xref: /freebsd/share/man/man9/VOP_ADVLOCK.9 (revision 2e14815b84df9657a3c6d3c1b0b290317c53591a)
1fab63cc4SDoug Rabson.\" -*- nroff -*-
2fab63cc4SDoug Rabson.\"
3fab63cc4SDoug Rabson.\" Copyright (c) 1996 Doug Rabson
4fab63cc4SDoug Rabson.\"
5fab63cc4SDoug Rabson.\" All rights reserved.
6fab63cc4SDoug Rabson.\"
7fab63cc4SDoug Rabson.\" This program is free software.
8fab63cc4SDoug Rabson.\"
9fab63cc4SDoug Rabson.\" Redistribution and use in source and binary forms, with or without
10fab63cc4SDoug Rabson.\" modification, are permitted provided that the following conditions
11fab63cc4SDoug Rabson.\" are met:
12fab63cc4SDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
13fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
14fab63cc4SDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
15fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
16fab63cc4SDoug Rabson.\"    documentation and/or other materials provided with the distribution.
17fab63cc4SDoug Rabson.\"
18fab63cc4SDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19fab63cc4SDoug Rabson.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20fab63cc4SDoug Rabson.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21fab63cc4SDoug Rabson.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22fab63cc4SDoug Rabson.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23fab63cc4SDoug Rabson.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24fab63cc4SDoug Rabson.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25fab63cc4SDoug Rabson.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26fab63cc4SDoug Rabson.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27fab63cc4SDoug Rabson.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28fab63cc4SDoug Rabson.\"
292e14815bSBruce Evans.\" $Id: VOP_ADVLOCK.9,v 1.1 1997/03/03 18:00:05 dfr Exp $
30fab63cc4SDoug Rabson.\"
31fab63cc4SDoug Rabson.Dd July 24, 1996
32fab63cc4SDoug Rabson.Os
33fab63cc4SDoug Rabson.Dt VOP_ADVLOCK 9
34fab63cc4SDoug Rabson.Sh NAME
35fab63cc4SDoug Rabson.Nm VOP_ADVLOCK
36fab63cc4SDoug Rabson.Nd advisory record locking
37fab63cc4SDoug Rabson.Sh SYNOPSIS
382e14815bSBruce Evans.Fd #include <sys/param.h>
39fab63cc4SDoug Rabson.Fd #include <sys/vnode.h>
40fab63cc4SDoug Rabson.Fd #include <sys/fcntl.h>
41fab63cc4SDoug Rabson.Fd #include <sys/lockf.h>
42fab63cc4SDoug Rabson.Ft int
43fab63cc4SDoug Rabson.Fn VOP_ADVLOCK "struct vnode *vp" "caddr_t id" "int op" "struct flock *fl" "int flags"
44fab63cc4SDoug Rabson.Sh DESCRIPTION
45fab63cc4SDoug Rabson.Pp
46fab63cc4SDoug RabsonThe arguments are:
47fab63cc4SDoug Rabson.Bl -tag -width flags
48fab63cc4SDoug Rabson.It Ar vp
49fab63cc4SDoug Rabsonthe vnode being manipulated
50fab63cc4SDoug Rabson.It Ar id
51fab63cc4SDoug Rabsonthe process changing the lock
52fab63cc4SDoug Rabson.It Ar op
53fab63cc4SDoug Rabsonthe operation to perform
54fab63cc4SDoug Rabson.It Ar fl
55fab63cc4SDoug Rabsondescription of the lock
56fab63cc4SDoug Rabson.It Ar flags
57fab63cc4SDoug Rabson???
58fab63cc4SDoug Rabson.El
59fab63cc4SDoug Rabson.Pp
60fab63cc4SDoug RabsonThis entry point manipulates advisory record locks on the file.  Most
61fab63cc4SDoug Rabsonfilesystems delegate the work for this call to
62fab63cc4SDoug Rabson.Xr lf_advlock 9 .
63fab63cc4SDoug Rabson.Sh RETURN VALUES
64fab63cc4SDoug RabsonZero is returned on success, otherwise an error is returned.
65fab63cc4SDoug Rabson.Sh SEE ALSO
66fab63cc4SDoug Rabson.Xr vnode 9 ,
67fab63cc4SDoug Rabson.Xr flock 2 ,
68fab63cc4SDoug Rabson.Xr fcntl 2
69fab63cc4SDoug Rabson.Sh AUTHORS
70fab63cc4SDoug RabsonThis man page was written by Doug Rabson.
71