MdeModulePkg: Update DumpImageRecord() in ImagePropertiesRecordLib

Update DumpImageRecord() to be DumpImageRecords(), and improve
the debug output. The function will output at DEBUG_INFO instead,
and the function will be run in DXE and SMM
MAT logic when the MAT is installed at EndOfDxe on DEBUG builds.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Dandan Bi <dandan.bi@intel.com>
Cc: Jiaxin Wu <jiaxin.wu@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Signed-off-by: Taylor Beebe <taylor.d.beebe@gmail.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

6 files changed, 137 insertions, 23 deletions

diff --git a/MdeModulePkg/Core/Dxe/Misc/MemoryAttributesTable.c b/MdeModulePkg/Core/Dxe/Misc/MemoryAttributesTable.c
index 993db28106..e9343a2c4e 100644
--- a/MdeModulePkg/Core/Dxe/Misc/MemoryAttributesTable.c
+++ b/MdeModulePkg/Core/Dxe/Misc/MemoryAttributesTable.c
@@ -284,6 +284,15 @@ InstallMemoryAttributesTableOnEndOfDxe (
 {

   mMemoryAttributesTableEndOfDxe = TRUE;

   InstallMemoryAttributesTable ();

+

+  DEBUG_CODE_BEGIN ();

+  if ( mImagePropertiesPrivateData.ImageRecordCount > 0) {

+    DEBUG ((DEBUG_INFO, "DXE - Total Runtime Image Count: 0x%x\n", mImagePropertiesPrivateData.ImageRecordCount));

+    DEBUG ((DEBUG_INFO, "DXE - Dump Runtime Image Records:\n"));

+    DumpImageRecords (&mImagePropertiesPrivateData.ImageRecordList);

+  }

+

+  DEBUG_CODE_END ();

 }

 

 /**

diff --git a/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c b/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
index 03de9b2c5f..28fe74ecc4 100644
--- a/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
+++ b/MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c
@@ -496,9 +496,14 @@ SmmInstallMemoryAttributesTable (
     return EFI_SUCCESS;

   }

 

-  DEBUG ((DEBUG_VERBOSE, "SMM Total Image Count - 0x%x\n", mImagePropertiesPrivateData.ImageRecordCount));

-  DEBUG ((DEBUG_VERBOSE, "SMM Dump ImageRecord:\n"));

-  DumpImageRecord (&mImagePropertiesPrivateData.ImageRecordList);

+  DEBUG_CODE_BEGIN ();

+  if ( mImagePropertiesPrivateData.ImageRecordCount > 0) {

+    DEBUG ((DEBUG_INFO, "SMM - Total Runtime Image Count - 0x%x\n", mImagePropertiesPrivateData.ImageRecordCount));

+    DEBUG ((DEBUG_INFO, "SMM - Dump Runtime Image Records:\n"));

+    DumpImageRecords (&mImagePropertiesPrivateData.ImageRecordList);

+  }

+

+  DEBUG_CODE_END ();

 

   PublishMemoryAttributesTable ();

 

diff --git a/MdeModulePkg/Include/Library/ImagePropertiesRecordLib.h b/MdeModulePkg/Include/Library/ImagePropertiesRecordLib.h
index 5090a52153..87c94c7237 100644
--- a/MdeModulePkg/Include/Library/ImagePropertiesRecordLib.h
+++ b/MdeModulePkg/Include/Library/ImagePropertiesRecordLib.h
@@ -182,13 +182,13 @@ FindImageRecord (
   );

 

 /**

-  Dump image record.

+  Debug dumps the input list of IMAGE_PROPERTIES_RECORD structs.

 

-  @param[in]  ImageRecordList  A list of IMAGE_PROPERTIES_RECORD entries

+  @param[in]  ImageRecordList   Head of the IMAGE_PROPERTIES_RECORD list

 **/

 VOID

 EFIAPI

-DumpImageRecord (

+DumpImageRecords (

   IN LIST_ENTRY  *ImageRecordList

   );

 

diff --git a/MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.c b/MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.c
index 6c5eb1dc31..e53ce086c5 100644
--- a/MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.c
+++ b/MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.c
@@ -14,6 +14,7 @@
 #include <Library/BaseMemoryLib.h>

 #include <Library/DebugLib.h>

 #include <Library/MemoryAllocationLib.h>

+#include <Library/PeCoffGetEntryPointLib.h>

 #include <Library/ImagePropertiesRecordLib.h>

 

 #define PREVIOUS_MEMORY_DESCRIPTOR(MemoryDescriptor, Size) \

@@ -785,31 +786,128 @@ SortImageRecord (
 }

 

 /**

-  Dump image record.

+  Extract the .efi filename out of the input PDB.

 

-  @param[in]  ImageRecordList  A list of IMAGE_PROPERTIES_RECORD entries

+  @param[in]      PdbPointer      Pointer to the PDB file path.

+  @param[out]     EfiFileName     Pointer to the .efi filename.

+  @param[in]      EfiFileNameSize Size of the .efi filename buffer.

+**/

+STATIC

+VOID

+GetFilename (

+  IN CHAR8   *PdbPointer,

+  OUT CHAR8  *EfiFileName,

+  IN UINTN   EfiFileNameSize

+  )

+{

+  UINTN  Index;

+  UINTN  StartIndex;

+

+  if ((PdbPointer == NULL) || (EfiFileNameSize < 5)) {

+    return;

+  }

+

+  // Print Module Name by Pdb file path.

+  StartIndex = 0;

+  for (Index = 0; PdbPointer[Index] != 0; Index++) {

+    if ((PdbPointer[Index] == '\\') || (PdbPointer[Index] == '/')) {

+      StartIndex = Index + 1;

+    }

+  }

+

+  // Copy the PDB file name to EfiFileName and replace .pdb with .efi

+  for (Index = 0; Index < EfiFileNameSize - 4; Index++) {

+    EfiFileName[Index] = PdbPointer[Index + StartIndex];

+    if (EfiFileName[Index] == 0) {

+      EfiFileName[Index] = '.';

+    }

+

+    if (EfiFileName[Index] == '.') {

+      EfiFileName[Index + 1] = 'e';

+      EfiFileName[Index + 2] = 'f';

+      EfiFileName[Index + 3] = 'i';

+      EfiFileName[Index + 4] = 0;

+      break;

+    }

+  }

+

+  if (Index == sizeof (EfiFileName) - 4) {

+    EfiFileName[Index] = 0;

+  }

+}

+

+/**

+  Debug dumps the input list of IMAGE_PROPERTIES_RECORD structs.

+

+  @param[in]  ImageRecordList   Head of the IMAGE_PROPERTIES_RECORD list

 **/

 VOID

 EFIAPI

-DumpImageRecord (

+DumpImageRecords (

   IN LIST_ENTRY  *ImageRecordList

   )

 {

-  IMAGE_PROPERTIES_RECORD  *ImageRecord;

-  LIST_ENTRY               *ImageRecordLink;

-  UINTN                    Index;

+  LIST_ENTRY                            *ImageRecordLink;

+  IMAGE_PROPERTIES_RECORD               *CurrentImageRecord;

+  LIST_ENTRY                            *CodeSectionLink;

+  IMAGE_PROPERTIES_RECORD_CODE_SECTION  *CurrentCodeSection;

+  CHAR8                                 *PdbPointer;

+  CHAR8                                 EfiFileName[256];

 

-  for (ImageRecordLink = ImageRecordList->ForwardLink, Index = 0;

-       ImageRecordLink != ImageRecordList;

-       ImageRecordLink = ImageRecordLink->ForwardLink, Index++)

-  {

-    ImageRecord = CR (

-                    ImageRecordLink,

-                    IMAGE_PROPERTIES_RECORD,

-                    Link,

-                    IMAGE_PROPERTIES_RECORD_SIGNATURE

-                    );

-    DEBUG ((DEBUG_VERBOSE, "Image[%d]: 0x%016lx - 0x%016lx\n", Index, ImageRecord->ImageBase, ImageRecord->ImageSize));

+  if (ImageRecordList == NULL) {

+    return;

+  }

+

+  ImageRecordLink = ImageRecordList->ForwardLink;

+

+  while (ImageRecordLink != ImageRecordList) {

+    CurrentImageRecord = CR (

+                           ImageRecordLink,

+                           IMAGE_PROPERTIES_RECORD,

+                           Link,

+                           IMAGE_PROPERTIES_RECORD_SIGNATURE

+                           );

+

+    PdbPointer = PeCoffLoaderGetPdbPointer ((VOID *)(UINTN)CurrentImageRecord->ImageBase);

+    if (PdbPointer != NULL) {

+      GetFilename (PdbPointer, EfiFileName, sizeof (EfiFileName));

+      DEBUG ((

+        DEBUG_INFO,

+        "%a: 0x%llx - 0x%llx\n",

+        EfiFileName,

+        CurrentImageRecord->ImageBase,

+        CurrentImageRecord->ImageBase + CurrentImageRecord->ImageSize

+        ));

+    } else {

+      DEBUG ((

+        DEBUG_INFO,

+        "Unknown Image: 0x%llx - 0x%llx\n",

+        CurrentImageRecord->ImageBase,

+        CurrentImageRecord->ImageBase + CurrentImageRecord->ImageSize

+        ));

+    }

+

+    CodeSectionLink = CurrentImageRecord->CodeSegmentList.ForwardLink;

+

+    while (CodeSectionLink != &CurrentImageRecord->CodeSegmentList) {

+      CurrentCodeSection = CR (

+                             CodeSectionLink,

+                             IMAGE_PROPERTIES_RECORD_CODE_SECTION,

+                             Link,

+                             IMAGE_PROPERTIES_RECORD_CODE_SECTION_SIGNATURE

+                             );

+

+      DEBUG ((

+        DEBUG_INFO,

+        "  Code Section: 0x%llx - 0x%llx\n",

+        CurrentCodeSection->CodeSegmentBase,

+        CurrentCodeSection->CodeSegmentBase + CurrentCodeSection->CodeSegmentSize

+        ));

+

+      CodeSectionLink = CodeSectionLink->ForwardLink;

+    }

+

+    ImageRecordLink = ImageRecordLink->ForwardLink;

   }

 }

 

diff --git a/MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.inf b/MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.inf
index cfe0c04b3b..1f82cc3e46 100644
--- a/MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.inf
+++ b/MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.inf
@@ -24,6 +24,7 @@
   BaseMemoryLib

   DebugLib

   MemoryAllocationLib

+  PeCoffGetEntryPointLib

 

 [Packages]

   MdePkg/MdePkg.dec

diff --git a/MdeModulePkg/Test/MdeModulePkgHostTest.dsc b/MdeModulePkg/Test/MdeModulePkgHostTest.dsc
index 2b8cbb867a..198cdd814f 100644
--- a/MdeModulePkg/Test/MdeModulePkgHostTest.dsc
+++ b/MdeModulePkg/Test/MdeModulePkgHostTest.dsc
@@ -57,6 +57,7 @@
   MdeModulePkg/Library/ImagePropertiesRecordLib/UnitTest/ImagePropertiesRecordLibUnitTestHost.inf {

     <LibraryClasses>

       ImagePropertiesRecordLib|MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.inf

+      PeCoffGetEntryPointLib|MdePkg/Library/BasePeCoffGetEntryPointLib/BasePeCoffGetEntryPointLib.inf

   }

 

   #