linux-toradex.git/tools/memory-model/Documentation, branch v5.12-rc5

tools/memory-model: Tie acquire loads to reads-from

2021-01-04T22:40:49+00:00

This commit explicitly makes the connection between acquire loads and
the reads-from relation.  It also adds an entry for happens-before,
and refers to the corresponding section of explanation.txt.

Reported-by: Boqun Feng 
Signed-off-by: Paul E. McKenney

tools/memory-model: Add a glossary of LKMM terms

2020-11-07T01:24:53+00:00

[ paulmck: Apply Alan Stern feedback. ]
Signed-off-by: Paul E. McKenney

tools/memory-model: Document categories of ordering primitives

2020-11-07T01:24:50+00:00

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

tools/memory-model: Move Documentation description to Documentation/README

2020-10-26T23:18:53+00:00

This commit moves the descriptions of the files residing in
tools/memory-model/Documentation to a README file in that directory,
leaving behind the description of tools/memory-model/Documentation/README
itself.  After this change, tools/memory-model/Documentation/README
provides a guide to the files in the tools/memory-model/Documentation
directory, guiding people with different skills and needs to the most
appropriate starting point.

Signed-off-by: Paul E. McKenney

tools: memory-model: Document that the LKMM can easily miss control dependencies

2020-10-26T23:18:53+00:00

Add a small section to the litmus-tests.txt documentation file for
the Linux Kernel Memory Model explaining that the memory model often
fails to recognize certain control dependencies.

Suggested-by: Akira Yokosawa 
Signed-off-by: Alan Stern 
Reviewed-by: Joel Fernandes (Google) 
Signed-off-by: Paul E. McKenney

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

2020-09-04T18:58:15+00:00

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 
Signed-off-by: Paul E. McKenney

tools/memory-model: Add a simple entry point document

2020-09-03T16:51:01+00:00

Current LKMM documentation assumes that the reader already understands
concurrency in the Linux kernel, which won't necessarily always be the
case.  This commit supplies a simple.txt file that provides a starting
point for someone who is new to concurrency in the Linux kernel.
That said, this file might also useful as a reminder to experienced
developers of simpler approaches to dealing with concurrency.

Link: Link: https://lwn.net/Articles/827180/
[ paulmck: Apply feedback from Joel Fernandes. ]
Co-developed-by: Dave Chinner 
Signed-off-by: Dave Chinner 
Co-developed-by: Paul E. McKenney 
Signed-off-by: Paul E. McKenney

tools/memory-model: Improve litmus-test documentation

2020-09-03T16:51:01+00:00

The current LKMM documentation says very little about litmus tests, and
worse yet directs people to the herd7 documentation for more information.
Now, the herd7 documentation is quite voluminous and educational,
but it is intended for people creating and modifying memory models,
not those attempting to use them.

This commit therefore updates README and creates a litmus-tests.txt
file that gives an overview of litmus-test format and describes ways of
modeling various special cases, illustrated with numerous examples.

[ paulmck: Add Alan Stern feedback. ]
[ paulmck: Apply Dave Chinner feedback. ]
[ paulmck: Apply Andrii Nakryiko feedback. ]
[ paulmck: Apply Johannes Weiner feedback. ]
Link: https://lwn.net/Articles/827180/
Reported-by: Dave Chinner 
Acked-by: Peter Zijlstra (Intel) 
Signed-off-by: Paul E. McKenney

tools/memory-model: Update recipes.txt prime_numbers.c path

2020-09-03T16:51:00+00:00

The expand_to_next_prime() and next_prime_number() functions have moved
from lib/prime_numbers.c to lib/math/prime_numbers.c, so this commit
updates recipes.txt to reflect this change.

Signed-off-by: Paul E. McKenney

Replace HTTP links with HTTPS ones: LKMM

2020-09-03T16:51:00+00:00

Rationale:
Reduces attack surface on kernel devs opening the links for MITM
as HTTPS traffic is much harder to manipulate.

Deterministic algorithm:
For each file:
  If not .svg:
    For each line:
      If doesn't contain `\bxmlns\b`:
        For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`:
          If both the HTTP and HTTPS versions
          return 200 OK and serve the same content:
            Replace HTTP with HTTPS.

Signed-off-by: Alexander A. Klimov 
Signed-off-by: Paul E. McKenney