UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.c

   1 /** @file
   2   CPU Exception Handler Library common functions.
   3
   4   Copyright (c) 2012 - 2016, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  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.
  12
  13 **/
  14
  15 #include "CpuExceptionCommon.h"
  16
  17 //
  18 // Error code flag indicating whether or not an error code will be
  19 // pushed on the stack if an exception occurs.
  20 //
  21 // 1 means an error code will be pushed, otherwise 0
  22 //
  23 CONST UINT32 mErrorCodeFlag = 0x00027d00;
  24
  25 //
  26 // Define the maximum message length
  27 //
  28 #define MAX_DEBUG_MESSAGE_LENGTH  0x100
  29
  30 CONST CHAR8 mExceptionReservedStr[] = "Reserved";
  31 CONST CHAR8 *mExceptionNameStr[] = {
  32   "#DE - Divide Error",
  33   "#DB - Debug",
  34   "NMI Interrupt",
  35   "#BP - Breakpoint",
  36   "#OF - Overflow",
  37   "#BR - BOUND Range Exceeded",
  38   "#UD - Invalid Opcode",
  39   "#NM - Device Not Available",
  40   "#DF - Double Fault",
  41   "Coprocessor Segment Overrun",
  42   "#TS - Invalid TSS",
  43   "#NP - Segment Not Present",
  44   "#SS - Stack Fault Fault",
  45   "#GP - General Protection",
  46   "#PF - Page-Fault",
  47   "Reserved",
  48   "#MF - x87 FPU Floating-Point Error",
  49   "#AC - Alignment Check",
  50   "#MC - Machine-Check",
  51   "#XM - SIMD floating-point",
  52   "#VE - Virtualization"
  53 };
  54
  55 #define EXCEPTION_KNOWN_NAME_NUM  (sizeof (mExceptionNameStr) / sizeof (CHAR8 *))
  56
  57 /**
  58   Get ASCII format string exception name by exception type.
  59
  60   @param ExceptionType  Exception type.
  61
  62   @return  ASCII format string exception name.
  63 **/
  64 CONST CHAR8 *
  65 GetExceptionNameStr (
  66   IN EFI_EXCEPTION_TYPE          ExceptionType
  67   )
  68 {
  69   if ((UINTN) ExceptionType < EXCEPTION_KNOWN_NAME_NUM) {
  70     return mExceptionNameStr[ExceptionType];
  71   } else {
  72     return mExceptionReservedStr;
  73   }
  74 }
  75
  76 /**
  77   Prints a message to the serial port.
  78
  79   @param  Format      Format string for the message to print.
  80   @param  ...         Variable argument list whose contents are accessed
  81                       based on the format string specified by Format.
  82
  83 **/
  84 VOID
  85 EFIAPI
  86 InternalPrintMessage (
  87   IN  CONST CHAR8  *Format,
  88   ...
  89   )
  90 {
  91   CHAR8    Buffer[MAX_DEBUG_MESSAGE_LENGTH];
  92   VA_LIST  Marker;
  93
  94   //
  95   // Convert the message to an ASCII String
  96   //
  97   VA_START (Marker, Format);
  98   AsciiVSPrint (Buffer, sizeof (Buffer), Format, Marker);
  99   VA_END (Marker);
 100
 101   //
 102   // Send the print string to a Serial Port
 103   //
 104   SerialPortWrite ((UINT8 *)Buffer, AsciiStrLen (Buffer));
 105 }
 106
 107 /**
 108   Find and display image base address and return image base and its entry point.
 109
 110   @param CurrentEip      Current instruction pointer.
 111
 112 **/
 113 VOID
 114 DumpModuleImageInfo (
 115   IN  UINTN              CurrentEip
 116   )
 117 {
 118   EFI_STATUS                           Status;
 119   UINTN                                Pe32Data;
 120   VOID                                 *PdbPointer;
 121   VOID                                 *EntryPoint;
 122
 123   Pe32Data = PeCoffSerachImageBase (CurrentEip);
 124   if (Pe32Data == 0) {
 125     InternalPrintMessage ("!!!! Can't find image information. !!!!\n");
 126   } else {
 127     //
 128     // Find Image Base entry point
 129     //
 130     Status = PeCoffLoaderGetEntryPoint ((VOID *) Pe32Data, &EntryPoint);
 131     if (EFI_ERROR (Status)) {
 132       EntryPoint = NULL;
 133     }
 134     InternalPrintMessage ("!!!! Find image ");
 135     PdbPointer = PeCoffLoaderGetPdbPointer ((VOID *) Pe32Data);
 136     if (PdbPointer != NULL) {
 137       InternalPrintMessage ("%a", PdbPointer);
 138     } else {
 139       InternalPrintMessage ("(No PDB) " );
 140     }
 141     InternalPrintMessage (
 142       " (ImageBase=%016lp, EntryPoint=%016p) !!!!\n",
 143       (VOID *) Pe32Data,
 144       EntryPoint
 145       );
 146   }
 147 }
 148
 149 /**
 150   Read and save reserved vector information
 151
 152   @param[in]  VectorInfo        Pointer to reserved vector list.
 153   @param[out] ReservedVector    Pointer to reserved vector data buffer.
 154   @param[in]  VectorCount       Vector number to be updated.
 155
 156   @return EFI_SUCCESS           Read and save vector info successfully.
 157   @retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.
 158
 159 **/
 160 EFI_STATUS
 161 ReadAndVerifyVectorInfo (
 162   IN  EFI_VECTOR_HANDOFF_INFO       *VectorInfo,
 163   OUT RESERVED_VECTORS_DATA         *ReservedVector,
 164   IN  UINTN                         VectorCount
 165   )
 166 {
 167   while (VectorInfo->Attribute != EFI_VECTOR_HANDOFF_LAST_ENTRY) {
 168     if (VectorInfo->Attribute > EFI_VECTOR_HANDOFF_HOOK_AFTER) {
 169       //
 170       // If vector attrubute is invalid
 171       //
 172       return EFI_INVALID_PARAMETER;
 173     }
 174     if (VectorInfo->VectorNumber < VectorCount) {
 175       ReservedVector[VectorInfo->VectorNumber].Attribute = VectorInfo->Attribute;
 176     }
 177     VectorInfo ++;
 178   }
 179   return EFI_SUCCESS;
 180 }