[build-script] Provide infrastructure for CMakeProduct subclasses to opt into using the just built swift toolchain.

Author: gottesmm

utils/swift_build_support/swift_build_support/cmake.py

@@ -90,11 +90,15 @@ def __iadd__(self, other):
 
 class CMake(object):
 
-    def __init__(self, args, toolchain):
+    def __init__(self, args, toolchain, prefer_just_built_toolchain=False):
+        """If prefer_just_built_toolchain is set to True, we set the clang, clang++,
+        and Swift compilers from the installed toolchain.
+        """
         self.args = args
         self.toolchain = toolchain
+        self.prefer_just_built_toolchain = prefer_just_built_toolchain
 
-    def common_options(self):
+    def common_options(self, product=None):
         """Return options used for all products, including LLVM/Clang
         """
         args = self.args
@@ -135,8 +139,18 @@ def common_options(self):
         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)
+        if self.prefer_just_built_toolchain and product:
+            toolchain_path = product.install_toolchain_path(args.host_target)
+            define("CMAKE_C_COMPILER:PATH", os.path.join(toolchain_path,
+                                                         'bin', 'clang'))
+            define("CMAKE_CXX_COMPILER:PATH", os.path.join(toolchain_path,
+                                                           'bin', 'clang++'))
+            define("CMAKE_Swift_COMPILER:PATH", os.path.join(toolchain_path,
+                                                             'bin', 'swiftc'))
+        else:
+            define("CMAKE_C_COMPILER:PATH", toolchain.cc)
+            define("CMAKE_CXX_COMPILER:PATH", toolchain.cxx)
+            define("CMAKE_Swift_COMPILER:PATH", toolchain.swiftc)
         define("CMAKE_LIBTOOL:PATH", toolchain.libtool)
         define("CMAKE_AR:PATH", toolchain.ar)
 

utils/swift_build_support/swift_build_support/products/cmake_product.py

@@ -18,10 +18,12 @@
 
 
 class CMakeProduct(product.Product):
-    def build_with_cmake(self, build_targets, build_type, build_args):
+    def build_with_cmake(self, build_targets, build_type, build_args,
+                         prefer_just_built_toolchain=False):
         assert self.toolchain.cmake is not None
         cmake_build = []
-        _cmake = cmake.CMake(self.args, self.toolchain)
+        _cmake = cmake.CMake(self.args, self.toolchain,
+                             prefer_just_built_toolchain)
 
         if self.toolchain.distcc_pump:
             cmake_build.append(self.toolchain.distcc_pump)
@@ -52,7 +54,7 @@ def build_with_cmake(self, build_targets, build_type, build_args):
 
             with shell.pushd(self.build_dir):
                 shell.call([self.toolchain.cmake] + list(self.cmake_options) +
-                           list(_cmake.common_options()) +
+                           list(_cmake.common_options(self)) +
                            self.args.extra_cmake_options + [self.source_dir],
                            env=env)
 

utils/swift_build_support/tests/test_cmake.py

@@ -47,6 +47,7 @@ def default_args(self):
         """
         return Namespace(host_cc="/path/to/clang",
                          host_cxx="/path/to/clang++",
+                         host_swiftc="/path/to/swiftc",
                          host_libtool="/path/to/libtool",
                          host_ar="/path/to/ar",
                          enable_asan=False,
@@ -81,6 +82,7 @@ def cmake(self, args):
         toolchain = host_toolchain()
         toolchain.cc = args.host_cc
         toolchain.cxx = args.host_cxx
+        toolchain.swiftc = args.host_swiftc
         toolchain.libtool = args.host_libtool
         toolchain.ar = args.host_ar
         if args.distcc:
@@ -98,6 +100,7 @@ def test_common_options_defaults(self):
             ["-G", "Ninja",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -112,6 +115,7 @@ def test_common_options_asan(self):
              "-DLLVM_USE_SANITIZER=Address",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -126,6 +130,7 @@ def test_common_options_ubsan(self):
              "-DLLVM_USE_SANITIZER=Undefined",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -140,6 +145,7 @@ def test_common_options_tsan(self):
              "-DLLVM_USE_SANITIZER=Thread",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -155,6 +161,7 @@ def test_common_options_asan_ubsan(self):
              "-DLLVM_USE_SANITIZER=Address;Undefined",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -170,6 +177,7 @@ def test_common_options_ubsan_tsan(self):
              "-DLLVM_USE_SANITIZER=Undefined;Thread",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -186,6 +194,7 @@ def test_common_options_asan_ubsan_tsan(self):
              "-DLLVM_USE_SANITIZER=Address;Undefined;Thread",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -200,6 +209,7 @@ def test_common_options_lsan(self):
              "-DLLVM_USE_SANITIZER=Leaks",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -214,6 +224,7 @@ def test_common_options_coverage_sanitizer(self):
              "-DLLVM_USE_SANITIZE_COVERAGE=ON",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -228,6 +239,7 @@ def test_common_options_export_compile_commands(self):
              "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -243,6 +255,7 @@ def test_common_options_distcc(self):
              "-DCMAKE_CXX_COMPILER_LAUNCHER:PATH=" + self.mock_distcc_path(),
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -258,6 +271,7 @@ def test_common_options_sccache(self):
              "-DCMAKE_CXX_COMPILER_LAUNCHER:PATH=" + self.mock_sccache_path(),
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -276,6 +290,7 @@ def test_common_options_launcher(self):
              "-DCMAKE_CXX_COMPILER_LAUNCHER:PATH=" + cmake_cxx_launcher,
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -289,6 +304,7 @@ def test_common_options_xcode(self):
             ["-G", "Xcode",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_CONFIGURATION_TYPES=" +
@@ -303,6 +319,7 @@ def test_common_options_clang_compiler_version(self):
             ["-G", "Ninja",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -316,6 +333,7 @@ def test_common_options_clang_user_visible_version(self):
             ["-G", "Ninja",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DLLVM_VERSION_MAJOR:STRING=9",
@@ -335,6 +353,7 @@ def test_common_options_build_ninja(self):
             ["-G", "Ninja",
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_MAKE_PROGRAM=" + self.which_ninja(args)])
@@ -359,6 +378,7 @@ def test_common_options_full(self):
              "-DCMAKE_CXX_COMPILER_LAUNCHER:PATH=" + self.mock_distcc_path(),
              "-DCMAKE_C_COMPILER:PATH=/path/to/clang",
              "-DCMAKE_CXX_COMPILER:PATH=/path/to/clang++",
+             "-DCMAKE_Swift_COMPILER:PATH=/path/to/swiftc",
              "-DCMAKE_LIBTOOL:PATH=/path/to/libtool",
              "-DCMAKE_AR:PATH=/path/to/ar",
              "-DCMAKE_CONFIGURATION_TYPES=" +