Skip to content

Commit 3a58abd

Browse files
committed
doc: capitalize headings
1 parent cf55251 commit 3a58abd

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ This project ports lock-free Multiple-Producer Single-Consumer (MPSC) queue algo
1414
- [Why MPI-3 RMA?](#why-mpi-3-rma)
1515
- [Hybrid MPI+MPI](#hybrid-mpimpi)
1616
- [Hybrid MPI+MPI+C++11](#hybrid-mpimpic11)
17-
- [Lock-free MPI porting](#lock-free-mpi-porting)
17+
- [Lock-Free MPI Porting](#lock-free-mpi-porting)
1818
- [Literature Review](#literature-review)
1919
- [Known Problems](#known-problems)
2020
- [Trends](#trends)
2121
- [Evaluation Strategy](#evaluation-strategy)
2222
- [Correctness](#correctness)
23-
- [Lock-freedom](#lock-freedom)
23+
- [Lock-Freedom](#lock-freedom)
2424
- [Performance](#performance)
2525
- [Scalability](#scalability)
2626

@@ -76,7 +76,7 @@ Pure MPI ignores intra-node locality. MPI-3 SHM provides `MPI_Win_allocate_share
7676

7777
C++11 atomics outperform MPI synchronization for intra-node communication. Using C++11 within shared memory windows optimizes the intra-node path.
7878

79-
### Lock-free MPI porting
79+
### Lock-Free MPI Porting
8080

8181
MPI-3 RMA enables lock-free implementations:
8282

@@ -149,7 +149,7 @@ We focus on the following criteria, in the order of decreasing importance:
149149
- ABA-freedom
150150
- Safe memory reclamation
151151

152-
### Lock-freedom
152+
### Lock-Freedom
153153

154154
No process may block system-wide progress. Note: lock-freedom depends on underlying primitives being lock-free on the target platform.
155155

implementations/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Porting challenges & strategies are discussed further in these algorithms' folde
66

77
Some have accompanying sections in the typst report to prove their correctness when modification to the original algorithms is necessary.
88

9-
## Ported algorithms
9+
## Ported Algorithms
1010

1111
- [`LTQueue` (Prasad Jayanti & Srdjan Petrovic)](/references/LTQueue/README.md): [implementation](/implementations/ltqueue)
1212

implementations/ltqueue/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# LTQueue (Prasad Jayanti, Srdjan Petrovic, 2005) - MPI port
1+
# LTQueue (Prasad Jayanti, Srdjan Petrovic, 2005) - MPI Port
22

33
Link: [paper](/references/LTQueue/README.md)
44

5-
## Naive port
5+
## Naive Port
66

77
### Replacing LL/SC
88

@@ -67,7 +67,7 @@ As LL/SC is not supported by MPI, we'll have to replace them using some other su
6767

6868
We'll investigate first scheme for the time being, which means find a way to avoid ABA problem.
6969

70-
#### Avoiding ABA problem
70+
#### Avoiding ABA Problem
7171

7272
The simplest approach is to use a monotonic version tag: Reserve some bits in the shared variable to use as a monotonic counter, so the shared variable now consists of two parts:
7373
* Control bits: The bits that comprise the meaningful value of the shared variable.
@@ -109,7 +109,7 @@ There is a nuance though. In the original version, the `timestamp` at each inter
109109
Cons:
110110
- Each time we read the internal node, we have to dereference the rank at the node to access the timestamp. This doubles network activities when accessing the internal node.
111111

112-
### Pseudo code after removing LL/SC
112+
### Pseudo Code After Removing LL/SC
113113

114114
SPSC is kept intact, and due to Prasad Jayanti and Srdjan Petrovic:
115115

@@ -247,7 +247,7 @@ function refresh(mpsc_t* q, tree_node_t* node)
247247
return CAS(&current_node->min_timestamp_rank, current_rank, (min_timestamp_rank, current_rank.version + 1))
248248
```
249249

250-
### Linearizability, Wait-freedom, Memory-safety
250+
### Linearizability, Wait-Freedom, Memory-Safety
251251

252252
### Porting
253253

implementations/slotqueue/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Slot-queue - A tailor-made optimized and simplified LTQueue for distributed context
1+
# Slot-Queue - A Tailor-Made Optimized and Simplified LTQueue for Distributed Context
22

33
This algorithm is inspired by both [Jiffy (Dolev Adas, Roy Friedman, 2022](/references/Jiffy/README.md) and [LTQueue (Prasad Jayanti, Srdjan Petrovic, 2005)](/references/LTQueue/README.md):
44
- The shared timestamp and double refresh trick is inspired by LTQueue to help Slot-queue wait-free.

report/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Thesis report
1+
# Thesis Report
22

33
This folder stores my thesis report: The summarized, comprehensive and focused culmination of this whole project.
44

0 commit comments

Comments
 (0)