mount.h revision 189290
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 189290 2009-03-02 23:26:30Z jamie $ 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_reserved; /* 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 * 152 * Unmarked fields are considered stable as long as a ref is held. 153 * 154 */ 155struct mount { 156 struct mtx mnt_mtx; /* mount structure interlock */ 157 int mnt_gen; /* struct mount generation */ 158#define mnt_startzero mnt_list 159 TAILQ_ENTRY(mount) mnt_list; /* (m) mount list */ 160 struct vfsops *mnt_op; /* operations on fs */ 161 struct vfsconf *mnt_vfc; /* configuration info */ 162 struct vnode *mnt_vnodecovered; /* vnode we mounted on */ 163 struct vnode *mnt_syncer; /* syncer vnode */ 164 int mnt_ref; /* (i) Reference count */ 165 struct vnodelst mnt_nvnodelist; /* (i) list of vnodes */ 166 int mnt_nvnodelistsize; /* (i) # of vnodes */ 167 int mnt_writeopcount; /* (i) write syscalls pending */ 168 int mnt_kern_flag; /* (i) kernel only flags */ 169 u_int mnt_flag; /* (i) flags shared with user */ 170 u_int mnt_noasync; /* (i) # noasync overrides */ 171 struct vfsoptlist *mnt_opt; /* current mount options */ 172 struct vfsoptlist *mnt_optnew; /* new options passed to fs */ 173 int mnt_maxsymlinklen; /* max size of short symlink */ 174 struct statfs mnt_stat; /* cache of filesystem stats */ 175 struct ucred *mnt_cred; /* credentials of mounter */ 176 void * mnt_data; /* private data */ 177 time_t mnt_time; /* last time written*/ 178 int mnt_iosize_max; /* max size for clusters, etc */ 179 struct netexport *mnt_export; /* export list */ 180 struct label *mnt_label; /* MAC label for the fs */ 181 u_int mnt_hashseed; /* Random seed for vfs_hash */ 182 int mnt_lockref; /* (i) Lock reference count */ 183 int mnt_secondary_writes; /* (i) # of secondary writes */ 184 int mnt_secondary_accwrites;/* (i) secondary wr. starts */ 185 struct thread *mnt_susp_owner; /* (i) thread owning suspension */ 186#define mnt_endzero mnt_gjprovider 187 char *mnt_gjprovider; /* gjournal provider name */ 188 struct lock mnt_explock; /* vfs_export walkers lock */ 189}; 190 191struct vnode *__mnt_vnode_next(struct vnode **mvp, struct mount *mp); 192struct vnode *__mnt_vnode_first(struct vnode **mvp, struct mount *mp); 193void __mnt_vnode_markerfree(struct vnode **mvp, struct mount *mp); 194 195#define MNT_VNODE_FOREACH(vp, mp, mvp) \ 196 for (vp = __mnt_vnode_first(&(mvp), (mp)); \ 197 (vp) != NULL; vp = __mnt_vnode_next(&(mvp), (mp))) 198 199#define MNT_VNODE_FOREACH_ABORT_ILOCKED(mp, mvp) \ 200 __mnt_vnode_markerfree(&(mvp), (mp)) 201 202#define MNT_VNODE_FOREACH_ABORT(mp, mvp) \ 203 do { \ 204 MNT_ILOCK(mp); \ 205 MNT_VNODE_FOREACH_ABORT_ILOCKED(mp, mvp); \ 206 MNT_IUNLOCK(mp); \ 207 } while (0) 208 209#define MNT_ILOCK(mp) mtx_lock(&(mp)->mnt_mtx) 210#define MNT_ITRYLOCK(mp) mtx_trylock(&(mp)->mnt_mtx) 211#define MNT_IUNLOCK(mp) mtx_unlock(&(mp)->mnt_mtx) 212#define MNT_MTX(mp) (&(mp)->mnt_mtx) 213#define MNT_REF(mp) (mp)->mnt_ref++ 214#define MNT_REL(mp) do { \ 215 KASSERT((mp)->mnt_ref > 0, ("negative mnt_ref")); \ 216 (mp)->mnt_ref--; \ 217 if ((mp)->mnt_ref == 0) \ 218 wakeup((mp)); \ 219} while (0) 220 221#endif /* _KERNEL */ 222 223/* 224 * User specifiable flags. 225 */ 226#define MNT_RDONLY 0x00000001 /* read only filesystem */ 227#define MNT_SYNCHRONOUS 0x00000002 /* filesystem written synchronously */ 228#define MNT_NOEXEC 0x00000004 /* can't exec from filesystem */ 229#define MNT_NOSUID 0x00000008 /* don't honor setuid bits on fs */ 230#define MNT_UNION 0x00000020 /* union with underlying filesystem */ 231#define MNT_ASYNC 0x00000040 /* filesystem written asynchronously */ 232#define MNT_SUIDDIR 0x00100000 /* special handling of SUID on dirs */ 233#define MNT_SOFTDEP 0x00200000 /* soft updates being done */ 234#define MNT_NOSYMFOLLOW 0x00400000 /* do not follow symlinks */ 235#define MNT_GJOURNAL 0x02000000 /* GEOM journal support enabled */ 236#define MNT_MULTILABEL 0x04000000 /* MAC support for individual objects */ 237#define MNT_ACLS 0x08000000 /* ACL support enabled */ 238#define MNT_NOATIME 0x10000000 /* disable update of file access time */ 239#define MNT_NOCLUSTERR 0x40000000 /* disable cluster read */ 240#define MNT_NOCLUSTERW 0x80000000 /* disable cluster write */ 241 242/* 243 * NFS export related mount flags. 244 */ 245#define MNT_EXRDONLY 0x00000080 /* exported read only */ 246#define MNT_EXPORTED 0x00000100 /* filesystem is exported */ 247#define MNT_DEFEXPORTED 0x00000200 /* exported to the world */ 248#define MNT_EXPORTANON 0x00000400 /* use anon uid mapping for everyone */ 249#define MNT_EXKERB 0x00000800 /* exported with Kerberos uid mapping */ 250#define MNT_EXPUBLIC 0x20000000 /* public export (WebNFS) */ 251 252/* 253 * Flags set by internal operations, 254 * but visible to the user. 255 * XXX some of these are not quite right.. (I've never seen the root flag set) 256 */ 257#define MNT_LOCAL 0x00001000 /* filesystem is stored locally */ 258#define MNT_QUOTA 0x00002000 /* quotas are enabled on filesystem */ 259#define MNT_ROOTFS 0x00004000 /* identifies the root filesystem */ 260#define MNT_USER 0x00008000 /* mounted by a user */ 261#define MNT_IGNORE 0x00800000 /* do not show entry in df */ 262 263/* 264 * Mask of flags that are visible to statfs(). 265 * XXX I think that this could now become (~(MNT_CMDFLAGS)) 266 * but the 'mount' program may need changing to handle this. 267 */ 268#define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \ 269 MNT_NOSUID | MNT_UNION | \ 270 MNT_ASYNC | MNT_EXRDONLY | MNT_EXPORTED | \ 271 MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB | \ 272 MNT_LOCAL | MNT_USER | MNT_QUOTA | \ 273 MNT_ROOTFS | MNT_NOATIME | MNT_NOCLUSTERR| \ 274 MNT_NOCLUSTERW | MNT_SUIDDIR | MNT_SOFTDEP | \ 275 MNT_IGNORE | MNT_EXPUBLIC | MNT_NOSYMFOLLOW | \ 276 MNT_GJOURNAL | MNT_MULTILABEL | MNT_ACLS) 277 278/* Mask of flags that can be updated. */ 279#define MNT_UPDATEMASK (MNT_NOSUID | MNT_NOEXEC | \ 280 MNT_SYNCHRONOUS | MNT_UNION | MNT_ASYNC | \ 281 MNT_NOATIME | \ 282 MNT_NOSYMFOLLOW | MNT_IGNORE | \ 283 MNT_NOCLUSTERR | MNT_NOCLUSTERW | MNT_SUIDDIR | \ 284 MNT_ACLS | MNT_USER) 285 286/* 287 * External filesystem command modifier flags. 288 * Unmount can use the MNT_FORCE flag. 289 * XXX: These are not STATES and really should be somewhere else. 290 * XXX: MNT_BYFSID collides with MNT_ACLS, but because MNT_ACLS is only used for 291 * mount(2) and MNT_BYFSID is only used for unmount(2) it's harmless. 292 */ 293#define MNT_UPDATE 0x00010000 /* not a real mount, just an update */ 294#define MNT_DELEXPORT 0x00020000 /* delete export host lists */ 295#define MNT_RELOAD 0x00040000 /* reload filesystem data */ 296#define MNT_FORCE 0x00080000 /* force unmount or readonly change */ 297#define MNT_SNAPSHOT 0x01000000 /* snapshot the filesystem */ 298#define MNT_BYFSID 0x08000000 /* specify filesystem by ID. */ 299#define MNT_CMDFLAGS (MNT_UPDATE | MNT_DELEXPORT | MNT_RELOAD | \ 300 MNT_FORCE | MNT_SNAPSHOT | MNT_BYFSID) 301/* 302 * Still available. 303 */ 304#define MNT_SPARE_0x00000010 0x00000010 305/* 306 * Internal filesystem control flags stored in mnt_kern_flag. 307 * 308 * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed 309 * past the mount point. This keeps the subtree stable during mounts 310 * and unmounts. 311 * 312 * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while 313 * dounmount() is still waiting to lock the mountpoint. This allows 314 * the filesystem to cancel operations that might otherwise deadlock 315 * with the unmount attempt (used by NFS). 316 * 317 * MNTK_NOINSMNTQ is strict subset of MNTK_UNMOUNT. They are separated 318 * to allow for failed unmount attempt to restore the syncer vnode for 319 * the mount. 320 */ 321#define MNTK_UNMOUNTF 0x00000001 /* forced unmount in progress */ 322#define MNTK_ASYNC 0x00000002 /* filtered async flag */ 323#define MNTK_SOFTDEP 0x00000004 /* async disabled by softdep */ 324#define MNTK_NOINSMNTQ 0x00000008 /* insmntque is not allowed */ 325#define MNTK_DRAINING 0x00000010 /* lock draining is happening */ 326#define MNTK_REFEXPIRE 0x00000020 /* refcount expiring is happening */ 327#define MNTK_UNMOUNT 0x01000000 /* unmount in progress */ 328#define MNTK_MWAIT 0x02000000 /* waiting for unmount to finish */ 329#define MNTK_SUSPEND 0x08000000 /* request write suspension */ 330#define MNTK_SUSPEND2 0x04000000 /* block secondary writes */ 331#define MNTK_SUSPENDED 0x10000000 /* write operations are suspended */ 332#define MNTK_MPSAFE 0x20000000 /* Filesystem is MPSAFE. */ 333#define MNTK_NOKNOTE 0x80000000 /* Don't send KNOTEs from VOP hooks */ 334#define MNTK_LOOKUP_SHARED 0x40000000 /* FS supports shared lock lookups */ 335 336/* 337 * Sysctl CTL_VFS definitions. 338 * 339 * Second level identifier specifies which filesystem. Second level 340 * identifier VFS_VFSCONF returns information about all filesystems. 341 * Second level identifier VFS_GENERIC is non-terminal. 342 */ 343#define VFS_VFSCONF 0 /* get configured filesystems */ 344#define VFS_GENERIC 0 /* generic filesystem information */ 345/* 346 * Third level identifiers for VFS_GENERIC are given below; third 347 * level identifiers for specific filesystems are given in their 348 * mount specific header files. 349 */ 350#define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */ 351#define VFS_CONF 2 /* struct: vfsconf for filesystem given 352 as next argument */ 353 354/* 355 * Flags for various system call interfaces. 356 * 357 * waitfor flags to vfs_sync() and getfsstat() 358 */ 359#define MNT_WAIT 1 /* synchronously wait for I/O to complete */ 360#define MNT_NOWAIT 2 /* start all I/O, but do not wait for it */ 361#define MNT_LAZY 3 /* push data not written by filesystem syncer */ 362#define MNT_SUSPEND 4 /* Suspend file system after sync */ 363 364/* 365 * Generic file handle 366 */ 367struct fhandle { 368 fsid_t fh_fsid; /* Filesystem id of mount point */ 369 struct fid fh_fid; /* Filesys specific id */ 370}; 371typedef struct fhandle fhandle_t; 372 373/* 374 * Old export arguments without security flavor list 375 */ 376struct oexport_args { 377 int ex_flags; /* export related flags */ 378 uid_t ex_root; /* mapping for root uid */ 379 struct xucred ex_anon; /* mapping for anonymous user */ 380 struct sockaddr *ex_addr; /* net address to which exported */ 381 u_char ex_addrlen; /* and the net address length */ 382 struct sockaddr *ex_mask; /* mask of valid bits in saddr */ 383 u_char ex_masklen; /* and the smask length */ 384 char *ex_indexfile; /* index file for WebNFS URLs */ 385}; 386 387/* 388 * Export arguments for local filesystem mount calls. 389 */ 390#define MAXSECFLAVORS 5 391struct export_args { 392 int ex_flags; /* export related flags */ 393 uid_t ex_root; /* mapping for root uid */ 394 struct xucred ex_anon; /* mapping for anonymous user */ 395 struct sockaddr *ex_addr; /* net address to which exported */ 396 u_char ex_addrlen; /* and the net address length */ 397 struct sockaddr *ex_mask; /* mask of valid bits in saddr */ 398 u_char ex_masklen; /* and the smask length */ 399 char *ex_indexfile; /* index file for WebNFS URLs */ 400 int ex_numsecflavors; /* security flavor count */ 401 int ex_secflavors[MAXSECFLAVORS]; /* list of security flavors */ 402}; 403 404/* 405 * Structure holding information for a publicly exported filesystem 406 * (WebNFS). Currently the specs allow just for one such filesystem. 407 */ 408struct nfs_public { 409 int np_valid; /* Do we hold valid information */ 410 fhandle_t np_handle; /* Filehandle for pub fs (internal) */ 411 struct mount *np_mount; /* Mountpoint of exported fs */ 412 char *np_index; /* Index file */ 413}; 414 415/* 416 * Filesystem configuration information. One of these exists for each 417 * type of filesystem supported by the kernel. These are searched at 418 * mount time to identify the requested filesystem. 419 * 420 * XXX: Never change the first two arguments! 421 */ 422struct vfsconf { 423 u_int vfc_version; /* ABI version number */ 424 char vfc_name[MFSNAMELEN]; /* filesystem type name */ 425 struct vfsops *vfc_vfsops; /* filesystem operations vector */ 426 int vfc_typenum; /* historic filesystem type number */ 427 int vfc_refcount; /* number mounted of this type */ 428 int vfc_flags; /* permanent flags */ 429 struct vfsoptdecl *vfc_opts; /* mount options */ 430 TAILQ_ENTRY(vfsconf) vfc_list; /* list of vfscons */ 431}; 432 433/* Userland version of the struct vfsconf. */ 434struct xvfsconf { 435 struct vfsops *vfc_vfsops; /* filesystem operations vector */ 436 char vfc_name[MFSNAMELEN]; /* filesystem type name */ 437 int vfc_typenum; /* historic filesystem type number */ 438 int vfc_refcount; /* number mounted of this type */ 439 int vfc_flags; /* permanent flags */ 440 struct vfsconf *vfc_next; /* next in list */ 441}; 442 443#ifndef BURN_BRIDGES 444struct ovfsconf { 445 void *vfc_vfsops; 446 char vfc_name[32]; 447 int vfc_index; 448 int vfc_refcount; 449 int vfc_flags; 450}; 451#endif 452 453/* 454 * NB: these flags refer to IMPLEMENTATION properties, not properties of 455 * any actual mounts; i.e., it does not make sense to change the flags. 456 */ 457#define VFCF_STATIC 0x00010000 /* statically compiled into kernel */ 458#define VFCF_NETWORK 0x00020000 /* may get data over the network */ 459#define VFCF_READONLY 0x00040000 /* writes are not implemented */ 460#define VFCF_SYNTHETIC 0x00080000 /* data does not represent real files */ 461#define VFCF_LOOPBACK 0x00100000 /* aliases some other mounted FS */ 462#define VFCF_UNICODE 0x00200000 /* stores file names as Unicode */ 463#define VFCF_JAIL 0x00400000 /* can be mounted from within a jail */ 464#define VFCF_DELEGADMIN 0x00800000 /* supports delegated administration */ 465 466typedef uint32_t fsctlop_t; 467 468struct vfsidctl { 469 int vc_vers; /* should be VFSIDCTL_VERS1 (below) */ 470 fsid_t vc_fsid; /* fsid to operate on */ 471 char vc_fstypename[MFSNAMELEN]; 472 /* type of fs 'nfs' or '*' */ 473 fsctlop_t vc_op; /* operation VFS_CTL_* (below) */ 474 void *vc_ptr; /* pointer to data structure */ 475 size_t vc_len; /* sizeof said structure */ 476 u_int32_t vc_spare[12]; /* spare (must be zero) */ 477}; 478 479/* vfsidctl API version. */ 480#define VFS_CTL_VERS1 0x01 481 482/* 483 * New style VFS sysctls, do not reuse/conflict with the namespace for 484 * private sysctls. 485 * All "global" sysctl ops have the 33rd bit set: 486 * 0x...1.... 487 * Private sysctl ops should have the 33rd bit unset. 488 */ 489#define VFS_CTL_QUERY 0x00010001 /* anything wrong? (vfsquery) */ 490#define VFS_CTL_TIMEO 0x00010002 /* set timeout for vfs notification */ 491#define VFS_CTL_NOLOCKS 0x00010003 /* disable file locking */ 492 493struct vfsquery { 494 u_int32_t vq_flags; 495 u_int32_t vq_spare[31]; 496}; 497 498/* vfsquery flags */ 499#define VQ_NOTRESP 0x0001 /* server down */ 500#define VQ_NEEDAUTH 0x0002 /* server bad auth */ 501#define VQ_LOWDISK 0x0004 /* we're low on space */ 502#define VQ_MOUNT 0x0008 /* new filesystem arrived */ 503#define VQ_UNMOUNT 0x0010 /* filesystem has left */ 504#define VQ_DEAD 0x0020 /* filesystem is dead, needs force unmount */ 505#define VQ_ASSIST 0x0040 /* filesystem needs assistance from external 506 program */ 507#define VQ_NOTRESPLOCK 0x0080 /* server lockd down */ 508#define VQ_FLAG0100 0x0100 /* placeholder */ 509#define VQ_FLAG0200 0x0200 /* placeholder */ 510#define VQ_FLAG0400 0x0400 /* placeholder */ 511#define VQ_FLAG0800 0x0800 /* placeholder */ 512#define VQ_FLAG1000 0x1000 /* placeholder */ 513#define VQ_FLAG2000 0x2000 /* placeholder */ 514#define VQ_FLAG4000 0x4000 /* placeholder */ 515#define VQ_FLAG8000 0x8000 /* placeholder */ 516 517#ifdef _KERNEL 518/* Point a sysctl request at a vfsidctl's data. */ 519#define VCTLTOREQ(vc, req) \ 520 do { \ 521 (req)->newptr = (vc)->vc_ptr; \ 522 (req)->newlen = (vc)->vc_len; \ 523 (req)->newidx = 0; \ 524 } while (0) 525#endif 526 527struct iovec; 528struct uio; 529 530#ifdef _KERNEL 531 532/* 533 * vfs_busy specific flags and mask. 534 */ 535#define MBF_NOWAIT 0x01 536#define MBF_MNTLSTLOCK 0x02 537#define MBF_MASK (MBF_NOWAIT | MBF_MNTLSTLOCK) 538 539#ifdef MALLOC_DECLARE 540MALLOC_DECLARE(M_MOUNT); 541#endif 542extern int maxvfsconf; /* highest defined filesystem type */ 543extern int nfs_mount_type; /* vfc_typenum for nfs, or -1 */ 544 545TAILQ_HEAD(vfsconfhead, vfsconf); 546extern struct vfsconfhead vfsconf; 547 548/* 549 * Operations supported on mounted filesystem. 550 */ 551struct mount_args; 552struct nameidata; 553struct sysctl_req; 554struct mntarg; 555 556typedef int vfs_cmount_t(struct mntarg *ma, void *data, int flags, struct thread *td); 557typedef int vfs_unmount_t(struct mount *mp, int mntflags, struct thread *td); 558typedef int vfs_root_t(struct mount *mp, int flags, struct vnode **vpp, 559 struct thread *td); 560typedef int vfs_quotactl_t(struct mount *mp, int cmds, uid_t uid, 561 void *arg, struct thread *td); 562typedef int vfs_statfs_t(struct mount *mp, struct statfs *sbp, 563 struct thread *td); 564typedef int vfs_sync_t(struct mount *mp, int waitfor, struct thread *td); 565typedef int vfs_vget_t(struct mount *mp, ino_t ino, int flags, 566 struct vnode **vpp); 567typedef int vfs_fhtovp_t(struct mount *mp, struct fid *fhp, struct vnode **vpp); 568typedef int vfs_checkexp_t(struct mount *mp, struct sockaddr *nam, 569 int *extflagsp, struct ucred **credanonp, 570 int *numsecflavors, int **secflavors); 571typedef int vfs_init_t(struct vfsconf *); 572typedef int vfs_uninit_t(struct vfsconf *); 573typedef int vfs_extattrctl_t(struct mount *mp, int cmd, 574 struct vnode *filename_vp, int attrnamespace, 575 const char *attrname, struct thread *td); 576typedef int vfs_mount_t(struct mount *mp, struct thread *td); 577typedef int vfs_sysctl_t(struct mount *mp, fsctlop_t op, 578 struct sysctl_req *req); 579typedef void vfs_susp_clean_t(struct mount *mp); 580 581struct vfsops { 582 vfs_mount_t *vfs_mount; 583 vfs_cmount_t *vfs_cmount; 584 vfs_unmount_t *vfs_unmount; 585 vfs_root_t *vfs_root; 586 vfs_quotactl_t *vfs_quotactl; 587 vfs_statfs_t *vfs_statfs; 588 vfs_sync_t *vfs_sync; 589 vfs_vget_t *vfs_vget; 590 vfs_fhtovp_t *vfs_fhtovp; 591 vfs_checkexp_t *vfs_checkexp; 592 vfs_init_t *vfs_init; 593 vfs_uninit_t *vfs_uninit; 594 vfs_extattrctl_t *vfs_extattrctl; 595 vfs_sysctl_t *vfs_sysctl; 596 vfs_susp_clean_t *vfs_susp_clean; 597}; 598 599vfs_statfs_t __vfs_statfs; 600 601#define VFS_MOUNT(MP, P) (*(MP)->mnt_op->vfs_mount)(MP, P) 602#define VFS_UNMOUNT(MP, FORCE, P) (*(MP)->mnt_op->vfs_unmount)(MP, FORCE, P) 603#define VFS_ROOT(MP, FLAGS, VPP, P) \ 604 (*(MP)->mnt_op->vfs_root)(MP, FLAGS, VPP, P) 605#define VFS_QUOTACTL(MP,C,U,A,P) (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A, P) 606#define VFS_STATFS(MP, SBP, P) __vfs_statfs((MP), (SBP), (P)) 607#define VFS_SYNC(MP, WAIT, P) (*(MP)->mnt_op->vfs_sync)(MP, WAIT, P) 608#define VFS_VGET(MP, INO, FLAGS, VPP) \ 609 (*(MP)->mnt_op->vfs_vget)(MP, INO, FLAGS, VPP) 610#define VFS_FHTOVP(MP, FIDP, VPP) \ 611 (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, VPP) 612#define VFS_CHECKEXP(MP, NAM, EXFLG, CRED, NUMSEC, SEC) \ 613 (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED, NUMSEC, SEC) 614#define VFS_EXTATTRCTL(MP, C, FN, NS, N, P) \ 615 (*(MP)->mnt_op->vfs_extattrctl)(MP, C, FN, NS, N, P) 616#define VFS_SYSCTL(MP, OP, REQ) \ 617 (*(MP)->mnt_op->vfs_sysctl)(MP, OP, REQ) 618#define VFS_SUSP_CLEAN(MP) \ 619 ({if (*(MP)->mnt_op->vfs_susp_clean != NULL) \ 620 (*(MP)->mnt_op->vfs_susp_clean)(MP); }) 621 622extern int mpsafe_vfs; 623 624#define VFS_NEEDSGIANT_(MP) \ 625 (!mpsafe_vfs || ((MP) != NULL && ((MP)->mnt_kern_flag & MNTK_MPSAFE) == 0)) 626 627#define VFS_NEEDSGIANT(MP) __extension__ \ 628({ \ 629 struct mount *_mp; \ 630 _mp = (MP); \ 631 VFS_NEEDSGIANT_(_mp); \ 632}) 633 634#define VFS_LOCK_GIANT(MP) __extension__ \ 635({ \ 636 int _locked; \ 637 struct mount *_mp; \ 638 _mp = (MP); \ 639 if (VFS_NEEDSGIANT_(_mp)) { \ 640 mtx_lock(&Giant); \ 641 _locked = 1; \ 642 } else \ 643 _locked = 0; \ 644 _locked; \ 645}) 646#define VFS_UNLOCK_GIANT(locked) if ((locked)) mtx_unlock(&Giant); 647#define VFS_ASSERT_GIANT(MP) do \ 648{ \ 649 struct mount *_mp; \ 650 _mp = (MP); \ 651 if (VFS_NEEDSGIANT_(_mp)) \ 652 mtx_assert(&Giant, MA_OWNED); \ 653} while (0) 654 655#define VFS_KNOTE_LOCKED(vp, hint) do \ 656{ \ 657 if (((vp)->v_vflag & VV_NOKNOTE) == 0) \ 658 VN_KNOTE((vp), (hint), 1); \ 659} while (0) 660 661#define VFS_KNOTE_UNLOCKED(vp, hint) do \ 662{ \ 663 if (((vp)->v_vflag & VV_NOKNOTE) == 0) \ 664 VN_KNOTE((vp), (hint), 0); \ 665} while (0) 666 667#include <sys/module.h> 668 669/* 670 * Version numbers. 671 */ 672#define VFS_VERSION_00 0x19660120 673#define VFS_VERSION VFS_VERSION_00 674 675#define VFS_SET(vfsops, fsname, flags) \ 676 static struct vfsconf fsname ## _vfsconf = { \ 677 .vfc_version = VFS_VERSION, \ 678 .vfc_name = #fsname, \ 679 .vfc_vfsops = &vfsops, \ 680 .vfc_typenum = -1, \ 681 .vfc_flags = flags, \ 682 }; \ 683 static moduledata_t fsname ## _mod = { \ 684 #fsname, \ 685 vfs_modevent, \ 686 & fsname ## _vfsconf \ 687 }; \ 688 DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE) 689 690extern char *mountrootfsname; 691 692/* 693 * exported vnode operations 694 */ 695 696int dounmount(struct mount *, int, struct thread *); 697 698int kernel_mount(struct mntarg *ma, int flags); 699int kernel_vmount(int flags, ...); 700struct mntarg *mount_arg(struct mntarg *ma, const char *name, const void *val, int len); 701struct mntarg *mount_argb(struct mntarg *ma, int flag, const char *name); 702struct mntarg *mount_argf(struct mntarg *ma, const char *name, const char *fmt, ...); 703struct mntarg *mount_argsu(struct mntarg *ma, const char *name, const void *val, int len); 704void statfs_scale_blocks(struct statfs *sf, long max_size); 705struct vfsconf *vfs_byname(const char *); 706struct vfsconf *vfs_byname_kld(const char *, struct thread *td, int *); 707void vfs_mount_destroy(struct mount *); 708void vfs_event_signal(fsid_t *, u_int32_t, intptr_t); 709void vfs_freeopts(struct vfsoptlist *opts); 710void vfs_deleteopt(struct vfsoptlist *opts, const char *name); 711int vfs_buildopts(struct uio *auio, struct vfsoptlist **options); 712int vfs_flagopt(struct vfsoptlist *opts, const char *name, u_int *w, u_int val); 713int vfs_getopt(struct vfsoptlist *, const char *, void **, int *); 714int vfs_getopt_pos(struct vfsoptlist *opts, const char *name); 715char *vfs_getopts(struct vfsoptlist *, const char *, int *error); 716int vfs_copyopt(struct vfsoptlist *, const char *, void *, int); 717int vfs_filteropt(struct vfsoptlist *, const char **legal); 718void vfs_opterror(struct vfsoptlist *opts, const char *fmt, ...); 719int vfs_scanopt(struct vfsoptlist *opts, const char *name, const char *fmt, ...); 720int vfs_setopt(struct vfsoptlist *opts, const char *name, void *value, 721 int len); 722int vfs_setopt_part(struct vfsoptlist *opts, const char *name, void *value, 723 int len); 724int vfs_setopts(struct vfsoptlist *opts, const char *name, 725 const char *value); 726int vfs_setpublicfs /* set publicly exported fs */ 727 (struct mount *, struct netexport *, struct export_args *); 728void vfs_msync(struct mount *, int); 729int vfs_busy(struct mount *, int); 730int vfs_export /* process mount export info */ 731 (struct mount *, struct export_args *); 732int vfs_allocate_syncvnode(struct mount *); 733int vfs_donmount(struct thread *td, int fsflags, struct uio *fsoptions); 734void vfs_getnewfsid(struct mount *); 735struct cdev *vfs_getrootfsid(struct mount *); 736struct mount *vfs_getvfs(fsid_t *); /* return vfs given fsid */ 737struct mount *vfs_busyfs(fsid_t *); 738int vfs_modevent(module_t, int, void *); 739void vfs_mount_error(struct mount *, const char *, ...); 740void vfs_mountroot(void); /* mount our root filesystem */ 741void vfs_mountedfrom(struct mount *, const char *from); 742void vfs_ref(struct mount *); 743void vfs_rel(struct mount *); 744struct mount *vfs_mount_alloc(struct vnode *, struct vfsconf *, const char *, 745 struct ucred *); 746int vfs_suser(struct mount *, struct thread *); 747void vfs_unbusy(struct mount *); 748void vfs_unmountall(void); 749extern TAILQ_HEAD(mntlist, mount) mountlist; /* mounted filesystem list */ 750extern struct mtx mountlist_mtx; 751extern struct nfs_public nfs_pub; 752 753/* 754 * Declarations for these vfs default operations are located in 755 * kern/vfs_default.c, they should be used instead of making "dummy" 756 * functions or casting entries in the VFS op table to "enopnotsupp()". 757 */ 758vfs_root_t vfs_stdroot; 759vfs_quotactl_t vfs_stdquotactl; 760vfs_statfs_t vfs_stdstatfs; 761vfs_sync_t vfs_stdsync; 762vfs_sync_t vfs_stdnosync; 763vfs_vget_t vfs_stdvget; 764vfs_fhtovp_t vfs_stdfhtovp; 765vfs_checkexp_t vfs_stdcheckexp; 766vfs_init_t vfs_stdinit; 767vfs_uninit_t vfs_stduninit; 768vfs_extattrctl_t vfs_stdextattrctl; 769vfs_sysctl_t vfs_stdsysctl; 770 771#else /* !_KERNEL */ 772 773#include <sys/cdefs.h> 774 775struct stat; 776 777__BEGIN_DECLS 778int fhopen(const struct fhandle *, int); 779int fhstat(const struct fhandle *, struct stat *); 780int fhstatfs(const struct fhandle *, struct statfs *); 781int fstatfs(int, struct statfs *); 782int getfh(const char *, fhandle_t *); 783int getfsstat(struct statfs *, long, int); 784int getmntinfo(struct statfs **, int); 785int lgetfh(const char *, fhandle_t *); 786int mount(const char *, const char *, int, void *); 787int nmount(struct iovec *, unsigned int, int); 788int statfs(const char *, struct statfs *); 789int unmount(const char *, int); 790 791/* C library stuff */ 792int getvfsbyname(const char *, struct xvfsconf *); 793__END_DECLS 794 795#endif /* _KERNEL */ 796 797#endif /* !_SYS_MOUNT_H_ */ 798