Merge pull request swiftlang#263 from benlangmuir/sanitize

[build-script] Add sanitizer flags

Author: benlangmuir

Utilities/build-script-helper.py

@@ -30,6 +30,10 @@ def get_swiftpm_options(args):
   if args.verbose:
     swiftpm_args += ['--verbose']
 
+  if args.sanitize:
+    for san in args.sanitize:
+      swiftpm_args += ['--sanitize=%s' % san]
+
   if platform.system() == 'Darwin':
     swiftpm_args += [
       # Relative library rpath for swift; will only be used when /usr/lib/swift
@@ -81,6 +85,44 @@ def delete_rpath(rpath, binary):
   print(' '.join(cmd))
   subprocess.check_call(cmd)
 
+
+def handle_invocation(swift_exec, args):
+  swiftpm_args = get_swiftpm_options(args)
+
+  env = os.environ
+  # Set the toolchain used in tests at runtime
+  env['SOURCEKIT_TOOLCHAIN_PATH'] = args.toolchain
+  # Use local dependencies (i.e. checked out next sourcekit-lsp).
+  if not args.no_local_deps:
+    env['SWIFTCI_USE_LOCAL_DEPS'] = "1"
+
+  if args.ninja_bin:
+    env['NINJA_BIN'] = args.ninja_bin
+
+  if args.sanitize and 'address' in args.sanitize:
+    # Workaround reports in Foundation: https://bugs.swift.org/browse/SR-12551
+    env['ASAN_OPTIONS'] = 'detect_leaks=false'
+  if args.sanitize and 'undefined' in args.sanitize:
+    supp = os.path.join(args.package_path, 'Utilities', 'ubsan_supressions.supp')
+    env['UBSAN_OPTIONS'] = 'halt_on_error=true,suppressions=%s' % supp
+
+
+  if args.action == 'build':
+    swiftpm('build', swift_exec, swiftpm_args, env)
+  elif args.action == 'test':
+    bin_path = swiftpm_bin_path(swift_exec, swiftpm_args, env)
+    tests = os.path.join(bin_path, 'sk-tests')
+    print('Cleaning ' + tests)
+    shutil.rmtree(tests, ignore_errors=True)
+    swiftpm('test', swift_exec, swiftpm_args + ['--parallel'], env)
+  elif args.action == 'install':
+    bin_path = swiftpm_bin_path(swift_exec, swiftpm_args, env)
+    swiftpm('build', swift_exec, swiftpm_args, env)
+    install(bin_path, args.toolchain)
+  else:
+    assert False, 'unknown action \'{}\''.format(args.action)
+
+
 def main():
   parser = argparse.ArgumentParser(description='Build along with the Swift build-script.')
   def add_common_args(parser):
@@ -90,6 +132,8 @@ def add_common_args(parser):
     parser.add_argument('--build-path', metavar='PATH', default='.build', help='build in the given path')
     parser.add_argument('--configuration', '-c', default='debug', help='build using configuration (release|debug)')
     parser.add_argument('--no-local-deps', action='store_true', help='use normal remote dependencies when building')
+    parser.add_argument('--sanitize', action='append', help='build using the given sanitizer(s) (address|thread|undefined)')
+    parser.add_argument('--sanitize-all', action='store_true', help='build using every available sanitizer in sub-directories of build path')
     parser.add_argument('--verbose', '-v', action='store_true', help='enable verbose output')
 
   subparsers = parser.add_subparsers(title='subcommands', dest='action', metavar='action')
@@ -104,6 +148,9 @@ def add_common_args(parser):
 
   args = parser.parse_args(sys.argv[1:])
 
+  if args.sanitize and args.sanitize_all:
+    assert False, 'cannot combine --sanitize with --sanitize-all'
+
   # Canonicalize paths
   args.package_path = os.path.abspath(args.package_path)
   args.build_path = os.path.abspath(args.build_path)
@@ -114,32 +161,27 @@ def add_common_args(parser):
   else:
     swift_exec = 'swift'
 
-  swiftpm_args = get_swiftpm_options(args)
+  handle_invocation(swift_exec, args)
+  if args.sanitize_all:
+    base = args.build_path
 
-  env = os.environ
-  # Set the toolchain used in tests at runtime
-  env['SOURCEKIT_TOOLCHAIN_PATH'] = args.toolchain
-  # Use local dependencies (i.e. checked out next sourcekit-lsp).
-  if not args.no_local_deps:
-    env['SWIFTCI_USE_LOCAL_DEPS'] = "1"
+    print('=== %s sourcekit-lsp with asan ===' % args.action)
+    args.sanitize = ['address']
+    args.build_path = os.path.join(base, 'test-asan')
+    handle_invocation(swift_exec, args)
 
-  if args.ninja_bin:
-    env['NINJA_BIN'] = args.ninja_bin
+    print('=== %s sourcekit-lsp with tsan ===' % args.action)
+    args.sanitize = ['thread']
+    args.build_path = os.path.join(base, 'test-tsan')
+    handle_invocation(swift_exec, args)
+
+    # Linux ubsan disabled: https://bugs.swift.org/browse/SR-12550
+    if platform.system() != 'Linux':
+      print('=== %s sourcekit-lsp with ubsan ===' % args.action)
+      args.sanitize = ['undefined']
+      args.build_path = os.path.join(base, 'test-ubsan')
+      handle_invocation(swift_exec, args)
 
-  if args.action == 'build':
-    swiftpm('build', swift_exec, swiftpm_args, env)
-  elif args.action == 'test':
-    bin_path = swiftpm_bin_path(swift_exec, swiftpm_args, env)
-    tests = os.path.join(bin_path, 'sk-tests')
-    print('Cleaning ' + tests)
-    shutil.rmtree(tests, ignore_errors=True)
-    swiftpm('test', swift_exec, swiftpm_args + ['--parallel'], env)
-  elif args.action == 'install':
-    bin_path = swiftpm_bin_path(swift_exec, swiftpm_args, env)
-    swiftpm('build', swift_exec, swiftpm_args, env)
-    install(bin_path, args.toolchain)
-  else:
-    assert False, 'unknown action \'{}\''.format(args.action)
 
 if __name__ == '__main__':
   main()

Utilities/ubsan_supressions.supp

@@ -0,0 +1 @@
+alignment:mdb.c