MdeModulePkg: Add MemoryAttributesTable generation.
authorjiewen yao <jiewen.yao@intel.com>
Fri, 29 Jan 2016 08:52:14 +0000 (16:52 +0800)
committerjiewen yao <jiewen.yao@intel.com>
Tue, 16 Feb 2016 23:28:49 +0000 (07:28 +0800)
Add MemoryAttributesTable generation in DxeCore.
We leverage the information collected by original
PropertiesTable, and publish runtime code/data to
another standalone table. So that this is a
compatible solution to report more PE Code/Data
information.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: "Yao, Jiewen" <jiewen.yao@intel.com>
Reviewed-by: "Gao, Liming" <liming.gao@intel.com>
MdeModulePkg/Core/Dxe/Misc/MemoryAttributesTable.c [new file with mode: 0644]

diff --git a/MdeModulePkg/Core/Dxe/Misc/MemoryAttributesTable.c b/MdeModulePkg/Core/Dxe/Misc/MemoryAttributesTable.c
new file mode 100644 (file)
index 0000000..c84146a
--- /dev/null
@@ -0,0 +1,214 @@
+/** @file\r
+  UEFI MemoryAttributesTable support\r
+\r
+Copyright (c) 2016, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include <PiDxe.h>\r
+#include <Library/BaseLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/DxeServicesTableLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/UefiLib.h>\r
+\r
+#include <Guid/EventGroup.h>\r
+\r
+#include <Guid/MemoryAttributesTable.h>\r
+#include <Guid/PropertiesTable.h>\r
+\r
+#include "DxeMain.h"\r
+\r
+/**\r
+  This function for GetMemoryMap() with properties table capability.\r
+\r
+  It calls original GetMemoryMap() to get the original memory map information. Then\r
+  plus the additional memory map entries for PE Code/Data seperation.\r
+\r
+  @param  MemoryMapSize          A pointer to the size, in bytes, of the\r
+                                 MemoryMap buffer. On input, this is the size of\r
+                                 the buffer allocated by the caller.  On output,\r
+                                 it is the size of the buffer returned by the\r
+                                 firmware  if the buffer was large enough, or the\r
+                                 size of the buffer needed  to contain the map if\r
+                                 the buffer was too small.\r
+  @param  MemoryMap              A pointer to the buffer in which firmware places\r
+                                 the current memory map.\r
+  @param  MapKey                 A pointer to the location in which firmware\r
+                                 returns the key for the current memory map.\r
+  @param  DescriptorSize         A pointer to the location in which firmware\r
+                                 returns the size, in bytes, of an individual\r
+                                 EFI_MEMORY_DESCRIPTOR.\r
+  @param  DescriptorVersion      A pointer to the location in which firmware\r
+                                 returns the version number associated with the\r
+                                 EFI_MEMORY_DESCRIPTOR.\r
+\r
+  @retval EFI_SUCCESS            The memory map was returned in the MemoryMap\r
+                                 buffer.\r
+  @retval EFI_BUFFER_TOO_SMALL   The MemoryMap buffer was too small. The current\r
+                                 buffer size needed to hold the memory map is\r
+                                 returned in MemoryMapSize.\r
+  @retval EFI_INVALID_PARAMETER  One of the parameters has an invalid value.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+CoreGetMemoryMapPropertiesTable (\r
+  IN OUT UINTN                  *MemoryMapSize,\r
+  IN OUT EFI_MEMORY_DESCRIPTOR  *MemoryMap,\r
+  OUT UINTN                     *MapKey,\r
+  OUT UINTN                     *DescriptorSize,\r
+  OUT UINT32                    *DescriptorVersion\r
+  );\r
+\r
+extern EFI_PROPERTIES_TABLE  mPropertiesTable;\r
+\r
+BOOLEAN         mIsConstructingMemoryAttributesTable = FALSE;\r
+\r
+/**\r
+  Install MemoryAttributesTable.\r
+\r
+  @param[in]  Event     The Event this notify function registered to.\r
+  @param[in]  Context   Pointer to the context data registered to the Event.\r
+**/\r
+VOID\r
+EFIAPI\r
+InstallMemoryAttributesTable (\r
+  EFI_EVENT                               Event,\r
+  VOID                                    *Context\r
+  )\r
+{\r
+  UINTN                          MemoryMapSize;\r
+  EFI_MEMORY_DESCRIPTOR          *MemoryMap;\r
+  EFI_MEMORY_DESCRIPTOR          *MemoryMapStart;\r
+  UINTN                          MapKey;\r
+  UINTN                          DescriptorSize;\r
+  UINT32                         DescriptorVersion;\r
+  UINTN                          Index;\r
+  EFI_STATUS                     Status;\r
+  UINT32                         RuntimeEntryCount;\r
+  EFI_MEMORY_ATTRIBUTES_TABLE    *MemoryAttributesTable;\r
+  EFI_MEMORY_DESCRIPTOR          *MemoryAttributesEntry;\r
+\r
+  if ((mPropertiesTable.MemoryProtectionAttribute & EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA) == 0) {\r
+    DEBUG ((EFI_D_VERBOSE, "MemoryProtectionAttribute NON_EXECUTABLE_PE_DATA is not set, "));\r
+    DEBUG ((EFI_D_VERBOSE, "because Runtime Driver Section Alignment is not %dK.\n", EFI_ACPI_RUNTIME_PAGE_ALLOCATION_ALIGNMENT >> 10));\r
+    return ;\r
+  }\r
+\r
+  mIsConstructingMemoryAttributesTable = TRUE;\r
+\r
+  MemoryMapSize = 0;\r
+  MemoryMap = NULL;\r
+  Status = CoreGetMemoryMapPropertiesTable (\r
+             &MemoryMapSize,\r
+             MemoryMap,\r
+             &MapKey,\r
+             &DescriptorSize,\r
+             &DescriptorVersion\r
+             );\r
+  ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r
+\r
+  do {\r
+    MemoryMap = AllocatePool (MemoryMapSize);\r
+    ASSERT (MemoryMap != NULL);\r
+\r
+    Status = CoreGetMemoryMapPropertiesTable (\r
+               &MemoryMapSize,\r
+               MemoryMap,\r
+               &MapKey,\r
+               &DescriptorSize,\r
+               &DescriptorVersion\r
+               );\r
+    if (EFI_ERROR (Status)) {\r
+      FreePool (MemoryMap);\r
+    }\r
+  } while (Status == EFI_BUFFER_TOO_SMALL);\r
+\r
+  MemoryMapStart = MemoryMap;\r
+  RuntimeEntryCount = 0;\r
+  for (Index = 0; Index < MemoryMapSize/DescriptorSize; Index++) {\r
+    switch (MemoryMap->Type) {\r
+    case EfiRuntimeServicesCode:\r
+    case EfiRuntimeServicesData:\r
+      RuntimeEntryCount ++;\r
+      break;\r
+    }\r
+    MemoryMap = NEXT_MEMORY_DESCRIPTOR(MemoryMap, DescriptorSize);\r
+  }\r
+\r
+  //\r
+  // Allocate MemoryAttributesTable\r
+  //\r
+  MemoryAttributesTable = AllocatePool (sizeof(EFI_MEMORY_ATTRIBUTES_TABLE) + DescriptorSize * RuntimeEntryCount);\r
+  ASSERT (MemoryAttributesTable != NULL);\r
+  MemoryAttributesTable->Version         = EFI_MEMORY_ATTRIBUTES_TABLE_VERSION;\r
+  MemoryAttributesTable->NumberOfEntries = RuntimeEntryCount;\r
+  MemoryAttributesTable->DescriptorSize  = (UINT32)DescriptorSize;\r
+  MemoryAttributesTable->Reserved        = 0;\r
+  DEBUG ((EFI_D_VERBOSE, "MemoryAttributesTable:\n"));\r
+  DEBUG ((EFI_D_VERBOSE, "  Version              - 0x%08x\n", MemoryAttributesTable->Version));\r
+  DEBUG ((EFI_D_VERBOSE, "  NumberOfEntries      - 0x%08x\n", MemoryAttributesTable->NumberOfEntries));\r
+  DEBUG ((EFI_D_VERBOSE, "  DescriptorSize       - 0x%08x\n", MemoryAttributesTable->DescriptorSize));\r
+  MemoryAttributesEntry = (EFI_MEMORY_DESCRIPTOR *)(MemoryAttributesTable + 1);\r
+  MemoryMap = MemoryMapStart;\r
+  for (Index = 0; Index < MemoryMapSize/DescriptorSize; Index++) {\r
+    switch (MemoryMap->Type) {\r
+    case EfiRuntimeServicesCode:\r
+    case EfiRuntimeServicesData:\r
+      CopyMem (MemoryAttributesEntry, MemoryMap, DescriptorSize);\r
+      MemoryAttributesEntry->Attribute &= (EFI_MEMORY_RO|EFI_MEMORY_XP|EFI_MEMORY_RUNTIME);\r
+      DEBUG ((EFI_D_VERBOSE, "Entry (0x%x)\n", MemoryAttributesEntry));\r
+      DEBUG ((EFI_D_VERBOSE, "  Type              - 0x%x\n", MemoryAttributesEntry->Type));\r
+      DEBUG ((EFI_D_VERBOSE, "  PhysicalStart     - 0x%016lx\n", MemoryAttributesEntry->PhysicalStart));\r
+      DEBUG ((EFI_D_VERBOSE, "  VirtualStart      - 0x%016lx\n", MemoryAttributesEntry->VirtualStart));\r
+      DEBUG ((EFI_D_VERBOSE, "  NumberOfPages     - 0x%016lx\n", MemoryAttributesEntry->NumberOfPages));\r
+      DEBUG ((EFI_D_VERBOSE, "  Attribute         - 0x%016lx\n", MemoryAttributesEntry->Attribute));\r
+      MemoryAttributesEntry = NEXT_MEMORY_DESCRIPTOR(MemoryAttributesEntry, DescriptorSize);\r
+      break;\r
+    }\r
+    MemoryMap = NEXT_MEMORY_DESCRIPTOR(MemoryMap, DescriptorSize);\r
+  }\r
+\r
+  Status = gBS->InstallConfigurationTable (&gEfiMemoryAttributesTableGuid, MemoryAttributesTable);\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  mIsConstructingMemoryAttributesTable = FALSE;\r
+}\r
+\r
+/**\r
+  Initialize MemoryAttrubutesTable support.\r
+**/\r
+VOID\r
+EFIAPI\r
+CoreInitializeMemoryAttributesTable (\r
+  VOID\r
+  )\r
+{\r
+  EFI_STATUS  Status;\r
+  EFI_EVENT   ReadyToBootEvent;\r
+\r
+  //\r
+  // Construct the table at ReadyToBoot, because this should be\r
+  // last point to allocate RuntimeCode/RuntimeData.\r
+  //\r
+  Status = gBS->CreateEventEx (\r
+                  EVT_NOTIFY_SIGNAL,\r
+                  TPL_NOTIFY,\r
+                  InstallMemoryAttributesTable,\r
+                  NULL,\r
+                  &gEfiEventReadyToBootGuid,\r
+                  &ReadyToBootEvent\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
+  return ;\r
+}\r