sys/ufs/ufs/ufsmount.h

   1 /*-
   2  * Copyright (c) 1982, 1986, 1989, 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  *      @(#)ufsmount.h  8.6 (Berkeley) 3/30/95
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _UFS_UFS_UFSMOUNT_H_
  34 #define _UFS_UFS_UFSMOUNT_H_
  35
  36 #include <sys/buf.h>    /* XXX For struct workhead. */
  37
  38 /*
  39  * Arguments to mount UFS-based filesystems
  40  */
  41 struct ufs_args {
  42         char    *fspec;                 /* block special device to mount */
  43         struct  oexport_args export;    /* network export information */
  44 };
  45
  46 #ifdef _KERNEL
  47
  48 #ifdef MALLOC_DECLARE
  49 MALLOC_DECLARE(M_UFSMNT);
  50 #endif
  51
  52 struct buf;
  53 struct inode;
  54 struct nameidata;
  55 struct taskqueue;
  56 struct timeval;
  57 struct ucred;
  58 struct uio;
  59 struct vnode;
  60 struct ufs_extattr_per_mount;
  61 struct jblocks;
  62 struct inodedep;
  63
  64 TAILQ_HEAD(inodedeplst, inodedep);
  65 LIST_HEAD(bmsafemaphd, bmsafemap);
  66
  67 /* This structure describes the UFS specific mount structure data. */
  68 struct ufsmount {
  69         struct  mount *um_mountp;               /* filesystem vfs structure */
  70         struct  cdev *um_dev;                   /* device mounted */
  71         struct  g_consumer *um_cp;
  72         struct  bufobj *um_bo;                  /* Buffer cache object */
  73         struct  vnode *um_devvp;                /* block device mounted vnode */
  74         u_long  um_fstype;                      /* type of filesystem */
  75         struct  fs *um_fs;                      /* pointer to superblock */
  76         struct  ufs_extattr_per_mount um_extattr;       /* extended attrs */
  77         u_long  um_nindir;                      /* indirect ptrs per block */
  78         u_long  um_bptrtodb;                    /* indir ptr to disk block */
  79         u_long  um_seqinc;                      /* inc between seq blocks */
  80         struct  mtx um_lock;                    /* Protects ufsmount & fs */
  81         pid_t   um_fsckpid;                     /* PID permitted fsck sysctls */
  82         struct  mount_softdeps *um_softdep;     /* softdep mgmt structure */
  83         struct  vnode *um_quotas[MAXQUOTAS];    /* pointer to quota files */
  84         struct  ucred *um_cred[MAXQUOTAS];      /* quota file access cred */
  85         time_t  um_btime[MAXQUOTAS];            /* block quota time limit */
  86         time_t  um_itime[MAXQUOTAS];            /* inode quota time limit */
  87         char    um_qflags[MAXQUOTAS];           /* quota specific flags */
  88         int64_t um_savedmaxfilesize;            /* XXX - limit maxfilesize */
  89         int     um_candelete;                   /* devvp supports TRIM */
  90         int     um_writesuspended;              /* suspension in progress */
  91         u_int   um_trim_inflight;
  92         struct taskqueue *um_trim_tq;
  93         int     (*um_balloc)(struct vnode *, off_t, int, struct ucred *,
  94                     int, struct buf **);
  95         int     (*um_blkatoff)(struct vnode *, off_t, char **, struct buf **);
  96         int     (*um_truncate)(struct vnode *, off_t, int, struct ucred *);
  97         int     (*um_update)(struct vnode *, int);
  98         int     (*um_valloc)(struct vnode *, int, struct ucred *,
  99                     struct vnode **);
 100         int     (*um_vfree)(struct vnode *, ino_t, int);
 101         void    (*um_ifree)(struct ufsmount *, struct inode *);
 102         int     (*um_rdonly)(struct inode *);
 103         void    (*um_snapgone)(struct inode *);
 104 };
 105
 106 #define UFS_BALLOC(aa, bb, cc, dd, ee, ff) VFSTOUFS((aa)->v_mount)->um_balloc(aa, bb, cc, dd, ee, ff)
 107 #define UFS_BLKATOFF(aa, bb, cc, dd) VFSTOUFS((aa)->v_mount)->um_blkatoff(aa, bb, cc, dd)
 108 #define UFS_TRUNCATE(aa, bb, cc, dd) VFSTOUFS((aa)->v_mount)->um_truncate(aa, bb, cc, dd)
 109 #define UFS_UPDATE(aa, bb) VFSTOUFS((aa)->v_mount)->um_update(aa, bb)
 110 #define UFS_VALLOC(aa, bb, cc, dd) VFSTOUFS((aa)->v_mount)->um_valloc(aa, bb, cc, dd)
 111 #define UFS_VFREE(aa, bb, cc) VFSTOUFS((aa)->v_mount)->um_vfree(aa, bb, cc)
 112 #define UFS_IFREE(aa, bb) ((aa)->um_ifree(aa, bb))
 113 #define UFS_RDONLY(aa) ((aa)->i_ump->um_rdonly(aa))
 114 #define UFS_SNAPGONE(aa) ((aa)->i_ump->um_snapgone(aa))
 115
 116 #define UFS_LOCK(aa)    mtx_lock(&(aa)->um_lock)
 117 #define UFS_UNLOCK(aa)  mtx_unlock(&(aa)->um_lock)
 118 #define UFS_MTX(aa)     (&(aa)->um_lock)
 119
 120 /*
 121  * Filesystem types
 122  */
 123 #define UFS1    1
 124 #define UFS2    2
 125
 126 /*
 127  * Flags describing the state of quotas.
 128  */
 129 #define QTF_OPENING     0x01                    /* Q_QUOTAON in progress */
 130 #define QTF_CLOSING     0x02                    /* Q_QUOTAOFF in progress */
 131 #define QTF_64BIT       0x04                    /* 64-bit quota file */
 132
 133 /* Convert mount ptr to ufsmount ptr. */
 134 #define VFSTOUFS(mp)    ((struct ufsmount *)((mp)->mnt_data))
 135 #define UFSTOVFS(ump)   (ump)->um_mountp
 136
 137 /*
 138  * Macros to access filesystem parameters in the ufsmount structure.
 139  * Used by ufs_bmap.
 140  */
 141 #define MNINDIR(ump)                    ((ump)->um_nindir)
 142 #define blkptrtodb(ump, b)              ((b) << (ump)->um_bptrtodb)
 143 #define is_sequential(ump, a, b)        ((b) == (a) + ump->um_seqinc)
 144 #endif /* _KERNEL */
 145
 146 #endif