ext/mysqlnd/mysqlnd

/* [<][>][^][v][top][bottom][index][help] */
This source file includes following definitions.
DBG_INF_EX
DBG_ERR_EX
DBG_INF_FMT_EX
DBG_ERR_FMT_EX
DBG_ENTER_EX
DBG_INF
DBG_ERR
DBG_INF_FMT
DBG_ERR_FMT
DBG_ENTER
TRACE_ALLOC_INF
TRACE_ALLOC_ERR
TRACE_ALLOC_INF_FMT
TRACE_ALLOC_ERR_FMT
TRACE_ALLOC_ENTER
   1 /*
   2   +----------------------------------------------------------------------+
   3   | PHP Version 7                                                        |
   4   +----------------------------------------------------------------------+
   5   | Copyright (c) 2006-2016 The PHP Group                                |
   6   +----------------------------------------------------------------------+
   7   | This source file is subject to version 3.01 of the PHP license,      |
   8   | that is bundled with this package in the file LICENSE, and is        |
   9   | available through the world-wide-web at the following url:           |
  10   | http://www.php.net/license/3_01.txt                                  |
  11   | If you did not receive a copy of the PHP license and are unable to   |
  12   | obtain it through the world-wide-web, please send a note to          |
  13   | license@php.net so we can mail you a copy immediately.               |
  14   +----------------------------------------------------------------------+
  15   | Authors: Georg Richter <georg@mysql.com>                             |
  16   |          Andrey Hristov <andrey@mysql.com>                           |
  17   |          Ulf Wendel <uwendel@mysql.com>                              |
  18   +----------------------------------------------------------------------+
  19 */
  20 
  21 /* $Id$ */
  22 
  23 #ifndef MYSQLND_DEBUG_H
  24 #define MYSQLND_DEBUG_H
  25 
  26 #include "mysqlnd_alloc.h"
  27 #include "zend_stack.h"
  28 
  29 struct st_mysqlnd_debug_methods
  30 {
  31         enum_func_status (*open)(MYSQLND_DEBUG * self, zend_bool reopen);
  32         void                     (*set_mode)(MYSQLND_DEBUG * self, const char * const mode);
  33         enum_func_status (*log)(MYSQLND_DEBUG * self, unsigned int line, const char * const file,
  34                                                         unsigned int level, const char * type, const char *message);
  35         enum_func_status (*log_va)(MYSQLND_DEBUG * self, unsigned int line, const char * const file,
  36                                                            unsigned int level, const char * type, const char *format, ...);
  37         zend_bool (*func_enter)(MYSQLND_DEBUG * self, unsigned int line, const char * const file,
  38                                                         const char * const func_name, unsigned int func_name_len);
  39         enum_func_status (*func_leave)(MYSQLND_DEBUG * self, unsigned int line, const char * const file, uint64_t call_time);
  40         enum_func_status (*close)(MYSQLND_DEBUG * self);
  41         enum_func_status (*free_handle)(MYSQLND_DEBUG * self);
  42 };
  43 
  44 
  45 struct st_mysqlnd_debug
  46 {
  47         php_stream      *stream;
  48         unsigned int flags;
  49         unsigned int nest_level_limit;
  50         int pid;
  51         char * file_name;
  52         zend_stack call_stack;
  53         zend_stack call_time_stack;
  54         HashTable not_filtered_functions;
  55         HashTable function_profiles;
  56         struct st_mysqlnd_debug_methods *m;
  57         const char ** skip_functions;
  58 };
  59 
  60 struct st_mysqlnd_plugin_trace_log
  61 {
  62         struct st_mysqlnd_plugin_header plugin_header;
  63         struct
  64         {
  65                 MYSQLND_DEBUG * (*trace_instance_init)(const char * skip_functions[]);
  66         } methods;
  67 };
  68 
  69 void mysqlnd_debug_trace_plugin_register(void);
  70 
  71 PHPAPI MYSQLND_DEBUG * mysqlnd_debug_init(const char * skip_functions[]);
  72 
  73 
  74 #if defined(__GNUC__) || defined(PHP_WIN32)
  75 #ifdef PHP_WIN32
  76 #include "win32/time.h"
  77 #elif defined(NETWARE)
  78 #include <sys/timeval.h>
  79 #include <sys/time.h>
  80 #else
  81 #include <sys/time.h>
  82 #endif
  83 
  84 #ifndef MYSQLND_PROFILING_DISABLED
  85 #define DBG_PROFILE_TIMEVAL_TO_DOUBLE(tp)       ((tp.tv_sec * 1000000LL)+ tp.tv_usec)
  86 #define DBG_PROFILE_START_TIME()                gettimeofday(&__dbg_prof_tp, NULL); __dbg_prof_start = DBG_PROFILE_TIMEVAL_TO_DOUBLE(__dbg_prof_tp);
  87 #define DBG_PROFILE_END_TIME(duration)  gettimeofday(&__dbg_prof_tp, NULL); (duration) = (DBG_PROFILE_TIMEVAL_TO_DOUBLE(__dbg_prof_tp) - __dbg_prof_start);
  88 #else
  89 #define DBG_PROFILE_TIMEVAL_TO_DOUBLE(tp)
  90 #define DBG_PROFILE_START_TIME()
  91 #define DBG_PROFILE_END_TIME(duration)
  92 #endif
  93 
  94 #define DBG_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)
  95 #define DBG_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)
  96 #define DBG_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)
  97 #define DBG_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)
  98 
  99 #define DBG_BLOCK_ENTER_EX(dbg_obj, block_name) DBG_BLOCK_ENTER_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL, (block_name))
 100 #define DBG_BLOCK_LEAVE_EX(dbg_obj)                             DBG_BLOCK_LEAVE_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL)
 101 
 102 #define DBG_BLOCK_ENTER_EX2(dbg_obj1, dbg_obj2, block_name) \
 103                 { \
 104                         DBG_ENTER_EX2((dbg_obj1), (dbg_obj2), (block_name));
 105 
 106 #define DBG_BLOCK_LEAVE_EX2(dbg_obj1, dbg_obj2) \
 107                         DBG_LEAVE_EX2((dbg_obj1), (dbg_obj2), ;) \
 108                 } \
 109 
 110 
 111 #define DBG_ENTER_EX(dbg_obj, func_name)        DBG_ENTER_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL, (func_name))
 112 #define DBG_LEAVE_EX(dbg_obj, leave)            DBG_LEAVE_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL, leave)
 113 
 114 #define DBG_ENTER_EX2(dbg_obj1, dbg_obj2, func_name) \
 115                                         struct timeval __dbg_prof_tp = {0}; \
 116                                         uint64_t __dbg_prof_start = 0; /* initialization is needed */ \
 117                                         zend_bool dbg_skip_trace = TRUE; \
 118                                         ((void)__dbg_prof_start); \
 119                                         if ((dbg_obj1)) { \
 120                                                 dbg_skip_trace = !(dbg_obj1)->m->func_enter((dbg_obj1), __LINE__, __FILE__, func_name, strlen(func_name)); \
 121                                         } \
 122                                         if ((dbg_obj2)) { \
 123                                                 dbg_skip_trace |= !(dbg_obj2)->m->func_enter((dbg_obj2), __LINE__, __FILE__, func_name, strlen(func_name)); \
 124                                         } \
 125                                         if (dbg_skip_trace) \
 126                                                 /* EMPTY */ ; /* shut compiler's mouth */       \
 127                                         do { \
 128                                                 if (((dbg_obj1) && (dbg_obj1)->flags & MYSQLND_DEBUG_PROFILE_CALLS) || \
 129                                                         ((dbg_obj2) && (dbg_obj2)->flags & MYSQLND_DEBUG_PROFILE_CALLS)) \
 130                                                 { \
 131                                                         DBG_PROFILE_START_TIME(); \
 132                                                 } \
 133                                         } while (0);
 134 
 135 #define DBG_LEAVE_EX2(dbg_obj1, dbg_obj2, leave)        \
 136                         do {\
 137                                 uint64_t this_call_duration = 0; \
 138                                 if (((dbg_obj1) && (dbg_obj1)->flags & MYSQLND_DEBUG_PROFILE_CALLS) || \
 139                                         ((dbg_obj2) && (dbg_obj2)->flags & MYSQLND_DEBUG_PROFILE_CALLS)) \
 140                                 { \
 141                                         DBG_PROFILE_END_TIME(this_call_duration); \
 142                                 } \
 143                                 if ((dbg_obj1)) { \
 144                                         (dbg_obj1)->m->func_leave((dbg_obj1), __LINE__, __FILE__, this_call_duration); \
 145                                 } \
 146                                 if ((dbg_obj2)) { \
 147                                         (dbg_obj2)->m->func_leave((dbg_obj2), __LINE__, __FILE__, this_call_duration); \
 148                                 } \
 149                                 leave \
 150                         } while (0);
 151 
 152 
 153 #define DBG_RETURN_EX(dbg_obj, value)           DBG_LEAVE_EX((dbg_obj), return (value);)
 154 #define DBG_VOID_RETURN_EX(dbg_obj)                     DBG_LEAVE_EX((dbg_obj), return;)
 155 
 156 #define DBG_RETURN_EX2(dbg_obj1, dbg_obj2, value)       DBG_LEAVE_EX2((dbg_obj1), (dbg_obj2), return (value);)
 157 #define DBG_VOID_RETURN_EX2(dbg_obj1, dbg_obj2)         DBG_LEAVE_EX2((dbg_obj1), (dbg_obj2), return;)
 158 
 159 
 160 
 161 #else  /* defined(__GNUC__) || defined(PHP_WIN32) */
 162 static inline void DBG_INF_EX(MYSQLND_DEBUG * dbg_obj, const char * const msg) {}
 163 static inline void DBG_ERR_EX(MYSQLND_DEBUG * dbg_obj, const char * const msg) {}
 164 static inline void DBG_INF_FMT_EX(MYSQLND_DEBUG * dbg_obj, ...) {}
 165 static inline void DBG_ERR_FMT_EX(MYSQLND_DEBUG * dbg_obj, ...) {}
 166 static inline void DBG_ENTER_EX(MYSQLND_DEBUG * dbg_obj, const char * const func_name) {}
 167 #define DBG_BLOCK_ENTER(bname)                  {
 168 #define DBG_RETURN_EX(dbg_obj, value)   return (value)
 169 #define DBG_VOID_RETURN_EX(dbg_obj)             return
 170 #define DBG_BLOCK_LEAVE_EX(dbg_obj)             }
 171 
 172 #endif
 173 
 174 #if MYSQLND_DBG_ENABLED == 1
 175 
 176 #define DBG_INF(msg)            DBG_INF_EX(MYSQLND_G(dbg), (msg))
 177 #define DBG_ERR(msg)            DBG_ERR_EX(MYSQLND_G(dbg), (msg))
 178 #define DBG_INF_FMT(...)        DBG_INF_FMT_EX(MYSQLND_G(dbg), __VA_ARGS__)
 179 #define DBG_ERR_FMT(...)        DBG_ERR_FMT_EX(MYSQLND_G(dbg), __VA_ARGS__)
 180 
 181 #define DBG_ENTER(func_name)    DBG_ENTER_EX(MYSQLND_G(dbg), (func_name))
 182 #define DBG_BLOCK_ENTER(bname)  DBG_BLOCK_ENTER_EX(MYSQLND_G(dbg), (bname))
 183 #define DBG_RETURN(value)               DBG_RETURN_EX(MYSQLND_G(dbg), (value))
 184 #define DBG_VOID_RETURN                 DBG_VOID_RETURN_EX(MYSQLND_G(dbg))
 185 #define DBG_BLOCK_LEAVE                 DBG_BLOCK_LEAVE_EX(MYSQLND_G(dbg))
 186 
 187 
 188 #define TRACE_ALLOC_INF(msg)                    DBG_INF_EX(MYSQLND_G(trace_alloc), (msg))
 189 #define TRACE_ALLOC_ERR(msg)                    DBG_ERR_EX(MYSQLND_G(trace_alloc), (msg))
 190 #define TRACE_ALLOC_INF_FMT(...)                DBG_INF_FMT_EX(MYSQLND_G(trace_alloc), __VA_ARGS__)
 191 #define TRACE_ALLOC_ERR_FMT(...)                DBG_ERR_FMT_EX(MYSQLND_G(trace_alloc), __VA_ARGS__)
 192 
 193 #define TRACE_ALLOC_ENTER(func_name)    DBG_ENTER_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc), (func_name))
 194 #define TRACE_ALLOC_BLOCK_ENTER(bname)  DBG_BLOCK_ENTER_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc), (bname))
 195 #define TRACE_ALLOC_RETURN(value)               DBG_RETURN_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc), (value))
 196 #define TRACE_ALLOC_VOID_RETURN                 DBG_VOID_RETURN_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc))
 197 #define TRACE_ALLOC_BLOCK_LEAVE                 DBG_BLOCK_LEAVE_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc))
 198 
 199 #elif MYSQLND_DBG_ENABLED == 0
 200 
 201 static inline void DBG_INF(const char * const msg) {}
 202 static inline void DBG_ERR(const char * const msg) {}
 203 static inline void DBG_INF_FMT(const char * const format, ...) {}
 204 static inline void DBG_ERR_FMT(const char * const format, ...) {}
 205 static inline void DBG_ENTER(const char * const func_name) {}
 206 #define DBG_BLOCK_ENTER(bname)  {
 207 #define DBG_RETURN(value)                       return (value)
 208 #define DBG_VOID_RETURN                         return
 209 #define DBG_BLOCK_LEAVE                 }
 210 
 211 
 212 static inline void TRACE_ALLOC_INF(const char * const msg) {}
 213 static inline void TRACE_ALLOC_ERR(const char * const msg) {}
 214 static inline void TRACE_ALLOC_INF_FMT(const char * const format, ...) {}
 215 static inline void TRACE_ALLOC_ERR_FMT(const char * const format, ...) {}
 216 static inline void TRACE_ALLOC_ENTER(const char * const func_name) {}
 217 #define TRACE_ALLOC_BLOCK_ENTER(bname)  {
 218 #define TRACE_ALLOC_RETURN(value)                       return (value)
 219 #define TRACE_ALLOC_VOID_RETURN                         return
 220 #define TRACE_ALLOC_BLOCK_LEAVE                 }
 221 
 222 #endif
 223 
 224 #endif /* MYSQLND_DEBUG_H */
 225 
 226 /*
 227  * Local variables:
 228  * tab-width: 4
 229  * c-basic-offset: 4
 230  * End:
 231  * vim600: noet sw=4 ts=4 fdm=marker
 232  * vim<600: noet sw=4 ts=4
 233  */
/* [<][>][^][v][top][bottom][index][help] */
root/ext/mysqlnd/mysqlnd_debug.h

INCLUDED FROM

DEFINITIONS
