blob: c42e075a9b3f9ce30dfbb184e46bf0a5a803e779 [file] [log] [blame]
Lawrence Tang02c801a2022-07-18 14:43:52 +01001/**
Lawrence Tangefe17e22022-08-08 09:16:23 +01002 * Describes functions for generating pseudo-random specification compliant CPER records.
Lawrence Tang02c801a2022-07-18 14:43:52 +01003 *
4 * Author: Lawrence.Tang@arm.com
5 **/
6
7#include <stdio.h>
8#include <stdlib.h>
9#include <string.h>
10#include "../edk/Cper.h"
11#include "gen-utils.h"
Lawrence Tang8f977452022-08-24 14:55:07 +010012#include "sections/gen-section.h"
Lawrence Tangd34f2b12022-07-19 15:36:31 +010013#include "cper-generate.h"
Lawrence Tang02c801a2022-07-18 14:43:52 +010014
Lawrence Tange407b4c2022-07-21 13:54:01 +010015EFI_ERROR_SECTION_DESCRIPTOR *generate_section_descriptor(char *type,
Ed Tanousb35d9572024-06-18 13:17:22 -070016 const size_t *lengths,
Lawrence Tange407b4c2022-07-21 13:54:01 +010017 int index,
18 int num_sections);
19size_t generate_section(void **location, char *type);
Lawrence Tang02c801a2022-07-18 14:43:52 +010020
Lawrence Tangd34f2b12022-07-19 15:36:31 +010021//Generates a CPER record with the given section types, outputting to the given stream.
Lawrence Tange407b4c2022-07-21 13:54:01 +010022void generate_cper_record(char **types, UINT16 num_sections, FILE *out)
Lawrence Tang02c801a2022-07-18 14:43:52 +010023{
Lawrence Tange407b4c2022-07-21 13:54:01 +010024 //Initialise randomiser.
25 init_random();
Lawrence Tang02c801a2022-07-18 14:43:52 +010026
Lawrence Tange407b4c2022-07-21 13:54:01 +010027 //Generate the sections.
28 void *sections[num_sections];
29 size_t section_lengths[num_sections];
30 for (int i = 0; i < num_sections; i++) {
31 section_lengths[i] = generate_section(sections + i, types[i]);
32 if (section_lengths[i] == 0) {
33 //Error encountered, exit.
34 printf("Error encountered generating section %d of type '%s', length returned zero.\n",
35 i + 1, types[i]);
36 return;
37 }
38 }
Lawrence Tang02c801a2022-07-18 14:43:52 +010039
Lawrence Tange407b4c2022-07-21 13:54:01 +010040 //Generate the header given the number of sections.
41 EFI_COMMON_ERROR_RECORD_HEADER *header =
42 (EFI_COMMON_ERROR_RECORD_HEADER *)calloc(
43 1, sizeof(EFI_COMMON_ERROR_RECORD_HEADER));
44 header->SignatureStart = 0x52455043; //CPER
45 header->SectionCount = num_sections;
46 header->SignatureEnd = 0xFFFFFFFF;
47 header->Flags = 4; //HW_ERROR_FLAGS_SIMULATED
48 header->RecordID = (UINT64)rand();
49 header->ErrorSeverity = rand() % 4;
Lawrence Tangaacf0e22022-07-20 13:28:52 +010050
Lawrence Tange407b4c2022-07-21 13:54:01 +010051 //Generate a valid timestamp.
52 header->TimeStamp.Century = int_to_bcd(rand() % 100);
53 header->TimeStamp.Year = int_to_bcd(rand() % 100);
54 header->TimeStamp.Month = int_to_bcd(rand() % 12 + 1);
55 header->TimeStamp.Day = int_to_bcd(rand() % 31 + 1);
56 header->TimeStamp.Hours = int_to_bcd(rand() % 24 + 1);
57 header->TimeStamp.Seconds = int_to_bcd(rand() % 60);
Lawrence Tangaacf0e22022-07-20 13:28:52 +010058
Lawrence Tange407b4c2022-07-21 13:54:01 +010059 //Turn all validation bits on.
John Chungf8fc7052024-05-03 20:05:29 +080060 header->ValidationBits = 0x3;
Lawrence Tang02c801a2022-07-18 14:43:52 +010061
Lawrence Tange407b4c2022-07-21 13:54:01 +010062 //Generate the section descriptors given the number of sections.
63 EFI_ERROR_SECTION_DESCRIPTOR *section_descriptors[num_sections];
John Chungf8fc7052024-05-03 20:05:29 +080064 for (int i = 0; i < num_sections; i++) {
Lawrence Tange407b4c2022-07-21 13:54:01 +010065 section_descriptors[i] = generate_section_descriptor(
66 types[i], section_lengths, i, num_sections);
John Chungf8fc7052024-05-03 20:05:29 +080067 }
Lawrence Tang02c801a2022-07-18 14:43:52 +010068
Lawrence Tange407b4c2022-07-21 13:54:01 +010069 //Calculate total length of structure, set in header.
70 size_t total_len = sizeof(EFI_COMMON_ERROR_RECORD_HEADER);
John Chungf8fc7052024-05-03 20:05:29 +080071 for (int i = 0; i < num_sections; i++) {
Lawrence Tange407b4c2022-07-21 13:54:01 +010072 total_len += section_lengths[i];
John Chungf8fc7052024-05-03 20:05:29 +080073 }
Lawrence Tange407b4c2022-07-21 13:54:01 +010074 total_len += num_sections * sizeof(EFI_ERROR_SECTION_DESCRIPTOR);
75 header->RecordLength = (UINT32)total_len;
Lawrence Tang02c801a2022-07-18 14:43:52 +010076
Lawrence Tange407b4c2022-07-21 13:54:01 +010077 //Write to stream in order, free all resources.
78 fwrite(header, sizeof(EFI_COMMON_ERROR_RECORD_HEADER), 1, out);
79 fflush(out);
80 free(header);
81 for (int i = 0; i < num_sections; i++) {
82 fwrite(section_descriptors[i],
83 sizeof(EFI_ERROR_SECTION_DESCRIPTOR), 1, out);
84 fflush(out);
85 free(section_descriptors[i]);
86 }
87 for (int i = 0; i < num_sections; i++) {
88 fwrite(sections[i], section_lengths[i], 1, out);
89 fflush(out);
90 free(sections[i]);
91 }
Lawrence Tang02c801a2022-07-18 14:43:52 +010092}
93
Lawrence Tang617949e2022-08-08 14:21:42 +010094//Generates a single section record for the given section, and outputs to file.
95void generate_single_section_record(char *type, FILE *out)
96{
97 //Generate a section.
John Chungf8fc7052024-05-03 20:05:29 +080098 void *section = NULL;
Lawrence Tang617949e2022-08-08 14:21:42 +010099 size_t section_len = generate_section(&section, type);
100
101 //Generate a descriptor, correct the offset.
102 EFI_ERROR_SECTION_DESCRIPTOR *section_descriptor =
103 generate_section_descriptor(type, &section_len, 0, 1);
104 section_descriptor->SectionOffset =
105 sizeof(EFI_ERROR_SECTION_DESCRIPTOR);
106
107 //Write all to file.
108 fwrite(section_descriptor, sizeof(EFI_ERROR_SECTION_DESCRIPTOR), 1,
109 out);
110 fwrite(section, section_len, 1, out);
111 fflush(out);
112
113 //Free remaining resources.
114 free(section_descriptor);
John Chungf8fc7052024-05-03 20:05:29 +0800115 free(section);
Lawrence Tang617949e2022-08-08 14:21:42 +0100116}
117
Lawrence Tang02c801a2022-07-18 14:43:52 +0100118//Generates a single section descriptor for a section with the given properties.
Lawrence Tange407b4c2022-07-21 13:54:01 +0100119EFI_ERROR_SECTION_DESCRIPTOR *generate_section_descriptor(char *type,
Ed Tanousb35d9572024-06-18 13:17:22 -0700120 const size_t *lengths,
Lawrence Tange407b4c2022-07-21 13:54:01 +0100121 int index,
122 int num_sections)
Lawrence Tang02c801a2022-07-18 14:43:52 +0100123{
Lawrence Tange407b4c2022-07-21 13:54:01 +0100124 EFI_ERROR_SECTION_DESCRIPTOR *descriptor =
125 (EFI_ERROR_SECTION_DESCRIPTOR *)generate_random_bytes(
126 sizeof(EFI_ERROR_SECTION_DESCRIPTOR));
Lawrence Tang02c801a2022-07-18 14:43:52 +0100127
Lawrence Tange407b4c2022-07-21 13:54:01 +0100128 //Set reserved bits to zero.
129 descriptor->Resv1 = 0;
130 descriptor->SectionFlags &= 0xFF;
Lawrence Tang02c801a2022-07-18 14:43:52 +0100131
Lawrence Tange407b4c2022-07-21 13:54:01 +0100132 //Validation bits all set to 'on'.
John Chungf8fc7052024-05-03 20:05:29 +0800133 descriptor->SecValidMask = 0x3;
Lawrence Tangaacf0e22022-07-20 13:28:52 +0100134
Lawrence Tange407b4c2022-07-21 13:54:01 +0100135 //Set severity.
136 descriptor->Severity = rand() % 4;
Lawrence Tangd34f2b12022-07-19 15:36:31 +0100137
Lawrence Tange407b4c2022-07-21 13:54:01 +0100138 //Set length, offset from base record.
139 descriptor->SectionLength = (UINT32)lengths[index];
140 descriptor->SectionOffset =
141 sizeof(EFI_COMMON_ERROR_RECORD_HEADER) +
142 (num_sections * sizeof(EFI_ERROR_SECTION_DESCRIPTOR));
John Chungf8fc7052024-05-03 20:05:29 +0800143 for (int i = 0; i < index; i++) {
Lawrence Tange407b4c2022-07-21 13:54:01 +0100144 descriptor->SectionOffset += lengths[i];
John Chungf8fc7052024-05-03 20:05:29 +0800145 }
Lawrence Tangaacf0e22022-07-20 13:28:52 +0100146
Lawrence Tange407b4c2022-07-21 13:54:01 +0100147 //Ensure the FRU text is not null terminated early.
148 for (int i = 0; i < 20; i++) {
John Chungf8fc7052024-05-03 20:05:29 +0800149 if (descriptor->FruString[i] == 0x0) {
Lawrence Tange407b4c2022-07-21 13:54:01 +0100150 descriptor->FruString[i] = rand() % 127 + 1;
John Chungf8fc7052024-05-03 20:05:29 +0800151 }
Lawrence Tang02c801a2022-07-18 14:43:52 +0100152
Lawrence Tange407b4c2022-07-21 13:54:01 +0100153 //Null terminate last byte.
John Chungf8fc7052024-05-03 20:05:29 +0800154 if (i == 19) {
Lawrence Tange407b4c2022-07-21 13:54:01 +0100155 descriptor->FruString[i] = 0x0;
John Chungf8fc7052024-05-03 20:05:29 +0800156 }
Lawrence Tange407b4c2022-07-21 13:54:01 +0100157 }
Lawrence Tang02c801a2022-07-18 14:43:52 +0100158
Lawrence Tang8f977452022-08-24 14:55:07 +0100159 //If section type is not "unknown", set section type GUID based on type name.
160 int section_guid_found = 0;
161 if (strcmp(type, "unknown") == 0) {
162 section_guid_found = 1;
163 } else {
164 //Find the appropriate GUID for this section name.
John Chungf8fc7052024-05-03 20:05:29 +0800165 for (size_t i = 0; i < generator_definitions_len; i++) {
Lawrence Tang8f977452022-08-24 14:55:07 +0100166 if (strcmp(type, generator_definitions[i].ShortName) ==
167 0) {
168 memcpy(&descriptor->SectionType,
169 generator_definitions[i].Guid,
170 sizeof(EFI_GUID));
171 section_guid_found = 1;
172 break;
173 }
Lawrence Tange407b4c2022-07-21 13:54:01 +0100174 }
Lawrence Tang8f977452022-08-24 14:55:07 +0100175 }
176
177 //Undefined section, show error.
178 if (!section_guid_found) {
Lawrence Tange407b4c2022-07-21 13:54:01 +0100179 //Undefined section, show error.
180 printf("Undefined section type '%s' provided. See 'cper-generate --help' for command information.\n",
181 type);
182 return 0;
183 }
184
185 return descriptor;
Lawrence Tang02c801a2022-07-18 14:43:52 +0100186}
187
188//Generates a single CPER section given the string type.
Lawrence Tange407b4c2022-07-21 13:54:01 +0100189size_t generate_section(void **location, char *type)
Lawrence Tang02c801a2022-07-18 14:43:52 +0100190{
Lawrence Tange407b4c2022-07-21 13:54:01 +0100191 //The length of the section.
192 size_t length = 0;
Lawrence Tang02c801a2022-07-18 14:43:52 +0100193
Lawrence Tang8f977452022-08-24 14:55:07 +0100194 //If the section name is "unknown", simply generate a random bytes section.
195 int section_generated = 0;
196 if (strcmp(type, "unknown") == 0) {
Lawrence Tange407b4c2022-07-21 13:54:01 +0100197 length = generate_random_section(location, rand() % 256);
Lawrence Tang8f977452022-08-24 14:55:07 +0100198 section_generated = 1;
199 } else {
200 //Function defined section, switch on the type, generate accordingly.
John Chungf8fc7052024-05-03 20:05:29 +0800201 for (size_t i = 0; i < generator_definitions_len; i++) {
Lawrence Tang8f977452022-08-24 14:55:07 +0100202 if (strcmp(type, generator_definitions[i].ShortName) ==
203 0) {
204 length = generator_definitions[i].Generate(
205 location);
206 section_generated = 1;
207 break;
208 }
209 }
210 }
211
212 //If we didn't find a section generator for the given name, error out.
213 if (!section_generated) {
Lawrence Tange407b4c2022-07-21 13:54:01 +0100214 printf("Undefined section type '%s' given to generate. See 'cper-generate --help' for command information.\n",
215 type);
216 return 0;
217 }
Lawrence Tang02c801a2022-07-18 14:43:52 +0100218
Lawrence Tange407b4c2022-07-21 13:54:01 +0100219 return length;
John Chungf8fc7052024-05-03 20:05:29 +0800220}