aboutsummaryrefslogtreecommitdiff
path: root/share/man
diff options
context:
space:
mode:
authorAttilio Rao <attilio@FreeBSD.org>2008-01-22 21:26:35 +0000
committerAttilio Rao <attilio@FreeBSD.org>2008-01-22 21:26:35 +0000
commit7ad783ffe7fb32ad6d4cfa7ca7a4d817ce891c5e (patch)
tree590f732b1fb1e909f1e5a46470005c27fe5c213e /share/man
parentfa8852657556e4c05e0eb0433b91e6ab959af19b (diff)
downloadsrc-7ad783ffe7fb32ad6d4cfa7ca7a4d817ce891c5e.tar.gz
src-7ad783ffe7fb32ad6d4cfa7ca7a4d817ce891c5e.zip
Add manpages for BUF_RECURSED(9) and BUF_ISLOCKED(9) and connect them to
the build. Reviewed by: brueffer
Notes
Notes: svn path=/head/; revision=175578
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man9/BUF_ISLOCKED.968
-rw-r--r--share/man/man9/BUF_RECURSED.964
-rw-r--r--share/man/man9/Makefile2
3 files changed, 134 insertions, 0 deletions
diff --git a/share/man/man9/BUF_ISLOCKED.9 b/share/man/man9/BUF_ISLOCKED.9
new file mode 100644
index 000000000000..7344869f6db9
--- /dev/null
+++ b/share/man/man9/BUF_ISLOCKED.9
@@ -0,0 +1,68 @@
+.\"
+.\" Copyright (C) 2008 Attilio Rao <attilio@FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice(s), this list of conditions and the following disclaimer as
+.\" the first lines of this file unmodified other than the possible
+.\" addition of one or more copyright notices.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice(s), this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
+.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+.\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
+.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+.\" DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd January 22, 2008
+.Dt BUF_ISLOCKED 9
+.Os
+.Sh NAME
+.Nm BUF_ISLOCKED
+.Nd "returns the state of the lock linked to the buffer"
+.Sh SYNOPSIS
+.In sys/param.h
+.In sys/systm.h
+.In sys/uio.h
+.In sys/bio.h
+.In sys/buf.h
+.Ft int
+.Fn BUF_ISLOCKED "struct buf *bp"
+.Sh DESCRIPTION
+The
+.Fn BUF_ISLOCKED
+function returns the status of the lock linked to the buffer in relation to
+curthread.
+.Pp
+It can return:
+.Bl -tag -width ".Dv LK_EXCLUSIVE"
+.It Dv LK_EXCLUSIVE
+An exclusive lock is held by curthread.
+.It Dv LK_EXCLOTHER
+An exclusive lock is held by someone other than curthread
+.It Dv LK_SHARED
+A shared lock is held.
+.It Li 0
+The lock is not held by anyone.
+.Sh SEE ALSO
+.Xr lockstatus 9 ,
+.Xr buf 9 ,
+.Xr BUF_LOCK 9 ,
+.Xr BUF_UNLOCK 9 ,
+.Xr lockmgr 9
+.Sh AUTHORS
+This manual page was written by
+.An Attilio Rao Aq attilio@FreeBSD.org .
diff --git a/share/man/man9/BUF_RECURSED.9 b/share/man/man9/BUF_RECURSED.9
new file mode 100644
index 000000000000..dfe818f1c4a9
--- /dev/null
+++ b/share/man/man9/BUF_RECURSED.9
@@ -0,0 +1,64 @@
+.\"
+.\" Copyright (C) 2008 Attilio Rao <attilio@FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice(s), this list of conditions and the following disclaimer as
+.\" the first lines of this file unmodified other than the possible
+.\" addition of one or more copyright notices.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice(s), this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
+.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+.\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
+.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+.\" DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd January 22, 2008
+.Dt BUF_RECURSED 9
+.Os
+.Sh NAME
+.Nm BUF_RECURSED
+.Nd "checks if the lock linked to the buffer is recursed"
+.Sh SYNOPSIS
+.In sys/param.h
+.In sys/systm.h
+.In sys/uio.h
+.In sys/bio.h
+.In sys/buf.h
+.Ft int
+.Fn BUF_RECURSED "struct buf *bp"
+.Sh DESCRIPTION
+The
+.Fn BUF_RECURSED
+function checks if the lock linked to the given buffer is recursed and
+returns 1 if the condition is true, 0 otherwise.
+.Pp
+Its argument is:
+.Bl -tag -width ".Fa bp"
+.It Fa bp
+The buffer linked to the lock.
+See
+.Xr lockmgr_recursed 9
+for details.
+.Sh SEE ALSO
+.Xr buf 9 ,
+.Xr BUF_LOCK 9 ,
+.Xr BUF_UNLOCK 9 ,
+.Xr lockmgr 9
+.Sh AUTHORS
+This manual page was written by
+.An Attilio Rao Aq attilio@FreeBSD.org .
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 1d6cc3b3631d..7a56609f496c 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -12,9 +12,11 @@ MAN= accept_filter.9 \
boot.9 \
bpf.9 \
buf.9 \
+ BUF_ISLOCKED.9 \
BUF_LOCK.9 \
BUF_LOCKFREE.9 \
BUF_LOCKINIT.9 \
+ BUF_RECURSED.9 \
BUF_TIMELOCK.9 \
BUF_UNLOCK.9 \
bus_activate_resource.9 \