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->c.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->c.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         u64 l;
  55
  56         if (idx == BTREE_ITER_MAX)
  57                 return NULL;
  58
  59         l = trans->iters_linked >> idx;
  60         if (!l)
  61                 return NULL;
  62
  63         idx += __ffs64(l);
  64         EBUG_ON(idx >= BTREE_ITER_MAX);
  65         EBUG_ON(trans->iters[idx].idx != idx);
  66         return &trans->iters[idx];
  67 }
  68
  69 #define trans_for_each_iter(_trans, _iter)                              \
  70         for (_iter = __trans_next_iter((_trans), 0);                    \
  71              (_iter);                                                   \
  72              _iter = __trans_next_iter((_trans), (_iter)->idx + 1))
  73
  74 static inline bool __iter_has_node(const struct btree_iter *iter,
  75                                    const struct btree *b)
  76 {
  77         return iter->l[b->c.level].b == b &&
  78                 btree_node_lock_seq_matches(iter, b, b->c.level);
  79 }
  80
  81 static inline struct btree_iter *
  82 __trans_next_iter_with_node(struct btree_trans *trans, struct btree *b,
  83                             unsigned idx)
  84 {
  85         struct btree_iter *iter = __trans_next_iter(trans, idx);
  86
  87         while (iter && !__iter_has_node(iter, b))
  88                 iter = __trans_next_iter(trans, iter->idx + 1);
  89
  90         return iter;
  91 }
  92
  93 #define trans_for_each_iter_with_node(_trans, _b, _iter)                \
  94         for (_iter = __trans_next_iter_with_node((_trans), (_b), 0);    \
  95              (_iter);                                                   \
  96              _iter = __trans_next_iter_with_node((_trans), (_b),        \
  97                                                  (_iter)->idx + 1))
  98
  99 #ifdef CONFIG_BCACHEFS_DEBUG
 100 void bch2_btree_trans_verify_iters(struct btree_trans *, struct btree *);
 101 void bch2_btree_trans_verify_locks(struct btree_trans *);
 102 #else
 103 static inline void bch2_btree_trans_verify_iters(struct btree_trans *trans,
 104                                                  struct btree *b) {}
 105 static inline void bch2_btree_trans_verify_locks(struct btree_trans *iter) {}
 106 #endif
 107
 108 void bch2_btree_iter_fix_key_modified(struct btree_iter *, struct btree *,
 109                                            struct bkey_packed *);
 110 void bch2_btree_node_iter_fix(struct btree_iter *, struct btree *,
 111                               struct btree_node_iter *, struct bkey_packed *,
 112                               unsigned, unsigned);
 113
 114 bool bch2_trans_relock(struct btree_trans *);
 115 void bch2_trans_unlock(struct btree_trans *);
 116
 117 bool __bch2_btree_iter_upgrade(struct btree_iter *, unsigned);
 118
 119 static inline bool bch2_btree_iter_upgrade(struct btree_iter *iter,
 120                                            unsigned new_locks_want)
 121 {
 122         new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
 123
 124         return iter->locks_want < new_locks_want
 125                 ? __bch2_btree_iter_upgrade(iter, new_locks_want)
 126                 : iter->uptodate <= BTREE_ITER_NEED_PEEK;
 127 }
 128
 129 void __bch2_btree_iter_downgrade(struct btree_iter *, unsigned);
 130
 131 static inline void bch2_btree_iter_downgrade(struct btree_iter *iter)
 132 {
 133         unsigned new_locks_want = (iter->flags & BTREE_ITER_INTENT ? 1 : 0);
 134
 135         if (iter->locks_want > new_locks_want)
 136                 __bch2_btree_iter_downgrade(iter, new_locks_want);
 137 }
 138
 139 void bch2_trans_downgrade(struct btree_trans *);
 140
 141 void bch2_btree_iter_node_replace(struct btree_iter *, struct btree *);
 142 void bch2_btree_iter_node_drop(struct btree_iter *, struct btree *);
 143
 144 void bch2_btree_iter_reinit_node(struct btree_iter *, struct btree *);
 145
 146 int __must_check bch2_btree_iter_traverse(struct btree_iter *);
 147
 148 int bch2_btree_iter_traverse_all(struct btree_trans *);
 149
 150 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
 151 struct btree *bch2_btree_iter_next_node(struct btree_iter *);
 152
 153 struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *);
 154 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
 155
 156 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
 157 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
 158
 159 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
 160 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
 161 struct bkey_s_c bch2_btree_iter_prev_slot(struct btree_iter *);
 162
 163 struct bkey_s_c bch2_btree_iter_peek_cached(struct btree_iter *);
 164
 165 bool bch2_btree_iter_advance(struct btree_iter *);
 166 bool bch2_btree_iter_rewind(struct btree_iter *);
 167
 168 static inline void bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
 169 {
 170         if (!(iter->flags & BTREE_ITER_ALL_SNAPSHOTS))
 171                 new_pos.snapshot = iter->snapshot;
 172
 173         iter->k.type = KEY_TYPE_deleted;
 174         iter->k.p.inode         = iter->pos.inode       = new_pos.inode;
 175         iter->k.p.offset        = iter->pos.offset      = new_pos.offset;
 176         iter->k.p.snapshot      = iter->pos.snapshot    = new_pos.snapshot;
 177         iter->k.size = 0;
 178         iter->should_be_locked = false;
 179 }
 180
 181 static inline struct btree_iter *btree_iter_child(struct btree_iter *iter)
 182 {
 183         return iter->child_idx == U8_MAX ? NULL
 184                 : iter->trans->iters + iter->child_idx;
 185 }
 186
 187 /* Sort order for locking btree iterators: */
 188 static inline int btree_iter_lock_cmp(const struct btree_iter *l,
 189                                       const struct btree_iter *r)
 190 {
 191         return   cmp_int(l->btree_id, r->btree_id) ?:
 192                 -cmp_int(btree_iter_is_cached(l), btree_iter_is_cached(r)) ?:
 193                  bkey_cmp(l->real_pos, r->real_pos);
 194 }
 195
 196 /*
 197  * Unlocks before scheduling
 198  * Note: does not revalidate iterator
 199  */
 200 static inline int bch2_trans_cond_resched(struct btree_trans *trans)
 201 {
 202         if (need_resched() || race_fault()) {
 203                 bch2_trans_unlock(trans);
 204                 schedule();
 205                 return bch2_trans_relock(trans) ? 0 : -EINTR;
 206         } else {
 207                 return 0;
 208         }
 209 }
 210
 211 #define __for_each_btree_node(_trans, _iter, _btree_id, _start, \
 212                               _locks_want, _depth, _flags, _b)          \
 213         for (iter = bch2_trans_get_node_iter((_trans), (_btree_id),     \
 214                                 _start, _locks_want, _depth, _flags),   \
 215              _b = bch2_btree_iter_peek_node(_iter);                     \
 216              (_b);                                                      \
 217              (_b) = bch2_btree_iter_next_node(_iter))
 218
 219 #define for_each_btree_node(_trans, _iter, _btree_id, _start,           \
 220                             _flags, _b)                                 \
 221         __for_each_btree_node(_trans, _iter, _btree_id, _start,         \
 222                               0, 0, _flags, _b)
 223
 224 static inline struct bkey_s_c __bch2_btree_iter_peek(struct btree_iter *iter,
 225                                                      unsigned flags)
 226 {
 227         if ((flags & BTREE_ITER_TYPE) == BTREE_ITER_CACHED)
 228                 return bch2_btree_iter_peek_cached(iter);
 229         else
 230                 return flags & BTREE_ITER_SLOTS
 231                         ? bch2_btree_iter_peek_slot(iter)
 232                         : bch2_btree_iter_peek(iter);
 233 }
 234
 235 static inline struct bkey_s_c __bch2_btree_iter_next(struct btree_iter *iter,
 236                                                      unsigned flags)
 237 {
 238         return flags & BTREE_ITER_SLOTS
 239                 ? bch2_btree_iter_next_slot(iter)
 240                 : bch2_btree_iter_next(iter);
 241 }
 242
 243 static inline int bkey_err(struct bkey_s_c k)
 244 {
 245         return PTR_ERR_OR_ZERO(k.k);
 246 }
 247
 248 #define for_each_btree_key(_trans, _iter, _btree_id,                    \
 249                            _start, _flags, _k, _ret)                    \
 250         for ((_iter) = bch2_trans_get_iter((_trans), (_btree_id),       \
 251                                            (_start), (_flags)),         \
 252              (_k) = __bch2_btree_iter_peek(_iter, _flags);              \
 253              !((_ret) = bkey_err(_k)) && (_k).k;                        \
 254              (_k) = __bch2_btree_iter_next(_iter, _flags))
 255
 256 #define for_each_btree_key_continue(_iter, _flags, _k, _ret)            \
 257         for ((_k) = __bch2_btree_iter_peek(_iter, _flags);              \
 258              !((_ret) = bkey_err(_k)) && (_k).k;                        \
 259              (_k) = __bch2_btree_iter_next(_iter, _flags))
 260
 261 /* new multiple iterator interface: */
 262
 263 int bch2_trans_iter_put(struct btree_trans *, struct btree_iter *);
 264 int bch2_trans_iter_free(struct btree_trans *, struct btree_iter *);
 265
 266 void bch2_trans_unlink_iters(struct btree_trans *);
 267
 268 struct btree_iter *__bch2_trans_get_iter(struct btree_trans *, enum btree_id,
 269                                          struct bpos, unsigned,
 270                                          unsigned, unsigned);
 271
 272 static inline struct btree_iter *
 273 bch2_trans_get_iter(struct btree_trans *trans, enum btree_id btree_id,
 274                     struct bpos pos, unsigned flags)
 275 {
 276         struct btree_iter *iter =
 277                 __bch2_trans_get_iter(trans, btree_id, pos,
 278                                       (flags & BTREE_ITER_INTENT) != 0, 0,
 279                                       flags);
 280         iter->ip_allocated = _THIS_IP_;
 281         return iter;
 282 }
 283
 284 struct btree_iter *__bch2_trans_copy_iter(struct btree_trans *,
 285                                         struct btree_iter *);
 286 static inline struct btree_iter *
 287 bch2_trans_copy_iter(struct btree_trans *trans, struct btree_iter *src)
 288 {
 289         struct btree_iter *iter =
 290                 __bch2_trans_copy_iter(trans, src);
 291
 292         iter->ip_allocated = _THIS_IP_;
 293         return iter;
 294 }
 295
 296 struct btree_iter *bch2_trans_get_node_iter(struct btree_trans *,
 297                                 enum btree_id, struct bpos,
 298                                 unsigned, unsigned, unsigned);
 299
 300 static inline bool btree_iter_live(struct btree_trans *trans, struct btree_iter *iter)
 301 {
 302         return (trans->iters_live & (1ULL << iter->idx)) != 0;
 303 }
 304
 305 static inline bool btree_iter_keep(struct btree_trans *trans, struct btree_iter *iter)
 306 {
 307         return btree_iter_live(trans, iter) ||
 308                 (iter->flags & BTREE_ITER_KEEP_UNTIL_COMMIT);
 309 }
 310
 311 static inline void set_btree_iter_dontneed(struct btree_trans *trans, struct btree_iter *iter)
 312 {
 313         trans->iters_touched &= ~(1ULL << iter->idx);
 314 }
 315
 316 #define TRANS_RESET_NOTRAVERSE          (1 << 0)
 317 #define TRANS_RESET_NOUNLOCK            (1 << 1)
 318
 319 void bch2_trans_reset(struct btree_trans *, unsigned);
 320
 321 static inline void bch2_trans_begin(struct btree_trans *trans)
 322 {
 323         return bch2_trans_reset(trans, 0);
 324 }
 325
 326 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
 327 void bch2_trans_init(struct btree_trans *, struct bch_fs *, unsigned, size_t);
 328 int bch2_trans_exit(struct btree_trans *);
 329
 330 void bch2_btree_trans_to_text(struct printbuf *, struct bch_fs *);
 331
 332 void bch2_fs_btree_iter_exit(struct bch_fs *);
 333 int bch2_fs_btree_iter_init(struct bch_fs *);
 334
 335 #endif /* _BCACHEFS_BTREE_ITER_H */