sys/sys/mount.h

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