Skip to content

Commit

Permalink
Cleanup observer API and add JIT support
Browse files Browse the repository at this point in the history
  • Loading branch information
@dstogov
dstogov committed Sep 18, 2020
1 parent b4c2670 commit d5d31ea
Show file tree
Hide file tree
Showing 13 changed files with 170 additions and 192 deletions.
4 changes: 1 addition & 3 deletions Zend/zend_execute_API.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -891,9 +891,7 @@ zend_result zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_
uint32_t orig_jit_trace_num = EG(jit_trace_num);

zend_init_func_execute_data(call, &func->op_array, fci->retval);
if (ZEND_OBSERVER_ENABLED) {
zend_observer_maybe_fcall_call_begin(call);
}
ZEND_OBSERVER_FCALL_BEGIN(call);
zend_execute_ex(call);
EG(jit_trace_num) = orig_jit_trace_num;
EG(opline_before_exception) = current_opline_before_exception;
Expand Down
13 changes: 2 additions & 11 deletions Zend/zend_generators.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -859,20 +859,11 @@ ZEND_API void zend_generator_resume(zend_generator *orig_generator) /* {{{ */
if (!ZEND_OBSERVER_ENABLED) {
zend_execute_ex(generator->execute_data);
} else {
zend_op_array *op_array = &generator->execute_data->func->op_array;
void *observer_handlers = ZEND_OBSERVER_HANDLERS(op_array);
if (!observer_handlers) {
zend_observer_fcall_install((zend_function *)op_array);
observer_handlers = ZEND_OBSERVER_HANDLERS(op_array);
}
ZEND_ASSERT(observer_handlers);
if (observer_handlers != ZEND_OBSERVER_NOT_OBSERVED) {
zend_observe_fcall_begin(observer_handlers, generator->execute_data);
}
zend_observer_generator_resume(generator->execute_data);
zend_execute_ex(generator->execute_data);
if (generator->execute_data) {
/* On the final return, this will be called from ZEND_GENERATOR_RETURN */
zend_observer_maybe_fcall_call_end(generator->execute_data, &generator->value);
zend_observer_fcall_end(generator->execute_data, &generator->value);
}
}
generator->flags &= ~ZEND_GENERATOR_CURRENTLY_RUNNING;
Expand Down
128 changes: 88 additions & 40 deletions Zend/zend_observer.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,28 @@
#include "zend_llist.h"
#include "zend_vm.h"

#define ZEND_OBSERVER_DATA(op_array) \
ZEND_OP_ARRAY_EXTENSION(op_array, zend_observer_fcall_op_array_extension)

#define ZEND_OBSERVER_NOT_OBSERVED ((void *) 2)

#define ZEND_OBSERVABLE_FN(fn_flags) \
(!(fn_flags & (ZEND_ACC_CALL_VIA_TRAMPOLINE | ZEND_ACC_FAKE_CLOSURE)))

typedef struct _zend_observer_fcall_data {
// points after the last handler
zend_observer_fcall_handlers *end;
// a variadic array using "struct hack"
zend_observer_fcall_handlers handlers[1];
} zend_observer_fcall_data;

zend_llist zend_observers_fcall_list;
zend_llist zend_observer_error_callbacks;

int zend_observer_fcall_op_array_extension = -1;

ZEND_TLS zend_arena *fcall_handlers_arena = NULL;

ZEND_API extern inline void zend_observer_maybe_fcall_call_begin(
zend_execute_data *execute_data);
ZEND_API extern inline void zend_observer_maybe_fcall_call_end(
zend_execute_data *execute_data,
zval *return_value);

// Call during minit/startup ONLY
ZEND_API void zend_observer_fcall_register(zend_observer_fcall_init init) {
/* We don't want to get an extension handle unless an ext installs an observer */
Expand Down Expand Up @@ -80,7 +89,7 @@ ZEND_API void zend_observer_shutdown(void) {
zend_llist_destroy(&zend_observer_error_callbacks);
}

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

zend_llist handlers_list;
zend_llist_init(&handlers_list, sizeof(zend_observer_fcall), NULL, 0);
zend_llist_init(&handlers_list, sizeof(zend_observer_fcall_handlers), NULL, 0);
for (element = list->head; element; element = element->next) {
zend_observer_fcall_init init;
memcpy(&init, element->data, sizeof init);
zend_observer_fcall handlers = init(function);
zend_observer_fcall_handlers handlers = init(function);
if (handlers.begin || handlers.end) {
zend_llist_add_element(&handlers_list, &handlers);
}
Expand All @@ -105,58 +114,97 @@ ZEND_API void zend_observer_fcall_install(zend_function *function) {
ZEND_ASSERT(RUN_TIME_CACHE(op_array));
void *ext;
if (handlers_list.count) {
size_t size = sizeof(zend_observer_fcall_cache) + (handlers_list.count - 1) * sizeof(zend_observer_fcall);
zend_observer_fcall_cache *cache = zend_arena_alloc(&fcall_handlers_arena, size);
zend_observer_fcall *handler = cache->handlers;
size_t size = sizeof(zend_observer_fcall_data) + (handlers_list.count - 1) * sizeof(zend_observer_fcall_handlers);
zend_observer_fcall_data *fcall_data = zend_arena_alloc(&fcall_handlers_arena, size);
zend_observer_fcall_handlers *handlers = fcall_data->handlers;
for (element = handlers_list.head; element; element = element->next) {
memcpy(handler++, element->data, sizeof *handler);
memcpy(handlers++, element->data, sizeof *handlers);
}
cache->end = handler;
ext = cache;
fcall_data->end = handlers;
ext = fcall_data;
} else {
ext = ZEND_OBSERVER_NOT_OBSERVED;
}

ZEND_OBSERVER_HANDLERS(op_array) = ext;
ZEND_OBSERVER_DATA(op_array) = ext;
zend_llist_destroy(&handlers_list);
}

ZEND_API void zend_observe_fcall_begin(
zend_observer_fcall_cache *cache,
zend_execute_data *execute_data)
static void ZEND_FASTCALL _zend_observe_fcall_begin(zend_execute_data *execute_data)
{
zend_observer_fcall *handler, *end = cache->end;
for (handler = cache->handlers; handler != end; ++handler) {
if (handler->begin) {
handler->begin(execute_data);
zend_op_array *op_array;
uint32_t fn_flags;
zend_observer_fcall_data *fcall_data;
zend_observer_fcall_handlers *handlers, *end;

if (!ZEND_OBSERVER_ENABLED) {
return;
}

op_array = &execute_data->func->op_array;
fn_flags = op_array->fn_flags;

if (!ZEND_OBSERVABLE_FN(fn_flags)) {
return;
}

fcall_data = ZEND_OBSERVER_DATA(op_array);
if (!fcall_data) {
zend_observer_fcall_install((zend_function *)op_array);
fcall_data = ZEND_OBSERVER_DATA(op_array);
}

ZEND_ASSERT(fcall_data);
if (fcall_data == ZEND_OBSERVER_NOT_OBSERVED) {
return;
}

end = fcall_data->end;
for (handlers = fcall_data->handlers; handlers != end; ++handlers) {
if (handlers->begin) {
handlers->begin(execute_data);
}
}
}

ZEND_API void zend_observer_fcall_call_end_helper(
zend_execute_data *execute_data,
zval *return_value)
ZEND_API void ZEND_FASTCALL zend_observer_generator_resume(zend_execute_data *execute_data)
{
zend_function *func = execute_data->func;
ZEND_ASSUME(ZEND_OBSERVABLE_FN(func->common.fn_flags));
void *observer_handlers = ZEND_OBSERVER_HANDLERS(&func->op_array);
// TODO: Fix exceptions from generators
// ZEND_ASSERT(observer_handlers);
if (observer_handlers && observer_handlers != ZEND_OBSERVER_NOT_OBSERVED) {
zend_observer_fcall_cache *cache = observer_handlers;
zend_observe_fcall_end(cache, execute_data, return_value);
_zend_observe_fcall_begin(execute_data);
}

ZEND_API void ZEND_FASTCALL zend_observer_fcall_begin(zend_execute_data *execute_data)
{
ZEND_ASSUME(execute_data->func);
if (!(execute_data->func->common.fn_flags & ZEND_ACC_GENERATOR)) {
_zend_observe_fcall_begin(execute_data);
}
}

ZEND_API void zend_observe_fcall_end(
zend_observer_fcall_cache *cache,
ZEND_API void ZEND_FASTCALL zend_observer_fcall_end(
zend_execute_data *execute_data,
zval *return_value)
{
zend_observer_fcall *handler = cache->end, *end = cache->handlers;
while (handler-- != end) {
if (handler->end) {
handler->end(execute_data, return_value);
zend_function *func = execute_data->func;
zend_observer_fcall_data *fcall_data;
zend_observer_fcall_handlers *handlers, *end;

if (!ZEND_OBSERVER_ENABLED
|| !ZEND_OBSERVABLE_FN(func->common.fn_flags)) {
return;
}

fcall_data = (zend_observer_fcall_data*)ZEND_OBSERVER_DATA(&func->op_array);
// TODO: Fix exceptions from generators
// ZEND_ASSERT(fcall_data);
if (!fcall_data || fcall_data == ZEND_OBSERVER_NOT_OBSERVED) {
return;
}

handlers = fcall_data->end;
end = fcall_data->handlers;
while (handlers-- != end) {
if (handlers->end) {
handlers->end(execute_data, return_value);
}
}
}
Expand Down
90 changes: 25 additions & 65 deletions Zend/zend_observer.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,87 +29,47 @@ extern ZEND_API int zend_observer_fcall_op_array_extension;

#define ZEND_OBSERVER_ENABLED (zend_observer_fcall_op_array_extension != -1)

#define ZEND_OBSERVER_HANDLERS(op_array) \
ZEND_OP_ARRAY_EXTENSION(op_array, zend_observer_fcall_op_array_extension)

#define ZEND_OBSERVER_NOT_OBSERVED ((void *) 2)

#define ZEND_OBSERVABLE_FN(fn_flags) \
(ZEND_OBSERVER_ENABLED && \
!(fn_flags & (ZEND_ACC_CALL_VIA_TRAMPOLINE | ZEND_ACC_FAKE_CLOSURE)))

struct zend_observer_fcall {
void (*begin)(zend_execute_data *execute_data);
void (*end)(zend_execute_data *execute_data, zval *retval);
};
typedef struct zend_observer_fcall zend_observer_fcall;

struct zend_observer_fcall_cache {
// points after the last handler
zend_observer_fcall *end;
// a variadic array using "struct hack"
zend_observer_fcall handlers[1];
};
typedef struct zend_observer_fcall_cache zend_observer_fcall_cache;
#define ZEND_OBSERVER_FCALL_BEGIN(execute_data) do { \
if (ZEND_OBSERVER_ENABLED) { \
zend_observer_fcall_begin(execute_data); \
} \
} while (0)

#define ZEND_OBSERVER_FCALL_END(execute_data, return_value) do { \
if (ZEND_OBSERVER_ENABLED) { \
zend_observer_fcall_end(execute_data, return_value); \
} \
} while (0)

typedef void (*zend_observer_fcall_begin_handler)(zend_execute_data *execute_data);
typedef void (*zend_observer_fcall_end_handler)(zend_execute_data *execute_data, zval *retval);

typedef struct _zend_observer_fcall_handlers {
zend_observer_fcall_begin_handler begin;
zend_observer_fcall_end_handler end;
} zend_observer_fcall_handlers;

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

// Call during minit/startup ONLY
ZEND_API void zend_observer_fcall_register(zend_observer_fcall_init init);
ZEND_API void zend_observer_fcall_register(zend_observer_fcall_init);

ZEND_API void zend_observer_startup(void); // Called by engine before MINITs
ZEND_API void zend_observer_activate(void);
ZEND_API void zend_observer_deactivate(void);
ZEND_API void zend_observer_shutdown(void);

ZEND_API void zend_observer_fcall_install(zend_function *function);

ZEND_API void zend_observe_fcall_begin(
zend_observer_fcall_cache *cache,
ZEND_API void ZEND_FASTCALL zend_observer_fcall_begin(
zend_execute_data *execute_data);

ZEND_API void zend_observe_fcall_end(
zend_observer_fcall_cache *cache,
zend_execute_data *execute_data,
zval *return_value);
ZEND_API void ZEND_FASTCALL zend_observer_generator_resume(
zend_execute_data *execute_data);

ZEND_API void zend_observer_fcall_call_end_helper(
ZEND_API void ZEND_FASTCALL zend_observer_fcall_end(
zend_execute_data *execute_data,
zval *return_value);

ZEND_API zend_always_inline void zend_observer_maybe_fcall_call_begin(
zend_execute_data *execute_data)
{
ZEND_ASSUME(execute_data->func);
zend_op_array *op_array = &execute_data->func->op_array;
uint32_t fn_flags = op_array->fn_flags;
if (ZEND_OBSERVABLE_FN(fn_flags) && !(fn_flags & ZEND_ACC_GENERATOR)) {
void *observer_handlers = ZEND_OBSERVER_HANDLERS(op_array);
if (!observer_handlers) {
zend_observer_fcall_install((zend_function *)op_array);
observer_handlers = ZEND_OBSERVER_HANDLERS(op_array);
}

ZEND_ASSERT(observer_handlers);
if (observer_handlers != ZEND_OBSERVER_NOT_OBSERVED) {
zend_observe_fcall_begin(
(zend_observer_fcall_cache *)observer_handlers,
execute_data);
}
}
}

ZEND_API zend_always_inline void zend_observer_maybe_fcall_call_end(
zend_execute_data *execute_data,
zval *return_value)
{
zend_function *func = execute_data->func;
if (ZEND_OBSERVABLE_FN(func->common.fn_flags)) {
zend_observer_fcall_call_end_helper(execute_data, return_value);
}
}

typedef void (*zend_observer_error_cb)(int type, const char *error_filename, uint32_t error_lineno, zend_string *message);

ZEND_API void zend_observer_error_register(zend_observer_error_cb callback);
Expand Down
Loading

0 comments on commit d5d31ea

Please sign in to comment.