Merge pull request swiftlang#22919 from apple/add-compiler-launcher

Add cmake-c-launcher and cmake-cxx-launcher flag to build-script

Author: shahmishal

utils/build-script

@@ -1036,6 +1036,14 @@ def main_preset():
         "--distcc",
         help="use distcc",
         action=arguments.action.optional_bool)
+    parser.add_argument(
+        "--cmake-c-launcher",
+        help="the absolute path to set CMAKE_C_COMPILER_LAUNCHER",
+        metavar="PATH")
+    parser.add_argument(
+        "--cmake-cxx-launcher",
+        help="the absolute path to set CMAKE_CXX_COMPILER_LAUNCHER",
+        metavar="PATH")
     parser.add_argument(
         "-j", "--jobs",
         help="the number of parallel build jobs to use",
@@ -1098,6 +1106,11 @@ def main_preset():
 
     preset_args = migrate_swift_sdks(preset.format_args())
 
+    if args.distcc and (args.cmake_c_launcher or args.cmake_cxx_launcher):
+        diagnostics.fatal(
+            '--distcc can not be used with' +
+            ' --cmake-c-launcher or --cmake-cxx-launcher')
+
     build_script_args = [sys.argv[0]]
     if args.dry_run:
         build_script_args += ["--dry-run"]
@@ -1113,6 +1126,10 @@ def main_preset():
                               args.swiftsyntax_install_prefix]
     if args.build_dir:
         build_script_args += ["--build-dir", args.build_dir]
+    if args.cmake_c_launcher:
+        build_script_args += ["--cmake-c-launcher", args.cmake_c_launcher]
+    if args.cmake_cxx_launcher:
+        build_script_args += ["--cmake-cxx-launcher", args.cmake_cxx_launcher]
 
     diagnostics.note('using preset "{}", which expands to \n\n{}\n'.format(
         args.preset, shell.quote_command(build_script_args)))

utils/build_swift/driver_arguments.py

@@ -357,6 +357,10 @@ def create_argument_parser():
     option('--host-cxx', store_path(executable=True),
            help='the absolute path to CXX, the "clang++" compiler for the '
                 'host platform. Default is auto detected.')
+    option('--cmake-c-launcher', store_path(executable=True),
+           help='the absolute path to set CMAKE_C_COMPILER_LAUNCHER')
+    option('--cmake-cxx-launcher', store_path(executable=True),
+           help='the absolute path to set CMAKE_CXX_COMPILER_LAUNCHER')
     option('--host-lipo', store_path(executable=True),
            help='the absolute path to lipo. Default is auto detected.')
     option('--host-libtool', store_path(executable=True),

utils/build_swift/tests/expected_options.py

@@ -96,6 +96,8 @@
     'build_watchos_device': False,
     'build_watchos_simulator': False,
     'build_xctest': False,
+    'cmake_c_launcher': None,
+    'cmake_cxx_launcher': None,
     'clang_compiler_version': None,
     'clang_profile_instr_use': None,
     'clang_user_visible_version': defaults.CLANG_USER_VISIBLE_VERSION,
@@ -537,6 +539,8 @@ class IgnoreOption(_BaseOption):
     PathOption('--install-symroot'),
     PathOption('--install-destdir'),
     PathOption('--symbols-package'),
+    PathOption('--cmake-c-launcher'),
+    PathOption('--cmake-cxx-launcher'),
 
     IntOption('--benchmark-num-o-iterations'),
     IntOption('--benchmark-num-onone-iterations'),

utils/swift_build_support/swift_build_support/cmake.py

@@ -107,6 +107,11 @@ def common_options(self):
             define("CMAKE_C_COMPILER_LAUNCHER:PATH", toolchain.distcc)
             define("CMAKE_CXX_COMPILER_LAUNCHER:PATH", toolchain.distcc)
 
+        if args.cmake_c_launcher:
+            define("CMAKE_C_COMPILER_LAUNCHER:PATH", args.cmake_c_launcher)
+        if args.cmake_cxx_launcher:
+            define("CMAKE_CXX_COMPILER_LAUNCHER:PATH", args.cmake_cxx_launcher)
+
         define("CMAKE_C_COMPILER:PATH", toolchain.cc)
         define("CMAKE_CXX_COMPILER:PATH", toolchain.cxx)
         define("CMAKE_LIBTOOL:PATH", toolchain.libtool)

utils/swift_build_support/tests/test_cmake.py

@@ -39,6 +39,8 @@ def default_args(self):
                          export_compile_commands=False,
                          distcc=False,
                          cmake_generator="Ninja",
+                         cmake_c_launcher=None,
+                         cmake_cxx_launcher=None,
                          clang_compiler_version=None,
                          clang_user_visible_version=None,
                          build_jobs=8,
@@ -212,6 +214,23 @@ def test_common_options_distcc(self):
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
 
+    def test_common_options_launcher(self):
+        args = self.default_args()
+        cmake_c_launcher = "/path/to/c_launcher"
+        cmake_cxx_launcher = "/path/to/cxx_launcher"
+        args.cmake_c_launcher = cmake_c_launcher
+        args.cmake_cxx_launcher = cmake_cxx_launcher
+        cmake = self.cmake(args)
+        self.assertEqual(
+            list(cmake.common_options()),
+            ["-G", "Ninja",
+             "-DCMAKE_C_COMPILER_LAUNCHER:PATH=" + cmake_c_launcher,
+             "-DCMAKE_CXX_COMPILER_LAUNCHER:PATH=" + cmake_cxx_launcher,
+             "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
+             "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
+             "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
+
     def test_common_options_xcode(self):
         args = self.default_args()
         args.cmake_generator = 'Xcode'