Annotation of embedaddon/php/ext/mysqlnd/mysqlnd_debug.h, revision 1.1.1.3
1.1 misho 1: /*
2: +----------------------------------------------------------------------+
3: | PHP Version 5 |
4: +----------------------------------------------------------------------+
1.1.1.3 ! misho 5: | Copyright (c) 2006-2013 The PHP Group |
1.1 misho 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:
1.1.1.2 misho 21: /* $Id$ */
1.1 misho 22:
23: #ifndef MYSQLND_DEBUG_H
24: #define MYSQLND_DEBUG_H
25:
1.1.1.2 misho 26: #include "mysqlnd_alloc.h"
1.1 misho 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: #ifdef ZTS
49: TSRMLS_D;
50: #endif
51: unsigned int flags;
52: unsigned int nest_level_limit;
53: int pid;
54: char * file_name;
55: zend_stack call_stack;
56: zend_stack call_time_stack;
57: HashTable not_filtered_functions;
58: HashTable function_profiles;
59: struct st_mysqlnd_debug_methods *m;
60: const char ** skip_functions;
61: };
62:
1.1.1.2 misho 63: struct st_mysqlnd_plugin_trace_log
64: {
65: struct st_mysqlnd_plugin_header plugin_header;
66: struct
67: {
68: MYSQLND_DEBUG * (*trace_instance_init)(const char * skip_functions[] TSRMLS_DC);
69: char * (*get_backtrace)(uint max_levels, size_t * length TSRMLS_DC);
70: } methods;
71: };
72:
73: void mysqlnd_debug_trace_plugin_register(TSRMLS_D);
1.1 misho 74:
75: PHPAPI MYSQLND_DEBUG * mysqlnd_debug_init(const char * skip_functions[] TSRMLS_DC);
76:
1.1.1.2 misho 77: PHPAPI char * mysqlnd_get_backtrace(uint max_levels, size_t * length TSRMLS_DC);
1.1 misho 78:
79: #if defined(__GNUC__) || (defined(_MSC_VER) && (_MSC_VER >= 1400))
80: #ifdef PHP_WIN32
81: #include "win32/time.h"
82: #elif defined(NETWARE)
83: #include <sys/timeval.h>
84: #include <sys/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)->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)->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)->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)->m->log_va((dbg_obj), __LINE__, __FILE__, -1, "error: ", __VA_ARGS__); } while (0)
103:
104: #define DBG_BLOCK_ENTER_EX(dbg_obj, block_name) \
105: { \
106: DBG_ENTER_EX(dbg_obj, (block_name));
107:
108: #define DBG_BLOCK_LEAVE_EX(dbg_obj) \
109: DBG_LEAVE_EX((dbg_obj), ;) \
110: } \
111:
112:
113: #define DBG_ENTER_EX(dbg_obj, func_name) \
114: struct timeval __dbg_prof_tp = {0}; \
115: uint64_t __dbg_prof_start = 0; /* initialization is needed */ \
116: zend_bool dbg_skip_trace = TRUE; \
117: if ((dbg_obj)) { \
118: dbg_skip_trace = !(dbg_obj)->m->func_enter((dbg_obj), __LINE__, __FILE__, func_name, strlen(func_name)); \
119: } \
120: do { \
121: if ((dbg_obj) && (dbg_obj)->flags & MYSQLND_DEBUG_PROFILE_CALLS) { \
122: DBG_PROFILE_START_TIME(); \
123: } \
124: } while (0);
125:
126: #define DBG_LEAVE_EX(dbg_obj, leave) \
127: do {\
128: if ((dbg_obj)) { \
129: uint64_t this_call_duration = 0; \
130: if ((dbg_obj)->flags & MYSQLND_DEBUG_PROFILE_CALLS) { \
131: DBG_PROFILE_END_TIME(this_call_duration); \
132: } \
133: (dbg_obj)->m->func_leave((dbg_obj), __LINE__, __FILE__, this_call_duration); \
134: } \
135: leave \
136: } while (0);
137:
138: #define DBG_RETURN_EX(dbg_obj, value) DBG_LEAVE_EX(dbg_obj, return (value);)
139:
140: #define DBG_VOID_RETURN_EX(dbg_obj) DBG_LEAVE_EX(dbg_obj, return;)
141:
142:
143:
144: #else
145: static inline void DBG_INF_EX(MYSQLND_DEBUG * dbg_obj, const char * const msg) {}
146: static inline void DBG_ERR_EX(MYSQLND_DEBUG * dbg_obj, const char * const msg) {}
147: static inline void DBG_INF_FMT_EX(MYSQLND_DEBUG * dbg_obj, ...) {}
148: static inline void DBG_ERR_FMT_EX(MYSQLND_DEBUG * dbg_obj, ...) {}
149: static inline void DBG_ENTER_EX(MYSQLND_DEBUG * dbg_obj, const char * const func_name) {}
150: #define DBG_BLOCK_ENTER(bname) {
151: #define DBG_RETURN_EX(dbg_obj, value) return (value)
152: #define DBG_VOID_RETURN_EX(dbg_obj) return
153: #define DBG_BLOCK_LEAVE_EX(dbg_obj) }
154:
1.1.1.2 misho 155: #endif
1.1 misho 156:
157: #if MYSQLND_DBG_ENABLED == 1
158:
159: #define DBG_INF(msg) DBG_INF_EX(MYSQLND_G(dbg), (msg))
160: #define DBG_ERR(msg) DBG_ERR_EX(MYSQLND_G(dbg), (msg))
161: #define DBG_INF_FMT(...) DBG_INF_FMT_EX(MYSQLND_G(dbg), __VA_ARGS__)
162: #define DBG_ERR_FMT(...) DBG_ERR_FMT_EX(MYSQLND_G(dbg), __VA_ARGS__)
163:
164: #define DBG_ENTER(func_name) DBG_ENTER_EX(MYSQLND_G(dbg), (func_name))
165: #define DBG_BLOCK_ENTER(bname) DBG_BLOCK_ENTER_EX(MYSQLND_G(dbg), (bname))
166: #define DBG_RETURN(value) DBG_RETURN_EX(MYSQLND_G(dbg), (value))
167: #define DBG_VOID_RETURN DBG_VOID_RETURN_EX(MYSQLND_G(dbg))
168: #define DBG_BLOCK_LEAVE DBG_BLOCK_LEAVE_EX(MYSQLND_G(dbg))
169:
170: #elif MYSQLND_DBG_ENABLED == 0
171:
172: static inline void DBG_INF(const char * const msg) {}
173: static inline void DBG_ERR(const char * const msg) {}
174: static inline void DBG_INF_FMT(const char * const format, ...) {}
175: static inline void DBG_ERR_FMT(const char * const format, ...) {}
176: static inline void DBG_ENTER(const char * const func_name) {}
177: #define DBG_BLOCK_ENTER(bname) {
178: #define DBG_RETURN(value) return (value)
179: #define DBG_VOID_RETURN return
180: #define DBG_BLOCK_LEAVE }
181:
182: #endif
183:
184: #endif /* MYSQLND_DEBUG_H */
185:
186: /*
187: * Local variables:
188: * tab-width: 4
189: * c-basic-offset: 4
190: * End:
191: * vim600: noet sw=4 ts=4 fdm=marker
192: * vim<600: noet sw=4 ts=4
193: */
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>