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/stat.h> 35 #include <sys/vnode.h> 36 37 #include <vfs/ext2fs/fs.h> 38 #include <vfs/ext2fs/inode.h> 39 #include <vfs/ext2fs/ext2fs.h> 40 #include <vfs/ext2fs/ext2_dinode.h> 41 #include <vfs/ext2fs/ext2_extern.h> 42 43 SDT_PROVIDER_DECLARE(ext2fs); 44 /* 45 * ext2fs trace probe: 46 * arg0: verbosity. Higher numbers give more verbose messages 47 * arg1: Textual message 48 */ 49 SDT_PROBE_DEFINE2(ext2fs, , trace, inode_cnv, "int", "char*"); 50 51 #ifdef EXT2FS_PRINT_EXTENTS 52 void 53 ext2_print_inode(struct inode *in) 54 { 55 int i; 56 struct ext4_extent_header *ehp; 57 struct ext4_extent *ep; 58 59 printf("Inode: %5ju", (uintmax_t)in->i_number); 60 printf( /* "Inode: %5d" */ 61 " Type: %10s Mode: 0x%o Flags: 0x%x Version: %d acl: 0x%jx\n", 62 "n/a", in->i_mode, in->i_flags, in->i_gen, in->i_facl); 63 printf("User: %5u Group: %5u Size: %ju\n", 64 in->i_uid, in->i_gid, (uintmax_t)in->i_size); 65 printf("Links: %3d Blockcount: %ju\n", 66 in->i_nlink, (uintmax_t)in->i_blocks); 67 printf("ctime: 0x%x ", in->i_ctime); 68 printf("atime: 0x%x ", in->i_atime); 69 printf("mtime: 0x%x ", in->i_mtime); 70 if (E2DI_HAS_XTIME(in)) 71 printf("crtime %#x\n", in->i_birthtime); 72 else 73 printf("\n"); 74 if (in->i_flag & IN_E4EXTENTS) { 75 printf("Extents:\n"); 76 ehp = (struct ext4_extent_header *)in->i_db; 77 printf("Header (magic 0x%x entries %d max %d depth %d gen %d)\n", 78 le16toh(ehp->eh_magic), le16toh(ehp->eh_ecount), 79 le16toh(ehp->eh_max), le16toh(ehp->eh_depth), 80 le32toh(ehp->eh_gen)); 81 ep = (struct ext4_extent *)(char *)(ehp + 1); 82 printf("Index (blk %d len %d start_lo %d start_hi %d)\n", 83 le32toh(ep->e_blk), 84 le16toh(ep->e_len), le32toh(ep->e_start_lo), 85 le16toh(ep->e_start_hi)); 86 printf("\n"); 87 } else { 88 printf("BLOCKS:"); 89 for (i = 0; i < (in->i_blocks <= 24 ? (in->i_blocks + 1) / 2 : 12); i++) 90 printf(" %d", in->i_db[i]); 91 printf("\n"); 92 } 93 } 94 #endif /* EXT2FS_PRINT_EXTENTS */ 95 96 static inline void 97 ext2_decode_extra_time(ext_time_t *sec, int32_t *nsec, uint32_t extra) 98 { 99 if (extra & htole32(EXT3_EPOCH_MASK)) 100 *sec += (uint64_t)(le32toh(extra) & EXT3_EPOCH_MASK) << 32; 101 102 *nsec = (le32toh(extra) & EXT3_NSEC_MASK) >> EXT3_EPOCH_BITS; 103 } 104 105 /* 106 * raw ext2 inode LE to host inode conversion 107 */ 108 int 109 ext2_ei2i(struct ext2fs_dinode *ei, struct inode *ip) 110 { 111 struct m_ext2fs *fs = ip->i_e2fs; 112 uint32_t ei_flags_host; 113 uint16_t ei_extra_isize_le; 114 int i; 115 116 if ((ip->i_number < EXT2_FIRST_INO(fs) && ip->i_number != EXT2_ROOTINO) || 117 (ip->i_number < EXT2_ROOTINO) || 118 (ip->i_number > le32toh(fs->e2fs->e2fs_icount))) { 119 SDT_PROBE2(ext2fs, , trace, inode_cnv, 1, "bad inode number"); 120 return (EINVAL); 121 } 122 123 ip->i_nlink = le16toh(ei->e2di_nlink); 124 if (ip->i_number == EXT2_ROOTINO && ip->i_nlink == 0) { 125 SDT_PROBE2(ext2fs, , trace, inode_cnv, 1, "root inode unallocated"); 126 return (EINVAL); 127 } 128 129 /* Check extra inode size */ 130 ei_extra_isize_le = le16toh(ei->e2di_extra_isize); 131 if (EXT2_INODE_SIZE(fs) > E2FS_REV0_INODE_SIZE) { 132 if (E2FS_REV0_INODE_SIZE + ei_extra_isize_le > 133 EXT2_INODE_SIZE(fs) || (ei_extra_isize_le & 3)) { 134 SDT_PROBE2(ext2fs, , trace, inode_cnv, 1, 135 "bad extra inode size"); 136 return (EINVAL); 137 } 138 } 139 140 /* 141 * Godmar thinks - if the link count is zero, then the inode is 142 * unused - according to ext2 standards. Ufs marks this fact by 143 * setting i_mode to zero - why ? I can see that this might lead to 144 * problems in an undelete. 145 */ 146 ip->i_mode = ip->i_nlink ? le16toh(ei->e2di_mode) : 0; 147 ip->i_size = le32toh(ei->e2di_size); 148 if (S_ISREG(ip->i_mode)) 149 ip->i_size |= (uint64_t)le32toh(ei->e2di_size_high) << 32; 150 ip->i_atime = (signed)le32toh(ei->e2di_atime); 151 ip->i_mtime = (signed)le32toh(ei->e2di_mtime); 152 ip->i_ctime = (signed)le32toh(ei->e2di_ctime); 153 if (E2DI_HAS_XTIME(ip)) { 154 ext2_decode_extra_time(&ip->i_atime, &ip->i_atimensec, 155 ei->e2di_atime_extra); 156 ext2_decode_extra_time(&ip->i_mtime, &ip->i_mtimensec, 157 ei->e2di_mtime_extra); 158 ext2_decode_extra_time(&ip->i_ctime, &ip->i_ctimensec, 159 ei->e2di_ctime_extra); 160 ip->i_birthtime = (signed)le32toh(ei->e2di_crtime); 161 ext2_decode_extra_time(&ip->i_birthtime, &ip->i_birthnsec, 162 ei->e2di_crtime_extra); 163 } 164 ip->i_flags = 0; 165 ei_flags_host = le32toh(ei->e2di_flags); 166 ip->i_flags |= (ei_flags_host & EXT2_APPEND) ? SF_APPEND : 0; 167 ip->i_flags |= (ei_flags_host & EXT2_IMMUTABLE) ? SF_IMMUTABLE : 0; 168 ip->i_flags |= (ei_flags_host & EXT2_NODUMP) ? UF_NODUMP : 0; 169 ip->i_flag |= (ei_flags_host & EXT3_INDEX) ? IN_E3INDEX : 0; 170 ip->i_flag |= (ei_flags_host & EXT4_EXTENTS) ? IN_E4EXTENTS : 0; 171 ip->i_blocks = le32toh(ei->e2di_nblock); 172 ip->i_facl = le32toh(ei->e2di_facl); 173 if (E2DI_HAS_HUGE_FILE(ip)) { 174 ip->i_blocks |= (uint64_t)le16toh(ei->e2di_nblock_high) << 32; 175 ip->i_facl |= (uint64_t)le16toh(ei->e2di_facl_high) << 32; 176 if (ei_flags_host & EXT4_HUGE_FILE) 177 ip->i_blocks = fsbtodb(ip->i_e2fs, ip->i_blocks); 178 } 179 ip->i_gen = le32toh(ei->e2di_gen); 180 ip->i_uid = le16toh(ei->e2di_uid); 181 ip->i_gid = le16toh(ei->e2di_gid); 182 ip->i_uid |= (uint32_t)le16toh(ei->e2di_uid_high) << 16; 183 ip->i_gid |= (uint32_t)le16toh(ei->e2di_gid_high) << 16; 184 185 if ((ip->i_flag & IN_E4EXTENTS)) { 186 memcpy(ip->i_data, ei->e2di_blocks, sizeof(ei->e2di_blocks)); 187 } else { 188 for (i = 0; i < EXT2_NDADDR; i++) 189 ip->i_db[i] = le32toh(ei->e2di_blocks[i]); 190 for (i = 0; i < EXT2_NIADDR; i++) 191 ip->i_ib[i] = le32toh(ei->e2di_blocks[EXT2_NDIR_BLOCKS + i]); 192 } 193 194 /* Verify inode csum. */ 195 return (ext2_ei_csum_verify(ip, ei)); 196 } 197 198 static inline uint32_t 199 ext2_encode_extra_time(int64_t sec, int32_t nsec) 200 { 201 uint32_t extra; 202 203 extra = ((sec - (int32_t)sec) >> 32) & EXT3_EPOCH_MASK; 204 205 return (htole32(extra | (nsec << EXT3_EPOCH_BITS))); 206 } 207 208 /* 209 * inode to raw ext2 LE inode conversion 210 */ 211 int 212 ext2_i2ei(struct inode *ip, struct ext2fs_dinode *ei) 213 { 214 struct m_ext2fs *fs; 215 int i; 216 217 fs = ip->i_e2fs; 218 ei->e2di_mode = htole16(ip->i_mode); 219 ei->e2di_nlink = htole16(ip->i_nlink); 220 ei->e2di_size = htole32(ip->i_size); 221 if (S_ISREG(ip->i_mode)) 222 ei->e2di_size_high = htole32(ip->i_size >> 32); 223 ei->e2di_atime = htole32(ip->i_atime); 224 ei->e2di_mtime = htole32(ip->i_mtime); 225 ei->e2di_ctime = htole32(ip->i_ctime); 226 /* 227 * Godmar thinks: if dtime is nonzero, ext2 says this inode has been 228 * deleted, this would correspond to a zero link count 229 */ 230 ei->e2di_dtime = htole32(le16toh(ei->e2di_nlink) ? 0 : 231 le32toh(ei->e2di_mtime)); 232 if (E2DI_HAS_XTIME(ip)) { 233 ei->e2di_ctime_extra = ext2_encode_extra_time(ip->i_ctime, 234 ip->i_ctimensec); 235 ei->e2di_mtime_extra = ext2_encode_extra_time(ip->i_mtime, 236 ip->i_mtimensec); 237 ei->e2di_atime_extra = ext2_encode_extra_time(ip->i_atime, 238 ip->i_atimensec); 239 ei->e2di_crtime = htole32(ip->i_birthtime); 240 ei->e2di_crtime_extra = ext2_encode_extra_time(ip->i_birthtime, 241 ip->i_birthnsec); 242 } 243 /* Keep these in host endian for a while since they change a lot */ 244 ei->e2di_flags = 0; 245 ei->e2di_flags |= htole32((ip->i_flags & SF_APPEND) ? EXT2_APPEND : 0); 246 ei->e2di_flags |= htole32((ip->i_flags & SF_IMMUTABLE) ? EXT2_IMMUTABLE : 0); 247 ei->e2di_flags |= htole32((ip->i_flags & UF_NODUMP) ? EXT2_NODUMP : 0); 248 ei->e2di_flags |= htole32((ip->i_flag & IN_E3INDEX) ? EXT3_INDEX : 0); 249 ei->e2di_flags |= htole32((ip->i_flag & IN_E4EXTENTS) ? EXT4_EXTENTS : 0); 250 if (ip->i_blocks > ~0U && 251 !EXT2_HAS_RO_COMPAT_FEATURE(fs, EXT2F_ROCOMPAT_HUGE_FILE)) { 252 SDT_PROBE2(ext2fs, , trace, inode_cnv, 1, "i_blocks value is out of range"); 253 return (EIO); 254 } 255 if (ip->i_blocks <= 0xffffffffffffULL) { 256 ei->e2di_nblock = htole32(ip->i_blocks & 0xffffffff); 257 ei->e2di_nblock_high = htole16(ip->i_blocks >> 32 & 0xffff); 258 } else { 259 ei->e2di_flags |= htole32(EXT4_HUGE_FILE); 260 ei->e2di_nblock = htole32(dbtofsb(fs, ip->i_blocks)); 261 ei->e2di_nblock_high = htole16(dbtofsb(fs, ip->i_blocks) >> 32 & 0xffff); 262 } 263 264 ei->e2di_facl = htole32(ip->i_facl & 0xffffffff); 265 ei->e2di_facl_high = htole16(ip->i_facl >> 32 & 0xffff); 266 ei->e2di_gen = htole32(ip->i_gen); 267 ei->e2di_uid = htole16(ip->i_uid & 0xffff); 268 ei->e2di_uid_high = htole16(ip->i_uid >> 16 & 0xffff); 269 ei->e2di_gid = htole16(ip->i_gid & 0xffff); 270 ei->e2di_gid_high = htole16(ip->i_gid >> 16 & 0xffff); 271 272 if ((ip->i_flag & IN_E4EXTENTS)) { 273 memcpy(ei->e2di_blocks, ip->i_data, sizeof(ei->e2di_blocks)); 274 } else { 275 for (i = 0; i < EXT2_NDADDR; i++) 276 ei->e2di_blocks[i] = htole32(ip->i_db[i]); 277 for (i = 0; i < EXT2_NIADDR; i++) 278 ei->e2di_blocks[EXT2_NDIR_BLOCKS + i] = htole32(ip->i_ib[i]); 279 } 280 281 /* Set inode csum. */ 282 ext2_ei_csum_set(ip, ei); 283 284 return (0); 285 } 286