xref: /freebsd/share/man/man9/VFS_ROOT.9 (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 1996 Doug Rabson
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\" $FreeBSD$
30.\"
31.Dd August 26, 2006
32.Os
33.Dt VFS_ROOT 9
34.Sh NAME
35.Nm VFS_ROOT
36.Nd return the root vnode of a file system
37.Sh SYNOPSIS
38.In sys/param.h
39.In sys/mount.h
40.In sys/vnode.h
41.Ft int
42.Fn VFS_ROOT "struct mount *mp" "int flags" "struct vnode **vpp" "struct thread *td"
43.Sh DESCRIPTION
44Return a locked vnode for the root directory of the file system.
45.Pp
46Its arguments are:
47.Bl -tag -width flags
48.It Fa mp
49The file system.
50.It Fa flags
51The lock type.
52Could be
53.Dv LK_EXCLUSIVE
54or
55.Dv LK_SHARED .
56File system is free to ignore the
57.Fa flags
58argument and instead acquire an exclusive lock.
59.It Fa vpp
60Return parameter for the root vnode.
61.It Fa td
62The calling thread.
63.El
64.Sh SEE ALSO
65.Xr VFS 9 ,
66.Xr vnode 9
67.Sh AUTHORS
68This manual page was written by
69.An Doug Rabson .
70