recipes/clang_toolchain.py

# Copyright 2017 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""Recipe for building Clang toolchain."""

from recipe_engine.config import Enum, ReturnSchema, Single
from recipe_engine.recipe_api import Property

import re


DEPS = [
  'infra/cipd',
  'infra/git',
  'infra/gitiles',
  'infra/gsutil',
  'infra/hash',
  'infra/jiri',
  'recipe_engine/context',
  'recipe_engine/file',
  'recipe_engine/json',
  'recipe_engine/path',
  'recipe_engine/platform',
  'recipe_engine/properties',
  'recipe_engine/raw_io',
  'recipe_engine/step',
  'recipe_engine/tempfile',
]

LLVM_PROJECT_GIT = 'https://fuchsia.googlesource.com/third_party/llvm-project'

PROPERTIES = {
  'url': Property(kind=str, help='Git repository URL', default=LLVM_PROJECT_GIT),
  'ref': Property(kind=str, help='Git reference', default='refs/heads/master'),
  'revision': Property(kind=str, help='Revision', default=None),
}


def RunSteps(api, url, ref, revision):
  api.gitiles.ensure_gitiles()
  api.gsutil.ensure_gsutil()
  api.jiri.ensure_jiri()

  api.cipd.set_service_account_credentials(
      api.cipd.default_bot_service_account_credentials)

  if not revision:
    revision = api.gitiles.refs(url).get(ref, None)
  cipd_pkg_name = 'fuchsia/clang/' + api.cipd.platform_suffix()
  step = api.cipd.search(cipd_pkg_name, 'git_revision:' + revision)
  if step.json.output['result']:
    api.step('Package is up-to-date', cmd=None)
    return

  with api.context(infra_steps=True):
    api.jiri.init()
    api.jiri.import_manifest(
        'manifest',
        'https://fuchsia.googlesource.com/zircon',
        'zircon'
    )
    api.jiri.update()

    llvm_dir = api.path['start_dir'].join('llvm-project')
    api.git.checkout(url, llvm_dir, ref=revision, submodules=True)

  with api.step.nest('ensure_packages'):
    with api.context(infra_steps=True):
      cipd_dir = api.path['start_dir'].join('cipd')
      packages = {
        'infra/cmake/${platform}': 'version:3.9.2',
        'infra/ninja/${platform}': 'version:1.8.2',
        'infra/swig/${platform}': 'version:3.0.12',
        'fuchsia/clang/${platform}': 'latest',
      }
      if api.platform.name == 'linux':
        packages.update({
          'fuchsia/sysroot/${platform}': 'latest'
        })
      api.cipd.ensure(cipd_dir, packages)

  staging_dir = api.path.mkdtemp('clang')
  pkg_name = 'clang+llvm-x86_64-%s' % api.platform.name.replace('mac', 'darwin')
  pkg_dir = staging_dir.join(pkg_name)
  api.file.ensure_directory('create pkg dir', pkg_dir)

  # build zircon
  zircon_dir = api.path['start_dir'].join('zircon')

  for project in ['user-x86-64', 'user-arm64']:
    with api.context(cwd=zircon_dir):
      api.step('build ' + project, [
        'make',
        '-j%s' % api.platform.cpu_count,
        'PROJECT=' + project,
        'user-only',
      ])

  # build clang+llvm
  build_dir = staging_dir.join('llvm_build_dir')
  api.file.ensure_directory('create llvm build dir', build_dir)

  extra_options = {
    'linux': [
      '-DBOOTSTRAP_CMAKE_EXE_LINKER_FLAGS=-static-libstdc++',
      '-DBOOTSTRAP_CMAKE_SYSROOT=%s' % cipd_dir,
      '-DCMAKE_SYSROOT=%s' % cipd_dir,
    ],
    'mac': [],
  }[api.platform.name]

  with api.context(cwd=build_dir):
    api.step('configure clang', [
      cipd_dir.join('bin', 'cmake'),
      '-GNinja',
      '-DCMAKE_C_COMPILER=%s' % cipd_dir.join('bin', 'clang'),
      '-DCMAKE_CXX_COMPILER=%s' % cipd_dir.join('bin', 'clang++'),
      '-DCMAKE_ASM_COMPILER=%s' % cipd_dir.join('bin', 'clang'),
      '-DCMAKE_MAKE_PROGRAM=%s' % cipd_dir.join('ninja'),
      '-DCMAKE_INSTALL_PREFIX=',
      '-DSWIG_EXECUTABLE=%s' % cipd_dir.join('bin', 'swig'),
      '-DBOOTSTRAP_SWIG_EXECUTABLE=%s' % cipd_dir.join('bin', 'swig'),
      '-DFUCHSIA_x86_64_SYSROOT=%s' % zircon_dir.join('build-user-x86-64', 'sysroot'),
      '-DFUCHSIA_aarch64_SYSROOT=%s' % zircon_dir.join('build-user-arm64', 'sysroot'),
      '-DLLVM_ENABLE_PROJECTS=clang;lld',
      '-DLLVM_ENABLE_RUNTIMES=compiler-rt;libcxx;libcxxabi;libunwind',
    ] + extra_options + [
      '-C', llvm_dir.join('clang', 'cmake', 'caches', 'Fuchsia.cmake'),
      llvm_dir.join('llvm'),
    ])
    api.step('build clang', [cipd_dir.join('ninja'), 'stage2-distribution'])
    # TODO: we should be running stage2-check-all
    api.step('check llvm', [cipd_dir.join('ninja'), 'stage2-check-llvm'])
    api.step('check clang', [cipd_dir.join('ninja'), 'stage2-check-clang'])
    with api.context(env={'DESTDIR': pkg_dir}):
      api.step('install clang',
               [cipd_dir.join('ninja'), 'stage2-install-distribution'])

  # use first rather than second stage clang just in case we're cross-compiling
  step_result = api.step('clang version',
      [build_dir.join('bin', 'clang'), '--version'],
      stdout=api.raw_io.output())
  m = re.search(r'version ([0-9.-]+)', step_result.stdout)
  assert m, 'Cannot determine Clang version'
  clang_version = m.group(1)

  pkg_def = api.cipd.PackageDefinition(
      package_name=cipd_pkg_name,
      package_root=pkg_dir,
      install_mode='copy')
  pkg_def.add_dir(pkg_dir)
  pkg_def.add_version_file('.versions/clang.cipd_version')

  cipd_pkg_file = api.path['tmp_base'].join('clang.cipd')

  api.cipd.build_from_pkg(
      pkg_def=pkg_def,
      output_package=cipd_pkg_file,
  )
  step_result = api.cipd.register(
      package_name=cipd_pkg_name,
      package_path=cipd_pkg_file,
      refs=['latest'],
      tags={
        'version': clang_version,
        'git_repository': LLVM_PROJECT_GIT,
        'git_revision': revision,
      },
  )

  api.gsutil.upload(
      'fuchsia',
      cipd_pkg_file,
      api.gsutil.join('clang', api.cipd.platform_suffix(), step_result.json.output['result']['instance_id']),
      unauthenticated_url=True
  )


def GenTests(api):
  revision = '75b05681239cb309a23fcb4f8864f177e5aa62da'
  version = 'clang version 5.0.0 (trunk 302207) (llvm/trunk 302209)'
  for platform in ('linux', 'mac'):
    yield (api.test(platform) +
           api.platform.name(platform) +
           api.gitiles.refs('refs', ('refs/heads/master', revision)))
    yield (api.test(platform + '_new') +
           api.platform.name(platform) +
           api.gitiles.refs('refs', ('refs/heads/master', revision)) +
           api.step_data('clang version', api.raw_io.stream_output(version)) +
           api.step_data('cipd search fuchsia/clang/' + platform + '-amd64 ' +
                         'git_revision:' + revision,
                         api.json.output({'result': []})))