Optimize observers #13649
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,6 +14,7 @@ | |
| +----------------------------------------------------------------------+ | ||
| | Authors: Levi Morrison <[email protected]> | | ||
| | Sammy Kaye Powers <[email protected]> | | ||
| | Bob Weinand <[email protected]> | | ||
| +----------------------------------------------------------------------+ | ||
| */ | ||
|
|
||
|
|
@@ -23,15 +24,8 @@ | |
| #include "zend_llist.h" | ||
| #include "zend_vm.h" | ||
|
|
||
| #define ZEND_OBSERVER_NOT_OBSERVED ((void *) 2) | ||
|
|
||
|
Comment on lines
-32
to
-33
There was a problem hiding this comment. Where does this check effectively move to? There was a problem hiding this comment. to zend_observer_fcall_has_no_observers in zend_observer.h |
||
| static zend_llist zend_observers_fcall_list; | ||
| static zend_llist zend_observer_function_declared_callbacks; | ||
| static zend_llist zend_observer_class_linked_callbacks; | ||
|
|
@@ -46,8 +40,6 @@ bool zend_observer_errors_observed; | |
| bool zend_observer_function_declared_observed; | ||
| bool zend_observer_class_linked_observed; | ||
|
|
||
| // Call during minit/startup ONLY | ||
| ZEND_API void zend_observer_fcall_register(zend_observer_fcall_init init) | ||
| { | ||
|
|
@@ -107,7 +99,7 @@ ZEND_API void zend_observer_post_startup(void) | |
|
|
||
| ZEND_API void zend_observer_activate(void) | ||
| { | ||
| EG(current_observed_frame) = NULL; | ||
| } | ||
|
|
||
| ZEND_API void zend_observer_shutdown(void) | ||
|
|
@@ -127,21 +119,24 @@ static void zend_observer_fcall_install(zend_execute_data *execute_data) | |
| zend_function *function = execute_data->func; | ||
|
|
||
| ZEND_ASSERT(RUN_TIME_CACHE(&function->common)); | ||
| zend_observer_fcall_begin_handler *begin_handlers = ZEND_OBSERVER_DATA(function), *begin_handlers_start = begin_handlers; | ||
| zend_observer_fcall_end_handler *end_handlers = (zend_observer_fcall_end_handler *)begin_handlers + list->count, *end_handlers_start = end_handlers; | ||
|
|
||
| *begin_handlers = ZEND_OBSERVER_NOT_OBSERVED; | ||
| *end_handlers = ZEND_OBSERVER_NOT_OBSERVED; | ||
| bool has_handlers = false; | ||
|
|
||
| for (zend_llist_element *element = list->head; element; element = element->next) { | ||
| zend_observer_fcall_init init; | ||
| memcpy(&init, element->data, sizeof init); | ||
| zend_observer_fcall_handlers handlers = init(execute_data); | ||
| if (handlers.begin) { | ||
| *(begin_handlers++) = handlers.begin; | ||
| has_handlers = true; | ||
| } | ||
| if (handlers.end) { | ||
| *(end_handlers++) = handlers.end; | ||
| has_handlers = true; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -151,6 +146,10 @@ static void zend_observer_fcall_install(zend_execute_data *execute_data) | |
| *end_handlers = *end_handlers_start; | ||
| *end_handlers_start = tmp; | ||
| } | ||
|
|
||
| if (!has_handlers) { | ||
| *begin_handlers_start = ZEND_OBSERVER_NONE_OBSERVED; | ||
| } | ||
| } | ||
|
|
||
| /* We need to provide the ability to retrieve the handler which will move onto the position the current handler was. | ||
|
|
@@ -182,8 +181,8 @@ static bool zend_observer_remove_handler(void **first_handler, void *old_handler | |
|
|
||
| ZEND_API void zend_observer_add_begin_handler(zend_function *function, zend_observer_fcall_begin_handler begin) { | ||
| size_t registered_observers = zend_observers_fcall_list.count; | ||
| zend_observer_fcall_begin_handler *first_handler = ZEND_OBSERVER_DATA(function), *last_handler = first_handler + registered_observers - 1; | ||
| if (*first_handler == ZEND_OBSERVER_NOT_OBSERVED || *first_handler == ZEND_OBSERVER_NONE_OBSERVED) { | ||
| *first_handler = begin; | ||
| } else { | ||
| for (zend_observer_fcall_begin_handler *cur_handler = first_handler + 1; cur_handler <= last_handler; ++cur_handler) { | ||
|
|
@@ -198,24 +197,45 @@ ZEND_API void zend_observer_add_begin_handler(zend_function *function, zend_obse | |
| } | ||
|
|
||
| ZEND_API bool zend_observer_remove_begin_handler(zend_function *function, zend_observer_fcall_begin_handler begin, zend_observer_fcall_begin_handler *next) { | ||
| void **begin_handlers = (void **)ZEND_OBSERVER_DATA(function); | ||
| if (zend_observer_remove_handler(begin_handlers, begin, (void**)next)) { | ||
| if (*begin_handlers == ZEND_OBSERVER_NOT_OBSERVED) { | ||
| size_t registered_observers = zend_observers_fcall_list.count; | ||
| if (begin_handlers[registered_observers] /* first end handler */ == ZEND_OBSERVER_NOT_OBSERVED) { | ||
| *begin_handlers = ZEND_OBSERVER_NONE_OBSERVED; | ||
| } | ||
| } | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
bwoebi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ZEND_API void zend_observer_add_end_handler(zend_function *function, zend_observer_fcall_end_handler end) { | ||
| size_t registered_observers = zend_observers_fcall_list.count; | ||
| void **begin_handler = (void **)ZEND_OBSERVER_DATA(function); | ||
| zend_observer_fcall_end_handler *end_handler = (zend_observer_fcall_end_handler *)begin_handler + registered_observers; | ||
| // to allow to preserve the invariant that end handlers are in reverse order of begin handlers, push the new end handler in front | ||
| if (*end_handler != ZEND_OBSERVER_NOT_OBSERVED) { | ||
| // there's no space for new handlers, then it's forbidden to call this function | ||
| ZEND_ASSERT(end_handler[registered_observers - 1] == NULL); | ||
| memmove(end_handler + 1, end_handler, sizeof(end_handler) * (registered_observers - 1)); | ||
| } else if (*begin_handler == ZEND_OBSERVER_NONE_OBSERVED) { | ||
| *begin_handler = ZEND_OBSERVER_NOT_OBSERVED; | ||
| } | ||
| *end_handler = end; | ||
| } | ||
|
|
||
| ZEND_API bool zend_observer_remove_end_handler(zend_function *function, zend_observer_fcall_end_handler end, zend_observer_fcall_end_handler *next) { | ||
| size_t registered_observers = zend_observers_fcall_list.count; | ||
| void **begin_handlers = (void **)ZEND_OBSERVER_DATA(function); | ||
| void **end_handlers = begin_handlers + registered_observers; | ||
| if (zend_observer_remove_handler(end_handlers, end, (void**)next)) { | ||
| if (*begin_handlers == ZEND_OBSERVER_NOT_OBSERVED && *end_handlers == ZEND_OBSERVER_NOT_OBSERVED) { | ||
| *begin_handlers = ZEND_OBSERVER_NONE_OBSERVED; | ||
| } | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| static inline zend_execute_data **prev_observed_frame(zend_execute_data *execute_data) { | ||
|
|
@@ -224,33 +244,33 @@ static inline zend_execute_data **prev_observed_frame(zend_execute_data *execute | |
| return (zend_execute_data **)&Z_PTR_P(EX_VAR_NUM((ZEND_USER_CODE(func->type) ? func->op_array.last_var : ZEND_CALL_NUM_ARGS(execute_data)) + func->common.T - 1)); | ||
| } | ||
|
|
||
| static void ZEND_FASTCALL _zend_observe_fcall_begin(zend_execute_data *execute_data) { | ||
| if (!ZEND_OBSERVER_ENABLED) { | ||
| return; | ||
| } | ||
|
|
||
| zend_observer_fcall_begin_specialized(execute_data, true); | ||
| } | ||
|
|
||
| ZEND_API void ZEND_FASTCALL zend_observer_fcall_begin_prechecked(zend_execute_data *execute_data, zend_observer_fcall_begin_handler *handler) | ||
| { | ||
| zend_observer_fcall_begin_handler *possible_handlers_end = handler + zend_observers_fcall_list.count; | ||
|
|
||
| if (!*handler) { | ||
| zend_observer_fcall_install(execute_data); | ||
| if (zend_observer_handler_is_unobserved(handler)) { | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| zend_observer_fcall_end_handler *end_handler = (zend_observer_fcall_end_handler *)possible_handlers_end; | ||
| if (*end_handler != ZEND_OBSERVER_NOT_OBSERVED) { | ||
| *prev_observed_frame(execute_data) = EG(current_observed_frame); | ||
| EG(current_observed_frame) = execute_data; | ||
|
|
||
| if (*handler == ZEND_OBSERVER_NOT_OBSERVED) { // this function must not be called if ZEND_OBSERVER_NONE_OBSERVED, hence sufficient to check | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| do { | ||
|
|
@@ -265,17 +285,17 @@ ZEND_API void ZEND_FASTCALL zend_observer_generator_resume(zend_execute_data *ex | |
|
|
||
| ZEND_API void ZEND_FASTCALL zend_observer_fcall_begin(zend_execute_data *execute_data) | ||
| { | ||
| ZEND_ASSUME(EX(func)); | ||
| if (!(EX(func)->common.fn_flags & ZEND_ACC_GENERATOR)) { | ||
| _zend_observe_fcall_begin(execute_data); | ||
| } | ||
| } | ||
|
|
||
| static inline void call_end_observers(zend_execute_data *execute_data, zval *return_value) { | ||
| zend_function *func = EX(func); | ||
| ZEND_ASSERT(func); | ||
|
|
||
| zend_observer_fcall_end_handler *handler = (zend_observer_fcall_end_handler *)ZEND_OBSERVER_DATA(func) + zend_observers_fcall_list.count; | ||
| // TODO: Fix exceptions from generators | ||
| // ZEND_ASSERT(fcall_data); | ||
| if (!*handler || *handler == ZEND_OBSERVER_NOT_OBSERVED) { | ||
|
|
@@ -288,19 +308,16 @@ static inline void call_end_observers(zend_execute_data *execute_data, zval *ret | |
| } while (++handler != possible_handlers_end && *handler != NULL); | ||
| } | ||
|
|
||
| ZEND_API void ZEND_FASTCALL zend_observer_fcall_end_prechecked(zend_execute_data *execute_data, zval *return_value) | ||
| { | ||
| call_end_observers(execute_data, return_value); | ||
| EG(current_observed_frame) = *prev_observed_frame(execute_data); | ||
| } | ||
|
|
||
| ZEND_API void zend_observer_fcall_end_all(void) | ||
| { | ||
| zend_execute_data *execute_data = EG(current_observed_frame), *original_execute_data = EG(current_execute_data); | ||
| EG(current_observed_frame) = NULL; | ||
| while (execute_data) { | ||
| EG(current_execute_data) = execute_data; | ||
| call_end_observers(execute_data, NULL); | ||
|
|
@@ -401,8 +418,8 @@ ZEND_API void ZEND_FASTCALL zend_observer_fiber_switch_notify(zend_fiber_context | |
| callback(from, to); | ||
| } | ||
|
|
||
| from->top_observed_frame = EG(current_observed_frame); | ||
| EG(current_observed_frame) = to->top_observed_frame; | ||
| } | ||
|
|
||
| ZEND_API void ZEND_FASTCALL zend_observer_fiber_destroy_notify(zend_fiber_context *destroying) | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't understand what are you doing here, and how this is related to observer optimization.
If this is a bug fix, please explain and commit this separately.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There will be a frame (the observed call) on top of the FRAMELESS opcode now. If I don't do this, it will try to generate the frame for the FRAMLESS frame on top of that, i.e. observed frameless calls would appear twice in stacktraces now.