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  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)mount.h     8.21 (Berkeley) 5/20/95
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_MOUNT_H_
  34 #define _SYS_MOUNT_H_
  35
  36 #include <sys/ucred.h>
  37 #include <sys/queue.h>
  38 #ifdef _KERNEL
  39 #include <sys/lock.h>
  40 #include <sys/lockmgr.h>
  41 #include <sys/_mutex.h>
  42 #endif
  43
  44 /*
  45  * NOTE: When changing statfs structure, mount structure, MNT_* flags or
  46  * MNTK_* flags also update DDB show mount command in vfs_subr.c.
  47  */
  48
  49 typedef struct fsid { int32_t val[2]; } fsid_t; /* filesystem id type */
  50
  51 /*
  52  * File identifier.
  53  * These are unique per filesystem on a single machine.
  54  */
  55 #define MAXFIDSZ        16
  56
  57 struct fid {
  58         u_short         fid_len;                /* length of data in bytes */
  59         u_short         fid_data0;              /* force longword alignment */
  60         char            fid_data[MAXFIDSZ];     /* data (variable length) */
  61 };
  62
  63 /*
  64  * filesystem statistics
  65  */
  66 #define MFSNAMELEN      16              /* length of type name including null */
  67 #define MNAMELEN        88              /* size of on/from name bufs */
  68 #define STATFS_VERSION  0x20030518      /* current version number */
  69 struct statfs {
  70         uint32_t f_version;             /* structure version number */
  71         uint32_t f_type;                /* type of filesystem */
  72         uint64_t f_flags;               /* copy of mount exported flags */
  73         uint64_t f_bsize;               /* filesystem fragment size */
  74         uint64_t f_iosize;              /* optimal transfer block size */
  75         uint64_t f_blocks;              /* total data blocks in filesystem */
  76         uint64_t f_bfree;               /* free blocks in filesystem */
  77         int64_t  f_bavail;              /* free blocks avail to non-superuser */
  78         uint64_t f_files;               /* total file nodes in filesystem */
  79         int64_t  f_ffree;               /* free nodes avail to non-superuser */
  80         uint64_t f_syncwrites;          /* count of sync writes since mount */
  81         uint64_t f_asyncwrites;         /* count of async writes since mount */
  82         uint64_t f_syncreads;           /* count of sync reads since mount */
  83         uint64_t f_asyncreads;          /* count of async reads since mount */
  84         uint64_t f_spare[10];           /* unused spare */
  85         uint32_t f_namemax;             /* maximum filename length */
  86         uid_t     f_owner;              /* user that mounted the filesystem */
  87         fsid_t    f_fsid;               /* filesystem id */
  88         char      f_charspare[80];          /* spare string space */
  89         char      f_fstypename[MFSNAMELEN]; /* filesystem type name */
  90         char      f_mntfromname[MNAMELEN];  /* mounted filesystem */
  91         char      f_mntonname[MNAMELEN];    /* directory on which mounted */
  92 };
  93
  94 #ifdef _KERNEL
  95 #define OMFSNAMELEN     16      /* length of fs type name, including null */
  96 #define OMNAMELEN       (88 - 2 * sizeof(long)) /* size of on/from name bufs */
  97
  98 /* XXX getfsstat.2 is out of date with write and read counter changes here. */
  99 /* XXX statfs.2 is out of date with read counter changes here. */
 100 struct ostatfs {
 101         long    f_spare2;               /* placeholder */
 102         long    f_bsize;                /* fundamental filesystem block size */
 103         long    f_iosize;               /* optimal transfer block size */
 104         long    f_blocks;               /* total data blocks in filesystem */
 105         long    f_bfree;                /* free blocks in fs */
 106         long    f_bavail;               /* free blocks avail to non-superuser */
 107         long    f_files;                /* total file nodes in filesystem */
 108         long    f_ffree;                /* free file nodes in fs */
 109         fsid_t  f_fsid;                 /* filesystem id */
 110         uid_t   f_owner;                /* user that mounted the filesystem */
 111         int     f_type;                 /* type of filesystem */
 112         int     f_flags;                /* copy of mount exported flags */
 113         long    f_syncwrites;           /* count of sync writes since mount */
 114         long    f_asyncwrites;          /* count of async writes since mount */
 115         char    f_fstypename[OMFSNAMELEN]; /* fs type name */
 116         char    f_mntonname[OMNAMELEN]; /* directory on which mounted */
 117         long    f_syncreads;            /* count of sync reads since mount */
 118         long    f_asyncreads;           /* count of async reads since mount */
 119         short   f_spares1;              /* unused spare */
 120         char    f_mntfromname[OMNAMELEN];/* mounted filesystem */
 121         short   f_spares2;              /* unused spare */
 122         /*
 123          * XXX on machines where longs are aligned to 8-byte boundaries, there
 124          * is an unnamed int32_t here.  This spare was after the apparent end
 125          * of the struct until we bit off the read counters from f_mntonname.
 126          */
 127         long    f_spare[2];             /* unused spare */
 128 };
 129
 130 TAILQ_HEAD(vnodelst, vnode);
 131
 132 /* Mount options list */
 133 TAILQ_HEAD(vfsoptlist, vfsopt);
 134 struct vfsopt {
 135         TAILQ_ENTRY(vfsopt) link;
 136         char    *name;
 137         void    *value;
 138         int     len;
 139         int     pos;
 140         int     seen;
 141 };
 142
 143 /*
 144  * Structure per mounted filesystem.  Each mounted filesystem has an
 145  * array of operations and an instance record.  The filesystems are
 146  * put on a doubly linked list.
 147  *
 148  * Lock reference:
 149  *      m - mountlist_mtx
 150  *      i - interlock
 151  *      v - vnode freelist mutex
 152  *
 153  * Unmarked fields are considered stable as long as a ref is held.
 154  *
 155  */
 156 struct mount {
 157         struct mtx      mnt_mtx;                /* mount structure interlock */
 158         int             mnt_gen;                /* struct mount generation */
 159 #define mnt_startzero   mnt_list
 160         TAILQ_ENTRY(mount) mnt_list;            /* (m) mount list */
 161         struct vfsops   *mnt_op;                /* operations on fs */
 162         struct vfsconf  *mnt_vfc;               /* configuration info */
 163         struct vnode    *mnt_vnodecovered;      /* vnode we mounted on */
 164         struct vnode    *mnt_syncer;            /* syncer vnode */
 165         int             mnt_ref;                /* (i) Reference count */
 166         struct vnodelst mnt_nvnodelist;         /* (i) list of vnodes */
 167         int             mnt_nvnodelistsize;     /* (i) # of vnodes */
 168         struct vnodelst mnt_activevnodelist;    /* (v) list of active vnodes */
 169         int             mnt_activevnodelistsize;/* (v) # of active vnodes */
 170         int             mnt_writeopcount;       /* (i) write syscalls pending */
 171         int             mnt_kern_flag;          /* (i) kernel only flags */
 172         uint64_t        mnt_flag;               /* (i) flags shared with user */
 173         u_int           mnt_pad_noasync;
 174         struct vfsoptlist *mnt_opt;             /* current mount options */
 175         struct vfsoptlist *mnt_optnew;          /* new options passed to fs */
 176         int             mnt_maxsymlinklen;      /* max size of short symlink */
 177         struct statfs   mnt_stat;               /* cache of filesystem stats */
 178         struct ucred    *mnt_cred;              /* credentials of mounter */
 179         void *          mnt_data;               /* private data */
 180         time_t          mnt_time;               /* last time written*/
 181         int             mnt_iosize_max;         /* max size for clusters, etc */
 182         struct netexport *mnt_export;           /* export list */
 183         struct label    *mnt_label;             /* MAC label for the fs */
 184         u_int           mnt_hashseed;           /* Random seed for vfs_hash */
 185         int             mnt_lockref;            /* (i) Lock reference count */
 186         int             mnt_secondary_writes;   /* (i) # of secondary writes */
 187         int             mnt_secondary_accwrites;/* (i) secondary wr. starts */
 188         struct thread   *mnt_susp_owner;        /* (i) thread owning suspension */
 189 #define mnt_endzero     mnt_gjprovider
 190         char            *mnt_gjprovider;        /* gjournal provider name */
 191         struct lock     mnt_explock;            /* vfs_export walkers lock */
 192 };
 193
 194 /*
 195  * Definitions for MNT_VNODE_FOREACH_ALL.
 196  */
 197 struct vnode *__mnt_vnode_next_all(struct vnode **mvp, struct mount *mp);
 198 struct vnode *__mnt_vnode_first_all(struct vnode **mvp, struct mount *mp);
 199 void          __mnt_vnode_markerfree_all(struct vnode **mvp, struct mount *mp);
 200
 201 #define MNT_VNODE_FOREACH_ALL(vp, mp, mvp)                              \
 202         for (vp = __mnt_vnode_first_all(&(mvp), (mp));                  \
 203                 (vp) != NULL; vp = __mnt_vnode_next_all(&(mvp), (mp)))
 204
 205 #define MNT_VNODE_FOREACH_ALL_ABORT(mp, mvp)                            \
 206         do {                                                            \
 207                 MNT_ILOCK(mp);                                          \
 208                 __mnt_vnode_markerfree_all(&(mvp), (mp));               \
 209                 /* MNT_IUNLOCK(mp); -- done in above function */        \
 210                 mtx_assert(MNT_MTX(mp), MA_NOTOWNED);                   \
 211         } while (0)
 212
 213 /*
 214  * Definitions for MNT_VNODE_FOREACH_ACTIVE.
 215  */
 216 struct vnode *__mnt_vnode_next_active(struct vnode **mvp, struct mount *mp);
 217 struct vnode *__mnt_vnode_first_active(struct vnode **mvp, struct mount *mp);
 218 void          __mnt_vnode_markerfree_active(struct vnode **mvp, struct mount *);
 219
 220 #define MNT_VNODE_FOREACH_ACTIVE(vp, mp, mvp)                           \
 221         for (vp = __mnt_vnode_first_active(&(mvp), (mp));               \
 222                 (vp) != NULL; vp = __mnt_vnode_next_active(&(mvp), (mp)))
 223
 224 #define MNT_VNODE_FOREACH_ACTIVE_ABORT(mp, mvp)                         \
 225         __mnt_vnode_markerfree_active(&(mvp), (mp))
 226
 227 /*
 228  * Definitions for MNT_VNODE_FOREACH.
 229  *
 230  * This interface has been deprecated in favor of MNT_VNODE_FOREACH_ALL.
 231  */
 232 struct vnode *__mnt_vnode_next(struct vnode **mvp, struct mount *mp);
 233 struct vnode *__mnt_vnode_first(struct vnode **mvp, struct mount *mp);
 234 void          __mnt_vnode_markerfree(struct vnode **mvp, struct mount *mp);
 235
 236 #define MNT_VNODE_FOREACH(vp, mp, mvp) \
 237         for (vp = __mnt_vnode_first(&(mvp), (mp)); \
 238                 (vp) != NULL; vp = __mnt_vnode_next(&(mvp), (mp)))
 239
 240 #define MNT_VNODE_FOREACH_ABORT_ILOCKED(mp, mvp)                        \
 241         __mnt_vnode_markerfree(&(mvp), (mp))
 242
 243 #define MNT_VNODE_FOREACH_ABORT(mp, mvp)                                \
 244         do {                                                            \
 245                 MNT_ILOCK(mp);                                          \
 246                 MNT_VNODE_FOREACH_ABORT_ILOCKED(mp, mvp);               \
 247                 MNT_IUNLOCK(mp);                                        \
 248         } while (0)
 249
 250 #define MNT_ILOCK(mp)   mtx_lock(&(mp)->mnt_mtx)
 251 #define MNT_ITRYLOCK(mp) mtx_trylock(&(mp)->mnt_mtx)
 252 #define MNT_IUNLOCK(mp) mtx_unlock(&(mp)->mnt_mtx)
 253 #define MNT_MTX(mp)     (&(mp)->mnt_mtx)
 254 #define MNT_REF(mp)     (mp)->mnt_ref++
 255 #define MNT_REL(mp)     do {                                            \
 256         KASSERT((mp)->mnt_ref > 0, ("negative mnt_ref"));               \
 257         (mp)->mnt_ref--;                                                \
 258         if ((mp)->mnt_ref == 0)                                         \
 259                 wakeup((mp));                                           \
 260 } while (0)
 261
 262 #endif /* _KERNEL */
 263
 264 /*
 265  * User specifiable flags, stored in mnt_flag.
 266  */
 267 #define MNT_RDONLY      0x0000000000000001ULL /* read only filesystem */
 268 #define MNT_SYNCHRONOUS 0x0000000000000002ULL /* fs written synchronously */
 269 #define MNT_NOEXEC      0x0000000000000004ULL /* can't exec from filesystem */
 270 #define MNT_NOSUID      0x0000000000000008ULL /* don't honor setuid fs bits */
 271 #define MNT_NFS4ACLS    0x0000000000000010ULL /* enable NFS version 4 ACLs */
 272 #define MNT_UNION       0x0000000000000020ULL /* union with underlying fs */
 273 #define MNT_ASYNC       0x0000000000000040ULL /* fs written asynchronously */
 274 #define MNT_SUIDDIR     0x0000000000100000ULL /* special SUID dir handling */
 275 #define MNT_SOFTDEP     0x0000000000200000ULL /* using soft updates */
 276 #define MNT_NOSYMFOLLOW 0x0000000000400000ULL /* do not follow symlinks */
 277 #define MNT_GJOURNAL    0x0000000002000000ULL /* GEOM journal support enabled */
 278 #define MNT_MULTILABEL  0x0000000004000000ULL /* MAC support for objects */
 279 #define MNT_ACLS        0x0000000008000000ULL /* ACL support enabled */
 280 #define MNT_NOATIME     0x0000000010000000ULL /* dont update file access time */
 281 #define MNT_NOCLUSTERR  0x0000000040000000ULL /* disable cluster read */
 282 #define MNT_NOCLUSTERW  0x0000000080000000ULL /* disable cluster write */
 283 #define MNT_SUJ         0x0000000100000000ULL /* using journaled soft updates */
 284
 285 /*
 286  * NFS export related mount flags.
 287  */
 288 #define MNT_EXRDONLY    0x0000000000000080ULL   /* exported read only */
 289 #define MNT_EXPORTED    0x0000000000000100ULL   /* filesystem is exported */
 290 #define MNT_DEFEXPORTED 0x0000000000000200ULL   /* exported to the world */
 291 #define MNT_EXPORTANON  0x0000000000000400ULL   /* anon uid mapping for all */
 292 #define MNT_EXKERB      0x0000000000000800ULL   /* exported with Kerberos */
 293 #define MNT_EXPUBLIC    0x0000000020000000ULL   /* public export (WebNFS) */
 294
 295 /*
 296  * Flags set by internal operations,
 297  * but visible to the user.
 298  * XXX some of these are not quite right.. (I've never seen the root flag set)
 299  */
 300 #define MNT_LOCAL       0x0000000000001000ULL /* filesystem is stored locally */
 301 #define MNT_QUOTA       0x0000000000002000ULL /* quotas are enabled on fs */
 302 #define MNT_ROOTFS      0x0000000000004000ULL /* identifies the root fs */
 303 #define MNT_USER        0x0000000000008000ULL /* mounted by a user */
 304 #define MNT_IGNORE      0x0000000000800000ULL /* do not show entry in df */
 305
 306 /*
 307  * Mask of flags that are visible to statfs().
 308  * XXX I think that this could now become (~(MNT_CMDFLAGS))
 309  * but the 'mount' program may need changing to handle this.
 310  */
 311 #define MNT_VISFLAGMASK (MNT_RDONLY     | MNT_SYNCHRONOUS | MNT_NOEXEC  | \
 312                         MNT_NOSUID      | MNT_UNION     | MNT_SUJ       | \
 313                         MNT_ASYNC       | MNT_EXRDONLY  | MNT_EXPORTED  | \
 314                         MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB    | \
 315                         MNT_LOCAL       | MNT_USER      | MNT_QUOTA     | \
 316                         MNT_ROOTFS      | MNT_NOATIME   | MNT_NOCLUSTERR| \
 317                         MNT_NOCLUSTERW  | MNT_SUIDDIR   | MNT_SOFTDEP   | \
 318                         MNT_IGNORE      | MNT_EXPUBLIC  | MNT_NOSYMFOLLOW | \
 319                         MNT_GJOURNAL    | MNT_MULTILABEL | MNT_ACLS     | \
 320                         MNT_NFS4ACLS)
 321
 322 /* Mask of flags that can be updated. */
 323 #define MNT_UPDATEMASK (MNT_NOSUID      | MNT_NOEXEC    | \
 324                         MNT_SYNCHRONOUS | MNT_UNION     | MNT_ASYNC     | \
 325                         MNT_NOATIME | \
 326                         MNT_NOSYMFOLLOW | MNT_IGNORE    | \
 327                         MNT_NOCLUSTERR  | MNT_NOCLUSTERW | MNT_SUIDDIR  | \
 328                         MNT_ACLS        | MNT_USER | MNT_NFS4ACLS)
 329
 330 /*
 331  * External filesystem command modifier flags.
 332  * Unmount can use the MNT_FORCE flag.
 333  * XXX: These are not STATES and really should be somewhere else.
 334  * XXX: MNT_BYFSID collides with MNT_ACLS, but because MNT_ACLS is only used for
 335  *      mount(2) and MNT_BYFSID is only used for unmount(2) it's harmless.
 336  */
 337 #define MNT_UPDATE      0x0000000000010000ULL /* not real mount, just update */
 338 #define MNT_DELEXPORT   0x0000000000020000ULL /* delete export host lists */
 339 #define MNT_RELOAD      0x0000000000040000ULL /* reload filesystem data */
 340 #define MNT_FORCE       0x0000000000080000ULL /* force unmount or readonly */
 341 #define MNT_SNAPSHOT    0x0000000001000000ULL /* snapshot the filesystem */
 342 #define MNT_BYFSID      0x0000000008000000ULL /* specify filesystem by ID. */
 343 #define MNT_CMDFLAGS   (MNT_UPDATE      | MNT_DELEXPORT | MNT_RELOAD    | \
 344                         MNT_FORCE       | MNT_SNAPSHOT  | MNT_BYFSID)
 345 /*
 346  * Internal filesystem control flags stored in mnt_kern_flag.
 347  *
 348  * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed
 349  * past the mount point.  This keeps the subtree stable during mounts
 350  * and unmounts.
 351  *
 352  * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while
 353  * dounmount() is still waiting to lock the mountpoint. This allows
 354  * the filesystem to cancel operations that might otherwise deadlock
 355  * with the unmount attempt (used by NFS).
 356  *
 357  * MNTK_NOINSMNTQ is strict subset of MNTK_UNMOUNT. They are separated
 358  * to allow for failed unmount attempt to restore the syncer vnode for
 359  * the mount.
 360  */
 361 #define MNTK_UNMOUNTF   0x00000001      /* forced unmount in progress */
 362 #define MNTK_ASYNC      0x00000002      /* filtered async flag */
 363 #define MNTK_SOFTDEP    0x00000004      /* async disabled by softdep */
 364 #define MNTK_NOINSMNTQ  0x00000008      /* insmntque is not allowed */
 365 #define MNTK_DRAINING   0x00000010      /* lock draining is happening */
 366 #define MNTK_REFEXPIRE  0x00000020      /* refcount expiring is happening */
 367 #define MNTK_EXTENDED_SHARED    0x00000040 /* Allow shared locking for more ops */
 368 #define MNTK_SHARED_WRITES      0x00000080 /* Allow shared locking for writes */
 369 #define MNTK_NO_IOPF    0x00000100      /* Disallow page faults during reads
 370                                            and writes. Filesystem shall properly
 371                                            handle i/o state on EFAULT. */
 372 #define MNTK_LOOKUP_EXCL_DOTDOT 0x00000800
 373 #define MNTK_NOASYNC    0x00800000      /* disable async */
 374 #define MNTK_UNMOUNT    0x01000000      /* unmount in progress */
 375 #define MNTK_MWAIT      0x02000000      /* waiting for unmount to finish */
 376 #define MNTK_SUSPEND    0x08000000      /* request write suspension */
 377 #define MNTK_SUSPEND2   0x04000000      /* block secondary writes */
 378 #define MNTK_SUSPENDED  0x10000000      /* write operations are suspended */
 379 #define MNTK_MPSAFE     0x20000000      /* Filesystem is MPSAFE. */
 380 #define MNTK_LOOKUP_SHARED      0x40000000 /* FS supports shared lock lookups */
 381 #define MNTK_NOKNOTE    0x80000000      /* Don't send KNOTEs from VOP hooks */
 382
 383 #define MNT_SHARED_WRITES(mp) (((mp) != NULL) &&        \
 384                                 ((mp)->mnt_kern_flag & MNTK_SHARED_WRITES))
 385
 386 /*
 387  * Sysctl CTL_VFS definitions.
 388  *
 389  * Second level identifier specifies which filesystem. Second level
 390  * identifier VFS_VFSCONF returns information about all filesystems.
 391  * Second level identifier VFS_GENERIC is non-terminal.
 392  */
 393 #define VFS_VFSCONF             0       /* get configured filesystems */
 394 #define VFS_GENERIC             0       /* generic filesystem information */
 395 /*
 396  * Third level identifiers for VFS_GENERIC are given below; third
 397  * level identifiers for specific filesystems are given in their
 398  * mount specific header files.
 399  */
 400 #define VFS_MAXTYPENUM  1       /* int: highest defined filesystem type */
 401 #define VFS_CONF        2       /* struct: vfsconf for filesystem given
 402                                    as next argument */
 403
 404 /*
 405  * Flags for various system call interfaces.
 406  *
 407  * waitfor flags to vfs_sync() and getfsstat()
 408  */
 409 #define MNT_WAIT        1       /* synchronously wait for I/O to complete */
 410 #define MNT_NOWAIT      2       /* start all I/O, but do not wait for it */
 411 #define MNT_LAZY        3       /* push data not written by filesystem syncer */
 412 #define MNT_SUSPEND     4       /* Suspend file system after sync */
 413
 414 /*
 415  * Generic file handle
 416  */
 417 struct fhandle {
 418         fsid_t  fh_fsid;        /* Filesystem id of mount point */
 419         struct  fid fh_fid;     /* Filesys specific id */
 420 };
 421 typedef struct fhandle  fhandle_t;
 422
 423 /*
 424  * Old export arguments without security flavor list
 425  */
 426 struct oexport_args {
 427         int     ex_flags;               /* export related flags */
 428         uid_t   ex_root;                /* mapping for root uid */
 429         struct  xucred ex_anon;         /* mapping for anonymous user */
 430         struct  sockaddr *ex_addr;      /* net address to which exported */
 431         u_char  ex_addrlen;             /* and the net address length */
 432         struct  sockaddr *ex_mask;      /* mask of valid bits in saddr */
 433         u_char  ex_masklen;             /* and the smask length */
 434         char    *ex_indexfile;          /* index file for WebNFS URLs */
 435 };
 436
 437 /*
 438  * Export arguments for local filesystem mount calls.
 439  */
 440 #define MAXSECFLAVORS   5
 441 struct export_args {
 442         int     ex_flags;               /* export related flags */
 443         uid_t   ex_root;                /* mapping for root uid */
 444         struct  xucred ex_anon;         /* mapping for anonymous user */
 445         struct  sockaddr *ex_addr;      /* net address to which exported */
 446         u_char  ex_addrlen;             /* and the net address length */
 447         struct  sockaddr *ex_mask;      /* mask of valid bits in saddr */
 448         u_char  ex_masklen;             /* and the smask length */
 449         char    *ex_indexfile;          /* index file for WebNFS URLs */
 450         int     ex_numsecflavors;       /* security flavor count */
 451         int     ex_secflavors[MAXSECFLAVORS]; /* list of security flavors */
 452 };
 453
 454 /*
 455  * Structure holding information for a publicly exported filesystem
 456  * (WebNFS). Currently the specs allow just for one such filesystem.
 457  */
 458 struct nfs_public {
 459         int             np_valid;       /* Do we hold valid information */
 460         fhandle_t       np_handle;      /* Filehandle for pub fs (internal) */
 461         struct mount    *np_mount;      /* Mountpoint of exported fs */
 462         char            *np_index;      /* Index file */
 463 };
 464
 465 /*
 466  * Filesystem configuration information. One of these exists for each
 467  * type of filesystem supported by the kernel. These are searched at
 468  * mount time to identify the requested filesystem.
 469  *
 470  * XXX: Never change the first two arguments!
 471  */
 472 struct vfsconf {
 473         u_int   vfc_version;            /* ABI version number */
 474         char    vfc_name[MFSNAMELEN];   /* filesystem type name */
 475         struct  vfsops *vfc_vfsops;     /* filesystem operations vector */
 476         int     vfc_typenum;            /* historic filesystem type number */
 477         int     vfc_refcount;           /* number mounted of this type */
 478         int     vfc_flags;              /* permanent flags */
 479         struct  vfsoptdecl *vfc_opts;   /* mount options */
 480         TAILQ_ENTRY(vfsconf) vfc_list;  /* list of vfscons */
 481 };
 482
 483 /* Userland version of the struct vfsconf. */
 484 struct xvfsconf {
 485         struct  vfsops *vfc_vfsops;     /* filesystem operations vector */
 486         char    vfc_name[MFSNAMELEN];   /* filesystem type name */
 487         int     vfc_typenum;            /* historic filesystem type number */
 488         int     vfc_refcount;           /* number mounted of this type */
 489         int     vfc_flags;              /* permanent flags */
 490         struct  vfsconf *vfc_next;      /* next in list */
 491 };
 492
 493 #ifndef BURN_BRIDGES
 494 struct ovfsconf {
 495         void    *vfc_vfsops;
 496         char    vfc_name[32];
 497         int     vfc_index;
 498         int     vfc_refcount;
 499         int     vfc_flags;
 500 };
 501 #endif
 502
 503 /*
 504  * NB: these flags refer to IMPLEMENTATION properties, not properties of
 505  * any actual mounts; i.e., it does not make sense to change the flags.
 506  */
 507 #define VFCF_STATIC     0x00010000      /* statically compiled into kernel */
 508 #define VFCF_NETWORK    0x00020000      /* may get data over the network */
 509 #define VFCF_READONLY   0x00040000      /* writes are not implemented */
 510 #define VFCF_SYNTHETIC  0x00080000      /* data does not represent real files */
 511 #define VFCF_LOOPBACK   0x00100000      /* aliases some other mounted FS */
 512 #define VFCF_UNICODE    0x00200000      /* stores file names as Unicode */
 513 #define VFCF_JAIL       0x00400000      /* can be mounted from within a jail */
 514 #define VFCF_DELEGADMIN 0x00800000      /* supports delegated administration */
 515
 516 typedef uint32_t fsctlop_t;
 517
 518 struct vfsidctl {
 519         int             vc_vers;        /* should be VFSIDCTL_VERS1 (below) */
 520         fsid_t          vc_fsid;        /* fsid to operate on */
 521         char            vc_fstypename[MFSNAMELEN];
 522                                         /* type of fs 'nfs' or '*' */
 523         fsctlop_t       vc_op;          /* operation VFS_CTL_* (below) */
 524         void            *vc_ptr;        /* pointer to data structure */
 525         size_t          vc_len;         /* sizeof said structure */
 526         u_int32_t       vc_spare[12];   /* spare (must be zero) */
 527 };
 528
 529 /* vfsidctl API version. */
 530 #define VFS_CTL_VERS1   0x01
 531
 532 /*
 533  * New style VFS sysctls, do not reuse/conflict with the namespace for
 534  * private sysctls.
 535  * All "global" sysctl ops have the 33rd bit set:
 536  * 0x...1....
 537  * Private sysctl ops should have the 33rd bit unset.
 538  */
 539 #define VFS_CTL_QUERY   0x00010001      /* anything wrong? (vfsquery) */
 540 #define VFS_CTL_TIMEO   0x00010002      /* set timeout for vfs notification */
 541 #define VFS_CTL_NOLOCKS 0x00010003      /* disable file locking */
 542
 543 struct vfsquery {
 544         u_int32_t       vq_flags;
 545         u_int32_t       vq_spare[31];
 546 };
 547
 548 /* vfsquery flags */
 549 #define VQ_NOTRESP      0x0001  /* server down */
 550 #define VQ_NEEDAUTH     0x0002  /* server bad auth */
 551 #define VQ_LOWDISK      0x0004  /* we're low on space */
 552 #define VQ_MOUNT        0x0008  /* new filesystem arrived */
 553 #define VQ_UNMOUNT      0x0010  /* filesystem has left */
 554 #define VQ_DEAD         0x0020  /* filesystem is dead, needs force unmount */
 555 #define VQ_ASSIST       0x0040  /* filesystem needs assistance from external
 556                                    program */
 557 #define VQ_NOTRESPLOCK  0x0080  /* server lockd down */
 558 #define VQ_FLAG0100     0x0100  /* placeholder */
 559 #define VQ_FLAG0200     0x0200  /* placeholder */
 560 #define VQ_FLAG0400     0x0400  /* placeholder */
 561 #define VQ_FLAG0800     0x0800  /* placeholder */
 562 #define VQ_FLAG1000     0x1000  /* placeholder */
 563 #define VQ_FLAG2000     0x2000  /* placeholder */
 564 #define VQ_FLAG4000     0x4000  /* placeholder */
 565 #define VQ_FLAG8000     0x8000  /* placeholder */
 566
 567 #ifdef _KERNEL
 568 /* Point a sysctl request at a vfsidctl's data. */
 569 #define VCTLTOREQ(vc, req)                                              \
 570         do {                                                            \
 571                 (req)->newptr = (vc)->vc_ptr;                           \
 572                 (req)->newlen = (vc)->vc_len;                           \
 573                 (req)->newidx = 0;                                      \
 574         } while (0)
 575 #endif
 576
 577 struct iovec;
 578 struct uio;
 579
 580 #ifdef _KERNEL
 581
 582 /*
 583  * vfs_busy specific flags and mask.
 584  */
 585 #define MBF_NOWAIT      0x01
 586 #define MBF_MNTLSTLOCK  0x02
 587 #define MBF_MASK        (MBF_NOWAIT | MBF_MNTLSTLOCK)
 588
 589 #ifdef MALLOC_DECLARE
 590 MALLOC_DECLARE(M_MOUNT);
 591 #endif
 592 extern int maxvfsconf;          /* highest defined filesystem type */
 593 extern int nfs_mount_type;      /* vfc_typenum for nfs, or -1 */
 594
 595 TAILQ_HEAD(vfsconfhead, vfsconf);
 596 extern struct vfsconfhead vfsconf;
 597
 598 /*
 599  * Operations supported on mounted filesystem.
 600  */
 601 struct mount_args;
 602 struct nameidata;
 603 struct sysctl_req;
 604 struct mntarg;
 605
 606 typedef int vfs_cmount_t(struct mntarg *ma, void *data, uint64_t flags);
 607 typedef int vfs_unmount_t(struct mount *mp, int mntflags);
 608 typedef int vfs_root_t(struct mount *mp, int flags, struct vnode **vpp);
 609 typedef int vfs_quotactl_t(struct mount *mp, int cmds, uid_t uid, void *arg);
 610 typedef int vfs_statfs_t(struct mount *mp, struct statfs *sbp);
 611 typedef int vfs_sync_t(struct mount *mp, int waitfor);
 612 typedef int vfs_vget_t(struct mount *mp, ino_t ino, int flags,
 613                     struct vnode **vpp);
 614 typedef int vfs_fhtovp_t(struct mount *mp, struct fid *fhp,
 615                     int flags, struct vnode **vpp);
 616 typedef int vfs_checkexp_t(struct mount *mp, struct sockaddr *nam,
 617                     int *extflagsp, struct ucred **credanonp,
 618                     int *numsecflavors, int **secflavors);
 619 typedef int vfs_init_t(struct vfsconf *);
 620 typedef int vfs_uninit_t(struct vfsconf *);
 621 typedef int vfs_extattrctl_t(struct mount *mp, int cmd,
 622                     struct vnode *filename_vp, int attrnamespace,
 623                     const char *attrname);
 624 typedef int vfs_mount_t(struct mount *mp);
 625 typedef int vfs_sysctl_t(struct mount *mp, fsctlop_t op,
 626                     struct sysctl_req *req);
 627 typedef void vfs_susp_clean_t(struct mount *mp);
 628
 629 struct vfsops {
 630         vfs_mount_t             *vfs_mount;
 631         vfs_cmount_t            *vfs_cmount;
 632         vfs_unmount_t           *vfs_unmount;
 633         vfs_root_t              *vfs_root;
 634         vfs_quotactl_t          *vfs_quotactl;
 635         vfs_statfs_t            *vfs_statfs;
 636         vfs_sync_t              *vfs_sync;
 637         vfs_vget_t              *vfs_vget;
 638         vfs_fhtovp_t            *vfs_fhtovp;
 639         vfs_checkexp_t          *vfs_checkexp;
 640         vfs_init_t              *vfs_init;
 641         vfs_uninit_t            *vfs_uninit;
 642         vfs_extattrctl_t        *vfs_extattrctl;
 643         vfs_sysctl_t            *vfs_sysctl;
 644         vfs_susp_clean_t        *vfs_susp_clean;
 645 };
 646
 647 vfs_statfs_t    __vfs_statfs;
 648
 649 #define VFS_MOUNT(MP)           (*(MP)->mnt_op->vfs_mount)(MP)
 650 #define VFS_UNMOUNT(MP, FORCE)  (*(MP)->mnt_op->vfs_unmount)(MP, FORCE)
 651 #define VFS_ROOT(MP, FLAGS, VPP)                                        \
 652         (*(MP)->mnt_op->vfs_root)(MP, FLAGS, VPP)
 653 #define VFS_QUOTACTL(MP, C, U, A)                                       \
 654         (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A)
 655 #define VFS_STATFS(MP, SBP)     __vfs_statfs((MP), (SBP))
 656 #define VFS_SYNC(MP, WAIT)      (*(MP)->mnt_op->vfs_sync)(MP, WAIT)
 657 #define VFS_VGET(MP, INO, FLAGS, VPP) \
 658         (*(MP)->mnt_op->vfs_vget)(MP, INO, FLAGS, VPP)
 659 #define VFS_FHTOVP(MP, FIDP, FLAGS, VPP) \
 660         (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, FLAGS, VPP)
 661 #define VFS_CHECKEXP(MP, NAM, EXFLG, CRED, NUMSEC, SEC) \
 662         (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED, NUMSEC, SEC)
 663 #define VFS_EXTATTRCTL(MP, C, FN, NS, N)                                \
 664         (*(MP)->mnt_op->vfs_extattrctl)(MP, C, FN, NS, N)
 665 #define VFS_SYSCTL(MP, OP, REQ) \
 666         (*(MP)->mnt_op->vfs_sysctl)(MP, OP, REQ)
 667 #define VFS_SUSP_CLEAN(MP) \
 668         ({if (*(MP)->mnt_op->vfs_susp_clean != NULL)            \
 669                (*(MP)->mnt_op->vfs_susp_clean)(MP); })
 670
 671 #define VFS_NEEDSGIANT_(MP)                                             \
 672     ((MP) != NULL && ((MP)->mnt_kern_flag & MNTK_MPSAFE) == 0)
 673
 674 #define VFS_NEEDSGIANT(MP) __extension__                                \
 675 ({                                                                      \
 676         struct mount *_mp;                                              \
 677         _mp = (MP);                                                     \
 678         VFS_NEEDSGIANT_(_mp);                                           \
 679 })
 680
 681 #define VFS_LOCK_GIANT(MP) __extension__                                \
 682 ({                                                                      \
 683         int _locked;                                                    \
 684         struct mount *_mp;                                              \
 685         _mp = (MP);                                                     \
 686         if (VFS_NEEDSGIANT_(_mp)) {                                     \
 687                 mtx_lock(&Giant);                                       \
 688                 _locked = 1;                                            \
 689         } else                                                          \
 690                 _locked = 0;                                            \
 691         _locked;                                                        \
 692 })
 693 #define VFS_UNLOCK_GIANT(locked) do                                     \
 694 {                                                                       \
 695         if ((locked))                                                   \
 696                 mtx_unlock(&Giant);                                     \
 697 } while (0)
 698 #define VFS_ASSERT_GIANT(MP) do                                         \
 699 {                                                                       \
 700         struct mount *_mp;                                              \
 701         _mp = (MP);                                                     \
 702         if (VFS_NEEDSGIANT_(_mp))                                       \
 703                 mtx_assert(&Giant, MA_OWNED);                           \
 704 } while (0)
 705
 706 #define VFS_KNOTE_LOCKED(vp, hint) do                                   \
 707 {                                                                       \
 708         if (((vp)->v_vflag & VV_NOKNOTE) == 0)                          \
 709                 VN_KNOTE((vp), (hint), KNF_LISTLOCKED);                 \
 710 } while (0)
 711
 712 #define VFS_KNOTE_UNLOCKED(vp, hint) do                                 \
 713 {                                                                       \
 714         if (((vp)->v_vflag & VV_NOKNOTE) == 0)                          \
 715                 VN_KNOTE((vp), (hint), 0);                              \
 716 } while (0)
 717
 718 #include <sys/module.h>
 719
 720 /*
 721  * Version numbers.
 722  */
 723 #define VFS_VERSION_00  0x19660120
 724 #define VFS_VERSION     VFS_VERSION_00
 725
 726 #define VFS_SET(vfsops, fsname, flags) \
 727         static struct vfsconf fsname ## _vfsconf = {            \
 728                 .vfc_version = VFS_VERSION,                     \
 729                 .vfc_name = #fsname,                            \
 730                 .vfc_vfsops = &vfsops,                          \
 731                 .vfc_typenum = -1,                              \
 732                 .vfc_flags = flags,                             \
 733         };                                                      \
 734         static moduledata_t fsname ## _mod = {                  \
 735                 #fsname,                                        \
 736                 vfs_modevent,                                   \
 737                 & fsname ## _vfsconf                            \
 738         };                                                      \
 739         DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
 740
 741 extern  char *mountrootfsname;
 742
 743 /*
 744  * exported vnode operations
 745  */
 746
 747 int     dounmount(struct mount *, int, struct thread *);
 748
 749 int     kernel_mount(struct mntarg *ma, uint64_t flags);
 750 int     kernel_vmount(int flags, ...);
 751 struct mntarg *mount_arg(struct mntarg *ma, const char *name, const void *val, int len);
 752 struct mntarg *mount_argb(struct mntarg *ma, int flag, const char *name);
 753 struct mntarg *mount_argf(struct mntarg *ma, const char *name, const char *fmt, ...);
 754 struct mntarg *mount_argsu(struct mntarg *ma, const char *name, const void *val, int len);
 755 void    statfs_scale_blocks(struct statfs *sf, long max_size);
 756 struct vfsconf *vfs_byname(const char *);
 757 struct vfsconf *vfs_byname_kld(const char *, struct thread *td, int *);
 758 void    vfs_mount_destroy(struct mount *);
 759 void    vfs_event_signal(fsid_t *, u_int32_t, intptr_t);
 760 void    vfs_freeopts(struct vfsoptlist *opts);
 761 void    vfs_deleteopt(struct vfsoptlist *opts, const char *name);
 762 int     vfs_buildopts(struct uio *auio, struct vfsoptlist **options);
 763 int     vfs_flagopt(struct vfsoptlist *opts, const char *name, uint64_t *w,
 764             uint64_t val);
 765 int     vfs_getopt(struct vfsoptlist *, const char *, void **, int *);
 766 int     vfs_getopt_pos(struct vfsoptlist *opts, const char *name);
 767 char    *vfs_getopts(struct vfsoptlist *, const char *, int *error);
 768 int     vfs_copyopt(struct vfsoptlist *, const char *, void *, int);
 769 int     vfs_filteropt(struct vfsoptlist *, const char **legal);
 770 void    vfs_opterror(struct vfsoptlist *opts, const char *fmt, ...);
 771 int     vfs_scanopt(struct vfsoptlist *opts, const char *name, const char *fmt, ...);
 772 int     vfs_setopt(struct vfsoptlist *opts, const char *name, void *value,
 773             int len);
 774 int     vfs_setopt_part(struct vfsoptlist *opts, const char *name, void *value,
 775             int len);
 776 int     vfs_setopts(struct vfsoptlist *opts, const char *name,
 777             const char *value);
 778 int     vfs_setpublicfs                     /* set publicly exported fs */
 779             (struct mount *, struct netexport *, struct export_args *);
 780 void    vfs_msync(struct mount *, int);
 781 int     vfs_busy(struct mount *, int);
 782 int     vfs_export                       /* process mount export info */
 783             (struct mount *, struct export_args *);
 784 void    vfs_allocate_syncvnode(struct mount *);
 785 void    vfs_deallocate_syncvnode(struct mount *);
 786 int     vfs_donmount(struct thread *td, uint64_t fsflags,
 787             struct uio *fsoptions);
 788 void    vfs_getnewfsid(struct mount *);
 789 struct cdev *vfs_getrootfsid(struct mount *);
 790 struct  mount *vfs_getvfs(fsid_t *);      /* return vfs given fsid */
 791 struct  mount *vfs_busyfs(fsid_t *);
 792 int     vfs_modevent(module_t, int, void *);
 793 void    vfs_mount_error(struct mount *, const char *, ...);
 794 void    vfs_mountroot(void);                    /* mount our root filesystem */
 795 void    vfs_mountedfrom(struct mount *, const char *from);
 796 void    vfs_oexport_conv(const struct oexport_args *oexp,
 797             struct export_args *exp);
 798 void    vfs_ref(struct mount *);
 799 void    vfs_rel(struct mount *);
 800 struct mount *vfs_mount_alloc(struct vnode *, struct vfsconf *, const char *,
 801             struct ucred *);
 802 int     vfs_suser(struct mount *, struct thread *);
 803 void    vfs_unbusy(struct mount *);
 804 void    vfs_unmountall(void);
 805 extern  TAILQ_HEAD(mntlist, mount) mountlist;   /* mounted filesystem list */
 806 extern  struct mtx mountlist_mtx;
 807 extern  struct nfs_public nfs_pub;
 808
 809 /*
 810  * Declarations for these vfs default operations are located in
 811  * kern/vfs_default.c, they should be used instead of making "dummy"
 812  * functions or casting entries in the VFS op table to "enopnotsupp()".
 813  */
 814 vfs_root_t              vfs_stdroot;
 815 vfs_quotactl_t          vfs_stdquotactl;
 816 vfs_statfs_t            vfs_stdstatfs;
 817 vfs_sync_t              vfs_stdsync;
 818 vfs_sync_t              vfs_stdnosync;
 819 vfs_vget_t              vfs_stdvget;
 820 vfs_fhtovp_t            vfs_stdfhtovp;
 821 vfs_checkexp_t          vfs_stdcheckexp;
 822 vfs_init_t              vfs_stdinit;
 823 vfs_uninit_t            vfs_stduninit;
 824 vfs_extattrctl_t        vfs_stdextattrctl;
 825 vfs_sysctl_t            vfs_stdsysctl;
 826
 827 #else /* !_KERNEL */
 828
 829 #include <sys/cdefs.h>
 830
 831 struct stat;
 832
 833 __BEGIN_DECLS
 834 int     fhopen(const struct fhandle *, int);
 835 int     fhstat(const struct fhandle *, struct stat *);
 836 int     fhstatfs(const struct fhandle *, struct statfs *);
 837 int     fstatfs(int, struct statfs *);
 838 int     getfh(const char *, fhandle_t *);
 839 int     getfsstat(struct statfs *, long, int);
 840 int     getmntinfo(struct statfs **, int);
 841 int     lgetfh(const char *, fhandle_t *);
 842 int     mount(const char *, const char *, int, void *);
 843 int     nmount(struct iovec *, unsigned int, int);
 844 int     statfs(const char *, struct statfs *);
 845 int     unmount(const char *, int);
 846
 847 /* C library stuff */
 848 int     getvfsbyname(const char *, struct xvfsconf *);
 849 __END_DECLS
 850
 851 #endif /* _KERNEL */
 852
 853 #endif /* !_SYS_MOUNT_H_ */