Merge pull request #30963 from benlangmuir/isdb-san

[build-script] Add sanitizer support to indexstore-db product

Author: benlangmuir

utils/build-presets.ini

@@ -1728,20 +1728,36 @@ sourcekit-lsp
 # Test IndexStore-DB
 #===------------------------------------------------------------------------===#
 
-[preset: buildbot_indexstoredb_macos]
+[preset: buildbot_indexstoredb_macos,no_sanitize]
 mixin-preset=mixin_swiftpm_package_macos_platform
 release
 assertions
 indexstore-db
 sourcekit-lsp
 
-[preset: buildbot_indexstoredb_linux]
+[preset: buildbot_indexstoredb_linux,no_sanitize]
 mixin-preset=mixin_swiftpm_package_linux_platform
 release
 assertions
 indexstore-db
 sourcekit-lsp
 
+[preset: buildbot_indexstoredb_macos,sanitize]
+mixin-preset=buildbot_indexstoredb_macos,no_sanitize
+test-indexstore-db-sanitize-all
+
+[preset: buildbot_indexstoredb_linux,sanitize]
+mixin-preset=buildbot_indexstoredb_linux,no_sanitize
+test-indexstore-db-sanitize-all
+
+# Default: sanitize-all
+[preset: buildbot_indexstoredb_macos]
+mixin-preset=buildbot_indexstoredb_macos,sanitize
+
+# Default: sanitize-all
+[preset: buildbot_indexstoredb_linux]
+mixin-preset=buildbot_indexstoredb_linux,sanitize
+
 #===------------------------------------------------------------------------===#
 # Test Swift Corelibs XCTest
 #===------------------------------------------------------------------------===#

utils/build_swift/build_swift/driver_arguments.py

@@ -567,6 +567,9 @@ def create_argument_parser():
 
     option(['--indexstore-db'], toggle_true('build_indexstoredb'),
            help='build IndexStoreDB')
+    option('--test-indexstore-db-sanitize-all',
+           toggle_true('test_indexstoredb_sanitize_all'),
+           help='run indexstore-db tests under all sanitizers')
     option(['--sourcekit-lsp'], toggle_true('build_sourcekitlsp'),
            help='build SourceKitLSP')
     option('--install-swiftsyntax', toggle_true('install_swiftsyntax'),

utils/build_swift/tests/expected_options.py

@@ -91,6 +91,7 @@
     'build_skstresstester': False,
     'build_swiftevolve': False,
     'build_indexstoredb': False,
+    'test_indexstoredb_sanitize_all': False,
     'build_sourcekitlsp': False,
     'install_swiftpm': False,
     'install_swiftsyntax': False,
@@ -503,6 +504,8 @@ class BuildScriptImplOption(_BaseOption):
     EnableOption('--libdispatch', dest='build_libdispatch'),
     EnableOption('--libicu', dest='build_libicu'),
     EnableOption('--indexstore-db', dest='build_indexstoredb'),
+    EnableOption('--test-indexstore-db-sanitize-all',
+                 dest='test_indexstoredb_sanitize_all'),
     EnableOption('--sourcekit-lsp', dest='build_sourcekitlsp'),
     EnableOption('--install-swiftsyntax', dest='install_swiftsyntax'),
     EnableOption('--swiftsyntax-verify-generated-files',

utils/swift_build_support/swift_build_support/products/indexstoredb.py

@@ -36,7 +36,8 @@ def should_test(self, host_target):
         return self.args.test_indexstoredb
 
     def test(self, host_target):
-        run_build_script_helper('test', host_target, self, self.args)
+        run_build_script_helper('test', host_target, self, self.args,
+                                self.args.test_indexstoredb_sanitize_all)
 
     def should_install(self, host_target):
         return False
@@ -45,13 +46,13 @@ def install(self, host_target):
         pass
 
 
-def run_build_script_helper(action, host_target, product, args):
+def run_build_script_helper(action, host_target, product, args,
+                            sanitize_all=False):
     script_path = os.path.join(
         product.source_dir, 'Utilities', 'build-script-helper.py')
 
     toolchain_path = targets.toolchain_path(args.install_destdir,
                                             args.install_prefix)
-
     is_release = product.is_release()
     configuration = 'release' if is_release else 'debug'
     helper_cmd = [
@@ -66,4 +67,13 @@ def run_build_script_helper(action, host_target, product, args):
     if args.verbose_build:
         helper_cmd.append('--verbose')
 
+    if sanitize_all:
+        helper_cmd.append('--sanitize-all')
+    elif args.enable_asan:
+        helper_cmd.extend(['--sanitize', 'address'])
+    elif args.enable_ubsan:
+        helper_cmd.extend(['--sanitize', 'undefined'])
+    elif args.enable_tsan:
+        helper_cmd.extend(['--sanitize', 'thread'])
+
     shell.call(helper_cmd)