Merge pull request #42253 from etcwilde/ewilde/build-foundation-dependencies

Teach build-script to build Foundation Dependencies (Zlib, libxml2, LibCurl)

Author: etcwilde

utils/build-script-impl

@@ -265,6 +265,9 @@ components=(
   libcxx
   libdispatch
   libicu
+  libxml2
+  zlib
+  curl
   llbuild
   lldb
   llvm
@@ -1262,6 +1265,7 @@ LIBDISPATCH_STATIC_SOURCE_DIR="${WORKSPACE}/swift-corelibs-libdispatch"
 LIBICU_SOURCE_DIR="${WORKSPACE}/icu"
 LIBCXX_SOURCE_DIR="${WORKSPACE}/llvm-project/libcxx"
 EXPERIMENTAL_STRING_PROCESSING_SOURCE_DIR="${WORKSPACE}/swift-experimental-string-processing"
+LIBXML2_SOURCE_DIR="${WORKSPACE}/libxml2"
 
 # We cannot currently apply the normal rules of skipping here for LLVM. Even if
 # we are skipping building LLVM, we still need to at least build a few tools
@@ -2524,6 +2528,61 @@ for host in "${ALL_HOSTS[@]}"; do
                     LIBICU_BUILD_ARGS=()
                 fi
 
+                if [[ ! "${SKIP_BUILD_LIBXML2}" ]]; then
+                    BASE_INSTALL_DIR="$(get_host_install_destdir ${host})"
+                    LIBXML2_HEADERS="${BASE_INSTALL_DIR}/usr/include/libxml2"
+                    LIBXML2_LIBRARY="${BASE_INSTALL_DIR}/usr/lib/libxml2.a"
+
+                    if [[ -z "${DRY_RUN}" && ! -d "${LIBXML2_HEADERS}" ]]; then
+                        echo "Error: '${LIBXML2_HEADERS}' does not exist" 1>&2
+                        exit 1
+                    fi
+
+                    if [[ -z "${DRY_RUN}" && ! -e "${LIBXML2_LIBRARY}" ]]; then
+                        echo "Error: '${LIBXML2_LIBRARY}' does not exist" 1>&2
+                        exit 1
+                    fi
+
+                    LIBXML2_BUILD_ARGS=(
+                        -DLIBXML2_INCLUDE_DIR:PATH="${LIBXML2_HEADERS}"
+                        -DLIBXML2_LIBRARY:PATH="${LIBXML2_LIBRARY}"
+                        -DLIBXML2_DEFINITIONS="-DLIBXML_STATIC"
+                    )
+                else
+                    LIBXML2_BUILD_ARGS=()
+                fi
+
+                if [[ ! "${SKIP_BUILD_ZLIB}" ]]; then
+                    BASE_INSTALL_DIR="$(get_host_install_destdir ${host})"
+                    ZLIB_HEADERS="${BASE_INSTALL_DIR}/usr/include"
+                    # Note: On Windows, the spelling is 'zlibstatic.lib',
+                    #       so if this is ported to python, that case will need
+                    #       to be handled.
+                    ZLIB_LIBRARY="${BASE_INSTALL_DIR}/usr/lib/libz.a"
+
+                    if [[ -z "${DRY_RUN}" && ! -d "${ZLIB_HEADERS}" ]]; then
+                        echo "Error: '${ZLIB_HEADERS}' does not exist" 1>&2
+                        exit 1
+                    fi
+
+                    if [[ -z "${DRY_RUN}" && ! -e "${ZLIB_LIBRARY}" ]]; then
+                        echo "Error: '${ZLIB_LIBRARY}' does not exist" 1>&2
+                        exit 1
+                    fi
+
+                    ZLIB_BUILD_ARGS=(
+                        -DZLIB_INCLUDE_DIR:PATH="${ZLIB_HEADERS}"
+                        -DZLIB_LIBRARY:PATH="${ZLIB_LIBRARY}"
+                    )
+                fi
+
+                if [[ ! "${SKIP_BUILD_CURL}" ]]; then
+                    BASE_INSTALL_DIR="$(get_host_install_destdir ${host})"
+                    CURL_BUILD_ARGS=(
+                        -DCURL_DIR="${BASE_INSTALL_DIR}/usr/lib/cmake/CURL"
+                    )
+                fi
+
                 if [[ "${SKIP_CLEAN_FOUNDATION}" == "0" ]]
                 then
                   # The Swift project might have been changed, but CMake might
@@ -2550,6 +2609,12 @@ for host in "${ALL_HOSTS[@]}"; do
 
                   ${LIBICU_BUILD_ARGS[@]}
 
+                  ${LIBXML2_BUILD_ARGS[@]}
+
+                  ${ZLIB_BUILD_ARGS[@]}
+
+                  ${CURL_BUILD_ARGS[@]}
+
                   -DFOUNDATION_PATH_TO_LIBDISPATCH_SOURCE=${LIBDISPATCH_SOURCE_DIR}
                   -DFOUNDATION_PATH_TO_LIBDISPATCH_BUILD=$(build_directory ${host} libdispatch)
                   -Ddispatch_DIR=$(build_directory ${host} libdispatch)/cmake/modules

utils/build_swift/build_swift/driver_arguments.py

@@ -90,6 +90,15 @@ def _apply_default_arguments(args):
     if args.libicu_build_variant is None:
         args.libicu_build_variant = args.build_variant
 
+    if args.libxml2_build_variant is None:
+        args.libxml2_build_variant = args.build_variant
+
+    if args.zlib_build_variant is None:
+        args.zlib_build_variant = args.build_variant
+
+    if args.curl_build_variant is None:
+        args.curl_build_variant = args.build_variant
+
     # Assertions are enabled by default.
     if args.assertions is None:
         args.assertions = True
@@ -709,6 +718,15 @@ def create_argument_parser():
     option('--libicu', toggle_true('build_libicu'),
            help='build libicu')
 
+    option('--static-libxml2', toggle_true('build_libxml2'), default=False,
+           help='build static libxml2')
+
+    option('--static-zlib', toggle_true('build_zlib'), default=False,
+           help='build static zlib')
+
+    option('--static-curl', toggle_true('build_curl'), default=False,
+           help='build static curl libraries')
+
     option('--playgroundsupport', toggle_true('build_playgroundsupport'),
            help='build PlaygroundSupport')
     option('--install-playgroundsupport',
@@ -820,6 +838,18 @@ def create_argument_parser():
            const='Debug',
            help='build the Debug variant of libicu')
 
+    option('--debug-libxml2', store('libxml2_build_variant'),
+           const='Debug',
+           help='build the Debug variant of libxml2')
+
+    option('--debug-zlib', store('zlib_build_variant'),
+           const='Debug',
+           help='build the Debug variant of zlib')
+
+    option('--debug-curl', store('curl_build_variant'),
+           const='Debug',
+           help='build the Debug variant of libcurl')
+
     # -------------------------------------------------------------------------
     # Assertions group
 
@@ -1252,6 +1282,12 @@ def create_argument_parser():
            help='skip building llvm')
     option('--skip-build-swift', toggle_false('build_swift'),
            help='skip building swift')
+    option('--skip-build-libxml2', toggle_false('build_libxml2'),
+           help='skip building libxml2')
+    option('--skip-build-zlib', toggle_false('build_zlib'),
+           help='skip building zlib')
+    option('--skip-build-curl', toggle_false('build_curl'),
+           help='skip building curl')
 
     # We need to list --skip-test-swift explicitly because otherwise argparse
     # will auto-expand arguments like --skip-test-swift to the only known
@@ -1330,6 +1366,9 @@ def create_argument_parser():
                      /swift-corelibs-foundation  (optional)
                      /swift-corelibs-libdispatch (optional)
                      /icu                        (optional)
+                     /libxml2                    (optional)
+                     /zlib                       (optional)
+                     /curl                       (optional)
 
 SWIFT_BUILD_ROOT: a directory in which to create out-of-tree builds.
                   Defaults to "$SWIFT_SOURCE_ROOT/build/".

utils/build_swift/tests/expected_options.py

@@ -66,6 +66,9 @@
     'build_jobs': multiprocessing.cpu_count(),
     'build_libdispatch': False,
     'build_libicu': False,
+    'build_libxml2': False,
+    'build_zlib': False,
+    'build_curl': False,
     'build_linux': True,
     'build_llbuild': False,
     'build_lldb': False,
@@ -181,6 +184,9 @@
     'legacy_impl': False,
     'libdispatch_build_variant': 'Debug',
     'libicu_build_variant': 'Debug',
+    'libxml2_build_variant': 'Debug',
+    'zlib_build_variant': 'Debug',
+    'curl_build_variant': 'Debug',
     'bootstrapping_mode': None,
     'lit_args': '-sv',
     'llbuild_assertions': True,
@@ -429,6 +435,9 @@ class BuildScriptImplOption(_BaseOption):
     SetOption('--debug-libdispatch',
               dest='libdispatch_build_variant', value='Debug'),
     SetOption('--debug-libicu', dest='libicu_build_variant', value='Debug'),
+    SetOption('--debug-libxml2', dest='libxml2_build_variant', value='Debug'),
+    SetOption('--debug-zlib', dest='zlib_build_variant', value='Debug'),
+    SetOption('--debug-curl', dest='curl_build_variant', value='Debug'),
     SetOption('--debug-lldb', dest='lldb_build_variant', value='Debug'),
     SetOption('--lldb-build-with-xcode', dest='lldb_build_with_xcode',
               value='1'),
@@ -560,6 +569,9 @@ class BuildScriptImplOption(_BaseOption):
     EnableOption('--only-non-executable-test'),
     EnableOption('--libdispatch', dest='build_libdispatch'),
     EnableOption('--libicu', dest='build_libicu'),
+    EnableOption('--static-libxml2', dest='build_libxml2'),
+    EnableOption('--static-zlib', dest='build_zlib'),
+    EnableOption('--static-curl', dest='build_curl'),
     EnableOption('--indexstore-db', dest='build_indexstoredb'),
     EnableOption('--test-indexstore-db-sanitize-all',
                  dest='test_indexstoredb_sanitize_all'),
@@ -663,6 +675,9 @@ class BuildScriptImplOption(_BaseOption):
                   dest='test_swift_inspect'),
     DisableOption('--skip-build-clang-tools-extra',
                   dest='build_clang_tools_extra'),
+    DisableOption('--skip-build-libxml2', dest='build_libxml2'),
+    DisableOption('--skip-build-zlib', dest='build_zlib'),
+    DisableOption('--skip-build-curl', dest='build_curl'),
 
     ChoicesOption('--compiler-vendor',
                   choices=['none', 'apple']),

utils/swift_build_support/swift_build_support/build_script_invocation.py

@@ -254,7 +254,10 @@ def convert_to_impl_arguments(self):
             (args.build_llbuild, "llbuild"),
             (args.build_libcxx, "libcxx"),
             (args.build_libdispatch, "libdispatch"),
-            (args.build_libicu, "libicu")
+            (args.build_libicu, "libicu"),
+            (args.build_libxml2, 'libxml2'),
+            (args.build_zlib, 'zlib'),
+            (args.build_curl, 'curl')
         ]
         for (should_build, string_name) in conditional_subproject_configs:
             if not should_build and not self.args.infer_dependencies:
@@ -541,6 +544,15 @@ def compute_product_pipelines(self):
         builder.add_product(products.CMark,
                             is_enabled=self.args.build_cmark)
 
+        builder.add_product(products.LibXML2,
+                            is_enabled=self.args.build_libxml2)
+
+        builder.add_product(products.zlib.Zlib,
+                            is_enabled=self.args.build_zlib)
+
+        builder.add_product(products.curl.LibCurl,
+                            is_enabled=self.args.build_curl)
+
         # Begin a build-script-impl pipeline for handling the compiler toolchain
         # and a subset of the tools that we build. We build these in this manner
         # to preserve current build-script-impl run behavior as we transition

utils/swift_build_support/swift_build_support/products/__init__.py

@@ -13,12 +13,14 @@
 from .backdeployconcurrency import BackDeployConcurrency
 from .benchmarks import Benchmarks
 from .cmark import CMark
+from .curl import LibCurl
 from .earlyswiftdriver import EarlySwiftDriver
 from .foundation import Foundation
 from .indexstoredb import IndexStoreDB
 from .libcxx import LibCXX
 from .libdispatch import LibDispatch
 from .libicu import LibICU
+from .libxml2 import LibXML2
 from .llbuild import LLBuild
 from .lldb import LLDB
 from .llvm import LLVM
@@ -37,6 +39,7 @@
 from .swiftsyntax import SwiftSyntax
 from .tsan_libdispatch import TSanLibDispatch
 from .xctest import XCTest
+from .zlib import Zlib
 
 __all__ = [
     'BackDeployConcurrency',
@@ -46,6 +49,9 @@
     'LibCXX',
     'LibDispatch',
     'LibICU',
+    'LibXML2',
+    'Zlib',
+    'LibCurl',
     'LLBuild',
     'LLDB',
     'LLVM',