|Slabs of the zone are never returned back to VM.|
|Each item in the zone would have internal reference counter associated with it. See uma_find_refcnt.|
|Pages belonging to the zone will not be included into mini-dumps.|
An allocation from zone would have
shadow copies, that are privately assigned to CPUs.
A CPU can address its private copy using base allocation address plus
multiple of current CPU id and
sizeof struct pcpu:
foo_zone = uma_zcreate(..., UMA_ZONE_PCPU); ... foo_base = uma_zalloc(foo_zone, ...); ... critical_enter(); foo_pcpu = (foo_t *)zpcpu_get(foo_base); /* do something with foo_pcpu */ critical_exit();
|By default book-keeping of items within a slab is done in the slab page itself. This flag explicitly tells subsystem that book-keeping structure should be allocated separately from special internal zone. This flag requires either UMA_ZONE_VTOSLAB or UMA_ZONE_HASH, since subsystem requires a mechanism to find a book-keeping structure to an item beeing freed. The subsystem may choose to prefer offpage book-keeping for certain zones implicitly.|
|The zone will have its uma_init method set to internal method that initializes a new allocated slab to all zeros. Do not mistake uma_init method with uma_ctor. A zone with UMA_ZONE_ZINIT flag would not return zeroed memory on every uma_zalloc.|
|The zone should use an internal hash table to find slab book-keeping structure where an allocation being freed belongs to.|
The zone should use special field of
.Vt vm_page_t to find slab book-keeping structure where an allocation being freed belongs to.
|The zone is for the malloc(9) subsystem.|
|The zone is for the VM subsystem.|
To allocate an item from a zone, simply call uma_zalloc with a pointer to that zone and set the flags argument to selected flags as documented in malloc(9). It will return a pointer to an item if successful, or NULL in the rare case where all items in the zone are in use and the allocator is unable to grow the zone and M_NOWAIT is specified.
Items are released back to the zone from which they were allocated by calling uma_zfree with a pointer to the zone and a pointer to the item. If item is NULL, then uma_zfree does nothing.
The variations uma_zalloc_arg and uma_zfree_arg allow to specify an argument for the ctor and dtor functions, respectively.
If zone was created with UMA_ZONE_REFCNT flag, then pointer to reference counter for an item can be retrieved with help of the uma_find_refcnt function.
Created zones, which are empty, can be destroyed using uma_zdestroy, freeing all memory that was allocated for the zone. All items allocated from the zone with uma_zalloc must have been freed with uma_zfree before.
The uma_zone_set_max function limits the number of items (and therefore memory) that can be allocated to zone. The nitems argument specifies the requested upper limit number of items. The effective limit is returned to the caller, as it may end up being higher than requested due to the implementation rounding up to ensure all memory pages allocated to the zone are utilised to capacity. The limit applies to the total number of items in the zone, which includes allocated items, free items and free items in the per-cpu caches. On systems with more than one CPU it may not be possible to allocate the specified number of items even when there is no shortage of memory, because all of the remaining free items may be in the caches of the other CPUs when the limit is hit.
The uma_zone_get_max function returns the effective upper limit number of items for a zone.
The uma_zone_get_cur function returns the approximate current occupancy of the zone. The returned value is approximate because appropriate synchronisation to determine an exact value is not performed by the implementation. This ensures low overhead at the expense of potentially stale data being used in the calculation.
The uma_zone_set_warning function sets a warning that will be printed on the system console when the given zone becomes full and fails to allocate an item. The warning will be printed not often than every five minutes. Warnings can be turned off globally by setting the vm.zone_warnings sysctl tunable to 0.
SYSCTL_UMA_MAX parent nbr name access zone descr
macro declares a static
oid that exports the effective upper limit number of items for a zone.
argument should be a pointer to
.Vt uma_zone_t . A read of the oid returns value obtained through uma_zone_get_max. A write to the oid sets new value via uma_zone_set_max. The SYSCTL_ADD_UMA_MAX ctx parent nbr name access zone descr macro is provided to create this type of oid dynamically.
SYSCTL_UMA_CUR parent nbr name access zone descr
macro declares a static read only
oid that exports the approximate current occupancy of the zone.
argument should be a pointer to
.Vt uma_zone_t . A read of the oid returns value obtained through uma_zone_get_cur. The SYSCTL_ADD_UMA_CUR ctx parent nbr name zone descr macro is provided to create this type of oid dynamically.
The uma_zalloc function returns a pointer to an item, or NULL if the zone ran out of unused items and M_NOWAIT was specified.
The zone allocator first appeared in
.Fx 3.0 . It was radically changed in
.Fx 5.0 to function as a slab allocator.
.An -nosplit The zone allocator was written by
.An John S. Dyson . The zone allocator was rewritten in large parts by
.An Jeff Roberson Aq jeff@FreeBSD.org to function as a slab allocator.