Rename VirtManager to VirtualizationService.
Bug: 188042280
Test: atest VirtualizationTestCases
Change-Id: I15f3f91e464f52d1b1fd47b1290846b1d21fa665
diff --git a/virtualizationservice/src/crosvm.rs b/virtualizationservice/src/crosvm.rs
new file mode 100644
index 0000000..552941d
--- /dev/null
+++ b/virtualizationservice/src/crosvm.rs
@@ -0,0 +1,196 @@
+// Copyright 2021, The Android Open Source Project
+//
+// 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.
+
+//! Functions for running instances of `crosvm`.
+
+use crate::aidl::VirtualMachineCallbacks;
+use crate::Cid;
+use android_system_virtualizationservice::aidl::android::system::virtualizationservice::VirtualMachineConfig::VirtualMachineConfig;
+use anyhow::{bail, Context, Error};
+use command_fds::{CommandFdExt, FdMapping};
+use log::{debug, error, info};
+use shared_child::SharedChild;
+use std::fs::File;
+use std::os::unix::io::AsRawFd;
+use std::process::Command;
+use std::sync::atomic::{AtomicBool, Ordering};
+use std::sync::Arc;
+use std::thread;
+
+const CROSVM_PATH: &str = "/apex/com.android.virt/bin/crosvm";
+
+/// Information about a particular instance of a VM which is running.
+#[derive(Debug)]
+pub struct VmInstance {
+ /// The crosvm child process.
+ child: SharedChild,
+ /// The CID assigned to the VM for vsock communication.
+ pub cid: Cid,
+ /// The UID of the process which requested the VM.
+ pub requester_uid: u32,
+ /// The SID of the process which requested the VM.
+ pub requester_sid: String,
+ /// The PID of the process which requested the VM. Note that this process may no longer exist
+ /// and the PID may have been reused for a different process, so this should not be trusted.
+ pub requester_debug_pid: i32,
+ /// Whether the VM is still running.
+ running: AtomicBool,
+ /// Callbacks to clients of the VM.
+ pub callbacks: VirtualMachineCallbacks,
+}
+
+impl VmInstance {
+ /// Create a new `VmInstance` for the given process.
+ fn new(
+ child: SharedChild,
+ cid: Cid,
+ requester_uid: u32,
+ requester_sid: String,
+ requester_debug_pid: i32,
+ ) -> VmInstance {
+ VmInstance {
+ child,
+ cid,
+ requester_uid,
+ requester_sid,
+ requester_debug_pid,
+ running: AtomicBool::new(true),
+ callbacks: Default::default(),
+ }
+ }
+
+ /// Start an instance of `crosvm` to manage a new VM. The `crosvm` instance will be killed when
+ /// the `VmInstance` is dropped.
+ pub fn start(
+ config: &VirtualMachineConfig,
+ cid: Cid,
+ log_fd: Option<File>,
+ requester_uid: u32,
+ requester_sid: String,
+ requester_debug_pid: i32,
+ ) -> Result<Arc<VmInstance>, Error> {
+ let child = run_vm(config, cid, log_fd)?;
+ let instance = Arc::new(VmInstance::new(
+ child,
+ cid,
+ requester_uid,
+ requester_sid,
+ requester_debug_pid,
+ ));
+
+ let instance_clone = instance.clone();
+ thread::spawn(move || {
+ instance_clone.monitor();
+ });
+
+ Ok(instance)
+ }
+
+ /// Wait for the crosvm child process to finish, then mark the VM as no longer running and call
+ /// any callbacks.
+ fn monitor(&self) {
+ match self.child.wait() {
+ Err(e) => error!("Error waiting for crosvm instance to die: {}", e),
+ Ok(status) => info!("crosvm exited with status {}", status),
+ }
+ self.running.store(false, Ordering::Release);
+ self.callbacks.callback_on_died(self.cid);
+ }
+
+ /// Return whether `crosvm` is still running the VM.
+ pub fn running(&self) -> bool {
+ self.running.load(Ordering::Acquire)
+ }
+
+ /// Kill the crosvm instance.
+ pub fn kill(&self) {
+ // TODO: Talk to crosvm to shutdown cleanly.
+ if let Err(e) = self.child.kill() {
+ error!("Error killing crosvm instance: {}", e);
+ }
+ }
+}
+
+/// Start an instance of `crosvm` to manage a new VM.
+fn run_vm(
+ config: &VirtualMachineConfig,
+ cid: Cid,
+ log_fd: Option<File>,
+) -> Result<SharedChild, Error> {
+ validate_config(config)?;
+
+ let mut command = Command::new(CROSVM_PATH);
+ // TODO(qwandor): Remove --disable-sandbox.
+ command.arg("run").arg("--disable-sandbox").arg("--cid").arg(cid.to_string());
+
+ if let Some(log_fd) = log_fd {
+ command.stdout(log_fd);
+ } else {
+ // Ignore console output.
+ command.arg("--serial=type=sink");
+ }
+
+ // Keep track of what file descriptors should be mapped to the crosvm process.
+ let mut fd_mappings = vec![];
+
+ if let Some(bootloader) = &config.bootloader {
+ command.arg("--bios").arg(add_fd_mapping(&mut fd_mappings, bootloader.as_ref()));
+ }
+
+ if let Some(initrd) = &config.initrd {
+ command.arg("--initrd").arg(add_fd_mapping(&mut fd_mappings, initrd.as_ref()));
+ }
+
+ if let Some(params) = &config.params {
+ command.arg("--params").arg(params);
+ }
+
+ for disk in &config.disks {
+ command.arg(if disk.writable { "--rwdisk" } else { "--disk" }).arg(add_fd_mapping(
+ &mut fd_mappings,
+ // TODO(b/187187765): This shouldn't be an Option.
+ disk.image.as_ref().context("Invalid disk image file descriptor")?.as_ref(),
+ ));
+ }
+
+ if let Some(kernel) = &config.kernel {
+ command.arg(add_fd_mapping(&mut fd_mappings, kernel.as_ref()));
+ }
+
+ debug!("Setting mappings {:?}", fd_mappings);
+ command.fd_mappings(fd_mappings)?;
+
+ info!("Running {:?}", command);
+ let result = SharedChild::spawn(&mut command)?;
+ Ok(result)
+}
+
+/// Ensure that the configuration has a valid combination of fields set, or return an error if not.
+fn validate_config(config: &VirtualMachineConfig) -> Result<(), Error> {
+ if config.bootloader.is_none() && config.kernel.is_none() {
+ bail!("VM must have either a bootloader or a kernel image.");
+ }
+ if config.bootloader.is_some() && (config.kernel.is_some() || config.initrd.is_some()) {
+ bail!("Can't have both bootloader and kernel/initrd image.");
+ }
+ Ok(())
+}
+
+/// Adds a mapping for `file` to `fd_mappings`, and returns a string of the form "/proc/self/fd/N"
+/// where N is the file descriptor for the child process.
+fn add_fd_mapping(fd_mappings: &mut Vec<FdMapping>, file: &File) -> String {
+ let fd = file.as_raw_fd();
+ fd_mappings.push(FdMapping { parent_fd: fd, child_fd: fd });
+ format!("/proc/self/fd/{}", fd)
+}