1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_BTREE_LOCKING_H
3 #define _BCACHEFS_BTREE_LOCKING_H
6 * Only for internal btree use:
8 * The btree iterator tracks what locks it wants to take, and what locks it
9 * currently has - here we have wrappers for locking/unlocking btree nodes and
10 * updating the iterator state
13 #include "btree_iter.h"
16 void bch2_btree_lock_init(struct btree_bkey_cached_common *, enum six_lock_init_flags);
19 void bch2_assert_btree_nodes_not_locked(void);
21 static inline void bch2_assert_btree_nodes_not_locked(void) {}
24 void bch2_trans_unlock_noassert(struct btree_trans *);
26 static inline bool is_btree_node(struct btree_path *path, unsigned l)
28 return l < BTREE_MAX_DEPTH && !IS_ERR_OR_NULL(path->l[l].b);
31 static inline struct btree_transaction_stats *btree_trans_stats(struct btree_trans *trans)
33 return trans->fn_idx < ARRAY_SIZE(trans->c->btree_transaction_stats)
34 ? &trans->c->btree_transaction_stats[trans->fn_idx]
38 /* matches six lock types */
39 enum btree_node_locked_type {
40 BTREE_NODE_UNLOCKED = -1,
41 BTREE_NODE_READ_LOCKED = SIX_LOCK_read,
42 BTREE_NODE_INTENT_LOCKED = SIX_LOCK_intent,
43 BTREE_NODE_WRITE_LOCKED = SIX_LOCK_write,
46 static inline int btree_node_locked_type(struct btree_path *path,
49 return BTREE_NODE_UNLOCKED + ((path->nodes_locked >> (level << 1)) & 3);
52 static inline bool btree_node_write_locked(struct btree_path *path, unsigned l)
54 return btree_node_locked_type(path, l) == BTREE_NODE_WRITE_LOCKED;
57 static inline bool btree_node_intent_locked(struct btree_path *path, unsigned l)
59 return btree_node_locked_type(path, l) == BTREE_NODE_INTENT_LOCKED;
62 static inline bool btree_node_read_locked(struct btree_path *path, unsigned l)
64 return btree_node_locked_type(path, l) == BTREE_NODE_READ_LOCKED;
67 static inline bool btree_node_locked(struct btree_path *path, unsigned level)
69 return btree_node_locked_type(path, level) != BTREE_NODE_UNLOCKED;
72 static inline void mark_btree_node_locked_noreset(struct btree_path *path,
74 enum btree_node_locked_type type)
76 /* relying on this to avoid a branch */
77 BUILD_BUG_ON(SIX_LOCK_read != 0);
78 BUILD_BUG_ON(SIX_LOCK_intent != 1);
80 path->nodes_locked &= ~(3U << (level << 1));
81 path->nodes_locked |= (type + 1) << (level << 1);
84 static inline void mark_btree_node_unlocked(struct btree_path *path,
87 EBUG_ON(btree_node_write_locked(path, level));
88 mark_btree_node_locked_noreset(path, level, BTREE_NODE_UNLOCKED);
91 static inline void mark_btree_node_locked(struct btree_trans *trans,
92 struct btree_path *path,
94 enum btree_node_locked_type type)
96 mark_btree_node_locked_noreset(path, level, (enum btree_node_locked_type) type);
97 #ifdef CONFIG_BCACHEFS_LOCK_TIME_STATS
98 path->l[level].lock_taken_time = local_clock();
102 static inline enum six_lock_type __btree_lock_want(struct btree_path *path, int level)
104 return level < path->locks_want
109 static inline enum btree_node_locked_type
110 btree_lock_want(struct btree_path *path, int level)
112 if (level < path->level)
113 return BTREE_NODE_UNLOCKED;
114 if (level < path->locks_want)
115 return BTREE_NODE_INTENT_LOCKED;
116 if (level == path->level)
117 return BTREE_NODE_READ_LOCKED;
118 return BTREE_NODE_UNLOCKED;
121 static void btree_trans_lock_hold_time_update(struct btree_trans *trans,
122 struct btree_path *path, unsigned level)
124 #ifdef CONFIG_BCACHEFS_LOCK_TIME_STATS
125 struct btree_transaction_stats *s = btree_trans_stats(trans);
128 __bch2_time_stats_update(&s->lock_hold_times,
129 path->l[level].lock_taken_time,
136 static inline void btree_node_unlock(struct btree_trans *trans,
137 struct btree_path *path, unsigned level)
139 int lock_type = btree_node_locked_type(path, level);
141 EBUG_ON(level >= BTREE_MAX_DEPTH);
143 if (lock_type != BTREE_NODE_UNLOCKED) {
144 six_unlock_type(&path->l[level].b->c.lock, lock_type);
145 btree_trans_lock_hold_time_update(trans, path, level);
147 mark_btree_node_unlocked(path, level);
150 static inline int btree_path_lowest_level_locked(struct btree_path *path)
152 return __ffs(path->nodes_locked) >> 1;
155 static inline int btree_path_highest_level_locked(struct btree_path *path)
157 return __fls(path->nodes_locked) >> 1;
160 static inline void __bch2_btree_path_unlock(struct btree_trans *trans,
161 struct btree_path *path)
163 btree_path_set_dirty(path, BTREE_ITER_NEED_RELOCK);
165 while (path->nodes_locked)
166 btree_node_unlock(trans, path, btree_path_lowest_level_locked(path));
170 * Updates the saved lock sequence number, so that bch2_btree_node_relock() will
174 bch2_btree_node_unlock_write_inlined(struct btree_trans *trans, struct btree_path *path,
177 struct btree_path *linked;
179 EBUG_ON(path->l[b->c.level].b != b);
180 EBUG_ON(path->l[b->c.level].lock_seq != six_lock_seq(&b->c.lock));
181 EBUG_ON(btree_node_locked_type(path, b->c.level) != SIX_LOCK_write);
183 mark_btree_node_locked_noreset(path, b->c.level, BTREE_NODE_INTENT_LOCKED);
185 trans_for_each_path_with_node(trans, b, linked)
186 linked->l[b->c.level].lock_seq++;
188 six_unlock_write(&b->c.lock);
191 void bch2_btree_node_unlock_write(struct btree_trans *,
192 struct btree_path *, struct btree *);
194 int bch2_six_check_for_deadlock(struct six_lock *lock, void *p);
198 static inline int __btree_node_lock_nopath(struct btree_trans *trans,
199 struct btree_bkey_cached_common *b,
200 enum six_lock_type type,
201 bool lock_may_not_fail,
206 trans->lock_may_not_fail = lock_may_not_fail;
207 trans->lock_must_abort = false;
210 ret = six_lock_ip_waiter(&b->lock, type, &trans->locking_wait,
211 bch2_six_check_for_deadlock, trans, ip);
212 WRITE_ONCE(trans->locking, NULL);
213 WRITE_ONCE(trans->locking_wait.start_time, 0);
217 static inline int __must_check
218 btree_node_lock_nopath(struct btree_trans *trans,
219 struct btree_bkey_cached_common *b,
220 enum six_lock_type type,
223 return __btree_node_lock_nopath(trans, b, type, false, ip);
226 static inline void btree_node_lock_nopath_nofail(struct btree_trans *trans,
227 struct btree_bkey_cached_common *b,
228 enum six_lock_type type)
230 int ret = __btree_node_lock_nopath(trans, b, type, true, _THIS_IP_);
236 * Lock a btree node if we already have it locked on one of our linked
239 static inline bool btree_node_lock_increment(struct btree_trans *trans,
240 struct btree_bkey_cached_common *b,
242 enum btree_node_locked_type want)
244 struct btree_path *path;
246 trans_for_each_path(trans, path)
247 if (&path->l[level].b->c == b &&
248 btree_node_locked_type(path, level) >= want) {
249 six_lock_increment(&b->lock, (enum six_lock_type) want);
256 static inline int btree_node_lock(struct btree_trans *trans,
257 struct btree_path *path,
258 struct btree_bkey_cached_common *b,
260 enum six_lock_type type,
265 EBUG_ON(level >= BTREE_MAX_DEPTH);
266 EBUG_ON(!(trans->paths_allocated & (1ULL << path->idx)));
268 if (likely(six_trylock_type(&b->lock, type)) ||
269 btree_node_lock_increment(trans, b, level, (enum btree_node_locked_type) type) ||
270 !(ret = btree_node_lock_nopath(trans, b, type, btree_path_ip_allocated(path)))) {
271 #ifdef CONFIG_BCACHEFS_LOCK_TIME_STATS
272 path->l[b->level].lock_taken_time = local_clock();
279 int __bch2_btree_node_lock_write(struct btree_trans *, struct btree_path *,
280 struct btree_bkey_cached_common *b, bool);
282 static inline int __btree_node_lock_write(struct btree_trans *trans,
283 struct btree_path *path,
284 struct btree_bkey_cached_common *b,
285 bool lock_may_not_fail)
287 EBUG_ON(&path->l[b->level].b->c != b);
288 EBUG_ON(path->l[b->level].lock_seq != six_lock_seq(&b->lock));
289 EBUG_ON(!btree_node_intent_locked(path, b->level));
292 * six locks are unfair, and read locks block while a thread wants a
293 * write lock: thus, we need to tell the cycle detector we have a write
294 * lock _before_ taking the lock:
296 mark_btree_node_locked_noreset(path, b->level, BTREE_NODE_WRITE_LOCKED);
298 return likely(six_trylock_write(&b->lock))
300 : __bch2_btree_node_lock_write(trans, path, b, lock_may_not_fail);
303 static inline int __must_check
304 bch2_btree_node_lock_write(struct btree_trans *trans,
305 struct btree_path *path,
306 struct btree_bkey_cached_common *b)
308 return __btree_node_lock_write(trans, path, b, false);
311 void bch2_btree_node_lock_write_nofail(struct btree_trans *,
313 struct btree_bkey_cached_common *);
317 bool bch2_btree_path_relock_norestart(struct btree_trans *,
318 struct btree_path *, unsigned long);
319 int __bch2_btree_path_relock(struct btree_trans *,
320 struct btree_path *, unsigned long);
322 static inline int bch2_btree_path_relock(struct btree_trans *trans,
323 struct btree_path *path, unsigned long trace_ip)
325 return btree_node_locked(path, path->level)
327 : __bch2_btree_path_relock(trans, path, trace_ip);
330 bool __bch2_btree_node_relock(struct btree_trans *, struct btree_path *, unsigned, bool trace);
332 static inline bool bch2_btree_node_relock(struct btree_trans *trans,
333 struct btree_path *path, unsigned level)
335 EBUG_ON(btree_node_locked(path, level) &&
336 !btree_node_write_locked(path, level) &&
337 btree_node_locked_type(path, level) != __btree_lock_want(path, level));
339 return likely(btree_node_locked(path, level)) ||
340 (!IS_ERR_OR_NULL(path->l[level].b) &&
341 __bch2_btree_node_relock(trans, path, level, true));
344 static inline bool bch2_btree_node_relock_notrace(struct btree_trans *trans,
345 struct btree_path *path, unsigned level)
347 EBUG_ON(btree_node_locked(path, level) &&
348 !btree_node_write_locked(path, level) &&
349 btree_node_locked_type(path, level) != __btree_lock_want(path, level));
351 return likely(btree_node_locked(path, level)) ||
352 (!IS_ERR_OR_NULL(path->l[level].b) &&
353 __bch2_btree_node_relock(trans, path, level, false));
359 struct get_locks_fail {
364 bool bch2_btree_path_upgrade_noupgrade_sibs(struct btree_trans *,
365 struct btree_path *, unsigned,
366 struct get_locks_fail *);
368 bool __bch2_btree_path_upgrade(struct btree_trans *,
369 struct btree_path *, unsigned,
370 struct get_locks_fail *);
372 static inline int bch2_btree_path_upgrade(struct btree_trans *trans,
373 struct btree_path *path,
374 unsigned new_locks_want)
376 struct get_locks_fail f;
377 unsigned old_locks_want = path->locks_want;
379 new_locks_want = min(new_locks_want, BTREE_MAX_DEPTH);
381 if (path->locks_want < new_locks_want
382 ? __bch2_btree_path_upgrade(trans, path, new_locks_want, &f)
383 : path->uptodate == BTREE_ITER_UPTODATE)
386 trace_and_count(trans->c, trans_restart_upgrade, trans, _THIS_IP_, path,
387 old_locks_want, new_locks_want, &f);
388 return btree_trans_restart(trans, BCH_ERR_transaction_restart_upgrade);
393 static inline void btree_path_set_should_be_locked(struct btree_path *path)
395 EBUG_ON(!btree_node_locked(path, path->level));
396 EBUG_ON(path->uptodate);
398 path->should_be_locked = true;
401 static inline void __btree_path_set_level_up(struct btree_trans *trans,
402 struct btree_path *path,
405 btree_node_unlock(trans, path, l);
406 path->l[l].b = ERR_PTR(-BCH_ERR_no_btree_node_up);
409 static inline void btree_path_set_level_up(struct btree_trans *trans,
410 struct btree_path *path)
412 __btree_path_set_level_up(trans, path, path->level++);
413 btree_path_set_dirty(path, BTREE_ITER_NEED_TRAVERSE);
418 struct six_lock_count bch2_btree_node_lock_counts(struct btree_trans *,
420 struct btree_bkey_cached_common *b,
423 int bch2_check_for_deadlock(struct btree_trans *, struct printbuf *);
425 #ifdef CONFIG_BCACHEFS_DEBUG
426 void bch2_btree_path_verify_locks(struct btree_path *);
427 void bch2_trans_verify_locks(struct btree_trans *);
429 static inline void bch2_btree_path_verify_locks(struct btree_path *path) {}
430 static inline void bch2_trans_verify_locks(struct btree_trans *trans) {}
433 #endif /* _BCACHEFS_BTREE_LOCKING_H */