xref: /PHP-8.1/Zend/zend_observer.h (revision e6cf5831)
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 
31 #define ZEND_OBSERVER_ENABLED (zend_observer_fcall_op_array_extension != -1)
32 
33 #define ZEND_OBSERVER_FCALL_BEGIN(execute_data) do { \
34 		if (ZEND_OBSERVER_ENABLED) { \
35 			zend_observer_fcall_begin(execute_data); \
36 		} \
37 	} while (0)
38 
39 #define ZEND_OBSERVER_FCALL_END(execute_data, return_value) do { \
40 		if (ZEND_OBSERVER_ENABLED) { \
41 			zend_observer_fcall_end(execute_data, return_value); \
42 		} \
43 	} while (0)
44 
45 typedef void (*zend_observer_fcall_begin_handler)(zend_execute_data *execute_data);
46 typedef void (*zend_observer_fcall_end_handler)(zend_execute_data *execute_data, zval *retval);
47 
48 typedef struct _zend_observer_fcall_handlers {
49 	zend_observer_fcall_begin_handler begin;
50 	zend_observer_fcall_end_handler end;
51 } zend_observer_fcall_handlers;
52 
53 /* If the fn should not be observed then return {NULL, NULL} */
54 typedef zend_observer_fcall_handlers (*zend_observer_fcall_init)(zend_execute_data *execute_data);
55 
56 // Call during minit/startup ONLY
57 ZEND_API void zend_observer_fcall_register(zend_observer_fcall_init);
58 
59 ZEND_API void zend_observer_startup(void); // Called by engine before MINITs
60 ZEND_API void zend_observer_post_startup(void); // Called by engine after MINITs
61 ZEND_API void zend_observer_activate(void);
62 ZEND_API void zend_observer_deactivate(void);
63 ZEND_API void zend_observer_shutdown(void);
64 
65 ZEND_API void ZEND_FASTCALL zend_observer_fcall_begin(
66 	zend_execute_data *execute_data);
67 
68 ZEND_API void ZEND_FASTCALL zend_observer_generator_resume(
69 	zend_execute_data *execute_data);
70 
71 ZEND_API void ZEND_FASTCALL zend_observer_fcall_end(
72 	zend_execute_data *execute_data,
73 	zval *return_value);
74 
75 ZEND_API void zend_observer_fcall_end_all(void);
76 
77 typedef void (*zend_observer_error_cb)(int type, zend_string *error_filename, uint32_t error_lineno, zend_string *message);
78 
79 ZEND_API void zend_observer_error_register(zend_observer_error_cb callback);
80 void zend_observer_error_notify(int type, zend_string *error_filename, uint32_t error_lineno, zend_string *message);
81 
82 typedef void (*zend_observer_fiber_init_handler)(zend_fiber_context *initializing);
83 typedef void (*zend_observer_fiber_switch_handler)(zend_fiber_context *from, zend_fiber_context *to);
84 typedef void (*zend_observer_fiber_destroy_handler)(zend_fiber_context *destroying);
85 
86 ZEND_API void zend_observer_fiber_init_register(zend_observer_fiber_init_handler handler);
87 ZEND_API void zend_observer_fiber_switch_register(zend_observer_fiber_switch_handler handler);
88 ZEND_API void zend_observer_fiber_destroy_register(zend_observer_fiber_destroy_handler handler);
89 
90 ZEND_API void ZEND_FASTCALL zend_observer_fiber_init_notify(zend_fiber_context *initializing);
91 ZEND_API void ZEND_FASTCALL zend_observer_fiber_switch_notify(zend_fiber_context *from, zend_fiber_context *to);
92 ZEND_API void ZEND_FASTCALL zend_observer_fiber_destroy_notify(zend_fiber_context *destroying);
93 
94 END_EXTERN_C()
95 
96 #endif /* ZEND_OBSERVER_H */
97