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