Blame Documentation/atomic_bitops.txt

Packit 7b02f3
Packit 7b02f3
On atomic bitops.
Packit 7b02f3
Packit 7b02f3
Packit 7b02f3
While our bitmap_{}() functions are non-atomic, we have a number of operations
Packit 7b02f3
operating on single bits in a bitmap that are atomic.
Packit 7b02f3
Packit 7b02f3
Packit 7b02f3
API
Packit 7b02f3
---
Packit 7b02f3
Packit 7b02f3
The single bit operations are:
Packit 7b02f3
Packit 7b02f3
Non-RMW ops:
Packit 7b02f3
Packit 7b02f3
  test_bit()
Packit 7b02f3
Packit 7b02f3
RMW atomic operations without return value:
Packit 7b02f3
Packit 7b02f3
  {set,clear,change}_bit()
Packit 7b02f3
  clear_bit_unlock()
Packit 7b02f3
Packit 7b02f3
RMW atomic operations with return value:
Packit 7b02f3
Packit 7b02f3
  test_and_{set,clear,change}_bit()
Packit 7b02f3
  test_and_set_bit_lock()
Packit 7b02f3
Packit 7b02f3
Barriers:
Packit 7b02f3
Packit 7b02f3
  smp_mb__{before,after}_atomic()
Packit 7b02f3
Packit 7b02f3
Packit 7b02f3
All RMW atomic operations have a '__' prefixed variant which is non-atomic.
Packit 7b02f3
Packit 7b02f3
Packit 7b02f3
SEMANTICS
Packit 7b02f3
---------
Packit 7b02f3
Packit 7b02f3
Non-atomic ops:
Packit 7b02f3
Packit 7b02f3
In particular __clear_bit_unlock() suffers the same issue as atomic_set(),
Packit 7b02f3
which is why the generic version maps to clear_bit_unlock(), see atomic_t.txt.
Packit 7b02f3
Packit 7b02f3
Packit 7b02f3
RMW ops:
Packit 7b02f3
Packit 7b02f3
The test_and_{}_bit() operations return the original value of the bit.
Packit 7b02f3
Packit 7b02f3
Packit 7b02f3
ORDERING
Packit 7b02f3
--------
Packit 7b02f3
Packit 7b02f3
Like with atomic_t, the rule of thumb is:
Packit 7b02f3
Packit 7b02f3
 - non-RMW operations are unordered;
Packit 7b02f3
Packit 7b02f3
 - RMW operations that have no return value are unordered;
Packit 7b02f3
Packit 7b02f3
 - RMW operations that have a return value are fully ordered.
Packit 7b02f3
Packit 7b02f3
 - RMW operations that are conditional are unordered on FAILURE,
Packit 7b02f3
   otherwise the above rules apply. In the case of test_and_{}_bit() operations,
Packit 7b02f3
   if the bit in memory is unchanged by the operation then it is deemed to have
Packit 7b02f3
   failed.
Packit 7b02f3
Packit 7b02f3
Except for a successful test_and_set_bit_lock() which has ACQUIRE semantics and
Packit 7b02f3
clear_bit_unlock() which has RELEASE semantics.
Packit 7b02f3
Packit 7b02f3
Since a platform only has a single means of achieving atomic operations
Packit 7b02f3
the same barriers as for atomic_t are used, see atomic_t.txt.
Packit 7b02f3