edify_generator.py revision a67616acfd436ac0ba224e675dc972c8491901fc
1# Copyright (C) 2009 The Android Open Source Project 2# 3# Licensed under the Apache License, Version 2.0 (the "License"); 4# you may not use this file except in compliance with the License. 5# You may obtain a copy of the License at 6# 7# http://www.apache.org/licenses/LICENSE-2.0 8# 9# Unless required by applicable law or agreed to in writing, software 10# distributed under the License is distributed on an "AS IS" BASIS, 11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12# See the License for the specific language governing permissions and 13# limitations under the License. 14 15import os 16import re 17 18import common 19 20class EdifyGenerator(object): 21 """Class to generate scripts in the 'edify' recovery script language 22 used from donut onwards.""" 23 24 def __init__(self, version, info): 25 self.script = [] 26 self.mounts = set() 27 self.version = version 28 self.info = info 29 30 def MakeTemporary(self): 31 """Make a temporary script object whose commands can latter be 32 appended to the parent script with AppendScript(). Used when the 33 caller wants to generate script commands out-of-order.""" 34 x = EdifyGenerator(self.version, self.info) 35 x.mounts = self.mounts 36 return x 37 38 @staticmethod 39 def _WordWrap(cmd, linelen=80): 40 """'cmd' should be a function call with null characters after each 41 parameter (eg, "somefun(foo,\0bar,\0baz)"). This function wraps cmd 42 to a given line length, replacing nulls with spaces and/or newlines 43 to format it nicely.""" 44 indent = cmd.index("(")+1 45 out = [] 46 first = True 47 x = re.compile("^(.{,%d})\0" % (linelen-indent,)) 48 while True: 49 if not first: 50 out.append(" " * indent) 51 first = False 52 m = x.search(cmd) 53 if not m: 54 parts = cmd.split("\0", 1) 55 out.append(parts[0]+"\n") 56 if len(parts) == 1: 57 break 58 else: 59 cmd = parts[1] 60 continue 61 out.append(m.group(1)+"\n") 62 cmd = cmd[m.end():] 63 64 return "".join(out).replace("\0", " ").rstrip("\n") 65 66 def AppendScript(self, other): 67 """Append the contents of another script (which should be created 68 with temporary=True) to this one.""" 69 self.script.extend(other.script) 70 71 def AssertSomeFingerprint(self, *fp): 72 """Assert that the current system build fingerprint is one of *fp.""" 73 if not fp: 74 raise ValueError("must specify some fingerprints") 75 cmd = ('assert(' + 76 ' ||\0'.join([('file_getprop("/system/build.prop", ' 77 '"ro.build.fingerprint") == "%s"') 78 % i for i in fp]) + 79 ');') 80 self.script.append(self._WordWrap(cmd)) 81 82 def AssertOlderBuild(self, timestamp): 83 """Assert that the build on the device is older (or the same as) 84 the given timestamp.""" 85 self.script.append(('assert(!less_than_int(%s, ' 86 'getprop("ro.build.date.utc")));') % (timestamp,)) 87 88 def AssertDevice(self, device): 89 """Assert that the device identifier is the given string.""" 90 cmd = ('assert(getprop("ro.product.device") == "%s" ||\0' 91 'getprop("ro.build.product") == "%s");' % (device, device)) 92 self.script.append(self._WordWrap(cmd)) 93 94 def AssertSomeBootloader(self, *bootloaders): 95 """Asert that the bootloader version is one of *bootloaders.""" 96 cmd = ("assert(" + 97 " ||\0".join(['getprop("ro.bootloader") == "%s"' % (b,) 98 for b in bootloaders]) + 99 ");") 100 self.script.append(self._WordWrap(cmd)) 101 102 def ShowProgress(self, frac, dur): 103 """Update the progress bar, advancing it over 'frac' over the next 104 'dur' seconds. 'dur' may be zero to advance it via SetProgress 105 commands instead of by time.""" 106 self.script.append("show_progress(%f, %d);" % (frac, int(dur))) 107 108 def SetProgress(self, frac): 109 """Set the position of the progress bar within the chunk defined 110 by the most recent ShowProgress call. 'frac' should be in 111 [0,1].""" 112 self.script.append("set_progress(%f);" % (frac,)) 113 114 def PatchCheck(self, filename, *sha1): 115 """Check that the given file (or MTD reference) has one of the 116 given *sha1 hashes, checking the version saved in cache if the 117 file does not match.""" 118 self.script.append('assert(apply_patch_check("%s"' % (filename,) + 119 "".join([', "%s"' % (i,) for i in sha1]) + 120 '));') 121 122 def FileCheck(self, filename, *sha1): 123 """Check that the given file (or MTD reference) has one of the 124 given *sha1 hashes.""" 125 self.script.append('assert(sha1_check(read_file("%s")' % (filename,) + 126 "".join([', "%s"' % (i,) for i in sha1]) + 127 '));') 128 129 def CacheFreeSpaceCheck(self, amount): 130 """Check that there's at least 'amount' space that can be made 131 available on /cache.""" 132 self.script.append("assert(apply_patch_space(%d));" % (amount,)) 133 134 def Mount(self, mount_point): 135 """Mount the partition with the given mount_point.""" 136 fstab = self.info.get("fstab", None) 137 if fstab: 138 p = fstab[mount_point] 139 self.script.append('mount("%s", "%s", "%s", "%s");' % 140 (p.fs_type, common.PARTITION_TYPES[p.fs_type], 141 p.device, p.mount_point)) 142 self.mounts.add(p.mount_point) 143 else: 144 what = mount_point.lstrip("/") 145 what = self.info.get("partition_path", "") + what 146 self.script.append('mount("%s", "%s", "%s", "%s");' % 147 (self.info["fs_type"], self.info["partition_type"], 148 what, mount_point)) 149 self.mounts.add(mount_point) 150 151 def UnpackPackageDir(self, src, dst): 152 """Unpack a given directory from the OTA package into the given 153 destination directory.""" 154 self.script.append('package_extract_dir("%s", "%s");' % (src, dst)) 155 156 def Comment(self, comment): 157 """Write a comment into the update script.""" 158 self.script.append("") 159 for i in comment.split("\n"): 160 self.script.append("# " + i) 161 self.script.append("") 162 163 def Print(self, message): 164 """Log a message to the screen (if the logs are visible).""" 165 self.script.append('ui_print("%s");' % (message,)) 166 167 def FormatPartition(self, partition): 168 """Format the given partition, specified by its mount point (eg, 169 "/system").""" 170 171 reserve_size = 0 172 fstab = self.info.get("fstab", None) 173 if fstab: 174 p = fstab[partition] 175 # Reserve the last 16 Kbytes of an EMMC /data for the crypto footer 176 if partition == "/data" and common.PARTITION_TYPES[p.fs_type] == "EMMC": 177 reserve_size = -16384 178 self.script.append('format("%s", "%s", "%s", "%s");' % 179 (p.fs_type, common.PARTITION_TYPES[p.fs_type], p.device, reserve_size) 180 else: 181 # older target-files without per-partition types 182 partition = self.info.get("partition_path", "") + partition 183 self.script.append('format("%s", "%s", "%s", "%s");' % 184 (self.info["fs_type"], self.info["partition_type"], 185 partition, reserve_size)) 186 187 def DeleteFiles(self, file_list): 188 """Delete all files in file_list.""" 189 if not file_list: return 190 cmd = "delete(" + ",\0".join(['"%s"' % (i,) for i in file_list]) + ");" 191 self.script.append(self._WordWrap(cmd)) 192 193 def ApplyPatch(self, srcfile, tgtfile, tgtsize, tgtsha1, *patchpairs): 194 """Apply binary patches (in *patchpairs) to the given srcfile to 195 produce tgtfile (which may be "-" to indicate overwriting the 196 source file.""" 197 if len(patchpairs) % 2 != 0 or len(patchpairs) == 0: 198 raise ValueError("bad patches given to ApplyPatch") 199 cmd = ['apply_patch("%s",\0"%s",\0%s,\0%d' 200 % (srcfile, tgtfile, tgtsha1, tgtsize)] 201 for i in range(0, len(patchpairs), 2): 202 cmd.append(',\0%s, package_extract_file("%s")' % patchpairs[i:i+2]) 203 cmd.append(');') 204 cmd = "".join(cmd) 205 self.script.append(self._WordWrap(cmd)) 206 207 def WriteFirmwareImage(self, kind, fn): 208 """Arrange to update the given firmware image (kind must be 209 "hboot" or "radio") when recovery finishes.""" 210 if self.version == 1: 211 self.script.append( 212 ('assert(package_extract_file("%(fn)s", "/tmp/%(kind)s.img"),\n' 213 ' write_firmware_image("/tmp/%(kind)s.img", "%(kind)s"));') 214 % {'kind': kind, 'fn': fn}) 215 else: 216 self.script.append( 217 'write_firmware_image("PACKAGE:%s", "%s");' % (fn, kind)) 218 219 def WriteRawImage(self, mount_point, fn): 220 """Write the given package file into the partition for the given 221 mount point.""" 222 223 fstab = self.info["fstab"] 224 if fstab: 225 p = fstab[mount_point] 226 partition_type = common.PARTITION_TYPES[p.fs_type] 227 args = {'device': p.device, 'fn': fn} 228 if partition_type == "MTD": 229 self.script.append( 230 ('assert(package_extract_file("%(fn)s", "/tmp/%(device)s.img"),\n' 231 ' write_raw_image("/tmp/%(device)s.img", "%(device)s"),\n' 232 ' delete("/tmp/%(device)s.img"));') % args) 233 elif partition_type == "EMMC": 234 self.script.append( 235 'package_extract_file("%(fn)s", "%(device)s");' % args) 236 else: 237 raise ValueError("don't know how to write \"%s\" partitions" % (p.fs_type,)) 238 else: 239 # backward compatibility with older target-files that lack recovery.fstab 240 if self.info["partition_type"] == "MTD": 241 self.script.append( 242 ('assert(package_extract_file("%(fn)s", "/tmp/%(partition)s.img"),\n' 243 ' write_raw_image("/tmp/%(partition)s.img", "%(partition)s"),\n' 244 ' delete("/tmp/%(partition)s.img"));') 245 % {'partition': partition, 'fn': fn}) 246 elif self.info["partition_type"] == "EMMC": 247 self.script.append( 248 ('package_extract_file("%(fn)s", "%(dir)s%(partition)s");') 249 % {'partition': partition, 'fn': fn, 250 'dir': self.info.get("partition_path", ""), 251 }) 252 else: 253 raise ValueError("don't know how to write \"%s\" partitions" % 254 (self.info["partition_type"],)) 255 256 def SetPermissions(self, fn, uid, gid, mode): 257 """Set file ownership and permissions.""" 258 self.script.append('set_perm(%d, %d, 0%o, "%s");' % (uid, gid, mode, fn)) 259 260 def SetPermissionsRecursive(self, fn, uid, gid, dmode, fmode): 261 """Recursively set path ownership and permissions.""" 262 self.script.append('set_perm_recursive(%d, %d, 0%o, 0%o, "%s");' 263 % (uid, gid, dmode, fmode, fn)) 264 265 def MakeSymlinks(self, symlink_list): 266 """Create symlinks, given a list of (dest, link) pairs.""" 267 by_dest = {} 268 for d, l in symlink_list: 269 by_dest.setdefault(d, []).append(l) 270 271 for dest, links in sorted(by_dest.iteritems()): 272 cmd = ('symlink("%s", ' % (dest,) + 273 ",\0".join(['"' + i + '"' for i in sorted(links)]) + ");") 274 self.script.append(self._WordWrap(cmd)) 275 276 def RetouchBinaries(self, file_list): 277 """Execute the retouch instructions in files listed.""" 278 cmd = ('retouch_binaries(' + 279 ', '.join(['"' + i[0] + '", "' + i[1] + '"' for i in file_list]) + 280 ');') 281 self.script.append(self._WordWrap(cmd)) 282 283 def UndoRetouchBinaries(self, file_list): 284 """Undo the retouching (retouch to zero offset).""" 285 cmd = ('undo_retouch_binaries(' + 286 ', '.join(['"' + i[0] + '", "' + i[1] + '"' for i in file_list]) + 287 ');') 288 self.script.append(self._WordWrap(cmd)) 289 290 def AppendExtra(self, extra): 291 """Append text verbatim to the output script.""" 292 self.script.append(extra) 293 294 def UnmountAll(self): 295 for p in sorted(self.mounts): 296 self.script.append('unmount("%s");' % (p,)) 297 self.mounts = set() 298 299 def AddToZip(self, input_zip, output_zip, input_path=None): 300 """Write the accumulated script to the output_zip file. input_zip 301 is used as the source for the 'updater' binary needed to run 302 script. If input_path is not None, it will be used as a local 303 path for the binary instead of input_zip.""" 304 305 self.UnmountAll() 306 307 common.ZipWriteStr(output_zip, "META-INF/com/google/android/updater-script", 308 "\n".join(self.script) + "\n") 309 310 if input_path is None: 311 data = input_zip.read("OTA/bin/updater") 312 else: 313 data = open(os.path.join(input_path, "updater")).read() 314 common.ZipWriteStr(output_zip, "META-INF/com/google/android/update-binary", 315 data, perms=0755) 316