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