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