2 * Copyright (c) 1989, 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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 * $DragonFly: src/sys/sys/mount.h,v 1.16 2004/12/29 02:40:03 dillon Exp $
41 #include <sys/ucred.h>
44 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)
46 #endif /* !_POSIX_C_SOURCE */
49 #include <sys/queue.h>
57 struct vop_mountctl_args;
59 typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */
63 * These are unique per filesystem on a single machine.
68 u_short fid_len; /* length of data in bytes */
69 u_short fid_reserved; /* force longword alignment */
70 char fid_data[MAXFIDSZ]; /* data (variable length) */
74 * file system statistics
77 #define MFSNAMELEN 16 /* length of fs type name, including null */
78 #define MNAMELEN 80 /* length of buffer for returned name */
81 long f_spare2; /* placeholder */
82 long f_bsize; /* fundamental file system block size */
83 long f_iosize; /* optimal transfer block size */
84 long f_blocks; /* total data blocks in file system */
85 long f_bfree; /* free blocks in fs */
86 long f_bavail; /* free blocks avail to non-superuser */
87 long f_files; /* total file nodes in file system */
88 long f_ffree; /* free file nodes in fs */
89 fsid_t f_fsid; /* file system id */
90 uid_t f_owner; /* user that mounted the filesystem */
91 int f_type; /* type of filesystem */
92 int f_flags; /* copy of mount exported flags */
93 long f_syncwrites; /* count of sync writes since mount */
94 long f_asyncwrites; /* count of async writes since mount */
95 char f_fstypename[MFSNAMELEN]; /* fs type name */
96 char f_mntonname[MNAMELEN]; /* directory on which mounted */
97 long f_syncreads; /* count of sync reads since mount */
98 long f_asyncreads; /* count of async reads since mount */
99 short f_spares1; /* unused spare */
100 char f_mntfromname[MNAMELEN];/* mounted filesystem */
101 short f_spares2; /* unused spare */
102 long f_spare[2]; /* unused spare */
105 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
107 * Structure per mounted file system. Each mounted file system has an
108 * array of operations and an instance record. The file systems are
109 * put on a doubly linked list.
111 * NOTE: mnt_nvnodelist and mnt_reservedvnlist. At the moment vnodes
112 * are linked into mnt_nvnodelist. At some point in the near future the
113 * vnode list will be split into a 'dirty' and 'clean' list. mnt_nvnodelist
114 * will become the dirty list and mnt_reservedvnlist will become the 'clean'
115 * list. Filesystem kld's syncing code should remain compatible since
116 * they only need to scan the dirty vnode list (nvnodelist -> dirtyvnodelist).
118 * NOTE: mnt_fsmanage structures. These structures are required by the new
119 * vnode operations vector abstraction. Each one contains its own operations
120 * vector which is registered just like VNODEOP_SET/vnodeopv_desc except it
121 * is done in the mount code rather then on vfs initialization. This
122 * structure is responsible for per-mount management, including vfs threading,
123 * journaling, and so forth.
125 * NOTE: Any vnode marked VPLACEMARKER is a placemarker and should ALWAYS BE
126 * SKIPPED. NO OTHER FIELDS IN SUCH VNODES ARE VALID.
128 * NOTE: All VFSs must at least populate mnt_vn_ops or those VOP ops that
129 * only take namecache pointers will not be able to find their operations
130 * vector via namecache->nc_mount.
132 TAILQ_HEAD(vnodelst, vnode);
133 TAILQ_HEAD(journallst, journal);
136 TAILQ_ENTRY(mount) mnt_list; /* mount list */
137 struct vfsops *mnt_op; /* operations on fs */
138 struct vfsconf *mnt_vfc; /* configuration info */
139 struct vnode *mnt_vnodecovered; /* vnode we mounted on */
140 struct vnode *mnt_syncer; /* syncer vnode */
141 struct vnodelst mnt_nvnodelist; /* list of vnodes this mount */
142 struct lock mnt_lock; /* mount structure lock */
143 int mnt_flag; /* flags shared with user */
144 int mnt_kern_flag; /* kernel only flags */
145 int mnt_maxsymlinklen; /* max size of short symlink */
146 struct statfs mnt_stat; /* cache of filesystem stats */
147 qaddr_t mnt_data; /* private data */
148 time_t mnt_time; /* last time written*/
149 u_int mnt_iosize_max; /* max IO request size */
150 struct vnodelst mnt_reservedvnlist; /* (future) dirty vnode list */
151 int mnt_nvnodelistsize; /* # of vnodes on this mount */
154 * ops vectors have a fixed stacking order. All primary calls run
155 * through mnt_vn_ops. This field is typically assigned to
156 * mnt_vn_norm_ops. If journaling has been enabled this field is
157 * usually assigned to mnt_vn_journal_ops.
159 struct vop_ops *mnt_vn_use_ops; /* current ops set */
161 struct vop_ops *mnt_vn_coherency_ops; /* cache coherency ops */
162 struct vop_ops *mnt_vn_journal_ops; /* journaling ops */
163 struct vop_ops *mnt_vn_norm_ops; /* for use by the VFS */
164 struct vop_ops *mnt_vn_spec_ops; /* for use by the VFS */
165 struct vop_ops *mnt_vn_fifo_ops; /* for use by the VFS */
166 struct namecache *mnt_ncp; /* NCF_MNTPT ncp */
168 struct journallst mnt_jlist; /* list of active journals */
171 #endif /* _KERNEL || _KERNEL_STRUCTURES */
174 * User specifiable flags.
176 #define MNT_RDONLY 0x00000001 /* read only filesystem */
177 #define MNT_SYNCHRONOUS 0x00000002 /* file system written synchronously */
178 #define MNT_NOEXEC 0x00000004 /* can't exec from filesystem */
179 #define MNT_NOSUID 0x00000008 /* don't honor setuid bits on fs */
180 #define MNT_NODEV 0x00000010 /* don't interpret special files */
181 #define MNT_UNION 0x00000020 /* union with underlying filesystem */
182 #define MNT_ASYNC 0x00000040 /* file system written asynchronously */
183 #define MNT_SUIDDIR 0x00100000 /* special handling of SUID on dirs */
184 #define MNT_SOFTDEP 0x00200000 /* soft updates being done */
185 #define MNT_NOSYMFOLLOW 0x00400000 /* do not follow symlinks */
186 #define MNT_NOATIME 0x10000000 /* disable update of file access time */
187 #define MNT_NOCLUSTERR 0x40000000 /* disable cluster read */
188 #define MNT_NOCLUSTERW 0x80000000 /* disable cluster write */
191 * NFS export related mount flags.
193 #define MNT_EXRDONLY 0x00000080 /* exported read only */
194 #define MNT_EXPORTED 0x00000100 /* file system is exported */
195 #define MNT_DEFEXPORTED 0x00000200 /* exported to the world */
196 #define MNT_EXPORTANON 0x00000400 /* use anon uid mapping for everyone */
197 #define MNT_EXKERB 0x00000800 /* exported with Kerberos uid mapping */
198 #define MNT_EXPUBLIC 0x20000000 /* public export (WebNFS) */
201 * Flags set by internal operations,
202 * but visible to the user.
203 * XXX some of these are not quite right.. (I've never seen the root flag set)
205 #define MNT_LOCAL 0x00001000 /* filesystem is stored locally */
206 #define MNT_QUOTA 0x00002000 /* quotas are enabled on filesystem */
207 #define MNT_ROOTFS 0x00004000 /* identifies the root filesystem */
208 #define MNT_USER 0x00008000 /* mounted by a user */
209 #define MNT_IGNORE 0x00800000 /* do not show entry in df */
212 * Mask of flags that are visible to statfs()
213 * XXX I think that this could now become (~(MNT_CMDFLAGS))
214 * but the 'mount' program may need changing to handle this.
216 #define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \
217 MNT_NOSUID | MNT_NODEV | MNT_UNION | \
218 MNT_ASYNC | MNT_EXRDONLY | MNT_EXPORTED | \
219 MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB | \
220 MNT_LOCAL | MNT_USER | MNT_QUOTA | \
221 MNT_ROOTFS | MNT_NOATIME | MNT_NOCLUSTERR| \
222 MNT_NOCLUSTERW | MNT_SUIDDIR | MNT_SOFTDEP | \
223 MNT_IGNORE | MNT_NOSYMFOLLOW | MNT_EXPUBLIC )
225 * External filesystem command modifier flags.
226 * Unmount can use the MNT_FORCE flag.
227 * XXX These are not STATES and really should be somewhere else.
229 #define MNT_UPDATE 0x00010000 /* not a real mount, just an update */
230 #define MNT_DELEXPORT 0x00020000 /* delete export host lists */
231 #define MNT_RELOAD 0x00040000 /* reload filesystem data */
232 #define MNT_FORCE 0x00080000 /* force unmount or readonly change */
233 #define MNT_CMDFLAGS (MNT_UPDATE|MNT_DELEXPORT|MNT_RELOAD|MNT_FORCE)
235 * Internal filesystem control flags stored in mnt_kern_flag.
237 * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed
238 * past the mount point. This keeps the subtree stable during mounts
241 * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while
242 * dounmount() is still waiting to lock the mountpoint. This allows
243 * the filesystem to cancel operations that might otherwise deadlock
244 * with the unmount attempt (used by NFS).
246 #define MNTK_UNMOUNTF 0x00000001 /* forced unmount in progress */
247 #define MNTK_UNMOUNT 0x01000000 /* unmount in progress */
248 #define MNTK_MWAIT 0x02000000 /* waiting for unmount to finish */
249 #define MNTK_WANTRDWR 0x04000000 /* upgrade to read/write requested */
252 * Sysctl CTL_VFS definitions.
254 * Second level identifier specifies which filesystem. Second level
255 * identifier VFS_VFSCONF returns information about all filesystems.
256 * Second level identifier VFS_GENERIC is non-terminal.
258 #define VFS_VFSCONF 0 /* get configured filesystems */
259 #define VFS_GENERIC 0 /* generic filesystem information */
261 * Third level identifiers for VFS_GENERIC are given below; third
262 * level identifiers for specific filesystems are given in their
263 * mount specific header files.
265 #define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */
266 #define VFS_CONF 2 /* struct: vfsconf for filesystem given
270 * Flags for various system call interfaces.
272 * waitfor flags to vfs_sync() and getfsstat()
274 #define MNT_WAIT 1 /* synchronously wait for I/O to complete */
275 #define MNT_NOWAIT 2 /* start all I/O, but do not wait for it */
276 #define MNT_LAZY 3 /* push data not written by filesystem syncer */
279 * Generic file handle
282 fsid_t fh_fsid; /* File system id of mount point */
283 struct fid fh_fid; /* File sys specific id */
285 typedef struct fhandle fhandle_t;
288 * Export arguments for local filesystem mount calls.
291 int ex_flags; /* export related flags */
292 uid_t ex_root; /* mapping for root uid */
293 struct ucred ex_anon; /* mapping for anonymous user */
294 struct sockaddr *ex_addr; /* net address to which exported */
295 int ex_addrlen; /* and the net address length */
296 struct sockaddr *ex_mask; /* mask of valid bits in saddr */
297 int ex_masklen; /* and the smask length */
298 char *ex_indexfile; /* index file for WebNFS URLs */
302 * Structure holding information for a publicly exported filesystem
303 * (WebNFS). Currently the specs allow just for one such filesystem.
306 int np_valid; /* Do we hold valid information */
307 fhandle_t np_handle; /* Filehandle for pub fs (internal) */
308 struct mount *np_mount; /* Mountpoint of exported fs */
309 char *np_index; /* Index file */
313 * Filesystem configuration information. One of these exists for each
314 * type of filesystem supported by the kernel. These are searched at
315 * mount time to identify the requested filesystem.
318 struct vfsops *vfc_vfsops; /* filesystem operations vector */
319 char vfc_name[MFSNAMELEN]; /* filesystem type name */
320 int vfc_typenum; /* historic filesystem type number */
321 int vfc_refcount; /* number mounted of this type */
322 int vfc_flags; /* permanent flags */
323 struct vfsconf *vfc_next; /* next in list */
335 * NB: these flags refer to IMPLEMENTATION properties, not properties of
336 * any actual mounts; i.e., it does not make sense to change the flags.
338 #define VFCF_STATIC 0x00010000 /* statically compiled into kernel */
339 #define VFCF_NETWORK 0x00020000 /* may get data over the network */
340 #define VFCF_READONLY 0x00040000 /* writes are not implemented */
341 #define VFCF_SYNTHETIC 0x00080000 /* data does not represent real files */
342 #define VFCF_LOOPBACK 0x00100000 /* aliases some other mounted FS */
343 #define VFCF_UNICODE 0x00200000 /* stores file names as Unicode*/
347 #ifdef MALLOC_DECLARE
348 MALLOC_DECLARE(M_MOUNT);
350 extern int maxvfsconf; /* highest defined filesystem type */
351 extern int nfs_mount_type; /* vfc_typenum for nfs, or -1 */
352 extern struct vfsconf *vfsconf; /* head of list of filesystem types */
356 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
358 TAILQ_HEAD(mntlist, mount); /* struct mntlist */
361 * Operations supported on mounted file system.
370 int (*vfs_mount) (struct mount *mp, char *path, caddr_t data,
372 int (*vfs_start) (struct mount *mp, int flags,
374 int (*vfs_unmount) (struct mount *mp, int mntflags,
376 int (*vfs_root) (struct mount *mp, struct vnode **vpp);
377 int (*vfs_quotactl) (struct mount *mp, int cmds, uid_t uid,
378 caddr_t arg, struct thread *td);
379 int (*vfs_statfs) (struct mount *mp, struct statfs *sbp,
381 int (*vfs_sync) (struct mount *mp, int waitfor,
383 int (*vfs_vget) (struct mount *mp, ino_t ino,
385 int (*vfs_fhtovp) (struct mount *mp, struct fid *fhp,
387 int (*vfs_checkexp) (struct mount *mp, struct sockaddr *nam,
388 int *extflagsp, struct ucred **credanonp);
389 int (*vfs_vptofh) (struct vnode *vp, struct fid *fhp);
390 int (*vfs_init) (struct vfsconf *);
391 int (*vfs_uninit) (struct vfsconf *);
392 int (*vfs_extattrctl) (struct mount *mp, int cmd,
393 const char *attrname, caddr_t arg,
397 #define VFS_MOUNT(MP, PATH, DATA, P) \
398 (*(MP)->mnt_op->vfs_mount)(MP, PATH, DATA, P)
399 #define VFS_START(MP, FLAGS, P) (*(MP)->mnt_op->vfs_start)(MP, FLAGS, P)
400 #define VFS_UNMOUNT(MP, FORCE, P) (*(MP)->mnt_op->vfs_unmount)(MP, FORCE, P)
401 #define VFS_ROOT(MP, VPP) (*(MP)->mnt_op->vfs_root)(MP, VPP)
402 #define VFS_QUOTACTL(MP,C,U,A,P) (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A, P)
403 #define VFS_STATFS(MP, SBP, P) (*(MP)->mnt_op->vfs_statfs)(MP, SBP, P)
404 #define VFS_SYNC(MP, WAIT, P) (*(MP)->mnt_op->vfs_sync)(MP, WAIT, P)
405 #define VFS_VGET(MP, INO, VPP) (*(MP)->mnt_op->vfs_vget)(MP, INO, VPP)
406 #define VFS_FHTOVP(MP, FIDP, VPP) \
407 (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, VPP)
408 #define VFS_VPTOFH(VP, FIDP) (*(VP)->v_mount->mnt_op->vfs_vptofh)(VP, FIDP)
409 #define VFS_CHECKEXP(MP, NAM, EXFLG, CRED) \
410 (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED)
411 #define VFS_EXTATTRCTL(MP, C, N, A, P) \
412 (*(MP)->mnt_op->vfs_extattrctl)(MP, C, N, A, P)
418 #include <sys/module.h>
420 #define VFS_SET(vfsops, fsname, flags) \
421 static struct vfsconf fsname ## _vfsconf = { \
429 static moduledata_t fsname ## _mod = { \
432 & fsname ## _vfsconf \
434 DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
438 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
440 #include <net/radix.h>
442 #define AF_MAX 33 /* XXX */
445 * Network address lookup element
448 struct radix_node netc_rnodes[2];
450 struct ucred netc_anon;
454 * Network export information
457 struct netcred ne_defexported; /* Default export */
458 struct radix_node_head *ne_rtable[AF_MAX+1]; /* Individual exports */
465 extern char *mountrootfsname;
468 * exported vnode operations
470 int dounmount (struct mount *, int, struct thread *);
471 int vfs_setpublicfs /* set publicly exported fs */
472 (struct mount *, struct netexport *, struct export_args *);
473 int vfs_lock (struct mount *); /* lock a vfs */
474 void vfs_msync (struct mount *, int);
475 void vfs_unlock (struct mount *); /* unlock a vfs */
476 int vfs_busy (struct mount *, int, struct lwkt_tokref *, struct thread *);
477 void vfs_bufstats(void);
478 int vfs_export /* process mount export info */
479 (struct mount *, struct netexport *, struct export_args *);
480 struct netcred *vfs_export_lookup /* lookup host in fs export list */
481 (struct mount *, struct netexport *, struct sockaddr *);
482 int vfs_allocate_syncvnode (struct mount *);
483 void vfs_getnewfsid (struct mount *);
484 dev_t vfs_getrootfsid (struct mount *);
485 struct mount *vfs_getvfs (fsid_t *); /* return vfs given fsid */
486 int vfs_modevent (module_t, int, void *);
487 int vfs_mountedon (struct vnode *); /* is a vfs mounted on vp */
488 int vfs_rootmountalloc (char *, char *, struct mount **);
489 void vfs_unbusy (struct mount *, struct thread *);
490 void vfs_unmountall (void);
491 int vfs_register (struct vfsconf *);
492 int vfs_unregister (struct vfsconf *);
493 extern struct mntlist mountlist; /* mounted filesystem list */
494 extern struct lwkt_token mountlist_token;
495 extern struct nfs_public nfs_pub;
498 * Declarations for these vfs default operations are located in
499 * kern/vfs_default.c, they should be used instead of making "dummy"
500 * functions or casting entries in the VFS op table to "enopnotsupp()".
502 int vfs_stdmount (struct mount *mp, char *path, caddr_t data,
503 struct nlookupdata *ndp, struct thread *p);
504 int vfs_stdstart (struct mount *mp, int flags, struct thread *p);
505 int vfs_stdunmount (struct mount *mp, int mntflags, struct thread *p);
506 int vfs_stdroot (struct mount *mp, struct vnode **vpp);
507 int vfs_stdquotactl (struct mount *mp, int cmds, uid_t uid,
508 caddr_t arg, struct thread *p);
509 int vfs_stdstatfs (struct mount *mp, struct statfs *sbp, struct thread *p);
510 int vfs_stdsync (struct mount *mp, int waitfor, struct thread *td);
511 int vfs_stdvget (struct mount *mp, ino_t ino, struct vnode **vpp);
512 int vfs_stdfhtovp (struct mount *mp, struct fid *fhp, struct vnode **vpp);
513 int vfs_stdcheckexp (struct mount *mp, struct sockaddr *nam,
514 int *extflagsp, struct ucred **credanonp);
515 int vfs_stdvptofh (struct vnode *vp, struct fid *fhp);
516 int vfs_stdinit (struct vfsconf *);
517 int vfs_stduninit (struct vfsconf *);
518 int vfs_stdextattrctl (struct mount *mp, int cmd, const char *attrname,
519 caddr_t arg, struct thread *p);
520 int journal_mountctl(struct vop_mountctl_args *ap);
524 #include <sys/cdefs.h>
527 int fstatfs (int, struct statfs *);
528 int getfh (const char *, fhandle_t *);
529 int getfsstat (struct statfs *, long, int);
530 int getmntinfo (struct statfs **, int);
531 int mount (const char *, const char *, int, void *);
532 int statfs (const char *, struct statfs *);
533 int unmount (const char *, int);
534 int fhopen (const struct fhandle *, int);
535 int fhstat (const struct fhandle *, struct stat *);
536 int fhstatfs (const struct fhandle *, struct statfs *);
538 /* C library stuff */
539 void endvfsent (void);
540 struct ovfsconf *getvfsbyname (const char *);
541 struct ovfsconf *getvfsbytype (int);
542 struct ovfsconf *getvfsent (void);
543 #define getvfsbyname new_getvfsbyname
544 int new_getvfsbyname (const char *, struct vfsconf *);
545 void setvfsent (int);
546 int vfsisloadable (const char *);
547 int vfsload (const char *);
552 #endif /* !_SYS_MOUNT_H_ */