summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Gwynne <dlg@cvs.openbsd.org>2008-10-27 08:56:50 +0000
committerDavid Gwynne <dlg@cvs.openbsd.org>2008-10-27 08:56:50 +0000
commit54cecdf664fd4dc656e998389867fab17f3f600b (patch)
treefccf9e24176e1cbede6d0f808cb466e5c5f5edfd
parent25a2ec364da005d0ce23ee943784698c05ac6cd7 (diff)
document pool_setipl.
with help from jmc@, thank you.
-rw-r--r--share/man/man9/Makefile4
-rw-r--r--share/man/man9/pool.924
2 files changed, 24 insertions, 4 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 6358bc00f94..f982f39cdef 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.144 2008/09/02 21:42:05 chl Exp $
+# $OpenBSD: Makefile,v 1.145 2008/10/27 08:56:49 dlg Exp $
# $NetBSD: Makefile,v 1.4 1996/01/09 03:23:01 thorpej Exp $
# Makefile for section 9 (kernel function and variable) manual pages.
@@ -237,7 +237,7 @@ MLINKS+=pmap.9 pmap_init.9 pmap.9 pmap_enter.9 pmap.9 pmap_remove.9 \
pmap.9 pmap_copy.9 pmap.9 pmap_kenter_pa.9 pmap.9 pmap_kremove.9
MLINKS+=pool.9 pool_init.9 pool.9 pool_destroy.9 \
pool.9 pool_get.9 pool.9 pool_put.9 pool.9 pool_prime.9 \
- pool.9 pool_sethiwat.9 pool.9 pool_setlowat.9 \
+ pool.9 pool_sethiwat.9 pool.9 pool_setipl.9 pool.9 pool_setlowat.9 \
pool.9 pool_sethardlimit.9 pool.9 pool_cache_init.9 \
pool.9 pool_cache_destroy.9 pool.9 pool_cache_get.9 \
pool.9 pool_cache_put.9 pool.9 pool_cache_destruct_object.9 \
diff --git a/share/man/man9/pool.9 b/share/man/man9/pool.9
index 927193372a9..4570e162e07 100644
--- a/share/man/man9/pool.9
+++ b/share/man/man9/pool.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: pool.9,v 1.36 2008/06/26 05:42:08 ray Exp $
+.\" $OpenBSD: pool.9,v 1.37 2008/10/27 08:56:49 dlg Exp $
.\" $NetBSD: pool.9,v 1.18 2001/06/21 11:59:01 wiz Exp $
.\"
.\" Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
@@ -28,7 +28,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd $Mdocdate: June 26 2008 $
+.Dd $Mdocdate: October 27 2008 $
.Dt POOL 9
.Os
.Sh NAME
@@ -37,6 +37,7 @@
.Nm pool_get ,
.Nm pool_put ,
.Nm pool_prime ,
+.Nm pool_setipl ,
.Nm pool_sethiwat ,
.Nm pool_setlowat ,
.Nm pool_sethardlimit ,
@@ -71,6 +72,8 @@
.Ft int
.Fn pool_prime "struct pool *pp" "int nitems"
.Ft void
+.Fn pool_setipl "struct pool *pp" "int ipl"
+.Ft void
.Fn pool_sethiwat "struct pool *pp" "int n"
.Ft void
.Fn pool_setlowat "struct pool *pp" "int n"
@@ -292,6 +295,22 @@ Unlike
.Fn pool_prime ,
this function does not allocate the necessary memory up-front.
.El
+.Ss SETTING THE PROTECTION LEVEL
+The
+.Fn pool_setipl
+function is used to specify the interrupt protection level at which the pool
+can be safely used.
+.Pp
+.Fn pool_setipl
+.Bl -tag -offset indent -width "flags"
+.It Fa pp
+The handle identifying the pool resource instance.
+.It Fa ipl
+The interrupt protection level used to protect the pool's internals.
+See
+.Xr spl 9
+for a list of the IPLs.
+.El
.Ss SETTING HARD LIMITS
The function
.Fn pool_sethardlimit
@@ -372,6 +391,7 @@ The pool manager is implemented in the file
.Sh SEE ALSO
.Xr free 9 ,
.Xr malloc 9 ,
+.Xr spl 9 ,
.Xr uvm 9
.Sh HISTORY
The pool manager first appeared in