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 static inline int btree_iter_err(const struct btree_iter *iter)
55 return iter->flags & BTREE_ITER_ERROR ? -EIO : 0;
58 /* Iterate over paths within a transaction: */
60 static inline struct btree_path *
61 __trans_next_path(struct btree_trans *trans, unsigned idx)
65 if (idx == BTREE_ITER_MAX)
68 l = trans->paths_allocated >> idx;
73 EBUG_ON(idx >= BTREE_ITER_MAX);
74 EBUG_ON(trans->paths[idx].idx != idx);
75 return &trans->paths[idx];
78 #define trans_for_each_path(_trans, _path) \
79 for (_path = __trans_next_path((_trans), 0); \
81 _path = __trans_next_path((_trans), (_path)->idx + 1))
83 static inline struct btree_path *next_btree_path(struct btree_trans *trans, struct btree_path *path)
85 unsigned idx = path ? path->sorted_idx + 1 : 0;
87 EBUG_ON(idx > trans->nr_sorted);
89 return idx < trans->nr_sorted
90 ? trans->paths + trans->sorted[idx]
94 static inline struct btree_path *prev_btree_path(struct btree_trans *trans, struct btree_path *path)
96 EBUG_ON(path->sorted_idx >= trans->nr_sorted);
97 return path->sorted_idx
98 ? trans->paths + trans->sorted[path->sorted_idx - 1]
102 #define trans_for_each_path_inorder(_trans, _path, _i) \
104 ((_path) = (_trans)->paths + trans->sorted[_i]), (_i) < (_trans)->nr_sorted;\
107 static inline bool __path_has_node(const struct btree_path *path,
108 const struct btree *b)
110 return path->l[b->c.level].b == b &&
111 btree_node_lock_seq_matches(path, b, b->c.level);
114 static inline struct btree_path *
115 __trans_next_path_with_node(struct btree_trans *trans, struct btree *b,
118 struct btree_path *path = __trans_next_path(trans, idx);
120 while (path && !__path_has_node(path, b))
121 path = __trans_next_path(trans, path->idx + 1);
126 #define trans_for_each_path_with_node(_trans, _b, _path) \
127 for (_path = __trans_next_path_with_node((_trans), (_b), 0); \
129 _path = __trans_next_path_with_node((_trans), (_b), \
132 struct btree_path * __must_check
133 bch2_btree_path_make_mut(struct btree_trans *, struct btree_path *,
134 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 *, bool, enum btree_id,
138 struct bpos, unsigned, unsigned, bool,
140 inline struct bkey_s_c bch2_btree_path_peek_slot(struct btree_path *, struct bkey *);
142 #ifdef CONFIG_BCACHEFS_DEBUG
143 void bch2_trans_verify_paths(struct btree_trans *);
144 void bch2_trans_verify_locks(struct btree_trans *);
145 void bch2_assert_pos_locked(struct btree_trans *, enum btree_id,
148 static inline void bch2_trans_verify_paths(struct btree_trans *trans) {}
149 static inline void bch2_trans_verify_locks(struct btree_trans *trans) {}
150 static inline void bch2_assert_pos_locked(struct btree_trans *trans, enum btree_id id,
151 struct bpos pos, bool key_cache) {}
154 void bch2_btree_path_fix_key_modified(struct btree_trans *trans,
155 struct btree *, struct bkey_packed *);
156 void bch2_btree_node_iter_fix(struct btree_trans *trans, struct btree_path *,
157 struct btree *, struct btree_node_iter *,
158 struct bkey_packed *, unsigned, unsigned);
160 bool bch2_btree_path_relock_intent(struct btree_trans *, struct btree_path *);
162 void bch2_path_put(struct btree_trans *, struct btree_path *, bool);
164 bool bch2_trans_relock(struct btree_trans *);
165 void bch2_trans_unlock(struct btree_trans *);
168 static inline int btree_trans_restart(struct btree_trans *trans)
170 trans->restarted = true;
171 bch2_trans_unlock(trans);
175 bool bch2_btree_node_upgrade(struct btree_trans *,
176 struct btree_path *, unsigned);
178 bool __bch2_btree_path_upgrade(struct btree_trans *,
179 struct btree_path *, unsigned);
181 static inline bool bch2_btree_path_upgrade(struct btree_trans *trans,
182 struct btree_path *path,
183 unsigned new_locks_want)
185 new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
187 return path->locks_want < new_locks_want
188 ? __bch2_btree_path_upgrade(trans, path, new_locks_want)
189 : path->uptodate == BTREE_ITER_UPTODATE;
192 void __bch2_btree_path_downgrade(struct btree_path *, unsigned);
194 static inline void bch2_btree_path_downgrade(struct btree_path *path)
196 unsigned new_locks_want = path->level + !!path->intent_ref;
198 if (path->locks_want > new_locks_want)
199 __bch2_btree_path_downgrade(path, new_locks_want);
202 void bch2_trans_downgrade(struct btree_trans *);
204 void bch2_trans_node_add(struct btree_trans *trans, struct btree *);
205 void bch2_trans_node_reinit_iter(struct btree_trans *, struct btree *);
207 int __must_check __bch2_btree_iter_traverse(struct btree_iter *iter);
208 int __must_check bch2_btree_iter_traverse(struct btree_iter *);
210 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
211 struct btree *bch2_btree_iter_next_node(struct btree_iter *);
213 struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *);
214 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
216 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
217 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
219 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
220 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
221 struct bkey_s_c bch2_btree_iter_prev_slot(struct btree_iter *);
223 bool bch2_btree_iter_advance(struct btree_iter *);
224 bool bch2_btree_iter_rewind(struct btree_iter *);
226 static inline void bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
228 if (!(iter->flags & BTREE_ITER_ALL_SNAPSHOTS))
229 new_pos.snapshot = iter->snapshot;
231 iter->k.type = KEY_TYPE_deleted;
232 iter->k.p.inode = iter->pos.inode = new_pos.inode;
233 iter->k.p.offset = iter->pos.offset = new_pos.offset;
234 iter->k.p.snapshot = iter->pos.snapshot = new_pos.snapshot;
238 static inline void bch2_btree_iter_set_pos_to_extent_start(struct btree_iter *iter)
240 BUG_ON(!(iter->flags & BTREE_ITER_IS_EXTENTS));
241 iter->pos = bkey_start_pos(&iter->k);
244 static inline void bch2_btree_iter_set_snapshot(struct btree_iter *iter, u32 snapshot)
246 struct bpos pos = iter->pos;
248 iter->snapshot = snapshot;
249 pos.snapshot = snapshot;
250 bch2_btree_iter_set_pos(iter, pos);
253 void bch2_trans_iter_exit(struct btree_trans *, struct btree_iter *);
254 void bch2_trans_iter_init(struct btree_trans *, struct btree_iter *,
255 unsigned, struct bpos, unsigned);
256 void bch2_trans_node_iter_init(struct btree_trans *, struct btree_iter *,
257 enum btree_id, struct bpos,
258 unsigned, unsigned, unsigned);
259 void bch2_trans_copy_iter(struct btree_iter *, struct btree_iter *);
261 static inline void set_btree_iter_dontneed(struct btree_iter *iter)
263 iter->path->preserve = false;
266 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
267 void bch2_trans_begin(struct btree_trans *);
269 static inline struct btree *
270 __btree_iter_peek_node_and_restart(struct btree_trans *trans, struct btree_iter *iter)
274 while (b = bch2_btree_iter_peek_node(iter),
275 PTR_ERR_OR_ZERO(b) == -EINTR)
276 bch2_trans_begin(trans);
281 #define __for_each_btree_node(_trans, _iter, _btree_id, _start, \
282 _locks_want, _depth, _flags, _b, _ret) \
283 for (bch2_trans_node_iter_init((_trans), &(_iter), (_btree_id), \
284 _start, _locks_want, _depth, _flags); \
285 (_b) = __btree_iter_peek_node_and_restart((_trans), &(_iter)),\
286 !((_ret) = PTR_ERR_OR_ZERO(_b)) && (_b); \
287 (_b) = bch2_btree_iter_next_node(&(_iter)))
289 #define for_each_btree_node(_trans, _iter, _btree_id, _start, \
291 __for_each_btree_node(_trans, _iter, _btree_id, _start, \
292 0, 0, _flags, _b, _ret)
294 static inline int bkey_err(struct bkey_s_c k)
296 return PTR_ERR_OR_ZERO(k.k);
299 static inline struct bkey_s_c __bch2_btree_iter_peek(struct btree_iter *iter,
302 return flags & BTREE_ITER_SLOTS
303 ? bch2_btree_iter_peek_slot(iter)
304 : bch2_btree_iter_peek(iter);
307 static inline int btree_trans_too_many_iters(struct btree_trans *trans)
309 return hweight64(trans->paths_allocated) > BTREE_ITER_MAX / 2
313 static inline struct bkey_s_c
314 __bch2_btree_iter_peek_and_restart(struct btree_trans *trans,
315 struct btree_iter *iter, unsigned flags)
319 while (btree_trans_too_many_iters(trans) ||
320 (k = __bch2_btree_iter_peek(iter, flags),
321 bkey_err(k) == -EINTR))
322 bch2_trans_begin(trans);
327 #define for_each_btree_key(_trans, _iter, _btree_id, \
328 _start, _flags, _k, _ret) \
329 for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
330 (_start), (_flags)); \
331 (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
332 !((_ret) = bkey_err(_k)) && (_k).k; \
333 bch2_btree_iter_advance(&(_iter)))
335 #define for_each_btree_key_norestart(_trans, _iter, _btree_id, \
336 _start, _flags, _k, _ret) \
337 for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
338 (_start), (_flags)); \
339 (_k) = __bch2_btree_iter_peek(&(_iter), _flags), \
340 !((_ret) = bkey_err(_k)) && (_k).k; \
341 bch2_btree_iter_advance(&(_iter)))
343 #define for_each_btree_key_continue(_trans, _iter, _flags, _k, _ret) \
345 (_k) = __bch2_btree_iter_peek_and_restart((_trans), &(_iter), _flags),\
346 !((_ret) = bkey_err(_k)) && (_k).k; \
347 bch2_btree_iter_advance(&(_iter)))
349 #define for_each_btree_key_continue_norestart(_iter, _flags, _k, _ret) \
351 (_k) = __bch2_btree_iter_peek(&(_iter), _flags), \
352 !((_ret) = bkey_err(_k)) && (_k).k; \
353 bch2_btree_iter_advance(&(_iter)))
355 /* new multiple iterator interface: */
357 void bch2_dump_trans_paths_updates(struct btree_trans *);
358 void bch2_trans_init(struct btree_trans *, struct bch_fs *, unsigned, size_t);
359 void bch2_trans_exit(struct btree_trans *);
361 void bch2_btree_trans_to_text(struct printbuf *, struct bch_fs *);
363 void bch2_fs_btree_iter_exit(struct bch_fs *);
364 int bch2_fs_btree_iter_init(struct bch_fs *);
366 #endif /* _BCACHEFS_BTREE_ITER_H */