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