Python script to compile and link the integration tests using llvm's clang-cl

syzygy/integration_tests/make_integration_tests_clang.py

 #!/usr/bin/env python
 # Copyright 2017 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.
 
 import optparse
 import os
 import re
 import subprocess
 import sys
 
+def compile(clang_path, source_files, src_dir):

[Sébastien Marchand, 2017/06/21 19:51:37]

Add a comment to describe what this function do.

[njanevsk, 2017/06/22 18:43:49]

Done.

+  compiler_flags = [
+    '-c',

[Sébastien Marchand, 2017/06/21 19:51:36]

Fix the indentation.

[njanevsk, 2017/06/22 18:43:49]

Done.

+        '-fsanitize=address',
+        '-mllvm',
+        '-asan-instrumentation-with-call-threshold=0',
+        '-mllvm',
+        '-asan-stack=0',
+        '-DUNICODE',
+        '-D_UNICODE',
+        '-DNOMINMAX',
+        '-D_CRT_SECURE_NO_WARNINGS',
+        '-I' + src_dir

[Sébastien Marchand, 2017/06/21 19:51:36]

s/+/,/ and move src_dir to the next line.

[njanevsk, 2017/06/22 18:43:49]

Why? Cause this is a single flag. include the src directory when searching for
headers.

[Sébastien Marchand, 2017/06/22 19:34:16]

Yes but this will also work with a comma, and here you're technically creating a
temporary string, so this is less efficient than doing "'I', src_dir,"

+  ]
+  compile_command = [clang_path]
+  compile_command.extend(compiler_flags)
+  compile_command.extend(source_files)
+  
+  ret = subprocess.call(compile_command)
+  if ret != 0:
+        print "Failed compiling the integration_tests using clang-cl"

[Sébastien Marchand, 2017/06/21 19:51:37]

This isn't indented properly.

[njanevsk, 2017/06/22 18:43:49]

Done.

+
+def link(clang_path, source_files, build_dir):
+  object_files = [os.path.splitext(filename)[0] + ".o" for filename in source_files]

[njanevsk, 2017/06/22 18:43:49]

Done.

+
+  compiler_controlled_linker_flags = [
+        '-o',
+        build_dir + '\integration_tests_dll.dll'

[Sébastien Marchand, 2017/06/21 19:51:36]

Fix indentation, look at the other Python script for reference.

[njanevsk, 2017/06/22 18:43:49]

Done.

+  ]
+  
+  linker_flags = [
+        '/link',
+        '/dll',
+        build_dir + '\export_dll.dll.lib',
+        build_dir + '\syzyasan_rtl.dll.lib',
+        '-defaultlib:libcmt'
+  ]
+  
+  linker_command = [clang_path]
+  linker_command.extend(['-m32'])

[Sébastien Marchand, 2017/06/21 19:51:36]

linker_command = [
  clang_path,
  '-m32',
]

[njanevsk, 2017/06/22 18:43:48]

Done.

+  linker_command.extend(object_files)
+  linker_command.extend(compiler_controlled_linker_flags)
+  linker_command.extend(linker_flags)
+  ret = subprocess.call(linker_command)
+  
+  if ret != 0:
+        print "Failed to link the integration_tests using clang-cl"

[Sébastien Marchand, 2017/06/21 19:51:36]

Fix indent.

[njanevsk, 2017/06/22 18:43:49]

Done.

 
 def main():
   parser = optparse.OptionParser(usage='%prog [options]')
   parser.add_option('--src-dir',
     help='The src directory where the syzygy repository is located.')
   parser.add_option('--build-dir', help='Syzygy build directory.')
   parser.add_option('--input-files', help='files to be compiled and linked')
   
   options, _ = parser.parse_args()
   
   if not options.src_dir:
     parser.error('--src-dir is required')
   if not options.build_dir:
     parser.error('--build-dir is required')
   if not options.input_files:
     parser.error('--input-files is required')
 
-  clang_path = options.src_dir + "/third_party/llvm-build/Release+Asserts/bin/clang-cl.exe"
-  compiler_flags = '-c -fsanitize=address -mllvm -asan-instrumentation-with-call-threshold=0 -mllvm -asan-stack=0 -DUNICODE -D_UNICODE -DNOMINMAX -D_CRT_SECURE_NO_WARNINGS -I' + options.src_dir
+  clang_path = options.src_dir + \

[Sébastien Marchand, 2017/06/21 19:51:37]

Use parenthesis instead of \, better than that, move this to a constant as
suggested in the previous round of comments.

[njanevsk, 2017/06/22 18:43:49]

Done.

+    "/third_party/llvm-build/Release+Asserts/bin/clang-cl.exe"
   
-  print os.path.dirname(os.path.realpath(__file__))
   source_files = re.findall(r'\b(\w+.cc)\b', options.input_files)
-  print subprocess.check_output('"' + clang_path + '" ' + compiler_flags + ' ' + ' '.join(source_files), shell = True)  
-  object_files = [filename[:-3] + ".o" for filename in source_files]
-
-  print subprocess.check_output('"' + clang_path + '" ' + '-m32' + ' ' + ' '.join(object_files) + ' -o' + ' ' + options.build_dir + '\integration_tests_dll.dll' + ' /link /dll ' + options.build_dir + '\export_dll.dll.lib ' + options.build_dir + '\syzyasan_rtl.dll.lib' + ' -defaultlib:libcmt', shell = True) 
+  compile(clang_path, source_files, options.src_dir)

[Sébastien Marchand, 2017/06/21 19:51:36]

Check the return value, don't try to link if the compile step failed.

[njanevsk, 2017/06/22 18:43:49]

Done.

+  link(clang_path, source_files, options.build_dir)

[Sébastien Marchand, 2017/06/21 19:51:36]

Ditto.

[njanevsk, 2017/06/22 18:43:49]

There is no need to check the return value here. Instead, I do this step only if
it compiled successfully. Otherwise I print an error message.

[Sébastien Marchand, 2017/06/22 19:34:16]

We still want the script to return something != 0 on error.

 
 if __name__ == '__main__':
   sys.exit(main())