tools/memory-model: Document data_race(READ_ONCE())
authorPaul E. McKenney <paulmck@kernel.org>
Tue, 18 May 2021 17:47:43 +0000 (10:47 -0700)
committerPaul E. McKenney <paulmck@kernel.org>
Tue, 27 Jul 2021 18:48:55 +0000 (11:48 -0700)
commit87859a8e3f083bd57b34e6a962544d775a76b15f
tree1e53444eca0d174121d6b2d0373aca0db902ecdb
parentf92975d76d537c06a2118f9c3c63432c0f7c7a88
tools/memory-model: Document data_race(READ_ONCE())

It is possible to cause KCSAN to ignore marked accesses by applying
__no_kcsan to the function or applying data_race() to the marked accesses.
These approaches allow the developer to restrict compiler optimizations
while also causing KCSAN to ignore diagnostic accesses.

This commit therefore updates the documentation accordingly.

Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
tools/memory-model/Documentation/access-marking.txt