Find a file
2019-02-10 09:43:16 +01:00
benches fix benchmarks 2018-11-16 10:45:22 +01:00
ci Add jemallocator-global crate 2019-01-15 16:12:53 +01:00
jemalloc-sys Fix typo in jemalloc-sys docs 2019-02-10 09:43:16 +01:00
jemallocator-global Add jemallocator-global crate 2019-01-15 16:12:53 +01:00
src Derive Copy, Clone, Default, Debug 2019-01-28 15:39:42 +01:00
systest bump ctest version 2018-10-31 13:16:57 +01:00
tests Fix shrink_in_place implementation 2018-11-09 20:05:36 +01:00
.appveyor.yml move init submodules to right after the clone phase 2018-11-18 12:29:02 +01:00
.gitignore Initial commit 2016-01-20 17:03:24 -08:00
.gitmodules update jemalloc5.1RC1 to jemalloc5.1 2018-05-16 19:16:50 +02:00
.travis.yml Try to fix docs build 2019-01-03 07:29:12 -08:00
Cargo.toml Add jemallocator-global crate 2019-01-15 16:12:53 +01:00
Cross.toml try harder to disable cargo's progress bar 2018-11-04 19:06:37 +01:00
LICENSE-APACHE Fill out some more project metadata 2016-01-20 17:06:21 -08:00
LICENSE-MIT Fill out some more project metadata 2016-01-20 17:06:21 -08:00
README.md Update travis config 2019-01-02 13:52:03 -08:00

jemallocator

Travis-CI Status Appveyor Status Latest Version docs

Links against jemalloc and provides a Jemalloc unit type that implements the allocator APIs and can be set as the #[global_allocator]

Documentation

To use jemallocator add it as a dependency:

# Cargo.toml
[dependencies]
jemallocator = "0.1.8"

To set jemallocator::Jemalloc as the global allocator add this to your project:

extern crate jemallocator;

#[global_allocator]
static ALLOC: jemallocator::Jemalloc = jemallocator::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 jemallocator and jemalloc-sys tests pass on the target?
  • jemalloc: do jemalloc's tests pass on the target?
  • valgrind: do the tests pass under valgrind?

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 valgrind
aarch64-unknown-linux-gnu
arm-unknown-linux-gnueabi
armv7-unknown-linux-gnueabi
i586-unknown-linux-gnu
i686-unknown-linux-gnu (tier 1)
mips-unknown-linux-gnu
mipsel-unknown-linux-musl
mips64-unknown-linux-gnuabi64
mips64el-unknown-linux-gnuabi64
powerpc-unknown-linux-gnu
powerpc64-unknown-linux-gnu
powerpc64le-unknown-linux-gnu
x86_64-unknown-linux-gnu (tier 1)
MacOSX targets: build run jemalloc valgrind
x86_64-apple-darwin (tier 1)
i686-apple-darwin (tier 1)
Windows targets: build run jemalloc valgrind
x86_64-pc-windows-msvc (tier 1)
i686-pc-windows-msvc (tier 1)
x86_64-pc-windows-gnu (tier 1)
i686-pc-windows-gnu (tier 1)
Android targets: build run jemalloc valgrind
aarch64-linux-android
x86_64-linux-android

Features

The jemallocator crate re-exports the features of the jemalloc-sys dependency.

License

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in jemallocator by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.