xref: /freebsd/share/man/man9/VFS_ROOT.9 (revision a2f733abcff64628b7771a47089628b7327a88bd)
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.Dd May 23, 2009
30.Dt VFS_ROOT 9
31.Os
32.Sh NAME
33.Nm VFS_ROOT
34.Nd return the root vnode of a file system
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/mount.h
38.In sys/vnode.h
39.Ft int
40.Fn VFS_ROOT "struct mount *mp" "int flags" "struct vnode **vpp"
41.Sh DESCRIPTION
42Return a locked vnode for the root directory of the file system.
43.Pp
44Its arguments are:
45.Bl -tag -width flags
46.It Fa mp
47The file system.
48.It Fa flags
49The lock type.
50Could be
51.Dv LK_EXCLUSIVE
52or
53.Dv LK_SHARED .
54File system is free to ignore the
55.Fa flags
56argument and instead acquire an exclusive lock.
57.It Fa vpp
58Return parameter for the root vnode.
59.El
60.Sh SEE ALSO
61.Xr VFS 9 ,
62.Xr vnode 9
63.Sh AUTHORS
64This manual page was written by
65.An Doug Rabson .
66