mimalloc2_rust_sys/
runtime_options.rs

1use cty::{c_int, c_long};
2
3pub type mi_option_t = c_int;
4
5// stable options
6pub const mi_option_show_errors: mi_option_t = 0; // print error messages
7pub const mi_option_show_stats: mi_option_t = 1; // print statistics on termination
8pub const mi_option_verbose: mi_option_t = 2; // print verbose messages
9
10// the following options are experimental (see src/options.h)
11pub const mi_option_eager_commit: mi_option_t = 3; // eager commit segments? (after `eager_commit_delay` segments) (=1)
12pub const mi_option_arena_eager_commit: mi_option_t = 4; // eager commit arenas? Use 2 to enable just on overcommit systems (=2)
13pub const mi_option_purge_decommits: mi_option_t = 5; // should a memory purge decommit (or only reset) (=1)
14pub const mi_option_allow_large_os_pages: mi_option_t = 6; // allow large (2MiB) OS pages; implies eager commit
15pub const mi_option_reserve_huge_os_pages: mi_option_t = 7; // reserve N huge OS pages (1GiB/page) at startup
16pub const mi_option_reserve_huge_os_pages_at: mi_option_t = 8; // reserve huge OS pages at a specific NUMA node
17pub const mi_option_reserve_os_memory: mi_option_t = 9; // reserve specified amount of OS memory in an arena at startup
18pub const mi_option_deprecated_segment_cache: mi_option_t = 10;
19pub const mi_option_deprecated_page_reset: mi_option_t = 11;
20pub const mi_option_abandoned_page_purge: mi_option_t = 12; // immediately purge delayed purges on thread termination
21pub const mi_option_deprecated_segment_reset: mi_option_t = 13;
22pub const mi_option_eager_commit_delay: mi_option_t = 14;
23pub const mi_option_purge_delay: mi_option_t = 15; // memory purging is delayed by N milli seconds; use 0 for immediate purging or -1 for no purging at all.
24pub const mi_option_use_numa_nodes: mi_option_t = 16; // 0 = use all available numa nodes; otherwise use at most N nodes.
25pub const mi_option_limit_os_alloc: mi_option_t = 17; // 1 = do not use OS memory for allocation (but only programmatically reserved arenas)
26pub const mi_option_os_tag: mi_option_t = 18; // tag used for OS logging (macOS only for now)
27pub const mi_option_max_errors: mi_option_t = 19; // issue at most N error messages
28pub const mi_option_max_warnings: mi_option_t = 20; // issue at most N warning messages
29pub const mi_option_max_segment_reclaim: mi_option_t = 21;
30pub const mi_option_destroy_on_exit: mi_option_t = 22; // if set; release all memory on exit; sometimes used for dynamic unloading but can be unsafe.
31pub const mi_option_arena_reserve: mi_option_t = 23; // initial memory size in KiB for arena reservation (1GiB on 64-bit)
32pub const mi_option_arena_purge_mult: mi_option_t = 24;
33pub const mi_option_purge_extend_delay: mi_option_t = 25;
34pub const _mi_option_last: mi_option_t = 26;
35
36// legacy option names
37pub const mi_option_large_os_pages: mi_option_t = mi_option_allow_large_os_pages;
38pub const mi_option_eager_region_commit: mi_option_t = mi_option_arena_eager_commit;
39pub const mi_option_reset_decommits: mi_option_t = mi_option_purge_decommits;
40pub const mi_option_reset_delay: mi_option_t = mi_option_purge_delay;
41pub const mi_option_abandoned_page_reset: mi_option_t = mi_option_abandoned_page_purge;
42
43extern "C" {
44    pub fn mi_option_disable(option: mi_option_t);
45    pub fn mi_option_enable(option: mi_option_t);
46    pub fn mi_option_get(option: mi_option_t) -> c_long;
47    pub fn mi_option_is_enabled(option: mi_option_t) -> bool;
48    pub fn mi_option_set(option: mi_option_t, value: c_long);
49    pub fn mi_option_set_default(option: mi_option_t, value: c_long);
50    pub fn mi_option_set_enabled(option: mi_option_t);
51    pub fn mi_option_set_enabled_default(option: mi_option_t);
52}