]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/btree_iter.h
Update bcachefs sources to dfaf9a6ee2 lib/printbuf: Clean up headers
[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         return -err;
186 }
187
188 __always_inline
189 static inline int btree_trans_restart(struct btree_trans *trans, int err)
190 {
191         btree_trans_restart_nounlock(trans, err);
192         return -err;
193 }
194
195 bool bch2_btree_node_upgrade(struct btree_trans *,
196                              struct btree_path *, unsigned);
197
198 bool __bch2_btree_path_upgrade(struct btree_trans *,
199                                struct btree_path *, unsigned);
200
201 static inline bool bch2_btree_path_upgrade(struct btree_trans *trans,
202                                            struct btree_path *path,
203                                            unsigned new_locks_want)
204 {
205         new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
206
207         return path->locks_want < new_locks_want
208                 ? __bch2_btree_path_upgrade(trans, path, new_locks_want)
209                 : path->uptodate == BTREE_ITER_UPTODATE;
210 }
211
212 void __bch2_btree_path_downgrade(struct btree_trans *, struct btree_path *, unsigned);
213
214 static inline void bch2_btree_path_downgrade(struct btree_trans *trans,
215                                              struct btree_path *path)
216 {
217         unsigned new_locks_want = path->level + !!path->intent_ref;
218
219         if (path->locks_want > new_locks_want)
220                 __bch2_btree_path_downgrade(trans, path, new_locks_want);
221 }
222
223 void bch2_trans_downgrade(struct btree_trans *);
224
225 void bch2_trans_node_add(struct btree_trans *trans, struct btree *);
226 void bch2_trans_node_reinit_iter(struct btree_trans *, struct btree *);
227
228 int __must_check __bch2_btree_iter_traverse(struct btree_iter *iter);
229 int __must_check bch2_btree_iter_traverse(struct btree_iter *);
230
231 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
232 struct btree *bch2_btree_iter_next_node(struct btree_iter *);
233
234 struct bkey_s_c bch2_btree_iter_peek_upto(struct btree_iter *, struct bpos);
235 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
236
237 struct bkey_s_c bch2_btree_iter_peek_all_levels(struct btree_iter *);
238
239 static inline struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *iter)
240 {
241         return bch2_btree_iter_peek_upto(iter, SPOS_MAX);
242 }
243
244 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
245 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
246
247 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
248 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
249 struct bkey_s_c bch2_btree_iter_prev_slot(struct btree_iter *);
250
251 bool bch2_btree_iter_advance(struct btree_iter *);
252 bool bch2_btree_iter_rewind(struct btree_iter *);
253
254 static inline void __bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
255 {
256         iter->k.type = KEY_TYPE_deleted;
257         iter->k.p.inode         = iter->pos.inode       = new_pos.inode;
258         iter->k.p.offset        = iter->pos.offset      = new_pos.offset;
259         iter->k.p.snapshot      = iter->pos.snapshot    = new_pos.snapshot;
260         iter->k.size = 0;
261 }
262
263 static inline void bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
264 {
265         if (unlikely(iter->update_path))
266                 bch2_path_put(iter->trans, iter->update_path,
267                               iter->flags & BTREE_ITER_INTENT);
268         iter->update_path = NULL;
269
270         if (!(iter->flags & BTREE_ITER_ALL_SNAPSHOTS))
271                 new_pos.snapshot = iter->snapshot;
272
273         __bch2_btree_iter_set_pos(iter, new_pos);
274 }
275
276 static inline void bch2_btree_iter_set_pos_to_extent_start(struct btree_iter *iter)
277 {
278         BUG_ON(!(iter->flags & BTREE_ITER_IS_EXTENTS));
279         iter->pos = bkey_start_pos(&iter->k);
280 }
281
282 static inline void bch2_btree_iter_set_snapshot(struct btree_iter *iter, u32 snapshot)
283 {
284         struct bpos pos = iter->pos;
285
286         iter->snapshot = snapshot;
287         pos.snapshot = snapshot;
288         bch2_btree_iter_set_pos(iter, pos);
289 }
290
291 void bch2_trans_iter_exit(struct btree_trans *, struct btree_iter *);
292 void bch2_trans_iter_init(struct btree_trans *, struct btree_iter *,
293                           unsigned, struct bpos, unsigned);
294 void bch2_trans_node_iter_init(struct btree_trans *, struct btree_iter *,
295                                enum btree_id, struct bpos,
296                                unsigned, unsigned, unsigned);
297 void bch2_trans_copy_iter(struct btree_iter *, struct btree_iter *);
298
299 static inline void set_btree_iter_dontneed(struct btree_iter *iter)
300 {
301         if (!iter->trans->restarted)
302                 iter->path->preserve = false;
303 }
304
305 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
306 u32 bch2_trans_begin(struct btree_trans *);
307
308 static inline struct btree *
309 __btree_iter_peek_node_and_restart(struct btree_trans *trans, struct btree_iter *iter)
310 {
311         struct btree *b;
312
313         while (b = bch2_btree_iter_peek_node(iter),
314                bch2_err_matches(PTR_ERR_OR_ZERO(b), BCH_ERR_transaction_restart))
315                 bch2_trans_begin(trans);
316
317         return b;
318 }
319
320 #define __for_each_btree_node(_trans, _iter, _btree_id, _start,         \
321                               _locks_want, _depth, _flags, _b, _ret)    \
322         for (bch2_trans_node_iter_init((_trans), &(_iter), (_btree_id), \
323                                 _start, _locks_want, _depth, _flags);   \
324              (_b) = __btree_iter_peek_node_and_restart((_trans), &(_iter)),\
325              !((_ret) = PTR_ERR_OR_ZERO(_b)) && (_b);                   \
326              (_b) = bch2_btree_iter_next_node(&(_iter)))
327
328 #define for_each_btree_node(_trans, _iter, _btree_id, _start,           \
329                             _flags, _b, _ret)                           \
330         __for_each_btree_node(_trans, _iter, _btree_id, _start,         \
331                               0, 0, _flags, _b, _ret)
332
333 static inline int bkey_err(struct bkey_s_c k)
334 {
335         return PTR_ERR_OR_ZERO(k.k);
336 }
337
338 static inline struct bkey_s_c bch2_btree_iter_peek_prev_type(struct btree_iter *iter,
339                                                              unsigned flags)
340 {
341         BUG_ON(flags & BTREE_ITER_ALL_LEVELS);
342
343         return  flags & BTREE_ITER_SLOTS      ? bch2_btree_iter_peek_slot(iter) :
344                                                 bch2_btree_iter_peek_prev(iter);
345 }
346
347 static inline struct bkey_s_c bch2_btree_iter_peek_type(struct btree_iter *iter,
348                                                         unsigned flags)
349 {
350         return  flags & BTREE_ITER_ALL_LEVELS ? bch2_btree_iter_peek_all_levels(iter) :
351                 flags & BTREE_ITER_SLOTS      ? bch2_btree_iter_peek_slot(iter) :
352                                                 bch2_btree_iter_peek(iter);
353 }
354
355 static inline struct bkey_s_c bch2_btree_iter_peek_upto_type(struct btree_iter *iter,
356                                                              struct bpos end,
357                                                              unsigned flags)
358 {
359         if (!(flags & BTREE_ITER_SLOTS))
360                 return bch2_btree_iter_peek_upto(iter, end);
361
362         if (bkey_cmp(iter->pos, end) > 0)
363                 return bkey_s_c_null;
364
365         return bch2_btree_iter_peek_slot(iter);
366 }
367
368 static inline int btree_trans_too_many_iters(struct btree_trans *trans)
369 {
370         if (hweight64(trans->paths_allocated) > BTREE_ITER_MAX / 2) {
371                 trace_trans_restart_too_many_iters(trans, _THIS_IP_);
372                 return btree_trans_restart(trans, BCH_ERR_transaction_restart_too_many_iters);
373         }
374
375         return 0;
376 }
377
378 static inline struct bkey_s_c
379 __bch2_btree_iter_peek_and_restart(struct btree_trans *trans,
380                                    struct btree_iter *iter, unsigned flags)
381 {
382         struct bkey_s_c k;
383
384         while (btree_trans_too_many_iters(trans) ||
385                (k = bch2_btree_iter_peek_type(iter, flags),
386                 bch2_err_matches(bkey_err(k), BCH_ERR_transaction_restart)))
387                 bch2_trans_begin(trans);
388
389         return k;
390 }
391
392 #define lockrestart_do(_trans, _do)                                     \
393 ({                                                                      \
394         u32 _restart_count;                                             \
395         int _ret;                                                       \
396                                                                         \
397         do {                                                            \
398                 _restart_count = bch2_trans_begin(_trans);              \
399                 _ret = (_do);                                           \
400         } while (bch2_err_matches(_ret, BCH_ERR_transaction_restart));  \
401                                                                         \
402         if (!_ret)                                                      \
403                 bch2_trans_verify_not_restarted(_trans, _restart_count);\
404                                                                         \
405         _ret;                                                           \
406 })
407
408 /*
409  * nested_lockrestart_do(), nested_commit_do():
410  *
411  * These are like lockrestart_do() and commit_do(), with two differences:
412  *
413  *  - We don't call bch2_trans_begin() unless we had a transaction restart
414  *  - We return -BCH_ERR_transaction_restart_nested if we succeeded after a
415  *  transaction restart
416  */
417 #define nested_lockrestart_do(_trans, _do)                              \
418 ({                                                                      \
419         u32 _restart_count, _orig_restart_count;                        \
420         int _ret;                                                       \
421                                                                         \
422         _restart_count = _orig_restart_count = (_trans)->restart_count; \
423                                                                         \
424         while (bch2_err_matches(_ret = (_do), BCH_ERR_transaction_restart))\
425                 _restart_count = bch2_trans_begin(_trans);              \
426                                                                         \
427         if (!_ret)                                                      \
428                 bch2_trans_verify_not_restarted(_trans, _restart_count);\
429                                                                         \
430         if (!_ret && trans_was_restarted(_trans, _orig_restart_count))  \
431                 _ret = -BCH_ERR_transaction_restart_nested;             \
432                                                                         \
433         _ret;                                                           \
434 })
435
436 #define for_each_btree_key2(_trans, _iter, _btree_id,                   \
437                             _start, _flags, _k, _do)                    \
438 ({                                                                      \
439         int _ret = 0;                                                   \
440                                                                         \
441         bch2_trans_iter_init((_trans), &(_iter), (_btree_id),           \
442                              (_start), (_flags));                       \
443                                                                         \
444         while (1) {                                                     \
445                 u32 _restart_count = bch2_trans_begin(_trans);          \
446                 (_k) = bch2_btree_iter_peek_type(&(_iter), (_flags));   \
447                 if (!(_k).k) {                                          \
448                         _ret = 0;                                       \
449                         break;                                          \
450                 }                                                       \
451                                                                         \
452                 _ret = bkey_err(_k) ?: (_do);                           \
453                 if (bch2_err_matches(_ret, BCH_ERR_transaction_restart))\
454                         continue;                                       \
455                 if (_ret)                                               \
456                         break;                                          \
457                 bch2_trans_verify_not_restarted(_trans, _restart_count);\
458                 if (!bch2_btree_iter_advance(&(_iter)))                 \
459                         break;                                          \
460         }                                                               \
461                                                                         \
462         bch2_trans_iter_exit((_trans), &(_iter));                       \
463         _ret;                                                           \
464 })
465
466 #define for_each_btree_key_reverse(_trans, _iter, _btree_id,            \
467                                    _start, _flags, _k, _do)             \
468 ({                                                                      \
469         int _ret = 0;                                                   \
470                                                                         \
471         bch2_trans_iter_init((_trans), &(_iter), (_btree_id),           \
472                              (_start), (_flags));                       \
473                                                                         \
474         while (1) {                                                     \
475                 u32 _restart_count = bch2_trans_begin(_trans);          \
476                 (_k) = bch2_btree_iter_peek_prev_type(&(_iter), (_flags));\
477                 if (!(_k).k) {                                          \
478                         _ret = 0;                                       \
479                         break;                                          \
480                 }                                                       \
481                                                                         \
482                 _ret = bkey_err(_k) ?: (_do);                           \
483                 if (bch2_err_matches(_ret, BCH_ERR_transaction_restart))\
484                         continue;                                       \
485                 if (_ret)                                               \
486                         break;                                          \
487                 bch2_trans_verify_not_restarted(_trans, _restart_count);\
488                 if (!bch2_btree_iter_rewind(&(_iter)))                  \
489                         break;                                          \
490         }                                                               \
491                                                                         \
492         bch2_trans_iter_exit((_trans), &(_iter));                       \
493         _ret;                                                           \
494 })
495
496 #define for_each_btree_key_commit(_trans, _iter, _btree_id,             \
497                                   _start, _iter_flags, _k,              \
498                                   _disk_res, _journal_seq, _commit_flags,\
499                                   _do)                                  \
500         for_each_btree_key2(_trans, _iter, _btree_id, _start, _iter_flags, _k,\
501                             (_do) ?: bch2_trans_commit(_trans, (_disk_res),\
502                                         (_journal_seq), (_commit_flags)))
503
504 #define for_each_btree_key(_trans, _iter, _btree_id,                    \
505                            _start, _flags, _k, _ret)                    \
506         for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id),      \
507                                   (_start), (_flags));                  \
508              (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
509              !((_ret) = bkey_err(_k)) && (_k).k;                        \
510              bch2_btree_iter_advance(&(_iter)))
511
512 #define for_each_btree_key_norestart(_trans, _iter, _btree_id,          \
513                            _start, _flags, _k, _ret)                    \
514         for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id),      \
515                                   (_start), (_flags));                  \
516              (_k) = bch2_btree_iter_peek_type(&(_iter), _flags),        \
517              !((_ret) = bkey_err(_k)) && (_k).k;                        \
518              bch2_btree_iter_advance(&(_iter)))
519
520 #define for_each_btree_key_upto_norestart(_trans, _iter, _btree_id,     \
521                            _start, _end, _flags, _k, _ret)              \
522         for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id),      \
523                                   (_start), (_flags));                  \
524              (_k) = bch2_btree_iter_peek_upto_type(&(_iter), _end, _flags),\
525              !((_ret) = bkey_err(_k)) && (_k).k;                        \
526              bch2_btree_iter_advance(&(_iter)))
527
528 #define for_each_btree_key_continue(_trans, _iter, _flags, _k, _ret)    \
529         for (;                                                          \
530              (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
531              !((_ret) = bkey_err(_k)) && (_k).k;                        \
532              bch2_btree_iter_advance(&(_iter)))
533
534 #define for_each_btree_key_continue_norestart(_iter, _flags, _k, _ret)  \
535         for (;                                                          \
536              (_k) = bch2_btree_iter_peek_type(&(_iter), _flags),        \
537              !((_ret) = bkey_err(_k)) && (_k).k;                        \
538              bch2_btree_iter_advance(&(_iter)))
539
540 /* new multiple iterator interface: */
541
542 void bch2_trans_updates_to_text(struct printbuf *, struct btree_trans *);
543 void bch2_btree_path_to_text(struct printbuf *, struct btree_path *);
544 void bch2_trans_paths_to_text(struct printbuf *, struct btree_trans *);
545 void bch2_dump_trans_updates(struct btree_trans *);
546 void bch2_dump_trans_paths_updates(struct btree_trans *);
547 void __bch2_trans_init(struct btree_trans *, struct bch_fs *,
548                        unsigned, size_t, const char *);
549 void bch2_trans_exit(struct btree_trans *);
550
551 #define bch2_trans_init(...)    __bch2_trans_init(__VA_ARGS__, __func__)
552
553 void bch2_btree_trans_to_text(struct printbuf *, struct btree_trans *);
554
555 void bch2_fs_btree_iter_exit(struct bch_fs *);
556 int bch2_fs_btree_iter_init(struct bch_fs *);
557
558 #endif /* _BCACHEFS_BTREE_ITER_H */