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"
128f977457SLawrence Tang #include "sections/gen-section.h"
13d34f2b11SLawrence Tang #include "cper-generate.h"
1402c801a5SLawrence Tang
15e407b4c8SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR *generate_section_descriptor(char *type,
16*b35d957eSEd Tanous const 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.
generate_cper_record(char ** types,UINT16 num_sections,FILE * out)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.
60f8fc7052SJohn Chung header->ValidationBits = 0x3;
6102c801a5SLawrence Tang
6202c801a5SLawrence Tang //Generate the section descriptors given the number of sections.
6302c801a5SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR *section_descriptors[num_sections];
64f8fc7052SJohn Chung 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);
67f8fc7052SJohn Chung }
6802c801a5SLawrence Tang
6902c801a5SLawrence Tang //Calculate total length of structure, set in header.
7067cbed6bSLawrence Tang size_t total_len = sizeof(EFI_COMMON_ERROR_RECORD_HEADER);
71f8fc7052SJohn Chung for (int i = 0; i < num_sections; i++) {
7202c801a5SLawrence Tang total_len += section_lengths[i];
73f8fc7052SJohn Chung }
7402c801a5SLawrence Tang total_len += num_sections * sizeof(EFI_ERROR_SECTION_DESCRIPTOR);
7502c801a5SLawrence Tang header->RecordLength = (UINT32)total_len;
7602c801a5SLawrence Tang
77d34f2b11SLawrence Tang //Write to stream in order, free all resources.
78d34f2b11SLawrence Tang fwrite(header, sizeof(EFI_COMMON_ERROR_RECORD_HEADER), 1, out);
79d34f2b11SLawrence Tang fflush(out);
8002c801a5SLawrence Tang free(header);
81e407b4c8SLawrence Tang for (int i = 0; i < num_sections; i++) {
82e407b4c8SLawrence Tang fwrite(section_descriptors[i],
83e407b4c8SLawrence Tang sizeof(EFI_ERROR_SECTION_DESCRIPTOR), 1, out);
84d34f2b11SLawrence Tang fflush(out);
8502c801a5SLawrence Tang free(section_descriptors[i]);
8602c801a5SLawrence Tang }
87e407b4c8SLawrence Tang for (int i = 0; i < num_sections; i++) {
88d34f2b11SLawrence Tang fwrite(sections[i], section_lengths[i], 1, out);
89d34f2b11SLawrence Tang fflush(out);
9002c801a5SLawrence Tang free(sections[i]);
9102c801a5SLawrence Tang }
9202c801a5SLawrence Tang }
9302c801a5SLawrence Tang
94617949e4SLawrence Tang //Generates a single section record for the given section, and outputs to file.
generate_single_section_record(char * type,FILE * out)95617949e4SLawrence Tang void generate_single_section_record(char *type, FILE *out)
96617949e4SLawrence Tang {
97617949e4SLawrence Tang //Generate a section.
98f8fc7052SJohn Chung void *section = NULL;
99617949e4SLawrence Tang size_t section_len = generate_section(§ion, type);
100617949e4SLawrence Tang
101617949e4SLawrence Tang //Generate a descriptor, correct the offset.
102617949e4SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR *section_descriptor =
103617949e4SLawrence Tang generate_section_descriptor(type, §ion_len, 0, 1);
104617949e4SLawrence Tang section_descriptor->SectionOffset =
105617949e4SLawrence Tang sizeof(EFI_ERROR_SECTION_DESCRIPTOR);
106617949e4SLawrence Tang
107617949e4SLawrence Tang //Write all to file.
108617949e4SLawrence Tang fwrite(section_descriptor, sizeof(EFI_ERROR_SECTION_DESCRIPTOR), 1,
109617949e4SLawrence Tang out);
110617949e4SLawrence Tang fwrite(section, section_len, 1, out);
111617949e4SLawrence Tang fflush(out);
112617949e4SLawrence Tang
113617949e4SLawrence Tang //Free remaining resources.
114617949e4SLawrence Tang free(section_descriptor);
115f8fc7052SJohn Chung free(section);
116617949e4SLawrence Tang }
117617949e4SLawrence Tang
11802c801a5SLawrence Tang //Generates a single section descriptor for a section with the given properties.
generate_section_descriptor(char * type,const size_t * lengths,int index,int num_sections)119e407b4c8SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR *generate_section_descriptor(char *type,
120*b35d957eSEd Tanous const size_t *lengths,
121e407b4c8SLawrence Tang int index,
122e407b4c8SLawrence Tang int num_sections)
12302c801a5SLawrence Tang {
12402c801a5SLawrence Tang EFI_ERROR_SECTION_DESCRIPTOR *descriptor =
125e407b4c8SLawrence Tang (EFI_ERROR_SECTION_DESCRIPTOR *)generate_random_bytes(
126e407b4c8SLawrence Tang sizeof(EFI_ERROR_SECTION_DESCRIPTOR));
12702c801a5SLawrence Tang
12802c801a5SLawrence Tang //Set reserved bits to zero.
12902c801a5SLawrence Tang descriptor->Resv1 = 0;
13002c801a5SLawrence Tang descriptor->SectionFlags &= 0xFF;
13102c801a5SLawrence Tang
132aacf0e26SLawrence Tang //Validation bits all set to 'on'.
133f8fc7052SJohn Chung descriptor->SecValidMask = 0x3;
134aacf0e26SLawrence Tang
135d34f2b11SLawrence Tang //Set severity.
136d34f2b11SLawrence Tang descriptor->Severity = rand() % 4;
137d34f2b11SLawrence Tang
13802c801a5SLawrence Tang //Set length, offset from base record.
13902c801a5SLawrence Tang descriptor->SectionLength = (UINT32)lengths[index];
140e407b4c8SLawrence Tang descriptor->SectionOffset =
141e407b4c8SLawrence Tang sizeof(EFI_COMMON_ERROR_RECORD_HEADER) +
142e407b4c8SLawrence Tang (num_sections * sizeof(EFI_ERROR_SECTION_DESCRIPTOR));
143f8fc7052SJohn Chung for (int i = 0; i < index; i++) {
14402c801a5SLawrence Tang descriptor->SectionOffset += lengths[i];
145f8fc7052SJohn Chung }
14602c801a5SLawrence Tang
147aacf0e26SLawrence Tang //Ensure the FRU text is not null terminated early.
148e407b4c8SLawrence Tang for (int i = 0; i < 20; i++) {
149f8fc7052SJohn Chung if (descriptor->FruString[i] == 0x0) {
150aacf0e26SLawrence Tang descriptor->FruString[i] = rand() % 127 + 1;
151f8fc7052SJohn Chung }
152aacf0e26SLawrence Tang
153aacf0e26SLawrence Tang //Null terminate last byte.
154f8fc7052SJohn Chung if (i == 19) {
155aacf0e26SLawrence Tang descriptor->FruString[i] = 0x0;
156aacf0e26SLawrence Tang }
157f8fc7052SJohn Chung }
158aacf0e26SLawrence Tang
1598f977457SLawrence Tang //If section type is not "unknown", set section type GUID based on type name.
1608f977457SLawrence Tang int section_guid_found = 0;
1618f977457SLawrence Tang if (strcmp(type, "unknown") == 0) {
1628f977457SLawrence Tang section_guid_found = 1;
1638f977457SLawrence Tang } else {
1648f977457SLawrence Tang //Find the appropriate GUID for this section name.
165f8fc7052SJohn Chung for (size_t i = 0; i < generator_definitions_len; i++) {
1668f977457SLawrence Tang if (strcmp(type, generator_definitions[i].ShortName) ==
1678f977457SLawrence Tang 0) {
168e407b4c8SLawrence Tang memcpy(&descriptor->SectionType,
1698f977457SLawrence Tang generator_definitions[i].Guid,
170e407b4c8SLawrence Tang sizeof(EFI_GUID));
1718f977457SLawrence Tang section_guid_found = 1;
17202c801a5SLawrence Tang break;
17302c801a5SLawrence Tang }
1748f977457SLawrence Tang }
1758f977457SLawrence Tang }
1768f977457SLawrence Tang
1778f977457SLawrence Tang //Undefined section, show error.
1788f977457SLawrence Tang if (!section_guid_found) {
17902c801a5SLawrence Tang //Undefined section, show error.
180e407b4c8SLawrence Tang printf("Undefined section type '%s' provided. See 'cper-generate --help' for command information.\n",
181e407b4c8SLawrence Tang type);
18202c801a5SLawrence Tang return 0;
18302c801a5SLawrence Tang }
18402c801a5SLawrence Tang
18502c801a5SLawrence Tang return descriptor;
18602c801a5SLawrence Tang }
18702c801a5SLawrence Tang
18802c801a5SLawrence Tang //Generates a single CPER section given the string type.
generate_section(void ** location,char * type)18902c801a5SLawrence Tang size_t generate_section(void **location, char *type)
19002c801a5SLawrence Tang {
19102c801a5SLawrence Tang //The length of the section.
19202c801a5SLawrence Tang size_t length = 0;
19302c801a5SLawrence Tang
1948f977457SLawrence Tang //If the section name is "unknown", simply generate a random bytes section.
1958f977457SLawrence Tang int section_generated = 0;
1968f977457SLawrence Tang if (strcmp(type, "unknown") == 0) {
197de9707f9SLawrence Tang length = generate_random_section(location, rand() % 256);
1988f977457SLawrence Tang section_generated = 1;
1998f977457SLawrence Tang } else {
2008f977457SLawrence Tang //Function defined section, switch on the type, generate accordingly.
201f8fc7052SJohn Chung for (size_t i = 0; i < generator_definitions_len; i++) {
2028f977457SLawrence Tang if (strcmp(type, generator_definitions[i].ShortName) ==
2038f977457SLawrence Tang 0) {
2048f977457SLawrence Tang length = generator_definitions[i].Generate(
2058f977457SLawrence Tang location);
2068f977457SLawrence Tang section_generated = 1;
2078f977457SLawrence Tang break;
2088f977457SLawrence Tang }
2098f977457SLawrence Tang }
2108f977457SLawrence Tang }
2118f977457SLawrence Tang
2128f977457SLawrence Tang //If we didn't find a section generator for the given name, error out.
2138f977457SLawrence Tang if (!section_generated) {
214e407b4c8SLawrence Tang printf("Undefined section type '%s' given to generate. See 'cper-generate --help' for command information.\n",
215e407b4c8SLawrence Tang type);
21602c801a5SLawrence Tang return 0;
21702c801a5SLawrence Tang }
21802c801a5SLawrence Tang
21902c801a5SLawrence Tang return length;
22002c801a5SLawrence Tang }
221