1 /* $NetBSD: lfs_inode.h,v 1.31 2025/12/06 04:55:04 perseant Exp $ */ 2 /* from NetBSD: ulfs_inode.h,v 1.5 2013/06/06 00:51:50 dholland Exp */ 3 /* from NetBSD: inode.h,v 1.72 2016/06/03 15:36:03 christos Exp */ 4 5 /* 6 * Copyright (c) 1982, 1989, 1993 7 * The Regents of the University of California. All rights reserved. 8 * (c) UNIX System Laboratories, Inc. 9 * All or some portions of this file are derived from material licensed 10 * to the University of California by American Telephone and Telegraph 11 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 12 * the permission of UNIX System Laboratories, Inc. 13 * 14 * Redistribution and use in source and binary forms, with or without 15 * modification, are permitted provided that the following conditions 16 * are met: 17 * 1. Redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer. 19 * 2. Redistributions in binary form must reproduce the above copyright 20 * notice, this list of conditions and the following disclaimer in the 21 * documentation and/or other materials provided with the distribution. 22 * 3. Neither the name of the University nor the names of its contributors 23 * may be used to endorse or promote products derived from this software 24 * without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36 * SUCH DAMAGE. 37 * 38 * @(#)inode.h 8.9 (Berkeley) 5/14/95 39 */ 40 41 #ifndef _UFS_LFS_LFS_INODE_H_ 42 #define _UFS_LFS_LFS_INODE_H_ 43 44 /* 45 * Some of the userlevel code (fsck, newfs, lfs_cleanerd) wants to use 46 * the in-memory inode structure in a faked-up kernel environment. 47 * This header file provides a reasonably sanitized version of the 48 * structures and definitions needed for that purpose. 49 */ 50 #include <sys/rbtree.h> 51 52 #include <miscfs/genfs/genfs_node.h> 53 #include <ufs/lfs/lfs.h> 54 55 /* 56 * Adjustable filesystem parameters 57 */ 58 #define MIN_FREE_SEGS 20 59 #define MIN_RESV_SEGS 15 60 61 /* 62 * The following constants define the usage of the quota file array in the 63 * ulfsmount structure and dquot array in the inode structure. The semantics 64 * of the elements of these arrays are defined in the routine lfs_getinoquota; 65 * the remainder of the quota code treats them generically and need not be 66 * inspected when changing the size of the array. 67 */ 68 #define ULFS_MAXQUOTAS 2 69 #define ULFS_USRQUOTA 0 /* element used for user quotas */ 70 #define ULFS_GRPQUOTA 1 /* element used for group quotas */ 71 72 /* 73 * Lookup result state (other than the result inode). This is 74 * currently stashed in the vnode between VOP_LOOKUP and directory 75 * operation VOPs, which is gross. 76 * 77 * XXX ulr_diroff is a lookup hint from the previous call of VOP_LOOKUP. 78 * probably it should not be here. 79 */ 80 struct ulfs_lookup_results { 81 int32_t ulr_count; /* Size of free slot in directory. */ 82 doff_t ulr_endoff; /* End of useful stuff in directory. */ 83 doff_t ulr_diroff; /* Offset in dir, where we found last entry. */ 84 doff_t ulr_offset; /* Offset of free space in directory. */ 85 uint32_t ulr_reclen; /* Size of found directory entry. */ 86 }; 87 88 /* notyet XXX */ 89 #define ULFS_CHECK_CRAPCOUNTER(dp) ((void)(dp)->i_crapcounter) 90 91 /* 92 * Per-filesystem inode extensions. 93 */ 94 struct lfs_inode_ext; 95 96 /* 97 * The inode is used to describe each active (or recently active) file in the 98 * ULFS filesystem. It is composed of two types of information. The first part 99 * is the information that is needed only while the file is active (such as 100 * the identity of the file and linkage to speed its lookup). The second part 101 * is the permanent meta-data associated with the file which is read in 102 * from the permanent dinode from long term storage when the file becomes 103 * active, and is put back when the file is no longer being used. 104 */ 105 struct inode { 106 struct genfs_node i_gnode; 107 TAILQ_ENTRY(inode) i_nextsnap; /* snapshot file list. */ 108 struct vnode *i_vnode; /* Vnode associated with this inode. */ 109 struct ulfsmount *i_ump; /* Mount point associated with this inode. */ 110 struct vnode *i_devvp; /* Vnode for block I/O. */ 111 112 uint32_t i_state; /* state */ 113 #define IN_ACCESS 0x0001 /* Access time update request. */ 114 #define IN_CHANGE 0x0002 /* Inode change time update request. */ 115 #define IN_UPDATE 0x0004 /* Inode was written to; update mtime. */ 116 #define IN_MODIFY 0x2000 /* Modification time update request. */ 117 #define IN_MODIFIED 0x0008 /* Inode has been modified. */ 118 #define IN_ACCESSED 0x0010 /* Inode has been accessed. */ 119 #define IN_DEAD 0x0020 /* Removed, waiting for reclaim. */ 120 #define IN_SHLOCK 0x0040 /* File has shared lock. */ 121 #define IN_EXLOCK 0x0080 /* File has exclusive lock. */ 122 #define IN_CLEANING 0x0100 /* LFS: file is being cleaned */ 123 #define IN_ADIROP 0x0200 /* LFS: dirop in progress */ 124 /* unused 0x0400 */ /* was FFS-only IN_SPACECOUNTED */ 125 #define IN_PAGING 0x1000 /* LFS: file is on paging queue */ 126 #define IN_CDIROP 0x4000 /* LFS: dirop completed pending i/o */ 127 #define IN_MARKER 0x00010000 /* LFS: marker inode for iteration */ 128 129 /* All of the flags that indicate a need to write the inode */ 130 #define IN_ALLMOD (IN_MODIFIED|IN_ACCESS|IN_CHANGE|IN_UPDATE|IN_MODIFY|IN_ACCESSED|IN_CLEANING) 131 132 dev_t i_dev; /* Device associated with the inode. */ 133 ino_t i_number; /* The identity of the inode. */ 134 135 struct lfs *i_lfs; /* The LFS volume we belong to. */ 136 137 void *i_unused1; /* Unused. */ 138 struct dquot *i_dquot[ULFS_MAXQUOTAS]; /* Dquot structures. */ 139 u_quad_t i_modrev; /* Revision level for NFS lease. */ 140 struct lockf *i_lockf;/* Head of byte-level lock list. */ 141 142 /* 143 * Side effects; used during (and after) directory lookup. 144 * XXX should not be here. 145 */ 146 struct ulfs_lookup_results i_crap; 147 unsigned i_crapcounter; /* serial number for i_crap */ 148 149 /* 150 * Inode extensions 151 */ 152 union { 153 /* Other extensions could go here... */ 154 struct lfs_inode_ext *lfs; 155 } inode_ext; 156 /* 157 * Copies from the on-disk dinode itself. 158 * 159 * These fields are currently only used by LFS. 160 */ 161 uint16_t i_mode; /* IFMT, permissions; see below. */ 162 int16_t i_nlink; /* File link count. */ 163 uint64_t i_size; /* File byte count. */ 164 uint32_t i_flags; /* Status flags (chflags). */ 165 int32_t i_gen; /* Generation number. */ 166 uint32_t i_uid; /* File owner. */ 167 uint32_t i_gid; /* File group. */ 168 uint16_t i_omode; /* Old mode, for ulfs_reclaim. */ 169 170 struct dirhash *i_dirhash; /* Hashing for large directories */ 171 172 /* 173 * The on-disk dinode itself. 174 */ 175 union lfs_dinode *i_din; 176 }; 177 178 /* 179 * LFS inode extensions. 180 */ 181 struct lfs_inode_ext { 182 off_t lfs_osize; /* size of file on disk */ 183 uint64_t lfs_effnblocks; /* number of blocks when i/o completes */ 184 size_t lfs_fragsize[ULFS_NDADDR]; /* size of on-disk direct blocks */ 185 TAILQ_ENTRY(inode) lfs_dchain; /* Dirop chain. */ 186 TAILQ_ENTRY(inode) lfs_pchain; /* Paging chain. */ 187 TAILQ_ENTRY(inode) lfs_clean; /* Mount point cleaning inodes list */ 188 #define LFSI_NO_GOP_WRITE 0x01 189 #define LFSI_DELETED 0x02 190 #define LFSI_WRAPBLOCK 0x04 191 #define LFSI_WRAPWAIT 0x08 192 #define LFSI_BMAP 0x10 193 uint32_t lfs_iflags; /* Inode flags */ 194 daddr_t lfs_hiblk; /* Highest lbn held by inode */ 195 #ifdef _KERNEL 196 SPLAY_HEAD(lfs_splay, lbnentry) lfs_lbtree; /* Tree of balloc'd lbns */ 197 int lfs_nbtree; /* Size of tree */ 198 rb_tree_t lfs_segdhd; /* rbtree for truncation */ 199 #endif 200 int16_t lfs_odnlink; /* on-disk nlink count for cleaner */ 201 }; 202 #define i_lfs_osize inode_ext.lfs->lfs_osize 203 #define i_lfs_effnblks inode_ext.lfs->lfs_effnblocks 204 #define i_lfs_fragsize inode_ext.lfs->lfs_fragsize 205 #define i_lfs_clean inode_ext.lfs->lfs_clean 206 #define i_lfs_dchain inode_ext.lfs->lfs_dchain 207 #define i_lfs_pchain inode_ext.lfs->lfs_pchain 208 #define i_lfs_iflags inode_ext.lfs->lfs_iflags 209 #define i_lfs_hiblk inode_ext.lfs->lfs_hiblk 210 #define i_lfs_lbtree inode_ext.lfs->lfs_lbtree 211 #define i_lfs_nbtree inode_ext.lfs->lfs_nbtree 212 #define i_lfs_segdhd inode_ext.lfs->lfs_segdhd 213 #define i_lfs_odnlink inode_ext.lfs->lfs_odnlink 214 215 /* 216 * "struct buf" associated definitions 217 */ 218 219 #ifdef _KERNEL 220 221 # define LFS_IS_MALLOC_BUF(bp) ((bp)->b_iodone == lfs_free_aiodone) 222 223 /* log for debugging writes to the Ifile */ 224 # ifdef DEBUG 225 struct lfs_log_entry { 226 const char *op; 227 const char *file; 228 int pid; 229 int line; 230 daddr_t block; 231 unsigned long flags; 232 }; 233 extern int lfs_lognum; 234 extern struct lfs_log_entry lfs_log[LFS_LOGLENGTH]; 235 # define LFS_BWRITE_LOG(bp) lfs_bwrite_log((bp), __FILE__, __LINE__) 236 # define LFS_ENTER_LOG(theop, thefile, theline, lbn, theflags, thepid) do {\ 237 \ 238 mutex_enter(&lfs_lock); \ 239 lfs_log[lfs_lognum].op = theop; \ 240 lfs_log[lfs_lognum].file = thefile; \ 241 lfs_log[lfs_lognum].line = (theline); \ 242 lfs_log[lfs_lognum].pid = (thepid); \ 243 lfs_log[lfs_lognum].block = (lbn); \ 244 lfs_log[lfs_lognum].flags = (theflags); \ 245 lfs_lognum = (lfs_lognum + 1) % LFS_LOGLENGTH; \ 246 mutex_exit(&lfs_lock); \ 247 } while (0) 248 249 /* Must match list in lfs_vfsops.c ! */ 250 # define DLOG_RF 0 /* roll forward */ 251 # define DLOG_ALLOC 1 /* inode alloc */ 252 # define DLOG_AVAIL 2 /* lfs_{,r,f}avail */ 253 # define DLOG_FLUSH 3 /* flush */ 254 # define DLOG_LLIST 4 /* locked list accounting */ 255 # define DLOG_WVNODE 5 /* vflush/writevnodes verbose */ 256 # define DLOG_VNODE 6 /* vflush/writevnodes */ 257 # define DLOG_SEG 7 /* segwrite */ 258 # define DLOG_SU 8 /* seguse accounting */ 259 # define DLOG_CLEAN 9 /* cleaner routines */ 260 # define DLOG_MOUNT 10 /* mount/unmount */ 261 # define DLOG_PAGE 11 /* putpages/gop_write */ 262 # define DLOG_DIROP 12 /* dirop accounting */ 263 # define DLOG_MALLOC 13 /* lfs_malloc accounting */ 264 # define DLOG_MAX 14 /* The terminator */ 265 # define DLOG(a) lfs_debug_log a 266 # else /* ! DEBUG */ 267 # define LFS_BCLEAN_LOG(fs, bp) 268 # define LFS_BWRITE_LOG(bp) VOP_BWRITE((bp)->b_vp, (bp)) 269 # define LFS_ENTER_LOG(theop, thefile, theline, lbn, theflags, thepid) __nothing 270 # define DLOG(a) 271 # endif /* ! DEBUG */ 272 #else /* ! _KERNEL */ 273 # define LFS_BWRITE_LOG(bp) VOP_BWRITE((bp)) 274 #endif /* _KERNEL */ 275 276 277 #endif /* _UFS_LFS_LFS_INODE_H_ */ 278