Allow specifying datadog.loader.force_inject=1 in loader (#3278)

* Allow specifying datadog.loader.force_inject=1 in loader

Signed-off-by: Bob Weinand <[email protected]>

* INI compatibility for 7.0 to 7.2

Signed-off-by: Bob Weinand <[email protected]>

* Do not project too far into the future, i.e. support only PHP+1 for ini registering

Signed-off-by: Bob Weinand <[email protected]>

---------

Signed-off-by: Bob Weinand <[email protected]>

Author: bwoebi

loader/compat_php.h

@@ -14,4 +14,27 @@ void ddloader_restore_zend_error_cb();
 zval *ddloader_zend_hash_update(HashTable *ht, zend_string *key, zval *pData);
 bool ddloader_zend_ini_parse_bool(zend_string *str);
 
+#if PHP_VERSION_ID < 80000
+typedef int zend_result;
+#endif
+
+typedef struct {
+    const char *name;
+    ZEND_INI_MH((*on_modify));
+    void *mh_arg1;
+    void *mh_arg2;
+    void *mh_arg3;
+    const char *value;
+    void (*displayer)(zend_ini_entry *ini_entry, int type);
+    int modifiable;
+
+    uint name_length;
+    uint value_length;
+} php7_0_to_2_zend_ini_entry_def;
+
+#undef ZEND_INI_ENTRY3_EX
+#define ZEND_INI_ENTRY3_EX(_name, _default_value, _modifiable, _on_modify, _arg1, _arg2, _arg3, _displayer) \
+	{ .name = _name, .on_modify = _on_modify, .mh_arg1 = _arg1, .mh_arg2 = _arg2, .mh_arg3 = _arg3, .value = _default_value, .displayer = _displayer, .modifiable = _modifiable, .name_length = sizeof(_name)-1, .value_length = sizeof(_default_value)-1 },
+
+
 #endif /* DD_LIBRARY_LOADER_COMPAT_PHP_H */

loader/dd_library_loader.c

@@ -17,9 +17,11 @@
 
 #define MIN_API_VERSION 320151012
 #define MAX_API_VERSION 420240924
+#define MAX_INI_API_VERSION MAX_API_VERSION + 1
 
 #define PHP_70_VERSION 20151012
 #define PHP_71_VERSION 20160303
+#define PHP_72_VERSION 20170718
 #define PHP_80_VERSION 20200930
 
 #define MIN_PHP_VERSION "7.0"
@@ -44,6 +46,28 @@ static bool already_done = false;
 # define OS_PATH "linux-gnu/"
 #endif
 
+static ZEND_INI_MH(ddloader_OnUpdateForceInject) {
+    (void)entry;
+    (void)mh_arg1;
+    (void)mh_arg2;
+    (void)mh_arg3;
+    (void)stage;
+
+    if (!force_load) {
+        force_load = ddloader_zend_ini_parse_bool(new_value);
+    }
+    return SUCCESS;
+}
+
+PHP_INI_BEGIN()
+    ZEND_INI_ENTRY("datadog.loader.force_inject", "0", PHP_INI_SYSTEM, ddloader_OnUpdateForceInject)
+PHP_INI_END()
+
+static const php7_0_to_2_zend_ini_entry_def ini_entries_7_0_to_2[] = {
+    ZEND_INI_ENTRY("datadog.loader.force_inject", "0", PHP_INI_SYSTEM, ddloader_OnUpdateForceInject)
+PHP_INI_END()
+
+
 static void ddloader_telemetryf(telemetry_reason reason, injected_ext *config, const char *error, const char *format, ...);
 
 static char *ddtrace_pre_load_hook(injected_ext *config) {
@@ -752,6 +776,9 @@ static int ddloader_api_no_check(int api_no) {
         return SUCCESS;
     }
 
+    // api_no is the Zend extension API number, similar to "420220829"
+    // It is an int, but represented as a string, we must remove the first char to get the PHP module API number
+    unsigned int module_api_no = api_no % 100000000;
     ddloader_configure();
 
     TELEMETRY(REASON_START, NULL, NULL, "Starting injection");
@@ -793,6 +820,11 @@ static int ddloader_api_no_check(int api_no) {
         return SUCCESS;
     }
 
+    if (force_load || api_no <= MAX_INI_API_VERSION) {
+        zend_module_entry *mod = zend_register_internal_module(&dd_library_loader_mod);
+        zend_register_ini_entries(module_api_no <= PHP_72_VERSION ? (zend_ini_entry_def *) ini_entries_7_0_to_2 : ini_entries, mod->module_number);
+    }
+
     if (api_no > MAX_API_VERSION) {
         if (!force_load) {
             TELEMETRY(REASON_INCOMPATIBLE_RUNTIME, NULL, NULL, "Found incompatible runtime (api no: %d). Supported runtimes: PHP " MIN_PHP_VERSION " to " MAX_PHP_VERSION, api_no);
@@ -802,9 +834,7 @@ static int ddloader_api_no_check(int api_no) {
         LOG(NULL, WARN, "DD_INJECT_FORCE enabled, allowing unsupported runtimes and continuing (api no: %d).", api_no);
     }
 
-    // api_no is the Zend extension API number, similar to "420220829"
-    // It is an int, but represented as a string, we must remove the first char to get the PHP module API number
-    php_api_no = api_no % 100000000;
+    php_api_no = module_api_no;
 
     return SUCCESS;
 }
@@ -846,7 +876,6 @@ static int ddloader_build_id_check(const char *build_id) {
 // Required. Otherwise the zend_extension is not loaded
 static int ddloader_zend_extension_startup(zend_extension *ext) {
     UNUSED(ext);
-    zend_register_internal_module(&dd_library_loader_mod);
     return SUCCESS;
 }
 

loader/tests/functional/test_incompatibility_jit.php

@@ -105,7 +105,7 @@
 EOT
         ],
     ],
-    // JIT enabled + force injection
+    // JIT enabled + force injection via ENV
     [
         "config" => "-dzend_extension=opcache -dopcache.enable_cli=1 -ddatadog.trace.cli_enabled=1 -dopcache.jit_buffer_size=32M -dopcache.jit=tracing",
         "env" => ['DD_INJECT_FORCE=1'],
@@ -139,6 +139,45 @@
 Injection error =>
 Extra config => datadog.trace.sources_path=%s/trace/src
 
+%A
+OPcache JIT is enabled and may cause instability. Ignoring as DD_INJECT_FORCE is enabled
+%A
+EOT
+        ],
+    ],
+    // JIT enabled + force injection via INI
+    [
+        "config" => "-dzend_extension=opcache -dopcache.enable_cli=1 -ddatadog.trace.cli_enabled=1 -ddatadog.loader.force_inject=1 -dopcache.jit_buffer_size=32M -dopcache.jit=tracing",
+        "must_not_contain" => [],
+        "must_contain" => [
+            $msg_forced,
+            <<<EOT
+ddtrace.disable: NO
+opcache_enabled: YES
+jit.enabled: YES
+jit.on: YES
+jit.buffer_size: 33554416
+EOT
+,
+            <<<EOT
+[ddtrace] [debug] Notifying profiler of finished local root span.
+[ddtrace] [span] Encoding span
+EOT
+        ],
+        "must_match" => [<<<EOT
+%A
+dd_library_loader_mod
+
+  => Datadog Library Loader
+Version => %s
+Author => Datadog
+
+  => ddtrace
+Version => %s
+Injection success => true
+Injection error =>
+Extra config => datadog.trace.sources_path=%s/trace/src
+
 %A
 OPcache JIT is enabled and may cause instability. Ignoring as DD_INJECT_FORCE is enabled
 %A