4deab888c9
## Proposed Changes Another `tree-states` motivated PR, this adds `jemalloc` as the default allocator, with an option to use the system allocator by compiling with `FEATURES="" make`. - [x] Metrics - [x] Test on Windows - [x] Test on macOS - [x] Test with `musl` - [x] Metrics dashboard on `lighthouse-metrics` (https://github.com/sigp/lighthouse-metrics/pull/37) Co-authored-by: Michael Sproul <micsproul@gmail.com>
72 lines
2.1 KiB
Rust
72 lines
2.1 KiB
Rust
//! Provides utilities for configuring the system allocator.
|
|
//!
|
|
//! ## Conditional Compilation
|
|
//!
|
|
//! This crate can be compiled with different feature flags to support different allocators:
|
|
//!
|
|
//! - Jemalloc, via the `jemalloc` feature.
|
|
//! - GNU malloc, if no features are set and the system supports it.
|
|
//! - The system allocator, if no features are set and the allocator is not GNU malloc.
|
|
//!
|
|
//! It is assumed that if Jemalloc is not in use, and the following two statements are correct then
|
|
//! we should expect to configure `glibc`:
|
|
//!
|
|
//! - `target_os = linux`
|
|
//! - `target_env != musl`
|
|
//!
|
|
//! If the above conditions are fulfilled but `glibc` still isn't present at runtime then a panic
|
|
//! may be triggered. It is understood that there's no way to be certain that a compatible `glibc`
|
|
//! is present: https://github.com/rust-lang/rust/issues/33244.
|
|
//!
|
|
//! ## Notes
|
|
//!
|
|
//! It's not clear how to precisely determine what the underlying allocator is. The efforts at
|
|
//! detecting `glibc` are best-effort. If this crate throws errors about undefined external
|
|
//! functions, then try to compile with the `not_glibc_interface` module.
|
|
|
|
#[cfg(all(
|
|
target_os = "linux",
|
|
not(target_env = "musl"),
|
|
not(feature = "jemalloc")
|
|
))]
|
|
mod glibc;
|
|
|
|
#[cfg(feature = "jemalloc")]
|
|
mod jemalloc;
|
|
|
|
pub use interface::*;
|
|
|
|
#[cfg(all(
|
|
target_os = "linux",
|
|
not(target_env = "musl"),
|
|
not(feature = "jemalloc")
|
|
))]
|
|
mod interface {
|
|
pub use crate::glibc::configure_glibc_malloc as configure_memory_allocator;
|
|
pub use crate::glibc::scrape_mallinfo_metrics as scrape_allocator_metrics;
|
|
}
|
|
|
|
#[cfg(feature = "jemalloc")]
|
|
mod interface {
|
|
#[allow(dead_code)]
|
|
pub fn configure_memory_allocator() -> Result<(), String> {
|
|
Ok(())
|
|
}
|
|
|
|
pub use crate::jemalloc::scrape_jemalloc_metrics as scrape_allocator_metrics;
|
|
}
|
|
|
|
#[cfg(all(
|
|
any(not(target_os = "linux"), target_env = "musl"),
|
|
not(feature = "jemalloc")
|
|
))]
|
|
mod interface {
|
|
#[allow(dead_code, clippy::unnecessary_wraps)]
|
|
pub fn configure_memory_allocator() -> Result<(), String> {
|
|
Ok(())
|
|
}
|
|
|
|
#[allow(dead_code)]
|
|
pub fn scrape_allocator_metrics() {}
|
|
}
|