]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/Dxe/Dispatcher/Dispatcher.c
MdeModulePkg DxeCore: Check FvImage alignment
[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Dispatcher / Dispatcher.c
index 68f5ef5d6463385c9de692a49db72ebf435dbc3d..c7b9224c0e33301e111d48f9b9407c03ac5b8572 100644 (file)
@@ -26,7 +26,7 @@
   Depex - Dependency Expresion.\r
   SOR   - Schedule On Request - Don't schedule if this bit is set.\r
 \r
-Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -91,7 +91,6 @@ typedef struct {
 \r
 FV_FILEPATH_DEVICE_PATH mFvDevicePath;\r
 \r
-\r
 //\r
 // Function Prototypes\r
 //\r
@@ -393,25 +392,6 @@ CoreTrust (
   return EFI_NOT_FOUND;\r
 }\r
 \r
-\r
-/**\r
-  An empty function to pass error checking of CreateEventEx ().\r
-\r
-  @param  Event                 Event whose notification function is being invoked.\r
-  @param  Context               Pointer to the notification function's context,\r
-                                which is implementation-dependent.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-CoreEmptyCallbackFunction (\r
-  IN EFI_EVENT                Event,\r
-  IN VOID                     *Context\r
-  )\r
-{\r
-  return;\r
-}\r
-\r
 /**\r
   This is the main Dispatcher for DXE and it exits when there are no more\r
   drivers to run. Drain the mScheduledQueue and load and start a PE\r
@@ -452,7 +432,7 @@ CoreDispatcher (
   Status = CoreCreateEventEx (\r
              EVT_NOTIFY_SIGNAL,\r
              TPL_NOTIFY,\r
-             CoreEmptyCallbackFunction,\r
+             EfiEventEmptyFunction,\r
              NULL,\r
              &gEfiEventDxeDispatchGuid,\r
              &DxeDispatchEvent\r
@@ -544,6 +524,7 @@ CoreDispatcher (
           &DriverEntry->ImageHandle,\r
           sizeof (DriverEntry->ImageHandle)\r
           );\r
+        ASSERT (DriverEntry->ImageHandle != NULL);\r
   \r
         Status = CoreStartImage (DriverEntry->ImageHandle, NULL, NULL);\r
   \r
@@ -708,25 +689,106 @@ FvHasBeenProcessed (
 \r
 /**\r
   Remember that Fv protocol on FvHandle has had it's drivers placed on the\r
-  mDiscoveredList. This fucntion adds entries on the mFvHandleList. Items are\r
-  never removed/freed from the mFvHandleList.\r
+  mDiscoveredList. This fucntion adds entries on the mFvHandleList if new \r
+  entry is different from one in mFvHandleList by checking FvImage Guid.\r
+  Items are never removed/freed from the mFvHandleList.\r
 \r
   @param  FvHandle              The handle of a FV that has been processed\r
 \r
+  @return A point to new added FvHandle entry. If FvHandle with the same FvImage guid\r
+          has been added, NULL will return. \r
+\r
 **/\r
-VOID\r
+KNOWN_HANDLE * \r
 FvIsBeingProcesssed (\r
   IN  EFI_HANDLE    FvHandle\r
   )\r
 {\r
-  KNOWN_HANDLE  *KnownHandle;\r
+  EFI_STATUS                            Status;\r
+  EFI_GUID                              FvNameGuid;\r
+  BOOLEAN                               FvNameGuidIsFound;\r
+  UINT32                                ExtHeaderOffset;\r
+  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL    *Fvb;\r
+  EFI_FIRMWARE_VOLUME_HEADER            *FwVolHeader;\r
+  EFI_FV_BLOCK_MAP_ENTRY                *BlockMap;\r
+  UINTN                                 LbaOffset;\r
+  UINTN                                 Index;\r
+  EFI_LBA                               LbaIndex;\r
+  LIST_ENTRY                            *Link;\r
+  KNOWN_HANDLE                          *KnownHandle;\r
+\r
+  FwVolHeader = NULL;\r
 \r
-  KnownHandle = AllocatePool (sizeof (KNOWN_HANDLE));\r
+  //\r
+  // Get the FirmwareVolumeBlock protocol on that handle\r
+  //\r
+  FvNameGuidIsFound = FALSE;\r
+  Status = CoreHandleProtocol (FvHandle, &gEfiFirmwareVolumeBlockProtocolGuid, (VOID **)&Fvb);\r
+  if (!EFI_ERROR (Status)) {\r
+    //\r
+    // Get the full FV header based on FVB protocol.\r
+    //\r
+    ASSERT (Fvb != NULL);\r
+    Status = GetFwVolHeader (Fvb, &FwVolHeader);\r
+    if (!EFI_ERROR (Status)) {\r
+      ASSERT (FwVolHeader != NULL);\r
+      if (VerifyFvHeaderChecksum (FwVolHeader) && FwVolHeader->ExtHeaderOffset != 0) {\r
+        ExtHeaderOffset = (UINT32) FwVolHeader->ExtHeaderOffset;\r
+        BlockMap  = FwVolHeader->BlockMap;\r
+        LbaIndex  = 0;\r
+        LbaOffset = 0;\r
+        //\r
+        // Find LbaIndex and LbaOffset for FV extension header based on BlockMap.\r
+        //\r
+        while ((BlockMap->NumBlocks != 0) || (BlockMap->Length != 0)) {\r
+          for (Index = 0; Index < BlockMap->NumBlocks && ExtHeaderOffset >= BlockMap->Length; Index ++) {\r
+            ExtHeaderOffset -= BlockMap->Length;\r
+            LbaIndex ++;\r
+          }\r
+          //\r
+          // Check whether FvExtHeader is crossing the multi block range.\r
+          //\r
+          if (Index < BlockMap->NumBlocks) {\r
+            LbaOffset = ExtHeaderOffset;\r
+            break;\r
+          }\r
+          BlockMap++;\r
+        }\r
+        //\r
+        // Read FvNameGuid from FV extension header.\r
+        //\r
+        Status = ReadFvbData (Fvb, &LbaIndex, &LbaOffset, sizeof (FvNameGuid), (UINT8 *) &FvNameGuid);\r
+        if (!EFI_ERROR (Status)) {\r
+          FvNameGuidIsFound = TRUE;\r
+        }\r
+      }\r
+      CoreFreePool (FwVolHeader);\r
+    }\r
+  }\r
+\r
+  if (FvNameGuidIsFound) {\r
+    //\r
+    // Check whether the FV image with the found FvNameGuid has been processed.\r
+    //\r
+    for (Link = mFvHandleList.ForwardLink; Link != &mFvHandleList; Link = Link->ForwardLink) {\r
+      KnownHandle = CR(Link, KNOWN_HANDLE, Link, KNOWN_HANDLE_SIGNATURE);\r
+      if (CompareGuid (&FvNameGuid, &KnownHandle->FvNameGuid)) {\r
+        DEBUG ((EFI_D_ERROR, "FvImage on FvHandle %p and %p has the same FvNameGuid %g.\n", FvHandle, KnownHandle->Handle, &FvNameGuid));\r
+        return NULL;\r
+      }\r
+    }\r
+  }\r
+\r
+  KnownHandle = AllocateZeroPool (sizeof (KNOWN_HANDLE));\r
   ASSERT (KnownHandle != NULL);\r
 \r
   KnownHandle->Signature = KNOWN_HANDLE_SIGNATURE;\r
   KnownHandle->Handle = FvHandle;\r
+  if (FvNameGuidIsFound) {\r
+    CopyGuid (&KnownHandle->FvNameGuid, &FvNameGuid);\r
+  }\r
   InsertTailList (&mFvHandleList, &KnownHandle->Link);\r
+  return KnownHandle;\r
 }\r
 \r
 \r
@@ -844,7 +906,7 @@ CoreAddToDriverList (
   Check if a FV Image type file (EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) is\r
   described by a EFI_HOB_FIRMWARE_VOLUME2 Hob.\r
 \r
-  @param  FvHandle              The handle which FVB protocol installed on.\r
+  @param  FvNameGuid            The FV image guid specified.\r
   @param  DriverName            The driver guid specified.\r
 \r
   @retval TRUE                  This file is found in a EFI_HOB_FIRMWARE_VOLUME2\r
@@ -854,7 +916,7 @@ CoreAddToDriverList (
 **/\r
 BOOLEAN\r
 FvFoundInHobFv2 (\r
-  IN  EFI_HANDLE                      FvHandle,\r
+  IN  CONST EFI_GUID                  *FvNameGuid,\r
   IN  CONST EFI_GUID                  *DriverName\r
   )\r
 {\r
@@ -863,7 +925,11 @@ FvFoundInHobFv2 (
   HobFv2.Raw = GetHobList ();\r
 \r
   while ((HobFv2.Raw = GetNextHob (EFI_HOB_TYPE_FV2, HobFv2.Raw)) != NULL) {\r
-    if (CompareGuid (DriverName, &HobFv2.FirmwareVolume2->FileName)) {\r
+    //\r
+    // Compare parent FvNameGuid and FileGuid both.\r
+    //\r
+    if (CompareGuid (DriverName, &HobFv2.FirmwareVolume2->FileName) &&\r
+        CompareGuid (FvNameGuid, &HobFv2.FirmwareVolume2->FvName)) {\r
       return TRUE;\r
     }\r
     HobFv2.Raw = GET_NEXT_HOB (HobFv2);\r
@@ -901,6 +967,7 @@ CoreProcessFvImageFile (
   UINTN                               BufferSize;\r
   EFI_FIRMWARE_VOLUME_HEADER          *FvHeader;\r
   UINT32                              FvAlignment;\r
+  EFI_DEVICE_PATH_PROTOCOL            *FvFileDevicePath;\r
 \r
   //\r
   // Read the first (and only the first) firmware volume section\r
@@ -921,43 +988,85 @@ CoreProcessFvImageFile (
                  &AuthenticationStatus\r
                  );\r
   if (!EFI_ERROR (Status)) {\r
+     //\r
+    // Evaluate the authentication status of the Firmware Volume through\r
+    // Security Architectural Protocol\r
+    //\r
+    if (gSecurity != NULL) {\r
+      FvFileDevicePath = CoreFvToDevicePath (Fv, FvHandle, DriverName);\r
+      Status = gSecurity->FileAuthenticationState (\r
+                            gSecurity,\r
+                            AuthenticationStatus,\r
+                            FvFileDevicePath\r
+                            );\r
+      if (FvFileDevicePath != NULL) {\r
+        FreePool (FvFileDevicePath);\r
+      }\r
+\r
+      if (Status != EFI_SUCCESS) {\r
+        //\r
+        // Security check failed. The firmware volume should not be used for any purpose.\r
+        //\r
+        if (Buffer != NULL) {\r
+          FreePool (Buffer);\r
+        }\r
+        return Status;\r
+      }\r
+    }\r
+\r
     //\r
     // FvImage should be at its required alignment.\r
     //\r
     FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) Buffer;\r
     //\r
-    // Get FvHeader alignment\r
-    //\r
-    FvAlignment = 1 << ((FvHeader->Attributes & EFI_FVB2_ALIGNMENT) >> 16);\r
-    //\r
-    // FvAlignment must be greater than or equal to 8 bytes of the minimum FFS alignment value. \r
+    // If EFI_FVB2_WEAK_ALIGNMENT is set in the volume header then the first byte of the volume\r
+    // can be aligned on any power-of-two boundary. A weakly aligned volume can not be moved from\r
+    // its initial linked location and maintain its alignment.\r
     //\r
-    if (FvAlignment < 8) {\r
-      FvAlignment = 8;\r
-    }\r
-    //\r
-    // Allocate the aligned buffer for the FvImage.\r
-    //\r
-    AlignedBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize), (UINTN) FvAlignment);\r
-    if (AlignedBuffer == NULL) {\r
-      Status = EFI_OUT_OF_RESOURCES;\r
-    } else {\r
+    if ((ReadUnaligned32 (&FvHeader->Attributes) & EFI_FVB2_WEAK_ALIGNMENT) != EFI_FVB2_WEAK_ALIGNMENT) {\r
       //\r
-      // Move FvImage into the aligned buffer and release the original buffer.\r
+      // Get FvHeader alignment\r
       //\r
-      CopyMem (AlignedBuffer, Buffer, BufferSize);\r
-      CoreFreePool (Buffer);\r
-      Buffer = NULL;\r
+      FvAlignment = 1 << ((ReadUnaligned32 (&FvHeader->Attributes) & EFI_FVB2_ALIGNMENT) >> 16);\r
       //\r
-      // Produce a FVB protocol for the file\r
+      // FvAlignment must be greater than or equal to 8 bytes of the minimum FFS alignment value.\r
       //\r
-      Status = ProduceFVBProtocolOnBuffer (\r
-                (EFI_PHYSICAL_ADDRESS) (UINTN) AlignedBuffer,\r
-                (UINT64)BufferSize,\r
-                FvHandle,\r
-                NULL\r
-                );\r
+      if (FvAlignment < 8) {\r
+        FvAlignment = 8;\r
+      }\r
+\r
+      //\r
+      // Check FvImage alignment.\r
+      //\r
+      if ((UINTN) FvHeader % FvAlignment != 0) {\r
+        //\r
+        // Allocate the aligned buffer for the FvImage.\r
+        //\r
+        AlignedBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES (BufferSize), (UINTN) FvAlignment);\r
+        if (AlignedBuffer == NULL) {\r
+          FreePool (Buffer);\r
+          return EFI_OUT_OF_RESOURCES;\r
+        } else {\r
+          //\r
+          // Move FvImage into the aligned buffer and release the original buffer.\r
+          //\r
+          CopyMem (AlignedBuffer, Buffer, BufferSize);\r
+          FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *) AlignedBuffer;\r
+          CoreFreePool (Buffer);\r
+          Buffer = NULL;\r
+        }\r
+      }\r
     }\r
+    //\r
+    // Produce a FVB protocol for the file\r
+    //\r
+    Status = ProduceFVBProtocolOnBuffer (\r
+              (EFI_PHYSICAL_ADDRESS) (UINTN) FvHeader,\r
+              (UINT64)BufferSize,\r
+              FvHandle,\r
+              AuthenticationStatus,\r
+              NULL\r
+              );\r
   }\r
 \r
   if (EFI_ERROR (Status)) {\r
@@ -1003,7 +1112,6 @@ CoreFwVolEventProtocolNotify (
 {\r
   EFI_STATUS                    Status;\r
   EFI_STATUS                    GetNextFileStatus;\r
-  EFI_STATUS                    SecurityStatus;\r
   EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;\r
   EFI_DEVICE_PATH_PROTOCOL      *FvDevicePath;\r
   EFI_HANDLE                    FvHandle;\r
@@ -1021,6 +1129,9 @@ CoreFwVolEventProtocolNotify (
   UINT32                        AuthenticationStatus;\r
   UINTN                         SizeOfBuffer;\r
   VOID                          *DepexBuffer;\r
+  KNOWN_HANDLE                  *KnownHandle;\r
+\r
+  FvHandle = NULL;\r
 \r
   while (TRUE) {\r
     BufferSize = sizeof (EFI_HANDLE);\r
@@ -1048,7 +1159,14 @@ CoreFwVolEventProtocolNotify (
     //\r
     // Since we are about to process this Fv mark it as processed.\r
     //\r
-    FvIsBeingProcesssed (FvHandle);\r
+    KnownHandle = FvIsBeingProcesssed (FvHandle);\r
+    if (KnownHandle == NULL) {\r
+      //\r
+      // The FV with the same FV name guid has already been processed. \r
+      // So lets skip it!\r
+      //\r
+      continue;\r
+    }\r
 \r
     Status = CoreHandleProtocol (FvHandle, &gEfiFirmwareVolume2ProtocolGuid, (VOID **)&Fv);\r
     if (EFI_ERROR (Status) || Fv == NULL) {\r
@@ -1067,24 +1185,6 @@ CoreFwVolEventProtocolNotify (
       continue;\r
     }\r
 \r
-    //\r
-    // Evaluate the authentication status of the Firmware Volume through\r
-    // Security Architectural Protocol\r
-    //\r
-    if (gSecurity != NULL) {\r
-      SecurityStatus = gSecurity->FileAuthenticationState (\r
-                                    gSecurity,\r
-                                    0,\r
-                                    FvDevicePath\r
-                                    );\r
-      if (SecurityStatus != EFI_SUCCESS) {\r
-        //\r
-        // Security check failed. The firmware volume should not be used for any purpose.\r
-        //\r
-        continue;\r
-      }\r
-    }\r
-\r
     //\r
     // Discover Drivers in FV and add them to the Discovered Driver List.\r
     // Process EFI_FV_FILETYPE_DRIVER type and then EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER\r
@@ -1131,30 +1231,7 @@ CoreFwVolEventProtocolNotify (
             // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has already\r
             // been extracted.\r
             //\r
-            if (FvFoundInHobFv2 (FvHandle, &NameGuid)) {\r
-              continue;\r
-            }\r
-\r
-            //\r
-            // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has PEI depex section.\r
-            //\r
-            DepexBuffer  = NULL;\r
-            SizeOfBuffer = 0;\r
-            Status = Fv->ReadSection (\r
-                           Fv,\r
-                           &NameGuid,\r
-                           EFI_SECTION_PEI_DEPEX,\r
-                           0,\r
-                           &DepexBuffer,\r
-                           &SizeOfBuffer,\r
-                           &AuthenticationStatus\r
-                           );\r
-            if (!EFI_ERROR (Status)) {\r
-              //\r
-              // If PEI depex section is found, this FV image will be ignored in DXE phase.\r
-              // Now, DxeCore doesn't support FV image with more one type DEPEX section.\r
-              //\r
-              FreePool (DepexBuffer);\r
+            if (FvFoundInHobFv2 (&KnownHandle->FvNameGuid, &NameGuid)) {\r
               continue;\r
             }\r
 \r
@@ -1174,11 +1251,11 @@ CoreFwVolEventProtocolNotify (
                            );\r
             if (!EFI_ERROR (Status)) {\r
               //\r
-              // If SMM depex section is found, this FV image will be ignored in DXE phase.\r
-              // Now, DxeCore doesn't support FV image with more one type DEPEX section.\r
+              // If SMM depex section is found, this FV image is invalid to be supported.\r
+              // ASSERT FALSE to report this FV image.  \r
               //\r
               FreePool (DepexBuffer);\r
-              continue;\r
+              ASSERT (FALSE);\r
             }\r
 \r
             //\r