| memstat_get_name | Return a pointer to the name of the memory type. Memory for the name is owned by libmemstat and will be valid through a call to memstat_mtl_free. Note that names will be unique with respect to a single allocator, but that the same name might be used by different memory types owned by different memory allocators. |
| memstat_get_allocator |
| | Return an integer identifier for the memory allocator that owns the memory type. |
| memstat_get_countlimit |
| | If the memory type has an administrative limit on the number of simultaneous allocations, return it. |
| memstat_get_byteslimit |
| | If the memory type has an administrative limit on the number of bytes of memory that may be simultaenously allocated for the memory type, return it. |
| memstat_get_sizemask |
| | If the memory type supports variable allocation sizes, return a bitmask of sizes allocated for the memory type. |
| memstat_get_size | If the memory type supports a fixed allocation size, return that size. |
| memstat_get_memalloced |
| | Return the total number of bytes allocated for the memory type over its lifetime. |
| memstat_get_memfreed |
| | Return the total number of bytes freed for the memory type over its lifetime. |
| memstat_get_numallocs |
| | Return the total number of allocations for the memory type over its lifetime. |
| memstat_get_numfrees |
| | Return the total number of frees for the memory type over its lifetime. |
| memstat_get_bytes |
| | Return the current number of bytes allocated to the memory type. |
| memstat_get_count |
| | Return the current number of allocations for the memory type. |
| memstat_get_free | If the memory allocator supports a cache, return the number of items in the cache. |
| memstat_get_failures |
| | If the memory allocator and type permit allocation failures, return the number of allocation failures measured. |
| memstat_get_caller_pointer |
| | Return a caller-owned pointer for the memory type. |
| memstat_set_caller_pointer |
| | Set a caller-owned pointer for the memory type. |
| memstat_get_caller_uint64 |
| | Return a caller-owned integer for the memory type. |
| memstat_set_caller_uint64 |
| | Set a caller-owned integer for the memory type. |
| memstat_get_zonefree |
| | If the memory allocator supports a multi-level allocation structure, return the number of cached items in the zone. These items will be in a fully constructed state available for immediate use. |
| memstat_get_kegfree |
| | If the memory allocator supports a multi-level allocation structure, return the number of cached items in the keg. These items may be in a partially constructed state, and may require further processing before they can be made available for use. |
| memstat_get_percpu_memalloced |
| | If the memory allocator supports per-CPU statistics, return the number of bytes of memory allocated for the memory type on the CPU over its lifetime. |
| memstat_get_percpu_memfreed |
| | If the memory allocator supports per-CPU statistics, return the number of bytes of memory freed from the memory type on the CPU over its lifetime. |
| memstat_get_percpu_numallocs |
| | If the memory allocator supports per-CPU statistics, return the number of allocations for the memory type on the CPU over its lifetime. |
| memstat_get_percpu_numfrees |
| | If the memory allocator supports per-CPU statistics, return the number of frees for the memory type on the CPU over its lifetime. |
| memstat_get_percpu_sizemask |
| | If the memory allocator supports variable size memory allocation and per-CPU statistics, return the size bitmask for the memory type on the CPU. |
| memstat_get_percpu_caller_pointer |
| | Return a caller-owned per-CPU pointer for the memory type. |
| memstat_set_percpu_caller_pointer |
| | Set a caller-owned per-CPU pointer for the memory type. |
| memstat_get_percpu_caller_uint64 |
| | Return a caller-owned per-CPU integer for the memory type. |
| memsttat_set_percpu_caller_uint64 |
| | Set a caller-owned per-CPU integer for the memory type. |
| memstat_get_percpu_free |
| | If the memory allocator supports a per-CPU cache, return the number of free items in the per-CPU cache of the designated CPU. |
|
RETURN VALUES
libmemstat functions fall into three categories: functions returning a pointer to an object, functions returning an integer return value, and functions implementing accessor methods returning data from a
.Vt struct memory_type . Functions returning a pointer to an object will generally return NULL on failure. memstat_mtl_alloc will return an error value via errno, which will consist of the value ENOMEM. Functions memstat_mtl_first, memstat_mtl_next, and memstat_mtl_find will return NULL when there is no entry or match in the list; however, this is not considered a failure mode and no error value is available.
Functions returning a integer success valuye will return 0 on success, or -1 on failure. If a failure is returned, the list error access method, memstat_mtl_geterror, may be used to retrieve the error state. The string representation of the error may be retrieved using memstat_strerror. Possible error values are:
