blob: fa53ad2fa75e5b58fc30161e2ccc15ef5752c76e [file] [log] [blame]
Doug Zongkereef39442009-04-02 12:14:19 -07001#!/usr/bin/env python
2#
3# Copyright (C) 2008 The Android Open Source Project
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of 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,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16
17"""
Tao Bao2aac9c92019-08-02 15:50:32 -070018Given an input target-files, produces an image zipfile suitable for use with
19'fastboot update'.
Doug Zongkereef39442009-04-02 12:14:19 -070020
21Usage: img_from_target_files [flags] input_target_files output_image_zip
22
Tao Bao2aac9c92019-08-02 15:50:32 -070023input_target_files: Path to the input target_files zip.
Daniel Normanb8a2f9d2019-04-24 12:55:51 -070024
25Flags:
Doug Zongker55d93282011-01-25 17:03:34 -080026 -z (--bootable_zip)
27 Include only the bootable images (eg 'boot' and 'recovery') in
28 the output.
29
Tao Bao57f8ed62019-08-14 23:08:18 -070030 --additional <filespec>
31 Include an additional entry into the generated zip file. The filespec is
32 in a format that's accepted by zip2zip (e.g.
33 'OTA/android-info.txt:android-info.txt', to copy `OTA/android-info.txt`
34 from input_file into output_file as `android-info.txt`. Refer to the
35 `filespec` arg in zip2zip's help message). The option can be repeated to
36 include multiple entries.
37
Doug Zongkereef39442009-04-02 12:14:19 -070038"""
39
Tao Bao89fbb0f2017-01-10 10:47:58 -080040from __future__ import print_function
41
Tao Bao32fcdab2018-10-12 10:30:39 -070042import logging
Tao Bao76def242017-11-21 09:25:31 -080043import os
Doug Zongkereef39442009-04-02 12:14:19 -070044import sys
Tao Bao76def242017-11-21 09:25:31 -080045import zipfile
46
47import common
Yifan Hong0e97dbb2019-04-17 14:28:52 -070048from build_super_image import BuildSuperImage
Doug Zongkereef39442009-04-02 12:14:19 -070049
Doug Zongkercf6d5a92014-02-18 10:57:07 -080050if sys.hexversion < 0x02070000:
Tao Baoac63a9d2019-08-26 20:33:11 -070051 print('Python 2.7 or newer is required.', file=sys.stderr)
Doug Zongkereef39442009-04-02 12:14:19 -070052 sys.exit(1)
53
Tao Bao32fcdab2018-10-12 10:30:39 -070054logger = logging.getLogger(__name__)
Doug Zongkereef39442009-04-02 12:14:19 -070055
56OPTIONS = common.OPTIONS
57
Tao Bao57f8ed62019-08-14 23:08:18 -070058OPTIONS.additional_entries = []
Tao Baoac63a9d2019-08-26 20:33:11 -070059OPTIONS.bootable_only = False
60OPTIONS.put_super = None
Ram Muthiah0c4a3522020-08-27 00:54:13 +000061OPTIONS.put_bootloader = None
Tao Baoac63a9d2019-08-26 20:33:11 -070062OPTIONS.dynamic_partition_list = None
63OPTIONS.super_device_list = None
64OPTIONS.retrofit_dap = None
65OPTIONS.build_super = None
66OPTIONS.sparse_userimages = None
Daniel Zhengee10d072023-06-01 14:18:18 -070067OPTIONS.use_fastboot_info = False
Ying Wanga0febe52013-03-20 11:02:05 -070068
Yifan Hong0e97dbb2019-04-17 14:28:52 -070069def LoadOptions(input_file):
Tao Bao2aac9c92019-08-02 15:50:32 -070070 """Loads information from input_file to OPTIONS.
Yifan Hong0e97dbb2019-04-17 14:28:52 -070071
72 Args:
Tao Bao57f8ed62019-08-14 23:08:18 -070073 input_file: Path to the input target_files zip file.
Yifan Hong0e97dbb2019-04-17 14:28:52 -070074 """
Tao Bao57f8ed62019-08-14 23:08:18 -070075 with zipfile.ZipFile(input_file) as input_zip:
76 info = OPTIONS.info_dict = common.LoadInfoDict(input_zip)
Yifan Hong0e97dbb2019-04-17 14:28:52 -070077
Tao Baoac63a9d2019-08-26 20:33:11 -070078 OPTIONS.put_super = info.get('super_image_in_update_package') == 'true'
Ram Muthiah0c4a3522020-08-27 00:54:13 +000079 OPTIONS.put_bootloader = info.get('bootloader_in_update_package') == 'true'
Tao Baoac63a9d2019-08-26 20:33:11 -070080 OPTIONS.dynamic_partition_list = info.get('dynamic_partition_list',
81 '').strip().split()
82 OPTIONS.super_device_list = info.get('super_block_devices',
83 '').strip().split()
84 OPTIONS.retrofit_dap = info.get('dynamic_partition_retrofit') == 'true'
85 OPTIONS.build_super = info.get('build_super_partition') == 'true'
86 OPTIONS.sparse_userimages = bool(info.get('extfs_sparse_flag'))
Yifan Hong0e97dbb2019-04-17 14:28:52 -070087
88
Tao Bao57f8ed62019-08-14 23:08:18 -070089def CopyZipEntries(input_file, output_file, entries):
90 """Copies ZIP entries between input and output files.
Yifan Hong0e97dbb2019-04-17 14:28:52 -070091
92 Args:
Tao Bao57f8ed62019-08-14 23:08:18 -070093 input_file: Path to the input target_files zip.
94 output_file: Output filename.
95 entries: A list of entries to copy, in a format that's accepted by zip2zip
96 (e.g. 'OTA/android-info.txt:android-info.txt', which copies
97 `OTA/android-info.txt` from input_file into output_file as
98 `android-info.txt`. Refer to the `filespec` arg in zip2zip's help
99 message).
100 """
101 logger.info('Writing %d entries to archive...', len(entries))
102 cmd = ['zip2zip', '-i', input_file, '-o', output_file]
103 cmd.extend(entries)
104 common.RunAndCheckOutput(cmd)
105
106
107def EntriesForUserImages(input_file):
108 """Returns the user images entries to be copied.
109
110 Args:
111 input_file: Path to the input target_files zip file.
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700112 """
Tao Baoac63a9d2019-08-26 20:33:11 -0700113 dynamic_images = [p + '.img' for p in OPTIONS.dynamic_partition_list]
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700114
115 # Filter out system_other for launch DAP devices because it is in super image.
Tao Baoac63a9d2019-08-26 20:33:11 -0700116 if not OPTIONS.retrofit_dap and 'system' in OPTIONS.dynamic_partition_list:
117 dynamic_images.append('system_other.img')
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700118
Tao Bao57f8ed62019-08-14 23:08:18 -0700119 entries = [
120 'OTA/android-info.txt:android-info.txt',
121 ]
Daniel Zhengee10d072023-06-01 14:18:18 -0700122 if OPTIONS.use_fastboot_info:
123 entries.append('META/fastboot-info.txt:fastboot-info.txt')
Tao Bao57f8ed62019-08-14 23:08:18 -0700124 with zipfile.ZipFile(input_file) as input_zip:
125 namelist = input_zip.namelist()
Kelvin Zhangdecee4a2023-05-19 12:33:06 -0700126 if 'PREBUILT_IMAGES/kernel_16k' in namelist:
127 entries.append('PREBUILT_IMAGES/kernel_16k:kernel_16k')
128 if 'PREBUILT_IMAGES/ramdisk_16k.img' in namelist:
129 entries.append('PREBUILT_IMAGES/ramdisk_16k.img:ramdisk_16k.img')
Tao Bao57f8ed62019-08-14 23:08:18 -0700130
131 for image_path in [name for name in namelist if name.startswith('IMAGES/')]:
132 image = os.path.basename(image_path)
Kelvin Zhangdecee4a2023-05-19 12:33:06 -0700133 if OPTIONS.bootable_only and image not in ('boot.img', 'recovery.img', 'bootloader', 'init_boot.img'):
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700134 continue
Ram Muthiah0c4a3522020-08-27 00:54:13 +0000135 if not image.endswith('.img') and image != 'bootloader':
136 continue
137 if image == 'bootloader' and not OPTIONS.put_bootloader:
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700138 continue
Tao Bao57f8ed62019-08-14 23:08:18 -0700139 # Filter out super_empty and the images that are already in super partition.
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700140 if OPTIONS.put_super:
Tao Baoac63a9d2019-08-26 20:33:11 -0700141 if image == 'super_empty.img':
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700142 continue
143 if image in dynamic_images:
144 continue
Tao Bao57f8ed62019-08-14 23:08:18 -0700145 entries.append('{}:{}'.format(image_path, image))
146 return entries
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700147
148
Tao Bao57f8ed62019-08-14 23:08:18 -0700149def EntriesForSplitSuperImages(input_file):
150 """Returns the entries for split super images.
Tao Bao2aac9c92019-08-02 15:50:32 -0700151
Tao Bao57f8ed62019-08-14 23:08:18 -0700152 This is only done for retrofit dynamic partition devices.
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700153
154 Args:
Tao Bao57f8ed62019-08-14 23:08:18 -0700155 input_file: Path to the input target_files zip file.
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700156 """
Tao Bao57f8ed62019-08-14 23:08:18 -0700157 with zipfile.ZipFile(input_file) as input_zip:
158 namelist = input_zip.namelist()
159 entries = []
160 for device in OPTIONS.super_device_list:
161 image = 'OTA/super_{}.img'.format(device)
162 assert image in namelist, 'Failed to find {}'.format(image)
163 entries.append('{}:{}'.format(image, os.path.basename(image)))
164 return entries
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700165
Tao Bao57f8ed62019-08-14 23:08:18 -0700166
167def RebuildAndWriteSuperImages(input_file, output_file):
168 """Builds and writes super images to the output file."""
169 logger.info('Building super image...')
170
171 # We need files under IMAGES/, OTA/, META/ for img_from_target_files.py.
172 # However, common.LoadInfoDict() may read additional files under BOOT/,
173 # RECOVERY/ and ROOT/. So unzip everything from the target_files.zip.
174 input_tmp = common.UnzipTemp(input_file)
175
176 super_file = common.MakeTempFile('super_', '.img')
177 BuildSuperImage(input_tmp, super_file)
178
179 logger.info('Writing super.img to archive...')
180 with zipfile.ZipFile(
Kelvin Zhangdecee4a2023-05-19 12:33:06 -0700181 output_file, 'a', compression=zipfile.ZIP_DEFLATED,
182 allowZip64=True) as output_zip:
Tao Baoac63a9d2019-08-26 20:33:11 -0700183 common.ZipWrite(output_zip, super_file, 'super.img')
Yifan Hong0e97dbb2019-04-17 14:28:52 -0700184
185
Tao Bao2aac9c92019-08-02 15:50:32 -0700186def ImgFromTargetFiles(input_file, output_file):
187 """Creates an image archive from the input target_files zip.
188
189 Args:
190 input_file: Path to the input target_files zip.
191 output_file: Output filename.
192
193 Raises:
194 ValueError: On invalid input.
195 """
jiajia tang92be6ee2021-04-21 15:49:51 +0800196 if not os.path.exists(input_file):
197 raise ValueError('%s is not exist' % input_file)
198
Tao Bao2aac9c92019-08-02 15:50:32 -0700199 if not zipfile.is_zipfile(input_file):
Tao Baoac63a9d2019-08-26 20:33:11 -0700200 raise ValueError('%s is not a valid zipfile' % input_file)
Tao Bao2aac9c92019-08-02 15:50:32 -0700201
Tao Baoac63a9d2019-08-26 20:33:11 -0700202 logger.info('Building image zip from target files zip.')
Tao Bao2aac9c92019-08-02 15:50:32 -0700203
Tao Bao57f8ed62019-08-14 23:08:18 -0700204 LoadOptions(input_file)
Tao Bao2aac9c92019-08-02 15:50:32 -0700205
Tao Bao57f8ed62019-08-14 23:08:18 -0700206 # Entries to be copied into the output file.
207 entries = EntriesForUserImages(input_file)
Tao Bao2aac9c92019-08-02 15:50:32 -0700208
Tao Bao57f8ed62019-08-14 23:08:18 -0700209 # Only for devices that retrofit dynamic partitions there're split super
210 # images available in the target_files.zip.
211 rebuild_super = False
212 if OPTIONS.build_super and OPTIONS.put_super:
213 if OPTIONS.retrofit_dap:
214 entries += EntriesForSplitSuperImages(input_file)
215 else:
216 rebuild_super = True
217
218 # Any additional entries provided by caller.
219 entries += OPTIONS.additional_entries
220
221 CopyZipEntries(input_file, output_file, entries)
222
223 if rebuild_super:
224 RebuildAndWriteSuperImages(input_file, output_file)
Tao Bao2aac9c92019-08-02 15:50:32 -0700225
226
Doug Zongkereef39442009-04-02 12:14:19 -0700227def main(argv):
228
Tao Bao57f8ed62019-08-14 23:08:18 -0700229 def option_handler(o, a):
Tao Baoac63a9d2019-08-26 20:33:11 -0700230 if o in ('-z', '--bootable_zip'):
231 OPTIONS.bootable_only = True
Tao Bao57f8ed62019-08-14 23:08:18 -0700232 elif o == '--additional':
233 OPTIONS.additional_entries.append(a)
Doug Zongkereef39442009-04-02 12:14:19 -0700234 else:
235 return False
Doug Zongkerfdd8e692009-08-03 17:27:48 -0700236 return True
Doug Zongkereef39442009-04-02 12:14:19 -0700237
238 args = common.ParseOptions(argv, __doc__,
Tao Baoac63a9d2019-08-26 20:33:11 -0700239 extra_opts='z',
Tao Bao57f8ed62019-08-14 23:08:18 -0700240 extra_long_opts=[
241 'additional=',
242 'bootable_zip',
243 ],
Doug Zongkereef39442009-04-02 12:14:19 -0700244 extra_option_handler=option_handler)
Doug Zongkereef39442009-04-02 12:14:19 -0700245 if len(args) != 2:
246 common.Usage(__doc__)
247 sys.exit(1)
248
Tao Bao32fcdab2018-10-12 10:30:39 -0700249 common.InitLogging()
250
Tao Bao2aac9c92019-08-02 15:50:32 -0700251 ImgFromTargetFiles(args[0], args[1])
Doug Zongkereef39442009-04-02 12:14:19 -0700252
Tao Baoac63a9d2019-08-26 20:33:11 -0700253 logger.info('done.')
Doug Zongkereef39442009-04-02 12:14:19 -0700254
255
256if __name__ == '__main__':
257 try:
Ying Wang7e6d4e42010-12-13 16:25:36 -0800258 common.CloseInheritedPipes()
Doug Zongkereef39442009-04-02 12:14:19 -0700259 main(sys.argv[1:])
Daniel Norman1bd2a1d2019-04-18 12:32:18 -0700260 finally:
261 common.Cleanup()