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