FIXUP: add FFI examples and fix build

ekump · ekump · commit d10aeef22ad1 · 2025-07-09T15:23:17.000-04:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/LICENSE-3rdparty.yml b/LICENSE-3rdparty.yml
@@ -1,4 +1,4 @@
-root_name: builder, build_common, tools, datadog-alloc, datadog-crashtracker, ddcommon, ddtelemetry, datadog-ddsketch, datadog-crashtracker-ffi, ddcommon-ffi, datadog-ipc, datadog-ipc-macros, tarpc, tarpc-plugins, tinybytes, spawn_worker, cc_utils, 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-utils, datadog-trace-normalization, dogstatsd-client, datadog-log-ffi, datadog-log, 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, bin_tests
+root_name: builder, build_common, tools, datadog-alloc, datadog-crashtracker, ddcommon, ddtelemetry, datadog-ddsketch, datadog-crashtracker-ffi, ddcommon-ffi, datadog-ipc, datadog-ipc-macros, tarpc, tarpc-plugins, tinybytes, spawn_worker, cc_utils, 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-utils, datadog-trace-normalization, dogstatsd-client, datadog-log-ffi, datadog-log, 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
diff --git a/build-profiling-ffi.sh b/build-profiling-ffi.sh
@@ -153,6 +153,7 @@ FEATURES=(
     "datadog-profiling-ffi/demangler"
     "datadog-library-config-ffi"
     "datadog-log-ffi"
+    "ddsketch-ffi"
 )
 if [[ "$symbolizer" -eq 1 ]]; then
     FEATURES+=("symbolizer")
@@ -237,7 +238,7 @@ echo "Generating $destdir/include/libdatadog headers..."
 rm -r $destdir/include/datadog/
 mkdir $destdir/include/datadog/
 
-CBINDGEN_HEADERS="common.h profiling.h telemetry.h crashtracker.h data-pipeline.h library-config.h log.h"
+CBINDGEN_HEADERS="common.h profiling.h telemetry.h crashtracker.h data-pipeline.h library-config.h log.h ddsketch.h"
 # When optional features are added, don't forget to also include the headers here
 case $ARG_FEATURES in
 esac
diff --git a/builder/Cargo.toml b/builder/Cargo.toml
@@ -15,6 +15,7 @@ data-pipeline = []
 symbolizer = []
 library-config = []
 log = []
+ddsketch = []
 
 [lib]
 bench = false
diff --git a/builder/src/bin/release.rs b/builder/src/bin/release.rs
@@ -70,6 +70,8 @@ pub fn main() {
         f.push("datadog-library-config-ffi".to_string());
         #[cfg(feature = "log")]
         f.push("datadog-log-ffi".to_string());
+        #[cfg(feature = "ddsketch")]
+        f.push("ddsketch-ffi".to_string());
         f
     };
 
diff --git a/builder/src/profiling.rs b/builder/src/profiling.rs
@@ -55,6 +55,8 @@ impl Profiling {
         headers.push("library-config.h");
         #[cfg(feature = "log")]
         headers.push("log.h");
+        #[cfg(feature = "ddsketch")]
+        headers.push("ddsketch.h");
 
         let mut origin_path: PathBuf = [&self.source_include, "dummy.h"].iter().collect();
         let mut target_path: PathBuf = [&self.target_include, "dummy.h"].iter().collect();
diff --git a/datadog-profiling-ffi/Cargo.toml b/datadog-profiling-ffi/Cargo.toml
@@ -29,6 +29,7 @@ crashtracker-receiver = ["crashtracker-ffi", "datadog-crashtracker-ffi/receiver"
 demangler = ["crashtracker-ffi", "datadog-crashtracker-ffi/demangler"]
 datadog-library-config-ffi = ["dep:datadog-library-config-ffi"]
 ddcommon-ffi = ["dep:ddcommon-ffi"]
+ddsketch-ffi = ["dep:ddsketch-ffi"]
 
 [build-dependencies]
 build_common = { path = "../build-common" }
@@ -43,6 +44,7 @@ ddcommon = { path = "../ddcommon" }
 ddcommon-ffi = { path = "../ddcommon-ffi", default-features = false, optional = true }
 ddtelemetry-ffi = { path = "../ddtelemetry-ffi", default-features = false, optional = true, features = ["expanded_builder_macros"] }
 datadog-log-ffi = { path = "../datadog-log-ffi", default-features = false, optional = true }
+ddsketch-ffi = { path = "../ddsketch-ffi", default-features = false, optional = true }
 function_name = "0.3.0"
 futures = { version = "0.3", default-features = false }
 http-body-util = "0.1"
diff --git a/datadog-profiling-ffi/src/lib.rs b/datadog-profiling-ffi/src/lib.rs
@@ -26,6 +26,11 @@ pub use ddtelemetry_ffi::*;
 #[allow(unused_imports)]
 pub use data_pipeline_ffi::*;
 
+// re-export ddsketch ffi
+#[cfg(feature = "ddsketch-ffi")]
+#[allow(unused_imports)]
+pub use ddsketch_ffi::*;
+
 // re-export library-config ffi
 #[cfg(feature = "datadog-library-config-ffi")]
 pub use datadog_library_config_ffi::*;
diff --git a/ddsketch-ffi/build.rs b/ddsketch-ffi/build.rs
@@ -1,8 +1,11 @@
-// Copyright 2023-Present Datadog, Inc. https://www.datadoghq.com/
+// Copyright 2025-Present Datadog, Inc. https://www.datadoghq.com/
 // SPDX-License-Identifier: Apache-2.0
 
+extern crate build_common;
+
 use build_common::generate_and_configure_header;
 
 fn main() {
-    generate_and_configure_header("datadog_ddsketch.h");
+    let header_name = "ddsketch.h";
+    generate_and_configure_header(header_name);
 }
diff --git a/ddsketch-ffi/cbindgen.toml b/ddsketch-ffi/cbindgen.toml
@@ -16,7 +16,7 @@ includes = ["common.h"]
 
 [parse]
 parse_deps = true
-include = ["ddcommon-ffi"]
+include = ["ddcommon-ffi", "datadog-ddsketch"]
 
 [export]
 include = ["ddsketch-ffi"]
@@ -32,4 +32,4 @@ must_use = "DDOG_CHECK_RETURN"
 
 [enum]
 prefix_with_name = true
-rename_variants = "ScreamingSnakeCase"
+rename_variants = "ScreamingSnakeCase"
diff --git a/examples/ffi/CMakeLists.txt b/examples/ffi/CMakeLists.txt
@@ -74,3 +74,7 @@ set_vcruntime_link_type(array_queue ${VCRUNTIME_LINK_TYPE})
 add_executable(library_config library_config.c)
 target_link_libraries(library_config PRIVATE Datadog::Profiling)
 set_vcruntime_link_type(library_config ${VCRUNTIME_LINK_TYPE})
+
+add_executable(ddsketch ddsketch.c)
+target_link_libraries(ddsketch PRIVATE Datadog::Profiling)
+set_vcruntime_link_type(ddsketch ${VCRUNTIME_LINK_TYPE})
diff --git a/examples/ffi/README.md b/examples/ffi/README.md
@@ -3,7 +3,7 @@
 
 In order to be able to run FFI examples, you need to build the shared library and headers with the command:
 ```bash
-cargo run --bin release --features profiling,telemetry,data-pipeline,symbolizer,crashtracker,library-config,log --release -- --out
+cargo run --bin release --features profiling,telemetry,data-pipeline,symbolizer,crashtracker,library-config,log,ddsketch --release -- --out
 ```
 
 You can then build the examples with:
diff --git a/examples/ffi/ddsketch.c b/examples/ffi/ddsketch.c
@@ -0,0 +1,74 @@
+// Copyright 2025-Present Datadog, Inc. https://www.datadoghq.com/
+// SPDX-License-Identifier: Apache-2.0
+
+#include <datadog/common.h>
+#include <datadog/ddsketch.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+#define TRY(expr)                                                                                  \
+  {                                                                                                \
+    struct DDSketchError *err = expr;                                                             \
+    if (err != NULL) {                                                                            \
+      const char *message = err->msg.ptr;                                                         \
+      fprintf(stderr, "ERROR: %s\n", message);                                                   \
+      ddog_ddsketch_error_free(err);                                                              \
+      return 1;                                                                                   \
+    }                                                                                             \
+  }
+
+int main(void) {
+  // Create a new DDSketch
+  ddog_DDSketch *sketch = NULL;
+  TRY(ddog_ddsketch_new(&sketch));
+
+  printf("Created DDSketch successfully\n");
+
+  // Add some sample data points
+  printf("Adding sample data points...\n");
+  TRY(ddog_ddsketch_add(sketch, 1.0));
+  TRY(ddog_ddsketch_add(sketch, 2.5));
+  TRY(ddog_ddsketch_add(sketch, 5.0));
+  TRY(ddog_ddsketch_add(sketch, 10.0));
+  TRY(ddog_ddsketch_add(sketch, 15.0));
+
+  // Add points with specific counts
+  printf("Adding points with specific counts...\n");
+  TRY(ddog_ddsketch_add_with_count(sketch, 3.0, 5.0));  // Add 3.0 with count 5
+  TRY(ddog_ddsketch_add_with_count(sketch, 7.0, 3.0));  // Add 7.0 with count 3
+
+  // Get the total count
+  double count = ddog_ddsketch_count(sketch);
+  printf("Total count in sketch: %.0f\n", count);
+
+  // Get the ordered bins (buckets)
+  printf("Getting ordered bins...\n");
+  ddog_Vec_DDSketchBin bins = ddog_ddsketch_ordered_bins(sketch);
+  
+  printf("Number of bins: %zu\n", bins.len);
+  for (size_t i = 0; i < bins.len; i++) {
+    printf("  Bin %zu: value=%.2f, weight=%.0f\n", i, bins.ptr[i].value, bins.ptr[i].weight);
+  }
+
+  // Clean up bins
+  ddog_ddsketch_bins_drop(bins);
+
+  // Encode the sketch to protobuf format
+  printf("Encoding sketch to protobuf...\n");
+  struct ddog_Vec_u8 encoded = ddog_ddsketch_encode(sketch);
+  
+  printf("Encoded sketch size: %zu bytes\n", encoded.len);
+  
+  // Print first few bytes of encoded data (for demonstration)
+  printf("First 10 bytes of encoded data: ");
+  for (size_t i = 0; i < (encoded.len < 10 ? encoded.len : 10); i++) {
+    printf("%02x ", encoded.ptr[i]);
+  }
+  printf("\n");
+
+  // Clean up the sketch (note: sketch is consumed by ddog_ddsketch_encode)
+  // ddog_ddsketch_drop is not called here because the sketch was consumed
+
+  printf("DDSketch example completed successfully!\n");
+  return 0;
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-root_name: builder, build_common, tools, datadog-alloc, datadog-crashtracker, ddcommon, ddtelemetry, datadog-ddsketch, datadog-crashtracker-ffi, ddcommon-ffi, datadog-ipc, datadog-ipc-macros, tarpc, tarpc-plugins, tinybytes, spawn_worker, cc_utils, 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-utils, datadog-trace-normalization, dogstatsd-client, datadog-log-ffi, datadog-log, 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, bin_tests
	`1`	+root_name: builder, build_common, tools, datadog-alloc, datadog-crashtracker, ddcommon, ddtelemetry, datadog-ddsketch, datadog-crashtracker-ffi, ddcommon-ffi, datadog-ipc, datadog-ipc-macros, tarpc, tarpc-plugins, tinybytes, spawn_worker, cc_utils, 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-utils, datadog-trace-normalization, dogstatsd-client, datadog-log-ffi, datadog-log, 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
`2`	`2`	`third_party_libraries:`
`3`	`3`	`- package_name: addr2line`
`4`	`4`	`package_version: 0.24.2`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,8 @@ pub fn main() {`
`70`	`70`	`f.push("datadog-library-config-ffi".to_string());`
`71`	`71`	`#[cfg(feature = "log")]`
`72`	`72`	`f.push("datadog-log-ffi".to_string());`
	`73`	`+ #[cfg(feature = "ddsketch")]`
	`74`	`+ f.push("ddsketch-ffi".to_string());`
`73`	`75`	`f`
`74`	`76`	`};`
`75`	`77`