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 * @(#)inode.h 8.9 (Berkeley) 5/14/95 37 * $FreeBSD$ 38 */ 39 40 #ifndef _UFS_UFS_INODE_H_ 41 #define _UFS_UFS_INODE_H_ 42 43 #include <sys/lock.h> 44 #include <sys/queue.h> 45 #include <ufs/ufs/dinode.h> 46 #include <sys/seqc.h> 47 48 /* 49 * This must agree with the definition in <ufs/ufs/dir.h>. 50 */ 51 #define doff_t int32_t 52 53 /* 54 * The inode is used to describe each active (or recently active) file in the 55 * UFS filesystem. It is composed of two types of information. The first part 56 * is the information that is needed only while the file is active (such as 57 * the identity of the file and linkage to speed its lookup). The second part 58 * is the permanent meta-data associated with the file which is read in 59 * from the permanent dinode from long term storage when the file becomes 60 * active, and is put back when the file is no longer being used. 61 * 62 * An inode may only be changed while holding either the exclusive 63 * vnode lock or the shared vnode lock and the vnode interlock. We use 64 * the latter only for "read" and "get" operations that require 65 * changing i_flag, or a timestamp. This locking protocol allows executing 66 * those operations without having to upgrade the vnode lock from shared to 67 * exclusive. 68 */ 69 struct inode { 70 TAILQ_ENTRY(inode) i_nextsnap; /* snapshot file list. */ 71 struct vnode *i_vnode;/* Vnode associated with this inode. */ 72 struct ufsmount *i_ump;/* Ufsmount point associated with this inode. */ 73 struct dquot *i_dquot[MAXQUOTAS]; /* Dquot structures. */ 74 union { 75 struct dirhash *dirhash; /* Hashing for large directories. */ 76 daddr_t *snapblklist; /* Collect expunged snapshot blocks. */ 77 } i_un; 78 /* 79 * The real copy of the on-disk inode. 80 */ 81 union { 82 struct ufs1_dinode *din1; /* UFS1 on-disk dinode. */ 83 struct ufs2_dinode *din2; /* UFS2 on-disk dinode. */ 84 } dinode_u; 85 86 ino_t i_number; /* The identity of the inode. */ 87 u_int32_t i_flag; /* flags, see below */ 88 int i_effnlink; /* i_nlink when I/O completes */ 89 90 /* 91 * Side effects; used during directory lookup. 92 */ 93 int32_t i_count; /* Size of free slot in directory. */ 94 doff_t i_endoff; /* End of useful stuff in directory. */ 95 doff_t i_diroff; /* Offset in dir, where we found last entry. */ 96 doff_t i_offset; /* Offset of free space in directory. */ 97 98 int i_nextclustercg; /* last cg searched for cluster */ 99 100 /* 101 * Data for extended attribute modification. 102 */ 103 u_char *i_ea_area; /* Pointer to malloced copy of EA area */ 104 unsigned i_ea_len; /* Length of i_ea_area */ 105 int i_ea_error; /* First errno in transaction */ 106 int i_ea_refs; /* Number of users of EA area */ 107 108 /* 109 * Copies from the on-disk dinode itself. 110 */ 111 u_int64_t i_size; /* File byte count. */ 112 u_int64_t i_gen; /* Generation number. */ 113 u_int32_t i_flags; /* Status flags (chflags). */ 114 u_int32_t i_uid; /* File owner. */ 115 u_int32_t i_gid; /* File group. */ 116 u_int16_t i_mode; /* IFMT, permissions; see below. */ 117 int16_t i_nlink; /* File link count. */ 118 }; 119 /* 120 * These flags are kept in i_flag. 121 */ 122 #define IN_ACCESS 0x0001 /* Access time update request. */ 123 #define IN_CHANGE 0x0002 /* Inode change time update request. */ 124 #define IN_UPDATE 0x0004 /* Modification time update request. */ 125 #define IN_MODIFIED 0x0008 /* Inode has been modified. */ 126 #define IN_NEEDSYNC 0x0010 /* Inode requires fsync. */ 127 #define IN_LAZYMOD 0x0020 /* Modified, but don't write yet. */ 128 #define IN_LAZYACCESS 0x0040 /* Process IN_ACCESS after the 129 suspension finished */ 130 #define IN_EA_LOCKED 0x0080 /* Extended attributes locked */ 131 #define IN_EA_LOCKWAIT 0x0100 /* Want extended attributes lock */ 132 #define IN_TRUNCATED 0x0200 /* Journaled truncation pending. */ 133 #define IN_UFS2 0x0400 /* UFS2 vs UFS1 */ 134 #define IN_IBLKDATA 0x0800 /* datasync requires inode block 135 update */ 136 #define IN_SIZEMOD 0x1000 /* Inode size has been modified */ 137 138 #define PRINT_INODE_FLAGS "\20\20b16\17b15\16b14\15sizemod" \ 139 "\14iblkdata\13is_ufs2\12truncated\11ea_lockwait\10ea_locked" \ 140 "\7lazyaccess\6lazymod\5needsync\4modified\3update\2change\1access" 141 142 #define UFS_INODE_FLAG_LAZY_MASK \ 143 (IN_ACCESS | IN_CHANGE | IN_MODIFIED | IN_UPDATE | IN_LAZYMOD | \ 144 IN_LAZYACCESS) 145 /* 146 * Some flags can persist a vnode transitioning to 0 hold count and being tkaen 147 * off the list. 148 */ 149 #define UFS_INODE_FLAG_LAZY_MASK_ASSERTABLE \ 150 (UFS_INODE_FLAG_LAZY_MASK & ~(IN_LAZYMOD | IN_LAZYACCESS)) 151 152 #define UFS_INODE_SET_MODE(ip, mode) do { \ 153 struct inode *_ip = (ip); \ 154 int _mode = (mode); \ 155 \ 156 ASSERT_VOP_IN_SEQC(ITOV(_ip)); \ 157 atomic_store_short(&(_ip)->i_mode, _mode); \ 158 } while (0) 159 160 #define UFS_INODE_SET_FLAG(ip, flags) do { \ 161 struct inode *_ip = (ip); \ 162 struct vnode *_vp = ITOV(_ip); \ 163 int _flags = (flags); \ 164 \ 165 _ip->i_flag |= _flags; \ 166 if (_flags & UFS_INODE_FLAG_LAZY_MASK) \ 167 vlazy(_vp); \ 168 } while (0) 169 170 #define UFS_INODE_SET_FLAG_SHARED(ip, flags) do { \ 171 struct inode *_ip = (ip); \ 172 struct vnode *_vp = ITOV(_ip); \ 173 int _flags = (flags); \ 174 \ 175 ASSERT_VI_UNLOCKED(_vp, __func__); \ 176 if ((_ip->i_flag & (_flags)) != _flags) { \ 177 VI_LOCK(_vp); \ 178 _ip->i_flag |= _flags; \ 179 if (_flags & UFS_INODE_FLAG_LAZY_MASK) \ 180 vlazy(_vp); \ 181 VI_UNLOCK(_vp); \ 182 } \ 183 } while (0) 184 185 #define i_dirhash i_un.dirhash 186 #define i_snapblklist i_un.snapblklist 187 #define i_din1 dinode_u.din1 188 #define i_din2 dinode_u.din2 189 190 #ifdef _KERNEL 191 192 #define ITOUMP(ip) ((ip)->i_ump) 193 #define ITODEV(ip) (ITOUMP(ip)->um_dev) 194 #define ITODEVVP(ip) (ITOUMP(ip)->um_devvp) 195 #define ITOFS(ip) (ITOUMP(ip)->um_fs) 196 #define ITOVFS(ip) ((ip)->i_vnode->v_mount) 197 198 static inline _Bool 199 I_IS_UFS1(const struct inode *ip) 200 { 201 202 return ((ip->i_flag & IN_UFS2) == 0); 203 } 204 205 static inline _Bool 206 I_IS_UFS2(const struct inode *ip) 207 { 208 209 return ((ip->i_flag & IN_UFS2) != 0); 210 } 211 212 /* 213 * The DIP macro is used to access fields in the dinode that are 214 * not cached in the inode itself. 215 */ 216 #define DIP(ip, field) (I_IS_UFS1(ip) ? (ip)->i_din1->d##field : \ 217 (ip)->i_din2->d##field) 218 #define DIP_SET(ip, field, val) do { \ 219 if (I_IS_UFS1(ip)) \ 220 (ip)->i_din1->d##field = (val); \ 221 else \ 222 (ip)->i_din2->d##field = (val); \ 223 } while (0) 224 225 #define SHORTLINK(ip) (I_IS_UFS1(ip) ? \ 226 (caddr_t)(ip)->i_din1->di_db : (caddr_t)(ip)->i_din2->di_db) 227 #define IS_SNAPSHOT(ip) ((ip)->i_flags & SF_SNAPSHOT) 228 229 /* 230 * Structure used to pass around logical block paths generated by 231 * ufs_getlbns and used by truncate and bmap code. 232 */ 233 struct indir { 234 ufs2_daddr_t in_lbn; /* Logical block number. */ 235 int in_off; /* Offset in buffer. */ 236 }; 237 238 /* Convert between inode pointers and vnode pointers. */ 239 #define VTOI(vp) ((struct inode *)(vp)->v_data) 240 #define VTOI_SMR(vp) ((struct inode *)vn_load_v_data_smr(vp)) 241 #define ITOV(ip) ((ip)->i_vnode) 242 243 /* Determine if soft dependencies are being done */ 244 #define DOINGSOFTDEP(vp) \ 245 (((vp)->v_mount->mnt_flag & (MNT_SOFTDEP | MNT_SUJ)) != 0) 246 #define MOUNTEDSOFTDEP(mp) (((mp)->mnt_flag & (MNT_SOFTDEP | MNT_SUJ)) != 0) 247 #define DOINGSUJ(vp) (((vp)->v_mount->mnt_flag & MNT_SUJ) != 0) 248 #define MOUNTEDSUJ(mp) (((mp)->mnt_flag & MNT_SUJ) != 0) 249 250 /* This overlays the fid structure (see mount.h). */ 251 struct ufid { 252 u_int16_t ufid_len; /* Length of structure. */ 253 u_int16_t ufid_pad; /* Force 32-bit alignment. */ 254 uint32_t ufid_ino; /* File number (ino). */ 255 uint32_t ufid_gen; /* Generation number. */ 256 }; 257 #endif /* _KERNEL */ 258 259 #endif /* !_UFS_UFS_INODE_H_ */ 260