blob: 23a9c03cd132081bfe476142b1f5296a21022313 [file] [log] [blame]
Andrew Walbrand6dce6f2021-03-05 16:39:08 +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
Andrew Walbranf6bf6862021-05-21 12:41:13 +000015//! Implementation of the AIDL interface of the VirtualizationService.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000016
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000017use crate::composite::make_composite_image;
18use crate::crosvm::{CrosvmConfig, DiskFile, VmInstance};
Andrew Walbrancc0db522021-07-12 17:03:42 +000019use crate::payload::add_microdroid_images;
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000020use crate::{Cid, FIRST_GUEST_CID};
Jooyung Han21e9b922021-06-26 04:14:16 +090021
Jiyong Park753553b2021-07-12 21:21:09 +090022use android_os_permissions_aidl::aidl::android::os::IPermissionController;
Andrew Walbranf6bf6862021-05-21 12:41:13 +000023use android_system_virtualizationservice::aidl::android::system::virtualizationservice::IVirtualizationService::IVirtualizationService;
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000024use android_system_virtualizationservice::aidl::android::system::virtualizationservice::DiskImage::DiskImage;
Andrew Walbranf6bf6862021-05-21 12:41:13 +000025use android_system_virtualizationservice::aidl::android::system::virtualizationservice::IVirtualMachine::{
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000026 BnVirtualMachine, IVirtualMachine,
27};
Andrew Walbranf6bf6862021-05-21 12:41:13 +000028use android_system_virtualizationservice::aidl::android::system::virtualizationservice::IVirtualMachineCallback::IVirtualMachineCallback;
Jooyung Han21e9b922021-06-26 04:14:16 +090029use android_system_virtualizationservice::aidl::android::system::virtualizationservice::{
30 VirtualMachineAppConfig::VirtualMachineAppConfig,
31 VirtualMachineConfig::VirtualMachineConfig,
32 VirtualMachineRawConfig::VirtualMachineRawConfig,
33};
Andrew Walbranf6bf6862021-05-21 12:41:13 +000034use android_system_virtualizationservice::aidl::android::system::virtualizationservice::VirtualMachineDebugInfo::VirtualMachineDebugInfo;
35use android_system_virtualizationservice::binder::{
Andrew Walbran806f1542021-06-10 14:07:12 +000036 self, BinderFeatures, ExceptionCode, Interface, ParcelFileDescriptor, Status, Strong, ThreadState,
Andrew Walbrana89fc132021-03-17 17:08:36 +000037};
Jooyung Han95884632021-07-06 22:27:54 +090038use anyhow::{bail, Context, Result};
Andrew Walbrandfc953d2021-06-10 13:59:56 +000039use disk::QcowFile;
Jiyong Park0a248432021-08-20 23:32:39 +090040use idsig::{V4Signature, HashAlgorithm};
Jiyong Park8611a6c2021-07-09 18:17:44 +090041use log::{debug, error, warn, info};
Andrew Walbrancc0db522021-07-12 17:03:42 +000042use microdroid_payload_config::VmPayloadConfig;
Andrew Walbrandff3b942021-06-09 15:20:36 +000043use std::convert::TryInto;
Andrew Walbran806f1542021-06-10 14:07:12 +000044use std::ffi::CString;
Jooyung Han95884632021-07-06 22:27:54 +090045use std::fs::{File, OpenOptions, create_dir};
Andrew Walbranb15cd6e2021-07-05 16:38:07 +000046use std::num::NonZeroU32;
Jiyong Park8611a6c2021-07-09 18:17:44 +090047use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd};
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000048use std::path::{Path, PathBuf};
Andrew Walbran320b5602021-03-04 16:11:12 +000049use std::sync::{Arc, Mutex, Weak};
Andrew Walbrancc0db522021-07-12 17:03:42 +000050use vmconfig::VmConfig;
Jiyong Park8611a6c2021-07-09 18:17:44 +090051use vsock::{VsockListener, SockAddr, VsockStream};
Jooyung Han35edb8f2021-07-01 16:17:16 +090052use zip::ZipArchive;
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000053
Andrew Walbranf6bf6862021-05-21 12:41:13 +000054pub const BINDER_SERVICE_IDENTIFIER: &str = "android.system.virtualizationservice";
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000055
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000056/// Directory in which to write disk image files used while running VMs.
Andrew Walbran488bd072021-07-14 13:29:51 +000057pub const TEMPORARY_DIRECTORY: &str = "/data/misc/virtualizationservice";
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000058
Jiyong Park8611a6c2021-07-09 18:17:44 +090059/// The CID representing the host VM
60const VMADDR_CID_HOST: u32 = 2;
61
62/// Port number that virtualizationservice listens on connections from the guest VMs for the
63/// payload output
64const PORT_VIRT_SERVICE: u32 = 3000;
65
Jooyung Han95884632021-07-06 22:27:54 +090066/// The size of zero.img.
67/// Gaps in composite disk images are filled with a shared zero.img.
68const ZERO_FILLER_SIZE: u64 = 4096;
69
Andrew Walbranf6bf6862021-05-21 12:41:13 +000070/// Implementation of `IVirtualizationService`, the entry point of the AIDL service.
Jooyung Han9900f3d2021-07-06 10:27:54 +090071#[derive(Debug, Default)]
Andrew Walbranf6bf6862021-05-21 12:41:13 +000072pub struct VirtualizationService {
Jiyong Park8611a6c2021-07-09 18:17:44 +090073 state: Arc<Mutex<State>>,
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000074}
75
Andrew Walbranf6bf6862021-05-21 12:41:13 +000076impl Interface for VirtualizationService {}
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000077
Andrew Walbranf6bf6862021-05-21 12:41:13 +000078impl IVirtualizationService for VirtualizationService {
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000079 /// Create and start a new VM with the given configuration, assigning it the next available CID.
80 ///
81 /// Returns a binder `IVirtualMachine` object referring to it, as a handle for the client.
Andrew Walbrana89fc132021-03-17 17:08:36 +000082 fn startVm(
83 &self,
Andrew Walbran3a5a9212021-05-04 17:09:08 +000084 config: &VirtualMachineConfig,
Andrew Walbrana89fc132021-03-17 17:08:36 +000085 log_fd: Option<&ParcelFileDescriptor>,
86 ) -> binder::Result<Strong<dyn IVirtualMachine>> {
Jiyong Park753553b2021-07-12 21:21:09 +090087 check_manage_access()?;
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000088 let state = &mut *self.state.lock().unwrap();
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000089 let log_fd = log_fd.map(clone_file).transpose()?;
Andrew Walbranf6a1eb92021-04-01 11:16:02 +000090 let requester_uid = ThreadState::get_calling_uid();
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000091 let requester_sid = get_calling_sid()?;
Andrew Walbran02034492021-04-13 15:05:07 +000092 let requester_debug_pid = ThreadState::get_calling_pid();
Andrew Walbrandae07162021-03-12 17:05:20 +000093 let cid = state.allocate_cid()?;
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000094
95 // Counter to generate unique IDs for temporary image files.
96 let mut next_temporary_image_id = 0;
97 // Files which are referred to from composite images. These must be mapped to the crosvm
98 // child process, and not closed before it is started.
99 let mut indirect_files = vec![];
100
101 // Make directory for temporary files.
102 let temporary_directory: PathBuf = format!("{}/{}", TEMPORARY_DIRECTORY, cid).into();
103 create_dir(&temporary_directory).map_err(|e| {
104 error!(
Andrew Walbran806f1542021-06-10 14:07:12 +0000105 "Failed to create temporary directory {:?} for VM files: {}",
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000106 temporary_directory, e
107 );
Andrew Walbran806f1542021-06-10 14:07:12 +0000108 new_binder_exception(
109 ExceptionCode::SERVICE_SPECIFIC,
110 format!(
111 "Failed to create temporary directory {:?} for VM files: {}",
112 temporary_directory, e
113 ),
114 )
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000115 })?;
116
Jooyung Han21e9b922021-06-26 04:14:16 +0900117 let config = match config {
Jooyung Han35edb8f2021-07-01 16:17:16 +0900118 VirtualMachineConfig::AppConfig(config) => BorrowedOrOwned::Owned(
Jooyung Han9900f3d2021-07-06 10:27:54 +0900119 load_app_config(config, &temporary_directory).map_err(|e| {
120 error!("Failed to load app config from {}: {}", &config.configPath, e);
121 new_binder_exception(
122 ExceptionCode::SERVICE_SPECIFIC,
123 format!("Failed to load app config from {}: {}", &config.configPath, e),
124 )
125 })?,
Jooyung Han35edb8f2021-07-01 16:17:16 +0900126 ),
127 VirtualMachineConfig::RawConfig(config) => BorrowedOrOwned::Borrowed(config),
Jooyung Han21e9b922021-06-26 04:14:16 +0900128 };
Jooyung Han35edb8f2021-07-01 16:17:16 +0900129 let config = config.as_ref();
Jooyung Han21e9b922021-06-26 04:14:16 +0900130
Jooyung Han95884632021-07-06 22:27:54 +0900131 let zero_filler_path = temporary_directory.join("zero.img");
Andrew Walbranfbb39d22021-07-28 17:01:25 +0000132 write_zero_filler(&zero_filler_path).map_err(|e| {
Jooyung Han95884632021-07-06 22:27:54 +0900133 error!("Failed to make composite image: {}", e);
134 new_binder_exception(
135 ExceptionCode::SERVICE_SPECIFIC,
136 format!("Failed to make composite image: {}", e),
137 )
138 })?;
Jooyung Han95884632021-07-06 22:27:54 +0900139
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000140 // Assemble disk images if needed.
141 let disks = config
142 .disks
143 .iter()
144 .map(|disk| {
145 assemble_disk_image(
146 disk,
Jooyung Han95884632021-07-06 22:27:54 +0900147 &zero_filler_path,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000148 &temporary_directory,
149 &mut next_temporary_image_id,
150 &mut indirect_files,
151 )
152 })
153 .collect::<Result<Vec<DiskFile>, _>>()?;
154
155 // Actually start the VM.
156 let crosvm_config = CrosvmConfig {
Andrew Walbran02034492021-04-13 15:05:07 +0000157 cid,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000158 bootloader: as_asref(&config.bootloader),
159 kernel: as_asref(&config.kernel),
160 initrd: as_asref(&config.initrd),
161 disks,
162 params: config.params.to_owned(),
Andrew Walbrancc045902021-07-27 16:06:17 +0000163 protected: config.protectedVm,
164 memory_mib: config.memoryMib.try_into().ok().and_then(NonZeroU32::new),
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000165 };
Andrew Walbran02b8ec02021-06-22 13:07:02 +0000166 let composite_disk_fds: Vec<_> =
167 indirect_files.iter().map(|file| file.as_raw_fd()).collect();
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000168 let instance = VmInstance::start(
169 &crosvm_config,
Andrew Walbran02034492021-04-13 15:05:07 +0000170 log_fd,
Andrew Walbran02b8ec02021-06-22 13:07:02 +0000171 &composite_disk_fds,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000172 temporary_directory,
Andrew Walbran02034492021-04-13 15:05:07 +0000173 requester_uid,
174 requester_sid,
175 requester_debug_pid,
Andrew Walbran3a5a9212021-05-04 17:09:08 +0000176 )
177 .map_err(|e| {
Andrew Walbran806f1542021-06-10 14:07:12 +0000178 error!("Failed to start VM with config {:?}: {}", config, e);
179 new_binder_exception(
180 ExceptionCode::SERVICE_SPECIFIC,
181 format!("Failed to start VM: {}", e),
182 )
Andrew Walbran3a5a9212021-05-04 17:09:08 +0000183 })?;
Andrew Walbran320b5602021-03-04 16:11:12 +0000184 state.add_vm(Arc::downgrade(&instance));
185 Ok(VirtualMachine::create(instance))
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000186 }
Andrew Walbran320b5602021-03-04 16:11:12 +0000187
Andrew Walbrandff3b942021-06-09 15:20:36 +0000188 /// Initialise an empty partition image of the given size to be used as a writable partition.
189 fn initializeWritablePartition(
190 &self,
191 image_fd: &ParcelFileDescriptor,
192 size: i64,
193 ) -> binder::Result<()> {
Jiyong Park753553b2021-07-12 21:21:09 +0900194 check_manage_access()?;
Andrew Walbrandfc953d2021-06-10 13:59:56 +0000195 let size = size.try_into().map_err(|e| {
Andrew Walbran806f1542021-06-10 14:07:12 +0000196 new_binder_exception(
197 ExceptionCode::ILLEGAL_ARGUMENT,
198 format!("Invalid size {}: {}", size, e),
199 )
Andrew Walbrandff3b942021-06-09 15:20:36 +0000200 })?;
Andrew Walbrandfc953d2021-06-10 13:59:56 +0000201 let image = clone_file(image_fd)?;
Andrew Walbrandff3b942021-06-09 15:20:36 +0000202
Andrew Walbrandfc953d2021-06-10 13:59:56 +0000203 QcowFile::new(image, size).map_err(|e| {
Andrew Walbran806f1542021-06-10 14:07:12 +0000204 new_binder_exception(
205 ExceptionCode::SERVICE_SPECIFIC,
206 format!("Failed to create QCOW2 image: {}", e),
207 )
Andrew Walbrandfc953d2021-06-10 13:59:56 +0000208 })?;
Andrew Walbrandff3b942021-06-09 15:20:36 +0000209
210 Ok(())
211 }
212
Jiyong Park0a248432021-08-20 23:32:39 +0900213 /// Creates or update the idsig file by digesting the input APK file.
214 fn createOrUpdateIdsigFile(
215 &self,
216 input_fd: &ParcelFileDescriptor,
217 idsig_fd: &ParcelFileDescriptor,
218 ) -> binder::Result<()> {
219 // TODO(b/193504400): do this only when (1) idsig_fd is empty or (2) the APK digest in
220 // idsig_fd is different from APK digest in input_fd
221
222 let mut input = clone_file(input_fd)?;
223 let mut sig = V4Signature::create(&mut input, 4096, &[], HashAlgorithm::SHA256).unwrap();
224
225 let mut output = clone_file(idsig_fd)?;
226 output.set_len(0).unwrap();
227 sig.write_into(&mut output).unwrap();
228 Ok(())
229 }
230
Andrew Walbran320b5602021-03-04 16:11:12 +0000231 /// Get a list of all currently running VMs. This method is only intended for debug purposes,
232 /// and as such is only permitted from the shell user.
233 fn debugListVms(&self) -> binder::Result<Vec<VirtualMachineDebugInfo>> {
Andrew Walbran806f1542021-06-10 14:07:12 +0000234 check_debug_access()?;
Andrew Walbran320b5602021-03-04 16:11:12 +0000235
236 let state = &mut *self.state.lock().unwrap();
237 let vms = state.vms();
Andrew Walbranf6a1eb92021-04-01 11:16:02 +0000238 let cids = vms
239 .into_iter()
240 .map(|vm| VirtualMachineDebugInfo {
241 cid: vm.cid as i32,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000242 temporaryDirectory: vm.temporary_directory.to_string_lossy().to_string(),
Andrew Walbran1ef19ae2021-04-07 11:31:57 +0000243 requesterUid: vm.requester_uid as i32,
244 requesterSid: vm.requester_sid.clone(),
Andrew Walbran02034492021-04-13 15:05:07 +0000245 requesterPid: vm.requester_debug_pid,
Andrew Walbrandae07162021-03-12 17:05:20 +0000246 running: vm.running(),
Andrew Walbranf6a1eb92021-04-01 11:16:02 +0000247 })
248 .collect();
Andrew Walbran320b5602021-03-04 16:11:12 +0000249 Ok(cids)
250 }
David Brazdil3c2ddef2021-03-18 13:09:57 +0000251
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000252 /// Hold a strong reference to a VM in VirtualizationService. This method is only intended for
253 /// debug purposes, and as such is only permitted from the shell user.
Andrei Homescu1415c132021-03-24 02:39:55 +0000254 fn debugHoldVmRef(&self, vmref: &Strong<dyn IVirtualMachine>) -> binder::Result<()> {
Andrew Walbran806f1542021-06-10 14:07:12 +0000255 check_debug_access()?;
David Brazdil3c2ddef2021-03-18 13:09:57 +0000256
David Brazdil3c2ddef2021-03-18 13:09:57 +0000257 let state = &mut *self.state.lock().unwrap();
Andrei Homescu1415c132021-03-24 02:39:55 +0000258 state.debug_hold_vm(vmref.clone());
David Brazdil3c2ddef2021-03-18 13:09:57 +0000259 Ok(())
260 }
261
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000262 /// Drop reference to a VM that is being held by VirtualizationService. Returns the reference if
263 /// the VM was found and None otherwise. This method is only intended for debug purposes, and as
264 /// such is only permitted from the shell user.
David Brazdil3c2ddef2021-03-18 13:09:57 +0000265 fn debugDropVmRef(&self, cid: i32) -> binder::Result<Option<Strong<dyn IVirtualMachine>>> {
Andrew Walbran806f1542021-06-10 14:07:12 +0000266 check_debug_access()?;
David Brazdil3c2ddef2021-03-18 13:09:57 +0000267
268 let state = &mut *self.state.lock().unwrap();
269 Ok(state.debug_drop_vm(cid))
270 }
Andrew Walbran320b5602021-03-04 16:11:12 +0000271}
272
Jiyong Park8611a6c2021-07-09 18:17:44 +0900273impl VirtualizationService {
274 pub fn init() -> VirtualizationService {
275 let service = VirtualizationService::default();
276 let state = service.state.clone(); // reference to state (not the state itself) is copied
277 std::thread::spawn(move || {
278 handle_connection_from_vm(state).unwrap();
279 });
280 service
281 }
282}
283
284/// Waits for incoming connections from VM. If a new connection is made, notify the event to the
285/// client via the callback (if registered).
286fn handle_connection_from_vm(state: Arc<Mutex<State>>) -> Result<()> {
287 let listener = VsockListener::bind_with_cid_port(VMADDR_CID_HOST, PORT_VIRT_SERVICE)?;
288 for stream in listener.incoming() {
289 let stream = match stream {
290 Err(e) => {
291 warn!("invalid incoming connection: {}", e);
292 continue;
293 }
294 Ok(s) => s,
295 };
296 if let Ok(SockAddr::Vsock(addr)) = stream.peer_addr() {
297 let cid = addr.cid();
298 let port = addr.port();
299 info!("connected from cid={}, port={}", cid, port);
300 if cid < FIRST_GUEST_CID {
301 warn!("connection is not from a guest VM");
302 continue;
303 }
304 if let Some(vm) = state.lock().unwrap().get_vm(cid) {
305 vm.callbacks.notify_payload_started(cid, stream);
306 }
307 }
308 }
309 Ok(())
310}
311
Andrew Walbranfbb39d22021-07-28 17:01:25 +0000312fn write_zero_filler(zero_filler_path: &Path) -> Result<()> {
Jooyung Han95884632021-07-06 22:27:54 +0900313 let file = OpenOptions::new()
314 .create_new(true)
315 .read(true)
316 .write(true)
317 .open(zero_filler_path)
318 .with_context(|| "Failed to create zero.img")?;
319 file.set_len(ZERO_FILLER_SIZE)?;
Andrew Walbranfbb39d22021-07-28 17:01:25 +0000320 Ok(())
Jooyung Han95884632021-07-06 22:27:54 +0900321}
322
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000323/// Given the configuration for a disk image, assembles the `DiskFile` to pass to crosvm.
324///
325/// This may involve assembling a composite disk from a set of partition images.
326fn assemble_disk_image(
327 disk: &DiskImage,
Jooyung Han95884632021-07-06 22:27:54 +0900328 zero_filler_path: &Path,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000329 temporary_directory: &Path,
330 next_temporary_image_id: &mut u64,
331 indirect_files: &mut Vec<File>,
Andrew Walbran806f1542021-06-10 14:07:12 +0000332) -> Result<DiskFile, Status> {
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000333 let image = if !disk.partitions.is_empty() {
334 if disk.image.is_some() {
335 warn!("DiskImage {:?} contains both image and partitions.", disk);
Andrew Walbran806f1542021-06-10 14:07:12 +0000336 return Err(new_binder_exception(
337 ExceptionCode::ILLEGAL_ARGUMENT,
338 "DiskImage contains both image and partitions.",
339 ));
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000340 }
341
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000342 let composite_image_filenames =
343 make_composite_image_filenames(temporary_directory, next_temporary_image_id);
344 let (image, partition_files) = make_composite_image(
345 &disk.partitions,
Jooyung Han95884632021-07-06 22:27:54 +0900346 zero_filler_path,
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000347 &composite_image_filenames.composite,
348 &composite_image_filenames.header,
349 &composite_image_filenames.footer,
350 )
351 .map_err(|e| {
352 error!("Failed to make composite image with config {:?}: {}", disk, e);
353 new_binder_exception(
354 ExceptionCode::SERVICE_SPECIFIC,
355 format!("Failed to make composite image: {}", e),
356 )
357 })?;
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000358
359 // Pass the file descriptors for the various partition files to crosvm when it
360 // is run.
361 indirect_files.extend(partition_files);
362
363 image
364 } else if let Some(image) = &disk.image {
365 clone_file(image)?
366 } else {
367 warn!("DiskImage {:?} didn't contain image or partitions.", disk);
Andrew Walbran806f1542021-06-10 14:07:12 +0000368 return Err(new_binder_exception(
369 ExceptionCode::ILLEGAL_ARGUMENT,
370 "DiskImage didn't contain image or partitions.",
371 ));
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000372 };
373
374 Ok(DiskFile { image, writable: disk.writable })
375}
376
Jooyung Han21e9b922021-06-26 04:14:16 +0900377fn load_app_config(
378 config: &VirtualMachineAppConfig,
379 temporary_directory: &Path,
Jooyung Hanadfb76c2021-06-28 17:29:30 +0900380) -> Result<VirtualMachineRawConfig> {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000381 let apk_file = clone_file(config.apk.as_ref().unwrap())?;
382 let idsig_file = clone_file(config.idsig.as_ref().unwrap())?;
Jiyong Park8d081812021-07-23 17:45:04 +0900383 let instance_file = clone_file(config.instanceImage.as_ref().unwrap())?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900384 let config_path = &config.configPath;
385
Andrew Walbrancc0db522021-07-12 17:03:42 +0000386 let mut apk_zip = ZipArchive::new(&apk_file)?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900387 let config_file = apk_zip.by_name(config_path)?;
388 let vm_payload_config: VmPayloadConfig = serde_json::from_reader(config_file)?;
389
390 let os_name = &vm_payload_config.os.name;
Andrew Walbrancc0db522021-07-12 17:03:42 +0000391
Jooyung Han35edb8f2021-07-01 16:17:16 +0900392 // For now, the only supported "os" value is "microdroid"
393 if os_name != "microdroid" {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000394 bail!("Unknown OS \"{}\"", os_name);
Jooyung Han35edb8f2021-07-01 16:17:16 +0900395 }
Andrew Walbrancc0db522021-07-12 17:03:42 +0000396
397 // It is safe to construct a filename based on the os_name because we've already checked that it
398 // is one of the allowed values.
Jooyung Han21e9b922021-06-26 04:14:16 +0900399 let vm_config_path = PathBuf::from(format!("/apex/com.android.virt/etc/{}.json", os_name));
400 let vm_config_file = File::open(vm_config_path)?;
Andrew Walbrancc0db522021-07-12 17:03:42 +0000401 let mut vm_config = VmConfig::load(&vm_config_file)?.to_parcelable()?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900402
Andrew Walbrancc045902021-07-27 16:06:17 +0000403 if config.memoryMib > 0 {
404 vm_config.memoryMib = config.memoryMib;
Andrew Walbran45bcb0c2021-07-14 15:02:06 +0000405 }
406
Andrew Walbrancc0db522021-07-12 17:03:42 +0000407 // Microdroid requires an additional payload disk image and the bootconfig partition.
Jooyung Hanadfb76c2021-06-28 17:29:30 +0900408 if os_name == "microdroid" {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000409 let apexes = vm_payload_config.apexes.clone();
410 add_microdroid_images(
411 config,
Jooyung Hanadfb76c2021-06-28 17:29:30 +0900412 temporary_directory,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000413 apk_file,
414 idsig_file,
Jiyong Park8d081812021-07-23 17:45:04 +0900415 instance_file,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000416 apexes,
417 &mut vm_config,
418 )?;
Jooyung Hanadfb76c2021-06-28 17:29:30 +0900419 }
Jooyung Han21e9b922021-06-26 04:14:16 +0900420
Andrew Walbrancc0db522021-07-12 17:03:42 +0000421 Ok(vm_config)
Jooyung Han21e9b922021-06-26 04:14:16 +0900422}
423
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000424/// Generates a unique filename to use for a composite disk image.
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000425fn make_composite_image_filenames(
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000426 temporary_directory: &Path,
427 next_temporary_image_id: &mut u64,
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000428) -> CompositeImageFilenames {
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000429 let id = *next_temporary_image_id;
430 *next_temporary_image_id += 1;
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000431 CompositeImageFilenames {
432 composite: temporary_directory.join(format!("composite-{}.img", id)),
433 header: temporary_directory.join(format!("composite-{}-header.img", id)),
434 footer: temporary_directory.join(format!("composite-{}-footer.img", id)),
435 }
436}
437
438/// Filenames for a composite disk image, including header and footer partitions.
439#[derive(Clone, Debug, Eq, PartialEq)]
440struct CompositeImageFilenames {
441 /// The composite disk image itself.
442 composite: PathBuf,
443 /// The header partition image.
444 header: PathBuf,
445 /// The footer partition image.
446 footer: PathBuf,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000447}
448
449/// Gets the calling SID of the current Binder thread.
Andrew Walbran806f1542021-06-10 14:07:12 +0000450fn get_calling_sid() -> Result<String, Status> {
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000451 ThreadState::with_calling_sid(|sid| {
452 if let Some(sid) = sid {
453 match sid.to_str() {
454 Ok(sid) => Ok(sid.to_owned()),
455 Err(e) => {
Andrew Walbran806f1542021-06-10 14:07:12 +0000456 error!("SID was not valid UTF-8: {}", e);
457 Err(new_binder_exception(
458 ExceptionCode::ILLEGAL_ARGUMENT,
459 format!("SID was not valid UTF-8: {}", e),
460 ))
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000461 }
462 }
463 } else {
464 error!("Missing SID on startVm");
Andrew Walbran806f1542021-06-10 14:07:12 +0000465 Err(new_binder_exception(ExceptionCode::SECURITY, "Missing SID on startVm"))
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000466 }
467 })
468}
469
Jiyong Park753553b2021-07-12 21:21:09 +0900470/// Checks whether the caller has a specific permission
471fn check_permission(perm: &str) -> binder::Result<()> {
472 let calling_pid = ThreadState::get_calling_pid();
473 let calling_uid = ThreadState::get_calling_uid();
474 // Root can do anything
475 if calling_uid == 0 {
476 return Ok(());
477 }
478 let perm_svc: Strong<dyn IPermissionController::IPermissionController> =
479 binder::get_interface("permission")?;
480 if perm_svc.checkPermission(perm, calling_pid, calling_uid as i32)? {
Andrew Walbran806f1542021-06-10 14:07:12 +0000481 Ok(())
482 } else {
Jiyong Park753553b2021-07-12 21:21:09 +0900483 Err(new_binder_exception(
484 ExceptionCode::SECURITY,
485 format!("does not have the {} permission", perm),
486 ))
Andrew Walbran806f1542021-06-10 14:07:12 +0000487 }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000488}
489
Jiyong Park753553b2021-07-12 21:21:09 +0900490/// Check whether the caller of the current Binder method is allowed to call debug methods.
491fn check_debug_access() -> binder::Result<()> {
492 check_permission("android.permission.DEBUG_VIRTUAL_MACHINE")
493}
494
495/// Check whether the caller of the current Binder method is allowed to manage VMs
496fn check_manage_access() -> binder::Result<()> {
497 check_permission("android.permission.MANAGE_VIRTUAL_MACHINE")
498}
499
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000500/// Implementation of the AIDL `IVirtualMachine` interface. Used as a handle to a VM.
501#[derive(Debug)]
502struct VirtualMachine {
503 instance: Arc<VmInstance>,
504}
505
506impl VirtualMachine {
507 fn create(instance: Arc<VmInstance>) -> Strong<dyn IVirtualMachine> {
508 let binder = VirtualMachine { instance };
Andrew Walbran4de28782021-04-13 14:51:43 +0000509 BnVirtualMachine::new_binder(binder, BinderFeatures::default())
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000510 }
511}
512
513impl Interface for VirtualMachine {}
514
515impl IVirtualMachine for VirtualMachine {
516 fn getCid(&self) -> binder::Result<i32> {
Jiyong Park753553b2021-07-12 21:21:09 +0900517 // Don't check permission. The owner of the VM might have passed this binder object to
518 // others.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000519 Ok(self.instance.cid as i32)
520 }
Andrew Walbrandae07162021-03-12 17:05:20 +0000521
522 fn isRunning(&self) -> binder::Result<bool> {
Jiyong Park753553b2021-07-12 21:21:09 +0900523 // Don't check permission. The owner of the VM might have passed this binder object to
524 // others.
Andrew Walbrandae07162021-03-12 17:05:20 +0000525 Ok(self.instance.running())
526 }
527
528 fn registerCallback(
529 &self,
530 callback: &Strong<dyn IVirtualMachineCallback>,
531 ) -> binder::Result<()> {
Jiyong Park753553b2021-07-12 21:21:09 +0900532 // Don't check permission. The owner of the VM might have passed this binder object to
533 // others.
534 //
Andrew Walbrandae07162021-03-12 17:05:20 +0000535 // TODO: Should this give an error if the VM is already dead?
536 self.instance.callbacks.add(callback.clone());
537 Ok(())
538 }
Andrew Walbrancbe8b082021-08-06 15:42:11 +0000539
540 fn connectVsock(&self, port: i32) -> binder::Result<ParcelFileDescriptor> {
541 if !self.instance.running() {
542 return Err(new_binder_exception(
543 ExceptionCode::SERVICE_SPECIFIC,
544 "VM is no longer running",
545 ));
546 }
547 let stream =
548 VsockStream::connect_with_cid_port(self.instance.cid, port as u32).map_err(|e| {
549 new_binder_exception(
550 ExceptionCode::SERVICE_SPECIFIC,
551 format!("Failed to connect: {}", e),
552 )
553 })?;
554 Ok(vsock_stream_to_pfd(stream))
555 }
Andrew Walbrandae07162021-03-12 17:05:20 +0000556}
557
558impl Drop for VirtualMachine {
559 fn drop(&mut self) {
560 debug!("Dropping {:?}", self);
561 self.instance.kill();
562 }
563}
564
565/// A set of Binders to be called back in response to various events on the VM, such as when it
566/// dies.
567#[derive(Debug, Default)]
568pub struct VirtualMachineCallbacks(Mutex<Vec<Strong<dyn IVirtualMachineCallback>>>);
569
570impl VirtualMachineCallbacks {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900571 /// Call all registered callbacks to notify that the payload has started.
572 pub fn notify_payload_started(&self, cid: Cid, stream: VsockStream) {
573 let callbacks = &*self.0.lock().unwrap();
Andrew Walbrancbe8b082021-08-06 15:42:11 +0000574 let pfd = vsock_stream_to_pfd(stream);
Jiyong Park8611a6c2021-07-09 18:17:44 +0900575 for callback in callbacks {
576 if let Err(e) = callback.onPayloadStarted(cid as i32, &pfd) {
577 error!("Error notifying payload start event from VM CID {}: {}", cid, e);
578 }
579 }
580 }
581
Andrew Walbrandae07162021-03-12 17:05:20 +0000582 /// Call all registered callbacks to say that the VM has died.
583 pub fn callback_on_died(&self, cid: Cid) {
584 let callbacks = &*self.0.lock().unwrap();
585 for callback in callbacks {
586 if let Err(e) = callback.onDied(cid as i32) {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900587 error!("Error notifying exit of VM CID {}: {}", cid, e);
Andrew Walbrandae07162021-03-12 17:05:20 +0000588 }
589 }
590 }
591
592 /// Add a new callback to the set.
593 fn add(&self, callback: Strong<dyn IVirtualMachineCallback>) {
594 self.0.lock().unwrap().push(callback);
595 }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000596}
597
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000598/// The mutable state of the VirtualizationService. There should only be one instance of this
599/// struct.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000600#[derive(Debug)]
601struct State {
Andrew Walbran320b5602021-03-04 16:11:12 +0000602 /// The next available unused CID.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000603 next_cid: Cid,
Andrew Walbran320b5602021-03-04 16:11:12 +0000604
605 /// The VMs which have been started. When VMs are started a weak reference is added to this list
606 /// while a strong reference is returned to the caller over Binder. Once all copies of the
607 /// Binder client are dropped the weak reference here will become invalid, and will be removed
608 /// from the list opportunistically the next time `add_vm` is called.
609 vms: Vec<Weak<VmInstance>>,
David Brazdil3c2ddef2021-03-18 13:09:57 +0000610
611 /// Vector of strong VM references held on behalf of users that cannot hold them themselves.
612 /// This is only used for debugging purposes.
613 debug_held_vms: Vec<Strong<dyn IVirtualMachine>>,
Andrew Walbran320b5602021-03-04 16:11:12 +0000614}
615
616impl State {
Andrew Walbrandae07162021-03-12 17:05:20 +0000617 /// Get a list of VMs which still have Binder references to them.
Andrew Walbran320b5602021-03-04 16:11:12 +0000618 fn vms(&self) -> Vec<Arc<VmInstance>> {
619 // Attempt to upgrade the weak pointers to strong pointers.
620 self.vms.iter().filter_map(Weak::upgrade).collect()
621 }
622
623 /// Add a new VM to the list.
624 fn add_vm(&mut self, vm: Weak<VmInstance>) {
625 // Garbage collect any entries from the stored list which no longer exist.
626 self.vms.retain(|vm| vm.strong_count() > 0);
627
628 // Actually add the new VM.
629 self.vms.push(vm);
630 }
David Brazdil3c2ddef2021-03-18 13:09:57 +0000631
Jiyong Park8611a6c2021-07-09 18:17:44 +0900632 /// Get a VM that corresponds to the given cid
633 fn get_vm(&self, cid: Cid) -> Option<Arc<VmInstance>> {
634 self.vms().into_iter().find(|vm| vm.cid == cid)
635 }
636
David Brazdil3c2ddef2021-03-18 13:09:57 +0000637 /// Store a strong VM reference.
638 fn debug_hold_vm(&mut self, vm: Strong<dyn IVirtualMachine>) {
639 self.debug_held_vms.push(vm);
640 }
641
642 /// Retrieve and remove a strong VM reference.
643 fn debug_drop_vm(&mut self, cid: i32) -> Option<Strong<dyn IVirtualMachine>> {
644 let pos = self.debug_held_vms.iter().position(|vm| vm.getCid() == Ok(cid))?;
645 Some(self.debug_held_vms.swap_remove(pos))
646 }
Andrew Walbrandae07162021-03-12 17:05:20 +0000647
648 /// Get the next available CID, or an error if we have run out.
649 fn allocate_cid(&mut self) -> binder::Result<Cid> {
650 // TODO(qwandor): keep track of which CIDs are currently in use so that we can reuse them.
651 let cid = self.next_cid;
Andrew Walbran806f1542021-06-10 14:07:12 +0000652 self.next_cid = self.next_cid.checked_add(1).ok_or(ExceptionCode::ILLEGAL_STATE)?;
Andrew Walbrandae07162021-03-12 17:05:20 +0000653 Ok(cid)
654 }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000655}
656
657impl Default for State {
658 fn default() -> Self {
David Brazdil3c2ddef2021-03-18 13:09:57 +0000659 State { next_cid: FIRST_GUEST_CID, vms: vec![], debug_held_vms: vec![] }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000660 }
661}
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000662
663/// Converts an `&Option<T>` to an `Option<U>` where `T` implements `AsRef<U>`.
664fn as_asref<T: AsRef<U>, U>(option: &Option<T>) -> Option<&U> {
665 option.as_ref().map(|t| t.as_ref())
666}
667
668/// Converts a `&ParcelFileDescriptor` to a `File` by cloning the file.
Andrew Walbran806f1542021-06-10 14:07:12 +0000669fn clone_file(file: &ParcelFileDescriptor) -> Result<File, Status> {
670 file.as_ref().try_clone().map_err(|e| {
671 new_binder_exception(
672 ExceptionCode::BAD_PARCELABLE,
673 format!("Failed to clone File from ParcelFileDescriptor: {}", e),
674 )
675 })
676}
677
Andrew Walbrancbe8b082021-08-06 15:42:11 +0000678/// Converts a `VsockStream` to a `ParcelFileDescriptor`.
679fn vsock_stream_to_pfd(stream: VsockStream) -> ParcelFileDescriptor {
680 // SAFETY: ownership is transferred from stream to f
681 let f = unsafe { File::from_raw_fd(stream.into_raw_fd()) };
682 ParcelFileDescriptor::new(f)
683}
684
Andrew Walbran806f1542021-06-10 14:07:12 +0000685/// Constructs a new Binder error `Status` with the given `ExceptionCode` and message.
686fn new_binder_exception<T: AsRef<str>>(exception: ExceptionCode, message: T) -> Status {
687 Status::new_exception(exception, CString::new(message.as_ref()).ok().as_deref())
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000688}
Jooyung Han35edb8f2021-07-01 16:17:16 +0900689
690/// Simple utility for referencing Borrowed or Owned. Similar to std::borrow::Cow, but
691/// it doesn't require that T implements Clone.
692enum BorrowedOrOwned<'a, T> {
693 Borrowed(&'a T),
694 Owned(T),
695}
696
697impl<'a, T> AsRef<T> for BorrowedOrOwned<'a, T> {
698 fn as_ref(&self) -> &T {
699 match self {
700 Self::Borrowed(b) => b,
Chris Wailes68c39f82021-07-27 16:03:44 -0700701 Self::Owned(o) => o,
Jooyung Han35edb8f2021-07-01 16:17:16 +0900702 }
703 }
704}