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