src/tools/auto_bisect/builder.py

   1 # Copyright 2014 The Chromium Authors. All rights reserved.
   2 # Use of this source code is governed by a BSD-style license that can be
   3 # found in the LICENSE file.
   4
   5 """Classes and functions for building Chrome.
   6
   7 This includes functions for running commands to build, as well as
   8 specific rules about which targets to build.
   9 """
  10
  11 import os
  12 import subprocess
  13 import sys
  14
  15 import bisect_utils
  16
  17 ORIGINAL_ENV = {}
  18
  19
  20 class Builder(object):
  21   """Subclasses of the Builder class are used by the bisect script to build
  22   relevant targets.
  23   """
  24   def __init__(self, opts):
  25     """Performs setup for building with target build system.
  26
  27     Args:
  28       opts: Options parsed from command line.
  29
  30     Raises:
  31       RuntimeError: Some condition necessary for building was not met.
  32     """
  33     if bisect_utils.IsWindowsHost():
  34       if not opts.build_preference:
  35         opts.build_preference = 'msvs'
  36
  37       if opts.build_preference == 'msvs':
  38         if not os.getenv('VS100COMNTOOLS'):
  39           raise RuntimeError(
  40               'Path to visual studio could not be determined.')
  41       else:
  42         # Need to re-escape goma dir, see crbug.com/394990.
  43         if opts.goma_dir:
  44           opts.goma_dir = opts.goma_dir.encode('string_escape')
  45         SetBuildSystemDefault(opts.build_preference, opts.use_goma,
  46                               opts.goma_dir)
  47     else:
  48       if not opts.build_preference:
  49         if 'ninja' in os.getenv('GYP_GENERATORS', default=''):
  50           opts.build_preference = 'ninja'
  51         else:
  52           opts.build_preference = 'make'
  53
  54       SetBuildSystemDefault(opts.build_preference, opts.use_goma, opts.goma_dir)
  55
  56     if not SetupPlatformBuildEnvironment(opts):
  57       raise RuntimeError('Failed to set platform environment.')
  58
  59   @staticmethod
  60   def FromOpts(opts):
  61     """Constructs and returns a Builder object.
  62
  63     Args:
  64       opts: Options parsed from the command-line.
  65     """
  66     builder = None
  67     if opts.target_platform == 'android':
  68       builder = AndroidBuilder(opts)
  69     elif opts.target_platform == 'android-chrome':
  70       builder = AndroidChromeBuilder(opts)
  71     else:
  72       builder = DesktopBuilder(opts)
  73     return builder
  74
  75   def Build(self, depot, opts):
  76     """Runs a command to build Chrome."""
  77     raise NotImplementedError()
  78
  79
  80 def GetBuildOutputDirectory(opts, src_dir=None):
  81   """Returns the path to the build directory, relative to the checkout root.
  82
  83   Assumes that the current working directory is the checkout root.
  84
  85   Args:
  86     opts: Command-line options.
  87     src_dir: Path to chromium/src directory.
  88
  89   Returns:
  90     A path to the directory to use as build output directory.
  91
  92   Raises:
  93     NotImplementedError: The platform according to sys.platform is unexpected.
  94   """
  95   src_dir = src_dir or 'src'
  96   if opts.build_preference == 'ninja' or bisect_utils.IsLinuxHost():
  97     return os.path.join(src_dir, 'out')
  98   if bisect_utils.IsMacHost():
  99     return os.path.join(src_dir, 'xcodebuild')
 100   if bisect_utils.IsWindowsHost():
 101     return os.path.join(src_dir, 'build')
 102   raise NotImplementedError('Unexpected platform %s' % sys.platform)
 103
 104
 105 class DesktopBuilder(Builder):
 106   """DesktopBuilder is used to build Chromium on Linux, Mac, or Windows."""
 107
 108   def __init__(self, opts):
 109     super(DesktopBuilder, self).__init__(opts)
 110
 111   def Build(self, depot, opts):
 112     """Builds chromium_builder_perf target using options passed into the script.
 113
 114     Args:
 115       depot: Name of current depot being bisected.
 116       opts: The options parsed from the command line.
 117
 118     Returns:
 119       True if build was successful.
 120     """
 121     targets = ['chromium_builder_perf']
 122
 123     threads = None
 124     if opts.use_goma:
 125       threads = opts.goma_threads
 126
 127     build_success = False
 128     if opts.build_preference == 'make':
 129       build_success = BuildWithMake(threads, targets, opts.target_build_type)
 130     elif opts.build_preference == 'ninja':
 131       build_success = BuildWithNinja(threads, targets, opts.target_build_type)
 132     elif opts.build_preference == 'msvs':
 133       assert bisect_utils.IsWindowsHost(), 'msvs is only supported on Windows.'
 134       build_success = BuildWithVisualStudio(targets, opts.target_build_type)
 135     else:
 136       assert False, 'No build system defined.'
 137     return build_success
 138
 139
 140 class AndroidBuilder(Builder):
 141   """AndroidBuilder is used to build on android."""
 142
 143   def __init__(self, opts):
 144     super(AndroidBuilder, self).__init__(opts)
 145
 146   # TODO(qyearsley): Make this a class method and verify that it works with
 147   # a unit test.
 148   # pylint: disable=R0201
 149   def _GetTargets(self):
 150     """Returns a list of build targets."""
 151     return ['chrome_shell_apk', 'cc_perftests_apk', 'android_tools']
 152
 153   def Build(self, depot, opts):
 154     """Builds the android content shell and other necessary tools.
 155
 156     Args:
 157         depot: Current depot being bisected.
 158         opts: The options parsed from the command line.
 159
 160     Returns:
 161         True if build was successful.
 162     """
 163     threads = None
 164     if opts.use_goma:
 165       threads = opts.goma_threads
 166
 167     build_success = False
 168     if opts.build_preference == 'ninja':
 169       build_success = BuildWithNinja(
 170           threads, self._GetTargets(), opts.target_build_type)
 171     else:
 172       assert False, 'No build system defined.'
 173
 174     return build_success
 175
 176
 177 class AndroidChromeBuilder(AndroidBuilder):
 178   """AndroidChromeBuilder is used to build "android-chrome".
 179
 180   This is slightly different from AndroidBuilder.
 181   """
 182
 183   def __init__(self, opts):
 184     super(AndroidChromeBuilder, self).__init__(opts)
 185
 186   # TODO(qyearsley): Make this a class method and verify that it works with
 187   # a unit test.
 188   # pylint: disable=R0201
 189   def _GetTargets(self):
 190     """Returns a list of build targets."""
 191     return AndroidBuilder._GetTargets(self) + ['chrome_apk']
 192
 193
 194 def SetBuildSystemDefault(build_system, use_goma, goma_dir):
 195   """Sets up any environment variables needed to build with the specified build
 196   system.
 197
 198   Args:
 199     build_system: A string specifying build system. Currently only 'ninja' or
 200         'make' are supported.
 201   """
 202   if build_system == 'ninja':
 203     gyp_var = os.getenv('GYP_GENERATORS', default='')
 204
 205     if not gyp_var or not 'ninja' in gyp_var:
 206       if gyp_var:
 207         os.environ['GYP_GENERATORS'] = gyp_var + ',ninja'
 208       else:
 209         os.environ['GYP_GENERATORS'] = 'ninja'
 210
 211       if bisect_utils.IsWindowsHost():
 212         os.environ['GYP_DEFINES'] = 'component=shared_library '\
 213             'incremental_chrome_dll=1 disable_nacl=1 fastbuild=1 '\
 214             'chromium_win_pch=0'
 215
 216   elif build_system == 'make':
 217     os.environ['GYP_GENERATORS'] = 'make'
 218   else:
 219     raise RuntimeError('%s build not supported.' % build_system)
 220
 221   if use_goma:
 222     os.environ['GYP_DEFINES'] = '%s %s' % (os.getenv('GYP_DEFINES', default=''),
 223                                            'use_goma=1')
 224     if goma_dir:
 225       os.environ['GYP_DEFINES'] += ' gomadir=%s' % goma_dir
 226
 227
 228 def SetupPlatformBuildEnvironment(opts):
 229   """Performs any platform-specific setup.
 230
 231   Args:
 232     opts: The options parsed from the command line through parse_args().
 233
 234   Returns:
 235     True if successful.
 236   """
 237   if 'android' in opts.target_platform:
 238     CopyAndSaveOriginalEnvironmentVars()
 239     return SetupAndroidBuildEnvironment(opts)
 240   return True
 241
 242
 243 def BuildWithMake(threads, targets, build_type='Release'):
 244   """Runs a make command with the given targets.
 245
 246   Args:
 247     threads: The number of threads to use. None means unspecified/unlimited.
 248     targets: List of make targets.
 249     build_type: Release or Debug.
 250
 251   Returns:
 252     True if the command had a 0 exit code, False otherwise.
 253   """
 254   cmd = ['make', 'BUILDTYPE=%s' % build_type]
 255   if threads:
 256     cmd.append('-j%d' % threads)
 257   cmd += targets
 258   return_code = bisect_utils.RunProcess(cmd)
 259   return not return_code
 260
 261
 262 def BuildWithNinja(threads, targets, build_type='Release'):
 263   """Runs a ninja command with the given targets."""
 264   cmd = ['ninja', '-C', os.path.join('out', build_type)]
 265   if threads:
 266     cmd.append('-j%d' % threads)
 267   cmd += targets
 268   return_code = bisect_utils.RunProcess(cmd)
 269   return not return_code
 270
 271
 272 def BuildWithVisualStudio(targets, build_type='Release'):
 273   """Runs a command to build the given targets with Visual Studio."""
 274   path_to_devenv = os.path.abspath(
 275       os.path.join(os.environ['VS100COMNTOOLS'], '..', 'IDE', 'devenv.com'))
 276   path_to_sln = os.path.join(os.getcwd(), 'chrome', 'chrome.sln')
 277   cmd = [path_to_devenv, '/build', build_type, path_to_sln]
 278   for t in targets:
 279     cmd.extend(['/Project', t])
 280   return_code = bisect_utils.RunProcess(cmd)
 281   return not return_code
 282
 283
 284 def CopyAndSaveOriginalEnvironmentVars():
 285   """Makes a copy of the current environment variables.
 286
 287   Before making a copy of the environment variables and setting a global
 288   variable, this function unsets a certain set of environment variables.
 289   """
 290   # TODO: Waiting on crbug.com/255689, will remove this after.
 291   vars_to_remove = [
 292       'CHROME_SRC',
 293       'CHROMIUM_GYP_FILE',
 294       'GYP_DEFINES',
 295       'GYP_GENERATORS',
 296       'GYP_GENERATOR_FLAGS',
 297       'OBJCOPY',
 298   ]
 299   for key in os.environ:
 300     if 'ANDROID' in key:
 301       vars_to_remove.append(key)
 302   for key in vars_to_remove:
 303     if os.environ.has_key(key):
 304       del os.environ[key]
 305
 306   global ORIGINAL_ENV
 307   ORIGINAL_ENV = os.environ.copy()
 308
 309
 310 def SetupAndroidBuildEnvironment(opts, path_to_src=None):
 311   """Sets up the android build environment.
 312
 313   Args:
 314     opts: The options parsed from the command line through parse_args().
 315     path_to_src: Path to the src checkout.
 316
 317   Returns:
 318     True if successful.
 319   """
 320   # Revert the environment variables back to default before setting them up
 321   # with envsetup.sh.
 322   env_vars = os.environ.copy()
 323   for k, _ in env_vars.iteritems():
 324     del os.environ[k]
 325   for k, v in ORIGINAL_ENV.iteritems():
 326     os.environ[k] = v
 327
 328   envsetup_path = os.path.join('build', 'android', 'envsetup.sh')
 329   proc = subprocess.Popen(['bash', '-c', 'source %s && env' % envsetup_path],
 330                           stdout=subprocess.PIPE,
 331                           stderr=subprocess.PIPE,
 332                           cwd=path_to_src)
 333   out, _ = proc.communicate()
 334
 335   for line in out.splitlines():
 336     k, _, v = line.partition('=')
 337     os.environ[k] = v
 338
 339   # envsetup.sh no longer sets OS=android in GYP_DEFINES environment variable.
 340   # (See http://crrev.com/170273005). So, we set this variable explicitly here
 341   # in order to build Chrome on Android.
 342   if 'GYP_DEFINES' not in os.environ:
 343     os.environ['GYP_DEFINES'] = 'OS=android'
 344   else:
 345     os.environ['GYP_DEFINES'] += ' OS=android'
 346
 347   if opts.use_goma:
 348     os.environ['GYP_DEFINES'] += ' use_goma=1'
 349   return not proc.returncode