tools/memory-model: Document categories of ordering primitives
authorPaul E. McKenney <paulmck@kernel.org>
Tue, 11 Aug 2020 18:27:33 +0000 (11:27 -0700)
committerPaul E. McKenney <paulmck@kernel.org>
Sat, 7 Nov 2020 01:24:50 +0000 (17:24 -0800)
commitebb477cb2fb7a44ff600e0a7393bad906a0ecd80
treeec332876086de3b864e16d78762bf63a3255db40
parentab8bcad67bee82e4be290b32f0faaf582d7c3edc
tools/memory-model: Document categories of ordering primitives

The Linux kernel has a number of categories of ordering primitives, which
are recorded in the LKMM implementation and hinted at by cheatsheet.txt.
But there is no overview of these categories, and such an overview
is needed in order to understand multithreaded LKMM litmus tests.
This commit therefore adds an ordering.txt as well as extracting a
control-dependencies.txt from memory-barriers.txt.  It also updates the
README file.

[ paulmck:  Apply Akira Yokosawa file-placement feedback. ]
[ paulmck:  Apply Alan Stern feedback. ]
[ paulmck:  Apply self-review feedback. ]
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
tools/memory-model/Documentation/README
tools/memory-model/Documentation/control-dependencies.txt [new file with mode: 0644]
tools/memory-model/Documentation/ordering.txt [new file with mode: 0644]