Do not export global allocator (#533)

* Do not export allocator

* Make sure to use jemalloc in all downstream tests

* Update readme

* Remove test jemalloc boilerplate

* One more

* Fix clippies

* One more

* Clippy

Co-authored-by: Daniel Lubarov <daniel@lubarov.com>

README.md

@@ -31,7 +31,15 @@ RUSTFLAGS=-Ctarget-cpu=native cargo run --release --example bench_recursion -- -
 
 ## Jemalloc
 
-By default, Plonky2 uses the [Jemalloc](http://jemalloc.net) memory allocator due to its superior performance. Currently, it changes the default allocator of any binary to which it is linked. You can disable this behavior by removing the corresponding lines in [`plonky2/src/lib.rs`](https://github.com/mir-protocol/plonky2/blob/main/plonky2/src/lib.rs).
+Plonky2 prefers the [Jemalloc](http://jemalloc.net) memory allocator due to its superior performance. To use it, include `jemallocator = "0.3.2"` in`Cargo.toml`and add the following lines
+to your `main.rs`:
+
+```rust
+use jemallocator::Jemalloc;
+
+#[global_allocator]
+static GLOBAL: Jemalloc = Jemalloc;
+```
 
 Jemalloc is known to cause crashes when a binary compiled for x86 is run on an Apple silicon-based Mac under [Rosetta 2](https://support.apple.com/en-us/HT211861). If you are experiencing crashes on your Apple silicon Mac, run `rustc --print target-libdir`. The output should contain `aarch64-apple-darwin`. If the output contains `x86_64-apple-darwin`, then you are running the Rust toolchain for x86; we recommend switching to the native ARM version.
 

plonky2/Cargo.toml

@@ -27,15 +27,15 @@ serde_cbor = "0.11.1"
 keccak-hash = "0.8.0"
 static_assertions = "1.1.0"
 
-[target.'cfg(not(target_env = "msvc"))'.dependencies]
-jemallocator = "0.3.2"
-
 [dev-dependencies]
 criterion = "0.3.5"
 tynm = "0.1.6"
 structopt = "0.3.26"
 num_cpus = "1.13.1"
 
+[target.'cfg(not(target_env = "msvc"))'.dev-dependencies]
+jemallocator = "0.3.2"
+
 [[bench]]
 name = "field_arithmetic"
 harness = false

plonky2/benches/allocator/mod.rs

@@ -0,0 +1,7 @@
+// Set up Jemalloc
+#[cfg(not(target_env = "msvc"))]
+use jemallocator::Jemalloc;
+
+#[cfg(not(target_env = "msvc"))]
+#[global_allocator]
+static GLOBAL: Jemalloc = Jemalloc;

plonky2/benches/ffts.rs

@@ -1,3 +1,5 @@
+mod allocator;
+
 use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
 use plonky2::field::field_types::Field;
 use plonky2::field::goldilocks_field::GoldilocksField;

plonky2/benches/field_arithmetic.rs

@@ -1,3 +1,5 @@
+mod allocator;
+
 use criterion::{criterion_group, criterion_main, BatchSize, Criterion};
 use plonky2::field::extension_field::quadratic::QuadraticExtension;
 use plonky2::field::extension_field::quartic::QuarticExtension;

plonky2/benches/hashing.rs

@@ -1,6 +1,8 @@
 #![allow(incomplete_features)]
 #![feature(generic_const_exprs)]
 
+mod allocator;
+
 use criterion::{criterion_group, criterion_main, BatchSize, Criterion};
 use plonky2::field::goldilocks_field::GoldilocksField;
 use plonky2::hash::hash_types::{BytesHash, RichField};

plonky2/benches/merkle.rs

@@ -1,5 +1,7 @@
 #![feature(generic_const_exprs)]
 
+mod allocator;
+
 use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
 use plonky2::field::goldilocks_field::GoldilocksField;
 use plonky2::hash::hash_types::RichField;

plonky2/benches/reverse_index_bits.rs

@@ -1,3 +1,5 @@
+mod allocator;
+
 use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
 use plonky2::field::field_types::Field;
 use plonky2::field::goldilocks_field::GoldilocksField;

plonky2/benches/transpose.rs

@@ -1,3 +1,5 @@
+mod allocator;
+
 use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
 use plonky2::field::field_types::Field;
 use plonky2::field::goldilocks_field::GoldilocksField;

plonky2/src/lib.rs

@@ -19,11 +19,3 @@ pub mod hash;
 pub mod iop;
 pub mod plonk;
 pub mod util;
-
-// Set up Jemalloc
-#[cfg(not(target_env = "msvc"))]
-use jemallocator::Jemalloc;
-
-#[cfg(not(target_env = "msvc"))]
-#[global_allocator]
-static GLOBAL: Jemalloc = Jemalloc;

system_zero/Cargo.toml

@@ -21,3 +21,6 @@ criterion = "0.3.5"
 [[bench]]
 name = "lookup_permuted_cols"
 harness = false
+
+[target.'cfg(not(target_env = "msvc"))'.dev-dependencies]
+jemallocator = "0.3.2"

system_zero/benches/allocator/mod.rs

@@ -0,0 +1,7 @@
+// Set up Jemalloc
+#[cfg(not(target_env = "msvc"))]
+use jemallocator::Jemalloc;
+
+#[cfg(not(target_env = "msvc"))]
+#[global_allocator]
+static GLOBAL: Jemalloc = Jemalloc;

system_zero/benches/lookup_permuted_cols.rs

@@ -1,3 +1,5 @@
+mod allocator;
+
 use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
 use itertools::Itertools;
 use plonky2::field::field_types::Field;