Skip to contentSkip to conversation

Add index markers

PATCH Applied Akira Yokosawa 2 participants 5 messages Apr 6, 2025

lore
Share & tools
lore
#0 lore raw

cover Add index markers

Subject: [PATCH -perfbook 0/3] Add index markers

Add index markers for the following terms/acronym:

- Linux kernel memory consistency model (LKMM)
- thermal throttling
- multicopy atomicity

For "multicopy atomicity", instances of closely related adjective forms are marked as well. See Patch 3/3.

Thanks, Akira
--
Akira Yokosawa (3):
memorder: Add index marker for "LKMM" as acronym
cpu, SMPdesign, debugging: Add index markers for "thermal throttling"
memorder: Add index markers for "multicopy atomicity"

 SMPdesign/criteria.tex  |  2 +-
 cpu/overview.tex        |  2 +-
 debugging/debugging.tex |  2 +-
 memorder/memorder.tex   | 36 +++++++++++++++++++++---------------
 4 files changed, 24 insertions(+), 18 deletions(-)

base-commit: dd844c5b3fcf839a409027967e05ccc3a8dbdd5c

Signature · 1 line
2.34.1
#1 lore raw

PATCH 1/3 memorder: Add index marker for "LKMM" as acronym

---
 memorder/memorder.tex | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
memorder/memorder.tex +2 -2
index 5c50d42d..46261137 100644
@@ -86,8 +86,8 @@ follows up with more detail on a few representative hardware platforms.
 	 {F. W. Nichol}
 
 This section is for people who would like to avoid learning all the
-details of the Linux-kernel memory model (LKMM), the better to get on with
-their concurrency lives.
+details of the Linux-kernel memory model (\IXacr{lkmm}), the better
+to get on with their concurrency lives.
 The good news is that learning a very small fraction of LKMM can get
 you most of its benefits.
 % @@@ \cref{tab:memorder:Linux-Kernel Memory-Ordering Cheat Sheet}
Signature · 1 line
2.34.1
#2 lore raw

PATCH 2/3 cpu, SMPdesign, debugging: Add index markers for "thermal throttling"

In reply to Akira Yokosawa
---
 SMPdesign/criteria.tex  | 2 +-
 cpu/overview.tex        | 2 +-
 debugging/debugging.tex | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)
SMPdesign/criteria.tex +1 -1
index 17152a90..2e98174b 100644
@@ -192,6 +192,6 @@ parallel program.
 }\QuickQuizEnd
 
 It is worth reiterating that contention has many guises, including
-lock contention, memory contention, cache overflow, thermal throttling,
+lock contention, memory contention, cache overflow, \IX{thermal throttling},
 and much else besides.
 This chapter looks primarily at lock and memory contention.
cpu/overview.tex +1 -1
index 715084ed..eedf8491 100644
@@ -345,7 +345,7 @@ wall-clock time consumed by that code has actually \emph{increased}.
 \ContributedBy{fig:cpu:Encounters Thermal Throttling}{Melissa Broussard, remixed}
 \end{figure}
 
-Welcome to modern thermal throttling.
+Welcome to modern \IX{thermal throttling}.
 
 If you reduced the number of clock cycles by making more effective
 use of the CPU's functional units, you will have increased the
debugging/debugging.tex +1 -1
index 832d27b2..0fcf4541 100644
@@ -2355,7 +2355,7 @@ to creep in, including:
 	Assuming that these sources of interference occur randomly,
 	their effect can be minimized by reducing the number of
 	iterations.
-\item	Thermal throttling can understate scalability because increasing
+\item	\IX{Thermal throttling} can understate scalability because increasing
 	CPU activity increases heat generation, and on systems without
 	adequate cooling (most of them!), this can result in the CPU
 	frequency decreasing as the number of CPUs increases.\footnote{
Signature · 1 line
2.34.1
#3 lore raw

PATCH 3/3 memorder: Add index markers for "multicopy atomicity"

In reply to Akira Yokosawa

Notes:
1. "other-multicopy atomicity" and "non-multicopy atomicity" want macros with alternative forms such as \IXalth{other-multicopy atomicity}{other-}{multicopy atomicity}, so that they don't have extra spaces after "other-" and "non-" in the printed text.

2. Several instances of "multicopy atomic" and friends are also marked for "multicopy atomicity".

---
 memorder/memorder.tex | 32 +++++++++++++++++++-------------
 1 file changed, 19 insertions(+), 13 deletions(-)
memorder/memorder.tex +19 -13
index 46261137..1a367509 100644
@@ -2273,7 +2273,7 @@ accommodate only one store at a time, then any pair of CPUs would
 agree on the order of all stores that they observed.
 Unfortunately, building a computer system as shown in the figure, without
 store buffers or even caches, would result in glacially slow computation.
-Most CPU vendors interested in providing multicopy atomicity therefore
+Most CPU vendors interested in providing \IXB{multicopy atomicity} therefore
 instead provide the slightly weaker
 \emph{other-multicopy atomicity}~\cite[Section B2.3]{ARMv8A:2017},
 which excludes the CPU doing a given store from the requirement that all
@@ -2287,7 +2287,7 @@ CPUs agree on the order of all stores.\footnote{
 	\cpageref{tab:memorder:Summary of Memory Ordering}.}
 This means that if only a subset of CPUs are doing stores, the
 other CPUs will agree on the order of stores, hence the ``other''
-in ``other-multicopy atomicity''.
+in ``\IXBalth{other-multicopy atomicity}{other-}{multicopy atomicity}''.
 Unlike multicopy-atomic platforms, within other-multicopy-atomic platforms,
 the CPU doing the store is permitted to observe its
 store early, which allows its later loads to obtain the newly stored
@@ -2332,8 +2332,8 @@ value directly from the store buffer, which improves performance.
 
 Perhaps there will come a day when all platforms provide some flavor
 of multi-copy atomicity, but
-in the meantime, non-multicopy-atomic platforms do exist, and so software
-must deal with them.
+in the meantime, \IXalth{non-multicopy-atomic}{non-}{multicopy atomicity}
+platforms do exist, and so software must deal with them.
 
 \begin{listing}
 \input{CodeSamples/formal/litmus/[email protected]}
@@ -3447,7 +3447,9 @@ bottom, confirming that this counter-intuitive really can happen.
 If you wish, you can click on ``Undo'' to explore other options or
 click on ``Reset'' to start over.
 It can be very helpful to carry out these steps in different orders
-to better understand how a non-multicopy-atomic architecture operates.
+to better understand how a
+\IXalth{non-multicopy-atomic}{non-}{multicopy atomicity}
+architecture operates.
 
 \QuickQuiz{
 	What happens if that \co{lwsync} instruction is instead a
@@ -5364,11 +5366,13 @@ sequential consistency.
 Performance considerations have dictated that no modern mainstream
 system is sequentially consistent.
 
-The next three rows cover multicopy atomicity, which was defined in
+The next three rows cover \IX{multicopy atomicity}, which was defined in
 \cref{sec:memorder:Multicopy Atomicity}.
-The first is full-up (and rare) multicopy atomicity, the second is the
-weaker other-multicopy atomicity, and the third is the weakest
-non-multicopy atomicity.
+The first is full-up (and rare)
+\IXalth{multicopy atomicity}{full}{multicopy atomicity}, the second is the
+weaker \IXalth{other-multicopy atomicity}{other-}{multicopy atomicity},
+and the third is the weakest
+\IXalth{non-multicopy atomicity}{non-}{multicopy atomicity}.
 
 The next row, ``Non-Cache Coherent'', covers accesses from multiple
 threads to a single variable, which was discussed in
@@ -6071,7 +6075,7 @@ instructions~\cite{PowerPC94,MichaelLyons05a}:
 	order of these stores.
 	Not so on PowerPC, even with an \co{lwsync} instruction between each
 	pair of memory-reference instructions, because PowerPC is
-	non-multicopy atomic.
+	\IXalth{non-multicopy atomic}{non-}{multicopy atomicity}.
 \item	[\tco{eieio}] (enforce in-order execution of I/O, in case you
 	were wondering) causes all preceding cacheable stores to appear
 	to have completed before all subsequent stores.
@@ -6233,7 +6237,8 @@ own stores as having happened earlier than this total global order
 would indicate.
 This exception to the total ordering is needed to allow important
 hardware optimizations involving store buffers.
-In addition, x86 provides other-multicopy atomicity, for example,
+In addition, x86 provides
+\IXalth{other-multicopy atomicity}{other-}{multicopy atomicity}, for example,
 so that if CPU~0 sees a store by CPU~1, then CPU~0 is guaranteed to see
 all stores that CPU~1 saw prior to its store.
 Software may use atomic operations to override these hardware optimizations,
@@ -6287,8 +6292,9 @@ but compiler constraints suffices for both the
 It also has strong memory-ordering semantics, as shown in
 \cref{tab:memorder:Summary of Memory Ordering}.
 In particular, all CPUs will agree on the order of unrelated stores from
-different CPUs, that is, the z~Systems CPU family is fully multicopy
-atomic, and is the only commercially available system with this property.
+different CPUs, that is, the z~Systems CPU family is
+\IXalth{fully multicopy atomic}{full}{multicopy atomicity},
+and is the only commercially available system with this property.
 
 As with most CPUs, the z~Systems architecture does not guarantee a
 cache-coherent instruction stream, hence,
Signature · 1 line
2.34.1
#4 lore raw
In reply to Akira Yokosawa
Quoted 10 lines · Akira Yokosawa

Subject: [PATCH -perfbook 0/3] Add index markers

Add index markers for the following terms/acronym:

- Linux kernel memory consistency model (LKMM)
- thermal throttling
- multicopy atomicity

For "multicopy atomicity", instances of closely related adjective forms are marked as well. See Patch 3/3.

Queued and pushed, thank you very much!!!

Thanx, Paul

Quoted 18 lines

Thanks, Akira
--
Akira Yokosawa (3):
memorder: Add index marker for "LKMM" as acronym
cpu, SMPdesign, debugging: Add index markers for "thermal throttling"
memorder: Add index markers for "multicopy atomicity"

 SMPdesign/criteria.tex  |  2 +-
 cpu/overview.tex        |  2 +-
 debugging/debugging.tex |  2 +-
 memorder/memorder.tex   | 36 +++++++++++++++++++++---------------
 4 files changed, 24 insertions(+), 18 deletions(-)

base-commit: dd844c5b3fcf839a409027967e05ccc3a8dbdd5c

Signature · 1 line
2.34.1