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