1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1982, 1989, 1993 5 * The Regents of the University of California. All rights reserved. 6 * (c) UNIX System Laboratories, Inc. 7 * All or some portions of this file are derived from material licensed 8 * to the University of California by American Telephone and Telegraph 9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 10 * the permission of UNIX System Laboratories, Inc. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 */ 36 37 #ifndef _UFS_UFS_INODE_H_ 38 #define _UFS_UFS_INODE_H_ 39 40 #include <sys/lock.h> 41 #include <sys/queue.h> 42 #include <ufs/ufs/dinode.h> 43 #include <sys/seqc.h> 44 #ifdef DIAGNOSTIC 45 #include <sys/stack.h> 46 #endif 47 #include <sys/buf.h> 48 49 /* 50 * This must agree with the definition in <ufs/ufs/dir.h>. 51 */ 52 #define doff_t int32_t 53 54 #ifdef DIAGNOSTIC 55 struct iown_tracker { 56 struct thread *tr_owner; 57 struct stack tr_st; 58 struct stack tr_unlock; 59 int tr_gen; 60 }; 61 #endif 62 63 /* 64 * The inode is used to describe each active (or recently active) file in the 65 * UFS filesystem. It is composed of two types of information. The first part 66 * is the information that is needed only while the file is active (such as 67 * the identity of the file and linkage to speed its lookup). The second part 68 * is the permanent meta-data associated with the file which is read in 69 * from the permanent dinode from long term storage when the file becomes 70 * active, and is put back when the file is no longer being used. 71 * 72 * An inode may only be changed while holding either the exclusive 73 * vnode lock or the shared vnode lock and the vnode interlock. We use 74 * the latter only for "read" and "get" operations that require 75 * changing i_flag, or a timestamp. This locking protocol allows executing 76 * those operations without having to upgrade the vnode lock from shared to 77 * exclusive. 78 */ 79 struct inode { 80 TAILQ_ENTRY(inode) i_nextsnap; /* Snapshot file list. */ 81 struct vnode *i_vnode; /* Vnode associated with this inode. */ 82 struct ufsmount *i_ump; /* Ufsmount point associated with this inode. */ 83 struct dquot *i_dquot[MAXQUOTAS]; /* Dquot structures. */ 84 union { 85 struct dirhash *dirhash; /* Hashing for large directories. */ 86 daddr_t *snapblklist; /* Collect expunged snapshot blocks. */ 87 } i_un; 88 /* 89 * The real copy of the on-disk inode. 90 */ 91 union dinodep i_dp; /* On-disk dinode */ 92 93 ino_t i_number; /* The identity of the inode. */ 94 uint32_t i_flag; /* flags, see below */ 95 int32_t i_effnlink; /* i_nlink when I/O completes */ 96 97 /* 98 * Side effects; used during directory lookup. 99 */ 100 int32_t i_count; /* Size of free slot in directory. */ 101 doff_t i_endoff; /* End of useful stuff in directory. */ 102 doff_t i_diroff; /* Offset in dir, where we found last entry. */ 103 doff_t i_offset; /* Offset of free space in directory. */ 104 #ifdef DIAGNOSTIC 105 int i_lock_gen; 106 struct iown_tracker i_count_tracker; 107 struct iown_tracker i_endoff_tracker; 108 struct iown_tracker i_offset_tracker; 109 #endif 110 111 int i_nextclustercg; /* last cg searched for cluster */ 112 113 struct vn_clusterw i_clusterw; /* Buffer clustering information */ 114 115 /* 116 * Data for extended attribute modification. 117 */ 118 uint8_t *i_ea_area; /* Pointer to malloced copy of EA area */ 119 unsigned i_ea_len; /* Length of i_ea_area */ 120 int i_ea_error; /* First errno in transaction */ 121 int i_ea_refs; /* Number of users of EA area */ 122 123 /* 124 * Copies from the on-disk dinode itself. 125 */ 126 uint64_t i_size; /* File byte count. */ 127 uint64_t i_gen; /* Generation number. */ 128 uint32_t i_flags; /* Status flags (chflags). */ 129 uint32_t i_uid; /* File owner. */ 130 uint32_t i_gid; /* File group. */ 131 int32_t i_nlink; /* File link count. */ 132 uint16_t i_mode; /* IFMT, permissions; see below. */ 133 }; 134 /* 135 * These flags are kept in i_flag. 136 */ 137 #define IN_ACCESS 0x0001 /* Access time update request. */ 138 #define IN_CHANGE 0x0002 /* Inode change time update request. */ 139 #define IN_UPDATE 0x0004 /* Modification time update request. */ 140 #define IN_MODIFIED 0x0008 /* Inode has been modified. */ 141 #define IN_NEEDSYNC 0x0010 /* Inode requires fsync. */ 142 #define IN_LAZYMOD 0x0020 /* Modified, but don't write yet. */ 143 #define IN_LAZYACCESS 0x0040 /* Process IN_ACCESS after the 144 suspension finished */ 145 #define IN_EA_LOCKED 0x0080 /* Extended attributes locked */ 146 #define IN_EA_LOCKWAIT 0x0100 /* Want extended attributes lock */ 147 #define IN_TRUNCATED 0x0200 /* Journaled truncation pending. */ 148 #define IN_UFS2 0x0400 /* UFS2 vs UFS1 */ 149 #define IN_IBLKDATA 0x0800 /* datasync requires inode block 150 update */ 151 #define IN_SIZEMOD 0x1000 /* Inode size has been modified */ 152 #define IN_ENDOFF 0x2000 /* Free space at the end of directory, 153 try to truncate when possible */ 154 155 #define PRINT_INODE_FLAGS "\20\20b16\17b15\16b14\15sizemod" \ 156 "\14iblkdata\13is_ufs2\12truncated\11ea_lockwait\10ea_locked" \ 157 "\7lazyaccess\6lazymod\5needsync\4modified\3update\2change\1access" 158 159 #define UFS_INODE_FLAG_LAZY_MASK \ 160 (IN_ACCESS | IN_CHANGE | IN_MODIFIED | IN_UPDATE | IN_LAZYMOD | \ 161 IN_LAZYACCESS) 162 /* 163 * Some flags can persist a vnode transitioning to 0 hold count and being tkaen 164 * off the list. 165 */ 166 #define UFS_INODE_FLAG_LAZY_MASK_ASSERTABLE \ 167 (UFS_INODE_FLAG_LAZY_MASK & ~(IN_LAZYMOD | IN_LAZYACCESS)) 168 169 #define UFS_INODE_SET_MODE(ip, mode) do { \ 170 struct inode *_ip = (ip); \ 171 int _mode = (mode); \ 172 \ 173 ASSERT_VOP_IN_SEQC(ITOV(_ip)); \ 174 atomic_store_short(&(_ip)->i_mode, _mode); \ 175 } while (0) 176 177 #define UFS_INODE_SET_FLAG(ip, flags) do { \ 178 struct inode *_ip = (ip); \ 179 struct vnode *_vp = ITOV(_ip); \ 180 int _flags = (flags); \ 181 \ 182 _ip->i_flag |= _flags; \ 183 if (_flags & UFS_INODE_FLAG_LAZY_MASK) \ 184 vlazy(_vp); \ 185 } while (0) 186 187 #define UFS_INODE_SET_FLAG_SHARED(ip, flags) do { \ 188 struct inode *_ip = (ip); \ 189 struct vnode *_vp = ITOV(_ip); \ 190 int _flags = (flags); \ 191 \ 192 ASSERT_VI_UNLOCKED(_vp, __func__); \ 193 if ((_ip->i_flag & (_flags)) != _flags) { \ 194 VI_LOCK(_vp); \ 195 _ip->i_flag |= _flags; \ 196 if (_flags & UFS_INODE_FLAG_LAZY_MASK) \ 197 vlazy(_vp); \ 198 VI_UNLOCK(_vp); \ 199 } \ 200 } while (0) 201 202 #define i_dirhash i_un.dirhash 203 #define i_snapblklist i_un.snapblklist 204 #define i_din1 i_dp.dp1 205 #define i_din2 i_dp.dp2 206 207 #define ITOUMP(ip) ((ip)->i_ump) 208 #define ITODEV(ip) (ITOUMP(ip)->um_dev) 209 #define ITODEVVP(ip) (ITOUMP(ip)->um_devvp) 210 #define ITOFS(ip) (ITOUMP(ip)->um_fs) 211 #define ITOVFS(ip) ((ip)->i_vnode->v_mount) 212 213 #ifdef _KERNEL 214 215 static inline _Bool 216 I_IS_UFS1(const struct inode *ip) 217 { 218 219 return ((ip->i_flag & IN_UFS2) == 0); 220 } 221 222 static inline _Bool 223 I_IS_UFS2(const struct inode *ip) 224 { 225 226 return ((ip->i_flag & IN_UFS2) != 0); 227 } 228 #endif /* _KERNEL */ 229 230 /* 231 * The DIP macro is used to access fields in the dinode that are 232 * not cached in the inode itself. 233 */ 234 #define DIP(ip, field) (I_IS_UFS1(ip) ? (ip)->i_din1->d##field : \ 235 (ip)->i_din2->d##field) 236 #define DIP_SET(ip, field, val) do { \ 237 if (I_IS_UFS1(ip)) \ 238 (ip)->i_din1->d##field = (val); \ 239 else \ 240 (ip)->i_din2->d##field = (val); \ 241 } while (0) 242 #define DIP_SET_NLINK(ip, val) do { \ 243 KASSERT(ip->i_nlink >= 0, ("%s:%d %s(): setting negative " \ 244 "nlink value %d for inode %jd\n", __FILE__, __LINE__, \ 245 __FUNCTION__, (ip)->i_nlink, (ip)->i_number)); \ 246 DIP_SET(ip, i_nlink, val); \ 247 } while (0) 248 249 #define IS_SNAPSHOT(ip) ((ip)->i_flags & SF_SNAPSHOT) 250 #define IS_UFS(vp) ((vp)->v_data != NULL) 251 252 /* 253 * Structure used to pass around logical block paths generated by 254 * ufs_getlbns and used by truncate and bmap code. 255 */ 256 struct indir { 257 ufs2_daddr_t in_lbn; /* Logical block number. */ 258 int in_off; /* Offset in buffer. */ 259 }; 260 261 /* Convert between inode pointers and vnode pointers. */ 262 #define VTOI(vp) ((struct inode *)(vp)->v_data) 263 #define VTOI_SMR(vp) ((struct inode *)vn_load_v_data_smr(vp)) 264 #define ITOV(ip) ((ip)->i_vnode) 265 266 /* Determine if soft dependencies are being done */ 267 #define MOUNTEDSOFTDEP(mp) (((mp)->mnt_flag & MNT_SOFTDEP) != 0) 268 #define DOINGSOFTDEP(vp) MOUNTEDSOFTDEP((vp)->v_mount) 269 #define MOUNTEDSUJ(mp) (((mp)->mnt_flag & (MNT_SOFTDEP | MNT_SUJ)) == \ 270 (MNT_SOFTDEP | MNT_SUJ)) 271 #define DOINGSUJ(vp) MOUNTEDSUJ((vp)->v_mount) 272 273 /* This overlays the fid structure (see mount.h). */ 274 struct ufid { 275 uint16_t ufid_len; /* Length of structure. */ 276 uint16_t ufid_pad; /* Force 32-bit alignment. */ 277 uint32_t ufid_ino; /* File number (ino). */ 278 uint32_t ufid_gen; /* Generation number. */ 279 }; 280 281 #ifdef _KERNEL 282 #ifdef DIAGNOSTIC 283 void ufs_init_trackers(struct inode *ip); 284 void ufs_unlock_tracker(struct inode *ip); 285 286 doff_t ufs_get_i_offset(struct inode *ip, const char *file, int line); 287 void ufs_set_i_offset(struct inode *ip, doff_t off, const char *file, int line); 288 #define I_OFFSET(ip) ufs_get_i_offset(ip, __FILE__, __LINE__) 289 #define SET_I_OFFSET(ip, off) ufs_set_i_offset(ip, off, __FILE__, __LINE__) 290 291 int32_t ufs_get_i_count(struct inode *ip, const char *file, int line); 292 void ufs_set_i_count(struct inode *ip, int32_t cnt, const char *file, int line); 293 #define I_COUNT(ip) ufs_get_i_count(ip, __FILE__, __LINE__) 294 #define SET_I_COUNT(ip, cnt) ufs_set_i_count(ip, cnt, __FILE__, __LINE__) 295 296 doff_t ufs_get_i_endoff(struct inode *ip, const char *file, int line); 297 void ufs_set_i_endoff(struct inode *ip, doff_t off, const char *file, int line); 298 #define I_ENDOFF(ip) ufs_get_i_endoff(ip, __FILE__, __LINE__) 299 #define SET_I_ENDOFF(ip, off) ufs_set_i_endoff(ip, off, __FILE__, __LINE__) 300 301 #else 302 #define I_OFFSET(ip) ((ip)->i_offset) 303 #define SET_I_OFFSET(ip, off) ((ip)->i_offset = (off)) 304 #define I_COUNT(ip) ((ip)->i_count) 305 #define SET_I_COUNT(ip, cnt) ((ip)->i_count = cnt) 306 #define I_ENDOFF(ip) ((ip)->i_endoff) 307 #define SET_I_ENDOFF(ip, off) ((ip)->i_endoff = off) 308 #endif 309 310 #endif /* _KERNEL */ 311 312 #endif /* !_UFS_UFS_INODE_H_ */ 313