1f08c3bdfSopenharmony_ciMCE Stress Test Suite 
2f08c3bdfSopenharmony_ci=====================
3f08c3bdfSopenharmony_ci
4f08c3bdfSopenharmony_ciOct 10th, 2009
5f08c3bdfSopenharmony_ci
6f08c3bdfSopenharmony_ciHaicheng Li
7f08c3bdfSopenharmony_ci
8f08c3bdfSopenharmony_ci
9f08c3bdfSopenharmony_ciAbout the MCE stress test suite
10f08c3bdfSopenharmony_ci-------------------------------
11f08c3bdfSopenharmony_ci
12f08c3bdfSopenharmony_ciThe MCE stress test suite is a collection of tools and test scripts, which
13f08c3bdfSopenharmony_ciintends to achieve stress testing for Linux kernel MCA high level handlers
14f08c3bdfSopenharmony_cithat include HWPosion page recovery, soft page offline, and so on.
15f08c3bdfSopenharmony_ci
16f08c3bdfSopenharmony_ciIn general, this test suite is designed to do stress testing thru various
17f08c3bdfSopenharmony_citest interfaces, i.e. madvise syscall, HWPoison page injector, and APEI
18f08c3bdfSopenharmony_ciinjector (see ACPI4.0 spec). And it's able to support most of popular
19f08c3bdfSopenharmony_ciLinux File Systems (FS), that is, there is an option (i.e. -f) for user to
20f08c3bdfSopenharmony_cispecify which FS type they want the test to be running on.
21f08c3bdfSopenharmony_ci
22f08c3bdfSopenharmony_ci
23f08c3bdfSopenharmony_ciTest Dependencies
24f08c3bdfSopenharmony_ci-----------------
25f08c3bdfSopenharmony_ciMCE stress test suite has following dependencies on kernel and other tools:
26f08c3bdfSopenharmony_ci
27f08c3bdfSopenharmony_ci* Linux Kernel:
28f08c3bdfSopenharmony_ci  Version 2.6.32 or newer, with MCA high level handlers enabled.
29f08c3bdfSopenharmony_ci
30f08c3bdfSopenharmony_ci* ltp-pan: 
31f08c3bdfSopenharmony_ci  A test harness of Linux Test Project, http://ltp.sf.net.
32f08c3bdfSopenharmony_ci
33f08c3bdfSopenharmony_ci* page-types:
34f08c3bdfSopenharmony_ci  A tool to query page types, which is accompanied with Linux kernel
35f08c3bdfSopenharmony_ci  source (2.6.32 or newer, $KERNEL_SRC/Documentation/vm/page-types.c).
36f08c3bdfSopenharmony_ci
37f08c3bdfSopenharmony_ciPls. refer to the HOWTO doc (../doc/stress-howto.txt) to setup your test
38f08c3bdfSopenharmony_cienviroment.
39f08c3bdfSopenharmony_ci
40f08c3bdfSopenharmony_ci
41f08c3bdfSopenharmony_ciIn the package
42f08c3bdfSopenharmony_ci---------------
43f08c3bdfSopenharmony_ciHere is a short description of what is included in this test suite. 
44f08c3bdfSopenharmony_ci
45f08c3bdfSopenharmony_ciREADME
46f08c3bdfSopenharmony_ci        This document.
47f08c3bdfSopenharmony_ci
48f08c3bdfSopenharmony_ci../doc/stress-howto.txt
49f08c3bdfSopenharmony_ci	HOWTO doc, including design details and usage guide.
50f08c3bdfSopenharmony_ci
51f08c3bdfSopenharmony_ciMakefile
52f08c3bdfSopenharmony_ci        Makefile for MCE stress test suite.
53f08c3bdfSopenharmony_ci
54f08c3bdfSopenharmony_cihwposion.sh
55f08c3bdfSopenharmony_ci	Test driver.
56f08c3bdfSopenharmony_ci
57f08c3bdfSopenharmony_citools/*
58f08c3bdfSopenharmony_ci	Test workloads.		
59f08c3bdfSopenharmony_ci
60f08c3bdfSopenharmony_ci
61f08c3bdfSopenharmony_ciGet Started
62f08c3bdfSopenharmony_ci-----------
63f08c3bdfSopenharmony_ciPls. read through the HOWTO doc (../doc/stress-howto.txt) before you start
64f08c3bdfSopenharmony_cithe stress testing on your system.
65f08c3bdfSopenharmony_ci
66f08c3bdfSopenharmony_ciYou can also get help on specific test options in following way:
67f08c3bdfSopenharmony_ci# ./hwpoison.sh -h
68f08c3bdfSopenharmony_ci
69f08c3bdfSopenharmony_ci
70f08c3bdfSopenharmony_ciWarning!
71f08c3bdfSopenharmony_ci--------
72f08c3bdfSopenharmony_ciBe careful with these tests!
73f08c3bdfSopenharmony_ci
74f08c3bdfSopenharmony_ciDon't run them on production systems. They should not cause problems on 
75f08c3bdfSopenharmony_ciproperly functioning systems, they are intended to find (or cause) problems.
76