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