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