UefiCpuPkg/MpInitLib: honor the platform's boot CPU count in AP detection

- If a platform boots such that the boot CPU count is smaller than
  PcdCpuMaxLogicalProcessorNumber, then the platform cannot use the "fast
  AP detection" logic added in commit 6e1987f19af7. (Which has been
  documented as a subset of use case (2) in the previous patch.)

  Said logic depends on the boot CPU count being equal to
  PcdCpuMaxLogicalProcessorNumber. If the equality does not hold, the
  platform either has to wait too long, or risk missing APs due to an
  early timeout.

- The platform may not be able to use the variant added in commit
  0594ec417c89 either. (Which has been documented as use case (1) in the
  previous patch.)

  See commit 861218740d6d. When OVMF runs on QEMU/KVM, APs may check in
  with the BSP in arbitrary order, plus the individual AP may take
  arbitrarily long to check-in. If "NumApsExecuting" falls to zero
  mid-enumeration, APs will be missed.

Allow platforms to specify the exact boot CPU count, independently of
PcdCpuMaxLogicalProcessorNumber. In this mode, the BSP waits for all APs
to check-in regardless of timeout. If at least one AP fails to check-in,
then the AP enumeration hangs forever. That is the desired behavior when
the exact boot CPU count is known in advance. (A hung boot is better than
an AP checking-in after timeout, and executing code from released
storage.)

Cc: Eric Dong <eric.dong@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=1515
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Ray Ni <ray.ni@intel.com>

1 files changed, 13 insertions, 0 deletions

diff --git a/UefiCpuPkg/UefiCpuPkg.dec b/UefiCpuPkg/UefiCpuPkg.dec
index 031a2ccd68..12f4413ea5 100644
--- a/UefiCpuPkg/UefiCpuPkg.dec
+++ b/UefiCpuPkg/UefiCpuPkg.dec
@@ -227,6 +227,19 @@
   ## Specifies timeout value in microseconds for the BSP to detect all APs for the first time.

   # @Prompt Timeout for the BSP to detect all APs for the first time.

   gUefiCpuPkgTokenSpaceGuid.PcdCpuApInitTimeOutInMicroSeconds|50000|UINT32|0x00000004

+  ## Specifies the number of Logical Processors that are available in the

+  #  preboot environment after platform reset, including BSP and APs. Possible

+  #  values:<BR><BR>

+  #  zero (default) - PcdCpuBootLogicalProcessorNumber is ignored, and

+  #                   PcdCpuApInitTimeOutInMicroSeconds limits the initial AP

+  #                   detection by the BSP.<BR>

+  #  nonzero        - PcdCpuApInitTimeOutInMicroSeconds is ignored. The initial

+  #                   AP detection finishes only when the detected CPU count

+  #                   (BSP plus APs) reaches the value of

+  #                   PcdCpuBootLogicalProcessorNumber, regardless of how long

+  #                   that takes.<BR>

+  # @Prompt Number of Logical Processors available after platform reset.

+  gUefiCpuPkgTokenSpaceGuid.PcdCpuBootLogicalProcessorNumber|0|UINT32|0x00000008

   ## Specifies the base address of the first microcode Patch in the microcode Region.

   # @Prompt Microcode Region base address.

   gUefiCpuPkgTokenSpaceGuid.PcdCpuMicrocodePatchAddress|0x0|UINT64|0x00000005