1 /** 2 * Describes high level functions for converting an entire CPER log, and functions for parsing 3 * CPER headers and section descriptions into an intermediate JSON format. 4 * 5 * Author: Lawrence.Tang@arm.com 6 **/ 7 8 #include <stdio.h> 9 #include "json.h" 10 #include "b64.h" 11 #include "edk/Cper.h" 12 #include "cper-parse.h" 13 #include "cper-utils.h" 14 #include "sections/cper-section-generic.h" 15 #include "sections/cper-section-ia32x64.h" 16 #include "sections/cper-section-arm.h" 17 #include "sections/cper-section-memory.h" 18 #include "sections/cper-section-pcie.h" 19 #include "sections/cper-section-pci-bus.h" 20 #include "sections/cper-section-pci-dev.h" 21 #include "sections/cper-section-firmware.h" 22 #include "sections/cper-section-dmar-generic.h" 23 #include "sections/cper-section-dmar-vtd.h" 24 #include "sections/cper-section-dmar-iommu.h" 25 #include "sections/cper-section-ccix-per.h" 26 #include "sections/cper-section-cxl-protocol.h" 27 #include "sections/cper-section-ipf.h" 28 #include "sections/cper-section-cxl-component.h" 29 30 //Private pre-definitions. 31 json_object* cper_header_to_ir(EFI_COMMON_ERROR_RECORD_HEADER* header); 32 json_object* cper_section_descriptor_to_ir(EFI_ERROR_SECTION_DESCRIPTOR* section_descriptor); 33 json_object* cper_section_to_ir(FILE* handle, EFI_ERROR_SECTION_DESCRIPTOR* descriptor); 34 35 //Reads a CPER log file at the given file location, and returns an intermediate 36 //JSON representation of this CPER record. 37 json_object* cper_to_ir(FILE* cper_file) 38 { 39 //Ensure this is really a CPER log. 40 EFI_COMMON_ERROR_RECORD_HEADER header; 41 fseek(cper_file, 0, SEEK_SET); 42 if (fread(&header, sizeof(EFI_COMMON_ERROR_RECORD_HEADER), 1, cper_file) != 1) 43 { 44 printf("Invalid CPER file: Invalid length (log too short).\n"); 45 return NULL; 46 } 47 48 //Check if the header contains the magic bytes ("CPER"). 49 if (header.SignatureStart != EFI_ERROR_RECORD_SIGNATURE_START) { 50 printf("Invalid CPER file: Invalid header (incorrect signature).\n"); 51 return NULL; 52 } 53 54 //Create the header JSON object from the read bytes. 55 json_object* header_ir = cper_header_to_ir(&header); 56 57 //Read the appropriate number of section descriptors & sections, and convert them into IR format. 58 json_object* section_descriptors_ir = json_object_new_array(); 59 json_object* sections_ir = json_object_new_array(); 60 for (int i=0; i<header.SectionCount; i++) 61 { 62 //Create the section descriptor. 63 EFI_ERROR_SECTION_DESCRIPTOR section_descriptor; 64 if (fread(§ion_descriptor, sizeof(EFI_ERROR_SECTION_DESCRIPTOR), 1, cper_file) != 1) 65 { 66 printf("Invalid number of section headers: Header states %d sections, could not read section %d.\n", header.SectionCount, i+1); 67 return NULL; 68 } 69 json_object_array_add(section_descriptors_ir, cper_section_descriptor_to_ir(§ion_descriptor)); 70 71 //Read the section itself. 72 json_object_array_add(sections_ir, cper_section_to_ir(cper_file, §ion_descriptor)); 73 } 74 75 //Add the header, section descriptors, and sections to a parent object. 76 json_object* parent = json_object_new_object(); 77 json_object_object_add(parent, "header", header_ir); 78 json_object_object_add(parent, "sectionDescriptors", section_descriptors_ir); 79 json_object_object_add(parent, "sections", sections_ir); 80 81 return parent; 82 } 83 84 //Converts a parsed CPER record header into intermediate JSON object format. 85 json_object* cper_header_to_ir(EFI_COMMON_ERROR_RECORD_HEADER* header) 86 { 87 json_object* header_ir = json_object_new_object(); 88 89 //Revision/version information. 90 json_object_object_add(header_ir, "revision", revision_to_ir(header->Revision)); 91 92 //Section count. 93 json_object_object_add(header_ir, "sectionCount", json_object_new_int(header->SectionCount)); 94 95 //Error severity (with interpreted string version). 96 json_object* error_severity = json_object_new_object(); 97 json_object_object_add(error_severity, "code", json_object_new_uint64(header->ErrorSeverity)); 98 json_object_object_add(error_severity, "name", json_object_new_string(severity_to_string(header->ErrorSeverity))); 99 json_object_object_add(header_ir, "severity", error_severity); 100 101 //The validation bits for each section. 102 json_object* validation_bits = bitfield_to_ir(header->ValidationBits, 3, CPER_HEADER_VALID_BITFIELD_NAMES); 103 json_object_object_add(header_ir, "validationBits", validation_bits); 104 105 //Total length of the record (including headers) in bytes. 106 json_object_object_add(header_ir, "recordLength", json_object_new_uint64(header->RecordLength)); 107 108 //If a timestamp exists according to validation bits, then add it. 109 if (header->ValidationBits & 0b10) 110 { 111 char timestamp_string[TIMESTAMP_LENGTH]; 112 sprintf(timestamp_string, "%02d%02d-%02d-%02dT%02d:%02d:%02d.000", 113 header->TimeStamp.Century, 114 header->TimeStamp.Year, 115 header->TimeStamp.Month, 116 header->TimeStamp.Day, 117 header->TimeStamp.Hours, 118 header->TimeStamp.Minutes, 119 header->TimeStamp.Seconds); 120 121 json_object_object_add(header_ir, "timestamp", json_object_new_string(timestamp_string)); 122 json_object_object_add(header_ir, "timestampIsPrecise", json_object_new_boolean(header->TimeStamp.Flag)); 123 } 124 125 //If a platform ID exists according to the validation bits, then add it. 126 if (header->ValidationBits & 0b1) 127 { 128 char platform_string[GUID_STRING_LENGTH]; 129 guid_to_string(platform_string, &header->PlatformID); 130 json_object_object_add(header_ir, "platformID", json_object_new_string(platform_string)); 131 } 132 133 //If a partition ID exists according to the validation bits, then add it. 134 if (header->ValidationBits & 0b100) 135 { 136 char partition_string[GUID_STRING_LENGTH]; 137 guid_to_string(partition_string, &header->PartitionID); 138 json_object_object_add(header_ir, "partitionID", json_object_new_string(partition_string)); 139 } 140 141 //Creator ID of the header. 142 char creator_string[GUID_STRING_LENGTH]; 143 guid_to_string(creator_string, &header->CreatorID); 144 json_object_object_add(header_ir, "creatorID", json_object_new_string(creator_string)); 145 146 //Notification type for the header. Some defined types are available. 147 json_object* notification_type = json_object_new_object(); 148 char notification_type_string[GUID_STRING_LENGTH]; 149 guid_to_string(notification_type_string, &header->NotificationType); 150 json_object_object_add(notification_type, "guid", json_object_new_string(notification_type_string)); 151 152 //Add the human readable notification type if possible. 153 char* notification_type_readable = "Unknown"; 154 if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeCmcGuid)) 155 notification_type_readable = "CMC"; 156 else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeCpeGuid)) 157 notification_type_readable = "CPE"; 158 else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeMceGuid)) 159 notification_type_readable = "MCE"; 160 else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypePcieGuid)) 161 notification_type_readable = "PCIe"; 162 else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeInitGuid)) 163 notification_type_readable = "INIT"; 164 else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeNmiGuid)) 165 notification_type_readable = "NMI"; 166 else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeBootGuid)) 167 notification_type_readable = "Boot"; 168 else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeDmarGuid)) 169 notification_type_readable = "DMAr"; 170 else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeSeaGuid)) 171 notification_type_readable = "SEA"; 172 else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeSeiGuid)) 173 notification_type_readable = "SEI"; 174 else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypePeiGuid)) 175 notification_type_readable = "PEI"; 176 else if (guid_equal(&header->NotificationType, &gEfiEventNotificationTypeCxlGuid)) 177 notification_type_readable = "CXL Component"; 178 json_object_object_add(notification_type, "type", json_object_new_string(notification_type_readable)); 179 json_object_object_add(header_ir, "notificationType", notification_type); 180 181 //The record ID for this record, unique on a given system. 182 json_object_object_add(header_ir, "recordID", json_object_new_uint64(header->RecordID)); 183 184 //Flag for the record, and a human readable form. 185 json_object* flags = integer_to_readable_pair(header->Flags, 186 sizeof(CPER_HEADER_FLAG_TYPES_KEYS) / sizeof(int), 187 CPER_HEADER_FLAG_TYPES_KEYS, 188 CPER_HEADER_FLAG_TYPES_VALUES, 189 "Unknown"); 190 json_object_object_add(header_ir, "flags", flags); 191 192 //Persistence information. Outside the scope of specification, so just a uint32 here. 193 json_object_object_add(header_ir, "persistenceInfo", json_object_new_uint64(header->PersistenceInfo)); 194 return header_ir; 195 } 196 197 //Converts the given EFI section descriptor into JSON IR format. 198 json_object* cper_section_descriptor_to_ir(EFI_ERROR_SECTION_DESCRIPTOR* section_descriptor) 199 { 200 json_object* section_descriptor_ir = json_object_new_object(); 201 202 //The offset of the section from the base of the record header, length. 203 json_object_object_add(section_descriptor_ir, "sectionOffset", json_object_new_uint64(section_descriptor->SectionOffset)); 204 json_object_object_add(section_descriptor_ir, "sectionLength", json_object_new_uint64(section_descriptor->SectionLength)); 205 206 //Revision. 207 json_object_object_add(section_descriptor_ir, "revision", revision_to_ir(section_descriptor->Revision)); 208 209 //Validation bits. 210 json_object* validation_bits = bitfield_to_ir(section_descriptor->SecValidMask, 2, CPER_SECTION_DESCRIPTOR_VALID_BITFIELD_NAMES); 211 json_object_object_add(section_descriptor_ir, "validationBits", validation_bits); 212 213 //Flag bits. 214 json_object* flags = bitfield_to_ir(section_descriptor->SectionFlags, 8, CPER_SECTION_DESCRIPTOR_FLAGS_BITFIELD_NAMES); 215 json_object_object_add(section_descriptor_ir, "flags", flags); 216 217 //Section type (GUID). 218 json_object* section_type = json_object_new_object(); 219 char section_type_string[GUID_STRING_LENGTH]; 220 guid_to_string(section_type_string, §ion_descriptor->SectionType); 221 json_object_object_add(section_type, "data", json_object_new_string(section_type_string)); 222 223 //Readable section type, if possible. 224 char* section_type_readable = "Unknown"; 225 if (guid_equal(§ion_descriptor->SectionType, &gEfiProcessorGenericErrorSectionGuid)) 226 section_type_readable = "Processor Generic"; 227 else if (guid_equal(§ion_descriptor->SectionType, &gEfiIa32X64ProcessorErrorSectionGuid)) 228 section_type_readable = "IA32/X64"; 229 else if (guid_equal(§ion_descriptor->SectionType, &gEfiIpfProcessorErrorSectionGuid)) 230 section_type_readable = "IPF"; 231 else if (guid_equal(§ion_descriptor->SectionType, &gEfiArmProcessorErrorSectionGuid)) 232 section_type_readable = "ARM"; 233 else if (guid_equal(§ion_descriptor->SectionType, &gEfiPlatformMemoryErrorSectionGuid) 234 || guid_equal(§ion_descriptor->SectionType, &gEfiPlatformMemoryError2SectionGuid)) 235 section_type_readable = "Platform Memory"; 236 else if (guid_equal(§ion_descriptor->SectionType, &gEfiPcieErrorSectionGuid)) 237 section_type_readable = "PCIe"; 238 else if (guid_equal(§ion_descriptor->SectionType, &gEfiFirmwareErrorSectionGuid)) 239 section_type_readable = "Firmware Error Record Reference"; 240 else if (guid_equal(§ion_descriptor->SectionType, &gEfiPciBusErrorSectionGuid)) 241 section_type_readable = "PCI/PCI-X Bus"; 242 else if (guid_equal(§ion_descriptor->SectionType, &gEfiPciDevErrorSectionGuid)) 243 section_type_readable = "PCI Component/Device"; 244 else if (guid_equal(§ion_descriptor->SectionType, &gEfiDMArGenericErrorSectionGuid)) 245 section_type_readable = "DMAr Generic"; 246 else if (guid_equal(§ion_descriptor->SectionType, &gEfiDirectedIoDMArErrorSectionGuid)) 247 section_type_readable = "Intel VT for Directed I/O specific DMAr section"; 248 else if (guid_equal(§ion_descriptor->SectionType, &gEfiIommuDMArErrorSectionGuid)) 249 section_type_readable = "IOMMU specific DMAr section"; 250 else if (guid_equal(§ion_descriptor->SectionType, &gEfiCcixPerLogErrorSectionGuid)) 251 section_type_readable = "CCIX PER Log Error"; 252 else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlProtocolErrorSectionGuid)) 253 section_type_readable = "CXL Protocol Error"; 254 else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlGeneralMediaErrorSectionGuid)) 255 section_type_readable = "CXL General Media Component Error"; 256 else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlDramEventErrorSectionGuid)) 257 section_type_readable = "CXL DRAM Component Error"; 258 else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlPhysicalSwitchErrorSectionGuid)) 259 section_type_readable = "CXL Physical Switch Component Error"; 260 else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlVirtualSwitchErrorSectionGuid)) 261 section_type_readable = "CXL Virtual Switch Component Error"; 262 else if (guid_equal(§ion_descriptor->SectionType, &gEfiCxlMldPortErrorSectionGuid)) 263 section_type_readable = "CXL MLD Port Component Error"; 264 265 json_object_object_add(section_type, "type", json_object_new_string(section_type_readable)); 266 json_object_object_add(section_descriptor_ir, "sectionType", section_type); 267 268 //If validation bits indicate it exists, add FRU ID. 269 if (section_descriptor->SecValidMask & 0b1) 270 { 271 char fru_id_string[GUID_STRING_LENGTH]; 272 guid_to_string(fru_id_string, §ion_descriptor->FruId); 273 json_object_object_add(section_descriptor_ir, "fruID", json_object_new_string(fru_id_string)); 274 } 275 276 //If validation bits indicate it exists, add FRU text. 277 if ((section_descriptor->SecValidMask & 0b10) >> 1) 278 json_object_object_add(section_descriptor_ir, "fruText", json_object_new_string(section_descriptor->FruString)); 279 280 //Section severity. 281 json_object* section_severity = json_object_new_object(); 282 json_object_object_add(section_severity, "code", json_object_new_uint64(section_descriptor->Severity)); 283 json_object_object_add(section_severity, "name", json_object_new_string(severity_to_string(section_descriptor->Severity))); 284 json_object_object_add(section_descriptor_ir, "severity", section_severity); 285 286 return section_descriptor_ir; 287 } 288 289 290 //Converts the section described by a single given section descriptor. 291 json_object* cper_section_to_ir(FILE* handle, EFI_ERROR_SECTION_DESCRIPTOR* descriptor) 292 { 293 //Save our current position in the stream. 294 long position = ftell(handle); 295 296 //Read section as described by the section descriptor. 297 fseek(handle, descriptor->SectionOffset, SEEK_SET); 298 void* section = malloc(descriptor->SectionLength); 299 if (fread(section, descriptor->SectionLength, 1, handle) != 1) 300 { 301 printf("Section read failed: Could not read %d bytes from global offset %d.\n", 302 descriptor->SectionLength, 303 descriptor->SectionOffset); 304 free(section); 305 return NULL; 306 } 307 308 //Seek back to our original position. 309 fseek(handle, position, SEEK_SET); 310 311 //Parse section to IR based on GUID. 312 json_object* result = NULL; 313 if (guid_equal(&descriptor->SectionType, &gEfiProcessorGenericErrorSectionGuid)) 314 result = cper_section_generic_to_ir(section, descriptor); 315 else if (guid_equal(&descriptor->SectionType, &gEfiIa32X64ProcessorErrorSectionGuid)) 316 result = cper_section_ia32x64_to_ir(section, descriptor); 317 else if (guid_equal(&descriptor->SectionType, &gEfiIpfProcessorErrorSectionGuid)) 318 result = cper_section_ipf_to_ir(section, descriptor); 319 else if (guid_equal(&descriptor->SectionType, &gEfiArmProcessorErrorSectionGuid)) 320 result = cper_section_arm_to_ir(section, descriptor); 321 else if (guid_equal(&descriptor->SectionType, &gEfiPlatformMemoryErrorSectionGuid)) 322 result = cper_section_platform_memory_to_ir(section, descriptor); 323 else if (guid_equal(&descriptor->SectionType, &gEfiPlatformMemoryError2SectionGuid)) 324 result = cper_section_platform_memory2_to_ir(section, descriptor); 325 else if (guid_equal(&descriptor->SectionType, &gEfiPcieErrorSectionGuid)) 326 result = cper_section_pcie_to_ir(section, descriptor); 327 else if (guid_equal(&descriptor->SectionType, &gEfiFirmwareErrorSectionGuid)) 328 result = cper_section_firmware_to_ir(section, descriptor); 329 else if (guid_equal(&descriptor->SectionType, &gEfiPciBusErrorSectionGuid)) 330 result = cper_section_pci_bus_to_ir(section, descriptor); 331 else if (guid_equal(&descriptor->SectionType, &gEfiPciDevErrorSectionGuid)) 332 result = cper_section_pci_dev_to_ir(section, descriptor); 333 else if (guid_equal(&descriptor->SectionType, &gEfiDMArGenericErrorSectionGuid)) 334 result = cper_section_dmar_generic_to_ir(section, descriptor); 335 else if (guid_equal(&descriptor->SectionType, &gEfiDirectedIoDMArErrorSectionGuid)) 336 result = cper_section_dmar_vtd_to_ir(section, descriptor); 337 else if (guid_equal(&descriptor->SectionType, &gEfiIommuDMArErrorSectionGuid)) 338 result = cper_section_dmar_iommu_to_ir(section, descriptor); 339 else if (guid_equal(&descriptor->SectionType, &gEfiCcixPerLogErrorSectionGuid)) 340 result = cper_section_ccix_per_to_ir(section, descriptor); 341 else if (guid_equal(&descriptor->SectionType, &gEfiCxlProtocolErrorSectionGuid)) 342 result = cper_section_cxl_protocol_to_ir(section, descriptor); 343 else if (guid_equal(&descriptor->SectionType, &gEfiCxlGeneralMediaErrorSectionGuid) 344 || guid_equal(&descriptor->SectionType, &gEfiCxlDramEventErrorSectionGuid) 345 || guid_equal(&descriptor->SectionType, &gEfiCxlPhysicalSwitchErrorSectionGuid) 346 || guid_equal(&descriptor->SectionType, &gEfiCxlVirtualSwitchErrorSectionGuid) 347 || guid_equal(&descriptor->SectionType, &gEfiCxlMldPortErrorSectionGuid)) 348 { 349 result = cper_section_cxl_component_to_ir(section, descriptor); 350 } 351 else 352 { 353 //Failed read, unknown GUID. 354 //Output the data as formatted base64. 355 result = json_object_new_object(); 356 char* encoded = b64_encode((unsigned char*)section, descriptor->SectionLength); 357 json_object_object_add(result, "data", json_object_new_string(encoded)); 358 free(encoded); 359 } 360 361 //Free section memory, return result. 362 free(section); 363 return result; 364 }