]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/btree_iter.h
Update bcachefs sources to 90a9c61e2b bcachefs: Switch bch2_btree_delete_range()...
[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 static inline struct btree_path *
58 __trans_next_path(struct btree_trans *trans, unsigned idx)
59 {
60         u64 l;
61
62         if (idx == BTREE_ITER_MAX)
63                 return NULL;
64
65         l = trans->paths_allocated >> idx;
66         if (!l)
67                 return NULL;
68
69         idx += __ffs64(l);
70         EBUG_ON(idx >= BTREE_ITER_MAX);
71         EBUG_ON(trans->paths[idx].idx != idx);
72         return &trans->paths[idx];
73 }
74
75 void bch2_btree_path_check_sort(struct btree_trans *, struct btree_path *, int);
76
77 #define trans_for_each_path(_trans, _path)                              \
78         for (_path = __trans_next_path((_trans), 0);                    \
79              (_path);                                                   \
80              _path = __trans_next_path((_trans), (_path)->idx + 1))
81
82 static inline struct btree_path *next_btree_path(struct btree_trans *trans, struct btree_path *path)
83 {
84         unsigned idx = path ? path->sorted_idx + 1 : 0;
85
86         EBUG_ON(idx > trans->nr_sorted);
87
88         return idx < trans->nr_sorted
89                 ? trans->paths + trans->sorted[idx]
90                 : NULL;
91 }
92
93 static inline struct btree_path *prev_btree_path(struct btree_trans *trans, struct btree_path *path)
94 {
95         EBUG_ON(path->sorted_idx >= trans->nr_sorted);
96         return path->sorted_idx
97                 ? trans->paths + trans->sorted[path->sorted_idx - 1]
98                 : NULL;
99 }
100
101 #define trans_for_each_path_inorder(_trans, _path, _i)                  \
102         for (_i = 0;                                                    \
103              ((_path) = (_trans)->paths + trans->sorted[_i]), (_i) < (_trans)->nr_sorted;\
104              _i++)
105
106 static inline bool __path_has_node(const struct btree_path *path,
107                                    const struct btree *b)
108 {
109         return path->l[b->c.level].b == b &&
110                 btree_node_lock_seq_matches(path, b, b->c.level);
111 }
112
113 static inline struct btree_path *
114 __trans_next_path_with_node(struct btree_trans *trans, struct btree *b,
115                             unsigned idx)
116 {
117         struct btree_path *path = __trans_next_path(trans, idx);
118
119         while (path && !__path_has_node(path, b))
120                 path = __trans_next_path(trans, path->idx + 1);
121
122         return path;
123 }
124
125 #define trans_for_each_path_with_node(_trans, _b, _path)                \
126         for (_path = __trans_next_path_with_node((_trans), (_b), 0);    \
127              (_path);                                                   \
128              _path = __trans_next_path_with_node((_trans), (_b),        \
129                                                  (_path)->idx + 1))
130
131 struct btree_path * __must_check
132 bch2_btree_path_make_mut(struct btree_trans *, struct btree_path *,
133                          bool, unsigned long);
134 struct btree_path * __must_check
135 bch2_btree_path_set_pos(struct btree_trans *, struct btree_path *,
136                         struct bpos, bool, unsigned long);
137 int __must_check bch2_btree_path_traverse(struct btree_trans *,
138                                           struct btree_path *, unsigned);
139 struct btree_path *bch2_path_get(struct btree_trans *, enum btree_id, struct bpos,
140                                  unsigned, unsigned, unsigned, unsigned long);
141 inline struct bkey_s_c bch2_btree_path_peek_slot(struct btree_path *, struct bkey *);
142
143 struct bkey_i *bch2_btree_journal_peek_slot(struct btree_trans *,
144                                         struct btree_iter *, struct bpos);
145
146 #ifdef CONFIG_BCACHEFS_DEBUG
147 void bch2_trans_verify_paths(struct btree_trans *);
148 void bch2_trans_verify_locks(struct btree_trans *);
149 void bch2_assert_pos_locked(struct btree_trans *, enum btree_id,
150                             struct bpos, bool);
151 #else
152 static inline void bch2_trans_verify_paths(struct btree_trans *trans) {}
153 static inline void bch2_trans_verify_locks(struct btree_trans *trans) {}
154 static inline void bch2_assert_pos_locked(struct btree_trans *trans, enum btree_id id,
155                                           struct bpos pos, bool key_cache) {}
156 #endif
157
158 void bch2_btree_path_fix_key_modified(struct btree_trans *trans,
159                                       struct btree *, struct bkey_packed *);
160 void bch2_btree_node_iter_fix(struct btree_trans *trans, struct btree_path *,
161                               struct btree *, struct btree_node_iter *,
162                               struct bkey_packed *, unsigned, unsigned);
163
164 int bch2_btree_path_relock_intent(struct btree_trans *, struct btree_path *);
165
166 void bch2_path_put(struct btree_trans *, struct btree_path *, bool);
167
168 int bch2_trans_relock(struct btree_trans *);
169 void bch2_trans_unlock(struct btree_trans *);
170
171 static inline bool trans_was_restarted(struct btree_trans *trans, u32 restart_count)
172 {
173         return restart_count != trans->restart_count;
174 }
175
176 void bch2_trans_verify_not_restarted(struct btree_trans *, u32);
177
178 __always_inline
179 static inline int btree_trans_restart_nounlock(struct btree_trans *trans, int err)
180 {
181         BUG_ON(err <= 0);
182         BUG_ON(!bch2_err_matches(err, BCH_ERR_transaction_restart));
183
184         trans->restarted = err;
185         trans->restart_count++;
186         return -err;
187 }
188
189 __always_inline
190 static inline int btree_trans_restart(struct btree_trans *trans, int err)
191 {
192         btree_trans_restart_nounlock(trans, err);
193         return -err;
194 }
195
196 bool bch2_btree_node_upgrade(struct btree_trans *,
197                              struct btree_path *, unsigned);
198
199 bool __bch2_btree_path_upgrade(struct btree_trans *,
200                                struct btree_path *, unsigned);
201
202 static inline bool bch2_btree_path_upgrade(struct btree_trans *trans,
203                                            struct btree_path *path,
204                                            unsigned new_locks_want)
205 {
206         new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
207
208         return path->locks_want < new_locks_want
209                 ? __bch2_btree_path_upgrade(trans, path, new_locks_want)
210                 : path->uptodate == BTREE_ITER_UPTODATE;
211 }
212
213 void __bch2_btree_path_downgrade(struct btree_trans *, struct btree_path *, unsigned);
214
215 static inline void bch2_btree_path_downgrade(struct btree_trans *trans,
216                                              struct btree_path *path)
217 {
218         unsigned new_locks_want = path->level + !!path->intent_ref;
219
220         if (path->locks_want > new_locks_want)
221                 __bch2_btree_path_downgrade(trans, path, new_locks_want);
222 }
223
224 void bch2_trans_downgrade(struct btree_trans *);
225
226 void bch2_trans_node_add(struct btree_trans *trans, struct btree *);
227 void bch2_trans_node_reinit_iter(struct btree_trans *, struct btree *);
228
229 int __must_check __bch2_btree_iter_traverse(struct btree_iter *iter);
230 int __must_check bch2_btree_iter_traverse(struct btree_iter *);
231
232 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
233 struct btree *bch2_btree_iter_next_node(struct btree_iter *);
234
235 struct bkey_s_c bch2_btree_iter_peek_upto(struct btree_iter *, struct bpos);
236 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
237
238 struct bkey_s_c bch2_btree_iter_peek_all_levels(struct btree_iter *);
239
240 static inline struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *iter)
241 {
242         return bch2_btree_iter_peek_upto(iter, SPOS_MAX);
243 }
244
245 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
246 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
247
248 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
249 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
250 struct bkey_s_c bch2_btree_iter_prev_slot(struct btree_iter *);
251
252 bool bch2_btree_iter_advance(struct btree_iter *);
253 bool bch2_btree_iter_rewind(struct btree_iter *);
254
255 static inline void __bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
256 {
257         iter->k.type = KEY_TYPE_deleted;
258         iter->k.p.inode         = iter->pos.inode       = new_pos.inode;
259         iter->k.p.offset        = iter->pos.offset      = new_pos.offset;
260         iter->k.p.snapshot      = iter->pos.snapshot    = new_pos.snapshot;
261         iter->k.size = 0;
262 }
263
264 static inline void bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
265 {
266         if (unlikely(iter->update_path))
267                 bch2_path_put(iter->trans, iter->update_path,
268                               iter->flags & BTREE_ITER_INTENT);
269         iter->update_path = NULL;
270
271         if (!(iter->flags & BTREE_ITER_ALL_SNAPSHOTS))
272                 new_pos.snapshot = iter->snapshot;
273
274         __bch2_btree_iter_set_pos(iter, new_pos);
275 }
276
277 static inline void bch2_btree_iter_set_pos_to_extent_start(struct btree_iter *iter)
278 {
279         BUG_ON(!(iter->flags & BTREE_ITER_IS_EXTENTS));
280         iter->pos = bkey_start_pos(&iter->k);
281 }
282
283 static inline void bch2_btree_iter_set_snapshot(struct btree_iter *iter, u32 snapshot)
284 {
285         struct bpos pos = iter->pos;
286
287         iter->snapshot = snapshot;
288         pos.snapshot = snapshot;
289         bch2_btree_iter_set_pos(iter, pos);
290 }
291
292 void bch2_trans_iter_exit(struct btree_trans *, struct btree_iter *);
293 void bch2_trans_iter_init(struct btree_trans *, struct btree_iter *,
294                           unsigned, struct bpos, unsigned);
295 void bch2_trans_node_iter_init(struct btree_trans *, struct btree_iter *,
296                                enum btree_id, struct bpos,
297                                unsigned, unsigned, unsigned);
298 void bch2_trans_copy_iter(struct btree_iter *, struct btree_iter *);
299
300 static inline void set_btree_iter_dontneed(struct btree_iter *iter)
301 {
302         if (!iter->trans->restarted)
303                 iter->path->preserve = false;
304 }
305
306 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
307 u32 bch2_trans_begin(struct btree_trans *);
308
309 static inline struct btree *
310 __btree_iter_peek_node_and_restart(struct btree_trans *trans, struct btree_iter *iter)
311 {
312         struct btree *b;
313
314         while (b = bch2_btree_iter_peek_node(iter),
315                bch2_err_matches(PTR_ERR_OR_ZERO(b), BCH_ERR_transaction_restart))
316                 bch2_trans_begin(trans);
317
318         return b;
319 }
320
321 #define __for_each_btree_node(_trans, _iter, _btree_id, _start,         \
322                               _locks_want, _depth, _flags, _b, _ret)    \
323         for (bch2_trans_node_iter_init((_trans), &(_iter), (_btree_id), \
324                                 _start, _locks_want, _depth, _flags);   \
325              (_b) = __btree_iter_peek_node_and_restart((_trans), &(_iter)),\
326              !((_ret) = PTR_ERR_OR_ZERO(_b)) && (_b);                   \
327              (_b) = bch2_btree_iter_next_node(&(_iter)))
328
329 #define for_each_btree_node(_trans, _iter, _btree_id, _start,           \
330                             _flags, _b, _ret)                           \
331         __for_each_btree_node(_trans, _iter, _btree_id, _start,         \
332                               0, 0, _flags, _b, _ret)
333
334 static inline int bkey_err(struct bkey_s_c k)
335 {
336         return PTR_ERR_OR_ZERO(k.k);
337 }
338
339 static inline struct bkey_s_c bch2_btree_iter_peek_prev_type(struct btree_iter *iter,
340                                                              unsigned flags)
341 {
342         BUG_ON(flags & BTREE_ITER_ALL_LEVELS);
343
344         return  flags & BTREE_ITER_SLOTS      ? bch2_btree_iter_peek_slot(iter) :
345                                                 bch2_btree_iter_peek_prev(iter);
346 }
347
348 static inline struct bkey_s_c bch2_btree_iter_peek_type(struct btree_iter *iter,
349                                                         unsigned flags)
350 {
351         return  flags & BTREE_ITER_ALL_LEVELS ? bch2_btree_iter_peek_all_levels(iter) :
352                 flags & BTREE_ITER_SLOTS      ? bch2_btree_iter_peek_slot(iter) :
353                                                 bch2_btree_iter_peek(iter);
354 }
355
356 static inline struct bkey_s_c bch2_btree_iter_peek_upto_type(struct btree_iter *iter,
357                                                              struct bpos end,
358                                                              unsigned flags)
359 {
360         if (!(flags & BTREE_ITER_SLOTS))
361                 return bch2_btree_iter_peek_upto(iter, end);
362
363         if (bkey_cmp(iter->pos, end) > 0)
364                 return bkey_s_c_null;
365
366         return bch2_btree_iter_peek_slot(iter);
367 }
368
369 static inline int btree_trans_too_many_iters(struct btree_trans *trans)
370 {
371         if (hweight64(trans->paths_allocated) > BTREE_ITER_MAX) {
372                 trace_trans_restart_too_many_iters(trans, _THIS_IP_);
373                 return btree_trans_restart(trans, BCH_ERR_transaction_restart_too_many_iters);
374         }
375
376         return 0;
377 }
378
379 static inline struct bkey_s_c
380 __bch2_btree_iter_peek_and_restart(struct btree_trans *trans,
381                                    struct btree_iter *iter, unsigned flags)
382 {
383         struct bkey_s_c k;
384
385         while (btree_trans_too_many_iters(trans) ||
386                (k = bch2_btree_iter_peek_type(iter, flags),
387                 bch2_err_matches(bkey_err(k), BCH_ERR_transaction_restart)))
388                 bch2_trans_begin(trans);
389
390         return k;
391 }
392
393 #define lockrestart_do(_trans, _do)                                     \
394 ({                                                                      \
395         int _ret;                                                       \
396                                                                         \
397         do {                                                            \
398                 bch2_trans_begin(_trans);                               \
399                 _ret = (_do);                                           \
400         } while (bch2_err_matches(_ret, BCH_ERR_transaction_restart));  \
401                                                                         \
402         _ret;                                                           \
403 })
404
405 /*
406  * nested_lockrestart_do(), nested_commit_do():
407  *
408  * These are like lockrestart_do() and commit_do(), with two differences:
409  *
410  *  - We don't call bch2_trans_begin() unless we had a transaction restart
411  *  - We return -BCH_ERR_transaction_restart_nested if we succeeded after a
412  *  transaction restart
413  */
414 #define nested_lockrestart_do(_trans, _do)                              \
415 ({                                                                      \
416         u32 _restart_count, _orig_restart_count;                        \
417         int _ret;                                                       \
418                                                                         \
419         _restart_count = _orig_restart_count = (_trans)->restart_count; \
420                                                                         \
421         while (bch2_err_matches(_ret = (_do), BCH_ERR_transaction_restart))\
422                 _restart_count = bch2_trans_begin(_trans);              \
423                                                                         \
424         if (!_ret)                                                      \
425                 bch2_trans_verify_not_restarted(_trans, _restart_count);\
426                                                                         \
427         if (!_ret && trans_was_restarted(_trans, _orig_restart_count))  \
428                 _ret = -BCH_ERR_transaction_restart_nested;             \
429                                                                         \
430         _ret;                                                           \
431 })
432
433 #define for_each_btree_key2(_trans, _iter, _btree_id,                   \
434                             _start, _flags, _k, _do)                    \
435 ({                                                                      \
436         int _ret = 0;                                                   \
437                                                                         \
438         bch2_trans_iter_init((_trans), &(_iter), (_btree_id),           \
439                              (_start), (_flags));                       \
440                                                                         \
441         while (1) {                                                     \
442                 bch2_trans_begin(_trans);                               \
443                 (_k) = bch2_btree_iter_peek_type(&(_iter), (_flags));   \
444                 if (!(_k).k) {                                          \
445                         _ret = 0;                                       \
446                         break;                                          \
447                 }                                                       \
448                                                                         \
449                 _ret = bkey_err(_k) ?: (_do);                           \
450                 if (bch2_err_matches(_ret, BCH_ERR_transaction_restart))\
451                         continue;                                       \
452                 if (_ret)                                               \
453                         break;                                          \
454                 if (!bch2_btree_iter_advance(&(_iter)))                 \
455                         break;                                          \
456         }                                                               \
457                                                                         \
458         bch2_trans_iter_exit((_trans), &(_iter));                       \
459         _ret;                                                           \
460 })
461
462 #define for_each_btree_key_reverse(_trans, _iter, _btree_id,            \
463                                    _start, _flags, _k, _do)             \
464 ({                                                                      \
465         int _ret = 0;                                                   \
466                                                                         \
467         bch2_trans_iter_init((_trans), &(_iter), (_btree_id),           \
468                              (_start), (_flags));                       \
469                                                                         \
470         while (1) {                                                     \
471                 bch2_trans_begin(_trans);                               \
472                 (_k) = bch2_btree_iter_peek_prev_type(&(_iter), (_flags));\
473                 if (!(_k).k) {                                          \
474                         _ret = 0;                                       \
475                         break;                                          \
476                 }                                                       \
477                                                                         \
478                 _ret = bkey_err(_k) ?: (_do);                           \
479                 if (bch2_err_matches(_ret, BCH_ERR_transaction_restart))\
480                         continue;                                       \
481                 if (_ret)                                               \
482                         break;                                          \
483                 if (!bch2_btree_iter_rewind(&(_iter)))                  \
484                         break;                                          \
485         }                                                               \
486                                                                         \
487         bch2_trans_iter_exit((_trans), &(_iter));                       \
488         _ret;                                                           \
489 })
490
491 #define for_each_btree_key_commit(_trans, _iter, _btree_id,             \
492                                   _start, _iter_flags, _k,              \
493                                   _disk_res, _journal_seq, _commit_flags,\
494                                   _do)                                  \
495         for_each_btree_key2(_trans, _iter, _btree_id, _start, _iter_flags, _k,\
496                             (_do) ?: bch2_trans_commit(_trans, (_disk_res),\
497                                         (_journal_seq), (_commit_flags)))
498
499 #define for_each_btree_key(_trans, _iter, _btree_id,                    \
500                            _start, _flags, _k, _ret)                    \
501         for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id),      \
502                                   (_start), (_flags));                  \
503              (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
504              !((_ret) = bkey_err(_k)) && (_k).k;                        \
505              bch2_btree_iter_advance(&(_iter)))
506
507 #define for_each_btree_key_norestart(_trans, _iter, _btree_id,          \
508                            _start, _flags, _k, _ret)                    \
509         for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id),      \
510                                   (_start), (_flags));                  \
511              (_k) = bch2_btree_iter_peek_type(&(_iter), _flags),        \
512              !((_ret) = bkey_err(_k)) && (_k).k;                        \
513              bch2_btree_iter_advance(&(_iter)))
514
515 #define for_each_btree_key_upto_norestart(_trans, _iter, _btree_id,     \
516                            _start, _end, _flags, _k, _ret)              \
517         for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id),      \
518                                   (_start), (_flags));                  \
519              (_k) = bch2_btree_iter_peek_upto_type(&(_iter), _end, _flags),\
520              !((_ret) = bkey_err(_k)) && (_k).k;                        \
521              bch2_btree_iter_advance(&(_iter)))
522
523 #define for_each_btree_key_continue(_trans, _iter, _flags, _k, _ret)    \
524         for (;                                                          \
525              (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
526              !((_ret) = bkey_err(_k)) && (_k).k;                        \
527              bch2_btree_iter_advance(&(_iter)))
528
529 #define for_each_btree_key_continue_norestart(_iter, _flags, _k, _ret)  \
530         for (;                                                          \
531              (_k) = bch2_btree_iter_peek_type(&(_iter), _flags),        \
532              !((_ret) = bkey_err(_k)) && (_k).k;                        \
533              bch2_btree_iter_advance(&(_iter)))
534
535 /* new multiple iterator interface: */
536
537 void bch2_trans_updates_to_text(struct printbuf *, struct btree_trans *);
538 void bch2_dump_trans_updates(struct btree_trans *);
539 void bch2_dump_trans_paths_updates(struct btree_trans *);
540 void __bch2_trans_init(struct btree_trans *, struct bch_fs *,
541                        unsigned, size_t, const char *);
542 void bch2_trans_exit(struct btree_trans *);
543
544 #define bch2_trans_init(...)    __bch2_trans_init(__VA_ARGS__, __func__)
545
546 void bch2_btree_trans_to_text(struct printbuf *, struct btree_trans *);
547
548 void bch2_fs_btree_iter_exit(struct bch_fs *);
549 int bch2_fs_btree_iter_init(struct bch_fs *);
550
551 #endif /* _BCACHEFS_BTREE_ITER_H */