blob: 2d238a813f069ce9857de7f30c8ccfee88cb86f4 [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::{
18 DiskImage::DiskImage, Partition::Partition, VirtualMachineAppConfig::VirtualMachineAppConfig,
19 VirtualMachineRawConfig::VirtualMachineRawConfig,
20};
21use android_system_virtualizationservice::binder::ParcelFileDescriptor;
Jooyung Han44b02ab2021-07-16 03:19:13 +090022use anyhow::{anyhow, Context, Result};
Jooyung Han5dc42172021-10-05 16:43:47 +090023use binder::{wait_for_interface, Strong};
Jooyung Han5e0f2062021-10-12 14:00:46 +090024use log::{error, info};
Jooyung Han21e9b922021-06-26 04:14:16 +090025use microdroid_metadata::{ApexPayload, ApkPayload, Metadata};
Jooyung Han5dc42172021-10-05 16:43:47 +090026use microdroid_payload_config::{ApexConfig, VmPayloadConfig};
Jooyung Han9900f3d2021-07-06 10:27:54 +090027use once_cell::sync::OnceCell;
Jooyung Han5dc42172021-10-05 16:43:47 +090028use packagemanager_aidl::aidl::android::content::pm::IPackageManagerNative::IPackageManagerNative;
Jooyung Han44b02ab2021-07-16 03:19:13 +090029use serde::Deserialize;
30use serde_xml_rs::from_reader;
Jooyung Han5e0f2062021-10-12 14:00:46 +090031use std::env;
Jooyung Han44b02ab2021-07-16 03:19:13 +090032use std::fs::{File, OpenOptions};
Jooyung Han21e9b922021-06-26 04:14:16 +090033use std::path::{Path, PathBuf};
Andrew Walbrancc0db522021-07-12 17:03:42 +000034use vmconfig::open_parcel_file;
35
36/// The list of APEXes which microdroid requires.
37// TODO(b/192200378) move this to microdroid.json?
Jooyung Han1c2d7582021-09-08 22:46:42 +090038const MICRODROID_REQUIRED_APEXES: [&str; 2] = ["com.android.adbd", "com.android.os.statsd"];
Jooyung Han21e9b922021-06-26 04:14:16 +090039
Jooyung Han44b02ab2021-07-16 03:19:13 +090040const APEX_INFO_LIST_PATH: &str = "/apex/apex-info-list.xml";
41
Jooyung Han5dc42172021-10-05 16:43:47 +090042const PACKAGE_MANAGER_NATIVE_SERVICE: &str = "package_native";
43
Jooyung Han73bac242021-07-02 10:25:49 +090044/// Represents the list of APEXes
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090045#[derive(Clone, Debug, Deserialize)]
Jooyung Han9900f3d2021-07-06 10:27:54 +090046struct ApexInfoList {
Jooyung Han44b02ab2021-07-16 03:19:13 +090047 #[serde(rename = "apex-info")]
Jooyung Han73bac242021-07-02 10:25:49 +090048 list: Vec<ApexInfo>,
49}
50
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090051#[derive(Clone, Debug, Deserialize)]
Jooyung Han73bac242021-07-02 10:25:49 +090052struct ApexInfo {
Jooyung Han44b02ab2021-07-16 03:19:13 +090053 #[serde(rename = "moduleName")]
Jooyung Han73bac242021-07-02 10:25:49 +090054 name: String,
Jooyung Han44b02ab2021-07-16 03:19:13 +090055 #[serde(rename = "modulePath")]
Jooyung Han73bac242021-07-02 10:25:49 +090056 path: PathBuf,
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090057
58 #[serde(default)]
59 boot_classpath: bool,
60 #[serde(default)]
61 systemserver_classpath: bool,
62 #[serde(default)]
63 dex2oatboot_classpath: bool,
Jooyung Han73bac242021-07-02 10:25:49 +090064}
65
66impl ApexInfoList {
67 /// Loads ApexInfoList
Jooyung Han9900f3d2021-07-06 10:27:54 +090068 fn load() -> Result<&'static ApexInfoList> {
69 static INSTANCE: OnceCell<ApexInfoList> = OnceCell::new();
70 INSTANCE.get_or_try_init(|| {
Jooyung Han44b02ab2021-07-16 03:19:13 +090071 let apex_info_list = File::open(APEX_INFO_LIST_PATH)
72 .context(format!("Failed to open {}", APEX_INFO_LIST_PATH))?;
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090073 let mut apex_info_list: ApexInfoList = from_reader(apex_info_list)
Jooyung Han44b02ab2021-07-16 03:19:13 +090074 .context(format!("Failed to parse {}", APEX_INFO_LIST_PATH))?;
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090075
76 // For active APEXes, we refer env variables to see if it contributes to classpath
77 let boot_classpath_apexes = find_apex_names_in_classpath_env("BOOTCLASSPATH");
78 let systemserver_classpath_apexes =
79 find_apex_names_in_classpath_env("SYSTEMSERVERCLASSPATH");
80 let dex2oatboot_classpath_apexes =
81 find_apex_names_in_classpath_env("DEX2OATBOOTCLASSPATH");
82 for apex_info in apex_info_list.list.iter_mut() {
83 apex_info.boot_classpath = boot_classpath_apexes.contains(&apex_info.name);
84 apex_info.systemserver_classpath =
85 systemserver_classpath_apexes.contains(&apex_info.name);
86 apex_info.dex2oatboot_classpath =
87 dex2oatboot_classpath_apexes.contains(&apex_info.name);
88 }
Jooyung Han44b02ab2021-07-16 03:19:13 +090089 Ok(apex_info_list)
Jooyung Han9900f3d2021-07-06 10:27:54 +090090 })
Jooyung Han73bac242021-07-02 10:25:49 +090091 }
92
Jooyung Han9d7cd7d2021-10-12 17:44:14 +090093 /// Returns the list of apex names matching with the predicate
94 fn get_matching(&self, predicate: fn(&ApexInfo) -> bool) -> Vec<String> {
95 self.list.iter().filter(|info| predicate(info)).map(|info| info.name.clone()).collect()
96 }
97
Jooyung Han73bac242021-07-02 10:25:49 +090098 fn get_path_for(&self, apex_name: &str) -> Result<PathBuf> {
99 Ok(self
100 .list
101 .iter()
102 .find(|apex| apex.name == apex_name)
103 .ok_or_else(|| anyhow!("{} not found.", apex_name))?
104 .path
105 .clone())
106 }
Jooyung Han21e9b922021-06-26 04:14:16 +0900107}
108
Jooyung Han5dc42172021-10-05 16:43:47 +0900109struct PackageManager {
110 service: Strong<dyn IPackageManagerNative>,
111 // TODO(b/199146189) use IPackageManagerNative
112 apex_info_list: &'static ApexInfoList,
113}
114
115impl PackageManager {
116 fn new() -> Result<Self> {
117 let service = wait_for_interface(PACKAGE_MANAGER_NATIVE_SERVICE)
118 .context("Failed to find PackageManager")?;
119 let apex_info_list = ApexInfoList::load()?;
120 Ok(Self { service, apex_info_list })
121 }
122
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900123 fn get_apex_list(&self, prefer_staged: bool) -> Result<ApexInfoList> {
124 let mut list = self.apex_info_list.clone();
Jooyung Han5dc42172021-10-05 16:43:47 +0900125 if prefer_staged {
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900126 // When prefer_staged, we override ApexInfo by consulting "package_native"
127 let staged = self.service.getStagedApexModuleNames()?;
128 for apex_info in list.list.iter_mut() {
129 if staged.contains(&apex_info.name) {
130 let staged_apex_info = self.service.getStagedApexInfo(&apex_info.name)?;
131 if let Some(staged_apex_info) = staged_apex_info {
132 apex_info.path = PathBuf::from(staged_apex_info.diskImagePath);
133 // TODO(b/201788989) copy bootclasspath/systemserverclasspath
134 }
135 }
Jooyung Han5dc42172021-10-05 16:43:47 +0900136 }
137 }
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900138 Ok(list)
Jooyung Han5dc42172021-10-05 16:43:47 +0900139 }
140}
141
Andrew Walbrancc0db522021-07-12 17:03:42 +0000142fn make_metadata_file(
Jooyung Han21e9b922021-06-26 04:14:16 +0900143 config_path: &str,
Jooyung Han5e0f2062021-10-12 14:00:46 +0900144 apex_names: &[String],
Jooyung Han21e9b922021-06-26 04:14:16 +0900145 temporary_directory: &Path,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000146) -> Result<ParcelFileDescriptor> {
Jooyung Han21e9b922021-06-26 04:14:16 +0900147 let metadata_path = temporary_directory.join("metadata");
148 let metadata = Metadata {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000149 version: 1,
Jooyung Han5e0f2062021-10-12 14:00:46 +0900150 apexes: apex_names
Jooyung Han21e9b922021-06-26 04:14:16 +0900151 .iter()
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900152 .enumerate()
Jooyung Han5e0f2062021-10-12 14:00:46 +0900153 .map(|(i, apex_name)| ApexPayload {
154 name: apex_name.clone(),
Jooyung Han19c1d6c2021-08-06 14:08:16 +0900155 partition_name: format!("microdroid-apex-{}", i),
156 ..Default::default()
157 })
Jooyung Han21e9b922021-06-26 04:14:16 +0900158 .collect(),
159 apk: Some(ApkPayload {
Jooyung Han35edb8f2021-07-01 16:17:16 +0900160 name: "apk".to_owned(),
161 payload_partition_name: "microdroid-apk".to_owned(),
162 idsig_partition_name: "microdroid-apk-idsig".to_owned(),
Jooyung Han21e9b922021-06-26 04:14:16 +0900163 ..Default::default()
164 })
165 .into(),
166 payload_config_path: format!("/mnt/apk/{}", config_path),
167 ..Default::default()
168 };
Andrew Walbrancc0db522021-07-12 17:03:42 +0000169
170 // Write metadata to file.
171 let mut metadata_file = OpenOptions::new()
172 .create_new(true)
173 .read(true)
174 .write(true)
175 .open(&metadata_path)
176 .with_context(|| format!("Failed to open metadata file {:?}", metadata_path))?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900177 microdroid_metadata::write_metadata(&metadata, &mut metadata_file)?;
178
Andrew Walbrancc0db522021-07-12 17:03:42 +0000179 // Re-open the metadata file as read-only.
180 open_parcel_file(&metadata_path, false)
181}
182
183/// Creates a DiskImage with partitions:
184/// metadata: metadata
185/// microdroid-apex-0: apex 0
186/// microdroid-apex-1: apex 1
187/// ..
188/// microdroid-apk: apk
189/// microdroid-apk-idsig: idsig
190fn make_payload_disk(
191 apk_file: File,
192 idsig_file: File,
193 config_path: &str,
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900194 vm_payload_config: &VmPayloadConfig,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000195 temporary_directory: &Path,
196) -> Result<DiskImage> {
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900197 let pm = PackageManager::new()?;
198 let apex_list = pm.get_apex_list(vm_payload_config.prefer_staged)?;
199
200 // collect APEX names from config
201 let apexes = collect_apex_names(&apex_list, &vm_payload_config.apexes);
202 info!("Microdroid payload APEXes: {:?}", apexes);
203
204 let metadata_file = make_metadata_file(config_path, &apexes, temporary_directory)?;
Jooyung Han21e9b922021-06-26 04:14:16 +0900205 // put metadata at the first partition
206 let mut partitions = vec![Partition {
Jooyung Han14e5a8e2021-07-06 20:48:38 +0900207 label: "payload-metadata".to_owned(),
Jooyung Han631d5882021-07-29 06:34:05 +0900208 image: Some(metadata_file),
Jooyung Han21e9b922021-06-26 04:14:16 +0900209 writable: false,
210 }];
211
Jooyung Han21e9b922021-06-26 04:14:16 +0900212 for (i, apex) in apexes.iter().enumerate() {
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900213 let apex_path = apex_list.get_path_for(apex)?;
Andrew Walbrancc0db522021-07-12 17:03:42 +0000214 let apex_file = open_parcel_file(&apex_path, false)?;
Jooyung Han95884632021-07-06 22:27:54 +0900215 partitions.push(Partition {
216 label: format!("microdroid-apex-{}", i),
Jooyung Han631d5882021-07-29 06:34:05 +0900217 image: Some(apex_file),
Jooyung Han95884632021-07-06 22:27:54 +0900218 writable: false,
219 });
Jooyung Han21e9b922021-06-26 04:14:16 +0900220 }
Jooyung Han95884632021-07-06 22:27:54 +0900221 partitions.push(Partition {
222 label: "microdroid-apk".to_owned(),
Jooyung Han631d5882021-07-29 06:34:05 +0900223 image: Some(ParcelFileDescriptor::new(apk_file)),
Jooyung Han95884632021-07-06 22:27:54 +0900224 writable: false,
225 });
226 partitions.push(Partition {
227 label: "microdroid-apk-idsig".to_owned(),
Jooyung Han631d5882021-07-29 06:34:05 +0900228 image: Some(ParcelFileDescriptor::new(idsig_file)),
Jooyung Han95884632021-07-06 22:27:54 +0900229 writable: false,
230 });
Jooyung Han21e9b922021-06-26 04:14:16 +0900231
232 Ok(DiskImage { image: None, partitions, writable: false })
233}
Andrew Walbrancc0db522021-07-12 17:03:42 +0000234
Jooyung Han5e0f2062021-10-12 14:00:46 +0900235fn find_apex_names_in_classpath_env(classpath_env_var: &str) -> Vec<String> {
236 let val = env::var(classpath_env_var).unwrap_or_else(|e| {
237 error!("Reading {} failed: {}", classpath_env_var, e);
238 String::from("")
239 });
240 val.split(':')
241 .filter_map(|path| {
242 Path::new(path)
243 .strip_prefix("/apex/")
244 .map(|stripped| {
245 let first = stripped.iter().next().unwrap();
246 first.to_str().unwrap().to_string()
247 })
248 .ok()
249 })
250 .collect()
251}
252
253// Collect APEX names from config
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900254fn collect_apex_names(apex_list: &ApexInfoList, apexes: &[ApexConfig]) -> Vec<String> {
Jooyung Han5e0f2062021-10-12 14:00:46 +0900255 // Process pseudo names like "{BOOTCLASSPATH}".
256 // For now we have following pseudo APEX names:
257 // - {BOOTCLASSPATH}: represents APEXes contributing "BOOTCLASSPATH" environment variable
258 // - {DEX2OATBOOTCLASSPATH}: represents APEXes contributing "DEX2OATBOOTCLASSPATH" environment variable
259 // - {SYSTEMSERVERCLASSPATH}: represents APEXes contributing "SYSTEMSERVERCLASSPATH" environment variable
260 let mut apex_names: Vec<String> = apexes
261 .iter()
262 .flat_map(|apex| match apex.name.as_str() {
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900263 "{BOOTCLASSPATH}" => apex_list.get_matching(|apex| apex.boot_classpath),
264 "{DEX2OATBOOTCLASSPATH}" => apex_list.get_matching(|apex| apex.dex2oatboot_classpath),
265 "{SYSTEMSERVERCLASSPATH}" => apex_list.get_matching(|apex| apex.systemserver_classpath),
Jooyung Han5e0f2062021-10-12 14:00:46 +0900266 _ => vec![apex.name.clone()],
267 })
268 .collect();
269 // Add required APEXes
270 apex_names.extend(MICRODROID_REQUIRED_APEXES.iter().map(|name| name.to_string()));
271 apex_names.sort();
272 apex_names.dedup();
273 apex_names
274}
275
Andrew Walbrancc0db522021-07-12 17:03:42 +0000276pub fn add_microdroid_images(
277 config: &VirtualMachineAppConfig,
278 temporary_directory: &Path,
279 apk_file: File,
280 idsig_file: File,
Jiyong Park8d081812021-07-23 17:45:04 +0900281 instance_file: File,
Jooyung Han5dc42172021-10-05 16:43:47 +0900282 vm_payload_config: &VmPayloadConfig,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000283 vm_config: &mut VirtualMachineRawConfig,
284) -> Result<()> {
Andrew Walbrancc0db522021-07-12 17:03:42 +0000285 vm_config.disks.push(make_payload_disk(
286 apk_file,
287 idsig_file,
288 &config.configPath,
Jooyung Han9d7cd7d2021-10-12 17:44:14 +0900289 vm_payload_config,
Andrew Walbrancc0db522021-07-12 17:03:42 +0000290 temporary_directory,
291 )?);
292
293 if config.debug {
294 vm_config.disks[1].partitions.push(Partition {
295 label: "bootconfig".to_owned(),
Jooyung Han631d5882021-07-29 06:34:05 +0900296 image: Some(open_parcel_file(
Andrew Walbrancc0db522021-07-12 17:03:42 +0000297 Path::new("/apex/com.android.virt/etc/microdroid_bootconfig.debug"),
298 false,
Jooyung Han631d5882021-07-29 06:34:05 +0900299 )?),
Andrew Walbrancc0db522021-07-12 17:03:42 +0000300 writable: false,
301 });
302 }
303
Jiyong Park8d081812021-07-23 17:45:04 +0900304 // instance image is at the second partition in the second disk.
305 vm_config.disks[1].partitions.push(Partition {
306 label: "vm-instance".to_owned(),
Jooyung Han631d5882021-07-29 06:34:05 +0900307 image: Some(ParcelFileDescriptor::new(instance_file)),
Jiyong Park8d081812021-07-23 17:45:04 +0900308 writable: true,
309 });
310
Andrew Walbrancc0db522021-07-12 17:03:42 +0000311 Ok(())
312}
Jooyung Han5e0f2062021-10-12 14:00:46 +0900313
314#[cfg(test)]
315mod tests {
316 use super::*;
317 #[test]
318 fn test_find_apex_names_in_classpath_env() {
319 let key = "TEST_BOOTCLASSPATH";
320 let classpath = "/apex/com.android.foo/javalib/foo.jar:/system/framework/framework.jar:/apex/com.android.bar/javalib/bar.jar";
321 env::set_var(key, classpath);
322 assert_eq!(
323 find_apex_names_in_classpath_env(key),
324 vec!["com.android.foo".to_owned(), "com.android.bar".to_owned()]
325 );
326 }
327}