xref: /dragonfly/share/man/man9/VOP_ADVLOCK.9 (revision e5a92d33)
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.\"
29.Dd June 30, 1999
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 of more of the following:
56.Bl -column ".Dv F_UNLCK" -offset indent
57.It Dv F_RDLCK Ta "shared or read lock"
58.It Dv F_UNLCK Ta "unlock"
59.It Dv F_WRLCK Ta "exclusive or write lock"
60.It Dv F_WAIT Ta "Wait until lock is granted"
61.It Dv F_POSIX Ta "Use POSIX semantics for lock"
62.El
63.El
64.Pp
65This entry point manipulates advisory record locks on the file.  Most
66filesystems delegate the work for this call to
67.Fn lf_advlock .
68.Sh RETURN VALUES
69Zero is returned on success, otherwise an error is returned.
70.Sh SEE ALSO
71.Xr fcntl 2 ,
72.Xr flock 2 ,
73.Xr vnode 9
74.Sh AUTHORS
75This man page was written by
76.An Doug Rabson .
77