2 * Copyright (C) 2011 STRATO. All rights reserved.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public
6 * License v2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public
14 * License along with this program; if not, write to the
15 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 * Boston, MA 021110-1307, USA.
19 #include <linux/vmalloc.h>
24 #include "transaction.h"
25 #include "delayed-ref.h"
28 struct extent_inode_elem {
31 struct extent_inode_elem *next;
34 static int check_extent_in_eb(struct btrfs_key *key, struct extent_buffer *eb,
35 struct btrfs_file_extent_item *fi,
37 struct extent_inode_elem **eie)
41 struct extent_inode_elem *e;
43 data_offset = btrfs_file_extent_offset(eb, fi);
44 data_len = btrfs_file_extent_num_bytes(eb, fi);
46 if (extent_item_pos < data_offset ||
47 extent_item_pos >= data_offset + data_len)
50 e = kmalloc(sizeof(*e), GFP_NOFS);
55 e->inum = key->objectid;
56 e->offset = key->offset + (extent_item_pos - data_offset);
62 static int find_extent_in_eb(struct extent_buffer *eb, u64 wanted_disk_byte,
64 struct extent_inode_elem **eie)
68 struct btrfs_file_extent_item *fi;
75 * from the shared data ref, we only have the leaf but we need
76 * the key. thus, we must look into all items and see that we
77 * find one (some) with a reference to our extent item.
79 nritems = btrfs_header_nritems(eb);
80 for (slot = 0; slot < nritems; ++slot) {
81 btrfs_item_key_to_cpu(eb, &key, slot);
82 if (key.type != BTRFS_EXTENT_DATA_KEY)
84 fi = btrfs_item_ptr(eb, slot, struct btrfs_file_extent_item);
85 extent_type = btrfs_file_extent_type(eb, fi);
86 if (extent_type == BTRFS_FILE_EXTENT_INLINE)
88 /* don't skip BTRFS_FILE_EXTENT_PREALLOC, we can handle that */
89 disk_byte = btrfs_file_extent_disk_bytenr(eb, fi);
90 if (disk_byte != wanted_disk_byte)
93 ret = check_extent_in_eb(&key, eb, fi, extent_item_pos, eie);
102 * this structure records all encountered refs on the way up to the root
104 struct __prelim_ref {
105 struct list_head list;
107 struct btrfs_key key_for_search;
110 struct extent_inode_elem *inode_list;
112 u64 wanted_disk_byte;
116 * the rules for all callers of this function are:
117 * - obtaining the parent is the goal
118 * - if you add a key, you must know that it is a correct key
119 * - if you cannot add the parent or a correct key, then we will look into the
120 * block later to set a correct key
124 * backref type | shared | indirect | shared | indirect
125 * information | tree | tree | data | data
126 * --------------------+--------+----------+--------+----------
127 * parent logical | y | - | - | -
128 * key to resolve | - | y | y | y
129 * tree block logical | - | - | - | -
130 * root for resolving | y | y | y | y
132 * - column 1: we've the parent -> done
133 * - column 2, 3, 4: we use the key to find the parent
135 * on disk refs (inline or keyed)
136 * ==============================
137 * backref type | shared | indirect | shared | indirect
138 * information | tree | tree | data | data
139 * --------------------+--------+----------+--------+----------
140 * parent logical | y | - | y | -
141 * key to resolve | - | - | - | y
142 * tree block logical | y | y | y | y
143 * root for resolving | - | y | y | y
145 * - column 1, 3: we've the parent -> done
146 * - column 2: we take the first key from the block to find the parent
147 * (see __add_missing_keys)
148 * - column 4: we use the key to find the parent
150 * additional information that's available but not required to find the parent
151 * block might help in merging entries to gain some speed.
154 static int __add_prelim_ref(struct list_head *head, u64 root_id,
155 struct btrfs_key *key, int level,
156 u64 parent, u64 wanted_disk_byte, int count)
158 struct __prelim_ref *ref;
160 /* in case we're adding delayed refs, we're holding the refs spinlock */
161 ref = kmalloc(sizeof(*ref), GFP_ATOMIC);
165 ref->root_id = root_id;
167 ref->key_for_search = *key;
169 memset(&ref->key_for_search, 0, sizeof(ref->key_for_search));
171 ref->inode_list = NULL;
174 ref->parent = parent;
175 ref->wanted_disk_byte = wanted_disk_byte;
176 list_add_tail(&ref->list, head);
181 static int add_all_parents(struct btrfs_root *root, struct btrfs_path *path,
182 struct ulist *parents, int level,
183 struct btrfs_key *key_for_search, u64 time_seq,
184 u64 wanted_disk_byte,
185 const u64 *extent_item_pos)
189 struct extent_buffer *eb;
190 struct btrfs_key key;
191 struct btrfs_file_extent_item *fi;
192 struct extent_inode_elem *eie = NULL;
196 eb = path->nodes[level];
197 ret = ulist_add(parents, eb->start, 0, GFP_NOFS);
204 * We normally enter this function with the path already pointing to
205 * the first item to check. But sometimes, we may enter it with
206 * slot==nritems. In that case, go to the next leaf before we continue.
208 if (path->slots[0] >= btrfs_header_nritems(path->nodes[0]))
209 ret = btrfs_next_old_leaf(root, path, time_seq);
213 slot = path->slots[0];
215 btrfs_item_key_to_cpu(eb, &key, slot);
217 if (key.objectid != key_for_search->objectid ||
218 key.type != BTRFS_EXTENT_DATA_KEY)
221 fi = btrfs_item_ptr(eb, slot, struct btrfs_file_extent_item);
222 disk_byte = btrfs_file_extent_disk_bytenr(eb, fi);
224 if (disk_byte == wanted_disk_byte) {
226 if (extent_item_pos) {
227 ret = check_extent_in_eb(&key, eb, fi,
234 ret = ulist_add(parents, eb->start,
235 (uintptr_t)eie, GFP_NOFS);
238 if (!extent_item_pos) {
239 ret = btrfs_next_old_leaf(root, path,
245 ret = btrfs_next_old_item(root, path, time_seq);
254 * resolve an indirect backref in the form (root_id, key, level)
255 * to a logical address
257 static int __resolve_indirect_ref(struct btrfs_fs_info *fs_info,
258 int search_commit_root,
260 struct __prelim_ref *ref,
261 struct ulist *parents,
262 const u64 *extent_item_pos)
264 struct btrfs_path *path;
265 struct btrfs_root *root;
266 struct btrfs_key root_key;
267 struct extent_buffer *eb;
270 int level = ref->level;
272 path = btrfs_alloc_path();
275 path->search_commit_root = !!search_commit_root;
277 root_key.objectid = ref->root_id;
278 root_key.type = BTRFS_ROOT_ITEM_KEY;
279 root_key.offset = (u64)-1;
280 root = btrfs_read_fs_root_no_name(fs_info, &root_key);
286 root_level = btrfs_old_root_level(root, time_seq);
288 if (root_level + 1 == level)
291 path->lowest_level = level;
292 ret = btrfs_search_old_slot(root, &ref->key_for_search, path, time_seq);
293 pr_debug("search slot in root %llu (level %d, ref count %d) returned "
294 "%d for key (%llu %u %llu)\n",
295 (unsigned long long)ref->root_id, level, ref->count, ret,
296 (unsigned long long)ref->key_for_search.objectid,
297 ref->key_for_search.type,
298 (unsigned long long)ref->key_for_search.offset);
302 eb = path->nodes[level];
310 eb = path->nodes[level];
313 ret = add_all_parents(root, path, parents, level, &ref->key_for_search,
314 time_seq, ref->wanted_disk_byte,
317 btrfs_free_path(path);
322 * resolve all indirect backrefs from the list
324 static int __resolve_indirect_refs(struct btrfs_fs_info *fs_info,
325 int search_commit_root, u64 time_seq,
326 struct list_head *head,
327 const u64 *extent_item_pos)
331 struct __prelim_ref *ref;
332 struct __prelim_ref *ref_safe;
333 struct __prelim_ref *new_ref;
334 struct ulist *parents;
335 struct ulist_node *node;
336 struct ulist_iterator uiter;
338 parents = ulist_alloc(GFP_NOFS);
343 * _safe allows us to insert directly after the current item without
344 * iterating over the newly inserted items.
345 * we're also allowed to re-assign ref during iteration.
347 list_for_each_entry_safe(ref, ref_safe, head, list) {
348 if (ref->parent) /* already direct */
352 err = __resolve_indirect_ref(fs_info, search_commit_root,
353 time_seq, ref, parents,
360 /* we put the first parent into the ref at hand */
361 ULIST_ITER_INIT(&uiter);
362 node = ulist_next(parents, &uiter);
363 ref->parent = node ? node->val : 0;
364 ref->inode_list = node ?
365 (struct extent_inode_elem *)(uintptr_t)node->aux : 0;
367 /* additional parents require new refs being added here */
368 while ((node = ulist_next(parents, &uiter))) {
369 new_ref = kmalloc(sizeof(*new_ref), GFP_NOFS);
374 memcpy(new_ref, ref, sizeof(*ref));
375 new_ref->parent = node->val;
376 new_ref->inode_list = (struct extent_inode_elem *)
377 (uintptr_t)node->aux;
378 list_add(&new_ref->list, &ref->list);
380 ulist_reinit(parents);
387 static inline int ref_for_same_block(struct __prelim_ref *ref1,
388 struct __prelim_ref *ref2)
390 if (ref1->level != ref2->level)
392 if (ref1->root_id != ref2->root_id)
394 if (ref1->key_for_search.type != ref2->key_for_search.type)
396 if (ref1->key_for_search.objectid != ref2->key_for_search.objectid)
398 if (ref1->key_for_search.offset != ref2->key_for_search.offset)
400 if (ref1->parent != ref2->parent)
407 * read tree blocks and add keys where required.
409 static int __add_missing_keys(struct btrfs_fs_info *fs_info,
410 struct list_head *head)
412 struct list_head *pos;
413 struct extent_buffer *eb;
415 list_for_each(pos, head) {
416 struct __prelim_ref *ref;
417 ref = list_entry(pos, struct __prelim_ref, list);
421 if (ref->key_for_search.type)
423 BUG_ON(!ref->wanted_disk_byte);
424 eb = read_tree_block(fs_info->tree_root, ref->wanted_disk_byte,
425 fs_info->tree_root->leafsize, 0);
426 if (!eb || !extent_buffer_uptodate(eb)) {
427 free_extent_buffer(eb);
430 btrfs_tree_read_lock(eb);
431 if (btrfs_header_level(eb) == 0)
432 btrfs_item_key_to_cpu(eb, &ref->key_for_search, 0);
434 btrfs_node_key_to_cpu(eb, &ref->key_for_search, 0);
435 btrfs_tree_read_unlock(eb);
436 free_extent_buffer(eb);
442 * merge two lists of backrefs and adjust counts accordingly
444 * mode = 1: merge identical keys, if key is set
445 * FIXME: if we add more keys in __add_prelim_ref, we can merge more here.
446 * additionally, we could even add a key range for the blocks we
447 * looked into to merge even more (-> replace unresolved refs by those
449 * mode = 2: merge identical parents
451 static void __merge_refs(struct list_head *head, int mode)
453 struct list_head *pos1;
455 list_for_each(pos1, head) {
456 struct list_head *n2;
457 struct list_head *pos2;
458 struct __prelim_ref *ref1;
460 ref1 = list_entry(pos1, struct __prelim_ref, list);
462 for (pos2 = pos1->next, n2 = pos2->next; pos2 != head;
463 pos2 = n2, n2 = pos2->next) {
464 struct __prelim_ref *ref2;
465 struct __prelim_ref *xchg;
466 struct extent_inode_elem *eie;
468 ref2 = list_entry(pos2, struct __prelim_ref, list);
471 if (!ref_for_same_block(ref1, ref2))
473 if (!ref1->parent && ref2->parent) {
479 if (ref1->parent != ref2->parent)
483 eie = ref1->inode_list;
484 while (eie && eie->next)
487 eie->next = ref2->inode_list;
489 ref1->inode_list = ref2->inode_list;
490 ref1->count += ref2->count;
492 list_del(&ref2->list);
500 * add all currently queued delayed refs from this head whose seq nr is
501 * smaller or equal that seq to the list
503 static int __add_delayed_refs(struct btrfs_delayed_ref_head *head, u64 seq,
504 struct list_head *prefs)
506 struct btrfs_delayed_extent_op *extent_op = head->extent_op;
507 struct rb_node *n = &head->node.rb_node;
508 struct btrfs_key key;
509 struct btrfs_key op_key = {0};
513 if (extent_op && extent_op->update_key)
514 btrfs_disk_key_to_cpu(&op_key, &extent_op->key);
516 while ((n = rb_prev(n))) {
517 struct btrfs_delayed_ref_node *node;
518 node = rb_entry(n, struct btrfs_delayed_ref_node,
520 if (node->bytenr != head->node.bytenr)
522 WARN_ON(node->is_head);
527 switch (node->action) {
528 case BTRFS_ADD_DELAYED_EXTENT:
529 case BTRFS_UPDATE_DELAYED_HEAD:
532 case BTRFS_ADD_DELAYED_REF:
535 case BTRFS_DROP_DELAYED_REF:
541 switch (node->type) {
542 case BTRFS_TREE_BLOCK_REF_KEY: {
543 struct btrfs_delayed_tree_ref *ref;
545 ref = btrfs_delayed_node_to_tree_ref(node);
546 ret = __add_prelim_ref(prefs, ref->root, &op_key,
547 ref->level + 1, 0, node->bytenr,
548 node->ref_mod * sgn);
551 case BTRFS_SHARED_BLOCK_REF_KEY: {
552 struct btrfs_delayed_tree_ref *ref;
554 ref = btrfs_delayed_node_to_tree_ref(node);
555 ret = __add_prelim_ref(prefs, ref->root, NULL,
556 ref->level + 1, ref->parent,
558 node->ref_mod * sgn);
561 case BTRFS_EXTENT_DATA_REF_KEY: {
562 struct btrfs_delayed_data_ref *ref;
563 ref = btrfs_delayed_node_to_data_ref(node);
565 key.objectid = ref->objectid;
566 key.type = BTRFS_EXTENT_DATA_KEY;
567 key.offset = ref->offset;
568 ret = __add_prelim_ref(prefs, ref->root, &key, 0, 0,
570 node->ref_mod * sgn);
573 case BTRFS_SHARED_DATA_REF_KEY: {
574 struct btrfs_delayed_data_ref *ref;
576 ref = btrfs_delayed_node_to_data_ref(node);
578 key.objectid = ref->objectid;
579 key.type = BTRFS_EXTENT_DATA_KEY;
580 key.offset = ref->offset;
581 ret = __add_prelim_ref(prefs, ref->root, &key, 0,
582 ref->parent, node->bytenr,
583 node->ref_mod * sgn);
597 * add all inline backrefs for bytenr to the list
599 static int __add_inline_refs(struct btrfs_fs_info *fs_info,
600 struct btrfs_path *path, u64 bytenr,
601 int *info_level, struct list_head *prefs)
605 struct extent_buffer *leaf;
606 struct btrfs_key key;
609 struct btrfs_extent_item *ei;
614 * enumerate all inline refs
616 leaf = path->nodes[0];
617 slot = path->slots[0];
619 item_size = btrfs_item_size_nr(leaf, slot);
620 BUG_ON(item_size < sizeof(*ei));
622 ei = btrfs_item_ptr(leaf, slot, struct btrfs_extent_item);
623 flags = btrfs_extent_flags(leaf, ei);
625 ptr = (unsigned long)(ei + 1);
626 end = (unsigned long)ei + item_size;
628 if (flags & BTRFS_EXTENT_FLAG_TREE_BLOCK) {
629 struct btrfs_tree_block_info *info;
631 info = (struct btrfs_tree_block_info *)ptr;
632 *info_level = btrfs_tree_block_level(leaf, info);
633 ptr += sizeof(struct btrfs_tree_block_info);
636 BUG_ON(!(flags & BTRFS_EXTENT_FLAG_DATA));
640 struct btrfs_extent_inline_ref *iref;
644 iref = (struct btrfs_extent_inline_ref *)ptr;
645 type = btrfs_extent_inline_ref_type(leaf, iref);
646 offset = btrfs_extent_inline_ref_offset(leaf, iref);
649 case BTRFS_SHARED_BLOCK_REF_KEY:
650 ret = __add_prelim_ref(prefs, 0, NULL,
651 *info_level + 1, offset,
654 case BTRFS_SHARED_DATA_REF_KEY: {
655 struct btrfs_shared_data_ref *sdref;
658 sdref = (struct btrfs_shared_data_ref *)(iref + 1);
659 count = btrfs_shared_data_ref_count(leaf, sdref);
660 ret = __add_prelim_ref(prefs, 0, NULL, 0, offset,
664 case BTRFS_TREE_BLOCK_REF_KEY:
665 ret = __add_prelim_ref(prefs, offset, NULL,
669 case BTRFS_EXTENT_DATA_REF_KEY: {
670 struct btrfs_extent_data_ref *dref;
674 dref = (struct btrfs_extent_data_ref *)(&iref->offset);
675 count = btrfs_extent_data_ref_count(leaf, dref);
676 key.objectid = btrfs_extent_data_ref_objectid(leaf,
678 key.type = BTRFS_EXTENT_DATA_KEY;
679 key.offset = btrfs_extent_data_ref_offset(leaf, dref);
680 root = btrfs_extent_data_ref_root(leaf, dref);
681 ret = __add_prelim_ref(prefs, root, &key, 0, 0,
690 ptr += btrfs_extent_inline_ref_size(type);
697 * add all non-inline backrefs for bytenr to the list
699 static int __add_keyed_refs(struct btrfs_fs_info *fs_info,
700 struct btrfs_path *path, u64 bytenr,
701 int info_level, struct list_head *prefs)
703 struct btrfs_root *extent_root = fs_info->extent_root;
706 struct extent_buffer *leaf;
707 struct btrfs_key key;
710 ret = btrfs_next_item(extent_root, path);
718 slot = path->slots[0];
719 leaf = path->nodes[0];
720 btrfs_item_key_to_cpu(leaf, &key, slot);
722 if (key.objectid != bytenr)
724 if (key.type < BTRFS_TREE_BLOCK_REF_KEY)
726 if (key.type > BTRFS_SHARED_DATA_REF_KEY)
730 case BTRFS_SHARED_BLOCK_REF_KEY:
731 ret = __add_prelim_ref(prefs, 0, NULL,
732 info_level + 1, key.offset,
735 case BTRFS_SHARED_DATA_REF_KEY: {
736 struct btrfs_shared_data_ref *sdref;
739 sdref = btrfs_item_ptr(leaf, slot,
740 struct btrfs_shared_data_ref);
741 count = btrfs_shared_data_ref_count(leaf, sdref);
742 ret = __add_prelim_ref(prefs, 0, NULL, 0, key.offset,
746 case BTRFS_TREE_BLOCK_REF_KEY:
747 ret = __add_prelim_ref(prefs, key.offset, NULL,
751 case BTRFS_EXTENT_DATA_REF_KEY: {
752 struct btrfs_extent_data_ref *dref;
756 dref = btrfs_item_ptr(leaf, slot,
757 struct btrfs_extent_data_ref);
758 count = btrfs_extent_data_ref_count(leaf, dref);
759 key.objectid = btrfs_extent_data_ref_objectid(leaf,
761 key.type = BTRFS_EXTENT_DATA_KEY;
762 key.offset = btrfs_extent_data_ref_offset(leaf, dref);
763 root = btrfs_extent_data_ref_root(leaf, dref);
764 ret = __add_prelim_ref(prefs, root, &key, 0, 0,
780 * this adds all existing backrefs (inline backrefs, backrefs and delayed
781 * refs) for the given bytenr to the refs list, merges duplicates and resolves
782 * indirect refs to their parent bytenr.
783 * When roots are found, they're added to the roots list
785 * FIXME some caching might speed things up
787 static int find_parent_nodes(struct btrfs_trans_handle *trans,
788 struct btrfs_fs_info *fs_info, u64 bytenr,
789 u64 time_seq, struct ulist *refs,
790 struct ulist *roots, const u64 *extent_item_pos)
792 struct btrfs_key key;
793 struct btrfs_path *path;
794 struct btrfs_delayed_ref_root *delayed_refs = NULL;
795 struct btrfs_delayed_ref_head *head;
798 int search_commit_root = (trans == BTRFS_BACKREF_SEARCH_COMMIT_ROOT);
799 struct list_head prefs_delayed;
800 struct list_head prefs;
801 struct __prelim_ref *ref;
803 INIT_LIST_HEAD(&prefs);
804 INIT_LIST_HEAD(&prefs_delayed);
806 key.objectid = bytenr;
807 key.type = BTRFS_EXTENT_ITEM_KEY;
808 key.offset = (u64)-1;
810 path = btrfs_alloc_path();
813 path->search_commit_root = !!search_commit_root;
816 * grab both a lock on the path and a lock on the delayed ref head.
817 * We need both to get a consistent picture of how the refs look
818 * at a specified point in time
823 ret = btrfs_search_slot(trans, fs_info->extent_root, &key, path, 0, 0);
828 if (trans != BTRFS_BACKREF_SEARCH_COMMIT_ROOT) {
830 * look if there are updates for this ref queued and lock the
833 delayed_refs = &trans->transaction->delayed_refs;
834 spin_lock(&delayed_refs->lock);
835 head = btrfs_find_delayed_ref_head(trans, bytenr);
837 if (!mutex_trylock(&head->mutex)) {
838 atomic_inc(&head->node.refs);
839 spin_unlock(&delayed_refs->lock);
841 btrfs_release_path(path);
844 * Mutex was contended, block until it's
845 * released and try again
847 mutex_lock(&head->mutex);
848 mutex_unlock(&head->mutex);
849 btrfs_put_delayed_ref(&head->node);
852 ret = __add_delayed_refs(head, time_seq,
854 mutex_unlock(&head->mutex);
856 spin_unlock(&delayed_refs->lock);
860 spin_unlock(&delayed_refs->lock);
863 if (path->slots[0]) {
864 struct extent_buffer *leaf;
868 leaf = path->nodes[0];
869 slot = path->slots[0];
870 btrfs_item_key_to_cpu(leaf, &key, slot);
871 if (key.objectid == bytenr &&
872 key.type == BTRFS_EXTENT_ITEM_KEY) {
873 ret = __add_inline_refs(fs_info, path, bytenr,
874 &info_level, &prefs);
877 ret = __add_keyed_refs(fs_info, path, bytenr,
883 btrfs_release_path(path);
885 list_splice_init(&prefs_delayed, &prefs);
887 ret = __add_missing_keys(fs_info, &prefs);
891 __merge_refs(&prefs, 1);
893 ret = __resolve_indirect_refs(fs_info, search_commit_root, time_seq,
894 &prefs, extent_item_pos);
898 __merge_refs(&prefs, 2);
900 while (!list_empty(&prefs)) {
901 ref = list_first_entry(&prefs, struct __prelim_ref, list);
902 list_del(&ref->list);
903 WARN_ON(ref->count < 0);
904 if (ref->count && ref->root_id && ref->parent == 0) {
905 /* no parent == root of tree */
906 ret = ulist_add(roots, ref->root_id, 0, GFP_NOFS);
910 if (ref->count && ref->parent) {
911 struct extent_inode_elem *eie = NULL;
912 if (extent_item_pos && !ref->inode_list) {
914 struct extent_buffer *eb;
915 bsz = btrfs_level_size(fs_info->extent_root,
917 eb = read_tree_block(fs_info->extent_root,
918 ref->parent, bsz, 0);
919 if (!eb || !extent_buffer_uptodate(eb)) {
920 free_extent_buffer(eb);
924 ret = find_extent_in_eb(eb, bytenr,
925 *extent_item_pos, &eie);
926 ref->inode_list = eie;
927 free_extent_buffer(eb);
929 ret = ulist_add_merge(refs, ref->parent,
930 (uintptr_t)ref->inode_list,
931 (u64 *)&eie, GFP_NOFS);
934 if (!ret && extent_item_pos) {
936 * we've recorded that parent, so we must extend
937 * its inode list here
942 eie->next = ref->inode_list;
949 btrfs_free_path(path);
950 while (!list_empty(&prefs)) {
951 ref = list_first_entry(&prefs, struct __prelim_ref, list);
952 list_del(&ref->list);
955 while (!list_empty(&prefs_delayed)) {
956 ref = list_first_entry(&prefs_delayed, struct __prelim_ref,
958 list_del(&ref->list);
965 static void free_leaf_list(struct ulist *blocks)
967 struct ulist_node *node = NULL;
968 struct extent_inode_elem *eie;
969 struct extent_inode_elem *eie_next;
970 struct ulist_iterator uiter;
972 ULIST_ITER_INIT(&uiter);
973 while ((node = ulist_next(blocks, &uiter))) {
976 eie = (struct extent_inode_elem *)(uintptr_t)node->aux;
977 for (; eie; eie = eie_next) {
978 eie_next = eie->next;
988 * Finds all leafs with a reference to the specified combination of bytenr and
989 * offset. key_list_head will point to a list of corresponding keys (caller must
990 * free each list element). The leafs will be stored in the leafs ulist, which
991 * must be freed with ulist_free.
993 * returns 0 on success, <0 on error
995 static int btrfs_find_all_leafs(struct btrfs_trans_handle *trans,
996 struct btrfs_fs_info *fs_info, u64 bytenr,
997 u64 time_seq, struct ulist **leafs,
998 const u64 *extent_item_pos)
1003 tmp = ulist_alloc(GFP_NOFS);
1006 *leafs = ulist_alloc(GFP_NOFS);
1012 ret = find_parent_nodes(trans, fs_info, bytenr,
1013 time_seq, *leafs, tmp, extent_item_pos);
1016 if (ret < 0 && ret != -ENOENT) {
1017 free_leaf_list(*leafs);
1025 * walk all backrefs for a given extent to find all roots that reference this
1026 * extent. Walking a backref means finding all extents that reference this
1027 * extent and in turn walk the backrefs of those, too. Naturally this is a
1028 * recursive process, but here it is implemented in an iterative fashion: We
1029 * find all referencing extents for the extent in question and put them on a
1030 * list. In turn, we find all referencing extents for those, further appending
1031 * to the list. The way we iterate the list allows adding more elements after
1032 * the current while iterating. The process stops when we reach the end of the
1033 * list. Found roots are added to the roots list.
1035 * returns 0 on success, < 0 on error.
1037 int btrfs_find_all_roots(struct btrfs_trans_handle *trans,
1038 struct btrfs_fs_info *fs_info, u64 bytenr,
1039 u64 time_seq, struct ulist **roots)
1042 struct ulist_node *node = NULL;
1043 struct ulist_iterator uiter;
1046 tmp = ulist_alloc(GFP_NOFS);
1049 *roots = ulist_alloc(GFP_NOFS);
1055 ULIST_ITER_INIT(&uiter);
1057 ret = find_parent_nodes(trans, fs_info, bytenr,
1058 time_seq, tmp, *roots, NULL);
1059 if (ret < 0 && ret != -ENOENT) {
1064 node = ulist_next(tmp, &uiter);
1075 static int __inode_info(u64 inum, u64 ioff, u8 key_type,
1076 struct btrfs_root *fs_root, struct btrfs_path *path,
1077 struct btrfs_key *found_key)
1080 struct btrfs_key key;
1081 struct extent_buffer *eb;
1083 key.type = key_type;
1084 key.objectid = inum;
1087 ret = btrfs_search_slot(NULL, fs_root, &key, path, 0, 0);
1091 eb = path->nodes[0];
1092 if (ret && path->slots[0] >= btrfs_header_nritems(eb)) {
1093 ret = btrfs_next_leaf(fs_root, path);
1096 eb = path->nodes[0];
1099 btrfs_item_key_to_cpu(eb, found_key, path->slots[0]);
1100 if (found_key->type != key.type || found_key->objectid != key.objectid)
1107 * this makes the path point to (inum INODE_ITEM ioff)
1109 int inode_item_info(u64 inum, u64 ioff, struct btrfs_root *fs_root,
1110 struct btrfs_path *path)
1112 struct btrfs_key key;
1113 return __inode_info(inum, ioff, BTRFS_INODE_ITEM_KEY, fs_root, path,
1117 static int inode_ref_info(u64 inum, u64 ioff, struct btrfs_root *fs_root,
1118 struct btrfs_path *path,
1119 struct btrfs_key *found_key)
1121 return __inode_info(inum, ioff, BTRFS_INODE_REF_KEY, fs_root, path,
1125 int btrfs_find_one_extref(struct btrfs_root *root, u64 inode_objectid,
1126 u64 start_off, struct btrfs_path *path,
1127 struct btrfs_inode_extref **ret_extref,
1131 struct btrfs_key key;
1132 struct btrfs_key found_key;
1133 struct btrfs_inode_extref *extref;
1134 struct extent_buffer *leaf;
1137 key.objectid = inode_objectid;
1138 btrfs_set_key_type(&key, BTRFS_INODE_EXTREF_KEY);
1139 key.offset = start_off;
1141 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
1146 leaf = path->nodes[0];
1147 slot = path->slots[0];
1148 if (slot >= btrfs_header_nritems(leaf)) {
1150 * If the item at offset is not found,
1151 * btrfs_search_slot will point us to the slot
1152 * where it should be inserted. In our case
1153 * that will be the slot directly before the
1154 * next INODE_REF_KEY_V2 item. In the case
1155 * that we're pointing to the last slot in a
1156 * leaf, we must move one leaf over.
1158 ret = btrfs_next_leaf(root, path);
1167 btrfs_item_key_to_cpu(leaf, &found_key, slot);
1170 * Check that we're still looking at an extended ref key for
1171 * this particular objectid. If we have different
1172 * objectid or type then there are no more to be found
1173 * in the tree and we can exit.
1176 if (found_key.objectid != inode_objectid)
1178 if (btrfs_key_type(&found_key) != BTRFS_INODE_EXTREF_KEY)
1182 ptr = btrfs_item_ptr_offset(leaf, path->slots[0]);
1183 extref = (struct btrfs_inode_extref *)ptr;
1184 *ret_extref = extref;
1186 *found_off = found_key.offset;
1194 * this iterates to turn a name (from iref/extref) into a full filesystem path.
1195 * Elements of the path are separated by '/' and the path is guaranteed to be
1196 * 0-terminated. the path is only given within the current file system.
1197 * Therefore, it never starts with a '/'. the caller is responsible to provide
1198 * "size" bytes in "dest". the dest buffer will be filled backwards. finally,
1199 * the start point of the resulting string is returned. this pointer is within
1201 * in case the path buffer would overflow, the pointer is decremented further
1202 * as if output was written to the buffer, though no more output is actually
1203 * generated. that way, the caller can determine how much space would be
1204 * required for the path to fit into the buffer. in that case, the returned
1205 * value will be smaller than dest. callers must check this!
1207 char *btrfs_ref_to_path(struct btrfs_root *fs_root, struct btrfs_path *path,
1208 u32 name_len, unsigned long name_off,
1209 struct extent_buffer *eb_in, u64 parent,
1210 char *dest, u32 size)
1215 s64 bytes_left = ((s64)size) - 1;
1216 struct extent_buffer *eb = eb_in;
1217 struct btrfs_key found_key;
1218 int leave_spinning = path->leave_spinning;
1219 struct btrfs_inode_ref *iref;
1221 if (bytes_left >= 0)
1222 dest[bytes_left] = '\0';
1224 path->leave_spinning = 1;
1226 bytes_left -= name_len;
1227 if (bytes_left >= 0)
1228 read_extent_buffer(eb, dest + bytes_left,
1229 name_off, name_len);
1231 btrfs_tree_read_unlock_blocking(eb);
1232 free_extent_buffer(eb);
1234 ret = inode_ref_info(parent, 0, fs_root, path, &found_key);
1240 next_inum = found_key.offset;
1242 /* regular exit ahead */
1243 if (parent == next_inum)
1246 slot = path->slots[0];
1247 eb = path->nodes[0];
1248 /* make sure we can use eb after releasing the path */
1250 atomic_inc(&eb->refs);
1251 btrfs_tree_read_lock(eb);
1252 btrfs_set_lock_blocking_rw(eb, BTRFS_READ_LOCK);
1254 btrfs_release_path(path);
1255 iref = btrfs_item_ptr(eb, slot, struct btrfs_inode_ref);
1257 name_len = btrfs_inode_ref_name_len(eb, iref);
1258 name_off = (unsigned long)(iref + 1);
1262 if (bytes_left >= 0)
1263 dest[bytes_left] = '/';
1266 btrfs_release_path(path);
1267 path->leave_spinning = leave_spinning;
1270 return ERR_PTR(ret);
1272 return dest + bytes_left;
1276 * this makes the path point to (logical EXTENT_ITEM *)
1277 * returns BTRFS_EXTENT_FLAG_DATA for data, BTRFS_EXTENT_FLAG_TREE_BLOCK for
1278 * tree blocks and <0 on error.
1280 int extent_from_logical(struct btrfs_fs_info *fs_info, u64 logical,
1281 struct btrfs_path *path, struct btrfs_key *found_key,
1287 struct extent_buffer *eb;
1288 struct btrfs_extent_item *ei;
1289 struct btrfs_key key;
1291 key.type = BTRFS_EXTENT_ITEM_KEY;
1292 key.objectid = logical;
1293 key.offset = (u64)-1;
1295 ret = btrfs_search_slot(NULL, fs_info->extent_root, &key, path, 0, 0);
1298 ret = btrfs_previous_item(fs_info->extent_root, path,
1299 0, BTRFS_EXTENT_ITEM_KEY);
1303 btrfs_item_key_to_cpu(path->nodes[0], found_key, path->slots[0]);
1304 if (found_key->type != BTRFS_EXTENT_ITEM_KEY ||
1305 found_key->objectid > logical ||
1306 found_key->objectid + found_key->offset <= logical) {
1307 pr_debug("logical %llu is not within any extent\n",
1308 (unsigned long long)logical);
1312 eb = path->nodes[0];
1313 item_size = btrfs_item_size_nr(eb, path->slots[0]);
1314 BUG_ON(item_size < sizeof(*ei));
1316 ei = btrfs_item_ptr(eb, path->slots[0], struct btrfs_extent_item);
1317 flags = btrfs_extent_flags(eb, ei);
1319 pr_debug("logical %llu is at position %llu within the extent (%llu "
1320 "EXTENT_ITEM %llu) flags %#llx size %u\n",
1321 (unsigned long long)logical,
1322 (unsigned long long)(logical - found_key->objectid),
1323 (unsigned long long)found_key->objectid,
1324 (unsigned long long)found_key->offset,
1325 (unsigned long long)flags, item_size);
1327 WARN_ON(!flags_ret);
1329 if (flags & BTRFS_EXTENT_FLAG_TREE_BLOCK)
1330 *flags_ret = BTRFS_EXTENT_FLAG_TREE_BLOCK;
1331 else if (flags & BTRFS_EXTENT_FLAG_DATA)
1332 *flags_ret = BTRFS_EXTENT_FLAG_DATA;
1342 * helper function to iterate extent inline refs. ptr must point to a 0 value
1343 * for the first call and may be modified. it is used to track state.
1344 * if more refs exist, 0 is returned and the next call to
1345 * __get_extent_inline_ref must pass the modified ptr parameter to get the
1346 * next ref. after the last ref was processed, 1 is returned.
1347 * returns <0 on error
1349 static int __get_extent_inline_ref(unsigned long *ptr, struct extent_buffer *eb,
1350 struct btrfs_extent_item *ei, u32 item_size,
1351 struct btrfs_extent_inline_ref **out_eiref,
1356 struct btrfs_tree_block_info *info;
1360 flags = btrfs_extent_flags(eb, ei);
1361 if (flags & BTRFS_EXTENT_FLAG_TREE_BLOCK) {
1362 info = (struct btrfs_tree_block_info *)(ei + 1);
1364 (struct btrfs_extent_inline_ref *)(info + 1);
1366 *out_eiref = (struct btrfs_extent_inline_ref *)(ei + 1);
1368 *ptr = (unsigned long)*out_eiref;
1369 if ((void *)*ptr >= (void *)ei + item_size)
1373 end = (unsigned long)ei + item_size;
1374 *out_eiref = (struct btrfs_extent_inline_ref *)*ptr;
1375 *out_type = btrfs_extent_inline_ref_type(eb, *out_eiref);
1377 *ptr += btrfs_extent_inline_ref_size(*out_type);
1378 WARN_ON(*ptr > end);
1380 return 1; /* last */
1386 * reads the tree block backref for an extent. tree level and root are returned
1387 * through out_level and out_root. ptr must point to a 0 value for the first
1388 * call and may be modified (see __get_extent_inline_ref comment).
1389 * returns 0 if data was provided, 1 if there was no more data to provide or
1392 int tree_backref_for_extent(unsigned long *ptr, struct extent_buffer *eb,
1393 struct btrfs_extent_item *ei, u32 item_size,
1394 u64 *out_root, u8 *out_level)
1398 struct btrfs_tree_block_info *info;
1399 struct btrfs_extent_inline_ref *eiref;
1401 if (*ptr == (unsigned long)-1)
1405 ret = __get_extent_inline_ref(ptr, eb, ei, item_size,
1410 if (type == BTRFS_TREE_BLOCK_REF_KEY ||
1411 type == BTRFS_SHARED_BLOCK_REF_KEY)
1418 /* we can treat both ref types equally here */
1419 info = (struct btrfs_tree_block_info *)(ei + 1);
1420 *out_root = btrfs_extent_inline_ref_offset(eb, eiref);
1421 *out_level = btrfs_tree_block_level(eb, info);
1424 *ptr = (unsigned long)-1;
1429 static int iterate_leaf_refs(struct extent_inode_elem *inode_list,
1430 u64 root, u64 extent_item_objectid,
1431 iterate_extent_inodes_t *iterate, void *ctx)
1433 struct extent_inode_elem *eie;
1436 for (eie = inode_list; eie; eie = eie->next) {
1437 pr_debug("ref for %llu resolved, key (%llu EXTEND_DATA %llu), "
1438 "root %llu\n", extent_item_objectid,
1439 eie->inum, eie->offset, root);
1440 ret = iterate(eie->inum, eie->offset, root, ctx);
1442 pr_debug("stopping iteration for %llu due to ret=%d\n",
1443 extent_item_objectid, ret);
1452 * calls iterate() for every inode that references the extent identified by
1453 * the given parameters.
1454 * when the iterator function returns a non-zero value, iteration stops.
1456 int iterate_extent_inodes(struct btrfs_fs_info *fs_info,
1457 u64 extent_item_objectid, u64 extent_item_pos,
1458 int search_commit_root,
1459 iterate_extent_inodes_t *iterate, void *ctx)
1462 struct btrfs_trans_handle *trans;
1463 struct ulist *refs = NULL;
1464 struct ulist *roots = NULL;
1465 struct ulist_node *ref_node = NULL;
1466 struct ulist_node *root_node = NULL;
1467 struct seq_list tree_mod_seq_elem = {};
1468 struct ulist_iterator ref_uiter;
1469 struct ulist_iterator root_uiter;
1471 pr_debug("resolving all inodes for extent %llu\n",
1472 extent_item_objectid);
1474 if (search_commit_root) {
1475 trans = BTRFS_BACKREF_SEARCH_COMMIT_ROOT;
1477 trans = btrfs_join_transaction(fs_info->extent_root);
1479 return PTR_ERR(trans);
1480 btrfs_get_tree_mod_seq(fs_info, &tree_mod_seq_elem);
1483 ret = btrfs_find_all_leafs(trans, fs_info, extent_item_objectid,
1484 tree_mod_seq_elem.seq, &refs,
1489 ULIST_ITER_INIT(&ref_uiter);
1490 while (!ret && (ref_node = ulist_next(refs, &ref_uiter))) {
1491 ret = btrfs_find_all_roots(trans, fs_info, ref_node->val,
1492 tree_mod_seq_elem.seq, &roots);
1495 ULIST_ITER_INIT(&root_uiter);
1496 while (!ret && (root_node = ulist_next(roots, &root_uiter))) {
1497 pr_debug("root %llu references leaf %llu, data list "
1498 "%#llx\n", root_node->val, ref_node->val,
1499 (long long)ref_node->aux);
1500 ret = iterate_leaf_refs((struct extent_inode_elem *)
1501 (uintptr_t)ref_node->aux,
1503 extent_item_objectid,
1509 free_leaf_list(refs);
1511 if (!search_commit_root) {
1512 btrfs_put_tree_mod_seq(fs_info, &tree_mod_seq_elem);
1513 btrfs_end_transaction(trans, fs_info->extent_root);
1519 int iterate_inodes_from_logical(u64 logical, struct btrfs_fs_info *fs_info,
1520 struct btrfs_path *path,
1521 iterate_extent_inodes_t *iterate, void *ctx)
1524 u64 extent_item_pos;
1526 struct btrfs_key found_key;
1527 int search_commit_root = path->search_commit_root;
1529 ret = extent_from_logical(fs_info, logical, path, &found_key, &flags);
1530 btrfs_release_path(path);
1533 if (flags & BTRFS_EXTENT_FLAG_TREE_BLOCK)
1536 extent_item_pos = logical - found_key.objectid;
1537 ret = iterate_extent_inodes(fs_info, found_key.objectid,
1538 extent_item_pos, search_commit_root,
1544 typedef int (iterate_irefs_t)(u64 parent, u32 name_len, unsigned long name_off,
1545 struct extent_buffer *eb, void *ctx);
1547 static int iterate_inode_refs(u64 inum, struct btrfs_root *fs_root,
1548 struct btrfs_path *path,
1549 iterate_irefs_t *iterate, void *ctx)
1558 struct extent_buffer *eb;
1559 struct btrfs_item *item;
1560 struct btrfs_inode_ref *iref;
1561 struct btrfs_key found_key;
1564 path->leave_spinning = 1;
1565 ret = inode_ref_info(inum, parent ? parent+1 : 0, fs_root, path,
1570 ret = found ? 0 : -ENOENT;
1575 parent = found_key.offset;
1576 slot = path->slots[0];
1577 eb = path->nodes[0];
1578 /* make sure we can use eb after releasing the path */
1579 atomic_inc(&eb->refs);
1580 btrfs_tree_read_lock(eb);
1581 btrfs_set_lock_blocking_rw(eb, BTRFS_READ_LOCK);
1582 btrfs_release_path(path);
1584 item = btrfs_item_nr(eb, slot);
1585 iref = btrfs_item_ptr(eb, slot, struct btrfs_inode_ref);
1587 for (cur = 0; cur < btrfs_item_size(eb, item); cur += len) {
1588 name_len = btrfs_inode_ref_name_len(eb, iref);
1589 /* path must be released before calling iterate()! */
1590 pr_debug("following ref at offset %u for inode %llu in "
1592 (unsigned long long)found_key.objectid,
1593 (unsigned long long)fs_root->objectid);
1594 ret = iterate(parent, name_len,
1595 (unsigned long)(iref + 1), eb, ctx);
1598 len = sizeof(*iref) + name_len;
1599 iref = (struct btrfs_inode_ref *)((char *)iref + len);
1601 btrfs_tree_read_unlock_blocking(eb);
1602 free_extent_buffer(eb);
1605 btrfs_release_path(path);
1610 static int iterate_inode_extrefs(u64 inum, struct btrfs_root *fs_root,
1611 struct btrfs_path *path,
1612 iterate_irefs_t *iterate, void *ctx)
1619 struct extent_buffer *eb;
1620 struct btrfs_inode_extref *extref;
1621 struct extent_buffer *leaf;
1627 ret = btrfs_find_one_extref(fs_root, inum, offset, path, &extref,
1632 ret = found ? 0 : -ENOENT;
1637 slot = path->slots[0];
1638 eb = path->nodes[0];
1639 /* make sure we can use eb after releasing the path */
1640 atomic_inc(&eb->refs);
1642 btrfs_tree_read_lock(eb);
1643 btrfs_set_lock_blocking_rw(eb, BTRFS_READ_LOCK);
1644 btrfs_release_path(path);
1646 leaf = path->nodes[0];
1647 item_size = btrfs_item_size_nr(leaf, path->slots[0]);
1648 ptr = btrfs_item_ptr_offset(leaf, path->slots[0]);
1651 while (cur_offset < item_size) {
1654 extref = (struct btrfs_inode_extref *)(ptr + cur_offset);
1655 parent = btrfs_inode_extref_parent(eb, extref);
1656 name_len = btrfs_inode_extref_name_len(eb, extref);
1657 ret = iterate(parent, name_len,
1658 (unsigned long)&extref->name, eb, ctx);
1662 cur_offset += btrfs_inode_extref_name_len(leaf, extref);
1663 cur_offset += sizeof(*extref);
1665 btrfs_tree_read_unlock_blocking(eb);
1666 free_extent_buffer(eb);
1671 btrfs_release_path(path);
1676 static int iterate_irefs(u64 inum, struct btrfs_root *fs_root,
1677 struct btrfs_path *path, iterate_irefs_t *iterate,
1683 ret = iterate_inode_refs(inum, fs_root, path, iterate, ctx);
1686 else if (ret != -ENOENT)
1689 ret = iterate_inode_extrefs(inum, fs_root, path, iterate, ctx);
1690 if (ret == -ENOENT && found_refs)
1697 * returns 0 if the path could be dumped (probably truncated)
1698 * returns <0 in case of an error
1700 static int inode_to_path(u64 inum, u32 name_len, unsigned long name_off,
1701 struct extent_buffer *eb, void *ctx)
1703 struct inode_fs_paths *ipath = ctx;
1706 int i = ipath->fspath->elem_cnt;
1707 const int s_ptr = sizeof(char *);
1710 bytes_left = ipath->fspath->bytes_left > s_ptr ?
1711 ipath->fspath->bytes_left - s_ptr : 0;
1713 fspath_min = (char *)ipath->fspath->val + (i + 1) * s_ptr;
1714 fspath = btrfs_ref_to_path(ipath->fs_root, ipath->btrfs_path, name_len,
1715 name_off, eb, inum, fspath_min, bytes_left);
1717 return PTR_ERR(fspath);
1719 if (fspath > fspath_min) {
1720 ipath->fspath->val[i] = (u64)(unsigned long)fspath;
1721 ++ipath->fspath->elem_cnt;
1722 ipath->fspath->bytes_left = fspath - fspath_min;
1724 ++ipath->fspath->elem_missed;
1725 ipath->fspath->bytes_missing += fspath_min - fspath;
1726 ipath->fspath->bytes_left = 0;
1733 * this dumps all file system paths to the inode into the ipath struct, provided
1734 * is has been created large enough. each path is zero-terminated and accessed
1735 * from ipath->fspath->val[i].
1736 * when it returns, there are ipath->fspath->elem_cnt number of paths available
1737 * in ipath->fspath->val[]. when the allocated space wasn't sufficient, the
1738 * number of missed paths in recored in ipath->fspath->elem_missed, otherwise,
1739 * it's zero. ipath->fspath->bytes_missing holds the number of bytes that would
1740 * have been needed to return all paths.
1742 int paths_from_inode(u64 inum, struct inode_fs_paths *ipath)
1744 return iterate_irefs(inum, ipath->fs_root, ipath->btrfs_path,
1745 inode_to_path, ipath);
1748 struct btrfs_data_container *init_data_container(u32 total_bytes)
1750 struct btrfs_data_container *data;
1753 alloc_bytes = max_t(size_t, total_bytes, sizeof(*data));
1754 data = vmalloc(alloc_bytes);
1756 return ERR_PTR(-ENOMEM);
1758 if (total_bytes >= sizeof(*data)) {
1759 data->bytes_left = total_bytes - sizeof(*data);
1760 data->bytes_missing = 0;
1762 data->bytes_missing = sizeof(*data) - total_bytes;
1763 data->bytes_left = 0;
1767 data->elem_missed = 0;
1773 * allocates space to return multiple file system paths for an inode.
1774 * total_bytes to allocate are passed, note that space usable for actual path
1775 * information will be total_bytes - sizeof(struct inode_fs_paths).
1776 * the returned pointer must be freed with free_ipath() in the end.
1778 struct inode_fs_paths *init_ipath(s32 total_bytes, struct btrfs_root *fs_root,
1779 struct btrfs_path *path)
1781 struct inode_fs_paths *ifp;
1782 struct btrfs_data_container *fspath;
1784 fspath = init_data_container(total_bytes);
1786 return (void *)fspath;
1788 ifp = kmalloc(sizeof(*ifp), GFP_NOFS);
1791 return ERR_PTR(-ENOMEM);
1794 ifp->btrfs_path = path;
1795 ifp->fspath = fspath;
1796 ifp->fs_root = fs_root;
1801 void free_ipath(struct inode_fs_paths *ipath)
1805 vfree(ipath->fspath);