19888c340SDavid Sterba /* SPDX-License-Identifier: GPL-2.0 */ 2a542ad1bSJan Schmidt /* 3a542ad1bSJan Schmidt * Copyright (C) 2011 STRATO. All rights reserved. 4a542ad1bSJan Schmidt */ 5a542ad1bSJan Schmidt 69888c340SDavid Sterba #ifndef BTRFS_BACKREF_H 79888c340SDavid Sterba #define BTRFS_BACKREF_H 8a542ad1bSJan Schmidt 955e301fdSFilipe Brandenburger #include <linux/btrfs.h> 108da6d581SJan Schmidt #include "ulist.h" 11741188d3SQu Wenruo #include "disk-io.h" 1291cb916cSAlexander Block #include "extent_io.h" 13a542ad1bSJan Schmidt 14a542ad1bSJan Schmidt struct inode_fs_paths { 15a542ad1bSJan Schmidt struct btrfs_path *btrfs_path; 16a542ad1bSJan Schmidt struct btrfs_root *fs_root; 17a542ad1bSJan Schmidt struct btrfs_data_container *fspath; 18a542ad1bSJan Schmidt }; 19a542ad1bSJan Schmidt 20a542ad1bSJan Schmidt typedef int (iterate_extent_inodes_t)(u64 inum, u64 offset, u64 root, 21a542ad1bSJan Schmidt void *ctx); 22a542ad1bSJan Schmidt 23a542ad1bSJan Schmidt int extent_from_logical(struct btrfs_fs_info *fs_info, u64 logical, 2469917e43SLiu Bo struct btrfs_path *path, struct btrfs_key *found_key, 2569917e43SLiu Bo u64 *flags); 26a542ad1bSJan Schmidt 27a542ad1bSJan Schmidt int tree_backref_for_extent(unsigned long *ptr, struct extent_buffer *eb, 286eda71d0SLiu Bo struct btrfs_key *key, struct btrfs_extent_item *ei, 296eda71d0SLiu Bo u32 item_size, u64 *out_root, u8 *out_level); 30a542ad1bSJan Schmidt 31a542ad1bSJan Schmidt int iterate_extent_inodes(struct btrfs_fs_info *fs_info, 32a542ad1bSJan Schmidt u64 extent_item_objectid, 337a3ae2f8SJan Schmidt u64 extent_offset, int search_commit_root, 34c995ab3cSZygo Blaxell iterate_extent_inodes_t *iterate, void *ctx, 35c995ab3cSZygo Blaxell bool ignore_offset); 36a542ad1bSJan Schmidt 37a542ad1bSJan Schmidt int iterate_inodes_from_logical(u64 logical, struct btrfs_fs_info *fs_info, 38a542ad1bSJan Schmidt struct btrfs_path *path, 39c995ab3cSZygo Blaxell iterate_extent_inodes_t *iterate, void *ctx, 40c995ab3cSZygo Blaxell bool ignore_offset); 41a542ad1bSJan Schmidt 42a542ad1bSJan Schmidt int paths_from_inode(u64 inum, struct inode_fs_paths *ipath); 43a542ad1bSJan Schmidt 4419b546d7SQu Wenruo int btrfs_find_all_leafs(struct btrfs_trans_handle *trans, 4519b546d7SQu Wenruo struct btrfs_fs_info *fs_info, u64 bytenr, 4619b546d7SQu Wenruo u64 time_seq, struct ulist **leafs, 4719b546d7SQu Wenruo const u64 *extent_item_pos, bool ignore_offset); 488da6d581SJan Schmidt int btrfs_find_all_roots(struct btrfs_trans_handle *trans, 498da6d581SJan Schmidt struct btrfs_fs_info *fs_info, u64 bytenr, 50*8949b9a1SFilipe Manana u64 time_seq, struct ulist **roots, bool ignore_offset, 51*8949b9a1SFilipe Manana bool skip_commit_root_sem); 5296b5bd77SJan Schmidt char *btrfs_ref_to_path(struct btrfs_root *fs_root, struct btrfs_path *path, 5396b5bd77SJan Schmidt u32 name_len, unsigned long name_off, 5496b5bd77SJan Schmidt struct extent_buffer *eb_in, u64 parent, 5596b5bd77SJan Schmidt char *dest, u32 size); 568da6d581SJan Schmidt 57a542ad1bSJan Schmidt struct btrfs_data_container *init_data_container(u32 total_bytes); 58a542ad1bSJan Schmidt struct inode_fs_paths *init_ipath(s32 total_bytes, struct btrfs_root *fs_root, 59a542ad1bSJan Schmidt struct btrfs_path *path); 60a542ad1bSJan Schmidt void free_ipath(struct inode_fs_paths *ipath); 61a542ad1bSJan Schmidt 62f186373fSMark Fasheh int btrfs_find_one_extref(struct btrfs_root *root, u64 inode_objectid, 63f186373fSMark Fasheh u64 start_off, struct btrfs_path *path, 64f186373fSMark Fasheh struct btrfs_inode_extref **ret_extref, 65f186373fSMark Fasheh u64 *found_off); 665911c8feSDavid Sterba int btrfs_check_shared(struct btrfs_root *root, u64 inum, u64 bytenr, 675911c8feSDavid Sterba struct ulist *roots, struct ulist *tmp_ulist); 68f186373fSMark Fasheh 69b9e9a6cbSWang Shilong int __init btrfs_prelim_ref_init(void); 70e67c718bSDavid Sterba void __cold btrfs_prelim_ref_exit(void); 7100142756SJeff Mahoney 7200142756SJeff Mahoney struct prelim_ref { 7300142756SJeff Mahoney struct rb_node rbnode; 7400142756SJeff Mahoney u64 root_id; 7500142756SJeff Mahoney struct btrfs_key key_for_search; 7600142756SJeff Mahoney int level; 7700142756SJeff Mahoney int count; 7800142756SJeff Mahoney struct extent_inode_elem *inode_list; 7900142756SJeff Mahoney u64 parent; 8000142756SJeff Mahoney u64 wanted_disk_byte; 8100142756SJeff Mahoney }; 8200142756SJeff Mahoney 83a37f232bSQu Wenruo /* 84a37f232bSQu Wenruo * Iterate backrefs of one extent. 85a37f232bSQu Wenruo * 86a37f232bSQu Wenruo * Now it only supports iteration of tree block in commit root. 87a37f232bSQu Wenruo */ 88a37f232bSQu Wenruo struct btrfs_backref_iter { 89a37f232bSQu Wenruo u64 bytenr; 90a37f232bSQu Wenruo struct btrfs_path *path; 91a37f232bSQu Wenruo struct btrfs_fs_info *fs_info; 92a37f232bSQu Wenruo struct btrfs_key cur_key; 93a37f232bSQu Wenruo u32 item_ptr; 94a37f232bSQu Wenruo u32 cur_ptr; 95a37f232bSQu Wenruo u32 end_ptr; 96a37f232bSQu Wenruo }; 97a37f232bSQu Wenruo 98a37f232bSQu Wenruo struct btrfs_backref_iter *btrfs_backref_iter_alloc( 99a37f232bSQu Wenruo struct btrfs_fs_info *fs_info, gfp_t gfp_flag); 100a37f232bSQu Wenruo 101a37f232bSQu Wenruo static inline void btrfs_backref_iter_free(struct btrfs_backref_iter *iter) 102a37f232bSQu Wenruo { 103a37f232bSQu Wenruo if (!iter) 104a37f232bSQu Wenruo return; 105a37f232bSQu Wenruo btrfs_free_path(iter->path); 106a37f232bSQu Wenruo kfree(iter); 107a37f232bSQu Wenruo } 108a37f232bSQu Wenruo 109c39c2ddcSQu Wenruo static inline struct extent_buffer *btrfs_backref_get_eb( 110c39c2ddcSQu Wenruo struct btrfs_backref_iter *iter) 111c39c2ddcSQu Wenruo { 112c39c2ddcSQu Wenruo if (!iter) 113c39c2ddcSQu Wenruo return NULL; 114c39c2ddcSQu Wenruo return iter->path->nodes[0]; 115c39c2ddcSQu Wenruo } 116c39c2ddcSQu Wenruo 117c39c2ddcSQu Wenruo /* 118c39c2ddcSQu Wenruo * For metadata with EXTENT_ITEM key (non-skinny) case, the first inline data 119c39c2ddcSQu Wenruo * is btrfs_tree_block_info, without a btrfs_extent_inline_ref header. 120c39c2ddcSQu Wenruo * 121c39c2ddcSQu Wenruo * This helper determines if that's the case. 122c39c2ddcSQu Wenruo */ 123c39c2ddcSQu Wenruo static inline bool btrfs_backref_has_tree_block_info( 124c39c2ddcSQu Wenruo struct btrfs_backref_iter *iter) 125c39c2ddcSQu Wenruo { 126c39c2ddcSQu Wenruo if (iter->cur_key.type == BTRFS_EXTENT_ITEM_KEY && 127c39c2ddcSQu Wenruo iter->cur_ptr - iter->item_ptr == sizeof(struct btrfs_extent_item)) 128c39c2ddcSQu Wenruo return true; 129c39c2ddcSQu Wenruo return false; 130c39c2ddcSQu Wenruo } 131c39c2ddcSQu Wenruo 132a37f232bSQu Wenruo int btrfs_backref_iter_start(struct btrfs_backref_iter *iter, u64 bytenr); 133a37f232bSQu Wenruo 134c39c2ddcSQu Wenruo int btrfs_backref_iter_next(struct btrfs_backref_iter *iter); 135c39c2ddcSQu Wenruo 136c39c2ddcSQu Wenruo static inline bool btrfs_backref_iter_is_inline_ref( 137c39c2ddcSQu Wenruo struct btrfs_backref_iter *iter) 138c39c2ddcSQu Wenruo { 139c39c2ddcSQu Wenruo if (iter->cur_key.type == BTRFS_EXTENT_ITEM_KEY || 140c39c2ddcSQu Wenruo iter->cur_key.type == BTRFS_METADATA_ITEM_KEY) 141c39c2ddcSQu Wenruo return true; 142c39c2ddcSQu Wenruo return false; 143c39c2ddcSQu Wenruo } 144c39c2ddcSQu Wenruo 145a37f232bSQu Wenruo static inline void btrfs_backref_iter_release(struct btrfs_backref_iter *iter) 146a37f232bSQu Wenruo { 147a37f232bSQu Wenruo iter->bytenr = 0; 148a37f232bSQu Wenruo iter->item_ptr = 0; 149a37f232bSQu Wenruo iter->cur_ptr = 0; 150a37f232bSQu Wenruo iter->end_ptr = 0; 151a37f232bSQu Wenruo btrfs_release_path(iter->path); 152a37f232bSQu Wenruo memset(&iter->cur_key, 0, sizeof(iter->cur_key)); 153a37f232bSQu Wenruo } 154a37f232bSQu Wenruo 15570535441SQu Wenruo /* 15670535441SQu Wenruo * Backref cache related structures 15770535441SQu Wenruo * 15870535441SQu Wenruo * The whole objective of backref_cache is to build a bi-directional map 15970535441SQu Wenruo * of tree blocks (represented by backref_node) and all their parents. 16070535441SQu Wenruo */ 16170535441SQu Wenruo 16270535441SQu Wenruo /* 16370535441SQu Wenruo * Represent a tree block in the backref cache 16470535441SQu Wenruo */ 16570535441SQu Wenruo struct btrfs_backref_node { 166e9a28dc5SQu Wenruo struct { 16770535441SQu Wenruo struct rb_node rb_node; 16870535441SQu Wenruo u64 bytenr; 169e9a28dc5SQu Wenruo }; /* Use rb_simple_node for search/insert */ 17070535441SQu Wenruo 17170535441SQu Wenruo u64 new_bytenr; 17270535441SQu Wenruo /* Objectid of tree block owner, can be not uptodate */ 17370535441SQu Wenruo u64 owner; 17470535441SQu Wenruo /* Link to pending, changed or detached list */ 17570535441SQu Wenruo struct list_head list; 17670535441SQu Wenruo 17770535441SQu Wenruo /* List of upper level edges, which link this node to its parents */ 17870535441SQu Wenruo struct list_head upper; 17970535441SQu Wenruo /* List of lower level edges, which link this node to its children */ 18070535441SQu Wenruo struct list_head lower; 18170535441SQu Wenruo 18270535441SQu Wenruo /* NULL if this node is not tree root */ 18370535441SQu Wenruo struct btrfs_root *root; 18470535441SQu Wenruo /* Extent buffer got by COWing the block */ 18570535441SQu Wenruo struct extent_buffer *eb; 18670535441SQu Wenruo /* Level of the tree block */ 18770535441SQu Wenruo unsigned int level:8; 18892a7cc42SQu Wenruo /* Is the block in a non-shareable tree */ 18970535441SQu Wenruo unsigned int cowonly:1; 19070535441SQu Wenruo /* 1 if no child node is in the cache */ 19170535441SQu Wenruo unsigned int lowest:1; 19270535441SQu Wenruo /* Is the extent buffer locked */ 19370535441SQu Wenruo unsigned int locked:1; 19470535441SQu Wenruo /* Has the block been processed */ 19570535441SQu Wenruo unsigned int processed:1; 19670535441SQu Wenruo /* Have backrefs of this block been checked */ 19770535441SQu Wenruo unsigned int checked:1; 19870535441SQu Wenruo /* 19970535441SQu Wenruo * 1 if corresponding block has been COWed but some upper level block 20070535441SQu Wenruo * pointers may not point to the new location 20170535441SQu Wenruo */ 20270535441SQu Wenruo unsigned int pending:1; 20370535441SQu Wenruo /* 1 if the backref node isn't connected to any other backref node */ 20470535441SQu Wenruo unsigned int detached:1; 20570535441SQu Wenruo 20670535441SQu Wenruo /* 20770535441SQu Wenruo * For generic purpose backref cache, where we only care if it's a reloc 20870535441SQu Wenruo * root, doesn't care the source subvolid. 20970535441SQu Wenruo */ 21070535441SQu Wenruo unsigned int is_reloc_root:1; 21170535441SQu Wenruo }; 21270535441SQu Wenruo 21370535441SQu Wenruo #define LOWER 0 21470535441SQu Wenruo #define UPPER 1 21570535441SQu Wenruo 21670535441SQu Wenruo /* 21770535441SQu Wenruo * Represent an edge connecting upper and lower backref nodes. 21870535441SQu Wenruo */ 21970535441SQu Wenruo struct btrfs_backref_edge { 22070535441SQu Wenruo /* 22170535441SQu Wenruo * list[LOWER] is linked to btrfs_backref_node::upper of lower level 22270535441SQu Wenruo * node, and list[UPPER] is linked to btrfs_backref_node::lower of 22370535441SQu Wenruo * upper level node. 22470535441SQu Wenruo * 22570535441SQu Wenruo * Also, build_backref_tree() uses list[UPPER] for pending edges, before 22670535441SQu Wenruo * linking list[UPPER] to its upper level nodes. 22770535441SQu Wenruo */ 22870535441SQu Wenruo struct list_head list[2]; 22970535441SQu Wenruo 23070535441SQu Wenruo /* Two related nodes */ 23170535441SQu Wenruo struct btrfs_backref_node *node[2]; 23270535441SQu Wenruo }; 23370535441SQu Wenruo 23470535441SQu Wenruo struct btrfs_backref_cache { 23570535441SQu Wenruo /* Red black tree of all backref nodes in the cache */ 23670535441SQu Wenruo struct rb_root rb_root; 23770535441SQu Wenruo /* For passing backref nodes to btrfs_reloc_cow_block */ 23870535441SQu Wenruo struct btrfs_backref_node *path[BTRFS_MAX_LEVEL]; 23970535441SQu Wenruo /* 24070535441SQu Wenruo * List of blocks that have been COWed but some block pointers in upper 24170535441SQu Wenruo * level blocks may not reflect the new location 24270535441SQu Wenruo */ 24370535441SQu Wenruo struct list_head pending[BTRFS_MAX_LEVEL]; 24470535441SQu Wenruo /* List of backref nodes with no child node */ 24570535441SQu Wenruo struct list_head leaves; 24670535441SQu Wenruo /* List of blocks that have been COWed in current transaction */ 24770535441SQu Wenruo struct list_head changed; 24870535441SQu Wenruo /* List of detached backref node. */ 24970535441SQu Wenruo struct list_head detached; 25070535441SQu Wenruo 25170535441SQu Wenruo u64 last_trans; 25270535441SQu Wenruo 25370535441SQu Wenruo int nr_nodes; 25470535441SQu Wenruo int nr_edges; 25570535441SQu Wenruo 25670535441SQu Wenruo /* List of unchecked backref edges during backref cache build */ 25770535441SQu Wenruo struct list_head pending_edge; 25870535441SQu Wenruo 25970535441SQu Wenruo /* List of useless backref nodes during backref cache build */ 26070535441SQu Wenruo struct list_head useless_node; 26170535441SQu Wenruo 26270535441SQu Wenruo struct btrfs_fs_info *fs_info; 26370535441SQu Wenruo 26470535441SQu Wenruo /* 26570535441SQu Wenruo * Whether this cache is for relocation 26670535441SQu Wenruo * 26770535441SQu Wenruo * Reloction backref cache require more info for reloc root compared 26870535441SQu Wenruo * to generic backref cache. 26970535441SQu Wenruo */ 27070535441SQu Wenruo unsigned int is_reloc; 27170535441SQu Wenruo }; 27270535441SQu Wenruo 273584fb121SQu Wenruo void btrfs_backref_init_cache(struct btrfs_fs_info *fs_info, 274584fb121SQu Wenruo struct btrfs_backref_cache *cache, int is_reloc); 275b1818dabSQu Wenruo struct btrfs_backref_node *btrfs_backref_alloc_node( 276b1818dabSQu Wenruo struct btrfs_backref_cache *cache, u64 bytenr, int level); 27747254d07SQu Wenruo struct btrfs_backref_edge *btrfs_backref_alloc_edge( 27847254d07SQu Wenruo struct btrfs_backref_cache *cache); 279584fb121SQu Wenruo 280f39911e5SQu Wenruo #define LINK_LOWER (1 << 0) 281f39911e5SQu Wenruo #define LINK_UPPER (1 << 1) 282f39911e5SQu Wenruo static inline void btrfs_backref_link_edge(struct btrfs_backref_edge *edge, 283f39911e5SQu Wenruo struct btrfs_backref_node *lower, 284f39911e5SQu Wenruo struct btrfs_backref_node *upper, 285f39911e5SQu Wenruo int link_which) 286f39911e5SQu Wenruo { 287f39911e5SQu Wenruo ASSERT(upper && lower && upper->level == lower->level + 1); 288f39911e5SQu Wenruo edge->node[LOWER] = lower; 289f39911e5SQu Wenruo edge->node[UPPER] = upper; 290f39911e5SQu Wenruo if (link_which & LINK_LOWER) 291f39911e5SQu Wenruo list_add_tail(&edge->list[LOWER], &lower->upper); 292f39911e5SQu Wenruo if (link_which & LINK_UPPER) 293f39911e5SQu Wenruo list_add_tail(&edge->list[UPPER], &upper->lower); 294f39911e5SQu Wenruo } 295f39911e5SQu Wenruo 296741188d3SQu Wenruo static inline void btrfs_backref_free_node(struct btrfs_backref_cache *cache, 297741188d3SQu Wenruo struct btrfs_backref_node *node) 298741188d3SQu Wenruo { 299741188d3SQu Wenruo if (node) { 300eddda68dSJosef Bacik ASSERT(list_empty(&node->list)); 301eddda68dSJosef Bacik ASSERT(list_empty(&node->lower)); 302eddda68dSJosef Bacik ASSERT(node->eb == NULL); 303741188d3SQu Wenruo cache->nr_nodes--; 304741188d3SQu Wenruo btrfs_put_root(node->root); 305741188d3SQu Wenruo kfree(node); 306741188d3SQu Wenruo } 307741188d3SQu Wenruo } 308741188d3SQu Wenruo 309741188d3SQu Wenruo static inline void btrfs_backref_free_edge(struct btrfs_backref_cache *cache, 310741188d3SQu Wenruo struct btrfs_backref_edge *edge) 311741188d3SQu Wenruo { 312741188d3SQu Wenruo if (edge) { 313741188d3SQu Wenruo cache->nr_edges--; 314741188d3SQu Wenruo kfree(edge); 315741188d3SQu Wenruo } 316741188d3SQu Wenruo } 317741188d3SQu Wenruo 318b0fe7078SQu Wenruo static inline void btrfs_backref_unlock_node_buffer( 319b0fe7078SQu Wenruo struct btrfs_backref_node *node) 320b0fe7078SQu Wenruo { 321b0fe7078SQu Wenruo if (node->locked) { 322b0fe7078SQu Wenruo btrfs_tree_unlock(node->eb); 323b0fe7078SQu Wenruo node->locked = 0; 324b0fe7078SQu Wenruo } 325b0fe7078SQu Wenruo } 326b0fe7078SQu Wenruo 327b0fe7078SQu Wenruo static inline void btrfs_backref_drop_node_buffer( 328b0fe7078SQu Wenruo struct btrfs_backref_node *node) 329b0fe7078SQu Wenruo { 330b0fe7078SQu Wenruo if (node->eb) { 331b0fe7078SQu Wenruo btrfs_backref_unlock_node_buffer(node); 332b0fe7078SQu Wenruo free_extent_buffer(node->eb); 333b0fe7078SQu Wenruo node->eb = NULL; 334b0fe7078SQu Wenruo } 335b0fe7078SQu Wenruo } 336b0fe7078SQu Wenruo 337b0fe7078SQu Wenruo /* 338b0fe7078SQu Wenruo * Drop the backref node from cache without cleaning up its children 339b0fe7078SQu Wenruo * edges. 340b0fe7078SQu Wenruo * 341b0fe7078SQu Wenruo * This can only be called on node without parent edges. 342b0fe7078SQu Wenruo * The children edges are still kept as is. 343b0fe7078SQu Wenruo */ 344b0fe7078SQu Wenruo static inline void btrfs_backref_drop_node(struct btrfs_backref_cache *tree, 345b0fe7078SQu Wenruo struct btrfs_backref_node *node) 346b0fe7078SQu Wenruo { 347eddda68dSJosef Bacik ASSERT(list_empty(&node->upper)); 348b0fe7078SQu Wenruo 349b0fe7078SQu Wenruo btrfs_backref_drop_node_buffer(node); 350eddda68dSJosef Bacik list_del_init(&node->list); 351eddda68dSJosef Bacik list_del_init(&node->lower); 352b0fe7078SQu Wenruo if (!RB_EMPTY_NODE(&node->rb_node)) 353b0fe7078SQu Wenruo rb_erase(&node->rb_node, &tree->rb_root); 354b0fe7078SQu Wenruo btrfs_backref_free_node(tree, node); 355b0fe7078SQu Wenruo } 356b0fe7078SQu Wenruo 357023acb07SQu Wenruo void btrfs_backref_cleanup_node(struct btrfs_backref_cache *cache, 358023acb07SQu Wenruo struct btrfs_backref_node *node); 359023acb07SQu Wenruo 36013fe1bdbSQu Wenruo void btrfs_backref_release_cache(struct btrfs_backref_cache *cache); 36113fe1bdbSQu Wenruo 362982c92cbSQu Wenruo static inline void btrfs_backref_panic(struct btrfs_fs_info *fs_info, 363982c92cbSQu Wenruo u64 bytenr, int errno) 364982c92cbSQu Wenruo { 365982c92cbSQu Wenruo btrfs_panic(fs_info, errno, 366982c92cbSQu Wenruo "Inconsistency in backref cache found at offset %llu", 367982c92cbSQu Wenruo bytenr); 368982c92cbSQu Wenruo } 369982c92cbSQu Wenruo 3701b60d2ecSQu Wenruo int btrfs_backref_add_tree_node(struct btrfs_backref_cache *cache, 3711b60d2ecSQu Wenruo struct btrfs_path *path, 3721b60d2ecSQu Wenruo struct btrfs_backref_iter *iter, 3731b60d2ecSQu Wenruo struct btrfs_key *node_key, 3741b60d2ecSQu Wenruo struct btrfs_backref_node *cur); 3751b60d2ecSQu Wenruo 376fc997ed0SQu Wenruo int btrfs_backref_finish_upper_links(struct btrfs_backref_cache *cache, 377fc997ed0SQu Wenruo struct btrfs_backref_node *start); 378fc997ed0SQu Wenruo 3791b23ea18SQu Wenruo void btrfs_backref_error_cleanup(struct btrfs_backref_cache *cache, 3801b23ea18SQu Wenruo struct btrfs_backref_node *node); 3811b23ea18SQu Wenruo 382a542ad1bSJan Schmidt #endif 383