First pass

Author: gyuheon0h

Cargo.lock

@@ -1,4 +1,4 @@
-root_name: builder, build_common, tools, datadog-alloc, datadog-crashtracker, ddcommon, ddtelemetry, datadog-ddsketch, datadog-crashtracker-ffi, ddcommon-ffi, datadog-ffe, datadog-ipc, datadog-ipc-macros, tarpc, tarpc-plugins, tinybytes, spawn_worker, datadog-library-config, datadog-library-config-ffi, datadog-live-debugger, datadog-live-debugger-ffi, datadog-profiling, datadog-profiling-protobuf, datadog-profiling-ffi, data-pipeline-ffi, data-pipeline, datadog-trace-protobuf, datadog-trace-stats, datadog-trace-utils, datadog-trace-normalization, dogstatsd-client, datadog-log, datadog-log-ffi, ddsketch-ffi, ddtelemetry-ffi, symbolizer-ffi, datadog-profiling-replayer, datadog-remote-config, datadog-sidecar, datadog-sidecar-macros, datadog-sidecar-ffi, datadog-trace-obfuscation, datadog-tracer-flare, sidecar_mockgen, test_spawn_from_lib
+root_name: builder, build_common, tools, datadog-alloc, datadog-crashtracker, ddcommon, ddcommon-ffi, ddtelemetry, datadog-ddsketch, datadog-crashtracker-ffi, datadog-ffe, datadog-ipc, datadog-ipc-macros, tarpc, tarpc-plugins, tinybytes, spawn_worker, datadog-library-config, datadog-library-config-ffi, datadog-live-debugger, datadog-live-debugger-ffi, datadog-profiling, datadog-profiling-protobuf, datadog-profiling-ffi, data-pipeline-ffi, data-pipeline, datadog-trace-protobuf, datadog-trace-stats, datadog-trace-utils, datadog-trace-normalization, dogstatsd-client, datadog-log, datadog-log-ffi, ddsketch-ffi, ddtelemetry-ffi, symbolizer-ffi, datadog-profiling-replayer, datadog-remote-config, datadog-sidecar, datadog-sidecar-macros, datadog-sidecar-ffi, datadog-trace-obfuscation, datadog-tracer-flare, sidecar_mockgen, test_spawn_from_lib
 third_party_libraries:
 - package_name: addr2line
   package_version: 0.24.2

LICENSE-3rdparty.yml

@@ -15,6 +15,7 @@ current_platform = "0.2.0"
 datadog-profiling = { path = "../datadog-profiling" }
 datadog-crashtracker = { path = "../datadog-crashtracker" }
 ddcommon = { path = "../ddcommon" }
+ddcommon-ffi = { path = "../ddcommon-ffi" }
 tempfile = "3.3"
 serde_json = { version = "1.0" }
 strum = { version = "0.26.2", features = ["derive"] }

bin_tests/Cargo.toml

@@ -129,6 +129,8 @@ pub fn get_behavior(mode_str: &str) -> Box<dyn Behavior> {
         "chained" => Box::new(test_007_chaining::Test),
         "fork" => Box::new(test_008_fork::Test),
         "prechain_abort" => Box::new(test_009_prechain_with_abort::Test),
+        "runtime_callback_frame" => Box::new(test_010_runtime_callback_frame::Test),
+        "runtime_callback_string" => Box::new(test_011_runtime_callback_string::Test),
         _ => panic!("Unknown mode: {mode_str}"),
     }
 }

bin_tests/src/modes/behavior.rs

@@ -10,3 +10,5 @@ pub mod test_006_sigchld_sigstack;
 pub mod test_007_chaining;
 pub mod test_008_fork;
 pub mod test_009_prechain_with_abort;
+pub mod test_010_runtime_callback_frame;
+pub mod test_011_runtime_callback_string;

bin_tests/src/modes/unix/mod.rs

@@ -0,0 +1,109 @@
+// Copyright 2024-Present Datadog, Inc. https://www.datadoghq.com/
+// SPDX-License-Identifier: Apache-2.0
+//
+// This test validates the runtime stack collection callback mechanism using frame-by-frame mode.
+// It registers a test callback that provides mock runtime stack frames,
+// then crashes and verifies that the runtime frames appear in the crash report.
+//
+// This test uses frame-by-frame callback to emit structured runtime stack data.
+
+use crate::modes::behavior::Behavior;
+use datadog_crashtracker::{
+    clear_runtime_callback, register_runtime_frame_callback, CrashtrackerConfiguration,
+    RuntimeStackFrame,
+};
+use ddcommon_ffi::CharSlice;
+use std::path::Path;
+
+pub struct Test;
+
+impl Behavior for Test {
+    fn setup(
+        &self,
+        _output_dir: &Path,
+        _config: &mut CrashtrackerConfiguration,
+    ) -> anyhow::Result<()> {
+        Ok(())
+    }
+
+    fn pre(&self, _output_dir: &Path) -> anyhow::Result<()> {
+        // Ensure clean state
+        unsafe {
+            clear_runtime_callback();
+        }
+        register_runtime_frame_callback(test_runtime_callback_frame)
+            .map_err(|e| anyhow::anyhow!("Failed to register runtime callback: {:?}", e))?;
+        Ok(())
+    }
+
+    fn post(&self, _output_dir: &Path) -> anyhow::Result<()> {
+        Ok(())
+    }
+}
+
+// Signal-safe test callback that emits mock runtime stack frames
+unsafe extern "C" fn test_runtime_callback_frame(
+    emit_frame: unsafe extern "C" fn(*const RuntimeStackFrame),
+) {
+    static FUNCTION_NAME_1: &str = "test_module.TestClass.runtime_function_1";
+    static FUNCTION_NAME_2: &str = "my_package.submodule.MyModule.runtime_function_2";
+    static FUNCTION_NAME_3: &str = "__main__.runtime_main";
+    static FILE_NAME_1: &str = "script.py";
+    static FILE_NAME_2: &str = "module.py";
+    static FILE_NAME_3: &str = "main.py";
+
+    let frame1 = RuntimeStackFrame {
+        function_name: CharSlice::from(FUNCTION_NAME_1),
+        file_name: CharSlice::from(FILE_NAME_1),
+        line_number: 42,
+        column_number: 15,
+    };
+    emit_frame(&frame1);
+
+    let frame2 = RuntimeStackFrame {
+        function_name: CharSlice::from(FUNCTION_NAME_2),
+        file_name: CharSlice::from(FILE_NAME_2),
+        line_number: 100,
+        column_number: 8,
+    };
+    emit_frame(&frame2);
+
+    let frame3 = RuntimeStackFrame {
+        function_name: CharSlice::from(FUNCTION_NAME_3),
+        file_name: CharSlice::from(FILE_NAME_3),
+        line_number: 10,
+        column_number: 1,
+    };
+    emit_frame(&frame3);
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use datadog_crashtracker::{clear_runtime_callback, is_runtime_callback_registered};
+
+    #[test]
+    fn test_runtime_callback_frame_registration() {
+        // Ensure clean state
+        unsafe {
+            clear_runtime_callback();
+        }
+
+        assert!(!is_runtime_callback_registered());
+
+        let result = register_runtime_frame_callback(test_runtime_callback_frame);
+        assert!(result.is_ok(), "Frame callback registration should succeed");
+        assert!(
+            is_runtime_callback_registered(),
+            "Callback should be registered"
+        );
+
+        unsafe {
+            clear_runtime_callback();
+        }
+        assert!(
+            !is_runtime_callback_registered(),
+            "Callback should be cleared"
+        );
+    }
+}

bin_tests/src/modes/unix/test_010_runtime_callback_frame.rs

@@ -0,0 +1,82 @@
+// Copyright 2024-Present Datadog, Inc. https://www.datadoghq.com/
+// SPDX-License-Identifier: Apache-2.0
+//
+// This test validates the runtime stack collection callback mechanism using string mode.
+// It registers a test callback that provides mock runtime stacktrace string,
+// then crashes and verifies that the runtime stacktrace string appear in the crash report.
+//
+// This test uses stacktrace string callback to emit structured runtime stack data.
+
+use crate::modes::behavior::Behavior;
+use datadog_crashtracker::{
+    clear_runtime_callback, register_runtime_stacktrace_string_callback, CrashtrackerConfiguration,
+};
+use std::ffi::c_char;
+use std::path::Path;
+
+pub struct Test;
+
+impl Behavior for Test {
+    fn setup(
+        &self,
+        _output_dir: &Path,
+        _config: &mut CrashtrackerConfiguration,
+    ) -> anyhow::Result<()> {
+        Ok(())
+    }
+
+    fn pre(&self, _output_dir: &Path) -> anyhow::Result<()> {
+        // Ensure clean state
+        unsafe {
+            clear_runtime_callback();
+        }
+        register_runtime_stacktrace_string_callback(test_runtime_callback_string)
+            .map_err(|e| anyhow::anyhow!("Failed to register runtime callback: {:?}", e))?;
+        Ok(())
+    }
+
+    fn post(&self, _output_dir: &Path) -> anyhow::Result<()> {
+        Ok(())
+    }
+}
+
+// Signal-safe test callback that emits mock runtime stacktrace string
+unsafe extern "C" fn test_runtime_callback_string(
+    emit_stacktrace_string: unsafe extern "C" fn(*const c_char),
+) {
+    static STACKTRACE_STRING: &[u8] = b"test_stacktrace_string\0";
+    emit_stacktrace_string(STACKTRACE_STRING.as_ptr() as *const c_char);
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use datadog_crashtracker::{clear_runtime_callback, is_runtime_callback_registered};
+
+    #[test]
+    fn test_runtime_callback_string_registration() {
+        unsafe {
+            clear_runtime_callback();
+        }
+
+        assert!(!is_runtime_callback_registered());
+
+        let result = register_runtime_stacktrace_string_callback(test_runtime_callback_string);
+        assert!(
+            result.is_ok(),
+            "String callback registration should succeed"
+        );
+        assert!(
+            is_runtime_callback_registered(),
+            "Callback should be registered"
+        );
+
+        unsafe {
+            clear_runtime_callback();
+        }
+        assert!(
+            !is_runtime_callback_registered(),
+            "Callback should be cleared"
+        );
+    }
+}