tcmalloc-better 0.1.19

A Rust wrapper over Google's TCMalloc memory allocator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

use crate::TCMalloc;
use libtcmalloc_sys::{NeedsProcessBackgroundActions, ProcessBackgroundActions};
#[cfg(feature = "std")]
use std::thread;

#[cfg(feature = "std")]
extern crate std;

#[cfg(feature = "extension")]
#[cfg_attr(docsrs, doc(cfg(feature = "extension")))]
impl TCMalloc {
    /// Return true if `process_background_actions` should be called on this platform.
    #[inline]
    pub fn needs_process_background_actions() -> bool {
        unsafe { NeedsProcessBackgroundActions() }
    }

    /// Runs housekeeping actions for the allocator off of the main allocation path.
    ///
    /// Should be run in the background thread. May return or may not return.
    /// Use `process_background_actions_thread()` if possible.
    #[inline]
    pub fn process_background_actions() {
        unsafe { ProcessBackgroundActions() };
    }

    /// Runs housekeeping actions for the allocator in the background thread.
    #[cfg(feature = "std")]
    #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
    pub fn process_background_actions_thread() -> Option<thread::JoinHandle<()>> {
        if Self::needs_process_background_actions() {
            Some(thread::spawn(|| {
                Self::process_background_actions();
            }))
        } else {
            None
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    #[cfg(target_os = "linux")]
    fn test_needs_process_background_actions() {
        assert!(!TCMalloc::needs_process_background_actions());
    }

    #[test]
    #[cfg(feature = "std")]
    fn test_process_background_actions() {
        TCMalloc::process_background_actions_thread();
    }
}