UefiCpuPkg/Library/CpuExceptionHandlerLib/PeiCpuException.c

   1 /** @file
   2   CPU exception handler library implementation for PEIM module.
   3
   4 Copyright (c) 2016 - 2022, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #include <PiPei.h>
  10 #include "CpuExceptionCommon.h"
  11 #include <Library/DebugLib.h>
  12 #include <Library/HobLib.h>
  13 #include <Library/MemoryAllocationLib.h>
  14 #include <Library/PcdLib.h>
  15
  16 CONST UINTN  mDoFarReturnFlag = 0;
  17
  18 typedef struct {
  19   UINT8                     ExceptionStubHeader[HOOKAFTER_STUB_SIZE];
  20   EXCEPTION_HANDLER_DATA    *ExceptionHandlerData;
  21 } EXCEPTION0_STUB_HEADER;
  22
  23 /**
  24   Get exception handler data pointer from IDT[0].
  25
  26   The exception #0 stub header is duplicated in an allocated pool with extra 4-byte/8-byte to store the
  27   exception handler data. The new allocated memory layout follows structure EXCEPTION0_STUB_HEADER.
  28   The code assumes that all processors uses the same exception handler for #0 exception.
  29
  30   @return  pointer to exception handler data.
  31 **/
  32 EXCEPTION_HANDLER_DATA *
  33 GetExceptionHandlerData (
  34   VOID
  35   )
  36 {
  37   IA32_DESCRIPTOR           IdtDescriptor;
  38   IA32_IDT_GATE_DESCRIPTOR  *IdtTable;
  39   EXCEPTION0_STUB_HEADER    *Exception0StubHeader;
  40
  41   AsmReadIdtr (&IdtDescriptor);
  42   IdtTable = (IA32_IDT_GATE_DESCRIPTOR *)IdtDescriptor.Base;
  43
  44   Exception0StubHeader = (EXCEPTION0_STUB_HEADER *)ArchGetIdtHandler (&IdtTable[0]);
  45   return Exception0StubHeader->ExceptionHandlerData;
  46 }
  47
  48 /**
  49   Set exception handler data pointer to IDT[0].
  50
  51   The exception #0 stub header is duplicated in an allocated pool with extra 4-byte/8-byte to store the
  52   exception handler data. The new allocated memory layout follows structure EXCEPTION0_STUB_HEADER.
  53   The code assumes that all processors uses the same exception handler for #0 exception.
  54
  55   @param ExceptionHandlerData  pointer to exception handler data.
  56 **/
  57 VOID
  58 SetExceptionHandlerData (
  59   IN EXCEPTION_HANDLER_DATA  *ExceptionHandlerData
  60   )
  61 {
  62   EXCEPTION0_STUB_HEADER    *Exception0StubHeader;
  63   IA32_DESCRIPTOR           IdtDescriptor;
  64   IA32_IDT_GATE_DESCRIPTOR  *IdtTable;
  65
  66   //
  67   // Duplicate the exception #0 stub header in pool and cache the ExceptionHandlerData just after the stub header.
  68   // So AP can get the ExceptionHandlerData by reading the IDT[0].
  69   //
  70   AsmReadIdtr (&IdtDescriptor);
  71   IdtTable = (IA32_IDT_GATE_DESCRIPTOR *)IdtDescriptor.Base;
  72
  73   Exception0StubHeader = AllocatePool (sizeof (*Exception0StubHeader));
  74   ASSERT (Exception0StubHeader != NULL);
  75   CopyMem (
  76     Exception0StubHeader->ExceptionStubHeader,
  77     (VOID *)ArchGetIdtHandler (&IdtTable[0]),
  78     sizeof (Exception0StubHeader->ExceptionStubHeader)
  79     );
  80   Exception0StubHeader->ExceptionHandlerData = ExceptionHandlerData;
  81   ArchUpdateIdtEntry (&IdtTable[0], (UINTN)Exception0StubHeader->ExceptionStubHeader);
  82 }
  83
  84 /**
  85   Common exception handler.
  86
  87   @param ExceptionType  Exception type.
  88   @param SystemContext  Pointer to EFI_SYSTEM_CONTEXT.
  89 **/
  90 VOID
  91 EFIAPI
  92 CommonExceptionHandler (
  93   IN EFI_EXCEPTION_TYPE  ExceptionType,
  94   IN EFI_SYSTEM_CONTEXT  SystemContext
  95   )
  96 {
  97   EXCEPTION_HANDLER_DATA  *ExceptionHandlerData;
  98
  99   ExceptionHandlerData = GetExceptionHandlerData ();
 100   CommonExceptionHandlerWorker (ExceptionType, SystemContext, ExceptionHandlerData);
 101 }
 102
 103 /**
 104   Initializes all CPU exceptions entries and provides the default exception handlers.
 105
 106   Caller should try to get an array of interrupt and/or exception vectors that are in use and need to
 107   persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 specification.
 108   If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL.
 109   If VectorInfo is not NULL, the exception vectors will be initialized per vector attribute accordingly.
 110   Note: Before invoking this API, caller must allocate memory for IDT table and load
 111         IDTR by AsmWriteIdtr().
 112
 113   @param[in]  VectorInfo    Pointer to reserved vector list.
 114
 115   @retval EFI_SUCCESS           CPU Exception Entries have been successfully initialized
 116                                 with default exception handlers.
 117   @retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.
 118   @retval EFI_UNSUPPORTED       This function is not supported.
 119
 120 **/
 121 EFI_STATUS
 122 EFIAPI
 123 InitializeCpuExceptionHandlers (
 124   IN EFI_VECTOR_HANDOFF_INFO  *VectorInfo OPTIONAL
 125   )
 126 {
 127   EFI_STATUS              Status;
 128   EXCEPTION_HANDLER_DATA  *ExceptionHandlerData;
 129   RESERVED_VECTORS_DATA   *ReservedVectors;
 130
 131   ReservedVectors = AllocatePool (sizeof (RESERVED_VECTORS_DATA) * CPU_EXCEPTION_NUM);
 132   ASSERT (ReservedVectors != NULL);
 133
 134   ExceptionHandlerData = AllocatePool (sizeof (EXCEPTION_HANDLER_DATA));
 135   ASSERT (ExceptionHandlerData != NULL);
 136   ExceptionHandlerData->IdtEntryCount            = CPU_EXCEPTION_NUM;
 137   ExceptionHandlerData->ReservedVectors          = ReservedVectors;
 138   ExceptionHandlerData->ExternalInterruptHandler = NULL;
 139   InitializeSpinLock (&ExceptionHandlerData->DisplayMessageSpinLock);
 140
 141   Status = InitializeCpuExceptionHandlersWorker (VectorInfo, ExceptionHandlerData);
 142   if (EFI_ERROR (Status)) {
 143     FreePool (ReservedVectors);
 144     FreePool (ExceptionHandlerData);
 145     return Status;
 146   }
 147
 148   SetExceptionHandlerData (ExceptionHandlerData);
 149   return EFI_SUCCESS;
 150 }
 151
 152 /**
 153   Initializes all CPU exceptions entries with optional extra initializations.
 154
 155   By default, this method should include all functionalities implemented by
 156   InitializeCpuExceptionHandlers(), plus extra initialization works, if any.
 157   This could be done by calling InitializeCpuExceptionHandlers() directly
 158   in this method besides the extra works.
 159
 160   InitData is optional and its use and content are processor arch dependent.
 161   The typical usage of it is to convey resources which have to be reserved
 162   elsewhere and are necessary for the extra initializations of exception.
 163
 164   @param[in]  VectorInfo    Pointer to reserved vector list.
 165   @param[in]  InitData      Pointer to data optional for extra initializations
 166                             of exception.
 167
 168   @retval EFI_SUCCESS             The exceptions have been successfully
 169                                   initialized.
 170   @retval EFI_INVALID_PARAMETER   VectorInfo or InitData contains invalid
 171                                   content.
 172
 173 **/
 174 EFI_STATUS
 175 EFIAPI
 176 InitializeCpuExceptionHandlersEx (
 177   IN EFI_VECTOR_HANDOFF_INFO  *VectorInfo OPTIONAL,
 178   IN CPU_EXCEPTION_INIT_DATA  *InitData OPTIONAL
 179   )
 180 {
 181   EFI_STATUS  Status;
 182
 183   //
 184   // To avoid repeat initialization of default handlers, the caller should pass
 185   // an extended init data with InitDefaultHandlers set to FALSE. There's no
 186   // need to call this method to just initialize default handlers. Call non-ex
 187   // version instead; or this method must be implemented as a simple wrapper of
 188   // non-ex version of it, if this version has to be called.
 189   //
 190   if ((InitData == NULL) || InitData->Ia32.InitDefaultHandlers) {
 191     Status = InitializeCpuExceptionHandlers (VectorInfo);
 192   } else {
 193     Status = EFI_SUCCESS;
 194   }
 195
 196   if (!EFI_ERROR (Status)) {
 197     //
 198     // Initializing stack switch is only necessary for Stack Guard functionality.
 199     //
 200     if (PcdGetBool (PcdCpuStackGuard) && (InitData != NULL)) {
 201       Status = ArchSetupExceptionStack (InitData);
 202     }
 203   }
 204
 205   return Status;
 206 }