blob: 002e5052833246f784ace1d31dc71d12a54e1f7a [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
Jooyung Hanc221c052022-02-22 05:20:15 +090017mod create_idsig;
Jiyong Park48b354d2021-07-15 15:04:38 +090018mod create_partition;
Andrew Walbranf395b822021-05-05 10:38:59 +000019mod run;
Andrew Walbranea9fa482021-03-04 16:11:12 +000020
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};
David Brazdil20412d92021-03-18 10:53:06 +000025use anyhow::{Context, Error};
Alan Stokes0e82b502022-08-08 14:44:48 +010026use binder::ProcessState;
Victor Hsiehb5bcfab2022-09-12 13:06:26 -070027use clap::Parser;
Jooyung Hanc221c052022-02-22 05:20:15 +090028use create_idsig::command_create_idsig;
Jiyong Park48b354d2021-07-15 15:04:38 +090029use create_partition::command_create_partition;
Nikita Ioffeb0b67562022-11-22 15:48:06 +000030use run::{command_run, command_run_app, command_run_microdroid};
Andrew Walbranc4b1bde2022-02-03 15:26:02 +000031use rustutils::system_properties;
32use std::path::{Path, PathBuf};
Andrew Walbranea9fa482021-03-04 16:11:12 +000033
Inseob Kima5a262f2021-11-17 19:41:03 +090034#[derive(Debug)]
35struct Idsigs(Vec<PathBuf>);
36
Victor Hsiehb5bcfab2022-09-12 13:06:26 -070037#[derive(Parser)]
David Brazdil20412d92021-03-18 10:53:06 +000038enum 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
Jooyung Han21e9b922021-06-26 04:14:16 +090042 apk: PathBuf,
43
44 /// Path to idsig of the APK
Jooyung Han21e9b922021-06-26 04:14:16 +090045 idsig: PathBuf,
46
Jiyong Park48b354d2021-07-15 15:04:38 +090047 /// Path to the instance image. Created if not exists.
Jiyong Park48b354d2021-07-15 15:04:38 +090048 instance: PathBuf,
49
Jooyung Han21e9b922021-06-26 04:14:16 +090050 /// Path to VM config JSON within APK (e.g. assets/vm_config.json)
Inseob Kim7b5f65c2022-11-15 14:27:04 +090051 #[clap(long)]
Alan Stokes0d1ef782022-09-27 13:46:35 +010052 config_path: Option<String>,
Jooyung Han21e9b922021-06-26 04:14:16 +090053
Inseob Kim7b5f65c2022-11-15 14:27:04 +090054 /// Path to VM payload binary within APK (e.g. MicrodroidTestNativeLib.so)
55 #[clap(long)]
56 payload_path: Option<String>,
57
Victor Hsiehb5bcfab2022-09-12 13:06:26 -070058 /// Name of VM
59 #[clap(long)]
60 name: Option<String>,
61
Jooyung Han21e9b922021-06-26 04:14:16 +090062 /// Detach VM from the terminal and run in the background
Victor Hsiehb5bcfab2022-09-12 13:06:26 -070063 #[clap(short, long)]
Jooyung Han21e9b922021-06-26 04:14:16 +090064 daemonize: bool,
65
Shikha Panwar22e70452022-10-10 18:32:55 +000066 /// Path to the file backing the storage.
67 /// Created if the option is used but the path does not exist in the device.
68 #[clap(long)]
69 storage: Option<PathBuf>,
70
71 /// Size of the storage. Used only if --storage is supplied but path does not exist
72 /// Default size is 10*1024*1024
73 #[clap(long)]
74 storage_size: Option<u64>,
75
Jiyong Parkb8182bb2021-10-26 22:53:08 +090076 /// Path to file for VM console output.
Victor Hsiehb5bcfab2022-09-12 13:06:26 -070077 #[clap(long)]
Jiyong Parkb8182bb2021-10-26 22:53:08 +090078 console: Option<PathBuf>,
79
Jooyung Han21e9b922021-06-26 04:14:16 +090080 /// Path to file for VM log output.
Victor Hsiehb5bcfab2022-09-12 13:06:26 -070081 #[clap(long)]
Jooyung Han21e9b922021-06-26 04:14:16 +090082 log: Option<PathBuf>,
Jiyong Park23601142021-07-05 13:15:32 +090083
Seungjae Yoofa22bb02022-12-08 16:38:42 +090084 /// Debug level of the VM. Supported values: "none" (default), and "full".
Victor Hsiehb5bcfab2022-09-12 13:06:26 -070085 #[clap(long, default_value = "none", value_parser = parse_debug_level)]
Jiyong Parkc2a49cc2021-10-15 00:02:12 +090086 debug: DebugLevel,
Jiyong Parkd63cfff2021-09-27 20:10:17 +090087
Andrew Walbran3994f002022-01-27 17:33:45 +000088 /// Run VM in protected mode.
Victor Hsiehb5bcfab2022-09-12 13:06:26 -070089 #[clap(short, long)]
Andrew Walbran3994f002022-01-27 17:33:45 +000090 protected: bool,
91
Jiyong Parkd63cfff2021-09-27 20:10:17 +090092 /// Memory size (in MiB) of the VM. If unspecified, defaults to the value of `memory_mib`
93 /// in the VM config file.
Victor Hsiehb5bcfab2022-09-12 13:06:26 -070094 #[clap(short, long)]
Jiyong Parkd63cfff2021-09-27 20:10:17 +090095 mem: Option<u32>,
Inseob Kima5a262f2021-11-17 19:41:03 +090096
Jiyong Park032615f2022-01-10 13:55:34 +090097 /// Number of vCPUs in the VM. If unspecified, defaults to 1.
Victor Hsiehb5bcfab2022-09-12 13:06:26 -070098 #[clap(long)]
Jiyong Park032615f2022-01-10 13:55:34 +090099 cpus: Option<u32>,
100
Jiyong Parkdfe16d62022-04-20 17:32:12 +0900101 /// Comma separated list of task profile names to apply to the VM
Victor Hsiehb5bcfab2022-09-12 13:06:26 -0700102 #[clap(long)]
Jiyong Parkdfe16d62022-04-20 17:32:12 +0900103 task_profiles: Vec<String>,
104
Inseob Kima5a262f2021-11-17 19:41:03 +0900105 /// Paths to extra idsig files.
Victor Hsiehb5bcfab2022-09-12 13:06:26 -0700106 #[clap(long = "extra-idsig")]
Inseob Kima5a262f2021-11-17 19:41:03 +0900107 extra_idsigs: Vec<PathBuf>,
Jooyung Han21e9b922021-06-26 04:14:16 +0900108 },
Nikita Ioffeb0b67562022-11-22 15:48:06 +0000109 /// Run a virtual machine with Microdroid inside
110 RunMicrodroid {
111 /// Path to the directory where VM-related files (e.g. instance.img, apk.idsig, etc.) will
112 /// be stored. If not specified a random directory under /data/local/tmp/microdroid will be
113 /// created and used.
114 #[clap(long)]
115 work_dir: Option<PathBuf>,
116
117 /// Name of VM
118 #[clap(long)]
119 name: Option<String>,
120
121 /// Detach VM from the terminal and run in the background
122 #[clap(short, long)]
123 daemonize: bool,
124
125 /// Path to the file backing the storage.
126 /// Created if the option is used but the path does not exist in the device.
127 #[clap(long)]
128 storage: Option<PathBuf>,
129
130 /// Size of the storage. Used only if --storage is supplied but path does not exist
131 /// Default size is 10*1024*1024
132 #[clap(long)]
133 storage_size: Option<u64>,
134
135 /// Path to file for VM console output.
136 #[clap(long)]
137 console: Option<PathBuf>,
138
139 /// Path to file for VM log output.
140 #[clap(long)]
141 log: Option<PathBuf>,
142
Seungjae Yoofa22bb02022-12-08 16:38:42 +0900143 /// Debug level of the VM. Supported values: "none" (default), and "full".
Nikita Ioffe0a15fcf2022-12-01 21:12:50 +0000144 #[clap(long, default_value = "full", value_parser = parse_debug_level)]
Nikita Ioffeb0b67562022-11-22 15:48:06 +0000145 debug: DebugLevel,
146
147 /// Run VM in protected mode.
148 #[clap(short, long)]
149 protected: bool,
150
151 /// Memory size (in MiB) of the VM. If unspecified, defaults to the value of `memory_mib`
152 /// in the VM config file.
153 #[clap(short, long)]
154 mem: Option<u32>,
155
156 /// Number of vCPUs in the VM. If unspecified, defaults to 1.
157 #[clap(long)]
158 cpus: Option<u32>,
159
160 /// Comma separated list of task profile names to apply to the VM
161 #[clap(long)]
162 task_profiles: Vec<String>,
163 },
David Brazdil20412d92021-03-18 10:53:06 +0000164 /// Run a virtual machine
165 Run {
166 /// Path to VM config JSON
David Brazdil20412d92021-03-18 10:53:06 +0000167 config: PathBuf,
David Brazdil3c2ddef2021-03-18 13:09:57 +0000168
Victor Hsiehb5bcfab2022-09-12 13:06:26 -0700169 /// Name of VM
170 #[clap(long)]
171 name: Option<String>,
172
David Brazdil3c2ddef2021-03-18 13:09:57 +0000173 /// Detach VM from the terminal and run in the background
Victor Hsiehb5bcfab2022-09-12 13:06:26 -0700174 #[clap(short, long)]
David Brazdil3c2ddef2021-03-18 13:09:57 +0000175 daemonize: bool,
Andrew Walbranbe429242021-06-28 12:22:54 +0000176
Jiyong Park032615f2022-01-10 13:55:34 +0900177 /// Number of vCPUs in the VM. If unspecified, defaults to 1.
Victor Hsiehb5bcfab2022-09-12 13:06:26 -0700178 #[clap(long)]
Jiyong Park032615f2022-01-10 13:55:34 +0900179 cpus: Option<u32>,
180
Jiyong Parkdfe16d62022-04-20 17:32:12 +0900181 /// Comma separated list of task profile names to apply to the VM
Victor Hsiehb5bcfab2022-09-12 13:06:26 -0700182 #[clap(long)]
Jiyong Parkdfe16d62022-04-20 17:32:12 +0900183 task_profiles: Vec<String>,
184
Jiyong Parkb8182bb2021-10-26 22:53:08 +0900185 /// Path to file for VM console output.
Victor Hsiehb5bcfab2022-09-12 13:06:26 -0700186 #[clap(long)]
Jiyong Parkb8182bb2021-10-26 22:53:08 +0900187 console: Option<PathBuf>,
Jooyung Hanb7983a22022-02-22 05:21:27 +0900188
189 /// Path to file for VM log output.
Victor Hsiehb5bcfab2022-09-12 13:06:26 -0700190 #[clap(long)]
Jooyung Hanb7983a22022-02-22 05:21:27 +0900191 log: Option<PathBuf>,
David Brazdil3c2ddef2021-03-18 13:09:57 +0000192 },
193 /// Stop a virtual machine running in the background
194 Stop {
195 /// CID of the virtual machine
196 cid: u32,
David Brazdil20412d92021-03-18 10:53:06 +0000197 },
198 /// List running virtual machines
199 List,
Andrew Walbranc4b1bde2022-02-03 15:26:02 +0000200 /// Print information about virtual machine support
201 Info,
Andrew Walbrandff3b942021-06-09 15:20:36 +0000202 /// Create a new empty partition to be used as a writable partition for a VM
203 CreatePartition {
204 /// Path at which to create the image file
Andrew Walbrandff3b942021-06-09 15:20:36 +0000205 path: PathBuf,
206
207 /// The desired size of the partition, in bytes.
208 size: u64,
Jiyong Park9dd389e2021-08-23 20:42:59 +0900209
210 /// Type of the partition
Victor Hsiehb5bcfab2022-09-12 13:06:26 -0700211 #[clap(short = 't', long = "type", default_value = "raw",
212 value_parser = parse_partition_type)]
Jiyong Park9dd389e2021-08-23 20:42:59 +0900213 partition_type: PartitionType,
Andrew Walbrandff3b942021-06-09 15:20:36 +0000214 },
Jooyung Hanc221c052022-02-22 05:20:15 +0900215 /// Creates or update the idsig file by digesting the input APK file.
216 CreateIdsig {
217 /// Path to VM Payload APK
Jooyung Hanc221c052022-02-22 05:20:15 +0900218 apk: PathBuf,
Victor Hsiehb5bcfab2022-09-12 13:06:26 -0700219
Jooyung Hanc221c052022-02-22 05:20:15 +0900220 /// Path to idsig of the APK
Jooyung Hanc221c052022-02-22 05:20:15 +0900221 path: PathBuf,
222 },
David Brazdil20412d92021-03-18 10:53:06 +0000223}
224
Jiyong Parkc2a49cc2021-10-15 00:02:12 +0900225fn parse_debug_level(s: &str) -> Result<DebugLevel, String> {
226 match s {
227 "none" => Ok(DebugLevel::NONE),
Jiyong Parkc2a49cc2021-10-15 00:02:12 +0900228 "full" => Ok(DebugLevel::FULL),
229 _ => Err(format!("Invalid debug level {}", s)),
230 }
231}
232
Jiyong Park9dd389e2021-08-23 20:42:59 +0900233fn parse_partition_type(s: &str) -> Result<PartitionType, String> {
234 match s {
235 "raw" => Ok(PartitionType::RAW),
236 "instance" => Ok(PartitionType::ANDROID_VM_INSTANCE),
237 _ => Err(format!("Invalid partition type {}", s)),
238 }
239}
240
Andrew Walbranea9fa482021-03-04 16:11:12 +0000241fn main() -> Result<(), Error> {
242 env_logger::init();
Victor Hsiehb5bcfab2022-09-12 13:06:26 -0700243 let opt = Opt::parse();
Andrew Walbranea9fa482021-03-04 16:11:12 +0000244
245 // We need to start the thread pool for Binder to work properly, especially link_to_death.
246 ProcessState::start_thread_pool();
247
David Brazdil4b4c5102022-12-19 22:56:20 +0000248 let virtmgr =
249 vmclient::VirtualizationService::new().context("Failed to spawn VirtualizationService")?;
250 let service = virtmgr.connect().context("Failed to connect to VirtualizationService")?;
Andrew Walbran320b5602021-03-04 16:11:12 +0000251
David Brazdil20412d92021-03-18 10:53:06 +0000252 match opt {
Inseob Kima5a262f2021-11-17 19:41:03 +0900253 Opt::RunApp {
Seungjae Yoo62085c02022-08-12 04:44:52 +0000254 name,
Inseob Kima5a262f2021-11-17 19:41:03 +0900255 apk,
256 idsig,
257 instance,
Shikha Panwar22e70452022-10-10 18:32:55 +0000258 storage,
259 storage_size,
Inseob Kima5a262f2021-11-17 19:41:03 +0900260 config_path,
Inseob Kim7b5f65c2022-11-15 14:27:04 +0900261 payload_path,
Inseob Kima5a262f2021-11-17 19:41:03 +0900262 daemonize,
263 console,
264 log,
265 debug,
Andrew Walbran3994f002022-01-27 17:33:45 +0000266 protected,
Inseob Kima5a262f2021-11-17 19:41:03 +0900267 mem,
Jiyong Park032615f2022-01-10 13:55:34 +0900268 cpus,
Jiyong Parkdfe16d62022-04-20 17:32:12 +0900269 task_profiles,
Inseob Kima5a262f2021-11-17 19:41:03 +0900270 extra_idsigs,
271 } => command_run_app(
Seungjae Yoo62085c02022-08-12 04:44:52 +0000272 name,
Andrew Walbran616d13f2022-05-12 18:35:55 +0000273 service.as_ref(),
Inseob Kima5a262f2021-11-17 19:41:03 +0900274 &apk,
275 &idsig,
276 &instance,
Shikha Panwar22e70452022-10-10 18:32:55 +0000277 storage.as_deref(),
278 storage_size,
Inseob Kim7b5f65c2022-11-15 14:27:04 +0900279 config_path,
280 payload_path,
Inseob Kima5a262f2021-11-17 19:41:03 +0900281 daemonize,
282 console.as_deref(),
283 log.as_deref(),
284 debug,
Andrew Walbran3994f002022-01-27 17:33:45 +0000285 protected,
Inseob Kima5a262f2021-11-17 19:41:03 +0900286 mem,
Jiyong Park032615f2022-01-10 13:55:34 +0900287 cpus,
Jiyong Parkdfe16d62022-04-20 17:32:12 +0900288 task_profiles,
Inseob Kima5a262f2021-11-17 19:41:03 +0900289 &extra_idsigs,
290 ),
Nikita Ioffeb0b67562022-11-22 15:48:06 +0000291 Opt::RunMicrodroid {
292 name,
293 work_dir,
294 storage,
295 storage_size,
296 daemonize,
297 console,
298 log,
Nikita Ioffeb0b67562022-11-22 15:48:06 +0000299 debug,
300 protected,
301 mem,
302 cpus,
303 task_profiles,
304 } => command_run_microdroid(
305 name,
306 service.as_ref(),
307 work_dir,
308 storage.as_deref(),
309 storage_size,
310 daemonize,
311 console.as_deref(),
312 log.as_deref(),
Nikita Ioffeb0b67562022-11-22 15:48:06 +0000313 debug,
314 protected,
315 mem,
316 cpus,
317 task_profiles,
318 ),
Victor Hsiehf219cd82022-09-09 13:13:11 -0700319 Opt::Run { name, config, daemonize, cpus, task_profiles, console, log } => {
Jiyong Park032615f2022-01-10 13:55:34 +0900320 command_run(
Seungjae Yoo62085c02022-08-12 04:44:52 +0000321 name,
Andrew Walbran616d13f2022-05-12 18:35:55 +0000322 service.as_ref(),
Jiyong Park032615f2022-01-10 13:55:34 +0900323 &config,
324 daemonize,
325 console.as_deref(),
Jooyung Hanb7983a22022-02-22 05:21:27 +0900326 log.as_deref(),
Jiyong Park032615f2022-01-10 13:55:34 +0900327 /* mem */ None,
328 cpus,
Jiyong Parkdfe16d62022-04-20 17:32:12 +0900329 task_profiles,
Jiyong Park032615f2022-01-10 13:55:34 +0900330 )
Andrew Walbranbe429242021-06-28 12:22:54 +0000331 }
Andrew Walbran616d13f2022-05-12 18:35:55 +0000332 Opt::Stop { cid } => command_stop(service.as_ref(), cid),
333 Opt::List => command_list(service.as_ref()),
Andrew Walbranc4b1bde2022-02-03 15:26:02 +0000334 Opt::Info => command_info(),
Jiyong Park9dd389e2021-08-23 20:42:59 +0900335 Opt::CreatePartition { path, size, partition_type } => {
Andrew Walbran616d13f2022-05-12 18:35:55 +0000336 command_create_partition(service.as_ref(), &path, size, partition_type)
Jiyong Park9dd389e2021-08-23 20:42:59 +0900337 }
Andrew Walbran616d13f2022-05-12 18:35:55 +0000338 Opt::CreateIdsig { apk, path } => command_create_idsig(service.as_ref(), &apk, &path),
Andrew Walbranea9fa482021-03-04 16:11:12 +0000339 }
340}
341
David Brazdil3c2ddef2021-03-18 13:09:57 +0000342/// Retrieve reference to a previously daemonized VM and stop it.
Andrew Walbran616d13f2022-05-12 18:35:55 +0000343fn command_stop(service: &dyn IVirtualizationService, cid: u32) -> Result<(), Error> {
Andrew Walbran17de24f2021-05-27 13:27:30 +0000344 service
David Brazdil3c2ddef2021-03-18 13:09:57 +0000345 .debugDropVmRef(cid as i32)
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000346 .context("Failed to get VM from VirtualizationService")?
David Brazdil3c2ddef2021-03-18 13:09:57 +0000347 .context("CID does not correspond to a running background VM")?;
Andrew Walbranea9fa482021-03-04 16:11:12 +0000348 Ok(())
349}
350
Andrew Walbran320b5602021-03-04 16:11:12 +0000351/// List the VMs currently running.
Andrew Walbran616d13f2022-05-12 18:35:55 +0000352fn command_list(service: &dyn IVirtualizationService) -> Result<(), Error> {
Andrew Walbran17de24f2021-05-27 13:27:30 +0000353 let vms = service.debugListVms().context("Failed to get list of VMs")?;
Andrew Walbran320b5602021-03-04 16:11:12 +0000354 println!("Running VMs: {:#?}", vms);
355 Ok(())
356}
Andrew Walbranc4b1bde2022-02-03 15:26:02 +0000357
358/// Print information about supported VM types.
359fn command_info() -> Result<(), Error> {
360 let unprotected_vm_supported =
361 system_properties::read_bool("ro.boot.hypervisor.vm.supported", false)?;
362 let protected_vm_supported =
363 system_properties::read_bool("ro.boot.hypervisor.protected_vm.supported", false)?;
364 match (unprotected_vm_supported, protected_vm_supported) {
365 (false, false) => println!("VMs are not supported."),
366 (false, true) => println!("Only protected VMs are supported."),
367 (true, false) => println!("Only unprotected VMs are supported."),
368 (true, true) => println!("Both protected and unprotected VMs are supported."),
369 }
370
Andrew Walbran014efb52022-02-03 17:43:11 +0000371 if let Some(version) = system_properties::read("ro.boot.hypervisor.version")? {
Andrew Walbranc4b1bde2022-02-03 15:26:02 +0000372 println!("Hypervisor version: {}", version);
373 } else {
374 println!("Hypervisor version not set.");
375 }
376
377 if Path::new("/dev/kvm").exists() {
378 println!("/dev/kvm exists.");
379 } else {
380 println!("/dev/kvm does not exist.");
381 }
382
383 Ok(())
384}
Andrew Walbran1f810b62022-08-10 13:33:57 +0000385
386#[cfg(test)]
387mod tests {
388 use super::*;
389 use clap::IntoApp;
390
391 #[test]
392 fn verify_app() {
393 Opt::into_app().debug_assert();
394 }
395}