xref: /freebsd/share/man/man9/VFS_MOUNT.9 (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
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 July 24, 1996
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" "char *path" "caddr_t data" "struct nameidata *ndp" "struct thread *td"
43.Sh DESCRIPTION
44Mount a file system into the system's namespace.
45.Pp
46Its arguments are:
47.Bl -tag -width data
48.It Fa mp
49Structure representing the file system.
50.It Fa path
51Pathname where the file system is being mounted.
52.It Fa data
53File system specific data.
54This should be read into the kernel using
55.Xr copyin 9 .
56.It Fa ndp
57Contains the result of a
58.Xr namei 9
59call on the pathname of the mountpoint.
60.It Fa td
61Thread which is mounting the file system.
62.El
63.Pp
64This is called both to mount new file systems and to change the
65attributes of an existing file system.
66If the
67.Dv MNT_UPDATE
68flag is set in
69.Fa mp->mnt_flag
70then the file system should update its internal state from the value of
71.Fa mp->mnt_flag .
72This can be used, for instance, to convert a read-only file system to
73read-write.
74It is also used by
75.Xr mountd 8
76to update the NFS export information for the file system.
77.Pp
78If the
79.Dv MNT_UPDATE
80flag is not specified, then this is a newly mounted file system.
81The file system code should allocate and initialize
82any private data needed to represent
83the file system (it can use the
84.Fa mp->mnt_data
85field to store this information).
86.Sh SEE ALSO
87.Xr VFS 9 ,
88.Xr vnode 9
89.Sh AUTHORS
90This manual page was written by
91.An Doug Rabson .
92