share/man/man9/VOP_ADVLOCK.9

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