Calculate enough space for 2 variables (public key and variable data) instead of...
[mirror_edk2.git] / SecurityPkg / VariableAuthenticated / RuntimeDxe / Variable.c
CommitLineData
0c18794e 1/** @file\r
021a1af9 2 The common variable operation routines shared by DXE_RUNTIME variable\r
0c18794e 3 module and DXE_SMM variable module.\r
4\r
dc204d5a
JY
5 Caution: This module requires additional review when modified.\r
6 This driver will have external input - variable data. They may be input in SMM mode.\r
7 This external input must be validated carefully to avoid security issue like\r
8 buffer overflow, integer overflow.\r
9\r
10 VariableServiceGetNextVariableName () and VariableServiceQueryVariableInfo() are external API.\r
11 They need check input parameter.\r
12\r
13 VariableServiceGetVariable() and VariableServiceSetVariable() are external API\r
14 to receive datasize and data buffer. The size should be checked carefully.\r
15\r
16 VariableServiceSetVariable() should also check authenticate data to avoid buffer overflow,\r
17 integer overflow. It should also check attribute to avoid authentication bypass.\r
18\r
9bc5dabb 19Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>\r
2d3fb919 20This program and the accompanying materials\r
21are licensed and made available under the terms and conditions of the BSD License\r
22which accompanies this distribution. The full text of the license may be found at\r
0c18794e 23http://opensource.org/licenses/bsd-license.php\r
24\r
2d3fb919 25THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
0c18794e 26WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
27\r
28**/\r
29\r
30#include "Variable.h"\r
31#include "AuthService.h"\r
32\r
33VARIABLE_MODULE_GLOBAL *mVariableModuleGlobal;\r
34\r
35///\r
36/// Define a memory cache that improves the search performance for a variable.\r
37///\r
6ab9f441 38VARIABLE_STORE_HEADER *mNvVariableCache = NULL;\r
0c18794e 39\r
40///\r
41/// The memory entry used for variable statistics data.\r
42///\r
6ab9f441
RN
43VARIABLE_INFO_ENTRY *gVariableInfo = NULL;\r
44\r
45///\r
46/// The list to store the variables which cannot be set after the EFI_END_OF_DXE_EVENT_GROUP_GUID\r
47/// or EVT_GROUP_READY_TO_BOOT event.\r
48///\r
49LIST_ENTRY mLockedVariableList = INITIALIZE_LIST_HEAD_VARIABLE (mLockedVariableList);\r
50\r
51///\r
52/// The flag to indicate whether the platform has left the DXE phase of execution.\r
53///\r
54BOOLEAN mEndOfDxe = FALSE;\r
55\r
56///\r
57/// The flag to indicate whether the variable storage locking is enabled.\r
58///\r
59BOOLEAN mEnableLocking = TRUE;\r
0c18794e 60\r
6675a21f
SZ
61//\r
62// To prevent name collisions with possible future globally defined variables,\r
63// other internal firmware data variables that are not defined here must be\r
64// saved with a unique VendorGuid other than EFI_GLOBAL_VARIABLE or\r
65// any other GUID defined by the UEFI Specification. Implementations must\r
66// only permit the creation of variables with a UEFI Specification-defined\r
67// VendorGuid when these variables are documented in the UEFI Specification.\r
68//\r
69GLOBAL_VARIABLE_ENTRY mGlobalVariableList[] = {\r
70 {EFI_LANG_CODES_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
71 {EFI_LANG_VARIABLE_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT},\r
72 {EFI_TIME_OUT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT},\r
73 {EFI_PLATFORM_LANG_CODES_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
74 {EFI_PLATFORM_LANG_VARIABLE_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT},\r
75 {EFI_CON_IN_VARIABLE_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT},\r
76 {EFI_CON_OUT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT},\r
77 {EFI_ERR_OUT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT},\r
78 {EFI_CON_IN_DEV_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
79 {EFI_CON_OUT_DEV_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
80 {EFI_ERR_OUT_DEV_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
81 {EFI_BOOT_ORDER_VARIABLE_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT},\r
82 {EFI_BOOT_NEXT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT},\r
83 {EFI_BOOT_CURRENT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
84 {EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
85 {EFI_DRIVER_ORDER_VARIABLE_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT},\r
86 {EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT},\r
87 {EFI_SETUP_MODE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
88 {EFI_KEY_EXCHANGE_KEY_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT_AT},\r
89 {EFI_PLATFORM_KEY_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT_AT},\r
90 {EFI_SIGNATURE_SUPPORT_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
91 {EFI_SECURE_BOOT_MODE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
92 {EFI_KEK_DEFAULT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
93 {EFI_PK_DEFAULT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
94 {EFI_DB_DEFAULT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
95 {EFI_DBX_DEFAULT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
96 {EFI_DBT_DEFAULT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
97 {EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
98 {EFI_OS_INDICATIONS_VARIABLE_NAME, VARIABLE_ATTRIBUTE_NV_BS_RT},\r
99 {EFI_VENDOR_KEYS_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
100};\r
101GLOBAL_VARIABLE_ENTRY mGlobalVariableList2[] = {\r
102 {L"Boot####", VARIABLE_ATTRIBUTE_NV_BS_RT},\r
103 {L"Driver####", VARIABLE_ATTRIBUTE_NV_BS_RT},\r
104 {L"Key####", VARIABLE_ATTRIBUTE_NV_BS_RT},\r
105};\r
0c18794e 106\r
c1d93242
JY
107/**\r
108\r
109 SecureBoot Hook for auth variable update.\r
110\r
111 @param[in] VariableName Name of Variable to be found.\r
112 @param[in] VendorGuid Variable vendor GUID.\r
113**/\r
114VOID\r
115EFIAPI\r
116SecureBootHook (\r
117 IN CHAR16 *VariableName,\r
118 IN EFI_GUID *VendorGuid\r
119 );\r
120\r
0c18794e 121/**\r
2d3fb919 122 Routine used to track statistical information about variable usage.\r
0c18794e 123 The data is stored in the EFI system table so it can be accessed later.\r
2d3fb919 124 VariableInfo.efi can dump out the table. Only Boot Services variable\r
0c18794e 125 accesses are tracked by this code. The PcdVariableCollectStatistics\r
2d3fb919 126 build flag controls if this feature is enabled.\r
0c18794e 127\r
2d3fb919 128 A read that hits in the cache will have Read and Cache true for\r
0c18794e 129 the transaction. Data is allocated by this routine, but never\r
130 freed.\r
131\r
132 @param[in] VariableName Name of the Variable to track.\r
133 @param[in] VendorGuid Guid of the Variable to track.\r
134 @param[in] Volatile TRUE if volatile FALSE if non-volatile.\r
135 @param[in] Read TRUE if GetVariable() was called.\r
136 @param[in] Write TRUE if SetVariable() was called.\r
137 @param[in] Delete TRUE if deleted via SetVariable().\r
138 @param[in] Cache TRUE for a cache hit.\r
139\r
140**/\r
141VOID\r
142UpdateVariableInfo (\r
143 IN CHAR16 *VariableName,\r
144 IN EFI_GUID *VendorGuid,\r
145 IN BOOLEAN Volatile,\r
146 IN BOOLEAN Read,\r
147 IN BOOLEAN Write,\r
148 IN BOOLEAN Delete,\r
149 IN BOOLEAN Cache\r
150 )\r
151{\r
152 VARIABLE_INFO_ENTRY *Entry;\r
153\r
154 if (FeaturePcdGet (PcdVariableCollectStatistics)) {\r
155\r
156 if (AtRuntime ()) {\r
157 // Don't collect statistics at runtime.\r
158 return;\r
159 }\r
160\r
161 if (gVariableInfo == NULL) {\r
162 //\r
163 // On the first call allocate a entry and place a pointer to it in\r
164 // the EFI System Table.\r
165 //\r
166 gVariableInfo = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));\r
167 ASSERT (gVariableInfo != NULL);\r
168\r
169 CopyGuid (&gVariableInfo->VendorGuid, VendorGuid);\r
170 gVariableInfo->Name = AllocatePool (StrSize (VariableName));\r
171 ASSERT (gVariableInfo->Name != NULL);\r
172 StrCpy (gVariableInfo->Name, VariableName);\r
173 gVariableInfo->Volatile = Volatile;\r
174 }\r
175\r
2d3fb919 176\r
0c18794e 177 for (Entry = gVariableInfo; Entry != NULL; Entry = Entry->Next) {\r
178 if (CompareGuid (VendorGuid, &Entry->VendorGuid)) {\r
179 if (StrCmp (VariableName, Entry->Name) == 0) {\r
180 if (Read) {\r
181 Entry->ReadCount++;\r
182 }\r
183 if (Write) {\r
184 Entry->WriteCount++;\r
185 }\r
186 if (Delete) {\r
187 Entry->DeleteCount++;\r
188 }\r
189 if (Cache) {\r
190 Entry->CacheCount++;\r
191 }\r
192\r
193 return;\r
194 }\r
195 }\r
196\r
197 if (Entry->Next == NULL) {\r
198 //\r
199 // If the entry is not in the table add it.\r
200 // Next iteration of the loop will fill in the data.\r
201 //\r
202 Entry->Next = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));\r
203 ASSERT (Entry->Next != NULL);\r
204\r
205 CopyGuid (&Entry->Next->VendorGuid, VendorGuid);\r
206 Entry->Next->Name = AllocatePool (StrSize (VariableName));\r
207 ASSERT (Entry->Next->Name != NULL);\r
208 StrCpy (Entry->Next->Name, VariableName);\r
209 Entry->Next->Volatile = Volatile;\r
210 }\r
211\r
212 }\r
213 }\r
214}\r
215\r
216\r
217/**\r
218\r
219 This code checks if variable header is valid or not.\r
220\r
221 @param Variable Pointer to the Variable Header.\r
222\r
223 @retval TRUE Variable header is valid.\r
224 @retval FALSE Variable header is not valid.\r
225\r
226**/\r
227BOOLEAN\r
228IsValidVariableHeader (\r
229 IN VARIABLE_HEADER *Variable\r
230 )\r
231{\r
232 if (Variable == NULL || Variable->StartId != VARIABLE_DATA) {\r
233 return FALSE;\r
234 }\r
235\r
236 return TRUE;\r
237}\r
238\r
239\r
240/**\r
241\r
242 This function writes data to the FWH at the correct LBA even if the LBAs\r
243 are fragmented.\r
244\r
245 @param Global Pointer to VARAIBLE_GLOBAL structure.\r
246 @param Volatile Point out the Variable is Volatile or Non-Volatile.\r
247 @param SetByIndex TRUE if target pointer is given as index.\r
248 FALSE if target pointer is absolute.\r
249 @param Fvb Pointer to the writable FVB protocol.\r
250 @param DataPtrIndex Pointer to the Data from the end of VARIABLE_STORE_HEADER\r
251 structure.\r
252 @param DataSize Size of data to be written.\r
253 @param Buffer Pointer to the buffer from which data is written.\r
254\r
255 @retval EFI_INVALID_PARAMETER Parameters not valid.\r
256 @retval EFI_SUCCESS Variable store successfully updated.\r
257\r
258**/\r
259EFI_STATUS\r
260UpdateVariableStore (\r
261 IN VARIABLE_GLOBAL *Global,\r
262 IN BOOLEAN Volatile,\r
263 IN BOOLEAN SetByIndex,\r
264 IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb,\r
265 IN UINTN DataPtrIndex,\r
266 IN UINT32 DataSize,\r
267 IN UINT8 *Buffer\r
268 )\r
269{\r
270 EFI_FV_BLOCK_MAP_ENTRY *PtrBlockMapEntry;\r
271 UINTN BlockIndex2;\r
272 UINTN LinearOffset;\r
273 UINTN CurrWriteSize;\r
274 UINTN CurrWritePtr;\r
275 UINT8 *CurrBuffer;\r
276 EFI_LBA LbaNumber;\r
277 UINTN Size;\r
278 EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
279 VARIABLE_STORE_HEADER *VolatileBase;\r
280 EFI_PHYSICAL_ADDRESS FvVolHdr;\r
281 EFI_PHYSICAL_ADDRESS DataPtr;\r
282 EFI_STATUS Status;\r
283\r
284 FwVolHeader = NULL;\r
285 DataPtr = DataPtrIndex;\r
286\r
287 //\r
288 // Check if the Data is Volatile.\r
289 //\r
290 if (!Volatile) {\r
648f98d1 291 if (Fvb == NULL) {\r
292 return EFI_INVALID_PARAMETER;\r
293 }\r
0c18794e 294 Status = Fvb->GetPhysicalAddress(Fvb, &FvVolHdr);\r
295 ASSERT_EFI_ERROR (Status);\r
296\r
297 FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) FvVolHdr);\r
298 //\r
299 // Data Pointer should point to the actual Address where data is to be\r
300 // written.\r
301 //\r
302 if (SetByIndex) {\r
303 DataPtr += mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase;\r
304 }\r
305\r
306 if ((DataPtr + DataSize) >= ((EFI_PHYSICAL_ADDRESS) (UINTN) ((UINT8 *) FwVolHeader + FwVolHeader->FvLength))) {\r
307 return EFI_INVALID_PARAMETER;\r
308 }\r
309 } else {\r
310 //\r
311 // Data Pointer should point to the actual Address where data is to be\r
312 // written.\r
313 //\r
314 VolatileBase = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase);\r
315 if (SetByIndex) {\r
316 DataPtr += mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;\r
317 }\r
318\r
319 if ((DataPtr + DataSize) >= ((UINTN) ((UINT8 *) VolatileBase + VolatileBase->Size))) {\r
320 return EFI_INVALID_PARAMETER;\r
321 }\r
2d3fb919 322\r
0c18794e 323 //\r
324 // If Volatile Variable just do a simple mem copy.\r
2d3fb919 325 //\r
0c18794e 326 CopyMem ((UINT8 *)(UINTN)DataPtr, Buffer, DataSize);\r
327 return EFI_SUCCESS;\r
328 }\r
2d3fb919 329\r
0c18794e 330 //\r
331 // If we are here we are dealing with Non-Volatile Variables.\r
332 //\r
333 LinearOffset = (UINTN) FwVolHeader;\r
334 CurrWritePtr = (UINTN) DataPtr;\r
335 CurrWriteSize = DataSize;\r
336 CurrBuffer = Buffer;\r
337 LbaNumber = 0;\r
338\r
339 if (CurrWritePtr < LinearOffset) {\r
340 return EFI_INVALID_PARAMETER;\r
341 }\r
342\r
343 for (PtrBlockMapEntry = FwVolHeader->BlockMap; PtrBlockMapEntry->NumBlocks != 0; PtrBlockMapEntry++) {\r
344 for (BlockIndex2 = 0; BlockIndex2 < PtrBlockMapEntry->NumBlocks; BlockIndex2++) {\r
345 //\r
346 // Check to see if the Variable Writes are spanning through multiple\r
347 // blocks.\r
348 //\r
349 if ((CurrWritePtr >= LinearOffset) && (CurrWritePtr < LinearOffset + PtrBlockMapEntry->Length)) {\r
350 if ((CurrWritePtr + CurrWriteSize) <= (LinearOffset + PtrBlockMapEntry->Length)) {\r
351 Status = Fvb->Write (\r
352 Fvb,\r
353 LbaNumber,\r
354 (UINTN) (CurrWritePtr - LinearOffset),\r
355 &CurrWriteSize,\r
356 CurrBuffer\r
357 );\r
358 return Status;\r
359 } else {\r
360 Size = (UINT32) (LinearOffset + PtrBlockMapEntry->Length - CurrWritePtr);\r
361 Status = Fvb->Write (\r
362 Fvb,\r
363 LbaNumber,\r
364 (UINTN) (CurrWritePtr - LinearOffset),\r
365 &Size,\r
366 CurrBuffer\r
367 );\r
368 if (EFI_ERROR (Status)) {\r
369 return Status;\r
370 }\r
371\r
372 CurrWritePtr = LinearOffset + PtrBlockMapEntry->Length;\r
373 CurrBuffer = CurrBuffer + Size;\r
374 CurrWriteSize = CurrWriteSize - Size;\r
375 }\r
376 }\r
377\r
378 LinearOffset += PtrBlockMapEntry->Length;\r
379 LbaNumber++;\r
380 }\r
381 }\r
382\r
383 return EFI_SUCCESS;\r
384}\r
385\r
386\r
387/**\r
388\r
389 This code gets the current status of Variable Store.\r
390\r
391 @param VarStoreHeader Pointer to the Variable Store Header.\r
392\r
393 @retval EfiRaw Variable store status is raw.\r
394 @retval EfiValid Variable store status is valid.\r
395 @retval EfiInvalid Variable store status is invalid.\r
396\r
397**/\r
398VARIABLE_STORE_STATUS\r
399GetVariableStoreStatus (\r
400 IN VARIABLE_STORE_HEADER *VarStoreHeader\r
401 )\r
402{\r
403 if (CompareGuid (&VarStoreHeader->Signature, &gEfiAuthenticatedVariableGuid) &&\r
404 VarStoreHeader->Format == VARIABLE_STORE_FORMATTED &&\r
405 VarStoreHeader->State == VARIABLE_STORE_HEALTHY\r
406 ) {\r
407\r
408 return EfiValid;\r
409 } else if (((UINT32 *)(&VarStoreHeader->Signature))[0] == 0xffffffff &&\r
410 ((UINT32 *)(&VarStoreHeader->Signature))[1] == 0xffffffff &&\r
411 ((UINT32 *)(&VarStoreHeader->Signature))[2] == 0xffffffff &&\r
412 ((UINT32 *)(&VarStoreHeader->Signature))[3] == 0xffffffff &&\r
413 VarStoreHeader->Size == 0xffffffff &&\r
414 VarStoreHeader->Format == 0xff &&\r
415 VarStoreHeader->State == 0xff\r
416 ) {\r
417\r
418 return EfiRaw;\r
419 } else {\r
420 return EfiInvalid;\r
421 }\r
422}\r
423\r
424\r
425/**\r
426\r
427 This code gets the size of name of variable.\r
428\r
429 @param Variable Pointer to the Variable Header.\r
430\r
431 @return UINTN Size of variable in bytes.\r
432\r
433**/\r
434UINTN\r
435NameSizeOfVariable (\r
436 IN VARIABLE_HEADER *Variable\r
437 )\r
438{\r
439 if (Variable->State == (UINT8) (-1) ||\r
440 Variable->DataSize == (UINT32) (-1) ||\r
441 Variable->NameSize == (UINT32) (-1) ||\r
442 Variable->Attributes == (UINT32) (-1)) {\r
443 return 0;\r
444 }\r
445 return (UINTN) Variable->NameSize;\r
446}\r
447\r
448/**\r
449\r
450 This code gets the size of variable data.\r
451\r
452 @param Variable Pointer to the Variable Header.\r
453\r
454 @return Size of variable in bytes.\r
455\r
456**/\r
457UINTN\r
458DataSizeOfVariable (\r
459 IN VARIABLE_HEADER *Variable\r
460 )\r
461{\r
462 if (Variable->State == (UINT8) (-1) ||\r
463 Variable->DataSize == (UINT32) (-1) ||\r
464 Variable->NameSize == (UINT32) (-1) ||\r
465 Variable->Attributes == (UINT32) (-1)) {\r
466 return 0;\r
467 }\r
468 return (UINTN) Variable->DataSize;\r
469}\r
470\r
471/**\r
472\r
473 This code gets the pointer to the variable name.\r
474\r
475 @param Variable Pointer to the Variable Header.\r
476\r
477 @return Pointer to Variable Name which is Unicode encoding.\r
478\r
479**/\r
480CHAR16 *\r
481GetVariableNamePtr (\r
482 IN VARIABLE_HEADER *Variable\r
483 )\r
484{\r
485\r
486 return (CHAR16 *) (Variable + 1);\r
487}\r
488\r
489/**\r
490\r
491 This code gets the pointer to the variable data.\r
492\r
493 @param Variable Pointer to the Variable Header.\r
494\r
495 @return Pointer to Variable Data.\r
496\r
497**/\r
498UINT8 *\r
499GetVariableDataPtr (\r
500 IN VARIABLE_HEADER *Variable\r
501 )\r
502{\r
503 UINTN Value;\r
2d3fb919 504\r
0c18794e 505 //\r
506 // Be careful about pad size for alignment.\r
507 //\r
508 Value = (UINTN) GetVariableNamePtr (Variable);\r
509 Value += NameSizeOfVariable (Variable);\r
510 Value += GET_PAD_SIZE (NameSizeOfVariable (Variable));\r
511\r
512 return (UINT8 *) Value;\r
513}\r
514\r
515\r
516/**\r
517\r
518 This code gets the pointer to the next variable header.\r
519\r
520 @param Variable Pointer to the Variable Header.\r
521\r
522 @return Pointer to next variable header.\r
523\r
524**/\r
525VARIABLE_HEADER *\r
526GetNextVariablePtr (\r
527 IN VARIABLE_HEADER *Variable\r
528 )\r
529{\r
530 UINTN Value;\r
531\r
532 if (!IsValidVariableHeader (Variable)) {\r
533 return NULL;\r
534 }\r
535\r
536 Value = (UINTN) GetVariableDataPtr (Variable);\r
537 Value += DataSizeOfVariable (Variable);\r
538 Value += GET_PAD_SIZE (DataSizeOfVariable (Variable));\r
539\r
540 //\r
541 // Be careful about pad size for alignment.\r
542 //\r
543 return (VARIABLE_HEADER *) HEADER_ALIGN (Value);\r
544}\r
545\r
546/**\r
547\r
548 Gets the pointer to the first variable header in given variable store area.\r
549\r
550 @param VarStoreHeader Pointer to the Variable Store Header.\r
551\r
552 @return Pointer to the first variable header.\r
553\r
554**/\r
555VARIABLE_HEADER *\r
556GetStartPointer (\r
557 IN VARIABLE_STORE_HEADER *VarStoreHeader\r
558 )\r
559{\r
560 //\r
561 // The end of variable store.\r
562 //\r
563 return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);\r
564}\r
565\r
566/**\r
567\r
568 Gets the pointer to the end of the variable storage area.\r
569\r
570 This function gets pointer to the end of the variable storage\r
571 area, according to the input variable store header.\r
572\r
573 @param VarStoreHeader Pointer to the Variable Store Header.\r
574\r
2d3fb919 575 @return Pointer to the end of the variable storage area.\r
0c18794e 576\r
577**/\r
578VARIABLE_HEADER *\r
579GetEndPointer (\r
580 IN VARIABLE_STORE_HEADER *VarStoreHeader\r
581 )\r
582{\r
583 //\r
584 // The end of variable store\r
585 //\r
586 return (VARIABLE_HEADER *) HEADER_ALIGN ((UINTN) VarStoreHeader + VarStoreHeader->Size);\r
587}\r
588\r
83758cdc 589/**\r
590\r
591 Check the PubKeyIndex is a valid key or not.\r
592\r
593 This function will iterate the NV storage to see if this PubKeyIndex is still referenced \r
594 by any valid count-based auth variabe.\r
595 \r
596 @param[in] PubKeyIndex Index of the public key in public key store.\r
597\r
598 @retval TRUE The PubKeyIndex is still in use.\r
599 @retval FALSE The PubKeyIndex is not referenced by any count-based auth variabe.\r
600 \r
601**/\r
602BOOLEAN\r
603IsValidPubKeyIndex (\r
604 IN UINT32 PubKeyIndex\r
605 )\r
606{\r
607 VARIABLE_HEADER *Variable;\r
608\r
609 if (PubKeyIndex > mPubKeyNumber) {\r
610 return FALSE;\r
611 }\r
612 \r
9a12e582 613 Variable = GetStartPointer ((VARIABLE_STORE_HEADER *) (UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);\r
83758cdc 614 \r
615 while (IsValidVariableHeader (Variable)) {\r
616 if ((Variable->State == VAR_ADDED || Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) && \r
617 Variable->PubKeyIndex == PubKeyIndex) {\r
618 return TRUE;\r
619 }\r
620 Variable = GetNextVariablePtr (Variable);\r
621 }\r
622 \r
623 return FALSE;\r
624}\r
0c18794e 625\r
626/**\r
627\r
83758cdc 628 Get the number of valid public key in PubKeyStore.\r
629 \r
630 @param[in] PubKeyNumber Number of the public key in public key store.\r
631\r
632 @return Number of valid public key in PubKeyStore.\r
633\r
634**/\r
635UINT32\r
636GetValidPubKeyNumber (\r
637 IN UINT32 PubKeyNumber\r
638 )\r
639{\r
640 UINT32 PubKeyIndex;\r
641 UINT32 Counter;\r
642\r
643 Counter = 0;\r
644 \r
645 for (PubKeyIndex = 1; PubKeyIndex <= PubKeyNumber; PubKeyIndex++) {\r
646 if (IsValidPubKeyIndex (PubKeyIndex)) {\r
647 Counter++;\r
648 }\r
649 }\r
650 \r
651 return Counter;\r
652}\r
653\r
654/**\r
655\r
656 Filter the useless key in public key store.\r
657\r
658 This function will find out all valid public keys in public key database, save them in new allocated \r
659 buffer NewPubKeyStore, and give the new PubKeyIndex. The caller is responsible for freeing buffer\r
660 NewPubKeyIndex and NewPubKeyStore with FreePool().\r
661\r
662 @param[in] PubKeyStore Point to the public key database.\r
663 @param[in] PubKeyNumber Number of the public key in PubKeyStore.\r
664 @param[out] NewPubKeyIndex Point to an array of new PubKeyIndex corresponds to NewPubKeyStore.\r
665 @param[out] NewPubKeyStore Saved all valid public keys in PubKeyStore.\r
666 @param[out] NewPubKeySize Buffer size of the NewPubKeyStore.\r
667 \r
668 @retval EFI_SUCCESS Trim operation is complete successfully.\r
669 @retval EFI_OUT_OF_RESOURCES No enough memory resources, or no useless key in PubKeyStore.\r
670 \r
671**/\r
672EFI_STATUS\r
673PubKeyStoreFilter (\r
674 IN UINT8 *PubKeyStore,\r
675 IN UINT32 PubKeyNumber,\r
676 OUT UINT32 **NewPubKeyIndex,\r
677 OUT UINT8 **NewPubKeyStore,\r
678 OUT UINT32 *NewPubKeySize\r
679 )\r
680{\r
681 UINT32 PubKeyIndex;\r
682 UINT32 CopiedKey;\r
683 UINT32 NewPubKeyNumber;\r
684 \r
685 NewPubKeyNumber = GetValidPubKeyNumber (PubKeyNumber);\r
686 if (NewPubKeyNumber == PubKeyNumber) {\r
687 return EFI_OUT_OF_RESOURCES;\r
688 }\r
689\r
690 if (NewPubKeyNumber != 0) {\r
691 *NewPubKeySize = NewPubKeyNumber * EFI_CERT_TYPE_RSA2048_SIZE;\r
692 } else {\r
693 *NewPubKeySize = sizeof (UINT8);\r
694 }\r
695\r
696 *NewPubKeyStore = AllocatePool (*NewPubKeySize);\r
697 if (*NewPubKeyStore == NULL) {\r
698 return EFI_OUT_OF_RESOURCES;\r
699 }\r
0c18794e 700\r
83758cdc 701 *NewPubKeyIndex = AllocateZeroPool ((PubKeyNumber + 1) * sizeof (UINT32));\r
702 if (*NewPubKeyIndex == NULL) {\r
703 FreePool (*NewPubKeyStore);\r
128ef095 704 *NewPubKeyStore = NULL;\r
83758cdc 705 return EFI_OUT_OF_RESOURCES;\r
706 }\r
0c18794e 707\r
83758cdc 708 CopiedKey = 0;\r
709 for (PubKeyIndex = 1; PubKeyIndex <= PubKeyNumber; PubKeyIndex++) {\r
710 if (IsValidPubKeyIndex (PubKeyIndex)) {\r
711 CopyMem (\r
712 *NewPubKeyStore + CopiedKey * EFI_CERT_TYPE_RSA2048_SIZE,\r
713 PubKeyStore + (PubKeyIndex - 1) * EFI_CERT_TYPE_RSA2048_SIZE,\r
714 EFI_CERT_TYPE_RSA2048_SIZE\r
715 );\r
716 (*NewPubKeyIndex)[PubKeyIndex] = ++CopiedKey;\r
717 }\r
718 }\r
719 return EFI_SUCCESS;\r
720}\r
721\r
722/**\r
723\r
724 Variable store garbage collection and reclaim operation.\r
725\r
726 If ReclaimPubKeyStore is FALSE, reclaim variable space by deleting the obsoleted varaibles.\r
727 If ReclaimPubKeyStore is TRUE, reclaim invalid key in public key database and update the PubKeyIndex\r
728 for all the count-based authenticate variable in NV storage.\r
729\r
ca5a7d87 730 @param[in] VariableBase Base address of variable store.\r
731 @param[out] LastVariableOffset Offset of last variable.\r
732 @param[in] IsVolatile The variable store is volatile or not;\r
733 if it is non-volatile, need FTW.\r
734 @param[in, out] UpdatingPtrTrack Pointer to updating variable pointer track structure.\r
7baf3c69
SZ
735 @param[in] NewVariable Pointer to new variable.\r
736 @param[in] NewVariableSize New variable size.\r
ca5a7d87 737 @param[in] ReclaimPubKeyStore Reclaim for public key database or not.\r
83758cdc 738 \r
83758cdc 739 @return EFI_SUCCESS Reclaim operation has finished successfully.\r
7baf3c69 740 @return EFI_OUT_OF_RESOURCES No enough memory resources or variable space.\r
ca5a7d87 741 @return EFI_DEVICE_ERROR The public key database doesn't exist.\r
83758cdc 742 @return Others Unexpect error happened during reclaim operation.\r
0c18794e 743\r
744**/\r
745EFI_STATUS\r
746Reclaim (\r
ca5a7d87 747 IN EFI_PHYSICAL_ADDRESS VariableBase,\r
748 OUT UINTN *LastVariableOffset,\r
749 IN BOOLEAN IsVolatile,\r
750 IN OUT VARIABLE_POINTER_TRACK *UpdatingPtrTrack,\r
7baf3c69
SZ
751 IN VARIABLE_HEADER *NewVariable,\r
752 IN UINTN NewVariableSize,\r
753 IN BOOLEAN ReclaimPubKeyStore\r
0c18794e 754 )\r
755{\r
756 VARIABLE_HEADER *Variable;\r
757 VARIABLE_HEADER *AddedVariable;\r
758 VARIABLE_HEADER *NextVariable;\r
759 VARIABLE_HEADER *NextAddedVariable;\r
760 VARIABLE_STORE_HEADER *VariableStoreHeader;\r
761 UINT8 *ValidBuffer;\r
762 UINTN MaximumBufferSize;\r
763 UINTN VariableSize;\r
0c18794e 764 UINTN NameSize;\r
765 UINT8 *CurrPtr;\r
766 VOID *Point0;\r
767 VOID *Point1;\r
768 BOOLEAN FoundAdded;\r
769 EFI_STATUS Status;\r
8f3a9e58
SZ
770 UINTN CommonVariableTotalSize;\r
771 UINTN HwErrVariableTotalSize;\r
83758cdc 772 UINT32 *NewPubKeyIndex;\r
773 UINT8 *NewPubKeyStore;\r
774 UINT32 NewPubKeySize;\r
775 VARIABLE_HEADER *PubKeyHeader;\r
23b06935 776 VARIABLE_HEADER *UpdatingVariable;\r
7baf3c69 777 VARIABLE_HEADER *UpdatingInDeletedTransition;\r
23b06935
SZ
778\r
779 UpdatingVariable = NULL;\r
7baf3c69 780 UpdatingInDeletedTransition = NULL;\r
23b06935
SZ
781 if (UpdatingPtrTrack != NULL) {\r
782 UpdatingVariable = UpdatingPtrTrack->CurrPtr;\r
7baf3c69 783 UpdatingInDeletedTransition = UpdatingPtrTrack->InDeletedTransitionPtr;\r
23b06935 784 }\r
0c18794e 785\r
786 VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) VariableBase);\r
8f3a9e58
SZ
787\r
788 CommonVariableTotalSize = 0;\r
789 HwErrVariableTotalSize = 0;\r
83758cdc 790 NewPubKeyIndex = NULL;\r
791 NewPubKeyStore = NULL;\r
792 NewPubKeySize = 0;\r
793 PubKeyHeader = NULL;\r
0c18794e 794\r
128ef095
SZ
795 if (IsVolatile) {\r
796 //\r
797 // Start Pointers for the variable.\r
798 //\r
799 Variable = GetStartPointer (VariableStoreHeader);\r
800 MaximumBufferSize = sizeof (VARIABLE_STORE_HEADER);\r
801\r
802 while (IsValidVariableHeader (Variable)) {\r
803 NextVariable = GetNextVariablePtr (Variable);\r
804 if ((Variable->State == VAR_ADDED || Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) &&\r
805 Variable != UpdatingVariable &&\r
806 Variable != UpdatingInDeletedTransition\r
807 ) {\r
808 VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r
809 MaximumBufferSize += VariableSize;\r
810 }\r
811\r
812 Variable = NextVariable;\r
0c18794e 813 }\r
814\r
128ef095
SZ
815 if (NewVariable != NULL) {\r
816 //\r
817 // Add the new variable size.\r
818 //\r
819 MaximumBufferSize += NewVariableSize;\r
820 }\r
0c18794e 821\r
7baf3c69 822 //\r
128ef095
SZ
823 // Reserve the 1 Bytes with Oxff to identify the\r
824 // end of the variable buffer.\r
7baf3c69 825 //\r
128ef095
SZ
826 MaximumBufferSize += 1;\r
827 ValidBuffer = AllocatePool (MaximumBufferSize);\r
828 if (ValidBuffer == NULL) {\r
829 return EFI_OUT_OF_RESOURCES;\r
830 }\r
831 } else {\r
832 //\r
833 // For NV variable reclaim, don't allocate pool here and just use mNvVariableCache\r
834 // as the buffer to reduce SMRAM consumption for SMM variable driver.\r
835 //\r
836 MaximumBufferSize = mNvVariableCache->Size;\r
837 ValidBuffer = (UINT8 *) mNvVariableCache;\r
0c18794e 838 }\r
839\r
840 SetMem (ValidBuffer, MaximumBufferSize, 0xff);\r
841\r
842 //\r
843 // Copy variable store header.\r
844 //\r
845 CopyMem (ValidBuffer, VariableStoreHeader, sizeof (VARIABLE_STORE_HEADER));\r
846 CurrPtr = (UINT8 *) GetStartPointer ((VARIABLE_STORE_HEADER *) ValidBuffer);\r
847\r
83758cdc 848 if (ReclaimPubKeyStore) {\r
7baf3c69 849 ASSERT (IsVolatile == FALSE);\r
83758cdc 850 //\r
851 // Trim the PubKeyStore and get new PubKeyIndex.\r
852 //\r
853 Status = PubKeyStoreFilter (\r
854 mPubKeyStore,\r
855 mPubKeyNumber,\r
856 &NewPubKeyIndex,\r
857 &NewPubKeyStore,\r
858 &NewPubKeySize\r
859 );\r
860 if (EFI_ERROR (Status)) {\r
128ef095 861 goto Done;\r
83758cdc 862 }\r
0c18794e 863\r
83758cdc 864 //\r
865 // Refresh the PubKeyIndex for all valid variables (ADDED and IN_DELETED_TRANSITION).\r
866 //\r
128ef095 867 Variable = GetStartPointer (VariableStoreHeader);\r
83758cdc 868 while (IsValidVariableHeader (Variable)) {\r
869 NextVariable = GetNextVariablePtr (Variable);\r
870 if (Variable->State == VAR_ADDED || Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
871 if ((StrCmp (GetVariableNamePtr (Variable), AUTHVAR_KEYDB_NAME) == 0) && \r
872 (CompareGuid (&Variable->VendorGuid, &gEfiAuthenticatedVariableGuid))) {\r
873 //\r
874 // Skip the public key database, it will be reinstalled later.\r
875 //\r
876 PubKeyHeader = Variable;\r
0c18794e 877 Variable = NextVariable;\r
878 continue;\r
879 }\r
83758cdc 880 \r
881 VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r
882 CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);\r
883 ((VARIABLE_HEADER*) CurrPtr)->PubKeyIndex = NewPubKeyIndex[Variable->PubKeyIndex];\r
884 CurrPtr += VariableSize;\r
7baf3c69 885 if ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
83758cdc 886 HwErrVariableTotalSize += VariableSize;\r
7baf3c69 887 } else if ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
83758cdc 888 CommonVariableTotalSize += VariableSize;\r
889 }\r
0c18794e 890 }\r
83758cdc 891 Variable = NextVariable;\r
0c18794e 892 }\r
0c18794e 893\r
83758cdc 894 //\r
895 // Reinstall the new public key database.\r
896 //\r
12cbe232 897 ASSERT (PubKeyHeader != NULL);\r
ca5a7d87 898 if (PubKeyHeader == NULL) {\r
128ef095
SZ
899 Status = EFI_DEVICE_ERROR;\r
900 goto Done;\r
ca5a7d87 901 }\r
83758cdc 902 CopyMem (CurrPtr, (UINT8*) PubKeyHeader, sizeof (VARIABLE_HEADER));\r
903 Variable = (VARIABLE_HEADER*) CurrPtr;\r
904 Variable->DataSize = NewPubKeySize;\r
905 StrCpy (GetVariableNamePtr (Variable), GetVariableNamePtr (PubKeyHeader));\r
906 CopyMem (GetVariableDataPtr (Variable), NewPubKeyStore, NewPubKeySize);\r
907 CurrPtr = (UINT8*) GetNextVariablePtr (Variable); \r
908 CommonVariableTotalSize += (UINTN) CurrPtr - (UINTN) Variable;\r
909 } else {\r
910 //\r
911 // Reinstall all ADDED variables as long as they are not identical to Updating Variable.\r
912 //\r
913 Variable = GetStartPointer (VariableStoreHeader);\r
914 while (IsValidVariableHeader (Variable)) {\r
915 NextVariable = GetNextVariablePtr (Variable);\r
7baf3c69 916 if (Variable != UpdatingVariable && Variable->State == VAR_ADDED) {\r
0c18794e 917 VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r
918 CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);\r
0c18794e 919 CurrPtr += VariableSize;\r
920 if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
8f3a9e58 921 HwErrVariableTotalSize += VariableSize;\r
0c18794e 922 } else if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
8f3a9e58 923 CommonVariableTotalSize += VariableSize;\r
0c18794e 924 }\r
925 }\r
83758cdc 926 Variable = NextVariable;\r
0c18794e 927 }\r
928\r
83758cdc 929 //\r
930 // Reinstall all in delete transition variables.\r
931 //\r
7baf3c69 932 Variable = GetStartPointer (VariableStoreHeader);\r
83758cdc 933 while (IsValidVariableHeader (Variable)) {\r
934 NextVariable = GetNextVariablePtr (Variable);\r
7baf3c69 935 if (Variable != UpdatingVariable && Variable != UpdatingInDeletedTransition && Variable->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
83758cdc 936\r
937 //\r
938 // Buffer has cached all ADDED variable.\r
939 // Per IN_DELETED variable, we have to guarantee that\r
940 // no ADDED one in previous buffer.\r
941 //\r
942\r
943 FoundAdded = FALSE;\r
944 AddedVariable = GetStartPointer ((VARIABLE_STORE_HEADER *) ValidBuffer);\r
945 while (IsValidVariableHeader (AddedVariable)) {\r
946 NextAddedVariable = GetNextVariablePtr (AddedVariable);\r
947 NameSize = NameSizeOfVariable (AddedVariable);\r
948 if (CompareGuid (&AddedVariable->VendorGuid, &Variable->VendorGuid) &&\r
949 NameSize == NameSizeOfVariable (Variable)\r
950 ) {\r
951 Point0 = (VOID *) GetVariableNamePtr (AddedVariable);\r
952 Point1 = (VOID *) GetVariableNamePtr (Variable);\r
23b06935 953 if (CompareMem (Point0, Point1, NameSize) == 0) {\r
83758cdc 954 FoundAdded = TRUE;\r
955 break;\r
956 }\r
957 }\r
958 AddedVariable = NextAddedVariable;\r
959 }\r
960 if (!FoundAdded) {\r
961 //\r
962 // Promote VAR_IN_DELETED_TRANSITION to VAR_ADDED.\r
963 //\r
964 VariableSize = (UINTN) NextVariable - (UINTN) Variable;\r
965 CopyMem (CurrPtr, (UINT8 *) Variable, VariableSize);\r
966 ((VARIABLE_HEADER *) CurrPtr)->State = VAR_ADDED;\r
967 CurrPtr += VariableSize;\r
968 if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
969 HwErrVariableTotalSize += VariableSize;\r
970 } else if ((!IsVolatile) && ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r
971 CommonVariableTotalSize += VariableSize;\r
972 }\r
973 }\r
974 }\r
975\r
976 Variable = NextVariable;\r
977 }\r
7baf3c69
SZ
978\r
979 //\r
980 // Install the new variable if it is not NULL.\r
981 //\r
982 if (NewVariable != NULL) {\r
983 if ((UINTN) (CurrPtr - ValidBuffer) + NewVariableSize > VariableStoreHeader->Size) {\r
984 //\r
985 // No enough space to store the new variable.\r
986 //\r
987 Status = EFI_OUT_OF_RESOURCES;\r
988 goto Done;\r
989 }\r
990 if (!IsVolatile) {\r
991 if ((NewVariable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
992 HwErrVariableTotalSize += NewVariableSize;\r
993 } else if ((NewVariable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
994 CommonVariableTotalSize += NewVariableSize;\r
995 }\r
996 if ((HwErrVariableTotalSize > PcdGet32 (PcdHwErrStorageSize)) ||\r
997 (CommonVariableTotalSize > VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER) - PcdGet32 (PcdHwErrStorageSize))) {\r
998 //\r
999 // No enough space to store the new variable by NV or NV+HR attribute.\r
1000 //\r
1001 Status = EFI_OUT_OF_RESOURCES;\r
1002 goto Done;\r
1003 }\r
1004 }\r
1005\r
1006 CopyMem (CurrPtr, (UINT8 *) NewVariable, NewVariableSize);\r
1007 ((VARIABLE_HEADER *) CurrPtr)->State = VAR_ADDED;\r
1008 if (UpdatingVariable != NULL) {\r
1009 UpdatingPtrTrack->CurrPtr = (VARIABLE_HEADER *)((UINTN)UpdatingPtrTrack->StartPtr + ((UINTN)CurrPtr - (UINTN)GetStartPointer ((VARIABLE_STORE_HEADER *) ValidBuffer)));\r
1010 UpdatingPtrTrack->InDeletedTransitionPtr = NULL;\r
1011 }\r
1012 CurrPtr += NewVariableSize;\r
1013 }\r
0c18794e 1014 }\r
1015\r
1016 if (IsVolatile) {\r
1017 //\r
1018 // If volatile variable store, just copy valid buffer.\r
1019 //\r
1020 SetMem ((UINT8 *) (UINTN) VariableBase, VariableStoreHeader->Size, 0xff);\r
7baf3c69 1021 CopyMem ((UINT8 *) (UINTN) VariableBase, ValidBuffer, (UINTN) (CurrPtr - ValidBuffer));\r
128ef095 1022 *LastVariableOffset = (UINTN) (CurrPtr - ValidBuffer);\r
0c18794e 1023 Status = EFI_SUCCESS;\r
1024 } else {\r
1025 //\r
1026 // If non-volatile variable store, perform FTW here.\r
1027 //\r
1028 Status = FtwVariableSpace (\r
1029 VariableBase,\r
128ef095 1030 (VARIABLE_STORE_HEADER *) ValidBuffer\r
0c18794e 1031 );\r
128ef095
SZ
1032 if (!EFI_ERROR (Status)) {\r
1033 *LastVariableOffset = (UINTN) (CurrPtr - ValidBuffer);\r
8f3a9e58
SZ
1034 mVariableModuleGlobal->HwErrVariableTotalSize = HwErrVariableTotalSize;\r
1035 mVariableModuleGlobal->CommonVariableTotalSize = CommonVariableTotalSize;\r
128ef095
SZ
1036 } else {\r
1037 NextVariable = GetStartPointer ((VARIABLE_STORE_HEADER *)(UINTN)VariableBase);\r
1038 while (IsValidVariableHeader (NextVariable)) {\r
1039 VariableSize = NextVariable->NameSize + NextVariable->DataSize + sizeof (VARIABLE_HEADER);\r
1040 if ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
1041 mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VariableSize);\r
1042 } else if ((Variable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
1043 mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VariableSize);\r
1044 }\r
8f3a9e58 1045\r
128ef095
SZ
1046 NextVariable = GetNextVariablePtr (NextVariable);\r
1047 }\r
1048 *LastVariableOffset = (UINTN) NextVariable - (UINTN) VariableBase;\r
8f3a9e58 1049 }\r
0c18794e 1050 }\r
1051\r
128ef095
SZ
1052Done:\r
1053 if (IsVolatile) {\r
1054 FreePool (ValidBuffer);\r
1055 } else {\r
1056 //\r
1057 // For NV variable reclaim, we use mNvVariableCache as the buffer, so copy the data back.\r
1058 //\r
1059 CopyMem (mNvVariableCache, (UINT8 *)(UINTN)VariableBase, VariableStoreHeader->Size);\r
83758cdc 1060\r
128ef095
SZ
1061 if (NewPubKeyStore != NULL) {\r
1062 FreePool (NewPubKeyStore);\r
1063 }\r
7baf3c69 1064\r
128ef095
SZ
1065 if (NewPubKeyIndex != NULL) {\r
1066 FreePool (NewPubKeyIndex);\r
1067 }\r
1068 }\r
0c18794e 1069\r
1070 return Status;\r
1071}\r
1072\r
9a000b46
RN
1073/**\r
1074 Find the variable in the specified variable store.\r
1075\r
ecc722ad 1076 @param[in] VariableName Name of the variable to be found\r
1077 @param[in] VendorGuid Vendor GUID to be found.\r
9622df63
SZ
1078 @param[in] IgnoreRtCheck Ignore EFI_VARIABLE_RUNTIME_ACCESS attribute\r
1079 check at runtime when searching variable.\r
ecc722ad 1080 @param[in, out] PtrTrack Variable Track Pointer structure that contains Variable Information.\r
9a000b46 1081\r
ecc722ad 1082 @retval EFI_SUCCESS Variable found successfully\r
1083 @retval EFI_NOT_FOUND Variable not found\r
9a000b46
RN
1084**/\r
1085EFI_STATUS\r
1086FindVariableEx (\r
1087 IN CHAR16 *VariableName,\r
1088 IN EFI_GUID *VendorGuid,\r
9622df63 1089 IN BOOLEAN IgnoreRtCheck,\r
9a000b46
RN
1090 IN OUT VARIABLE_POINTER_TRACK *PtrTrack\r
1091 )\r
1092{\r
1093 VARIABLE_HEADER *InDeletedVariable;\r
1094 VOID *Point;\r
1095\r
23b06935
SZ
1096 PtrTrack->InDeletedTransitionPtr = NULL;\r
1097\r
9a000b46
RN
1098 //\r
1099 // Find the variable by walk through HOB, volatile and non-volatile variable store.\r
1100 //\r
1101 InDeletedVariable = NULL;\r
1102\r
1103 for ( PtrTrack->CurrPtr = PtrTrack->StartPtr\r
1104 ; (PtrTrack->CurrPtr < PtrTrack->EndPtr) && IsValidVariableHeader (PtrTrack->CurrPtr)\r
1105 ; PtrTrack->CurrPtr = GetNextVariablePtr (PtrTrack->CurrPtr)\r
1106 ) {\r
2d3fb919 1107 if (PtrTrack->CurrPtr->State == VAR_ADDED ||\r
9a000b46
RN
1108 PtrTrack->CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)\r
1109 ) {\r
9622df63 1110 if (IgnoreRtCheck || !AtRuntime () || ((PtrTrack->CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) != 0)) {\r
9a000b46
RN
1111 if (VariableName[0] == 0) {\r
1112 if (PtrTrack->CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
1113 InDeletedVariable = PtrTrack->CurrPtr;\r
1114 } else {\r
23b06935 1115 PtrTrack->InDeletedTransitionPtr = InDeletedVariable;\r
9a000b46
RN
1116 return EFI_SUCCESS;\r
1117 }\r
1118 } else {\r
1119 if (CompareGuid (VendorGuid, &PtrTrack->CurrPtr->VendorGuid)) {\r
1120 Point = (VOID *) GetVariableNamePtr (PtrTrack->CurrPtr);\r
1121\r
1122 ASSERT (NameSizeOfVariable (PtrTrack->CurrPtr) != 0);\r
1123 if (CompareMem (VariableName, Point, NameSizeOfVariable (PtrTrack->CurrPtr)) == 0) {\r
1124 if (PtrTrack->CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
1125 InDeletedVariable = PtrTrack->CurrPtr;\r
1126 } else {\r
23b06935 1127 PtrTrack->InDeletedTransitionPtr = InDeletedVariable;\r
9a000b46
RN
1128 return EFI_SUCCESS;\r
1129 }\r
1130 }\r
1131 }\r
1132 }\r
1133 }\r
1134 }\r
1135 }\r
1136\r
1137 PtrTrack->CurrPtr = InDeletedVariable;\r
1138 return (PtrTrack->CurrPtr == NULL) ? EFI_NOT_FOUND : EFI_SUCCESS;\r
1139}\r
1140\r
0c18794e 1141\r
1142/**\r
1143 Finds variable in storage blocks of volatile and non-volatile storage areas.\r
1144\r
1145 This code finds variable in storage blocks of volatile and non-volatile storage areas.\r
1146 If VariableName is an empty string, then we just return the first\r
1147 qualified variable without comparing VariableName and VendorGuid.\r
9622df63
SZ
1148 If IgnoreRtCheck is TRUE, then we ignore the EFI_VARIABLE_RUNTIME_ACCESS attribute check\r
1149 at runtime when searching existing variable, only VariableName and VendorGuid are compared.\r
1150 Otherwise, variables without EFI_VARIABLE_RUNTIME_ACCESS are not visible at runtime.\r
0c18794e 1151\r
ecc722ad 1152 @param[in] VariableName Name of the variable to be found.\r
1153 @param[in] VendorGuid Vendor GUID to be found.\r
1154 @param[out] PtrTrack VARIABLE_POINTER_TRACK structure for output,\r
0c18794e 1155 including the range searched and the target position.\r
ecc722ad 1156 @param[in] Global Pointer to VARIABLE_GLOBAL structure, including\r
0c18794e 1157 base of volatile variable storage area, base of\r
1158 NV variable storage area, and a lock.\r
9622df63
SZ
1159 @param[in] IgnoreRtCheck Ignore EFI_VARIABLE_RUNTIME_ACCESS attribute\r
1160 check at runtime when searching variable.\r
0c18794e 1161\r
1162 @retval EFI_INVALID_PARAMETER If VariableName is not an empty string, while\r
1163 VendorGuid is NULL.\r
1164 @retval EFI_SUCCESS Variable successfully found.\r
1165 @retval EFI_NOT_FOUND Variable not found\r
1166\r
1167**/\r
1168EFI_STATUS\r
1169FindVariable (\r
1170 IN CHAR16 *VariableName,\r
1171 IN EFI_GUID *VendorGuid,\r
1172 OUT VARIABLE_POINTER_TRACK *PtrTrack,\r
ecc722ad 1173 IN VARIABLE_GLOBAL *Global,\r
9622df63 1174 IN BOOLEAN IgnoreRtCheck\r
0c18794e 1175 )\r
1176{\r
9a000b46
RN
1177 EFI_STATUS Status;\r
1178 VARIABLE_STORE_HEADER *VariableStoreHeader[VariableStoreTypeMax];\r
1179 VARIABLE_STORE_TYPE Type;\r
1180\r
1181 if (VariableName[0] != 0 && VendorGuid == NULL) {\r
1182 return EFI_INVALID_PARAMETER;\r
1183 }\r
0c18794e 1184\r
1185 //\r
9a000b46 1186 // 0: Volatile, 1: HOB, 2: Non-Volatile.\r
0c18794e 1187 // The index and attributes mapping must be kept in this order as RuntimeServiceGetNextVariableName\r
1188 // make use of this mapping to implement search algorithm.\r
1189 //\r
9a000b46
RN
1190 VariableStoreHeader[VariableStoreTypeVolatile] = (VARIABLE_STORE_HEADER *) (UINTN) Global->VolatileVariableBase;\r
1191 VariableStoreHeader[VariableStoreTypeHob] = (VARIABLE_STORE_HEADER *) (UINTN) Global->HobVariableBase;\r
1192 VariableStoreHeader[VariableStoreTypeNv] = mNvVariableCache;\r
0c18794e 1193\r
1194 //\r
9a000b46 1195 // Find the variable by walk through HOB, volatile and non-volatile variable store.\r
0c18794e 1196 //\r
9a000b46
RN
1197 for (Type = (VARIABLE_STORE_TYPE) 0; Type < VariableStoreTypeMax; Type++) {\r
1198 if (VariableStoreHeader[Type] == NULL) {\r
1199 continue;\r
1200 }\r
0c18794e 1201\r
9a000b46
RN
1202 PtrTrack->StartPtr = GetStartPointer (VariableStoreHeader[Type]);\r
1203 PtrTrack->EndPtr = GetEndPointer (VariableStoreHeader[Type]);\r
1204 PtrTrack->Volatile = (BOOLEAN) (Type == VariableStoreTypeVolatile);\r
0c18794e 1205\r
9622df63 1206 Status = FindVariableEx (VariableName, VendorGuid, IgnoreRtCheck, PtrTrack);\r
9a000b46
RN
1207 if (!EFI_ERROR (Status)) {\r
1208 return Status;\r
0c18794e 1209 }\r
1210 }\r
0c18794e 1211 return EFI_NOT_FOUND;\r
1212}\r
1213\r
1214/**\r
1215 Get index from supported language codes according to language string.\r
1216\r
1217 This code is used to get corresponding index in supported language codes. It can handle\r
1218 RFC4646 and ISO639 language tags.\r
1219 In ISO639 language tags, take 3-characters as a delimitation to find matched string and calculate the index.\r
1220 In RFC4646 language tags, take semicolon as a delimitation to find matched string and calculate the index.\r
1221\r
1222 For example:\r
1223 SupportedLang = "engfraengfra"\r
1224 Lang = "eng"\r
1225 Iso639Language = TRUE\r
1226 The return value is "0".\r
1227 Another example:\r
1228 SupportedLang = "en;fr;en-US;fr-FR"\r
1229 Lang = "fr-FR"\r
1230 Iso639Language = FALSE\r
1231 The return value is "3".\r
1232\r
1233 @param SupportedLang Platform supported language codes.\r
1234 @param Lang Configured language.\r
1235 @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646.\r
1236\r
1237 @retval The index of language in the language codes.\r
1238\r
1239**/\r
1240UINTN\r
1241GetIndexFromSupportedLangCodes(\r
1242 IN CHAR8 *SupportedLang,\r
1243 IN CHAR8 *Lang,\r
1244 IN BOOLEAN Iso639Language\r
2d3fb919 1245 )\r
0c18794e 1246{\r
1247 UINTN Index;\r
1248 UINTN CompareLength;\r
1249 UINTN LanguageLength;\r
1250\r
1251 if (Iso639Language) {\r
1252 CompareLength = ISO_639_2_ENTRY_SIZE;\r
1253 for (Index = 0; Index < AsciiStrLen (SupportedLang); Index += CompareLength) {\r
1254 if (AsciiStrnCmp (Lang, SupportedLang + Index, CompareLength) == 0) {\r
1255 //\r
1256 // Successfully find the index of Lang string in SupportedLang string.\r
1257 //\r
1258 Index = Index / CompareLength;\r
1259 return Index;\r
1260 }\r
1261 }\r
1262 ASSERT (FALSE);\r
1263 return 0;\r
1264 } else {\r
1265 //\r
1266 // Compare RFC4646 language code\r
1267 //\r
1268 Index = 0;\r
1269 for (LanguageLength = 0; Lang[LanguageLength] != '\0'; LanguageLength++);\r
1270\r
1271 for (Index = 0; *SupportedLang != '\0'; Index++, SupportedLang += CompareLength) {\r
1272 //\r
1273 // Skip ';' characters in SupportedLang\r
1274 //\r
1275 for (; *SupportedLang != '\0' && *SupportedLang == ';'; SupportedLang++);\r
1276 //\r
1277 // Determine the length of the next language code in SupportedLang\r
1278 //\r
1279 for (CompareLength = 0; SupportedLang[CompareLength] != '\0' && SupportedLang[CompareLength] != ';'; CompareLength++);\r
2d3fb919 1280\r
1281 if ((CompareLength == LanguageLength) &&\r
0c18794e 1282 (AsciiStrnCmp (Lang, SupportedLang, CompareLength) == 0)) {\r
1283 //\r
1284 // Successfully find the index of Lang string in SupportedLang string.\r
1285 //\r
1286 return Index;\r
1287 }\r
1288 }\r
1289 ASSERT (FALSE);\r
1290 return 0;\r
1291 }\r
1292}\r
1293\r
1294/**\r
1295 Get language string from supported language codes according to index.\r
1296\r
1297 This code is used to get corresponding language strings in supported language codes. It can handle\r
1298 RFC4646 and ISO639 language tags.\r
1299 In ISO639 language tags, take 3-characters as a delimitation. Find language string according to the index.\r
1300 In RFC4646 language tags, take semicolon as a delimitation. Find language string according to the index.\r
1301\r
1302 For example:\r
1303 SupportedLang = "engfraengfra"\r
1304 Index = "1"\r
1305 Iso639Language = TRUE\r
1306 The return value is "fra".\r
1307 Another example:\r
1308 SupportedLang = "en;fr;en-US;fr-FR"\r
1309 Index = "1"\r
1310 Iso639Language = FALSE\r
1311 The return value is "fr".\r
1312\r
1313 @param SupportedLang Platform supported language codes.\r
1314 @param Index The index in supported language codes.\r
1315 @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC4646.\r
1316\r
1317 @retval The language string in the language codes.\r
1318\r
1319**/\r
1320CHAR8 *\r
1321GetLangFromSupportedLangCodes (\r
1322 IN CHAR8 *SupportedLang,\r
1323 IN UINTN Index,\r
1324 IN BOOLEAN Iso639Language\r
1325)\r
1326{\r
1327 UINTN SubIndex;\r
1328 UINTN CompareLength;\r
1329 CHAR8 *Supported;\r
1330\r
1331 SubIndex = 0;\r
1332 Supported = SupportedLang;\r
1333 if (Iso639Language) {\r
1334 //\r
1335 // According to the index of Lang string in SupportedLang string to get the language.\r
1336 // This code will be invoked in RUNTIME, therefore there is not a memory allocate/free operation.\r
1337 // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.\r
1338 //\r
1339 CompareLength = ISO_639_2_ENTRY_SIZE;\r
1340 mVariableModuleGlobal->Lang[CompareLength] = '\0';\r
1341 return CopyMem (mVariableModuleGlobal->Lang, SupportedLang + Index * CompareLength, CompareLength);\r
2d3fb919 1342\r
0c18794e 1343 } else {\r
1344 while (TRUE) {\r
1345 //\r
1346 // Take semicolon as delimitation, sequentially traverse supported language codes.\r
1347 //\r
1348 for (CompareLength = 0; *Supported != ';' && *Supported != '\0'; CompareLength++) {\r
1349 Supported++;\r
1350 }\r
1351 if ((*Supported == '\0') && (SubIndex != Index)) {\r
1352 //\r
1353 // Have completed the traverse, but not find corrsponding string.\r
1354 // This case is not allowed to happen.\r
1355 //\r
1356 ASSERT(FALSE);\r
1357 return NULL;\r
1358 }\r
1359 if (SubIndex == Index) {\r
1360 //\r
1361 // According to the index of Lang string in SupportedLang string to get the language.\r
1362 // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation.\r
1363 // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.\r
1364 //\r
1365 mVariableModuleGlobal->PlatformLang[CompareLength] = '\0';\r
1366 return CopyMem (mVariableModuleGlobal->PlatformLang, Supported - CompareLength, CompareLength);\r
1367 }\r
1368 SubIndex++;\r
1369\r
1370 //\r
1371 // Skip ';' characters in Supported\r
1372 //\r
1373 for (; *Supported != '\0' && *Supported == ';'; Supported++);\r
1374 }\r
1375 }\r
1376}\r
1377\r
1378/**\r
2d3fb919 1379 Returns a pointer to an allocated buffer that contains the best matching language\r
1380 from a set of supported languages.\r
1381\r
1382 This function supports both ISO 639-2 and RFC 4646 language codes, but language\r
0c18794e 1383 code types may not be mixed in a single call to this function. This function\r
1384 supports a variable argument list that allows the caller to pass in a prioritized\r
1385 list of language codes to test against all the language codes in SupportedLanguages.\r
1386\r
1387 If SupportedLanguages is NULL, then ASSERT().\r
1388\r
1389 @param[in] SupportedLanguages A pointer to a Null-terminated ASCII string that\r
2d3fb919 1390 contains a set of language codes in the format\r
0c18794e 1391 specified by Iso639Language.\r
1392 @param[in] Iso639Language If TRUE, then all language codes are assumed to be\r
1393 in ISO 639-2 format. If FALSE, then all language\r
1394 codes are assumed to be in RFC 4646 language format\r
2d3fb919 1395 @param[in] ... A variable argument list that contains pointers to\r
0c18794e 1396 Null-terminated ASCII strings that contain one or more\r
1397 language codes in the format specified by Iso639Language.\r
1398 The first language code from each of these language\r
1399 code lists is used to determine if it is an exact or\r
2d3fb919 1400 close match to any of the language codes in\r
0c18794e 1401 SupportedLanguages. Close matches only apply to RFC 4646\r
1402 language codes, and the matching algorithm from RFC 4647\r
2d3fb919 1403 is used to determine if a close match is present. If\r
0c18794e 1404 an exact or close match is found, then the matching\r
1405 language code from SupportedLanguages is returned. If\r
1406 no matches are found, then the next variable argument\r
2d3fb919 1407 parameter is evaluated. The variable argument list\r
0c18794e 1408 is terminated by a NULL.\r
1409\r
1410 @retval NULL The best matching language could not be found in SupportedLanguages.\r
2d3fb919 1411 @retval NULL There are not enough resources available to return the best matching\r
0c18794e 1412 language.\r
2d3fb919 1413 @retval Other A pointer to a Null-terminated ASCII string that is the best matching\r
0c18794e 1414 language in SupportedLanguages.\r
1415\r
1416**/\r
1417CHAR8 *\r
1418EFIAPI\r
1419VariableGetBestLanguage (\r
2d3fb919 1420 IN CONST CHAR8 *SupportedLanguages,\r
0c18794e 1421 IN BOOLEAN Iso639Language,\r
1422 ...\r
1423 )\r
1424{\r
1425 VA_LIST Args;\r
1426 CHAR8 *Language;\r
1427 UINTN CompareLength;\r
1428 UINTN LanguageLength;\r
1429 CONST CHAR8 *Supported;\r
1430 CHAR8 *Buffer;\r
1431\r
648f98d1 1432 if (SupportedLanguages == NULL) {\r
1433 return NULL;\r
1434 }\r
0c18794e 1435\r
1436 VA_START (Args, Iso639Language);\r
1437 while ((Language = VA_ARG (Args, CHAR8 *)) != NULL) {\r
1438 //\r
1439 // Default to ISO 639-2 mode\r
1440 //\r
1441 CompareLength = 3;\r
1442 LanguageLength = MIN (3, AsciiStrLen (Language));\r
1443\r
1444 //\r
1445 // If in RFC 4646 mode, then determine the length of the first RFC 4646 language code in Language\r
1446 //\r
1447 if (!Iso639Language) {\r
1448 for (LanguageLength = 0; Language[LanguageLength] != 0 && Language[LanguageLength] != ';'; LanguageLength++);\r
1449 }\r
1450\r
1451 //\r
1452 // Trim back the length of Language used until it is empty\r
1453 //\r
1454 while (LanguageLength > 0) {\r
1455 //\r
1456 // Loop through all language codes in SupportedLanguages\r
1457 //\r
1458 for (Supported = SupportedLanguages; *Supported != '\0'; Supported += CompareLength) {\r
1459 //\r
1460 // In RFC 4646 mode, then Loop through all language codes in SupportedLanguages\r
1461 //\r
1462 if (!Iso639Language) {\r
1463 //\r
1464 // Skip ';' characters in Supported\r
1465 //\r
1466 for (; *Supported != '\0' && *Supported == ';'; Supported++);\r
1467 //\r
1468 // Determine the length of the next language code in Supported\r
1469 //\r
1470 for (CompareLength = 0; Supported[CompareLength] != 0 && Supported[CompareLength] != ';'; CompareLength++);\r
1471 //\r
1472 // If Language is longer than the Supported, then skip to the next language\r
1473 //\r
1474 if (LanguageLength > CompareLength) {\r
1475 continue;\r
1476 }\r
1477 }\r
1478 //\r
1479 // See if the first LanguageLength characters in Supported match Language\r
1480 //\r
1481 if (AsciiStrnCmp (Supported, Language, LanguageLength) == 0) {\r
1482 VA_END (Args);\r
1483\r
1484 Buffer = Iso639Language ? mVariableModuleGlobal->Lang : mVariableModuleGlobal->PlatformLang;\r
1485 Buffer[CompareLength] = '\0';\r
1486 return CopyMem (Buffer, Supported, CompareLength);\r
1487 }\r
1488 }\r
1489\r
1490 if (Iso639Language) {\r
1491 //\r
1492 // If ISO 639 mode, then each language can only be tested once\r
1493 //\r
1494 LanguageLength = 0;\r
1495 } else {\r
1496 //\r
2d3fb919 1497 // If RFC 4646 mode, then trim Language from the right to the next '-' character\r
0c18794e 1498 //\r
1499 for (LanguageLength--; LanguageLength > 0 && Language[LanguageLength] != '-'; LanguageLength--);\r
1500 }\r
1501 }\r
1502 }\r
1503 VA_END (Args);\r
1504\r
1505 //\r
2d3fb919 1506 // No matches were found\r
0c18794e 1507 //\r
1508 return NULL;\r
1509}\r
1510\r
b2bd493e
SZ
1511/**\r
1512 This function is to check if the remaining variable space is enough to set\r
1513 all Variables from argument list successfully. The purpose of the check\r
1514 is to keep the consistency of the Variables to be in variable storage.\r
1515\r
1516 Note: Variables are assumed to be in same storage.\r
1517 The set sequence of Variables will be same with the sequence of VariableEntry from argument list,\r
1518 so follow the argument sequence to check the Variables.\r
1519\r
1520 @param[in] Attributes Variable attributes for Variable entries.\r
9a12e582
DG
1521 @param ... The variable argument list with type VARIABLE_ENTRY_CONSISTENCY *.\r
1522 A NULL terminates the list. The VariableSize of \r
1523 VARIABLE_ENTRY_CONSISTENCY is the variable data size as input.\r
1524 It will be changed to variable total size as output.\r
b2bd493e
SZ
1525\r
1526 @retval TRUE Have enough variable space to set the Variables successfully.\r
1527 @retval FALSE No enough variable space to set the Variables successfully.\r
1528\r
1529**/\r
1530BOOLEAN\r
1531EFIAPI\r
1532CheckRemainingSpaceForConsistency (\r
1533 IN UINT32 Attributes,\r
1534 ...\r
1535 )\r
1536{\r
1537 EFI_STATUS Status;\r
1538 VA_LIST Args;\r
1539 VARIABLE_ENTRY_CONSISTENCY *VariableEntry;\r
1540 UINT64 MaximumVariableStorageSize;\r
1541 UINT64 RemainingVariableStorageSize;\r
1542 UINT64 MaximumVariableSize;\r
1543 UINTN TotalNeededSize;\r
1544 UINTN OriginalVarSize;\r
1545 VARIABLE_STORE_HEADER *VariableStoreHeader;\r
1546 VARIABLE_POINTER_TRACK VariablePtrTrack;\r
1547 VARIABLE_HEADER *NextVariable;\r
9a12e582
DG
1548 UINTN VarNameSize;\r
1549 UINTN VarDataSize;\r
b2bd493e
SZ
1550\r
1551 //\r
1552 // Non-Volatile related.\r
1553 //\r
1554 VariableStoreHeader = mNvVariableCache;\r
1555\r
1556 Status = VariableServiceQueryVariableInfoInternal (\r
1557 Attributes,\r
1558 &MaximumVariableStorageSize,\r
1559 &RemainingVariableStorageSize,\r
1560 &MaximumVariableSize\r
1561 );\r
1562 ASSERT_EFI_ERROR (Status);\r
1563\r
1564 TotalNeededSize = 0;\r
1565 VA_START (Args, Attributes);\r
1566 VariableEntry = VA_ARG (Args, VARIABLE_ENTRY_CONSISTENCY *);\r
1567 while (VariableEntry != NULL) {\r
9a12e582
DG
1568 //\r
1569 // Calculate variable total size.\r
1570 //\r
1571 VarNameSize = StrSize (VariableEntry->Name);\r
1572 VarNameSize += GET_PAD_SIZE (VarNameSize);\r
1573 VarDataSize = VariableEntry->VariableSize;\r
1574 VarDataSize += GET_PAD_SIZE (VarDataSize);\r
1575 VariableEntry->VariableSize = HEADER_ALIGN (sizeof (VARIABLE_HEADER) + VarNameSize + VarDataSize);\r
1576\r
b2bd493e
SZ
1577 TotalNeededSize += VariableEntry->VariableSize;\r
1578 VariableEntry = VA_ARG (Args, VARIABLE_ENTRY_CONSISTENCY *);\r
1579 }\r
1580 VA_END (Args);\r
1581\r
1582 if (RemainingVariableStorageSize >= TotalNeededSize) {\r
1583 //\r
1584 // Already have enough space.\r
1585 //\r
1586 return TRUE;\r
1587 } else if (AtRuntime ()) {\r
1588 //\r
1589 // At runtime, no reclaim.\r
1590 // The original variable space of Variables can't be reused.\r
1591 //\r
1592 return FALSE;\r
1593 }\r
1594\r
1595 VA_START (Args, Attributes);\r
1596 VariableEntry = VA_ARG (Args, VARIABLE_ENTRY_CONSISTENCY *);\r
1597 while (VariableEntry != NULL) {\r
1598 //\r
1599 // Check if Variable[Index] has been present and get its size.\r
1600 //\r
1601 OriginalVarSize = 0;\r
1602 VariablePtrTrack.StartPtr = GetStartPointer (VariableStoreHeader);\r
1603 VariablePtrTrack.EndPtr = GetEndPointer (VariableStoreHeader);\r
1604 Status = FindVariableEx (\r
1605 VariableEntry->Name,\r
1606 VariableEntry->Guid,\r
1607 FALSE,\r
1608 &VariablePtrTrack\r
1609 );\r
1610 if (!EFI_ERROR (Status)) {\r
1611 //\r
1612 // Get size of Variable[Index].\r
1613 //\r
1614 NextVariable = GetNextVariablePtr (VariablePtrTrack.CurrPtr);\r
1615 OriginalVarSize = (UINTN) NextVariable - (UINTN) VariablePtrTrack.CurrPtr;\r
1616 //\r
1617 // Add the original size of Variable[Index] to remaining variable storage size.\r
1618 //\r
1619 RemainingVariableStorageSize += OriginalVarSize;\r
1620 }\r
1621 if (VariableEntry->VariableSize > RemainingVariableStorageSize) {\r
1622 //\r
1623 // No enough space for Variable[Index].\r
1624 //\r
1625 VA_END (Args);\r
1626 return FALSE;\r
1627 }\r
1628 //\r
1629 // Sub the (new) size of Variable[Index] from remaining variable storage size.\r
1630 //\r
1631 RemainingVariableStorageSize -= VariableEntry->VariableSize;\r
1632 VariableEntry = VA_ARG (Args, VARIABLE_ENTRY_CONSISTENCY *);\r
1633 }\r
1634 VA_END (Args);\r
1635\r
1636 return TRUE;\r
1637}\r
1638\r
0c18794e 1639/**\r
1640 Hook the operations in PlatformLangCodes, LangCodes, PlatformLang and Lang.\r
1641\r
1642 When setting Lang/LangCodes, simultaneously update PlatformLang/PlatformLangCodes.\r
1643\r
1644 According to UEFI spec, PlatformLangCodes/LangCodes are only set once in firmware initialization,\r
1645 and are read-only. Therefore, in variable driver, only store the original value for other use.\r
1646\r
1647 @param[in] VariableName Name of variable.\r
1648\r
1649 @param[in] Data Variable data.\r
1650\r
1651 @param[in] DataSize Size of data. 0 means delete.\r
1652\r
9bc5dabb
SZ
1653 @retval EFI_SUCCESS The update operation is successful or ignored.\r
1654 @retval EFI_WRITE_PROTECTED Update PlatformLangCodes/LangCodes at runtime.\r
1655 @retval EFI_OUT_OF_RESOURCES No enough variable space to do the update operation.\r
1656 @retval Others Other errors happened during the update operation.\r
1657\r
0c18794e 1658**/\r
9bc5dabb 1659EFI_STATUS\r
4d832aab 1660AutoUpdateLangVariable (\r
0c18794e 1661 IN CHAR16 *VariableName,\r
1662 IN VOID *Data,\r
1663 IN UINTN DataSize\r
1664 )\r
1665{\r
1666 EFI_STATUS Status;\r
1667 CHAR8 *BestPlatformLang;\r
1668 CHAR8 *BestLang;\r
1669 UINTN Index;\r
1670 UINT32 Attributes;\r
1671 VARIABLE_POINTER_TRACK Variable;\r
1672 BOOLEAN SetLanguageCodes;\r
b2bd493e 1673 VARIABLE_ENTRY_CONSISTENCY VariableEntry[2];\r
0c18794e 1674\r
1675 //\r
1676 // Don't do updates for delete operation\r
1677 //\r
1678 if (DataSize == 0) {\r
9bc5dabb 1679 return EFI_SUCCESS;\r
0c18794e 1680 }\r
1681\r
1682 SetLanguageCodes = FALSE;\r
1683\r
6675a21f 1684 if (StrCmp (VariableName, EFI_PLATFORM_LANG_CODES_VARIABLE_NAME) == 0) {\r
0c18794e 1685 //\r
1686 // PlatformLangCodes is a volatile variable, so it can not be updated at runtime.\r
1687 //\r
1688 if (AtRuntime ()) {\r
9bc5dabb 1689 return EFI_WRITE_PROTECTED;\r
0c18794e 1690 }\r
1691\r
1692 SetLanguageCodes = TRUE;\r
1693\r
1694 //\r
1695 // According to UEFI spec, PlatformLangCodes is only set once in firmware initialization, and is read-only\r
1696 // Therefore, in variable driver, only store the original value for other use.\r
1697 //\r
1698 if (mVariableModuleGlobal->PlatformLangCodes != NULL) {\r
1699 FreePool (mVariableModuleGlobal->PlatformLangCodes);\r
1700 }\r
1701 mVariableModuleGlobal->PlatformLangCodes = AllocateRuntimeCopyPool (DataSize, Data);\r
1702 ASSERT (mVariableModuleGlobal->PlatformLangCodes != NULL);\r
1703\r
1704 //\r
2d3fb919 1705 // PlatformLang holds a single language from PlatformLangCodes,\r
0c18794e 1706 // so the size of PlatformLangCodes is enough for the PlatformLang.\r
1707 //\r
1708 if (mVariableModuleGlobal->PlatformLang != NULL) {\r
1709 FreePool (mVariableModuleGlobal->PlatformLang);\r
1710 }\r
1711 mVariableModuleGlobal->PlatformLang = AllocateRuntimePool (DataSize);\r
1712 ASSERT (mVariableModuleGlobal->PlatformLang != NULL);\r
1713\r
6675a21f 1714 } else if (StrCmp (VariableName, EFI_LANG_CODES_VARIABLE_NAME) == 0) {\r
0c18794e 1715 //\r
1716 // LangCodes is a volatile variable, so it can not be updated at runtime.\r
1717 //\r
1718 if (AtRuntime ()) {\r
9bc5dabb 1719 return EFI_WRITE_PROTECTED;\r
0c18794e 1720 }\r
1721\r
1722 SetLanguageCodes = TRUE;\r
1723\r
1724 //\r
1725 // According to UEFI spec, LangCodes is only set once in firmware initialization, and is read-only\r
1726 // Therefore, in variable driver, only store the original value for other use.\r
1727 //\r
1728 if (mVariableModuleGlobal->LangCodes != NULL) {\r
1729 FreePool (mVariableModuleGlobal->LangCodes);\r
1730 }\r
1731 mVariableModuleGlobal->LangCodes = AllocateRuntimeCopyPool (DataSize, Data);\r
1732 ASSERT (mVariableModuleGlobal->LangCodes != NULL);\r
1733 }\r
1734\r
2d3fb919 1735 if (SetLanguageCodes\r
0c18794e 1736 && (mVariableModuleGlobal->PlatformLangCodes != NULL)\r
1737 && (mVariableModuleGlobal->LangCodes != NULL)) {\r
1738 //\r
1739 // Update Lang if PlatformLang is already set\r
1740 // Update PlatformLang if Lang is already set\r
1741 //\r
6675a21f 1742 Status = FindVariable (EFI_PLATFORM_LANG_VARIABLE_NAME, &gEfiGlobalVariableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r
0c18794e 1743 if (!EFI_ERROR (Status)) {\r
1744 //\r
1745 // Update Lang\r
1746 //\r
6675a21f 1747 VariableName = EFI_PLATFORM_LANG_VARIABLE_NAME;\r
0c18794e 1748 Data = GetVariableDataPtr (Variable.CurrPtr);\r
1749 DataSize = Variable.CurrPtr->DataSize;\r
1750 } else {\r
6675a21f 1751 Status = FindVariable (EFI_LANG_VARIABLE_NAME, &gEfiGlobalVariableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r
0c18794e 1752 if (!EFI_ERROR (Status)) {\r
1753 //\r
1754 // Update PlatformLang\r
1755 //\r
6675a21f 1756 VariableName = EFI_LANG_VARIABLE_NAME;\r
0c18794e 1757 Data = GetVariableDataPtr (Variable.CurrPtr);\r
1758 DataSize = Variable.CurrPtr->DataSize;\r
1759 } else {\r
1760 //\r
1761 // Neither PlatformLang nor Lang is set, directly return\r
1762 //\r
9bc5dabb 1763 return EFI_SUCCESS;\r
0c18794e 1764 }\r
1765 }\r
1766 }\r
2d3fb919 1767\r
9bc5dabb
SZ
1768 Status = EFI_SUCCESS;\r
1769\r
0c18794e 1770 //\r
1771 // According to UEFI spec, "Lang" and "PlatformLang" is NV|BS|RT attributions.\r
1772 //\r
1773 Attributes = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS;\r
1774\r
6675a21f 1775 if (StrCmp (VariableName, EFI_PLATFORM_LANG_VARIABLE_NAME) == 0) {\r
0c18794e 1776 //\r
1777 // Update Lang when PlatformLangCodes/LangCodes were set.\r
1778 //\r
1779 if ((mVariableModuleGlobal->PlatformLangCodes != NULL) && (mVariableModuleGlobal->LangCodes != NULL)) {\r
1780 //\r
1781 // When setting PlatformLang, firstly get most matched language string from supported language codes.\r
1782 //\r
1783 BestPlatformLang = VariableGetBestLanguage (mVariableModuleGlobal->PlatformLangCodes, FALSE, Data, NULL);\r
1784 if (BestPlatformLang != NULL) {\r
1785 //\r
1786 // Get the corresponding index in language codes.\r
1787 //\r
1788 Index = GetIndexFromSupportedLangCodes (mVariableModuleGlobal->PlatformLangCodes, BestPlatformLang, FALSE);\r
1789\r
1790 //\r
1791 // Get the corresponding ISO639 language tag according to RFC4646 language tag.\r
1792 //\r
1793 BestLang = GetLangFromSupportedLangCodes (mVariableModuleGlobal->LangCodes, Index, TRUE);\r
1794\r
1795 //\r
9a12e582 1796 // Check the variable space for both Lang and PlatformLang variable.\r
b2bd493e 1797 //\r
9a12e582 1798 VariableEntry[0].VariableSize = ISO_639_2_ENTRY_SIZE + 1;\r
b2bd493e
SZ
1799 VariableEntry[0].Guid = &gEfiGlobalVariableGuid;\r
1800 VariableEntry[0].Name = EFI_LANG_VARIABLE_NAME;\r
9a12e582
DG
1801 \r
1802 VariableEntry[1].VariableSize = AsciiStrSize (BestPlatformLang);\r
b2bd493e
SZ
1803 VariableEntry[1].Guid = &gEfiGlobalVariableGuid;\r
1804 VariableEntry[1].Name = EFI_PLATFORM_LANG_VARIABLE_NAME;\r
1805 if (!CheckRemainingSpaceForConsistency (VARIABLE_ATTRIBUTE_NV_BS_RT, &VariableEntry[0], &VariableEntry[1], NULL)) {\r
1806 //\r
1807 // No enough variable space to set both Lang and PlatformLang successfully.\r
1808 //\r
1809 Status = EFI_OUT_OF_RESOURCES;\r
1810 } else {\r
1811 //\r
1812 // Successfully convert PlatformLang to Lang, and set the BestLang value into Lang variable simultaneously.\r
1813 //\r
1814 FindVariable (EFI_LANG_VARIABLE_NAME, &gEfiGlobalVariableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r
0c18794e 1815\r
b2bd493e
SZ
1816 Status = UpdateVariable (EFI_LANG_VARIABLE_NAME, &gEfiGlobalVariableGuid, BestLang,\r
1817 ISO_639_2_ENTRY_SIZE + 1, Attributes, 0, 0, &Variable, NULL);\r
1818 }\r
0c18794e 1819\r
9bc5dabb 1820 DEBUG ((EFI_D_INFO, "Variable Driver Auto Update PlatformLang, PlatformLang:%a, Lang:%a Status: %r\n", BestPlatformLang, BestLang, Status));\r
0c18794e 1821 }\r
1822 }\r
1823\r
6675a21f 1824 } else if (StrCmp (VariableName, EFI_LANG_VARIABLE_NAME) == 0) {\r
0c18794e 1825 //\r
1826 // Update PlatformLang when PlatformLangCodes/LangCodes were set.\r
1827 //\r
1828 if ((mVariableModuleGlobal->PlatformLangCodes != NULL) && (mVariableModuleGlobal->LangCodes != NULL)) {\r
1829 //\r
1830 // When setting Lang, firstly get most matched language string from supported language codes.\r
1831 //\r
1832 BestLang = VariableGetBestLanguage (mVariableModuleGlobal->LangCodes, TRUE, Data, NULL);\r
1833 if (BestLang != NULL) {\r
1834 //\r
1835 // Get the corresponding index in language codes.\r
1836 //\r
1837 Index = GetIndexFromSupportedLangCodes (mVariableModuleGlobal->LangCodes, BestLang, TRUE);\r
1838\r
1839 //\r
1840 // Get the corresponding RFC4646 language tag according to ISO639 language tag.\r
1841 //\r
1842 BestPlatformLang = GetLangFromSupportedLangCodes (mVariableModuleGlobal->PlatformLangCodes, Index, FALSE);\r
1843\r
1844 //\r
9a12e582 1845 // Check the variable space for both PlatformLang and Lang variable.\r
0c18794e 1846 //\r
9a12e582 1847 VariableEntry[0].VariableSize = AsciiStrSize (BestPlatformLang);\r
b2bd493e
SZ
1848 VariableEntry[0].Guid = &gEfiGlobalVariableGuid;\r
1849 VariableEntry[0].Name = EFI_PLATFORM_LANG_VARIABLE_NAME;\r
9a12e582
DG
1850\r
1851 VariableEntry[1].VariableSize = ISO_639_2_ENTRY_SIZE + 1;\r
b2bd493e
SZ
1852 VariableEntry[1].Guid = &gEfiGlobalVariableGuid;\r
1853 VariableEntry[1].Name = EFI_LANG_VARIABLE_NAME;\r
1854 if (!CheckRemainingSpaceForConsistency (VARIABLE_ATTRIBUTE_NV_BS_RT, &VariableEntry[0], &VariableEntry[1], NULL)) {\r
1855 //\r
1856 // No enough variable space to set both PlatformLang and Lang successfully.\r
1857 //\r
1858 Status = EFI_OUT_OF_RESOURCES;\r
1859 } else {\r
1860 //\r
1861 // Successfully convert Lang to PlatformLang, and set the BestPlatformLang value into PlatformLang variable simultaneously.\r
1862 //\r
1863 FindVariable (EFI_PLATFORM_LANG_VARIABLE_NAME, &gEfiGlobalVariableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r
0c18794e 1864\r
b2bd493e
SZ
1865 Status = UpdateVariable (EFI_PLATFORM_LANG_VARIABLE_NAME, &gEfiGlobalVariableGuid, BestPlatformLang,\r
1866 AsciiStrSize (BestPlatformLang), Attributes, 0, 0, &Variable, NULL);\r
1867 }\r
0c18794e 1868\r
9bc5dabb 1869 DEBUG ((EFI_D_INFO, "Variable Driver Auto Update Lang, Lang:%a, PlatformLang:%a Status: %r\n", BestLang, BestPlatformLang, Status));\r
0c18794e 1870 }\r
1871 }\r
1872 }\r
9bc5dabb 1873\r
b2bd493e
SZ
1874 if (SetLanguageCodes) {\r
1875 //\r
1876 // Continue to set PlatformLangCodes or LangCodes.\r
1877 //\r
1878 return EFI_SUCCESS;\r
1879 } else {\r
1880 return Status;\r
1881 }\r
0c18794e 1882}\r
1883\r
1884/**\r
1885 Update the variable region with Variable information. If EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS is set,\r
1886 index of associated public key is needed.\r
1887\r
1888 @param[in] VariableName Name of variable.\r
1889 @param[in] VendorGuid Guid of variable.\r
1890 @param[in] Data Variable data.\r
1891 @param[in] DataSize Size of data. 0 means delete.\r
1892 @param[in] Attributes Attributes of the variable.\r
1893 @param[in] KeyIndex Index of associated public key.\r
1894 @param[in] MonotonicCount Value of associated monotonic count.\r
23b06935 1895 @param[in, out] CacheVariable The variable information which is used to keep track of variable usage.\r
0c18794e 1896 @param[in] TimeStamp Value of associated TimeStamp.\r
2d3fb919 1897\r
0c18794e 1898 @retval EFI_SUCCESS The update operation is success.\r
1899 @retval EFI_OUT_OF_RESOURCES Variable region is full, can not write other data into this region.\r
1900\r
1901**/\r
1902EFI_STATUS\r
1903UpdateVariable (\r
1904 IN CHAR16 *VariableName,\r
1905 IN EFI_GUID *VendorGuid,\r
1906 IN VOID *Data,\r
1907 IN UINTN DataSize,\r
1908 IN UINT32 Attributes OPTIONAL,\r
1909 IN UINT32 KeyIndex OPTIONAL,\r
1910 IN UINT64 MonotonicCount OPTIONAL,\r
23b06935 1911 IN OUT VARIABLE_POINTER_TRACK *CacheVariable,\r
0c18794e 1912 IN EFI_TIME *TimeStamp OPTIONAL\r
1913 )\r
1914{\r
1915 EFI_STATUS Status;\r
1916 VARIABLE_HEADER *NextVariable;\r
1917 UINTN ScratchSize;\r
732d199d 1918 UINTN MaxDataSize;\r
0c18794e 1919 UINTN NonVolatileVarableStoreSize;\r
1920 UINTN VarNameOffset;\r
1921 UINTN VarDataOffset;\r
1922 UINTN VarNameSize;\r
1923 UINTN VarSize;\r
1924 BOOLEAN Volatile;\r
1925 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;\r
1926 UINT8 State;\r
0c18794e 1927 VARIABLE_POINTER_TRACK *Variable;\r
1928 VARIABLE_POINTER_TRACK NvVariable;\r
1929 VARIABLE_STORE_HEADER *VariableStoreHeader;\r
1930 UINTN CacheOffset;\r
fddbbc66
SZ
1931 UINT8 *BufferForMerge;\r
1932 UINTN MergedBufSize;\r
1933 BOOLEAN DataReady;\r
0c18794e 1934 UINTN DataOffset;\r
0c18794e 1935\r
1936 if (mVariableModuleGlobal->FvbInstance == NULL) {\r
1937 //\r
1938 // The FVB protocol is not installed, so the EFI_VARIABLE_WRITE_ARCH_PROTOCOL is not installed.\r
1939 //\r
1940 if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {\r
1941 //\r
1942 // Trying to update NV variable prior to the installation of EFI_VARIABLE_WRITE_ARCH_PROTOCOL\r
1943 //\r
1944 return EFI_NOT_AVAILABLE_YET;\r
1945 } else if ((Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS) != 0) {\r
1946 //\r
1947 // Trying to update volatile authenticated variable prior to the installation of EFI_VARIABLE_WRITE_ARCH_PROTOCOL\r
1948 // The authenticated variable perhaps is not initialized, just return here.\r
1949 //\r
1950 return EFI_NOT_AVAILABLE_YET;\r
1951 }\r
1952 }\r
1953\r
1954 if ((CacheVariable->CurrPtr == NULL) || CacheVariable->Volatile) {\r
1955 Variable = CacheVariable;\r
1956 } else {\r
1957 //\r
1958 // Update/Delete existing NV variable.\r
1959 // CacheVariable points to the variable in the memory copy of Flash area\r
1960 // Now let Variable points to the same variable in Flash area.\r
1961 //\r
1962 VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase);\r
2d3fb919 1963 Variable = &NvVariable;\r
0c18794e 1964 Variable->StartPtr = GetStartPointer (VariableStoreHeader);\r
1965 Variable->EndPtr = GetEndPointer (VariableStoreHeader);\r
1966 Variable->CurrPtr = (VARIABLE_HEADER *)((UINTN)Variable->StartPtr + ((UINTN)CacheVariable->CurrPtr - (UINTN)CacheVariable->StartPtr));\r
23b06935
SZ
1967 if (CacheVariable->InDeletedTransitionPtr != NULL) {\r
1968 Variable->InDeletedTransitionPtr = (VARIABLE_HEADER *)((UINTN)Variable->StartPtr + ((UINTN)CacheVariable->InDeletedTransitionPtr - (UINTN)CacheVariable->StartPtr));\r
1969 } else {\r
1970 Variable->InDeletedTransitionPtr = NULL;\r
1971 }\r
0c18794e 1972 Variable->Volatile = FALSE;\r
2d3fb919 1973 }\r
0c18794e 1974\r
1975 Fvb = mVariableModuleGlobal->FvbInstance;\r
0c18794e 1976\r
1977 //\r
1978 // Tricky part: Use scratch data area at the end of volatile variable store\r
1979 // as a temporary storage.\r
1980 //\r
1981 NextVariable = GetEndPointer ((VARIABLE_STORE_HEADER *) ((UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase));\r
1982 ScratchSize = MAX (PcdGet32 (PcdMaxVariableSize), PcdGet32 (PcdMaxHardwareErrorVariableSize));\r
fddbbc66
SZ
1983 SetMem (NextVariable, ScratchSize, 0xff);\r
1984 DataReady = FALSE;\r
0c18794e 1985\r
1986 if (Variable->CurrPtr != NULL) {\r
1987 //\r
1988 // Update/Delete existing variable.\r
1989 //\r
2d3fb919 1990 if (AtRuntime ()) {\r
0c18794e 1991 //\r
2d3fb919 1992 // If AtRuntime and the variable is Volatile and Runtime Access,\r
1993 // the volatile is ReadOnly, and SetVariable should be aborted and\r
0c18794e 1994 // return EFI_WRITE_PROTECTED.\r
1995 //\r
1996 if (Variable->Volatile) {\r
1997 Status = EFI_WRITE_PROTECTED;\r
1998 goto Done;\r
1999 }\r
2000 //\r
2001 // Only variable that have NV attributes can be updated/deleted in Runtime.\r
2002 //\r
2003 if ((Variable->CurrPtr->Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) {\r
2004 Status = EFI_INVALID_PARAMETER;\r
2d3fb919 2005 goto Done;\r
0c18794e 2006 }\r
ecc722ad 2007 \r
2008 //\r
2009 // Only variable that have RT attributes can be updated/deleted in Runtime.\r
2010 //\r
2011 if ((Variable->CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0) {\r
2012 Status = EFI_INVALID_PARAMETER;\r
2013 goto Done;\r
2014 }\r
0c18794e 2015 }\r
2016\r
2017 //\r
2018 // Setting a data variable with no access, or zero DataSize attributes\r
2019 // causes it to be deleted.\r
2d3fb919 2020 // When the EFI_VARIABLE_APPEND_WRITE attribute is set, DataSize of zero will\r
2021 // not delete the variable.\r
0c18794e 2022 //\r
2d3fb919 2023 if ((((Attributes & EFI_VARIABLE_APPEND_WRITE) == 0) && (DataSize == 0))|| ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0)) {\r
23b06935
SZ
2024 if (Variable->InDeletedTransitionPtr != NULL) {\r
2025 //\r
2026 // Both ADDED and IN_DELETED_TRANSITION variable are present,\r
2027 // set IN_DELETED_TRANSITION one to DELETED state first.\r
2028 //\r
2029 State = Variable->InDeletedTransitionPtr->State;\r
2030 State &= VAR_DELETED;\r
2031 Status = UpdateVariableStore (\r
2032 &mVariableModuleGlobal->VariableGlobal,\r
2033 Variable->Volatile,\r
2034 FALSE,\r
2035 Fvb,\r
2036 (UINTN) &Variable->InDeletedTransitionPtr->State,\r
2037 sizeof (UINT8),\r
2038 &State\r
2039 );\r
2040 if (!EFI_ERROR (Status)) {\r
2041 if (!Variable->Volatile) {\r
0cc565de 2042 ASSERT (CacheVariable->InDeletedTransitionPtr != NULL);\r
23b06935
SZ
2043 CacheVariable->InDeletedTransitionPtr->State = State;\r
2044 }\r
2045 } else {\r
2046 goto Done;\r
2047 }\r
2048 }\r
2049\r
0c18794e 2050 State = Variable->CurrPtr->State;\r
2051 State &= VAR_DELETED;\r
2052\r
2053 Status = UpdateVariableStore (\r
2054 &mVariableModuleGlobal->VariableGlobal,\r
2055 Variable->Volatile,\r
2056 FALSE,\r
2057 Fvb,\r
2058 (UINTN) &Variable->CurrPtr->State,\r
2059 sizeof (UINT8),\r
2060 &State\r
2d3fb919 2061 );\r
0c18794e 2062 if (!EFI_ERROR (Status)) {\r
2063 UpdateVariableInfo (VariableName, VendorGuid, Variable->Volatile, FALSE, FALSE, TRUE, FALSE);\r
2064 if (!Variable->Volatile) {\r
2065 CacheVariable->CurrPtr->State = State;\r
335e2681 2066 FlushHobVariableToFlash (VariableName, VendorGuid);\r
0c18794e 2067 }\r
2068 }\r
2d3fb919 2069 goto Done;\r
0c18794e 2070 }\r
2071 //\r
2072 // If the variable is marked valid, and the same data has been passed in,\r
2073 // then return to the caller immediately.\r
2074 //\r
2075 if (DataSizeOfVariable (Variable->CurrPtr) == DataSize &&\r
fddbbc66 2076 (CompareMem (Data, GetVariableDataPtr (Variable->CurrPtr), DataSize) == 0) &&\r
2d3fb919 2077 ((Attributes & EFI_VARIABLE_APPEND_WRITE) == 0) &&\r
2078 (TimeStamp == NULL)) {\r
2079 //\r
2080 // Variable content unchanged and no need to update timestamp, just return.\r
2081 //\r
0c18794e 2082 UpdateVariableInfo (VariableName, VendorGuid, Variable->Volatile, FALSE, TRUE, FALSE, FALSE);\r
2083 Status = EFI_SUCCESS;\r
2084 goto Done;\r
2085 } else if ((Variable->CurrPtr->State == VAR_ADDED) ||\r
2086 (Variable->CurrPtr->State == (VAR_ADDED & VAR_IN_DELETED_TRANSITION))) {\r
2087\r
2088 //\r
2089 // EFI_VARIABLE_APPEND_WRITE attribute only effects for existing variable\r
2090 //\r
2091 if ((Attributes & EFI_VARIABLE_APPEND_WRITE) != 0) {\r
2d3fb919 2092 //\r
fddbbc66
SZ
2093 // NOTE: From 0 to DataOffset of NextVariable is reserved for Variable Header and Name.\r
2094 // From DataOffset of NextVariable is to save the existing variable data.\r
2d3fb919 2095 //\r
2096 DataOffset = sizeof (VARIABLE_HEADER) + Variable->CurrPtr->NameSize + GET_PAD_SIZE (Variable->CurrPtr->NameSize);\r
fddbbc66
SZ
2097 BufferForMerge = (UINT8 *) ((UINTN) NextVariable + DataOffset);\r
2098 CopyMem (BufferForMerge, (UINT8 *) ((UINTN) Variable->CurrPtr + DataOffset), Variable->CurrPtr->DataSize);\r
2d3fb919 2099\r
732d199d 2100 //\r
2101 // Set Max Common Variable Data Size as default MaxDataSize \r
2102 //\r
fddbbc66 2103 MaxDataSize = PcdGet32 (PcdMaxVariableSize) - DataOffset;\r
732d199d 2104\r
5767f22f 2105 if ((CompareGuid (VendorGuid, &gEfiImageSecurityDatabaseGuid) &&\r
2106 ((StrCmp (VariableName, EFI_IMAGE_SECURITY_DATABASE) == 0) || (StrCmp (VariableName, EFI_IMAGE_SECURITY_DATABASE1) == 0))) ||\r
2107 (CompareGuid (VendorGuid, &gEfiGlobalVariableGuid) && (StrCmp (VariableName, EFI_KEY_EXCHANGE_KEY_NAME) == 0))) {\r
2d3fb919 2108 //\r
5767f22f 2109 // For variables with formatted as EFI_SIGNATURE_LIST, the driver shall not perform an append of\r
2d3fb919 2110 // EFI_SIGNATURE_DATA values that are already part of the existing variable value.\r
2111 //\r
732d199d 2112 Status = AppendSignatureList (\r
fddbbc66 2113 BufferForMerge,\r
732d199d 2114 Variable->CurrPtr->DataSize, \r
2115 MaxDataSize - Variable->CurrPtr->DataSize,\r
fddbbc66
SZ
2116 Data,\r
2117 DataSize,\r
2118 &MergedBufSize\r
732d199d 2119 );\r
2120 if (Status == EFI_BUFFER_TOO_SMALL) {\r
2121 //\r
fddbbc66 2122 // Signature List is too long, Failed to Append.\r
732d199d 2123 //\r
2124 Status = EFI_INVALID_PARAMETER;\r
2125 goto Done;\r
2126 }\r
2127\r
fddbbc66 2128 if (MergedBufSize == Variable->CurrPtr->DataSize) {\r
2d3fb919 2129 if ((TimeStamp == NULL) || CompareTimeStamp (TimeStamp, &Variable->CurrPtr->TimeStamp)) {\r
2130 //\r
2131 // New EFI_SIGNATURE_DATA is not found and timestamp is not later\r
2132 // than current timestamp, return EFI_SUCCESS directly.\r
2133 //\r
2134 UpdateVariableInfo (VariableName, VendorGuid, Variable->Volatile, FALSE, TRUE, FALSE, FALSE);\r
2135 Status = EFI_SUCCESS;\r
2136 goto Done;\r
2137 }\r
2138 }\r
2139 } else {\r
2140 //\r
fddbbc66 2141 // For other Variables, append the new data to the end of existing data.\r
732d199d 2142 // Max Harware error record variable data size is different from common variable\r
2d3fb919 2143 //\r
732d199d 2144 if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
fddbbc66 2145 MaxDataSize = PcdGet32 (PcdMaxHardwareErrorVariableSize) - DataOffset;\r
732d199d 2146 }\r
2147\r
2148 if (Variable->CurrPtr->DataSize + DataSize > MaxDataSize) {\r
2149 //\r
fddbbc66 2150 // Existing data size + new data size exceed maximum variable size limitation.\r
732d199d 2151 //\r
2152 Status = EFI_INVALID_PARAMETER;\r
2153 goto Done;\r
2154 }\r
fddbbc66
SZ
2155 CopyMem ((UINT8*) ((UINTN) BufferForMerge + Variable->CurrPtr->DataSize), Data, DataSize);\r
2156 MergedBufSize = Variable->CurrPtr->DataSize + DataSize;\r
2d3fb919 2157 }\r
2158\r
0c18794e 2159 //\r
fddbbc66 2160 // BufferForMerge(from DataOffset of NextVariable) has included the merged existing and new data.\r
0c18794e 2161 //\r
fddbbc66
SZ
2162 Data = BufferForMerge;\r
2163 DataSize = MergedBufSize;\r
2164 DataReady = TRUE;\r
0c18794e 2165 }\r
2166\r
2167 //\r
2168 // Mark the old variable as in delete transition.\r
2169 //\r
2170 State = Variable->CurrPtr->State;\r
2171 State &= VAR_IN_DELETED_TRANSITION;\r
2172\r
2173 Status = UpdateVariableStore (\r
2174 &mVariableModuleGlobal->VariableGlobal,\r
2175 Variable->Volatile,\r
2176 FALSE,\r
2177 Fvb,\r
2178 (UINTN) &Variable->CurrPtr->State,\r
2179 sizeof (UINT8),\r
2180 &State\r
2d3fb919 2181 );\r
0c18794e 2182 if (EFI_ERROR (Status)) {\r
2d3fb919 2183 goto Done;\r
2184 }\r
0c18794e 2185 if (!Variable->Volatile) {\r
2186 CacheVariable->CurrPtr->State = State;\r
2187 }\r
2d3fb919 2188 }\r
0c18794e 2189 } else {\r
2190 //\r
2191 // Not found existing variable. Create a new variable.\r
0c18794e 2192 //\r
2d3fb919 2193\r
2194 if ((DataSize == 0) && ((Attributes & EFI_VARIABLE_APPEND_WRITE) != 0)) {\r
2195 Status = EFI_SUCCESS;\r
0c18794e 2196 goto Done;\r
2197 }\r
2d3fb919 2198\r
0c18794e 2199 //\r
2200 // Make sure we are trying to create a new variable.\r
2d3fb919 2201 // Setting a data variable with zero DataSize or no access attributes means to delete it.\r
0c18794e 2202 //\r
2203 if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {\r
2204 Status = EFI_NOT_FOUND;\r
2205 goto Done;\r
2206 }\r
2d3fb919 2207\r
0c18794e 2208 //\r
2209 // Only variable have NV|RT attribute can be created in Runtime.\r
2210 //\r
2211 if (AtRuntime () &&\r
2212 (((Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0) || ((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0))) {\r
2213 Status = EFI_INVALID_PARAMETER;\r
2214 goto Done;\r
2d3fb919 2215 }\r
0c18794e 2216 }\r
2217\r
2218 //\r
2219 // Function part - create a new variable and copy the data.\r
2220 // Both update a variable and create a variable will come here.\r
fddbbc66 2221 //\r
0c18794e 2222 NextVariable->StartId = VARIABLE_DATA;\r
2223 //\r
2224 // NextVariable->State = VAR_ADDED;\r
2225 //\r
2226 NextVariable->Reserved = 0;\r
2227 NextVariable->PubKeyIndex = KeyIndex;\r
2228 NextVariable->MonotonicCount = MonotonicCount;\r
2d3fb919 2229 ZeroMem (&NextVariable->TimeStamp, sizeof (EFI_TIME));\r
0c18794e 2230\r
3b4151bc 2231 if (((Attributes & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) != 0) &&\r
2d3fb919 2232 (TimeStamp != NULL)) {\r
3b4151bc 2233 if ((Attributes & EFI_VARIABLE_APPEND_WRITE) == 0) {\r
2234 CopyMem (&NextVariable->TimeStamp, TimeStamp, sizeof (EFI_TIME));\r
2235 } else {\r
0c18794e 2236 //\r
2237 // In the case when the EFI_VARIABLE_APPEND_WRITE attribute is set, only\r
2238 // when the new TimeStamp value is later than the current timestamp associated\r
2239 // with the variable, we need associate the new timestamp with the updated value.\r
2240 //\r
2d3fb919 2241 if (Variable->CurrPtr != NULL) {\r
2242 if (CompareTimeStamp (&Variable->CurrPtr->TimeStamp, TimeStamp)) {\r
2243 CopyMem (&NextVariable->TimeStamp, TimeStamp, sizeof (EFI_TIME));\r
2244 }\r
0c18794e 2245 }\r
3b4151bc 2246 }\r
0c18794e 2247 }\r
2248\r
2249 //\r
2d3fb919 2250 // The EFI_VARIABLE_APPEND_WRITE attribute will never be set in the returned\r
0c18794e 2251 // Attributes bitmask parameter of a GetVariable() call.\r
2252 //\r
2253 NextVariable->Attributes = Attributes & (~EFI_VARIABLE_APPEND_WRITE);\r
2d3fb919 2254\r
0c18794e 2255 VarNameOffset = sizeof (VARIABLE_HEADER);\r
2256 VarNameSize = StrSize (VariableName);\r
2257 CopyMem (\r
2258 (UINT8 *) ((UINTN) NextVariable + VarNameOffset),\r
2259 VariableName,\r
2260 VarNameSize\r
2261 );\r
2262 VarDataOffset = VarNameOffset + VarNameSize + GET_PAD_SIZE (VarNameSize);\r
fddbbc66
SZ
2263\r
2264 //\r
2265 // If DataReady is TRUE, it means the variable data has been saved into\r
2266 // NextVariable during EFI_VARIABLE_APPEND_WRITE operation preparation.\r
2267 //\r
2268 if (!DataReady) {\r
2269 CopyMem (\r
2270 (UINT8 *) ((UINTN) NextVariable + VarDataOffset),\r
2271 Data,\r
2272 DataSize\r
2273 );\r
2274 }\r
2275\r
0c18794e 2276 CopyMem (&NextVariable->VendorGuid, VendorGuid, sizeof (EFI_GUID));\r
2277 //\r
2278 // There will be pad bytes after Data, the NextVariable->NameSize and\r
2279 // NextVariable->DataSize should not include pad size so that variable\r
2280 // service can get actual size in GetVariable.\r
2281 //\r
2282 NextVariable->NameSize = (UINT32)VarNameSize;\r
2283 NextVariable->DataSize = (UINT32)DataSize;\r
2284\r
2285 //\r
2286 // The actual size of the variable that stores in storage should\r
2287 // include pad size.\r
2288 //\r
2289 VarSize = VarDataOffset + DataSize + GET_PAD_SIZE (DataSize);\r
2290 if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {\r
2291 //\r
2292 // Create a nonvolatile variable.\r
2293 //\r
2294 Volatile = FALSE;\r
2295 NonVolatileVarableStoreSize = ((VARIABLE_STORE_HEADER *)(UINTN)(mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase))->Size;\r
2d3fb919 2296 if ((((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0)\r
0c18794e 2297 && ((VarSize + mVariableModuleGlobal->HwErrVariableTotalSize) > PcdGet32 (PcdHwErrStorageSize)))\r
2d3fb919 2298 || (((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == 0)\r
0c18794e 2299 && ((VarSize + mVariableModuleGlobal->CommonVariableTotalSize) > NonVolatileVarableStoreSize - sizeof (VARIABLE_STORE_HEADER) - PcdGet32 (PcdHwErrStorageSize)))) {\r
2300 if (AtRuntime ()) {\r
2301 Status = EFI_OUT_OF_RESOURCES;\r
2302 goto Done;\r
2303 }\r
2304 //\r
7baf3c69 2305 // Perform garbage collection & reclaim operation, and integrate the new variable at the same time.\r
0c18794e 2306 //\r
83758cdc 2307 Status = Reclaim (\r
2308 mVariableModuleGlobal->VariableGlobal.NonVolatileVariableBase,\r
2309 &mVariableModuleGlobal->NonVolatileLastVariableOffset,\r
2310 FALSE,\r
23b06935 2311 Variable,\r
7baf3c69
SZ
2312 NextVariable,\r
2313 HEADER_ALIGN (VarSize),\r
83758cdc 2314 FALSE\r
2315 );\r
7baf3c69
SZ
2316 if (!EFI_ERROR (Status)) {\r
2317 //\r
2318 // The new variable has been integrated successfully during reclaiming.\r
2319 //\r
2320 if (Variable->CurrPtr != NULL) {\r
2321 CacheVariable->CurrPtr = (VARIABLE_HEADER *)((UINTN) CacheVariable->StartPtr + ((UINTN) Variable->CurrPtr - (UINTN) Variable->StartPtr));\r
2322 CacheVariable->InDeletedTransitionPtr = NULL;\r
2323 }\r
2324 UpdateVariableInfo (VariableName, VendorGuid, FALSE, FALSE, TRUE, FALSE, FALSE);\r
2325 FlushHobVariableToFlash (VariableName, VendorGuid);\r
23b06935 2326 }\r
7baf3c69 2327 goto Done;\r
0c18794e 2328 }\r
2329 //\r
2330 // Four steps\r
2331 // 1. Write variable header\r
2d3fb919 2332 // 2. Set variable state to header valid\r
0c18794e 2333 // 3. Write variable data\r
2334 // 4. Set variable state to valid\r
2335 //\r
2336 //\r
2337 // Step 1:\r
2338 //\r
2339 CacheOffset = mVariableModuleGlobal->NonVolatileLastVariableOffset;\r
2340 Status = UpdateVariableStore (\r
2341 &mVariableModuleGlobal->VariableGlobal,\r
2342 FALSE,\r
2343 TRUE,\r
2344 Fvb,\r
2345 mVariableModuleGlobal->NonVolatileLastVariableOffset,\r
2346 sizeof (VARIABLE_HEADER),\r
2347 (UINT8 *) NextVariable\r
2348 );\r
2349\r
2350 if (EFI_ERROR (Status)) {\r
2351 goto Done;\r
2352 }\r
2353\r
2354 //\r
2355 // Step 2:\r
2356 //\r
2357 NextVariable->State = VAR_HEADER_VALID_ONLY;\r
2358 Status = UpdateVariableStore (\r
2359 &mVariableModuleGlobal->VariableGlobal,\r
2360 FALSE,\r
2361 TRUE,\r
2362 Fvb,\r
2363 mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),\r
2364 sizeof (UINT8),\r
2365 &NextVariable->State\r
2366 );\r
2367\r
2368 if (EFI_ERROR (Status)) {\r
2369 goto Done;\r
2370 }\r
2371 //\r
2372 // Step 3:\r
2373 //\r
2374 Status = UpdateVariableStore (\r
2375 &mVariableModuleGlobal->VariableGlobal,\r
2376 FALSE,\r
2377 TRUE,\r
2378 Fvb,\r
2379 mVariableModuleGlobal->NonVolatileLastVariableOffset + sizeof (VARIABLE_HEADER),\r
2380 (UINT32) VarSize - sizeof (VARIABLE_HEADER),\r
2381 (UINT8 *) NextVariable + sizeof (VARIABLE_HEADER)\r
2382 );\r
2383\r
2384 if (EFI_ERROR (Status)) {\r
2385 goto Done;\r
2386 }\r
2387 //\r
2388 // Step 4:\r
2389 //\r
2390 NextVariable->State = VAR_ADDED;\r
2391 Status = UpdateVariableStore (\r
2392 &mVariableModuleGlobal->VariableGlobal,\r
2393 FALSE,\r
2394 TRUE,\r
2395 Fvb,\r
2396 mVariableModuleGlobal->NonVolatileLastVariableOffset + OFFSET_OF (VARIABLE_HEADER, State),\r
2397 sizeof (UINT8),\r
2398 &NextVariable->State\r
2399 );\r
2400\r
2401 if (EFI_ERROR (Status)) {\r
2402 goto Done;\r
2403 }\r
2404\r
2405 mVariableModuleGlobal->NonVolatileLastVariableOffset += HEADER_ALIGN (VarSize);\r
2406\r
2407 if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0) {\r
2408 mVariableModuleGlobal->HwErrVariableTotalSize += HEADER_ALIGN (VarSize);\r
2409 } else {\r
2410 mVariableModuleGlobal->CommonVariableTotalSize += HEADER_ALIGN (VarSize);\r
2411 }\r
2412 //\r
2413 // update the memory copy of Flash region.\r
2414 //\r
2415 CopyMem ((UINT8 *)mNvVariableCache + CacheOffset, (UINT8 *)NextVariable, VarSize);\r
2416 } else {\r
2417 //\r
2418 // Create a volatile variable.\r
2d3fb919 2419 //\r
0c18794e 2420 Volatile = TRUE;\r
2421\r
2422 if ((UINT32) (VarSize + mVariableModuleGlobal->VolatileLastVariableOffset) >\r
2423 ((VARIABLE_STORE_HEADER *) ((UINTN) (mVariableModuleGlobal->VariableGlobal.VolatileVariableBase)))->Size) {\r
2424 //\r
7baf3c69 2425 // Perform garbage collection & reclaim operation, and integrate the new variable at the same time.\r
0c18794e 2426 //\r
83758cdc 2427 Status = Reclaim (\r
2428 mVariableModuleGlobal->VariableGlobal.VolatileVariableBase,\r
2429 &mVariableModuleGlobal->VolatileLastVariableOffset,\r
2430 TRUE,\r
23b06935 2431 Variable,\r
7baf3c69
SZ
2432 NextVariable,\r
2433 HEADER_ALIGN (VarSize),\r
83758cdc 2434 FALSE\r
2435 );\r
7baf3c69
SZ
2436 if (!EFI_ERROR (Status)) {\r
2437 //\r
2438 // The new variable has been integrated successfully during reclaiming.\r
2439 //\r
2440 if (Variable->CurrPtr != NULL) {\r
2441 CacheVariable->CurrPtr = (VARIABLE_HEADER *)((UINTN) CacheVariable->StartPtr + ((UINTN) Variable->CurrPtr - (UINTN) Variable->StartPtr));\r
2442 CacheVariable->InDeletedTransitionPtr = NULL;\r
2443 }\r
2444 UpdateVariableInfo (VariableName, VendorGuid, TRUE, FALSE, TRUE, FALSE, FALSE);\r
23b06935 2445 }\r
7baf3c69 2446 goto Done;\r
0c18794e 2447 }\r
2448\r
2449 NextVariable->State = VAR_ADDED;\r
2450 Status = UpdateVariableStore (\r
2451 &mVariableModuleGlobal->VariableGlobal,\r
2452 TRUE,\r
2453 TRUE,\r
2454 Fvb,\r
2455 mVariableModuleGlobal->VolatileLastVariableOffset,\r
2456 (UINT32) VarSize,\r
2457 (UINT8 *) NextVariable\r
2458 );\r
2459\r
2460 if (EFI_ERROR (Status)) {\r
2461 goto Done;\r
2462 }\r
2463\r
2464 mVariableModuleGlobal->VolatileLastVariableOffset += HEADER_ALIGN (VarSize);\r
2465 }\r
2466\r
2467 //\r
2468 // Mark the old variable as deleted.\r
2469 //\r
23b06935
SZ
2470 if (!EFI_ERROR (Status) && Variable->CurrPtr != NULL) {\r
2471 if (Variable->InDeletedTransitionPtr != NULL) {\r
2472 //\r
2473 // Both ADDED and IN_DELETED_TRANSITION old variable are present,\r
2474 // set IN_DELETED_TRANSITION one to DELETED state first.\r
2475 //\r
2476 State = Variable->InDeletedTransitionPtr->State;\r
2477 State &= VAR_DELETED;\r
2478 Status = UpdateVariableStore (\r
2479 &mVariableModuleGlobal->VariableGlobal,\r
2480 Variable->Volatile,\r
2481 FALSE,\r
2482 Fvb,\r
2483 (UINTN) &Variable->InDeletedTransitionPtr->State,\r
2484 sizeof (UINT8),\r
2485 &State\r
2486 );\r
2487 if (!EFI_ERROR (Status)) {\r
2488 if (!Variable->Volatile) {\r
0cc565de 2489 ASSERT (CacheVariable->InDeletedTransitionPtr != NULL);\r
23b06935
SZ
2490 CacheVariable->InDeletedTransitionPtr->State = State;\r
2491 }\r
2492 } else {\r
2493 goto Done;\r
2494 }\r
2495 }\r
2496\r
0c18794e 2497 State = Variable->CurrPtr->State;\r
2498 State &= VAR_DELETED;\r
2499\r
2500 Status = UpdateVariableStore (\r
2501 &mVariableModuleGlobal->VariableGlobal,\r
2502 Variable->Volatile,\r
2503 FALSE,\r
2504 Fvb,\r
2505 (UINTN) &Variable->CurrPtr->State,\r
2506 sizeof (UINT8),\r
2507 &State\r
2508 );\r
2d3fb919 2509 if (!EFI_ERROR (Status) && !Variable->Volatile) {\r
0c18794e 2510 CacheVariable->CurrPtr->State = State;\r
2511 }\r
2512 }\r
2513\r
2514 if (!EFI_ERROR (Status)) {\r
2515 UpdateVariableInfo (VariableName, VendorGuid, Volatile, FALSE, TRUE, FALSE, FALSE);\r
335e2681
SZ
2516 if (!Volatile) {\r
2517 FlushHobVariableToFlash (VariableName, VendorGuid);\r
2518 }\r
0c18794e 2519 }\r
2520\r
2521Done:\r
2522 return Status;\r
2523}\r
2524\r
a5f15e30
SZ
2525/**\r
2526 Check if a Unicode character is a hexadecimal character.\r
2527\r
2528 This function checks if a Unicode character is a \r
2529 hexadecimal character. The valid hexadecimal character is \r
2530 L'0' to L'9', L'a' to L'f', or L'A' to L'F'.\r
2531\r
2532\r
2533 @param Char The character to check against.\r
2534\r
2535 @retval TRUE If the Char is a hexadecmial character.\r
2536 @retval FALSE If the Char is not a hexadecmial character.\r
2537\r
2538**/\r
2539BOOLEAN\r
2540EFIAPI\r
2541IsHexaDecimalDigitCharacter (\r
2542 IN CHAR16 Char\r
2543 )\r
2544{\r
2545 return (BOOLEAN) ((Char >= L'0' && Char <= L'9') || (Char >= L'A' && Char <= L'F') || (Char >= L'a' && Char <= L'f'));\r
2546}\r
2547\r
2548/**\r
2549\r
2550 This code checks if variable is hardware error record variable or not.\r
2551\r
2552 According to UEFI spec, hardware error record variable should use the EFI_HARDWARE_ERROR_VARIABLE VendorGuid\r
2553 and have the L"HwErrRec####" name convention, #### is a printed hex value and no 0x or h is included in the hex value.\r
2554\r
2555 @param VariableName Pointer to variable name.\r
2556 @param VendorGuid Variable Vendor Guid.\r
2557\r
2558 @retval TRUE Variable is hardware error record variable.\r
2559 @retval FALSE Variable is not hardware error record variable.\r
2560\r
2561**/\r
2562BOOLEAN\r
2563EFIAPI\r
2564IsHwErrRecVariable (\r
2565 IN CHAR16 *VariableName,\r
2566 IN EFI_GUID *VendorGuid\r
2567 )\r
2568{\r
2569 if (!CompareGuid (VendorGuid, &gEfiHardwareErrorVariableGuid) ||\r
2570 (StrLen (VariableName) != StrLen (L"HwErrRec####")) ||\r
2571 (StrnCmp(VariableName, L"HwErrRec", StrLen (L"HwErrRec")) != 0) ||\r
2572 !IsHexaDecimalDigitCharacter (VariableName[0x8]) ||\r
2573 !IsHexaDecimalDigitCharacter (VariableName[0x9]) ||\r
2574 !IsHexaDecimalDigitCharacter (VariableName[0xA]) ||\r
2575 !IsHexaDecimalDigitCharacter (VariableName[0xB])) {\r
2576 return FALSE;\r
2577 }\r
2578\r
2579 return TRUE;\r
2580}\r
2581\r
6675a21f
SZ
2582/**\r
2583 This code checks if variable guid is global variable guid first.\r
2584 If yes, further check if variable name is in mGlobalVariableList or mGlobalVariableList2 and attributes matched.\r
2585\r
2586 @param[in] VariableName Pointer to variable name.\r
2587 @param[in] VendorGuid Variable Vendor Guid.\r
2588 @param[in] Attributes Attributes of the variable.\r
2589\r
2590 @retval EFI_SUCCESS Variable is not global variable, or Variable is global variable, variable name is in the lists and attributes matched.\r
2591 @retval EFI_INVALID_PARAMETER Variable is global variable, but variable name is not in the lists or attributes unmatched.\r
2592\r
2593**/\r
2594EFI_STATUS\r
2595EFIAPI\r
2596CheckEfiGlobalVariable (\r
2597 IN CHAR16 *VariableName,\r
2598 IN EFI_GUID *VendorGuid,\r
2599 IN UINT32 Attributes\r
2600 )\r
2601{\r
2602 UINTN Index;\r
2603 UINTN NameLength;\r
2604\r
2605 if (CompareGuid (VendorGuid, &gEfiGlobalVariableGuid)){\r
2606 //\r
2607 // Try list 1, exactly match.\r
2608 //\r
2609 for (Index = 0; Index < sizeof (mGlobalVariableList)/sizeof (mGlobalVariableList[0]); Index++) {\r
2610 if ((StrCmp (mGlobalVariableList[Index].Name, VariableName) == 0) &&\r
2611 (Attributes == 0 || (Attributes & (~EFI_VARIABLE_APPEND_WRITE)) == mGlobalVariableList[Index].Attributes)) {\r
2612 return EFI_SUCCESS;\r
2613 }\r
2614 }\r
2615\r
2616 //\r
2617 // Try list 2.\r
2618 //\r
2619 NameLength = StrLen (VariableName) - 4;\r
2620 for (Index = 0; Index < sizeof (mGlobalVariableList2)/sizeof (mGlobalVariableList2[0]); Index++) {\r
2621 if ((StrLen (VariableName) == StrLen (mGlobalVariableList2[Index].Name)) &&\r
2622 (StrnCmp (mGlobalVariableList2[Index].Name, VariableName, NameLength) == 0) &&\r
2623 IsHexaDecimalDigitCharacter (VariableName[NameLength]) &&\r
2624 IsHexaDecimalDigitCharacter (VariableName[NameLength + 1]) &&\r
2625 IsHexaDecimalDigitCharacter (VariableName[NameLength + 2]) &&\r
2626 IsHexaDecimalDigitCharacter (VariableName[NameLength + 3]) &&\r
2627 (Attributes == 0 || (Attributes & (~EFI_VARIABLE_APPEND_WRITE)) == mGlobalVariableList2[Index].Attributes)) {\r
2628 return EFI_SUCCESS;\r
2629 }\r
2630 }\r
2631\r
2632 DEBUG ((EFI_D_INFO, "[Variable]: set global variable with invalid variable name or attributes - %g:%s:%x\n", VendorGuid, VariableName, Attributes));\r
2633 return EFI_INVALID_PARAMETER;\r
2634 }\r
2635\r
2636 return EFI_SUCCESS;\r
2637}\r
2638\r
6ab9f441
RN
2639/**\r
2640 Mark a variable that will become read-only after leaving the DXE phase of execution.\r
2641\r
2642 @param[in] This The VARIABLE_LOCK_PROTOCOL instance.\r
2643 @param[in] VariableName A pointer to the variable name that will be made read-only subsequently.\r
2644 @param[in] VendorGuid A pointer to the vendor GUID that will be made read-only subsequently.\r
2645\r
2646 @retval EFI_SUCCESS The variable specified by the VariableName and the VendorGuid was marked\r
2647 as pending to be read-only.\r
2648 @retval EFI_INVALID_PARAMETER VariableName or VendorGuid is NULL.\r
2649 Or VariableName is an empty string.\r
2650 @retval EFI_ACCESS_DENIED EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
2651 already been signaled.\r
2652 @retval EFI_OUT_OF_RESOURCES There is not enough resource to hold the lock request.\r
2653**/\r
2654EFI_STATUS\r
2655EFIAPI\r
2656VariableLockRequestToLock (\r
2657 IN CONST EDKII_VARIABLE_LOCK_PROTOCOL *This,\r
2658 IN CHAR16 *VariableName,\r
2659 IN EFI_GUID *VendorGuid\r
2660 )\r
2661{\r
2662 VARIABLE_ENTRY *Entry;\r
2663\r
2664 if (VariableName == NULL || VariableName[0] == 0 || VendorGuid == NULL) {\r
2665 return EFI_INVALID_PARAMETER;\r
2666 }\r
2667\r
2668 if (mEndOfDxe) {\r
2669 return EFI_ACCESS_DENIED;\r
2670 }\r
2671\r
2672 Entry = AllocateRuntimePool (sizeof (*Entry) + StrSize (VariableName));\r
2673 if (Entry == NULL) {\r
2674 return EFI_OUT_OF_RESOURCES;\r
2675 }\r
2676\r
2677 DEBUG ((EFI_D_INFO, "[Variable] Lock: %g:%s\n", VendorGuid, VariableName));\r
2678\r
2679 AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
2680\r
2681 Entry->Name = (CHAR16 *) (Entry + 1);\r
2682 StrCpy (Entry->Name, VariableName);\r
2683 CopyGuid (&Entry->Guid, VendorGuid);\r
2684 InsertTailList (&mLockedVariableList, &Entry->Link);\r
2685\r
2686 ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
2687\r
2688 return EFI_SUCCESS;\r
2689}\r
2690\r
05a643f9 2691/**\r
2692 This code checks if variable should be treated as read-only variable.\r
2693\r
2694 @param[in] VariableName Name of the Variable.\r
2695 @param[in] VendorGuid GUID of the Variable.\r
2696\r
2697 @retval TRUE This variable is read-only variable.\r
2698 @retval FALSE This variable is NOT read-only variable.\r
2699 \r
2700**/\r
2701BOOLEAN\r
2702IsReadOnlyVariable (\r
2703 IN CHAR16 *VariableName,\r
2704 IN EFI_GUID *VendorGuid\r
2705 )\r
2706{\r
2707 if (CompareGuid (VendorGuid, &gEfiGlobalVariableGuid)) {\r
2708 if ((StrCmp (VariableName, EFI_SETUP_MODE_NAME) == 0) ||\r
2709 (StrCmp (VariableName, EFI_SIGNATURE_SUPPORT_NAME) == 0) ||\r
a555940b 2710 (StrCmp (VariableName, EFI_SECURE_BOOT_MODE_NAME) == 0) ||\r
3a186b06
FS
2711 (StrCmp (VariableName, EFI_VENDOR_KEYS_VARIABLE_NAME) == 0) ||\r
2712 (StrCmp (VariableName, EFI_KEK_DEFAULT_VARIABLE_NAME) == 0) ||\r
2713 (StrCmp (VariableName, EFI_PK_DEFAULT_VARIABLE_NAME) == 0) ||\r
2714 (StrCmp (VariableName, EFI_DB_DEFAULT_VARIABLE_NAME) == 0) ||\r
2715 (StrCmp (VariableName, EFI_DBX_DEFAULT_VARIABLE_NAME) == 0) ||\r
2716 (StrCmp (VariableName, EFI_DBT_DEFAULT_VARIABLE_NAME) == 0)) {\r
05a643f9 2717 return TRUE;\r
2718 }\r
2719 }\r
2720 \r
2721 return FALSE;\r
2722}\r
2723\r
0c18794e 2724/**\r
2725\r
2726 This code finds variable in storage blocks (Volatile or Non-Volatile).\r
2727\r
dc204d5a
JY
2728 Caution: This function may receive untrusted input.\r
2729 This function may be invoked in SMM mode, and datasize is external input.\r
2730 This function will do basic validation, before parse the data.\r
2731\r
0c18794e 2732 @param VariableName Name of Variable to be found.\r
2733 @param VendorGuid Variable vendor GUID.\r
2734 @param Attributes Attribute value of the variable found.\r
2735 @param DataSize Size of Data found. If size is less than the\r
2736 data, this value contains the required size.\r
2737 @param Data Data pointer.\r
2d3fb919 2738\r
0c18794e 2739 @return EFI_INVALID_PARAMETER Invalid parameter.\r
2740 @return EFI_SUCCESS Find the specified variable.\r
2741 @return EFI_NOT_FOUND Not found.\r
2742 @return EFI_BUFFER_TO_SMALL DataSize is too small for the result.\r
2743\r
2744**/\r
2745EFI_STATUS\r
2746EFIAPI\r
2747VariableServiceGetVariable (\r
2748 IN CHAR16 *VariableName,\r
2749 IN EFI_GUID *VendorGuid,\r
2750 OUT UINT32 *Attributes OPTIONAL,\r
2751 IN OUT UINTN *DataSize,\r
2752 OUT VOID *Data\r
2753 )\r
2754{\r
2755 EFI_STATUS Status;\r
2756 VARIABLE_POINTER_TRACK Variable;\r
2757 UINTN VarDataSize;\r
2758\r
2759 if (VariableName == NULL || VendorGuid == NULL || DataSize == NULL) {\r
2760 return EFI_INVALID_PARAMETER;\r
2761 }\r
2762\r
2763 AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
2d3fb919 2764\r
ecc722ad 2765 Status = FindVariable (VariableName, VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r
0c18794e 2766 if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {\r
2767 goto Done;\r
2768 }\r
2769\r
2770 //\r
2771 // Get data size\r
2772 //\r
2773 VarDataSize = DataSizeOfVariable (Variable.CurrPtr);\r
2774 ASSERT (VarDataSize != 0);\r
2775\r
2776 if (*DataSize >= VarDataSize) {\r
2777 if (Data == NULL) {\r
2778 Status = EFI_INVALID_PARAMETER;\r
2779 goto Done;\r
2780 }\r
2781\r
2782 CopyMem (Data, GetVariableDataPtr (Variable.CurrPtr), VarDataSize);\r
2783 if (Attributes != NULL) {\r
2784 *Attributes = Variable.CurrPtr->Attributes;\r
2785 }\r
2786\r
2787 *DataSize = VarDataSize;\r
2788 UpdateVariableInfo (VariableName, VendorGuid, Variable.Volatile, TRUE, FALSE, FALSE, FALSE);\r
2d3fb919 2789\r
0c18794e 2790 Status = EFI_SUCCESS;\r
2791 goto Done;\r
2792 } else {\r
2793 *DataSize = VarDataSize;\r
2794 Status = EFI_BUFFER_TOO_SMALL;\r
2795 goto Done;\r
2796 }\r
2797\r
2798Done:\r
2799 ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
2800 return Status;\r
2801}\r
2802\r
2803\r
2804\r
2805/**\r
2806\r
2807 This code Finds the Next available variable.\r
2808\r
dc204d5a
JY
2809 Caution: This function may receive untrusted input.\r
2810 This function may be invoked in SMM mode. This function will do basic validation, before parse the data.\r
2811\r
0c18794e 2812 @param VariableNameSize Size of the variable name.\r
2813 @param VariableName Pointer to variable name.\r
2814 @param VendorGuid Variable Vendor Guid.\r
2815\r
2816 @return EFI_INVALID_PARAMETER Invalid parameter.\r
2817 @return EFI_SUCCESS Find the specified variable.\r
2818 @return EFI_NOT_FOUND Not found.\r
2819 @return EFI_BUFFER_TO_SMALL DataSize is too small for the result.\r
2820\r
2821**/\r
2822EFI_STATUS\r
2823EFIAPI\r
2824VariableServiceGetNextVariableName (\r
2825 IN OUT UINTN *VariableNameSize,\r
2826 IN OUT CHAR16 *VariableName,\r
2827 IN OUT EFI_GUID *VendorGuid\r
2828 )\r
2829{\r
9a000b46 2830 VARIABLE_STORE_TYPE Type;\r
0c18794e 2831 VARIABLE_POINTER_TRACK Variable;\r
9a000b46 2832 VARIABLE_POINTER_TRACK VariableInHob;\r
23b06935 2833 VARIABLE_POINTER_TRACK VariablePtrTrack;\r
0c18794e 2834 UINTN VarNameSize;\r
2835 EFI_STATUS Status;\r
9a000b46 2836 VARIABLE_STORE_HEADER *VariableStoreHeader[VariableStoreTypeMax];\r
0c18794e 2837\r
2838 if (VariableNameSize == NULL || VariableName == NULL || VendorGuid == NULL) {\r
2839 return EFI_INVALID_PARAMETER;\r
2840 }\r
2841\r
2842 AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
2843\r
ecc722ad 2844 Status = FindVariable (VariableName, VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r
0c18794e 2845 if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {\r
2846 goto Done;\r
2847 }\r
2848\r
2849 if (VariableName[0] != 0) {\r
2850 //\r
2851 // If variable name is not NULL, get next variable.\r
2852 //\r
2853 Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r
2854 }\r
2855\r
9a000b46
RN
2856 //\r
2857 // 0: Volatile, 1: HOB, 2: Non-Volatile.\r
2858 // The index and attributes mapping must be kept in this order as FindVariable\r
2859 // makes use of this mapping to implement search algorithm.\r
2860 //\r
2861 VariableStoreHeader[VariableStoreTypeVolatile] = (VARIABLE_STORE_HEADER *) (UINTN) mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;\r
2862 VariableStoreHeader[VariableStoreTypeHob] = (VARIABLE_STORE_HEADER *) (UINTN) mVariableModuleGlobal->VariableGlobal.HobVariableBase;\r
2863 VariableStoreHeader[VariableStoreTypeNv] = mNvVariableCache;\r
2864\r
0c18794e 2865 while (TRUE) {\r
2866 //\r
9a000b46 2867 // Switch from Volatile to HOB, to Non-Volatile.\r
0c18794e 2868 //\r
9a000b46
RN
2869 while ((Variable.CurrPtr >= Variable.EndPtr) ||\r
2870 (Variable.CurrPtr == NULL) ||\r
2871 !IsValidVariableHeader (Variable.CurrPtr)\r
2872 ) {\r
2873 //\r
2874 // Find current storage index\r
2875 //\r
2876 for (Type = (VARIABLE_STORE_TYPE) 0; Type < VariableStoreTypeMax; Type++) {\r
2877 if ((VariableStoreHeader[Type] != NULL) && (Variable.StartPtr == GetStartPointer (VariableStoreHeader[Type]))) {\r
2878 break;\r
2879 }\r
2880 }\r
2881 ASSERT (Type < VariableStoreTypeMax);\r
2882 //\r
2883 // Switch to next storage\r
2884 //\r
2885 for (Type++; Type < VariableStoreTypeMax; Type++) {\r
2886 if (VariableStoreHeader[Type] != NULL) {\r
2887 break;\r
2888 }\r
2889 }\r
2890 //\r
2d3fb919 2891 // Capture the case that\r
9a000b46
RN
2892 // 1. current storage is the last one, or\r
2893 // 2. no further storage\r
2894 //\r
2895 if (Type == VariableStoreTypeMax) {\r
0c18794e 2896 Status = EFI_NOT_FOUND;\r
2897 goto Done;\r
2898 }\r
9a000b46
RN
2899 Variable.StartPtr = GetStartPointer (VariableStoreHeader[Type]);\r
2900 Variable.EndPtr = GetEndPointer (VariableStoreHeader[Type]);\r
2901 Variable.CurrPtr = Variable.StartPtr;\r
0c18794e 2902 }\r
9a000b46 2903\r
0c18794e 2904 //\r
2905 // Variable is found\r
2906 //\r
23b06935
SZ
2907 if (Variable.CurrPtr->State == VAR_ADDED || Variable.CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
2908 if (!AtRuntime () || ((Variable.CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) != 0)) {\r
2909 if (Variable.CurrPtr->State == (VAR_IN_DELETED_TRANSITION & VAR_ADDED)) {\r
2910 //\r
2911 // If it is a IN_DELETED_TRANSITION variable,\r
2912 // and there is also a same ADDED one at the same time,\r
2913 // don't return it.\r
2914 //\r
2915 VariablePtrTrack.StartPtr = Variable.StartPtr;\r
2916 VariablePtrT