freebsd-dev/share/man/man9/lockstatus.9
Alfred Perlstein 82ed18ac0c Document some of the kernel API dealing with locks used primarily by VFS.
Submitted by: Chad David <davidc@acns.ab.ca>
2001-07-10 04:22:14 +00:00

82 lines
2.5 KiB
Groff

.\"
.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. 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 July 9, 2001
.Dt LOCKSTATUS 9
.Os
.Sh NAME
.Nm lockstatus
.Nd "Returns the lock status"
.Sh SYNOPSIS
.Fd #include <sys/lockmgr.h>
.Ft int
.Fo lockstatus
.Fa "struct lock *lkp"
.Fa "struct proc *p"
.Fc
.Sh DESCRIPTION
The
.Nm
function returns the status of the lock in relation to the proc
passed to it.
.Pp
Its arguments are:
.Bl -tag
.It Ar lkp
The lock to return the status of.
.It Ar p
The process to check any exclusive locks against. If
.Ar p
is NULL and an exclusive lock is held
.Ar LK_EXCLUSIVE
is returned.
.El
.Sh RETURN VALUES
.Bl -tag
.It Ar LK_EXCLUSIVE
An exclusive lock is held by the process
.Ar p
passed in.
.It Ar LK_EXCLOTHER
An exclusive lock is held by someone other then the process
.Ar p
passed in.
.It Ar LK_SHARED
A shared lock is held.
count is the sum of exclusive locks and shared locks.
.It Ar 0
The lock is not held by anyone.
.El
.Sh SEE ALSO
.Xr lockmgr 9
.Xr lockcount 9
.Xr lockdestroy 9
.Xr lockmgr_printinfo 9
.Sh AUTHORS
This man page was written by Chad David.