]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Srat/SratParser.c
ShellPkg: acpiview: PPTT: Prevent buffer overruns
[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / Parsers / Srat / SratParser.c
CommitLineData
a6eaba4d 1/** @file\r
ee4dc24f
RN
2 SRAT table parser\r
3\r
527a3685 4 Copyright (c) 2016 - 2019, ARM Limited. All rights reserved.\r
56ba3746 5 SPDX-License-Identifier: BSD-2-Clause-Patent\r
ee4dc24f
RN
6\r
7 @par Reference(s):\r
8 - ACPI 6.2 Specification - Errata A, September 2017\r
9**/\r
10\r
11#include <IndustryStandard/Acpi.h>\r
12#include <Library/PrintLib.h>\r
13#include <Library/UefiLib.h>\r
14#include "AcpiParser.h"\r
15#include "AcpiTableParser.h"\r
16\r
17// Local Variables\r
18STATIC CONST UINT8* SratRAType;\r
19STATIC CONST UINT8* SratRALength;\r
20STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
21\r
a6eaba4d
DB
22/**\r
23 This function validates the Reserved field in the SRAT table header.\r
ee4dc24f
RN
24\r
25 @param [in] Ptr Pointer to the start of the field data.\r
26 @param [in] Context Pointer to context specific information e.g. this\r
27 could be a pointer to the ACPI table header.\r
a6eaba4d 28**/\r
ee4dc24f
RN
29STATIC\r
30VOID\r
31EFIAPI\r
32ValidateSratReserved (\r
33 IN UINT8* Ptr,\r
34 IN VOID* Context\r
527a3685
KK
35 )\r
36{\r
37 if (*(UINT32*)Ptr != 1) {\r
38 IncrementErrorCount ();\r
39 Print (L"\nERROR: Reserved should be 1 for backward compatibility.\n");\r
40 }\r
41}\r
ee4dc24f 42\r
a6eaba4d
DB
43/**\r
44 This function traces the APIC Proximity Domain field.\r
ee4dc24f
RN
45\r
46 @param [in] Format Format string for tracing the data.\r
47 @param [in] Ptr Pointer to the start of the buffer.\r
a6eaba4d 48**/\r
ee4dc24f
RN
49STATIC\r
50VOID\r
7343bc80 51EFIAPI\r
ee4dc24f 52DumpSratApicProximity (\r
527a3685
KK
53 IN CONST CHAR16* Format,\r
54 IN UINT8* Ptr\r
55 )\r
56{\r
57 UINT32 ProximityDomain;\r
58\r
59 ProximityDomain = Ptr[0] | (Ptr[1] << 8) | (Ptr[2] << 16);\r
60\r
61 Print (Format, ProximityDomain);\r
62}\r
ee4dc24f 63\r
a6eaba4d
DB
64/**\r
65 An ACPI_PARSER array describing the SRAT Table.\r
66**/\r
ee4dc24f
RN
67STATIC CONST ACPI_PARSER SratParser[] = {\r
68 PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
69 {L"Reserved", 4, 36, L"0x%x", NULL, NULL, ValidateSratReserved, NULL},\r
70 {L"Reserved", 8, 40, L"0x%lx", NULL, NULL, NULL, NULL}\r
71};\r
72\r
a6eaba4d
DB
73/**\r
74 An ACPI_PARSER array describing the Resource Allocation structure header.\r
75**/\r
ee4dc24f
RN
76STATIC CONST ACPI_PARSER SratResourceAllocationParser[] = {\r
77 {L"Type", 1, 0, NULL, NULL, (VOID**)&SratRAType, NULL, NULL},\r
78 {L"Length", 1, 1, NULL, NULL, (VOID**)&SratRALength, NULL, NULL}\r
79};\r
80\r
a6eaba4d
DB
81/**\r
82 An ACPI_PARSER array describing the GICC Affinity structure.\r
83**/\r
ee4dc24f
RN
84STATIC CONST ACPI_PARSER SratGicCAffinityParser[] = {\r
85 {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
86 {L"Length", 1, 1, L"0x%x", NULL, NULL, NULL, NULL},\r
87\r
88 {L"Proximity Domain", 4, 2, L"0x%x", NULL, NULL, NULL, NULL},\r
89 {L"ACPI Processor UID", 4, 6, L"0x%x", NULL, NULL, NULL, NULL},\r
90 {L"Flags", 4, 10, L"0x%x", NULL, NULL, NULL, NULL},\r
91 {L"Clock Domain", 4, 14, L"0x%x", NULL, NULL, NULL, NULL}\r
92};\r
93\r
a6eaba4d
DB
94/**\r
95 An ACPI_PARSER array describing the GIC ITS Affinity structure.\r
96**/\r
ee4dc24f
RN
97STATIC CONST ACPI_PARSER SratGicITSAffinityParser[] = {\r
98 {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
99 {L"Length", 1, 1, L"0x%x", NULL, NULL, NULL, NULL},\r
100\r
101 {L"Proximity Domain", 4, 2, L"0x%x", NULL, NULL, NULL, NULL},\r
102 {L"Reserved", 2, 6, L"0x%x", NULL, NULL, NULL, NULL},\r
103 {L"ITS Id", 4, 8, L"0x%x", NULL, NULL, NULL, NULL},\r
104};\r
105\r
a6eaba4d
DB
106/**\r
107 An ACPI_PARSER array describing the Memory Affinity structure.\r
108**/\r
ee4dc24f
RN
109STATIC CONST ACPI_PARSER SratMemAffinityParser[] = {\r
110 {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
111 {L"Length", 1, 1, L"0x%x", NULL, NULL, NULL, NULL},\r
112\r
113 {L"Proximity Domain", 4, 2, L"0x%x", NULL, NULL, NULL, NULL},\r
114 {L"Reserved", 2, 6, L"0x%x", NULL, NULL, NULL, NULL},\r
115 {L"Base Address Low", 4, 8, L"0x%x", NULL, NULL, NULL, NULL},\r
116 {L"Base Address High", 4, 12, L"0x%x", NULL, NULL, NULL, NULL},\r
117 {L"Length Low", 4, 16, L"0x%x", NULL, NULL, NULL, NULL},\r
118 {L"Length High", 4, 20, L"0x%x", NULL, NULL, NULL, NULL},\r
119 {L"Reserved", 4, 24, L"0x%x", NULL, NULL, NULL, NULL},\r
120 {L"Flags", 4, 28, L"0x%x", NULL, NULL, NULL, NULL},\r
121 {L"Reserved", 8, 32, L"0x%lx", NULL, NULL, NULL, NULL}\r
122};\r
123\r
a6eaba4d
DB
124/**\r
125 An ACPI_PARSER array describing the APIC/SAPIC Affinity structure.\r
126**/\r
ee4dc24f
RN
127STATIC CONST ACPI_PARSER SratApciSapicAffinityParser[] = {\r
128 {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
129 {L"Length", 1, 1, L"0x%x", NULL, NULL, NULL, NULL},\r
130\r
131 {L"Proximity Domain [7:0]", 1, 2, L"0x%x", NULL, NULL, NULL, NULL},\r
132 {L"APIC ID", 1, 3, L"0x%x", NULL, NULL, NULL, NULL},\r
133 {L"Flags", 4, 4, L"0x%x", NULL, NULL, NULL, NULL},\r
134 {L"Local SAPIC EID", 1, 8, L"0x%x", NULL, NULL, NULL, NULL},\r
135 {L"Proximity Domain [31:8]", 3, 9, L"0x%x", DumpSratApicProximity,\r
136 NULL, NULL, NULL},\r
137 {L"Clock Domain", 4, 12, L"0x%x", NULL, NULL, NULL, NULL}\r
138};\r
139\r
a6eaba4d
DB
140/**\r
141 An ACPI_PARSER array describing the Processor Local x2APIC Affinity structure.\r
142**/\r
ee4dc24f
RN
143STATIC CONST ACPI_PARSER SratX2ApciAffinityParser[] = {\r
144 {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
145 {L"Length", 1, 1, L"0x%x", NULL, NULL, NULL, NULL},\r
146\r
147 {L"Reserved", 2, 2, L"0x%x", NULL, NULL, NULL, NULL},\r
148 {L"Proximity Domain", 4, 4, L"0x%x", NULL, NULL, NULL, NULL},\r
149 {L"X2APIC ID", 4, 8, L"0x%x", NULL, NULL, NULL, NULL},\r
150 {L"Flags", 4, 12, L"0x%x", NULL, NULL, NULL, NULL},\r
151 {L"Clock Domain", 4, 16, L"0x%x", NULL, NULL, NULL, NULL},\r
152 {L"Reserved", 4, 20, L"0x%x", NULL, NULL, NULL, NULL}\r
153};\r
154\r
a6eaba4d
DB
155/**\r
156 This function parses the ACPI SRAT table.\r
ee4dc24f
RN
157 When trace is enabled this function parses the SRAT table and\r
158 traces the ACPI table fields.\r
159\r
160 This function parses the following Resource Allocation Structures:\r
161 - Processor Local APIC/SAPIC Affinity Structure\r
162 - Memory Affinity Structure\r
163 - Processor Local x2APIC Affinity Structure\r
164 - GICC Affinity Structure\r
165\r
166 This function also performs validation of the ACPI table fields.\r
167\r
168 @param [in] Trace If TRUE, trace the ACPI fields.\r
169 @param [in] Ptr Pointer to the start of the buffer.\r
170 @param [in] AcpiTableLength Length of the ACPI table.\r
171 @param [in] AcpiTableRevision Revision of the ACPI table.\r
a6eaba4d 172**/\r
ee4dc24f
RN
173VOID\r
174EFIAPI\r
175ParseAcpiSrat (\r
176 IN BOOLEAN Trace,\r
177 IN UINT8* Ptr,\r
178 IN UINT32 AcpiTableLength,\r
179 IN UINT8 AcpiTableRevision\r
180 )\r
181{\r
182 UINT32 Offset;\r
183 UINT8* ResourcePtr;\r
f75c7478
DB
184 UINT32 GicCAffinityIndex;\r
185 UINT32 GicITSAffinityIndex;\r
186 UINT32 MemoryAffinityIndex;\r
187 UINT32 ApicSapicAffinityIndex;\r
188 UINT32 X2ApicAffinityIndex;\r
ee4dc24f
RN
189 CHAR8 Buffer[80]; // Used for AsciiName param of ParseAcpi\r
190\r
f75c7478
DB
191 GicCAffinityIndex = 0;\r
192 GicITSAffinityIndex = 0;\r
193 MemoryAffinityIndex = 0;\r
194 ApicSapicAffinityIndex = 0;\r
195 X2ApicAffinityIndex = 0;\r
196\r
ee4dc24f
RN
197 if (!Trace) {\r
198 return;\r
199 }\r
200\r
201 Offset = ParseAcpi (\r
202 TRUE,\r
203 0,\r
204 "SRAT",\r
205 Ptr,\r
206 AcpiTableLength,\r
207 PARSER_PARAMS (SratParser)\r
208 );\r
748c1efd 209\r
ee4dc24f
RN
210 ResourcePtr = Ptr + Offset;\r
211\r
212 while (Offset < AcpiTableLength) {\r
213 ParseAcpi (\r
214 FALSE,\r
215 0,\r
216 NULL,\r
217 ResourcePtr,\r
218 2, // The length is 1 byte at offset 1\r
219 PARSER_PARAMS (SratResourceAllocationParser)\r
220 );\r
221\r
222 switch (*SratRAType) {\r
223 case EFI_ACPI_6_2_GICC_AFFINITY:\r
224 AsciiSPrint (\r
225 Buffer,\r
226 sizeof (Buffer),\r
227 "GICC Affinity Structure [%d]",\r
228 GicCAffinityIndex++\r
229 );\r
230 ParseAcpi (\r
231 TRUE,\r
232 2,\r
233 Buffer,\r
234 ResourcePtr,\r
235 *SratRALength,\r
236 PARSER_PARAMS (SratGicCAffinityParser)\r
237 );\r
238 break;\r
239\r
240 case EFI_ACPI_6_2_GIC_ITS_AFFINITY:\r
241 AsciiSPrint (\r
242 Buffer,\r
243 sizeof (Buffer),\r
244 "GIC ITS Affinity Structure [%d]",\r
245 GicITSAffinityIndex++\r
246 );\r
247 ParseAcpi (\r
248 TRUE,\r
249 2,\r
250 Buffer,\r
251 ResourcePtr,\r
252 *SratRALength,\r
253 PARSER_PARAMS (SratGicITSAffinityParser)\r
748c1efd 254 );\r
ee4dc24f
RN
255 break;\r
256\r
257 case EFI_ACPI_6_2_MEMORY_AFFINITY:\r
258 AsciiSPrint (\r
259 Buffer,\r
260 sizeof (Buffer),\r
261 "Memory Affinity Structure [%d]",\r
262 MemoryAffinityIndex++\r
263 );\r
264 ParseAcpi (\r
265 TRUE,\r
266 2,\r
267 Buffer,\r
268 ResourcePtr,\r
269 *SratRALength,\r
270 PARSER_PARAMS (SratMemAffinityParser)\r
271 );\r
272 break;\r
273\r
274 case EFI_ACPI_6_2_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY:\r
275 AsciiSPrint (\r
276 Buffer,\r
277 sizeof (Buffer),\r
278 "APIC/SAPIC Affinity Structure [%d]",\r
279 ApicSapicAffinityIndex++\r
280 );\r
281 ParseAcpi (\r
282 TRUE,\r
283 2,\r
284 Buffer,\r
285 ResourcePtr,\r
286 *SratRALength,\r
287 PARSER_PARAMS (SratApciSapicAffinityParser)\r
288 );\r
289 break;\r
290\r
291 case EFI_ACPI_6_2_PROCESSOR_LOCAL_X2APIC_AFFINITY:\r
292 AsciiSPrint (\r
293 Buffer,\r
294 sizeof (Buffer),\r
295 "X2APIC Affinity Structure [%d]",\r
296 X2ApicAffinityIndex++\r
297 );\r
298 ParseAcpi (\r
299 TRUE,\r
300 2,\r
301 Buffer,\r
302 ResourcePtr,\r
303 *SratRALength,\r
304 PARSER_PARAMS (SratX2ApciAffinityParser)\r
305 );\r
306 break;\r
307\r
308 default:\r
309 IncrementErrorCount ();\r
310 Print (L"ERROR: Unknown SRAT Affinity type = 0x%x\n", *SratRAType);\r
311 break;\r
312 }\r
313\r
314 ResourcePtr += (*SratRALength);\r
315 Offset += (*SratRALength);\r
316 }\r
317}\r