1MCE test suite 2--------------- 3 4The MCE test suite is a collection of tools and test scripts for 5testing the Linux kernel machine check error recovery 6features. This is the code that deals with recovery from memory 7bit errors and other hardware problems. 8 9For some more details on machine checks see http://www.mcelog.org 10 11The goal is to cover most Linux kernel MCE processing code paths 12and features with automation tests. 13 14In the Package 15-------------- 16 17Here is a short description of what is included in the package 18 19README 20 This document 21 22COPYING 23 GNU General Public License 24 25Makefile 26 Top level make file for MCE test suite 27 28drivers/* 29 Contains test drivers, which drive test procedure and do some 30 common works for test drivers. There is one directory for each 31 test driver, the user interface of a driver is the driver.sh 32 in corresponding directory, such as: 33 drivers/kdump/driver.sh 34 is user interface of kdump test driver. 35 36cases/* 37 Contains all test cases, which may be organized in 38 sub-directories, the interface of a class of test cases is a 39 shell script under cases/, such as: 40 -- cases/soft-inj/panic/cases.sh 41 is for test cases triggered by soft-inject and may cause system 42 panic during testing. 43 -- cases/apei-inj/ucr/cases.sh 44 is for test cases triggered by apei-inject. 45 46config/* 47 Contains test configuration files, which specifies the 48 parameters for test driver, which test cases are used in test, 49 the parameters for test cases, etc. 50 51tsrc/* 52 Some standalone test programs for various parts of the machine 53 check code. 54 55lib/* 56 Contains some shell scripts, in which some common shell 57 functions and variable definitions are defined to be used by 58 multiple test drivers or test cases. 59 60tools/* 61 Some tools used by MCE test suites. 62 63doc/* 64 Documentation for MCE test suites include howto and 65 descriptions of every test case. 66 67results/ 68 When test is done, the test result will be placed in this 69 directory, test results for a specific test driver will be 70 placed in corresponding directory, such as test results of 71 kdump test driver will be placed in "results/kdump". General 72 test result is in results/$driver/result; additional results 73 of various cases may be in corresponding directory, for 74 example, files in 75 results/kdump/soft-inj/panic/fatal/ 76 is for additional result for test case soft-inj/panic/fatal. 77 78work/ 79 During test, some temporary file will be put in work 80 directory, temporary files for a specific test driver will be 81 placed in corresponding directory, such as temporary files of 82 kdump test driver will be placed in "work/kdump". Test log is 83 in work/$driver/log. 84 85bin/ 86 Some tools used by test drivers or test cases will be 87 installed into this directory. 88 89stress/ 90 Linux MCE stress test suite. 91 92Test Instruction 93---------------- 94 95Please refer to corresponding section in doc/howto.txt. 96 97Very quick way to test this: 98 be root 99 make sure you have a kernel with CONFIG_X86_MCE_INJECT 100 and CONFIG_HWPOISON_INJECT and soft-offlining support 101 run "make test" 102 103Futher Information 104------------------ 105 106For futher information about MCE test suite, please refer to documents 107in doc sub-directory. 108 109doc/howto.txt: a more detailed HOWTO document 110 111doc/stress-howto.txt: Detailed HOWTO document for MCE stress test suite 112 113doc/cases/*.txt: Description of every test case, including test 114 objective, code patch tested, reference and 115 expected results 116