d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
db4fcadf52
freebsd-skq/share/man/man9/VOP_LOCK.9

126 lines
3.4 KiB
Groff
Raw Normal View History

This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.\" -*- nroff -*-
.\"
.\" Copyright (c) 1996 Doug Rabson
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (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$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.\"
Modify VOP_ISLOCKED() and lockstatus() prototypes in order to reflect 'thread' argument axing.
2008-02-25 19:12:01 +00:00
.Dd February 25, 2008
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Dt VOP_LOCK 9
mdoc: order prologue macros consistently by Dd/Dt/Os Although groff_mdoc(7) gives another impression, this is the ordering most widely used and also required by mdocml/mandoc. Reviewed by: ru Approved by: philip, ed (mentors)
2010-04-14 19:08:06 +00:00
.Os
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Sh NAME
.Nm VOP_LOCK ,
.Nm VOP_UNLOCK ,
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
1999-03-17 20:17:32 +00:00
.Nm VOP_ISLOCKED ,
.Nm vn_lock
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Nd serialize access to a vnode
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In sys/param.h
.In sys/lock.h
.In sys/vnode.h
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Ft int
Update VOP_LOCK() and VOP_UNLOCK() prototypes. Leave 'td' argument description as it is used by VOP_ISLOCKED(). It will be axed in further commit.
2008-01-18 22:09:29 +00:00
.Fn VOP_LOCK "struct vnode *vp" "int flags"
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Ft int
Update VOP_LOCK() and VOP_UNLOCK() prototypes. Leave 'td' argument description as it is used by VOP_ISLOCKED(). It will be axed in further commit.
2008-01-18 22:09:29 +00:00
.Fn VOP_UNLOCK "struct vnode *vp" "int flags"
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Ft int
Modify VOP_ISLOCKED() and lockstatus() prototypes in order to reflect 'thread' argument axing.
2008-02-25 19:12:01 +00:00
.Fn VOP_ISLOCKED "struct vnode *vp"
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
1999-03-17 20:17:32 +00:00
.Ft int
Update vn_lock() prototype accordingly with the 'thread' argument removal.
2008-01-10 01:23:59 +00:00
.Fn vn_lock "struct vnode *vp" "int flags"
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Sh DESCRIPTION
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
These calls are used to serialize access to the file system, such as
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
1999-03-17 20:17:32 +00:00
to prevent two writes to the same file from happening at the
same time.
.Pp
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
The arguments are:
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
1999-03-17 20:17:32 +00:00
.Bl -tag -width flags
Some mdoc(7) fixes: Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately. The .Ar mdoc(7) specifier should only be used when displaying command line arguments. Approved by: des (mentor)
2003-05-31 14:07:25 +00:00
.It Fa vp
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
The vnode being locked or unlocked.
Some mdoc(7) fixes: Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately. The .Ar mdoc(7) specifier should only be used when displaying command line arguments. Approved by: des (mentor)
2003-05-31 14:07:25 +00:00
.It Fa flags
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
1999-03-17 20:17:32 +00:00
One of the lock request types:
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
.Pp
Trimm out now unused option LK_EXCLUPGRADE from the lockmgr namespace. This option just adds complexity and the new implementation no longer will support it, so axing it now that it is unused is probabilly the better idea. FreeBSD version is bumped in order to reflect the KPI breakage introduced by this patch. In the ports tree, kris found that only old OSKit code uses it, but as it is thought to work only on 2.x kernels serie, version bumping will solve any problem.
2007-12-28 00:38:13 +00:00
.Bl -tag -width ".Dv LK_CANRECURSE" -offset indent -compact
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
.It Dv LK_SHARED
Shared lock.
.It Dv LK_EXCLUSIVE
Exclusive lock.
.It Dv LK_UPGRADE
Shared-to-exclusive upgrade.
.It Dv LK_DOWNGRADE
Exclusive-to-shared downgrade.
.It Dv LK_RELEASE
Release any type of lock.
.It Dv LK_DRAIN
Wait for all lock activity to end.
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.El
.Pp
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
1999-03-17 20:17:32 +00:00
The lock type may be
.Em or Ns 'ed
with these lock flags:
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
.Pp
Trimm out now unused option LK_EXCLUPGRADE from the lockmgr namespace. This option just adds complexity and the new implementation no longer will support it, so axing it now that it is unused is probabilly the better idea. FreeBSD version is bumped in order to reflect the KPI breakage introduced by this patch. In the ports tree, kris found that only old OSKit code uses it, but as it is thought to work only on 2.x kernels serie, version bumping will solve any problem.
2007-12-28 00:38:13 +00:00
.Bl -tag -width ".Dv LK_CANRECURSE" -offset indent -compact
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
.It Dv LK_NOWAIT
Do not sleep to wait for lock.
.It Dv LK_SLEEPFAIL
Sleep, then return failure.
.It Dv LK_CANRECURSE
Allow recursive exclusive lock.
Add the missing option LK_NOWITNESS for vn_lock / VOP_LOCK operations.
2008-06-05 17:07:33 +00:00
.It Dv LK_NOWITNESS
Instruct
.Xr witness 4
to ignore this instance.
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
1999-03-17 20:17:32 +00:00
.El
.Pp
The lock type may be
.Em or Ns 'ed
with these control flags:
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
.Pp
Trimm out now unused option LK_EXCLUPGRADE from the lockmgr namespace. This option just adds complexity and the new implementation no longer will support it, so axing it now that it is unused is probabilly the better idea. FreeBSD version is bumped in order to reflect the KPI breakage introduced by this patch. In the ports tree, kris found that only old OSKit code uses it, but as it is thought to work only on 2.x kernels serie, version bumping will solve any problem.
2007-12-28 00:38:13 +00:00
.Bl -tag -width ".Dv LK_CANRECURSE" -offset indent -compact
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
.It Dv LK_INTERLOCK
Specify when the caller already has a simple lock
Fix various mdoc issues and some EOL whitespace. Found with: mandoc -Tlint
2014-12-21 10:57:42 +00:00
.Po Fn VOP_LOCK
will unlock the simple lock after getting the lock
.Pc .
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly)
2005-01-28 10:43:05 +00:00
.It Dv LK_RETRY
Retry until locked.
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
1999-03-17 20:17:32 +00:00
.El
.Pp
Kernel code should use
.Fn vn_lock
to lock a vnode rather than calling
.Fn VOP_LOCK
directly.
Update vn_lock() prototype accordingly with the 'thread' argument removal.
2008-01-10 01:23:59 +00:00
.Fn vn_lock
Removed a contraction.
2008-01-10 19:11:37 +00:00
also does not want a thread specified as argument but it
Update vn_lock() prototype accordingly with the 'thread' argument removal.
2008-01-10 01:23:59 +00:00
assumes curthread to be used.
Add several necessary .El's. MFC after: 2 weeks
2010-02-27 01:17:44 +00:00
.El
This is the current draft of my filesystem manpages. Some files are incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
1997-03-03 18:01:01 +00:00
.Sh RETURN VALUES
Zero is returned on success, otherwise an error is returned.
.Sh SEE ALSO
.Xr vnode 9
.Sh AUTHORS
Use 'manual page' instead of 'man page' for consistency. Approved by: re (hrs)
2005-06-28 20:15:19 +00:00
This manual page was written by
.Sh AUTHOR -> .Sh AUTHORS according to mdoc specs. Use .An/.Aq.
1998-03-12 07:31:21 +00:00
.An Doug Rabson .
Reference in New Issue Copy Permalink