]> git.sesse.net Git - bcachefs-tools-debian/blobdiff - libbcachefs/btree_iter.h
Update bcachefs sources to 4837f82ee1 bcachefs: Use cached iterators for alloc btree
[bcachefs-tools-debian] / libbcachefs / btree_iter.h
index 57f38765f72eaba5a48a24fc00eace1739f98c2f..bd9ec3ec9a92a2809128f6ae799dfeae44bc9ca9 100644 (file)
-#ifndef _BCACHE_BTREE_ITER_H
-#define _BCACHE_BTREE_ITER_H
+/* SPDX-License-Identifier: GPL-2.0 */
+#ifndef _BCACHEFS_BTREE_ITER_H
+#define _BCACHEFS_BTREE_ITER_H
 
+#include "bset.h"
 #include "btree_types.h"
 
+static inline void btree_iter_set_dirty(struct btree_iter *iter,
+                                       enum btree_iter_uptodate u)
+{
+       iter->uptodate = max_t(unsigned, iter->uptodate, u);
+}
 
-#define BTREE_ITER_INTENT              (1 << 0)
-#define BTREE_ITER_WITH_HOLES          (1 << 1)
-#define BTREE_ITER_PREFETCH            (1 << 2)
-/*
- * Used in bch2_btree_iter_traverse(), to indicate whether we're searching for
- * @pos or the first key strictly greater than @pos
- */
-#define BTREE_ITER_IS_EXTENTS          (1 << 3)
-/*
- * indicates we need to call bch2_btree_iter_traverse() to revalidate iterator:
- */
-#define BTREE_ITER_AT_END_OF_LEAF      (1 << 4)
-#define BTREE_ITER_ERROR               (1 << 5)
-
-/*
- * @pos                        - iterator's current position
- * @level              - current btree depth
- * @locks_want         - btree level below which we start taking intent locks
- * @nodes_locked       - bitmask indicating which nodes in @nodes are locked
- * @nodes_intent_locked        - bitmask indicating which locks are intent locks
- */
-struct btree_iter {
-       struct bch_fs           *c;
-       struct bpos             pos;
-
-       u8                      flags;
-       enum btree_id           btree_id:8;
-       unsigned                level:4,
-                               locks_want:4,
-                               nodes_locked:4,
-                               nodes_intent_locked:4;
-
-       u32                     lock_seq[BTREE_MAX_DEPTH];
+static inline struct btree *btree_iter_node(struct btree_iter *iter,
+                                           unsigned level)
+{
+       return level < BTREE_MAX_DEPTH ? iter->l[level].b : NULL;
+}
 
+static inline bool btree_node_lock_seq_matches(const struct btree_iter *iter,
+                                       const struct btree *b, unsigned level)
+{
        /*
-        * NOTE: Never set iter->nodes to NULL except in btree_iter_lock_root().
-        *
-        * This is because iter->nodes[iter->level] == NULL is how
-        * btree_iter_next_node() knows that it's finished with a depth first
-        * traversal. Just unlocking a node (with btree_node_unlock()) is fine,
-        * and if you really don't want that node used again (e.g. btree_split()
-        * freed it) decrementing lock_seq will cause bch2_btree_node_relock() to
-        * always fail (but since freeing a btree node takes a write lock on the
-        * node, which increments the node's lock seq, that's not actually
-        * necessary in that example).
-        *
-        * One extra slot for a sentinel NULL:
+        * We don't compare the low bits of the lock sequence numbers because
+        * @iter might have taken a write lock on @b, and we don't want to skip
+        * the linked iterator if the sequence numbers were equal before taking
+        * that write lock. The lock sequence number is incremented by taking
+        * and releasing write locks and is even when unlocked:
         */
-       struct btree            *nodes[BTREE_MAX_DEPTH + 1];
-       struct btree_node_iter  node_iters[BTREE_MAX_DEPTH];
+       return iter->l[level].lock_seq >> 1 == b->c.lock.state.seq >> 1;
+}
 
-       /*
-        * Current unpacked key - so that bch2_btree_iter_next()/
-        * bch2_btree_iter_next_with_holes() can correctly advance pos.
-        */
-       struct bkey             k;
+static inline struct btree *btree_node_parent(struct btree_iter *iter,
+                                             struct btree *b)
+{
+       return btree_iter_node(iter, b->c.level + 1);
+}
 
-       /*
-        * Circular linked list of linked iterators: linked iterators share
-        * locks (e.g. two linked iterators may have the same node intent
-        * locked, or read and write locked, at the same time), and insertions
-        * through one iterator won't invalidate the other linked iterators.
-        */
+static inline bool btree_trans_has_multiple_iters(const struct btree_trans *trans)
+{
+       return hweight64(trans->iters_linked) > 1;
+}
 
-       /* Must come last: */
-       struct btree_iter       *next;
-};
+static inline int btree_iter_err(const struct btree_iter *iter)
+{
+       return iter->flags & BTREE_ITER_ERROR ? -EIO : 0;
+}
+
+/* Iterate over iters within a transaction: */
+
+#define trans_for_each_iter_all(_trans, _iter)                         \
+       for (_iter = (_trans)->iters;                                   \
+            _iter < (_trans)->iters + (_trans)->nr_iters;              \
+            _iter++)
 
-static inline bool btree_iter_linked(const struct btree_iter *iter)
+static inline struct btree_iter *
+__trans_next_iter(struct btree_trans *trans, unsigned idx)
 {
-       return iter->next != iter;
+       EBUG_ON(idx < trans->nr_iters && trans->iters[idx].idx != idx);
+
+       for (; idx < trans->nr_iters; idx++)
+               if (trans->iters_linked & (1ULL << idx))
+                       return &trans->iters[idx];
+
+       return NULL;
 }
 
-/**
- * for_each_linked_btree_iter - iterate over all iterators linked with @_iter
- */
-#define for_each_linked_btree_iter(_iter, _linked)                     \
-       for ((_linked) = (_iter)->next;                                 \
-            (_linked) != (_iter);                                      \
-            (_linked) = (_linked)->next)
+#define trans_for_each_iter(_trans, _iter)                             \
+       for (_iter = __trans_next_iter((_trans), 0);                    \
+            (_iter);                                                   \
+            _iter = __trans_next_iter((_trans), (_iter)->idx + 1))
+
+static inline bool __iter_has_node(const struct btree_iter *iter,
+                                  const struct btree *b)
+{
+       return iter->l[b->c.level].b == b &&
+               btree_node_lock_seq_matches(iter, b, b->c.level);
+}
 
 static inline struct btree_iter *
-__next_linked_btree_node(struct btree_iter *iter, struct btree *b,
-                        struct btree_iter *linked)
+__trans_next_iter_with_node(struct btree_trans *trans, struct btree *b,
+                           unsigned idx)
 {
-       do {
-               linked = linked->next;
-
-               if (linked == iter)
-                       return NULL;
-
-               /*
-                * We don't compare the low bits of the lock sequence numbers
-                * because @iter might have taken a write lock on @b, and we
-                * don't want to skip the linked iterator if the sequence
-                * numbers were equal before taking that write lock. The lock
-                * sequence number is incremented by taking and releasing write
-                * locks and is even when unlocked:
-                */
-       } while (linked->nodes[b->level] != b ||
-                linked->lock_seq[b->level] >> 1 != b->lock.state.seq >> 1);
-
-       return linked;
+       struct btree_iter *iter = __trans_next_iter(trans, idx);
+
+       while (iter && !__iter_has_node(iter, b))
+               iter = __trans_next_iter(trans, iter->idx + 1);
+
+       return iter;
 }
 
-/**
- * for_each_linked_btree_node - iterate over all iterators linked with @_iter
- * that also point to @_b
- *
- * @_b is assumed to be locked by @_iter
- *
- * Filters out iterators that don't have a valid btree_node iterator for @_b -
- * i.e. iterators for which bch2_btree_node_relock() would not succeed.
- */
-#define for_each_linked_btree_node(_iter, _b, _linked)                 \
-       for ((_linked) = (_iter);                                       \
-            ((_linked) = __next_linked_btree_node(_iter, _b, _linked));)
+#define trans_for_each_iter_with_node(_trans, _b, _iter)               \
+       for (_iter = __trans_next_iter_with_node((_trans), (_b), 0);    \
+            (_iter);                                                   \
+            _iter = __trans_next_iter_with_node((_trans), (_b),        \
+                                                (_iter)->idx + 1))
 
 #ifdef CONFIG_BCACHEFS_DEBUG
-void bch2_btree_iter_verify(struct btree_iter *, struct btree *);
+void bch2_btree_trans_verify_iters(struct btree_trans *, struct btree *);
+void bch2_btree_trans_verify_locks(struct btree_trans *);
 #else
-static inline void bch2_btree_iter_verify(struct btree_iter *iter,
-                                        struct btree *b) {}
+static inline void bch2_btree_trans_verify_iters(struct btree_trans *trans,
+                                                struct btree *b) {}
+static inline void bch2_btree_trans_verify_locks(struct btree_trans *iter) {}
 #endif
 
+void bch2_btree_iter_fix_key_modified(struct btree_iter *, struct btree *,
+                                          struct bkey_packed *);
 void bch2_btree_node_iter_fix(struct btree_iter *, struct btree *,
-                            struct btree_node_iter *, struct bset_tree *,
-                            struct bkey_packed *, unsigned, unsigned);
+                             struct btree_node_iter *, struct bkey_packed *,
+                             unsigned, unsigned);
+
+bool bch2_btree_iter_relock(struct btree_iter *, bool);
+bool bch2_trans_relock(struct btree_trans *);
+void bch2_trans_unlock(struct btree_trans *);
 
-int bch2_btree_iter_unlock(struct btree_iter *);
-bool __bch2_btree_iter_set_locks_want(struct btree_iter *, unsigned);
+bool __bch2_btree_iter_upgrade(struct btree_iter *, unsigned);
+bool __bch2_btree_iter_upgrade_nounlock(struct btree_iter *, unsigned);
 
-static inline bool bch2_btree_iter_set_locks_want(struct btree_iter *iter,
-                                                unsigned new_locks_want)
+static inline bool bch2_btree_iter_upgrade(struct btree_iter *iter,
+                                          unsigned new_locks_want)
 {
        new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
 
-       if (iter->locks_want == new_locks_want &&
-           iter->nodes_intent_locked == (1 << new_locks_want) - 1)
-               return true;
+       return iter->locks_want < new_locks_want
+               ? (!iter->trans->nounlock
+                  ? __bch2_btree_iter_upgrade(iter, new_locks_want)
+                  : __bch2_btree_iter_upgrade_nounlock(iter, new_locks_want))
+               : iter->uptodate <= BTREE_ITER_NEED_PEEK;
+}
+
+void __bch2_btree_iter_downgrade(struct btree_iter *, unsigned);
 
-       return __bch2_btree_iter_set_locks_want(iter, new_locks_want);
+static inline void bch2_btree_iter_downgrade(struct btree_iter *iter)
+{
+       if (iter->locks_want > (iter->flags & BTREE_ITER_INTENT) ? 1 : 0)
+               __bch2_btree_iter_downgrade(iter, 0);
 }
 
-bool bch2_btree_iter_node_replace(struct btree_iter *, struct btree *);
-void bch2_btree_iter_node_drop_linked(struct btree_iter *, struct btree *);
+void bch2_trans_downgrade(struct btree_trans *);
+
+void bch2_btree_iter_node_replace(struct btree_iter *, struct btree *);
 void bch2_btree_iter_node_drop(struct btree_iter *, struct btree *);
 
 void bch2_btree_iter_reinit_node(struct btree_iter *, struct btree *);
 
-int __must_check bch2_btree_iter_traverse(struct btree_iter *);
+int __must_check __bch2_btree_iter_traverse(struct btree_iter *);
+
+static inline int __must_check
+bch2_btree_iter_traverse(struct btree_iter *iter)
+{
+       return iter->uptodate >= BTREE_ITER_NEED_RELOCK
+               ? __bch2_btree_iter_traverse(iter)
+               : 0;
+}
+
+int bch2_btree_iter_traverse_all(struct btree_trans *);
 
 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
-struct btree *bch2_btree_iter_next_node(struct btree_iter *, unsigned);
+struct btree *bch2_btree_iter_next_node(struct btree_iter *);
 
 struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *);
-struct bkey_s_c bch2_btree_iter_peek_with_holes(struct btree_iter *);
+struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
+
+struct bkey_s_c bch2_btree_iter_peek_with_updates(struct btree_iter *);
+struct bkey_s_c bch2_btree_iter_next_with_updates(struct btree_iter *);
+
+struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
+struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
+
+struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
+struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
+
+struct bkey_s_c bch2_btree_iter_peek_cached(struct btree_iter *);
+
 void bch2_btree_iter_set_pos_same_leaf(struct btree_iter *, struct bpos);
+void __bch2_btree_iter_set_pos(struct btree_iter *, struct bpos, bool);
 void bch2_btree_iter_set_pos(struct btree_iter *, struct bpos);
-void bch2_btree_iter_advance_pos(struct btree_iter *);
-void bch2_btree_iter_rewind(struct btree_iter *, struct bpos);
-
-void __bch2_btree_iter_init(struct btree_iter *, struct bch_fs *,
-                          enum btree_id, struct bpos,
-                          unsigned , unsigned, unsigned);
 
-static inline void bch2_btree_iter_init(struct btree_iter *iter,
-                       struct bch_fs *c, enum btree_id btree_id,
-                       struct bpos pos, unsigned flags)
+static inline int btree_iter_cmp(const struct btree_iter *l,
+                                const struct btree_iter *r)
 {
-       __bch2_btree_iter_init(iter, c, btree_id, pos,
-                              flags & BTREE_ITER_INTENT ? 1 : 0, 0,
-                              btree_id == BTREE_ID_EXTENTS
-                              ?  BTREE_ITER_IS_EXTENTS : 0);
+       return   cmp_int(l->btree_id, r->btree_id) ?:
+               -cmp_int(btree_iter_type(l), btree_iter_type(r)) ?:
+                bkey_cmp(l->pos, r->pos);
 }
 
-void bch2_btree_iter_link(struct btree_iter *, struct btree_iter *);
-void bch2_btree_iter_unlink(struct btree_iter *);
-void bch2_btree_iter_copy(struct btree_iter *, struct btree_iter *);
-
-static inline struct bpos btree_type_successor(enum btree_id id,
-                                              struct bpos pos)
+/*
+ * Unlocks before scheduling
+ * Note: does not revalidate iterator
+ */
+static inline int bch2_trans_cond_resched(struct btree_trans *trans)
 {
-       if (id == BTREE_ID_INODES) {
-               pos.inode++;
-               pos.offset = 0;
-       } else if (id != BTREE_ID_EXTENTS) {
-               pos = bkey_successor(pos);
+       if (need_resched() || race_fault()) {
+               bch2_trans_unlock(trans);
+               schedule();
+               return bch2_trans_relock(trans) ? 0 : -EINTR;
+       } else {
+               return 0;
        }
+}
+
+#define __for_each_btree_node(_trans, _iter, _btree_id, _start,        \
+                             _locks_want, _depth, _flags, _b)          \
+       for (iter = bch2_trans_get_node_iter((_trans), (_btree_id),     \
+                               _start, _locks_want, _depth, _flags),   \
+            _b = bch2_btree_iter_peek_node(_iter);                     \
+            (_b);                                                      \
+            (_b) = bch2_btree_iter_next_node(_iter))
 
-       return pos;
+#define for_each_btree_node(_trans, _iter, _btree_id, _start,          \
+                           _flags, _b)                                 \
+       __for_each_btree_node(_trans, _iter, _btree_id, _start,         \
+                             0, 0, _flags, _b)
+
+static inline struct bkey_s_c __bch2_btree_iter_peek(struct btree_iter *iter,
+                                                    unsigned flags)
+{
+       if ((flags & BTREE_ITER_TYPE) == BTREE_ITER_CACHED)
+               return bch2_btree_iter_peek_cached(iter);
+       else
+               return flags & BTREE_ITER_SLOTS
+                       ? bch2_btree_iter_peek_slot(iter)
+                       : bch2_btree_iter_peek(iter);
 }
 
-static inline int __btree_iter_cmp(enum btree_id id,
-                                  struct bpos pos,
-                                  const struct btree_iter *r)
+static inline struct bkey_s_c __bch2_btree_iter_next(struct btree_iter *iter,
+                                                    unsigned flags)
 {
-       if (id != r->btree_id)
-               return id < r->btree_id ? -1 : 1;
-       return bkey_cmp(pos, r->pos);
+       return flags & BTREE_ITER_SLOTS
+               ? bch2_btree_iter_next_slot(iter)
+               : bch2_btree_iter_next(iter);
 }
 
-static inline int btree_iter_cmp(const struct btree_iter *l,
-                                const struct btree_iter *r)
+static inline int bkey_err(struct bkey_s_c k)
 {
-       return __btree_iter_cmp(l->btree_id, l->pos, r);
+       return PTR_ERR_OR_ZERO(k.k);
 }
 
-#define __for_each_btree_node(_iter, _c, _btree_id, _start,            \
-                             _locks_want, _depth, _flags, _b)          \
-       for (__bch2_btree_iter_init((_iter), (_c), (_btree_id), _start, \
-                                   _locks_want, _depth, _flags),       \
-            _b = bch2_btree_iter_peek_node(_iter);                     \
-            (_b);                                                      \
-            (_b) = bch2_btree_iter_next_node(_iter, _depth))
+#define for_each_btree_key(_trans, _iter, _btree_id,                   \
+                          _start, _flags, _k, _ret)                    \
+       for ((_ret) = PTR_ERR_OR_ZERO((_iter) =                         \
+                       bch2_trans_get_iter((_trans), (_btree_id),      \
+                                           (_start), (_flags))) ?:     \
+                     PTR_ERR_OR_ZERO(((_k) =                           \
+                       __bch2_btree_iter_peek(_iter, _flags)).k);      \
+            !_ret && (_k).k;                                           \
+            (_ret) = PTR_ERR_OR_ZERO(((_k) =                           \
+                       __bch2_btree_iter_next(_iter, _flags)).k))
+
+#define for_each_btree_key_continue(_iter, _flags, _k, _ret)           \
+       for ((_k) = __bch2_btree_iter_peek(_iter, _flags);              \
+            !((_ret) = bkey_err(_k)) && (_k).k;                        \
+            (_k) = __bch2_btree_iter_next(_iter, _flags))
+
+/* new multiple iterator interface: */
 
-#define for_each_btree_node(_iter, _c, _btree_id, _start, _flags, _b)  \
-       __for_each_btree_node(_iter, _c, _btree_id, _start, 0, 0, _flags, _b)
+int bch2_trans_iter_put(struct btree_trans *, struct btree_iter *);
+int bch2_trans_iter_free(struct btree_trans *, struct btree_iter *);
 
-#define for_each_btree_key(_iter, _c, _btree_id,  _start, _flags, _k)  \
-       for (bch2_btree_iter_init((_iter), (_c), (_btree_id),   \
-                                 (_start), (_flags));          \
-            !IS_ERR_OR_NULL(((_k) = (((_flags) & BTREE_ITER_WITH_HOLES)\
-                               ? bch2_btree_iter_peek_with_holes(_iter)\
-                               : bch2_btree_iter_peek(_iter))).k);     \
-            bch2_btree_iter_advance_pos(_iter))
+void bch2_trans_unlink_iters(struct btree_trans *);
 
-static inline int btree_iter_err(struct bkey_s_c k)
+struct btree_iter *__bch2_trans_get_iter(struct btree_trans *, enum btree_id,
+                                        struct bpos, unsigned);
+
+static inline struct btree_iter *
+bch2_trans_get_iter(struct btree_trans *trans, enum btree_id btree_id,
+                   struct bpos pos, unsigned flags)
 {
-       return IS_ERR(k.k) ? PTR_ERR(k.k) : 0;
+       struct btree_iter *iter =
+               __bch2_trans_get_iter(trans, btree_id, pos, flags);
+
+       if (!IS_ERR(iter))
+               iter->ip_allocated = _THIS_IP_;
+       return iter;
 }
 
-/*
- * Unlocks before scheduling
- * Note: does not revalidate iterator
- */
-static inline void bch2_btree_iter_cond_resched(struct btree_iter *iter)
+struct btree_iter *__bch2_trans_copy_iter(struct btree_trans *,
+                                       struct btree_iter *);
+static inline struct btree_iter *
+bch2_trans_copy_iter(struct btree_trans *trans, struct btree_iter *src)
 {
-       struct btree_iter *linked;
+       struct btree_iter *iter =
+               __bch2_trans_copy_iter(trans, src);
+
+       if (!IS_ERR(iter))
+               iter->ip_allocated = _THIS_IP_;
+       return iter;
 
-       if (need_resched()) {
-               for_each_linked_btree_iter(iter, linked)
-                       bch2_btree_iter_unlock(linked);
-               bch2_btree_iter_unlock(iter);
-               schedule();
-       } else if (race_fault()) {
-               for_each_linked_btree_iter(iter, linked)
-                       bch2_btree_iter_unlock(linked);
-               bch2_btree_iter_unlock(iter);
-       }
 }
 
-#endif /* _BCACHE_BTREE_ITER_H */
+struct btree_iter *bch2_trans_get_node_iter(struct btree_trans *,
+                               enum btree_id, struct bpos,
+                               unsigned, unsigned, unsigned);
+
+#define TRANS_RESET_NOTRAVERSE         (1 << 0)
+
+void bch2_trans_reset(struct btree_trans *, unsigned);
+
+static inline void bch2_trans_begin(struct btree_trans *trans)
+{
+       return bch2_trans_reset(trans, 0);
+}
+
+void *bch2_trans_kmalloc(struct btree_trans *, size_t);
+void bch2_trans_init(struct btree_trans *, struct bch_fs *, unsigned, size_t);
+int bch2_trans_exit(struct btree_trans *);
+
+void bch2_btree_trans_to_text(struct printbuf *, struct bch_fs *);
+
+void bch2_fs_btree_iter_exit(struct bch_fs *);
+int bch2_fs_btree_iter_init(struct bch_fs *);
+
+#endif /* _BCACHEFS_BTREE_ITER_H */