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.15 2004/12/17 00:18:09 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 * NOTE: All VFSs must at least populate mnt_vn_ops or those VOP ops that
127 * only take namecache pointers will not be able to find their operations
128 * vector via namecache->nc_mount.
130 TAILQ_HEAD(vnodelst, vnode);
133 TAILQ_ENTRY(mount) mnt_list; /* mount list */
134 struct vfsops *mnt_op; /* operations on fs */
135 struct vfsconf *mnt_vfc; /* configuration info */
136 struct vnode *mnt_vnodecovered; /* vnode we mounted on */
137 struct vnode *mnt_syncer; /* syncer vnode */
138 struct vnodelst mnt_nvnodelist; /* list of vnodes this mount */
139 struct lock mnt_lock; /* mount structure lock */
140 int mnt_flag; /* flags shared with user */
141 int mnt_kern_flag; /* kernel only flags */
142 int mnt_maxsymlinklen; /* max size of short symlink */
143 struct statfs mnt_stat; /* cache of filesystem stats */
144 qaddr_t mnt_data; /* private data */
145 time_t mnt_time; /* last time written*/
146 u_int mnt_iosize_max; /* max IO request size */
147 struct vnodelst mnt_reservedvnlist; /* (future) dirty vnode list */
148 int mnt_nvnodelistsize; /* # of vnodes on this mount */
151 * ops vectors have a fixed stacking order. All primary calls run
152 * through mnt_vn_ops. This field is typically assigned to
153 * mnt_vn_norm_ops. If journaling has been enabled this field is
154 * usually assigned to mnt_vn_journal_ops.
156 struct vop_ops *mnt_vn_use_ops; /* current ops set */
158 struct vop_ops *mnt_vn_coherency_ops; /* cache coherency ops */
159 struct vop_ops *mnt_vn_journal_ops; /* journaling ops */
160 struct vop_ops *mnt_vn_norm_ops; /* for use by the VFS */
161 struct vop_ops *mnt_vn_spec_ops; /* for use by the VFS */
162 struct vop_ops *mnt_vn_fifo_ops; /* for use by the VFS */
163 struct namecache *mnt_ncp; /* NCF_MNTPT ncp */
165 #endif /* _KERNEL || _KERNEL_STRUCTURES */
168 * User specifiable flags.
170 #define MNT_RDONLY 0x00000001 /* read only filesystem */
171 #define MNT_SYNCHRONOUS 0x00000002 /* file system written synchronously */
172 #define MNT_NOEXEC 0x00000004 /* can't exec from filesystem */
173 #define MNT_NOSUID 0x00000008 /* don't honor setuid bits on fs */
174 #define MNT_NODEV 0x00000010 /* don't interpret special files */
175 #define MNT_UNION 0x00000020 /* union with underlying filesystem */
176 #define MNT_ASYNC 0x00000040 /* file system written asynchronously */
177 #define MNT_SUIDDIR 0x00100000 /* special handling of SUID on dirs */
178 #define MNT_SOFTDEP 0x00200000 /* soft updates being done */
179 #define MNT_NOSYMFOLLOW 0x00400000 /* do not follow symlinks */
180 #define MNT_NOATIME 0x10000000 /* disable update of file access time */
181 #define MNT_NOCLUSTERR 0x40000000 /* disable cluster read */
182 #define MNT_NOCLUSTERW 0x80000000 /* disable cluster write */
185 * NFS export related mount flags.
187 #define MNT_EXRDONLY 0x00000080 /* exported read only */
188 #define MNT_EXPORTED 0x00000100 /* file system is exported */
189 #define MNT_DEFEXPORTED 0x00000200 /* exported to the world */
190 #define MNT_EXPORTANON 0x00000400 /* use anon uid mapping for everyone */
191 #define MNT_EXKERB 0x00000800 /* exported with Kerberos uid mapping */
192 #define MNT_EXPUBLIC 0x20000000 /* public export (WebNFS) */
195 * Flags set by internal operations,
196 * but visible to the user.
197 * XXX some of these are not quite right.. (I've never seen the root flag set)
199 #define MNT_LOCAL 0x00001000 /* filesystem is stored locally */
200 #define MNT_QUOTA 0x00002000 /* quotas are enabled on filesystem */
201 #define MNT_ROOTFS 0x00004000 /* identifies the root filesystem */
202 #define MNT_USER 0x00008000 /* mounted by a user */
203 #define MNT_IGNORE 0x00800000 /* do not show entry in df */
206 * Mask of flags that are visible to statfs()
207 * XXX I think that this could now become (~(MNT_CMDFLAGS))
208 * but the 'mount' program may need changing to handle this.
210 #define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \
211 MNT_NOSUID | MNT_NODEV | MNT_UNION | \
212 MNT_ASYNC | MNT_EXRDONLY | MNT_EXPORTED | \
213 MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB | \
214 MNT_LOCAL | MNT_USER | MNT_QUOTA | \
215 MNT_ROOTFS | MNT_NOATIME | MNT_NOCLUSTERR| \
216 MNT_NOCLUSTERW | MNT_SUIDDIR | MNT_SOFTDEP | \
217 MNT_IGNORE | MNT_NOSYMFOLLOW | MNT_EXPUBLIC )
219 * External filesystem command modifier flags.
220 * Unmount can use the MNT_FORCE flag.
221 * XXX These are not STATES and really should be somewhere else.
223 #define MNT_UPDATE 0x00010000 /* not a real mount, just an update */
224 #define MNT_DELEXPORT 0x00020000 /* delete export host lists */
225 #define MNT_RELOAD 0x00040000 /* reload filesystem data */
226 #define MNT_FORCE 0x00080000 /* force unmount or readonly change */
227 #define MNT_CMDFLAGS (MNT_UPDATE|MNT_DELEXPORT|MNT_RELOAD|MNT_FORCE)
229 * Internal filesystem control flags stored in mnt_kern_flag.
231 * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed
232 * past the mount point. This keeps the subtree stable during mounts
235 * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while
236 * dounmount() is still waiting to lock the mountpoint. This allows
237 * the filesystem to cancel operations that might otherwise deadlock
238 * with the unmount attempt (used by NFS).
240 #define MNTK_UNMOUNTF 0x00000001 /* forced unmount in progress */
241 #define MNTK_UNMOUNT 0x01000000 /* unmount in progress */
242 #define MNTK_MWAIT 0x02000000 /* waiting for unmount to finish */
243 #define MNTK_WANTRDWR 0x04000000 /* upgrade to read/write requested */
246 * Sysctl CTL_VFS definitions.
248 * Second level identifier specifies which filesystem. Second level
249 * identifier VFS_VFSCONF returns information about all filesystems.
250 * Second level identifier VFS_GENERIC is non-terminal.
252 #define VFS_VFSCONF 0 /* get configured filesystems */
253 #define VFS_GENERIC 0 /* generic filesystem information */
255 * Third level identifiers for VFS_GENERIC are given below; third
256 * level identifiers for specific filesystems are given in their
257 * mount specific header files.
259 #define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */
260 #define VFS_CONF 2 /* struct: vfsconf for filesystem given
264 * Flags for various system call interfaces.
266 * waitfor flags to vfs_sync() and getfsstat()
268 #define MNT_WAIT 1 /* synchronously wait for I/O to complete */
269 #define MNT_NOWAIT 2 /* start all I/O, but do not wait for it */
270 #define MNT_LAZY 3 /* push data not written by filesystem syncer */
273 * Generic file handle
276 fsid_t fh_fsid; /* File system id of mount point */
277 struct fid fh_fid; /* File sys specific id */
279 typedef struct fhandle fhandle_t;
282 * Export arguments for local filesystem mount calls.
285 int ex_flags; /* export related flags */
286 uid_t ex_root; /* mapping for root uid */
287 struct ucred ex_anon; /* mapping for anonymous user */
288 struct sockaddr *ex_addr; /* net address to which exported */
289 int ex_addrlen; /* and the net address length */
290 struct sockaddr *ex_mask; /* mask of valid bits in saddr */
291 int ex_masklen; /* and the smask length */
292 char *ex_indexfile; /* index file for WebNFS URLs */
296 * Structure holding information for a publicly exported filesystem
297 * (WebNFS). Currently the specs allow just for one such filesystem.
300 int np_valid; /* Do we hold valid information */
301 fhandle_t np_handle; /* Filehandle for pub fs (internal) */
302 struct mount *np_mount; /* Mountpoint of exported fs */
303 char *np_index; /* Index file */
307 * Filesystem configuration information. One of these exists for each
308 * type of filesystem supported by the kernel. These are searched at
309 * mount time to identify the requested filesystem.
312 struct vfsops *vfc_vfsops; /* filesystem operations vector */
313 char vfc_name[MFSNAMELEN]; /* filesystem type name */
314 int vfc_typenum; /* historic filesystem type number */
315 int vfc_refcount; /* number mounted of this type */
316 int vfc_flags; /* permanent flags */
317 struct vfsconf *vfc_next; /* next in list */
329 * NB: these flags refer to IMPLEMENTATION properties, not properties of
330 * any actual mounts; i.e., it does not make sense to change the flags.
332 #define VFCF_STATIC 0x00010000 /* statically compiled into kernel */
333 #define VFCF_NETWORK 0x00020000 /* may get data over the network */
334 #define VFCF_READONLY 0x00040000 /* writes are not implemented */
335 #define VFCF_SYNTHETIC 0x00080000 /* data does not represent real files */
336 #define VFCF_LOOPBACK 0x00100000 /* aliases some other mounted FS */
337 #define VFCF_UNICODE 0x00200000 /* stores file names as Unicode*/
341 #ifdef MALLOC_DECLARE
342 MALLOC_DECLARE(M_MOUNT);
344 extern int maxvfsconf; /* highest defined filesystem type */
345 extern int nfs_mount_type; /* vfc_typenum for nfs, or -1 */
346 extern struct vfsconf *vfsconf; /* head of list of filesystem types */
350 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
352 TAILQ_HEAD(mntlist, mount); /* struct mntlist */
355 * Operations supported on mounted file system.
364 int (*vfs_mount) (struct mount *mp, char *path, caddr_t data,
366 int (*vfs_start) (struct mount *mp, int flags,
368 int (*vfs_unmount) (struct mount *mp, int mntflags,
370 int (*vfs_root) (struct mount *mp, struct vnode **vpp);
371 int (*vfs_quotactl) (struct mount *mp, int cmds, uid_t uid,
372 caddr_t arg, struct thread *td);
373 int (*vfs_statfs) (struct mount *mp, struct statfs *sbp,
375 int (*vfs_sync) (struct mount *mp, int waitfor,
377 int (*vfs_vget) (struct mount *mp, ino_t ino,
379 int (*vfs_fhtovp) (struct mount *mp, struct fid *fhp,
381 int (*vfs_checkexp) (struct mount *mp, struct sockaddr *nam,
382 int *extflagsp, struct ucred **credanonp);
383 int (*vfs_vptofh) (struct vnode *vp, struct fid *fhp);
384 int (*vfs_init) (struct vfsconf *);
385 int (*vfs_uninit) (struct vfsconf *);
386 int (*vfs_extattrctl) (struct mount *mp, int cmd,
387 const char *attrname, caddr_t arg,
391 #define VFS_MOUNT(MP, PATH, DATA, P) \
392 (*(MP)->mnt_op->vfs_mount)(MP, PATH, DATA, P)
393 #define VFS_START(MP, FLAGS, P) (*(MP)->mnt_op->vfs_start)(MP, FLAGS, P)
394 #define VFS_UNMOUNT(MP, FORCE, P) (*(MP)->mnt_op->vfs_unmount)(MP, FORCE, P)
395 #define VFS_ROOT(MP, VPP) (*(MP)->mnt_op->vfs_root)(MP, VPP)
396 #define VFS_QUOTACTL(MP,C,U,A,P) (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A, P)
397 #define VFS_STATFS(MP, SBP, P) (*(MP)->mnt_op->vfs_statfs)(MP, SBP, P)
398 #define VFS_SYNC(MP, WAIT, P) (*(MP)->mnt_op->vfs_sync)(MP, WAIT, P)
399 #define VFS_VGET(MP, INO, VPP) (*(MP)->mnt_op->vfs_vget)(MP, INO, VPP)
400 #define VFS_FHTOVP(MP, FIDP, VPP) \
401 (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, VPP)
402 #define VFS_VPTOFH(VP, FIDP) (*(VP)->v_mount->mnt_op->vfs_vptofh)(VP, FIDP)
403 #define VFS_CHECKEXP(MP, NAM, EXFLG, CRED) \
404 (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED)
405 #define VFS_EXTATTRCTL(MP, C, N, A, P) \
406 (*(MP)->mnt_op->vfs_extattrctl)(MP, C, N, A, P)
412 #include <sys/module.h>
414 #define VFS_SET(vfsops, fsname, flags) \
415 static struct vfsconf fsname ## _vfsconf = { \
423 static moduledata_t fsname ## _mod = { \
426 & fsname ## _vfsconf \
428 DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
432 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
434 #include <net/radix.h>
436 #define AF_MAX 33 /* XXX */
439 * Network address lookup element
442 struct radix_node netc_rnodes[2];
444 struct ucred netc_anon;
448 * Network export information
451 struct netcred ne_defexported; /* Default export */
452 struct radix_node_head *ne_rtable[AF_MAX+1]; /* Individual exports */
459 extern char *mountrootfsname;
462 * exported vnode operations
464 int dounmount (struct mount *, int, struct thread *);
465 int vfs_setpublicfs /* set publicly exported fs */
466 (struct mount *, struct netexport *, struct export_args *);
467 int vfs_lock (struct mount *); /* lock a vfs */
468 void vfs_msync (struct mount *, int);
469 void vfs_unlock (struct mount *); /* unlock a vfs */
470 int vfs_busy (struct mount *, int, struct lwkt_tokref *, struct thread *);
471 void vfs_bufstats(void);
472 int vfs_export /* process mount export info */
473 (struct mount *, struct netexport *, struct export_args *);
474 struct netcred *vfs_export_lookup /* lookup host in fs export list */
475 (struct mount *, struct netexport *, struct sockaddr *);
476 int vfs_allocate_syncvnode (struct mount *);
477 void vfs_getnewfsid (struct mount *);
478 dev_t vfs_getrootfsid (struct mount *);
479 struct mount *vfs_getvfs (fsid_t *); /* return vfs given fsid */
480 int vfs_modevent (module_t, int, void *);
481 int vfs_mountedon (struct vnode *); /* is a vfs mounted on vp */
482 int vfs_rootmountalloc (char *, char *, struct mount **);
483 void vfs_unbusy (struct mount *, struct thread *);
484 void vfs_unmountall (void);
485 int vfs_register (struct vfsconf *);
486 int vfs_unregister (struct vfsconf *);
487 extern struct mntlist mountlist; /* mounted filesystem list */
488 extern struct lwkt_token mountlist_token;
489 extern struct nfs_public nfs_pub;
492 * Declarations for these vfs default operations are located in
493 * kern/vfs_default.c, they should be used instead of making "dummy"
494 * functions or casting entries in the VFS op table to "enopnotsupp()".
496 int vfs_stdmount (struct mount *mp, char *path, caddr_t data,
497 struct nlookupdata *ndp, struct thread *p);
498 int vfs_stdstart (struct mount *mp, int flags, struct thread *p);
499 int vfs_stdunmount (struct mount *mp, int mntflags, struct thread *p);
500 int vfs_stdroot (struct mount *mp, struct vnode **vpp);
501 int vfs_stdquotactl (struct mount *mp, int cmds, uid_t uid,
502 caddr_t arg, struct thread *p);
503 int vfs_stdstatfs (struct mount *mp, struct statfs *sbp, struct thread *p);
504 int vfs_stdsync (struct mount *mp, int waitfor, struct thread *td);
505 int vfs_stdvget (struct mount *mp, ino_t ino, struct vnode **vpp);
506 int vfs_stdfhtovp (struct mount *mp, struct fid *fhp, struct vnode **vpp);
507 int vfs_stdcheckexp (struct mount *mp, struct sockaddr *nam,
508 int *extflagsp, struct ucred **credanonp);
509 int vfs_stdvptofh (struct vnode *vp, struct fid *fhp);
510 int vfs_stdinit (struct vfsconf *);
511 int vfs_stduninit (struct vfsconf *);
512 int vfs_stdextattrctl (struct mount *mp, int cmd, const char *attrname,
513 caddr_t arg, struct thread *p);
517 #include <sys/cdefs.h>
520 int fstatfs (int, struct statfs *);
521 int getfh (const char *, fhandle_t *);
522 int getfsstat (struct statfs *, long, int);
523 int getmntinfo (struct statfs **, int);
524 int mount (const char *, const char *, int, void *);
525 int statfs (const char *, struct statfs *);
526 int unmount (const char *, int);
527 int fhopen (const struct fhandle *, int);
528 int fhstat (const struct fhandle *, struct stat *);
529 int fhstatfs (const struct fhandle *, struct statfs *);
531 int journal_attach(struct mount *mp);
532 int journal_detach(struct mount *mp);
534 /* C library stuff */
535 void endvfsent (void);
536 struct ovfsconf *getvfsbyname (const char *);
537 struct ovfsconf *getvfsbytype (int);
538 struct ovfsconf *getvfsent (void);
539 #define getvfsbyname new_getvfsbyname
540 int new_getvfsbyname (const char *, struct vfsconf *);
541 void setvfsent (int);
542 int vfsisloadable (const char *);
543 int vfsload (const char *);
548 #endif /* !_SYS_MOUNT_H_ */