xref: /freebsd-13.1/sys/sys/mount.h (revision b4889992)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1989, 1991, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)mount.h	8.21 (Berkeley) 5/20/95
32  * $FreeBSD$
33  */
34 
35 #ifndef _SYS_MOUNT_H_
36 #define _SYS_MOUNT_H_
37 
38 #include <sys/ucred.h>
39 #include <sys/queue.h>
40 #ifdef _KERNEL
41 #include <sys/lock.h>
42 #include <sys/lockmgr.h>
43 #include <sys/tslog.h>
44 #include <sys/_mutex.h>
45 #include <sys/_sx.h>
46 #endif
47 
48 /*
49  * NOTE: When changing statfs structure, mount structure, MNT_* flags or
50  * MNTK_* flags also update DDB show mount command in vfs_subr.c.
51  */
52 
53 typedef struct fsid { int32_t val[2]; } fsid_t;	/* filesystem id type */
54 
55 #define fsidcmp(a, b) memcmp((a), (b), sizeof(fsid_t))
56 
57 /*
58  * File identifier.
59  * These are unique per filesystem on a single machine.
60  *
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.
63  */
64 #define	MAXFIDSZ	16
65 
66 struct fid {
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) */
70 };
71 
72 /*
73  * filesystem statistics
74  */
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 */
78 struct statfs {
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 */
101 };
102 
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 */
128 };
129 #endif /* _WANT_FREEBSD11_STATFS || _KERNEL */
130 
131 #ifdef _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 */
134 
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. */
137 struct ostatfs {
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 */
159 	/*
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.
163 	 */
164 	long	f_spare[2];		/* unused spare */
165 };
166 
167 TAILQ_HEAD(vnodelst, vnode);
168 
169 /* Mount options list */
170 TAILQ_HEAD(vfsoptlist, vfsopt);
171 struct vfsopt {
172 	TAILQ_ENTRY(vfsopt) link;
173 	char	*name;
174 	void	*value;
175 	int	len;
176 	int	pos;
177 	int	seen;
178 };
179 
180 struct mount_pcpu {
181 	int		mntp_thread_in_ops;
182 	int		mntp_ref;
183 	int		mntp_lockref;
184 	int		mntp_writeopcount;
185 };
186 
187 _Static_assert(sizeof(struct mount_pcpu) == 16,
188     "the struct is allocated from pcpu 16 zone");
189 
190 /*
191  * Structure per mounted filesystem.  Each mounted filesystem has an
192  * array of operations and an instance record.  The filesystems are
193  * put on a doubly linked list.
194  *
195  * Lock reference:
196  * 	l - mnt_listmtx
197  *	m - mountlist_mtx
198  *	i - interlock
199  *	i* - interlock of uppers' list head
200  *	v - vnode freelist mutex
201  *
202  * Unmarked fields are considered stable as long as a ref is held.
203  *
204  */
205 struct mount {
206 	int 		mnt_vfs_ops;		/* (i) pending vfs ops */
207 	int		mnt_kern_flag;		/* (i) kernel only flags */
208 	uint64_t	mnt_flag;		/* (i) flags shared with user */
209 	struct mount_pcpu *mnt_pcpu;		/* per-CPU data */
210 	struct vnode	*mnt_rootvnode;
211 	struct vnode	*mnt_vnodecovered;	/* vnode we mounted on */
212 	struct vfsops	*mnt_op;		/* operations on fs */
213 	struct vfsconf	*mnt_vfc;		/* configuration info */
214 	struct mtx __aligned(CACHE_LINE_SIZE)	mnt_mtx; /* mount structure interlock */
215 	int		mnt_gen;		/* struct mount generation */
216 #define	mnt_startzero	mnt_list
217 	TAILQ_ENTRY(mount) mnt_list;		/* (m) mount list */
218 	struct vnode	*mnt_syncer;		/* syncer vnode */
219 	int		mnt_ref;		/* (i) Reference count */
220 	struct vnodelst	mnt_nvnodelist;		/* (i) list of vnodes */
221 	int		mnt_nvnodelistsize;	/* (i) # of vnodes */
222 	int		mnt_writeopcount;	/* (i) write syscalls pending */
223 	struct vfsoptlist *mnt_opt;		/* current mount options */
224 	struct vfsoptlist *mnt_optnew;		/* new options passed to fs */
225 	u_int		mnt_pad0;		/* was mnt_maxsymlinklen */
226 	struct statfs	mnt_stat;		/* cache of filesystem stats */
227 	struct ucred	*mnt_cred;		/* credentials of mounter */
228 	void *		mnt_data;		/* private data */
229 	time_t		mnt_time;		/* last time written*/
230 	int		mnt_iosize_max;		/* max size for clusters, etc */
231 	struct netexport *mnt_export;		/* export list */
232 	struct label	*mnt_label;		/* MAC label for the fs */
233 	u_int		mnt_hashseed;		/* Random seed for vfs_hash */
234 	int		mnt_lockref;		/* (i) Lock reference count */
235 	int		mnt_secondary_writes;   /* (i) # of secondary writes */
236 	int		mnt_secondary_accwrites;/* (i) secondary wr. starts */
237 	struct thread	*mnt_susp_owner;	/* (i) thread owning suspension */
238 #define	mnt_endzero	mnt_gjprovider
239 	char		*mnt_gjprovider;	/* gjournal provider name */
240 	struct mtx	mnt_listmtx;
241 	struct vnodelst	mnt_lazyvnodelist;	/* (l) list of lazy vnodes */
242 	int		mnt_lazyvnodelistsize;	/* (l) # of lazy vnodes */
243 	struct lock	mnt_explock;		/* vfs_export walkers lock */
244 	TAILQ_ENTRY(mount) mnt_upper_link;	/* (i*) we in the all uppers */
245 	TAILQ_HEAD(, mount) mnt_uppers;		/* (i) upper mounts over us */
246 };
247 
248 /*
249  * Definitions for MNT_VNODE_FOREACH_ALL.
250  */
251 struct vnode *__mnt_vnode_next_all(struct vnode **mvp, struct mount *mp);
252 struct vnode *__mnt_vnode_first_all(struct vnode **mvp, struct mount *mp);
253 void          __mnt_vnode_markerfree_all(struct vnode **mvp, struct mount *mp);
254 
255 #define MNT_VNODE_FOREACH_ALL(vp, mp, mvp)				\
256 	for (vp = __mnt_vnode_first_all(&(mvp), (mp));			\
257 		(vp) != NULL; vp = __mnt_vnode_next_all(&(mvp), (mp)))
258 
259 #define MNT_VNODE_FOREACH_ALL_ABORT(mp, mvp)				\
260 	do {								\
261 		MNT_ILOCK(mp);						\
262 		__mnt_vnode_markerfree_all(&(mvp), (mp));		\
263 		/* MNT_IUNLOCK(mp); -- done in above function */	\
264 		mtx_assert(MNT_MTX(mp), MA_NOTOWNED);			\
265 	} while (0)
266 
267 /*
268  * Definitions for MNT_VNODE_FOREACH_LAZY.
269  */
270 typedef int mnt_lazy_cb_t(struct vnode *, void *);
271 struct vnode *__mnt_vnode_next_lazy(struct vnode **mvp, struct mount *mp,
272     mnt_lazy_cb_t *cb, void *cbarg);
273 struct vnode *__mnt_vnode_first_lazy(struct vnode **mvp, struct mount *mp,
274     mnt_lazy_cb_t *cb, void *cbarg);
275 void          __mnt_vnode_markerfree_lazy(struct vnode **mvp, struct mount *mp);
276 
277 #define MNT_VNODE_FOREACH_LAZY(vp, mp, mvp, cb, cbarg)			\
278 	for (vp = __mnt_vnode_first_lazy(&(mvp), (mp), (cb), (cbarg));	\
279 		(vp) != NULL; 						\
280 		vp = __mnt_vnode_next_lazy(&(mvp), (mp), (cb), (cbarg)))
281 
282 #define MNT_VNODE_FOREACH_LAZY_ABORT(mp, mvp)				\
283 	__mnt_vnode_markerfree_lazy(&(mvp), (mp))
284 
285 #define	MNT_ILOCK(mp)	mtx_lock(&(mp)->mnt_mtx)
286 #define	MNT_ITRYLOCK(mp) mtx_trylock(&(mp)->mnt_mtx)
287 #define	MNT_IUNLOCK(mp)	mtx_unlock(&(mp)->mnt_mtx)
288 #define	MNT_MTX(mp)	(&(mp)->mnt_mtx)
289 
290 #define	MNT_REF(mp)	do {						\
291 	mtx_assert(MNT_MTX(mp), MA_OWNED);				\
292 	mp->mnt_ref++;							\
293 } while (0)
294 #define	MNT_REL(mp)	do {						\
295 	mtx_assert(MNT_MTX(mp), MA_OWNED);				\
296 	(mp)->mnt_ref--;						\
297 	if ((mp)->mnt_vfs_ops && (mp)->mnt_ref < 0)		\
298 		vfs_dump_mount_counters(mp);				\
299 	if ((mp)->mnt_ref == 0 && (mp)->mnt_vfs_ops)		\
300 		wakeup((mp));						\
301 } while (0)
302 
303 #endif /* _KERNEL */
304 
305 #if defined(_WANT_MNTOPTNAMES) || defined(_KERNEL)
306 struct mntoptnames {
307 	uint64_t o_opt;
308 	const char *o_name;
309 };
310 #define MNTOPT_NAMES							\
311 	{ MNT_ASYNC,		"asynchronous" },			\
312 	{ MNT_EXPORTED,		"NFS exported" },			\
313 	{ MNT_LOCAL,		"local" },				\
314 	{ MNT_NOATIME,		"noatime" },				\
315 	{ MNT_NOEXEC,		"noexec" },				\
316 	{ MNT_NOSUID,		"nosuid" },				\
317 	{ MNT_NOSYMFOLLOW,	"nosymfollow" },			\
318 	{ MNT_QUOTA,		"with quotas" },			\
319 	{ MNT_RDONLY,		"read-only" },				\
320 	{ MNT_SYNCHRONOUS,	"synchronous" },			\
321 	{ MNT_UNION,		"union" },				\
322 	{ MNT_NOCLUSTERR,	"noclusterr" },				\
323 	{ MNT_NOCLUSTERW,	"noclusterw" },				\
324 	{ MNT_SUIDDIR,		"suiddir" },				\
325 	{ MNT_SOFTDEP,		"soft-updates" },			\
326 	{ MNT_SUJ,		"journaled soft-updates" },		\
327 	{ MNT_MULTILABEL,	"multilabel" },				\
328 	{ MNT_ACLS,		"acls" },				\
329 	{ MNT_NFS4ACLS,		"nfsv4acls" },				\
330 	{ MNT_GJOURNAL,		"gjournal" },				\
331 	{ MNT_AUTOMOUNTED,	"automounted" },			\
332 	{ MNT_VERIFIED,		"verified" },				\
333 	{ MNT_UNTRUSTED,	"untrusted" },				\
334 	{ MNT_NOCOVER,		"nocover" },				\
335 	{ MNT_EMPTYDIR,		"emptydir" },				\
336 	{ MNT_UPDATE,		"update" },				\
337 	{ MNT_DELEXPORT,	"delexport" },				\
338 	{ MNT_RELOAD,		"reload" },				\
339 	{ MNT_FORCE,		"force" },				\
340 	{ MNT_SNAPSHOT,		"snapshot" },				\
341 	{ 0, NULL }
342 #endif
343 
344 /*
345  * User specifiable flags, stored in mnt_flag.
346  */
347 #define	MNT_RDONLY	0x0000000000000001ULL /* read only filesystem */
348 #define	MNT_SYNCHRONOUS	0x0000000000000002ULL /* fs written synchronously */
349 #define	MNT_NOEXEC	0x0000000000000004ULL /* can't exec from filesystem */
350 #define	MNT_NOSUID	0x0000000000000008ULL /* don't honor setuid fs bits */
351 #define	MNT_NFS4ACLS	0x0000000000000010ULL /* enable NFS version 4 ACLs */
352 #define	MNT_UNION	0x0000000000000020ULL /* union with underlying fs */
353 #define	MNT_ASYNC	0x0000000000000040ULL /* fs written asynchronously */
354 #define	MNT_SUIDDIR	0x0000000000100000ULL /* special SUID dir handling */
355 #define	MNT_SOFTDEP	0x0000000000200000ULL /* using soft updates */
356 #define	MNT_NOSYMFOLLOW	0x0000000000400000ULL /* do not follow symlinks */
357 #define	MNT_GJOURNAL	0x0000000002000000ULL /* GEOM journal support enabled */
358 #define	MNT_MULTILABEL	0x0000000004000000ULL /* MAC support for objects */
359 #define	MNT_ACLS	0x0000000008000000ULL /* ACL support enabled */
360 #define	MNT_NOATIME	0x0000000010000000ULL /* dont update file access time */
361 #define	MNT_NOCLUSTERR	0x0000000040000000ULL /* disable cluster read */
362 #define	MNT_NOCLUSTERW	0x0000000080000000ULL /* disable cluster write */
363 #define	MNT_SUJ		0x0000000100000000ULL /* using journaled soft updates */
364 #define	MNT_AUTOMOUNTED	0x0000000200000000ULL /* mounted by automountd(8) */
365 #define	MNT_UNTRUSTED	0x0000000800000000ULL /* filesys metadata untrusted */
366 
367 /*
368  * NFS export related mount flags.
369  */
370 #define	MNT_EXRDONLY	0x0000000000000080ULL	/* exported read only */
371 #define	MNT_EXPORTED	0x0000000000000100ULL	/* filesystem is exported */
372 #define	MNT_DEFEXPORTED	0x0000000000000200ULL	/* exported to the world */
373 #define	MNT_EXPORTANON	0x0000000000000400ULL	/* anon uid mapping for all */
374 #define	MNT_EXKERB	0x0000000000000800ULL	/* exported with Kerberos */
375 #define	MNT_EXPUBLIC	0x0000000020000000ULL	/* public export (WebNFS) */
376 #define	MNT_EXTLS	0x0000004000000000ULL /* require TLS */
377 #define	MNT_EXTLSCERT	0x0000008000000000ULL /* require TLS with client cert */
378 #define	MNT_EXTLSCERTUSER 0x0000010000000000ULL /* require TLS with user cert */
379 
380 /*
381  * Flags set by internal operations, but visible to the user.
382  */
383 #define	MNT_LOCAL	0x0000000000001000ULL /* filesystem is stored locally */
384 #define	MNT_QUOTA	0x0000000000002000ULL /* quotas are enabled on fs */
385 #define	MNT_ROOTFS	0x0000000000004000ULL /* identifies the root fs */
386 #define	MNT_USER	0x0000000000008000ULL /* mounted by a user */
387 #define	MNT_IGNORE	0x0000000000800000ULL /* do not show entry in df */
388 #define	MNT_VERIFIED	0x0000000400000000ULL /* filesystem is verified */
389 
390 /*
391  * Mask of flags that are visible to statfs().
392  * XXX I think that this could now become (~(MNT_CMDFLAGS))
393  * but the 'mount' program may need changing to handle this.
394  */
395 #define	MNT_VISFLAGMASK	(MNT_RDONLY	| MNT_SYNCHRONOUS | MNT_NOEXEC	| \
396 			MNT_NOSUID	| MNT_UNION	| MNT_SUJ	| \
397 			MNT_ASYNC	| MNT_EXRDONLY	| MNT_EXPORTED	| \
398 			MNT_DEFEXPORTED	| MNT_EXPORTANON| MNT_EXKERB	| \
399 			MNT_LOCAL	| MNT_USER	| MNT_QUOTA	| \
400 			MNT_ROOTFS	| MNT_NOATIME	| MNT_NOCLUSTERR| \
401 			MNT_NOCLUSTERW	| MNT_SUIDDIR	| MNT_SOFTDEP	| \
402 			MNT_IGNORE	| MNT_EXPUBLIC	| MNT_NOSYMFOLLOW | \
403 			MNT_GJOURNAL	| MNT_MULTILABEL | MNT_ACLS	| \
404 			MNT_NFS4ACLS	| MNT_AUTOMOUNTED | MNT_VERIFIED | \
405 			MNT_UNTRUSTED)
406 
407 /* Mask of flags that can be updated. */
408 #define	MNT_UPDATEMASK (MNT_NOSUID	| MNT_NOEXEC	| \
409 			MNT_SYNCHRONOUS	| MNT_UNION	| MNT_ASYNC	| \
410 			MNT_NOATIME | \
411 			MNT_NOSYMFOLLOW	| MNT_IGNORE	| \
412 			MNT_NOCLUSTERR	| MNT_NOCLUSTERW | MNT_SUIDDIR	| \
413 			MNT_ACLS	| MNT_USER	| MNT_NFS4ACLS	| \
414 			MNT_AUTOMOUNTED | MNT_UNTRUSTED)
415 
416 /*
417  * External filesystem command modifier flags.
418  * Unmount can use the MNT_FORCE flag.
419  * XXX: These are not STATES and really should be somewhere else.
420  * XXX: MNT_BYFSID and MNT_NONBUSY collide with MNT_ACLS and MNT_MULTILABEL,
421  *      but because MNT_ACLS and MNT_MULTILABEL are only used for mount(2),
422  *      and MNT_BYFSID and MNT_NONBUSY are only used for unmount(2),
423  *      it's harmless.
424  */
425 #define	MNT_UPDATE	0x0000000000010000ULL /* not real mount, just update */
426 #define	MNT_DELEXPORT	0x0000000000020000ULL /* delete export host lists */
427 #define	MNT_RELOAD	0x0000000000040000ULL /* reload filesystem data */
428 #define	MNT_FORCE	0x0000000000080000ULL /* force unmount or readonly */
429 #define	MNT_SNAPSHOT	0x0000000001000000ULL /* snapshot the filesystem */
430 #define	MNT_NONBUSY	0x0000000004000000ULL /* check vnode use counts. */
431 #define	MNT_BYFSID	0x0000000008000000ULL /* specify filesystem by ID. */
432 #define	MNT_NOCOVER	0x0000001000000000ULL /* Do not cover a mount point */
433 #define	MNT_EMPTYDIR	0x0000002000000000ULL /* Only mount on empty dir */
434 #define MNT_CMDFLAGS   (MNT_UPDATE	| MNT_DELEXPORT	| MNT_RELOAD	| \
435 			MNT_FORCE	| MNT_SNAPSHOT	| MNT_NONBUSY	| \
436 			MNT_BYFSID	| MNT_NOCOVER	| MNT_EMPTYDIR)
437 /*
438  * Internal filesystem control flags stored in mnt_kern_flag.
439  *
440  * MNTK_UNMOUNT locks the mount entry so that name lookup cannot
441  * proceed past the mount point.  This keeps the subtree stable during
442  * mounts and unmounts.  When non-forced unmount flushes all vnodes
443  * from the mp queue, the MNTK_UNMOUNT flag prevents insmntque() from
444  * queueing new vnodes.
445  *
446  * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while
447  * dounmount() is still waiting to lock the mountpoint. This allows
448  * the filesystem to cancel operations that might otherwise deadlock
449  * with the unmount attempt (used by NFS).
450  */
451 #define MNTK_UNMOUNTF	0x00000001	/* forced unmount in progress */
452 #define MNTK_ASYNC	0x00000002	/* filtered async flag */
453 #define MNTK_SOFTDEP	0x00000004	/* async disabled by softdep */
454 #define MNTK_NOMSYNC	0x00000008	/* don't do msync */
455 #define	MNTK_DRAINING	0x00000010	/* lock draining is happening */
456 #define	MNTK_REFEXPIRE	0x00000020	/* refcount expiring is happening */
457 #define MNTK_EXTENDED_SHARED	0x00000040 /* Allow shared locking for more ops */
458 #define	MNTK_SHARED_WRITES	0x00000080 /* Allow shared locking for writes */
459 #define	MNTK_NO_IOPF	0x00000100	/* Disallow page faults during reads
460 					   and writes. Filesystem shall properly
461 					   handle i/o state on EFAULT. */
462 #define	MNTK_VGONE_UPPER	0x00000200
463 #define	MNTK_VGONE_WAITER	0x00000400
464 #define	MNTK_LOOKUP_EXCL_DOTDOT	0x00000800
465 #define	MNTK_MARKER		0x00001000
466 #define	MNTK_UNMAPPED_BUFS	0x00002000
467 #define	MNTK_USES_BCACHE	0x00004000 /* FS uses the buffer cache. */
468 #define	MNTK_TEXT_REFS		0x00008000 /* Keep use ref for text */
469 #define	MNTK_VMSETSIZE_BUG	0x00010000
470 #define	MNTK_UNIONFS	0x00020000	/* A hack for F_ISUNIONSTACK */
471 #define	MNTK_FPLOOKUP	0x00040000	/* fast path lookup is supported */
472 #define	MNTK_SUSPEND_ALL	0x00080000 /* Suspended by all-fs suspension */
473 #define MNTK_NOASYNC	0x00800000	/* disable async */
474 #define MNTK_UNMOUNT	0x01000000	/* unmount in progress */
475 #define	MNTK_MWAIT	0x02000000	/* waiting for unmount to finish */
476 #define	MNTK_SUSPEND	0x08000000	/* request write suspension */
477 #define	MNTK_SUSPEND2	0x04000000	/* block secondary writes */
478 #define	MNTK_SUSPENDED	0x10000000	/* write operations are suspended */
479 #define	MNTK_NULL_NOCACHE	0x20000000 /* auto disable cache for nullfs
480 					      mounts over this fs */
481 #define MNTK_LOOKUP_SHARED	0x40000000 /* FS supports shared lock lookups */
482 #define	MNTK_NOKNOTE	0x80000000	/* Don't send KNOTEs from VOP hooks */
483 
484 #ifdef _KERNEL
485 static inline int
MNT_SHARED_WRITES(struct mount * mp)486 MNT_SHARED_WRITES(struct mount *mp)
487 {
488 
489 	return (mp != NULL && (mp->mnt_kern_flag & MNTK_SHARED_WRITES) != 0);
490 }
491 
492 static inline int
MNT_EXTENDED_SHARED(struct mount * mp)493 MNT_EXTENDED_SHARED(struct mount *mp)
494 {
495 
496 	return (mp != NULL && (mp->mnt_kern_flag & MNTK_EXTENDED_SHARED) != 0);
497 }
498 #endif
499 
500 /*
501  * Sysctl CTL_VFS definitions.
502  *
503  * Second level identifier specifies which filesystem. Second level
504  * identifier VFS_VFSCONF returns information about all filesystems.
505  * Second level identifier VFS_GENERIC is non-terminal.
506  */
507 #define	VFS_VFSCONF		0	/* get configured filesystems */
508 #define	VFS_GENERIC		0	/* generic filesystem information */
509 /*
510  * Third level identifiers for VFS_GENERIC are given below; third
511  * level identifiers for specific filesystems are given in their
512  * mount specific header files.
513  */
514 #define VFS_MAXTYPENUM	1	/* int: highest defined filesystem type */
515 #define VFS_CONF	2	/* struct: vfsconf for filesystem given
516 				   as next argument */
517 
518 /*
519  * Flags for various system call interfaces.
520  *
521  * waitfor flags to vfs_sync() and getfsstat()
522  */
523 #define MNT_WAIT	1	/* synchronously wait for I/O to complete */
524 #define MNT_NOWAIT	2	/* start all I/O, but do not wait for it */
525 #define MNT_LAZY	3	/* push data not written by filesystem syncer */
526 #define MNT_SUSPEND	4	/* Suspend file system after sync */
527 
528 /*
529  * Generic file handle
530  */
531 struct fhandle {
532 	fsid_t	fh_fsid;	/* Filesystem id of mount point */
533 	struct	fid fh_fid;	/* Filesys specific id */
534 };
535 typedef struct fhandle	fhandle_t;
536 
537 /*
538  * Old export arguments without security flavor list
539  */
540 struct oexport_args {
541 	int	ex_flags;		/* export related flags */
542 	uid_t	ex_root;		/* mapping for root uid */
543 	struct	xucred ex_anon;		/* mapping for anonymous user */
544 	struct	sockaddr *ex_addr;	/* net address to which exported */
545 	u_char	ex_addrlen;		/* and the net address length */
546 	struct	sockaddr *ex_mask;	/* mask of valid bits in saddr */
547 	u_char	ex_masklen;		/* and the smask length */
548 	char	*ex_indexfile;		/* index file for WebNFS URLs */
549 };
550 
551 /*
552  * Not quite so old export arguments with 32bit ex_flags and xucred ex_anon.
553  */
554 #define	MAXSECFLAVORS	5
555 struct o2export_args {
556 	int	ex_flags;		/* export related flags */
557 	uid_t	ex_root;		/* mapping for root uid */
558 	struct	xucred ex_anon;		/* mapping for anonymous user */
559 	struct	sockaddr *ex_addr;	/* net address to which exported */
560 	u_char	ex_addrlen;		/* and the net address length */
561 	struct	sockaddr *ex_mask;	/* mask of valid bits in saddr */
562 	u_char	ex_masklen;		/* and the smask length */
563 	char	*ex_indexfile;		/* index file for WebNFS URLs */
564 	int	ex_numsecflavors;	/* security flavor count */
565 	int	ex_secflavors[MAXSECFLAVORS]; /* list of security flavors */
566 };
567 
568 /*
569  * Export arguments for local filesystem mount calls.
570  */
571 struct export_args {
572 	uint64_t ex_flags;		/* export related flags */
573 	uid_t	ex_root;		/* mapping for root uid */
574 	uid_t	ex_uid;			/* mapping for anonymous user */
575 	int	ex_ngroups;
576 	gid_t	*ex_groups;
577 	struct	sockaddr *ex_addr;	/* net address to which exported */
578 	u_char	ex_addrlen;		/* and the net address length */
579 	struct	sockaddr *ex_mask;	/* mask of valid bits in saddr */
580 	u_char	ex_masklen;		/* and the smask length */
581 	char	*ex_indexfile;		/* index file for WebNFS URLs */
582 	int	ex_numsecflavors;	/* security flavor count */
583 	int	ex_secflavors[MAXSECFLAVORS]; /* list of security flavors */
584 };
585 
586 /*
587  * Structure holding information for a publicly exported filesystem
588  * (WebNFS). Currently the specs allow just for one such filesystem.
589  */
590 struct nfs_public {
591 	int		np_valid;	/* Do we hold valid information */
592 	fhandle_t	np_handle;	/* Filehandle for pub fs (internal) */
593 	struct mount	*np_mount;	/* Mountpoint of exported fs */
594 	char		*np_index;	/* Index file */
595 };
596 
597 /*
598  * Filesystem configuration information. One of these exists for each
599  * type of filesystem supported by the kernel. These are searched at
600  * mount time to identify the requested filesystem.
601  *
602  * XXX: Never change the first two arguments!
603  */
604 struct vfsconf {
605 	u_int	vfc_version;		/* ABI version number */
606 	char	vfc_name[MFSNAMELEN];	/* filesystem type name */
607 	struct	vfsops *vfc_vfsops;	/* filesystem operations vector */
608 	struct	vfsops *vfc_vfsops_sd;	/* ... signal-deferred */
609 	int	vfc_typenum;		/* historic filesystem type number */
610 	int	vfc_refcount;		/* number mounted of this type */
611 	int	vfc_flags;		/* permanent flags */
612 	int	vfc_prison_flag;	/* prison allow.mount.* flag */
613 	struct	vfsoptdecl *vfc_opts;	/* mount options */
614 	TAILQ_ENTRY(vfsconf) vfc_list;	/* list of vfscons */
615 };
616 
617 /* Userland version of the struct vfsconf. */
618 struct xvfsconf {
619 	struct	vfsops *vfc_vfsops;	/* filesystem operations vector */
620 	char	vfc_name[MFSNAMELEN];	/* filesystem type name */
621 	int	vfc_typenum;		/* historic filesystem type number */
622 	int	vfc_refcount;		/* number mounted of this type */
623 	int	vfc_flags;		/* permanent flags */
624 	struct	vfsconf *vfc_next;	/* next in list */
625 };
626 
627 #ifndef BURN_BRIDGES
628 struct ovfsconf {
629 	void	*vfc_vfsops;
630 	char	vfc_name[32];
631 	int	vfc_index;
632 	int	vfc_refcount;
633 	int	vfc_flags;
634 };
635 #endif
636 
637 /*
638  * NB: these flags refer to IMPLEMENTATION properties, not properties of
639  * any actual mounts; i.e., it does not make sense to change the flags.
640  */
641 #define	VFCF_STATIC	0x00010000	/* statically compiled into kernel */
642 #define	VFCF_NETWORK	0x00020000	/* may get data over the network */
643 #define	VFCF_READONLY	0x00040000	/* writes are not implemented */
644 #define	VFCF_SYNTHETIC	0x00080000	/* data does not represent real files */
645 #define	VFCF_LOOPBACK	0x00100000	/* aliases some other mounted FS */
646 #define	VFCF_UNICODE	0x00200000	/* stores file names as Unicode */
647 #define	VFCF_JAIL	0x00400000	/* can be mounted from within a jail */
648 #define	VFCF_DELEGADMIN	0x00800000	/* supports delegated administration */
649 #define	VFCF_SBDRY	0x01000000	/* Stop at Boundary: defer stop requests
650 					   to kernel->user (AST) transition */
651 
652 typedef uint32_t fsctlop_t;
653 
654 struct vfsidctl {
655 	int		vc_vers;	/* should be VFSIDCTL_VERS1 (below) */
656 	fsid_t		vc_fsid;	/* fsid to operate on */
657 	char		vc_fstypename[MFSNAMELEN];
658 					/* type of fs 'nfs' or '*' */
659 	fsctlop_t	vc_op;		/* operation VFS_CTL_* (below) */
660 	void		*vc_ptr;	/* pointer to data structure */
661 	size_t		vc_len;		/* sizeof said structure */
662 	u_int32_t	vc_spare[12];	/* spare (must be zero) */
663 };
664 
665 /* vfsidctl API version. */
666 #define VFS_CTL_VERS1	0x01
667 
668 /*
669  * New style VFS sysctls, do not reuse/conflict with the namespace for
670  * private sysctls.
671  * All "global" sysctl ops have the 33rd bit set:
672  * 0x...1....
673  * Private sysctl ops should have the 33rd bit unset.
674  */
675 #define VFS_CTL_QUERY	0x00010001	/* anything wrong? (vfsquery) */
676 #define VFS_CTL_TIMEO	0x00010002	/* set timeout for vfs notification */
677 #define VFS_CTL_NOLOCKS	0x00010003	/* disable file locking */
678 
679 struct vfsquery {
680 	u_int32_t	vq_flags;
681 	u_int32_t	vq_spare[31];
682 };
683 
684 /* vfsquery flags */
685 #define VQ_NOTRESP	0x0001	/* server down */
686 #define VQ_NEEDAUTH	0x0002	/* server bad auth */
687 #define VQ_LOWDISK	0x0004	/* we're low on space */
688 #define VQ_MOUNT	0x0008	/* new filesystem arrived */
689 #define VQ_UNMOUNT	0x0010	/* filesystem has left */
690 #define VQ_DEAD		0x0020	/* filesystem is dead, needs force unmount */
691 #define VQ_ASSIST	0x0040	/* filesystem needs assistance from external
692 				   program */
693 #define VQ_NOTRESPLOCK	0x0080	/* server lockd down */
694 #define VQ_FLAG0100	0x0100	/* placeholder */
695 #define VQ_FLAG0200	0x0200	/* placeholder */
696 #define VQ_FLAG0400	0x0400	/* placeholder */
697 #define VQ_FLAG0800	0x0800	/* placeholder */
698 #define VQ_FLAG1000	0x1000	/* placeholder */
699 #define VQ_FLAG2000	0x2000	/* placeholder */
700 #define VQ_FLAG4000	0x4000	/* placeholder */
701 #define VQ_FLAG8000	0x8000	/* placeholder */
702 
703 #ifdef _KERNEL
704 /* Point a sysctl request at a vfsidctl's data. */
705 #define VCTLTOREQ(vc, req)						\
706 	do {								\
707 		(req)->newptr = (vc)->vc_ptr;				\
708 		(req)->newlen = (vc)->vc_len;				\
709 		(req)->newidx = 0;					\
710 	} while (0)
711 #endif
712 
713 struct iovec;
714 struct uio;
715 
716 #ifdef _KERNEL
717 
718 /*
719  * vfs_busy specific flags and mask.
720  */
721 #define	MBF_NOWAIT	0x01
722 #define	MBF_MNTLSTLOCK	0x02
723 #define	MBF_MASK	(MBF_NOWAIT | MBF_MNTLSTLOCK)
724 
725 #ifdef MALLOC_DECLARE
726 MALLOC_DECLARE(M_MOUNT);
727 MALLOC_DECLARE(M_STATFS);
728 #endif
729 extern int maxvfsconf;		/* highest defined filesystem type */
730 
731 TAILQ_HEAD(vfsconfhead, vfsconf);
732 extern struct vfsconfhead vfsconf;
733 
734 /*
735  * Operations supported on mounted filesystem.
736  */
737 struct mount_args;
738 struct nameidata;
739 struct sysctl_req;
740 struct mntarg;
741 
742 /*
743  * N.B., vfs_cmount is the ancient vfsop invoked by the old mount(2) syscall.
744  * The new way is vfs_mount.
745  *
746  * vfs_cmount implementations typically translate arguments from their
747  * respective old per-FS structures into the key-value list supported by
748  * nmount(2), then use kernel_mount(9) to mimic nmount(2) from kernelspace.
749  *
750  * Filesystems with mounters that use nmount(2) do not need to and should not
751  * implement vfs_cmount.  Hopefully a future cleanup can remove vfs_cmount and
752  * mount(2) entirely.
753  */
754 typedef int vfs_cmount_t(struct mntarg *ma, void *data, uint64_t flags);
755 typedef int vfs_unmount_t(struct mount *mp, int mntflags);
756 typedef int vfs_root_t(struct mount *mp, int flags, struct vnode **vpp);
757 typedef	int vfs_quotactl_t(struct mount *mp, int cmds, uid_t uid, void *arg);
758 typedef	int vfs_statfs_t(struct mount *mp, struct statfs *sbp);
759 typedef	int vfs_sync_t(struct mount *mp, int waitfor);
760 typedef	int vfs_vget_t(struct mount *mp, ino_t ino, int flags,
761 		    struct vnode **vpp);
762 typedef	int vfs_fhtovp_t(struct mount *mp, struct fid *fhp,
763 		    int flags, struct vnode **vpp);
764 typedef	int vfs_checkexp_t(struct mount *mp, struct sockaddr *nam,
765 		    uint64_t *extflagsp, struct ucred **credanonp,
766 		    int *numsecflavors, int *secflavors);
767 typedef	int vfs_init_t(struct vfsconf *);
768 typedef	int vfs_uninit_t(struct vfsconf *);
769 typedef	int vfs_extattrctl_t(struct mount *mp, int cmd,
770 		    struct vnode *filename_vp, int attrnamespace,
771 		    const char *attrname);
772 typedef	int vfs_mount_t(struct mount *mp);
773 typedef int vfs_sysctl_t(struct mount *mp, fsctlop_t op,
774 		    struct sysctl_req *req);
775 typedef void vfs_susp_clean_t(struct mount *mp);
776 typedef void vfs_notify_lowervp_t(struct mount *mp, struct vnode *lowervp);
777 typedef void vfs_purge_t(struct mount *mp);
778 
779 struct vfsops {
780 	vfs_mount_t		*vfs_mount;
781 	vfs_cmount_t		*vfs_cmount;
782 	vfs_unmount_t		*vfs_unmount;
783 	vfs_root_t		*vfs_root;
784 	vfs_root_t		*vfs_cachedroot;
785 	vfs_quotactl_t		*vfs_quotactl;
786 	vfs_statfs_t		*vfs_statfs;
787 	vfs_sync_t		*vfs_sync;
788 	vfs_vget_t		*vfs_vget;
789 	vfs_fhtovp_t		*vfs_fhtovp;
790 	vfs_checkexp_t		*vfs_checkexp;
791 	vfs_init_t		*vfs_init;
792 	vfs_uninit_t		*vfs_uninit;
793 	vfs_extattrctl_t	*vfs_extattrctl;
794 	vfs_sysctl_t		*vfs_sysctl;
795 	vfs_susp_clean_t	*vfs_susp_clean;
796 	vfs_notify_lowervp_t	*vfs_reclaim_lowervp;
797 	vfs_notify_lowervp_t	*vfs_unlink_lowervp;
798 	vfs_purge_t		*vfs_purge;
799 	vfs_mount_t		*vfs_spare[6];	/* spares for ABI compat */
800 };
801 
802 vfs_statfs_t	__vfs_statfs;
803 
804 #define	VFS_MOUNT(MP) ({						\
805 	int _rc;							\
806 									\
807 	TSRAW(curthread, TS_ENTER, "VFS_MOUNT", (MP)->mnt_vfc->vfc_name);\
808 	_rc = (*(MP)->mnt_op->vfs_mount)(MP);				\
809 	TSRAW(curthread, TS_EXIT, "VFS_MOUNT", (MP)->mnt_vfc->vfc_name);\
810 	_rc; })
811 
812 #define	VFS_UNMOUNT(MP, FORCE) ({					\
813 	int _rc;							\
814 									\
815 	_rc = (*(MP)->mnt_op->vfs_unmount)(MP, FORCE);			\
816 	_rc; })
817 
818 #define	VFS_ROOT(MP, FLAGS, VPP) ({					\
819 	int _rc;							\
820 									\
821 	_rc = (*(MP)->mnt_op->vfs_root)(MP, FLAGS, VPP);		\
822 	_rc; })
823 
824 #define	VFS_CACHEDROOT(MP, FLAGS, VPP) ({				\
825 	int _rc;							\
826 									\
827 	_rc = (*(MP)->mnt_op->vfs_cachedroot)(MP, FLAGS, VPP);		\
828 	_rc; })
829 
830 #define	VFS_QUOTACTL(MP, C, U, A) ({					\
831 	int _rc;							\
832 									\
833 	_rc = (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A);		\
834 	_rc; })
835 
836 #define	VFS_STATFS(MP, SBP) ({						\
837 	int _rc;							\
838 									\
839 	_rc = __vfs_statfs((MP), (SBP));				\
840 	_rc; })
841 
842 #define	VFS_SYNC(MP, WAIT) ({						\
843 	int _rc;							\
844 									\
845 	_rc = (*(MP)->mnt_op->vfs_sync)(MP, WAIT);			\
846 	_rc; })
847 
848 #define	VFS_VGET(MP, INO, FLAGS, VPP) ({				\
849 	int _rc;							\
850 									\
851 	_rc = (*(MP)->mnt_op->vfs_vget)(MP, INO, FLAGS, VPP);		\
852 	_rc; })
853 
854 #define	VFS_FHTOVP(MP, FIDP, FLAGS, VPP) ({				\
855 	int _rc;							\
856 									\
857 	_rc = (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, FLAGS, VPP);	\
858 	_rc; })
859 
860 #define	VFS_CHECKEXP(MP, NAM, EXFLG, CRED, NUMSEC, SEC) ({		\
861 	int _rc;							\
862 									\
863 	_rc = (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED, NUMSEC,\
864 	    SEC);							\
865 	_rc; })
866 
867 #define	VFS_EXTATTRCTL(MP, C, FN, NS, N) ({				\
868 	int _rc;							\
869 									\
870 	_rc = (*(MP)->mnt_op->vfs_extattrctl)(MP, C, FN, NS, N);	\
871 	_rc; })
872 
873 #define	VFS_SYSCTL(MP, OP, REQ) ({					\
874 	int _rc;							\
875 									\
876 	_rc = (*(MP)->mnt_op->vfs_sysctl)(MP, OP, REQ);			\
877 	_rc; })
878 
879 #define	VFS_SUSP_CLEAN(MP) do {						\
880 	if (*(MP)->mnt_op->vfs_susp_clean != NULL) {			\
881 		(*(MP)->mnt_op->vfs_susp_clean)(MP);			\
882 	}								\
883 } while (0)
884 
885 #define	VFS_RECLAIM_LOWERVP(MP, VP) do {				\
886 	if (*(MP)->mnt_op->vfs_reclaim_lowervp != NULL) {		\
887 		(*(MP)->mnt_op->vfs_reclaim_lowervp)((MP), (VP));	\
888 	}								\
889 } while (0)
890 
891 #define	VFS_UNLINK_LOWERVP(MP, VP) do {					\
892 	if (*(MP)->mnt_op->vfs_unlink_lowervp != NULL) {		\
893 		(*(MP)->mnt_op->vfs_unlink_lowervp)((MP), (VP));	\
894 	}								\
895 } while (0)
896 
897 #define	VFS_PURGE(MP) do {						\
898 	if (*(MP)->mnt_op->vfs_purge != NULL) {				\
899 		(*(MP)->mnt_op->vfs_purge)(MP);				\
900 	}								\
901 } while (0)
902 
903 #define VFS_KNOTE_LOCKED(vp, hint) do					\
904 {									\
905 	if (((vp)->v_vflag & VV_NOKNOTE) == 0)				\
906 		VN_KNOTE((vp), (hint), KNF_LISTLOCKED);			\
907 } while (0)
908 
909 #define VFS_KNOTE_UNLOCKED(vp, hint) do					\
910 {									\
911 	if (((vp)->v_vflag & VV_NOKNOTE) == 0)				\
912 		VN_KNOTE((vp), (hint), 0);				\
913 } while (0)
914 
915 #define	VFS_NOTIFY_UPPER_RECLAIM	1
916 #define	VFS_NOTIFY_UPPER_UNLINK		2
917 
918 #include <sys/module.h>
919 
920 /*
921  * Version numbers.
922  */
923 #define VFS_VERSION_00	0x19660120
924 #define VFS_VERSION_01	0x20121030
925 #define VFS_VERSION_02	0x20180504
926 #define VFS_VERSION	VFS_VERSION_02
927 
928 #define VFS_SET(vfsops, fsname, flags) \
929 	static struct vfsconf fsname ## _vfsconf = {		\
930 		.vfc_version = VFS_VERSION,			\
931 		.vfc_name = #fsname,				\
932 		.vfc_vfsops = &vfsops,				\
933 		.vfc_typenum = -1,				\
934 		.vfc_flags = flags,				\
935 	};							\
936 	static moduledata_t fsname ## _mod = {			\
937 		#fsname,					\
938 		vfs_modevent,					\
939 		& fsname ## _vfsconf				\
940 	};							\
941 	DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
942 
943 /*
944  * exported vnode operations
945  */
946 
947 int	dounmount(struct mount *, int, struct thread *);
948 
949 int	kernel_mount(struct mntarg *ma, uint64_t flags);
950 int	kernel_vmount(int flags, ...);
951 struct mntarg *mount_arg(struct mntarg *ma, const char *name, const void *val, int len);
952 struct mntarg *mount_argb(struct mntarg *ma, int flag, const char *name);
953 struct mntarg *mount_argf(struct mntarg *ma, const char *name, const char *fmt, ...);
954 struct mntarg *mount_argsu(struct mntarg *ma, const char *name, const void *val, int len);
955 void	statfs_scale_blocks(struct statfs *sf, long max_size);
956 struct vfsconf *vfs_byname(const char *);
957 struct vfsconf *vfs_byname_kld(const char *, struct thread *td, int *);
958 void	vfs_mount_destroy(struct mount *);
959 void	vfs_event_signal(fsid_t *, u_int32_t, intptr_t);
960 void	vfs_freeopts(struct vfsoptlist *opts);
961 void	vfs_deleteopt(struct vfsoptlist *opts, const char *name);
962 int	vfs_buildopts(struct uio *auio, struct vfsoptlist **options);
963 int	vfs_flagopt(struct vfsoptlist *opts, const char *name, uint64_t *w,
964 	    uint64_t val);
965 int	vfs_getopt(struct vfsoptlist *, const char *, void **, int *);
966 int	vfs_getopt_pos(struct vfsoptlist *opts, const char *name);
967 int	vfs_getopt_size(struct vfsoptlist *opts, const char *name,
968 	    off_t *value);
969 char	*vfs_getopts(struct vfsoptlist *, const char *, int *error);
970 int	vfs_copyopt(struct vfsoptlist *, const char *, void *, int);
971 int	vfs_filteropt(struct vfsoptlist *, const char **legal);
972 void	vfs_opterror(struct vfsoptlist *opts, const char *fmt, ...);
973 int	vfs_scanopt(struct vfsoptlist *opts, const char *name, const char *fmt, ...);
974 int	vfs_setopt(struct vfsoptlist *opts, const char *name, void *value,
975 	    int len);
976 int	vfs_setopt_part(struct vfsoptlist *opts, const char *name, void *value,
977 	    int len);
978 int	vfs_setopts(struct vfsoptlist *opts, const char *name,
979 	    const char *value);
980 int	vfs_setpublicfs			    /* set publicly exported fs */
981 	    (struct mount *, struct netexport *, struct export_args *);
982 void	vfs_periodic(struct mount *, int);
983 int	vfs_busy(struct mount *, int);
984 int	vfs_export			 /* process mount export info */
985 	    (struct mount *, struct export_args *);
986 void	vfs_allocate_syncvnode(struct mount *);
987 void	vfs_deallocate_syncvnode(struct mount *);
988 int	vfs_donmount(struct thread *td, uint64_t fsflags,
989 	    struct uio *fsoptions);
990 void	vfs_getnewfsid(struct mount *);
991 struct cdev *vfs_getrootfsid(struct mount *);
992 struct	mount *vfs_getvfs(fsid_t *);      /* return vfs given fsid */
993 struct	mount *vfs_busyfs(fsid_t *);
994 int	vfs_modevent(module_t, int, void *);
995 void	vfs_mount_error(struct mount *, const char *, ...);
996 void	vfs_mountroot(void);			/* mount our root filesystem */
997 void	vfs_mountedfrom(struct mount *, const char *from);
998 void	vfs_notify_upper(struct vnode *, int);
999 struct mount *vfs_ref_from_vp(struct vnode *);
1000 void	vfs_ref(struct mount *);
1001 void	vfs_rel(struct mount *);
1002 struct mount *vfs_mount_alloc(struct vnode *, struct vfsconf *, const char *,
1003 	    struct ucred *);
1004 int	vfs_suser(struct mount *, struct thread *);
1005 void	vfs_unbusy(struct mount *);
1006 void	vfs_unmountall(void);
1007 int	vfs_remount_ro(struct mount *mp);
1008 
1009 extern	TAILQ_HEAD(mntlist, mount) mountlist;	/* mounted filesystem list */
1010 extern	struct mtx_padalign mountlist_mtx;
1011 extern	struct nfs_public nfs_pub;
1012 extern	struct sx vfsconf_sx;
1013 #define	vfsconf_lock()		sx_xlock(&vfsconf_sx)
1014 #define	vfsconf_unlock()	sx_xunlock(&vfsconf_sx)
1015 #define	vfsconf_slock()		sx_slock(&vfsconf_sx)
1016 #define	vfsconf_sunlock()	sx_sunlock(&vfsconf_sx)
1017 struct vnode *mntfs_allocvp(struct mount *, struct vnode *);
1018 void   mntfs_freevp(struct vnode *);
1019 
1020 /*
1021  * Declarations for these vfs default operations are located in
1022  * kern/vfs_default.c.  They will be automatically used to replace
1023  * null entries in VFS ops tables when registering a new filesystem
1024  * type in the global table.
1025  */
1026 vfs_root_t		vfs_stdroot;
1027 vfs_quotactl_t		vfs_stdquotactl;
1028 vfs_statfs_t		vfs_stdstatfs;
1029 vfs_sync_t		vfs_stdsync;
1030 vfs_sync_t		vfs_stdnosync;
1031 vfs_vget_t		vfs_stdvget;
1032 vfs_fhtovp_t		vfs_stdfhtovp;
1033 vfs_checkexp_t		vfs_stdcheckexp;
1034 vfs_init_t		vfs_stdinit;
1035 vfs_uninit_t		vfs_stduninit;
1036 vfs_extattrctl_t	vfs_stdextattrctl;
1037 vfs_sysctl_t		vfs_stdsysctl;
1038 
1039 void	syncer_suspend(void);
1040 void	syncer_resume(void);
1041 
1042 struct vnode *vfs_cache_root_clear(struct mount *);
1043 void	vfs_cache_root_set(struct mount *, struct vnode *);
1044 
1045 void	vfs_op_barrier_wait(struct mount *);
1046 void	vfs_op_enter(struct mount *);
1047 void	vfs_op_exit_locked(struct mount *);
1048 void	vfs_op_exit(struct mount *);
1049 
1050 #ifdef DIAGNOSTIC
1051 void	vfs_assert_mount_counters(struct mount *);
1052 void	vfs_dump_mount_counters(struct mount *);
1053 #else
1054 #define vfs_assert_mount_counters(mp) do { } while (0)
1055 #define vfs_dump_mount_counters(mp) do { } while (0)
1056 #endif
1057 
1058 enum mount_counter { MNT_COUNT_REF, MNT_COUNT_LOCKREF, MNT_COUNT_WRITEOPCOUNT };
1059 int	vfs_mount_fetch_counter(struct mount *, enum mount_counter);
1060 
1061 void suspend_all_fs(void);
1062 void resume_all_fs(void);
1063 
1064 /*
1065  * Code transitioning mnt_vfs_ops to > 0 issues IPIs until it observes
1066  * all CPUs not executing code enclosed by thread_in_ops_pcpu variable.
1067  *
1068  * This provides an invariant that by the time the last CPU is observed not
1069  * executing, everyone else entering will see the counter > 0 and exit.
1070  *
1071  * Note there is no barrier between vfs_ops and the rest of the code in the
1072  * section. It is not necessary as the writer has to wait for everyone to drain
1073  * before making any changes or only make changes safe while the section is
1074  * executed.
1075  */
1076 #define	vfs_mount_pcpu(mp)		zpcpu_get(mp->mnt_pcpu)
1077 #define	vfs_mount_pcpu_remote(mp, cpu)	zpcpu_get_cpu(mp->mnt_pcpu, cpu)
1078 
1079 #define vfs_op_thread_entered(mp) ({				\
1080 	MPASS(curthread->td_critnest > 0);			\
1081 	struct mount_pcpu *_mpcpu = vfs_mount_pcpu(mp);		\
1082 	_mpcpu->mntp_thread_in_ops == 1;			\
1083 })
1084 
1085 #define vfs_op_thread_enter_crit(mp, _mpcpu) ({			\
1086 	bool _retval_crit = true;				\
1087 	MPASS(curthread->td_critnest > 0);			\
1088 	_mpcpu = vfs_mount_pcpu(mp);				\
1089 	MPASS(mpcpu->mntp_thread_in_ops == 0);			\
1090 	_mpcpu->mntp_thread_in_ops = 1;				\
1091 	atomic_interrupt_fence();					\
1092 	if (__predict_false(mp->mnt_vfs_ops > 0)) {		\
1093 		vfs_op_thread_exit_crit(mp, _mpcpu);		\
1094 		_retval_crit = false;				\
1095 	}							\
1096 	_retval_crit;						\
1097 })
1098 
1099 #define vfs_op_thread_enter(mp, _mpcpu) ({			\
1100 	bool _retval;						\
1101 	critical_enter();					\
1102 	_retval = vfs_op_thread_enter_crit(mp, _mpcpu);		\
1103 	if (__predict_false(!_retval))				\
1104 		critical_exit();				\
1105 	_retval;						\
1106 })
1107 
1108 #define vfs_op_thread_exit_crit(mp, _mpcpu) do {		\
1109 	MPASS(_mpcpu == vfs_mount_pcpu(mp));			\
1110 	MPASS(_mpcpu->mntp_thread_in_ops == 1);			\
1111 	atomic_interrupt_fence();					\
1112 	_mpcpu->mntp_thread_in_ops = 0;				\
1113 } while (0)
1114 
1115 #define vfs_op_thread_exit(mp, _mpcpu) do {			\
1116 	vfs_op_thread_exit_crit(mp, _mpcpu);			\
1117 	critical_exit();					\
1118 } while (0)
1119 
1120 #define vfs_mp_count_add_pcpu(_mpcpu, count, val) do {		\
1121 	MPASS(_mpcpu->mntp_thread_in_ops == 1);			\
1122 	_mpcpu->mntp_##count += val;				\
1123 } while (0)
1124 
1125 #define vfs_mp_count_sub_pcpu(_mpcpu, count, val) do {		\
1126 	MPASS(_mpcpu->mntp_thread_in_ops == 1);			\
1127 	_mpcpu->mntp_##count -= val;				\
1128 } while (0)
1129 
1130 #else /* !_KERNEL */
1131 
1132 #include <sys/cdefs.h>
1133 
1134 struct stat;
1135 
1136 __BEGIN_DECLS
1137 int	fhlink(struct fhandle *, const char *);
1138 int	fhlinkat(struct fhandle *, int, const char *);
1139 int	fhopen(const struct fhandle *, int);
1140 int	fhreadlink(struct fhandle *, char *, size_t);
1141 int	fhstat(const struct fhandle *, struct stat *);
1142 int	fhstatfs(const struct fhandle *, struct statfs *);
1143 int	fstatfs(int, struct statfs *);
1144 int	getfh(const char *, fhandle_t *);
1145 int	getfhat(int, char *, struct fhandle *, int);
1146 int	getfsstat(struct statfs *, long, int);
1147 int	getmntinfo(struct statfs **, int);
1148 int	lgetfh(const char *, fhandle_t *);
1149 int	mount(const char *, const char *, int, void *);
1150 int	nmount(struct iovec *, unsigned int, int);
1151 int	statfs(const char *, struct statfs *);
1152 int	unmount(const char *, int);
1153 
1154 /* C library stuff */
1155 int	getvfsbyname(const char *, struct xvfsconf *);
1156 __END_DECLS
1157 
1158 #endif /* _KERNEL */
1159 
1160 #endif /* !_SYS_MOUNT_H_ */
1161