xref: /freebsd/share/man/man9/VFS_MOUNT.9 (revision e8d8bef961a50d4dc22501cde4fb9fb0be1b2532)
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 May 23, 2009
32.Dt VFS_MOUNT 9
33.Os
34.Sh NAME
35.Nm VFS_MOUNT
36.Nd mount 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_MOUNT "struct mount *mp"
43.Sh DESCRIPTION
44The
45.Fn VFS_MOUNT
46macro mounts a file system into the system's namespace or updates the
47attributes of an already mounted file system.
48.Pp
49The arguments it expects are:
50.Bl -tag -width data
51.It Fa mp
52Structure representing the file system.
53.El
54.Pp
55The
56.Fn VFS_MOUNT
57macro is called both to mount new file systems and to change the
58attributes of an existing file system.
59If the
60.Dv MNT_UPDATE
61flag is set in
62.Fa mp->mnt_flag
63then the file system should update its internal state from the value of
64.Fa mp->mnt_flag .
65This can be used, for instance, to convert a read-only file system to
66read-write.
67It is also used by
68.Xr mountd 8
69to update the NFS export information for the file system.
70.Pp
71If the
72.Dv MNT_UPDATE
73flag is not specified, then this is a newly mounted file system.
74The file system code should allocate and initialize
75any private data needed to represent
76the file system (it can use the
77.Fa mp->mnt_data
78field to store this information).
79.Sh SEE ALSO
80.Xr VFS 9 ,
81.Xr vnode 9
82.Sh AUTHORS
83This manual page was written by
84.An Doug Rabson .
85