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