Merge pull request #146 from clux/allocator-hints

Add hints about changing allocators

README.md

@@ -123,6 +123,19 @@ CircleCI supports both methods:
 - [Circle: direct folder cache (manual docker build)](https://github.com/clux/webapp-rs/blob/master/.circleci/config.yml)
 - Circle also supports [docker layer caching](https://circleci.com/docs/2.0/docker-layer-caching/) (no example atm)
 
+## Allocator Performance
+
+To optimise memory performance (see [#142](https://github.com/clux/muslrust/issues/142)) consider changing the global allocators in sensitive applications:
+
+- [jemalloc](https://github.com/tikv/jemallocator)
+- [mimalloc](https://github.com/microsoft/mimalloc)
+
+```rust
+use tikv_jemallocator::Jemalloc;
+#[global_allocator]
+static GLOBAL: Jemalloc = Jemalloc;
+```
+
 ## Troubleshooting
 
 ### SSL Verification

test/serdecrate/Cargo.toml

@@ -2,8 +2,10 @@
 authors = ["clux <[email protected]>"]
 name = "serdecrate"
 version = "0.1.0"
+edition = "2021"
 
 [dependencies]
 serde = "1.0.15"
 serde_derive = "1.0.15"
 serde_json = "1.0.4"
+tikv-jemallocator = "0.5.4"

test/serdecrate/src/main.rs

@@ -1,8 +1,9 @@
-#[macro_use]
-extern crate serde_derive;
+use serde_derive::{Deserialize, Serialize};
+use serde_json;
 
-extern crate serde;
-extern crate serde_json;
+use tikv_jemallocator::Jemalloc;
+#[global_allocator]
+static GLOBAL: Jemalloc = Jemalloc;
 
 #[derive(Serialize, Deserialize, Debug)]
 struct Point {