]> git.proxmox.com Git - mirror_edk2.git/blobdiff - UefiCpuPkg/Library/MpInitLib/MpLib.c
UefiCpuPkg/MpInitLib: Check APs Status and update APs status
[mirror_edk2.git] / UefiCpuPkg / Library / MpInitLib / MpLib.c
index 3a266e9607d4884ded4dc86bd28123a0f50b393c..2691af289a2a573369bf0849944d6436cd3f0efd 100644 (file)
@@ -901,6 +901,332 @@ WakeUpAP (
   }\r
 }\r
 \r
+/**\r
+  Calculate timeout value and return the current performance counter value.\r
+\r
+  Calculate the number of performance counter ticks required for a timeout.\r
+  If TimeoutInMicroseconds is 0, return value is also 0, which is recognized\r
+  as infinity.\r
+\r
+  @param[in]  TimeoutInMicroseconds   Timeout value in microseconds.\r
+  @param[out] CurrentTime             Returns the current value of the performance counter.\r
+\r
+  @return Expected time stamp counter for timeout.\r
+          If TimeoutInMicroseconds is 0, return value is also 0, which is recognized\r
+          as infinity.\r
+\r
+**/\r
+UINT64\r
+CalculateTimeout (\r
+  IN  UINTN   TimeoutInMicroseconds,\r
+  OUT UINT64  *CurrentTime\r
+  )\r
+{\r
+  //\r
+  // Read the current value of the performance counter\r
+  //\r
+  *CurrentTime = GetPerformanceCounter ();\r
+\r
+  //\r
+  // If TimeoutInMicroseconds is 0, return value is also 0, which is recognized\r
+  // as infinity.\r
+  //\r
+  if (TimeoutInMicroseconds == 0) {\r
+    return 0;\r
+  }\r
+\r
+  //\r
+  // GetPerformanceCounterProperties () returns the timestamp counter's frequency\r
+  // in Hz. So multiply the return value with TimeoutInMicroseconds and then divide\r
+  // it by 1,000,000, to get the number of ticks for the timeout value.\r
+  //\r
+  return DivU64x32 (\r
+           MultU64x64 (\r
+             GetPerformanceCounterProperties (NULL, NULL),\r
+             TimeoutInMicroseconds\r
+             ),\r
+           1000000\r
+           );\r
+}\r
+\r
+/**\r
+  Checks whether timeout expires.\r
+\r
+  Check whether the number of elapsed performance counter ticks required for\r
+  a timeout condition has been reached.\r
+  If Timeout is zero, which means infinity, return value is always FALSE.\r
+\r
+  @param[in, out]  PreviousTime   On input,  the value of the performance counter\r
+                                  when it was last read.\r
+                                  On output, the current value of the performance\r
+                                  counter\r
+  @param[in]       TotalTime      The total amount of elapsed time in performance\r
+                                  counter ticks.\r
+  @param[in]       Timeout        The number of performance counter ticks required\r
+                                  to reach a timeout condition.\r
+\r
+  @retval TRUE                    A timeout condition has been reached.\r
+  @retval FALSE                   A timeout condition has not been reached.\r
+\r
+**/\r
+BOOLEAN\r
+CheckTimeout (\r
+  IN OUT UINT64  *PreviousTime,\r
+  IN     UINT64  *TotalTime,\r
+  IN     UINT64  Timeout\r
+  )\r
+{\r
+  UINT64  Start;\r
+  UINT64  End;\r
+  UINT64  CurrentTime;\r
+  INT64   Delta;\r
+  INT64   Cycle;\r
+\r
+  if (Timeout == 0) {\r
+    return FALSE;\r
+  }\r
+  GetPerformanceCounterProperties (&Start, &End);\r
+  Cycle = End - Start;\r
+  if (Cycle < 0) {\r
+    Cycle = -Cycle;\r
+  }\r
+  Cycle++;\r
+  CurrentTime = GetPerformanceCounter();\r
+  Delta = (INT64) (CurrentTime - *PreviousTime);\r
+  if (Start > End) {\r
+    Delta = -Delta;\r
+  }\r
+  if (Delta < 0) {\r
+    Delta += Cycle;\r
+  }\r
+  *TotalTime += Delta;\r
+  *PreviousTime = CurrentTime;\r
+  if (*TotalTime > Timeout) {\r
+    return TRUE;\r
+  }\r
+  return FALSE;\r
+}\r
+\r
+/**\r
+  Reset an AP to Idle state.\r
+\r
+  Any task being executed by the AP will be aborted and the AP\r
+  will be waiting for a new task in Wait-For-SIPI state.\r
+\r
+  @param[in] ProcessorNumber  The handle number of processor.\r
+**/\r
+VOID\r
+ResetProcessorToIdleState (\r
+  IN UINTN                     ProcessorNumber\r
+  )\r
+{\r
+  CPU_MP_DATA           *CpuMpData;\r
+\r
+  CpuMpData = GetCpuMpData ();\r
+\r
+  WakeUpAP (CpuMpData, FALSE, ProcessorNumber, NULL, NULL);\r
+\r
+  SetApState (&CpuMpData->CpuData[ProcessorNumber], CpuStateIdle);\r
+}\r
+\r
+/**\r
+  Searches for the next waiting AP.\r
+\r
+  Search for the next AP that is put in waiting state by single-threaded StartupAllAPs().\r
+\r
+  @param[out]  NextProcessorNumber  Pointer to the processor number of the next waiting AP.\r
+\r
+  @retval EFI_SUCCESS          The next waiting AP has been found.\r
+  @retval EFI_NOT_FOUND        No waiting AP exists.\r
+\r
+**/\r
+EFI_STATUS\r
+GetNextWaitingProcessorNumber (\r
+  OUT UINTN                    *NextProcessorNumber\r
+  )\r
+{\r
+  UINTN           ProcessorNumber;\r
+  CPU_MP_DATA     *CpuMpData;\r
+\r
+  CpuMpData = GetCpuMpData ();\r
+\r
+  for (ProcessorNumber = 0; ProcessorNumber < CpuMpData->CpuCount; ProcessorNumber++) {\r
+    if (CpuMpData->CpuData[ProcessorNumber].Waiting) {\r
+      *NextProcessorNumber = ProcessorNumber;\r
+      return EFI_SUCCESS;\r
+    }\r
+  }\r
+\r
+  return EFI_NOT_FOUND;\r
+}\r
+\r
+/** Checks status of specified AP.\r
+\r
+  This function checks whether the specified AP has finished the task assigned\r
+  by StartupThisAP(), and whether timeout expires.\r
+\r
+  @param[in]  ProcessorNumber       The handle number of processor.\r
+\r
+  @retval EFI_SUCCESS           Specified AP has finished task assigned by StartupThisAPs().\r
+  @retval EFI_TIMEOUT           The timeout expires.\r
+  @retval EFI_NOT_READY         Specified AP has not finished task and timeout has not expired.\r
+**/\r
+EFI_STATUS\r
+CheckThisAP (\r
+  IN UINTN        ProcessorNumber\r
+  )\r
+{\r
+  CPU_MP_DATA     *CpuMpData;\r
+  CPU_AP_DATA     *CpuData;\r
+\r
+  CpuMpData = GetCpuMpData ();\r
+  CpuData   = &CpuMpData->CpuData[ProcessorNumber];\r
+\r
+  //\r
+  //  Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.\r
+  //  Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the\r
+  //  value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.\r
+  //\r
+  //\r
+  // If the AP finishes for StartupThisAP(), return EFI_SUCCESS.\r
+  //\r
+  if (GetApState(CpuData) == CpuStateFinished) {\r
+    if (CpuData->Finished != NULL) {\r
+      *(CpuData->Finished) = TRUE;\r
+    }\r
+    SetApState (CpuData, CpuStateIdle);\r
+    return EFI_SUCCESS;\r
+  } else {\r
+    //\r
+    // If timeout expires for StartupThisAP(), report timeout.\r
+    //\r
+    if (CheckTimeout (&CpuData->CurrentTime, &CpuData->TotalTime, CpuData->ExpectedTime)) {\r
+      if (CpuData->Finished != NULL) {\r
+        *(CpuData->Finished) = FALSE;\r
+      }\r
+      //\r
+      // Reset failed AP to idle state\r
+      //\r
+      ResetProcessorToIdleState (ProcessorNumber);\r
+\r
+      return EFI_TIMEOUT;\r
+    }\r
+  }\r
+  return EFI_NOT_READY;\r
+}\r
+\r
+/**\r
+  Checks status of all APs.\r
+\r
+  This function checks whether all APs have finished task assigned by StartupAllAPs(),\r
+  and whether timeout expires.\r
+\r
+  @retval EFI_SUCCESS           All APs have finished task assigned by StartupAllAPs().\r
+  @retval EFI_TIMEOUT           The timeout expires.\r
+  @retval EFI_NOT_READY         APs have not finished task and timeout has not expired.\r
+**/\r
+EFI_STATUS\r
+CheckAllAPs (\r
+  VOID\r
+  )\r
+{\r
+  UINTN           ProcessorNumber;\r
+  UINTN           NextProcessorNumber;\r
+  UINTN           ListIndex;\r
+  EFI_STATUS      Status;\r
+  CPU_MP_DATA     *CpuMpData;\r
+  CPU_AP_DATA     *CpuData;\r
+\r
+  CpuMpData = GetCpuMpData ();\r
+\r
+  NextProcessorNumber = 0;\r
+\r
+  //\r
+  // Go through all APs that are responsible for the StartupAllAPs().\r
+  //\r
+  for (ProcessorNumber = 0; ProcessorNumber < CpuMpData->CpuCount; ProcessorNumber++) {\r
+    if (!CpuMpData->CpuData[ProcessorNumber].Waiting) {\r
+      continue;\r
+    }\r
+\r
+    CpuData = &CpuMpData->CpuData[ProcessorNumber];\r
+    //\r
+    // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.\r
+    // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the\r
+    // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.\r
+    //\r
+    if (GetApState(CpuData) == CpuStateFinished) {\r
+      CpuMpData->RunningCount ++;\r
+      CpuMpData->CpuData[ProcessorNumber].Waiting = FALSE;\r
+      SetApState(CpuData, CpuStateIdle);\r
+\r
+      //\r
+      // If in Single Thread mode, then search for the next waiting AP for execution.\r
+      //\r
+      if (CpuMpData->SingleThread) {\r
+        Status = GetNextWaitingProcessorNumber (&NextProcessorNumber);\r
+\r
+        if (!EFI_ERROR (Status)) {\r
+          WakeUpAP (\r
+            CpuMpData,\r
+            FALSE,\r
+            (UINT32) NextProcessorNumber,\r
+            CpuMpData->Procedure,\r
+            CpuMpData->ProcArguments\r
+            );\r
+         }\r
+      }\r
+    }\r
+  }\r
+\r
+  //\r
+  // If all APs finish, return EFI_SUCCESS.\r
+  //\r
+  if (CpuMpData->RunningCount == CpuMpData->StartCount) {\r
+    return EFI_SUCCESS;\r
+  }\r
+\r
+  //\r
+  // If timeout expires, report timeout.\r
+  //\r
+  if (CheckTimeout (\r
+       &CpuMpData->CurrentTime,\r
+       &CpuMpData->TotalTime,\r
+       CpuMpData->ExpectedTime)\r
+       ) {\r
+    //\r
+    // If FailedCpuList is not NULL, record all failed APs in it.\r
+    //\r
+    if (CpuMpData->FailedCpuList != NULL) {\r
+      *CpuMpData->FailedCpuList =\r
+         AllocatePool ((CpuMpData->StartCount - CpuMpData->FinishedCount + 1) * sizeof (UINTN));\r
+      ASSERT (*CpuMpData->FailedCpuList != NULL);\r
+    }\r
+    ListIndex = 0;\r
+\r
+    for (ProcessorNumber = 0; ProcessorNumber < CpuMpData->CpuCount; ProcessorNumber++) {\r
+      //\r
+      // Check whether this processor is responsible for StartupAllAPs().\r
+      //\r
+      if (CpuMpData->CpuData[ProcessorNumber].Waiting) {\r
+        //\r
+        // Reset failed APs to idle state\r
+        //\r
+        ResetProcessorToIdleState (ProcessorNumber);\r
+        CpuMpData->CpuData[ProcessorNumber].Waiting = FALSE;\r
+        if (CpuMpData->FailedCpuList != NULL) {\r
+          (*CpuMpData->FailedCpuList)[ListIndex++] = ProcessorNumber;\r
+        }\r
+      }\r
+    }\r
+    if (CpuMpData->FailedCpuList != NULL) {\r
+      (*CpuMpData->FailedCpuList)[ListIndex] = END_OF_CPU_LIST;\r
+    }\r
+    return EFI_TIMEOUT;\r
+  }\r
+  return EFI_NOT_READY;\r
+}\r
+\r
 /**\r
   MP Initialize Library initialization.\r
 \r