102c801a5SLawrence Tang /** 2efe17e2cSLawrence Tang * Describes functions for generating pseudo-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" 13d34f2b11SLawrence Tang #include "cper-generate.h" 1402c801a5SLawrence Tang 15e407b4c8SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR *generate_section_descriptor(char *type, 16e407b4c8SLawrence Tang size_t *lengths, 17e407b4c8SLawrence Tang int index, 18e407b4c8SLawrence Tang int num_sections); 1902c801a5SLawrence Tang size_t generate_section(void **location, char *type); 2002c801a5SLawrence Tang 21d34f2b11SLawrence Tang //Generates a CPER record with the given section types, outputting to the given stream. 22d34f2b11SLawrence Tang void generate_cper_record(char **types, UINT16 num_sections, FILE *out) 2302c801a5SLawrence Tang { 2402c801a5SLawrence Tang //Initialise randomiser. 2502c801a5SLawrence Tang init_random(); 2602c801a5SLawrence Tang 27d34f2b11SLawrence Tang //Generate the sections. 2802c801a5SLawrence Tang void *sections[num_sections]; 2902c801a5SLawrence Tang size_t section_lengths[num_sections]; 30e407b4c8SLawrence Tang for (int i = 0; i < num_sections; i++) { 31d34f2b11SLawrence Tang section_lengths[i] = generate_section(sections + i, types[i]); 32e407b4c8SLawrence Tang if (section_lengths[i] == 0) { 3302c801a5SLawrence Tang //Error encountered, exit. 34e407b4c8SLawrence Tang printf("Error encountered generating section %d of type '%s', length returned zero.\n", 35e407b4c8SLawrence Tang i + 1, types[i]); 36d34f2b11SLawrence Tang return; 3702c801a5SLawrence Tang } 3802c801a5SLawrence Tang } 3902c801a5SLawrence Tang 4002c801a5SLawrence Tang //Generate the header given the number of sections. 4102c801a5SLawrence Tang EFI_COMMON_ERROR_RECORD_HEADER *header = 42e407b4c8SLawrence Tang (EFI_COMMON_ERROR_RECORD_HEADER *)calloc( 43e407b4c8SLawrence Tang 1, sizeof(EFI_COMMON_ERROR_RECORD_HEADER)); 4402c801a5SLawrence Tang header->SignatureStart = 0x52455043; //CPER 4502c801a5SLawrence Tang header->SectionCount = num_sections; 4602c801a5SLawrence Tang header->SignatureEnd = 0xFFFFFFFF; 4702c801a5SLawrence Tang header->Flags = 4; //HW_ERROR_FLAGS_SIMULATED 4867cbed6bSLawrence Tang header->RecordID = (UINT64)rand(); 4967cbed6bSLawrence Tang header->ErrorSeverity = rand() % 4; 50aacf0e26SLawrence Tang 51aacf0e26SLawrence Tang //Generate a valid timestamp. 52aacf0e26SLawrence Tang header->TimeStamp.Century = int_to_bcd(rand() % 100); 53aacf0e26SLawrence Tang header->TimeStamp.Year = int_to_bcd(rand() % 100); 54aacf0e26SLawrence Tang header->TimeStamp.Month = int_to_bcd(rand() % 12 + 1); 55aacf0e26SLawrence Tang header->TimeStamp.Day = int_to_bcd(rand() % 31 + 1); 56aacf0e26SLawrence Tang header->TimeStamp.Hours = int_to_bcd(rand() % 24 + 1); 57aacf0e26SLawrence Tang header->TimeStamp.Seconds = int_to_bcd(rand() % 60); 58aacf0e26SLawrence Tang 59aacf0e26SLawrence Tang //Turn all validation bits on. 60aacf0e26SLawrence Tang header->ValidationBits = 0b11; 6102c801a5SLawrence Tang 6202c801a5SLawrence Tang //Generate the section descriptors given the number of sections. 6302c801a5SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR *section_descriptors[num_sections]; 6402c801a5SLawrence Tang for (int i = 0; i < num_sections; i++) 65e407b4c8SLawrence Tang section_descriptors[i] = generate_section_descriptor( 66e407b4c8SLawrence Tang types[i], section_lengths, i, num_sections); 6702c801a5SLawrence Tang 6802c801a5SLawrence Tang //Calculate total length of structure, set in header. 6967cbed6bSLawrence Tang size_t total_len = sizeof(EFI_COMMON_ERROR_RECORD_HEADER); 7002c801a5SLawrence Tang for (int i = 0; i < num_sections; i++) 7102c801a5SLawrence Tang total_len += section_lengths[i]; 7202c801a5SLawrence Tang total_len += num_sections * sizeof(EFI_ERROR_SECTION_DESCRIPTOR); 7302c801a5SLawrence Tang header->RecordLength = (UINT32)total_len; 7402c801a5SLawrence Tang 75d34f2b11SLawrence Tang //Write to stream in order, free all resources. 76d34f2b11SLawrence Tang fwrite(header, sizeof(EFI_COMMON_ERROR_RECORD_HEADER), 1, out); 77d34f2b11SLawrence Tang fflush(out); 7802c801a5SLawrence Tang free(header); 79e407b4c8SLawrence Tang for (int i = 0; i < num_sections; i++) { 80e407b4c8SLawrence Tang fwrite(section_descriptors[i], 81e407b4c8SLawrence Tang sizeof(EFI_ERROR_SECTION_DESCRIPTOR), 1, out); 82d34f2b11SLawrence Tang fflush(out); 8302c801a5SLawrence Tang free(section_descriptors[i]); 8402c801a5SLawrence Tang } 85e407b4c8SLawrence Tang for (int i = 0; i < num_sections; i++) { 86d34f2b11SLawrence Tang fwrite(sections[i], section_lengths[i], 1, out); 87d34f2b11SLawrence Tang fflush(out); 8802c801a5SLawrence Tang free(sections[i]); 8902c801a5SLawrence Tang } 9002c801a5SLawrence Tang } 9102c801a5SLawrence Tang 92*617949e4SLawrence Tang //Generates a single section record for the given section, and outputs to file. 93*617949e4SLawrence Tang void generate_single_section_record(char *type, FILE *out) 94*617949e4SLawrence Tang { 95*617949e4SLawrence Tang //Generate a section. 96*617949e4SLawrence Tang void *section; 97*617949e4SLawrence Tang size_t section_len = generate_section(§ion, type); 98*617949e4SLawrence Tang 99*617949e4SLawrence Tang //Generate a descriptor, correct the offset. 100*617949e4SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR *section_descriptor = 101*617949e4SLawrence Tang generate_section_descriptor(type, §ion_len, 0, 1); 102*617949e4SLawrence Tang section_descriptor->SectionOffset = 103*617949e4SLawrence Tang sizeof(EFI_ERROR_SECTION_DESCRIPTOR); 104*617949e4SLawrence Tang 105*617949e4SLawrence Tang //Write all to file. 106*617949e4SLawrence Tang fwrite(section_descriptor, sizeof(EFI_ERROR_SECTION_DESCRIPTOR), 1, 107*617949e4SLawrence Tang out); 108*617949e4SLawrence Tang fwrite(section, section_len, 1, out); 109*617949e4SLawrence Tang fflush(out); 110*617949e4SLawrence Tang 111*617949e4SLawrence Tang //Free remaining resources. 112*617949e4SLawrence Tang free(section_descriptor); 113*617949e4SLawrence Tang } 114*617949e4SLawrence Tang 11502c801a5SLawrence Tang //Generates a single section descriptor for a section with the given properties. 116e407b4c8SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR *generate_section_descriptor(char *type, 117e407b4c8SLawrence Tang size_t *lengths, 118e407b4c8SLawrence Tang int index, 119e407b4c8SLawrence Tang int num_sections) 12002c801a5SLawrence Tang { 12102c801a5SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR *descriptor = 122e407b4c8SLawrence Tang (EFI_ERROR_SECTION_DESCRIPTOR *)generate_random_bytes( 123e407b4c8SLawrence Tang sizeof(EFI_ERROR_SECTION_DESCRIPTOR)); 12402c801a5SLawrence Tang 12502c801a5SLawrence Tang //Set reserved bits to zero. 12602c801a5SLawrence Tang descriptor->Resv1 = 0; 12702c801a5SLawrence Tang descriptor->SectionFlags &= 0xFF; 12802c801a5SLawrence Tang 129aacf0e26SLawrence Tang //Validation bits all set to 'on'. 130aacf0e26SLawrence Tang descriptor->SecValidMask = 0b11; 131aacf0e26SLawrence Tang 132d34f2b11SLawrence Tang //Set severity. 133d34f2b11SLawrence Tang descriptor->Severity = rand() % 4; 134d34f2b11SLawrence Tang 13502c801a5SLawrence Tang //Set length, offset from base record. 13602c801a5SLawrence Tang descriptor->SectionLength = (UINT32)lengths[index]; 137e407b4c8SLawrence Tang descriptor->SectionOffset = 138e407b4c8SLawrence Tang sizeof(EFI_COMMON_ERROR_RECORD_HEADER) + 139e407b4c8SLawrence Tang (num_sections * sizeof(EFI_ERROR_SECTION_DESCRIPTOR)); 14002c801a5SLawrence Tang for (int i = 0; i < index; i++) 14102c801a5SLawrence Tang descriptor->SectionOffset += lengths[i]; 14202c801a5SLawrence Tang 143aacf0e26SLawrence Tang //Ensure the FRU text is not null terminated early. 144e407b4c8SLawrence Tang for (int i = 0; i < 20; i++) { 14501e3a44dSLawrence Tang if (descriptor->FruString[i] == 0x0) 146aacf0e26SLawrence Tang descriptor->FruString[i] = rand() % 127 + 1; 147aacf0e26SLawrence Tang 148aacf0e26SLawrence Tang //Null terminate last byte. 149aacf0e26SLawrence Tang if (i == 19) 150aacf0e26SLawrence Tang descriptor->FruString[i] = 0x0; 151aacf0e26SLawrence Tang } 152aacf0e26SLawrence Tang 15302c801a5SLawrence Tang //Set section type GUID based on type name. 15402c801a5SLawrence Tang if (strcmp(type, "generic") == 0) 155e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 156e407b4c8SLawrence Tang &gEfiProcessorGenericErrorSectionGuid, sizeof(EFI_GUID)); 15702c801a5SLawrence Tang else if (strcmp(type, "ia32x64") == 0) 158e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 159e407b4c8SLawrence Tang &gEfiIa32X64ProcessorErrorSectionGuid, sizeof(EFI_GUID)); 16002c801a5SLawrence Tang else if (strcmp(type, "ipf") == 0) 161e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 162e407b4c8SLawrence Tang &gEfiIpfProcessorErrorSectionGuid, sizeof(EFI_GUID)); 16302c801a5SLawrence Tang else if (strcmp(type, "arm") == 0) 164e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 165e407b4c8SLawrence Tang &gEfiArmProcessorErrorSectionGuid, sizeof(EFI_GUID)); 16602c801a5SLawrence Tang else if (strcmp(type, "memory") == 0) 167e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 168e407b4c8SLawrence Tang &gEfiPlatformMemoryErrorSectionGuid, sizeof(EFI_GUID)); 16902c801a5SLawrence Tang else if (strcmp(type, "memory2") == 0) 170e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 171e407b4c8SLawrence Tang &gEfiPlatformMemoryError2SectionGuid, sizeof(EFI_GUID)); 17202c801a5SLawrence Tang else if (strcmp(type, "pcie") == 0) 173e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, &gEfiPcieErrorSectionGuid, 174e407b4c8SLawrence Tang sizeof(EFI_GUID)); 17502c801a5SLawrence Tang else if (strcmp(type, "firmware") == 0) 176e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, &gEfiFirmwareErrorSectionGuid, 177e407b4c8SLawrence Tang sizeof(EFI_GUID)); 17802c801a5SLawrence Tang else if (strcmp(type, "pcibus") == 0) 179e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, &gEfiPciBusErrorSectionGuid, 180e407b4c8SLawrence Tang sizeof(EFI_GUID)); 18102c801a5SLawrence Tang else if (strcmp(type, "pcidev") == 0) 182e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, &gEfiPciDevErrorSectionGuid, 183e407b4c8SLawrence Tang sizeof(EFI_GUID)); 18402c801a5SLawrence Tang else if (strcmp(type, "dmargeneric") == 0) 185e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 186e407b4c8SLawrence Tang &gEfiDMArGenericErrorSectionGuid, sizeof(EFI_GUID)); 18702c801a5SLawrence Tang else if (strcmp(type, "dmarvtd") == 0) 188e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 189e407b4c8SLawrence Tang &gEfiDirectedIoDMArErrorSectionGuid, sizeof(EFI_GUID)); 19002c801a5SLawrence Tang else if (strcmp(type, "dmariommu") == 0) 191e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, &gEfiIommuDMArErrorSectionGuid, 192e407b4c8SLawrence Tang sizeof(EFI_GUID)); 19302c801a5SLawrence Tang else if (strcmp(type, "ccixper") == 0) 194e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 195e407b4c8SLawrence Tang &gEfiCcixPerLogErrorSectionGuid, sizeof(EFI_GUID)); 19602c801a5SLawrence Tang else if (strcmp(type, "cxlprotocol") == 0) 197e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 198e407b4c8SLawrence Tang &gEfiCxlProtocolErrorSectionGuid, sizeof(EFI_GUID)); 199e407b4c8SLawrence Tang else if (strcmp(type, "cxlcomponent") == 0) { 20002c801a5SLawrence Tang //Choose between the different CXL component type GUIDs. 20102c801a5SLawrence Tang int componentType = rand() % 5; 202e407b4c8SLawrence Tang switch (componentType) { 20302c801a5SLawrence Tang case 0: 204e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 205e407b4c8SLawrence Tang &gEfiCxlGeneralMediaErrorSectionGuid, 206e407b4c8SLawrence Tang sizeof(EFI_GUID)); 20702c801a5SLawrence Tang break; 20802c801a5SLawrence Tang case 1: 209e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 210e407b4c8SLawrence Tang &gEfiCxlDramEventErrorSectionGuid, 211e407b4c8SLawrence Tang sizeof(EFI_GUID)); 21202c801a5SLawrence Tang break; 21302c801a5SLawrence Tang case 2: 214e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 215e407b4c8SLawrence Tang &gEfiCxlPhysicalSwitchErrorSectionGuid, 216e407b4c8SLawrence Tang sizeof(EFI_GUID)); 21702c801a5SLawrence Tang break; 21802c801a5SLawrence Tang case 3: 219e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 220e407b4c8SLawrence Tang &gEfiCxlVirtualSwitchErrorSectionGuid, 221e407b4c8SLawrence Tang sizeof(EFI_GUID)); 22202c801a5SLawrence Tang break; 22302c801a5SLawrence Tang default: 224e407b4c8SLawrence Tang memcpy(&descriptor->SectionType, 225e407b4c8SLawrence Tang &gEfiCxlMldPortErrorSectionGuid, 226e407b4c8SLawrence Tang sizeof(EFI_GUID)); 22702c801a5SLawrence Tang break; 22802c801a5SLawrence Tang } 229e407b4c8SLawrence Tang } else if (strcmp(type, "unknown") != 0) { 23002c801a5SLawrence Tang //Undefined section, show error. 231e407b4c8SLawrence Tang printf("Undefined section type '%s' provided. See 'cper-generate --help' for command information.\n", 232e407b4c8SLawrence Tang type); 23302c801a5SLawrence Tang return 0; 23402c801a5SLawrence Tang } 23502c801a5SLawrence Tang 23602c801a5SLawrence Tang return descriptor; 23702c801a5SLawrence Tang } 23802c801a5SLawrence Tang 23902c801a5SLawrence Tang //Generates a single CPER section given the string type. 24002c801a5SLawrence Tang size_t generate_section(void **location, char *type) 24102c801a5SLawrence Tang { 24202c801a5SLawrence Tang //The length of the section. 24302c801a5SLawrence Tang size_t length = 0; 24402c801a5SLawrence Tang 24502c801a5SLawrence Tang //Switch on the type, generate accordingly. 24602c801a5SLawrence Tang if (strcmp(type, "generic") == 0) 24702c801a5SLawrence Tang length = generate_section_generic(location); 24802c801a5SLawrence Tang else if (strcmp(type, "ia32x64") == 0) 24902c801a5SLawrence Tang length = generate_section_ia32x64(location); 25002c801a5SLawrence Tang // else if (strcmp(type, "ipf") == 0) 25102c801a5SLawrence Tang // length = generate_section_ipf(location); 25267cbed6bSLawrence Tang else if (strcmp(type, "arm") == 0) 25367cbed6bSLawrence Tang length = generate_section_arm(location); 254de9707f9SLawrence Tang else if (strcmp(type, "memory") == 0) 255de9707f9SLawrence Tang length = generate_section_memory(location); 256de9707f9SLawrence Tang else if (strcmp(type, "memory2") == 0) 257de9707f9SLawrence Tang length = generate_section_memory2(location); 258de9707f9SLawrence Tang else if (strcmp(type, "pcie") == 0) 259de9707f9SLawrence Tang length = generate_section_pcie(location); 260de9707f9SLawrence Tang else if (strcmp(type, "firmware") == 0) 261de9707f9SLawrence Tang length = generate_section_firmware(location); 262de9707f9SLawrence Tang else if (strcmp(type, "pcibus") == 0) 263de9707f9SLawrence Tang length = generate_section_pci_bus(location); 264de9707f9SLawrence Tang else if (strcmp(type, "pcidev") == 0) 265de9707f9SLawrence Tang length = generate_section_pci_dev(location); 266de9707f9SLawrence Tang else if (strcmp(type, "dmargeneric") == 0) 267de9707f9SLawrence Tang length = generate_section_dmar_generic(location); 268de9707f9SLawrence Tang else if (strcmp(type, "dmarvtd") == 0) 269de9707f9SLawrence Tang length = generate_section_dmar_vtd(location); 270de9707f9SLawrence Tang else if (strcmp(type, "dmariommu") == 0) 271de9707f9SLawrence Tang length = generate_section_dmar_iommu(location); 272de9707f9SLawrence Tang else if (strcmp(type, "ccixper") == 0) 273de9707f9SLawrence Tang length = generate_section_ccix_per(location); 274de9707f9SLawrence Tang else if (strcmp(type, "cxlprotocol") == 0) 275de9707f9SLawrence Tang length = generate_section_cxl_protocol(location); 276de9707f9SLawrence Tang else if (strcmp(type, "cxlcomponent") == 0) 277de9707f9SLawrence Tang length = generate_section_cxl_component(location); 278de9707f9SLawrence Tang else if (strcmp(type, "unknown") == 0) 279de9707f9SLawrence Tang length = generate_random_section(location, rand() % 256); 280e407b4c8SLawrence Tang else { 28102c801a5SLawrence Tang //Undefined section, show error. 282e407b4c8SLawrence Tang printf("Undefined section type '%s' given to generate. See 'cper-generate --help' for command information.\n", 283e407b4c8SLawrence Tang type); 28402c801a5SLawrence Tang return 0; 28502c801a5SLawrence Tang } 28602c801a5SLawrence Tang 28702c801a5SLawrence Tang return length; 28802c801a5SLawrence Tang }