1 /*- 2 * SPDX-License-Identifier: MIT-CMU 3 * 4 * Copyright (c) 1995 The University of Utah and 5 * the Computer Systems Laboratory at the University of Utah (CSL). 6 * All rights reserved. 7 * 8 * Permission to use, copy, modify and distribute this software is hereby 9 * granted provided that (1) source code retains these copyright, permission, 10 * and disclaimer notices, and (2) redistributions including binaries 11 * reproduce the notices in supporting documentation, and (3) all advertising 12 * materials mentioning features or use of this software display the following 13 * acknowledgement: ``This product includes software developed by the 14 * Computer Systems Laboratory at the University of Utah.'' 15 * 16 * THE UNIVERSITY OF UTAH AND CSL ALLOW FREE USE OF THIS SOFTWARE IN ITS "AS 17 * IS" CONDITION. THE UNIVERSITY OF UTAH AND CSL DISCLAIM ANY LIABILITY OF 18 * ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 19 * 20 * CSL requests users of this software to return to csl-dist@cs.utah.edu any 21 * improvements that they make and grant CSL redistribution rights. 22 * 23 * Utah $Hdr$ 24 * $FreeBSD$ 25 */ 26 27 /* 28 * routines to convert on disk ext2 inodes into inodes and back 29 */ 30 #include <sys/param.h> 31 #include <sys/systm.h> 32 #include <sys/endian.h> 33 #include <sys/lock.h> 34 #include <sys/sdt.h> 35 #include <sys/stat.h> 36 #include <sys/vnode.h> 37 38 #include <fs/ext2fs/fs.h> 39 #include <fs/ext2fs/inode.h> 40 #include <fs/ext2fs/ext2fs.h> 41 #include <fs/ext2fs/ext2_dinode.h> 42 #include <fs/ext2fs/ext2_extern.h> 43 44 SDT_PROVIDER_DECLARE(ext2fs); 45 /* 46 * ext2fs trace probe: 47 * arg0: verbosity. Higher numbers give more verbose messages 48 * arg1: Textual message 49 */ 50 SDT_PROBE_DEFINE2(ext2fs, , trace, inode_cnv, "int", "char*"); 51 52 #ifdef EXT2FS_PRINT_EXTENTS 53 void 54 ext2_print_inode(struct inode *in) 55 { 56 int i; 57 struct ext4_extent_header *ehp; 58 struct ext4_extent *ep; 59 60 printf("Inode: %5ju", (uintmax_t)in->i_number); 61 printf( /* "Inode: %5d" */ 62 " Type: %10s Mode: 0x%o Flags: 0x%x Version: %d acl: 0x%jx\n", 63 "n/a", in->i_mode, in->i_flags, in->i_gen, in->i_facl); 64 printf("User: %5u Group: %5u Size: %ju\n", 65 in->i_uid, in->i_gid, (uintmax_t)in->i_size); 66 printf("Links: %3d Blockcount: %ju\n", 67 in->i_nlink, (uintmax_t)in->i_blocks); 68 printf("ctime: 0x%x ", in->i_ctime); 69 printf("atime: 0x%x ", in->i_atime); 70 printf("mtime: 0x%x ", in->i_mtime); 71 if (E2DI_HAS_XTIME(in)) 72 printf("crtime %#x\n", in->i_birthtime); 73 else 74 printf("\n"); 75 if (in->i_flag & IN_E4EXTENTS) { 76 printf("Extents:\n"); 77 ehp = (struct ext4_extent_header *)in->i_db; 78 printf("Header (magic 0x%x entries %d max %d depth %d gen %d)\n", 79 le16toh(ehp->eh_magic), le16toh(ehp->eh_ecount), 80 le16toh(ehp->eh_max), le16toh(ehp->eh_depth), 81 le32toh(ehp->eh_gen)); 82 ep = (struct ext4_extent *)(char *)(ehp + 1); 83 printf("Index (blk %d len %d start_lo %d start_hi %d)\n", 84 le32toh(ep->e_blk), 85 le16toh(ep->e_len), le32toh(ep->e_start_lo), 86 le16toh(ep->e_start_hi)); 87 printf("\n"); 88 } else { 89 printf("BLOCKS:"); 90 for (i = 0; i < (in->i_blocks <= 24 ? (in->i_blocks + 1) / 2 : 12); i++) 91 printf(" %d", in->i_db[i]); 92 printf("\n"); 93 } 94 } 95 #endif /* EXT2FS_PRINT_EXTENTS */ 96 97 #define XTIME_TO_NSEC(x) ((le32toh(x) & EXT3_NSEC_MASK) >> 2) 98 99 /* 100 * raw ext2 inode LE to host inode conversion 101 */ 102 int 103 ext2_ei2i(struct ext2fs_dinode *ei, struct inode *ip) 104 { 105 struct m_ext2fs *fs = ip->i_e2fs; 106 uint32_t ei_flags_host; 107 uint16_t ei_extra_isize_le; 108 int i; 109 110 if ((ip->i_number < EXT2_FIRST_INO(fs) && ip->i_number != EXT2_ROOTINO) || 111 (ip->i_number < EXT2_ROOTINO) || 112 (ip->i_number > le32toh(fs->e2fs->e2fs_icount))) { 113 SDT_PROBE2(ext2fs, , trace, inode_cnv, 1, "bad inode number"); 114 return (EINVAL); 115 } 116 117 ip->i_nlink = le16toh(ei->e2di_nlink); 118 if (ip->i_number == EXT2_ROOTINO && ip->i_nlink == 0) { 119 SDT_PROBE2(ext2fs, , trace, inode_cnv, 1, "root inode unallocated"); 120 return (EINVAL); 121 } 122 123 /* Check extra inode size */ 124 ei_extra_isize_le = le16toh(ei->e2di_extra_isize); 125 if (EXT2_INODE_SIZE(fs) > E2FS_REV0_INODE_SIZE) { 126 if (E2FS_REV0_INODE_SIZE + ei_extra_isize_le > 127 EXT2_INODE_SIZE(fs) || (ei_extra_isize_le & 3)) { 128 SDT_PROBE2(ext2fs, , trace, inode_cnv, 1, 129 "bad extra inode size"); 130 return (EINVAL); 131 } 132 } 133 134 /* 135 * Godmar thinks - if the link count is zero, then the inode is 136 * unused - according to ext2 standards. Ufs marks this fact by 137 * setting i_mode to zero - why ? I can see that this might lead to 138 * problems in an undelete. 139 */ 140 ip->i_mode = ip->i_nlink ? le16toh(ei->e2di_mode) : 0; 141 ip->i_size = le32toh(ei->e2di_size); 142 if (S_ISREG(ip->i_mode)) 143 ip->i_size |= (uint64_t)le32toh(ei->e2di_size_high) << 32; 144 ip->i_atime = le32toh(ei->e2di_atime); 145 ip->i_mtime = le32toh(ei->e2di_mtime); 146 ip->i_ctime = le32toh(ei->e2di_ctime); 147 if (E2DI_HAS_XTIME(ip)) { 148 ip->i_atimensec = XTIME_TO_NSEC(ei->e2di_atime_extra); 149 ip->i_mtimensec = XTIME_TO_NSEC(ei->e2di_mtime_extra); 150 ip->i_ctimensec = XTIME_TO_NSEC(ei->e2di_ctime_extra); 151 ip->i_birthtime = le32toh(ei->e2di_crtime); 152 ip->i_birthnsec = XTIME_TO_NSEC(ei->e2di_crtime_extra); 153 } 154 ip->i_flags = 0; 155 ei_flags_host = le32toh(ei->e2di_flags); 156 ip->i_flags |= (ei_flags_host & EXT2_APPEND) ? SF_APPEND : 0; 157 ip->i_flags |= (ei_flags_host & EXT2_IMMUTABLE) ? SF_IMMUTABLE : 0; 158 ip->i_flags |= (ei_flags_host & EXT2_NODUMP) ? UF_NODUMP : 0; 159 ip->i_flag |= (ei_flags_host & EXT3_INDEX) ? IN_E3INDEX : 0; 160 ip->i_flag |= (ei_flags_host & EXT4_EXTENTS) ? IN_E4EXTENTS : 0; 161 ip->i_blocks = le32toh(ei->e2di_nblock); 162 ip->i_facl = le32toh(ei->e2di_facl); 163 if (E2DI_HAS_HUGE_FILE(ip)) { 164 ip->i_blocks |= (uint64_t)le16toh(ei->e2di_nblock_high) << 32; 165 ip->i_facl |= (uint64_t)le16toh(ei->e2di_facl_high) << 32; 166 if (ei_flags_host & EXT4_HUGE_FILE) 167 ip->i_blocks = fsbtodb(ip->i_e2fs, ip->i_blocks); 168 } 169 ip->i_gen = le32toh(ei->e2di_gen); 170 ip->i_uid = le16toh(ei->e2di_uid); 171 ip->i_gid = le16toh(ei->e2di_gid); 172 ip->i_uid |= (uint32_t)le16toh(ei->e2di_uid_high) << 16; 173 ip->i_gid |= (uint32_t)le16toh(ei->e2di_gid_high) << 16; 174 175 if ((ip->i_flag & IN_E4EXTENTS)) { 176 memcpy(ip->i_data, ei->e2di_blocks, sizeof(ei->e2di_blocks)); 177 } else { 178 for (i = 0; i < EXT2_NDADDR; i++) 179 ip->i_db[i] = le32toh(ei->e2di_blocks[i]); 180 for (i = 0; i < EXT2_NIADDR; i++) 181 ip->i_ib[i] = le32toh(ei->e2di_blocks[EXT2_NDIR_BLOCKS + i]); 182 } 183 184 /* Verify inode csum. */ 185 return (ext2_ei_csum_verify(ip, ei)); 186 } 187 188 #define NSEC_TO_XTIME(t) (htole32((t << 2) & EXT3_NSEC_MASK)) 189 190 /* 191 * inode to raw ext2 LE inode conversion 192 */ 193 int 194 ext2_i2ei(struct inode *ip, struct ext2fs_dinode *ei) 195 { 196 struct m_ext2fs *fs; 197 int i; 198 199 fs = ip->i_e2fs; 200 ei->e2di_mode = htole16(ip->i_mode); 201 ei->e2di_nlink = htole16(ip->i_nlink); 202 ei->e2di_size = htole32(ip->i_size); 203 if (S_ISREG(ip->i_mode)) 204 ei->e2di_size_high = htole32(ip->i_size >> 32); 205 ei->e2di_atime = htole32(ip->i_atime); 206 ei->e2di_mtime = htole32(ip->i_mtime); 207 ei->e2di_ctime = htole32(ip->i_ctime); 208 /* 209 * Godmar thinks: if dtime is nonzero, ext2 says this inode has been 210 * deleted, this would correspond to a zero link count 211 */ 212 ei->e2di_dtime = htole32(le16toh(ei->e2di_nlink) ? 0 : 213 le32toh(ei->e2di_mtime)); 214 if (E2DI_HAS_XTIME(ip)) { 215 ei->e2di_ctime_extra = NSEC_TO_XTIME(ip->i_ctimensec); 216 ei->e2di_mtime_extra = NSEC_TO_XTIME(ip->i_mtimensec); 217 ei->e2di_atime_extra = NSEC_TO_XTIME(ip->i_atimensec); 218 ei->e2di_crtime = htole32(ip->i_birthtime); 219 ei->e2di_crtime_extra = NSEC_TO_XTIME(ip->i_birthnsec); 220 } 221 /* Keep these in host endian for a while since they change a lot */ 222 ei->e2di_flags = 0; 223 ei->e2di_flags |= htole32((ip->i_flags & SF_APPEND) ? EXT2_APPEND : 0); 224 ei->e2di_flags |= htole32((ip->i_flags & SF_IMMUTABLE) ? EXT2_IMMUTABLE : 0); 225 ei->e2di_flags |= htole32((ip->i_flags & UF_NODUMP) ? EXT2_NODUMP : 0); 226 ei->e2di_flags |= htole32((ip->i_flag & IN_E3INDEX) ? EXT3_INDEX : 0); 227 ei->e2di_flags |= htole32((ip->i_flag & IN_E4EXTENTS) ? EXT4_EXTENTS : 0); 228 if (ip->i_blocks > ~0U && 229 !EXT2_HAS_RO_COMPAT_FEATURE(fs, EXT2F_ROCOMPAT_HUGE_FILE)) { 230 SDT_PROBE2(ext2fs, , trace, inode_cnv, 1, "i_blocks value is out of range"); 231 return (EIO); 232 } 233 if (ip->i_blocks <= 0xffffffffffffULL) { 234 ei->e2di_nblock = htole32(ip->i_blocks & 0xffffffff); 235 ei->e2di_nblock_high = htole16(ip->i_blocks >> 32 & 0xffff); 236 } else { 237 ei->e2di_flags |= htole32(EXT4_HUGE_FILE); 238 ei->e2di_nblock = htole32(dbtofsb(fs, ip->i_blocks)); 239 ei->e2di_nblock_high = htole16(dbtofsb(fs, ip->i_blocks) >> 32 & 0xffff); 240 } 241 242 ei->e2di_facl = htole32(ip->i_facl & 0xffffffff); 243 ei->e2di_facl_high = htole16(ip->i_facl >> 32 & 0xffff); 244 ei->e2di_gen = htole32(ip->i_gen); 245 ei->e2di_uid = htole16(ip->i_uid & 0xffff); 246 ei->e2di_uid_high = htole16(ip->i_uid >> 16 & 0xffff); 247 ei->e2di_gid = htole16(ip->i_gid & 0xffff); 248 ei->e2di_gid_high = htole16(ip->i_gid >> 16 & 0xffff); 249 250 if ((ip->i_flag & IN_E4EXTENTS)) { 251 memcpy(ei->e2di_blocks, ip->i_data, sizeof(ei->e2di_blocks)); 252 } else { 253 for (i = 0; i < EXT2_NDADDR; i++) 254 ei->e2di_blocks[i] = htole32(ip->i_db[i]); 255 for (i = 0; i < EXT2_NIADDR; i++) 256 ei->e2di_blocks[EXT2_NDIR_BLOCKS + i] = htole32(ip->i_ib[i]); 257 } 258 259 /* Set inode csum. */ 260 ext2_ei_csum_set(ip, ei); 261 262 return (0); 263 } 264