Re: [edk2-devel] [PATCH v4 00/14] Add ImagePropertiesRecordLib and Fix MAT Bugs

["Taylor Beebe" <taylor.d.beebe@gmail.com>]

Reviews on this patch series would be much appreciated :)

On 8/28/23 9:38 AM, Ard Biesheuvel wrote:
> I was hoping to get around to this before the end of the week (but I
> am not a MdeModulePkg maintainer)
>
>
> On Mon, 28 Aug 2023 at 18:27, Taylor Beebe <taylor.d.beebe@gmail.com> wrote:
>> Can I please get reviews/feedback on this patch series?
>>
>> On 8/16/23 11:14 AM, Taylor Beebe via groups.io wrote:
>>> Can I please get reviews/feedback on this patch series?
>>>
>>> On 8/4/2023 12:46 PM, Taylor Beebe via groups.io wrote:
>>>> From: Taylor Beebe <taylor.d.beebe@gmail.com>
>>>>
>>>> v4:
>>>> - Expose additional functions in the Library API
>>>> - Add NULL checks to library functions and return a
>>>>     status where applicable.
>>>>
>>>> v3:
>>>> - Refactor patch series so the transition of logic from the DXE
>>>>     MAT logic to the new library is more clear.
>>>> - Update function headers to improve clarity and follow EDK2
>>>>     standards.
>>>> - Add Create and Delete functions for Image Properties Records
>>>>     and redirect some of the SMM and DXE MAT code to use these
>>>>     functions.
>>>> - Update/Add DumpImageRecords() to print the image name and code
>>>>     sections of each runtime image which will be put in the MAT.
>>>>     The DXE and SMM MAT logic will now invoke the DumpImageRecords()
>>>>     on DEBUG builds at the EndOfDxe event to install the MAT.
>>>>
>>>> v2:
>>>> - A one-line change in patch 3 was moved to patch 9 for correctness.
>>>>
>>>> Reference: https://github.com/tianocore/edk2/pull/4590
>>>> Bugzilla: https://bugzilla.tianocore.org/show_bug.cgi?id=4492
>>>>
>>>> The UEFI and SMM MAT logic contains duplicate logic for manipulating
>>>> image
>>>> properties records which is used to track runtime images.
>>>> This patch series adds a new library, ImagePropertiesRecordLib,
>>>> which consolidates this logic and fixes the bugs which currently
>>>> exist in
>>>> the MAT logic.
>>>>
>>>> The first patch adds the ImagePropertiesRecordLib implementation which
>>>> is a copy of the UEFI MAT logic with minor modifications to remove the
>>>> reliance on globabl variables and make the code unit testable.
>>>>
>>>> The second patch adds a unit test for the ImagePropertiesRecordLib. The
>>>> logic tests various potential layouts of the EFI memory map and runtime
>>>> images. 3/4 of these tests will fail which demonstrates the MAT logic
>>>> bugs.
>>>>
>>>> The third patch fixes the logic in the ImagePropertiesRecordLib so
>>>> that all of the unit tests pass and the MAT logic can be fixed by
>>>> using the library.
>>>>
>>>> The remaining patches add library instances to DSC files and remove
>>>> the image properties record logic from the SMM and UEFI MAT logic.
>>>>
>>>> Cc: Andrew Fish <afish@apple.com>
>>>> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
>>>> Cc: Dandan Bi <dandan.bi@intel.com>
>>>> Cc: Eric Dong <eric.dong@intel.com>
>>>> Cc: Gerd Hoffmann <kraxel@redhat.com>
>>>> Cc: Guo Dong <guo.dong@intel.com>
>>>> Cc: Gua Guo <gua.guo@intel.com>
>>>> Cc: James Lu <james.lu@intel.com>
>>>> Cc: Jian J Wang <jian.j.wang@intel.com>
>>>> Cc: Jiewen Yao <jiewen.yao@intel.com>
>>>> Cc: Jordan Justen <jordan.l.justen@intel.com>
>>>> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
>>>> Cc: Liming Gao <gaoliming@byosoft.com.cn>
>>>> Cc: Rahul Kumar <rahul1.kumar@intel.com>
>>>> Cc: Ray Ni <ray.ni@intel.com>
>>>> Cc: Sami Mujawar <sami.mujawar@arm.com>
>>>> Cc: Sean Rhodes <sean@starlabs.systems>
>>>>
>>>> Taylor Beebe (14):
>>>>     MdeModulePkg: Add ImagePropertiesRecordLib
>>>>     ArmVirtPkg: Add ImagePropertiesRecordLib Instance
>>>>     EmulatorPkg: Add ImagePropertiesRecordLib Instance
>>>>     OvmfPkg: Add ImagePropertiesRecordLib Instance
>>>>     UefiPayloadPkg: Add ImagePropertiesRecordLib Instance
>>>>     MdeModulePkg: Update MemoryAttributesTable.c to Reduce Global
>>>> Variable
>>>>       Use
>>>>     MdeModulePkg: Move Some DXE MAT Logic to ImagePropertiesRecordLib
>>>>     MdeModulePkg: Add ImagePropertiesRecordLib Host-Based Unit Test
>>>>     MdeModulePkg: Fix Bugs in MAT Logic
>>>>     MdeModulePkg: Add NULL checks and Return Status to
>>>>       ImagePropertiesRecordLib
>>>>     UefiCpuPkg: Use Attribute From SMM MemoryAttributesTable if Nonzero
>>>>     MdeModulePkg: Transition SMM MAT Logic to Use
>>>> ImagePropertiesRecordLib
>>>>     MdeModulePkg: Add Logic to Create/Delete Image Properties Records
>>>>     MdeModulePkg: Update DumpImageRecord() in ImagePropertiesRecordLib
>>>>
>>>> MdeModulePkg/Core/Dxe/Misc/MemoryAttributesTable.c |  967
>>>> +----------------
>>>> MdeModulePkg/Core/Dxe/Misc/MemoryProtection.c |   24 +-
>>>> MdeModulePkg/Core/PiSmmCore/MemoryAttributesTable.c |  958
>>>> +---------------
>>>> MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.c
>>>> | 1144 ++++++++++++++++++++
>>>> MdeModulePkg/Library/ImagePropertiesRecordLib/UnitTest/ImagePropertiesRecordLibUnitTestHost.c
>>>> |  938 ++++++++++++++++
>>>> UefiCpuPkg/PiSmmCpuDxeSmm/SmmCpuMemoryManagement.c |   19 +-
>>>> ArmVirtPkg/ArmVirt.dsc.inc |    1 +
>>>> EmulatorPkg/EmulatorPkg.dsc |    1 +
>>>> MdeModulePkg/Core/Dxe/DxeMain.h |   20 -
>>>> MdeModulePkg/Core/Dxe/DxeMain.inf |    1 +
>>>> MdeModulePkg/Core/PiSmmCore/PiSmmCore.inf |    1 +
>>>> MdeModulePkg/Include/Library/ImagePropertiesRecordLib.h |  234 ++++
>>>> MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.inf
>>>> |   31 +
>>>> MdeModulePkg/Library/ImagePropertiesRecordLib/UnitTest/ImagePropertiesRecordLibUnitTestHost.inf
>>>> |   35 +
>>>> MdeModulePkg/MdeModulePkg.dec |    5 +
>>>> MdeModulePkg/MdeModulePkg.dsc |    2 +
>>>> MdeModulePkg/Test/MdeModulePkgHostTest.dsc |    6 +
>>>> OvmfPkg/AmdSev/AmdSevX64.dsc |    1 +
>>>> OvmfPkg/Bhyve/BhyveX64.dsc |    1 +
>>>> OvmfPkg/CloudHv/CloudHvX64.dsc |    1 +
>>>> OvmfPkg/IntelTdx/IntelTdxX64.dsc |    1 +
>>>> OvmfPkg/Microvm/MicrovmX64.dsc |    1 +
>>>> OvmfPkg/OvmfPkgIa32.dsc |    1 +
>>>> OvmfPkg/OvmfPkgIa32X64.dsc |    1 +
>>>> OvmfPkg/OvmfPkgX64.dsc |    1 +
>>>> OvmfPkg/OvmfXen.dsc |    1 +
>>>> OvmfPkg/RiscVVirt/RiscVVirtQemu.dsc |    1 +
>>>> UefiPayloadPkg/UefiPayloadPkg.dsc |    1 +
>>>>    28 files changed, 2524 insertions(+), 1874 deletions(-)
>>>>    create mode 100644
>>>> MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.c
>>>>    create mode 100644
>>>> MdeModulePkg/Library/ImagePropertiesRecordLib/UnitTest/ImagePropertiesRecordLibUnitTestHost.c
>>>>    create mode 100644
>>>> MdeModulePkg/Include/Library/ImagePropertiesRecordLib.h
>>>>    create mode 100644
>>>> MdeModulePkg/Library/ImagePropertiesRecordLib/ImagePropertiesRecordLib.inf
>>>>    create mode 100644
>>>> MdeModulePkg/Library/ImagePropertiesRecordLib/UnitTest/ImagePropertiesRecordLibUnitTestHost.inf
>>>>


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#109072): https://edk2.groups.io/g/devel/message/109072
Mute This Topic: https://groups.io/mt/100553430/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-