Re: [PATCH v3 1/3] UnitTestFrameworkPkg : BaseTimerLibPosix: Adds a host-based timer Lib

["Michael D Kinney" <michael.d.kinney@intel.com>]

Matt,

Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com> 

Mike

> -----Original Message-----
> From: matthewfcarlson@gmail.com
> <matthewfcarlson@gmail.com>
> Sent: Tuesday, July 14, 2020 11:23 AM
> To: devel@edk2.groups.io
> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Sean
> Brogan <sean.brogan@microsoft.com>; Bret Barkelew
> <Bret.Barkelew@microsoft.com>
> Subject: [PATCH v3 1/3] UnitTestFrameworkPkg :
> BaseTimerLibPosix: Adds a host-based timer Lib
> 
> From: Matthew Carlson <macarl@microsoft.com>
> 
> This adds a host based BaseTimerLib that won't assert.
> 
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
> Signed-off-by: Matthew Carlson
> <matthewfcarlson@gmail.com>
> ---
> 
> UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/Tim
> erLibPosix.c       | 132 ++++++++++++++++++++
> 
> UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/Bas
> eTimerLibPosix.inf |  33 +++++
> 
> UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/Bas
> eTimerLibPosix.uni |  14 +++
> 
> UnitTestFrameworkPkg/Test/UnitTestFrameworkPkgHostTest.d
> sc                 |   1 +
>  UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc
> |   1 +
>  5 files changed, 181 insertions(+)
> 
> diff --git
> a/UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/T
> imerLibPosix.c
> b/UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/T
> imerLibPosix.c
> new file mode 100644
> index 000000000000..3c1394e3b21b
> --- /dev/null
> +++
> b/UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/T
> imerLibPosix.c
> @@ -0,0 +1,132 @@
> +/** @file
> 
> +  A semi-functional instance of the Timer Library.
> 
> +
> 
> +  Copyright (c) Microsoft Corporation.
> 
> +
> 
> +  SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> +
> 
> +**/
> 
> +
> 
> +#include <Base.h>
> 
> +#include <Library/TimerLib.h>
> 
> +#include <Library/DebugLib.h>
> 
> +#include <stdio.h>
> 
> +#include <stdlib.h>
> 
> +#include <time.h>
> 
> +
> 
> +/**
> 
> +  Stalls the CPU for at least the given number of
> microseconds.
> 
> +
> 
> +  @param  MicroSeconds  The minimum number of
> microseconds to delay.
> 
> +  @return The value of MicroSeconds inputted.
> 
> +
> 
> +**/
> 
> +UINTN
> 
> +EFIAPI
> 
> +MicroSecondDelay (
> 
> +  IN      UINTN                     MicroSeconds
> 
> +  )
> 
> +{
> 
> +  // Since this is a host based test, we don't actually
> want to stall
> 
> +  return MicroSeconds;
> 
> +}
> 
> +
> 
> +/**
> 
> +  Stalls the CPU for at least the given number of
> nanoseconds.
> 
> +
> 
> +  @param  NanoSeconds The minimum number of nanoseconds
> to delay.
> 
> +  @return The value of NanoSeconds inputted.
> 
> +
> 
> +**/
> 
> +UINTN
> 
> +EFIAPI
> 
> +NanoSecondDelay (
> 
> +  IN      UINTN                     NanoSeconds
> 
> +  )
> 
> +{
> 
> +  // Since this is a host based test, we don't actually
> want to stall
> 
> +  return NanoSeconds;
> 
> +}
> 
> +
> 
> +/**
> 
> +  Retrieves the current value of a 64-bit free running
> performance counter.
> 
> +
> 
> +  The counter can either count up by 1 or count down by
> 1. If the physical
> 
> +  performance counter counts by a larger increment,
> then the counter values
> 
> +  must be translated. The properties of the counter can
> be retrieved from
> 
> +  GetPerformanceCounterProperties().
> 
> +
> 
> +  @return The current value of the free running
> performance counter.
> 
> +
> 
> +**/
> 
> +UINT64
> 
> +EFIAPI
> 
> +GetPerformanceCounter (
> 
> +  VOID
> 
> +  )
> 
> +{
> 
> +  struct timespec ts;
> 
> +  timespec_get(&ts, TIME_UTC);
> 
> +  // Return the current number of nanoseconds on the
> clock
> 
> +  return ts.tv_nsec;
> 
> +}
> 
> +
> 
> +/**
> 
> +  Retrieves the 64-bit frequency in Hz and the range of
> performance counter
> 
> +  values.
> 
> +
> 
> +  If StartValue is not NULL, then the value that the
> performance counter starts
> 
> +  with immediately after is it rolls over is returned
> in StartValue. If
> 
> +  EndValue is not NULL, then the value that the
> performance counter end with
> 
> +  immediately before it rolls over is returned in
> EndValue. The 64-bit
> 
> +  frequency of the performance counter in Hz is always
> returned. If StartValue
> 
> +  is less than EndValue, then the performance counter
> counts up. If StartValue
> 
> +  is greater than EndValue, then the performance
> counter counts down. For
> 
> +  example, a 64-bit free running counter that counts up
> would have a StartValue
> 
> +  of 0 and an EndValue of 0xFFFFFFFFFFFFFFFF. A 24-bit
> free running counter
> 
> +  that counts down would have a StartValue of 0xFFFFFF
> and an EndValue of 0.
> 
> +
> 
> +  @param  StartValue  The value the performance counter
> starts with when it
> 
> +                      rolls over.
> 
> +  @param  EndValue    The value that the performance
> counter ends with before
> 
> +                      it rolls over.
> 
> +
> 
> +  @return The frequency in Hz.
> 
> +
> 
> +**/
> 
> +UINT64
> 
> +EFIAPI
> 
> +GetPerformanceCounterProperties (
> 
> +  OUT      UINT64                    *StartValue,
> OPTIONAL
> 
> +  OUT      UINT64                    *EndValue
> OPTIONAL
> 
> +  )
> 
> +{
> 
> +  if ( EndValue != NULL ) {
> 
> +    *EndValue = MAX_UINT64;
> 
> +  }
> 
> +  if ( StartValue != NULL ) {
> 
> +    *StartValue = 0;
> 
> +  }
> 
> +  // Return the number of nanoseconds in a second
> 
> +  return 1000000000;
> 
> +}
> 
> +
> 
> +/**
> 
> +  Converts elapsed ticks of performance counter to time
> in nanoseconds.
> 
> +
> 
> +  This function converts the elapsed ticks of running
> performance counter to
> 
> +  time value in unit of nanoseconds.
> 
> +
> 
> +  @param  Ticks     The number of elapsed ticks of
> running performance counter.
> 
> +
> 
> +  @return The elapsed time in nanoseconds.
> 
> +
> 
> +**/
> 
> +UINT64
> 
> +EFIAPI
> 
> +GetTimeInNanoSecond (
> 
> +  IN      UINT64                     Ticks
> 
> +  )
> 
> +{
> 
> +  return Ticks;
> 
> +}
> 
> diff --git
> a/UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/B
> aseTimerLibPosix.inf
> b/UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/B
> aseTimerLibPosix.inf
> new file mode 100644
> index 000000000000..797f04bb125b
> --- /dev/null
> +++
> b/UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/B
> aseTimerLibPosix.inf
> @@ -0,0 +1,33 @@
> +## @file
> 
> +#  An instance of Timer Library for posix compliant
> hosts.
> 
> +#
> 
> +#  A semi-functional instance of the Timer Library that
> can be used for
> 
> +#  host based testing as a functional timer library
> instance.
> 
> +#
> 
> +#  Copyright (c) Microsoft Corporation.
> 
> +#
> 
> +#  SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> +#
> 
> +#
> 
> +##
> 
> +
> 
> +[Defines]
> 
> +  INF_VERSION                    = 0x00010005
> 
> +  BASE_NAME                      = BaseTimerLibPosix
> 
> +  MODULE_UNI_FILE                =
> BaseTimerLibPosix.uni
> 
> +  FILE_GUID                      = a2a413b8-43c3-40cc-
> a298-be7a214d3564
> 
> +  MODULE_TYPE                    = BASE
> 
> +  VERSION_STRING                 = 1.0
> 
> +  LIBRARY_CLASS                  =
> TimerLib|HOST_APPLICATION
> 
> +#
> 
> +#  VALID_ARCHITECTURES           = HOST
> 
> +#
> 
> +
> 
> +[Sources]
> 
> +  TimerLibPosix.c
> 
> +
> 
> +[Packages]
> 
> +  MdePkg/MdePkg.dec
> 
> +
> 
> +[LibraryClasses]
> 
> +  DebugLib
> 
> diff --git
> a/UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/B
> aseTimerLibPosix.uni
> b/UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/B
> aseTimerLibPosix.uni
> new file mode 100644
> index 000000000000..a6859a0fc88a
> --- /dev/null
> +++
> b/UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/B
> aseTimerLibPosix.uni
> @@ -0,0 +1,14 @@
> +// @file
> 
> +// An instance of Timer Library for posix compliant
> hosts.
> 
> +//
> 
> +// A semi-functional instance of the Timer Library that
> can be used
> 
> +// for host based unit tests on posix compliant
> machines.
> 
> +//
> 
> +// Copyright (c) Microsoft Corporation.
> 
> +//
> 
> +// SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> +//
> 
> +
> 
> +#string STR_MODULE_ABSTRACT             #language en-US
> "Host instance of Timer Library"
> 
> +
> 
> +#string STR_MODULE_DESCRIPTION          #language en-US
> "An instance of the Timer Library that can be used for
> host based unit tests."
> 
> diff --git
> a/UnitTestFrameworkPkg/Test/UnitTestFrameworkPkgHostTest
> .dsc
> b/UnitTestFrameworkPkg/Test/UnitTestFrameworkPkgHostTest
> .dsc
> index 701e7299d767..f82b3b7a323e 100644
> ---
> a/UnitTestFrameworkPkg/Test/UnitTestFrameworkPkgHostTest
> .dsc
> +++
> b/UnitTestFrameworkPkg/Test/UnitTestFrameworkPkgHostTest
> .dsc
> @@ -30,4 +30,5 @@
>    UnitTestFrameworkPkg/Library/CmockaLib/CmockaLib.inf
> 
> 
> UnitTestFrameworkPkg/Library/Posix/DebugLibPosix/DebugLi
> bPosix.inf
> 
> 
> UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPo
> six/MemoryAllocationLibPosix.inf
> 
> +
> UnitTestFrameworkPkg/Library/Posix/BaseTimerLibPosix/Bas
> eTimerLibPosix.inf
> 
> 
> UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLibCmoc
> ka.inf
> 
> diff --git
> a/UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc
> b/UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc
> index e954968efc52..76f0a719ded3 100644
> ---
> a/UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc
> +++
> b/UnitTestFrameworkPkg/UnitTestFrameworkPkgHost.dsc.inc
> @@ -13,6 +13,7 @@
> 
> UnitTestLib|UnitTestFrameworkPkg/Library/UnitTestLib/Uni
> tTestLibCmocka.inf
> 
> 
> DebugLib|UnitTestFrameworkPkg/Library/Posix/DebugLibPosi
> x/DebugLibPosix.inf
> 
> 
> MemoryAllocationLib|UnitTestFrameworkPkg/Library/Posix/M
> emoryAllocationLibPosix/MemoryAllocationLibPosix.inf
> 
> +
> TimerLib|UnitTestFrameworkPkg/Library/Posix/BaseTimerLib
> Posix/BaseTimerLibPosix.inf
> 
> 
> 
>  [BuildOptions]
> 
>    GCC:*_*_*_CC_FLAGS = -fno-pie
> 
> --
> 2.27.0.windows.1