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