xref: /dragonfly/share/man/man9/VOP_ADVLOCK.9 (revision 16777b6b)
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: src/share/man/man9/VOP_ADVLOCK.9,v 1.6.2.3 2001/12/17 11:30:18 ru Exp $
30.\" $DragonFly: src/share/man/man9/VOP_ADVLOCK.9,v 1.3 2003/07/27 05:36:06 hmp Exp $
31.\"
32.Dd June 30, 1999
33.Os
34.Dt VOP_ADVLOCK 9
35.Sh NAME
36.Nm VOP_ADVLOCK
37.Nd advisory record locking
38.Sh SYNOPSIS
39.In sys/param.h
40.In sys/vnode.h
41.In sys/fcntl.h
42.In sys/lockf.h
43.Ft int
44.Fn VOP_ADVLOCK "struct vnode *vp" "caddr_t id" "int op" "struct flock *fl" "int flags"
45.Sh DESCRIPTION
46The arguments are:
47.Bl -tag -width flags
48.It Fa vp
49the vnode being manipulated
50.It Fa id
51the id token which is changing the lock
52.It Fa op
53the operation to perform (see
54.Xr fcntl 2 )
55.It Fa fl
56description of the lock
57.It Fa flags
58One of more of the following:
59.Bl -column F_UNLCK -offset indent
60.It Dv F_RDLCK Ta "shared or read lock"
61.It Dv F_UNLCK Ta "unlock"
62.It Dv F_WRLCK Ta "exclusive or write lock"
63.It Dv F_WAIT Ta "Wait until lock is granted"
64.It Dv F_FLOCK Ta Use
65.Xr flock 2
66semantics for lock
67.It Dv F_POSIX Ta "Use POSIX semantics for lock"
68.El
69.El
70.Pp
71This entry point manipulates advisory record locks on the file.  Most
72filesystems delegate the work for this call to
73.Fn lf_advlock .
74.Sh RETURN VALUES
75Zero is returned on success, otherwise an error is returned.
76.Sh SEE ALSO
77.Xr fcntl 2 ,
78.Xr flock 2 ,
79.Xr vnode 9
80.Sh AUTHORS
81This man page was written by
82.An Doug Rabson .
83