From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by spool.mail.gandi.net (Postfix) with ESMTPS id 36B9F941CDE for ; Fri, 3 Nov 2023 17:17:20 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=UqvduWIjNHMDsxPERM9MKYVcvDa3qYT4tA8HR1Qnbpc=; c=relaxed/simple; d=groups.io; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:Precedence:List-Subscribe:List-Help:Sender:List-Id:Mailing-List:Delivered-To:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Transfer-Encoding; s=20140610; t=1699031838; v=1; b=ll+8niFLTzcwSjwkoGKD7Cj/kveLul9vf1sPu1/+W0uGwGiF/r1eo83rXGK0Dwh3acAg1ZlJ z+h/N3wOSItZqybtWXTAwxlECNQ+gVBUY38URvTQS2MWMHhWNoSXgm/JvYr0j3HZJ6LxVgqZWMG w2PlceOCBvrtr7cZ4nSSndls= X-Received: by 127.0.0.2 with SMTP id 81GTYY7687511xCfaO8Tp23D; Fri, 03 Nov 2023 10:17:18 -0700 X-Received: from mail-pl1-f182.google.com (mail-pl1-f182.google.com [209.85.214.182]) by mx.groups.io with SMTP id smtpd.web11.59063.1699031838393864575 for ; Fri, 03 Nov 2023 10:17:18 -0700 X-Received: by mail-pl1-f182.google.com with SMTP id d9443c01a7336-1cc3bb32b5dso20603645ad.3 for ; Fri, 03 Nov 2023 10:17:18 -0700 (PDT) X-Gm-Message-State: XwbDfxgL5KE2PL7d1ioN4z7qx7686176AA= X-Google-Smtp-Source: AGHT+IGWtkeitwIrP5RoWHdO3UAXVNn2S56MlrPTlaEDVpx6tFTRFPBjpdZuwaUlZ6OkSW7d8zmKWA== X-Received: by 2002:a17:902:dcd5:b0:1cc:4a64:30df with SMTP id t21-20020a170902dcd500b001cc4a6430dfmr12725999pll.59.1699031837611; Fri, 03 Nov 2023 10:17:17 -0700 (PDT) X-Received: from localhost.localdomain ([50.46.253.1]) by smtp.gmail.com with ESMTPSA id b8-20020a170903228800b001bf5e24b2a8sm1625152plh.174.2023.11.03.10.17.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Nov 2023 10:17:17 -0700 (PDT) From: "Taylor Beebe" To: devel@edk2.groups.io Cc: Andrew Fish , Ard Biesheuvel , Dandan Bi , Eric Dong , Gerd Hoffmann , Guo Dong , Gua Guo , James Lu , Jian J Wang , Jiewen Yao , Jordan Justen , Leif Lindholm , Liming Gao , Rahul Kumar , Ray Ni , Sami Mujawar , Sean Rhodes , Lazlo Ersek Subject: [edk2-devel] [PATCH v4 00/14] Add ImagePropertiesRecordLib and Fix MAT Bugs Date: Fri, 3 Nov 2023 10:16:52 -0700 Message-ID: <20231103171706.148-1-taylor.d.beebe@gmail.com> MIME-Version: 1.0 Precedence: Bulk List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,taylor.d.beebe@gmail.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: Content-Transfer-Encoding: 8bit X-GND-Status: LEGIT Authentication-Results: spool.mail.gandi.net; dkim=pass header.d=groups.io header.s=20140610 header.b=ll+8niFL; dmarc=fail reason="SPF not aligned (relaxed), DKIM not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (spool.mail.gandi.net: domain of bounce@groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce@groups.io 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 Cc: Ard Biesheuvel Cc: Dandan Bi Cc: Eric Dong Cc: Gerd Hoffmann Cc: Guo Dong Cc: Gua Guo Cc: James Lu Cc: Jian J Wang Cc: Jiewen Yao Cc: Jordan Justen Cc: Leif Lindholm Cc: Liming Gao Cc: Rahul Kumar Cc: Ray Ni Cc: Sami Mujawar Cc: Sean Rhodes Cc: Lazlo Ersek 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 -- 2.42.0.windows.2 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#110648): https://edk2.groups.io/g/devel/message/110648 Mute This Topic: https://groups.io/mt/102368839/7686176 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io] -=-=-=-=-=-=-=-=-=-=-=-