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