UefiCpuPkg: Add ExceptionHandlerData for ArchSaveExceptionContext()

[mirror_edk2.git] / UefiCpuPkg / Library / CpuExceptionHandlerLib / X64 / ArchExceptionHandler.c

/** @file\r
  x64 CPU Exception Handler.\r
\r
  Copyright (c) 2012 - 2016, 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
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "CpuExceptionCommon.h"\r
\r
/**\r
  Return address map of exception handler template so that C code can generate\r
  exception tables.\r
\r
  @param IdtEntry          Pointer to IDT entry to be updated.\r
  @param InterruptHandler  IDT handler value.\r
**/\r
VOID\r
ArchUpdateIdtEntry (\r
  IN IA32_IDT_GATE_DESCRIPTOR        *IdtEntry,\r
  IN UINTN                           InterruptHandler\r
  )\r
{\r
  IdtEntry->Bits.OffsetLow   = (UINT16)(UINTN)InterruptHandler;\r
  IdtEntry->Bits.OffsetHigh  = (UINT16)((UINTN)InterruptHandler >> 16);\r
  IdtEntry->Bits.OffsetUpper = (UINT32)((UINTN)InterruptHandler >> 32);	\r
  IdtEntry->Bits.GateType    = IA32_IDT_GATE_TYPE_INTERRUPT_32;\r
}\r
\r
/**\r
  Read IDT handler value from IDT entry.\r
\r
  @param IdtEntry          Pointer to IDT entry to be read.\r
\r
**/\r
UINTN\r
ArchGetIdtHandler (\r
  IN IA32_IDT_GATE_DESCRIPTOR        *IdtEntry\r
  )\r
{\r
  return IdtEntry->Bits.OffsetLow + (((UINTN) IdtEntry->Bits.OffsetHigh)  << 16) +\r
                                    (((UINTN) IdtEntry->Bits.OffsetUpper) << 32);\r
}\r
\r
/**\r
  Save CPU exception context when handling EFI_VECTOR_HANDOFF_HOOK_AFTER case.\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 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
  //\r
  ReservedVectors[ExceptionType].OldSs         = SystemContext.SystemContextX64->Ss;\r
  ReservedVectors[ExceptionType].OldSp         = SystemContext.SystemContextX64->Rsp;\r
  ReservedVectors[ExceptionType].OldFlags      = SystemContext.SystemContextX64->Rflags;\r
  ReservedVectors[ExceptionType].OldCs         = SystemContext.SystemContextX64->Cs;\r
  ReservedVectors[ExceptionType].OldIp         = SystemContext.SystemContextX64->Rip;\r
  ReservedVectors[ExceptionType].ExceptionData = SystemContext.SystemContextX64->ExceptionData;\r
  //\r
  // Clear IF flag to avoid old IDT handler enable interrupt by IRET\r
  //\r
  Eflags.UintN = SystemContext.SystemContextX64->Rflags;\r
  Eflags.Bits.IF = 0; \r
  SystemContext.SystemContextX64->Rflags = Eflags.UintN;\r
  //\r
  // Modify the EIP in stack, then old IDT handler will return to the stub code\r
  //\r
  SystemContext.SystemContextX64->Rip = (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
**/\r
VOID\r
ArchRestoreExceptionContext (\r
  IN UINTN                ExceptionType,\r
  IN EFI_SYSTEM_CONTEXT   SystemContext \r
  )\r
{\r
  SystemContext.SystemContextX64->Ss            = mReservedVectors[ExceptionType].OldSs;\r
  SystemContext.SystemContextX64->Rsp           = mReservedVectors[ExceptionType].OldSp;\r
  SystemContext.SystemContextX64->Rflags        = mReservedVectors[ExceptionType].OldFlags;\r
  SystemContext.SystemContextX64->Cs            = mReservedVectors[ExceptionType].OldCs;\r
  SystemContext.SystemContextX64->Rip           = mReservedVectors[ExceptionType].OldIp;\r
  SystemContext.SystemContextX64->ExceptionData = mReservedVectors[ExceptionType].ExceptionData;\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
DumpCpuContent (\r
  IN EFI_EXCEPTION_TYPE   ExceptionType,\r
  IN EFI_SYSTEM_CONTEXT   SystemContext\r
  )\r
{\r
  UINTN                   ImageBase;\r
  UINTN                   EntryPoint;\r
\r
  InternalPrintMessage (\r
    "!!!! X64 Exception Type - %02x(%a)  CPU Apic ID - %08x !!!!\n",\r
    ExceptionType,\r
    GetExceptionNameStr (ExceptionType),\r
    GetApicId ()\r
    );\r
\r
  InternalPrintMessage (\r
    "RIP  - %016lx, CS  - %016lx, RFLAGS - %016lx\n",\r
    SystemContext.SystemContextX64->Rip,\r
    SystemContext.SystemContextX64->Cs,\r
    SystemContext.SystemContextX64->Rflags\r
    );\r
  if (mErrorCodeFlag & (1 << ExceptionType)) {\r
    InternalPrintMessage (\r
      "ExceptionData - %016lx\n",\r
      SystemContext.SystemContextX64->ExceptionData\r
      );\r
  }\r
  InternalPrintMessage (\r
    "RAX  - %016lx, RCX - %016lx, RDX - %016lx\n",\r
    SystemContext.SystemContextX64->Rax,\r
    SystemContext.SystemContextX64->Rcx,\r
    SystemContext.SystemContextX64->Rdx\r
    );\r
  InternalPrintMessage (\r
    "RBX  - %016lx, RSP - %016lx, RBP - %016lx\n",\r
    SystemContext.SystemContextX64->Rbx,\r
    SystemContext.SystemContextX64->Rsp,\r
    SystemContext.SystemContextX64->Rbp\r
    );\r
  InternalPrintMessage (\r
    "RSI  - %016lx, RDI - %016lx\n",\r
    SystemContext.SystemContextX64->Rsi,\r
    SystemContext.SystemContextX64->Rdi\r
    );\r
  InternalPrintMessage (\r
    "R8   - %016lx, R9  - %016lx, R10 - %016lx\n",\r
    SystemContext.SystemContextX64->R8,\r
    SystemContext.SystemContextX64->R9,\r
    SystemContext.SystemContextX64->R10\r
    );\r
  InternalPrintMessage (\r
    "R11  - %016lx, R12 - %016lx, R13 - %016lx\n",\r
    SystemContext.SystemContextX64->R11,\r
    SystemContext.SystemContextX64->R12,\r
    SystemContext.SystemContextX64->R13\r
    );\r
  InternalPrintMessage (\r
    "R14  - %016lx, R15 - %016lx\n",\r
    SystemContext.SystemContextX64->R14,\r
    SystemContext.SystemContextX64->R15\r
    );\r
  InternalPrintMessage (\r
    "DS   - %016lx, ES  - %016lx, FS  - %016lx\n",\r
    SystemContext.SystemContextX64->Ds,\r
    SystemContext.SystemContextX64->Es,\r
    SystemContext.SystemContextX64->Fs\r
    );\r
  InternalPrintMessage (\r
    "GS   - %016lx, SS  - %016lx\n",\r
    SystemContext.SystemContextX64->Gs,\r
    SystemContext.SystemContextX64->Ss\r
    );\r
  InternalPrintMessage (\r
    "CR0  - %016lx, CR2 - %016lx, CR3 - %016lx\n",\r
    SystemContext.SystemContextX64->Cr0,\r
    SystemContext.SystemContextX64->Cr2,\r
    SystemContext.SystemContextX64->Cr3\r
    );\r
  InternalPrintMessage (\r
    "CR4  - %016lx, CR8 - %016lx\n",\r
    SystemContext.SystemContextX64->Cr4,\r
    SystemContext.SystemContextX64->Cr8\r
    );\r
  InternalPrintMessage (\r
    "DR0  - %016lx, DR1 - %016lx, DR2 - %016lx\n",\r
    SystemContext.SystemContextX64->Dr0,\r
    SystemContext.SystemContextX64->Dr1,\r
    SystemContext.SystemContextX64->Dr2\r
    );\r
  InternalPrintMessage (\r
    "DR3  - %016lx, DR6 - %016lx, DR7 - %016lx\n",\r
    SystemContext.SystemContextX64->Dr3,\r
    SystemContext.SystemContextX64->Dr6,\r
    SystemContext.SystemContextX64->Dr7\r
    );\r
  InternalPrintMessage (\r
    "GDTR - %016lx %016lx, LDTR - %016lx\n",\r
    SystemContext.SystemContextX64->Gdtr[0],\r
    SystemContext.SystemContextX64->Gdtr[1],\r
    SystemContext.SystemContextX64->Ldtr\r
    );\r
  InternalPrintMessage (\r
    "IDTR - %016lx %016lx,   TR - %016lx\n",\r
    SystemContext.SystemContextX64->Idtr[0],\r
    SystemContext.SystemContextX64->Idtr[1],\r
    SystemContext.SystemContextX64->Tr\r
    );\r
	InternalPrintMessage (\r
    "FXSAVE_STATE - %016lx\n",\r
    &SystemContext.SystemContextX64->FxSaveState\r
    );\r
\r
  //\r
  // Find module image base and module entry point by RIP\r
  //\r
  ImageBase = FindModuleImageBase (SystemContext.SystemContextX64->Rip, &EntryPoint);\r
  if (ImageBase != 0) {\r
    InternalPrintMessage (\r
      " (ImageBase=%016lx, EntryPoint=%016lx) !!!!\n",\r
      ImageBase,\r
      EntryPoint\r
      );\r
  }\r
}\r