Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 48d44d4e authored by Andrea Parri's avatar Andrea Parri Committed by Ingo Molnar
Browse files

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.

Suggested-by: default avatarIngo Molnar <mingo@kernel.org>
Signed-off-by: default avatarAndrea Parri <parri.andrea@gmail.com>
Signed-off-by: default avatarPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Acked-by: default avatarPeter Zijlstra <peterz@infradead.org>
Acked-by: default avatarWill Deacon <will.deacon@arm.com>
Acked-by: default avatarAlan Stern <stern@rowland.harvard.edu>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: akiyks@gmail.com
Cc: boqun.feng@gmail.com
Cc: dhowells@redhat.com
Cc: j.alglave@ucl.ac.uk
Cc: linux-arch@vger.kernel.org
Cc: luc.maranget@inria.fr
Cc: nborisov@suse.com
Cc: npiggin@gmail.com
Link: http://lkml.kernel.org/r/1519169112-20593-1-git-send-email-paulmck@linux.vnet.ibm.com


Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
parent 862e6e2a

tools/memory-model/MAINTAINERS

+1 −1
Original line number Diff line number Diff line 
LINUX KERNEL MEMORY MODEL

LINUX KERNEL MEMORY CONSISTENCY MODEL

M:	Alan Stern <stern@rowland.harvard.edu>

M:	Andrea Parri <parri.andrea@gmail.com>

M:	Will Deacon <will.deacon@arm.com>

tools/memory-model/README

+7 −7
Original line number Diff line number Diff line 
			=========================

			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
Original line number Diff line number Diff line
@@ -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
Original line number Diff line number Diff line
@@ -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.