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