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 */ 33 34 #ifndef _UFS_UFS_UFSMOUNT_H_ 35 #define _UFS_UFS_UFSMOUNT_H_ 36 37 /* 38 * Arguments to mount UFS-based filesystems 39 */ 40 struct ufs_args { 41 char *fspec; /* block special device to mount */ 42 struct oexport_args export; /* network export information */ 43 }; 44 45 #include <sys/_task.h> 46 47 #ifdef _KERNEL 48 #ifdef MALLOC_DECLARE 49 MALLOC_DECLARE(M_UFSMNT); 50 MALLOC_DECLARE(M_TRIM); 51 #endif 52 #endif /* _KERNEL */ 53 54 struct buf; 55 struct inode; 56 struct nameidata; 57 struct taskqueue; 58 struct timeval; 59 struct ucred; 60 struct uio; 61 struct vnode; 62 struct ufs_extattr_per_mount; 63 struct jblocks; 64 struct inodedep; 65 66 TAILQ_HEAD(inodedeplst, inodedep); 67 LIST_HEAD(bmsafemaphd, bmsafemap); 68 LIST_HEAD(trimlist_hashhead, ffs_blkfree_trim_params); 69 70 #include <sys/_lock.h> 71 #include <sys/_mutex.h> 72 #include <sys/_sx.h> 73 74 /* 75 * This structure describes the UFS specific mount structure data. 76 * The function operators are used to support different versions of 77 * UFS (UFS1, UFS2, etc). 78 * 79 * Lock reference: 80 * c - set at allocation then constant until freed 81 * i - ufsmount interlock (UFS_LOCK / UFS_UNLOCK) 82 * q - associated quota file is locked 83 * r - ref to parent mount structure is held (vfs_busy / vfs_unbusy) 84 */ 85 struct ufsmount { 86 struct mount *um_mountp; /* (r) filesystem vfs struct */ 87 struct cdev *um_dev; /* (r) device mounted */ 88 struct g_consumer *um_cp; /* (r) GEOM access point */ 89 struct bufobj *um_bo; /* (r) Buffer cache object */ 90 struct vnode *um_odevvp; /* (r) devfs dev vnode */ 91 struct vnode *um_devvp; /* (r) mntfs private vnode */ 92 uint64_t um_fstype; /* (c) type of filesystem */ 93 struct fs *um_fs; /* (r) pointer to superblock */ 94 struct ufs_extattr_per_mount um_extattr; /* (c) extended attrs */ 95 uint64_t um_nindir; /* (c) indirect ptrs per blk */ 96 uint64_t um_bptrtodb; /* (c) indir disk block ptr */ 97 uint64_t um_seqinc; /* (c) inc between seq blocks */ 98 uint64_t um_bsize; /* (c) fs block size */ 99 uint64_t um_maxsymlinklen; /* (c) max size of short 100 symlink */ 101 struct mtx um_lock; /* (c) Protects ufsmount & fs */ 102 struct sx um_checkpath_lock; /* (c) Protects ufs_checkpath() 103 result */ 104 struct mount_softdeps *um_softdep; /* (c) softdep mgmt structure */ 105 struct vnode *um_quotas[MAXQUOTAS]; /* (q) pointer to quota files */ 106 struct ucred *um_cred[MAXQUOTAS]; /* (q) quota file access cred */ 107 time_t um_btime[MAXQUOTAS]; /* (q) block quota time limit */ 108 time_t um_itime[MAXQUOTAS]; /* (q) inode quota time limit */ 109 char um_qflags[MAXQUOTAS]; /* (i) quota specific flags */ 110 int64_t um_savedmaxfilesize; /* (c) track maxfilesize */ 111 uint64_t um_flags; /* (i) filesystem flags */ 112 struct timeval um_last_fullmsg; /* (i) last full msg time */ 113 int um_secs_fullmsg; /* (i) seconds since full msg */ 114 struct timeval um_last_integritymsg; /* (i) last integrity msg */ 115 int um_secs_integritymsg; /* (i) secs since integ msg */ 116 uint64_t um_trim_inflight; /* (i) outstanding trim count */ 117 uint64_t um_trim_inflight_blks; /* (i) outstanding trim blks */ 118 uint64_t um_trim_total; /* (i) total trim count */ 119 uint64_t um_trim_total_blks; /* (i) total trim block count */ 120 struct taskqueue *um_trim_tq; /* (c) trim request queue */ 121 struct trimlist_hashhead *um_trimhash; /* (i) trimlist hash table */ 122 u_long um_trimlisthashsize; /* (i) trim hash table size-1 */ 123 /* (c) - below function ptrs */ 124 int (*um_balloc)(struct vnode *, off_t, int, struct ucred *, 125 int, struct buf **); 126 int (*um_blkatoff)(struct vnode *, off_t, char **, struct buf **); 127 int (*um_truncate)(struct vnode *, off_t, int, struct ucred *); 128 int (*um_update)(struct vnode *, int); 129 int (*um_valloc)(struct vnode *, int, struct ucred *, 130 struct vnode **); 131 int (*um_vfree)(struct vnode *, ino_t, int); 132 void (*um_ifree)(struct ufsmount *, struct inode *); 133 int (*um_rdonly)(struct inode *); 134 void (*um_snapgone)(struct inode *); 135 int (*um_check_blkno)(struct mount *, ino_t, daddr_t, int); 136 }; 137 138 /* 139 * filesystem flags 140 */ 141 #define UM_CANDELETE 0x00000001 /* devvp supports TRIM */ 142 #define UM_WRITESUSPENDED 0x00000002 /* suspension in progress */ 143 #define UM_CANSPEEDUP 0x00000004 /* devvp supports SPEEDUP */ 144 #define UM_FSFAIL_CLEANUP 0x00000008 /* need cleanup after 145 unrecoverable error */ 146 /* 147 * function prototypes 148 */ 149 #define UFS_BALLOC(aa, bb, cc, dd, ee, ff) \ 150 VFSTOUFS((aa)->v_mount)->um_balloc(aa, bb, cc, dd, ee, ff) 151 #define UFS_BLKATOFF(aa, bb, cc, dd) \ 152 VFSTOUFS((aa)->v_mount)->um_blkatoff(aa, bb, cc, dd) 153 #define UFS_TRUNCATE(aa, bb, cc, dd) \ 154 VFSTOUFS((aa)->v_mount)->um_truncate(aa, bb, cc, dd) 155 #define UFS_UPDATE(aa, bb) VFSTOUFS((aa)->v_mount)->um_update(aa, bb) 156 #define UFS_VALLOC(aa, bb, cc, dd) \ 157 VFSTOUFS((aa)->v_mount)->um_valloc(aa, bb, cc, dd) 158 #define UFS_VFREE(aa, bb, cc) VFSTOUFS((aa)->v_mount)->um_vfree(aa, bb, cc) 159 #define UFS_IFREE(aa, bb) ((aa)->um_ifree(aa, bb)) 160 #define UFS_RDONLY(aa) (ITOUMP(aa)->um_rdonly(aa)) 161 #define UFS_SNAPGONE(aa) (ITOUMP(aa)->um_snapgone(aa)) 162 #define UFS_CHECK_BLKNO(aa, bb, cc, dd) \ 163 (VFSTOUFS(aa)->um_check_blkno == NULL ? 0 : \ 164 VFSTOUFS(aa)->um_check_blkno(aa, bb, cc, dd)) 165 166 #define UFS_LOCK(aa) mtx_lock(&(aa)->um_lock) 167 #define UFS_UNLOCK(aa) mtx_unlock(&(aa)->um_lock) 168 #define UFS_MTX(aa) (&(aa)->um_lock) 169 170 /* 171 * Filesystem types 172 */ 173 #define UFS1 1 174 #define UFS2 2 175 176 /* 177 * Flags describing the state of quotas. 178 */ 179 #define QTF_OPENING 0x01 /* Q_QUOTAON in progress */ 180 #define QTF_CLOSING 0x02 /* Q_QUOTAOFF in progress */ 181 #define QTF_64BIT 0x04 /* 64-bit quota file */ 182 183 /* Convert mount ptr to ufsmount ptr. */ 184 #define VFSTOUFS(mp) ((struct ufsmount *)((mp)->mnt_data)) 185 #define UFSTOVFS(ump) (ump)->um_mountp 186 187 /* 188 * Macros to access filesystem parameters in the ufsmount structure. 189 * Used by ufs_bmap. 190 */ 191 #define MNINDIR(ump) ((ump)->um_nindir) 192 #define blkptrtodb(ump, b) ((b) << (ump)->um_bptrtodb) 193 #define is_sequential(ump, a, b) ((b) == (a) + ump->um_seqinc) 194 195 /* true if old FS format...*/ 196 #define OFSFMT(vp) (VFSTOUFS((vp)->v_mount)->um_maxsymlinklen <= 0) 197 198 #endif 199