VOP_LOCK(9) serialize access to a vnode

Other Alias

VOP_UNLOCK, VOP_ISLOCKED, vn_lock

SYNOPSIS

In sys/param.h In sys/lock.h In sys/vnode.h Ft int Fn VOP_LOCK struct vnode *vp int flags Ft int Fn VOP_UNLOCK struct vnode *vp int flags Ft int Fn VOP_ISLOCKED struct vnode *vp Ft int Fn vn_lock struct vnode *vp int flags

DESCRIPTION

These calls are used to serialize access to the file system, such as to prevent two writes to the same file from happening at the same time.

The arguments are:

Fa vp
The vnode being locked or unlocked.
Fa flags
One of the lock request types:

LK_SHARED
Shared lock.
LK_EXCLUSIVE
Exclusive lock.
LK_UPGRADE
Shared-to-exclusive upgrade.
LK_DOWNGRADE
Exclusive-to-shared downgrade.
LK_RELEASE
Release any type of lock.
LK_DRAIN
Wait for all lock activity to end.

The lock type may be or 'ed with these lock flags:

LK_NOWAIT
Do not sleep to wait for lock.
LK_SLEEPFAIL
Sleep, then return failure.
LK_CANRECURSE
Allow recursive exclusive lock.
LK_NOWITNESS
Instruct witness(4) to ignore this instance.

The lock type may be or 'ed with these control flags:

LK_INTERLOCK
Specify when the caller already has a simple lock Fn ( VOP_LOCK will unlock the simple lock after getting the lock).
LK_RETRY
Retry until locked.

Kernel code should use Fn vn_lock to lock a vnode rather than calling Fn VOP_LOCK directly. Fn vn_lock also does not want a thread specified as argument but it assumes curthread to be used.

RETURN VALUES

Zero is returned on success, otherwise an error is returned.

AUTHORS

This manual page was written by An Doug Rabson .