blob: 653281d45f512bd8fbb01411e833ee4aa711099e [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
David Brazdil1f530702022-10-03 12:18:10 +010017use crate::{get_calling_pid, get_calling_uid};
Alan Stokesfda70842023-12-20 17:50:14 +000018use crate::atom::{write_vm_booted_stats, write_vm_creation_stats};
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000019use crate::composite::make_composite_image;
Jeongik Chac181be72024-03-27 00:18:30 +090020use crate::crosvm::{CrosvmConfig, DiskFile, DisplayConfig, InputDeviceOption, PayloadState, VmContext, VmInstance, VmState};
Jaewan Kim61f86142023-03-28 15:12:52 +090021use crate::debug_config::DebugConfig;
Shikha Panwar55e10ec2024-02-13 12:53:49 +000022use crate::dt_overlay::{create_device_tree_overlay, VM_DT_OVERLAY_MAX_SIZE, VM_DT_OVERLAY_PATH};
Nikita Ioffe5dfddf22023-06-29 16:11:26 +010023use crate::payload::{add_microdroid_payload_images, add_microdroid_system_images, add_microdroid_vendor_image};
Seungjae Yoofd9a0622022-10-14 10:01:29 +090024use crate::selinux::{getfilecon, SeContext};
Jiyong Park753553b2021-07-12 21:21:09 +090025use android_os_permissions_aidl::aidl::android::os::IPermissionController;
David Brazdil49f96f52022-12-16 21:29:13 +000026use android_system_virtualizationcommon::aidl::android::system::virtualizationcommon::{
Alice Wang4e3015d2023-10-10 09:35:37 +000027 Certificate::Certificate,
Andrew Walbranc92d35f2022-01-12 12:45:19 +000028 DeathReason::DeathReason,
David Brazdil49f96f52022-12-16 21:29:13 +000029 ErrorCode::ErrorCode,
30};
31use android_system_virtualizationservice::aidl::android::system::virtualizationservice::{
Inseob Kim53d0b212023-07-20 16:58:37 +090032 AssignableDevice::AssignableDevice,
David Brazdil7d1e5ec2023-02-06 17:56:29 +000033 CpuTopology::CpuTopology,
Andrew Walbran6b650662021-09-07 13:13:23 +000034 DiskImage::DiskImage,
Jeongik Chac181be72024-03-27 00:18:30 +090035 InputDevice::InputDevice,
Alan Stokes0cc59ee2021-09-24 11:20:34 +010036 IVirtualMachine::{BnVirtualMachine, IVirtualMachine},
Andrew Walbran6b650662021-09-07 13:13:23 +000037 IVirtualMachineCallback::IVirtualMachineCallback,
38 IVirtualizationService::IVirtualizationService,
Keir Frasercdd4b112022-11-24 14:02:25 +000039 MemoryTrimLevel::MemoryTrimLevel,
Jiyong Park029977d2021-11-24 21:56:49 +090040 Partition::Partition,
Andrew Walbran6b650662021-09-07 13:13:23 +000041 PartitionType::PartitionType,
Inseob Kim0168b462022-12-27 14:54:35 +090042 VirtualMachineAppConfig::{DebugLevel::DebugLevel, Payload::Payload, VirtualMachineAppConfig},
Jooyung Han21e9b922021-06-26 04:14:16 +090043 VirtualMachineConfig::VirtualMachineConfig,
Andrew Walbran6b650662021-09-07 13:13:23 +000044 VirtualMachineDebugInfo::VirtualMachineDebugInfo,
Alan Stokes0d1ef782022-09-27 13:46:35 +010045 VirtualMachinePayloadConfig::VirtualMachinePayloadConfig,
Jooyung Han21e9b922021-06-26 04:14:16 +090046 VirtualMachineRawConfig::VirtualMachineRawConfig,
Andrew Walbran6b650662021-09-07 13:13:23 +000047 VirtualMachineState::VirtualMachineState,
Jooyung Han21e9b922021-06-26 04:14:16 +090048};
David Brazdilafc9a9e2023-01-12 16:08:10 +000049use android_system_virtualizationservice_internal::aidl::android::system::virtualizationservice_internal::IVirtualizationServiceInternal::IVirtualizationServiceInternal;
Seungjae Yoodd91f0f2022-11-09 15:25:21 +090050use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::{
David Brazdilafc9a9e2023-01-12 16:08:10 +000051 BnVirtualMachineService, IVirtualMachineService,
Seungjae Yoofd9a0622022-10-14 10:01:29 +090052};
Shikha Panware45e9422024-02-28 21:18:10 +000053use android_hardware_security_secretkeeper::aidl::android::hardware::security::secretkeeper::ISecretkeeper::{BnSecretkeeper, ISecretkeeper};
Shikha Panwar5d6a6752023-12-14 22:08:26 +000054use android_hardware_security_secretkeeper::aidl::android::hardware::security::secretkeeper::SecretId::SecretId;
55use android_hardware_security_authgraph::aidl::android::hardware::security::authgraph::{
56 Arc::Arc as AuthgraphArc, IAuthGraphKeyExchange::IAuthGraphKeyExchange,
57 IAuthGraphKeyExchange::BnAuthGraphKeyExchange, Identity::Identity, KeInitResult::KeInitResult,
58 Key::Key, PubKey::PubKey, SessionIdSignature::SessionIdSignature, SessionInfo::SessionInfo,
59 SessionInitiationInfo::SessionInitiationInfo,
60};
Alan Stokes25f69362023-03-06 16:51:54 +000061use anyhow::{anyhow, bail, Context, Result};
Seungjae Yoofd9a0622022-10-14 10:01:29 +090062use apkverify::{HashAlgorithm, V4Signature};
Jiyong Parkd7bd2f22023-08-10 20:41:19 +090063use avflog::LogResult;
Alan Stokes0e82b502022-08-08 14:44:48 +010064use binder::{
David Brazdilafc9a9e2023-01-12 16:08:10 +000065 self, wait_for_interface, BinderFeatures, ExceptionCode, Interface, ParcelFileDescriptor,
66 Status, StatusCode, Strong,
Jiyong Park2227eaa2023-08-04 11:59:18 +090067 IntoBinderResult,
Andrew Walbrana89fc132021-03-17 17:08:36 +000068};
Shikha Panwar55e10ec2024-02-13 12:53:49 +000069use cstr::cstr;
Inseob Kim46257382024-01-03 15:41:22 +090070use glob::glob;
David Brazdil49f96f52022-12-16 21:29:13 +000071use lazy_static::lazy_static;
Seungjae Yoo0a8c84c2022-07-11 08:19:15 +000072use log::{debug, error, info, warn};
Inseob Kim89b24592024-02-23 18:59:43 +090073use microdroid_payload_config::{ApkConfig, Task, TaskType, VmPayloadConfig};
Inseob Kim0168b462022-12-27 14:54:35 +090074use nix::unistd::pipe;
David Brazdil73988ea2022-11-11 15:10:32 +000075use rpcbinder::RpcServer;
Alan Stokes25f69362023-03-06 16:51:54 +000076use rustutils::system_properties;
Jiyong Parkdcf17412022-02-08 15:07:23 +090077use semver::VersionReq;
Inseob Kim6ef80972023-07-20 17:23:36 +090078use std::collections::HashSet;
Andrew Walbrandff3b942021-06-09 15:20:36 +000079use std::convert::TryInto;
Shikha Panwar55e10ec2024-02-13 12:53:49 +000080use std::fs;
Jaewan Kim39952072024-01-19 17:04:53 +090081use std::ffi::CStr;
Inseob Kim6ef80972023-07-20 17:23:36 +090082use std::fs::{canonicalize, read_dir, remove_file, File, OpenOptions};
Shikha Panwar9ae2e622024-01-30 12:22:30 +000083use std::io::{BufRead, BufReader, Error, ErrorKind, Seek, SeekFrom, Write};
Inseob Kim46257382024-01-03 15:41:22 +090084use std::iter;
Nikita Ioffe5776f082023-02-10 21:38:26 +000085use std::num::{NonZeroU16, NonZeroU32};
Inseob Kimff48a7c2024-02-26 22:07:21 +090086use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd};
David Brazdilafc9a9e2023-01-12 16:08:10 +000087use std::os::unix::raw::pid_t;
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000088use std::path::{Path, PathBuf};
Andrew Walbran320b5602021-03-04 16:11:12 +000089use std::sync::{Arc, Mutex, Weak};
Seungjae Yoo14e60182024-02-21 13:28:31 +090090use vbmeta::VbMetaImage;
Pierre-Clément Tosid3bbe1d2024-04-15 18:03:51 +010091use vmconfig::{VmConfig, get_debug_level};
David Brazdilafc9a9e2023-01-12 16:08:10 +000092use vsock::VsockStream;
Jooyung Han35edb8f2021-07-01 16:17:16 +090093use zip::ZipArchive;
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000094
David Brazdil41d1a872022-10-05 14:44:19 +010095/// The unique ID of a VM used (together with a port number) for vsock communication.
96pub type Cid = u32;
97
David Brazdil4b4c5102022-12-19 22:56:20 +000098pub const BINDER_SERVICE_IDENTIFIER: &str = "android.system.virtualizationservice";
99
Jooyung Han95884632021-07-06 22:27:54 +0900100/// The size of zero.img.
101/// Gaps in composite disk images are filled with a shared zero.img.
102const ZERO_FILLER_SIZE: u64 = 4096;
103
David Brazdilf50c7a62023-04-19 14:22:42 +0000104/// Magic string for the instance image
105const ANDROID_VM_INSTANCE_MAGIC: &str = "Android-VM-instance";
106
107/// Version of the instance image format
108const ANDROID_VM_INSTANCE_VERSION: u16 = 1;
109
Alan Stokes0d1ef782022-09-27 13:46:35 +0100110const MICRODROID_OS_NAME: &str = "microdroid";
111
Shikha Panwar5d6a6752023-12-14 22:08:26 +0000112const SECRETKEEPER_IDENTIFIER: &str =
Shikha Panwarbe5dee72024-02-21 19:06:20 +0000113 "android.hardware.security.secretkeeper.ISecretkeeper/default";
Shikha Panwar5d6a6752023-12-14 22:08:26 +0000114
David Brazdilf50c7a62023-04-19 14:22:42 +0000115const UNFORMATTED_STORAGE_MAGIC: &str = "UNFORMATTED-STORAGE";
116
117/// crosvm requires all partitions to be a multiple of 4KiB.
118const PARTITION_GRANULARITY_BYTES: u64 = 4096;
119
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000120const VM_REFERENCE_DT_ON_HOST_PATH: &str = "/proc/device-tree/avf/reference";
121
David Brazdil49f96f52022-12-16 21:29:13 +0000122lazy_static! {
David Brazdil4b4c5102022-12-19 22:56:20 +0000123 pub static ref GLOBAL_SERVICE: Strong<dyn IVirtualizationServiceInternal> =
124 wait_for_interface(BINDER_SERVICE_IDENTIFIER)
125 .expect("Could not connect to VirtualizationServiceInternal");
Inseob Kim46257382024-01-03 15:41:22 +0900126 static ref SUPPORTED_OS_NAMES: HashSet<String> =
127 get_supported_os_names().expect("Failed to get list of supported os names");
David Brazdil49f96f52022-12-16 21:29:13 +0000128}
129
Nikita Ioffef1ce9872022-12-09 13:31:59 +0000130fn create_or_update_idsig_file(
131 input_fd: &ParcelFileDescriptor,
132 idsig_fd: &ParcelFileDescriptor,
133) -> Result<()> {
134 let mut input = clone_file(input_fd)?;
135 let metadata = input.metadata().context("failed to get input metadata")?;
136 if !metadata.is_file() {
137 bail!("input is not a regular file");
138 }
Alan Stokes25f69362023-03-06 16:51:54 +0000139 let mut sig =
140 V4Signature::create(&mut input, get_current_sdk()?, 4096, &[], HashAlgorithm::SHA256)
141 .context("failed to create idsig")?;
Nikita Ioffef1ce9872022-12-09 13:31:59 +0000142
143 let mut output = clone_file(idsig_fd)?;
Jiyong Park8d192952023-06-26 14:29:51 +0900144
145 // Optimization. We don't have to update idsig file whenever a VM is started. Don't update it,
146 // if the idsig file already has the same APK digest.
147 if output.metadata()?.len() > 0 {
148 if let Ok(out_sig) = V4Signature::from_idsig(&mut output) {
149 if out_sig.signing_info.apk_digest == sig.signing_info.apk_digest {
150 debug!("idsig {:?} is up-to-date with apk {:?}.", output, input);
151 return Ok(());
152 }
153 }
154 // if we fail to read v4signature from output, that's fine. User can pass a random file.
155 // We will anyway overwrite the file to the v4signature generated from input_fd.
156 }
157
Shikha Panwar9ae2e622024-01-30 12:22:30 +0000158 output
159 .seek(SeekFrom::Start(0))
160 .context("failed to move cursor to start on the idsig output")?;
Nikita Ioffec09b0492022-12-14 20:18:33 +0000161 output.set_len(0).context("failed to set_len on the idsig output")?;
162 sig.write_into(&mut output).context("failed to write idsig")?;
Nikita Ioffef1ce9872022-12-09 13:31:59 +0000163 Ok(())
164}
165
Alan Stokes25f69362023-03-06 16:51:54 +0000166fn get_current_sdk() -> Result<u32> {
167 let current_sdk = system_properties::read("ro.build.version.sdk")?;
168 let current_sdk = current_sdk.ok_or_else(|| anyhow!("SDK version missing"))?;
169 current_sdk.parse().context("Malformed SDK version")
170}
171
David Brazdil4b4c5102022-12-19 22:56:20 +0000172pub fn remove_temporary_files(path: &PathBuf) -> Result<()> {
173 for dir_entry in read_dir(path)? {
174 remove_file(dir_entry?.path())?;
175 }
176 Ok(())
David Brazdil528e0472022-10-10 15:06:02 +0100177}
178
David Brazdil528e0472022-10-10 15:06:02 +0100179/// Implementation of `IVirtualizationService`, the entry point of the AIDL service.
David Brazdil49f96f52022-12-16 21:29:13 +0000180#[derive(Debug, Default)]
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000181pub struct VirtualizationService {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900182 state: Arc<Mutex<State>>,
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000183}
184
Shikha Panward8e35422021-10-11 13:51:27 +0000185impl Interface for VirtualizationService {
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000186 fn dump(&self, writer: &mut dyn Write, _args: &[&CStr]) -> Result<(), StatusCode> {
Shikha Panward8e35422021-10-11 13:51:27 +0000187 check_permission("android.permission.DUMP").or(Err(StatusCode::PERMISSION_DENIED))?;
188 let state = &mut *self.state.lock().unwrap();
189 let vms = state.vms();
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000190 writeln!(writer, "Running {0} VMs:", vms.len()).or(Err(StatusCode::UNKNOWN_ERROR))?;
Shikha Panward8e35422021-10-11 13:51:27 +0000191 for vm in vms {
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000192 writeln!(writer, "VM CID: {}", vm.cid).or(Err(StatusCode::UNKNOWN_ERROR))?;
193 writeln!(writer, "\tState: {:?}", vm.vm_state.lock().unwrap())
Shikha Panward8e35422021-10-11 13:51:27 +0000194 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000195 writeln!(writer, "\tPayload state {:?}", vm.payload_state())
Shikha Panward8e35422021-10-11 13:51:27 +0000196 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000197 writeln!(writer, "\tProtected: {}", vm.protected).or(Err(StatusCode::UNKNOWN_ERROR))?;
198 writeln!(writer, "\ttemporary_directory: {}", vm.temporary_directory.to_string_lossy())
Shikha Panward8e35422021-10-11 13:51:27 +0000199 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000200 writeln!(writer, "\trequester_uid: {}", vm.requester_uid)
Shikha Panward8e35422021-10-11 13:51:27 +0000201 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000202 writeln!(writer, "\trequester_debug_pid: {}", vm.requester_debug_pid)
Shikha Panward8e35422021-10-11 13:51:27 +0000203 .or(Err(StatusCode::UNKNOWN_ERROR))?;
204 }
205 Ok(())
206 }
207}
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000208impl IVirtualizationService for VirtualizationService {
Andrew Walbranf8d94112021-09-07 11:45:36 +0000209 /// Creates (but does not start) a new VM with the given configuration, assigning it the next
210 /// available CID.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000211 ///
212 /// Returns a binder `IVirtualMachine` object referring to it, as a handle for the client.
Andrew Walbranf8d94112021-09-07 11:45:36 +0000213 fn createVm(
Andrew Walbrana89fc132021-03-17 17:08:36 +0000214 &self,
Andrew Walbran3a5a9212021-05-04 17:09:08 +0000215 config: &VirtualMachineConfig,
Jiyong Parke6fb1672023-06-26 16:45:55 +0900216 console_out_fd: Option<&ParcelFileDescriptor>,
217 console_in_fd: Option<&ParcelFileDescriptor>,
Andrew Walbrana89fc132021-03-17 17:08:36 +0000218 log_fd: Option<&ParcelFileDescriptor>,
219 ) -> binder::Result<Strong<dyn IVirtualMachine>> {
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000220 let mut is_protected = false;
Jiyong Parke6fb1672023-06-26 16:45:55 +0900221 let ret = self.create_vm_internal(
222 config,
223 console_out_fd,
224 console_in_fd,
225 log_fd,
226 &mut is_protected,
227 );
Seungjae Yoo0a8c84c2022-07-11 08:19:15 +0000228 write_vm_creation_stats(config, is_protected, &ret);
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000229 ret
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000230 }
Andrew Walbran320b5602021-03-04 16:11:12 +0000231
Shikha Panwar61a74b52024-02-16 13:17:01 +0000232 /// Allocate a new instance_id to the VM
233 fn allocateInstanceId(&self) -> binder::Result<[u8; 64]> {
Shikha Panwarbd5eba92024-03-27 20:23:31 +0000234 check_manage_access()?;
Shikha Panwar61a74b52024-02-16 13:17:01 +0000235 GLOBAL_SERVICE.allocateInstanceId()
236 }
237
Andrew Walbrandff3b942021-06-09 15:20:36 +0000238 /// Initialise an empty partition image of the given size to be used as a writable partition.
239 fn initializeWritablePartition(
240 &self,
241 image_fd: &ParcelFileDescriptor,
Alan Stokesff0005f2023-01-30 09:53:00 +0000242 size_bytes: i64,
Jiyong Park9dd389e2021-08-23 20:42:59 +0900243 partition_type: PartitionType,
Andrew Walbrandff3b942021-06-09 15:20:36 +0000244 ) -> binder::Result<()> {
Jiyong Park753553b2021-07-12 21:21:09 +0900245 check_manage_access()?;
Jiyong Park2227eaa2023-08-04 11:59:18 +0900246 let size_bytes = size_bytes
247 .try_into()
248 .with_context(|| format!("Invalid size: {}", size_bytes))
249 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000250 let size_bytes = round_up(size_bytes, PARTITION_GRANULARITY_BYTES);
Shikha Panwar9ae2e622024-01-30 12:22:30 +0000251 let mut image = clone_file(image_fd)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000252 // initialize the file. Any data in the file will be erased.
Shikha Panwar9ae2e622024-01-30 12:22:30 +0000253 image
254 .seek(SeekFrom::Start(0))
255 .context("failed to move cursor to start")
256 .or_service_specific_exception(-1)?;
Jiyong Park2227eaa2023-08-04 11:59:18 +0900257 image.set_len(0).context("Failed to reset a file").or_service_specific_exception(-1)?;
Frederick Mayle0d310572024-05-02 12:34:58 -0700258 // Set the file length. In most filesystems, this will not allocate any physical disk
259 // space, it will only change the logical size.
260 image
261 .set_len(size_bytes)
262 .context("Failed to extend file")
Jiyong Park2227eaa2023-08-04 11:59:18 +0900263 .or_service_specific_exception(-1)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000264
265 match partition_type {
266 PartitionType::RAW => Ok(()),
Frederick Mayle0d310572024-05-02 12:34:58 -0700267 PartitionType::ANDROID_VM_INSTANCE => format_as_android_vm_instance(&mut image),
268 PartitionType::ENCRYPTEDSTORE => format_as_encryptedstore(&mut image),
David Brazdilf50c7a62023-04-19 14:22:42 +0000269 _ => Err(Error::new(
270 ErrorKind::Unsupported,
271 format!("Unsupported partition type {:?}", partition_type),
272 )),
273 }
Jiyong Park2227eaa2023-08-04 11:59:18 +0900274 .with_context(|| format!("Failed to initialize partition as {:?}", partition_type))
275 .or_service_specific_exception(-1)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000276
277 Ok(())
Andrew Walbrandff3b942021-06-09 15:20:36 +0000278 }
279
Jiyong Park0a248432021-08-20 23:32:39 +0900280 /// Creates or update the idsig file by digesting the input APK file.
281 fn createOrUpdateIdsigFile(
282 &self,
283 input_fd: &ParcelFileDescriptor,
284 idsig_fd: &ParcelFileDescriptor,
285 ) -> binder::Result<()> {
Jiyong Parkc3ca24f2022-06-28 10:45:15 +0900286 check_manage_access()?;
287
Jiyong Park2227eaa2023-08-04 11:59:18 +0900288 create_or_update_idsig_file(input_fd, idsig_fd).or_service_specific_exception(-1)?;
Jiyong Park0a248432021-08-20 23:32:39 +0900289 Ok(())
290 }
291
Andrew Walbran320b5602021-03-04 16:11:12 +0000292 /// Get a list of all currently running VMs. This method is only intended for debug purposes,
293 /// and as such is only permitted from the shell user.
294 fn debugListVms(&self) -> binder::Result<Vec<VirtualMachineDebugInfo>> {
David Brazdil209074a2023-01-12 16:44:51 +0000295 // Delegate to the global service, including checking the debug permission.
David Brazdild4f51a52023-01-11 14:09:27 +0000296 GLOBAL_SERVICE.debugListVms()
Andrew Walbran320b5602021-03-04 16:11:12 +0000297 }
Inseob Kim53d0b212023-07-20 16:58:37 +0900298
299 /// Get a list of assignable device types.
300 fn getAssignableDevices(&self) -> binder::Result<Vec<AssignableDevice>> {
301 // Delegate to the global service, including checking the permission.
302 GLOBAL_SERVICE.getAssignableDevices()
303 }
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100304
Inseob Kim46257382024-01-03 15:41:22 +0900305 /// Get a list of supported OSes.
306 fn getSupportedOSList(&self) -> binder::Result<Vec<String>> {
307 Ok(Vec::from_iter(SUPPORTED_OS_NAMES.iter().cloned()))
308 }
309
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100310 /// Returns whether given feature is enabled
311 fn isFeatureEnabled(&self, feature: &str) -> binder::Result<bool> {
312 check_manage_access()?;
Shikha Panwar6d306412024-02-17 21:37:49 +0000313 Ok(avf_features::is_feature_enabled(feature))
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100314 }
Alice Wange64dd182024-01-17 15:57:55 +0000315
316 fn enableTestAttestation(&self) -> binder::Result<()> {
317 GLOBAL_SERVICE.enableTestAttestation()
318 }
Alice Wang0362f7f2024-03-21 08:16:26 +0000319
320 fn isRemoteAttestationSupported(&self) -> binder::Result<bool> {
321 check_manage_access()?;
322 GLOBAL_SERVICE.isRemoteAttestationSupported()
323 }
Shikha Panwar7aef66d2024-03-13 00:28:41 +0000324
325 fn isUpdatableVmSupported(&self) -> binder::Result<bool> {
326 // The response is specific to Microdroid. Updatable VMs are only possible if device
327 // supports Secretkeeper. Guest OS needs to use Secretkeeper based secrets. Microdroid does
328 // this, however other guest OSes may do things differently.
329 check_manage_access()?;
330 Ok(is_secretkeeper_supported())
331 }
Shikha Panwarbd5eba92024-03-27 20:23:31 +0000332
Shikha Panwar07d701c2024-03-28 14:43:52 +0000333 fn removeVmInstance(&self, instance_id: &[u8; 64]) -> binder::Result<()> {
334 check_manage_access()?;
335 GLOBAL_SERVICE.removeVmInstance(instance_id)
336 }
337
Shikha Panwarbd5eba92024-03-27 20:23:31 +0000338 fn claimVmInstance(&self, instance_id: &[u8; 64]) -> binder::Result<()> {
339 check_manage_access()?;
340 GLOBAL_SERVICE.claimVmInstance(instance_id)
341 }
Andrew Walbran320b5602021-03-04 16:11:12 +0000342}
343
Jiyong Park8611a6c2021-07-09 18:17:44 +0900344impl VirtualizationService {
345 pub fn init() -> VirtualizationService {
David Brazdil49f96f52022-12-16 21:29:13 +0000346 VirtualizationService::default()
Jiyong Park8611a6c2021-07-09 18:17:44 +0900347 }
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000348
David Brazdil209074a2023-01-12 16:44:51 +0000349 fn create_vm_context(
350 &self,
351 requester_debug_pid: pid_t,
352 ) -> binder::Result<(VmContext, Cid, PathBuf)> {
David Brazdil8cf8f482022-11-23 14:21:26 +0000353 const NUM_ATTEMPTS: usize = 5;
354
355 for _ in 0..NUM_ATTEMPTS {
Charisee96113f32023-01-26 09:00:42 +0000356 let vm_context = GLOBAL_SERVICE.allocateGlobalVmContext(requester_debug_pid)?;
David Brazdild4f51a52023-01-11 14:09:27 +0000357 let cid = vm_context.getCid()? as Cid;
358 let temp_dir: PathBuf = vm_context.getTemporaryDirectory()?.into();
David Brazdil8cf8f482022-11-23 14:21:26 +0000359 let service = VirtualMachineService::new_binder(self.state.clone(), cid).as_binder();
360
361 // Start VM service listening for connections from the new CID on port=CID.
David Brazdil8cf8f482022-11-23 14:21:26 +0000362 let port = cid;
David Brazdil3238da42022-11-18 10:04:51 +0000363 match RpcServer::new_vsock(service, cid, port) {
David Brazdil8cf8f482022-11-23 14:21:26 +0000364 Ok(vm_server) => {
365 vm_server.start();
David Brazdild4f51a52023-01-11 14:09:27 +0000366 return Ok((VmContext::new(vm_context, vm_server), cid, temp_dir));
David Brazdil8cf8f482022-11-23 14:21:26 +0000367 }
368 Err(err) => {
369 warn!("Could not start RpcServer on port {}: {}", port, err);
370 }
371 }
372 }
Jiyong Park2227eaa2023-08-04 11:59:18 +0900373 Err(anyhow!("Too many attempts to create VM context failed"))
374 .or_service_specific_exception(-1)
David Brazdil8cf8f482022-11-23 14:21:26 +0000375 }
376
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000377 fn create_vm_internal(
378 &self,
379 config: &VirtualMachineConfig,
Jiyong Parke6fb1672023-06-26 16:45:55 +0900380 console_out_fd: Option<&ParcelFileDescriptor>,
381 console_in_fd: Option<&ParcelFileDescriptor>,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000382 log_fd: Option<&ParcelFileDescriptor>,
383 is_protected: &mut bool,
384 ) -> binder::Result<Strong<dyn IVirtualMachine>> {
David Brazdil209074a2023-01-12 16:44:51 +0000385 let requester_uid = get_calling_uid();
386 let requester_debug_pid = get_calling_pid();
387
Nikita Ioffe631717e2023-09-05 13:38:07 +0100388 check_config_features(config)?;
389
David Brazdil209074a2023-01-12 16:44:51 +0000390 // Allocating VM context checks the MANAGE_VIRTUAL_MACHINE permission.
391 let (vm_context, cid, temporary_directory) = self.create_vm_context(requester_debug_pid)?;
Inseob Kim1119d702022-05-02 18:01:58 +0900392
Alan Stokesfda70842023-12-20 17:50:14 +0000393 if is_custom_config(config) {
Alan Stokes7bc146c2022-10-20 17:10:32 +0100394 check_use_custom_virtual_machine()?;
Inseob Kim1119d702022-05-02 18:01:58 +0900395 }
396
Nikita Ioffe5776f082023-02-10 21:38:26 +0000397 let gdb_port = extract_gdb_port(config);
398
399 // Additional permission checks if caller request gdb.
400 if gdb_port.is_some() {
401 check_gdb_allowed(config)?;
402 }
403
Shikha Panwar8707f0f2024-02-28 20:40:42 +0000404 // Currently, VirtMgr adds the host copy of reference DT & untrusted properties
405 // (e.g. instance-id)
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000406 let host_ref_dt = Path::new(VM_REFERENCE_DT_ON_HOST_PATH);
407 let host_ref_dt = if host_ref_dt.exists()
408 && read_dir(host_ref_dt).or_service_specific_exception(-1)?.next().is_some()
409 {
410 Some(host_ref_dt)
411 } else {
412 warn!("VM reference DT doesn't exist in host DT");
413 None
414 };
415
Seungjae Yoo14e60182024-02-21 13:28:31 +0900416 let vendor_hashtree_digest = extract_vendor_hashtree_digest(config)
417 .context("Failed to extract vendor hashtree digest")
418 .or_service_specific_exception(-1)?;
419
420 let trusted_props = if let Some(ref vendor_hashtree_digest) = vendor_hashtree_digest {
421 info!(
422 "Passing vendor hashtree digest to pvmfw. This will be rejected if it doesn't \
423 match the trusted digest in the pvmfw config, causing the VM to fail to start."
424 );
425 vec![(
426 cstr!("vendor_hashtree_descriptor_root_digest"),
427 vendor_hashtree_digest.as_slice(),
428 )]
429 } else {
430 vec![]
431 };
432
Shikha Panwar61a74b52024-02-16 13:17:01 +0000433 let instance_id;
Shikha Panwar8707f0f2024-02-28 20:40:42 +0000434 let mut untrusted_props = Vec::with_capacity(2);
435 if cfg!(llpvm_changes) {
Shikha Panwar61a74b52024-02-16 13:17:01 +0000436 instance_id = extract_instance_id(config);
Shikha Panwar8707f0f2024-02-28 20:40:42 +0000437 untrusted_props.push((cstr!("instance-id"), &instance_id[..]));
Alan Stokesc96b35e2024-05-03 13:21:20 +0100438 let want_updatable = extract_want_updatable(config);
439 if want_updatable && is_secretkeeper_supported() {
Shikha Panwar8707f0f2024-02-28 20:40:42 +0000440 // Let guest know that it can defer rollback protection to Secretkeeper by setting
441 // an empty property in untrusted node in DT. This enables Updatable VMs.
442 untrusted_props.push((cstr!("defer-rollback-protection"), &[]))
443 }
444 }
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000445
Seungjae Yoo14e60182024-02-21 13:28:31 +0900446 let device_tree_overlay =
447 if host_ref_dt.is_some() || !untrusted_props.is_empty() || !trusted_props.is_empty() {
448 let dt_output = temporary_directory.join(VM_DT_OVERLAY_PATH);
449 let mut data = [0_u8; VM_DT_OVERLAY_MAX_SIZE];
450 let fdt = create_device_tree_overlay(
451 &mut data,
452 host_ref_dt,
453 &untrusted_props,
454 &trusted_props,
455 )
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000456 .map_err(|e| anyhow!("Failed to create DT overlay, {e:?}"))
457 .or_service_specific_exception(-1)?;
Seungjae Yoo14e60182024-02-21 13:28:31 +0900458 fs::write(&dt_output, fdt.as_slice()).or_service_specific_exception(-1)?;
459 Some(File::open(dt_output).or_service_specific_exception(-1)?)
460 } else {
461 None
462 };
Seungjae Yooec3bc522023-11-09 10:14:30 +0900463
Jaewan Kimf3143242024-03-15 06:56:31 +0000464 let debug_config = DebugConfig::new(config);
Jaewan Kim61f86142023-03-28 15:12:52 +0900465
466 let ramdump = if debug_config.is_ramdump_needed() {
Jiyong Parked180932023-02-24 19:55:41 +0900467 Some(prepare_ramdump_file(&temporary_directory)?)
468 } else {
469 None
470 };
471
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000472 let state = &mut *self.state.lock().unwrap();
Jiyong Parke6fb1672023-06-26 16:45:55 +0900473 let console_out_fd =
474 clone_or_prepare_logger_fd(&debug_config, console_out_fd, format!("Console({})", cid))?;
475 let console_in_fd = console_in_fd.map(clone_file).transpose()?;
Jaewan Kim61f86142023-03-28 15:12:52 +0900476 let log_fd = clone_or_prepare_logger_fd(&debug_config, log_fd, format!("Log({})", cid))?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000477
478 // Counter to generate unique IDs for temporary image files.
479 let mut next_temporary_image_id = 0;
480 // Files which are referred to from composite images. These must be mapped to the crosvm
481 // child process, and not closed before it is started.
482 let mut indirect_files = vec![];
483
Alan Stokes7bc146c2022-10-20 17:10:32 +0100484 let (is_app_config, config) = match config {
485 VirtualMachineConfig::RawConfig(config) => (false, BorrowedOrOwned::Borrowed(config)),
486 VirtualMachineConfig::AppConfig(config) => {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900487 let config = load_app_config(config, &debug_config, &temporary_directory)
488 .or_service_specific_exception_with(-1, |e| {
Jaewan Kim61f86142023-03-28 15:12:52 +0900489 *is_protected = config.protectedVm;
490 let message = format!("Failed to load app config: {:?}", e);
491 error!("{}", message);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900492 message
Jaewan Kim61f86142023-03-28 15:12:52 +0900493 })?;
Alan Stokes7bc146c2022-10-20 17:10:32 +0100494 (true, BorrowedOrOwned::Owned(config))
495 }
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000496 };
497 let config = config.as_ref();
498 *is_protected = config.protectedVm;
499
500 // Check if partition images are labeled incorrectly. This is to prevent random images
501 // which are not protected by the Android Verified Boot (e.g. bits downloaded by apps) from
Alan Stokes3e5eec12023-09-07 12:10:00 +0100502 // being loaded in a pVM. This applies to everything but the instance image in the raw
503 // config, and everything but the non-executable, generated partitions in the app
504 // config.
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000505 config
506 .disks
507 .iter()
508 .flat_map(|disk| disk.partitions.iter())
509 .filter(|partition| {
510 if is_app_config {
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100511 !is_safe_app_partition(&partition.label)
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000512 } else {
Alice Wangc206b9b2023-08-28 14:13:51 +0000513 !is_safe_raw_partition(&partition.label)
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000514 }
515 })
516 .try_for_each(check_label_for_partition)
Jiyong Park2227eaa2023-08-04 11:59:18 +0900517 .or_service_specific_exception(-1)?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000518
Inseob Kimff48a7c2024-02-26 22:07:21 +0900519 // Check if files for payloads and bases are NOT coming from /vendor and /odm, as they may
520 // have unstable interfaces.
521 // TODO(b/316431494): remove once Treble interfaces are stabilized.
522 check_partitions_for_files(config).or_service_specific_exception(-1)?;
523
Alan Stokes185fe112023-01-10 16:20:55 +0000524 let kernel = maybe_clone_file(&config.kernel)?;
525 let initrd = maybe_clone_file(&config.initrd)?;
526
527 // In a protected VM, we require custom kernels to come from a trusted source (b/237054515).
528 if config.protectedVm {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900529 check_label_for_kernel_files(&kernel, &initrd).or_service_specific_exception(-1)?;
Alan Stokes185fe112023-01-10 16:20:55 +0000530 }
531
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000532 let zero_filler_path = temporary_directory.join("zero.img");
Jiyong Park2227eaa2023-08-04 11:59:18 +0900533 write_zero_filler(&zero_filler_path)
534 .context("Failed to make composite image")
535 .with_log()
536 .or_service_specific_exception(-1)?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000537
538 // Assemble disk images if needed.
539 let disks = config
540 .disks
541 .iter()
542 .map(|disk| {
543 assemble_disk_image(
544 disk,
545 &zero_filler_path,
546 &temporary_directory,
547 &mut next_temporary_image_id,
548 &mut indirect_files,
549 )
550 })
551 .collect::<Result<Vec<DiskFile>, _>>()?;
552
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000553 let (cpus, host_cpu_topology) = match config.cpuTopology {
554 CpuTopology::MATCH_HOST => (None, true),
555 CpuTopology::ONE_CPU => (NonZeroU32::new(1), false),
556 val => {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900557 return Err(anyhow!("Failed to parse CPU topology value {:?}", val))
558 .with_log()
559 .or_service_specific_exception(-1);
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000560 }
561 };
562
David Brazdil2dfefd12023-11-17 14:07:36 +0000563 let (vfio_devices, dtbo) = if !config.devices.is_empty() {
Inseob Kim6ef80972023-07-20 17:23:36 +0900564 let mut set = HashSet::new();
565 for device in config.devices.iter() {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900566 let path = canonicalize(device)
567 .with_context(|| format!("can't canonicalize {device}"))
568 .or_service_specific_exception(-1)?;
Inseob Kim6ef80972023-07-20 17:23:36 +0900569 if !set.insert(path) {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900570 return Err(anyhow!("duplicated device {device}"))
571 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Inseob Kim6ef80972023-07-20 17:23:36 +0900572 }
573 }
Jakob Vukalovicd42aa2c2023-11-09 16:04:00 +0000574 let devices = GLOBAL_SERVICE.bindDevicesToVfioDriver(&config.devices)?;
David Brazdil2dfefd12023-11-17 14:07:36 +0000575 let dtbo_file = File::from(
576 GLOBAL_SERVICE
577 .getDtboFile()?
578 .as_ref()
579 .try_clone()
Jaewan Kim39952072024-01-19 17:04:53 +0900580 .context("Failed to create VM DTBO from ParcelFileDescriptor")
David Brazdil2dfefd12023-11-17 14:07:36 +0000581 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)?,
582 );
583 (devices, Some(dtbo_file))
Inseob Kim7307a892023-09-14 13:37:58 +0900584 } else {
David Brazdil2dfefd12023-11-17 14:07:36 +0000585 (vec![], None)
Inseob Kim7307a892023-09-14 13:37:58 +0900586 };
Jeongik Cha798401c2024-04-11 21:54:49 +0900587 let display_config = if cfg!(paravirtualized_devices) {
588 config
589 .displayConfig
590 .as_ref()
591 .map(DisplayConfig::new)
592 .transpose()
593 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT)?
594 } else {
595 None
596 };
Jeongik Cha1df1c032024-04-03 16:03:12 +0900597
Jeongik Chac181be72024-03-27 00:18:30 +0900598 let input_device_options = if cfg!(paravirtualized_devices) {
599 config
600 .inputDevices
601 .iter()
602 .map(to_input_device_option_from)
603 .collect::<Result<Vec<InputDeviceOption>, _>>()
604 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT)?
605 } else {
606 vec![]
607 };
608
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000609 // Actually start the VM.
610 let crosvm_config = CrosvmConfig {
611 cid,
Seungjae Yoo62085c02022-08-12 04:44:52 +0000612 name: config.name.clone(),
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000613 bootloader: maybe_clone_file(&config.bootloader)?,
Alan Stokes185fe112023-01-10 16:20:55 +0000614 kernel,
615 initrd,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000616 disks,
617 params: config.params.to_owned(),
618 protected: *is_protected,
Jaewan Kim61f86142023-03-28 15:12:52 +0900619 debug_config,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000620 memory_mib: config.memoryMib.try_into().ok().and_then(NonZeroU32::new),
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000621 cpus,
622 host_cpu_topology,
Jiyong Parke6fb1672023-06-26 16:45:55 +0900623 console_out_fd,
624 console_in_fd,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000625 log_fd,
Jiyong Parked180932023-02-24 19:55:41 +0900626 ramdump,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000627 indirect_files,
628 platform_version: parse_platform_version_req(&config.platformVersion)?,
Jiyong Parke6ed0f92022-06-22 00:13:00 +0900629 detect_hangup: is_app_config,
Nikita Ioffe5776f082023-02-10 21:38:26 +0000630 gdb_port,
Inseob Kim7307a892023-09-14 13:37:58 +0900631 vfio_devices,
David Brazdil2dfefd12023-11-17 14:07:36 +0000632 dtbo,
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000633 device_tree_overlay,
Jeongik Cha1df1c032024-04-03 16:03:12 +0900634 display_config,
Jeongik Chac181be72024-03-27 00:18:30 +0900635 input_device_options,
Vincent Donnefort538a2c62024-03-20 16:01:10 +0000636 hugepages: config.hugePages,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000637 };
638 let instance = Arc::new(
David Brazdil528e0472022-10-10 15:06:02 +0100639 VmInstance::new(
640 crosvm_config,
641 temporary_directory,
642 requester_uid,
643 requester_debug_pid,
644 vm_context,
645 )
Jiyong Park2227eaa2023-08-04 11:59:18 +0900646 .with_context(|| format!("Failed to create VM with config {:?}", config))
647 .with_log()
648 .or_service_specific_exception(-1)?,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000649 );
650 state.add_vm(Arc::downgrade(&instance));
651 Ok(VirtualMachine::create(instance))
652 }
Jiyong Park8611a6c2021-07-09 18:17:44 +0900653}
654
Alan Stokesfda70842023-12-20 17:50:14 +0000655/// Returns whether a VM config represents a "custom" virtual machine, which requires the
656/// USE_CUSTOM_VIRTUAL_MACHINE.
657fn is_custom_config(config: &VirtualMachineConfig) -> bool {
658 match config {
659 // Any raw (non-Microdroid) VM is considered custom.
660 VirtualMachineConfig::RawConfig(_) => true,
661 VirtualMachineConfig::AppConfig(config) => {
662 // Some features are reserved for platform apps only, even when using
663 // VirtualMachineAppConfig. Almost all of these features are grouped in the
664 // CustomConfig struct:
665 // - controlling CPUs;
666 // - gdbPort is set, meaning that crosvm will start a gdb server;
667 // - using anything other than the default kernel;
668 // - specifying devices to be assigned.
669 if config.customConfig.is_some() {
670 true
671 } else {
672 // Additional custom features not included in CustomConfig:
673 // - specifying a config file;
Alan Stokes736f6822024-02-16 16:08:00 +0000674 // - specifying extra APKs;
675 // - specifying an OS other than Microdroid.
Inseob Kim89b24592024-02-23 18:59:43 +0900676 (match &config.payload {
Alan Stokesfda70842023-12-20 17:50:14 +0000677 Payload::ConfigPath(_) => true,
Inseob Kim89b24592024-02-23 18:59:43 +0900678 Payload::PayloadConfig(payload_config) => !payload_config.extraApks.is_empty(),
679 }) || config.osName != MICRODROID_OS_NAME
Alan Stokesfda70842023-12-20 17:50:14 +0000680 }
681 }
682 }
683}
684
Seungjae Yoo14e60182024-02-21 13:28:31 +0900685fn extract_vendor_hashtree_digest(config: &VirtualMachineConfig) -> Result<Option<Vec<u8>>> {
686 let VirtualMachineConfig::AppConfig(config) = config else {
687 return Ok(None);
688 };
689 let Some(custom_config) = &config.customConfig else {
690 return Ok(None);
691 };
692 let Some(file) = custom_config.vendorImage.as_ref() else {
693 return Ok(None);
694 };
695
696 let file = clone_file(file)?;
697 let size =
698 file.metadata().context("Failed to get metadata from microdroid vendor image")?.len();
699 let vbmeta = VbMetaImage::verify_reader_region(&file, 0, size)
700 .context("Failed to get vbmeta from microdroid-vendor.img")?;
701
702 for descriptor in vbmeta.descriptors()?.iter() {
703 if let vbmeta::Descriptor::Hashtree(_) = descriptor {
704 let root_digest = hex::encode(descriptor.to_hashtree()?.root_digest());
705 return Ok(Some(root_digest.as_bytes().to_vec()));
706 }
707 }
708 Err(anyhow!("No hashtree digest is extracted from microdroid vendor image"))
709}
710
Andrew Walbranfbb39d22021-07-28 17:01:25 +0000711fn write_zero_filler(zero_filler_path: &Path) -> Result<()> {
Jooyung Han95884632021-07-06 22:27:54 +0900712 let file = OpenOptions::new()
713 .create_new(true)
714 .read(true)
715 .write(true)
716 .open(zero_filler_path)
717 .with_context(|| "Failed to create zero.img")?;
718 file.set_len(ZERO_FILLER_SIZE)?;
Andrew Walbranfbb39d22021-07-28 17:01:25 +0000719 Ok(())
Jooyung Han95884632021-07-06 22:27:54 +0900720}
721
David Brazdilf50c7a62023-04-19 14:22:42 +0000722fn format_as_android_vm_instance(part: &mut dyn Write) -> std::io::Result<()> {
723 part.write_all(ANDROID_VM_INSTANCE_MAGIC.as_bytes())?;
724 part.write_all(&ANDROID_VM_INSTANCE_VERSION.to_le_bytes())?;
725 part.flush()
726}
727
728fn format_as_encryptedstore(part: &mut dyn Write) -> std::io::Result<()> {
729 part.write_all(UNFORMATTED_STORAGE_MAGIC.as_bytes())?;
730 part.flush()
731}
732
733fn round_up(input: u64, granularity: u64) -> u64 {
734 if granularity == 0 {
735 return input;
736 }
737 // If the input is absurdly large we round down instead of up; it's going to fail anyway.
738 let result = input.checked_add(granularity - 1).unwrap_or(input);
739 (result / granularity) * granularity
740}
741
Jeongik Chac181be72024-03-27 00:18:30 +0900742fn to_input_device_option_from(input_device: &InputDevice) -> Result<InputDeviceOption> {
743 Ok(match input_device {
744 InputDevice::SingleTouch(single_touch) => InputDeviceOption::SingleTouch {
745 file: clone_file(single_touch.pfd.as_ref().ok_or(anyhow!("pfd should have value"))?)?,
746 height: u32::try_from(single_touch.height)?,
747 width: u32::try_from(single_touch.width)?,
748 name: if !single_touch.name.is_empty() {
749 Some(single_touch.name.clone())
750 } else {
751 None
752 },
753 },
754 InputDevice::EvDev(evdev) => InputDeviceOption::EvDev(clone_file(
755 evdev.pfd.as_ref().ok_or(anyhow!("pfd should have value"))?,
756 )?),
Jeongik Cha985b6402024-04-15 18:13:00 +0900757 InputDevice::Keyboard(keyboard) => InputDeviceOption::Keyboard(clone_file(
758 keyboard.pfd.as_ref().ok_or(anyhow!("pfd should have value"))?,
759 )?),
Jeongik Cha343894e2024-05-17 20:39:31 +0900760 InputDevice::Mouse(mouse) => InputDeviceOption::Mouse(clone_file(
761 mouse.pfd.as_ref().ok_or(anyhow!("pfd should have value"))?,
762 )?),
Jeongik Chac181be72024-03-27 00:18:30 +0900763 })
764}
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000765/// Given the configuration for a disk image, assembles the `DiskFile` to pass to crosvm.
766///
767/// This may involve assembling a composite disk from a set of partition images.
768fn assemble_disk_image(
769 disk: &DiskImage,
Jooyung Han95884632021-07-06 22:27:54 +0900770 zero_filler_path: &Path,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000771 temporary_directory: &Path,
772 next_temporary_image_id: &mut u64,
773 indirect_files: &mut Vec<File>,
Andrew Walbran806f1542021-06-10 14:07:12 +0000774) -> Result<DiskFile, Status> {
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000775 let image = if !disk.partitions.is_empty() {
776 if disk.image.is_some() {
777 warn!("DiskImage {:?} contains both image and partitions.", disk);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900778 return Err(anyhow!("DiskImage contains both image and partitions"))
779 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000780 }
781
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000782 let composite_image_filenames =
783 make_composite_image_filenames(temporary_directory, next_temporary_image_id);
784 let (image, partition_files) = make_composite_image(
785 &disk.partitions,
Jooyung Han95884632021-07-06 22:27:54 +0900786 zero_filler_path,
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000787 &composite_image_filenames.composite,
788 &composite_image_filenames.header,
789 &composite_image_filenames.footer,
790 )
Jiyong Park2227eaa2023-08-04 11:59:18 +0900791 .with_context(|| format!("Failed to make composite disk image with config {:?}", disk))
792 .with_log()
793 .or_service_specific_exception(-1)?;
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000794
795 // Pass the file descriptors for the various partition files to crosvm when it
796 // is run.
797 indirect_files.extend(partition_files);
798
799 image
800 } else if let Some(image) = &disk.image {
801 clone_file(image)?
802 } else {
803 warn!("DiskImage {:?} didn't contain image or partitions.", disk);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900804 return Err(anyhow!("DiskImage didn't contain image or partitions."))
805 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000806 };
807
808 Ok(DiskFile { image, writable: disk.writable })
809}
810
Nikita Ioffeaa6858c2023-07-04 01:37:41 +0100811fn append_kernel_param(param: &str, vm_config: &mut VirtualMachineRawConfig) {
812 if let Some(ref mut params) = vm_config.params {
813 params.push(' ');
814 params.push_str(param)
815 } else {
816 vm_config.params = Some(param.to_owned())
817 }
818}
819
Inseob Kim46257382024-01-03 15:41:22 +0900820fn extract_os_name_from_config_path(config: &Path) -> Option<String> {
821 if config.extension()?.to_str()? != "json" {
822 return None;
Inseob Kim172f9eb2023-11-06 17:02:08 +0900823 }
Inseob Kim46257382024-01-03 15:41:22 +0900824
825 Some(config.with_extension("").file_name()?.to_str()?.to_owned())
826}
827
828fn extract_os_names_from_configs(config_glob_pattern: &str) -> Result<HashSet<String>> {
829 let configs = glob(config_glob_pattern)?.collect::<Result<Vec<_>, _>>()?;
830 let os_names =
831 configs.iter().filter_map(|x| extract_os_name_from_config_path(x)).collect::<HashSet<_>>();
832
833 Ok(os_names)
834}
835
836fn get_supported_os_names() -> Result<HashSet<String>> {
837 if !cfg!(vendor_modules) {
838 return Ok(iter::once(MICRODROID_OS_NAME.to_owned()).collect());
839 }
840
841 extract_os_names_from_configs("/apex/com.android.virt/etc/microdroid*.json")
842}
843
844fn is_valid_os(os_name: &str) -> bool {
845 SUPPORTED_OS_NAMES.contains(os_name)
Inseob Kim172f9eb2023-11-06 17:02:08 +0900846}
847
Jooyung Han21e9b922021-06-26 04:14:16 +0900848fn load_app_config(
849 config: &VirtualMachineAppConfig,
Jaewan Kim61f86142023-03-28 15:12:52 +0900850 debug_config: &DebugConfig,
Jooyung Han21e9b922021-06-26 04:14:16 +0900851 temporary_directory: &Path,
Jooyung Hanadfb76c2021-06-28 17:29:30 +0900852) -> Result<VirtualMachineRawConfig> {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000853 let apk_file = clone_file(config.apk.as_ref().unwrap())?;
854 let idsig_file = clone_file(config.idsig.as_ref().unwrap())?;
Jiyong Park8d081812021-07-23 17:45:04 +0900855 let instance_file = clone_file(config.instanceImage.as_ref().unwrap())?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900856
Shikha Panwar22e70452022-10-10 18:32:55 +0000857 let storage_image = if let Some(file) = config.encryptedStorageImage.as_ref() {
858 Some(clone_file(file)?)
859 } else {
860 None
861 };
862
Alan Stokesfda70842023-12-20 17:50:14 +0000863 let vm_payload_config;
864 let extra_apk_files: Vec<_>;
865 match &config.payload {
Alan Stokes0d1ef782022-09-27 13:46:35 +0100866 Payload::ConfigPath(config_path) => {
Alan Stokesfda70842023-12-20 17:50:14 +0000867 vm_payload_config =
868 load_vm_payload_config_from_file(&apk_file, config_path.as_str())
869 .with_context(|| format!("Couldn't read config from {}", config_path))?;
870 extra_apk_files = vm_payload_config
871 .extra_apks
872 .iter()
873 .enumerate()
874 .map(|(i, apk)| {
875 File::open(PathBuf::from(&apk.path))
876 .with_context(|| format!("Failed to open extra apk #{i} {}", apk.path))
877 })
878 .collect::<Result<_>>()?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100879 }
Alan Stokesfda70842023-12-20 17:50:14 +0000880 Payload::PayloadConfig(payload_config) => {
881 vm_payload_config = create_vm_payload_config(payload_config)?;
882 extra_apk_files =
883 payload_config.extraApks.iter().map(clone_file).collect::<binder::Result<_>>()?;
884 }
Alan Stokes0d1ef782022-09-27 13:46:35 +0100885 };
Jooyung Han21e9b922021-06-26 04:14:16 +0900886
Inseob Kim89b24592024-02-23 18:59:43 +0900887 let payload_config_os = vm_payload_config.os.name.as_str();
888 if !payload_config_os.is_empty() && payload_config_os != "microdroid" {
889 bail!("'os' in payload config is deprecated");
890 }
891
Inseob Kim172f9eb2023-11-06 17:02:08 +0900892 // For now, the only supported OS is Microdroid and Microdroid GKI
Inseob Kim89b24592024-02-23 18:59:43 +0900893 let os_name = config.osName.as_str();
Inseob Kim172f9eb2023-11-06 17:02:08 +0900894 if !is_valid_os(os_name) {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000895 bail!("Unknown OS \"{}\"", os_name);
Jooyung Han35edb8f2021-07-01 16:17:16 +0900896 }
Andrew Walbrancc0db522021-07-12 17:03:42 +0000897
898 // It is safe to construct a filename based on the os_name because we've already checked that it
899 // is one of the allowed values.
Jooyung Han21e9b922021-06-26 04:14:16 +0900900 let vm_config_path = PathBuf::from(format!("/apex/com.android.virt/etc/{}.json", os_name));
901 let vm_config_file = File::open(vm_config_path)?;
Andrew Walbrancc0db522021-07-12 17:03:42 +0000902 let mut vm_config = VmConfig::load(&vm_config_file)?.to_parcelable()?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900903
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +0100904 if let Some(custom_config) = &config.customConfig {
905 if let Some(file) = custom_config.customKernelImage.as_ref() {
906 vm_config.kernel = Some(ParcelFileDescriptor::new(clone_file(file)?))
907 }
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +0100908 vm_config.gdbPort = custom_config.gdbPort;
Nikita Ioffe5dfddf22023-06-29 16:11:26 +0100909
910 if let Some(file) = custom_config.vendorImage.as_ref() {
Nikita Ioffeaa6858c2023-07-04 01:37:41 +0100911 add_microdroid_vendor_image(clone_file(file)?, &mut vm_config);
912 append_kernel_param("androidboot.microdroid.mount_vendor=1", &mut vm_config)
Nikita Ioffe5dfddf22023-06-29 16:11:26 +0100913 }
Inseob Kim6ef80972023-07-20 17:23:36 +0900914
Chris Wailes6177c662024-05-09 14:37:44 -0700915 vm_config.devices.clone_from(&custom_config.devices);
Nikita Ioffe26c35ed2023-06-05 17:49:08 +0100916 }
917
Andrew Walbrancc045902021-07-27 16:06:17 +0000918 if config.memoryMib > 0 {
919 vm_config.memoryMib = config.memoryMib;
Andrew Walbran45bcb0c2021-07-14 15:02:06 +0000920 }
921
Chris Wailes6177c662024-05-09 14:37:44 -0700922 vm_config.name.clone_from(&config.name);
Andrew Walbran3994f002022-01-27 17:33:45 +0000923 vm_config.protectedVm = config.protectedVm;
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000924 vm_config.cpuTopology = config.cpuTopology;
Vincent Donnefort538a2c62024-03-20 16:01:10 +0000925 vm_config.hugePages = config.hugePages || vm_payload_config.hugepages;
Jiyong Park032615f2022-01-10 13:55:34 +0900926
Shikha Panwar22e70452022-10-10 18:32:55 +0000927 // Microdroid takes additional init ramdisk & (optionally) storage image
Inseob Kim172f9eb2023-11-06 17:02:08 +0900928 add_microdroid_system_images(config, instance_file, storage_image, os_name, &mut vm_config)?;
Shikha Panwar22e70452022-10-10 18:32:55 +0000929
930 // Include Microdroid payload disk (contains apks, idsigs) in vm config
931 add_microdroid_payload_images(
Alan Stokes0d1ef782022-09-27 13:46:35 +0100932 config,
Jaewan Kim61f86142023-03-28 15:12:52 +0900933 debug_config,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100934 temporary_directory,
935 apk_file,
936 idsig_file,
Alan Stokesfda70842023-12-20 17:50:14 +0000937 extra_apk_files,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100938 &vm_payload_config,
939 &mut vm_config,
940 )?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900941
Andrew Walbrancc0db522021-07-12 17:03:42 +0000942 Ok(vm_config)
Jooyung Han21e9b922021-06-26 04:14:16 +0900943}
944
Inseob Kimff48a7c2024-02-26 22:07:21 +0900945fn check_partition_for_file(fd: &ParcelFileDescriptor) -> Result<()> {
946 let path = format!("/proc/self/fd/{}", fd.as_raw_fd());
947 let link = fs::read_link(&path).context(format!("can't read_link {path}"))?;
948
949 // microdroid vendor image is OK
950 if cfg!(vendor_modules) && link == Path::new("/vendor/etc/avf/microdroid/microdroid_vendor.img")
951 {
952 return Ok(());
953 }
954
955 if link.starts_with("/vendor") || link.starts_with("/odm") {
956 bail!("vendor or odm file {} can't be used for VM", link.display());
957 }
958
959 Ok(())
960}
961
962fn check_partitions_for_files(config: &VirtualMachineRawConfig) -> Result<()> {
963 config
964 .disks
965 .iter()
966 .flat_map(|disk| disk.partitions.iter())
967 .filter_map(|partition| partition.image.as_ref())
968 .try_for_each(check_partition_for_file)?;
969
970 config.kernel.as_ref().map_or(Ok(()), check_partition_for_file)?;
971 config.initrd.as_ref().map_or(Ok(()), check_partition_for_file)?;
972 config.bootloader.as_ref().map_or(Ok(()), check_partition_for_file)?;
973
974 Ok(())
975}
976
Alan Stokes0d1ef782022-09-27 13:46:35 +0100977fn load_vm_payload_config_from_file(apk_file: &File, config_path: &str) -> Result<VmPayloadConfig> {
978 let mut apk_zip = ZipArchive::new(apk_file)?;
979 let config_file = apk_zip.by_name(config_path)?;
980 Ok(serde_json::from_reader(config_file)?)
981}
982
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000983fn create_vm_payload_config(
984 payload_config: &VirtualMachinePayloadConfig,
985) -> Result<VmPayloadConfig> {
Alan Stokes0d1ef782022-09-27 13:46:35 +0100986 // There isn't an actual config file. Construct a synthetic VmPayloadConfig from the explicit
987 // parameters we've been given. Microdroid will do something equivalent inside the VM using the
988 // payload config that we send it via the metadata file.
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000989
990 let payload_binary_name = &payload_config.payloadBinaryName;
991 if payload_binary_name.contains('/') {
992 bail!("Payload binary name must not specify a path: {payload_binary_name}");
993 }
994
995 let task = Task { type_: TaskType::MicrodroidLauncher, command: payload_binary_name.clone() };
Alan Stokesfda70842023-12-20 17:50:14 +0000996
997 // The VM only cares about how many there are, these names are actually ignored.
998 let extra_apk_count = payload_config.extraApks.len();
999 let extra_apks =
1000 (0..extra_apk_count).map(|i| ApkConfig { path: format!("extra-apk-{i}") }).collect();
1001
Inseob Kim89b24592024-02-23 18:59:43 +09001002 Ok(VmPayloadConfig { task: Some(task), extra_apks, ..Default::default() })
Alan Stokes0d1ef782022-09-27 13:46:35 +01001003}
1004
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +00001005/// Generates a unique filename to use for a composite disk image.
Andrew Walbran3eca16c2021-06-14 11:15:14 +00001006fn make_composite_image_filenames(
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +00001007 temporary_directory: &Path,
1008 next_temporary_image_id: &mut u64,
Andrew Walbran3eca16c2021-06-14 11:15:14 +00001009) -> CompositeImageFilenames {
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +00001010 let id = *next_temporary_image_id;
1011 *next_temporary_image_id += 1;
Andrew Walbran3eca16c2021-06-14 11:15:14 +00001012 CompositeImageFilenames {
1013 composite: temporary_directory.join(format!("composite-{}.img", id)),
1014 header: temporary_directory.join(format!("composite-{}-header.img", id)),
1015 footer: temporary_directory.join(format!("composite-{}-footer.img", id)),
1016 }
1017}
1018
1019/// Filenames for a composite disk image, including header and footer partitions.
1020#[derive(Clone, Debug, Eq, PartialEq)]
1021struct CompositeImageFilenames {
1022 /// The composite disk image itself.
1023 composite: PathBuf,
1024 /// The header partition image.
1025 header: PathBuf,
1026 /// The footer partition image.
1027 footer: PathBuf,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +00001028}
1029
Jiyong Park753553b2021-07-12 21:21:09 +09001030/// Checks whether the caller has a specific permission
1031fn check_permission(perm: &str) -> binder::Result<()> {
David Brazdil1f530702022-10-03 12:18:10 +01001032 let calling_pid = get_calling_pid();
1033 let calling_uid = get_calling_uid();
Jiyong Park753553b2021-07-12 21:21:09 +09001034 // Root can do anything
1035 if calling_uid == 0 {
1036 return Ok(());
1037 }
1038 let perm_svc: Strong<dyn IPermissionController::IPermissionController> =
1039 binder::get_interface("permission")?;
1040 if perm_svc.checkPermission(perm, calling_pid, calling_uid as i32)? {
Andrew Walbran806f1542021-06-10 14:07:12 +00001041 Ok(())
1042 } else {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001043 Err(anyhow!("does not have the {} permission", perm))
1044 .or_binder_exception(ExceptionCode::SECURITY)
Andrew Walbran806f1542021-06-10 14:07:12 +00001045 }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001046}
1047
Jiyong Park753553b2021-07-12 21:21:09 +09001048/// Check whether the caller of the current Binder method is allowed to manage VMs
1049fn check_manage_access() -> binder::Result<()> {
1050 check_permission("android.permission.MANAGE_VIRTUAL_MACHINE")
1051}
1052
Inseob Kim1119d702022-05-02 18:01:58 +09001053/// Check whether the caller of the current Binder method is allowed to create custom VMs
1054fn check_use_custom_virtual_machine() -> binder::Result<()> {
1055 check_permission("android.permission.USE_CUSTOM_VIRTUAL_MACHINE")
1056}
1057
Alan Stokes185fe112023-01-10 16:20:55 +00001058/// Return whether a partition is exempt from selinux label checks, because we know that it does
1059/// not contain code and is likely to be generated in an app-writable directory.
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001060fn is_safe_app_partition(label: &str) -> bool {
Shikha Panwara2ff8c52022-11-30 19:25:46 +00001061 // See add_microdroid_system_images & add_microdroid_payload_images in payload.rs.
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001062 label == "vm-instance"
Shikha Panwara2ff8c52022-11-30 19:25:46 +00001063 || label == "encryptedstore"
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001064 || label == "microdroid-apk-idsig"
1065 || label == "payload-metadata"
1066 || label.starts_with("extra-idsig-")
1067}
1068
Alice Wangc206b9b2023-08-28 14:13:51 +00001069/// Returns whether a partition with the given label is safe for a raw config VM.
1070fn is_safe_raw_partition(label: &str) -> bool {
1071 label == "vm-instance"
1072}
1073
Alan Stokes185fe112023-01-10 16:20:55 +00001074/// Check that a file SELinux label is acceptable.
1075///
1076/// We only want to allow code in a VM to be sourced from places that apps, and the
Seungjae Yoo2b74c442023-11-15 18:05:07 +09001077/// system or vendor, do not have write access to.
Alan Stokes185fe112023-01-10 16:20:55 +00001078///
1079/// Note that sepolicy must also grant read access for these types to both virtualization
1080/// service and crosvm.
1081///
1082/// App private data files are deliberately excluded, to avoid arbitrary payloads being run on
1083/// user devices (W^X).
1084fn check_label_is_allowed(context: &SeContext) -> Result<()> {
1085 match context.selinux_type()? {
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001086 | "apk_data_file" // APKs of an installed app
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001087 | "shell_data_file" // test files created via adb shell
Alan Stokesfe4bb0c2023-03-20 14:15:36 +00001088 | "staging_data_file" // updated/staged APEX images
1089 | "system_file" // immutable dm-verity protected partition
1090 | "virtualizationservice_data_file" // files created by VS / VirtMgr
Seungjae Yoo2b74c442023-11-15 18:05:07 +09001091 | "vendor_microdroid_file" // immutable dm-verity protected partition (/vendor/etc/avf/microdroid/.*)
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001092 => Ok(()),
Alan Stokes185fe112023-01-10 16:20:55 +00001093 _ => bail!("Label {} is not allowed", context),
Jiyong Park029977d2021-11-24 21:56:49 +09001094 }
1095}
1096
Alan Stokes185fe112023-01-10 16:20:55 +00001097fn check_label_for_partition(partition: &Partition) -> Result<()> {
1098 let file = partition.image.as_ref().unwrap().as_ref();
1099 check_label_is_allowed(&getfilecon(file)?)
1100 .with_context(|| format!("Partition {} invalid", &partition.label))
1101}
1102
1103fn check_label_for_kernel_files(kernel: &Option<File>, initrd: &Option<File>) -> Result<()> {
1104 if let Some(f) = kernel {
1105 check_label_for_file(f, "kernel")?;
1106 }
1107 if let Some(f) = initrd {
1108 check_label_for_file(f, "initrd")?;
1109 }
1110 Ok(())
1111}
1112fn check_label_for_file(file: &File, name: &str) -> Result<()> {
1113 check_label_is_allowed(&getfilecon(file)?).with_context(|| format!("{} file invalid", name))
1114}
1115
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001116/// Implementation of the AIDL `IVirtualMachine` interface. Used as a handle to a VM.
1117#[derive(Debug)]
1118struct VirtualMachine {
1119 instance: Arc<VmInstance>,
1120}
1121
1122impl VirtualMachine {
1123 fn create(instance: Arc<VmInstance>) -> Strong<dyn IVirtualMachine> {
David Brazdil4b4c5102022-12-19 22:56:20 +00001124 BnVirtualMachine::new_binder(VirtualMachine { instance }, BinderFeatures::default())
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001125 }
1126}
1127
1128impl Interface for VirtualMachine {}
1129
1130impl IVirtualMachine for VirtualMachine {
1131 fn getCid(&self) -> binder::Result<i32> {
Jiyong Park753553b2021-07-12 21:21:09 +09001132 // Don't check permission. The owner of the VM might have passed this binder object to
1133 // others.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001134 Ok(self.instance.cid as i32)
1135 }
Andrew Walbrandae07162021-03-12 17:05:20 +00001136
Andrew Walbran6b650662021-09-07 13:13:23 +00001137 fn getState(&self) -> binder::Result<VirtualMachineState> {
Jiyong Park753553b2021-07-12 21:21:09 +09001138 // Don't check permission. The owner of the VM might have passed this binder object to
1139 // others.
Andrew Walbran6b650662021-09-07 13:13:23 +00001140 Ok(get_state(&self.instance))
Andrew Walbrandae07162021-03-12 17:05:20 +00001141 }
1142
1143 fn registerCallback(
1144 &self,
1145 callback: &Strong<dyn IVirtualMachineCallback>,
1146 ) -> binder::Result<()> {
Jiyong Park753553b2021-07-12 21:21:09 +09001147 // Don't check permission. The owner of the VM might have passed this binder object to
1148 // others.
1149 //
Andrew Walbrandae07162021-03-12 17:05:20 +00001150 // TODO: Should this give an error if the VM is already dead?
1151 self.instance.callbacks.add(callback.clone());
1152 Ok(())
1153 }
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001154
Andrew Walbranf8d94112021-09-07 11:45:36 +00001155 fn start(&self) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001156 self.instance
1157 .start()
1158 .with_context(|| format!("Error starting VM with CID {}", self.instance.cid))
1159 .with_log()
1160 .or_service_specific_exception(-1)
Andrew Walbranf8d94112021-09-07 11:45:36 +00001161 }
1162
Inseob Kima446f802022-07-11 19:46:37 +09001163 fn stop(&self) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001164 self.instance
1165 .kill()
1166 .with_context(|| format!("Error stopping VM with CID {}", self.instance.cid))
1167 .with_log()
1168 .or_service_specific_exception(-1)
Inseob Kima446f802022-07-11 19:46:37 +09001169 }
1170
Keir Frasercdd4b112022-11-24 14:02:25 +00001171 fn onTrimMemory(&self, level: MemoryTrimLevel) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001172 self.instance
1173 .trim_memory(level)
1174 .with_context(|| format!("Error trimming VM with CID {}", self.instance.cid))
1175 .with_log()
1176 .or_service_specific_exception(-1)
Keir Frasercdd4b112022-11-24 14:02:25 +00001177 }
1178
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001179 fn connectVsock(&self, port: i32) -> binder::Result<ParcelFileDescriptor> {
Andrew Walbranf8d94112021-09-07 11:45:36 +00001180 if !matches!(&*self.instance.vm_state.lock().unwrap(), VmState::Running { .. }) {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001181 return Err(anyhow!("VM is not running")).or_service_specific_exception(-1);
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001182 }
Alan Stokes10c47672022-12-13 17:17:08 +00001183 let port = port as u32;
1184 if port < 1024 {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001185 return Err(anyhow!("Can't connect to privileged port {port}"))
1186 .or_service_specific_exception(-1);
Alan Stokes10c47672022-12-13 17:17:08 +00001187 }
Jiyong Park2227eaa2023-08-04 11:59:18 +09001188 let stream = VsockStream::connect_with_cid_port(self.instance.cid, port)
1189 .context("Failed to connect")
1190 .or_service_specific_exception(-1)?;
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001191 Ok(vsock_stream_to_pfd(stream))
1192 }
Andrew Walbrandae07162021-03-12 17:05:20 +00001193}
1194
1195impl Drop for VirtualMachine {
1196 fn drop(&mut self) {
1197 debug!("Dropping {:?}", self);
Inseob Kima446f802022-07-11 19:46:37 +09001198 if let Err(e) = self.instance.kill() {
1199 debug!("Error stopping dropped VM with CID {}: {:?}", self.instance.cid, e);
1200 }
Andrew Walbrandae07162021-03-12 17:05:20 +00001201 }
1202}
1203
1204/// A set of Binders to be called back in response to various events on the VM, such as when it
1205/// dies.
1206#[derive(Debug, Default)]
1207pub struct VirtualMachineCallbacks(Mutex<Vec<Strong<dyn IVirtualMachineCallback>>>);
1208
1209impl VirtualMachineCallbacks {
Jiyong Park8611a6c2021-07-09 18:17:44 +09001210 /// Call all registered callbacks to notify that the payload has started.
David Brazdil451cc962022-10-14 14:08:12 +01001211 pub fn notify_payload_started(&self, cid: Cid) {
Jiyong Park8611a6c2021-07-09 18:17:44 +09001212 let callbacks = &*self.0.lock().unwrap();
Jiyong Park8611a6c2021-07-09 18:17:44 +09001213 for callback in callbacks {
David Brazdil451cc962022-10-14 14:08:12 +01001214 if let Err(e) = callback.onPayloadStarted(cid as i32) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001215 error!("Error notifying payload start event from VM CID {}: {:?}", cid, e);
Jiyong Park8611a6c2021-07-09 18:17:44 +09001216 }
1217 }
1218 }
1219
Inseob Kim14cb8692021-08-31 21:50:39 +09001220 /// Call all registered callbacks to notify that the payload is ready to serve.
1221 pub fn notify_payload_ready(&self, cid: Cid) {
1222 let callbacks = &*self.0.lock().unwrap();
1223 for callback in callbacks {
1224 if let Err(e) = callback.onPayloadReady(cid as i32) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001225 error!("Error notifying payload ready event from VM CID {}: {:?}", cid, e);
Inseob Kim14cb8692021-08-31 21:50:39 +09001226 }
1227 }
1228 }
1229
Inseob Kim2444af92021-08-31 01:22:50 +09001230 /// Call all registered callbacks to notify that the payload has finished.
1231 pub fn notify_payload_finished(&self, cid: Cid, exit_code: i32) {
1232 let callbacks = &*self.0.lock().unwrap();
1233 for callback in callbacks {
1234 if let Err(e) = callback.onPayloadFinished(cid as i32, exit_code) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001235 error!("Error notifying payload finish event from VM CID {}: {:?}", cid, e);
Inseob Kim2444af92021-08-31 01:22:50 +09001236 }
1237 }
1238 }
1239
Jooyung Handd0a1732021-11-23 15:26:20 +09001240 /// Call all registered callbacks to say that the VM encountered an error.
Alan Stokes2bead0d2022-09-05 16:58:34 +01001241 pub fn notify_error(&self, cid: Cid, error_code: ErrorCode, message: &str) {
Jooyung Handd0a1732021-11-23 15:26:20 +09001242 let callbacks = &*self.0.lock().unwrap();
1243 for callback in callbacks {
1244 if let Err(e) = callback.onError(cid as i32, error_code, message) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001245 error!("Error notifying error event from VM CID {}: {:?}", cid, e);
Jooyung Handd0a1732021-11-23 15:26:20 +09001246 }
1247 }
1248 }
1249
Andrew Walbrandae07162021-03-12 17:05:20 +00001250 /// Call all registered callbacks to say that the VM has died.
Andrew Walbranc92d35f2022-01-12 12:45:19 +00001251 pub fn callback_on_died(&self, cid: Cid, reason: DeathReason) {
Andrew Walbrandae07162021-03-12 17:05:20 +00001252 let callbacks = &*self.0.lock().unwrap();
1253 for callback in callbacks {
Andrew Walbranc92d35f2022-01-12 12:45:19 +00001254 if let Err(e) = callback.onDied(cid as i32, reason) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001255 error!("Error notifying exit of VM CID {}: {:?}", cid, e);
Andrew Walbrandae07162021-03-12 17:05:20 +00001256 }
1257 }
1258 }
1259
1260 /// Add a new callback to the set.
1261 fn add(&self, callback: Strong<dyn IVirtualMachineCallback>) {
1262 self.0.lock().unwrap().push(callback);
1263 }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001264}
1265
Andrew Walbranf6bf6862021-05-21 12:41:13 +00001266/// The mutable state of the VirtualizationService. There should only be one instance of this
1267/// struct.
Chris Wailes641fc4a2021-12-01 15:03:21 -08001268#[derive(Debug, Default)]
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001269struct State {
Alan Stokes3e5eec12023-09-07 12:10:00 +01001270 /// The VMs which have been started. When VMs are started a weak reference is added to this
1271 /// list while a strong reference is returned to the caller over Binder. Once all copies of
1272 /// the Binder client are dropped the weak reference here will become invalid, and will be
1273 /// removed from the list opportunistically the next time `add_vm` is called.
Andrew Walbran320b5602021-03-04 16:11:12 +00001274 vms: Vec<Weak<VmInstance>>,
1275}
1276
1277impl State {
Andrew Walbrandae07162021-03-12 17:05:20 +00001278 /// Get a list of VMs which still have Binder references to them.
Andrew Walbran320b5602021-03-04 16:11:12 +00001279 fn vms(&self) -> Vec<Arc<VmInstance>> {
1280 // Attempt to upgrade the weak pointers to strong pointers.
1281 self.vms.iter().filter_map(Weak::upgrade).collect()
1282 }
1283
1284 /// Add a new VM to the list.
1285 fn add_vm(&mut self, vm: Weak<VmInstance>) {
1286 // Garbage collect any entries from the stored list which no longer exist.
1287 self.vms.retain(|vm| vm.strong_count() > 0);
1288
1289 // Actually add the new VM.
1290 self.vms.push(vm);
1291 }
David Brazdil3c2ddef2021-03-18 13:09:57 +00001292
Jiyong Park8611a6c2021-07-09 18:17:44 +09001293 /// Get a VM that corresponds to the given cid
1294 fn get_vm(&self, cid: Cid) -> Option<Arc<VmInstance>> {
1295 self.vms().into_iter().find(|vm| vm.cid == cid)
1296 }
Jiyong Parkd50a0242021-09-16 21:00:14 +09001297}
1298
Andrew Walbran6b650662021-09-07 13:13:23 +00001299/// Gets the `VirtualMachineState` of the given `VmInstance`.
1300fn get_state(instance: &VmInstance) -> VirtualMachineState {
Andrew Walbranf8d94112021-09-07 11:45:36 +00001301 match &*instance.vm_state.lock().unwrap() {
1302 VmState::NotStarted { .. } => VirtualMachineState::NOT_STARTED,
1303 VmState::Running { .. } => match instance.payload_state() {
Andrew Walbran6b650662021-09-07 13:13:23 +00001304 PayloadState::Starting => VirtualMachineState::STARTING,
1305 PayloadState::Started => VirtualMachineState::STARTED,
1306 PayloadState::Ready => VirtualMachineState::READY,
1307 PayloadState::Finished => VirtualMachineState::FINISHED,
Jiyong Parka4eebde2022-07-12 18:01:12 +09001308 PayloadState::Hangup => VirtualMachineState::DEAD,
Andrew Walbranf8d94112021-09-07 11:45:36 +00001309 },
1310 VmState::Dead => VirtualMachineState::DEAD,
1311 VmState::Failed => VirtualMachineState::DEAD,
Andrew Walbran6b650662021-09-07 13:13:23 +00001312 }
1313}
1314
David Brazdilf50c7a62023-04-19 14:22:42 +00001315/// Converts a `&ParcelFileDescriptor` to a `File` by cloning the file.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001316pub fn clone_file(file: &ParcelFileDescriptor) -> binder::Result<File> {
1317 file.as_ref()
1318 .try_clone()
1319 .context("Failed to clone File from ParcelFileDescriptor")
1320 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)
Andrei Homescu11333c62023-11-09 04:26:39 +00001321 .map(File::from)
David Brazdilf50c7a62023-04-19 14:22:42 +00001322}
1323
Andrew Walbrand3a84182021-09-07 14:48:52 +00001324/// Converts an `&Option<ParcelFileDescriptor>` to an `Option<File>` by cloning the file.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001325fn maybe_clone_file(file: &Option<ParcelFileDescriptor>) -> binder::Result<Option<File>> {
Andrew Walbrand3a84182021-09-07 14:48:52 +00001326 file.as_ref().map(clone_file).transpose()
1327}
1328
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001329/// Converts a `VsockStream` to a `ParcelFileDescriptor`.
1330fn vsock_stream_to_pfd(stream: VsockStream) -> ParcelFileDescriptor {
1331 // SAFETY: ownership is transferred from stream to f
1332 let f = unsafe { File::from_raw_fd(stream.into_raw_fd()) };
1333 ParcelFileDescriptor::new(f)
1334}
1335
Jiyong Parkdcf17412022-02-08 15:07:23 +09001336/// Parses the platform version requirement string.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001337fn parse_platform_version_req(s: &str) -> binder::Result<VersionReq> {
1338 VersionReq::parse(s)
1339 .with_context(|| format!("Invalid platform version requirement {}", s))
1340 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)
Jiyong Parkdcf17412022-02-08 15:07:23 +09001341}
1342
Jiyong Parked180932023-02-24 19:55:41 +09001343/// Create the empty ramdump file
1344fn prepare_ramdump_file(temporary_directory: &Path) -> binder::Result<File> {
1345 // `ramdump_write` is sent to crosvm and will be the backing store for the /dev/hvc1 where
1346 // VM will emit ramdump to. `ramdump_read` will be sent back to the client (i.e. the VM
1347 // owner) for readout.
1348 let ramdump_path = temporary_directory.join("ramdump");
Jiyong Park2227eaa2023-08-04 11:59:18 +09001349 let ramdump = File::create(ramdump_path)
1350 .context("Failed to prepare ramdump file")
1351 .with_log()
1352 .or_service_specific_exception(-1)?;
Jiyong Parked180932023-02-24 19:55:41 +09001353 Ok(ramdump)
1354}
1355
Nikita Ioffe5776f082023-02-10 21:38:26 +00001356fn is_protected(config: &VirtualMachineConfig) -> bool {
1357 match config {
1358 VirtualMachineConfig::RawConfig(config) => config.protectedVm,
1359 VirtualMachineConfig::AppConfig(config) => config.protectedVm,
1360 }
1361}
1362
1363fn check_gdb_allowed(config: &VirtualMachineConfig) -> binder::Result<()> {
1364 if is_protected(config) {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001365 return Err(anyhow!("Can't use gdb with protected VMs"))
1366 .or_binder_exception(ExceptionCode::SECURITY);
Nikita Ioffe5776f082023-02-10 21:38:26 +00001367 }
1368
Pierre-Clément Tosid3bbe1d2024-04-15 18:03:51 +01001369 if get_debug_level(config) == Some(DebugLevel::NONE) {
1370 return Err(anyhow!("Can't use gdb with non-debuggable VMs"))
1371 .or_binder_exception(ExceptionCode::SECURITY);
Nikita Ioffe5776f082023-02-10 21:38:26 +00001372 }
Pierre-Clément Tosid3bbe1d2024-04-15 18:03:51 +01001373
1374 Ok(())
Nikita Ioffe5776f082023-02-10 21:38:26 +00001375}
1376
Shikha Panwar61a74b52024-02-16 13:17:01 +00001377fn extract_instance_id(config: &VirtualMachineConfig) -> [u8; 64] {
1378 match config {
1379 VirtualMachineConfig::RawConfig(config) => config.instanceId,
1380 VirtualMachineConfig::AppConfig(config) => config.instanceId,
1381 }
1382}
1383
Alan Stokesc96b35e2024-05-03 13:21:20 +01001384fn extract_want_updatable(config: &VirtualMachineConfig) -> bool {
1385 match config {
1386 VirtualMachineConfig::RawConfig(_) => true,
1387 VirtualMachineConfig::AppConfig(config) => {
1388 let Some(custom) = &config.customConfig else { return true };
1389 custom.wantUpdatable
1390 }
1391 }
1392}
1393
Nikita Ioffe5776f082023-02-10 21:38:26 +00001394fn extract_gdb_port(config: &VirtualMachineConfig) -> Option<NonZeroU16> {
1395 match config {
1396 VirtualMachineConfig::RawConfig(config) => NonZeroU16::new(config.gdbPort as u16),
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +01001397 VirtualMachineConfig::AppConfig(config) => {
1398 NonZeroU16::new(config.customConfig.as_ref().map(|c| c.gdbPort).unwrap_or(0) as u16)
1399 }
Nikita Ioffe5776f082023-02-10 21:38:26 +00001400 }
1401}
1402
Nikita Ioffe631717e2023-09-05 13:38:07 +01001403fn check_no_vendor_modules(config: &VirtualMachineConfig) -> binder::Result<()> {
1404 let VirtualMachineConfig::AppConfig(config) = config else { return Ok(()) };
1405 if let Some(custom_config) = &config.customConfig {
1406 if custom_config.vendorImage.is_some() || custom_config.customKernelImage.is_some() {
1407 return Err(anyhow!("vendor modules feature is disabled"))
1408 .or_binder_exception(ExceptionCode::UNSUPPORTED_OPERATION);
1409 }
1410 }
1411 Ok(())
1412}
1413
Nikita Ioffe94a8a182023-11-16 16:37:48 +00001414fn check_no_devices(config: &VirtualMachineConfig) -> binder::Result<()> {
1415 let VirtualMachineConfig::AppConfig(config) = config else { return Ok(()) };
1416 if let Some(custom_config) = &config.customConfig {
1417 if !custom_config.devices.is_empty() {
1418 return Err(anyhow!("device assignment feature is disabled"))
1419 .or_binder_exception(ExceptionCode::UNSUPPORTED_OPERATION);
1420 }
1421 }
1422 Ok(())
1423}
1424
Alan Stokesfda70842023-12-20 17:50:14 +00001425fn check_no_extra_apks(config: &VirtualMachineConfig) -> binder::Result<()> {
1426 let VirtualMachineConfig::AppConfig(config) = config else { return Ok(()) };
1427 let Payload::PayloadConfig(payload_config) = &config.payload else { return Ok(()) };
1428 if !payload_config.extraApks.is_empty() {
1429 return Err(anyhow!("multi-tenant feature is disabled"))
1430 .or_binder_exception(ExceptionCode::UNSUPPORTED_OPERATION);
1431 }
1432 Ok(())
1433}
1434
Nikita Ioffe631717e2023-09-05 13:38:07 +01001435fn check_config_features(config: &VirtualMachineConfig) -> binder::Result<()> {
1436 if !cfg!(vendor_modules) {
1437 check_no_vendor_modules(config)?;
1438 }
Nikita Ioffe94a8a182023-11-16 16:37:48 +00001439 if !cfg!(device_assignment) {
1440 check_no_devices(config)?;
1441 }
Alan Stokesfda70842023-12-20 17:50:14 +00001442 if !cfg!(multi_tenant) {
1443 check_no_extra_apks(config)?;
1444 }
Nikita Ioffe631717e2023-09-05 13:38:07 +01001445 Ok(())
1446}
1447
Inseob Kim0168b462022-12-27 14:54:35 +09001448fn clone_or_prepare_logger_fd(
Jaewan Kim61f86142023-03-28 15:12:52 +09001449 debug_config: &DebugConfig,
Inseob Kim0168b462022-12-27 14:54:35 +09001450 fd: Option<&ParcelFileDescriptor>,
1451 tag: String,
1452) -> Result<Option<File>, Status> {
1453 if let Some(fd) = fd {
1454 return Ok(Some(clone_file(fd)?));
1455 }
1456
Jaewan Kim61f86142023-03-28 15:12:52 +09001457 if !debug_config.should_prepare_console_output() {
Jaewan Kim66f062e2023-02-25 01:07:43 +09001458 return Ok(None);
1459 };
Inseob Kim0168b462022-12-27 14:54:35 +09001460
Frederick Maylefbbcfcd2024-04-08 16:31:54 -07001461 let (read_fd, write_fd) =
Jiyong Park2227eaa2023-08-04 11:59:18 +09001462 pipe().context("Failed to create pipe").or_service_specific_exception(-1)?;
Inseob Kim0168b462022-12-27 14:54:35 +09001463
Frederick Maylefbbcfcd2024-04-08 16:31:54 -07001464 let mut reader = BufReader::new(File::from(read_fd));
1465 let write_fd = File::from(write_fd);
Inseob Kim0168b462022-12-27 14:54:35 +09001466
1467 std::thread::spawn(move || loop {
1468 let mut buf = vec![];
1469 match reader.read_until(b'\n', &mut buf) {
1470 Ok(0) => {
1471 // EOF
1472 return;
1473 }
1474 Ok(size) => {
1475 if buf[size - 1] == b'\n' {
1476 buf.pop();
1477 }
1478 info!("{}: {}", &tag, &String::from_utf8_lossy(&buf));
1479 }
1480 Err(e) => {
1481 error!("Could not read console pipe: {:?}", e);
1482 return;
1483 }
1484 };
1485 });
1486
1487 Ok(Some(write_fd))
1488}
1489
Jooyung Han35edb8f2021-07-01 16:17:16 +09001490/// Simple utility for referencing Borrowed or Owned. Similar to std::borrow::Cow, but
1491/// it doesn't require that T implements Clone.
1492enum BorrowedOrOwned<'a, T> {
1493 Borrowed(&'a T),
1494 Owned(T),
1495}
1496
1497impl<'a, T> AsRef<T> for BorrowedOrOwned<'a, T> {
1498 fn as_ref(&self) -> &T {
1499 match self {
1500 Self::Borrowed(b) => b,
Chris Wailes68c39f82021-07-27 16:03:44 -07001501 Self::Owned(o) => o,
Jooyung Han35edb8f2021-07-01 16:17:16 +09001502 }
1503 }
1504}
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001505
1506/// Implementation of `IVirtualMachineService`, the entry point of the AIDL service.
1507#[derive(Debug, Default)]
1508struct VirtualMachineService {
1509 state: Arc<Mutex<State>>,
Inseob Kimc7d28c72021-10-25 14:28:10 +00001510 cid: Cid,
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001511}
1512
1513impl Interface for VirtualMachineService {}
1514
1515impl IVirtualMachineService for VirtualMachineService {
Inseob Kimc7d28c72021-10-25 14:28:10 +00001516 fn notifyPayloadStarted(&self) -> binder::Result<()> {
1517 let cid = self.cid;
Inseob Kim7f61fe72021-08-20 20:50:47 +09001518 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001519 info!("VM with CID {} started payload", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001520 vm.update_payload_state(PayloadState::Started)
1521 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
David Brazdil451cc962022-10-14 14:08:12 +01001522 vm.callbacks.notify_payload_started(cid);
Seungjae Yoo62085c02022-08-12 04:44:52 +00001523
Seungjae Yoo6d265d92022-11-15 10:51:33 +09001524 let vm_start_timestamp = vm.vm_metric.lock().unwrap().start_timestamp;
1525 write_vm_booted_stats(vm.requester_uid as i32, &vm.name, vm_start_timestamp);
Inseob Kim7f61fe72021-08-20 20:50:47 +09001526 Ok(())
1527 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001528 error!("notifyPayloadStarted is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001529 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001530 }
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001531 }
Inseob Kim2444af92021-08-31 01:22:50 +09001532
Inseob Kimc7d28c72021-10-25 14:28:10 +00001533 fn notifyPayloadReady(&self) -> binder::Result<()> {
1534 let cid = self.cid;
Inseob Kim14cb8692021-08-31 21:50:39 +09001535 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001536 info!("VM with CID {} reported payload is ready", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001537 vm.update_payload_state(PayloadState::Ready)
1538 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Inseob Kim14cb8692021-08-31 21:50:39 +09001539 vm.callbacks.notify_payload_ready(cid);
1540 Ok(())
1541 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001542 error!("notifyPayloadReady is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001543 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim14cb8692021-08-31 21:50:39 +09001544 }
1545 }
1546
Inseob Kimc7d28c72021-10-25 14:28:10 +00001547 fn notifyPayloadFinished(&self, exit_code: i32) -> binder::Result<()> {
1548 let cid = self.cid;
Inseob Kim2444af92021-08-31 01:22:50 +09001549 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001550 info!("VM with CID {} finished payload", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001551 vm.update_payload_state(PayloadState::Finished)
1552 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Inseob Kim2444af92021-08-31 01:22:50 +09001553 vm.callbacks.notify_payload_finished(cid, exit_code);
1554 Ok(())
1555 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001556 error!("notifyPayloadFinished is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001557 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Jooyung Handd0a1732021-11-23 15:26:20 +09001558 }
1559 }
1560
Alan Stokes2bead0d2022-09-05 16:58:34 +01001561 fn notifyError(&self, error_code: ErrorCode, message: &str) -> binder::Result<()> {
Jooyung Handd0a1732021-11-23 15:26:20 +09001562 let cid = self.cid;
1563 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001564 info!("VM with CID {} encountered an error", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001565 vm.update_payload_state(PayloadState::Finished)
1566 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Jooyung Handd0a1732021-11-23 15:26:20 +09001567 vm.callbacks.notify_error(cid, error_code, message);
1568 Ok(())
1569 } else {
Seungjae Yooec8c1602022-06-20 05:28:00 +00001570 error!("notifyError is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001571 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim2444af92021-08-31 01:22:50 +09001572 }
1573 }
Alice Wangc2fec932023-02-23 16:24:02 +00001574
Shikha Panware45e9422024-02-28 21:18:10 +00001575 fn getSecretkeeper(&self) -> binder::Result<Strong<dyn ISecretkeeper>> {
1576 if !is_secretkeeper_supported() {
1577 return Err(StatusCode::NAME_NOT_FOUND)?;
1578 }
1579 let sk = binder::wait_for_interface(SECRETKEEPER_IDENTIFIER)?;
1580 Ok(BnSecretkeeper::new_binder(SecretkeeperProxy(sk), BinderFeatures::default()))
Shikha Panwar5d6a6752023-12-14 22:08:26 +00001581 }
1582
Alice Wange64dd182024-01-17 15:57:55 +00001583 fn requestAttestation(&self, csr: &[u8], test_mode: bool) -> binder::Result<Vec<Certificate>> {
1584 GLOBAL_SERVICE.requestAttestation(csr, get_calling_uid() as i32, test_mode)
Alice Wangc2fec932023-02-23 16:24:02 +00001585 }
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001586}
1587
Shikha Panwar8707f0f2024-02-28 20:40:42 +00001588fn is_secretkeeper_supported() -> bool {
Shikha Panwar81d13d32024-03-10 19:39:23 +00001589 binder::is_declared(SECRETKEEPER_IDENTIFIER)
1590 .expect("Could not check for declared Secretkeeper interface")
Shikha Panwar8187ca22024-01-04 08:33:08 +00001591}
1592
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001593impl VirtualMachineService {
Inseob Kimc7d28c72021-10-25 14:28:10 +00001594 fn new_binder(state: Arc<Mutex<State>>, cid: Cid) -> Strong<dyn IVirtualMachineService> {
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001595 BnVirtualMachineService::new_binder(
Inseob Kimc7d28c72021-10-25 14:28:10 +00001596 VirtualMachineService { state, cid },
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001597 BinderFeatures::default(),
1598 )
1599 }
1600}
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001601
Stephen Hines4c1e2fc2024-02-09 16:34:47 -08001602struct SecretkeeperProxy(Strong<dyn ISecretkeeper>);
1603
1604impl Interface for SecretkeeperProxy {}
1605
1606impl ISecretkeeper for SecretkeeperProxy {
1607 fn processSecretManagementRequest(&self, req: &[u8]) -> binder::Result<Vec<u8>> {
1608 // Pass the request to the channel, and read the response.
1609 self.0.processSecretManagementRequest(req)
1610 }
1611
1612 fn getAuthGraphKe(&self) -> binder::Result<Strong<dyn IAuthGraphKeyExchange>> {
1613 let ag = AuthGraphKeyExchangeProxy(self.0.getAuthGraphKe()?);
1614 Ok(BnAuthGraphKeyExchange::new_binder(ag, BinderFeatures::default()))
1615 }
1616
1617 fn deleteIds(&self, ids: &[SecretId]) -> binder::Result<()> {
1618 self.0.deleteIds(ids)
1619 }
1620
1621 fn deleteAll(&self) -> binder::Result<()> {
1622 self.0.deleteAll()
1623 }
1624}
1625
1626struct AuthGraphKeyExchangeProxy(Strong<dyn IAuthGraphKeyExchange>);
1627
1628impl Interface for AuthGraphKeyExchangeProxy {}
1629
1630impl IAuthGraphKeyExchange for AuthGraphKeyExchangeProxy {
1631 fn create(&self) -> binder::Result<SessionInitiationInfo> {
1632 self.0.create()
1633 }
1634
1635 fn init(
1636 &self,
1637 peer_pub_key: &PubKey,
1638 peer_id: &Identity,
1639 peer_nonce: &[u8],
1640 peer_version: i32,
1641 ) -> binder::Result<KeInitResult> {
1642 self.0.init(peer_pub_key, peer_id, peer_nonce, peer_version)
1643 }
1644
1645 fn finish(
1646 &self,
1647 peer_pub_key: &PubKey,
1648 peer_id: &Identity,
1649 peer_signature: &SessionIdSignature,
1650 peer_nonce: &[u8],
1651 peer_version: i32,
1652 own_key: &Key,
1653 ) -> binder::Result<SessionInfo> {
1654 self.0.finish(peer_pub_key, peer_id, peer_signature, peer_nonce, peer_version, own_key)
1655 }
1656
1657 fn authenticationComplete(
1658 &self,
1659 peer_signature: &SessionIdSignature,
1660 shared_keys: &[AuthgraphArc; 2],
1661 ) -> binder::Result<[AuthgraphArc; 2]> {
1662 self.0.authenticationComplete(peer_signature, shared_keys)
1663 }
1664}
1665
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001666#[cfg(test)]
1667mod tests {
1668 use super::*;
1669
1670 #[test]
1671 fn test_is_allowed_label_for_partition() -> Result<()> {
1672 let expected_results = vec![
1673 ("u:object_r:system_file:s0", true),
1674 ("u:object_r:apk_data_file:s0", true),
1675 ("u:object_r:app_data_file:s0", false),
1676 ("u:object_r:app_data_file:s0:c512,c768", false),
1677 ("u:object_r:privapp_data_file:s0:c512,c768", false),
1678 ("invalid", false),
1679 ("user:role:apk_data_file:severity:categories", true),
1680 ("user:role:apk_data_file:severity:categories:extraneous", false),
1681 ];
1682
1683 for (label, expected_valid) in expected_results {
1684 let context = SeContext::new(label)?;
1685 let result = check_label_is_allowed(&context);
1686 if expected_valid {
1687 assert!(result.is_ok(), "Expected label {} to be allowed, got {:?}", label, result);
1688 } else if result.is_ok() {
1689 bail!("Expected label {} to be disallowed", label);
1690 }
1691 }
1692 Ok(())
1693 }
Nikita Ioffef1ce9872022-12-09 13:31:59 +00001694
1695 #[test]
1696 fn test_create_or_update_idsig_file_empty_apk() -> Result<()> {
1697 let apk = tempfile::tempfile().unwrap();
1698 let idsig = tempfile::tempfile().unwrap();
1699
1700 let ret = create_or_update_idsig_file(
1701 &ParcelFileDescriptor::new(apk),
1702 &ParcelFileDescriptor::new(idsig),
1703 );
1704 assert!(ret.is_err(), "should fail");
1705 Ok(())
1706 }
1707
1708 #[test]
1709 fn test_create_or_update_idsig_dir_instead_of_file_for_apk() -> Result<()> {
1710 let tmp_dir = tempfile::TempDir::new().unwrap();
1711 let apk = File::open(tmp_dir.path()).unwrap();
1712 let idsig = tempfile::tempfile().unwrap();
1713
1714 let ret = create_or_update_idsig_file(
1715 &ParcelFileDescriptor::new(apk),
1716 &ParcelFileDescriptor::new(idsig),
1717 );
1718 assert!(ret.is_err(), "should fail");
1719 Ok(())
1720 }
1721
1722 /// Verifies that create_or_update_idsig_file won't oom if a fd that corresponds to a directory
1723 /// on ext4 filesystem is passed.
1724 /// On ext4 lseek on a directory fd will return (off_t)-1 (see:
1725 /// https://bugzilla.kernel.org/show_bug.cgi?id=200043), which will result in
1726 /// create_or_update_idsig_file ooming while attempting to allocate petabytes of memory.
1727 #[test]
1728 fn test_create_or_update_idsig_does_not_crash_dir_on_ext4() -> Result<()> {
1729 // APEXes are backed by the ext4.
1730 let apk = File::open("/apex/com.android.virt/").unwrap();
1731 let idsig = tempfile::tempfile().unwrap();
1732
1733 let ret = create_or_update_idsig_file(
1734 &ParcelFileDescriptor::new(apk),
1735 &ParcelFileDescriptor::new(idsig),
1736 );
1737 assert!(ret.is_err(), "should fail");
1738 Ok(())
1739 }
Jiyong Park8d192952023-06-26 14:29:51 +09001740
1741 #[test]
1742 fn test_create_or_update_idsig_does_not_update_if_already_valid() -> Result<()> {
1743 use std::io::Seek;
1744
1745 // Pick any APK
1746 let mut apk = File::open("/system/priv-app/Shell/Shell.apk").unwrap();
1747 let mut idsig = tempfile::tempfile().unwrap();
1748
1749 create_or_update_idsig_file(
1750 &ParcelFileDescriptor::new(apk.try_clone()?),
1751 &ParcelFileDescriptor::new(idsig.try_clone()?),
1752 )?;
1753 let modified_orig = idsig.metadata()?.modified()?;
1754 apk.rewind()?;
1755 idsig.rewind()?;
1756
1757 // Call the function again
1758 create_or_update_idsig_file(
1759 &ParcelFileDescriptor::new(apk.try_clone()?),
1760 &ParcelFileDescriptor::new(idsig.try_clone()?),
1761 )?;
1762 let modified_new = idsig.metadata()?.modified()?;
1763 assert!(modified_orig == modified_new, "idsig file was updated unnecessarily");
1764 Ok(())
1765 }
Nikita Ioffeaa6858c2023-07-04 01:37:41 +01001766
1767 #[test]
Shikha Panwar9ae2e622024-01-30 12:22:30 +00001768 fn test_create_or_update_idsig_on_non_empty_file() -> Result<()> {
1769 use std::io::Read;
1770
1771 // Pick any APK
1772 let mut apk = File::open("/system/priv-app/Shell/Shell.apk").unwrap();
1773 let idsig_empty = tempfile::tempfile().unwrap();
1774 let mut idsig_invalid = tempfile::tempfile().unwrap();
1775 idsig_invalid.write_all(b"Oops")?;
1776
1777 // Create new idsig
1778 create_or_update_idsig_file(
1779 &ParcelFileDescriptor::new(apk.try_clone()?),
1780 &ParcelFileDescriptor::new(idsig_empty.try_clone()?),
1781 )?;
1782 apk.rewind()?;
1783
1784 // Update idsig_invalid
1785 create_or_update_idsig_file(
1786 &ParcelFileDescriptor::new(apk.try_clone()?),
1787 &ParcelFileDescriptor::new(idsig_invalid.try_clone()?),
1788 )?;
1789
1790 // Ensure the 2 idsig files have same size!
1791 assert!(
1792 idsig_empty.metadata()?.len() == idsig_invalid.metadata()?.len(),
1793 "idsig files differ in size"
1794 );
1795 // Ensure the 2 idsig files have same content!
1796 for (b1, b2) in idsig_empty.bytes().zip(idsig_invalid.bytes()) {
1797 assert!(b1.unwrap() == b2.unwrap(), "idsig files differ")
1798 }
1799 Ok(())
1800 }
1801 #[test]
Nikita Ioffeaa6858c2023-07-04 01:37:41 +01001802 fn test_append_kernel_param_first_param() {
1803 let mut vm_config = VirtualMachineRawConfig { ..Default::default() };
1804 append_kernel_param("foo=1", &mut vm_config);
1805 assert_eq!(vm_config.params, Some("foo=1".to_owned()))
1806 }
1807
1808 #[test]
1809 fn test_append_kernel_param() {
1810 let mut vm_config =
1811 VirtualMachineRawConfig { params: Some("foo=5".to_owned()), ..Default::default() };
1812 append_kernel_param("bar=42", &mut vm_config);
1813 assert_eq!(vm_config.params, Some("foo=5 bar=42".to_owned()))
1814 }
Seungjae Yooec3bc522023-11-09 10:14:30 +09001815
Inseob Kim46257382024-01-03 15:41:22 +09001816 fn test_extract_os_name_from_config_path(
1817 path: &Path,
1818 expected_result: Option<&str>,
1819 ) -> Result<()> {
1820 let result = extract_os_name_from_config_path(path);
1821 if result.as_deref() != expected_result {
1822 bail!("Expected {:?} but was {:?}", expected_result, &result)
1823 }
1824 Ok(())
1825 }
1826
1827 #[test]
1828 fn test_extract_os_name_from_microdroid_config() -> Result<()> {
1829 test_extract_os_name_from_config_path(
1830 Path::new("/apex/com.android.virt/etc/microdroid.json"),
1831 Some("microdroid"),
1832 )
1833 }
1834
1835 #[test]
1836 fn test_extract_os_name_from_microdroid_gki_config() -> Result<()> {
1837 test_extract_os_name_from_config_path(
1838 Path::new("/apex/com.android.virt/etc/microdroid_gki-android14-6.1.json"),
1839 Some("microdroid_gki-android14-6.1"),
1840 )
1841 }
1842
1843 #[test]
1844 fn test_extract_os_name_from_invalid_path() -> Result<()> {
1845 test_extract_os_name_from_config_path(
1846 Path::new("/apex/com.android.virt/etc/microdroid.img"),
1847 None,
1848 )
1849 }
1850
1851 #[test]
1852 fn test_extract_os_name_from_configs() -> Result<()> {
1853 let tmp_dir = tempfile::TempDir::new()?;
1854 let tmp_dir_path = tmp_dir.path().to_owned();
1855
1856 let mut os_names: HashSet<String> = HashSet::new();
1857 os_names.insert("microdroid".to_owned());
1858 os_names.insert("microdroid_gki-android14-6.1".to_owned());
1859 os_names.insert("microdroid_gki-android15-6.1".to_owned());
1860
1861 // config files
1862 for os_name in &os_names {
1863 std::fs::write(tmp_dir_path.join(os_name.to_owned() + ".json"), b"")?;
1864 }
1865
1866 // fake files not related to configs
1867 std::fs::write(tmp_dir_path.join("microdroid_super.img"), b"")?;
1868 std::fs::write(tmp_dir_path.join("microdroid_foobar.apk"), b"")?;
1869
1870 let glob_pattern = match tmp_dir_path.join("microdroid*.json").to_str() {
1871 Some(s) => s.to_owned(),
1872 None => bail!("tmp_dir_path {:?} is not UTF-8", tmp_dir_path),
1873 };
1874
1875 let result = extract_os_names_from_configs(&glob_pattern)?;
1876 if result != os_names {
1877 bail!("Expected {:?} but was {:?}", os_names, result);
1878 }
1879 Ok(())
1880 }
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001881}