]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/PiSmmCore/Smi.c
MdeModulePkg/SmmCore: Fix hang due to already-freed memory deference
[mirror_edk2.git] / MdeModulePkg / Core / PiSmmCore / Smi.c
index ccf6c0de2cd27e81f9c6e51119317af46ed5b83c..0c09e7fa102fb0e943629a2fdd9a35c897eac578 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   SMI management.\r
 \r
-  Copyright (c) 2009 - 2010, Intel Corporation.  All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials are licensed and made available \r
   under the terms and conditions of the BSD License which accompanies this \r
   distribution.  The full text of the license may be found at        \r
 \r
 #include "PiSmmCore.h"\r
 \r
-//\r
-// SMM_HANDLER - used for each SMM handler\r
-//\r
-\r
-#define SMI_ENTRY_SIGNATURE  SIGNATURE_32('s','m','i','e')\r
-\r
- typedef struct {\r
-  UINTN       Signature;\r
-  LIST_ENTRY  AllEntries;  // All entries\r
-\r
-  EFI_GUID    HandlerType; // Type of interrupt\r
-  LIST_ENTRY  SmiHandlers; // All handlers\r
-} SMI_ENTRY;\r
-\r
-#define SMI_HANDLER_SIGNATURE  SIGNATURE_32('s','m','i','h')\r
-\r
- typedef struct {\r
-  UINTN                         Signature;\r
-  LIST_ENTRY                    Link;        // Link on SMI_ENTRY.SmiHandlers\r
-  EFI_SMM_HANDLER_ENTRY_POINT2  Handler;     // The smm handler's entry point\r
-  SMI_ENTRY                     *SmiEntry;\r
-} SMI_HANDLER;\r
-\r
-LIST_ENTRY  mRootSmiHandlerList = INITIALIZE_LIST_HEAD_VARIABLE (mRootSmiHandlerList);\r
 LIST_ENTRY  mSmiEntryList       = INITIALIZE_LIST_HEAD_VARIABLE (mSmiEntryList);\r
 \r
+SMI_ENTRY   mRootSmiEntry = {\r
+  SMI_ENTRY_SIGNATURE,\r
+  INITIALIZE_LIST_HEAD_VARIABLE (mRootSmiEntry.AllEntries),\r
+  {0},\r
+  INITIALIZE_LIST_HEAD_VARIABLE (mRootSmiEntry.SmiHandlers),\r
+};\r
+\r
 /**\r
   Finds the SMI entry for the requested handler type.\r
 \r
@@ -109,10 +92,10 @@ SmmCoreFindSmiEntry (
   @param  CommBuffer     Points to the optional communication buffer.\r
   @param  CommBufferSize Points to the size of the optional communication buffer.\r
 \r
-  @retval EFI_SUCCESS                        Interrupt source was processed successfully but not quiesced.\r
+  @retval EFI_WARN_INTERRUPT_SOURCE_PENDING  Interrupt source was processed successfully but not quiesced.\r
   @retval EFI_INTERRUPT_PENDING              One or more SMI sources could not be quiesced.\r
-  @retval EFI_WARN_INTERRUPT_SOURCE_PENDING  Interrupt source was not handled or quiesced.\r
-  @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED Interrupt source was handled and quiesced.\r
+  @retval EFI_NOT_FOUND                      Interrupt source was not handled or quiesced.\r
+  @retval EFI_SUCCESS                        Interrupt source was handled and quiesced.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -128,45 +111,30 @@ SmiManage (
   LIST_ENTRY   *Head;\r
   SMI_ENTRY    *SmiEntry;\r
   SMI_HANDLER  *SmiHandler;\r
-  BOOLEAN      InterruptQuiesced;\r
+  BOOLEAN      SuccessReturn;\r
   EFI_STATUS   Status;\r
   \r
+  Status = EFI_NOT_FOUND;\r
+  SuccessReturn = FALSE;\r
   if (HandlerType == NULL) {\r
     //\r
     // Root SMI handler\r
     //\r
-    Status = EFI_WARN_INTERRUPT_SOURCE_PENDING;\r
-\r
-    Head = &mRootSmiHandlerList;\r
-    for (Link = Head->ForwardLink; Link != Head; Link = Link->ForwardLink) {\r
-      SmiHandler = CR (Link, SMI_HANDLER, Link, SMI_HANDLER_SIGNATURE);\r
-\r
-      Status = SmiHandler->Handler (\r
-                 (EFI_HANDLE) SmiHandler,\r
-                 Context,\r
-                 CommBuffer,\r
-                 CommBufferSize\r
-                 );\r
-      if (Status == EFI_SUCCESS || Status == EFI_INTERRUPT_PENDING) {\r
-        return Status;\r
-      }\r
-    }\r
-    return Status;\r
-  }\r
-\r
-  //\r
-  // Non-root SMI handler\r
-  //\r
-  SmiEntry = SmmCoreFindSmiEntry ((EFI_GUID *) HandlerType, FALSE);\r
-  if (SmiEntry == NULL) {\r
+    SmiEntry = &mRootSmiEntry;\r
+  } else {\r
     //\r
-    // There is no handler registered for this interrupt source\r
+    // Non-root SMI handler\r
     //\r
-    return EFI_WARN_INTERRUPT_SOURCE_PENDING;\r
+    SmiEntry = SmmCoreFindSmiEntry ((EFI_GUID *) HandlerType, FALSE);\r
+    if (SmiEntry == NULL) {\r
+      //\r
+      // There is no handler registered for this interrupt source\r
+      //\r
+      return Status;\r
+    }\r
   }\r
-\r
-  InterruptQuiesced = FALSE;\r
   Head = &SmiEntry->SmiHandlers;\r
+\r
   for (Link = Head->ForwardLink; Link != Head; Link = Link->ForwardLink) {\r
     SmiHandler = CR (Link, SMI_HANDLER, Link, SMI_HANDLER_SIGNATURE);\r
 \r
@@ -180,42 +148,54 @@ SmiManage (
     switch (Status) {\r
     case EFI_INTERRUPT_PENDING:\r
       //\r
-      // If a handler returns EFI_INTERRUPT_PENDING, the interrupt could not be\r
-      // quiesced, then no additional handlers will be processed,\r
-      // and EFI_INTERRUPT_PENDING will be returned\r
+      // If a handler returns EFI_INTERRUPT_PENDING and HandlerType is not NULL then\r
+      // no additional handlers will be processed and EFI_INTERRUPT_PENDING will be returned.\r
       //\r
-      return EFI_INTERRUPT_PENDING;\r
+      if (HandlerType != NULL) {\r
+        return EFI_INTERRUPT_PENDING;\r
+      }\r
+      break;\r
 \r
     case EFI_SUCCESS:\r
       //\r
-      // If handler return EFI_SUCCESS, the interrupt was handled and quiesced,\r
-      // no other handlers should still be called,\r
-      // and EFI_WARN_INTERRUPT_SOURCE_QUIESCED will be returned\r
+      // If at least one of the handlers returns EFI_SUCCESS then the function will return\r
+      // EFI_SUCCESS. If a handler returns EFI_SUCCESS and HandlerType is not NULL then no\r
+      // additional handlers will be processed.\r
       //\r
-      return EFI_WARN_INTERRUPT_SOURCE_QUIESCED;\r
+      if (HandlerType != NULL) {\r
+        return EFI_SUCCESS;\r
+      }\r
+      SuccessReturn = TRUE;\r
+      break;\r
 \r
     case EFI_WARN_INTERRUPT_SOURCE_QUIESCED:\r
       //\r
-      // If at least one of the handlers report EFI_WARN_INTERRUPT_SOURCE_QUIESCED,\r
-      // then this function will return EFI_WARN_INTERRUPT_SOURCE_QUIESCED\r
+      // If at least one of the handlers returns EFI_WARN_INTERRUPT_SOURCE_QUIESCED\r
+      // then the function will return EFI_SUCCESS. \r
+      //\r
+      SuccessReturn = TRUE;\r
+      break;\r
+\r
+    case EFI_WARN_INTERRUPT_SOURCE_PENDING:\r
+      //\r
+      // If all the handlers returned EFI_WARN_INTERRUPT_SOURCE_PENDING\r
+      // then EFI_WARN_INTERRUPT_SOURCE_PENDING will be returned.\r
       //\r
-      InterruptQuiesced = TRUE;\r
       break;\r
 \r
     default:\r
+      //\r
+      // Unexpected status code returned.\r
+      //\r
+      ASSERT (FALSE);\r
       break;\r
     }\r
   }\r
 \r
-  if (InterruptQuiesced) {\r
-    Status = EFI_WARN_INTERRUPT_SOURCE_QUIESCED;\r
-  } else {\r
-    //\r
-    // If no handler report EFI_WARN_INTERRUPT_SOURCE_QUIESCED, then this\r
-    // function will return EFI_INTERRUPT_PENDING\r
-    //\r
-    Status = EFI_INTERRUPT_PENDING;\r
+  if (SuccessReturn) {\r
+    Status = EFI_SUCCESS;\r
   }\r
+\r
   return Status;\r
 }\r
 \r
@@ -253,13 +233,13 @@ SmiHandlerRegister (
 \r
   SmiHandler->Signature = SMI_HANDLER_SIGNATURE;\r
   SmiHandler->Handler = Handler;\r
+  SmiHandler->CallerAddr = (UINTN)RETURN_ADDRESS (0);\r
 \r
   if (HandlerType == NULL) {\r
     //\r
     // This is root SMI handler\r
     //\r
-    SmiEntry = NULL;\r
-    List = &mRootSmiHandlerList;\r
+    SmiEntry = &mRootSmiEntry;\r
   } else {\r
     //\r
     // None root SMI handler\r
@@ -268,9 +248,8 @@ SmiHandlerRegister (
     if (SmiEntry == NULL) {\r
       return EFI_OUT_OF_RESOURCES;\r
     }\r
-\r
-    List = &SmiEntry->SmiHandlers;\r
   }\r
+  List = &SmiEntry->SmiHandlers;\r
 \r
   SmiHandler->SmiEntry = SmiEntry;\r
   InsertTailList (List, &SmiHandler->Link);\r
@@ -297,14 +276,41 @@ SmiHandlerUnRegister (
 {\r
   SMI_HANDLER  *SmiHandler;\r
   SMI_ENTRY    *SmiEntry;\r
+  LIST_ENTRY   *EntryLink;\r
+  LIST_ENTRY   *HandlerLink;\r
 \r
-  SmiHandler = (SMI_HANDLER *) DispatchHandle;\r
-\r
-  if (SmiHandler == NULL) {\r
+  if (DispatchHandle == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  if (SmiHandler->Signature != SMI_HANDLER_SIGNATURE) {\r
+  //\r
+  // Look for it in root SMI handlers\r
+  //\r
+  SmiHandler = NULL;\r
+  for ( HandlerLink = GetFirstNode (&mRootSmiEntry.SmiHandlers)\r
+      ; !IsNull (&mRootSmiEntry.SmiHandlers, HandlerLink) && (SmiHandler != DispatchHandle)\r
+      ; HandlerLink = GetNextNode (&mRootSmiEntry.SmiHandlers, HandlerLink)\r
+      ) {\r
+    SmiHandler = CR (HandlerLink, SMI_HANDLER, Link, SMI_HANDLER_SIGNATURE);\r
+  }\r
+\r
+  //\r
+  // Look for it in non-root SMI handlers\r
+  //\r
+  for ( EntryLink = GetFirstNode (&mSmiEntryList)\r
+      ; !IsNull (&mSmiEntryList, EntryLink) && (SmiHandler != DispatchHandle)\r
+      ; EntryLink = GetNextNode (&mSmiEntryList, EntryLink)\r
+      ) {\r
+    SmiEntry = CR (EntryLink, SMI_ENTRY, AllEntries, SMI_ENTRY_SIGNATURE);\r
+    for ( HandlerLink = GetFirstNode (&SmiEntry->SmiHandlers)\r
+        ; !IsNull (&SmiEntry->SmiHandlers, HandlerLink) && (SmiHandler != DispatchHandle)\r
+        ; HandlerLink = GetNextNode (&SmiEntry->SmiHandlers, HandlerLink)\r
+        ) {\r
+      SmiHandler = CR (HandlerLink, SMI_HANDLER, Link, SMI_HANDLER_SIGNATURE);\r
+    }\r
+  }\r
+\r
+  if (SmiHandler != DispatchHandle) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r