diff options
| author | Daan <daanl@outlook.com> | 2022-02-02 19:19:03 -0800 |
|---|---|---|
| committer | Daan <daanl@outlook.com> | 2022-02-02 19:19:03 -0800 |
| commit | f515b80093cfd5893070169a439d77616a48f8d8 (patch) | |
| tree | 3ee8d25c81b7668b2d1cb53cd69dd78e99adaf17 /include/mimalloc.h | |
| parent | 6ff2312ab5fce89b93b1b85d3b3ffb8c60794c7a (diff) | |
update documentation on options
Diffstat (limited to 'include/mimalloc.h')
| -rw-r--r-- | include/mimalloc.h | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/include/mimalloc.h b/include/mimalloc.h index 6f95075..0b84f6c 100644 --- a/include/mimalloc.h +++ b/include/mimalloc.h @@ -296,30 +296,30 @@ mi_decl_export int mi_reserve_huge_os_pages(size_t pages, double max_secs, size // ------------------------------------------------------ -// Options, all `false` by default +// Options // ------------------------------------------------------ typedef enum mi_option_e { // stable options - mi_option_show_errors, - mi_option_show_stats, - mi_option_verbose, - // the following options are experimental - mi_option_eager_commit, - mi_option_eager_region_commit, + mi_option_show_errors, // print error messages + mi_option_show_stats, // print statistics on termination + mi_option_verbose, // print verbose messages + // the following options are experimental (see src/options.h) + mi_option_eager_commit, + mi_option_eager_region_commit, mi_option_reset_decommits, - mi_option_large_os_pages, // implies eager commit - mi_option_reserve_huge_os_pages, - mi_option_reserve_huge_os_pages_at, - mi_option_reserve_os_memory, - mi_option_segment_cache, - mi_option_page_reset, - mi_option_abandoned_page_reset, + mi_option_large_os_pages, // use large (2MiB) OS pages, implies eager commit + mi_option_reserve_huge_os_pages, // reserve N huge OS pages (1GiB) at startup + mi_option_reserve_huge_os_pages_at, // reserve huge OS pages at a specific NUMA node + mi_option_reserve_os_memory, // reserve specified amount of OS memory at startup + mi_option_segment_cache, + mi_option_page_reset, + mi_option_abandoned_page_reset, mi_option_segment_reset, mi_option_eager_commit_delay, mi_option_reset_delay, - mi_option_use_numa_nodes, - mi_option_limit_os_alloc, + mi_option_use_numa_nodes, // 0 = use available numa nodes, otherwise use at most N nodes. + mi_option_limit_os_alloc, // 1 = do not use OS memory for allocation (but only reserved arenas) mi_option_os_tag, mi_option_max_errors, mi_option_max_warnings, |