summaryrefslogtreecommitdiff
path: root/tools/memory-model/Documentation/README
diff options
context:
space:
mode:
authorAndrea Parri <parri.andrea@gmail.com>2024-06-19 03:06:04 +0200
committerPaul E. McKenney <paulmck@kernel.org>2024-09-13 23:56:43 -0700
commite8adbac0d44fe5f275902c004d04b0cfc33fce8d (patch)
tree75adfe273726c0ab49ccce61570c6899bdf1b62a /tools/memory-model/Documentation/README
parent8400291e289ee6b2bf9779ff1c83a291501f017b (diff)
downloadlinux-e8adbac0d44fe5f275902c004d04b0cfc33fce8d.tar.gz
linux-e8adbac0d44fe5f275902c004d04b0cfc33fce8d.tar.bz2
linux-e8adbac0d44fe5f275902c004d04b0cfc33fce8d.zip
tools/memory-model: Document herd7 (abstract) representation
The Linux-kernel memory model (LKMM) source code and the herd7 tool are closely linked in that the latter is responsible for (pre)processing each C-like macro of a litmus test, and for providing the LKMM with a set of events, or "representation", corresponding to the given macro. This commit therefore provides herd-representation.txt to document the representations of the concurrency macros, following their "classification" in Documentation/atomic_t.txt. Link: https://lore.kernel.org/all/ZnFZPJlILp5B9scN@andrea/ Suggested-by: Hernan Ponce de Leon <hernan.poncedeleon@huaweicloud.com> Signed-off-by: Andrea Parri <parri.andrea@gmail.com> Reviewed-by: Boqun Feng <boqun.feng@gmail.com> Reviewed-by: Hernan Ponce de Leon <hernan.poncedeleon@huaweicloud.com> Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Diffstat (limited to 'tools/memory-model/Documentation/README')
-rw-r--r--tools/memory-model/Documentation/README7
1 files changed, 6 insertions, 1 deletions
diff --git a/tools/memory-model/Documentation/README b/tools/memory-model/Documentation/README
index 304162743a5b..44e7dae73b29 100644
--- a/tools/memory-model/Documentation/README
+++ b/tools/memory-model/Documentation/README
@@ -33,7 +33,8 @@ o You are familiar with Linux-kernel concurrency and the use of
o You are familiar with Linux-kernel concurrency and the use
of LKMM, and would like to learn about LKMM's requirements,
- rationale, and implementation: explanation.txt
+ rationale, and implementation: explanation.txt and
+ herd-representation.txt
o You are interested in the publications related to LKMM, including
hardware manuals, academic literature, standards-committee
@@ -61,6 +62,10 @@ control-dependencies.txt
explanation.txt
Detailed description of the memory model.
+herd-representation.txt
+ The (abstract) representation of the Linux-kernel concurrency
+ primitives in terms of events.
+
litmus-tests.txt
The format, features, capabilities, and limitations of the litmus
tests that LKMM can evaluate.