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 _FS_EXT2FS_INODE_H_ 38 #define _FS_EXT2FS_INODE_H_ 39 40 #include <sys/param.h> 41 #include <sys/lock.h> 42 #include <sys/mutex.h> 43 #include <sys/queue.h> 44 #include <sys/buf.h> 45 46 #include <fs/ext2fs/ext2_extents.h> 47 48 /* 49 * This must agree with the definition in <ufs/ufs/dir.h>. 50 */ 51 #define doff_t int32_t 52 53 #define EXT2_NDADDR 12 /* Direct addresses in inode. */ 54 #define EXT2_NIADDR 3 /* Indirect addresses in inode. */ 55 56 /* 57 * The size of physical and logical block numbers in EXT2FS. 58 */ 59 typedef uint32_t e2fs_daddr_t; 60 typedef int64_t e2fs_lbn_t; 61 typedef int64_t e4fs_daddr_t; 62 typedef int64_t ext_time_t; 63 64 /* 65 * The inode is used to describe each active (or recently active) file in the 66 * EXT2FS filesystem. It is composed of two types of information. The first 67 * part is the information that is needed only while the file is active (such 68 * as the identity of the file and linkage to speed its lookup). The second 69 * part is the permanent meta-data associated with the file which is read in 70 * from the permanent dinode from long term storage when the file becomes 71 * active, and is put back when the file is no longer being used. 72 */ 73 struct inode { 74 struct vnode *i_vnode;/* Vnode associated with this inode. */ 75 struct ext2mount *i_ump; 76 uint32_t i_flag; /* flags, see below */ 77 ino_t i_number; /* The identity of the inode. */ 78 79 struct m_ext2fs *i_e2fs; /* EXT2FS */ 80 u_quad_t i_modrev; /* Revision level for NFS lease. */ 81 /* 82 * Side effects; used during directory lookup. 83 */ 84 int32_t i_count; /* Size of free slot in directory. */ 85 doff_t i_endoff; /* End of useful stuff in directory. */ 86 doff_t i_diroff; /* Offset in dir, where we found last entry. */ 87 doff_t i_offset; /* Offset of free space in directory. */ 88 89 uint32_t i_block_group; 90 uint32_t i_next_alloc_block; 91 uint32_t i_next_alloc_goal; 92 93 /* Fields from struct dinode in UFS. */ 94 uint16_t i_mode; /* IFMT, permissions; see below. */ 95 int32_t i_nlink; /* File link count. */ 96 uint32_t i_uid; /* File owner. */ 97 uint32_t i_gid; /* File group. */ 98 uint64_t i_size; /* File byte count. */ 99 uint64_t i_blocks; /* Blocks actually held. */ 100 ext_time_t i_atime; /* Last access time. */ 101 ext_time_t i_mtime; /* Last modified time. */ 102 ext_time_t i_ctime; /* Last inode change time. */ 103 ext_time_t i_birthtime; /* Inode creation time. */ 104 int32_t i_mtimensec; /* Last modified time. */ 105 int32_t i_atimensec; /* Last access time. */ 106 int32_t i_ctimensec; /* Last inode change time. */ 107 int32_t i_birthnsec; /* Inode creation time. */ 108 uint32_t i_gen; /* Generation number. */ 109 uint64_t i_facl; /* EA block number. */ 110 uint32_t i_flags; /* Status flags (chflags). */ 111 dev_t i_rdev; /* Major/minor inode values. */ 112 union { 113 struct { 114 uint32_t i_db[EXT2_NDADDR]; /* Direct disk blocks. */ 115 uint32_t i_ib[EXT2_NIADDR]; /* Indirect disk blocks. */ 116 }; 117 uint32_t i_data[EXT2_NDADDR + EXT2_NIADDR]; 118 }; 119 120 struct ext4_extent_cache i_ext_cache; /* cache for ext4 extent */ 121 122 struct vn_clusterw i_clusterw; /* Buffer clustering information */ 123 }; 124 125 /* 126 * The di_db fields may be overlaid with other information for 127 * file types that do not have associated disk storage. Block 128 * and character devices overlay the first data block with their 129 * dev_t value. Short symbolic links place their path in the 130 * di_db area. 131 */ 132 #define i_shortlink i_db 133 134 /* File permissions. */ 135 #define IEXEC 0000100 /* Executable. */ 136 #define IWRITE 0000200 /* Writeable. */ 137 #define IREAD 0000400 /* Readable. */ 138 #define ISVTX 0001000 /* Sticky bit. */ 139 #define ISGID 0002000 /* Set-gid. */ 140 #define ISUID 0004000 /* Set-uid. */ 141 142 /* File types. */ 143 #define IFMT 0170000 /* Mask of file type. */ 144 #define IFIFO 0010000 /* Named pipe (fifo). */ 145 #define IFCHR 0020000 /* Character device. */ 146 #define IFDIR 0040000 /* Directory file. */ 147 #define IFBLK 0060000 /* Block device. */ 148 #define IFREG 0100000 /* Regular file. */ 149 #define IFLNK 0120000 /* Symbolic link. */ 150 #define IFSOCK 0140000 /* UNIX domain socket. */ 151 #define IFWHT 0160000 /* Whiteout. */ 152 153 /* These flags are kept in i_flag. */ 154 #define IN_ACCESS 0x0001 /* Access time update request. */ 155 #define IN_CHANGE 0x0002 /* Inode change time update request. */ 156 #define IN_UPDATE 0x0004 /* Modification time update request. */ 157 #define IN_MODIFIED 0x0008 /* Inode has been modified. */ 158 #define IN_RENAME 0x0010 /* Inode is being renamed. */ 159 #define IN_HASHED 0x0020 /* Inode is on hash list */ 160 #define IN_LAZYMOD 0x0040 /* Modified, but don't write yet. */ 161 #define IN_SPACECOUNTED 0x0080 /* Blocks to be freed in free count. */ 162 #define IN_LAZYACCESS 0x0100 /* Process IN_ACCESS after the 163 suspension finished */ 164 165 /* 166 * These are translation flags for some attributes that Ext4 167 * passes as inode flags but that we cannot pass directly. 168 */ 169 #define IN_E3INDEX 0x010000 170 #define IN_E4EXTENTS 0x020000 171 172 #define i_devvp i_ump->um_devvp 173 174 #ifdef _KERNEL 175 /* 176 * Structure used to pass around logical block paths generated by 177 * ext2_getlbns and used by truncate and bmap code. 178 */ 179 struct indir { 180 e2fs_lbn_t in_lbn; /* Logical block number. */ 181 int in_off; /* Offset in buffer. */ 182 }; 183 184 /* Convert between inode pointers and vnode pointers. */ 185 #define VTOI(vp) ((struct inode *)(vp)->v_data) 186 #define ITOV(ip) ((ip)->i_vnode) 187 188 /* This overlays the fid structure (see mount.h). */ 189 struct ufid { 190 uint16_t ufid_len; /* Length of structure. */ 191 uint16_t ufid_pad; /* Force 32-bit alignment. */ 192 uint32_t ufid_gen; /* Generation number. */ 193 ino_t ufid_ino; /* File number (ino). */ 194 }; 195 #endif /* _KERNEL */ 196 197 #endif /* !_FS_EXT2FS_INODE_H_ */ 198