blob: 07e6d9601a5f0138317ee1054a95b9da2e86bde8 [file] [log] [blame]
#!/usr/bin/env python3
r"""
PEL functions.
"""
import func_args as fa
import bmc_ssh_utils as bsu
import json
import os
import sys
from robot.libraries.BuiltIn import BuiltIn
base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.append(base_path + "/data/")
import pel_variables
class peltool_exception(Exception):
r"""
Base class for peltool related exceptions.
"""
def __init__(self, message):
self.message = message
super().__init__(self.message)
def peltool(option_string, parse_json=True, **bsu_options):
r"""
Run peltool on the BMC with the caller's option string and return the result.
Example:
${pel_results}= Peltool -l
Rprint Vars pel_results
pel_results:
[0x50000031]:
[CompID]: 0x1000
[PLID]: 0x50000031
[Subsystem]: BMC Firmware
[Message]: An application had an internal failure
[SRC]: BD8D1002
[Commit Time]: 02/25/2020 04:51:31
[Sev]: Unrecoverable Error
[CreatorID]: BMC
Description of argument(s):
option_string A string of options which are to be processed by the peltool command.
parse_json Indicates that the raw JSON data should parsed into a list of
dictionaries.
bsu_options Options to be passed directly to bmc_execute_command. See its prolog for
details.
"""
bsu_options = fa.args_to_objects(bsu_options)
out_buf, stderr, rc = bsu.bmc_execute_command('peltool ' + option_string, **bsu_options)
if parse_json:
try:
return json.loads(out_buf)
except ValueError:
return {}
return out_buf
def get_pel_data_from_bmc(include_hidden_pels=False,
include_informational_pels=False):
r"""
Returns PEL data from BMC else throws exception.
Description of arguments:
include_hidden_pels True/False (default: False).
Set True to get hidden PELs else False.
include_informational_pels True/False (default: False).
Set True to get informational PELs else False.
"""
try:
pel_cmd = " -l"
if include_hidden_pels:
pel_cmd = pel_cmd + " -h"
if include_informational_pels:
pel_cmd = pel_cmd + " -f"
pel_data = peltool(pel_cmd)
if not pel_data:
print("No PEL data present in BMC ...")
except Exception as e:
raise peltool_exception("Failed to get PEL data from BMC : " + str(e))
return pel_data
def fetch_all_pel_ids_for_src(src_id, severity, include_hidden_pels=False):
r"""
Fetch all PEL IDs for the input SRC ID based on the severity type
in the list format.
Description of arguments:
src_id SRC ID (e.g. BCXXYYYY).
severity PEL severity (e.g. "Predictive Error"
"Recovered Error").
include_hidden_pels True/False (default: False).
Set True to get hidden PELs else False.
"""
try:
src_pel_ids = []
pel_data = get_pel_data_from_bmc(include_hidden_pels)
pel_id_list = pel_data.keys()
for pel_id in pel_id_list:
# Check if required SRC ID with severity is present
if ((pel_data[pel_id]["SRC"] == src_id) and (pel_data[pel_id]["Sev"] == severity)):
src_pel_ids.append(pel_id)
if not src_pel_ids:
raise peltool_exception(src_id + " with severity " + severity + " not present")
except Exception as e:
raise peltool_exception("Failed to fetch PEL ID for required SRC : " + str(e))
return src_pel_ids
def verify_src_signature_and_threshold(pel_id, attn_type, signature_desc, th_limit):
r"""
Verifies SRC details for the given PEL ID based on the required
attention type, signature description, threshold limits.
Description of arguments:
pel_id PEL ID for the required SRC details to verify.
attn_type Attention type (e.g. RE, CS, UNIT_CS).
signature_desc Signature description of the error inject.
th_limit Threshold limit (e.g. 1, 5, 32).
"""
try:
pel_cmd = " -i " + pel_id
src_data = peltool(pel_cmd)
src_dict = src_data["Primary SRC"]["SRC Details"]
usr_data = src_data["User Data 1"]
# Example for signature in recoverable error
#
# "SRC Details": {
# "Attention Type": "RECOVERABLE",
# "Node": 0,
# "Target Type": "TYPE_OMIC",
# "Target Instance": 0,
# "Signature": "MC_OMI_DL_FIR[1]: OMI-DL0 UE on data flit"
# }
if (attn_type == "RE"):
if (src_dict["Attention Type"] != "RECOVERABLE"):
raise peltool_exception("Required Attention type " + attn_type + " not found")
# Example for signature in system checkstop error
#
# "SRC Details": {
# "Primary Attention": "system checkstop",
# "Signature Description": {
# "Chip Desc": "node 0 proc 0 (P10 2.0)",
# "Signature": "EQ_L2_FIR(0)[7] L2 directory read UE",
# "Attn Type": "checkstop"
# }
elif (attn_type == "CS"):
if (src_dict["Primary Attention"] != "system checkstop"):
raise peltool_exception("Required Attention type " + attn_type + " not found")
elif (attn_type == "UNIT_CS"):
if (src_dict["Attention Type"] != "UNIT_CS"):
raise peltool_exception("Required Attention type " + attn_type + " not found")
else:
raise peltool_exception("Required Attention type " + attn_type + " not found")
if signature_desc not in src_dict["Signature"]:
raise peltool_exception("Required Signature " + signature_desc + " not found")
if (int(th_limit) != usr_data["Error Count"]):
raise peltool_exception("Required Threshold limit " + th_limit + " not found")
except Exception as e:
raise peltool_exception("Failed to verify SRC details : " + str(e))
return True
def fetch_all_src(include_hidden_pels=False):
r"""
Fetch all SRC IDs from peltool in the list format.
include_hidden_pels True/False (default: False).
Set True to get hidden PELs else False.
"""
try:
src_id = []
pel_data = get_pel_data_from_bmc(include_hidden_pels)
if pel_data:
pel_id_list = pel_data.keys()
for pel_id in pel_id_list:
src_id.append(pel_data[pel_id]["SRC"])
print("SRC IDs: " + str(src_id))
except Exception as e:
raise peltool_exception("Failed to fetch all SRCs : " + str(e))
return src_id
def check_for_unexpected_src(unexpected_src_list=[], include_hidden_pels=False):
r"""
From the given unexpected SRC list, check if any unexpected SRC created
on the BMC. Returns 0 if no SRC found else throws exception.
Description of arguments:
unexpected_src_list Give unexpected SRCs in the list format.
e.g.: ["BBXXYYYY", "AAXXYYYY"].
include_hidden_pels True/False (default: False).
Set True to get hidden PELs else False.
"""
try:
unexpected_src_count = 0
if not unexpected_src_list:
print("Unexpected SRC list is empty.")
src_data = fetch_all_src(include_hidden_pels)
for src in unexpected_src_list:
if src in src_data:
print("Found an unexpected SRC : " + src)
unexpected_src_count = unexpected_src_count + 1
if (unexpected_src_count >= 1):
raise peltool_exception("Unexpected SRC found.")
except Exception as e:
raise peltool_exception("Failed to verify unexpected SRC list : " + str(e))
return unexpected_src_count
def filter_unexpected_srcs(expected_srcs=None):
r"""
Return list of SRCs found in BMC after filtering expected SRCs.
If expected_srcs is None then all SRCs found in system are returned.
Description of arguments:
expected_srcs List of expected SRCs. E.g. ["BBXXYYYY", "AAXXYYYY"].
"""
srcs_found = fetch_all_src()
if not expected_srcs:
expected_srcs = []
print(expected_srcs)
return list(set(srcs_found) - set(expected_srcs))
def get_bmc_event_log_id_for_pel(pel_id):
r"""
Return BMC event log ID for the given PEL ID.
Description of arguments:
pel_id PEL ID. E.g. 0x50000021.
"""
pel_data = peltool("-i " + pel_id)
print(pel_data)
bmc_id_for_pel = pel_data["Private Header"]["BMC Event Log Id"]
return bmc_id_for_pel