Hi Jiewen, Changing the name of a library is a non-backwards compatible change from a platform DSC file perspective for downstream consumers.
Whenever any type of non-backwards compatible change is made, we need to highlight that in the commit messages and the Patch #0. The rename is clearly documented in this series. I am only asking that the non-backwards compatible aspect be highlighted along with instructions on what updates to a downstream platform DSC are required. We can work on ways to collect this type of information into a release note format so the changes required to move from one release to the next are clearly documented. Best regards, Mike > -----Original Message----- > From: Yao, Jiewen <jiewen....@intel.com> > Sent: Monday, November 7, 2022 5:28 PM > To: Xu, Min M <min.m...@intel.com>; devel@edk2.groups.io > Cc: Dong, Eric <eric.d...@intel.com>; Ni, Ray <ray...@intel.com>; Brijesh > Singh <brijesh.si...@amd.com>; Aktas, Erdem > <erdemak...@google.com>; Gerd Hoffmann <kra...@redhat.com>; James Bottomley > <j...@linux.ibm.com>; Tom Lendacky > <thomas.lenda...@amd.com>; Dong, Guo <guo.d...@intel.com>; Rhodes, Sean > <sean@starlabs.systems>; Lu, James <james...@intel.com>; > Guo, Gua <gua....@intel.com>; Kinney, Michael D <michael.d.kin...@intel.com>; > Gao, Liming <gaolim...@byosoft.com.cn> > Subject: [edk2-stable202211] [PATCH V4 0/3] Rename VmgExitLib to CcExitLib > > Hi > I suggest we catch this to edk2-stable202211. > > I already give R-B for V3 before soft-freeze. > > The V4 just merges 2 patch into 1, based upon other feedback. > > Thank you > Yao, Jiewen > > > > -----Original Message----- > > From: Xu, Min M <min.m...@intel.com> > > Sent: Tuesday, November 8, 2022 9:15 AM > > To: devel@edk2.groups.io > > Cc: Xu, Min M <min.m...@intel.com>; Dong, Eric <eric.d...@intel.com>; > > Ni, Ray <ray...@intel.com>; Brijesh Singh <brijesh.si...@amd.com>; Aktas, > > Erdem <erdemak...@google.com>; Gerd Hoffmann <kra...@redhat.com>; > > James Bottomley <j...@linux.ibm.com>; Yao, Jiewen > > <jiewen....@intel.com>; Tom Lendacky <thomas.lenda...@amd.com>; > > Dong, Guo <guo.d...@intel.com>; Rhodes, Sean <sean@starlabs.systems>; > > Lu, James <james...@intel.com>; Guo, Gua <gua....@intel.com>; Kinney, > > Michael D <michael.d.kin...@intel.com>; Gao, Liming > > <gaolim...@byosoft.com.cn> > > Subject: [PATCH V4 0/3] Rename VmgExitLib to CcExitLib > > > > BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=4123 > > > > VmgExitLib once was designed to provide interfaces to support #VC handler > > and issue VMGEXIT instruction. After TDVF (enable TDX feature in OVMF) is > > introduced, this library is updated to support #VE as well. Now the name > > of VmgExitLib cannot reflect what the lib does. > > > > This patch-set renames VmgExitLib to CcExitLib (Cc means Confidential > > Computing). This is simple renaming and there is no logic changes. Then > > APIs defined in CcExitLib.h are added with a CcExit prefix. This is to > > make the name more meaningful. > > > > Code: https://github.com/mxu9/edk2/tree/CcExitLib.v4 > > > > v4 changes: > > - The previous versions of the patch-set are to first duplicate a new > > CcExitLib then delete the old VmgExitLib. According to this comments > > https://edk2.groups.io/g/devel/message/96019 it suggests renaming in > > a single patch is better. > > - Lib APIs are added with CcExit prefix, not CcExitLib prefix. > > > > v3 changes: > > - Rename CcExitHandleVc / CcExitHandleVe to > > CcExitLibHandleVc / CcExitLibHandleVe to make the nameing consistent. > > - Update the CcExitLib to merge the patch eff44c008d99 > > (OvmfPkg/VmgExitLig: HALT on #VE when access to private memory). > > > > v2 changes: > > - Patch #3 is added to import CcExitLib in OvmfPkg's *.dsc. This is to > > prevent the building from being broken in the following patches. > > > > Cc: Eric Dong <eric.d...@intel.com> > > Cc: Ray Ni <ray...@intel.com> > > Cc: Brijesh Singh <brijesh.si...@amd.com> > > Cc: Erdem Aktas <erdemak...@google.com> > > Cc: Gerd Hoffmann <kra...@redhat.com> > > Cc: James Bottomley <j...@linux.ibm.com> > > Cc: Jiewen Yao <jiewen....@intel.com> > > Cc: Tom Lendacky <thomas.lenda...@amd.com> > > Cc: Guo Dong <guo.d...@intel.com> > > Cc: Sean Rhodes <sean@starlabs.systems> > > Cc: James Lu <james...@intel.com> > > Cc: Gua Guo <gua....@intel.com> > > Cc: Michael D Kinney <michael.d.kin...@intel.com> > > Cc: Liming Gao <gaolim...@byosoft.com.cn> > > Reviewed-by: Jiewen Yao <jiewen....@intel.com> > > Signed-off-by: Min Xu <min.m...@intel.com> > > > > Min M Xu (3): > > OvmfPkg/UefiCpuPkg/UefiPayloadPkg: Rename VmgExitLib to CcExitLib > > OvmfPkg/UefiCpuPkg: Add CcExit prefix to the APIs of CcExitLib > > Maintainers: Update the VmgExitLib to CcExitLib > > > > Maintainers.txt | 2 +- > > OvmfPkg/AmdSev/AmdSevX64.dsc | 4 +- > > OvmfPkg/Bhyve/BhyveX64.dsc | 2 +- > > OvmfPkg/CloudHv/CloudHvX64.dsc | 6 +- > > OvmfPkg/IntelTdx/IntelTdxX64.dsc | 4 +- > > .../DxeMemEncryptSevLib.inf | 2 +- > > .../PeiMemEncryptSevLib.inf | 2 +- > > .../SecMemEncryptSevLib.inf | 2 +- > > .../X64/SnpPageStateChangeInternal.c | 10 +- > > .../VmgExitLib.c => CcExitLib/CcExitLib.c} | 23 ++-- > > .../CcExitLib.inf} | 17 +-- > > .../CcExitTd.h} | 4 +- > > .../CcExitVcHandler.c} | 129 +++++++++--------- > > .../CcExitVcHandler.h} | 6 +- > > .../CcExitVeHandler.c} | 6 +- > > .../PeiDxeCcExitVcHandler.c} | 6 +- > > .../SecCcExitLib.inf} | 14 +- > > .../SecCcExitVcHandler.c} | 6 +- > > .../X64/TdVmcallCpuid.nasm | 0 > > OvmfPkg/Microvm/MicrovmX64.dsc | 4 +- > > OvmfPkg/OvmfPkgIa32.dsc | 4 +- > > OvmfPkg/OvmfPkgIa32X64.dsc | 4 +- > > OvmfPkg/OvmfPkgX64.dsc | 6 +- > > OvmfPkg/OvmfXen.dsc | 2 +- > > OvmfPkg/PlatformPei/AmdSev.c | 10 +- > > OvmfPkg/PlatformPei/PlatformPei.inf | 2 +- > > .../FvbServicesRuntimeDxe.inf | 2 +- > > .../QemuFlashDxe.c | 10 +- > > .../Library/{VmgExitLib.h => CcExitLib.h} | 29 ++-- > > .../CcExitLibNull.c} | 47 +++++-- > > .../CcExitLibNull.inf} | 12 +- > > .../Library/CcExitLibNull/CcExitLibNull.uni | 14 ++ > > .../DxeCpuExceptionHandlerLib.inf | 2 +- > > .../PeiCpuExceptionHandlerLib.inf | 2 +- > > .../PeiDxeSmmCpuException.c | 6 +- > > .../SecPeiCpuException.c | 6 +- > > .../SecPeiCpuExceptionHandlerLib.inf | 2 +- > > .../SmmCpuExceptionHandlerLib.inf | 2 +- > > .../Xcode5SecPeiCpuExceptionHandlerLib.inf | 2 +- > > UefiCpuPkg/Library/MpInitLib/AmdSev.c | 10 +- > > UefiCpuPkg/Library/MpInitLib/DxeMpInitLib.inf | 2 +- > > UefiCpuPkg/Library/MpInitLib/DxeMpLib.c | 8 +- > > UefiCpuPkg/Library/MpInitLib/MpLib.c | 2 +- > > UefiCpuPkg/Library/MpInitLib/PeiMpInitLib.inf | 2 +- > > UefiCpuPkg/Library/MpInitLib/X64/AmdSev.c | 10 +- > > .../Library/VmgExitLibNull/VmTdExitNull.c | 38 ------ > > .../Library/VmgExitLibNull/VmgExitLibNull.uni | 15 -- > > UefiCpuPkg/UefiCpuPkg.dec | 4 +- > > UefiCpuPkg/UefiCpuPkg.dsc | 4 +- > > UefiPayloadPkg/UefiPayloadPkg.dsc | 2 +- > > 50 files changed, 252 insertions(+), 258 deletions(-) > > rename OvmfPkg/Library/{VmgExitLib/VmgExitLib.c => CcExitLib/CcExitLib.c} > > (89%) > > rename OvmfPkg/Library/{VmgExitLib/VmgExitLib.inf => > > CcExitLib/CcExitLib.inf} (66%) > > rename OvmfPkg/Library/{VmgExitLib/VmTdExitHandler.h => > > CcExitLib/CcExitTd.h} (86%) > > rename OvmfPkg/Library/{VmgExitLib/VmgExitVcHandler.c => > > CcExitLib/CcExitVcHandler.c} (90%) > > rename OvmfPkg/Library/{VmgExitLib/VmgExitVcHandler.h => > > CcExitLib/CcExitVcHandler.h} (89%) > > rename OvmfPkg/Library/{VmgExitLib/VmTdExitVeHandler.c => > > CcExitLib/CcExitVeHandler.c} (95%) > > rename OvmfPkg/Library/{VmgExitLib/PeiDxeVmgExitVcHandler.c => > > CcExitLib/PeiDxeCcExitVcHandler.c} (93%) > > rename OvmfPkg/Library/{VmgExitLib/SecVmgExitLib.inf => > > CcExitLib/SecCcExitLib.inf} (79%) > > rename OvmfPkg/Library/{VmgExitLib/SecVmgExitVcHandler.c => > > CcExitLib/SecCcExitVcHandler.c} (93%) > > rename OvmfPkg/Library/{VmgExitLib => > > CcExitLib}/X64/TdVmcallCpuid.nasm (100%) > > rename UefiCpuPkg/Include/Library/{VmgExitLib.h => CcExitLib.h} (87%) > > rename UefiCpuPkg/Library/{VmgExitLibNull/VmgExitLibNull.c => > > CcExitLibNull/CcExitLibNull.c} (76%) > > rename UefiCpuPkg/Library/{VmgExitLibNull/VmgExitLibNull.inf => > > CcExitLibNull/CcExitLibNull.inf} (60%) > > create mode 100644 UefiCpuPkg/Library/CcExitLibNull/CcExitLibNull.uni > > delete mode 100644 UefiCpuPkg/Library/VmgExitLibNull/VmTdExitNull.c > > delete mode 100644 > > UefiCpuPkg/Library/VmgExitLibNull/VmgExitLibNull.uni > > > > -- > > 2.29.2.windows.2 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#96198): https://edk2.groups.io/g/devel/message/96198 Mute This Topic: https://groups.io/mt/94881988/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
