git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/btree_iter.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _BCACHEFS_BTREE_ITER_H
   3 #define _BCACHEFS_BTREE_ITER_H
   4
   5 #include "bset.h"
   6 #include "btree_types.h"
   7
   8 static inline void btree_iter_set_dirty(struct btree_iter *iter,
   9                                         enum btree_iter_uptodate u)
  10 {
  11         iter->uptodate = max_t(unsigned, iter->uptodate, u);
  12 }
  13
  14 static inline struct btree *btree_iter_node(struct btree_iter *iter,
  15                                             unsigned level)
  16 {
  17         return level < BTREE_MAX_DEPTH ? iter->l[level].b : NULL;
  18 }
  19
  20 static inline bool btree_node_lock_seq_matches(const struct btree_iter *iter,
  21                                         const struct btree *b, unsigned level)
  22 {
  23         /*
  24          * We don't compare the low bits of the lock sequence numbers because
  25          * @iter might have taken a write lock on @b, and we don't want to skip
  26          * the linked iterator if the sequence numbers were equal before taking
  27          * that write lock. The lock sequence number is incremented by taking
  28          * and releasing write locks and is even when unlocked:
  29          */
  30         return iter->l[level].lock_seq >> 1 == b->lock.state.seq >> 1;
  31 }
  32
  33 static inline struct btree *btree_node_parent(struct btree_iter *iter,
  34                                               struct btree *b)
  35 {
  36         return btree_iter_node(iter, b->level + 1);
  37 }
  38
  39 static inline bool btree_trans_has_multiple_iters(const struct btree_trans *trans)
  40 {
  41         return hweight64(trans->iters_linked) > 1;
  42 }
  43
  44 static inline int btree_iter_err(const struct btree_iter *iter)
  45 {
  46         return iter->flags & BTREE_ITER_ERROR ? -EIO : 0;
  47 }
  48
  49 /* Iterate over iters within a transaction: */
  50
  51 static inline struct btree_iter *
  52 __trans_next_iter(struct btree_trans *trans, unsigned idx)
  53 {
  54         EBUG_ON(idx < trans->nr_iters && trans->iters[idx].idx != idx);
  55
  56         for (; idx < trans->nr_iters; idx++)
  57                 if (trans->iters_linked & (1ULL << idx))
  58                         return &trans->iters[idx];
  59
  60         return NULL;
  61 }
  62
  63 #define trans_for_each_iter(_trans, _iter)                              \
  64         for (_iter = __trans_next_iter((_trans), 0);                    \
  65              (_iter);                                                   \
  66              _iter = __trans_next_iter((_trans), (_iter)->idx + 1))
  67
  68 static inline bool __iter_has_node(const struct btree_iter *iter,
  69                                    const struct btree *b)
  70 {
  71         return iter->l[b->level].b == b &&
  72                 btree_node_lock_seq_matches(iter, b, b->level);
  73 }
  74
  75 static inline struct btree_iter *
  76 __trans_next_iter_with_node(struct btree_trans *trans, struct btree *b,
  77                             unsigned idx)
  78 {
  79         struct btree_iter *iter = __trans_next_iter(trans, idx);
  80
  81         while (iter && !__iter_has_node(iter, b))
  82                 iter = __trans_next_iter(trans, iter->idx + 1);
  83
  84         return iter;
  85 }
  86
  87 #define trans_for_each_iter_with_node(_trans, _b, _iter)                \
  88         for (_iter = __trans_next_iter_with_node((_trans), (_b), 0);    \
  89              (_iter);                                                   \
  90              _iter = __trans_next_iter_with_node((_trans), (_b),        \
  91                                                  (_iter)->idx + 1))
  92
  93 #ifdef CONFIG_BCACHEFS_DEBUG
  94 void bch2_btree_iter_verify(struct btree_iter *, struct btree *);
  95 void bch2_btree_trans_verify_locks(struct btree_trans *);
  96 #else
  97 static inline void bch2_btree_iter_verify(struct btree_iter *iter,
  98                                           struct btree *b) {}
  99 static inline void bch2_btree_trans_verify_locks(struct btree_trans *iter) {}
 100 #endif
 101
 102 void bch2_btree_node_iter_fix(struct btree_iter *, struct btree *,
 103                               struct btree_node_iter *, struct bkey_packed *,
 104                               unsigned, unsigned);
 105
 106 bool bch2_trans_relock(struct btree_trans *);
 107 void bch2_trans_unlock(struct btree_trans *);
 108
 109 bool __bch2_btree_iter_upgrade(struct btree_iter *, unsigned);
 110 bool __bch2_btree_iter_upgrade_nounlock(struct btree_iter *, unsigned);
 111
 112 static inline bool bch2_btree_iter_upgrade(struct btree_iter *iter,
 113                                            unsigned new_locks_want)
 114 {
 115         new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
 116
 117         return iter->locks_want < new_locks_want
 118                 ? (!iter->trans->nounlock
 119                    ? __bch2_btree_iter_upgrade(iter, new_locks_want)
 120                    : __bch2_btree_iter_upgrade_nounlock(iter, new_locks_want))
 121                 : iter->uptodate <= BTREE_ITER_NEED_PEEK;
 122 }
 123
 124 void __bch2_btree_iter_downgrade(struct btree_iter *, unsigned);
 125
 126 static inline void bch2_btree_iter_downgrade(struct btree_iter *iter)
 127 {
 128         if (iter->locks_want > (iter->flags & BTREE_ITER_INTENT) ? 1 : 0)
 129                 __bch2_btree_iter_downgrade(iter, 0);
 130 }
 131
 132 void bch2_btree_iter_node_replace(struct btree_iter *, struct btree *);
 133 void bch2_btree_iter_node_drop(struct btree_iter *, struct btree *);
 134
 135 void bch2_btree_iter_reinit_node(struct btree_iter *, struct btree *);
 136
 137 int __must_check __bch2_btree_iter_traverse(struct btree_iter *);
 138
 139 static inline int __must_check
 140 bch2_btree_iter_traverse(struct btree_iter *iter)
 141 {
 142         return iter->uptodate >= BTREE_ITER_NEED_RELOCK
 143                 ? __bch2_btree_iter_traverse(iter)
 144                 : 0;
 145 }
 146
 147 int bch2_btree_iter_traverse_all(struct btree_trans *);
 148
 149 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
 150 struct btree *bch2_btree_iter_next_node(struct btree_iter *, unsigned);
 151
 152 struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *);
 153 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
 154
 155 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
 156 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
 157
 158 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
 159 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
 160
 161 void bch2_btree_iter_set_pos_same_leaf(struct btree_iter *, struct bpos);
 162 void bch2_btree_iter_set_pos(struct btree_iter *, struct bpos);
 163
 164 static inline struct bpos btree_type_successor(enum btree_id id,
 165                                                struct bpos pos)
 166 {
 167         if (id == BTREE_ID_INODES) {
 168                 pos.inode++;
 169                 pos.offset = 0;
 170         } else if (!btree_node_type_is_extents(id)) {
 171                 pos = bkey_successor(pos);
 172         }
 173
 174         return pos;
 175 }
 176
 177 static inline struct bpos btree_type_predecessor(enum btree_id id,
 178                                                struct bpos pos)
 179 {
 180         if (id == BTREE_ID_INODES) {
 181                 --pos.inode;
 182                 pos.offset = 0;
 183         } else {
 184                 pos = bkey_predecessor(pos);
 185         }
 186
 187         return pos;
 188 }
 189
 190 static inline int __btree_iter_cmp(enum btree_id id,
 191                                    struct bpos pos,
 192                                    const struct btree_iter *r)
 193 {
 194         if (id != r->btree_id)
 195                 return id < r->btree_id ? -1 : 1;
 196         return bkey_cmp(pos, r->pos);
 197 }
 198
 199 static inline int btree_iter_cmp(const struct btree_iter *l,
 200                                  const struct btree_iter *r)
 201 {
 202         return __btree_iter_cmp(l->btree_id, l->pos, r);
 203 }
 204
 205 /*
 206  * Unlocks before scheduling
 207  * Note: does not revalidate iterator
 208  */
 209 static inline int bch2_trans_cond_resched(struct btree_trans *trans)
 210 {
 211         if (need_resched() || race_fault()) {
 212                 bch2_trans_unlock(trans);
 213                 schedule();
 214                 return bch2_trans_relock(trans) ? 0 : -EINTR;
 215         } else {
 216                 return 0;
 217         }
 218 }
 219
 220 #define __for_each_btree_node(_trans, _iter, _btree_id, _start, \
 221                               _locks_want, _depth, _flags, _b)          \
 222         for (iter = bch2_trans_get_node_iter((_trans), (_btree_id),     \
 223                                 _start, _locks_want, _depth, _flags),   \
 224              _b = bch2_btree_iter_peek_node(_iter);                     \
 225              (_b);                                                      \
 226              (_b) = bch2_btree_iter_next_node(_iter, _depth))
 227
 228 #define for_each_btree_node(_trans, _iter, _btree_id, _start,           \
 229                             _flags, _b)                                 \
 230         __for_each_btree_node(_trans, _iter, _btree_id, _start,         \
 231                               0, 0, _flags, _b)
 232
 233 static inline struct bkey_s_c __bch2_btree_iter_peek(struct btree_iter *iter,
 234                                                      unsigned flags)
 235 {
 236         return flags & BTREE_ITER_SLOTS
 237                 ? bch2_btree_iter_peek_slot(iter)
 238                 : bch2_btree_iter_peek(iter);
 239 }
 240
 241 static inline struct bkey_s_c __bch2_btree_iter_next(struct btree_iter *iter,
 242                                                      unsigned flags)
 243 {
 244         return flags & BTREE_ITER_SLOTS
 245                 ? bch2_btree_iter_next_slot(iter)
 246                 : bch2_btree_iter_next(iter);
 247 }
 248
 249 #define for_each_btree_key(_trans, _iter, _btree_id,                    \
 250                            _start, _flags, _k, _ret)                    \
 251         for ((_ret) = PTR_ERR_OR_ZERO((_iter) =                         \
 252                         bch2_trans_get_iter((_trans), (_btree_id),      \
 253                                             (_start), (_flags))) ?:     \
 254                       PTR_ERR_OR_ZERO(((_k) =                           \
 255                         __bch2_btree_iter_peek(_iter, _flags)).k);      \
 256              !_ret && (_k).k;                                           \
 257              (_ret) = PTR_ERR_OR_ZERO(((_k) =                           \
 258                         __bch2_btree_iter_next(_iter, _flags)).k))
 259
 260 #define for_each_btree_key_continue(_iter, _flags, _k)                  \
 261         for ((_k) = __bch2_btree_iter_peek(_iter, _flags);              \
 262              !IS_ERR_OR_NULL((_k).k);                                   \
 263              (_k) = __bch2_btree_iter_next(_iter, _flags))
 264
 265 static inline int bkey_err(struct bkey_s_c k)
 266 {
 267         return PTR_ERR_OR_ZERO(k.k);
 268 }
 269
 270 /* new multiple iterator interface: */
 271
 272 int bch2_trans_iter_put(struct btree_trans *, struct btree_iter *);
 273 int bch2_trans_iter_free(struct btree_trans *, struct btree_iter *);
 274 int bch2_trans_iter_free_on_commit(struct btree_trans *, struct btree_iter *);
 275
 276 void bch2_trans_unlink_iters(struct btree_trans *, u64);
 277
 278 struct btree_iter *__bch2_trans_get_iter(struct btree_trans *, enum btree_id,
 279                                          struct bpos, unsigned, u64);
 280 struct btree_iter *bch2_trans_copy_iter(struct btree_trans *,
 281                                         struct btree_iter *);
 282
 283 static __always_inline u64 __btree_iter_id(void)
 284 {
 285         u64 ret = 0;
 286
 287         ret <<= 32;
 288         ret |= _RET_IP_ & U32_MAX;
 289         ret <<= 32;
 290         ret |= _THIS_IP_ & U32_MAX;
 291         return ret;
 292 }
 293
 294 static __always_inline struct btree_iter *
 295 bch2_trans_get_iter(struct btree_trans *trans, enum btree_id btree_id,
 296                     struct bpos pos, unsigned flags)
 297 {
 298         return __bch2_trans_get_iter(trans, btree_id, pos, flags,
 299                                      __btree_iter_id());
 300 }
 301
 302 struct btree_iter *bch2_trans_get_node_iter(struct btree_trans *,
 303                                 enum btree_id, struct bpos,
 304                                 unsigned, unsigned, unsigned);
 305
 306 void bch2_trans_begin(struct btree_trans *);
 307
 308 static inline void bch2_trans_begin_updates(struct btree_trans *trans)
 309 {
 310         trans->nr_updates = 0;
 311 }
 312
 313 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
 314 void bch2_trans_init(struct btree_trans *, struct bch_fs *, unsigned, size_t);
 315 int bch2_trans_exit(struct btree_trans *);
 316
 317 void bch2_fs_btree_iter_exit(struct bch_fs *);
 318 int bch2_fs_btree_iter_init(struct bch_fs *);
 319
 320 #endif /* _BCACHEFS_BTREE_ITER_H */