mount.h revision 51797
1/* 2 * Copyright (c) 1989, 1991, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 20 * 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 31 * SUCH DAMAGE. 32 * 33 * @(#)mount.h 8.21 (Berkeley) 5/20/95 34 * $FreeBSD: head/sys/sys/mount.h 51797 1999-09-29 20:05:33Z phk $ 35 */ 36 37#ifndef _SYS_MOUNT_H_ 38#define _SYS_MOUNT_H_ 39 40#include <sys/ucred.h> 41 42#ifndef KERNEL 43#if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE) 44#include <sys/stat.h> 45#endif /* !_POSIX_C_SOURCE */ 46#endif /* !KERNEL */ 47 48#include <sys/queue.h> 49#include <sys/lock.h> 50 51typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */ 52 53/* 54 * File identifier. 55 * These are unique per filesystem on a single machine. 56 */ 57#define MAXFIDSZ 16 58 59struct fid { 60 u_short fid_len; /* length of data in bytes */ 61 u_short fid_reserved; /* force longword alignment */ 62 char fid_data[MAXFIDSZ]; /* data (variable length) */ 63}; 64 65/* 66 * file system statistics 67 */ 68 69#define MFSNAMELEN 16 /* length of fs type name, including null */ 70#define MNAMELEN 90 /* length of buffer for returned name */ 71 72struct statfs { 73 long f_spare2; /* placeholder */ 74 long f_bsize; /* fundamental file system block size */ 75 long f_iosize; /* optimal transfer block size */ 76 long f_blocks; /* total data blocks in file system */ 77 long f_bfree; /* free blocks in fs */ 78 long f_bavail; /* free blocks avail to non-superuser */ 79 long f_files; /* total file nodes in file system */ 80 long f_ffree; /* free file nodes in fs */ 81 fsid_t f_fsid; /* file system id */ 82 uid_t f_owner; /* user that mounted the filesystem */ 83 int f_type; /* type of filesystem */ 84 int f_flags; /* copy of mount exported flags */ 85 long f_syncwrites; /* count of sync writes since mount */ 86 long f_asyncwrites; /* count of async writes since mount */ 87 char f_fstypename[MFSNAMELEN]; /* fs type name */ 88 char f_mntonname[MNAMELEN]; /* directory on which mounted */ 89 char f_mntfromname[MNAMELEN];/* mounted filesystem */ 90}; 91 92/* 93 * Structure per mounted file system. Each mounted file system has an 94 * array of operations and an instance record. The file systems are 95 * put on a doubly linked list. 96 */ 97LIST_HEAD(vnodelst, vnode); 98 99struct mount { 100 CIRCLEQ_ENTRY(mount) mnt_list; /* mount list */ 101 struct vfsops *mnt_op; /* operations on fs */ 102 struct vfsconf *mnt_vfc; /* configuration info */ 103 struct vnode *mnt_vnodecovered; /* vnode we mounted on */ 104 struct vnode *mnt_syncer; /* syncer vnode */ 105 struct vnodelst mnt_vnodelist; /* list of vnodes this mount */ 106 struct lock mnt_lock; /* mount structure lock */ 107 int mnt_flag; /* flags shared with user */ 108 int mnt_kern_flag; /* kernel only flags */ 109 int mnt_maxsymlinklen; /* max size of short symlink */ 110 struct statfs mnt_stat; /* cache of filesystem stats */ 111 qaddr_t mnt_data; /* private data */ 112 time_t mnt_time; /* last time written*/ 113 u_int mnt_iosize_max; /* max IO request size */ 114}; 115 116/* 117 * User specifiable flags. 118 */ 119#define MNT_RDONLY 0x00000001 /* read only filesystem */ 120#define MNT_SYNCHRONOUS 0x00000002 /* file system written synchronously */ 121#define MNT_NOEXEC 0x00000004 /* can't exec from filesystem */ 122#define MNT_NOSUID 0x00000008 /* don't honor setuid bits on fs */ 123#define MNT_NODEV 0x00000010 /* don't interpret special files */ 124#define MNT_UNION 0x00000020 /* union with underlying filesystem */ 125#define MNT_ASYNC 0x00000040 /* file system written asynchronously */ 126#define MNT_SUIDDIR 0x00100000 /* special handling of SUID on dirs */ 127#define MNT_SOFTDEP 0x00200000 /* soft updates being done */ 128#define MNT_NOSYMFOLLOW 0x00400000 /* do not follow symlinks */ 129#define MNT_NOATIME 0x10000000 /* disable update of file access time */ 130#define MNT_NOCLUSTERR 0x40000000 /* disable cluster read */ 131#define MNT_NOCLUSTERW 0x80000000 /* disable cluster write */ 132 133/* 134 * NFS export related mount flags. 135 */ 136#define MNT_EXRDONLY 0x00000080 /* exported read only */ 137#define MNT_EXPORTED 0x00000100 /* file system is exported */ 138#define MNT_DEFEXPORTED 0x00000200 /* exported to the world */ 139#define MNT_EXPORTANON 0x00000400 /* use anon uid mapping for everyone */ 140#define MNT_EXKERB 0x00000800 /* exported with Kerberos uid mapping */ 141#define MNT_EXPUBLIC 0x20000000 /* public export (WebNFS) */ 142 143/* 144 * Flags set by internal operations, 145 * but visible to the user. 146 * XXX some of these are not quite right.. (I've never seen the root flag set) 147 */ 148#define MNT_LOCAL 0x00001000 /* filesystem is stored locally */ 149#define MNT_QUOTA 0x00002000 /* quotas are enabled on filesystem */ 150#define MNT_ROOTFS 0x00004000 /* identifies the root filesystem */ 151#define MNT_USER 0x00008000 /* mounted by a user */ 152 153/* 154 * Mask of flags that are visible to statfs() 155 * XXX I think that this could now become (~(MNT_CMDFLAGS)) 156 * but the 'mount' program may need changing to handle this. 157 * XXX MNT_EXPUBLIC is presently left out. I don't know why. 158 */ 159#define MNT_VISFLAGMASK (MNT_RDONLY | MNT_SYNCHRONOUS | MNT_NOEXEC | \ 160 MNT_NOSUID | MNT_NODEV | MNT_UNION | \ 161 MNT_ASYNC | MNT_EXRDONLY | MNT_EXPORTED | \ 162 MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB | \ 163 MNT_LOCAL | MNT_USER | MNT_QUOTA | \ 164 MNT_ROOTFS | MNT_NOATIME | MNT_NOCLUSTERR| \ 165 MNT_NOCLUSTERW | MNT_SUIDDIR | MNT_SOFTDEP \ 166 /* | MNT_EXPUBLIC */) 167/* 168 * External filesystem command modifier flags. 169 * Unmount can use the MNT_FORCE flag. 170 * XXX These are not STATES and really should be somewhere else. 171 */ 172#define MNT_UPDATE 0x00010000 /* not a real mount, just an update */ 173#define MNT_DELEXPORT 0x00020000 /* delete export host lists */ 174#define MNT_RELOAD 0x00040000 /* reload filesystem data */ 175#define MNT_FORCE 0x00080000 /* force unmount or readonly change */ 176#define MNT_CMDFLAGS (MNT_UPDATE|MNT_DELEXPORT|MNT_RELOAD|MNT_FORCE) 177/* 178 * Internal filesystem control flags stored in mnt_kern_flag. 179 * 180 * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed 181 * past the mount point. This keeps the subtree stable during mounts 182 * and unmounts. 183 */ 184#define MNTK_UNMOUNT 0x01000000 /* unmount in progress */ 185#define MNTK_MWAIT 0x02000000 /* waiting for unmount to finish */ 186#define MNTK_WANTRDWR 0x04000000 /* upgrade to read/write requested */ 187 188/* 189 * Sysctl CTL_VFS definitions. 190 * 191 * Second level identifier specifies which filesystem. Second level 192 * identifier VFS_VFSCONF returns information about all filesystems. 193 * Second level identifier VFS_GENERIC is non-terminal. 194 */ 195#define VFS_VFSCONF 0 /* get configured filesystems */ 196#define VFS_GENERIC 0 /* generic filesystem information */ 197/* 198 * Third level identifiers for VFS_GENERIC are given below; third 199 * level identifiers for specific filesystems are given in their 200 * mount specific header files. 201 */ 202#define VFS_MAXTYPENUM 1 /* int: highest defined filesystem type */ 203#define VFS_CONF 2 /* struct: vfsconf for filesystem given 204 as next argument */ 205 206/* 207 * Flags for various system call interfaces. 208 * 209 * waitfor flags to vfs_sync() and getfsstat() 210 */ 211#define MNT_WAIT 1 /* synchronously wait for I/O to complete */ 212#define MNT_NOWAIT 2 /* start all I/O, but do not wait for it */ 213#define MNT_LAZY 3 /* push data not written by filesystem syncer */ 214 215/* 216 * Generic file handle 217 */ 218struct fhandle { 219 fsid_t fh_fsid; /* File system id of mount point */ 220 struct fid fh_fid; /* File sys specific id */ 221}; 222typedef struct fhandle fhandle_t; 223 224/* 225 * Export arguments for local filesystem mount calls. 226 */ 227struct export_args { 228 int ex_flags; /* export related flags */ 229 uid_t ex_root; /* mapping for root uid */ 230 struct ucred ex_anon; /* mapping for anonymous user */ 231 struct sockaddr *ex_addr; /* net address to which exported */ 232 int ex_addrlen; /* and the net address length */ 233 struct sockaddr *ex_mask; /* mask of valid bits in saddr */ 234 int ex_masklen; /* and the smask length */ 235 char *ex_indexfile; /* index file for WebNFS URLs */ 236}; 237 238/* 239 * Structure holding information for a publicly exported filesystem 240 * (WebNFS). Currently the specs allow just for one such filesystem. 241 */ 242struct nfs_public { 243 int np_valid; /* Do we hold valid information */ 244 fhandle_t np_handle; /* Filehandle for pub fs (internal) */ 245 struct mount *np_mount; /* Mountpoint of exported fs */ 246 char *np_index; /* Index file */ 247}; 248 249/* 250 * Filesystem configuration information. One of these exists for each 251 * type of filesystem supported by the kernel. These are searched at 252 * mount time to identify the requested filesystem. 253 */ 254struct vfsconf { 255 struct vfsops *vfc_vfsops; /* filesystem operations vector */ 256 char vfc_name[MFSNAMELEN]; /* filesystem type name */ 257 int vfc_typenum; /* historic filesystem type number */ 258 int vfc_refcount; /* number mounted of this type */ 259 int vfc_flags; /* permanent flags */ 260 struct vfsconf *vfc_next; /* next in list */ 261}; 262 263struct ovfsconf { 264 void *vfc_vfsops; 265 char vfc_name[32]; 266 int vfc_index; 267 int vfc_refcount; 268 int vfc_flags; 269}; 270 271/* 272 * NB: these flags refer to IMPLEMENTATION properties, not properties of 273 * any actual mounts; i.e., it does not make sense to change the flags. 274 */ 275#define VFCF_STATIC 0x00010000 /* statically compiled into kernel */ 276#define VFCF_NETWORK 0x00020000 /* may get data over the network */ 277#define VFCF_READONLY 0x00040000 /* writes are not implemented */ 278#define VFCF_SYNTHETIC 0x00080000 /* data does not represent real files */ 279#define VFCF_LOOPBACK 0x00100000 /* aliases some other mounted FS */ 280#define VFCF_UNICODE 0x00200000 /* stores file names as Unicode*/ 281 282#ifdef KERNEL 283 284#ifdef MALLOC_DECLARE 285MALLOC_DECLARE(M_MOUNT); 286#endif 287extern int maxvfsconf; /* highest defined filesystem type */ 288extern int nfs_mount_type; /* vfc_typenum for nfs, or -1 */ 289extern struct vfsconf *vfsconf; /* head of list of filesystem types */ 290 291/* 292 * Operations supported on mounted file system. 293 */ 294#ifdef __STDC__ 295struct nameidata; 296struct mbuf; 297#endif 298 299struct vfsops { 300 int (*vfs_mount) __P((struct mount *mp, char *path, caddr_t data, 301 struct nameidata *ndp, struct proc *p)); 302 int (*vfs_start) __P((struct mount *mp, int flags, 303 struct proc *p)); 304 int (*vfs_unmount) __P((struct mount *mp, int mntflags, 305 struct proc *p)); 306 int (*vfs_root) __P((struct mount *mp, struct vnode **vpp)); 307 int (*vfs_quotactl) __P((struct mount *mp, int cmds, uid_t uid, 308 caddr_t arg, struct proc *p)); 309 int (*vfs_statfs) __P((struct mount *mp, struct statfs *sbp, 310 struct proc *p)); 311 int (*vfs_sync) __P((struct mount *mp, int waitfor, 312 struct ucred *cred, struct proc *p)); 313 int (*vfs_vget) __P((struct mount *mp, ino_t ino, 314 struct vnode **vpp)); 315 int (*vfs_fhtovp) __P((struct mount *mp, struct fid *fhp, 316 struct vnode **vpp)); 317 int (*vfs_checkexp) __P((struct mount *mp, struct sockaddr *nam, 318 int *extflagsp, struct ucred **credanonp)); 319 int (*vfs_vptofh) __P((struct vnode *vp, struct fid *fhp)); 320 int (*vfs_init) __P((struct vfsconf *)); 321 int (*vfs_uninit) __P((struct vfsconf *)); 322}; 323 324#define VFS_MOUNT(MP, PATH, DATA, NDP, P) \ 325 (*(MP)->mnt_op->vfs_mount)(MP, PATH, DATA, NDP, P) 326#define VFS_START(MP, FLAGS, P) (*(MP)->mnt_op->vfs_start)(MP, FLAGS, P) 327#define VFS_UNMOUNT(MP, FORCE, P) (*(MP)->mnt_op->vfs_unmount)(MP, FORCE, P) 328#define VFS_ROOT(MP, VPP) (*(MP)->mnt_op->vfs_root)(MP, VPP) 329#define VFS_QUOTACTL(MP,C,U,A,P) (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A, P) 330#define VFS_STATFS(MP, SBP, P) (*(MP)->mnt_op->vfs_statfs)(MP, SBP, P) 331#define VFS_SYNC(MP, WAIT, C, P) (*(MP)->mnt_op->vfs_sync)(MP, WAIT, C, P) 332#define VFS_VGET(MP, INO, VPP) (*(MP)->mnt_op->vfs_vget)(MP, INO, VPP) 333#define VFS_FHTOVP(MP, FIDP, VPP) \ 334 (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, VPP) 335#define VFS_VPTOFH(VP, FIDP) (*(VP)->v_mount->mnt_op->vfs_vptofh)(VP, FIDP) 336#define VFS_CHECKEXP(MP, NAM, EXFLG, CRED) \ 337 (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED) 338 339#include <sys/module.h> 340 341#define VFS_SET(vfsops, fsname, flags) \ 342 static struct vfsconf fsname ## _vfsconf = { \ 343 &vfsops, \ 344 #fsname, \ 345 -1, \ 346 0, \ 347 flags \ 348 }; \ 349 static moduledata_t fsname ## _mod = { \ 350 #fsname, \ 351 vfs_modevent, \ 352 & fsname ## _vfsconf \ 353 }; \ 354 DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE) 355 356#include <net/radix.h> 357 358#define AF_MAX 31 /* XXX */ 359 360/* 361 * Network address lookup element 362 */ 363struct netcred { 364 struct radix_node netc_rnodes[2]; 365 int netc_exflags; 366 struct ucred netc_anon; 367}; 368 369/* 370 * Network export information 371 */ 372struct netexport { 373 struct netcred ne_defexported; /* Default export */ 374 struct radix_node_head *ne_rtable[AF_MAX+1]; /* Individual exports */ 375}; 376 377extern char *mountrootfsname; 378 379/* 380 * exported vnode operations 381 */ 382int dounmount __P((struct mount *, int, struct proc *)); 383int vfs_setpublicfs /* set publicly exported fs */ 384 __P((struct mount *, struct netexport *, struct export_args *)); 385int vfs_lock __P((struct mount *)); /* lock a vfs */ 386void vfs_msync __P((struct mount *, int)); 387void vfs_unlock __P((struct mount *)); /* unlock a vfs */ 388int vfs_busy __P((struct mount *, int, struct simplelock *, struct proc *)); 389int vfs_export /* process mount export info */ 390 __P((struct mount *, struct netexport *, struct export_args *)); 391struct netcred *vfs_export_lookup /* lookup host in fs export list */ 392 __P((struct mount *, struct netexport *, struct sockaddr *)); 393int vfs_allocate_syncvnode __P((struct mount *)); 394void vfs_getnewfsid __P((struct mount *)); 395dev_t vfs_getrootfsid __P((struct mount *)); 396struct mount *vfs_getvfs __P((fsid_t *)); /* return vfs given fsid */ 397int vfs_modevent __P((module_t, int, void *)); 398int vfs_mountedon __P((struct vnode *)); /* is a vfs mounted on vp */ 399int vfs_rootmountalloc __P((char *, char *, struct mount **)); 400void vfs_unbusy __P((struct mount *, struct proc *)); 401void vfs_unmountall __P((void)); 402int vfs_register __P((struct vfsconf *)); 403int vfs_unregister __P((struct vfsconf *)); 404extern CIRCLEQ_HEAD(mntlist, mount) mountlist; /* mounted filesystem list */ 405extern struct simplelock mountlist_slock; 406extern struct nfs_public nfs_pub; 407 408/* 409 * Declarations for these vfs default operations are located in 410 * kern/vfs_default.c, they should be used instead of making "dummy" 411 * functions or casting entries in the VFS op table to "enopnotsupp()". 412 */ 413int vfs_stdmount __P((struct mount *mp, char *path, caddr_t data, 414 struct nameidata *ndp, struct proc *p)); 415int vfs_stdstart __P((struct mount *mp, int flags, struct proc *p)); 416int vfs_stdunmount __P((struct mount *mp, int mntflags, struct proc *p)); 417int vfs_stdroot __P((struct mount *mp, struct vnode **vpp)); 418int vfs_stdquotactl __P((struct mount *mp, int cmds, uid_t uid, 419 caddr_t arg, struct proc *p)); 420int vfs_stdstatfs __P((struct mount *mp, struct statfs *sbp, struct proc *p)); 421int vfs_stdsync __P((struct mount *mp, int waitfor, struct ucred *cred, 422 struct proc *p)); 423int vfs_stdvget __P((struct mount *mp, ino_t ino, struct vnode **vpp)); 424int vfs_stdfhtovp __P((struct mount *mp, struct fid *fhp, struct vnode **vpp)); 425int vfs_stdcheckexp __P((struct mount *mp, struct sockaddr *nam, 426 int *extflagsp, struct ucred **credanonp)); 427int vfs_stdvptofh __P((struct vnode *vp, struct fid *fhp)); 428int vfs_stdinit __P((struct vfsconf *)); 429int vfs_stduninit __P((struct vfsconf *)); 430 431#else /* !KERNEL */ 432 433#include <sys/cdefs.h> 434 435__BEGIN_DECLS 436int fstatfs __P((int, struct statfs *)); 437int getfh __P((const char *, fhandle_t *)); 438int getfsstat __P((struct statfs *, long, int)); 439int getmntinfo __P((struct statfs **, int)); 440int mount __P((const char *, const char *, int, void *)); 441int statfs __P((const char *, struct statfs *)); 442int unmount __P((const char *, int)); 443int fhopen __P((const struct fhandle *, int)); 444int fhstat __P((const struct fhandle *, struct stat *)); 445int fhstatfs __P((const struct fhandle *, struct statfs *)); 446 447/* C library stuff */ 448void endvfsent __P((void)); 449struct ovfsconf *getvfsbyname __P((const char *)); 450struct ovfsconf *getvfsbytype __P((int)); 451struct ovfsconf *getvfsent __P((void)); 452#define getvfsbyname new_getvfsbyname 453int new_getvfsbyname __P((const char *, struct vfsconf *)); 454void setvfsent __P((int)); 455int vfsisloadable __P((const char *)); 456int vfsload __P((const char *)); 457__END_DECLS 458 459#endif /* KERNEL */ 460 461#endif /* !_SYS_MOUNT_H_ */ 462