Releases: microsoft/mu_basecore
dev-v2024050000.2.0
This is the first dev branch release notes.
What's Changed
These are reduced sets of notes since the v2024050000.1.4 release. Moving forward dev releases will only track changes on the dev branch.
- BaseTools HostBasedUnittestRunner Modify CC_REORGANIZE to exclude Null implementations. by @apop5 in #1218
- BaseTools\HostbasedUnittestRunner: Add support to exclude files from codecoverage. [RB & FF] by @apop5 in #1222
- Update release drafter for dev branches by @makubacki in #1224
A release will be drafted for the dev branch and the release branch. The releases are differentiated by both their release title and tag.
- Release Branch
- Title:
release-v<version> - Tag:
v<version>
- Title:
- Dev Branch
- Title:
dev-v<version> - Tag:
dev-v<version>
- Title:
Note that the tag for the release branch follows the same convention as existing release tags, that is v<version>.
Contributors
Assets 2
release-v2024050000.1.4
What's Changed
-
[Cherry-Pick] Declare mock SMM Access2 Protocol. (#1177) [RB \& FF] @apop5 (#1223)
Change Details
## Description
Declare mock SMM Access2 Protocol for google test.
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Run the google test.
Integration Instructions
N/A
</blockquote> <hr> </details>
-
[Cherry-Pick] BaseTools\HostbasedUnittestRunner: Add support to exclude files from codecoverage. [RB & FF] (#1222)
Change Details
## Description
When Unit tests are run, the generated report includes null libraries in the calculation.
Modifying the organize_coverage to exclude null libraries from the code coverage results.
These changes only effect the case when CC_REORGANIZE is set to true in the project.add CC_EXCLUDE option, which defaults to exclude files/libraries with Null in their name. Can be over-ridden by adding CC_EXCLUDE to comandline.
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
- Backport to release branch?
How This Was Tested
Ran on private repo which contained a lot of NULL libraries. Prior to change, Null libraries were included in the report, after the modification, they were not
Tested modifying CC_EXCLUDE on command line to verify that specific libraries/folders can be targeted by exclude statement.
Integration Instructions
No changes required.
coverage report will look different if CC_REORGANIZE is set to True as NULL libraries will be excluded.
to restore to original functionality, specify CC_EXCLUDE= on the command line.</blockquote> <hr> </details>
Full Changelog: v2024050000.1.3...v2024050000.1.4
Contributors
Assets 4
v2024050000.1.3
What's Changed
🐛 Bug Fixes
-
[TEMPORARY] Disable Stack Cookies for MSVC ARM/AARCH64 #1220
Change Details
## Description
edk2 commit tianocore/edk2@f53f029 added support for ARM/AARCH64 stack cookie checking. This was cherry-picked to mu_basecore. However, StackCheckLibNull does not contain the asm files for ARM/AARCH64 MSVC, so CI builds (and platform builds) fail.
MSVC has a different requirements that are not documented for MSVC ARM/AARCH64 as compared to IA32/X64, so in order to spend more time investigating and testing this, stack cookies are disabled temporarily for ARM/AARCH64 MSVC in mu_basecore.
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
- Backport to release branch?
How This Was Tested
Going back to previous state.
Integration Instructions
Fixes breakages seen when stack cookies were enabled.
Full Changelog: v2024050000.1.2...v2024050000.1.3
v2024050000.1.2
What's Changed
-
[CHERRY-PICK] Added all mock function in MockUefiLib under MdeModulePkg @v-sbolisetti (#1206)
Change Details
## Description
this is a cherry-pick of cd58170
- Backport to release branch?
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Unit tests component can call these mock functions success
Integration Instructions
N/A
🐛 Bug Fixes
-
[Cherry-Pick] Fix naming convention in FirmwareVolume2 gmock @TsunFeng (#1207)
Change Details
## Description
Fix naming convention for FirmwareVolume2 gmock.
- Rename
FV_ReadFile->FvReadFile - Rename
FV_WriteFile->FvWriteFile
cherry-pick of
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Unit tests component can call these mock functions success
Integration Instructions
N/A
- Rename
Full Changelog: v2024050000.1.1...v2024050000.1.2
Contributors
Assets 4
v2023110013.0.1
What's Changed
-
[CHERRY-PICK] UnitTestFrameworkPkg: Use TianoCore mirror of subhook s… @makubacki (#1210)
Change Details
## Description
Change subhook url from https://github.com/Zeex/subhook to https://github.com/tianocore/edk2-subhook because old url is no longer available.
Also align .gitmodules file to use consistent LF line endings.
Signed-off-by: Michael D Kinney [email protected]
(cherry picked from edk2 commit 95d8a1c255cfb8e063d679930d08ca6426eb5701)- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
- Build and CI
Integration Instructions
- Update all repos to use this new submodule URL for subhook
since the original repo is no longer available.
Full Changelog: v2023110013.0.0...v2023110013.0.1
Contributors
Assets 4
v2024050000.1.1
What's Changed
-
[Cherry-Pick] StandaloneMmPkg: Initialize 'WillReturn' variable @apop5 (#1200)
Change Details
## Description
The local variable 'WillReturn' was being used without prior initialization in some code paths.
This patch ensures that 'WillReturn' is properly initialized to prevent undefined behavior.cherry-picked from edk2 tianocore/edk2@30b6d08
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
A platform using StandaloneMM failed to dispatch some handlers. It was tracked back to needing this edk2 cherry-pick is needed to handle the paths through the code.
Integration Instructions
N/A
-
[CHERRY-PICK] Bring in more mocks from release/202311 @VivianNK (#1197)
Change Details
## Description
Cherry-picked from dev/202405: #1182
Add mock functions under MockUefiLib and Create Mock for CapsuleLib, PerformanceLib and GenericMemoryTestProtocol
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Unit tests component can call these mock functions success
Integration Instructions
N/A
</blockquote> <hr> </details>
-
[CHERRY-PICK] Added missing fix for ProductDataFormatter missed from 202311 (#1195) @kenlautner (#1196)
Change Details
## Description
A fix for the ProductDataFormatter script was missed during the transition from 202311 to 202405. This just adds it back.
For details on how to complete these options and their meaning refer to CONTRIBUTING.md.
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Tested on physical hardware. Product Data is correctly being found.
Integration Instructions
N/A
</blockquote> <hr> </details>
Full Changelog: v2024050000.1.0...v2024050000.1.1
Contributors
Assets 4
v2024050000.1.0
What's Changed
-
[Cherry-Pick] MdePkg: Add Gmocks for libraries @VivianNK (#1189)
Change Details
## Description
Cherry-picked from dev (0ba6a3d)
Mock Libraries:
MdePkg\Test\Mock\Library\GoogleTest\MockCpuLib
MdePkg\Test\Mock\Library\GoogleTest\MockPciSegmentLib
MdePkg\Test\Mock\Library\GoogleTest\MockReportStatusCodeLib
MdePkg\Test\Mock\Library\GoogleTest\MockSmmServicesTableLibMock Protocol:
MdePkg\Test\Mock\Include\GoogleTest\Protocol\MockMpService.hSigned-off-by: jack Hsieh [email protected]
Cc: Maintainer Shruti Gupta [email protected]
Cc: Reviewer Shruti Gupta [email protected]- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Mocks used by unit tests
Integration Instructions
N/A
-
[Cherry-Pick] [RB\&FF] MdeModulePkg/HiiDatabaseDxe: Remove assert for VarStoreId = 0 @apop5 (#1186)
Change Details
Description
It is legal for the VarStoreId of a question to
be 0 per the UEFI spec:
"Specifies the identifier of a previously
declared variable store to use when storing the
question’s value. A value of zero indicates
no associated variable store."Instead of hitting an assert just skip this
question as there is no value to return.</blockquote> <hr> </details>
-
[Rebase \& FF] MdePkg: Add gmock for PcdLib @VivianNK (#1179)
Change Details
## Description
Cherry-pick from dev/202405:
a45519aFor details on how to complete these options and their meaning refer to CONTRIBUTING.md.
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Consumed in a GoogleTest
Integration Instructions
N/A
-
[REBASE\&FF] Cherry-pick EDKII commits @Javagedes (#1172)
Change Details
## Description Cherry-pick the following commits from EDKII / backport from dev/202405:
- tianocore/edk2@30e53f8 into release/202405
- tianocore/edk2@1715d672 into release/202405.
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
N/A
Integration Instructions
N/A
</blockquote> <hr> </details>
-
[CHERRY-PICK] MdePkg: Add mocks for AcpiTable and more @VivianNK (#1167)
Change Details
## Description
Create mock for AcpiTable, FirmwareVolume2 and
AcpiSystemDescriptionTable protocols.Cherry-picked from dev/202405:
fe6a1f9- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Mock consumed in local unit test.
Integration Instructions
N/A
🚀 Features & ✨ Enhancements
-
[CHERRY-PICK] MdeModulePkg: Gcd: Only Update gMemoryMap Attributes if Correct GCD Type @os-d (#1175)
Change Details
## Description
Currently whenever gDS->SetMemorySpaceCapabilities() is called, it attempts to set the corresponding attributes in the gMemoryMap descriptor. However, gMemoryMap only contains entries from GCD types EfiGcdMemoryTypeSystemMemory and EfiGcdMemoryTypeMoreReliable, so for all other types a failure is reported in the code. This is a failure that is expected, so it does not provide value and can lead to real failures being ignored.
This patch updates the gDS->SetMemorySpaceCapabilities() code to only call into updating gMemoryMap if the GCD type is SystemMemory or MoreReliable, to avoid spurious errors being reported. This also avoids the expensive operation of searching through gMemoryMap for entries we know we will fail to find.
Cherry-picked from edk2 via dev/202405.
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
N/A.
Integration Instructions
N/A.
</blockquote> <hr> </details>
-
[REBASE\&FF] CryptoPkg: Require exact crypto version match @Javagedes (#1160)
Change Details
## Description
Crypto versioning is not currently backwards compatible. This change updates the check to require an exact match of the crypto version.
Cherry-pick from dev/202405: 34455f5
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
N/A
Integration Instructions
N/A
</blockquote> <hr> </details>
Full Changelog: v2024050000.0.2...v2024050000.1.0
Contributors
Assets 4
v2023110013.0.0
What's Changed
-
[REBASE\&FF] Cherry-pick EDKII commits @Javagedes (#1170)
Change Details
## Description
Cherry-pick the following commits from EDKII:
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
N/A
Integration Instructions
N/A
</blockquote> <hr> </details>
⚠️ Breaking Changes
-
[Rebase \& FF] Fix PI status code @kuqin12 (#1187)
Change Details
## Description
We upstreamed the correct PI status code to PI spec and should get rid of MU_CHANGE to avoid conflict.
For details on how to complete these options and their meaning refer to CONTRIBUTING.md.
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
This change only involves definition migration.
Integration Instructions
For applicable components, platform needs to update these definitions in their code.
EFI_SW_EC_MEMORY_TYPE_INFORMATION_CHANGE->EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
EFI_SW_EC_RELEASE_ASSERT->EFI_SW_EC_ILLEGAL_SOFTWARE_STATE</blockquote> <hr> </details>
Full Changelog: v2023110012.1.0...v2023110013.0.0
Contributors
Assets 4
v2024050000.0.2
What's Changed
-
[CHERRY-PICK][REBASE\&FF] ImageValidation.py: Support gitignore style syntax for file exclusion @Javagedes (#1154)
Change Details
## Description
Cherry-pick of #1140 into dev/202405
This commit is also in release/202308
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
- Squash into 6310e1e
How This Was Tested
Cherry-pick of #1140 into dev/202405
Integration Instructions
Cherry-pick of #1140 into dev/202405
</blockquote> <hr> </details>
-
[CHERRY-PICK] .pytool/ImageValidation: Print invalid dir paths @makubacki (#1155)
Change Details
## Description
-
Print directory paths considered invalid to aid debugging
-
Build native OS file paths using os.path.join for walk dirs
-
Clean up trailing whitespace throughout the file
-
Impacts functionality?
-
Impacts security?
-
Breaking change?
-
Includes tests?
-
Includes documentation?
How This Was Tested
- Local build with the plugin
- Tested invalid directory printing by adding an invalid arch to
TARGET_ARCH(so the directory doesn't exist in build output).
Integration Instructions
N/A - Minor tweaks
-
-
[Cherry-Pick] Support Report Status Code in the UefiPxe driver. @apop5 (#1138)
Change Details
## Description
Report PXE error status via Status Code, with this design, it will be flexible to register a status code handler via gEfiRscHandlerProtocolGuid to output the customized error code to other telemetry service.
The subclass code is
EFI_IO_BUS_IP_NETWORK- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
N/A
Integration Instructions
N/A
🐛 Bug Fixes
-
[REBASE\&FF] MdeModulePkg/SMM: Initialize 'WillReturn' variable @Javagedes (#1159)
Change Details
## Description
The local variable 'WillReturn' was being used without prior initialization in some code paths.
This patch ensures that 'WillReturn' is properly initialized to prevent undefined behavior.Cherry-pick from EDKII tianocore/edk2@30b6d08
Cherry-pick from dev/202405 36f763d- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Cherry-pick from EDKII tianocore/edk2@30b6d08
Integration Instructions
Cherry-pick from EDKII tianocore/edk2@30b6d08
</blockquote> <hr> </details>
Full Changelog: v2024050000.0.1...v2024050000.0.2
Contributors
Assets 4
v2023110012.1.0
What's Changed
-
[202311] ImageValidation.py: Support gitignore style syntax for file exclusion @Javagedes (#1141)
Change Details
## Description
Add gitignore style syntax for file exclusion
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Ensured existing syntax (filename only) continues to work. Ensured gitignore style syntax now works.
Integration Instructions
N/A
-
Mock Functions for ReportStatusCodeHandler Library \& RegistryNotify , ConnectController in MockUefiBootServicesTableLib @v-sbolisetti (#1122)
Change Details
## Description
Added Mock Functions for ReportStatusCodeHandler Library & RegistryNotify , ConnectController in MockUefiBootServicesTableLib
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Unit tests component can call these mock functions success
Integration Instructions
N/A
-
Add mock functions under MockUefiRuntimeServicesTableLib, MockUefiRuntimeServicesTableLib and Create Mock for DxeServicesTableLib @YiTa-AMI (#1109)
Change Details
## Description
Add mock functions under MockUefiRuntimeServicesTableLib, MockUefiRuntimeServicesTableLib and Create Mock for DxeServicesTableLib
For details on how to complete to complete these options and their meaning refer to CONTRIBUTING.md.
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Unit tests component can call these mock functions success
Integration Instructions
N/A
-
[CHERRY-PICK] MdeModulePkg/FaultTolerantWriteDxe: Fix buffer overrun issue @os-d (#1134)
Change Details
## Description
-
This PR aims to prevent a buffer overrun issue found in FtwGetLastWriteHeader function.As per the current code, when there is a malformed blocks (with all bytes as 0s) then
Offset += FTW_WRITE_TOTAL_SIZE (FtwHeader->NumberOfWrites, FtwHeader->PrivateDataSize)would access beyond FtwWorkSpaceSize. -
Also added the signature check to validate work space
-
Impacts functionality?
-
Impacts security?
-
Breaking change?
-
Includes tests?
-
Includes documentation?
How This Was Tested
Tested on failing platform.
Integration Instructions
N/A.
-
-
[202311] ImageValidation.py: Don't parse entire image @Javagedes (#1126)
Change Details
## Description
This commit modifies the PE parsing functionality to only parse the headers of the image, rather than the entire image. This change is made to improve performance and also the probability of failing to parse the entire image. This comes after this commit (erocarrera/pefile#365) in pefile resulted in efi image parsing failures, breaking the build.
This commit also wraps the parsing of the image in a try-except block to catch any exceptions that may be raised during parsing, to cleanly exit.
See: microsoft/mu_tiano_platforms#1025 and erocarrera/pefile#421
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Validated pipelines build on mu_tiano_platforms
Integration Instructions
N/A
-
Add mock functions under MockUefiLib and Create Mock for CapsuleLib, PerformanceLib, MockUefiBootManagerLib and GenericMemoryTestProtocol @YiTa-AMI (#1111)
Change Details
## Description
Add mock functions under MockUefiLib and Create Mock for CapsuleLib, PerformanceLib and GenericMemoryTestProtocol
For details on how to complete to complete these options and their meaning refer to CONTRIBUTING.md.
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Unit tests component can call these mock functions success
Integration Instructions
N/A
-
[202311] ImageValidation: Determine profile from inf MODULE\_TYPE @Javagedes (#1125)
Change Details
## Description
In previous iterations, the profile was determined by parsing the makefile, looking for MODULE_TYPE. As each OS / tool chain may use a different makefile type, this was not a reliable method. This updates the plugin to read the INF for the compiled efi file to determine the MODULE_TYPE and thus the profile.
- Impacts functionality?
- Impacts security?
- Breaking change?
- Includes tests?
- Includes documentation?
How This Was Tested
Validated on qemuq35 that the module type was successfully parsed.
Integration Instructions
N/A
🚀 Features & ✨ Enhancements
-
[2311][Rebase \& FF] STM Support @makubacki (#1113)
Change Details
## Description
Adds SMM Transfer Monitor (STM) infrastructure changes.
Commit Summary
-
MdeModulePkg/TpmMeasurementLibNull: Add MM_CORE_STANDALONE
-
BaseTools: Add the GenStm C tool
-
Impacts functionality?
-
Impacts security?
-
Breaking change?
-
Includes tests?
-
Includes documentation?
How This Was Tested
- Build with GenStm
- Generate an aux file using the build rule
- Link the TpmMeasureLibNull instance to a Standalone MM Core module
Integration Instructions
- No change is needed unless this support is needed
- Review the GenStm arguments in help output for more details
-
Full Changelog: v2023110012.0.0...v2023110012.1.0
