102c801a5SLawrence Tang /** 2*d34f2b11SLawrence Tang * Describes functions for generating psuedo-random specification compliant CPER records. 302c801a5SLawrence Tang * 402c801a5SLawrence Tang * Author: Lawrence.Tang@arm.com 502c801a5SLawrence Tang **/ 602c801a5SLawrence Tang 702c801a5SLawrence Tang #include <stdio.h> 802c801a5SLawrence Tang #include <stdlib.h> 902c801a5SLawrence Tang #include <string.h> 1002c801a5SLawrence Tang #include "../edk/Cper.h" 1102c801a5SLawrence Tang #include "gen-utils.h" 1267cbed6bSLawrence Tang #include "sections/gen-sections.h" 13*d34f2b11SLawrence Tang #include "cper-generate.h" 1402c801a5SLawrence Tang 1567cbed6bSLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR* generate_section_descriptor(char* type, size_t* lengths, int index, int num_sections); 1602c801a5SLawrence Tang size_t generate_section(void** location, char* type); 1702c801a5SLawrence Tang 18*d34f2b11SLawrence Tang //Generates a CPER record with the given section types, outputting to the given stream. 19*d34f2b11SLawrence Tang void generate_cper_record(char** types, UINT16 num_sections, FILE* out) 2002c801a5SLawrence Tang { 2102c801a5SLawrence Tang //Initialise randomiser. 2202c801a5SLawrence Tang init_random(); 2302c801a5SLawrence Tang 24*d34f2b11SLawrence Tang //Generate the sections. 2502c801a5SLawrence Tang void* sections[num_sections]; 2602c801a5SLawrence Tang size_t section_lengths[num_sections]; 2702c801a5SLawrence Tang for (int i=0; i<num_sections; i++) 2802c801a5SLawrence Tang { 29*d34f2b11SLawrence Tang section_lengths[i] = generate_section(sections + i, types[i]); 3002c801a5SLawrence Tang if (section_lengths[i] == 0) 3102c801a5SLawrence Tang { 3202c801a5SLawrence Tang //Error encountered, exit. 33*d34f2b11SLawrence Tang printf("Error encountered generating section %d of type '%s', length returned zero.\n", i+1, types[i]); 34*d34f2b11SLawrence Tang return; 3502c801a5SLawrence Tang } 3602c801a5SLawrence Tang } 3702c801a5SLawrence Tang 3802c801a5SLawrence Tang //Generate the header given the number of sections. 3902c801a5SLawrence Tang EFI_COMMON_ERROR_RECORD_HEADER* header = 4002c801a5SLawrence Tang (EFI_COMMON_ERROR_RECORD_HEADER*)calloc(1, sizeof(EFI_COMMON_ERROR_RECORD_HEADER)); 4102c801a5SLawrence Tang header->SignatureStart = 0x52455043; //CPER 4202c801a5SLawrence Tang header->SectionCount = num_sections; 4302c801a5SLawrence Tang header->SignatureEnd = 0xFFFFFFFF; 4402c801a5SLawrence Tang header->Flags = 4; //HW_ERROR_FLAGS_SIMULATED 4567cbed6bSLawrence Tang header->RecordID = (UINT64)rand(); 4667cbed6bSLawrence Tang header->ErrorSeverity = rand() % 4; 4767cbed6bSLawrence Tang *((UINT64*)&header->TimeStamp) = (UINT64)rand(); 4867cbed6bSLawrence Tang header->ValidationBits = rand() % 0b1000; 4902c801a5SLawrence Tang 5002c801a5SLawrence Tang //Generate the section descriptors given the number of sections. 5102c801a5SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR* section_descriptors[num_sections]; 5202c801a5SLawrence Tang for (int i=0; i<num_sections; i++) 53*d34f2b11SLawrence Tang section_descriptors[i] = generate_section_descriptor(types[i], section_lengths, i, num_sections); 5402c801a5SLawrence Tang 5502c801a5SLawrence Tang //Calculate total length of structure, set in header. 5667cbed6bSLawrence Tang size_t total_len = sizeof(EFI_COMMON_ERROR_RECORD_HEADER); 5702c801a5SLawrence Tang for (int i=0; i<num_sections; i++) 5802c801a5SLawrence Tang total_len += section_lengths[i]; 5902c801a5SLawrence Tang total_len += num_sections * sizeof(EFI_ERROR_SECTION_DESCRIPTOR); 6002c801a5SLawrence Tang header->RecordLength = (UINT32)total_len; 6102c801a5SLawrence Tang 62*d34f2b11SLawrence Tang //Write to stream in order, free all resources. 63*d34f2b11SLawrence Tang fwrite(header, sizeof(EFI_COMMON_ERROR_RECORD_HEADER), 1, out); 64*d34f2b11SLawrence Tang fflush(out); 6502c801a5SLawrence Tang free(header); 6602c801a5SLawrence Tang for (int i=0; i<num_sections; i++) 6702c801a5SLawrence Tang { 68*d34f2b11SLawrence Tang fwrite(section_descriptors[i], sizeof(EFI_ERROR_SECTION_DESCRIPTOR), 1, out); 69*d34f2b11SLawrence Tang fflush(out); 7002c801a5SLawrence Tang free(section_descriptors[i]); 7102c801a5SLawrence Tang } 7202c801a5SLawrence Tang for (int i=0; i<num_sections; i++) 7302c801a5SLawrence Tang { 74*d34f2b11SLawrence Tang fwrite(sections[i], section_lengths[i], 1, out); 75*d34f2b11SLawrence Tang fflush(out); 7602c801a5SLawrence Tang free(sections[i]); 7702c801a5SLawrence Tang } 7802c801a5SLawrence Tang } 7902c801a5SLawrence Tang 8002c801a5SLawrence Tang //Generates a single section descriptor for a section with the given properties. 8167cbed6bSLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR* generate_section_descriptor(char* type, size_t* lengths, int index, int num_sections) 8202c801a5SLawrence Tang { 8302c801a5SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR* descriptor = 8402c801a5SLawrence Tang (EFI_ERROR_SECTION_DESCRIPTOR*)generate_random_bytes(sizeof(EFI_ERROR_SECTION_DESCRIPTOR)); 8502c801a5SLawrence Tang 8602c801a5SLawrence Tang //Set reserved bits to zero. 8702c801a5SLawrence Tang descriptor->SecValidMask &= 0b11; 8802c801a5SLawrence Tang descriptor->Resv1 = 0; 8902c801a5SLawrence Tang descriptor->SectionFlags &= 0xFF; 9002c801a5SLawrence Tang 91*d34f2b11SLawrence Tang //Set severity. 92*d34f2b11SLawrence Tang descriptor->Severity = rand() % 4; 93*d34f2b11SLawrence Tang 9402c801a5SLawrence Tang //Set length, offset from base record. 9502c801a5SLawrence Tang descriptor->SectionLength = (UINT32)lengths[index]; 9667cbed6bSLawrence Tang descriptor->SectionOffset = sizeof(EFI_COMMON_ERROR_RECORD_HEADER) 9767cbed6bSLawrence Tang + (num_sections * sizeof(EFI_ERROR_SECTION_DESCRIPTOR)); 9802c801a5SLawrence Tang for (int i=0; i<index; i++) 9902c801a5SLawrence Tang descriptor->SectionOffset += lengths[i]; 10002c801a5SLawrence Tang 10102c801a5SLawrence Tang //Set section type GUID based on type name. 10202c801a5SLawrence Tang if (strcmp(type, "generic") == 0) 10302c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiProcessorGenericErrorSectionGuid, sizeof(EFI_GUID)); 10402c801a5SLawrence Tang else if (strcmp(type, "ia32x64") == 0) 10502c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiIa32X64ProcessorErrorSectionGuid, sizeof(EFI_GUID)); 10602c801a5SLawrence Tang else if (strcmp(type, "ipf") == 0) 10702c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiIpfProcessorErrorSectionGuid, sizeof(EFI_GUID)); 10802c801a5SLawrence Tang else if (strcmp(type, "arm") == 0) 10902c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiArmProcessorErrorSectionGuid, sizeof(EFI_GUID)); 11002c801a5SLawrence Tang else if (strcmp(type, "memory") == 0) 11102c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiPlatformMemoryErrorSectionGuid, sizeof(EFI_GUID)); 11202c801a5SLawrence Tang else if (strcmp(type, "memory2") == 0) 11302c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiPlatformMemoryError2SectionGuid, sizeof(EFI_GUID)); 11402c801a5SLawrence Tang else if (strcmp(type, "pcie") == 0) 11502c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiPcieErrorSectionGuid, sizeof(EFI_GUID)); 11602c801a5SLawrence Tang else if (strcmp(type, "firmware") == 0) 11702c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiFirmwareErrorSectionGuid, sizeof(EFI_GUID)); 11802c801a5SLawrence Tang else if (strcmp(type, "pcibus") == 0) 11902c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiPciBusErrorSectionGuid, sizeof(EFI_GUID)); 12002c801a5SLawrence Tang else if (strcmp(type, "pcidev") == 0) 12102c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiPciDevErrorSectionGuid, sizeof(EFI_GUID)); 12202c801a5SLawrence Tang else if (strcmp(type, "dmargeneric") == 0) 12302c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiDMArGenericErrorSectionGuid, sizeof(EFI_GUID)); 12402c801a5SLawrence Tang else if (strcmp(type, "dmarvtd") == 0) 12502c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiDirectedIoDMArErrorSectionGuid, sizeof(EFI_GUID)); 12602c801a5SLawrence Tang else if (strcmp(type, "dmariommu") == 0) 12702c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiIommuDMArErrorSectionGuid, sizeof(EFI_GUID)); 12802c801a5SLawrence Tang else if (strcmp(type, "ccixper") == 0) 12902c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiCcixPerLogErrorSectionGuid, sizeof(EFI_GUID)); 13002c801a5SLawrence Tang else if (strcmp(type, "cxlprotocol") == 0) 13102c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiCxlProtocolErrorSectionGuid, sizeof(EFI_GUID)); 13202c801a5SLawrence Tang else if (strcmp(type, "cxlcomponent") == 0) 13302c801a5SLawrence Tang { 13402c801a5SLawrence Tang //Choose between the different CXL component type GUIDs. 13502c801a5SLawrence Tang int componentType = rand() % 5; 13602c801a5SLawrence Tang switch (componentType) 13702c801a5SLawrence Tang { 13802c801a5SLawrence Tang case 0: 13902c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiCxlGeneralMediaErrorSectionGuid, sizeof(EFI_GUID)); 14002c801a5SLawrence Tang break; 14102c801a5SLawrence Tang case 1: 14202c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiCxlDramEventErrorSectionGuid, sizeof(EFI_GUID)); 14302c801a5SLawrence Tang break; 14402c801a5SLawrence Tang case 2: 14502c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiCxlPhysicalSwitchErrorSectionGuid, sizeof(EFI_GUID)); 14602c801a5SLawrence Tang break; 14702c801a5SLawrence Tang case 3: 14802c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiCxlVirtualSwitchErrorSectionGuid, sizeof(EFI_GUID)); 14902c801a5SLawrence Tang break; 15002c801a5SLawrence Tang default: 15102c801a5SLawrence Tang memcpy(&descriptor->SectionType, &gEfiCxlMldPortErrorSectionGuid, sizeof(EFI_GUID)); 15202c801a5SLawrence Tang break; 15302c801a5SLawrence Tang } 15402c801a5SLawrence Tang } 15502c801a5SLawrence Tang else if (strcmp(type, "unknown") != 0) 15602c801a5SLawrence Tang { 15702c801a5SLawrence Tang //Undefined section, show error. 15802c801a5SLawrence Tang printf("Undefined section type '%s' provided. See 'cper-generate --help' for command information.\n", type); 15902c801a5SLawrence Tang return 0; 16002c801a5SLawrence Tang } 16102c801a5SLawrence Tang 16202c801a5SLawrence Tang return descriptor; 16302c801a5SLawrence Tang } 16402c801a5SLawrence Tang 16502c801a5SLawrence Tang //Generates a single CPER section given the string type. 16602c801a5SLawrence Tang size_t generate_section(void** location, char* type) 16702c801a5SLawrence Tang { 16802c801a5SLawrence Tang //The length of the section. 16902c801a5SLawrence Tang size_t length = 0; 17002c801a5SLawrence Tang 17102c801a5SLawrence Tang //Switch on the type, generate accordingly. 17202c801a5SLawrence Tang if (strcmp(type, "generic") == 0) 17302c801a5SLawrence Tang length = generate_section_generic(location); 17402c801a5SLawrence Tang else if (strcmp(type, "ia32x64") == 0) 17502c801a5SLawrence Tang length = generate_section_ia32x64(location); 17602c801a5SLawrence Tang // else if (strcmp(type, "ipf") == 0) 17702c801a5SLawrence Tang // length = generate_section_ipf(location); 17867cbed6bSLawrence Tang else if (strcmp(type, "arm") == 0) 17967cbed6bSLawrence Tang length = generate_section_arm(location); 180de9707f9SLawrence Tang else if (strcmp(type, "memory") == 0) 181de9707f9SLawrence Tang length = generate_section_memory(location); 182de9707f9SLawrence Tang else if (strcmp(type, "memory2") == 0) 183de9707f9SLawrence Tang length = generate_section_memory2(location); 184de9707f9SLawrence Tang else if (strcmp(type, "pcie") == 0) 185de9707f9SLawrence Tang length = generate_section_pcie(location); 186de9707f9SLawrence Tang else if (strcmp(type, "firmware") == 0) 187de9707f9SLawrence Tang length = generate_section_firmware(location); 188de9707f9SLawrence Tang else if (strcmp(type, "pcibus") == 0) 189de9707f9SLawrence Tang length = generate_section_pci_bus(location); 190de9707f9SLawrence Tang else if (strcmp(type, "pcidev") == 0) 191de9707f9SLawrence Tang length = generate_section_pci_dev(location); 192de9707f9SLawrence Tang else if (strcmp(type, "dmargeneric") == 0) 193de9707f9SLawrence Tang length = generate_section_dmar_generic(location); 194de9707f9SLawrence Tang else if (strcmp(type, "dmarvtd") == 0) 195de9707f9SLawrence Tang length = generate_section_dmar_vtd(location); 196de9707f9SLawrence Tang else if (strcmp(type, "dmariommu") == 0) 197de9707f9SLawrence Tang length = generate_section_dmar_iommu(location); 198de9707f9SLawrence Tang else if (strcmp(type, "ccixper") == 0) 199de9707f9SLawrence Tang length = generate_section_ccix_per(location); 200de9707f9SLawrence Tang else if (strcmp(type, "cxlprotocol") == 0) 201de9707f9SLawrence Tang length = generate_section_cxl_protocol(location); 202de9707f9SLawrence Tang else if (strcmp(type, "cxlcomponent") == 0) 203de9707f9SLawrence Tang length = generate_section_cxl_component(location); 204de9707f9SLawrence Tang else if (strcmp(type, "unknown") == 0) 205de9707f9SLawrence Tang length = generate_random_section(location, rand() % 256); 20602c801a5SLawrence Tang else 20702c801a5SLawrence Tang { 20802c801a5SLawrence Tang //Undefined section, show error. 20902c801a5SLawrence Tang printf("Undefined section type '%s' given to generate. See 'cper-generate --help' for command information.\n", type); 21002c801a5SLawrence Tang return 0; 21102c801a5SLawrence Tang } 21202c801a5SLawrence Tang 21302c801a5SLawrence Tang return length; 21402c801a5SLawrence Tang }