xref: /freebsd/share/man/man9/VFS_ROOT.9 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1fab63cc4SDoug Rabson.\" -*- nroff -*-
2fab63cc4SDoug Rabson.\"
3fab63cc4SDoug Rabson.\" Copyright (c) 1996 Doug Rabson
4fab63cc4SDoug Rabson.\"
5fab63cc4SDoug Rabson.\" All rights reserved.
6fab63cc4SDoug Rabson.\"
7fab63cc4SDoug Rabson.\" This program is free software.
8fab63cc4SDoug Rabson.\"
9fab63cc4SDoug Rabson.\" Redistribution and use in source and binary forms, with or without
10fab63cc4SDoug Rabson.\" modification, are permitted provided that the following conditions
11fab63cc4SDoug Rabson.\" are met:
12fab63cc4SDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
13fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
14fab63cc4SDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
15fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
16fab63cc4SDoug Rabson.\"    documentation and/or other materials provided with the distribution.
17fab63cc4SDoug Rabson.\"
18fab63cc4SDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19fab63cc4SDoug Rabson.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20fab63cc4SDoug Rabson.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21fab63cc4SDoug Rabson.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22fab63cc4SDoug Rabson.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23fab63cc4SDoug Rabson.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24fab63cc4SDoug Rabson.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25fab63cc4SDoug Rabson.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26fab63cc4SDoug Rabson.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27fab63cc4SDoug Rabson.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28fab63cc4SDoug Rabson.\"
29c327ec00STom McLaughlin.Dd May 23, 2009
30fab63cc4SDoug Rabson.Dt VFS_ROOT 9
31*aa12cea2SUlrich Spörlein.Os
32fab63cc4SDoug Rabson.Sh NAME
33fab63cc4SDoug Rabson.Nm VFS_ROOT
34fab63cc4SDoug Rabson.Nd return the root vnode of a file system
35fab63cc4SDoug Rabson.Sh SYNOPSIS
3632eef9aeSRuslan Ermilov.In sys/param.h
3732eef9aeSRuslan Ermilov.In sys/mount.h
3832eef9aeSRuslan Ermilov.In sys/vnode.h
39fab63cc4SDoug Rabson.Ft int
40c327ec00STom McLaughlin.Fn VFS_ROOT "struct mount *mp" "int flags" "struct vnode **vpp"
41fab63cc4SDoug Rabson.Sh DESCRIPTION
42fab63cc4SDoug RabsonReturn a locked vnode for the root directory of the file system.
43fab63cc4SDoug Rabson.Pp
44fab63cc4SDoug RabsonIts arguments are:
4544689dc0SPawel Jakub Dawidek.Bl -tag -width flags
460640e9e0SHiten Pandya.It Fa mp
47fab63cc4SDoug RabsonThe file system.
4844689dc0SPawel Jakub Dawidek.It Fa flags
4981ae4b8dSRuslan ErmilovThe lock type.
5081ae4b8dSRuslan ErmilovCould be
5144689dc0SPawel Jakub Dawidek.Dv LK_EXCLUSIVE
5244689dc0SPawel Jakub Dawidekor
5344689dc0SPawel Jakub Dawidek.Dv LK_SHARED .
5444689dc0SPawel Jakub DawidekFile system is free to ignore the
5544689dc0SPawel Jakub Dawidek.Fa flags
5644689dc0SPawel Jakub Dawidekargument and instead acquire an exclusive lock.
570640e9e0SHiten Pandya.It Fa vpp
58fab63cc4SDoug RabsonReturn parameter for the root vnode.
59fab63cc4SDoug Rabson.El
60fab63cc4SDoug Rabson.Sh SEE ALSO
61bceb8aedSWolfram Schneider.Xr VFS 9 ,
62bceb8aedSWolfram Schneider.Xr vnode 9
63fab63cc4SDoug Rabson.Sh AUTHORS
6409356c84SHiten PandyaThis manual page was written by
65aaf1f16eSPhilippe Charnier.An Doug Rabson .
66