xref: /freebsd/share/man/man9/VOP_ADVLOCK.9 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
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.Dd February 10, 2021
30.Dt VOP_ADVLOCK 9
31.Os
32.Sh NAME
33.Nm VOP_ADVLOCK
34.Nd advisory record locking
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/vnode.h
38.In sys/fcntl.h
39.In sys/lockf.h
40.Ft int
41.Fn VOP_ADVLOCK "struct vnode *vp" "caddr_t id" "int op" "struct flock *fl" "int flags"
42.Sh DESCRIPTION
43The arguments are:
44.Bl -tag -width flags
45.It Fa vp
46The vnode being manipulated.
47.It Fa id
48The id token which is changing the lock.
49.It Fa op
50The operation to perform (see
51.Xr fcntl 2 ) .
52.It Fa fl
53Description of the lock.
54.It Fa flags
55One or more of the following:
56.Pp
57.Bl -tag -width ".Dv F_REMOTE" -offset indent -compact
58.It Dv F_WAIT
59Wait until lock is granted.
60.It Dv F_FLOCK
61Use
62.Xr flock 2
63semantics for lock.
64.It Dv F_POSIX
65Use POSIX semantics for lock.
66.It Dv F_REMOTE
67Lock owner is remote NFS client.
68.It Dv F_NOINTR
69Mask signals while waiting for the lock.
70.El
71.El
72.Pp
73This entry point manipulates advisory record locks on the file.
74Most file systems delegate the work for this call to
75.Fn lf_advlock .
76.Sh RETURN VALUES
77Zero is returned on success, otherwise an error is returned.
78.Sh SEE ALSO
79.Xr fcntl 2 ,
80.Xr flock 2 ,
81.Xr vnode 9
82.Sh AUTHORS
83This manual page was written by
84.An Doug Rabson .
85