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