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