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
41 * XXX - compatability until lockmgr() goes away or all the #includes are
44 #include <sys/lockmgr.h>
46 #include <sys/ucred.h>
47 #include <sys/queue.h>
49 #include <sys/_lock.h>
50 #include <sys/_mutex.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 #if defined(__i386__) || defined(__powerpc__)
76 #define MNAMELEN 80 /* length of buffer for returned name */
78 #if defined(__alpha__) || defined(__ia64__) || defined(__sparc64__)
79 #define MNAMELEN 72 /* length of buffer for returned name */
83 long f_spare2; /* placeholder */
84 long f_bsize; /* fundamental file system block size */
85 long f_iosize; /* optimal transfer block size */
86 long f_blocks; /* total data blocks in file system */
87 long f_bfree; /* free blocks in fs */
88 long f_bavail; /* free blocks avail to non-superuser */
89 long f_files; /* total file nodes in file system */
90 long f_ffree; /* free file nodes in fs */
91 fsid_t f_fsid; /* file system id */
92 uid_t f_owner; /* user that mounted the filesystem */
93 int f_type; /* type of filesystem */
94 int f_flags; /* copy of mount exported flags */
95 long f_syncwrites; /* count of sync writes since mount */
96 long f_asyncwrites; /* count of async writes since mount */
97 char f_fstypename[MFSNAMELEN]; /* fs type name */
98 char f_mntonname[MNAMELEN]; /* directory on which mounted */
99 long f_syncreads; /* count of sync reads since mount */
100 long f_asyncreads; /* count of async reads since mount */
101 short f_spares1; /* unused spare */
102 char f_mntfromname[MNAMELEN];/* mounted filesystem */
103 short f_spares2; /* unused spare */
104 long f_spare[2]; /* unused spare */
109 * Structure per mounted file system. Each mounted file system has an
110 * array of operations and an instance record. The file systems are
111 * put on a doubly linked list.
113 * NOTE: mnt_nvnodelist and mnt_reservedvnlist. At the moment vnodes
114 * are linked into mnt_nvnodelist. At some point in the near future the
115 * vnode list will be split into a 'dirty' and 'clean' list. mnt_nvnodelist
116 * will become the dirty list and mnt_reservedvnlist will become the 'clean'
117 * list. Filesystem kld's syncing code should remain compatible since
118 * they only need to scan the dirty vnode list (nvnodelist -> dirtyvnodelist).
120 TAILQ_HEAD(vnodelst, vnode);
123 TAILQ_ENTRY(mount) mnt_list; /* mount list */
124 struct vfsops *mnt_op; /* operations on fs */
125 struct vfsconf *mnt_vfc; /* configuration info */
126 struct vnode *mnt_vnodecovered; /* vnode we mounted on */
127 struct vnode *mnt_syncer; /* syncer vnode */
128 struct vnodelst mnt_nvnodelist; /* list of vnodes this mount */
129 struct vnodelst mnt_reservedvnlist; /* (future) dirty vnode list */
130 struct lock mnt_lock; /* mount structure lock */
131 int mnt_writeopcount; /* write syscalls in progress */
132 int mnt_flag; /* flags shared with user */
133 int mnt_kern_flag; /* kernel only flags */
134 int mnt_maxsymlinklen; /* max size of short symlink */
135 struct statfs mnt_stat; /* cache of filesystem stats */
136 qaddr_t mnt_data; /* private data */
137 time_t mnt_time; /* last time written*/
138 u_int mnt_iosize_max; /* max IO request size */
139 struct netexport *mnt_export; /* export list */
144 * User specifiable flags.
146 #define MNT_RDONLY 0x00000001 /* read only filesystem */
147 #define MNT_SYNCHRONOUS 0x00000002 /* file system written synchronously */
148 #define MNT_NOEXEC 0x00000004 /* can't exec from filesystem */
149 #define MNT_NOSUID 0x00000008 /* don't honor setuid bits on fs */
150 #define MNT_NODEV 0x00000010 /* don't interpret special files */
151 #define MNT_UNION 0x00000020 /* union with underlying filesystem */
152 #define MNT_ASYNC 0x00000040 /* file system written asynchronously */
153 #define MNT_SUIDDIR 0x00100000 /* special handling of SUID on dirs */
154 #define MNT_SOFTDEP 0x00200000 /* soft updates being done */
155 #define MNT_NOSYMFOLLOW 0x00400000 /* do not follow symlinks */
156 #define MNT_JAILDEVFS 0x02000000 /* Jail friendly DEVFS behaviour */
157 #define MNT_NOATIME 0x10000000 /* disable update of file access time */
158 #define MNT_NOCLUSTERR 0x40000000 /* disable cluster read */
159 #define MNT_NOCLUSTERW 0x80000000 /* disable cluster write */
162 * NFS export related mount flags.
164 #define MNT_EXRDONLY 0x00000080 /* exported read only */
165 #define MNT_EXPORTED 0x00000100 /* file system is exported */
166 #define MNT_DEFEXPORTED 0x00000200 /* exported to the world */
167 #define MNT_EXPORTANON 0x00000400 /* use anon uid mapping for everyone */
168 #define MNT_EXKERB 0x00000800 /* exported with Kerberos uid mapping */
169 #define MNT_EXPUBLIC 0x20000000 /* public export (WebNFS) */
172 * Flags set by internal operations,
173 * but visible to the user.
174 * XXX some of these are not quite right.. (I've never seen the root flag set)
176 #define MNT_LOCAL 0x00001000 /* filesystem is stored locally */
177 #define MNT_QUOTA 0x00002000 /* quotas are enabled on filesystem */
178 #define MNT_ROOTFS 0x00004000 /* identifies the root filesystem */
179 #define MNT_USER 0x00008000 /* mounted by a user */
180 #define MNT_IGNORE 0x00800000 /* do not show entry in df */
183 * Mask of flags that are visible to statfs()
184 * XXX I think that this could now become (~(MNT_CMDFLAGS))
185 * but the 'mount' program may need changing to handle this.
187 #define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \
188 MNT_NOSUID | MNT_NODEV | MNT_UNION | \
189 MNT_ASYNC | MNT_EXRDONLY | MNT_EXPORTED | \
190 MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB | \
191 MNT_LOCAL | MNT_USER | MNT_QUOTA | \
192 MNT_ROOTFS | MNT_NOATIME | MNT_NOCLUSTERR| \
193 MNT_NOCLUSTERW | MNT_SUIDDIR | MNT_SOFTDEP | \
194 MNT_IGNORE | MNT_EXPUBLIC | MNT_NOSYMFOLLOW | \
197 /* Mask of flags that can be updated */
198 #define MNT_UPDATEMASK (MNT_NOSUID | MNT_NOEXEC | MNT_NODEV | \
199 MNT_SYNCHRONOUS | MNT_UNION | MNT_ASYNC | \
201 MNT_NOSYMFOLLOW | MNT_IGNORE | MNT_JAILDEVFS | \
202 MNT_NOCLUSTERR | MNT_NOCLUSTERW | MNT_SUIDDIR)
205 * External filesystem command modifier flags.
206 * Unmount can use the MNT_FORCE flag.
207 * XXX These are not STATES and really should be somewhere else.
209 #define MNT_UPDATE 0x00010000 /* not a real mount, just an update */
210 #define MNT_DELEXPORT 0x00020000 /* delete export host lists */
211 #define MNT_RELOAD 0x00040000 /* reload filesystem data */
212 #define MNT_FORCE 0x00080000 /* force unmount or readonly change */
213 #define MNT_SNAPSHOT 0x01000000 /* snapshot the filesystem */
214 #define MNT_CMDFLAGS (MNT_UPDATE | MNT_DELEXPORT | MNT_RELOAD | \
215 MNT_FORCE | MNT_SNAPSHOT)
219 #define MNT_SPARE2 0x04000000
220 #define MNT_SPARE3 0x08000000
222 * Internal filesystem control flags stored in mnt_kern_flag.
224 * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed
225 * past the mount point. This keeps the subtree stable during mounts
228 #define MNTK_UNMOUNT 0x01000000 /* unmount in progress */
229 #define MNTK_MWAIT 0x02000000 /* waiting for unmount to finish */
230 #define MNTK_WANTRDWR 0x04000000 /* upgrade to read/write requested */
231 #define MNTK_SUSPEND 0x08000000 /* request write suspension */
232 #define MNTK_SUSPENDED 0x10000000 /* write operations are suspended */
235 * Sysctl CTL_VFS definitions.
237 * Second level identifier specifies which filesystem. Second level
238 * identifier VFS_VFSCONF returns information about all filesystems.
239 * Second level identifier VFS_GENERIC is non-terminal.
241 #define VFS_VFSCONF 0 /* get configured filesystems */
242 #define VFS_GENERIC 0 /* generic filesystem information */
244 * Third level identifiers for VFS_GENERIC are given below; third
245 * level identifiers for specific filesystems are given in their
246 * mount specific header files.
248 #define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */
249 #define VFS_CONF 2 /* struct: vfsconf for filesystem given
253 * Flags for various system call interfaces.
255 * waitfor flags to vfs_sync() and getfsstat()
257 #define MNT_WAIT 1 /* synchronously wait for I/O to complete */
258 #define MNT_NOWAIT 2 /* start all I/O, but do not wait for it */
259 #define MNT_LAZY 3 /* push data not written by filesystem syncer */
262 * Generic file handle
265 fsid_t fh_fsid; /* File system id of mount point */
266 struct fid fh_fid; /* File sys specific id */
268 typedef struct fhandle fhandle_t;
271 * Export arguments for local filesystem mount calls.
274 int ex_flags; /* export related flags */
275 uid_t ex_root; /* mapping for root uid */
276 struct xucred ex_anon; /* mapping for anonymous user */
277 struct sockaddr *ex_addr; /* net address to which exported */
278 u_char ex_addrlen; /* and the net address length */
279 struct sockaddr *ex_mask; /* mask of valid bits in saddr */
280 u_char ex_masklen; /* and the smask length */
281 char *ex_indexfile; /* index file for WebNFS URLs */
285 * Structure holding information for a publicly exported filesystem
286 * (WebNFS). Currently the specs allow just for one such filesystem.
289 int np_valid; /* Do we hold valid information */
290 fhandle_t np_handle; /* Filehandle for pub fs (internal) */
291 struct mount *np_mount; /* Mountpoint of exported fs */
292 char *np_index; /* Index file */
296 * Filesystem configuration information. One of these exists for each
297 * type of filesystem supported by the kernel. These are searched at
298 * mount time to identify the requested filesystem.
301 struct vfsops *vfc_vfsops; /* filesystem operations vector */
302 char vfc_name[MFSNAMELEN]; /* filesystem type name */
303 int vfc_typenum; /* historic filesystem type number */
304 int vfc_refcount; /* number mounted of this type */
305 int vfc_flags; /* permanent flags */
306 struct vfsconf *vfc_next; /* next in list */
318 * NB: these flags refer to IMPLEMENTATION properties, not properties of
319 * any actual mounts; i.e., it does not make sense to change the flags.
321 #define VFCF_STATIC 0x00010000 /* statically compiled into kernel */
322 #define VFCF_NETWORK 0x00020000 /* may get data over the network */
323 #define VFCF_READONLY 0x00040000 /* writes are not implemented */
324 #define VFCF_SYNTHETIC 0x00080000 /* data does not represent real files */
325 #define VFCF_LOOPBACK 0x00100000 /* aliases some other mounted FS */
326 #define VFCF_UNICODE 0x00200000 /* stores file names as Unicode*/
330 #ifdef MALLOC_DECLARE
331 MALLOC_DECLARE(M_MOUNT);
333 extern int maxvfsconf; /* highest defined filesystem type */
334 extern int nfs_mount_type; /* vfc_typenum for nfs, or -1 */
335 extern struct vfsconf *vfsconf; /* head of list of filesystem types */
338 * Operations supported on mounted file system.
347 int (*vfs_mount) __P((struct mount *mp, char *path, caddr_t data,
348 struct nameidata *ndp, struct thread *td));
349 int (*vfs_start) __P((struct mount *mp, int flags,
351 int (*vfs_unmount) __P((struct mount *mp, int mntflags,
353 int (*vfs_root) __P((struct mount *mp, struct vnode **vpp));
354 int (*vfs_quotactl) __P((struct mount *mp, int cmds, uid_t uid,
355 caddr_t arg, struct thread *td));
356 int (*vfs_statfs) __P((struct mount *mp, struct statfs *sbp,
358 int (*vfs_sync) __P((struct mount *mp, int waitfor,
359 struct ucred *cred, struct thread *td));
360 int (*vfs_vget) __P((struct mount *mp, ino_t ino,
361 struct vnode **vpp));
362 int (*vfs_fhtovp) __P((struct mount *mp, struct fid *fhp,
363 struct vnode **vpp));
364 int (*vfs_checkexp) __P((struct mount *mp, struct sockaddr *nam,
365 int *extflagsp, struct ucred **credanonp));
366 int (*vfs_vptofh) __P((struct vnode *vp, struct fid *fhp));
367 int (*vfs_init) __P((struct vfsconf *));
368 int (*vfs_uninit) __P((struct vfsconf *));
369 int (*vfs_extattrctl) __P((struct mount *mp, int cmd,
370 struct vnode *filename_vp,
371 int attrnamespace, const char *attrname,
375 #define VFS_MOUNT(MP, PATH, DATA, NDP, P) \
376 (*(MP)->mnt_op->vfs_mount)(MP, PATH, DATA, NDP, P)
377 #define VFS_START(MP, FLAGS, P) (*(MP)->mnt_op->vfs_start)(MP, FLAGS, P)
378 #define VFS_UNMOUNT(MP, FORCE, P) (*(MP)->mnt_op->vfs_unmount)(MP, FORCE, P)
379 #define VFS_ROOT(MP, VPP) (*(MP)->mnt_op->vfs_root)(MP, VPP)
380 #define VFS_QUOTACTL(MP,C,U,A,P) (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A, P)
381 #define VFS_STATFS(MP, SBP, P) (*(MP)->mnt_op->vfs_statfs)(MP, SBP, P)
382 #define VFS_SYNC(MP, WAIT, C, P) (*(MP)->mnt_op->vfs_sync)(MP, WAIT, C, P)
383 #define VFS_VGET(MP, INO, VPP) (*(MP)->mnt_op->vfs_vget)(MP, INO, VPP)
384 #define VFS_FHTOVP(MP, FIDP, VPP) \
385 (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, VPP)
386 #define VFS_VPTOFH(VP, FIDP) (*(VP)->v_mount->mnt_op->vfs_vptofh)(VP, FIDP)
387 #define VFS_CHECKEXP(MP, NAM, EXFLG, CRED) \
388 (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED)
389 #define VFS_EXTATTRCTL(MP, C, FN, NS, N, P) \
390 (*(MP)->mnt_op->vfs_extattrctl)(MP, C, FN, NS, N, P)
392 #include <sys/module.h>
394 #define VFS_SET(vfsops, fsname, flags) \
395 static struct vfsconf fsname ## _vfsconf = { \
402 static moduledata_t fsname ## _mod = { \
405 & fsname ## _vfsconf \
407 DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
409 extern char *mountrootfsname;
412 * exported vnode operations
414 int dounmount __P((struct mount *, int, struct thread *td));
415 int vfs_mount __P((struct thread *td, const char *type, char *path,
416 int flags, void *data));
417 int vfs_setpublicfs /* set publicly exported fs */
418 __P((struct mount *, struct netexport *, struct export_args *));
419 int vfs_lock __P((struct mount *)); /* lock a vfs */
420 void vfs_msync __P((struct mount *, int));
421 void vfs_unlock __P((struct mount *)); /* unlock a vfs */
422 int vfs_busy __P((struct mount *, int, struct mtx *, struct thread *td));
423 int vfs_export /* process mount export info */
424 __P((struct mount *, struct export_args *));
425 struct netcred *vfs_export_lookup /* lookup host in fs export list */
426 __P((struct mount *, struct sockaddr *));
427 int vfs_allocate_syncvnode __P((struct mount *));
428 void vfs_getnewfsid __P((struct mount *));
429 dev_t vfs_getrootfsid __P((struct mount *));
430 struct mount *vfs_getvfs __P((fsid_t *)); /* return vfs given fsid */
431 int vfs_modevent __P((module_t, int, void *));
432 int vfs_mountedon __P((struct vnode *)); /* is a vfs mounted on vp */
433 int vfs_rootmountalloc __P((char *, char *, struct mount **));
434 void vfs_unbusy __P((struct mount *, struct thread *td));
435 void vfs_unmountall __P((void));
436 int vfs_register __P((struct vfsconf *));
437 int vfs_unregister __P((struct vfsconf *));
438 extern TAILQ_HEAD(mntlist, mount) mountlist; /* mounted filesystem list */
439 extern struct mtx mountlist_mtx;
440 extern struct nfs_public nfs_pub;
443 * Declarations for these vfs default operations are located in
444 * kern/vfs_default.c, they should be used instead of making "dummy"
445 * functions or casting entries in the VFS op table to "enopnotsupp()".
447 int vfs_stdmount __P((struct mount *mp, char *path, caddr_t data,
448 struct nameidata *ndp, struct thread *td));
449 int vfs_stdstart __P((struct mount *mp, int flags, struct thread *td));
450 int vfs_stdunmount __P((struct mount *mp, int mntflags, struct thread *td));
451 int vfs_stdroot __P((struct mount *mp, struct vnode **vpp));
452 int vfs_stdquotactl __P((struct mount *mp, int cmds, uid_t uid,
453 caddr_t arg, struct thread *td));
454 int vfs_stdstatfs __P((struct mount *mp, struct statfs *sbp, struct thread *td));
455 int vfs_stdsync __P((struct mount *mp, int waitfor, struct ucred *cred,
457 int vfs_stdvget __P((struct mount *mp, ino_t ino, struct vnode **vpp));
458 int vfs_stdfhtovp __P((struct mount *mp, struct fid *fhp, struct vnode **vpp));
459 int vfs_stdcheckexp __P((struct mount *mp, struct sockaddr *nam,
460 int *extflagsp, struct ucred **credanonp));
461 int vfs_stdvptofh __P((struct vnode *vp, struct fid *fhp));
462 int vfs_stdinit __P((struct vfsconf *));
463 int vfs_stduninit __P((struct vfsconf *));
464 int vfs_stdextattrctl __P((struct mount *mp, int cmd,
465 struct vnode *filename_vp, int attrnamespace, const char *attrname,
468 /* XXX - these should be indirect functions!!! */
469 int softdep_process_worklist __P((struct mount *));
470 int softdep_fsync __P((struct vnode *));
473 #include <sys/cdefs.h>
478 int fhopen __P((const struct fhandle *, int));
479 int fhstat __P((const struct fhandle *, struct stat *));
480 int fhstatfs __P((const struct fhandle *, struct statfs *));
481 int fstatfs __P((int, struct statfs *));
482 int getfh __P((const char *, fhandle_t *));
483 int getfsstat __P((struct statfs *, long, int));
484 int getmntinfo __P((struct statfs **, int));
485 int mount __P((const char *, const char *, int, void *));
486 int statfs __P((const char *, struct statfs *));
487 int unmount __P((const char *, int));
489 /* C library stuff */
490 void endvfsent __P((void));
491 struct ovfsconf *getvfsbyname __P((const char *));
492 struct ovfsconf *getvfsbytype __P((int));
493 struct ovfsconf *getvfsent __P((void));
494 #define getvfsbyname new_getvfsbyname
495 int new_getvfsbyname __P((const char *, struct vfsconf *));
496 void setvfsent __P((int));
497 int vfsisloadable __P((const char *));
498 int vfsload __P((const char *));
503 #endif /* !_SYS_MOUNT_H_ */