xref: /dflybsd-src/share/man/man9/VOP_ADVLOCK.9 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\" Copyright (c) 1996 Doug Rabson
286d7f5d3SJohn Marino.\"
386d7f5d3SJohn Marino.\" All rights reserved.
486d7f5d3SJohn Marino.\"
586d7f5d3SJohn Marino.\" This program is free software.
686d7f5d3SJohn Marino.\"
786d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
886d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
986d7f5d3SJohn Marino.\" are met:
1086d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
1186d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
1286d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
1386d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
1486d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
1586d7f5d3SJohn Marino.\"
1686d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
1786d7f5d3SJohn Marino.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1886d7f5d3SJohn Marino.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1986d7f5d3SJohn Marino.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
2086d7f5d3SJohn Marino.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2186d7f5d3SJohn Marino.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2286d7f5d3SJohn Marino.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2386d7f5d3SJohn Marino.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2486d7f5d3SJohn Marino.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2586d7f5d3SJohn Marino.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2686d7f5d3SJohn Marino.\"
2786d7f5d3SJohn Marino.\" $FreeBSD: src/share/man/man9/VOP_ADVLOCK.9,v 1.6.2.3 2001/12/17 11:30:18 ru Exp $
2886d7f5d3SJohn Marino.\"
2986d7f5d3SJohn Marino.Dd June 30, 1999
3086d7f5d3SJohn Marino.Dt VOP_ADVLOCK 9
3186d7f5d3SJohn Marino.Os
3286d7f5d3SJohn Marino.Sh NAME
3386d7f5d3SJohn Marino.Nm VOP_ADVLOCK
3486d7f5d3SJohn Marino.Nd advisory record locking
3586d7f5d3SJohn Marino.Sh SYNOPSIS
3686d7f5d3SJohn Marino.In sys/param.h
3786d7f5d3SJohn Marino.In sys/vnode.h
3886d7f5d3SJohn Marino.In sys/fcntl.h
3986d7f5d3SJohn Marino.In sys/lockf.h
4086d7f5d3SJohn Marino.Ft int
4186d7f5d3SJohn Marino.Fn VOP_ADVLOCK "struct vnode *vp" "caddr_t id" "int op" "struct flock *fl" "int flags"
4286d7f5d3SJohn Marino.Sh DESCRIPTION
4386d7f5d3SJohn MarinoThe arguments are:
4486d7f5d3SJohn Marino.Bl -tag -width flags
4586d7f5d3SJohn Marino.It Fa vp
4686d7f5d3SJohn Marinothe vnode being manipulated
4786d7f5d3SJohn Marino.It Fa id
4886d7f5d3SJohn Marinothe id token which is changing the lock
4986d7f5d3SJohn Marino.It Fa op
5086d7f5d3SJohn Marinothe operation to perform (see
5186d7f5d3SJohn Marino.Xr fcntl 2 )
5286d7f5d3SJohn Marino.It Fa fl
5386d7f5d3SJohn Marinodescription of the lock
5486d7f5d3SJohn Marino.It Fa flags
5586d7f5d3SJohn MarinoOne of more of the following:
5686d7f5d3SJohn Marino.Bl -column ".Dv F_UNLCK" -offset indent
5786d7f5d3SJohn Marino.It Dv F_RDLCK Ta "shared or read lock"
5886d7f5d3SJohn Marino.It Dv F_UNLCK Ta "unlock"
5986d7f5d3SJohn Marino.It Dv F_WRLCK Ta "exclusive or write lock"
6086d7f5d3SJohn Marino.It Dv F_WAIT Ta "Wait until lock is granted"
6186d7f5d3SJohn Marino.It Dv F_POSIX Ta "Use POSIX semantics for lock"
6286d7f5d3SJohn Marino.El
6386d7f5d3SJohn Marino.El
6486d7f5d3SJohn Marino.Pp
6586d7f5d3SJohn MarinoThis entry point manipulates advisory record locks on the file.  Most
6686d7f5d3SJohn Marinofilesystems delegate the work for this call to
6786d7f5d3SJohn Marino.Fn lf_advlock .
6886d7f5d3SJohn Marino.Sh RETURN VALUES
6986d7f5d3SJohn MarinoZero is returned on success, otherwise an error is returned.
7086d7f5d3SJohn Marino.Sh SEE ALSO
7186d7f5d3SJohn Marino.Xr fcntl 2 ,
7286d7f5d3SJohn Marino.Xr flock 2 ,
7386d7f5d3SJohn Marino.Xr vnode 9
7486d7f5d3SJohn Marino.Sh AUTHORS
7586d7f5d3SJohn MarinoThis man page was written by
7686d7f5d3SJohn Marino.An Doug Rabson .
77