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