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