#allocator #jemalloc #control-api #api-bindings

no-std tikv-jemalloc-ctl

A safe wrapper over jemalloc's control and introspection APIs

5 releases

0.5.4 Jul 27, 2023
0.5.0 May 24, 2022
0.4.2 Aug 9, 2021
0.4.1 Nov 17, 2020
0.4.0 Jul 21, 2020

#177 in Memory management

Download history 90201/week @ 2024-03-14 98167/week @ 2024-03-21 107429/week @ 2024-03-28 112583/week @ 2024-04-04 118307/week @ 2024-04-11 119773/week @ 2024-04-18 113103/week @ 2024-04-25 117009/week @ 2024-05-02 117850/week @ 2024-05-09 124402/week @ 2024-05-16 142695/week @ 2024-05-23 154761/week @ 2024-05-30 140560/week @ 2024-06-06 141920/week @ 2024-06-13 138715/week @ 2024-06-20 134889/week @ 2024-06-27

590,974 downloads per month
Used in 82 crates (18 directly)

MIT/Apache

2MB
52K SLoC

C 47K SLoC // 0.1% comments Rust 1.5K SLoC // 0.1% comments Visual Studio Project 1.5K SLoC M4 657 SLoC // 0.1% comments Shell 380 SLoC // 0.3% comments C++ 371 SLoC // 0.1% comments Python 261 SLoC // 0.3% comments Visual Studio Solution 125 SLoC XSL 9 SLoC

jemalloc-ctl

Travis-CI Status Latest Version docs

A safe wrapper over jemalloc's mallctl*() control and introspection APIs.

Documentation

Platform support

Supported on all platforms supported by the tikv-jemallocator crate.

Example


use std::thread;
use std::time::Duration;
use tikv_jemalloc_ctl::{stats, epoch};

#[global_allocator]
static ALLOC: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc;

fn main() {
    // Obtain a MIB for the `epoch`, `stats.allocated`, and
    // `atats.resident` keys:
    let e = epoch::mib().unwrap();
    let allocated = stats::allocated::mib().unwrap();
    let resident = stats::resident::mib().unwrap();
    
    loop {
        // Many statistics are cached and only updated 
        // when the epoch is advanced:
        e.advance().unwrap();
        
        // Read statistics using MIB key:
        let allocated = allocated.read().unwrap();
        let resident = resident.read().unwrap();
        println!("{} bytes allocated/{} bytes resident", allocated, resident);
        thread::sleep(Duration::from_secs(10));
    }
}

License

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in jemalloc-ctl by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies