Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 1 | // 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 Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 15 | //! Implementation of the AIDL interface of the VirtualizationService. |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 16 | |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 17 | use crate::composite::make_composite_image; |
| 18 | use crate::crosvm::{CrosvmConfig, DiskFile, VmInstance}; |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 19 | use crate::payload::add_microdroid_images; |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 20 | use crate::{Cid, FIRST_GUEST_CID}; |
Jooyung Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 21 | |
Jiyong Park | 753553b | 2021-07-12 21:21:09 +0900 | [diff] [blame] | 22 | use android_os_permissions_aidl::aidl::android::os::IPermissionController; |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 23 | use android_system_virtualizationservice::aidl::android::system::virtualizationservice::IVirtualizationService::IVirtualizationService; |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 24 | use android_system_virtualizationservice::aidl::android::system::virtualizationservice::DiskImage::DiskImage; |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 25 | use android_system_virtualizationservice::aidl::android::system::virtualizationservice::IVirtualMachine::{ |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 26 | BnVirtualMachine, IVirtualMachine, |
| 27 | }; |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 28 | use android_system_virtualizationservice::aidl::android::system::virtualizationservice::IVirtualMachineCallback::IVirtualMachineCallback; |
Jooyung Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 29 | use android_system_virtualizationservice::aidl::android::system::virtualizationservice::{ |
| 30 | VirtualMachineAppConfig::VirtualMachineAppConfig, |
| 31 | VirtualMachineConfig::VirtualMachineConfig, |
| 32 | VirtualMachineRawConfig::VirtualMachineRawConfig, |
| 33 | }; |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 34 | use android_system_virtualizationservice::aidl::android::system::virtualizationservice::VirtualMachineDebugInfo::VirtualMachineDebugInfo; |
| 35 | use android_system_virtualizationservice::binder::{ |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 36 | self, BinderFeatures, ExceptionCode, Interface, ParcelFileDescriptor, Status, Strong, ThreadState, |
Andrew Walbran | a89fc13 | 2021-03-17 17:08:36 +0000 | [diff] [blame] | 37 | }; |
Jooyung Han | 9588463 | 2021-07-06 22:27:54 +0900 | [diff] [blame] | 38 | use anyhow::{bail, Context, Result}; |
Andrew Walbran | dfc953d | 2021-06-10 13:59:56 +0000 | [diff] [blame] | 39 | use disk::QcowFile; |
Jiyong Park | 0a24843 | 2021-08-20 23:32:39 +0900 | [diff] [blame^] | 40 | use idsig::{V4Signature, HashAlgorithm}; |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 41 | use log::{debug, error, warn, info}; |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 42 | use microdroid_payload_config::VmPayloadConfig; |
Andrew Walbran | dff3b94 | 2021-06-09 15:20:36 +0000 | [diff] [blame] | 43 | use std::convert::TryInto; |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 44 | use std::ffi::CString; |
Jooyung Han | 9588463 | 2021-07-06 22:27:54 +0900 | [diff] [blame] | 45 | use std::fs::{File, OpenOptions, create_dir}; |
Andrew Walbran | b15cd6e | 2021-07-05 16:38:07 +0000 | [diff] [blame] | 46 | use std::num::NonZeroU32; |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 47 | use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd}; |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 48 | use std::path::{Path, PathBuf}; |
Andrew Walbran | 320b560 | 2021-03-04 16:11:12 +0000 | [diff] [blame] | 49 | use std::sync::{Arc, Mutex, Weak}; |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 50 | use vmconfig::VmConfig; |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 51 | use vsock::{VsockListener, SockAddr, VsockStream}; |
Jooyung Han | 35edb8f | 2021-07-01 16:17:16 +0900 | [diff] [blame] | 52 | use zip::ZipArchive; |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 53 | |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 54 | pub const BINDER_SERVICE_IDENTIFIER: &str = "android.system.virtualizationservice"; |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 55 | |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 56 | /// Directory in which to write disk image files used while running VMs. |
Andrew Walbran | 488bd07 | 2021-07-14 13:29:51 +0000 | [diff] [blame] | 57 | pub const TEMPORARY_DIRECTORY: &str = "/data/misc/virtualizationservice"; |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 58 | |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 59 | /// The CID representing the host VM |
| 60 | const VMADDR_CID_HOST: u32 = 2; |
| 61 | |
| 62 | /// Port number that virtualizationservice listens on connections from the guest VMs for the |
| 63 | /// payload output |
| 64 | const PORT_VIRT_SERVICE: u32 = 3000; |
| 65 | |
Jooyung Han | 9588463 | 2021-07-06 22:27:54 +0900 | [diff] [blame] | 66 | /// The size of zero.img. |
| 67 | /// Gaps in composite disk images are filled with a shared zero.img. |
| 68 | const ZERO_FILLER_SIZE: u64 = 4096; |
| 69 | |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 70 | /// Implementation of `IVirtualizationService`, the entry point of the AIDL service. |
Jooyung Han | 9900f3d | 2021-07-06 10:27:54 +0900 | [diff] [blame] | 71 | #[derive(Debug, Default)] |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 72 | pub struct VirtualizationService { |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 73 | state: Arc<Mutex<State>>, |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 74 | } |
| 75 | |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 76 | impl Interface for VirtualizationService {} |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 77 | |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 78 | impl IVirtualizationService for VirtualizationService { |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 79 | /// 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 Walbran | a89fc13 | 2021-03-17 17:08:36 +0000 | [diff] [blame] | 82 | fn startVm( |
| 83 | &self, |
Andrew Walbran | 3a5a921 | 2021-05-04 17:09:08 +0000 | [diff] [blame] | 84 | config: &VirtualMachineConfig, |
Andrew Walbran | a89fc13 | 2021-03-17 17:08:36 +0000 | [diff] [blame] | 85 | log_fd: Option<&ParcelFileDescriptor>, |
| 86 | ) -> binder::Result<Strong<dyn IVirtualMachine>> { |
Jiyong Park | 753553b | 2021-07-12 21:21:09 +0900 | [diff] [blame] | 87 | check_manage_access()?; |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 88 | let state = &mut *self.state.lock().unwrap(); |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 89 | let log_fd = log_fd.map(clone_file).transpose()?; |
Andrew Walbran | f6a1eb9 | 2021-04-01 11:16:02 +0000 | [diff] [blame] | 90 | let requester_uid = ThreadState::get_calling_uid(); |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 91 | let requester_sid = get_calling_sid()?; |
Andrew Walbran | 0203449 | 2021-04-13 15:05:07 +0000 | [diff] [blame] | 92 | let requester_debug_pid = ThreadState::get_calling_pid(); |
Andrew Walbran | dae0716 | 2021-03-12 17:05:20 +0000 | [diff] [blame] | 93 | let cid = state.allocate_cid()?; |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 94 | |
| 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 Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 105 | "Failed to create temporary directory {:?} for VM files: {}", |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 106 | temporary_directory, e |
| 107 | ); |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 108 | 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 Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 115 | })?; |
| 116 | |
Jooyung Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 117 | let config = match config { |
Jooyung Han | 35edb8f | 2021-07-01 16:17:16 +0900 | [diff] [blame] | 118 | VirtualMachineConfig::AppConfig(config) => BorrowedOrOwned::Owned( |
Jooyung Han | 9900f3d | 2021-07-06 10:27:54 +0900 | [diff] [blame] | 119 | 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 Han | 35edb8f | 2021-07-01 16:17:16 +0900 | [diff] [blame] | 126 | ), |
| 127 | VirtualMachineConfig::RawConfig(config) => BorrowedOrOwned::Borrowed(config), |
Jooyung Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 128 | }; |
Jooyung Han | 35edb8f | 2021-07-01 16:17:16 +0900 | [diff] [blame] | 129 | let config = config.as_ref(); |
Jooyung Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 130 | |
Jooyung Han | 9588463 | 2021-07-06 22:27:54 +0900 | [diff] [blame] | 131 | let zero_filler_path = temporary_directory.join("zero.img"); |
Andrew Walbran | fbb39d2 | 2021-07-28 17:01:25 +0000 | [diff] [blame] | 132 | write_zero_filler(&zero_filler_path).map_err(|e| { |
Jooyung Han | 9588463 | 2021-07-06 22:27:54 +0900 | [diff] [blame] | 133 | 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 Han | 9588463 | 2021-07-06 22:27:54 +0900 | [diff] [blame] | 139 | |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 140 | // Assemble disk images if needed. |
| 141 | let disks = config |
| 142 | .disks |
| 143 | .iter() |
| 144 | .map(|disk| { |
| 145 | assemble_disk_image( |
| 146 | disk, |
Jooyung Han | 9588463 | 2021-07-06 22:27:54 +0900 | [diff] [blame] | 147 | &zero_filler_path, |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 148 | &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 Walbran | 0203449 | 2021-04-13 15:05:07 +0000 | [diff] [blame] | 157 | cid, |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 158 | 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 Walbran | cc04590 | 2021-07-27 16:06:17 +0000 | [diff] [blame] | 163 | protected: config.protectedVm, |
| 164 | memory_mib: config.memoryMib.try_into().ok().and_then(NonZeroU32::new), |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 165 | }; |
Andrew Walbran | 02b8ec0 | 2021-06-22 13:07:02 +0000 | [diff] [blame] | 166 | let composite_disk_fds: Vec<_> = |
| 167 | indirect_files.iter().map(|file| file.as_raw_fd()).collect(); |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 168 | let instance = VmInstance::start( |
| 169 | &crosvm_config, |
Andrew Walbran | 0203449 | 2021-04-13 15:05:07 +0000 | [diff] [blame] | 170 | log_fd, |
Andrew Walbran | 02b8ec0 | 2021-06-22 13:07:02 +0000 | [diff] [blame] | 171 | &composite_disk_fds, |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 172 | temporary_directory, |
Andrew Walbran | 0203449 | 2021-04-13 15:05:07 +0000 | [diff] [blame] | 173 | requester_uid, |
| 174 | requester_sid, |
| 175 | requester_debug_pid, |
Andrew Walbran | 3a5a921 | 2021-05-04 17:09:08 +0000 | [diff] [blame] | 176 | ) |
| 177 | .map_err(|e| { |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 178 | 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 Walbran | 3a5a921 | 2021-05-04 17:09:08 +0000 | [diff] [blame] | 183 | })?; |
Andrew Walbran | 320b560 | 2021-03-04 16:11:12 +0000 | [diff] [blame] | 184 | state.add_vm(Arc::downgrade(&instance)); |
| 185 | Ok(VirtualMachine::create(instance)) |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 186 | } |
Andrew Walbran | 320b560 | 2021-03-04 16:11:12 +0000 | [diff] [blame] | 187 | |
Andrew Walbran | dff3b94 | 2021-06-09 15:20:36 +0000 | [diff] [blame] | 188 | /// 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 Park | 753553b | 2021-07-12 21:21:09 +0900 | [diff] [blame] | 194 | check_manage_access()?; |
Andrew Walbran | dfc953d | 2021-06-10 13:59:56 +0000 | [diff] [blame] | 195 | let size = size.try_into().map_err(|e| { |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 196 | new_binder_exception( |
| 197 | ExceptionCode::ILLEGAL_ARGUMENT, |
| 198 | format!("Invalid size {}: {}", size, e), |
| 199 | ) |
Andrew Walbran | dff3b94 | 2021-06-09 15:20:36 +0000 | [diff] [blame] | 200 | })?; |
Andrew Walbran | dfc953d | 2021-06-10 13:59:56 +0000 | [diff] [blame] | 201 | let image = clone_file(image_fd)?; |
Andrew Walbran | dff3b94 | 2021-06-09 15:20:36 +0000 | [diff] [blame] | 202 | |
Andrew Walbran | dfc953d | 2021-06-10 13:59:56 +0000 | [diff] [blame] | 203 | QcowFile::new(image, size).map_err(|e| { |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 204 | new_binder_exception( |
| 205 | ExceptionCode::SERVICE_SPECIFIC, |
| 206 | format!("Failed to create QCOW2 image: {}", e), |
| 207 | ) |
Andrew Walbran | dfc953d | 2021-06-10 13:59:56 +0000 | [diff] [blame] | 208 | })?; |
Andrew Walbran | dff3b94 | 2021-06-09 15:20:36 +0000 | [diff] [blame] | 209 | |
| 210 | Ok(()) |
| 211 | } |
| 212 | |
Jiyong Park | 0a24843 | 2021-08-20 23:32:39 +0900 | [diff] [blame^] | 213 | /// 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 Walbran | 320b560 | 2021-03-04 16:11:12 +0000 | [diff] [blame] | 231 | /// 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 Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 234 | check_debug_access()?; |
Andrew Walbran | 320b560 | 2021-03-04 16:11:12 +0000 | [diff] [blame] | 235 | |
| 236 | let state = &mut *self.state.lock().unwrap(); |
| 237 | let vms = state.vms(); |
Andrew Walbran | f6a1eb9 | 2021-04-01 11:16:02 +0000 | [diff] [blame] | 238 | let cids = vms |
| 239 | .into_iter() |
| 240 | .map(|vm| VirtualMachineDebugInfo { |
| 241 | cid: vm.cid as i32, |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 242 | temporaryDirectory: vm.temporary_directory.to_string_lossy().to_string(), |
Andrew Walbran | 1ef19ae | 2021-04-07 11:31:57 +0000 | [diff] [blame] | 243 | requesterUid: vm.requester_uid as i32, |
| 244 | requesterSid: vm.requester_sid.clone(), |
Andrew Walbran | 0203449 | 2021-04-13 15:05:07 +0000 | [diff] [blame] | 245 | requesterPid: vm.requester_debug_pid, |
Andrew Walbran | dae0716 | 2021-03-12 17:05:20 +0000 | [diff] [blame] | 246 | running: vm.running(), |
Andrew Walbran | f6a1eb9 | 2021-04-01 11:16:02 +0000 | [diff] [blame] | 247 | }) |
| 248 | .collect(); |
Andrew Walbran | 320b560 | 2021-03-04 16:11:12 +0000 | [diff] [blame] | 249 | Ok(cids) |
| 250 | } |
David Brazdil | 3c2ddef | 2021-03-18 13:09:57 +0000 | [diff] [blame] | 251 | |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 252 | /// 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 Homescu | 1415c13 | 2021-03-24 02:39:55 +0000 | [diff] [blame] | 254 | fn debugHoldVmRef(&self, vmref: &Strong<dyn IVirtualMachine>) -> binder::Result<()> { |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 255 | check_debug_access()?; |
David Brazdil | 3c2ddef | 2021-03-18 13:09:57 +0000 | [diff] [blame] | 256 | |
David Brazdil | 3c2ddef | 2021-03-18 13:09:57 +0000 | [diff] [blame] | 257 | let state = &mut *self.state.lock().unwrap(); |
Andrei Homescu | 1415c13 | 2021-03-24 02:39:55 +0000 | [diff] [blame] | 258 | state.debug_hold_vm(vmref.clone()); |
David Brazdil | 3c2ddef | 2021-03-18 13:09:57 +0000 | [diff] [blame] | 259 | Ok(()) |
| 260 | } |
| 261 | |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 262 | /// 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 Brazdil | 3c2ddef | 2021-03-18 13:09:57 +0000 | [diff] [blame] | 265 | fn debugDropVmRef(&self, cid: i32) -> binder::Result<Option<Strong<dyn IVirtualMachine>>> { |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 266 | check_debug_access()?; |
David Brazdil | 3c2ddef | 2021-03-18 13:09:57 +0000 | [diff] [blame] | 267 | |
| 268 | let state = &mut *self.state.lock().unwrap(); |
| 269 | Ok(state.debug_drop_vm(cid)) |
| 270 | } |
Andrew Walbran | 320b560 | 2021-03-04 16:11:12 +0000 | [diff] [blame] | 271 | } |
| 272 | |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 273 | impl 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). |
| 286 | fn 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 Walbran | fbb39d2 | 2021-07-28 17:01:25 +0000 | [diff] [blame] | 312 | fn write_zero_filler(zero_filler_path: &Path) -> Result<()> { |
Jooyung Han | 9588463 | 2021-07-06 22:27:54 +0900 | [diff] [blame] | 313 | 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 Walbran | fbb39d2 | 2021-07-28 17:01:25 +0000 | [diff] [blame] | 320 | Ok(()) |
Jooyung Han | 9588463 | 2021-07-06 22:27:54 +0900 | [diff] [blame] | 321 | } |
| 322 | |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 323 | /// 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. |
| 326 | fn assemble_disk_image( |
| 327 | disk: &DiskImage, |
Jooyung Han | 9588463 | 2021-07-06 22:27:54 +0900 | [diff] [blame] | 328 | zero_filler_path: &Path, |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 329 | temporary_directory: &Path, |
| 330 | next_temporary_image_id: &mut u64, |
| 331 | indirect_files: &mut Vec<File>, |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 332 | ) -> Result<DiskFile, Status> { |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 333 | let image = if !disk.partitions.is_empty() { |
| 334 | if disk.image.is_some() { |
| 335 | warn!("DiskImage {:?} contains both image and partitions.", disk); |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 336 | return Err(new_binder_exception( |
| 337 | ExceptionCode::ILLEGAL_ARGUMENT, |
| 338 | "DiskImage contains both image and partitions.", |
| 339 | )); |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 340 | } |
| 341 | |
Andrew Walbran | 3eca16c | 2021-06-14 11:15:14 +0000 | [diff] [blame] | 342 | 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 Han | 9588463 | 2021-07-06 22:27:54 +0900 | [diff] [blame] | 346 | zero_filler_path, |
Andrew Walbran | 3eca16c | 2021-06-14 11:15:14 +0000 | [diff] [blame] | 347 | &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 Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 358 | |
| 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 Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 368 | return Err(new_binder_exception( |
| 369 | ExceptionCode::ILLEGAL_ARGUMENT, |
| 370 | "DiskImage didn't contain image or partitions.", |
| 371 | )); |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 372 | }; |
| 373 | |
| 374 | Ok(DiskFile { image, writable: disk.writable }) |
| 375 | } |
| 376 | |
Jooyung Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 377 | fn load_app_config( |
| 378 | config: &VirtualMachineAppConfig, |
| 379 | temporary_directory: &Path, |
Jooyung Han | adfb76c | 2021-06-28 17:29:30 +0900 | [diff] [blame] | 380 | ) -> Result<VirtualMachineRawConfig> { |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 381 | let apk_file = clone_file(config.apk.as_ref().unwrap())?; |
| 382 | let idsig_file = clone_file(config.idsig.as_ref().unwrap())?; |
Jiyong Park | 8d08181 | 2021-07-23 17:45:04 +0900 | [diff] [blame] | 383 | let instance_file = clone_file(config.instanceImage.as_ref().unwrap())?; |
Jooyung Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 384 | let config_path = &config.configPath; |
| 385 | |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 386 | let mut apk_zip = ZipArchive::new(&apk_file)?; |
Jooyung Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 387 | 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 Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 391 | |
Jooyung Han | 35edb8f | 2021-07-01 16:17:16 +0900 | [diff] [blame] | 392 | // For now, the only supported "os" value is "microdroid" |
| 393 | if os_name != "microdroid" { |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 394 | bail!("Unknown OS \"{}\"", os_name); |
Jooyung Han | 35edb8f | 2021-07-01 16:17:16 +0900 | [diff] [blame] | 395 | } |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 396 | |
| 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 Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 399 | 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 Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 401 | let mut vm_config = VmConfig::load(&vm_config_file)?.to_parcelable()?; |
Jooyung Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 402 | |
Andrew Walbran | cc04590 | 2021-07-27 16:06:17 +0000 | [diff] [blame] | 403 | if config.memoryMib > 0 { |
| 404 | vm_config.memoryMib = config.memoryMib; |
Andrew Walbran | 45bcb0c | 2021-07-14 15:02:06 +0000 | [diff] [blame] | 405 | } |
| 406 | |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 407 | // Microdroid requires an additional payload disk image and the bootconfig partition. |
Jooyung Han | adfb76c | 2021-06-28 17:29:30 +0900 | [diff] [blame] | 408 | if os_name == "microdroid" { |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 409 | let apexes = vm_payload_config.apexes.clone(); |
| 410 | add_microdroid_images( |
| 411 | config, |
Jooyung Han | adfb76c | 2021-06-28 17:29:30 +0900 | [diff] [blame] | 412 | temporary_directory, |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 413 | apk_file, |
| 414 | idsig_file, |
Jiyong Park | 8d08181 | 2021-07-23 17:45:04 +0900 | [diff] [blame] | 415 | instance_file, |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 416 | apexes, |
| 417 | &mut vm_config, |
| 418 | )?; |
Jooyung Han | adfb76c | 2021-06-28 17:29:30 +0900 | [diff] [blame] | 419 | } |
Jooyung Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 420 | |
Andrew Walbran | cc0db52 | 2021-07-12 17:03:42 +0000 | [diff] [blame] | 421 | Ok(vm_config) |
Jooyung Han | 21e9b92 | 2021-06-26 04:14:16 +0900 | [diff] [blame] | 422 | } |
| 423 | |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 424 | /// Generates a unique filename to use for a composite disk image. |
Andrew Walbran | 3eca16c | 2021-06-14 11:15:14 +0000 | [diff] [blame] | 425 | fn make_composite_image_filenames( |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 426 | temporary_directory: &Path, |
| 427 | next_temporary_image_id: &mut u64, |
Andrew Walbran | 3eca16c | 2021-06-14 11:15:14 +0000 | [diff] [blame] | 428 | ) -> CompositeImageFilenames { |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 429 | let id = *next_temporary_image_id; |
| 430 | *next_temporary_image_id += 1; |
Andrew Walbran | 3eca16c | 2021-06-14 11:15:14 +0000 | [diff] [blame] | 431 | 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)] |
| 440 | struct 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 Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 447 | } |
| 448 | |
| 449 | /// Gets the calling SID of the current Binder thread. |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 450 | fn get_calling_sid() -> Result<String, Status> { |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 451 | 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 Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 456 | 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 Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 461 | } |
| 462 | } |
| 463 | } else { |
| 464 | error!("Missing SID on startVm"); |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 465 | Err(new_binder_exception(ExceptionCode::SECURITY, "Missing SID on startVm")) |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 466 | } |
| 467 | }) |
| 468 | } |
| 469 | |
Jiyong Park | 753553b | 2021-07-12 21:21:09 +0900 | [diff] [blame] | 470 | /// Checks whether the caller has a specific permission |
| 471 | fn 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 Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 481 | Ok(()) |
| 482 | } else { |
Jiyong Park | 753553b | 2021-07-12 21:21:09 +0900 | [diff] [blame] | 483 | Err(new_binder_exception( |
| 484 | ExceptionCode::SECURITY, |
| 485 | format!("does not have the {} permission", perm), |
| 486 | )) |
Andrew Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 487 | } |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 488 | } |
| 489 | |
Jiyong Park | 753553b | 2021-07-12 21:21:09 +0900 | [diff] [blame] | 490 | /// Check whether the caller of the current Binder method is allowed to call debug methods. |
| 491 | fn 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 |
| 496 | fn check_manage_access() -> binder::Result<()> { |
| 497 | check_permission("android.permission.MANAGE_VIRTUAL_MACHINE") |
| 498 | } |
| 499 | |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 500 | /// Implementation of the AIDL `IVirtualMachine` interface. Used as a handle to a VM. |
| 501 | #[derive(Debug)] |
| 502 | struct VirtualMachine { |
| 503 | instance: Arc<VmInstance>, |
| 504 | } |
| 505 | |
| 506 | impl VirtualMachine { |
| 507 | fn create(instance: Arc<VmInstance>) -> Strong<dyn IVirtualMachine> { |
| 508 | let binder = VirtualMachine { instance }; |
Andrew Walbran | 4de2878 | 2021-04-13 14:51:43 +0000 | [diff] [blame] | 509 | BnVirtualMachine::new_binder(binder, BinderFeatures::default()) |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 510 | } |
| 511 | } |
| 512 | |
| 513 | impl Interface for VirtualMachine {} |
| 514 | |
| 515 | impl IVirtualMachine for VirtualMachine { |
| 516 | fn getCid(&self) -> binder::Result<i32> { |
Jiyong Park | 753553b | 2021-07-12 21:21:09 +0900 | [diff] [blame] | 517 | // Don't check permission. The owner of the VM might have passed this binder object to |
| 518 | // others. |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 519 | Ok(self.instance.cid as i32) |
| 520 | } |
Andrew Walbran | dae0716 | 2021-03-12 17:05:20 +0000 | [diff] [blame] | 521 | |
| 522 | fn isRunning(&self) -> binder::Result<bool> { |
Jiyong Park | 753553b | 2021-07-12 21:21:09 +0900 | [diff] [blame] | 523 | // Don't check permission. The owner of the VM might have passed this binder object to |
| 524 | // others. |
Andrew Walbran | dae0716 | 2021-03-12 17:05:20 +0000 | [diff] [blame] | 525 | Ok(self.instance.running()) |
| 526 | } |
| 527 | |
| 528 | fn registerCallback( |
| 529 | &self, |
| 530 | callback: &Strong<dyn IVirtualMachineCallback>, |
| 531 | ) -> binder::Result<()> { |
Jiyong Park | 753553b | 2021-07-12 21:21:09 +0900 | [diff] [blame] | 532 | // Don't check permission. The owner of the VM might have passed this binder object to |
| 533 | // others. |
| 534 | // |
Andrew Walbran | dae0716 | 2021-03-12 17:05:20 +0000 | [diff] [blame] | 535 | // TODO: Should this give an error if the VM is already dead? |
| 536 | self.instance.callbacks.add(callback.clone()); |
| 537 | Ok(()) |
| 538 | } |
Andrew Walbran | cbe8b08 | 2021-08-06 15:42:11 +0000 | [diff] [blame] | 539 | |
| 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 Walbran | dae0716 | 2021-03-12 17:05:20 +0000 | [diff] [blame] | 556 | } |
| 557 | |
| 558 | impl 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)] |
| 568 | pub struct VirtualMachineCallbacks(Mutex<Vec<Strong<dyn IVirtualMachineCallback>>>); |
| 569 | |
| 570 | impl VirtualMachineCallbacks { |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 571 | /// 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 Walbran | cbe8b08 | 2021-08-06 15:42:11 +0000 | [diff] [blame] | 574 | let pfd = vsock_stream_to_pfd(stream); |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 575 | 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 Walbran | dae0716 | 2021-03-12 17:05:20 +0000 | [diff] [blame] | 582 | /// 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 Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 587 | error!("Error notifying exit of VM CID {}: {}", cid, e); |
Andrew Walbran | dae0716 | 2021-03-12 17:05:20 +0000 | [diff] [blame] | 588 | } |
| 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 Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 596 | } |
| 597 | |
Andrew Walbran | f6bf686 | 2021-05-21 12:41:13 +0000 | [diff] [blame] | 598 | /// The mutable state of the VirtualizationService. There should only be one instance of this |
| 599 | /// struct. |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 600 | #[derive(Debug)] |
| 601 | struct State { |
Andrew Walbran | 320b560 | 2021-03-04 16:11:12 +0000 | [diff] [blame] | 602 | /// The next available unused CID. |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 603 | next_cid: Cid, |
Andrew Walbran | 320b560 | 2021-03-04 16:11:12 +0000 | [diff] [blame] | 604 | |
| 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 Brazdil | 3c2ddef | 2021-03-18 13:09:57 +0000 | [diff] [blame] | 610 | |
| 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 Walbran | 320b560 | 2021-03-04 16:11:12 +0000 | [diff] [blame] | 614 | } |
| 615 | |
| 616 | impl State { |
Andrew Walbran | dae0716 | 2021-03-12 17:05:20 +0000 | [diff] [blame] | 617 | /// Get a list of VMs which still have Binder references to them. |
Andrew Walbran | 320b560 | 2021-03-04 16:11:12 +0000 | [diff] [blame] | 618 | 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 Brazdil | 3c2ddef | 2021-03-18 13:09:57 +0000 | [diff] [blame] | 631 | |
Jiyong Park | 8611a6c | 2021-07-09 18:17:44 +0900 | [diff] [blame] | 632 | /// 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 Brazdil | 3c2ddef | 2021-03-18 13:09:57 +0000 | [diff] [blame] | 637 | /// 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 Walbran | dae0716 | 2021-03-12 17:05:20 +0000 | [diff] [blame] | 647 | |
| 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 Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 652 | self.next_cid = self.next_cid.checked_add(1).ok_or(ExceptionCode::ILLEGAL_STATE)?; |
Andrew Walbran | dae0716 | 2021-03-12 17:05:20 +0000 | [diff] [blame] | 653 | Ok(cid) |
| 654 | } |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 655 | } |
| 656 | |
| 657 | impl Default for State { |
| 658 | fn default() -> Self { |
David Brazdil | 3c2ddef | 2021-03-18 13:09:57 +0000 | [diff] [blame] | 659 | State { next_cid: FIRST_GUEST_CID, vms: vec![], debug_held_vms: vec![] } |
Andrew Walbran | d6dce6f | 2021-03-05 16:39:08 +0000 | [diff] [blame] | 660 | } |
| 661 | } |
Andrew Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 662 | |
| 663 | /// Converts an `&Option<T>` to an `Option<U>` where `T` implements `AsRef<U>`. |
| 664 | fn 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 Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 669 | fn 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 Walbran | cbe8b08 | 2021-08-06 15:42:11 +0000 | [diff] [blame] | 678 | /// Converts a `VsockStream` to a `ParcelFileDescriptor`. |
| 679 | fn 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 Walbran | 806f154 | 2021-06-10 14:07:12 +0000 | [diff] [blame] | 685 | /// Constructs a new Binder error `Status` with the given `ExceptionCode` and message. |
| 686 | fn 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 Walbran | f5fbb7d | 2021-05-12 17:15:48 +0000 | [diff] [blame] | 688 | } |
Jooyung Han | 35edb8f | 2021-07-01 16:17:16 +0900 | [diff] [blame] | 689 | |
| 690 | /// Simple utility for referencing Borrowed or Owned. Similar to std::borrow::Cow, but |
| 691 | /// it doesn't require that T implements Clone. |
| 692 | enum BorrowedOrOwned<'a, T> { |
| 693 | Borrowed(&'a T), |
| 694 | Owned(T), |
| 695 | } |
| 696 | |
| 697 | impl<'a, T> AsRef<T> for BorrowedOrOwned<'a, T> { |
| 698 | fn as_ref(&self) -> &T { |
| 699 | match self { |
| 700 | Self::Borrowed(b) => b, |
Chris Wailes | 68c39f8 | 2021-07-27 16:03:44 -0700 | [diff] [blame] | 701 | Self::Owned(o) => o, |
Jooyung Han | 35edb8f | 2021-07-01 16:17:16 +0900 | [diff] [blame] | 702 | } |
| 703 | } |
| 704 | } |