Report the setting variable failure to platform through the status code when core cannot handle the error.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15385 6f19259b-4bc3-4df7-8a09-765794883524

5 files changed, 192 insertions, 33 deletions

diff --git a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsBoot.c b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsBoot.c
index 3701434ef..134833286 100644
--- a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsBoot.c
+++ b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsBoot.c
@@ -1,7 +1,7 @@
 /** @file

   BDS Lib functions which relate with create or process the boot option.

 

-Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -82,6 +82,10 @@ BdsDeleteBootOption (
                   0,

                   NULL

                   );

+  //

+  // Deleting variable with existing variable implementation shouldn't fail.

+  //

+  ASSERT_EFI_ERROR (Status);

 

   //

   // adjust boot order array

@@ -626,6 +630,10 @@ BdsDeleteAllInvalidLegacyBootOptions (
                   BootOrderSize,

                   BootOrder

                   );

+  //

+  // Shrinking variable with existing variable implementation shouldn't fail.

+  //

+  ASSERT_EFI_ERROR (Status);

   if (BootOrder != NULL) {

     FreePool (BootOrder);

   }

@@ -857,11 +865,10 @@ BdsAddNonExistingLegacyBootOptions (
                 &BootOrder,

                 &BootOrderSize

                 );

-      if (EFI_ERROR (Status)) {

-        break;

+      if (!EFI_ERROR (Status)) {

+        BbsIndex     = Index;

+        OptionNumber = BootOrder[BootOrderSize / sizeof (UINT16) - 1];

       }

-      BbsIndex     = Index;

-      OptionNumber = BootOrder[BootOrderSize / sizeof (UINT16) - 1];

     }

 

     ASSERT (BbsIndex == Index);

@@ -2265,7 +2272,7 @@ BdsLibBootViaBootOption (
     // In this case, "BootCurrent" is not created.

     // Only create the BootCurrent variable when it points to a valid Boot#### variable.

     //

-    gRT->SetVariable (

+    SetVariableAndReportStatusCodeOnError (

           L"BootCurrent",

           &gEfiGlobalVariableGuid,

           EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,

@@ -2463,13 +2470,14 @@ Done:
 

   //

   // Clear Boot Current

+  // Deleting variable with current implementation shouldn't fail.

   //

   gRT->SetVariable (

         L"BootCurrent",

         &gEfiGlobalVariableGuid,

         EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,

         0,

-        &Option->BootCurrent

+        NULL

         );

 

   return Status;

@@ -2580,6 +2588,7 @@ BdsExpandPartitionPartialDevicePathToFull (
         FreePool (TempNewDevicePath);

         //

         // Save the matching Device Path so we don't need to do a connect all next time

+        // Failure to set the variable only impacts the performance when next time expanding the short-form device path.

         //

         Status = gRT->SetVariable (

                         HD_BOOT_DEVICE_PATH_VARIABLE_NAME,

@@ -2678,6 +2687,7 @@ BdsExpandPartitionPartialDevicePathToFull (
 

       //

       // Save the matching Device Path so we don't need to do a connect all next time

+      // Failure to set the variable only impacts the performance when next time expanding the short-form device path.

       //

       Status = gRT->SetVariable (

                       HD_BOOT_DEVICE_PATH_VARIABLE_NAME,

@@ -2887,6 +2897,10 @@ BdsLibDeleteOptionFromHandle (
                   BootOrderSize,

                   BootOrder

                   );

+  //

+  // Shrinking variable with existing variable implementation shouldn't fail.

+  //

+  ASSERT_EFI_ERROR (Status);

 

   FreePool (BootOrder);

 

@@ -2985,6 +2999,10 @@ BdsDeleteAllInvalidEfiBootOption (
                       NULL

                       );

       //

+      // Deleting variable with current variable implementation shouldn't fail.

+      //

+      ASSERT_EFI_ERROR (Status);

+      //

       // Mark this boot option in boot order as deleted

       //

       BootOrder[Index] = 0xffff;

@@ -3012,6 +3030,10 @@ BdsDeleteAllInvalidEfiBootOption (
                   Index2 * sizeof (UINT16),

                   BootOrder

                   );

+  //

+  // Shrinking variable with current variable implementation shouldn't fail.

+  //

+  ASSERT_EFI_ERROR (Status);

 

   FreePool (BootOrder);

 

@@ -3135,7 +3157,9 @@ BdsLibEnumerateAllBootOption (
         AsciiStrSize (PlatLang),

         PlatLang

         );

-      ASSERT_EFI_ERROR (Status);

+      //

+      // Failure to set the variable only impacts the performance next time enumerating the boot options.

+      //

 

       if (LastLang != NULL) {

         FreePool (LastLang);

@@ -3478,6 +3502,7 @@ BdsLibBootNext (
   VOID

   )

 {

+  EFI_STATUS        Status;

   UINT16            *BootNext;

   UINTN             BootNextSize;

   CHAR16            Buffer[20];

@@ -3502,13 +3527,17 @@ BdsLibBootNext (
   // Clear the boot next variable first

   //

   if (BootNext != NULL) {

-    gRT->SetVariable (

-          L"BootNext",

-          &gEfiGlobalVariableGuid,

-          EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

-          0,

-          BootNext

-          );

+    Status = gRT->SetVariable (

+                    L"BootNext",

+                    &gEfiGlobalVariableGuid,

+                    EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,

+                    0,

+                    NULL

+                    );

+    //

+    // Deleting variable with current variable implementation shouldn't fail.

+    //

+    ASSERT_EFI_ERROR (Status);

 

     //

     // Start to build the boot option and try to boot

diff --git a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConsole.c b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConsole.c
index 84e4a0e6b..271093eec 100644
--- a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConsole.c
+++ b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConsole.c
@@ -1,7 +1,7 @@
 /** @file

   BDS Lib functions which contain all the code to connect console device

 

-Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -285,17 +285,16 @@ BdsLibUpdateConsoleVariable (
   // Finally, Update the variable of the default console by NewDevicePath

   //

   DevicePathSize = GetDevicePathSize (NewDevicePath);

-  Status = gRT->SetVariable (

-                  ConVarName,

-                  &gEfiGlobalVariableGuid,

-                  Attributes,

-                  DevicePathSize,

-                  NewDevicePath

-                  );

+  Status = SetVariableAndReportStatusCodeOnError (

+             ConVarName,

+             &gEfiGlobalVariableGuid,

+             Attributes,

+             DevicePathSize,

+             NewDevicePath

+             );

   if ((DevicePathSize == 0) && (Status == EFI_NOT_FOUND)) {

     Status = EFI_SUCCESS;

   }

-  ASSERT_EFI_ERROR (Status);

 

   if (VarConsole == NewDevicePath) {

     if (VarConsole != NULL) {

diff --git a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsMisc.c b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsMisc.c
index cafbe71e2..4ea30bdf7 100644
--- a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsMisc.c
+++ b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsMisc.c
@@ -1419,13 +1419,13 @@ BdsSetMemoryTypeInformationVariable (
   // Or create the variable in first boot.

   //

   if (MemoryTypeInformationModified || !MemoryTypeInformationVariableExists) {

-    Status = gRT->SetVariable (

-                    EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,

-                    &gEfiMemoryTypeInformationGuid,

-                    EFI_VARIABLE_NON_VOLATILE  | EFI_VARIABLE_BOOTSERVICE_ACCESS,

-                    VariableSize,

-                    PreviousMemoryTypeInformation

-                    );

+    Status = SetVariableAndReportStatusCodeOnError (

+               EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,

+               &gEfiMemoryTypeInformationGuid,

+               EFI_VARIABLE_NON_VOLATILE  | EFI_VARIABLE_BOOTSERVICE_ACCESS,

+               VariableSize,

+               PreviousMemoryTypeInformation

+               );

 

     if (!EFI_ERROR (Status)) {

       //

@@ -1486,3 +1486,87 @@ BdsLibUserIdentify (
   return Manager->Identify (Manager, User);

 }

 

+/**

+  Set the variable and report the error through status code upon failure.

+

+  @param  VariableName           A Null-terminated string that is the name of the vendor's variable.

+                                 Each VariableName is unique for each VendorGuid. VariableName must

+                                 contain 1 or more characters. If VariableName is an empty string,

+                                 then EFI_INVALID_PARAMETER is returned.

+  @param  VendorGuid             A unique identifier for the vendor.

+  @param  Attributes             Attributes bitmask to set for the variable.

+  @param  DataSize               The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE, 

+                                 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or 

+                                 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero 

+                                 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is 

+                                 set, then a SetVariable() call with a DataSize of zero will not cause any change to 

+                                 the variable value (the timestamp associated with the variable may be updated however 

+                                 even if no new data value is provided,see the description of the 

+                                 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not 

+                                 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated). 

+  @param  Data                   The contents for the variable.

+

+  @retval EFI_SUCCESS            The firmware has successfully stored the variable and its data as

+                                 defined by the Attributes.

+  @retval EFI_INVALID_PARAMETER  An invalid combination of attribute bits, name, and GUID was supplied, or the

+                                 DataSize exceeds the maximum allowed.

+  @retval EFI_INVALID_PARAMETER  VariableName is an empty string.

+  @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the variable and its data.

+  @retval EFI_DEVICE_ERROR       The variable could not be retrieved due to a hardware error.

+  @retval EFI_WRITE_PROTECTED    The variable in question is read-only.

+  @retval EFI_WRITE_PROTECTED    The variable in question cannot be deleted.

+  @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 

+                                 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo 

+                                 does NOT pass the validation check carried out by the firmware.

+

+  @retval EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.

+**/

+EFI_STATUS

+SetVariableAndReportStatusCodeOnError (

+  IN CHAR16     *VariableName,

+  IN EFI_GUID   *VendorGuid,

+  IN UINT32     Attributes,

+  IN UINTN      DataSize,

+  IN VOID       *Data

+  )

+{

+  EFI_STATUS                 Status;

+  EDKII_SET_VARIABLE_STATUS  *SetVariableStatus;

+  UINTN                      NameSize;

+

+  Status = gRT->SetVariable (

+                  VariableName,

+                  VendorGuid,

+                  Attributes,

+                  DataSize,

+                  Data

+                  );

+  if (EFI_ERROR (Status)) {

+    NameSize = StrSize (VariableName);

+    SetVariableStatus = AllocatePool (sizeof (EDKII_SET_VARIABLE_STATUS) + NameSize + DataSize);

+    if (SetVariableStatus != NULL) {

+      CopyGuid (&SetVariableStatus->Guid, VendorGuid);

+      SetVariableStatus->NameSize   = NameSize;

+      SetVariableStatus->DataSize   = DataSize;

+      SetVariableStatus->SetStatus  = Status;

+      SetVariableStatus->Attributes = Attributes;

+      CopyMem (SetVariableStatus + 1,                          VariableName, NameSize);

+      CopyMem (((UINT8 *) (SetVariableStatus + 1)) + NameSize, Data,         DataSize);

+

+      REPORT_STATUS_CODE_EX (

+        EFI_ERROR_CODE,

+        PcdGet32 (PcdErrorCodeSetVariable),

+        0,

+        NULL,

+        &gEdkiiStatusCodeDataTypeVariableGuid,

+        SetVariableStatus,

+        sizeof (EDKII_SET_VARIABLE_STATUS) + NameSize + DataSize

+        );

+

+      FreePool (SetVariableStatus);

+    }

+  }

+

+  return Status;

+}

+

diff --git a/IntelFrameworkModulePkg/Library/GenericBdsLib/GenericBdsLib.inf b/IntelFrameworkModulePkg/Library/GenericBdsLib/GenericBdsLib.inf
index 2fb9916aa..041afc4e1 100644
--- a/IntelFrameworkModulePkg/Library/GenericBdsLib/GenericBdsLib.inf
+++ b/IntelFrameworkModulePkg/Library/GenericBdsLib/GenericBdsLib.inf
@@ -5,7 +5,7 @@
 #  2) BDS boot device connect interface;

 #  3) BDS Misc interfaces for mainting boot variable, ouput string, etc.

 #  

-#  Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>

+#  Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>

 #  This program and the accompanying materials

 #  are licensed and made available under the terms and conditions of the BSD License

 #  which accompanies this distribution.  The full text of the license may be found at

@@ -79,6 +79,7 @@
   gHdBootDevicePathVariablGuid                  ## SOMETIMES_PRODUCES ## Variable:L"HDDP" (The device path of Boot file on Hard device.)

   gBdsLibStringPackageGuid                      ## PRODUCES ## GUID (HII String PackageList Guid)

   gEfiLegacyDevOrderVariableGuid                ## CONSUMES ## GUID

+  gEdkiiStatusCodeDataTypeVariableGuid          ## SOMETIMES_CONSUMES

 

 [Protocols]

   gEfiSimpleFileSystemProtocolGuid              # PROTOCOL CONSUMES

@@ -111,4 +112,5 @@
   gEfiMdeModulePkgTokenSpaceGuid.PcdResetOnMemoryTypeInformationChange

   gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeOsLoaderLoad

   gEfiMdeModulePkgTokenSpaceGuid.PcdProgressCodeOsLoaderStart

+  gEfiMdeModulePkgTokenSpaceGuid.PcdErrorCodeSetVariable

   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile

diff --git a/IntelFrameworkModulePkg/Library/GenericBdsLib/InternalBdsLib.h b/IntelFrameworkModulePkg/Library/GenericBdsLib/InternalBdsLib.h
index 80b1f49a9..c32579bfc 100644
--- a/IntelFrameworkModulePkg/Library/GenericBdsLib/InternalBdsLib.h
+++ b/IntelFrameworkModulePkg/Library/GenericBdsLib/InternalBdsLib.h
@@ -1,7 +1,7 @@
 /** @file

   BDS library definition, include the file and data structure

 

-Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -51,6 +51,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Guid/HdBootVariable.h>

 #include <Guid/LastEnumLang.h>

 #include <Guid/LegacyDevOrder.h>

+#include <Guid/StatusCodeDataTypeVariable.h>

 

 #include <Library/PrintLib.h>

 #include <Library/DebugLib.h>

@@ -147,4 +148,48 @@ ValidateOption (
   UINTN                     VariableSize

   );

 

+/**

+  Set the variable and report the error through status code upon failure.

+

+  @param  VariableName           A Null-terminated string that is the name of the vendor's variable.

+                                 Each VariableName is unique for each VendorGuid. VariableName must

+                                 contain 1 or more characters. If VariableName is an empty string,

+                                 then EFI_INVALID_PARAMETER is returned.

+  @param  VendorGuid             A unique identifier for the vendor.

+  @param  Attributes             Attributes bitmask to set for the variable.

+  @param  DataSize               The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE, 

+                                 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or 

+                                 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero 

+                                 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is 

+                                 set, then a SetVariable() call with a DataSize of zero will not cause any change to 

+                                 the variable value (the timestamp associated with the variable may be updated however 

+                                 even if no new data value is provided,see the description of the 

+                                 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not 

+                                 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated). 

+  @param  Data                   The contents for the variable.

+

+  @retval EFI_SUCCESS            The firmware has successfully stored the variable and its data as

+                                 defined by the Attributes.

+  @retval EFI_INVALID_PARAMETER  An invalid combination of attribute bits, name, and GUID was supplied, or the

+                                 DataSize exceeds the maximum allowed.

+  @retval EFI_INVALID_PARAMETER  VariableName is an empty string.

+  @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the variable and its data.

+  @retval EFI_DEVICE_ERROR       The variable could not be retrieved due to a hardware error.

+  @retval EFI_WRITE_PROTECTED    The variable in question is read-only.

+  @retval EFI_WRITE_PROTECTED    The variable in question cannot be deleted.

+  @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 

+                                 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo 

+                                 does NOT pass the validation check carried out by the firmware.

+

+  @retval EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.

+**/

+EFI_STATUS

+SetVariableAndReportStatusCodeOnError (

+  IN CHAR16     *VariableName,

+  IN EFI_GUID   *VendorGuid,

+  IN UINT32     Attributes,

+  IN UINTN      DataSize,

+  IN VOID       *Data

+  );

+

 #endif // _BDS_LIB_H_