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 #define trans_for_each_path(_trans, _path) \
74 for (_path = __trans_next_path((_trans), 0); \
76 _path = __trans_next_path((_trans), (_path)->idx + 1))
78 static inline struct btree_path *next_btree_path(struct btree_trans *trans, struct btree_path *path)
80 unsigned idx = path ? path->sorted_idx + 1 : 0;
82 EBUG_ON(idx > trans->nr_sorted);
84 return idx < trans->nr_sorted
85 ? trans->paths + trans->sorted[idx]
89 static inline struct btree_path *prev_btree_path(struct btree_trans *trans, struct btree_path *path)
91 EBUG_ON(path->sorted_idx >= trans->nr_sorted);
92 return path->sorted_idx
93 ? trans->paths + trans->sorted[path->sorted_idx - 1]
97 #define trans_for_each_path_inorder(_trans, _path, _i) \
99 ((_path) = (_trans)->paths + trans->sorted[_i]), (_i) < (_trans)->nr_sorted;\
102 static inline bool __path_has_node(const struct btree_path *path,
103 const struct btree *b)
105 return path->l[b->c.level].b == b &&
106 btree_node_lock_seq_matches(path, b, b->c.level);
109 static inline struct btree_path *
110 __trans_next_path_with_node(struct btree_trans *trans, struct btree *b,
113 struct btree_path *path = __trans_next_path(trans, idx);
115 while (path && !__path_has_node(path, b))
116 path = __trans_next_path(trans, path->idx + 1);
121 #define trans_for_each_path_with_node(_trans, _b, _path) \
122 for (_path = __trans_next_path_with_node((_trans), (_b), 0); \
124 _path = __trans_next_path_with_node((_trans), (_b), \
127 struct btree_path * __must_check
128 bch2_btree_path_make_mut(struct btree_trans *, struct btree_path *,
129 bool, unsigned long);
130 struct btree_path * __must_check
131 bch2_btree_path_set_pos(struct btree_trans *, struct btree_path *,
132 struct bpos, bool, unsigned long);
133 int __must_check bch2_btree_path_traverse(struct btree_trans *,
134 struct btree_path *, unsigned);
135 struct btree_path *bch2_path_get(struct btree_trans *, enum btree_id, struct bpos,
136 unsigned, unsigned, unsigned, unsigned long);
137 inline struct bkey_s_c bch2_btree_path_peek_slot(struct btree_path *, struct bkey *);
139 #ifdef CONFIG_BCACHEFS_DEBUG
140 void bch2_trans_verify_paths(struct btree_trans *);
141 void bch2_trans_verify_locks(struct btree_trans *);
142 void bch2_assert_pos_locked(struct btree_trans *, enum btree_id,
145 static inline void bch2_trans_verify_paths(struct btree_trans *trans) {}
146 static inline void bch2_trans_verify_locks(struct btree_trans *trans) {}
147 static inline void bch2_assert_pos_locked(struct btree_trans *trans, enum btree_id id,
148 struct bpos pos, bool key_cache) {}
151 void bch2_btree_path_fix_key_modified(struct btree_trans *trans,
152 struct btree *, struct bkey_packed *);
153 void bch2_btree_node_iter_fix(struct btree_trans *trans, struct btree_path *,
154 struct btree *, struct btree_node_iter *,
155 struct bkey_packed *, unsigned, unsigned);
157 bool bch2_btree_path_relock_intent(struct btree_trans *, struct btree_path *);
159 void bch2_path_put(struct btree_trans *, struct btree_path *, bool);
161 bool bch2_trans_relock(struct btree_trans *);
162 void bch2_trans_unlock(struct btree_trans *);
165 static inline int btree_trans_restart(struct btree_trans *trans)
167 trans->restarted = true;
168 bch2_trans_unlock(trans);
172 bool bch2_btree_node_upgrade(struct btree_trans *,
173 struct btree_path *, unsigned);
175 bool __bch2_btree_path_upgrade(struct btree_trans *,
176 struct btree_path *, unsigned);
178 static inline bool bch2_btree_path_upgrade(struct btree_trans *trans,
179 struct btree_path *path,
180 unsigned new_locks_want)
182 new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
184 return path->locks_want < new_locks_want
185 ? __bch2_btree_path_upgrade(trans, path, new_locks_want)
186 : path->uptodate == BTREE_ITER_UPTODATE;
189 void __bch2_btree_path_downgrade(struct btree_path *, unsigned);
191 static inline void bch2_btree_path_downgrade(struct btree_path *path)
193 unsigned new_locks_want = path->level + !!path->intent_ref;
195 if (path->locks_want > new_locks_want)
196 __bch2_btree_path_downgrade(path, new_locks_want);
199 void bch2_trans_downgrade(struct btree_trans *);
201 void bch2_trans_node_add(struct btree_trans *trans, struct btree *);
202 void bch2_trans_node_reinit_iter(struct btree_trans *, struct btree *);
204 int __must_check __bch2_btree_iter_traverse(struct btree_iter *iter);
205 int __must_check bch2_btree_iter_traverse(struct btree_iter *);
207 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
208 struct btree *bch2_btree_iter_next_node(struct btree_iter *);
210 struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *);
211 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
213 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
214 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
216 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
217 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
218 struct bkey_s_c bch2_btree_iter_prev_slot(struct btree_iter *);
220 bool bch2_btree_iter_advance(struct btree_iter *);
221 bool bch2_btree_iter_rewind(struct btree_iter *);
223 static inline void __bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
225 iter->k.type = KEY_TYPE_deleted;
226 iter->k.p.inode = iter->pos.inode = new_pos.inode;
227 iter->k.p.offset = iter->pos.offset = new_pos.offset;
228 iter->k.p.snapshot = iter->pos.snapshot = new_pos.snapshot;
232 static inline void bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
234 if (unlikely(iter->update_path))
235 bch2_path_put(iter->trans, iter->update_path,
236 iter->flags & BTREE_ITER_INTENT);
237 iter->update_path = NULL;
239 if (!(iter->flags & BTREE_ITER_ALL_SNAPSHOTS))
240 new_pos.snapshot = iter->snapshot;
242 __bch2_btree_iter_set_pos(iter, new_pos);
245 static inline void bch2_btree_iter_set_pos_to_extent_start(struct btree_iter *iter)
247 BUG_ON(!(iter->flags & BTREE_ITER_IS_EXTENTS));
248 iter->pos = bkey_start_pos(&iter->k);
251 static inline void bch2_btree_iter_set_snapshot(struct btree_iter *iter, u32 snapshot)
253 struct bpos pos = iter->pos;
255 iter->snapshot = snapshot;
256 pos.snapshot = snapshot;
257 bch2_btree_iter_set_pos(iter, pos);
260 void bch2_trans_iter_exit(struct btree_trans *, struct btree_iter *);
261 void bch2_trans_iter_init(struct btree_trans *, struct btree_iter *,
262 unsigned, struct bpos, unsigned);
263 void bch2_trans_node_iter_init(struct btree_trans *, struct btree_iter *,
264 enum btree_id, struct bpos,
265 unsigned, unsigned, unsigned);
266 void bch2_trans_copy_iter(struct btree_iter *, struct btree_iter *);
268 static inline void set_btree_iter_dontneed(struct btree_iter *iter)
270 iter->path->preserve = false;
273 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
274 void bch2_trans_begin(struct btree_trans *);
276 static inline struct btree *
277 __btree_iter_peek_node_and_restart(struct btree_trans *trans, struct btree_iter *iter)
281 while (b = bch2_btree_iter_peek_node(iter),
282 PTR_ERR_OR_ZERO(b) == -EINTR)
283 bch2_trans_begin(trans);
288 #define __for_each_btree_node(_trans, _iter, _btree_id, _start, \
289 _locks_want, _depth, _flags, _b, _ret) \
290 for (bch2_trans_node_iter_init((_trans), &(_iter), (_btree_id), \
291 _start, _locks_want, _depth, _flags); \
292 (_b) = __btree_iter_peek_node_and_restart((_trans), &(_iter)),\
293 !((_ret) = PTR_ERR_OR_ZERO(_b)) && (_b); \
294 (_b) = bch2_btree_iter_next_node(&(_iter)))
296 #define for_each_btree_node(_trans, _iter, _btree_id, _start, \
298 __for_each_btree_node(_trans, _iter, _btree_id, _start, \
299 0, 0, _flags, _b, _ret)
301 static inline int bkey_err(struct bkey_s_c k)
303 return PTR_ERR_OR_ZERO(k.k);
306 static inline struct bkey_s_c bch2_btree_iter_peek_type(struct btree_iter *iter,
309 return flags & BTREE_ITER_SLOTS
310 ? bch2_btree_iter_peek_slot(iter)
311 : bch2_btree_iter_peek(iter);
314 static inline int btree_trans_too_many_iters(struct btree_trans *trans)
316 return hweight64(trans->paths_allocated) > BTREE_ITER_MAX / 2
320 static inline struct bkey_s_c
321 __bch2_btree_iter_peek_and_restart(struct btree_trans *trans,
322 struct btree_iter *iter, unsigned flags)
326 while (btree_trans_too_many_iters(trans) ||
327 (k = bch2_btree_iter_peek_type(iter, flags),
328 bkey_err(k) == -EINTR))
329 bch2_trans_begin(trans);
334 #define for_each_btree_key(_trans, _iter, _btree_id, \
335 _start, _flags, _k, _ret) \
336 for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
337 (_start), (_flags)); \
338 (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
339 !((_ret) = bkey_err(_k)) && (_k).k; \
340 bch2_btree_iter_advance(&(_iter)))
342 #define for_each_btree_key_norestart(_trans, _iter, _btree_id, \
343 _start, _flags, _k, _ret) \
344 for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
345 (_start), (_flags)); \
346 (_k) = bch2_btree_iter_peek_type(&(_iter), _flags), \
347 !((_ret) = bkey_err(_k)) && (_k).k; \
348 bch2_btree_iter_advance(&(_iter)))
350 #define for_each_btree_key_continue(_trans, _iter, _flags, _k, _ret) \
352 (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
353 !((_ret) = bkey_err(_k)) && (_k).k; \
354 bch2_btree_iter_advance(&(_iter)))
356 #define for_each_btree_key_continue_norestart(_iter, _flags, _k, _ret) \
358 (_k) = bch2_btree_iter_peek_type(&(_iter), _flags), \
359 !((_ret) = bkey_err(_k)) && (_k).k; \
360 bch2_btree_iter_advance(&(_iter)))
362 /* new multiple iterator interface: */
364 void bch2_dump_trans_paths_updates(struct btree_trans *);
365 void __bch2_trans_init(struct btree_trans *, struct bch_fs *,
366 unsigned, size_t, const char *);
367 void bch2_trans_exit(struct btree_trans *);
369 #define bch2_trans_init(...) __bch2_trans_init(__VA_ARGS__, __func__)
371 void bch2_btree_trans_to_text(struct printbuf *, struct bch_fs *);
373 void bch2_fs_btree_iter_exit(struct bch_fs *);
374 int bch2_fs_btree_iter_init(struct bch_fs *);
376 #endif /* _BCACHEFS_BTREE_ITER_H */