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  * 3. 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: src/sys/sys/mount.h,v 1.89.2.7 2003/04/04 20:35:57 tegge Exp $
  31  */
  32
  33 #ifndef _SYS_MOUNT_H_
  34 #define _SYS_MOUNT_H_
  35
  36 #include <sys/queue.h>
  37 #include <sys/tree.h>
  38 #include <sys/ucred.h>
  39
  40 #ifndef _KERNEL
  41 #if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)
  42 #include <sys/stat.h>
  43 #endif /* !_POSIX_C_SOURCE */
  44 #endif /* !_KERNEL */
  45
  46 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  47 #ifndef _SYS_LOCK_H_
  48 #include <sys/lock.h>
  49 #endif
  50 #ifndef _SYS_NAMECACHE_H_
  51 #include <sys/namecache.h>
  52 #endif
  53 #ifndef _SYS_STATVFS_H_
  54 #include <sys/statvfs.h>
  55 #endif
  56 #ifndef _SYS_THREAD_H_
  57 #include <sys/thread.h>
  58 #endif
  59 #include <sys/vfs_quota.h>
  60 #endif
  61
  62 struct thread;
  63 struct journal;
  64 struct vop_ops;
  65 struct vop_mountctl_args;
  66 struct statvfs;
  67 struct vmntvnodescan_info;
  68
  69 typedef struct fsid { int32_t val[2]; } fsid_t; /* file system id type */
  70
  71 /*
  72  * File identifier.  These are unique per filesystem on a single machine.
  73  *
  74  * fix_ext is also used by HAMMER.
  75  */
  76 #define MAXFIDSZ        16
  77
  78 struct fid {
  79         u_short         fid_len;                /* length of data in bytes */
  80         u_short         fid_ext;                /* extended data           */
  81         char            fid_data[MAXFIDSZ];     /* data (variable length) */
  82 };
  83
  84 /*
  85  * file system statistics
  86  */
  87
  88 #define MFSNAMELEN      16      /* length of fs type name, including null */
  89 #define MNAMELEN        80      /* length of buffer for returned name */
  90
  91 struct statfs {
  92         long    f_spare2;               /* placeholder */
  93         long    f_bsize;                /* fundamental file system block size */
  94         long    f_iosize;               /* optimal transfer block size */
  95         long    f_blocks;               /* total data blocks in file system */
  96         long    f_bfree;                /* free blocks in fs */
  97         long    f_bavail;               /* free blocks avail to non-superuser */
  98         long    f_files;                /* total file nodes in file system */
  99         long    f_ffree;                /* free file nodes in fs */
 100         fsid_t  f_fsid;                 /* file system id */
 101         uid_t   f_owner;                /* user that mounted the filesystem */
 102         int     f_type;                 /* type of filesystem */
 103         int     f_flags;                /* copy of mount exported flags */
 104         long    f_syncwrites;           /* count of sync writes since mount */
 105         long    f_asyncwrites;          /* count of async writes since mount */
 106         char    f_fstypename[MFSNAMELEN]; /* fs type name */
 107         char    f_mntonname[MNAMELEN];  /* directory on which mounted */
 108         long    f_syncreads;            /* count of sync reads since mount */
 109         long    f_asyncreads;           /* count of async reads since mount */
 110         short   f_spares1;              /* unused spare */
 111         char    f_mntfromname[MNAMELEN];/* mounted filesystem */
 112         short   f_spares2;              /* unused spare */
 113         long    f_spare[2];             /* unused spare */
 114 };
 115
 116 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 117
 118 /*
 119  * bio_ops are associated with the mount structure and used in conjuction
 120  * with the b_dep field in a buffer.  Currently softupdates and HAMMER
 121  * utilize this field.
 122  *
 123  * All bio_ops callbacks must be MPSAFE and could be called without
 124  * the mplock.
 125  */
 126 struct buf;
 127
 128 struct bio_ops {
 129         TAILQ_ENTRY(bio_ops) entry;
 130         void    (*io_start) (struct buf *);
 131         void    (*io_complete) (struct buf *);
 132         void    (*io_deallocate) (struct buf *);
 133         int     (*io_fsync) (struct vnode *);
 134         int     (*io_sync) (struct mount *);
 135         void    (*io_movedeps) (struct buf *, struct buf *);
 136         int     (*io_countdeps) (struct buf *, int);
 137         int     (*io_checkread) (struct buf *);
 138         int     (*io_checkwrite) (struct buf *);
 139 };
 140
 141 #endif
 142
 143 /*
 144  * vfs quota accounting
 145  *
 146  * uids and gids often come in contiguous blocks; use a small linear
 147  * array as the basic in-memory accounting allocation unit
 148  */
 149 #define ACCT_CHUNK_BITS 5
 150 #define ACCT_CHUNK_NIDS (1<<ACCT_CHUNK_BITS)
 151 #define ACCT_CHUNK_MASK (ACCT_CHUNK_NIDS - 1)
 152
 153 struct ac_counters {
 154         uint64_t space;
 155         uint64_t limit;
 156 };
 157
 158 struct ac_unode {
 159         RB_ENTRY(ac_unode)      rb_entry;
 160         uid_t                   left_bits;
 161         struct ac_counters      uid_chunk[ACCT_CHUNK_NIDS];
 162 };
 163
 164 struct ac_gnode {
 165         RB_ENTRY(ac_gnode)      rb_entry;
 166         gid_t                   left_bits;
 167         struct ac_counters      gid_chunk[ACCT_CHUNK_NIDS];
 168 };
 169
 170 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 171
 172 struct vfs_acct {
 173         RB_HEAD(ac_utree,ac_unode)      ac_uroot;
 174         RB_HEAD(ac_gtree,ac_gnode)      ac_groot;
 175         uint64_t                        ac_bytes;       /* total bytes used */
 176         uint64_t                        ac_limit;
 177         struct spinlock                 ac_spin;        /* protective spinlock */
 178 };
 179
 180
 181 /*
 182  * Structure per mounted file system.  Each mounted file system has an
 183  * array of operations and an instance record.  The file systems are
 184  * put on a doubly linked list.
 185  *
 186  * NOTE: mnt_nvnodelist and mnt_reservedvnlist.  At the moment vnodes
 187  * are linked into mnt_nvnodelist.  At some point in the near future the
 188  * vnode list will be split into a 'dirty' and 'clean' list. mnt_nvnodelist
 189  * will become the dirty list and mnt_reservedvnlist will become the 'clean'
 190  * list.  Filesystem kld's syncing code should remain compatible since
 191  * they only need to scan the dirty vnode list (nvnodelist -> dirtyvnodelist).
 192  *
 193  * NOTE: All VFSs must at least populate mnt_vn_ops or those VOP ops that
 194  * only take namecache pointers will not be able to find their operations
 195  * vector via namecache->nc_mount.
 196  *
 197  * MPSAFE NOTES: mnt_lock interlocks mounting and unmounting operations.
 198  *
 199  *               mnt_token interlocks operations which adjust the mount
 200  *               structure and will also be held through VFS operations
 201  *               for VFSes not flagged MPSAFE.
 202  *
 203  *               The VFS should pre-set VFCF_MPSAFE in the VFS_SET() to
 204  *               avoid use of the mplock during mounting.  This will also
 205  *               cause MNTK_ALL_MPSAFE to be set in mnt_kern_flags.  If the
 206  *               VFS does not set VFCF_MPSAFE then it can set individual
 207  *               MNTK_*_MPSAFE flags in mnt_kern_flags.
 208  */
 209 TAILQ_HEAD(vnodelst, vnode);
 210 TAILQ_HEAD(journallst, journal);
 211
 212 struct mount {
 213         TAILQ_ENTRY(mount) mnt_list;            /* mount list */
 214         struct vfsops   *mnt_op;                /* operations on fs */
 215         struct vfsconf  *mnt_vfc;               /* configuration info */
 216         u_int           mnt_namecache_gen;      /* ++ to clear negative hits */
 217         u_int           mnt_pbuf_count;         /* pbuf usage limit */
 218         struct vnode    *mnt_syncer;            /* syncer vnode */
 219         struct syncer_ctx *mnt_syncer_ctx;      /* syncer process context */
 220         struct vnodelst mnt_nvnodelist;         /* list of vnodes this mount */
 221         TAILQ_HEAD(,vmntvnodescan_info) mnt_vnodescan_list;
 222         struct lock     mnt_lock;               /* mount structure lock */
 223         int             mnt_flag;               /* flags shared with user */
 224         int             mnt_kern_flag;          /* kernel only flags */
 225         int             mnt_maxsymlinklen;      /* max size of short symlink */
 226         struct statfs   mnt_stat;               /* cache of filesystem stats */
 227         struct statvfs  mnt_vstat;              /* extended stats */
 228         qaddr_t         mnt_data;               /* private data */
 229         time_t          mnt_time;               /* last time written*/
 230         u_int           mnt_iosize_max;         /* max IO request size */
 231         struct vnodelst mnt_reservedvnlist;     /* (future) dirty vnode list */
 232         int             mnt_nvnodelistsize;     /* # of vnodes on this mount */
 233
 234         /*
 235          * ops vectors have a fixed stacking order.  All primary calls run
 236          * through mnt_vn_ops.  This field is typically assigned to
 237          * mnt_vn_norm_ops.  If journaling has been enabled this field is
 238          * usually assigned to mnt_vn_journal_ops.
 239          */
 240         struct vop_ops  *mnt_vn_use_ops;        /* current ops set */
 241
 242         struct vop_ops  *mnt_vn_coherency_ops;  /* cache coherency ops */
 243         struct vop_ops  *mnt_vn_journal_ops;    /* journaling ops */
 244         struct vop_ops  *mnt_vn_norm_ops;       /* for use by the VFS */
 245         struct vop_ops  *mnt_vn_spec_ops;       /* for use by the VFS */
 246         struct vop_ops  *mnt_vn_fifo_ops;       /* for use by the VFS */
 247         struct nchandle mnt_ncmountpt;          /* mount point */
 248         struct nchandle mnt_ncmounton;          /* mounted on */
 249         char            mnt_pad[24];            /* (try to cache-align refs) */
 250         int             mnt_refs;               /* nchandle references */
 251         int             mnt_hold;               /* prevent kfree */
 252         struct lwkt_token mnt_token;            /* token lock if not MPSAFE */
 253         struct journallst mnt_jlist;            /* list of active journals */
 254         u_int8_t        *mnt_jbitmap;           /* streamid bitmap */
 255         int16_t         mnt_streamid;           /* last streamid */
 256
 257         struct bio_ops  *mnt_bioops;            /* BIO ops (hammer, softupd) */
 258
 259         struct vfs_acct mnt_acct;               /* vfs space accounting */
 260 };
 261
 262 #endif /* _KERNEL || _KERNEL_STRUCTURES */
 263
 264 /*
 265  * User specifiable flags.
 266  */
 267 #define MNT_RDONLY      0x00000001      /* read only filesystem */
 268 #define MNT_SYNCHRONOUS 0x00000002      /* file system written synchronously */
 269 #define MNT_NOEXEC      0x00000004      /* can't exec from filesystem */
 270 #define MNT_NOSUID      0x00000008      /* don't honor setuid bits on fs */
 271 #define MNT_NODEV       0x00000010      /* don't interpret special files */
 272 #define MNT_AUTOMOUNTED 0x00000020      /* mounted by automountd(8) */
 273 #define MNT_ASYNC       0x00000040      /* file system written asynchronously */
 274 #define MNT_SUIDDIR     0x00100000      /* special handling of SUID on dirs */
 275 #define MNT_SOFTDEP     0x00200000      /* soft updates being done */
 276 #define MNT_NOSYMFOLLOW 0x00400000      /* do not follow symlinks */
 277 #define MNT_TRIM        0x01000000      /* Enable online FS trimming */
 278 #define MNT_NOATIME     0x10000000      /* disable update of file access time */
 279 #define MNT_NOCLUSTERR  0x40000000      /* disable cluster read */
 280 #define MNT_NOCLUSTERW  0x80000000      /* disable cluster write */
 281
 282 /*
 283  * NFS export related mount flags.
 284  */
 285 #define MNT_EXRDONLY    0x00000080      /* exported read only */
 286 #define MNT_EXPORTED    0x00000100      /* file system is exported */
 287 #define MNT_DEFEXPORTED 0x00000200      /* exported to the world */
 288 #define MNT_EXPORTANON  0x00000400      /* use anon uid mapping for everyone */
 289 #define MNT_EXKERB      0x00000800      /* exported with Kerberos uid mapping */
 290 #define MNT_EXPUBLIC    0x20000000      /* public export (WebNFS) */
 291
 292 /*
 293  * Flags set by internal operations,
 294  * but visible to the user.
 295  * XXX some of these are not quite right.. (I've never seen the root flag set)
 296  */
 297 #define MNT_LOCAL       0x00001000      /* filesystem is stored locally */
 298 #define MNT_QUOTA       0x00002000      /* quotas are enabled on filesystem */
 299 #define MNT_ROOTFS      0x00004000      /* identifies the root filesystem */
 300 #define MNT_USER        0x00008000      /* mounted by a user */
 301 #define MNT_IGNORE      0x00800000      /* do not show entry in df */
 302
 303 /*
 304  * Mask of flags that are visible to statfs()
 305  * XXX I think that this could now become (~(MNT_CMDFLAGS))
 306  * but the 'mount' program may need changing to handle this.
 307  */
 308 #define MNT_VISFLAGMASK (MNT_RDONLY     | MNT_SYNCHRONOUS | MNT_NOEXEC  | \
 309                         MNT_NOSUID      | MNT_NODEV                     | \
 310                         MNT_ASYNC       | MNT_EXRDONLY  | MNT_EXPORTED  | \
 311                         MNT_DEFEXPORTED | MNT_EXPORTANON| MNT_EXKERB    | \
 312                         MNT_LOCAL       | MNT_USER      | MNT_QUOTA     | \
 313                         MNT_ROOTFS      | MNT_NOATIME   | MNT_NOCLUSTERR| \
 314                         MNT_NOCLUSTERW  | MNT_SUIDDIR   | MNT_SOFTDEP   | \
 315                         MNT_IGNORE      | MNT_NOSYMFOLLOW | MNT_EXPUBLIC| \
 316                         MNT_TRIM        | MNT_AUTOMOUNTED)
 317 /*
 318  * External filesystem command modifier flags.
 319  * Unmount can use the MNT_FORCE flag.
 320  * XXX These are not STATES and really should be somewhere else.
 321  */
 322 #define MNT_UPDATE      0x00010000      /* not a real mount, just an update */
 323 #define MNT_DELEXPORT   0x00020000      /* delete export host lists */
 324 #define MNT_RELOAD      0x00040000      /* reload filesystem data */
 325 #define MNT_FORCE       0x00080000      /* force unmount or readonly change */
 326 #define MNT_CMDFLAGS    (MNT_UPDATE|MNT_DELEXPORT|MNT_RELOAD|MNT_FORCE)
 327 /*
 328  * Internal filesystem control flags stored in mnt_kern_flag.
 329  *
 330  * MNTK_UNMOUNT locks the mount entry so that name lookup cannot proceed
 331  * past the mount point.  This keeps the subtree stable during mounts
 332  * and unmounts.
 333  *
 334  * MNTK_UNMOUNTF permits filesystems to detect a forced unmount while
 335  * dounmount() is still waiting to lock the mountpoint. This allows
 336  * the filesystem to cancel operations that might otherwise deadlock
 337  * with the unmount attempt (used by NFS).
 338  *
 339  * MNTK_NOSTKMNT prevents mounting another filesystem inside the flagged one.
 340  */
 341 #define MNTK_UNMOUNTF   0x00000001      /* forced unmount in progress */
 342 #define MNTK_MPSAFE     0x00010000      /* call vops without mnt_token lock */
 343 #define MNTK_RD_MPSAFE  0x00020000      /* vop_read is MPSAFE */
 344 #define MNTK_WR_MPSAFE  0x00040000      /* vop_write is MPSAFE */
 345 #define MNTK_GA_MPSAFE  0x00080000      /* vop_getattr is MPSAFE */
 346 #define MNTK_IN_MPSAFE  0x00100000      /* vop_inactive is MPSAFE */
 347 #define MNTK_SG_MPSAFE  0x00200000      /* vop_strategy is MPSAFE */
 348 #define MNTK_NCALIASED  0x00800000      /* namecached aliased */
 349 #define MNTK_UNMOUNT    0x01000000      /* unmount in progress */
 350 #define MNTK_MWAIT      0x02000000      /* waiting for unmount to finish */
 351 #define MNTK_WANTRDWR   0x04000000      /* upgrade to read/write requested */
 352 #define MNTK_FSMID      0x08000000      /* getattr supports FSMIDs */
 353 #define MNTK_NOSTKMNT   0x10000000      /* no stacked mount point allowed */
 354 #define MNTK_NOMSYNC    0x20000000      /* used by tmpfs */
 355 #define MNTK_THR_SYNC   0x40000000      /* fs sync thread requested */
 356 #define MNTK_ST_MPSAFE  0x80000000      /* (mfs) vfs_start is MPSAFE */
 357
 358 #define MNTK_ALL_MPSAFE (MNTK_MPSAFE | MNTK_RD_MPSAFE | MNTK_WR_MPSAFE | \
 359                          MNTK_GA_MPSAFE | MNTK_IN_MPSAFE | MNTK_SG_MPSAFE | \
 360                          MNTK_ST_MPSAFE)
 361
 362 /*
 363  * mountlist_*() defines
 364  */
 365 #define MNTSCAN_FORWARD         0x0001
 366 #define MNTSCAN_REVERSE         0x0002
 367 #define MNTSCAN_NOBUSY          0x0004
 368
 369 #define MNTINS_FIRST            0x0001
 370 #define MNTINS_LAST             0x0002
 371
 372 /*
 373  * Sysctl CTL_VFS definitions.
 374  *
 375  * Second level identifier specifies which filesystem. Second level
 376  * identifier VFS_VFSCONF returns information about all filesystems.
 377  * Second level identifier VFS_GENERIC is non-terminal.
 378  */
 379 #define VFS_VFSCONF             0       /* get configured filesystems */
 380 #define VFS_GENERIC             0       /* generic filesystem information */
 381 /*
 382  * Third level identifiers for VFS_GENERIC are given below; third
 383  * level identifiers for specific filesystems are given in their
 384  * mount specific header files.
 385  */
 386 #define VFS_MAXTYPENUM  1       /* int: highest defined filesystem type */
 387 #define VFS_CONF        2       /* struct: vfsconf for filesystem given
 388                                    as next argument */
 389
 390 /*
 391  * VFS MPLOCK helper.
 392  */
 393 #define VFS_MPLOCK_DECLARE      int xlock_mpsafe
 394
 395 #define VFS_MPLOCK(mp)          VFS_MPLOCK_FLAG(mp, MNTK_MPSAFE)
 396
 397 #define VFS_MPLOCK_FLAG(mp, flag)                                       \
 398                 do {                                                    \
 399                         if (mp->mnt_kern_flag & flag) {                 \
 400                                 xlock_mpsafe = 1;                       \
 401                         } else {                                        \
 402                                 get_mplock();   /* TEMPORARY */         \
 403                                 lwkt_gettoken(&mp->mnt_token);          \
 404                                 xlock_mpsafe = 0;                       \
 405                         }                                               \
 406                 } while(0)
 407
 408 #define VFS_MPUNLOCK(mp)                                                \
 409                 do {                                                    \
 410                         if (xlock_mpsafe == 0) {                        \
 411                                 lwkt_reltoken(&mp->mnt_token);          \
 412                                 rel_mplock();   /* TEMPORARY */         \
 413                         }                                               \
 414                 } while(0)
 415
 416 /*
 417  * Flags for various system call interfaces.
 418  *
 419  * waitfor flags to vfs_sync() and getfsstat()
 420  */
 421 #define MNT_WAIT        0x0001  /* synchronously wait for I/O to complete */
 422 #define MNT_NOWAIT      0x0002  /* start all I/O, but do not wait for it */
 423 #define MNT_LAZY        0x0004  /* be lazy and do not necessarily push it all */
 424
 425 #define VOP_FSYNC_SYSCALL       0x0001  /* from system call */
 426
 427 /*
 428  * Generic file handle
 429  */
 430 struct fhandle {
 431         fsid_t  fh_fsid;        /* File system id of mount point */
 432         struct  fid fh_fid;     /* File sys specific id */
 433 };
 434 typedef struct fhandle  fhandle_t;
 435
 436 /*
 437  * Export arguments for local filesystem mount calls.
 438  */
 439 struct export_args {
 440         int     ex_flags;               /* export related flags */
 441         uid_t   ex_root;                /* mapping for root uid */
 442         struct  ucred ex_anon;          /* mapping for anonymous user */
 443         struct  sockaddr *ex_addr;      /* net address to which exported */
 444         int     ex_addrlen;             /* and the net address length */
 445         struct  sockaddr *ex_mask;      /* mask of valid bits in saddr */
 446         int     ex_masklen;             /* and the smask length */
 447         char    *ex_indexfile;          /* index file for WebNFS URLs */
 448 };
 449
 450 /*
 451  * Structure holding information for a publicly exported filesystem
 452  * (WebNFS). Currently the specs allow just for one such filesystem.
 453  */
 454 struct nfs_public {
 455         int             np_valid;       /* Do we hold valid information */
 456         fhandle_t       np_handle;      /* Filehandle for pub fs (internal) */
 457         struct mount    *np_mount;      /* Mountpoint of exported fs */
 458         char            *np_index;      /* Index file */
 459 };
 460
 461 /*
 462  * Filesystem configuration information. One of these exists for each
 463  * type of filesystem supported by the kernel. These are searched at
 464  * mount time to identify the requested filesystem.
 465  */
 466 struct vfsconf {
 467         struct  vfsops *vfc_vfsops;     /* filesystem operations vector */
 468         char    vfc_name[MFSNAMELEN];   /* filesystem type name */
 469         int     vfc_typenum;            /* historic filesystem type number */
 470         int     vfc_refcount;           /* number mounted of this type */
 471         int     vfc_flags;              /* permanent flags */
 472         STAILQ_ENTRY(vfsconf) vfc_next; /* next in list */
 473 };
 474
 475 struct ovfsconf {
 476         void    *vfc_vfsops;
 477         char    vfc_name[32];
 478         int     vfc_index;
 479         int     vfc_refcount;
 480         int     vfc_flags;
 481 };
 482
 483 /*
 484  * NB: these flags refer to IMPLEMENTATION properties, not properties of
 485  * any actual mounts; i.e., it does not make sense to change the flags.
 486  */
 487 #define VFCF_STATIC     0x00010000      /* statically compiled into kernel */
 488 #define VFCF_NETWORK    0x00020000      /* may get data over the network */
 489 #define VFCF_READONLY   0x00040000      /* writes are not implemented */
 490 #define VFCF_SYNTHETIC  0x00080000      /* data does not represent real files */
 491 #define VFCF_LOOPBACK   0x00100000      /* aliases some other mounted FS */
 492 #define VFCF_UNICODE    0x00200000      /* stores file names as Unicode*/
 493 #define VFCF_MPSAFE     0x00400000      /* VFS is fully MPSAFE */
 494
 495 /* vfsquery flags */
 496 #define VQ_NOTRESP      0x0001  /* server down */
 497 #define VQ_NEEDAUTH     0x0002  /* server bad auth */
 498 #define VQ_LOWDISK      0x0004  /* we're low on space */
 499 #define VQ_MOUNT        0x0008  /* new filesystem arrived */
 500 #define VQ_UNMOUNT      0x0010  /* filesystem has left */
 501 #define VQ_DEAD         0x0020  /* filesystem is dead, needs force unmount */
 502 #define VQ_ASSIST       0x0040  /* filesystem needs assistance from external
 503                                    program */
 504 #define VQ_NOTRESPLOCK  0x0080  /* server lockd down */
 505 #define VQ_FLAG0100     0x0100  /* placeholder */
 506 #define VQ_FLAG0200     0x0200  /* placeholder */
 507 #define VQ_FLAG0400     0x0400  /* placeholder */
 508 #define VQ_FLAG0800     0x0800  /* placeholder */
 509 #define VQ_FLAG1000     0x1000  /* placeholder */
 510 #define VQ_FLAG2000     0x2000  /* placeholder */
 511 #define VQ_FLAG4000     0x4000  /* placeholder */
 512 #define VQ_FLAG8000     0x8000  /* placeholder */
 513
 514 #ifdef _KERNEL
 515
 516 #ifdef MALLOC_DECLARE
 517 MALLOC_DECLARE(M_MOUNT);
 518 #endif
 519 extern int nfs_mount_type;      /* vfc_typenum for nfs, or -1 */
 520
 521 struct vfsconf *vfsconf_find_by_name(const char *);
 522 struct vfsconf *vfsconf_find_by_typenum(int);
 523 int vfsconf_get_maxtypenum(void);
 524 int vfsconf_each(int (*)(struct vfsconf *, void *), void *);
 525
 526 #endif
 527
 528 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 529
 530 TAILQ_HEAD(mntlist, mount);     /* struct mntlist */
 531
 532 /*
 533  * Operations supported on mounted file system.
 534  */
 535 struct nlookupdata;
 536 struct nlookupdata;
 537 struct mbuf;
 538
 539 typedef int vfs_mount_t(struct mount *mp, char *path, caddr_t data,
 540                                     struct ucred *cred);
 541 typedef int vfs_start_t(struct mount *mp, int flags);
 542 typedef int vfs_unmount_t(struct mount *mp, int mntflags);
 543 typedef int vfs_root_t(struct mount *mp, struct vnode **vpp);
 544 typedef int vfs_quotactl_t(struct mount *mp, int cmds, uid_t uid, caddr_t arg,
 545                                     struct ucred *cred);
 546 typedef int vfs_statfs_t(struct mount *mp, struct statfs *sbp,
 547                                     struct ucred *cred);
 548 typedef int vfs_statvfs_t(struct mount *mp, struct statvfs *sbp,
 549                                     struct ucred *cred);
 550 typedef int vfs_sync_t(struct mount *mp, int waitfor);
 551 typedef int vfs_vget_t(struct mount *mp, struct vnode *dvp,
 552                                     ino_t ino, struct vnode **vpp);
 553 typedef int vfs_fhtovp_t(struct mount *mp, struct vnode *rootvp,
 554                                     struct fid *fhp, struct vnode **vpp);
 555 typedef int vfs_checkexp_t(struct mount *mp, struct sockaddr *nam,
 556                                     int *extflagsp, struct ucred **credanonp);
 557 typedef int vfs_vptofh_t(struct vnode *vp, struct fid *fhp);
 558 typedef int vfs_init_t(struct vfsconf *);
 559 typedef int vfs_uninit_t(struct vfsconf *);
 560 typedef int vfs_extattrctl_t(struct mount *mp, int cmd, struct vnode *vp,
 561                     int attrnamespace, const char *attrname,
 562                     struct ucred *cred);
 563 typedef int vfs_acinit_t(struct mount *mp);
 564 typedef void vfs_acdone_t(struct mount *mp);
 565 typedef void vfs_account_t(struct mount *mp,
 566                         uid_t uid, gid_t gid, int64_t delta);
 567 typedef void vfs_ncpgen_set_t(struct mount *mp, struct namecache *ncp);
 568 typedef int vfs_ncpgen_test_t(struct mount *mp, struct namecache *ncp);
 569
 570 int vfs_mount(struct mount *mp, char *path, caddr_t data, struct ucred *cred);
 571 int vfs_start(struct mount *mp, int flags);
 572 int vfs_unmount(struct mount *mp, int mntflags);
 573 int vfs_root(struct mount *mp, struct vnode **vpp);
 574 int vfs_quotactl(struct mount *mp, int cmds, uid_t uid, caddr_t arg,
 575                                 struct ucred *cred);
 576 int vfs_statfs(struct mount *mp, struct statfs *sbp, struct ucred *cred);
 577 int vfs_statvfs(struct mount *mp, struct statvfs *sbp, struct ucred *cred);
 578 int vfs_sync(struct mount *mp, int waitfor);
 579 int vfs_vget(struct mount *mp, struct vnode *dvp,
 580                                 ino_t ino, struct vnode **vpp);
 581 int vfs_fhtovp(struct mount *mp, struct vnode *rootvp,
 582                                 struct fid *fhp, struct vnode **vpp);
 583 int vfs_checkexp(struct mount *mp, struct sockaddr *nam,
 584                                 int *extflagsp, struct ucred **credanonp);
 585 int vfs_vptofh(struct vnode *vp, struct fid *fhp);
 586 int vfs_init(struct vfsconf *vfc);
 587 int vfs_uninit(struct vfsconf *vfc, struct vfsconf *vfsp);
 588 int vfs_extattrctl(struct mount *mp, int cmd, struct vnode *vp,
 589                     int attrnamespace, const char *attrname,
 590                     struct ucred *cred);
 591
 592
 593 struct vfsops {
 594         vfs_mount_t     *vfs_mount;
 595         vfs_start_t     *vfs_start;
 596         vfs_unmount_t   *vfs_unmount;
 597         vfs_root_t      *vfs_root;
 598         vfs_quotactl_t  *vfs_quotactl;
 599         vfs_statfs_t    *vfs_statfs;
 600         vfs_sync_t      *vfs_sync;
 601         vfs_vget_t      *vfs_vget;
 602         vfs_fhtovp_t    *vfs_fhtovp;
 603         vfs_checkexp_t  *vfs_checkexp;
 604         vfs_vptofh_t    *vfs_vptofh;
 605         vfs_init_t      *vfs_init;
 606         vfs_uninit_t    *vfs_uninit;
 607         vfs_extattrctl_t *vfs_extattrctl;
 608         vfs_statvfs_t   *vfs_statvfs;
 609         vfs_acinit_t    *vfs_acinit;
 610         vfs_acdone_t    *vfs_acdone;
 611         vfs_account_t   *vfs_account;
 612         vfs_ncpgen_set_t        *vfs_ncpgen_set;
 613         vfs_ncpgen_test_t       *vfs_ncpgen_test;
 614 };
 615
 616 #define VFS_MOUNT(MP, PATH, DATA, CRED)         \
 617         vfs_mount(MP, PATH, DATA, CRED)
 618 #define VFS_START(MP, FLAGS)                    \
 619         vfs_start(MP, FLAGS)
 620 #define VFS_UNMOUNT(MP, FORCE)                  \
 621         vfs_unmount(MP, FORCE)
 622 #define VFS_ROOT(MP, VPP)                       \
 623         vfs_root(MP, VPP)
 624 #define VFS_QUOTACTL(MP, C, U, A, CRED)         \
 625         vfs_quotactl(MP, C, U, A, CRED)
 626 #define VFS_STATFS(MP, SBP, CRED)               \
 627         vfs_statfs(MP, SBP, CRED)
 628 #define VFS_STATVFS(MP, SBP, CRED)              \
 629         vfs_statvfs(MP, SBP, CRED)
 630 #define VFS_SYNC(MP, WAIT)                      \
 631         vfs_sync(MP, WAIT)
 632 #define VFS_VGET(MP, DVP, INO, VPP)             \
 633         vfs_vget(MP, DVP, INO, VPP)
 634 #define VFS_FHTOVP(MP, ROOTVP, FIDP, VPP)       \
 635         vfs_fhtovp(MP, ROOTVP, FIDP, VPP)
 636 #define VFS_VPTOFH(VP, FIDP)                    \
 637         vfs_vptofh(VP, FIDP)
 638 #define VFS_CHECKEXP(MP, NAM, EXFLG, CRED)      \
 639         vfs_checkexp(MP, NAM, EXFLG, CRED)
 640 #define VFS_EXTATTRCTL(MP, C, FVP, NS, N, CRED) \
 641         vfs_extattrctl(MP, C, FVP, NS, N, CRED)
 642 #define VFS_ACCOUNT(MP, U, G, D) \
 643         if ((MP->mnt_op->vfs_account != NULL) && (D != 0)) \
 644                 MP->mnt_op->vfs_account(MP, U, G, D);
 645 #define VFS_ACINIT(MP, ERROR) \
 646         if (vfs_quota_enabled && MP->mnt_op->vfs_acinit != NULL) \
 647                 ERROR = MP->mnt_op->vfs_acinit(MP);
 648 #define VFS_ACDONE(MP) \
 649         if (vfs_quota_enabled && MP->mnt_op->vfs_acdone != NULL) \
 650                 MP->mnt_op->vfs_acdone(MP);
 651 #define VFS_NCPGEN_SET(MP, NCP) \
 652         MP->mnt_op->vfs_ncpgen_set(MP, NCP)
 653 #define VFS_NCPGEN_TEST(MP, NCP) \
 654         MP->mnt_op->vfs_ncpgen_test(MP, NCP)
 655
 656 #endif
 657
 658 #ifdef _KERNEL
 659
 660 #include <sys/module.h>
 661
 662 #define VFS_SET(vfsops, fsname, flags) \
 663         static struct vfsconf fsname ## _vfsconf = {            \
 664                 &vfsops,                                        \
 665                 #fsname,                                        \
 666                 -1,                                             \
 667                 0,                                              \
 668                 flags,                                          \
 669                 { NULL },                                       \
 670         };                                                      \
 671         static moduledata_t fsname ## _mod = {                  \
 672                 #fsname,                                        \
 673                 vfs_modevent,                                   \
 674                 & fsname ## _vfsconf                            \
 675         };                                                      \
 676         DECLARE_MODULE(fsname, fsname ## _mod, SI_SUB_VFS, SI_ORDER_MIDDLE)
 677
 678 #endif
 679
 680 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 681
 682 #include <net/radix.h>
 683
 684 #define AF_MAX          36      /* XXX */
 685
 686 /*
 687  * Network address lookup element
 688  */
 689 struct netcred {
 690         struct  radix_node netc_rnodes[2];
 691         int     netc_exflags;
 692         struct  ucred netc_anon;
 693 };
 694
 695 /*
 696  * Network export information
 697  */
 698 struct netexport {
 699         struct  netcred ne_defexported;         /* Default export */
 700         struct  radix_node_head *ne_inethead;   /* IPv4 radix */
 701         struct  radix_node_head *ne_inet6head;  /* IPv6 radix */
 702         struct  radix_node_head *ne_maskhead;   /* Shared mask radix */
 703 };
 704 #define NE_LOCK(nep)            lwkt_getpooltoken(nep)
 705 #define NE_UNLOCK(nep)          lwkt_relpooltoken(nep)
 706 #define NE_ASSERT_LOCKED(nep)   \
 707     ASSERT_LWKT_TOKEN_HELD(lwkt_token_pool_lookup(nep))
 708
 709 #endif
 710
 711 #ifdef _KERNEL
 712
 713 extern  char *mountrootfsname;
 714
 715 /*
 716  * exported vnode operations
 717  */
 718 void    mount_hold(struct mount *);
 719 void    mount_drop(struct mount *);
 720 int     dounmount (struct mount *, int);
 721 int     vfs_setpublicfs                     /* set publicly exported fs */
 722           (struct mount *, struct netexport *, const struct export_args *);
 723 int     vfs_lock (struct mount *);         /* lock a vfs */
 724 void    vfs_msync (struct mount *, int);
 725 void    vfs_unlock (struct mount *);       /* unlock a vfs */
 726 int     vfs_busy (struct mount *, int);
 727 int     vfs_export                          /* process mount export info */
 728           (struct mount *, struct netexport *, const struct export_args *);
 729 struct  netcred *vfs_export_lookup          /* lookup host in fs export list */
 730           (struct mount *, struct netexport *, struct sockaddr *);
 731 int     vfs_allocate_syncvnode (struct mount *);
 732 void    vfs_getnewfsid (struct mount *);
 733 int     vfs_setfsid(struct mount *mp, fsid_t *template);
 734 cdev_t  vfs_getrootfsid (struct mount *);
 735 struct  mount *vfs_getvfs (fsid_t *);      /* return vfs given fsid */
 736 int     vfs_modevent (module_t, int, void *);
 737 int     vfs_mountedon (struct vnode *);    /* is a vfs mounted on vp */
 738 int     vfs_rootmountalloc (char *, char *, struct mount **);
 739 void    vfs_unbusy (struct mount *);
 740 void    vfs_unmountall (void);
 741 int     vfs_register (struct vfsconf *);
 742 int     vfs_unregister (struct vfsconf *);
 743 extern  struct nfs_public nfs_pub;
 744
 745 /*
 746  * Declarations for these vfs default operations are located in
 747  * kern/vfs_default.c, they should be used instead of making "dummy"
 748  * functions or casting entries in the VFS op table to "enopnotsupp()".
 749  */
 750 vfs_start_t     vfs_stdstart;
 751 vfs_root_t      vfs_stdroot;
 752 vfs_quotactl_t  vfs_stdquotactl;
 753 vfs_statfs_t    vfs_stdstatfs;
 754 vfs_statvfs_t   vfs_stdstatvfs;
 755 vfs_sync_t      vfs_stdsync;
 756 vfs_sync_t      vfs_stdnosync;
 757 vfs_vget_t      vfs_stdvget;
 758 vfs_fhtovp_t    vfs_stdfhtovp;
 759 vfs_checkexp_t  vfs_stdcheckexp;
 760 vfs_vptofh_t    vfs_stdvptofh;
 761 vfs_init_t      vfs_stdinit;
 762 vfs_uninit_t    vfs_stduninit;
 763 vfs_extattrctl_t vfs_stdextattrctl;
 764 vfs_acinit_t    vfs_stdac_init;
 765 vfs_acdone_t    vfs_stdac_done;
 766 vfs_account_t   vfs_stdaccount;
 767 vfs_account_t   vfs_noaccount;
 768 vfs_ncpgen_set_t        vfs_stdncpgen_set;
 769 vfs_ncpgen_test_t       vfs_stdncpgen_test;
 770
 771 struct vop_access_args;
 772 int vop_helper_access(struct vop_access_args *ap, uid_t ino_uid, gid_t ino_gid,
 773                         mode_t ino_mode, u_int32_t ino_flags);
 774 int vop_helper_setattr_flags(u_int32_t *ino_flags, u_int32_t vaflags,
 775                         uid_t uid, struct ucred *cred);
 776 uid_t vop_helper_create_uid(struct mount *mp, mode_t dmode, uid_t duid,
 777                         struct ucred *cred, mode_t *modep);
 778 int vop_helper_chmod(struct vnode *vp, mode_t new_mode, struct ucred *cred,
 779                         uid_t cur_uid, gid_t cur_gid, mode_t *cur_modep);
 780 int vop_helper_chown(struct vnode *vp, uid_t new_uid, gid_t new_gid,
 781                         struct ucred *cred,
 782                         uid_t *cur_uidp, gid_t *cur_gidp, mode_t *cur_modep);
 783 int vop_helper_read_shortcut(struct vop_read_args *ap);
 784
 785 void    add_bio_ops(struct bio_ops *ops);
 786 void    rem_bio_ops(struct bio_ops *ops);
 787
 788 int     journal_mountctl(struct vop_mountctl_args *ap);
 789 void    journal_remove_all_journals(struct mount *mp, int flags);
 790
 791 void    mountlist_insert(struct mount *, int);
 792 int     mountlist_interlock(int (*callback)(struct mount *), struct mount *);
 793 struct mount *mountlist_boot_getfirst(void);
 794 void    mountlist_remove(struct mount *mp);
 795 int     mountlist_exists(struct mount *mp);
 796 int     mountlist_scan(int (*callback)(struct mount *, void *), void *, int);
 797 struct mount *mount_get_by_nc(struct namecache *ncp);
 798 #else /* !_KERNEL */
 799
 800 #include <sys/cdefs.h>
 801
 802 __BEGIN_DECLS
 803 int     fstatfs (int, struct statfs *);
 804 int     getfh (const char *, fhandle_t *);
 805 int     getfsstat (struct statfs *, long, int);
 806 int     getmntinfo (struct statfs **, int);
 807 int     getmntvinfo (struct statfs **, struct statvfs **, int);
 808 int     mount (const char *, const char *, int, void *);
 809 int     statfs (const char *, struct statfs *);
 810 int     unmount (const char *, int);
 811 int     fhopen (const struct fhandle *, int);
 812 int     fhstat (const struct fhandle *, struct stat *);
 813 int     fhstatfs (const struct fhandle *, struct statfs *);
 814
 815 /* C library stuff */
 816 void    endvfsent (void);
 817 struct  ovfsconf *getvfsbyname (const char *);
 818 struct  ovfsconf *getvfsbytype (int);
 819 struct  ovfsconf *getvfsent (void);
 820 #define getvfsbyname    new_getvfsbyname
 821 int     new_getvfsbyname (const char *, struct vfsconf *);
 822 void    setvfsent (int);
 823 int     vfsisloadable (const char *);
 824 int     vfsload (const char *);
 825 __END_DECLS
 826
 827 #endif /* _KERNEL */
 828
 829 #endif /* !_SYS_MOUNT_H_ */
 830