1c1d7c514SDavid Sterba // SPDX-License-Identifier: GPL-2.0 2557ea5ddSQu Wenruo /* 3557ea5ddSQu Wenruo * Copyright (C) Qu Wenruo 2017. All rights reserved. 4557ea5ddSQu Wenruo */ 5557ea5ddSQu Wenruo 6557ea5ddSQu Wenruo /* 7557ea5ddSQu Wenruo * The module is used to catch unexpected/corrupted tree block data. 8557ea5ddSQu Wenruo * Such behavior can be caused either by a fuzzed image or bugs. 9557ea5ddSQu Wenruo * 10557ea5ddSQu Wenruo * The objective is to do leaf/node validation checks when tree block is read 11557ea5ddSQu Wenruo * from disk, and check *every* possible member, so other code won't 12557ea5ddSQu Wenruo * need to checking them again. 13557ea5ddSQu Wenruo * 14557ea5ddSQu Wenruo * Due to the potential and unwanted damage, every checker needs to be 15557ea5ddSQu Wenruo * carefully reviewed otherwise so it does not prevent mount of valid images. 16557ea5ddSQu Wenruo */ 17557ea5ddSQu Wenruo 18557ea5ddSQu Wenruo #include "ctree.h" 19557ea5ddSQu Wenruo #include "tree-checker.h" 20557ea5ddSQu Wenruo #include "disk-io.h" 21557ea5ddSQu Wenruo #include "compression.h" 22fce466eaSQu Wenruo #include "volumes.h" 23557ea5ddSQu Wenruo 24bba4f298SQu Wenruo /* 25bba4f298SQu Wenruo * Error message should follow the following format: 26bba4f298SQu Wenruo * corrupt <type>: <identifier>, <reason>[, <bad_value>] 27bba4f298SQu Wenruo * 28bba4f298SQu Wenruo * @type: leaf or node 29bba4f298SQu Wenruo * @identifier: the necessary info to locate the leaf/node. 30bba4f298SQu Wenruo * It's recommened to decode key.objecitd/offset if it's 31bba4f298SQu Wenruo * meaningful. 32bba4f298SQu Wenruo * @reason: describe the error 33bba4f298SQu Wenruo * @bad_value: optional, it's recommened to output bad value and its 34bba4f298SQu Wenruo * expected value (range). 35bba4f298SQu Wenruo * 36bba4f298SQu Wenruo * Since comma is used to separate the components, only space is allowed 37bba4f298SQu Wenruo * inside each component. 38bba4f298SQu Wenruo */ 39bba4f298SQu Wenruo 40bba4f298SQu Wenruo /* 41bba4f298SQu Wenruo * Append generic "corrupt leaf/node root=%llu block=%llu slot=%d: " to @fmt. 42bba4f298SQu Wenruo * Allows callers to customize the output. 43bba4f298SQu Wenruo */ 44bba4f298SQu Wenruo __printf(4, 5) 45e67c718bSDavid Sterba __cold 462f659546SQu Wenruo static void generic_err(const struct btrfs_fs_info *fs_info, 47bba4f298SQu Wenruo const struct extent_buffer *eb, int slot, 48bba4f298SQu Wenruo const char *fmt, ...) 49bba4f298SQu Wenruo { 50bba4f298SQu Wenruo struct va_format vaf; 51bba4f298SQu Wenruo va_list args; 52bba4f298SQu Wenruo 53bba4f298SQu Wenruo va_start(args, fmt); 54bba4f298SQu Wenruo 55bba4f298SQu Wenruo vaf.fmt = fmt; 56bba4f298SQu Wenruo vaf.va = &args; 57bba4f298SQu Wenruo 582f659546SQu Wenruo btrfs_crit(fs_info, 59bba4f298SQu Wenruo "corrupt %s: root=%llu block=%llu slot=%d, %pV", 60bba4f298SQu Wenruo btrfs_header_level(eb) == 0 ? "leaf" : "node", 612f659546SQu Wenruo btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot, &vaf); 62bba4f298SQu Wenruo va_end(args); 63bba4f298SQu Wenruo } 64bba4f298SQu Wenruo 658806d718SQu Wenruo /* 668806d718SQu Wenruo * Customized reporter for extent data item, since its key objectid and 678806d718SQu Wenruo * offset has its own meaning. 688806d718SQu Wenruo */ 698806d718SQu Wenruo __printf(4, 5) 70e67c718bSDavid Sterba __cold 712f659546SQu Wenruo static void file_extent_err(const struct btrfs_fs_info *fs_info, 728806d718SQu Wenruo const struct extent_buffer *eb, int slot, 738806d718SQu Wenruo const char *fmt, ...) 748806d718SQu Wenruo { 758806d718SQu Wenruo struct btrfs_key key; 768806d718SQu Wenruo struct va_format vaf; 778806d718SQu Wenruo va_list args; 788806d718SQu Wenruo 798806d718SQu Wenruo btrfs_item_key_to_cpu(eb, &key, slot); 808806d718SQu Wenruo va_start(args, fmt); 818806d718SQu Wenruo 828806d718SQu Wenruo vaf.fmt = fmt; 838806d718SQu Wenruo vaf.va = &args; 848806d718SQu Wenruo 852f659546SQu Wenruo btrfs_crit(fs_info, 868806d718SQu Wenruo "corrupt %s: root=%llu block=%llu slot=%d ino=%llu file_offset=%llu, %pV", 872f659546SQu Wenruo btrfs_header_level(eb) == 0 ? "leaf" : "node", 882f659546SQu Wenruo btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot, 892f659546SQu Wenruo key.objectid, key.offset, &vaf); 908806d718SQu Wenruo va_end(args); 918806d718SQu Wenruo } 928806d718SQu Wenruo 938806d718SQu Wenruo /* 948806d718SQu Wenruo * Return 0 if the btrfs_file_extent_##name is aligned to @alignment 958806d718SQu Wenruo * Else return 1 968806d718SQu Wenruo */ 972f659546SQu Wenruo #define CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, name, alignment) \ 988806d718SQu Wenruo ({ \ 998806d718SQu Wenruo if (!IS_ALIGNED(btrfs_file_extent_##name((leaf), (fi)), (alignment))) \ 1002f659546SQu Wenruo file_extent_err((fs_info), (leaf), (slot), \ 1018806d718SQu Wenruo "invalid %s for file extent, have %llu, should be aligned to %u", \ 1028806d718SQu Wenruo (#name), btrfs_file_extent_##name((leaf), (fi)), \ 1038806d718SQu Wenruo (alignment)); \ 1048806d718SQu Wenruo (!IS_ALIGNED(btrfs_file_extent_##name((leaf), (fi)), (alignment))); \ 1058806d718SQu Wenruo }) 1068806d718SQu Wenruo 1072f659546SQu Wenruo static int check_extent_data_item(struct btrfs_fs_info *fs_info, 108557ea5ddSQu Wenruo struct extent_buffer *leaf, 109557ea5ddSQu Wenruo struct btrfs_key *key, int slot) 110557ea5ddSQu Wenruo { 111557ea5ddSQu Wenruo struct btrfs_file_extent_item *fi; 1122f659546SQu Wenruo u32 sectorsize = fs_info->sectorsize; 113557ea5ddSQu Wenruo u32 item_size = btrfs_item_size_nr(leaf, slot); 114557ea5ddSQu Wenruo 115557ea5ddSQu Wenruo if (!IS_ALIGNED(key->offset, sectorsize)) { 1162f659546SQu Wenruo file_extent_err(fs_info, leaf, slot, 1178806d718SQu Wenruo "unaligned file_offset for file extent, have %llu should be aligned to %u", 1188806d718SQu Wenruo key->offset, sectorsize); 119557ea5ddSQu Wenruo return -EUCLEAN; 120557ea5ddSQu Wenruo } 121557ea5ddSQu Wenruo 122557ea5ddSQu Wenruo fi = btrfs_item_ptr(leaf, slot, struct btrfs_file_extent_item); 123557ea5ddSQu Wenruo 124557ea5ddSQu Wenruo if (btrfs_file_extent_type(leaf, fi) > BTRFS_FILE_EXTENT_TYPES) { 1252f659546SQu Wenruo file_extent_err(fs_info, leaf, slot, 1268806d718SQu Wenruo "invalid type for file extent, have %u expect range [0, %u]", 1278806d718SQu Wenruo btrfs_file_extent_type(leaf, fi), 1288806d718SQu Wenruo BTRFS_FILE_EXTENT_TYPES); 129557ea5ddSQu Wenruo return -EUCLEAN; 130557ea5ddSQu Wenruo } 131557ea5ddSQu Wenruo 132557ea5ddSQu Wenruo /* 133557ea5ddSQu Wenruo * Support for new compression/encrption must introduce incompat flag, 134557ea5ddSQu Wenruo * and must be caught in open_ctree(). 135557ea5ddSQu Wenruo */ 136557ea5ddSQu Wenruo if (btrfs_file_extent_compression(leaf, fi) > BTRFS_COMPRESS_TYPES) { 1372f659546SQu Wenruo file_extent_err(fs_info, leaf, slot, 1388806d718SQu Wenruo "invalid compression for file extent, have %u expect range [0, %u]", 1398806d718SQu Wenruo btrfs_file_extent_compression(leaf, fi), 1408806d718SQu Wenruo BTRFS_COMPRESS_TYPES); 141557ea5ddSQu Wenruo return -EUCLEAN; 142557ea5ddSQu Wenruo } 143557ea5ddSQu Wenruo if (btrfs_file_extent_encryption(leaf, fi)) { 1442f659546SQu Wenruo file_extent_err(fs_info, leaf, slot, 1458806d718SQu Wenruo "invalid encryption for file extent, have %u expect 0", 1468806d718SQu Wenruo btrfs_file_extent_encryption(leaf, fi)); 147557ea5ddSQu Wenruo return -EUCLEAN; 148557ea5ddSQu Wenruo } 149557ea5ddSQu Wenruo if (btrfs_file_extent_type(leaf, fi) == BTRFS_FILE_EXTENT_INLINE) { 150557ea5ddSQu Wenruo /* Inline extent must have 0 as key offset */ 151557ea5ddSQu Wenruo if (key->offset) { 1522f659546SQu Wenruo file_extent_err(fs_info, leaf, slot, 1538806d718SQu Wenruo "invalid file_offset for inline file extent, have %llu expect 0", 1548806d718SQu Wenruo key->offset); 155557ea5ddSQu Wenruo return -EUCLEAN; 156557ea5ddSQu Wenruo } 157557ea5ddSQu Wenruo 158557ea5ddSQu Wenruo /* Compressed inline extent has no on-disk size, skip it */ 159557ea5ddSQu Wenruo if (btrfs_file_extent_compression(leaf, fi) != 160557ea5ddSQu Wenruo BTRFS_COMPRESS_NONE) 161557ea5ddSQu Wenruo return 0; 162557ea5ddSQu Wenruo 163557ea5ddSQu Wenruo /* Uncompressed inline extent size must match item size */ 164557ea5ddSQu Wenruo if (item_size != BTRFS_FILE_EXTENT_INLINE_DATA_START + 165557ea5ddSQu Wenruo btrfs_file_extent_ram_bytes(leaf, fi)) { 1662f659546SQu Wenruo file_extent_err(fs_info, leaf, slot, 1678806d718SQu Wenruo "invalid ram_bytes for uncompressed inline extent, have %u expect %llu", 1688806d718SQu Wenruo item_size, BTRFS_FILE_EXTENT_INLINE_DATA_START + 1698806d718SQu Wenruo btrfs_file_extent_ram_bytes(leaf, fi)); 170557ea5ddSQu Wenruo return -EUCLEAN; 171557ea5ddSQu Wenruo } 172557ea5ddSQu Wenruo return 0; 173557ea5ddSQu Wenruo } 174557ea5ddSQu Wenruo 175557ea5ddSQu Wenruo /* Regular or preallocated extent has fixed item size */ 176557ea5ddSQu Wenruo if (item_size != sizeof(*fi)) { 1772f659546SQu Wenruo file_extent_err(fs_info, leaf, slot, 178709a95c3SArnd Bergmann "invalid item size for reg/prealloc file extent, have %u expect %zu", 1798806d718SQu Wenruo item_size, sizeof(*fi)); 180557ea5ddSQu Wenruo return -EUCLEAN; 181557ea5ddSQu Wenruo } 1822f659546SQu Wenruo if (CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, ram_bytes, sectorsize) || 1832f659546SQu Wenruo CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, disk_bytenr, sectorsize) || 1842f659546SQu Wenruo CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, disk_num_bytes, sectorsize) || 1852f659546SQu Wenruo CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, offset, sectorsize) || 1862f659546SQu Wenruo CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, num_bytes, sectorsize)) 187557ea5ddSQu Wenruo return -EUCLEAN; 188557ea5ddSQu Wenruo return 0; 189557ea5ddSQu Wenruo } 190557ea5ddSQu Wenruo 1912f659546SQu Wenruo static int check_csum_item(struct btrfs_fs_info *fs_info, 1922f659546SQu Wenruo struct extent_buffer *leaf, struct btrfs_key *key, 1932f659546SQu Wenruo int slot) 194557ea5ddSQu Wenruo { 1952f659546SQu Wenruo u32 sectorsize = fs_info->sectorsize; 1962f659546SQu Wenruo u32 csumsize = btrfs_super_csum_size(fs_info->super_copy); 197557ea5ddSQu Wenruo 198557ea5ddSQu Wenruo if (key->objectid != BTRFS_EXTENT_CSUM_OBJECTID) { 1992f659546SQu Wenruo generic_err(fs_info, leaf, slot, 200d508c5f0SQu Wenruo "invalid key objectid for csum item, have %llu expect %llu", 201d508c5f0SQu Wenruo key->objectid, BTRFS_EXTENT_CSUM_OBJECTID); 202557ea5ddSQu Wenruo return -EUCLEAN; 203557ea5ddSQu Wenruo } 204557ea5ddSQu Wenruo if (!IS_ALIGNED(key->offset, sectorsize)) { 2052f659546SQu Wenruo generic_err(fs_info, leaf, slot, 206d508c5f0SQu Wenruo "unaligned key offset for csum item, have %llu should be aligned to %u", 207d508c5f0SQu Wenruo key->offset, sectorsize); 208557ea5ddSQu Wenruo return -EUCLEAN; 209557ea5ddSQu Wenruo } 210557ea5ddSQu Wenruo if (!IS_ALIGNED(btrfs_item_size_nr(leaf, slot), csumsize)) { 2112f659546SQu Wenruo generic_err(fs_info, leaf, slot, 212d508c5f0SQu Wenruo "unaligned item size for csum item, have %u should be aligned to %u", 213d508c5f0SQu Wenruo btrfs_item_size_nr(leaf, slot), csumsize); 214557ea5ddSQu Wenruo return -EUCLEAN; 215557ea5ddSQu Wenruo } 216557ea5ddSQu Wenruo return 0; 217557ea5ddSQu Wenruo } 218557ea5ddSQu Wenruo 219557ea5ddSQu Wenruo /* 220ad7b0368SQu Wenruo * Customized reported for dir_item, only important new info is key->objectid, 221ad7b0368SQu Wenruo * which represents inode number 222ad7b0368SQu Wenruo */ 223ad7b0368SQu Wenruo __printf(4, 5) 224e67c718bSDavid Sterba __cold 2252f659546SQu Wenruo static void dir_item_err(const struct btrfs_fs_info *fs_info, 226ad7b0368SQu Wenruo const struct extent_buffer *eb, int slot, 227ad7b0368SQu Wenruo const char *fmt, ...) 228ad7b0368SQu Wenruo { 229ad7b0368SQu Wenruo struct btrfs_key key; 230ad7b0368SQu Wenruo struct va_format vaf; 231ad7b0368SQu Wenruo va_list args; 232ad7b0368SQu Wenruo 233ad7b0368SQu Wenruo btrfs_item_key_to_cpu(eb, &key, slot); 234ad7b0368SQu Wenruo va_start(args, fmt); 235ad7b0368SQu Wenruo 236ad7b0368SQu Wenruo vaf.fmt = fmt; 237ad7b0368SQu Wenruo vaf.va = &args; 238ad7b0368SQu Wenruo 2392f659546SQu Wenruo btrfs_crit(fs_info, 240ad7b0368SQu Wenruo "corrupt %s: root=%llu block=%llu slot=%d ino=%llu, %pV", 2412f659546SQu Wenruo btrfs_header_level(eb) == 0 ? "leaf" : "node", 2422f659546SQu Wenruo btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot, 2432f659546SQu Wenruo key.objectid, &vaf); 244ad7b0368SQu Wenruo va_end(args); 245ad7b0368SQu Wenruo } 246ad7b0368SQu Wenruo 2472f659546SQu Wenruo static int check_dir_item(struct btrfs_fs_info *fs_info, 248ad7b0368SQu Wenruo struct extent_buffer *leaf, 249ad7b0368SQu Wenruo struct btrfs_key *key, int slot) 250ad7b0368SQu Wenruo { 251ad7b0368SQu Wenruo struct btrfs_dir_item *di; 252ad7b0368SQu Wenruo u32 item_size = btrfs_item_size_nr(leaf, slot); 253ad7b0368SQu Wenruo u32 cur = 0; 254ad7b0368SQu Wenruo 255ad7b0368SQu Wenruo di = btrfs_item_ptr(leaf, slot, struct btrfs_dir_item); 256ad7b0368SQu Wenruo while (cur < item_size) { 257ad7b0368SQu Wenruo u32 name_len; 258ad7b0368SQu Wenruo u32 data_len; 259ad7b0368SQu Wenruo u32 max_name_len; 260ad7b0368SQu Wenruo u32 total_size; 261ad7b0368SQu Wenruo u32 name_hash; 262ad7b0368SQu Wenruo u8 dir_type; 263ad7b0368SQu Wenruo 264ad7b0368SQu Wenruo /* header itself should not cross item boundary */ 265ad7b0368SQu Wenruo if (cur + sizeof(*di) > item_size) { 2662f659546SQu Wenruo dir_item_err(fs_info, leaf, slot, 2677cfad652SArnd Bergmann "dir item header crosses item boundary, have %zu boundary %u", 268ad7b0368SQu Wenruo cur + sizeof(*di), item_size); 269ad7b0368SQu Wenruo return -EUCLEAN; 270ad7b0368SQu Wenruo } 271ad7b0368SQu Wenruo 272ad7b0368SQu Wenruo /* dir type check */ 273ad7b0368SQu Wenruo dir_type = btrfs_dir_type(leaf, di); 274ad7b0368SQu Wenruo if (dir_type >= BTRFS_FT_MAX) { 2752f659546SQu Wenruo dir_item_err(fs_info, leaf, slot, 276ad7b0368SQu Wenruo "invalid dir item type, have %u expect [0, %u)", 277ad7b0368SQu Wenruo dir_type, BTRFS_FT_MAX); 278ad7b0368SQu Wenruo return -EUCLEAN; 279ad7b0368SQu Wenruo } 280ad7b0368SQu Wenruo 281ad7b0368SQu Wenruo if (key->type == BTRFS_XATTR_ITEM_KEY && 282ad7b0368SQu Wenruo dir_type != BTRFS_FT_XATTR) { 2832f659546SQu Wenruo dir_item_err(fs_info, leaf, slot, 284ad7b0368SQu Wenruo "invalid dir item type for XATTR key, have %u expect %u", 285ad7b0368SQu Wenruo dir_type, BTRFS_FT_XATTR); 286ad7b0368SQu Wenruo return -EUCLEAN; 287ad7b0368SQu Wenruo } 288ad7b0368SQu Wenruo if (dir_type == BTRFS_FT_XATTR && 289ad7b0368SQu Wenruo key->type != BTRFS_XATTR_ITEM_KEY) { 2902f659546SQu Wenruo dir_item_err(fs_info, leaf, slot, 291ad7b0368SQu Wenruo "xattr dir type found for non-XATTR key"); 292ad7b0368SQu Wenruo return -EUCLEAN; 293ad7b0368SQu Wenruo } 294ad7b0368SQu Wenruo if (dir_type == BTRFS_FT_XATTR) 295ad7b0368SQu Wenruo max_name_len = XATTR_NAME_MAX; 296ad7b0368SQu Wenruo else 297ad7b0368SQu Wenruo max_name_len = BTRFS_NAME_LEN; 298ad7b0368SQu Wenruo 299ad7b0368SQu Wenruo /* Name/data length check */ 300ad7b0368SQu Wenruo name_len = btrfs_dir_name_len(leaf, di); 301ad7b0368SQu Wenruo data_len = btrfs_dir_data_len(leaf, di); 302ad7b0368SQu Wenruo if (name_len > max_name_len) { 3032f659546SQu Wenruo dir_item_err(fs_info, leaf, slot, 304ad7b0368SQu Wenruo "dir item name len too long, have %u max %u", 305ad7b0368SQu Wenruo name_len, max_name_len); 306ad7b0368SQu Wenruo return -EUCLEAN; 307ad7b0368SQu Wenruo } 3082f659546SQu Wenruo if (name_len + data_len > BTRFS_MAX_XATTR_SIZE(fs_info)) { 3092f659546SQu Wenruo dir_item_err(fs_info, leaf, slot, 310ad7b0368SQu Wenruo "dir item name and data len too long, have %u max %u", 311ad7b0368SQu Wenruo name_len + data_len, 3122f659546SQu Wenruo BTRFS_MAX_XATTR_SIZE(fs_info)); 313ad7b0368SQu Wenruo return -EUCLEAN; 314ad7b0368SQu Wenruo } 315ad7b0368SQu Wenruo 316ad7b0368SQu Wenruo if (data_len && dir_type != BTRFS_FT_XATTR) { 3172f659546SQu Wenruo dir_item_err(fs_info, leaf, slot, 318ad7b0368SQu Wenruo "dir item with invalid data len, have %u expect 0", 319ad7b0368SQu Wenruo data_len); 320ad7b0368SQu Wenruo return -EUCLEAN; 321ad7b0368SQu Wenruo } 322ad7b0368SQu Wenruo 323ad7b0368SQu Wenruo total_size = sizeof(*di) + name_len + data_len; 324ad7b0368SQu Wenruo 325ad7b0368SQu Wenruo /* header and name/data should not cross item boundary */ 326ad7b0368SQu Wenruo if (cur + total_size > item_size) { 3272f659546SQu Wenruo dir_item_err(fs_info, leaf, slot, 328ad7b0368SQu Wenruo "dir item data crosses item boundary, have %u boundary %u", 329ad7b0368SQu Wenruo cur + total_size, item_size); 330ad7b0368SQu Wenruo return -EUCLEAN; 331ad7b0368SQu Wenruo } 332ad7b0368SQu Wenruo 333ad7b0368SQu Wenruo /* 334ad7b0368SQu Wenruo * Special check for XATTR/DIR_ITEM, as key->offset is name 335ad7b0368SQu Wenruo * hash, should match its name 336ad7b0368SQu Wenruo */ 337ad7b0368SQu Wenruo if (key->type == BTRFS_DIR_ITEM_KEY || 338ad7b0368SQu Wenruo key->type == BTRFS_XATTR_ITEM_KEY) { 339e2683fc9SDavid Sterba char namebuf[max(BTRFS_NAME_LEN, XATTR_NAME_MAX)]; 340e2683fc9SDavid Sterba 341ad7b0368SQu Wenruo read_extent_buffer(leaf, namebuf, 342ad7b0368SQu Wenruo (unsigned long)(di + 1), name_len); 343ad7b0368SQu Wenruo name_hash = btrfs_name_hash(namebuf, name_len); 344ad7b0368SQu Wenruo if (key->offset != name_hash) { 3452f659546SQu Wenruo dir_item_err(fs_info, leaf, slot, 346ad7b0368SQu Wenruo "name hash mismatch with key, have 0x%016x expect 0x%016llx", 347ad7b0368SQu Wenruo name_hash, key->offset); 348ad7b0368SQu Wenruo return -EUCLEAN; 349ad7b0368SQu Wenruo } 350ad7b0368SQu Wenruo } 351ad7b0368SQu Wenruo cur += total_size; 352ad7b0368SQu Wenruo di = (struct btrfs_dir_item *)((void *)di + total_size); 353ad7b0368SQu Wenruo } 354ad7b0368SQu Wenruo return 0; 355ad7b0368SQu Wenruo } 356ad7b0368SQu Wenruo 357fce466eaSQu Wenruo __printf(4, 5) 358fce466eaSQu Wenruo __cold 359fce466eaSQu Wenruo static void block_group_err(const struct btrfs_fs_info *fs_info, 360fce466eaSQu Wenruo const struct extent_buffer *eb, int slot, 361fce466eaSQu Wenruo const char *fmt, ...) 362fce466eaSQu Wenruo { 363fce466eaSQu Wenruo struct btrfs_key key; 364fce466eaSQu Wenruo struct va_format vaf; 365fce466eaSQu Wenruo va_list args; 366fce466eaSQu Wenruo 367fce466eaSQu Wenruo btrfs_item_key_to_cpu(eb, &key, slot); 368fce466eaSQu Wenruo va_start(args, fmt); 369fce466eaSQu Wenruo 370fce466eaSQu Wenruo vaf.fmt = fmt; 371fce466eaSQu Wenruo vaf.va = &args; 372fce466eaSQu Wenruo 373fce466eaSQu Wenruo btrfs_crit(fs_info, 374fce466eaSQu Wenruo "corrupt %s: root=%llu block=%llu slot=%d bg_start=%llu bg_len=%llu, %pV", 375fce466eaSQu Wenruo btrfs_header_level(eb) == 0 ? "leaf" : "node", 376fce466eaSQu Wenruo btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot, 377fce466eaSQu Wenruo key.objectid, key.offset, &vaf); 378fce466eaSQu Wenruo va_end(args); 379fce466eaSQu Wenruo } 380fce466eaSQu Wenruo 381fce466eaSQu Wenruo static int check_block_group_item(struct btrfs_fs_info *fs_info, 382fce466eaSQu Wenruo struct extent_buffer *leaf, 383fce466eaSQu Wenruo struct btrfs_key *key, int slot) 384fce466eaSQu Wenruo { 385fce466eaSQu Wenruo struct btrfs_block_group_item bgi; 386fce466eaSQu Wenruo u32 item_size = btrfs_item_size_nr(leaf, slot); 387fce466eaSQu Wenruo u64 flags; 388fce466eaSQu Wenruo u64 type; 389fce466eaSQu Wenruo 390fce466eaSQu Wenruo /* 391fce466eaSQu Wenruo * Here we don't really care about alignment since extent allocator can 392fce466eaSQu Wenruo * handle it. We care more about the size, as if one block group is 393fce466eaSQu Wenruo * larger than maximum size, it's must be some obvious corruption. 394fce466eaSQu Wenruo */ 395fce466eaSQu Wenruo if (key->offset > BTRFS_MAX_DATA_CHUNK_SIZE || key->offset == 0) { 396fce466eaSQu Wenruo block_group_err(fs_info, leaf, slot, 397fce466eaSQu Wenruo "invalid block group size, have %llu expect (0, %llu]", 398fce466eaSQu Wenruo key->offset, BTRFS_MAX_DATA_CHUNK_SIZE); 399fce466eaSQu Wenruo return -EUCLEAN; 400fce466eaSQu Wenruo } 401fce466eaSQu Wenruo 402fce466eaSQu Wenruo if (item_size != sizeof(bgi)) { 403fce466eaSQu Wenruo block_group_err(fs_info, leaf, slot, 404fce466eaSQu Wenruo "invalid item size, have %u expect %zu", 405fce466eaSQu Wenruo item_size, sizeof(bgi)); 406fce466eaSQu Wenruo return -EUCLEAN; 407fce466eaSQu Wenruo } 408fce466eaSQu Wenruo 409fce466eaSQu Wenruo read_extent_buffer(leaf, &bgi, btrfs_item_ptr_offset(leaf, slot), 410fce466eaSQu Wenruo sizeof(bgi)); 411fce466eaSQu Wenruo if (btrfs_block_group_chunk_objectid(&bgi) != 412fce466eaSQu Wenruo BTRFS_FIRST_CHUNK_TREE_OBJECTID) { 413fce466eaSQu Wenruo block_group_err(fs_info, leaf, slot, 414fce466eaSQu Wenruo "invalid block group chunk objectid, have %llu expect %llu", 415fce466eaSQu Wenruo btrfs_block_group_chunk_objectid(&bgi), 416fce466eaSQu Wenruo BTRFS_FIRST_CHUNK_TREE_OBJECTID); 417fce466eaSQu Wenruo return -EUCLEAN; 418fce466eaSQu Wenruo } 419fce466eaSQu Wenruo 420fce466eaSQu Wenruo if (btrfs_block_group_used(&bgi) > key->offset) { 421fce466eaSQu Wenruo block_group_err(fs_info, leaf, slot, 422fce466eaSQu Wenruo "invalid block group used, have %llu expect [0, %llu)", 423fce466eaSQu Wenruo btrfs_block_group_used(&bgi), key->offset); 424fce466eaSQu Wenruo return -EUCLEAN; 425fce466eaSQu Wenruo } 426fce466eaSQu Wenruo 427fce466eaSQu Wenruo flags = btrfs_block_group_flags(&bgi); 428fce466eaSQu Wenruo if (hweight64(flags & BTRFS_BLOCK_GROUP_PROFILE_MASK) > 1) { 429fce466eaSQu Wenruo block_group_err(fs_info, leaf, slot, 430fce466eaSQu Wenruo "invalid profile flags, have 0x%llx (%lu bits set) expect no more than 1 bit set", 431fce466eaSQu Wenruo flags & BTRFS_BLOCK_GROUP_PROFILE_MASK, 432fce466eaSQu Wenruo hweight64(flags & BTRFS_BLOCK_GROUP_PROFILE_MASK)); 433fce466eaSQu Wenruo return -EUCLEAN; 434fce466eaSQu Wenruo } 435fce466eaSQu Wenruo 436fce466eaSQu Wenruo type = flags & BTRFS_BLOCK_GROUP_TYPE_MASK; 437fce466eaSQu Wenruo if (type != BTRFS_BLOCK_GROUP_DATA && 438fce466eaSQu Wenruo type != BTRFS_BLOCK_GROUP_METADATA && 439fce466eaSQu Wenruo type != BTRFS_BLOCK_GROUP_SYSTEM && 440fce466eaSQu Wenruo type != (BTRFS_BLOCK_GROUP_METADATA | 441fce466eaSQu Wenruo BTRFS_BLOCK_GROUP_DATA)) { 442fce466eaSQu Wenruo block_group_err(fs_info, leaf, slot, 443*761333f2SShaokun Zhang "invalid type, have 0x%llx (%lu bits set) expect either 0x%llx, 0x%llx, 0x%llx or 0x%llx", 444fce466eaSQu Wenruo type, hweight64(type), 445fce466eaSQu Wenruo BTRFS_BLOCK_GROUP_DATA, BTRFS_BLOCK_GROUP_METADATA, 446fce466eaSQu Wenruo BTRFS_BLOCK_GROUP_SYSTEM, 447fce466eaSQu Wenruo BTRFS_BLOCK_GROUP_METADATA | BTRFS_BLOCK_GROUP_DATA); 448fce466eaSQu Wenruo return -EUCLEAN; 449fce466eaSQu Wenruo } 450fce466eaSQu Wenruo return 0; 451fce466eaSQu Wenruo } 452fce466eaSQu Wenruo 453ad7b0368SQu Wenruo /* 454557ea5ddSQu Wenruo * Common point to switch the item-specific validation. 455557ea5ddSQu Wenruo */ 4562f659546SQu Wenruo static int check_leaf_item(struct btrfs_fs_info *fs_info, 457557ea5ddSQu Wenruo struct extent_buffer *leaf, 458557ea5ddSQu Wenruo struct btrfs_key *key, int slot) 459557ea5ddSQu Wenruo { 460557ea5ddSQu Wenruo int ret = 0; 461557ea5ddSQu Wenruo 462557ea5ddSQu Wenruo switch (key->type) { 463557ea5ddSQu Wenruo case BTRFS_EXTENT_DATA_KEY: 4642f659546SQu Wenruo ret = check_extent_data_item(fs_info, leaf, key, slot); 465557ea5ddSQu Wenruo break; 466557ea5ddSQu Wenruo case BTRFS_EXTENT_CSUM_KEY: 4672f659546SQu Wenruo ret = check_csum_item(fs_info, leaf, key, slot); 468557ea5ddSQu Wenruo break; 469ad7b0368SQu Wenruo case BTRFS_DIR_ITEM_KEY: 470ad7b0368SQu Wenruo case BTRFS_DIR_INDEX_KEY: 471ad7b0368SQu Wenruo case BTRFS_XATTR_ITEM_KEY: 4722f659546SQu Wenruo ret = check_dir_item(fs_info, leaf, key, slot); 473ad7b0368SQu Wenruo break; 474fce466eaSQu Wenruo case BTRFS_BLOCK_GROUP_ITEM_KEY: 475fce466eaSQu Wenruo ret = check_block_group_item(fs_info, leaf, key, slot); 476fce466eaSQu Wenruo break; 477557ea5ddSQu Wenruo } 478557ea5ddSQu Wenruo return ret; 479557ea5ddSQu Wenruo } 480557ea5ddSQu Wenruo 4812f659546SQu Wenruo static int check_leaf(struct btrfs_fs_info *fs_info, struct extent_buffer *leaf, 48269fc6cbbSQu Wenruo bool check_item_data) 483557ea5ddSQu Wenruo { 484557ea5ddSQu Wenruo /* No valid key type is 0, so all key should be larger than this key */ 485557ea5ddSQu Wenruo struct btrfs_key prev_key = {0, 0, 0}; 486557ea5ddSQu Wenruo struct btrfs_key key; 487557ea5ddSQu Wenruo u32 nritems = btrfs_header_nritems(leaf); 488557ea5ddSQu Wenruo int slot; 489557ea5ddSQu Wenruo 490f556faa4SQu Wenruo if (btrfs_header_level(leaf) != 0) { 491f556faa4SQu Wenruo generic_err(fs_info, leaf, 0, 492f556faa4SQu Wenruo "invalid level for leaf, have %d expect 0", 493f556faa4SQu Wenruo btrfs_header_level(leaf)); 494f556faa4SQu Wenruo return -EUCLEAN; 495f556faa4SQu Wenruo } 496f556faa4SQu Wenruo 497557ea5ddSQu Wenruo /* 498557ea5ddSQu Wenruo * Extent buffers from a relocation tree have a owner field that 499557ea5ddSQu Wenruo * corresponds to the subvolume tree they are based on. So just from an 500557ea5ddSQu Wenruo * extent buffer alone we can not find out what is the id of the 501557ea5ddSQu Wenruo * corresponding subvolume tree, so we can not figure out if the extent 502557ea5ddSQu Wenruo * buffer corresponds to the root of the relocation tree or not. So 503557ea5ddSQu Wenruo * skip this check for relocation trees. 504557ea5ddSQu Wenruo */ 505557ea5ddSQu Wenruo if (nritems == 0 && !btrfs_header_flag(leaf, BTRFS_HEADER_FLAG_RELOC)) { 506ba480dd4SQu Wenruo u64 owner = btrfs_header_owner(leaf); 507557ea5ddSQu Wenruo struct btrfs_root *check_root; 508557ea5ddSQu Wenruo 509ba480dd4SQu Wenruo /* These trees must never be empty */ 510ba480dd4SQu Wenruo if (owner == BTRFS_ROOT_TREE_OBJECTID || 511ba480dd4SQu Wenruo owner == BTRFS_CHUNK_TREE_OBJECTID || 512ba480dd4SQu Wenruo owner == BTRFS_EXTENT_TREE_OBJECTID || 513ba480dd4SQu Wenruo owner == BTRFS_DEV_TREE_OBJECTID || 514ba480dd4SQu Wenruo owner == BTRFS_FS_TREE_OBJECTID || 515ba480dd4SQu Wenruo owner == BTRFS_DATA_RELOC_TREE_OBJECTID) { 516ba480dd4SQu Wenruo generic_err(fs_info, leaf, 0, 517ba480dd4SQu Wenruo "invalid root, root %llu must never be empty", 518ba480dd4SQu Wenruo owner); 519ba480dd4SQu Wenruo return -EUCLEAN; 520ba480dd4SQu Wenruo } 521ba480dd4SQu Wenruo key.objectid = owner; 522557ea5ddSQu Wenruo key.type = BTRFS_ROOT_ITEM_KEY; 523557ea5ddSQu Wenruo key.offset = (u64)-1; 524557ea5ddSQu Wenruo 525557ea5ddSQu Wenruo check_root = btrfs_get_fs_root(fs_info, &key, false); 526557ea5ddSQu Wenruo /* 527557ea5ddSQu Wenruo * The only reason we also check NULL here is that during 528557ea5ddSQu Wenruo * open_ctree() some roots has not yet been set up. 529557ea5ddSQu Wenruo */ 530557ea5ddSQu Wenruo if (!IS_ERR_OR_NULL(check_root)) { 531557ea5ddSQu Wenruo struct extent_buffer *eb; 532557ea5ddSQu Wenruo 533557ea5ddSQu Wenruo eb = btrfs_root_node(check_root); 534557ea5ddSQu Wenruo /* if leaf is the root, then it's fine */ 535557ea5ddSQu Wenruo if (leaf != eb) { 5362f659546SQu Wenruo generic_err(fs_info, leaf, 0, 537478d01b3SQu Wenruo "invalid nritems, have %u should not be 0 for non-root leaf", 538478d01b3SQu Wenruo nritems); 539557ea5ddSQu Wenruo free_extent_buffer(eb); 540557ea5ddSQu Wenruo return -EUCLEAN; 541557ea5ddSQu Wenruo } 542557ea5ddSQu Wenruo free_extent_buffer(eb); 543557ea5ddSQu Wenruo } 544557ea5ddSQu Wenruo return 0; 545557ea5ddSQu Wenruo } 546557ea5ddSQu Wenruo 547557ea5ddSQu Wenruo if (nritems == 0) 548557ea5ddSQu Wenruo return 0; 549557ea5ddSQu Wenruo 550557ea5ddSQu Wenruo /* 551557ea5ddSQu Wenruo * Check the following things to make sure this is a good leaf, and 552557ea5ddSQu Wenruo * leaf users won't need to bother with similar sanity checks: 553557ea5ddSQu Wenruo * 554557ea5ddSQu Wenruo * 1) key ordering 555557ea5ddSQu Wenruo * 2) item offset and size 556557ea5ddSQu Wenruo * No overlap, no hole, all inside the leaf. 557557ea5ddSQu Wenruo * 3) item content 558557ea5ddSQu Wenruo * If possible, do comprehensive sanity check. 559557ea5ddSQu Wenruo * NOTE: All checks must only rely on the item data itself. 560557ea5ddSQu Wenruo */ 561557ea5ddSQu Wenruo for (slot = 0; slot < nritems; slot++) { 562557ea5ddSQu Wenruo u32 item_end_expected; 563557ea5ddSQu Wenruo int ret; 564557ea5ddSQu Wenruo 565557ea5ddSQu Wenruo btrfs_item_key_to_cpu(leaf, &key, slot); 566557ea5ddSQu Wenruo 567557ea5ddSQu Wenruo /* Make sure the keys are in the right order */ 568557ea5ddSQu Wenruo if (btrfs_comp_cpu_keys(&prev_key, &key) >= 0) { 5692f659546SQu Wenruo generic_err(fs_info, leaf, slot, 570478d01b3SQu Wenruo "bad key order, prev (%llu %u %llu) current (%llu %u %llu)", 571478d01b3SQu Wenruo prev_key.objectid, prev_key.type, 572478d01b3SQu Wenruo prev_key.offset, key.objectid, key.type, 573478d01b3SQu Wenruo key.offset); 574557ea5ddSQu Wenruo return -EUCLEAN; 575557ea5ddSQu Wenruo } 576557ea5ddSQu Wenruo 577557ea5ddSQu Wenruo /* 578557ea5ddSQu Wenruo * Make sure the offset and ends are right, remember that the 579557ea5ddSQu Wenruo * item data starts at the end of the leaf and grows towards the 580557ea5ddSQu Wenruo * front. 581557ea5ddSQu Wenruo */ 582557ea5ddSQu Wenruo if (slot == 0) 583557ea5ddSQu Wenruo item_end_expected = BTRFS_LEAF_DATA_SIZE(fs_info); 584557ea5ddSQu Wenruo else 585557ea5ddSQu Wenruo item_end_expected = btrfs_item_offset_nr(leaf, 586557ea5ddSQu Wenruo slot - 1); 587557ea5ddSQu Wenruo if (btrfs_item_end_nr(leaf, slot) != item_end_expected) { 5882f659546SQu Wenruo generic_err(fs_info, leaf, slot, 589478d01b3SQu Wenruo "unexpected item end, have %u expect %u", 590478d01b3SQu Wenruo btrfs_item_end_nr(leaf, slot), 591478d01b3SQu Wenruo item_end_expected); 592557ea5ddSQu Wenruo return -EUCLEAN; 593557ea5ddSQu Wenruo } 594557ea5ddSQu Wenruo 595557ea5ddSQu Wenruo /* 596557ea5ddSQu Wenruo * Check to make sure that we don't point outside of the leaf, 597557ea5ddSQu Wenruo * just in case all the items are consistent to each other, but 598557ea5ddSQu Wenruo * all point outside of the leaf. 599557ea5ddSQu Wenruo */ 600557ea5ddSQu Wenruo if (btrfs_item_end_nr(leaf, slot) > 601557ea5ddSQu Wenruo BTRFS_LEAF_DATA_SIZE(fs_info)) { 6022f659546SQu Wenruo generic_err(fs_info, leaf, slot, 603478d01b3SQu Wenruo "slot end outside of leaf, have %u expect range [0, %u]", 604478d01b3SQu Wenruo btrfs_item_end_nr(leaf, slot), 605478d01b3SQu Wenruo BTRFS_LEAF_DATA_SIZE(fs_info)); 606557ea5ddSQu Wenruo return -EUCLEAN; 607557ea5ddSQu Wenruo } 608557ea5ddSQu Wenruo 609557ea5ddSQu Wenruo /* Also check if the item pointer overlaps with btrfs item. */ 610557ea5ddSQu Wenruo if (btrfs_item_nr_offset(slot) + sizeof(struct btrfs_item) > 611557ea5ddSQu Wenruo btrfs_item_ptr_offset(leaf, slot)) { 6122f659546SQu Wenruo generic_err(fs_info, leaf, slot, 613478d01b3SQu Wenruo "slot overlaps with its data, item end %lu data start %lu", 614478d01b3SQu Wenruo btrfs_item_nr_offset(slot) + 615478d01b3SQu Wenruo sizeof(struct btrfs_item), 616478d01b3SQu Wenruo btrfs_item_ptr_offset(leaf, slot)); 617557ea5ddSQu Wenruo return -EUCLEAN; 618557ea5ddSQu Wenruo } 619557ea5ddSQu Wenruo 62069fc6cbbSQu Wenruo if (check_item_data) { 62169fc6cbbSQu Wenruo /* 62269fc6cbbSQu Wenruo * Check if the item size and content meet other 62369fc6cbbSQu Wenruo * criteria 62469fc6cbbSQu Wenruo */ 6252f659546SQu Wenruo ret = check_leaf_item(fs_info, leaf, &key, slot); 626557ea5ddSQu Wenruo if (ret < 0) 627557ea5ddSQu Wenruo return ret; 62869fc6cbbSQu Wenruo } 629557ea5ddSQu Wenruo 630557ea5ddSQu Wenruo prev_key.objectid = key.objectid; 631557ea5ddSQu Wenruo prev_key.type = key.type; 632557ea5ddSQu Wenruo prev_key.offset = key.offset; 633557ea5ddSQu Wenruo } 634557ea5ddSQu Wenruo 635557ea5ddSQu Wenruo return 0; 636557ea5ddSQu Wenruo } 637557ea5ddSQu Wenruo 6382f659546SQu Wenruo int btrfs_check_leaf_full(struct btrfs_fs_info *fs_info, 63969fc6cbbSQu Wenruo struct extent_buffer *leaf) 64069fc6cbbSQu Wenruo { 6412f659546SQu Wenruo return check_leaf(fs_info, leaf, true); 64269fc6cbbSQu Wenruo } 64369fc6cbbSQu Wenruo 6442f659546SQu Wenruo int btrfs_check_leaf_relaxed(struct btrfs_fs_info *fs_info, 6452f659546SQu Wenruo struct extent_buffer *leaf) 6462f659546SQu Wenruo { 6472f659546SQu Wenruo return check_leaf(fs_info, leaf, false); 6482f659546SQu Wenruo } 6492f659546SQu Wenruo 6502f659546SQu Wenruo int btrfs_check_node(struct btrfs_fs_info *fs_info, struct extent_buffer *node) 651557ea5ddSQu Wenruo { 652557ea5ddSQu Wenruo unsigned long nr = btrfs_header_nritems(node); 653557ea5ddSQu Wenruo struct btrfs_key key, next_key; 654557ea5ddSQu Wenruo int slot; 655f556faa4SQu Wenruo int level = btrfs_header_level(node); 656557ea5ddSQu Wenruo u64 bytenr; 657557ea5ddSQu Wenruo int ret = 0; 658557ea5ddSQu Wenruo 659f556faa4SQu Wenruo if (level <= 0 || level >= BTRFS_MAX_LEVEL) { 660f556faa4SQu Wenruo generic_err(fs_info, node, 0, 661f556faa4SQu Wenruo "invalid level for node, have %d expect [1, %d]", 662f556faa4SQu Wenruo level, BTRFS_MAX_LEVEL - 1); 663f556faa4SQu Wenruo return -EUCLEAN; 664f556faa4SQu Wenruo } 6652f659546SQu Wenruo if (nr == 0 || nr > BTRFS_NODEPTRS_PER_BLOCK(fs_info)) { 6662f659546SQu Wenruo btrfs_crit(fs_info, 667bba4f298SQu Wenruo "corrupt node: root=%llu block=%llu, nritems too %s, have %lu expect range [1,%u]", 6682f659546SQu Wenruo btrfs_header_owner(node), node->start, 669bba4f298SQu Wenruo nr == 0 ? "small" : "large", nr, 6702f659546SQu Wenruo BTRFS_NODEPTRS_PER_BLOCK(fs_info)); 671bba4f298SQu Wenruo return -EUCLEAN; 672557ea5ddSQu Wenruo } 673557ea5ddSQu Wenruo 674557ea5ddSQu Wenruo for (slot = 0; slot < nr - 1; slot++) { 675557ea5ddSQu Wenruo bytenr = btrfs_node_blockptr(node, slot); 676557ea5ddSQu Wenruo btrfs_node_key_to_cpu(node, &key, slot); 677557ea5ddSQu Wenruo btrfs_node_key_to_cpu(node, &next_key, slot + 1); 678557ea5ddSQu Wenruo 679557ea5ddSQu Wenruo if (!bytenr) { 6802f659546SQu Wenruo generic_err(fs_info, node, slot, 681bba4f298SQu Wenruo "invalid NULL node pointer"); 682bba4f298SQu Wenruo ret = -EUCLEAN; 683bba4f298SQu Wenruo goto out; 684bba4f298SQu Wenruo } 6852f659546SQu Wenruo if (!IS_ALIGNED(bytenr, fs_info->sectorsize)) { 6862f659546SQu Wenruo generic_err(fs_info, node, slot, 687bba4f298SQu Wenruo "unaligned pointer, have %llu should be aligned to %u", 6882f659546SQu Wenruo bytenr, fs_info->sectorsize); 689bba4f298SQu Wenruo ret = -EUCLEAN; 690557ea5ddSQu Wenruo goto out; 691557ea5ddSQu Wenruo } 692557ea5ddSQu Wenruo 693557ea5ddSQu Wenruo if (btrfs_comp_cpu_keys(&key, &next_key) >= 0) { 6942f659546SQu Wenruo generic_err(fs_info, node, slot, 695bba4f298SQu Wenruo "bad key order, current (%llu %u %llu) next (%llu %u %llu)", 696bba4f298SQu Wenruo key.objectid, key.type, key.offset, 697bba4f298SQu Wenruo next_key.objectid, next_key.type, 698bba4f298SQu Wenruo next_key.offset); 699bba4f298SQu Wenruo ret = -EUCLEAN; 700557ea5ddSQu Wenruo goto out; 701557ea5ddSQu Wenruo } 702557ea5ddSQu Wenruo } 703557ea5ddSQu Wenruo out: 704557ea5ddSQu Wenruo return ret; 705557ea5ddSQu Wenruo } 706