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 *, bool);
134 int __must_check bch2_btree_path_traverse(struct btree_trans *,
135 struct btree_path *, unsigned);
136 struct btree_path *bch2_path_get(struct btree_trans *, bool, enum btree_id,
137 struct bpos, unsigned, unsigned, bool);
138 inline struct bkey_s_c bch2_btree_path_peek_slot(struct btree_path *, struct bkey *);
140 #ifdef CONFIG_BCACHEFS_DEBUG
141 void bch2_trans_verify_paths(struct btree_trans *);
142 void bch2_trans_verify_locks(struct btree_trans *);
144 static inline void bch2_trans_verify_paths(struct btree_trans *trans) {}
145 static inline void bch2_trans_verify_locks(struct btree_trans *trans) {}
148 void bch2_btree_path_fix_key_modified(struct btree_trans *trans,
149 struct btree *, struct bkey_packed *);
150 void bch2_btree_node_iter_fix(struct btree_trans *trans, struct btree_path *,
151 struct btree *, struct btree_node_iter *,
152 struct bkey_packed *, unsigned, unsigned);
154 bool bch2_btree_path_relock_intent(struct btree_trans *, struct btree_path *);
156 void bch2_path_put(struct btree_trans *, struct btree_path *, bool);
158 bool bch2_trans_relock(struct btree_trans *);
159 void bch2_trans_unlock(struct btree_trans *);
162 static inline int btree_trans_restart(struct btree_trans *trans)
164 trans->restarted = true;
165 bch2_trans_unlock(trans);
169 bool __bch2_btree_path_upgrade(struct btree_trans *,
170 struct btree_path *, unsigned);
172 static inline bool bch2_btree_path_upgrade(struct btree_trans *trans,
173 struct btree_path *path,
174 unsigned new_locks_want)
176 new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
178 return path->locks_want < new_locks_want
179 ? __bch2_btree_path_upgrade(trans, path, new_locks_want)
180 : path->uptodate == BTREE_ITER_UPTODATE;
183 void __bch2_btree_path_downgrade(struct btree_path *, unsigned);
185 static inline void bch2_btree_path_downgrade(struct btree_path *path)
187 unsigned new_locks_want = path->level + !!path->intent_ref;
189 if (path->locks_want > new_locks_want)
190 __bch2_btree_path_downgrade(path, new_locks_want);
193 void bch2_trans_downgrade(struct btree_trans *);
195 void bch2_trans_node_add(struct btree_trans *trans, struct btree *);
196 void bch2_trans_node_reinit_iter(struct btree_trans *, struct btree *);
198 int __must_check __bch2_btree_iter_traverse(struct btree_iter *iter);
199 int __must_check bch2_btree_iter_traverse(struct btree_iter *);
201 struct btree *bch2_btree_iter_peek_node(struct btree_iter *);
202 struct btree *bch2_btree_iter_next_node(struct btree_iter *);
204 struct bkey_s_c bch2_btree_iter_peek(struct btree_iter *);
205 struct bkey_s_c bch2_btree_iter_next(struct btree_iter *);
207 struct bkey_s_c bch2_btree_iter_peek_prev(struct btree_iter *);
208 struct bkey_s_c bch2_btree_iter_prev(struct btree_iter *);
210 struct bkey_s_c bch2_btree_iter_peek_slot(struct btree_iter *);
211 struct bkey_s_c bch2_btree_iter_next_slot(struct btree_iter *);
212 struct bkey_s_c bch2_btree_iter_prev_slot(struct btree_iter *);
214 bool bch2_btree_iter_advance(struct btree_iter *);
215 bool bch2_btree_iter_rewind(struct btree_iter *);
217 static inline void bch2_btree_iter_set_pos(struct btree_iter *iter, struct bpos new_pos)
219 if (!(iter->flags & BTREE_ITER_ALL_SNAPSHOTS))
220 new_pos.snapshot = iter->snapshot;
222 iter->k.type = KEY_TYPE_deleted;
223 iter->k.p.inode = iter->pos.inode = new_pos.inode;
224 iter->k.p.offset = iter->pos.offset = new_pos.offset;
225 iter->k.p.snapshot = iter->pos.snapshot = new_pos.snapshot;
227 if (iter->path->ref == 1)
228 iter->path->should_be_locked = false;
231 static inline void bch2_btree_iter_set_pos_to_extent_start(struct btree_iter *iter)
233 BUG_ON(!(iter->flags & BTREE_ITER_IS_EXTENTS));
234 iter->pos = bkey_start_pos(&iter->k);
237 static inline void bch2_btree_iter_set_snapshot(struct btree_iter *iter, u32 snapshot)
239 struct bpos pos = iter->pos;
241 iter->snapshot = snapshot;
242 pos.snapshot = snapshot;
243 bch2_btree_iter_set_pos(iter, pos);
247 * Unlocks before scheduling
248 * Note: does not revalidate iterator
250 static inline int bch2_trans_cond_resched(struct btree_trans *trans)
252 if (need_resched() || race_fault()) {
253 bch2_trans_unlock(trans);
255 return bch2_trans_relock(trans) ? 0 : -EINTR;
261 #define __for_each_btree_node(_trans, _iter, _btree_id, _start, \
262 _locks_want, _depth, _flags, _b, _ret) \
263 for (bch2_trans_node_iter_init((_trans), &(_iter), (_btree_id), \
264 _start, _locks_want, _depth, _flags), \
265 _b = bch2_btree_iter_peek_node(&(_iter)); \
266 !((_ret) = PTR_ERR_OR_ZERO(_b)) && (_b); \
267 (_b) = bch2_btree_iter_next_node(&(_iter)))
269 #define for_each_btree_node(_trans, _iter, _btree_id, _start, \
271 __for_each_btree_node(_trans, _iter, _btree_id, _start, \
272 0, 0, _flags, _b, _ret)
274 static inline struct bkey_s_c __bch2_btree_iter_peek(struct btree_iter *iter,
277 return flags & BTREE_ITER_SLOTS
278 ? bch2_btree_iter_peek_slot(iter)
279 : bch2_btree_iter_peek(iter);
282 static inline struct bkey_s_c __bch2_btree_iter_next(struct btree_iter *iter,
285 return flags & BTREE_ITER_SLOTS
286 ? bch2_btree_iter_next_slot(iter)
287 : bch2_btree_iter_next(iter);
290 static inline int bkey_err(struct bkey_s_c k)
292 return PTR_ERR_OR_ZERO(k.k);
295 #define for_each_btree_key(_trans, _iter, _btree_id, \
296 _start, _flags, _k, _ret) \
297 for (bch2_trans_iter_init((_trans), &(_iter), (_btree_id), \
298 (_start), (_flags)), \
299 (_k) = __bch2_btree_iter_peek(&(_iter), _flags); \
300 !((_ret) = bkey_err(_k)) && (_k).k; \
301 (_k) = __bch2_btree_iter_next(&(_iter), _flags))
303 #define for_each_btree_key_continue(_iter, _flags, _k, _ret) \
304 for ((_k) = __bch2_btree_iter_peek(&(_iter), _flags); \
305 !((_ret) = bkey_err(_k)) && (_k).k; \
306 (_k) = __bch2_btree_iter_next(&(_iter), _flags))
308 /* new multiple iterator interface: */
310 void bch2_dump_trans_paths_updates(struct btree_trans *);
312 void bch2_trans_iter_exit(struct btree_trans *, struct btree_iter *);
313 void bch2_trans_iter_init(struct btree_trans *, struct btree_iter *,
314 unsigned, struct bpos, unsigned);
315 void bch2_trans_node_iter_init(struct btree_trans *, struct btree_iter *,
316 enum btree_id, struct bpos,
317 unsigned, unsigned, unsigned);
318 void bch2_trans_copy_iter(struct btree_iter *, struct btree_iter *);
320 static inline void set_btree_iter_dontneed(struct btree_iter *iter)
322 iter->path->preserve = false;
325 void *bch2_trans_kmalloc(struct btree_trans *, size_t);
326 void bch2_trans_begin(struct btree_trans *);
327 void bch2_trans_init(struct btree_trans *, struct bch_fs *, unsigned, size_t);
328 void bch2_trans_exit(struct btree_trans *);
330 void bch2_btree_trans_to_text(struct printbuf *, struct bch_fs *);
332 void bch2_fs_btree_iter_exit(struct bch_fs *);
333 int bch2_fs_btree_iter_init(struct bch_fs *);
335 #endif /* _BCACHEFS_BTREE_ITER_H */