feat(foundry-cli::utils): add support for mimalloc and tracy-allocator (#10545)

- Introduced `mimalloc` as an optional allocator.
- Added `tracy-allocator` support for profiling memory allocations.
- Updated global allocator logic to conditionally use `jemalloc` (default) or `mimalloc`.
- Modified `anvil`, `cast`, `chisel` and `forge` crates to include new features.
These new features are inspired from Reth and Solar projects.

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

Author: mablr

Cargo.lock

@@ -268,6 +268,11 @@ async-trait = "0.1"
 derive_more = { version = "2.0", features = ["full"] }
 thiserror = "2"
 
+# allocators
+mimalloc = "0.1"
+tikv-jemallocator = "0.6"
+tracy-client = "0.18"
+
 # misc
 auto_impl = "1"
 aws-config = { version = "1", default-features = true }
@@ -318,7 +323,6 @@ soldeer-commands = "=0.5.4"
 soldeer-core = { version = "=0.5.4", features = ["serde"] }
 strum = "0.27"
 tempfile = "3.13"
-tikv-jemallocator = "0.6"
 tokio = "1"
 toml = "0.8"
 tower = "0.5"

Cargo.toml

@@ -117,6 +117,8 @@ op-alloy-rpc-types.workspace = true
 default = ["cli", "jemalloc"]
 asm-keccak = ["alloy-primitives/asm-keccak"]
 jemalloc = ["foundry-cli/jemalloc"]
+mimalloc = ["foundry-cli/mimalloc"]
+tracy-allocator = ["foundry-cli/tracy-allocator"]
 cli = ["tokio/full", "cmd"]
 cmd = [
     "clap",

crates/anvil/Cargo.toml

@@ -95,6 +95,8 @@ foundry-test-utils.workspace = true
 default = ["jemalloc"]
 asm-keccak = ["alloy-primitives/asm-keccak"]
 jemalloc = ["foundry-cli/jemalloc"]
+mimalloc = ["foundry-cli/mimalloc"]
+tracy-allocator = ["foundry-cli/tracy-allocator"]
 aws-kms = ["foundry-wallets/aws-kms", "dep:aws-sdk-kms"]
 gcp-kms = ["foundry-wallets/gcp-kms", "dep:gcloud-sdk"]
 isolate-by-default = ["foundry-config/isolate-by-default"]

crates/cast/Cargo.toml

@@ -64,3 +64,5 @@ tracing-subscriber.workspace = true
 default = ["jemalloc"]
 asm-keccak = ["alloy-primitives/asm-keccak"]
 jemalloc = ["foundry-cli/jemalloc"]
+mimalloc = ["foundry-cli/mimalloc"]
+tracy-allocator = ["foundry-cli/tracy-allocator"]

crates/chisel/Cargo.toml

@@ -39,6 +39,7 @@ eyre.workspace = true
 futures.workspace = true
 indicatif.workspace = true
 itertools.workspace = true
+mimalloc = { workspace = true, optional = true }
 rayon.workspace = true
 regex = { workspace = true, default-features = false }
 serde_json.workspace = true
@@ -48,6 +49,7 @@ strum = { workspace = true, features = ["derive"] }
 tokio = { workspace = true, features = ["macros"] }
 tracing-subscriber = { workspace = true, features = ["registry", "env-filter"] }
 tracing.workspace = true
+tracy-client = { workspace = true, optional = true, features = ["demangle"] }
 yansi.workspace = true
 rustls = { workspace = true, features = ["ring"] }
 
@@ -61,4 +63,6 @@ tikv-jemallocator = { workspace = true, optional = true }
 
 [features]
 tracy = ["dep:tracing-tracy"]
+tracy-allocator = ["dep:tracy-client", "tracy"]
 jemalloc = ["dep:tikv-jemallocator"]
+mimalloc = ["dep:mimalloc"]

crates/cli/Cargo.toml

@@ -1,18 +1,41 @@
 //! Abstract global allocator implementation.
 
-// If jemalloc feature is enabled on Unix systems, use jemalloc as the global allocator.
-// Otherwise, explicitly use the system allocator.
+#[cfg(feature = "mimalloc")]
+use mimalloc as _;
+#[cfg(all(feature = "jemalloc", unix))]
+use tikv_jemallocator as _;
+
+// If neither jemalloc nor mimalloc are enabled, use explicitly the system allocator.
+// By default jemalloc is enabled on Unix systems.
 cfg_if::cfg_if! {
     if #[cfg(all(feature = "jemalloc", unix))] {
         type AllocatorInner = tikv_jemallocator::Jemalloc;
+    } else if #[cfg(feature = "mimalloc")] {
+        type AllocatorInner = mimalloc::MiMalloc;
     } else {
         type AllocatorInner = std::alloc::System;
     }
 }
 
-pub type Allocator = AllocatorInner;
+// Wrap the allocator if the `tracy-allocator` feature is enabled.
+cfg_if::cfg_if! {
+    if #[cfg(feature = "tracy-allocator")] {
+        type AllocatorWrapper = tracy_client::ProfiledAllocator<AllocatorInner>;
+        tracy_client::register_demangler!();
+        const fn new_allocator_wrapper() -> AllocatorWrapper {
+            AllocatorWrapper::new(AllocatorInner {}, 100)
+        }
+    } else {
+        type AllocatorWrapper = AllocatorInner;
+        const fn new_allocator_wrapper() -> AllocatorWrapper {
+            AllocatorInner {}
+        }
+    }
+}
+
+pub type Allocator = AllocatorWrapper;
 
 /// Creates a new [allocator][Allocator].
 pub const fn new_allocator() -> Allocator {
-    AllocatorInner {}
+    new_allocator_wrapper()
 }

crates/cli/src/utils/allocator.rs

@@ -116,6 +116,8 @@ alloy-signer-local.workspace = true
 default = ["jemalloc"]
 asm-keccak = ["alloy-primitives/asm-keccak"]
 jemalloc = ["foundry-cli/jemalloc"]
+mimalloc = ["foundry-cli/mimalloc"]
+tracy-allocator = ["foundry-cli/tracy-allocator"]
 aws-kms = ["foundry-wallets/aws-kms"]
 gcp-kms = ["foundry-wallets/gcp-kms"]
 isolate-by-default = ["foundry-config/isolate-by-default"]