1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_BTREE_ITER_H
3 #define _BCACHEFS_BTREE_ITER_H
6 #include "btree_types.h"
8 static inline void __btree_path_get(struct btree_path *path, bool intent)
11 path->intent_ref += intent;
14 static inline bool __btree_path_put(struct btree_path *path, bool intent)
17 EBUG_ON(!path->intent_ref && intent);
18 path->intent_ref -= intent;
19 return --path->ref == 0;
22 static inline void btree_path_set_dirty(struct btree_path *path,
23 enum btree_path_uptodate u)
25 path->uptodate = max_t(unsigned, path->uptodate, u);
28 static inline struct btree *btree_path_node(struct btree_path *path,
31 return level < BTREE_MAX_DEPTH ? path->l[level].b : NULL;
34 static inline bool btree_node_lock_seq_matches(const struct btree_path *path,
35 const struct btree *b, unsigned level)
38 * We don't compare the low bits of the lock sequence numbers because
39 * @path might have taken a write lock on @b, and we don't want to skip
40 * the linked path if the sequence numbers were equal before taking that
41 * write lock. The lock sequence number is incremented by taking and
42 * releasing write locks and is even when unlocked:
44 return path->l[level].lock_seq >> 1 == b->c.lock.state.seq >> 1;
47 static inline struct btree *btree_node_parent(struct btree_path *path,
50 return btree_path_node(path, b->c.level + 1);
53 /* Iterate over paths within a transaction: */
55 static inline struct btree_path *
56 __trans_next_path(struct btree_trans *trans, unsigned idx)
60 if (idx == BTREE_ITER_MAX)
63 l = trans->paths_allocated >> idx;
68 EBUG_ON(idx >= BTREE_ITER_MAX);
69 EBUG_ON(trans->paths[idx].idx != idx);
70 return &trans->paths[idx];
73 void bch2_btree_path_check_sort(struct btree_trans *, struct btree_path *, int);
75 #define trans_for_each_path(_trans, _path) \
76 for (_path = __trans_next_path((_trans), 0); \
78 _path = __trans_next_path((_trans), (_path)->idx + 1))
80 static inline struct btree_path *next_btree_path(struct btree_trans *trans, struct btree_path *path)
82 unsigned idx = path ? path->sorted_idx + 1 : 0;
84 EBUG_ON(idx > trans->nr_sorted);
86 return idx < trans->nr_sorted
87 ? trans->paths + trans->sorted[idx]
91 static inline struct btree_path *prev_btree_path(struct btree_trans *trans, struct btree_path *path)
93 EBUG_ON(path->sorted_idx >= trans->nr_sorted);
94 return path->sorted_idx
95 ? trans->paths + trans->sorted[path->sorted_idx - 1]
99 #define trans_for_each_path_inorder(_trans, _path, _i) \
101 ((_path) = (_trans)->paths + trans->sorted[_i]), (_i) < (_trans)->nr_sorted;\
104 static inline bool __path_has_node(const struct btree_path *path,
105 const struct btree *b)
107 return path->l[b->c.level].b == b &&
108 btree_node_lock_seq_matches(path, b, b->c.level);
111 static inline struct btree_path *
112 __trans_next_path_with_node(struct btree_trans *trans, struct btree *b,
115 struct btree_path *path = __trans_next_path(trans, idx);
117 while (path && !__path_has_node(path, b))
118 path = __trans_next_path(trans, path->idx + 1);
123 #define trans_for_each_path_with_node(_trans, _b, _path) \
124 for (_path = __trans_next_path_with_node((_trans), (_b), 0); \
126 _path = __trans_next_path_with_node((_trans), (_b), \
129 struct btree_path * __must_check
130 bch2_btree_path_make_mut(struct btree_trans *, struct btree_path *,
131 bool, unsigned long);
132 struct btree_path * __must_check
133 bch2_btree_path_set_pos(struct btree_trans *, struct btree_path *,
134 struct bpos, bool, unsigned long);
135 int __must_check bch2_btree_path_traverse(struct btree_trans *,
136 struct btree_path *, unsigned);
137 struct btree_path *bch2_path_get(struct btree_trans *, enum btree_id, struct bpos,
138 unsigned, unsigned, unsigned, unsigned long);
139 inline struct bkey_s_c bch2_btree_path_peek_slot(struct btree_path *, struct bkey *);
141 #ifdef CONFIG_BCACHEFS_DEBUG
142 void bch2_trans_verify_paths(struct btree_trans *);
143 void bch2_trans_verify_locks(struct btree_trans *);
144 void bch2_assert_pos_locked(struct btree_trans *, enum btree_id,
147 static inline void bch2_trans_verify_paths(struct btree_trans *trans) {}
148 static inline void bch2_trans_verify_locks(struct btree_trans *trans) {}
149 static inline void bch2_assert_pos_locked(struct btree_trans *trans, enum btree_id id,
150 struct bpos pos, bool key_cache) {}
153 void bch2_btree_path_fix_key_modified(struct btree_trans *trans,
154 struct btree *, struct bkey_packed *);
155 void bch2_btree_node_iter_fix(struct btree_trans *trans, struct btree_path *,
156 struct btree *, struct btree_node_iter *,
157 struct bkey_packed *, unsigned, unsigned);
159 bool bch2_btree_path_relock_intent(struct btree_trans *, struct btree_path *);
161 void bch2_path_put(struct btree_trans *, struct btree_path *, bool);
163 bool bch2_trans_relock(struct btree_trans *);
164 void bch2_trans_unlock(struct btree_trans *);
167 static inline int btree_trans_restart(struct btree_trans *trans)
169 trans->restarted = true;
170 bch2_trans_unlock(trans);
174 bool bch2_btree_node_upgrade(struct btree_trans *,
175 struct btree_path *, unsigned);
177 bool __bch2_btree_path_upgrade(struct btree_trans *,
178 struct btree_path *, unsigned);
180 static inline bool bch2_btree_path_upgrade(struct btree_trans *trans,
181 struct btree_path *path,
182 unsigned new_locks_want)
184 new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
186 return path->locks_want < new_locks_want
187 ? __bch2_btree_path_upgrade(trans, path, new_locks_want)
188 : path->uptodate == BTREE_ITER_UPTODATE;
191 void __bch2_btree_path_downgrade(struct btree_path *, unsigned);
193 static inline void bch2_btree_path_downgrade(struct btree_path *path)
195 unsigned new_locks_want = path->level + !!path->intent_ref;
197 if (path->locks_want > new_locks_want)
198 __bch2_btree_path_downgrade(path, new_locks_want);
201 void bch2_trans_downgrade(struct btree_trans *);
203 void bch2_trans_node_add(struct btree_trans *trans, struct btree *);
204 void bch2_trans_node_reinit_iter(struct btree_trans *, struct btree *);
206 int __must_check __bch2_btree_iter_traverse(struct btree_iter *iter);
207 int __must_check bch2_btree_iter_traverse(struct btree_iter *);
209 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
210 struct btree *bch2_btree_iter_next_node(struct btree_iter *);
212 struct bkey_s_c bch2_btree_iter_peek_upto(struct btree_iter *, struct bpos);
213 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
215 struct bkey_s_c bch2_btree_iter_peek_all_levels(struct btree_iter *);
217 static inline struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *iter)
219 return bch2_btree_iter_peek_upto(iter, SPOS_MAX);
222 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
223 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
225 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
226 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
227 struct bkey_s_c bch2_btree_iter_prev_slot(struct btree_iter *);
229 bool bch2_btree_iter_advance(struct btree_iter *);
230 bool bch2_btree_iter_rewind(struct btree_iter *);
232 static inline void __bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
234 iter->k.type = KEY_TYPE_deleted;
235 iter->k.p.inode = iter->pos.inode = new_pos.inode;
236 iter->k.p.offset = iter->pos.offset = new_pos.offset;
237 iter->k.p.snapshot = iter->pos.snapshot = new_pos.snapshot;
241 static inline void bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
243 if (unlikely(iter->update_path))
244 bch2_path_put(iter->trans, iter->update_path,
245 iter->flags & BTREE_ITER_INTENT);
246 iter->update_path = NULL;
248 if (!(iter->flags & BTREE_ITER_ALL_SNAPSHOTS))
249 new_pos.snapshot = iter->snapshot;
251 __bch2_btree_iter_set_pos(iter, new_pos);
254 static inline void bch2_btree_iter_set_pos_to_extent_start(struct btree_iter *iter)
256 BUG_ON(!(iter->flags & BTREE_ITER_IS_EXTENTS));
257 iter->pos = bkey_start_pos(&iter->k);
260 static inline void bch2_btree_iter_set_snapshot(struct btree_iter *iter, u32 snapshot)
262 struct bpos pos = iter->pos;
264 iter->snapshot = snapshot;
265 pos.snapshot = snapshot;
266 bch2_btree_iter_set_pos(iter, pos);
269 void bch2_trans_iter_exit(struct btree_trans *, struct btree_iter *);
270 void bch2_trans_iter_init(struct btree_trans *, struct btree_iter *,
271 unsigned, struct bpos, unsigned);
272 void bch2_trans_node_iter_init(struct btree_trans *, struct btree_iter *,
273 enum btree_id, struct bpos,
274 unsigned, unsigned, unsigned);
275 void bch2_trans_copy_iter(struct btree_iter *, struct btree_iter *);
277 static inline void set_btree_iter_dontneed(struct btree_iter *iter)
279 iter->path->preserve = false;
282 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
283 void bch2_trans_begin(struct btree_trans *);
285 static inline struct btree *
286 __btree_iter_peek_node_and_restart(struct btree_trans *trans, struct btree_iter *iter)
290 while (b = bch2_btree_iter_peek_node(iter),
291 PTR_ERR_OR_ZERO(b) == -EINTR)
292 bch2_trans_begin(trans);
297 #define __for_each_btree_node(_trans, _iter, _btree_id, _start, \
298 _locks_want, _depth, _flags, _b, _ret) \
299 for (bch2_trans_node_iter_init((_trans), &(_iter), (_btree_id), \
300 _start, _locks_want, _depth, _flags); \
301 (_b) = __btree_iter_peek_node_and_restart((_trans), &(_iter)),\
302 !((_ret) = PTR_ERR_OR_ZERO(_b)) && (_b); \
303 (_b) = bch2_btree_iter_next_node(&(_iter)))
305 #define for_each_btree_node(_trans, _iter, _btree_id, _start, \
307 __for_each_btree_node(_trans, _iter, _btree_id, _start, \
308 0, 0, _flags, _b, _ret)
310 static inline int bkey_err(struct bkey_s_c k)
312 return PTR_ERR_OR_ZERO(k.k);
315 static inline struct bkey_s_c bch2_btree_iter_peek_type(struct btree_iter *iter,
318 return flags & BTREE_ITER_ALL_LEVELS ? bch2_btree_iter_peek_all_levels(iter) :
319 flags & BTREE_ITER_SLOTS ? bch2_btree_iter_peek_slot(iter) :
320 bch2_btree_iter_peek(iter);
323 static inline struct bkey_s_c bch2_btree_iter_peek_upto_type(struct btree_iter *iter,
327 if (!(flags & BTREE_ITER_SLOTS))
328 return bch2_btree_iter_peek_upto(iter, end);
330 if (bkey_cmp(iter->pos, end) > 0)
331 return bkey_s_c_null;
333 return bch2_btree_iter_peek_slot(iter);
336 static inline int btree_trans_too_many_iters(struct btree_trans *trans)
338 return hweight64(trans->paths_allocated) > BTREE_ITER_MAX / 2
342 static inline struct bkey_s_c
343 __bch2_btree_iter_peek_and_restart(struct btree_trans *trans,
344 struct btree_iter *iter, unsigned flags)
348 while (btree_trans_too_many_iters(trans) ||
349 (k = bch2_btree_iter_peek_type(iter, flags),
350 bkey_err(k) == -EINTR))
351 bch2_trans_begin(trans);
356 #define for_each_btree_key(_trans, _iter, _btree_id, \
357 _start, _flags, _k, _ret) \
358 for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
359 (_start), (_flags)); \
360 (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
361 !((_ret) = bkey_err(_k)) && (_k).k; \
362 bch2_btree_iter_advance(&(_iter)))
364 #define for_each_btree_key_norestart(_trans, _iter, _btree_id, \
365 _start, _flags, _k, _ret) \
366 for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
367 (_start), (_flags)); \
368 (_k) = bch2_btree_iter_peek_type(&(_iter), _flags), \
369 !((_ret) = bkey_err(_k)) && (_k).k; \
370 bch2_btree_iter_advance(&(_iter)))
372 #define for_each_btree_key_upto_norestart(_trans, _iter, _btree_id, \
373 _start, _end, _flags, _k, _ret) \
374 for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
375 (_start), (_flags)); \
376 (_k) = bch2_btree_iter_peek_upto_type(&(_iter), _end, _flags),\
377 !((_ret) = bkey_err(_k)) && (_k).k; \
378 bch2_btree_iter_advance(&(_iter)))
380 #define for_each_btree_key_continue(_trans, _iter, _flags, _k, _ret) \
382 (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
383 !((_ret) = bkey_err(_k)) && (_k).k; \
384 bch2_btree_iter_advance(&(_iter)))
386 #define for_each_btree_key_continue_norestart(_iter, _flags, _k, _ret) \
388 (_k) = bch2_btree_iter_peek_type(&(_iter), _flags), \
389 !((_ret) = bkey_err(_k)) && (_k).k; \
390 bch2_btree_iter_advance(&(_iter)))
392 /* new multiple iterator interface: */
394 void bch2_trans_updates_to_text(struct printbuf *, struct btree_trans *);
395 void bch2_dump_trans_updates(struct btree_trans *);
396 void bch2_dump_trans_paths_updates(struct btree_trans *);
397 void __bch2_trans_init(struct btree_trans *, struct bch_fs *,
398 unsigned, size_t, const char *);
399 void bch2_trans_exit(struct btree_trans *);
401 #define bch2_trans_init(...) __bch2_trans_init(__VA_ARGS__, __func__)
403 void bch2_btree_trans_to_text(struct printbuf *, struct bch_fs *);
405 void bch2_fs_btree_iter_exit(struct bch_fs *);
406 int bch2_fs_btree_iter_init(struct bch_fs *);
408 #endif /* _BCACHEFS_BTREE_ITER_H */