share/man/man9/BUF_LOCK.9

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