Merge pull request #1089 from DataDog/sammyk/observer-api

PHP 8: Observer API

Author: SammyK

.circleci/config.yml

@@ -1187,7 +1187,7 @@ workflows:
                 - php:7.2-fpm-alpine
                 - php:7.3-fpm-alpine
                 - php:7.4-fpm-alpine
-                - php:8.0.0RC3-fpm-alpine
+                - php:8.0.0RC4-fpm-alpine # Add RC5 when available
       - pecl_tests:
           requires: [ "Build PECL" ]
           name: "PHP 54 PECL tests"

dockerfiles/ci/alpine/docker-compose.yml

@@ -13,5 +13,5 @@ services:
       context: ./php-8.0
       args:
         phpVersion: 8.0
-        phpTarGzUrl: https://github.com/SammyK/php-src/archive/sammyk/php8.0.0-pre-rc5.tar.gz
-        phpSha256Hash: 9597c3497f6afa05e13db1e69e86e53bcfc19ad9581c30384be0f7f8f55c3eae
+        phpTarGzUrl: https://github.com/php/php-src/archive/php-8.0.0RC5.tar.gz
+        phpSha256Hash: ec5836f816e17fd8a281f671bb247b4c420f8de23fb425d599877cd911a54230

dockerfiles/ci/buster/docker-compose.yml

@@ -13,8 +13,8 @@ services:
       context: ./php-8.0
       args:
         phpVersion: 8.0
-        phpTarGzUrl: https://github.com/SammyK/php-src/archive/sammyk/php8.0.0-pre-rc5.tar.gz
-        phpSha256Hash: 9597c3497f6afa05e13db1e69e86e53bcfc19ad9581c30384be0f7f8f55c3eae
+        phpTarGzUrl: https://github.com/php/php-src/archive/php-8.0.0RC5.tar.gz
+        phpSha256Hash: ec5836f816e17fd8a281f671bb247b4c420f8de23fb425d599877cd911a54230
 
   php-master:
     image: datadog/dd-trace-ci:php-master_buster

dockerfiles/ci/centos/6/docker-compose.yml

@@ -11,6 +11,6 @@ services:
       context: ./php-8.0
       args:
         phpVersion: 8.0
-        phpTarGzUrl: https://github.com/SammyK/php-src/archive/sammyk/php8.0.0-pre-rc5.tar.gz
-        phpSha256Hash: 9597c3497f6afa05e13db1e69e86e53bcfc19ad9581c30384be0f7f8f55c3eae
+        phpTarGzUrl: https://github.com/php/php-src/archive/php-8.0.0RC5.tar.gz
+        phpSha256Hash: ec5836f816e17fd8a281f671bb247b4c420f8de23fb425d599877cd911a54230
     image: 'datadog/dd-trace-ci:php-8.0_centos-6'

dockerfiles/compile_extension/docker-compose.yml

@@ -112,9 +112,9 @@ services:
       context: .
       dockerfile: Dockerfile_alpine
       args:
-        php_version: 8.0.0RC3
-        php_url: https://downloads.php.net/~carusogabriel/php-8.0.0RC3.tar.gz
-        php_sha: c651a10058840abd44f99a8aed0446f102291d1408f2299790b919634689b5cd
+        php_version: 8.0.0RC5
+        php_url: https://github.com/php/php-src/archive/php-8.0.0RC5.tar.gz
+        php_sha: ec5836f816e17fd8a281f671bb247b4c420f8de23fb425d599877cd911a54230
         php_api: 20200930
     command: build-dd-trace-php
     volumes:

dockerfiles/compile_extension/install-php

@@ -6,6 +6,7 @@ set -xe
 PHP_TAR_FILE=php.tar.gz
 apk add --no-cache --virtual .php-build-deps \
     autoconf \
+    bison \
     ca-certificates \
     coreutils \
     g++ \
@@ -32,6 +33,7 @@ CFLAGS="$PHP_CFLAGS" CPPFLAGS="$PHP_CPPFLAGS" LDFLAGS="$PHP_LDFLAGS"
 PHP_CONFIG_ARGS=""
 
 # Installing PHP
+./buildconf --force
 ./configure \
     --prefix="${PHP_INSTALL_DIR}" \
     --with-config-file-path="${PHP_INI_DIR}" \

ext/php8/ddtrace.c

@@ -71,16 +71,9 @@ STD_PHP_INI_ENTRY("ddtrace.request_init_hook", "", PHP_INI_SYSTEM, OnUpdateStrin
 PHP_INI_END()
 
 static int ddtrace_startup(struct _zend_extension *extension) {
-#if PHP_VERSION_ID < 80000
-    ddtrace_resource = zend_get_resource_handle(extension);
-#if PHP_VERSION_ID >= 70400
-    ddtrace_op_array_extension = zend_get_op_array_extension_handle();
-#endif
-#else
     UNUSED(extension);
     ddtrace_resource = zend_get_resource_handle(PHP_DDTRACE_EXTNAME);
     ddtrace_op_array_extension = zend_get_op_array_extension_handle(PHP_DDTRACE_EXTNAME);
-#endif
 
     ddtrace_excluded_modules_startup();
     ddtrace_internal_handlers_startup();
@@ -433,10 +426,6 @@ static PHP_RINIT_FUNCTION(ddtrace) {
     ddtrace_distributed_tracing_rinit(TSRMLS_C);
     DDTRACE_G(disable_in_current_request) = 0;
 
-    // This allows us to hook the ZEND_HANDLE_EXCEPTION pseudo opcode
-    ZEND_VM_SET_OPCODE_HANDLER(EG(exception_op));
-    EG(exception_op)->opcode = ZEND_HANDLE_EXCEPTION;
-
     ddtrace_dogstatsd_client_rinit(TSRMLS_C);
 
     ddtrace_seed_prng(TSRMLS_C);
@@ -1114,15 +1103,9 @@ static PHP_FUNCTION(dd_trace_disable_in_request) {
 }
 
 static PHP_FUNCTION(dd_trace_reset) {
-    PHP5_UNUSED(return_value_used, this_ptr, return_value_ptr, ht);
-    PHP7_UNUSED(execute_data);
-
-    if (DDTRACE_G(disable)) {
-        RETURN_BOOL(0);
-    }
-
-    ddtrace_dispatch_reset(TSRMLS_C);
-    RETURN_BOOL(1);
+    UNUSED(execute_data);
+    ddtrace_log_debug("Cannot reset traced functions on PHP 8+");
+    RETURN_BOOL(0);
 }
 
 /* {{{ proto string dd_trace_serialize_msgpack(array trace_array) */

ext/php8/dispatch.c

@@ -108,15 +108,6 @@ void ddtrace_dispatch_destroy(TSRMLS_D) {
     }
 }
 
-void ddtrace_dispatch_reset(TSRMLS_D) {
-    if (DDTRACE_G(class_lookup)) {
-        zend_hash_clean(DDTRACE_G(class_lookup));
-    }
-    if (DDTRACE_G(function_lookup)) {
-        zend_hash_clean(DDTRACE_G(function_lookup));
-    }
-}
-
 static HashTable *_get_lookup_for_target(zval *class_name TSRMLS_DC) {
     HashTable *overridable_lookup = NULL;
     if (class_name && DDTRACE_G(class_lookup)) {

ext/php8/dispatch.h

@@ -63,7 +63,6 @@ inline void ddtrace_dispatch_release(ddtrace_dispatch_t *dispatch) {
 
 void ddtrace_dispatch_init(TSRMLS_D);
 void ddtrace_dispatch_destroy(TSRMLS_D);
-void ddtrace_dispatch_reset(TSRMLS_D);
 
 #if PHP_VERSION_ID < 70000
 

ext/php8/engine_hooks.c

@@ -1,57 +1,28 @@
 #include "engine_hooks.h"
 
+#include <Zend/zend_observer.h>
 #include <php.h>
 #include <time.h>
-#if PHP_VERSION_ID >= 80000
-#include <Zend/zend_observer.h>
-#endif
 
 #include "configuration.h"
 #include "ddtrace.h"
 #include "span.h"
 
 ZEND_EXTERN_MODULE_GLOBALS(ddtrace);
 
-static zend_op_array *(*_prev_compile_file)(zend_file_handle *file_handle, int type TSRMLS_DC);
-#if PHP_VERSION_ID < 80000
-void (*ddtrace_prev_error_cb)(DDTRACE_ERROR_CB_PARAMETERS);
-#endif
-
-void ddtrace_execute_internal_minit(void);
-void ddtrace_execute_internal_mshutdown(void);
+static zend_op_array *(*_prev_compile_file)(zend_file_handle *file_handle, int type);
 
 static void _compile_minit(void);
 static void _compile_mshutdown(void);
 
-void ddtrace_opcode_minit(void);
-void ddtrace_opcode_mshutdown(void);
-
 void ddtrace_engine_hooks_minit(void) {
-    ddtrace_execute_internal_minit();
-    ddtrace_opcode_minit();
     _compile_minit();
 
-#if PHP_VERSION_ID >= 50500 && PHP_VERSION_ID < 80000
-    ddtrace_prev_error_cb = zend_error_cb;
-    zend_error_cb = ddtrace_error_cb;
-#endif
-
-#if PHP_VERSION_ID >= 80000
+    zend_observer_fcall_register(ddtrace_observer_fcall_init);
     zend_observer_error_register(ddtrace_observer_error_cb);
-#endif
 }
 
-void ddtrace_engine_hooks_mshutdown(void) {
-#if PHP_VERSION_ID < 80000
-    if (ddtrace_prev_error_cb == ddtrace_error_cb) {
-        zend_error_cb = ddtrace_prev_error_cb;
-    }
-#endif
-
-    _compile_mshutdown();
-    ddtrace_opcode_mshutdown();
-    ddtrace_execute_internal_mshutdown();
-}
+void ddtrace_engine_hooks_mshutdown(void) { _compile_mshutdown(); }
 
 static uint64_t _get_microseconds() {
     struct timespec time;
@@ -61,10 +32,10 @@ static uint64_t _get_microseconds() {
     return 0U;
 }
 
-static zend_op_array *_dd_compile_file(zend_file_handle *file_handle, int type TSRMLS_DC) {
+static zend_op_array *_dd_compile_file(zend_file_handle *file_handle, int type) {
     zend_op_array *res;
     uint64_t start = _get_microseconds();
-    res = _prev_compile_file(file_handle, type TSRMLS_CC);
+    res = _prev_compile_file(file_handle, type);
     DDTRACE_G(compile_time_microseconds) += (int64_t)(_get_microseconds() - start);
     return res;
 }
@@ -82,14 +53,12 @@ static void _compile_mshutdown(void) {
     }
 }
 
-void ddtrace_compile_time_reset(TSRMLS_D) { DDTRACE_G(compile_time_microseconds) = 0; }
+void ddtrace_compile_time_reset(void) { DDTRACE_G(compile_time_microseconds) = 0; }
 
-int64_t ddtrace_compile_time_get(TSRMLS_D) { return DDTRACE_G(compile_time_microseconds); }
+int64_t ddtrace_compile_time_get(void) { return DDTRACE_G(compile_time_microseconds); }
+
+extern inline void ddtrace_backup_error_handling(ddtrace_error_handling *eh, zend_error_handling_t mode);
 
-extern inline void ddtrace_backup_error_handling(ddtrace_error_handling *eh, zend_error_handling_t mode TSRMLS_DC);
-#if PHP_VERSION_ID < 80000
-extern inline void ddtrace_restore_error_handling(ddtrace_error_handling *eh TSRMLS_DC);
-#else
 void ddtrace_restore_error_handling(ddtrace_error_handling *eh) {
     if (PG(last_error_message)) {
         if (PG(last_error_message) != eh->message) {
@@ -99,21 +68,15 @@ void ddtrace_restore_error_handling(ddtrace_error_handling *eh) {
             free(PG(last_error_file));
         }
     }
-    zend_restore_error_handling(&eh->error_handling TSRMLS_CC);
+    zend_restore_error_handling(&eh->error_handling);
     PG(last_error_type) = eh->type;
     PG(last_error_message) = eh->message;
     PG(last_error_file) = eh->file;
     PG(last_error_lineno) = eh->lineno;
     EG(error_reporting) = eh->error_reporting;
 }
-#endif
+
 extern inline void ddtrace_sandbox_end(ddtrace_sandbox_backup *backup TSRMLS_DC);
-#if PHP_VERSION_ID < 70000
-extern inline ddtrace_sandbox_backup ddtrace_sandbox_begin(zend_op *opline_before_exception TSRMLS_DC);
-extern inline void ddtrace_maybe_clear_exception(TSRMLS_D);
-extern inline zval *ddtrace_exception_get_entry(zval *object, char *name, int name_len TSRMLS_DC);
-#else
 extern inline ddtrace_sandbox_backup ddtrace_sandbox_begin(void);
 extern inline void ddtrace_maybe_clear_exception(void);
 extern inline zend_class_entry *ddtrace_get_exception_base(zval *object);
-#endif