Re: [edk2-devel] [Patch 2/5] UefiCpuPkg/MpInitLib: Add MpInitLibStartupAllCPUs API.

["Ni, Ray" <ray.ni@intel.com>]

I feel having additional parameter "IncludeBsp" in StartupAllAps() is a bit confusing.
How abut let StartupAllAPs() call StartupAllCPUs()?
StartupAllCPUs() contains a parameter indicating whether BSP is excluded.

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Dong,
> Eric
> Sent: Friday, July 19, 2019 3:28 PM
> To: devel@edk2.groups.io
> Cc: Ni, Ray <ray.ni@intel.com>; Laszlo Ersek <lersek@redhat.com>; Kumar,
> Chandana C <chandana.c.kumar@intel.com>; Zeng, Star
> <star.zeng@intel.com>
> Subject: [edk2-devel] [Patch 2/5] UefiCpuPkg/MpInitLib: Add
> MpInitLibStartupAllCPUs API.
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1973
> 
> Add new MpInitLibStartupAllCPUs API uses to start all processors at the same
> time.
> 
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Chandana Kumar <chandana.c.kumar@intel.com>
> Cc: Star Zeng <star.zeng@intel.com>
> Signed-off-by: Eric Dong <eric.dong@intel.com>
> ---
>  UefiCpuPkg/Library/MpInitLib/DxeMpLib.c |  1 +
>  UefiCpuPkg/Library/MpInitLib/MpLib.c    | 74
> ++++++++++++++++++++++++-
>  UefiCpuPkg/Library/MpInitLib/MpLib.h    |  2 +
>  UefiCpuPkg/Library/MpInitLib/PeiMpLib.c |  1 +
>  4 files changed, 75 insertions(+), 3 deletions(-)
> 
> diff --git a/UefiCpuPkg/Library/MpInitLib/DxeMpLib.c
> b/UefiCpuPkg/Library/MpInitLib/DxeMpLib.c
> index 6be1bae464..69c34afdf1 100644
> --- a/UefiCpuPkg/Library/MpInitLib/DxeMpLib.c
> +++ b/UefiCpuPkg/Library/MpInitLib/DxeMpLib.c
> @@ -571,6 +571,7 @@ MpInitLibStartupAllAPs (
>    Status = StartupAllAPsWorker (
>               Procedure,
>               SingleThread,
> +             FALSE,
>               WaitEvent,
>               TimeoutInMicroseconds,
>               ProcedureArgument,
> diff --git a/UefiCpuPkg/Library/MpInitLib/MpLib.c
> b/UefiCpuPkg/Library/MpInitLib/MpLib.c
> index 6f51bc4ebf..791f5e85ab 100644
> --- a/UefiCpuPkg/Library/MpInitLib/MpLib.c
> +++ b/UefiCpuPkg/Library/MpInitLib/MpLib.c
> @@ -2130,6 +2130,7 @@ MpInitLibGetNumberOfProcessors (
>                                        number.  If FALSE, then all the enabled APs
>                                        execute the function specified by Procedure
>                                        simultaneously.
> +  @param[in]  IncludeBsp              Whether let BSP also trig this task.
>    @param[in]  WaitEvent               The event created by the caller with
> CreateEvent()
>                                        service.
>    @param[in]  TimeoutInMicroseconds   Indicates the time limit in
> microseconds for
> @@ -2154,6 +2155,7 @@ EFI_STATUS
>  StartupAllAPsWorker (
>    IN  EFI_AP_PROCEDURE          Procedure,
>    IN  BOOLEAN                   SingleThread,
> +  IN  BOOLEAN                   IncludeBsp,
>    IN  EFI_EVENT                 WaitEvent               OPTIONAL,
>    IN  UINTN                     TimeoutInMicroseconds,
>    IN  VOID                      *ProcedureArgument      OPTIONAL,
> @@ -2175,7 +2177,7 @@ StartupAllAPsWorker (
>      *FailedCpuList = NULL;
>    }
> 
> -  if (CpuMpData->CpuCount == 1) {
> +  if (CpuMpData->CpuCount == 1 && !IncludeBsp) {
>      return EFI_NOT_STARTED;
>    }
> 
> @@ -2218,9 +2220,9 @@ StartupAllAPsWorker (
>      }
>    }
> 
> -  if (!HasEnabledAp) {
> +  if (!HasEnabledAp && !IncludeBsp) {
>      //
> -    // If no enabled AP exists, return EFI_NOT_STARTED.
> +    // If no enabled AP exists and not include Bsp to do the procedure, return
> EFI_NOT_STARTED.
>      //
>      return EFI_NOT_STARTED;
>    }
> @@ -2266,6 +2268,13 @@ StartupAllAPsWorker (
>      }
>    }
> 
> +  if (IncludeBsp) {
> +    //
> +    // Start BSP.
> +    //
> +    Procedure (ProcedureArgument);
> +  }
> +
>    Status = EFI_SUCCESS;
>    if (WaitEvent == NULL) {
>      do {
> @@ -2411,3 +2420,62 @@ GetCpuMpDataFromGuidedHob (
>    return CpuMpData;
>  }
> 
> +/**
> +  This service executes a caller provided function on all enabled CPUs.
> +
> +  @param[in]  Procedure               A pointer to the function to be run on
> +                                      enabled APs of the system. See type
> +                                      EFI_AP_PROCEDURE.
> +  @param[in]  TimeoutInMicroseconds   Indicates the time limit in
> microseconds for
> +                                      APs to return from Procedure, either for
> +                                      blocking or non-blocking mode. Zero means
> +                                      infinity.
> +  @param[in]  ProcedureArgument       The parameter passed into
> Procedure for
> +                                      all APs.
> +  @param[out] FailedCpuList           If NULL, this parameter is ignored.
> Otherwise,
> +                                      if all APs finish successfully, then its
> +                                      content is set to NULL. If not all APs
> +                                      finish before timeout expires, then its
> +                                      content is set to address of the buffer
> +                                      holding handle numbers of the failed APs.
> +                                      The buffer is allocated by MP Initialization
> +                                      library, and it's the caller's responsibility to
> +                                      free the buffer with FreePool() service.
> +                                      In blocking mode, it is ready for consumption
> +                                      when the call returns. In non-blocking mode,
> +                                      it is ready when WaitEvent is signaled.  The
> +                                      list of failed CPU is terminated by
> +                                      END_OF_CPU_LIST.
> +
> +  @retval EFI_SUCCESS             In blocking mode, all CPUs have finished
> before
> +                                  the timeout expired.
> +  @retval EFI_SUCCESS             In non-blocking mode, function has been
> dispatched
> +                                  to all enabled CPUs.
> +  @retval EFI_DEVICE_ERROR        Caller processor is AP.
> +  @retval EFI_NOT_READY           Any enabled APs are busy.
> +  @retval EFI_NOT_READY           MP Initialize Library is not initialized.
> +  @retval EFI_TIMEOUT             In blocking mode, the timeout expired before
> +                                  all enabled APs have finished.
> +  @retval EFI_INVALID_PARAMETER   Procedure is NULL.
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +MpInitLibStartupAllCPUs (
> +  IN  EFI_AP_PROCEDURE          Procedure,
> +  IN  UINTN                     TimeoutInMicroseconds,
> +  IN  VOID                      *ProcedureArgument      OPTIONAL,
> +  OUT UINTN                     **FailedCpuList         OPTIONAL
> +  )
> +{
> +  return StartupAllAPsWorker (
> +           Procedure,
> +           FALSE,
> +           TRUE,
> +           NULL,
> +           TimeoutInMicroseconds,
> +           ProcedureArgument,
> +           FailedCpuList
> +           );
> +}
> +
> diff --git a/UefiCpuPkg/Library/MpInitLib/MpLib.h
> b/UefiCpuPkg/Library/MpInitLib/MpLib.h
> index f89037c59e..fce7961a98 100644
> --- a/UefiCpuPkg/Library/MpInitLib/MpLib.h
> +++ b/UefiCpuPkg/Library/MpInitLib/MpLib.h
> @@ -405,6 +405,7 @@ InitMpGlobalData (
>                                        number.  If FALSE, then all the enabled APs
>                                        execute the function specified by Procedure
>                                        simultaneously.
> +  @param[in]  IncludeBsp              Whether let BSP also trig this task.
>    @param[in]  WaitEvent               The event created by the caller with
> CreateEvent()
>                                        service.
>    @param[in]  TimeoutInMicroseconds   Indicates the time limit in
> microseconds for
> @@ -429,6 +430,7 @@ EFI_STATUS
>  StartupAllAPsWorker (
>    IN  EFI_AP_PROCEDURE          Procedure,
>    IN  BOOLEAN                   SingleThread,
> +  IN  BOOLEAN                   IncludeBsp,
>    IN  EFI_EVENT                 WaitEvent               OPTIONAL,
>    IN  UINTN                     TimeoutInMicroseconds,
>    IN  VOID                      *ProcedureArgument      OPTIONAL,
> diff --git a/UefiCpuPkg/Library/MpInitLib/PeiMpLib.c
> b/UefiCpuPkg/Library/MpInitLib/PeiMpLib.c
> index 35dff91fd2..a3e568b056 100644
> --- a/UefiCpuPkg/Library/MpInitLib/PeiMpLib.c
> +++ b/UefiCpuPkg/Library/MpInitLib/PeiMpLib.c
> @@ -404,6 +404,7 @@ MpInitLibStartupAllAPs (
>    return StartupAllAPsWorker (
>             Procedure,
>             SingleThread,
> +           FALSE,
>             NULL,
>             TimeoutInMicroseconds,
>             ProcedureArgument,
> --
> 2.21.0.windows.1
> 
> 
>