]> asedeno.scripts.mit.edu Git - linux.git/blob - fs/btrfs/tree-checker.c
btrfs: tree-checker: Refactor inode key check into seperate function
[linux.git] / fs / btrfs / tree-checker.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (C) Qu Wenruo 2017.  All rights reserved.
4  */
5
6 /*
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.
9  *
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.
13  *
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.
16  */
17
18 #include <linux/types.h>
19 #include <linux/stddef.h>
20 #include <linux/error-injection.h>
21 #include "ctree.h"
22 #include "tree-checker.h"
23 #include "disk-io.h"
24 #include "compression.h"
25 #include "volumes.h"
26 #include "misc.h"
27
28 /*
29  * Error message should follow the following format:
30  * corrupt <type>: <identifier>, <reason>[, <bad_value>]
31  *
32  * @type:       leaf or node
33  * @identifier: the necessary info to locate the leaf/node.
34  *              It's recommended to decode key.objecitd/offset if it's
35  *              meaningful.
36  * @reason:     describe the error
37  * @bad_value:  optional, it's recommended to output bad value and its
38  *              expected value (range).
39  *
40  * Since comma is used to separate the components, only space is allowed
41  * inside each component.
42  */
43
44 /*
45  * Append generic "corrupt leaf/node root=%llu block=%llu slot=%d: " to @fmt.
46  * Allows callers to customize the output.
47  */
48 __printf(3, 4)
49 __cold
50 static void generic_err(const struct extent_buffer *eb, int slot,
51                         const char *fmt, ...)
52 {
53         const struct btrfs_fs_info *fs_info = eb->fs_info;
54         struct va_format vaf;
55         va_list args;
56
57         va_start(args, fmt);
58
59         vaf.fmt = fmt;
60         vaf.va = &args;
61
62         btrfs_crit(fs_info,
63                 "corrupt %s: root=%llu block=%llu slot=%d, %pV",
64                 btrfs_header_level(eb) == 0 ? "leaf" : "node",
65                 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot, &vaf);
66         va_end(args);
67 }
68
69 /*
70  * Customized reporter for extent data item, since its key objectid and
71  * offset has its own meaning.
72  */
73 __printf(3, 4)
74 __cold
75 static void file_extent_err(const struct extent_buffer *eb, int slot,
76                             const char *fmt, ...)
77 {
78         const struct btrfs_fs_info *fs_info = eb->fs_info;
79         struct btrfs_key key;
80         struct va_format vaf;
81         va_list args;
82
83         btrfs_item_key_to_cpu(eb, &key, slot);
84         va_start(args, fmt);
85
86         vaf.fmt = fmt;
87         vaf.va = &args;
88
89         btrfs_crit(fs_info,
90         "corrupt %s: root=%llu block=%llu slot=%d ino=%llu file_offset=%llu, %pV",
91                 btrfs_header_level(eb) == 0 ? "leaf" : "node",
92                 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
93                 key.objectid, key.offset, &vaf);
94         va_end(args);
95 }
96
97 /*
98  * Return 0 if the btrfs_file_extent_##name is aligned to @alignment
99  * Else return 1
100  */
101 #define CHECK_FE_ALIGNED(leaf, slot, fi, name, alignment)                     \
102 ({                                                                            \
103         if (!IS_ALIGNED(btrfs_file_extent_##name((leaf), (fi)), (alignment))) \
104                 file_extent_err((leaf), (slot),                               \
105         "invalid %s for file extent, have %llu, should be aligned to %u",     \
106                         (#name), btrfs_file_extent_##name((leaf), (fi)),      \
107                         (alignment));                                         \
108         (!IS_ALIGNED(btrfs_file_extent_##name((leaf), (fi)), (alignment)));   \
109 })
110
111 static u64 file_extent_end(struct extent_buffer *leaf,
112                            struct btrfs_key *key,
113                            struct btrfs_file_extent_item *extent)
114 {
115         u64 end;
116         u64 len;
117
118         if (btrfs_file_extent_type(leaf, extent) == BTRFS_FILE_EXTENT_INLINE) {
119                 len = btrfs_file_extent_ram_bytes(leaf, extent);
120                 end = ALIGN(key->offset + len, leaf->fs_info->sectorsize);
121         } else {
122                 len = btrfs_file_extent_num_bytes(leaf, extent);
123                 end = key->offset + len;
124         }
125         return end;
126 }
127
128 /*
129  * Customized report for dir_item, the only new important information is
130  * key->objectid, which represents inode number
131  */
132 __printf(3, 4)
133 __cold
134 static void dir_item_err(const struct extent_buffer *eb, int slot,
135                          const char *fmt, ...)
136 {
137         const struct btrfs_fs_info *fs_info = eb->fs_info;
138         struct btrfs_key key;
139         struct va_format vaf;
140         va_list args;
141
142         btrfs_item_key_to_cpu(eb, &key, slot);
143         va_start(args, fmt);
144
145         vaf.fmt = fmt;
146         vaf.va = &args;
147
148         btrfs_crit(fs_info,
149                 "corrupt %s: root=%llu block=%llu slot=%d ino=%llu, %pV",
150                 btrfs_header_level(eb) == 0 ? "leaf" : "node",
151                 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
152                 key.objectid, &vaf);
153         va_end(args);
154 }
155
156 /*
157  * This functions checks prev_key->objectid, to ensure current key and prev_key
158  * share the same objectid as inode number.
159  *
160  * This is to detect missing INODE_ITEM in subvolume trees.
161  *
162  * Return true if everything is OK or we don't need to check.
163  * Return false if anything is wrong.
164  */
165 static bool check_prev_ino(struct extent_buffer *leaf,
166                            struct btrfs_key *key, int slot,
167                            struct btrfs_key *prev_key)
168 {
169         /* No prev key, skip check */
170         if (slot == 0)
171                 return true;
172
173         /* Only these key->types needs to be checked */
174         ASSERT(key->type == BTRFS_XATTR_ITEM_KEY ||
175                key->type == BTRFS_INODE_REF_KEY ||
176                key->type == BTRFS_DIR_INDEX_KEY ||
177                key->type == BTRFS_DIR_ITEM_KEY ||
178                key->type == BTRFS_EXTENT_DATA_KEY);
179
180         /*
181          * Only subvolume trees along with their reloc trees need this check.
182          * Things like log tree doesn't follow this ino requirement.
183          */
184         if (!is_fstree(btrfs_header_owner(leaf)))
185                 return true;
186
187         if (key->objectid == prev_key->objectid)
188                 return true;
189
190         /* Error found */
191         dir_item_err(leaf, slot,
192                 "invalid previous key objectid, have %llu expect %llu",
193                 prev_key->objectid, key->objectid);
194         return false;
195 }
196 static int check_extent_data_item(struct extent_buffer *leaf,
197                                   struct btrfs_key *key, int slot,
198                                   struct btrfs_key *prev_key)
199 {
200         struct btrfs_fs_info *fs_info = leaf->fs_info;
201         struct btrfs_file_extent_item *fi;
202         u32 sectorsize = fs_info->sectorsize;
203         u32 item_size = btrfs_item_size_nr(leaf, slot);
204         u64 extent_end;
205
206         if (!IS_ALIGNED(key->offset, sectorsize)) {
207                 file_extent_err(leaf, slot,
208 "unaligned file_offset for file extent, have %llu should be aligned to %u",
209                         key->offset, sectorsize);
210                 return -EUCLEAN;
211         }
212
213         /*
214          * Previous key must have the same key->objectid (ino).
215          * It can be XATTR_ITEM, INODE_ITEM or just another EXTENT_DATA.
216          * But if objectids mismatch, it means we have a missing
217          * INODE_ITEM.
218          */
219         if (!check_prev_ino(leaf, key, slot, prev_key))
220                 return -EUCLEAN;
221
222         fi = btrfs_item_ptr(leaf, slot, struct btrfs_file_extent_item);
223
224         /*
225          * Make sure the item contains at least inline header, so the file
226          * extent type is not some garbage.
227          */
228         if (item_size < BTRFS_FILE_EXTENT_INLINE_DATA_START) {
229                 file_extent_err(leaf, slot,
230                                 "invalid item size, have %u expect [%zu, %u)",
231                                 item_size, BTRFS_FILE_EXTENT_INLINE_DATA_START,
232                                 SZ_4K);
233                 return -EUCLEAN;
234         }
235         if (btrfs_file_extent_type(leaf, fi) >= BTRFS_NR_FILE_EXTENT_TYPES) {
236                 file_extent_err(leaf, slot,
237                 "invalid type for file extent, have %u expect range [0, %u]",
238                         btrfs_file_extent_type(leaf, fi),
239                         BTRFS_NR_FILE_EXTENT_TYPES - 1);
240                 return -EUCLEAN;
241         }
242
243         /*
244          * Support for new compression/encryption must introduce incompat flag,
245          * and must be caught in open_ctree().
246          */
247         if (btrfs_file_extent_compression(leaf, fi) >= BTRFS_NR_COMPRESS_TYPES) {
248                 file_extent_err(leaf, slot,
249         "invalid compression for file extent, have %u expect range [0, %u]",
250                         btrfs_file_extent_compression(leaf, fi),
251                         BTRFS_NR_COMPRESS_TYPES - 1);
252                 return -EUCLEAN;
253         }
254         if (btrfs_file_extent_encryption(leaf, fi)) {
255                 file_extent_err(leaf, slot,
256                         "invalid encryption for file extent, have %u expect 0",
257                         btrfs_file_extent_encryption(leaf, fi));
258                 return -EUCLEAN;
259         }
260         if (btrfs_file_extent_type(leaf, fi) == BTRFS_FILE_EXTENT_INLINE) {
261                 /* Inline extent must have 0 as key offset */
262                 if (key->offset) {
263                         file_extent_err(leaf, slot,
264                 "invalid file_offset for inline file extent, have %llu expect 0",
265                                 key->offset);
266                         return -EUCLEAN;
267                 }
268
269                 /* Compressed inline extent has no on-disk size, skip it */
270                 if (btrfs_file_extent_compression(leaf, fi) !=
271                     BTRFS_COMPRESS_NONE)
272                         return 0;
273
274                 /* Uncompressed inline extent size must match item size */
275                 if (item_size != BTRFS_FILE_EXTENT_INLINE_DATA_START +
276                     btrfs_file_extent_ram_bytes(leaf, fi)) {
277                         file_extent_err(leaf, slot,
278         "invalid ram_bytes for uncompressed inline extent, have %u expect %llu",
279                                 item_size, BTRFS_FILE_EXTENT_INLINE_DATA_START +
280                                 btrfs_file_extent_ram_bytes(leaf, fi));
281                         return -EUCLEAN;
282                 }
283                 return 0;
284         }
285
286         /* Regular or preallocated extent has fixed item size */
287         if (item_size != sizeof(*fi)) {
288                 file_extent_err(leaf, slot,
289         "invalid item size for reg/prealloc file extent, have %u expect %zu",
290                         item_size, sizeof(*fi));
291                 return -EUCLEAN;
292         }
293         if (CHECK_FE_ALIGNED(leaf, slot, fi, ram_bytes, sectorsize) ||
294             CHECK_FE_ALIGNED(leaf, slot, fi, disk_bytenr, sectorsize) ||
295             CHECK_FE_ALIGNED(leaf, slot, fi, disk_num_bytes, sectorsize) ||
296             CHECK_FE_ALIGNED(leaf, slot, fi, offset, sectorsize) ||
297             CHECK_FE_ALIGNED(leaf, slot, fi, num_bytes, sectorsize))
298                 return -EUCLEAN;
299
300         /* Catch extent end overflow */
301         if (check_add_overflow(btrfs_file_extent_num_bytes(leaf, fi),
302                                key->offset, &extent_end)) {
303                 file_extent_err(leaf, slot,
304         "extent end overflow, have file offset %llu extent num bytes %llu",
305                                 key->offset,
306                                 btrfs_file_extent_num_bytes(leaf, fi));
307                 return -EUCLEAN;
308         }
309
310         /*
311          * Check that no two consecutive file extent items, in the same leaf,
312          * present ranges that overlap each other.
313          */
314         if (slot > 0 &&
315             prev_key->objectid == key->objectid &&
316             prev_key->type == BTRFS_EXTENT_DATA_KEY) {
317                 struct btrfs_file_extent_item *prev_fi;
318                 u64 prev_end;
319
320                 prev_fi = btrfs_item_ptr(leaf, slot - 1,
321                                          struct btrfs_file_extent_item);
322                 prev_end = file_extent_end(leaf, prev_key, prev_fi);
323                 if (prev_end > key->offset) {
324                         file_extent_err(leaf, slot - 1,
325 "file extent end range (%llu) goes beyond start offset (%llu) of the next file extent",
326                                         prev_end, key->offset);
327                         return -EUCLEAN;
328                 }
329         }
330
331         return 0;
332 }
333
334 static int check_csum_item(struct extent_buffer *leaf, struct btrfs_key *key,
335                            int slot, struct btrfs_key *prev_key)
336 {
337         struct btrfs_fs_info *fs_info = leaf->fs_info;
338         u32 sectorsize = fs_info->sectorsize;
339         u32 csumsize = btrfs_super_csum_size(fs_info->super_copy);
340
341         if (key->objectid != BTRFS_EXTENT_CSUM_OBJECTID) {
342                 generic_err(leaf, slot,
343                 "invalid key objectid for csum item, have %llu expect %llu",
344                         key->objectid, BTRFS_EXTENT_CSUM_OBJECTID);
345                 return -EUCLEAN;
346         }
347         if (!IS_ALIGNED(key->offset, sectorsize)) {
348                 generic_err(leaf, slot,
349         "unaligned key offset for csum item, have %llu should be aligned to %u",
350                         key->offset, sectorsize);
351                 return -EUCLEAN;
352         }
353         if (!IS_ALIGNED(btrfs_item_size_nr(leaf, slot), csumsize)) {
354                 generic_err(leaf, slot,
355         "unaligned item size for csum item, have %u should be aligned to %u",
356                         btrfs_item_size_nr(leaf, slot), csumsize);
357                 return -EUCLEAN;
358         }
359         if (slot > 0 && prev_key->type == BTRFS_EXTENT_CSUM_KEY) {
360                 u64 prev_csum_end;
361                 u32 prev_item_size;
362
363                 prev_item_size = btrfs_item_size_nr(leaf, slot - 1);
364                 prev_csum_end = (prev_item_size / csumsize) * sectorsize;
365                 prev_csum_end += prev_key->offset;
366                 if (prev_csum_end > key->offset) {
367                         generic_err(leaf, slot - 1,
368 "csum end range (%llu) goes beyond the start range (%llu) of the next csum item",
369                                     prev_csum_end, key->offset);
370                         return -EUCLEAN;
371                 }
372         }
373         return 0;
374 }
375
376 /* Inode item error output has the same format as dir_item_err() */
377 #define inode_item_err(eb, slot, fmt, ...)                      \
378         dir_item_err(eb, slot, fmt, __VA_ARGS__)
379
380 static int check_inode_key(struct extent_buffer *leaf, struct btrfs_key *key,
381                            int slot)
382 {
383         struct btrfs_key item_key;
384         bool is_inode_item;
385
386         btrfs_item_key_to_cpu(leaf, &item_key, slot);
387         is_inode_item = (item_key.type == BTRFS_INODE_ITEM_KEY);
388
389         /* For XATTR_ITEM, location key should be all 0 */
390         if (item_key.type == BTRFS_XATTR_ITEM_KEY) {
391                 if (key->type != 0 || key->objectid != 0 || key->offset != 0)
392                         return -EUCLEAN;
393                 return 0;
394         }
395
396         if ((key->objectid < BTRFS_FIRST_FREE_OBJECTID ||
397              key->objectid > BTRFS_LAST_FREE_OBJECTID) &&
398             key->objectid != BTRFS_ROOT_TREE_DIR_OBJECTID &&
399             key->objectid != BTRFS_FREE_INO_OBJECTID) {
400                 if (is_inode_item) {
401                         generic_err(leaf, slot,
402         "invalid key objectid: has %llu expect %llu or [%llu, %llu] or %llu",
403                                 key->objectid, BTRFS_ROOT_TREE_DIR_OBJECTID,
404                                 BTRFS_FIRST_FREE_OBJECTID,
405                                 BTRFS_LAST_FREE_OBJECTID,
406                                 BTRFS_FREE_INO_OBJECTID);
407                 } else {
408                         dir_item_err(leaf, slot,
409 "invalid location key objectid: has %llu expect %llu or [%llu, %llu] or %llu",
410                                 key->objectid, BTRFS_ROOT_TREE_DIR_OBJECTID,
411                                 BTRFS_FIRST_FREE_OBJECTID,
412                                 BTRFS_LAST_FREE_OBJECTID,
413                                 BTRFS_FREE_INO_OBJECTID);
414                 }
415                 return -EUCLEAN;
416         }
417         if (key->offset != 0) {
418                 if (is_inode_item)
419                         inode_item_err(leaf, slot,
420                                        "invalid key offset: has %llu expect 0",
421                                        key->offset);
422                 else
423                         dir_item_err(leaf, slot,
424                                 "invalid location key offset:has %llu expect 0",
425                                 key->offset);
426                 return -EUCLEAN;
427         }
428         return 0;
429 }
430
431 static int check_dir_item(struct extent_buffer *leaf,
432                           struct btrfs_key *key, struct btrfs_key *prev_key,
433                           int slot)
434 {
435         struct btrfs_fs_info *fs_info = leaf->fs_info;
436         struct btrfs_dir_item *di;
437         u32 item_size = btrfs_item_size_nr(leaf, slot);
438         u32 cur = 0;
439
440         if (!check_prev_ino(leaf, key, slot, prev_key))
441                 return -EUCLEAN;
442         di = btrfs_item_ptr(leaf, slot, struct btrfs_dir_item);
443         while (cur < item_size) {
444                 u32 name_len;
445                 u32 data_len;
446                 u32 max_name_len;
447                 u32 total_size;
448                 u32 name_hash;
449                 u8 dir_type;
450
451                 /* header itself should not cross item boundary */
452                 if (cur + sizeof(*di) > item_size) {
453                         dir_item_err(leaf, slot,
454                 "dir item header crosses item boundary, have %zu boundary %u",
455                                 cur + sizeof(*di), item_size);
456                         return -EUCLEAN;
457                 }
458
459                 /* dir type check */
460                 dir_type = btrfs_dir_type(leaf, di);
461                 if (dir_type >= BTRFS_FT_MAX) {
462                         dir_item_err(leaf, slot,
463                         "invalid dir item type, have %u expect [0, %u)",
464                                 dir_type, BTRFS_FT_MAX);
465                         return -EUCLEAN;
466                 }
467
468                 if (key->type == BTRFS_XATTR_ITEM_KEY &&
469                     dir_type != BTRFS_FT_XATTR) {
470                         dir_item_err(leaf, slot,
471                 "invalid dir item type for XATTR key, have %u expect %u",
472                                 dir_type, BTRFS_FT_XATTR);
473                         return -EUCLEAN;
474                 }
475                 if (dir_type == BTRFS_FT_XATTR &&
476                     key->type != BTRFS_XATTR_ITEM_KEY) {
477                         dir_item_err(leaf, slot,
478                         "xattr dir type found for non-XATTR key");
479                         return -EUCLEAN;
480                 }
481                 if (dir_type == BTRFS_FT_XATTR)
482                         max_name_len = XATTR_NAME_MAX;
483                 else
484                         max_name_len = BTRFS_NAME_LEN;
485
486                 /* Name/data length check */
487                 name_len = btrfs_dir_name_len(leaf, di);
488                 data_len = btrfs_dir_data_len(leaf, di);
489                 if (name_len > max_name_len) {
490                         dir_item_err(leaf, slot,
491                         "dir item name len too long, have %u max %u",
492                                 name_len, max_name_len);
493                         return -EUCLEAN;
494                 }
495                 if (name_len + data_len > BTRFS_MAX_XATTR_SIZE(fs_info)) {
496                         dir_item_err(leaf, slot,
497                         "dir item name and data len too long, have %u max %u",
498                                 name_len + data_len,
499                                 BTRFS_MAX_XATTR_SIZE(fs_info));
500                         return -EUCLEAN;
501                 }
502
503                 if (data_len && dir_type != BTRFS_FT_XATTR) {
504                         dir_item_err(leaf, slot,
505                         "dir item with invalid data len, have %u expect 0",
506                                 data_len);
507                         return -EUCLEAN;
508                 }
509
510                 total_size = sizeof(*di) + name_len + data_len;
511
512                 /* header and name/data should not cross item boundary */
513                 if (cur + total_size > item_size) {
514                         dir_item_err(leaf, slot,
515                 "dir item data crosses item boundary, have %u boundary %u",
516                                 cur + total_size, item_size);
517                         return -EUCLEAN;
518                 }
519
520                 /*
521                  * Special check for XATTR/DIR_ITEM, as key->offset is name
522                  * hash, should match its name
523                  */
524                 if (key->type == BTRFS_DIR_ITEM_KEY ||
525                     key->type == BTRFS_XATTR_ITEM_KEY) {
526                         char namebuf[max(BTRFS_NAME_LEN, XATTR_NAME_MAX)];
527
528                         read_extent_buffer(leaf, namebuf,
529                                         (unsigned long)(di + 1), name_len);
530                         name_hash = btrfs_name_hash(namebuf, name_len);
531                         if (key->offset != name_hash) {
532                                 dir_item_err(leaf, slot,
533                 "name hash mismatch with key, have 0x%016x expect 0x%016llx",
534                                         name_hash, key->offset);
535                                 return -EUCLEAN;
536                         }
537                 }
538                 cur += total_size;
539                 di = (struct btrfs_dir_item *)((void *)di + total_size);
540         }
541         return 0;
542 }
543
544 __printf(3, 4)
545 __cold
546 static void block_group_err(const struct extent_buffer *eb, int slot,
547                             const char *fmt, ...)
548 {
549         const struct btrfs_fs_info *fs_info = eb->fs_info;
550         struct btrfs_key key;
551         struct va_format vaf;
552         va_list args;
553
554         btrfs_item_key_to_cpu(eb, &key, slot);
555         va_start(args, fmt);
556
557         vaf.fmt = fmt;
558         vaf.va = &args;
559
560         btrfs_crit(fs_info,
561         "corrupt %s: root=%llu block=%llu slot=%d bg_start=%llu bg_len=%llu, %pV",
562                 btrfs_header_level(eb) == 0 ? "leaf" : "node",
563                 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
564                 key.objectid, key.offset, &vaf);
565         va_end(args);
566 }
567
568 static int check_block_group_item(struct extent_buffer *leaf,
569                                   struct btrfs_key *key, int slot)
570 {
571         struct btrfs_block_group_item bgi;
572         u32 item_size = btrfs_item_size_nr(leaf, slot);
573         u64 flags;
574         u64 type;
575
576         /*
577          * Here we don't really care about alignment since extent allocator can
578          * handle it.  We care more about the size.
579          */
580         if (key->offset == 0) {
581                 block_group_err(leaf, slot,
582                                 "invalid block group size 0");
583                 return -EUCLEAN;
584         }
585
586         if (item_size != sizeof(bgi)) {
587                 block_group_err(leaf, slot,
588                         "invalid item size, have %u expect %zu",
589                                 item_size, sizeof(bgi));
590                 return -EUCLEAN;
591         }
592
593         read_extent_buffer(leaf, &bgi, btrfs_item_ptr_offset(leaf, slot),
594                            sizeof(bgi));
595         if (btrfs_stack_block_group_chunk_objectid(&bgi) !=
596             BTRFS_FIRST_CHUNK_TREE_OBJECTID) {
597                 block_group_err(leaf, slot,
598                 "invalid block group chunk objectid, have %llu expect %llu",
599                                 btrfs_stack_block_group_chunk_objectid(&bgi),
600                                 BTRFS_FIRST_CHUNK_TREE_OBJECTID);
601                 return -EUCLEAN;
602         }
603
604         if (btrfs_stack_block_group_used(&bgi) > key->offset) {
605                 block_group_err(leaf, slot,
606                         "invalid block group used, have %llu expect [0, %llu)",
607                                 btrfs_stack_block_group_used(&bgi), key->offset);
608                 return -EUCLEAN;
609         }
610
611         flags = btrfs_stack_block_group_flags(&bgi);
612         if (hweight64(flags & BTRFS_BLOCK_GROUP_PROFILE_MASK) > 1) {
613                 block_group_err(leaf, slot,
614 "invalid profile flags, have 0x%llx (%lu bits set) expect no more than 1 bit set",
615                         flags & BTRFS_BLOCK_GROUP_PROFILE_MASK,
616                         hweight64(flags & BTRFS_BLOCK_GROUP_PROFILE_MASK));
617                 return -EUCLEAN;
618         }
619
620         type = flags & BTRFS_BLOCK_GROUP_TYPE_MASK;
621         if (type != BTRFS_BLOCK_GROUP_DATA &&
622             type != BTRFS_BLOCK_GROUP_METADATA &&
623             type != BTRFS_BLOCK_GROUP_SYSTEM &&
624             type != (BTRFS_BLOCK_GROUP_METADATA |
625                            BTRFS_BLOCK_GROUP_DATA)) {
626                 block_group_err(leaf, slot,
627 "invalid type, have 0x%llx (%lu bits set) expect either 0x%llx, 0x%llx, 0x%llx or 0x%llx",
628                         type, hweight64(type),
629                         BTRFS_BLOCK_GROUP_DATA, BTRFS_BLOCK_GROUP_METADATA,
630                         BTRFS_BLOCK_GROUP_SYSTEM,
631                         BTRFS_BLOCK_GROUP_METADATA | BTRFS_BLOCK_GROUP_DATA);
632                 return -EUCLEAN;
633         }
634         return 0;
635 }
636
637 __printf(4, 5)
638 __cold
639 static void chunk_err(const struct extent_buffer *leaf,
640                       const struct btrfs_chunk *chunk, u64 logical,
641                       const char *fmt, ...)
642 {
643         const struct btrfs_fs_info *fs_info = leaf->fs_info;
644         bool is_sb;
645         struct va_format vaf;
646         va_list args;
647         int i;
648         int slot = -1;
649
650         /* Only superblock eb is able to have such small offset */
651         is_sb = (leaf->start == BTRFS_SUPER_INFO_OFFSET);
652
653         if (!is_sb) {
654                 /*
655                  * Get the slot number by iterating through all slots, this
656                  * would provide better readability.
657                  */
658                 for (i = 0; i < btrfs_header_nritems(leaf); i++) {
659                         if (btrfs_item_ptr_offset(leaf, i) ==
660                                         (unsigned long)chunk) {
661                                 slot = i;
662                                 break;
663                         }
664                 }
665         }
666         va_start(args, fmt);
667         vaf.fmt = fmt;
668         vaf.va = &args;
669
670         if (is_sb)
671                 btrfs_crit(fs_info,
672                 "corrupt superblock syschunk array: chunk_start=%llu, %pV",
673                            logical, &vaf);
674         else
675                 btrfs_crit(fs_info,
676         "corrupt leaf: root=%llu block=%llu slot=%d chunk_start=%llu, %pV",
677                            BTRFS_CHUNK_TREE_OBJECTID, leaf->start, slot,
678                            logical, &vaf);
679         va_end(args);
680 }
681
682 /*
683  * The common chunk check which could also work on super block sys chunk array.
684  *
685  * Return -EUCLEAN if anything is corrupted.
686  * Return 0 if everything is OK.
687  */
688 int btrfs_check_chunk_valid(struct extent_buffer *leaf,
689                             struct btrfs_chunk *chunk, u64 logical)
690 {
691         struct btrfs_fs_info *fs_info = leaf->fs_info;
692         u64 length;
693         u64 stripe_len;
694         u16 num_stripes;
695         u16 sub_stripes;
696         u64 type;
697         u64 features;
698         bool mixed = false;
699
700         length = btrfs_chunk_length(leaf, chunk);
701         stripe_len = btrfs_chunk_stripe_len(leaf, chunk);
702         num_stripes = btrfs_chunk_num_stripes(leaf, chunk);
703         sub_stripes = btrfs_chunk_sub_stripes(leaf, chunk);
704         type = btrfs_chunk_type(leaf, chunk);
705
706         if (!num_stripes) {
707                 chunk_err(leaf, chunk, logical,
708                           "invalid chunk num_stripes, have %u", num_stripes);
709                 return -EUCLEAN;
710         }
711         if (!IS_ALIGNED(logical, fs_info->sectorsize)) {
712                 chunk_err(leaf, chunk, logical,
713                 "invalid chunk logical, have %llu should aligned to %u",
714                           logical, fs_info->sectorsize);
715                 return -EUCLEAN;
716         }
717         if (btrfs_chunk_sector_size(leaf, chunk) != fs_info->sectorsize) {
718                 chunk_err(leaf, chunk, logical,
719                           "invalid chunk sectorsize, have %u expect %u",
720                           btrfs_chunk_sector_size(leaf, chunk),
721                           fs_info->sectorsize);
722                 return -EUCLEAN;
723         }
724         if (!length || !IS_ALIGNED(length, fs_info->sectorsize)) {
725                 chunk_err(leaf, chunk, logical,
726                           "invalid chunk length, have %llu", length);
727                 return -EUCLEAN;
728         }
729         if (!is_power_of_2(stripe_len) || stripe_len != BTRFS_STRIPE_LEN) {
730                 chunk_err(leaf, chunk, logical,
731                           "invalid chunk stripe length: %llu",
732                           stripe_len);
733                 return -EUCLEAN;
734         }
735         if (~(BTRFS_BLOCK_GROUP_TYPE_MASK | BTRFS_BLOCK_GROUP_PROFILE_MASK) &
736             type) {
737                 chunk_err(leaf, chunk, logical,
738                           "unrecognized chunk type: 0x%llx",
739                           ~(BTRFS_BLOCK_GROUP_TYPE_MASK |
740                             BTRFS_BLOCK_GROUP_PROFILE_MASK) &
741                           btrfs_chunk_type(leaf, chunk));
742                 return -EUCLEAN;
743         }
744
745         if (!has_single_bit_set(type & BTRFS_BLOCK_GROUP_PROFILE_MASK) &&
746             (type & BTRFS_BLOCK_GROUP_PROFILE_MASK) != 0) {
747                 chunk_err(leaf, chunk, logical,
748                 "invalid chunk profile flag: 0x%llx, expect 0 or 1 bit set",
749                           type & BTRFS_BLOCK_GROUP_PROFILE_MASK);
750                 return -EUCLEAN;
751         }
752         if ((type & BTRFS_BLOCK_GROUP_TYPE_MASK) == 0) {
753                 chunk_err(leaf, chunk, logical,
754         "missing chunk type flag, have 0x%llx one bit must be set in 0x%llx",
755                           type, BTRFS_BLOCK_GROUP_TYPE_MASK);
756                 return -EUCLEAN;
757         }
758
759         if ((type & BTRFS_BLOCK_GROUP_SYSTEM) &&
760             (type & (BTRFS_BLOCK_GROUP_METADATA | BTRFS_BLOCK_GROUP_DATA))) {
761                 chunk_err(leaf, chunk, logical,
762                           "system chunk with data or metadata type: 0x%llx",
763                           type);
764                 return -EUCLEAN;
765         }
766
767         features = btrfs_super_incompat_flags(fs_info->super_copy);
768         if (features & BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS)
769                 mixed = true;
770
771         if (!mixed) {
772                 if ((type & BTRFS_BLOCK_GROUP_METADATA) &&
773                     (type & BTRFS_BLOCK_GROUP_DATA)) {
774                         chunk_err(leaf, chunk, logical,
775                         "mixed chunk type in non-mixed mode: 0x%llx", type);
776                         return -EUCLEAN;
777                 }
778         }
779
780         if ((type & BTRFS_BLOCK_GROUP_RAID10 && sub_stripes != 2) ||
781             (type & BTRFS_BLOCK_GROUP_RAID1 && num_stripes != 2) ||
782             (type & BTRFS_BLOCK_GROUP_RAID5 && num_stripes < 2) ||
783             (type & BTRFS_BLOCK_GROUP_RAID6 && num_stripes < 3) ||
784             (type & BTRFS_BLOCK_GROUP_DUP && num_stripes != 2) ||
785             ((type & BTRFS_BLOCK_GROUP_PROFILE_MASK) == 0 && num_stripes != 1)) {
786                 chunk_err(leaf, chunk, logical,
787                         "invalid num_stripes:sub_stripes %u:%u for profile %llu",
788                         num_stripes, sub_stripes,
789                         type & BTRFS_BLOCK_GROUP_PROFILE_MASK);
790                 return -EUCLEAN;
791         }
792
793         return 0;
794 }
795
796 /*
797  * Enhanced version of chunk item checker.
798  *
799  * The common btrfs_check_chunk_valid() doesn't check item size since it needs
800  * to work on super block sys_chunk_array which doesn't have full item ptr.
801  */
802 static int check_leaf_chunk_item(struct extent_buffer *leaf,
803                                  struct btrfs_chunk *chunk,
804                                  struct btrfs_key *key, int slot)
805 {
806         int num_stripes;
807
808         if (btrfs_item_size_nr(leaf, slot) < sizeof(struct btrfs_chunk)) {
809                 chunk_err(leaf, chunk, key->offset,
810                         "invalid chunk item size: have %u expect [%zu, %u)",
811                         btrfs_item_size_nr(leaf, slot),
812                         sizeof(struct btrfs_chunk),
813                         BTRFS_LEAF_DATA_SIZE(leaf->fs_info));
814                 return -EUCLEAN;
815         }
816
817         num_stripes = btrfs_chunk_num_stripes(leaf, chunk);
818         /* Let btrfs_check_chunk_valid() handle this error type */
819         if (num_stripes == 0)
820                 goto out;
821
822         if (btrfs_chunk_item_size(num_stripes) !=
823             btrfs_item_size_nr(leaf, slot)) {
824                 chunk_err(leaf, chunk, key->offset,
825                         "invalid chunk item size: have %u expect %lu",
826                         btrfs_item_size_nr(leaf, slot),
827                         btrfs_chunk_item_size(num_stripes));
828                 return -EUCLEAN;
829         }
830 out:
831         return btrfs_check_chunk_valid(leaf, chunk, key->offset);
832 }
833
834 __printf(3, 4)
835 __cold
836 static void dev_item_err(const struct extent_buffer *eb, int slot,
837                          const char *fmt, ...)
838 {
839         struct btrfs_key key;
840         struct va_format vaf;
841         va_list args;
842
843         btrfs_item_key_to_cpu(eb, &key, slot);
844         va_start(args, fmt);
845
846         vaf.fmt = fmt;
847         vaf.va = &args;
848
849         btrfs_crit(eb->fs_info,
850         "corrupt %s: root=%llu block=%llu slot=%d devid=%llu %pV",
851                 btrfs_header_level(eb) == 0 ? "leaf" : "node",
852                 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
853                 key.objectid, &vaf);
854         va_end(args);
855 }
856
857 static int check_dev_item(struct extent_buffer *leaf,
858                           struct btrfs_key *key, int slot)
859 {
860         struct btrfs_dev_item *ditem;
861
862         if (key->objectid != BTRFS_DEV_ITEMS_OBJECTID) {
863                 dev_item_err(leaf, slot,
864                              "invalid objectid: has=%llu expect=%llu",
865                              key->objectid, BTRFS_DEV_ITEMS_OBJECTID);
866                 return -EUCLEAN;
867         }
868         ditem = btrfs_item_ptr(leaf, slot, struct btrfs_dev_item);
869         if (btrfs_device_id(leaf, ditem) != key->offset) {
870                 dev_item_err(leaf, slot,
871                              "devid mismatch: key has=%llu item has=%llu",
872                              key->offset, btrfs_device_id(leaf, ditem));
873                 return -EUCLEAN;
874         }
875
876         /*
877          * For device total_bytes, we don't have reliable way to check it, as
878          * it can be 0 for device removal. Device size check can only be done
879          * by dev extents check.
880          */
881         if (btrfs_device_bytes_used(leaf, ditem) >
882             btrfs_device_total_bytes(leaf, ditem)) {
883                 dev_item_err(leaf, slot,
884                              "invalid bytes used: have %llu expect [0, %llu]",
885                              btrfs_device_bytes_used(leaf, ditem),
886                              btrfs_device_total_bytes(leaf, ditem));
887                 return -EUCLEAN;
888         }
889         /*
890          * Remaining members like io_align/type/gen/dev_group aren't really
891          * utilized.  Skip them to make later usage of them easier.
892          */
893         return 0;
894 }
895
896 /* Inode item error output has the same format as dir_item_err() */
897 #define inode_item_err(eb, slot, fmt, ...)                      \
898         dir_item_err(eb, slot, fmt, __VA_ARGS__)
899
900 static int check_inode_item(struct extent_buffer *leaf,
901                             struct btrfs_key *key, int slot)
902 {
903         struct btrfs_fs_info *fs_info = leaf->fs_info;
904         struct btrfs_inode_item *iitem;
905         u64 super_gen = btrfs_super_generation(fs_info->super_copy);
906         u32 valid_mask = (S_IFMT | S_ISUID | S_ISGID | S_ISVTX | 0777);
907         u32 mode;
908         int ret;
909
910         ret = check_inode_key(leaf, key, slot);
911         if (ret < 0)
912                 return ret;
913
914         iitem = btrfs_item_ptr(leaf, slot, struct btrfs_inode_item);
915
916         /* Here we use super block generation + 1 to handle log tree */
917         if (btrfs_inode_generation(leaf, iitem) > super_gen + 1) {
918                 inode_item_err(leaf, slot,
919                         "invalid inode generation: has %llu expect (0, %llu]",
920                                btrfs_inode_generation(leaf, iitem),
921                                super_gen + 1);
922                 return -EUCLEAN;
923         }
924         /* Note for ROOT_TREE_DIR_ITEM, mkfs could set its transid 0 */
925         if (btrfs_inode_transid(leaf, iitem) > super_gen + 1) {
926                 inode_item_err(leaf, slot,
927                         "invalid inode generation: has %llu expect [0, %llu]",
928                                btrfs_inode_transid(leaf, iitem), super_gen + 1);
929                 return -EUCLEAN;
930         }
931
932         /*
933          * For size and nbytes it's better not to be too strict, as for dir
934          * item its size/nbytes can easily get wrong, but doesn't affect
935          * anything in the fs. So here we skip the check.
936          */
937         mode = btrfs_inode_mode(leaf, iitem);
938         if (mode & ~valid_mask) {
939                 inode_item_err(leaf, slot,
940                                "unknown mode bit detected: 0x%x",
941                                mode & ~valid_mask);
942                 return -EUCLEAN;
943         }
944
945         /*
946          * S_IFMT is not bit mapped so we can't completely rely on
947          * is_power_of_2/has_single_bit_set, but it can save us from checking
948          * FIFO/CHR/DIR/REG.  Only needs to check BLK, LNK and SOCKS
949          */
950         if (!has_single_bit_set(mode & S_IFMT)) {
951                 if (!S_ISLNK(mode) && !S_ISBLK(mode) && !S_ISSOCK(mode)) {
952                         inode_item_err(leaf, slot,
953                         "invalid mode: has 0%o expect valid S_IF* bit(s)",
954                                        mode & S_IFMT);
955                         return -EUCLEAN;
956                 }
957         }
958         if (S_ISDIR(mode) && btrfs_inode_nlink(leaf, iitem) > 1) {
959                 inode_item_err(leaf, slot,
960                        "invalid nlink: has %u expect no more than 1 for dir",
961                         btrfs_inode_nlink(leaf, iitem));
962                 return -EUCLEAN;
963         }
964         if (btrfs_inode_flags(leaf, iitem) & ~BTRFS_INODE_FLAG_MASK) {
965                 inode_item_err(leaf, slot,
966                                "unknown flags detected: 0x%llx",
967                                btrfs_inode_flags(leaf, iitem) &
968                                ~BTRFS_INODE_FLAG_MASK);
969                 return -EUCLEAN;
970         }
971         return 0;
972 }
973
974 static int check_root_item(struct extent_buffer *leaf, struct btrfs_key *key,
975                            int slot)
976 {
977         struct btrfs_fs_info *fs_info = leaf->fs_info;
978         struct btrfs_root_item ri;
979         const u64 valid_root_flags = BTRFS_ROOT_SUBVOL_RDONLY |
980                                      BTRFS_ROOT_SUBVOL_DEAD;
981
982         /* No such tree id */
983         if (key->objectid == 0) {
984                 generic_err(leaf, slot, "invalid root id 0");
985                 return -EUCLEAN;
986         }
987
988         /*
989          * Some older kernel may create ROOT_ITEM with non-zero offset, so here
990          * we only check offset for reloc tree whose key->offset must be a
991          * valid tree.
992          */
993         if (key->objectid == BTRFS_TREE_RELOC_OBJECTID && key->offset == 0) {
994                 generic_err(leaf, slot, "invalid root id 0 for reloc tree");
995                 return -EUCLEAN;
996         }
997
998         if (btrfs_item_size_nr(leaf, slot) != sizeof(ri)) {
999                 generic_err(leaf, slot,
1000                             "invalid root item size, have %u expect %zu",
1001                             btrfs_item_size_nr(leaf, slot), sizeof(ri));
1002         }
1003
1004         read_extent_buffer(leaf, &ri, btrfs_item_ptr_offset(leaf, slot),
1005                            sizeof(ri));
1006
1007         /* Generation related */
1008         if (btrfs_root_generation(&ri) >
1009             btrfs_super_generation(fs_info->super_copy) + 1) {
1010                 generic_err(leaf, slot,
1011                         "invalid root generation, have %llu expect (0, %llu]",
1012                             btrfs_root_generation(&ri),
1013                             btrfs_super_generation(fs_info->super_copy) + 1);
1014                 return -EUCLEAN;
1015         }
1016         if (btrfs_root_generation_v2(&ri) >
1017             btrfs_super_generation(fs_info->super_copy) + 1) {
1018                 generic_err(leaf, slot,
1019                 "invalid root v2 generation, have %llu expect (0, %llu]",
1020                             btrfs_root_generation_v2(&ri),
1021                             btrfs_super_generation(fs_info->super_copy) + 1);
1022                 return -EUCLEAN;
1023         }
1024         if (btrfs_root_last_snapshot(&ri) >
1025             btrfs_super_generation(fs_info->super_copy) + 1) {
1026                 generic_err(leaf, slot,
1027                 "invalid root last_snapshot, have %llu expect (0, %llu]",
1028                             btrfs_root_last_snapshot(&ri),
1029                             btrfs_super_generation(fs_info->super_copy) + 1);
1030                 return -EUCLEAN;
1031         }
1032
1033         /* Alignment and level check */
1034         if (!IS_ALIGNED(btrfs_root_bytenr(&ri), fs_info->sectorsize)) {
1035                 generic_err(leaf, slot,
1036                 "invalid root bytenr, have %llu expect to be aligned to %u",
1037                             btrfs_root_bytenr(&ri), fs_info->sectorsize);
1038                 return -EUCLEAN;
1039         }
1040         if (btrfs_root_level(&ri) >= BTRFS_MAX_LEVEL) {
1041                 generic_err(leaf, slot,
1042                             "invalid root level, have %u expect [0, %u]",
1043                             btrfs_root_level(&ri), BTRFS_MAX_LEVEL - 1);
1044                 return -EUCLEAN;
1045         }
1046         if (ri.drop_level >= BTRFS_MAX_LEVEL) {
1047                 generic_err(leaf, slot,
1048                             "invalid root level, have %u expect [0, %u]",
1049                             ri.drop_level, BTRFS_MAX_LEVEL - 1);
1050                 return -EUCLEAN;
1051         }
1052
1053         /* Flags check */
1054         if (btrfs_root_flags(&ri) & ~valid_root_flags) {
1055                 generic_err(leaf, slot,
1056                             "invalid root flags, have 0x%llx expect mask 0x%llx",
1057                             btrfs_root_flags(&ri), valid_root_flags);
1058                 return -EUCLEAN;
1059         }
1060         return 0;
1061 }
1062
1063 __printf(3,4)
1064 __cold
1065 static void extent_err(const struct extent_buffer *eb, int slot,
1066                        const char *fmt, ...)
1067 {
1068         struct btrfs_key key;
1069         struct va_format vaf;
1070         va_list args;
1071         u64 bytenr;
1072         u64 len;
1073
1074         btrfs_item_key_to_cpu(eb, &key, slot);
1075         bytenr = key.objectid;
1076         if (key.type == BTRFS_METADATA_ITEM_KEY ||
1077             key.type == BTRFS_TREE_BLOCK_REF_KEY ||
1078             key.type == BTRFS_SHARED_BLOCK_REF_KEY)
1079                 len = eb->fs_info->nodesize;
1080         else
1081                 len = key.offset;
1082         va_start(args, fmt);
1083
1084         vaf.fmt = fmt;
1085         vaf.va = &args;
1086
1087         btrfs_crit(eb->fs_info,
1088         "corrupt %s: block=%llu slot=%d extent bytenr=%llu len=%llu %pV",
1089                 btrfs_header_level(eb) == 0 ? "leaf" : "node",
1090                 eb->start, slot, bytenr, len, &vaf);
1091         va_end(args);
1092 }
1093
1094 static int check_extent_item(struct extent_buffer *leaf,
1095                              struct btrfs_key *key, int slot)
1096 {
1097         struct btrfs_fs_info *fs_info = leaf->fs_info;
1098         struct btrfs_extent_item *ei;
1099         bool is_tree_block = false;
1100         unsigned long ptr;      /* Current pointer inside inline refs */
1101         unsigned long end;      /* Extent item end */
1102         const u32 item_size = btrfs_item_size_nr(leaf, slot);
1103         u64 flags;
1104         u64 generation;
1105         u64 total_refs;         /* Total refs in btrfs_extent_item */
1106         u64 inline_refs = 0;    /* found total inline refs */
1107
1108         if (key->type == BTRFS_METADATA_ITEM_KEY &&
1109             !btrfs_fs_incompat(fs_info, SKINNY_METADATA)) {
1110                 generic_err(leaf, slot,
1111 "invalid key type, METADATA_ITEM type invalid when SKINNY_METADATA feature disabled");
1112                 return -EUCLEAN;
1113         }
1114         /* key->objectid is the bytenr for both key types */
1115         if (!IS_ALIGNED(key->objectid, fs_info->sectorsize)) {
1116                 generic_err(leaf, slot,
1117                 "invalid key objectid, have %llu expect to be aligned to %u",
1118                            key->objectid, fs_info->sectorsize);
1119                 return -EUCLEAN;
1120         }
1121
1122         /* key->offset is tree level for METADATA_ITEM_KEY */
1123         if (key->type == BTRFS_METADATA_ITEM_KEY &&
1124             key->offset >= BTRFS_MAX_LEVEL) {
1125                 extent_err(leaf, slot,
1126                            "invalid tree level, have %llu expect [0, %u]",
1127                            key->offset, BTRFS_MAX_LEVEL - 1);
1128                 return -EUCLEAN;
1129         }
1130
1131         /*
1132          * EXTENT/METADATA_ITEM consists of:
1133          * 1) One btrfs_extent_item
1134          *    Records the total refs, type and generation of the extent.
1135          *
1136          * 2) One btrfs_tree_block_info (for EXTENT_ITEM and tree backref only)
1137          *    Records the first key and level of the tree block.
1138          *
1139          * 2) Zero or more btrfs_extent_inline_ref(s)
1140          *    Each inline ref has one btrfs_extent_inline_ref shows:
1141          *    2.1) The ref type, one of the 4
1142          *         TREE_BLOCK_REF       Tree block only
1143          *         SHARED_BLOCK_REF     Tree block only
1144          *         EXTENT_DATA_REF      Data only
1145          *         SHARED_DATA_REF      Data only
1146          *    2.2) Ref type specific data
1147          *         Either using btrfs_extent_inline_ref::offset, or specific
1148          *         data structure.
1149          */
1150         if (item_size < sizeof(*ei)) {
1151                 extent_err(leaf, slot,
1152                            "invalid item size, have %u expect [%zu, %u)",
1153                            item_size, sizeof(*ei),
1154                            BTRFS_LEAF_DATA_SIZE(fs_info));
1155                 return -EUCLEAN;
1156         }
1157         end = item_size + btrfs_item_ptr_offset(leaf, slot);
1158
1159         /* Checks against extent_item */
1160         ei = btrfs_item_ptr(leaf, slot, struct btrfs_extent_item);
1161         flags = btrfs_extent_flags(leaf, ei);
1162         total_refs = btrfs_extent_refs(leaf, ei);
1163         generation = btrfs_extent_generation(leaf, ei);
1164         if (generation > btrfs_super_generation(fs_info->super_copy) + 1) {
1165                 extent_err(leaf, slot,
1166                            "invalid generation, have %llu expect (0, %llu]",
1167                            generation,
1168                            btrfs_super_generation(fs_info->super_copy) + 1);
1169                 return -EUCLEAN;
1170         }
1171         if (!has_single_bit_set(flags & (BTRFS_EXTENT_FLAG_DATA |
1172                                          BTRFS_EXTENT_FLAG_TREE_BLOCK))) {
1173                 extent_err(leaf, slot,
1174                 "invalid extent flag, have 0x%llx expect 1 bit set in 0x%llx",
1175                         flags, BTRFS_EXTENT_FLAG_DATA |
1176                         BTRFS_EXTENT_FLAG_TREE_BLOCK);
1177                 return -EUCLEAN;
1178         }
1179         is_tree_block = !!(flags & BTRFS_EXTENT_FLAG_TREE_BLOCK);
1180         if (is_tree_block) {
1181                 if (key->type == BTRFS_EXTENT_ITEM_KEY &&
1182                     key->offset != fs_info->nodesize) {
1183                         extent_err(leaf, slot,
1184                                    "invalid extent length, have %llu expect %u",
1185                                    key->offset, fs_info->nodesize);
1186                         return -EUCLEAN;
1187                 }
1188         } else {
1189                 if (key->type != BTRFS_EXTENT_ITEM_KEY) {
1190                         extent_err(leaf, slot,
1191                         "invalid key type, have %u expect %u for data backref",
1192                                    key->type, BTRFS_EXTENT_ITEM_KEY);
1193                         return -EUCLEAN;
1194                 }
1195                 if (!IS_ALIGNED(key->offset, fs_info->sectorsize)) {
1196                         extent_err(leaf, slot,
1197                         "invalid extent length, have %llu expect aligned to %u",
1198                                    key->offset, fs_info->sectorsize);
1199                         return -EUCLEAN;
1200                 }
1201         }
1202         ptr = (unsigned long)(struct btrfs_extent_item *)(ei + 1);
1203
1204         /* Check the special case of btrfs_tree_block_info */
1205         if (is_tree_block && key->type != BTRFS_METADATA_ITEM_KEY) {
1206                 struct btrfs_tree_block_info *info;
1207
1208                 info = (struct btrfs_tree_block_info *)ptr;
1209                 if (btrfs_tree_block_level(leaf, info) >= BTRFS_MAX_LEVEL) {
1210                         extent_err(leaf, slot,
1211                         "invalid tree block info level, have %u expect [0, %u]",
1212                                    btrfs_tree_block_level(leaf, info),
1213                                    BTRFS_MAX_LEVEL - 1);
1214                         return -EUCLEAN;
1215                 }
1216                 ptr = (unsigned long)(struct btrfs_tree_block_info *)(info + 1);
1217         }
1218
1219         /* Check inline refs */
1220         while (ptr < end) {
1221                 struct btrfs_extent_inline_ref *iref;
1222                 struct btrfs_extent_data_ref *dref;
1223                 struct btrfs_shared_data_ref *sref;
1224                 u64 dref_offset;
1225                 u64 inline_offset;
1226                 u8 inline_type;
1227
1228                 if (ptr + sizeof(*iref) > end) {
1229                         extent_err(leaf, slot,
1230 "inline ref item overflows extent item, ptr %lu iref size %zu end %lu",
1231                                    ptr, sizeof(*iref), end);
1232                         return -EUCLEAN;
1233                 }
1234                 iref = (struct btrfs_extent_inline_ref *)ptr;
1235                 inline_type = btrfs_extent_inline_ref_type(leaf, iref);
1236                 inline_offset = btrfs_extent_inline_ref_offset(leaf, iref);
1237                 if (ptr + btrfs_extent_inline_ref_size(inline_type) > end) {
1238                         extent_err(leaf, slot,
1239 "inline ref item overflows extent item, ptr %lu iref size %u end %lu",
1240                                    ptr, inline_type, end);
1241                         return -EUCLEAN;
1242                 }
1243
1244                 switch (inline_type) {
1245                 /* inline_offset is subvolid of the owner, no need to check */
1246                 case BTRFS_TREE_BLOCK_REF_KEY:
1247                         inline_refs++;
1248                         break;
1249                 /* Contains parent bytenr */
1250                 case BTRFS_SHARED_BLOCK_REF_KEY:
1251                         if (!IS_ALIGNED(inline_offset, fs_info->sectorsize)) {
1252                                 extent_err(leaf, slot,
1253                 "invalid tree parent bytenr, have %llu expect aligned to %u",
1254                                            inline_offset, fs_info->sectorsize);
1255                                 return -EUCLEAN;
1256                         }
1257                         inline_refs++;
1258                         break;
1259                 /*
1260                  * Contains owner subvolid, owner key objectid, adjusted offset.
1261                  * The only obvious corruption can happen in that offset.
1262                  */
1263                 case BTRFS_EXTENT_DATA_REF_KEY:
1264                         dref = (struct btrfs_extent_data_ref *)(&iref->offset);
1265                         dref_offset = btrfs_extent_data_ref_offset(leaf, dref);
1266                         if (!IS_ALIGNED(dref_offset, fs_info->sectorsize)) {
1267                                 extent_err(leaf, slot,
1268                 "invalid data ref offset, have %llu expect aligned to %u",
1269                                            dref_offset, fs_info->sectorsize);
1270                                 return -EUCLEAN;
1271                         }
1272                         inline_refs += btrfs_extent_data_ref_count(leaf, dref);
1273                         break;
1274                 /* Contains parent bytenr and ref count */
1275                 case BTRFS_SHARED_DATA_REF_KEY:
1276                         sref = (struct btrfs_shared_data_ref *)(iref + 1);
1277                         if (!IS_ALIGNED(inline_offset, fs_info->sectorsize)) {
1278                                 extent_err(leaf, slot,
1279                 "invalid data parent bytenr, have %llu expect aligned to %u",
1280                                            inline_offset, fs_info->sectorsize);
1281                                 return -EUCLEAN;
1282                         }
1283                         inline_refs += btrfs_shared_data_ref_count(leaf, sref);
1284                         break;
1285                 default:
1286                         extent_err(leaf, slot, "unknown inline ref type: %u",
1287                                    inline_type);
1288                         return -EUCLEAN;
1289                 }
1290                 ptr += btrfs_extent_inline_ref_size(inline_type);
1291         }
1292         /* No padding is allowed */
1293         if (ptr != end) {
1294                 extent_err(leaf, slot,
1295                            "invalid extent item size, padding bytes found");
1296                 return -EUCLEAN;
1297         }
1298
1299         /* Finally, check the inline refs against total refs */
1300         if (inline_refs > total_refs) {
1301                 extent_err(leaf, slot,
1302                         "invalid extent refs, have %llu expect >= inline %llu",
1303                            total_refs, inline_refs);
1304                 return -EUCLEAN;
1305         }
1306         return 0;
1307 }
1308
1309 static int check_simple_keyed_refs(struct extent_buffer *leaf,
1310                                    struct btrfs_key *key, int slot)
1311 {
1312         u32 expect_item_size = 0;
1313
1314         if (key->type == BTRFS_SHARED_DATA_REF_KEY)
1315                 expect_item_size = sizeof(struct btrfs_shared_data_ref);
1316
1317         if (btrfs_item_size_nr(leaf, slot) != expect_item_size) {
1318                 generic_err(leaf, slot,
1319                 "invalid item size, have %u expect %u for key type %u",
1320                             btrfs_item_size_nr(leaf, slot),
1321                             expect_item_size, key->type);
1322                 return -EUCLEAN;
1323         }
1324         if (!IS_ALIGNED(key->objectid, leaf->fs_info->sectorsize)) {
1325                 generic_err(leaf, slot,
1326 "invalid key objectid for shared block ref, have %llu expect aligned to %u",
1327                             key->objectid, leaf->fs_info->sectorsize);
1328                 return -EUCLEAN;
1329         }
1330         if (key->type != BTRFS_TREE_BLOCK_REF_KEY &&
1331             !IS_ALIGNED(key->offset, leaf->fs_info->sectorsize)) {
1332                 extent_err(leaf, slot,
1333                 "invalid tree parent bytenr, have %llu expect aligned to %u",
1334                            key->offset, leaf->fs_info->sectorsize);
1335                 return -EUCLEAN;
1336         }
1337         return 0;
1338 }
1339
1340 static int check_extent_data_ref(struct extent_buffer *leaf,
1341                                  struct btrfs_key *key, int slot)
1342 {
1343         struct btrfs_extent_data_ref *dref;
1344         unsigned long ptr = btrfs_item_ptr_offset(leaf, slot);
1345         const unsigned long end = ptr + btrfs_item_size_nr(leaf, slot);
1346
1347         if (btrfs_item_size_nr(leaf, slot) % sizeof(*dref) != 0) {
1348                 generic_err(leaf, slot,
1349         "invalid item size, have %u expect aligned to %zu for key type %u",
1350                             btrfs_item_size_nr(leaf, slot),
1351                             sizeof(*dref), key->type);
1352         }
1353         if (!IS_ALIGNED(key->objectid, leaf->fs_info->sectorsize)) {
1354                 generic_err(leaf, slot,
1355 "invalid key objectid for shared block ref, have %llu expect aligned to %u",
1356                             key->objectid, leaf->fs_info->sectorsize);
1357                 return -EUCLEAN;
1358         }
1359         for (; ptr < end; ptr += sizeof(*dref)) {
1360                 u64 root_objectid;
1361                 u64 owner;
1362                 u64 offset;
1363                 u64 hash;
1364
1365                 dref = (struct btrfs_extent_data_ref *)ptr;
1366                 root_objectid = btrfs_extent_data_ref_root(leaf, dref);
1367                 owner = btrfs_extent_data_ref_objectid(leaf, dref);
1368                 offset = btrfs_extent_data_ref_offset(leaf, dref);
1369                 hash = hash_extent_data_ref(root_objectid, owner, offset);
1370                 if (hash != key->offset) {
1371                         extent_err(leaf, slot,
1372         "invalid extent data ref hash, item has 0x%016llx key has 0x%016llx",
1373                                    hash, key->offset);
1374                         return -EUCLEAN;
1375                 }
1376                 if (!IS_ALIGNED(offset, leaf->fs_info->sectorsize)) {
1377                         extent_err(leaf, slot,
1378         "invalid extent data backref offset, have %llu expect aligned to %u",
1379                                    offset, leaf->fs_info->sectorsize);
1380                 }
1381         }
1382         return 0;
1383 }
1384
1385 #define inode_ref_err(eb, slot, fmt, args...)                   \
1386         inode_item_err(eb, slot, fmt, ##args)
1387 static int check_inode_ref(struct extent_buffer *leaf,
1388                            struct btrfs_key *key, struct btrfs_key *prev_key,
1389                            int slot)
1390 {
1391         struct btrfs_inode_ref *iref;
1392         unsigned long ptr;
1393         unsigned long end;
1394
1395         if (!check_prev_ino(leaf, key, slot, prev_key))
1396                 return -EUCLEAN;
1397         /* namelen can't be 0, so item_size == sizeof() is also invalid */
1398         if (btrfs_item_size_nr(leaf, slot) <= sizeof(*iref)) {
1399                 inode_ref_err(leaf, slot,
1400                         "invalid item size, have %u expect (%zu, %u)",
1401                         btrfs_item_size_nr(leaf, slot),
1402                         sizeof(*iref), BTRFS_LEAF_DATA_SIZE(leaf->fs_info));
1403                 return -EUCLEAN;
1404         }
1405
1406         ptr = btrfs_item_ptr_offset(leaf, slot);
1407         end = ptr + btrfs_item_size_nr(leaf, slot);
1408         while (ptr < end) {
1409                 u16 namelen;
1410
1411                 if (ptr + sizeof(iref) > end) {
1412                         inode_ref_err(leaf, slot,
1413                         "inode ref overflow, ptr %lu end %lu inode_ref_size %zu",
1414                                 ptr, end, sizeof(iref));
1415                         return -EUCLEAN;
1416                 }
1417
1418                 iref = (struct btrfs_inode_ref *)ptr;
1419                 namelen = btrfs_inode_ref_name_len(leaf, iref);
1420                 if (ptr + sizeof(*iref) + namelen > end) {
1421                         inode_ref_err(leaf, slot,
1422                                 "inode ref overflow, ptr %lu end %lu namelen %u",
1423                                 ptr, end, namelen);
1424                         return -EUCLEAN;
1425                 }
1426
1427                 /*
1428                  * NOTE: In theory we should record all found index numbers
1429                  * to find any duplicated indexes, but that will be too time
1430                  * consuming for inodes with too many hard links.
1431                  */
1432                 ptr += sizeof(*iref) + namelen;
1433         }
1434         return 0;
1435 }
1436
1437 /*
1438  * Common point to switch the item-specific validation.
1439  */
1440 static int check_leaf_item(struct extent_buffer *leaf,
1441                            struct btrfs_key *key, int slot,
1442                            struct btrfs_key *prev_key)
1443 {
1444         int ret = 0;
1445         struct btrfs_chunk *chunk;
1446
1447         switch (key->type) {
1448         case BTRFS_EXTENT_DATA_KEY:
1449                 ret = check_extent_data_item(leaf, key, slot, prev_key);
1450                 break;
1451         case BTRFS_EXTENT_CSUM_KEY:
1452                 ret = check_csum_item(leaf, key, slot, prev_key);
1453                 break;
1454         case BTRFS_DIR_ITEM_KEY:
1455         case BTRFS_DIR_INDEX_KEY:
1456         case BTRFS_XATTR_ITEM_KEY:
1457                 ret = check_dir_item(leaf, key, prev_key, slot);
1458                 break;
1459         case BTRFS_INODE_REF_KEY:
1460                 ret = check_inode_ref(leaf, key, prev_key, slot);
1461                 break;
1462         case BTRFS_BLOCK_GROUP_ITEM_KEY:
1463                 ret = check_block_group_item(leaf, key, slot);
1464                 break;
1465         case BTRFS_CHUNK_ITEM_KEY:
1466                 chunk = btrfs_item_ptr(leaf, slot, struct btrfs_chunk);
1467                 ret = check_leaf_chunk_item(leaf, chunk, key, slot);
1468                 break;
1469         case BTRFS_DEV_ITEM_KEY:
1470                 ret = check_dev_item(leaf, key, slot);
1471                 break;
1472         case BTRFS_INODE_ITEM_KEY:
1473                 ret = check_inode_item(leaf, key, slot);
1474                 break;
1475         case BTRFS_ROOT_ITEM_KEY:
1476                 ret = check_root_item(leaf, key, slot);
1477                 break;
1478         case BTRFS_EXTENT_ITEM_KEY:
1479         case BTRFS_METADATA_ITEM_KEY:
1480                 ret = check_extent_item(leaf, key, slot);
1481                 break;
1482         case BTRFS_TREE_BLOCK_REF_KEY:
1483         case BTRFS_SHARED_DATA_REF_KEY:
1484         case BTRFS_SHARED_BLOCK_REF_KEY:
1485                 ret = check_simple_keyed_refs(leaf, key, slot);
1486                 break;
1487         case BTRFS_EXTENT_DATA_REF_KEY:
1488                 ret = check_extent_data_ref(leaf, key, slot);
1489                 break;
1490         }
1491         return ret;
1492 }
1493
1494 static int check_leaf(struct extent_buffer *leaf, bool check_item_data)
1495 {
1496         struct btrfs_fs_info *fs_info = leaf->fs_info;
1497         /* No valid key type is 0, so all key should be larger than this key */
1498         struct btrfs_key prev_key = {0, 0, 0};
1499         struct btrfs_key key;
1500         u32 nritems = btrfs_header_nritems(leaf);
1501         int slot;
1502
1503         if (btrfs_header_level(leaf) != 0) {
1504                 generic_err(leaf, 0,
1505                         "invalid level for leaf, have %d expect 0",
1506                         btrfs_header_level(leaf));
1507                 return -EUCLEAN;
1508         }
1509
1510         /*
1511          * Extent buffers from a relocation tree have a owner field that
1512          * corresponds to the subvolume tree they are based on. So just from an
1513          * extent buffer alone we can not find out what is the id of the
1514          * corresponding subvolume tree, so we can not figure out if the extent
1515          * buffer corresponds to the root of the relocation tree or not. So
1516          * skip this check for relocation trees.
1517          */
1518         if (nritems == 0 && !btrfs_header_flag(leaf, BTRFS_HEADER_FLAG_RELOC)) {
1519                 u64 owner = btrfs_header_owner(leaf);
1520
1521                 /* These trees must never be empty */
1522                 if (owner == BTRFS_ROOT_TREE_OBJECTID ||
1523                     owner == BTRFS_CHUNK_TREE_OBJECTID ||
1524                     owner == BTRFS_EXTENT_TREE_OBJECTID ||
1525                     owner == BTRFS_DEV_TREE_OBJECTID ||
1526                     owner == BTRFS_FS_TREE_OBJECTID ||
1527                     owner == BTRFS_DATA_RELOC_TREE_OBJECTID) {
1528                         generic_err(leaf, 0,
1529                         "invalid root, root %llu must never be empty",
1530                                     owner);
1531                         return -EUCLEAN;
1532                 }
1533                 /* Unknown tree */
1534                 if (owner == 0) {
1535                         generic_err(leaf, 0,
1536                                 "invalid owner, root 0 is not defined");
1537                         return -EUCLEAN;
1538                 }
1539                 return 0;
1540         }
1541
1542         if (nritems == 0)
1543                 return 0;
1544
1545         /*
1546          * Check the following things to make sure this is a good leaf, and
1547          * leaf users won't need to bother with similar sanity checks:
1548          *
1549          * 1) key ordering
1550          * 2) item offset and size
1551          *    No overlap, no hole, all inside the leaf.
1552          * 3) item content
1553          *    If possible, do comprehensive sanity check.
1554          *    NOTE: All checks must only rely on the item data itself.
1555          */
1556         for (slot = 0; slot < nritems; slot++) {
1557                 u32 item_end_expected;
1558                 int ret;
1559
1560                 btrfs_item_key_to_cpu(leaf, &key, slot);
1561
1562                 /* Make sure the keys are in the right order */
1563                 if (btrfs_comp_cpu_keys(&prev_key, &key) >= 0) {
1564                         generic_err(leaf, slot,
1565         "bad key order, prev (%llu %u %llu) current (%llu %u %llu)",
1566                                 prev_key.objectid, prev_key.type,
1567                                 prev_key.offset, key.objectid, key.type,
1568                                 key.offset);
1569                         return -EUCLEAN;
1570                 }
1571
1572                 /*
1573                  * Make sure the offset and ends are right, remember that the
1574                  * item data starts at the end of the leaf and grows towards the
1575                  * front.
1576                  */
1577                 if (slot == 0)
1578                         item_end_expected = BTRFS_LEAF_DATA_SIZE(fs_info);
1579                 else
1580                         item_end_expected = btrfs_item_offset_nr(leaf,
1581                                                                  slot - 1);
1582                 if (btrfs_item_end_nr(leaf, slot) != item_end_expected) {
1583                         generic_err(leaf, slot,
1584                                 "unexpected item end, have %u expect %u",
1585                                 btrfs_item_end_nr(leaf, slot),
1586                                 item_end_expected);
1587                         return -EUCLEAN;
1588                 }
1589
1590                 /*
1591                  * Check to make sure that we don't point outside of the leaf,
1592                  * just in case all the items are consistent to each other, but
1593                  * all point outside of the leaf.
1594                  */
1595                 if (btrfs_item_end_nr(leaf, slot) >
1596                     BTRFS_LEAF_DATA_SIZE(fs_info)) {
1597                         generic_err(leaf, slot,
1598                         "slot end outside of leaf, have %u expect range [0, %u]",
1599                                 btrfs_item_end_nr(leaf, slot),
1600                                 BTRFS_LEAF_DATA_SIZE(fs_info));
1601                         return -EUCLEAN;
1602                 }
1603
1604                 /* Also check if the item pointer overlaps with btrfs item. */
1605                 if (btrfs_item_nr_offset(slot) + sizeof(struct btrfs_item) >
1606                     btrfs_item_ptr_offset(leaf, slot)) {
1607                         generic_err(leaf, slot,
1608                 "slot overlaps with its data, item end %lu data start %lu",
1609                                 btrfs_item_nr_offset(slot) +
1610                                 sizeof(struct btrfs_item),
1611                                 btrfs_item_ptr_offset(leaf, slot));
1612                         return -EUCLEAN;
1613                 }
1614
1615                 if (check_item_data) {
1616                         /*
1617                          * Check if the item size and content meet other
1618                          * criteria
1619                          */
1620                         ret = check_leaf_item(leaf, &key, slot, &prev_key);
1621                         if (ret < 0)
1622                                 return ret;
1623                 }
1624
1625                 prev_key.objectid = key.objectid;
1626                 prev_key.type = key.type;
1627                 prev_key.offset = key.offset;
1628         }
1629
1630         return 0;
1631 }
1632
1633 int btrfs_check_leaf_full(struct extent_buffer *leaf)
1634 {
1635         return check_leaf(leaf, true);
1636 }
1637 ALLOW_ERROR_INJECTION(btrfs_check_leaf_full, ERRNO);
1638
1639 int btrfs_check_leaf_relaxed(struct extent_buffer *leaf)
1640 {
1641         return check_leaf(leaf, false);
1642 }
1643
1644 int btrfs_check_node(struct extent_buffer *node)
1645 {
1646         struct btrfs_fs_info *fs_info = node->fs_info;
1647         unsigned long nr = btrfs_header_nritems(node);
1648         struct btrfs_key key, next_key;
1649         int slot;
1650         int level = btrfs_header_level(node);
1651         u64 bytenr;
1652         int ret = 0;
1653
1654         if (level <= 0 || level >= BTRFS_MAX_LEVEL) {
1655                 generic_err(node, 0,
1656                         "invalid level for node, have %d expect [1, %d]",
1657                         level, BTRFS_MAX_LEVEL - 1);
1658                 return -EUCLEAN;
1659         }
1660         if (nr == 0 || nr > BTRFS_NODEPTRS_PER_BLOCK(fs_info)) {
1661                 btrfs_crit(fs_info,
1662 "corrupt node: root=%llu block=%llu, nritems too %s, have %lu expect range [1,%u]",
1663                            btrfs_header_owner(node), node->start,
1664                            nr == 0 ? "small" : "large", nr,
1665                            BTRFS_NODEPTRS_PER_BLOCK(fs_info));
1666                 return -EUCLEAN;
1667         }
1668
1669         for (slot = 0; slot < nr - 1; slot++) {
1670                 bytenr = btrfs_node_blockptr(node, slot);
1671                 btrfs_node_key_to_cpu(node, &key, slot);
1672                 btrfs_node_key_to_cpu(node, &next_key, slot + 1);
1673
1674                 if (!bytenr) {
1675                         generic_err(node, slot,
1676                                 "invalid NULL node pointer");
1677                         ret = -EUCLEAN;
1678                         goto out;
1679                 }
1680                 if (!IS_ALIGNED(bytenr, fs_info->sectorsize)) {
1681                         generic_err(node, slot,
1682                         "unaligned pointer, have %llu should be aligned to %u",
1683                                 bytenr, fs_info->sectorsize);
1684                         ret = -EUCLEAN;
1685                         goto out;
1686                 }
1687
1688                 if (btrfs_comp_cpu_keys(&key, &next_key) >= 0) {
1689                         generic_err(node, slot,
1690         "bad key order, current (%llu %u %llu) next (%llu %u %llu)",
1691                                 key.objectid, key.type, key.offset,
1692                                 next_key.objectid, next_key.type,
1693                                 next_key.offset);
1694                         ret = -EUCLEAN;
1695                         goto out;
1696                 }
1697         }
1698 out:
1699         return ret;
1700 }
1701 ALLOW_ERROR_INJECTION(btrfs_check_node, ERRNO);