blob: 8583fe2ebbcc15edf7bda6e91bbc38b7ba54ac19 [file] [log] [blame]
Andrew Walbranf395b822021-05-05 10:38:59 +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//! Command to run a VM.
16
Jiyong Park48b354d2021-07-15 15:04:38 +090017use crate::create_partition::command_create_partition;
Andrew Walbranf395b822021-05-05 10:38:59 +000018use crate::sync::AtomicFlag;
Jooyung Han21e9b922021-06-26 04:14:16 +090019use android_system_virtualizationservice::aidl::android::system::virtualizationservice::{
Andrew Walbranc92d35f2022-01-12 12:45:19 +000020 DeathReason::DeathReason, IVirtualMachine::IVirtualMachine,
21 IVirtualMachineCallback::BnVirtualMachineCallback,
Jiyong Parkc2a49cc2021-10-15 00:02:12 +090022 IVirtualMachineCallback::IVirtualMachineCallback,
23 IVirtualizationService::IVirtualizationService, PartitionType::PartitionType,
24 VirtualMachineAppConfig::DebugLevel::DebugLevel,
25 VirtualMachineAppConfig::VirtualMachineAppConfig, VirtualMachineConfig::VirtualMachineConfig,
Andrew Walbranf8d94112021-09-07 11:45:36 +000026 VirtualMachineState::VirtualMachineState,
Jooyung Han21e9b922021-06-26 04:14:16 +090027};
Andrew Walbranf6bf6862021-05-21 12:41:13 +000028use android_system_virtualizationservice::binder::{
Andrew Walbranf395b822021-05-05 10:38:59 +000029 BinderFeatures, DeathRecipient, IBinder, ParcelFileDescriptor, Strong,
30};
Andrew Walbranf6bf6862021-05-21 12:41:13 +000031use android_system_virtualizationservice::binder::{Interface, Result as BinderResult};
Inseob Kima5a262f2021-11-17 19:41:03 +090032use anyhow::{bail, Context, Error};
33use microdroid_payload_config::VmPayloadConfig;
Andrew Walbranf395b822021-05-05 10:38:59 +000034use std::fs::File;
Jiyong Park8611a6c2021-07-09 18:17:44 +090035use std::io::{self, BufRead, BufReader};
Andrew Walbranf395b822021-05-05 10:38:59 +000036use std::os::unix::io::{AsRawFd, FromRawFd};
Inseob Kima5a262f2021-11-17 19:41:03 +090037use std::path::{Path, PathBuf};
Jiyong Park48b354d2021-07-15 15:04:38 +090038use vmconfig::{open_parcel_file, VmConfig};
Inseob Kima5a262f2021-11-17 19:41:03 +090039use zip::ZipArchive;
Andrew Walbranf395b822021-05-05 10:38:59 +000040
Jooyung Han21e9b922021-06-26 04:14:16 +090041/// Run a VM from the given APK, idsig, and config.
Jiyong Park48b354d2021-07-15 15:04:38 +090042#[allow(clippy::too_many_arguments)]
Jooyung Han21e9b922021-06-26 04:14:16 +090043pub fn command_run_app(
44 service: Strong<dyn IVirtualizationService>,
45 apk: &Path,
46 idsig: &Path,
Jiyong Park48b354d2021-07-15 15:04:38 +090047 instance: &Path,
Jooyung Han21e9b922021-06-26 04:14:16 +090048 config_path: &str,
49 daemonize: bool,
Jiyong Parkb8182bb2021-10-26 22:53:08 +090050 console_path: Option<&Path>,
Jooyung Han21e9b922021-06-26 04:14:16 +090051 log_path: Option<&Path>,
Jiyong Parkc2a49cc2021-10-15 00:02:12 +090052 debug_level: DebugLevel,
Jiyong Parkd63cfff2021-09-27 20:10:17 +090053 mem: Option<u32>,
Jiyong Park032615f2022-01-10 13:55:34 +090054 cpus: Option<u32>,
55 cpu_affinity: Option<String>,
Inseob Kima5a262f2021-11-17 19:41:03 +090056 extra_idsigs: &[PathBuf],
Jooyung Han21e9b922021-06-26 04:14:16 +090057) -> Result<(), Error> {
Inseob Kima5a262f2021-11-17 19:41:03 +090058 let extra_apks = parse_extra_apk_list(apk, config_path)?;
59 if extra_apks.len() != extra_idsigs.len() {
60 bail!(
61 "Found {} extra apks, but there are {} extra idsigs",
62 extra_apks.len(),
63 extra_idsigs.len()
64 )
65 }
66
67 for i in 0..extra_apks.len() {
68 let extra_apk_fd = ParcelFileDescriptor::new(File::open(&extra_apks[i])?);
69 let extra_idsig_fd = ParcelFileDescriptor::new(File::create(&extra_idsigs[i])?);
70 service.createOrUpdateIdsigFile(&extra_apk_fd, &extra_idsig_fd)?;
71 }
72
Jooyung Han21e9b922021-06-26 04:14:16 +090073 let apk_file = File::open(apk).context("Failed to open APK file")?;
Jiyong Park0a248432021-08-20 23:32:39 +090074 let idsig_file = File::create(idsig).context("Failed to create idsig file")?;
75
76 let apk_fd = ParcelFileDescriptor::new(apk_file);
77 let idsig_fd = ParcelFileDescriptor::new(idsig_file);
78 service.createOrUpdateIdsigFile(&apk_fd, &idsig_fd)?;
79
Jooyung Han21e9b922021-06-26 04:14:16 +090080 let idsig_file = File::open(idsig).context("Failed to open idsig file")?;
Jiyong Park0a248432021-08-20 23:32:39 +090081 let idsig_fd = ParcelFileDescriptor::new(idsig_file);
Jiyong Park48b354d2021-07-15 15:04:38 +090082
83 if !instance.exists() {
84 const INSTANCE_FILE_SIZE: u64 = 10 * 1024 * 1024;
Jiyong Park9dd389e2021-08-23 20:42:59 +090085 command_create_partition(
86 service.clone(),
87 instance,
88 INSTANCE_FILE_SIZE,
89 PartitionType::ANDROID_VM_INSTANCE,
90 )?;
Jiyong Park48b354d2021-07-15 15:04:38 +090091 }
92
Inseob Kima5a262f2021-11-17 19:41:03 +090093 let extra_idsig_files: Result<Vec<File>, _> = extra_idsigs.iter().map(File::open).collect();
94 let extra_idsig_fds = extra_idsig_files?.into_iter().map(ParcelFileDescriptor::new).collect();
95
Jooyung Han21e9b922021-06-26 04:14:16 +090096 let config = VirtualMachineConfig::AppConfig(VirtualMachineAppConfig {
Jiyong Park0a248432021-08-20 23:32:39 +090097 apk: apk_fd.into(),
98 idsig: idsig_fd.into(),
Inseob Kima5a262f2021-11-17 19:41:03 +090099 extraIdsigs: extra_idsig_fds,
Jiyong Park48b354d2021-07-15 15:04:38 +0900100 instanceImage: open_parcel_file(instance, true /* writable */)?.into(),
Jooyung Han21e9b922021-06-26 04:14:16 +0900101 configPath: config_path.to_owned(),
Jiyong Parkc2a49cc2021-10-15 00:02:12 +0900102 debugLevel: debug_level,
Jiyong Parkd63cfff2021-09-27 20:10:17 +0900103 memoryMib: mem.unwrap_or(0) as i32, // 0 means use the VM default
Jiyong Park032615f2022-01-10 13:55:34 +0900104 numCpus: cpus.unwrap_or(1) as i32,
105 cpuAffinity: cpu_affinity,
Jooyung Han21e9b922021-06-26 04:14:16 +0900106 });
Jiyong Parkb8182bb2021-10-26 22:53:08 +0900107 run(
108 service,
109 &config,
110 &format!("{:?}!{:?}", apk, config_path),
111 daemonize,
112 console_path,
113 log_path,
114 )
Jooyung Han21e9b922021-06-26 04:14:16 +0900115}
116
Andrew Walbranf395b822021-05-05 10:38:59 +0000117/// Run a VM from the given configuration file.
118pub fn command_run(
Andrew Walbran17de24f2021-05-27 13:27:30 +0000119 service: Strong<dyn IVirtualizationService>,
Andrew Walbranf395b822021-05-05 10:38:59 +0000120 config_path: &Path,
121 daemonize: bool,
Jiyong Parkb8182bb2021-10-26 22:53:08 +0900122 console_path: Option<&Path>,
Jiyong Parkd63cfff2021-09-27 20:10:17 +0900123 mem: Option<u32>,
Jiyong Park032615f2022-01-10 13:55:34 +0900124 cpus: Option<u32>,
125 cpu_affinity: Option<String>,
Andrew Walbranf395b822021-05-05 10:38:59 +0000126) -> Result<(), Error> {
Andrew Walbran3a5a9212021-05-04 17:09:08 +0000127 let config_file = File::open(config_path).context("Failed to open config file")?;
Jiyong Parkd63cfff2021-09-27 20:10:17 +0900128 let mut config =
Andrew Walbran3a5a9212021-05-04 17:09:08 +0000129 VmConfig::load(&config_file).context("Failed to parse config file")?.to_parcelable()?;
Jiyong Parkd63cfff2021-09-27 20:10:17 +0900130 if let Some(mem) = mem {
131 config.memoryMib = mem as i32;
132 }
Jiyong Park032615f2022-01-10 13:55:34 +0900133 if let Some(cpus) = cpus {
134 config.numCpus = cpus as i32;
135 }
136 config.cpuAffinity = cpu_affinity;
Jooyung Han21e9b922021-06-26 04:14:16 +0900137 run(
138 service,
139 &VirtualMachineConfig::RawConfig(config),
140 &format!("{:?}", config_path),
141 daemonize,
Jiyong Parkb8182bb2021-10-26 22:53:08 +0900142 console_path,
143 None,
Jooyung Han21e9b922021-06-26 04:14:16 +0900144 )
145}
146
Andrew Walbranf8d94112021-09-07 11:45:36 +0000147fn state_to_str(vm_state: VirtualMachineState) -> &'static str {
148 match vm_state {
149 VirtualMachineState::NOT_STARTED => "NOT_STARTED",
150 VirtualMachineState::STARTING => "STARTING",
151 VirtualMachineState::STARTED => "STARTED",
152 VirtualMachineState::READY => "READY",
153 VirtualMachineState::FINISHED => "FINISHED",
154 VirtualMachineState::DEAD => "DEAD",
155 _ => "(invalid state)",
156 }
157}
158
Jooyung Han21e9b922021-06-26 04:14:16 +0900159fn run(
160 service: Strong<dyn IVirtualizationService>,
161 config: &VirtualMachineConfig,
162 config_path: &str,
163 daemonize: bool,
Jiyong Parkb8182bb2021-10-26 22:53:08 +0900164 console_path: Option<&Path>,
Jooyung Han21e9b922021-06-26 04:14:16 +0900165 log_path: Option<&Path>,
166) -> Result<(), Error> {
Jiyong Parkb8182bb2021-10-26 22:53:08 +0900167 let console = if let Some(console_path) = console_path {
168 Some(ParcelFileDescriptor::new(
169 File::create(console_path)
170 .with_context(|| format!("Failed to open console file {:?}", console_path))?,
171 ))
172 } else if daemonize {
173 None
174 } else {
175 Some(ParcelFileDescriptor::new(duplicate_stdout()?))
176 };
177 let log = if let Some(log_path) = log_path {
Andrew Walbranbe429242021-06-28 12:22:54 +0000178 Some(ParcelFileDescriptor::new(
179 File::create(log_path)
180 .with_context(|| format!("Failed to open log file {:?}", log_path))?,
181 ))
182 } else if daemonize {
183 None
184 } else {
185 Some(ParcelFileDescriptor::new(duplicate_stdout()?))
186 };
Jiyong Parkb8182bb2021-10-26 22:53:08 +0900187
188 let vm =
189 service.createVm(config, console.as_ref(), log.as_ref()).context("Failed to create VM")?;
Andrew Walbranf395b822021-05-05 10:38:59 +0000190
191 let cid = vm.getCid().context("Failed to get CID")?;
Andrew Walbranf8d94112021-09-07 11:45:36 +0000192 println!(
193 "Created VM from {} with CID {}, state is {}.",
194 config_path,
195 cid,
196 state_to_str(vm.getState()?)
197 );
198 vm.start()?;
199 println!("Started VM, state now {}.", state_to_str(vm.getState()?));
Andrew Walbranf395b822021-05-05 10:38:59 +0000200
201 if daemonize {
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000202 // Pass the VM reference back to VirtualizationService and have it hold it in the
203 // background.
Andrew Walbran17de24f2021-05-27 13:27:30 +0000204 service.debugHoldVmRef(&vm).context("Failed to pass VM to VirtualizationService")
Andrew Walbranf395b822021-05-05 10:38:59 +0000205 } else {
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000206 // Wait until the VM or VirtualizationService dies. If we just returned immediately then the
Andrew Walbranf395b822021-05-05 10:38:59 +0000207 // IVirtualMachine Binder object would be dropped and the VM would be killed.
208 wait_for_vm(vm)
209 }
210}
211
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000212/// Wait until the given VM or the VirtualizationService itself dies.
Andrew Walbranf395b822021-05-05 10:38:59 +0000213fn wait_for_vm(vm: Strong<dyn IVirtualMachine>) -> Result<(), Error> {
214 let dead = AtomicFlag::default();
215 let callback = BnVirtualMachineCallback::new_binder(
216 VirtualMachineCallback { dead: dead.clone() },
217 BinderFeatures::default(),
218 );
219 vm.registerCallback(&callback)?;
220 let death_recipient = wait_for_death(&mut vm.as_binder(), dead.clone())?;
221 dead.wait();
222 // Ensure that death_recipient isn't dropped before we wait on the flag, as it is removed
223 // from the Binder when it's dropped.
224 drop(death_recipient);
225 Ok(())
226}
227
228/// Raise the given flag when the given Binder object dies.
229///
230/// If the returned DeathRecipient is dropped then this will no longer do anything.
231fn wait_for_death(binder: &mut impl IBinder, dead: AtomicFlag) -> Result<DeathRecipient, Error> {
232 let mut death_recipient = DeathRecipient::new(move || {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900233 eprintln!("VirtualizationService unexpectedly died");
Andrew Walbranf395b822021-05-05 10:38:59 +0000234 dead.raise();
235 });
236 binder.link_to_death(&mut death_recipient)?;
237 Ok(death_recipient)
238}
239
Inseob Kima5a262f2021-11-17 19:41:03 +0900240fn parse_extra_apk_list(apk: &Path, config_path: &str) -> Result<Vec<String>, Error> {
241 let mut archive = ZipArchive::new(File::open(apk)?)?;
242 let config_file = archive.by_name(config_path)?;
243 let config: VmPayloadConfig = serde_json::from_reader(config_file)?;
244 Ok(config.extra_apks.into_iter().map(|x| x.path).collect())
245}
246
Andrew Walbranf395b822021-05-05 10:38:59 +0000247#[derive(Debug)]
248struct VirtualMachineCallback {
249 dead: AtomicFlag,
250}
251
252impl Interface for VirtualMachineCallback {}
253
254impl IVirtualMachineCallback for VirtualMachineCallback {
Inseob Kim7f61fe72021-08-20 20:50:47 +0900255 fn onPayloadStarted(
256 &self,
257 _cid: i32,
258 stream: Option<&ParcelFileDescriptor>,
259 ) -> BinderResult<()> {
260 // Show the output of the payload
261 if let Some(stream) = stream {
262 let mut reader = BufReader::new(stream.as_ref());
263 loop {
264 let mut s = String::new();
265 match reader.read_line(&mut s) {
266 Ok(0) => break,
267 Ok(_) => print!("{}", s),
268 Err(e) => eprintln!("error reading from virtual machine: {}", e),
269 };
270 }
Jiyong Park8611a6c2021-07-09 18:17:44 +0900271 }
272 Ok(())
273 }
274
Inseob Kim14cb8692021-08-31 21:50:39 +0900275 fn onPayloadReady(&self, _cid: i32) -> BinderResult<()> {
Inseob Kim8dbc3222021-09-01 21:50:23 +0900276 eprintln!("payload is ready");
Inseob Kim14cb8692021-08-31 21:50:39 +0900277 Ok(())
278 }
279
Inseob Kim8dbc3222021-09-01 21:50:23 +0900280 fn onPayloadFinished(&self, _cid: i32, exit_code: i32) -> BinderResult<()> {
281 eprintln!("payload finished with exit code {}", exit_code);
Inseob Kim2444af92021-08-31 01:22:50 +0900282 Ok(())
283 }
284
Jooyung Handd0a1732021-11-23 15:26:20 +0900285 fn onError(&self, _cid: i32, error_code: i32, message: &str) -> BinderResult<()> {
286 eprintln!("VM encountered an error: code={}, message={}", error_code, message);
287 Ok(())
288 }
289
Andrew Walbranc92d35f2022-01-12 12:45:19 +0000290 fn onDied(&self, _cid: i32, reason: DeathReason) -> BinderResult<()> {
Andrew Walbranf395b822021-05-05 10:38:59 +0000291 self.dead.raise();
Andrew Walbranc92d35f2022-01-12 12:45:19 +0000292
293 match reason {
294 DeathReason::SHUTDOWN => println!("VM shutdown cleanly."),
295 DeathReason::REBOOT => println!("VM tried to reboot, possibly due to a kernel panic."),
296 DeathReason::KILLED => println!("VM was killed."),
297 DeathReason::UNKNOWN => println!("VM died for an unknown reason."),
298 DeathReason::INFRASTRUCTURE_ERROR => println!("Error waiting for VM to finish."),
299 _ => println!("VM died for an unrecognised reason."),
300 }
Andrew Walbranf395b822021-05-05 10:38:59 +0000301 Ok(())
302 }
303}
304
305/// Safely duplicate the standard output file descriptor.
306fn duplicate_stdout() -> io::Result<File> {
307 let stdout_fd = io::stdout().as_raw_fd();
308 // Safe because this just duplicates a file descriptor which we know to be valid, and we check
309 // for an error.
310 let dup_fd = unsafe { libc::dup(stdout_fd) };
311 if dup_fd < 0 {
312 Err(io::Error::last_os_error())
313 } else {
314 // Safe because we have just duplicated the file descriptor so we own it, and `from_raw_fd`
315 // takes ownership of it.
316 Ok(unsafe { File::from_raw_fd(dup_fd) })
317 }
318}