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