From 9aef904d24570b4fdb71caba57a93ba185950091 Mon Sep 17 00:00:00 2001 From: Putta Khunchalee Date: Sun, 10 Nov 2024 01:26:06 +0700 Subject: [PATCH] Initializes MMIO implementation for HVF (#1091) --- Cargo.toml | 1 + arch/aarch64/Cargo.toml | 7 ++ arch/aarch64/LICENSE-APACHE | 202 ++++++++++++++++++++++++++++++++++ arch/aarch64/LICENSE-MIT | 17 +++ arch/aarch64/src/exception.rs | 23 ++++ arch/aarch64/src/lib.rs | 5 + gui/Cargo.toml | 3 + gui/src/vmm/hv/macos/cpu.rs | 18 ++- gui/src/vmm/hv/macos/mod.rs | 20 +++- 9 files changed, 293 insertions(+), 3 deletions(-) create mode 100644 arch/aarch64/Cargo.toml create mode 100644 arch/aarch64/LICENSE-APACHE create mode 100644 arch/aarch64/LICENSE-MIT create mode 100644 arch/aarch64/src/exception.rs create mode 100644 arch/aarch64/src/lib.rs diff --git a/Cargo.toml b/Cargo.toml index 8ef8783f..91c31c01 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,7 @@ [workspace] resolver = "2" members = [ + "arch/aarch64", "arch/x86-64", "gui", "kernel", diff --git a/arch/aarch64/Cargo.toml b/arch/aarch64/Cargo.toml new file mode 100644 index 00000000..cd9b44ce --- /dev/null +++ b/arch/aarch64/Cargo.toml @@ -0,0 +1,7 @@ +[package] +name = "aarch64" +version = "0.1.0" +edition = "2021" + +[dependencies] +bitfield-struct = "0.9.2" diff --git a/arch/aarch64/LICENSE-APACHE b/arch/aarch64/LICENSE-APACHE new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/arch/aarch64/LICENSE-APACHE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + http://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. diff --git a/arch/aarch64/LICENSE-MIT b/arch/aarch64/LICENSE-MIT new file mode 100644 index 00000000..969d061e --- /dev/null +++ b/arch/aarch64/LICENSE-MIT @@ -0,0 +1,17 @@ +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/arch/aarch64/src/exception.rs b/arch/aarch64/src/exception.rs new file mode 100644 index 00000000..66b78d78 --- /dev/null +++ b/arch/aarch64/src/exception.rs @@ -0,0 +1,23 @@ +use bitfield_struct::bitfield; + +/// Raw value of `VBAR_EL1`. +#[bitfield(u64)] +pub struct Vbar { + #[bits(11)] + __: u16, + #[bits(53)] + pub addr: u64, +} + +/// Raw value of `ESR_EL1`, `ESR_EL2` and `ESR_EL3`. +#[bitfield(u64)] +pub struct Esr { + #[bits(25)] + pub iss: u32, + pub il: bool, + #[bits(6)] + pub ec: u8, + #[bits(24)] + pub iss2: u32, + __: u8, +} diff --git a/arch/aarch64/src/lib.rs b/arch/aarch64/src/lib.rs new file mode 100644 index 00000000..73c239ec --- /dev/null +++ b/arch/aarch64/src/lib.rs @@ -0,0 +1,5 @@ +#![no_std] + +pub use self::exception::*; + +mod exception; diff --git a/gui/Cargo.toml b/gui/Cargo.toml index 30429df2..38e717ea 100644 --- a/gui/Cargo.toml +++ b/gui/Cargo.toml @@ -21,6 +21,9 @@ serde = { version = "1.0.209", features = ["derive"] } thiserror = "1.0" uuid = { version = "1.10.0", features = ["serde", "v4"] } +[target.'cfg(target_arch = "aarch64")'.dependencies] +aarch64 = { path = "../arch/aarch64" } + [target.'cfg(target_arch = "x86_64")'.dependencies] x86-64 = { path = "../arch/x86-64" } diff --git a/gui/src/vmm/hv/macos/cpu.rs b/gui/src/vmm/hv/macos/cpu.rs index 59eb95a4..bfa09bf9 100644 --- a/gui/src/vmm/hv/macos/cpu.rs +++ b/gui/src/vmm/hv/macos/cpu.rs @@ -1,5 +1,7 @@ // SPDX-License-Identifier: MIT OR Apache-2.0 use crate::vmm::hv::{Cpu, CpuCommit, CpuDebug, CpuExit, CpuIo, CpuRun, CpuStates, IoBuf}; +use aarch64::Esr; +use applevisor_sys::hv_exit_reason_t::HV_EXIT_REASON_EXCEPTION; use applevisor_sys::hv_reg_t::{HV_REG_CPSR, HV_REG_PC, HV_REG_X0, HV_REG_X1}; use applevisor_sys::hv_sys_reg_t::{ HV_SYS_REG_MAIR_EL1, HV_SYS_REG_SCTLR_EL1, HV_SYS_REG_SP_EL1, HV_SYS_REG_TCR_EL1, @@ -232,7 +234,21 @@ impl<'a, 'b> CpuExit for HvfExit<'a, 'b> { } fn into_io(self) -> Result { - todo!(); + // Check reason. + let e = unsafe { &*self.0.exit }; + + if e.reason != HV_EXIT_REASON_EXCEPTION { + return Err(self); + } + + // Check if Data Abort exception from a lower Exception level. + let s = Esr::from_bits(e.exception.syndrome); + + if s.ec() != 0b100100 { + return Err(self); + } + + todo!() } fn into_debug(self) -> Result { diff --git a/gui/src/vmm/hv/macos/mod.rs b/gui/src/vmm/hv/macos/mod.rs index 58c74e51..7c80700c 100644 --- a/gui/src/vmm/hv/macos/mod.rs +++ b/gui/src/vmm/hv/macos/mod.rs @@ -9,7 +9,7 @@ use applevisor_sys::hv_feature_reg_t::{ use applevisor_sys::{ hv_feature_reg_t, hv_return_t, hv_vcpu_config_create, hv_vcpu_config_get_feature_reg, hv_vcpu_config_t, hv_vcpu_create, hv_vcpu_set_trap_debug_exceptions, hv_vm_create, - hv_vm_destroy, + hv_vm_destroy, hv_vm_get_max_vcpu_count, }; use std::num::NonZero; use std::ptr::{null, null_mut}; @@ -24,7 +24,7 @@ mod mapper; /// # Safety /// `ram_block` must be greater or equal host page size. pub unsafe fn new( - _: usize, + cpu: usize, ram_size: NonZero, ram_block: NonZero, debug: bool, @@ -44,6 +44,16 @@ pub unsafe fn new( }, }; + // Get max vCPU count. + let mut max = 0; + let ret = hv_vm_get_max_vcpu_count(&mut max); + + if let Some(v) = NonZero::new(ret) { + return Err(HvfError::GetMaxCpuFailed(v)); + } else if usize::try_from(max).unwrap() < cpu { + return Err(HvfError::MaxCpuTooLow(cpu)); + } + // Load PE features. hv.feats.mmfr0 = hv .read_feature_reg(HV_FEATURE_REG_ID_AA64MMFR0_EL1) @@ -147,6 +157,12 @@ pub enum HvfError { #[error("couldn't create a VM ({0:#x})")] CreateVmFailed(NonZero), + #[error("couldn't get maximum number of vCPU for a VM")] + GetMaxCpuFailed(NonZero), + + #[error("your OS does not support {0} vCPU on a VM")] + MaxCpuTooLow(usize), + #[error("couldn't read ID_AA64MMFR0_EL1 ({0:#x})")] ReadMmfr0Failed(NonZero),