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