xref: /dragonfly/share/man/man9/VFS_MOUNT.9 (revision 9dbf638f)
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: src/share/man/man9/VFS_MOUNT.9,v 1.7.2.1 2001/12/17 11:30:18 ru Exp $
30.\" $DragonFly: src/share/man/man9/VFS_MOUNT.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
31.\"
32.Dd July 24, 1996
33.Os
34.Dt VFS_MOUNT 9
35.Sh NAME
36.Nm VFS_MOUNT
37.Nd mount a filesystem
38.Sh SYNOPSIS
39.In sys/param.h
40.In sys/mount.h
41.In sys/vnode.h
42.Ft int
43.Fn VFS_MOUNT "struct mount *mp" "char *path" "caddr_t data" "struct nameidata *ndp" "struct proc *p"
44.Sh DESCRIPTION
45Mount a filesystem into the system's namespace.
46.Pp
47Its arguments are:
48.Bl -tag -width data
49.It Ar mp
50Structure representing the filesystem.
51.It Ar path
52Pathname where the filesystem is being mounted.
53.It Ar data
54Filesystem specific data.  This should be read into the kernel using
55.Xr copyin 9 .
56.It Ar ndp
57Contains the result of a
58.Xr namei 9
59call on the pathname of the mountpoint.
60.It Ar p
61Process which is mounting the filesystem.
62.El
63.Pp
64This is called both to mount new filesystems and to change the
65attributes of an existing filesystem.  If the
66.Dv MNT_UPDATE
67flag is set in
68.Fa mp->mnt_flag
69then the filesystem should update its internal state from the value of
70.Fa mp->mnt_flag .
71This can be used, for instance, to convert a read-only filesystem to
72read-write.
73It is also used by
74.Xr mountd 8
75to update the NFS export information for the filesystem.
76.Pp
77If the
78.Dv MNT_UPDATE
79flag is not specified, then this is a newly mounted filesystem.  The
80filesystem code should allocate and initialize
81any private data needed to represent
82the filesystem (it can use the
83.Fa mp->mnt_data
84field to store this information).
85.Sh SEE ALSO
86.Xr VFS 9 ,
87.Xr vnode 9
88.Sh AUTHORS
89This man page was written by
90.An Doug Rabson .
91