Add standalone datadog-ipc-helper binary

Extract the sidecar into a dedicated `datadog-ipc-helper` binary (new
`components-rs/sidecar-bin` crate) that is located at runtime alongside
the `ddtrace.so` path, removing the `php_shared_build` cfg flag and the
old `php_sidecar_mockgen` crate entirely.

Build script gains platform specific RUSTFLAGS for the sidecar binary:
musl disables static CRT (needed for dlopen of the AppSec helper) and
mac os switches fat LTO to thin LTO to work around problems with the
llvm mac os linker.

Author: cataphract

Cargo.lock

@@ -1,5 +1,6 @@
 [workspace]
-members = ["components-rs", "components-rs/php_sidecar_mockgen", "profiling"]
+members = ["components-rs", "components-rs/sidecar-bin", "profiling"]
+exclude = ["tmp"]
 resolver = "2"
 
 [workspace.package]
@@ -25,6 +26,7 @@ codegen-units = 1
 panic = "abort"
 inherits = "release"
 
+
 [profile.profiler-release]
 panic = "abort"
 inherits = "release"

Cargo.toml

@@ -22,6 +22,9 @@ BENCHMARK_EXTRA ?=
 COMPONENTS_BUILD_DIR = $(PROJECT_ROOT)/tmp/build_components
 SO_FILE = $(BUILD_DIR)/modules/ddtrace.so
 AR_FILE = $(BUILD_DIR)/modules/ddtrace.a
+SIDECAR_BIN_DEBUG = $(BUILD_DIR)/target/debug/datadog-ipc-helper
+SIDECAR_BIN_RELEASE = $(BUILD_DIR)/target/tracer-release/datadog-ipc-helper
+SIDECAR_BIN = $(if $(RUST_DEBUG_BUILD),$(SIDECAR_BIN_DEBUG),$(SIDECAR_BIN_RELEASE))
 WALL_FLAGS = -Wall -Wextra
 CFLAGS ?= $(shell [ -n "${DD_TRACE_DOCKER_DEBUG}" ] && echo -O0 || echo -O2) -g $(WALL_FLAGS)
 LDFLAGS ?=
@@ -48,7 +51,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-ffe,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},libdd-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-ffe,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,libdd-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 }' )
@@ -63,7 +66,9 @@ else
 	SED_I = sed -i ''
 endif
 
-all: $(BUILD_DIR)/configure $(SO_FILE)
+SIDECAR_BIN_IN_MODULES = $(BUILD_DIR)/modules/datadog-ipc-helper
+
+all: $(BUILD_DIR)/configure $(SO_FILE) $(SIDECAR_BIN_IN_MODULES)
 
 # The following differentiation exists so we can build only (but always) the relevant files while executing tests
 #  - when a `.phpt` changes, we only copy the file to the build dir and we DO NOT rebuild
@@ -104,8 +109,6 @@ $(BUILD_DIR)/%: %
 
 JUNIT_RESULTS_DIR := $(shell pwd)
 
-all: $(BUILD_DIR)/configure $(SO_FILE)
-
 $(BUILD_DIR)/configure: $(M4_FILES) $(BUILD_DIR)/ddtrace.sym $(BUILD_DIR)/VERSION
 	$(Q) (cd $(BUILD_DIR); phpize && $(SED_I) 's/\/FAILED/\/\\bFAILED/' $(BUILD_DIR)/run-tests.php) # Fix PHP 5.4 exit code bug when running selected tests (FAILED vs XFAILED)
 
@@ -116,16 +119,23 @@ $(BUILD_DIR)/run-tests.php: $(if $(ASSUME_COMPILED),, $(BUILD_DIR)/configure)
 $(BUILD_DIR)/Makefile: $(BUILD_DIR)/configure
 	$(Q) (cd $(BUILD_DIR); $(if $(ASAN),CFLAGS="${CFLAGS} -DZEND_TRACK_ARENA_ALLOC") ./configure --$(if $(RUST_DEBUG_BUILD),enable,disable)-ddtrace-rust-debug $(if $(ASAN), --enable-ddtrace-sanitize) $(EXTRA_CONFIGURE_OPTIONS))
 
+
 $(SO_FILE): $(if $(ASSUME_COMPILED),, $(ALL_OBJECT_FILES) $(BUILD_DIR)/compile_rust.sh)
 	$(if $(ASSUME_COMPILED),,$(Q) $(MAKE) -C $(BUILD_DIR) -j)
 
+$(SIDECAR_BIN_IN_MODULES): $(SO_FILE)
+	$(Q) cp $(SIDECAR_BIN) $@
+
 $(AR_FILE): $(ALL_OBJECT_FILES)
 	$(Q) $(MAKE) -C $(BUILD_DIR) -j ./modules/ddtrace.a all
 
 $(PHP_EXTENSION_DIR)/ddtrace.so: $(SO_FILE)
 	$(Q) $(SUDO) $(if $(ASSUME_COMPILED),cp $(BUILD_DIR)/modules/ddtrace.so $(PHP_EXTENSION_DIR)/ddtrace.so,$(MAKE) -C $(BUILD_DIR) install)
 
-install: $(PHP_EXTENSION_DIR)/ddtrace.so
+$(PHP_EXTENSION_DIR)/datadog-ipc-helper: $(SIDECAR_BIN)
+	$(Q) $(SUDO) cp $(SIDECAR_BIN) $(PHP_EXTENSION_DIR)/datadog-ipc-helper
+
+install: $(PHP_EXTENSION_DIR)/ddtrace.so $(PHP_EXTENSION_DIR)/datadog-ipc-helper
 
 set_static_option:
 	$(eval EXTRA_CONFIGURE_OPTIONS := --enable-ddtrace-rust-library-split)

Makefile

@@ -345,13 +345,14 @@ def buildTracerTask = { String version, String variant, altBaseTag = null ->
             ],
             outputs: [
                     volume: 'php-tracer',
-                    files: ['build_extension/modules/ddtrace.so'],
+                    files: ['build_extension/modules/ddtrace.so',
+                            'build_extension/modules/datadog-ipc-helper'],
             ],
             command: [
                     '-e', '-c',
                     '''
                     cd /project
-                    PHPRC= RUST_DEBUG_BUILD=1 make /project/tmp/build_extension/modules/ddtrace.so
+                    PHPRC= RUST_DEBUG_BUILD=1 make
                     '''
             ]
     )

appsec/tests/integration/build.gradle

@@ -3,22 +3,47 @@ cd components-rs
 
 RUSTFLAGS="${RUSTFLAGS:-} --cfg tokio_unstable"
 
-if test -n "$SHARED"; then
-  RUSTFLAGS="$RUSTFLAGS --cfg php_shared_build"
-fi
-
 case "${host_os}" in
   darwin*)
     RUSTFLAGS="$RUSTFLAGS -Clink-arg=-undefined -Clink-arg=dynamic_lookup";
     ;;
 esac
 
-set -x
+set -ex
 
 if test -n "$COMPILE_ASAN"; then
   # We need -lresolv due to https://github.com/llvm/llvm-project/issues/59007
   export LDFLAGS="-fsanitize=address $(if cc -v 2>&1 | grep -q clang; then echo "-shared-libsan -lresolv"; fi)"
   export CFLAGS="$LDFLAGS -fno-omit-frame-pointer" # the cc buildtools will only pick up CFLAGS it seems
 fi
 
-SIDECAR_VERSION=$(cat ../VERSION) RUSTFLAGS="$RUSTFLAGS" RUSTC_BOOTSTRAP=1 "${DDTRACE_CARGO:-cargo}" build $(test "${PROFILE:-debug}" = "debug" || echo --profile "$PROFILE") "$@"
+# Choose the cargo profile.
+if test "${PROFILE:-debug}" = "debug"; then
+  CARGO_PROFILE_ARG=""
+else
+  CARGO_PROFILE_ARG="--profile $PROFILE"
+fi
+
+CARGO_TARGET_DIR="${CARGO_TARGET_DIR:?CARGO_TARGET_DIR must be set}"
+
+# Sidecar-specific RUSTFLAGS.
+# - musl: disable static CRT so dlopen works for loading the AppSec helper.
+# - macOS: override fat LTO (from tracer-release) to thin LTO, because the
+#   Xcode system linker ships an older LLVM that cannot parse the bitcode
+#   produced by the Rust toolchain's fat-LTO mode.
+SIDECAR_RUSTFLAGS="$RUSTFLAGS"
+case "${host_os}" in
+  *musl*)
+    SIDECAR_RUSTFLAGS="$SIDECAR_RUSTFLAGS -C target-feature=-crt-static"
+    ;;
+  darwin*)
+    SIDECAR_RUSTFLAGS="$SIDECAR_RUSTFLAGS -C lto=thin"
+    ;;
+esac
+
+SIDECAR_VERSION=$(cat ../VERSION) RUSTFLAGS="$RUSTFLAGS" RUSTC_BOOTSTRAP=1 \
+  "${DDTRACE_CARGO:-cargo}" build -p ddtrace-php $CARGO_PROFILE_ARG "$@"
+
+SIDECAR_VERSION=$(cat ../VERSION) RUSTFLAGS="$SIDECAR_RUSTFLAGS" RUSTC_BOOTSTRAP=1 \
+  "${DDTRACE_CARGO:-cargo}" build -p datadog-ipc-helper $CARGO_PROFILE_ARG "$@"
+

compile_rust.sh

@@ -55,4 +55,4 @@ hashbrown = "0.15"
 cbindgen = "0.27"
 
 [lints.rust]
-unexpected_cfgs = { level = "warn", check-cfg = ['cfg(php_shared_build)'] }
+unexpected_cfgs = { level = "warn", check-cfg = [] }

components-rs/Cargo.toml

@@ -17,8 +17,6 @@ extern ddog_VecRemoteConfigProduct DDTRACE_REMOTE_CONFIG_PRODUCTS;
 
 extern ddog_VecRemoteConfigCapabilities DDTRACE_REMOTE_CONFIG_CAPABILITIES;
 
-extern const uint8_t *DDOG_PHP_FUNCTION;
-
 extern struct ddog_SidecarTransport *ddtrace_sidecar;
 
 /**