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