atomic/bitops: Clarify ordering semantics for failed test_and_{}_bit()
Subsystems (5)
PATCH 1/1 atomic/bitops: Clarify ordering semantics for failed test_and_{}_bit()
A test_and_{}_bit() operation fails if the value of the bit is such that the modification does not take place. For example, if test_and_set_bit() returns 1. In these cases, follow the behaviour of cmpxchg and allow the operation to be unordered. This also applies to test_and_set_bit_lock() if the lock is found to be be taken already.
--- Documentation/atomic_bitops.txt | 7 ++++++- include/asm-generic/bitops/lock.h | 3 ++- 2 files changed, 8 insertions(+), 2 deletions(-)
Documentation/atomic_bitops.txt +6 -1
@@ -58,7 +58,12 @@ Like with atomic_t, the rule of thumb is: - RMW operations that have a return value are fully ordered. -Except for test_and_set_bit_lock() which has ACQUIRE semantics and + - RMW operations that are conditional are unordered on FAILURE, + otherwise the above rules apply. In the case of test_and_{}_bit() operations, + if the bit in memory is unchanged by the operation then it is deemed to have + failed. + +Except for a successful test_and_set_bit_lock() which has ACQUIRE semantics and clear_bit_unlock() which has RELEASE semantics. Since a platform only has a single means of achieving atomic operations
include/asm-generic/bitops/lock.h +2 -1
@@ -7,7 +7,8 @@* @nr: Bit to set * @addr: Address to count from * -* This operation is atomic and provides acquire barrier semantics. +* This operation is atomic and provides acquire barrier semantics if +* the returned value is 0. * It can be used to implement bit locks. */ #define test_and_set_bit_lock (nr, addr) test_and_set_bit(nr, addr)
Signature · 1 line
2.1.4
Quoted 5 lines · Will Deacon
A test_and_{}_bit() operation fails if the value of the bit is such that the modification does not take place. For example, if
test_and_set_bit()returns 1. In these cases, follow the behaviour of cmpxchg and allow the operation to be unordered. This also applies totest_and_set_bit_lock()if the lock is found to be be taken already.
You also looked at a bunch of users, right? And while you found some dodgy ones, they were not more broken because of this IIRC.
Quoted 43 lines
Cc Peter Zijlstra <[email protected]>Cc "Paul E. McKenney" <[email protected]>Signed-off-by Will Deacon <[email protected]>--- Documentation/atomic_bitops.txt | 7 ++++++- include/asm-generic/bitops/lock.h | 3 ++- 2 files changed, 8 insertions(+), 2 deletions(-)Documentation/atomic_bitops.txt +6
-1@@ -58,7 +58,12 @@ Like with atomic_t, the rule of thumb is: - RMW operations that have a return value are fully ordered. -Except for test_and_set_bit_lock() which has ACQUIRE semantics and + - RMW operations that are conditional are unordered on FAILURE, + otherwise the above rules apply. In the case of test_and_{}_bit() operations, + if the bit in memory is unchanged by the operation then it is deemed to have + failed. + +Except for a successful test_and_set_bit_lock() which has ACQUIRE semantics and clear_bit_unlock() which has RELEASE semantics. Since a platform only has a single means of achieving atomic operationsinclude/asm-generic/bitops/lock.h +2
-1@@ -7,7 +7,8 @@* @nr: Bit to set * @addr: Address to count from * -* This operation is atomic and provides acquire barrier semantics. +* This operation is atomic and provides acquire barrier semantics if +* the returned value is 0. * It can be used to implement bit locks. */ #define test_and_set_bit_lock (nr, addr) test_and_set_bit(nr, addr)Signature · 1 line
2.1.4
tip-bot for Will Deacon
merge bot[tip:locking/urgent] locking/atomic/bitops: Document and clarify ordering semantics for failed test_and_{}_bit()
In reply to Will Deaconlocking/atomic/bitops: Document and clarify ordering semantics for failed test_and_{}_bit()
Commit-ID: 61e02392d3c7ecac1f91c0a90a8043d67e081846 Gitweb: https://git.kernel.org/tip/61e02392d3c7ecac1f91c0a90a8043d67e081846 Author: Will Deacon <[email protected]> AuthorDate: Tue, 13 Feb 2018 13:30:19 +0000 Committer: Ingo Molnar <[email protected]> CommitDate: Tue, 13 Feb 2018 14:55:53 +0100
locking/atomic/bitops: Document and clarify ordering semantics for failed test_and_{}_bit()
A test_and_{}_bit() operation fails if the value of the bit is such that the modification does not take place. For example, if test_and_set_bit() returns 1. In these cases, follow the behaviour of cmpxchg and allow the operation to be unordered. This also applies to test_and_set_bit_lock() if the lock is found to be be taken already.
--- Documentation/atomic_bitops.txt | 7 ++++++- include/asm-generic/bitops/lock.h | 3 ++- 2 files changed, 8 insertions(+), 2 deletions(-)
Documentation/atomic_bitops.txt +6 -1
@@ -58,7 +58,12 @@ Like with atomic_t, the rule of thumb is: - RMW operations that have a return value are fully ordered. -Except for test_and_set_bit_lock() which has ACQUIRE semantics and + - RMW operations that are conditional are unordered on FAILURE, + otherwise the above rules apply. In the case of test_and_{}_bit() operations, + if the bit in memory is unchanged by the operation then it is deemed to have + failed. + +Except for a successful test_and_set_bit_lock() which has ACQUIRE semantics and clear_bit_unlock() which has RELEASE semantics. Since a platform only has a single means of achieving atomic operations
include/asm-generic/bitops/lock.h +2 -1
@@ -7,7 +7,8 @@* @nr: Bit to set * @addr: Address to count from * -* This operation is atomic and provides acquire barrier semantics. +* This operation is atomic and provides acquire barrier semantics if +* the returned value is 0. * It can be used to implement bit locks. */ #define test_and_set_bit_lock (nr, addr) test_and_set_bit(nr, addr)