Merge pull request #38719 from gottesmm/build-script-bootstrap-stage2-init

gottesmm · web-flow · commit a7884619a90d · 2021-08-04T19:09:41.000-07:00
[build-script] Begin putting in infrastructure for the multi-compiler stage swift build
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -250,6 +250,10 @@ option(SWIFT_BUILD_RUNTIME_WITH_HOST_COMPILER
        "Use the host compiler and not the internal clang to build the swift runtime"
        FALSE)
 
+option(SWIFT_RUN_TESTS_WITH_HOST_COMPILER
+       "Run tests against the host compiler and not the just built swift"
+       FALSE)
+
 set(SWIFT_SDKS "" CACHE STRING
     "If non-empty, limits building target binaries only to specified SDKs (despite other SDKs being available)")
 
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -134,10 +134,20 @@ set(SWIFT_LIT_ARGS "" CACHE STRING "Arguments to pass to lit")
 set(SWIFT_LIT_ENVIRONMENT "" CACHE STRING "Environment to use for lit invocations")
 
 if(NOT SWIFT_INCLUDE_TOOLS)
-  list(APPEND SWIFT_LIT_ARGS
-       "--path=${SWIFT_NATIVE_LLVM_TOOLS_PATH}"
-       "--path=${SWIFT_NATIVE_CLANG_TOOLS_PATH}"
-       "--path=${SWIFT_NATIVE_SWIFT_TOOLS_PATH}")
+  if(SWIFT_RUN_TESTS_WITH_HOST_COMPILER)
+    precondition(CMAKE_Swift_COMPILER MESSAGE "Can only run tests if a Swift compiler is specified")
+    get_filename_component(SWIFT_COMPILER_DIR "${CMAKE_Swift_COMPILER}" DIRECTORY)
+    precondition(SWIFT_COMPILER_DIR)
+    # We assume that we are building against a toolchain where all tools are
+    # next to swiftc.
+    list(APPEND SWIFT_LIT_ARGS
+      "--path=${SWIFT_COMPILER_DIR}")
+  else()
+    list(APPEND SWIFT_LIT_ARGS
+      "--path=${SWIFT_NATIVE_LLVM_TOOLS_PATH}"
+      "--path=${SWIFT_NATIVE_CLANG_TOOLS_PATH}"
+      "--path=${SWIFT_NATIVE_SWIFT_TOOLS_PATH}")
+  endif()
   if(SWIFT_BUILD_STDLIB)
     list(APPEND SWIFT_LIT_ARGS
          "--param" "test_resource_dir=${SWIFTLIB_DIR}")
diff --git a/utils/swift_build_support/swift_build_support/cmake.py b/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)
 
diff --git a/utils/swift_build_support/swift_build_support/compiler_stage.py b/utils/swift_build_support/swift_build_support/compiler_stage.py
@@ -0,0 +1,32 @@
+# ===--- compiler_stage.py -----------------------------------------------===#
+#
+# This source file is part of the Swift.org open source project
+#
+# Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
+# Licensed under Apache License v2.0 with Runtime Library Exception
+#
+# See https:#swift.org/LICENSE.txt for license information
+# See https:#swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+#
+# ===---------------------------------------------------------------------===#
+
+class StageArgs(object):
+    def __init__(self, stage, args):
+        self.stage = stage
+        self.args = args
+
+    def __getattr__(self, key):
+        real_key = '{}{}'.format(key, self.stage.postfix)
+        if not hasattr(self.args, real_key):
+            return None
+        return getattr(self.args, real_key)
+
+
+class Stage(object):
+    def __init__(self, identifier, postfix=""):
+        self.identifier = identifier
+        self.postfix = postfix
+
+
+STAGE_1 = Stage(1, "")
+STAGE_2 = Stage(2, "_stage2")
diff --git a/utils/swift_build_support/swift_build_support/host_specific_configuration.py b/utils/swift_build_support/swift_build_support/host_specific_configuration.py
@@ -14,43 +14,49 @@
 import sys
 from argparse import ArgumentError
 
+from . import compiler_stage
 from .targets import StdlibDeploymentTarget
 
 
 class HostSpecificConfiguration(object):
-
     """Configuration information for an individual host."""
 
-    def __init__(self, host_target, args):
+    def __init__(self, host_target, args, stage_dependent_args=None):
         """Initialize for the given `host_target`."""
+        # If we were not passed a stage_dependent_args object, then we do not need
+        # to make a distinction in between them and can just use args.
+        if not isinstance(args, compiler_stage.StageArgs):
+            args = compiler_stage.StageArgs(compiler_stage.STAGE_1, args)
+        if stage_dependent_args is None:
+            stage_dependent_args = args
 
         # Compute the set of deployment targets to configure/build.
-        if host_target == args.host_target:
+        if host_target == stage_dependent_args.host_target:
             # This host is the user's desired product, so honor the requested
             # set of targets to configure/build.
-            stdlib_targets_to_configure = args.stdlib_deployment_targets
-            if "all" in args.build_stdlib_deployment_targets:
+            stdlib_targets_to_configure = stage_dependent_args.stdlib_deployment_targets
+            if "all" in stage_dependent_args.build_stdlib_deployment_targets:
                 stdlib_targets_to_build = set(stdlib_targets_to_configure)
             else:
                 stdlib_targets_to_build = set(
-                    args.build_stdlib_deployment_targets).intersection(
-                    set(args.stdlib_deployment_targets))
+                    stage_dependent_args.build_stdlib_deployment_targets).intersection(
+                    set(stage_dependent_args.stdlib_deployment_targets))
         else:
             # Otherwise, this is a host we are building as part of
             # cross-compiling, so we only need the target itself.
             stdlib_targets_to_configure = [host_target]
-            if (hasattr(args, 'stdlib_deployment_targets')):
+            if stage_dependent_args.stdlib_deployment_targets:
                 # there are some build configs that expect
                 # not to be building the stdlib for the target
                 # since it will be provided by different means
                 stdlib_targets_to_build = set(
                     stdlib_targets_to_configure).intersection(
-                    set(args.stdlib_deployment_targets))
+                    set(stage_dependent_args.stdlib_deployment_targets))
             else:
                 stdlib_targets_to_build = set(stdlib_targets_to_configure)
 
-        if (hasattr(args, 'stdlib_deployment_targets') and
-                args.stdlib_deployment_targets == []):
+        if stage_dependent_args.stdlib_deployment_targets and \
+           stage_dependent_args.stdlib_deployment_targets == []:
             stdlib_targets_to_configure = []
             stdlib_targets_to_build = []
 
@@ -59,11 +65,15 @@ def __init__(self, host_target, args):
         # FIXME: We should move the platform-derived arguments to be entirely
         # data driven, so that we can eliminate this code duplication and just
         # iterate over all supported platforms.
-        platforms_to_skip_build = self.__platforms_to_skip_build(args)
-        platforms_to_skip_test = self.__platforms_to_skip_test(args)
+        platforms_to_skip_build = \
+            self.__platforms_to_skip_build(args, stage_dependent_args)
+        platforms_to_skip_test = \
+            self.__platforms_to_skip_test(args, stage_dependent_args)
         platforms_archs_to_skip_test = \
-            self.__platforms_archs_to_skip_test(args, host_target)
-        platforms_to_skip_test_host = self.__platforms_to_skip_test_host(args)
+            self.__platforms_archs_to_skip_test(args, stage_dependent_args,
+                                                host_target)
+        platforms_to_skip_test_host = \
+            self.__platforms_to_skip_test_host(args, stage_dependent_args)
 
         # Compute the lists of **CMake** targets for each use case (configure
         # vs. build vs. run) and the SDKs to configure with.
@@ -125,7 +135,10 @@ def __init__(self, host_target, args):
                 # Validation, long, and stress tests require building the full
                 # standard library, whereas the other targets can build a
                 # slightly smaller subset which is faster to build.
-                if args.build_swift_stdlib_unittest_extra or \
+                #
+                # NOTE: We currently do not seperate testing options for
+                # stage1/stage2 compiler. This can change with time.
+                if stage_dependent_args.build_swift_stdlib_unittest_extra or \
                         args.validation_test or args.long_test or \
                         args.stress_test:
                     self.swift_stdlib_build_targets.append(
@@ -172,7 +185,7 @@ def __init__(self, host_target, args):
                 # If the compiler is being tested after being built to use the
                 # standalone swift-driver, we build a test-target to
                 # run a reduced set of lit-tests that verify the early swift-driver.
-                if getattr(args, 'test_early_swift_driver', False) and\
+                if args.test_early_swift_driver and\
                    not test_host_only:
                     self.swift_test_run_targets.append(
                         "check-swift-only_early_swiftdriver-{}".format(name))
@@ -215,80 +228,82 @@ def add_flags_for_cross_compilation(self, args, deployment_target):
         self.swift_flags = deployment_target.platform.swift_flags(args)
         self.cmake_options = deployment_target.platform.cmake_options(args)
 
-    def __platforms_to_skip_build(self, args):
+    def __platforms_to_skip_build(self, args, stage_dependent_args):
         platforms_to_skip_build = set()
-        if not args.build_linux:
+        if not stage_dependent_args.build_linux:
             platforms_to_skip_build.add(StdlibDeploymentTarget.Linux)
-        if not args.build_freebsd:
+        if not stage_dependent_args.build_freebsd:
             platforms_to_skip_build.add(StdlibDeploymentTarget.FreeBSD)
-        if not args.build_cygwin:
+        if not stage_dependent_args.build_cygwin:
             platforms_to_skip_build.add(StdlibDeploymentTarget.Cygwin)
-        if not args.build_osx:
+        if not stage_dependent_args.build_osx:
             platforms_to_skip_build.add(StdlibDeploymentTarget.OSX)
-        if not args.build_ios_device:
+        if not stage_dependent_args.build_ios_device:
             platforms_to_skip_build.add(StdlibDeploymentTarget.iOS)
-        if not args.build_ios_simulator:
+        if not stage_dependent_args.build_ios_simulator:
             platforms_to_skip_build.add(StdlibDeploymentTarget.iOSSimulator)
-        if not args.build_tvos_device:
+        if not stage_dependent_args.build_tvos_device:
             platforms_to_skip_build.add(StdlibDeploymentTarget.AppleTV)
-        if not args.build_tvos_simulator:
+        if not stage_dependent_args.build_tvos_simulator:
             platforms_to_skip_build.add(
                 StdlibDeploymentTarget.AppleTVSimulator)
-        if not args.build_watchos_device:
+        if not stage_dependent_args.build_watchos_device:
             platforms_to_skip_build.add(StdlibDeploymentTarget.AppleWatch)
-        if not args.build_watchos_simulator:
+        if not stage_dependent_args.build_watchos_simulator:
             platforms_to_skip_build.add(
                 StdlibDeploymentTarget.AppleWatchSimulator)
-        if not args.build_android:
+        if not stage_dependent_args.build_android:
             platforms_to_skip_build.add(StdlibDeploymentTarget.Android)
         return platforms_to_skip_build
 
-    def __platforms_to_skip_test(self, args):
+    def __platforms_to_skip_test(self, args, stage_dependent_args):
         platforms_to_skip_test = set()
-        if not args.test_linux:
+        if not stage_dependent_args.test_linux:
             platforms_to_skip_test.add(StdlibDeploymentTarget.Linux)
-        if not args.test_freebsd:
+        if not stage_dependent_args.test_freebsd:
             platforms_to_skip_test.add(StdlibDeploymentTarget.FreeBSD)
-        if not args.test_cygwin:
+        if not stage_dependent_args.test_cygwin:
             platforms_to_skip_test.add(StdlibDeploymentTarget.Cygwin)
-        if not args.test_osx:
+        if not stage_dependent_args.test_osx:
             platforms_to_skip_test.add(StdlibDeploymentTarget.OSX)
-        if not args.test_ios_host and not args.only_non_executable_test:
+        if not stage_dependent_args.test_ios_host and not args.only_non_executable_test:
             platforms_to_skip_test.add(StdlibDeploymentTarget.iOS)
         elif not args.only_non_executable_test:
             raise ArgumentError(None,
                                 "error: iOS device tests are not " +
                                 "supported in open-source Swift.")
-        if not args.test_ios_simulator:
+        if not stage_dependent_args.test_ios_simulator:
             platforms_to_skip_test.add(StdlibDeploymentTarget.iOSSimulator)
-        if not args.test_tvos_host and not args.only_non_executable_test:
+        if not stage_dependent_args.test_tvos_host and \
+           not args.only_non_executable_test:
             platforms_to_skip_test.add(StdlibDeploymentTarget.AppleTV)
         elif not args.only_non_executable_test:
             raise ArgumentError(None,
                                 "error: tvOS device tests are not " +
                                 "supported in open-source Swift.")
-        if not args.test_tvos_simulator:
+        if not stage_dependent_args.test_tvos_simulator:
             platforms_to_skip_test.add(StdlibDeploymentTarget.AppleTVSimulator)
-        if not args.test_watchos_host and not args.only_non_executable_test:
+        if not stage_dependent_args.test_watchos_host and \
+           not args.only_non_executable_test:
             platforms_to_skip_test.add(StdlibDeploymentTarget.AppleWatch)
         elif not args.only_non_executable_test:
             raise ArgumentError(None,
                                 "error: watchOS device tests are not " +
                                 "supported in open-source Swift.")
-        if not args.test_watchos_simulator:
+        if not stage_dependent_args.test_watchos_simulator:
             platforms_to_skip_test.add(
                 StdlibDeploymentTarget.AppleWatchSimulator)
-        if not args.test_android:
+        if not stage_dependent_args.test_android:
             platforms_to_skip_test.add(StdlibDeploymentTarget.Android)
 
         return platforms_to_skip_test
 
-    def __platforms_archs_to_skip_test(self, args, host_target):
+    def __platforms_archs_to_skip_test(self, args, stage_dependent_args, host_target):
         platforms_archs_to_skip_test = set()
-        if not args.test_ios_32bit_simulator:
+        if not stage_dependent_args.test_ios_32bit_simulator:
             platforms_archs_to_skip_test.add(
                 StdlibDeploymentTarget.iOSSimulator.i386)
-        if not args.test_watchos_32bit_simulator:
+        if not stage_dependent_args.test_watchos_32bit_simulator:
             platforms_archs_to_skip_test.add(
                 StdlibDeploymentTarget.AppleWatchSimulator.i386)
         if host_target == StdlibDeploymentTarget.OSX.x86_64.name:
@@ -312,14 +327,17 @@ def __platforms_archs_to_skip_test(self, args, host_target):
 
         return platforms_archs_to_skip_test
 
-    def __platforms_to_skip_test_host(self, args):
+    def __platforms_to_skip_test_host(self, args, stage_dependent_args):
         platforms_to_skip_test_host = set()
-        if not args.test_android_host:
+        if not stage_dependent_args.test_android_host:
             platforms_to_skip_test_host.add(StdlibDeploymentTarget.Android)
-        if not args.test_ios_host and not args.only_non_executable_test:
+        if not stage_dependent_args.test_ios_host and \
+           not args.only_non_executable_test:
             platforms_to_skip_test_host.add(StdlibDeploymentTarget.iOS)
-        if not args.test_tvos_host and not args.only_non_executable_test:
+        if not stage_dependent_args.test_tvos_host and \
+           not args.only_non_executable_test:
             platforms_to_skip_test_host.add(StdlibDeploymentTarget.AppleTV)
-        if not args.test_watchos_host and not args.only_non_executable_test:
+        if not stage_dependent_args.test_watchos_host and \
+           not args.only_non_executable_test:
             platforms_to_skip_test_host.add(StdlibDeploymentTarget.AppleWatch)
         return platforms_to_skip_test_host
diff --git a/utils/swift_build_support/swift_build_support/products/cmake_product.py b/utils/swift_build_support/swift_build_support/products/cmake_product.py
@@ -18,15 +18,26 @@
 
 
 class CMakeProduct(product.Product):
-    def build_with_cmake(self, build_targets, build_type, build_args):
+    def is_verbose(self):
+        return self.args.verbose_build
+
+    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)
         cmake_build.extend([self.toolchain.cmake, "--build"])
 
+        # If we are verbose...
+        if self.is_verbose():
+            # And ninja, add a -v.
+            if self.args.cmake_generator == "Ninja":
+                build_args.append('-v')
+
         generator_output_path = ""
         if self.args.cmake_generator == "Ninja":
             generator_output_path = os.path.join(self.build_dir, "build.ninja")
@@ -52,7 +63,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)
 
@@ -80,6 +91,13 @@ def test_with_cmake(self, executable_target, results_targets,
 
         if self.toolchain.distcc_pump:
             cmake_build.append(self.toolchain.distcc_pump)
+
+        # If we are verbose...
+        if self.is_verbose():
+            # And ninja, add a -v.
+            if self.args.cmake_generator == "Ninja":
+                build_args.append('-v')
+
         cmake_args = [self.toolchain.cmake, "--build", self.build_dir,
                       "--config", build_type, "--"]
         cmake_build.extend(cmake_args + build_args)
diff --git a/utils/swift_build_support/tests/test_cmake.py b/utils/swift_build_support/tests/test_cmake.py
