1 /*
2 +----------------------------------------------------------------------+
3 | Zend Engine |
4 +----------------------------------------------------------------------+
5 | Copyright (c) Zend Technologies Ltd. (http://www.zend.com) |
6 +----------------------------------------------------------------------+
7 | This source file is subject to version 2.00 of the Zend 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.zend.com/license/2_00.txt. |
11 | If you did not receive a copy of the Zend license and are unable to |
12 | obtain it through the world-wide-web, please send a note to |
13 | license@zend.com so we can mail you a copy immediately. |
14 +----------------------------------------------------------------------+
15 | Authors: Levi Morrison <levim@php.net> |
16 | Sammy Kaye Powers <sammyk@php.net> |
17 +----------------------------------------------------------------------+
18 */
19
20 #ifndef ZEND_OBSERVER_H
21 #define ZEND_OBSERVER_H
22
23 #include "zend.h"
24 #include "zend_compile.h"
25 #include "zend_fibers.h"
26
27 BEGIN_EXTERN_C()
28
29 extern ZEND_API int zend_observer_fcall_op_array_extension;
30 extern ZEND_API bool zend_observer_errors_observed;
31 extern ZEND_API bool zend_observer_function_declared_observed;
32 extern ZEND_API bool zend_observer_class_linked_observed;
33
34 #define ZEND_OBSERVER_ENABLED (zend_observer_fcall_op_array_extension != -1)
35
36 #define ZEND_OBSERVER_FCALL_BEGIN(execute_data) do { \
37 if (ZEND_OBSERVER_ENABLED) { \
38 zend_observer_fcall_begin(execute_data); \
39 } \
40 } while (0)
41
42 #define ZEND_OBSERVER_FCALL_END(execute_data, return_value) do { \
43 if (ZEND_OBSERVER_ENABLED) { \
44 zend_observer_fcall_end(execute_data, return_value); \
45 } \
46 } while (0)
47
48 typedef void (*zend_observer_fcall_begin_handler)(zend_execute_data *execute_data);
49 typedef void (*zend_observer_fcall_end_handler)(zend_execute_data *execute_data, zval *retval);
50
51 typedef struct _zend_observer_fcall_handlers {
52 zend_observer_fcall_begin_handler begin;
53 zend_observer_fcall_end_handler end;
54 } zend_observer_fcall_handlers;
55
56 /* If the fn should not be observed then return {NULL, NULL} */
57 typedef zend_observer_fcall_handlers (*zend_observer_fcall_init)(zend_execute_data *execute_data);
58
59 // Call during minit/startup ONLY
60 ZEND_API void zend_observer_fcall_register(zend_observer_fcall_init);
61
62 // Call during runtime, but only if you have used zend_observer_fcall_register.
63 // You must not have more than one begin and one end handler active at the same time. Remove the old one first, if there is an existing one.
64 ZEND_API void zend_observer_add_begin_handler(zend_function *function, zend_observer_fcall_begin_handler begin);
65 ZEND_API bool zend_observer_remove_begin_handler(zend_function *function, zend_observer_fcall_begin_handler begin, zend_observer_fcall_begin_handler *next);
66 ZEND_API void zend_observer_add_end_handler(zend_function *function, zend_observer_fcall_end_handler end);
67 ZEND_API bool zend_observer_remove_end_handler(zend_function *function, zend_observer_fcall_end_handler end, zend_observer_fcall_end_handler *next);
68
69 ZEND_API void zend_observer_startup(void); // Called by engine before MINITs
70 ZEND_API void zend_observer_post_startup(void); // Called by engine after MINITs
71 ZEND_API void zend_observer_activate(void);
72 ZEND_API void zend_observer_shutdown(void);
73
74 ZEND_API void ZEND_FASTCALL zend_observer_fcall_begin(
75 zend_execute_data *execute_data);
76
77 ZEND_API void ZEND_FASTCALL zend_observer_generator_resume(
78 zend_execute_data *execute_data);
79
80 ZEND_API void ZEND_FASTCALL zend_observer_fcall_end(
81 zend_execute_data *execute_data,
82 zval *return_value);
83
84 ZEND_API void zend_observer_fcall_end_all(void);
85
86 typedef void (*zend_observer_function_declared_cb)(zend_op_array *op_array, zend_string *name);
87
88 ZEND_API void zend_observer_function_declared_register(zend_observer_function_declared_cb cb);
89 ZEND_API void ZEND_FASTCALL _zend_observer_function_declared_notify(zend_op_array *op_array, zend_string *name);
zend_observer_function_declared_notify(zend_op_array * op_array,zend_string * name)90 static inline void zend_observer_function_declared_notify(zend_op_array *op_array, zend_string *name) {
91 if (UNEXPECTED(zend_observer_function_declared_observed)) {
92 _zend_observer_function_declared_notify(op_array, name);
93 }
94 }
95
96 typedef void (*zend_observer_class_linked_cb)(zend_class_entry *ce, zend_string *name);
97
98 ZEND_API void zend_observer_class_linked_register(zend_observer_class_linked_cb cb);
99 ZEND_API void ZEND_FASTCALL _zend_observer_class_linked_notify(zend_class_entry *ce, zend_string *name);
zend_observer_class_linked_notify(zend_class_entry * ce,zend_string * name)100 static inline void zend_observer_class_linked_notify(zend_class_entry *ce, zend_string *name) {
101 if (UNEXPECTED(zend_observer_class_linked_observed)) {
102 _zend_observer_class_linked_notify(ce, name);
103 }
104 }
105
106 typedef void (*zend_observer_error_cb)(int type, zend_string *error_filename, uint32_t error_lineno, zend_string *message);
107
108 ZEND_API void zend_observer_error_register(zend_observer_error_cb callback);
109 ZEND_API void _zend_observer_error_notify(int type, zend_string *error_filename, uint32_t error_lineno, zend_string *message);
zend_observer_error_notify(int type,zend_string * error_filename,uint32_t error_lineno,zend_string * message)110 static inline void zend_observer_error_notify(int type, zend_string *error_filename, uint32_t error_lineno, zend_string *message) {
111 if (UNEXPECTED(zend_observer_errors_observed)) {
112 _zend_observer_error_notify(type, error_filename, error_lineno, message);
113 }
114 }
115
116 typedef void (*zend_observer_fiber_init_handler)(zend_fiber_context *initializing);
117 typedef void (*zend_observer_fiber_switch_handler)(zend_fiber_context *from, zend_fiber_context *to);
118 typedef void (*zend_observer_fiber_destroy_handler)(zend_fiber_context *destroying);
119
120 ZEND_API void zend_observer_fiber_init_register(zend_observer_fiber_init_handler handler);
121 ZEND_API void zend_observer_fiber_switch_register(zend_observer_fiber_switch_handler handler);
122 ZEND_API void zend_observer_fiber_destroy_register(zend_observer_fiber_destroy_handler handler);
123
124 ZEND_API void ZEND_FASTCALL zend_observer_fiber_init_notify(zend_fiber_context *initializing);
125 ZEND_API void ZEND_FASTCALL zend_observer_fiber_switch_notify(zend_fiber_context *from, zend_fiber_context *to);
126 ZEND_API void ZEND_FASTCALL zend_observer_fiber_destroy_notify(zend_fiber_context *destroying);
127
128 END_EXTERN_C()
129
130 #endif /* ZEND_OBSERVER_H */
131
