1 /**
2 * Describes functions for parsing JSON IR CPER data into binary CPER format.
3 *
4 * Author: Lawrence.Tang@arm.com
5 **/
6
7 #include <stdio.h>
8 #include <string.h>
9 #include <json.h>
10 #include <libcper/base64.h>
11 #include <libcper/Cper.h>
12 #include <libcper/cper-parse.h>
13 #include <libcper/cper-utils.h>
14 #include <libcper/sections/cper-section.h>
15
16 //Private pre-declarations.
17 void ir_header_to_cper(json_object *header_ir,
18 EFI_COMMON_ERROR_RECORD_HEADER *header);
19 void ir_section_descriptor_to_cper(json_object *section_descriptor_ir,
20 EFI_ERROR_SECTION_DESCRIPTOR *descriptor);
21 void ir_section_to_cper(json_object *section,
22 EFI_ERROR_SECTION_DESCRIPTOR *descriptor, FILE *out);
23
24 //Converts the given JSON IR CPER representation into CPER binary format, piped to the provided file stream.
25 //This function performs no validation of the IR against the CPER-JSON specification. To ensure a safe call,
26 //use validate_schema() from json-schema.h before attempting to call this function.
ir_to_cper(json_object * ir,FILE * out)27 void ir_to_cper(json_object *ir, FILE *out)
28 {
29 //Create the CPER header.
30 EFI_COMMON_ERROR_RECORD_HEADER *header =
31 (EFI_COMMON_ERROR_RECORD_HEADER *)calloc(
32 1, sizeof(EFI_COMMON_ERROR_RECORD_HEADER));
33 ir_header_to_cper(json_object_object_get(ir, "header"), header);
34 fwrite(header, sizeof(EFI_COMMON_ERROR_RECORD_HEADER), 1, out);
35 fflush(out);
36
37 //Create the CPER section descriptors.
38 json_object *section_descriptors =
39 json_object_object_get(ir, "sectionDescriptors");
40 int amt_descriptors = json_object_array_length(section_descriptors);
41 EFI_ERROR_SECTION_DESCRIPTOR *descriptors[amt_descriptors];
42 for (int i = 0; i < amt_descriptors; i++) {
43 descriptors[i] = (EFI_ERROR_SECTION_DESCRIPTOR *)calloc(
44 1, sizeof(EFI_ERROR_SECTION_DESCRIPTOR));
45 ir_section_descriptor_to_cper(
46 json_object_array_get_idx(section_descriptors, i),
47 descriptors[i]);
48 fwrite(descriptors[i], sizeof(EFI_ERROR_SECTION_DESCRIPTOR), 1,
49 out);
50 fflush(out);
51 }
52
53 //Run through each section in turn.
54 json_object *sections = json_object_object_get(ir, "sections");
55 int amt_sections = json_object_array_length(sections);
56 if (amt_sections == amt_descriptors) {
57 for (int i = 0; i < amt_sections; i++) {
58 //Get the section itself from the IR.
59 json_object *section =
60 json_object_array_get_idx(sections, i);
61
62 //Convert.
63 ir_section_to_cper(section, descriptors[i], out);
64 }
65 }
66
67 //Free all remaining resources.
68 free(header);
69 for (int i = 0; i < amt_descriptors; i++) {
70 free(descriptors[i]);
71 }
72 }
73
74 //Converts a CPER-JSON IR header to a CPER header structure.
ir_header_to_cper(json_object * header_ir,EFI_COMMON_ERROR_RECORD_HEADER * header)75 void ir_header_to_cper(json_object *header_ir,
76 EFI_COMMON_ERROR_RECORD_HEADER *header)
77 {
78 header->SignatureStart = 0x52455043; //CPER
79
80 //Revision.
81 json_object *revision = json_object_object_get(header_ir, "revision");
82 int minor =
83 json_object_get_int(json_object_object_get(revision, "minor"));
84 int major =
85 json_object_get_int(json_object_object_get(revision, "major"));
86 header->Revision = minor + (major << 8);
87
88 header->SignatureEnd = 0xFFFFFFFF;
89
90 //Section count.
91 int section_count = json_object_get_int(
92 json_object_object_get(header_ir, "sectionCount"));
93 header->SectionCount = (UINT16)section_count;
94
95 //Error severity.
96 json_object *severity = json_object_object_get(header_ir, "severity");
97 header->ErrorSeverity = (UINT32)json_object_get_uint64(
98 json_object_object_get(severity, "code"));
99
100 //Validation bits.
101 ValidationTypes ui32Type = { UINT_32T, .value.ui32 = 0 };
102 struct json_object *obj = NULL;
103
104 //Record length.
105 header->RecordLength = (UINT32)json_object_get_uint64(
106 json_object_object_get(header_ir, "recordLength"));
107
108 //Timestamp, if present.
109 if (json_object_object_get_ex(header_ir, "timestamp", &obj)) {
110 json_object *timestamp = obj;
111 if (timestamp != NULL) {
112 string_to_timestamp(&header->TimeStamp,
113 json_object_get_string(timestamp));
114 header->TimeStamp.Flag = json_object_get_boolean(
115 json_object_object_get(header_ir,
116 "timestampIsPrecise"));
117 }
118 add_to_valid_bitfield(&ui32Type, 1);
119 }
120
121 //Various GUIDs.
122 json_object *platform_id;
123 json_object_object_get_ex(header_ir, "platformID", &platform_id);
124 json_object *partition_id;
125 json_object_object_get_ex(header_ir, "partitionID", &partition_id);
126 if (platform_id != NULL) {
127 string_to_guid(&header->PlatformID,
128 json_object_get_string(platform_id));
129 add_to_valid_bitfield(&ui32Type, 0);
130 }
131 if (partition_id != NULL) {
132 string_to_guid(&header->PartitionID,
133 json_object_get_string(partition_id));
134 add_to_valid_bitfield(&ui32Type, 2);
135 }
136 string_to_guid(&header->CreatorID,
137 json_object_get_string(
138 json_object_object_get(header_ir, "creatorID")));
139
140 //Notification type.
141 json_object *notification_type =
142 json_object_object_get(header_ir, "notificationType");
143 string_to_guid(&header->NotificationType,
144 json_object_get_string(json_object_object_get(
145 notification_type, "guid")));
146
147 //Record ID, persistence info.
148 header->RecordID = json_object_get_uint64(
149 json_object_object_get(header_ir, "recordID"));
150 header->PersistenceInfo = json_object_get_uint64(
151 json_object_object_get(header_ir, "persistenceInfo"));
152
153 //Flags.
154 json_object *flags = json_object_object_get(header_ir, "flags");
155 header->Flags = (UINT32)json_object_get_uint64(
156 json_object_object_get(flags, "value"));
157
158 header->ValidationBits = ui32Type.value.ui32;
159 }
160
161 //Converts a single given IR section into CPER, outputting to the given stream.
ir_section_to_cper(json_object * section,EFI_ERROR_SECTION_DESCRIPTOR * descriptor,FILE * out)162 void ir_section_to_cper(json_object *section,
163 EFI_ERROR_SECTION_DESCRIPTOR *descriptor, FILE *out)
164 {
165 json_object *ir = NULL;
166
167 //Find the correct section type, and parse.
168 int section_converted = 0;
169 for (size_t i = 0; i < section_definitions_len; i++) {
170 if (guid_equal(section_definitions[i].Guid,
171 &descriptor->SectionType) &&
172 section_definitions[i].ToCPER != NULL) {
173 ir = json_object_object_get(
174 section, section_definitions[i].ShortName);
175 section_definitions[i].ToCPER(ir, out);
176 section_converted = 1;
177 break;
178 }
179 }
180
181 //If unknown GUID, so read as a base64 unknown section.
182 if (!section_converted) {
183 ir = json_object_object_get(section, "Unknown");
184 json_object *encoded = json_object_object_get(ir, "data");
185
186 int32_t decoded_len = 0;
187
188 UINT8 *decoded = base64_decode(
189 json_object_get_string(encoded),
190 json_object_get_string_len(encoded), &decoded_len);
191 if (decoded == NULL) {
192 printf("Failed to allocate decode output buffer. \n");
193 } else {
194 fwrite(decoded, decoded_len, 1, out);
195 free(decoded);
196 }
197 }
198 }
199
200 //Converts a single CPER-JSON IR section descriptor into a CPER structure.
ir_section_descriptor_to_cper(json_object * section_descriptor_ir,EFI_ERROR_SECTION_DESCRIPTOR * descriptor)201 void ir_section_descriptor_to_cper(json_object *section_descriptor_ir,
202 EFI_ERROR_SECTION_DESCRIPTOR *descriptor)
203 {
204 //Section offset, length.
205 descriptor->SectionOffset = (UINT32)json_object_get_uint64(
206 json_object_object_get(section_descriptor_ir, "sectionOffset"));
207 descriptor->SectionLength = (UINT32)json_object_get_uint64(
208 json_object_object_get(section_descriptor_ir, "sectionLength"));
209
210 //Revision.
211 json_object *revision =
212 json_object_object_get(section_descriptor_ir, "revision");
213 int minor =
214 json_object_get_int(json_object_object_get(revision, "minor"));
215 int major =
216 json_object_get_int(json_object_object_get(revision, "major"));
217 descriptor->Revision = minor + (major << 8);
218
219 //Validation bits, flags.
220 ValidationTypes ui8Type = { UINT_8T, .value.ui8 = 0 };
221 struct json_object *obj = NULL;
222
223 descriptor->SectionFlags = ir_to_bitfield(
224 json_object_object_get(section_descriptor_ir, "flags"), 8,
225 CPER_SECTION_DESCRIPTOR_FLAGS_BITFIELD_NAMES);
226
227 //Section type.
228 json_object *section_type =
229 json_object_object_get(section_descriptor_ir, "sectionType");
230 string_to_guid(&descriptor->SectionType,
231 json_object_get_string(
232 json_object_object_get(section_type, "data")));
233
234 //FRU ID, if present.
235 if (json_object_object_get_ex(section_descriptor_ir, "fruID", &obj)) {
236 json_object *fru_id = obj;
237 if (fru_id != NULL) {
238 string_to_guid(&descriptor->FruId,
239 json_object_get_string(fru_id));
240 add_to_valid_bitfield(&ui8Type, 0);
241 }
242 }
243
244 //Severity code.
245 json_object *severity =
246 json_object_object_get(section_descriptor_ir, "severity");
247 descriptor->Severity = (UINT32)json_object_get_uint64(
248 json_object_object_get(severity, "code"));
249
250 //FRU text, if present.
251 if (json_object_object_get_ex(section_descriptor_ir, "fruText", &obj)) {
252 json_object *fru_text = obj;
253 if (fru_text != NULL) {
254 strncpy(descriptor->FruString,
255 json_object_get_string(fru_text),
256 sizeof(descriptor->FruString) - 1);
257 descriptor
258 ->FruString[sizeof(descriptor->FruString) - 1] =
259 '\0';
260 add_to_valid_bitfield(&ui8Type, 1);
261 }
262 }
263 descriptor->SecValidMask = ui8Type.value.ui8;
264 }
265
266 //Converts IR for a given single section format CPER record into CPER binary.
ir_single_section_to_cper(json_object * ir,FILE * out)267 void ir_single_section_to_cper(json_object *ir, FILE *out)
268 {
269 //Create & write a section descriptor to file.
270 EFI_ERROR_SECTION_DESCRIPTOR section_descriptor;
271 memset(§ion_descriptor, 0, sizeof(section_descriptor));
272
273 ir_section_descriptor_to_cper(
274 json_object_object_get(ir, "sectionDescriptor"),
275 §ion_descriptor);
276 fwrite(§ion_descriptor, sizeof(section_descriptor), 1, out);
277
278 //Write section to file.
279 ir_section_to_cper(json_object_object_get(ir, "section"),
280 §ion_descriptor, out);
281
282 fflush(out);
283 }
284