img_from_target_files.py revision f8824aff68f63cf5484063bda4d5342034eb82c0 
1#!/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"""
18Given a target-files zipfile, produces an image zipfile suitable for
19use with 'fastboot update'.
20
21Usage:  img_from_target_files [flags] input_target_files output_image_zip
22
23  -b  (--board_config)  <file>
24      Deprecated.
25
26  -z  (--bootable_zip)
27      Include only the bootable images (eg 'boot' and 'recovery') in
28      the output.
29
30"""
31
32import sys
33
34if sys.hexversion < 0x02070000:
35  print >> sys.stderr, "Python 2.7 or newer is required."
36  sys.exit(1)
37
38import errno
39import os
40import re
41import shutil
42import subprocess
43import tempfile
44import zipfile
45
46# missing in Python 2.4 and before
47if not hasattr(os, "SEEK_SET"):
48  os.SEEK_SET = 0
49
50import build_image
51import common
52
53OPTIONS = common.OPTIONS
54
55
56def AddSystem(output_zip, sparse=True):
57  """Turn the contents of SYSTEM into a system image and store it in
58  output_zip."""
59  data = BuildSystem(OPTIONS.input_tmp, OPTIONS.info_dict, sparse=sparse)
60  common.ZipWriteStr(output_zip, "system.img", data)
61
62
63def BuildSystem(input_dir, info_dict, sparse=True, map_file=None):
64  print "creating system.img..."
65
66  img = tempfile.NamedTemporaryFile()
67
68  # The name of the directory it is making an image out of matters to
69  # mkyaffs2image.  It wants "system" but we have a directory named
70  # "SYSTEM", so create a symlink.
71  try:
72    os.symlink(os.path.join(input_dir, "SYSTEM"),
73               os.path.join(input_dir, "system"))
74  except OSError, e:
75      # bogus error on my mac version?
76      #   File "./build/tools/releasetools/img_from_target_files", line 86, in AddSystem
77      #     os.path.join(OPTIONS.input_tmp, "system"))
78      # OSError: [Errno 17] File exists
79    if (e.errno == errno.EEXIST):
80      pass
81
82  image_props = build_image.ImagePropFromGlobalDict(info_dict, "system")
83  fstab = info_dict["fstab"]
84  if fstab:
85    image_props["fs_type" ] = fstab["/system"].fs_type
86  succ = build_image.BuildImage(os.path.join(input_dir, "system"),
87                                image_props, img.name)
88  assert succ, "build system.img image failed"
89
90  mapdata = None
91
92  if sparse:
93    data = open(img.name).read()
94    img.close()
95  else:
96    success, name = build_image.UnsparseImage(img.name, replace=False)
97    if not success:
98      assert False, "unsparsing system.img failed"
99
100    if map_file:
101      mmap = tempfile.NamedTemporaryFile()
102      mimg = tempfile.NamedTemporaryFile(delete=False)
103      success = build_image.MappedUnsparseImage(
104          img.name, name, mmap.name, mimg.name)
105      if not success:
106        assert False, "creating sparse map failed"
107      os.unlink(name)
108      name = mimg.name
109
110      with open(mmap.name) as f:
111        mapdata = f.read()
112
113    try:
114      with open(name) as f:
115        data = f.read()
116    finally:
117      os.unlink(name)
118
119  if mapdata is None:
120    return data
121  else:
122    return mapdata, data
123
124
125def AddVendor(output_zip):
126  """Turn the contents of VENDOR into vendor.img and store it in
127  output_zip."""
128
129  image_props = build_image.ImagePropFromGlobalDict(OPTIONS.info_dict,
130                                                    "vendor")
131  # The build system has to explicitly request for vendor.img.
132  if "fs_type" not in image_props:
133    return
134
135  print "creating vendor.img..."
136
137  img = tempfile.NamedTemporaryFile()
138
139  # The name of the directory it is making an image out of matters to
140  # mkyaffs2image.  It wants "vendor" but we have a directory named
141  # "VENDOR", so create a symlink or an empty directory if VENDOR does not
142  # exist.
143  if not os.path.exists(os.path.join(OPTIONS.input_tmp, "vendor")):
144    if os.path.exists(os.path.join(OPTIONS.input_tmp, "VENDOR")):
145      os.symlink(os.path.join(OPTIONS.input_tmp, "VENDOR"),
146                 os.path.join(OPTIONS.input_tmp, "vendor"))
147    else:
148      os.mkdir(os.path.join(OPTIONS.input_tmp, "vendor"))
149
150  img = tempfile.NamedTemporaryFile()
151
152  fstab = OPTIONS.info_dict["fstab"]
153  if fstab:
154    image_props["fs_type" ] = fstab["/vendor"].fs_type
155  succ = build_image.BuildImage(os.path.join(OPTIONS.input_tmp, "vendor"),
156                                image_props, img.name)
157  assert succ, "build vendor.img image failed"
158
159  common.CheckSize(img.name, "vendor.img", OPTIONS.info_dict)
160  output_zip.write(img.name, "vendor.img")
161  img.close()
162
163
164def AddUserdata(output_zip):
165  """Create an empty userdata image and store it in output_zip."""
166
167  image_props = build_image.ImagePropFromGlobalDict(OPTIONS.info_dict,
168                                                    "data")
169  # If no userdata_size is provided for extfs, skip userdata.img.
170  if (image_props.get("fs_type", "").startswith("ext") and
171      not image_props.get("partition_size")):
172    return
173
174  print "creating userdata.img..."
175
176  # The name of the directory it is making an image out of matters to
177  # mkyaffs2image.  So we create a temp dir, and within it we create an
178  # empty dir named "data", and build the image from that.
179  temp_dir = tempfile.mkdtemp()
180  user_dir = os.path.join(temp_dir, "data")
181  os.mkdir(user_dir)
182  img = tempfile.NamedTemporaryFile()
183
184  fstab = OPTIONS.info_dict["fstab"]
185  if fstab:
186    image_props["fs_type" ] = fstab["/data"].fs_type
187  succ = build_image.BuildImage(user_dir, image_props, img.name)
188  assert succ, "build userdata.img image failed"
189
190  common.CheckSize(img.name, "userdata.img", OPTIONS.info_dict)
191  output_zip.write(img.name, "userdata.img")
192  img.close()
193  os.rmdir(user_dir)
194  os.rmdir(temp_dir)
195
196
197def AddCache(output_zip):
198  """Create an empty cache image and store it in output_zip."""
199
200  image_props = build_image.ImagePropFromGlobalDict(OPTIONS.info_dict,
201                                                    "cache")
202  # The build system has to explicitly request for cache.img.
203  if "fs_type" not in image_props:
204    return
205
206  print "creating cache.img..."
207
208  # The name of the directory it is making an image out of matters to
209  # mkyaffs2image.  So we create a temp dir, and within it we create an
210  # empty dir named "cache", and build the image from that.
211  temp_dir = tempfile.mkdtemp()
212  user_dir = os.path.join(temp_dir, "cache")
213  os.mkdir(user_dir)
214  img = tempfile.NamedTemporaryFile()
215
216  fstab = OPTIONS.info_dict["fstab"]
217  if fstab:
218    image_props["fs_type" ] = fstab["/cache"].fs_type
219  succ = build_image.BuildImage(user_dir, image_props, img.name)
220  assert succ, "build cache.img image failed"
221
222  common.CheckSize(img.name, "cache.img", OPTIONS.info_dict)
223  output_zip.write(img.name, "cache.img")
224  img.close()
225  os.rmdir(user_dir)
226  os.rmdir(temp_dir)
227
228
229def CopyInfo(output_zip):
230  """Copy the android-info.txt file from the input to the output."""
231  output_zip.write(os.path.join(OPTIONS.input_tmp, "OTA", "android-info.txt"),
232                   "android-info.txt")
233
234
235def main(argv):
236  bootable_only = [False]
237
238  def option_handler(o, a):
239    if o in ("-b", "--board_config"):
240      pass       # deprecated
241    if o in ("-z", "--bootable_zip"):
242      bootable_only[0] = True
243    else:
244      return False
245    return True
246
247  args = common.ParseOptions(argv, __doc__,
248                             extra_opts="b:z",
249                             extra_long_opts=["board_config=",
250                                              "bootable_zip"],
251                             extra_option_handler=option_handler)
252
253  bootable_only = bootable_only[0]
254
255  if len(args) != 2:
256    common.Usage(__doc__)
257    sys.exit(1)
258
259  OPTIONS.input_tmp, input_zip = common.UnzipTemp(args[0])
260  OPTIONS.info_dict = common.LoadInfoDict(input_zip)
261
262  # If this image was originally labelled with SELinux contexts, make sure we
263  # also apply the labels in our new image. During building, the "file_contexts"
264  # is in the out/ directory tree, but for repacking from target-files.zip it's
265  # in the root directory of the ramdisk.
266  if "selinux_fc" in OPTIONS.info_dict:
267    OPTIONS.info_dict["selinux_fc"] = os.path.join(OPTIONS.input_tmp, "BOOT", "RAMDISK",
268        "file_contexts")
269
270  output_zip = zipfile.ZipFile(args[1], "w", compression=zipfile.ZIP_DEFLATED)
271
272  boot_image = common.GetBootableImage(
273      "boot.img", "boot.img", OPTIONS.input_tmp, "BOOT")
274  if boot_image:
275      boot_image.AddToZip(output_zip)
276  recovery_image = common.GetBootableImage(
277      "recovery.img", "recovery.img", OPTIONS.input_tmp, "RECOVERY")
278  if recovery_image:
279    recovery_image.AddToZip(output_zip)
280
281  if not bootable_only:
282    AddSystem(output_zip)
283    AddVendor(output_zip)
284    AddUserdata(output_zip)
285    AddCache(output_zip)
286    CopyInfo(output_zip)
287
288  print "cleaning up..."
289  output_zip.close()
290  shutil.rmtree(OPTIONS.input_tmp)
291
292  print "done."
293
294
295if __name__ == '__main__':
296  try:
297    common.CloseInheritedPipes()
298    main(sys.argv[1:])
299  except common.ExternalError, e:
300    print
301    print "   ERROR: %s" % (e,)
302    print
303    sys.exit(1)
304