btrfs: tree-checker: get fs_info from eb in check_block_group_item
[sfrench/cifs-2.6.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 "ctree.h"
19 #include "tree-checker.h"
20 #include "disk-io.h"
21 #include "compression.h"
22 #include "volumes.h"
23
24 /*
25  * Error message should follow the following format:
26  * corrupt <type>: <identifier>, <reason>[, <bad_value>]
27  *
28  * @type:       leaf or node
29  * @identifier: the necessary info to locate the leaf/node.
30  *              It's recommended to decode key.objecitd/offset if it's
31  *              meaningful.
32  * @reason:     describe the error
33  * @bad_value:  optional, it's recommended to output bad value and its
34  *              expected value (range).
35  *
36  * Since comma is used to separate the components, only space is allowed
37  * inside each component.
38  */
39
40 /*
41  * Append generic "corrupt leaf/node root=%llu block=%llu slot=%d: " to @fmt.
42  * Allows callers to customize the output.
43  */
44 __printf(3, 4)
45 __cold
46 static void generic_err(const struct extent_buffer *eb, int slot,
47                         const char *fmt, ...)
48 {
49         const struct btrfs_fs_info *fs_info = eb->fs_info;
50         struct va_format vaf;
51         va_list args;
52
53         va_start(args, fmt);
54
55         vaf.fmt = fmt;
56         vaf.va = &args;
57
58         btrfs_crit(fs_info,
59                 "corrupt %s: root=%llu block=%llu slot=%d, %pV",
60                 btrfs_header_level(eb) == 0 ? "leaf" : "node",
61                 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot, &vaf);
62         va_end(args);
63 }
64
65 /*
66  * Customized reporter for extent data item, since its key objectid and
67  * offset has its own meaning.
68  */
69 __printf(3, 4)
70 __cold
71 static void file_extent_err(const struct extent_buffer *eb, int slot,
72                             const char *fmt, ...)
73 {
74         const struct btrfs_fs_info *fs_info = eb->fs_info;
75         struct btrfs_key key;
76         struct va_format vaf;
77         va_list args;
78
79         btrfs_item_key_to_cpu(eb, &key, slot);
80         va_start(args, fmt);
81
82         vaf.fmt = fmt;
83         vaf.va = &args;
84
85         btrfs_crit(fs_info,
86         "corrupt %s: root=%llu block=%llu slot=%d ino=%llu file_offset=%llu, %pV",
87                 btrfs_header_level(eb) == 0 ? "leaf" : "node",
88                 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
89                 key.objectid, key.offset, &vaf);
90         va_end(args);
91 }
92
93 /*
94  * Return 0 if the btrfs_file_extent_##name is aligned to @alignment
95  * Else return 1
96  */
97 #define CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, name, alignment)            \
98 ({                                                                            \
99         if (!IS_ALIGNED(btrfs_file_extent_##name((leaf), (fi)), (alignment))) \
100                 file_extent_err((leaf), (slot),                               \
101         "invalid %s for file extent, have %llu, should be aligned to %u",     \
102                         (#name), btrfs_file_extent_##name((leaf), (fi)),      \
103                         (alignment));                                         \
104         (!IS_ALIGNED(btrfs_file_extent_##name((leaf), (fi)), (alignment)));   \
105 })
106
107 static int check_extent_data_item(struct btrfs_fs_info *fs_info,
108                                   struct extent_buffer *leaf,
109                                   struct btrfs_key *key, int slot)
110 {
111         struct btrfs_file_extent_item *fi;
112         u32 sectorsize = fs_info->sectorsize;
113         u32 item_size = btrfs_item_size_nr(leaf, slot);
114
115         if (!IS_ALIGNED(key->offset, sectorsize)) {
116                 file_extent_err(leaf, slot,
117 "unaligned file_offset for file extent, have %llu should be aligned to %u",
118                         key->offset, sectorsize);
119                 return -EUCLEAN;
120         }
121
122         fi = btrfs_item_ptr(leaf, slot, struct btrfs_file_extent_item);
123
124         if (btrfs_file_extent_type(leaf, fi) > BTRFS_FILE_EXTENT_TYPES) {
125                 file_extent_err(leaf, slot,
126                 "invalid type for file extent, have %u expect range [0, %u]",
127                         btrfs_file_extent_type(leaf, fi),
128                         BTRFS_FILE_EXTENT_TYPES);
129                 return -EUCLEAN;
130         }
131
132         /*
133          * Support for new compression/encryption must introduce incompat flag,
134          * and must be caught in open_ctree().
135          */
136         if (btrfs_file_extent_compression(leaf, fi) > BTRFS_COMPRESS_TYPES) {
137                 file_extent_err(leaf, slot,
138         "invalid compression for file extent, have %u expect range [0, %u]",
139                         btrfs_file_extent_compression(leaf, fi),
140                         BTRFS_COMPRESS_TYPES);
141                 return -EUCLEAN;
142         }
143         if (btrfs_file_extent_encryption(leaf, fi)) {
144                 file_extent_err(leaf, slot,
145                         "invalid encryption for file extent, have %u expect 0",
146                         btrfs_file_extent_encryption(leaf, fi));
147                 return -EUCLEAN;
148         }
149         if (btrfs_file_extent_type(leaf, fi) == BTRFS_FILE_EXTENT_INLINE) {
150                 /* Inline extent must have 0 as key offset */
151                 if (key->offset) {
152                         file_extent_err(leaf, slot,
153                 "invalid file_offset for inline file extent, have %llu expect 0",
154                                 key->offset);
155                         return -EUCLEAN;
156                 }
157
158                 /* Compressed inline extent has no on-disk size, skip it */
159                 if (btrfs_file_extent_compression(leaf, fi) !=
160                     BTRFS_COMPRESS_NONE)
161                         return 0;
162
163                 /* Uncompressed inline extent size must match item size */
164                 if (item_size != BTRFS_FILE_EXTENT_INLINE_DATA_START +
165                     btrfs_file_extent_ram_bytes(leaf, fi)) {
166                         file_extent_err(leaf, slot,
167         "invalid ram_bytes for uncompressed inline extent, have %u expect %llu",
168                                 item_size, BTRFS_FILE_EXTENT_INLINE_DATA_START +
169                                 btrfs_file_extent_ram_bytes(leaf, fi));
170                         return -EUCLEAN;
171                 }
172                 return 0;
173         }
174
175         /* Regular or preallocated extent has fixed item size */
176         if (item_size != sizeof(*fi)) {
177                 file_extent_err(leaf, slot,
178         "invalid item size for reg/prealloc file extent, have %u expect %zu",
179                         item_size, sizeof(*fi));
180                 return -EUCLEAN;
181         }
182         if (CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, ram_bytes, sectorsize) ||
183             CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, disk_bytenr, sectorsize) ||
184             CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, disk_num_bytes, sectorsize) ||
185             CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, offset, sectorsize) ||
186             CHECK_FE_ALIGNED(fs_info, leaf, slot, fi, num_bytes, sectorsize))
187                 return -EUCLEAN;
188         return 0;
189 }
190
191 static int check_csum_item(struct extent_buffer *leaf, struct btrfs_key *key,
192                            int slot)
193 {
194         struct btrfs_fs_info *fs_info = leaf->fs_info;
195         u32 sectorsize = fs_info->sectorsize;
196         u32 csumsize = btrfs_super_csum_size(fs_info->super_copy);
197
198         if (key->objectid != BTRFS_EXTENT_CSUM_OBJECTID) {
199                 generic_err(leaf, slot,
200                 "invalid key objectid for csum item, have %llu expect %llu",
201                         key->objectid, BTRFS_EXTENT_CSUM_OBJECTID);
202                 return -EUCLEAN;
203         }
204         if (!IS_ALIGNED(key->offset, sectorsize)) {
205                 generic_err(leaf, slot,
206         "unaligned key offset for csum item, have %llu should be aligned to %u",
207                         key->offset, sectorsize);
208                 return -EUCLEAN;
209         }
210         if (!IS_ALIGNED(btrfs_item_size_nr(leaf, slot), csumsize)) {
211                 generic_err(leaf, slot,
212         "unaligned item size for csum item, have %u should be aligned to %u",
213                         btrfs_item_size_nr(leaf, slot), csumsize);
214                 return -EUCLEAN;
215         }
216         return 0;
217 }
218
219 /*
220  * Customized reported for dir_item, only important new info is key->objectid,
221  * which represents inode number
222  */
223 __printf(3, 4)
224 __cold
225 static void dir_item_err(const struct extent_buffer *eb, int slot,
226                          const char *fmt, ...)
227 {
228         const struct btrfs_fs_info *fs_info = eb->fs_info;
229         struct btrfs_key key;
230         struct va_format vaf;
231         va_list args;
232
233         btrfs_item_key_to_cpu(eb, &key, slot);
234         va_start(args, fmt);
235
236         vaf.fmt = fmt;
237         vaf.va = &args;
238
239         btrfs_crit(fs_info,
240         "corrupt %s: root=%llu block=%llu slot=%d ino=%llu, %pV",
241                 btrfs_header_level(eb) == 0 ? "leaf" : "node",
242                 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
243                 key.objectid, &vaf);
244         va_end(args);
245 }
246
247 static int check_dir_item(struct extent_buffer *leaf,
248                           struct btrfs_key *key, int slot)
249 {
250         struct btrfs_fs_info *fs_info = leaf->fs_info;
251         struct btrfs_dir_item *di;
252         u32 item_size = btrfs_item_size_nr(leaf, slot);
253         u32 cur = 0;
254
255         di = btrfs_item_ptr(leaf, slot, struct btrfs_dir_item);
256         while (cur < item_size) {
257                 u32 name_len;
258                 u32 data_len;
259                 u32 max_name_len;
260                 u32 total_size;
261                 u32 name_hash;
262                 u8 dir_type;
263
264                 /* header itself should not cross item boundary */
265                 if (cur + sizeof(*di) > item_size) {
266                         dir_item_err(leaf, slot,
267                 "dir item header crosses item boundary, have %zu boundary %u",
268                                 cur + sizeof(*di), item_size);
269                         return -EUCLEAN;
270                 }
271
272                 /* dir type check */
273                 dir_type = btrfs_dir_type(leaf, di);
274                 if (dir_type >= BTRFS_FT_MAX) {
275                         dir_item_err(leaf, slot,
276                         "invalid dir item type, have %u expect [0, %u)",
277                                 dir_type, BTRFS_FT_MAX);
278                         return -EUCLEAN;
279                 }
280
281                 if (key->type == BTRFS_XATTR_ITEM_KEY &&
282                     dir_type != BTRFS_FT_XATTR) {
283                         dir_item_err(leaf, slot,
284                 "invalid dir item type for XATTR key, have %u expect %u",
285                                 dir_type, BTRFS_FT_XATTR);
286                         return -EUCLEAN;
287                 }
288                 if (dir_type == BTRFS_FT_XATTR &&
289                     key->type != BTRFS_XATTR_ITEM_KEY) {
290                         dir_item_err(leaf, slot,
291                         "xattr dir type found for non-XATTR key");
292                         return -EUCLEAN;
293                 }
294                 if (dir_type == BTRFS_FT_XATTR)
295                         max_name_len = XATTR_NAME_MAX;
296                 else
297                         max_name_len = BTRFS_NAME_LEN;
298
299                 /* Name/data length check */
300                 name_len = btrfs_dir_name_len(leaf, di);
301                 data_len = btrfs_dir_data_len(leaf, di);
302                 if (name_len > max_name_len) {
303                         dir_item_err(leaf, slot,
304                         "dir item name len too long, have %u max %u",
305                                 name_len, max_name_len);
306                         return -EUCLEAN;
307                 }
308                 if (name_len + data_len > BTRFS_MAX_XATTR_SIZE(fs_info)) {
309                         dir_item_err(leaf, slot,
310                         "dir item name and data len too long, have %u max %u",
311                                 name_len + data_len,
312                                 BTRFS_MAX_XATTR_SIZE(fs_info));
313                         return -EUCLEAN;
314                 }
315
316                 if (data_len && dir_type != BTRFS_FT_XATTR) {
317                         dir_item_err(leaf, slot,
318                         "dir item with invalid data len, have %u expect 0",
319                                 data_len);
320                         return -EUCLEAN;
321                 }
322
323                 total_size = sizeof(*di) + name_len + data_len;
324
325                 /* header and name/data should not cross item boundary */
326                 if (cur + total_size > item_size) {
327                         dir_item_err(leaf, slot,
328                 "dir item data crosses item boundary, have %u boundary %u",
329                                 cur + total_size, item_size);
330                         return -EUCLEAN;
331                 }
332
333                 /*
334                  * Special check for XATTR/DIR_ITEM, as key->offset is name
335                  * hash, should match its name
336                  */
337                 if (key->type == BTRFS_DIR_ITEM_KEY ||
338                     key->type == BTRFS_XATTR_ITEM_KEY) {
339                         char namebuf[max(BTRFS_NAME_LEN, XATTR_NAME_MAX)];
340
341                         read_extent_buffer(leaf, namebuf,
342                                         (unsigned long)(di + 1), name_len);
343                         name_hash = btrfs_name_hash(namebuf, name_len);
344                         if (key->offset != name_hash) {
345                                 dir_item_err(leaf, slot,
346                 "name hash mismatch with key, have 0x%016x expect 0x%016llx",
347                                         name_hash, key->offset);
348                                 return -EUCLEAN;
349                         }
350                 }
351                 cur += total_size;
352                 di = (struct btrfs_dir_item *)((void *)di + total_size);
353         }
354         return 0;
355 }
356
357 __printf(3, 4)
358 __cold
359 static void block_group_err(const struct extent_buffer *eb, int slot,
360                             const char *fmt, ...)
361 {
362         const struct btrfs_fs_info *fs_info = eb->fs_info;
363         struct btrfs_key key;
364         struct va_format vaf;
365         va_list args;
366
367         btrfs_item_key_to_cpu(eb, &key, slot);
368         va_start(args, fmt);
369
370         vaf.fmt = fmt;
371         vaf.va = &args;
372
373         btrfs_crit(fs_info,
374         "corrupt %s: root=%llu block=%llu slot=%d bg_start=%llu bg_len=%llu, %pV",
375                 btrfs_header_level(eb) == 0 ? "leaf" : "node",
376                 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
377                 key.objectid, key.offset, &vaf);
378         va_end(args);
379 }
380
381 static int check_block_group_item(struct extent_buffer *leaf,
382                                   struct btrfs_key *key, int slot)
383 {
384         struct btrfs_block_group_item bgi;
385         u32 item_size = btrfs_item_size_nr(leaf, slot);
386         u64 flags;
387         u64 type;
388
389         /*
390          * Here we don't really care about alignment since extent allocator can
391          * handle it.  We care more about the size.
392          */
393         if (key->offset == 0) {
394                 block_group_err(leaf, slot,
395                                 "invalid block group size 0");
396                 return -EUCLEAN;
397         }
398
399         if (item_size != sizeof(bgi)) {
400                 block_group_err(leaf, slot,
401                         "invalid item size, have %u expect %zu",
402                                 item_size, sizeof(bgi));
403                 return -EUCLEAN;
404         }
405
406         read_extent_buffer(leaf, &bgi, btrfs_item_ptr_offset(leaf, slot),
407                            sizeof(bgi));
408         if (btrfs_block_group_chunk_objectid(&bgi) !=
409             BTRFS_FIRST_CHUNK_TREE_OBJECTID) {
410                 block_group_err(leaf, slot,
411                 "invalid block group chunk objectid, have %llu expect %llu",
412                                 btrfs_block_group_chunk_objectid(&bgi),
413                                 BTRFS_FIRST_CHUNK_TREE_OBJECTID);
414                 return -EUCLEAN;
415         }
416
417         if (btrfs_block_group_used(&bgi) > key->offset) {
418                 block_group_err(leaf, slot,
419                         "invalid block group used, have %llu expect [0, %llu)",
420                                 btrfs_block_group_used(&bgi), key->offset);
421                 return -EUCLEAN;
422         }
423
424         flags = btrfs_block_group_flags(&bgi);
425         if (hweight64(flags & BTRFS_BLOCK_GROUP_PROFILE_MASK) > 1) {
426                 block_group_err(leaf, slot,
427 "invalid profile flags, have 0x%llx (%lu bits set) expect no more than 1 bit set",
428                         flags & BTRFS_BLOCK_GROUP_PROFILE_MASK,
429                         hweight64(flags & BTRFS_BLOCK_GROUP_PROFILE_MASK));
430                 return -EUCLEAN;
431         }
432
433         type = flags & BTRFS_BLOCK_GROUP_TYPE_MASK;
434         if (type != BTRFS_BLOCK_GROUP_DATA &&
435             type != BTRFS_BLOCK_GROUP_METADATA &&
436             type != BTRFS_BLOCK_GROUP_SYSTEM &&
437             type != (BTRFS_BLOCK_GROUP_METADATA |
438                            BTRFS_BLOCK_GROUP_DATA)) {
439                 block_group_err(leaf, slot,
440 "invalid type, have 0x%llx (%lu bits set) expect either 0x%llx, 0x%llx, 0x%llx or 0x%llx",
441                         type, hweight64(type),
442                         BTRFS_BLOCK_GROUP_DATA, BTRFS_BLOCK_GROUP_METADATA,
443                         BTRFS_BLOCK_GROUP_SYSTEM,
444                         BTRFS_BLOCK_GROUP_METADATA | BTRFS_BLOCK_GROUP_DATA);
445                 return -EUCLEAN;
446         }
447         return 0;
448 }
449
450 __printf(5, 6)
451 __cold
452 static void chunk_err(const struct btrfs_fs_info *fs_info,
453                       const struct extent_buffer *leaf,
454                       const struct btrfs_chunk *chunk, u64 logical,
455                       const char *fmt, ...)
456 {
457         bool is_sb;
458         struct va_format vaf;
459         va_list args;
460         int i;
461         int slot = -1;
462
463         /* Only superblock eb is able to have such small offset */
464         is_sb = (leaf->start == BTRFS_SUPER_INFO_OFFSET);
465
466         if (!is_sb) {
467                 /*
468                  * Get the slot number by iterating through all slots, this
469                  * would provide better readability.
470                  */
471                 for (i = 0; i < btrfs_header_nritems(leaf); i++) {
472                         if (btrfs_item_ptr_offset(leaf, i) ==
473                                         (unsigned long)chunk) {
474                                 slot = i;
475                                 break;
476                         }
477                 }
478         }
479         va_start(args, fmt);
480         vaf.fmt = fmt;
481         vaf.va = &args;
482
483         if (is_sb)
484                 btrfs_crit(fs_info,
485                 "corrupt superblock syschunk array: chunk_start=%llu, %pV",
486                            logical, &vaf);
487         else
488                 btrfs_crit(fs_info,
489         "corrupt leaf: root=%llu block=%llu slot=%d chunk_start=%llu, %pV",
490                            BTRFS_CHUNK_TREE_OBJECTID, leaf->start, slot,
491                            logical, &vaf);
492         va_end(args);
493 }
494
495 /*
496  * The common chunk check which could also work on super block sys chunk array.
497  *
498  * Return -EUCLEAN if anything is corrupted.
499  * Return 0 if everything is OK.
500  */
501 int btrfs_check_chunk_valid(struct btrfs_fs_info *fs_info,
502                             struct extent_buffer *leaf,
503                             struct btrfs_chunk *chunk, u64 logical)
504 {
505         u64 length;
506         u64 stripe_len;
507         u16 num_stripes;
508         u16 sub_stripes;
509         u64 type;
510         u64 features;
511         bool mixed = false;
512
513         length = btrfs_chunk_length(leaf, chunk);
514         stripe_len = btrfs_chunk_stripe_len(leaf, chunk);
515         num_stripes = btrfs_chunk_num_stripes(leaf, chunk);
516         sub_stripes = btrfs_chunk_sub_stripes(leaf, chunk);
517         type = btrfs_chunk_type(leaf, chunk);
518
519         if (!num_stripes) {
520                 chunk_err(fs_info, leaf, chunk, logical,
521                           "invalid chunk num_stripes, have %u", num_stripes);
522                 return -EUCLEAN;
523         }
524         if (!IS_ALIGNED(logical, fs_info->sectorsize)) {
525                 chunk_err(fs_info, leaf, chunk, logical,
526                 "invalid chunk logical, have %llu should aligned to %u",
527                           logical, fs_info->sectorsize);
528                 return -EUCLEAN;
529         }
530         if (btrfs_chunk_sector_size(leaf, chunk) != fs_info->sectorsize) {
531                 chunk_err(fs_info, leaf, chunk, logical,
532                           "invalid chunk sectorsize, have %u expect %u",
533                           btrfs_chunk_sector_size(leaf, chunk),
534                           fs_info->sectorsize);
535                 return -EUCLEAN;
536         }
537         if (!length || !IS_ALIGNED(length, fs_info->sectorsize)) {
538                 chunk_err(fs_info, leaf, chunk, logical,
539                           "invalid chunk length, have %llu", length);
540                 return -EUCLEAN;
541         }
542         if (!is_power_of_2(stripe_len) || stripe_len != BTRFS_STRIPE_LEN) {
543                 chunk_err(fs_info, leaf, chunk, logical,
544                           "invalid chunk stripe length: %llu",
545                           stripe_len);
546                 return -EUCLEAN;
547         }
548         if (~(BTRFS_BLOCK_GROUP_TYPE_MASK | BTRFS_BLOCK_GROUP_PROFILE_MASK) &
549             type) {
550                 chunk_err(fs_info, leaf, chunk, logical,
551                           "unrecognized chunk type: 0x%llx",
552                           ~(BTRFS_BLOCK_GROUP_TYPE_MASK |
553                             BTRFS_BLOCK_GROUP_PROFILE_MASK) &
554                           btrfs_chunk_type(leaf, chunk));
555                 return -EUCLEAN;
556         }
557
558         if (!is_power_of_2(type & BTRFS_BLOCK_GROUP_PROFILE_MASK) &&
559             (type & BTRFS_BLOCK_GROUP_PROFILE_MASK) != 0) {
560                 chunk_err(fs_info, leaf, chunk, logical,
561                 "invalid chunk profile flag: 0x%llx, expect 0 or 1 bit set",
562                           type & BTRFS_BLOCK_GROUP_PROFILE_MASK);
563                 return -EUCLEAN;
564         }
565         if ((type & BTRFS_BLOCK_GROUP_TYPE_MASK) == 0) {
566                 chunk_err(fs_info, leaf, chunk, logical,
567         "missing chunk type flag, have 0x%llx one bit must be set in 0x%llx",
568                           type, BTRFS_BLOCK_GROUP_TYPE_MASK);
569                 return -EUCLEAN;
570         }
571
572         if ((type & BTRFS_BLOCK_GROUP_SYSTEM) &&
573             (type & (BTRFS_BLOCK_GROUP_METADATA | BTRFS_BLOCK_GROUP_DATA))) {
574                 chunk_err(fs_info, leaf, chunk, logical,
575                           "system chunk with data or metadata type: 0x%llx",
576                           type);
577                 return -EUCLEAN;
578         }
579
580         features = btrfs_super_incompat_flags(fs_info->super_copy);
581         if (features & BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS)
582                 mixed = true;
583
584         if (!mixed) {
585                 if ((type & BTRFS_BLOCK_GROUP_METADATA) &&
586                     (type & BTRFS_BLOCK_GROUP_DATA)) {
587                         chunk_err(fs_info, leaf, chunk, logical,
588                         "mixed chunk type in non-mixed mode: 0x%llx", type);
589                         return -EUCLEAN;
590                 }
591         }
592
593         if ((type & BTRFS_BLOCK_GROUP_RAID10 && sub_stripes != 2) ||
594             (type & BTRFS_BLOCK_GROUP_RAID1 && num_stripes != 2) ||
595             (type & BTRFS_BLOCK_GROUP_RAID5 && num_stripes < 2) ||
596             (type & BTRFS_BLOCK_GROUP_RAID6 && num_stripes < 3) ||
597             (type & BTRFS_BLOCK_GROUP_DUP && num_stripes != 2) ||
598             ((type & BTRFS_BLOCK_GROUP_PROFILE_MASK) == 0 && num_stripes != 1)) {
599                 chunk_err(fs_info, leaf, chunk, logical,
600                         "invalid num_stripes:sub_stripes %u:%u for profile %llu",
601                         num_stripes, sub_stripes,
602                         type & BTRFS_BLOCK_GROUP_PROFILE_MASK);
603                 return -EUCLEAN;
604         }
605
606         return 0;
607 }
608
609 __printf(4, 5)
610 __cold
611 static void dev_item_err(const struct btrfs_fs_info *fs_info,
612                          const struct extent_buffer *eb, int slot,
613                          const char *fmt, ...)
614 {
615         struct btrfs_key key;
616         struct va_format vaf;
617         va_list args;
618
619         btrfs_item_key_to_cpu(eb, &key, slot);
620         va_start(args, fmt);
621
622         vaf.fmt = fmt;
623         vaf.va = &args;
624
625         btrfs_crit(fs_info,
626         "corrupt %s: root=%llu block=%llu slot=%d devid=%llu %pV",
627                 btrfs_header_level(eb) == 0 ? "leaf" : "node",
628                 btrfs_header_owner(eb), btrfs_header_bytenr(eb), slot,
629                 key.objectid, &vaf);
630         va_end(args);
631 }
632
633 static int check_dev_item(struct btrfs_fs_info *fs_info,
634                           struct extent_buffer *leaf,
635                           struct btrfs_key *key, int slot)
636 {
637         struct btrfs_dev_item *ditem;
638         u64 max_devid = max(BTRFS_MAX_DEVS(fs_info), BTRFS_MAX_DEVS_SYS_CHUNK);
639
640         if (key->objectid != BTRFS_DEV_ITEMS_OBJECTID) {
641                 dev_item_err(fs_info, leaf, slot,
642                              "invalid objectid: has=%llu expect=%llu",
643                              key->objectid, BTRFS_DEV_ITEMS_OBJECTID);
644                 return -EUCLEAN;
645         }
646         if (key->offset > max_devid) {
647                 dev_item_err(fs_info, leaf, slot,
648                              "invalid devid: has=%llu expect=[0, %llu]",
649                              key->offset, max_devid);
650                 return -EUCLEAN;
651         }
652         ditem = btrfs_item_ptr(leaf, slot, struct btrfs_dev_item);
653         if (btrfs_device_id(leaf, ditem) != key->offset) {
654                 dev_item_err(fs_info, leaf, slot,
655                              "devid mismatch: key has=%llu item has=%llu",
656                              key->offset, btrfs_device_id(leaf, ditem));
657                 return -EUCLEAN;
658         }
659
660         /*
661          * For device total_bytes, we don't have reliable way to check it, as
662          * it can be 0 for device removal. Device size check can only be done
663          * by dev extents check.
664          */
665         if (btrfs_device_bytes_used(leaf, ditem) >
666             btrfs_device_total_bytes(leaf, ditem)) {
667                 dev_item_err(fs_info, leaf, slot,
668                              "invalid bytes used: have %llu expect [0, %llu]",
669                              btrfs_device_bytes_used(leaf, ditem),
670                              btrfs_device_total_bytes(leaf, ditem));
671                 return -EUCLEAN;
672         }
673         /*
674          * Remaining members like io_align/type/gen/dev_group aren't really
675          * utilized.  Skip them to make later usage of them easier.
676          */
677         return 0;
678 }
679
680 /* Inode item error output has the same format as dir_item_err() */
681 #define inode_item_err(fs_info, eb, slot, fmt, ...)                     \
682         dir_item_err(eb, slot, fmt, __VA_ARGS__)
683
684 static int check_inode_item(struct btrfs_fs_info *fs_info,
685                             struct extent_buffer *leaf,
686                             struct btrfs_key *key, int slot)
687 {
688         struct btrfs_inode_item *iitem;
689         u64 super_gen = btrfs_super_generation(fs_info->super_copy);
690         u32 valid_mask = (S_IFMT | S_ISUID | S_ISGID | S_ISVTX | 0777);
691         u32 mode;
692
693         if ((key->objectid < BTRFS_FIRST_FREE_OBJECTID ||
694              key->objectid > BTRFS_LAST_FREE_OBJECTID) &&
695             key->objectid != BTRFS_ROOT_TREE_DIR_OBJECTID &&
696             key->objectid != BTRFS_FREE_INO_OBJECTID) {
697                 generic_err(leaf, slot,
698         "invalid key objectid: has %llu expect %llu or [%llu, %llu] or %llu",
699                             key->objectid, BTRFS_ROOT_TREE_DIR_OBJECTID,
700                             BTRFS_FIRST_FREE_OBJECTID,
701                             BTRFS_LAST_FREE_OBJECTID,
702                             BTRFS_FREE_INO_OBJECTID);
703                 return -EUCLEAN;
704         }
705         if (key->offset != 0) {
706                 inode_item_err(fs_info, leaf, slot,
707                         "invalid key offset: has %llu expect 0",
708                         key->offset);
709                 return -EUCLEAN;
710         }
711         iitem = btrfs_item_ptr(leaf, slot, struct btrfs_inode_item);
712
713         /* Here we use super block generation + 1 to handle log tree */
714         if (btrfs_inode_generation(leaf, iitem) > super_gen + 1) {
715                 inode_item_err(fs_info, leaf, slot,
716                         "invalid inode generation: has %llu expect (0, %llu]",
717                                btrfs_inode_generation(leaf, iitem),
718                                super_gen + 1);
719                 return -EUCLEAN;
720         }
721         /* Note for ROOT_TREE_DIR_ITEM, mkfs could set its transid 0 */
722         if (btrfs_inode_transid(leaf, iitem) > super_gen + 1) {
723                 inode_item_err(fs_info, leaf, slot,
724                         "invalid inode generation: has %llu expect [0, %llu]",
725                                btrfs_inode_transid(leaf, iitem), super_gen + 1);
726                 return -EUCLEAN;
727         }
728
729         /*
730          * For size and nbytes it's better not to be too strict, as for dir
731          * item its size/nbytes can easily get wrong, but doesn't affect
732          * anything in the fs. So here we skip the check.
733          */
734         mode = btrfs_inode_mode(leaf, iitem);
735         if (mode & ~valid_mask) {
736                 inode_item_err(fs_info, leaf, slot,
737                                "unknown mode bit detected: 0x%x",
738                                mode & ~valid_mask);
739                 return -EUCLEAN;
740         }
741
742         /*
743          * S_IFMT is not bit mapped so we can't completely rely on is_power_of_2,
744          * but is_power_of_2() can save us from checking FIFO/CHR/DIR/REG.
745          * Only needs to check BLK, LNK and SOCKS
746          */
747         if (!is_power_of_2(mode & S_IFMT)) {
748                 if (!S_ISLNK(mode) && !S_ISBLK(mode) && !S_ISSOCK(mode)) {
749                         inode_item_err(fs_info, leaf, slot,
750                         "invalid mode: has 0%o expect valid S_IF* bit(s)",
751                                        mode & S_IFMT);
752                         return -EUCLEAN;
753                 }
754         }
755         if (S_ISDIR(mode) && btrfs_inode_nlink(leaf, iitem) > 1) {
756                 inode_item_err(fs_info, leaf, slot,
757                        "invalid nlink: has %u expect no more than 1 for dir",
758                         btrfs_inode_nlink(leaf, iitem));
759                 return -EUCLEAN;
760         }
761         if (btrfs_inode_flags(leaf, iitem) & ~BTRFS_INODE_FLAG_MASK) {
762                 inode_item_err(fs_info, leaf, slot,
763                                "unknown flags detected: 0x%llx",
764                                btrfs_inode_flags(leaf, iitem) &
765                                ~BTRFS_INODE_FLAG_MASK);
766                 return -EUCLEAN;
767         }
768         return 0;
769 }
770
771 /*
772  * Common point to switch the item-specific validation.
773  */
774 static int check_leaf_item(struct btrfs_fs_info *fs_info,
775                            struct extent_buffer *leaf,
776                            struct btrfs_key *key, int slot)
777 {
778         int ret = 0;
779         struct btrfs_chunk *chunk;
780
781         switch (key->type) {
782         case BTRFS_EXTENT_DATA_KEY:
783                 ret = check_extent_data_item(fs_info, leaf, key, slot);
784                 break;
785         case BTRFS_EXTENT_CSUM_KEY:
786                 ret = check_csum_item(leaf, key, slot);
787                 break;
788         case BTRFS_DIR_ITEM_KEY:
789         case BTRFS_DIR_INDEX_KEY:
790         case BTRFS_XATTR_ITEM_KEY:
791                 ret = check_dir_item(leaf, key, slot);
792                 break;
793         case BTRFS_BLOCK_GROUP_ITEM_KEY:
794                 ret = check_block_group_item(leaf, key, slot);
795                 break;
796         case BTRFS_CHUNK_ITEM_KEY:
797                 chunk = btrfs_item_ptr(leaf, slot, struct btrfs_chunk);
798                 ret = btrfs_check_chunk_valid(fs_info, leaf, chunk,
799                                               key->offset);
800                 break;
801         case BTRFS_DEV_ITEM_KEY:
802                 ret = check_dev_item(fs_info, leaf, key, slot);
803                 break;
804         case BTRFS_INODE_ITEM_KEY:
805                 ret = check_inode_item(fs_info, leaf, key, slot);
806                 break;
807         }
808         return ret;
809 }
810
811 static int check_leaf(struct btrfs_fs_info *fs_info, struct extent_buffer *leaf,
812                       bool check_item_data)
813 {
814         /* No valid key type is 0, so all key should be larger than this key */
815         struct btrfs_key prev_key = {0, 0, 0};
816         struct btrfs_key key;
817         u32 nritems = btrfs_header_nritems(leaf);
818         int slot;
819
820         if (btrfs_header_level(leaf) != 0) {
821                 generic_err(leaf, 0,
822                         "invalid level for leaf, have %d expect 0",
823                         btrfs_header_level(leaf));
824                 return -EUCLEAN;
825         }
826
827         /*
828          * Extent buffers from a relocation tree have a owner field that
829          * corresponds to the subvolume tree they are based on. So just from an
830          * extent buffer alone we can not find out what is the id of the
831          * corresponding subvolume tree, so we can not figure out if the extent
832          * buffer corresponds to the root of the relocation tree or not. So
833          * skip this check for relocation trees.
834          */
835         if (nritems == 0 && !btrfs_header_flag(leaf, BTRFS_HEADER_FLAG_RELOC)) {
836                 u64 owner = btrfs_header_owner(leaf);
837                 struct btrfs_root *check_root;
838
839                 /* These trees must never be empty */
840                 if (owner == BTRFS_ROOT_TREE_OBJECTID ||
841                     owner == BTRFS_CHUNK_TREE_OBJECTID ||
842                     owner == BTRFS_EXTENT_TREE_OBJECTID ||
843                     owner == BTRFS_DEV_TREE_OBJECTID ||
844                     owner == BTRFS_FS_TREE_OBJECTID ||
845                     owner == BTRFS_DATA_RELOC_TREE_OBJECTID) {
846                         generic_err(leaf, 0,
847                         "invalid root, root %llu must never be empty",
848                                     owner);
849                         return -EUCLEAN;
850                 }
851                 key.objectid = owner;
852                 key.type = BTRFS_ROOT_ITEM_KEY;
853                 key.offset = (u64)-1;
854
855                 check_root = btrfs_get_fs_root(fs_info, &key, false);
856                 /*
857                  * The only reason we also check NULL here is that during
858                  * open_ctree() some roots has not yet been set up.
859                  */
860                 if (!IS_ERR_OR_NULL(check_root)) {
861                         struct extent_buffer *eb;
862
863                         eb = btrfs_root_node(check_root);
864                         /* if leaf is the root, then it's fine */
865                         if (leaf != eb) {
866                                 generic_err(leaf, 0,
867                 "invalid nritems, have %u should not be 0 for non-root leaf",
868                                         nritems);
869                                 free_extent_buffer(eb);
870                                 return -EUCLEAN;
871                         }
872                         free_extent_buffer(eb);
873                 }
874                 return 0;
875         }
876
877         if (nritems == 0)
878                 return 0;
879
880         /*
881          * Check the following things to make sure this is a good leaf, and
882          * leaf users won't need to bother with similar sanity checks:
883          *
884          * 1) key ordering
885          * 2) item offset and size
886          *    No overlap, no hole, all inside the leaf.
887          * 3) item content
888          *    If possible, do comprehensive sanity check.
889          *    NOTE: All checks must only rely on the item data itself.
890          */
891         for (slot = 0; slot < nritems; slot++) {
892                 u32 item_end_expected;
893                 int ret;
894
895                 btrfs_item_key_to_cpu(leaf, &key, slot);
896
897                 /* Make sure the keys are in the right order */
898                 if (btrfs_comp_cpu_keys(&prev_key, &key) >= 0) {
899                         generic_err(leaf, slot,
900         "bad key order, prev (%llu %u %llu) current (%llu %u %llu)",
901                                 prev_key.objectid, prev_key.type,
902                                 prev_key.offset, key.objectid, key.type,
903                                 key.offset);
904                         return -EUCLEAN;
905                 }
906
907                 /*
908                  * Make sure the offset and ends are right, remember that the
909                  * item data starts at the end of the leaf and grows towards the
910                  * front.
911                  */
912                 if (slot == 0)
913                         item_end_expected = BTRFS_LEAF_DATA_SIZE(fs_info);
914                 else
915                         item_end_expected = btrfs_item_offset_nr(leaf,
916                                                                  slot - 1);
917                 if (btrfs_item_end_nr(leaf, slot) != item_end_expected) {
918                         generic_err(leaf, slot,
919                                 "unexpected item end, have %u expect %u",
920                                 btrfs_item_end_nr(leaf, slot),
921                                 item_end_expected);
922                         return -EUCLEAN;
923                 }
924
925                 /*
926                  * Check to make sure that we don't point outside of the leaf,
927                  * just in case all the items are consistent to each other, but
928                  * all point outside of the leaf.
929                  */
930                 if (btrfs_item_end_nr(leaf, slot) >
931                     BTRFS_LEAF_DATA_SIZE(fs_info)) {
932                         generic_err(leaf, slot,
933                         "slot end outside of leaf, have %u expect range [0, %u]",
934                                 btrfs_item_end_nr(leaf, slot),
935                                 BTRFS_LEAF_DATA_SIZE(fs_info));
936                         return -EUCLEAN;
937                 }
938
939                 /* Also check if the item pointer overlaps with btrfs item. */
940                 if (btrfs_item_nr_offset(slot) + sizeof(struct btrfs_item) >
941                     btrfs_item_ptr_offset(leaf, slot)) {
942                         generic_err(leaf, slot,
943                 "slot overlaps with its data, item end %lu data start %lu",
944                                 btrfs_item_nr_offset(slot) +
945                                 sizeof(struct btrfs_item),
946                                 btrfs_item_ptr_offset(leaf, slot));
947                         return -EUCLEAN;
948                 }
949
950                 if (check_item_data) {
951                         /*
952                          * Check if the item size and content meet other
953                          * criteria
954                          */
955                         ret = check_leaf_item(fs_info, leaf, &key, slot);
956                         if (ret < 0)
957                                 return ret;
958                 }
959
960                 prev_key.objectid = key.objectid;
961                 prev_key.type = key.type;
962                 prev_key.offset = key.offset;
963         }
964
965         return 0;
966 }
967
968 int btrfs_check_leaf_full(struct btrfs_fs_info *fs_info,
969                           struct extent_buffer *leaf)
970 {
971         return check_leaf(fs_info, leaf, true);
972 }
973
974 int btrfs_check_leaf_relaxed(struct btrfs_fs_info *fs_info,
975                              struct extent_buffer *leaf)
976 {
977         return check_leaf(fs_info, leaf, false);
978 }
979
980 int btrfs_check_node(struct btrfs_fs_info *fs_info, struct extent_buffer *node)
981 {
982         unsigned long nr = btrfs_header_nritems(node);
983         struct btrfs_key key, next_key;
984         int slot;
985         int level = btrfs_header_level(node);
986         u64 bytenr;
987         int ret = 0;
988
989         if (level <= 0 || level >= BTRFS_MAX_LEVEL) {
990                 generic_err(node, 0,
991                         "invalid level for node, have %d expect [1, %d]",
992                         level, BTRFS_MAX_LEVEL - 1);
993                 return -EUCLEAN;
994         }
995         if (nr == 0 || nr > BTRFS_NODEPTRS_PER_BLOCK(fs_info)) {
996                 btrfs_crit(fs_info,
997 "corrupt node: root=%llu block=%llu, nritems too %s, have %lu expect range [1,%u]",
998                            btrfs_header_owner(node), node->start,
999                            nr == 0 ? "small" : "large", nr,
1000                            BTRFS_NODEPTRS_PER_BLOCK(fs_info));
1001                 return -EUCLEAN;
1002         }
1003
1004         for (slot = 0; slot < nr - 1; slot++) {
1005                 bytenr = btrfs_node_blockptr(node, slot);
1006                 btrfs_node_key_to_cpu(node, &key, slot);
1007                 btrfs_node_key_to_cpu(node, &next_key, slot + 1);
1008
1009                 if (!bytenr) {
1010                         generic_err(node, slot,
1011                                 "invalid NULL node pointer");
1012                         ret = -EUCLEAN;
1013                         goto out;
1014                 }
1015                 if (!IS_ALIGNED(bytenr, fs_info->sectorsize)) {
1016                         generic_err(node, slot,
1017                         "unaligned pointer, have %llu should be aligned to %u",
1018                                 bytenr, fs_info->sectorsize);
1019                         ret = -EUCLEAN;
1020                         goto out;
1021                 }
1022
1023                 if (btrfs_comp_cpu_keys(&key, &next_key) >= 0) {
1024                         generic_err(node, slot,
1025         "bad key order, current (%llu %u %llu) next (%llu %u %llu)",
1026                                 key.objectid, key.type, key.offset,
1027                                 next_key.objectid, next_key.type,
1028                                 next_key.offset);
1029                         ret = -EUCLEAN;
1030                         goto out;
1031                 }
1032         }
1033 out:
1034         return ret;
1035 }