Commit | Line | Data |
---|---|---|
20a27a64 MK |
1 | /** @file\r |
2 | Functions in this module are associated with variable parsing operations and\r | |
3 | are intended to be usable across variable driver source files.\r | |
4 | \r | |
5 | Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r | |
6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
7 | \r | |
8 | **/\r | |
9 | \r | |
10 | #include "VariableParsing.h"\r | |
11 | \r | |
12 | /**\r | |
13 | \r | |
14 | This code checks if variable header is valid or not.\r | |
15 | \r | |
16 | @param[in] Variable Pointer to the Variable Header.\r | |
17 | @param[in] VariableStoreEnd Pointer to the Variable Store End.\r | |
18 | \r | |
19 | @retval TRUE Variable header is valid.\r | |
20 | @retval FALSE Variable header is not valid.\r | |
21 | \r | |
22 | **/\r | |
23 | BOOLEAN\r | |
24 | IsValidVariableHeader (\r | |
1436aea4 MK |
25 | IN VARIABLE_HEADER *Variable,\r |
26 | IN VARIABLE_HEADER *VariableStoreEnd\r | |
20a27a64 MK |
27 | )\r |
28 | {\r | |
29 | if ((Variable == NULL) || (Variable >= VariableStoreEnd) || (Variable->StartId != VARIABLE_DATA)) {\r | |
30 | //\r | |
31 | // Variable is NULL or has reached the end of variable store,\r | |
32 | // or the StartId is not correct.\r | |
33 | //\r | |
34 | return FALSE;\r | |
35 | }\r | |
36 | \r | |
37 | return TRUE;\r | |
38 | }\r | |
39 | \r | |
40 | /**\r | |
41 | \r | |
42 | This code gets the current status of Variable Store.\r | |
43 | \r | |
44 | @param[in] VarStoreHeader Pointer to the Variable Store Header.\r | |
45 | \r | |
46 | @retval EfiRaw Variable store status is raw.\r | |
47 | @retval EfiValid Variable store status is valid.\r | |
48 | @retval EfiInvalid Variable store status is invalid.\r | |
49 | \r | |
50 | **/\r | |
51 | VARIABLE_STORE_STATUS\r | |
52 | GetVariableStoreStatus (\r | |
1436aea4 | 53 | IN VARIABLE_STORE_HEADER *VarStoreHeader\r |
20a27a64 MK |
54 | )\r |
55 | {\r | |
56 | if ((CompareGuid (&VarStoreHeader->Signature, &gEfiAuthenticatedVariableGuid) ||\r | |
57 | CompareGuid (&VarStoreHeader->Signature, &gEfiVariableGuid)) &&\r | |
1436aea4 MK |
58 | (VarStoreHeader->Format == VARIABLE_STORE_FORMATTED) &&\r |
59 | (VarStoreHeader->State == VARIABLE_STORE_HEALTHY)\r | |
60 | )\r | |
61 | {\r | |
20a27a64 | 62 | return EfiValid;\r |
1436aea4 MK |
63 | } else if ((((UINT32 *)(&VarStoreHeader->Signature))[0] == 0xffffffff) &&\r |
64 | (((UINT32 *)(&VarStoreHeader->Signature))[1] == 0xffffffff) &&\r | |
65 | (((UINT32 *)(&VarStoreHeader->Signature))[2] == 0xffffffff) &&\r | |
66 | (((UINT32 *)(&VarStoreHeader->Signature))[3] == 0xffffffff) &&\r | |
67 | (VarStoreHeader->Size == 0xffffffff) &&\r | |
68 | (VarStoreHeader->Format == 0xff) &&\r | |
69 | (VarStoreHeader->State == 0xff)\r | |
70 | )\r | |
71 | {\r | |
20a27a64 MK |
72 | return EfiRaw;\r |
73 | } else {\r | |
74 | return EfiInvalid;\r | |
75 | }\r | |
76 | }\r | |
77 | \r | |
78 | /**\r | |
79 | This code gets the size of variable header.\r | |
80 | \r | |
04401023 MK |
81 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r |
82 | FALSE indicates authenticated variables are not used.\r | |
83 | \r | |
20a27a64 MK |
84 | @return Size of variable header in bytes in type UINTN.\r |
85 | \r | |
86 | **/\r | |
87 | UINTN\r | |
88 | GetVariableHeaderSize (\r | |
1436aea4 | 89 | IN BOOLEAN AuthFormat\r |
20a27a64 MK |
90 | )\r |
91 | {\r | |
1436aea4 | 92 | UINTN Value;\r |
20a27a64 | 93 | \r |
04401023 | 94 | if (AuthFormat) {\r |
20a27a64 MK |
95 | Value = sizeof (AUTHENTICATED_VARIABLE_HEADER);\r |
96 | } else {\r | |
97 | Value = sizeof (VARIABLE_HEADER);\r | |
98 | }\r | |
99 | \r | |
100 | return Value;\r | |
101 | }\r | |
102 | \r | |
103 | /**\r | |
104 | \r | |
105 | This code gets the size of name of variable.\r | |
106 | \r | |
04401023 MK |
107 | @param[in] Variable Pointer to the variable header.\r |
108 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r | |
109 | FALSE indicates authenticated variables are not used.\r | |
20a27a64 MK |
110 | \r |
111 | @return UINTN Size of variable in bytes.\r | |
112 | \r | |
113 | **/\r | |
114 | UINTN\r | |
115 | NameSizeOfVariable (\r | |
1436aea4 MK |
116 | IN VARIABLE_HEADER *Variable,\r |
117 | IN BOOLEAN AuthFormat\r | |
20a27a64 MK |
118 | )\r |
119 | {\r | |
1436aea4 | 120 | AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r |
20a27a64 | 121 | \r |
1436aea4 | 122 | AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *)Variable;\r |
04401023 | 123 | if (AuthFormat) {\r |
1436aea4 MK |
124 | if ((AuthVariable->State == (UINT8)(-1)) ||\r |
125 | (AuthVariable->DataSize == (UINT32)(-1)) ||\r | |
126 | (AuthVariable->NameSize == (UINT32)(-1)) ||\r | |
127 | (AuthVariable->Attributes == (UINT32)(-1)))\r | |
128 | {\r | |
20a27a64 MK |
129 | return 0;\r |
130 | }\r | |
1436aea4 MK |
131 | \r |
132 | return (UINTN)AuthVariable->NameSize;\r | |
20a27a64 | 133 | } else {\r |
1436aea4 MK |
134 | if ((Variable->State == (UINT8)(-1)) ||\r |
135 | (Variable->DataSize == (UINT32)(-1)) ||\r | |
136 | (Variable->NameSize == (UINT32)(-1)) ||\r | |
137 | (Variable->Attributes == (UINT32)(-1)))\r | |
138 | {\r | |
20a27a64 MK |
139 | return 0;\r |
140 | }\r | |
1436aea4 MK |
141 | \r |
142 | return (UINTN)Variable->NameSize;\r | |
20a27a64 MK |
143 | }\r |
144 | }\r | |
145 | \r | |
146 | /**\r | |
147 | This code sets the size of name of variable.\r | |
148 | \r | |
04401023 MK |
149 | @param[in] Variable Pointer to the Variable Header.\r |
150 | @param[in] NameSize Name size to set.\r | |
151 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r | |
152 | FALSE indicates authenticated variables are not used.\r | |
20a27a64 MK |
153 | \r |
154 | **/\r | |
155 | VOID\r | |
156 | SetNameSizeOfVariable (\r | |
1436aea4 MK |
157 | IN VARIABLE_HEADER *Variable,\r |
158 | IN UINTN NameSize,\r | |
159 | IN BOOLEAN AuthFormat\r | |
20a27a64 MK |
160 | )\r |
161 | {\r | |
1436aea4 | 162 | AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r |
20a27a64 | 163 | \r |
1436aea4 | 164 | AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *)Variable;\r |
04401023 | 165 | if (AuthFormat) {\r |
1436aea4 | 166 | AuthVariable->NameSize = (UINT32)NameSize;\r |
20a27a64 | 167 | } else {\r |
1436aea4 | 168 | Variable->NameSize = (UINT32)NameSize;\r |
20a27a64 MK |
169 | }\r |
170 | }\r | |
171 | \r | |
172 | /**\r | |
173 | \r | |
174 | This code gets the size of variable data.\r | |
175 | \r | |
04401023 MK |
176 | @param[in] Variable Pointer to the Variable Header.\r |
177 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r | |
178 | FALSE indicates authenticated variables are not used.\r | |
20a27a64 MK |
179 | \r |
180 | @return Size of variable in bytes.\r | |
181 | \r | |
182 | **/\r | |
183 | UINTN\r | |
184 | DataSizeOfVariable (\r | |
1436aea4 MK |
185 | IN VARIABLE_HEADER *Variable,\r |
186 | IN BOOLEAN AuthFormat\r | |
20a27a64 MK |
187 | )\r |
188 | {\r | |
1436aea4 | 189 | AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r |
20a27a64 | 190 | \r |
1436aea4 | 191 | AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *)Variable;\r |
04401023 | 192 | if (AuthFormat) {\r |
1436aea4 MK |
193 | if ((AuthVariable->State == (UINT8)(-1)) ||\r |
194 | (AuthVariable->DataSize == (UINT32)(-1)) ||\r | |
195 | (AuthVariable->NameSize == (UINT32)(-1)) ||\r | |
196 | (AuthVariable->Attributes == (UINT32)(-1)))\r | |
197 | {\r | |
20a27a64 MK |
198 | return 0;\r |
199 | }\r | |
1436aea4 MK |
200 | \r |
201 | return (UINTN)AuthVariable->DataSize;\r | |
20a27a64 | 202 | } else {\r |
1436aea4 MK |
203 | if ((Variable->State == (UINT8)(-1)) ||\r |
204 | (Variable->DataSize == (UINT32)(-1)) ||\r | |
205 | (Variable->NameSize == (UINT32)(-1)) ||\r | |
206 | (Variable->Attributes == (UINT32)(-1)))\r | |
207 | {\r | |
20a27a64 MK |
208 | return 0;\r |
209 | }\r | |
1436aea4 MK |
210 | \r |
211 | return (UINTN)Variable->DataSize;\r | |
20a27a64 MK |
212 | }\r |
213 | }\r | |
214 | \r | |
215 | /**\r | |
216 | This code sets the size of variable data.\r | |
217 | \r | |
218 | @param[in] Variable Pointer to the Variable Header.\r | |
219 | @param[in] DataSize Data size to set.\r | |
04401023 MK |
220 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r |
221 | FALSE indicates authenticated variables are not used.\r | |
20a27a64 MK |
222 | \r |
223 | **/\r | |
224 | VOID\r | |
225 | SetDataSizeOfVariable (\r | |
1436aea4 MK |
226 | IN VARIABLE_HEADER *Variable,\r |
227 | IN UINTN DataSize,\r | |
228 | IN BOOLEAN AuthFormat\r | |
20a27a64 MK |
229 | )\r |
230 | {\r | |
1436aea4 | 231 | AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r |
20a27a64 | 232 | \r |
1436aea4 | 233 | AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *)Variable;\r |
04401023 | 234 | if (AuthFormat) {\r |
1436aea4 | 235 | AuthVariable->DataSize = (UINT32)DataSize;\r |
20a27a64 | 236 | } else {\r |
1436aea4 | 237 | Variable->DataSize = (UINT32)DataSize;\r |
20a27a64 MK |
238 | }\r |
239 | }\r | |
240 | \r | |
241 | /**\r | |
242 | \r | |
243 | This code gets the pointer to the variable name.\r | |
244 | \r | |
04401023 MK |
245 | @param[in] Variable Pointer to the Variable Header.\r |
246 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r | |
247 | FALSE indicates authenticated variables are not used.\r | |
20a27a64 MK |
248 | \r |
249 | @return Pointer to Variable Name which is Unicode encoding.\r | |
250 | \r | |
251 | **/\r | |
252 | CHAR16 *\r | |
253 | GetVariableNamePtr (\r | |
1436aea4 MK |
254 | IN VARIABLE_HEADER *Variable,\r |
255 | IN BOOLEAN AuthFormat\r | |
20a27a64 MK |
256 | )\r |
257 | {\r | |
1436aea4 | 258 | return (CHAR16 *)((UINTN)Variable + GetVariableHeaderSize (AuthFormat));\r |
20a27a64 MK |
259 | }\r |
260 | \r | |
261 | /**\r | |
262 | This code gets the pointer to the variable guid.\r | |
263 | \r | |
04401023 MK |
264 | @param[in] Variable Pointer to the Variable Header.\r |
265 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r | |
266 | FALSE indicates authenticated variables are not used.\r | |
20a27a64 MK |
267 | \r |
268 | @return A EFI_GUID* pointer to Vendor Guid.\r | |
269 | \r | |
270 | **/\r | |
271 | EFI_GUID *\r | |
272 | GetVendorGuidPtr (\r | |
1436aea4 MK |
273 | IN VARIABLE_HEADER *Variable,\r |
274 | IN BOOLEAN AuthFormat\r | |
20a27a64 MK |
275 | )\r |
276 | {\r | |
1436aea4 | 277 | AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r |
20a27a64 | 278 | \r |
1436aea4 | 279 | AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *)Variable;\r |
04401023 | 280 | if (AuthFormat) {\r |
20a27a64 MK |
281 | return &AuthVariable->VendorGuid;\r |
282 | } else {\r | |
283 | return &Variable->VendorGuid;\r | |
284 | }\r | |
285 | }\r | |
286 | \r | |
287 | /**\r | |
288 | \r | |
289 | This code gets the pointer to the variable data.\r | |
290 | \r | |
04401023 MK |
291 | @param[in] Variable Pointer to the Variable Header.\r |
292 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r | |
293 | FALSE indicates authenticated variables are not used.\r | |
20a27a64 MK |
294 | \r |
295 | @return Pointer to Variable Data.\r | |
296 | \r | |
297 | **/\r | |
298 | UINT8 *\r | |
299 | GetVariableDataPtr (\r | |
1436aea4 MK |
300 | IN VARIABLE_HEADER *Variable,\r |
301 | IN BOOLEAN AuthFormat\r | |
20a27a64 MK |
302 | )\r |
303 | {\r | |
1436aea4 | 304 | UINTN Value;\r |
20a27a64 MK |
305 | \r |
306 | //\r | |
307 | // Be careful about pad size for alignment.\r | |
308 | //\r | |
1436aea4 | 309 | Value = (UINTN)GetVariableNamePtr (Variable, AuthFormat);\r |
04401023 MK |
310 | Value += NameSizeOfVariable (Variable, AuthFormat);\r |
311 | Value += GET_PAD_SIZE (NameSizeOfVariable (Variable, AuthFormat));\r | |
20a27a64 | 312 | \r |
1436aea4 | 313 | return (UINT8 *)Value;\r |
20a27a64 MK |
314 | }\r |
315 | \r | |
316 | /**\r | |
317 | This code gets the variable data offset related to variable header.\r | |
318 | \r | |
04401023 MK |
319 | @param[in] Variable Pointer to the Variable Header.\r |
320 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r | |
321 | FALSE indicates authenticated variables are not used.\r | |
20a27a64 MK |
322 | \r |
323 | @return Variable Data offset.\r | |
324 | \r | |
325 | **/\r | |
326 | UINTN\r | |
327 | GetVariableDataOffset (\r | |
1436aea4 MK |
328 | IN VARIABLE_HEADER *Variable,\r |
329 | IN BOOLEAN AuthFormat\r | |
20a27a64 MK |
330 | )\r |
331 | {\r | |
1436aea4 | 332 | UINTN Value;\r |
20a27a64 MK |
333 | \r |
334 | //\r | |
335 | // Be careful about pad size for alignment\r | |
336 | //\r | |
1436aea4 | 337 | Value = GetVariableHeaderSize (AuthFormat);\r |
04401023 MK |
338 | Value += NameSizeOfVariable (Variable, AuthFormat);\r |
339 | Value += GET_PAD_SIZE (NameSizeOfVariable (Variable, AuthFormat));\r | |
20a27a64 MK |
340 | \r |
341 | return Value;\r | |
342 | }\r | |
343 | \r | |
344 | /**\r | |
345 | \r | |
346 | This code gets the pointer to the next variable header.\r | |
347 | \r | |
04401023 MK |
348 | @param[in] Variable Pointer to the Variable Header.\r |
349 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r | |
350 | FALSE indicates authenticated variables are not used.\r | |
20a27a64 MK |
351 | \r |
352 | @return Pointer to next variable header.\r | |
353 | \r | |
354 | **/\r | |
355 | VARIABLE_HEADER *\r | |
356 | GetNextVariablePtr (\r | |
1436aea4 MK |
357 | IN VARIABLE_HEADER *Variable,\r |
358 | IN BOOLEAN AuthFormat\r | |
20a27a64 MK |
359 | )\r |
360 | {\r | |
1436aea4 | 361 | UINTN Value;\r |
20a27a64 | 362 | \r |
1436aea4 | 363 | Value = (UINTN)GetVariableDataPtr (Variable, AuthFormat);\r |
04401023 MK |
364 | Value += DataSizeOfVariable (Variable, AuthFormat);\r |
365 | Value += GET_PAD_SIZE (DataSizeOfVariable (Variable, AuthFormat));\r | |
20a27a64 MK |
366 | \r |
367 | //\r | |
368 | // Be careful about pad size for alignment.\r | |
369 | //\r | |
1436aea4 | 370 | return (VARIABLE_HEADER *)HEADER_ALIGN (Value);\r |
20a27a64 MK |
371 | }\r |
372 | \r | |
373 | /**\r | |
374 | \r | |
375 | Gets the pointer to the first variable header in given variable store area.\r | |
376 | \r | |
377 | @param[in] VarStoreHeader Pointer to the Variable Store Header.\r | |
378 | \r | |
379 | @return Pointer to the first variable header.\r | |
380 | \r | |
381 | **/\r | |
382 | VARIABLE_HEADER *\r | |
383 | GetStartPointer (\r | |
1436aea4 | 384 | IN VARIABLE_STORE_HEADER *VarStoreHeader\r |
20a27a64 MK |
385 | )\r |
386 | {\r | |
387 | //\r | |
388 | // The start of variable store.\r | |
389 | //\r | |
1436aea4 | 390 | return (VARIABLE_HEADER *)HEADER_ALIGN (VarStoreHeader + 1);\r |
20a27a64 MK |
391 | }\r |
392 | \r | |
393 | /**\r | |
394 | \r | |
395 | Gets the pointer to the end of the variable storage area.\r | |
396 | \r | |
397 | This function gets pointer to the end of the variable storage\r | |
398 | area, according to the input variable store header.\r | |
399 | \r | |
400 | @param[in] VarStoreHeader Pointer to the Variable Store Header.\r | |
401 | \r | |
402 | @return Pointer to the end of the variable storage area.\r | |
403 | \r | |
404 | **/\r | |
405 | VARIABLE_HEADER *\r | |
406 | GetEndPointer (\r | |
1436aea4 | 407 | IN VARIABLE_STORE_HEADER *VarStoreHeader\r |
20a27a64 MK |
408 | )\r |
409 | {\r | |
410 | //\r | |
411 | // The end of variable store\r | |
412 | //\r | |
1436aea4 | 413 | return (VARIABLE_HEADER *)HEADER_ALIGN ((UINTN)VarStoreHeader + VarStoreHeader->Size);\r |
20a27a64 MK |
414 | }\r |
415 | \r | |
416 | /**\r | |
417 | Compare two EFI_TIME data.\r | |
418 | \r | |
419 | \r | |
420 | @param[in] FirstTime A pointer to the first EFI_TIME data.\r | |
421 | @param[in] SecondTime A pointer to the second EFI_TIME data.\r | |
422 | \r | |
423 | @retval TRUE The FirstTime is not later than the SecondTime.\r | |
424 | @retval FALSE The FirstTime is later than the SecondTime.\r | |
425 | \r | |
426 | **/\r | |
427 | BOOLEAN\r | |
428 | VariableCompareTimeStampInternal (\r | |
1436aea4 MK |
429 | IN EFI_TIME *FirstTime,\r |
430 | IN EFI_TIME *SecondTime\r | |
20a27a64 MK |
431 | )\r |
432 | {\r | |
433 | if (FirstTime->Year != SecondTime->Year) {\r | |
1436aea4 | 434 | return (BOOLEAN)(FirstTime->Year < SecondTime->Year);\r |
20a27a64 | 435 | } else if (FirstTime->Month != SecondTime->Month) {\r |
1436aea4 | 436 | return (BOOLEAN)(FirstTime->Month < SecondTime->Month);\r |
20a27a64 | 437 | } else if (FirstTime->Day != SecondTime->Day) {\r |
1436aea4 | 438 | return (BOOLEAN)(FirstTime->Day < SecondTime->Day);\r |
20a27a64 | 439 | } else if (FirstTime->Hour != SecondTime->Hour) {\r |
1436aea4 | 440 | return (BOOLEAN)(FirstTime->Hour < SecondTime->Hour);\r |
20a27a64 | 441 | } else if (FirstTime->Minute != SecondTime->Minute) {\r |
1436aea4 | 442 | return (BOOLEAN)(FirstTime->Minute < SecondTime->Minute);\r |
20a27a64 MK |
443 | }\r |
444 | \r | |
1436aea4 | 445 | return (BOOLEAN)(FirstTime->Second <= SecondTime->Second);\r |
20a27a64 MK |
446 | }\r |
447 | \r | |
448 | /**\r | |
449 | Find the variable in the specified variable store.\r | |
450 | \r | |
451 | @param[in] VariableName Name of the variable to be found\r | |
452 | @param[in] VendorGuid Vendor GUID to be found.\r | |
453 | @param[in] IgnoreRtCheck Ignore EFI_VARIABLE_RUNTIME_ACCESS attribute\r | |
454 | check at runtime when searching variable.\r | |
455 | @param[in, out] PtrTrack Variable Track Pointer structure that contains Variable Information.\r | |
04401023 MK |
456 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r |
457 | FALSE indicates authenticated variables are not used.\r | |
20a27a64 MK |
458 | \r |
459 | @retval EFI_SUCCESS Variable found successfully\r | |
460 | @retval EFI_NOT_FOUND Variable not found\r | |
461 | **/\r | |
462 | EFI_STATUS\r | |
463 | FindVariableEx (\r | |
464 | IN CHAR16 *VariableName,\r | |
465 | IN EFI_GUID *VendorGuid,\r | |
466 | IN BOOLEAN IgnoreRtCheck,\r | |
04401023 MK |
467 | IN OUT VARIABLE_POINTER_TRACK *PtrTrack,\r |
468 | IN BOOLEAN AuthFormat\r | |
20a27a64 MK |
469 | )\r |
470 | {\r | |
1436aea4 MK |
471 | VARIABLE_HEADER *InDeletedVariable;\r |
472 | VOID *Point;\r | |
20a27a64 MK |
473 | \r |
474 | PtrTrack->InDeletedTransitionPtr = NULL;\r | |
475 | \r | |
476 | //\r | |
477 | // Find the variable by walk through HOB, volatile and non-volatile variable store.\r | |
478 | //\r | |
1436aea4 | 479 | InDeletedVariable = NULL;\r |
20a27a64 MK |
480 | \r |
481 | for ( PtrTrack->CurrPtr = PtrTrack->StartPtr\r | |
1436aea4 MK |
482 | ; IsValidVariableHeader (PtrTrack->CurrPtr, PtrTrack->EndPtr)\r |
483 | ; PtrTrack->CurrPtr = GetNextVariablePtr (PtrTrack->CurrPtr, AuthFormat)\r | |
484 | )\r | |
485 | {\r | |
486 | if ((PtrTrack->CurrPtr->State == VAR_ADDED) ||\r | |
487 | (PtrTrack->CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED))\r | |
488 | )\r | |
489 | {\r | |
20a27a64 MK |
490 | if (IgnoreRtCheck || !AtRuntime () || ((PtrTrack->CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) != 0)) {\r |
491 | if (VariableName[0] == 0) {\r | |
492 | if (PtrTrack->CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r | |
1436aea4 | 493 | InDeletedVariable = PtrTrack->CurrPtr;\r |
20a27a64 MK |
494 | } else {\r |
495 | PtrTrack->InDeletedTransitionPtr = InDeletedVariable;\r | |
496 | return EFI_SUCCESS;\r | |
497 | }\r | |
498 | } else {\r | |
04401023 | 499 | if (CompareGuid (VendorGuid, GetVendorGuidPtr (PtrTrack->CurrPtr, AuthFormat))) {\r |
1436aea4 | 500 | Point = (VOID *)GetVariableNamePtr (PtrTrack->CurrPtr, AuthFormat);\r |
20a27a64 | 501 | \r |
04401023 MK |
502 | ASSERT (NameSizeOfVariable (PtrTrack->CurrPtr, AuthFormat) != 0);\r |
503 | if (CompareMem (VariableName, Point, NameSizeOfVariable (PtrTrack->CurrPtr, AuthFormat)) == 0) {\r | |
20a27a64 | 504 | if (PtrTrack->CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r |
1436aea4 | 505 | InDeletedVariable = PtrTrack->CurrPtr;\r |
20a27a64 MK |
506 | } else {\r |
507 | PtrTrack->InDeletedTransitionPtr = InDeletedVariable;\r | |
508 | return EFI_SUCCESS;\r | |
509 | }\r | |
510 | }\r | |
511 | }\r | |
512 | }\r | |
513 | }\r | |
514 | }\r | |
515 | }\r | |
516 | \r | |
517 | PtrTrack->CurrPtr = InDeletedVariable;\r | |
518 | return (PtrTrack->CurrPtr == NULL) ? EFI_NOT_FOUND : EFI_SUCCESS;\r | |
519 | }\r | |
520 | \r | |
521 | /**\r | |
f8ff4cca | 522 | This code finds the next available variable.\r |
20a27a64 MK |
523 | \r |
524 | Caution: This function may receive untrusted input.\r | |
525 | This function may be invoked in SMM mode. This function will do basic validation, before parse the data.\r | |
526 | \r | |
f8ff4cca MK |
527 | @param[in] VariableName Pointer to variable name.\r |
528 | @param[in] VendorGuid Variable Vendor Guid.\r | |
529 | @param[in] VariableStoreList A list of variable stores that should be used to get the next variable.\r | |
530 | The maximum number of entries is the max value of VARIABLE_STORE_TYPE.\r | |
531 | @param[out] VariablePtr Pointer to variable header address.\r | |
04401023 MK |
532 | @param[in] AuthFormat TRUE indicates authenticated variables are used.\r |
533 | FALSE indicates authenticated variables are not used.\r | |
20a27a64 MK |
534 | \r |
535 | @retval EFI_SUCCESS The function completed successfully.\r | |
536 | @retval EFI_NOT_FOUND The next variable was not found.\r | |
537 | @retval EFI_INVALID_PARAMETER If VariableName is not an empty string, while VendorGuid is NULL.\r | |
538 | @retval EFI_INVALID_PARAMETER The input values of VariableName and VendorGuid are not a name and\r | |
539 | GUID of an existing variable.\r | |
540 | \r | |
541 | **/\r | |
542 | EFI_STATUS\r | |
543 | EFIAPI\r | |
544 | VariableServiceGetNextVariableInternal (\r | |
1436aea4 MK |
545 | IN CHAR16 *VariableName,\r |
546 | IN EFI_GUID *VendorGuid,\r | |
547 | IN VARIABLE_STORE_HEADER **VariableStoreList,\r | |
548 | OUT VARIABLE_HEADER **VariablePtr,\r | |
549 | IN BOOLEAN AuthFormat\r | |
20a27a64 MK |
550 | )\r |
551 | {\r | |
f8ff4cca MK |
552 | EFI_STATUS Status;\r |
553 | VARIABLE_STORE_TYPE StoreType;\r | |
20a27a64 MK |
554 | VARIABLE_POINTER_TRACK Variable;\r |
555 | VARIABLE_POINTER_TRACK VariableInHob;\r | |
556 | VARIABLE_POINTER_TRACK VariablePtrTrack;\r | |
20a27a64 | 557 | \r |
f8ff4cca MK |
558 | Status = EFI_NOT_FOUND;\r |
559 | \r | |
560 | if (VariableStoreList == NULL) {\r | |
561 | return EFI_INVALID_PARAMETER;\r | |
562 | }\r | |
563 | \r | |
bbb5b0d6 MK |
564 | ZeroMem (&Variable, sizeof (Variable));\r |
565 | \r | |
f8ff4cca | 566 | // Check if the variable exists in the given variable store list\r |
1436aea4 | 567 | for (StoreType = (VARIABLE_STORE_TYPE)0; StoreType < VariableStoreTypeMax; StoreType++) {\r |
f8ff4cca MK |
568 | if (VariableStoreList[StoreType] == NULL) {\r |
569 | continue;\r | |
570 | }\r | |
571 | \r | |
572 | Variable.StartPtr = GetStartPointer (VariableStoreList[StoreType]);\r | |
1436aea4 MK |
573 | Variable.EndPtr = GetEndPointer (VariableStoreList[StoreType]);\r |
574 | Variable.Volatile = (BOOLEAN)(StoreType == VariableStoreTypeVolatile);\r | |
f8ff4cca | 575 | \r |
04401023 | 576 | Status = FindVariableEx (VariableName, VendorGuid, FALSE, &Variable, AuthFormat);\r |
f8ff4cca MK |
577 | if (!EFI_ERROR (Status)) {\r |
578 | break;\r | |
579 | }\r | |
580 | }\r | |
581 | \r | |
1436aea4 | 582 | if ((Variable.CurrPtr == NULL) || EFI_ERROR (Status)) {\r |
20a27a64 | 583 | //\r |
f8ff4cca MK |
584 | // For VariableName is an empty string, FindVariableEx() will try to find and return\r |
585 | // the first qualified variable, and if FindVariableEx() returns error (EFI_NOT_FOUND)\r | |
20a27a64 MK |
586 | // as no any variable is found, still go to return the error (EFI_NOT_FOUND).\r |
587 | //\r | |
588 | if (VariableName[0] != 0) {\r | |
589 | //\r | |
f8ff4cca | 590 | // For VariableName is not an empty string, and FindVariableEx() returns error as\r |
20a27a64 MK |
591 | // VariableName and VendorGuid are not a name and GUID of an existing variable,\r |
592 | // there is no way to get next variable, follow spec to return EFI_INVALID_PARAMETER.\r | |
593 | //\r | |
594 | Status = EFI_INVALID_PARAMETER;\r | |
595 | }\r | |
1436aea4 | 596 | \r |
20a27a64 MK |
597 | goto Done;\r |
598 | }\r | |
599 | \r | |
600 | if (VariableName[0] != 0) {\r | |
601 | //\r | |
f8ff4cca | 602 | // If variable name is not empty, get next variable.\r |
20a27a64 | 603 | //\r |
04401023 | 604 | Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr, AuthFormat);\r |
20a27a64 MK |
605 | }\r |
606 | \r | |
20a27a64 MK |
607 | while (TRUE) {\r |
608 | //\r | |
f8ff4cca | 609 | // Switch to the next variable store if needed\r |
20a27a64 MK |
610 | //\r |
611 | while (!IsValidVariableHeader (Variable.CurrPtr, Variable.EndPtr)) {\r | |
612 | //\r | |
613 | // Find current storage index\r | |
614 | //\r | |
1436aea4 | 615 | for (StoreType = (VARIABLE_STORE_TYPE)0; StoreType < VariableStoreTypeMax; StoreType++) {\r |
f8ff4cca | 616 | if ((VariableStoreList[StoreType] != NULL) && (Variable.StartPtr == GetStartPointer (VariableStoreList[StoreType]))) {\r |
20a27a64 MK |
617 | break;\r |
618 | }\r | |
619 | }\r | |
1436aea4 | 620 | \r |
f8ff4cca | 621 | ASSERT (StoreType < VariableStoreTypeMax);\r |
20a27a64 MK |
622 | //\r |
623 | // Switch to next storage\r | |
624 | //\r | |
f8ff4cca MK |
625 | for (StoreType++; StoreType < VariableStoreTypeMax; StoreType++) {\r |
626 | if (VariableStoreList[StoreType] != NULL) {\r | |
20a27a64 MK |
627 | break;\r |
628 | }\r | |
629 | }\r | |
1436aea4 | 630 | \r |
20a27a64 MK |
631 | //\r |
632 | // Capture the case that\r | |
633 | // 1. current storage is the last one, or\r | |
634 | // 2. no further storage\r | |
635 | //\r | |
f8ff4cca | 636 | if (StoreType == VariableStoreTypeMax) {\r |
20a27a64 MK |
637 | Status = EFI_NOT_FOUND;\r |
638 | goto Done;\r | |
639 | }\r | |
1436aea4 | 640 | \r |
f8ff4cca | 641 | Variable.StartPtr = GetStartPointer (VariableStoreList[StoreType]);\r |
1436aea4 | 642 | Variable.EndPtr = GetEndPointer (VariableStoreList[StoreType]);\r |
20a27a64 MK |
643 | Variable.CurrPtr = Variable.StartPtr;\r |
644 | }\r | |
645 | \r | |
646 | //\r | |
647 | // Variable is found\r | |
648 | //\r | |
1436aea4 | 649 | if ((Variable.CurrPtr->State == VAR_ADDED) || (Variable.CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED))) {\r |
20a27a64 MK |
650 | if (!AtRuntime () || ((Variable.CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) != 0)) {\r |
651 | if (Variable.CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r | |
652 | //\r | |
653 | // If it is a IN_DELETED_TRANSITION variable,\r | |
654 | // and there is also a same ADDED one at the same time,\r | |
655 | // don't return it.\r | |
656 | //\r | |
657 | VariablePtrTrack.StartPtr = Variable.StartPtr;\r | |
1436aea4 MK |
658 | VariablePtrTrack.EndPtr = Variable.EndPtr;\r |
659 | Status = FindVariableEx (\r | |
660 | GetVariableNamePtr (Variable.CurrPtr, AuthFormat),\r | |
661 | GetVendorGuidPtr (Variable.CurrPtr, AuthFormat),\r | |
662 | FALSE,\r | |
663 | &VariablePtrTrack,\r | |
664 | AuthFormat\r | |
665 | );\r | |
666 | if (!EFI_ERROR (Status) && (VariablePtrTrack.CurrPtr->State == VAR_ADDED)) {\r | |
04401023 | 667 | Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr, AuthFormat);\r |
20a27a64 MK |
668 | continue;\r |
669 | }\r | |
670 | }\r | |
671 | \r | |
672 | //\r | |
673 | // Don't return NV variable when HOB overrides it\r | |
674 | //\r | |
f8ff4cca MK |
675 | if ((VariableStoreList[VariableStoreTypeHob] != NULL) && (VariableStoreList[VariableStoreTypeNv] != NULL) &&\r |
676 | (Variable.StartPtr == GetStartPointer (VariableStoreList[VariableStoreTypeNv]))\r | |
1436aea4 MK |
677 | )\r |
678 | {\r | |
f8ff4cca | 679 | VariableInHob.StartPtr = GetStartPointer (VariableStoreList[VariableStoreTypeHob]);\r |
1436aea4 MK |
680 | VariableInHob.EndPtr = GetEndPointer (VariableStoreList[VariableStoreTypeHob]);\r |
681 | Status = FindVariableEx (\r | |
682 | GetVariableNamePtr (Variable.CurrPtr, AuthFormat),\r | |
683 | GetVendorGuidPtr (Variable.CurrPtr, AuthFormat),\r | |
684 | FALSE,\r | |
685 | &VariableInHob,\r | |
686 | AuthFormat\r | |
687 | );\r | |
20a27a64 | 688 | if (!EFI_ERROR (Status)) {\r |
04401023 | 689 | Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr, AuthFormat);\r |
20a27a64 MK |
690 | continue;\r |
691 | }\r | |
692 | }\r | |
693 | \r | |
694 | *VariablePtr = Variable.CurrPtr;\r | |
1436aea4 | 695 | Status = EFI_SUCCESS;\r |
20a27a64 MK |
696 | goto Done;\r |
697 | }\r | |
698 | }\r | |
699 | \r | |
04401023 | 700 | Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr, AuthFormat);\r |
20a27a64 MK |
701 | }\r |
702 | \r | |
703 | Done:\r | |
704 | return Status;\r | |
705 | }\r | |
706 | \r | |
707 | /**\r | |
708 | Routine used to track statistical information about variable usage.\r | |
709 | The data is stored in the EFI system table so it can be accessed later.\r | |
710 | VariableInfo.efi can dump out the table. Only Boot Services variable\r | |
711 | accesses are tracked by this code. The PcdVariableCollectStatistics\r | |
712 | build flag controls if this feature is enabled.\r | |
713 | \r | |
714 | A read that hits in the cache will have Read and Cache true for\r | |
715 | the transaction. Data is allocated by this routine, but never\r | |
716 | freed.\r | |
717 | \r | |
8d53adbe MK |
718 | @param[in] VariableName Name of the Variable to track.\r |
719 | @param[in] VendorGuid Guid of the Variable to track.\r | |
720 | @param[in] Volatile TRUE if volatile FALSE if non-volatile.\r | |
721 | @param[in] Read TRUE if GetVariable() was called.\r | |
722 | @param[in] Write TRUE if SetVariable() was called.\r | |
723 | @param[in] Delete TRUE if deleted via SetVariable().\r | |
724 | @param[in] Cache TRUE for a cache hit.\r | |
725 | @param[in,out] VariableInfo Pointer to a pointer of VARIABLE_INFO_ENTRY structures.\r | |
20a27a64 MK |
726 | \r |
727 | **/\r | |
728 | VOID\r | |
729 | UpdateVariableInfo (\r | |
730 | IN CHAR16 *VariableName,\r | |
731 | IN EFI_GUID *VendorGuid,\r | |
732 | IN BOOLEAN Volatile,\r | |
733 | IN BOOLEAN Read,\r | |
734 | IN BOOLEAN Write,\r | |
735 | IN BOOLEAN Delete,\r | |
8d53adbe MK |
736 | IN BOOLEAN Cache,\r |
737 | IN OUT VARIABLE_INFO_ENTRY **VariableInfo\r | |
20a27a64 MK |
738 | )\r |
739 | {\r | |
1436aea4 | 740 | VARIABLE_INFO_ENTRY *Entry;\r |
20a27a64 MK |
741 | \r |
742 | if (FeaturePcdGet (PcdVariableCollectStatistics)) {\r | |
1436aea4 | 743 | if ((VariableName == NULL) || (VendorGuid == NULL) || (VariableInfo == NULL)) {\r |
8d53adbe MK |
744 | return;\r |
745 | }\r | |
1436aea4 | 746 | \r |
20a27a64 MK |
747 | if (AtRuntime ()) {\r |
748 | // Don't collect statistics at runtime.\r | |
749 | return;\r | |
750 | }\r | |
751 | \r | |
8d53adbe | 752 | if (*VariableInfo == NULL) {\r |
20a27a64 MK |
753 | //\r |
754 | // On the first call allocate a entry and place a pointer to it in\r | |
755 | // the EFI System Table.\r | |
756 | //\r | |
8d53adbe MK |
757 | *VariableInfo = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));\r |
758 | ASSERT (*VariableInfo != NULL);\r | |
759 | \r | |
760 | CopyGuid (&(*VariableInfo)->VendorGuid, VendorGuid);\r | |
761 | (*VariableInfo)->Name = AllocateZeroPool (StrSize (VariableName));\r | |
762 | ASSERT ((*VariableInfo)->Name != NULL);\r | |
1436aea4 | 763 | StrCpyS ((*VariableInfo)->Name, StrSize (VariableName)/sizeof (CHAR16), VariableName);\r |
8d53adbe | 764 | (*VariableInfo)->Volatile = Volatile;\r |
20a27a64 MK |
765 | }\r |
766 | \r | |
8d53adbe | 767 | for (Entry = (*VariableInfo); Entry != NULL; Entry = Entry->Next) {\r |
20a27a64 MK |
768 | if (CompareGuid (VendorGuid, &Entry->VendorGuid)) {\r |
769 | if (StrCmp (VariableName, Entry->Name) == 0) {\r | |
770 | if (Read) {\r | |
771 | Entry->ReadCount++;\r | |
772 | }\r | |
1436aea4 | 773 | \r |
20a27a64 MK |
774 | if (Write) {\r |
775 | Entry->WriteCount++;\r | |
776 | }\r | |
1436aea4 | 777 | \r |
20a27a64 MK |
778 | if (Delete) {\r |
779 | Entry->DeleteCount++;\r | |
780 | }\r | |
1436aea4 | 781 | \r |
20a27a64 MK |
782 | if (Cache) {\r |
783 | Entry->CacheCount++;\r | |
784 | }\r | |
785 | \r | |
786 | return;\r | |
787 | }\r | |
788 | }\r | |
789 | \r | |
790 | if (Entry->Next == NULL) {\r | |
791 | //\r | |
792 | // If the entry is not in the table add it.\r | |
793 | // Next iteration of the loop will fill in the data.\r | |
794 | //\r | |
795 | Entry->Next = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));\r | |
796 | ASSERT (Entry->Next != NULL);\r | |
797 | \r | |
798 | CopyGuid (&Entry->Next->VendorGuid, VendorGuid);\r | |
799 | Entry->Next->Name = AllocateZeroPool (StrSize (VariableName));\r | |
800 | ASSERT (Entry->Next->Name != NULL);\r | |
1436aea4 | 801 | StrCpyS (Entry->Next->Name, StrSize (VariableName)/sizeof (CHAR16), VariableName);\r |
20a27a64 MK |
802 | Entry->Next->Volatile = Volatile;\r |
803 | }\r | |
20a27a64 MK |
804 | }\r |
805 | }\r | |
806 | }\r |