Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

tools/memory-model: Expand the cheatsheet.txt notion of relaxed

This commit adds a key entry enumerating the various types of relaxed
operations. While in the area, it also renames the relaxed rows.

[ paulmck: Apply Boqun Feng feedback. ]
Acked-by: Boqun Feng <boqun.feng@gmail.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>

+19 -14
+19 -14
tools/memory-model/Documentation/cheatsheet.txt
··· 3 3 C Self R W RMW Self R W DR DW RMW SV 4 4 -- ---- - - --- ---- - - -- -- --- -- 5 5 6 - Store, e.g., WRITE_ONCE() Y Y 7 - Load, e.g., READ_ONCE() Y Y Y Y 8 - Unsuccessful RMW operation Y Y Y Y 6 + Relaxed store Y Y 7 + Relaxed load Y Y Y Y 8 + Relaxed RMW operation Y Y Y Y 9 9 rcu_dereference() Y Y Y Y 10 10 Successful *_acquire() R Y Y Y Y Y Y 11 11 Successful *_release() C Y Y Y W Y ··· 17 17 smp_mb__after_atomic() CP a a Y Y Y Y Y Y 18 18 19 19 20 - Key: C: Ordering is cumulative 21 - P: Ordering propagates 22 - R: Read, for example, READ_ONCE(), or read portion of RMW 23 - W: Write, for example, WRITE_ONCE(), or write portion of RMW 24 - Y: Provides ordering 25 - a: Provides ordering given intervening RMW atomic operation 26 - DR: Dependent read (address dependency) 27 - DW: Dependent write (address, data, or control dependency) 28 - RMW: Atomic read-modify-write operation 29 - SELF: Orders self, as opposed to accesses before and/or after 30 - SV: Orders later accesses to the same variable 20 + Key: Relaxed: A relaxed operation is either READ_ONCE(), WRITE_ONCE(), 21 + a *_relaxed() RMW operation, an unsuccessful RMW 22 + operation, a non-value-returning RMW operation such 23 + as atomic_inc(), or one of the atomic*_read() and 24 + atomic*_set() family of operations. 25 + C: Ordering is cumulative 26 + P: Ordering propagates 27 + R: Read, for example, READ_ONCE(), or read portion of RMW 28 + W: Write, for example, WRITE_ONCE(), or write portion of RMW 29 + Y: Provides ordering 30 + a: Provides ordering given intervening RMW atomic operation 31 + DR: Dependent read (address dependency) 32 + DW: Dependent write (address, data, or control dependency) 33 + RMW: Atomic read-modify-write operation 34 + SELF: Orders self, as opposed to accesses before and/or after 35 + SV: Orders later accesses to the same variable