1. Add two performance measurement points for SMM performance measurement;

2. Introduce SmmCorePlatformHookLib library class defining two platform hook points. Update PI Smm Core to call the hook points before and after invoking registered SMI handlers. A NULL instance of this library class is implemented.

Note that after this check in, DSC files consuming the PiSmmCore.inf need to be updated to add a library instance for SmmCorePlatformHookLib library class.


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12140 6f19259b-4bc3-4df7-8a09-765794883524

8 files changed, 166 insertions, 5 deletions

diff --git a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
index 75337f6b1c..a5e4b6e980 100644
--- a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
+++ b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.c
@@ -1,7 +1,7 @@
 /** @file

   SMM Core Main Entry Point

 

-  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2009 - 2011, 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        

@@ -246,12 +246,19 @@ SmmEntryPoint (
   EFI_STATUS                  Status;

   EFI_SMM_COMMUNICATE_HEADER  *CommunicateHeader;

 

+  PERF_START (NULL, "SMM", NULL, 0) ;

+

   //

   // Update SMST using the context

   //

   CopyMem (&gSmmCoreSmst.SmmStartupThisAp, SmmEntryContext, sizeof (EFI_SMM_ENTRY_CONTEXT));

 

   //

+  // Call platform hook before Smm Dispatch

+  //

+  PlatformHookBeforeSmmDispatch ();

+

+  //

   // If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed

   //

   if (mInLegacyBoot) {

@@ -297,11 +304,18 @@ SmmEntryPoint (
     //

     SmiManage (NULL, NULL, NULL, NULL);

   }

+  

+  //

+  // Call platform hook after Smm Dispatch

+  //

+  PlatformHookAfterSmmDispatch ();

 

   //

   // Clear the InSmm flag as we are going to leave SMM

   //

   gSmmCorePrivate->InSmm = FALSE;

+

+  PERF_END (NULL, "SMM", NULL, 0) ;

 }

 

 /**

diff --git a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.h b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.h
index 5cd1237056..19af786612 100644
--- a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.h
+++ b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.h
@@ -2,7 +2,7 @@
   The internal header file includes the common header files, defines

   internal structure and functions used by SmmCore module.

 

-  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2009 - 2011, 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        

@@ -43,6 +43,8 @@
 #include <Library/UefiLib.h>                   

 #include <Library/UefiBootServicesTableLib.h>

 #include <Library/PcdLib.h>

+#include <Library/SmmCorePlatformHookLib.h>

+#include <Library/PerformanceLib.h>

 

 #include "PiSmmCorePrivateData.h"

 

diff --git a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.inf b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.inf
index 96886e1e25..7687a618f7 100644
--- a/MdeModulePkg/Core/PiSmmCore/PiSmmCore.inf
+++ b/MdeModulePkg/Core/PiSmmCore/PiSmmCore.inf
@@ -1,7 +1,7 @@
 ## @file

 # This module provide an SMM CIS compliant implementation of SMM Core.

 #

-# Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>

+# Copyright (c) 2009 - 2011, 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

@@ -54,7 +54,9 @@
   UefiBootServicesTableLib    

   MemoryAllocationLib

   PcdLib

-  

+  SmmCorePlatformHookLib

+  PerformanceLib

+

 [Protocols]

   gEfiDxeSmmReadyToLockProtocolGuid             # PROTOCOL ALWAYS_CONSUMED

   gEfiSmmReadyToLockProtocolGuid                # PROTOCOL ALWAYS_PRODUCED

diff --git a/MdeModulePkg/Include/Library/SmmCorePlatformHookLib.h b/MdeModulePkg/Include/Library/SmmCorePlatformHookLib.h
new file mode 100644
index 0000000000..773d0615b7
--- /dev/null
+++ b/MdeModulePkg/Include/Library/SmmCorePlatformHookLib.h
@@ -0,0 +1,50 @@
+/** @file

+  Smm Core Platform Hook Library.  This library class defines a set of platform

+  hooks called by the SMM Core.

+

+Copyright (c) 2011, 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 that 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.

+

+**/

+

+#ifndef __SMM_CORE_PLATFORM_HOOK_LIB__

+#define __SMM_CORE_PLATFORM_HOOK_LIB__

+

+/**

+  Performs platform specific tasks before invoking registered SMI handlers.

+  

+  This function performs platform specific tasks before invoking registered SMI handlers.

+  

+  @retval EFI_SUCCESS       The platform hook completes successfully.

+  @retval Other values      The paltform hook cannot complete due to some error.

+

+**/

+EFI_STATUS

+EFIAPI

+PlatformHookBeforeSmmDispatch (

+  VOID

+  );

+

+

+/**

+  Performs platform specific tasks after invoking registered SMI handlers.

+  

+  This function performs platform specific tasks after invoking registered SMI handlers.

+  

+  @retval EFI_SUCCESS       The platform hook completes successfully.

+  @retval Other values      The paltform hook cannot complete due to some error.

+

+**/

+EFI_STATUS

+EFIAPI

+PlatformHookAfterSmmDispatch (

+  VOID

+  );

+  

+#endif

diff --git a/MdeModulePkg/Library/SmmCorePlatformHookLibNull/SmmCorePlatformHookLibNull.c b/MdeModulePkg/Library/SmmCorePlatformHookLibNull/SmmCorePlatformHookLibNull.c
new file mode 100644
index 0000000000..ef38c8fdf5
--- /dev/null
+++ b/MdeModulePkg/Library/SmmCorePlatformHookLibNull/SmmCorePlatformHookLibNull.c
@@ -0,0 +1,52 @@
+/** @file

+  Null instance of SmmCorePlatformHookLibNull.

+

+  Copyright (c) 2011, 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 <Library/SmmCorePlatformHookLib.h>

+

+/**

+  Performs platform specific tasks before invoking registered SMI handlers.

+  

+  This function performs platform specific tasks before invoking registered SMI handlers.

+  

+  @retval EFI_SUCCESS       The platform hook completes successfully.

+  @retval Other values      The paltform hook cannot complete due to some error.

+

+**/

+EFI_STATUS

+EFIAPI

+PlatformHookBeforeSmmDispatch (

+  VOID

+  )

+{

+  return EFI_SUCCESS;

+}

+

+

+/**

+  Performs platform specific tasks after invoking registered SMI handlers.

+  

+  This function performs platform specific tasks after invoking registered SMI handlers.

+  

+  @retval EFI_SUCCESS       The platform hook completes successfully.

+  @retval Other values      The paltform hook cannot complete due to some error.

+

+**/

+EFI_STATUS

+EFIAPI

+PlatformHookAfterSmmDispatch (

+  VOID

+  )

+{

+  return EFI_SUCCESS;

+}

diff --git a/MdeModulePkg/Library/SmmCorePlatformHookLibNull/SmmCorePlatformHookLibNull.inf b/MdeModulePkg/Library/SmmCorePlatformHookLibNull/SmmCorePlatformHookLibNull.inf
new file mode 100644
index 0000000000..c234577e9f
--- /dev/null
+++ b/MdeModulePkg/Library/SmmCorePlatformHookLibNull/SmmCorePlatformHookLibNull.inf
@@ -0,0 +1,35 @@
+## @file

+#  SMM Core Platform Hook Null Library instance

+#

+#  Copyright (c) 2011, 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                      = SmmCorePlatformHookLibNull

+  FILE_GUID                      = FED6583D-2418-4760-AC96-B5E18F0A6326

+  MODULE_TYPE                    = SMM_CORE

+  VERSION_STRING                 = 1.0

+  PI_SPECIFICATION_VERSION       = 0x0001000A

+  LIBRARY_CLASS                  = SmmCorePlatformHookLib|SMM_CORE

+

+#

+# The following information is for reference only and not required by the build tools.

+#

+#  VALID_ARCHITECTURES           = IA32 X64

+#

+

+[Sources]

+  SmmCorePlatformHookLibNull.c

+

+[Packages]

+  MdePkg/MdePkg.dec

+  MdeModulePkg/MdeModulePkg.dec

diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
index 80c9632e60..b2782df5f0 100644
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -85,6 +85,10 @@
   ##  @libraryclass  Provide platform specific hooks.

   #

   PlatformHookLib|Include/Library/PlatformHookLib.h

+

+  ##  @libraryclass  Provide platform specific hooks for SMM core.

+  #

+  SmmCorePlatformHookLib|Include/Library/SmmCorePlatformHookLib.h

   

 [Guids]

   ## MdeModule package token space guid

diff --git a/MdeModulePkg/MdeModulePkg.dsc b/MdeModulePkg/MdeModulePkg.dsc
index 78cf7603a5..67c13444d1 100644
--- a/MdeModulePkg/MdeModulePkg.dsc
+++ b/MdeModulePkg/MdeModulePkg.dsc
@@ -120,7 +120,8 @@
 [LibraryClasses.common.SMM_CORE]

   MemoryAllocationLib|MdeModulePkg/Library/PiSmmCoreMemoryAllocationLib/PiSmmCoreMemoryAllocationLib.inf

   SmmServicesTableLib|MdeModulePkg/Library/PiSmmCoreSmmServicesTableLib/PiSmmCoreSmmServicesTableLib.inf

-  

+  SmmCorePlatformHookLib|MdeModulePkg/Library/SmmCorePlatformHookLibNull/SmmCorePlatformHookLibNull.inf  

+

 [LibraryClasses.common.DXE_SMM_DRIVER]

   HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf

   DebugLib|MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf

@@ -321,4 +322,5 @@
   MdeModulePkg/Library/SmmPerformanceLib/SmmPerformanceLib.inf

   MdeModulePkg/Library/DxeSmmPerformanceLib/DxeSmmPerformanceLib.inf

   MdeModulePkg/Library/SmmLockBoxLib/SmmLockBoxPeiLib.inf

+  MdeModulePkg/Library/SmmCorePlatformHookLibNull/SmmCorePlatformHookLibNull.inf