Enable dynamic configuration for debugger-related products (#3476)

* Enable dynamic configuration for debugger-related products

- Dynamic instrumentation
- Code origins
- Exception replay

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

* Fixup libdatadog updates

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

* Fix distinguishing modified vs unmodified

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

* Update libdatadog once more

---------

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

Author: bwoebi

Cargo.lock

@@ -48,7 +48,7 @@ RUN_TESTS_CMD := DD_SERVICE= DD_ENV= REPORT_EXIT_STATUS=1 TEST_PHP_SRCDIR=$(PROJ
 
 C_FILES = $(shell find components components-rs ext src/dogstatsd zend_abstract_interface -name '*.c' -o -name '*.h' | awk '{ printf "$(BUILD_DIR)/%s\n", $$1 }' )
 TEST_FILES = $(shell find tests/ext -name '*.php*' -o -name '*.inc' -o -name '*.json' -o -name '*.yaml' -o -name 'CONFLICTS' | awk '{ printf "$(BUILD_DIR)/%s\n", $$1 }' )
-RUST_FILES = $(BUILD_DIR)/Cargo.toml $(BUILD_DIR)/Cargo.lock $(shell find components-rs -name '*.c' -o -name '*.rs' -o -name 'Cargo.toml' | awk '{ printf "$(BUILD_DIR)/%s\n", $$1 }' ) $(shell find libdatadog/{build-common,datadog-crashtracker,datadog-crashtracker-ffi,datadog-ipc,datadog-ipc-macros,datadog-live-debugger,datadog-live-debugger-ffi,datadog-remote-config,datadog-sidecar,datadog-sidecar-ffi,datadog-sidecar-macros,libdd-alloc,libdd-common,libdd-common-ffi,libdd-data-pipeline,libdd-ddsketch,libdd-dogstatsd-client,libdd-library-config,libdd-library-config-ffi,libdd-log,libdd-telemetry,libdd-telemetry-ffi,libdd-tinybytes,libdd-trace-*,spawn_worker,tools/{cc_utils,sidecar_mockgen},datadog-trace-*,Cargo.toml} \( -type l -o -type f \) \( -path "*/src*" -o -path "*/examples*" -o -path "*Cargo.toml" -o -path "*/build.rs" -o -path "*/tests/dataservice.rs" -o -path "*/tests/service_functional.rs" \) -not -path "*/datadog-ipc/build.rs" -not -path "*/datadog-sidecar-ffi/build.rs")
+RUST_FILES = $(BUILD_DIR)/Cargo.toml $(BUILD_DIR)/Cargo.lock $(shell find components-rs -name '*.c' -o -name '*.rs' -o -name 'Cargo.toml' | awk '{ printf "$(BUILD_DIR)/%s\n", $$1 }' ) $(shell find libdatadog/{build-common,datadog-ipc,datadog-ipc-macros,datadog-live-debugger,datadog-live-debugger-ffi,datadog-remote-config,datadog-sidecar,datadog-sidecar-ffi,datadog-sidecar-macros,libdd-alloc,libdd-common,libdd-common-ffi,libdd-crashtracker,libdd-crashtracker-ffi,libdd-data-pipeline,libdd-ddsketch,libdd-dogstatsd-client,libdd-library-config,libdd-library-config-ffi,libdd-log,libdd-telemetry,libdd-telemetry-ffi,libdd-tinybytes,libdd-trace-*,spawn_worker,tools/{cc_utils,sidecar_mockgen},datadog-trace-*,Cargo.toml} \( -type l -o -type f \) \( -path "*/src*" -o -path "*/examples*" -o -path "*Cargo.toml" -o -path "*/build.rs" -o -path "*/tests/dataservice.rs" -o -path "*/tests/service_functional.rs" \) -not -path "*/datadog-ipc/build.rs" -not -path "*/datadog-sidecar-ffi/build.rs")
 ALL_OBJECT_FILES = $(C_FILES) $(RUST_FILES) $(BUILD_DIR)/Makefile
 TEST_OPCACHE_FILES = $(shell find tests/opcache -name '*.php*' -o -name '.gitkeep' | awk '{ printf "$(BUILD_DIR)/%s\n", $$1 }' )
 TEST_STUB_FILES = $(shell find tests/ext -type d -name 'stubs' -exec find '{}' -type f \; | awk '{ printf "$(BUILD_DIR)/%s\n", $$1 }' )
@@ -436,8 +436,8 @@ generate_cbindgen: cbindgen_binary # Regenerate components-rs/ddtrace.h componen
 		$(command rustup && echo run nightly --) cbindgen --crate datadog-sidecar-ffi  \
 			--config datadog-sidecar-ffi/cbindgen.toml \
 			--output $(PROJECT_ROOT)/components-rs/sidecar.h; \
-		$(command rustup && echo run nightly --) cbindgen --crate datadog-crashtracker-ffi  \
-			--config datadog-crashtracker-ffi/cbindgen.toml \
+		$(command rustup && echo run nightly --) cbindgen --crate libdd-crashtracker-ffi  \
+			--config libdd-crashtracker-ffi/cbindgen.toml \
 			--output $(PROJECT_ROOT)/components-rs/crashtracker.h; \
 		$(command rustup && echo run nightly --) cbindgen --crate libdd-library-config-ffi  \
 			--config libdd-library-config-ffi/cbindgen.toml \

Makefile

@@ -4,6 +4,7 @@ include_guard = "DDTRACE_PHP_H"
 style = "both"
 header = """
 struct _zend_string;
+typedef struct _zend_string _zend_string;
 """
 
 no_includes = true

cbindgen.toml

@@ -20,7 +20,7 @@ datadog-sidecar = { path = "../libdatadog/datadog-sidecar" }
 datadog-sidecar-ffi = { path = "../libdatadog/datadog-sidecar-ffi" }
 libdd-tinybytes = { path = "../libdatadog/libdd-tinybytes" }
 libdd-trace-utils = { path = "../libdatadog/libdd-trace-utils" }
-datadog-crashtracker-ffi = { path = "../libdatadog/datadog-crashtracker-ffi", default-features = false, features = ["collector"] }
+libdd-crashtracker-ffi = { path = "../libdatadog/libdd-crashtracker-ffi", default-features = false, features = ["collector"] }
 libdd-library-config-ffi = { path = "../libdatadog/libdd-library-config-ffi", default-features = false }
 spawn_worker = { path = "../libdatadog/spawn_worker" }
 anyhow = { version = "1.0" }

components-rs/Cargo.toml

@@ -16,16 +16,45 @@ pub struct ZendString {
     pub val: [u8; 1],
 }
 
+#[repr(transparent)]
+pub struct OwnedZendString(pub NonNull<ZendString>);
+
+impl OwnedZendString {
+    pub fn from_copy(mut ptr: NonNull<ZendString>) -> Self {
+        unsafe { DDOG_ADDREF_ZEND_STRING.unwrap_unchecked()(ptr.as_mut()) };
+        OwnedZendString(ptr)
+    }
+}
+
+impl Drop for OwnedZendString {
+    fn drop(&mut self) {
+        unsafe {
+            DDOG_FREE_ZEND_STRING.unwrap_unchecked()(OwnedZendString(self.0));
+        }
+    }
+}
+
+impl Clone for OwnedZendString {
+    fn clone(&self) -> Self {
+        OwnedZendString::from_copy(self.0)
+    }
+}
+
 static mut DDOG_ADDREF_ZEND_STRING: Option<extern "C" fn(&mut ZendString)> = None;
+static mut DDOG_INIT_ZEND_STRING: Option<extern "C" fn(CharSlice) -> OwnedZendString> = None;
+static mut DDOG_FREE_ZEND_STRING: Option<extern "C" fn(OwnedZendString)> = None;
 
 static mut REFCOUNTED_CELL_VTABLE: Option<RefCountedCellVTable> = None;
 
 #[no_mangle]
 pub unsafe extern "C" fn ddog_init_span_func(
-    free_func: extern "C" fn(&mut ZendString),
+    free_func: extern "C" fn(OwnedZendString),
     addref_func: extern "C" fn(&mut ZendString),
+    init_func: extern "C" fn(CharSlice) -> OwnedZendString,
 ) {
     DDOG_ADDREF_ZEND_STRING = Some(addref_func);
+    DDOG_INIT_ZEND_STRING = Some(init_func);
+    DDOG_FREE_ZEND_STRING = Some(free_func);
 
     REFCOUNTED_CELL_VTABLE = Some(RefCountedCellVTable {
         clone,
@@ -38,6 +67,42 @@ pub unsafe extern "C" fn ddog_init_span_func(
     }
 }
 
+pub fn u8_from_zend_string(str: &ZendString) -> &[u8] {
+    unsafe { std::slice::from_raw_parts(str.val.as_ptr(), str.len) }
+}
+
+impl AsRef<[u8]> for OwnedZendString {
+    fn as_ref(&self) -> &[u8] {
+        unsafe { self.0.as_ref() }.as_ref()
+    }
+}
+
+impl AsRef<[u8]> for ZendString {
+    fn as_ref(&self) -> &[u8] {
+        u8_from_zend_string(self)
+    }
+}
+
+impl Into<OwnedZendString> for &str {
+    fn into(self) -> OwnedZendString {
+        init_zend_string(self.as_bytes())
+    }
+}
+
+impl Into<OwnedZendString> for &[u8] {
+    fn into(self) -> OwnedZendString {
+        init_zend_string(self)
+    }
+}
+
+pub fn init_zend_string(str: &[u8]) -> OwnedZendString {
+    unsafe { DDOG_INIT_ZEND_STRING.unwrap_unchecked()(CharSlice::from_bytes(str)) }
+}
+
+pub unsafe fn dangling_zend_string() -> OwnedZendString {
+    OwnedZendString(NonNull::dangling())
+}
+
 fn convert_to_bytes(zend_str: &mut ZendString) -> Bytes {
     unsafe {
         DDOG_ADDREF_ZEND_STRING.unwrap_unchecked()(zend_str); // Increment the reference count to prevent double free
@@ -52,14 +117,6 @@ fn convert_to_bytes(zend_str: &mut ZendString) -> Bytes {
     }
 }
 
-fn convert_literal_to_bytes(string: *const c_char) -> Bytes {
-    unsafe {
-        let cstring = CStr::from_ptr(string);
-
-        Bytes::from_static(cstring.to_bytes())
-    }
-}
-
 fn convert_zend_to_bytes_string(zend_str: &mut ZendString) -> BytesString {
     unsafe {
         match String::from_utf8_lossy(std::slice::from_raw_parts(

components-rs/bytes.rs

@@ -257,6 +257,9 @@ typedef struct ddog_Vec_Tag_ParseResult {
   struct ddog_Error *error_message;
 } ddog_Vec_Tag_ParseResult;
 
+typedef struct _zend_string _zend_string;
+
+
 #define ddog_LOG_ONCE (1 << 3)
 
 #define ddog_MultiTargetFetcher_DEFAULT_CLIENTS_LIMIT 100
@@ -271,6 +274,13 @@ typedef enum ddog_ConfigurationOrigin {
   DDOG_CONFIGURATION_ORIGIN_FLEET_STABLE_CONFIG,
 } ddog_ConfigurationOrigin;
 
+typedef enum ddog_DynamicConfigUpdateMode {
+  DDOG_DYNAMIC_CONFIG_UPDATE_MODE_READ,
+  DDOG_DYNAMIC_CONFIG_UPDATE_MODE_READ_WRITE,
+  DDOG_DYNAMIC_CONFIG_UPDATE_MODE_WRITE,
+  DDOG_DYNAMIC_CONFIG_UPDATE_MODE_RESTORE,
+} ddog_DynamicConfigUpdateMode;
+
 typedef enum ddog_EvaluateAt {
   DDOG_EVALUATE_AT_ENTRY,
   DDOG_EVALUATE_AT_EXIT,
@@ -441,9 +451,11 @@ typedef struct ddog_Tag {
   const struct ddog_DslString *value;
 } ddog_Tag;
 
-typedef struct ddog_Vec_CChar *(*ddog_DynamicConfigUpdate)(ddog_CharSlice config,
-                                                           ddog_CharSlice value,
-                                                           bool return_old);
+typedef struct _zend_string *ddog_OwnedZendString;
+
+typedef struct _zend_string *(*ddog_DynamicConfigUpdate)(ddog_CharSlice config,
+                                                         ddog_OwnedZendString value,
+                                                         enum ddog_DynamicConfigUpdateMode mode);
 
 typedef enum ddog_IntermediateValue_Tag {
   DDOG_INTERMEDIATE_VALUE_STRING,
@@ -750,6 +762,8 @@ typedef struct ddog_Vec_RemoteConfigCapabilities {
 
 typedef struct ddog_Vec_RemoteConfigCapabilities ddog_VecRemoteConfigCapabilities;
 
+#define ddog_DYANMIC_CONFIG_UPDATE_UNMODIFIED (_zend_string*)1
+
 typedef struct ddog_DebuggerCapture ddog_DebuggerCapture;
 typedef struct ddog_DebuggerValue ddog_DebuggerValue;
 
@@ -966,6 +980,12 @@ typedef struct ddog_AttributeAnyValueBytes ddog_AttributeAnyValueBytes;
 typedef struct ddog_AttributeArrayValueBytes ddog_AttributeArrayValueBytes;
 
 
+typedef enum ddog_DynamicInstrumentationConfigState {
+  DDOG_DYNAMIC_INSTRUMENTATION_CONFIG_STATE_ENABLED,
+  DDOG_DYNAMIC_INSTRUMENTATION_CONFIG_STATE_DISABLED,
+  DDOG_DYNAMIC_INSTRUMENTATION_CONFIG_STATE_NOT_SET,
+} ddog_DynamicInstrumentationConfigState;
+
 typedef struct ddog_AgentInfoReader ddog_AgentInfoReader;
 
 typedef struct ddog_AgentRemoteConfigReader ddog_AgentRemoteConfigReader;

components-rs/common.h

@@ -1,6 +1,4 @@
 struct _zend_string;
-
-
 #ifndef DDTRACE_PHP_H
 #define DDTRACE_PHP_H
 
@@ -82,7 +80,7 @@ bool ddog_remote_configs_service_env_change(struct ddog_RemoteConfigState *remot
 
 bool ddog_remote_config_alter_dynamic_config(struct ddog_RemoteConfigState *remote_config,
                                              ddog_CharSlice config,
-                                             ddog_CharSlice new_value);
+                                             ddog_OwnedZendString new_value);
 
 void ddog_setup_remote_config(ddog_DynamicConfigUpdate update_config,
                               const struct ddog_LiveDebuggerSetup *setup);
@@ -183,8 +181,9 @@ ddog_MaybeError ddog_sidecar_telemetry_filter_flush(struct ddog_SidecarTransport
                                                     ddog_CharSlice service,
                                                     ddog_CharSlice env);
 
-void ddog_init_span_func(void (*free_func)(struct _zend_string*),
-                         void (*addref_func)(struct _zend_string*));
+void ddog_init_span_func(void (*free_func)(ddog_OwnedZendString),
+                         void (*addref_func)(struct _zend_string*),
+                         ddog_OwnedZendString (*init_func)(ddog_CharSlice));
 
 void ddog_set_span_service_zstr(ddog_SpanBytes *ptr, struct _zend_string *str);
 

components-rs/ddtrace.h

@@ -1,6 +1,7 @@
 #![allow(internal_features)]
 #![feature(allow_internal_unstable)]
 #![feature(linkage)]
+#![allow(static_mut_refs)] // remove with move to Rust 2024 edition
 
 pub mod log;
 pub mod remote_config;
@@ -16,7 +17,7 @@ use std::ffi::c_char;
 use std::ptr::null_mut;
 use uuid::Uuid;
 
-pub use datadog_crashtracker_ffi::*;
+pub use libdd_crashtracker_ffi::*;
 pub use libdd_library_config_ffi::*;
 pub use datadog_sidecar_ffi::*;
 use libdd_common::{parse_uri, Endpoint};