]> git.proxmox.com Git - mirror_edk2.git/blobdiff - UefiCpuPkg/Library/CpuExceptionHandlerLib/Ia32/ArchExceptionHandler.c
UefiCpuPkg/CpuExceptionHandlerLib: Fix spelling issue
[mirror_edk2.git] / UefiCpuPkg / Library / CpuExceptionHandlerLib / Ia32 / ArchExceptionHandler.c
index a4326acd7aa42f7cd5088c1f8908665ffec47010..531258610aa9b651b86ce9b0ecc7a2ef529f2526 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
-  IA32 CPU Exception Hanlder functons.\r
+  IA32 CPU Exception Handler functons.\r
 \r
-  Copyright (c) 2012 - 2013, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2012 - 2018, 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
@@ -50,86 +50,300 @@ ArchGetIdtHandler (
 /**\r
   Save CPU exception context when handling EFI_VECTOR_HANDOFF_HOOK_AFTER case.\r
 \r
-  @param ExceptionType  Exception type.\r
-  @param SystemContext  Pointer to EFI_SYSTEM_CONTEXT.\r
-\r
+  @param[in] ExceptionType        Exception type.\r
+  @param[in] SystemContext        Pointer to EFI_SYSTEM_CONTEXT.\r
+  @param[in] ExceptionHandlerData Pointer to exception handler data.\r
 **/\r
 VOID\r
 ArchSaveExceptionContext (\r
-  IN UINTN                ExceptionType,\r
-  IN EFI_SYSTEM_CONTEXT   SystemContext \r
+  IN UINTN                        ExceptionType,\r
+  IN EFI_SYSTEM_CONTEXT           SystemContext,\r
+  IN EXCEPTION_HANDLER_DATA       *ExceptionHandlerData\r
   )\r
 {\r
   IA32_EFLAGS32           Eflags;\r
+  RESERVED_VECTORS_DATA   *ReservedVectors;\r
+\r
+  ReservedVectors = ExceptionHandlerData->ReservedVectors;\r
   //\r
-  // Save Exception context in global variable\r
+  // Save Exception context in global variable in first entry of the exception handler.\r
+  // So when original exception handler returns to the new exception handler (second entry),\r
+  // the Eflags/Cs/Eip/ExceptionData can be used.\r
   //\r
-  mReservedVectors[ExceptionType].OldFlags      = SystemContext.SystemContextIa32->Eflags;\r
-  mReservedVectors[ExceptionType].OldCs         = SystemContext.SystemContextIa32->Cs;\r
-  mReservedVectors[ExceptionType].OldIp         = SystemContext.SystemContextIa32->Eip;\r
-  mReservedVectors[ExceptionType].ExceptionData = SystemContext.SystemContextIa32->ExceptionData;\r
+  ReservedVectors[ExceptionType].OldFlags      = SystemContext.SystemContextIa32->Eflags;\r
+  ReservedVectors[ExceptionType].OldCs         = SystemContext.SystemContextIa32->Cs;\r
+  ReservedVectors[ExceptionType].OldIp         = SystemContext.SystemContextIa32->Eip;\r
+  ReservedVectors[ExceptionType].ExceptionData = SystemContext.SystemContextIa32->ExceptionData;\r
   //\r
   // Clear IF flag to avoid old IDT handler enable interrupt by IRET\r
   //\r
   Eflags.UintN = SystemContext.SystemContextIa32->Eflags;\r
-  Eflags.Bits.IF = 0; \r
+  Eflags.Bits.IF = 0;\r
   SystemContext.SystemContextIa32->Eflags = Eflags.UintN;\r
   //\r
-  // Modify the EIP in stack, then old IDT handler will return to the stub code\r
+  // Modify the EIP in stack, then old IDT handler will return to HookAfterStubBegin.\r
   //\r
-  SystemContext.SystemContextIa32->Eip    = (UINTN) mReservedVectors[ExceptionType].HookAfterStubHeaderCode;\r
+  SystemContext.SystemContextIa32->Eip    = (UINTN) ReservedVectors[ExceptionType].HookAfterStubHeaderCode;\r
 }\r
 \r
 /**\r
   Restore CPU exception context when handling EFI_VECTOR_HANDOFF_HOOK_AFTER case.\r
 \r
-  @param ExceptionType  Exception type.\r
-  @param SystemContext  Pointer to EFI_SYSTEM_CONTEXT.\r
+  @param[in] ExceptionType        Exception type.\r
+  @param[in] SystemContext        Pointer to EFI_SYSTEM_CONTEXT.\r
+  @param[in] ExceptionHandlerData Pointer to exception handler data.\r
 **/\r
 VOID\r
 ArchRestoreExceptionContext (\r
-  IN UINTN                ExceptionType,\r
-  IN EFI_SYSTEM_CONTEXT   SystemContext \r
+  IN UINTN                        ExceptionType,\r
+  IN EFI_SYSTEM_CONTEXT           SystemContext,\r
+  IN EXCEPTION_HANDLER_DATA       *ExceptionHandlerData\r
   )\r
 {\r
-  SystemContext.SystemContextIa32->Eflags        = mReservedVectors[ExceptionType].OldFlags;\r
-  SystemContext.SystemContextIa32->Cs            = mReservedVectors[ExceptionType].OldCs;\r
-  SystemContext.SystemContextIa32->Eip           = mReservedVectors[ExceptionType].OldIp;\r
-  SystemContext.SystemContextIa32->ExceptionData = mReservedVectors[ExceptionType].ExceptionData;\r
+  RESERVED_VECTORS_DATA   *ReservedVectors;\r
+\r
+  ReservedVectors = ExceptionHandlerData->ReservedVectors;\r
+  SystemContext.SystemContextIa32->Eflags        = ReservedVectors[ExceptionType].OldFlags;\r
+  SystemContext.SystemContextIa32->Cs            = ReservedVectors[ExceptionType].OldCs;\r
+  SystemContext.SystemContextIa32->Eip           = ReservedVectors[ExceptionType].OldIp;\r
+  SystemContext.SystemContextIa32->ExceptionData = ReservedVectors[ExceptionType].ExceptionData;\r
 }\r
 \r
 /**\r
-  Display CPU information.\r
+  Setup separate stack for given exceptions.\r
 \r
-  @param ExceptionType  Exception type.\r
-  @param SystemContext  Pointer to EFI_SYSTEM_CONTEXT.\r
+  @param[in] StackSwitchData      Pointer to data required for setuping up\r
+                                  stack switch.\r
+\r
+  @retval EFI_SUCCESS             The exceptions have been successfully\r
+                                  initialized with new stack.\r
+  @retval EFI_INVALID_PARAMETER   StackSwitchData contains invalid content.\r
+\r
+**/\r
+EFI_STATUS\r
+ArchSetupExceptionStack (\r
+  IN CPU_EXCEPTION_INIT_DATA      *StackSwitchData\r
+  )\r
+{\r
+  IA32_DESCRIPTOR                   Gdtr;\r
+  IA32_DESCRIPTOR                   Idtr;\r
+  IA32_IDT_GATE_DESCRIPTOR          *IdtTable;\r
+  IA32_TSS_DESCRIPTOR               *TssDesc;\r
+  IA32_TASK_STATE_SEGMENT           *Tss;\r
+  UINTN                             StackTop;\r
+  UINTN                             Index;\r
+  UINTN                             Vector;\r
+  UINTN                             TssBase;\r
+  UINTN                             GdtSize;\r
+  EXCEPTION_HANDLER_TEMPLATE_MAP    TemplateMap;\r
+\r
+  if (StackSwitchData == NULL ||\r
+      StackSwitchData->Ia32.Revision != CPU_EXCEPTION_INIT_DATA_REV ||\r
+      StackSwitchData->Ia32.KnownGoodStackTop == 0 ||\r
+      StackSwitchData->Ia32.KnownGoodStackSize == 0 ||\r
+      StackSwitchData->Ia32.StackSwitchExceptions == NULL ||\r
+      StackSwitchData->Ia32.StackSwitchExceptionNumber == 0 ||\r
+      StackSwitchData->Ia32.StackSwitchExceptionNumber > CPU_EXCEPTION_NUM ||\r
+      StackSwitchData->Ia32.GdtTable == NULL ||\r
+      StackSwitchData->Ia32.IdtTable == NULL ||\r
+      StackSwitchData->Ia32.ExceptionTssDesc == NULL ||\r
+      StackSwitchData->Ia32.ExceptionTss == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // The caller is responsible for that the GDT table, no matter the existing\r
+  // one or newly allocated, has enough space to hold descriptors for exception\r
+  // task-state segments.\r
+  //\r
+  if (((UINTN)StackSwitchData->Ia32.GdtTable & (IA32_GDT_ALIGNMENT - 1)) != 0) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if ((UINTN)StackSwitchData->Ia32.ExceptionTssDesc < (UINTN)(StackSwitchData->Ia32.GdtTable)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if ((UINTN)StackSwitchData->Ia32.ExceptionTssDesc + StackSwitchData->Ia32.ExceptionTssDescSize >\r
+      ((UINTN)(StackSwitchData->Ia32.GdtTable) + StackSwitchData->Ia32.GdtTableSize)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // We need one descriptor and one TSS for current task and every exception\r
+  // specified.\r
+  //\r
+  if (StackSwitchData->Ia32.ExceptionTssDescSize <\r
+      sizeof (IA32_TSS_DESCRIPTOR) * (StackSwitchData->Ia32.StackSwitchExceptionNumber + 1)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  if (StackSwitchData->Ia32.ExceptionTssSize <\r
+      sizeof (IA32_TASK_STATE_SEGMENT) * (StackSwitchData->Ia32.StackSwitchExceptionNumber + 1)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  TssDesc = StackSwitchData->Ia32.ExceptionTssDesc;\r
+  Tss     = StackSwitchData->Ia32.ExceptionTss;\r
+\r
+  //\r
+  // Initialize new GDT table and/or IDT table, if any\r
+  //\r
+  AsmReadIdtr (&Idtr);\r
+  AsmReadGdtr (&Gdtr);\r
+\r
+  GdtSize = (UINTN)TssDesc +\r
+            sizeof (IA32_TSS_DESCRIPTOR) *\r
+            (StackSwitchData->Ia32.StackSwitchExceptionNumber + 1) -\r
+            (UINTN)(StackSwitchData->Ia32.GdtTable);\r
+  if ((UINTN)StackSwitchData->Ia32.GdtTable != Gdtr.Base) {\r
+    CopyMem (StackSwitchData->Ia32.GdtTable, (VOID *)Gdtr.Base, Gdtr.Limit + 1);\r
+    Gdtr.Base = (UINTN)StackSwitchData->Ia32.GdtTable;\r
+    Gdtr.Limit = (UINT16)GdtSize - 1;\r
+  }\r
+\r
+  if ((UINTN)StackSwitchData->Ia32.IdtTable != Idtr.Base) {\r
+    Idtr.Base = (UINTN)StackSwitchData->Ia32.IdtTable;\r
+  }\r
+  if (StackSwitchData->Ia32.IdtTableSize > 0) {\r
+    Idtr.Limit = (UINT16)(StackSwitchData->Ia32.IdtTableSize - 1);\r
+  }\r
+\r
+  //\r
+  // Fixup current task descriptor. Task-state segment for current task will\r
+  // be filled by processor during task switching.\r
+  //\r
+  TssBase = (UINTN)Tss;\r
+\r
+  TssDesc->Uint64          = 0;\r
+  TssDesc->Bits.LimitLow   = sizeof(IA32_TASK_STATE_SEGMENT) - 1;\r
+  TssDesc->Bits.BaseLow    = (UINT16)TssBase;\r
+  TssDesc->Bits.BaseMid    = (UINT8)(TssBase >> 16);\r
+  TssDesc->Bits.Type       = IA32_GDT_TYPE_TSS;\r
+  TssDesc->Bits.P          = 1;\r
+  TssDesc->Bits.LimitHigh  = 0;\r
+  TssDesc->Bits.BaseHigh   = (UINT8)(TssBase >> 24);\r
+\r
+  //\r
+  // Fixup exception task descriptor and task-state segment\r
+  //\r
+  AsmGetTssTemplateMap (&TemplateMap);\r
+  StackTop = StackSwitchData->Ia32.KnownGoodStackTop - CPU_STACK_ALIGNMENT;\r
+  StackTop = (UINTN)ALIGN_POINTER (StackTop, CPU_STACK_ALIGNMENT);\r
+  IdtTable = StackSwitchData->Ia32.IdtTable;\r
+  for (Index = 0; Index < StackSwitchData->Ia32.StackSwitchExceptionNumber; ++Index) {\r
+    TssDesc += 1;\r
+    Tss     += 1;\r
+\r
+    //\r
+    // Fixup TSS descriptor\r
+    //\r
+    TssBase = (UINTN)Tss;\r
+\r
+    TssDesc->Uint64         = 0;\r
+    TssDesc->Bits.LimitLow  = sizeof(IA32_TASK_STATE_SEGMENT) - 1;\r
+    TssDesc->Bits.BaseLow   = (UINT16)TssBase;\r
+    TssDesc->Bits.BaseMid   = (UINT8)(TssBase >> 16);\r
+    TssDesc->Bits.Type      = IA32_GDT_TYPE_TSS;\r
+    TssDesc->Bits.P         = 1;\r
+    TssDesc->Bits.LimitHigh = 0;\r
+    TssDesc->Bits.BaseHigh  = (UINT8)(TssBase >> 24);\r
+\r
+    //\r
+    // Fixup TSS\r
+    //\r
+    Vector = StackSwitchData->Ia32.StackSwitchExceptions[Index];\r
+    if (Vector >= CPU_EXCEPTION_NUM ||\r
+        Vector >= (Idtr.Limit + 1) / sizeof (IA32_IDT_GATE_DESCRIPTOR)) {\r
+      continue;\r
+    }\r
+\r
+    ZeroMem (Tss, sizeof (*Tss));\r
+    Tss->EIP    = (UINT32)(TemplateMap.ExceptionStart\r
+                           + Vector * TemplateMap.ExceptionStubHeaderSize);\r
+    Tss->EFLAGS = 0x2;\r
+    Tss->ESP    = StackTop;\r
+    Tss->CR3    = AsmReadCr3 ();\r
+    Tss->ES     = AsmReadEs ();\r
+    Tss->CS     = AsmReadCs ();\r
+    Tss->SS     = AsmReadSs ();\r
+    Tss->DS     = AsmReadDs ();\r
+    Tss->FS     = AsmReadFs ();\r
+    Tss->GS     = AsmReadGs ();\r
+\r
+    StackTop   -= StackSwitchData->Ia32.KnownGoodStackSize;\r
+\r
+    //\r
+    // Update IDT to use Task Gate for given exception\r
+    //\r
+    IdtTable[Vector].Bits.OffsetLow  = 0;\r
+    IdtTable[Vector].Bits.Selector   = (UINT16)((UINTN)TssDesc - Gdtr.Base);\r
+    IdtTable[Vector].Bits.Reserved_0 = 0;\r
+    IdtTable[Vector].Bits.GateType   = IA32_IDT_GATE_TYPE_TASK;\r
+    IdtTable[Vector].Bits.OffsetHigh = 0;\r
+  }\r
+\r
+  //\r
+  // Publish GDT\r
+  //\r
+  AsmWriteGdtr (&Gdtr);\r
+\r
+  //\r
+  // Load current task\r
+  //\r
+  AsmWriteTr ((UINT16)((UINTN)StackSwitchData->Ia32.ExceptionTssDesc - Gdtr.Base));\r
+\r
+  //\r
+  // Publish IDT\r
+  //\r
+  AsmWriteIdtr (&Idtr);\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Display processor context.\r
+\r
+  @param[in] ExceptionType  Exception type.\r
+  @param[in] SystemContext  Processor context to be display.\r
 **/\r
 VOID\r
-DumpCpuContent (\r
+EFIAPI\r
+DumpCpuContext (\r
   IN EFI_EXCEPTION_TYPE   ExceptionType,\r
   IN EFI_SYSTEM_CONTEXT   SystemContext\r
   )\r
 {\r
-  UINTN                   ImageBase;\r
-  UINTN                   EntryPoint;\r
-\r
   InternalPrintMessage (\r
-    "!!!! IA32 Exception Type - %08x    CPU Apic ID - %08x !!!!\n",\r
+    "!!!! IA32 Exception Type - %02x(%a)  CPU Apic ID - %08x !!!!\n",\r
     ExceptionType,\r
+    GetExceptionNameStr (ExceptionType),\r
     GetApicId ()\r
     );\r
+  if ((mErrorCodeFlag & (1 << ExceptionType)) != 0) {\r
+    InternalPrintMessage (\r
+      "ExceptionData - %08x",\r
+      SystemContext.SystemContextIa32->ExceptionData\r
+      );\r
+    if (ExceptionType == EXCEPT_IA32_PAGE_FAULT) {\r
+      InternalPrintMessage (\r
+        "  I:%x R:%x U:%x W:%x P:%x PK:%x S:%x",\r
+        (SystemContext.SystemContextIa32->ExceptionData & IA32_PF_EC_ID)   != 0,\r
+        (SystemContext.SystemContextIa32->ExceptionData & IA32_PF_EC_RSVD) != 0,\r
+        (SystemContext.SystemContextIa32->ExceptionData & IA32_PF_EC_US)   != 0,\r
+        (SystemContext.SystemContextIa32->ExceptionData & IA32_PF_EC_WR)   != 0,\r
+        (SystemContext.SystemContextIa32->ExceptionData & IA32_PF_EC_P)    != 0,\r
+        (SystemContext.SystemContextIa32->ExceptionData & IA32_PF_EC_PK)   != 0,\r
+        (SystemContext.SystemContextIa32->ExceptionData & IA32_PF_EC_SGX)  != 0\r
+        );\r
+    }\r
+    InternalPrintMessage ("\n");\r
+  }\r
   InternalPrintMessage (\r
     "EIP  - %08x, CS  - %08x, EFLAGS - %08x\n",\r
     SystemContext.SystemContextIa32->Eip,\r
     SystemContext.SystemContextIa32->Cs,\r
     SystemContext.SystemContextIa32->Eflags\r
     );\r
-  if ((mErrorCodeFlag & (1 << ExceptionType)) != 0) {\r
-    InternalPrintMessage (\r
-      "ExceptionData - %08x\n",\r
-      SystemContext.SystemContextIa32->ExceptionData\r
-      );\r
-  }\r
   InternalPrintMessage (\r
     "EAX  - %08x, ECX - %08x, EDX - %08x, EBX - %08x\n",\r
     SystemContext.SystemContextIa32->Eax,\r
@@ -187,16 +401,32 @@ DumpCpuContent (
     "FXSAVE_STATE - %08x\n",\r
     &SystemContext.SystemContextIa32->FxSaveState\r
     );\r
+}\r
 \r
+/**\r
+  Display CPU information.\r
+\r
+  @param ExceptionType  Exception type.\r
+  @param SystemContext  Pointer to EFI_SYSTEM_CONTEXT.\r
+**/\r
+VOID\r
+DumpImageAndCpuContent (\r
+  IN EFI_EXCEPTION_TYPE   ExceptionType,\r
+  IN EFI_SYSTEM_CONTEXT   SystemContext\r
+  )\r
+{\r
+  DumpCpuContext (ExceptionType, SystemContext);\r
   //\r
-  // Find module image base and module entry point by RIP\r
+  // Dump module image base and module entry point by EIP\r
   //\r
-  ImageBase = FindModuleImageBase (SystemContext.SystemContextIa32->Eip, &EntryPoint);\r
-  if (ImageBase != 0) {\r
-    InternalPrintMessage (\r
-      " (ImageBase=%08x, EntryPoint=%08x) !!!!\n",\r
-      ImageBase,\r
-      EntryPoint\r
-      );\r
+  if ((ExceptionType == EXCEPT_IA32_PAGE_FAULT) &&\r
+      ((SystemContext.SystemContextIa32->ExceptionData & IA32_PF_EC_ID) != 0)) {\r
+    //\r
+    // The EIP in SystemContext could not be used\r
+    // if it is page fault with I/D set.\r
+    //\r
+    DumpModuleImageInfo ((*(UINTN *)(UINTN)SystemContext.SystemContextIa32->Esp));\r
+  } else {\r
+    DumpModuleImageInfo (SystemContext.SystemContextIa32->Eip);\r
   }\r
 }\r