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