lib/libc/sys/mount.2

   1 .\" Copyright (c) 1980, 1989, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd March 30, 2020
  29 .Dt MOUNT 2
  30 .Os
  31 .Sh NAME
  32 .Nm mount ,
  33 .Nm nmount ,
  34 .Nm unmount
  35 .Nd mount or dismount a file system
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In sys/param.h
  40 .In sys/mount.h
  41 .Ft int
  42 .Fn mount "const char *type" "const char *dir" "int flags" "void *data"
  43 .Ft int
  44 .Fn unmount "const char *dir" "int flags"
  45 .In sys/uio.h
  46 .Ft int
  47 .Fn nmount "struct iovec *iov" "u_int niov" "int flags"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn mount
  51 system call grafts
  52 a file system object onto the system file tree
  53 at the point
  54 .Fa dir .
  55 The argument
  56 .Fa data
  57 describes the file system object to be mounted.
  58 The argument
  59 .Fa type
  60 tells the kernel how to interpret
  61 .Fa data
  62 (See
  63 .Fa type
  64 below).
  65 The contents of the file system
  66 become available through the new mount point
  67 .Fa dir .
  68 Any files in
  69 .Fa dir
  70 at the time
  71 of a successful mount are swept under the carpet so to speak, and
  72 are unavailable until the file system is unmounted.
  73 .Pp
  74 The
  75 .Fn nmount
  76 system call behaves similarly to
  77 .Fn mount ,
  78 except that the mount options (file system type name, device to mount,
  79 mount-point name, etc.) are passed as an array of name-value pairs
  80 in the array
  81 .Fa iov ,
  82 containing
  83 .Fa niov
  84 elements.
  85 The following options are required by all file systems:
  86 .Bl -column fstype -offset indent
  87 .It
  88 .Li fstype Ta file system type name (e.g., Dq Li procfs )
  89 .It
  90 .Li fspath Ta mount point pathname (e.g., Dq Li /proc )
  91 .El
  92 .Pp
  93 Depending on the file system type, other options may be
  94 recognized or required;
  95 for example, most disk-based file systems require a
  96 .Dq Li from
  97 option containing the pathname of a special device
  98 in addition to the options listed above.
  99 .Pp
 100 By default only the super-user may call the
 101 .Fn mount
 102 system call.
 103 This restriction can be removed by setting the
 104 .Va vfs.usermount
 105 .Xr sysctl 8
 106 variable
 107 to a non-zero value; see the BUGS section for more information.
 108 .Pp
 109 The following
 110 .Fa flags
 111 may be specified to
 112 suppress default semantics which affect file system access.
 113 .Bl -tag -width MNT_SYNCHRONOUS
 114 .It Dv MNT_RDONLY
 115 The file system should be treated as read-only;
 116 even the super-user may not write on it.
 117 Specifying MNT_UPDATE without this option will upgrade
 118 a read-only file system to read/write.
 119 .It Dv MNT_NOEXEC
 120 Do not allow files to be executed from the file system.
 121 .It Dv MNT_NOSUID
 122 Do not honor setuid or setgid bits on files when executing them.
 123 This flag is set automatically when the caller is not the super-user.
 124 .It Dv MNT_NOATIME
 125 Disable update of file access times.
 126 .It Dv MNT_SNAPSHOT
 127 Create a snapshot of the file system.
 128 This is currently only supported on UFS2 file systems, see
 129 .Xr mksnap_ffs 8
 130 for more information.
 131 .It Dv MNT_SUIDDIR
 132 Directories with the SUID bit set chown new files to their own owner.
 133 This flag requires the SUIDDIR option to have been compiled into the kernel
 134 to have any effect.
 135 See the
 136 .Xr mount 8
 137 and
 138 .Xr chmod 2
 139 pages for more information.
 140 .It Dv MNT_SYNCHRONOUS
 141 All I/O to the file system should be done synchronously.
 142 .It Dv MNT_ASYNC
 143 All I/O to the file system should be done asynchronously.
 144 .It Dv MNT_FORCE
 145 Force a read-write mount even if the file system appears to be unclean.
 146 Dangerous.
 147 Together with
 148 .Dv MNT_UPDATE
 149 and
 150 .Dv MNT_RDONLY ,
 151 specify that the file system is to be forcibly downgraded to a read-only
 152 mount even if some files are open for writing.
 153 .It Dv MNT_NOCLUSTERR
 154 Disable read clustering.
 155 .It Dv MNT_NOCLUSTERW
 156 Disable write clustering.
 157 .It Dv MNT_NOCOVER
 158 Do not mount over the root of another mount point.
 159 .It Dv MNT_EMPTYDIR
 160 Require an empty directory for the mount point directory.
 161 .El
 162 .Pp
 163 The flag
 164 .Dv MNT_UPDATE
 165 indicates that the mount command is being applied
 166 to an already mounted file system.
 167 This allows the mount flags to be changed without requiring
 168 that the file system be unmounted and remounted.
 169 Some file systems may not allow all flags to be changed.
 170 For example,
 171 many file systems will not allow a change from read-write to read-only.
 172 .Pp
 173 The flag
 174 .Dv MNT_RELOAD
 175 causes the vfs subsystem to update its data structures pertaining to
 176 the specified already mounted file system.
 177 .Pp
 178 The
 179 .Fa type
 180 argument names the file system.
 181 The types of file systems known to the system can be obtained with
 182 .Xr lsvfs 1 .
 183 .Pp
 184 The
 185 .Fa data
 186 argument
 187 is a pointer to a structure that contains the type
 188 specific arguments to mount.
 189 The format for these argument structures is described in the
 190 manual page for each file system.
 191 By convention file system manual pages are named
 192 by prefixing ``mount_'' to the name of the file system as returned by
 193 .Xr lsvfs 1 .
 194 Thus the
 195 .Tn NFS
 196 file system is described by the
 197 .Xr mount_nfs 8
 198 manual page.
 199 It should be noted that a manual page for default
 200 file systems, known as UFS and UFS2, does not exist.
 201 .Pp
 202 The
 203 .Fn unmount
 204 system call disassociates the file system from the specified
 205 mount point
 206 .Fa dir .
 207 .Pp
 208 The
 209 .Fa flags
 210 argument may include
 211 .Dv MNT_FORCE
 212 to specify that the file system should be forcibly unmounted
 213 even if files are still active.
 214 Active special devices continue to work,
 215 but any further accesses to any other active files result in errors
 216 even if the file system is later remounted.
 217 .Pp
 218 If the
 219 .Dv MNT_BYFSID
 220 flag is specified,
 221 .Fa dir
 222 should instead be a file system ID encoded as
 223 .Dq Li FSID : Ns Ar val0 : Ns Ar val1 ,
 224 where
 225 .Ar val0
 226 and
 227 .Ar val1
 228 are the contents of the
 229 .Vt fsid_t
 230 .Va val[]
 231 array in decimal.
 232 The file system that has the specified file system ID will be unmounted.
 233 .Sh RETURN VALUES
 234 .Rv -std
 235 .Sh ERRORS
 236 The
 237 .Fn mount
 238 and
 239 .Fn nmount
 240 system calls will fail when one of the following occurs:
 241 .Bl -tag -width Er
 242 .It Bq Er EPERM
 243 The caller is neither the super-user nor the owner of
 244 .Fa dir .
 245 .It Bq Er ENAMETOOLONG
 246 A component of a pathname exceeded 255 characters,
 247 or the entire length of a path name exceeded 1023 characters.
 248 .It Bq Er ELOOP
 249 Too many symbolic links were encountered in translating a pathname.
 250 .It Bq Er ENOENT
 251 A component of
 252 .Fa dir
 253 does not exist.
 254 .It Bq Er ENOTDIR
 255 A component of
 256 .Fa name
 257 is not a directory,
 258 or a path prefix of
 259 .Fa special
 260 is not a directory.
 261 .It Bq Er EBUSY
 262 Another process currently holds a reference to
 263 .Fa dir .
 264 .It Bq Er EBUSY
 265 The
 266 .Dv MNT_NOCOVER
 267 option was given, and the requested mount point
 268 is already the root of another mount point.
 269 .It Bq Er EFAULT
 270 The
 271 .Fa dir
 272 argument
 273 points outside the process's allocated address space.
 274 .It Bq Er EIO
 275 An I/O error occurred while reading data from
 276 .Fa special .
 277 .It Bq Er EINTEGRITY
 278 The backing store for
 279 .Fa special
 280 detected corrupted data while reading.
 281 .El
 282 .Pp
 283 The following errors can occur for a
 284 .Em ufs
 285 file system mount:
 286 .Bl -tag -width Er
 287 .It Bq Er ENODEV
 288 A component of ufs_args
 289 .Fa fspec
 290 does not exist.
 291 .It Bq Er ENOTBLK
 292 The
 293 .Fa fspec
 294 argument
 295 is not a block device.
 296 .It Bq Er ENOTEMPTY
 297 The
 298 .Dv MNT_EMPTYDIR
 299 option was specified, and the requested mount point
 300 is not an empty directory.
 301 .It Bq Er ENXIO
 302 The major device number of
 303 .Fa fspec
 304 is out of range (this indicates no device driver exists
 305 for the associated hardware).
 306 .It Bq Er EBUSY
 307 .Fa fspec
 308 is already mounted.
 309 .It Bq Er EMFILE
 310 No space remains in the mount table.
 311 .It Bq Er EINVAL
 312 The super block for the file system had a bad magic
 313 number or an out of range block size.
 314 .It Bq Er EINTEGRITY
 315 The super block for the file system had a bad check hash.
 316 The check hash can usually be corrected by running
 317 .Xr fsck 8 .
 318 .It Bq Er ENOMEM
 319 Not enough memory was available to read the cylinder
 320 group information for the file system.
 321 .It Bq Er EIO
 322 An I/O error occurred while reading the super block or
 323 cylinder group information.
 324 .It Bq Er EFAULT
 325 The
 326 .Fa fspec
 327 argument
 328 points outside the process's allocated address space.
 329 .El
 330 .Pp
 331 The following errors can occur for a
 332 .Em nfs
 333 file system mount:
 334 .Bl -tag -width Er
 335 .It Bq Er ETIMEDOUT
 336 .Em Nfs
 337 timed out trying to contact the server.
 338 .It Bq Er EFAULT
 339 Some part of the information described by nfs_args
 340 points outside the process's allocated address space.
 341 .El
 342 .Pp
 343 The
 344 .Fn unmount
 345 system call may fail with one of the following errors:
 346 .Bl -tag -width Er
 347 .It Bq Er EPERM
 348 The caller is neither the super-user nor the user who issued the corresponding
 349 .Fn mount
 350 call.
 351 .It Bq Er ENAMETOOLONG
 352 The length of the path name exceeded 1023 characters.
 353 .It Bq Er EINVAL
 354 The requested directory is not in the mount table.
 355 .It Bq Er ENOENT
 356 The file system ID specified using
 357 .Dv MNT_BYFSID
 358 was not found in the mount table.
 359 .It Bq Er EINVAL
 360 The file system ID specified using
 361 .Dv MNT_BYFSID
 362 could not be decoded.
 363 .It Bq Er EINVAL
 364 The specified file system is the root file system.
 365 .It Bq Er EBUSY
 366 A process is holding a reference to a file located
 367 on the file system.
 368 .It Bq Er EIO
 369 An I/O error occurred while writing cached file system information.
 370 .It Bq Er EFAULT
 371 The
 372 .Fa dir
 373 argument
 374 points outside the process's allocated address space.
 375 .El
 376 .Sh SEE ALSO
 377 .Xr lsvfs 1 ,
 378 .Xr mksnap_ffs 8 ,
 379 .Xr mount 8 ,
 380 .Xr umount 8
 381 .Sh HISTORY
 382 The
 383 .Fn mount
 384 and
 385 .Fn unmount
 386 functions appeared in
 387 .At v1 .
 388 The
 389 .Fn nmount
 390 system call first appeared in
 391 .Fx 5.0 .
 392 .Sh BUGS
 393 Some of the error codes need translation to more obvious messages.
 394 .Pp
 395 Allowing untrusted users to mount arbitrary media, e.g. by enabling
 396 .Va vfs.usermount ,
 397 should not be considered safe.
 398 Most file systems in
 399 .Fx
 400 were not built to safeguard against malicious devices.