blob: 7e2a925c0e88804c3b6c35f5a74cab50f8ef8bb1 [file] [log] [blame]
Andrew Walbranea9fa482021-03-04 16:11:12 +00001// Copyright 2021, The Android Open Source Project
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Android VM control tool.
16
Jiyong Park48b354d2021-07-15 15:04:38 +090017mod create_partition;
Andrew Walbranf395b822021-05-05 10:38:59 +000018mod run;
Andrew Walbranea9fa482021-03-04 16:11:12 +000019mod sync;
20
Jiyong Parkc2a49cc2021-10-15 00:02:12 +090021use android_system_virtualizationservice::aidl::android::system::virtualizationservice::{
22 IVirtualizationService::IVirtualizationService, PartitionType::PartitionType,
23 VirtualMachineAppConfig::DebugLevel::DebugLevel,
24};
Jiyong Park48b354d2021-07-15 15:04:38 +090025use android_system_virtualizationservice::binder::{wait_for_interface, ProcessState, Strong};
David Brazdil20412d92021-03-18 10:53:06 +000026use anyhow::{Context, Error};
Jiyong Park48b354d2021-07-15 15:04:38 +090027use create_partition::command_create_partition;
Jooyung Han21e9b922021-06-26 04:14:16 +090028use run::{command_run, command_run_app};
Jiyong Park48b354d2021-07-15 15:04:38 +090029use std::path::PathBuf;
David Brazdil20412d92021-03-18 10:53:06 +000030use structopt::clap::AppSettings;
31use structopt::StructOpt;
Andrew Walbranea9fa482021-03-04 16:11:12 +000032
Andrew Walbran17de24f2021-05-27 13:27:30 +000033const VIRTUALIZATION_SERVICE_BINDER_SERVICE_IDENTIFIER: &str =
34 "android.system.virtualizationservice";
Andrew Walbranea9fa482021-03-04 16:11:12 +000035
David Brazdil20412d92021-03-18 10:53:06 +000036#[derive(StructOpt)]
37#[structopt(no_version, global_settings = &[AppSettings::DisableVersion])]
38enum Opt {
Jooyung Han21e9b922021-06-26 04:14:16 +090039 /// Run a virtual machine with a config in APK
40 RunApp {
41 /// Path to VM Payload APK
42 #[structopt(parse(from_os_str))]
43 apk: PathBuf,
44
45 /// Path to idsig of the APK
46 #[structopt(parse(from_os_str))]
47 idsig: PathBuf,
48
Jiyong Park48b354d2021-07-15 15:04:38 +090049 /// Path to the instance image. Created if not exists.
50 #[structopt(parse(from_os_str))]
51 instance: PathBuf,
52
Jooyung Han21e9b922021-06-26 04:14:16 +090053 /// Path to VM config JSON within APK (e.g. assets/vm_config.json)
54 config_path: String,
55
56 /// Detach VM from the terminal and run in the background
57 #[structopt(short, long)]
58 daemonize: bool,
59
60 /// Path to file for VM log output.
61 #[structopt(short, long)]
62 log: Option<PathBuf>,
Jiyong Park23601142021-07-05 13:15:32 +090063
Jiyong Parkc2a49cc2021-10-15 00:02:12 +090064 /// Debug level of the VM. Supported values: "none" (default), "app_only", and "full".
65 #[structopt(short, long, default_value = "none", parse(try_from_str=parse_debug_level))]
66 debug: DebugLevel,
Jiyong Parkd63cfff2021-09-27 20:10:17 +090067
68 /// Memory size (in MiB) of the VM. If unspecified, defaults to the value of `memory_mib`
69 /// in the VM config file.
70 #[structopt(short, long)]
71 mem: Option<u32>,
Jooyung Han21e9b922021-06-26 04:14:16 +090072 },
David Brazdil20412d92021-03-18 10:53:06 +000073 /// Run a virtual machine
74 Run {
75 /// Path to VM config JSON
76 #[structopt(parse(from_os_str))]
77 config: PathBuf,
David Brazdil3c2ddef2021-03-18 13:09:57 +000078
79 /// Detach VM from the terminal and run in the background
80 #[structopt(short, long)]
81 daemonize: bool,
Andrew Walbranbe429242021-06-28 12:22:54 +000082
83 /// Path to file for VM log output.
84 #[structopt(short, long)]
85 log: Option<PathBuf>,
David Brazdil3c2ddef2021-03-18 13:09:57 +000086 },
87 /// Stop a virtual machine running in the background
88 Stop {
89 /// CID of the virtual machine
90 cid: u32,
David Brazdil20412d92021-03-18 10:53:06 +000091 },
92 /// List running virtual machines
93 List,
Andrew Walbrandff3b942021-06-09 15:20:36 +000094 /// Create a new empty partition to be used as a writable partition for a VM
95 CreatePartition {
96 /// Path at which to create the image file
97 #[structopt(parse(from_os_str))]
98 path: PathBuf,
99
100 /// The desired size of the partition, in bytes.
101 size: u64,
Jiyong Park9dd389e2021-08-23 20:42:59 +0900102
103 /// Type of the partition
104 #[structopt(short="t", long="type", default_value="raw", parse(try_from_str=parse_partition_type))]
105 partition_type: PartitionType,
Andrew Walbrandff3b942021-06-09 15:20:36 +0000106 },
David Brazdil20412d92021-03-18 10:53:06 +0000107}
108
Jiyong Parkc2a49cc2021-10-15 00:02:12 +0900109fn parse_debug_level(s: &str) -> Result<DebugLevel, String> {
110 match s {
111 "none" => Ok(DebugLevel::NONE),
112 "app_only" => Ok(DebugLevel::APP_ONLY),
113 "full" => Ok(DebugLevel::FULL),
114 _ => Err(format!("Invalid debug level {}", s)),
115 }
116}
117
Jiyong Park9dd389e2021-08-23 20:42:59 +0900118fn parse_partition_type(s: &str) -> Result<PartitionType, String> {
119 match s {
120 "raw" => Ok(PartitionType::RAW),
121 "instance" => Ok(PartitionType::ANDROID_VM_INSTANCE),
122 _ => Err(format!("Invalid partition type {}", s)),
123 }
124}
125
Andrew Walbranea9fa482021-03-04 16:11:12 +0000126fn main() -> Result<(), Error> {
127 env_logger::init();
David Brazdil20412d92021-03-18 10:53:06 +0000128 let opt = Opt::from_args();
Andrew Walbranea9fa482021-03-04 16:11:12 +0000129
130 // We need to start the thread pool for Binder to work properly, especially link_to_death.
131 ProcessState::start_thread_pool();
132
Andrew Walbranf1453802021-03-29 17:12:54 +0000133 let service = wait_for_interface(VIRTUALIZATION_SERVICE_BINDER_SERVICE_IDENTIFIER)
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000134 .context("Failed to find VirtualizationService")?;
Andrew Walbran320b5602021-03-04 16:11:12 +0000135
David Brazdil20412d92021-03-18 10:53:06 +0000136 match opt {
Jiyong Parkd63cfff2021-09-27 20:10:17 +0900137 Opt::RunApp { apk, idsig, instance, config_path, daemonize, log, debug, mem } => {
Jiyong Park48b354d2021-07-15 15:04:38 +0900138 command_run_app(
139 service,
140 &apk,
141 &idsig,
142 &instance,
143 &config_path,
144 daemonize,
145 log.as_deref(),
146 debug,
Jiyong Parkd63cfff2021-09-27 20:10:17 +0900147 mem,
Jiyong Park48b354d2021-07-15 15:04:38 +0900148 )
Jooyung Han21e9b922021-06-26 04:14:16 +0900149 }
Andrew Walbranbe429242021-06-28 12:22:54 +0000150 Opt::Run { config, daemonize, log } => {
Jiyong Parkd63cfff2021-09-27 20:10:17 +0900151 command_run(service, &config, daemonize, log.as_deref(), /* mem */ None)
Andrew Walbranbe429242021-06-28 12:22:54 +0000152 }
Andrew Walbran17de24f2021-05-27 13:27:30 +0000153 Opt::Stop { cid } => command_stop(service, cid),
154 Opt::List => command_list(service),
Jiyong Park9dd389e2021-08-23 20:42:59 +0900155 Opt::CreatePartition { path, size, partition_type } => {
156 command_create_partition(service, &path, size, partition_type)
157 }
Andrew Walbranea9fa482021-03-04 16:11:12 +0000158 }
159}
160
David Brazdil3c2ddef2021-03-18 13:09:57 +0000161/// Retrieve reference to a previously daemonized VM and stop it.
Andrew Walbran17de24f2021-05-27 13:27:30 +0000162fn command_stop(service: Strong<dyn IVirtualizationService>, cid: u32) -> Result<(), Error> {
163 service
David Brazdil3c2ddef2021-03-18 13:09:57 +0000164 .debugDropVmRef(cid as i32)
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000165 .context("Failed to get VM from VirtualizationService")?
David Brazdil3c2ddef2021-03-18 13:09:57 +0000166 .context("CID does not correspond to a running background VM")?;
Andrew Walbranea9fa482021-03-04 16:11:12 +0000167 Ok(())
168}
169
Andrew Walbran320b5602021-03-04 16:11:12 +0000170/// List the VMs currently running.
Andrew Walbran17de24f2021-05-27 13:27:30 +0000171fn command_list(service: Strong<dyn IVirtualizationService>) -> Result<(), Error> {
172 let vms = service.debugListVms().context("Failed to get list of VMs")?;
Andrew Walbran320b5602021-03-04 16:11:12 +0000173 println!("Running VMs: {:#?}", vms);
174 Ok(())
175}