blob: acd182c95bc4a20ff992f0a599852acd2d6c39b2 [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};
David Brazdil49f96f52022-12-16 21:29:13 +000018use crate::atom::{
David Brazdil49f96f52022-12-16 21:29:13 +000019 write_vm_booted_stats, write_vm_creation_stats};
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000020use crate::composite::make_composite_image;
Inseob Kim7307a892023-09-14 13:37:58 +090021use crate::crosvm::{CrosvmConfig, DiskFile, PayloadState, VfioDevice, VmContext, VmInstance, VmState};
Jaewan Kim61f86142023-03-28 15:12:52 +090022use crate::debug_config::DebugConfig;
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,
Alan Stokes27f3ef02023-09-29 15:09:35 +010038 IVirtualizationService::FEATURE_MULTI_TENANT,
Nikita Ioffe631717e2023-09-05 13:38:07 +010039 IVirtualizationService::FEATURE_VENDOR_MODULES,
Alan Stokes7f27c0d2023-09-07 16:22:58 +010040 IVirtualizationService::FEATURE_DICE_CHANGES,
Keir Frasercdd4b112022-11-24 14:02:25 +000041 MemoryTrimLevel::MemoryTrimLevel,
Jiyong Park029977d2021-11-24 21:56:49 +090042 Partition::Partition,
Andrew Walbran6b650662021-09-07 13:13:23 +000043 PartitionType::PartitionType,
Inseob Kim0168b462022-12-27 14:54:35 +090044 VirtualMachineAppConfig::{DebugLevel::DebugLevel, Payload::Payload, VirtualMachineAppConfig},
Jooyung Han21e9b922021-06-26 04:14:16 +090045 VirtualMachineConfig::VirtualMachineConfig,
Andrew Walbran6b650662021-09-07 13:13:23 +000046 VirtualMachineDebugInfo::VirtualMachineDebugInfo,
Alan Stokes0d1ef782022-09-27 13:46:35 +010047 VirtualMachinePayloadConfig::VirtualMachinePayloadConfig,
Jooyung Han21e9b922021-06-26 04:14:16 +090048 VirtualMachineRawConfig::VirtualMachineRawConfig,
Andrew Walbran6b650662021-09-07 13:13:23 +000049 VirtualMachineState::VirtualMachineState,
Jooyung Han21e9b922021-06-26 04:14:16 +090050};
David Brazdilafc9a9e2023-01-12 16:08:10 +000051use android_system_virtualizationservice_internal::aidl::android::system::virtualizationservice_internal::IVirtualizationServiceInternal::IVirtualizationServiceInternal;
Seungjae Yoodd91f0f2022-11-09 15:25:21 +090052use android_system_virtualmachineservice::aidl::android::system::virtualmachineservice::IVirtualMachineService::{
David Brazdilafc9a9e2023-01-12 16:08:10 +000053 BnVirtualMachineService, IVirtualMachineService,
Seungjae Yoofd9a0622022-10-14 10:01:29 +090054};
Alan Stokes25f69362023-03-06 16:51:54 +000055use anyhow::{anyhow, bail, Context, Result};
Seungjae Yoofd9a0622022-10-14 10:01:29 +090056use apkverify::{HashAlgorithm, V4Signature};
Jiyong Parkd7bd2f22023-08-10 20:41:19 +090057use avflog::LogResult;
Alan Stokes0e82b502022-08-08 14:44:48 +010058use binder::{
David Brazdilafc9a9e2023-01-12 16:08:10 +000059 self, wait_for_interface, BinderFeatures, ExceptionCode, Interface, ParcelFileDescriptor,
60 Status, StatusCode, Strong,
Jiyong Park2227eaa2023-08-04 11:59:18 +090061 IntoBinderResult,
Andrew Walbrana89fc132021-03-17 17:08:36 +000062};
David Brazdilf50c7a62023-04-19 14:22:42 +000063use disk::QcowFile;
David Brazdil49f96f52022-12-16 21:29:13 +000064use lazy_static::lazy_static;
Seungjae Yooec3bc522023-11-09 10:14:30 +090065use libfdt::Fdt;
Seungjae Yoo0a8c84c2022-07-11 08:19:15 +000066use log::{debug, error, info, warn};
Seungjae Yoofd9a0622022-10-14 10:01:29 +090067use microdroid_payload_config::{OsConfig, Task, TaskType, VmPayloadConfig};
Inseob Kim0168b462022-12-27 14:54:35 +090068use nix::unistd::pipe;
David Brazdil73988ea2022-11-11 15:10:32 +000069use rpcbinder::RpcServer;
Alan Stokes25f69362023-03-06 16:51:54 +000070use rustutils::system_properties;
Jiyong Parkdcf17412022-02-08 15:07:23 +090071use semver::VersionReq;
Inseob Kim6ef80972023-07-20 17:23:36 +090072use std::collections::HashSet;
Andrew Walbrandff3b942021-06-09 15:20:36 +000073use std::convert::TryInto;
Seungjae Yooec3bc522023-11-09 10:14:30 +090074use std::ffi::{CStr, CString};
Inseob Kim6ef80972023-07-20 17:23:36 +090075use std::fs::{canonicalize, read_dir, remove_file, File, OpenOptions};
David Brazdilf50c7a62023-04-19 14:22:42 +000076use std::io::{BufRead, BufReader, Error, ErrorKind, Write};
Nikita Ioffe5776f082023-02-10 21:38:26 +000077use std::num::{NonZeroU16, NonZeroU32};
Andrew Walbrand3a84182021-09-07 14:48:52 +000078use std::os::unix::io::{FromRawFd, IntoRawFd};
David Brazdilafc9a9e2023-01-12 16:08:10 +000079use std::os::unix::raw::pid_t;
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +000080use std::path::{Path, PathBuf};
Andrew Walbran320b5602021-03-04 16:11:12 +000081use std::sync::{Arc, Mutex, Weak};
Seungjae Yooec3bc522023-11-09 10:14:30 +090082use vbmeta::VbMetaImage;
Andrew Walbrancc0db522021-07-12 17:03:42 +000083use vmconfig::VmConfig;
David Brazdilafc9a9e2023-01-12 16:08:10 +000084use vsock::VsockStream;
Jooyung Han35edb8f2021-07-01 16:17:16 +090085use zip::ZipArchive;
Andrew Walbrand6dce6f2021-03-05 16:39:08 +000086
David Brazdil41d1a872022-10-05 14:44:19 +010087/// The unique ID of a VM used (together with a port number) for vsock communication.
88pub type Cid = u32;
89
David Brazdil4b4c5102022-12-19 22:56:20 +000090pub const BINDER_SERVICE_IDENTIFIER: &str = "android.system.virtualizationservice";
91
Jooyung Han95884632021-07-06 22:27:54 +090092/// The size of zero.img.
93/// Gaps in composite disk images are filled with a shared zero.img.
94const ZERO_FILLER_SIZE: u64 = 4096;
95
David Brazdilf50c7a62023-04-19 14:22:42 +000096/// Magic string for the instance image
97const ANDROID_VM_INSTANCE_MAGIC: &str = "Android-VM-instance";
98
99/// Version of the instance image format
100const ANDROID_VM_INSTANCE_VERSION: u16 = 1;
101
Alan Stokes0d1ef782022-09-27 13:46:35 +0100102const MICRODROID_OS_NAME: &str = "microdroid";
103
Inseob Kim172f9eb2023-11-06 17:02:08 +0900104const MICRODROID_GKI_OS_NAME: &str = "microdroid_gki";
105
David Brazdilf50c7a62023-04-19 14:22:42 +0000106const UNFORMATTED_STORAGE_MAGIC: &str = "UNFORMATTED-STORAGE";
107
Seungjae Yooec3bc522023-11-09 10:14:30 +0900108/// Roughly estimated sufficient size for storing vendor public key into DTBO.
109const EMPTY_VENDOR_DT_OVERLAY_BUF_SIZE: usize = 10000;
110
David Brazdilf50c7a62023-04-19 14:22:42 +0000111/// crosvm requires all partitions to be a multiple of 4KiB.
112const PARTITION_GRANULARITY_BYTES: u64 = 4096;
113
David Brazdil49f96f52022-12-16 21:29:13 +0000114lazy_static! {
David Brazdil4b4c5102022-12-19 22:56:20 +0000115 pub static ref GLOBAL_SERVICE: Strong<dyn IVirtualizationServiceInternal> =
116 wait_for_interface(BINDER_SERVICE_IDENTIFIER)
117 .expect("Could not connect to VirtualizationServiceInternal");
David Brazdil49f96f52022-12-16 21:29:13 +0000118}
119
Nikita Ioffef1ce9872022-12-09 13:31:59 +0000120fn create_or_update_idsig_file(
121 input_fd: &ParcelFileDescriptor,
122 idsig_fd: &ParcelFileDescriptor,
123) -> Result<()> {
124 let mut input = clone_file(input_fd)?;
125 let metadata = input.metadata().context("failed to get input metadata")?;
126 if !metadata.is_file() {
127 bail!("input is not a regular file");
128 }
Alan Stokes25f69362023-03-06 16:51:54 +0000129 let mut sig =
130 V4Signature::create(&mut input, get_current_sdk()?, 4096, &[], HashAlgorithm::SHA256)
131 .context("failed to create idsig")?;
Nikita Ioffef1ce9872022-12-09 13:31:59 +0000132
133 let mut output = clone_file(idsig_fd)?;
Jiyong Park8d192952023-06-26 14:29:51 +0900134
135 // Optimization. We don't have to update idsig file whenever a VM is started. Don't update it,
136 // if the idsig file already has the same APK digest.
137 if output.metadata()?.len() > 0 {
138 if let Ok(out_sig) = V4Signature::from_idsig(&mut output) {
139 if out_sig.signing_info.apk_digest == sig.signing_info.apk_digest {
140 debug!("idsig {:?} is up-to-date with apk {:?}.", output, input);
141 return Ok(());
142 }
143 }
144 // if we fail to read v4signature from output, that's fine. User can pass a random file.
145 // We will anyway overwrite the file to the v4signature generated from input_fd.
146 }
147
Nikita Ioffec09b0492022-12-14 20:18:33 +0000148 output.set_len(0).context("failed to set_len on the idsig output")?;
149 sig.write_into(&mut output).context("failed to write idsig")?;
Nikita Ioffef1ce9872022-12-09 13:31:59 +0000150 Ok(())
151}
152
Alan Stokes25f69362023-03-06 16:51:54 +0000153fn get_current_sdk() -> Result<u32> {
154 let current_sdk = system_properties::read("ro.build.version.sdk")?;
155 let current_sdk = current_sdk.ok_or_else(|| anyhow!("SDK version missing"))?;
156 current_sdk.parse().context("Malformed SDK version")
157}
158
David Brazdil4b4c5102022-12-19 22:56:20 +0000159pub fn remove_temporary_files(path: &PathBuf) -> Result<()> {
160 for dir_entry in read_dir(path)? {
161 remove_file(dir_entry?.path())?;
162 }
163 Ok(())
David Brazdil528e0472022-10-10 15:06:02 +0100164}
165
David Brazdil528e0472022-10-10 15:06:02 +0100166/// Implementation of `IVirtualizationService`, the entry point of the AIDL service.
David Brazdil49f96f52022-12-16 21:29:13 +0000167#[derive(Debug, Default)]
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000168pub struct VirtualizationService {
Jiyong Park8611a6c2021-07-09 18:17:44 +0900169 state: Arc<Mutex<State>>,
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000170}
171
Shikha Panward8e35422021-10-11 13:51:27 +0000172impl Interface for VirtualizationService {
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000173 fn dump(&self, writer: &mut dyn Write, _args: &[&CStr]) -> Result<(), StatusCode> {
Shikha Panward8e35422021-10-11 13:51:27 +0000174 check_permission("android.permission.DUMP").or(Err(StatusCode::PERMISSION_DENIED))?;
175 let state = &mut *self.state.lock().unwrap();
176 let vms = state.vms();
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000177 writeln!(writer, "Running {0} VMs:", vms.len()).or(Err(StatusCode::UNKNOWN_ERROR))?;
Shikha Panward8e35422021-10-11 13:51:27 +0000178 for vm in vms {
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000179 writeln!(writer, "VM CID: {}", vm.cid).or(Err(StatusCode::UNKNOWN_ERROR))?;
180 writeln!(writer, "\tState: {:?}", vm.vm_state.lock().unwrap())
Shikha Panward8e35422021-10-11 13:51:27 +0000181 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000182 writeln!(writer, "\tPayload state {:?}", vm.payload_state())
Shikha Panward8e35422021-10-11 13:51:27 +0000183 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000184 writeln!(writer, "\tProtected: {}", vm.protected).or(Err(StatusCode::UNKNOWN_ERROR))?;
185 writeln!(writer, "\ttemporary_directory: {}", vm.temporary_directory.to_string_lossy())
Shikha Panward8e35422021-10-11 13:51:27 +0000186 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000187 writeln!(writer, "\trequester_uid: {}", vm.requester_uid)
Shikha Panward8e35422021-10-11 13:51:27 +0000188 .or(Err(StatusCode::UNKNOWN_ERROR))?;
Andrei Homescu0cf8e222023-11-09 04:27:55 +0000189 writeln!(writer, "\trequester_debug_pid: {}", vm.requester_debug_pid)
Shikha Panward8e35422021-10-11 13:51:27 +0000190 .or(Err(StatusCode::UNKNOWN_ERROR))?;
191 }
192 Ok(())
193 }
194}
Andrew Walbranf6bf6862021-05-21 12:41:13 +0000195impl IVirtualizationService for VirtualizationService {
Andrew Walbranf8d94112021-09-07 11:45:36 +0000196 /// Creates (but does not start) a new VM with the given configuration, assigning it the next
197 /// available CID.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000198 ///
199 /// Returns a binder `IVirtualMachine` object referring to it, as a handle for the client.
Andrew Walbranf8d94112021-09-07 11:45:36 +0000200 fn createVm(
Andrew Walbrana89fc132021-03-17 17:08:36 +0000201 &self,
Andrew Walbran3a5a9212021-05-04 17:09:08 +0000202 config: &VirtualMachineConfig,
Jiyong Parke6fb1672023-06-26 16:45:55 +0900203 console_out_fd: Option<&ParcelFileDescriptor>,
204 console_in_fd: Option<&ParcelFileDescriptor>,
Andrew Walbrana89fc132021-03-17 17:08:36 +0000205 log_fd: Option<&ParcelFileDescriptor>,
206 ) -> binder::Result<Strong<dyn IVirtualMachine>> {
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000207 let mut is_protected = false;
Jiyong Parke6fb1672023-06-26 16:45:55 +0900208 let ret = self.create_vm_internal(
209 config,
210 console_out_fd,
211 console_in_fd,
212 log_fd,
213 &mut is_protected,
214 );
Seungjae Yoo0a8c84c2022-07-11 08:19:15 +0000215 write_vm_creation_stats(config, is_protected, &ret);
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000216 ret
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000217 }
Andrew Walbran320b5602021-03-04 16:11:12 +0000218
Andrew Walbrandff3b942021-06-09 15:20:36 +0000219 /// Initialise an empty partition image of the given size to be used as a writable partition.
220 fn initializeWritablePartition(
221 &self,
222 image_fd: &ParcelFileDescriptor,
Alan Stokesff0005f2023-01-30 09:53:00 +0000223 size_bytes: i64,
Jiyong Park9dd389e2021-08-23 20:42:59 +0900224 partition_type: PartitionType,
Andrew Walbrandff3b942021-06-09 15:20:36 +0000225 ) -> binder::Result<()> {
Jiyong Park753553b2021-07-12 21:21:09 +0900226 check_manage_access()?;
Jiyong Park2227eaa2023-08-04 11:59:18 +0900227 let size_bytes = size_bytes
228 .try_into()
229 .with_context(|| format!("Invalid size: {}", size_bytes))
230 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000231 let size_bytes = round_up(size_bytes, PARTITION_GRANULARITY_BYTES);
232 let image = clone_file(image_fd)?;
233 // initialize the file. Any data in the file will be erased.
Jiyong Park2227eaa2023-08-04 11:59:18 +0900234 image.set_len(0).context("Failed to reset a file").or_service_specific_exception(-1)?;
235 let mut part = QcowFile::new(image, size_bytes)
236 .context("Failed to create QCOW2 image")
237 .or_service_specific_exception(-1)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000238
239 match partition_type {
240 PartitionType::RAW => Ok(()),
241 PartitionType::ANDROID_VM_INSTANCE => format_as_android_vm_instance(&mut part),
242 PartitionType::ENCRYPTEDSTORE => format_as_encryptedstore(&mut part),
243 _ => Err(Error::new(
244 ErrorKind::Unsupported,
245 format!("Unsupported partition type {:?}", partition_type),
246 )),
247 }
Jiyong Park2227eaa2023-08-04 11:59:18 +0900248 .with_context(|| format!("Failed to initialize partition as {:?}", partition_type))
249 .or_service_specific_exception(-1)?;
David Brazdilf50c7a62023-04-19 14:22:42 +0000250
251 Ok(())
Andrew Walbrandff3b942021-06-09 15:20:36 +0000252 }
253
Jiyong Park0a248432021-08-20 23:32:39 +0900254 /// Creates or update the idsig file by digesting the input APK file.
255 fn createOrUpdateIdsigFile(
256 &self,
257 input_fd: &ParcelFileDescriptor,
258 idsig_fd: &ParcelFileDescriptor,
259 ) -> binder::Result<()> {
Jiyong Parkc3ca24f2022-06-28 10:45:15 +0900260 check_manage_access()?;
261
Jiyong Park2227eaa2023-08-04 11:59:18 +0900262 create_or_update_idsig_file(input_fd, idsig_fd).or_service_specific_exception(-1)?;
Jiyong Park0a248432021-08-20 23:32:39 +0900263 Ok(())
264 }
265
Andrew Walbran320b5602021-03-04 16:11:12 +0000266 /// Get a list of all currently running VMs. This method is only intended for debug purposes,
267 /// and as such is only permitted from the shell user.
268 fn debugListVms(&self) -> binder::Result<Vec<VirtualMachineDebugInfo>> {
David Brazdil209074a2023-01-12 16:44:51 +0000269 // Delegate to the global service, including checking the debug permission.
David Brazdild4f51a52023-01-11 14:09:27 +0000270 GLOBAL_SERVICE.debugListVms()
Andrew Walbran320b5602021-03-04 16:11:12 +0000271 }
Inseob Kim53d0b212023-07-20 16:58:37 +0900272
273 /// Get a list of assignable device types.
274 fn getAssignableDevices(&self) -> binder::Result<Vec<AssignableDevice>> {
275 // Delegate to the global service, including checking the permission.
276 GLOBAL_SERVICE.getAssignableDevices()
277 }
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100278
279 /// Returns whether given feature is enabled
280 fn isFeatureEnabled(&self, feature: &str) -> binder::Result<bool> {
281 check_manage_access()?;
282
283 // This approach is quite cumbersome, but will do the work for the short term.
284 // TODO(b/298012279): make this scalable.
285 match feature {
Alan Stokes7f27c0d2023-09-07 16:22:58 +0100286 FEATURE_DICE_CHANGES => Ok(cfg!(dice_changes)),
Alan Stokes27f3ef02023-09-29 15:09:35 +0100287 FEATURE_MULTI_TENANT => Ok(cfg!(multi_tenant)),
Nikita Ioffe631717e2023-09-05 13:38:07 +0100288 FEATURE_VENDOR_MODULES => Ok(cfg!(vendor_modules)),
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100289 _ => {
Alan Stokes7f27c0d2023-09-07 16:22:58 +0100290 warn!("unknown feature {feature}");
Nikita Ioffef7c742a2023-09-04 16:57:59 +0100291 Ok(false)
292 }
293 }
294 }
Andrew Walbran320b5602021-03-04 16:11:12 +0000295}
296
Jiyong Park8611a6c2021-07-09 18:17:44 +0900297impl VirtualizationService {
298 pub fn init() -> VirtualizationService {
David Brazdil49f96f52022-12-16 21:29:13 +0000299 VirtualizationService::default()
Jiyong Park8611a6c2021-07-09 18:17:44 +0900300 }
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000301
David Brazdil209074a2023-01-12 16:44:51 +0000302 fn create_vm_context(
303 &self,
304 requester_debug_pid: pid_t,
305 ) -> binder::Result<(VmContext, Cid, PathBuf)> {
David Brazdil8cf8f482022-11-23 14:21:26 +0000306 const NUM_ATTEMPTS: usize = 5;
307
308 for _ in 0..NUM_ATTEMPTS {
Charisee96113f32023-01-26 09:00:42 +0000309 let vm_context = GLOBAL_SERVICE.allocateGlobalVmContext(requester_debug_pid)?;
David Brazdild4f51a52023-01-11 14:09:27 +0000310 let cid = vm_context.getCid()? as Cid;
311 let temp_dir: PathBuf = vm_context.getTemporaryDirectory()?.into();
David Brazdil8cf8f482022-11-23 14:21:26 +0000312 let service = VirtualMachineService::new_binder(self.state.clone(), cid).as_binder();
313
314 // Start VM service listening for connections from the new CID on port=CID.
David Brazdil8cf8f482022-11-23 14:21:26 +0000315 let port = cid;
David Brazdil3238da42022-11-18 10:04:51 +0000316 match RpcServer::new_vsock(service, cid, port) {
David Brazdil8cf8f482022-11-23 14:21:26 +0000317 Ok(vm_server) => {
318 vm_server.start();
David Brazdild4f51a52023-01-11 14:09:27 +0000319 return Ok((VmContext::new(vm_context, vm_server), cid, temp_dir));
David Brazdil8cf8f482022-11-23 14:21:26 +0000320 }
321 Err(err) => {
322 warn!("Could not start RpcServer on port {}: {}", port, err);
323 }
324 }
325 }
Jiyong Park2227eaa2023-08-04 11:59:18 +0900326 Err(anyhow!("Too many attempts to create VM context failed"))
327 .or_service_specific_exception(-1)
David Brazdil8cf8f482022-11-23 14:21:26 +0000328 }
329
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000330 fn create_vm_internal(
331 &self,
332 config: &VirtualMachineConfig,
Jiyong Parke6fb1672023-06-26 16:45:55 +0900333 console_out_fd: Option<&ParcelFileDescriptor>,
334 console_in_fd: Option<&ParcelFileDescriptor>,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000335 log_fd: Option<&ParcelFileDescriptor>,
336 is_protected: &mut bool,
337 ) -> binder::Result<Strong<dyn IVirtualMachine>> {
David Brazdil209074a2023-01-12 16:44:51 +0000338 let requester_uid = get_calling_uid();
339 let requester_debug_pid = get_calling_pid();
340
Nikita Ioffe631717e2023-09-05 13:38:07 +0100341 check_config_features(config)?;
342
David Brazdil209074a2023-01-12 16:44:51 +0000343 // Allocating VM context checks the MANAGE_VIRTUAL_MACHINE permission.
344 let (vm_context, cid, temporary_directory) = self.create_vm_context(requester_debug_pid)?;
Inseob Kim1119d702022-05-02 18:01:58 +0900345
Alan Stokes7bc146c2022-10-20 17:10:32 +0100346 let is_custom = match config {
347 VirtualMachineConfig::RawConfig(_) => true,
348 VirtualMachineConfig::AppConfig(config) => {
349 // Some features are reserved for platform apps only, even when using
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +0100350 // VirtualMachineAppConfig. Almost all of these features are grouped in the
351 // CustomConfig struct:
Alan Stokes7bc146c2022-10-20 17:10:32 +0100352 // - controlling CPUs;
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +0100353 // - specifying a config file in the APK; (this one is not part of CustomConfig)
Nikita Ioffe26c35ed2023-06-05 17:49:08 +0100354 // - gdbPort is set, meaning that crosvm will start a gdb server;
Inseob Kim6ef80972023-07-20 17:23:36 +0900355 // - using anything other than the default kernel;
356 // - specifying devices to be assigned.
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +0100357 config.customConfig.is_some() || matches!(config.payload, Payload::ConfigPath(_))
Inseob Kim1119d702022-05-02 18:01:58 +0900358 }
Alan Stokes7bc146c2022-10-20 17:10:32 +0100359 };
360 if is_custom {
361 check_use_custom_virtual_machine()?;
Inseob Kim1119d702022-05-02 18:01:58 +0900362 }
363
Nikita Ioffe5776f082023-02-10 21:38:26 +0000364 let gdb_port = extract_gdb_port(config);
365
366 // Additional permission checks if caller request gdb.
367 if gdb_port.is_some() {
368 check_gdb_allowed(config)?;
369 }
370
Seungjae Yooec3bc522023-11-09 10:14:30 +0900371 let vendor_public_key = extract_vendor_public_key(config)
372 .context("Failed to extract vendor public key")
373 .or_service_specific_exception(-1)?;
374 let dtbo_vendor = if let Some(vendor_public_key) = vendor_public_key {
375 let dtbo_for_vendor_image = temporary_directory.join("dtbo_vendor");
376 create_dtbo_for_vendor_image(&vendor_public_key, &dtbo_for_vendor_image)
377 .context("Failed to write vendor_public_key")
378 .or_service_specific_exception(-1)?;
379 let file = File::open(dtbo_for_vendor_image)
380 .context("Failed to open dtbo_vendor")
381 .or_service_specific_exception(-1)?;
382 Some(file)
383 } else {
384 None
385 };
386
Jaewan Kim61f86142023-03-28 15:12:52 +0900387 let debug_level = match config {
388 VirtualMachineConfig::AppConfig(config) => config.debugLevel,
389 _ => DebugLevel::NONE,
390 };
391 let debug_config = DebugConfig::new(debug_level);
392
393 let ramdump = if debug_config.is_ramdump_needed() {
Jiyong Parked180932023-02-24 19:55:41 +0900394 Some(prepare_ramdump_file(&temporary_directory)?)
395 } else {
396 None
397 };
398
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000399 let state = &mut *self.state.lock().unwrap();
Jiyong Parke6fb1672023-06-26 16:45:55 +0900400 let console_out_fd =
401 clone_or_prepare_logger_fd(&debug_config, console_out_fd, format!("Console({})", cid))?;
402 let console_in_fd = console_in_fd.map(clone_file).transpose()?;
Jaewan Kim61f86142023-03-28 15:12:52 +0900403 let log_fd = clone_or_prepare_logger_fd(&debug_config, log_fd, format!("Log({})", cid))?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000404
405 // Counter to generate unique IDs for temporary image files.
406 let mut next_temporary_image_id = 0;
407 // Files which are referred to from composite images. These must be mapped to the crosvm
408 // child process, and not closed before it is started.
409 let mut indirect_files = vec![];
410
Alan Stokes7bc146c2022-10-20 17:10:32 +0100411 let (is_app_config, config) = match config {
412 VirtualMachineConfig::RawConfig(config) => (false, BorrowedOrOwned::Borrowed(config)),
413 VirtualMachineConfig::AppConfig(config) => {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900414 let config = load_app_config(config, &debug_config, &temporary_directory)
415 .or_service_specific_exception_with(-1, |e| {
Jaewan Kim61f86142023-03-28 15:12:52 +0900416 *is_protected = config.protectedVm;
417 let message = format!("Failed to load app config: {:?}", e);
418 error!("{}", message);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900419 message
Jaewan Kim61f86142023-03-28 15:12:52 +0900420 })?;
Alan Stokes7bc146c2022-10-20 17:10:32 +0100421 (true, BorrowedOrOwned::Owned(config))
422 }
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000423 };
424 let config = config.as_ref();
425 *is_protected = config.protectedVm;
426
427 // Check if partition images are labeled incorrectly. This is to prevent random images
428 // which are not protected by the Android Verified Boot (e.g. bits downloaded by apps) from
Alan Stokes3e5eec12023-09-07 12:10:00 +0100429 // being loaded in a pVM. This applies to everything but the instance image in the raw
430 // config, and everything but the non-executable, generated partitions in the app
431 // config.
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000432 config
433 .disks
434 .iter()
435 .flat_map(|disk| disk.partitions.iter())
436 .filter(|partition| {
437 if is_app_config {
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100438 !is_safe_app_partition(&partition.label)
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000439 } else {
Alice Wangc206b9b2023-08-28 14:13:51 +0000440 !is_safe_raw_partition(&partition.label)
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000441 }
442 })
443 .try_for_each(check_label_for_partition)
Jiyong Park2227eaa2023-08-04 11:59:18 +0900444 .or_service_specific_exception(-1)?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000445
Alan Stokes185fe112023-01-10 16:20:55 +0000446 let kernel = maybe_clone_file(&config.kernel)?;
447 let initrd = maybe_clone_file(&config.initrd)?;
448
449 // In a protected VM, we require custom kernels to come from a trusted source (b/237054515).
450 if config.protectedVm {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900451 check_label_for_kernel_files(&kernel, &initrd).or_service_specific_exception(-1)?;
Alan Stokes185fe112023-01-10 16:20:55 +0000452 }
453
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000454 let zero_filler_path = temporary_directory.join("zero.img");
Jiyong Park2227eaa2023-08-04 11:59:18 +0900455 write_zero_filler(&zero_filler_path)
456 .context("Failed to make composite image")
457 .with_log()
458 .or_service_specific_exception(-1)?;
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000459
460 // Assemble disk images if needed.
461 let disks = config
462 .disks
463 .iter()
464 .map(|disk| {
465 assemble_disk_image(
466 disk,
467 &zero_filler_path,
468 &temporary_directory,
469 &mut next_temporary_image_id,
470 &mut indirect_files,
471 )
472 })
473 .collect::<Result<Vec<DiskFile>, _>>()?;
474
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000475 let (cpus, host_cpu_topology) = match config.cpuTopology {
476 CpuTopology::MATCH_HOST => (None, true),
477 CpuTopology::ONE_CPU => (NonZeroU32::new(1), false),
478 val => {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900479 return Err(anyhow!("Failed to parse CPU topology value {:?}", val))
480 .with_log()
481 .or_service_specific_exception(-1);
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000482 }
483 };
484
David Brazdil2dfefd12023-11-17 14:07:36 +0000485 let (vfio_devices, dtbo) = if !config.devices.is_empty() {
Inseob Kim6ef80972023-07-20 17:23:36 +0900486 let mut set = HashSet::new();
487 for device in config.devices.iter() {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900488 let path = canonicalize(device)
489 .with_context(|| format!("can't canonicalize {device}"))
490 .or_service_specific_exception(-1)?;
Inseob Kim6ef80972023-07-20 17:23:36 +0900491 if !set.insert(path) {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900492 return Err(anyhow!("duplicated device {device}"))
493 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Inseob Kim6ef80972023-07-20 17:23:36 +0900494 }
495 }
David Brazdil2dfefd12023-11-17 14:07:36 +0000496 let devices = GLOBAL_SERVICE
Inseob Kim7307a892023-09-14 13:37:58 +0900497 .bindDevicesToVfioDriver(&config.devices)?
498 .into_iter()
499 .map(|x| VfioDevice {
500 sysfs_path: PathBuf::from(&x.sysfsPath),
Jaewan Kim35e818d2023-10-18 05:36:38 +0000501 dtbo_label: x.dtboLabel,
Inseob Kim7307a892023-09-14 13:37:58 +0900502 })
David Brazdil2dfefd12023-11-17 14:07:36 +0000503 .collect::<Vec<_>>();
504 let dtbo_file = File::from(
505 GLOBAL_SERVICE
506 .getDtboFile()?
507 .as_ref()
508 .try_clone()
509 .context("Failed to create File from ParcelFileDescriptor")
510 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)?,
511 );
512 (devices, Some(dtbo_file))
Inseob Kim7307a892023-09-14 13:37:58 +0900513 } else {
David Brazdil2dfefd12023-11-17 14:07:36 +0000514 (vec![], None)
Inseob Kim7307a892023-09-14 13:37:58 +0900515 };
Inseob Kim6ef80972023-07-20 17:23:36 +0900516
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000517 // Actually start the VM.
518 let crosvm_config = CrosvmConfig {
519 cid,
Seungjae Yoo62085c02022-08-12 04:44:52 +0000520 name: config.name.clone(),
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000521 bootloader: maybe_clone_file(&config.bootloader)?,
Alan Stokes185fe112023-01-10 16:20:55 +0000522 kernel,
523 initrd,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000524 disks,
525 params: config.params.to_owned(),
526 protected: *is_protected,
Jaewan Kim61f86142023-03-28 15:12:52 +0900527 debug_config,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000528 memory_mib: config.memoryMib.try_into().ok().and_then(NonZeroU32::new),
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000529 cpus,
530 host_cpu_topology,
Jiyong Parkdfe16d62022-04-20 17:32:12 +0900531 task_profiles: config.taskProfiles.clone(),
Jiyong Parke6fb1672023-06-26 16:45:55 +0900532 console_out_fd,
533 console_in_fd,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000534 log_fd,
Jiyong Parked180932023-02-24 19:55:41 +0900535 ramdump,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000536 indirect_files,
537 platform_version: parse_platform_version_req(&config.platformVersion)?,
Jiyong Parke6ed0f92022-06-22 00:13:00 +0900538 detect_hangup: is_app_config,
Nikita Ioffe5776f082023-02-10 21:38:26 +0000539 gdb_port,
Inseob Kim7307a892023-09-14 13:37:58 +0900540 vfio_devices,
David Brazdil2dfefd12023-11-17 14:07:36 +0000541 dtbo,
Seungjae Yooec3bc522023-11-09 10:14:30 +0900542 dtbo_vendor,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000543 };
544 let instance = Arc::new(
David Brazdil528e0472022-10-10 15:06:02 +0100545 VmInstance::new(
546 crosvm_config,
547 temporary_directory,
548 requester_uid,
549 requester_debug_pid,
550 vm_context,
551 )
Jiyong Park2227eaa2023-08-04 11:59:18 +0900552 .with_context(|| format!("Failed to create VM with config {:?}", config))
553 .with_log()
554 .or_service_specific_exception(-1)?,
Shikha Panwar061aa2c2022-04-05 12:52:56 +0000555 );
556 state.add_vm(Arc::downgrade(&instance));
557 Ok(VirtualMachine::create(instance))
558 }
Jiyong Park8611a6c2021-07-09 18:17:44 +0900559}
560
Seungjae Yooec3bc522023-11-09 10:14:30 +0900561fn extract_vendor_public_key(config: &VirtualMachineConfig) -> Result<Option<Vec<u8>>> {
562 let VirtualMachineConfig::AppConfig(config) = config else {
563 return Ok(None);
564 };
565 let Some(custom_config) = &config.customConfig else {
566 return Ok(None);
567 };
568 let Some(file) = custom_config.vendorImage.as_ref() else {
569 return Ok(None);
570 };
571
572 let file = clone_file(file)?;
573 let size = file.metadata().context("Failed to get metadata from microdroid-vendor.img")?.len();
574 let vbmeta = VbMetaImage::verify_reader_region(&file, 0, size)
575 .context("Failed to get vbmeta from microdroid-vendor.img")?;
576 let vendor_public_key = vbmeta
577 .public_key()
578 .ok_or(anyhow!("No public key is extracted from microdroid-vendor.img"))?
579 .to_vec();
580
581 Ok(Some(vendor_public_key))
582}
583
584fn create_dtbo_for_vendor_image(vendor_public_key: &[u8], dtbo: &PathBuf) -> Result<()> {
585 if dtbo.exists() {
586 return Err(anyhow!("DTBO file already exists"));
587 }
588
589 let mut buf = vec![0; EMPTY_VENDOR_DT_OVERLAY_BUF_SIZE];
590 let fdt = Fdt::create_empty_tree(buf.as_mut_slice())
591 .map_err(|e| anyhow!("Failed to create FDT: {:?}", e))?;
592 let mut root = fdt.root_mut().map_err(|e| anyhow!("Failed to get root node: {:?}", e))?;
593
594 let fragment_node_name = CString::new("fragment@0")?;
595 let mut fragment_node = root
596 .add_subnode(fragment_node_name.as_c_str())
597 .map_err(|e| anyhow!("Failed to create fragment node: {:?}", e))?;
598 let target_path_prop_name = CString::new("target-path")?;
599 let target_path = CString::new("/")?;
600 fragment_node
601 .setprop(target_path_prop_name.as_c_str(), target_path.to_bytes_with_nul())
602 .map_err(|e| anyhow!("Failed to set target-path: {:?}", e))?;
603 let overlay_node_name = CString::new("__overlay__")?;
604 let mut overlay_node = fragment_node
605 .add_subnode(overlay_node_name.as_c_str())
606 .map_err(|e| anyhow!("Failed to create overlay node: {:?}", e))?;
607
608 let avf_node_name = CString::new("avf")?;
609 let mut avf_node = overlay_node
610 .add_subnode(avf_node_name.as_c_str())
611 .map_err(|e| anyhow!("Failed to create avf node: {:?}", e))?;
612 let vendor_public_key_name = CString::new("vendor_public_key")?;
613 avf_node
614 .setprop(vendor_public_key_name.as_c_str(), vendor_public_key)
615 .map_err(|e| anyhow!("Failed to set avf/vendor_public_key: {:?}", e))?;
616
617 fdt.pack().map_err(|e| anyhow!("Failed to pack fdt: {:?}", e))?;
618 let mut file = File::create(dtbo)?;
619 file.write_all(fdt.as_slice())?;
620 Ok(file.flush()?)
621}
622
Andrew Walbranfbb39d22021-07-28 17:01:25 +0000623fn write_zero_filler(zero_filler_path: &Path) -> Result<()> {
Jooyung Han95884632021-07-06 22:27:54 +0900624 let file = OpenOptions::new()
625 .create_new(true)
626 .read(true)
627 .write(true)
628 .open(zero_filler_path)
629 .with_context(|| "Failed to create zero.img")?;
630 file.set_len(ZERO_FILLER_SIZE)?;
Andrew Walbranfbb39d22021-07-28 17:01:25 +0000631 Ok(())
Jooyung Han95884632021-07-06 22:27:54 +0900632}
633
David Brazdilf50c7a62023-04-19 14:22:42 +0000634fn format_as_android_vm_instance(part: &mut dyn Write) -> std::io::Result<()> {
635 part.write_all(ANDROID_VM_INSTANCE_MAGIC.as_bytes())?;
636 part.write_all(&ANDROID_VM_INSTANCE_VERSION.to_le_bytes())?;
637 part.flush()
638}
639
640fn format_as_encryptedstore(part: &mut dyn Write) -> std::io::Result<()> {
641 part.write_all(UNFORMATTED_STORAGE_MAGIC.as_bytes())?;
642 part.flush()
643}
644
645fn round_up(input: u64, granularity: u64) -> u64 {
646 if granularity == 0 {
647 return input;
648 }
649 // If the input is absurdly large we round down instead of up; it's going to fail anyway.
650 let result = input.checked_add(granularity - 1).unwrap_or(input);
651 (result / granularity) * granularity
652}
653
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000654/// Given the configuration for a disk image, assembles the `DiskFile` to pass to crosvm.
655///
656/// This may involve assembling a composite disk from a set of partition images.
657fn assemble_disk_image(
658 disk: &DiskImage,
Jooyung Han95884632021-07-06 22:27:54 +0900659 zero_filler_path: &Path,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000660 temporary_directory: &Path,
661 next_temporary_image_id: &mut u64,
662 indirect_files: &mut Vec<File>,
Andrew Walbran806f1542021-06-10 14:07:12 +0000663) -> Result<DiskFile, Status> {
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000664 let image = if !disk.partitions.is_empty() {
665 if disk.image.is_some() {
666 warn!("DiskImage {:?} contains both image and partitions.", disk);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900667 return Err(anyhow!("DiskImage contains both image and partitions"))
668 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000669 }
670
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000671 let composite_image_filenames =
672 make_composite_image_filenames(temporary_directory, next_temporary_image_id);
673 let (image, partition_files) = make_composite_image(
674 &disk.partitions,
Jooyung Han95884632021-07-06 22:27:54 +0900675 zero_filler_path,
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000676 &composite_image_filenames.composite,
677 &composite_image_filenames.header,
678 &composite_image_filenames.footer,
679 )
Jiyong Park2227eaa2023-08-04 11:59:18 +0900680 .with_context(|| format!("Failed to make composite disk image with config {:?}", disk))
681 .with_log()
682 .or_service_specific_exception(-1)?;
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000683
684 // Pass the file descriptors for the various partition files to crosvm when it
685 // is run.
686 indirect_files.extend(partition_files);
687
688 image
689 } else if let Some(image) = &disk.image {
690 clone_file(image)?
691 } else {
692 warn!("DiskImage {:?} didn't contain image or partitions.", disk);
Jiyong Park2227eaa2023-08-04 11:59:18 +0900693 return Err(anyhow!("DiskImage didn't contain image or partitions."))
694 .or_binder_exception(ExceptionCode::ILLEGAL_ARGUMENT);
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000695 };
696
697 Ok(DiskFile { image, writable: disk.writable })
698}
699
Nikita Ioffeaa6858c2023-07-04 01:37:41 +0100700fn append_kernel_param(param: &str, vm_config: &mut VirtualMachineRawConfig) {
701 if let Some(ref mut params) = vm_config.params {
702 params.push(' ');
703 params.push_str(param)
704 } else {
705 vm_config.params = Some(param.to_owned())
706 }
707}
708
Inseob Kim172f9eb2023-11-06 17:02:08 +0900709fn is_valid_os(os_name: &str) -> bool {
710 if os_name == MICRODROID_OS_NAME {
711 return true;
712 }
713 if cfg!(vendor_modules) && os_name == MICRODROID_GKI_OS_NAME {
714 return true;
715 }
716 false
717}
718
Jooyung Han21e9b922021-06-26 04:14:16 +0900719fn load_app_config(
720 config: &VirtualMachineAppConfig,
Jaewan Kim61f86142023-03-28 15:12:52 +0900721 debug_config: &DebugConfig,
Jooyung Han21e9b922021-06-26 04:14:16 +0900722 temporary_directory: &Path,
Jooyung Hanadfb76c2021-06-28 17:29:30 +0900723) -> Result<VirtualMachineRawConfig> {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000724 let apk_file = clone_file(config.apk.as_ref().unwrap())?;
725 let idsig_file = clone_file(config.idsig.as_ref().unwrap())?;
Jiyong Park8d081812021-07-23 17:45:04 +0900726 let instance_file = clone_file(config.instanceImage.as_ref().unwrap())?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900727
Shikha Panwar22e70452022-10-10 18:32:55 +0000728 let storage_image = if let Some(file) = config.encryptedStorageImage.as_ref() {
729 Some(clone_file(file)?)
730 } else {
731 None
732 };
733
Alan Stokes0d1ef782022-09-27 13:46:35 +0100734 let vm_payload_config = match &config.payload {
735 Payload::ConfigPath(config_path) => {
736 load_vm_payload_config_from_file(&apk_file, config_path.as_str())
737 .with_context(|| format!("Couldn't read config from {}", config_path))?
738 }
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000739 Payload::PayloadConfig(payload_config) => create_vm_payload_config(payload_config)?,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100740 };
Jooyung Han21e9b922021-06-26 04:14:16 +0900741
Inseob Kim172f9eb2023-11-06 17:02:08 +0900742 // For now, the only supported OS is Microdroid and Microdroid GKI
Alan Stokes0d1ef782022-09-27 13:46:35 +0100743 let os_name = vm_payload_config.os.name.as_str();
Inseob Kim172f9eb2023-11-06 17:02:08 +0900744 if !is_valid_os(os_name) {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000745 bail!("Unknown OS \"{}\"", os_name);
Jooyung Han35edb8f2021-07-01 16:17:16 +0900746 }
Andrew Walbrancc0db522021-07-12 17:03:42 +0000747
748 // It is safe to construct a filename based on the os_name because we've already checked that it
749 // is one of the allowed values.
Jooyung Han21e9b922021-06-26 04:14:16 +0900750 let vm_config_path = PathBuf::from(format!("/apex/com.android.virt/etc/{}.json", os_name));
751 let vm_config_file = File::open(vm_config_path)?;
Andrew Walbrancc0db522021-07-12 17:03:42 +0000752 let mut vm_config = VmConfig::load(&vm_config_file)?.to_parcelable()?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900753
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +0100754 if let Some(custom_config) = &config.customConfig {
755 if let Some(file) = custom_config.customKernelImage.as_ref() {
756 vm_config.kernel = Some(ParcelFileDescriptor::new(clone_file(file)?))
757 }
758 vm_config.taskProfiles = custom_config.taskProfiles.clone();
759 vm_config.gdbPort = custom_config.gdbPort;
Nikita Ioffe5dfddf22023-06-29 16:11:26 +0100760
761 if let Some(file) = custom_config.vendorImage.as_ref() {
Nikita Ioffeaa6858c2023-07-04 01:37:41 +0100762 add_microdroid_vendor_image(clone_file(file)?, &mut vm_config);
763 append_kernel_param("androidboot.microdroid.mount_vendor=1", &mut vm_config)
Nikita Ioffe5dfddf22023-06-29 16:11:26 +0100764 }
Inseob Kim6ef80972023-07-20 17:23:36 +0900765
766 vm_config.devices = custom_config.devices.clone();
Nikita Ioffe26c35ed2023-06-05 17:49:08 +0100767 }
768
Andrew Walbrancc045902021-07-27 16:06:17 +0000769 if config.memoryMib > 0 {
770 vm_config.memoryMib = config.memoryMib;
Andrew Walbran45bcb0c2021-07-14 15:02:06 +0000771 }
772
Seungjae Yoo62085c02022-08-12 04:44:52 +0000773 vm_config.name = config.name.clone();
Andrew Walbran3994f002022-01-27 17:33:45 +0000774 vm_config.protectedVm = config.protectedVm;
David Brazdil7d1e5ec2023-02-06 17:56:29 +0000775 vm_config.cpuTopology = config.cpuTopology;
Jiyong Park032615f2022-01-10 13:55:34 +0900776
Shikha Panwar22e70452022-10-10 18:32:55 +0000777 // Microdroid takes additional init ramdisk & (optionally) storage image
Inseob Kim172f9eb2023-11-06 17:02:08 +0900778 add_microdroid_system_images(config, instance_file, storage_image, os_name, &mut vm_config)?;
Shikha Panwar22e70452022-10-10 18:32:55 +0000779
780 // Include Microdroid payload disk (contains apks, idsigs) in vm config
781 add_microdroid_payload_images(
Alan Stokes0d1ef782022-09-27 13:46:35 +0100782 config,
Jaewan Kim61f86142023-03-28 15:12:52 +0900783 debug_config,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100784 temporary_directory,
785 apk_file,
786 idsig_file,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100787 &vm_payload_config,
788 &mut vm_config,
789 )?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900790
Andrew Walbrancc0db522021-07-12 17:03:42 +0000791 Ok(vm_config)
Jooyung Han21e9b922021-06-26 04:14:16 +0900792}
793
Alan Stokes0d1ef782022-09-27 13:46:35 +0100794fn load_vm_payload_config_from_file(apk_file: &File, config_path: &str) -> Result<VmPayloadConfig> {
795 let mut apk_zip = ZipArchive::new(apk_file)?;
796 let config_file = apk_zip.by_name(config_path)?;
797 Ok(serde_json::from_reader(config_file)?)
798}
799
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000800fn create_vm_payload_config(
801 payload_config: &VirtualMachinePayloadConfig,
802) -> Result<VmPayloadConfig> {
Alan Stokes0d1ef782022-09-27 13:46:35 +0100803 // There isn't an actual config file. Construct a synthetic VmPayloadConfig from the explicit
804 // parameters we've been given. Microdroid will do something equivalent inside the VM using the
805 // payload config that we send it via the metadata file.
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000806
807 let payload_binary_name = &payload_config.payloadBinaryName;
808 if payload_binary_name.contains('/') {
809 bail!("Payload binary name must not specify a path: {payload_binary_name}");
810 }
811
812 let task = Task { type_: TaskType::MicrodroidLauncher, command: payload_binary_name.clone() };
Inseob Kim172f9eb2023-11-06 17:02:08 +0900813 let name = payload_config.osName.clone();
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000814 Ok(VmPayloadConfig {
Inseob Kim172f9eb2023-11-06 17:02:08 +0900815 os: OsConfig { name },
Alan Stokes0d1ef782022-09-27 13:46:35 +0100816 task: Some(task),
817 apexes: vec![],
818 extra_apks: vec![],
819 prefer_staged: false,
Inseob Kimab1037d2023-02-08 17:03:31 +0900820 export_tombstones: None,
Alan Stokes0d1ef782022-09-27 13:46:35 +0100821 enable_authfs: false,
Alan Stokes8f12f2b2023-01-09 09:19:20 +0000822 })
Alan Stokes0d1ef782022-09-27 13:46:35 +0100823}
824
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000825/// Generates a unique filename to use for a composite disk image.
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000826fn make_composite_image_filenames(
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000827 temporary_directory: &Path,
828 next_temporary_image_id: &mut u64,
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000829) -> CompositeImageFilenames {
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000830 let id = *next_temporary_image_id;
831 *next_temporary_image_id += 1;
Andrew Walbran3eca16c2021-06-14 11:15:14 +0000832 CompositeImageFilenames {
833 composite: temporary_directory.join(format!("composite-{}.img", id)),
834 header: temporary_directory.join(format!("composite-{}-header.img", id)),
835 footer: temporary_directory.join(format!("composite-{}-footer.img", id)),
836 }
837}
838
839/// Filenames for a composite disk image, including header and footer partitions.
840#[derive(Clone, Debug, Eq, PartialEq)]
841struct CompositeImageFilenames {
842 /// The composite disk image itself.
843 composite: PathBuf,
844 /// The header partition image.
845 header: PathBuf,
846 /// The footer partition image.
847 footer: PathBuf,
Andrew Walbranf5fbb7d2021-05-12 17:15:48 +0000848}
849
Jiyong Park753553b2021-07-12 21:21:09 +0900850/// Checks whether the caller has a specific permission
851fn check_permission(perm: &str) -> binder::Result<()> {
David Brazdil1f530702022-10-03 12:18:10 +0100852 let calling_pid = get_calling_pid();
853 let calling_uid = get_calling_uid();
Jiyong Park753553b2021-07-12 21:21:09 +0900854 // Root can do anything
855 if calling_uid == 0 {
856 return Ok(());
857 }
858 let perm_svc: Strong<dyn IPermissionController::IPermissionController> =
859 binder::get_interface("permission")?;
860 if perm_svc.checkPermission(perm, calling_pid, calling_uid as i32)? {
Andrew Walbran806f1542021-06-10 14:07:12 +0000861 Ok(())
862 } else {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900863 Err(anyhow!("does not have the {} permission", perm))
864 .or_binder_exception(ExceptionCode::SECURITY)
Andrew Walbran806f1542021-06-10 14:07:12 +0000865 }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000866}
867
Jiyong Park753553b2021-07-12 21:21:09 +0900868/// Check whether the caller of the current Binder method is allowed to manage VMs
869fn check_manage_access() -> binder::Result<()> {
870 check_permission("android.permission.MANAGE_VIRTUAL_MACHINE")
871}
872
Inseob Kim1119d702022-05-02 18:01:58 +0900873/// Check whether the caller of the current Binder method is allowed to create custom VMs
874fn check_use_custom_virtual_machine() -> binder::Result<()> {
875 check_permission("android.permission.USE_CUSTOM_VIRTUAL_MACHINE")
876}
877
Alan Stokes185fe112023-01-10 16:20:55 +0000878/// Return whether a partition is exempt from selinux label checks, because we know that it does
879/// not contain code and is likely to be generated in an app-writable directory.
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100880fn is_safe_app_partition(label: &str) -> bool {
Shikha Panwara2ff8c52022-11-30 19:25:46 +0000881 // See add_microdroid_system_images & add_microdroid_payload_images in payload.rs.
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100882 label == "vm-instance"
Shikha Panwara2ff8c52022-11-30 19:25:46 +0000883 || label == "encryptedstore"
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100884 || label == "microdroid-apk-idsig"
885 || label == "payload-metadata"
886 || label.starts_with("extra-idsig-")
887}
888
Alice Wangc206b9b2023-08-28 14:13:51 +0000889/// Returns whether a partition with the given label is safe for a raw config VM.
890fn is_safe_raw_partition(label: &str) -> bool {
891 label == "vm-instance"
892}
893
Alan Stokes185fe112023-01-10 16:20:55 +0000894/// Check that a file SELinux label is acceptable.
895///
896/// 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 +0900897/// system or vendor, do not have write access to.
Alan Stokes185fe112023-01-10 16:20:55 +0000898///
899/// Note that sepolicy must also grant read access for these types to both virtualization
900/// service and crosvm.
901///
902/// App private data files are deliberately excluded, to avoid arbitrary payloads being run on
903/// user devices (W^X).
904fn check_label_is_allowed(context: &SeContext) -> Result<()> {
905 match context.selinux_type()? {
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100906 | "apk_data_file" // APKs of an installed app
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100907 | "shell_data_file" // test files created via adb shell
Alan Stokesfe4bb0c2023-03-20 14:15:36 +0000908 | "staging_data_file" // updated/staged APEX images
909 | "system_file" // immutable dm-verity protected partition
910 | "virtualizationservice_data_file" // files created by VS / VirtMgr
Seungjae Yoo2b74c442023-11-15 18:05:07 +0900911 | "vendor_microdroid_file" // immutable dm-verity protected partition (/vendor/etc/avf/microdroid/.*)
Alan Stokes53cc5ca2022-08-30 14:28:19 +0100912 => Ok(()),
Alan Stokes185fe112023-01-10 16:20:55 +0000913 _ => bail!("Label {} is not allowed", context),
Jiyong Park029977d2021-11-24 21:56:49 +0900914 }
915}
916
Alan Stokes185fe112023-01-10 16:20:55 +0000917fn check_label_for_partition(partition: &Partition) -> Result<()> {
918 let file = partition.image.as_ref().unwrap().as_ref();
919 check_label_is_allowed(&getfilecon(file)?)
920 .with_context(|| format!("Partition {} invalid", &partition.label))
921}
922
923fn check_label_for_kernel_files(kernel: &Option<File>, initrd: &Option<File>) -> Result<()> {
924 if let Some(f) = kernel {
925 check_label_for_file(f, "kernel")?;
926 }
927 if let Some(f) = initrd {
928 check_label_for_file(f, "initrd")?;
929 }
930 Ok(())
931}
932fn check_label_for_file(file: &File, name: &str) -> Result<()> {
933 check_label_is_allowed(&getfilecon(file)?).with_context(|| format!("{} file invalid", name))
934}
935
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000936/// Implementation of the AIDL `IVirtualMachine` interface. Used as a handle to a VM.
937#[derive(Debug)]
938struct VirtualMachine {
939 instance: Arc<VmInstance>,
940}
941
942impl VirtualMachine {
943 fn create(instance: Arc<VmInstance>) -> Strong<dyn IVirtualMachine> {
David Brazdil4b4c5102022-12-19 22:56:20 +0000944 BnVirtualMachine::new_binder(VirtualMachine { instance }, BinderFeatures::default())
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000945 }
946}
947
948impl Interface for VirtualMachine {}
949
950impl IVirtualMachine for VirtualMachine {
951 fn getCid(&self) -> binder::Result<i32> {
Jiyong Park753553b2021-07-12 21:21:09 +0900952 // Don't check permission. The owner of the VM might have passed this binder object to
953 // others.
Andrew Walbrand6dce6f2021-03-05 16:39:08 +0000954 Ok(self.instance.cid as i32)
955 }
Andrew Walbrandae07162021-03-12 17:05:20 +0000956
Andrew Walbran6b650662021-09-07 13:13:23 +0000957 fn getState(&self) -> binder::Result<VirtualMachineState> {
Jiyong Park753553b2021-07-12 21:21:09 +0900958 // Don't check permission. The owner of the VM might have passed this binder object to
959 // others.
Andrew Walbran6b650662021-09-07 13:13:23 +0000960 Ok(get_state(&self.instance))
Andrew Walbrandae07162021-03-12 17:05:20 +0000961 }
962
963 fn registerCallback(
964 &self,
965 callback: &Strong<dyn IVirtualMachineCallback>,
966 ) -> binder::Result<()> {
Jiyong Park753553b2021-07-12 21:21:09 +0900967 // Don't check permission. The owner of the VM might have passed this binder object to
968 // others.
969 //
Andrew Walbrandae07162021-03-12 17:05:20 +0000970 // TODO: Should this give an error if the VM is already dead?
971 self.instance.callbacks.add(callback.clone());
972 Ok(())
973 }
Andrew Walbrancbe8b082021-08-06 15:42:11 +0000974
Andrew Walbranf8d94112021-09-07 11:45:36 +0000975 fn start(&self) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900976 self.instance
977 .start()
978 .with_context(|| format!("Error starting VM with CID {}", self.instance.cid))
979 .with_log()
980 .or_service_specific_exception(-1)
Andrew Walbranf8d94112021-09-07 11:45:36 +0000981 }
982
Inseob Kima446f802022-07-11 19:46:37 +0900983 fn stop(&self) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900984 self.instance
985 .kill()
986 .with_context(|| format!("Error stopping VM with CID {}", self.instance.cid))
987 .with_log()
988 .or_service_specific_exception(-1)
Inseob Kima446f802022-07-11 19:46:37 +0900989 }
990
Keir Frasercdd4b112022-11-24 14:02:25 +0000991 fn onTrimMemory(&self, level: MemoryTrimLevel) -> binder::Result<()> {
Jiyong Park2227eaa2023-08-04 11:59:18 +0900992 self.instance
993 .trim_memory(level)
994 .with_context(|| format!("Error trimming VM with CID {}", self.instance.cid))
995 .with_log()
996 .or_service_specific_exception(-1)
Keir Frasercdd4b112022-11-24 14:02:25 +0000997 }
998
Andrew Walbrancbe8b082021-08-06 15:42:11 +0000999 fn connectVsock(&self, port: i32) -> binder::Result<ParcelFileDescriptor> {
Andrew Walbranf8d94112021-09-07 11:45:36 +00001000 if !matches!(&*self.instance.vm_state.lock().unwrap(), VmState::Running { .. }) {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001001 return Err(anyhow!("VM is not running")).or_service_specific_exception(-1);
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001002 }
Alan Stokes10c47672022-12-13 17:17:08 +00001003 let port = port as u32;
1004 if port < 1024 {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001005 return Err(anyhow!("Can't connect to privileged port {port}"))
1006 .or_service_specific_exception(-1);
Alan Stokes10c47672022-12-13 17:17:08 +00001007 }
Jiyong Park2227eaa2023-08-04 11:59:18 +09001008 let stream = VsockStream::connect_with_cid_port(self.instance.cid, port)
1009 .context("Failed to connect")
1010 .or_service_specific_exception(-1)?;
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001011 Ok(vsock_stream_to_pfd(stream))
1012 }
Andrew Walbrandae07162021-03-12 17:05:20 +00001013}
1014
1015impl Drop for VirtualMachine {
1016 fn drop(&mut self) {
1017 debug!("Dropping {:?}", self);
Inseob Kima446f802022-07-11 19:46:37 +09001018 if let Err(e) = self.instance.kill() {
1019 debug!("Error stopping dropped VM with CID {}: {:?}", self.instance.cid, e);
1020 }
Andrew Walbrandae07162021-03-12 17:05:20 +00001021 }
1022}
1023
1024/// A set of Binders to be called back in response to various events on the VM, such as when it
1025/// dies.
1026#[derive(Debug, Default)]
1027pub struct VirtualMachineCallbacks(Mutex<Vec<Strong<dyn IVirtualMachineCallback>>>);
1028
1029impl VirtualMachineCallbacks {
Jiyong Park8611a6c2021-07-09 18:17:44 +09001030 /// Call all registered callbacks to notify that the payload has started.
David Brazdil451cc962022-10-14 14:08:12 +01001031 pub fn notify_payload_started(&self, cid: Cid) {
Jiyong Park8611a6c2021-07-09 18:17:44 +09001032 let callbacks = &*self.0.lock().unwrap();
Jiyong Park8611a6c2021-07-09 18:17:44 +09001033 for callback in callbacks {
David Brazdil451cc962022-10-14 14:08:12 +01001034 if let Err(e) = callback.onPayloadStarted(cid as i32) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001035 error!("Error notifying payload start event from VM CID {}: {:?}", cid, e);
Jiyong Park8611a6c2021-07-09 18:17:44 +09001036 }
1037 }
1038 }
1039
Inseob Kim14cb8692021-08-31 21:50:39 +09001040 /// Call all registered callbacks to notify that the payload is ready to serve.
1041 pub fn notify_payload_ready(&self, cid: Cid) {
1042 let callbacks = &*self.0.lock().unwrap();
1043 for callback in callbacks {
1044 if let Err(e) = callback.onPayloadReady(cid as i32) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001045 error!("Error notifying payload ready event from VM CID {}: {:?}", cid, e);
Inseob Kim14cb8692021-08-31 21:50:39 +09001046 }
1047 }
1048 }
1049
Inseob Kim2444af92021-08-31 01:22:50 +09001050 /// Call all registered callbacks to notify that the payload has finished.
1051 pub fn notify_payload_finished(&self, cid: Cid, exit_code: i32) {
1052 let callbacks = &*self.0.lock().unwrap();
1053 for callback in callbacks {
1054 if let Err(e) = callback.onPayloadFinished(cid as i32, exit_code) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001055 error!("Error notifying payload finish event from VM CID {}: {:?}", cid, e);
Inseob Kim2444af92021-08-31 01:22:50 +09001056 }
1057 }
1058 }
1059
Jooyung Handd0a1732021-11-23 15:26:20 +09001060 /// Call all registered callbacks to say that the VM encountered an error.
Alan Stokes2bead0d2022-09-05 16:58:34 +01001061 pub fn notify_error(&self, cid: Cid, error_code: ErrorCode, message: &str) {
Jooyung Handd0a1732021-11-23 15:26:20 +09001062 let callbacks = &*self.0.lock().unwrap();
1063 for callback in callbacks {
1064 if let Err(e) = callback.onError(cid as i32, error_code, message) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001065 error!("Error notifying error event from VM CID {}: {:?}", cid, e);
Jooyung Handd0a1732021-11-23 15:26:20 +09001066 }
1067 }
1068 }
1069
Andrew Walbrandae07162021-03-12 17:05:20 +00001070 /// Call all registered callbacks to say that the VM has died.
Andrew Walbranc92d35f2022-01-12 12:45:19 +00001071 pub fn callback_on_died(&self, cid: Cid, reason: DeathReason) {
Andrew Walbrandae07162021-03-12 17:05:20 +00001072 let callbacks = &*self.0.lock().unwrap();
1073 for callback in callbacks {
Andrew Walbranc92d35f2022-01-12 12:45:19 +00001074 if let Err(e) = callback.onDied(cid as i32, reason) {
Alan Stokes70ccf162022-07-08 11:05:03 +01001075 error!("Error notifying exit of VM CID {}: {:?}", cid, e);
Andrew Walbrandae07162021-03-12 17:05:20 +00001076 }
1077 }
1078 }
1079
1080 /// Add a new callback to the set.
1081 fn add(&self, callback: Strong<dyn IVirtualMachineCallback>) {
1082 self.0.lock().unwrap().push(callback);
1083 }
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001084}
1085
Andrew Walbranf6bf6862021-05-21 12:41:13 +00001086/// The mutable state of the VirtualizationService. There should only be one instance of this
1087/// struct.
Chris Wailes641fc4a2021-12-01 15:03:21 -08001088#[derive(Debug, Default)]
Andrew Walbrand6dce6f2021-03-05 16:39:08 +00001089struct State {
Alan Stokes3e5eec12023-09-07 12:10:00 +01001090 /// The VMs which have been started. When VMs are started a weak reference is added to this
1091 /// list while a strong reference is returned to the caller over Binder. Once all copies of
1092 /// the Binder client are dropped the weak reference here will become invalid, and will be
1093 /// removed from the list opportunistically the next time `add_vm` is called.
Andrew Walbran320b5602021-03-04 16:11:12 +00001094 vms: Vec<Weak<VmInstance>>,
1095}
1096
1097impl State {
Andrew Walbrandae07162021-03-12 17:05:20 +00001098 /// Get a list of VMs which still have Binder references to them.
Andrew Walbran320b5602021-03-04 16:11:12 +00001099 fn vms(&self) -> Vec<Arc<VmInstance>> {
1100 // Attempt to upgrade the weak pointers to strong pointers.
1101 self.vms.iter().filter_map(Weak::upgrade).collect()
1102 }
1103
1104 /// Add a new VM to the list.
1105 fn add_vm(&mut self, vm: Weak<VmInstance>) {
1106 // Garbage collect any entries from the stored list which no longer exist.
1107 self.vms.retain(|vm| vm.strong_count() > 0);
1108
1109 // Actually add the new VM.
1110 self.vms.push(vm);
1111 }
David Brazdil3c2ddef2021-03-18 13:09:57 +00001112
Jiyong Park8611a6c2021-07-09 18:17:44 +09001113 /// Get a VM that corresponds to the given cid
1114 fn get_vm(&self, cid: Cid) -> Option<Arc<VmInstance>> {
1115 self.vms().into_iter().find(|vm| vm.cid == cid)
1116 }
Jiyong Parkd50a0242021-09-16 21:00:14 +09001117}
1118
Andrew Walbran6b650662021-09-07 13:13:23 +00001119/// Gets the `VirtualMachineState` of the given `VmInstance`.
1120fn get_state(instance: &VmInstance) -> VirtualMachineState {
Andrew Walbranf8d94112021-09-07 11:45:36 +00001121 match &*instance.vm_state.lock().unwrap() {
1122 VmState::NotStarted { .. } => VirtualMachineState::NOT_STARTED,
1123 VmState::Running { .. } => match instance.payload_state() {
Andrew Walbran6b650662021-09-07 13:13:23 +00001124 PayloadState::Starting => VirtualMachineState::STARTING,
1125 PayloadState::Started => VirtualMachineState::STARTED,
1126 PayloadState::Ready => VirtualMachineState::READY,
1127 PayloadState::Finished => VirtualMachineState::FINISHED,
Jiyong Parka4eebde2022-07-12 18:01:12 +09001128 PayloadState::Hangup => VirtualMachineState::DEAD,
Andrew Walbranf8d94112021-09-07 11:45:36 +00001129 },
1130 VmState::Dead => VirtualMachineState::DEAD,
1131 VmState::Failed => VirtualMachineState::DEAD,
Andrew Walbran6b650662021-09-07 13:13:23 +00001132 }
1133}
1134
David Brazdilf50c7a62023-04-19 14:22:42 +00001135/// Converts a `&ParcelFileDescriptor` to a `File` by cloning the file.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001136pub fn clone_file(file: &ParcelFileDescriptor) -> binder::Result<File> {
1137 file.as_ref()
1138 .try_clone()
1139 .context("Failed to clone File from ParcelFileDescriptor")
1140 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)
Andrei Homescu11333c62023-11-09 04:26:39 +00001141 .map(File::from)
David Brazdilf50c7a62023-04-19 14:22:42 +00001142}
1143
Andrew Walbrand3a84182021-09-07 14:48:52 +00001144/// Converts an `&Option<ParcelFileDescriptor>` to an `Option<File>` by cloning the file.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001145fn maybe_clone_file(file: &Option<ParcelFileDescriptor>) -> binder::Result<Option<File>> {
Andrew Walbrand3a84182021-09-07 14:48:52 +00001146 file.as_ref().map(clone_file).transpose()
1147}
1148
Andrew Walbrancbe8b082021-08-06 15:42:11 +00001149/// Converts a `VsockStream` to a `ParcelFileDescriptor`.
1150fn vsock_stream_to_pfd(stream: VsockStream) -> ParcelFileDescriptor {
1151 // SAFETY: ownership is transferred from stream to f
1152 let f = unsafe { File::from_raw_fd(stream.into_raw_fd()) };
1153 ParcelFileDescriptor::new(f)
1154}
1155
Jiyong Parkdcf17412022-02-08 15:07:23 +09001156/// Parses the platform version requirement string.
Jiyong Park2227eaa2023-08-04 11:59:18 +09001157fn parse_platform_version_req(s: &str) -> binder::Result<VersionReq> {
1158 VersionReq::parse(s)
1159 .with_context(|| format!("Invalid platform version requirement {}", s))
1160 .or_binder_exception(ExceptionCode::BAD_PARCELABLE)
Jiyong Parkdcf17412022-02-08 15:07:23 +09001161}
1162
Jiyong Parked180932023-02-24 19:55:41 +09001163/// Create the empty ramdump file
1164fn prepare_ramdump_file(temporary_directory: &Path) -> binder::Result<File> {
1165 // `ramdump_write` is sent to crosvm and will be the backing store for the /dev/hvc1 where
1166 // VM will emit ramdump to. `ramdump_read` will be sent back to the client (i.e. the VM
1167 // owner) for readout.
1168 let ramdump_path = temporary_directory.join("ramdump");
Jiyong Park2227eaa2023-08-04 11:59:18 +09001169 let ramdump = File::create(ramdump_path)
1170 .context("Failed to prepare ramdump file")
1171 .with_log()
1172 .or_service_specific_exception(-1)?;
Jiyong Parked180932023-02-24 19:55:41 +09001173 Ok(ramdump)
1174}
1175
Nikita Ioffe5776f082023-02-10 21:38:26 +00001176fn is_protected(config: &VirtualMachineConfig) -> bool {
1177 match config {
1178 VirtualMachineConfig::RawConfig(config) => config.protectedVm,
1179 VirtualMachineConfig::AppConfig(config) => config.protectedVm,
1180 }
1181}
1182
1183fn check_gdb_allowed(config: &VirtualMachineConfig) -> binder::Result<()> {
1184 if is_protected(config) {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001185 return Err(anyhow!("Can't use gdb with protected VMs"))
1186 .or_binder_exception(ExceptionCode::SECURITY);
Nikita Ioffe5776f082023-02-10 21:38:26 +00001187 }
1188
1189 match config {
1190 VirtualMachineConfig::RawConfig(_) => Ok(()),
1191 VirtualMachineConfig::AppConfig(config) => {
1192 if config.debugLevel != DebugLevel::FULL {
Jiyong Park2227eaa2023-08-04 11:59:18 +09001193 Err(anyhow!("Can't use gdb with non-debuggable VMs"))
1194 .or_binder_exception(ExceptionCode::SECURITY)
Nikita Ioffe5776f082023-02-10 21:38:26 +00001195 } else {
1196 Ok(())
1197 }
1198 }
1199 }
1200}
1201
1202fn extract_gdb_port(config: &VirtualMachineConfig) -> Option<NonZeroU16> {
1203 match config {
1204 VirtualMachineConfig::RawConfig(config) => NonZeroU16::new(config.gdbPort as u16),
Nikita Ioffea0eb5ee2023-06-26 18:18:21 +01001205 VirtualMachineConfig::AppConfig(config) => {
1206 NonZeroU16::new(config.customConfig.as_ref().map(|c| c.gdbPort).unwrap_or(0) as u16)
1207 }
Nikita Ioffe5776f082023-02-10 21:38:26 +00001208 }
1209}
1210
Nikita Ioffe631717e2023-09-05 13:38:07 +01001211fn check_no_vendor_modules(config: &VirtualMachineConfig) -> binder::Result<()> {
1212 let VirtualMachineConfig::AppConfig(config) = config else { return Ok(()) };
1213 if let Some(custom_config) = &config.customConfig {
1214 if custom_config.vendorImage.is_some() || custom_config.customKernelImage.is_some() {
1215 return Err(anyhow!("vendor modules feature is disabled"))
1216 .or_binder_exception(ExceptionCode::UNSUPPORTED_OPERATION);
1217 }
1218 }
1219 Ok(())
1220}
1221
Nikita Ioffe94a8a182023-11-16 16:37:48 +00001222fn check_no_devices(config: &VirtualMachineConfig) -> binder::Result<()> {
1223 let VirtualMachineConfig::AppConfig(config) = config else { return Ok(()) };
1224 if let Some(custom_config) = &config.customConfig {
1225 if !custom_config.devices.is_empty() {
1226 return Err(anyhow!("device assignment feature is disabled"))
1227 .or_binder_exception(ExceptionCode::UNSUPPORTED_OPERATION);
1228 }
1229 }
1230 Ok(())
1231}
1232
Nikita Ioffe631717e2023-09-05 13:38:07 +01001233fn check_config_features(config: &VirtualMachineConfig) -> binder::Result<()> {
1234 if !cfg!(vendor_modules) {
1235 check_no_vendor_modules(config)?;
1236 }
Nikita Ioffe94a8a182023-11-16 16:37:48 +00001237 if !cfg!(device_assignment) {
1238 check_no_devices(config)?;
1239 }
Nikita Ioffe631717e2023-09-05 13:38:07 +01001240 Ok(())
1241}
1242
Inseob Kim0168b462022-12-27 14:54:35 +09001243fn clone_or_prepare_logger_fd(
Jaewan Kim61f86142023-03-28 15:12:52 +09001244 debug_config: &DebugConfig,
Inseob Kim0168b462022-12-27 14:54:35 +09001245 fd: Option<&ParcelFileDescriptor>,
1246 tag: String,
1247) -> Result<Option<File>, Status> {
1248 if let Some(fd) = fd {
1249 return Ok(Some(clone_file(fd)?));
1250 }
1251
Jaewan Kim61f86142023-03-28 15:12:52 +09001252 if !debug_config.should_prepare_console_output() {
Jaewan Kim66f062e2023-02-25 01:07:43 +09001253 return Ok(None);
1254 };
Inseob Kim0168b462022-12-27 14:54:35 +09001255
Jiyong Park2227eaa2023-08-04 11:59:18 +09001256 let (raw_read_fd, raw_write_fd) =
1257 pipe().context("Failed to create pipe").or_service_specific_exception(-1)?;
Inseob Kim0168b462022-12-27 14:54:35 +09001258
Andrew Walbranb58d1b42023-07-07 13:54:49 +01001259 // 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 +09001260 let mut reader = BufReader::new(unsafe { File::from_raw_fd(raw_read_fd) });
Andrew Walbranb58d1b42023-07-07 13:54:49 +01001261 // 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 +09001262 let write_fd = unsafe { File::from_raw_fd(raw_write_fd) };
1263
1264 std::thread::spawn(move || loop {
1265 let mut buf = vec![];
1266 match reader.read_until(b'\n', &mut buf) {
1267 Ok(0) => {
1268 // EOF
1269 return;
1270 }
1271 Ok(size) => {
1272 if buf[size - 1] == b'\n' {
1273 buf.pop();
1274 }
1275 info!("{}: {}", &tag, &String::from_utf8_lossy(&buf));
1276 }
1277 Err(e) => {
1278 error!("Could not read console pipe: {:?}", e);
1279 return;
1280 }
1281 };
1282 });
1283
1284 Ok(Some(write_fd))
1285}
1286
Jooyung Han35edb8f2021-07-01 16:17:16 +09001287/// Simple utility for referencing Borrowed or Owned. Similar to std::borrow::Cow, but
1288/// it doesn't require that T implements Clone.
1289enum BorrowedOrOwned<'a, T> {
1290 Borrowed(&'a T),
1291 Owned(T),
1292}
1293
1294impl<'a, T> AsRef<T> for BorrowedOrOwned<'a, T> {
1295 fn as_ref(&self) -> &T {
1296 match self {
1297 Self::Borrowed(b) => b,
Chris Wailes68c39f82021-07-27 16:03:44 -07001298 Self::Owned(o) => o,
Jooyung Han35edb8f2021-07-01 16:17:16 +09001299 }
1300 }
1301}
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001302
1303/// Implementation of `IVirtualMachineService`, the entry point of the AIDL service.
1304#[derive(Debug, Default)]
1305struct VirtualMachineService {
1306 state: Arc<Mutex<State>>,
Inseob Kimc7d28c72021-10-25 14:28:10 +00001307 cid: Cid,
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001308}
1309
1310impl Interface for VirtualMachineService {}
1311
1312impl IVirtualMachineService for VirtualMachineService {
Inseob Kimc7d28c72021-10-25 14:28:10 +00001313 fn notifyPayloadStarted(&self) -> binder::Result<()> {
1314 let cid = self.cid;
Inseob Kim7f61fe72021-08-20 20:50:47 +09001315 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001316 info!("VM with CID {} started payload", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001317 vm.update_payload_state(PayloadState::Started)
1318 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
David Brazdil451cc962022-10-14 14:08:12 +01001319 vm.callbacks.notify_payload_started(cid);
Seungjae Yoo62085c02022-08-12 04:44:52 +00001320
Seungjae Yoo6d265d92022-11-15 10:51:33 +09001321 let vm_start_timestamp = vm.vm_metric.lock().unwrap().start_timestamp;
1322 write_vm_booted_stats(vm.requester_uid as i32, &vm.name, vm_start_timestamp);
Inseob Kim7f61fe72021-08-20 20:50:47 +09001323 Ok(())
1324 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001325 error!("notifyPayloadStarted is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001326 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001327 }
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001328 }
Inseob Kim2444af92021-08-31 01:22:50 +09001329
Inseob Kimc7d28c72021-10-25 14:28:10 +00001330 fn notifyPayloadReady(&self) -> binder::Result<()> {
1331 let cid = self.cid;
Inseob Kim14cb8692021-08-31 21:50:39 +09001332 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001333 info!("VM with CID {} reported payload is ready", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001334 vm.update_payload_state(PayloadState::Ready)
1335 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Inseob Kim14cb8692021-08-31 21:50:39 +09001336 vm.callbacks.notify_payload_ready(cid);
1337 Ok(())
1338 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001339 error!("notifyPayloadReady is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001340 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim14cb8692021-08-31 21:50:39 +09001341 }
1342 }
1343
Inseob Kimc7d28c72021-10-25 14:28:10 +00001344 fn notifyPayloadFinished(&self, exit_code: i32) -> binder::Result<()> {
1345 let cid = self.cid;
Inseob Kim2444af92021-08-31 01:22:50 +09001346 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001347 info!("VM with CID {} finished payload", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001348 vm.update_payload_state(PayloadState::Finished)
1349 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Inseob Kim2444af92021-08-31 01:22:50 +09001350 vm.callbacks.notify_payload_finished(cid, exit_code);
1351 Ok(())
1352 } else {
Jooyung Handd0a1732021-11-23 15:26:20 +09001353 error!("notifyPayloadFinished is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001354 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Jooyung Handd0a1732021-11-23 15:26:20 +09001355 }
1356 }
1357
Alan Stokes2bead0d2022-09-05 16:58:34 +01001358 fn notifyError(&self, error_code: ErrorCode, message: &str) -> binder::Result<()> {
Jooyung Handd0a1732021-11-23 15:26:20 +09001359 let cid = self.cid;
1360 if let Some(vm) = self.state.lock().unwrap().get_vm(cid) {
David Brazdil415097c2022-10-21 14:17:05 +01001361 info!("VM with CID {} encountered an error", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001362 vm.update_payload_state(PayloadState::Finished)
1363 .or_binder_exception(ExceptionCode::ILLEGAL_STATE)?;
Jooyung Handd0a1732021-11-23 15:26:20 +09001364 vm.callbacks.notify_error(cid, error_code, message);
1365 Ok(())
1366 } else {
Seungjae Yooec8c1602022-06-20 05:28:00 +00001367 error!("notifyError is called from an unknown CID {}", cid);
Jiyong Park2227eaa2023-08-04 11:59:18 +09001368 Err(anyhow!("cannot find a VM with CID {}", cid)).or_service_specific_exception(-1)
Inseob Kim2444af92021-08-31 01:22:50 +09001369 }
1370 }
Alice Wangc2fec932023-02-23 16:24:02 +00001371
Alice Wang4e3015d2023-10-10 09:35:37 +00001372 fn requestAttestation(&self, csr: &[u8]) -> binder::Result<Vec<Certificate>> {
Alice Wangbff017f2023-11-09 14:43:28 +00001373 GLOBAL_SERVICE.requestAttestation(csr, get_calling_uid() as i32)
Alice Wangc2fec932023-02-23 16:24:02 +00001374 }
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001375}
1376
1377impl VirtualMachineService {
Inseob Kimc7d28c72021-10-25 14:28:10 +00001378 fn new_binder(state: Arc<Mutex<State>>, cid: Cid) -> Strong<dyn IVirtualMachineService> {
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001379 BnVirtualMachineService::new_binder(
Inseob Kimc7d28c72021-10-25 14:28:10 +00001380 VirtualMachineService { state, cid },
Inseob Kim1b95f2e2021-08-19 13:17:40 +09001381 BinderFeatures::default(),
1382 )
1383 }
1384}
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001385
1386#[cfg(test)]
1387mod tests {
1388 use super::*;
1389
1390 #[test]
1391 fn test_is_allowed_label_for_partition() -> Result<()> {
1392 let expected_results = vec![
1393 ("u:object_r:system_file:s0", true),
1394 ("u:object_r:apk_data_file:s0", true),
1395 ("u:object_r:app_data_file:s0", false),
1396 ("u:object_r:app_data_file:s0:c512,c768", false),
1397 ("u:object_r:privapp_data_file:s0:c512,c768", false),
1398 ("invalid", false),
1399 ("user:role:apk_data_file:severity:categories", true),
1400 ("user:role:apk_data_file:severity:categories:extraneous", false),
1401 ];
1402
1403 for (label, expected_valid) in expected_results {
1404 let context = SeContext::new(label)?;
1405 let result = check_label_is_allowed(&context);
1406 if expected_valid {
1407 assert!(result.is_ok(), "Expected label {} to be allowed, got {:?}", label, result);
1408 } else if result.is_ok() {
1409 bail!("Expected label {} to be disallowed", label);
1410 }
1411 }
1412 Ok(())
1413 }
Nikita Ioffef1ce9872022-12-09 13:31:59 +00001414
1415 #[test]
1416 fn test_create_or_update_idsig_file_empty_apk() -> Result<()> {
1417 let apk = tempfile::tempfile().unwrap();
1418 let idsig = tempfile::tempfile().unwrap();
1419
1420 let ret = create_or_update_idsig_file(
1421 &ParcelFileDescriptor::new(apk),
1422 &ParcelFileDescriptor::new(idsig),
1423 );
1424 assert!(ret.is_err(), "should fail");
1425 Ok(())
1426 }
1427
1428 #[test]
1429 fn test_create_or_update_idsig_dir_instead_of_file_for_apk() -> Result<()> {
1430 let tmp_dir = tempfile::TempDir::new().unwrap();
1431 let apk = File::open(tmp_dir.path()).unwrap();
1432 let idsig = tempfile::tempfile().unwrap();
1433
1434 let ret = create_or_update_idsig_file(
1435 &ParcelFileDescriptor::new(apk),
1436 &ParcelFileDescriptor::new(idsig),
1437 );
1438 assert!(ret.is_err(), "should fail");
1439 Ok(())
1440 }
1441
1442 /// Verifies that create_or_update_idsig_file won't oom if a fd that corresponds to a directory
1443 /// on ext4 filesystem is passed.
1444 /// On ext4 lseek on a directory fd will return (off_t)-1 (see:
1445 /// https://bugzilla.kernel.org/show_bug.cgi?id=200043), which will result in
1446 /// create_or_update_idsig_file ooming while attempting to allocate petabytes of memory.
1447 #[test]
1448 fn test_create_or_update_idsig_does_not_crash_dir_on_ext4() -> Result<()> {
1449 // APEXes are backed by the ext4.
1450 let apk = File::open("/apex/com.android.virt/").unwrap();
1451 let idsig = tempfile::tempfile().unwrap();
1452
1453 let ret = create_or_update_idsig_file(
1454 &ParcelFileDescriptor::new(apk),
1455 &ParcelFileDescriptor::new(idsig),
1456 );
1457 assert!(ret.is_err(), "should fail");
1458 Ok(())
1459 }
Jiyong Park8d192952023-06-26 14:29:51 +09001460
1461 #[test]
1462 fn test_create_or_update_idsig_does_not_update_if_already_valid() -> Result<()> {
1463 use std::io::Seek;
1464
1465 // Pick any APK
1466 let mut apk = File::open("/system/priv-app/Shell/Shell.apk").unwrap();
1467 let mut idsig = tempfile::tempfile().unwrap();
1468
1469 create_or_update_idsig_file(
1470 &ParcelFileDescriptor::new(apk.try_clone()?),
1471 &ParcelFileDescriptor::new(idsig.try_clone()?),
1472 )?;
1473 let modified_orig = idsig.metadata()?.modified()?;
1474 apk.rewind()?;
1475 idsig.rewind()?;
1476
1477 // Call the function again
1478 create_or_update_idsig_file(
1479 &ParcelFileDescriptor::new(apk.try_clone()?),
1480 &ParcelFileDescriptor::new(idsig.try_clone()?),
1481 )?;
1482 let modified_new = idsig.metadata()?.modified()?;
1483 assert!(modified_orig == modified_new, "idsig file was updated unnecessarily");
1484 Ok(())
1485 }
Nikita Ioffeaa6858c2023-07-04 01:37:41 +01001486
1487 #[test]
1488 fn test_append_kernel_param_first_param() {
1489 let mut vm_config = VirtualMachineRawConfig { ..Default::default() };
1490 append_kernel_param("foo=1", &mut vm_config);
1491 assert_eq!(vm_config.params, Some("foo=1".to_owned()))
1492 }
1493
1494 #[test]
1495 fn test_append_kernel_param() {
1496 let mut vm_config =
1497 VirtualMachineRawConfig { params: Some("foo=5".to_owned()), ..Default::default() };
1498 append_kernel_param("bar=42", &mut vm_config);
1499 assert_eq!(vm_config.params, Some("foo=5 bar=42".to_owned()))
1500 }
Seungjae Yooec3bc522023-11-09 10:14:30 +09001501
1502 #[test]
1503 fn test_create_dtbo_for_vendor_image() -> Result<()> {
1504 let vendor_public_key = String::from("foo");
1505 let vendor_public_key = vendor_public_key.as_bytes();
1506
1507 let tmp_dir = tempfile::TempDir::new()?;
1508 let dtbo_path = tmp_dir.path().to_path_buf().join("bar");
1509
1510 create_dtbo_for_vendor_image(vendor_public_key, &dtbo_path)?;
1511
1512 let data = std::fs::read(dtbo_path)?;
1513 let fdt = Fdt::from_slice(&data).unwrap();
1514
1515 let fragment_node_path = CString::new("/fragment@0")?;
1516 let fragment_node = fdt.node(fragment_node_path.as_c_str()).unwrap();
1517 let Some(fragment_node) = fragment_node else {
1518 bail!("fragment_node shouldn't be None.");
1519 };
1520 let target_path_prop_name = CString::new("target-path")?;
1521 let target_path_from_dtbo =
1522 fragment_node.getprop(target_path_prop_name.as_c_str()).unwrap();
1523 let target_path_expected = CString::new("/")?;
1524 assert_eq!(target_path_from_dtbo, Some(target_path_expected.to_bytes_with_nul()));
1525
1526 let avf_node_path = CString::new("/fragment@0/__overlay__/avf")?;
1527 let avf_node = fdt.node(avf_node_path.as_c_str()).unwrap();
1528 let Some(avf_node) = avf_node else {
1529 bail!("avf_node shouldn't be None.");
1530 };
1531 let vendor_public_key_name = CString::new("vendor_public_key")?;
1532 let key_from_dtbo = avf_node.getprop(vendor_public_key_name.as_c_str()).unwrap();
1533 assert_eq!(key_from_dtbo, Some(vendor_public_key));
1534
1535 tmp_dir.close()?;
1536 Ok(())
1537 }
1538
1539 #[test]
1540 fn test_create_dtbo_for_vendor_image_throws_error_if_already_exists() -> Result<()> {
1541 let vendor_public_key = String::from("foo");
1542 let vendor_public_key = vendor_public_key.as_bytes();
1543
1544 let tmp_dir = tempfile::TempDir::new()?;
1545 let dtbo_path = tmp_dir.path().to_path_buf().join("bar");
1546
1547 create_dtbo_for_vendor_image(vendor_public_key, &dtbo_path)?;
1548
1549 let ret_second_trial = create_dtbo_for_vendor_image(vendor_public_key, &dtbo_path);
1550 assert!(ret_second_trial.is_err(), "should fail");
1551
1552 tmp_dir.close()?;
1553 Ok(())
1554 }
Alan Stokes53cc5ca2022-08-30 14:28:19 +01001555}