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