Skip to content

Commit d5d31ea

Browse files
dstogovdstogov
committed
Cleanup observer API and add JIT support
1 parent b4c2670 commit d5d31ea

13 files changed

+170
-192
lines changed

‎Zend/zend_execute_API.c

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -891,9 +891,7 @@ zend_result zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_
891891
uint32_t orig_jit_trace_num = EG(jit_trace_num);
892892

893893
zend_init_func_execute_data(call, &func->op_array, fci->retval);
894-
if (ZEND_OBSERVER_ENABLED) {
895-
zend_observer_maybe_fcall_call_begin(call);
896-
}
894+
ZEND_OBSERVER_FCALL_BEGIN(call);
897895
zend_execute_ex(call);
898896
EG(jit_trace_num) = orig_jit_trace_num;
899897
EG(opline_before_exception) = current_opline_before_exception;

‎Zend/zend_generators.c

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -859,20 +859,11 @@ ZEND_API void zend_generator_resume(zend_generator *orig_generator) /* {{{ */
859859
if (!ZEND_OBSERVER_ENABLED) {
860860
zend_execute_ex(generator->execute_data);
861861
} else {
862-
zend_op_array *op_array = &generator->execute_data->func->op_array;
863-
void *observer_handlers = ZEND_OBSERVER_HANDLERS(op_array);
864-
if (!observer_handlers) {
865-
zend_observer_fcall_install((zend_function *)op_array);
866-
observer_handlers = ZEND_OBSERVER_HANDLERS(op_array);
867-
}
868-
ZEND_ASSERT(observer_handlers);
869-
if (observer_handlers != ZEND_OBSERVER_NOT_OBSERVED) {
870-
zend_observe_fcall_begin(observer_handlers, generator->execute_data);
871-
}
862+
zend_observer_generator_resume(generator->execute_data);
872863
zend_execute_ex(generator->execute_data);
873864
if (generator->execute_data) {
874865
/* On the final return, this will be called from ZEND_GENERATOR_RETURN */
875-
zend_observer_maybe_fcall_call_end(generator->execute_data, &generator->value);
866+
zend_observer_fcall_end(generator->execute_data, &generator->value);
876867
}
877868
}
878869
generator->flags &= ~ZEND_GENERATOR_CURRENTLY_RUNNING;

‎Zend/zend_observer.c

Lines changed: 88 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,28 @@
2323
#include "zend_llist.h"
2424
#include "zend_vm.h"
2525

26+
#define ZEND_OBSERVER_DATA(op_array) \
27+
ZEND_OP_ARRAY_EXTENSION(op_array, zend_observer_fcall_op_array_extension)
28+
29+
#define ZEND_OBSERVER_NOT_OBSERVED ((void *) 2)
30+
31+
#define ZEND_OBSERVABLE_FN(fn_flags) \
32+
(!(fn_flags & (ZEND_ACC_CALL_VIA_TRAMPOLINE | ZEND_ACC_FAKE_CLOSURE)))
33+
34+
typedef struct _zend_observer_fcall_data {
35+
// points after the last handler
36+
zend_observer_fcall_handlers *end;
37+
// a variadic array using "struct hack"
38+
zend_observer_fcall_handlers handlers[1];
39+
} zend_observer_fcall_data;
40+
2641
zend_llist zend_observers_fcall_list;
2742
zend_llist zend_observer_error_callbacks;
2843

2944
int zend_observer_fcall_op_array_extension = -1;
3045

3146
ZEND_TLS zend_arena *fcall_handlers_arena = NULL;
3247

33-
ZEND_API extern inline void zend_observer_maybe_fcall_call_begin(
34-
zend_execute_data *execute_data);
35-
ZEND_API extern inline void zend_observer_maybe_fcall_call_end(
36-
zend_execute_data *execute_data,
37-
zval *return_value);
38-
3948
// Call during minit/startup ONLY
4049
ZEND_API void zend_observer_fcall_register(zend_observer_fcall_init init) {
4150
/* We don't want to get an extension handle unless an ext installs an observer */
@@ -80,7 +89,7 @@ ZEND_API void zend_observer_shutdown(void) {
8089
zend_llist_destroy(&zend_observer_error_callbacks);
8190
}
8291

83-
ZEND_API void zend_observer_fcall_install(zend_function *function) {
92+
static void zend_observer_fcall_install(zend_function *function) {
8493
zend_llist_element *element;
8594
zend_llist *list = &zend_observers_fcall_list;
8695
zend_op_array *op_array = &function->op_array;
@@ -92,11 +101,11 @@ ZEND_API void zend_observer_fcall_install(zend_function *function) {
92101
ZEND_ASSERT(function->type != ZEND_INTERNAL_FUNCTION);
93102

94103
zend_llist handlers_list;
95-
zend_llist_init(&handlers_list, sizeof(zend_observer_fcall), NULL, 0);
104+
zend_llist_init(&handlers_list, sizeof(zend_observer_fcall_handlers), NULL, 0);
96105
for (element = list->head; element; element = element->next) {
97106
zend_observer_fcall_init init;
98107
memcpy(&init, element->data, sizeof init);
99-
zend_observer_fcall handlers = init(function);
108+
zend_observer_fcall_handlers handlers = init(function);
100109
if (handlers.begin || handlers.end) {
101110
zend_llist_add_element(&handlers_list, &handlers);
102111
}
@@ -105,58 +114,97 @@ ZEND_API void zend_observer_fcall_install(zend_function *function) {
105114
ZEND_ASSERT(RUN_TIME_CACHE(op_array));
106115
void *ext;
107116
if (handlers_list.count) {
108-
size_t size = sizeof(zend_observer_fcall_cache) + (handlers_list.count - 1) * sizeof(zend_observer_fcall);
109-
zend_observer_fcall_cache *cache = zend_arena_alloc(&fcall_handlers_arena, size);
110-
zend_observer_fcall *handler = cache->handlers;
117+
size_t size = sizeof(zend_observer_fcall_data) + (handlers_list.count - 1) * sizeof(zend_observer_fcall_handlers);
118+
zend_observer_fcall_data *fcall_data = zend_arena_alloc(&fcall_handlers_arena, size);
119+
zend_observer_fcall_handlers *handlers = fcall_data->handlers;
111120
for (element = handlers_list.head; element; element = element->next) {
112-
memcpy(handler++, element->data, sizeof *handler);
121+
memcpy(handlers++, element->data, sizeof *handlers);
113122
}
114-
cache->end = handler;
115-
ext = cache;
123+
fcall_data->end = handlers;
124+
ext = fcall_data;
116125
} else {
117126
ext = ZEND_OBSERVER_NOT_OBSERVED;
118127
}
119128

120-
ZEND_OBSERVER_HANDLERS(op_array) = ext;
129+
ZEND_OBSERVER_DATA(op_array) = ext;
121130
zend_llist_destroy(&handlers_list);
122131
}
123132

124-
ZEND_API void zend_observe_fcall_begin(
125-
zend_observer_fcall_cache *cache,
126-
zend_execute_data *execute_data)
133+
static void ZEND_FASTCALL _zend_observe_fcall_begin(zend_execute_data *execute_data)
127134
{
128-
zend_observer_fcall *handler, *end = cache->end;
129-
for (handler = cache->handlers; handler != end; ++handler) {
130-
if (handler->begin) {
131-
handler->begin(execute_data);
135+
zend_op_array *op_array;
136+
uint32_t fn_flags;
137+
zend_observer_fcall_data *fcall_data;
138+
zend_observer_fcall_handlers *handlers, *end;
139+
140+
if (!ZEND_OBSERVER_ENABLED) {
141+
return;
142+
}
143+
144+
op_array = &execute_data->func->op_array;
145+
fn_flags = op_array->fn_flags;
146+
147+
if (!ZEND_OBSERVABLE_FN(fn_flags)) {
148+
return;
149+
}
150+
151+
fcall_data = ZEND_OBSERVER_DATA(op_array);
152+
if (!fcall_data) {
153+
zend_observer_fcall_install((zend_function *)op_array);
154+
fcall_data = ZEND_OBSERVER_DATA(op_array);
155+
}
156+
157+
ZEND_ASSERT(fcall_data);
158+
if (fcall_data == ZEND_OBSERVER_NOT_OBSERVED) {
159+
return;
160+
}
161+
162+
end = fcall_data->end;
163+
for (handlers = fcall_data->handlers; handlers != end; ++handlers) {
164+
if (handlers->begin) {
165+
handlers->begin(execute_data);
132166
}
133167
}
134168
}
135169

136-
ZEND_API void zend_observer_fcall_call_end_helper(
137-
zend_execute_data *execute_data,
138-
zval *return_value)
170+
ZEND_API void ZEND_FASTCALL zend_observer_generator_resume(zend_execute_data *execute_data)
139171
{
140-
zend_function *func = execute_data->func;
141-
ZEND_ASSUME(ZEND_OBSERVABLE_FN(func->common.fn_flags));
142-
void *observer_handlers = ZEND_OBSERVER_HANDLERS(&func->op_array);
143-
// TODO: Fix exceptions from generators
144-
// ZEND_ASSERT(observer_handlers);
145-
if (observer_handlers && observer_handlers != ZEND_OBSERVER_NOT_OBSERVED) {
146-
zend_observer_fcall_cache *cache = observer_handlers;
147-
zend_observe_fcall_end(cache, execute_data, return_value);
172+
_zend_observe_fcall_begin(execute_data);
173+
}
174+
175+
ZEND_API void ZEND_FASTCALL zend_observer_fcall_begin(zend_execute_data *execute_data)
176+
{
177+
ZEND_ASSUME(execute_data->func);
178+
if (!(execute_data->func->common.fn_flags & ZEND_ACC_GENERATOR)) {
179+
_zend_observe_fcall_begin(execute_data);
148180
}
149181
}
150182

151-
ZEND_API void zend_observe_fcall_end(
152-
zend_observer_fcall_cache *cache,
183+
ZEND_API void ZEND_FASTCALL zend_observer_fcall_end(
153184
zend_execute_data *execute_data,
154185
zval *return_value)
155186
{
156-
zend_observer_fcall *handler = cache->end, *end = cache->handlers;
157-
while (handler-- != end) {
158-
if (handler->end) {
159-
handler->end(execute_data, return_value);
187+
zend_function *func = execute_data->func;
188+
zend_observer_fcall_data *fcall_data;
189+
zend_observer_fcall_handlers *handlers, *end;
190+
191+
if (!ZEND_OBSERVER_ENABLED
192+
|| !ZEND_OBSERVABLE_FN(func->common.fn_flags)) {
193+
return;
194+
}
195+
196+
fcall_data = (zend_observer_fcall_data*)ZEND_OBSERVER_DATA(&func->op_array);
197+
// TODO: Fix exceptions from generators
198+
// ZEND_ASSERT(fcall_data);
199+
if (!fcall_data || fcall_data == ZEND_OBSERVER_NOT_OBSERVED) {
200+
return;
201+
}
202+
203+
handlers = fcall_data->end;
204+
end = fcall_data->handlers;
205+
while (handlers-- != end) {
206+
if (handlers->end) {
207+
handlers->end(execute_data, return_value);
160208
}
161209
}
162210
}

‎Zend/zend_observer.h

Lines changed: 25 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -29,87 +29,47 @@ extern ZEND_API int zend_observer_fcall_op_array_extension;
2929

3030
#define ZEND_OBSERVER_ENABLED (zend_observer_fcall_op_array_extension != -1)
3131

32-
#define ZEND_OBSERVER_HANDLERS(op_array) \
33-
ZEND_OP_ARRAY_EXTENSION(op_array, zend_observer_fcall_op_array_extension)
34-
35-
#define ZEND_OBSERVER_NOT_OBSERVED ((void *) 2)
36-
37-
#define ZEND_OBSERVABLE_FN(fn_flags) \
38-
(ZEND_OBSERVER_ENABLED && \
39-
!(fn_flags & (ZEND_ACC_CALL_VIA_TRAMPOLINE | ZEND_ACC_FAKE_CLOSURE)))
40-
41-
struct zend_observer_fcall {
42-
void (*begin)(zend_execute_data *execute_data);
43-
void (*end)(zend_execute_data *execute_data, zval *retval);
44-
};
45-
typedef struct zend_observer_fcall zend_observer_fcall;
46-
47-
struct zend_observer_fcall_cache {
48-
// points after the last handler
49-
zend_observer_fcall *end;
50-
// a variadic array using "struct hack"
51-
zend_observer_fcall handlers[1];
52-
};
53-
typedef struct zend_observer_fcall_cache zend_observer_fcall_cache;
32+
#define ZEND_OBSERVER_FCALL_BEGIN(execute_data) do { \
33+
if (ZEND_OBSERVER_ENABLED) { \
34+
zend_observer_fcall_begin(execute_data); \
35+
} \
36+
} while (0)
37+
38+
#define ZEND_OBSERVER_FCALL_END(execute_data, return_value) do { \
39+
if (ZEND_OBSERVER_ENABLED) { \
40+
zend_observer_fcall_end(execute_data, return_value); \
41+
} \
42+
} while (0)
43+
44+
typedef void (*zend_observer_fcall_begin_handler)(zend_execute_data *execute_data);
45+
typedef void (*zend_observer_fcall_end_handler)(zend_execute_data *execute_data, zval *retval);
46+
47+
typedef struct _zend_observer_fcall_handlers {
48+
zend_observer_fcall_begin_handler begin;
49+
zend_observer_fcall_end_handler end;
50+
} zend_observer_fcall_handlers;
5451

5552
/* If the fn should not be observed then return {NULL, NULL} */
56-
typedef zend_observer_fcall(*zend_observer_fcall_init)(zend_function *func);
53+
typedef zend_observer_fcall_handlers (*zend_observer_fcall_init)(zend_function *func);
5754

5855
// Call during minit/startup ONLY
59-
ZEND_API void zend_observer_fcall_register(zend_observer_fcall_init init);
56+
ZEND_API void zend_observer_fcall_register(zend_observer_fcall_init);
6057

6158
ZEND_API void zend_observer_startup(void); // Called by engine before MINITs
6259
ZEND_API void zend_observer_activate(void);
6360
ZEND_API void zend_observer_deactivate(void);
6461
ZEND_API void zend_observer_shutdown(void);
6562

66-
ZEND_API void zend_observer_fcall_install(zend_function *function);
67-
68-
ZEND_API void zend_observe_fcall_begin(
69-
zend_observer_fcall_cache *cache,
63+
ZEND_API void ZEND_FASTCALL zend_observer_fcall_begin(
7064
zend_execute_data *execute_data);
7165

72-
ZEND_API void zend_observe_fcall_end(
73-
zend_observer_fcall_cache *cache,
74-
zend_execute_data *execute_data,
75-
zval *return_value);
66+
ZEND_API void ZEND_FASTCALL zend_observer_generator_resume(
67+
zend_execute_data *execute_data);
7668

77-
ZEND_API void zend_observer_fcall_call_end_helper(
69+
ZEND_API void ZEND_FASTCALL zend_observer_fcall_end(
7870
zend_execute_data *execute_data,
7971
zval *return_value);
8072

81-
ZEND_API zend_always_inline void zend_observer_maybe_fcall_call_begin(
82-
zend_execute_data *execute_data)
83-
{
84-
ZEND_ASSUME(execute_data->func);
85-
zend_op_array *op_array = &execute_data->func->op_array;
86-
uint32_t fn_flags = op_array->fn_flags;
87-
if (ZEND_OBSERVABLE_FN(fn_flags) && !(fn_flags & ZEND_ACC_GENERATOR)) {
88-
void *observer_handlers = ZEND_OBSERVER_HANDLERS(op_array);
89-
if (!observer_handlers) {
90-
zend_observer_fcall_install((zend_function *)op_array);
91-
observer_handlers = ZEND_OBSERVER_HANDLERS(op_array);
92-
}
93-
94-
ZEND_ASSERT(observer_handlers);
95-
if (observer_handlers != ZEND_OBSERVER_NOT_OBSERVED) {
96-
zend_observe_fcall_begin(
97-
(zend_observer_fcall_cache *)observer_handlers,
98-
execute_data);
99-
}
100-
}
101-
}
102-
103-
ZEND_API zend_always_inline void zend_observer_maybe_fcall_call_end(
104-
zend_execute_data *execute_data,
105-
zval *return_value)
106-
{
107-
zend_function *func = execute_data->func;
108-
if (ZEND_OBSERVABLE_FN(func->common.fn_flags)) {
109-
zend_observer_fcall_call_end_helper(execute_data, return_value);
110-
}
111-
}
112-
11373
typedef void (*zend_observer_error_cb)(int type, const char *error_filename, uint32_t error_lineno, zend_string *message);
11474

11575
ZEND_API void zend_observer_error_register(zend_observer_error_cb callback);

0 commit comments

Comments
 (0)