From nobody Sun Feb 8 16:30:46 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+108864+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+108864+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=gmail.com ARC-Seal: i=1; a=rsa-sha256; t=1695171487; cv=none; d=zohomail.com; s=zohoarc; b=eoaOsCdfDS+Vd2wYF9CBEPb6NkPLzVEkCOERhhPf82o7A+cmpeFdhQ0qqM8O2bzG1uG+IReJTsPR1ZwPnNm1acB8yvR260buN8zmFzv8Klffa/L/LHPBmerc7zSPTAu9CiIYa5J19Xlm1z7fmbsrxoXgM85ZeKHIoZzieqbzZDk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1695171487; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=F60JSBsPL6vlAdKIx1K4+8tTQiSWYO63T+MnhLNaC1I=; b=jc++wwe47bBs86nH5xm2j6/GuljV07fN/8xVSscC9ZVFbISnZBlxjgzTIDNihphDgG/EQthDkSRWT6vjs6awFnlQVhEHzTvyFNPy2F1GzF4lQbMiacF/0V/9q1jKgV4dKBKvdAzwyWUXkv3bV4F4954MUt7lVJlDQD7MrYyAMRI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+108864+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1695171487618222.04970974756304; Tue, 19 Sep 2023 17:58:07 -0700 (PDT) Return-Path: DKIM-Signature: a=rsa-sha256; bh=4vr5c1t69xsBXWDQYLoElz7CuDiZh86ZwuWw5ntmar4=; c=relaxed/simple; d=groups.io; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: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=1695171487; v=1; b=vRccn8n9tfmBy6wP4P7WWLChlmXrRhwnsYuPE+4mUokt9P+5MQOBp1bHEZdgKlVFPVORX5fJ GDbHLTTC1eI5AbDF8DLmFkLIiwc3vGd4B2BfFcUSzM6SwVf+RwC38Q21fig581mV0uldyHxBxp6 yQeuSoQJcwfHDPdUe8l14TJQ= X-Received: by 127.0.0.2 with SMTP id w7PgYY1788612x1O2eTCE0jU; Tue, 19 Sep 2023 17:58:07 -0700 X-Received: from mail-pg1-f182.google.com (mail-pg1-f182.google.com [209.85.215.182]) by mx.groups.io with SMTP id smtpd.web11.26915.1695171486818405766 for ; Tue, 19 Sep 2023 17:58:06 -0700 X-Received: by mail-pg1-f182.google.com with SMTP id 41be03b00d2f7-573e67cc6eeso4852944a12.2 for ; Tue, 19 Sep 2023 17:58:06 -0700 (PDT) X-Gm-Message-State: MUog4JufKQJUmE8SrMFp4T72x1787277AA= X-Google-Smtp-Source: AGHT+IG+kMAt8F6p3TZSP5YUACBfWtu+6AzipMxkr0Y1aUn6TSjTeQKGNHIbEGAE+fluitHV/FZeBw== X-Received: by 2002:a05:6a21:271c:b0:14c:c393:402d with SMTP id rm28-20020a056a21271c00b0014cc393402dmr893483pzb.34.1695171485924; Tue, 19 Sep 2023 17:58:05 -0700 (PDT) X-Received: from localhost.localdomain ([50.46.253.1]) by smtp.gmail.com with ESMTPSA id 13-20020a170902c24d00b001bb988ac243sm10563576plg.297.2023.09.19.17.58.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 19 Sep 2023 17:58:05 -0700 (PDT) From: "Taylor Beebe" To: devel@edk2.groups.io Cc: Jian J Wang , Liming Gao Subject: [edk2-devel] [PATCH v4 02/28] MdeModulePkg: Define SetMemoryProtectionsLib and GetMemoryProtectionsLib Date: Tue, 19 Sep 2023 17:57:25 -0700 Message-ID: <20230920005752.2041-3-taylor.d.beebe@gmail.com> In-Reply-To: <20230920005752.2041-1-taylor.d.beebe@gmail.com> References: <20230920005752.2041-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: quoted-printable X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1695171489439100009 Content-Type: text/plain; charset="utf-8" SetMemoryProtectionsLib is a PEIM which allows platforms to apply memory protection settings to the current boot. GetMemoryProtectionsLib has DXE and MM implementations to allow platforms to query the current memory protection settings via a global variable populated by the library Implementations. The global variable is a union of the MM and DXE settings. the DXE struct is only valid in a DXE module and the MM struct is only valid in an SMM or Stanalone MM module. Signed-off-by: Taylor Beebe Cc: Jian J Wang Cc: Liming Gao --- MdeModulePkg/Include/Library/GetMemoryProtectionsLib.h | 83 +++++++++++ MdeModulePkg/Include/Library/SetMemoryProtectionsLib.h | 152 +++++++++++++= +++++++ MdeModulePkg/MdeModulePkg.dec | 8 ++ 3 files changed, 243 insertions(+) diff --git a/MdeModulePkg/Include/Library/GetMemoryProtectionsLib.h b/MdeMo= dulePkg/Include/Library/GetMemoryProtectionsLib.h new file mode 100644 index 000000000000..c8f7084e9c80 --- /dev/null +++ b/MdeModulePkg/Include/Library/GetMemoryProtectionsLib.h @@ -0,0 +1,83 @@ +/** @file +Library for accessing the platform memory protection settings. + +Copyright (c) Microsoft Corporation. +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef GET_MEMORY_PROTECTION_SETTINGS_LIB_H_ +#define GET_MEMORY_PROTECTION_SETTINGS_LIB_H_ + +#include +#include + +#pragma pack(1) + +typedef union { + DXE_MEMORY_PROTECTION_SETTINGS Dxe; + MM_MEMORY_PROTECTION_SETTINGS Mm; +} MEMORY_PROTECTION_SETTINGS_UNION; + +#pragma pack() + +// The global used to access current Memory Protection Settings +extern MEMORY_PROTECTION_SETTINGS_UNION gMps; + +#define MPS_IS_DXE_SIGNATURE_VALID (gMps.Dxe.Signature =3D=3D DXE_MEMORY_= PROTECTION_SIGNATURE) +#define MPS_IS_MM_SIGNATURE_VALID (gMps.Mm.Signature =3D=3D MM_MEMORY_PR= OTECTION_SIGNATURE) + +#define IS_DXE_PAGE_GUARD_ACTIVE (MPS_IS_DXE_SIGNATURE_VALID = && \ + !IsZeroBuffer (&gMps.Dxe.PageGuard.Enabl= edForType, MPS_MEMORY_TYPE_BUFFER_SIZE) && \ + gMps.Dxe.HeapGuard.PageGuardEnabled) + +#define IS_DXE_POOL_GUARD_ACTIVE (MPS_IS_DXE_SIGNATURE_VALID = && \ + !IsZeroBuffer (&gMps.Dxe.PoolGuard.Enabl= edForType, MPS_MEMORY_TYPE_BUFFER_SIZE) && \ + gMps.Dxe.HeapGuard.PoolGuardEnabled) + +#define IS_DXE_EXECUTION_PROTECTION_ACTIVE (MPS_IS_DXE_SIGNATURE_VALID = && \ + !IsZeroBuffer (&gMps.Dxe.Execu= tionProtection.EnabledForType, MPS_MEMORY_TYPE_BUFFER_SIZE)) + +#define IS_DXE_IMAGE_PROTECTION_ACTIVE (MPS_IS_DXE_SIGNATURE_VALID = && \ + (gMps.Dxe.ImageProtection.ProtectI= mageFromFv || \ + gMps.Dxe.ImageProtection.ProtectI= mageFromUnknown)) + +#define IS_DXE_MEMORY_PROTECTION_ACTIVE (MPS_IS_DXE_SIGNATURE_VALID = && \ + (IS_DXE_PAGE_GUARD_ACTIVE = || \ + IS_DXE_POOL_GUARD_ACTIVE = || \ + IS_DXE_EXECUTION_PROTECTION_ACTI= VE || \ + IS_DXE_IMAGE_PROTECTION_ACTIVE = || \ + gMps.Dxe.CpuStackGuardEnabled = || \ + gMps.Dxe.StackExecutionProtectio= nEnabled || \ + gMps.Dxe.NullPointerDetection.En= abled || \ + gMps.Dxe.HeapGuard.FreedMemoryGu= ardEnabled)) + +#define IS_MM_PAGE_GUARD_ACTIVE (MPS_IS_MM_SIGNATURE_VALID = && \ + gMps.Mm.HeapGuard.PageGuardEnabled = && \ + !IsZeroBuffer (&gMps.Mm.PageGuard.Enabl= edForType, MPS_MEMORY_TYPE_BUFFER_SIZE)) + +#define IS_MM_POOL_GUARD_ACTIVE (MPS_IS_MM_SIGNATURE_VALID = && \ + gMps.Mm.HeapGuard.PoolGuardEnabled = && \ + !IsZeroBuffer (&gMps.Mm.PoolGuard.Enable= dForType, MPS_MEMORY_TYPE_BUFFER_SIZE)) + +#define IS_MM_MEMORY_PROTECTION_ACTIVE (MPS_IS_MM_SIGNATURE_VALID = && \ + (IS_MM_PAGE_GUARD_ACTIVE = || \ + IS_MM_POOL_GUARD_ACTIVE = || \ + gMps.Mm.NullPointerDetection.Enab= led)); + +/** + Populates gMps global. This function is invoked by the library construct= or and only needs to be + called if library contructors have not yet been invoked. + + @retval EFI_SUCCESS gMps global was populated. + @retval EFI_NOT_FOUND The gMemoryProtectionSettingsGuid HOB was not = found. + @retval EFI_ABORTED The version number of the DXE or MM memory pro= tection settings was invalid. + @retval EFI_UNSUPPORTED NULL implementation called. +**/ +EFI_STATUS +EFIAPI +PopulateMpsGlobal ( + VOID + ); + +#endif diff --git a/MdeModulePkg/Include/Library/SetMemoryProtectionsLib.h b/MdeMo= dulePkg/Include/Library/SetMemoryProtectionsLib.h new file mode 100644 index 000000000000..023c987c3c7e --- /dev/null +++ b/MdeModulePkg/Include/Library/SetMemoryProtectionsLib.h @@ -0,0 +1,152 @@ +/** @file +Library for creating the MM and DXE memory protection HOB entries. + +Copyright (c) Microsoft Corporation. +SPDX-License-Identifier: BSD-2-Clause-Patent +**/ + +#ifndef SET_MEMORY_PROTECTION_SETTINGS_LIB_H_ +#define SET_MEMORY_PROTECTION_SETTINGS_LIB_H_ + +#include + +typedef struct { + CHAR8 *Name; + CHAR8 *Description; + DXE_MEMORY_PROTECTION_SETTINGS Settings; +} DXE_MEMORY_PROTECTION_PROFILES; + +typedef enum { + DxeMemoryProtectionSettingsPcd, + DxeMemoryProtectionSettingsMax +} DXE_MEMORY_PROTECTION_PROFILE_INDEX; + +typedef struct { + CHAR8 *Name; + CHAR8 *Description; + MM_MEMORY_PROTECTION_SETTINGS Settings; +} MM_MEMORY_PROTECTION_PROFILES; + +typedef enum { + MmMemoryProtectionSettingsPcd, + MmMemoryProtectionSettingsMax +} MM_MEMORY_PROTECTION_PROFILE_INDEX; + +extern DXE_MEMORY_PROTECTION_PROFILES DxeMemoryProtectionProfiles[DxeMemo= ryProtectionSettingsMax]; +extern MM_MEMORY_PROTECTION_PROFILES MmMemoryProtectionProfiles[MmMemory= ProtectionSettingsMax]; + +/** + Prevent further changes to the memory protection settings via this + library API. + + @retval EFI_SUCCESS The memory protection settings are locked. + @retval EFI_ABORTED Unable to get/create the memory protection= settings. + @retval EFI_UNSUPPORTED NULL implementation called. +**/ +EFI_STATUS +EFIAPI +LockMemoryProtectionSettings ( + VOID + ); + +/** + Sets the DXE memory protection settings. If DxeMps is NULL, the settings= will be set based + on ProfileIndex. + + @param[in] DxeMps Pointer to the memory protection settings to pu= blish. If NULL, the + settings will be created based on ProfileIndex. + @param[in] ProfileIndex The index of the memory protection profile to u= se if DxeMps is NULL. + + @retval EFI_SUCCESS The memory protection HOB was successfully= created. + @retval EFI_INVALID_PARAMETER The ProfileIndex was invalid or the versio= n number of the + input DxeMps was not equal to the version = currently present + in the settings. + @retval EFI_ABORTED Unable to get/create the memory protection= settings. + @retval EFI_ACCESS_DENIED The memory protection settings are locked. + @retval EFI_UNSUPPORTED NULL implementation called. +**/ +EFI_STATUS +EFIAPI +SetDxeMemoryProtectionSettings ( + IN DXE_MEMORY_PROTECTION_SETTINGS *DxeMps OPTIONAL, + IN DXE_MEMORY_PROTECTION_PROFILE_INDEX ProfileIndex + ); + +/** + Sets the MM memory protection HOB entry. If MmMps is NULL, the settings = will be set based + on ProfileIndex. + + @param[in] MmMps Pointer to the memory protection settings to pu= blish. If NULL, the + settings will be created based on ProfileIndex. + @param[in] ProfileIndex The index of the memory protection profile to u= se if MmMps is NULL. + + @retval EFI_SUCCESS The memory protection HOB was successfully= created. + @retval EFI_OUT_OF_RESOURCES There was insufficient memory to create th= e HOB. + @retval EFI_INVALID_PARAMETER The ProfileIndex was invalid or the versio= n number of the + input MmMps was not equal to the version c= urrently present + in the settings. + @retval EFI_ABORTED Unable to get/create the memory protection= settings. + @retval EFI_ACCESS_DENIED The memory protection settings are locked. + @retval EFI_UNSUPPORTED NULL implementation called. +**/ +EFI_STATUS +EFIAPI +SetMmMemoryProtectionSettings ( + IN MM_MEMORY_PROTECTION_SETTINGS *MmMps OPTIONAL, + IN MM_MEMORY_PROTECTION_PROFILE_INDEX ProfileIndex + ); + +/** + Copies the current memory protection settings into the input buffer. + + NOTE: The returned settings may not be the final settings used by the + platform on this boot. Unless LockMemoryProtectionSettings() has + been called, settings may be modified by drivers until DXE handoff. + + @param[out] Mps The memory protection settings pointer to populate. + + @retval EFI_SUCCESS The memory protection settings were copied + into the input buffer. + @retval EFI_INVALID_PARAMETER Mps was NULL. + @retval EFI_ABORTED Unable to get/create the memory protection= settings. + @retval EFI_UNSUPPORTED NULL implementation called. +**/ +EFI_STATUS +EFIAPI +GetCurrentMemoryProtectionSettings ( + OUT MEMORY_PROTECTION_SETTINGS *Mps + ); + +/** + Returns TRUE any form of DXE memory protection is currently active. + + NOTE: The returned value may reflect the final settings used by the + platform on this boot. Unless LockMemoryProtectionSettings() has + been called, settings may be modified by drivers until DXE handoff. + + @retval TRUE DXE Memory protection is active. + @retval FALSE DXE Memory protection is not active. +**/ +BOOLEAN +EFIAPI +IsDxeMemoryProtectionActive ( + VOID + ); + +/** + Returns TRUE any form of MM memory protection is currently active. + + NOTE: The returned value may reflect the final settings used by the + platform on this boot. Unless LockMemoryProtectionSettings() has + been called, settings may be modified by drivers until DXE handoff. + + @retval TRUE MM Memory protection is active. + @retval FALSE MM Memory protection is not active. +**/ +BOOLEAN +EFIAPI +IsMmMemoryProtectionActive ( + VOID + ); + +#endif diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec index 5e1a0388bed3..6ad0902a1bff 100644 --- a/MdeModulePkg/MdeModulePkg.dec +++ b/MdeModulePkg/MdeModulePkg.dec @@ -164,6 +164,14 @@ [LibraryClasses] # VariableFlashInfoLib|Include/Library/VariableFlashInfoLib.h =20 + ## @libraryclass Provides a global for consuming memory protection setti= ngs + # + GetMemoryProtectionsLib|Include/Library/GetMemoryProtectionsLib.h + + ## @libraryclass Library for creating the memory protection settings HOB + # + SetMemoryProtectionsLib|Include/Library/SetMemoryProtectionsLib.h + [Guids] ## MdeModule package token space guid # Include/Guid/MdeModulePkgTokenSpace.h --=20 2.42.0.windows.2 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#108864): https://edk2.groups.io/g/devel/message/108864 Mute This Topic: https://groups.io/mt/101469939/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-