Add zlib build product

This patch adds a zlib and static-zlib build product, respectively
producing a dynamic and static zlib library. This is a dependency of
building Foundation.

Author: etcwilde

utils/build-script-impl

@@ -266,6 +266,7 @@ components=(
   libdispatch
   libicu
   libxml2
+  zlib
   llbuild
   lldb
   llvm
@@ -2542,6 +2543,30 @@ for host in "${ALL_HOSTS[@]}"; do
                     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_CLEAN_FOUNDATION}" == "0" ]]
                 then
                   # The Swift project might have been changed, but CMake might
@@ -2570,6 +2595,8 @@ for host in "${ALL_HOSTS[@]}"; do
 
                   ${LIBXML2_BUILD_ARGS[@]}
 
+                  ${ZLIB_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

@@ -93,6 +93,9 @@ def _apply_default_arguments(args):
     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
+
     # Assertions are enabled by default.
     if args.assertions is None:
         args.assertions = True
@@ -715,6 +718,9 @@ def create_argument_parser():
     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('--playgroundsupport', toggle_true('build_playgroundsupport'),
            help='build PlaygroundSupport')
     option('--install-playgroundsupport',
@@ -830,6 +836,9 @@ def create_argument_parser():
            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')
 
     # -------------------------------------------------------------------------
     # Assertions group
@@ -1265,6 +1274,8 @@ def create_argument_parser():
            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')
 
     # We need to list --skip-test-swift explicitly because otherwise argparse
     # will auto-expand arguments like --skip-test-swift to the only known
@@ -1344,6 +1355,7 @@ def create_argument_parser():
                      /swift-corelibs-libdispatch (optional)
                      /icu                        (optional)
                      /libxml2                    (optional)
+                     /zlib                       (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

@@ -67,6 +67,7 @@
     'build_libdispatch': False,
     'build_libicu': False,
     'build_libxml2': False,
+    'build_zlib': False,
     'build_linux': True,
     'build_llbuild': False,
     'build_lldb': False,
@@ -183,6 +184,7 @@
     'libdispatch_build_variant': 'Debug',
     'libicu_build_variant': 'Debug',
     'libxml2_build_variant': 'Debug',
+    'zlib_build_variant': 'Debug',
     'bootstrapping_mode': None,
     'lit_args': '-sv',
     'llbuild_assertions': True,
@@ -432,6 +434,7 @@ class BuildScriptImplOption(_BaseOption):
               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-lldb', dest='lldb_build_variant', value='Debug'),
     SetOption('--lldb-build-with-xcode', dest='lldb_build_with_xcode',
               value='1'),
@@ -564,6 +567,7 @@ class BuildScriptImplOption(_BaseOption):
     EnableOption('--libdispatch', dest='build_libdispatch'),
     EnableOption('--libicu', dest='build_libicu'),
     EnableOption('--static-libxml2', dest='build_libxml2'),
+    EnableOption('--static-zlib', dest='build_zlib'),
     EnableOption('--indexstore-db', dest='build_indexstoredb'),
     EnableOption('--test-indexstore-db-sanitize-all',
                  dest='test_indexstoredb_sanitize_all'),
@@ -668,6 +672,7 @@ class BuildScriptImplOption(_BaseOption):
     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'),
 
     ChoicesOption('--compiler-vendor',
                   choices=['none', 'apple']),

utils/swift_build_support/swift_build_support/build_script_invocation.py

@@ -255,7 +255,8 @@ def convert_to_impl_arguments(self):
             (args.build_libcxx, "libcxx"),
             (args.build_libdispatch, "libdispatch"),
             (args.build_libicu, "libicu"),
-            (args.build_libxml2, 'libxml2')
+            (args.build_libxml2, 'libxml2'),
+            (args.build_zlib, 'zlib')
         ]
         for (should_build, string_name) in conditional_subproject_configs:
             if not should_build and not self.args.infer_dependencies:
@@ -545,6 +546,9 @@ def compute_product_pipelines(self):
         builder.add_product(products.LibXML2,
                             is_enabled=self.args.build_libxml2)
 
+        builder.add_product(products.zlib.Zlib,
+                            is_enabled=self.args.build_zlib)
+
         # 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

@@ -38,6 +38,7 @@
 from .swiftsyntax import SwiftSyntax
 from .tsan_libdispatch import TSanLibDispatch
 from .xctest import XCTest
+from .zlib import Zlib
 
 __all__ = [
     'BackDeployConcurrency',
@@ -48,6 +49,7 @@
     'LibDispatch',
     'LibICU',
     'LibXML2',
+    'Zlib',
     'LLBuild',
     'LLDB',
     'LLVM',

utils/swift_build_support/swift_build_support/products/foundation.py

@@ -18,6 +18,7 @@
 from . import llvm
 from . import product
 from . import swift
+from . import zlib
 
 
 class Foundation(product.Product):
@@ -53,7 +54,8 @@ def get_dependencies(cls):
                 libicu.LibICU,
                 swift.Swift,
                 libdispatch.LibDispatch,
-                libxml2.LibXML2]
+                libxml2.LibXML2,
+                zlib.Zlib]
 
     @classmethod
     def is_nondarwin_only_build_product(cls):

utils/swift_build_support/swift_build_support/products/zlib.py

@@ -0,0 +1,98 @@
+# swift_build_support/products/zlib.py ------------------------------------
+#
+# This source file is part of the Swift.org open source project
+#
+# Copyright (c) 2014 - 2017 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
+#
+# ----------------------------------------------------------------------------
+
+from . import cmake_product
+from . import earlyswiftdriver
+
+
+class Zlib(cmake_product.CMakeProduct):
+    @classmethod
+    def is_build_script_impl_product(cls):
+        """is_build_script_impl_product -> bool
+
+        Whether this product is produced by build-script-impl
+        """
+        return False
+
+    @classmethod
+    def is_before_build_script_impl_product(cls):
+        """is_before_build_script_impl_product -> bool
+
+        Whether this product is built before any build-script-impl products
+        """
+        return True
+
+    @classmethod
+    def is_nondarwin_only_build_product(cls):
+        return True
+
+    @classmethod
+    def get_dependencies(cls):
+        return [earlyswiftdriver.EarlySwiftDriver]
+
+    def should_build(self, host_target):
+        """should_build() -> Bool
+
+        Return True if zlib should be built
+        """
+        return self.args.build_zlib
+
+    def should_test(self, host_target):
+        """should_test() -> Bool
+
+        Returns True if zlib should be tested.
+        Currently is set to false
+        """
+        return False
+
+    def should_install(self, host_target):
+        """should_install() -> Bool
+
+        Returns True
+        If we're building zlib, you're going to need it
+        """
+        return self.args.build_zlib
+
+    def install(self, host_target):
+        """
+        Install zlib to the target location
+        """
+        path = self.host_install_destdir(host_target)
+        self.install_with_cmake(['install'], path)
+
+    def build(self, host_target):
+        self.cmake_options.define('BUILD_SHARED_LIBS', 'NO')
+        self.cmake_options.define('CMAKE_POSITION_INDEPENDENT_CODE', 'YES')
+
+        if self.args.zlib_build_variant is None:
+            self.args.zlib_build_variant = "Release"
+        self.cmake_options.define('CMAKE_BUILD_TYPE:STRING',
+                                  self.args.zlib_build_variant)
+        self.cmake_options.define('CMAKE_BUILD_TYPE', 'RELEASE')
+        self.cmake_options.define('SKIP_INSTALL_FILES', 'YES')
+        self.cmake_options.define('CMAKE_INSTALL_PREFIX', '/usr')
+
+        (platform, arch) = host_target.split('-')
+        common_c_flags = ' '.join(self.common_cross_c_flags(platform, arch))
+        self.cmake_options.define('CMAKE_C_FLAGS', common_c_flags)
+        self.cmake_options.define('CMAKE_CXX_FLAGS', common_c_flags)
+
+        if host_target.startswith("macosx") or \
+           host_target.startswith("iphone") or \
+           host_target.startswith("appletv") or \
+           host_target.startswith("watch"):
+            toolchain_file = self.generate_darwin_toolchain_file(platform, arch)
+            self.cmake_options.define('CMAKE_TOOLCHAIN_FILE:PATH', toolchain_file)
+        elif platform == "linux":
+            toolchain_file = self.generate_linux_toolchain_file(platform, arch)
+            self.cmake_options.define('CMAKE_TOOLCHAIN_FILE:PATH', toolchain_file)
+        self.build_with_cmake(["all"], self.args.zlib_build_variant, [])