Initial implementation of supervisor

[kuqin12]

Description

This is the initial implementation of MM supervisor and user core in Rust.

• Impacts functionality?
• Impacts security?
• Breaking change?
• Includes tests?
• Includes documentation?

How This Was Tested

This was tested on QEMU Q35 platform and booted to OS desktop as well as passed supervisor test app.

Integration Instructions

The integration guide is listed in: https://github.com/kuqin12/mu_feature_mm_supv/blob/personal/kuqin/supv_init/SeaPkg/Docs/PlatformIntegration/PlatformIntegrationSteps.md#integraion-guide-for-rust-based-supervisor. Because it provides the implementation of MM supervisor init module.

[patina-automation]

QEMU Validation Failed

QEMU validation did not complete successfully or did not shutdown as expected.

Workflow run: https://github.com/OpenDevicePartnership/patina/actions/runs/28404973648

⚠️ Build Failure Detected

The Setup and Build patina-dxe-core-qemu step failed in the following job(s):

• Run Patina QEMU Validation / Validate QEMU - ArmVirt (Linux)
• Run Patina QEMU Validation / Validate QEMU Q35 (Windows)
• Run Patina QEMU Validation / Validate QEMU - Q35 (Linux)

Build logs are available in the workflow run artifacts:

• qemu-validation-logs-Windows-Q35
• qemu-validation-logs-Linux-ArmVirt
• qemu-validation-logs-Linux-Q35

Download the log artifacts from the workflow run to review the build output and
determine whether the error is expected.

Is this expected? If the PR introduces breaking changes to patina that
require a corresponding update to patina-dxe-core-qemu,
the build failure is expected.

Contact a repo admin or PR reviewer to override the Patina QEMU PR Validation status check.

Job Results

Job	Result
Gather Incoming PR Metadata	✅
Run Patina QEMU Validation / Post In-Progress Notification	✅
Run Patina QEMU Validation / Preflight Checks	✅
Run Patina QEMU Validation / Get Constants / Get Repository Constants	✅
Run Patina QEMU Validation / Validate QEMU - ArmVirt (Linux)	❌
Run Patina QEMU Validation / Validate QEMU Q35 (Windows)	❌
Run Patina QEMU Validation / Validate QEMU - Q35 (Linux)	❌
Run Patina QEMU Validation / Emit PR Metadata	✅

Error Details

qemu-validation-logs-Linux-ArmVirt/armvirt-linux.log (8 error/warning sections)

warning: patch `patina_mm_supervisor v22.0.1 (/__w/patina/patina/patina_mm_supervisor)` was not used in the crate graph

warning: patch `patina_mm_user_core v22.0.1 (/__w/patina/patina/patina_mm_user_core)` was not used in the crate graph
help: Check that the patched package version and available features are compatible

warning: patch `patina_mm_supervisor v22.0.1 (/__w/patina/patina/patina_mm_supervisor)` was not used in the crate graph

warning: patch `patina_mm_user_core v22.0.1 (/__w/patina/patina/patina_mm_user_core)` was not used in the crate graph
help: Check that the patched package version and available features are compatible

error[E0308]: mismatched types
   --> src/q35/component/service/smbios_test.rs:45:49
    |
 45 |         boot_services.locate_protocol_unchecked(&SMBIOS_PROTOCOL_GUID, core::ptr::null_mut()).map_err(|e| {
    |                       ------------------------- ^^^^^^^^^^^^^^^^^^^^^ expected `r_efi::base::Guid`, found `r_efi::efi::Guid`
    |                       |
    |                       arguments to this method are incorrect
    |
note: there are multiple different versions of crate `r_efi` in the dependency graph
   --> /.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/r-efi-6.0.0/src/base.rs:392:1
    |
392 | pub struct Guid {
    | ^^^^^^^^^^^^^^^ this is the expected type
    |
   ::: /.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/r-efi-7.0.0/src/base.rs:392:1
    |
392 | pub struct Guid {
    | --------------- this is the found type
    = help: you can use `cargo tree` to explore your dependency tree
note: method defined here
   --> /__w/patina/patina/sdk/patina/src/boot_services.rs:826:15
    |
826 |     unsafe fn locate_protocol_unchecked(
    |               ^^^^^^^^^^^^^^^^^^^^^^^^^

For more information about this error, try `rustc --explain E0308`.

error: could not compile `qemu_dxe_core` (lib) due to 1 previous error

warning: build failed, waiting for other jobs to finish...

[cargo-make] ERROR - Error while running duckscript: Source: Unknown Line: 113 - Error while executing command, exit code: 101

qemu-validation-logs-Windows-Q35/q35-windows.log (8 error/warning sections)

warning: patch `patina_mm_supervisor v22.0.1 (D:\a\patina\patina\patina_mm_supervisor)` was not used in the crate graph

warning: patch `patina_mm_user_core v22.0.1 (D:\a\patina\patina\patina_mm_user_core)` was not used in the crate graph
help: Check that the patched package version and available features are compatible

warning: patch `patina_mm_supervisor v22.0.1 (D:\a\patina\patina\patina_mm_supervisor)` was not used in the crate graph

warning: patch `patina_mm_user_core v22.0.1 (D:\a\patina\patina\patina_mm_user_core)` was not used in the crate graph
help: Check that the patched package version and available features are compatible

error[E0308]: mismatched types
   --> src\q35\component\service\smbios_test.rs:45:49
    |
 45 |         boot_services.locate_protocol_unchecked(&SMBIOS_PROTOCOL_GUID, core::ptr::null_mut()).map_err(|e| {
    |                       ------------------------- ^^^^^^^^^^^^^^^^^^^^^ expected `r_efi::base::Guid`, found `r_efi::efi::Guid`
    |                       |
    |                       arguments to this method are incorrect
    |
note: there are multiple different versions of crate `r_efi` in the dependency graph
   --> C:\Users\runneradmin\.cargo\registry\src\index.crates.io-1949cf8c6b5b557f\r-efi-6.0.0\src\base.rs:392:1
    |
392 | pub struct Guid {
    | ^^^^^^^^^^^^^^^ this is the expected type
    |
   ::: C:\Users\runneradmin\.cargo\registry\src\index.crates.io-1949cf8c6b5b557f\r-efi-7.0.0\src\base.rs:392:1
    |
392 | pub struct Guid {
    | --------------- this is the found type
    = help: you can use `cargo tree` to explore your dependency tree
note: method defined here
   --> D:\a\patina\patina\sdk\patina\src\boot_services.rs:826:15
    |
826 |     unsafe fn locate_protocol_unchecked(
    |               ^^^^^^^^^^^^^^^^^^^^^^^^^

For more information about this error, try `rustc --explain E0308`.

error: could not compile `qemu_dxe_core` (lib) due to 1 previous error

warning: build failed, waiting for other jobs to finish...

[cargo-make] ERROR - Error while running duckscript: Source: Unknown Line: 113 - Error while executing command, exit code: 101

qemu-validation-logs-Linux-Q35/q35-linux.log (8 error/warning sections)

warning: patch `patina_mm_supervisor v22.0.1 (/__w/patina/patina/patina_mm_supervisor)` was not used in the crate graph

warning: patch `patina_mm_user_core v22.0.1 (/__w/patina/patina/patina_mm_user_core)` was not used in the crate graph
help: Check that the patched package version and available features are compatible

warning: patch `patina_mm_supervisor v22.0.1 (/__w/patina/patina/patina_mm_supervisor)` was not used in the crate graph

warning: patch `patina_mm_user_core v22.0.1 (/__w/patina/patina/patina_mm_user_core)` was not used in the crate graph
help: Check that the patched package version and available features are compatible

error[E0308]: mismatched types
   --> src/q35/component/service/smbios_test.rs:45:49
    |
 45 |         boot_services.locate_protocol_unchecked(&SMBIOS_PROTOCOL_GUID, core::ptr::null_mut()).map_err(|e| {
    |                       ------------------------- ^^^^^^^^^^^^^^^^^^^^^ expected `r_efi::base::Guid`, found `r_efi::efi::Guid`
    |                       |
    |                       arguments to this method are incorrect
    |
note: there are multiple different versions of crate `r_efi` in the dependency graph
   --> /.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/r-efi-6.0.0/src/base.rs:392:1
    |
392 | pub struct Guid {
    | ^^^^^^^^^^^^^^^ this is the expected type
    |
   ::: /.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/r-efi-7.0.0/src/base.rs:392:1
    |
392 | pub struct Guid {
    | --------------- this is the found type
    = help: you can use `cargo tree` to explore your dependency tree
note: method defined here
   --> /__w/patina/patina/sdk/patina/src/boot_services.rs:826:15
    |
826 |     unsafe fn locate_protocol_unchecked(
    |               ^^^^^^^^^^^^^^^^^^^^^^^^^

For more information about this error, try `rustc --explain E0308`.

error: could not compile `qemu_dxe_core` (lib) due to 1 previous error

warning: build failed, waiting for other jobs to finish...

[cargo-make] ERROR - Error while running duckscript: Source: Unknown Line: 113 - Error while executing command, exit code: 101

Dependencies

Repository	Ref
patina	d3a06ea
patina-dxe-core-qemu	fb2e07f
patina-fw-patcher	5b82a50
patina-qemu firmware	v4.0.1
patina-qemu build script	cf7af08

This comment was automatically generated by the Patina QEMU PR Validation Post workflow.

[Javagedes]

I'm very concerned about the number of global statics in your implementation. I understand it may actually be necessary to be able to perform our SEA validation on the supervisor.

We need to consolidate the statics if possible. If we cannot (due to SEA validation requirements), then we need to make trait abstractions around each of the different statics so that at runtime they all link up, but for testing you can use mockall to mock the different statics. e.g. something like:

static MY_STATIC: SomeStatic = SomeStatic::new();

trait MyTrait {
    fn interface_fn1();
    fn interface_fn2();
}

impl MyTrait for SomeStatic {
    fn interface_fn1() { MY_STATIC.interface_fn1() }
    fn interface_fn2() { MY_STATIC.interface_fn2() }
}

This will allow us to use mockall with the trait to do proper mocking.

[kuqin12]

Binary level PR: OpenDevicePartnership/patina-dxe-core-qemu#162

[codecov]

Codecov Report

❌ Patch coverage is 26.68616% with 3761 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
patina_mm_supervisor/src/mem/page_allocator.rs	1.61%	429 Missing ⚠️
patina_mm_user_core/src/mm_services.rs	0.00%	423 Missing ⚠️
...upervisor/src/privilege_mgmt/syscall_dispatcher.rs	4.89%	350 Missing ⚠️
patina_mm_supervisor/src/mm_policy/gate.rs	3.99%	265 Missing ⚠️
patina_mm_supervisor/src/mm_policy/helpers.rs	6.38%	220 Missing ⚠️
patina_mm_supervisor/src/save_state.rs	21.43%	220 Missing ⚠️
patina_mm_user_core/src/lib.rs	0.00%	186 Missing ⚠️
...supervisor_handlers/supv_request/unblock_memory.rs	51.98%	170 Missing ⚠️
patina_mm_user_core/src/mmi.rs	0.00%	155 Missing ⚠️
patina_mm_user_core/src/mm_dispatcher.rs	0.00%	149 Missing ⚠️
... and 25 more

📢 Thoughts on this report? Let us know!