123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243 |
- #!/usr/bin/env python
- # Copyright 2018 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.
- from __future__ import print_function
- import json
- import os
- import re
- import subprocess
- import sys
- # Add src/testing/ into sys.path for importing common without pylint errors.
- sys.path.append(
- os.path.abspath(os.path.join(os.path.dirname(__file__), os.path.pardir)))
- from scripts import common
- # A list of files that are allowed to have static initializers.
- # If something adds a static initializer, revert it. We don't accept regressions
- # in static initializers.
- _LINUX_SI_FILE_ALLOWLIST = {
- 'chrome': [
- 'InstrProfilingRuntime.cpp', # Only in coverage builds, not production.
- 'atomicops_internals_x86.cc', # TODO(crbug.com/973551): Remove.
- 'iostream.cpp:', # TODO(crbug.com/973554): Remove.
- '000100', # libc++ uses init_priority 100 for iostreams.
- 'spinlock.cc', # TODO(crbug.com/973556): Remove.
- ],
- 'nacl_helper_bootstrap': [],
- }
- _LINUX_SI_FILE_ALLOWLIST['nacl_helper'] = _LINUX_SI_FILE_ALLOWLIST['chrome']
- # The lists for Chrome OS are conceptually the same as the Linux ones above.
- # If something adds a static initializer, revert it. We don't accept regressions
- # in static initializers.
- _CROS_SI_FILE_ALLOWLIST = {
- 'chrome': [
- 'InstrProfilingRuntime.cpp', # Only in coverage builds, not production.
- 'atomicops_internals_x86.cc', # TODO(crbug.com/973551): Remove.
- 'iostream.cpp:', # TODO(crbug.com/973554): Remove.
- '000100', # libc++ uses init_priority 100 for iostreams.
- 'spinlock.cc', # TODO(crbug.com/973556): Remove.
- 'rpc.pb.cc', # TODO(crbug.com/537099): Remove.
- ],
- 'nacl_helper_bootstrap': [],
- }
- _CROS_SI_FILE_ALLOWLIST['nacl_helper'] = _LINUX_SI_FILE_ALLOWLIST['chrome']
- # Mac can use this list when a dsym is available, otherwise it will fall back
- # to checking the count.
- _MAC_SI_FILE_ALLOWLIST = [
- 'InstrProfilingRuntime.cpp', # Only in coverage builds, not in production.
- 'sysinfo.cc', # Only in coverage builds, not in production.
- 'iostream.cpp', # Used to setup std::cin/cout/cerr.
- '000100', # Used to setup std::cin/cout/cerr
- ]
- # Two static initializers are needed on Mac for libc++ to set up
- # std::cin/cout/cerr before main() runs. Only iostream.cpp needs to be counted
- # here. Plus, PartitionAlloc-Everywhere uses one static initializer
- # (InitializeDefaultMallocZoneWithPartitionAlloc) to install a malloc zone.
- FALLBACK_EXPECTED_MAC_SI_COUNT = 3
- # For coverage builds, also allow 'IntrProfilingRuntime.cpp'
- COVERAGE_BUILD_FALLBACK_EXPECTED_MAC_SI_COUNT = 4
- def run_process(command):
- p = subprocess.Popen(command, stdout=subprocess.PIPE, universal_newlines=True)
- stdout = p.communicate()[0]
- if p.returncode != 0:
- raise Exception(
- 'ERROR from command "%s": %d' % (' '.join(command), p.returncode))
- return stdout
- def main_mac(src_dir, allow_coverage_initializer = False):
- base_names = ('Chromium', 'Google Chrome')
- ret = 0
- for base_name in base_names:
- app_bundle = base_name + '.app'
- framework_name = base_name + ' Framework'
- framework_bundle = framework_name + '.framework'
- framework_dsym_bundle = framework_bundle + '.dSYM'
- framework_unstripped_name = framework_name + '.unstripped'
- chromium_executable = os.path.join(app_bundle, 'Contents', 'MacOS',
- base_name)
- chromium_framework_executable = os.path.join(framework_bundle,
- framework_name)
- chromium_framework_dsym = os.path.join(framework_dsym_bundle, 'Contents',
- 'Resources', 'DWARF', framework_name)
- if os.path.exists(chromium_executable):
- # Count the number of files with at least one static initializer.
- si_count = 0
- # Find the __DATA,__mod_init_func section.
- # If the checkout uses the hermetic xcode binaries, then otool must be
- # directly invoked. The indirection via /usr/bin/otool won't work unless
- # there's an actual system install of Xcode.
- hermetic_xcode_path = os.path.join(src_dir, 'build', 'mac_files',
- 'xcode_binaries')
- if os.path.exists(hermetic_xcode_path):
- otool_path = os.path.join(hermetic_xcode_path, 'Contents', 'Developer',
- 'Toolchains', 'XcodeDefault.xctoolchain', 'usr', 'bin', 'otool')
- else:
- otool_path = 'otool'
- stdout = run_process([otool_path, '-l', chromium_framework_executable])
- section_index = stdout.find('sectname __mod_init_func')
- if section_index != -1:
- # If the section exists, the "size" line must follow it.
- initializers_s = re.search('size 0x([0-9a-f]+)',
- stdout[section_index:]).group(1)
- word_size = 8 # Assume 64 bit
- si_count = int(initializers_s, 16) / word_size
- # Print the list of static initializers.
- if si_count > 0:
- # First look for a dSYM to get information about the initializers. If
- # one is not present, check if there is an unstripped copy of the build
- # output.
- mac_tools_path = os.path.join(src_dir, 'tools', 'mac')
- if os.path.exists(chromium_framework_dsym):
- dump_static_initializers = os.path.join(
- mac_tools_path, 'dump-static-initializers.py')
- stdout = run_process(
- [dump_static_initializers, chromium_framework_dsym])
- for line in stdout:
- if re.match('0x[0-9a-f]+', line) and not any(
- f in line for f in _MAC_SI_FILE_ALLOWLIST):
- ret = 1
- print('Found invalid static initializer: {}'.format(line))
- print(stdout)
- else:
- allowed_si_count = FALLBACK_EXPECTED_MAC_SI_COUNT
- if allow_coverage_initializer:
- allowed_si_count = COVERAGE_BUILD_FALLBACK_EXPECTED_MAC_SI_COUNT
- if si_count > allowed_si_count:
- print('Expected <= %d static initializers in %s, but found %d' %
- (allowed_si_count, chromium_framework_executable,
- si_count))
- ret = 1
- show_mod_init_func = os.path.join(mac_tools_path,
- 'show_mod_init_func.py')
- args = [show_mod_init_func]
- if os.path.exists(framework_unstripped_name):
- args.append(framework_unstripped_name)
- else:
- print('# Warning: Falling back to potentially stripped output.')
- args.append(chromium_framework_executable)
- if os.path.exists(hermetic_xcode_path):
- args.extend(['--xcode-path', hermetic_xcode_path])
- stdout = run_process(args)
- print(stdout)
- return ret
- def main_linux(src_dir, is_chromeos):
- ret = 0
- allowlist = _CROS_SI_FILE_ALLOWLIST if is_chromeos else \
- _LINUX_SI_FILE_ALLOWLIST
- for binary_name in allowlist:
- if not os.path.exists(binary_name):
- continue
- dump_static_initializers = os.path.join(src_dir, 'tools', 'linux',
- 'dump-static-initializers.py')
- stdout = run_process([dump_static_initializers, '-d', binary_name])
- # The output has the following format:
- # First lines: '# <file_name> <si_name>'
- # Last line: '# Found <num> static initializers in <num> files.'
- #
- # For example:
- # # spinlock.cc GetSystemCPUsCount()
- # # spinlock.cc adaptive_spin_count
- # # Found 2 static initializers in 1 files.
- files_with_si = set()
- for line in stdout.splitlines()[:-1]:
- parts = line.split(' ', 2)
- assert len(parts) == 3 and parts[0] == '#'
- files_with_si.add(parts[1])
- for f in files_with_si:
- if f not in allowlist[binary_name]:
- ret = 1
- print(('Error: file "%s" is not expected to have static initializers in'
- ' binary "%s"') % (f, binary_name))
- print('\n# Static initializers in %s:' % binary_name)
- print(stdout)
- return ret
- def main_run(args):
- if args.build_config_fs != 'Release':
- raise Exception('Only release builds are supported')
- src_dir = args.paths['checkout']
- build_dir = os.path.join(src_dir, 'out', args.build_config_fs)
- os.chdir(build_dir)
- if sys.platform.startswith('darwin'):
- rc = main_mac(src_dir,
- allow_coverage_initializer = '--allow-coverage-initializer' in args.args)
- elif sys.platform.startswith('linux'):
- is_chromeos = 'buildername' in args.properties and \
- 'chromeos' in args.properties['buildername']
- rc = main_linux(src_dir, is_chromeos)
- else:
- sys.stderr.write('Unsupported platform %s.\n' % repr(sys.platform))
- return 2
- common.record_local_script_results(
- 'check_static_initializers', args.output, [], rc == 0)
- return rc
- def main_compile_targets(args):
- if sys.platform.startswith('darwin'):
- compile_targets = ['chrome']
- elif sys.platform.startswith('linux'):
- compile_targets = ['chrome', 'nacl_helper', 'nacl_helper_bootstrap']
- else:
- compile_targets = []
- json.dump(compile_targets, args.output)
- return 0
- if __name__ == '__main__':
- funcs = {
- 'run': main_run,
- 'compile_targets': main_compile_targets,
- }
- sys.exit(common.run_script(sys.argv[1:], funcs))
|