build_image.py revision 2ed665a033c587b276b1615516e5354e2ace47cd
1#!/usr/bin/env python 2# 3# Copyright (C) 2011 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""" 18Build image output_image_file from input_directory and properties_file. 19 20Usage: build_image input_directory properties_file output_image_file 21 22""" 23import os 24import os.path 25import subprocess 26import sys 27import commands 28import shutil 29import tempfile 30 31FIXED_SALT = "aee087a5be3b982978c923f566a94613496b417f2af592639bc80d141e34dfe7" 32 33def RunCommand(cmd): 34 """ Echo and run the given command 35 36 Args: 37 cmd: the command represented as a list of strings. 38 Returns: 39 The exit code. 40 """ 41 print "Running: ", " ".join(cmd) 42 p = subprocess.Popen(cmd) 43 p.communicate() 44 return p.returncode 45 46def GetVerityTreeSize(partition_size): 47 cmd = "build_verity_tree -s %d" 48 cmd %= partition_size 49 status, output = commands.getstatusoutput(cmd) 50 if status: 51 print output 52 return False, 0 53 return True, int(output) 54 55def GetVerityMetadataSize(partition_size): 56 cmd = "system/extras/verity/build_verity_metadata.py -s %d" 57 cmd %= partition_size 58 status, output = commands.getstatusoutput(cmd) 59 if status: 60 print output 61 return False, 0 62 return True, int(output) 63 64def AdjustPartitionSizeForVerity(partition_size): 65 """Modifies the provided partition size to account for the verity metadata. 66 67 This information is used to size the created image appropriately. 68 Args: 69 partition_size: the size of the partition to be verified. 70 Returns: 71 The size of the partition adjusted for verity metadata. 72 """ 73 success, verity_tree_size = GetVerityTreeSize(partition_size) 74 if not success: 75 return 0 76 success, verity_metadata_size = GetVerityMetadataSize(partition_size) 77 if not success: 78 return 0 79 return partition_size - verity_tree_size - verity_metadata_size 80 81def BuildVerityTree(sparse_image_path, verity_image_path, prop_dict): 82 cmd = "build_verity_tree -A %s %s %s" % ( 83 FIXED_SALT, sparse_image_path, verity_image_path) 84 print cmd 85 status, output = commands.getstatusoutput(cmd) 86 if status: 87 print "Could not build verity tree! Error: %s" % output 88 return False 89 root, salt = output.split() 90 prop_dict["verity_root_hash"] = root 91 prop_dict["verity_salt"] = salt 92 return True 93 94def BuildVerityMetadata(image_size, verity_metadata_path, root_hash, salt, 95 block_device, signer_path, key): 96 cmd_template = ( 97 "system/extras/verity/build_verity_metadata.py %s %s %s %s %s %s %s") 98 cmd = cmd_template % (image_size, verity_metadata_path, root_hash, salt, 99 block_device, signer_path, key) 100 print cmd 101 status, output = commands.getstatusoutput(cmd) 102 if status: 103 print "Could not build verity metadata! Error: %s" % output 104 return False 105 return True 106 107def Append2Simg(sparse_image_path, unsparse_image_path, error_message): 108 """Appends the unsparse image to the given sparse image. 109 110 Args: 111 sparse_image_path: the path to the (sparse) image 112 unsparse_image_path: the path to the (unsparse) image 113 Returns: 114 True on success, False on failure. 115 """ 116 cmd = "append2simg %s %s" 117 cmd %= (sparse_image_path, unsparse_image_path) 118 print cmd 119 status, output = commands.getstatusoutput(cmd) 120 if status: 121 print "%s: %s" % (error_message, output) 122 return False 123 return True 124 125def BuildVerifiedImage(data_image_path, verity_image_path, 126 verity_metadata_path): 127 if not Append2Simg(data_image_path, verity_metadata_path, 128 "Could not append verity metadata!"): 129 return False 130 if not Append2Simg(data_image_path, verity_image_path, 131 "Could not append verity tree!"): 132 return False 133 return True 134 135def UnsparseImage(sparse_image_path, replace=True): 136 img_dir = os.path.dirname(sparse_image_path) 137 unsparse_image_path = "unsparse_" + os.path.basename(sparse_image_path) 138 unsparse_image_path = os.path.join(img_dir, unsparse_image_path) 139 if os.path.exists(unsparse_image_path): 140 if replace: 141 os.unlink(unsparse_image_path) 142 else: 143 return True, unsparse_image_path 144 inflate_command = ["simg2img", sparse_image_path, unsparse_image_path] 145 exit_code = RunCommand(inflate_command) 146 if exit_code != 0: 147 os.remove(unsparse_image_path) 148 return False, None 149 return True, unsparse_image_path 150 151def MakeVerityEnabledImage(out_file, prop_dict): 152 """Creates an image that is verifiable using dm-verity. 153 154 Args: 155 out_file: the location to write the verifiable image at 156 prop_dict: a dictionary of properties required for image creation and 157 verification 158 Returns: 159 True on success, False otherwise. 160 """ 161 # get properties 162 image_size = prop_dict["partition_size"] 163 block_dev = prop_dict["verity_block_device"] 164 signer_key = prop_dict["verity_key"] + ".pk8" 165 signer_path = prop_dict["verity_signer_cmd"] 166 167 # make a tempdir 168 tempdir_name = tempfile.mkdtemp(suffix="_verity_images") 169 170 # get partial image paths 171 verity_image_path = os.path.join(tempdir_name, "verity.img") 172 verity_metadata_path = os.path.join(tempdir_name, "verity_metadata.img") 173 174 # build the verity tree and get the root hash and salt 175 if not BuildVerityTree(out_file, verity_image_path, prop_dict): 176 shutil.rmtree(tempdir_name, ignore_errors=True) 177 return False 178 179 # build the metadata blocks 180 root_hash = prop_dict["verity_root_hash"] 181 salt = prop_dict["verity_salt"] 182 if not BuildVerityMetadata(image_size, verity_metadata_path, root_hash, salt, 183 block_dev, signer_path, signer_key): 184 shutil.rmtree(tempdir_name, ignore_errors=True) 185 return False 186 187 # build the full verified image 188 if not BuildVerifiedImage(out_file, 189 verity_image_path, 190 verity_metadata_path): 191 shutil.rmtree(tempdir_name, ignore_errors=True) 192 return False 193 194 shutil.rmtree(tempdir_name, ignore_errors=True) 195 return True 196 197def BuildImage(in_dir, prop_dict, out_file): 198 """Build an image to out_file from in_dir with property prop_dict. 199 200 Args: 201 in_dir: path of input directory. 202 prop_dict: property dictionary. 203 out_file: path of the output image file. 204 205 Returns: 206 True iff the image is built successfully. 207 """ 208 # system_root_image=true: build a system.img that combines the contents of 209 # /system and the ramdisk, and can be mounted at the root of the file system. 210 origin_in = in_dir 211 fs_config = prop_dict.get("fs_config") 212 if (prop_dict.get("system_root_image") == "true" 213 and prop_dict["mount_point"] == "system"): 214 in_dir = tempfile.mkdtemp() 215 # Change the mount point to "/" 216 prop_dict["mount_point"] = "/" 217 if fs_config: 218 # We need to merge the fs_config files of system and ramdisk. 219 fd, merged_fs_config = tempfile.mkstemp(prefix="root_fs_config", 220 suffix=".txt") 221 os.close(fd) 222 with open(merged_fs_config, "w") as fw: 223 if "ramdisk_fs_config" in prop_dict: 224 with open(prop_dict["ramdisk_fs_config"]) as fr: 225 fw.writelines(fr.readlines()) 226 with open(fs_config) as fr: 227 fw.writelines(fr.readlines()) 228 fs_config = merged_fs_config 229 230 build_command = [] 231 fs_type = prop_dict.get("fs_type", "") 232 run_fsck = False 233 234 fs_spans_partition = True 235 if fs_type.startswith("squash"): 236 fs_spans_partition = False 237 238 is_verity_partition = "verity_block_device" in prop_dict 239 verity_supported = prop_dict.get("verity") == "true" 240 # adjust the partition size to make room for the hashes if this is to be verified 241 if verity_supported and is_verity_partition and fs_spans_partition: 242 partition_size = int(prop_dict.get("partition_size")) 243 adjusted_size = AdjustPartitionSizeForVerity(partition_size) 244 if not adjusted_size: 245 return False 246 prop_dict["partition_size"] = str(adjusted_size) 247 prop_dict["original_partition_size"] = str(partition_size) 248 249 if fs_type.startswith("ext"): 250 build_command = ["mkuserimg.sh"] 251 if "extfs_sparse_flag" in prop_dict: 252 build_command.append(prop_dict["extfs_sparse_flag"]) 253 run_fsck = True 254 build_command.extend([in_dir, out_file, fs_type, 255 prop_dict["mount_point"]]) 256 build_command.append(prop_dict["partition_size"]) 257 if "journal_size" in prop_dict: 258 build_command.extend(["-j", prop_dict["journal_size"]]) 259 if "timestamp" in prop_dict: 260 build_command.extend(["-T", str(prop_dict["timestamp"])]) 261 if fs_config: 262 build_command.extend(["-C", fs_config]) 263 if "block_list" in prop_dict: 264 build_command.extend(["-B", prop_dict["block_list"]]) 265 build_command.extend(["-L", prop_dict["mount_point"]]) 266 if "selinux_fc" in prop_dict: 267 build_command.append(prop_dict["selinux_fc"]) 268 elif fs_type.startswith("squash"): 269 build_command = ["mksquashfsimage.sh"] 270 build_command.extend([in_dir, out_file]) 271 build_command.extend(["-m", prop_dict["mount_point"]]) 272 if "selinux_fc" in prop_dict: 273 build_command.extend(["-c", prop_dict["selinux_fc"]]) 274 elif fs_type.startswith("f2fs"): 275 build_command = ["mkf2fsuserimg.sh"] 276 build_command.extend([out_file, prop_dict["partition_size"]]) 277 else: 278 build_command = ["mkyaffs2image", "-f"] 279 if prop_dict.get("mkyaffs2_extra_flags", None): 280 build_command.extend(prop_dict["mkyaffs2_extra_flags"].split()) 281 build_command.append(in_dir) 282 build_command.append(out_file) 283 if "selinux_fc" in prop_dict: 284 build_command.append(prop_dict["selinux_fc"]) 285 build_command.append(prop_dict["mount_point"]) 286 287 if in_dir != origin_in: 288 # Construct a staging directory of the root file system. 289 ramdisk_dir = prop_dict.get("ramdisk_dir") 290 if ramdisk_dir: 291 shutil.rmtree(in_dir) 292 shutil.copytree(ramdisk_dir, in_dir, symlinks=True) 293 staging_system = os.path.join(in_dir, "system") 294 shutil.rmtree(staging_system, ignore_errors=True) 295 shutil.copytree(origin_in, staging_system, symlinks=True) 296 try: 297 exit_code = RunCommand(build_command) 298 finally: 299 if in_dir != origin_in: 300 # Clean up temporary directories and files. 301 shutil.rmtree(in_dir, ignore_errors=True) 302 if fs_config: 303 os.remove(fs_config) 304 if exit_code != 0: 305 return False 306 307 if not fs_spans_partition: 308 mount_point = prop_dict.get("mount_point") 309 partition_size = int(prop_dict.get("partition_size")) 310 image_size = os.stat(out_file).st_size 311 if image_size > partition_size: 312 print "Error: %s image size of %d is larger than partition size of %d" % (mount_point, image_size, partition_size) 313 return False 314 if verity_supported and is_verity_partition: 315 if 2 * image_size - AdjustPartitionSizeForVerity(image_size) > partition_size: 316 print "Error: No more room on %s to fit verity data" % mount_point 317 return False 318 prop_dict["original_partition_size"] = prop_dict["partition_size"] 319 prop_dict["partition_size"] = str(image_size) 320 321 # create the verified image if this is to be verified 322 if verity_supported and is_verity_partition: 323 if not MakeVerityEnabledImage(out_file, prop_dict): 324 return False 325 326 if run_fsck and prop_dict.get("skip_fsck") != "true": 327 success, unsparse_image = UnsparseImage(out_file, replace=False) 328 if not success: 329 return False 330 331 # Run e2fsck on the inflated image file 332 e2fsck_command = ["e2fsck", "-f", "-n", unsparse_image] 333 exit_code = RunCommand(e2fsck_command) 334 335 os.remove(unsparse_image) 336 337 return exit_code == 0 338 339 340def ImagePropFromGlobalDict(glob_dict, mount_point): 341 """Build an image property dictionary from the global dictionary. 342 343 Args: 344 glob_dict: the global dictionary from the build system. 345 mount_point: such as "system", "data" etc. 346 """ 347 d = {} 348 if "build.prop" in glob_dict: 349 bp = glob_dict["build.prop"] 350 if "ro.build.date.utc" in bp: 351 d["timestamp"] = bp["ro.build.date.utc"] 352 353 def copy_prop(src_p, dest_p): 354 if src_p in glob_dict: 355 d[dest_p] = str(glob_dict[src_p]) 356 357 common_props = ( 358 "extfs_sparse_flag", 359 "mkyaffs2_extra_flags", 360 "selinux_fc", 361 "skip_fsck", 362 "verity", 363 "verity_key", 364 "verity_signer_cmd" 365 ) 366 for p in common_props: 367 copy_prop(p, p) 368 369 d["mount_point"] = mount_point 370 if mount_point == "system": 371 copy_prop("fs_type", "fs_type") 372 # Copy the generic sysetem fs type first, override with specific one if 373 # available. 374 copy_prop("system_fs_type", "fs_type") 375 copy_prop("system_size", "partition_size") 376 copy_prop("system_journal_size", "journal_size") 377 copy_prop("system_verity_block_device", "verity_block_device") 378 copy_prop("system_root_image", "system_root_image") 379 copy_prop("ramdisk_dir", "ramdisk_dir") 380 elif mount_point == "data": 381 # Copy the generic fs type first, override with specific one if available. 382 copy_prop("fs_type", "fs_type") 383 copy_prop("userdata_fs_type", "fs_type") 384 copy_prop("userdata_size", "partition_size") 385 elif mount_point == "cache": 386 copy_prop("cache_fs_type", "fs_type") 387 copy_prop("cache_size", "partition_size") 388 elif mount_point == "vendor": 389 copy_prop("vendor_fs_type", "fs_type") 390 copy_prop("vendor_size", "partition_size") 391 copy_prop("vendor_journal_size", "journal_size") 392 copy_prop("vendor_verity_block_device", "verity_block_device") 393 elif mount_point == "oem": 394 copy_prop("fs_type", "fs_type") 395 copy_prop("oem_size", "partition_size") 396 copy_prop("oem_journal_size", "journal_size") 397 398 return d 399 400 401def LoadGlobalDict(filename): 402 """Load "name=value" pairs from filename""" 403 d = {} 404 f = open(filename) 405 for line in f: 406 line = line.strip() 407 if not line or line.startswith("#"): 408 continue 409 k, v = line.split("=", 1) 410 d[k] = v 411 f.close() 412 return d 413 414 415def main(argv): 416 if len(argv) != 3: 417 print __doc__ 418 sys.exit(1) 419 420 in_dir = argv[0] 421 glob_dict_file = argv[1] 422 out_file = argv[2] 423 424 glob_dict = LoadGlobalDict(glob_dict_file) 425 image_filename = os.path.basename(out_file) 426 mount_point = "" 427 if image_filename == "system.img": 428 mount_point = "system" 429 elif image_filename == "userdata.img": 430 mount_point = "data" 431 elif image_filename == "cache.img": 432 mount_point = "cache" 433 elif image_filename == "vendor.img": 434 mount_point = "vendor" 435 elif image_filename == "oem.img": 436 mount_point = "oem" 437 else: 438 print >> sys.stderr, "error: unknown image file name ", image_filename 439 exit(1) 440 441 image_properties = ImagePropFromGlobalDict(glob_dict, mount_point) 442 if not BuildImage(in_dir, image_properties, out_file): 443 print >> sys.stderr, "error: failed to build %s from %s" % (out_file, 444 in_dir) 445 exit(1) 446 447 448if __name__ == '__main__': 449 main(sys.argv[1:]) 450