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