freebsd-nq/share/man/man9/VFS_LOCK_GIANT.9

.\"
.\" Copyright (c) 2005 Robert N. M. Watson
.\" All rights reserved.
.\"
.\" 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(s), this list of conditions and the following disclaimer as
.\"    the first lines of this file unmodified other than the possible
.\"    addition of one or more copyright notices.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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.
.\"
.\" $FreeBSD$
.\"
.Dd September 21, 2005
.Dt VFS_LOCK_GIANT 9
.Os
.Sh NAME
.Nm VFS_LOCK_GIANT ,
.Nm VFS_UNLOCK_GIANT
.Nd "conditionally lock and unlock Giant around entry into VFS"
.Sh SYNOPSIS
.In sys/param.h
.In sys/mount.h
.In sys/vnode.h
.Ft int
.Fn VFS_LOCK_GIANT "struct mount *mp"
.Ft void
.Fn VFS_UNLOCK_GIANT "int vfslocked"
.Sh DESCRIPTION
.Fn VFS_LOCK_GIANT
will conditionally acquire the
.Va Giant
lock if the file system referenced by
.Fa mp
is marked as MPSAFE or not, returning a flag indicating whether
.Va Giant
was
set, which may later be passed to
.Fn VFS_UNLOCK_GIANT .
The value of
.Fa mp
will typically be derived from the mount pointer in a
.Vt vnode
on which a VFS operation will be performed.
.Pp
.Fn VFS_UNLOCK_GIANT
conditionally releases the
.Va Giant
lock if the passed
.Fa vfslocked
argument is non-zero.
It is expected that the argument will be derived from the return values of
.Fn VFS_LOCK_GIANT
or
.Xr NDHASGIANT 9 .
.Sh RETURN VALUES
.Fn VFS_LOCK_GIANT
returns a boolean indicating whether or not
.Va Giant
was acquired.
.Sh SEE ALSO
.Xr mutex 9 ,
.Xr NDHASGIANT 9 ,
.Xr vnode 9
.Sh AUTHORS
.An -nosplit
MPSAFE VFS support for
.Fx
was implemented by
.An Jeff Roberson .
.Pp
This manual page was written by
.An Robert Watson .
.Sh BUGS
Non-MPSAFE file systems exist, requiring callers conditional locking and
unlocking of
.Va Giant .
Add discussion of Giant, the MPSAFE flag, and NDHASGIANT() to namei(9). Add a VFS_LOCK_GIANT(9)/VFS_UNLOCK_GIANT(9) man page. Discussed with: jeff MFC after: 3 days 2005-09-21 10:19:57 +00:00			`.\"`
			`.\" Copyright (c) 2005 Robert N. M. Watson`
			`.\" All rights reserved.`
			`.\"`
			`.\" 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(s), this list of conditions and the following disclaimer as`
			`.\" the first lines of this file unmodified other than the possible`
			`.\" addition of one or more copyright notices.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
			`.Dd September 21, 2005`
			`.Dt VFS_LOCK_GIANT 9`
			`.Os`
			`.Sh NAME`
			`.Nm VFS_LOCK_GIANT ,`
			`.Nm VFS_UNLOCK_GIANT`
Unbreak and fix markup. 2005-11-18 14:01:11 +00:00			`.Nd "conditionally lock and unlock Giant around entry into VFS"`
Add discussion of Giant, the MPSAFE flag, and NDHASGIANT() to namei(9). Add a VFS_LOCK_GIANT(9)/VFS_UNLOCK_GIANT(9) man page. Discussed with: jeff MFC after: 3 days 2005-09-21 10:19:57 +00:00			`.Sh SYNOPSIS`
			`.In sys/param.h`
VFS_LOCK_GIANT and VFS_UNLOCK_GIANT are actually defined in sys/mount.h, so also include sys/mount.h in SYNOPSIS. PR: docs/90541 Submitted by: Wojciech A. Koszek dunstan^freebsd.czest.pl MFC after: 1 week 2005-12-18 08:07:30 +00:00			`.In sys/mount.h`
Add discussion of Giant, the MPSAFE flag, and NDHASGIANT() to namei(9). Add a VFS_LOCK_GIANT(9)/VFS_UNLOCK_GIANT(9) man page. Discussed with: jeff MFC after: 3 days 2005-09-21 10:19:57 +00:00			`.In sys/vnode.h`
			`.Ft int`
			`.Fn VFS_LOCK_GIANT "struct mount *mp"`
			`.Ft void`
			`.Fn VFS_UNLOCK_GIANT "int vfslocked"`
			`.Sh DESCRIPTION`
			`.Fn VFS_LOCK_GIANT`
			`will conditionally acquire the`
Unbreak and fix markup. 2005-11-18 14:01:11 +00:00			`.Va Giant`
Add discussion of Giant, the MPSAFE flag, and NDHASGIANT() to namei(9). Add a VFS_LOCK_GIANT(9)/VFS_UNLOCK_GIANT(9) man page. Discussed with: jeff MFC after: 3 days 2005-09-21 10:19:57 +00:00			`lock if the file system referenced by`
			`.Fa mp`
Unbreak and fix markup. 2005-11-18 14:01:11 +00:00			`is marked as MPSAFE or not, returning a flag indicating whether`
			`.Va Giant`
			`was`
Add discussion of Giant, the MPSAFE flag, and NDHASGIANT() to namei(9). Add a VFS_LOCK_GIANT(9)/VFS_UNLOCK_GIANT(9) man page. Discussed with: jeff MFC after: 3 days 2005-09-21 10:19:57 +00:00			`set, which may later be passed to`
			`.Fn VFS_UNLOCK_GIANT .`
			`The value of`
			`.Fa mp`
			`will typically be derived from the mount pointer in a`
Unbreak and fix markup. 2005-11-18 14:01:11 +00:00			`.Vt vnode`
Add discussion of Giant, the MPSAFE flag, and NDHASGIANT() to namei(9). Add a VFS_LOCK_GIANT(9)/VFS_UNLOCK_GIANT(9) man page. Discussed with: jeff MFC after: 3 days 2005-09-21 10:19:57 +00:00			`on which a VFS operation will be performed.`
			`.Pp`
			`.Fn VFS_UNLOCK_GIANT`
			`conditionally releases the`
			`.Va Giant`
			`lock if the passed`
			`.Fa vfslocked`
			`argument is non-zero.`
			`It is expected that the argument will be derived from the return values of`
Unbreak and fix markup. 2005-11-18 14:01:11 +00:00			`.Fn VFS_LOCK_GIANT`
Add discussion of Giant, the MPSAFE flag, and NDHASGIANT() to namei(9). Add a VFS_LOCK_GIANT(9)/VFS_UNLOCK_GIANT(9) man page. Discussed with: jeff MFC after: 3 days 2005-09-21 10:19:57 +00:00			`or`
			`.Xr NDHASGIANT 9 .`
			`.Sh RETURN VALUES`
			`.Fn VFS_LOCK_GIANT`
			`returns a boolean indicating whether or not`
			`.Va Giant`
			`was acquired.`
			`.Sh SEE ALSO`
			`.Xr mutex 9 ,`
			`.Xr NDHASGIANT 9 ,`
			`.Xr vnode 9`
			`.Sh AUTHORS`
Unbreak and fix markup. 2005-11-18 14:01:11 +00:00			`.An -nosplit`
Add discussion of Giant, the MPSAFE flag, and NDHASGIANT() to namei(9). Add a VFS_LOCK_GIANT(9)/VFS_UNLOCK_GIANT(9) man page. Discussed with: jeff MFC after: 3 days 2005-09-21 10:19:57 +00:00			`MPSAFE VFS support for`
			`.Fx`
			`was implemented by`
			`.An Jeff Roberson .`
			`.Pp`
			`This manual page was written by`
			`.An Robert Watson .`
			`.Sh BUGS`
			`Non-MPSAFE file systems exist, requiring callers conditional locking and`
			`unlocking of`
			`.Va Giant .`