blob: 22733cbe590525ce41ef255ede33678de023cfc0 [file] [log] [blame]
# Copyright 2016 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.
import default_flavor
"""GN flavor utils, used for building Skia with GN."""
class GNFlavorUtils(default_flavor.DefaultFlavorUtils):
def _run(self, title, cmd, infra_step=False, **kwargs):
return self.m.run(self.m.step, title, cmd=cmd,
infra_step=infra_step, **kwargs)
def _py(self, title, script, infra_step=True, args=()):
return self.m.run(self.m.python, title, script=script, args=args,
infra_step=infra_step)
def build_command_buffer(self):
self.m.run(self.m.python, 'build command_buffer',
script=self.m.vars.skia_dir.join('tools', 'build_command_buffer.py'),
args=[
'--chrome-dir', self.m.vars.checkout_root,
'--output-dir', self.m.vars.skia_out.join(self.m.vars.configuration),
'--no-sync', '--make-output-dir'])
def _get_goma_json(self):
json_key = 'jwt_service_account_goma-client'
json_filename = json_key + '.json'
# Ensure that the tmp_dir exists.
self.m.run.run_once(self.m.file.ensure_directory,
'makedirs tmp_dir',
self.m.vars.tmp_dir)
json_file = self.m.vars.tmp_dir.join(json_filename)
self.m.python.inline(
'download ' + json_filename,
"""
import os
import sys
import urllib2
TOKEN_URL = (
'http://metadata/computeMetadata/v1/project/attributes/%s')
req = urllib2.Request(TOKEN_URL, headers={'Metadata-Flavor': 'Google'})
contents = urllib2.urlopen(req).read()
with open(sys.argv[1], 'w') as f:
f.write(contents)
""" % json_key,
args=[json_file],
infra_step=True)
return json_file
def compile(self, unused_target):
"""Build Skia with GN."""
compiler = self.m.vars.builder_cfg.get('compiler', '')
configuration = self.m.vars.builder_cfg.get('configuration', '')
extra_tokens = self.m.vars.extra_tokens
os = self.m.vars.builder_cfg.get('os', '')
target_arch = self.m.vars.builder_cfg.get('target_arch', '')
goma_dir = None
clang_linux = str(self.m.vars.slave_dir.join('clang_linux'))
emscripten_sdk = str(self.m.vars.slave_dir.join('emscripten_sdk'))
linux_vulkan_sdk = str(self.m.vars.slave_dir.join('linux_vulkan_sdk'))
win_toolchain = str(self.m.vars.slave_dir.join(
't', 'depot_tools', 'win_toolchain', 'vs_files',
'a9e1098bba66d2acccc377d5ee81265910f29272'))
win_vulkan_sdk = str(self.m.vars.slave_dir.join('win_vulkan_sdk'))
cc, cxx = None, None
extra_cflags = []
extra_ldflags = []
if compiler == 'Clang' and self.m.vars.is_linux:
cc = clang_linux + '/bin/clang'
cxx = clang_linux + '/bin/clang++'
extra_cflags .append('-B%s/bin' % clang_linux)
extra_ldflags.append('-B%s/bin' % clang_linux)
extra_ldflags.append('-fuse-ld=lld')
elif compiler == 'Clang':
cc, cxx = 'clang', 'clang++'
elif compiler == 'GCC' and os == "Ubuntu14":
cc, cxx = 'gcc-4.8', 'g++-4.8'
elif compiler == 'GCC':
cc, cxx = 'gcc', 'g++'
elif compiler == 'EMCC':
cc = emscripten_sdk + '/emscripten/incoming/emcc'
cxx = emscripten_sdk + '/emscripten/incoming/em++'
extra_cflags.append('-Wno-unknown-warning-option')
if 'Coverage' in extra_tokens:
# See https://clang.llvm.org/docs/SourceBasedCodeCoverage.html for
# more info on using llvm to gather coverage information.
extra_cflags.append('-fprofile-instr-generate')
extra_cflags.append('-fcoverage-mapping')
extra_ldflags.append('-fprofile-instr-generate')
extra_ldflags.append('-fcoverage-mapping')
if compiler != 'MSVC' and configuration == 'Debug':
extra_cflags.append('-O1')
if 'Exceptions' in extra_tokens:
extra_cflags.append('/EHsc')
if 'Fast' in extra_tokens:
extra_cflags.extend(['-march=native', '-fomit-frame-pointer', '-O3',
'-ffp-contract=off'])
# TODO(benjaminwagner): Same appears in compile.py to set CPPFLAGS. Are
# both needed?
if len(extra_tokens) == 1 and extra_tokens[0].startswith('SK'):
extra_cflags.append('-D' + extra_tokens[0])
if 'MSAN' in extra_tokens:
extra_ldflags.append('-L' + clang_linux + '/msan')
args = {}
ninja_args = ['-k', '0', '-C', self.out_dir]
env = {}
if configuration != 'Debug':
args['is_debug'] = 'false'
if 'ANGLE' in extra_tokens:
args['skia_use_angle'] = 'true'
if 'CommandBuffer' in extra_tokens:
self.m.run.run_once(self.build_command_buffer)
if 'MSAN' in extra_tokens:
args['skia_enable_gpu'] = 'false'
args['skia_use_fontconfig'] = 'false'
if 'ASAN' in extra_tokens or 'UBSAN' in extra_tokens:
args['skia_enable_spirv_validation'] = 'false'
if 'Mini' in extra_tokens:
args.update({
'is_component_build': 'true', # Proves we can link a coherent .so.
'is_official_build': 'true', # No debug symbols, no tools.
'skia_enable_effects': 'false',
'skia_enable_gpu': 'true',
'skia_enable_pdf': 'false',
'skia_use_expat': 'false',
'skia_use_libjpeg_turbo': 'false',
'skia_use_libpng': 'false',
'skia_use_libwebp': 'false',
'skia_use_zlib': 'false',
})
if 'NoGPU' in extra_tokens:
args['skia_enable_gpu'] = 'false'
if 'EmbededResouces' in extra_tokens:
args['skia_embed_resoucres'] = 'true'
if 'Shared' in extra_tokens:
args['is_component_build'] = 'true'
if 'Vulkan' in extra_tokens and not 'Android' in extra_tokens:
args['skia_enable_vulkan_debug_layers'] = 'false'
if self.m.vars.is_linux:
args['skia_vulkan_sdk'] = '"%s"' % linux_vulkan_sdk
if 'Win' in os:
args['skia_vulkan_sdk'] = '"%s"' % win_vulkan_sdk
if 'Metal' in extra_tokens:
args['skia_use_metal'] = 'true'
if 'iOS' in extra_tokens:
# Bots use Chromium signing cert.
args['skia_ios_identity'] = '".*GS9WA.*"'
args['skia_ios_profile'] = '"Upstream Testing Provisioning Profile"'
if 'CheckGeneratedFiles' in extra_tokens:
args['skia_compile_processors'] = 'true'
if compiler == 'Clang' and 'Win' in os:
args['clang_win'] = '"%s"' % self.m.vars.slave_dir.join('clang_win')
if target_arch == 'wasm':
args.update({
'skia_use_freetype': 'false',
'skia_use_fontconfig': 'false',
'skia_use_dng_sdk': 'false',
'skia_use_icu': 'false',
'skia_enable_gpu': 'false',
})
if 'Goma' in extra_tokens or 'GomaNoFallback' in extra_tokens:
json_file = self._get_goma_json()
self.m.cipd.set_service_account_credentials(json_file)
goma_package = ('infra_internal/goma/client/%s' %
self.m.cipd.platform_suffix())
goma_dir = self.m.path['cache'].join('goma')
self.m.cipd.ensure(goma_dir, {goma_package: 'release'})
env['GOMA_SERVICE_ACCOUNT_JSON_FILE'] = json_file
if 'GomaNoFallback' in extra_tokens:
env['GOMA_HERMETIC'] = 'error'
env['GOMA_USE_LOCAL'] = '0'
env['GOMA_FALLBACK'] = '0'
with self.m.context(cwd=goma_dir, env=env):
self._py('start goma', 'goma_ctl.py', args=['ensure_start'])
args['cc_wrapper'] = '"%s"' % goma_dir.join('gomacc')
if 'ANGLE' in extra_tokens and 'Win' in os:
# ANGLE uses case-insensitive include paths in D3D code. Not sure why
# only Goma warns about this.
extra_cflags.append('-Wno-nonportable-include-path')
ninja_args.extend(['-j', '2000'])
sanitize = ''
for t in extra_tokens:
if t.endswith('SAN'):
sanitize = t
if 'SafeStack' in extra_tokens:
assert sanitize == ''
sanitize = 'safe-stack'
for (k,v) in {
'cc': cc,
'cxx': cxx,
'sanitize': sanitize,
'target_cpu': target_arch,
'target_os': 'ios' if 'iOS' in extra_tokens else '',
'win_sdk': win_toolchain + '/win_sdk' if 'Win' in os else '',
'win_vc': win_toolchain + '/VC' if 'Win' in os else '',
}.iteritems():
if v:
args[k] = '"%s"' % v
if extra_cflags:
args['extra_cflags'] = repr(extra_cflags).replace("'", '"')
if extra_ldflags:
args['extra_ldflags'] = repr(extra_ldflags).replace("'", '"')
gn_args = ' '.join('%s=%s' % (k,v) for (k,v) in sorted(args.iteritems()))
gn = 'gn.exe' if 'Win' in os else 'gn'
ninja = 'ninja.exe' if 'Win' in os else 'ninja'
gn = self.m.vars.skia_dir.join('bin', gn)
try:
with self.m.context(cwd=self.m.vars.skia_dir):
self._py('fetch-gn', self.m.vars.skia_dir.join('bin', 'fetch-gn'))
if 'CheckGeneratedFiles' in extra_tokens:
env['PATH'] = '%s:%%(PATH)s' % self.m.vars.skia_dir.join('bin')
self._py(
'fetch-clang-format',
self.m.vars.skia_dir.join('bin', 'fetch-clang-format'))
if target_arch == 'wasm':
fastcomp = emscripten_sdk + '/clang/fastcomp/build_incoming_64/bin'
env['PATH'] = '%s:%%(PATH)s' % fastcomp
with self.m.env(env):
self._run('gn gen', [gn, 'gen', self.out_dir, '--args=' + gn_args])
self._run('ninja', [ninja] + ninja_args)
finally:
if goma_dir:
with self.m.context(cwd=goma_dir, env=env):
self.m.run(self.m.python, 'print goma stats',
script='goma_ctl.py', args=['stat'], infra_step=True,
abort_on_failure=False, fail_build_on_failure=False)
self.m.run(self.m.python, 'stop goma',
script='goma_ctl.py', args=['stop'], infra_step=True,
abort_on_failure=False, fail_build_on_failure=False)
# Hack: goma_ctl stop is asynchronous, so the process often does not
# stop before the recipe exits, which causes Swarming to freak out.
# Wait a couple seconds for it to exit normally.
# TODO(dogben): Remove after internal b/72128121 is resolved.
self.m.run(self.m.python.inline, 'wait for goma_ctl stop',
program="""import time; time.sleep(2)""",
infra_step=True,
abort_on_failure=False, fail_build_on_failure=False)
def copy_extra_build_products(self, swarming_out_dir):
configuration = self.m.vars.builder_cfg.get('configuration', '')
extra_tokens = self.m.vars.extra_tokens
os = self.m.vars.builder_cfg.get('os', '')
win_vulkan_sdk = str(self.m.vars.slave_dir.join('win_vulkan_sdk'))
if 'Win' in os and 'Vulkan' in extra_tokens:
self.m.run.copy_build_products(
win_vulkan_sdk,
swarming_out_dir.join('out', configuration + '_x64'))
def step(self, name, cmd):
app = self.m.vars.skia_out.join(self.m.vars.configuration, cmd[0])
cmd = [app] + cmd[1:]
env = self.m.context.env
path = []
ld_library_path = []
slave_dir = self.m.vars.slave_dir
clang_linux = str(slave_dir.join('clang_linux'))
extra_tokens = self.m.vars.extra_tokens
if self.m.vars.is_linux:
if (self.m.vars.builder_cfg.get('cpu_or_gpu', '') == 'GPU'
and 'Intel' in self.m.vars.builder_cfg.get('cpu_or_gpu_value', '')):
# The vulkan in this asset name simply means that the graphics driver
# supports Vulkan. It is also the driver used for GL code.
dri_path = slave_dir.join('linux_vulkan_intel_driver_release')
if self.m.vars.builder_cfg.get('configuration', '') == 'Debug':
dri_path = slave_dir.join('linux_vulkan_intel_driver_debug')
ld_library_path.append(dri_path)
env['LIBGL_DRIVERS_PATH'] = str(dri_path)
env['VK_ICD_FILENAMES'] = str(dri_path.join('intel_icd.x86_64.json'))
if 'Vulkan' in extra_tokens:
path.append(slave_dir.join('linux_vulkan_sdk', 'bin'))
ld_library_path.append(slave_dir.join('linux_vulkan_sdk', 'lib'))
if any('SAN' in t for t in extra_tokens):
# Sanitized binaries may want to run clang_linux/bin/llvm-symbolizer.
path.append(clang_linux + '/bin')
elif self.m.vars.is_linux:
cmd = ['catchsegv'] + cmd
if 'ASAN' in extra_tokens or 'UBSAN' in extra_tokens:
env[ 'ASAN_OPTIONS'] = 'symbolize=1 detect_leaks=1'
env[ 'LSAN_OPTIONS'] = 'symbolize=1 print_suppressions=1'
env['UBSAN_OPTIONS'] = 'symbolize=1 print_stacktrace=1'
if 'MSAN' in extra_tokens:
# Find the MSAN-built libc++.
ld_library_path.append(clang_linux + '/msan')
if 'TSAN' in extra_tokens:
# We don't care about malloc(), fprintf, etc. used in signal handlers.
# If we're in a signal handler, we're already crashing...
env['TSAN_OPTIONS'] = 'report_signal_unsafe=0'
if 'Coverage' in extra_tokens:
# This is the output file for the coverage data. Just running the binary
# will produce the output. The output_file is in the swarming_out_dir and
# thus will be an isolated output of the Test step.
profname = '%s.profraw' % self.m.vars.builder_cfg.get('test_filter','o')
env['LLVM_PROFILE_FILE'] = self.m.path.join(self.m.vars.swarming_out_dir,
profname)
if path:
env['PATH'] = '%%(PATH)s:%s' % ':'.join('%s' % p for p in path)
if ld_library_path:
env['LD_LIBRARY_PATH'] = ':'.join('%s' % p for p in ld_library_path)
to_symbolize = ['dm', 'nanobench']
if name in to_symbolize and self.m.vars.is_linux:
# Convert path objects or placeholders into strings such that they can
# be passed to symbolize_stack_trace.py
args = [slave_dir] + [str(x) for x in cmd]
with self.m.context(cwd=self.m.vars.skia_dir, env=env):
self._py('symbolized %s' % name,
self.module.resource('symbolize_stack_trace.py'),
args=args,
infra_step=False)
else:
with self.m.context(env=env):
self._run(name, cmd)