2001-07-09 06:47:10 +00:00
|
|
|
.\"
|
|
|
|
|
.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice(s), this list of conditions and the following disclaimer as
|
|
|
|
|
.\" the first lines of this file unmodified other than the possible
|
|
|
|
|
.\" addition of one or more copyright notices.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice(s), this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
|
|
|
|
|
.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
|
|
|
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
|
|
|
.\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
|
|
|
|
|
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
|
|
|
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
|
|
|
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
|
|
|
.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
|
|
|
|
|
.\" DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
|
|
|
|
.Dd July 8, 2001
|
|
|
|
|
.Dt VFS_MOUNT 9
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm vfs_mount
|
|
|
|
|
.Nd "Generic filesystem mount function"
|
|
|
|
|
.Sh SYNOPSIS
|
2001-07-11 03:51:44 +00:00
|
|
|
.Fd #include <sys/param.h>
|
2001-07-09 06:47:10 +00:00
|
|
|
.Fd #include <sys/mount.h>
|
|
|
|
|
.Ft int
|
2001-07-11 03:51:44 +00:00
|
|
|
.Fn vfs_mount "struct proc *vp" "char *fstype" "char *fspath" "int fsflags" "void *fsdata"
|
2001-07-09 06:47:10 +00:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
function handles the generic portion of mounting a filesystem,
|
|
|
|
|
and calls the filesystem specific mount function after verifying
|
|
|
|
|
its parameters and setting up the structures expected by the
|
|
|
|
|
underlying mount code.
|
|
|
|
|
.Pp
|
|
|
|
|
.Nm
|
|
|
|
|
is called directly by the mount system call.
|
|
|
|
|
.Pp
|
|
|
|
|
Its arguments are:
|
|
|
|
|
.Bl -tag -width fsflags
|
|
|
|
|
.It Ar p
|
|
|
|
|
The process responsible for this call.
|
|
|
|
|
.It Ar fstype
|
|
|
|
|
The type of filesystem being mounted.
|
|
|
|
|
.It Ar fspath
|
|
|
|
|
The path to the mount point of the filesystem.
|
|
|
|
|
.It Ar fsflags
|
|
|
|
|
Flags controlling the mount. See mount(8) for details.
|
|
|
|
|
.Pp
|
|
|
|
|
MNT_EXPORTED MNT_NOSUID MNT_NODEV MNT_UPDATE MNT_RELOAD
|
|
|
|
|
MNT_FORCE MNT_ASYNC MNT_SYNCHRONOUS MNT_UNION MNT_NOATIME
|
|
|
|
|
MNT_SNAPSHOT MNT_NOCLUSTERR MNT_NOCLUSTERW MNT_IGNORE
|
|
|
|
|
MNT_UNION MNT_NOSYMFOLLOW
|
|
|
|
|
.It Ar fsdata
|
|
|
|
|
Filesystem specific data structure. It is in userspace
|
|
|
|
|
when passed to
|
|
|
|
|
.Nm
|
|
|
|
|
and is left untouched when passed to filesystems mount().
|
|
|
|
|
.El
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
A 0 value is returned on success.
|
|
|
|
|
.Sh ERRORS
|
|
|
|
|
.Bl -tag -width Er
|
|
|
|
|
.It Bq Er ENAMETOOLONG
|
|
|
|
|
The fs type or the mount point path is too long or any individual
|
|
|
|
|
path component is too long.
|
|
|
|
|
.It Bq Er EPERM
|
|
|
|
|
Permission denied. There are a number of reason this can occur
|
|
|
|
|
ranging from the user not having permission to mount a filesystem
|
|
|
|
|
to the securelevel being to high to load the fstype module.
|
|
|
|
|
.It Bq Er EINVAL
|
|
|
|
|
Invalid operation (ex: trying to update a non mount-point).
|
|
|
|
|
.It Bq Er ENOENT
|
|
|
|
|
The mount point does not exist (from namei)
|
|
|
|
|
.It Bq Er ELOOP
|
|
|
|
|
The mount point is a muddle of links (from namei)
|
|
|
|
|
.It Bq Er EOPNOTSUPP
|
|
|
|
|
The operation is not supported (ex: reloading a r/w filesystem)
|
|
|
|
|
.It Bq Er EBUSY
|
|
|
|
|
The mount point is busy or is not really a mount point (on update)
|
|
|
|
|
.It Bq Er ENOTDIR
|
|
|
|
|
The mount point is not a directory
|
|
|
|
|
.It Bq Er ENODEV
|
|
|
|
|
The kernel linker was unable to load the specified fstype or
|
|
|
|
|
was unable to find the specified fstype module.
|
|
|
|
|
.Pp
|
|
|
|
|
Other errors can be returned by the filesystems mount() and
|
|
|
|
|
you should check the specific filesystem for details. Also
|
|
|
|
|
this call relies on a large number of other kernel services
|
|
|
|
|
whose errors it returns so this list my not be exhaustive.
|
|
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr mount 2
|
|
|
|
|
.Xr mount 8
|
|
|
|
|
.Xr mount 9
|
|
|
|
|
.Xr ffs_mount 9
|
|
|
|
|
vfs.usermount
|
|
|
|
|
.Sh AUTHORS
|
|
|
|
|
This man page was written by Chad David.
|
