blob: c06fd4cc4bee1ae0aeec59bb1a65693b7fe27a08 [file] [log] [blame]
Bill Peckhame9eb5f92019-02-01 15:52:10 -08001#!/usr/bin/env python
2#
Daniel Norman03747412022-02-25 10:38:37 -08003# Copyright (C) 2022 The Android Open Source Project
Bill Peckhame9eb5f92019-02-01 15:52:10 -08004#
5# Licensed under the Apache License, Version 2.0 (the "License"); you may not
6# use this file except in compliance with the License. You may obtain a copy of
7# the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14# License for the specific language governing permissions and limitations under
15# the License.
Daniel Norman4cc9df62019-07-18 10:11:07 -070016#
17"""This script merges two partial target files packages.
Bill Peckhame9eb5f92019-02-01 15:52:10 -080018
Daniel Normandbbf5a32020-10-22 16:03:32 -070019One input package contains framework files, and the other contains vendor files.
Bill Peckhame9eb5f92019-02-01 15:52:10 -080020
Daniel Normandbbf5a32020-10-22 16:03:32 -070021This script produces a complete, merged target files package:
22 - This package can be used to generate a flashable IMG package.
23 See --output-img.
24 - This package can be used to generate an OTA package. See --output-ota.
25 - The merged package is checked for compatibility between the two inputs.
26
27Usage: merge_target_files [args]
Bill Peckhame9eb5f92019-02-01 15:52:10 -080028
Daniel Normand5d70ea2019-06-05 15:13:43 -070029 --framework-target-files framework-target-files-zip-archive
30 The input target files package containing framework bits. This is a zip
Bill Peckhame9eb5f92019-02-01 15:52:10 -080031 archive.
32
Daniel Normand5d70ea2019-06-05 15:13:43 -070033 --framework-item-list framework-item-list-file
Daniel Norman5f476772022-03-02 15:46:34 -080034 The optional path to a newline-separated config file of items that
35 are extracted as-is from the framework target files package.
Daniel Norman2c99c5b2019-03-07 13:01:48 -080036
Daniel Normand5d70ea2019-06-05 15:13:43 -070037 --framework-misc-info-keys framework-misc-info-keys-file
Daniel Norman5f476772022-03-02 15:46:34 -080038 The optional path to a newline-separated config file of keys to
39 extract from the framework META/misc_info.txt file.
Daniel Norman2c99c5b2019-03-07 13:01:48 -080040
Daniel Normand5d70ea2019-06-05 15:13:43 -070041 --vendor-target-files vendor-target-files-zip-archive
42 The input target files package containing vendor bits. This is a zip
Bill Peckhame9eb5f92019-02-01 15:52:10 -080043 archive.
44
Daniel Normand5d70ea2019-06-05 15:13:43 -070045 --vendor-item-list vendor-item-list-file
Daniel Norman5f476772022-03-02 15:46:34 -080046 The optional path to a newline-separated config file of items that
47 are extracted as-is from the vendor target files package.
Daniel Norman2c99c5b2019-03-07 13:01:48 -080048
Bill Peckhame9eb5f92019-02-01 15:52:10 -080049 --output-target-files output-target-files-package
Daniel Normanfdb38812019-04-15 09:47:24 -070050 If provided, the output merged target files package. Also a zip archive.
51
52 --output-dir output-directory
53 If provided, the destination directory for saving merged files. Requires
54 the --output-item-list flag.
55 Can be provided alongside --output-target-files, or by itself.
56
57 --output-item-list output-item-list-file.
58 The optional path to a newline-separated config file that specifies the
59 file patterns to copy into the --output-dir. Required if providing
60 the --output-dir flag.
Daniel Normana4911da2019-03-15 14:36:21 -070061
Daniel Norman3b64ce12019-04-16 16:11:35 -070062 --output-ota output-ota-package
63 The output ota package. This is a zip archive. Use of this flag may
64 require passing the --path common flag; see common.py.
65
Daniel Norman1bd2a1d2019-04-18 12:32:18 -070066 --output-img output-img-package
67 The output img package, suitable for use with 'fastboot update'. Use of
68 this flag may require passing the --path common flag; see common.py.
69
Daniel Normanf0318252019-04-15 11:34:56 -070070 --output-super-empty output-super-empty-image
71 If provided, creates a super_empty.img file from the merged target
72 files package and saves it at this path.
73
Daniel Normana4911da2019-03-15 14:36:21 -070074 --rebuild_recovery
Po Hua6c59122022-02-16 08:41:29 +000075 Copy the recovery image used by non-A/B devices, used when
76 regenerating vendor images with --rebuild-sepolicy.
Bill Peckham364c1cc2019-03-29 18:27:23 -070077
Daniel Normanb0c75912020-09-24 14:30:21 -070078 --allow-duplicate-apkapex-keys
79 If provided, duplicate APK/APEX keys are ignored and the value from the
80 framework is used.
81
Daniel Norman571e1822021-06-25 17:18:25 -070082 --rebuild-sepolicy
83 If provided, rebuilds odm.img or vendor.img to include merged sepolicy
84 files. If odm is present then odm is preferred.
85
86 --vendor-otatools otatools.zip
87 If provided, use this otatools.zip when recompiling the odm or vendor
88 image to include sepolicy.
89
Bill Peckham364c1cc2019-03-29 18:27:23 -070090 --keep-tmp
91 Keep tempoary files for debugging purposes.
Jose Galmes9c8f6eb2021-07-21 09:34:08 -070092
93 The following only apply when using the VSDK to perform dexopt on vendor apps:
94
95 --framework-dexpreopt-config
96 If provided, the location of framwework's dexpreopt_config.zip.
97
98 --framework-dexpreopt-tools
99 if provided, the location of framework's dexpreopt_tools.zip.
100
101 --vendor-dexpreopt-config
102 If provided, the location of vendor's dexpreopt_config.zip.
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800103"""
104
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800105import logging
106import os
Daniel Normanfdb38812019-04-15 09:47:24 -0700107import shutil
Bill Peckham540d91a2019-04-25 14:18:16 -0700108import subprocess
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800109import sys
Daniel Norman5f476772022-03-02 15:46:34 -0800110import zipfile
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800111
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800112import add_img_to_target_files
Daniel Normandb8cacc2021-04-09 15:34:43 -0700113import build_image
Daniel Normanf0318252019-04-15 11:34:56 -0700114import build_super_image
115import common
Daniel Norman1bd2a1d2019-04-18 12:32:18 -0700116import img_from_target_files
Daniel Norman2465fc82022-03-02 12:01:20 -0800117import merge_compatibility_checks
118import merge_dexopt
119import merge_meta
120import merge_utils
Daniel Norman3b64ce12019-04-16 16:11:35 -0700121import ota_from_target_files
Daniel Normandb8cacc2021-04-09 15:34:43 -0700122
Daniel Normana84d13b2022-02-17 14:16:40 -0800123from common import ExternalError
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800124
125logger = logging.getLogger(__name__)
Tao Bao2ad4b822019-06-27 16:52:12 -0700126
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800127OPTIONS = common.OPTIONS
Bill Peckhamcb848172020-04-03 12:50:47 -0700128# Always turn on verbose logging.
129OPTIONS.verbose = True
Daniel Normand5d70ea2019-06-05 15:13:43 -0700130OPTIONS.framework_target_files = None
Daniel Norman5f476772022-03-02 15:46:34 -0800131OPTIONS.framework_item_list = []
132OPTIONS.framework_misc_info_keys = []
Daniel Normand5d70ea2019-06-05 15:13:43 -0700133OPTIONS.vendor_target_files = None
Daniel Norman5f476772022-03-02 15:46:34 -0800134OPTIONS.vendor_item_list = []
Bill Peckhamf753e152019-02-19 18:02:46 -0800135OPTIONS.output_target_files = None
Daniel Normanfdb38812019-04-15 09:47:24 -0700136OPTIONS.output_dir = None
Daniel Norman5f476772022-03-02 15:46:34 -0800137OPTIONS.output_item_list = []
Daniel Norman3b64ce12019-04-16 16:11:35 -0700138OPTIONS.output_ota = None
Daniel Norman1bd2a1d2019-04-18 12:32:18 -0700139OPTIONS.output_img = None
Daniel Normanf0318252019-04-15 11:34:56 -0700140OPTIONS.output_super_empty = None
Daniel Normana4911da2019-03-15 14:36:21 -0700141OPTIONS.rebuild_recovery = False
Daniel Normanb0c75912020-09-24 14:30:21 -0700142# TODO(b/150582573): Remove this option.
143OPTIONS.allow_duplicate_apkapex_keys = False
Daniel Norman571e1822021-06-25 17:18:25 -0700144OPTIONS.vendor_otatools = None
145OPTIONS.rebuild_sepolicy = False
Bill Peckhamf753e152019-02-19 18:02:46 -0800146OPTIONS.keep_tmp = False
Jose Galmes9c8f6eb2021-07-21 09:34:08 -0700147OPTIONS.framework_dexpreopt_config = None
148OPTIONS.framework_dexpreopt_tools = None
149OPTIONS.vendor_dexpreopt_config = None
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800150
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800151
Daniel Norman03747412022-02-25 10:38:37 -0800152def create_merged_package(temp_dir):
Tao Bao2ad4b822019-06-27 16:52:12 -0700153 """Merges two target files packages into one target files structure.
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800154
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900155 Returns:
156 Path to merged package under temp directory.
157 """
Daniel Normandbbf5a32020-10-22 16:03:32 -0700158 # Extract "as is" items from the input framework and vendor partial target
159 # files packages directly into the output temporary directory, since these items
160 # do not need special case processing.
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800161
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800162 output_target_files_temp_dir = os.path.join(temp_dir, 'output')
Daniel Norman2465fc82022-03-02 12:01:20 -0800163 merge_utils.ExtractItems(
Daniel Norman03747412022-02-25 10:38:37 -0800164 input_zip=OPTIONS.framework_target_files,
165 output_dir=output_target_files_temp_dir,
166 extract_item_list=OPTIONS.framework_item_list)
Daniel Norman2465fc82022-03-02 12:01:20 -0800167 merge_utils.ExtractItems(
Daniel Norman03747412022-02-25 10:38:37 -0800168 input_zip=OPTIONS.vendor_target_files,
169 output_dir=output_target_files_temp_dir,
170 extract_item_list=OPTIONS.vendor_item_list)
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800171
Daniel Normandbbf5a32020-10-22 16:03:32 -0700172 # Perform special case processing on META/* items.
173 # After this function completes successfully, all the files we need to create
174 # the output target files package are in place.
Daniel Norman2465fc82022-03-02 12:01:20 -0800175 merge_meta.MergeMetaFiles(
176 temp_dir=temp_dir, merged_dir=output_target_files_temp_dir)
Daniel Norman03747412022-02-25 10:38:37 -0800177
Daniel Norman2465fc82022-03-02 12:01:20 -0800178 merge_dexopt.MergeDexopt(
Daniel Norman03747412022-02-25 10:38:37 -0800179 temp_dir=temp_dir, output_target_files_dir=output_target_files_temp_dir)
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800180
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900181 return output_target_files_temp_dir
182
183
Daniel Norman03747412022-02-25 10:38:37 -0800184def generate_missing_images(target_files_dir):
185 """Generate any missing images from target files."""
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900186
187 # Regenerate IMAGES in the target directory.
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800188
Daniel Normandbbf5a32020-10-22 16:03:32 -0700189 add_img_args = [
190 '--verbose',
191 '--add_missing',
192 ]
Daniel Norman03747412022-02-25 10:38:37 -0800193 if OPTIONS.rebuild_recovery:
Daniel Normana4911da2019-03-15 14:36:21 -0700194 add_img_args.append('--rebuild_recovery')
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900195 add_img_args.append(target_files_dir)
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800196
197 add_img_to_target_files.main(add_img_args)
198
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900199
Daniel Norman03747412022-02-25 10:38:37 -0800200def rebuild_image_with_sepolicy(target_files_dir):
Daniel Norman571e1822021-06-25 17:18:25 -0700201 """Rebuilds odm.img or vendor.img to include merged sepolicy files.
202
203 If odm is present then odm is preferred -- otherwise vendor is used.
Daniel Norman571e1822021-06-25 17:18:25 -0700204 """
205 partition = 'vendor'
206 if os.path.exists(os.path.join(target_files_dir, 'ODM')) or os.path.exists(
207 os.path.join(target_files_dir, 'IMAGES/odm.img')):
208 partition = 'odm'
209 partition_img = '{}.img'.format(partition)
Po Hua6c59122022-02-16 08:41:29 +0000210 partition_map = '{}.map'.format(partition)
Daniel Norman571e1822021-06-25 17:18:25 -0700211
212 logger.info('Recompiling %s using the merged sepolicy files.', partition_img)
213
214 # Copy the combined SEPolicy file and framework hashes to the image that is
215 # being rebuilt.
216 def copy_selinux_file(input_path, output_filename):
Po Hu0e4403e2021-07-06 17:05:56 +0800217 input_filename = os.path.join(target_files_dir, input_path)
218 if not os.path.exists(input_filename):
219 input_filename = input_filename.replace('SYSTEM_EXT/', 'SYSTEM/system_ext/') \
220 .replace('PRODUCT/', 'SYSTEM/product/')
221 if not os.path.exists(input_filename):
222 logger.info('Skipping copy_selinux_file for %s', input_filename)
223 return
Daniel Norman571e1822021-06-25 17:18:25 -0700224 shutil.copy(
Po Hu0e4403e2021-07-06 17:05:56 +0800225 input_filename,
Daniel Norman571e1822021-06-25 17:18:25 -0700226 os.path.join(target_files_dir, partition.upper(), 'etc/selinux',
227 output_filename))
228
229 copy_selinux_file('META/combined_sepolicy', 'precompiled_sepolicy')
230 copy_selinux_file('SYSTEM/etc/selinux/plat_sepolicy_and_mapping.sha256',
231 'precompiled_sepolicy.plat_sepolicy_and_mapping.sha256')
232 copy_selinux_file(
233 'SYSTEM_EXT/etc/selinux/system_ext_sepolicy_and_mapping.sha256',
234 'precompiled_sepolicy.system_ext_sepolicy_and_mapping.sha256')
235 copy_selinux_file('PRODUCT/etc/selinux/product_sepolicy_and_mapping.sha256',
236 'precompiled_sepolicy.product_sepolicy_and_mapping.sha256')
237
Daniel Norman03747412022-02-25 10:38:37 -0800238 if not OPTIONS.vendor_otatools:
Daniel Norman571e1822021-06-25 17:18:25 -0700239 # Remove the partition from the merged target-files archive. It will be
Daniel Norman03747412022-02-25 10:38:37 -0800240 # rebuilt later automatically by generate_missing_images().
Daniel Norman571e1822021-06-25 17:18:25 -0700241 os.remove(os.path.join(target_files_dir, 'IMAGES', partition_img))
Daniel Norman03747412022-02-25 10:38:37 -0800242 return
Daniel Norman571e1822021-06-25 17:18:25 -0700243
Daniel Norman03747412022-02-25 10:38:37 -0800244 # TODO(b/192253131): Remove the need for vendor_otatools by fixing
245 # backwards-compatibility issues when compiling images across releases.
246 if not OPTIONS.vendor_target_files:
247 raise ValueError(
248 'Expected vendor_target_files if vendor_otatools is not None.')
249 logger.info(
250 '%s recompilation will be performed using the vendor otatools.zip',
251 partition_img)
Daniel Norman571e1822021-06-25 17:18:25 -0700252
Daniel Norman03747412022-02-25 10:38:37 -0800253 # Unzip the vendor build's otatools.zip and target-files archive.
254 vendor_otatools_dir = common.MakeTempDir(
255 prefix='merge_target_files_vendor_otatools_')
256 vendor_target_files_dir = common.MakeTempDir(
257 prefix='merge_target_files_vendor_target_files_')
258 common.UnzipToDir(OPTIONS.vendor_otatools, vendor_otatools_dir)
259 common.UnzipToDir(OPTIONS.vendor_target_files, vendor_target_files_dir)
Daniel Norman571e1822021-06-25 17:18:25 -0700260
Daniel Norman03747412022-02-25 10:38:37 -0800261 # Copy the partition contents from the merged target-files archive to the
262 # vendor target-files archive.
263 shutil.rmtree(os.path.join(vendor_target_files_dir, partition.upper()))
264 shutil.copytree(
265 os.path.join(target_files_dir, partition.upper()),
266 os.path.join(vendor_target_files_dir, partition.upper()),
267 symlinks=True)
Daniel Norman571e1822021-06-25 17:18:25 -0700268
Daniel Norman03747412022-02-25 10:38:37 -0800269 # Delete then rebuild the partition.
270 os.remove(os.path.join(vendor_target_files_dir, 'IMAGES', partition_img))
271 rebuild_partition_command = [
272 os.path.join(vendor_otatools_dir, 'bin', 'add_img_to_target_files'),
273 '--verbose',
274 '--add_missing',
275 ]
276 if OPTIONS.rebuild_recovery:
277 rebuild_partition_command.append('--rebuild_recovery')
278 rebuild_partition_command.append(vendor_target_files_dir)
279 logger.info('Recompiling %s: %s', partition_img,
280 ' '.join(rebuild_partition_command))
281 common.RunAndCheckOutput(rebuild_partition_command, verbose=True)
Po Hua6c59122022-02-16 08:41:29 +0000282
Daniel Norman03747412022-02-25 10:38:37 -0800283 # Move the newly-created image to the merged target files dir.
284 if not os.path.exists(os.path.join(target_files_dir, 'IMAGES')):
285 os.makedirs(os.path.join(target_files_dir, 'IMAGES'))
286 shutil.move(
287 os.path.join(vendor_target_files_dir, 'IMAGES', partition_img),
288 os.path.join(target_files_dir, 'IMAGES', partition_img))
289 shutil.move(
290 os.path.join(vendor_target_files_dir, 'IMAGES', partition_map),
291 os.path.join(target_files_dir, 'IMAGES', partition_map))
Po Hua6c59122022-02-16 08:41:29 +0000292
Daniel Norman03747412022-02-25 10:38:37 -0800293 def copy_recovery_file(filename):
294 for subdir in ('VENDOR', 'SYSTEM/vendor'):
295 source = os.path.join(vendor_target_files_dir, subdir, filename)
296 if os.path.exists(source):
297 dest = os.path.join(target_files_dir, subdir, filename)
298 shutil.copy(source, dest)
299 return
300 logger.info('Skipping copy_recovery_file for %s, file not found', filename)
301
302 if OPTIONS.rebuild_recovery:
303 copy_recovery_file('etc/recovery.img')
304 copy_recovery_file('bin/install-recovery.sh')
305 copy_recovery_file('recovery-from-boot.p')
Daniel Norman571e1822021-06-25 17:18:25 -0700306
307
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900308def generate_super_empty_image(target_dir, output_super_empty):
Tao Bao2ad4b822019-06-27 16:52:12 -0700309 """Generates super_empty image from target package.
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900310
311 Args:
312 target_dir: Path to the target file package which contains misc_info.txt for
313 detailed information for super image.
314 output_super_empty: If provided, copies a super_empty.img file from the
315 target files package to this path.
316 """
Daniel Norman1bd2a1d2019-04-18 12:32:18 -0700317 # Create super_empty.img using the merged misc_info.txt.
318
Daniel Norman4cc9df62019-07-18 10:11:07 -0700319 misc_info_txt = os.path.join(target_dir, 'META', 'misc_info.txt')
Daniel Norman1bd2a1d2019-04-18 12:32:18 -0700320
Kiyoung Kimebe7c9c2019-06-25 17:09:55 +0900321 use_dynamic_partitions = common.LoadDictionaryFromFile(misc_info_txt).get(
322 'use_dynamic_partitions')
Daniel Norman1bd2a1d2019-04-18 12:32:18 -0700323
324 if use_dynamic_partitions != 'true' and output_super_empty:
325 raise ValueError(
326 'Building super_empty.img requires use_dynamic_partitions=true.')
327 elif use_dynamic_partitions == 'true':
Daniel Norman4cc9df62019-07-18 10:11:07 -0700328 super_empty_img = os.path.join(target_dir, 'IMAGES', 'super_empty.img')
Daniel Norman1bd2a1d2019-04-18 12:32:18 -0700329 build_super_image_args = [
330 misc_info_txt,
331 super_empty_img,
332 ]
333 build_super_image.main(build_super_image_args)
334
335 # Copy super_empty.img to the user-provided output_super_empty location.
336 if output_super_empty:
337 shutil.copyfile(super_empty_img, output_super_empty)
338
Daniel Normanb8a2f9d2019-04-24 12:55:51 -0700339
Daniel Norman03747412022-02-25 10:38:37 -0800340def create_target_files_archive(output_zip, source_dir, temp_dir):
341 """Creates a target_files zip archive from the input source dir.
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900342
343 Args:
Daniel Norman03747412022-02-25 10:38:37 -0800344 output_zip: The name of the zip archive target files package.
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900345 source_dir: The target directory contains package to be archived.
346 temp_dir: Path to temporary directory for any intermediate files.
347 """
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800348 output_target_files_list = os.path.join(temp_dir, 'output.list')
Daniel Norman4cc9df62019-07-18 10:11:07 -0700349 output_target_files_meta_dir = os.path.join(source_dir, 'META')
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800350
Daniel Normandbbf5a32020-10-22 16:03:32 -0700351 def files_from_path(target_path, extra_args=None):
352 """Gets files under the given path and return a sorted list."""
353 find_command = ['find', target_path] + (extra_args or [])
354 find_process = common.Run(
355 find_command, stdout=subprocess.PIPE, verbose=False)
356 return common.RunAndCheckOutput(['sort'],
357 stdin=find_process.stdout,
358 verbose=False)
359
Daniel Norman03747412022-02-25 10:38:37 -0800360 # META content appears first in the zip. This is done by the
361 # standard build system for optimized extraction of those files,
362 # so we do the same step for merged target_files.zips here too.
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900363 meta_content = files_from_path(output_target_files_meta_dir)
Daniel Norman4cc9df62019-07-18 10:11:07 -0700364 other_content = files_from_path(
365 source_dir,
366 ['-path', output_target_files_meta_dir, '-prune', '-o', '-print'])
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800367
Tao Bao2ad4b822019-06-27 16:52:12 -0700368 with open(output_target_files_list, 'w') as f:
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800369 f.write(meta_content)
370 f.write(other_content)
371
372 command = [
Bill Peckhamf753e152019-02-19 18:02:46 -0800373 'soong_zip',
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800374 '-d',
Daniel Normane5b134a2019-04-17 14:54:06 -0700375 '-o',
Daniel Norman03747412022-02-25 10:38:37 -0800376 os.path.abspath(output_zip),
Daniel Normane5b134a2019-04-17 14:54:06 -0700377 '-C',
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900378 source_dir,
Daniel Normaneaf5c1d2021-02-09 11:01:42 -0800379 '-r',
Daniel Normane5b134a2019-04-17 14:54:06 -0700380 output_target_files_list,
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800381 ]
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900382
Daniel Norman03747412022-02-25 10:38:37 -0800383 logger.info('creating %s', output_zip)
Daniel Normaneaf5c1d2021-02-09 11:01:42 -0800384 common.RunAndCheckOutput(command, verbose=True)
Daniel Norman03747412022-02-25 10:38:37 -0800385 logger.info('finished creating %s', output_zip)
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900386
387
Daniel Norman03747412022-02-25 10:38:37 -0800388def merge_target_files(temp_dir):
Tao Bao2ad4b822019-06-27 16:52:12 -0700389 """Merges two target files packages together.
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900390
Daniel Norman03747412022-02-25 10:38:37 -0800391 This function uses framework and vendor target files packages as input,
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900392 performs various file extractions, special case processing, and finally
393 creates a merged zip archive as output.
394
395 Args:
396 temp_dir: The name of a directory we use when we extract items from the
397 input target files packages, and also a scratch directory that we use for
398 temporary files.
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900399 """
400
401 logger.info('starting: merge framework %s and vendor %s into output %s',
Daniel Norman03747412022-02-25 10:38:37 -0800402 OPTIONS.framework_target_files, OPTIONS.vendor_target_files,
403 OPTIONS.output_target_files)
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900404
Daniel Norman03747412022-02-25 10:38:37 -0800405 output_target_files_temp_dir = create_merged_package(temp_dir)
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900406
Daniel Norman21c34f72020-11-11 17:25:50 -0800407 partition_map = common.PartitionMapFromTargetFiles(
408 output_target_files_temp_dir)
409
Daniel Norman2465fc82022-03-02 12:01:20 -0800410 compatibility_errors = merge_compatibility_checks.CheckCompatibility(
411 target_files_dir=output_target_files_temp_dir,
412 partition_map=partition_map)
413 if compatibility_errors:
414 for error in compatibility_errors:
415 logger.error(error)
416 raise ExternalError(
417 'Found incompatibilities in the merged target files package.')
Daniel Normand3351562020-10-29 12:33:11 -0700418
Daniel Norman571e1822021-06-25 17:18:25 -0700419 # Include the compiled policy in an image if requested.
Daniel Norman03747412022-02-25 10:38:37 -0800420 if OPTIONS.rebuild_sepolicy:
421 rebuild_image_with_sepolicy(output_target_files_temp_dir)
Daniel Norman48603ff2021-02-22 15:15:24 -0800422
Daniel Norman03747412022-02-25 10:38:37 -0800423 generate_missing_images(output_target_files_temp_dir)
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900424
Daniel Norman03747412022-02-25 10:38:37 -0800425 generate_super_empty_image(output_target_files_temp_dir,
426 OPTIONS.output_super_empty)
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900427
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900428 # Finally, create the output target files zip archive and/or copy the
429 # output items to the output target files directory.
430
Daniel Norman03747412022-02-25 10:38:37 -0800431 if OPTIONS.output_dir:
Daniel Norman2465fc82022-03-02 12:01:20 -0800432 merge_utils.CopyItems(output_target_files_temp_dir, OPTIONS.output_dir,
433 OPTIONS.output_item_list)
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900434
Daniel Norman03747412022-02-25 10:38:37 -0800435 if not OPTIONS.output_target_files:
Kiyoung Kim7cbeda72019-06-28 13:26:04 +0900436 return
437
Daniel Norman03747412022-02-25 10:38:37 -0800438 create_target_files_archive(OPTIONS.output_target_files,
439 output_target_files_temp_dir, temp_dir)
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800440
Daniel Norman74eb74b2019-09-18 14:01:48 -0700441 # Create the IMG package from the merged target files package.
Daniel Norman03747412022-02-25 10:38:37 -0800442 if OPTIONS.output_img:
443 img_from_target_files.main(
444 [OPTIONS.output_target_files, OPTIONS.output_img])
Daniel Norman74eb74b2019-09-18 14:01:48 -0700445
Daniel Norman3b64ce12019-04-16 16:11:35 -0700446 # Create the OTA package from the merged target files package.
447
Daniel Norman03747412022-02-25 10:38:37 -0800448 if OPTIONS.output_ota:
449 ota_from_target_files.main(
450 [OPTIONS.output_target_files, OPTIONS.output_ota])
Daniel Norman3b64ce12019-04-16 16:11:35 -0700451
Daniel Norman1bd2a1d2019-04-18 12:32:18 -0700452
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800453def main():
454 """The main function.
455
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800456 Process command line arguments, then call merge_target_files to
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800457 perform the heavy lifting.
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800458 """
459
460 common.InitLogging()
461
Bill Peckhamf753e152019-02-19 18:02:46 -0800462 def option_handler(o, a):
463 if o == '--system-target-files':
Daniel Normand5d70ea2019-06-05 15:13:43 -0700464 logger.warning(
465 '--system-target-files has been renamed to --framework-target-files')
466 OPTIONS.framework_target_files = a
467 elif o == '--framework-target-files':
468 OPTIONS.framework_target_files = a
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800469 elif o == '--system-item-list':
Daniel Normand5d70ea2019-06-05 15:13:43 -0700470 logger.warning(
471 '--system-item-list has been renamed to --framework-item-list')
472 OPTIONS.framework_item_list = a
473 elif o == '--framework-item-list':
474 OPTIONS.framework_item_list = a
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800475 elif o == '--system-misc-info-keys':
Daniel Norman4cc9df62019-07-18 10:11:07 -0700476 logger.warning('--system-misc-info-keys has been renamed to '
477 '--framework-misc-info-keys')
Daniel Normand5d70ea2019-06-05 15:13:43 -0700478 OPTIONS.framework_misc_info_keys = a
479 elif o == '--framework-misc-info-keys':
480 OPTIONS.framework_misc_info_keys = a
Bill Peckhamf753e152019-02-19 18:02:46 -0800481 elif o == '--other-target-files':
Daniel Normand5d70ea2019-06-05 15:13:43 -0700482 logger.warning(
483 '--other-target-files has been renamed to --vendor-target-files')
484 OPTIONS.vendor_target_files = a
485 elif o == '--vendor-target-files':
486 OPTIONS.vendor_target_files = a
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800487 elif o == '--other-item-list':
Daniel Norman2d7989a2021-04-05 17:40:47 +0000488 logger.warning('--other-item-list has been renamed to --vendor-item-list')
Daniel Normand5d70ea2019-06-05 15:13:43 -0700489 OPTIONS.vendor_item_list = a
490 elif o == '--vendor-item-list':
491 OPTIONS.vendor_item_list = a
Bill Peckhamf753e152019-02-19 18:02:46 -0800492 elif o == '--output-target-files':
493 OPTIONS.output_target_files = a
Daniel Normanfdb38812019-04-15 09:47:24 -0700494 elif o == '--output-dir':
495 OPTIONS.output_dir = a
496 elif o == '--output-item-list':
497 OPTIONS.output_item_list = a
Daniel Norman3b64ce12019-04-16 16:11:35 -0700498 elif o == '--output-ota':
499 OPTIONS.output_ota = a
Daniel Norman1bd2a1d2019-04-18 12:32:18 -0700500 elif o == '--output-img':
501 OPTIONS.output_img = a
Daniel Normanf0318252019-04-15 11:34:56 -0700502 elif o == '--output-super-empty':
503 OPTIONS.output_super_empty = a
Daniel Norman2465fc82022-03-02 12:01:20 -0800504 elif o == '--rebuild_recovery' or o == '--rebuild-recovery':
Daniel Normana4911da2019-03-15 14:36:21 -0700505 OPTIONS.rebuild_recovery = True
Daniel Normanb0c75912020-09-24 14:30:21 -0700506 elif o == '--allow-duplicate-apkapex-keys':
507 OPTIONS.allow_duplicate_apkapex_keys = True
Daniel Norman571e1822021-06-25 17:18:25 -0700508 elif o == '--vendor-otatools':
509 OPTIONS.vendor_otatools = a
510 elif o == '--rebuild-sepolicy':
511 OPTIONS.rebuild_sepolicy = True
Bill Peckham364c1cc2019-03-29 18:27:23 -0700512 elif o == '--keep-tmp':
Bill Peckhamf753e152019-02-19 18:02:46 -0800513 OPTIONS.keep_tmp = True
Jose Galmes9c8f6eb2021-07-21 09:34:08 -0700514 elif o == '--framework-dexpreopt-config':
515 OPTIONS.framework_dexpreopt_config = a
516 elif o == '--framework-dexpreopt-tools':
517 OPTIONS.framework_dexpreopt_tools = a
518 elif o == '--vendor-dexpreopt-config':
519 OPTIONS.vendor_dexpreopt_config = a
Bill Peckhamf753e152019-02-19 18:02:46 -0800520 else:
521 return False
522 return True
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800523
Bill Peckhamf753e152019-02-19 18:02:46 -0800524 args = common.ParseOptions(
Daniel Normane5b134a2019-04-17 14:54:06 -0700525 sys.argv[1:],
526 __doc__,
Bill Peckhamf753e152019-02-19 18:02:46 -0800527 extra_long_opts=[
528 'system-target-files=',
Daniel Normand5d70ea2019-06-05 15:13:43 -0700529 'framework-target-files=',
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800530 'system-item-list=',
Daniel Normand5d70ea2019-06-05 15:13:43 -0700531 'framework-item-list=',
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800532 'system-misc-info-keys=',
Daniel Normand5d70ea2019-06-05 15:13:43 -0700533 'framework-misc-info-keys=',
Bill Peckhamf753e152019-02-19 18:02:46 -0800534 'other-target-files=',
Daniel Normand5d70ea2019-06-05 15:13:43 -0700535 'vendor-target-files=',
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800536 'other-item-list=',
Daniel Normand5d70ea2019-06-05 15:13:43 -0700537 'vendor-item-list=',
Bill Peckhamf753e152019-02-19 18:02:46 -0800538 'output-target-files=',
Daniel Normanfdb38812019-04-15 09:47:24 -0700539 'output-dir=',
540 'output-item-list=',
Daniel Norman3b64ce12019-04-16 16:11:35 -0700541 'output-ota=',
Daniel Norman1bd2a1d2019-04-18 12:32:18 -0700542 'output-img=',
Daniel Normanf0318252019-04-15 11:34:56 -0700543 'output-super-empty=',
Jose Galmes9c8f6eb2021-07-21 09:34:08 -0700544 'framework-dexpreopt-config=',
545 'framework-dexpreopt-tools=',
546 'vendor-dexpreopt-config=',
Daniel Normana4911da2019-03-15 14:36:21 -0700547 'rebuild_recovery',
Daniel Norman2465fc82022-03-02 12:01:20 -0800548 'rebuild-recovery',
Daniel Normanb0c75912020-09-24 14:30:21 -0700549 'allow-duplicate-apkapex-keys',
Daniel Norman571e1822021-06-25 17:18:25 -0700550 'vendor-otatools=',
551 'rebuild-sepolicy',
Bill Peckham364c1cc2019-03-29 18:27:23 -0700552 'keep-tmp',
Bill Peckhamf753e152019-02-19 18:02:46 -0800553 ],
554 extra_option_handler=option_handler)
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800555
Tao Bao2ad4b822019-06-27 16:52:12 -0700556 # pylint: disable=too-many-boolean-expressions
Daniel Normand5d70ea2019-06-05 15:13:43 -0700557 if (args or OPTIONS.framework_target_files is None or
558 OPTIONS.vendor_target_files is None or
Daniel Normane5b134a2019-04-17 14:54:06 -0700559 (OPTIONS.output_target_files is None and OPTIONS.output_dir is None) or
Daniel Norman5f476772022-03-02 15:46:34 -0800560 (OPTIONS.output_dir is not None and not OPTIONS.output_item_list) or
Po Hua6c59122022-02-16 08:41:29 +0000561 (OPTIONS.rebuild_recovery and not OPTIONS.rebuild_sepolicy)):
Bill Peckhamf753e152019-02-19 18:02:46 -0800562 common.Usage(__doc__)
Bill Peckham889b0c62019-02-21 18:53:37 -0800563 sys.exit(1)
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800564
Daniel Norman5f476772022-03-02 15:46:34 -0800565 with zipfile.ZipFile(OPTIONS.framework_target_files, allowZip64=True) as fz:
566 framework_namelist = fz.namelist()
567 with zipfile.ZipFile(OPTIONS.vendor_target_files, allowZip64=True) as vz:
568 vendor_namelist = vz.namelist()
569
Daniel Normand5d70ea2019-06-05 15:13:43 -0700570 if OPTIONS.framework_item_list:
Daniel Norman03747412022-02-25 10:38:37 -0800571 OPTIONS.framework_item_list = common.LoadListFromFile(
572 OPTIONS.framework_item_list)
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800573 else:
Daniel Norman5f476772022-03-02 15:46:34 -0800574 OPTIONS.framework_item_list = merge_utils.InferItemList(
575 input_namelist=framework_namelist, framework=True)
Daniel Norman2465fc82022-03-02 12:01:20 -0800576 OPTIONS.framework_partition_set = merge_utils.ItemListToPartitionSet(
Daniel Norman03747412022-02-25 10:38:37 -0800577 OPTIONS.framework_item_list)
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800578
Daniel Normand5d70ea2019-06-05 15:13:43 -0700579 if OPTIONS.framework_misc_info_keys:
Daniel Norman03747412022-02-25 10:38:37 -0800580 OPTIONS.framework_misc_info_keys = common.LoadListFromFile(
Daniel Normand5d70ea2019-06-05 15:13:43 -0700581 OPTIONS.framework_misc_info_keys)
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800582 else:
Daniel Norman5f476772022-03-02 15:46:34 -0800583 OPTIONS.framework_misc_info_keys = merge_utils.InferFrameworkMiscInfoKeys(
584 input_namelist=framework_namelist)
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800585
Daniel Normand5d70ea2019-06-05 15:13:43 -0700586 if OPTIONS.vendor_item_list:
Daniel Norman03747412022-02-25 10:38:37 -0800587 OPTIONS.vendor_item_list = common.LoadListFromFile(OPTIONS.vendor_item_list)
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800588 else:
Daniel Norman5f476772022-03-02 15:46:34 -0800589 OPTIONS.vendor_item_list = merge_utils.InferItemList(
590 input_namelist=vendor_namelist, framework=False)
Daniel Norman2465fc82022-03-02 12:01:20 -0800591 OPTIONS.vendor_partition_set = merge_utils.ItemListToPartitionSet(
Daniel Norman03747412022-02-25 10:38:37 -0800592 OPTIONS.vendor_item_list)
Daniel Norman2c99c5b2019-03-07 13:01:48 -0800593
Daniel Normanfdb38812019-04-15 09:47:24 -0700594 if OPTIONS.output_item_list:
Daniel Norman03747412022-02-25 10:38:37 -0800595 OPTIONS.output_item_list = common.LoadListFromFile(OPTIONS.output_item_list)
Daniel Normanfdb38812019-04-15 09:47:24 -0700596
Daniel Norman2465fc82022-03-02 12:01:20 -0800597 if not merge_utils.ValidateConfigLists():
Daniel Normane5964522019-03-19 10:32:03 -0700598 sys.exit(1)
599
Daniel Norman2465fc82022-03-02 12:01:20 -0800600 temp_dir = common.MakeTempDir(prefix='merge_target_files_')
601 try:
602 merge_target_files(temp_dir)
603 finally:
604 if OPTIONS.keep_tmp:
605 logger.info('Keeping temp_dir %s', temp_dir)
606 else:
607 common.Cleanup()
Bill Peckhame9eb5f92019-02-01 15:52:10 -0800608
609
610if __name__ == '__main__':
Bill Peckham889b0c62019-02-21 18:53:37 -0800611 main()