share/man/man9/VOP_ADVLOCK.9

   1 .\" Copyright (c) 1996 Doug Rabson
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" This program is free software.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/VOP_ADVLOCK.9,v 1.6.2.3 2001/12/17 11:30:18 ru Exp $
  28 .\" $DragonFly: src/share/man/man9/VOP_ADVLOCK.9,v 1.4 2004/06/01 11:36:53 hmp Exp $
  29 .\"
  30 .Dd June 30, 1999
  31 .Os
  32 .Dt VOP_ADVLOCK 9
  33 .Sh NAME
  34 .Nm VOP_ADVLOCK
  35 .Nd advisory record locking
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/vnode.h
  39 .In sys/fcntl.h
  40 .In sys/lockf.h
  41 .Ft int
  42 .Fn VOP_ADVLOCK "struct vnode *vp" "caddr_t id" "int op" "struct flock *fl" "int flags"
  43 .Sh DESCRIPTION
  44 The arguments are:
  45 .Bl -tag -width flags
  46 .It Fa vp
  47 the vnode being manipulated
  48 .It Fa id
  49 the id token which is changing the lock
  50 .It Fa op
  51 the operation to perform (see
  52 .Xr fcntl 2 )
  53 .It Fa fl
  54 description of the lock
  55 .It Fa flags
  56 One of more of the following:
  57 .Bl -column F_UNLCK -offset indent
  58 .It Dv F_RDLCK Ta "shared or read lock"
  59 .It Dv F_UNLCK Ta "unlock"
  60 .It Dv F_WRLCK Ta "exclusive or write lock"
  61 .It Dv F_WAIT Ta "Wait until lock is granted"
  62 .It Dv F_FLOCK Ta Use
  63 .Xr flock 2
  64 semantics for lock
  65 .It Dv F_POSIX Ta "Use POSIX semantics for lock"
  66 .El
  67 .El
  68 .Pp
  69 This entry point manipulates advisory record locks on the file.  Most
  70 filesystems delegate the work for this call to
  71 .Fn lf_advlock .
  72 .Sh RETURN VALUES
  73 Zero is returned on success, otherwise an error is returned.
  74 .Sh SEE ALSO
  75 .Xr fcntl 2 ,
  76 .Xr flock 2 ,
  77 .Xr vnode 9
  78 .Sh AUTHORS
  79 This man page was written by
  80 .An Doug Rabson .