xref: /linux/tools/memory-model/scripts/README (revision 37c600a3cc8a6941d77e853ec4e0e33fffa1046b)
1b02eb5b0SPaul E. McKenney			============
2b02eb5b0SPaul E. McKenney			LKMM SCRIPTS
3b02eb5b0SPaul E. McKenney			============
4b02eb5b0SPaul E. McKenney
5b02eb5b0SPaul E. McKenney
6b02eb5b0SPaul E. McKenneyThese scripts are run from the tools/memory-model directory.
7b02eb5b0SPaul E. McKenney
8b02eb5b0SPaul E. McKenneycheckalllitmus.sh
9b02eb5b0SPaul E. McKenney
10b02eb5b0SPaul E. McKenney	Run all litmus tests in the litmus-tests directory, checking
11b02eb5b0SPaul E. McKenney	the results against the expected results recorded in the
12b02eb5b0SPaul E. McKenney	"Result:" comment lines.
13b02eb5b0SPaul E. McKenney
14b02eb5b0SPaul E. McKenneycheckghlitmus.sh
15b02eb5b0SPaul E. McKenney
16b02eb5b0SPaul E. McKenney	Run all litmus tests in the https://github.com/paulmckrcu/litmus
17b02eb5b0SPaul E. McKenney	archive that are C-language and that have "Result:" comment lines
18b02eb5b0SPaul E. McKenney	documenting expected results, comparing the actual results to
19b02eb5b0SPaul E. McKenney	those expected.
20b02eb5b0SPaul E. McKenney
21b02eb5b0SPaul E. McKenneychecklitmushist.sh
22b02eb5b0SPaul E. McKenney
23b02eb5b0SPaul E. McKenney	Run all litmus tests having .litmus.out files from previous
24b02eb5b0SPaul E. McKenney	initlitmushist.sh or newlitmushist.sh runs, comparing the
25*37c600a3SAndrea Parri	herd7 output to that of the original runs.
26b02eb5b0SPaul E. McKenney
27b02eb5b0SPaul E. McKenneychecklitmus.sh
28b02eb5b0SPaul E. McKenney
29b02eb5b0SPaul E. McKenney	Check a single litmus test against its "Result:" expected result.
30b02eb5b0SPaul E. McKenney
31b02eb5b0SPaul E. McKenneycmplitmushist.sh
32b02eb5b0SPaul E. McKenney
33b02eb5b0SPaul E. McKenney	Compare output from two different runs of the same litmus tests,
34b02eb5b0SPaul E. McKenney	with the absolute pathnames of the tests to run provided one
35b02eb5b0SPaul E. McKenney	name per line on standard input.  Not normally run manually,
36b02eb5b0SPaul E. McKenney	provided instead for use by other scripts.
37b02eb5b0SPaul E. McKenney
38b02eb5b0SPaul E. McKenneyinitlitmushist.sh
39b02eb5b0SPaul E. McKenney
40b02eb5b0SPaul E. McKenney	Run all litmus tests having no more than the specified number
41b02eb5b0SPaul E. McKenney	of processes given a specified timeout, recording the results
42b02eb5b0SPaul E. McKenney	in .litmus.out files.
43b02eb5b0SPaul E. McKenney
44b02eb5b0SPaul E. McKenneyjudgelitmus.sh
45b02eb5b0SPaul E. McKenney
46*37c600a3SAndrea Parri	Given a .litmus file and its .litmus.out herd7 output, check the
47b02eb5b0SPaul E. McKenney	.litmus.out file against the .litmus file's "Result:" comment to
48b02eb5b0SPaul E. McKenney	judge whether the test ran correctly.  Not normally run manually,
49b02eb5b0SPaul E. McKenney	provided instead for use by other scripts.
50b02eb5b0SPaul E. McKenney
51b02eb5b0SPaul E. McKenneynewlitmushist.sh
52b02eb5b0SPaul E. McKenney
53b02eb5b0SPaul E. McKenney	For all new or updated litmus tests having no more than the
54b02eb5b0SPaul E. McKenney	specified number of processes given a specified timeout, run
55b02eb5b0SPaul E. McKenney	and record the results in .litmus.out files.
56b02eb5b0SPaul E. McKenney
57b02eb5b0SPaul E. McKenneyparseargs.sh
58b02eb5b0SPaul E. McKenney
59b02eb5b0SPaul E. McKenney	Parse command-line arguments.  Not normally run manually,
60b02eb5b0SPaul E. McKenney	provided instead for use by other scripts.
61b02eb5b0SPaul E. McKenney
62b02eb5b0SPaul E. McKenneyrunlitmushist.sh
63b02eb5b0SPaul E. McKenney
64b02eb5b0SPaul E. McKenney	Run the litmus tests whose absolute pathnames are provided one
65b02eb5b0SPaul E. McKenney	name per line on standard input.  Not normally run manually,
66b02eb5b0SPaul E. McKenney	provided instead for use by other scripts.
67b02eb5b0SPaul E. McKenney
68b02eb5b0SPaul E. McKenneyREADME
69b02eb5b0SPaul E. McKenney
70b02eb5b0SPaul E. McKenney	This file
71