[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[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
  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
Commit	Line	Data
8f07f895	1	/** @file\r
e3644786	2	x64 CPU Exception Handler.\r
8f07f895	3	\r
81b21fc2	4	Copyright (c) 2012 - 2016, 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
	31	IdtEntry->Bits.OffsetHigh = (UINT16)((UINTN)InterruptHandler >> 16);\r
	32	IdtEntry->Bits.OffsetUpper = (UINT32)((UINTN)InterruptHandler >> 32); \r
	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 JF	81	Eflags.UintN = SystemContext.SystemContextX64->Rflags;\r
	82	Eflags.Bits.IF = 0; \r
	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
	114	\r
	115	/**\r
3f25e6ea	116	Display CPU information.\r
e41aad15 JF	117	\r
	118	@param ExceptionType Exception type.\r
	119	@param SystemContext Pointer to EFI_SYSTEM_CONTEXT.\r
	120	**/\r
	121	VOID\r
	122	DumpCpuContent (\r
	123	IN EFI_EXCEPTION_TYPE ExceptionType,\r
8f07f895	124	IN EFI_SYSTEM_CONTEXT SystemContext\r
	125	)\r
	126	{\r
	127	UINTN ImageBase;\r
	128	UINTN EntryPoint;\r
	129	\r
	130	InternalPrintMessage (\r
a51ee144	131	"!!!! X64 Exception Type - %02x(%a) CPU Apic ID - %08x !!!!\n",\r
8f07f895	132	ExceptionType,\r
a51ee144	133	GetExceptionNameStr (ExceptionType),\r
8f07f895	134	GetApicId ()\r
8f07f895	135	);\r
a51ee144	136	\r
8f07f895	137	InternalPrintMessage (\r
	138	"RIP - %016lx, CS - %016lx, RFLAGS - %016lx\n",\r
	139	SystemContext.SystemContextX64->Rip,\r
	140	SystemContext.SystemContextX64->Cs,\r
	141	SystemContext.SystemContextX64->Rflags\r
	142	);\r
	143	if (mErrorCodeFlag & (1 << ExceptionType)) {\r
	144	InternalPrintMessage (\r
	145	"ExceptionData - %016lx\n",\r
	146	SystemContext.SystemContextX64->ExceptionData\r
	147	);\r
	148	}\r
	149	InternalPrintMessage (\r
	150	"RAX - %016lx, RCX - %016lx, RDX - %016lx\n",\r
	151	SystemContext.SystemContextX64->Rax,\r
	152	SystemContext.SystemContextX64->Rcx,\r
	153	SystemContext.SystemContextX64->Rdx\r
	154	);\r
	155	InternalPrintMessage (\r
	156	"RBX - %016lx, RSP - %016lx, RBP - %016lx\n",\r
	157	SystemContext.SystemContextX64->Rbx,\r
	158	SystemContext.SystemContextX64->Rsp,\r
	159	SystemContext.SystemContextX64->Rbp\r
	160	);\r
	161	InternalPrintMessage (\r
	162	"RSI - %016lx, RDI - %016lx\n",\r
	163	SystemContext.SystemContextX64->Rsi,\r
	164	SystemContext.SystemContextX64->Rdi\r
	165	);\r
	166	InternalPrintMessage (\r
	167	"R8 - %016lx, R9 - %016lx, R10 - %016lx\n",\r
	168	SystemContext.SystemContextX64->R8,\r
	169	SystemContext.SystemContextX64->R9,\r
	170	SystemContext.SystemContextX64->R10\r
	171	);\r
	172	InternalPrintMessage (\r
	173	"R11 - %016lx, R12 - %016lx, R13 - %016lx\n",\r
	174	SystemContext.SystemContextX64->R11,\r
	175	SystemContext.SystemContextX64->R12,\r
	176	SystemContext.SystemContextX64->R13\r
	177	);\r
	178	InternalPrintMessage (\r
	179	"R14 - %016lx, R15 - %016lx\n",\r
	180	SystemContext.SystemContextX64->R14,\r
	181	SystemContext.SystemContextX64->R15\r
	182	);\r
	183	InternalPrintMessage (\r
	184	"DS - %016lx, ES - %016lx, FS - %016lx\n",\r
	185	SystemContext.SystemContextX64->Ds,\r
	186	SystemContext.SystemContextX64->Es,\r
	187	SystemContext.SystemContextX64->Fs\r
	188	);\r
	189	InternalPrintMessage (\r
	190	"GS - %016lx, SS - %016lx\n",\r
	191	SystemContext.SystemContextX64->Gs,\r
	192	SystemContext.SystemContextX64->Ss\r
	193	);\r
	194	InternalPrintMessage (\r
	195	"CR0 - %016lx, CR2 - %016lx, CR3 - %016lx\n",\r
	196	SystemContext.SystemContextX64->Cr0,\r
	197	SystemContext.SystemContextX64->Cr2,\r
	198	SystemContext.SystemContextX64->Cr3\r
	199	);\r
	200	InternalPrintMessage (\r
201	"CR4 - %016lx, CR8 - %016lx\n",\r
202	SystemContext.SystemContextX64->Cr4,\r
203	SystemContext.SystemContextX64->Cr8\r
204	);\r
205	InternalPrintMessage (\r
206	"DR0 - %016lx, DR1 - %016lx, DR2 - %016lx\n",\r
207	SystemContext.SystemContextX64->Dr0,\r
208	SystemContext.SystemContextX64->Dr1,\r
209	SystemContext.SystemContextX64->Dr2\r
210	);\r
211	InternalPrintMessage (\r
212	"DR3 - %016lx, DR6 - %016lx, DR7 - %016lx\n",\r
213	SystemContext.SystemContextX64->Dr3,\r
214	SystemContext.SystemContextX64->Dr6,\r
215	SystemContext.SystemContextX64->Dr7\r
216	);\r
217	InternalPrintMessage (\r
218	"GDTR - %016lx %016lx, LDTR - %016lx\n",\r
219	SystemContext.SystemContextX64->Gdtr[0],\r
220	SystemContext.SystemContextX64->Gdtr[1],\r
221	SystemContext.SystemContextX64->Ldtr\r
222	);\r
223	InternalPrintMessage (\r
224	"IDTR - %016lx %016lx, TR - %016lx\n",\r
225	SystemContext.SystemContextX64->Idtr[0],\r
226	SystemContext.SystemContextX64->Idtr[1],\r
227	SystemContext.SystemContextX64->Tr\r
228	);\r
229	InternalPrintMessage (\r
230	"FXSAVE_STATE - %016lx\n",\r
231	&SystemContext.SystemContextX64->FxSaveState\r
232	);\r
233	\r
234	//\r
235	// Find module image base and module entry point by RIP\r
236	//\r
237	ImageBase = FindModuleImageBase (SystemContext.SystemContextX64->Rip, &EntryPoint);\r
238	if (ImageBase != 0) {\r
239	InternalPrintMessage (\r
240	" (ImageBase=%016lx, EntryPoint=%016lx) !!!!\n",\r
241	ImageBase,\r
242	EntryPoint\r
243	);\r
244	}\r
245	}\r