Add validation on ACPI_S3_CONTEXT.S3DebugBufferAddress, moreover only debug tip could...

[mirror_edk2.git] / MdeModulePkg / Universal / Acpi / BootScriptExecutorDxe / X64 / SetIdtEntry.c

/** @file\r
  Set a IDT entry for debug purpose\r
\r
  Set a IDT entry for interrupt vector 3 for debug purpose for x64 platform\r
\r
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
#include "ScriptExecute.h"\r
//\r
// INTERRUPT_GATE_DESCRIPTOR and SetIdtEntry () are used to setup IDT to do debug\r
//\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  UINT16    Offset15To0;\r
  UINT16    SegmentSelector;\r
  UINT16    Attributes;\r
  UINT16    Offset31To16;\r
  UINT32    Offset63To32;\r
  UINT32    Reserved;\r
} INTERRUPT_GATE_DESCRIPTOR;\r
\r
#define INTERRUPT_GATE_ATTRIBUTE   0x8e00\r
\r
#pragma pack()\r
\r
#define IA32_PG_P                   BIT0\r
#define IA32_PG_RW                  BIT1\r
#define IA32_PG_PS                  BIT7\r
\r
UINT64                             mPhyMask;\r
BOOLEAN                            mPage1GSupport;\r
VOID                               *mOriginalHandler;\r
UINTN                              mS3NvsPageTableAddress;\r
\r
/**\r
  Page fault handler.\r
\r
**/\r
VOID\r
EFIAPI\r
PageFaultHandlerHook (\r
  VOID\r
  );\r
\r
/**\r
  Hook IDT with our page fault handler so that the on-demand paging works on page fault.\r
\r
  @param  IdtEntry  a pointer to IDT entry\r
\r
**/\r
VOID\r
HookPageFaultHandler (\r
  IN INTERRUPT_GATE_DESCRIPTOR                     *IdtEntry\r
  )\r
{\r
  UINT32         RegEax;\r
  UINT32         RegEdx;\r
\r
  AsmCpuid (0x80000008, &RegEax, NULL, NULL, NULL);\r
  mPhyMask = LShiftU64 (1, (UINT8)RegEax) - 1;\r
  mPhyMask &= (1ull << 48) - SIZE_4KB;\r
\r
  mPage1GSupport = FALSE;\r
  if (PcdGetBool(PcdUse1GPageTable)) {\r
    AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL);\r
    if (RegEax >= 0x80000001) {\r
      AsmCpuid (0x80000001, NULL, NULL, NULL, &RegEdx);\r
      if ((RegEdx & BIT26) != 0) {\r
        mPage1GSupport = TRUE;\r
      }\r
    }\r
  }\r
\r
  //\r
  // Set Page Fault entry to catch >4G access\r
  //\r
  mOriginalHandler = (VOID *)(UINTN)(LShiftU64 (IdtEntry->Offset63To32, 32) + IdtEntry->Offset15To0 + (IdtEntry->Offset31To16 << 16));\r
  IdtEntry->Offset15To0     = (UINT16)((UINTN)PageFaultHandlerHook);\r
  IdtEntry->SegmentSelector = (UINT16)AsmReadCs ();\r
  IdtEntry->Attributes      = (UINT16)INTERRUPT_GATE_ATTRIBUTE;\r
  IdtEntry->Offset31To16    = (UINT16)((UINTN)PageFaultHandlerHook >> 16);\r
  IdtEntry->Offset63To32    = (UINT32)((UINTN)PageFaultHandlerHook >> 32);\r
  IdtEntry->Reserved        = 0;\r
\r
  if (mPage1GSupport) {\r
    mS3NvsPageTableAddress = (UINTN)(AsmReadCr3 () & mPhyMask) + EFI_PAGES_TO_SIZE(2);\r
  }else {\r
    mS3NvsPageTableAddress = (UINTN)(AsmReadCr3 () & mPhyMask) + EFI_PAGES_TO_SIZE(6);\r
  }\r
}\r
\r
/**\r
  Set a IDT entry for interrupt vector 3 for debug purpose.\r
\r
  @param  AcpiS3Context  a pointer to a structure of ACPI_S3_CONTEXT\r
\r
**/\r
VOID\r
SetIdtEntry (\r
  IN ACPI_S3_CONTEXT     *AcpiS3Context\r
  )\r
{\r
  INTERRUPT_GATE_DESCRIPTOR                     *IdtEntry;\r
  IA32_DESCRIPTOR                               *IdtDescriptor;\r
  UINTN                                         S3DebugBuffer;\r
\r
  //\r
  // Restore IDT for debug\r
  //\r
  IdtDescriptor = (IA32_DESCRIPTOR *) (UINTN) (AcpiS3Context->IdtrProfile);\r
  AsmWriteIdtr (IdtDescriptor);\r
\r
  //\r
  // Setup the default CPU exception handlers\r
  //\r
  SetupCpuExceptionHandlers ();\r
\r
  DEBUG_CODE (\r
    //\r
    // Update IDT entry INT3 if the instruction is valid in it\r
    //\r
    S3DebugBuffer = (UINTN) (AcpiS3Context->S3DebugBufferAddress);\r
    if (*(UINTN *)S3DebugBuffer != (UINTN) -1) {\r
      IdtEntry = (INTERRUPT_GATE_DESCRIPTOR *)(IdtDescriptor->Base + (3 * sizeof (INTERRUPT_GATE_DESCRIPTOR)));\r
      IdtEntry->Offset15To0     = (UINT16)S3DebugBuffer;\r
      IdtEntry->SegmentSelector = (UINT16)AsmReadCs ();\r
      IdtEntry->Attributes      = (UINT16)INTERRUPT_GATE_ATTRIBUTE;\r
      IdtEntry->Offset31To16    = (UINT16)(S3DebugBuffer >> 16);\r
      IdtEntry->Offset63To32    = (UINT32)(S3DebugBuffer >> 32);\r
      IdtEntry->Reserved        = 0;\r
    }\r
  );\r
\r
  IdtEntry = (INTERRUPT_GATE_DESCRIPTOR *)(IdtDescriptor->Base + (14 * sizeof (INTERRUPT_GATE_DESCRIPTOR)));\r
  HookPageFaultHandler (IdtEntry);\r
}\r
\r
/**\r
  Get new page address.\r
\r
  @param  PageNum  new page number needed\r
\r
  @return new page address\r
**/\r
UINTN\r
GetNewPage (\r
  IN UINTN  PageNum\r
  )\r
{\r
  UINTN  NewPage;\r
  NewPage = mS3NvsPageTableAddress;\r
  ZeroMem ((VOID *)NewPage, EFI_PAGES_TO_SIZE(PageNum));\r
  mS3NvsPageTableAddress += EFI_PAGES_TO_SIZE(PageNum);\r
  return NewPage;\r
}\r
\r
/**\r
  The page fault handler that on-demand read >4G memory/MMIO.\r
  \r
  @retval TRUE     The page fault is correctly handled.\r
  @retval FALSE    The page fault is not handled and is passed through to original handler.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
PageFaultHandler (\r
  VOID\r
  )\r
{\r
  UINT64         *PageTable;\r
  UINT64         PFAddress;\r
  UINTN          PTIndex;\r
\r
  PFAddress = AsmReadCr2 ();\r
  DEBUG ((EFI_D_ERROR, "BootScript - PageFaultHandler: Cr2 - %lx\n", PFAddress));\r
\r
  if (PFAddress >= mPhyMask + SIZE_4KB) {\r
    return FALSE;\r
  }\r
  PFAddress &= mPhyMask;\r
\r
  PageTable = (UINT64*)(UINTN)(AsmReadCr3 () & mPhyMask);\r
\r
  PTIndex = BitFieldRead64 (PFAddress, 39, 47);\r
  // PML4E\r
  if ((PageTable[PTIndex] & IA32_PG_P) == 0) {\r
    PageTable[PTIndex] = GetNewPage (1) | IA32_PG_P | IA32_PG_RW;\r
  }\r
  PageTable = (UINT64*)(UINTN)(PageTable[PTIndex] & mPhyMask);\r
  PTIndex = BitFieldRead64 (PFAddress, 30, 38);\r
  // PDPTE\r
  if (mPage1GSupport) {\r
    PageTable[PTIndex] = PFAddress | IA32_PG_P | IA32_PG_RW | IA32_PG_PS;\r
  } else {\r
    if ((PageTable[PTIndex] & IA32_PG_P) == 0) {\r
      PageTable[PTIndex] = GetNewPage (1) | IA32_PG_P | IA32_PG_RW;\r
    }\r
    PageTable = (UINT64*)(UINTN)(PageTable[PTIndex] & mPhyMask);\r
    PTIndex = BitFieldRead64 (PFAddress, 21, 29);\r
    // PD\r
    PageTable[PTIndex] = PFAddress | IA32_PG_P | IA32_PG_RW | IA32_PG_PS;\r
  }\r
\r
  return TRUE;\r
}\r