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