[PATCH lkmm v2 0/2] tools/memory-model: Add locking.txt and glossary.txt to README

[PATCH lkmm v2 0/2] tools/memory-model: Add locking.txt and glossary.txt to README

[Akira Yokosawa]

Hi all,

Here is a v2 series with the trailing white space fixed and Acked-by's
from Andrea applied.

Please find v1 at [1] if you need to.

[1]: https://lore.kernel.org/ae2b0f62-a593-4e7c-ab51-06d4e8a21005@gmail.com/

        Thanks, Akira
--
Akira Yokosawa (2):
  tools/memory-model: Add locking.txt and glossary.txt to README
  tools/memory-model: simple.txt: Fix stale reference to
    recipes-pairs.txt

 tools/memory-model/Documentation/README     | 17 +++++++++++++++++
 tools/memory-model/Documentation/simple.txt |  2 +-
 2 files changed, 18 insertions(+), 1 deletion(-)


base-commit: 5bdd17ab5a7259d2da562eab63abab3a6d95adcd
-- 
2.34.1

[PATCH lkmm v2 1/2] tools/memory-model: Add locking.txt and glossary.txt to README

[Akira Yokosawa]

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 <akiyks@gmail.com>
Acked-by: Andrea Parri <parri.andrea@gmail.com>
Cc: Marco Elver <elver@google.com>
---
v2:
  Removed trailing white space (Andrea).

--
 tools/memory-model/Documentation/README | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/tools/memory-model/Documentation/README b/tools/memory-model/Documentation/README
index 44e7dae73b29..9999c1effdb6 100644
--- a/tools/memory-model/Documentation/README
+++ b/tools/memory-model/Documentation/README
@@ -9,6 +9,8 @@ depending on what you know and what you would like to learn.  Please note
 that the documents later in this list assume that the reader understands
 the material provided by documents earlier in this list.
 
+If LKMM-specific terms lost you, glossary.txt might help you.
+
 o	You are new to Linux-kernel concurrency: simple.txt
 
 o	You have some background in Linux-kernel concurrency, and would
@@ -21,6 +23,9 @@ o	You are familiar with the Linux-kernel concurrency primitives
 	that you need, and just want to get started with LKMM litmus
 	tests:  litmus-tests.txt
 
+o	You would like to access lock-protected shared variables without
+	having their corresponding locks held:  locking.txt
+
 o	You are familiar with Linux-kernel concurrency, and would
 	like a detailed intuitive understanding of LKMM, including
 	situations involving more than two threads:  recipes.txt
@@ -28,6 +33,11 @@ o	You are familiar with Linux-kernel concurrency, and would
 o	You would like a detailed understanding of what your compiler can
 	and cannot do to control dependencies:  control-dependencies.txt
 
+o	You would like to mark concurrent normal accesses to shared
+	variables so that intentional "racy" accesses can be properly
+	documented, especially when you are responding to complaints
+	from KCSAN:  access-marking.txt
+
 o	You are familiar with Linux-kernel concurrency and the use of
 	LKMM, and would like a quick reference:  cheatsheet.txt
 
@@ -62,6 +72,9 @@ control-dependencies.txt
 explanation.txt
 	Detailed description of the memory model.
 
+glossary.txt
+	Brief definitions of LKMM-related terms.
+
 herd-representation.txt
 	The (abstract) representation of the Linux-kernel concurrency
 	primitives in terms of events.
@@ -70,6 +83,10 @@ litmus-tests.txt
 	The format, features, capabilities, and limitations of the litmus
 	tests that LKMM can evaluate.
 
+locking.txt
+	Rules for accessing lock-protected shared variables outside of
+	their corresponding critical sections.
+
 ordering.txt
 	Overview of the Linux kernel's low-level memory-ordering
 	primitives by category.
-- 
2.34.1

[PATCH lkmm v2 2/2] tools/memory-model: simple.txt: Fix stale reference to recipes-pairs.txt

[Akira Yokosawa]

There has never been recipes-paris.txt at least since v5.11.
Fix the typo.

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Acked-by: Andrea Parri <parri.andrea@gmail.com>
---
v2:
  No change.

--
 tools/memory-model/Documentation/simple.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/memory-model/Documentation/simple.txt b/tools/memory-model/Documentation/simple.txt
index 4c789ec8334f..21f06c1d1b70 100644
--- a/tools/memory-model/Documentation/simple.txt
+++ b/tools/memory-model/Documentation/simple.txt
@@ -266,5 +266,5 @@ More complex use cases
 ======================
 
 If the alternatives above do not do what you need, please look at the
-recipes-pairs.txt file to peel off the next layer of the memory-ordering
+recipes.txt file to peel off the next layer of the memory-ordering
 onion.
-- 
2.34.1

Re: [PATCH lkmm v2 0/2] tools/memory-model: Add locking.txt and glossary.txt to README

[Paul E. McKenney]

On Tue, Jun 25, 2024 at 05:56:49PM +0900, Akira Yokosawa wrote:
> Hi all,
> 
> Here is a v2 series with the trailing white space fixed and Acked-by's
> from Andrea applied.
> 
> Please find v1 at [1] if you need to.
> 
> [1]: https://lore.kernel.org/ae2b0f62-a593-4e7c-ab51-06d4e8a21005@gmail.com/
> 
>         Thanks, Akira

Queued for further review, thank you all!

							Thanx, Paul

> --
> Akira Yokosawa (2):
>   tools/memory-model: Add locking.txt and glossary.txt to README
>   tools/memory-model: simple.txt: Fix stale reference to
>     recipes-pairs.txt
> 
>  tools/memory-model/Documentation/README     | 17 +++++++++++++++++
>  tools/memory-model/Documentation/simple.txt |  2 +-
>  2 files changed, 18 insertions(+), 1 deletion(-)
> 
> 
> base-commit: 5bdd17ab5a7259d2da562eab63abab3a6d95adcd
> -- 
> 2.34.1
>