Automatically copy the DIA DLL in the Syzygy binaries directory.

build/get_syzygy_binaries.py

 #!/usr/bin/env python
 # Copyright 2014 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.
 
 """A utility script for downloading versioned Syzygy binaries."""
 
 import hashlib
 import errno
+import fnmatch
 import json
 import logging
 import optparse
 import os
 import re
 import shutil
 import stat
 import sys
 import subprocess
 import tempfile
@@ skipping 21 matching lines @@
 # List of reources to be downloaded and installed. These are tuples with the
 # following format:
 # (basename, logging name, relative installation path, extraction filter)
 _RESOURCES = [
   ('benchmark.zip', 'benchmark', '', None),
   ('binaries.zip', 'binaries', 'exe', None),
   ('symbols.zip', 'symbols', 'exe',
       lambda x: x.filename.endswith('.dll.pdb'))]
 
 
+# Name of the MS DIA dll that we need to copy to the binaries directory.
+_DIA_DLL_NAME = "msdia140.dll"
+
+
 def _LoadState(output_dir):
   """Loads the contents of the state file for a given |output_dir|, returning
   None if it doesn't exist.
   """
   path = os.path.join(output_dir, _STATE)
   if not os.path.exists(path):
     _LOGGER.debug('No state file found.')
     return None
   with open(path, 'rb') as f:
     _LOGGER.debug('Reading state file: %s', path)
@@ skipping 214 matching lines @@
 
 def _Download(resource):
   """Downloads the given GS resource to a temporary file, returning its path."""
   tmp = tempfile.mkstemp(suffix='syzygy_archive')
   os.close(tmp[0])
   url = 'gs://syzygy-archive' + resource
   _GsUtil('cp', url, tmp[1])
   return tmp[1]
 
 
+def _MaybeCopyDIABinaries(options, contents):

[scottmg, 2016/10/03 21:47:03]

I guess it shouldn't be called "Maybe..." any more either as it either succeeds
at copying or raises.

(If you do that, I'd probably make the _LOGGER.debug with early return be raise
too if that doesn't break something.)

[Sébastien Marchand, 2016/10/03 21:57:08]

Ha good point, initially this function was only a 'best effort' thing (i.e. copy
the dll if it's there, skip it otherwise), but I can't think of any reason why
it might be missing.

+  """Try to copy the DIA DLL to the binaries exe directory.
+
+  This doesn't check if the toolchain version of this DLL is the same as the
+  one used by the Syzygy binaries, so this will only be useful if Chrome and
+  Syzygy are using the same revision of the toolchain.
+  """
+  toolchain_data_file = os.path.join(os.path.dirname(__file__),
+                                     'win_toolchain.json')
+  if not os.path.exists(toolchain_data_file):
+    _LOGGER.debug('Toolchain JSON data file doesn\'t exist.')
+    return
+  _LOGGER.debug('%s exists' % toolchain_data_file)
+  with open(toolchain_data_file) as temp_f:
+    toolchain_data = json.load(temp_f)
+  if not os.path.isdir(toolchain_data['path']):
+    _LOGGER.error('The toolchain JSON file is invalid.')
+    return
+  dia_sdk_binaries_dir = os.path.join(toolchain_data['path'], 'DIA SDK', 'bin')
+  dia_dll = os.path.join(dia_sdk_binaries_dir, _DIA_DLL_NAME)
+  if not os.path.exists(dia_dll):
+    raise Exception('%s is missing.')
+  dia_dll_dest = os.path.join(options.output_dir, 'exe', _DIA_DLL_NAME)
+  _LOGGER.debug('Copying %s to %s.' % (dia_dll, dia_dll_dest))
+  if not options.dry_run:
+    shutil.copy(dia_dll, dia_dll_dest)
+    contents[os.path.relpath(dia_dll_dest, options.output_dir)] = (
+        _Md5(dia_dll_dest))
+
+
 def _InstallBinaries(options, deleted={}):
   """Installs Syzygy binaries. This assumes that the output directory has
   already been cleaned, as it will refuse to overwrite existing files."""
   contents = {}
   state = { 'revision': options.revision, 'contents': contents }
   archive_path = _SYZYGY_ARCHIVE_PATH % { 'revision': options.revision }
   if options.resources:
     resources = [(resource, resource, '', None)
                  for resource in options.resources]
   else:
@@ skipping 34 matching lines @@
           if not options.dry_run:
             archive.extract(entry.filename, fulldir)
             md5 = _Md5(fullpath)
             contents[relpath] = md5
             if sys.platform == 'cygwin':
               os.chmod(fullpath, os.stat(fullpath).st_mode | stat.S_IXUSR)
 
     _LOGGER.debug('Removing temporary file "%s".', path)
     os.remove(path)
 
+  if options.copy_dia_binaries:
+    # Try to copy the DIA binaries to the binaries directory.
+    _MaybeCopyDIABinaries(options, contents)
+
   return state
 
 
 def _ParseCommandLine():
   """Parses the command-line and returns an options structure."""
   option_parser = optparse.OptionParser()
   option_parser.add_option('--dry-run', action='store_true', default=False,
       help='If true then will simply list actions that would be performed.')
   option_parser.add_option('--force', action='store_true', default=False,
       help='Force an installation even if the binaries are up to date.')
@@ skipping 11 matching lines @@
   option_parser.add_option('--revision-file', type='string',
       help='A text file containing an SVN revision or GIT hash.')
   option_parser.add_option('--resource', type='string', action='append',
       dest='resources', help='A resource to be downloaded.')
   option_parser.add_option('--verbose', dest='log_level', action='store_const',
       default=logging.INFO, const=logging.DEBUG,
       help='Enables verbose logging.')
   option_parser.add_option('--quiet', dest='log_level', action='store_const',
       default=logging.INFO, const=logging.ERROR,
       help='Disables all output except for errors.')
+  option_parser.add_option('--copy-dia-binaries', action='store_true',
+      default=False, help='If true then the DIA dll will get copied into the '
+                          'binaries directory if it\'s available.')
   options, args = option_parser.parse_args()
   if args:
     option_parser.error('Unexpected arguments: %s' % args)
   if not options.output_dir:
     option_parser.error('Must specify --output-dir.')
   if not options.revision and not options.revision_file:
     option_parser.error('Must specify one of --revision or --revision-file.')
   if options.revision and options.revision_file:
     option_parser.error('Must not specify both --revision and --revision-file.')
 
@@ skipping 98 matching lines @@
   # Install the new binaries. In a dry-run this will actually download the
   # archives, but it won't write anything to disk.
   state = _InstallBinaries(options, deleted)
 
   # Build and save the state for the directory.
   _SaveState(options.output_dir, state, options.dry_run)
 
 
 if __name__ == '__main__':
   main()