ArmPkg/Library/DefaultExceptionHandlerLib/AArch64/DefaultExceptionHandler.c

   1 /** @file
   2   Default exception handler
   3
   4   Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
   5   Copyright (c) 2011 - 2014, ARM Ltd. All rights reserved.<BR>
   6
   7   SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #include <Uefi.h>
  12 #include <Library/UefiLib.h>
  13 #include <Library/BaseLib.h>
  14 #include <Library/DebugLib.h>
  15 #include <Library/PeCoffGetEntryPointLib.h>
  16 #include <Library/PrintLib.h>
  17 #include <Library/ArmDisassemblerLib.h>
  18 #include <Library/SerialPortLib.h>
  19 #include <Library/UefiBootServicesTableLib.h>
  20
  21 #include <Guid/DebugImageInfoTable.h>
  22 #include <Protocol/DebugSupport.h>
  23 #include <Protocol/LoadedImage.h>
  24
  25 STATIC CHAR8  *gExceptionTypeString[] = {
  26   "Synchronous",
  27   "IRQ",
  28   "FIQ",
  29   "SError"
  30 };
  31
  32 STATIC BOOLEAN  mRecursiveException;
  33
  34 CHAR8 *
  35 GetImageName (
  36   IN  UINTN  FaultAddress,
  37   OUT UINTN  *ImageBase,
  38   OUT UINTN  *PeCoffSizeOfHeaders
  39   );
  40
  41 STATIC
  42 VOID
  43 DescribeInstructionOrDataAbort (
  44   IN CHAR8  *AbortType,
  45   IN UINTN  Iss
  46   )
  47 {
  48   CHAR8  *AbortCause;
  49
  50   switch (Iss & 0x3f) {
  51     case 0x0: AbortCause = "Address size fault, zeroth level of translation or translation table base register";
  52       break;
  53     case 0x1: AbortCause = "Address size fault, first level";
  54       break;
  55     case 0x2: AbortCause = "Address size fault, second level";
  56       break;
  57     case 0x3: AbortCause = "Address size fault, third level";
  58       break;
  59     case 0x4: AbortCause = "Translation fault, zeroth level";
  60       break;
  61     case 0x5: AbortCause = "Translation fault, first level";
  62       break;
  63     case 0x6: AbortCause = "Translation fault, second level";
  64       break;
  65     case 0x7: AbortCause = "Translation fault, third level";
  66       break;
  67     case 0x9: AbortCause = "Access flag fault, first level";
  68       break;
  69     case 0xa: AbortCause = "Access flag fault, second level";
  70       break;
  71     case 0xb: AbortCause = "Access flag fault, third level";
  72       break;
  73     case 0xd: AbortCause = "Permission fault, first level";
  74       break;
  75     case 0xe: AbortCause = "Permission fault, second level";
  76       break;
  77     case 0xf: AbortCause = "Permission fault, third level";
  78       break;
  79     case 0x10: AbortCause = "Synchronous external abort";
  80       break;
  81     case 0x18: AbortCause = "Synchronous parity error on memory access";
  82       break;
  83     case 0x11: AbortCause = "Asynchronous external abort";
  84       break;
  85     case 0x19: AbortCause = "Asynchronous parity error on memory access";
  86       break;
  87     case 0x14: AbortCause = "Synchronous external abort on translation table walk, zeroth level";
  88       break;
  89     case 0x15: AbortCause = "Synchronous external abort on translation table walk, first level";
  90       break;
  91     case 0x16: AbortCause = "Synchronous external abort on translation table walk, second level";
  92       break;
  93     case 0x17: AbortCause = "Synchronous external abort on translation table walk, third level";
  94       break;
  95     case 0x1c: AbortCause = "Synchronous parity error on memory access on translation table walk, zeroth level";
  96       break;
  97     case 0x1d: AbortCause = "Synchronous parity error on memory access on translation table walk, first level";
  98       break;
  99     case 0x1e: AbortCause = "Synchronous parity error on memory access on translation table walk, second level";
 100       break;
 101     case 0x1f: AbortCause = "Synchronous parity error on memory access on translation table walk, third level";
 102       break;
 103     case 0x21: AbortCause = "Alignment fault";
 104       break;
 105     case 0x22: AbortCause = "Debug event";
 106       break;
 107     case 0x30: AbortCause = "TLB conflict abort";
 108       break;
 109     case 0x33:
 110     case 0x34: AbortCause = "IMPLEMENTATION DEFINED";
 111       break;
 112     case 0x35:
 113     case 0x36: AbortCause = "Domain fault";
 114       break;
 115     default: AbortCause = "";
 116       break;
 117   }
 118
 119   DEBUG ((DEBUG_ERROR, "\n%a: %a\n", AbortType, AbortCause));
 120 }
 121
 122 STATIC
 123 VOID
 124 DescribeExceptionSyndrome (
 125   IN UINT32  Esr
 126   )
 127 {
 128   CHAR8  *Message;
 129   UINTN  Ec;
 130   UINTN  Iss;
 131
 132   Ec  = Esr >> 26;
 133   Iss = Esr & 0x00ffffff;
 134
 135   switch (Ec) {
 136     case 0x15: Message = "SVC executed in AArch64";
 137       break;
 138     case 0x20:
 139     case 0x21: DescribeInstructionOrDataAbort ("Instruction abort", Iss);
 140       return;
 141     case 0x22: Message = "PC alignment fault";
 142       break;
 143     case 0x23: Message = "SP alignment fault";
 144       break;
 145     case 0x24:
 146     case 0x25: DescribeInstructionOrDataAbort ("Data abort", Iss);
 147       return;
 148     default: return;
 149   }
 150
 151   DEBUG ((DEBUG_ERROR, "\n %a \n", Message));
 152 }
 153
 154 #ifndef MDEPKG_NDEBUG
 155 STATIC
 156 CONST CHAR8 *
 157 BaseName (
 158   IN  CONST CHAR8  *FullName
 159   )
 160 {
 161   CONST CHAR8  *Str;
 162
 163   Str = FullName + AsciiStrLen (FullName);
 164
 165   while (--Str > FullName) {
 166     if ((*Str == '/') || (*Str == '\\')) {
 167       return Str + 1;
 168     }
 169   }
 170
 171   return Str;
 172 }
 173
 174 #endif
 175
 176 /**
 177   This is the default action to take on an unexpected exception
 178
 179   Since this is exception context don't do anything crazy like try to allocate memory.
 180
 181   @param  ExceptionType    Type of the exception
 182   @param  SystemContext    Register state at the time of the Exception
 183
 184 **/
 185 VOID
 186 DefaultExceptionHandler (
 187   IN     EFI_EXCEPTION_TYPE  ExceptionType,
 188   IN OUT EFI_SYSTEM_CONTEXT  SystemContext
 189   )
 190 {
 191   CHAR8  Buffer[100];
 192   UINTN  CharCount;
 193   INT32  Offset;
 194
 195   if (mRecursiveException) {
 196     STATIC CHAR8 CONST  Message[] = "\nRecursive exception occurred while dumping the CPU state\n";
 197
 198     SerialPortWrite ((UINT8 *)Message, sizeof Message - 1);
 199     if (gST->ConOut != NULL) {
 200       AsciiPrint (Message);
 201     }
 202
 203     CpuDeadLoop ();
 204   }
 205
 206   mRecursiveException = TRUE;
 207
 208   CharCount = AsciiSPrint (Buffer, sizeof (Buffer), "\n\n%a Exception at 0x%016lx\n", gExceptionTypeString[ExceptionType], SystemContext.SystemContextAArch64->ELR);
 209   SerialPortWrite ((UINT8 *)Buffer, CharCount);
 210   if (gST->ConOut != NULL) {
 211     AsciiPrint (Buffer);
 212   }
 213
 214   DEBUG_CODE_BEGIN ();
 215   CHAR8   *Pdb, *PrevPdb;
 216   UINTN   ImageBase;
 217   UINTN   PeCoffSizeOfHeader;
 218   UINT64  *Fp;
 219   UINT64  RootFp[2];
 220   UINTN   Idx;
 221
 222   PrevPdb = Pdb = GetImageName (SystemContext.SystemContextAArch64->ELR, &ImageBase, &PeCoffSizeOfHeader);
 223   if (Pdb != NULL) {
 224     DEBUG ((
 225       DEBUG_ERROR,
 226       "PC 0x%012lx (0x%012lx+0x%08x) [ 0] %a\n",
 227       SystemContext.SystemContextAArch64->ELR,
 228       ImageBase,
 229       SystemContext.SystemContextAArch64->ELR - ImageBase,
 230       BaseName (Pdb)
 231       ));
 232   } else {
 233     DEBUG ((DEBUG_ERROR, "PC 0x%012lx\n", SystemContext.SystemContextAArch64->ELR));
 234   }
 235
 236   if ((UINT64 *)SystemContext.SystemContextAArch64->FP != 0) {
 237     Idx = 0;
 238
 239     RootFp[0] = ((UINT64 *)SystemContext.SystemContextAArch64->FP)[0];
 240     RootFp[1] = ((UINT64 *)SystemContext.SystemContextAArch64->FP)[1];
 241     if (RootFp[1] != SystemContext.SystemContextAArch64->LR) {
 242       RootFp[0] = SystemContext.SystemContextAArch64->FP;
 243       RootFp[1] = SystemContext.SystemContextAArch64->LR;
 244     }
 245
 246     for (Fp = RootFp; Fp[0] != 0; Fp = (UINT64 *)Fp[0]) {
 247       Pdb = GetImageName (Fp[1], &ImageBase, &PeCoffSizeOfHeader);
 248       if (Pdb != NULL) {
 249         if (Pdb != PrevPdb) {
 250           Idx++;
 251           PrevPdb = Pdb;
 252         }
 253
 254         DEBUG ((
 255           DEBUG_ERROR,
 256           "PC 0x%012lx (0x%012lx+0x%08x) [% 2d] %a\n",
 257           Fp[1],
 258           ImageBase,
 259           Fp[1] - ImageBase,
 260           Idx,
 261           BaseName (Pdb)
 262           ));
 263       } else {
 264         DEBUG ((DEBUG_ERROR, "PC 0x%012lx\n", Fp[1]));
 265       }
 266     }
 267
 268     PrevPdb = Pdb = GetImageName (SystemContext.SystemContextAArch64->ELR, &ImageBase, &PeCoffSizeOfHeader);
 269     if (Pdb != NULL) {
 270       DEBUG ((DEBUG_ERROR, "\n[ 0] %a\n", Pdb));
 271     }
 272
 273     Idx = 0;
 274     for (Fp = RootFp; Fp[0] != 0; Fp = (UINT64 *)Fp[0]) {
 275       Pdb = GetImageName (Fp[1], &ImageBase, &PeCoffSizeOfHeader);
 276       if ((Pdb != NULL) && (Pdb != PrevPdb)) {
 277         DEBUG ((DEBUG_ERROR, "[% 2d] %a\n", ++Idx, Pdb));
 278         PrevPdb = Pdb;
 279       }
 280     }
 281   }
 282
 283   DEBUG_CODE_END ();
 284
 285   DEBUG ((DEBUG_ERROR, "\n  X0 0x%016lx   X1 0x%016lx   X2 0x%016lx   X3 0x%016lx\n", SystemContext.SystemContextAArch64->X0, SystemContext.SystemContextAArch64->X1, SystemContext.SystemContextAArch64->X2, SystemContext.SystemContextAArch64->X3));
 286   DEBUG ((DEBUG_ERROR, "  X4 0x%016lx   X5 0x%016lx   X6 0x%016lx   X7 0x%016lx\n", SystemContext.SystemContextAArch64->X4, SystemContext.SystemContextAArch64->X5, SystemContext.SystemContextAArch64->X6, SystemContext.SystemContextAArch64->X7));
 287   DEBUG ((DEBUG_ERROR, "  X8 0x%016lx   X9 0x%016lx  X10 0x%016lx  X11 0x%016lx\n", SystemContext.SystemContextAArch64->X8, SystemContext.SystemContextAArch64->X9, SystemContext.SystemContextAArch64->X10, SystemContext.SystemContextAArch64->X11));
 288   DEBUG ((DEBUG_ERROR, " X12 0x%016lx  X13 0x%016lx  X14 0x%016lx  X15 0x%016lx\n", SystemContext.SystemContextAArch64->X12, SystemContext.SystemContextAArch64->X13, SystemContext.SystemContextAArch64->X14, SystemContext.SystemContextAArch64->X15));
 289   DEBUG ((DEBUG_ERROR, " X16 0x%016lx  X17 0x%016lx  X18 0x%016lx  X19 0x%016lx\n", SystemContext.SystemContextAArch64->X16, SystemContext.SystemContextAArch64->X17, SystemContext.SystemContextAArch64->X18, SystemContext.SystemContextAArch64->X19));
 290   DEBUG ((DEBUG_ERROR, " X20 0x%016lx  X21 0x%016lx  X22 0x%016lx  X23 0x%016lx\n", SystemContext.SystemContextAArch64->X20, SystemContext.SystemContextAArch64->X21, SystemContext.SystemContextAArch64->X22, SystemContext.SystemContextAArch64->X23));
 291   DEBUG ((DEBUG_ERROR, " X24 0x%016lx  X25 0x%016lx  X26 0x%016lx  X27 0x%016lx\n", SystemContext.SystemContextAArch64->X24, SystemContext.SystemContextAArch64->X25, SystemContext.SystemContextAArch64->X26, SystemContext.SystemContextAArch64->X27));
 292   DEBUG ((DEBUG_ERROR, " X28 0x%016lx   FP 0x%016lx   LR 0x%016lx  \n", SystemContext.SystemContextAArch64->X28, SystemContext.SystemContextAArch64->FP, SystemContext.SystemContextAArch64->LR));
 293
 294   /* We save these as 128bit numbers, but have to print them as two 64bit numbers,
 295      so swap the 64bit words to correctly represent a 128bit number.  */
 296   DEBUG ((DEBUG_ERROR, "\n  V0 0x%016lx %016lx   V1 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V0[1], SystemContext.SystemContextAArch64->V0[0], SystemContext.SystemContextAArch64->V1[1], SystemContext.SystemContextAArch64->V1[0]));
 297   DEBUG ((DEBUG_ERROR, "  V2 0x%016lx %016lx   V3 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V2[1], SystemContext.SystemContextAArch64->V2[0], SystemContext.SystemContextAArch64->V3[1], SystemContext.SystemContextAArch64->V3[0]));
 298   DEBUG ((DEBUG_ERROR, "  V4 0x%016lx %016lx   V5 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V4[1], SystemContext.SystemContextAArch64->V4[0], SystemContext.SystemContextAArch64->V5[1], SystemContext.SystemContextAArch64->V5[0]));
 299   DEBUG ((DEBUG_ERROR, "  V6 0x%016lx %016lx   V7 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V6[1], SystemContext.SystemContextAArch64->V6[0], SystemContext.SystemContextAArch64->V7[1], SystemContext.SystemContextAArch64->V7[0]));
 300   DEBUG ((DEBUG_ERROR, "  V8 0x%016lx %016lx   V9 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V8[1], SystemContext.SystemContextAArch64->V8[0], SystemContext.SystemContextAArch64->V9[1], SystemContext.SystemContextAArch64->V9[0]));
 301   DEBUG ((DEBUG_ERROR, " V10 0x%016lx %016lx  V11 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V10[1], SystemContext.SystemContextAArch64->V10[0], SystemContext.SystemContextAArch64->V11[1], SystemContext.SystemContextAArch64->V11[0]));
 302   DEBUG ((DEBUG_ERROR, " V12 0x%016lx %016lx  V13 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V12[1], SystemContext.SystemContextAArch64->V12[0], SystemContext.SystemContextAArch64->V13[1], SystemContext.SystemContextAArch64->V13[0]));
 303   DEBUG ((DEBUG_ERROR, " V14 0x%016lx %016lx  V15 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V14[1], SystemContext.SystemContextAArch64->V14[0], SystemContext.SystemContextAArch64->V15[1], SystemContext.SystemContextAArch64->V15[0]));
 304   DEBUG ((DEBUG_ERROR, " V16 0x%016lx %016lx  V17 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V16[1], SystemContext.SystemContextAArch64->V16[0], SystemContext.SystemContextAArch64->V17[1], SystemContext.SystemContextAArch64->V17[0]));
 305   DEBUG ((DEBUG_ERROR, " V18 0x%016lx %016lx  V19 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V18[1], SystemContext.SystemContextAArch64->V18[0], SystemContext.SystemContextAArch64->V19[1], SystemContext.SystemContextAArch64->V19[0]));
 306   DEBUG ((DEBUG_ERROR, " V20 0x%016lx %016lx  V21 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V20[1], SystemContext.SystemContextAArch64->V20[0], SystemContext.SystemContextAArch64->V21[1], SystemContext.SystemContextAArch64->V21[0]));
 307   DEBUG ((DEBUG_ERROR, " V22 0x%016lx %016lx  V23 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V22[1], SystemContext.SystemContextAArch64->V22[0], SystemContext.SystemContextAArch64->V23[1], SystemContext.SystemContextAArch64->V23[0]));
 308   DEBUG ((DEBUG_ERROR, " V24 0x%016lx %016lx  V25 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V24[1], SystemContext.SystemContextAArch64->V24[0], SystemContext.SystemContextAArch64->V25[1], SystemContext.SystemContextAArch64->V25[0]));
 309   DEBUG ((DEBUG_ERROR, " V26 0x%016lx %016lx  V27 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V26[1], SystemContext.SystemContextAArch64->V26[0], SystemContext.SystemContextAArch64->V27[1], SystemContext.SystemContextAArch64->V27[0]));
 310   DEBUG ((DEBUG_ERROR, " V28 0x%016lx %016lx  V29 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V28[1], SystemContext.SystemContextAArch64->V28[0], SystemContext.SystemContextAArch64->V29[1], SystemContext.SystemContextAArch64->V29[0]));
 311   DEBUG ((DEBUG_ERROR, " V30 0x%016lx %016lx  V31 0x%016lx %016lx\n", SystemContext.SystemContextAArch64->V30[1], SystemContext.SystemContextAArch64->V30[0], SystemContext.SystemContextAArch64->V31[1], SystemContext.SystemContextAArch64->V31[0]));
 312
 313   DEBUG ((DEBUG_ERROR, "\n  SP 0x%016lx  ELR 0x%016lx  SPSR 0x%08lx  FPSR 0x%08lx\n ESR 0x%08lx          FAR 0x%016lx\n", SystemContext.SystemContextAArch64->SP, SystemContext.SystemContextAArch64->ELR, SystemContext.SystemContextAArch64->SPSR, SystemContext.SystemContextAArch64->FPSR, SystemContext.SystemContextAArch64->ESR, SystemContext.SystemContextAArch64->FAR));
 314
 315   DEBUG ((DEBUG_ERROR, "\n ESR : EC 0x%02x  IL 0x%x  ISS 0x%08x\n", (SystemContext.SystemContextAArch64->ESR & 0xFC000000) >> 26, (SystemContext.SystemContextAArch64->ESR >> 25) & 0x1, SystemContext.SystemContextAArch64->ESR & 0x1FFFFFF));
 316
 317   DescribeExceptionSyndrome (SystemContext.SystemContextAArch64->ESR);
 318
 319   DEBUG ((DEBUG_ERROR, "\nStack dump:\n"));
 320   for (Offset = -256; Offset < 256; Offset += 32) {
 321     DEBUG ((
 322       DEBUG_ERROR,
 323       "%c %013lx: %016lx %016lx %016lx %016lx\n",
 324       Offset == 0 ? '>' : ' ',
 325       SystemContext.SystemContextAArch64->SP + Offset,
 326       *(UINT64 *)(SystemContext.SystemContextAArch64->SP + Offset),
 327       *(UINT64 *)(SystemContext.SystemContextAArch64->SP + Offset + 8),
 328       *(UINT64 *)(SystemContext.SystemContextAArch64->SP + Offset + 16),
 329       *(UINT64 *)(SystemContext.SystemContextAArch64->SP + Offset + 24)
 330       ));
 331   }
 332
 333   ASSERT (FALSE);
 334   CpuDeadLoop ();
 335 }