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