xref: /freebsd/share/man/man9/VOP_ADVLOCK.9 (revision 952d112864d8008aa87278a30a539d888a8493cd)
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.\" $Id$
30.\"
31.Dd July 24, 1996
32.Os
33.Dt VOP_ADVLOCK 9
34.Sh NAME
35.Nm VOP_ADVLOCK
36.Nd advisory record locking
37.Sh SYNOPSIS
38.Fd #include <sys/vnode.h>
39.Fd #include <sys/fcntl.h>
40.Fd #include <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.Pp
45The arguments are:
46.Bl -tag -width flags
47.It Ar vp
48the vnode being manipulated
49.It Ar id
50the process changing the lock
51.It Ar op
52the operation to perform
53.It Ar fl
54description of the lock
55.It Ar flags
56???
57.El
58.Pp
59This entry point manipulates advisory record locks on the file.  Most
60filesystems delegate the work for this call to
61.Xr lf_advlock 9 .
62.Sh RETURN VALUES
63Zero is returned on success, otherwise an error is returned.
64.Sh SEE ALSO
65.Xr vnode 9 ,
66.Xr flock 2 ,
67.Xr fcntl 2
68.Sh AUTHORS
69This man page was written by Doug Rabson.
70