diff options
author | ghelmer <ghelmer@FreeBSD.org> | 1999-03-17 20:17:32 +0000 |
---|---|---|
committer | ghelmer <ghelmer@FreeBSD.org> | 1999-03-17 20:17:32 +0000 |
commit | 10d69fb3871694a69da8b2a540f49962d4ce44d2 (patch) | |
tree | 252a5dff88e0fb089bf570ca94051ad74f7cb459 | |
parent | 0987d6b0022fa70f58b6ea190e984587d1f7e2c9 (diff) | |
download | FreeBSD-src-10d69fb3871694a69da8b2a540f49962d4ce44d2.zip FreeBSD-src-10d69fb3871694a69da8b2a540f49962d4ce44d2.tar.gz |
Document the flags and p parameters to VOP_LOCK and VOP_UNLOCK. Also,
at Doug Rabson's suggestion, add vn_lock(9) as an alternative name for
this manpage and note its calling convention.
PR: docs/9338
-rw-r--r-- | share/man/man9/Makefile | 3 | ||||
-rw-r--r-- | share/man/man9/VOP_LOCK.9 | 56 |
2 files changed, 52 insertions, 7 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index 1effebb..994612f 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -1,4 +1,4 @@ -# $Id: Makefile,v 1.45 1999/03/06 17:37:20 bde Exp $ +# $Id: Makefile,v 1.46 1999/03/06 19:03:31 bde Exp $ MAN9= MD5.9 \ VFS.9 VFS_FHTOVP.9 VFS_INIT.9 VFS_MOUNT.9 VFS_QUOTACTL.9 \ @@ -44,6 +44,7 @@ MLINKS+=VOP_GETPAGES.9 VOP_PUTPAGES.9 MLINKS+=VOP_INACTIVE.9 VOP_RECLAIM.9 MLINKS+=VOP_LOCK.9 VOP_ISLOCKED.9 MLINKS+=VOP_LOCK.9 VOP_UNLOCK.9 +MLINKS+=VOP_LOCK.9 vn_lock.9 MLINKS+=VOP_OPENCLOSE.9 VOP_CLOSE.9 MLINKS+=VOP_OPENCLOSE.9 VOP_OPEN.9 MLINKS+=VOP_RDWR.9 VOP_READ.9 diff --git a/share/man/man9/VOP_LOCK.9 b/share/man/man9/VOP_LOCK.9 index bc82f91..7b09063 100644 --- a/share/man/man9/VOP_LOCK.9 +++ b/share/man/man9/VOP_LOCK.9 @@ -26,7 +26,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: VOP_LOCK.9,v 1.3 1997/04/13 14:39:58 bde Exp $ +.\" $Id: VOP_LOCK.9,v 1.4 1998/03/12 07:31:11 charnier Exp $ .\" .Dd July 24, 1996 .Os @@ -34,9 +34,11 @@ .Sh NAME .Nm VOP_LOCK , .Nm VOP_UNLOCK , -.Nm VOP_ISLOCKED +.Nm VOP_ISLOCKED , +.Nm vn_lock .Nd serialize access to a vnode .Sh SYNOPSIS +.Fd #include <sys/lock.h> .Fd #include <sys/param.h> .Fd #include <sys/vnode.h> .Ft int @@ -45,17 +47,59 @@ .Fn VOP_UNLOCK "struct vnode *vp" "int flags" "struct proc *p" .Ft int .Fn VOP_ISLOCKED "struct vnode *vp" +.Ft int +.Fn vn_lock "struct vnode *vp" "int flags" "struct proc *p" .Sh DESCRIPTION .Pp +These calls are used to serialize access to the filesystem, such as +to prevent two writes to the same file from happening at the +same time. +.Pp The arguments are: -.Bl -tag -width vp +.Bl -tag -width flags .It Ar vp the vnode being locked or unlocked +.It Ar flags +One of the lock request types: +.Bl -column LK_EXCLUPGRADE -offset indent +.It Dv LK_SHARED Ta "Shared lock" +.It Dv LK_EXCLUSIVE Ta "Exclusive lock" +.It Dv LK_UPGRADE Ta "Shared-to-exclusive upgrade" +.It Dv LK_EXCLUPGRADE Ta "First shared-to-exclusive upgrade" +.It Dv LK_DOWNGRADE Ta "Exclusive-to-shared downgrade" +.It Dv LK_RELEASE Ta "Release any type of lock" +.It Dv LK_DRAIN Ta "Wait for all lock activity to end" .El .Pp -These calls are used to serialize access to the filesystem, for -instance to prevent two writes to the same file from happening at the -same time. +The lock type may be +.Em or Ns 'ed +with these lock flags: +.Bl -column LK_CANRECURSE -offset indent +.It Dv LK_NOWAIT Ta "Do not sleep to wait for lock" +.It Dv LK_SLEEPFAIL Ta "Sleep, then return failure" +.It Dv LK_CANRECURSE Ta "Allow recursive exclusive lock" +.It Dv LK_REENABLE Ta "Lock is to be reenabled after drain" +.It Dv LK_NOPAUSE Ta "No spinloop" +.El +.Pp +The lock type may be +.Em or Ns 'ed +with these control flags: +.Bl -column LK_INTERLOCK -offset indent +.It Dv LK_INTERLOCK Ta "Specify when the caller already has a simple lock \ +(VOP_LOCK will unlock the simple lock after getting the lock)" +.It Dv LK_RETRY Ta "Retry until locked" +.It Dv LK_NOOBJ Ta "Don't create object" +.El +.It Ar p +process context to use for the locks +.El +.Pp +Kernel code should use +.Fn vn_lock +to lock a vnode rather than calling +.Fn VOP_LOCK +directly. .Sh RETURN VALUES Zero is returned on success, otherwise an error is returned. .Sh PSEUDOCODE |