blob: 8f7a69a0e5e24f70c189c2824cb99674fffadfd1 [file] [log] [blame]
Jooyung Han21e9b922021-06-26 04:14:16 +09001// 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
15//! Payload disk image
16
Andrew Walbrancc0db522021-07-12 17:03:42 +000017use android_system_virtualizationservice::aidl::android::system::virtualizationservice::{
Jiyong Parkc2a49cc2021-10-15 00:02:12 +090018 DiskImage::DiskImage, Partition::Partition, VirtualMachineAppConfig::DebugLevel::DebugLevel,
19 VirtualMachineAppConfig::VirtualMachineAppConfig,
Andrew Walbrancc0db522021-07-12 17:03:42 +000020 VirtualMachineRawConfig::VirtualMachineRawConfig,
21};
22use android_system_virtualizationservice::binder::ParcelFileDescriptor;
Inseob Kima5a262f2021-11-17 19:41:03 +090023use anyhow::{anyhow, bail, Context, Result};
Jooyung Han53cf7992021-10-18 19:38:41 +090024use binder::wait_for_interface;
Jooyung Han5e0f2062021-10-12 14:00:46 +090025use log::{error, info};
Jooyung Han21e9b922021-06-26 04:14:16 +090026use microdroid_metadata::{ApexPayload, ApkPayload, Metadata};
Jooyung Han5dc42172021-10-05 16:43:47 +090027use microdroid_payload_config::{ApexConfig, VmPayloadConfig};
Jooyung Han9900f3d2021-07-06 10:27:54 +090028use once_cell::sync::OnceCell;
Jooyung Han5dc42172021-10-05 16:43:47 +090029use packagemanager_aidl::aidl::android::content::pm::IPackageManagerNative::IPackageManagerNative;
Jooyung Han44b02ab2021-07-16 03:19:13 +090030use serde::Deserialize;
31use serde_xml_rs::from_reader;
Jooyung Han5e0f2062021-10-12 14:00:46 +090032use std::env;
Jooyung Han44b02ab2021-07-16 03:19:13 +090033use std::fs::{File, OpenOptions};
Jooyung Han21e9b922021-06-26 04:14:16 +090034use std::path::{Path, PathBuf};
Andrew Walbrancc0db522021-07-12 17:03:42 +000035use vmconfig::open_parcel_file;
36
37/// The list of APEXes which microdroid requires.
38// TODO(b/192200378) move this to microdroid.json?
Inseob Kimb4868e62021-11-09 17:28:23 +090039const MICRODROID_REQUIRED_APEXES: [&str; 1] = ["com.android.os.statsd"];
40const MICRODROID_REQUIRED_APEXES_DEBUG: [&str; 1] = ["com.android.adbd"];
Jooyung Han21e9b922021-06-26 04:14:16 +090041
Jooyung Han44b02ab2021-07-16 03:19:13 +090042const APEX_INFO_LIST_PATH: &str = "/apex/apex-info-list.xml";
43
Jooyung Han5dc42172021-10-05 16:43:47 +090044const PACKAGE_MANAGER_NATIVE_SERVICE: &str = "package_native";
45
Jooyung Han73bac242021-07-02 10:25:49 +090046/// Represents the list of APEXes
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090047#[derive(Clone, Debug, Deserialize)]
Jooyung Han9900f3d2021-07-06 10:27:54 +090048struct ApexInfoList {
Jooyung Han44b02ab2021-07-16 03:19:13 +090049 #[serde(rename = "apex-info")]
Jooyung Han73bac242021-07-02 10:25:49 +090050 list: Vec<ApexInfo>,
51}
52
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090053#[derive(Clone, Debug, Deserialize)]
Jooyung Han73bac242021-07-02 10:25:49 +090054struct ApexInfo {
Jooyung Han44b02ab2021-07-16 03:19:13 +090055 #[serde(rename = "moduleName")]
Jooyung Han73bac242021-07-02 10:25:49 +090056 name: String,
Jooyung Han44b02ab2021-07-16 03:19:13 +090057 #[serde(rename = "modulePath")]
Jooyung Han73bac242021-07-02 10:25:49 +090058 path: PathBuf,
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090059
60 #[serde(default)]
61 boot_classpath: bool,
62 #[serde(default)]
63 systemserver_classpath: bool,
64 #[serde(default)]
65 dex2oatboot_classpath: bool,
Jooyung Han73bac242021-07-02 10:25:49 +090066}
67
68impl ApexInfoList {
69 /// Loads ApexInfoList
Jooyung Han9900f3d2021-07-06 10:27:54 +090070 fn load() -> Result<&'static ApexInfoList> {
71 static INSTANCE: OnceCell<ApexInfoList> = OnceCell::new();
72 INSTANCE.get_or_try_init(|| {
Jooyung Han44b02ab2021-07-16 03:19:13 +090073 let apex_info_list = File::open(APEX_INFO_LIST_PATH)
74 .context(format!("Failed to open {}", APEX_INFO_LIST_PATH))?;
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090075 let mut apex_info_list: ApexInfoList = from_reader(apex_info_list)
Jooyung Han44b02ab2021-07-16 03:19:13 +090076 .context(format!("Failed to parse {}", APEX_INFO_LIST_PATH))?;
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090077
78 // For active APEXes, we refer env variables to see if it contributes to classpath
79 let boot_classpath_apexes = find_apex_names_in_classpath_env("BOOTCLASSPATH");
80 let systemserver_classpath_apexes =
81 find_apex_names_in_classpath_env("SYSTEMSERVERCLASSPATH");
82 let dex2oatboot_classpath_apexes =
83 find_apex_names_in_classpath_env("DEX2OATBOOTCLASSPATH");
84 for apex_info in apex_info_list.list.iter_mut() {
85 apex_info.boot_classpath = boot_classpath_apexes.contains(&apex_info.name);
86 apex_info.systemserver_classpath =
87 systemserver_classpath_apexes.contains(&apex_info.name);
88 apex_info.dex2oatboot_classpath =
89 dex2oatboot_classpath_apexes.contains(&apex_info.name);
90 }
Jooyung Han44b02ab2021-07-16 03:19:13 +090091 Ok(apex_info_list)
Jooyung Han9900f3d2021-07-06 10:27:54 +090092 })
Jooyung Han73bac242021-07-02 10:25:49 +090093 }
94
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090095 /// Returns the list of apex names matching with the predicate
96 fn get_matching(&self, predicate: fn(&ApexInfo) -> bool) -> Vec<String> {
97 self.list.iter().filter(|info| predicate(info)).map(|info| info.name.clone()).collect()
98 }
99
Jooyung Han73bac242021-07-02 10:25:49 +0900100 fn get_path_for(&self, apex_name: &str) -> Result<PathBuf> {
101 Ok(self
102 .list
103 .iter()
104 .find(|apex| apex.name == apex_name)
105 .ok_or_else(|| anyhow!("{} not found.", apex_name))?
106 .path
107 .clone())
108 }
Jooyung Han21e9b922021-06-26 04:14:16 +0900109}
110
Jooyung Han5dc42172021-10-05 16:43:47 +0900111struct PackageManager {
Jooyung Han5dc42172021-10-05 16:43:47 +0900112 // TODO(b/199146189) use IPackageManagerNative
113 apex_info_list: &'static ApexInfoList,
114}
115
116impl PackageManager {
117 fn new() -> Result<Self> {
Jooyung Han5dc42172021-10-05 16:43:47 +0900118 let apex_info_list = ApexInfoList::load()?;
Jooyung Han53cf7992021-10-18 19:38:41 +0900119 Ok(Self { apex_info_list })
Jooyung Han5dc42172021-10-05 16:43:47 +0900120 }
121
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900122 fn get_apex_list(&self, prefer_staged: bool) -> Result<ApexInfoList> {
Jooyung Han53cf7992021-10-18 19:38:41 +0900123 // get the list of active apexes
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900124 let mut list = self.apex_info_list.clone();
Jooyung Han53cf7992021-10-18 19:38:41 +0900125 // When prefer_staged, we override ApexInfo by consulting "package_native"
Jooyung Han5dc42172021-10-05 16:43:47 +0900126 if prefer_staged {
Jooyung Han53cf7992021-10-18 19:38:41 +0900127 let pm =
128 wait_for_interface::<dyn IPackageManagerNative>(PACKAGE_MANAGER_NATIVE_SERVICE)
129 .context("Failed to get service when prefer_staged is set.")?;
130 let staged = pm.getStagedApexModuleNames()?;
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900131 for apex_info in list.list.iter_mut() {
132 if staged.contains(&apex_info.name) {
Jooyung Han53cf7992021-10-18 19:38:41 +0900133 let staged_apex_info = pm.getStagedApexInfo(&apex_info.name)?;
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900134 if let Some(staged_apex_info) = staged_apex_info {
135 apex_info.path = PathBuf::from(staged_apex_info.diskImagePath);
Jooyung Han1e7b6032021-11-01 15:02:45 +0900136 apex_info.boot_classpath = staged_apex_info.hasBootClassPathJars;
137 apex_info.systemserver_classpath =
138 staged_apex_info.hasSystemServerClassPathJars;
139 apex_info.dex2oatboot_classpath =
140 staged_apex_info.hasDex2OatBootClassPathJars;
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900141 }
142 }
Jooyung Han5dc42172021-10-05 16:43:47 +0900143 }
144 }
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900145 Ok(list)
Jooyung Han5dc42172021-10-05 16:43:47 +0900146 }
147}
148
Andrew Walbrancc0db522021-07-12 17:03:42 +0000149fn make_metadata_file(
Jooyung Han21e9b922021-06-26 04:14:16 +0900150 config_path: &str,
Jooyung Han5e0f2062021-10-12 14:00:46 +0900151 apex_names: &[String],
Jooyung Han21e9b922021-06-26 04:14:16 +0900152 temporary_directory: &Path,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000153) -> Result<ParcelFileDescriptor> {
Jooyung Han21e9b922021-06-26 04:14:16 +0900154 let metadata_path = temporary_directory.join("metadata");
155 let metadata = Metadata {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000156 version: 1,
Jooyung Han5e0f2062021-10-12 14:00:46 +0900157 apexes: apex_names
Jooyung Han21e9b922021-06-26 04:14:16 +0900158 .iter()
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900159 .enumerate()
Jooyung Han5e0f2062021-10-12 14:00:46 +0900160 .map(|(i, apex_name)| ApexPayload {
161 name: apex_name.clone(),
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900162 partition_name: format!("microdroid-apex-{}", i),
163 ..Default::default()
164 })
Jooyung Han21e9b922021-06-26 04:14:16 +0900165 .collect(),
166 apk: Some(ApkPayload {
Jooyung Han35edb8f2021-07-01 16:17:16 +0900167 name: "apk".to_owned(),
168 payload_partition_name: "microdroid-apk".to_owned(),
169 idsig_partition_name: "microdroid-apk-idsig".to_owned(),
Jooyung Han21e9b922021-06-26 04:14:16 +0900170 ..Default::default()
171 })
172 .into(),
173 payload_config_path: format!("/mnt/apk/{}", config_path),
174 ..Default::default()
175 };
Andrew Walbrancc0db522021-07-12 17:03:42 +0000176
177 // Write metadata to file.
178 let mut metadata_file = OpenOptions::new()
179 .create_new(true)
180 .read(true)
181 .write(true)
182 .open(&metadata_path)
183 .with_context(|| format!("Failed to open metadata file {:?}", metadata_path))?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900184 microdroid_metadata::write_metadata(&metadata, &mut metadata_file)?;
185
Andrew Walbrancc0db522021-07-12 17:03:42 +0000186 // Re-open the metadata file as read-only.
187 open_parcel_file(&metadata_path, false)
188}
189
190/// Creates a DiskImage with partitions:
191/// metadata: metadata
192/// microdroid-apex-0: apex 0
193/// microdroid-apex-1: apex 1
194/// ..
195/// microdroid-apk: apk
196/// microdroid-apk-idsig: idsig
Inseob Kima5a262f2021-11-17 19:41:03 +0900197/// extra-apk-0: additional apk 0
198/// extra-idsig-0: additional idsig 0
199/// extra-apk-1: additional apk 1
200/// extra-idsig-1: additional idsig 1
201/// ..
Andrew Walbrancc0db522021-07-12 17:03:42 +0000202fn make_payload_disk(
Inseob Kima5a262f2021-11-17 19:41:03 +0900203 app_config: &VirtualMachineAppConfig,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000204 apk_file: File,
205 idsig_file: File,
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900206 vm_payload_config: &VmPayloadConfig,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000207 temporary_directory: &Path,
208) -> Result<DiskImage> {
Inseob Kima5a262f2021-11-17 19:41:03 +0900209 if vm_payload_config.extra_apks.len() != app_config.extraIdsigs.len() {
210 bail!(
211 "payload config has {} apks, but app config has {} idsigs",
212 vm_payload_config.extra_apks.len(),
213 app_config.extraIdsigs.len()
214 );
215 }
216
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900217 let pm = PackageManager::new()?;
218 let apex_list = pm.get_apex_list(vm_payload_config.prefer_staged)?;
219
220 // collect APEX names from config
Inseob Kima5a262f2021-11-17 19:41:03 +0900221 let apexes = collect_apex_names(&apex_list, &vm_payload_config.apexes, app_config.debugLevel);
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900222 info!("Microdroid payload APEXes: {:?}", apexes);
223
Inseob Kima5a262f2021-11-17 19:41:03 +0900224 let metadata_file = make_metadata_file(&app_config.configPath, &apexes, temporary_directory)?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900225 // put metadata at the first partition
226 let mut partitions = vec![Partition {
Jooyung Han14e5a8e2021-07-06 20:48:38 +0900227 label: "payload-metadata".to_owned(),
Jooyung Han631d5882021-07-29 06:34:05 +0900228 image: Some(metadata_file),
Jooyung Han21e9b922021-06-26 04:14:16 +0900229 writable: false,
230 }];
231
Jooyung Han21e9b922021-06-26 04:14:16 +0900232 for (i, apex) in apexes.iter().enumerate() {
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900233 let apex_path = apex_list.get_path_for(apex)?;
Andrew Walbrancc0db522021-07-12 17:03:42 +0000234 let apex_file = open_parcel_file(&apex_path, false)?;
Jooyung Han95884632021-07-06 22:27:54 +0900235 partitions.push(Partition {
236 label: format!("microdroid-apex-{}", i),
Jooyung Han631d5882021-07-29 06:34:05 +0900237 image: Some(apex_file),
Jooyung Han95884632021-07-06 22:27:54 +0900238 writable: false,
239 });
Jooyung Han21e9b922021-06-26 04:14:16 +0900240 }
Jooyung Han95884632021-07-06 22:27:54 +0900241 partitions.push(Partition {
242 label: "microdroid-apk".to_owned(),
Jooyung Han631d5882021-07-29 06:34:05 +0900243 image: Some(ParcelFileDescriptor::new(apk_file)),
Jooyung Han95884632021-07-06 22:27:54 +0900244 writable: false,
245 });
246 partitions.push(Partition {
247 label: "microdroid-apk-idsig".to_owned(),
Jooyung Han631d5882021-07-29 06:34:05 +0900248 image: Some(ParcelFileDescriptor::new(idsig_file)),
Jooyung Han95884632021-07-06 22:27:54 +0900249 writable: false,
250 });
Jooyung Han21e9b922021-06-26 04:14:16 +0900251
Inseob Kima5a262f2021-11-17 19:41:03 +0900252 // we've already checked that extra_apks and extraIdsigs are in the same size.
253 let extra_apks = &vm_payload_config.extra_apks;
254 let extra_idsigs = &app_config.extraIdsigs;
255 for (i, (extra_apk, extra_idsig)) in extra_apks.iter().zip(extra_idsigs.iter()).enumerate() {
256 partitions.push(Partition {
257 label: format!("extra-apk-{}", i),
258 image: Some(ParcelFileDescriptor::new(File::open(PathBuf::from(&extra_apk.path))?)),
259 writable: false,
260 });
261
262 partitions.push(Partition {
263 label: format!("extra-idsig-{}", i),
264 image: Some(ParcelFileDescriptor::new(extra_idsig.as_ref().try_clone()?)),
265 writable: false,
266 });
267 }
268
Jooyung Han21e9b922021-06-26 04:14:16 +0900269 Ok(DiskImage { image: None, partitions, writable: false })
270}
Andrew Walbrancc0db522021-07-12 17:03:42 +0000271
Jooyung Han5e0f2062021-10-12 14:00:46 +0900272fn find_apex_names_in_classpath_env(classpath_env_var: &str) -> Vec<String> {
273 let val = env::var(classpath_env_var).unwrap_or_else(|e| {
274 error!("Reading {} failed: {}", classpath_env_var, e);
275 String::from("")
276 });
277 val.split(':')
278 .filter_map(|path| {
279 Path::new(path)
280 .strip_prefix("/apex/")
281 .map(|stripped| {
282 let first = stripped.iter().next().unwrap();
283 first.to_str().unwrap().to_string()
284 })
285 .ok()
286 })
287 .collect()
288}
289
290// Collect APEX names from config
Inseob Kimb4868e62021-11-09 17:28:23 +0900291fn collect_apex_names(
292 apex_list: &ApexInfoList,
293 apexes: &[ApexConfig],
294 debug_level: DebugLevel,
295) -> Vec<String> {
Jooyung Han5e0f2062021-10-12 14:00:46 +0900296 // Process pseudo names like "{BOOTCLASSPATH}".
297 // For now we have following pseudo APEX names:
298 // - {BOOTCLASSPATH}: represents APEXes contributing "BOOTCLASSPATH" environment variable
299 // - {DEX2OATBOOTCLASSPATH}: represents APEXes contributing "DEX2OATBOOTCLASSPATH" environment variable
300 // - {SYSTEMSERVERCLASSPATH}: represents APEXes contributing "SYSTEMSERVERCLASSPATH" environment variable
301 let mut apex_names: Vec<String> = apexes
302 .iter()
303 .flat_map(|apex| match apex.name.as_str() {
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900304 "{BOOTCLASSPATH}" => apex_list.get_matching(|apex| apex.boot_classpath),
305 "{DEX2OATBOOTCLASSPATH}" => apex_list.get_matching(|apex| apex.dex2oatboot_classpath),
306 "{SYSTEMSERVERCLASSPATH}" => apex_list.get_matching(|apex| apex.systemserver_classpath),
Jooyung Han5e0f2062021-10-12 14:00:46 +0900307 _ => vec![apex.name.clone()],
308 })
309 .collect();
310 // Add required APEXes
311 apex_names.extend(MICRODROID_REQUIRED_APEXES.iter().map(|name| name.to_string()));
Inseob Kimb4868e62021-11-09 17:28:23 +0900312 if debug_level != DebugLevel::NONE {
313 apex_names.extend(MICRODROID_REQUIRED_APEXES_DEBUG.iter().map(|name| name.to_string()));
314 }
Jooyung Han5e0f2062021-10-12 14:00:46 +0900315 apex_names.sort();
316 apex_names.dedup();
317 apex_names
318}
319
Andrew Walbrancc0db522021-07-12 17:03:42 +0000320pub fn add_microdroid_images(
321 config: &VirtualMachineAppConfig,
322 temporary_directory: &Path,
323 apk_file: File,
324 idsig_file: File,
Jiyong Park8d081812021-07-23 17:45:04 +0900325 instance_file: File,
Jooyung Han5dc42172021-10-05 16:43:47 +0900326 vm_payload_config: &VmPayloadConfig,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000327 vm_config: &mut VirtualMachineRawConfig,
328) -> Result<()> {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000329 vm_config.disks.push(make_payload_disk(
Inseob Kima5a262f2021-11-17 19:41:03 +0900330 config,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000331 apk_file,
332 idsig_file,
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900333 vm_payload_config,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000334 temporary_directory,
335 )?);
336
Jiyong Parkacf31b02021-11-04 20:45:14 +0900337 vm_config.disks[1].partitions.push(Partition {
338 label: "vbmeta".to_owned(),
339 image: Some(open_parcel_file(
340 Path::new("/apex/com.android.virt/etc/fs/microdroid_vbmeta_bootconfig.img"),
341 false,
342 )?),
343 writable: false,
344 });
Jiyong Parkc2a49cc2021-10-15 00:02:12 +0900345 let bootconfig_image = "/apex/com.android.virt/etc/microdroid_bootconfig.".to_owned()
346 + match config.debugLevel {
347 DebugLevel::NONE => "normal",
348 DebugLevel::APP_ONLY => "app_debuggable",
349 DebugLevel::FULL => "full_debuggable",
350 _ => return Err(anyhow!("unsupported debug level: {:?}", config.debugLevel)),
351 };
352 vm_config.disks[1].partitions.push(Partition {
353 label: "bootconfig".to_owned(),
354 image: Some(open_parcel_file(Path::new(&bootconfig_image), false)?),
355 writable: false,
356 });
Andrew Walbrancc0db522021-07-12 17:03:42 +0000357
Jiyong Park8d081812021-07-23 17:45:04 +0900358 // instance image is at the second partition in the second disk.
359 vm_config.disks[1].partitions.push(Partition {
360 label: "vm-instance".to_owned(),
Jooyung Han631d5882021-07-29 06:34:05 +0900361 image: Some(ParcelFileDescriptor::new(instance_file)),
Jiyong Park8d081812021-07-23 17:45:04 +0900362 writable: true,
363 });
364
Andrew Walbrancc0db522021-07-12 17:03:42 +0000365 Ok(())
366}
Jooyung Han5e0f2062021-10-12 14:00:46 +0900367
368#[cfg(test)]
369mod tests {
370 use super::*;
371 #[test]
372 fn test_find_apex_names_in_classpath_env() {
373 let key = "TEST_BOOTCLASSPATH";
374 let classpath = "/apex/com.android.foo/javalib/foo.jar:/system/framework/framework.jar:/apex/com.android.bar/javalib/bar.jar";
375 env::set_var(key, classpath);
376 assert_eq!(
377 find_apex_names_in_classpath_env(key),
378 vec!["com.android.foo".to_owned(), "com.android.bar".to_owned()]
379 );
380 }
381}