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