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

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