1 /*
2   +----------------------------------------------------------------------+
3   | PHP Version 7                                                        |
4   +----------------------------------------------------------------------+
5   | Copyright (c) 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 #else
86 #include <sys/time.h>
87 #endif
88 
89 #ifndef MYSQLND_PROFILING_DISABLED
90 #define DBG_PROFILE_TIMEVAL_TO_DOUBLE(tp)	((tp.tv_sec * 1000000LL)+ tp.tv_usec)
91 #define DBG_PROFILE_START_TIME()		gettimeofday(&__dbg_prof_tp, NULL); __dbg_prof_start = DBG_PROFILE_TIMEVAL_TO_DOUBLE(__dbg_prof_tp);
92 #define DBG_PROFILE_END_TIME(duration)	gettimeofday(&__dbg_prof_tp, NULL); (duration) = (DBG_PROFILE_TIMEVAL_TO_DOUBLE(__dbg_prof_tp) - __dbg_prof_start);
93 #else
94 #define DBG_PROFILE_TIMEVAL_TO_DOUBLE(tp)
95 #define DBG_PROFILE_START_TIME()
96 #define DBG_PROFILE_END_TIME(duration)
97 #endif
98 
99 #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)
100 #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)
101 #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)
102 #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)
103 
104 #define DBG_BLOCK_ENTER_EX(dbg_obj, block_name) DBG_BLOCK_ENTER_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL, (block_name))
105 #define DBG_BLOCK_LEAVE_EX(dbg_obj)				DBG_BLOCK_LEAVE_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL)
106 
107 #define DBG_BLOCK_ENTER_EX2(dbg_obj1, dbg_obj2, block_name) \
108 		{ \
109 			DBG_ENTER_EX2((dbg_obj1), (dbg_obj2), (block_name));
110 
111 #define DBG_BLOCK_LEAVE_EX2(dbg_obj1, dbg_obj2) \
112 			DBG_LEAVE_EX2((dbg_obj1), (dbg_obj2), ;) \
113 		} \
114 
115 
116 #define DBG_ENTER_EX(dbg_obj, func_name)	DBG_ENTER_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL, (func_name))
117 #define DBG_LEAVE_EX(dbg_obj, leave)		DBG_LEAVE_EX2((dbg_obj), (MYSQLND_DEBUG *) NULL, leave)
118 
119 #define DBG_ENTER_EX2(dbg_obj1, dbg_obj2, func_name) \
120 					struct timeval __dbg_prof_tp = {0}; \
121 					uint64_t __dbg_prof_start = 0; /* initialization is needed */ \
122 					zend_bool dbg_skip_trace = TRUE; \
123 					((void)__dbg_prof_start); \
124 					if ((dbg_obj1)) { \
125 						dbg_skip_trace = !(dbg_obj1)->m->func_enter((dbg_obj1), __LINE__, __FILE__, func_name, strlen(func_name)); \
126 					} \
127 					if ((dbg_obj2)) { \
128 						dbg_skip_trace |= !(dbg_obj2)->m->func_enter((dbg_obj2), __LINE__, __FILE__, func_name, strlen(func_name)); \
129 					} \
130 					if (dbg_skip_trace) { \
131 						/* EMPTY */ ; /* shut compiler's mouth */	\
132 					} \
133 					do { \
134 						if (((dbg_obj1) && (dbg_obj1)->flags & MYSQLND_DEBUG_PROFILE_CALLS) || \
135 							((dbg_obj2) && (dbg_obj2)->flags & MYSQLND_DEBUG_PROFILE_CALLS)) \
136 						{ \
137 							DBG_PROFILE_START_TIME(); \
138 						} \
139 					} while (0);
140 
141 #define DBG_LEAVE_EX2(dbg_obj1, dbg_obj2, leave)	\
142 			do {\
143 				uint64_t this_call_duration = 0; \
144 				if (((dbg_obj1) && (dbg_obj1)->flags & MYSQLND_DEBUG_PROFILE_CALLS) || \
145 					((dbg_obj2) && (dbg_obj2)->flags & MYSQLND_DEBUG_PROFILE_CALLS)) \
146 				{ \
147 					DBG_PROFILE_END_TIME(this_call_duration); \
148 				} \
149 				if ((dbg_obj1)) { \
150 					(dbg_obj1)->m->func_leave((dbg_obj1), __LINE__, __FILE__, this_call_duration); \
151 				} \
152 				if ((dbg_obj2)) { \
153 					(dbg_obj2)->m->func_leave((dbg_obj2), __LINE__, __FILE__, this_call_duration); \
154 				} \
155 				leave \
156 			} while (0);
157 
158 
159 #define DBG_RETURN_EX(dbg_obj, value)		DBG_LEAVE_EX((dbg_obj), return (value);)
160 #define DBG_VOID_RETURN_EX(dbg_obj)			DBG_LEAVE_EX((dbg_obj), return;)
161 
162 #define DBG_RETURN_EX2(dbg_obj1, dbg_obj2, value)	DBG_LEAVE_EX2((dbg_obj1), (dbg_obj2), return (value);)
163 #define DBG_VOID_RETURN_EX2(dbg_obj1, dbg_obj2)		DBG_LEAVE_EX2((dbg_obj1), (dbg_obj2), return;)
164 
165 
166 
167 #else  /* defined(__GNUC__) || defined(PHP_WIN32) */
DBG_INF_EX(MYSQLND_DEBUG * dbg_obj, const char * const msg)168 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)169 static inline void DBG_ERR_EX(MYSQLND_DEBUG * dbg_obj, const char * const msg) {}
DBG_INF_FMT_EX(MYSQLND_DEBUG * dbg_obj, ...)170 static inline void DBG_INF_FMT_EX(MYSQLND_DEBUG * dbg_obj, ...) {}
DBG_ERR_FMT_EX(MYSQLND_DEBUG * dbg_obj, ...)171 static inline void DBG_ERR_FMT_EX(MYSQLND_DEBUG * dbg_obj, ...) {}
DBG_ENTER_EX(MYSQLND_DEBUG * dbg_obj, const char * const func_name)172 static inline void DBG_ENTER_EX(MYSQLND_DEBUG * dbg_obj, const char * const func_name) {}
173 #define DBG_BLOCK_ENTER(bname)			{
174 #define DBG_RETURN_EX(dbg_obj, value)	return (value)
175 #define DBG_VOID_RETURN_EX(dbg_obj)		return
176 #define DBG_BLOCK_LEAVE_EX(dbg_obj)		}
177 
178 #endif
179 
180 #if MYSQLND_DBG_ENABLED == 1
181 
182 #define DBG_INF(msg)		DBG_INF_EX(MYSQLND_G(dbg), (msg))
183 #define DBG_ERR(msg)		DBG_ERR_EX(MYSQLND_G(dbg), (msg))
184 #define DBG_INF_FMT(...)	DBG_INF_FMT_EX(MYSQLND_G(dbg), __VA_ARGS__)
185 #define DBG_ERR_FMT(...)	DBG_ERR_FMT_EX(MYSQLND_G(dbg), __VA_ARGS__)
186 
187 #define DBG_ENTER(func_name)	DBG_ENTER_EX(MYSQLND_G(dbg), (func_name))
188 #define DBG_BLOCK_ENTER(bname)	DBG_BLOCK_ENTER_EX(MYSQLND_G(dbg), (bname))
189 #define DBG_RETURN(value)		DBG_RETURN_EX(MYSQLND_G(dbg), (value))
190 #define DBG_VOID_RETURN			DBG_VOID_RETURN_EX(MYSQLND_G(dbg))
191 #define DBG_BLOCK_LEAVE			DBG_BLOCK_LEAVE_EX(MYSQLND_G(dbg))
192 
193 
194 #define TRACE_ALLOC_INF(msg)			DBG_INF_EX(MYSQLND_G(trace_alloc), (msg))
195 #define TRACE_ALLOC_ERR(msg)			DBG_ERR_EX(MYSQLND_G(trace_alloc), (msg))
196 #define TRACE_ALLOC_INF_FMT(...)		DBG_INF_FMT_EX(MYSQLND_G(trace_alloc), __VA_ARGS__)
197 #define TRACE_ALLOC_ERR_FMT(...)		DBG_ERR_FMT_EX(MYSQLND_G(trace_alloc), __VA_ARGS__)
198 
199 #define TRACE_ALLOC_ENTER(func_name)	DBG_ENTER_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc), (func_name))
200 #define TRACE_ALLOC_BLOCK_ENTER(bname)	DBG_BLOCK_ENTER_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc), (bname))
201 #define TRACE_ALLOC_RETURN(value)		DBG_RETURN_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc), (value))
202 #define TRACE_ALLOC_VOID_RETURN			DBG_VOID_RETURN_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc))
203 #define TRACE_ALLOC_BLOCK_LEAVE			DBG_BLOCK_LEAVE_EX2(MYSQLND_G(dbg), MYSQLND_G(trace_alloc))
204 
205 #elif MYSQLND_DBG_ENABLED == 0
206 
DBG_INF(const char * const msg)207 static inline void DBG_INF(const char * const msg) {}
DBG_ERR(const char * const msg)208 static inline void DBG_ERR(const char * const msg) {}
DBG_INF_FMT(const char * const format, ...)209 static inline void DBG_INF_FMT(const char * const format, ...) {}
DBG_ERR_FMT(const char * const format, ...)210 static inline void DBG_ERR_FMT(const char * const format, ...) {}
DBG_ENTER(const char * const func_name)211 static inline void DBG_ENTER(const char * const func_name) {}
212 #define DBG_BLOCK_ENTER(bname)	{
213 #define DBG_RETURN(value)			return (value)
214 #define DBG_VOID_RETURN				return
215 #define DBG_BLOCK_LEAVE			}
216 
217 
TRACE_ALLOC_INF(const char * const msg)218 static inline void TRACE_ALLOC_INF(const char * const msg) {}
TRACE_ALLOC_ERR(const char * const msg)219 static inline void TRACE_ALLOC_ERR(const char * const msg) {}
TRACE_ALLOC_INF_FMT(const char * const format, ...)220 static inline void TRACE_ALLOC_INF_FMT(const char * const format, ...) {}
TRACE_ALLOC_ERR_FMT(const char * const format, ...)221 static inline void TRACE_ALLOC_ERR_FMT(const char * const format, ...) {}
TRACE_ALLOC_ENTER(const char * const func_name)222 static inline void TRACE_ALLOC_ENTER(const char * const func_name) {}
223 #define TRACE_ALLOC_BLOCK_ENTER(bname)	{
224 #define TRACE_ALLOC_RETURN(value)			return (value)
225 #define TRACE_ALLOC_VOID_RETURN				return
226 #define TRACE_ALLOC_BLOCK_LEAVE			}
227 
228 #endif
229 
230 #endif /* MYSQLND_DEBUG_H */
231