Introducing host based unit tests on AArch64 systems by kuqin12 · Pull Request #12070 · tianocore/edk2

kuqin12 · 2026-01-28T00:58:52Z

Description

This change adds the support for building and running host based unit tests on AArch64 Linux systems.

The change currently only supports the operations using GCC as the compiler. Support for CLANG is pending.

Known issues:

Subhook does not support AArch64 binaries, thus function pointer patching are not supported when building on AArch64 platforms.
RngLib for AArch64 target will check on to determine the availability of RDRAND instruction, which may or may not be supported depending on . It is suggested to use the timer based RngLib for host tests.
We might need a legit TimerLib for host based unit test to resolve the issue above.
The packages that depends on RngLib are not onboarded to support AArch64 host tests. Including CryptoPkg, SecurityPkg, and UefiCpuPkg.
Breaking change?
- Breaking change - Does this PR cause a break in build or boot behavior?
- Examples: Does it add a new library class or move a module to a different repo.
Impacts security?
- Security - Does this PR have a direct security impact?
- Examples: Crypto algorithm change or buffer overflow fix.
Includes tests?
- Tests - Does this PR include any explicit test code?
- Examples: Unit tests or integration tests.

How This Was Tested

This was tested on a AArch64 host system running Ubuntu 24.04.

Integration Instructions

N/A

github-actions · 2026-03-29T23:48:24Z

This PR has been automatically marked as stale because it has not had activity in 60 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions.

mergify · 2026-03-29T23:49:01Z

PR can not be merged due to conflict. Please rebase and resubmit

kuqin12 · 2026-03-30T04:23:51Z

Not stale

pierregondois

Hello Kun,
Just a few comments, otherwise I tried the branch locally and it seems to work well.

pierregondois · 2026-04-30T09:29:54Z


 [Sources.AARCH64]
  AArch64/InternalSwitchStack.c
-  AArch64/Unaligned.c


NIT:
It seems that this patch does 2 things:

Add preprocessor for AArch64 instances

Cleanup some unnecessary files

Maybe this patch should be split in 2 and also remove the following unused sections:

[Sources.RISCV64]

[Sources.EBC]

NIT2:
The following function are not supported by the UnitTestHost BaseLib implementation:

AArch64/ArmReadCntPctReg.S

AArch64/ArmReadIdAA64Isar0Reg.S

It doesn't seem it is required right now and it will still be possible to add it later if needed, so just making a note of it.

NIT3:
Also, the VALID_ARCHITECTURES might be updated to add AARCH64

Thanks for your comments and testing this.

I have updated this patch per your feedback. Specifically, I split the majority of the inf change into a separate commit and also removed the EBC and RISCV sections.

It was a good callout, but I did not add the CntPctReg and IdAA64Isar0Reg support in this patch set. I would like to add the timer related changes in a separate PR to resolve the lack of timer support on host-based tests. But please let me know if you have other thoughts.

pierregondois · 2026-04-30T09:34:36Z

-/**
-  Sample unit test that performs a divide by 0
-**/
-TEST (SanitizerTests, DivideByZeroDeathTest) {


It seems that the same division by 0 test exists in:
UnitTestFrameworkPkg/Test/GoogleTest/Sample/SampleGoogleTestGenerateException/ampleGoogleTestGenerateException.cpp

The test should generate an exception, but instead it should fail as the result is 0 (checked against MAX_UINTN). Maybe the test should be IA32/X64 only.

I left this feedback out for this round of push. The test is intended to generate an exception, but divide by 0 will not trip on any exception on AArch64 platforms. Should we switch to read from a null pointer instead in this case? @mdkinney any thoughts?

On the other hand, this test is not included in the unit test dsc file, so we do not have obvious way to mark this test as x86 specific, other than the inf's supported architecture, which is already configured as such.

I left this feedback out for this round of push. The test is intended to generate an exception, but divide by 0 will not trip on any exception on AArch64 platforms. Should we switch to read from a null pointer instead in this case? @mdkinney any thoughts?

On the other hand, this test is not included in the unit test dsc file, so we do not have obvious way to mark this test as x86 specific, other than the inf's supported architecture, which is already configured as such.

Most of this file can work for all archs. Just this one test should be broken out into an x86 only cpp file and INF updated with main cpp file for all archs and the one special cpp file for IA32/X64 only.

This change updates the iasl binary to the 20230628 release. The updated release also adds support for execution on ARM host machines. Signed-off-by: Kun Qin <[email protected]>

This change adds a few preprocessors to build AArch64 host based unit tests properly. An AArch64 specific instance of `gUnitTestHostBaseLib` is created to abstract the reference of arch specific special instructions. Signed-off-by: Kun Qin <[email protected]>

The existing UnitTestHostBaseLib has some source entries that are either redundant or for unsupported architectures. This change consolidated the redundant entries and removed the entries for unsupported architectures. Signed-off-by: Kun Qin <[email protected]>

…rch64 AArch64 does not have divide-by-zero exception. This change modifies the corresponding test to work with AArch64. Signed-off-by: Kun Qin <[email protected]>

This change adds the support of float operations for AArch64 host based unit tests by overriding the compiler flags. Signed-off-by: Kun Qin <[email protected]>

This change adds the GCC compiler flag for AArch64 targets. Signed-off-by: Kun Qin <[email protected]>

Current FunctionMockLib is relying on the subhoob module to support the backend operation by bitbanging the binary post-disassembly. However subhook module is a x64 centric module and does not support AArch64 usage. This change removes the mock function support for AArch64. The functionality will need other solutions to be properly supported. Signed-off-by: Kun Qin <[email protected]>

This change adds the AArch64 target for host based unit tests. Signed-off-by: Kun Qin <[email protected]>

The current instance does not support host based test on AArch64 host system due to its dependency on hardware UART library. This change created a new instance that does not initialize the serial port for host based test applications. Signed-off-by: Kun Qin <[email protected]>

This change adds the AArch64 target for host based unit tests. Signed-off-by: Kun Qin <[email protected]>

kuqin12 mentioned this pull request Jan 28, 2026

[Rebase & FF] Supporting unit test that runs on AArch64 microsoft/mu_basecore#1613

Closed

5 tasks

kuqin12 marked this pull request as ready for review January 28, 2026 09:04

tianocore-assign-reviewers Bot requested review from Li-Aaron, YuweiChen1110, gapalomi, lgao4, makubacki, mdkinney, mikebeaton, nate-desimone, pierregondois, ponchofigueroa, samimujawar, spbrogan and xuweiintel January 28, 2026 09:05

kuqin12 mentioned this pull request Feb 27, 2026

[Feature]: Support Host-Based Unit Tests on AArch64 platforms microsoft/mu_basecore#1514

Closed

github-actions Bot added the stale Due to lack of updates, this item is pending deletion. label Mar 29, 2026

github-actions Bot removed the stale Due to lack of updates, this item is pending deletion. label Mar 30, 2026

kuqin12 force-pushed the arm64_test branch from a90f219 to 0a95a6b Compare March 31, 2026 17:51

kuqin12 force-pushed the arm64_test branch from 0a95a6b to 70cf7ce Compare April 8, 2026 23:16

mdkinney reviewed Apr 9, 2026

View reviewed changes

Comment thread UnitTestFrameworkPkg/Test/GoogleTest/Sample/SampleGoogleTest/SampleGoogleTest.cpp Outdated

ardbiesheuvel reviewed Apr 10, 2026

View reviewed changes

Comment thread UnitTestFrameworkPkg/Library/UnitTestDebugAssertLib/UnitTestDebugAssertLibHost.inf Outdated

kuqin12 force-pushed the arm64_test branch 2 times, most recently from 1f0fc95 to 08ddeaa Compare April 16, 2026 23:09

kuqin12 force-pushed the arm64_test branch 3 times, most recently from 5d5cc39 to 3eb6d07 Compare April 29, 2026 23:14

pierregondois reviewed Apr 30, 2026

View reviewed changes

kuqin12 force-pushed the arm64_test branch from 3eb6d07 to e12084e Compare May 1, 2026 21:01

kuqin12 added 14 commits May 1, 2026 14:04

BaseTools: iasl: Update iasl binaries to 20230628 release

805c3f4

This change updates the iasl binary to the 20230628 release. The updated release also adds support for execution on ARM host machines. Signed-off-by: Kun Qin <[email protected]>

UnitTestFrameworkPkg: SampleGoogleTest: No divide-by-zero test for AA…

da19c08

…rch64 AArch64 does not have divide-by-zero exception. This change modifies the corresponding test to work with AArch64. Signed-off-by: Kun Qin <[email protected]>

UnitTestFrameworkPkg: CmockaLib: Support float operations

7cbbff3

This change adds the support of float operations for AArch64 host based unit tests by overriding the compiler flags. Signed-off-by: Kun Qin <[email protected]>

UnitTestFrameworkPkg: UnitTestDebugAssertLib: GCC support for AArch64

197b990

This change adds the GCC compiler flag for AArch64 targets. Signed-off-by: Kun Qin <[email protected]>

UnitTestFrameworkPkg: Test: Adding AArch64 target

ea5b2a6

This change adds the AArch64 target for host based unit tests. Signed-off-by: Kun Qin <[email protected]>

MdePkg: Host Test: Adding AArch64 target

2692a0e

This change adds the AArch64 target for host based unit tests. Signed-off-by: Kun Qin <[email protected]>

MdeModulePkg: Host Test: Adding AArch64 target

1cceca5

This change adds the AArch64 target for host based unit tests. Signed-off-by: Kun Qin <[email protected]>

FmpDevicePkg: Host Test: Adding AArch64 target

9cbd65a

This change adds the AArch64 target for host based unit tests. Signed-off-by: Kun Qin <[email protected]>

DynamicTablesPkg: Host Test: Adding AArch64 target

77a476d

This change adds the AArch64 target for host based unit tests. Signed-off-by: Kun Qin <[email protected]>

PrmPkg: Host Test: Adding AArch64 target

b501bb3

This change adds the AArch64 target for host based unit tests. Signed-off-by: Kun Qin <[email protected]>

kuqin12 force-pushed the arm64_test branch from e12084e to b501bb3 Compare May 1, 2026 21:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introducing host based unit tests on AArch64 systems#12070

Introducing host based unit tests on AArch64 systems#12070
kuqin12 wants to merge 14 commits intotianocore:masterfrom
kuqin12:arm64_test

kuqin12 commented Jan 28, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Mar 29, 2026

Uh oh!

mergify Bot commented Mar 29, 2026

Uh oh!

kuqin12 commented Mar 30, 2026

Uh oh!

Uh oh!

Uh oh!

pierregondois left a comment

Uh oh!

pierregondois Apr 30, 2026

Uh oh!

kuqin12 May 1, 2026

Uh oh!

pierregondois Apr 30, 2026

Uh oh!

kuqin12 May 1, 2026

Uh oh!

mdkinney May 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

kuqin12 commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How This Was Tested

Integration Instructions

Uh oh!

github-actions Bot commented Mar 29, 2026

Uh oh!

mergify Bot commented Mar 29, 2026

Uh oh!

kuqin12 commented Mar 30, 2026

Uh oh!

Uh oh!

Uh oh!

pierregondois left a comment

Choose a reason for hiding this comment

Uh oh!

pierregondois Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

kuqin12 May 1, 2026

Choose a reason for hiding this comment

Uh oh!

pierregondois Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

kuqin12 May 1, 2026

Choose a reason for hiding this comment

Uh oh!

mdkinney May 2, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kuqin12 commented Jan 28, 2026 •

edited

Loading