| #!/usr/bin/env python |
| # Copyright (c) 2011 The Chromium Authors. All rights reserved. |
| # Use of this source code is governed by a BSD-style license that can be |
| # found in the LICENSE file. |
| |
| """Reports binary size and static initializer metrics for an APK. |
| |
| More information at //docs/speed/binary_size/metrics.md. |
| """ |
| |
| import argparse |
| import collections |
| from contextlib import contextmanager |
| import json |
| import logging |
| import os |
| import re |
| import struct |
| import sys |
| import zipfile |
| import zlib |
| |
| from binary_size import apk_downloader |
| import devil_chromium |
| from devil.android.sdk import build_tools |
| from devil.utils import cmd_helper |
| from devil.utils import lazy |
| import method_count |
| from pylib import constants |
| from pylib.constants import host_paths |
| |
| _AAPT_PATH = lazy.WeakConstant(lambda: build_tools.GetPath('aapt')) |
| _BUILD_UTILS_PATH = os.path.join( |
| host_paths.DIR_SOURCE_ROOT, 'build', 'android', 'gyp') |
| _APK_PATCH_SIZE_ESTIMATOR_PATH = os.path.join( |
| host_paths.DIR_SOURCE_ROOT, 'third_party', 'apk-patch-size-estimator') |
| |
| with host_paths.SysPath(host_paths.BUILD_COMMON_PATH): |
| import perf_tests_results_helper # pylint: disable=import-error |
| |
| with host_paths.SysPath(_BUILD_UTILS_PATH, 0): |
| from util import build_utils # pylint: disable=import-error |
| |
| with host_paths.SysPath(_APK_PATCH_SIZE_ESTIMATOR_PATH): |
| import apk_patch_size_estimator # pylint: disable=import-error |
| |
| |
| # Python had a bug in zipinfo parsing that triggers on ChromeModern.apk |
| # https://bugs.python.org/issue14315 |
| def _PatchedDecodeExtra(self): |
| # Try to decode the extra field. |
| extra = self.extra |
| unpack = struct.unpack |
| while len(extra) >= 4: |
| tp, ln = unpack('<HH', extra[:4]) |
| if tp == 1: |
| if ln >= 24: |
| counts = unpack('<QQQ', extra[4:28]) |
| elif ln == 16: |
| counts = unpack('<QQ', extra[4:20]) |
| elif ln == 8: |
| counts = unpack('<Q', extra[4:12]) |
| elif ln == 0: |
| counts = () |
| else: |
| raise RuntimeError, "Corrupt extra field %s"%(ln,) |
| |
| idx = 0 |
| |
| # ZIP64 extension (large files and/or large archives) |
| if self.file_size in (0xffffffffffffffffL, 0xffffffffL): |
| self.file_size = counts[idx] |
| idx += 1 |
| |
| if self.compress_size == 0xFFFFFFFFL: |
| self.compress_size = counts[idx] |
| idx += 1 |
| |
| if self.header_offset == 0xffffffffL: |
| self.header_offset = counts[idx] |
| idx += 1 |
| |
| extra = extra[ln + 4:] |
| |
| zipfile.ZipInfo._decodeExtra = ( # pylint: disable=protected-access |
| _PatchedDecodeExtra) |
| |
| # Captures an entire config from aapt output. |
| _AAPT_CONFIG_PATTERN = r'config %s:(.*?)config [a-zA-Z-]+:' |
| # Matches string resource entries from aapt output. |
| _AAPT_ENTRY_RE = re.compile( |
| r'resource (?P<id>\w{10}) [\w\.]+:string/.*?"(?P<val>.+?)"', re.DOTALL) |
| _BASE_CHART = { |
| 'format_version': '0.1', |
| 'benchmark_name': 'resource_sizes', |
| 'benchmark_description': 'APK resource size information.', |
| 'trace_rerun_options': [], |
| 'charts': {} |
| } |
| _DUMP_STATIC_INITIALIZERS_PATH = os.path.join( |
| host_paths.DIR_SOURCE_ROOT, 'tools', 'linux', 'dump-static-initializers.py') |
| # Pragma exists when enable_resource_whitelist_generation=true. |
| _RC_HEADER_RE = re.compile( |
| r'^#define (?P<name>\w+) (?:_Pragma\(.*?\) )?(?P<id>\d+)$') |
| _RE_NON_LANGUAGE_PAK = re.compile(r'^assets/.*(resources|percent)\.pak$') |
| _RE_COMPRESSED_LANGUAGE_PAK = re.compile( |
| r'\.lpak$|^assets/(?!stored-locales/).*(?!resources|percent)\.pak$') |
| _RE_STORED_LANGUAGE_PAK = re.compile(r'^assets/stored-locales/.*\.pak$') |
| _READELF_SIZES_METRICS = { |
| 'text': ['.text'], |
| 'data': ['.data', '.rodata', '.data.rel.ro', '.data.rel.ro.local'], |
| 'relocations': ['.rel.dyn', '.rel.plt', '.rela.dyn', '.rela.plt'], |
| 'unwind': ['.ARM.extab', '.ARM.exidx', '.eh_frame', '.eh_frame_hdr', |
| '.ARM.exidxsentinel_section_after_text'], |
| 'symbols': ['.dynsym', '.dynstr', '.dynamic', '.shstrtab', '.got', '.plt', |
| '.got.plt', '.hash', '.gnu.hash'], |
| 'bss': ['.bss'], |
| 'other': ['.init_array', '.fini_array', '.comment', '.note.gnu.gold-version', |
| '.note.crashpad.info', '.note.android.ident', |
| '.ARM.attributes', '.note.gnu.build-id', '.gnu.version', |
| '.gnu.version_d', '.gnu.version_r', '.interp', '.gcc_except_table'] |
| } |
| |
| |
| def _RunReadelf(so_path, options, tool_prefix=''): |
| return cmd_helper.GetCmdOutput( |
| [tool_prefix + 'readelf'] + options + [so_path]) |
| |
| |
| def _ExtractMainLibSectionSizesFromApk(apk_path, main_lib_path, tool_prefix): |
| with Unzip(apk_path, filename=main_lib_path) as extracted_lib_path: |
| grouped_section_sizes = collections.defaultdict(int) |
| section_sizes = _CreateSectionNameSizeMap(extracted_lib_path, tool_prefix) |
| for group_name, section_names in _READELF_SIZES_METRICS.iteritems(): |
| for section_name in section_names: |
| if section_name in section_sizes: |
| grouped_section_sizes[group_name] += section_sizes.pop(section_name) |
| |
| # Group any unknown section headers into the "other" group. |
| for section_header, section_size in section_sizes.iteritems(): |
| print "Unknown elf section header:", section_header |
| grouped_section_sizes['other'] += section_size |
| |
| return grouped_section_sizes |
| |
| |
| def _CreateSectionNameSizeMap(so_path, tool_prefix): |
| stdout = _RunReadelf(so_path, ['-S', '--wide'], tool_prefix) |
| section_sizes = {} |
| # Matches [ 2] .hash HASH 00000000006681f0 0001f0 003154 04 A 3 0 8 |
| for match in re.finditer(r'\[[\s\d]+\] (\..*)$', stdout, re.MULTILINE): |
| items = match.group(1).split() |
| section_sizes[items[0]] = int(items[4], 16) |
| |
| return section_sizes |
| |
| |
| def _ParseLibBuildId(so_path, tool_prefix): |
| """Returns the Build ID of the given native library.""" |
| stdout = _RunReadelf(so_path, ['-n'], tool_prefix) |
| match = re.search(r'Build ID: (\w+)', stdout) |
| return match.group(1) if match else None |
| |
| |
| def _ParseManifestAttributes(apk_path): |
| # Check if the manifest specifies whether or not to extract native libs. |
| skip_extract_lib = False |
| output = cmd_helper.GetCmdOutput([ |
| _AAPT_PATH.read(), 'd', 'xmltree', apk_path, 'AndroidManifest.xml']) |
| m = re.search(r'extractNativeLibs\(.*\)=\(.*\)(\w)', output) |
| if m: |
| skip_extract_lib = not bool(int(m.group(1))) |
| |
| # Dex decompression overhead varies by Android version. |
| m = re.search(r'android:minSdkVersion\(\w+\)=\(type \w+\)(\w+)\n', output) |
| sdk_version = int(m.group(1), 16) |
| # Pre-L: Dalvik - .odex file is simply decompressed/optimized dex file (~1x). |
| # L, M: ART - .odex file is compiled version of the dex file (~4x). |
| # N: ART - Uses Dalvik-like JIT for normal apps (~1x), full compilation for |
| # shared apps (~4x). |
| # Actual multipliers calculated using "apk_operations.py disk-usage". |
| # Will need to update multipliers once apk obfuscation is enabled. |
| # E.g. with obfuscation, the 4.04 changes to 4.46. |
| if sdk_version < 21: |
| dex_multiplier = 1.16 |
| elif sdk_version < 24: |
| dex_multiplier = 4.04 |
| elif 'Monochrome' in apk_path or 'WebView' in apk_path: |
| dex_multiplier = 4.04 # compilation_filter=speed |
| else: |
| dex_multiplier = 1.17 # compilation_filter=speed-profile |
| |
| return dex_multiplier, skip_extract_lib |
| |
| |
| def CountStaticInitializers(so_path, tool_prefix): |
| # Mostly copied from //infra/scripts/legacy/scripts/slave/chromium/sizes.py. |
| def get_elf_section_size(readelf_stdout, section_name): |
| # Matches: .ctors PROGBITS 000000000516add0 5169dd0 000010 00 WA 0 0 8 |
| match = re.search(r'\.%s.*$' % re.escape(section_name), |
| readelf_stdout, re.MULTILINE) |
| if not match: |
| return (False, -1) |
| size_str = re.split(r'\W+', match.group(0))[5] |
| return (True, int(size_str, 16)) |
| |
| # Find the number of files with at least one static initializer. |
| # First determine if we're 32 or 64 bit |
| stdout = _RunReadelf(so_path, ['-h'], tool_prefix) |
| elf_class_line = re.search('Class:.*$', stdout, re.MULTILINE).group(0) |
| elf_class = re.split(r'\W+', elf_class_line)[1] |
| if elf_class == 'ELF32': |
| word_size = 4 |
| else: |
| word_size = 8 |
| |
| # Then find the number of files with global static initializers. |
| # NOTE: this is very implementation-specific and makes assumptions |
| # about how compiler and linker implement global static initializers. |
| si_count = 0 |
| stdout = _RunReadelf(so_path, ['-SW'], tool_prefix) |
| has_init_array, init_array_size = get_elf_section_size(stdout, 'init_array') |
| if has_init_array: |
| si_count = init_array_size / word_size |
| si_count = max(si_count, 0) |
| return si_count |
| |
| |
| def GetStaticInitializers(so_path, tool_prefix): |
| output = cmd_helper.GetCmdOutput([_DUMP_STATIC_INITIALIZERS_PATH, '-d', |
| so_path, '-t', tool_prefix]) |
| summary = re.search(r'Found \d+ static initializers in (\d+) files.', output) |
| return output.splitlines()[:-1], int(summary.group(1)) |
| |
| |
| def _NormalizeLanguagePaks(translations, normalized_apk_size, factor): |
| english_pak = translations.FindByPattern(r'.*/en[-_][Uu][Ss]\.l?pak') |
| num_translations = translations.GetNumEntries() |
| if english_pak: |
| normalized_apk_size -= translations.ComputeZippedSize() |
| normalized_apk_size += int( |
| english_pak.compress_size * num_translations * factor) |
| return normalized_apk_size |
| |
| |
| def _NormalizeResourcesArsc(apk_path, num_arsc_files, num_translations, |
| out_dir): |
| """Estimates the expected overhead of untranslated strings in resources.arsc. |
| |
| See http://crbug.com/677966 for why this is necessary. |
| """ |
| # If there are multiple .arsc files, use the resource packaged APK instead. |
| if num_arsc_files > 1: |
| if not out_dir: |
| print 'Skipping resources.arsc normalization (output directory required)' |
| return 0 |
| ap_name = os.path.basename(apk_path).replace('.apk', '.intermediate.ap_') |
| ap_path = os.path.join(out_dir, 'gen/arsc/apks', ap_name) |
| if not os.path.exists(ap_path): |
| raise Exception('Missing expected file: %s, try rebuilding.' % ap_path) |
| apk_path = ap_path |
| |
| aapt_output = _RunAaptDumpResources(apk_path) |
| # en-rUS is in the default config and may be cluttered with non-translatable |
| # strings, so en-rGB is a better baseline for finding missing translations. |
| en_strings = _CreateResourceIdValueMap(aapt_output, 'en-rGB') |
| fr_strings = _CreateResourceIdValueMap(aapt_output, 'fr') |
| |
| # en-US and en-GB will never be translated. |
| config_count = num_translations - 2 |
| |
| size = 0 |
| for res_id, string_val in en_strings.iteritems(): |
| if string_val == fr_strings[res_id]: |
| string_size = len(string_val) |
| # 7 bytes is the per-entry overhead (not specific to any string). See |
| # https://android.googlesource.com/platform/frameworks/base.git/+/android-4.2.2_r1/tools/aapt/StringPool.cpp#414. |
| # The 1.5 factor was determined experimentally and is meant to account for |
| # other languages generally having longer strings than english. |
| size += config_count * (7 + string_size * 1.5) |
| |
| return size |
| |
| |
| def _CreateResourceIdValueMap(aapt_output, lang): |
| """Return a map of resource ids to string values for the given |lang|.""" |
| config_re = _AAPT_CONFIG_PATTERN % lang |
| return {entry.group('id'): entry.group('val') |
| for config_section in re.finditer(config_re, aapt_output, re.DOTALL) |
| for entry in re.finditer(_AAPT_ENTRY_RE, config_section.group(0))} |
| |
| |
| def _RunAaptDumpResources(apk_path): |
| cmd = [_AAPT_PATH.read(), 'dump', '--values', 'resources', apk_path] |
| status, output = cmd_helper.GetCmdStatusAndOutput(cmd) |
| if status != 0: |
| raise Exception('Failed running aapt command: "%s" with output "%s".' % |
| (' '.join(cmd), output)) |
| return output |
| |
| |
| class _FileGroup(object): |
| """Represents a category that apk files can fall into.""" |
| |
| def __init__(self, name): |
| self.name = name |
| self._zip_infos = [] |
| self._extracted_multipliers = [] |
| |
| def AddZipInfo(self, zip_info, extracted_multiplier=0): |
| self._zip_infos.append(zip_info) |
| self._extracted_multipliers.append(extracted_multiplier) |
| |
| def AllEntries(self): |
| return iter(self._zip_infos) |
| |
| def GetNumEntries(self): |
| return len(self._zip_infos) |
| |
| def FindByPattern(self, pattern): |
| return next((i for i in self._zip_infos if re.match(pattern, i.filename)), |
| None) |
| |
| def FindLargest(self): |
| if not self._zip_infos: |
| return None |
| return max(self._zip_infos, key=lambda i: i.file_size) |
| |
| def ComputeZippedSize(self): |
| return sum(i.compress_size for i in self._zip_infos) |
| |
| def ComputeUncompressedSize(self): |
| return sum(i.file_size for i in self._zip_infos) |
| |
| def ComputeExtractedSize(self): |
| ret = 0 |
| for zi, multiplier in zip(self._zip_infos, self._extracted_multipliers): |
| ret += zi.file_size * multiplier |
| return ret |
| |
| def ComputeInstallSize(self): |
| return self.ComputeExtractedSize() + self.ComputeZippedSize() |
| |
| |
| def PrintApkAnalysis(apk_filename, tool_prefix, out_dir, chartjson=None): |
| """Analyse APK to determine size contributions of different file classes.""" |
| file_groups = [] |
| |
| def make_group(name): |
| group = _FileGroup(name) |
| file_groups.append(group) |
| return group |
| |
| native_code = make_group('Native code') |
| java_code = make_group('Java code') |
| native_resources_no_translations = make_group('Native resources (no l10n)') |
| translations = make_group('Native resources (l10n)') |
| stored_translations = make_group('Native resources stored (l10n)') |
| icu_data = make_group('ICU (i18n library) data') |
| v8_snapshots = make_group('V8 Snapshots') |
| png_drawables = make_group('PNG drawables') |
| res_directory = make_group('Non-compiled Android resources') |
| arsc = make_group('Compiled Android resources') |
| metadata = make_group('Package metadata') |
| unknown = make_group('Unknown files') |
| notices = make_group('licenses.notice file') |
| unwind_cfi = make_group('unwind_cfi (dev and canary only)') |
| |
| apk = zipfile.ZipFile(apk_filename, 'r') |
| try: |
| apk_contents = apk.infolist() |
| finally: |
| apk.close() |
| |
| dex_multiplier, skip_extract_lib = _ParseManifestAttributes(apk_filename) |
| total_apk_size = os.path.getsize(apk_filename) |
| apk_basename = os.path.basename(apk_filename) |
| for member in apk_contents: |
| filename = member.filename |
| if filename.endswith('/'): |
| continue |
| if filename.endswith('.so'): |
| should_extract_lib = not (skip_extract_lib or 'crazy' in filename) |
| native_code.AddZipInfo( |
| member, extracted_multiplier=int(should_extract_lib)) |
| elif filename.endswith('.dex'): |
| java_code.AddZipInfo(member, extracted_multiplier=dex_multiplier) |
| elif re.search(_RE_NON_LANGUAGE_PAK, filename): |
| native_resources_no_translations.AddZipInfo(member) |
| elif re.search(_RE_COMPRESSED_LANGUAGE_PAK, filename): |
| translations.AddZipInfo( |
| member, |
| extracted_multiplier=int('en_' in filename or 'en-' in filename)) |
| elif re.search(_RE_STORED_LANGUAGE_PAK, filename): |
| stored_translations.AddZipInfo(member) |
| elif filename == 'assets/icudtl.dat': |
| icu_data.AddZipInfo(member) |
| elif filename.endswith('.bin'): |
| v8_snapshots.AddZipInfo(member) |
| elif filename.endswith('.png') or filename.endswith('.webp'): |
| png_drawables.AddZipInfo(member) |
| elif filename.startswith('res/'): |
| res_directory.AddZipInfo(member) |
| elif filename.endswith('.arsc'): |
| arsc.AddZipInfo(member) |
| elif filename.startswith('META-INF') or filename == 'AndroidManifest.xml': |
| metadata.AddZipInfo(member) |
| elif filename.endswith('.notice'): |
| notices.AddZipInfo(member) |
| elif filename.startswith('assets/unwind_cfi'): |
| unwind_cfi.AddZipInfo(member) |
| else: |
| unknown.AddZipInfo(member) |
| |
| total_install_size = total_apk_size |
| zip_overhead = total_apk_size |
| |
| for group in file_groups: |
| actual_size = group.ComputeZippedSize() |
| install_size = group.ComputeInstallSize() |
| uncompressed_size = group.ComputeUncompressedSize() |
| |
| total_install_size += group.ComputeExtractedSize() |
| zip_overhead -= actual_size |
| |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_Breakdown', group.name + ' size', |
| actual_size, 'bytes') |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_InstallBreakdown', |
| group.name + ' size', install_size, 'bytes') |
| # Only a few metrics are compressed in the first place. |
| # To avoid over-reporting, track uncompressed size only for compressed |
| # entries. |
| if uncompressed_size != actual_size: |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_Uncompressed', |
| group.name + ' size', uncompressed_size, |
| 'bytes') |
| |
| # Per-file zip overhead is caused by: |
| # * 30 byte entry header + len(file name) |
| # * 46 byte central directory entry + len(file name) |
| # * 0-3 bytes for zipalign. |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_Breakdown', 'Zip Overhead', |
| zip_overhead, 'bytes') |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_InstallSize', 'APK size', |
| total_apk_size, 'bytes') |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_InstallSize', |
| 'Estimated installed size', total_install_size, 'bytes') |
| transfer_size = _CalculateCompressedSize(apk_filename) |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_TransferSize', |
| 'Transfer size (deflate)', transfer_size, 'bytes') |
| |
| # Size of main dex vs remaining. |
| main_dex_info = java_code.FindByPattern('classes.dex') |
| if main_dex_info: |
| main_dex_size = main_dex_info.file_size |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_Specifics', |
| 'main dex size', main_dex_size, 'bytes') |
| secondary_size = java_code.ComputeUncompressedSize() - main_dex_size |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_Specifics', |
| 'secondary dex size', secondary_size, 'bytes') |
| |
| # Size of main .so vs remaining. |
| main_lib_info = native_code.FindLargest() |
| if main_lib_info: |
| main_lib_size = main_lib_info.file_size |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_Specifics', |
| 'main lib size', main_lib_size, 'bytes') |
| secondary_size = native_code.ComputeUncompressedSize() - main_lib_size |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_Specifics', |
| 'other lib size', secondary_size, 'bytes') |
| |
| main_lib_section_sizes = _ExtractMainLibSectionSizesFromApk( |
| apk_filename, main_lib_info.filename, tool_prefix) |
| for metric_name, size in main_lib_section_sizes.iteritems(): |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_MainLibInfo', |
| metric_name, size, 'bytes') |
| |
| # Main metric that we want to monitor for jumps. |
| normalized_apk_size = total_apk_size |
| # unwind_cfi exists only in dev, canary, and non-channel builds. |
| normalized_apk_size -= unwind_cfi.ComputeZippedSize() |
| # Always look at uncompressed .so. |
| normalized_apk_size -= native_code.ComputeZippedSize() |
| normalized_apk_size += native_code.ComputeUncompressedSize() |
| # TODO(agrieve): Once we have better tooling (which can tell you where dex |
| # size came from), change this to "ComputeExtractedSize()". |
| normalized_apk_size += java_code.ComputeUncompressedSize() |
| # Avoid noise caused when strings change and translations haven't yet been |
| # updated. |
| num_translations = translations.GetNumEntries() |
| num_stored_translations = stored_translations.GetNumEntries() |
| |
| if num_translations > 1: |
| # Multipliers found by looking at MonochromePublic.apk and seeing how much |
| # smaller en-US.pak is relative to the average locale.pak. |
| normalized_apk_size = _NormalizeLanguagePaks( |
| translations, normalized_apk_size, 1.17) |
| if num_stored_translations > 1: |
| normalized_apk_size = _NormalizeLanguagePaks( |
| stored_translations, normalized_apk_size, 1.43) |
| if num_translations + num_stored_translations > 1: |
| if num_translations == 0: |
| # WebView stores all locale paks uncompressed. |
| num_arsc_translations = num_stored_translations |
| else: |
| # Monochrome has more configurations than Chrome since it includes |
| # WebView (which supports more locales), but these should mostly be empty |
| # so ignore them here. |
| num_arsc_translations = num_translations |
| normalized_apk_size += int(_NormalizeResourcesArsc( |
| apk_filename, arsc.GetNumEntries(), num_arsc_translations, out_dir)) |
| |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_Specifics', |
| 'normalized apk size', normalized_apk_size, 'bytes') |
| |
| perf_tests_results_helper.ReportPerfResult(chartjson, |
| apk_basename + '_Specifics', |
| 'file count', len(apk_contents), 'zip entries') |
| |
| for info in unknown.AllEntries(): |
| print 'Unknown entry:', info.filename, info.compress_size |
| |
| |
| def _AnnotatePakResources(out_dir): |
| """Returns a pair of maps: id_name_map, id_header_map.""" |
| print 'Looking at resources in: %s' % out_dir |
| |
| grit_headers = [] |
| for root, _, files in os.walk(out_dir): |
| if root.endswith('grit'): |
| grit_headers += [os.path.join(root, f) for f in files if f.endswith('.h')] |
| assert grit_headers, 'Failed to find grit headers in %s' % out_dir |
| |
| id_name_map = {} |
| id_header_map = {} |
| for header in grit_headers: |
| with open(header, 'r') as f: |
| for line in f.readlines(): |
| m = _RC_HEADER_RE.match(line.strip()) |
| if m: |
| i = int(m.group('id')) |
| name = m.group('name') |
| if i in id_name_map and name != id_name_map[i]: |
| print 'WARNING: Resource ID conflict %s (%s vs %s)' % ( |
| i, id_name_map[i], name) |
| id_name_map[i] = name |
| id_header_map[i] = os.path.relpath(header, out_dir) |
| return id_name_map, id_header_map |
| |
| |
| # This method also used by //build/android/gyp/assert_static_initializers.py |
| def AnalyzeStaticInitializers(apk_filename, tool_prefix, dump_sis, out_dir, |
| ignored_libs): |
| # Static initializer counting mostly copies logic in |
| # infra/scripts/legacy/scripts/slave/chromium/sizes.py. |
| with zipfile.ZipFile(apk_filename) as z: |
| so_files = [f for f in z.infolist() |
| if f.filename.endswith('.so') and f.file_size > 0 |
| and os.path.basename(f.filename) not in ignored_libs] |
| # Skip checking static initializers for 32 bit .so files when 64 bit .so files |
| # are present since the 32 bit versions will be checked by bots that only |
| # build the 32 bit version. This avoids the complexity of finding 32 bit .so |
| # files in the output directory in 64 bit builds. |
| has_64 = any('64' in f.filename for f in so_files) |
| files_to_check = [f for f in so_files if not has_64 or '64' in f.filename] |
| |
| si_count = 0 |
| for f in files_to_check: |
| with Unzip(apk_filename, filename=f.filename) as unzipped_so: |
| si_count += CountStaticInitializers(unzipped_so, tool_prefix) |
| if dump_sis: |
| # Print count and list of SIs reported by dump-static-initializers.py. |
| # Doesn't work well on all archs (particularly arm), which is why |
| # the readelf method is used for tracking SI counts. |
| _PrintDumpSIsCount(f.filename, unzipped_so, out_dir, tool_prefix) |
| return si_count |
| |
| |
| def _PrintDumpSIsCount(apk_so_name, unzipped_so, out_dir, tool_prefix): |
| lib_name = os.path.basename(apk_so_name).replace('crazy.', '') |
| so_with_symbols_path = os.path.join(out_dir, 'lib.unstripped', lib_name) |
| if os.path.exists(so_with_symbols_path): |
| _VerifyLibBuildIdsMatch(tool_prefix, unzipped_so, so_with_symbols_path) |
| sis, _ = GetStaticInitializers( |
| so_with_symbols_path, tool_prefix) |
| for si in sis: |
| print si |
| else: |
| raise Exception('Unstripped .so not found. Looked here: %s', |
| so_with_symbols_path) |
| |
| |
| def _CalculateCompressedSize(file_path): |
| CHUNK_SIZE = 256 * 1024 |
| compressor = zlib.compressobj() |
| total_size = 0 |
| with open(file_path, 'rb') as f: |
| for chunk in iter(lambda: f.read(CHUNK_SIZE), ''): |
| total_size += len(compressor.compress(chunk)) |
| total_size += len(compressor.flush()) |
| return total_size |
| |
| |
| def _PrintDexAnalysis(apk_filename, chartjson=None): |
| sizes, total_size = method_count.ExtractSizesFromZip(apk_filename) |
| |
| graph_title = os.path.basename(apk_filename) + '_Dex' |
| dex_metrics = method_count.CONTRIBUTORS_TO_DEX_CACHE |
| cumulative_sizes = collections.defaultdict(int) |
| for classes_dex_sizes in sizes.values(): |
| for key in dex_metrics: |
| cumulative_sizes[key] += classes_dex_sizes[key] |
| for key, label in dex_metrics.iteritems(): |
| perf_tests_results_helper.ReportPerfResult(chartjson, graph_title, label, |
| cumulative_sizes[key], 'entries') |
| |
| graph_title = '%sCache' % graph_title |
| perf_tests_results_helper.ReportPerfResult(chartjson, graph_title, 'DexCache', |
| total_size, 'bytes') |
| |
| |
| def _PrintPatchSizeEstimate(new_apk, builder, bucket, chartjson=None): |
| apk_name = os.path.basename(new_apk) |
| title = apk_name + '_PatchSizeEstimate' |
| # Reference APK paths have spaces replaced by underscores. |
| builder = builder.replace(' ', '_') |
| old_apk = apk_downloader.MaybeDownloadApk( |
| builder, apk_downloader.CURRENT_MILESTONE, apk_name, |
| apk_downloader.DEFAULT_DOWNLOAD_PATH, bucket) |
| if old_apk: |
| # Use a temp dir in case patch size functions fail to clean up temp files. |
| with build_utils.TempDir() as tmp: |
| tmp_name = os.path.join(tmp, 'patch.tmp') |
| bsdiff = apk_patch_size_estimator.calculate_bsdiff( |
| old_apk, new_apk, None, tmp_name) |
| perf_tests_results_helper.ReportPerfResult(chartjson, title, |
| 'BSDiff (gzipped)', bsdiff, 'bytes') |
| fbf = apk_patch_size_estimator.calculate_filebyfile( |
| old_apk, new_apk, None, tmp_name) |
| perf_tests_results_helper.ReportPerfResult(chartjson, title, |
| 'FileByFile (gzipped)', fbf, 'bytes') |
| |
| |
| @contextmanager |
| def Unzip(zip_file, filename=None): |
| """Utility for temporary use of a single file in a zip archive.""" |
| with build_utils.TempDir() as unzipped_dir: |
| unzipped_files = build_utils.ExtractAll( |
| zip_file, unzipped_dir, True, pattern=filename) |
| if len(unzipped_files) == 0: |
| raise Exception( |
| '%s not found in %s' % (filename, zip_file)) |
| yield unzipped_files[0] |
| |
| |
| def _VerifyLibBuildIdsMatch(tool_prefix, *so_files): |
| if len(set(_ParseLibBuildId(f, tool_prefix) for f in so_files)) > 1: |
| raise Exception('Found differing build ids in output directory and apk. ' |
| 'Your output directory is likely stale.') |
| |
| |
| def _ConfigOutDirAndToolsPrefix(out_dir): |
| if out_dir: |
| constants.SetOutputDirectory(os.path.abspath(out_dir)) |
| else: |
| try: |
| out_dir = constants.GetOutDirectory() |
| devil_chromium.Initialize() |
| except EnvironmentError: |
| pass |
| if out_dir: |
| build_vars = build_utils.ReadBuildVars( |
| os.path.join(out_dir, "build_vars.txt")) |
| tool_prefix = os.path.join(out_dir, build_vars['android_tool_prefix']) |
| else: |
| tool_prefix = '' |
| return out_dir, tool_prefix |
| |
| |
| def main(): |
| argparser = argparse.ArgumentParser(description='Print APK size metrics.') |
| argparser.add_argument('--min-pak-resource-size', |
| type=int, |
| default=20*1024, |
| help='Minimum byte size of displayed pak resources.') |
| argparser.add_argument('--chromium-output-directory', |
| dest='out_dir', |
| help='Location of the build artifacts.') |
| argparser.add_argument('--chartjson', |
| action='store_true', |
| help='Sets output mode to chartjson.') |
| argparser.add_argument('--output-dir', |
| default='.', |
| help='Directory to save chartjson to.') |
| argparser.add_argument('--dump-static-initializers', |
| action='store_true', |
| dest='dump_sis', |
| help='Run dump-static-initializers.py to get the list' |
| 'of static initializers (slow).') |
| argparser.add_argument('--loadable_module', |
| action='append', |
| help='Use for libraries added via loadable_modules') |
| argparser.add_argument('--estimate-patch-size', |
| action='store_true', |
| help='Include patch size estimates. Useful for perf ' |
| 'builders where a reference APK is available but adds ' |
| '~3 mins to run time.') |
| argparser.add_argument('--reference-apk-builder', |
| default=apk_downloader.DEFAULT_BUILDER, |
| help='Builder name to use for reference APK for patch ' |
| 'size estimates.') |
| argparser.add_argument('--reference-apk-bucket', |
| default=apk_downloader.DEFAULT_BUCKET, |
| help='Storage bucket holding reference APKs.') |
| argparser.add_argument('apk', help='APK file path.') |
| args = argparser.parse_args() |
| |
| chartjson = _BASE_CHART.copy() if args.chartjson else None |
| out_dir, tool_prefix = _ConfigOutDirAndToolsPrefix(args.out_dir) |
| if args.dump_sis and not out_dir: |
| argparser.error( |
| '--dump-static-initializers requires --chromium-output-directory') |
| |
| # Do not add any new metrics without also documenting them in: |
| # //docs/speed/binary_size/metrics.md. |
| |
| PrintApkAnalysis(args.apk, tool_prefix, out_dir, chartjson=chartjson) |
| _PrintDexAnalysis(args.apk, chartjson=chartjson) |
| |
| ignored_libs = args.loadable_module if args.loadable_module else [] |
| |
| si_count = AnalyzeStaticInitializers( |
| args.apk, tool_prefix, args.dump_sis, out_dir, ignored_libs) |
| perf_tests_results_helper.ReportPerfResult( |
| chartjson, 'StaticInitializersCount', 'count', si_count, 'count') |
| |
| if args.estimate_patch_size: |
| _PrintPatchSizeEstimate(args.apk, args.reference_apk_builder, |
| args.reference_apk_bucket, chartjson=chartjson) |
| if chartjson: |
| results_path = os.path.join(args.output_dir, 'results-chart.json') |
| logging.critical('Dumping json to %s', results_path) |
| with open(results_path, 'w') as json_file: |
| json.dump(chartjson, json_file) |
| |
| |
| if __name__ == '__main__': |
| sys.exit(main()) |
