1Xen MCE test suite
2---------------
3
4The Xen MCE test suite is a collection of tools and test scripts for
5testing the Xen MCE processing features. The goal is to cover
6most Xen MCE processing code paths and features with automation tests.
7
8
9In the Package
10--------------
11
12Here is a short description of what is included in the package
13
14README
15	This is document
16
17Makefile
18	For compile
19
20cases/*
21	Contains all test cases, which may be organized in sub-directories,
22	the interface of test case is a shell script under cases/, such as:
23	   -- cases/srao_mem/dom0/cases.sh
24
25config/*
26	Contains test configuration files, which specifies the parameters
27	for test cases, etc.
28
29lib/*
30	Contains some shell scripts, in which some common shell
31	functions and variable definitions are defined to be used by
32	test cases.
33
34tools/*
35	Tools used by MCE test suites, now only xen-mceinj tool.
36
37results/
38	When test is done, the test result will be placed in this
39	directory, test results	of various cases may be in corresponding
40	directory.
41	For example, files in
42	    results/srao_mem_dom0/result
43	is the result for test case cases/srao_mem/dom0/cases.sh, there will
44	be 3 result conditions: PASSED/FAILED/NORESULT.
45		results/<test_case>/testlog   #the test log during testing
46		results/<test_case>/mcelog    #mcelog output during testing
47		results/<test_case>/xenlog    #Xen log during testing
48		results/<test_case>/gklog     #VM guest kernel log during testing
49		results/<test_case>/guest_config   #config file used to create guest
50
51
52Test Instruction
53----------------
54
551.	make sure you have a dom0 with mce support
56	CONFIG_X86_MCE=y
57	CONFIG_X86_MCE_INTEL=y
58	CONFIG_X86_MCE_AMD=y
59	CONFIG_X86_MCE_THRESHOLD=y
60	CONFIG_X86_MCE_INJECT=y
61
622.	run system at xen and start xend. A installed guest image is
63	necessary when do guest MCE error injection.
643.	compile tools that used to test. in mce-test, $make.
65	Note: make sure compile xen/tools before do this step
664.	run test cases that you want.
67	e.g. $sh cases/srao_mem/dom0/cases.sh -d 0 -p 0x0200 -c 2 -t 1
685.	get test result in results directory
69
70
71Notes
72----------------
73All test cases fake a error and inject this error in 0x180020, For Xen
74test cases(e.g. cases/srao_mem/xen/cases.sh), error happen on every page
75may cause a Xen panic.
76