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