sys/sys/mount.h

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