File tree Expand file tree Collapse file tree 2 files changed +17
-4
lines changed Expand file tree Collapse file tree 2 files changed +17
-4
lines changed Original file line number Diff line number Diff line change 1
1
[package ]
2
2
name = " mimalloc"
3
3
version = " 0.1.2"
4
- authors = [" Octavian Oncescu <octavonce@gmail.com>" ]
4
+ authors = [
5
+ " Octavian Oncescu <octavonce@gmail.com>" ,
6
+ " Vincent Rouillé <vincent@speedy37.fr>" ,
7
+ ]
5
8
edition = " 2018"
6
9
repository = " https://github.com/purpleprotocol/mimalloc_rust"
7
10
keywords = [" mimalloc" , " allocator" , " encrypted-heap" , " performance" ]
Original file line number Diff line number Diff line change 1
1
# Mimalloc Rust
2
+
2
3
[ ![ 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 ]
3
4
4
5
A drop-in global allocator wrapper around the [ mimalloc] ( https://github.com/microsoft/mimalloc ) allocator.
5
6
Mimalloc is a general purpose, performance oriented allocator built by Microsoft.
6
7
7
8
## Usage
9
+
8
10
``` rust
9
11
use mimalloc :: MiMalloc ;
10
12
11
13
#[global_allocator]
12
14
static GLOBAL : MiMalloc = MiMalloc ;
13
15
```
14
16
17
+ ## Requirements
18
+
19
+ [ CMake] ( https://cmake.org/ ) and a __ C__ compiler are required for building
20
+ [ mimalloc] ( https://github.com/microsoft/mimalloc ) with cargo.
21
+
15
22
## Usage without secure mode
16
- By default this library builds mimalloc in secure mode. This means that
17
- heap allocations are encrypted, but this results in a 3% increase in overhead.
23
+
24
+ By default this library builds mimalloc in secure mode. This add guard pages,
25
+ randomized allocation, encrypted free lists, etc. The performance penalty should
26
+ only be around 3% according to [ mimalloc] ( https://github.com/microsoft/mimalloc )
27
+ own benchmarks.
18
28
19
29
To disable secure mode, in ` Cargo.toml ` :
20
30
``` rust
@@ -25,4 +35,4 @@ mimalloc = { version = "*", default-features = false }
25
35
[ crates.io ] : https://crates.io/crates/mimalloc
26
36
[ Latest Version ] : https://img.shields.io/crates/v/mimalloc.svg
27
37
[ Documentation ] : https://docs.rs/mimalloc/badge.svg
28
- [ docs.rs ] : https://docs.rs/mimalloc
38
+ [ docs.rs ] : https://docs.rs/mimalloc
You can’t perform that action at this time.
0 commit comments