From cd95d29164d4219cfe92b84f2201189bcded4993 Mon Sep 17 00:00:00 2001
From: Changyuan Lyu <changyuanl@google.com>
Date: Sun, 23 Jun 2024 12:25:02 -0700
Subject: [PATCH] refactor(hvf): move Vm and Vcpu to sub modules

Signed-off-by: Changyuan Lyu <changyuanl@google.com>
---
 alioth/src/hv/hvf/hvf.rs       | 235 +--------------------------------
 alioth/src/hv/hvf/vcpu/vcpu.rs |  49 +++++++
 alioth/src/hv/hvf/vm.rs        | 211 +++++++++++++++++++++++++++++
 3 files changed, 266 insertions(+), 229 deletions(-)
 create mode 100644 alioth/src/hv/hvf/vcpu/vcpu.rs
 create mode 100644 alioth/src/hv/hvf/vm.rs

diff --git a/alioth/src/hv/hvf/hvf.rs b/alioth/src/hv/hvf/hvf.rs
index 92c6b0f..a57e8b8 100644
--- a/alioth/src/hv/hvf/hvf.rs
+++ b/alioth/src/hv/hvf/hvf.rs
@@ -12,243 +12,20 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use std::os::fd::{AsFd, BorrowedFd};
-use std::thread::JoinHandle;
+#[path = "vcpu/vcpu.rs"]
+mod vcpu;
+mod vm;
 
-use crate::arch::reg::{Reg, SReg};
-use crate::hv::{
-    GicV2, Hypervisor, IoeventFd, IoeventFdRegistry, IrqFd, IrqSender, MemMapOption, MsiSender,
-    Result, Vcpu, Vm, VmEntry, VmExit, VmMemory,
-};
+use crate::hv::{Hypervisor, Result, VmConfig};
 
-#[derive(Debug)]
-pub struct HvfVcpu {}
-
-impl Vcpu for HvfVcpu {
-    fn reset(&self, _is_bsp: bool) -> Result<()> {
-        unimplemented!()
-    }
-
-    fn dump(&self) -> Result<()> {
-        unimplemented!()
-    }
-
-    fn get_reg(&self, _reg: Reg) -> Result<u64> {
-        unimplemented!()
-    }
-
-    fn run(&mut self, _entry: VmEntry) -> Result<VmExit> {
-        unimplemented!()
-    }
-
-    fn set_regs(&mut self, _vals: &[(Reg, u64)]) -> Result<()> {
-        unimplemented!()
-    }
-
-    fn get_sreg(&self, _reg: SReg) -> Result<u64> {
-        unimplemented!()
-    }
-
-    fn set_sregs(&mut self, _sregs: &[(SReg, u64)]) -> Result<()> {
-        unimplemented!()
-    }
-}
-
-#[derive(Debug)]
-pub struct HvfMemory {}
-
-impl VmMemory for HvfMemory {
-    fn deregister_encrypted_range(&self, _range: &[u8]) -> Result<()> {
-        unimplemented!()
-    }
-    fn max_mem_slots(&self) -> Result<u32> {
-        unimplemented!()
-    }
-    fn mem_map(
-        &self,
-        _slot: u32,
-        _gpa: u64,
-        _size: u64,
-        _hva: usize,
-        _option: MemMapOption,
-    ) -> Result<()> {
-        unimplemented!()
-    }
-
-    fn register_encrypted_range(&self, _range: &[u8]) -> Result<()> {
-        unimplemented!()
-    }
-
-    fn unmap(&self, _slot: u32, _gpa: u64, _size: u64) -> Result<()> {
-        unimplemented!()
-    }
-
-    fn mark_private_memory(&self, _gpa: u64, _size: u64, _private: bool) -> Result<()> {
-        unimplemented!()
-    }
-}
-
-#[derive(Debug)]
-pub struct HvfIrqSender {}
-impl IrqSender for HvfIrqSender {
-    fn send(&self) -> Result<()> {
-        unimplemented!()
-    }
-}
-
-#[derive(Debug)]
-pub struct HvfIrqFd {}
-impl AsFd for HvfIrqFd {
-    fn as_fd(&self) -> BorrowedFd<'_> {
-        unimplemented!()
-    }
-}
-impl IrqFd for HvfIrqFd {
-    fn get_addr_hi(&self) -> u32 {
-        unimplemented!()
-    }
-    fn get_addr_lo(&self) -> u32 {
-        unimplemented!()
-    }
-    fn get_data(&self) -> u32 {
-        unimplemented!()
-    }
-    fn get_masked(&self) -> bool {
-        unimplemented!()
-    }
-    fn set_addr_hi(&self, _val: u32) -> Result<()> {
-        unimplemented!()
-    }
-    fn set_addr_lo(&self, _val: u32) -> Result<()> {
-        unimplemented!()
-    }
-    fn set_data(&self, _val: u32) -> Result<()> {
-        unimplemented!()
-    }
-    fn set_masked(&self, _val: bool) -> Result<()> {
-        unimplemented!()
-    }
-}
-
-#[derive(Debug)]
-pub struct HvfMsiSender {}
-
-impl MsiSender for HvfMsiSender {
-    type IrqFd = HvfIrqFd;
-    fn create_irqfd(&self) -> Result<Self::IrqFd> {
-        unimplemented!()
-    }
-    fn send(&self, _addr: u64, _data: u32) -> Result<()> {
-        unimplemented!()
-    }
-}
-
-#[derive(Debug)]
-pub struct HvfIoeventFd {}
-
-impl IoeventFd for HvfIoeventFd {}
-
-impl AsFd for HvfIoeventFd {
-    fn as_fd(&self) -> BorrowedFd<'_> {
-        unimplemented!()
-    }
-}
-
-#[derive(Debug)]
-pub struct HvfIoeventFdRegistry {}
-
-impl IoeventFdRegistry for HvfIoeventFdRegistry {
-    type IoeventFd = HvfIoeventFd;
-    fn create(&self) -> Result<Self::IoeventFd> {
-        unimplemented!()
-    }
-    fn deregister(&self, _fd: &Self::IoeventFd) -> Result<()> {
-        unimplemented!()
-    }
-    fn register(
-        &self,
-        _fd: &Self::IoeventFd,
-        _gpa: u64,
-        _len: u8,
-        _data: Option<u64>,
-    ) -> Result<()> {
-        unimplemented!()
-    }
-}
-
-#[derive(Debug)]
-pub struct HvfGicV2 {}
-
-impl GicV2 for HvfGicV2 {
-    fn init(&self) -> Result<()> {
-        unimplemented!()
-    }
-    fn get_dist_reg(&self, _cpu_index: u32, _offset: u16) -> Result<u32> {
-        unimplemented!()
-    }
-    fn set_dist_reg(&self, _cpu_index: u32, _offset: u16, _val: u32) -> Result<()> {
-        unimplemented!()
-    }
-    fn get_cpu_reg(&self, _cpu_index: u32, _offset: u16) -> Result<u32> {
-        unimplemented!()
-    }
-    fn set_cpu_reg(&self, _cpu_index: u32, _offset: u16, _val: u32) -> Result<()> {
-        unimplemented!()
-    }
-    fn get_num_irqs(&self) -> Result<u32> {
-        unimplemented!()
-    }
-    fn set_num_irqs(&self, _val: u32) -> Result<()> {
-        unimplemented!()
-    }
-}
-
-#[derive(Debug)]
-pub struct HvfVm {}
-
-impl Vm for HvfVm {
-    type Vcpu = HvfVcpu;
-    type Memory = HvfMemory;
-    type MsiSender = HvfMsiSender;
-    type IoeventFdRegistry = HvfIoeventFdRegistry;
-    fn create_ioeventfd_registry(&self) -> Result<Self::IoeventFdRegistry> {
-        unimplemented!()
-    }
-    fn create_msi_sender(&self) -> Result<Self::MsiSender> {
-        unimplemented!()
-    }
-    fn create_vcpu(&self, _id: u32) -> Result<Self::Vcpu> {
-        unimplemented!()
-    }
-    fn create_vm_memory(&mut self) -> Result<Self::Memory> {
-        unimplemented!()
-    }
-    fn stop_vcpu<T>(_id: u32, _handle: &JoinHandle<T>) -> Result<()> {
-        unimplemented!()
-    }
-
-    type GicV2 = HvfGicV2;
-
-    fn create_gic_v2(
-        &self,
-        _distributor_base: u64,
-        _cpu_interface_base: u64,
-    ) -> Result<Self::GicV2> {
-        unimplemented!()
-    }
-
-    type IrqSender = HvfIrqSender;
-    fn create_irq_sender(&self, _pin: u8) -> Result<Self::IrqSender> {
-        unimplemented!()
-    }
-}
+use vm::HvfVm;
 
 #[derive(Debug)]
 pub struct Hvf {}
 
 impl Hypervisor for Hvf {
     type Vm = HvfVm;
-    fn create_vm(&self, _config: &super::VmConfig) -> Result<Self::Vm> {
+    fn create_vm(&self, _config: &VmConfig) -> Result<Self::Vm> {
         unimplemented!()
     }
 }
diff --git a/alioth/src/hv/hvf/vcpu/vcpu.rs b/alioth/src/hv/hvf/vcpu/vcpu.rs
new file mode 100644
index 0000000..c728e96
--- /dev/null
+++ b/alioth/src/hv/hvf/vcpu/vcpu.rs
@@ -0,0 +1,49 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use crate::arch::reg::{Reg, SReg};
+use crate::hv::{Result, Vcpu, VmEntry, VmExit};
+
+#[derive(Debug)]
+pub struct HvfVcpu {}
+
+impl Vcpu for HvfVcpu {
+    fn reset(&self, _is_bsp: bool) -> Result<()> {
+        unimplemented!()
+    }
+
+    fn dump(&self) -> Result<()> {
+        unimplemented!()
+    }
+
+    fn get_reg(&self, _reg: Reg) -> Result<u64> {
+        unimplemented!()
+    }
+
+    fn run(&mut self, _entry: VmEntry) -> Result<VmExit> {
+        unimplemented!()
+    }
+
+    fn set_regs(&mut self, _vals: &[(Reg, u64)]) -> Result<()> {
+        unimplemented!()
+    }
+
+    fn get_sreg(&self, _reg: SReg) -> Result<u64> {
+        unimplemented!()
+    }
+
+    fn set_sregs(&mut self, _sregs: &[(SReg, u64)]) -> Result<()> {
+        unimplemented!()
+    }
+}
diff --git a/alioth/src/hv/hvf/vm.rs b/alioth/src/hv/hvf/vm.rs
new file mode 100644
index 0000000..cfa3498
--- /dev/null
+++ b/alioth/src/hv/hvf/vm.rs
@@ -0,0 +1,211 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::os::fd::{AsFd, BorrowedFd};
+use std::thread::JoinHandle;
+
+use crate::hv::hvf::vcpu::HvfVcpu;
+use crate::hv::{
+    GicV2, IoeventFd, IoeventFdRegistry, IrqFd, IrqSender, MemMapOption, MsiSender, Result, Vm,
+    VmMemory,
+};
+
+#[derive(Debug)]
+pub struct HvfMemory {}
+
+impl VmMemory for HvfMemory {
+    fn deregister_encrypted_range(&self, _range: &[u8]) -> Result<()> {
+        unimplemented!()
+    }
+    fn max_mem_slots(&self) -> Result<u32> {
+        unimplemented!()
+    }
+    fn mem_map(
+        &self,
+        _slot: u32,
+        _gpa: u64,
+        _size: u64,
+        _hva: usize,
+        _option: MemMapOption,
+    ) -> Result<()> {
+        unimplemented!()
+    }
+
+    fn register_encrypted_range(&self, _range: &[u8]) -> Result<()> {
+        unimplemented!()
+    }
+
+    fn unmap(&self, _slot: u32, _gpa: u64, _size: u64) -> Result<()> {
+        unimplemented!()
+    }
+
+    fn mark_private_memory(&self, _gpa: u64, _size: u64, _private: bool) -> Result<()> {
+        unimplemented!()
+    }
+}
+
+#[derive(Debug)]
+pub struct HvfIrqSender {}
+impl IrqSender for HvfIrqSender {
+    fn send(&self) -> Result<()> {
+        unimplemented!()
+    }
+}
+
+#[derive(Debug)]
+pub struct HvfIrqFd {}
+impl AsFd for HvfIrqFd {
+    fn as_fd(&self) -> BorrowedFd<'_> {
+        unimplemented!()
+    }
+}
+impl IrqFd for HvfIrqFd {
+    fn get_addr_hi(&self) -> u32 {
+        unimplemented!()
+    }
+    fn get_addr_lo(&self) -> u32 {
+        unimplemented!()
+    }
+    fn get_data(&self) -> u32 {
+        unimplemented!()
+    }
+    fn get_masked(&self) -> bool {
+        unimplemented!()
+    }
+    fn set_addr_hi(&self, _val: u32) -> Result<()> {
+        unimplemented!()
+    }
+    fn set_addr_lo(&self, _val: u32) -> Result<()> {
+        unimplemented!()
+    }
+    fn set_data(&self, _val: u32) -> Result<()> {
+        unimplemented!()
+    }
+    fn set_masked(&self, _val: bool) -> Result<()> {
+        unimplemented!()
+    }
+}
+
+#[derive(Debug)]
+pub struct HvfMsiSender {}
+
+impl MsiSender for HvfMsiSender {
+    type IrqFd = HvfIrqFd;
+    fn create_irqfd(&self) -> Result<Self::IrqFd> {
+        unimplemented!()
+    }
+    fn send(&self, _addr: u64, _data: u32) -> Result<()> {
+        unimplemented!()
+    }
+}
+
+#[derive(Debug)]
+pub struct HvfIoeventFd {}
+
+impl IoeventFd for HvfIoeventFd {}
+
+impl AsFd for HvfIoeventFd {
+    fn as_fd(&self) -> BorrowedFd<'_> {
+        unimplemented!()
+    }
+}
+
+#[derive(Debug)]
+pub struct HvfIoeventFdRegistry {}
+
+impl IoeventFdRegistry for HvfIoeventFdRegistry {
+    type IoeventFd = HvfIoeventFd;
+    fn create(&self) -> Result<Self::IoeventFd> {
+        unimplemented!()
+    }
+    fn deregister(&self, _fd: &Self::IoeventFd) -> Result<()> {
+        unimplemented!()
+    }
+    fn register(
+        &self,
+        _fd: &Self::IoeventFd,
+        _gpa: u64,
+        _len: u8,
+        _data: Option<u64>,
+    ) -> Result<()> {
+        unimplemented!()
+    }
+}
+
+#[derive(Debug)]
+pub struct HvfGicV2 {}
+
+impl GicV2 for HvfGicV2 {
+    fn init(&self) -> Result<()> {
+        unimplemented!()
+    }
+    fn get_dist_reg(&self, _cpu_index: u32, _offset: u16) -> Result<u32> {
+        unimplemented!()
+    }
+    fn set_dist_reg(&self, _cpu_index: u32, _offset: u16, _val: u32) -> Result<()> {
+        unimplemented!()
+    }
+    fn get_cpu_reg(&self, _cpu_index: u32, _offset: u16) -> Result<u32> {
+        unimplemented!()
+    }
+    fn set_cpu_reg(&self, _cpu_index: u32, _offset: u16, _val: u32) -> Result<()> {
+        unimplemented!()
+    }
+    fn get_num_irqs(&self) -> Result<u32> {
+        unimplemented!()
+    }
+    fn set_num_irqs(&self, _val: u32) -> Result<()> {
+        unimplemented!()
+    }
+}
+
+#[derive(Debug)]
+pub struct HvfVm {}
+
+impl Vm for HvfVm {
+    type Vcpu = HvfVcpu;
+    type Memory = HvfMemory;
+    type MsiSender = HvfMsiSender;
+    type IoeventFdRegistry = HvfIoeventFdRegistry;
+    fn create_ioeventfd_registry(&self) -> Result<Self::IoeventFdRegistry> {
+        unimplemented!()
+    }
+    fn create_msi_sender(&self) -> Result<Self::MsiSender> {
+        unimplemented!()
+    }
+    fn create_vcpu(&self, _id: u32) -> Result<Self::Vcpu> {
+        unimplemented!()
+    }
+    fn create_vm_memory(&mut self) -> Result<Self::Memory> {
+        unimplemented!()
+    }
+    fn stop_vcpu<T>(_id: u32, _handle: &JoinHandle<T>) -> Result<()> {
+        unimplemented!()
+    }
+
+    type GicV2 = HvfGicV2;
+
+    fn create_gic_v2(
+        &self,
+        _distributor_base: u64,
+        _cpu_interface_base: u64,
+    ) -> Result<Self::GicV2> {
+        unimplemented!()
+    }
+
+    type IrqSender = HvfIrqSender;
+    fn create_irq_sender(&self, _pin: u8) -> Result<Self::IrqSender> {
+        unimplemented!()
+    }
+}