Add the ability to build Chrome tools to the Win Clang build script.

tools/clang/scripts/update.py

 #!/usr/bin/env python
 # Copyright (c) 2012 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.
 
 """Windows can't run .sh files, so this is a Python implementation of
 update.sh. This script should replace update.sh on all platforms eventually."""
 
+import argparse
 import os
 import re
 import shutil
 import subprocess
 import stat
 import sys
 import time
 
 # Do NOT CHANGE this if you don't know what you're doing -- see
 # https://code.google.com/p/chromium/wiki/UpdatingClang
 # Reverting problematic clang rolls is safe, though.
 # Note: this revision is only used for Windows. Other platforms use update.sh.
 LLVM_WIN_REVISION = 'HEAD'
 
 # ASan on Windows is useful enough to use it even while the clang/win is still
 # in bringup. Use a pinned revision to make it slightly more stable.
 if (re.search(r'\b(asan)=1', os.environ.get('GYP_DEFINES', '')) and
     not 'LLVM_FORCE_HEAD_REVISION' in os.environ):
   LLVM_WIN_REVISION = '233530'
 
 # Path constants. (All of these should be absolute paths.)
 THIS_DIR = os.path.abspath(os.path.dirname(__file__))
 CHROMIUM_DIR = os.path.abspath(os.path.join(THIS_DIR, '..', '..', '..'))
 LLVM_DIR = os.path.join(CHROMIUM_DIR, 'third_party', 'llvm')
+CHROME_TOOLS_SHIM_DIR = os.path.join(LLVM_DIR, 'tools', 'chrometools')
 LLVM_BUILD_DIR = os.path.join(CHROMIUM_DIR, 'third_party', 'llvm-build',
                               'Release+Asserts')
 COMPILER_RT_BUILD_DIR = os.path.join(LLVM_BUILD_DIR, '32bit-compiler-rt')
 CLANG_DIR = os.path.join(LLVM_DIR, 'tools', 'clang')
 LLD_DIR = os.path.join(LLVM_DIR, 'tools', 'lld')
 COMPILER_RT_DIR = os.path.join(LLVM_DIR, 'projects', 'compiler-rt')
 STAMP_FILE = os.path.join(LLVM_BUILD_DIR, 'cr_build_revision')
 VERSION = '3.7.0'
 
 LLVM_REPO_URL='https://llvm.org/svn/llvm-project'
@@ skipping 79 matching lines @@
     return
 
   if os.path.isdir(dir):
     print "Removing %s." % (dir)
     RmTree(dir)
 
   print "Retrying."
   RunCommand(command)
 
 
+def DeleteChromeToolsShim():
+  shutil.rmtree(CHROME_TOOLS_SHIM_DIR)
+
+
+def CreateChromeToolsShim():
+  """Hooks the Chrome tools into the LLVM build.
+
+  Several Chrome tools have dependencies on LLVM/Clang libraries. The LLVM build
+  detects implicit tools in the tools subdirectory, so this helper install a
+  shim CMakeLists.txt that forwards to the real directory for the Chrome tools.
+
+  Note that the shim directory name intentionally has no _ or _. The implicit

[Nico, 2015/04/07 04:18:55]

_ or _?

[dcheng, 2015/04/07 07:22:53]

Hmm. I copy pasted this from update.sh... and sure enough, the same typo is
there!

Fixed here for now. Will fix the other one when I get a chance.

+  tool detection logic munges them in a weird way."""

[Nico, 2015/04/07 04:18:55]

assert not '_'in CHROME_TOOLS_SHIM_DIR
?

[dcheng, 2015/04/07 07:22:53]

Done.

+  os.mkdir(CHROME_TOOLS_SHIM_DIR)
+  with file(os.path.join(CHROME_TOOLS_SHIM_DIR, 'CMakeLists.txt'), 'w') as f:

[Nico, 2015/04/07 04:18:55]

f.write('# Automatically generated by tools/clang/scripts/update.py. Do not
edit')

[dcheng, 2015/04/07 07:22:53]

Done.

+    f.write("# Since tools/clang isn't actually a subdirectory, use the two\n")

[Nico, 2015/04/07 04:18:55]

nit: single quotes

[dcheng, 2015/04/07 07:22:53]

Rephrased the text to avoid single quotes so I switched these strings to use
single quotes now.

+    f.write("# argument version to specify where build artifacts go. CMake\n")
+    f.write("# disallows reuse of the same binary dir for multiple source\n")
+    f.write("# dirs, so the build artifacts need to go into a subdirectory.\n")
+    f.write("add_subdirectory(${CHROMIUM_TOOLS_SRC} ")
+    f.write("${CMAKE_CURRENT_BINARY_DIR}/a)\n")
+
+
 def AddCMakeToPath():
   """Look for CMake and add it to PATH if it's not there already."""
   try:
     # First check if cmake is already on PATH.
     subprocess.call(['cmake', '--version'])
     return
   except OSError as e:
     if e.errno != os.errno.ENOENT:
       raise
 
@@ skipping 32 matching lines @@
   # svn.bat in depot_tools will be ignored.
   default_pathext = ('.com', '.exe', '.bat', '.cmd')
   for path in os.environ.get('PATH', '').split(os.pathsep):
     for ext in default_pathext:
       candidate = os.path.join(path, 'svn' + ext)
       if os.path.isfile(candidate):
         return '-DSubversion_SVN_EXECUTABLE=%s' % candidate
   return ''
 
 
-def UpdateClang():
+def UpdateClang(args):
   print 'Updating Clang to %s...' % (LLVM_WIN_REVISION)
   if LLVM_WIN_REVISION != 'HEAD' and ReadStampFile() == LLVM_WIN_REVISION:
     print 'Already up to date.'
     return 0
 
   AddCMakeToPath()
-  ClobberChromiumBuildFiles()
+  if args.clobber:
+    ClobberChromiumBuildFiles()
 
   # Reset the stamp file in case the build is unsuccessful.
   WriteStampFile('')
 
+  DeleteChromeToolsShim();
   Checkout('LLVM', LLVM_REPO_URL + '/llvm/trunk', LLVM_DIR)
   Checkout('Clang', LLVM_REPO_URL + '/cfe/trunk', CLANG_DIR)
   Checkout('LLD', LLVM_REPO_URL + '/lld/trunk', LLD_DIR)
   Checkout('compiler-rt', LLVM_REPO_URL + '/compiler-rt/trunk', COMPILER_RT_DIR)
+  CreateChromeToolsShim();
 
   if not os.path.exists(LLVM_BUILD_DIR):
     os.makedirs(LLVM_BUILD_DIR)
   os.chdir(LLVM_BUILD_DIR)
 
+  cmake_args = ['-GNinja', '-DCMAKE_BUILD_TYPE=Release',
+                '-DLLVM_ENABLE_ASSERTIONS=ON', SubversionCmakeArg(),
+                '-DCHROMIUM_TOOLS_SRC=%s' % os.path.join(
+                    CHROMIUM_DIR, 'tools', 'clang')]
+  if args.tools:
+    cmake_args.append('-DCHROMIUM_TOOLS=%s' % ';'.join(args.tools))
+
   RunCommand(GetVSVersion().SetupScript('x64') +
-             ['&&', 'cmake', '-GNinja', '-DCMAKE_BUILD_TYPE=Release',
-              '-DLLVM_ENABLE_ASSERTIONS=ON', SubversionCmakeArg(), LLVM_DIR])
+             ['&&', 'cmake'] + cmake_args + [LLVM_DIR])
   RunCommand(GetVSVersion().SetupScript('x64') + ['&&', 'ninja', 'all'])
 
   # Do an x86 build of compiler-rt to get the 32-bit ASan run-time.
   # TODO(hans): Remove once the regular build above produces this.
   if not os.path.exists(COMPILER_RT_BUILD_DIR):
     os.makedirs(COMPILER_RT_BUILD_DIR)
   os.chdir(COMPILER_RT_BUILD_DIR)
   RunCommand(GetVSVersion().SetupScript('x86') +
-             ['&&', 'cmake', '-GNinja', '-DCMAKE_BUILD_TYPE=Release',
-              '-DLLVM_ENABLE_ASSERTIONS=ON', LLVM_DIR])
+             ['&&', 'cmake'] + cmake_args + [LLVM_DIR])
   RunCommand(GetVSVersion().SetupScript('x86') + ['&&', 'ninja', 'compiler-rt'])
 
   # TODO(hans): Make this (and the .gypi and .isolate files) version number
   # independent.
   asan_rt_lib_src_dir = os.path.join(COMPILER_RT_BUILD_DIR, 'lib', 'clang',
                                      VERSION, 'lib', 'windows')
   asan_rt_lib_dst_dir = os.path.join(LLVM_BUILD_DIR, 'lib', 'clang',
                                      VERSION, 'lib', 'windows')
   CopyDirectoryContents(asan_rt_lib_src_dir, asan_rt_lib_dst_dir,
                         r'^.*-i386\.lib$')
@@ skipping 41 matching lines @@
         stderr=os.fdopen(os.dup(sys.stdin.fileno())))
 
   if not re.search(r'\b(clang|asan)=1', os.environ.get('GYP_DEFINES', '')):
     print 'Skipping Clang update (clang=1 was not set in GYP_DEFINES).'
     return 0
 
   if re.search(r'\b(make_clang_dir)=', os.environ.get('GYP_DEFINES', '')):
     print 'Skipping Clang update (make_clang_dir= was set in GYP_DEFINES).'
     return 0
 
-  return UpdateClang()
+  parser = argparse.ArgumentParser(description='Build Clang.')
+  parser.add_argument('--no-clobber', dest='clobber', action='store_false')

[dcheng, 2015/04/06 23:09:10]

I added this argument, because it makes tool testing a bit difficult otherwise
(since it constantly blows away the compile DB / intermediate build artifacts
that source files might depend on). I think in this mode, it'd be nice to
suppress updating the LLVM repo too, but I'm not sure what a good name for that
flag is... or if I should just add a separate flag for that.

+  parser.add_argument('--tools', nargs='*')
+  return UpdateClang(parser.parse_args())
 
 
 if __name__ == '__main__':
   sys.exit(main())