Add UEFI 2.5 properties table support in DXE core.

Add PropertiesTableAttributesDxe driver to set ACPINvs/Reserved memory type to be XP, as default policy.

Contributed-under: TianoCore Contribution Agreement 1.0

Signed-off-by: "Yao, Jiewen" <Jiewen.yao@intel.com>
Reviewed-by: "Zeng, Star" <Star.Zeng@intel.com>
Reviewed-by: "Gao, Liming" <Liming.Gao@intel.com>

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

MdeModulePkg/Core/Dxe/DxeMain.h

@@ -2858,4 +2858,33 @@ CoreUpdateMemoryAttributes (
   IN UINT64                NewAttributes
   );
 
+/**
+  Initialize PropertiesTable support.
+**/
+VOID
+EFIAPI
+CoreInitializePropertiesTable (
+  VOID
+  );
+
+/**
+  Insert image record.
+
+  @param  RuntimeImage    Runtime image information
+**/
+VOID
+InsertImageRecord (
+  IN EFI_RUNTIME_IMAGE_ENTRY  *RuntimeImage
+  );
+
+/**
+  Remove Image record.
+
+  @param  RuntimeImage    Runtime image information
+**/
+VOID
+RemoveImageRecord (
+  IN EFI_RUNTIME_IMAGE_ENTRY  *RuntimeImage
+  );
+
 #endif

MdeModulePkg/Core/Dxe/DxeMain.inf

@@ -40,6 +40,7 @@
   Misc/Stall.c
   Misc/SetWatchdogTimer.c
   Misc/InstallConfigurationTable.c
+  Misc/PropertiesTable.c
   Library/Library.c
   Hand/DriverSupport.c
   Hand/Notify.c
@@ -123,6 +124,8 @@
   gEfiVectorHandoffTableGuid                    ## SOMETIMES_PRODUCES   ## SystemTable
   gEdkiiMemoryProfileGuid                       ## SOMETIMES_PRODUCES   ## GUID # Install protocol
   gZeroGuid                                     ## SOMETIMES_CONSUMES   ## GUID
+  gEfiPropertiesTableGuid                       ## SOMETIMES_PRODUCES   ## SystemTable
+  gEfiEndOfDxeEventGroupGuid                    ## SOMETIMES_CONSUMES   ## Event
 
 [Ppis]
   gEfiVectorHandoffInfoPpiGuid                  ## UNDEFINED # HOB
@@ -182,6 +185,7 @@
   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxEfiSystemTablePointerAddress         ## CONSUMES
   gEfiMdeModulePkgTokenSpaceGuid.PcdMemoryProfileMemoryType                 ## CONSUMES
   gEfiMdeModulePkgTokenSpaceGuid.PcdMemoryProfilePropertyMask               ## CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PropertiesTableEnable                      ## CONSUMES
 
 # [Hob]
 # RESOURCE_DESCRIPTOR   ## CONSUMES

MdeModulePkg/Core/Dxe/DxeMain/DxeMain.c

@@ -387,6 +387,8 @@ DxeMain (
 
   MemoryProfileInstallProtocol ();
 
+  CoreInitializePropertiesTable ();
+
   //
   // Get persisted vector hand-off info from GUIDeed HOB again due to HobStart may be updated,
   // and install configuration table

MdeModulePkg/Core/Dxe/Image/Image.c

@@ -710,6 +710,7 @@ CoreLoadPeImage (
       Image->RuntimeData->RelocationData = Image->ImageContext.FixupData;
       Image->RuntimeData->Handle         = Image->Handle;
       InsertTailList (&gRuntime->ImageHead, &Image->RuntimeData->Link);
+      InsertImageRecord (Image->RuntimeData);
     }
   }
 
@@ -952,6 +953,7 @@ CoreUnloadAndCloseImage (
       // Remove the Image from the Runtime Image list as we are about to Free it!
       //
       RemoveEntryList (&Image->RuntimeData->Link);
+      RemoveImageRecord (Image->RuntimeData);
     }
     CoreFreePool (Image->RuntimeData);
   }

MdeModulePkg/MdeModulePkg.dec

@@ -1261,6 +1261,28 @@
   # @Prompt Flag to request system reboot after processing capsule.
   gEfiMdeModulePkgTokenSpaceGuid.PcdSystemRebootAfterCapsuleProcessFlag|0x0001|UINT16|0x0000006d
 
+  ## Publish PropertiesTable or not.
+  #
+  # If this PCD is TRUE, DxeCore publishs PropertiesTable.
+  # DxeCore evaluates if all runtime drivers has 4K aligned PE sections. If all
+  # PE sections in runtime drivers are 4K aligned, DxeCore sets BIT0 in
+  # PropertiesTable. Or DxeCore clears BIT0 in PropertiesTable.
+  # If this PCD is FALSE, DxeCore does not publish PropertiesTable.
+  #
+  # If PropertiesTable has BIT0 set, DxeCore uses below policy in UEFI memory map:
+  #   1) Use EfiRuntimeServicesCode for runtime driver PE image code section and
+  #      use EfiRuntimeServicesData for runtime driver PE image header and other section.
+  #   2) Set EfiRuntimeServicesCode to be EFI_MEMORY_RO.
+  #   3) Set EfiRuntimeServicesData to be EFI_MEMORY_XP.
+  #   4) Set EfiMemoryMappedIO and EfiMemoryMappedIOPortSpace to be EFI_MEMORY_XP.
+  #
+  # NOTE: Platform need gurantee this PCD is set correctly. Platform should set
+  # this PCD to be TURE if and only if all runtime driver has seperated Code/Data
+  # section. If PE code/data sections are merged, the result is unpredictable.
+  #
+  # @Prompt Publish UEFI PropertiesTable.
+  gEfiMdeModulePkgTokenSpaceGuid.PropertiesTableEnable|TRUE|BOOLEAN|0x0000006e
+
   ## Default OEM ID for ACPI table creation, its length must be 0x6 bytes to follow ACPI specification.
   # @Prompt Default OEM ID for ACPI table creation.
   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemId|"INTEL "|VOID*|0x30001034

MdeModulePkg/MdeModulePkg.dsc

@@ -356,6 +356,8 @@
 
   MdeModulePkg/Universal/FvSimpleFileSystemDxe/FvSimpleFileSystemDxe.inf
   MdeModulePkg/Universal/EsrtDxe/EsrtDxe.inf
+  
+  MdeModulePkg/Universal/PropertiesTableAttributesDxe/PropertiesTableAttributesDxe.inf
 
 [Components.IA32, Components.X64, Components.IPF]  
   MdeModulePkg/Universal/Network/UefiPxeBcDxe/UefiPxeBcDxe.inf

MdeModulePkg/Universal/PropertiesTableAttributesDxe/PropertiesTableAttributesDxe.c

@@ -0,0 +1,206 @@
+/**@file
+  This module sets default policy for attributes of EfiACPIMemoryNVS and EfiReservedMemoryType.
+
+  This module sets EFI_MEMORY_XP for attributes of EfiACPIMemoryNVS and EfiReservedMemoryType
+  in UEFI memory map, if and only of PropertiesTable is published and has BIT0 set.
+
+Copyright (c) 2015, 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
+http://opensource.org/licenses/bsd-license.php
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#include <Uefi.h>
+#include <Library/DebugLib.h>
+#include <Library/UefiBootServicesTableLib.h>
+#include <Library/DxeServicesTableLib.h>
+#include <Library/UefiLib.h>
+#include <Library/MemoryAllocationLib.h>
+#include <Guid/EventGroup.h>
+#include <Guid/PropertiesTable.h>
+
+/**
+  Converts a number of EFI_PAGEs to a size in bytes.
+
+  NOTE: Do not use EFI_PAGES_TO_SIZE because it handles UINTN only.
+
+  @param  Pages     The number of EFI_PAGES.
+
+  @return  The number of bytes associated with the number of EFI_PAGEs specified
+           by Pages.
+**/
+UINT64
+EfiPagesToSize (
+  IN UINT64 Pages
+  )
+{
+  return LShiftU64 (Pages, EFI_PAGE_SHIFT);
+}
+
+/**
+  Set memory attributes according to default policy.
+
+  @param  MemoryMap        A pointer to the buffer in which firmware places the current memory map.
+  @param  MemoryMapSize    Size, in bytes, of the MemoryMap buffer.
+  @param  DescriptorSize   size, in bytes, of an individual EFI_MEMORY_DESCRIPTOR.
+**/
+VOID
+SetMemorySpaceAttributesDefault (
+  IN EFI_MEMORY_DESCRIPTOR  *MemoryMap,
+  IN UINTN                  MemoryMapSize,
+  IN UINTN                  DescriptorSize
+  )
+{
+  EFI_MEMORY_DESCRIPTOR       *MemoryMapEntry;
+  EFI_MEMORY_DESCRIPTOR       *MemoryMapEnd;
+  EFI_STATUS                  Status;
+
+  DEBUG ((EFI_D_INFO, "SetMemorySpaceAttributesDefault\n"));
+
+  MemoryMapEntry = MemoryMap;
+  MemoryMapEnd   = (EFI_MEMORY_DESCRIPTOR *) ((UINT8 *) MemoryMap + MemoryMapSize);
+  while ((UINTN)MemoryMapEntry < (UINTN)MemoryMapEnd) {
+    if (MemoryMapEntry->PhysicalStart < BASE_1MB) {
+      //
+      // Do not touch memory space below 1MB
+      //
+      MemoryMapEntry = NEXT_MEMORY_DESCRIPTOR (MemoryMapEntry, DescriptorSize);
+      continue;
+    }
+    switch (MemoryMapEntry->Type) {
+    case EfiRuntimeServicesCode:
+    case EfiRuntimeServicesData:
+      //
+      // should be handled later;
+      //
+      break;
+    case EfiReservedMemoryType:
+    case EfiACPIMemoryNVS:
+      //
+      // Handle EfiReservedMemoryType and EfiACPIMemoryNVS, because there might be firmware executable there.
+      //
+      DEBUG ((EFI_D_INFO, "SetMemorySpaceAttributes - %016lx - %016lx (%016lx) ...\n",
+        MemoryMapEntry->PhysicalStart,
+        MemoryMapEntry->PhysicalStart + EfiPagesToSize (MemoryMapEntry->NumberOfPages),
+        MemoryMapEntry->Attribute
+        ));
+      Status = gDS->SetMemorySpaceCapabilities (
+                      MemoryMapEntry->PhysicalStart,
+                      EfiPagesToSize (MemoryMapEntry->NumberOfPages),
+                      MemoryMapEntry->Attribute | EFI_MEMORY_XP
+                      );
+      DEBUG ((EFI_D_INFO, "SetMemorySpaceCapabilities - %r\n", Status));
+      break;
+    }
+
+    MemoryMapEntry = NEXT_MEMORY_DESCRIPTOR (MemoryMapEntry, DescriptorSize);
+  }
+
+  return ;
+}
+
+/**
+  Update memory attributes according to default policy.
+
+  @param[in]  Event     The Event this notify function registered to.
+  @param[in]  Context   Pointer to the context data registered to the Event.
+**/
+VOID
+EFIAPI
+UpdateMemoryAttributesDefault (
+  EFI_EVENT                               Event,
+  VOID                                    *Context
+  )
+{
+  EFI_STATUS                  Status;
+  EFI_MEMORY_DESCRIPTOR       *MemoryMap;
+  UINTN                       MemoryMapSize;
+  UINTN                       MapKey;
+  UINTN                       DescriptorSize;
+  UINT32                      DescriptorVersion;
+  EFI_PROPERTIES_TABLE        *PropertiesTable;
+
+  DEBUG ((EFI_D_INFO, "UpdateMemoryAttributesDefault\n"));
+  Status = EfiGetSystemConfigurationTable (&gEfiPropertiesTableGuid, &PropertiesTable);
+  if (EFI_ERROR (Status)) {
+    goto Done;
+  }
+
+  DEBUG ((EFI_D_INFO, "MemoryProtectionAttribute - 0x%016lx\n", PropertiesTable->MemoryProtectionAttribute));
+  if ((PropertiesTable->MemoryProtectionAttribute & EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA) == 0) {
+    goto Done;
+  }
+
+  //
+  // Get the EFI memory map.
+  //
+  MemoryMapSize  = 0;
+  MemoryMap      = NULL;
+  Status = gBS->GetMemoryMap (
+                  &MemoryMapSize,
+                  MemoryMap,
+                  &MapKey,
+                  &DescriptorSize,
+                  &DescriptorVersion
+                  );
+  ASSERT (Status == EFI_BUFFER_TOO_SMALL);
+  do {
+    MemoryMap = (EFI_MEMORY_DESCRIPTOR *) AllocatePool (MemoryMapSize);
+    ASSERT (MemoryMap != NULL);
+    Status = gBS->GetMemoryMap (
+                    &MemoryMapSize,
+                    MemoryMap,
+                    &MapKey,
+                    &DescriptorSize,
+                    &DescriptorVersion
+                    );
+    if (EFI_ERROR (Status)) {
+      FreePool (MemoryMap);
+    }
+  } while (Status == EFI_BUFFER_TOO_SMALL);
+  ASSERT_EFI_ERROR (Status);
+
+  SetMemorySpaceAttributesDefault (MemoryMap, MemoryMapSize, DescriptorSize);
+
+Done:
+  gBS->CloseEvent (Event);
+
+  return ;
+}
+
+/**
+  The entrypoint of properties table attribute driver.
+
+  @param  ImageHandle    The firmware allocated handle for the EFI image.
+  @param  SystemTable    A pointer to the EFI System Table.
+
+  @retval EFI_SUCCESS    It always returns EFI_SUCCESS.
+
+**/
+EFI_STATUS
+EFIAPI
+InitializePropertiesTableAttributesDxe (
+  IN EFI_HANDLE        ImageHandle,
+  IN EFI_SYSTEM_TABLE  *SystemTable
+  )
+{
+  EFI_STATUS  Status;
+  EFI_EVENT   ReadyToBootEvent;
+
+  Status = gBS->CreateEventEx (
+                  EVT_NOTIFY_SIGNAL,
+                  TPL_CALLBACK,
+                  UpdateMemoryAttributesDefault,
+                  NULL,
+                  &gEfiEventReadyToBootGuid,
+                  &ReadyToBootEvent
+                  );
+  ASSERT_EFI_ERROR (Status);
+
+  return EFI_SUCCESS;
+}

MdeModulePkg/Universal/PropertiesTableAttributesDxe/PropertiesTableAttributesDxe.inf

@@ -0,0 +1,57 @@
+## @file
+#
+# This module sets default policy for attributes of EfiACPIMemoryNVS and EfiReservedMemoryType.
+#
+# This module sets EFI_MEMORY_XP for attributes of EfiACPIMemoryNVS and EfiReservedMemoryType
+# in UEFI memory map, if and only of PropertiesTable is published and has BIT0 set.
+#
+# Copyright (c) 2015, 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
+#  http://opensource.org/licenses/bsd-license.php
+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+#
+#
+##
+
+[Defines]
+  INF_VERSION                    = 0x00010005
+  BASE_NAME                      = PropertiesTableAttributesDxe
+  MODULE_UNI_FILE                = PropertiesTableAttributesDxe.uni
+  FILE_GUID                      = AA48FBB2-9F87-4DFD-B416-575938F0C8F4
+  MODULE_TYPE                    = DXE_DRIVER
+  VERSION_STRING                 = 1.0
+  ENTRY_POINT                    = InitializePropertiesTableAttributesDxe
+
+#
+# The following information is for reference only and not required by the build tools.
+#
+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC
+#
+
+[Sources]
+  PropertiesTableAttributesDxe.c
+
+[Packages]
+  MdePkg/MdePkg.dec
+
+[LibraryClasses]
+  UefiDriverEntryPoint
+  UefiBootServicesTableLib
+  DxeServicesTableLib
+  DebugLib
+  UefiLib
+  MemoryAllocationLib
+
+[Guids]
+  gEfiEventReadyToBootGuid                      ## CONSUMES ## Event
+  gEfiPropertiesTableGuid                       ## CONSUMES ## SystemTable
+
+[Depex]
+  TRUE
+
+[UserExtensions.TianoCore."ExtraFiles"]
+  PropertiesTableAttributesDxeExtra.uni