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