[loader] Add injection information to phpinfo output for the SSI loader (#3271)

* Add injection information to phpinfo output for the SSI loader

* Fixes

* Fix test

Author: iamluc

loader/compat_php.c

@@ -161,28 +161,28 @@ static void ddloader_php_70_71_zend_error_cb(int type, const char *error_filenam
     UNUSED(type);
     UNUSED(error_filename);
     UNUSED(error_lineno);
-    ddloader_logv(WARN, format, args);
+    ddloader_logv(NULL, WARN, format, args);
 }
 
 static void ddloader_php_72_73_74_zend_error_cb(int type, const char *error_filename, const uint32_t error_lineno, const char *format, va_list args) {
     UNUSED(type);
     UNUSED(error_filename);
     UNUSED(error_lineno);
-    ddloader_logv(WARN, format, args);
+    ddloader_logv(NULL, WARN, format, args);
 }
 
 static void ddloader_php_80_error_zend_error_cb(int type, const char *error_filename, const uint32_t error_lineno, zend_string *message) {
     UNUSED(type);
     UNUSED(error_filename);
     UNUSED(error_lineno);
-    LOG(WARN, "Error while registering the module: %s", ZSTR_VAL(message));
+    LOG(NULL, WARN, "Error while registering the module: %s", ZSTR_VAL(message));
 }
 
 static void ddloader_php_error_zend_error_cb(int type, zend_string *error_filename, const uint32_t error_lineno, zend_string *message) {
     UNUSED(type);
     UNUSED(error_filename);
     UNUSED(error_lineno);
-    LOG(WARN, "Error while registering the module: %s)", ZSTR_VAL(message));
+    LOG(NULL, WARN, "Error while registering the module: %s)", ZSTR_VAL(message));
 }
 
 void (*old_zend_error_cb)(void);

loader/config.m4

@@ -18,5 +18,5 @@ if test "$PHP_DD_LIBRARY_LOADER" != "no"; then
   dnl In case of no dependencies
   AC_DEFINE(HAVE_DD_LIBRARY_LOADER, 1, [ Have dd_library_loader support ])
 
-  PHP_NEW_EXTENSION(dd_library_loader, dd_library_loader.c compat_php.c, $ext_shared, , , , yes)
+  PHP_NEW_EXTENSION(dd_library_loader, dd_library_loader.c dd_library_loader_module.c compat_php.c, $ext_shared, , , , yes)
 fi

loader/dd_library_loader.c

@@ -0,0 +1,44 @@
+#include <php.h>
+#include <zend_extensions.h>
+#include <php_ini.h>
+#include <php_main.h>
+#include <php_version.h>
+#include <ext/standard/info.h>
+
+#include "php_dd_library_loader.h"
+
+extern injected_ext ddloader_injected_ext_config[];
+
+static void ddloader_info_function(zend_module_entry *module) {
+    UNUSED(module);
+
+    php_info_print_table_start();
+    php_info_print_table_header(2, "", "Datadog Library Loader");
+    php_info_print_table_row(2, "Version", PHP_DD_LIBRARY_LOADER_VERSION);
+    php_info_print_table_row(2, "Author", "Datadog");
+    php_info_print_table_end();
+
+    for (unsigned int i = 0; i < EXT_COUNT; ++i) {
+        php_info_print_table_start();
+        php_info_print_table_header(2, "", ddloader_injected_ext_config[i].ext_name);
+        php_info_print_table_row(2, "Version", ddloader_injected_ext_config[i].version);
+        php_info_print_table_row(2, "Injection success", ddloader_injected_ext_config[i].injection_success ? "true" : "false");
+        php_info_print_table_row(2, "Injection error", ddloader_injected_ext_config[i].injection_error ? ddloader_injected_ext_config[i].injection_error : "");
+        php_info_print_table_row(2, "Extra config", ddloader_injected_ext_config[i].extra_config);
+        php_info_print_table_row(2, "Logs", ddloader_injected_ext_config[i].logs);
+        php_info_print_table_end();
+    }
+}
+
+zend_module_entry dd_library_loader_mod = {
+    STANDARD_MODULE_HEADER,
+    "dd_library_loader_mod",
+    NULL,                         // functions
+    NULL,                         // MINIT
+    NULL,                         // MSHUTDOWN
+    NULL,                         // RINIT
+    NULL,                         // RSHUTDOWN
+    ddloader_info_function,       // MINFO
+    PHP_DD_LIBRARY_LOADER_VERSION, // version
+    STANDARD_MODULE_PROPERTIES
+};

loader/dd_library_loader_module.c

@@ -15,10 +15,7 @@ typedef enum {
     ERROR,
 } log_level;
 
-#define LOG(level, format, ...) ddloader_logf(level, format, ##__VA_ARGS__);
-
-void ddloader_logv(log_level level, const char *format, va_list va);
-void ddloader_logf(log_level level, const char *format, ...);
+#define LOG(config, level, format, ...) ddloader_logf(config, level, format, ##__VA_ARGS__);
 
 typedef enum {
     REASON_START,
@@ -29,31 +26,52 @@ typedef enum {
     REASON_COMPLETE,
 } telemetry_reason;
 
+typedef enum {
+    EXT_DDTRACE,
+    EXT_DATADOG_PROFILING,
+    EXT_DDAPPSEC,
+
+    EXT_COUNT,
+} dd_injected_ext;
+
 #define TELEMETRY(reason, config, error, format, ...) ddloader_telemetryf(reason, config, error, format, ##__VA_ARGS__);
 
 #define DECLARE_INJECTED_EXT(name, dir, min_version, _pre_load_hook, _pre_minit_hook, deps)                      \
     {                                                                                               \
         .ext_name = name, .ext_dir = dir, .ext_min_version = min_version, .tmp_name = name "_injected", .tmp_deps = deps,           \
         .pre_load_hook = _pre_load_hook, .pre_minit_hook = _pre_minit_hook,                         \
         .orig_module_startup_func = NULL, .orig_module_deps = NULL, .orig_module_functions = NULL,  \
-        .module_number = -1, .version = NULL                                                        \
+        .module_number = -1, .version = NULL,                                                       \
+        .injection_success = false, .injection_error = NULL, .extra_config = {0}, .logs = {0}       \
     }
 
+#define MAX_EXTRA_CONFIG_SIZE 1024
+#define MAX_LOGS_SIZE 2048
+
 typedef struct _injected_ext {
     const char *ext_name;
     const char *ext_dir;
     unsigned int ext_min_version;
 
     const char *tmp_name;
     const zend_module_dep *tmp_deps;
-    char *(*pre_load_hook)(void);
-    void (*pre_minit_hook)(void);
+    char *(*pre_load_hook)(struct _injected_ext *config);
+    void (*pre_minit_hook)(struct _injected_ext *config);
 
     zend_result (*orig_module_startup_func)(INIT_FUNC_ARGS);
     const zend_module_dep *orig_module_deps;
     const zend_function_entry *orig_module_functions;
     int module_number;
     char *version;
+
+    // phpinfo data
+    bool injection_success;
+    const char *injection_error;
+    char extra_config[MAX_EXTRA_CONFIG_SIZE];
+    char logs[MAX_LOGS_SIZE];
 } injected_ext;
 
+void ddloader_logv(injected_ext *config, log_level level, const char *format, va_list va);
+void ddloader_logf(injected_ext *config, log_level level, const char *format, ...);
+
 #endif /* PHP_DD_LIBRARY_LOADER_H */

loader/php_dd_library_loader.h

@@ -8,16 +8,19 @@ function boolstr($bool) {
 
 if (!extension_loaded('Zend OPcache')) {
     echo "OPcache is not loaded\n";
-    return;
+    goto end;
 }
 
 $status = opcache_get_status();
 if ($status === false) {
     echo "OPcache is disabled\n";
-    return;
+    goto end;
 }
 
 echo "opcache_enabled: ".boolstr($status['opcache_enabled'])."\n";
 echo "jit.enabled: ".boolstr($status['jit']['enabled'])."\n";
 echo "jit.on: ".boolstr($status['jit']['on'])."\n";
 echo "jit.buffer_size: ".$status['jit']['buffer_size']."\n";
+
+end:
+phpinfo();

loader/tests/functional/fixtures/opcache_jit.php

@@ -21,7 +21,24 @@
 ddtrace.disable: NO
 OPcache is disabled
 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
+EOT
+        ],
     ],
     // OPcache enabled, but not JIT
     [
@@ -34,7 +51,24 @@
 jit.on: NO
 jit.buffer_size: 0
 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
+EOT
+        ],
     ],
     // JIT enabled
     [
@@ -49,7 +83,27 @@
 jit.on: YES
 jit.buffer_size: 33554416
 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
+ddtrace.disable=1
+
+%A
+OPcache JIT is enabled and may cause instability. ddtrace will be disabled unless the environment DD_INJECT_FORCE is set to '1', 'true', 'yes' or 'on'
+%A
+EOT
+        ],
     ],
     // JIT enabled + force injection
     [
@@ -64,10 +118,32 @@
 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
+EOT
+        ],
     ],
 ];
 foreach ($tests as $data) {
@@ -83,4 +159,8 @@
     foreach ($data['must_not_contain'] as $str) {
         assertNotContains($output, $str);
     }
+
+    foreach ($data['must_match'] as $pattern) {
+        assertMatchesFormat($output, $pattern);
+    }
 }

loader/tests/functional/test_incompatibility_jit.php

@@ -0,0 +1,92 @@
+<?php
+
+require_once __DIR__."/includes/autoload.php";
+skip_if_php5();
+
+$output = runCLI('-i', true);
+
+if ('7.0' === php_minor_version()) {
+    assertMatchesFormat($output, <<<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
+
+Logs => Found extension file: %s
+%A
+Application instrumentation bootstrapping complete ('ddtrace')
+%A
+
+  => datadog-profiling
+Version =>
+Injection success => false
+Injection error => Incompatible runtime
+Extra config =>
+Logs => Aborting application instrumentation due to an incompatible runtime
+'datadog-profiling' extension is not supported on this PHP version
+%A
+
+  => ddappsec
+Version => %s
+Injection success => true
+Injection error =>
+Extra config => datadog.appsec.helper_path=%s
+
+Logs => Found extension file: %s
+%A
+Application instrumentation bootstrapping complete ('ddappsec')
+%A
+EOT
+    );
+} else {
+    assertMatchesFormat($output, <<<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
+
+Logs => Found extension file: %s
+%A
+Application instrumentation bootstrapping complete ('ddtrace')
+%A
+
+  => datadog-profiling
+Version => %s
+Injection success => true
+Injection error =>
+Extra config => datadog.profiling.enabled=0
+
+Logs => Found extension file: %s
+%A
+Application instrumentation bootstrapping complete ('datadog-profiling')
+%A
+
+  => ddappsec
+Version => %s
+Injection success => true
+Injection error =>
+Extra config => datadog.appsec.helper_path=%s
+
+Logs => Found extension file: %s
+%A
+Application instrumentation bootstrapping complete ('ddappsec')
+%A
+EOT
+    );
+}