1/*- 2 * Copyright (c) 1989, 1991, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 4. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * @(#)mount.h 8.21 (Berkeley) 5/20/95 30 * $FreeBSD: stable/10/sys/sys/mount.h 309530 2016-12-04 13:56:15Z kib $ 31 */ 32 33#ifndef _SYS_MOUNT_H_ 34#define _SYS_MOUNT_H_ 35 36#include <sys/ucred.h> 37#include <sys/queue.h> 38#ifdef _KERNEL 39#include <sys/lock.h> 40#include <sys/lockmgr.h> 41#include <sys/_mutex.h> 42#include <sys/_sx.h> 43#endif 44 45/* 46 * NOTE: When changing statfs structure, mount structure, MNT_* flags or 47 * MNTK_* flags also update DDB show mount command in vfs_subr.c. 48 */ 49 50typedef struct fsid { int32_t val[2]; } fsid_t; /* filesystem id type */ 51 52/* 53 * File identifier. 54 * These are unique per filesystem on a single machine. 55 */ 56#define MAXFIDSZ 16 57 58struct fid { 59 u_short fid_len; /* length of data in bytes */ 60 u_short fid_data0; /* force longword alignment */ 61 char fid_data[MAXFIDSZ]; /* data (variable length) */ 62}; 63 64/* 65 * filesystem statistics 66 */ 67#define MFSNAMELEN 16 /* length of type name including null */ 68#define MNAMELEN 88 /* size of on/from name bufs */ 69#define STATFS_VERSION 0x20030518 /* current version number */ 70struct statfs { 71 uint32_t f_version; /* structure version number */ 72 uint32_t f_type; /* type of filesystem */ 73 uint64_t f_flags; /* copy of mount exported flags */ 74 uint64_t f_bsize; /* filesystem fragment size */ 75 uint64_t f_iosize; /* optimal transfer block size */ 76 uint64_t f_blocks; /* total data blocks in filesystem */ 77 uint64_t f_bfree; /* free blocks in filesystem */ 78 int64_t f_bavail; /* free blocks avail to non-superuser */ 79 uint64_t f_files; /* total file nodes in filesystem */ 80 int64_t f_ffree; /* free nodes avail to non-superuser */ 81 uint64_t f_syncwrites; /* count of sync writes since mount */ 82 uint64_t f_asyncwrites; /* count of async writes since mount */ 83 uint64_t f_syncreads; /* count of sync reads since mount */ 84 uint64_t f_asyncreads; /* count of async reads since mount */ 85 uint64_t f_spare[10]; /* unused spare */ 86 uint32_t f_namemax; /* maximum filename length */ 87 uid_t f_owner; /* user that mounted the filesystem */ 88 fsid_t f_fsid; /* filesystem id */ 89 char f_charspare[80]; /* spare string space */ 90 char f_fstypename[MFSNAMELEN]; /* filesystem type name */ 91 char f_mntfromname[MNAMELEN]; /* mounted filesystem */ 92 char f_mntonname[MNAMELEN]; /* directory on which mounted */ 93}; 94 95#ifdef _KERNEL 96#define OMFSNAMELEN 16 /* length of fs type name, including null */ 97#define OMNAMELEN (88 - 2 * sizeof(long)) /* size of on/from name bufs */ 98 99/* XXX getfsstat.2 is out of date with write and read counter changes here. */ 100/* XXX statfs.2 is out of date with read counter changes here. */ 101struct ostatfs { 102 long f_spare2; /* placeholder */ 103 long f_bsize; /* fundamental filesystem block size */ 104 long f_iosize; /* optimal transfer block size */ 105 long f_blocks; /* total data blocks in filesystem */ 106 long f_bfree; /* free blocks in fs */ 107 long f_bavail; /* free blocks avail to non-superuser */ 108 long f_files; /* total file nodes in filesystem */ 109 long f_ffree; /* free file nodes in fs */ 110 fsid_t f_fsid; /* filesystem id */ 111 uid_t f_owner; /* user that mounted the filesystem */ 112 int f_type; /* type of filesystem */ 113 int f_flags; /* copy of mount exported flags */ 114 long f_syncwrites; /* count of sync writes since mount */ 115 long f_asyncwrites; /* count of async writes since mount */ 116 char f_fstypename[OMFSNAMELEN]; /* fs type name */ 117 char f_mntonname[OMNAMELEN]; /* directory on which mounted */ 118 long f_syncreads; /* count of sync reads since mount */ 119 long f_asyncreads; /* count of async reads since mount */ 120 short f_spares1; /* unused spare */ 121 char f_mntfromname[OMNAMELEN];/* mounted filesystem */ 122 short f_spares2; /* unused spare */ 123 /* 124 * XXX on machines where longs are aligned to 8-byte boundaries, there 125 * is an unnamed int32_t here. This spare was after the apparent end 126 * of the struct until we bit off the read counters from f_mntonname. 127 */ 128 long f_spare[2]; /* unused spare */ 129}; 130 131TAILQ_HEAD(vnodelst, vnode); 132 133/* Mount options list */ 134TAILQ_HEAD(vfsoptlist, vfsopt); 135struct vfsopt { 136 TAILQ_ENTRY(vfsopt) link; 137 char *name; 138 void *value; 139 int len; 140 int pos; 141 int seen; 142}; 143 144/* 145 * Structure per mounted filesystem. Each mounted filesystem has an 146 * array of operations and an instance record. The filesystems are 147 * put on a doubly linked list. 148 * 149 * Lock reference: 150 * m - mountlist_mtx 151 * i - interlock 152 * v - vnode freelist mutex 153 * 154 * Unmarked fields are considered stable as long as a ref is held. 155 * 156 */ 157struct mount { 158 struct mtx mnt_mtx; /* mount structure interlock */ 159 int mnt_gen; /* struct mount generation */ 160#define mnt_startzero mnt_list 161 TAILQ_ENTRY(mount) mnt_list; /* (m) mount list */ 162 struct vfsops *mnt_op; /* operations on fs */ 163 struct vfsconf *mnt_vfc; /* configuration info */ 164 struct vnode *mnt_vnodecovered; /* vnode we mounted on */ 165 struct vnode *mnt_syncer; /* syncer vnode */ 166 int mnt_ref; /* (i) Reference count */ 167 struct vnodelst mnt_nvnodelist; /* (i) list of vnodes */ 168 int mnt_nvnodelistsize; /* (i) # of vnodes */ 169 struct vnodelst mnt_activevnodelist; /* (v) list of active vnodes */ 170 int mnt_activevnodelistsize;/* (v) # of active vnodes */ 171 int mnt_writeopcount; /* (i) write syscalls pending */ 172 int mnt_kern_flag; /* (i) kernel only flags */ 173 uint64_t mnt_flag; /* (i) flags shared with user */ 174 struct vfsoptlist *mnt_opt; /* current mount options */ 175 struct vfsoptlist *mnt_optnew; /* new options passed to fs */ 176 int mnt_maxsymlinklen; /* max size of short symlink */ 177 struct statfs mnt_stat; /* cache of filesystem stats */ 178 struct ucred *mnt_cred; /* credentials of mounter */ 179 void * mnt_data; /* private data */ 180 time_t mnt_time; /* last time written*/ 181 int mnt_iosize_max; /* max size for clusters, etc */ 182 struct netexport *mnt_export; /* export list */ 183 struct label *mnt_label; /* MAC label for the fs */ 184 u_int mnt_hashseed; /* Random seed for vfs_hash */ 185 int mnt_lockref; /* (i) Lock reference count */ 186 int mnt_secondary_writes; /* (i) # of secondary writes */ 187 int mnt_secondary_accwrites;/* (i) secondary wr. starts */ 188 struct thread *mnt_susp_owner; /* (i) thread owning suspension */ 189#define mnt_endzero mnt_gjprovider 190 char *mnt_gjprovider; /* gjournal provider name */ 191 struct lock mnt_explock; /* vfs_export walkers lock */ 192 TAILQ_ENTRY(mount) mnt_upper_link; /* (m) we in the all uppers */ 193 TAILQ_HEAD(, mount) mnt_uppers; /* (m) upper mounts over us*/ 194}; 195 196/* 197 * Definitions for MNT_VNODE_FOREACH_ALL. 198 */ 199struct vnode *__mnt_vnode_next_all(struct vnode **mvp, struct mount *mp); 200struct vnode *__mnt_vnode_first_all(struct vnode **mvp, struct mount *mp); 201void __mnt_vnode_markerfree_all(struct vnode **mvp, struct mount *mp); 202 203#define MNT_VNODE_FOREACH_ALL(vp, mp, mvp) \ 204 for (vp = __mnt_vnode_first_all(&(mvp), (mp)); \ 205 (vp) != NULL; vp = __mnt_vnode_next_all(&(mvp), (mp))) 206 207#define MNT_VNODE_FOREACH_ALL_ABORT(mp, mvp) \ 208 do { \ 209 MNT_ILOCK(mp); \ 210 __mnt_vnode_markerfree_all(&(mvp), (mp)); \ 211 /* MNT_IUNLOCK(mp); -- done in above function */ \ 212 mtx_assert(MNT_MTX(mp), MA_NOTOWNED); \ 213 } while (0) 214 215/* 216 * Definitions for MNT_VNODE_FOREACH_ACTIVE. 217 */ 218struct vnode *__mnt_vnode_next_active(struct vnode **mvp, struct mount *mp); 219struct vnode *__mnt_vnode_first_active(struct vnode **mvp, struct mount *mp); 220void __mnt_vnode_markerfree_active(struct vnode **mvp, struct mount *); 221 222#define MNT_VNODE_FOREACH_ACTIVE(vp, mp, mvp) \ 223 for (vp = __mnt_vnode_first_active(&(mvp), (mp)); \ 224 (vp) != NULL; vp = __mnt_vnode_next_active(&(mvp), (mp))) 225 226#define MNT_VNODE_FOREACH_ACTIVE_ABORT(mp, mvp) \ 227 __mnt_vnode_markerfree_active(&(mvp), (mp)) 228 229#define MNT_ILOCK(mp) mtx_lock(&(mp)->mnt_mtx) 230#define MNT_ITRYLOCK(mp) mtx_trylock(&(mp)->mnt_mtx) 231#define MNT_IUNLOCK(mp) mtx_unlock(&(mp)->mnt_mtx) 232#define MNT_MTX(mp) (&(mp)->mnt_mtx) 233#define MNT_REF(mp) (mp)->mnt_ref++ 234#define MNT_REL(mp) do { \ 235 KASSERT((mp)->mnt_ref > 0, ("negative mnt_ref")); \ 236 (mp)->mnt_ref--; \ 237 if ((mp)->mnt_ref == 0) \ 238 wakeup((mp)); \ 239} while (0) 240 241#endif /* _KERNEL */ 242 243/* 244 * User specifiable flags, stored in mnt_flag. 245 */ 246#define MNT_RDONLY 0x0000000000000001ULL /* read only filesystem */ 247#define MNT_SYNCHRONOUS 0x0000000000000002ULL /* fs written synchronously */ 248#define MNT_NOEXEC 0x0000000000000004ULL /* can't exec from filesystem */ 249#define MNT_NOSUID 0x0000000000000008ULL /* don't honor setuid fs bits */ 250#define MNT_NFS4ACLS 0x0000000000000010ULL /* enable NFS version 4 ACLs */ 251#define MNT_UNION 0x0000000000000020ULL /* union with underlying fs */ 252#define MNT_ASYNC 0x0000000000000040ULL /* fs written asynchronously */ 253#define MNT_SUIDDIR 0x0000000000100000ULL /* special SUID dir handling */ 254#define MNT_SOFTDEP 0x0000000000200000ULL /* using soft updates */ 255#define MNT_NOSYMFOLLOW 0x0000000000400000ULL /* do not follow symlinks */ 256#define MNT_GJOURNAL 0x0000000002000000ULL /* GEOM journal support enabled */ 257#define MNT_MULTILABEL 0x0000000004000000ULL /* MAC support for objects */ 258#define MNT_ACLS 0x0000000008000000ULL /* ACL support enabled */ 259#define MNT_NOATIME 0x0000000010000000ULL /* dont update file access time */ 260#define MNT_NOCLUSTERR 0x0000000040000000ULL /* disable cluster read */ 261#define MNT_NOCLUSTERW 0x0000000080000000ULL /* disable cluster write */ 262#define MNT_SUJ 0x0000000100000000ULL /* using journaled soft updates */ 263#define MNT_AUTOMOUNTED 0x0000000200000000ULL /* mounted by automountd(8) */ 264 265/* 266 * NFS export related mount flags. 267 */ 268#define MNT_EXRDONLY 0x0000000000000080ULL /* exported read only */ 269#define MNT_EXPORTED 0x0000000000000100ULL /* filesystem is exported */ 270#define MNT_DEFEXPORTED 0x0000000000000200ULL /* exported to the world */ 271#define MNT_EXPORTANON 0x0000000000000400ULL /* anon uid mapping for all */ 272#define MNT_EXKERB 0x0000000000000800ULL /* exported with Kerberos */ 273#define MNT_EXPUBLIC 0x0000000020000000ULL /* public export (WebNFS) */ 274 275/* 276 * Flags set by internal operations, 277 * but visible to the user. 278 * XXX some of these are not quite right.. (I've never seen the root flag set) 279 */ 280#define MNT_LOCAL 0x0000000000001000ULL /* filesystem is stored locally */ 281#define MNT_QUOTA 0x0000000000002000ULL /* quotas are enabled on fs */ 282#define MNT_ROOTFS 0x0000000000004000ULL /* identifies the root fs */ 283#define MNT_USER 0x0000000000008000ULL /* mounted by a user */ 284#define MNT_IGNORE 0x0000000000800000ULL /* do not show entry in df */ 285 286/* 287 * Mask of flags that are visible to statfs(). 288 * XXX I think that this could now become (~(MNT_CMDFLAGS)) 289 * but the 'mount' program may need changing to handle this. 290 */ 291#define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \ 292 MNT_NOSUID | MNT_UNION | MNT_SUJ | \ 293 MNT_ASYNC | MNT_EXRDONLY | MNT_EXPORTED | \ 294 MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB | \ 295 MNT_LOCAL | MNT_USER | MNT_QUOTA | \ 296 MNT_ROOTFS | MNT_NOATIME | MNT_NOCLUSTERR| \ 297 MNT_NOCLUSTERW | MNT_SUIDDIR | MNT_SOFTDEP | \ 298 MNT_IGNORE | MNT_EXPUBLIC | MNT_NOSYMFOLLOW | \ 299 MNT_GJOURNAL | MNT_MULTILABEL | MNT_ACLS | \ 300 MNT_NFS4ACLS | MNT_AUTOMOUNTED) 301 302/* Mask of flags that can be updated. */ 303#define MNT_UPDATEMASK (MNT_NOSUID | MNT_NOEXEC | \ 304 MNT_SYNCHRONOUS | MNT_UNION | MNT_ASYNC | \ 305 MNT_NOATIME | \ 306 MNT_NOSYMFOLLOW | MNT_IGNORE | \ 307 MNT_NOCLUSTERR | MNT_NOCLUSTERW | MNT_SUIDDIR | \ 308 MNT_ACLS | MNT_USER | MNT_NFS4ACLS | \ 309 MNT_AUTOMOUNTED) 310 311/* 312 * External filesystem command modifier flags. 313 * Unmount can use the MNT_FORCE flag. 314 * XXX: These are not STATES and really should be somewhere else. 315 * XXX: MNT_BYFSID collides with MNT_ACLS, but because MNT_ACLS is only used for 316 * mount(2) and MNT_BYFSID is only used for unmount(2) it's harmless. 317 */ 318#define MNT_UPDATE 0x0000000000010000ULL /* not real mount, just update */ 319#define MNT_DELEXPORT 0x0000000000020000ULL /* delete export host lists */ 320#define MNT_RELOAD 0x0000000000040000ULL /* reload filesystem data */ 321#define MNT_FORCE 0x0000000000080000ULL /* force unmount or readonly */ 322#define MNT_SNAPSHOT 0x0000000001000000ULL /* snapshot the filesystem */ 323#define MNT_BYFSID 0x0000000008000000ULL /* specify filesystem by ID. */ 324#define MNT_CMDFLAGS (MNT_UPDATE | MNT_DELEXPORT | MNT_RELOAD | \ 325 MNT_FORCE | MNT_SNAPSHOT | MNT_BYFSID) 326/* 327 * Internal filesystem control flags stored in mnt_kern_flag. 328 * 329 * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed 330 * past the mount point. This keeps the subtree stable during mounts 331 * and unmounts. 332 * 333 * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while 334 * dounmount() is still waiting to lock the mountpoint. This allows 335 * the filesystem to cancel operations that might otherwise deadlock 336 * with the unmount attempt (used by NFS). 337 * 338 * MNTK_NOINSMNTQ is strict subset of MNTK_UNMOUNT. They are separated 339 * to allow for failed unmount attempt to restore the syncer vnode for 340 * the mount. 341 */ 342#define MNTK_UNMOUNTF 0x00000001 /* forced unmount in progress */ 343#define MNTK_ASYNC 0x00000002 /* filtered async flag */ 344#define MNTK_SOFTDEP 0x00000004 /* async disabled by softdep */ 345#define MNTK_NOINSMNTQ 0x00000008 /* insmntque is not allowed */ 346#define MNTK_DRAINING 0x00000010 /* lock draining is happening */ 347#define MNTK_REFEXPIRE 0x00000020 /* refcount expiring is happening */ 348#define MNTK_EXTENDED_SHARED 0x00000040 /* Allow shared locking for more ops */ 349#define MNTK_SHARED_WRITES 0x00000080 /* Allow shared locking for writes */ 350#define MNTK_NO_IOPF 0x00000100 /* Disallow page faults during reads 351 and writes. Filesystem shall properly 352 handle i/o state on EFAULT. */ 353#define MNTK_VGONE_UPPER 0x00000200 354#define MNTK_VGONE_WAITER 0x00000400 355#define MNTK_LOOKUP_EXCL_DOTDOT 0x00000800 356#define MNTK_MARKER 0x00001000 357#define MNTK_UNMAPPED_BUFS 0x00002000 358#define MNTK_USES_BCACHE 0x00004000 /* FS uses the buffer cache. */ 359#define MNTK_NOASYNC 0x00800000 /* disable async */ 360#define MNTK_UNMOUNT 0x01000000 /* unmount in progress */ 361#define MNTK_MWAIT 0x02000000 /* waiting for unmount to finish */ 362#define MNTK_SUSPEND 0x08000000 /* request write suspension */ 363#define MNTK_SUSPEND2 0x04000000 /* block secondary writes */ 364#define MNTK_SUSPENDED 0x10000000 /* write operations are suspended */ 365#define MNTK_NULL_NOCACHE 0x20000000 /* auto disable cache for nullfs 366 mounts over this fs */ 367#define MNTK_LOOKUP_SHARED 0x40000000 /* FS supports shared lock lookups */ 368#define MNTK_NOKNOTE 0x80000000 /* Don't send KNOTEs from VOP hooks */ 369 370#ifdef _KERNEL 371static inline int 372MNT_SHARED_WRITES(struct mount *mp) 373{ 374 375 return (mp != NULL && (mp->mnt_kern_flag & MNTK_SHARED_WRITES) != 0); 376} 377 378static inline int 379MNT_EXTENDED_SHARED(struct mount *mp) 380{ 381 382 return (mp != NULL && (mp->mnt_kern_flag & MNTK_EXTENDED_SHARED) != 0); 383} 384#endif 385 386/* 387 * Sysctl CTL_VFS definitions. 388 * 389 * Second level identifier specifies which filesystem. Second level 390 * identifier VFS_VFSCONF returns information about all filesystems. 391 * Second level identifier VFS_GENERIC is non-terminal. 392 */ 393#define VFS_VFSCONF 0 /* get configured filesystems */ 394#define VFS_GENERIC 0 /* generic filesystem information */ 395/* 396 * Third level identifiers for VFS_GENERIC are given below; third 397 * level identifiers for specific filesystems are given in their 398 * mount specific header files. 399 */ 400#define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */ 401#define VFS_CONF 2 /* struct: vfsconf for filesystem given 402 as next argument */ 403 404/* 405 * Flags for various system call interfaces. 406 * 407 * waitfor flags to vfs_sync() and getfsstat() 408 */ 409#define MNT_WAIT 1 /* synchronously wait for I/O to complete */ 410#define MNT_NOWAIT 2 /* start all I/O, but do not wait for it */ 411#define MNT_LAZY 3 /* push data not written by filesystem syncer */ 412#define MNT_SUSPEND 4 /* Suspend file system after sync */ 413 414/* 415 * Generic file handle 416 */ 417struct fhandle { 418 fsid_t fh_fsid; /* Filesystem id of mount point */ 419 struct fid fh_fid; /* Filesys specific id */ 420}; 421typedef struct fhandle fhandle_t; 422 423/* 424 * Old export arguments without security flavor list 425 */ 426struct oexport_args { 427 int ex_flags; /* export related flags */ 428 uid_t ex_root; /* mapping for root uid */ 429 struct xucred ex_anon; /* mapping for anonymous user */ 430 struct sockaddr *ex_addr; /* net address to which exported */ 431 u_char ex_addrlen; /* and the net address length */ 432 struct sockaddr *ex_mask; /* mask of valid bits in saddr */ 433 u_char ex_masklen; /* and the smask length */ 434 char *ex_indexfile; /* index file for WebNFS URLs */ 435}; 436 437/* 438 * Export arguments for local filesystem mount calls. 439 */ 440#define MAXSECFLAVORS 5 441struct export_args { 442 int ex_flags; /* export related flags */ 443 uid_t ex_root; /* mapping for root uid */ 444 struct xucred ex_anon; /* mapping for anonymous user */ 445 struct sockaddr *ex_addr; /* net address to which exported */ 446 u_char ex_addrlen; /* and the net address length */ 447 struct sockaddr *ex_mask; /* mask of valid bits in saddr */ 448 u_char ex_masklen; /* and the smask length */ 449 char *ex_indexfile; /* index file for WebNFS URLs */ 450 int ex_numsecflavors; /* security flavor count */ 451 int ex_secflavors[MAXSECFLAVORS]; /* list of security flavors */ 452}; 453 454/* 455 * Structure holding information for a publicly exported filesystem 456 * (WebNFS). Currently the specs allow just for one such filesystem. 457 */ 458struct nfs_public { 459 int np_valid; /* Do we hold valid information */ 460 fhandle_t np_handle; /* Filehandle for pub fs (internal) */ 461 struct mount *np_mount; /* Mountpoint of exported fs */ 462 char *np_index; /* Index file */ 463}; 464 465/* 466 * Filesystem configuration information. One of these exists for each 467 * type of filesystem supported by the kernel. These are searched at 468 * mount time to identify the requested filesystem. 469 * 470 * XXX: Never change the first two arguments! 471 */ 472struct vfsconf { 473 u_int vfc_version; /* ABI version number */ 474 char vfc_name[MFSNAMELEN]; /* filesystem type name */ 475 struct vfsops *vfc_vfsops; /* filesystem operations vector */ 476 int vfc_typenum; /* historic filesystem type number */ 477 int vfc_refcount; /* number mounted of this type */ 478 int vfc_flags; /* permanent flags */ 479 struct vfsoptdecl *vfc_opts; /* mount options */ 480 TAILQ_ENTRY(vfsconf) vfc_list; /* list of vfscons */ 481}; 482 483/* Userland version of the struct vfsconf. */ 484struct xvfsconf { 485 struct vfsops *vfc_vfsops; /* filesystem operations vector */ 486 char vfc_name[MFSNAMELEN]; /* filesystem type name */ 487 int vfc_typenum; /* historic filesystem type number */ 488 int vfc_refcount; /* number mounted of this type */ 489 int vfc_flags; /* permanent flags */ 490 struct vfsconf *vfc_next; /* next in list */ 491}; 492 493#ifndef BURN_BRIDGES 494struct ovfsconf { 495 void *vfc_vfsops; 496 char vfc_name[32]; 497 int vfc_index; 498 int vfc_refcount; 499 int vfc_flags; 500}; 501#endif 502 503/* 504 * NB: these flags refer to IMPLEMENTATION properties, not properties of 505 * any actual mounts; i.e., it does not make sense to change the flags. 506 */ 507#define VFCF_STATIC 0x00010000 /* statically compiled into kernel */ 508#define VFCF_NETWORK 0x00020000 /* may get data over the network */ 509#define VFCF_READONLY 0x00040000 /* writes are not implemented */ 510#define VFCF_SYNTHETIC 0x00080000 /* data does not represent real files */ 511#define VFCF_LOOPBACK 0x00100000 /* aliases some other mounted FS */ 512#define VFCF_UNICODE 0x00200000 /* stores file names as Unicode */ 513#define VFCF_JAIL 0x00400000 /* can be mounted from within a jail */ 514#define VFCF_DELEGADMIN 0x00800000 /* supports delegated administration */ 515#define VFCF_SBDRY 0x01000000 /* defer stop requests */ 516 517typedef uint32_t fsctlop_t; 518 519struct vfsidctl { 520 int vc_vers; /* should be VFSIDCTL_VERS1 (below) */ 521 fsid_t vc_fsid; /* fsid to operate on */ 522 char vc_fstypename[MFSNAMELEN]; 523 /* type of fs 'nfs' or '*' */ 524 fsctlop_t vc_op; /* operation VFS_CTL_* (below) */ 525 void *vc_ptr; /* pointer to data structure */ 526 size_t vc_len; /* sizeof said structure */ 527 u_int32_t vc_spare[12]; /* spare (must be zero) */ 528}; 529 530/* vfsidctl API version. */ 531#define VFS_CTL_VERS1 0x01 532 533/* 534 * New style VFS sysctls, do not reuse/conflict with the namespace for 535 * private sysctls. 536 * All "global" sysctl ops have the 33rd bit set: 537 * 0x...1.... 538 * Private sysctl ops should have the 33rd bit unset. 539 */ 540#define VFS_CTL_QUERY 0x00010001 /* anything wrong? (vfsquery) */ 541#define VFS_CTL_TIMEO 0x00010002 /* set timeout for vfs notification */ 542#define VFS_CTL_NOLOCKS 0x00010003 /* disable file locking */ 543 544struct vfsquery { 545 u_int32_t vq_flags; 546 u_int32_t vq_spare[31]; 547}; 548 549/* vfsquery flags */ 550#define VQ_NOTRESP 0x0001 /* server down */ 551#define VQ_NEEDAUTH 0x0002 /* server bad auth */ 552#define VQ_LOWDISK 0x0004 /* we're low on space */ 553#define VQ_MOUNT 0x0008 /* new filesystem arrived */ 554#define VQ_UNMOUNT 0x0010 /* filesystem has left */ 555#define VQ_DEAD 0x0020 /* filesystem is dead, needs force unmount */ 556#define VQ_ASSIST 0x0040 /* filesystem needs assistance from external 557 program */ 558#define VQ_NOTRESPLOCK 0x0080 /* server lockd down */ 559#define VQ_FLAG0100 0x0100 /* placeholder */ 560#define VQ_FLAG0200 0x0200 /* placeholder */ 561#define VQ_FLAG0400 0x0400 /* placeholder */ 562#define VQ_FLAG0800 0x0800 /* placeholder */ 563#define VQ_FLAG1000 0x1000 /* placeholder */ 564#define VQ_FLAG2000 0x2000 /* placeholder */ 565#define VQ_FLAG4000 0x4000 /* placeholder */ 566#define VQ_FLAG8000 0x8000 /* placeholder */ 567 568#ifdef _KERNEL 569/* Point a sysctl request at a vfsidctl's data. */ 570#define VCTLTOREQ(vc, req) \ 571 do { \ 572 (req)->newptr = (vc)->vc_ptr; \ 573 (req)->newlen = (vc)->vc_len; \ 574 (req)->newidx = 0; \ 575 } while (0) 576#endif 577 578struct iovec; 579struct uio; 580 581#ifdef _KERNEL 582 583/* 584 * vfs_busy specific flags and mask. 585 */ 586#define MBF_NOWAIT 0x01 587#define MBF_MNTLSTLOCK 0x02 588#define MBF_MASK (MBF_NOWAIT | MBF_MNTLSTLOCK) 589 590#ifdef MALLOC_DECLARE 591MALLOC_DECLARE(M_MOUNT); 592#endif 593extern int maxvfsconf; /* highest defined filesystem type */ 594extern int nfs_mount_type; /* vfc_typenum for nfs, or -1 */ 595 596TAILQ_HEAD(vfsconfhead, vfsconf); 597extern struct vfsconfhead vfsconf; 598 599/* 600 * Operations supported on mounted filesystem. 601 */ 602struct mount_args; 603struct nameidata; 604struct sysctl_req; 605struct mntarg; 606 607typedef int vfs_cmount_t(struct mntarg *ma, void *data, uint64_t flags); 608typedef int vfs_unmount_t(struct mount *mp, int mntflags); 609typedef int vfs_root_t(struct mount *mp, int flags, struct vnode **vpp); 610typedef int vfs_quotactl_t(struct mount *mp, int cmds, uid_t uid, void *arg); 611typedef int vfs_statfs_t(struct mount *mp, struct statfs *sbp); 612typedef int vfs_sync_t(struct mount *mp, int waitfor); 613typedef int vfs_vget_t(struct mount *mp, ino_t ino, int flags, 614 struct vnode **vpp); 615typedef int vfs_fhtovp_t(struct mount *mp, struct fid *fhp, 616 int flags, struct vnode **vpp); 617typedef int vfs_checkexp_t(struct mount *mp, struct sockaddr *nam, 618 int *extflagsp, struct ucred **credanonp, 619 int *numsecflavors, int **secflavors); 620typedef int vfs_init_t(struct vfsconf *); 621typedef int vfs_uninit_t(struct vfsconf *); 622typedef int vfs_extattrctl_t(struct mount *mp, int cmd, 623 struct vnode *filename_vp, int attrnamespace, 624 const char *attrname); 625typedef int vfs_mount_t(struct mount *mp); 626typedef int vfs_sysctl_t(struct mount *mp, fsctlop_t op, 627 struct sysctl_req *req); 628typedef void vfs_susp_clean_t(struct mount *mp); 629typedef void vfs_notify_lowervp_t(struct mount *mp, struct vnode *lowervp); 630typedef void vfs_purge_t(struct mount *mp); 631 632struct vfsops { 633 vfs_mount_t *vfs_mount; 634 vfs_cmount_t *vfs_cmount; 635 vfs_unmount_t *vfs_unmount; 636 vfs_root_t *vfs_root; 637 vfs_quotactl_t *vfs_quotactl; 638 vfs_statfs_t *vfs_statfs; 639 vfs_sync_t *vfs_sync; 640 vfs_vget_t *vfs_vget; 641 vfs_fhtovp_t *vfs_fhtovp; 642 vfs_checkexp_t *vfs_checkexp; 643 vfs_init_t *vfs_init; 644 vfs_uninit_t *vfs_uninit; 645 vfs_extattrctl_t *vfs_extattrctl; 646 vfs_sysctl_t *vfs_sysctl; 647 vfs_susp_clean_t *vfs_susp_clean; 648 vfs_notify_lowervp_t *vfs_reclaim_lowervp; 649 vfs_notify_lowervp_t *vfs_unlink_lowervp; 650 vfs_purge_t *vfs_purge; 651 vfs_mount_t *vfs_spare[6]; /* spares for ABI compat */ 652}; 653 654vfs_statfs_t __vfs_statfs; 655 656#define VFS_PROLOGUE(MP) do { \ 657 struct mount *mp__; \ 658 int _enable_stops; \ 659 \ 660 mp__ = (MP); \ 661 _enable_stops = (mp__ != NULL && \ 662 (mp__->mnt_vfc->vfc_flags & VFCF_SBDRY) && sigdeferstop()) 663 664#define VFS_EPILOGUE(MP) \ 665 if (_enable_stops) \ 666 sigallowstop(); \ 667} while (0) 668 669#define VFS_MOUNT(MP) ({ \ 670 int _rc; \ 671 \ 672 VFS_PROLOGUE(MP); \ 673 _rc = (*(MP)->mnt_op->vfs_mount)(MP); \ 674 VFS_EPILOGUE(MP); \ 675 _rc; }) 676 677#define VFS_UNMOUNT(MP, FORCE) ({ \ 678 int _rc; \ 679 \ 680 VFS_PROLOGUE(MP); \ 681 _rc = (*(MP)->mnt_op->vfs_unmount)(MP, FORCE); \ 682 VFS_EPILOGUE(MP); \ 683 _rc; }) 684 685#define VFS_ROOT(MP, FLAGS, VPP) ({ \ 686 int _rc; \ 687 \ 688 VFS_PROLOGUE(MP); \ 689 _rc = (*(MP)->mnt_op->vfs_root)(MP, FLAGS, VPP); \ 690 VFS_EPILOGUE(MP); \ 691 _rc; }) 692 693#define VFS_QUOTACTL(MP, C, U, A) ({ \ 694 int _rc; \ 695 \ 696 VFS_PROLOGUE(MP); \ 697 _rc = (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A); \ 698 VFS_EPILOGUE(MP); \ 699 _rc; }) 700 701#define VFS_STATFS(MP, SBP) ({ \ 702 int _rc; \ 703 \ 704 VFS_PROLOGUE(MP); \ 705 _rc = __vfs_statfs((MP), (SBP)); \ 706 VFS_EPILOGUE(MP); \ 707 _rc; }) 708 709#define VFS_SYNC(MP, WAIT) ({ \ 710 int _rc; \ 711 \ 712 VFS_PROLOGUE(MP); \ 713 _rc = (*(MP)->mnt_op->vfs_sync)(MP, WAIT); \ 714 VFS_EPILOGUE(MP); \ 715 _rc; }) 716 717#define VFS_VGET(MP, INO, FLAGS, VPP) ({ \ 718 int _rc; \ 719 \ 720 VFS_PROLOGUE(MP); \ 721 _rc = (*(MP)->mnt_op->vfs_vget)(MP, INO, FLAGS, VPP); \ 722 VFS_EPILOGUE(MP); \ 723 _rc; }) 724 725#define VFS_FHTOVP(MP, FIDP, FLAGS, VPP) ({ \ 726 int _rc; \ 727 \ 728 VFS_PROLOGUE(MP); \ 729 _rc = (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, FLAGS, VPP); \ 730 VFS_EPILOGUE(MP); \ 731 _rc; }) 732 733#define VFS_CHECKEXP(MP, NAM, EXFLG, CRED, NUMSEC, SEC) ({ \ 734 int _rc; \ 735 \ 736 VFS_PROLOGUE(MP); \ 737 _rc = (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED, NUMSEC,\ 738 SEC); \ 739 VFS_EPILOGUE(MP); \ 740 _rc; }) 741 742#define VFS_EXTATTRCTL(MP, C, FN, NS, N) ({ \ 743 int _rc; \ 744 \ 745 VFS_PROLOGUE(MP); \ 746 _rc = (*(MP)->mnt_op->vfs_extattrctl)(MP, C, FN, NS, N); \ 747 VFS_EPILOGUE(MP); \ 748 _rc; }) 749 750#define VFS_SYSCTL(MP, OP, REQ) ({ \ 751 int _rc; \ 752 \ 753 VFS_PROLOGUE(MP); \ 754 _rc = (*(MP)->mnt_op->vfs_sysctl)(MP, OP, REQ); \ 755 VFS_EPILOGUE(MP); \ 756 _rc; }) 757 758#define VFS_SUSP_CLEAN(MP) do { \ 759 if (*(MP)->mnt_op->vfs_susp_clean != NULL) { \ 760 VFS_PROLOGUE(MP); \ 761 (*(MP)->mnt_op->vfs_susp_clean)(MP); \ 762 VFS_EPILOGUE(MP); \ 763 } \ 764} while (0) 765 766#define VFS_RECLAIM_LOWERVP(MP, VP) do { \ 767 if (*(MP)->mnt_op->vfs_reclaim_lowervp != NULL) { \ 768 VFS_PROLOGUE(MP); \ 769 (*(MP)->mnt_op->vfs_reclaim_lowervp)((MP), (VP)); \ 770 VFS_EPILOGUE(MP); \ 771 } \ 772} while (0) 773 774#define VFS_UNLINK_LOWERVP(MP, VP) do { \ 775 if (*(MP)->mnt_op->vfs_unlink_lowervp != NULL) { \ 776 VFS_PROLOGUE(MP); \ 777 (*(MP)->mnt_op->vfs_unlink_lowervp)((MP), (VP)); \ 778 VFS_EPILOGUE(MP); \ 779 } \ 780} while (0) 781 782#define VFS_PURGE(MP) do { \ 783 if (*(MP)->mnt_op->vfs_purge != NULL) { \ 784 VFS_PROLOGUE(MP); \ 785 (*(MP)->mnt_op->vfs_purge)(MP); \ 786 VFS_EPILOGUE(MP); \ 787 } \ 788} while (0) 789 790#define VFS_KNOTE_LOCKED(vp, hint) do \ 791{ \ 792 if (((vp)->v_vflag & VV_NOKNOTE) == 0) \ 793 VN_KNOTE((vp), (hint), KNF_LISTLOCKED); \ 794} while (0) 795 796#define VFS_KNOTE_UNLOCKED(vp, hint) do \ 797{ \ 798 if (((vp)->v_vflag & VV_NOKNOTE) == 0) \ 799 VN_KNOTE((vp), (hint), 0); \ 800} while (0) 801 802#define VFS_NOTIFY_UPPER_RECLAIM 1 803#define VFS_NOTIFY_UPPER_UNLINK 2 804 805#include <sys/module.h> 806 807/* 808 * Version numbers. 809 */ 810#define VFS_VERSION_00 0x19660120 811#define VFS_VERSION_01 0x20121030 812#define VFS_VERSION VFS_VERSION_01 813 814#define VFS_SET(vfsops, fsname, flags) \ 815 static struct vfsconf fsname ## _vfsconf = { \ 816 .vfc_version = VFS_VERSION, \ 817 .vfc_name = #fsname, \ 818 .vfc_vfsops = &vfsops, \ 819 .vfc_typenum = -1, \ 820 .vfc_flags = flags, \ 821 }; \ 822 static moduledata_t fsname ## _mod = { \ 823 #fsname, \ 824 vfs_modevent, \ 825 & fsname ## _vfsconf \ 826 }; \ 827 DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE) 828 829extern char *mountrootfsname; 830 831/* 832 * exported vnode operations 833 */ 834 835int dounmount(struct mount *, int, struct thread *); 836 837int kernel_mount(struct mntarg *ma, uint64_t flags); 838int kernel_vmount(int flags, ...); 839struct mntarg *mount_arg(struct mntarg *ma, const char *name, const void *val, int len); 840struct mntarg *mount_argb(struct mntarg *ma, int flag, const char *name); 841struct mntarg *mount_argf(struct mntarg *ma, const char *name, const char *fmt, ...); 842struct mntarg *mount_argsu(struct mntarg *ma, const char *name, const void *val, int len); 843void statfs_scale_blocks(struct statfs *sf, long max_size); 844struct vfsconf *vfs_byname(const char *); 845struct vfsconf *vfs_byname_kld(const char *, struct thread *td, int *); 846void vfs_mount_destroy(struct mount *); 847void vfs_event_signal(fsid_t *, u_int32_t, intptr_t); 848void vfs_freeopts(struct vfsoptlist *opts); 849void vfs_deleteopt(struct vfsoptlist *opts, const char *name); 850int vfs_buildopts(struct uio *auio, struct vfsoptlist **options); 851int vfs_flagopt(struct vfsoptlist *opts, const char *name, uint64_t *w, 852 uint64_t val); 853int vfs_getopt(struct vfsoptlist *, const char *, void **, int *); 854int vfs_getopt_pos(struct vfsoptlist *opts, const char *name); 855int vfs_getopt_size(struct vfsoptlist *opts, const char *name, 856 off_t *value); 857char *vfs_getopts(struct vfsoptlist *, const char *, int *error); 858int vfs_copyopt(struct vfsoptlist *, const char *, void *, int); 859int vfs_filteropt(struct vfsoptlist *, const char **legal); 860void vfs_opterror(struct vfsoptlist *opts, const char *fmt, ...); 861int vfs_scanopt(struct vfsoptlist *opts, const char *name, const char *fmt, ...); 862int vfs_setopt(struct vfsoptlist *opts, const char *name, void *value, 863 int len); 864int vfs_setopt_part(struct vfsoptlist *opts, const char *name, void *value, 865 int len); 866int vfs_setopts(struct vfsoptlist *opts, const char *name, 867 const char *value); 868int vfs_setpublicfs /* set publicly exported fs */ 869 (struct mount *, struct netexport *, struct export_args *); 870void vfs_msync(struct mount *, int); 871int vfs_busy(struct mount *, int); 872int vfs_export /* process mount export info */ 873 (struct mount *, struct export_args *); 874void vfs_allocate_syncvnode(struct mount *); 875void vfs_deallocate_syncvnode(struct mount *); 876int vfs_donmount(struct thread *td, uint64_t fsflags, 877 struct uio *fsoptions); 878void vfs_getnewfsid(struct mount *); 879struct cdev *vfs_getrootfsid(struct mount *); 880struct mount *vfs_getvfs(fsid_t *); /* return vfs given fsid */ 881struct mount *vfs_busyfs(fsid_t *); 882int vfs_modevent(module_t, int, void *); 883void vfs_mount_error(struct mount *, const char *, ...); 884void vfs_mountroot(void); /* mount our root filesystem */ 885void vfs_mountedfrom(struct mount *, const char *from); 886void vfs_notify_upper(struct vnode *, int); 887void vfs_oexport_conv(const struct oexport_args *oexp, 888 struct export_args *exp); 889void vfs_ref(struct mount *); 890void vfs_rel(struct mount *); 891struct mount *vfs_mount_alloc(struct vnode *, struct vfsconf *, const char *, 892 struct ucred *); 893int vfs_suser(struct mount *, struct thread *); 894void vfs_unbusy(struct mount *); 895void vfs_unmountall(void); 896extern TAILQ_HEAD(mntlist, mount) mountlist; /* mounted filesystem list */ 897extern struct mtx mountlist_mtx; 898extern struct nfs_public nfs_pub; 899extern struct sx vfsconf_sx; 900#define vfsconf_lock() sx_xlock(&vfsconf_sx) 901#define vfsconf_unlock() sx_xunlock(&vfsconf_sx) 902#define vfsconf_slock() sx_slock(&vfsconf_sx) 903#define vfsconf_sunlock() sx_sunlock(&vfsconf_sx) 904 905/* 906 * Declarations for these vfs default operations are located in 907 * kern/vfs_default.c. They will be automatically used to replace 908 * null entries in VFS ops tables when registering a new filesystem 909 * type in the global table. 910 */ 911vfs_root_t vfs_stdroot; 912vfs_quotactl_t vfs_stdquotactl; 913vfs_statfs_t vfs_stdstatfs; 914vfs_sync_t vfs_stdsync; 915vfs_sync_t vfs_stdnosync; 916vfs_vget_t vfs_stdvget; 917vfs_fhtovp_t vfs_stdfhtovp; 918vfs_checkexp_t vfs_stdcheckexp; 919vfs_init_t vfs_stdinit; 920vfs_uninit_t vfs_stduninit; 921vfs_extattrctl_t vfs_stdextattrctl; 922vfs_sysctl_t vfs_stdsysctl; 923 924void syncer_suspend(void); 925void syncer_resume(void); 926 927#else /* !_KERNEL */ 928 929#include <sys/cdefs.h> 930 931struct stat; 932 933__BEGIN_DECLS 934int fhopen(const struct fhandle *, int); 935int fhstat(const struct fhandle *, struct stat *); 936int fhstatfs(const struct fhandle *, struct statfs *); 937int fstatfs(int, struct statfs *); 938int getfh(const char *, fhandle_t *); 939int getfsstat(struct statfs *, long, int); 940int getmntinfo(struct statfs **, int); 941int lgetfh(const char *, fhandle_t *); 942int mount(const char *, const char *, int, void *); 943int nmount(struct iovec *, unsigned int, int); 944int statfs(const char *, struct statfs *); 945int unmount(const char *, int); 946 947/* C library stuff */ 948int getvfsbyname(const char *, struct xvfsconf *); 949__END_DECLS 950 951#endif /* _KERNEL */ 952 953#endif /* !_SYS_MOUNT_H_ */ 954