mysqlnd_debug.h

/*
 +----------------------------------------------------------------------+
 | Copyright (c) The PHP Group |
 +----------------------------------------------------------------------+
 | This source file is subject to version 3.01 of the PHP license, |
 | that is bundled with this package in the file LICENSE, and is |
 | available through the world-wide-web at the following url: |
 | https://www.php.net/license/3_01.txt |
 | If you did not receive a copy of the PHP license and are unable to |
 | obtain it through the world-wide-web, please send a note to |
 | license@php.net so we can mail you a copy immediately. |
 +----------------------------------------------------------------------+
 | Authors: Andrey Hristov <andrey@php.net> |
 | Ulf Wendel <uw@php.net> |
 +----------------------------------------------------------------------+
*/

#ifndefMYSQLND_DEBUG_H
#defineMYSQLND_DEBUG_H

#include"mysqlnd_alloc.h"
#include"zend_stack.h"

structst_mysqlnd_debug_methods
{
enum_func_status (*open)(MYSQLND_DEBUG*self, boolreopen);
void (*set_mode)(MYSQLND_DEBUG*self, constchar*constmode);
enum_func_status (*log)(MYSQLND_DEBUG*self, unsigned intline, constchar*constfile,
unsigned intlevel, constchar*type, constchar*message);
enum_func_status (*log_va)(
MYSQLND_DEBUG*self, unsigned intline, constchar*constfile,
unsigned intlevel, constchar*type, constchar*format, ...)
ZEND_ATTRIBUTE_FORMAT(printf, 6, 7);
bool (*func_enter)(MYSQLND_DEBUG*self, unsigned intline, constchar*constfile,
constchar*constfunc_name, unsigned intfunc_name_len);
enum_func_status (*func_leave)(MYSQLND_DEBUG*self, unsigned intline, constchar*constfile, uint64_tcall_time);
enum_func_status (*close)(MYSQLND_DEBUG*self);
enum_func_status (*free_handle)(MYSQLND_DEBUG*self);
};


structst_mysqlnd_debug
{
php_stream*stream;
unsigned intflags;
unsigned intnest_level_limit;
intpid;
char*file_name;
zend_stackcall_stack;
zend_stackcall_time_stack;
HashTablenot_filtered_functions;
HashTablefunction_profiles;
structst_mysqlnd_debug_methods*m;
constchar**skip_functions;
};

structst_mysqlnd_plugin_trace_log
{
structst_mysqlnd_plugin_headerplugin_header;
struct
 {
MYSQLND_DEBUG* (*trace_instance_init)(constchar*skip_functions[]);
 } methods;
};

voidmysqlnd_debug_trace_plugin_register(void);

PHPAPIMYSQLND_DEBUG*mysqlnd_debug_init(constchar*skip_functions[]);

#defineMYSQLND_DEBUG_DUMP_TIME 1
#defineMYSQLND_DEBUG_DUMP_TRACE 2
#defineMYSQLND_DEBUG_DUMP_PID 4
#defineMYSQLND_DEBUG_DUMP_LINE 8
#defineMYSQLND_DEBUG_DUMP_FILE 16
#defineMYSQLND_DEBUG_DUMP_LEVEL 32
#defineMYSQLND_DEBUG_APPEND 64
#defineMYSQLND_DEBUG_FLUSH 128
#defineMYSQLND_DEBUG_TRACE_MEMORY_CALLS 256
#defineMYSQLND_DEBUG_PROFILE_CALLS 512


#if defined(__GNUC__) || defined(PHP_WIN32)
#ifdefPHP_WIN32
#include"win32/time.h"
#else
#include<sys/time.h>
#endif

#ifndefMYSQLND_PROFILING_DISABLED
#defineDBG_PROFILE_TIMEVAL_TO_DOUBLE(tp) ((tp.tv_sec * 1000000LL)+ tp.tv_usec)
#defineDBG_PROFILE_START_TIME() gettimeofday(&__dbg_prof_tp, NULL); __dbg_prof_start = DBG_PROFILE_TIMEVAL_TO_DOUBLE(__dbg_prof_tp);
#defineDBG_PROFILE_END_TIME(duration) gettimeofday(&__dbg_prof_tp, NULL); (duration) = (DBG_PROFILE_TIMEVAL_TO_DOUBLE(__dbg_prof_tp) - __dbg_prof_start);
#else
#defineDBG_PROFILE_TIMEVAL_TO_DOUBLE(tp)
#defineDBG_PROFILE_START_TIME()
#defineDBG_PROFILE_END_TIME(duration)
#endif

#defineDBG_INF_EX(dbg_obj, msg) do { if (dbg_skip_trace == FALSE && (dbg_obj)) (dbg_obj)->m->log((dbg_obj), __LINE__, __FILE__, -1, "info : ", (msg)); } while (0)
#defineDBG_ERR_EX(dbg_obj, msg) do { if (dbg_skip_trace == FALSE && (dbg_obj)) (dbg_obj)->m->log((dbg_obj), __LINE__, __FILE__, -1, "error: ", (msg)); } while (0)
#defineDBG_INF_FMT_EX(dbg_obj, ...) do { if (dbg_skip_trace == FALSE && (dbg_obj)) (dbg_obj)->m->log_va((dbg_obj), __LINE__, __FILE__, -1, "info : ", __VA_ARGS__); } while (0)
#defineDBG_ERR_FMT_EX(dbg_obj, ...) do { if (dbg_skip_trace == FALSE && (dbg_obj)) (dbg_obj)->m->log_va((dbg_obj), __LINE__, __FILE__, -1, "error: ", __VA_ARGS__); } while (0)

#defineDBG_BLOCK_ENTER_EX(dbg_obj, block_name) DBG_BLOCK_ENTER_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL, (block_name))
#defineDBG_BLOCK_LEAVE_EX(dbg_obj) DBG_BLOCK_LEAVE_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL)

#defineDBG_BLOCK_ENTER_EX2(dbg_obj1, dbg_obj2, block_name) \
 { \
 DBG_ENTER_EX2((dbg_obj1), (dbg_obj2), (block_name));

#defineDBG_BLOCK_LEAVE_EX2(dbg_obj1, dbg_obj2) \
 DBG_LEAVE_EX2((dbg_obj1), (dbg_obj2), ;) \
 } \


#defineDBG_ENTER_EX(dbg_obj, func_name) DBG_ENTER_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL, (func_name))
#defineDBG_LEAVE_EX(dbg_obj, leave) DBG_LEAVE_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL, leave)

#defineDBG_ENTER_EX2(dbg_obj1, dbg_obj2, func_name) \
 struct timeval __dbg_prof_tp = {0}; \
 uint64_t __dbg_prof_start = 0; /* initialization is needed */ \
booldbg_skip_trace= TRUE; \
 ((void)__dbg_prof_start); \
if ((dbg_obj1)) { \
dbg_skip_trace= !(dbg_obj1)->m->func_enter((dbg_obj1), __LINE__, __FILE__, func_name, strlen(func_name)); \
 } \
if ((dbg_obj2)) { \
dbg_skip_trace |= !(dbg_obj2)->m->func_enter((dbg_obj2), __LINE__, __FILE__, func_name, strlen(func_name)); \
 } \
if (dbg_skip_trace) { \
/* EMPTY */ ; /* shut compiler's mouth */ \
 } \
do { \
if (((dbg_obj1) && ((dbg_obj1)->flags&MYSQLND_DEBUG_PROFILE_CALLS)) || \
 ((dbg_obj2) && ((dbg_obj2)->flags&MYSQLND_DEBUG_PROFILE_CALLS))) \
 { \
DBG_PROFILE_START_TIME(); \
 } \
 } while (0);

#defineDBG_LEAVE_EX2(dbg_obj1, dbg_obj2, leave) \
 do { \
 uint64_t this_call_duration = 0; \
 if (((dbg_obj1) && ((dbg_obj1)->flags & MYSQLND_DEBUG_PROFILE_CALLS)) || \
 ((dbg_obj2) && ((dbg_obj2)->flags & MYSQLND_DEBUG_PROFILE_CALLS))) \
 { \
 DBG_PROFILE_END_TIME(this_call_duration); \
 } \
 if ((dbg_obj1)) { \
 (dbg_obj1)->m->func_leave((dbg_obj1), __LINE__, __FILE__, this_call_duration); \
 } \
 if ((dbg_obj2)) { \
 (dbg_obj2)->m->func_leave((dbg_obj2), __LINE__, __FILE__, this_call_duration); \
 } \
 leave \
 } while (0);


#defineDBG_RETURN_EX(dbg_obj, value) DBG_LEAVE_EX((dbg_obj), return (value);)
#defineDBG_VOID_RETURN_EX(dbg_obj) DBG_LEAVE_EX((dbg_obj), return;)

#defineDBG_RETURN_EX2(dbg_obj1, dbg_obj2, value) DBG_LEAVE_EX2((dbg_obj1), (dbg_obj2), return (value);)
#defineDBG_VOID_RETURN_EX2(dbg_obj1, dbg_obj2) DBG_LEAVE_EX2((dbg_obj1), (dbg_obj2), return;)



#else/* defined(__GNUC__) || defined(PHP_WIN32) */
staticinlinevoidDBG_INF_EX(MYSQLND_DEBUG*dbg_obj, constchar*constmsg) {}
staticinlinevoidDBG_ERR_EX(MYSQLND_DEBUG*dbg_obj, constchar*constmsg) {}
staticinlinevoidDBG_INF_FMT_EX(MYSQLND_DEBUG*dbg_obj, ...) {}
staticinlinevoidDBG_ERR_FMT_EX(MYSQLND_DEBUG*dbg_obj, ...) {}
staticinlinevoidDBG_ENTER_EX(MYSQLND_DEBUG*dbg_obj, constchar*constfunc_name) {}
#defineDBG_BLOCK_ENTER(bname) {
#defineDBG_RETURN_EX(dbg_obj, value) return (value)
#defineDBG_VOID_RETURN_EX(dbg_obj) return
#defineDBG_BLOCK_LEAVE_EX(dbg_obj) }

#endif

#ifMYSQLND_DBG_ENABLED==1

#defineDBG_INF(msg) DBG_INF_EX(MYSQLND_G(dbg), (msg))
#defineDBG_ERR(msg) DBG_ERR_EX(MYSQLND_G(dbg), (msg))
#defineDBG_INF_FMT(...) DBG_INF_FMT_EX(MYSQLND_G(dbg), __VA_ARGS__)
#defineDBG_ERR_FMT(...) DBG_ERR_FMT_EX(MYSQLND_G(dbg), __VA_ARGS__)

#defineDBG_ENTER(func_name) DBG_ENTER_EX(MYSQLND_G(dbg), (func_name))
#defineDBG_BLOCK_ENTER(bname) DBG_BLOCK_ENTER_EX(MYSQLND_G(dbg), (bname))
#defineDBG_RETURN(value) DBG_RETURN_EX(MYSQLND_G(dbg), (value))
#defineDBG_VOID_RETURN DBG_VOID_RETURN_EX(MYSQLND_G(dbg))
#defineDBG_BLOCK_LEAVE DBG_BLOCK_LEAVE_EX(MYSQLND_G(dbg))


#defineTRACE_ALLOC_INF(msg) DBG_INF_EX(MYSQLND_G(trace_alloc), (msg))
#defineTRACE_ALLOC_ERR(msg) DBG_ERR_EX(MYSQLND_G(trace_alloc), (msg))
#defineTRACE_ALLOC_INF_FMT(...) DBG_INF_FMT_EX(MYSQLND_G(trace_alloc), __VA_ARGS__)
#defineTRACE_ALLOC_ERR_FMT(...) DBG_ERR_FMT_EX(MYSQLND_G(trace_alloc), __VA_ARGS__)

#defineTRACE_ALLOC_ENTER(func_name) DBG_ENTER_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc), (func_name))
#defineTRACE_ALLOC_BLOCK_ENTER(bname) DBG_BLOCK_ENTER_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc), (bname))
#defineTRACE_ALLOC_RETURN(value) DBG_RETURN_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc), (value))
#defineTRACE_ALLOC_VOID_RETURN DBG_VOID_RETURN_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc))
#defineTRACE_ALLOC_BLOCK_LEAVE DBG_BLOCK_LEAVE_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc))

#elifMYSQLND_DBG_ENABLED==0

staticinlinevoidDBG_INF(constchar*constmsg) {}
staticinlinevoidDBG_ERR(constchar*constmsg) {}
staticinlinevoidDBG_INF_FMT(constchar*constformat, ...) {}
staticinlinevoidDBG_ERR_FMT(constchar*constformat, ...) {}
staticinlinevoidDBG_ENTER(constchar*constfunc_name) {}
#defineDBG_BLOCK_ENTER(bname) {
#defineDBG_RETURN(value) return (value)
#defineDBG_VOID_RETURN return
#defineDBG_BLOCK_LEAVE }


staticinlinevoidTRACE_ALLOC_INF(constchar*constmsg) {}
staticinlinevoidTRACE_ALLOC_ERR(constchar*constmsg) {}
staticinlinevoidTRACE_ALLOC_INF_FMT(constchar*constformat, ...) {}
staticinlinevoidTRACE_ALLOC_ERR_FMT(constchar*constformat, ...) {}
staticinlinevoidTRACE_ALLOC_ENTER(constchar*constfunc_name) {}
#defineTRACE_ALLOC_BLOCK_ENTER(bname) {
#defineTRACE_ALLOC_RETURN(value) return (value)
#defineTRACE_ALLOC_VOID_RETURN return
#defineTRACE_ALLOC_BLOCK_LEAVE }

#endif

#endif/* MYSQLND_DEBUG_H */