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.13 2004/09/30 18:59:50 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 typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */
61 * These are unique per filesystem on a single machine.
66 u_short fid_len; /* length of data in bytes */
67 u_short fid_reserved; /* force longword alignment */
68 char fid_data[MAXFIDSZ]; /* data (variable length) */
72 * file system statistics
75 #define MFSNAMELEN 16 /* length of fs type name, including null */
76 #define MNAMELEN 80 /* length of buffer for returned name */
79 long f_spare2; /* placeholder */
80 long f_bsize; /* fundamental file system block size */
81 long f_iosize; /* optimal transfer block size */
82 long f_blocks; /* total data blocks in file system */
83 long f_bfree; /* free blocks in fs */
84 long f_bavail; /* free blocks avail to non-superuser */
85 long f_files; /* total file nodes in file system */
86 long f_ffree; /* free file nodes in fs */
87 fsid_t f_fsid; /* file system id */
88 uid_t f_owner; /* user that mounted the filesystem */
89 int f_type; /* type of filesystem */
90 int f_flags; /* copy of mount exported flags */
91 long f_syncwrites; /* count of sync writes since mount */
92 long f_asyncwrites; /* count of async writes since mount */
93 char f_fstypename[MFSNAMELEN]; /* fs type name */
94 char f_mntonname[MNAMELEN]; /* directory on which mounted */
95 long f_syncreads; /* count of sync reads since mount */
96 long f_asyncreads; /* count of async reads since mount */
97 short f_spares1; /* unused spare */
98 char f_mntfromname[MNAMELEN];/* mounted filesystem */
99 short f_spares2; /* unused spare */
100 long f_spare[2]; /* unused spare */
103 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
105 * Structure per mounted file system. Each mounted file system has an
106 * array of operations and an instance record. The file systems are
107 * put on a doubly linked list.
109 * NOTE: mnt_nvnodelist and mnt_reservedvnlist. At the moment vnodes
110 * are linked into mnt_nvnodelist. At some point in the near future the
111 * vnode list will be split into a 'dirty' and 'clean' list. mnt_nvnodelist
112 * will become the dirty list and mnt_reservedvnlist will become the 'clean'
113 * list. Filesystem kld's syncing code should remain compatible since
114 * they only need to scan the dirty vnode list (nvnodelist -> dirtyvnodelist).
116 * NOTE: mnt_fsmanage structures. These structures are required by the new
117 * vnode operations vector abstraction. Each one contains its own operations
118 * vector which is registered just like VNODEOP_SET/vnodeopv_desc except it
119 * is done in the mount code rather then on vfs initialization. This
120 * structure is responsible for per-mount management, including vfs threading,
121 * journaling, and so forth.
123 * NOTE: Any vnode marked VPLACEMARKER is a placemarker and should ALWAYS BE
124 * SKIPPED. NO OTHER FIELDS IN SUCH VNODES ARE VALID.
126 TAILQ_HEAD(vnodelst, vnode);
129 TAILQ_ENTRY(mount) mnt_list; /* mount list */
130 struct vfsops *mnt_op; /* operations on fs */
131 struct vfsconf *mnt_vfc; /* configuration info */
132 struct vnode *mnt_vnodecovered; /* vnode we mounted on */
133 struct vnode *mnt_syncer; /* syncer vnode */
134 struct vnodelst mnt_nvnodelist; /* list of vnodes this mount */
135 struct lock mnt_lock; /* mount structure lock */
136 int mnt_flag; /* flags shared with user */
137 int mnt_kern_flag; /* kernel only flags */
138 int mnt_maxsymlinklen; /* max size of short symlink */
139 struct statfs mnt_stat; /* cache of filesystem stats */
140 qaddr_t mnt_data; /* private data */
141 time_t mnt_time; /* last time written*/
142 u_int mnt_iosize_max; /* max IO request size */
143 struct vnodelst mnt_reservedvnlist; /* (future) dirty vnode list */
144 int mnt_nvnodelistsize; /* # of vnodes on this mount */
145 struct vop_ops *mnt_vn_ops; /* for use by the VFS */
146 struct vop_ops *mnt_vn_spec_ops; /* for use by the VFS */
147 struct vop_ops *mnt_vn_fifo_ops; /* for use by the VFS */
148 struct namecache *mnt_ncp; /* NCF_MNTPT ncp */
150 #endif /* _KERNEL || _KERNEL_STRUCTURES */
153 * User specifiable flags.
155 #define MNT_RDONLY 0x00000001 /* read only filesystem */
156 #define MNT_SYNCHRONOUS 0x00000002 /* file system written synchronously */
157 #define MNT_NOEXEC 0x00000004 /* can't exec from filesystem */
158 #define MNT_NOSUID 0x00000008 /* don't honor setuid bits on fs */
159 #define MNT_NODEV 0x00000010 /* don't interpret special files */
160 #define MNT_UNION 0x00000020 /* union with underlying filesystem */
161 #define MNT_ASYNC 0x00000040 /* file system written asynchronously */
162 #define MNT_SUIDDIR 0x00100000 /* special handling of SUID on dirs */
163 #define MNT_SOFTDEP 0x00200000 /* soft updates being done */
164 #define MNT_NOSYMFOLLOW 0x00400000 /* do not follow symlinks */
165 #define MNT_NOATIME 0x10000000 /* disable update of file access time */
166 #define MNT_NOCLUSTERR 0x40000000 /* disable cluster read */
167 #define MNT_NOCLUSTERW 0x80000000 /* disable cluster write */
170 * NFS export related mount flags.
172 #define MNT_EXRDONLY 0x00000080 /* exported read only */
173 #define MNT_EXPORTED 0x00000100 /* file system is exported */
174 #define MNT_DEFEXPORTED 0x00000200 /* exported to the world */
175 #define MNT_EXPORTANON 0x00000400 /* use anon uid mapping for everyone */
176 #define MNT_EXKERB 0x00000800 /* exported with Kerberos uid mapping */
177 #define MNT_EXPUBLIC 0x20000000 /* public export (WebNFS) */
180 * Flags set by internal operations,
181 * but visible to the user.
182 * XXX some of these are not quite right.. (I've never seen the root flag set)
184 #define MNT_LOCAL 0x00001000 /* filesystem is stored locally */
185 #define MNT_QUOTA 0x00002000 /* quotas are enabled on filesystem */
186 #define MNT_ROOTFS 0x00004000 /* identifies the root filesystem */
187 #define MNT_USER 0x00008000 /* mounted by a user */
188 #define MNT_IGNORE 0x00800000 /* do not show entry in df */
191 * Mask of flags that are visible to statfs()
192 * XXX I think that this could now become (~(MNT_CMDFLAGS))
193 * but the 'mount' program may need changing to handle this.
195 #define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \
196 MNT_NOSUID | MNT_NODEV | MNT_UNION | \
197 MNT_ASYNC | MNT_EXRDONLY | MNT_EXPORTED | \
198 MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB | \
199 MNT_LOCAL | MNT_USER | MNT_QUOTA | \
200 MNT_ROOTFS | MNT_NOATIME | MNT_NOCLUSTERR| \
201 MNT_NOCLUSTERW | MNT_SUIDDIR | MNT_SOFTDEP | \
202 MNT_IGNORE | MNT_NOSYMFOLLOW | MNT_EXPUBLIC )
204 * External filesystem command modifier flags.
205 * Unmount can use the MNT_FORCE flag.
206 * XXX These are not STATES and really should be somewhere else.
208 #define MNT_UPDATE 0x00010000 /* not a real mount, just an update */
209 #define MNT_DELEXPORT 0x00020000 /* delete export host lists */
210 #define MNT_RELOAD 0x00040000 /* reload filesystem data */
211 #define MNT_FORCE 0x00080000 /* force unmount or readonly change */
212 #define MNT_CMDFLAGS (MNT_UPDATE|MNT_DELEXPORT|MNT_RELOAD|MNT_FORCE)
214 * Internal filesystem control flags stored in mnt_kern_flag.
216 * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed
217 * past the mount point. This keeps the subtree stable during mounts
220 * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while
221 * dounmount() is still waiting to lock the mountpoint. This allows
222 * the filesystem to cancel operations that might otherwise deadlock
223 * with the unmount attempt (used by NFS).
225 #define MNTK_UNMOUNTF 0x00000001 /* forced unmount in progress */
226 #define MNTK_UNMOUNT 0x01000000 /* unmount in progress */
227 #define MNTK_MWAIT 0x02000000 /* waiting for unmount to finish */
228 #define MNTK_WANTRDWR 0x04000000 /* upgrade to read/write requested */
231 * Sysctl CTL_VFS definitions.
233 * Second level identifier specifies which filesystem. Second level
234 * identifier VFS_VFSCONF returns information about all filesystems.
235 * Second level identifier VFS_GENERIC is non-terminal.
237 #define VFS_VFSCONF 0 /* get configured filesystems */
238 #define VFS_GENERIC 0 /* generic filesystem information */
240 * Third level identifiers for VFS_GENERIC are given below; third
241 * level identifiers for specific filesystems are given in their
242 * mount specific header files.
244 #define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */
245 #define VFS_CONF 2 /* struct: vfsconf for filesystem given
249 * Flags for various system call interfaces.
251 * waitfor flags to vfs_sync() and getfsstat()
253 #define MNT_WAIT 1 /* synchronously wait for I/O to complete */
254 #define MNT_NOWAIT 2 /* start all I/O, but do not wait for it */
255 #define MNT_LAZY 3 /* push data not written by filesystem syncer */
258 * Generic file handle
261 fsid_t fh_fsid; /* File system id of mount point */
262 struct fid fh_fid; /* File sys specific id */
264 typedef struct fhandle fhandle_t;
267 * Export arguments for local filesystem mount calls.
270 int ex_flags; /* export related flags */
271 uid_t ex_root; /* mapping for root uid */
272 struct ucred ex_anon; /* mapping for anonymous user */
273 struct sockaddr *ex_addr; /* net address to which exported */
274 int ex_addrlen; /* and the net address length */
275 struct sockaddr *ex_mask; /* mask of valid bits in saddr */
276 int ex_masklen; /* and the smask length */
277 char *ex_indexfile; /* index file for WebNFS URLs */
281 * Structure holding information for a publicly exported filesystem
282 * (WebNFS). Currently the specs allow just for one such filesystem.
285 int np_valid; /* Do we hold valid information */
286 fhandle_t np_handle; /* Filehandle for pub fs (internal) */
287 struct mount *np_mount; /* Mountpoint of exported fs */
288 char *np_index; /* Index file */
292 * Filesystem configuration information. One of these exists for each
293 * type of filesystem supported by the kernel. These are searched at
294 * mount time to identify the requested filesystem.
297 struct vfsops *vfc_vfsops; /* filesystem operations vector */
298 char vfc_name[MFSNAMELEN]; /* filesystem type name */
299 int vfc_typenum; /* historic filesystem type number */
300 int vfc_refcount; /* number mounted of this type */
301 int vfc_flags; /* permanent flags */
302 struct vfsconf *vfc_next; /* next in list */
314 * NB: these flags refer to IMPLEMENTATION properties, not properties of
315 * any actual mounts; i.e., it does not make sense to change the flags.
317 #define VFCF_STATIC 0x00010000 /* statically compiled into kernel */
318 #define VFCF_NETWORK 0x00020000 /* may get data over the network */
319 #define VFCF_READONLY 0x00040000 /* writes are not implemented */
320 #define VFCF_SYNTHETIC 0x00080000 /* data does not represent real files */
321 #define VFCF_LOOPBACK 0x00100000 /* aliases some other mounted FS */
322 #define VFCF_UNICODE 0x00200000 /* stores file names as Unicode*/
326 #ifdef MALLOC_DECLARE
327 MALLOC_DECLARE(M_MOUNT);
329 extern int maxvfsconf; /* highest defined filesystem type */
330 extern int nfs_mount_type; /* vfc_typenum for nfs, or -1 */
331 extern struct vfsconf *vfsconf; /* head of list of filesystem types */
335 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
337 TAILQ_HEAD(mntlist, mount); /* struct mntlist */
340 * Operations supported on mounted file system.
349 int (*vfs_mount) (struct mount *mp, char *path, caddr_t data,
351 int (*vfs_start) (struct mount *mp, int flags,
353 int (*vfs_unmount) (struct mount *mp, int mntflags,
355 int (*vfs_root) (struct mount *mp, struct vnode **vpp);
356 int (*vfs_quotactl) (struct mount *mp, int cmds, uid_t uid,
357 caddr_t arg, struct thread *td);
358 int (*vfs_statfs) (struct mount *mp, struct statfs *sbp,
360 int (*vfs_sync) (struct mount *mp, int waitfor,
362 int (*vfs_vget) (struct mount *mp, ino_t ino,
364 int (*vfs_fhtovp) (struct mount *mp, struct fid *fhp,
366 int (*vfs_checkexp) (struct mount *mp, struct sockaddr *nam,
367 int *extflagsp, struct ucred **credanonp);
368 int (*vfs_vptofh) (struct vnode *vp, struct fid *fhp);
369 int (*vfs_init) (struct vfsconf *);
370 int (*vfs_uninit) (struct vfsconf *);
371 int (*vfs_extattrctl) (struct mount *mp, int cmd,
372 const char *attrname, caddr_t arg,
376 #define VFS_MOUNT(MP, PATH, DATA, P) \
377 (*(MP)->mnt_op->vfs_mount)(MP, PATH, DATA, P)
378 #define VFS_START(MP, FLAGS, P) (*(MP)->mnt_op->vfs_start)(MP, FLAGS, P)
379 #define VFS_UNMOUNT(MP, FORCE, P) (*(MP)->mnt_op->vfs_unmount)(MP, FORCE, P)
380 #define VFS_ROOT(MP, VPP) (*(MP)->mnt_op->vfs_root)(MP, VPP)
381 #define VFS_QUOTACTL(MP,C,U,A,P) (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A, P)
382 #define VFS_STATFS(MP, SBP, P) (*(MP)->mnt_op->vfs_statfs)(MP, SBP, P)
383 #define VFS_SYNC(MP, WAIT, P) (*(MP)->mnt_op->vfs_sync)(MP, WAIT, P)
384 #define VFS_VGET(MP, INO, VPP) (*(MP)->mnt_op->vfs_vget)(MP, INO, VPP)
385 #define VFS_FHTOVP(MP, FIDP, VPP) \
386 (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, VPP)
387 #define VFS_VPTOFH(VP, FIDP) (*(VP)->v_mount->mnt_op->vfs_vptofh)(VP, FIDP)
388 #define VFS_CHECKEXP(MP, NAM, EXFLG, CRED) \
389 (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED)
390 #define VFS_EXTATTRCTL(MP, C, N, A, P) \
391 (*(MP)->mnt_op->vfs_extattrctl)(MP, C, N, A, P)
397 #include <sys/module.h>
399 #define VFS_SET(vfsops, fsname, flags) \
400 static struct vfsconf fsname ## _vfsconf = { \
408 static moduledata_t fsname ## _mod = { \
411 & fsname ## _vfsconf \
413 DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
417 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
419 #include <net/radix.h>
421 #define AF_MAX 33 /* XXX */
424 * Network address lookup element
427 struct radix_node netc_rnodes[2];
429 struct ucred netc_anon;
433 * Network export information
436 struct netcred ne_defexported; /* Default export */
437 struct radix_node_head *ne_rtable[AF_MAX+1]; /* Individual exports */
444 extern char *mountrootfsname;
447 * exported vnode operations
449 int dounmount (struct mount *, int, struct thread *);
450 int vfs_setpublicfs /* set publicly exported fs */
451 (struct mount *, struct netexport *, struct export_args *);
452 int vfs_lock (struct mount *); /* lock a vfs */
453 void vfs_msync (struct mount *, int);
454 void vfs_unlock (struct mount *); /* unlock a vfs */
455 int vfs_busy (struct mount *, int, struct lwkt_tokref *, struct thread *);
456 void vfs_bufstats(void);
457 int vfs_export /* process mount export info */
458 (struct mount *, struct netexport *, struct export_args *);
459 struct netcred *vfs_export_lookup /* lookup host in fs export list */
460 (struct mount *, struct netexport *, struct sockaddr *);
461 int vfs_allocate_syncvnode (struct mount *);
462 void vfs_getnewfsid (struct mount *);
463 dev_t vfs_getrootfsid (struct mount *);
464 struct mount *vfs_getvfs (fsid_t *); /* return vfs given fsid */
465 int vfs_modevent (module_t, int, void *);
466 int vfs_mountedon (struct vnode *); /* is a vfs mounted on vp */
467 int vfs_rootmountalloc (char *, char *, struct mount **);
468 void vfs_unbusy (struct mount *, struct thread *);
469 void vfs_unmountall (void);
470 int vfs_register (struct vfsconf *);
471 int vfs_unregister (struct vfsconf *);
472 extern struct mntlist mountlist; /* mounted filesystem list */
473 extern struct lwkt_token mountlist_token;
474 extern struct nfs_public nfs_pub;
477 * Declarations for these vfs default operations are located in
478 * kern/vfs_default.c, they should be used instead of making "dummy"
479 * functions or casting entries in the VFS op table to "enopnotsupp()".
481 int vfs_stdmount (struct mount *mp, char *path, caddr_t data,
482 struct nameidata *ndp, struct thread *p);
483 int vfs_stdstart (struct mount *mp, int flags, struct thread *p);
484 int vfs_stdunmount (struct mount *mp, int mntflags, struct thread *p);
485 int vfs_stdroot (struct mount *mp, struct vnode **vpp);
486 int vfs_stdquotactl (struct mount *mp, int cmds, uid_t uid,
487 caddr_t arg, struct thread *p);
488 int vfs_stdstatfs (struct mount *mp, struct statfs *sbp, struct thread *p);
489 int vfs_stdsync (struct mount *mp, int waitfor, struct thread *td);
490 int vfs_stdvget (struct mount *mp, ino_t ino, struct vnode **vpp);
491 int vfs_stdfhtovp (struct mount *mp, struct fid *fhp, struct vnode **vpp);
492 int vfs_stdcheckexp (struct mount *mp, struct sockaddr *nam,
493 int *extflagsp, struct ucred **credanonp);
494 int vfs_stdvptofh (struct vnode *vp, struct fid *fhp);
495 int vfs_stdinit (struct vfsconf *);
496 int vfs_stduninit (struct vfsconf *);
497 int vfs_stdextattrctl (struct mount *mp, int cmd, const char *attrname,
498 caddr_t arg, struct thread *p);
502 #include <sys/cdefs.h>
505 int fstatfs (int, struct statfs *);
506 int getfh (const char *, fhandle_t *);
507 int getfsstat (struct statfs *, long, int);
508 int getmntinfo (struct statfs **, int);
509 int mount (const char *, const char *, int, void *);
510 int statfs (const char *, struct statfs *);
511 int unmount (const char *, int);
512 int fhopen (const struct fhandle *, int);
513 int fhstat (const struct fhandle *, struct stat *);
514 int fhstatfs (const struct fhandle *, struct statfs *);
516 /* C library stuff */
517 void endvfsent (void);
518 struct ovfsconf *getvfsbyname (const char *);
519 struct ovfsconf *getvfsbytype (int);
520 struct ovfsconf *getvfsent (void);
521 #define getvfsbyname new_getvfsbyname
522 int new_getvfsbyname (const char *, struct vfsconf *);
523 void setvfsent (int);
524 int vfsisloadable (const char *);
525 int vfsload (const char *);
530 #endif /* !_SYS_MOUNT_H_ */