1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) Qu Wenruo 2017. All rights reserved.
7 * The module is used to catch unexpected/corrupted tree block data.
8 * Such behavior can be caused either by a fuzzed image or bugs.
10 * The objective is to do leaf/node validation checks when tree block is read
11 * from disk, and check *every* possible member, so other code won't
12 * need to checking them again.
14 * Due to the potential and unwanted damage, every checker needs to be
15 * carefully reviewed otherwise so it does not prevent mount of valid images.
18 #include <linux/types.h>
19 #include <linux/stddef.h>
20 #include <linux/error-injection.h>
22 #include "tree-checker.h"
24 #include "compression.h"
27 #include "btrfs_inode.h"
30 * Error message should follow the following format:
31 * corrupt <type>: <identifier>, <reason>[, <bad_value>]
34 * @identifier: the necessary info to locate the leaf/node.
35 * It's recommended to decode key.objecitd/offset if it's
37 * @reason: describe the error
38 * @bad_value: optional, it's recommended to output bad value and its
39 * expected value (range).
41 * Since comma is used to separate the components, only space is allowed
42 * inside each component.
46 * Append generic "corrupt leaf/node root=%llu block=%llu slot=%d: " to @fmt.
47 * Allows callers to customize the output.
51 static void generic_err(const struct extent_buffer *eb, int slot,
54 const struct btrfs_fs_info *fs_info = eb->fs_info;
64 "corrupt %s: root=%llu block=%llu slot=%d, %pV",
65 btrfs_header_level(eb) == 0 ? "leaf" : "node",
66 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot, &vaf);
71 * Customized reporter for extent data item, since its key objectid and
72 * offset has its own meaning.
76 static void file_extent_err(const struct extent_buffer *eb, int slot,
79 const struct btrfs_fs_info *fs_info = eb->fs_info;
84 btrfs_item_key_to_cpu(eb, &key, slot);
91 "corrupt %s: root=%llu block=%llu slot=%d ino=%llu file_offset=%llu, %pV",
92 btrfs_header_level(eb) == 0 ? "leaf" : "node",
93 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
94 key.objectid, key.offset, &vaf);
99 * Return 0 if the btrfs_file_extent_##name is aligned to @alignment
102 #define CHECK_FE_ALIGNED(leaf, slot, fi, name, alignment) \
104 if (unlikely(!IS_ALIGNED(btrfs_file_extent_##name((leaf), (fi)), \
106 file_extent_err((leaf), (slot), \
107 "invalid %s for file extent, have %llu, should be aligned to %u", \
108 (#name), btrfs_file_extent_##name((leaf), (fi)), \
110 (!IS_ALIGNED(btrfs_file_extent_##name((leaf), (fi)), (alignment))); \
113 static u64 file_extent_end(struct extent_buffer *leaf,
114 struct btrfs_key *key,
115 struct btrfs_file_extent_item *extent)
120 if (btrfs_file_extent_type(leaf, extent) == BTRFS_FILE_EXTENT_INLINE) {
121 len = btrfs_file_extent_ram_bytes(leaf, extent);
122 end = ALIGN(key->offset + len, leaf->fs_info->sectorsize);
124 len = btrfs_file_extent_num_bytes(leaf, extent);
125 end = key->offset + len;
131 * Customized report for dir_item, the only new important information is
132 * key->objectid, which represents inode number
136 static void dir_item_err(const struct extent_buffer *eb, int slot,
137 const char *fmt, ...)
139 const struct btrfs_fs_info *fs_info = eb->fs_info;
140 struct btrfs_key key;
141 struct va_format vaf;
144 btrfs_item_key_to_cpu(eb, &key, slot);
151 "corrupt %s: root=%llu block=%llu slot=%d ino=%llu, %pV",
152 btrfs_header_level(eb) == 0 ? "leaf" : "node",
153 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
159 * This functions checks prev_key->objectid, to ensure current key and prev_key
160 * share the same objectid as inode number.
162 * This is to detect missing INODE_ITEM in subvolume trees.
164 * Return true if everything is OK or we don't need to check.
165 * Return false if anything is wrong.
167 static bool check_prev_ino(struct extent_buffer *leaf,
168 struct btrfs_key *key, int slot,
169 struct btrfs_key *prev_key)
171 /* No prev key, skip check */
175 /* Only these key->types needs to be checked */
176 ASSERT(key->type == BTRFS_XATTR_ITEM_KEY ||
177 key->type == BTRFS_INODE_REF_KEY ||
178 key->type == BTRFS_DIR_INDEX_KEY ||
179 key->type == BTRFS_DIR_ITEM_KEY ||
180 key->type == BTRFS_EXTENT_DATA_KEY);
183 * Only subvolume trees along with their reloc trees need this check.
184 * Things like log tree doesn't follow this ino requirement.
186 if (!is_fstree(btrfs_header_owner(leaf)))
189 if (key->objectid == prev_key->objectid)
193 dir_item_err(leaf, slot,
194 "invalid previous key objectid, have %llu expect %llu",
195 prev_key->objectid, key->objectid);
198 static int check_extent_data_item(struct extent_buffer *leaf,
199 struct btrfs_key *key, int slot,
200 struct btrfs_key *prev_key)
202 struct btrfs_fs_info *fs_info = leaf->fs_info;
203 struct btrfs_file_extent_item *fi;
204 u32 sectorsize = fs_info->sectorsize;
205 u32 item_size = btrfs_item_size(leaf, slot);
208 if (unlikely(!IS_ALIGNED(key->offset, sectorsize))) {
209 file_extent_err(leaf, slot,
210 "unaligned file_offset for file extent, have %llu should be aligned to %u",
211 key->offset, sectorsize);
216 * Previous key must have the same key->objectid (ino).
217 * It can be XATTR_ITEM, INODE_ITEM or just another EXTENT_DATA.
218 * But if objectids mismatch, it means we have a missing
221 if (unlikely(!check_prev_ino(leaf, key, slot, prev_key)))
224 fi = btrfs_item_ptr(leaf, slot, struct btrfs_file_extent_item);
227 * Make sure the item contains at least inline header, so the file
228 * extent type is not some garbage.
230 if (unlikely(item_size < BTRFS_FILE_EXTENT_INLINE_DATA_START)) {
231 file_extent_err(leaf, slot,
232 "invalid item size, have %u expect [%zu, %u)",
233 item_size, BTRFS_FILE_EXTENT_INLINE_DATA_START,
237 if (unlikely(btrfs_file_extent_type(leaf, fi) >=
238 BTRFS_NR_FILE_EXTENT_TYPES)) {
239 file_extent_err(leaf, slot,
240 "invalid type for file extent, have %u expect range [0, %u]",
241 btrfs_file_extent_type(leaf, fi),
242 BTRFS_NR_FILE_EXTENT_TYPES - 1);
247 * Support for new compression/encryption must introduce incompat flag,
248 * and must be caught in open_ctree().
250 if (unlikely(btrfs_file_extent_compression(leaf, fi) >=
251 BTRFS_NR_COMPRESS_TYPES)) {
252 file_extent_err(leaf, slot,
253 "invalid compression for file extent, have %u expect range [0, %u]",
254 btrfs_file_extent_compression(leaf, fi),
255 BTRFS_NR_COMPRESS_TYPES - 1);
258 if (unlikely(btrfs_file_extent_encryption(leaf, fi))) {
259 file_extent_err(leaf, slot,
260 "invalid encryption for file extent, have %u expect 0",
261 btrfs_file_extent_encryption(leaf, fi));
264 if (btrfs_file_extent_type(leaf, fi) == BTRFS_FILE_EXTENT_INLINE) {
265 /* Inline extent must have 0 as key offset */
266 if (unlikely(key->offset)) {
267 file_extent_err(leaf, slot,
268 "invalid file_offset for inline file extent, have %llu expect 0",
273 /* Compressed inline extent has no on-disk size, skip it */
274 if (btrfs_file_extent_compression(leaf, fi) !=
278 /* Uncompressed inline extent size must match item size */
279 if (unlikely(item_size != BTRFS_FILE_EXTENT_INLINE_DATA_START +
280 btrfs_file_extent_ram_bytes(leaf, fi))) {
281 file_extent_err(leaf, slot,
282 "invalid ram_bytes for uncompressed inline extent, have %u expect %llu",
283 item_size, BTRFS_FILE_EXTENT_INLINE_DATA_START +
284 btrfs_file_extent_ram_bytes(leaf, fi));
290 /* Regular or preallocated extent has fixed item size */
291 if (unlikely(item_size != sizeof(*fi))) {
292 file_extent_err(leaf, slot,
293 "invalid item size for reg/prealloc file extent, have %u expect %zu",
294 item_size, sizeof(*fi));
297 if (unlikely(CHECK_FE_ALIGNED(leaf, slot, fi, ram_bytes, sectorsize) ||
298 CHECK_FE_ALIGNED(leaf, slot, fi, disk_bytenr, sectorsize) ||
299 CHECK_FE_ALIGNED(leaf, slot, fi, disk_num_bytes, sectorsize) ||
300 CHECK_FE_ALIGNED(leaf, slot, fi, offset, sectorsize) ||
301 CHECK_FE_ALIGNED(leaf, slot, fi, num_bytes, sectorsize)))
304 /* Catch extent end overflow */
305 if (unlikely(check_add_overflow(btrfs_file_extent_num_bytes(leaf, fi),
306 key->offset, &extent_end))) {
307 file_extent_err(leaf, slot,
308 "extent end overflow, have file offset %llu extent num bytes %llu",
310 btrfs_file_extent_num_bytes(leaf, fi));
315 * Check that no two consecutive file extent items, in the same leaf,
316 * present ranges that overlap each other.
319 prev_key->objectid == key->objectid &&
320 prev_key->type == BTRFS_EXTENT_DATA_KEY) {
321 struct btrfs_file_extent_item *prev_fi;
324 prev_fi = btrfs_item_ptr(leaf, slot - 1,
325 struct btrfs_file_extent_item);
326 prev_end = file_extent_end(leaf, prev_key, prev_fi);
327 if (unlikely(prev_end > key->offset)) {
328 file_extent_err(leaf, slot - 1,
329 "file extent end range (%llu) goes beyond start offset (%llu) of the next file extent",
330 prev_end, key->offset);
338 static int check_csum_item(struct extent_buffer *leaf, struct btrfs_key *key,
339 int slot, struct btrfs_key *prev_key)
341 struct btrfs_fs_info *fs_info = leaf->fs_info;
342 u32 sectorsize = fs_info->sectorsize;
343 const u32 csumsize = fs_info->csum_size;
345 if (unlikely(key->objectid != BTRFS_EXTENT_CSUM_OBJECTID)) {
346 generic_err(leaf, slot,
347 "invalid key objectid for csum item, have %llu expect %llu",
348 key->objectid, BTRFS_EXTENT_CSUM_OBJECTID);
351 if (unlikely(!IS_ALIGNED(key->offset, sectorsize))) {
352 generic_err(leaf, slot,
353 "unaligned key offset for csum item, have %llu should be aligned to %u",
354 key->offset, sectorsize);
357 if (unlikely(!IS_ALIGNED(btrfs_item_size(leaf, slot), csumsize))) {
358 generic_err(leaf, slot,
359 "unaligned item size for csum item, have %u should be aligned to %u",
360 btrfs_item_size(leaf, slot), csumsize);
363 if (slot > 0 && prev_key->type == BTRFS_EXTENT_CSUM_KEY) {
367 prev_item_size = btrfs_item_size(leaf, slot - 1);
368 prev_csum_end = (prev_item_size / csumsize) * sectorsize;
369 prev_csum_end += prev_key->offset;
370 if (unlikely(prev_csum_end > key->offset)) {
371 generic_err(leaf, slot - 1,
372 "csum end range (%llu) goes beyond the start range (%llu) of the next csum item",
373 prev_csum_end, key->offset);
380 /* Inode item error output has the same format as dir_item_err() */
381 #define inode_item_err(eb, slot, fmt, ...) \
382 dir_item_err(eb, slot, fmt, __VA_ARGS__)
384 static int check_inode_key(struct extent_buffer *leaf, struct btrfs_key *key,
387 struct btrfs_key item_key;
390 btrfs_item_key_to_cpu(leaf, &item_key, slot);
391 is_inode_item = (item_key.type == BTRFS_INODE_ITEM_KEY);
393 /* For XATTR_ITEM, location key should be all 0 */
394 if (item_key.type == BTRFS_XATTR_ITEM_KEY) {
395 if (unlikely(key->objectid != 0 || key->type != 0 ||
401 if (unlikely((key->objectid < BTRFS_FIRST_FREE_OBJECTID ||
402 key->objectid > BTRFS_LAST_FREE_OBJECTID) &&
403 key->objectid != BTRFS_ROOT_TREE_DIR_OBJECTID &&
404 key->objectid != BTRFS_FREE_INO_OBJECTID)) {
406 generic_err(leaf, slot,
407 "invalid key objectid: has %llu expect %llu or [%llu, %llu] or %llu",
408 key->objectid, BTRFS_ROOT_TREE_DIR_OBJECTID,
409 BTRFS_FIRST_FREE_OBJECTID,
410 BTRFS_LAST_FREE_OBJECTID,
411 BTRFS_FREE_INO_OBJECTID);
413 dir_item_err(leaf, slot,
414 "invalid location key objectid: has %llu expect %llu or [%llu, %llu] or %llu",
415 key->objectid, BTRFS_ROOT_TREE_DIR_OBJECTID,
416 BTRFS_FIRST_FREE_OBJECTID,
417 BTRFS_LAST_FREE_OBJECTID,
418 BTRFS_FREE_INO_OBJECTID);
422 if (unlikely(key->offset != 0)) {
424 inode_item_err(leaf, slot,
425 "invalid key offset: has %llu expect 0",
428 dir_item_err(leaf, slot,
429 "invalid location key offset:has %llu expect 0",
436 static int check_root_key(struct extent_buffer *leaf, struct btrfs_key *key,
439 struct btrfs_key item_key;
442 btrfs_item_key_to_cpu(leaf, &item_key, slot);
443 is_root_item = (item_key.type == BTRFS_ROOT_ITEM_KEY);
445 /* No such tree id */
446 if (unlikely(key->objectid == 0)) {
448 generic_err(leaf, slot, "invalid root id 0");
450 dir_item_err(leaf, slot,
451 "invalid location key root id 0");
455 /* DIR_ITEM/INDEX/INODE_REF is not allowed to point to non-fs trees */
456 if (unlikely(!is_fstree(key->objectid) && !is_root_item)) {
457 dir_item_err(leaf, slot,
458 "invalid location key objectid, have %llu expect [%llu, %llu]",
459 key->objectid, BTRFS_FIRST_FREE_OBJECTID,
460 BTRFS_LAST_FREE_OBJECTID);
465 * ROOT_ITEM with non-zero offset means this is a snapshot, created at
467 * Furthermore, for location key in DIR_ITEM, its offset is always -1.
469 * So here we only check offset for reloc tree whose key->offset must
472 if (unlikely(key->objectid == BTRFS_TREE_RELOC_OBJECTID &&
474 generic_err(leaf, slot, "invalid root id 0 for reloc tree");
480 static int check_dir_item(struct extent_buffer *leaf,
481 struct btrfs_key *key, struct btrfs_key *prev_key,
484 struct btrfs_fs_info *fs_info = leaf->fs_info;
485 struct btrfs_dir_item *di;
486 u32 item_size = btrfs_item_size(leaf, slot);
489 if (unlikely(!check_prev_ino(leaf, key, slot, prev_key)))
492 di = btrfs_item_ptr(leaf, slot, struct btrfs_dir_item);
493 while (cur < item_size) {
494 struct btrfs_key location_key;
503 /* header itself should not cross item boundary */
504 if (unlikely(cur + sizeof(*di) > item_size)) {
505 dir_item_err(leaf, slot,
506 "dir item header crosses item boundary, have %zu boundary %u",
507 cur + sizeof(*di), item_size);
511 /* Location key check */
512 btrfs_dir_item_key_to_cpu(leaf, di, &location_key);
513 if (location_key.type == BTRFS_ROOT_ITEM_KEY) {
514 ret = check_root_key(leaf, &location_key, slot);
515 if (unlikely(ret < 0))
517 } else if (location_key.type == BTRFS_INODE_ITEM_KEY ||
518 location_key.type == 0) {
519 ret = check_inode_key(leaf, &location_key, slot);
520 if (unlikely(ret < 0))
523 dir_item_err(leaf, slot,
524 "invalid location key type, have %u, expect %u or %u",
525 location_key.type, BTRFS_ROOT_ITEM_KEY,
526 BTRFS_INODE_ITEM_KEY);
531 dir_type = btrfs_dir_type(leaf, di);
532 if (unlikely(dir_type >= BTRFS_FT_MAX)) {
533 dir_item_err(leaf, slot,
534 "invalid dir item type, have %u expect [0, %u)",
535 dir_type, BTRFS_FT_MAX);
539 if (unlikely(key->type == BTRFS_XATTR_ITEM_KEY &&
540 dir_type != BTRFS_FT_XATTR)) {
541 dir_item_err(leaf, slot,
542 "invalid dir item type for XATTR key, have %u expect %u",
543 dir_type, BTRFS_FT_XATTR);
546 if (unlikely(dir_type == BTRFS_FT_XATTR &&
547 key->type != BTRFS_XATTR_ITEM_KEY)) {
548 dir_item_err(leaf, slot,
549 "xattr dir type found for non-XATTR key");
552 if (dir_type == BTRFS_FT_XATTR)
553 max_name_len = XATTR_NAME_MAX;
555 max_name_len = BTRFS_NAME_LEN;
557 /* Name/data length check */
558 name_len = btrfs_dir_name_len(leaf, di);
559 data_len = btrfs_dir_data_len(leaf, di);
560 if (unlikely(name_len > max_name_len)) {
561 dir_item_err(leaf, slot,
562 "dir item name len too long, have %u max %u",
563 name_len, max_name_len);
566 if (unlikely(name_len + data_len > BTRFS_MAX_XATTR_SIZE(fs_info))) {
567 dir_item_err(leaf, slot,
568 "dir item name and data len too long, have %u max %u",
570 BTRFS_MAX_XATTR_SIZE(fs_info));
574 if (unlikely(data_len && dir_type != BTRFS_FT_XATTR)) {
575 dir_item_err(leaf, slot,
576 "dir item with invalid data len, have %u expect 0",
581 total_size = sizeof(*di) + name_len + data_len;
583 /* header and name/data should not cross item boundary */
584 if (unlikely(cur + total_size > item_size)) {
585 dir_item_err(leaf, slot,
586 "dir item data crosses item boundary, have %u boundary %u",
587 cur + total_size, item_size);
592 * Special check for XATTR/DIR_ITEM, as key->offset is name
593 * hash, should match its name
595 if (key->type == BTRFS_DIR_ITEM_KEY ||
596 key->type == BTRFS_XATTR_ITEM_KEY) {
597 char namebuf[max(BTRFS_NAME_LEN, XATTR_NAME_MAX)];
599 read_extent_buffer(leaf, namebuf,
600 (unsigned long)(di + 1), name_len);
601 name_hash = btrfs_name_hash(namebuf, name_len);
602 if (unlikely(key->offset != name_hash)) {
603 dir_item_err(leaf, slot,
604 "name hash mismatch with key, have 0x%016x expect 0x%016llx",
605 name_hash, key->offset);
610 di = (struct btrfs_dir_item *)((void *)di + total_size);
617 static void block_group_err(const struct extent_buffer *eb, int slot,
618 const char *fmt, ...)
620 const struct btrfs_fs_info *fs_info = eb->fs_info;
621 struct btrfs_key key;
622 struct va_format vaf;
625 btrfs_item_key_to_cpu(eb, &key, slot);
632 "corrupt %s: root=%llu block=%llu slot=%d bg_start=%llu bg_len=%llu, %pV",
633 btrfs_header_level(eb) == 0 ? "leaf" : "node",
634 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
635 key.objectid, key.offset, &vaf);
639 static int check_block_group_item(struct extent_buffer *leaf,
640 struct btrfs_key *key, int slot)
642 struct btrfs_fs_info *fs_info = leaf->fs_info;
643 struct btrfs_block_group_item bgi;
644 u32 item_size = btrfs_item_size(leaf, slot);
650 * Here we don't really care about alignment since extent allocator can
651 * handle it. We care more about the size.
653 if (unlikely(key->offset == 0)) {
654 block_group_err(leaf, slot,
655 "invalid block group size 0");
659 if (unlikely(item_size != sizeof(bgi))) {
660 block_group_err(leaf, slot,
661 "invalid item size, have %u expect %zu",
662 item_size, sizeof(bgi));
666 read_extent_buffer(leaf, &bgi, btrfs_item_ptr_offset(leaf, slot),
668 chunk_objectid = btrfs_stack_block_group_chunk_objectid(&bgi);
669 if (btrfs_fs_incompat(fs_info, EXTENT_TREE_V2)) {
671 * We don't init the nr_global_roots until we load the global
672 * roots, so this could be 0 at mount time. If it's 0 we'll
673 * just assume we're fine, and later we'll check against our
676 if (unlikely(fs_info->nr_global_roots &&
677 chunk_objectid >= fs_info->nr_global_roots)) {
678 block_group_err(leaf, slot,
679 "invalid block group global root id, have %llu, needs to be <= %llu",
681 fs_info->nr_global_roots);
684 } else if (unlikely(chunk_objectid != BTRFS_FIRST_CHUNK_TREE_OBJECTID)) {
685 block_group_err(leaf, slot,
686 "invalid block group chunk objectid, have %llu expect %llu",
687 btrfs_stack_block_group_chunk_objectid(&bgi),
688 BTRFS_FIRST_CHUNK_TREE_OBJECTID);
692 if (unlikely(btrfs_stack_block_group_used(&bgi) > key->offset)) {
693 block_group_err(leaf, slot,
694 "invalid block group used, have %llu expect [0, %llu)",
695 btrfs_stack_block_group_used(&bgi), key->offset);
699 flags = btrfs_stack_block_group_flags(&bgi);
700 if (unlikely(hweight64(flags & BTRFS_BLOCK_GROUP_PROFILE_MASK) > 1)) {
701 block_group_err(leaf, slot,
702 "invalid profile flags, have 0x%llx (%lu bits set) expect no more than 1 bit set",
703 flags & BTRFS_BLOCK_GROUP_PROFILE_MASK,
704 hweight64(flags & BTRFS_BLOCK_GROUP_PROFILE_MASK));
708 type = flags & BTRFS_BLOCK_GROUP_TYPE_MASK;
709 if (unlikely(type != BTRFS_BLOCK_GROUP_DATA &&
710 type != BTRFS_BLOCK_GROUP_METADATA &&
711 type != BTRFS_BLOCK_GROUP_SYSTEM &&
712 type != (BTRFS_BLOCK_GROUP_METADATA |
713 BTRFS_BLOCK_GROUP_DATA))) {
714 block_group_err(leaf, slot,
715 "invalid type, have 0x%llx (%lu bits set) expect either 0x%llx, 0x%llx, 0x%llx or 0x%llx",
716 type, hweight64(type),
717 BTRFS_BLOCK_GROUP_DATA, BTRFS_BLOCK_GROUP_METADATA,
718 BTRFS_BLOCK_GROUP_SYSTEM,
719 BTRFS_BLOCK_GROUP_METADATA | BTRFS_BLOCK_GROUP_DATA);
727 static void chunk_err(const struct extent_buffer *leaf,
728 const struct btrfs_chunk *chunk, u64 logical,
729 const char *fmt, ...)
731 const struct btrfs_fs_info *fs_info = leaf->fs_info;
733 struct va_format vaf;
738 /* Only superblock eb is able to have such small offset */
739 is_sb = (leaf->start == BTRFS_SUPER_INFO_OFFSET);
743 * Get the slot number by iterating through all slots, this
744 * would provide better readability.
746 for (i = 0; i < btrfs_header_nritems(leaf); i++) {
747 if (btrfs_item_ptr_offset(leaf, i) ==
748 (unsigned long)chunk) {
760 "corrupt superblock syschunk array: chunk_start=%llu, %pV",
764 "corrupt leaf: root=%llu block=%llu slot=%d chunk_start=%llu, %pV",
765 BTRFS_CHUNK_TREE_OBJECTID, leaf->start, slot,
771 * The common chunk check which could also work on super block sys chunk array.
773 * Return -EUCLEAN if anything is corrupted.
774 * Return 0 if everything is OK.
776 int btrfs_check_chunk_valid(struct extent_buffer *leaf,
777 struct btrfs_chunk *chunk, u64 logical)
779 struct btrfs_fs_info *fs_info = leaf->fs_info;
792 length = btrfs_chunk_length(leaf, chunk);
793 stripe_len = btrfs_chunk_stripe_len(leaf, chunk);
794 num_stripes = btrfs_chunk_num_stripes(leaf, chunk);
795 sub_stripes = btrfs_chunk_sub_stripes(leaf, chunk);
796 type = btrfs_chunk_type(leaf, chunk);
797 raid_index = btrfs_bg_flags_to_raid_index(type);
798 ncopies = btrfs_raid_array[raid_index].ncopies;
799 nparity = btrfs_raid_array[raid_index].nparity;
801 if (unlikely(!num_stripes)) {
802 chunk_err(leaf, chunk, logical,
803 "invalid chunk num_stripes, have %u", num_stripes);
806 if (unlikely(num_stripes < ncopies)) {
807 chunk_err(leaf, chunk, logical,
808 "invalid chunk num_stripes < ncopies, have %u < %d",
809 num_stripes, ncopies);
812 if (unlikely(nparity && num_stripes == nparity)) {
813 chunk_err(leaf, chunk, logical,
814 "invalid chunk num_stripes == nparity, have %u == %d",
815 num_stripes, nparity);
818 if (unlikely(!IS_ALIGNED(logical, fs_info->sectorsize))) {
819 chunk_err(leaf, chunk, logical,
820 "invalid chunk logical, have %llu should aligned to %u",
821 logical, fs_info->sectorsize);
824 if (unlikely(btrfs_chunk_sector_size(leaf, chunk) != fs_info->sectorsize)) {
825 chunk_err(leaf, chunk, logical,
826 "invalid chunk sectorsize, have %u expect %u",
827 btrfs_chunk_sector_size(leaf, chunk),
828 fs_info->sectorsize);
831 if (unlikely(!length || !IS_ALIGNED(length, fs_info->sectorsize))) {
832 chunk_err(leaf, chunk, logical,
833 "invalid chunk length, have %llu", length);
836 if (unlikely(check_add_overflow(logical, length, &chunk_end))) {
837 chunk_err(leaf, chunk, logical,
838 "invalid chunk logical start and length, have logical start %llu length %llu",
842 if (unlikely(!is_power_of_2(stripe_len) || stripe_len != BTRFS_STRIPE_LEN)) {
843 chunk_err(leaf, chunk, logical,
844 "invalid chunk stripe length: %llu",
848 if (unlikely(type & ~(BTRFS_BLOCK_GROUP_TYPE_MASK |
849 BTRFS_BLOCK_GROUP_PROFILE_MASK))) {
850 chunk_err(leaf, chunk, logical,
851 "unrecognized chunk type: 0x%llx",
852 ~(BTRFS_BLOCK_GROUP_TYPE_MASK |
853 BTRFS_BLOCK_GROUP_PROFILE_MASK) &
854 btrfs_chunk_type(leaf, chunk));
858 if (unlikely(!has_single_bit_set(type & BTRFS_BLOCK_GROUP_PROFILE_MASK) &&
859 (type & BTRFS_BLOCK_GROUP_PROFILE_MASK) != 0)) {
860 chunk_err(leaf, chunk, logical,
861 "invalid chunk profile flag: 0x%llx, expect 0 or 1 bit set",
862 type & BTRFS_BLOCK_GROUP_PROFILE_MASK);
865 if (unlikely((type & BTRFS_BLOCK_GROUP_TYPE_MASK) == 0)) {
866 chunk_err(leaf, chunk, logical,
867 "missing chunk type flag, have 0x%llx one bit must be set in 0x%llx",
868 type, BTRFS_BLOCK_GROUP_TYPE_MASK);
872 if (unlikely((type & BTRFS_BLOCK_GROUP_SYSTEM) &&
873 (type & (BTRFS_BLOCK_GROUP_METADATA |
874 BTRFS_BLOCK_GROUP_DATA)))) {
875 chunk_err(leaf, chunk, logical,
876 "system chunk with data or metadata type: 0x%llx",
881 features = btrfs_super_incompat_flags(fs_info->super_copy);
882 if (features & BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS)
886 if (unlikely((type & BTRFS_BLOCK_GROUP_METADATA) &&
887 (type & BTRFS_BLOCK_GROUP_DATA))) {
888 chunk_err(leaf, chunk, logical,
889 "mixed chunk type in non-mixed mode: 0x%llx", type);
894 if (unlikely((type & BTRFS_BLOCK_GROUP_RAID10 &&
895 sub_stripes != btrfs_raid_array[BTRFS_RAID_RAID10].sub_stripes) ||
896 (type & BTRFS_BLOCK_GROUP_RAID1 &&
897 num_stripes != btrfs_raid_array[BTRFS_RAID_RAID1].devs_min) ||
898 (type & BTRFS_BLOCK_GROUP_RAID1C3 &&
899 num_stripes != btrfs_raid_array[BTRFS_RAID_RAID1C3].devs_min) ||
900 (type & BTRFS_BLOCK_GROUP_RAID1C4 &&
901 num_stripes != btrfs_raid_array[BTRFS_RAID_RAID1C4].devs_min) ||
902 (type & BTRFS_BLOCK_GROUP_RAID5 &&
903 num_stripes < btrfs_raid_array[BTRFS_RAID_RAID5].devs_min) ||
904 (type & BTRFS_BLOCK_GROUP_RAID6 &&
905 num_stripes < btrfs_raid_array[BTRFS_RAID_RAID6].devs_min) ||
906 (type & BTRFS_BLOCK_GROUP_DUP &&
907 num_stripes != btrfs_raid_array[BTRFS_RAID_DUP].dev_stripes) ||
908 ((type & BTRFS_BLOCK_GROUP_PROFILE_MASK) == 0 &&
909 num_stripes != btrfs_raid_array[BTRFS_RAID_SINGLE].dev_stripes))) {
910 chunk_err(leaf, chunk, logical,
911 "invalid num_stripes:sub_stripes %u:%u for profile %llu",
912 num_stripes, sub_stripes,
913 type & BTRFS_BLOCK_GROUP_PROFILE_MASK);
921 * Enhanced version of chunk item checker.
923 * The common btrfs_check_chunk_valid() doesn't check item size since it needs
924 * to work on super block sys_chunk_array which doesn't have full item ptr.
926 static int check_leaf_chunk_item(struct extent_buffer *leaf,
927 struct btrfs_chunk *chunk,
928 struct btrfs_key *key, int slot)
932 if (unlikely(btrfs_item_size(leaf, slot) < sizeof(struct btrfs_chunk))) {
933 chunk_err(leaf, chunk, key->offset,
934 "invalid chunk item size: have %u expect [%zu, %u)",
935 btrfs_item_size(leaf, slot),
936 sizeof(struct btrfs_chunk),
937 BTRFS_LEAF_DATA_SIZE(leaf->fs_info));
941 num_stripes = btrfs_chunk_num_stripes(leaf, chunk);
942 /* Let btrfs_check_chunk_valid() handle this error type */
943 if (num_stripes == 0)
946 if (unlikely(btrfs_chunk_item_size(num_stripes) !=
947 btrfs_item_size(leaf, slot))) {
948 chunk_err(leaf, chunk, key->offset,
949 "invalid chunk item size: have %u expect %lu",
950 btrfs_item_size(leaf, slot),
951 btrfs_chunk_item_size(num_stripes));
955 return btrfs_check_chunk_valid(leaf, chunk, key->offset);
960 static void dev_item_err(const struct extent_buffer *eb, int slot,
961 const char *fmt, ...)
963 struct btrfs_key key;
964 struct va_format vaf;
967 btrfs_item_key_to_cpu(eb, &key, slot);
973 btrfs_crit(eb->fs_info,
974 "corrupt %s: root=%llu block=%llu slot=%d devid=%llu %pV",
975 btrfs_header_level(eb) == 0 ? "leaf" : "node",
976 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
981 static int check_dev_item(struct extent_buffer *leaf,
982 struct btrfs_key *key, int slot)
984 struct btrfs_dev_item *ditem;
985 const u32 item_size = btrfs_item_size(leaf, slot);
987 if (unlikely(key->objectid != BTRFS_DEV_ITEMS_OBJECTID)) {
988 dev_item_err(leaf, slot,
989 "invalid objectid: has=%llu expect=%llu",
990 key->objectid, BTRFS_DEV_ITEMS_OBJECTID);
994 if (unlikely(item_size != sizeof(*ditem))) {
995 dev_item_err(leaf, slot, "invalid item size: has %u expect %zu",
996 item_size, sizeof(*ditem));
1000 ditem = btrfs_item_ptr(leaf, slot, struct btrfs_dev_item);
1001 if (unlikely(btrfs_device_id(leaf, ditem) != key->offset)) {
1002 dev_item_err(leaf, slot,
1003 "devid mismatch: key has=%llu item has=%llu",
1004 key->offset, btrfs_device_id(leaf, ditem));
1009 * For device total_bytes, we don't have reliable way to check it, as
1010 * it can be 0 for device removal. Device size check can only be done
1011 * by dev extents check.
1013 if (unlikely(btrfs_device_bytes_used(leaf, ditem) >
1014 btrfs_device_total_bytes(leaf, ditem))) {
1015 dev_item_err(leaf, slot,
1016 "invalid bytes used: have %llu expect [0, %llu]",
1017 btrfs_device_bytes_used(leaf, ditem),
1018 btrfs_device_total_bytes(leaf, ditem));
1022 * Remaining members like io_align/type/gen/dev_group aren't really
1023 * utilized. Skip them to make later usage of them easier.
1028 static int check_inode_item(struct extent_buffer *leaf,
1029 struct btrfs_key *key, int slot)
1031 struct btrfs_fs_info *fs_info = leaf->fs_info;
1032 struct btrfs_inode_item *iitem;
1033 u64 super_gen = btrfs_super_generation(fs_info->super_copy);
1034 u32 valid_mask = (S_IFMT | S_ISUID | S_ISGID | S_ISVTX | 0777);
1035 const u32 item_size = btrfs_item_size(leaf, slot);
1041 ret = check_inode_key(leaf, key, slot);
1042 if (unlikely(ret < 0))
1045 if (unlikely(item_size != sizeof(*iitem))) {
1046 generic_err(leaf, slot, "invalid item size: has %u expect %zu",
1047 item_size, sizeof(*iitem));
1051 iitem = btrfs_item_ptr(leaf, slot, struct btrfs_inode_item);
1053 /* Here we use super block generation + 1 to handle log tree */
1054 if (unlikely(btrfs_inode_generation(leaf, iitem) > super_gen + 1)) {
1055 inode_item_err(leaf, slot,
1056 "invalid inode generation: has %llu expect (0, %llu]",
1057 btrfs_inode_generation(leaf, iitem),
1061 /* Note for ROOT_TREE_DIR_ITEM, mkfs could set its transid 0 */
1062 if (unlikely(btrfs_inode_transid(leaf, iitem) > super_gen + 1)) {
1063 inode_item_err(leaf, slot,
1064 "invalid inode transid: has %llu expect [0, %llu]",
1065 btrfs_inode_transid(leaf, iitem), super_gen + 1);
1070 * For size and nbytes it's better not to be too strict, as for dir
1071 * item its size/nbytes can easily get wrong, but doesn't affect
1072 * anything in the fs. So here we skip the check.
1074 mode = btrfs_inode_mode(leaf, iitem);
1075 if (unlikely(mode & ~valid_mask)) {
1076 inode_item_err(leaf, slot,
1077 "unknown mode bit detected: 0x%x",
1078 mode & ~valid_mask);
1083 * S_IFMT is not bit mapped so we can't completely rely on
1084 * is_power_of_2/has_single_bit_set, but it can save us from checking
1085 * FIFO/CHR/DIR/REG. Only needs to check BLK, LNK and SOCKS
1087 if (!has_single_bit_set(mode & S_IFMT)) {
1088 if (unlikely(!S_ISLNK(mode) && !S_ISBLK(mode) && !S_ISSOCK(mode))) {
1089 inode_item_err(leaf, slot,
1090 "invalid mode: has 0%o expect valid S_IF* bit(s)",
1095 if (unlikely(S_ISDIR(mode) && btrfs_inode_nlink(leaf, iitem) > 1)) {
1096 inode_item_err(leaf, slot,
1097 "invalid nlink: has %u expect no more than 1 for dir",
1098 btrfs_inode_nlink(leaf, iitem));
1101 btrfs_inode_split_flags(btrfs_inode_flags(leaf, iitem), &flags, &ro_flags);
1102 if (unlikely(flags & ~BTRFS_INODE_FLAG_MASK)) {
1103 inode_item_err(leaf, slot,
1104 "unknown incompat flags detected: 0x%x", flags);
1107 if (unlikely(!sb_rdonly(fs_info->sb) &&
1108 (ro_flags & ~BTRFS_INODE_RO_FLAG_MASK))) {
1109 inode_item_err(leaf, slot,
1110 "unknown ro-compat flags detected on writeable mount: 0x%x",
1117 static int check_root_item(struct extent_buffer *leaf, struct btrfs_key *key,
1120 struct btrfs_fs_info *fs_info = leaf->fs_info;
1121 struct btrfs_root_item ri = { 0 };
1122 const u64 valid_root_flags = BTRFS_ROOT_SUBVOL_RDONLY |
1123 BTRFS_ROOT_SUBVOL_DEAD;
1126 ret = check_root_key(leaf, key, slot);
1127 if (unlikely(ret < 0))
1130 if (unlikely(btrfs_item_size(leaf, slot) != sizeof(ri) &&
1131 btrfs_item_size(leaf, slot) !=
1132 btrfs_legacy_root_item_size())) {
1133 generic_err(leaf, slot,
1134 "invalid root item size, have %u expect %zu or %u",
1135 btrfs_item_size(leaf, slot), sizeof(ri),
1136 btrfs_legacy_root_item_size());
1141 * For legacy root item, the members starting at generation_v2 will be
1142 * all filled with 0.
1143 * And since we allow geneartion_v2 as 0, it will still pass the check.
1145 read_extent_buffer(leaf, &ri, btrfs_item_ptr_offset(leaf, slot),
1146 btrfs_item_size(leaf, slot));
1148 /* Generation related */
1149 if (unlikely(btrfs_root_generation(&ri) >
1150 btrfs_super_generation(fs_info->super_copy) + 1)) {
1151 generic_err(leaf, slot,
1152 "invalid root generation, have %llu expect (0, %llu]",
1153 btrfs_root_generation(&ri),
1154 btrfs_super_generation(fs_info->super_copy) + 1);
1157 if (unlikely(btrfs_root_generation_v2(&ri) >
1158 btrfs_super_generation(fs_info->super_copy) + 1)) {
1159 generic_err(leaf, slot,
1160 "invalid root v2 generation, have %llu expect (0, %llu]",
1161 btrfs_root_generation_v2(&ri),
1162 btrfs_super_generation(fs_info->super_copy) + 1);
1165 if (unlikely(btrfs_root_last_snapshot(&ri) >
1166 btrfs_super_generation(fs_info->super_copy) + 1)) {
1167 generic_err(leaf, slot,
1168 "invalid root last_snapshot, have %llu expect (0, %llu]",
1169 btrfs_root_last_snapshot(&ri),
1170 btrfs_super_generation(fs_info->super_copy) + 1);
1174 /* Alignment and level check */
1175 if (unlikely(!IS_ALIGNED(btrfs_root_bytenr(&ri), fs_info->sectorsize))) {
1176 generic_err(leaf, slot,
1177 "invalid root bytenr, have %llu expect to be aligned to %u",
1178 btrfs_root_bytenr(&ri), fs_info->sectorsize);
1181 if (unlikely(btrfs_root_level(&ri) >= BTRFS_MAX_LEVEL)) {
1182 generic_err(leaf, slot,
1183 "invalid root level, have %u expect [0, %u]",
1184 btrfs_root_level(&ri), BTRFS_MAX_LEVEL - 1);
1187 if (unlikely(btrfs_root_drop_level(&ri) >= BTRFS_MAX_LEVEL)) {
1188 generic_err(leaf, slot,
1189 "invalid root level, have %u expect [0, %u]",
1190 btrfs_root_drop_level(&ri), BTRFS_MAX_LEVEL - 1);
1195 if (unlikely(btrfs_root_flags(&ri) & ~valid_root_flags)) {
1196 generic_err(leaf, slot,
1197 "invalid root flags, have 0x%llx expect mask 0x%llx",
1198 btrfs_root_flags(&ri), valid_root_flags);
1206 static void extent_err(const struct extent_buffer *eb, int slot,
1207 const char *fmt, ...)
1209 struct btrfs_key key;
1210 struct va_format vaf;
1215 btrfs_item_key_to_cpu(eb, &key, slot);
1216 bytenr = key.objectid;
1217 if (key.type == BTRFS_METADATA_ITEM_KEY ||
1218 key.type == BTRFS_TREE_BLOCK_REF_KEY ||
1219 key.type == BTRFS_SHARED_BLOCK_REF_KEY)
1220 len = eb->fs_info->nodesize;
1223 va_start(args, fmt);
1228 btrfs_crit(eb->fs_info,
1229 "corrupt %s: block=%llu slot=%d extent bytenr=%llu len=%llu %pV",
1230 btrfs_header_level(eb) == 0 ? "leaf" : "node",
1231 eb->start, slot, bytenr, len, &vaf);
1235 static int check_extent_item(struct extent_buffer *leaf,
1236 struct btrfs_key *key, int slot)
1238 struct btrfs_fs_info *fs_info = leaf->fs_info;
1239 struct btrfs_extent_item *ei;
1240 bool is_tree_block = false;
1241 unsigned long ptr; /* Current pointer inside inline refs */
1242 unsigned long end; /* Extent item end */
1243 const u32 item_size = btrfs_item_size(leaf, slot);
1246 u64 total_refs; /* Total refs in btrfs_extent_item */
1247 u64 inline_refs = 0; /* found total inline refs */
1249 if (unlikely(key->type == BTRFS_METADATA_ITEM_KEY &&
1250 !btrfs_fs_incompat(fs_info, SKINNY_METADATA))) {
1251 generic_err(leaf, slot,
1252 "invalid key type, METADATA_ITEM type invalid when SKINNY_METADATA feature disabled");
1255 /* key->objectid is the bytenr for both key types */
1256 if (unlikely(!IS_ALIGNED(key->objectid, fs_info->sectorsize))) {
1257 generic_err(leaf, slot,
1258 "invalid key objectid, have %llu expect to be aligned to %u",
1259 key->objectid, fs_info->sectorsize);
1263 /* key->offset is tree level for METADATA_ITEM_KEY */
1264 if (unlikely(key->type == BTRFS_METADATA_ITEM_KEY &&
1265 key->offset >= BTRFS_MAX_LEVEL)) {
1266 extent_err(leaf, slot,
1267 "invalid tree level, have %llu expect [0, %u]",
1268 key->offset, BTRFS_MAX_LEVEL - 1);
1273 * EXTENT/METADATA_ITEM consists of:
1274 * 1) One btrfs_extent_item
1275 * Records the total refs, type and generation of the extent.
1277 * 2) One btrfs_tree_block_info (for EXTENT_ITEM and tree backref only)
1278 * Records the first key and level of the tree block.
1280 * 2) Zero or more btrfs_extent_inline_ref(s)
1281 * Each inline ref has one btrfs_extent_inline_ref shows:
1282 * 2.1) The ref type, one of the 4
1283 * TREE_BLOCK_REF Tree block only
1284 * SHARED_BLOCK_REF Tree block only
1285 * EXTENT_DATA_REF Data only
1286 * SHARED_DATA_REF Data only
1287 * 2.2) Ref type specific data
1288 * Either using btrfs_extent_inline_ref::offset, or specific
1291 if (unlikely(item_size < sizeof(*ei))) {
1292 extent_err(leaf, slot,
1293 "invalid item size, have %u expect [%zu, %u)",
1294 item_size, sizeof(*ei),
1295 BTRFS_LEAF_DATA_SIZE(fs_info));
1298 end = item_size + btrfs_item_ptr_offset(leaf, slot);
1300 /* Checks against extent_item */
1301 ei = btrfs_item_ptr(leaf, slot, struct btrfs_extent_item);
1302 flags = btrfs_extent_flags(leaf, ei);
1303 total_refs = btrfs_extent_refs(leaf, ei);
1304 generation = btrfs_extent_generation(leaf, ei);
1305 if (unlikely(generation >
1306 btrfs_super_generation(fs_info->super_copy) + 1)) {
1307 extent_err(leaf, slot,
1308 "invalid generation, have %llu expect (0, %llu]",
1310 btrfs_super_generation(fs_info->super_copy) + 1);
1313 if (unlikely(!has_single_bit_set(flags & (BTRFS_EXTENT_FLAG_DATA |
1314 BTRFS_EXTENT_FLAG_TREE_BLOCK)))) {
1315 extent_err(leaf, slot,
1316 "invalid extent flag, have 0x%llx expect 1 bit set in 0x%llx",
1317 flags, BTRFS_EXTENT_FLAG_DATA |
1318 BTRFS_EXTENT_FLAG_TREE_BLOCK);
1321 is_tree_block = !!(flags & BTRFS_EXTENT_FLAG_TREE_BLOCK);
1322 if (is_tree_block) {
1323 if (unlikely(key->type == BTRFS_EXTENT_ITEM_KEY &&
1324 key->offset != fs_info->nodesize)) {
1325 extent_err(leaf, slot,
1326 "invalid extent length, have %llu expect %u",
1327 key->offset, fs_info->nodesize);
1331 if (unlikely(key->type != BTRFS_EXTENT_ITEM_KEY)) {
1332 extent_err(leaf, slot,
1333 "invalid key type, have %u expect %u for data backref",
1334 key->type, BTRFS_EXTENT_ITEM_KEY);
1337 if (unlikely(!IS_ALIGNED(key->offset, fs_info->sectorsize))) {
1338 extent_err(leaf, slot,
1339 "invalid extent length, have %llu expect aligned to %u",
1340 key->offset, fs_info->sectorsize);
1343 if (unlikely(flags & BTRFS_BLOCK_FLAG_FULL_BACKREF)) {
1344 extent_err(leaf, slot,
1345 "invalid extent flag, data has full backref set");
1349 ptr = (unsigned long)(struct btrfs_extent_item *)(ei + 1);
1351 /* Check the special case of btrfs_tree_block_info */
1352 if (is_tree_block && key->type != BTRFS_METADATA_ITEM_KEY) {
1353 struct btrfs_tree_block_info *info;
1355 info = (struct btrfs_tree_block_info *)ptr;
1356 if (unlikely(btrfs_tree_block_level(leaf, info) >= BTRFS_MAX_LEVEL)) {
1357 extent_err(leaf, slot,
1358 "invalid tree block info level, have %u expect [0, %u]",
1359 btrfs_tree_block_level(leaf, info),
1360 BTRFS_MAX_LEVEL - 1);
1363 ptr = (unsigned long)(struct btrfs_tree_block_info *)(info + 1);
1366 /* Check inline refs */
1368 struct btrfs_extent_inline_ref *iref;
1369 struct btrfs_extent_data_ref *dref;
1370 struct btrfs_shared_data_ref *sref;
1375 if (unlikely(ptr + sizeof(*iref) > end)) {
1376 extent_err(leaf, slot,
1377 "inline ref item overflows extent item, ptr %lu iref size %zu end %lu",
1378 ptr, sizeof(*iref), end);
1381 iref = (struct btrfs_extent_inline_ref *)ptr;
1382 inline_type = btrfs_extent_inline_ref_type(leaf, iref);
1383 inline_offset = btrfs_extent_inline_ref_offset(leaf, iref);
1384 if (unlikely(ptr + btrfs_extent_inline_ref_size(inline_type) > end)) {
1385 extent_err(leaf, slot,
1386 "inline ref item overflows extent item, ptr %lu iref size %u end %lu",
1387 ptr, inline_type, end);
1391 switch (inline_type) {
1392 /* inline_offset is subvolid of the owner, no need to check */
1393 case BTRFS_TREE_BLOCK_REF_KEY:
1396 /* Contains parent bytenr */
1397 case BTRFS_SHARED_BLOCK_REF_KEY:
1398 if (unlikely(!IS_ALIGNED(inline_offset,
1399 fs_info->sectorsize))) {
1400 extent_err(leaf, slot,
1401 "invalid tree parent bytenr, have %llu expect aligned to %u",
1402 inline_offset, fs_info->sectorsize);
1408 * Contains owner subvolid, owner key objectid, adjusted offset.
1409 * The only obvious corruption can happen in that offset.
1411 case BTRFS_EXTENT_DATA_REF_KEY:
1412 dref = (struct btrfs_extent_data_ref *)(&iref->offset);
1413 dref_offset = btrfs_extent_data_ref_offset(leaf, dref);
1414 if (unlikely(!IS_ALIGNED(dref_offset,
1415 fs_info->sectorsize))) {
1416 extent_err(leaf, slot,
1417 "invalid data ref offset, have %llu expect aligned to %u",
1418 dref_offset, fs_info->sectorsize);
1421 inline_refs += btrfs_extent_data_ref_count(leaf, dref);
1423 /* Contains parent bytenr and ref count */
1424 case BTRFS_SHARED_DATA_REF_KEY:
1425 sref = (struct btrfs_shared_data_ref *)(iref + 1);
1426 if (unlikely(!IS_ALIGNED(inline_offset,
1427 fs_info->sectorsize))) {
1428 extent_err(leaf, slot,
1429 "invalid data parent bytenr, have %llu expect aligned to %u",
1430 inline_offset, fs_info->sectorsize);
1433 inline_refs += btrfs_shared_data_ref_count(leaf, sref);
1436 extent_err(leaf, slot, "unknown inline ref type: %u",
1440 ptr += btrfs_extent_inline_ref_size(inline_type);
1442 /* No padding is allowed */
1443 if (unlikely(ptr != end)) {
1444 extent_err(leaf, slot,
1445 "invalid extent item size, padding bytes found");
1449 /* Finally, check the inline refs against total refs */
1450 if (unlikely(inline_refs > total_refs)) {
1451 extent_err(leaf, slot,
1452 "invalid extent refs, have %llu expect >= inline %llu",
1453 total_refs, inline_refs);
1459 static int check_simple_keyed_refs(struct extent_buffer *leaf,
1460 struct btrfs_key *key, int slot)
1462 u32 expect_item_size = 0;
1464 if (key->type == BTRFS_SHARED_DATA_REF_KEY)
1465 expect_item_size = sizeof(struct btrfs_shared_data_ref);
1467 if (unlikely(btrfs_item_size(leaf, slot) != expect_item_size)) {
1468 generic_err(leaf, slot,
1469 "invalid item size, have %u expect %u for key type %u",
1470 btrfs_item_size(leaf, slot),
1471 expect_item_size, key->type);
1474 if (unlikely(!IS_ALIGNED(key->objectid, leaf->fs_info->sectorsize))) {
1475 generic_err(leaf, slot,
1476 "invalid key objectid for shared block ref, have %llu expect aligned to %u",
1477 key->objectid, leaf->fs_info->sectorsize);
1480 if (unlikely(key->type != BTRFS_TREE_BLOCK_REF_KEY &&
1481 !IS_ALIGNED(key->offset, leaf->fs_info->sectorsize))) {
1482 extent_err(leaf, slot,
1483 "invalid tree parent bytenr, have %llu expect aligned to %u",
1484 key->offset, leaf->fs_info->sectorsize);
1490 static int check_extent_data_ref(struct extent_buffer *leaf,
1491 struct btrfs_key *key, int slot)
1493 struct btrfs_extent_data_ref *dref;
1494 unsigned long ptr = btrfs_item_ptr_offset(leaf, slot);
1495 const unsigned long end = ptr + btrfs_item_size(leaf, slot);
1497 if (unlikely(btrfs_item_size(leaf, slot) % sizeof(*dref) != 0)) {
1498 generic_err(leaf, slot,
1499 "invalid item size, have %u expect aligned to %zu for key type %u",
1500 btrfs_item_size(leaf, slot),
1501 sizeof(*dref), key->type);
1504 if (unlikely(!IS_ALIGNED(key->objectid, leaf->fs_info->sectorsize))) {
1505 generic_err(leaf, slot,
1506 "invalid key objectid for shared block ref, have %llu expect aligned to %u",
1507 key->objectid, leaf->fs_info->sectorsize);
1510 for (; ptr < end; ptr += sizeof(*dref)) {
1514 * We cannot check the extent_data_ref hash due to possible
1515 * overflow from the leaf due to hash collisions.
1517 dref = (struct btrfs_extent_data_ref *)ptr;
1518 offset = btrfs_extent_data_ref_offset(leaf, dref);
1519 if (unlikely(!IS_ALIGNED(offset, leaf->fs_info->sectorsize))) {
1520 extent_err(leaf, slot,
1521 "invalid extent data backref offset, have %llu expect aligned to %u",
1522 offset, leaf->fs_info->sectorsize);
1529 #define inode_ref_err(eb, slot, fmt, args...) \
1530 inode_item_err(eb, slot, fmt, ##args)
1531 static int check_inode_ref(struct extent_buffer *leaf,
1532 struct btrfs_key *key, struct btrfs_key *prev_key,
1535 struct btrfs_inode_ref *iref;
1539 if (unlikely(!check_prev_ino(leaf, key, slot, prev_key)))
1541 /* namelen can't be 0, so item_size == sizeof() is also invalid */
1542 if (unlikely(btrfs_item_size(leaf, slot) <= sizeof(*iref))) {
1543 inode_ref_err(leaf, slot,
1544 "invalid item size, have %u expect (%zu, %u)",
1545 btrfs_item_size(leaf, slot),
1546 sizeof(*iref), BTRFS_LEAF_DATA_SIZE(leaf->fs_info));
1550 ptr = btrfs_item_ptr_offset(leaf, slot);
1551 end = ptr + btrfs_item_size(leaf, slot);
1555 if (unlikely(ptr + sizeof(iref) > end)) {
1556 inode_ref_err(leaf, slot,
1557 "inode ref overflow, ptr %lu end %lu inode_ref_size %zu",
1558 ptr, end, sizeof(iref));
1562 iref = (struct btrfs_inode_ref *)ptr;
1563 namelen = btrfs_inode_ref_name_len(leaf, iref);
1564 if (unlikely(ptr + sizeof(*iref) + namelen > end)) {
1565 inode_ref_err(leaf, slot,
1566 "inode ref overflow, ptr %lu end %lu namelen %u",
1572 * NOTE: In theory we should record all found index numbers
1573 * to find any duplicated indexes, but that will be too time
1574 * consuming for inodes with too many hard links.
1576 ptr += sizeof(*iref) + namelen;
1582 * Common point to switch the item-specific validation.
1584 static int check_leaf_item(struct extent_buffer *leaf,
1585 struct btrfs_key *key, int slot,
1586 struct btrfs_key *prev_key)
1589 struct btrfs_chunk *chunk;
1591 switch (key->type) {
1592 case BTRFS_EXTENT_DATA_KEY:
1593 ret = check_extent_data_item(leaf, key, slot, prev_key);
1595 case BTRFS_EXTENT_CSUM_KEY:
1596 ret = check_csum_item(leaf, key, slot, prev_key);
1598 case BTRFS_DIR_ITEM_KEY:
1599 case BTRFS_DIR_INDEX_KEY:
1600 case BTRFS_XATTR_ITEM_KEY:
1601 ret = check_dir_item(leaf, key, prev_key, slot);
1603 case BTRFS_INODE_REF_KEY:
1604 ret = check_inode_ref(leaf, key, prev_key, slot);
1606 case BTRFS_BLOCK_GROUP_ITEM_KEY:
1607 ret = check_block_group_item(leaf, key, slot);
1609 case BTRFS_CHUNK_ITEM_KEY:
1610 chunk = btrfs_item_ptr(leaf, slot, struct btrfs_chunk);
1611 ret = check_leaf_chunk_item(leaf, chunk, key, slot);
1613 case BTRFS_DEV_ITEM_KEY:
1614 ret = check_dev_item(leaf, key, slot);
1616 case BTRFS_INODE_ITEM_KEY:
1617 ret = check_inode_item(leaf, key, slot);
1619 case BTRFS_ROOT_ITEM_KEY:
1620 ret = check_root_item(leaf, key, slot);
1622 case BTRFS_EXTENT_ITEM_KEY:
1623 case BTRFS_METADATA_ITEM_KEY:
1624 ret = check_extent_item(leaf, key, slot);
1626 case BTRFS_TREE_BLOCK_REF_KEY:
1627 case BTRFS_SHARED_DATA_REF_KEY:
1628 case BTRFS_SHARED_BLOCK_REF_KEY:
1629 ret = check_simple_keyed_refs(leaf, key, slot);
1631 case BTRFS_EXTENT_DATA_REF_KEY:
1632 ret = check_extent_data_ref(leaf, key, slot);
1638 static int check_leaf(struct extent_buffer *leaf, bool check_item_data)
1640 struct btrfs_fs_info *fs_info = leaf->fs_info;
1641 /* No valid key type is 0, so all key should be larger than this key */
1642 struct btrfs_key prev_key = {0, 0, 0};
1643 struct btrfs_key key;
1644 u32 nritems = btrfs_header_nritems(leaf);
1647 if (unlikely(btrfs_header_level(leaf) != 0)) {
1648 generic_err(leaf, 0,
1649 "invalid level for leaf, have %d expect 0",
1650 btrfs_header_level(leaf));
1655 * Extent buffers from a relocation tree have a owner field that
1656 * corresponds to the subvolume tree they are based on. So just from an
1657 * extent buffer alone we can not find out what is the id of the
1658 * corresponding subvolume tree, so we can not figure out if the extent
1659 * buffer corresponds to the root of the relocation tree or not. So
1660 * skip this check for relocation trees.
1662 if (nritems == 0 && !btrfs_header_flag(leaf, BTRFS_HEADER_FLAG_RELOC)) {
1663 u64 owner = btrfs_header_owner(leaf);
1665 /* These trees must never be empty */
1666 if (unlikely(owner == BTRFS_ROOT_TREE_OBJECTID ||
1667 owner == BTRFS_CHUNK_TREE_OBJECTID ||
1668 owner == BTRFS_DEV_TREE_OBJECTID ||
1669 owner == BTRFS_FS_TREE_OBJECTID ||
1670 owner == BTRFS_DATA_RELOC_TREE_OBJECTID)) {
1671 generic_err(leaf, 0,
1672 "invalid root, root %llu must never be empty",
1678 if (unlikely(owner == 0)) {
1679 generic_err(leaf, 0,
1680 "invalid owner, root 0 is not defined");
1684 /* EXTENT_TREE_V2 can have empty extent trees. */
1685 if (btrfs_fs_incompat(fs_info, EXTENT_TREE_V2))
1688 if (unlikely(owner == BTRFS_EXTENT_TREE_OBJECTID)) {
1689 generic_err(leaf, 0,
1690 "invalid root, root %llu must never be empty",
1698 if (unlikely(nritems == 0))
1702 * Check the following things to make sure this is a good leaf, and
1703 * leaf users won't need to bother with similar sanity checks:
1706 * 2) item offset and size
1707 * No overlap, no hole, all inside the leaf.
1709 * If possible, do comprehensive sanity check.
1710 * NOTE: All checks must only rely on the item data itself.
1712 for (slot = 0; slot < nritems; slot++) {
1713 u32 item_end_expected;
1717 btrfs_item_key_to_cpu(leaf, &key, slot);
1719 /* Make sure the keys are in the right order */
1720 if (unlikely(btrfs_comp_cpu_keys(&prev_key, &key) >= 0)) {
1721 generic_err(leaf, slot,
1722 "bad key order, prev (%llu %u %llu) current (%llu %u %llu)",
1723 prev_key.objectid, prev_key.type,
1724 prev_key.offset, key.objectid, key.type,
1729 item_data_end = (u64)btrfs_item_offset(leaf, slot) +
1730 btrfs_item_size(leaf, slot);
1732 * Make sure the offset and ends are right, remember that the
1733 * item data starts at the end of the leaf and grows towards the
1737 item_end_expected = BTRFS_LEAF_DATA_SIZE(fs_info);
1739 item_end_expected = btrfs_item_offset(leaf,
1741 if (unlikely(item_data_end != item_end_expected)) {
1742 generic_err(leaf, slot,
1743 "unexpected item end, have %llu expect %u",
1744 item_data_end, item_end_expected);
1749 * Check to make sure that we don't point outside of the leaf,
1750 * just in case all the items are consistent to each other, but
1751 * all point outside of the leaf.
1753 if (unlikely(item_data_end > BTRFS_LEAF_DATA_SIZE(fs_info))) {
1754 generic_err(leaf, slot,
1755 "slot end outside of leaf, have %llu expect range [0, %u]",
1756 item_data_end, BTRFS_LEAF_DATA_SIZE(fs_info));
1760 /* Also check if the item pointer overlaps with btrfs item. */
1761 if (unlikely(btrfs_item_ptr_offset(leaf, slot) <
1762 btrfs_item_nr_offset(slot) + sizeof(struct btrfs_item))) {
1763 generic_err(leaf, slot,
1764 "slot overlaps with its data, item end %lu data start %lu",
1765 btrfs_item_nr_offset(slot) +
1766 sizeof(struct btrfs_item),
1767 btrfs_item_ptr_offset(leaf, slot));
1771 if (check_item_data) {
1773 * Check if the item size and content meet other
1776 ret = check_leaf_item(leaf, &key, slot, &prev_key);
1777 if (unlikely(ret < 0))
1781 prev_key.objectid = key.objectid;
1782 prev_key.type = key.type;
1783 prev_key.offset = key.offset;
1789 int btrfs_check_leaf_full(struct extent_buffer *leaf)
1791 return check_leaf(leaf, true);
1793 ALLOW_ERROR_INJECTION(btrfs_check_leaf_full, ERRNO);
1795 int btrfs_check_leaf_relaxed(struct extent_buffer *leaf)
1797 return check_leaf(leaf, false);
1800 int btrfs_check_node(struct extent_buffer *node)
1802 struct btrfs_fs_info *fs_info = node->fs_info;
1803 unsigned long nr = btrfs_header_nritems(node);
1804 struct btrfs_key key, next_key;
1806 int level = btrfs_header_level(node);
1810 if (unlikely(level <= 0 || level >= BTRFS_MAX_LEVEL)) {
1811 generic_err(node, 0,
1812 "invalid level for node, have %d expect [1, %d]",
1813 level, BTRFS_MAX_LEVEL - 1);
1816 if (unlikely(nr == 0 || nr > BTRFS_NODEPTRS_PER_BLOCK(fs_info))) {
1818 "corrupt node: root=%llu block=%llu, nritems too %s, have %lu expect range [1,%u]",
1819 btrfs_header_owner(node), node->start,
1820 nr == 0 ? "small" : "large", nr,
1821 BTRFS_NODEPTRS_PER_BLOCK(fs_info));
1825 for (slot = 0; slot < nr - 1; slot++) {
1826 bytenr = btrfs_node_blockptr(node, slot);
1827 btrfs_node_key_to_cpu(node, &key, slot);
1828 btrfs_node_key_to_cpu(node, &next_key, slot + 1);
1830 if (unlikely(!bytenr)) {
1831 generic_err(node, slot,
1832 "invalid NULL node pointer");
1836 if (unlikely(!IS_ALIGNED(bytenr, fs_info->sectorsize))) {
1837 generic_err(node, slot,
1838 "unaligned pointer, have %llu should be aligned to %u",
1839 bytenr, fs_info->sectorsize);
1844 if (unlikely(btrfs_comp_cpu_keys(&key, &next_key) >= 0)) {
1845 generic_err(node, slot,
1846 "bad key order, current (%llu %u %llu) next (%llu %u %llu)",
1847 key.objectid, key.type, key.offset,
1848 next_key.objectid, next_key.type,
1857 ALLOW_ERROR_INJECTION(btrfs_check_node, ERRNO);
1859 int btrfs_check_eb_owner(const struct extent_buffer *eb, u64 root_owner)
1861 const bool is_subvol = is_fstree(root_owner);
1862 const u64 eb_owner = btrfs_header_owner(eb);
1865 * Skip dummy fs, as selftests don't create unique ebs for each dummy
1868 if (test_bit(BTRFS_FS_STATE_DUMMY_FS_INFO, &eb->fs_info->fs_state))
1871 * There are several call sites (backref walking, qgroup, and data
1872 * reloc) passing 0 as @root_owner, as they are not holding the
1873 * tree root. In that case, we can not do a reliable ownership check,
1876 if (root_owner == 0)
1879 * These trees use key.offset as their owner, our callers don't have
1880 * the extra capacity to pass key.offset here. So we just skip them.
1882 if (root_owner == BTRFS_TREE_LOG_OBJECTID ||
1883 root_owner == BTRFS_TREE_RELOC_OBJECTID)
1887 /* For non-subvolume trees, the eb owner should match root owner */
1888 if (unlikely(root_owner != eb_owner)) {
1889 btrfs_crit(eb->fs_info,
1890 "corrupted %s, root=%llu block=%llu owner mismatch, have %llu expect %llu",
1891 btrfs_header_level(eb) == 0 ? "leaf" : "node",
1892 root_owner, btrfs_header_bytenr(eb), eb_owner,
1900 * For subvolume trees, owners can mismatch, but they should all belong
1901 * to subvolume trees.
1903 if (unlikely(is_subvol != is_fstree(eb_owner))) {
1904 btrfs_crit(eb->fs_info,
1905 "corrupted %s, root=%llu block=%llu owner mismatch, have %llu expect [%llu, %llu]",
1906 btrfs_header_level(eb) == 0 ? "leaf" : "node",
1907 root_owner, btrfs_header_bytenr(eb), eb_owner,
1908 BTRFS_FIRST_FREE_OBJECTID, BTRFS_LAST_FREE_OBJECTID);