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

/** @file\r
  x64 CPU Exception Handler.\r
\r
  Copyright (c) 2012 - 2017, 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[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 EXCEPTION_HANDLER_DATA       *ExceptionHandlerData\r
  )\r
{\r
  RESERVED_VECTORS_DATA   *ReservedVectors;\r
\r
  ReservedVectors = ExceptionHandlerData->ReservedVectors;\r
  SystemContext.SystemContextX64->Ss            = ReservedVectors[ExceptionType].OldSs;\r
  SystemContext.SystemContextX64->Rsp           = ReservedVectors[ExceptionType].OldSp;\r
  SystemContext.SystemContextX64->Rflags        = ReservedVectors[ExceptionType].OldFlags;\r
  SystemContext.SystemContextX64->Cs            = ReservedVectors[ExceptionType].OldCs;\r
  SystemContext.SystemContextX64->Rip           = ReservedVectors[ExceptionType].OldIp;\r
  SystemContext.SystemContextX64->ExceptionData = ReservedVectors[ExceptionType].ExceptionData;\r
}\r
\r
/**\r
  Setup separate stack for given exceptions.\r
\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
ArchSetupExcpetionStack (\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
\r
  if (StackSwitchData == NULL ||\r
      StackSwitchData->Ia32.Revision != CPU_EXCEPTION_INIT_DATA_REV ||\r
      StackSwitchData->X64.KnownGoodStackTop == 0 ||\r
      StackSwitchData->X64.KnownGoodStackSize == 0 ||\r
      StackSwitchData->X64.StackSwitchExceptions == NULL ||\r
      StackSwitchData->X64.StackSwitchExceptionNumber == 0 ||\r
      StackSwitchData->X64.StackSwitchExceptionNumber > CPU_EXCEPTION_NUM ||\r
      StackSwitchData->X64.GdtTable == NULL ||\r
      StackSwitchData->X64.IdtTable == NULL ||\r
      StackSwitchData->X64.ExceptionTssDesc == NULL ||\r
      StackSwitchData->X64.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->X64.GdtTable & (IA32_GDT_ALIGNMENT - 1)) != 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if ((UINTN)StackSwitchData->X64.ExceptionTssDesc < (UINTN)(StackSwitchData->X64.GdtTable)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (((UINTN)StackSwitchData->X64.ExceptionTssDesc + StackSwitchData->X64.ExceptionTssDescSize) >\r
      ((UINTN)(StackSwitchData->X64.GdtTable) + StackSwitchData->X64.GdtTableSize)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // One task gate descriptor and one task-state segment are needed.\r
  //\r
  if (StackSwitchData->X64.ExceptionTssDescSize < sizeof (IA32_TSS_DESCRIPTOR)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  if (StackSwitchData->X64.ExceptionTssSize < sizeof (IA32_TASK_STATE_SEGMENT)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Interrupt stack table supports only 7 vectors.\r
  //\r
  TssDesc = StackSwitchData->X64.ExceptionTssDesc;\r
  Tss     = StackSwitchData->X64.ExceptionTss;\r
  if (StackSwitchData->X64.StackSwitchExceptionNumber > ARRAY_SIZE (Tss->IST)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\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 + sizeof (IA32_TSS_DESCRIPTOR) -\r
            (UINTN)(StackSwitchData->X64.GdtTable);\r
  if ((UINTN)StackSwitchData->X64.GdtTable != Gdtr.Base) {\r
    CopyMem (StackSwitchData->X64.GdtTable, (VOID *)Gdtr.Base, Gdtr.Limit + 1);\r
    Gdtr.Base = (UINTN)StackSwitchData->X64.GdtTable;\r
    Gdtr.Limit = (UINT16)GdtSize - 1;\r
  }\r
\r
  if ((UINTN)StackSwitchData->X64.IdtTable != Idtr.Base) {\r
    Idtr.Base = (UINTN)StackSwitchData->X64.IdtTable;\r
  }\r
  if (StackSwitchData->X64.IdtTableSize > 0) {\r
    Idtr.Limit = (UINT16)(StackSwitchData->X64.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->Bits.LimitLow   = sizeof(IA32_TASK_STATE_SEGMENT) - 1;\r
  TssDesc->Bits.BaseLow    = (UINT16)TssBase;\r
  TssDesc->Bits.BaseMidl   = (UINT8)(TssBase >> 16);\r
  TssDesc->Bits.Type       = IA32_GDT_TYPE_TSS;\r
  TssDesc->Bits.P          = 1;\r
  TssDesc->Bits.LimitHigh  = 0;\r
  TssDesc->Bits.BaseMidh   = (UINT8)(TssBase >> 24);\r
  TssDesc->Bits.BaseHigh   = (UINT32)(TssBase >> 32);\r
\r
  //\r
  // Fixup exception task descriptor and task-state segment\r
  //\r
  StackTop = StackSwitchData->X64.KnownGoodStackTop - CPU_STACK_ALIGNMENT;\r
  StackTop = (UINTN)ALIGN_POINTER (StackTop, CPU_STACK_ALIGNMENT);\r
  IdtTable = StackSwitchData->X64.IdtTable;\r
  for (Index = 0; Index < StackSwitchData->X64.StackSwitchExceptionNumber; ++Index) {\r
    //\r
    // Fixup IST\r
    //\r
    Tss->IST[Index] = StackTop;\r
    StackTop -= StackSwitchData->X64.KnownGoodStackSize;\r
\r
    //\r
    // Set the IST field to enable corresponding IST\r
    //\r
    Vector = StackSwitchData->X64.StackSwitchExceptions[Index];\r
    if (Vector >= CPU_EXCEPTION_NUM ||\r
        Vector >= (Idtr.Limit + 1) / sizeof (IA32_IDT_GATE_DESCRIPTOR)) {\r
      continue;\r
    }\r
    IdtTable[Vector].Bits.Reserved_0 = (UINT8)(Index + 1);\r
  }\r
\r
  //\r
  // Publish GDT\r
  //\r
  AsmWriteGdtr (&Gdtr);\r
\r
  //\r
  // Load current task\r
  //\r
  AsmWriteTr ((UINT16)((UINTN)StackSwitchData->X64.ExceptionTssDesc - Gdtr.Base));\r
\r
  //\r
  // Publish IDT\r
  //\r
  AsmWriteIdtr (&Idtr);\r
\r
  return EFI_SUCCESS;\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
EFIAPI\r
DumpCpuContext (\r
  IN EFI_EXCEPTION_TYPE   ExceptionType,\r
  IN EFI_SYSTEM_CONTEXT   SystemContext\r
  )\r
{\r
  InternalPrintMessage (\r
    "!!!! X64 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 - %016lx",\r
      SystemContext.SystemContextX64->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.SystemContextX64->ExceptionData & IA32_PF_EC_ID)   != 0,\r
        (SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_RSVD) != 0,\r
        (SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_US)   != 0,\r
        (SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_WR)   != 0,\r
        (SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_P)    != 0,\r
        (SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_PK)   != 0,\r
        (SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_SGX)  != 0\r
        );\r
    }\r
    InternalPrintMessage ("\n");\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
  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
/**\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
  // Dump module image base and module entry point by RIP\r
  //\r
  if ((ExceptionType == EXCEPT_IA32_PAGE_FAULT) &&\r
      ((SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_ID) != 0)) {\r
    //\r
    // The RIP in SystemContext could not be used\r
    // if it is page fault with I/D set.\r
    //\r
    DumpModuleImageInfo ((*(UINTN *)(UINTN)SystemContext.SystemContextX64->Rsp));\r
  } else {\r
    DumpModuleImageInfo (SystemContext.SystemContextX64->Rip);\r
  }\r
}\r
Commit	Line	Data
8f07f895	1	/** @file\r
e3644786	2	x64 CPU Exception Handler.\r
8f07f895	3	\r
1b2f7b3e	4	Copyright (c) 2012 - 2017, Intel Corporation. All rights reserved.<BR>\r
8f07f895	5	This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#include "CpuExceptionCommon.h"\r
	16	\r
	17	/**\r
e41aad15 JF	18	Return address map of exception handler template so that C code can generate\r
e41aad15 JF	19	exception tables.\r
8f07f895	20	\r
e41aad15 JF	21	@param IdtEntry Pointer to IDT entry to be updated.\r
e41aad15 JF	22	@param InterruptHandler IDT handler value.\r
8f07f895	23	**/\r
8f07f895	24	VOID\r
e41aad15 JF	25	ArchUpdateIdtEntry (\r
	26	IN IA32_IDT_GATE_DESCRIPTOR *IdtEntry,\r
	27	IN UINTN InterruptHandler\r
8f07f895	28	)\r
8f07f895	29	{\r
e41aad15 JF	30	IdtEntry->Bits.OffsetLow = (UINT16)(UINTN)InterruptHandler;\r
e41aad15 JF	31	IdtEntry->Bits.OffsetHigh = (UINT16)((UINTN)InterruptHandler >> 16);\r
dd563742	32	IdtEntry->Bits.OffsetUpper = (UINT32)((UINTN)InterruptHandler >> 32);\r
e41aad15 JF	33	IdtEntry->Bits.GateType = IA32_IDT_GATE_TYPE_INTERRUPT_32;\r
	34	}\r
	35	\r
	36	/**\r
	37	Read IDT handler value from IDT entry.\r
	38	\r
	39	@param IdtEntry Pointer to IDT entry to be read.\r
	40	\r
	41	**/\r
	42	UINTN\r
	43	ArchGetIdtHandler (\r
	44	IN IA32_IDT_GATE_DESCRIPTOR *IdtEntry\r
	45	)\r
	46	{\r
	47	return IdtEntry->Bits.OffsetLow + (((UINTN) IdtEntry->Bits.OffsetHigh) << 16) +\r
	48	(((UINTN) IdtEntry->Bits.OffsetUpper) << 32);\r
	49	}\r
8f07f895	50	\r
e41aad15 JF	51	/**\r
	52	Save CPU exception context when handling EFI_VECTOR_HANDOFF_HOOK_AFTER case.\r
	53	\r
81b21fc2 JF	54	@param[in] ExceptionType Exception type.\r
	55	@param[in] SystemContext Pointer to EFI_SYSTEM_CONTEXT.\r
	56	@param[in] ExceptionHandlerData Pointer to exception handler data.\r
e41aad15 JF	57	**/\r
	58	VOID\r
	59	ArchSaveExceptionContext (\r
81b21fc2 JF	60	IN UINTN ExceptionType,\r
	61	IN EFI_SYSTEM_CONTEXT SystemContext,\r
	62	IN EXCEPTION_HANDLER_DATA *ExceptionHandlerData\r
e41aad15 JF	63	)\r
	64	{\r
	65	IA32_EFLAGS32 Eflags;\r
81b21fc2 JF	66	RESERVED_VECTORS_DATA *ReservedVectors;\r
	67	\r
	68	ReservedVectors = ExceptionHandlerData->ReservedVectors;\r
8f07f895	69	//\r
e41aad15	70	// Save Exception context in global variable\r
8f07f895	71	//\r
81b21fc2 JF	72	ReservedVectors[ExceptionType].OldSs = SystemContext.SystemContextX64->Ss;\r
	73	ReservedVectors[ExceptionType].OldSp = SystemContext.SystemContextX64->Rsp;\r
	74	ReservedVectors[ExceptionType].OldFlags = SystemContext.SystemContextX64->Rflags;\r
	75	ReservedVectors[ExceptionType].OldCs = SystemContext.SystemContextX64->Cs;\r
	76	ReservedVectors[ExceptionType].OldIp = SystemContext.SystemContextX64->Rip;\r
	77	ReservedVectors[ExceptionType].ExceptionData = SystemContext.SystemContextX64->ExceptionData;\r
8f07f895	78	//\r
e41aad15	79	// Clear IF flag to avoid old IDT handler enable interrupt by IRET\r
8f07f895	80	//\r
e41aad15	81	Eflags.UintN = SystemContext.SystemContextX64->Rflags;\r
dd563742	82	Eflags.Bits.IF = 0;\r
e41aad15 JF	83	SystemContext.SystemContextX64->Rflags = Eflags.UintN;\r
	84	//\r
	85	// Modify the EIP in stack, then old IDT handler will return to the stub code\r
	86	//\r
81b21fc2	87	SystemContext.SystemContextX64->Rip = (UINTN) ReservedVectors[ExceptionType].HookAfterStubHeaderCode;\r
8f07f895	88	}\r
	89	\r
	90	/**\r
e41aad15	91	Restore CPU exception context when handling EFI_VECTOR_HANDOFF_HOOK_AFTER case.\r
8f07f895	92	\r
368c54e7 JF	93	@param[in] ExceptionType Exception type.\r
	94	@param[in] SystemContext Pointer to EFI_SYSTEM_CONTEXT.\r
	95	@param[in] ExceptionHandlerData Pointer to exception handler data.\r
8f07f895	96	**/\r
8f07f895	97	VOID\r
e41aad15	98	ArchRestoreExceptionContext (\r
368c54e7 JF	99	IN UINTN ExceptionType,\r
	100	IN EFI_SYSTEM_CONTEXT SystemContext,\r
	101	IN EXCEPTION_HANDLER_DATA *ExceptionHandlerData\r
e41aad15 JF	102	)\r
e41aad15 JF	103	{\r
368c54e7 JF	104	RESERVED_VECTORS_DATA *ReservedVectors;\r
	105	\r
	106	ReservedVectors = ExceptionHandlerData->ReservedVectors;\r
	107	SystemContext.SystemContextX64->Ss = ReservedVectors[ExceptionType].OldSs;\r
	108	SystemContext.SystemContextX64->Rsp = ReservedVectors[ExceptionType].OldSp;\r
	109	SystemContext.SystemContextX64->Rflags = ReservedVectors[ExceptionType].OldFlags;\r
	110	SystemContext.SystemContextX64->Cs = ReservedVectors[ExceptionType].OldCs;\r
	111	SystemContext.SystemContextX64->Rip = ReservedVectors[ExceptionType].OldIp;\r
	112	SystemContext.SystemContextX64->ExceptionData = ReservedVectors[ExceptionType].ExceptionData;\r
e41aad15 JF	113	}\r
e41aad15 JF	114	\r
0ff5aa9c JW	115	/**\r
	116	Setup separate stack for given exceptions.\r
	117	\r
	118	@param[in] StackSwitchData Pointer to data required for setuping up\r
	119	stack switch.\r
	120	\r
	121	@retval EFI_SUCCESS The exceptions have been successfully\r
	122	initialized with new stack.\r
	123	@retval EFI_INVALID_PARAMETER StackSwitchData contains invalid content.\r
	124	\r
	125	**/\r
	126	EFI_STATUS\r
	127	ArchSetupExcpetionStack (\r
	128	IN CPU_EXCEPTION_INIT_DATA *StackSwitchData\r
	129	)\r
	130	{\r
	131	IA32_DESCRIPTOR Gdtr;\r
	132	IA32_DESCRIPTOR Idtr;\r
	133	IA32_IDT_GATE_DESCRIPTOR *IdtTable;\r
	134	IA32_TSS_DESCRIPTOR *TssDesc;\r
	135	IA32_TASK_STATE_SEGMENT *Tss;\r
	136	UINTN StackTop;\r
	137	UINTN Index;\r
	138	UINTN Vector;\r
	139	UINTN TssBase;\r
	140	UINTN GdtSize;\r
	141	\r
	142	if (StackSwitchData == NULL \|\|\r
	143	StackSwitchData->Ia32.Revision != CPU_EXCEPTION_INIT_DATA_REV \|\|\r
	144	StackSwitchData->X64.KnownGoodStackTop == 0 \|\|\r
	145	StackSwitchData->X64.KnownGoodStackSize == 0 \|\|\r
	146	StackSwitchData->X64.StackSwitchExceptions == NULL \|\|\r
	147	StackSwitchData->X64.StackSwitchExceptionNumber == 0 \|\|\r
	148	StackSwitchData->X64.StackSwitchExceptionNumber > CPU_EXCEPTION_NUM \|\|\r
	149	StackSwitchData->X64.GdtTable == NULL \|\|\r
	150	StackSwitchData->X64.IdtTable == NULL \|\|\r
	151	StackSwitchData->X64.ExceptionTssDesc == NULL \|\|\r
	152	StackSwitchData->X64.ExceptionTss == NULL) {\r
	153	return EFI_INVALID_PARAMETER;\r
	154	}\r
	155	\r
	156	//\r
	157	// The caller is responsible for that the GDT table, no matter the existing\r
	158	// one or newly allocated, has enough space to hold descriptors for exception\r
	159	// task-state segments.\r
	160	//\r
	161	if (((UINTN)StackSwitchData->X64.GdtTable & (IA32_GDT_ALIGNMENT - 1)) != 0) {\r
	162	return EFI_INVALID_PARAMETER;\r
	163	}\r
	164	\r
	165	if ((UINTN)StackSwitchData->X64.ExceptionTssDesc < (UINTN)(StackSwitchData->X64.GdtTable)) {\r
	166	return EFI_INVALID_PARAMETER;\r
	167	}\r
	168	\r
	169	if (((UINTN)StackSwitchData->X64.ExceptionTssDesc + StackSwitchData->X64.ExceptionTssDescSize) >\r
	170	((UINTN)(StackSwitchData->X64.GdtTable) + StackSwitchData->X64.GdtTableSize)) {\r
	171	return EFI_INVALID_PARAMETER;\r
	172	}\r
	173	\r
	174	//\r
	175	// One task gate descriptor and one task-state segment are needed.\r
	176	//\r
	177	if (StackSwitchData->X64.ExceptionTssDescSize < sizeof (IA32_TSS_DESCRIPTOR)) {\r
	178	return EFI_INVALID_PARAMETER;\r
179	}\r
180	if (StackSwitchData->X64.ExceptionTssSize < sizeof (IA32_TASK_STATE_SEGMENT)) {\r
181	return EFI_INVALID_PARAMETER;\r
182	}\r
183	\r
184	//\r
185	// Interrupt stack table supports only 7 vectors.\r
186	//\r
187	TssDesc = StackSwitchData->X64.ExceptionTssDesc;\r
188	Tss = StackSwitchData->X64.ExceptionTss;\r
d69ba6a7	189	if (StackSwitchData->X64.StackSwitchExceptionNumber > ARRAY_SIZE (Tss->IST)) {\r
0ff5aa9c JW	190	return EFI_INVALID_PARAMETER;\r
	191	}\r
	192	\r
	193	//\r
	194	// Initialize new GDT table and/or IDT table, if any\r
	195	//\r
	196	AsmReadIdtr (&Idtr);\r
	197	AsmReadGdtr (&Gdtr);\r
	198	\r
	199	GdtSize = (UINTN)TssDesc + sizeof (IA32_TSS_DESCRIPTOR) -\r
	200	(UINTN)(StackSwitchData->X64.GdtTable);\r
	201	if ((UINTN)StackSwitchData->X64.GdtTable != Gdtr.Base) {\r
	202	CopyMem (StackSwitchData->X64.GdtTable, (VOID *)Gdtr.Base, Gdtr.Limit + 1);\r
	203	Gdtr.Base = (UINTN)StackSwitchData->X64.GdtTable;\r
	204	Gdtr.Limit = (UINT16)GdtSize - 1;\r
	205	}\r
	206	\r
	207	if ((UINTN)StackSwitchData->X64.IdtTable != Idtr.Base) {\r
	208	Idtr.Base = (UINTN)StackSwitchData->X64.IdtTable;\r
	209	}\r
	210	if (StackSwitchData->X64.IdtTableSize > 0) {\r
	211	Idtr.Limit = (UINT16)(StackSwitchData->X64.IdtTableSize - 1);\r
	212	}\r
	213	\r
	214	//\r
	215	// Fixup current task descriptor. Task-state segment for current task will\r
	216	// be filled by processor during task switching.\r
	217	//\r
	218	TssBase = (UINTN)Tss;\r
	219	\r
	220	TssDesc->Bits.LimitLow = sizeof(IA32_TASK_STATE_SEGMENT) - 1;\r
	221	TssDesc->Bits.BaseLow = (UINT16)TssBase;\r
	222	TssDesc->Bits.BaseMidl = (UINT8)(TssBase >> 16);\r
	223	TssDesc->Bits.Type = IA32_GDT_TYPE_TSS;\r
d69ba6a7	224	TssDesc->Bits.P = 1;\r
0ff5aa9c JW	225	TssDesc->Bits.LimitHigh = 0;\r
	226	TssDesc->Bits.BaseMidh = (UINT8)(TssBase >> 24);\r
	227	TssDesc->Bits.BaseHigh = (UINT32)(TssBase >> 32);\r
	228	\r
	229	//\r
	230	// Fixup exception task descriptor and task-state segment\r
	231	//\r
	232	StackTop = StackSwitchData->X64.KnownGoodStackTop - CPU_STACK_ALIGNMENT;\r
	233	StackTop = (UINTN)ALIGN_POINTER (StackTop, CPU_STACK_ALIGNMENT);\r
	234	IdtTable = StackSwitchData->X64.IdtTable;\r
	235	for (Index = 0; Index < StackSwitchData->X64.StackSwitchExceptionNumber; ++Index) {\r
	236	//\r
	237	// Fixup IST\r
	238	//\r
d69ba6a7	239	Tss->IST[Index] = StackTop;\r
0ff5aa9c JW	240	StackTop -= StackSwitchData->X64.KnownGoodStackSize;\r
	241	\r
	242	//\r
	243	// Set the IST field to enable corresponding IST\r
	244	//\r
	245	Vector = StackSwitchData->X64.StackSwitchExceptions[Index];\r
	246	if (Vector >= CPU_EXCEPTION_NUM \|\|\r
	247	Vector >= (Idtr.Limit + 1) / sizeof (IA32_IDT_GATE_DESCRIPTOR)) {\r
	248	continue;\r
	249	}\r
	250	IdtTable[Vector].Bits.Reserved_0 = (UINT8)(Index + 1);\r
	251	}\r
	252	\r
	253	//\r
	254	// Publish GDT\r
	255	//\r
	256	AsmWriteGdtr (&Gdtr);\r
	257	\r
	258	//\r
	259	// Load current task\r
	260	//\r
	261	AsmWriteTr ((UINT16)((UINTN)StackSwitchData->X64.ExceptionTssDesc - Gdtr.Base));\r
	262	\r
	263	//\r
	264	// Publish IDT\r
	265	//\r
	266	AsmWriteIdtr (&Idtr);\r
	267	\r
	268	return EFI_SUCCESS;\r
	269	}\r
	270	\r
e41aad15	271	/**\r
3f25e6ea	272	Display CPU information.\r
e41aad15 JF	273	\r
	274	@param ExceptionType Exception type.\r
	275	@param SystemContext Pointer to EFI_SYSTEM_CONTEXT.\r
	276	**/\r
	277	VOID\r
1b2f7b3e JF	278	EFIAPI\r
1b2f7b3e JF	279	DumpCpuContext (\r
e41aad15	280	IN EFI_EXCEPTION_TYPE ExceptionType,\r
8f07f895	281	IN EFI_SYSTEM_CONTEXT SystemContext\r
	282	)\r
	283	{\r
8f07f895	284	InternalPrintMessage (\r
a51ee144	285	"!!!! X64 Exception Type - %02x(%a) CPU Apic ID - %08x !!!!\n",\r
8f07f895	286	ExceptionType,\r
a51ee144	287	GetExceptionNameStr (ExceptionType),\r
8f07f895	288	GetApicId ()\r
8f07f895	289	);\r
1b2f7b3e JF	290	if ((mErrorCodeFlag & (1 << ExceptionType)) != 0) {\r
	291	InternalPrintMessage (\r
	292	"ExceptionData - %016lx",\r
	293	SystemContext.SystemContextX64->ExceptionData\r
	294	);\r
	295	if (ExceptionType == EXCEPT_IA32_PAGE_FAULT) {\r
	296	InternalPrintMessage (\r
	297	" I:%x R:%x U:%x W:%x P:%x PK:%x S:%x",\r
	298	(SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_ID) != 0,\r
	299	(SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_RSVD) != 0,\r
	300	(SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_US) != 0,\r
	301	(SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_WR) != 0,\r
	302	(SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_P) != 0,\r
	303	(SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_PK) != 0,\r
	304	(SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_SGX) != 0\r
	305	);\r
	306	}\r
	307	InternalPrintMessage ("\n");\r
	308	}\r
8f07f895	309	InternalPrintMessage (\r
	310	"RIP - %016lx, CS - %016lx, RFLAGS - %016lx\n",\r
	311	SystemContext.SystemContextX64->Rip,\r
	312	SystemContext.SystemContextX64->Cs,\r
	313	SystemContext.SystemContextX64->Rflags\r
	314	);\r
8f07f895	315	InternalPrintMessage (\r
	316	"RAX - %016lx, RCX - %016lx, RDX - %016lx\n",\r
	317	SystemContext.SystemContextX64->Rax,\r
	318	SystemContext.SystemContextX64->Rcx,\r
	319	SystemContext.SystemContextX64->Rdx\r
	320	);\r
	321	InternalPrintMessage (\r
	322	"RBX - %016lx, RSP - %016lx, RBP - %016lx\n",\r
	323	SystemContext.SystemContextX64->Rbx,\r
	324	SystemContext.SystemContextX64->Rsp,\r
	325	SystemContext.SystemContextX64->Rbp\r
	326	);\r
	327	InternalPrintMessage (\r
	328	"RSI - %016lx, RDI - %016lx\n",\r
	329	SystemContext.SystemContextX64->Rsi,\r
	330	SystemContext.SystemContextX64->Rdi\r
	331	);\r
	332	InternalPrintMessage (\r
	333	"R8 - %016lx, R9 - %016lx, R10 - %016lx\n",\r
	334	SystemContext.SystemContextX64->R8,\r
	335	SystemContext.SystemContextX64->R9,\r
	336	SystemContext.SystemContextX64->R10\r
	337	);\r
	338	InternalPrintMessage (\r
	339	"R11 - %016lx, R12 - %016lx, R13 - %016lx\n",\r
	340	SystemContext.SystemContextX64->R11,\r
	341	SystemContext.SystemContextX64->R12,\r
	342	SystemContext.SystemContextX64->R13\r
	343	);\r
	344	InternalPrintMessage (\r
	345	"R14 - %016lx, R15 - %016lx\n",\r
	346	SystemContext.SystemContextX64->R14,\r
	347	SystemContext.SystemContextX64->R15\r
	348	);\r
	349	InternalPrintMessage (\r
	350	"DS - %016lx, ES - %016lx, FS - %016lx\n",\r
	351	SystemContext.SystemContextX64->Ds,\r
	352	SystemContext.SystemContextX64->Es,\r
	353	SystemContext.SystemContextX64->Fs\r
	354	);\r
	355	InternalPrintMessage (\r
	356	"GS - %016lx, SS - %016lx\n",\r
	357	SystemContext.SystemContextX64->Gs,\r
	358	SystemContext.SystemContextX64->Ss\r
	359	);\r
	360	InternalPrintMessage (\r
	361	"CR0 - %016lx, CR2 - %016lx, CR3 - %016lx\n",\r
	362	SystemContext.SystemContextX64->Cr0,\r
	363	SystemContext.SystemContextX64->Cr2,\r
	364	SystemContext.SystemContextX64->Cr3\r
	365	);\r
	366	InternalPrintMessage (\r
	367	"CR4 - %016lx, CR8 - %016lx\n",\r
	368	SystemContext.SystemContextX64->Cr4,\r
	369	SystemContext.SystemContextX64->Cr8\r
	370	);\r
	371	InternalPrintMessage (\r
	372	"DR0 - %016lx, DR1 - %016lx, DR2 - %016lx\n",\r
	373	SystemContext.SystemContextX64->Dr0,\r
	374	SystemContext.SystemContextX64->Dr1,\r
	375	SystemContext.SystemContextX64->Dr2\r
	376	);\r
	377	InternalPrintMessage (\r
	378	"DR3 - %016lx, DR6 - %016lx, DR7 - %016lx\n",\r
379	SystemContext.SystemContextX64->Dr3,\r
380	SystemContext.SystemContextX64->Dr6,\r
381	SystemContext.SystemContextX64->Dr7\r
382	);\r
383	InternalPrintMessage (\r
384	"GDTR - %016lx %016lx, LDTR - %016lx\n",\r
385	SystemContext.SystemContextX64->Gdtr[0],\r
386	SystemContext.SystemContextX64->Gdtr[1],\r
387	SystemContext.SystemContextX64->Ldtr\r
388	);\r
389	InternalPrintMessage (\r
390	"IDTR - %016lx %016lx, TR - %016lx\n",\r
391	SystemContext.SystemContextX64->Idtr[0],\r
392	SystemContext.SystemContextX64->Idtr[1],\r
393	SystemContext.SystemContextX64->Tr\r
394	);\r
dd563742	395	InternalPrintMessage (\r
8f07f895	396	"FXSAVE_STATE - %016lx\n",\r
	397	&SystemContext.SystemContextX64->FxSaveState\r
	398	);\r
1b2f7b3e	399	}\r
8f07f895	400	\r
1b2f7b3e JF	401	/**\r
	402	Display CPU information.\r
	403	\r
	404	@param ExceptionType Exception type.\r
	405	@param SystemContext Pointer to EFI_SYSTEM_CONTEXT.\r
	406	**/\r
	407	VOID\r
	408	DumpImageAndCpuContent (\r
	409	IN EFI_EXCEPTION_TYPE ExceptionType,\r
	410	IN EFI_SYSTEM_CONTEXT SystemContext\r
	411	)\r
	412	{\r
	413	DumpCpuContext (ExceptionType, SystemContext);\r
8f07f895	414	//\r
1b2f7b3e	415	// Dump module image base and module entry point by RIP\r
8f07f895	416	//\r
bb207f6c SZ	417	if ((ExceptionType == EXCEPT_IA32_PAGE_FAULT) &&\r
	418	((SystemContext.SystemContextX64->ExceptionData & IA32_PF_EC_ID) != 0)) {\r
	419	//\r
	420	// The RIP in SystemContext could not be used\r
	421	// if it is page fault with I/D set.\r
	422	//\r
	423	DumpModuleImageInfo (((UINTN )(UINTN)SystemContext.SystemContextX64->Rsp));\r
	424	} else {\r
	425	DumpModuleImageInfo (SystemContext.SystemContextX64->Rip);\r
	426	}\r
8f07f895	427	}\r