From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by mx.groups.io with SMTP id smtpd.web11.4179.1617783395523757436 for ; Wed, 07 Apr 2021 01:16:35 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 134.134.136.65, mailfrom: yun.lou@intel.com) IronPort-SDR: NnJ006bWBNx42aKuD1qgvrQrVu49CKQCH0FkF9wSMXJ90Ti8KTY6xVDhoQ0XZGo4xk0iuHkGC+ SVhLnFqDjHfg== X-IronPort-AV: E=McAfee;i="6000,8403,9946"; a="193296792" X-IronPort-AV: E=Sophos;i="5.82,203,1613462400"; d="scan'208";a="193296792" Received: from orsmga001.jf.intel.com ([10.7.209.18]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 07 Apr 2021 01:16:33 -0700 IronPort-SDR: JTgduepcbeV2uVQXSOWwXRBUrg4HrbAiz8+AphVnJrh10jb6/hjPfuCR234gQ1853N0/T66sNg /pV0HRUBX5jQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.82,203,1613462400"; d="scan'208";a="458260157" Received: from shwdeopenlab102.ccr.corp.intel.com ([10.239.183.74]) by orsmga001.jf.intel.com with ESMTP; 07 Apr 2021 01:16:31 -0700 From: "Jason Lou" To: devel@edk2.groups.io Cc: Jason Lou , Ray Ni , Eric Dong , Laszlo Ersek , Rahul Kumar Subject: [PATCH v2] UefiCpuPkg: Remove PEI/DXE instances of CpuTimerLib. Date: Wed, 7 Apr 2021 16:16:25 +0800 Message-Id: <20210407081625.14254-1-yun.lou@intel.com> X-Mailer: git-send-email 2.28.0.windows.1 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Jason Lou REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3D2832 1. Remove PEI instance(PeiCpuTimerLib). PeiCpuTimerLib is currently designed to save time by getting CPU TSC frequency from Hob. BaseCpuTimerLib is designed to calculate TSC frequency by using CPUID[15h] each time. The time it takes to find CpuCrystalFrequencyHob (about 2000ns) is much longer than it takes to calculate TSC frequency with CPUID[15h] (about 450ns), which means using BaseCpuTimerLib to trigger a delay is more accurate than using PeiCpuTimerLib, recommend to use BaseCpuTimerLib instead of PeiCpuTimerLib. 2. Remove DXE instance(DxeCpuTimerLib). DxeCpuTimerLib is designed to calculate TSC frequency with CPUID[15h] in its constructor function, then save it in a global variable. For this design, once the driver containing this instance is running, this constructor function is called, it will take extra time to calculate TSC frequency. The time it takes to get TSC frequency from global variable is shorter than it takes to calculate TSC frequency with CPUID[15h], but 450ns is a short time, the impact on the platform is very limited. In addition, in order to simplify the code, recommend to use BaseCpuTimerLib instead of DxeCpuTimerLib. I did some experiments on one server platform and collected following data: 1. Average time required to find CpuCrystalFrequencyHob: about 2000 ns. 2. Average time required to find the last Hob: about 2700 ns. 2. Average time required to calculate TSC frequency: about 450 ns. Reference code: // // Calculate average time required to find Hob. // DEBUG((DEBUG_ERROR, "[PeiCpuTimerLib] GetPerformanceCounterFrequency - = GetFirstGuidHob (1000 cycles)\n")); Ticks1 =3D AsmReadTsc(); for (i =3D 0; i < 1000; i++) { GuidHob =3D GetFirstGuidHob (&mCpuCrystalFrequencyHobGuid); } Ticks2 =3D AsmReadTsc(); if (GuidHob =3D=3D NULL) { DEBUG((DEBUG_ERROR, "[PeiCpuTimerLib] - CpuCrystalFrequencyHob can n= ot be found!\n")); } else { DEBUG((DEBUG_ERROR, "[PeiCpuTimerLib] - Average time required to fin= d Hob =3D %d ns\n", \ DivU64x32(DivU64x64Remainder(MultU64x32((Ticks2 - Ticks1), 100000= 0000), *CpuCrystalCounterFrequency, NULL), 1000))); } // // Calculate average time required to calculate CPU frequency. // DEBUG((DEBUG_ERROR, "[PeiCpuTimerLib] GetPerformanceCounterFrequency - = CpuidCoreClockCalculateTscFrequency (1000 cycles)\n")); Ticks1 =3D AsmReadTsc(); for (i =3D 0; i < 1000; i++) { Freq =3D CpuidCoreClockCalculateTscFrequency (); } Ticks2 =3D AsmReadTsc(); DEBUG((DEBUG_ERROR, "[PeiCpuTimerLib] - Average time required to calcu= late TSC frequency =3D %d ns\n", \ DivU64x32(DivU64x64Remainder(MultU64x32((Ticks2 - Ticks1), 10000000= 00), *CpuCrystalCounterFrequency, NULL), 1000))); Signed-off-by: Jason Lou Cc: Ray Ni Cc: Eric Dong Cc: Laszlo Ersek Cc: Rahul Kumar --- UefiCpuPkg/Library/CpuTimerLib/DxeCpuTimerLib.c | 85 -------------------- UefiCpuPkg/Library/CpuTimerLib/PeiCpuTimerLib.c | 58 ------------- UefiCpuPkg/Library/CpuTimerLib/DxeCpuTimerLib.inf | 37 --------- UefiCpuPkg/Library/CpuTimerLib/DxeCpuTimerLib.uni | 17 ---- UefiCpuPkg/Library/CpuTimerLib/PeiCpuTimerLib.inf | 36 --------- UefiCpuPkg/Library/CpuTimerLib/PeiCpuTimerLib.uni | 17 ---- UefiCpuPkg/UefiCpuPkg.dsc | 2 - 7 files changed, 252 deletions(-) diff --git a/UefiCpuPkg/Library/CpuTimerLib/DxeCpuTimerLib.c b/UefiCpuPkg/L= ibrary/CpuTimerLib/DxeCpuTimerLib.c deleted file mode 100644 index 269e5a3e83..0000000000 --- a/UefiCpuPkg/Library/CpuTimerLib/DxeCpuTimerLib.c +++ /dev/null @@ -1,85 +0,0 @@ -/** @file=0D - CPUID Leaf 0x15 for Core Crystal Clock frequency instance of Timer Libra= ry.=0D -=0D - Copyright (c) 2019 Intel Corporation. All rights reserved.
=0D - SPDX-License-Identifier: BSD-2-Clause-Patent=0D -=0D -**/=0D -=0D -#include =0D -#include =0D -#include =0D -#include =0D -=0D -extern GUID mCpuCrystalFrequencyHobGuid;=0D -=0D -/**=0D - CPUID Leaf 0x15 for Core Crystal Clock Frequency.=0D -=0D - The TSC counting frequency is determined by using CPUID leaf 0x15. Frequ= ency in MHz =3D Core XTAL frequency * EBX/EAX.=0D - In newer flavors of the CPU, core xtal frequency is returned in ECX or 0= if not supported.=0D - @return The number of TSC counts per second.=0D -=0D -**/=0D -UINT64=0D -CpuidCoreClockCalculateTscFrequency (=0D - VOID=0D - );=0D -=0D -//=0D -// Cached CPU Crystal counter frequency=0D -//=0D -UINT64 mCpuCrystalCounterFrequency =3D 0;=0D -=0D -=0D -/**=0D - Internal function to retrieves the 64-bit frequency in Hz.=0D -=0D - Internal function to retrieves the 64-bit frequency in Hz.=0D -=0D - @return The frequency in Hz.=0D -=0D -**/=0D -UINT64=0D -InternalGetPerformanceCounterFrequency (=0D - VOID=0D - )=0D -{=0D - return mCpuCrystalCounterFrequency;=0D -}=0D -=0D -/**=0D - The constructor function is to initialize CpuCrystalCounterFrequency.=0D -=0D - @param ImageHandle The firmware allocated handle for the EFI image.=0D - @param SystemTable A pointer to the EFI System Table.=0D -=0D - @retval EFI_SUCCESS The constructor always returns RETURN_SUCCESS.=0D -=0D -**/=0D -EFI_STATUS=0D -EFIAPI=0D -DxeCpuTimerLibConstructor (=0D - IN EFI_HANDLE ImageHandle,=0D - IN EFI_SYSTEM_TABLE *SystemTable=0D - )=0D -{=0D - EFI_HOB_GUID_TYPE *GuidHob;=0D -=0D - //=0D - // Initialize CpuCrystalCounterFrequency=0D - //=0D - GuidHob =3D GetFirstGuidHob (&mCpuCrystalFrequencyHobGuid);=0D - if (GuidHob !=3D NULL) {=0D - mCpuCrystalCounterFrequency =3D *(UINT64*)GET_GUID_HOB_DATA (GuidHob);= =0D - } else {=0D - mCpuCrystalCounterFrequency =3D CpuidCoreClockCalculateTscFrequency ()= ;=0D - }=0D -=0D - if (mCpuCrystalCounterFrequency =3D=3D 0) {=0D - return EFI_UNSUPPORTED;=0D - }=0D -=0D - return EFI_SUCCESS;=0D -}=0D -=0D diff --git a/UefiCpuPkg/Library/CpuTimerLib/PeiCpuTimerLib.c b/UefiCpuPkg/L= ibrary/CpuTimerLib/PeiCpuTimerLib.c deleted file mode 100644 index 91a7212056..0000000000 --- a/UefiCpuPkg/Library/CpuTimerLib/PeiCpuTimerLib.c +++ /dev/null @@ -1,58 +0,0 @@ -/** @file=0D - CPUID Leaf 0x15 for Core Crystal Clock frequency instance as PEI Timer L= ibrary.=0D -=0D - Copyright (c) 2019 Intel Corporation. All rights reserved.
=0D - SPDX-License-Identifier: BSD-2-Clause-Patent=0D -=0D -**/=0D -=0D -#include =0D -#include =0D -#include =0D -#include =0D -#include =0D -=0D -extern GUID mCpuCrystalFrequencyHobGuid;=0D -=0D -/**=0D - CPUID Leaf 0x15 for Core Crystal Clock Frequency.=0D -=0D - The TSC counting frequency is determined by using CPUID leaf 0x15. Frequ= ency in MHz =3D Core XTAL frequency * EBX/EAX.=0D - In newer flavors of the CPU, core xtal frequency is returned in ECX or 0= if not supported.=0D - @return The number of TSC counts per second.=0D -=0D -**/=0D -UINT64=0D -CpuidCoreClockCalculateTscFrequency (=0D - VOID=0D - );=0D -=0D -/**=0D - Internal function to retrieves the 64-bit frequency in Hz.=0D -=0D - Internal function to retrieves the 64-bit frequency in Hz.=0D -=0D - @return The frequency in Hz.=0D -=0D -**/=0D -UINT64=0D -InternalGetPerformanceCounterFrequency (=0D - VOID=0D - )=0D -{=0D - UINT64 *CpuCrystalCounterFrequency;=0D - EFI_HOB_GUID_TYPE *GuidHob;=0D -=0D - CpuCrystalCounterFrequency =3D NULL;=0D - GuidHob =3D GetFirstGuidHob (&mCpuCrystalFrequencyHobGuid);=0D - if (GuidHob =3D=3D NULL) {=0D - CpuCrystalCounterFrequency =3D (UINT64*)BuildGuidHob(&mCpuCrystalFreq= uencyHobGuid, sizeof (*CpuCrystalCounterFrequency));=0D - ASSERT (CpuCrystalCounterFrequency !=3D NULL);=0D - *CpuCrystalCounterFrequency =3D CpuidCoreClockCalculateTscFrequency ()= ;=0D - } else {=0D - CpuCrystalCounterFrequency =3D (UINT64*)GET_GUID_HOB_DATA (GuidHob);=0D - }=0D -=0D - return *CpuCrystalCounterFrequency;=0D -}=0D -=0D diff --git a/UefiCpuPkg/Library/CpuTimerLib/DxeCpuTimerLib.inf b/UefiCpuPkg= /Library/CpuTimerLib/DxeCpuTimerLib.inf deleted file mode 100644 index 6c83549c87..0000000000 --- a/UefiCpuPkg/Library/CpuTimerLib/DxeCpuTimerLib.inf +++ /dev/null @@ -1,37 +0,0 @@ -## @file=0D -# DXE CPU Timer Library=0D -#=0D -# Provides basic timer support using CPUID Leaf 0x15 XTAL frequency. The = performance=0D -# counter features are provided by the processors time stamp counter.=0D -#=0D -# Copyright (c) 2019, Intel Corporation. All rights reserved.
=0D -# SPDX-License-Identifier: BSD-2-Clause-Patent=0D -#=0D -##=0D -=0D -[Defines]=0D - INF_VERSION =3D 0x00010005=0D - BASE_NAME =3D DxeCpuTimerLib=0D - FILE_GUID =3D F22CC0DA-E7DB-4E4D-ABE2-A608188233A2= =0D - MODULE_TYPE =3D DXE_DRIVER=0D - VERSION_STRING =3D 1.0=0D - LIBRARY_CLASS =3D TimerLib|DXE_CORE DXE_DRIVER DXE_RUNT= IME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER SMM_CORE=0D - CONSTRUCTOR =3D DxeCpuTimerLibConstructor=0D - MODULE_UNI_FILE =3D DxeCpuTimerLib.uni=0D -=0D -[Sources]=0D - CpuTimerLib.c=0D - DxeCpuTimerLib.c=0D -=0D -[Packages]=0D - MdePkg/MdePkg.dec=0D - UefiCpuPkg/UefiCpuPkg.dec=0D -=0D -[LibraryClasses]=0D - BaseLib=0D - PcdLib=0D - DebugLib=0D - HobLib=0D -=0D -[Pcd]=0D - gUefiCpuPkgTokenSpaceGuid.PcdCpuCoreCrystalClockFrequency ## CONSUMES=0D diff --git a/UefiCpuPkg/Library/CpuTimerLib/DxeCpuTimerLib.uni b/UefiCpuPkg= /Library/CpuTimerLib/DxeCpuTimerLib.uni deleted file mode 100644 index f55b92abac..0000000000 --- a/UefiCpuPkg/Library/CpuTimerLib/DxeCpuTimerLib.uni +++ /dev/null @@ -1,17 +0,0 @@ -// /** @file=0D -// DXE CPU Timer Library=0D -//=0D -// Provides basic timer support using CPUID Leaf 0x15 XTAL frequency. The= performance=0D -// counter features are provided by the processors time stamp counter.=0D -//=0D -// Copyright (c) 2019, Intel Corporation. All rights reserved.
=0D -//=0D -// SPDX-License-Identifier: BSD-2-Clause-Patent=0D -//=0D -// **/=0D -=0D -=0D -#string STR_MODULE_ABSTRACT #language en-US "CPU Timer Library= "=0D -=0D -#string STR_MODULE_DESCRIPTION #language en-US "Provides basic ti= mer support using CPUID Leaf 0x15 XTAL frequency."=0D -=0D diff --git a/UefiCpuPkg/Library/CpuTimerLib/PeiCpuTimerLib.inf b/UefiCpuPkg= /Library/CpuTimerLib/PeiCpuTimerLib.inf deleted file mode 100644 index 7af0fc44a6..0000000000 --- a/UefiCpuPkg/Library/CpuTimerLib/PeiCpuTimerLib.inf +++ /dev/null @@ -1,36 +0,0 @@ -## @file=0D -# PEI CPU Timer Library=0D -#=0D -# Provides basic timer support using CPUID Leaf 0x15 XTAL frequency. The = performance=0D -# counter features are provided by the processors time stamp counter.=0D -#=0D -# Copyright (c) 2019, Intel Corporation. All rights reserved.
=0D -# SPDX-License-Identifier: BSD-2-Clause-Patent=0D -#=0D -##=0D -=0D -[Defines]=0D - INF_VERSION =3D 0x00010005=0D - BASE_NAME =3D PeiCpuTimerLib=0D - FILE_GUID =3D 2B13DE00-1A5F-4DD7-A298-01B08AF1015A= =0D - MODULE_TYPE =3D BASE=0D - VERSION_STRING =3D 1.0=0D - LIBRARY_CLASS =3D TimerLib|PEI_CORE PEIM=0D - MODULE_UNI_FILE =3D PeiCpuTimerLib.uni=0D -=0D -[Sources]=0D - CpuTimerLib.c=0D - PeiCpuTimerLib.c=0D -=0D -[Packages]=0D - MdePkg/MdePkg.dec=0D - UefiCpuPkg/UefiCpuPkg.dec=0D -=0D -[LibraryClasses]=0D - BaseLib=0D - PcdLib=0D - DebugLib=0D - HobLib=0D -=0D -[Pcd]=0D - gUefiCpuPkgTokenSpaceGuid.PcdCpuCoreCrystalClockFrequency ## CONSUMES=0D diff --git a/UefiCpuPkg/Library/CpuTimerLib/PeiCpuTimerLib.uni b/UefiCpuPkg= /Library/CpuTimerLib/PeiCpuTimerLib.uni deleted file mode 100644 index 49beb44908..0000000000 --- a/UefiCpuPkg/Library/CpuTimerLib/PeiCpuTimerLib.uni +++ /dev/null @@ -1,17 +0,0 @@ -// /** @file=0D -// PEI CPU Timer Library=0D -//=0D -// Provides basic timer support using CPUID Leaf 0x15 XTAL frequency. The= performance=0D -// counter features are provided by the processors time stamp counter.=0D -//=0D -// Copyright (c) 2019, Intel Corporation. All rights reserved.
=0D -//=0D -// SPDX-License-Identifier: BSD-2-Clause-Patent=0D -//=0D -// **/=0D -=0D -=0D -#string STR_MODULE_ABSTRACT #language en-US "CPU Timer Library= "=0D -=0D -#string STR_MODULE_DESCRIPTION #language en-US "Provides basic ti= mer support using CPUID Leaf 0x15 XTAL frequency."=0D -=0D diff --git a/UefiCpuPkg/UefiCpuPkg.dsc b/UefiCpuPkg/UefiCpuPkg.dsc index 98c4c53465..c16cf8d1b9 100644 --- a/UefiCpuPkg/UefiCpuPkg.dsc +++ b/UefiCpuPkg/UefiCpuPkg.dsc @@ -116,8 +116,6 @@ UefiCpuPkg/Library/SecPeiDxeTimerLibUefiCpu/SecPeiDxeTimerLibUefiCpu.inf= =0D UefiCpuPkg/Application/Cpuid/Cpuid.inf=0D UefiCpuPkg/Library/CpuTimerLib/BaseCpuTimerLib.inf=0D - UefiCpuPkg/Library/CpuTimerLib/DxeCpuTimerLib.inf=0D - UefiCpuPkg/Library/CpuTimerLib/PeiCpuTimerLib.inf=0D UefiCpuPkg/Library/CpuCacheInfoLib/PeiCpuCacheInfoLib.inf=0D UefiCpuPkg/Library/CpuCacheInfoLib/DxeCpuCacheInfoLib.inf=0D =0D --=20 2.28.0.windows.1