Skip to content

Commit 9bc931e

Browse files
akiykspaulmckrcu
authored andcommitted
tools/memory-model: Add locking.txt and glossary.txt to README
locking.txt and glossary.txt have been in LKMM's documentation for quite a while. Add them in README's introduction of docs and the list of docs at the bottom. Add access-marking.txt in the former as well. Signed-off-by: Akira Yokosawa <[email protected]> Acked-by: Andrea Parri <[email protected]> Cc: Marco Elver <[email protected]> Signed-off-by: Paul E. McKenney <[email protected]>
1 parent e8adbac commit 9bc931e

File tree

1 file changed

+17
-0
lines changed
  • tools/memory-model/Documentation

1 file changed

+17
-0
lines changed

tools/memory-model/Documentation/README

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ depending on what you know and what you would like to learn. Please note
99
that the documents later in this list assume that the reader understands
1010
the material provided by documents earlier in this list.
1111

12+
If LKMM-specific terms lost you, glossary.txt might help you.
13+
1214
o You are new to Linux-kernel concurrency: simple.txt
1315

1416
o You have some background in Linux-kernel concurrency, and would
@@ -21,13 +23,21 @@ o You are familiar with the Linux-kernel concurrency primitives
2123
that you need, and just want to get started with LKMM litmus
2224
tests: litmus-tests.txt
2325

26+
o You would like to access lock-protected shared variables without
27+
having their corresponding locks held: locking.txt
28+
2429
o You are familiar with Linux-kernel concurrency, and would
2530
like a detailed intuitive understanding of LKMM, including
2631
situations involving more than two threads: recipes.txt
2732

2833
o You would like a detailed understanding of what your compiler can
2934
and cannot do to control dependencies: control-dependencies.txt
3035

36+
o You would like to mark concurrent normal accesses to shared
37+
variables so that intentional "racy" accesses can be properly
38+
documented, especially when you are responding to complaints
39+
from KCSAN: access-marking.txt
40+
3141
o You are familiar with Linux-kernel concurrency and the use of
3242
LKMM, and would like a quick reference: cheatsheet.txt
3343

@@ -62,6 +72,9 @@ control-dependencies.txt
6272
explanation.txt
6373
Detailed description of the memory model.
6474

75+
glossary.txt
76+
Brief definitions of LKMM-related terms.
77+
6578
herd-representation.txt
6679
The (abstract) representation of the Linux-kernel concurrency
6780
primitives in terms of events.
@@ -70,6 +83,10 @@ litmus-tests.txt
7083
The format, features, capabilities, and limitations of the litmus
7184
tests that LKMM can evaluate.
7285

86+
locking.txt
87+
Rules for accessing lock-protected shared variables outside of
88+
their corresponding critical sections.
89+
7390
ordering.txt
7491
Overview of the Linux kernel's low-level memory-ordering
7592
primitives by category.

0 commit comments

Comments
 (0)