80 lines
2.5 KiB
Groff
80 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 BUF_LOCK 9
|
|
.Os
|
|
.Sh NAME
|
|
.Nm BUF_LOCK
|
|
.Nd "Locks a buffer"
|
|
.Sh SYNOPSIS
|
|
.Fd #include <sys/buf.h>
|
|
.Ft int
|
|
.Fo BUF_LOCK
|
|
.Fa "struct buf *bp"
|
|
.Fa "int locktype"
|
|
.Fa "char *wmesg"
|
|
.Fa "int catch"
|
|
.Fa "int timo"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
function locks the given buffer, and limits the amount of time it
|
|
will sleep to
|
|
.Ar timo
|
|
and OR's
|
|
.Ar catch
|
|
into the sleep priority.
|
|
.Ar wmesg
|
|
is the wmesg used in the sleep.
|
|
.Pp
|
|
Its arguments are:
|
|
.Bl -tag -width locktype
|
|
.It Ar bp
|
|
The buffer to lock.
|
|
.It Ar locktype
|
|
Flags controlling the type of lock. See lockmgr(9) for details.
|
|
.It Ar wmesg
|
|
The wmesg used in any sleeps while aquiring the lock.
|
|
.It Ar catch
|
|
Priority OR'd into the sleep priority.
|
|
.It Ar timo
|
|
The timeout for any sleeps encountered during the lock.
|
|
.El
|
|
.Sh RETURN VALUE
|
|
A value of 0 is returned on success. See lockmgr(9) for
|
|
details on non-zero return values.
|
|
.Sh SEE ALSO
|
|
.Xr buf 9
|
|
.Xr lockmgr 9
|
|
.Xr BUF_UNLOCK 9
|
|
.Xr BUF_TIMELOCK 9
|
|
.Sh AUTHORS
|
|
This man page was written by Chad David.
|