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