summaryrefslogtreecommitdiffstats
path: root/share/man/man9/zone.9
diff options
context:
space:
mode:
authorasmodai <asmodai@FreeBSD.org>2002-04-30 12:45:31 +0000
committerasmodai <asmodai@FreeBSD.org>2002-04-30 12:45:31 +0000
commit4d8fcc6041d6a14af689b04bbcb414363c63a77f (patch)
treefd4ce974c5be8670684223b372ad419f22ea1b4d /share/man/man9/zone.9
parent32b14628815cabf630326edd07f808f075c220a9 (diff)
downloadFreeBSD-src-4d8fcc6041d6a14af689b04bbcb414363c63a77f.zip
FreeBSD-src-4d8fcc6041d6a14af689b04bbcb414363c63a77f.tar.gz
Prefix the remaining functions with uma_ as is now the case in UMA.
Diffstat (limited to 'share/man/man9/zone.9')
-rw-r--r--share/man/man9/zone.924
1 files changed, 12 insertions, 12 deletions
diff --git a/share/man/man9/zone.9 b/share/man/man9/zone.9
index 73f79b1..e31c900 100644
--- a/share/man/man9/zone.9
+++ b/share/man/man9/zone.9
@@ -29,20 +29,20 @@
.Dt ZONE 9
.Os
.Sh NAME
-.Nm zalloc ,
-.Nm zfree ,
-.Nm zdestroy
+.Nm uma_zalloc ,
+.Nm uma_zfree ,
+.Nm uma_zdestroy
.Nd zone allocator
.Sh SYNOPSIS
.In sys/param.h
.In sys/queue.h
.In vm/uma.h
.Ft void *
-.Fn zalloc "vm_zone_t z"
+.Fn uma_zalloc "vm_zone_t z"
.Ft void
-.Fn zfree "vm_zone_t z" "void *item"
+.Fn uma_zfree "vm_zone_t z" "void *item"
.Ft void
-.Fn zdestroy "vm_zone_t z"
+.Fn uma_zdestroy "vm_zone_t z"
.Sh DESCRIPTION
The zone allocator provides an efficient interface for managing
dynamically-sized collections of items of similar size.
@@ -78,7 +78,7 @@ will retain the contents as of the last free, with the exception of the
fields mentioned above.
.Pp
To allocate an item from a zone, simply call
-.Fn zalloc
+.Fn uma_zalloc
with a pointer to that zone; it will return a pointer to an item, or
.Dv NULL
in the rare case where all items in the zone are in use and the
@@ -86,18 +86,18 @@ allocator is unable to grow the zone.
.Pp
Items are released back to the zone from which they were allocated by
calling
-.Fn zfree
+.Fn uma_zfree
with a pointer to the zone and a pointer to the item.
.Pp
Zones created with
.Fn zinit
can be destroyed using
-.Fn zdestroy ,
+.Fn uma_zdestroy ,
freeing all memory that was allocated for the zone.
All items allocated from the zone with
-.Fn zalloc
+.Fn uma_zalloc
must have been freed with
-.Fn zfree
+.Fn uma_zfree
before.
.Sh RETURN VALUES
.Pp
@@ -113,7 +113,7 @@ a
.Vt "struct vm_zone" .
.Pp
The
-.Fn zalloc
+.Fn uma_zalloc
function returns a pointer to an item, or
.Dv NULL
if the zone ran out of unused items and the allocator was unable to
OpenPOWER on IntegriCloud