sys/ufs/ufs/ufsmount.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)ufsmount.h  8.6 (Berkeley) 3/30/95
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _UFS_UFS_UFSMOUNT_H_
  36 #define _UFS_UFS_UFSMOUNT_H_
  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 #include <sys/_task.h>
  47
  48 #ifdef _KERNEL
  49 #ifdef MALLOC_DECLARE
  50 MALLOC_DECLARE(M_UFSMNT);
  51 MALLOC_DECLARE(M_TRIM);
  52 #endif
  53 #endif  /* _KERNEL */
  54
  55 struct buf;
  56 struct inode;
  57 struct nameidata;
  58 struct taskqueue;
  59 struct timeval;
  60 struct ucred;
  61 struct uio;
  62 struct vnode;
  63 struct ufs_extattr_per_mount;
  64 struct jblocks;
  65 struct inodedep;
  66
  67 TAILQ_HEAD(inodedeplst, inodedep);
  68 LIST_HEAD(bmsafemaphd, bmsafemap);
  69 LIST_HEAD(trimlist_hashhead, ffs_blkfree_trim_params);
  70 struct fsfail_task {
  71         struct task task;
  72         fsid_t fsid;
  73 };
  74
  75 #include <sys/_lock.h>
  76 #include <sys/_mutex.h>
  77
  78 /*
  79  * This structure describes the UFS specific mount structure data.
  80  * The function operators are used to support different versions of
  81  * UFS (UFS1, UFS2, etc).
  82  *
  83  * Lock reference:
  84  *      c - set at allocation then constant until freed
  85  *      i - ufsmount interlock (UFS_LOCK / UFS_UNLOCK)
  86  *      q - associated quota file is locked
  87  *      r - ref to parent mount structure is held (vfs_busy / vfs_unbusy)
  88  *      u - managed by user process fsck_ufs
  89  */
  90 struct ufsmount {
  91         struct  mount *um_mountp;               /* (r) filesystem vfs struct */
  92         struct  cdev *um_dev;                   /* (r) device mounted */
  93         struct  g_consumer *um_cp;              /* (r) GEOM access point */
  94         struct  bufobj *um_bo;                  /* (r) Buffer cache object */
  95         struct  vnode *um_odevvp;               /* (r) devfs dev vnode */
  96         struct  vnode *um_devvp;                /* (r) mntfs private vnode */
  97         u_long  um_fstype;                      /* (c) type of filesystem */
  98         struct  fs *um_fs;                      /* (r) pointer to superblock */
  99         struct  ufs_extattr_per_mount um_extattr; /* (c) extended attrs */
 100         u_long  um_nindir;                      /* (c) indirect ptrs per blk */
 101         u_long  um_bptrtodb;                    /* (c) indir disk block ptr */
 102         u_long  um_seqinc;                      /* (c) inc between seq blocks */
 103         struct  mtx um_lock;                    /* (c) Protects ufsmount & fs */
 104         pid_t   um_fsckpid;                     /* (u) PID can do fsck sysctl */
 105         struct  mount_softdeps *um_softdep;     /* (c) softdep mgmt structure */
 106         struct  vnode *um_quotas[MAXQUOTAS];    /* (q) pointer to quota files */
 107         struct  ucred *um_cred[MAXQUOTAS];      /* (q) quota file access cred */
 108         time_t  um_btime[MAXQUOTAS];            /* (q) block quota time limit */
 109         time_t  um_itime[MAXQUOTAS];            /* (q) inode quota time limit */
 110         char    um_qflags[MAXQUOTAS];           /* (i) quota specific flags */
 111         int64_t um_savedmaxfilesize;            /* (c) track maxfilesize */
 112         u_int   um_flags;                       /* (i) filesystem flags */
 113         struct  timeval um_last_fullmsg;        /* (i) last full msg time */
 114         int     um_secs_fullmsg;                /* (i) seconds since full msg */
 115         struct  timeval um_last_integritymsg;   /* (i) last integrity msg */
 116         int     um_secs_integritymsg;           /* (i) secs since integ msg */
 117         u_int   um_trim_inflight;               /* (i) outstanding trim count */
 118         u_int   um_trim_inflight_blks;          /* (i) outstanding trim blks */
 119         u_long  um_trim_total;                  /* (i) total trim count */
 120         u_long  um_trim_total_blks;             /* (i) total trim block count */
 121         struct  taskqueue *um_trim_tq;          /* (c) trim request queue */
 122         struct  trimlist_hashhead *um_trimhash; /* (i) trimlist hash table */
 123         u_long  um_trimlisthashsize;            /* (i) trim hash table size-1 */
 124         struct  fsfail_task *um_fsfail_task;    /* (i) task for fsfail cleanup*/
 125                                                 /* (c) - below function ptrs */
 126         int     (*um_balloc)(struct vnode *, off_t, int, struct ucred *,
 127                     int, struct buf **);
 128         int     (*um_blkatoff)(struct vnode *, off_t, char **, struct buf **);
 129         int     (*um_truncate)(struct vnode *, off_t, int, struct ucred *);
 130         int     (*um_update)(struct vnode *, int);
 131         int     (*um_valloc)(struct vnode *, int, struct ucred *,
 132                     struct vnode **);
 133         int     (*um_vfree)(struct vnode *, ino_t, int);
 134         void    (*um_ifree)(struct ufsmount *, struct inode *);
 135         int     (*um_rdonly)(struct inode *);
 136         void    (*um_snapgone)(struct inode *);
 137         int     (*um_check_blkno)(struct mount *, ino_t, daddr_t, int);
 138 };
 139
 140 /*
 141  * filesystem flags
 142  */
 143 #define UM_CANDELETE            0x00000001      /* devvp supports TRIM */
 144 #define UM_WRITESUSPENDED       0x00000002      /* suspension in progress */
 145 #define UM_CANSPEEDUP           0x00000004      /* devvp supports SPEEDUP */
 146 #define UM_FSFAIL_CLEANUP       0x00000008      /* need cleanup after
 147                                                    unrecoverable error */
 148 /*
 149  * function prototypes
 150  */
 151 #define UFS_BALLOC(aa, bb, cc, dd, ee, ff) \
 152         VFSTOUFS((aa)->v_mount)->um_balloc(aa, bb, cc, dd, ee, ff)
 153 #define UFS_BLKATOFF(aa, bb, cc, dd) \
 154         VFSTOUFS((aa)->v_mount)->um_blkatoff(aa, bb, cc, dd)
 155 #define UFS_TRUNCATE(aa, bb, cc, dd) \
 156         VFSTOUFS((aa)->v_mount)->um_truncate(aa, bb, cc, dd)
 157 #define UFS_UPDATE(aa, bb) VFSTOUFS((aa)->v_mount)->um_update(aa, bb)
 158 #define UFS_VALLOC(aa, bb, cc, dd) \
 159         VFSTOUFS((aa)->v_mount)->um_valloc(aa, bb, cc, dd)
 160 #define UFS_VFREE(aa, bb, cc) VFSTOUFS((aa)->v_mount)->um_vfree(aa, bb, cc)
 161 #define UFS_IFREE(aa, bb) ((aa)->um_ifree(aa, bb))
 162 #define UFS_RDONLY(aa) (ITOUMP(aa)->um_rdonly(aa))
 163 #define UFS_SNAPGONE(aa) (ITOUMP(aa)->um_snapgone(aa))
 164 #define UFS_CHECK_BLKNO(aa, bb, cc, dd)                 \
 165         (VFSTOUFS(aa)->um_check_blkno == NULL ? 0 :     \
 166          VFSTOUFS(aa)->um_check_blkno(aa, bb, cc, dd))
 167
 168 #define UFS_LOCK(aa)    mtx_lock(&(aa)->um_lock)
 169 #define UFS_UNLOCK(aa)  mtx_unlock(&(aa)->um_lock)
 170 #define UFS_MTX(aa)     (&(aa)->um_lock)
 171
 172 /*
 173  * Filesystem types
 174  */
 175 #define UFS1    1
 176 #define UFS2    2
 177
 178 /*
 179  * Flags describing the state of quotas.
 180  */
 181 #define QTF_OPENING     0x01                    /* Q_QUOTAON in progress */
 182 #define QTF_CLOSING     0x02                    /* Q_QUOTAOFF in progress */
 183 #define QTF_64BIT       0x04                    /* 64-bit quota file */
 184
 185 /* Convert mount ptr to ufsmount ptr. */
 186 #define VFSTOUFS(mp)    ((struct ufsmount *)((mp)->mnt_data))
 187 #define UFSTOVFS(ump)   (ump)->um_mountp
 188
 189 /*
 190  * Macros to access filesystem parameters in the ufsmount structure.
 191  * Used by ufs_bmap.
 192  */
 193 #define MNINDIR(ump)                    ((ump)->um_nindir)
 194 #define blkptrtodb(ump, b)              ((b) << (ump)->um_bptrtodb)
 195 #define is_sequential(ump, a, b)        ((b) == (a) + ump->um_seqinc)
 196
 197 #endif