Struct tikv_jemalloc_ctl::stats::retained

pub struct retained;

Total number of bytes in virtual memory mappings that were retained rather than being returned to the operating system via e.g. munmap(2).

Retained virtual memory is typically untouched, decommitted, or purged, so it has no strongly associated physical memory. Retained memory is excluded from mapped memory statistics, e.g. mapped.

This statistic is cached, and is only refreshed when the epoch is advanced. See the [::epoch] type for more information.

This corresponds to stats.retained in jemalloc’s API.

Examples

use tikv_jemalloc_ctl::{epoch, stats};
let e = epoch::mib().unwrap();
let retained = stats::retained::mib().unwrap();

e.advance().unwrap();
let size = retained.read().unwrap();
println!("{} bytes of total retained data", size);

Implementations

impl retained

pub fn mib() -> Result<retained_mib>

Returns Management Information Base (MIB)

This value can be used to access the key without doing string lookup.

pub fn name() -> &'static Name

Key [::keys::Name].

impl retained

pub fn read() -> Result<size_t>

Reads value using string API.