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 | Bob Weinand <bobwei9@hotmail.com> |
18 +----------------------------------------------------------------------+
19 */
20
21 #ifndef ZEND_OBSERVER_H
22 #define ZEND_OBSERVER_H
23
24 #include "zend.h"
25 #include "zend_compile.h"
26 #include "zend_fibers.h"
27
28 BEGIN_EXTERN_C()
29
30 extern ZEND_API int zend_observer_fcall_op_array_extension;
31 extern ZEND_API int zend_observer_fcall_internal_function_extension;
32 extern ZEND_API bool zend_observer_errors_observed;
33 extern ZEND_API bool zend_observer_function_declared_observed;
34 extern ZEND_API bool zend_observer_class_linked_observed;
35
36 #define ZEND_OBSERVER_HANDLE(function) (ZEND_USER_CODE((function)->type) \
37 ? zend_observer_fcall_op_array_extension : zend_observer_fcall_internal_function_extension)
38
39 #define ZEND_OBSERVER_DATA(function) \
40 ((zend_observer_fcall_begin_handler *)&ZEND_OP_ARRAY_EXTENSION((&(function)->common), ZEND_OBSERVER_HANDLE(function)))
41
42 /* Neither begin nor end handler present. Needs to be set in the slot of the begin handler.
43 * Optimization reducing runtime checks. */
44 #define ZEND_OBSERVER_NONE_OBSERVED ((void *) 3)
45
46 /* Omit zend_observer_fcall_internal_function_extension check, they are set at the same time. */
47 #define ZEND_OBSERVER_ENABLED (zend_observer_fcall_op_array_extension != -1)
48
49 #define ZEND_OBSERVER_FCALL_BEGIN(execute_data) do { \
50 if (ZEND_OBSERVER_ENABLED) { \
51 zend_observer_fcall_begin(execute_data); \
52 } \
53 } while (0)
54
55 #define ZEND_OBSERVER_FCALL_END(execute_data, return_value) do { \
56 if (ZEND_OBSERVER_ENABLED) { \
57 zend_observer_fcall_end(execute_data, return_value); \
58 } \
59 } while (0)
60
61 typedef void (*zend_observer_fcall_begin_handler)(zend_execute_data *execute_data);
62 typedef void (*zend_observer_fcall_end_handler)(zend_execute_data *execute_data, zval *retval);
63
64 typedef struct _zend_observer_fcall_handlers {
65 zend_observer_fcall_begin_handler begin;
66 zend_observer_fcall_end_handler end;
67 } zend_observer_fcall_handlers;
68
69 /* If the fn should not be observed then return {NULL, NULL} */
70 typedef zend_observer_fcall_handlers (*zend_observer_fcall_init)(zend_execute_data *execute_data);
71
72 // Call during minit/startup ONLY
73 ZEND_API void zend_observer_fcall_register(zend_observer_fcall_init);
74
75 // Call during runtime, but only if you have used zend_observer_fcall_register.
76 // 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.
77 ZEND_API void zend_observer_add_begin_handler(zend_function *function, zend_observer_fcall_begin_handler begin);
78 ZEND_API bool zend_observer_remove_begin_handler(zend_function *function, zend_observer_fcall_begin_handler begin, zend_observer_fcall_begin_handler *next);
79 ZEND_API void zend_observer_add_end_handler(zend_function *function, zend_observer_fcall_end_handler end);
80 ZEND_API bool zend_observer_remove_end_handler(zend_function *function, zend_observer_fcall_end_handler end, zend_observer_fcall_end_handler *next);
81
82 ZEND_API void zend_observer_startup(void); // Called by engine before MINITs
83 ZEND_API void zend_observer_post_startup(void); // Called by engine after MINITs
84 ZEND_API void zend_observer_activate(void);
85 ZEND_API void zend_observer_shutdown(void);
86
87 ZEND_API void ZEND_FASTCALL zend_observer_fcall_begin(zend_execute_data *execute_data);
88 /* prechecked: the call is actually observed. */
89 ZEND_API void ZEND_FASTCALL zend_observer_fcall_begin_prechecked(zend_execute_data *execute_data, zend_observer_fcall_begin_handler *observer_data);
90
zend_observer_handler_is_unobserved(zend_observer_fcall_begin_handler * handler)91 static zend_always_inline bool zend_observer_handler_is_unobserved(zend_observer_fcall_begin_handler *handler) {
92 return *handler == ZEND_OBSERVER_NONE_OBSERVED;
93 }
94
95 /* Initial check for observers has not happened yet or no observers are installed. */
zend_observer_fcall_has_no_observers(zend_execute_data * execute_data,bool allow_generator,zend_observer_fcall_begin_handler ** handler)96 static zend_always_inline bool zend_observer_fcall_has_no_observers(zend_execute_data *execute_data, bool allow_generator, zend_observer_fcall_begin_handler **handler) {
97 zend_function *function = EX(func);
98 void *ZEND_MAP_PTR(runtime_cache) = ZEND_MAP_PTR(function->common.run_time_cache);
99
100 if (function->common.fn_flags & (ZEND_ACC_CALL_VIA_TRAMPOLINE | (allow_generator ? 0 : ZEND_ACC_GENERATOR))) {
101 return true;
102 }
103
104 if (!ZEND_MAP_PTR(runtime_cache)) {
105 return true;
106 }
107
108 *handler = (zend_observer_fcall_begin_handler *)ZEND_MAP_PTR_GET(runtime_cache) + ZEND_OBSERVER_HANDLE(function);
109 return zend_observer_handler_is_unobserved(*handler);
110 }
111
112 /* zend_observer_fcall_begin(), but with generator check inlined and optimized away. */
zend_observer_fcall_begin_specialized(zend_execute_data * execute_data,bool allow_generator)113 static zend_always_inline void zend_observer_fcall_begin_specialized(zend_execute_data *execute_data, bool allow_generator) {
114 zend_observer_fcall_begin_handler *handler;
115 if (!zend_observer_fcall_has_no_observers(execute_data, allow_generator, &handler)) {
116 zend_observer_fcall_begin_prechecked(execute_data, handler);
117 }
118 }
119
120 ZEND_API void ZEND_FASTCALL zend_observer_generator_resume(zend_execute_data *execute_data);
121
122 /* prechecked: the call is actually observed. */
123 ZEND_API void ZEND_FASTCALL zend_observer_fcall_end_prechecked(zend_execute_data *execute_data, zval *return_value);
zend_observer_fcall_end(zend_execute_data * execute_data,zval * return_value)124 static zend_always_inline void zend_observer_fcall_end(zend_execute_data *execute_data, zval *return_value) {
125 if (execute_data == EG(current_observed_frame)) {
126 zend_observer_fcall_end_prechecked(execute_data, return_value);
127 }
128 }
129
130 ZEND_API void zend_observer_fcall_end_all(void);
131
132 typedef void (*zend_observer_function_declared_cb)(zend_op_array *op_array, zend_string *name);
133
134 ZEND_API void zend_observer_function_declared_register(zend_observer_function_declared_cb cb);
135 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)136 static inline void zend_observer_function_declared_notify(zend_op_array *op_array, zend_string *name) {
137 if (UNEXPECTED(zend_observer_function_declared_observed)) {
138 _zend_observer_function_declared_notify(op_array, name);
139 }
140 }
141
142 typedef void (*zend_observer_class_linked_cb)(zend_class_entry *ce, zend_string *name);
143
144 ZEND_API void zend_observer_class_linked_register(zend_observer_class_linked_cb cb);
145 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)146 static inline void zend_observer_class_linked_notify(zend_class_entry *ce, zend_string *name) {
147 if (UNEXPECTED(zend_observer_class_linked_observed)) {
148 _zend_observer_class_linked_notify(ce, name);
149 }
150 }
151
152 typedef void (*zend_observer_error_cb)(int type, zend_string *error_filename, uint32_t error_lineno, zend_string *message);
153
154 ZEND_API void zend_observer_error_register(zend_observer_error_cb callback);
155 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)156 static inline void zend_observer_error_notify(int type, zend_string *error_filename, uint32_t error_lineno, zend_string *message) {
157 if (UNEXPECTED(zend_observer_errors_observed)) {
158 _zend_observer_error_notify(type, error_filename, error_lineno, message);
159 }
160 }
161
162 typedef void (*zend_observer_fiber_init_handler)(zend_fiber_context *initializing);
163 typedef void (*zend_observer_fiber_switch_handler)(zend_fiber_context *from, zend_fiber_context *to);
164 typedef void (*zend_observer_fiber_destroy_handler)(zend_fiber_context *destroying);
165
166 ZEND_API void zend_observer_fiber_init_register(zend_observer_fiber_init_handler handler);
167 ZEND_API void zend_observer_fiber_switch_register(zend_observer_fiber_switch_handler handler);
168 ZEND_API void zend_observer_fiber_destroy_register(zend_observer_fiber_destroy_handler handler);
169
170 ZEND_API void ZEND_FASTCALL zend_observer_fiber_init_notify(zend_fiber_context *initializing);
171 ZEND_API void ZEND_FASTCALL zend_observer_fiber_switch_notify(zend_fiber_context *from, zend_fiber_context *to);
172 ZEND_API void ZEND_FASTCALL zend_observer_fiber_destroy_notify(zend_fiber_context *destroying);
173
174 END_EXTERN_C()
175
176 #endif /* ZEND_OBSERVER_H */
177
