xref: /freebsd/share/man/man9/VFS_MOUNT.9 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
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 January 7, 2005
32.Os
33.Dt VFS_MOUNT 9
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" "struct thread *td"
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.It Fa td
54Thread which is mounting the file system.
55.El
56.Pp
57The
58.Fn VFS_MOUNT
59macro is called both to mount new file systems and to change the
60attributes of an existing file system.
61If the
62.Dv MNT_UPDATE
63flag is set in
64.Fa mp->mnt_flag
65then the file system should update its internal state from the value of
66.Fa mp->mnt_flag .
67This can be used, for instance, to convert a read-only file system to
68read-write.
69It is also used by
70.Xr mountd 8
71to update the NFS export information for the file system.
72.Pp
73If the
74.Dv MNT_UPDATE
75flag is not specified, then this is a newly mounted file system.
76The file system code should allocate and initialize
77any private data needed to represent
78the file system (it can use the
79.Fa mp->mnt_data
80field to store this information).
81.Sh SEE ALSO
82.Xr VFS 9 ,
83.Xr vnode 9
84.Sh AUTHORS
85This manual page was written by
86.An Doug Rabson .
87