android/android_kernel_samsung_sm8650
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tools/memory-model: doc: Describe the requirement of the litmus-tests directory

Browse Source 
It's better that we have some "standard" about which test should be put
in the litmus-tests directory because it helps future contributors
understand whether they should work on litmus-tests in kernel or Paul's
GitHub repo. Therefore explain a little bit on what a "representative"
litmus test is.

Signed-off-by: Boqun Feng <boqun.feng@gmail.com>
Acked-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
This commit is contained in:
Boqun Feng 2021-10-25 22:54:15 +08:00 committed by Paul E. McKenney
parent ddfe12944e
commit b47c05ecf6
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
tools/memory-model/README
View File

@ -195,6 +195,18 @@ litmus-tests
are listed in litmus-tests/README. A great deal more litmus are listed in litmus-tests/README. A great deal more litmus
tests are available at https://github.com/paulmckrcu/litmus. tests are available at https://github.com/paulmckrcu/litmus.
By "representative", it means the one in the litmus-tests
directory is:
1) simple, the number of threads should be relatively
small and each thread function should be relatively
simple.
2) orthogonal, there should be no two litmus tests
describing the same aspect of the memory model.
3) textbook, developers can easily copy-paste-modify
the litmus tests to use the patterns on their own
code.
lock.cat lock.cat
Provides a front-end analysis of lock acquisition and release, Provides a front-end analysis of lock acquisition and release,
for example, associating a lock acquisition with the preceding for example, associating a lock acquisition with the preceding