xref: /dragonfly/sys/sys/mount.h (revision ef54aa85)
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  * 3. 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: src/sys/sys/mount.h,v 1.89.2.7 2003/04/04 20:35:57 tegge Exp $
31  */
32 
33 #ifndef _SYS_MOUNT_H_
34 #define _SYS_MOUNT_H_
35 
36 #include <sys/cdefs.h>
37 #include <sys/queue.h>
38 #include <sys/tree.h>
39 #include <sys/ucred.h>
40 
41 #ifndef _KERNEL
42 #if __BSD_VISIBLE
43 #include <sys/stat.h>
44 #endif /* __BSD_VISIBLE */
45 #endif /* !_KERNEL */
46 
47 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
48 #ifndef _SYS_LOCK_H_
49 #include <sys/lock.h>
50 #endif
51 #ifndef _SYS_NAMECACHE_H_
52 #include <sys/namecache.h>
53 #endif
54 #ifndef _SYS_STATVFS_H_
55 #include <sys/statvfs.h>
56 #endif
57 #ifndef _SYS_THREAD_H_
58 #include <sys/thread.h>
59 #endif
60 #include <sys/vfs_quota.h>
61 #include <sys/mplock2.h>
62 #endif
63 
64 struct thread;
65 struct journal;
66 struct vop_ops;
67 struct vop_mountctl_args;
68 struct statvfs;
69 struct vmntvnodescan_info;
70 
71 typedef struct fsid { int32_t val[2]; } fsid_t;	/* file system id type */
72 
73 #define fsidcmp(a, b) memcmp((a), (b), sizeof(fsid_t))
74 
75 /*
76  * File identifier.  These are unique per filesystem on a single machine.
77  *
78  * fix_ext is also used by HAMMER.
79  */
80 #define	MAXFIDSZ	16
81 
82 struct fid {
83 	u_short		fid_len;		/* length of data in bytes */
84 	u_short		fid_ext;		/* extended data 	   */
85 	char		fid_data[MAXFIDSZ];	/* data (variable length) */
86 } __packed;
87 
88 /*
89  * file system statistics
90  */
91 
92 #define MFSNAMELEN	16	/* length of fs type name, including null */
93 #define	MNAMELEN	80	/* length of buffer for returned name */
94 
95 struct statfs {
96 	long	f_spare2;		/* placeholder */
97 	long	f_bsize;		/* fundamental file system block size */
98 	long	f_iosize;		/* optimal transfer block size */
99 	long	f_blocks;		/* total data blocks in file system */
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 file system */
103 	long	f_ffree;		/* free file nodes in fs */
104 	fsid_t	f_fsid;			/* file system 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[MFSNAMELEN]; /* fs type name */
111 	char	f_mntonname[MNAMELEN];	/* 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[MNAMELEN];/* mounted filesystem */
116 	short	f_spares2;		/* unused spare */
117 	long    f_spare[2];		/* unused spare */
118 };
119 
120 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
121 
122 /*
123  * bio_ops are associated with the mount structure and used in conjuction
124  * with the b_dep field in a buffer.  Currently softupdates and HAMMER
125  * utilize this field.
126  *
127  * All bio_ops callbacks must be MPSAFE and could be called without
128  * the mplock.
129  */
130 struct buf;
131 
132 struct bio_ops {
133 	TAILQ_ENTRY(bio_ops) entry;
134 	void	(*io_start) (struct buf *);
135 	void	(*io_complete) (struct buf *);
136 	void	(*io_deallocate) (struct buf *);
137 	int	(*io_fsync) (struct vnode *);
138 	int	(*io_sync) (struct mount *);
139 	void	(*io_movedeps) (struct buf *, struct buf *);
140 	int	(*io_countdeps) (struct buf *, int);
141 	int	(*io_checkread) (struct buf *);
142 	int	(*io_checkwrite) (struct buf *);
143 };
144 
145 #endif
146 
147 /*
148  * vfs quota accounting
149  *
150  * uids and gids often come in contiguous blocks; use a small linear
151  * array as the basic in-memory accounting allocation unit
152  */
153 #define ACCT_CHUNK_BITS	5
154 #define ACCT_CHUNK_NIDS	(1<<ACCT_CHUNK_BITS)
155 #define ACCT_CHUNK_MASK	(ACCT_CHUNK_NIDS - 1)
156 
157 struct ac_counters {
158 	uint64_t space;
159 	uint64_t limit;
160 };
161 
162 struct ac_unode {
163 	RB_ENTRY(ac_unode)	rb_entry;
164 	uid_t			left_bits;
165 	struct ac_counters	uid_chunk[ACCT_CHUNK_NIDS];
166 };
167 
168 struct ac_gnode {
169 	RB_ENTRY(ac_gnode)	rb_entry;
170 	gid_t			left_bits;
171 	struct ac_counters	gid_chunk[ACCT_CHUNK_NIDS];
172 };
173 
174 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
175 
176 struct vfs_acct {
177 	RB_HEAD(ac_utree,ac_unode)	ac_uroot;
178 	RB_HEAD(ac_gtree,ac_gnode)	ac_groot;
179 	uint64_t			ac_bytes;	/* total bytes used */
180 	uint64_t			ac_limit;
181 	struct spinlock			ac_spin;	/* protective spinlock */
182 };
183 
184 
185 /*
186  * Structure per mounted file system.  Each mounted file system has an
187  * array of operations and an instance record.  The file systems are
188  * put on a doubly linked list.
189  *
190  * NOTE: mnt_nvnodelist and mnt_reservedvnlist.  At the moment vnodes
191  * are linked into mnt_nvnodelist.  At some point in the near future the
192  * vnode list will be split into a 'dirty' and 'clean' list. mnt_nvnodelist
193  * will become the dirty list and mnt_reservedvnlist will become the 'clean'
194  * list.  Filesystem kld's syncing code should remain compatible since
195  * they only need to scan the dirty vnode list (nvnodelist -> dirtyvnodelist).
196  *
197  * NOTE: All VFSs must at least populate mnt_vn_ops or those VOP ops that
198  * only take namecache pointers will not be able to find their operations
199  * vector via namecache->nc_mount.
200  *
201  * MPSAFE NOTES: mnt_lock interlocks mounting and unmounting operations.
202  *
203  *		 mnt_token interlocks operations which adjust the mount
204  *		 structure and will also be held through VFS operations
205  *		 for VFSes not flagged MPSAFE.
206  *
207  *		 The VFS should pre-set VFCF_MPSAFE in the VFS_SET() to
208  *		 avoid use of the mplock during mounting.  This will also
209  *		 cause MNTK_ALL_MPSAFE to be set in mnt_kern_flags.  If the
210  *		 VFS does not set VFCF_MPSAFE then it can set individual
211  *		 MNTK_*_MPSAFE flags in mnt_kern_flags.
212  */
213 TAILQ_HEAD(vnodelst, vnode);
214 TAILQ_HEAD(journallst, journal);
215 
216 struct mount {
217 	TAILQ_ENTRY(mount) mnt_list;		/* mount list */
218 	struct vfsops	*mnt_op;		/* operations on fs */
219 	struct vfsconf	*mnt_vfc;		/* configuration info */
220 	u_int		mnt_namecache_gen;	/* ++ to clear negative hits */
221 	u_int		mnt_pbuf_count;		/* pbuf usage limit */
222 	struct vnode	*mnt_syncer;		/* syncer vnode */
223 	struct syncer_ctx *mnt_syncer_ctx;	/* syncer process context */
224 	struct vnodelst	mnt_nvnodelist;		/* list of vnodes this mount */
225 	TAILQ_HEAD(,vmntvnodescan_info) mnt_vnodescan_list;
226 	struct lock	mnt_lock;		/* mount structure lock */
227 	int		mnt_flag;		/* flags shared with user */
228 	int		mnt_kern_flag;		/* kernel only flags */
229 	int		mnt_maxsymlinklen;	/* max size of short symlink */
230 	struct statfs	mnt_stat;		/* cache of filesystem stats */
231 	struct statvfs	mnt_vstat;		/* extended stats */
232 	qaddr_t		mnt_data;		/* private data */
233 	time_t		mnt_time;		/* last time written*/
234 	u_int		mnt_iosize_max;		/* max IO request size */
235 	struct vnodelst	mnt_reservedvnlist;	/* (future) dirty vnode list */
236 	int		mnt_nvnodelistsize;	/* # of vnodes on this mount */
237 
238 	/*
239 	 * ops vectors have a fixed stacking order.  All primary calls run
240 	 * through mnt_vn_ops.  This field is typically assigned to
241 	 * mnt_vn_norm_ops.  If journaling has been enabled this field is
242 	 * usually assigned to mnt_vn_journal_ops.
243 	 */
244 	struct vop_ops	*mnt_vn_use_ops;	/* current ops set */
245 
246 	struct vop_ops	*mnt_vn_coherency_ops;	/* cache coherency ops */
247 	struct vop_ops	*mnt_vn_journal_ops;	/* journaling ops */
248 	struct vop_ops  *mnt_vn_norm_ops;	/* for use by the VFS */
249 	struct vop_ops	*mnt_vn_spec_ops;	/* for use by the VFS */
250 	struct vop_ops	*mnt_vn_fifo_ops;	/* for use by the VFS */
251 	struct nchandle mnt_ncmountpt;		/* mount point */
252 	struct nchandle mnt_ncmounton;		/* mounted on */
253 	char		mnt_pad[16];		/* (try to cache-align refs) */
254 	struct ucred	*mnt_cred;		/* for cr_prison */
255 	int		mnt_refs;		/* nchandle references */
256 	int		mnt_hold;		/* prevent kfree */
257 	struct lwkt_token mnt_token;		/* token lock if not MPSAFE */
258 	struct journallst mnt_jlist;		/* list of active journals */
259 	u_int8_t	*mnt_jbitmap;		/* streamid bitmap */
260 	int16_t		mnt_streamid;		/* last streamid */
261 
262 	struct bio_ops	*mnt_bioops;		/* BIO ops (hammer, softupd) */
263 	struct lock	mnt_renlock;		/* rename directory lock */
264 
265 	struct vfs_acct	mnt_acct;		/* vfs space accounting */
266 	RB_ENTRY(mount)	mnt_node;		/* mnt_stat.f_fsid */
267 };
268 
269 #endif /* _KERNEL || _KERNEL_STRUCTURES */
270 
271 /*
272  * User specifiable flags.
273  */
274 #define	MNT_RDONLY	0x00000001	/* read only filesystem */
275 #define	MNT_SYNCHRONOUS	0x00000002	/* file system written synchronously */
276 #define	MNT_NOEXEC	0x00000004	/* can't exec from filesystem */
277 #define	MNT_NOSUID	0x00000008	/* don't honor setuid bits on fs */
278 #define	MNT_NODEV	0x00000010	/* don't interpret special files */
279 #define	MNT_AUTOMOUNTED	0x00000020	/* mounted by automountd(8) */
280 #define	MNT_ASYNC	0x00000040	/* file system written asynchronously */
281 #define	MNT_SUIDDIR	0x00100000	/* special handling of SUID on dirs */
282 #define	MNT_SOFTDEP	0x00200000	/* soft updates being done */
283 #define	MNT_NOSYMFOLLOW	0x00400000	/* do not follow symlinks */
284 #define	MNT_TRIM	0x01000000	/* Enable online FS trimming */
285 #define	MNT_NOATIME	0x10000000	/* disable update of file access time */
286 #define	MNT_NOCLUSTERR	0x40000000	/* disable cluster read */
287 #define	MNT_NOCLUSTERW	0x80000000	/* disable cluster write */
288 
289 /*
290  * NFS export related mount flags.
291  */
292 #define	MNT_EXRDONLY	0x00000080	/* exported read only */
293 #define	MNT_EXPORTED	0x00000100	/* file system is exported */
294 #define	MNT_DEFEXPORTED	0x00000200	/* exported to the world */
295 #define	MNT_EXPORTANON	0x00000400	/* use anon uid mapping for everyone */
296 #define	MNT_EXKERB	0x00000800	/* exported with Kerberos uid mapping */
297 #define	MNT_EXPUBLIC	0x20000000	/* public export (WebNFS) */
298 
299 /*
300  * Flags set by internal operations,
301  * but visible to the user.
302  * XXX some of these are not quite right.. (I've never seen the root flag set)
303  */
304 #define	MNT_LOCAL	0x00001000	/* filesystem is stored locally */
305 #define	MNT_QUOTA	0x00002000	/* quotas are enabled on filesystem */
306 #define	MNT_ROOTFS	0x00004000	/* identifies the root filesystem */
307 #define	MNT_USER	0x00008000	/* mounted by a user */
308 #define	MNT_IGNORE	0x00800000	/* do not show entry in df */
309 
310 /*
311  * Mask of flags that are visible to statfs()
312  * XXX I think that this could now become (~(MNT_CMDFLAGS))
313  * but the 'mount' program may need changing to handle this.
314  */
315 #define	MNT_VISFLAGMASK	(MNT_RDONLY	| MNT_SYNCHRONOUS | MNT_NOEXEC	| \
316 			MNT_NOSUID	| MNT_NODEV			| \
317 			MNT_ASYNC	| MNT_EXRDONLY	| MNT_EXPORTED	| \
318 			MNT_DEFEXPORTED	| MNT_EXPORTANON| MNT_EXKERB	| \
319 			MNT_LOCAL	| MNT_USER	| MNT_QUOTA	| \
320 			MNT_ROOTFS	| MNT_NOATIME	| MNT_NOCLUSTERR| \
321 			MNT_NOCLUSTERW	| MNT_SUIDDIR	| MNT_SOFTDEP	| \
322 			MNT_IGNORE	| MNT_NOSYMFOLLOW | MNT_EXPUBLIC| \
323 			MNT_TRIM	| MNT_AUTOMOUNTED)
324 /*
325  * External filesystem command modifier flags.
326  * Unmount can use the MNT_FORCE flag.
327  * XXX These are not STATES and really should be somewhere else.
328  */
329 #define	MNT_UPDATE	0x00010000	/* not a real mount, just an update */
330 #define	MNT_DELEXPORT	0x00020000	/* delete export host lists */
331 #define	MNT_RELOAD	0x00040000	/* reload filesystem data */
332 #define	MNT_FORCE	0x00080000	/* force unmount or readonly change */
333 #define MNT_CMDFLAGS	(MNT_UPDATE|MNT_DELEXPORT|MNT_RELOAD|MNT_FORCE)
334 /*
335  * Internal filesystem control flags stored in mnt_kern_flag.
336  *
337  * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed
338  * past the mount point.  This keeps the subtree stable during mounts
339  * and unmounts.
340  *
341  * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while
342  * dounmount() is still waiting to lock the mountpoint. This allows
343  * the filesystem to cancel operations that might otherwise deadlock
344  * with the unmount attempt (used by NFS).
345  *
346  * MNTK_NOSTKMNT prevents mounting another filesystem inside the flagged one.
347  */
348 #define MNTK_UNMOUNTF	0x00000001	/* forced unmount in progress */
349 #define MNTK_QUICKHALT	0x00008000	/* quick unmount on halt */
350 #define MNTK_MPSAFE	0x00010000	/* call vops without mnt_token lock */
351 #define MNTK_RD_MPSAFE	0x00020000	/* vop_read is MPSAFE */
352 #define MNTK_WR_MPSAFE	0x00040000	/* vop_write is MPSAFE */
353 #define MNTK_GA_MPSAFE	0x00080000	/* vop_getattr is MPSAFE */
354 #define MNTK_IN_MPSAFE	0x00100000	/* vop_inactive is MPSAFE */
355 #define MNTK_SG_MPSAFE	0x00200000	/* vop_strategy is MPSAFE */
356 #define MNTK_NCALIASED	0x00800000	/* namecached aliased */
357 #define MNTK_UNMOUNT	0x01000000	/* unmount in progress */
358 #define	MNTK_MWAIT	0x02000000	/* waiting for unmount to finish */
359 #define MNTK_WANTRDWR	0x04000000	/* upgrade to read/write requested */
360 #define MNTK_NOSTKMNT	0x10000000	/* no stacked mount point allowed */
361 #define MNTK_NOMSYNC	0x20000000	/* used by tmpfs */
362 #define MNTK_THR_SYNC	0x40000000	/* fs sync thread requested */
363 #define MNTK_ST_MPSAFE	0x80000000	/* (mfs) vfs_start is MPSAFE */
364 
365 #define MNTK_ALL_MPSAFE	(MNTK_MPSAFE | MNTK_RD_MPSAFE | MNTK_WR_MPSAFE | \
366 			 MNTK_GA_MPSAFE | MNTK_IN_MPSAFE | MNTK_SG_MPSAFE | \
367 			 MNTK_ST_MPSAFE)
368 
369 /*
370  * mountlist_*() defines
371  */
372 #define MNTSCAN_FORWARD		0x0001
373 #define MNTSCAN_REVERSE		0x0002
374 #define MNTSCAN_NOBUSY		0x0004
375 #define MNTSCAN_NOUNLOCK	0x0008
376 
377 #define MNTINS_FIRST		0x0001
378 #define MNTINS_LAST		0x0002
379 
380 /*
381  * Sysctl CTL_VFS definitions.
382  *
383  * Second level identifier specifies which filesystem. Second level
384  * identifier VFS_VFSCONF returns information about all filesystems.
385  * Second level identifier VFS_GENERIC is non-terminal.
386  */
387 #define	VFS_VFSCONF		0	/* get configured filesystems */
388 #define	VFS_GENERIC		0	/* generic filesystem information */
389 /*
390  * Third level identifiers for VFS_GENERIC are given below; third
391  * level identifiers for specific filesystems are given in their
392  * mount specific header files.
393  */
394 #define VFS_MAXTYPENUM	1	/* int: highest defined filesystem type */
395 #define VFS_CONF	2	/* struct: vfsconf for filesystem given
396 				   as next argument */
397 
398 /*
399  * VFS MPLOCK helper.
400  *
401  * We have to cache the supplied mp because in certain situations
402  * the related vnode might go away across the use case (vop_strategy()).
403  */
404 #define VFS_MPLOCK_DECLARE	struct mount *xlock_mp
405 
406 #define VFS_MPLOCK(mp)		VFS_MPLOCK_FLAG(mp, MNTK_MPSAFE)
407 
408 #define VFS_MPLOCK_FLAG(mp, flag)					\
409 		do {							\
410 			if (mp->mnt_kern_flag & flag) {			\
411 				xlock_mp = NULL;			\
412 			} else {					\
413 				xlock_mp = (mp);			\
414 				get_mplock();	/* TEMPORARY */		\
415 				lwkt_gettoken(&xlock_mp->mnt_token);	\
416 			}						\
417 		} while(0)
418 
419 #define VFS_MPUNLOCK()						\
420 		do {							\
421 			if (xlock_mp) {					\
422 				lwkt_reltoken(&xlock_mp->mnt_token);	\
423 				rel_mplock();	/* TEMPORARY */		\
424 			}						\
425 		} while(0)
426 
427 /*
428  * Flags for various system call interfaces.
429  *
430  * waitfor flags to vfs_sync() and getfsstat()
431  */
432 #define MNT_WAIT	0x0001	/* synchronously wait for I/O to complete */
433 #define MNT_NOWAIT	0x0002	/* start all I/O, but do not wait for it */
434 #define MNT_LAZY	0x0004	/* be lazy and do not necessarily push it all */
435 
436 #define VOP_FSYNC_SYSCALL	0x0001	/* from system call */
437 
438 /*
439  * Generic file handle
440  */
441 struct fhandle {
442 	fsid_t	fh_fsid;	/* File system id of mount point */
443 	struct	fid fh_fid;	/* File sys specific id */
444 };
445 typedef struct fhandle	fhandle_t;
446 
447 /*
448  * Export arguments for local filesystem mount calls.
449  */
450 struct export_args {
451 	int	ex_flags;		/* export related flags */
452 	uid_t	ex_root;		/* mapping for root uid */
453 	struct	ucred ex_anon;		/* mapping for anonymous user */
454 	struct	sockaddr *ex_addr;	/* net address to which exported */
455 	int	ex_addrlen;		/* and the net address length */
456 	struct	sockaddr *ex_mask;	/* mask of valid bits in saddr */
457 	int	ex_masklen;		/* and the smask length */
458 	char	*ex_indexfile;		/* index file for WebNFS URLs */
459 };
460 
461 /*
462  * Structure holding information for a publicly exported filesystem
463  * (WebNFS). Currently the specs allow just for one such filesystem.
464  */
465 struct nfs_public {
466 	int		np_valid;	/* Do we hold valid information */
467 	fhandle_t	np_handle;	/* Filehandle for pub fs (internal) */
468 	struct mount	*np_mount;	/* Mountpoint of exported fs */
469 	char		*np_index;	/* Index file */
470 };
471 
472 /*
473  * Filesystem configuration information. One of these exists for each
474  * type of filesystem supported by the kernel. These are searched at
475  * mount time to identify the requested filesystem.
476  */
477 struct vfsconf {
478 	struct	vfsops *vfc_vfsops;	/* filesystem operations vector */
479 	char	vfc_name[MFSNAMELEN];	/* filesystem type name */
480 	int	vfc_typenum;		/* historic filesystem type number */
481 	int	vfc_refcount;		/* number mounted of this type */
482 	int	vfc_flags;		/* permanent flags */
483 	STAILQ_ENTRY(vfsconf) vfc_next;	/* next in list */
484 };
485 
486 struct ovfsconf {
487 	void	*vfc_vfsops;
488 	char	vfc_name[32];
489 	int	vfc_index;
490 	int	vfc_refcount;
491 	int	vfc_flags;
492 };
493 
494 /*
495  * NB: these flags refer to IMPLEMENTATION properties, not properties of
496  * any actual mounts; i.e., it does not make sense to change the flags.
497  */
498 #define	VFCF_STATIC	0x00010000	/* statically compiled into kernel */
499 #define	VFCF_NETWORK	0x00020000	/* may get data over the network */
500 #define	VFCF_READONLY	0x00040000	/* writes are not implemented */
501 #define VFCF_SYNTHETIC	0x00080000	/* data does not represent real files */
502 #define	VFCF_LOOPBACK	0x00100000	/* aliases some other mounted FS */
503 #define	VFCF_UNICODE	0x00200000	/* stores file names as Unicode*/
504 #define VFCF_MPSAFE	0x00400000	/* VFS is fully MPSAFE */
505 
506 /* vfsquery flags */
507 #define VQ_NOTRESP	0x0001	/* server down */
508 #define VQ_NEEDAUTH	0x0002	/* server bad auth */
509 #define VQ_LOWDISK	0x0004	/* we're low on space */
510 #define VQ_MOUNT	0x0008	/* new filesystem arrived */
511 #define VQ_UNMOUNT	0x0010	/* filesystem has left */
512 #define VQ_DEAD		0x0020	/* filesystem is dead, needs force unmount */
513 #define VQ_ASSIST	0x0040	/* filesystem needs assistance from external
514 				   program */
515 #define VQ_NOTRESPLOCK	0x0080	/* server lockd down */
516 #define VQ_FLAG0100	0x0100	/* placeholder */
517 #define VQ_FLAG0200	0x0200	/* placeholder */
518 #define VQ_FLAG0400	0x0400	/* placeholder */
519 #define VQ_FLAG0800	0x0800	/* placeholder */
520 #define VQ_FLAG1000	0x1000	/* placeholder */
521 #define VQ_FLAG2000	0x2000	/* placeholder */
522 #define VQ_FLAG4000	0x4000	/* placeholder */
523 #define VQ_FLAG8000	0x8000	/* placeholder */
524 
525 #ifdef _KERNEL
526 
527 #ifdef MALLOC_DECLARE
528 MALLOC_DECLARE(M_MOUNT);
529 #endif
530 extern int nfs_mount_type;	/* vfc_typenum for nfs, or -1 */
531 
532 struct vfsconf *vfsconf_find_by_name(const char *);
533 struct vfsconf *vfsconf_find_by_typenum(int);
534 int vfsconf_get_maxtypenum(void);
535 int vfsconf_each(int (*)(struct vfsconf *, void *), void *);
536 
537 #endif
538 
539 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
540 
541 TAILQ_HEAD(mntlist, mount);	/* struct mntlist */
542 
543 /*
544  * Operations supported on mounted file system.
545  */
546 struct nlookupdata;
547 struct mbuf;
548 
549 typedef int vfs_mount_t(struct mount *mp, char *path, caddr_t data,
550 				    struct ucred *cred);
551 typedef int vfs_start_t(struct mount *mp, int flags);
552 typedef int vfs_unmount_t(struct mount *mp, int mntflags);
553 typedef int vfs_root_t(struct mount *mp, struct vnode **vpp);
554 typedef int vfs_quotactl_t(struct mount *mp, int cmds, uid_t uid, caddr_t arg,
555 				    struct ucred *cred);
556 typedef int vfs_statfs_t(struct mount *mp, struct statfs *sbp,
557 				    struct ucred *cred);
558 typedef int vfs_statvfs_t(struct mount *mp, struct statvfs *sbp,
559 				    struct ucred *cred);
560 typedef int vfs_sync_t(struct mount *mp, int waitfor);
561 typedef int vfs_vget_t(struct mount *mp, struct vnode *dvp,
562 				    ino_t ino, struct vnode **vpp);
563 typedef int vfs_fhtovp_t(struct mount *mp, struct vnode *rootvp,
564 				    struct fid *fhp, struct vnode **vpp);
565 typedef int vfs_checkexp_t(struct mount *mp, struct sockaddr *nam,
566 				    int *extflagsp, struct ucred **credanonp);
567 typedef int vfs_vptofh_t(struct vnode *vp, struct fid *fhp);
568 typedef int vfs_init_t(struct vfsconf *);
569 typedef int vfs_uninit_t(struct vfsconf *);
570 typedef int vfs_extattrctl_t(struct mount *mp, int cmd, struct vnode *vp,
571 		    int attrnamespace, const char *attrname,
572 		    struct ucred *cred);
573 typedef int vfs_acinit_t(struct mount *mp);
574 typedef void vfs_acdone_t(struct mount *mp);
575 typedef void vfs_account_t(struct mount *mp,
576 			uid_t uid, gid_t gid, int64_t delta);
577 typedef void vfs_ncpgen_set_t(struct mount *mp, struct namecache *ncp);
578 typedef int vfs_ncpgen_test_t(struct mount *mp, struct namecache *ncp);
579 typedef int vfs_modifying_t(struct mount *mp);
580 
581 int vfs_mount(struct mount *mp, char *path, caddr_t data, struct ucred *cred);
582 int vfs_start(struct mount *mp, int flags);
583 int vfs_unmount(struct mount *mp, int mntflags);
584 int vfs_root(struct mount *mp, struct vnode **vpp);
585 int vfs_quotactl(struct mount *mp, int cmds, uid_t uid, caddr_t arg,
586 				struct ucred *cred);
587 int vfs_statfs(struct mount *mp, struct statfs *sbp, struct ucred *cred);
588 int vfs_statvfs(struct mount *mp, struct statvfs *sbp, struct ucred *cred);
589 int vfs_sync(struct mount *mp, int waitfor);
590 int vfs_vget(struct mount *mp, struct vnode *dvp,
591 				ino_t ino, struct vnode **vpp);
592 int vfs_fhtovp(struct mount *mp, struct vnode *rootvp,
593 				struct fid *fhp, struct vnode **vpp);
594 int vfs_checkexp(struct mount *mp, struct sockaddr *nam,
595 				int *extflagsp, struct ucred **credanonp);
596 int vfs_vptofh(struct vnode *vp, struct fid *fhp);
597 int vfs_init(struct vfsconf *vfc);
598 int vfs_uninit(struct vfsconf *vfc, struct vfsconf *vfsp);
599 int vfs_extattrctl(struct mount *mp, int cmd, struct vnode *vp,
600 		    int attrnamespace, const char *attrname,
601 		    struct ucred *cred);
602 int vfs_modifying(struct mount *mp);
603 
604 struct vfsops {
605 	long		vfs_flags;
606 	vfs_mount_t 	*vfs_mount;
607 	vfs_start_t 	*vfs_start;
608 	vfs_unmount_t 	*vfs_unmount;
609 	vfs_root_t   	*vfs_root;
610 	vfs_quotactl_t 	*vfs_quotactl;
611 	vfs_statfs_t 	*vfs_statfs;
612 	vfs_sync_t   	*vfs_sync;
613 	vfs_vget_t  	*vfs_vget;
614 	vfs_fhtovp_t 	*vfs_fhtovp;
615 	vfs_checkexp_t 	*vfs_checkexp;
616 	vfs_vptofh_t 	*vfs_vptofh;
617 	vfs_init_t  	*vfs_init;
618 	vfs_uninit_t 	*vfs_uninit;
619 	vfs_extattrctl_t *vfs_extattrctl;
620 	vfs_statvfs_t 	*vfs_statvfs;
621 	vfs_acinit_t	*vfs_acinit;
622 	vfs_acdone_t	*vfs_acdone;
623 	vfs_account_t	*vfs_account;
624 	vfs_ncpgen_set_t	*vfs_ncpgen_set;
625 	vfs_ncpgen_test_t	*vfs_ncpgen_test;
626 	vfs_modifying_t	*vfs_modifying;
627 };
628 
629 #define VFSOPSF_NOSYNCERTHR	0x00000001
630 
631 #define VFS_MOUNT(MP, PATH, DATA, CRED)		\
632 	vfs_mount(MP, PATH, DATA, CRED)
633 #define VFS_START(MP, FLAGS)			\
634 	vfs_start(MP, FLAGS)
635 #define VFS_UNMOUNT(MP, FORCE)			\
636 	vfs_unmount(MP, FORCE)
637 #define VFS_ROOT(MP, VPP)			\
638 	vfs_root(MP, VPP)
639 #define VFS_QUOTACTL(MP, C, U, A, CRED)		\
640 	vfs_quotactl(MP, C, U, A, CRED)
641 #define VFS_STATFS(MP, SBP, CRED)		\
642 	vfs_statfs(MP, SBP, CRED)
643 #define VFS_STATVFS(MP, SBP, CRED)		\
644 	vfs_statvfs(MP, SBP, CRED)
645 #define VFS_SYNC(MP, WAIT)			\
646 	vfs_sync(MP, WAIT)
647 #define VFS_VGET(MP, DVP, INO, VPP)		\
648 	vfs_vget(MP, DVP, INO, VPP)
649 #define VFS_FHTOVP(MP, ROOTVP, FIDP, VPP) 	\
650 	vfs_fhtovp(MP, ROOTVP, FIDP, VPP)
651 #define	VFS_VPTOFH(VP, FIDP)			\
652 	vfs_vptofh(VP, FIDP)
653 #define VFS_CHECKEXP(MP, NAM, EXFLG, CRED)	\
654 	vfs_checkexp(MP, NAM, EXFLG, CRED)
655 #define VFS_EXTATTRCTL(MP, C, FVP, NS, N, CRED)	\
656 	vfs_extattrctl(MP, C, FVP, NS, N, CRED)
657 #define VFS_ACCOUNT(MP, U, G, D) \
658 	if ((MP->mnt_op->vfs_account != NULL) && (D != 0)) \
659 		MP->mnt_op->vfs_account(MP, U, G, D);
660 #define VFS_ACINIT(MP, ERROR) \
661 	if (vfs_quota_enabled && MP->mnt_op->vfs_acinit != NULL) \
662 		ERROR = MP->mnt_op->vfs_acinit(MP);
663 #define VFS_ACDONE(MP) \
664 	if (vfs_quota_enabled && MP->mnt_op->vfs_acdone != NULL) \
665 		MP->mnt_op->vfs_acdone(MP);
666 #define VFS_NCPGEN_SET(MP, NCP) \
667 	MP->mnt_op->vfs_ncpgen_set(MP, NCP)
668 #define VFS_NCPGEN_TEST(MP, NCP) \
669 	MP->mnt_op->vfs_ncpgen_test(MP, NCP)
670 #define VFS_MODIFYING(MP) \
671 	MP->mnt_op->vfs_modifying(MP)
672 
673 #endif
674 
675 #ifdef _KERNEL
676 
677 #include <sys/module.h>
678 
679 #define VFS_SET(vfsops, fsname, flags) \
680 	static struct vfsconf fsname ## _vfsconf = {		\
681 		&vfsops,					\
682 		#fsname,					\
683 		-1,						\
684 		0,						\
685 		flags,						\
686 		{ NULL },					\
687 	};							\
688 	static moduledata_t fsname ## _mod = {			\
689 		#fsname,					\
690 		vfs_modevent,					\
691 		& fsname ## _vfsconf				\
692 	};							\
693 	DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
694 
695 #endif
696 
697 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
698 
699 #include <net/radix.h>
700 
701 /*
702  * Network address lookup element
703  */
704 struct netcred {
705 	struct	radix_node netc_rnodes[2];
706 	int	netc_exflags;
707 	struct	ucred netc_anon;
708 };
709 
710 /*
711  * Network export information
712  */
713 struct netexport {
714 	struct	netcred ne_defexported;		/* Default export */
715 	struct	radix_node_head *ne_inethead;	/* IPv4 radix */
716 	struct	radix_node_head *ne_inet6head;	/* IPv6 radix */
717 	struct	radix_node_head *ne_maskhead;	/* Shared mask radix */
718 };
719 #define NE_LOCK(nep)		lwkt_getpooltoken(nep)
720 #define NE_UNLOCK(nep)		lwkt_relpooltoken(nep)
721 #define NE_ASSERT_LOCKED(nep)	\
722     ASSERT_LWKT_TOKEN_HELD(lwkt_token_pool_lookup(nep))
723 
724 #endif
725 
726 #ifdef _KERNEL
727 /*
728  * exported vnode operations
729  */
730 void	mount_hold(struct mount *);
731 void	mount_drop(struct mount *);
732 int	dounmount (struct mount *, int, int);
733 int	vfs_setpublicfs			    /* set publicly exported fs */
734 	  (struct mount *, struct netexport *, const struct export_args *);
735 int	vfs_lock (struct mount *);         /* lock a vfs */
736 void	vfs_msync (struct mount *, int);
737 void	vfs_unlock (struct mount *);       /* unlock a vfs */
738 int	vfs_busy (struct mount *, int);
739 int	vfs_export			    /* process mount export info */
740 	  (struct mount *, struct netexport *, const struct export_args *);
741 struct	netcred *vfs_export_lookup	    /* lookup host in fs export list */
742 	  (struct mount *, struct netexport *, struct sockaddr *);
743 int	vfs_allocate_syncvnode (struct mount *);
744 void	vfs_getnewfsid (struct mount *);
745 void	vfs_setfsid(struct mount *mp, fsid_t *template);
746 cdev_t	vfs_getrootfsid (struct mount *);
747 struct	mount *vfs_getvfs (fsid_t *);      /* return vfs given fsid */
748 int	vfs_modevent (module_t, int, void *);
749 int	vfs_mountedon (struct vnode *);    /* is a vfs mounted on vp */
750 int	vfs_rootmountalloc (char *, char *, struct mount **);
751 void	vfs_unbusy (struct mount *);
752 void	vfs_unmountall (int halting);
753 int	vfs_register (struct vfsconf *);
754 int	vfs_unregister (struct vfsconf *);
755 extern	struct nfs_public nfs_pub;
756 
757 /*
758  * Declarations for these vfs default operations are located in
759  * kern/vfs_default.c, they should be used instead of making "dummy"
760  * functions or casting entries in the VFS op table to "enopnotsupp()".
761  */
762 vfs_start_t 	vfs_stdstart;
763 vfs_root_t  	vfs_stdroot;
764 vfs_quotactl_t 	vfs_stdquotactl;
765 vfs_statfs_t  	vfs_stdstatfs;
766 vfs_statvfs_t  	vfs_stdstatvfs;
767 vfs_sync_t   	vfs_stdsync;
768 vfs_sync_t   	vfs_stdnosync;
769 vfs_vget_t  	vfs_stdvget;
770 vfs_fhtovp_t 	vfs_stdfhtovp;
771 vfs_checkexp_t 	vfs_stdcheckexp;
772 vfs_vptofh_t 	vfs_stdvptofh;
773 vfs_init_t  	vfs_stdinit;
774 vfs_uninit_t 	vfs_stduninit;
775 vfs_extattrctl_t vfs_stdextattrctl;
776 vfs_acinit_t	vfs_stdac_init;
777 vfs_acdone_t	vfs_stdac_done;
778 vfs_account_t	vfs_stdaccount;
779 vfs_account_t	vfs_noaccount;
780 vfs_ncpgen_set_t	vfs_stdncpgen_set;
781 vfs_ncpgen_test_t	vfs_stdncpgen_test;
782 vfs_modifying_t	vfs_stdmodifying;
783 
784 struct vop_access_args;
785 int vop_helper_access(struct vop_access_args *ap, uid_t ino_uid, gid_t ino_gid,
786 			mode_t ino_mode, u_int32_t ino_flags);
787 int vop_helper_setattr_flags(u_int32_t *ino_flags, u_int32_t vaflags,
788 			uid_t uid, struct ucred *cred);
789 uid_t vop_helper_create_uid(struct mount *mp, mode_t dmode, uid_t duid,
790 			struct ucred *cred, mode_t *modep);
791 int vop_helper_chmod(struct vnode *vp, mode_t new_mode, struct ucred *cred,
792 			uid_t cur_uid, gid_t cur_gid, mode_t *cur_modep);
793 int vop_helper_chown(struct vnode *vp, uid_t new_uid, gid_t new_gid,
794 			struct ucred *cred,
795 			uid_t *cur_uidp, gid_t *cur_gidp, mode_t *cur_modep);
796 int vop_helper_read_shortcut(struct vop_read_args *ap);
797 
798 void	add_bio_ops(struct bio_ops *ops);
799 void	rem_bio_ops(struct bio_ops *ops);
800 
801 int     journal_mountctl(struct vop_mountctl_args *ap);
802 void	journal_remove_all_journals(struct mount *mp, int flags);
803 
804 void	mountlist_insert(struct mount *, int);
805 int	mountlist_interlock(int (*callback)(struct mount *), struct mount *);
806 struct mount *mountlist_boot_getfirst(void);
807 void	mountlist_remove(struct mount *mp);
808 int	mountlist_exists(struct mount *mp);
809 int	mountlist_scan(int (*callback)(struct mount *, void *), void *, int);
810 struct mount *mount_get_by_nc(struct namecache *ncp);
811 #else /* !_KERNEL */
812 
813 __BEGIN_DECLS
814 int	fstatfs (int, struct statfs *);
815 int	getfh (const char *, fhandle_t *);
816 int	getfsstat (struct statfs *, long, int);
817 int	getmntinfo (struct statfs **, int);
818 int	getmntvinfo (struct statfs **, struct statvfs **, int);
819 int	mount (const char *, const char *, int, void *);
820 int	statfs (const char *, struct statfs *);
821 int	unmount (const char *, int);
822 int	fhopen (const struct fhandle *, int);
823 int	fhstat (const struct fhandle *, struct stat *);
824 int	fhstatfs (const struct fhandle *, struct statfs *);
825 
826 /* C library stuff */
827 void	endvfsent (void);
828 struct	ovfsconf *getvfsbyname (const char *);
829 struct	ovfsconf *getvfsbytype (int);
830 struct	ovfsconf *getvfsent (void);
831 #define	getvfsbyname	new_getvfsbyname
832 int	new_getvfsbyname (const char *, struct vfsconf *);
833 void	setvfsent (int);
834 int	vfsisloadable (const char *);
835 int	vfsload (const char *);
836 __END_DECLS
837 
838 #endif /* _KERNEL */
839 
840 #endif /* !_SYS_MOUNT_H_ */
841 
842