The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/mount.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: dcf78fea32ad0bdd7dd5d0979b6d71ef


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.