xref: /freebsd/share/man/man9/BUF_LOCK.9 (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
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.Dd July 9, 2001
28.Dt BUF_LOCK 9
29.Os
30.Sh NAME
31.Nm BUF_LOCK
32.Nd "locks a buffer"
33.Sh SYNOPSIS
34.In sys/param.h
35.In sys/systm.h
36.In sys/uio.h
37.In sys/bio.h
38.In sys/buf.h
39.Ft int
40.Fn BUF_LOCK "struct buf *bp" "int locktype"
41.Sh DESCRIPTION
42The
43.Fn BUF_LOCK
44function locks the given buffer.
45If the lock is already held this
46call will block until it can acquire the lock unless
47.Dv LK_NOWAIT
48is set.
49.Pp
50Its arguments are:
51.Bl -tag -width ".Fa locktype"
52.It Fa bp
53The buffer to lock.
54.It Fa locktype
55Flags controlling the type of lock.
56See
57.Xr lockmgr 9
58for details.
59.El
60.Sh RETURN VALUES
61A value of 0 is returned upon success.
62See
63.Xr lockmgr 9
64for
65information on non-zero return values.
66.Sh SEE ALSO
67.Xr buf 9 ,
68.Xr BUF_TIMELOCK 9 ,
69.Xr BUF_UNLOCK 9 ,
70.Xr lockmgr 9
71.Sh AUTHORS
72This manual page was written by
73.An Chad David Aq Mt davidc@acns.ab.ca .
74