Merge pull request #80 from Freax13/enhancement/cli-lib-stable

Freax13 · web-flow · commit 823cda5a21c5 · 2024-10-19T12:41:32.000+02:00
make it possible to build CLI on stable rust
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -75,6 +75,20 @@ jobs:
           TEE_TDX: ${{ matrix.tdx }}
           TEE_INSECURE: ${{ matrix.insecure }}
 
+  build-cli-on-stable:
+    name: "Build CLI on stable"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: Swatinem/rust-cache@v2
+        with:
+          key: build-cli-stable
+          workspaces: |
+            host
+      - name: "Build"
+        run: cargo +stable build --all-features
+        working-directory: host/mushroom
+
   clippy:
     name: "Clippy"
     runs-on: ubuntu-latest
diff --git a/common/constants/Cargo.toml b/common/constants/Cargo.toml
@@ -6,4 +6,4 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-x86_64 = "0.15.1"
+x86_64 = { version = "0.15.1", default-features = false }
diff --git a/common/loader/Cargo.toml b/common/loader/Cargo.toml
@@ -13,4 +13,4 @@ itertools = { version = "0.12.1", default-features = false }
 snp-types = { workspace = true }
 thiserror = { version = "1.0.58" }
 raw-cpuid = "11.0.1"
-x86_64 = "0.15.1"
+x86_64 = { version = "0.15.1", default-features = false }
diff --git a/common/loader/src/elf.rs b/common/loader/src/elf.rs
@@ -146,7 +146,7 @@ pub fn load_shadow_mapping(
             vmpl1_perms.set(VmplPermissions::WRITE, ph.is_write());
             vmpl1_perms &= vmpl1_perms_mask;
 
-            let mut iter = (start_page..=end_inclusive_page).peekable();
+            let mut iter = Page::range_inclusive(start_page, end_inclusive_page).peekable();
             from_fn(move || {
                 let page = iter.next()?;
 
diff --git a/common/profiler-types/Cargo.toml b/common/profiler-types/Cargo.toml
@@ -4,5 +4,5 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-bytemuck = { version = "1.15.0", features = ["derive"] }
+bytemuck = { version = "1.15.0", features = ["derive", "min_const_generics"] }
 constants = { workspace = true }
diff --git a/common/profiler-types/src/lib.rs b/common/profiler-types/src/lib.rs
@@ -2,7 +2,7 @@
 
 use core::{mem::size_of, sync::atomic::AtomicU8};
 
-use bytemuck::NoUninit;
+use bytemuck::{NoUninit, Zeroable};
 use constants::MAX_APS_COUNT;
 
 const NOTIFY_BITS: usize = MAX_APS_COUNT as usize;
@@ -44,14 +44,14 @@ pub const PROFILER_ENTRIES: usize = {
     entries
 };
 
-#[derive(Clone, Copy, NoUninit)]
+#[derive(Clone, Copy, Zeroable, NoUninit)]
 #[repr(C, align(16))]
 pub struct Entry {
     pub time: u64,
     pub event: u64,
 }
 
-#[derive(Clone, Copy)]
+#[derive(Clone, Copy, Zeroable)]
 #[repr(C, align(64))]
 pub struct PerCpuEntries {
     pub entries: [Entry; PROFILER_ENTRIES],
diff --git a/common/snp-types/Cargo.toml b/common/snp-types/Cargo.toml
@@ -10,4 +10,4 @@ bitflags = { version = "2.4.2", features = ["bytemuck"] }
 bit_field = "0.10.2"
 bytemuck = { version = "1.15.0", features = ["derive", "min_const_generics"] }
 paste = "1.0.14"
-x86_64 = "0.15.1"
+x86_64 = { version = "0.15.1", default-features = false }
diff --git a/common/tdx-types/Cargo.toml b/common/tdx-types/Cargo.toml
@@ -11,7 +11,7 @@ p256 = { version = "0.13.2", optional = true }
 sha2 = { version = "0.10.8", optional = true }
 thiserror = { version = "1.0.64", optional = true }
 x509-cert = { version = "0.2.5", features = ["pem"], default-features = false, optional = true }
-x86_64 = "0.15.1"
+x86_64 = { version = "0.15.1", default-features = false }
 
 [features]
 std = ["bytemuck/extern_crate_std", "x509-cert?/std"]
diff --git a/host/mushroom-verify/Cargo.toml b/host/mushroom-verify/Cargo.toml
@@ -12,7 +12,7 @@ sha2 = "0.10.8"
 snp-types = { workspace = true, optional = true }
 vcek-kds = { workspace = true, optional = true }
 tdx-types = { workspace = true, features = ["quote"], optional = true }
-x86_64 = { version = "0.15.1", optional = true }
+x86_64 = { version = "0.15.1", default-features = false, optional = true }
 
 [features]
 default = ["snp", "tdx"]
diff --git a/host/mushroom-verify/src/lib.rs b/host/mushroom-verify/src/lib.rs
@@ -1,5 +1,3 @@
-#![feature(array_chunks)]
-
 use io::input::Header;
 use sha2::{Digest, Sha256};
 
diff --git a/host/mushroom-verify/src/tdx.rs b/host/mushroom-verify/src/tdx.rs
@@ -50,9 +50,9 @@ impl Configuration {
 
             for (i, page) in pages.drain(..).enumerate() {
                 let gpa = gpa + i as u64;
-                for (j, chunk) in page.array_chunks().enumerate() {
+                for (j, chunk) in page.chunks(256).enumerate() {
                     let gpa = gpa.start_address() + (j * chunk.len()) as u64;
-                    mr_extend(&mut hasher, gpa, chunk);
+                    mr_extend(&mut hasher, gpa, chunk.try_into().unwrap());
                 }
             }
         }
diff --git a/host/mushroom/Cargo.toml b/host/mushroom/Cargo.toml
@@ -35,5 +35,5 @@ tokio = { version = "1.36.0", features = ["fs", "macros", "rt-multi-thread"], op
 tracing = "0.1.40"
 tracing-subscriber = { version = "0.3.18", optional = true }
 vcek-kds = { workspace = true, optional = true }
-volatile = { version = "0.5.1", features = ["unstable"] }
-x86_64 = "0.15.1"
+volatile = { version = "0.5.1", features = [] }
+x86_64 = { version = "0.15.1", default-features = false }
diff --git a/host/mushroom/src/lib.rs b/host/mushroom/src/lib.rs
@@ -1,16 +1,9 @@
-#![feature(new_zeroed_alloc)]
-
-use std::{collections::HashMap, num::NonZeroU32, ptr::NonNull};
+use std::{collections::HashMap, num::NonZeroU32};
 
 use anyhow::{Context, Result};
 use bit_field::BitField;
-use bytemuck::NoUninit;
 use kvm::KvmCap;
 use slot::Slot;
-use volatile::{
-    access::{ReadOnly, Readable},
-    VolatilePtr,
-};
 use x86_64::structures::paging::PhysFrame;
 
 #[cfg(feature = "insecure")]
@@ -72,26 +65,6 @@ fn find_slot(gpa: PhysFrame, slots: &mut HashMap<u16, Slot>) -> Result<&mut Slot
         .context("failed to find slot which contains ghcb")
 }
 
-/// The volatile equivalent of `bytemuck::bytes_of`.
-fn volatile_bytes_of<T>(ptr: VolatilePtr<T, impl Readable>) -> VolatilePtr<[u8], ReadOnly>
-where
-    T: NoUninit,
-{
-    let data = ptr.as_raw_ptr().as_ptr().cast::<u8>();
-    let ptr = core::ptr::slice_from_raw_parts_mut(data, size_of::<T>());
-    let ptr = unsafe {
-        // SAFETY: We got originially the pointer from a `NonNull` and only
-        // casted it to another type and added size metadata.
-        NonNull::new_unchecked(ptr)
-    };
-    unsafe {
-        // SAFETY: `ptr` points to a valid `T` and its `NoUninit`
-        // implementation promises us that it's safe to view the data as a
-        // slice of bytes.
-        VolatilePtr::new_read_only(ptr)
-    }
-}
-
 fn is_efault(err: &anyhow::Error) -> bool {
     err.downcast_ref::<nix::Error>()
         .is_some_and(|&err| err == nix::Error::EFAULT)
diff --git a/host/mushroom/src/profiler.rs b/host/mushroom/src/profiler.rs
@@ -11,7 +11,7 @@ use std::{
 use anyhow::{ensure, Context, Error, Result};
 use bit_field::BitField;
 use bitflags::bitflags;
-use bytemuck::{bytes_of, cast_slice, NoUninit};
+use bytemuck::{bytes_of, cast_slice, zeroed_box, NoUninit};
 use constants::MAX_APS_COUNT;
 use profiler_types::{AllEntries, Entry, PerCpuEntries, ProfilerControl, CALL_STACK_CAPACITY};
 use rand::random;
@@ -193,8 +193,7 @@ fn collector_thread(
     control: Arc<CollectorThreadControl>,
     dat_files: Arc<[Mutex<File>]>,
 ) {
-    let buffer = Box::<PerCpuEntries>::new_zeroed();
-    let mut buffer = unsafe { buffer.assume_init() };
+    let mut buffer = zeroed_box::<PerCpuEntries>();
 
     let mut guard = control.notify.lock().unwrap();
 
diff --git a/host/mushroom/src/snp.rs b/host/mushroom/src/snp.rs
@@ -7,6 +7,7 @@ use std::{
 
 use anyhow::{bail, Context, Result};
 use bit_field::BitField;
+use bytemuck::{bytes_of, pod_read_unaligned};
 use constants::{
     physical_address::{kernel, supervisor, DYNAMIC_2MIB},
     FINISH_OUTPUT_MSR, FIRST_AP, KICK_AP_PORT, MAX_APS_COUNT, MEMORY_PORT, UPDATE_OUTPUT_MSR,
@@ -28,7 +29,7 @@ use crate::{
     logging::start_log_collection,
     profiler::{start_profile_collection, ProfileFolder},
     slot::Slot,
-    volatile_bytes_of, MushroomResult,
+    MushroomResult,
 };
 
 #[allow(clippy::too_many_arguments)]
@@ -254,13 +255,11 @@ impl VmContext {
                 KvmExit::Io(io) => {
                     assert_eq!(io.size, 4, "accesses to the ports should have size 4");
 
-                    let data = volatile_bytes_of(kvm_run);
-                    let data = data
-                        .index(io.data_offset as usize..)
-                        .index(..usize::from(io.size));
-                    let mut buffer = [0; 4];
-                    data.copy_into_slice(&mut buffer);
-                    let value = u32::from_ne_bytes(buffer);
+                    let raw_kvm_run = kvm_run.read();
+                    let raw_kvm_run = bytes_of(&raw_kvm_run);
+                    let value = pod_read_unaligned::<u32>(
+                        &raw_kvm_run[io.data_offset as usize..][..usize::from(io.size)],
+                    );
 
                     match io.port {
                         MEMORY_PORT => {
diff --git a/host/mushroom/src/tdx.rs b/host/mushroom/src/tdx.rs
@@ -12,7 +12,7 @@ use std::{
 
 use anyhow::{bail, ensure, Context, Result};
 use bit_field::BitField;
-use bytemuck::checked::try_pod_read_unaligned;
+use bytemuck::{bytes_of, checked::try_pod_read_unaligned, pod_read_unaligned};
 use constants::{
     physical_address::{kernel, supervisor, DYNAMIC_2MIB},
     FINISH_OUTPUT_MSR, MAX_APS_COUNT, MEMORY_PORT, UPDATE_OUTPUT_MSR,
@@ -37,7 +37,7 @@ use crate::{
     logging::start_log_collection,
     profiler::{start_profile_collection, ProfileFolder},
     slot::Slot,
-    volatile_bytes_of, MushroomResult, TSC_MHZ,
+    MushroomResult, TSC_MHZ,
 };
 
 /// The signal used to kick threads out of KVM_RUN.
@@ -317,13 +317,11 @@ impl VmContext {
                 KvmExit::Io(io) => {
                     assert_eq!(io.size, 4, "accesses to the ports should have size 4");
 
-                    let data = volatile_bytes_of(kvm_run);
-                    let data = data
-                        .index(io.data_offset as usize..)
-                        .index(..usize::from(io.size));
-                    let mut buffer = [0; 4];
-                    data.copy_into_slice(&mut buffer);
-                    let value = u32::from_ne_bytes(buffer);
+                    let raw_kvm_run = kvm_run.read();
+                    let raw_kvm_run = bytes_of(&raw_kvm_run);
+                    let value = pod_read_unaligned::<u32>(
+                        &raw_kvm_run[io.data_offset as usize..][..usize::from(io.size)],
+                    );
 
                     match io.port {
                         MEMORY_PORT => {

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-#![feature(array_chunks)]`
`2`		`-`
`3`	`1`	`use io::input::Header;`
`4`	`2`	`use sha2::{Digest, Sha256};`
`5`	`3`