[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / EbcDebugger / EdbHook.c

/*++\r
\r
Copyright (c) 2007, Intel Corporation\r
All rights reserved. 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
Module Name:\r
\r
  EdbHook.c\r
\r
Abstract:\r
\r
\r
--*/\r
\r
#include "Edb.h"\r
\r
//\r
// Hook support function\r
//\r
VOID\r
EbcDebuggerCheckHookFlag (\r
  IN VM_CONTEXT *VmPtr,\r
  IN UINT32     Flag\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Check the Hook flag, and trigger exception if match.\r
\r
Arguments:\r
\r
  VmPtr        - EbcDebuggerCheckHookFlag\r
  Flag         - Feature flag\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  if ((mDebuggerPrivate.FeatureFlags & Flag) == Flag) {\r
    mDebuggerPrivate.StatusFlags = Flag;\r
    EbcDebugSignalException (\r
      EXCEPT_EBC_BREAKPOINT,\r
      EXCEPTION_FLAG_NONE,\r
      VmPtr\r
      );\r
  }\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerPushCallstackSource (\r
  IN UINT64                   SourceEntry,\r
  IN EFI_DEBUGGER_BRANCH_TYPE Type\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  It will record soruce address for Callstack entry.\r
\r
Arguments:\r
\r
  SourceEntry  - Source address\r
  Type         - Branch type\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  if (mDebuggerPrivate.CallStackEntryCount > EFI_DEBUGGER_CALLSTACK_MAX) {\r
    ASSERT (FALSE);\r
    mDebuggerPrivate.CallStackEntryCount = EFI_DEBUGGER_CALLSTACK_MAX;\r
  }\r
  //\r
  // Record the new callstack entry\r
  //\r
  mDebuggerPrivate.CallStackEntry[mDebuggerPrivate.CallStackEntryCount].SourceAddress = SourceEntry;\r
  mDebuggerPrivate.CallStackEntry[mDebuggerPrivate.CallStackEntryCount].Type = Type;\r
\r
  //\r
  // Do not change CallStackEntryCount\r
  //\r
\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerPushCallstackParameter (\r
  IN UINT64                   ParameterAddress,\r
  IN EFI_DEBUGGER_BRANCH_TYPE Type\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  It will record parameter for Callstack entry.\r
\r
Arguments:\r
\r
  ParameterAddress - The address for the parameter\r
  Type             - Branch type\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  if (mDebuggerPrivate.CallStackEntryCount > EFI_DEBUGGER_CALLSTACK_MAX) {\r
    ASSERT (FALSE);\r
    mDebuggerPrivate.CallStackEntryCount = EFI_DEBUGGER_CALLSTACK_MAX;\r
  }\r
  //\r
  // Record the new callstack parameter\r
  //\r
  mDebuggerPrivate.CallStackEntry[mDebuggerPrivate.CallStackEntryCount].ParameterAddr = (UINTN)ParameterAddress;\r
  CopyMem (\r
    mDebuggerPrivate.CallStackEntry[mDebuggerPrivate.CallStackEntryCount].Parameter,\r
    (VOID *)(UINTN)ParameterAddress,\r
    sizeof(mDebuggerPrivate.CallStackEntry[mDebuggerPrivate.CallStackEntryCount].Parameter)\r
    );\r
\r
  //\r
  // Do not change CallStackEntryCount\r
  //\r
\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerPushCallstackDest (\r
  IN UINT64                   DestEntry,\r
  IN EFI_DEBUGGER_BRANCH_TYPE Type\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  It will record source address for callstack entry.\r
\r
Arguments:\r
\r
  DestEntry    - Source address\r
  Type         - Branch type\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  UINTN Index;\r
\r
  if (mDebuggerPrivate.CallStackEntryCount < EFI_DEBUGGER_CALLSTACK_MAX) {\r
    //\r
    // If there is empty entry for callstack, add it\r
    //\r
    ASSERT (mDebuggerPrivate.CallStackEntry[mDebuggerPrivate.CallStackEntryCount].Type == Type);\r
    mDebuggerPrivate.CallStackEntry[mDebuggerPrivate.CallStackEntryCount].DestAddress = DestEntry;\r
    mDebuggerPrivate.CallStackEntryCount ++;\r
  } else {\r
    //\r
    // If there is no empty entry for callstack, throw the oldest one\r
    //\r
    ASSERT (mDebuggerPrivate.CallStackEntry[EFI_DEBUGGER_TRACE_MAX].Type == Type);\r
    for (Index = 0; Index < EFI_DEBUGGER_CALLSTACK_MAX; Index++) {\r
      mDebuggerPrivate.CallStackEntry[Index] = mDebuggerPrivate.CallStackEntry[Index + 1];\r
    }\r
    mDebuggerPrivate.CallStackEntry[EFI_DEBUGGER_CALLSTACK_MAX - 1].DestAddress = DestEntry;\r
    mDebuggerPrivate.CallStackEntryCount = EFI_DEBUGGER_CALLSTACK_MAX;\r
  }\r
\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerPopCallstack (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  It will throw the newest Callstack entry.\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  if ((mDebuggerPrivate.CallStackEntryCount > 0) &&\r
      (mDebuggerPrivate.CallStackEntryCount <= EFI_DEBUGGER_CALLSTACK_MAX)) {\r
    //\r
    // Throw the newest one\r
    //\r
    mDebuggerPrivate.CallStackEntryCount --;\r
    mDebuggerPrivate.CallStackEntry[mDebuggerPrivate.CallStackEntryCount].SourceAddress = 0;\r
    mDebuggerPrivate.CallStackEntry[mDebuggerPrivate.CallStackEntryCount].DestAddress = 0;\r
  } else if (mDebuggerPrivate.CallStackEntryCount == 0) {\r
    //\r
    // NOT assert here because it is reasonable, because when we start to build\r
    // callstack, we do not know how many function already called.\r
    //\r
  } else {\r
    ASSERT (FALSE);\r
  }\r
\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerPushTraceSourceEntry (\r
  IN UINT64                   SourceEntry,\r
  IN EFI_DEBUGGER_BRANCH_TYPE Type\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  It will record source address for trace entry.\r
\r
Arguments:\r
\r
  SourceEntry  - Source address\r
  Type         - Branch type\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  if (mDebuggerPrivate.TraceEntryCount > EFI_DEBUGGER_TRACE_MAX) {\r
    ASSERT (FALSE);\r
    mDebuggerPrivate.TraceEntryCount = EFI_DEBUGGER_TRACE_MAX;\r
  }\r
  //\r
  // Record the new trace entry\r
  //\r
  mDebuggerPrivate.TraceEntry[mDebuggerPrivate.TraceEntryCount].SourceAddress = SourceEntry;\r
  mDebuggerPrivate.TraceEntry[mDebuggerPrivate.TraceEntryCount].Type = Type;\r
\r
  //\r
  // Do not change TraceEntryCount\r
  //\r
\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerPushTraceDestEntry (\r
  IN UINT64                   DestEntry,\r
  IN EFI_DEBUGGER_BRANCH_TYPE Type\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  It will record destination address for trace entry.\r
\r
Arguments:\r
\r
  DestEntry    - Destination address\r
  Type         - Branch type\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  UINTN Index;\r
\r
  if (mDebuggerPrivate.TraceEntryCount < EFI_DEBUGGER_TRACE_MAX) {\r
    //\r
    // If there is empty entry for trace, add it\r
    //\r
    ASSERT (mDebuggerPrivate.TraceEntry[mDebuggerPrivate.TraceEntryCount].Type == Type);\r
    mDebuggerPrivate.TraceEntry[mDebuggerPrivate.TraceEntryCount].DestAddress = DestEntry;\r
    mDebuggerPrivate.TraceEntryCount ++;\r
  } else {\r
    //\r
    // If there is no empty entry for trace, throw the oldest one\r
    //\r
    ASSERT (mDebuggerPrivate.TraceEntry[EFI_DEBUGGER_TRACE_MAX].Type == Type);\r
    for (Index = 0; Index < EFI_DEBUGGER_TRACE_MAX; Index++) {\r
      mDebuggerPrivate.TraceEntry[Index] = mDebuggerPrivate.TraceEntry[Index + 1];\r
    }\r
    mDebuggerPrivate.TraceEntry[EFI_DEBUGGER_CALLSTACK_MAX - 1].DestAddress = DestEntry;\r
    mDebuggerPrivate.TraceEntryCount = EFI_DEBUGGER_TRACE_MAX;\r
  }\r
\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerPushStepEntry (\r
  IN UINT64                   Entry,\r
  IN UINT64                   FramePtr,\r
  IN UINT32                   Flag\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  It will record address for StepEntry, if STEPOVER or STEPOUT is enabled.\r
\r
Arguments:\r
\r
  Entry    - Break Address\r
  FramePtr - Break Frame pointer\r
  Flag     - for STEPOVER or STEPOUT\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  //\r
  // Check StepOver\r
  //\r
  if ((Flag == EFI_DEBUG_FLAG_EBC_STEPOVER) &&\r
      ((mDebuggerPrivate.FeatureFlags & EFI_DEBUG_FLAG_EBC_STEPOVER) == EFI_DEBUG_FLAG_EBC_STEPOVER)) {\r
    mDebuggerPrivate.StepContext.BreakAddress = Entry;\r
    mDebuggerPrivate.StepContext.FramePointer = FramePtr;\r
    mDebuggerPrivate.FeatureFlags &= ~EFI_DEBUG_FLAG_EBC_B_STEPOVER;\r
  }\r
  //\r
  // Check StepOut\r
  //\r
  if ((Flag == EFI_DEBUG_FLAG_EBC_STEPOUT) &&\r
      ((mDebuggerPrivate.FeatureFlags & EFI_DEBUG_FLAG_EBC_STEPOUT) == EFI_DEBUG_FLAG_EBC_STEPOUT)) {\r
    mDebuggerPrivate.StepContext.BreakAddress = Entry;\r
    mDebuggerPrivate.StepContext.FramePointer = FramePtr;\r
    mDebuggerPrivate.FeatureFlags &= ~EFI_DEBUG_FLAG_EBC_B_STEPOUT;\r
  }\r
}\r
\r
VOID\r
EFIAPI\r
EbcDebuggerBreakEventFunc (\r
  IN EFI_EVENT                Event,\r
  IN VOID                     *Context\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  if ((mDebuggerPrivate.FeatureFlags & EFI_DEBUG_FLAG_EBC_BOK) != EFI_DEBUG_FLAG_EBC_BOK) {\r
    return ;\r
  }\r
\r
  Status = gBS->CheckEvent (gST->ConIn->WaitForKey);\r
  if (Status == EFI_SUCCESS) {\r
    mDebuggerPrivate.StatusFlags = EFI_DEBUG_FLAG_EBC_BOK;\r
  }\r
}\r
\r
//\r
// Hook function implementation\r
//\r
VOID\r
EbcDebuggerHookInit (\r
  IN EFI_HANDLE                  Handle,\r
  IN EFI_DEBUG_SUPPORT_PROTOCOL  *EbcDebugProtocol\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in InitializeEbcDriver.\r
  It will init the EbcDebuggerPrivate data structure.\r
\r
Arguments:\r
\r
  Handle           - The EbcDebugProtocol handle.\r
  EbcDebugProtocol - The EbcDebugProtocol interface.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EFI_STATUS                 Status;\r
  UINTN                      Index;\r
  EFI_DEBUGGER_SYMBOL_OBJECT *Object;\r
  EFI_DEBUGGER_SYMBOL_ENTRY  *Entry;\r
\r
\r
  //\r
  // Register all exception handler\r
  //\r
  for (Index = EXCEPT_EBC_UNDEFINED; Index <= EXCEPT_EBC_STEP; Index++) {\r
    EbcDebugProtocol->RegisterExceptionCallback (\r
      EbcDebugProtocol,\r
      0,\r
      NULL,\r
      Index\r
      );\r
    EbcDebugProtocol->RegisterExceptionCallback (\r
      EbcDebugProtocol,\r
      0,\r
      EdbExceptionHandler,\r
      Index\r
      );\r
  }\r
\r
  //\r
  // Init Symbol\r
  //\r
  Object = AllocateZeroPool (sizeof(EFI_DEBUGGER_SYMBOL_OBJECT) * EFI_DEBUGGER_SYMBOL_OBJECT_MAX);\r
  ASSERT (Object != NULL);\r
  mDebuggerPrivate.DebuggerSymbolContext.Object = Object;\r
  mDebuggerPrivate.DebuggerSymbolContext.ObjectCount = 0;\r
  mDebuggerPrivate.DebuggerSymbolContext.MaxObjectCount = EFI_DEBUGGER_SYMBOL_OBJECT_MAX;\r
  for (Index = 0; Index < EFI_DEBUGGER_SYMBOL_OBJECT_MAX; Index++) {\r
    Entry = AllocateZeroPool (sizeof(EFI_DEBUGGER_SYMBOL_ENTRY) * EFI_DEBUGGER_SYMBOL_ENTRY_MAX);\r
    ASSERT (Entry != NULL);\r
    Object[Index].Entry = Entry;\r
    Object[Index].MaxEntryCount = EFI_DEBUGGER_SYMBOL_ENTRY_MAX;\r
    Object[Index].SourceBuffer = AllocateZeroPool (sizeof(VOID *) * (EFI_DEBUGGER_SYMBOL_ENTRY_MAX + 1));\r
    ASSERT (Object[Index].SourceBuffer != NULL);\r
  }\r
\r
  //\r
  // locate PciRootBridgeIo\r
  //\r
  Status = gBS->LocateProtocol (\r
                  &gEfiPciRootBridgeIoProtocolGuid,\r
                  NULL,\r
                  (VOID**) &mDebuggerPrivate.PciRootBridgeIo\r
                  );\r
\r
  //\r
  // locate DebugImageInfoTable\r
  //\r
  Status = EfiGetSystemConfigurationTable (\r
             &gEfiDebugImageInfoTableGuid,\r
             (VOID**) &mDebuggerPrivate.DebugImageInfoTableHeader\r
             );\r
\r
  //\r
  // Register Debugger Configuration Protocol, for config in shell\r
  //\r
  Status = gBS->InstallProtocolInterface (\r
                  &Handle,\r
                  &gEfiDebuggerConfigurationProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  &mDebuggerPrivate.DebuggerConfiguration\r
                  );\r
\r
  //\r
  //\r
  // Create break event\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
                  TPL_CALLBACK,\r
                  EbcDebuggerBreakEventFunc,\r
                  NULL,\r
                  &mDebuggerPrivate.BreakEvent\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    Status = gBS->SetTimer (\r
                    mDebuggerPrivate.BreakEvent,\r
                    TimerPeriodic,\r
                    EFI_DEBUG_BREAK_TIMER_INTERVAL\r
                    );\r
  }\r
\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookUnload (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in UnloadImage for EBC Interpreter.\r
  It clean up the environment.\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  UINTN                      Index;\r
  UINTN                      SubIndex;\r
  EFI_DEBUGGER_SYMBOL_OBJECT *Object;\r
\r
  //\r
  // Close the break event\r
  //\r
  if (mDebuggerPrivate.BreakEvent != NULL) {\r
    gBS->CloseEvent (mDebuggerPrivate.BreakEvent);\r
  }\r
\r
  //\r
  // Clean up the symbol\r
  //\r
  Object = mDebuggerPrivate.DebuggerSymbolContext.Object;\r
  for (Index = 0; Index < EFI_DEBUGGER_SYMBOL_OBJECT_MAX; Index++) {\r
    //\r
    // Clean up Entry\r
    //\r
    gBS->FreePool (Object[Index].Entry);\r
    Object[Index].Entry = NULL;\r
    Object[Index].EntryCount = 0;\r
    //\r
    // Clean up source buffer\r
    //\r
    for (SubIndex = 0; Object[Index].SourceBuffer[SubIndex] != NULL; SubIndex++) {\r
      gBS->FreePool (Object[Index].SourceBuffer[SubIndex]);\r
      Object[Index].SourceBuffer[SubIndex] = NULL;\r
    }\r
    gBS->FreePool (Object[Index].SourceBuffer);\r
    Object[Index].SourceBuffer = NULL;\r
  }\r
\r
  //\r
  // Clean up Object\r
  //\r
  gBS->FreePool (Object);\r
  mDebuggerPrivate.DebuggerSymbolContext.Object = NULL;\r
  mDebuggerPrivate.DebuggerSymbolContext.ObjectCount = 0;\r
\r
  //\r
  // Done\r
  //\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookEbcUnloadImage (\r
  IN EFI_HANDLE                  Handle\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in EbcUnloadImage.\r
  Currently do nothing here.\r
\r
Arguments:\r
\r
  Handle           - The EbcImage handle.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookExecuteEbcImageEntryPoint (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteEbcImageEntryPoint.\r
  It will record the call-stack entry. (-1 means EbcImageEntryPoint call)\r
  and trigger Exception if BOE enabled.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EbcDebuggerPushCallstackSource ((UINT64)(UINTN)-1, EfiDebuggerBranchTypeEbcCall);\r
  EbcDebuggerPushCallstackParameter ((UINT64)(UINTN)VmPtr->Gpr[0], EfiDebuggerBranchTypeEbcCall);\r
  EbcDebuggerPushCallstackDest ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcCall);\r
  EbcDebuggerCheckHookFlag (VmPtr, EFI_DEBUG_FLAG_EBC_BOE);\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookEbcInterpret (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteEbcImageEntryPoint.\r
  It will record the call-stack entry. (-2 means EbcInterpret call)\r
  and trigger Exception if BOT enabled.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EbcDebuggerPushCallstackSource ((UINT64)(UINTN)-2, EfiDebuggerBranchTypeEbcCall);\r
  EbcDebuggerPushCallstackParameter ((UINT64)(UINTN)VmPtr->Gpr[0], EfiDebuggerBranchTypeEbcCall);\r
  EbcDebuggerPushCallstackDest ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcCall);\r
  EbcDebuggerCheckHookFlag (VmPtr, EFI_DEBUG_FLAG_EBC_BOT);\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookExecuteStart (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in EbcExecute, before ExecuteFunction.\r
  It will trigger Exception if GoTil, StepOver, or StepOut hit.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EFI_TPL   CurrentTpl;\r
\r
  //\r
  // Check Ip for GoTil\r
  //\r
  if (mDebuggerPrivate.GoTilContext.BreakAddress == (UINT64)(UINTN)VmPtr->Ip) {\r
    mDebuggerPrivate.StatusFlags = EFI_DEBUG_FLAG_EBC_GT;\r
    mDebuggerPrivate.GoTilContext.BreakAddress = 0;\r
    EbcDebugSignalException (\r
      EXCEPT_EBC_BREAKPOINT,\r
      EXCEPTION_FLAG_NONE,\r
      VmPtr\r
      );\r
    mDebuggerPrivate.StatusFlags &= ~EFI_DEBUG_FLAG_EBC_B_GT;\r
    return ;\r
  }\r
  //\r
  // Check ReturnAddress for StepOver\r
  //\r
  if ((mDebuggerPrivate.StepContext.BreakAddress == (UINT64)(UINTN)VmPtr->Ip) &&\r
      (mDebuggerPrivate.StepContext.FramePointer == (UINT64)(UINTN)VmPtr->FramePtr)) {\r
    mDebuggerPrivate.StatusFlags = EFI_DEBUG_FLAG_EBC_STEPOVER;\r
    mDebuggerPrivate.StepContext.BreakAddress = 0;\r
    mDebuggerPrivate.StepContext.FramePointer = 0;\r
    EbcDebugSignalException (\r
      EXCEPT_EBC_BREAKPOINT,\r
      EXCEPTION_FLAG_NONE,\r
      VmPtr\r
      );\r
    mDebuggerPrivate.StatusFlags &= ~EFI_DEBUG_FLAG_EBC_B_STEPOVER;\r
  }\r
  //\r
  // Check FramePtr for StepOut\r
  //\r
  if (mDebuggerPrivate.StepContext.BreakAddress == (UINT64)(UINTN)VmPtr->FramePtr) {\r
    mDebuggerPrivate.StatusFlags = EFI_DEBUG_FLAG_EBC_STEPOUT;\r
    mDebuggerPrivate.StepContext.BreakAddress = 0;\r
    mDebuggerPrivate.StepContext.FramePointer = 0;\r
    EbcDebugSignalException (\r
      EXCEPT_EBC_BREAKPOINT,\r
      EXCEPTION_FLAG_NONE,\r
      VmPtr\r
      );\r
    mDebuggerPrivate.StatusFlags &= ~EFI_DEBUG_FLAG_EBC_B_STEPOUT;\r
  }\r
  //\r
  // Check Flags for BreakOnKey\r
  //\r
  if (mDebuggerPrivate.StatusFlags == EFI_DEBUG_FLAG_EBC_BOK) {\r
    //\r
    // Only break when the current TPL <= TPL_APPLICATION\r
    //\r
    CurrentTpl = gBS->RaiseTPL (TPL_HIGH_LEVEL);\r
    gBS->RestoreTPL (CurrentTpl);\r
    if (CurrentTpl <= TPL_APPLICATION) {\r
      EbcDebugSignalException (\r
        EXCEPT_EBC_BREAKPOINT,\r
        EXCEPTION_FLAG_NONE,\r
        VmPtr\r
        );\r
      mDebuggerPrivate.StatusFlags &= ~EFI_DEBUG_FLAG_EBC_B_BOK;\r
    }\r
  }\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookExecuteEnd (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in EbcExecute, after ExecuteFunction.\r
  It will record StepOut Entry if need.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  UINTN  Address;\r
\r
  //\r
  // Use FramePtr as checkpoint for StepOut\r
  //\r
  CopyMem (&Address, (VOID *)((UINTN)VmPtr->FramePtr), sizeof(Address));\r
  EbcDebuggerPushStepEntry (Address, (UINT64)(UINTN)VmPtr->FramePtr, EFI_DEBUG_FLAG_EBC_STEPOUT);\r
\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookCALLStart (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteCALL, before move IP.\r
  It will trigger Exception if BOC enabled,\r
  and record Callstack, and trace information.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EbcDebuggerCheckHookFlag (VmPtr, EFI_DEBUG_FLAG_EBC_BOC);\r
  EbcDebuggerPushCallstackSource ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcCall);\r
  EbcDebuggerPushCallstackParameter ((UINT64)(UINTN)VmPtr->Gpr[0], EfiDebuggerBranchTypeEbcCall);\r
  EbcDebuggerPushTraceSourceEntry ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcCall);\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookCALLEnd (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteCALL, after move IP.\r
  It will record Callstack, trace information\r
  and record StepOver/StepOut Entry if need.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  UINT64  Address;\r
  UINTN   FramePtr;\r
\r
  EbcDebuggerPushCallstackDest ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcCall);\r
  EbcDebuggerPushTraceDestEntry ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcCall);\r
\r
  //\r
  // Get Old FramePtr\r
  //\r
  CopyMem (&FramePtr, (VOID *)((UINTN)VmPtr->FramePtr), sizeof(FramePtr));\r
\r
  //\r
  // Use ReturnAddress as checkpoint for StepOver\r
  //\r
  CopyMem (&Address, (VOID *)(UINTN)VmPtr->Gpr[0], sizeof(Address));\r
  EbcDebuggerPushStepEntry (Address, FramePtr, EFI_DEBUG_FLAG_EBC_STEPOVER);\r
\r
  //\r
  // Use FramePtr as checkpoint for StepOut\r
  //\r
  Address = 0;\r
  CopyMem (&Address, (VOID *)(FramePtr), sizeof(UINTN));\r
  EbcDebuggerPushStepEntry (Address, FramePtr, EFI_DEBUG_FLAG_EBC_STEPOUT);\r
\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookCALLEXStart (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteCALL, before call EbcLLCALLEX.\r
  It will trigger Exception if BOCX enabled,\r
  and record Callstack information.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EbcDebuggerCheckHookFlag (VmPtr, EFI_DEBUG_FLAG_EBC_BOCX);\r
//  EbcDebuggerPushCallstackSource ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcCallEx);\r
//  EbcDebuggerPushCallstackParameter ((UINT64)(UINTN)VmPtr->R[0], EfiDebuggerBranchTypeEbcCallEx);\r
  EbcDebuggerPushTraceSourceEntry ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcCallEx);\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookCALLEXEnd (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteCALL, after call EbcLLCALLEX.\r
  It will record trace information.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
//  EbcDebuggerPushCallstackDest ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcCallEx);\r
  EbcDebuggerPushTraceDestEntry ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcCallEx);\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookRETStart (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteRET, before move IP.\r
  It will trigger Exception if BOR enabled,\r
  and record Callstack, and trace information.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EbcDebuggerCheckHookFlag (VmPtr, EFI_DEBUG_FLAG_EBC_BOR);\r
  EbcDebuggerPopCallstack ();\r
  EbcDebuggerPushTraceSourceEntry ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcRet);\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookRETEnd (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteRET, after move IP.\r
  It will record trace information.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EbcDebuggerPushTraceDestEntry ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcRet);\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookJMPStart (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteJMP, before move IP.\r
  It will record trace information.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EbcDebuggerPushTraceSourceEntry ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcJmp);\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookJMPEnd (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteJMP, after move IP.\r
  It will record trace information.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EbcDebuggerPushTraceDestEntry ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcJmp);\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookJMP8Start (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteJMP8, before move IP.\r
  It will record trace information.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EbcDebuggerPushTraceSourceEntry ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcJmp8);\r
  return ;\r
}\r
\r
VOID\r
EbcDebuggerHookJMP8End (\r
  IN VM_CONTEXT *VmPtr\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  The hook in ExecuteJMP8, after move IP.\r
  It will record trace information.\r
\r
Arguments:\r
\r
  VmPtr - pointer to VM context.\r
\r
Returns:\r
  None\r
\r
--*/\r
{\r
  EbcDebuggerPushTraceDestEntry ((UINT64)(UINTN)VmPtr->Ip, EfiDebuggerBranchTypeEbcJmp8);\r
  return ;\r
}\r