blob: ac970d1f9d05f0105c2335ae64a124e995833361 [file] [log] [blame]
Doug Zongker3c84f562014-07-31 11:06:30 -07001#!/usr/bin/env python
2#
3# Copyright (C) 2014 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"""
18Given a target-files zipfile that does not contain images (ie, does
19not have an IMAGES/ top-level subdirectory), produce the images and
20add them to the zipfile.
21
Tianjie Xub48589a2016-08-03 19:21:52 -070022Usage: add_img_to_target_files [flag] target_files
23
24 -a (--add_missing)
25 Build and add missing images to "IMAGES/". If this option is
26 not specified, this script will simply exit when "IMAGES/"
27 directory exists in the target file.
28
29 -r (--rebuild_recovery)
30 Rebuild the recovery patch and write it to the system image. Only
31 meaningful when system image needs to be rebuilt.
32
33 --replace_verity_private_key
34 Replace the private key used for verity signing. (same as the option
35 in sign_target_files_apks)
36
37 --replace_verity_public_key
38 Replace the certificate (public key) used for verity verification. (same
39 as the option in sign_target_files_apks)
40
41 --is_signing
42 Skip building & adding the images for "userdata" and "cache" if we
43 are signing the target files.
Doug Zongker3c84f562014-07-31 11:06:30 -070044"""
45
Tao Bao89fbb0f2017-01-10 10:47:58 -080046from __future__ import print_function
47
Doug Zongker3c84f562014-07-31 11:06:30 -070048import sys
49
50if sys.hexversion < 0x02070000:
Tao Bao89fbb0f2017-01-10 10:47:58 -080051 print("Python 2.7 or newer is required.", file=sys.stderr)
Doug Zongker3c84f562014-07-31 11:06:30 -070052 sys.exit(1)
53
Tao Bao822f5842015-09-30 16:01:14 -070054import datetime
Doug Zongker3c84f562014-07-31 11:06:30 -070055import errno
56import os
David Zeuthend995f4b2016-01-29 16:59:17 -050057import shlex
Ying Wang2a048392015-06-25 13:56:53 -070058import shutil
David Zeuthend995f4b2016-01-29 16:59:17 -050059import subprocess
Doug Zongker3c84f562014-07-31 11:06:30 -070060import tempfile
61import zipfile
62
Doug Zongker3c84f562014-07-31 11:06:30 -070063import build_image
64import common
Tianjie Xuf1a13182017-01-19 17:39:30 -080065import rangelib
Tianjie Xucfa86222016-03-07 16:31:19 -080066import sparse_img
Doug Zongker3c84f562014-07-31 11:06:30 -070067
68OPTIONS = common.OPTIONS
69
Michael Runge2e0d8fc2014-11-13 21:41:08 -080070OPTIONS.add_missing = False
71OPTIONS.rebuild_recovery = False
Tianjie Xu38af07f2017-05-25 17:38:53 -070072OPTIONS.replace_recovery_patch_files_list = []
Baligh Uddin59f4ff12015-09-16 21:20:30 -070073OPTIONS.replace_verity_public_key = False
74OPTIONS.replace_verity_private_key = False
Tianjie Xub48589a2016-08-03 19:21:52 -070075OPTIONS.is_signing = False
Doug Zongker3c84f562014-07-31 11:06:30 -070076
Dan Willemsen2ee00d52017-03-05 19:51:56 -080077
78class OutputFile(object):
79 def __init__(self, output_zip, input_dir, prefix, name):
80 self._output_zip = output_zip
81 self.input_name = os.path.join(input_dir, prefix, name)
82
83 if self._output_zip:
84 self._zip_name = os.path.join(prefix, name)
85
86 root, suffix = os.path.splitext(name)
87 self.name = common.MakeTempFile(prefix=root + '-', suffix=suffix)
88 else:
89 self.name = self.input_name
90
91 def Write(self):
92 if self._output_zip:
93 common.ZipWrite(self._output_zip, self.name, self._zip_name)
94
95
Tianjie Xucfa86222016-03-07 16:31:19 -080096def GetCareMap(which, imgname):
97 """Generate care_map of system (or vendor) partition"""
98
99 assert which in ("system", "vendor")
Tianjie Xucfa86222016-03-07 16:31:19 -0800100
101 simg = sparse_img.SparseImage(imgname)
102 care_map_list = []
Tianjie Xu955629b2017-03-01 11:48:25 -0800103 care_map_list.append(which)
Tianjie Xuf1a13182017-01-19 17:39:30 -0800104
105 care_map_ranges = simg.care_map
106 key = which + "_adjusted_partition_size"
107 adjusted_blocks = OPTIONS.info_dict.get(key)
108 if adjusted_blocks:
109 assert adjusted_blocks > 0, "blocks should be positive for " + which
110 care_map_ranges = care_map_ranges.intersect(rangelib.RangeSet(
111 "0-%d" % (adjusted_blocks,)))
112
113 care_map_list.append(care_map_ranges.to_string_raw())
Tianjie Xucfa86222016-03-07 16:31:19 -0800114 return care_map_list
115
116
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800117def AddSystem(output_zip, prefix="IMAGES/", recovery_img=None, boot_img=None):
Doug Zongker3c84f562014-07-31 11:06:30 -0700118 """Turn the contents of SYSTEM into a system image and store it in
David Zeuthend995f4b2016-01-29 16:59:17 -0500119 output_zip. Returns the name of the system image file."""
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800120
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800121 img = OutputFile(output_zip, OPTIONS.input_tmp, prefix, "system.img")
122 if os.path.exists(img.input_name):
Tao Bao89fbb0f2017-01-10 10:47:58 -0800123 print("system.img already exists in %s, no need to rebuild..." % (prefix,))
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800124 return img.input_name
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800125
126 def output_sink(fn, data):
Dan Albert8b72aef2015-03-23 19:13:21 -0700127 ofile = open(os.path.join(OPTIONS.input_tmp, "SYSTEM", fn), "w")
128 ofile.write(data)
129 ofile.close()
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800130
Tianjie Xu38af07f2017-05-25 17:38:53 -0700131 arc_name = "SYSTEM/" + fn
132 if arc_name in output_zip.namelist():
133 OPTIONS.replace_recovery_patch_files_list.append(arc_name)
134 else:
135 common.ZipWrite(output_zip, ofile.name, arc_name)
136
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800137 if OPTIONS.rebuild_recovery:
Tao Bao89fbb0f2017-01-10 10:47:58 -0800138 print("Building new recovery patch")
Dan Albert8b72aef2015-03-23 19:13:21 -0700139 common.MakeRecoveryPatch(OPTIONS.input_tmp, output_sink, recovery_img,
140 boot_img, info_dict=OPTIONS.info_dict)
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800141
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800142 block_list = OutputFile(output_zip, OPTIONS.input_tmp, prefix, "system.map")
143 CreateImage(OPTIONS.input_tmp, OPTIONS.info_dict, "system", img,
144 block_list=block_list)
David Zeuthend995f4b2016-01-29 16:59:17 -0500145
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800146 return img.name
Doug Zongkerfc44a512014-08-26 13:10:25 -0700147
148
Alex Light4e358ab2016-06-16 14:47:10 -0700149def AddSystemOther(output_zip, prefix="IMAGES/"):
150 """Turn the contents of SYSTEM_OTHER into a system_other image
151 and store it in output_zip."""
152
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800153 img = OutputFile(output_zip, OPTIONS.input_tmp, prefix, "system_other.img")
154 if os.path.exists(img.input_name):
Tao Bao89fbb0f2017-01-10 10:47:58 -0800155 print("system_other.img already exists in %s, no need to rebuild..." % (
156 prefix,))
Alex Light4e358ab2016-06-16 14:47:10 -0700157 return
158
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800159 CreateImage(OPTIONS.input_tmp, OPTIONS.info_dict, "system_other", img)
Alex Light4e358ab2016-06-16 14:47:10 -0700160
161
Doug Zongkerfc44a512014-08-26 13:10:25 -0700162def AddVendor(output_zip, prefix="IMAGES/"):
163 """Turn the contents of VENDOR into a vendor image and store in it
164 output_zip."""
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800165
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800166 img = OutputFile(output_zip, OPTIONS.input_tmp, prefix, "vendor.img")
167 if os.path.exists(img.input_name):
Tao Bao89fbb0f2017-01-10 10:47:58 -0800168 print("vendor.img already exists in %s, no need to rebuild..." % (prefix,))
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800169 return img.input_name
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800170
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800171 block_list = OutputFile(output_zip, OPTIONS.input_tmp, prefix, "vendor.map")
172 CreateImage(OPTIONS.input_tmp, OPTIONS.info_dict, "vendor", img,
173 block_list=block_list)
174 return img.name
Doug Zongker3c84f562014-07-31 11:06:30 -0700175
Yueyao Zhu889ee5e2017-05-12 17:50:46 -0700176
Tao Baoc633ed02017-05-30 21:46:33 -0700177def AddDtbo(output_zip, prefix="IMAGES/"):
178 """Adds the DTBO image.
179
180 Uses the image under prefix if it already exists. Otherwise looks for the
181 image under PREBUILT_IMAGES/, signs it as needed, and returns the image name.
182 """
183
184 img = OutputFile(output_zip, OPTIONS.input_tmp, prefix, "dtbo.img")
185 if os.path.exists(img.input_name):
186 print("dtbo.img already exists in %s, no need to rebuild..." % (prefix,))
187 return img.input_name
188
189 dtbo_prebuilt_path = os.path.join(
190 OPTIONS.input_tmp, "PREBUILT_IMAGES", "dtbo.img")
191 assert os.path.exists(dtbo_prebuilt_path)
192 shutil.copy(dtbo_prebuilt_path, img.name)
193
194 # AVB-sign the image as needed.
195 if OPTIONS.info_dict.get("board_avb_enable") == "true":
196 avbtool = os.getenv('AVBTOOL') or OPTIONS.info_dict["avb_avbtool"]
197 part_size = OPTIONS.info_dict.get("dtbo_size")
198 # The AVB hash footer will be replaced if already present.
199 cmd = [avbtool, "add_hash_footer", "--image", img.name,
200 "--partition_size", str(part_size), "--partition_name", "dtbo"]
201 common.AppendAVBSigningArgs(cmd)
202 args = OPTIONS.info_dict.get("board_avb_dtbo_add_hash_footer_args")
203 if args and args.strip():
204 cmd.extend(shlex.split(args))
205 p = common.Run(cmd, stdout=subprocess.PIPE)
206 p.communicate()
207 assert p.returncode == 0, \
208 "avbtool add_hash_footer of %s failed" % (img.name,)
209
210 img.Write()
211 return img.name
212
Doug Zongker3c84f562014-07-31 11:06:30 -0700213
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800214def CreateImage(input_dir, info_dict, what, output_file, block_list=None):
Tao Bao89fbb0f2017-01-10 10:47:58 -0800215 print("creating " + what + ".img...")
Doug Zongker3c84f562014-07-31 11:06:30 -0700216
Doug Zongker3c84f562014-07-31 11:06:30 -0700217 # The name of the directory it is making an image out of matters to
218 # mkyaffs2image. It wants "system" but we have a directory named
219 # "SYSTEM", so create a symlink.
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800220 temp_dir = tempfile.mkdtemp()
221 OPTIONS.tempfiles.append(temp_dir)
Doug Zongker3c84f562014-07-31 11:06:30 -0700222 try:
223 os.symlink(os.path.join(input_dir, what.upper()),
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800224 os.path.join(temp_dir, what))
Dan Albert8b72aef2015-03-23 19:13:21 -0700225 except OSError as e:
226 # bogus error on my mac version?
227 # File "./build/tools/releasetools/img_from_target_files"
228 # os.path.join(OPTIONS.input_tmp, "system"))
229 # OSError: [Errno 17] File exists
230 if e.errno == errno.EEXIST:
Doug Zongker3c84f562014-07-31 11:06:30 -0700231 pass
232
233 image_props = build_image.ImagePropFromGlobalDict(info_dict, what)
234 fstab = info_dict["fstab"]
Tianjie Xucfa86222016-03-07 16:31:19 -0800235 mount_point = "/" + what
236 if fstab and mount_point in fstab:
237 image_props["fs_type"] = fstab[mount_point].fs_type
Doug Zongker3c84f562014-07-31 11:06:30 -0700238
Tao Bao822f5842015-09-30 16:01:14 -0700239 # Use a fixed timestamp (01/01/2009) when packaging the image.
240 # Bug: 24377993
241 epoch = datetime.datetime.fromtimestamp(0)
242 timestamp = (datetime.datetime(2009, 1, 1) - epoch).total_seconds()
243 image_props["timestamp"] = int(timestamp)
244
Doug Zongker3c84f562014-07-31 11:06:30 -0700245 if what == "system":
246 fs_config_prefix = ""
247 else:
248 fs_config_prefix = what + "_"
249
250 fs_config = os.path.join(
251 input_dir, "META/" + fs_config_prefix + "filesystem_config.txt")
Dan Albert8b72aef2015-03-23 19:13:21 -0700252 if not os.path.exists(fs_config):
253 fs_config = None
Doug Zongker3c84f562014-07-31 11:06:30 -0700254
Ying Wanga2292c92015-03-24 19:07:40 -0700255 # Override values loaded from info_dict.
256 if fs_config:
257 image_props["fs_config"] = fs_config
Ying Wanga2292c92015-03-24 19:07:40 -0700258 if block_list:
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800259 image_props["block_list"] = block_list.name
Ying Wanga2292c92015-03-24 19:07:40 -0700260
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800261 succ = build_image.BuildImage(os.path.join(temp_dir, what),
262 image_props, output_file.name)
Doug Zongker3c84f562014-07-31 11:06:30 -0700263 assert succ, "build " + what + ".img image failed"
264
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800265 output_file.Write()
266 if block_list:
267 block_list.Write()
268
Tianjie Xu6b2e1552017-06-01 11:32:32 -0700269 # Set the 'adjusted_partition_size' that excludes the verity blocks of the
270 # given image. When avb is enabled, this size is the max image size returned
271 # by the avb tool.
Tianjie Xuf1a13182017-01-19 17:39:30 -0800272 is_verity_partition = "verity_block_device" in image_props
Tianjie Xu6b2e1552017-06-01 11:32:32 -0700273 verity_supported = (image_props.get("verity") == "true" or
274 image_props.get("board_avb_enable") == "true")
275 is_avb_enable = image_props.get("avb_hashtree_enable") == "true"
276 if verity_supported and (is_verity_partition or is_avb_enable):
Tianjie Xuf1a13182017-01-19 17:39:30 -0800277 adjusted_blocks_value = image_props.get("partition_size")
278 if adjusted_blocks_value:
279 adjusted_blocks_key = what + "_adjusted_partition_size"
280 info_dict[adjusted_blocks_key] = int(adjusted_blocks_value)/4096 - 1
281
Doug Zongker3c84f562014-07-31 11:06:30 -0700282
283def AddUserdata(output_zip, prefix="IMAGES/"):
Ying Wang2a048392015-06-25 13:56:53 -0700284 """Create a userdata image and store it in output_zip.
285
286 In most case we just create and store an empty userdata.img;
287 But the invoker can also request to create userdata.img with real
288 data from the target files, by setting "userdata_img_with_data=true"
289 in OPTIONS.info_dict.
290 """
Doug Zongker3c84f562014-07-31 11:06:30 -0700291
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800292 img = OutputFile(output_zip, OPTIONS.input_tmp, prefix, "userdata.img")
293 if os.path.exists(img.input_name):
Tao Bao89fbb0f2017-01-10 10:47:58 -0800294 print("userdata.img already exists in %s, no need to rebuild..." % (
295 prefix,))
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800296 return
297
Elliott Hughes305b0882016-06-15 17:04:54 -0700298 # Skip userdata.img if no size.
Tao Bao2c15d9e2015-07-09 11:51:16 -0700299 image_props = build_image.ImagePropFromGlobalDict(OPTIONS.info_dict, "data")
Elliott Hughes305b0882016-06-15 17:04:54 -0700300 if not image_props.get("partition_size"):
Doug Zongker3c84f562014-07-31 11:06:30 -0700301 return
302
Tao Bao89fbb0f2017-01-10 10:47:58 -0800303 print("creating userdata.img...")
Doug Zongker3c84f562014-07-31 11:06:30 -0700304
Tao Bao822f5842015-09-30 16:01:14 -0700305 # Use a fixed timestamp (01/01/2009) when packaging the image.
306 # Bug: 24377993
307 epoch = datetime.datetime.fromtimestamp(0)
308 timestamp = (datetime.datetime(2009, 1, 1) - epoch).total_seconds()
309 image_props["timestamp"] = int(timestamp)
310
Doug Zongker3c84f562014-07-31 11:06:30 -0700311 # The name of the directory it is making an image out of matters to
312 # mkyaffs2image. So we create a temp dir, and within it we create an
Ying Wang2a048392015-06-25 13:56:53 -0700313 # empty dir named "data", or a symlink to the DATA dir,
314 # and build the image from that.
Doug Zongker3c84f562014-07-31 11:06:30 -0700315 temp_dir = tempfile.mkdtemp()
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800316 OPTIONS.tempfiles.append(temp_dir)
Doug Zongker3c84f562014-07-31 11:06:30 -0700317 user_dir = os.path.join(temp_dir, "data")
Ying Wang2a048392015-06-25 13:56:53 -0700318 empty = (OPTIONS.info_dict.get("userdata_img_with_data") != "true")
319 if empty:
320 # Create an empty dir.
321 os.mkdir(user_dir)
322 else:
323 # Symlink to the DATA dir.
324 os.symlink(os.path.join(OPTIONS.input_tmp, "DATA"),
325 user_dir)
326
Doug Zongker3c84f562014-07-31 11:06:30 -0700327 fstab = OPTIONS.info_dict["fstab"]
328 if fstab:
Dan Albert8b72aef2015-03-23 19:13:21 -0700329 image_props["fs_type"] = fstab["/data"].fs_type
Doug Zongker3c84f562014-07-31 11:06:30 -0700330 succ = build_image.BuildImage(user_dir, image_props, img.name)
331 assert succ, "build userdata.img image failed"
332
333 common.CheckSize(img.name, "userdata.img", OPTIONS.info_dict)
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800334 img.Write()
Doug Zongker3c84f562014-07-31 11:06:30 -0700335
336
Bowgo Tsai8ee4a3d2017-03-31 15:21:26 +0800337def AddVBMeta(output_zip, boot_img_path, system_img_path, vendor_img_path,
Yueyao Zhu889ee5e2017-05-12 17:50:46 -0700338 dtbo_img_path, prefix="IMAGES/"):
David Zeuthen2ce63ed2016-09-15 13:43:54 -0400339 """Create a VBMeta image and store it in output_zip."""
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800340 img = OutputFile(output_zip, OPTIONS.input_tmp, prefix, "vbmeta.img")
Tao Baoc633ed02017-05-30 21:46:33 -0700341 avbtool = os.getenv('AVBTOOL') or OPTIONS.info_dict["avb_avbtool"]
David Zeuthen2ce63ed2016-09-15 13:43:54 -0400342 cmd = [avbtool, "make_vbmeta_image",
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800343 "--output", img.name,
David Zeuthen2ce63ed2016-09-15 13:43:54 -0400344 "--include_descriptors_from_image", boot_img_path,
Bowgo Tsai9b377602017-04-14 18:50:11 +0800345 "--include_descriptors_from_image", system_img_path]
Bowgo Tsai8ee4a3d2017-03-31 15:21:26 +0800346 if vendor_img_path is not None:
347 cmd.extend(["--include_descriptors_from_image", vendor_img_path])
Yueyao Zhu889ee5e2017-05-12 17:50:46 -0700348 if dtbo_img_path is not None:
349 cmd.extend(["--include_descriptors_from_image", dtbo_img_path])
Tao Baoc633ed02017-05-30 21:46:33 -0700350 if OPTIONS.info_dict.get("system_root_image") == "true":
Bowgo Tsai9b377602017-04-14 18:50:11 +0800351 cmd.extend(["--setup_rootfs_from_kernel", system_img_path])
David Zeuthen2ce63ed2016-09-15 13:43:54 -0400352 common.AppendAVBSigningArgs(cmd)
Tao Baoc633ed02017-05-30 21:46:33 -0700353 args = OPTIONS.info_dict.get("board_avb_make_vbmeta_image_args")
David Zeuthen2ce63ed2016-09-15 13:43:54 -0400354 if args and args.strip():
355 cmd.extend(shlex.split(args))
356 p = common.Run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
357 p.communicate()
358 assert p.returncode == 0, "avbtool make_vbmeta_image failed"
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800359 img.Write()
David Zeuthen2ce63ed2016-09-15 13:43:54 -0400360
361
David Zeuthen25328622016-04-08 15:08:03 -0400362def AddPartitionTable(output_zip, prefix="IMAGES/"):
363 """Create a partition table image and store it in output_zip."""
364
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800365 img = OutputFile(output_zip, OPTIONS.input_tmp, prefix, "partition-table.img")
366 bpt = OutputFile(output_zip, OPTIONS.input_tmp, prefix, "partition-table.bpt")
David Zeuthen25328622016-04-08 15:08:03 -0400367
368 # use BPTTOOL from environ, or "bpttool" if empty or not set.
369 bpttool = os.getenv("BPTTOOL") or "bpttool"
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800370 cmd = [bpttool, "make_table", "--output_json", bpt.name,
371 "--output_gpt", img.name]
David Zeuthen25328622016-04-08 15:08:03 -0400372 input_files_str = OPTIONS.info_dict["board_bpt_input_files"]
373 input_files = input_files_str.split(" ")
374 for i in input_files:
375 cmd.extend(["--input", i])
376 disk_size = OPTIONS.info_dict.get("board_bpt_disk_size")
377 if disk_size:
378 cmd.extend(["--disk_size", disk_size])
379 args = OPTIONS.info_dict.get("board_bpt_make_table_args")
380 if args:
381 cmd.extend(shlex.split(args))
382
383 p = common.Run(cmd, stdout=subprocess.PIPE)
384 p.communicate()
385 assert p.returncode == 0, "bpttool make_table failed"
386
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800387 img.Write()
388 bpt.Write()
David Zeuthen25328622016-04-08 15:08:03 -0400389
390
Doug Zongker3c84f562014-07-31 11:06:30 -0700391def AddCache(output_zip, prefix="IMAGES/"):
392 """Create an empty cache image and store it in output_zip."""
393
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800394 img = OutputFile(output_zip, OPTIONS.input_tmp, prefix, "cache.img")
395 if os.path.exists(img.input_name):
Tao Bao89fbb0f2017-01-10 10:47:58 -0800396 print("cache.img already exists in %s, no need to rebuild..." % (prefix,))
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800397 return
398
Tao Bao2c15d9e2015-07-09 11:51:16 -0700399 image_props = build_image.ImagePropFromGlobalDict(OPTIONS.info_dict, "cache")
Doug Zongker3c84f562014-07-31 11:06:30 -0700400 # The build system has to explicitly request for cache.img.
401 if "fs_type" not in image_props:
402 return
403
Tao Bao89fbb0f2017-01-10 10:47:58 -0800404 print("creating cache.img...")
Doug Zongker3c84f562014-07-31 11:06:30 -0700405
Tao Bao822f5842015-09-30 16:01:14 -0700406 # Use a fixed timestamp (01/01/2009) when packaging the image.
407 # Bug: 24377993
408 epoch = datetime.datetime.fromtimestamp(0)
409 timestamp = (datetime.datetime(2009, 1, 1) - epoch).total_seconds()
410 image_props["timestamp"] = int(timestamp)
411
Doug Zongker3c84f562014-07-31 11:06:30 -0700412 # The name of the directory it is making an image out of matters to
413 # mkyaffs2image. So we create a temp dir, and within it we create an
414 # empty dir named "cache", and build the image from that.
415 temp_dir = tempfile.mkdtemp()
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800416 OPTIONS.tempfiles.append(temp_dir)
Doug Zongker3c84f562014-07-31 11:06:30 -0700417 user_dir = os.path.join(temp_dir, "cache")
418 os.mkdir(user_dir)
Doug Zongker3c84f562014-07-31 11:06:30 -0700419
420 fstab = OPTIONS.info_dict["fstab"]
421 if fstab:
Dan Albert8b72aef2015-03-23 19:13:21 -0700422 image_props["fs_type"] = fstab["/cache"].fs_type
Doug Zongker3c84f562014-07-31 11:06:30 -0700423 succ = build_image.BuildImage(user_dir, image_props, img.name)
424 assert succ, "build cache.img image failed"
425
426 common.CheckSize(img.name, "cache.img", OPTIONS.info_dict)
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800427 img.Write()
Doug Zongker3c84f562014-07-31 11:06:30 -0700428
429
Tianjie Xu38af07f2017-05-25 17:38:53 -0700430def ReplaceRecoveryPatchFiles(zip_filename):
431 """Update the related files under SYSTEM/ after rebuilding recovery."""
432
433 cmd = ["zip", "-d", zip_filename] + OPTIONS.replace_recovery_patch_files_list
434 p = common.Run(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
435 p.communicate()
436
437 output_zip = zipfile.ZipFile(zip_filename, "a",
438 compression=zipfile.ZIP_DEFLATED,
439 allowZip64=True)
440 for item in OPTIONS.replace_recovery_patch_files_list:
441 file_path = os.path.join(OPTIONS.input_tmp, item)
442 assert os.path.exists(file_path)
443 common.ZipWrite(output_zip, file_path, arcname=item)
444 common.ZipClose(output_zip)
445
446
Doug Zongker3c84f562014-07-31 11:06:30 -0700447def AddImagesToTargetFiles(filename):
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800448 if os.path.isdir(filename):
449 OPTIONS.input_tmp = os.path.abspath(filename)
450 input_zip = None
451 else:
452 OPTIONS.input_tmp, input_zip = common.UnzipTemp(filename)
Doug Zongkerfc44a512014-08-26 13:10:25 -0700453
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800454 if not OPTIONS.add_missing:
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800455 if os.path.isdir(os.path.join(OPTIONS.input_tmp, "IMAGES")):
456 print("target_files appears to already contain images.")
457 sys.exit(1)
Doug Zongkerfc44a512014-08-26 13:10:25 -0700458
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800459 has_vendor = os.path.isdir(os.path.join(OPTIONS.input_tmp, "VENDOR"))
460 has_system_other = os.path.isdir(os.path.join(OPTIONS.input_tmp,
461 "SYSTEM_OTHER"))
Doug Zongker3c84f562014-07-31 11:06:30 -0700462
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800463 if input_zip:
464 OPTIONS.info_dict = common.LoadInfoDict(input_zip, OPTIONS.input_tmp)
Alex Light4e358ab2016-06-16 14:47:10 -0700465
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800466 common.ZipClose(input_zip)
467 output_zip = zipfile.ZipFile(filename, "a",
468 compression=zipfile.ZIP_DEFLATED,
469 allowZip64=True)
470 else:
471 OPTIONS.info_dict = common.LoadInfoDict(filename, filename)
472 output_zip = None
473 images_dir = os.path.join(OPTIONS.input_tmp, "IMAGES")
474 if not os.path.isdir(images_dir):
475 os.makedirs(images_dir)
476 images_dir = None
Doug Zongker3c84f562014-07-31 11:06:30 -0700477
Tao Baodb45efa2015-10-27 19:25:18 -0700478 has_recovery = (OPTIONS.info_dict.get("no_recovery") != "true")
479
Doug Zongkerfc44a512014-08-26 13:10:25 -0700480 def banner(s):
Tao Bao89fbb0f2017-01-10 10:47:58 -0800481 print("\n\n++++ " + s + " ++++\n\n")
Doug Zongker3c84f562014-07-31 11:06:30 -0700482
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800483 prebuilt_path = os.path.join(OPTIONS.input_tmp, "IMAGES", "boot.img")
484 boot_image = None
485 if os.path.exists(prebuilt_path):
David Zeuthend995f4b2016-01-29 16:59:17 -0500486 banner("boot")
Tao Bao89fbb0f2017-01-10 10:47:58 -0800487 print("boot.img already exists in IMAGES/, no need to rebuild...")
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800488 if OPTIONS.rebuild_recovery:
489 boot_image = common.GetBootableImage(
490 "IMAGES/boot.img", "boot.img", OPTIONS.input_tmp, "BOOT")
491 else:
David Zeuthen2ce63ed2016-09-15 13:43:54 -0400492 banner("boot")
493 boot_image = common.GetBootableImage(
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800494 "IMAGES/boot.img", "boot.img", OPTIONS.input_tmp, "BOOT")
David Zeuthen2ce63ed2016-09-15 13:43:54 -0400495 if boot_image:
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800496 if output_zip:
497 boot_image.AddToZip(output_zip)
498 else:
499 boot_image.WriteToDir(OPTIONS.input_tmp)
Doug Zongker3c84f562014-07-31 11:06:30 -0700500
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800501 recovery_image = None
Tao Baodb45efa2015-10-27 19:25:18 -0700502 if has_recovery:
503 banner("recovery")
504 prebuilt_path = os.path.join(OPTIONS.input_tmp, "IMAGES", "recovery.img")
505 if os.path.exists(prebuilt_path):
Tao Bao89fbb0f2017-01-10 10:47:58 -0800506 print("recovery.img already exists in IMAGES/, no need to rebuild...")
Tao Baodb45efa2015-10-27 19:25:18 -0700507 if OPTIONS.rebuild_recovery:
508 recovery_image = common.GetBootableImage(
509 "IMAGES/recovery.img", "recovery.img", OPTIONS.input_tmp,
510 "RECOVERY")
511 else:
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800512 recovery_image = common.GetBootableImage(
513 "IMAGES/recovery.img", "recovery.img", OPTIONS.input_tmp, "RECOVERY")
Tao Baodb45efa2015-10-27 19:25:18 -0700514 if recovery_image:
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800515 if output_zip:
516 recovery_image.AddToZip(output_zip)
517 else:
518 recovery_image.WriteToDir(OPTIONS.input_tmp)
Doug Zongker3c84f562014-07-31 11:06:30 -0700519
Tao Baod42e97e2016-11-30 12:11:57 -0800520 banner("recovery (two-step image)")
521 # The special recovery.img for two-step package use.
522 recovery_two_step_image = common.GetBootableImage(
523 "IMAGES/recovery-two-step.img", "recovery-two-step.img",
524 OPTIONS.input_tmp, "RECOVERY", two_step_image=True)
525 if recovery_two_step_image:
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800526 if output_zip:
527 recovery_two_step_image.AddToZip(output_zip)
528 else:
529 recovery_two_step_image.WriteToDir(OPTIONS.input_tmp)
Tao Baod42e97e2016-11-30 12:11:57 -0800530
Doug Zongkerfc44a512014-08-26 13:10:25 -0700531 banner("system")
David Zeuthend995f4b2016-01-29 16:59:17 -0500532 system_img_path = AddSystem(
Tao Baoc633ed02017-05-30 21:46:33 -0700533 output_zip, recovery_img=recovery_image, boot_img=boot_image)
Tianjie Xu737afb92016-07-11 11:42:53 -0700534 vendor_img_path = None
Doug Zongkerfc44a512014-08-26 13:10:25 -0700535 if has_vendor:
536 banner("vendor")
Tianjie Xu737afb92016-07-11 11:42:53 -0700537 vendor_img_path = AddVendor(output_zip)
Alex Light4e358ab2016-06-16 14:47:10 -0700538 if has_system_other:
539 banner("system_other")
540 AddSystemOther(output_zip)
Tianjie Xub48589a2016-08-03 19:21:52 -0700541 if not OPTIONS.is_signing:
542 banner("userdata")
543 AddUserdata(output_zip)
544 banner("cache")
545 AddCache(output_zip)
Tao Baoc633ed02017-05-30 21:46:33 -0700546
547 if OPTIONS.info_dict.get("board_bpt_enable") == "true":
David Zeuthen25328622016-04-08 15:08:03 -0400548 banner("partition-table")
549 AddPartitionTable(output_zip)
Tao Baoc633ed02017-05-30 21:46:33 -0700550
551 dtbo_img_path = None
552 if OPTIONS.info_dict.get("has_dtbo") == "true":
553 banner("dtbo")
554 dtbo_img_path = AddDtbo(output_zip)
555
556 if OPTIONS.info_dict.get("board_avb_enable") == "true":
David Zeuthen2ce63ed2016-09-15 13:43:54 -0400557 banner("vbmeta")
558 boot_contents = boot_image.WriteToTemp()
Yueyao Zhu889ee5e2017-05-12 17:50:46 -0700559 AddVBMeta(output_zip, boot_contents.name, system_img_path,
560 vendor_img_path, dtbo_img_path)
Doug Zongker3c84f562014-07-31 11:06:30 -0700561
Wei Wang2e735ca2016-05-10 22:48:13 -0700562 # For devices using A/B update, copy over images from RADIO/ and/or
563 # VENDOR_IMAGES/ to IMAGES/ and make sure we have all the needed
564 # images ready under IMAGES/. All images should have '.img' as extension.
Tianjie Xuaaca4212016-06-28 14:34:03 -0700565 banner("radio")
Tao Baoa0421cd2015-11-16 16:32:27 -0800566 ab_partitions = os.path.join(OPTIONS.input_tmp, "META", "ab_partitions.txt")
567 if os.path.exists(ab_partitions):
568 with open(ab_partitions, 'r') as f:
569 lines = f.readlines()
Tianjie Xucfa86222016-03-07 16:31:19 -0800570 # For devices using A/B update, generate care_map for system and vendor
571 # partitions (if present), then write this file to target_files package.
572 care_map_list = []
Tao Baoa0421cd2015-11-16 16:32:27 -0800573 for line in lines:
Tianjie Xu6b2e1552017-06-01 11:32:32 -0700574 if line.strip() == "system" and (
575 "system_verity_block_device" in OPTIONS.info_dict or
576 OPTIONS.info_dict.get("system_avb_hashtree_enable") == "true"):
Tianjie Xu737afb92016-07-11 11:42:53 -0700577 assert os.path.exists(system_img_path)
578 care_map_list += GetCareMap("system", system_img_path)
Tianjie Xu6b2e1552017-06-01 11:32:32 -0700579 if line.strip() == "vendor" and (
580 "vendor_verity_block_device" in OPTIONS.info_dict or
581 OPTIONS.info_dict.get("vendor_avb_hashtree_enable") == "true"):
Tianjie Xu737afb92016-07-11 11:42:53 -0700582 assert os.path.exists(vendor_img_path)
583 care_map_list += GetCareMap("vendor", vendor_img_path)
Tianjie Xucfa86222016-03-07 16:31:19 -0800584
Tao Baoa0421cd2015-11-16 16:32:27 -0800585 img_name = line.strip() + ".img"
Tianjie Xuaaca4212016-06-28 14:34:03 -0700586 prebuilt_path = os.path.join(OPTIONS.input_tmp, "IMAGES", img_name)
587 if os.path.exists(prebuilt_path):
Tao Bao89fbb0f2017-01-10 10:47:58 -0800588 print("%s already exists, no need to overwrite..." % (img_name,))
Tianjie Xuaaca4212016-06-28 14:34:03 -0700589 continue
590
Tao Baoa0421cd2015-11-16 16:32:27 -0800591 img_radio_path = os.path.join(OPTIONS.input_tmp, "RADIO", img_name)
Wei Wang2e735ca2016-05-10 22:48:13 -0700592 img_vendor_dir = os.path.join(
593 OPTIONS.input_tmp, "VENDOR_IMAGES")
Tao Baoa0421cd2015-11-16 16:32:27 -0800594 if os.path.exists(img_radio_path):
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800595 if output_zip:
596 common.ZipWrite(output_zip, img_radio_path,
597 os.path.join("IMAGES", img_name))
598 else:
599 shutil.copy(img_radio_path, prebuilt_path)
Wei Wang2e735ca2016-05-10 22:48:13 -0700600 else:
601 for root, _, files in os.walk(img_vendor_dir):
602 if img_name in files:
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800603 if output_zip:
604 common.ZipWrite(output_zip, os.path.join(root, img_name),
605 os.path.join("IMAGES", img_name))
606 else:
607 shutil.copy(os.path.join(root, img_name), prebuilt_path)
Wei Wang2e735ca2016-05-10 22:48:13 -0700608 break
Tao Baoa0421cd2015-11-16 16:32:27 -0800609
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800610 if output_zip:
611 # Zip spec says: All slashes MUST be forward slashes.
612 img_path = 'IMAGES/' + img_name
613 assert img_path in output_zip.namelist(), "cannot find " + img_name
614 else:
615 img_path = os.path.join(OPTIONS.input_tmp, "IMAGES", img_name)
616 assert os.path.exists(img_path), "cannot find " + img_name
Tao Baoa0421cd2015-11-16 16:32:27 -0800617
Tianjie Xucfa86222016-03-07 16:31:19 -0800618 if care_map_list:
619 file_path = "META/care_map.txt"
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800620 if output_zip:
621 common.ZipWriteStr(output_zip, file_path, '\n'.join(care_map_list))
622 else:
623 with open(os.path.join(OPTIONS.input_tmp, file_path), 'w') as fp:
624 fp.write('\n'.join(care_map_list))
Tianjie Xucfa86222016-03-07 16:31:19 -0800625
Dan Willemsen2ee00d52017-03-05 19:51:56 -0800626 if output_zip:
627 common.ZipClose(output_zip)
Tianjie Xu38af07f2017-05-25 17:38:53 -0700628 if OPTIONS.replace_recovery_patch_files_list:
629 ReplaceRecoveryPatchFiles(output_zip.filename)
630
Doug Zongker3c84f562014-07-31 11:06:30 -0700631
Doug Zongker3c84f562014-07-31 11:06:30 -0700632def main(argv):
Baligh Uddin59f4ff12015-09-16 21:20:30 -0700633 def option_handler(o, a):
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800634 if o in ("-a", "--add_missing"):
635 OPTIONS.add_missing = True
636 elif o in ("-r", "--rebuild_recovery",):
637 OPTIONS.rebuild_recovery = True
Baligh Uddin59f4ff12015-09-16 21:20:30 -0700638 elif o == "--replace_verity_private_key":
639 OPTIONS.replace_verity_private_key = (True, a)
640 elif o == "--replace_verity_public_key":
641 OPTIONS.replace_verity_public_key = (True, a)
Tianjie Xub48589a2016-08-03 19:21:52 -0700642 elif o == "--is_signing":
643 OPTIONS.is_signing = True
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800644 else:
645 return False
646 return True
647
Dan Albert8b72aef2015-03-23 19:13:21 -0700648 args = common.ParseOptions(
649 argv, __doc__, extra_opts="ar",
Baligh Uddin59f4ff12015-09-16 21:20:30 -0700650 extra_long_opts=["add_missing", "rebuild_recovery",
651 "replace_verity_public_key=",
652 "replace_verity_private_key=",
Tao Bao45810422016-10-17 16:20:12 -0700653 "is_signing"],
Dan Albert8b72aef2015-03-23 19:13:21 -0700654 extra_option_handler=option_handler)
Michael Runge2e0d8fc2014-11-13 21:41:08 -0800655
Doug Zongker3c84f562014-07-31 11:06:30 -0700656
657 if len(args) != 1:
658 common.Usage(__doc__)
659 sys.exit(1)
660
661 AddImagesToTargetFiles(args[0])
Tao Bao89fbb0f2017-01-10 10:47:58 -0800662 print("done.")
Doug Zongker3c84f562014-07-31 11:06:30 -0700663
664if __name__ == '__main__':
665 try:
666 common.CloseInheritedPipes()
667 main(sys.argv[1:])
Dan Albert8b72aef2015-03-23 19:13:21 -0700668 except common.ExternalError as e:
Tao Bao89fbb0f2017-01-10 10:47:58 -0800669 print("\n ERROR: %s\n" % (e,))
Doug Zongker3c84f562014-07-31 11:06:30 -0700670 sys.exit(1)
Doug Zongkerfc44a512014-08-26 13:10:25 -0700671 finally:
672 common.Cleanup()