xref: /linux/fs/btrfs/tree-checker.h (revision 7f71507851fc7764b36a3221839607d3a45c2025)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) Qu Wenruo 2017.  All rights reserved.
4  */
5 
6 #ifndef BTRFS_TREE_CHECKER_H
7 #define BTRFS_TREE_CHECKER_H
8 
9 #include <linux/types.h>
10 #include <uapi/linux/btrfs_tree.h>
11 
12 struct extent_buffer;
13 struct btrfs_chunk;
14 struct btrfs_key;
15 
16 /* All the extra info needed to verify the parentness of a tree block. */
17 struct btrfs_tree_parent_check {
18 	/*
19 	 * The owner check against the tree block.
20 	 *
21 	 * Can be 0 to skip the owner check.
22 	 */
23 	u64 owner_root;
24 
25 	/*
26 	 * Expected transid, can be 0 to skip the check, but such skip
27 	 * should only be utilized for backref walk related code.
28 	 */
29 	u64 transid;
30 
31 	/*
32 	 * The expected first key.
33 	 *
34 	 * This check can be skipped if @has_first_key is false, such skip
35 	 * can happen for case where we don't have the parent node key,
36 	 * e.g. reading the tree root, doing backref walk.
37 	 */
38 	struct btrfs_key first_key;
39 	bool has_first_key;
40 
41 	/* The expected level. Should always be set. */
42 	u8 level;
43 };
44 
45 enum btrfs_tree_block_status {
46 	BTRFS_TREE_BLOCK_CLEAN,
47 	BTRFS_TREE_BLOCK_INVALID_NRITEMS,
48 	BTRFS_TREE_BLOCK_INVALID_PARENT_KEY,
49 	BTRFS_TREE_BLOCK_BAD_KEY_ORDER,
50 	BTRFS_TREE_BLOCK_INVALID_LEVEL,
51 	BTRFS_TREE_BLOCK_INVALID_FREE_SPACE,
52 	BTRFS_TREE_BLOCK_INVALID_OFFSETS,
53 	BTRFS_TREE_BLOCK_INVALID_BLOCKPTR,
54 	BTRFS_TREE_BLOCK_INVALID_ITEM,
55 	BTRFS_TREE_BLOCK_INVALID_OWNER,
56 	BTRFS_TREE_BLOCK_WRITTEN_NOT_SET,
57 };
58 
59 /*
60  * Exported simply for btrfs-progs which wants to have the
61  * btrfs_tree_block_status return codes.
62  */
63 enum btrfs_tree_block_status __btrfs_check_leaf(struct extent_buffer *leaf);
64 enum btrfs_tree_block_status __btrfs_check_node(struct extent_buffer *node);
65 
66 int btrfs_check_leaf(struct extent_buffer *leaf);
67 int btrfs_check_node(struct extent_buffer *node);
68 
69 int btrfs_check_chunk_valid(struct extent_buffer *leaf,
70 			    struct btrfs_chunk *chunk, u64 logical);
71 int btrfs_check_eb_owner(const struct extent_buffer *eb, u64 root_owner);
72 int btrfs_verify_level_key(struct extent_buffer *eb,
73 			   const struct btrfs_tree_parent_check *check);
74 
75 #endif
76