polkadot_jemalloc_shim/lib.rs
1// Copyright (C) Parity Technologies (UK) Ltd.
2// This file is part of Polkadot.
3
4// Polkadot is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8
9// Polkadot is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13
14// You should have received a copy of the GNU General Public License
15// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
16
17//! Shim crate to enable `jemalloc-allocator` feature for Polkadot crates.
18//!
19//! Because [there doesn't exist any easier way right now](https://github.com/rust-lang/cargo/issues/1197), we
20//! need an entire crate to handle `jemalloc` enabling/disabling. This way we can enable it by
21//! default on Linux, but have it optional on all other OSes.
22
23/// Sets the global allocator to `jemalloc` when the feature is enabled.
24#[cfg(feature = "jemalloc-allocator")]
25#[global_allocator]
26static ALLOC: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc;