[build-script][SR-237] Migrated calculation of COMMON_CMAKE_OPTIONS to Python.

rintaro · rintaro · commit c025590c88d6 · 2016-04-25T14:27:29.000+09:00
Calculate `COMMON_CMAKE_OPTIONS` in `build-script`, then pass them to
`build-script-impl` using newly introduced `--common-cmake-option` argument.
diff --git a/utils/build-script b/utils/build-script
@@ -48,6 +48,7 @@ from swift_build_support import migration  # noqa (E402)
 import swift_build_support.ninja      # noqa (E402)
 import swift_build_support.tar        # noqa (E402)
 import swift_build_support.targets    # noqa (E402)
+from swift_build_support.cmake import CMake  # noqa (E402)
 
 
 # A strict parser for bools (unlike Python's `bool()`, where
@@ -812,6 +813,33 @@ details of the setups of other systems or automated environments.""")
         help="Path to a directory containing headers libicui18n",
         metavar="PATH")
 
+    parser.add_argument(
+        "--host-cc",
+        help="the absolute path to CC, the 'clang' compiler for the host "
+             "platform. Default is auto detected.",
+        metavar="PATH")
+    parser.add_argument(
+        "--host-cxx",
+        help="the absolute path to CXX, the 'clang++' compiler for the host "
+             "platform. Default is auto detected.",
+        metavar="PATH")
+    parser.add_argument(
+        "--distcc",
+        help="use distcc in pump mode",
+        action="store_true")
+    parser.add_argument(
+        "--enable-asan",
+        help="enable Address Sanitizer",
+        action="store_true")
+    parser.add_argument(
+        "--enable-ubsan",
+        help="enable Undefined Behavior Sanitizer",
+        action="store_true")
+    parser.add_argument(
+        "--clang-compiler-version",
+        help="string that indicates a compiler version for Clang",
+        metavar="MAJOR.MINOR.PATCH")
+
     parser.add_argument(
         "--extra-cmake-options",
         help="Pass through extra options to CMake in the form of comma "
@@ -955,11 +983,6 @@ details of the setups of other systems or automated environments.""")
 
     build_script_impl_inferred_args = []
 
-    if args.export_compile_commands:
-        build_script_impl_inferred_args += [
-            "--export-compile-commands"
-        ]
-
     if not args.test and not args.validation_test and not args.long_test:
         build_script_impl_inferred_args += [
             "--skip-test-cmark",
@@ -1166,9 +1189,16 @@ details of the setups of other systems or automated environments.""")
 
     host_clang = swift_build_support.toolchain.host_clang(
         xcrun_toolchain=args.darwin_xcrun_toolchain)
-    if not host_clang:
+    if args.host_cc is None and host_clang is not None:
+        args.host_cc = str(host_clang.cc)
+    if args.host_cxx is None and host_clang is not None:
+        args.host_cxx = str(host_clang.cxx)
+    is_host_clang_ok = (
+        args.host_cc is not None and os.access(args.host_cc, os.X_OK) and
+        args.host_cxx is not None and os.access(args.host_cxx, os.X_OK))
+    if not is_host_clang_ok:
         print_with_argv0(
-            "Can't find clang.  Please install clang-3.5 or a later version.")
+            "Can't find clang. Please install clang-3.5 or a later version.")
         return 1
 
     host_cmake = args.cmake
@@ -1178,14 +1208,38 @@ details of the setups of other systems or automated environments.""")
     if not host_cmake:
         print_with_argv0("Can't find CMake. Please install CMake.")
         return 1
+
+    # distcc usage.
+    host_distcc = None
+    host_distcc_pump = None
+    if args.distcc:
+        host_distcc = swift_build_support.which('distcc')
+        # On some platforms, 'pump' may be unrelated to distcc, in which case
+        # it's called 'distcc-pump'.
+        host_distcc_pump = swift_build_support.which('distcc-pump')
+        if host_distcc_pump is None:
+            host_distcc_pump = swift_build_support.which('pump')
+
+        if host_distcc is None or host_distcc_pump is None:
+            print_with_argv0(
+                "Can't find distcc. Please install distcc")
+
+        host_distcc = str(host_distcc)
+        host_distcc_pump = str(host_distcc_pump)
+
+    cmake = CMake(args=args,
+                  host_cc=args.host_cc,
+                  host_cxx=args.host_cxx,
+                  host_distcc=host_distcc)
+
     build_script_impl_args = [
         "--build-dir", build_dir,
         "--install-prefix", os.path.abspath(args.install_prefix),
         "--host-target", args.host_target,
         "--stdlib-deployment-targets",
         " ".join(args.stdlib_deployment_targets),
-        "--host-cc", host_clang.cc,
-        "--host-cxx", host_clang.cxx,
+        "--host-cc", args.host_cc,
+        "--host-cxx", args.host_cxx,
         "--darwin-xcrun-toolchain", args.darwin_xcrun_toolchain,
         "--cmake", host_cmake,
         "--cmark-build-type", args.cmark_build_variant,
@@ -1201,8 +1255,24 @@ details of the setups of other systems or automated environments.""")
             args.swift_analyze_code_coverage).lower(),
         "--cmake-generator", args.cmake_generator,
         "--build-jobs", str(args.build_jobs),
-        "--workspace", SWIFT_SOURCE_ROOT
+        "--workspace", SWIFT_SOURCE_ROOT,
+        "--common-cmake-options=%s" % ' '.join(
+            pipes.quote(opt) for opt in cmake.common_options()),
     ]
+
+    if args.distcc:
+        build_script_impl_args += [
+            "--distcc",
+            "--distcc-pump=%s" % host_distcc_pump
+        ]
+    if args.enable_asan:
+        build_script_impl_args += ["--enable-asan"]
+    if args.enable_ubsan:
+        build_script_impl_args += ["--enable-ubsan"]
+    if args.clang_compiler_version:
+        build_script_impl_args += [
+            "--clang-compiler-version", args.clang_compiler_version
+        ]
     if args.install_symroot:
         build_script_impl_args += [
             "--install-symroot", os.path.abspath(args.install_symroot)
diff --git a/utils/build-script-impl b/utils/build-script-impl
@@ -89,6 +89,7 @@ KNOWN_SETTINGS=(
     enable-ubsan                ""               "enable Undefined Behavior Sanitizer"
     cmake                       ""               "path to the cmake binary"
     distcc                      ""               "use distcc in pump mode"
+    distcc-pump                 ""               "the path to distcc pump executable. This argument is required if distcc is set."
     build-runtime-with-host-compiler   "1"       "use the host c++ compiler to build everything"
     cmake-generator             "Unix Makefiles" "kind of build system to generate; see output of 'cmake --help' for choices"
     verbose-build               ""               "print the commands executed during the build"
@@ -218,8 +219,8 @@ KNOWN_SETTINGS=(
     android-icu-uc-include             ""        "Path to a directory containing headers for libicuuc"
     android-icu-i18n                   ""        "Path to a directory containing libicui18n.so"
     android-icu-i18n-include           ""        "Path to a directory containing headers libicui18n"
-    export-compile-commands            ""        "set to generate JSON compilation databases for each build product"
     check-args-only                    ""        "set to check all arguments are known. Exit with status 0 if success, non zero otherwise"
+    common-cmake-options               ""        "CMake options used for all targets, including LLVM/Clang"
     # TODO: Remove this some time later.
     user-config-args            ""               "**Renamed to --extra-cmake-options**: User-supplied arguments to cmake when used to do configuration."
 )
@@ -247,13 +248,6 @@ function to_varname() {
     toupper "${1//-/_}"
 }
 
-function join_array_with_delimiter() {
-    # $1 is the delimiter
-    local IFS="$1"
-    shift
-    echo "$*"
-}
-
 function set_lldb_build_mode() {
     LLDB_BUILD_MODE="CustomSwift-${LLDB_BUILD_TYPE}"
 }
@@ -1132,64 +1126,12 @@ if ! [[ "${SKIP_TEST_BENCHMARKS}" ]] &&
 fi
 echo
 
-# CMake options used for all targets, including LLVM/Clang
-COMMON_CMAKE_OPTIONS=(
-    -G "${CMAKE_GENERATOR}"
-)
-
 COMMON_C_FLAGS=""
-SANITIZERS=()
-if [[ "${ENABLE_ASAN}" ]] ; then
-    SANITIZERS=(
-        "${SANITIZERS[@]}"
-        "Address"
-    )
-fi
-
-if [[ "${ENABLE_UBSAN}" ]] ; then
-    SANITIZERS=(
-        "${SANITIZERS[@]}"
-        "Undefined"
-    )
-fi
-
-if [[ -n "${SANITIZERS[@]}" ]] ; then
-    COMMON_CMAKE_OPTIONS=(
-        "${COMMON_CMAKE_OPTIONS[@]}"
-        -DLLVM_USE_SANITIZER=$(join_array_with_delimiter ";" "${SANITIZERS[@]}")
-    )
-fi
-
-if [[ "${EXPORT_COMPILE_COMMANDS}" ]] ; then
-    COMMON_CMAKE_OPTIONS=(
-        "${COMMON_CMAKE_OPTIONS[@]}"
-        -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
-    )
-fi
 
 # Convert to an array.
+eval COMMON_CMAKE_OPTIONS=(${COMMON_CMAKE_OPTIONS})
 eval EXTRA_CMAKE_OPTIONS=(${EXTRA_CMAKE_OPTIONS})
 
-if [[ "${DISTCC}" ]] ; then
-    # On some platforms, 'pump' may be unrelated to distcc, in which case it's
-    # called 'distcc-pump'.
-    DISTCC_PUMP="$(which distcc-pump || which pump)"
-    COMMON_CMAKE_OPTIONS=(
-        "${COMMON_CMAKE_OPTIONS[@]}"
-        -DCMAKE_C_COMPILER:PATH="$(which distcc)"
-        -DCMAKE_C_COMPILER_ARG1="${HOST_CC}"
-        -DCMAKE_CXX_COMPILER:PATH="$(which distcc)"
-        -DCMAKE_CXX_COMPILER_ARG1="${HOST_CXX}"
-    )
-else
-    COMMON_CMAKE_OPTIONS=(
-        "${COMMON_CMAKE_OPTIONS[@]}"
-        -DCMAKE_C_COMPILER:PATH="${HOST_CC}"
-        -DCMAKE_CXX_COMPILER:PATH="${HOST_CXX}"
-    )
-fi
-
-
 CMAKE_JOBS="${BUILD_JOBS}"
 if [[ "${DISTCC}" ]] ; then
     CMAKE_JOBS="$(distcc -j)"
@@ -1215,29 +1157,13 @@ case "${CMAKE_GENERATOR}" in
         BUILD_ARGS="${BUILD_ARGS} -parallelizeTargets"
         BUILD_ARGS="${BUILD_ARGS} -jobs ${CMAKE_JOBS}"
         BUILD_TARGET_FLAG="-target"
-        COMMON_CMAKE_OPTIONS=(
-            "${COMMON_CMAKE_OPTIONS[@]}"
-            -DCMAKE_CONFIGURATION_TYPES="Debug;Release;MinSizeRel;RelWithDebInfo"
-        )
 
         # FIXME: We currently do not support building compiler-rt with the
         # Xcode generator.
         SKIP_COMPILER_RT=1
         ;;
 esac
 
-if [[ "${CLANG_COMPILER_VERSION}" ]] ; then
-    major_version=$(echo "${CLANG_COMPILER_VERSION}" | sed -e 's/\([0-9]*\).*/\1/')
-    minor_version=$(echo "${CLANG_COMPILER_VERSION}" | sed -e 's/[^.]*\.\([0-9]*\).*/\1/')
-    patch_version=$(echo "${CLANG_COMPILER_VERSION}" | sed -e 's/[^.]*\.[^.]*\.\([0-9]*\)/\1/')
-    COMMON_CMAKE_OPTIONS=(
-        "${COMMON_CMAKE_OPTIONS[@]}"
-        -DLLVM_VERSION_MAJOR:STRING="${major_version}"
-        -DLLVM_VERSION_MINOR:STRING="${minor_version}"
-        -DLLVM_VERSION_PATCH:STRING="${patch_version}"
-    )
-fi
-
 function build_directory() {
     deployment_target=$1
     product=$2
diff --git a/utils/swift_build_support/swift_build_support/cmake.py b/utils/swift_build_support/swift_build_support/cmake.py
@@ -14,7 +14,9 @@
 #
 # ----------------------------------------------------------------------------
 
+import re
 import platform
+from numbers import Number
 
 from . import xcrun
 from .which import which
@@ -34,3 +36,103 @@ def host_cmake(xcrun_toolchain):
             return cmake
         else:
             return '/usr/local/bin/cmake'
+
+
+class CMakeOptions(object):
+    """List like object used to define cmake options
+    """
+
+    def __init__(self):
+        self._options = []
+
+    def define(self, var, value):
+        """Utility to define cmake options in this object.
+
+        opts.define("FOO", "BAR")       # -> -DFOO=BAR
+        opts.define("FLAG:BOOL", True)  # -> -FLAG:BOOL=TRUE
+        """
+        if var.endswith(':BOOL'):
+            value = self.true_false(value)
+        if value is None:
+            value = ""
+        elif not isinstance(value, (str, Number)):
+            raise ValueError('define: invalid value: %s' % value)
+        self._options.append('-D%s=%s' % (var, value))
+
+    @staticmethod
+    def true_false(value):
+        if hasattr(value, 'lower'):
+            value = value.lower()
+        if value in [True, 1, 'true', 'yes', '1']:
+            return 'TRUE'
+        if value in [False, 0, 'false', 'no', '0']:
+            return 'FALSE'
+        raise ValueError("true_false: invalid value: %s" % value)
+
+    def __len__(self):
+        return self._options.__len__()
+
+    def __iter__(self):
+        return self._options.__iter__()
+
+    def __add__(self, other):
+        ret = CMakeOptions()
+        ret._options += self._options
+        ret._options += list(other)
+        return ret
+
+    def __iadd__(self, other):
+        self._options += list(other)
+        return self
+
+
+class CMake(object):
+
+    def __init__(self, args, host_cc, host_cxx, host_distcc):
+        self.args = args
+        self.host_cc = host_cc
+        self.host_cxx = host_cxx
+        self.host_distcc = host_distcc
+
+    def common_options(self):
+        """Return options used for all products, including LLVM/Clang
+        """
+        args = self.args
+        options = CMakeOptions()
+        define = options.define
+
+        options += ['-G', args.cmake_generator]
+
+        sanitizers = []
+        if args.enable_asan:
+            sanitizers.append('Address')
+        if args.enable_ubsan:
+            sanitizers.append('Undefined')
+        if sanitizers:
+            define("LLVM_USE_SANITIZER", ";".join(sanitizers))
+
+        if args.export_compile_commands:
+            define("CMAKE_EXPORT_COMPILE_COMMANDS", "ON")
+
+        if args.distcc:
+            define("CMAKE_C_COMPILER:PATH", self.host_distcc)
+            define("CMAKE_C_COMPILER_ARG1", self.host_cc)
+            define("CMAKE_CXX_COMPILER:PATH", self.host_distcc)
+            define("CMAKE_CXX_COMPILER_ARG1", self.host_cxx)
+        else:
+            define("CMAKE_C_COMPILER:PATH", self.host_cc)
+            define("CMAKE_CXX_COMPILER:PATH", self.host_cxx)
+
+        if args.cmake_generator == 'Xcode':
+            define("CMAKE_CONFIGURATION_TYPES",
+                   "Debug;Release;MinSizeRel;RelWithDebInfo")
+
+        if args.clang_compiler_version:
+            m = re.match(r'([0-9]*)\.([0-9]*)\.([0-9]*)',
+                         args.clang_compiler_version)
+            if m is not None:
+                define("LLVM_VERSION_MAJOR:STRING", m.group(1))
+                define("LLVM_VERSION_MINOR:STRING", m.group(2))
+                define("LLVM_VERSION_PATCH:STRING", m.group(3))
+
+        return options
diff --git a/utils/swift_build_support/tests/test_cmake.py b/utils/swift_build_support/tests/test_cmake.py
