blob: 279b4ece5c1d5d8870bb58d103b41a782e4a81c1 [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 Cha1df1c032024-04-03 16:03:12 +090020use crate::crosvm::{CrosvmConfig, DiskFile, DisplayConfig, 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,
Alan Stokes0cc59ee2021-09-24 11:20:34 +010035 IVirtualMachine::{BnVirtualMachine, IVirtualMachine},
Andrew Walbran6b650662021-09-07 13:13:23 +000036 IVirtualMachineCallback::IVirtualMachineCallback,
37 IVirtualizationService::IVirtualizationService,
Keir Frasercdd4b112022-11-24 14:02:25 +000038 MemoryTrimLevel::MemoryTrimLevel,
Jiyong Park029977d2021-11-24 21:56:49 +090039 Partition::Partition,
Andrew Walbran6b650662021-09-07 13:13:23 +000040 PartitionType::PartitionType,
Inseob Kim0168b462022-12-27 14:54:35 +090041 VirtualMachineAppConfig::{DebugLevel::DebugLevel, Payload::Payload, VirtualMachineAppConfig},
Jooyung Han21e9b922021-06-26 04:14:16 +090042 VirtualMachineConfig::VirtualMachineConfig,
Andrew Walbran6b650662021-09-07 13:13:23 +000043 VirtualMachineDebugInfo::VirtualMachineDebugInfo,
Alan Stokes0d1ef782022-09-27 13:46:35 +010044 VirtualMachinePayloadConfig::VirtualMachinePayloadConfig,
Jooyung Han21e9b922021-06-26 04:14:16 +090045 VirtualMachineRawConfig::VirtualMachineRawConfig,
Andrew Walbran6b650662021-09-07 13:13:23 +000046 VirtualMachineState::VirtualMachineState,
Jooyung Han21e9b922021-06-26 04:14:16 +090047};
David Brazdilafc9a9e2023-01-12 16:08:10 +000048use android_system_virtualizationservice_internal::aidl::android::system::virtualizationservice_internal::IVirtualizationServiceInternal::IVirtualizationServiceInternal;
Seungjae Yoodd91f0f2022-11-09 15:25:21 +090049use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::{
David Brazdilafc9a9e2023-01-12 16:08:10 +000050 BnVirtualMachineService, IVirtualMachineService,
Seungjae Yoofd9a0622022-10-14 10:01:29 +090051};
Shikha Panware45e9422024-02-28 21:18:10 +000052use android_hardware_security_secretkeeper::aidl::android::hardware::security::secretkeeper::ISecretkeeper::{BnSecretkeeper, ISecretkeeper};
Shikha Panwar5d6a6752023-12-14 22:08:26 +000053use android_hardware_security_secretkeeper::aidl::android::hardware::security::secretkeeper::SecretId::SecretId;
54use android_hardware_security_authgraph::aidl::android::hardware::security::authgraph::{
55 Arc::Arc as AuthgraphArc, IAuthGraphKeyExchange::IAuthGraphKeyExchange,
56 IAuthGraphKeyExchange::BnAuthGraphKeyExchange, Identity::Identity, KeInitResult::KeInitResult,
57 Key::Key, PubKey::PubKey, SessionIdSignature::SessionIdSignature, SessionInfo::SessionInfo,
58 SessionInitiationInfo::SessionInitiationInfo,
59};
Alan Stokes25f69362023-03-06 16:51:54 +000060use anyhow::{anyhow, bail, Context, Result};
Seungjae Yoofd9a0622022-10-14 10:01:29 +090061use apkverify::{HashAlgorithm, V4Signature};
Jiyong Parkd7bd2f22023-08-10 20:41:19 +090062use avflog::LogResult;
Alan Stokes0e82b502022-08-08 14:44:48 +010063use binder::{
David Brazdilafc9a9e2023-01-12 16:08:10 +000064 self, wait_for_interface, BinderFeatures, ExceptionCode, Interface, ParcelFileDescriptor,
65 Status, StatusCode, Strong,
Jiyong Park2227eaa2023-08-04 11:59:18 +090066 IntoBinderResult,
Andrew Walbrana89fc132021-03-17 17:08:36 +000067};
Shikha Panwar55e10ec2024-02-13 12:53:49 +000068use cstr::cstr;
David Brazdilf50c7a62023-04-19 14:22:42 +000069use disk::QcowFile;
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;
Andrew Walbrancc0db522021-07-12 17:03:42 +000091use vmconfig::VmConfig;
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)?;
Shikha Panwar9ae2e622024-01-30 12:22:30 +0000258
Jiyong Park2227eaa2023-08-04 11:59:18 +0900259 let mut part = QcowFile::new(image, size_bytes)
260 .context("Failed to create QCOW2 image")
261 .or_service_specific_exception(-1)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000262
263 match partition_type {
264 PartitionType::RAW => Ok(()),
265 PartitionType::ANDROID_VM_INSTANCE => format_as_android_vm_instance(&mut part),
266 PartitionType::ENCRYPTEDSTORE => format_as_encryptedstore(&mut part),
267 _ => Err(Error::new(
268 ErrorKind::Unsupported,
269 format!("Unsupported partition type {:?}", partition_type),
270 )),
271 }
Jiyong Park2227eaa2023-08-04 11:59:18 +0900272 .with_context(|| format!("Failed to initialize partition as {:?}", partition_type))
273 .or_service_specific_exception(-1)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000274
275 Ok(())
Andrew Walbrandff3b942021-06-09 15:20:36 +0000276 }
277
Jiyong Park0a248432021-08-20 23:32:39 +0900278 /// Creates or update the idsig file by digesting the input APK file.
279 fn createOrUpdateIdsigFile(
280 &self,
281 input_fd: &ParcelFileDescriptor,
282 idsig_fd: &ParcelFileDescriptor,
283 ) -> binder::Result<()> {
Jiyong Parkc3ca24f2022-06-28 10:45:15 +0900284 check_manage_access()?;
285
Jiyong Park2227eaa2023-08-04 11:59:18 +0900286 create_or_update_idsig_file(input_fd, idsig_fd).or_service_specific_exception(-1)?;
Jiyong Park0a248432021-08-20 23:32:39 +0900287 Ok(())
288 }
289
Andrew Walbran320b5602021-03-04 16:11:12 +0000290 /// Get a list of all currently running VMs. This method is only intended for debug purposes,
291 /// and as such is only permitted from the shell user.
292 fn debugListVms(&self) -> binder::Result<Vec<VirtualMachineDebugInfo>> {
David Brazdil209074a2023-01-12 16:44:51 +0000293 // Delegate to the global service, including checking the debug permission.
David Brazdild4f51a52023-01-11 14:09:27 +0000294 GLOBAL_SERVICE.debugListVms()
Andrew Walbran320b5602021-03-04 16:11:12 +0000295 }
Inseob Kim53d0b212023-07-20 16:58:37 +0900296
297 /// Get a list of assignable device types.
298 fn getAssignableDevices(&self) -> binder::Result<Vec<AssignableDevice>> {
299 // Delegate to the global service, including checking the permission.
300 GLOBAL_SERVICE.getAssignableDevices()
301 }
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100302
Inseob Kim46257382024-01-03 15:41:22 +0900303 /// Get a list of supported OSes.
304 fn getSupportedOSList(&self) -> binder::Result<Vec<String>> {
305 Ok(Vec::from_iter(SUPPORTED_OS_NAMES.iter().cloned()))
306 }
307
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100308 /// Returns whether given feature is enabled
309 fn isFeatureEnabled(&self, feature: &str) -> binder::Result<bool> {
310 check_manage_access()?;
Shikha Panwar6d306412024-02-17 21:37:49 +0000311 Ok(avf_features::is_feature_enabled(feature))
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100312 }
Alice Wange64dd182024-01-17 15:57:55 +0000313
314 fn enableTestAttestation(&self) -> binder::Result<()> {
315 GLOBAL_SERVICE.enableTestAttestation()
316 }
Alice Wang0362f7f2024-03-21 08:16:26 +0000317
318 fn isRemoteAttestationSupported(&self) -> binder::Result<bool> {
319 check_manage_access()?;
320 GLOBAL_SERVICE.isRemoteAttestationSupported()
321 }
Shikha Panwar7aef66d2024-03-13 00:28:41 +0000322
323 fn isUpdatableVmSupported(&self) -> binder::Result<bool> {
324 // The response is specific to Microdroid. Updatable VMs are only possible if device
325 // supports Secretkeeper. Guest OS needs to use Secretkeeper based secrets. Microdroid does
326 // this, however other guest OSes may do things differently.
327 check_manage_access()?;
328 Ok(is_secretkeeper_supported())
329 }
Shikha Panwarbd5eba92024-03-27 20:23:31 +0000330
Shikha Panwar07d701c2024-03-28 14:43:52 +0000331 fn removeVmInstance(&self, instance_id: &[u8; 64]) -> binder::Result<()> {
332 check_manage_access()?;
333 GLOBAL_SERVICE.removeVmInstance(instance_id)
334 }
335
Shikha Panwarbd5eba92024-03-27 20:23:31 +0000336 fn claimVmInstance(&self, instance_id: &[u8; 64]) -> binder::Result<()> {
337 check_manage_access()?;
338 GLOBAL_SERVICE.claimVmInstance(instance_id)
339 }
Andrew Walbran320b5602021-03-04 16:11:12 +0000340}
341
Jiyong Park8611a6c2021-07-09 18:17:44 +0900342impl VirtualizationService {
343 pub fn init() -> VirtualizationService {
David Brazdil49f96f52022-12-16 21:29:13 +0000344 VirtualizationService::default()
Jiyong Park8611a6c2021-07-09 18:17:44 +0900345 }
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000346
David Brazdil209074a2023-01-12 16:44:51 +0000347 fn create_vm_context(
348 &self,
349 requester_debug_pid: pid_t,
350 ) -> binder::Result<(VmContext, Cid, PathBuf)> {
David Brazdil8cf8f482022-11-23 14:21:26 +0000351 const NUM_ATTEMPTS: usize = 5;
352
353 for _ in 0..NUM_ATTEMPTS {
Charisee96113f32023-01-26 09:00:42 +0000354 let vm_context = GLOBAL_SERVICE.allocateGlobalVmContext(requester_debug_pid)?;
David Brazdild4f51a52023-01-11 14:09:27 +0000355 let cid = vm_context.getCid()? as Cid;
356 let temp_dir: PathBuf = vm_context.getTemporaryDirectory()?.into();
David Brazdil8cf8f482022-11-23 14:21:26 +0000357 let service = VirtualMachineService::new_binder(self.state.clone(), cid).as_binder();
358
359 // Start VM service listening for connections from the new CID on port=CID.
David Brazdil8cf8f482022-11-23 14:21:26 +0000360 let port = cid;
David Brazdil3238da42022-11-18 10:04:51 +0000361 match RpcServer::new_vsock(service, cid, port) {
David Brazdil8cf8f482022-11-23 14:21:26 +0000362 Ok(vm_server) => {
363 vm_server.start();
David Brazdild4f51a52023-01-11 14:09:27 +0000364 return Ok((VmContext::new(vm_context, vm_server), cid, temp_dir));
David Brazdil8cf8f482022-11-23 14:21:26 +0000365 }
366 Err(err) => {
367 warn!("Could not start RpcServer on port {}: {}", port, err);
368 }
369 }
370 }
Jiyong Park2227eaa2023-08-04 11:59:18 +0900371 Err(anyhow!("Too many attempts to create VM context failed"))
372 .or_service_specific_exception(-1)
David Brazdil8cf8f482022-11-23 14:21:26 +0000373 }
374
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000375 fn create_vm_internal(
376 &self,
377 config: &VirtualMachineConfig,
Jiyong Parke6fb1672023-06-26 16:45:55 +0900378 console_out_fd: Option<&ParcelFileDescriptor>,
379 console_in_fd: Option<&ParcelFileDescriptor>,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000380 log_fd: Option<&ParcelFileDescriptor>,
381 is_protected: &mut bool,
382 ) -> binder::Result<Strong<dyn IVirtualMachine>> {
David Brazdil209074a2023-01-12 16:44:51 +0000383 let requester_uid = get_calling_uid();
384 let requester_debug_pid = get_calling_pid();
385
Nikita Ioffe631717e2023-09-05 13:38:07 +0100386 check_config_features(config)?;
387
David Brazdil209074a2023-01-12 16:44:51 +0000388 // Allocating VM context checks the MANAGE_VIRTUAL_MACHINE permission.
389 let (vm_context, cid, temporary_directory) = self.create_vm_context(requester_debug_pid)?;
Inseob Kim1119d702022-05-02 18:01:58 +0900390
Alan Stokesfda70842023-12-20 17:50:14 +0000391 if is_custom_config(config) {
Alan Stokes7bc146c2022-10-20 17:10:32 +0100392 check_use_custom_virtual_machine()?;
Inseob Kim1119d702022-05-02 18:01:58 +0900393 }
394
Nikita Ioffe5776f082023-02-10 21:38:26 +0000395 let gdb_port = extract_gdb_port(config);
396
397 // Additional permission checks if caller request gdb.
398 if gdb_port.is_some() {
399 check_gdb_allowed(config)?;
400 }
401
Shikha Panwar8707f0f2024-02-28 20:40:42 +0000402 // Currently, VirtMgr adds the host copy of reference DT & untrusted properties
403 // (e.g. instance-id)
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000404 let host_ref_dt = Path::new(VM_REFERENCE_DT_ON_HOST_PATH);
405 let host_ref_dt = if host_ref_dt.exists()
406 && read_dir(host_ref_dt).or_service_specific_exception(-1)?.next().is_some()
407 {
408 Some(host_ref_dt)
409 } else {
410 warn!("VM reference DT doesn't exist in host DT");
411 None
412 };
413
Seungjae Yoo14e60182024-02-21 13:28:31 +0900414 let vendor_hashtree_digest = extract_vendor_hashtree_digest(config)
415 .context("Failed to extract vendor hashtree digest")
416 .or_service_specific_exception(-1)?;
417
418 let trusted_props = if let Some(ref vendor_hashtree_digest) = vendor_hashtree_digest {
419 info!(
420 "Passing vendor hashtree digest to pvmfw. This will be rejected if it doesn't \
421 match the trusted digest in the pvmfw config, causing the VM to fail to start."
422 );
423 vec![(
424 cstr!("vendor_hashtree_descriptor_root_digest"),
425 vendor_hashtree_digest.as_slice(),
426 )]
427 } else {
428 vec![]
429 };
430
Shikha Panwar61a74b52024-02-16 13:17:01 +0000431 let instance_id;
Shikha Panwar8707f0f2024-02-28 20:40:42 +0000432 let mut untrusted_props = Vec::with_capacity(2);
433 if cfg!(llpvm_changes) {
Shikha Panwar61a74b52024-02-16 13:17:01 +0000434 instance_id = extract_instance_id(config);
Shikha Panwar8707f0f2024-02-28 20:40:42 +0000435 untrusted_props.push((cstr!("instance-id"), &instance_id[..]));
436 if is_secretkeeper_supported() {
437 // Let guest know that it can defer rollback protection to Secretkeeper by setting
438 // an empty property in untrusted node in DT. This enables Updatable VMs.
439 untrusted_props.push((cstr!("defer-rollback-protection"), &[]))
440 }
441 }
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000442
Seungjae Yoo14e60182024-02-21 13:28:31 +0900443 let device_tree_overlay =
444 if host_ref_dt.is_some() || !untrusted_props.is_empty() || !trusted_props.is_empty() {
445 let dt_output = temporary_directory.join(VM_DT_OVERLAY_PATH);
446 let mut data = [0_u8; VM_DT_OVERLAY_MAX_SIZE];
447 let fdt = create_device_tree_overlay(
448 &mut data,
449 host_ref_dt,
450 &untrusted_props,
451 &trusted_props,
452 )
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000453 .map_err(|e| anyhow!("Failed to create DT overlay, {e:?}"))
454 .or_service_specific_exception(-1)?;
Seungjae Yoo14e60182024-02-21 13:28:31 +0900455 fs::write(&dt_output, fdt.as_slice()).or_service_specific_exception(-1)?;
456 Some(File::open(dt_output).or_service_specific_exception(-1)?)
457 } else {
458 None
459 };
Seungjae Yooec3bc522023-11-09 10:14:30 +0900460
Jaewan Kimf3143242024-03-15 06:56:31 +0000461 let debug_config = DebugConfig::new(config);
Jaewan Kim61f86142023-03-28 15:12:52 +0900462
463 let ramdump = if debug_config.is_ramdump_needed() {
Jiyong Parked180932023-02-24 19:55:41 +0900464 Some(prepare_ramdump_file(&temporary_directory)?)
465 } else {
466 None
467 };
468
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000469 let state = &mut *self.state.lock().unwrap();
Jiyong Parke6fb1672023-06-26 16:45:55 +0900470 let console_out_fd =
471 clone_or_prepare_logger_fd(&debug_config, console_out_fd, format!("Console({})", cid))?;
472 let console_in_fd = console_in_fd.map(clone_file).transpose()?;
Jaewan Kim61f86142023-03-28 15:12:52 +0900473 let log_fd = clone_or_prepare_logger_fd(&debug_config, log_fd, format!("Log({})", cid))?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000474
475 // Counter to generate unique IDs for temporary image files.
476 let mut next_temporary_image_id = 0;
477 // Files which are referred to from composite images. These must be mapped to the crosvm
478 // child process, and not closed before it is started.
479 let mut indirect_files = vec![];
480
Alan Stokes7bc146c2022-10-20 17:10:32 +0100481 let (is_app_config, config) = match config {
482 VirtualMachineConfig::RawConfig(config) => (false, BorrowedOrOwned::Borrowed(config)),
483 VirtualMachineConfig::AppConfig(config) => {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900484 let config = load_app_config(config, &debug_config, &temporary_directory)
485 .or_service_specific_exception_with(-1, |e| {
Jaewan Kim61f86142023-03-28 15:12:52 +0900486 *is_protected = config.protectedVm;
487 let message = format!("Failed to load app config: {:?}", e);
488 error!("{}", message);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900489 message
Jaewan Kim61f86142023-03-28 15:12:52 +0900490 })?;
Alan Stokes7bc146c2022-10-20 17:10:32 +0100491 (true, BorrowedOrOwned::Owned(config))
492 }
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000493 };
494 let config = config.as_ref();
495 *is_protected = config.protectedVm;
496
497 // Check if partition images are labeled incorrectly. This is to prevent random images
498 // which are not protected by the Android Verified Boot (e.g. bits downloaded by apps) from
Alan Stokes3e5eec12023-09-07 12:10:00 +0100499 // being loaded in a pVM. This applies to everything but the instance image in the raw
500 // config, and everything but the non-executable, generated partitions in the app
501 // config.
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000502 config
503 .disks
504 .iter()
505 .flat_map(|disk| disk.partitions.iter())
506 .filter(|partition| {
507 if is_app_config {
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100508 !is_safe_app_partition(&partition.label)
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000509 } else {
Alice Wangc206b9b2023-08-28 14:13:51 +0000510 !is_safe_raw_partition(&partition.label)
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000511 }
512 })
513 .try_for_each(check_label_for_partition)
Jiyong Park2227eaa2023-08-04 11:59:18 +0900514 .or_service_specific_exception(-1)?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000515
Inseob Kimff48a7c2024-02-26 22:07:21 +0900516 // Check if files for payloads and bases are NOT coming from /vendor and /odm, as they may
517 // have unstable interfaces.
518 // TODO(b/316431494): remove once Treble interfaces are stabilized.
519 check_partitions_for_files(config).or_service_specific_exception(-1)?;
520
Alan Stokes185fe112023-01-10 16:20:55 +0000521 let kernel = maybe_clone_file(&config.kernel)?;
522 let initrd = maybe_clone_file(&config.initrd)?;
523
524 // In a protected VM, we require custom kernels to come from a trusted source (b/237054515).
525 if config.protectedVm {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900526 check_label_for_kernel_files(&kernel, &initrd).or_service_specific_exception(-1)?;
Alan Stokes185fe112023-01-10 16:20:55 +0000527 }
528
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000529 let zero_filler_path = temporary_directory.join("zero.img");
Jiyong Park2227eaa2023-08-04 11:59:18 +0900530 write_zero_filler(&zero_filler_path)
531 .context("Failed to make composite image")
532 .with_log()
533 .or_service_specific_exception(-1)?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000534
535 // Assemble disk images if needed.
536 let disks = config
537 .disks
538 .iter()
539 .map(|disk| {
540 assemble_disk_image(
541 disk,
542 &zero_filler_path,
543 &temporary_directory,
544 &mut next_temporary_image_id,
545 &mut indirect_files,
546 )
547 })
548 .collect::<Result<Vec<DiskFile>, _>>()?;
549
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000550 let (cpus, host_cpu_topology) = match config.cpuTopology {
551 CpuTopology::MATCH_HOST => (None, true),
552 CpuTopology::ONE_CPU => (NonZeroU32::new(1), false),
553 val => {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900554 return Err(anyhow!("Failed to parse CPU topology value {:?}", val))
555 .with_log()
556 .or_service_specific_exception(-1);
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000557 }
558 };
559
David Brazdil2dfefd12023-11-17 14:07:36 +0000560 let (vfio_devices, dtbo) = if !config.devices.is_empty() {
Inseob Kim6ef80972023-07-20 17:23:36 +0900561 let mut set = HashSet::new();
562 for device in config.devices.iter() {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900563 let path = canonicalize(device)
564 .with_context(|| format!("can't canonicalize {device}"))
565 .or_service_specific_exception(-1)?;
Inseob Kim6ef80972023-07-20 17:23:36 +0900566 if !set.insert(path) {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900567 return Err(anyhow!("duplicated device {device}"))
568 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Inseob Kim6ef80972023-07-20 17:23:36 +0900569 }
570 }
Jakob Vukalovicd42aa2c2023-11-09 16:04:00 +0000571 let devices = GLOBAL_SERVICE.bindDevicesToVfioDriver(&config.devices)?;
David Brazdil2dfefd12023-11-17 14:07:36 +0000572 let dtbo_file = File::from(
573 GLOBAL_SERVICE
574 .getDtboFile()?
575 .as_ref()
576 .try_clone()
Jaewan Kim39952072024-01-19 17:04:53 +0900577 .context("Failed to create VM DTBO from ParcelFileDescriptor")
David Brazdil2dfefd12023-11-17 14:07:36 +0000578 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)?,
579 );
580 (devices, Some(dtbo_file))
Inseob Kim7307a892023-09-14 13:37:58 +0900581 } else {
David Brazdil2dfefd12023-11-17 14:07:36 +0000582 (vec![], None)
Inseob Kim7307a892023-09-14 13:37:58 +0900583 };
Inseob Kim6ef80972023-07-20 17:23:36 +0900584
Jeongik Cha1df1c032024-04-03 16:03:12 +0900585 let display_config = config
586 .displayConfig
587 .as_ref()
588 .map(DisplayConfig::new)
589 .transpose()
590 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT)?;
591
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000592 // Actually start the VM.
593 let crosvm_config = CrosvmConfig {
594 cid,
Seungjae Yoo62085c02022-08-12 04:44:52 +0000595 name: config.name.clone(),
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000596 bootloader: maybe_clone_file(&config.bootloader)?,
Alan Stokes185fe112023-01-10 16:20:55 +0000597 kernel,
598 initrd,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000599 disks,
600 params: config.params.to_owned(),
601 protected: *is_protected,
Jaewan Kim61f86142023-03-28 15:12:52 +0900602 debug_config,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000603 memory_mib: config.memoryMib.try_into().ok().and_then(NonZeroU32::new),
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000604 cpus,
605 host_cpu_topology,
Jiyong Parke6fb1672023-06-26 16:45:55 +0900606 console_out_fd,
607 console_in_fd,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000608 log_fd,
Jiyong Parked180932023-02-24 19:55:41 +0900609 ramdump,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000610 indirect_files,
611 platform_version: parse_platform_version_req(&config.platformVersion)?,
Jiyong Parke6ed0f92022-06-22 00:13:00 +0900612 detect_hangup: is_app_config,
Nikita Ioffe5776f082023-02-10 21:38:26 +0000613 gdb_port,
Inseob Kim7307a892023-09-14 13:37:58 +0900614 vfio_devices,
David Brazdil2dfefd12023-11-17 14:07:36 +0000615 dtbo,
Shikha Panwar55e10ec2024-02-13 12:53:49 +0000616 device_tree_overlay,
Jeongik Cha1df1c032024-04-03 16:03:12 +0900617 display_config,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000618 };
619 let instance = Arc::new(
David Brazdil528e0472022-10-10 15:06:02 +0100620 VmInstance::new(
621 crosvm_config,
622 temporary_directory,
623 requester_uid,
624 requester_debug_pid,
625 vm_context,
626 )
Jiyong Park2227eaa2023-08-04 11:59:18 +0900627 .with_context(|| format!("Failed to create VM with config {:?}", config))
628 .with_log()
629 .or_service_specific_exception(-1)?,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000630 );
631 state.add_vm(Arc::downgrade(&instance));
632 Ok(VirtualMachine::create(instance))
633 }
Jiyong Park8611a6c2021-07-09 18:17:44 +0900634}
635
Alan Stokesfda70842023-12-20 17:50:14 +0000636/// Returns whether a VM config represents a "custom" virtual machine, which requires the
637/// USE_CUSTOM_VIRTUAL_MACHINE.
638fn is_custom_config(config: &VirtualMachineConfig) -> bool {
639 match config {
640 // Any raw (non-Microdroid) VM is considered custom.
641 VirtualMachineConfig::RawConfig(_) => true,
642 VirtualMachineConfig::AppConfig(config) => {
643 // Some features are reserved for platform apps only, even when using
644 // VirtualMachineAppConfig. Almost all of these features are grouped in the
645 // CustomConfig struct:
646 // - controlling CPUs;
647 // - gdbPort is set, meaning that crosvm will start a gdb server;
648 // - using anything other than the default kernel;
649 // - specifying devices to be assigned.
650 if config.customConfig.is_some() {
651 true
652 } else {
653 // Additional custom features not included in CustomConfig:
654 // - specifying a config file;
Alan Stokes736f6822024-02-16 16:08:00 +0000655 // - specifying extra APKs;
656 // - specifying an OS other than Microdroid.
Inseob Kim89b24592024-02-23 18:59:43 +0900657 (match &config.payload {
Alan Stokesfda70842023-12-20 17:50:14 +0000658 Payload::ConfigPath(_) => true,
Inseob Kim89b24592024-02-23 18:59:43 +0900659 Payload::PayloadConfig(payload_config) => !payload_config.extraApks.is_empty(),
660 }) || config.osName != MICRODROID_OS_NAME
Alan Stokesfda70842023-12-20 17:50:14 +0000661 }
662 }
663 }
664}
665
Seungjae Yoo14e60182024-02-21 13:28:31 +0900666fn extract_vendor_hashtree_digest(config: &VirtualMachineConfig) -> Result<Option<Vec<u8>>> {
667 let VirtualMachineConfig::AppConfig(config) = config else {
668 return Ok(None);
669 };
670 let Some(custom_config) = &config.customConfig else {
671 return Ok(None);
672 };
673 let Some(file) = custom_config.vendorImage.as_ref() else {
674 return Ok(None);
675 };
676
677 let file = clone_file(file)?;
678 let size =
679 file.metadata().context("Failed to get metadata from microdroid vendor image")?.len();
680 let vbmeta = VbMetaImage::verify_reader_region(&file, 0, size)
681 .context("Failed to get vbmeta from microdroid-vendor.img")?;
682
683 for descriptor in vbmeta.descriptors()?.iter() {
684 if let vbmeta::Descriptor::Hashtree(_) = descriptor {
685 let root_digest = hex::encode(descriptor.to_hashtree()?.root_digest());
686 return Ok(Some(root_digest.as_bytes().to_vec()));
687 }
688 }
689 Err(anyhow!("No hashtree digest is extracted from microdroid vendor image"))
690}
691
Andrew Walbranfbb39d22021-07-28 17:01:25 +0000692fn write_zero_filler(zero_filler_path: &Path) -> Result<()> {
Jooyung Han95884632021-07-06 22:27:54 +0900693 let file = OpenOptions::new()
694 .create_new(true)
695 .read(true)
696 .write(true)
697 .open(zero_filler_path)
698 .with_context(|| "Failed to create zero.img")?;
699 file.set_len(ZERO_FILLER_SIZE)?;
Andrew Walbranfbb39d22021-07-28 17:01:25 +0000700 Ok(())
Jooyung Han95884632021-07-06 22:27:54 +0900701}
702
David Brazdilf50c7a62023-04-19 14:22:42 +0000703fn format_as_android_vm_instance(part: &mut dyn Write) -> std::io::Result<()> {
704 part.write_all(ANDROID_VM_INSTANCE_MAGIC.as_bytes())?;
705 part.write_all(&ANDROID_VM_INSTANCE_VERSION.to_le_bytes())?;
706 part.flush()
707}
708
709fn format_as_encryptedstore(part: &mut dyn Write) -> std::io::Result<()> {
710 part.write_all(UNFORMATTED_STORAGE_MAGIC.as_bytes())?;
711 part.flush()
712}
713
714fn round_up(input: u64, granularity: u64) -> u64 {
715 if granularity == 0 {
716 return input;
717 }
718 // If the input is absurdly large we round down instead of up; it's going to fail anyway.
719 let result = input.checked_add(granularity - 1).unwrap_or(input);
720 (result / granularity) * granularity
721}
722
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000723/// Given the configuration for a disk image, assembles the `DiskFile` to pass to crosvm.
724///
725/// This may involve assembling a composite disk from a set of partition images.
726fn assemble_disk_image(
727 disk: &DiskImage,
Jooyung Han95884632021-07-06 22:27:54 +0900728 zero_filler_path: &Path,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000729 temporary_directory: &Path,
730 next_temporary_image_id: &mut u64,
731 indirect_files: &mut Vec<File>,
Andrew Walbran806f1542021-06-10 14:07:12 +0000732) -> Result<DiskFile, Status> {
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000733 let image = if !disk.partitions.is_empty() {
734 if disk.image.is_some() {
735 warn!("DiskImage {:?} contains both image and partitions.", disk);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900736 return Err(anyhow!("DiskImage contains both image and partitions"))
737 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000738 }
739
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000740 let composite_image_filenames =
741 make_composite_image_filenames(temporary_directory, next_temporary_image_id);
742 let (image, partition_files) = make_composite_image(
743 &disk.partitions,
Jooyung Han95884632021-07-06 22:27:54 +0900744 zero_filler_path,
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000745 &composite_image_filenames.composite,
746 &composite_image_filenames.header,
747 &composite_image_filenames.footer,
748 )
Jiyong Park2227eaa2023-08-04 11:59:18 +0900749 .with_context(|| format!("Failed to make composite disk image with config {:?}", disk))
750 .with_log()
751 .or_service_specific_exception(-1)?;
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000752
753 // Pass the file descriptors for the various partition files to crosvm when it
754 // is run.
755 indirect_files.extend(partition_files);
756
757 image
758 } else if let Some(image) = &disk.image {
759 clone_file(image)?
760 } else {
761 warn!("DiskImage {:?} didn't contain image or partitions.", disk);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900762 return Err(anyhow!("DiskImage didn't contain image or partitions."))
763 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000764 };
765
766 Ok(DiskFile { image, writable: disk.writable })
767}
768
Nikita Ioffeaa6858c2023-07-04 01:37:41 +0100769fn append_kernel_param(param: &str, vm_config: &mut VirtualMachineRawConfig) {
770 if let Some(ref mut params) = vm_config.params {
771 params.push(' ');
772 params.push_str(param)
773 } else {
774 vm_config.params = Some(param.to_owned())
775 }
776}
777
Inseob Kim46257382024-01-03 15:41:22 +0900778fn extract_os_name_from_config_path(config: &Path) -> Option<String> {
779 if config.extension()?.to_str()? != "json" {
780 return None;
Inseob Kim172f9eb2023-11-06 17:02:08 +0900781 }
Inseob Kim46257382024-01-03 15:41:22 +0900782
783 Some(config.with_extension("").file_name()?.to_str()?.to_owned())
784}
785
786fn extract_os_names_from_configs(config_glob_pattern: &str) -> Result<HashSet<String>> {
787 let configs = glob(config_glob_pattern)?.collect::<Result<Vec<_>, _>>()?;
788 let os_names =
789 configs.iter().filter_map(|x| extract_os_name_from_config_path(x)).collect::<HashSet<_>>();
790
791 Ok(os_names)
792}
793
794fn get_supported_os_names() -> Result<HashSet<String>> {
795 if !cfg!(vendor_modules) {
796 return Ok(iter::once(MICRODROID_OS_NAME.to_owned()).collect());
797 }
798
799 extract_os_names_from_configs("/apex/com.android.virt/etc/microdroid*.json")
800}
801
802fn is_valid_os(os_name: &str) -> bool {
803 SUPPORTED_OS_NAMES.contains(os_name)
Inseob Kim172f9eb2023-11-06 17:02:08 +0900804}
805
Jooyung Han21e9b922021-06-26 04:14:16 +0900806fn load_app_config(
807 config: &VirtualMachineAppConfig,
Jaewan Kim61f86142023-03-28 15:12:52 +0900808 debug_config: &DebugConfig,
Jooyung Han21e9b922021-06-26 04:14:16 +0900809 temporary_directory: &Path,
Jooyung Hanadfb76c2021-06-28 17:29:30 +0900810) -> Result<VirtualMachineRawConfig> {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000811 let apk_file = clone_file(config.apk.as_ref().unwrap())?;
812 let idsig_file = clone_file(config.idsig.as_ref().unwrap())?;
Jiyong Park8d081812021-07-23 17:45:04 +0900813 let instance_file = clone_file(config.instanceImage.as_ref().unwrap())?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900814
Shikha Panwar22e70452022-10-10 18:32:55 +0000815 let storage_image = if let Some(file) = config.encryptedStorageImage.as_ref() {
816 Some(clone_file(file)?)
817 } else {
818 None
819 };
820
Alan Stokesfda70842023-12-20 17:50:14 +0000821 let vm_payload_config;
822 let extra_apk_files: Vec<_>;
823 match &config.payload {
Alan Stokes0d1ef782022-09-27 13:46:35 +0100824 Payload::ConfigPath(config_path) => {
Alan Stokesfda70842023-12-20 17:50:14 +0000825 vm_payload_config =
826 load_vm_payload_config_from_file(&apk_file, config_path.as_str())
827 .with_context(|| format!("Couldn't read config from {}", config_path))?;
828 extra_apk_files = vm_payload_config
829 .extra_apks
830 .iter()
831 .enumerate()
832 .map(|(i, apk)| {
833 File::open(PathBuf::from(&apk.path))
834 .with_context(|| format!("Failed to open extra apk #{i} {}", apk.path))
835 })
836 .collect::<Result<_>>()?;
Alan Stokes0d1ef782022-09-27 13:46:35 +0100837 }
Alan Stokesfda70842023-12-20 17:50:14 +0000838 Payload::PayloadConfig(payload_config) => {
839 vm_payload_config = create_vm_payload_config(payload_config)?;
840 extra_apk_files =
841 payload_config.extraApks.iter().map(clone_file).collect::<binder::Result<_>>()?;
842 }
Alan Stokes0d1ef782022-09-27 13:46:35 +0100843 };
Jooyung Han21e9b922021-06-26 04:14:16 +0900844
Inseob Kim89b24592024-02-23 18:59:43 +0900845 let payload_config_os = vm_payload_config.os.name.as_str();
846 if !payload_config_os.is_empty() && payload_config_os != "microdroid" {
847 bail!("'os' in payload config is deprecated");
848 }
849
Inseob Kim172f9eb2023-11-06 17:02:08 +0900850 // For now, the only supported OS is Microdroid and Microdroid GKI
Inseob Kim89b24592024-02-23 18:59:43 +0900851 let os_name = config.osName.as_str();
Inseob Kim172f9eb2023-11-06 17:02:08 +0900852 if !is_valid_os(os_name) {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000853 bail!("Unknown OS \"{}\"", os_name);
Jooyung Han35edb8f2021-07-01 16:17:16 +0900854 }
Andrew Walbrancc0db522021-07-12 17:03:42 +0000855
856 // It is safe to construct a filename based on the os_name because we've already checked that it
857 // is one of the allowed values.
Jooyung Han21e9b922021-06-26 04:14:16 +0900858 let vm_config_path = PathBuf::from(format!("/apex/com.android.virt/etc/{}.json", os_name));
859 let vm_config_file = File::open(vm_config_path)?;
Andrew Walbrancc0db522021-07-12 17:03:42 +0000860 let mut vm_config = VmConfig::load(&vm_config_file)?.to_parcelable()?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900861
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +0100862 if let Some(custom_config) = &config.customConfig {
863 if let Some(file) = custom_config.customKernelImage.as_ref() {
864 vm_config.kernel = Some(ParcelFileDescriptor::new(clone_file(file)?))
865 }
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +0100866 vm_config.gdbPort = custom_config.gdbPort;
Nikita Ioffe5dfddf22023-06-29 16:11:26 +0100867
868 if let Some(file) = custom_config.vendorImage.as_ref() {
Nikita Ioffeaa6858c2023-07-04 01:37:41 +0100869 add_microdroid_vendor_image(clone_file(file)?, &mut vm_config);
870 append_kernel_param("androidboot.microdroid.mount_vendor=1", &mut vm_config)
Nikita Ioffe5dfddf22023-06-29 16:11:26 +0100871 }
Inseob Kim6ef80972023-07-20 17:23:36 +0900872
873 vm_config.devices = custom_config.devices.clone();
Nikita Ioffe26c35ed2023-06-05 17:49:08 +0100874 }
875
Andrew Walbrancc045902021-07-27 16:06:17 +0000876 if config.memoryMib > 0 {
877 vm_config.memoryMib = config.memoryMib;
Andrew Walbran45bcb0c2021-07-14 15:02:06 +0000878 }
879
Seungjae Yoo62085c02022-08-12 04:44:52 +0000880 vm_config.name = config.name.clone();
Andrew Walbran3994f002022-01-27 17:33:45 +0000881 vm_config.protectedVm = config.protectedVm;
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000882 vm_config.cpuTopology = config.cpuTopology;
Jiyong Park032615f2022-01-10 13:55:34 +0900883
Shikha Panwar22e70452022-10-10 18:32:55 +0000884 // Microdroid takes additional init ramdisk & (optionally) storage image
Inseob Kim172f9eb2023-11-06 17:02:08 +0900885 add_microdroid_system_images(config, instance_file, storage_image, os_name, &mut vm_config)?;
Shikha Panwar22e70452022-10-10 18:32:55 +0000886
887 // Include Microdroid payload disk (contains apks, idsigs) in vm config
888 add_microdroid_payload_images(
Alan Stokes0d1ef782022-09-27 13:46:35 +0100889 config,
Jaewan Kim61f86142023-03-28 15:12:52 +0900890 debug_config,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100891 temporary_directory,
892 apk_file,
893 idsig_file,
Alan Stokesfda70842023-12-20 17:50:14 +0000894 extra_apk_files,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100895 &vm_payload_config,
896 &mut vm_config,
897 )?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900898
Andrew Walbrancc0db522021-07-12 17:03:42 +0000899 Ok(vm_config)
Jooyung Han21e9b922021-06-26 04:14:16 +0900900}
901
Inseob Kimff48a7c2024-02-26 22:07:21 +0900902fn check_partition_for_file(fd: &ParcelFileDescriptor) -> Result<()> {
903 let path = format!("/proc/self/fd/{}", fd.as_raw_fd());
904 let link = fs::read_link(&path).context(format!("can't read_link {path}"))?;
905
906 // microdroid vendor image is OK
907 if cfg!(vendor_modules) && link == Path::new("/vendor/etc/avf/microdroid/microdroid_vendor.img")
908 {
909 return Ok(());
910 }
911
912 if link.starts_with("/vendor") || link.starts_with("/odm") {
913 bail!("vendor or odm file {} can't be used for VM", link.display());
914 }
915
916 Ok(())
917}
918
919fn check_partitions_for_files(config: &VirtualMachineRawConfig) -> Result<()> {
920 config
921 .disks
922 .iter()
923 .flat_map(|disk| disk.partitions.iter())
924 .filter_map(|partition| partition.image.as_ref())
925 .try_for_each(check_partition_for_file)?;
926
927 config.kernel.as_ref().map_or(Ok(()), check_partition_for_file)?;
928 config.initrd.as_ref().map_or(Ok(()), check_partition_for_file)?;
929 config.bootloader.as_ref().map_or(Ok(()), check_partition_for_file)?;
930
931 Ok(())
932}
933
Alan Stokes0d1ef782022-09-27 13:46:35 +0100934fn load_vm_payload_config_from_file(apk_file: &File, config_path: &str) -> Result<VmPayloadConfig> {
935 let mut apk_zip = ZipArchive::new(apk_file)?;
936 let config_file = apk_zip.by_name(config_path)?;
937 Ok(serde_json::from_reader(config_file)?)
938}
939
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000940fn create_vm_payload_config(
941 payload_config: &VirtualMachinePayloadConfig,
942) -> Result<VmPayloadConfig> {
Alan Stokes0d1ef782022-09-27 13:46:35 +0100943 // There isn't an actual config file. Construct a synthetic VmPayloadConfig from the explicit
944 // parameters we've been given. Microdroid will do something equivalent inside the VM using the
945 // payload config that we send it via the metadata file.
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000946
947 let payload_binary_name = &payload_config.payloadBinaryName;
948 if payload_binary_name.contains('/') {
949 bail!("Payload binary name must not specify a path: {payload_binary_name}");
950 }
951
952 let task = Task { type_: TaskType::MicrodroidLauncher, command: payload_binary_name.clone() };
Alan Stokesfda70842023-12-20 17:50:14 +0000953
954 // The VM only cares about how many there are, these names are actually ignored.
955 let extra_apk_count = payload_config.extraApks.len();
956 let extra_apks =
957 (0..extra_apk_count).map(|i| ApkConfig { path: format!("extra-apk-{i}") }).collect();
958
Inseob Kim89b24592024-02-23 18:59:43 +0900959 Ok(VmPayloadConfig { task: Some(task), extra_apks, ..Default::default() })
Alan Stokes0d1ef782022-09-27 13:46:35 +0100960}
961
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000962/// Generates a unique filename to use for a composite disk image.
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000963fn make_composite_image_filenames(
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000964 temporary_directory: &Path,
965 next_temporary_image_id: &mut u64,
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000966) -> CompositeImageFilenames {
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000967 let id = *next_temporary_image_id;
968 *next_temporary_image_id += 1;
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000969 CompositeImageFilenames {
970 composite: temporary_directory.join(format!("composite-{}.img", id)),
971 header: temporary_directory.join(format!("composite-{}-header.img", id)),
972 footer: temporary_directory.join(format!("composite-{}-footer.img", id)),
973 }
974}
975
976/// Filenames for a composite disk image, including header and footer partitions.
977#[derive(Clone, Debug, Eq, PartialEq)]
978struct CompositeImageFilenames {
979 /// The composite disk image itself.
980 composite: PathBuf,
981 /// The header partition image.
982 header: PathBuf,
983 /// The footer partition image.
984 footer: PathBuf,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000985}
986
Jiyong Park753553b2021-07-12 21:21:09 +0900987/// Checks whether the caller has a specific permission
988fn check_permission(perm: &str) -> binder::Result<()> {
David Brazdil1f530702022-10-03 12:18:10 +0100989 let calling_pid = get_calling_pid();
990 let calling_uid = get_calling_uid();
Jiyong Park753553b2021-07-12 21:21:09 +0900991 // Root can do anything
992 if calling_uid == 0 {
993 return Ok(());
994 }
995 let perm_svc: Strong<dyn IPermissionController::IPermissionController> =
996 binder::get_interface("permission")?;
997 if perm_svc.checkPermission(perm, calling_pid, calling_uid as i32)? {
Andrew Walbran806f1542021-06-10 14:07:12 +0000998 Ok(())
999 } else {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001000 Err(anyhow!("does not have the {} permission", perm))
1001 .or_binder_exception(ExceptionCode::SECURITY)
Andrew Walbran806f1542021-06-10 14:07:12 +00001002 }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001003}
1004
Jiyong Park753553b2021-07-12 21:21:09 +09001005/// Check whether the caller of the current Binder method is allowed to manage VMs
1006fn check_manage_access() -> binder::Result<()> {
1007 check_permission("android.permission.MANAGE_VIRTUAL_MACHINE")
1008}
1009
Inseob Kim1119d702022-05-02 18:01:58 +09001010/// Check whether the caller of the current Binder method is allowed to create custom VMs
1011fn check_use_custom_virtual_machine() -> binder::Result<()> {
1012 check_permission("android.permission.USE_CUSTOM_VIRTUAL_MACHINE")
1013}
1014
Alan Stokes185fe112023-01-10 16:20:55 +00001015/// Return whether a partition is exempt from selinux label checks, because we know that it does
1016/// not contain code and is likely to be generated in an app-writable directory.
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001017fn is_safe_app_partition(label: &str) -> bool {
Shikha Panwara2ff8c52022-11-30 19:25:46 +00001018 // See add_microdroid_system_images & add_microdroid_payload_images in payload.rs.
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001019 label == "vm-instance"
Shikha Panwara2ff8c52022-11-30 19:25:46 +00001020 || label == "encryptedstore"
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001021 || label == "microdroid-apk-idsig"
1022 || label == "payload-metadata"
1023 || label.starts_with("extra-idsig-")
1024}
1025
Alice Wangc206b9b2023-08-28 14:13:51 +00001026/// Returns whether a partition with the given label is safe for a raw config VM.
1027fn is_safe_raw_partition(label: &str) -> bool {
1028 label == "vm-instance"
1029}
1030
Alan Stokes185fe112023-01-10 16:20:55 +00001031/// Check that a file SELinux label is acceptable.
1032///
1033/// 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 +09001034/// system or vendor, do not have write access to.
Alan Stokes185fe112023-01-10 16:20:55 +00001035///
1036/// Note that sepolicy must also grant read access for these types to both virtualization
1037/// service and crosvm.
1038///
1039/// App private data files are deliberately excluded, to avoid arbitrary payloads being run on
1040/// user devices (W^X).
1041fn check_label_is_allowed(context: &SeContext) -> Result<()> {
1042 match context.selinux_type()? {
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001043 | "apk_data_file" // APKs of an installed app
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001044 | "shell_data_file" // test files created via adb shell
Alan Stokesfe4bb0c2023-03-20 14:15:36 +00001045 | "staging_data_file" // updated/staged APEX images
1046 | "system_file" // immutable dm-verity protected partition
1047 | "virtualizationservice_data_file" // files created by VS / VirtMgr
Seungjae Yoo2b74c442023-11-15 18:05:07 +09001048 | "vendor_microdroid_file" // immutable dm-verity protected partition (/vendor/etc/avf/microdroid/.*)
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001049 => Ok(()),
Alan Stokes185fe112023-01-10 16:20:55 +00001050 _ => bail!("Label {} is not allowed", context),
Jiyong Park029977d2021-11-24 21:56:49 +09001051 }
1052}
1053
Alan Stokes185fe112023-01-10 16:20:55 +00001054fn check_label_for_partition(partition: &Partition) -> Result<()> {
1055 let file = partition.image.as_ref().unwrap().as_ref();
1056 check_label_is_allowed(&getfilecon(file)?)
1057 .with_context(|| format!("Partition {} invalid", &partition.label))
1058}
1059
1060fn check_label_for_kernel_files(kernel: &Option<File>, initrd: &Option<File>) -> Result<()> {
1061 if let Some(f) = kernel {
1062 check_label_for_file(f, "kernel")?;
1063 }
1064 if let Some(f) = initrd {
1065 check_label_for_file(f, "initrd")?;
1066 }
1067 Ok(())
1068}
1069fn check_label_for_file(file: &File, name: &str) -> Result<()> {
1070 check_label_is_allowed(&getfilecon(file)?).with_context(|| format!("{} file invalid", name))
1071}
1072
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001073/// Implementation of the AIDL `IVirtualMachine` interface. Used as a handle to a VM.
1074#[derive(Debug)]
1075struct VirtualMachine {
1076 instance: Arc<VmInstance>,
1077}
1078
1079impl VirtualMachine {
1080 fn create(instance: Arc<VmInstance>) -> Strong<dyn IVirtualMachine> {
David Brazdil4b4c5102022-12-19 22:56:20 +00001081 BnVirtualMachine::new_binder(VirtualMachine { instance }, BinderFeatures::default())
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001082 }
1083}
1084
1085impl Interface for VirtualMachine {}
1086
1087impl IVirtualMachine for VirtualMachine {
1088 fn getCid(&self) -> binder::Result<i32> {
Jiyong Park753553b2021-07-12 21:21:09 +09001089 // Don't check permission. The owner of the VM might have passed this binder object to
1090 // others.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001091 Ok(self.instance.cid as i32)
1092 }
Andrew Walbrandae07162021-03-12 17:05:20 +00001093
Andrew Walbran6b650662021-09-07 13:13:23 +00001094 fn getState(&self) -> binder::Result<VirtualMachineState> {
Jiyong Park753553b2021-07-12 21:21:09 +09001095 // Don't check permission. The owner of the VM might have passed this binder object to
1096 // others.
Andrew Walbran6b650662021-09-07 13:13:23 +00001097 Ok(get_state(&self.instance))
Andrew Walbrandae07162021-03-12 17:05:20 +00001098 }
1099
1100 fn registerCallback(
1101 &self,
1102 callback: &Strong<dyn IVirtualMachineCallback>,
1103 ) -> binder::Result<()> {
Jiyong Park753553b2021-07-12 21:21:09 +09001104 // Don't check permission. The owner of the VM might have passed this binder object to
1105 // others.
1106 //
Andrew Walbrandae07162021-03-12 17:05:20 +00001107 // TODO: Should this give an error if the VM is already dead?
1108 self.instance.callbacks.add(callback.clone());
1109 Ok(())
1110 }
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001111
Andrew Walbranf8d94112021-09-07 11:45:36 +00001112 fn start(&self) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001113 self.instance
1114 .start()
1115 .with_context(|| format!("Error starting VM with CID {}", self.instance.cid))
1116 .with_log()
1117 .or_service_specific_exception(-1)
Andrew Walbranf8d94112021-09-07 11:45:36 +00001118 }
1119
Inseob Kima446f802022-07-11 19:46:37 +09001120 fn stop(&self) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001121 self.instance
1122 .kill()
1123 .with_context(|| format!("Error stopping VM with CID {}", self.instance.cid))
1124 .with_log()
1125 .or_service_specific_exception(-1)
Inseob Kima446f802022-07-11 19:46:37 +09001126 }
1127
Keir Frasercdd4b112022-11-24 14:02:25 +00001128 fn onTrimMemory(&self, level: MemoryTrimLevel) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001129 self.instance
1130 .trim_memory(level)
1131 .with_context(|| format!("Error trimming VM with CID {}", self.instance.cid))
1132 .with_log()
1133 .or_service_specific_exception(-1)
Keir Frasercdd4b112022-11-24 14:02:25 +00001134 }
1135
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001136 fn connectVsock(&self, port: i32) -> binder::Result<ParcelFileDescriptor> {
Andrew Walbranf8d94112021-09-07 11:45:36 +00001137 if !matches!(&*self.instance.vm_state.lock().unwrap(), VmState::Running { .. }) {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001138 return Err(anyhow!("VM is not running")).or_service_specific_exception(-1);
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001139 }
Alan Stokes10c47672022-12-13 17:17:08 +00001140 let port = port as u32;
1141 if port < 1024 {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001142 return Err(anyhow!("Can't connect to privileged port {port}"))
1143 .or_service_specific_exception(-1);
Alan Stokes10c47672022-12-13 17:17:08 +00001144 }
Jiyong Park2227eaa2023-08-04 11:59:18 +09001145 let stream = VsockStream::connect_with_cid_port(self.instance.cid, port)
1146 .context("Failed to connect")
1147 .or_service_specific_exception(-1)?;
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001148 Ok(vsock_stream_to_pfd(stream))
1149 }
Andrew Walbrandae07162021-03-12 17:05:20 +00001150}
1151
1152impl Drop for VirtualMachine {
1153 fn drop(&mut self) {
1154 debug!("Dropping {:?}", self);
Inseob Kima446f802022-07-11 19:46:37 +09001155 if let Err(e) = self.instance.kill() {
1156 debug!("Error stopping dropped VM with CID {}: {:?}", self.instance.cid, e);
1157 }
Andrew Walbrandae07162021-03-12 17:05:20 +00001158 }
1159}
1160
1161/// A set of Binders to be called back in response to various events on the VM, such as when it
1162/// dies.
1163#[derive(Debug, Default)]
1164pub struct VirtualMachineCallbacks(Mutex<Vec<Strong<dyn IVirtualMachineCallback>>>);
1165
1166impl VirtualMachineCallbacks {
Jiyong Park8611a6c2021-07-09 18:17:44 +09001167 /// Call all registered callbacks to notify that the payload has started.
David Brazdil451cc962022-10-14 14:08:12 +01001168 pub fn notify_payload_started(&self, cid: Cid) {
Jiyong Park8611a6c2021-07-09 18:17:44 +09001169 let callbacks = &*self.0.lock().unwrap();
Jiyong Park8611a6c2021-07-09 18:17:44 +09001170 for callback in callbacks {
David Brazdil451cc962022-10-14 14:08:12 +01001171 if let Err(e) = callback.onPayloadStarted(cid as i32) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001172 error!("Error notifying payload start event from VM CID {}: {:?}", cid, e);
Jiyong Park8611a6c2021-07-09 18:17:44 +09001173 }
1174 }
1175 }
1176
Inseob Kim14cb8692021-08-31 21:50:39 +09001177 /// Call all registered callbacks to notify that the payload is ready to serve.
1178 pub fn notify_payload_ready(&self, cid: Cid) {
1179 let callbacks = &*self.0.lock().unwrap();
1180 for callback in callbacks {
1181 if let Err(e) = callback.onPayloadReady(cid as i32) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001182 error!("Error notifying payload ready event from VM CID {}: {:?}", cid, e);
Inseob Kim14cb8692021-08-31 21:50:39 +09001183 }
1184 }
1185 }
1186
Inseob Kim2444af92021-08-31 01:22:50 +09001187 /// Call all registered callbacks to notify that the payload has finished.
1188 pub fn notify_payload_finished(&self, cid: Cid, exit_code: i32) {
1189 let callbacks = &*self.0.lock().unwrap();
1190 for callback in callbacks {
1191 if let Err(e) = callback.onPayloadFinished(cid as i32, exit_code) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001192 error!("Error notifying payload finish event from VM CID {}: {:?}", cid, e);
Inseob Kim2444af92021-08-31 01:22:50 +09001193 }
1194 }
1195 }
1196
Jooyung Handd0a1732021-11-23 15:26:20 +09001197 /// Call all registered callbacks to say that the VM encountered an error.
Alan Stokes2bead0d2022-09-05 16:58:34 +01001198 pub fn notify_error(&self, cid: Cid, error_code: ErrorCode, message: &str) {
Jooyung Handd0a1732021-11-23 15:26:20 +09001199 let callbacks = &*self.0.lock().unwrap();
1200 for callback in callbacks {
1201 if let Err(e) = callback.onError(cid as i32, error_code, message) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001202 error!("Error notifying error event from VM CID {}: {:?}", cid, e);
Jooyung Handd0a1732021-11-23 15:26:20 +09001203 }
1204 }
1205 }
1206
Andrew Walbrandae07162021-03-12 17:05:20 +00001207 /// Call all registered callbacks to say that the VM has died.
Andrew Walbranc92d35f2022-01-12 12:45:19 +00001208 pub fn callback_on_died(&self, cid: Cid, reason: DeathReason) {
Andrew Walbrandae07162021-03-12 17:05:20 +00001209 let callbacks = &*self.0.lock().unwrap();
1210 for callback in callbacks {
Andrew Walbranc92d35f2022-01-12 12:45:19 +00001211 if let Err(e) = callback.onDied(cid as i32, reason) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001212 error!("Error notifying exit of VM CID {}: {:?}", cid, e);
Andrew Walbrandae07162021-03-12 17:05:20 +00001213 }
1214 }
1215 }
1216
1217 /// Add a new callback to the set.
1218 fn add(&self, callback: Strong<dyn IVirtualMachineCallback>) {
1219 self.0.lock().unwrap().push(callback);
1220 }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001221}
1222
Andrew Walbranf6bf6862021-05-21 12:41:13 +00001223/// The mutable state of the VirtualizationService. There should only be one instance of this
1224/// struct.
Chris Wailes641fc4a2021-12-01 15:03:21 -08001225#[derive(Debug, Default)]
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001226struct State {
Alan Stokes3e5eec12023-09-07 12:10:00 +01001227 /// The VMs which have been started. When VMs are started a weak reference is added to this
1228 /// list while a strong reference is returned to the caller over Binder. Once all copies of
1229 /// the Binder client are dropped the weak reference here will become invalid, and will be
1230 /// removed from the list opportunistically the next time `add_vm` is called.
Andrew Walbran320b5602021-03-04 16:11:12 +00001231 vms: Vec<Weak<VmInstance>>,
1232}
1233
1234impl State {
Andrew Walbrandae07162021-03-12 17:05:20 +00001235 /// Get a list of VMs which still have Binder references to them.
Andrew Walbran320b5602021-03-04 16:11:12 +00001236 fn vms(&self) -> Vec<Arc<VmInstance>> {
1237 // Attempt to upgrade the weak pointers to strong pointers.
1238 self.vms.iter().filter_map(Weak::upgrade).collect()
1239 }
1240
1241 /// Add a new VM to the list.
1242 fn add_vm(&mut self, vm: Weak<VmInstance>) {
1243 // Garbage collect any entries from the stored list which no longer exist.
1244 self.vms.retain(|vm| vm.strong_count() > 0);
1245
1246 // Actually add the new VM.
1247 self.vms.push(vm);
1248 }
David Brazdil3c2ddef2021-03-18 13:09:57 +00001249
Jiyong Park8611a6c2021-07-09 18:17:44 +09001250 /// Get a VM that corresponds to the given cid
1251 fn get_vm(&self, cid: Cid) -> Option<Arc<VmInstance>> {
1252 self.vms().into_iter().find(|vm| vm.cid == cid)
1253 }
Jiyong Parkd50a0242021-09-16 21:00:14 +09001254}
1255
Andrew Walbran6b650662021-09-07 13:13:23 +00001256/// Gets the `VirtualMachineState` of the given `VmInstance`.
1257fn get_state(instance: &VmInstance) -> VirtualMachineState {
Andrew Walbranf8d94112021-09-07 11:45:36 +00001258 match &*instance.vm_state.lock().unwrap() {
1259 VmState::NotStarted { .. } => VirtualMachineState::NOT_STARTED,
1260 VmState::Running { .. } => match instance.payload_state() {
Andrew Walbran6b650662021-09-07 13:13:23 +00001261 PayloadState::Starting => VirtualMachineState::STARTING,
1262 PayloadState::Started => VirtualMachineState::STARTED,
1263 PayloadState::Ready => VirtualMachineState::READY,
1264 PayloadState::Finished => VirtualMachineState::FINISHED,
Jiyong Parka4eebde2022-07-12 18:01:12 +09001265 PayloadState::Hangup => VirtualMachineState::DEAD,
Andrew Walbranf8d94112021-09-07 11:45:36 +00001266 },
1267 VmState::Dead => VirtualMachineState::DEAD,
1268 VmState::Failed => VirtualMachineState::DEAD,
Andrew Walbran6b650662021-09-07 13:13:23 +00001269 }
1270}
1271
David Brazdilf50c7a62023-04-19 14:22:42 +00001272/// Converts a `&ParcelFileDescriptor` to a `File` by cloning the file.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001273pub fn clone_file(file: &ParcelFileDescriptor) -> binder::Result<File> {
1274 file.as_ref()
1275 .try_clone()
1276 .context("Failed to clone File from ParcelFileDescriptor")
1277 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)
Andrei Homescu11333c62023-11-09 04:26:39 +00001278 .map(File::from)
David Brazdilf50c7a62023-04-19 14:22:42 +00001279}
1280
Andrew Walbrand3a84182021-09-07 14:48:52 +00001281/// Converts an `&Option<ParcelFileDescriptor>` to an `Option<File>` by cloning the file.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001282fn maybe_clone_file(file: &Option<ParcelFileDescriptor>) -> binder::Result<Option<File>> {
Andrew Walbrand3a84182021-09-07 14:48:52 +00001283 file.as_ref().map(clone_file).transpose()
1284}
1285
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001286/// Converts a `VsockStream` to a `ParcelFileDescriptor`.
1287fn vsock_stream_to_pfd(stream: VsockStream) -> ParcelFileDescriptor {
1288 // SAFETY: ownership is transferred from stream to f
1289 let f = unsafe { File::from_raw_fd(stream.into_raw_fd()) };
1290 ParcelFileDescriptor::new(f)
1291}
1292
Jiyong Parkdcf17412022-02-08 15:07:23 +09001293/// Parses the platform version requirement string.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001294fn parse_platform_version_req(s: &str) -> binder::Result<VersionReq> {
1295 VersionReq::parse(s)
1296 .with_context(|| format!("Invalid platform version requirement {}", s))
1297 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)
Jiyong Parkdcf17412022-02-08 15:07:23 +09001298}
1299
Jiyong Parked180932023-02-24 19:55:41 +09001300/// Create the empty ramdump file
1301fn prepare_ramdump_file(temporary_directory: &Path) -> binder::Result<File> {
1302 // `ramdump_write` is sent to crosvm and will be the backing store for the /dev/hvc1 where
1303 // VM will emit ramdump to. `ramdump_read` will be sent back to the client (i.e. the VM
1304 // owner) for readout.
1305 let ramdump_path = temporary_directory.join("ramdump");
Jiyong Park2227eaa2023-08-04 11:59:18 +09001306 let ramdump = File::create(ramdump_path)
1307 .context("Failed to prepare ramdump file")
1308 .with_log()
1309 .or_service_specific_exception(-1)?;
Jiyong Parked180932023-02-24 19:55:41 +09001310 Ok(ramdump)
1311}
1312
Nikita Ioffe5776f082023-02-10 21:38:26 +00001313fn is_protected(config: &VirtualMachineConfig) -> bool {
1314 match config {
1315 VirtualMachineConfig::RawConfig(config) => config.protectedVm,
1316 VirtualMachineConfig::AppConfig(config) => config.protectedVm,
1317 }
1318}
1319
1320fn check_gdb_allowed(config: &VirtualMachineConfig) -> binder::Result<()> {
1321 if is_protected(config) {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001322 return Err(anyhow!("Can't use gdb with protected VMs"))
1323 .or_binder_exception(ExceptionCode::SECURITY);
Nikita Ioffe5776f082023-02-10 21:38:26 +00001324 }
1325
1326 match config {
1327 VirtualMachineConfig::RawConfig(_) => Ok(()),
1328 VirtualMachineConfig::AppConfig(config) => {
1329 if config.debugLevel != DebugLevel::FULL {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001330 Err(anyhow!("Can't use gdb with non-debuggable VMs"))
1331 .or_binder_exception(ExceptionCode::SECURITY)
Nikita Ioffe5776f082023-02-10 21:38:26 +00001332 } else {
1333 Ok(())
1334 }
1335 }
1336 }
1337}
1338
Shikha Panwar61a74b52024-02-16 13:17:01 +00001339fn extract_instance_id(config: &VirtualMachineConfig) -> [u8; 64] {
1340 match config {
1341 VirtualMachineConfig::RawConfig(config) => config.instanceId,
1342 VirtualMachineConfig::AppConfig(config) => config.instanceId,
1343 }
1344}
1345
Nikita Ioffe5776f082023-02-10 21:38:26 +00001346fn extract_gdb_port(config: &VirtualMachineConfig) -> Option<NonZeroU16> {
1347 match config {
1348 VirtualMachineConfig::RawConfig(config) => NonZeroU16::new(config.gdbPort as u16),
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +01001349 VirtualMachineConfig::AppConfig(config) => {
1350 NonZeroU16::new(config.customConfig.as_ref().map(|c| c.gdbPort).unwrap_or(0) as u16)
1351 }
Nikita Ioffe5776f082023-02-10 21:38:26 +00001352 }
1353}
1354
Nikita Ioffe631717e2023-09-05 13:38:07 +01001355fn check_no_vendor_modules(config: &VirtualMachineConfig) -> binder::Result<()> {
1356 let VirtualMachineConfig::AppConfig(config) = config else { return Ok(()) };
1357 if let Some(custom_config) = &config.customConfig {
1358 if custom_config.vendorImage.is_some() || custom_config.customKernelImage.is_some() {
1359 return Err(anyhow!("vendor modules feature is disabled"))
1360 .or_binder_exception(ExceptionCode::UNSUPPORTED_OPERATION);
1361 }
1362 }
1363 Ok(())
1364}
1365
Nikita Ioffe94a8a182023-11-16 16:37:48 +00001366fn check_no_devices(config: &VirtualMachineConfig) -> binder::Result<()> {
1367 let VirtualMachineConfig::AppConfig(config) = config else { return Ok(()) };
1368 if let Some(custom_config) = &config.customConfig {
1369 if !custom_config.devices.is_empty() {
1370 return Err(anyhow!("device assignment feature is disabled"))
1371 .or_binder_exception(ExceptionCode::UNSUPPORTED_OPERATION);
1372 }
1373 }
1374 Ok(())
1375}
1376
Alan Stokesfda70842023-12-20 17:50:14 +00001377fn check_no_extra_apks(config: &VirtualMachineConfig) -> binder::Result<()> {
1378 let VirtualMachineConfig::AppConfig(config) = config else { return Ok(()) };
1379 let Payload::PayloadConfig(payload_config) = &config.payload else { return Ok(()) };
1380 if !payload_config.extraApks.is_empty() {
1381 return Err(anyhow!("multi-tenant feature is disabled"))
1382 .or_binder_exception(ExceptionCode::UNSUPPORTED_OPERATION);
1383 }
1384 Ok(())
1385}
1386
Nikita Ioffe631717e2023-09-05 13:38:07 +01001387fn check_config_features(config: &VirtualMachineConfig) -> binder::Result<()> {
1388 if !cfg!(vendor_modules) {
1389 check_no_vendor_modules(config)?;
1390 }
Nikita Ioffe94a8a182023-11-16 16:37:48 +00001391 if !cfg!(device_assignment) {
1392 check_no_devices(config)?;
1393 }
Alan Stokesfda70842023-12-20 17:50:14 +00001394 if !cfg!(multi_tenant) {
1395 check_no_extra_apks(config)?;
1396 }
Nikita Ioffe631717e2023-09-05 13:38:07 +01001397 Ok(())
1398}
1399
Inseob Kim0168b462022-12-27 14:54:35 +09001400fn clone_or_prepare_logger_fd(
Jaewan Kim61f86142023-03-28 15:12:52 +09001401 debug_config: &DebugConfig,
Inseob Kim0168b462022-12-27 14:54:35 +09001402 fd: Option<&ParcelFileDescriptor>,
1403 tag: String,
1404) -> Result<Option<File>, Status> {
1405 if let Some(fd) = fd {
1406 return Ok(Some(clone_file(fd)?));
1407 }
1408
Jaewan Kim61f86142023-03-28 15:12:52 +09001409 if !debug_config.should_prepare_console_output() {
Jaewan Kim66f062e2023-02-25 01:07:43 +09001410 return Ok(None);
1411 };
Inseob Kim0168b462022-12-27 14:54:35 +09001412
Jiyong Park2227eaa2023-08-04 11:59:18 +09001413 let (raw_read_fd, raw_write_fd) =
1414 pipe().context("Failed to create pipe").or_service_specific_exception(-1)?;
Inseob Kim0168b462022-12-27 14:54:35 +09001415
Andrew Walbranb58d1b42023-07-07 13:54:49 +01001416 // SAFETY: We are the sole owner of this FD as we just created it, and it is valid and open.
Inseob Kim0168b462022-12-27 14:54:35 +09001417 let mut reader = BufReader::new(unsafe { File::from_raw_fd(raw_read_fd) });
Andrew Walbranb58d1b42023-07-07 13:54:49 +01001418 // SAFETY: We are the sole owner of this FD as we just created it, and it is valid and open.
Inseob Kim0168b462022-12-27 14:54:35 +09001419 let write_fd = unsafe { File::from_raw_fd(raw_write_fd) };
1420
1421 std::thread::spawn(move || loop {
1422 let mut buf = vec![];
1423 match reader.read_until(b'\n', &mut buf) {
1424 Ok(0) => {
1425 // EOF
1426 return;
1427 }
1428 Ok(size) => {
1429 if buf[size - 1] == b'\n' {
1430 buf.pop();
1431 }
1432 info!("{}: {}", &tag, &String::from_utf8_lossy(&buf));
1433 }
1434 Err(e) => {
1435 error!("Could not read console pipe: {:?}", e);
1436 return;
1437 }
1438 };
1439 });
1440
1441 Ok(Some(write_fd))
1442}
1443
Jooyung Han35edb8f2021-07-01 16:17:16 +09001444/// Simple utility for referencing Borrowed or Owned. Similar to std::borrow::Cow, but
1445/// it doesn't require that T implements Clone.
1446enum BorrowedOrOwned<'a, T> {
1447 Borrowed(&'a T),
1448 Owned(T),
1449}
1450
1451impl<'a, T> AsRef<T> for BorrowedOrOwned<'a, T> {
1452 fn as_ref(&self) -> &T {
1453 match self {
1454 Self::Borrowed(b) => b,
Chris Wailes68c39f82021-07-27 16:03:44 -07001455 Self::Owned(o) => o,
Jooyung Han35edb8f2021-07-01 16:17:16 +09001456 }
1457 }
1458}
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001459
1460/// Implementation of `IVirtualMachineService`, the entry point of the AIDL service.
1461#[derive(Debug, Default)]
1462struct VirtualMachineService {
1463 state: Arc<Mutex<State>>,
Inseob Kimc7d28c72021-10-25 14:28:10 +00001464 cid: Cid,
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001465}
1466
1467impl Interface for VirtualMachineService {}
1468
1469impl IVirtualMachineService for VirtualMachineService {
Inseob Kimc7d28c72021-10-25 14:28:10 +00001470 fn notifyPayloadStarted(&self) -> binder::Result<()> {
1471 let cid = self.cid;
Inseob Kim7f61fe72021-08-20 20:50:47 +09001472 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001473 info!("VM with CID {} started payload", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001474 vm.update_payload_state(PayloadState::Started)
1475 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
David Brazdil451cc962022-10-14 14:08:12 +01001476 vm.callbacks.notify_payload_started(cid);
Seungjae Yoo62085c02022-08-12 04:44:52 +00001477
Seungjae Yoo6d265d92022-11-15 10:51:33 +09001478 let vm_start_timestamp = vm.vm_metric.lock().unwrap().start_timestamp;
1479 write_vm_booted_stats(vm.requester_uid as i32, &vm.name, vm_start_timestamp);
Inseob Kim7f61fe72021-08-20 20:50:47 +09001480 Ok(())
1481 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001482 error!("notifyPayloadStarted is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001483 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001484 }
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001485 }
Inseob Kim2444af92021-08-31 01:22:50 +09001486
Inseob Kimc7d28c72021-10-25 14:28:10 +00001487 fn notifyPayloadReady(&self) -> binder::Result<()> {
1488 let cid = self.cid;
Inseob Kim14cb8692021-08-31 21:50:39 +09001489 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001490 info!("VM with CID {} reported payload is ready", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001491 vm.update_payload_state(PayloadState::Ready)
1492 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Inseob Kim14cb8692021-08-31 21:50:39 +09001493 vm.callbacks.notify_payload_ready(cid);
1494 Ok(())
1495 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001496 error!("notifyPayloadReady is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001497 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim14cb8692021-08-31 21:50:39 +09001498 }
1499 }
1500
Inseob Kimc7d28c72021-10-25 14:28:10 +00001501 fn notifyPayloadFinished(&self, exit_code: i32) -> binder::Result<()> {
1502 let cid = self.cid;
Inseob Kim2444af92021-08-31 01:22:50 +09001503 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001504 info!("VM with CID {} finished payload", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001505 vm.update_payload_state(PayloadState::Finished)
1506 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Inseob Kim2444af92021-08-31 01:22:50 +09001507 vm.callbacks.notify_payload_finished(cid, exit_code);
1508 Ok(())
1509 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001510 error!("notifyPayloadFinished is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001511 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Jooyung Handd0a1732021-11-23 15:26:20 +09001512 }
1513 }
1514
Alan Stokes2bead0d2022-09-05 16:58:34 +01001515 fn notifyError(&self, error_code: ErrorCode, message: &str) -> binder::Result<()> {
Jooyung Handd0a1732021-11-23 15:26:20 +09001516 let cid = self.cid;
1517 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001518 info!("VM with CID {} encountered an error", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001519 vm.update_payload_state(PayloadState::Finished)
1520 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Jooyung Handd0a1732021-11-23 15:26:20 +09001521 vm.callbacks.notify_error(cid, error_code, message);
1522 Ok(())
1523 } else {
Seungjae Yooec8c1602022-06-20 05:28:00 +00001524 error!("notifyError is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001525 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim2444af92021-08-31 01:22:50 +09001526 }
1527 }
Alice Wangc2fec932023-02-23 16:24:02 +00001528
Shikha Panware45e9422024-02-28 21:18:10 +00001529 fn getSecretkeeper(&self) -> binder::Result<Strong<dyn ISecretkeeper>> {
1530 if !is_secretkeeper_supported() {
1531 return Err(StatusCode::NAME_NOT_FOUND)?;
1532 }
1533 let sk = binder::wait_for_interface(SECRETKEEPER_IDENTIFIER)?;
1534 Ok(BnSecretkeeper::new_binder(SecretkeeperProxy(sk), BinderFeatures::default()))
Shikha Panwar5d6a6752023-12-14 22:08:26 +00001535 }
1536
Alice Wange64dd182024-01-17 15:57:55 +00001537 fn requestAttestation(&self, csr: &[u8], test_mode: bool) -> binder::Result<Vec<Certificate>> {
1538 GLOBAL_SERVICE.requestAttestation(csr, get_calling_uid() as i32, test_mode)
Alice Wangc2fec932023-02-23 16:24:02 +00001539 }
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001540}
1541
Shikha Panwar8707f0f2024-02-28 20:40:42 +00001542fn is_secretkeeper_supported() -> bool {
Shikha Panwar81d13d32024-03-10 19:39:23 +00001543 binder::is_declared(SECRETKEEPER_IDENTIFIER)
1544 .expect("Could not check for declared Secretkeeper interface")
Shikha Panwar8187ca22024-01-04 08:33:08 +00001545}
1546
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001547impl VirtualMachineService {
Inseob Kimc7d28c72021-10-25 14:28:10 +00001548 fn new_binder(state: Arc<Mutex<State>>, cid: Cid) -> Strong<dyn IVirtualMachineService> {
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001549 BnVirtualMachineService::new_binder(
Inseob Kimc7d28c72021-10-25 14:28:10 +00001550 VirtualMachineService { state, cid },
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001551 BinderFeatures::default(),
1552 )
1553 }
1554}
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001555
Stephen Hines4c1e2fc2024-02-09 16:34:47 -08001556struct SecretkeeperProxy(Strong<dyn ISecretkeeper>);
1557
1558impl Interface for SecretkeeperProxy {}
1559
1560impl ISecretkeeper for SecretkeeperProxy {
1561 fn processSecretManagementRequest(&self, req: &[u8]) -> binder::Result<Vec<u8>> {
1562 // Pass the request to the channel, and read the response.
1563 self.0.processSecretManagementRequest(req)
1564 }
1565
1566 fn getAuthGraphKe(&self) -> binder::Result<Strong<dyn IAuthGraphKeyExchange>> {
1567 let ag = AuthGraphKeyExchangeProxy(self.0.getAuthGraphKe()?);
1568 Ok(BnAuthGraphKeyExchange::new_binder(ag, BinderFeatures::default()))
1569 }
1570
1571 fn deleteIds(&self, ids: &[SecretId]) -> binder::Result<()> {
1572 self.0.deleteIds(ids)
1573 }
1574
1575 fn deleteAll(&self) -> binder::Result<()> {
1576 self.0.deleteAll()
1577 }
1578}
1579
1580struct AuthGraphKeyExchangeProxy(Strong<dyn IAuthGraphKeyExchange>);
1581
1582impl Interface for AuthGraphKeyExchangeProxy {}
1583
1584impl IAuthGraphKeyExchange for AuthGraphKeyExchangeProxy {
1585 fn create(&self) -> binder::Result<SessionInitiationInfo> {
1586 self.0.create()
1587 }
1588
1589 fn init(
1590 &self,
1591 peer_pub_key: &PubKey,
1592 peer_id: &Identity,
1593 peer_nonce: &[u8],
1594 peer_version: i32,
1595 ) -> binder::Result<KeInitResult> {
1596 self.0.init(peer_pub_key, peer_id, peer_nonce, peer_version)
1597 }
1598
1599 fn finish(
1600 &self,
1601 peer_pub_key: &PubKey,
1602 peer_id: &Identity,
1603 peer_signature: &SessionIdSignature,
1604 peer_nonce: &[u8],
1605 peer_version: i32,
1606 own_key: &Key,
1607 ) -> binder::Result<SessionInfo> {
1608 self.0.finish(peer_pub_key, peer_id, peer_signature, peer_nonce, peer_version, own_key)
1609 }
1610
1611 fn authenticationComplete(
1612 &self,
1613 peer_signature: &SessionIdSignature,
1614 shared_keys: &[AuthgraphArc; 2],
1615 ) -> binder::Result<[AuthgraphArc; 2]> {
1616 self.0.authenticationComplete(peer_signature, shared_keys)
1617 }
1618}
1619
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001620#[cfg(test)]
1621mod tests {
1622 use super::*;
1623
1624 #[test]
1625 fn test_is_allowed_label_for_partition() -> Result<()> {
1626 let expected_results = vec![
1627 ("u:object_r:system_file:s0", true),
1628 ("u:object_r:apk_data_file:s0", true),
1629 ("u:object_r:app_data_file:s0", false),
1630 ("u:object_r:app_data_file:s0:c512,c768", false),
1631 ("u:object_r:privapp_data_file:s0:c512,c768", false),
1632 ("invalid", false),
1633 ("user:role:apk_data_file:severity:categories", true),
1634 ("user:role:apk_data_file:severity:categories:extraneous", false),
1635 ];
1636
1637 for (label, expected_valid) in expected_results {
1638 let context = SeContext::new(label)?;
1639 let result = check_label_is_allowed(&context);
1640 if expected_valid {
1641 assert!(result.is_ok(), "Expected label {} to be allowed, got {:?}", label, result);
1642 } else if result.is_ok() {
1643 bail!("Expected label {} to be disallowed", label);
1644 }
1645 }
1646 Ok(())
1647 }
Nikita Ioffef1ce9872022-12-09 13:31:59 +00001648
1649 #[test]
1650 fn test_create_or_update_idsig_file_empty_apk() -> Result<()> {
1651 let apk = tempfile::tempfile().unwrap();
1652 let idsig = tempfile::tempfile().unwrap();
1653
1654 let ret = create_or_update_idsig_file(
1655 &ParcelFileDescriptor::new(apk),
1656 &ParcelFileDescriptor::new(idsig),
1657 );
1658 assert!(ret.is_err(), "should fail");
1659 Ok(())
1660 }
1661
1662 #[test]
1663 fn test_create_or_update_idsig_dir_instead_of_file_for_apk() -> Result<()> {
1664 let tmp_dir = tempfile::TempDir::new().unwrap();
1665 let apk = File::open(tmp_dir.path()).unwrap();
1666 let idsig = tempfile::tempfile().unwrap();
1667
1668 let ret = create_or_update_idsig_file(
1669 &ParcelFileDescriptor::new(apk),
1670 &ParcelFileDescriptor::new(idsig),
1671 );
1672 assert!(ret.is_err(), "should fail");
1673 Ok(())
1674 }
1675
1676 /// Verifies that create_or_update_idsig_file won't oom if a fd that corresponds to a directory
1677 /// on ext4 filesystem is passed.
1678 /// On ext4 lseek on a directory fd will return (off_t)-1 (see:
1679 /// https://bugzilla.kernel.org/show_bug.cgi?id=200043), which will result in
1680 /// create_or_update_idsig_file ooming while attempting to allocate petabytes of memory.
1681 #[test]
1682 fn test_create_or_update_idsig_does_not_crash_dir_on_ext4() -> Result<()> {
1683 // APEXes are backed by the ext4.
1684 let apk = File::open("/apex/com.android.virt/").unwrap();
1685 let idsig = tempfile::tempfile().unwrap();
1686
1687 let ret = create_or_update_idsig_file(
1688 &ParcelFileDescriptor::new(apk),
1689 &ParcelFileDescriptor::new(idsig),
1690 );
1691 assert!(ret.is_err(), "should fail");
1692 Ok(())
1693 }
Jiyong Park8d192952023-06-26 14:29:51 +09001694
1695 #[test]
1696 fn test_create_or_update_idsig_does_not_update_if_already_valid() -> Result<()> {
1697 use std::io::Seek;
1698
1699 // Pick any APK
1700 let mut apk = File::open("/system/priv-app/Shell/Shell.apk").unwrap();
1701 let mut idsig = tempfile::tempfile().unwrap();
1702
1703 create_or_update_idsig_file(
1704 &ParcelFileDescriptor::new(apk.try_clone()?),
1705 &ParcelFileDescriptor::new(idsig.try_clone()?),
1706 )?;
1707 let modified_orig = idsig.metadata()?.modified()?;
1708 apk.rewind()?;
1709 idsig.rewind()?;
1710
1711 // Call the function again
1712 create_or_update_idsig_file(
1713 &ParcelFileDescriptor::new(apk.try_clone()?),
1714 &ParcelFileDescriptor::new(idsig.try_clone()?),
1715 )?;
1716 let modified_new = idsig.metadata()?.modified()?;
1717 assert!(modified_orig == modified_new, "idsig file was updated unnecessarily");
1718 Ok(())
1719 }
Nikita Ioffeaa6858c2023-07-04 01:37:41 +01001720
1721 #[test]
Shikha Panwar9ae2e622024-01-30 12:22:30 +00001722 fn test_create_or_update_idsig_on_non_empty_file() -> Result<()> {
1723 use std::io::Read;
1724
1725 // Pick any APK
1726 let mut apk = File::open("/system/priv-app/Shell/Shell.apk").unwrap();
1727 let idsig_empty = tempfile::tempfile().unwrap();
1728 let mut idsig_invalid = tempfile::tempfile().unwrap();
1729 idsig_invalid.write_all(b"Oops")?;
1730
1731 // Create new idsig
1732 create_or_update_idsig_file(
1733 &ParcelFileDescriptor::new(apk.try_clone()?),
1734 &ParcelFileDescriptor::new(idsig_empty.try_clone()?),
1735 )?;
1736 apk.rewind()?;
1737
1738 // Update idsig_invalid
1739 create_or_update_idsig_file(
1740 &ParcelFileDescriptor::new(apk.try_clone()?),
1741 &ParcelFileDescriptor::new(idsig_invalid.try_clone()?),
1742 )?;
1743
1744 // Ensure the 2 idsig files have same size!
1745 assert!(
1746 idsig_empty.metadata()?.len() == idsig_invalid.metadata()?.len(),
1747 "idsig files differ in size"
1748 );
1749 // Ensure the 2 idsig files have same content!
1750 for (b1, b2) in idsig_empty.bytes().zip(idsig_invalid.bytes()) {
1751 assert!(b1.unwrap() == b2.unwrap(), "idsig files differ")
1752 }
1753 Ok(())
1754 }
1755 #[test]
Nikita Ioffeaa6858c2023-07-04 01:37:41 +01001756 fn test_append_kernel_param_first_param() {
1757 let mut vm_config = VirtualMachineRawConfig { ..Default::default() };
1758 append_kernel_param("foo=1", &mut vm_config);
1759 assert_eq!(vm_config.params, Some("foo=1".to_owned()))
1760 }
1761
1762 #[test]
1763 fn test_append_kernel_param() {
1764 let mut vm_config =
1765 VirtualMachineRawConfig { params: Some("foo=5".to_owned()), ..Default::default() };
1766 append_kernel_param("bar=42", &mut vm_config);
1767 assert_eq!(vm_config.params, Some("foo=5 bar=42".to_owned()))
1768 }
Seungjae Yooec3bc522023-11-09 10:14:30 +09001769
Inseob Kim46257382024-01-03 15:41:22 +09001770 fn test_extract_os_name_from_config_path(
1771 path: &Path,
1772 expected_result: Option<&str>,
1773 ) -> Result<()> {
1774 let result = extract_os_name_from_config_path(path);
1775 if result.as_deref() != expected_result {
1776 bail!("Expected {:?} but was {:?}", expected_result, &result)
1777 }
1778 Ok(())
1779 }
1780
1781 #[test]
1782 fn test_extract_os_name_from_microdroid_config() -> Result<()> {
1783 test_extract_os_name_from_config_path(
1784 Path::new("/apex/com.android.virt/etc/microdroid.json"),
1785 Some("microdroid"),
1786 )
1787 }
1788
1789 #[test]
1790 fn test_extract_os_name_from_microdroid_gki_config() -> Result<()> {
1791 test_extract_os_name_from_config_path(
1792 Path::new("/apex/com.android.virt/etc/microdroid_gki-android14-6.1.json"),
1793 Some("microdroid_gki-android14-6.1"),
1794 )
1795 }
1796
1797 #[test]
1798 fn test_extract_os_name_from_invalid_path() -> Result<()> {
1799 test_extract_os_name_from_config_path(
1800 Path::new("/apex/com.android.virt/etc/microdroid.img"),
1801 None,
1802 )
1803 }
1804
1805 #[test]
1806 fn test_extract_os_name_from_configs() -> Result<()> {
1807 let tmp_dir = tempfile::TempDir::new()?;
1808 let tmp_dir_path = tmp_dir.path().to_owned();
1809
1810 let mut os_names: HashSet<String> = HashSet::new();
1811 os_names.insert("microdroid".to_owned());
1812 os_names.insert("microdroid_gki-android14-6.1".to_owned());
1813 os_names.insert("microdroid_gki-android15-6.1".to_owned());
1814
1815 // config files
1816 for os_name in &os_names {
1817 std::fs::write(tmp_dir_path.join(os_name.to_owned() + ".json"), b"")?;
1818 }
1819
1820 // fake files not related to configs
1821 std::fs::write(tmp_dir_path.join("microdroid_super.img"), b"")?;
1822 std::fs::write(tmp_dir_path.join("microdroid_foobar.apk"), b"")?;
1823
1824 let glob_pattern = match tmp_dir_path.join("microdroid*.json").to_str() {
1825 Some(s) => s.to_owned(),
1826 None => bail!("tmp_dir_path {:?} is not UTF-8", tmp_dir_path),
1827 };
1828
1829 let result = extract_os_names_from_configs(&glob_pattern)?;
1830 if result != os_names {
1831 bail!("Expected {:?} but was {:?}", os_names, result);
1832 }
1833 Ok(())
1834 }
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001835}