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