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