[go: up one dir, main page]

mimalloc 0.1.11

Performance and security oriented drop-in allocator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

# Mimalloc Rust

[![Build Status](https://travis-ci.org/purpleprotocol/mimalloc_rust.svg?branch=master)](https://travis-ci.org/purpleprotocol/mimalloc_rust) [![Latest Version]][crates.io] [![Documentation]][docs.rs]

A drop-in global allocator wrapper around the [mimalloc](https://github.com/microsoft/mimalloc) allocator.
Mimalloc is a general purpose, performance oriented allocator built by Microsoft.

## Usage

```rust
use mimalloc::MiMalloc;

#[global_allocator]
static GLOBAL: MiMalloc = MiMalloc;
```

## Requirements

[CMake](https://cmake.org/) and a __C__ compiler are required for building 
[mimalloc](https://github.com/microsoft/mimalloc) with cargo.

## Usage without secure mode

By default this library builds mimalloc in secure mode. This add guard pages, 
randomized allocation, encrypted free lists, etc. The performance penalty should 
only be around 3% according to [mimalloc](https://github.com/microsoft/mimalloc)
own benchmarks.

To disable secure mode, put in `Cargo.toml`:
```rust
[dependencies]
mimalloc = { version = "*", default-features = false }
```

## Usage with full secure mode
From version 1.2.0, mimalloc exposes another layer of secure features named `full-secure mode` that adds double-free mitigation. However, this might result in a bigger runtime performance hit than using only the plain secure mode.

To run mimalloc in full-secure mode, put in `Cargo.toml`:
```rust
[dependencies]
mimalloc = { version = "*", features = "secure-full" }
```

[crates.io]: https://crates.io/crates/mimalloc
[Latest Version]: https://img.shields.io/crates/v/mimalloc.svg
[Documentation]: https://docs.rs/mimalloc/badge.svg
[docs.rs]: https://docs.rs/mimalloc