xref: /dragonfly/share/man/man9/VFS_MOUNT.9 (revision 0ca59c34)
1.\" Copyright (c) 1996 Doug Rabson
2.\"
3.\" All rights reserved.
4.\"
5.\" This program is free software.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.\" $FreeBSD: src/share/man/man9/VFS_MOUNT.9,v 1.7.2.1 2001/12/17 11:30:18 ru Exp $
28.\"
29.Dd December 16, 2012
30.Dt VFS_MOUNT 9
31.Os
32.Sh NAME
33.Nm VFS_MOUNT
34.Nd mount a filesystem
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" "char *path" "caddr_t data" "struct ucred *cred"
41.Sh DESCRIPTION
42Mount a filesystem into the system's namespace.
43.Pp
44Its arguments are:
45.Bl -tag -width data
46.It Ar mp
47Structure representing the filesystem.
48.It Ar path
49Pathname where the filesystem is being mounted.
50.It Ar data
51Filesystem specific data.
52This should be read into the kernel using
53.Xr copyin 9 .
54.It Ar cred
55Pointer to a
56.Vt struct ucred
57for user credentials checking.
58.El
59.Pp
60This is called both to mount new filesystems and to change the
61attributes of an existing filesystem.
62If the
63.Dv MNT_UPDATE
64flag is set in
65.Fa mp->mnt_flag
66then the filesystem should update its internal state from the value of
67.Fa mp->mnt_flag .
68This can be used, for instance, to convert a read-only filesystem to
69read-write.
70It 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.
77The filesystem code should allocate and initialize
78any private data needed to represent the filesystem (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 man page was written by
86.An Doug Rabson .
87