summaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorjkoshy <jkoshy@FreeBSD.org>2005-01-30 10:21:04 +0000
committerjkoshy <jkoshy@FreeBSD.org>2005-01-30 10:21:04 +0000
commita37be2d715790a9eaa80f1ceb7c0143ab3c596c7 (patch)
treecfceb5ecff84188d8d75a1cd8a54b1a265ec5916 /share
parent268c70c97413a67d219f69ba02f9b891a52b38e4 (diff)
downloadFreeBSD-src-a37be2d715790a9eaa80f1ceb7c0143ab3c596c7.zip
FreeBSD-src-a37be2d715790a9eaa80f1ceb7c0143ab3c596c7.tar.gz
Bring the prototype for alq_open() in line with the code.
Add a section on locking.
Diffstat (limited to 'share')
-rw-r--r--share/man/man9/alq.920
1 files changed, 18 insertions, 2 deletions
diff --git a/share/man/man9/alq.9 b/share/man/man9/alq.9
index bcea3cc..9b41527 100644
--- a/share/man/man9/alq.9
+++ b/share/man/man9/alq.9
@@ -40,7 +40,13 @@
.Sh SYNOPSIS
.In sys/alq.h
.Ft int
-.Fn alq_open "struct alq **app" "const char *file" "int size" "int count"
+.Fo alq_open
+.Fa "struct alq **app"
+.Fa "const char *file"
+.Fa "struct ucred *cred"
+.Fa "int size"
+.Fa "int count"
+.Fc
.Ft int
.Fn alq_write "struct alq *alq" "void *data" "int waitok"
.Ft void
@@ -90,10 +96,12 @@ Behaviour is undefined if this field is modified.
The
.Fn alq_open
function creates a new logging queue.
-.Pp
The
.Fa file
argument is the name of the file to open for logging.
+The argument
+.Fa cred
+specifies the credentials to use when opening the file.
The size of each entry in the queue is determined by
.Fa size .
The
@@ -176,6 +184,14 @@ functions; by using these functions separately, a call
to
.Fn bcopy
can be avoided for performance critical code paths.
+.Sh LOCKING
+Each asynchronous queue is protected by a spin mutex.
+.Pp
+Function
+.Fn alq_post
+may attempt to acquire an internal sleep mutex, and should
+consequently not be used in contexts where sleeping is
+not allowed.
.Sh RETURN VALUES
The
.Fn alq_open
OpenPOWER on IntegriCloud