2 CPU Exception Library provides PEI/DXE/SMM CPU common exception handler.
4 Copyright (c) 2012 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "CpuExceptionCommon.h"
16 #include <Library/DebugLib.h>
19 // Spinlock for CPU information display
21 SPIN_LOCK mDisplayMessageSpinLock
;
24 // Image align size for DXE/SMM
26 CONST UINTN mImageAlignSize
= SIZE_4KB
;
28 RESERVED_VECTORS_DATA mReservedVectorsData
[CPU_EXCEPTION_NUM
];
29 EFI_CPU_INTERRUPT_HANDLER mExternalInterruptHandlerTable
[CPU_EXCEPTION_NUM
];
30 EFI_CPU_INTERRUPT_HANDLER
*mExternalInterruptHandler
= NULL
;
31 UINTN mEnabledInterruptNum
= 0;
34 Common exception handler.
36 @param ExceptionType Exception type.
37 @param SystemContext Pointer to EFI_SYSTEM_CONTEXT.
41 CommonExceptionHandler (
42 IN EFI_EXCEPTION_TYPE ExceptionType
,
43 IN EFI_SYSTEM_CONTEXT SystemContext
46 EXCEPTION_HANDLER_CONTEXT
*ExceptionHandlerContext
;
48 ExceptionHandlerContext
= (EXCEPTION_HANDLER_CONTEXT
*) (UINTN
) (SystemContext
.SystemContextIa32
);
50 switch (mReservedVectors
[ExceptionType
].Attribute
) {
51 case EFI_VECTOR_HANDOFF_HOOK_BEFORE
:
53 // Need to jmp to old IDT handler after this exception handler
55 ExceptionHandlerContext
->ExceptionDataFlag
= (mErrorCodeFlag
& (1 << ExceptionType
)) ? TRUE
: FALSE
;
56 ExceptionHandlerContext
->OldIdtHandler
= mReservedVectors
[ExceptionType
].ExceptonHandler
;
58 case EFI_VECTOR_HANDOFF_HOOK_AFTER
:
61 // If if anyone has gotten SPIN_LOCK for owner running hook after
63 if (AcquireSpinLockOrFail (&mReservedVectors
[ExceptionType
].SpinLock
)) {
65 // Need to execute old IDT handler before running this exception handler
67 mReservedVectors
[ExceptionType
].ApicId
= GetApicId ();
68 ArchSaveExceptionContext (ExceptionType
, SystemContext
);
69 ExceptionHandlerContext
->ExceptionDataFlag
= (mErrorCodeFlag
& (1 << ExceptionType
)) ? TRUE
: FALSE
;
70 ExceptionHandlerContext
->OldIdtHandler
= mReservedVectors
[ExceptionType
].ExceptonHandler
;
74 // If failed to acquire SPIN_LOCK, check if it was locked by processor itself
76 if (mReservedVectors
[ExceptionType
].ApicId
== GetApicId ()) {
78 // Old IDT handler has been executed, then retore CPU exception content to
79 // run new exception handler.
81 ArchRestoreExceptionContext (ExceptionType
, SystemContext
);
83 // Rlease spin lock for ApicId
85 ReleaseSpinLock (&mReservedVectors
[ExceptionType
].SpinLock
);
95 // It should never reach here
101 if (mExternalInterruptHandler
[ExceptionType
] != NULL
) {
102 (mExternalInterruptHandler
[ExceptionType
]) (ExceptionType
, SystemContext
);
103 } else if (ExceptionType
< CPU_EXCEPTION_NUM
) {
105 // Get Spinlock to display CPU information
107 while (!AcquireSpinLockOrFail (&mDisplayMessageSpinLock
)) {
111 // Display ExceptionType, CPU information and Image information
113 DumpCpuContent (ExceptionType
, SystemContext
);
115 // Release Spinlock of output message
117 ReleaseSpinLock (&mDisplayMessageSpinLock
);
119 // Enter a dead loop if needn't to execute old IDT handler further
121 if (mReservedVectors
[ExceptionType
].Attribute
!= EFI_VECTOR_HANDOFF_HOOK_BEFORE
) {
128 Internal worker function to update IDT entries accordling to vector attributes.
130 @param[in] IdtTable Pointer to IDT table.
131 @param[in] TemplateMap Pointer to a buffer where the address map is returned.
132 @param[in] IdtEntryCount IDT entries number to be updated.
137 IN IA32_IDT_GATE_DESCRIPTOR
*IdtTable
,
138 IN EXCEPTION_HANDLER_TEMPLATE_MAP
*TemplateMap
,
139 IN UINTN IdtEntryCount
144 UINTN InterruptHandler
;
147 // Use current CS as the segment selector of interrupt gate in IDT
149 CodeSegment
= AsmReadCs ();
151 for (Index
= 0; Index
< IdtEntryCount
; Index
++) {
152 IdtTable
[Index
].Bits
.Selector
= CodeSegment
;
154 // Check reserved vectors attributes
156 switch (mReservedVectors
[Index
].Attribute
) {
157 case EFI_VECTOR_HANDOFF_DO_NOT_HOOK
:
159 // Keep original IDT entry
162 case EFI_VECTOR_HANDOFF_HOOK_AFTER
:
163 InitializeSpinLock (&mReservedVectors
[Index
].SpinLock
);
165 (VOID
*) mReservedVectors
[Index
].HookAfterStubHeaderCode
,
166 (VOID
*) TemplateMap
->HookAfterStubHeaderStart
,
167 TemplateMap
->ExceptionStubHeaderSize
170 (VOID
*) mReservedVectors
[Index
].HookAfterStubHeaderCode
,
172 (VOID
*) TemplateMap
->HookAfterStubHeaderStart
175 // Go on the following code
177 case EFI_VECTOR_HANDOFF_HOOK_BEFORE
:
179 // Save original IDT handler address
181 mReservedVectors
[Index
].ExceptonHandler
= ArchGetIdtHandler (&IdtTable
[Index
]);
183 // Go on the following code
187 // Update new IDT entry
189 InterruptHandler
= TemplateMap
->ExceptionStart
+ Index
* TemplateMap
->ExceptionStubHeaderSize
;
190 ArchUpdateIdtEntry (&IdtTable
[Index
], InterruptHandler
);
196 // Save Interrupt number to global variable used for RegisterCpuInterruptHandler ()
198 mEnabledInterruptNum
= IdtEntryCount
;
202 Internal worker function to initialize exception handler.
204 @param[in] VectorInfo Pointer to reserved vector list.
205 @param[in, out] ExceptionHandlerData Pointer to exception handler data.
207 @retval EFI_SUCCESS CPU Exception Entries have been successfully initialized
208 with default exception handlers.
209 @retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.
210 @retval EFI_UNSUPPORTED This function is not supported.
214 InitializeCpuExceptionHandlersWorker (
215 IN EFI_VECTOR_HANDOFF_INFO
*VectorInfo OPTIONAL
,
216 IN OUT EXCEPTION_HANDLER_DATA
*ExceptionHandlerData
220 IA32_DESCRIPTOR IdtDescriptor
;
222 EXCEPTION_HANDLER_TEMPLATE_MAP TemplateMap
;
223 IA32_IDT_GATE_DESCRIPTOR
*IdtTable
;
224 RESERVED_VECTORS_DATA
*ReservedVectors
;
226 ReservedVectors
= ExceptionHandlerData
->ReservedVectors
;
227 SetMem ((VOID
*) ReservedVectors
, sizeof (RESERVED_VECTORS_DATA
) * CPU_EXCEPTION_NUM
, 0xff);
228 if (VectorInfo
!= NULL
) {
229 Status
= ReadAndVerifyVectorInfo (VectorInfo
, ReservedVectors
, CPU_EXCEPTION_NUM
);
230 if (EFI_ERROR (Status
)) {
231 return EFI_INVALID_PARAMETER
;
234 InitializeSpinLock (&mDisplayMessageSpinLock
);
236 mExternalInterruptHandler
= mExternalInterruptHandlerTable
;
238 // Read IDT descriptor and calculate IDT size
240 AsmReadIdtr (&IdtDescriptor
);
241 IdtEntryCount
= (IdtDescriptor
.Limit
+ 1) / sizeof (IA32_IDT_GATE_DESCRIPTOR
);
242 if (IdtEntryCount
> CPU_EXCEPTION_NUM
) {
244 // CPU exeption library only setup CPU_EXCEPTION_NUM exception handler at most
246 IdtEntryCount
= CPU_EXCEPTION_NUM
;
249 IdtTable
= (IA32_IDT_GATE_DESCRIPTOR
*) IdtDescriptor
.Base
;
250 AsmGetTemplateAddressMap (&TemplateMap
);
251 ASSERT (TemplateMap
.ExceptionStubHeaderSize
<= HOOKAFTER_STUB_SIZE
);
252 UpdateIdtTable (IdtTable
, &TemplateMap
, IdtEntryCount
);
253 mEnabledInterruptNum
= IdtEntryCount
;
258 Registers a function to be called from the processor interrupt handler.
260 @param[in] InterruptType Defines which interrupt or exception to hook.
261 @param[in] InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called
262 when a processor interrupt occurs. If this parameter is NULL, then the handler
265 @retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled.
266 @retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was
267 previously installed.
268 @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not
269 previously installed.
270 @retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported,
271 or this function is not supported.
274 RegisterCpuInterruptHandlerWorker (
275 IN EFI_EXCEPTION_TYPE InterruptType
,
276 IN EFI_CPU_INTERRUPT_HANDLER InterruptHandler
279 if (InterruptType
< 0 || InterruptType
>= (EFI_EXCEPTION_TYPE
)mEnabledInterruptNum
||
280 mReservedVectors
[InterruptType
].Attribute
== EFI_VECTOR_HANDOFF_DO_NOT_HOOK
) {
281 return EFI_UNSUPPORTED
;
284 if (InterruptHandler
== NULL
&& mExternalInterruptHandler
[InterruptType
] == NULL
) {
285 return EFI_INVALID_PARAMETER
;
288 if (InterruptHandler
!= NULL
&& mExternalInterruptHandler
[InterruptType
] != NULL
) {
289 return EFI_ALREADY_STARTED
;
292 mExternalInterruptHandler
[InterruptType
] = InterruptHandler
;