feat: add tracy profiler support (#12048)

* feat: add tracy profiler support

* chore: add start

* chore: auto split dsym file

* chore: fix cargo deny

* fix: ci modified check

* chore: fix cargo deny

* chore: fix cargo shear

---------

Co-authored-by: pshu <[email protected]>

Author: hardfist

Cargo.lock

@@ -146,10 +146,15 @@ swc_html_minifier   = { version = "35.0.0", default-features = false }
 swc_node_comments   = { version = "16.0.0", default-features = false }
 swc_plugin_runner   = { version = "21.0.0", default-features = false }
 
-wasi-common = { version = "35.0.0", default-features = false }
-wasmtime    = { version = "35.0.0", default-features = false }
-
 rspack_dojang = { version = "0.1.11", default-features = false }
+tracy-client = { version = "=0.18.2", default-features = false, features = [
+  "enable",
+  "sampling",
+  "demangle",
+  "system-tracing",
+] }
+wasi-common = { version = "35.0.0", default-features = false }
+wasmtime = { version = "35.0.0", default-features = false }
 
 
 # all rspack workspace dependencies
@@ -251,10 +256,11 @@ opt-level = 0
 
 # This is for local development
 [profile.dev]
-codegen-units = 16
-debug         = 2       # debug build will cause runtime panic if codegen-unints is default
-incremental   = true
-panic         = "abort"
+codegen-units   = 16
+debug           = 2          # debug build will cause runtime panic if codegen-unints is default
+incremental     = true
+panic           = "abort"
+split-debuginfo = "unpacked"
 
 [profile.release-debug]
 codegen-units = 16

Cargo.toml

@@ -1,2 +1,3 @@
 /*.node
-/*.wasm
+/*.wasm
+/*.dSYM

crates/node_binding/.gitignore

@@ -11,13 +11,14 @@ version.workspace = true
 crate-type = ["cdylib"]
 
 [features]
+allocative      = ["rspack_binding_api/allocative"]
 browser         = ["rspack_binding_api/browser"]
 color-backtrace = ["rspack_binding_api/color-backtrace"]
 debug_tool      = ["rspack_binding_api/debug_tool"]
 info-level      = ["tracing/release_max_level_info"]
 plugin          = ["rspack_binding_api/plugin"]
 sftrace-setup   = ["rspack_binding_api/sftrace-setup"]
-allocative      = ["rspack_binding_api/allocative"]
+tracy-client    = ["rspack_binding_api/tracy-client"]
 
 [package.metadata.cargo-shear]
 # Adding napi-derive as a dependency to workaround an issue where `dts` will no longer work without it.

crates/node_binding/Cargo.toml

@@ -11,7 +11,7 @@ const { values, positionals } = require("util").parseArgs({
 	allowPositionals: true
 });
 
-const { spawn } = require("child_process");
+const { spawn, spawnSync } = require("child_process");
 
 const NAPI_BINDING_DTS = "napi-binding.d.ts"
 const CARGO_SAFELY_EXIT_CODE = 0;
@@ -82,6 +82,9 @@ async function build() {
 			features.push("allocative");
 			rustflags.push("--cfg=allocative");
 		}
+		if (process.env.TRACY) {
+			features.push("tracy-client");
+		}
 		if (values.profile === "release") {
 			features.push("info-level");
 		}
@@ -138,6 +141,16 @@ async function build() {
 					renameSync("rspack.wasm32-wasi.debug.wasm", "rspack.browser.debug.wasm")
 					renameSync("rspack.wasm32-wasi.wasm", "rspack.browser.wasm")
 				}
+
+				if(process.env.TRACY){
+					// split debug symbols for tracy
+				  spawnSync('dsymutil', [
+						path.resolve(__dirname, "..", "rspack.darwin-arm64.node")
+					], {
+						stdio: "inherit",
+						shell: true,
+					})
+				}
 			}
 			resolve(code);
 		});

crates/node_binding/scripts/build.js

@@ -6,9 +6,12 @@ name              = "rspack_allocator"
 repository        = "https://github.com/web-infra-dev/rspack"
 version.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[dependencies]
 
 [target.'cfg(not(target_family = "wasm"))'.dependencies]
-sftrace-setup = { workspace = true, optional = true }
+sftrace-setup    = { workspace = true, optional = true }
+tracy-client     = { workspace = true, optional = true }
+tracy-client-sys = { version = "=0.26.0" }
 
 [target.'cfg(target_os = "linux")'.dependencies]
 # Turned on `local_dynamic_tls` to avoid issue: https://github.com/microsoft/mimalloc/issues/147
@@ -19,3 +22,6 @@ mimalloc = { workspace = true, features = ["v3"] }
 
 [target.'cfg(all(not(target_os = "linux"), not(target_os = "macos"), not(target_family = "wasm")))'.dependencies]
 mimalloc = { workspace = true }
+
+[package.metadata.cargo-shear]
+ignored = ["tracy-client-sys"]