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

Cache object: a6df00854ffc36672f06df93acd2dd8e


[ 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.