jemallocator/README.md

89 lines
3.6 KiB
Markdown
Raw Normal View History

2016-01-21 01:06:21 +00:00
# jemallocator
2018-05-04 16:28:20 +00:00
[![Build Status](https://travis-ci.org/alexcrichton/jemallocator.svg?branch=master)](https://travis-ci.org/alexcrichton/jemallocator) [![Build Status](https://ci.appveyor.com/api/projects/status/github/alexcrichton/jemallocator?branch=master&svg=true)](https://ci.appveyor.com/project/alexcrichton/jemallocator/branch/master)
2016-01-21 01:06:21 +00:00
[Documentation](https://docs.rs/jemallocator)
[`maser` branch documentation](http://alexcrichton.github.io/jemallocator/jemallocator/index.html)
2016-01-21 01:06:21 +00:00
A Rust allocator crate which links to [jemalloc](http://jemalloc.net/)
and provides a `Jemalloc` unit type for use with the `#[global_allocator]` attribute.
2016-01-21 01:34:31 +00:00
Usage:
```toml
# Cargo.toml
[dependencies]
jemallocator = "0.1.8"
2016-01-21 01:34:31 +00:00
```
Rust:
```rust
extern crate jemallocator;
2017-07-07 15:24:26 +00:00
#[global_allocator]
static ALLOC: jemallocator::Jemalloc = jemallocator::Jemalloc;
2016-01-21 01:34:31 +00:00
```
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.
2016-01-21 01:34:31 +00:00
2018-10-24 09:01:42 +00:00
# Platform support
The following table describes the supported platforms:
* `build`: does the library compile for the target?
* `run`: do the 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 |
|-------------------------------------|-----------|---------|
| `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** |
| `x86_64-apple-darwin` (tier 1) | ✓ | ✓ |
| `i686-apple-darwin` (tier 1) | ✓ | ✓ |
| **Windows targets:** | **build** | **run** |
| `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** |
| `aarch64-linux-android` | ✓ | ✓ |
| `x86_64-linux-android` | ✓ | ✓ |
2018-10-17 13:29:38 +00:00
# Features
2018-06-25 07:21:33 +00:00
2018-10-17 13:29:38 +00:00
The `jemallocator` crate re-exports the [features of the `jemalloc-sys`
dependency](https://github.com/alexcrichton/jemallocator/blob/master/jemalloc-sys/readme.md).
2018-06-25 07:21:33 +00:00
2016-01-21 01:06:21 +00:00
# License
2017-10-30 21:11:08 +00:00
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
2016-01-21 01:06:21 +00:00
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.