UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / SourceLevelDebugPkg / Library / DebugAgent / DebugAgentCommon / DebugMp.c

/** @file\r
  Multi-Processor support functions implementation.\r
\r
  Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "DebugAgent.h"\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED DEBUG_MP_CONTEXT volatile  mDebugMpContext = { 0, 0, 0, { 0 }, { 0 }, 0, 0, 0, 0, FALSE, FALSE };\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED DEBUG_CPU_DATA volatile  mDebugCpuData = { 0 };\r
\r
/**\r
  Acquire a spin lock when Multi-processor supported.\r
\r
  It will block in the function if cannot get the access control.\r
  If Multi-processor is not supported, return directly.\r
\r
  @param[in, out] MpSpinLock      A pointer to the spin lock.\r
\r
**/\r
VOID\r
AcquireMpSpinLock (\r
  IN OUT SPIN_LOCK  *MpSpinLock\r
  )\r
{\r
  if (!MultiProcessorDebugSupport ()) {\r
    return;\r
  }\r
\r
  while (TRUE) {\r
    if (AcquireSpinLockOrFail (MpSpinLock)) {\r
      break;\r
    }\r
\r
    CpuPause ();\r
    continue;\r
  }\r
}\r
\r
/**\r
  Release a spin lock when Multi-processor supported.\r
\r
  @param[in, out] MpSpinLock      A pointer to the spin lock.\r
\r
**/\r
VOID\r
ReleaseMpSpinLock (\r
  IN OUT SPIN_LOCK  *MpSpinLock\r
  )\r
{\r
  if (!MultiProcessorDebugSupport ()) {\r
    return;\r
  }\r
\r
  ReleaseSpinLock (MpSpinLock);\r
}\r
\r
/**\r
  Break the other processor by send IPI.\r
\r
  @param[in] CurrentProcessorIndex  Current processor index value.\r
\r
**/\r
VOID\r
HaltOtherProcessors (\r
  IN UINT32  CurrentProcessorIndex\r
  )\r
{\r
  DebugAgentMsgPrint (DEBUG_AGENT_INFO, "processor[%x]:Try to halt other processors.\n", CurrentProcessorIndex);\r
  if (!DebugAgentIsBsp (CurrentProcessorIndex)) {\r
    SetIpiSentByApFlag (TRUE);\r
  }\r
\r
  mDebugMpContext.BreakAtCpuIndex = CurrentProcessorIndex;\r
\r
  //\r
  // Set the debug viewpoint to the current breaking CPU.\r
  //\r
  SetDebugViewPoint (CurrentProcessorIndex);\r
\r
  //\r
  // Send fixed IPI to other processors.\r
  //\r
  SendFixedIpiAllExcludingSelf (DEBUG_TIMER_VECTOR);\r
}\r
\r
/**\r
  Get the current processor's index.\r
\r
  @return Processor index value.\r
\r
**/\r
UINT32\r
GetProcessorIndex (\r
  VOID\r
  )\r
{\r
  UINT32  Index;\r
  UINT16  LocalApicID;\r
\r
  LocalApicID = (UINT16)GetApicId ();\r
\r
  AcquireMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
\r
  for (Index = 0; Index < mDebugCpuData.CpuCount; Index++) {\r
    if (mDebugCpuData.ApicID[Index] == LocalApicID) {\r
      break;\r
    }\r
  }\r
\r
  if (Index == mDebugCpuData.CpuCount) {\r
    mDebugCpuData.ApicID[Index] = LocalApicID;\r
    mDebugCpuData.CpuCount++;\r
  }\r
\r
  ReleaseMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
\r
  return Index;\r
}\r
\r
/**\r
  Check if the specified processor is BSP or not.\r
\r
  @param[in] ProcessorIndex Processor index value.\r
\r
  @retval TRUE    It is BSP.\r
  @retval FALSE   It isn't BSP.\r
\r
**/\r
BOOLEAN\r
DebugAgentIsBsp (\r
  IN UINT32  ProcessorIndex\r
  )\r
{\r
  MSR_IA32_APIC_BASE_REGISTER  MsrApicBase;\r
\r
  //\r
  // If there are less than 2 CPUs detected, then the currently executing CPU\r
  // must be the BSP.  This avoids an access to an MSR that may not be supported\r
  // on single core CPUs.\r
  //\r
  if (mDebugCpuData.CpuCount < 2) {\r
    return TRUE;\r
  }\r
\r
  MsrApicBase.Uint64 = AsmReadMsr64 (MSR_IA32_APIC_BASE);\r
  if (MsrApicBase.Bits.BSP == 1) {\r
    if (mDebugMpContext.BspIndex != ProcessorIndex) {\r
      AcquireMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
      mDebugMpContext.BspIndex = ProcessorIndex;\r
      ReleaseMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
    }\r
\r
    return TRUE;\r
  } else {\r
    return FALSE;\r
  }\r
}\r
\r
/**\r
  Set processor stop flag bitmask in MP context.\r
\r
  @param[in] ProcessorIndex Processor index value.\r
  @param[in] StopFlag       TRUE means set stop flag.\r
                            FALSE means clean break flag.\r
\r
**/\r
VOID\r
SetCpuStopFlagByIndex (\r
  IN UINT32   ProcessorIndex,\r
  IN BOOLEAN  StopFlag\r
  )\r
{\r
  UINT8  Value;\r
  UINTN  Index;\r
\r
  AcquireMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
\r
  Value = mDebugMpContext.CpuStopStatusMask[ProcessorIndex / 8];\r
  Index = ProcessorIndex % 8;\r
  if (StopFlag) {\r
    Value = BitFieldWrite8 (Value, Index, Index, 1);\r
  } else {\r
    Value = BitFieldWrite8 (Value, Index, Index, 0);\r
  }\r
\r
  mDebugMpContext.CpuStopStatusMask[ProcessorIndex / 8] = Value;\r
\r
  ReleaseMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
}\r
\r
/**\r
  Set processor break flag bitmask in MP context.\r
\r
  @param[in] ProcessorIndex Processor index value.\r
  @param[in] BreakFlag      TRUE means set break flag.\r
                            FALSE means clean break flag.\r
\r
**/\r
VOID\r
SetCpuBreakFlagByIndex (\r
  IN UINT32   ProcessorIndex,\r
  IN BOOLEAN  BreakFlag\r
  )\r
{\r
  UINT8  Value;\r
  UINTN  Index;\r
\r
  AcquireMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
\r
  Value = mDebugMpContext.CpuBreakMask[ProcessorIndex / 8];\r
  Index = ProcessorIndex % 8;\r
  if (BreakFlag) {\r
    Value = BitFieldWrite8 (Value, Index, Index, 1);\r
  } else {\r
    Value = BitFieldWrite8 (Value, Index, Index, 0);\r
  }\r
\r
  mDebugMpContext.CpuBreakMask[ProcessorIndex / 8] = Value;\r
\r
  ReleaseMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
}\r
\r
/**\r
  Check if processor is stopped already.\r
\r
  @param[in] ProcessorIndex   Processor index value.\r
\r
  @retval TRUE        Processor is stopped already.\r
  @retval TRUE        Processor isn't stopped.\r
\r
**/\r
BOOLEAN\r
IsCpuStopped (\r
  IN UINT32  ProcessorIndex\r
  )\r
{\r
  UINT8  CpuMask;\r
\r
  CpuMask = (UINT8)(1 << (ProcessorIndex % 8));\r
\r
  if ((mDebugMpContext.CpuStopStatusMask[ProcessorIndex / 8] & CpuMask) != 0) {\r
    return TRUE;\r
  } else {\r
    return FALSE;\r
  }\r
}\r
\r
/**\r
  Set the run command flag.\r
\r
  @param[in] RunningFlag   TRUE means run command flag is set.\r
                           FALSE means run command flag is cleared.\r
\r
**/\r
VOID\r
SetCpuRunningFlag (\r
  IN BOOLEAN  RunningFlag\r
  )\r
{\r
  AcquireMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
  mDebugMpContext.RunCommandSet = RunningFlag;\r
  ReleaseMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
}\r
\r
/**\r
  Set the current view point to be debugged.\r
\r
  @param[in] ProcessorIndex   Processor index value.\r
\r
**/\r
VOID\r
SetDebugViewPoint (\r
  IN UINT32  ProcessorIndex\r
  )\r
{\r
  AcquireMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
  mDebugMpContext.ViewPointIndex = ProcessorIndex;\r
  ReleaseMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
}\r
\r
/**\r
  Set the IPI send by BPS/AP flag.\r
\r
  @param[in] IpiSentByApFlag   TRUE means this IPI is sent by AP.\r
                               FALSE means this IPI is sent by BSP.\r
\r
**/\r
VOID\r
SetIpiSentByApFlag (\r
  IN BOOLEAN  IpiSentByApFlag\r
  )\r
{\r
  AcquireMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
  mDebugMpContext.IpiSentByAp = IpiSentByApFlag;\r
  ReleaseMpSpinLock (&mDebugMpContext.MpContextSpinLock);\r
}\r
\r
/**\r
  Check the next pending breaking CPU.\r
\r
  @retval others      There is at least one processor broken, the minimum\r
                      index number of Processor returned.\r
  @retval -1          No any processor broken.\r
\r
**/\r
UINT32\r
FindNextPendingBreakCpu (\r
  VOID\r
  )\r
{\r
  UINT32  Index;\r
\r
  for (Index = 0; Index < DEBUG_CPU_MAX_COUNT / 8; Index++) {\r
    if (mDebugMpContext.CpuBreakMask[Index] != 0) {\r
      return (UINT32)LowBitSet32 (mDebugMpContext.CpuBreakMask[Index]) + Index * 8;\r
    }\r
  }\r
\r
  return (UINT32)-1;\r
}\r
\r
/**\r
  Check if all processors are in running status.\r
\r
  @retval TRUE        All processors run.\r
  @retval FALSE       At least one processor does not run.\r
\r
**/\r
BOOLEAN\r
IsAllCpuRunning (\r
  VOID\r
  )\r
{\r
  UINTN  Index;\r
\r
  for (Index = 0; Index < DEBUG_CPU_MAX_COUNT / 8; Index++) {\r
    if (mDebugMpContext.CpuStopStatusMask[Index] != 0) {\r
      return FALSE;\r
    }\r
  }\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Check if the current processor is the first breaking processor.\r
\r
  If yes, halt other processors.\r
\r
  @param[in] ProcessorIndex   Processor index value.\r
\r
  @return TRUE       This processor is the first breaking processor.\r
  @return FALSE      This processor is not the first breaking processor.\r
\r
**/\r
BOOLEAN\r
IsFirstBreakProcessor (\r
  IN UINT32  ProcessorIndex\r
  )\r
{\r
  if (MultiProcessorDebugSupport ()) {\r
    if (mDebugMpContext.BreakAtCpuIndex != (UINT32)-1) {\r
      //\r
      // The current processor is not the first breaking one.\r
      //\r
      SetCpuBreakFlagByIndex (ProcessorIndex, TRUE);\r
      return FALSE;\r
    } else {\r
      //\r
      // If no any processor breaks, try to halt other processors\r
      //\r
      HaltOtherProcessors (ProcessorIndex);\r
      return TRUE;\r
    }\r
  }\r
\r
  return TRUE;\r
}\r