Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tikv/jemallocator
Rust allocator using jemalloc as a backend
https://github.com/tikv/jemallocator
Last synced: about 1 month ago
JSON representation
Rust allocator using jemalloc as a backend
- Host: GitHub
- URL: https://github.com/tikv/jemallocator
- Owner: tikv
- License: other
- Fork: true (gnzlbg/jemallocator)
- Created: 2020-07-17T13:17:28.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-11T11:39:21.000Z (3 months ago)
- Last Synced: 2025-01-11T20:46:00.238Z (about 1 month ago)
- Language: Rust
- Size: 2.61 MB
- Stars: 381
- Watchers: 10
- Forks: 67
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-rust-list - tikv/jemallocator
- awesome-rust-list - tikv/jemallocator
README
# tikv-jemallocator
[![ci]][github actions] [![Latest Version]][crates.io] [![docs]][docs.rs]
This project is the successor of [jemallocator](https://github.com/gnzlbg/jemallocator).
The project is also published as `jemallocator` for historical reasons. The two crates are the same except names. For new projects, it's recommended to use `tikv-xxx` versions instead.
> Links against `jemalloc` and provides a `Jemalloc` unit type that implements
> the allocator APIs and can be set as the `#[global_allocator]`
## Overview
The `jemalloc` support ecosystem consists of the following crates:
* `tikv-jemalloc-sys`: builds and links against `jemalloc` exposing raw C bindings to it.
* `tikv-jemallocator`: provides the `Jemalloc` type which implements the
`GlobalAlloc` and `Alloc` traits.
* `tikv-jemalloc-ctl`: high-level wrapper over `jemalloc`'s control and introspection
APIs (the `mallctl*()` family of functions and the _MALLCTL NAMESPACE_)'
## Documentation
* [Latest release (docs.rs)][docs.rs]
To use `tikv-jemallocator` add it as a dependency:
```toml
# Cargo.toml
[dependencies]
[target.'cfg(not(target_env = "msvc"))'.dependencies]
tikv-jemallocator = "0.6"
```
To set `tikv_jemallocator::Jemalloc` as the global allocator add this to your project:
```rust
// main.rs
#[cfg(not(target_env = "msvc"))]
use tikv_jemallocator::Jemalloc;
#[cfg(not(target_env = "msvc"))]
#[global_allocator]
static GLOBAL: Jemalloc = Jemalloc;
```
And that's it! Once you've defined this `static` then jemalloc will be used for
all allocations requested by Rust code in the same program.
## Platform support
The following table describes the supported platforms:
* `build`: does the library compile for the target?
* `run`: do `tikv-jemallocator` and `tikv-jemalloc-sys` tests pass on the target?
* `jemalloc`: do `tikv-jemalloc`'s tests pass on the target?
Tier 1 targets are tested on all Rust channels (stable, beta, and nightly). All
other targets are only tested on Rust nightly.
| Linux targets: | build | run | jemalloc |
|-------------------------------------|-----------|---------|--------------|
| `aarch64-unknown-linux-gnu` | ✓ | ✓ | ✗ |
| `powerpc64le-unknown-linux-gnu` | ✓ | ✓ | ✗ |
| `x86_64-unknown-linux-gnu` (tier 1) | ✓ | ✓ | ✓ |
| **MacOSX targets:** | **build** | **run** | **jemalloc** |
| `aarch64-apple-darwin` | ✓ | ✓ | ✗ |
## Features
This crate provides following cargo feature flags:
* `alloc_trait` When the `alloc_trait` feature of this crate is enabled, it also implements the `Alloc` trait, allowing usage in collections.
* `default` feature is `background_threads_runtime_support`.
* The `tikv-jemallocator` crate re-exports the [features of the `tikv-jemalloc-sys`
dependency](https://github.com/tikv/jemallocator/blob/master/jemalloc-sys/README.md#features).
## License
This project is licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in `tikv-jemallocator` by you, as defined in the Apache-2.0 license,
shall be dual licensed as above, without any additional terms or conditions.
[Latest Version]: https://img.shields.io/crates/v/tikv-jemallocator.svg
[crates.io]: https://crates.io/crates/tikv-jemallocator
[docs]: https://docs.rs/tikv-jemallocator/badge.svg
[docs.rs]: https://docs.rs/tikv-jemallocator/
[ci]: https://github.com/tikv/jemallocator/actions/workflows/main.yml/badge.svg
[github actions]: https://github.com/tikv/jemallocator/actions