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