xref: /freebsd/share/man/man9/BUF_LOCK.9 (revision 6990ffd8a95caaba6858ad44ff1b3157d1efba8f)
1.\"
2.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice(s), this list of conditions and the following disclaimer as
9.\"    the first lines of this file unmodified other than the possible
10.\"    addition of one or more copyright notices.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice(s), this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
16.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18.\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
19.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
25.\" DAMAGE.
26.\"
27.\" $FreeBSD$
28.\"
29.Dd July 9, 2001
30.Dt BUF_LOCK 9
31.Os
32.Sh NAME
33.Nm BUF_LOCK
34.Nd "locks a buffer"
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/buf.h
38.Ft int
39.Fn BUF_LOCK "struct buf *bp" "int locktype"
40.Sh DESCRIPTION
41The
42.Fn BUF_LOCK
43function locks the given buffer.
44If the lock is already held this
45call will block until it can acquire the lock unless
46.Dv LK_NOWAIT
47is set.
48.Pp
49Its arguments are:
50.Bl -tag -width ".Fa locktype"
51.It Fa bp
52The buffer to lock.
53.It Fa locktype
54Flags controlling the type of lock.
55See
56.Xr lockmgr 9
57for details.
58.El
59.Sh RETURN VALUES
60A value of 0 is returned upon success.
61See
62.Xr lockmgr 9
63for
64information on non-zero return values.
65.Sh SEE ALSO
66.Xr buf 9 ,
67.Xr BUF_TIMELOCK 9 ,
68.Xr BUF_UNLOCK 9 ,
69.Xr lockmgr 9
70.Sh AUTHORS
71This man page was written by
72.An Chad David Aq davidc@acns.ab.ca .
73