(c) Copyright 2017 Intel Corp. All rights reserved.version_number=2.00.1.0001

******************************************************************************************
MCE LINUX TEST MODULE              V2.00.1.0001                      01/11/2018
******************************************************************************************

1. lxmce

1.1. Overview

Version Information: 2.00.1.0001
Supported Platform: Server

Purpose and Scope
This Linux test module is used to analyze the MCE(Machine Check Exception) log file and monitor the file in order to find out the MCE errors and events that users are looking for.

Test Environment Requirements and Limitations
The Intel(R) Modular Test Architecture Test Executive for Linux and RHEL 6.5 or greater are required.

License Agreement
All code is under the Intel(R) software License which can be found at http://legal.intel.com. A copy of this agreement must be included if code is released outside Intel.
 


1.2. Change History

Release Date                Version #                SW Developer                Change Description
08/18/2017                  1.00.1.0001              LIW                         Initial Release
01/11/2018                  2.00.1.0001              LIW                         Add the MCE black list to ignore and skip specific MCE errors or events if needed 



1.3. Pre Configuration Setup

Files needed to run this module:
	
File           Description 
lxmcex64       Executable image. 
lxmcex64.snx   Configuration file. 
lxmce.txt      Text only help file. 
lxmce.chm      Smart help file. 

1.4. Error Code

The first three hexadecimal digits of any error code represent a unique number assigned to the module.  The middle two digits represent the test number. The last three digits are unique with each module and represent the message index in this list.

Error Code      Message
51Dxx000        Invalid test number. 
51Dxx001        Invalid or missing test parameter: "xxxxxx". 
51Dxx002        CPU machine check was found. 

2. Sub-Tests
Test 1          MCE_Log_Test
Test 2          System_Log_Test
Test 3          MCE_Log_Monitor


2.1. Test 1 - MCE_Log_Test

OVERVIEW

This test scans the MCE log file specified by the parameter MCE_Log_File to find out the MCE errors and events marked by the keywords defined in the MCE_Error_Filter parameter.

PARAMETERS USED

MCE_Log_File
MCE_Error_Filter


2.2. Test 2 - System_Log_Test

OVERVIEW

This test scans the system message file specified by the parameter System_Log_File to find out the MCE errors and events marked by the System_Log_Filter_Keywords parameter. 

PARAMETERS USED

System_Log_File
System_Log_Filter_Keywords


2.3. Test 3 - MCE_Log_Monitor

OVERVIEW

This test monitors the MCE log specified by the parameter MCE_Log_File to find out the MCE errors and events marked by the MCE_Error_Filter parameter. 

PARAMETERS USED

MCE_Log_File
MCE_Error_Filter
Monitor_Test_Runtime

3. Parameters

  
There are several configuration parameters that are used by this test module. Each parameter is described in detail in this help file.
  
MCE_Log_File
MCE_Error_Filter
System_Log_File
System_Log_Filter_Keywords
Monitor_Test_Runtime


3.1. MCE_Log_File

Description

This required parameter indicates the path to the MCE log file, which is located at the path /var/log by default or any other path specified by the system administrator.

Used By

MCE_Log_Test
MCE_Log_Monitor

3.2. MCE_Error_Filter

Description

This required parameter is the MCE error filter that has all keywords defined by users who look into MCE logs and filter out those targeted logs by those keywords.

Used By

MCE_Log_Test
MCE_Log_Monitor

3.3. System_Log_File

Description

This required parameter indicates the path to the system log file, which is located at the path /var/log by default or any other path specified by the system administrator.

Used By

System_Log_Test

3.4. System_Log_Filter_Keywords

Description

This required parameter is used to specify the keywords that used to filter out the MCE errors and events in the system log file. 

Used By

System_Log_Test

3.5. Monitor_Test_Runtime

Description

This optional parameter is used to specify the run time of the MCE monitor, which can be started to watch for MCE errors and events logged into the MCE log file in realtime. The default value of the parameter is 120 seconds. 

Used By

MCE_Log_Monitor

4. Glossary

MCE	- Machine Check Exception
