feat(opentmk): opentmk framework with first testcase #1210
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Copyright (c) Microsoft Corporation. | ||
| # Licensed under the MIT License. | ||
|
|
||
| [package] | ||
| name = "opentmk" | ||
| edition.workspace = true | ||
| rust-version.workspace = true | ||
|
|
||
| [features] | ||
| default = ["nightly"] | ||
|
||
| nightly = ["x86_64-nightly"] | ||
| x86_64-nightly = ["x86_64/nightly"] | ||
|
|
||
| [dependencies] | ||
smalis-msft marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| arrayvec.workspace = true | ||
| bitfield-struct.workspace = true | ||
| cfg-if.workspace = true | ||
| hvdef = {workspace = true} | ||
| iced-x86 = { workspace = true, features = ["decoder", "nasm", "no_std"]} | ||
| lazy_static = { workspace = true, features = ["spin_no_std"] } | ||
| linked_list_allocator.workspace = true | ||
| log.workspace = true | ||
| memory_range.workspace = true | ||
| minimal_rt.workspace = true | ||
| spin.workspace = true | ||
| serde = { version = "1.0", default-features = false, features = ["derive"]} | ||
| serde_json = { version = "1.0", default-features = false, features = ["alloc"] } | ||
| thiserror.workspace = true | ||
| uefi = { workspace = true, features = ["alloc"] } | ||
| x86_64 = { workspace = true, features = ["instructions"] } | ||
| x86defs.workspace = true | ||
| zerocopy.workspace = true | ||
| nostd_spin_channel.workspace = true | ||
|
|
||
| [lints] | ||
| workspace = true | ||
|
|
||
| [build-dependencies] | ||
| minimal_rt_build.workspace = true | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # OpenTMK | ||
|
|
||
| See the guide for more info on how to build/run the code in this crate. | ||
smalis-msft marked this conversation as resolved.
Show resolved
Hide resolved
|
||
smalis-msft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| RUST_BACKTRACE=1 CARGO_PROFILE_RELEASE_force_frame_pointers=yes cargo build -p opentmk --target x86_64-unknown-uefi --release #--target-dir ./target/x86_64-unknown-uefi/debug | ||
|
||
| cargo xtask guest-test uefi --bootx64 ~/projects-local/openvmm/target/x86_64-unknown-uefi/release/opentmk.efi | ||
| qemu-img convert -f raw -O vhdx ~/projects-local/openvmm/target/x86_64-unknown-uefi/release/opentmk.img ~/projects/opentmk.vhdx | ||
| #CARGO_PROFILE_RELEASE_OPT_LEVEL=0 | ||
| #+nightly-2025-05-09 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| imports_granularity = "Item" # Expands `use foo::{bar, baz};` into separate `use` lines | ||
|
||
| reorder_imports = true # Optional: sort imports | ||
| normalize_imports = true # Optional: standardize style (e.g., remove leading ::) | ||
| group_imports = "StdExternalCrate" # Optional: group std/external/local with blank lines | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| /// Writes a synthehtic register to tell the hypervisor the OS ID. | ||
mayank-microsoft marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| fn report_os_id(guest_os_id: u64) { | ||
| // On ARM64, to be able to make hypercalls, one needs first to set the Guest OS ID | ||
| // synthetic register using a hypercall. Can't use `Hvcall::set_register` at that will | ||
| // lead to the infinite recursion as that function will first try initializing hypercalls | ||
| // with setting a register. | ||
| // | ||
| // Only one very specific HvSetVpRegisters hypercall is allowed to set the Guest OS ID | ||
| // (this is TLFS section 17.4.4.1.1 and 5.3), and that must be the fast hypercall. | ||
| let _ = minimal_rt::arch::hypercall::set_register_fast( | ||
| hvdef::HvArm64RegisterName::GuestOsId.into(), | ||
| guest_os_id.into(), | ||
| ); | ||
| } | ||
|
|
||
| pub(crate) fn initialize(guest_os_id: u64) { | ||
| // We are assuming we are running under a Microsoft hypervisor. | ||
| report_os_id(guest_os_id); | ||
| } | ||
|
|
||
| /// Call before jumping to kernel. | ||
| pub(crate) fn uninitialize() { | ||
| report_os_id(0); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| pub mod hypercall; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| //! Imports and re-exports architecture-specific implementations. | ||
|
|
||
| cfg_if::cfg_if!( | ||
| if #[cfg(target_arch = "x86_64")] { | ||
| mod x86_64; | ||
| pub use x86_64::*; | ||
| } else if #[cfg(target_arch = "aarch64")] { | ||
| mod aarch64; | ||
| pub use aarch64::*; | ||
| } else { | ||
| compile_error!("target_arch is not supported"); | ||
| } | ||
| ); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| #![expect(unsafe_code)] | ||
|
Member
There was a problem hiding this comment. please annotate why we have unsafe in each file we allow it
Contributor
Author
There was a problem hiding this comment. I've fixed it as a part of lint fixes. maybe it's an older commit? |
||
|
|
||
| use core::ptr::addr_of; | ||
|
|
||
| use hvdef::HV_PAGE_SIZE; | ||
| use minimal_rt::arch::hypercall::HYPERCALL_PAGE; | ||
| use minimal_rt::arch::msr::read_msr; | ||
| use minimal_rt::arch::msr::write_msr; | ||
|
|
||
| /// Writes an MSR to tell the hypervisor the OS ID. | ||
| fn report_os_id(guest_os_id: u64) { | ||
| // SAFETY: Using the contract established in the Hyper-V TLFS. | ||
| unsafe { | ||
| write_msr(hvdef::HV_X64_MSR_GUEST_OS_ID, guest_os_id); | ||
| }; | ||
| } | ||
|
|
||
| /// Writes an MSR to tell the hypervisor where the hypercall page is | ||
| pub fn write_hypercall_msr(enable: bool) { | ||
| // SAFETY: Using the contract established in the Hyper-V TLFS. | ||
| let hypercall_contents = hvdef::hypercall::MsrHypercallContents::from(unsafe { | ||
| read_msr(hvdef::HV_X64_MSR_HYPERCALL) | ||
| }); | ||
|
|
||
| let hypercall_page_num = addr_of!(HYPERCALL_PAGE) as u64 / HV_PAGE_SIZE; | ||
|
|
||
| if !(!enable || !hypercall_contents.enable()) { | ||
| return; | ||
| } | ||
| let new_hv_contents: hvdef::hypercall::MsrHypercallContents = hypercall_contents | ||
| .with_enable(enable) | ||
| .with_gpn(if enable { hypercall_page_num } else { 0 }); | ||
|
|
||
| // SAFETY: Using the contract established in the Hyper-V TLFS. | ||
| unsafe { write_msr(hvdef::HV_X64_MSR_HYPERCALL, new_hv_contents.into()) }; | ||
| } | ||
|
|
||
| /// Has to be called before using hypercalls. | ||
| pub fn initialize(guest_os_id: u64) { | ||
| // We are assuming we are running under a Microsoft hypervisor, so there is | ||
| // no need to check any cpuid leaves. | ||
| report_os_id(guest_os_id); | ||
| write_hypercall_msr(true); | ||
| } | ||
|
|
||
| /// Call to uninitialize hypercalL page overlay | ||
| pub fn uninitialize() { | ||
|
Contributor
There was a problem hiding this comment. Do we need uninitialize? Do we ever call it and/or jump to an OS kernel?
Contributor
Author
There was a problem hiding this comment. Its just for sanity if we do need to uninit the hypercall pages. |
||
| write_hypercall_msr(false); | ||
| report_os_id(0); | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we unify on the same version of spin that lazy_static is pulling in, so we only have the one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will work on versioning and package related changes as I resolve the merge conflicts.