]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/btree_iter.h
Update bcachefs sources to 72405e7ff8 bcachefs: Fix bch2_check_extents_to_backpointers()
[bcachefs-tools-debian] / 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 #include <trace/events/bcachefs.h>
9
10 static inline void __btree_path_get(struct btree_path *path, bool intent)
11 {
12         path->ref++;
13         path->intent_ref += intent;
14 }
15
16 static inline bool __btree_path_put(struct btree_path *path, bool intent)
17 {
18         EBUG_ON(!path->ref);
19         EBUG_ON(!path->intent_ref && intent);
20         path->intent_ref -= intent;
21         return --path->ref == 0;
22 }
23
24 static inline void btree_path_set_dirty(struct btree_path *path,
25                                         enum btree_path_uptodate u)
26 {
27         path->uptodate = max_t(unsigned, path->uptodate, u);
28 }
29
30 static inline struct btree *btree_path_node(struct btree_path *path,
31                                             unsigned level)
32 {
33         return level < BTREE_MAX_DEPTH ? path->l[level].b : NULL;
34 }
35
36 static inline bool btree_node_lock_seq_matches(const struct btree_path *path,
37                                         const struct btree *b, unsigned level)
38 {
39         /*
40          * We don't compare the low bits of the lock sequence numbers because
41          * @path might have taken a write lock on @b, and we don't want to skip
42          * the linked path if the sequence numbers were equal before taking that
43          * write lock. The lock sequence number is incremented by taking and
44          * releasing write locks and is even when unlocked:
45          */
46         return path->l[level].lock_seq >> 1 == b->c.lock.state.seq >> 1;
47 }
48
49 static inline struct btree *btree_node_parent(struct btree_path *path,
50                                               struct btree *b)
51 {
52         return btree_path_node(path, b->c.level + 1);
53 }
54
55 /* Iterate over paths within a transaction: */
56
57 void __bch2_btree_trans_sort_paths(struct btree_trans *);
58
59 static inline void btree_trans_sort_paths(struct btree_trans *trans)
60 {
61         if (!IS_ENABLED(CONFIG_BCACHEFS_DEBUG) &&
62             trans->paths_sorted)
63                 return;
64         __bch2_btree_trans_sort_paths(trans);
65 }
66
67 static inline struct btree_path *
68 __trans_next_path(struct btree_trans *trans, unsigned idx)
69 {
70         u64 l;
71
72         if (idx == BTREE_ITER_MAX)
73                 return NULL;
74
75         l = trans->paths_allocated >> idx;
76         if (!l)
77                 return NULL;
78
79         idx += __ffs64(l);
80         EBUG_ON(idx >= BTREE_ITER_MAX);
81         EBUG_ON(trans->paths[idx].idx != idx);
82         return &trans->paths[idx];
83 }
84
85 #define trans_for_each_path_from(_trans, _path, _start)                 \
86         for (_path = __trans_next_path((_trans), _start);               \
87              (_path);                                                   \
88              _path = __trans_next_path((_trans), (_path)->idx + 1))
89
90 #define trans_for_each_path(_trans, _path)                              \
91         trans_for_each_path_from(_trans, _path, 0)
92
93 static inline struct btree_path *next_btree_path(struct btree_trans *trans, struct btree_path *path)
94 {
95         unsigned idx = path ? path->sorted_idx + 1 : 0;
96
97         EBUG_ON(idx > trans->nr_sorted);
98
99         return idx < trans->nr_sorted
100                 ? trans->paths + trans->sorted[idx]
101                 : NULL;
102 }
103
104 static inline struct btree_path *prev_btree_path(struct btree_trans *trans, struct btree_path *path)
105 {
106         unsigned idx = path ? path->sorted_idx : trans->nr_sorted;
107
108         return idx
109                 ? trans->paths + trans->sorted[idx - 1]
110                 : NULL;
111 }
112
113 #define trans_for_each_path_inorder(_trans, _path, _i)                  \
114         for (_i = 0;                                                    \
115              ((_path) = (_trans)->paths + trans->sorted[_i]), (_i) < (_trans)->nr_sorted;\
116              _i++)
117
118 #define trans_for_each_path_inorder_reverse(_trans, _path, _i)          \
119         for (_i = trans->nr_sorted - 1;                                 \
120              ((_path) = (_trans)->paths + trans->sorted[_i]), (_i) >= 0;\
121              --_i)
122
123 static inline bool __path_has_node(const struct btree_path *path,
124                                    const struct btree *b)
125 {
126         return path->l[b->c.level].b == b &&
127                 btree_node_lock_seq_matches(path, b, b->c.level);
128 }
129
130 static inline struct btree_path *
131 __trans_next_path_with_node(struct btree_trans *trans, struct btree *b,
132                             unsigned idx)
133 {
134         struct btree_path *path = __trans_next_path(trans, idx);
135
136         while (path && !__path_has_node(path, b))
137                 path = __trans_next_path(trans, path->idx + 1);
138
139         return path;
140 }
141
142 #define trans_for_each_path_with_node(_trans, _b, _path)                \
143         for (_path = __trans_next_path_with_node((_trans), (_b), 0);    \
144              (_path);                                                   \
145              _path = __trans_next_path_with_node((_trans), (_b),        \
146                                                  (_path)->idx + 1))
147
148 struct btree_path *__bch2_btree_path_make_mut(struct btree_trans *, struct btree_path *,
149                          bool, unsigned long);
150
151 static inline struct btree_path * __must_check
152 bch2_btree_path_make_mut(struct btree_trans *trans,
153                          struct btree_path *path, bool intent,
154                          unsigned long ip)
155 {
156         if (path->ref > 1 || path->preserve)
157                 path = __bch2_btree_path_make_mut(trans, path, intent, ip);
158         path->should_be_locked = false;
159         return path;
160 }
161
162 struct btree_path * __must_check
163 __bch2_btree_path_set_pos(struct btree_trans *, struct btree_path *,
164                         struct bpos, bool, unsigned long, int);
165
166 static inline struct btree_path * __must_check
167 bch2_btree_path_set_pos(struct btree_trans *trans,
168                    struct btree_path *path, struct bpos new_pos,
169                    bool intent, unsigned long ip)
170 {
171         int cmp = bpos_cmp(new_pos, path->pos);
172
173         return cmp
174                 ? __bch2_btree_path_set_pos(trans, path, new_pos, intent, ip, cmp)
175                 : path;
176 }
177
178 int __must_check bch2_btree_path_traverse_one(struct btree_trans *, struct btree_path *,
179                                               unsigned, unsigned long);
180
181 static inline int __must_check bch2_btree_path_traverse(struct btree_trans *trans,
182                                           struct btree_path *path, unsigned flags)
183 {
184         if (path->uptodate < BTREE_ITER_NEED_RELOCK)
185                 return 0;
186
187         return bch2_btree_path_traverse_one(trans, path, flags, _RET_IP_);
188 }
189
190 int __must_check bch2_btree_path_traverse(struct btree_trans *,
191                                           struct btree_path *, unsigned);
192 struct btree_path *bch2_path_get(struct btree_trans *, enum btree_id, struct bpos,
193                                  unsigned, unsigned, unsigned, unsigned long);
194 struct bkey_s_c bch2_btree_path_peek_slot(struct btree_path *, struct bkey *);
195
196 struct bkey_i *bch2_btree_journal_peek_slot(struct btree_trans *,
197                                         struct btree_iter *, struct bpos);
198
199 void bch2_btree_path_level_init(struct btree_trans *, struct btree_path *, struct btree *);
200
201 int __bch2_trans_mutex_lock(struct btree_trans *, struct mutex *);
202
203 static inline int bch2_trans_mutex_lock(struct btree_trans *trans, struct mutex *lock)
204 {
205         return mutex_trylock(lock)
206                 ? 0
207                 : __bch2_trans_mutex_lock(trans, lock);
208 }
209
210 #ifdef CONFIG_BCACHEFS_DEBUG
211 void bch2_trans_verify_paths(struct btree_trans *);
212 void bch2_assert_pos_locked(struct btree_trans *, enum btree_id,
213                             struct bpos, bool);
214 #else
215 static inline void bch2_trans_verify_paths(struct btree_trans *trans) {}
216 static inline void bch2_assert_pos_locked(struct btree_trans *trans, enum btree_id id,
217                                           struct bpos pos, bool key_cache) {}
218 #endif
219
220 void bch2_btree_path_fix_key_modified(struct btree_trans *trans,
221                                       struct btree *, struct bkey_packed *);
222 void bch2_btree_node_iter_fix(struct btree_trans *trans, struct btree_path *,
223                               struct btree *, struct btree_node_iter *,
224                               struct bkey_packed *, unsigned, unsigned);
225
226 int bch2_btree_path_relock_intent(struct btree_trans *, struct btree_path *);
227
228 void bch2_path_put(struct btree_trans *, struct btree_path *, bool);
229
230 int bch2_trans_relock(struct btree_trans *);
231 int bch2_trans_relock_notrace(struct btree_trans *);
232 void bch2_trans_unlock(struct btree_trans *);
233 bool bch2_trans_locked(struct btree_trans *);
234
235 static inline bool trans_was_restarted(struct btree_trans *trans, u32 restart_count)
236 {
237         return restart_count != trans->restart_count;
238 }
239
240 void bch2_trans_restart_error(struct btree_trans *, u32);
241
242 static inline void bch2_trans_verify_not_restarted(struct btree_trans *trans,
243                                                    u32 restart_count)
244 {
245         if (trans_was_restarted(trans, restart_count))
246                 bch2_trans_restart_error(trans, restart_count);
247 }
248
249 void bch2_trans_in_restart_error(struct btree_trans *);
250
251 static inline void bch2_trans_verify_not_in_restart(struct btree_trans *trans)
252 {
253         if (trans->restarted)
254                 bch2_trans_in_restart_error(trans);
255 }
256
257 __always_inline
258 static inline int btree_trans_restart_nounlock(struct btree_trans *trans, int err)
259 {
260         BUG_ON(err <= 0);
261         BUG_ON(!bch2_err_matches(err, BCH_ERR_transaction_restart));
262
263         trans->restarted = err;
264         trans->last_restarted_ip = _THIS_IP_;
265         return -err;
266 }
267
268 __always_inline
269 static inline int btree_trans_restart(struct btree_trans *trans, int err)
270 {
271         btree_trans_restart_nounlock(trans, err);
272         return -err;
273 }
274
275 bool bch2_btree_node_upgrade(struct btree_trans *,
276                              struct btree_path *, unsigned);
277
278 void __bch2_btree_path_downgrade(struct btree_trans *, struct btree_path *, unsigned);
279
280 static inline void bch2_btree_path_downgrade(struct btree_trans *trans,
281                                              struct btree_path *path)
282 {
283         unsigned new_locks_want = path->level + !!path->intent_ref;
284
285         if (path->locks_want > new_locks_want)
286                 __bch2_btree_path_downgrade(trans, path, new_locks_want);
287 }
288
289 void bch2_trans_downgrade(struct btree_trans *);
290
291 void bch2_trans_node_add(struct btree_trans *trans, struct btree *);
292 void bch2_trans_node_reinit_iter(struct btree_trans *, struct btree *);
293
294 int __must_check __bch2_btree_iter_traverse(struct btree_iter *iter);
295 int __must_check bch2_btree_iter_traverse(struct btree_iter *);
296
297 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
298 struct btree *bch2_btree_iter_peek_node_and_restart(struct btree_iter *);
299 struct btree *bch2_btree_iter_next_node(struct btree_iter *);
300
301 struct bkey_s_c bch2_btree_iter_peek_upto(struct btree_iter *, struct bpos);
302 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
303
304 struct bkey_s_c bch2_btree_iter_peek_all_levels(struct btree_iter *);
305
306 static inline struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *iter)
307 {
308         return bch2_btree_iter_peek_upto(iter, SPOS_MAX);
309 }
310
311 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
312 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
313
314 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
315 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
316 struct bkey_s_c bch2_btree_iter_prev_slot(struct btree_iter *);
317
318 bool bch2_btree_iter_advance(struct btree_iter *);
319 bool bch2_btree_iter_rewind(struct btree_iter *);
320
321 static inline void __bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
322 {
323         iter->k.type = KEY_TYPE_deleted;
324         iter->k.p.inode         = iter->pos.inode       = new_pos.inode;
325         iter->k.p.offset        = iter->pos.offset      = new_pos.offset;
326         iter->k.p.snapshot      = iter->pos.snapshot    = new_pos.snapshot;
327         iter->k.size = 0;
328 }
329
330 static inline void bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
331 {
332         if (unlikely(iter->update_path))
333                 bch2_path_put(iter->trans, iter->update_path,
334                               iter->flags & BTREE_ITER_INTENT);
335         iter->update_path = NULL;
336
337         if (!(iter->flags & BTREE_ITER_ALL_SNAPSHOTS))
338                 new_pos.snapshot = iter->snapshot;
339
340         __bch2_btree_iter_set_pos(iter, new_pos);
341 }
342
343 static inline void bch2_btree_iter_set_pos_to_extent_start(struct btree_iter *iter)
344 {
345         BUG_ON(!(iter->flags & BTREE_ITER_IS_EXTENTS));
346         iter->pos = bkey_start_pos(&iter->k);
347 }
348
349 static inline void bch2_btree_iter_set_snapshot(struct btree_iter *iter, u32 snapshot)
350 {
351         struct bpos pos = iter->pos;
352
353         iter->snapshot = snapshot;
354         pos.snapshot = snapshot;
355         bch2_btree_iter_set_pos(iter, pos);
356 }
357
358 void bch2_trans_iter_exit(struct btree_trans *, struct btree_iter *);
359
360 static inline unsigned __bch2_btree_iter_flags(struct btree_trans *trans,
361                                                unsigned btree_id,
362                                                unsigned flags)
363 {
364         if (flags & BTREE_ITER_ALL_LEVELS)
365                 flags |= BTREE_ITER_ALL_SNAPSHOTS|__BTREE_ITER_ALL_SNAPSHOTS;
366
367         if (!(flags & (BTREE_ITER_ALL_SNAPSHOTS|BTREE_ITER_NOT_EXTENTS)) &&
368             btree_node_type_is_extents(btree_id))
369                 flags |= BTREE_ITER_IS_EXTENTS;
370
371         if (!(flags & __BTREE_ITER_ALL_SNAPSHOTS) &&
372             !btree_type_has_snapshots(btree_id))
373                 flags &= ~BTREE_ITER_ALL_SNAPSHOTS;
374
375         if (!(flags & BTREE_ITER_ALL_SNAPSHOTS) &&
376             btree_type_has_snapshots(btree_id))
377                 flags |= BTREE_ITER_FILTER_SNAPSHOTS;
378
379         if (trans->journal_replay_not_finished)
380                 flags |= BTREE_ITER_WITH_JOURNAL;
381
382         return flags;
383 }
384
385 static inline unsigned bch2_btree_iter_flags(struct btree_trans *trans,
386                                              unsigned btree_id,
387                                              unsigned flags)
388 {
389         if (!btree_id_cached(trans->c, btree_id)) {
390                 flags &= ~BTREE_ITER_CACHED;
391                 flags &= ~BTREE_ITER_WITH_KEY_CACHE;
392         } else if (!(flags & BTREE_ITER_CACHED))
393                 flags |= BTREE_ITER_WITH_KEY_CACHE;
394
395         return __bch2_btree_iter_flags(trans, btree_id, flags);
396 }
397
398 static inline void bch2_trans_iter_init_common(struct btree_trans *trans,
399                                           struct btree_iter *iter,
400                                           unsigned btree_id, struct bpos pos,
401                                           unsigned locks_want,
402                                           unsigned depth,
403                                           unsigned flags,
404                                           unsigned long ip)
405 {
406         memset(iter, 0, sizeof(*iter));
407         iter->trans     = trans;
408         iter->btree_id  = btree_id;
409         iter->flags     = flags;
410         iter->snapshot  = pos.snapshot;
411         iter->pos       = pos;
412         iter->k.p       = pos;
413
414 #ifdef CONFIG_BCACHEFS_DEBUG
415         iter->ip_allocated = ip;
416 #endif
417         iter->path = bch2_path_get(trans, btree_id, iter->pos,
418                                    locks_want, depth, flags, ip);
419 }
420
421 void bch2_trans_iter_init_outlined(struct btree_trans *, struct btree_iter *,
422                           unsigned, struct bpos, unsigned);
423
424 static inline void bch2_trans_iter_init(struct btree_trans *trans,
425                           struct btree_iter *iter,
426                           unsigned btree_id, struct bpos pos,
427                           unsigned flags)
428 {
429         if (__builtin_constant_p(btree_id) &&
430             __builtin_constant_p(flags))
431                 bch2_trans_iter_init_common(trans, iter, btree_id, pos, 0, 0,
432                                 bch2_btree_iter_flags(trans, btree_id, flags),
433                                 _THIS_IP_);
434         else
435                 bch2_trans_iter_init_outlined(trans, iter, btree_id, pos, flags);
436 }
437
438 void bch2_trans_node_iter_init(struct btree_trans *, struct btree_iter *,
439                                enum btree_id, struct bpos,
440                                unsigned, unsigned, unsigned);
441 void bch2_trans_copy_iter(struct btree_iter *, struct btree_iter *);
442
443 static inline void set_btree_iter_dontneed(struct btree_iter *iter)
444 {
445         if (!iter->trans->restarted)
446                 iter->path->preserve = false;
447 }
448
449 void *__bch2_trans_kmalloc(struct btree_trans *, size_t);
450
451 static inline void *bch2_trans_kmalloc(struct btree_trans *trans, size_t size)
452 {
453         size = roundup(size, 8);
454
455         if (likely(trans->mem_top + size <= trans->mem_bytes)) {
456                 void *p = trans->mem + trans->mem_top;
457
458                 trans->mem_top += size;
459                 memset(p, 0, size);
460                 return p;
461         } else {
462                 return __bch2_trans_kmalloc(trans, size);
463         }
464 }
465
466 static inline void *bch2_trans_kmalloc_nomemzero(struct btree_trans *trans, size_t size)
467 {
468         size = roundup(size, 8);
469
470         if (likely(trans->mem_top + size <= trans->mem_bytes)) {
471                 void *p = trans->mem + trans->mem_top;
472
473                 trans->mem_top += size;
474                 return p;
475         } else {
476                 return __bch2_trans_kmalloc(trans, size);
477         }
478 }
479
480 static inline struct bkey_i *bch2_bkey_make_mut(struct btree_trans *trans, struct bkey_s_c k)
481 {
482         struct bkey_i *mut = bch2_trans_kmalloc_nomemzero(trans, bkey_bytes(k.k));
483
484         if (!IS_ERR(mut))
485                 bkey_reassemble(mut, k);
486         return mut;
487 }
488
489 static inline struct bkey_i *bch2_bkey_get_mut(struct btree_trans *trans,
490                                                struct btree_iter *iter)
491 {
492         struct bkey_s_c k = bch2_btree_iter_peek_slot(iter);
493
494         return unlikely(IS_ERR(k.k))
495                 ? ERR_CAST(k.k)
496                 : bch2_bkey_make_mut(trans, k);
497 }
498
499 #define bch2_bkey_get_mut_typed(_trans, _iter, _type)                   \
500 ({                                                                      \
501         struct bkey_i *_k = bch2_bkey_get_mut(_trans, _iter);           \
502         struct bkey_i_##_type *_ret;                                    \
503                                                                         \
504         if (IS_ERR(_k))                                                 \
505                 _ret = ERR_CAST(_k);                                    \
506         else if (unlikely(_k->k.type != KEY_TYPE_##_type))              \
507                 _ret = ERR_PTR(-ENOENT);                                \
508         else                                                            \
509                 _ret = bkey_i_to_##_type(_k);                           \
510         _ret;                                                           \
511 })
512
513 #define bch2_bkey_alloc(_trans, _iter, _type)                           \
514 ({                                                                      \
515         struct bkey_i_##_type *_k = bch2_trans_kmalloc_nomemzero(_trans, sizeof(*_k));\
516         if (!IS_ERR(_k)) {                                              \
517                 bkey_##_type##_init(&_k->k_i);                          \
518                 _k->k.p = (_iter)->pos;                                 \
519         }                                                               \
520         _k;                                                             \
521 })
522
523 u32 bch2_trans_begin(struct btree_trans *);
524
525 /*
526  * XXX
527  * this does not handle transaction restarts from bch2_btree_iter_next_node()
528  * correctly
529  */
530 #define __for_each_btree_node(_trans, _iter, _btree_id, _start,         \
531                               _locks_want, _depth, _flags, _b, _ret)    \
532         for (bch2_trans_node_iter_init((_trans), &(_iter), (_btree_id), \
533                                 _start, _locks_want, _depth, _flags);   \
534              (_b) = bch2_btree_iter_peek_node_and_restart(&(_iter)),    \
535              !((_ret) = PTR_ERR_OR_ZERO(_b)) && (_b);                   \
536              (_b) = bch2_btree_iter_next_node(&(_iter)))
537
538 #define for_each_btree_node(_trans, _iter, _btree_id, _start,           \
539                             _flags, _b, _ret)                           \
540         __for_each_btree_node(_trans, _iter, _btree_id, _start,         \
541                               0, 0, _flags, _b, _ret)
542
543 static inline int bkey_err(struct bkey_s_c k)
544 {
545         return PTR_ERR_OR_ZERO(k.k);
546 }
547
548 static inline struct bkey_s_c bch2_btree_iter_peek_prev_type(struct btree_iter *iter,
549                                                              unsigned flags)
550 {
551         BUG_ON(flags & BTREE_ITER_ALL_LEVELS);
552
553         return  flags & BTREE_ITER_SLOTS      ? bch2_btree_iter_peek_slot(iter) :
554                                                 bch2_btree_iter_peek_prev(iter);
555 }
556
557 static inline struct bkey_s_c bch2_btree_iter_peek_type(struct btree_iter *iter,
558                                                         unsigned flags)
559 {
560         return  flags & BTREE_ITER_ALL_LEVELS ? bch2_btree_iter_peek_all_levels(iter) :
561                 flags & BTREE_ITER_SLOTS      ? bch2_btree_iter_peek_slot(iter) :
562                                                 bch2_btree_iter_peek(iter);
563 }
564
565 static inline struct bkey_s_c bch2_btree_iter_peek_upto_type(struct btree_iter *iter,
566                                                              struct bpos end,
567                                                              unsigned flags)
568 {
569         if (!(flags & BTREE_ITER_SLOTS))
570                 return bch2_btree_iter_peek_upto(iter, end);
571
572         if (bkey_gt(iter->pos, end))
573                 return bkey_s_c_null;
574
575         return bch2_btree_iter_peek_slot(iter);
576 }
577
578 static inline int btree_trans_too_many_iters(struct btree_trans *trans)
579 {
580         if (hweight64(trans->paths_allocated) > BTREE_ITER_MAX - 8) {
581                 trace_and_count(trans->c, trans_restart_too_many_iters, trans, _THIS_IP_);
582                 return btree_trans_restart(trans, BCH_ERR_transaction_restart_too_many_iters);
583         }
584
585         return 0;
586 }
587
588 struct bkey_s_c bch2_btree_iter_peek_and_restart_outlined(struct btree_iter *);
589
590 static inline struct bkey_s_c
591 __bch2_btree_iter_peek_and_restart(struct btree_trans *trans,
592                                    struct btree_iter *iter, unsigned flags)
593 {
594         struct bkey_s_c k;
595
596         while (btree_trans_too_many_iters(trans) ||
597                (k = bch2_btree_iter_peek_type(iter, flags),
598                 bch2_err_matches(bkey_err(k), BCH_ERR_transaction_restart)))
599                 bch2_trans_begin(trans);
600
601         return k;
602 }
603
604 static inline struct bkey_s_c
605 __bch2_btree_iter_peek_upto_and_restart(struct btree_trans *trans,
606                                         struct btree_iter *iter,
607                                         struct bpos end,
608                                         unsigned flags)
609 {
610         struct bkey_s_c k;
611
612         while (btree_trans_too_many_iters(trans) ||
613                (k = bch2_btree_iter_peek_upto_type(iter, end, flags),
614                 bch2_err_matches(bkey_err(k), BCH_ERR_transaction_restart)))
615                 bch2_trans_begin(trans);
616
617         return k;
618 }
619
620 #define lockrestart_do(_trans, _do)                                     \
621 ({                                                                      \
622         u32 _restart_count;                                             \
623         int _ret;                                                       \
624                                                                         \
625         do {                                                            \
626                 _restart_count = bch2_trans_begin(_trans);              \
627                 _ret = (_do);                                           \
628         } while (bch2_err_matches(_ret, BCH_ERR_transaction_restart));  \
629                                                                         \
630         if (!_ret)                                                      \
631                 bch2_trans_verify_not_restarted(_trans, _restart_count);\
632                                                                         \
633         _ret;                                                           \
634 })
635
636 /*
637  * nested_lockrestart_do(), nested_commit_do():
638  *
639  * These are like lockrestart_do() and commit_do(), with two differences:
640  *
641  *  - We don't call bch2_trans_begin() unless we had a transaction restart
642  *  - We return -BCH_ERR_transaction_restart_nested if we succeeded after a
643  *  transaction restart
644  */
645 #define nested_lockrestart_do(_trans, _do)                              \
646 ({                                                                      \
647         u32 _restart_count, _orig_restart_count;                        \
648         int _ret;                                                       \
649                                                                         \
650         _restart_count = _orig_restart_count = (_trans)->restart_count; \
651                                                                         \
652         while (bch2_err_matches(_ret = (_do), BCH_ERR_transaction_restart))\
653                 _restart_count = bch2_trans_begin(_trans);              \
654                                                                         \
655         if (!_ret)                                                      \
656                 bch2_trans_verify_not_restarted(_trans, _restart_count);\
657                                                                         \
658         if (!_ret && trans_was_restarted(_trans, _orig_restart_count))  \
659                 _ret = -BCH_ERR_transaction_restart_nested;             \
660                                                                         \
661         _ret;                                                           \
662 })
663
664 #define for_each_btree_key2(_trans, _iter, _btree_id,                   \
665                             _start, _flags, _k, _do)                    \
666 ({                                                                      \
667         int _ret = 0;                                                   \
668                                                                         \
669         bch2_trans_iter_init((_trans), &(_iter), (_btree_id),           \
670                              (_start), (_flags));                       \
671                                                                         \
672         while (1) {                                                     \
673                 u32 _restart_count = bch2_trans_begin(_trans);          \
674                                                                         \
675                 _ret = 0;                                               \
676                 (_k) = bch2_btree_iter_peek_type(&(_iter), (_flags));   \
677                 if (!(_k).k)                                            \
678                         break;                                          \
679                                                                         \
680                 _ret = bkey_err(_k) ?: (_do);                           \
681                 if (bch2_err_matches(_ret, BCH_ERR_transaction_restart))\
682                         continue;                                       \
683                 if (_ret)                                               \
684                         break;                                          \
685                 bch2_trans_verify_not_restarted(_trans, _restart_count);\
686                 if (!bch2_btree_iter_advance(&(_iter)))                 \
687                         break;                                          \
688         }                                                               \
689                                                                         \
690         bch2_trans_iter_exit((_trans), &(_iter));                       \
691         _ret;                                                           \
692 })
693
694 #define for_each_btree_key2_upto(_trans, _iter, _btree_id,              \
695                             _start, _end, _flags, _k, _do)              \
696 ({                                                                      \
697         int _ret = 0;                                                   \
698                                                                         \
699         bch2_trans_iter_init((_trans), &(_iter), (_btree_id),           \
700                              (_start), (_flags));                       \
701                                                                         \
702         while (1) {                                                     \
703                 u32 _restart_count = bch2_trans_begin(_trans);          \
704                                                                         \
705                 _ret = 0;                                               \
706                 (_k) = bch2_btree_iter_peek_upto_type(&(_iter), _end, (_flags));\
707                 if (!(_k).k)                                            \
708                         break;                                          \
709                                                                         \
710                 _ret = bkey_err(_k) ?: (_do);                           \
711                 if (bch2_err_matches(_ret, BCH_ERR_transaction_restart))\
712                         continue;                                       \
713                 if (_ret)                                               \
714                         break;                                          \
715                 bch2_trans_verify_not_restarted(_trans, _restart_count);\
716                 if (!bch2_btree_iter_advance(&(_iter)))                 \
717                         break;                                          \
718         }                                                               \
719                                                                         \
720         bch2_trans_iter_exit((_trans), &(_iter));                       \
721         _ret;                                                           \
722 })
723
724 #define for_each_btree_key_reverse(_trans, _iter, _btree_id,            \
725                                    _start, _flags, _k, _do)             \
726 ({                                                                      \
727         int _ret = 0;                                                   \
728                                                                         \
729         bch2_trans_iter_init((_trans), &(_iter), (_btree_id),           \
730                              (_start), (_flags));                       \
731                                                                         \
732         while (1) {                                                     \
733                 u32 _restart_count = bch2_trans_begin(_trans);          \
734                 (_k) = bch2_btree_iter_peek_prev_type(&(_iter), (_flags));\
735                 if (!(_k).k) {                                          \
736                         _ret = 0;                                       \
737                         break;                                          \
738                 }                                                       \
739                                                                         \
740                 _ret = bkey_err(_k) ?: (_do);                           \
741                 if (bch2_err_matches(_ret, BCH_ERR_transaction_restart))\
742                         continue;                                       \
743                 if (_ret)                                               \
744                         break;                                          \
745                 bch2_trans_verify_not_restarted(_trans, _restart_count);\
746                 if (!bch2_btree_iter_rewind(&(_iter)))                  \
747                         break;                                          \
748         }                                                               \
749                                                                         \
750         bch2_trans_iter_exit((_trans), &(_iter));                       \
751         _ret;                                                           \
752 })
753
754 #define for_each_btree_key_commit(_trans, _iter, _btree_id,             \
755                                   _start, _iter_flags, _k,              \
756                                   _disk_res, _journal_seq, _commit_flags,\
757                                   _do)                                  \
758         for_each_btree_key2(_trans, _iter, _btree_id, _start, _iter_flags, _k,\
759                             (_do) ?: bch2_trans_commit(_trans, (_disk_res),\
760                                         (_journal_seq), (_commit_flags)))
761
762 #define for_each_btree_key_upto_commit(_trans, _iter, _btree_id,        \
763                                   _start, _end, _iter_flags, _k,        \
764                                   _disk_res, _journal_seq, _commit_flags,\
765                                   _do)                                  \
766         for_each_btree_key2_upto(_trans, _iter, _btree_id, _start, _end, _iter_flags, _k,\
767                             (_do) ?: bch2_trans_commit(_trans, (_disk_res),\
768                                         (_journal_seq), (_commit_flags)))
769
770 #define for_each_btree_key(_trans, _iter, _btree_id,                    \
771                            _start, _flags, _k, _ret)                    \
772         for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id),      \
773                                   (_start), (_flags));                  \
774              (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
775              !((_ret) = bkey_err(_k)) && (_k).k;                        \
776              bch2_btree_iter_advance(&(_iter)))
777
778 #define for_each_btree_key_upto(_trans, _iter, _btree_id,               \
779                                 _start, _end, _flags, _k, _ret)         \
780         for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id),      \
781                                   (_start), (_flags));                  \
782              (_k) = __bch2_btree_iter_peek_upto_and_restart((_trans),   \
783                                                 &(_iter), _end, _flags),\
784              !((_ret) = bkey_err(_k)) && (_k).k;                        \
785              bch2_btree_iter_advance(&(_iter)))
786
787 #define for_each_btree_key_norestart(_trans, _iter, _btree_id,          \
788                            _start, _flags, _k, _ret)                    \
789         for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id),      \
790                                   (_start), (_flags));                  \
791              (_k) = bch2_btree_iter_peek_type(&(_iter), _flags),        \
792              !((_ret) = bkey_err(_k)) && (_k).k;                        \
793              bch2_btree_iter_advance(&(_iter)))
794
795 #define for_each_btree_key_upto_norestart(_trans, _iter, _btree_id,     \
796                            _start, _end, _flags, _k, _ret)              \
797         for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id),      \
798                                   (_start), (_flags));                  \
799              (_k) = bch2_btree_iter_peek_upto_type(&(_iter), _end, _flags),\
800              !((_ret) = bkey_err(_k)) && (_k).k;                        \
801              bch2_btree_iter_advance(&(_iter)))
802
803 #define for_each_btree_key_continue(_trans, _iter, _flags, _k, _ret)    \
804         for (;                                                          \
805              (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
806              !((_ret) = bkey_err(_k)) && (_k).k;                        \
807              bch2_btree_iter_advance(&(_iter)))
808
809 #define for_each_btree_key_continue_norestart(_iter, _flags, _k, _ret)  \
810         for (;                                                          \
811              (_k) = bch2_btree_iter_peek_type(&(_iter), _flags),        \
812              !((_ret) = bkey_err(_k)) && (_k).k;                        \
813              bch2_btree_iter_advance(&(_iter)))
814
815 #define for_each_btree_key_upto_continue_norestart(_iter, _end, _flags, _k, _ret)\
816         for (;                                                                  \
817              (_k) = bch2_btree_iter_peek_upto_type(&(_iter), _end, _flags),     \
818              !((_ret) = bkey_err(_k)) && (_k).k;                                \
819              bch2_btree_iter_advance(&(_iter)))
820
821 /* new multiple iterator interface: */
822
823 void bch2_trans_updates_to_text(struct printbuf *, struct btree_trans *);
824 void bch2_btree_path_to_text(struct printbuf *, struct btree_path *);
825 void bch2_trans_paths_to_text(struct printbuf *, struct btree_trans *);
826 void bch2_dump_trans_updates(struct btree_trans *);
827 void bch2_dump_trans_paths_updates(struct btree_trans *);
828 void __bch2_trans_init(struct btree_trans *, struct bch_fs *, unsigned);
829 void bch2_trans_exit(struct btree_trans *);
830
831 extern const char *bch2_btree_transaction_fns[BCH_TRANSACTIONS_NR];
832 unsigned bch2_trans_get_fn_idx(const char *);
833
834 #define bch2_trans_init(_trans, _c, _nr_iters, _mem)                    \
835 do {                                                                    \
836         static unsigned trans_fn_idx;                                   \
837                                                                         \
838         if (unlikely(!trans_fn_idx))                                    \
839                 trans_fn_idx = bch2_trans_get_fn_idx(__func__);         \
840                                                                         \
841         __bch2_trans_init(_trans, _c, trans_fn_idx);                    \
842 } while (0)
843
844 void bch2_btree_trans_to_text(struct printbuf *, struct btree_trans *);
845
846 void bch2_fs_btree_iter_exit(struct bch_fs *);
847 int bch2_fs_btree_iter_init(struct bch_fs *);
848
849 #endif /* _BCACHEFS_BTREE_ITER_H */