[PATCH] MdeModulePkg/PiSmmIpl: fix non-executable SMM RAM

[Jian J Wang <jian.j.wang@intel.com>]

This patch fixes an issue introduced by commit

  5b91bf82c67b586b9588cbe4bbffa1588f6b5926

This issue will only happen if PcdDxeNxMemoryProtectionPolicy is
enabled for reserved memory, which will mark SMM RAM as NX (non-
executable) during DXE core initialization. SMM IPL driver will
unset the NX attribute for SMM RAM to allow loading and running
SMM core/drivers.

But above commit will fail the unset operation of the NX attribute
due to a fact that SMM RAM has zero cache attribute (MRC code always
sets 0 attribute for reserved memory), which will cause GCD internal
method ConverToCpuArchAttributes() to return 0 attribute which is
taken as invalid CPU paging attribute and skip the calling of
gCpu->SetMemoryAttributes().

Commit 0c9f2cb10b7ddec56a3440e77219fd3ab1725e5c tries to fix compatible
issue but not this one. The solution is to make use of existing
functionality in PiSmmIpl to make sure one cache attribute is set
for SMM RAM. For performance consideration, PiSmmIpl will always
try to set SMM RAM to write-back. But there's a hole in the code
which will fail the setting write-back attribute because of no
corresponding cache capabilities. This patch will add necessary
cache capabilities before setting corresponding attributes.

Cc: Star Zeng <star.zeng@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
---
 MdeModulePkg/Core/PiSmmCore/PiSmmIpl.c | 32 ++++++++++++++++++++++++--------
 1 file changed, 24 insertions(+), 8 deletions(-)

diff --git a/MdeModulePkg/Core/PiSmmCore/PiSmmIpl.c b/MdeModulePkg/Core/PiSmmCore/PiSmmIpl.c
index 94d671bd74..552220b4dd 100644
--- a/MdeModulePkg/Core/PiSmmCore/PiSmmIpl.c
+++ b/MdeModulePkg/Core/PiSmmCore/PiSmmIpl.c
@@ -1617,6 +1617,21 @@ SmmIplEntry (
 
     GetSmramCacheRange (mCurrentSmramRange, &mSmramCacheBase, &mSmramCacheSize);
     //
+    // Make sure we can change the cache attributes.
+    //
+    Status = gDS->GetMemorySpaceDescriptor (
+                    mSmramCacheBase,
+                    &MemDesc
+                    );
+    if (!EFI_ERROR (Status) &&
+        (MemDesc.Capabilities & (EFI_MEMORY_WB | EFI_MEMORY_UC)) != (EFI_MEMORY_WB | EFI_MEMORY_UC)) {
+      gDS->SetMemorySpaceCapabilities (
+             mSmramCacheBase,
+             mSmramCacheSize,
+             MemDesc.Capabilities | EFI_MEMORY_WB | EFI_MEMORY_UC
+             );
+    }
+    //
     // If CPU AP is present, attempt to set SMRAM cacheability to WB and clear
     // XP if it's set.
     // Note that it is expected that cacheability of SMRAM has been set to WB if CPU AP
@@ -1626,7 +1641,7 @@ SmmIplEntry (
     Status = gBS->LocateProtocol (&gEfiCpuArchProtocolGuid, NULL, (VOID **)&CpuArch);
     if (!EFI_ERROR (Status)) {
       Status = gDS->SetMemorySpaceAttributes(
-                      mSmramCacheBase, 
+                      mSmramCacheBase,
                       mSmramCacheSize,
                       EFI_MEMORY_WB
                       );
@@ -1634,16 +1649,17 @@ SmmIplEntry (
         DEBUG ((DEBUG_WARN, "SMM IPL failed to set SMRAM window to EFI_MEMORY_WB\n"));
       }
 
-      Status = gDS->GetMemorySpaceDescriptor(
-                      mCurrentSmramRange->PhysicalStart,
+      Status = gDS->GetMemorySpaceDescriptor (
+                      mSmramCacheBase,
                       &MemDesc
                       );
       if (!EFI_ERROR (Status) && (MemDesc.Attributes & EFI_MEMORY_XP) != 0) {
-        gDS->SetMemorySpaceAttributes (
-               mCurrentSmramRange->PhysicalStart,
-               mCurrentSmramRange->PhysicalSize,
-               MemDesc.Attributes & (~EFI_MEMORY_XP)
-               );
+        Status = gDS->SetMemorySpaceAttributes (
+                        mSmramCacheBase,
+                        mSmramCacheSize,
+                        MemDesc.Attributes & (~EFI_MEMORY_XP)
+                        );
+        ASSERT_EFI_ERROR (Status);
       }
     }
     //
-- 
2.16.2.windows.1