Skip to contentSkip to conversation

tools/memory-model: clarify the origin/scope of the tool name

PATCH In review Andrea Parri 4 participants 10 messages Feb 1, 2018 – Feb 2, 2018 Linux kernel memory consistency model (lkmm)

lore
Share & tools
lore

Andrea Parri

author maintainer
#0 lore raw

PATCH 1/2 tools/memory-model: clarify the origin/scope of the tool name

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clearer that, in the context of tools/memory-model/, the term "memory-model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the full name in sources' headers and for the subsystem name.

---
 tools/memory-model/MAINTAINERS       |  2 +-
 tools/memory-model/README            | 14 +++++++-------
 tools/memory-model/linux-kernel.bell |  2 +-
 tools/memory-model/linux-kernel.cat  |  2 +-
 4 files changed, 10 insertions(+), 10 deletions(-)
tools/memory-model/MAINTAINERS +1 -1
index 711cbe72d6066..db3bd3fc0435b 100644
@@ -1,4 +1,4 @@
-LINUX KERNEL MEMORY MODEL
+LINUX KERNEL MEMORY CONSISTENCY MODEL
 M:	Alan Stern <[email protected]>
 M:	Andrea Parri <[email protected]>
 M:	Will Deacon <[email protected]>
tools/memory-model/README +7 -7
index 43ba49492111c..91414a49fac53 100644
@@ -1,15 +1,15 @@
-			=========================
-			LINUX KERNEL MEMORY MODEL
-			=========================
+		=====================================
+		LINUX KERNEL MEMORY CONSISTENCY MODEL
+		=====================================
 
 ============
 INTRODUCTION
 ============
 
-This directory contains the memory model of the Linux kernel, written
-in the "cat" language and executable by the (externally provided)
-"herd7" simulator, which exhaustively explores the state space of
-small litmus tests.
+This directory contains the memory consistency model (memory model, for
+short) of the Linux kernel, written in the "cat" language and executable
+by the externally provided "herd7" simulator, which exhaustively explores
+the state space of small litmus tests.
 
 In addition, the "klitmus7" tool (also externally provided) may be used
 to convert a litmus test to a Linux kernel module, which in turn allows
tools/memory-model/linux-kernel.bell +1 -1
index 57112505f5e03..b984bbda01a5c 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 enum Accesses = 'once (*READ_ONCE,WRITE_ONCE,ACCESS_ONCE*) ||
 		'release (*smp_store_release*) ||
tools/memory-model/linux-kernel.cat +1 -1
index 15b7a5dd8a9af..babe2b3b0bb32 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 (*
  * File "lock.cat" handles locks and is experimental.
Signature · 1 line
2.7.4
Acked-by on v1 1/2
#1 lore raw
Quoted 12 lines · Andrea Parri

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clearer that, in the context of tools/memory-model/, the term "memory-model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the full name in sources' headers and for the subsystem name.

Quoted 8 lines
---
 tools/memory-model/MAINTAINERS       |  2 +-
 tools/memory-model/README            | 14 +++++++-------
 tools/memory-model/linux-kernel.bell |  2 +-
 tools/memory-model/linux-kernel.cat  |  2 +-
 4 files changed, 10 insertions(+), 10 deletions(-)

Will

maintainer Acked-by on v1 1/2
#2 lore raw
In reply to Andrea Parri
Quoted 6 lines · Andrea Parri

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Quoted 8 lines

Make it clearer that, in the context of tools/memory-model/, the term "memory-model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the full name in sources' headers and for the subsystem name.

For both patches:

Acked-by Will Deacon Acked-by Alan Stern
#3 lore raw
Quoted 12 lines · Alan Stern
Quoted 10 lines · Andrea Parri

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clearer that, in the context of tools/memory-model/, the term "memory-model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Quoted 8 lines
Quoted 4 lines

Stick to the full name in sources' headers and for the subsystem name.

For both patches:

Thank you all -- I have queued this and pushed it to my RCU tree on branch lkmm. I did reword the commit log a bit, please see below and please let me know if any of my rewordings need halp.

Andrea, when you resend your second patch, could you please add Alan's Acked-by?

Thanx, Paul

------------------------------------------------------------------------

commit de175b697f71b8e3e6d980b7186b909fee0c4378

Author: Andrea Parri <[email protected]>
Date:   Thu Feb 1 13:03:29 2018 +0100

tools/memory-model: Clarify the origin/scope of the tool name

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clearer that tools/memory-model/ uses the term "memory model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the original "memory model" term in sources' headers and for the subsystem name.

tools/memory-model/MAINTAINERS +1 -1
index 711cbe72d606..db3bd3fc0435 100644
@@ -1,4 +1,4 @@
-LINUX KERNEL MEMORY MODEL
+LINUX KERNEL MEMORY CONSISTENCY MODEL
 M:	Alan Stern <[email protected]>
 M:	Andrea Parri <[email protected]>
 M:	Will Deacon <[email protected]>
tools/memory-model/README +7 -7
index 43ba49492111..91414a49fac5 100644
@@ -1,15 +1,15 @@
-			=========================
-			LINUX KERNEL MEMORY MODEL
-			=========================
+		=====================================
+		LINUX KERNEL MEMORY CONSISTENCY MODEL
+		=====================================
 
 ============
 INTRODUCTION
 ============
 
-This directory contains the memory model of the Linux kernel, written
-in the "cat" language and executable by the (externally provided)
-"herd7" simulator, which exhaustively explores the state space of
-small litmus tests.
+This directory contains the memory consistency model (memory model, for
+short) of the Linux kernel, written in the "cat" language and executable
+by the externally provided "herd7" simulator, which exhaustively explores
+the state space of small litmus tests.
 
 In addition, the "klitmus7" tool (also externally provided) may be used
 to convert a litmus test to a Linux kernel module, which in turn allows
tools/memory-model/linux-kernel.bell +1 -1
index 57112505f5e0..b984bbda01a5 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 enum Accesses = 'once (*READ_ONCE,WRITE_ONCE,ACCESS_ONCE*) ||
 		'release (*smp_store_release*) ||
tools/memory-model/linux-kernel.cat +1 -1
index 15b7a5dd8a9a..babe2b3b0bb3 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 (*
  * File "lock.cat" handles locks and is experimental.
author maintainer
#4 lore raw
Quoted 20 lines · Paul E. McKenney
Quoted 19 lines · Alan Stern
Quoted 6 lines · Andrea Parri

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Quoted 8 lines

Make it clearer that, in the context of tools/memory-model/, the term "memory-model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the full name in sources' headers and for the subsystem name.

For both patches:

Quoted 8 lines
Quoted 1 line

Thank you all -- I have queued this and pushed it to my RCU tree on branch lkmm. I did reword the commit log a bit, please see below and please let me know if any of my rewordings need halp.

Andrea, when you resend your second patch, could you please add Alan's Acked-by?

You mean in order to integrate Will's suggestion? I was planning to send that as a separate patch, as suggested by Will: the patch is on its way, IAC, please let me know if you'd prefer a V2 merging the two changes.

Andrea

Quoted 94 lines

Thanx, Paul

------------------------------------------------------------------------

commit de175b697f71b8e3e6d980b7186b909fee0c4378

Author: Andrea Parri <[email protected]>
Date:   Thu Feb 1 13:03:29 2018 +0100

tools/memory-model: Clarify the origin/scope of the tool name

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clearer that tools/memory-model/ uses the term "memory model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the original "memory model" term in sources' headers and for the subsystem name.

tools/memory-model/MAINTAINERS +1 -1
index 711cbe72d606..db3bd3fc0435 100644
@@ -1,4 +1,4 @@
-LINUX KERNEL MEMORY MODEL
+LINUX KERNEL MEMORY CONSISTENCY MODEL
 M:	Alan Stern <[email protected]>
 M:	Andrea Parri <[email protected]>
 M:	Will Deacon <[email protected]>
tools/memory-model/README +7 -7
index 43ba49492111..91414a49fac5 100644
@@ -1,15 +1,15 @@
-			=========================
-			LINUX KERNEL MEMORY MODEL
-			=========================
+		=====================================
+		LINUX KERNEL MEMORY CONSISTENCY MODEL
+		=====================================
 
 ============
 INTRODUCTION
 ============
 
-This directory contains the memory model of the Linux kernel, written
-in the "cat" language and executable by the (externally provided)
-"herd7" simulator, which exhaustively explores the state space of
-small litmus tests.
+This directory contains the memory consistency model (memory model, for
+short) of the Linux kernel, written in the "cat" language and executable
+by the externally provided "herd7" simulator, which exhaustively explores
+the state space of small litmus tests.
 
 In addition, the "klitmus7" tool (also externally provided) may be used
 to convert a litmus test to a Linux kernel module, which in turn allows
tools/memory-model/linux-kernel.bell +1 -1
index 57112505f5e0..b984bbda01a5 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 enum Accesses = 'once (*READ_ONCE,WRITE_ONCE,ACCESS_ONCE*) ||
 		'release (*smp_store_release*) ||
tools/memory-model/linux-kernel.cat +1 -1
index 15b7a5dd8a9a..babe2b3b0bb3 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 (*
  * File "lock.cat" handles locks and is experimental.
#5 lore raw
Quoted 27 lines · Andrea Parri
Quoted 26 lines · Paul E. McKenney
Quoted 12 lines · Alan Stern
Quoted 10 lines · Andrea Parri

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clearer that, in the context of tools/memory-model/, the term "memory-model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Quoted 8 lines
Quoted 4 lines

Stick to the full name in sources' headers and for the subsystem name.

For both patches:

Thank you all -- I have queued this and pushed it to my RCU tree on branch lkmm. I did reword the commit log a bit, please see below and please let me know if any of my rewordings need halp.

Quoted 6 lines
Quoted 2 lines

Andrea, when you resend your second patch, could you please add Alan's Acked-by?

You mean in order to integrate Will's suggestion? I was planning to send that as a separate patch, as suggested by Will: the patch is on its way, IAC, please let me know if you'd prefer a V2 merging the two changes.

Ah, apologies, I misread your reply. I have queued your second patch with Will's and Alan's Acked-by's.

Thanx, Paul

Quoted 98 lines

Andrea

Quoted 94 lines

Thanx, Paul

------------------------------------------------------------------------

commit de175b697f71b8e3e6d980b7186b909fee0c4378

Author: Andrea Parri <[email protected]>
Date:   Thu Feb 1 13:03:29 2018 +0100

tools/memory-model: Clarify the origin/scope of the tool name

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clearer that tools/memory-model/ uses the term "memory model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the original "memory model" term in sources' headers and for the subsystem name.

tools/memory-model/MAINTAINERS +1 -1
index 711cbe72d606..db3bd3fc0435 100644
@@ -1,4 +1,4 @@
-LINUX KERNEL MEMORY MODEL
+LINUX KERNEL MEMORY CONSISTENCY MODEL
 M:	Alan Stern <[email protected]>
 M:	Andrea Parri <[email protected]>
 M:	Will Deacon <[email protected]>
tools/memory-model/README +7 -7
index 43ba49492111..91414a49fac5 100644
@@ -1,15 +1,15 @@
-			=========================
-			LINUX KERNEL MEMORY MODEL
-			=========================
+		=====================================
+		LINUX KERNEL MEMORY CONSISTENCY MODEL
+		=====================================
 
 ============
 INTRODUCTION
 ============
 
-This directory contains the memory model of the Linux kernel, written
-in the "cat" language and executable by the (externally provided)
-"herd7" simulator, which exhaustively explores the state space of
-small litmus tests.
+This directory contains the memory consistency model (memory model, for
+short) of the Linux kernel, written in the "cat" language and executable
+by the externally provided "herd7" simulator, which exhaustively explores
+the state space of small litmus tests.
 
 In addition, the "klitmus7" tool (also externally provided) may be used
 to convert a litmus test to a Linux kernel module, which in turn allows
tools/memory-model/linux-kernel.bell +1 -1
index 57112505f5e0..b984bbda01a5 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 enum Accesses = 'once (*READ_ONCE,WRITE_ONCE,ACCESS_ONCE*) ||
 		'release (*smp_store_release*) ||
tools/memory-model/linux-kernel.cat +1 -1
index 15b7a5dd8a9a..babe2b3b0bb3 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 (*
  * File "lock.cat" handles locks and is experimental.
Acked-by Will Deacon Acked-by Alan Stern
#6 lore raw
Quoted 31 lines · Paul E. McKenney
Quoted 30 lines · Andrea Parri
Quoted 28 lines · Paul E. McKenney
Quoted 12 lines · Alan Stern
Quoted 10 lines · Andrea Parri

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clearer that, in the context of tools/memory-model/, the term "memory-model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Quoted 8 lines
Quoted 4 lines

Stick to the full name in sources' headers and for the subsystem name.

For both patches:

Thank you all -- I have queued this and pushed it to my RCU tree on branch lkmm. I did reword the commit log a bit, please see below and please let me know if any of my rewordings need halp.

Andrea, when you resend your second patch, could you please add Alan's Acked-by?

Quoted 6 lines
Quoted 3 lines

You mean in order to integrate Will's suggestion? I was planning to send that as a separate patch, as suggested by Will: the patch is on its way, IAC, please let me know if you'd prefer a V2 merging the two changes.

Ah, apologies, I misread your reply. I have queued your second patch with Will's and Alan's Acked-by's.

And I did reword the commit log a bit, so please check it.

Thanx, Paul

------------------------------------------------------------------------

commit 12a62a1d07031c0afa396b03334abbe30d9b9cf7

Author: Andrea Parri <[email protected]>
Date:   Thu Feb 1 13:04:26 2018 +0100

MAINTAINERS: Add the Memory Consistency Model subsystem

Move the contents of tools/memory-model/MAINTAINERS into the main MAINTAINERS file, removing tools/memory-model/MAINTAINERS. This allows get_maintainer.pl to correctly identify the maintainers of tools/memory-model/.

MAINTAINERS +16 -0
index e3581413420c..ba4dc08fbe95 100644
@@ -8086,6 +8086,22 @@ M:	Kees Cook <[email protected]>
 S:	Maintained
 F:	drivers/misc/lkdtm*
 
+LINUX KERNEL MEMORY CONSISTENCY MODEL
+M:	Alan Stern <[email protected]>
+M:	Andrea Parri <[email protected]>
+M:	Will Deacon <[email protected]>
+M:	Peter Zijlstra <[email protected]>
+M:	Boqun Feng <[email protected]>
+M:	Nicholas Piggin <[email protected]>
+M:	David Howells <[email protected]>
+M:	Jade Alglave <[email protected]>
+M:	Luc Maranget <[email protected]>
+M:	"Paul E. McKenney" <[email protected]>
+L:	[email protected]
+S:	Supported
+T:	git git://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git
+F:	tools/memory-model/
+
 LINUX SECURITY MODULE (LSM) FRAMEWORK
 M:	Chris Wright <[email protected]>
 L:	[email protected]
tools/memory-model/MAINTAINERS deleted +0 -15
deleted file mode 100644
index db3bd3fc0435..000000000000
@@ -1,15 +0,0 @@
-LINUX KERNEL MEMORY CONSISTENCY MODEL
-M:	Alan Stern <[email protected]>
-M:	Andrea Parri <[email protected]>
-M:	Will Deacon <[email protected]>
-M:	Peter Zijlstra <[email protected]>
-M:	Boqun Feng <[email protected]>
-M:	Nicholas Piggin <[email protected]>
-M:	David Howells <[email protected]>
-M:	Jade Alglave <[email protected]>
-M:	Luc Maranget <[email protected]>
-M:	"Paul E. McKenney" <[email protected]>
-L:	[email protected]
-S:	Supported
-T:	git git://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git
-F:	tools/memory-model/
author maintainer
#7 lore raw
In reply to Paul E. McKenney
Quoted 18 lines · Paul E. McKenney
Quoted 17 lines · Alan Stern
Quoted 14 lines · Andrea Parri

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clearer that, in the context of tools/memory-model/, the term "memory-model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the full name in sources' headers and for the subsystem name.

Quoted 7 lines
Quoted 3 lines

For both patches:

Thank you all -- I have queued this and pushed it to my RCU tree on branch lkmm. I did reword the commit log a bit, please see below and please let me know if any of my rewordings need halp.

Seems to me that your message has a leftover "is used".

Andrea

Quoted 97 lines

Andrea, when you resend your second patch, could you please add Alan's Acked-by?

Thanx, Paul

------------------------------------------------------------------------

commit de175b697f71b8e3e6d980b7186b909fee0c4378

Author: Andrea Parri <[email protected]>
Date:   Thu Feb 1 13:03:29 2018 +0100

tools/memory-model: Clarify the origin/scope of the tool name

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clearer that tools/memory-model/ uses the term "memory model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the original "memory model" term in sources' headers and for the subsystem name.

tools/memory-model/MAINTAINERS +1 -1
index 711cbe72d606..db3bd3fc0435 100644
@@ -1,4 +1,4 @@
-LINUX KERNEL MEMORY MODEL
+LINUX KERNEL MEMORY CONSISTENCY MODEL
 M:	Alan Stern <[email protected]>
 M:	Andrea Parri <[email protected]>
 M:	Will Deacon <[email protected]>
tools/memory-model/README +7 -7
index 43ba49492111..91414a49fac5 100644
@@ -1,15 +1,15 @@
-			=========================
-			LINUX KERNEL MEMORY MODEL
-			=========================
+		=====================================
+		LINUX KERNEL MEMORY CONSISTENCY MODEL
+		=====================================
 
 ============
 INTRODUCTION
 ============
 
-This directory contains the memory model of the Linux kernel, written
-in the "cat" language and executable by the (externally provided)
-"herd7" simulator, which exhaustively explores the state space of
-small litmus tests.
+This directory contains the memory consistency model (memory model, for
+short) of the Linux kernel, written in the "cat" language and executable
+by the externally provided "herd7" simulator, which exhaustively explores
+the state space of small litmus tests.
 
 In addition, the "klitmus7" tool (also externally provided) may be used
 to convert a litmus test to a Linux kernel module, which in turn allows
tools/memory-model/linux-kernel.bell +1 -1
index 57112505f5e0..b984bbda01a5 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 enum Accesses = 'once (*READ_ONCE,WRITE_ONCE,ACCESS_ONCE*) ||
 		'release (*smp_store_release*) ||
tools/memory-model/linux-kernel.cat +1 -1
index 15b7a5dd8a9a..babe2b3b0bb3 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 (*
  * File "lock.cat" handles locks and is experimental.
Acked-by Will Deacon Acked-by Alan Stern
#8 lore raw
Quoted 21 lines · Andrea Parri
Quoted 20 lines · Paul E. McKenney
Quoted 19 lines · Alan Stern
Quoted 6 lines · Andrea Parri

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Quoted 8 lines

Make it clearer that, in the context of tools/memory-model/, the term "memory-model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the full name in sources' headers and for the subsystem name.

For both patches:

Quoted 7 lines
Quoted 5 lines
Quoted 1 line

Thank you all -- I have queued this and pushed it to my RCU tree on branch lkmm. I did reword the commit log a bit, please see below and please let me know if any of my rewordings need halp.

Seems to me that your message has a leftover "is used".

Good catch, how about this instead?

Thanx, Paul

-----------------------------------------------------------------------

commit 2b1b4ab5166209da849f306fbdc84114d9e611fd

Author: Andrea Parri <[email protected]>
Date:   Thu Feb 1 13:03:29 2018 +0100

tools/memory-model: Clarify the origin/scope of the tool name

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clear that tools/memory-model/ uses the term "memory model" as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the original "memory model" term in sources' headers and for the subsystem name.

tools/memory-model/MAINTAINERS +1 -1
index 711cbe72d606..db3bd3fc0435 100644
@@ -1,4 +1,4 @@
-LINUX KERNEL MEMORY MODEL
+LINUX KERNEL MEMORY CONSISTENCY MODEL
 M:	Alan Stern <[email protected]>
 M:	Andrea Parri <[email protected]>
 M:	Will Deacon <[email protected]>
tools/memory-model/README +7 -7
index 43ba49492111..91414a49fac5 100644
@@ -1,15 +1,15 @@
-			=========================
-			LINUX KERNEL MEMORY MODEL
-			=========================
+		=====================================
+		LINUX KERNEL MEMORY CONSISTENCY MODEL
+		=====================================
 
 ============
 INTRODUCTION
 ============
 
-This directory contains the memory model of the Linux kernel, written
-in the "cat" language and executable by the (externally provided)
-"herd7" simulator, which exhaustively explores the state space of
-small litmus tests.
+This directory contains the memory consistency model (memory model, for
+short) of the Linux kernel, written in the "cat" language and executable
+by the externally provided "herd7" simulator, which exhaustively explores
+the state space of small litmus tests.
 
 In addition, the "klitmus7" tool (also externally provided) may be used
 to convert a litmus test to a Linux kernel module, which in turn allows
tools/memory-model/linux-kernel.bell +1 -1
index 57112505f5e0..b984bbda01a5 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 enum Accesses = 'once (*READ_ONCE,WRITE_ONCE,ACCESS_ONCE*) ||
 		'release (*smp_store_release*) ||
tools/memory-model/linux-kernel.cat +1 -1
index 15b7a5dd8a9a..babe2b3b0bb3 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 (*
  * File "lock.cat" handles locks and is experimental.
author maintainer
#9 lore raw
Quoted 24 lines · Paul E. McKenney
Quoted 23 lines · Andrea Parri
Quoted 22 lines · Paul E. McKenney
Quoted 20 lines · Alan Stern
Quoted 6 lines · Andrea Parri

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Quoted 8 lines

Make it clearer that, in the context of tools/memory-model/, the term "memory-model" is used as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the full name in sources' headers and for the subsystem name.

For both patches:

Quoted 7 lines
Quoted 5 lines
Quoted 3 lines

Thank you all -- I have queued this and pushed it to my RCU tree on branch lkmm. I did reword the commit log a bit, please see below and please let me know if any of my rewordings need halp.

Seems to me that your message has a leftover "is used".

Good catch, how about this instead?

Looks good to me. The same for 12a62a1d07031.

Thanks,
Andrea

Quoted 94 lines

Thanx, Paul

-----------------------------------------------------------------------

commit 2b1b4ab5166209da849f306fbdc84114d9e611fd

Author: Andrea Parri <[email protected]>
Date:   Thu Feb 1 13:03:29 2018 +0100

tools/memory-model: Clarify the origin/scope of the tool name

Ingo pointed out that:

"The "memory model" name is overly generic, ambiguous and somewhat
misleading, as we usually mean the virtual memory layout/model when we say "memory model". GCC too uses it in that sense [...]"

Make it clear that tools/memory-model/ uses the term "memory model" as shorthand for "memory consistency model" by calling out this convention in tools/memory-model/README.

Stick to the original "memory model" term in sources' headers and for the subsystem name.

tools/memory-model/MAINTAINERS +1 -1
index 711cbe72d606..db3bd3fc0435 100644
@@ -1,4 +1,4 @@
-LINUX KERNEL MEMORY MODEL
+LINUX KERNEL MEMORY CONSISTENCY MODEL
 M:	Alan Stern <[email protected]>
 M:	Andrea Parri <[email protected]>
 M:	Will Deacon <[email protected]>
tools/memory-model/README +7 -7
index 43ba49492111..91414a49fac5 100644
@@ -1,15 +1,15 @@
-			=========================
-			LINUX KERNEL MEMORY MODEL
-			=========================
+		=====================================
+		LINUX KERNEL MEMORY CONSISTENCY MODEL
+		=====================================
 
 ============
 INTRODUCTION
 ============
 
-This directory contains the memory model of the Linux kernel, written
-in the "cat" language and executable by the (externally provided)
-"herd7" simulator, which exhaustively explores the state space of
-small litmus tests.
+This directory contains the memory consistency model (memory model, for
+short) of the Linux kernel, written in the "cat" language and executable
+by the externally provided "herd7" simulator, which exhaustively explores
+the state space of small litmus tests.
 
 In addition, the "klitmus7" tool (also externally provided) may be used
 to convert a litmus test to a Linux kernel module, which in turn allows
tools/memory-model/linux-kernel.bell +1 -1
index 57112505f5e0..b984bbda01a5 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 enum Accesses = 'once (*READ_ONCE,WRITE_ONCE,ACCESS_ONCE*) ||
 		'release (*smp_store_release*) ||
tools/memory-model/linux-kernel.cat +1 -1
index 15b7a5dd8a9a..babe2b3b0bb3 100644
@@ -11,7 +11,7 @@
  * which is to appear in ASPLOS 2018.
  *)
 
-"Linux kernel memory model"
+"Linux-kernel memory consistency model"
 
 (*
  * File "lock.cat" handles locks and is experimental.