#memory #peak #memory-allocator #alloc #mem #instrument

peakmem-alloc

An allocator wrapper that allows measuring peak memory consumption

5 unstable releases

0.3.0 Mar 18, 2024
0.2.2 Mar 18, 2024
0.2.1 Mar 18, 2024
0.2.0 Mar 18, 2024
0.1.0 Apr 5, 2023

#254 in Memory management

Download history 19/week @ 2024-08-17 30/week @ 2024-08-24 117/week @ 2024-08-31 225/week @ 2024-09-07 72/week @ 2024-09-14 128/week @ 2024-09-21 195/week @ 2024-09-28 50/week @ 2024-10-05 454/week @ 2024-10-12 415/week @ 2024-10-19 163/week @ 2024-10-26 201/week @ 2024-11-02 58/week @ 2024-11-09 110/week @ 2024-11-16 120/week @ 2024-11-23 98/week @ 2024-11-30

397 downloads per month
Used in 2 crates (via binggan)

MIT license

8KB
120 lines

peakmem_alloc

An instrumenting middleware for global allocators in Rust, useful to find the peak memory consumed by a function.

Example

use peakmem_alloc::*;
use std::alloc::System;

#[global_allocator]
static GLOBAL: &PeakMemAlloc<System> = &INSTRUMENTED_SYSTEM;

#[test]
fn example_using_region() {
    GLOBAL.reset_peak_memory(); // Note that other threads may impact the peak memory computation.
    let _x: Vec<u8> = Vec::with_capacity(1_024);
    println!(
        "Peak Memory used by function : {:#?}", 
        GLOBAL.get_peak_memory()
    );
}

Custom allocators

You can wrap your existing allocator as follows:

use jemallocator::Jemalloc;
use peakmem_alloc::*;

#[global_allocator]
static GLOBAL: PeakMemAlloc<Jemalloc> = PeakMemAlloc::new(Jemalloc);


lib.rs:

An instrumenting allocator wrapper to compute (scoped) peak memory consumption.

Example

use peakmem_alloc::*;
use std::alloc::System;

#[global_allocator]
static GLOBAL: &PeakMemAlloc<System> = &INSTRUMENTED_SYSTEM;

fn main() {
   GLOBAL.reset_peak_memory();
   let _x: Vec<u8> = Vec::with_capacity(1_024);
   println!(
       "Peak Memory used by function : {:#?}",
       GLOBAL.get_peak_memory()
   );
}

No runtime deps