sys/sys/mount.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1989, 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)mount.h     8.21 (Berkeley) 5/20/95
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _SYS_MOUNT_H_
  36 #define _SYS_MOUNT_H_
  37
  38 #include <sys/ucred.h>
  39 #include <sys/queue.h>
  40 #ifdef _KERNEL
  41 #include <sys/lock.h>
  42 #include <sys/lockmgr.h>
  43 #include <sys/tslog.h>
  44 #include <sys/_mutex.h>
  45 #include <sys/_sx.h>
  46 #endif
  47
  48 /*
  49  * NOTE: When changing statfs structure, mount structure, MNT_* flags or
  50  * MNTK_* flags also update DDB show mount command in vfs_subr.c.
  51  */
  52
  53 typedef struct fsid { int32_t val[2]; } fsid_t; /* filesystem id type */
  54
  55 #define fsidcmp(a, b) memcmp((a), (b), sizeof(fsid_t))
  56
  57 /*
  58  * File identifier.
  59  * These are unique per filesystem on a single machine.
  60  *
  61  * Note that the offset of fid_data is 4 bytes, so care must be taken to avoid
  62  * undefined behavior accessing unaligned fields within an embedded struct.
  63  */
  64 #define MAXFIDSZ        16
  65
  66 struct fid {
  67         u_short         fid_len;                /* length of data in bytes */
  68         u_short         fid_data0;              /* force longword alignment */
  69         char            fid_data[MAXFIDSZ];     /* data (variable length) */
  70 };
  71
  72 /*
  73  * filesystem statistics
  74  */
  75 #define MFSNAMELEN      16              /* length of type name including null */
  76 #define MNAMELEN        1024            /* size of on/from name bufs */
  77 #define STATFS_VERSION  0x20140518      /* current version number */
  78 struct statfs {
  79         uint32_t f_version;             /* structure version number */
  80         uint32_t f_type;                /* type of filesystem */
  81         uint64_t f_flags;               /* copy of mount exported flags */
  82         uint64_t f_bsize;               /* filesystem fragment size */
  83         uint64_t f_iosize;              /* optimal transfer block size */
  84         uint64_t f_blocks;              /* total data blocks in filesystem */
  85         uint64_t f_bfree;               /* free blocks in filesystem */
  86         int64_t  f_bavail;              /* free blocks avail to non-superuser */
  87         uint64_t f_files;               /* total file nodes in filesystem */
  88         int64_t  f_ffree;               /* free nodes avail to non-superuser */
  89         uint64_t f_syncwrites;          /* count of sync writes since mount */
  90         uint64_t f_asyncwrites;         /* count of async writes since mount */
  91         uint64_t f_syncreads;           /* count of sync reads since mount */
  92         uint64_t f_asyncreads;          /* count of async reads since mount */
  93         uint64_t f_spare[10];           /* unused spare */
  94         uint32_t f_namemax;             /* maximum filename length */
  95         uid_t     f_owner;              /* user that mounted the filesystem */
  96         fsid_t    f_fsid;               /* filesystem id */
  97         char      f_charspare[80];          /* spare string space */
  98         char      f_fstypename[MFSNAMELEN]; /* filesystem type name */
  99         char      f_mntfromname[MNAMELEN];  /* mounted filesystem */
 100         char      f_mntonname[MNAMELEN];    /* directory on which mounted */
 101 };
 102
 103 #if defined(_WANT_FREEBSD11_STATFS) || defined(_KERNEL)
 104 #define FREEBSD11_STATFS_VERSION        0x20030518 /* current version number */
 105 struct freebsd11_statfs {
 106         uint32_t f_version;             /* structure version number */
 107         uint32_t f_type;                /* type of filesystem */
 108         uint64_t f_flags;               /* copy of mount exported flags */
 109         uint64_t f_bsize;               /* filesystem fragment size */
 110         uint64_t f_iosize;              /* optimal transfer block size */
 111         uint64_t f_blocks;              /* total data blocks in filesystem */
 112         uint64_t f_bfree;               /* free blocks in filesystem */
 113         int64_t  f_bavail;              /* free blocks avail to non-superuser */
 114         uint64_t f_files;               /* total file nodes in filesystem */
 115         int64_t  f_ffree;               /* free nodes avail to non-superuser */
 116         uint64_t f_syncwrites;          /* count of sync writes since mount */
 117         uint64_t f_asyncwrites;         /* count of async writes since mount */
 118         uint64_t f_syncreads;           /* count of sync reads since mount */
 119         uint64_t f_asyncreads;          /* count of async reads since mount */
 120         uint64_t f_spare[10];           /* unused spare */
 121         uint32_t f_namemax;             /* maximum filename length */
 122         uid_t     f_owner;              /* user that mounted the filesystem */
 123         fsid_t    f_fsid;               /* filesystem id */
 124         char      f_charspare[80];      /* spare string space */
 125         char      f_fstypename[16];     /* filesystem type name */
 126         char      f_mntfromname[88];    /* mounted filesystem */
 127         char      f_mntonname[88];      /* directory on which mounted */
 128 };
 129 #endif /* _WANT_FREEBSD11_STATFS || _KERNEL */
 130
 131 #ifdef _KERNEL
 132 #define OMFSNAMELEN     16      /* length of fs type name, including null */
 133 #define OMNAMELEN       (88 - 2 * sizeof(long)) /* size of on/from name bufs */
 134
 135 /* XXX getfsstat.2 is out of date with write and read counter changes here. */
 136 /* XXX statfs.2 is out of date with read counter changes here. */
 137 struct ostatfs {
 138         long    f_spare2;               /* placeholder */
 139         long    f_bsize;                /* fundamental filesystem block size */
 140         long    f_iosize;               /* optimal transfer block size */
 141         long    f_blocks;               /* total data blocks in filesystem */
 142         long    f_bfree;                /* free blocks in fs */
 143         long    f_bavail;               /* free blocks avail to non-superuser */
 144         long    f_files;                /* total file nodes in filesystem */
 145         long    f_ffree;                /* free file nodes in fs */
 146         fsid_t  f_fsid;                 /* filesystem id */
 147         uid_t   f_owner;                /* user that mounted the filesystem */
 148         int     f_type;                 /* type of filesystem */
 149         int     f_flags;                /* copy of mount exported flags */
 150         long    f_syncwrites;           /* count of sync writes since mount */
 151         long    f_asyncwrites;          /* count of async writes since mount */
 152         char    f_fstypename[OMFSNAMELEN]; /* fs type name */
 153         char    f_mntonname[OMNAMELEN]; /* directory on which mounted */
 154         long    f_syncreads;            /* count of sync reads since mount */
 155         long    f_asyncreads;           /* count of async reads since mount */
 156         short   f_spares1;              /* unused spare */
 157         char    f_mntfromname[OMNAMELEN];/* mounted filesystem */
 158         short   f_spares2;              /* unused spare */
 159         /*
 160          * XXX on machines where longs are aligned to 8-byte boundaries, there
 161          * is an unnamed int32_t here.  This spare was after the apparent end
 162          * of the struct until we bit off the read counters from f_mntonname.
 163          */
 164         long    f_spare[2];             /* unused spare */
 165 };
 166 #endif  /* _KERNEL */
 167
 168 #if defined(_WANT_MOUNT) || defined(_KERNEL)
 169 TAILQ_HEAD(vnodelst, vnode);
 170
 171 /* Mount options list */
 172 TAILQ_HEAD(vfsoptlist, vfsopt);
 173 struct vfsopt {
 174         TAILQ_ENTRY(vfsopt) link;
 175         char    *name;
 176         void    *value;
 177         int     len;
 178         int     pos;
 179         int     seen;
 180 };
 181
 182 struct mount_pcpu {
 183         int             mntp_thread_in_ops;
 184         int             mntp_ref;
 185         int             mntp_lockref;
 186         int             mntp_writeopcount;
 187 };
 188
 189 _Static_assert(sizeof(struct mount_pcpu) == 16,
 190     "the struct is allocated from pcpu 16 zone");
 191
 192 /*
 193  * Structure per mounted filesystem.  Each mounted filesystem has an
 194  * array of operations and an instance record.  The filesystems are
 195  * put on a doubly linked list.
 196  *
 197  * Lock reference:
 198  *      l - mnt_listmtx
 199  *      m - mountlist_mtx
 200  *      i - interlock
 201  *      i* - interlock of uppers' list head
 202  *      v - vnode freelist mutex
 203  *
 204  * Unmarked fields are considered stable as long as a ref is held.
 205  *
 206  */
 207 struct mount {
 208         int             mnt_vfs_ops;            /* (i) pending vfs ops */
 209         int             mnt_kern_flag;          /* (i) kernel only flags */
 210         uint64_t        mnt_flag;               /* (i) flags shared with user */
 211         struct mount_pcpu *mnt_pcpu;            /* per-CPU data */
 212         struct vnode    *mnt_rootvnode;
 213         struct vnode    *mnt_vnodecovered;      /* vnode we mounted on */
 214         struct vfsops   *mnt_op;                /* operations on fs */
 215         struct vfsconf  *mnt_vfc;               /* configuration info */
 216         struct mtx __aligned(CACHE_LINE_SIZE)   mnt_mtx; /* mount structure interlock */
 217         int             mnt_gen;                /* struct mount generation */
 218 #define mnt_startzero   mnt_list
 219         TAILQ_ENTRY(mount) mnt_list;            /* (m) mount list */
 220         struct vnode    *mnt_syncer;            /* syncer vnode */
 221         int             mnt_ref;                /* (i) Reference count */
 222         struct vnodelst mnt_nvnodelist;         /* (i) list of vnodes */
 223         int             mnt_nvnodelistsize;     /* (i) # of vnodes */
 224         int             mnt_writeopcount;       /* (i) write syscalls pending */
 225         struct vfsoptlist *mnt_opt;             /* current mount options */
 226         struct vfsoptlist *mnt_optnew;          /* new options passed to fs */
 227         int             mnt_maxsymlinklen;      /* max size of short symlink */
 228         struct statfs   mnt_stat;               /* cache of filesystem stats */
 229         struct ucred    *mnt_cred;              /* credentials of mounter */
 230         void *          mnt_data;               /* private data */
 231         time_t          mnt_time;               /* last time written*/
 232         int             mnt_iosize_max;         /* max size for clusters, etc */
 233         struct netexport *mnt_export;           /* export list */
 234         struct label    *mnt_label;             /* MAC label for the fs */
 235         u_int           mnt_hashseed;           /* Random seed for vfs_hash */
 236         int             mnt_lockref;            /* (i) Lock reference count */
 237         int             mnt_secondary_writes;   /* (i) # of secondary writes */
 238         int             mnt_secondary_accwrites;/* (i) secondary wr. starts */
 239         struct thread   *mnt_susp_owner;        /* (i) thread owning suspension */
 240 #define mnt_endzero     mnt_gjprovider
 241         char            *mnt_gjprovider;        /* gjournal provider name */
 242         struct mtx      mnt_listmtx;
 243         struct vnodelst mnt_lazyvnodelist;      /* (l) list of lazy vnodes */
 244         int             mnt_lazyvnodelistsize;  /* (l) # of lazy vnodes */
 245         struct lock     mnt_explock;            /* vfs_export walkers lock */
 246         TAILQ_ENTRY(mount) mnt_upper_link;      /* (i*) we in the all uppers */
 247         TAILQ_HEAD(, mount) mnt_uppers;         /* (i) upper mounts over us */
 248 };
 249 #endif  /* _WANT_MOUNT || _KERNEL */
 250
 251 #ifdef _KERNEL
 252 /*
 253  * Definitions for MNT_VNODE_FOREACH_ALL.
 254  */
 255 struct vnode *__mnt_vnode_next_all(struct vnode **mvp, struct mount *mp);
 256 struct vnode *__mnt_vnode_first_all(struct vnode **mvp, struct mount *mp);
 257 void          __mnt_vnode_markerfree_all(struct vnode **mvp, struct mount *mp);
 258
 259 #define MNT_VNODE_FOREACH_ALL(vp, mp, mvp)                              \
 260         for (vp = __mnt_vnode_first_all(&(mvp), (mp));                  \
 261                 (vp) != NULL; vp = __mnt_vnode_next_all(&(mvp), (mp)))
 262
 263 #define MNT_VNODE_FOREACH_ALL_ABORT(mp, mvp)                            \
 264         do {                                                            \
 265                 MNT_ILOCK(mp);                                          \
 266                 __mnt_vnode_markerfree_all(&(mvp), (mp));               \
 267                 /* MNT_IUNLOCK(mp); -- done in above function */        \
 268                 mtx_assert(MNT_MTX(mp), MA_NOTOWNED);                   \
 269         } while (0)
 270
 271 /*
 272  * Definitions for MNT_VNODE_FOREACH_LAZY.
 273  */
 274 typedef int mnt_lazy_cb_t(struct vnode *, void *);
 275 struct vnode *__mnt_vnode_next_lazy(struct vnode **mvp, struct mount *mp,
 276     mnt_lazy_cb_t *cb, void *cbarg);
 277 struct vnode *__mnt_vnode_first_lazy(struct vnode **mvp, struct mount *mp,
 278     mnt_lazy_cb_t *cb, void *cbarg);
 279 void          __mnt_vnode_markerfree_lazy(struct vnode **mvp, struct mount *mp);
 280
 281 #define MNT_VNODE_FOREACH_LAZY(vp, mp, mvp, cb, cbarg)                  \
 282         for (vp = __mnt_vnode_first_lazy(&(mvp), (mp), (cb), (cbarg));  \
 283                 (vp) != NULL;                                           \
 284                 vp = __mnt_vnode_next_lazy(&(mvp), (mp), (cb), (cbarg)))
 285
 286 #define MNT_VNODE_FOREACH_LAZY_ABORT(mp, mvp)                           \
 287         __mnt_vnode_markerfree_lazy(&(mvp), (mp))
 288
 289 #define MNT_ILOCK(mp)   mtx_lock(&(mp)->mnt_mtx)
 290 #define MNT_ITRYLOCK(mp) mtx_trylock(&(mp)->mnt_mtx)
 291 #define MNT_IUNLOCK(mp) mtx_unlock(&(mp)->mnt_mtx)
 292 #define MNT_MTX(mp)     (&(mp)->mnt_mtx)
 293
 294 #define MNT_REF(mp)     do {                                            \
 295         mtx_assert(MNT_MTX(mp), MA_OWNED);                              \
 296         mp->mnt_ref++;                                                  \
 297 } while (0)
 298 #define MNT_REL(mp)     do {                                            \
 299         mtx_assert(MNT_MTX(mp), MA_OWNED);                              \
 300         (mp)->mnt_ref--;                                                \
 301         if ((mp)->mnt_vfs_ops && (mp)->mnt_ref < 0)             \
 302                 vfs_dump_mount_counters(mp);                            \
 303         if ((mp)->mnt_ref == 0 && (mp)->mnt_vfs_ops)            \
 304                 wakeup((mp));                                           \
 305 } while (0)
 306
 307 #endif /* _KERNEL */
 308
 309 #if defined(_WANT_MNTOPTNAMES) || defined(_KERNEL)
 310 struct mntoptnames {
 311         uint64_t o_opt;
 312         const char *o_name;
 313 };
 314 #define MNTOPT_NAMES                                                    \
 315         { MNT_ASYNC,            "asynchronous" },                       \
 316         { MNT_EXPORTED,         "NFS exported" },                       \
 317         { MNT_LOCAL,            "local" },                              \
 318         { MNT_NOATIME,          "noatime" },                            \
 319         { MNT_NOEXEC,           "noexec" },                             \
 320         { MNT_NOSUID,           "nosuid" },                             \
 321         { MNT_NOSYMFOLLOW,      "nosymfollow" },                        \
 322         { MNT_QUOTA,            "with quotas" },                        \
 323         { MNT_RDONLY,           "read-only" },                          \
 324         { MNT_SYNCHRONOUS,      "synchronous" },                        \
 325         { MNT_UNION,            "union" },                              \
 326         { MNT_NOCLUSTERR,       "noclusterr" },                         \
 327         { MNT_NOCLUSTERW,       "noclusterw" },                         \
 328         { MNT_SUIDDIR,          "suiddir" },                            \
 329         { MNT_SOFTDEP,          "soft-updates" },                       \
 330         { MNT_SUJ,              "journaled soft-updates" },             \
 331         { MNT_MULTILABEL,       "multilabel" },                         \
 332         { MNT_ACLS,             "acls" },                               \
 333         { MNT_NFS4ACLS,         "nfsv4acls" },                          \
 334         { MNT_GJOURNAL,         "gjournal" },                           \
 335         { MNT_AUTOMOUNTED,      "automounted" },                        \
 336         { MNT_VERIFIED,         "verified" },                           \
 337         { MNT_UNTRUSTED,        "untrusted" },                          \
 338         { MNT_NOCOVER,          "nocover" },                            \
 339         { MNT_EMPTYDIR,         "emptydir" },                           \
 340         { MNT_UPDATE,           "update" },                             \
 341         { MNT_DELEXPORT,        "delexport" },                          \
 342         { MNT_RELOAD,           "reload" },                             \
 343         { MNT_FORCE,            "force" },                              \
 344         { MNT_SNAPSHOT,         "snapshot" },                           \
 345         { 0, NULL }
 346 #endif
 347
 348 /*
 349  * User specifiable flags, stored in mnt_flag.
 350  */
 351 #define MNT_RDONLY      0x0000000000000001ULL /* read only filesystem */
 352 #define MNT_SYNCHRONOUS 0x0000000000000002ULL /* fs written synchronously */
 353 #define MNT_NOEXEC      0x0000000000000004ULL /* can't exec from filesystem */
 354 #define MNT_NOSUID      0x0000000000000008ULL /* don't honor setuid fs bits */
 355 #define MNT_NFS4ACLS    0x0000000000000010ULL /* enable NFS version 4 ACLs */
 356 #define MNT_UNION       0x0000000000000020ULL /* union with underlying fs */
 357 #define MNT_ASYNC       0x0000000000000040ULL /* fs written asynchronously */
 358 #define MNT_SUIDDIR     0x0000000000100000ULL /* special SUID dir handling */
 359 #define MNT_SOFTDEP     0x0000000000200000ULL /* using soft updates */
 360 #define MNT_NOSYMFOLLOW 0x0000000000400000ULL /* do not follow symlinks */
 361 #define MNT_GJOURNAL    0x0000000002000000ULL /* GEOM journal support enabled */
 362 #define MNT_MULTILABEL  0x0000000004000000ULL /* MAC support for objects */
 363 #define MNT_ACLS        0x0000000008000000ULL /* ACL support enabled */
 364 #define MNT_NOATIME     0x0000000010000000ULL /* dont update file access time */
 365 #define MNT_NOCLUSTERR  0x0000000040000000ULL /* disable cluster read */
 366 #define MNT_NOCLUSTERW  0x0000000080000000ULL /* disable cluster write */
 367 #define MNT_SUJ         0x0000000100000000ULL /* using journaled soft updates */
 368 #define MNT_AUTOMOUNTED 0x0000000200000000ULL /* mounted by automountd(8) */
 369 #define MNT_UNTRUSTED   0x0000000800000000ULL /* filesys metadata untrusted */
 370
 371 /*
 372  * NFS export related mount flags.
 373  */
 374 #define MNT_EXRDONLY    0x0000000000000080ULL   /* exported read only */
 375 #define MNT_EXPORTED    0x0000000000000100ULL   /* filesystem is exported */
 376 #define MNT_DEFEXPORTED 0x0000000000000200ULL   /* exported to the world */
 377 #define MNT_EXPORTANON  0x0000000000000400ULL   /* anon uid mapping for all */
 378 #define MNT_EXKERB      0x0000000000000800ULL   /* exported with Kerberos */
 379 #define MNT_EXPUBLIC    0x0000000020000000ULL   /* public export (WebNFS) */
 380 #define MNT_EXTLS       0x0000004000000000ULL /* require TLS */
 381 #define MNT_EXTLSCERT   0x0000008000000000ULL /* require TLS with client cert */
 382 #define MNT_EXTLSCERTUSER 0x0000010000000000ULL /* require TLS with user cert */
 383
 384 /*
 385  * Flags set by internal operations,
 386  * but visible to the user.
 387  * XXX some of these are not quite right.. (I've never seen the root flag set)
 388  */
 389 #define MNT_LOCAL       0x0000000000001000ULL /* filesystem is stored locally */
 390 #define MNT_QUOTA       0x0000000000002000ULL /* quotas are enabled on fs */
 391 #define MNT_ROOTFS      0x0000000000004000ULL /* identifies the root fs */
 392 #define MNT_USER        0x0000000000008000ULL /* mounted by a user */
 393 #define MNT_IGNORE      0x0000000000800000ULL /* do not show entry in df */
 394 #define MNT_VERIFIED    0x0000000400000000ULL /* filesystem is verified */
 395
 396 /*
 397  * Mask of flags that are visible to statfs().
 398  * XXX I think that this could now become (~(MNT_CMDFLAGS))
 399  * but the 'mount' program may need changing to handle this.
 400  */
 401 #define MNT_VISFLAGMASK (MNT_RDONLY     | MNT_SYNCHRONOUS | MNT_NOEXEC  | \
 402                         MNT_NOSUID      | MNT_UNION     | MNT_SUJ       | \
 403                         MNT_ASYNC       | MNT_EXRDONLY  | MNT_EXPORTED  | \
 404                         MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB    | \
 405                         MNT_LOCAL       | MNT_USER      | MNT_QUOTA     | \
 406                         MNT_ROOTFS      | MNT_NOATIME   | MNT_NOCLUSTERR| \
 407                         MNT_NOCLUSTERW  | MNT_SUIDDIR   | MNT_SOFTDEP   | \
 408                         MNT_IGNORE      | MNT_EXPUBLIC  | MNT_NOSYMFOLLOW | \
 409                         MNT_GJOURNAL    | MNT_MULTILABEL | MNT_ACLS     | \
 410                         MNT_NFS4ACLS    | MNT_AUTOMOUNTED | MNT_VERIFIED | \
 411                         MNT_UNTRUSTED)
 412
 413 /* Mask of flags that can be updated. */
 414 #define MNT_UPDATEMASK (MNT_NOSUID      | MNT_NOEXEC    | \
 415                         MNT_SYNCHRONOUS | MNT_UNION     | MNT_ASYNC     | \
 416                         MNT_NOATIME | \
 417                         MNT_NOSYMFOLLOW | MNT_IGNORE    | \
 418                         MNT_NOCLUSTERR  | MNT_NOCLUSTERW | MNT_SUIDDIR  | \
 419                         MNT_ACLS        | MNT_USER      | MNT_NFS4ACLS  | \
 420                         MNT_AUTOMOUNTED | MNT_UNTRUSTED)
 421
 422 /*
 423  * External filesystem command modifier flags.
 424  * Unmount can use the MNT_FORCE flag.
 425  * XXX: These are not STATES and really should be somewhere else.
 426  * XXX: MNT_BYFSID and MNT_NONBUSY collide with MNT_ACLS and MNT_MULTILABEL,
 427  *      but because MNT_ACLS and MNT_MULTILABEL are only used for mount(2),
 428  *      and MNT_BYFSID and MNT_NONBUSY are only used for unmount(2),
 429  *      it's harmless.
 430  */
 431 #define MNT_UPDATE      0x0000000000010000ULL /* not real mount, just update */
 432 #define MNT_DELEXPORT   0x0000000000020000ULL /* delete export host lists */
 433 #define MNT_RELOAD      0x0000000000040000ULL /* reload filesystem data */
 434 #define MNT_FORCE       0x0000000000080000ULL /* force unmount or readonly */
 435 #define MNT_SNAPSHOT    0x0000000001000000ULL /* snapshot the filesystem */
 436 #define MNT_NONBUSY     0x0000000004000000ULL /* check vnode use counts. */
 437 #define MNT_BYFSID      0x0000000008000000ULL /* specify filesystem by ID. */
 438 #define MNT_NOCOVER     0x0000001000000000ULL /* Do not cover a mount point */
 439 #define MNT_EMPTYDIR    0x0000002000000000ULL /* Only mount on empty dir */
 440 #define MNT_CMDFLAGS   (MNT_UPDATE      | MNT_DELEXPORT | MNT_RELOAD    | \
 441                         MNT_FORCE       | MNT_SNAPSHOT  | MNT_NONBUSY   | \
 442                         MNT_BYFSID      | MNT_NOCOVER   | MNT_EMPTYDIR)
 443 /*
 444  * Internal filesystem control flags stored in mnt_kern_flag.
 445  *
 446  * MNTK_UNMOUNT locks the mount entry so that name lookup cannot
 447  * proceed past the mount point.  This keeps the subtree stable during
 448  * mounts and unmounts.  When non-forced unmount flushes all vnodes
 449  * from the mp queue, the MNTK_UNMOUNT flag prevents insmntque() from
 450  * queueing new vnodes.
 451  *
 452  * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while
 453  * dounmount() is still waiting to lock the mountpoint. This allows
 454  * the filesystem to cancel operations that might otherwise deadlock
 455  * with the unmount attempt (used by NFS).
 456  */
 457 #define MNTK_UNMOUNTF   0x00000001      /* forced unmount in progress */
 458 #define MNTK_ASYNC      0x00000002      /* filtered async flag */
 459 #define MNTK_SOFTDEP    0x00000004      /* async disabled by softdep */
 460 #define MNTK_NOMSYNC    0x00000008      /* don't do msync */
 461 #define MNTK_DRAINING   0x00000010      /* lock draining is happening */
 462 #define MNTK_REFEXPIRE  0x00000020      /* refcount expiring is happening */
 463 #define MNTK_EXTENDED_SHARED    0x00000040 /* Allow shared locking for more ops */
 464 #define MNTK_SHARED_WRITES      0x00000080 /* Allow shared locking for writes */
 465 #define MNTK_NO_IOPF    0x00000100      /* Disallow page faults during reads
 466                                            and writes. Filesystem shall properly
 467                                            handle i/o state on EFAULT. */
 468 #define MNTK_VGONE_UPPER        0x00000200
 469 #define MNTK_VGONE_WAITER       0x00000400
 470 #define MNTK_LOOKUP_EXCL_DOTDOT 0x00000800
 471 #define MNTK_MARKER             0x00001000
 472 #define MNTK_UNMAPPED_BUFS      0x00002000
 473 #define MNTK_USES_BCACHE        0x00004000 /* FS uses the buffer cache. */
 474 #define MNTK_TEXT_REFS          0x00008000 /* Keep use ref for text */
 475 #define MNTK_VMSETSIZE_BUG      0x00010000
 476 #define MNTK_UNIONFS    0x00020000      /* A hack for F_ISUNIONSTACK */
 477 #define MNTK_FPLOOKUP   0x00040000      /* fast path lookup is supported */
 478 #define MNTK_SUSPEND_ALL        0x00080000 /* Suspended by all-fs suspension */
 479 #define MNTK_NOASYNC    0x00800000      /* disable async */
 480 #define MNTK_UNMOUNT    0x01000000      /* unmount in progress */
 481 #define MNTK_MWAIT      0x02000000      /* waiting for unmount to finish */
 482 #define MNTK_SUSPEND    0x08000000      /* request write suspension */
 483 #define MNTK_SUSPEND2   0x04000000      /* block secondary writes */
 484 #define MNTK_SUSPENDED  0x10000000      /* write operations are suspended */
 485 #define MNTK_NULL_NOCACHE       0x20000000 /* auto disable cache for nullfs
 486                                               mounts over this fs */
 487 #define MNTK_LOOKUP_SHARED      0x40000000 /* FS supports shared lock lookups */
 488 #define MNTK_NOKNOTE    0x80000000      /* Don't send KNOTEs from VOP hooks */
 489
 490 #ifdef _KERNEL
 491 static inline int
 492 MNT_SHARED_WRITES(struct mount *mp)
 493 {
 494
 495         return (mp != NULL && (mp->mnt_kern_flag & MNTK_SHARED_WRITES) != 0);
 496 }
 497
 498 static inline int
 499 MNT_EXTENDED_SHARED(struct mount *mp)
 500 {
 501
 502         return (mp != NULL && (mp->mnt_kern_flag & MNTK_EXTENDED_SHARED) != 0);
 503 }
 504 #endif
 505
 506 /*
 507  * Sysctl CTL_VFS definitions.
 508  *
 509  * Second level identifier specifies which filesystem. Second level
 510  * identifier VFS_VFSCONF returns information about all filesystems.
 511  * Second level identifier VFS_GENERIC is non-terminal.
 512  */
 513 #define VFS_VFSCONF             0       /* get configured filesystems */
 514 #define VFS_GENERIC             0       /* generic filesystem information */
 515 /*
 516  * Third level identifiers for VFS_GENERIC are given below; third
 517  * level identifiers for specific filesystems are given in their
 518  * mount specific header files.
 519  */
 520 #define VFS_MAXTYPENUM  1       /* int: highest defined filesystem type */
 521 #define VFS_CONF        2       /* struct: vfsconf for filesystem given
 522                                    as next argument */
 523
 524 /*
 525  * Flags for various system call interfaces.
 526  *
 527  * waitfor flags to vfs_sync() and getfsstat()
 528  */
 529 #define MNT_WAIT        1       /* synchronously wait for I/O to complete */
 530 #define MNT_NOWAIT      2       /* start all I/O, but do not wait for it */
 531 #define MNT_LAZY        3       /* push data not written by filesystem syncer */
 532 #define MNT_SUSPEND     4       /* Suspend file system after sync */
 533
 534 /*
 535  * Generic file handle
 536  */
 537 struct fhandle {
 538         fsid_t  fh_fsid;        /* Filesystem id of mount point */
 539         struct  fid fh_fid;     /* Filesys specific id */
 540 };
 541 typedef struct fhandle  fhandle_t;
 542
 543 /*
 544  * Old export arguments without security flavor list
 545  */
 546 struct oexport_args {
 547         int     ex_flags;               /* export related flags */
 548         uid_t   ex_root;                /* mapping for root uid */
 549         struct  xucred ex_anon;         /* mapping for anonymous user */
 550         struct  sockaddr *ex_addr;      /* net address to which exported */
 551         u_char  ex_addrlen;             /* and the net address length */
 552         struct  sockaddr *ex_mask;      /* mask of valid bits in saddr */
 553         u_char  ex_masklen;             /* and the smask length */
 554         char    *ex_indexfile;          /* index file for WebNFS URLs */
 555 };
 556
 557 /*
 558  * Not quite so old export arguments with 32bit ex_flags and xucred ex_anon.
 559  */
 560 #define MAXSECFLAVORS   5
 561 struct o2export_args {
 562         int     ex_flags;               /* export related flags */
 563         uid_t   ex_root;                /* mapping for root uid */
 564         struct  xucred ex_anon;         /* mapping for anonymous user */
 565         struct  sockaddr *ex_addr;      /* net address to which exported */
 566         u_char  ex_addrlen;             /* and the net address length */
 567         struct  sockaddr *ex_mask;      /* mask of valid bits in saddr */
 568         u_char  ex_masklen;             /* and the smask length */
 569         char    *ex_indexfile;          /* index file for WebNFS URLs */
 570         int     ex_numsecflavors;       /* security flavor count */
 571         int     ex_secflavors[MAXSECFLAVORS]; /* list of security flavors */
 572 };
 573
 574 /*
 575  * Export arguments for local filesystem mount calls.
 576  */
 577 struct export_args {
 578         uint64_t ex_flags;              /* export related flags */
 579         uid_t   ex_root;                /* mapping for root uid */
 580         uid_t   ex_uid;                 /* mapping for anonymous user */
 581         int     ex_ngroups;
 582         gid_t   *ex_groups;
 583         struct  sockaddr *ex_addr;      /* net address to which exported */
 584         u_char  ex_addrlen;             /* and the net address length */
 585         struct  sockaddr *ex_mask;      /* mask of valid bits in saddr */
 586         u_char  ex_masklen;             /* and the smask length */
 587         char    *ex_indexfile;          /* index file for WebNFS URLs */
 588         int     ex_numsecflavors;       /* security flavor count */
 589         int     ex_secflavors[MAXSECFLAVORS]; /* list of security flavors */
 590 };
 591
 592 /*
 593  * Structure holding information for a publicly exported filesystem
 594  * (WebNFS). Currently the specs allow just for one such filesystem.
 595  */
 596 struct nfs_public {
 597         int             np_valid;       /* Do we hold valid information */
 598         fhandle_t       np_handle;      /* Filehandle for pub fs (internal) */
 599         struct mount    *np_mount;      /* Mountpoint of exported fs */
 600         char            *np_index;      /* Index file */
 601 };
 602
 603 /*
 604  * Filesystem configuration information. One of these exists for each
 605  * type of filesystem supported by the kernel. These are searched at
 606  * mount time to identify the requested filesystem.
 607  *
 608  * XXX: Never change the first two arguments!
 609  */
 610 struct vfsconf {
 611         u_int   vfc_version;            /* ABI version number */
 612         char    vfc_name[MFSNAMELEN];   /* filesystem type name */
 613         struct  vfsops *vfc_vfsops;     /* filesystem operations vector */
 614         struct  vfsops *vfc_vfsops_sd;  /* ... signal-deferred */
 615         int     vfc_typenum;            /* historic filesystem type number */
 616         int     vfc_refcount;           /* number mounted of this type */
 617         int     vfc_flags;              /* permanent flags */
 618         int     vfc_prison_flag;        /* prison allow.mount.* flag */
 619         struct  vfsoptdecl *vfc_opts;   /* mount options */
 620         TAILQ_ENTRY(vfsconf) vfc_list;  /* list of vfscons */
 621 };
 622
 623 /* Userland version of the struct vfsconf. */
 624 struct xvfsconf {
 625         struct  vfsops *vfc_vfsops;     /* filesystem operations vector */
 626         char    vfc_name[MFSNAMELEN];   /* filesystem type name */
 627         int     vfc_typenum;            /* historic filesystem type number */
 628         int     vfc_refcount;           /* number mounted of this type */
 629         int     vfc_flags;              /* permanent flags */
 630         struct  vfsconf *vfc_next;      /* next in list */
 631 };
 632
 633 #ifndef BURN_BRIDGES
 634 struct ovfsconf {
 635         void    *vfc_vfsops;
 636         char    vfc_name[32];
 637         int     vfc_index;
 638         int     vfc_refcount;
 639         int     vfc_flags;
 640 };
 641 #endif
 642
 643 /*
 644  * NB: these flags refer to IMPLEMENTATION properties, not properties of
 645  * any actual mounts; i.e., it does not make sense to change the flags.
 646  */
 647 #define VFCF_STATIC     0x00010000      /* statically compiled into kernel */
 648 #define VFCF_NETWORK    0x00020000      /* may get data over the network */
 649 #define VFCF_READONLY   0x00040000      /* writes are not implemented */
 650 #define VFCF_SYNTHETIC  0x00080000      /* data does not represent real files */
 651 #define VFCF_LOOPBACK   0x00100000      /* aliases some other mounted FS */
 652 #define VFCF_UNICODE    0x00200000      /* stores file names as Unicode */
 653 #define VFCF_JAIL       0x00400000      /* can be mounted from within a jail */
 654 #define VFCF_DELEGADMIN 0x00800000      /* supports delegated administration */
 655 #define VFCF_SBDRY      0x01000000      /* Stop at Boundary: defer stop requests
 656                                            to kernel->user (AST) transition */
 657
 658 typedef uint32_t fsctlop_t;
 659
 660 struct vfsidctl {
 661         int             vc_vers;        /* should be VFSIDCTL_VERS1 (below) */
 662         fsid_t          vc_fsid;        /* fsid to operate on */
 663         char            vc_fstypename[MFSNAMELEN];
 664                                         /* type of fs 'nfs' or '*' */
 665         fsctlop_t       vc_op;          /* operation VFS_CTL_* (below) */
 666         void            *vc_ptr;        /* pointer to data structure */
 667         size_t          vc_len;         /* sizeof said structure */
 668         u_int32_t       vc_spare[12];   /* spare (must be zero) */
 669 };
 670
 671 /* vfsidctl API version. */
 672 #define VFS_CTL_VERS1   0x01
 673
 674 /*
 675  * New style VFS sysctls, do not reuse/conflict with the namespace for
 676  * private sysctls.
 677  * All "global" sysctl ops have the 33rd bit set:
 678  * 0x...1....
 679  * Private sysctl ops should have the 33rd bit unset.
 680  */
 681 #define VFS_CTL_QUERY   0x00010001      /* anything wrong? (vfsquery) */
 682 #define VFS_CTL_TIMEO   0x00010002      /* set timeout for vfs notification */
 683 #define VFS_CTL_NOLOCKS 0x00010003      /* disable file locking */
 684
 685 struct vfsquery {
 686         u_int32_t       vq_flags;
 687         u_int32_t       vq_spare[31];
 688 };
 689
 690 /* vfsquery flags */
 691 #define VQ_NOTRESP      0x0001  /* server down */
 692 #define VQ_NEEDAUTH     0x0002  /* server bad auth */
 693 #define VQ_LOWDISK      0x0004  /* we're low on space */
 694 #define VQ_MOUNT        0x0008  /* new filesystem arrived */
 695 #define VQ_UNMOUNT      0x0010  /* filesystem has left */
 696 #define VQ_DEAD         0x0020  /* filesystem is dead, needs force unmount */
 697 #define VQ_ASSIST       0x0040  /* filesystem needs assistance from external
 698                                    program */
 699 #define VQ_NOTRESPLOCK  0x0080  /* server lockd down */
 700 #define VQ_FLAG0100     0x0100  /* placeholder */
 701 #define VQ_FLAG0200     0x0200  /* placeholder */
 702 #define VQ_FLAG0400     0x0400  /* placeholder */
 703 #define VQ_FLAG0800     0x0800  /* placeholder */
 704 #define VQ_FLAG1000     0x1000  /* placeholder */
 705 #define VQ_FLAG2000     0x2000  /* placeholder */
 706 #define VQ_FLAG4000     0x4000  /* placeholder */
 707 #define VQ_FLAG8000     0x8000  /* placeholder */
 708
 709 #ifdef _KERNEL
 710 /* Point a sysctl request at a vfsidctl's data. */
 711 #define VCTLTOREQ(vc, req)                                              \
 712         do {                                                            \
 713                 (req)->newptr = (vc)->vc_ptr;                           \
 714                 (req)->newlen = (vc)->vc_len;                           \
 715                 (req)->newidx = 0;                                      \
 716         } while (0)
 717 #endif
 718
 719 struct iovec;
 720 struct uio;
 721
 722 #ifdef _KERNEL
 723
 724 /*
 725  * vfs_busy specific flags and mask.
 726  */
 727 #define MBF_NOWAIT      0x01
 728 #define MBF_MNTLSTLOCK  0x02
 729 #define MBF_MASK        (MBF_NOWAIT | MBF_MNTLSTLOCK)
 730
 731 #ifdef MALLOC_DECLARE
 732 MALLOC_DECLARE(M_MOUNT);
 733 MALLOC_DECLARE(M_STATFS);
 734 #endif
 735 extern int maxvfsconf;          /* highest defined filesystem type */
 736
 737 TAILQ_HEAD(vfsconfhead, vfsconf);
 738 extern struct vfsconfhead vfsconf;
 739
 740 /*
 741  * Operations supported on mounted filesystem.
 742  */
 743 struct mount_args;
 744 struct nameidata;
 745 struct sysctl_req;
 746 struct mntarg;
 747
 748 /*
 749  * N.B., vfs_cmount is the ancient vfsop invoked by the old mount(2) syscall.
 750  * The new way is vfs_mount.
 751  *
 752  * vfs_cmount implementations typically translate arguments from their
 753  * respective old per-FS structures into the key-value list supported by
 754  * nmount(2), then use kernel_mount(9) to mimic nmount(2) from kernelspace.
 755  *
 756  * Filesystems with mounters that use nmount(2) do not need to and should not
 757  * implement vfs_cmount.  Hopefully a future cleanup can remove vfs_cmount and
 758  * mount(2) entirely.
 759  */
 760 typedef int vfs_cmount_t(struct mntarg *ma, void *data, uint64_t flags);
 761 typedef int vfs_unmount_t(struct mount *mp, int mntflags);
 762 typedef int vfs_root_t(struct mount *mp, int flags, struct vnode **vpp);
 763 typedef int vfs_quotactl_t(struct mount *mp, int cmds, uid_t uid, void *arg);
 764 typedef int vfs_statfs_t(struct mount *mp, struct statfs *sbp);
 765 typedef int vfs_sync_t(struct mount *mp, int waitfor);
 766 typedef int vfs_vget_t(struct mount *mp, ino_t ino, int flags,
 767                     struct vnode **vpp);
 768 typedef int vfs_fhtovp_t(struct mount *mp, struct fid *fhp,
 769                     int flags, struct vnode **vpp);
 770 typedef int vfs_checkexp_t(struct mount *mp, struct sockaddr *nam,
 771                     uint64_t *extflagsp, struct ucred **credanonp,
 772                     int *numsecflavors, int *secflavors);
 773 typedef int vfs_init_t(struct vfsconf *);
 774 typedef int vfs_uninit_t(struct vfsconf *);
 775 typedef int vfs_extattrctl_t(struct mount *mp, int cmd,
 776                     struct vnode *filename_vp, int attrnamespace,
 777                     const char *attrname);
 778 typedef int vfs_mount_t(struct mount *mp);
 779 typedef int vfs_sysctl_t(struct mount *mp, fsctlop_t op,
 780                     struct sysctl_req *req);
 781 typedef void vfs_susp_clean_t(struct mount *mp);
 782 typedef void vfs_notify_lowervp_t(struct mount *mp, struct vnode *lowervp);
 783 typedef void vfs_purge_t(struct mount *mp);
 784
 785 struct vfsops {
 786         vfs_mount_t             *vfs_mount;
 787         vfs_cmount_t            *vfs_cmount;
 788         vfs_unmount_t           *vfs_unmount;
 789         vfs_root_t              *vfs_root;
 790         vfs_root_t              *vfs_cachedroot;
 791         vfs_quotactl_t          *vfs_quotactl;
 792         vfs_statfs_t            *vfs_statfs;
 793         vfs_sync_t              *vfs_sync;
 794         vfs_vget_t              *vfs_vget;
 795         vfs_fhtovp_t            *vfs_fhtovp;
 796         vfs_checkexp_t          *vfs_checkexp;
 797         vfs_init_t              *vfs_init;
 798         vfs_uninit_t            *vfs_uninit;
 799         vfs_extattrctl_t        *vfs_extattrctl;
 800         vfs_sysctl_t            *vfs_sysctl;
 801         vfs_susp_clean_t        *vfs_susp_clean;
 802         vfs_notify_lowervp_t    *vfs_reclaim_lowervp;
 803         vfs_notify_lowervp_t    *vfs_unlink_lowervp;
 804         vfs_purge_t             *vfs_purge;
 805         vfs_mount_t             *vfs_spare[6];  /* spares for ABI compat */
 806 };
 807
 808 vfs_statfs_t    __vfs_statfs;
 809
 810 #define VFS_MOUNT(MP) ({                                                \
 811         int _rc;                                                        \
 812                                                                         \
 813         TSRAW(curthread, TS_ENTER, "VFS_MOUNT", (MP)->mnt_vfc->vfc_name);\
 814         _rc = (*(MP)->mnt_op->vfs_mount)(MP);                           \
 815         TSRAW(curthread, TS_EXIT, "VFS_MOUNT", (MP)->mnt_vfc->vfc_name);\
 816         _rc; })
 817
 818 #define VFS_UNMOUNT(MP, FORCE) ({                                       \
 819         int _rc;                                                        \
 820                                                                         \
 821         _rc = (*(MP)->mnt_op->vfs_unmount)(MP, FORCE);                  \
 822         _rc; })
 823
 824 #define VFS_ROOT(MP, FLAGS, VPP) ({                                     \
 825         int _rc;                                                        \
 826                                                                         \
 827         _rc = (*(MP)->mnt_op->vfs_root)(MP, FLAGS, VPP);                \
 828         _rc; })
 829
 830 #define VFS_CACHEDROOT(MP, FLAGS, VPP) ({                               \
 831         int _rc;                                                        \
 832                                                                         \
 833         _rc = (*(MP)->mnt_op->vfs_cachedroot)(MP, FLAGS, VPP);          \
 834         _rc; })
 835
 836 #define VFS_QUOTACTL(MP, C, U, A) ({                                    \
 837         int _rc;                                                        \
 838                                                                         \
 839         _rc = (*(MP)->mnt_op->vfs_quotactl)(MP, C, U, A);               \
 840         _rc; })
 841
 842 #define VFS_STATFS(MP, SBP) ({                                          \
 843         int _rc;                                                        \
 844                                                                         \
 845         _rc = __vfs_statfs((MP), (SBP));                                \
 846         _rc; })
 847
 848 #define VFS_SYNC(MP, WAIT) ({                                           \
 849         int _rc;                                                        \
 850                                                                         \
 851         _rc = (*(MP)->mnt_op->vfs_sync)(MP, WAIT);                      \
 852         _rc; })
 853
 854 #define VFS_VGET(MP, INO, FLAGS, VPP) ({                                \
 855         int _rc;                                                        \
 856                                                                         \
 857         _rc = (*(MP)->mnt_op->vfs_vget)(MP, INO, FLAGS, VPP);           \
 858         _rc; })
 859
 860 #define VFS_FHTOVP(MP, FIDP, FLAGS, VPP) ({                             \
 861         int _rc;                                                        \
 862                                                                         \
 863         _rc = (*(MP)->mnt_op->vfs_fhtovp)(MP, FIDP, FLAGS, VPP);        \
 864         _rc; })
 865
 866 #define VFS_CHECKEXP(MP, NAM, EXFLG, CRED, NUMSEC, SEC) ({              \
 867         int _rc;                                                        \
 868                                                                         \
 869         _rc = (*(MP)->mnt_op->vfs_checkexp)(MP, NAM, EXFLG, CRED, NUMSEC,\
 870             SEC);                                                       \
 871         _rc; })
 872
 873 #define VFS_EXTATTRCTL(MP, C, FN, NS, N) ({                             \
 874         int _rc;                                                        \
 875                                                                         \
 876         _rc = (*(MP)->mnt_op->vfs_extattrctl)(MP, C, FN, NS, N);        \
 877         _rc; })
 878
 879 #define VFS_SYSCTL(MP, OP, REQ) ({                                      \
 880         int _rc;                                                        \
 881                                                                         \
 882         _rc = (*(MP)->mnt_op->vfs_sysctl)(MP, OP, REQ);                 \
 883         _rc; })
 884
 885 #define VFS_SUSP_CLEAN(MP) do {                                         \
 886         if (*(MP)->mnt_op->vfs_susp_clean != NULL) {                    \
 887                 (*(MP)->mnt_op->vfs_susp_clean)(MP);                    \
 888         }                                                               \
 889 } while (0)
 890
 891 #define VFS_RECLAIM_LOWERVP(MP, VP) do {                                \
 892         if (*(MP)->mnt_op->vfs_reclaim_lowervp != NULL) {               \
 893                 (*(MP)->mnt_op->vfs_reclaim_lowervp)((MP), (VP));       \
 894         }                                                               \
 895 } while (0)
 896
 897 #define VFS_UNLINK_LOWERVP(MP, VP) do {                                 \
 898         if (*(MP)->mnt_op->vfs_unlink_lowervp != NULL) {                \
 899                 (*(MP)->mnt_op->vfs_unlink_lowervp)((MP), (VP));        \
 900         }                                                               \
 901 } while (0)
 902
 903 #define VFS_PURGE(MP) do {                                              \
 904         if (*(MP)->mnt_op->vfs_purge != NULL) {                         \
 905                 (*(MP)->mnt_op->vfs_purge)(MP);                         \
 906         }                                                               \
 907 } while (0)
 908
 909 #define VFS_KNOTE_LOCKED(vp, hint) do                                   \
 910 {                                                                       \
 911         if (((vp)->v_vflag & VV_NOKNOTE) == 0)                          \
 912                 VN_KNOTE((vp), (hint), KNF_LISTLOCKED);                 \
 913 } while (0)
 914
 915 #define VFS_KNOTE_UNLOCKED(vp, hint) do                                 \
 916 {                                                                       \
 917         if (((vp)->v_vflag & VV_NOKNOTE) == 0)                          \
 918                 VN_KNOTE((vp), (hint), 0);                              \
 919 } while (0)
 920
 921 #define VFS_NOTIFY_UPPER_RECLAIM        1
 922 #define VFS_NOTIFY_UPPER_UNLINK         2
 923
 924 #include <sys/module.h>
 925
 926 /*
 927  * Version numbers.
 928  */
 929 #define VFS_VERSION_00  0x19660120
 930 #define VFS_VERSION_01  0x20121030
 931 #define VFS_VERSION_02  0x20180504
 932 #define VFS_VERSION     VFS_VERSION_02
 933
 934 #define VFS_SET(vfsops, fsname, flags) \
 935         static struct vfsconf fsname ## _vfsconf = {            \
 936                 .vfc_version = VFS_VERSION,                     \
 937                 .vfc_name = #fsname,                            \
 938                 .vfc_vfsops = &vfsops,                          \
 939                 .vfc_typenum = -1,                              \
 940                 .vfc_flags = flags,                             \
 941         };                                                      \
 942         static moduledata_t fsname ## _mod = {                  \
 943                 #fsname,                                        \
 944                 vfs_modevent,                                   \
 945                 & fsname ## _vfsconf                            \
 946         };                                                      \
 947         DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
 948
 949 /*
 950  * exported vnode operations
 951  */
 952
 953 int     dounmount(struct mount *, int, struct thread *);
 954
 955 int     kernel_mount(struct mntarg *ma, uint64_t flags);
 956 int     kernel_vmount(int flags, ...);
 957 struct mntarg *mount_arg(struct mntarg *ma, const char *name, const void *val, int len);
 958 struct mntarg *mount_argb(struct mntarg *ma, int flag, const char *name);
 959 struct mntarg *mount_argf(struct mntarg *ma, const char *name, const char *fmt, ...);
 960 struct mntarg *mount_argsu(struct mntarg *ma, const char *name, const void *val, int len);
 961 void    statfs_scale_blocks(struct statfs *sf, long max_size);
 962 struct vfsconf *vfs_byname(const char *);
 963 struct vfsconf *vfs_byname_kld(const char *, struct thread *td, int *);
 964 void    vfs_mount_destroy(struct mount *);
 965 void    vfs_event_signal(fsid_t *, u_int32_t, intptr_t);
 966 void    vfs_freeopts(struct vfsoptlist *opts);
 967 void    vfs_deleteopt(struct vfsoptlist *opts, const char *name);
 968 int     vfs_buildopts(struct uio *auio, struct vfsoptlist **options);
 969 int     vfs_flagopt(struct vfsoptlist *opts, const char *name, uint64_t *w,
 970             uint64_t val);
 971 int     vfs_getopt(struct vfsoptlist *, const char *, void **, int *);
 972 int     vfs_getopt_pos(struct vfsoptlist *opts, const char *name);
 973 int     vfs_getopt_size(struct vfsoptlist *opts, const char *name,
 974             off_t *value);
 975 char    *vfs_getopts(struct vfsoptlist *, const char *, int *error);
 976 int     vfs_copyopt(struct vfsoptlist *, const char *, void *, int);
 977 int     vfs_filteropt(struct vfsoptlist *, const char **legal);
 978 void    vfs_opterror(struct vfsoptlist *opts, const char *fmt, ...);
 979 int     vfs_scanopt(struct vfsoptlist *opts, const char *name, const char *fmt, ...);
 980 int     vfs_setopt(struct vfsoptlist *opts, const char *name, void *value,
 981             int len);
 982 int     vfs_setopt_part(struct vfsoptlist *opts, const char *name, void *value,
 983             int len);
 984 int     vfs_setopts(struct vfsoptlist *opts, const char *name,
 985             const char *value);
 986 int     vfs_setpublicfs                     /* set publicly exported fs */
 987             (struct mount *, struct netexport *, struct export_args *);
 988 void    vfs_periodic(struct mount *, int);
 989 int     vfs_busy(struct mount *, int);
 990 int     vfs_export                       /* process mount export info */
 991             (struct mount *, struct export_args *);
 992 void    vfs_allocate_syncvnode(struct mount *);
 993 void    vfs_deallocate_syncvnode(struct mount *);
 994 int     vfs_donmount(struct thread *td, uint64_t fsflags,
 995             struct uio *fsoptions);
 996 void    vfs_getnewfsid(struct mount *);
 997 struct cdev *vfs_getrootfsid(struct mount *);
 998 struct  mount *vfs_getvfs(fsid_t *);      /* return vfs given fsid */
 999 struct  mount *vfs_busyfs(fsid_t *);
1000 int     vfs_modevent(module_t, int, void *);
1001 void    vfs_mount_error(struct mount *, const char *, ...);
1002 void    vfs_mountroot(void);                    /* mount our root filesystem */
1003 void    vfs_mountedfrom(struct mount *, const char *from);
1004 void    vfs_notify_upper(struct vnode *, int);
1005 struct mount *vfs_ref_from_vp(struct vnode *);
1006 void    vfs_ref(struct mount *);
1007 void    vfs_rel(struct mount *);
1008 struct mount *vfs_mount_alloc(struct vnode *, struct vfsconf *, const char *,
1009             struct ucred *);
1010 int     vfs_suser(struct mount *, struct thread *);
1011 void    vfs_unbusy(struct mount *);
1012 void    vfs_unmountall(void);
1013 extern  TAILQ_HEAD(mntlist, mount) mountlist;   /* mounted filesystem list */
1014 extern  struct mtx_padalign mountlist_mtx;
1015 extern  struct nfs_public nfs_pub;
1016 extern  struct sx vfsconf_sx;
1017 #define vfsconf_lock()          sx_xlock(&vfsconf_sx)
1018 #define vfsconf_unlock()        sx_xunlock(&vfsconf_sx)
1019 #define vfsconf_slock()         sx_slock(&vfsconf_sx)
1020 #define vfsconf_sunlock()       sx_sunlock(&vfsconf_sx)
1021 struct vnode *mntfs_allocvp(struct mount *, struct vnode *);
1022 void   mntfs_freevp(struct vnode *);
1023
1024 /*
1025  * Declarations for these vfs default operations are located in
1026  * kern/vfs_default.c.  They will be automatically used to replace
1027  * null entries in VFS ops tables when registering a new filesystem
1028  * type in the global table.
1029  */
1030 vfs_root_t              vfs_stdroot;
1031 vfs_quotactl_t          vfs_stdquotactl;
1032 vfs_statfs_t            vfs_stdstatfs;
1033 vfs_sync_t              vfs_stdsync;
1034 vfs_sync_t              vfs_stdnosync;
1035 vfs_vget_t              vfs_stdvget;
1036 vfs_fhtovp_t            vfs_stdfhtovp;
1037 vfs_checkexp_t          vfs_stdcheckexp;
1038 vfs_init_t              vfs_stdinit;
1039 vfs_uninit_t            vfs_stduninit;
1040 vfs_extattrctl_t        vfs_stdextattrctl;
1041 vfs_sysctl_t            vfs_stdsysctl;
1042
1043 void    syncer_suspend(void);
1044 void    syncer_resume(void);
1045
1046 struct vnode *vfs_cache_root_clear(struct mount *);
1047 void    vfs_cache_root_set(struct mount *, struct vnode *);
1048
1049 void    vfs_op_barrier_wait(struct mount *);
1050 void    vfs_op_enter(struct mount *);
1051 void    vfs_op_exit_locked(struct mount *);
1052 void    vfs_op_exit(struct mount *);
1053
1054 #ifdef DIAGNOSTIC
1055 void    vfs_assert_mount_counters(struct mount *);
1056 void    vfs_dump_mount_counters(struct mount *);
1057 #else
1058 #define vfs_assert_mount_counters(mp) do { } while (0)
1059 #define vfs_dump_mount_counters(mp) do { } while (0)
1060 #endif
1061
1062 enum mount_counter { MNT_COUNT_REF, MNT_COUNT_LOCKREF, MNT_COUNT_WRITEOPCOUNT };
1063 int     vfs_mount_fetch_counter(struct mount *, enum mount_counter);
1064
1065 void suspend_all_fs(void);
1066 void resume_all_fs(void);
1067
1068 /*
1069  * Code transitioning mnt_vfs_ops to > 0 issues IPIs until it observes
1070  * all CPUs not executing code enclosed by thread_in_ops_pcpu variable.
1071  *
1072  * This provides an invariant that by the time the last CPU is observed not
1073  * executing, everyone else entering will see the counter > 0 and exit.
1074  *
1075  * Note there is no barrier between vfs_ops and the rest of the code in the
1076  * section. It is not necessary as the writer has to wait for everyone to drain
1077  * before making any changes or only make changes safe while the section is
1078  * executed.
1079  */
1080 #define vfs_mount_pcpu(mp)              zpcpu_get(mp->mnt_pcpu)
1081 #define vfs_mount_pcpu_remote(mp, cpu)  zpcpu_get_cpu(mp->mnt_pcpu, cpu)
1082
1083 #define vfs_op_thread_entered(mp) ({                            \
1084         MPASS(curthread->td_critnest > 0);                      \
1085         struct mount_pcpu *_mpcpu = vfs_mount_pcpu(mp);         \
1086         _mpcpu->mntp_thread_in_ops == 1;                        \
1087 })
1088
1089 #define vfs_op_thread_enter_crit(mp, _mpcpu) ({                 \
1090         bool _retval_crit = true;                               \
1091         MPASS(curthread->td_critnest > 0);                      \
1092         _mpcpu = vfs_mount_pcpu(mp);                            \
1093         MPASS(mpcpu->mntp_thread_in_ops == 0);                  \
1094         _mpcpu->mntp_thread_in_ops = 1;                         \
1095         atomic_interrupt_fence();                                       \
1096         if (__predict_false(mp->mnt_vfs_ops > 0)) {             \
1097                 vfs_op_thread_exit_crit(mp, _mpcpu);            \
1098                 _retval_crit = false;                           \
1099         }                                                       \
1100         _retval_crit;                                           \
1101 })
1102
1103 #define vfs_op_thread_enter(mp, _mpcpu) ({                      \
1104         bool _retval;                                           \
1105         critical_enter();                                       \
1106         _retval = vfs_op_thread_enter_crit(mp, _mpcpu);         \
1107         if (__predict_false(!_retval))                          \
1108                 critical_exit();                                \
1109         _retval;                                                \
1110 })
1111
1112 #define vfs_op_thread_exit_crit(mp, _mpcpu) do {                \
1113         MPASS(_mpcpu == vfs_mount_pcpu(mp));                    \
1114         MPASS(_mpcpu->mntp_thread_in_ops == 1);                 \
1115         atomic_interrupt_fence();                                       \
1116         _mpcpu->mntp_thread_in_ops = 0;                         \
1117 } while (0)
1118
1119 #define vfs_op_thread_exit(mp, _mpcpu) do {                     \
1120         vfs_op_thread_exit_crit(mp, _mpcpu);                    \
1121         critical_exit();                                        \
1122 } while (0)
1123
1124 #define vfs_mp_count_add_pcpu(_mpcpu, count, val) do {          \
1125         MPASS(_mpcpu->mntp_thread_in_ops == 1);                 \
1126         _mpcpu->mntp_##count += val;                            \
1127 } while (0)
1128
1129 #define vfs_mp_count_sub_pcpu(_mpcpu, count, val) do {          \
1130         MPASS(_mpcpu->mntp_thread_in_ops == 1);                 \
1131         _mpcpu->mntp_##count -= val;                            \
1132 } while (0)
1133
1134 #else /* !_KERNEL */
1135
1136 #include <sys/cdefs.h>
1137
1138 struct stat;
1139
1140 __BEGIN_DECLS
1141 int     fhlink(struct fhandle *, const char *);
1142 int     fhlinkat(struct fhandle *, int, const char *);
1143 int     fhopen(const struct fhandle *, int);
1144 int     fhreadlink(struct fhandle *, char *, size_t);
1145 int     fhstat(const struct fhandle *, struct stat *);
1146 int     fhstatfs(const struct fhandle *, struct statfs *);
1147 int     fstatfs(int, struct statfs *);
1148 int     getfh(const char *, fhandle_t *);
1149 int     getfhat(int, char *, struct fhandle *, int);
1150 int     getfsstat(struct statfs *, long, int);
1151 int     getmntinfo(struct statfs **, int);
1152 int     lgetfh(const char *, fhandle_t *);
1153 int     mount(const char *, const char *, int, void *);
1154 int     nmount(struct iovec *, unsigned int, int);
1155 int     statfs(const char *, struct statfs *);
1156 int     unmount(const char *, int);
1157
1158 /* C library stuff */
1159 int     getvfsbyname(const char *, struct xvfsconf *);
1160 __END_DECLS
1161
1162 #endif /* _KERNEL */
1163
1164 #endif /* !_SYS_MOUNT_H_ */