Automatically copy the DIA DLL in the Syzygy binaries directory.

build/get_syzygy_binaries.py

Index: build/get_syzygy_binaries.py
diff --git a/build/get_syzygy_binaries.py b/build/get_syzygy_binaries.py
index 1cab3fcf48dfd21f8c54e6492101f9d5df2e6300..e5fec5996b81f94add22d62e171403d4f9317076 100755
--- a/build/get_syzygy_binaries.py
+++ b/build/get_syzygy_binaries.py
@@ -7,6 +7,7 @@
 
 import hashlib
 import errno
+import fnmatch
 import json
 import logging
 import optparse
@@ -48,6 +49,10 @@ _RESOURCES = [
       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.
@@ -282,6 +287,36 @@ def _Download(resource):
   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."""
@@ -336,6 +371,10 @@ def _InstallBinaries(options, deleted={}):
     _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
 
 
@@ -367,6 +406,9 @@ def _ParseCommandLine():
   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)