181d2c6f8SDaniel Axtens /* SPDX-License-Identifier: GPL-2.0 */
281d2c6f8SDaniel Axtens
381d2c6f8SDaniel Axtens /*
481d2c6f8SDaniel Axtens * This file provides wrappers with sanitizer instrumentation for bit
581d2c6f8SDaniel Axtens * locking operations.
681d2c6f8SDaniel Axtens *
781d2c6f8SDaniel Axtens * To use this functionality, an arch's bitops.h file needs to define each of
881d2c6f8SDaniel Axtens * the below bit operations with an arch_ prefix (e.g. arch_set_bit(),
981d2c6f8SDaniel Axtens * arch___set_bit(), etc.).
1081d2c6f8SDaniel Axtens */
1181d2c6f8SDaniel Axtens #ifndef _ASM_GENERIC_BITOPS_INSTRUMENTED_LOCK_H
1281d2c6f8SDaniel Axtens #define _ASM_GENERIC_BITOPS_INSTRUMENTED_LOCK_H
1381d2c6f8SDaniel Axtens
1427f937ccSMarco Elver #include <linux/instrumented.h>
1581d2c6f8SDaniel Axtens
1681d2c6f8SDaniel Axtens /**
1781d2c6f8SDaniel Axtens * clear_bit_unlock - Clear a bit in memory, for unlock
1881d2c6f8SDaniel Axtens * @nr: the bit to set
1981d2c6f8SDaniel Axtens * @addr: the address to start counting from
2081d2c6f8SDaniel Axtens *
2181d2c6f8SDaniel Axtens * This operation is atomic and provides release barrier semantics.
2281d2c6f8SDaniel Axtens */
clear_bit_unlock(long nr,volatile unsigned long * addr)2381d2c6f8SDaniel Axtens static inline void clear_bit_unlock(long nr, volatile unsigned long *addr)
2481d2c6f8SDaniel Axtens {
25*04def1b9SMarco Elver kcsan_release();
2627f937ccSMarco Elver instrument_atomic_write(addr + BIT_WORD(nr), sizeof(long));
2781d2c6f8SDaniel Axtens arch_clear_bit_unlock(nr, addr);
2881d2c6f8SDaniel Axtens }
2981d2c6f8SDaniel Axtens
3081d2c6f8SDaniel Axtens /**
3181d2c6f8SDaniel Axtens * __clear_bit_unlock - Clears a bit in memory
3281d2c6f8SDaniel Axtens * @nr: Bit to clear
3381d2c6f8SDaniel Axtens * @addr: Address to start counting from
3481d2c6f8SDaniel Axtens *
3581d2c6f8SDaniel Axtens * This is a non-atomic operation but implies a release barrier before the
3681d2c6f8SDaniel Axtens * memory operation. It can be used for an unlock if no other CPUs can
3781d2c6f8SDaniel Axtens * concurrently modify other bits in the word.
3881d2c6f8SDaniel Axtens */
__clear_bit_unlock(long nr,volatile unsigned long * addr)3981d2c6f8SDaniel Axtens static inline void __clear_bit_unlock(long nr, volatile unsigned long *addr)
4081d2c6f8SDaniel Axtens {
41*04def1b9SMarco Elver kcsan_release();
4227f937ccSMarco Elver instrument_write(addr + BIT_WORD(nr), sizeof(long));
4381d2c6f8SDaniel Axtens arch___clear_bit_unlock(nr, addr);
4481d2c6f8SDaniel Axtens }
4581d2c6f8SDaniel Axtens
4681d2c6f8SDaniel Axtens /**
4781d2c6f8SDaniel Axtens * test_and_set_bit_lock - Set a bit and return its old value, for lock
4881d2c6f8SDaniel Axtens * @nr: Bit to set
4981d2c6f8SDaniel Axtens * @addr: Address to count from
5081d2c6f8SDaniel Axtens *
5181d2c6f8SDaniel Axtens * This operation is atomic and provides acquire barrier semantics if
5281d2c6f8SDaniel Axtens * the returned value is 0.
5381d2c6f8SDaniel Axtens * It can be used to implement bit locks.
5481d2c6f8SDaniel Axtens */
test_and_set_bit_lock(long nr,volatile unsigned long * addr)5581d2c6f8SDaniel Axtens static inline bool test_and_set_bit_lock(long nr, volatile unsigned long *addr)
5681d2c6f8SDaniel Axtens {
57b159eeccSMarco Elver instrument_atomic_read_write(addr + BIT_WORD(nr), sizeof(long));
5881d2c6f8SDaniel Axtens return arch_test_and_set_bit_lock(nr, addr);
5981d2c6f8SDaniel Axtens }
6081d2c6f8SDaniel Axtens
6181d2c6f8SDaniel Axtens #if defined(arch_clear_bit_unlock_is_negative_byte)
6281d2c6f8SDaniel Axtens /**
6381d2c6f8SDaniel Axtens * clear_bit_unlock_is_negative_byte - Clear a bit in memory and test if bottom
6481d2c6f8SDaniel Axtens * byte is negative, for unlock.
6581d2c6f8SDaniel Axtens * @nr: the bit to clear
6681d2c6f8SDaniel Axtens * @addr: the address to start counting from
6781d2c6f8SDaniel Axtens *
6881d2c6f8SDaniel Axtens * This operation is atomic and provides release barrier semantics.
6981d2c6f8SDaniel Axtens *
7081d2c6f8SDaniel Axtens * This is a bit of a one-trick-pony for the filemap code, which clears
7181d2c6f8SDaniel Axtens * PG_locked and tests PG_waiters,
7281d2c6f8SDaniel Axtens */
7381d2c6f8SDaniel Axtens static inline bool
clear_bit_unlock_is_negative_byte(long nr,volatile unsigned long * addr)7481d2c6f8SDaniel Axtens clear_bit_unlock_is_negative_byte(long nr, volatile unsigned long *addr)
7581d2c6f8SDaniel Axtens {
76*04def1b9SMarco Elver kcsan_release();
7727f937ccSMarco Elver instrument_atomic_write(addr + BIT_WORD(nr), sizeof(long));
7881d2c6f8SDaniel Axtens return arch_clear_bit_unlock_is_negative_byte(nr, addr);
7981d2c6f8SDaniel Axtens }
8081d2c6f8SDaniel Axtens /* Let everybody know we have it. */
8181d2c6f8SDaniel Axtens #define clear_bit_unlock_is_negative_byte clear_bit_unlock_is_negative_byte
8281d2c6f8SDaniel Axtens #endif
8381d2c6f8SDaniel Axtens
8481d2c6f8SDaniel Axtens #endif /* _ASM_GENERIC_BITOPS_INSTRUMENTED_LOCK_H */
85