2 Default exception handler
4 Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <Library/UefiLib.h>
18 #include <Library/BaseLib.h>
19 #include <Library/DebugLib.h>
20 #include <Library/PeCoffGetEntryPointLib.h>
21 #include <Library/ArmDisassemblerLib.h>
23 #include <Guid/DebugImageInfoTable.h>
24 #include <Protocol/DebugSupport.h>
25 #include <Protocol/LoadedImage.h>
28 EFI_DEBUG_IMAGE_INFO_TABLE_HEADER
*gDebugImageTableHeader
= NULL
;
40 Use the EFI Debug Image Table to lookup the FaultAddress and find which PE/COFF image
41 it came from. As long as the PE/COFF image contains a debug directory entry a
42 string can be returned. For ELF and Mach-O images the string points to the Mach-O or ELF
43 image. Microsoft tools contain a pointer to the PDB file that contains the debug information.
45 @param FaultAddress Address to find PE/COFF image for.
46 @param ImageBase Return load address of found image
47 @param PeCoffSizeOfHeaders Return the size of the PE/COFF header for the image that was found
49 @retval NULL FaultAddress not in a loaded PE/COFF image.
50 @retval Path and file name of PE/COFF image.
55 IN UINT32 FaultAddress
,
56 OUT UINT32
*ImageBase
,
57 OUT UINT32
*PeCoffSizeOfHeaders
60 EFI_DEBUG_IMAGE_INFO
*DebugTable
;
65 DebugTable
= gDebugImageTableHeader
->EfiDebugImageInfoTable
;
66 if (DebugTable
== NULL
) {
70 Address
= (CHAR8
*)(UINTN
)FaultAddress
;
71 for (Entry
= 0; Entry
< gDebugImageTableHeader
->TableSize
; Entry
++, DebugTable
++) {
72 if (DebugTable
->NormalImage
!= NULL
) {
73 if ((DebugTable
->NormalImage
->ImageInfoType
== EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL
) &&
74 (DebugTable
->NormalImage
->LoadedImageProtocolInstance
!= NULL
)) {
75 if ((Address
>= (CHAR8
*)DebugTable
->NormalImage
->LoadedImageProtocolInstance
->ImageBase
) &&
76 (Address
<= ((CHAR8
*)DebugTable
->NormalImage
->LoadedImageProtocolInstance
->ImageBase
+ DebugTable
->NormalImage
->LoadedImageProtocolInstance
->ImageSize
))) {
77 *ImageBase
= (UINT32
)DebugTable
->NormalImage
->LoadedImageProtocolInstance
->ImageBase
;
78 *PeCoffSizeOfHeaders
= PeCoffGetSizeOfHeaders ((VOID
*)(UINTN
)*ImageBase
);
79 return PeCoffLoaderGetPdbPointer (DebugTable
->NormalImage
->LoadedImageProtocolInstance
->ImageBase
);
90 Convert the Current Program Status Register (CPSR) to a string. The string is
91 a defacto standard in the ARM world.
93 It is possible to add extra bits by adding them to CpsrChar array.
95 @param Cpsr ARM CPSR register value
96 @param ReturnStr 32 byte string that contains string version of CPSR
106 CHAR8
*Str
= ReturnStr
;
108 CPSR_CHAR CpsrChar
[] = {
122 for (Index
= 0; CpsrChar
[Index
].BIT
!= 0; Index
++, Str
++) {
123 *Str
= CpsrChar
[Index
].Char
;
124 if ((Cpsr
& (1 << CpsrChar
[Index
].BIT
)) != 0) {
125 // Concert to upper case if bit is set
133 switch (Cpsr
& 0x1f) {
164 AsciiStrCat (Str
, ModeStr
);
169 FaultStatusToString (
176 case 0x01: FaultSource
= "Alignment fault"; break;
177 case 0x02: FaultSource
= "Debug event fault"; break;
178 case 0x03: FaultSource
= "Access Flag fault on Section"; break;
179 case 0x04: FaultSource
= "Cache maintenance operation fault[2]"; break;
180 case 0x05: FaultSource
= "Translation fault on Section"; break;
181 case 0x06: FaultSource
= "Access Flag fault on Page"; break;
182 case 0x07: FaultSource
= "Translation fault on Page"; break;
183 case 0x08: FaultSource
= "Precise External Abort"; break;
184 case 0x09: FaultSource
= "Domain fault on Section"; break;
185 case 0x0b: FaultSource
= "Domain fault on Page"; break;
186 case 0x0c: FaultSource
= "External abort on translation, first level"; break;
187 case 0x0d: FaultSource
= "Permission fault on Section"; break;
188 case 0x0e: FaultSource
= "External abort on translation, second level"; break;
189 case 0x0f: FaultSource
= "Permission fault on Page"; break;
190 case 0x16: FaultSource
= "Imprecise External Abort"; break;
191 default: FaultSource
= "No function"; break;
198 CHAR8
*gExceptionTypeString
[] = {
211 This is the default action to take on an unexpected exception
213 Since this is exception context don't do anything crazy like try to allcoate memory.
215 @param ExceptionType Type of the exception
216 @param SystemContext Register state at the time of the Exception
221 DefaultExceptionHandler (
222 IN EFI_EXCEPTION_TYPE ExceptionType
,
223 IN OUT EFI_SYSTEM_CONTEXT SystemContext
231 DEBUG ((EFI_D_ERROR
, "\n%a Exception PC at 0x%08x CPSR 0x%08x ", gExceptionTypeString
[ExceptionType
], SystemContext
.SystemContextArm
->PC
, SystemContext
.SystemContextArm
->CPSR
));
235 UINT32 PeCoffSizeOfHeader
;
237 CHAR8 CpsrStr
[32]; // char per bit. Lower 5-bits are mode that is a 3 char string
242 CpsrString (SystemContext
.SystemContextArm
->CPSR
, CpsrStr
);
243 DEBUG ((EFI_D_ERROR
, "%a\n", CpsrStr
));
245 Pdb
= GetImageName (SystemContext
.SystemContextArm
->PC
, &ImageBase
, &PeCoffSizeOfHeader
);
246 Offset
= SystemContext
.SystemContextArm
->PC
- ImageBase
;
248 DEBUG ((EFI_D_ERROR
, "%a\n", Pdb
));
251 // A PE/COFF image loads its headers into memory so the headers are
252 // included in the linked addressess. ELF and Mach-O images do not
253 // include the headers so the first byte of the image is usually
254 // text (code). If you look at link maps from ELF or Mach-O images
255 // you need to subtact out the size of the PE/COFF header to get
256 // get the offset that matches the link map.
258 DEBUG ((EFI_D_ERROR
, "loaded at 0x%08x (PE/COFF offset) 0x%x (ELF or Mach-O offset) 0x%x", ImageBase
, Offset
, Offset
- PeCoffSizeOfHeader
));
260 // If we come from an image it is safe to show the instruction. We know it should not fault
261 DisAsm
= (UINT8
*)(UINTN
)SystemContext
.SystemContextArm
->PC
;
263 DisassembleInstruction (&DisAsm
, (SystemContext
.SystemContextArm
->CPSR
& BIT5
) == BIT5
, TRUE
, &ItBlock
, Buffer
, sizeof (Buffer
));
264 DEBUG ((EFI_D_ERROR
, "\n%a", Buffer
));
266 switch (ExceptionType
) {
267 case EXCEPT_ARM_UNDEFINED_INSTRUCTION
:
268 case EXCEPT_ARM_SOFTWARE_INTERRUPT
:
269 case EXCEPT_ARM_PREFETCH_ABORT
:
270 case EXCEPT_ARM_DATA_ABORT
:
271 // advance PC past the faulting instruction
272 PcAdjust
= (UINTN
)DisAsm
- SystemContext
.SystemContextArm
->PC
;
281 DEBUG ((EFI_D_ERROR
, "\n R0 0x%08x R1 0x%08x R2 0x%08x R3 0x%08x\n", SystemContext
.SystemContextArm
->R0
, SystemContext
.SystemContextArm
->R1
, SystemContext
.SystemContextArm
->R2
, SystemContext
.SystemContextArm
->R3
));
282 DEBUG ((EFI_D_ERROR
, " R4 0x%08x R5 0x%08x R6 0x%08x R7 0x%08x\n", SystemContext
.SystemContextArm
->R4
, SystemContext
.SystemContextArm
->R5
, SystemContext
.SystemContextArm
->R6
, SystemContext
.SystemContextArm
->R7
));
283 DEBUG ((EFI_D_ERROR
, " R8 0x%08x R9 0x%08x R10 0x%08x R11 0x%08x\n", SystemContext
.SystemContextArm
->R8
, SystemContext
.SystemContextArm
->R9
, SystemContext
.SystemContextArm
->R10
, SystemContext
.SystemContextArm
->R11
));
284 DEBUG ((EFI_D_ERROR
, " R12 0x%08x SP 0x%08x LR 0x%08x PC 0x%08x\n", SystemContext
.SystemContextArm
->R12
, SystemContext
.SystemContextArm
->SP
, SystemContext
.SystemContextArm
->LR
, SystemContext
.SystemContextArm
->PC
));
285 DEBUG ((EFI_D_ERROR
, "DFSR 0x%08x DFAR 0x%08x IFSR 0x%08x IFAR 0x%08x\n", SystemContext
.SystemContextArm
->DFSR
, SystemContext
.SystemContextArm
->DFAR
, SystemContext
.SystemContextArm
->IFSR
, SystemContext
.SystemContextArm
->IFAR
));
287 // Bit10 is Status[4] Bit3:0 is Status[3:0]
288 DfsrStatus
= (SystemContext
.SystemContextArm
->DFSR
& 0xf) | ((SystemContext
.SystemContextArm
->DFSR
>> 6) & 0x10);
289 DfsrWrite
= (SystemContext
.SystemContextArm
->DFSR
& BIT11
) != 0;
290 if (DfsrStatus
!= 0x00) {
291 DEBUG ((EFI_D_ERROR
, " %a: %a 0x%08x\n", FaultStatusToString (DfsrStatus
), DfsrWrite
? "write to" : "read from", SystemContext
.SystemContextArm
->DFAR
));
294 IfsrStatus
= (SystemContext
.SystemContextArm
->IFSR
& 0xf) | ((SystemContext
.SystemContextArm
->IFSR
>> 6) & 0x10);
295 if (IfsrStatus
!= 0) {
296 DEBUG ((EFI_D_ERROR
, " Instruction %a at 0x%08x\n", FaultStatusToString (SystemContext
.SystemContextArm
->IFSR
& 0xf), SystemContext
.SystemContextArm
->IFAR
));
299 DEBUG ((EFI_D_ERROR
, "\n"));
302 // Clear the error registers that we have already displayed incase some one wants to keep going
303 SystemContext
.SystemContextArm
->DFSR
= 0;
304 SystemContext
.SystemContextArm
->IFSR
= 0;
306 // If some one is stepping past the exception handler adjust the PC to point to the next instruction
307 SystemContext
.SystemContextArm
->PC
+= PcAdjust
;
314 The constructor function caches EFI Debug table information for use in the exception handler.
317 @param ImageHandle The firmware allocated handle for the EFI image.
318 @param SystemTable A pointer to the EFI System Table.
320 @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
325 DefaultExceptionHandlerConstructor (
326 IN EFI_HANDLE ImageHandle
,
327 IN EFI_SYSTEM_TABLE
*SystemTable
333 Status
= EfiGetSystemConfigurationTable (&gEfiDebugImageInfoTableGuid
, (VOID
**)&gDebugImageTableHeader
);
334 if (EFI_ERROR (Status
)) {
335 gDebugImageTableHeader
= NULL
;