Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Share build-script-helper between both tools
This change pulls build-script-helper up to the root of the repository and adds a --package-dir option so it can build either SourceKitStressTester or SwiftEvolve. Actually using this script requires matching changes in apple/swift; to help ease the transition, this commit leaves the old build-script-helper in place for now.
- Loading branch information
Showing
5 changed files
with
275 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,257 @@ | ||
| #!/usr/bin/env python | ||
|
|
||
| """ | ||
| This source file is part of the Swift.org open source project | ||
| Copyright (c) 2014 - 2018 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 | ||
| ------------------------------------------------------------------------------ | ||
| This is a helper script for the main swift repository's build-script.py that | ||
| knows how to build and install the stress tester utilities given a swift | ||
| workspace. | ||
| """ | ||
|
|
||
| from __future__ import print_function | ||
|
|
||
| import argparse | ||
| import sys | ||
| import os | ||
| import subprocess | ||
|
|
||
| def main(): | ||
| args = parse_args(sys.argv[1:]) | ||
| run(args) | ||
|
|
||
| def parse_args(args): | ||
| parser = argparse.ArgumentParser(prog='BUILD-SCRIPT-HELPER.PY') | ||
|
|
||
| parser.add_argument('--package-dir', default='SourceKitStressTester') | ||
| parser.add_argument('-v', '--verbose', action='store_true', help='log executed commands') | ||
| parser.add_argument('--prefix', help='install path') | ||
| parser.add_argument('--config', default='release') | ||
| parser.add_argument('--build-dir', default='.build') | ||
| parser.add_argument('--swiftc-exec', help='the compiler to use when building this package (default: xcrun -f swiftc)') | ||
| parser.add_argument('--swift-build-exec', help='the swift-build exec to use to build this package (default: xcrun -f swift-build)') | ||
| parser.add_argument('--swift-test-exec', help='the swift-test exec to use to test this package (default: xcrun -f swift-test)') | ||
| parser.add_argument('--swift-package-exec', help='the swift-package exec to use to generate an xcode project for this package (default: xcrun -f swift-package)') | ||
| parser.add_argument('--sourcekitd-dir', help='the directory containing the sourcekitd.framework to use (default: relative to swiftc-exec)') | ||
| parser.add_argument('--swiftsyntax-dir', help='the directory containing SwiftSyntax\'s build products (libSwiftSyntax.dylib, and SwiftSyntax.swiftmodule)') | ||
| parser.add_argument('build_actions', help="Extra actions to perform. Can be any number of the following: [all, test, install, generate-xcodeproj]", nargs="*", default=[]) | ||
|
|
||
| parsed = parser.parse_args(args) | ||
|
|
||
| if ("install" in parsed.build_actions or "all" in parsed.build_actions) and not parsed.prefix: | ||
| ArgumentParser.error("'--prefix' is required with the install action") | ||
| if parsed.swiftc_exec is None: | ||
| parsed.swiftc_exec = find_executable('swiftc') | ||
| if parsed.swift_build_exec is None: | ||
| parsed.swift_build_exec = find_executable('swift-build') | ||
| if parsed.swift_test_exec is None: | ||
| parsed.swift_test_exec = find_executable('swift-test') | ||
| if parsed.swift_package_exec is None: | ||
| parsed.swift_package_exec = find_executable('swift-package') | ||
| if parsed.sourcekitd_dir is None: | ||
| parsed.sourcekitd_dir = os.path.join(os.path.dirname(os.path.dirname(parsed.swiftc_exec)), 'lib') | ||
|
|
||
| # Convert package_dir to absolute path, relative to root of repo. | ||
| repo_path = os.path.dirname(__file__) | ||
| parsed.package_dir = os.path.realpath( | ||
| os.path.join(repo_path, parsed.package_dir)) | ||
|
|
||
| # Convert build_dir to absolute path, relative to package_dir. | ||
| parsed.build_dir = os.path.join(parsed.package_dir, '.build') | ||
|
|
||
| return parsed | ||
|
|
||
| def run(args): | ||
| if args.swiftsyntax_dir is None: | ||
| print("** Building SwiftSyntax **") | ||
| swiftsyntax_build_dir = os.path.join(PACKAGE_DIR, '.swiftsyntax_build') | ||
| build_swiftsyntax(swift_build_exec=args.swift_build_exec, | ||
| swiftc_exec=args.swiftc_exec, | ||
| build_dir=swiftsyntax_build_dir, | ||
| config=args.config, | ||
| verbose=args.verbose) | ||
| args.swiftsyntax_dir = os.path.join(swiftsyntax_build_dir, args.config) | ||
|
|
||
| sourcekit_searchpath=args.sourcekitd_dir | ||
| swiftsyntax_searchpath=args.swiftsyntax_dir | ||
| package_name = os.path.basename(args.package_dir) | ||
|
|
||
| print("** Building %s **" % package_name) | ||
| build_package(args.package_dir, | ||
| swift_build_exec=args.swift_build_exec, | ||
| swiftc_exec=args.swiftc_exec, | ||
| sourcekit_searchpath=sourcekit_searchpath, | ||
| swiftsyntax_searchpath=swiftsyntax_searchpath, | ||
| build_dir=args.build_dir, | ||
| config=args.config, | ||
| verbose=args.verbose) | ||
|
|
||
| output_dir = os.path.realpath(os.path.join(args.build_dir, args.config)) | ||
|
|
||
| if "generate-xcodeproj" in args.build_actions or "all" in args.build_actions: | ||
| print("** Generating Xcode project for %s **" % package_name) | ||
| generate_xcodeproj(args.package_dir, | ||
| swift_package_exec=args.swift_package_exec, | ||
| sourcekit_searchpath=sourcekit_searchpath, | ||
| swiftsyntax_searchpath=swiftsyntax_searchpath, | ||
| verbose=args.verbose) | ||
|
|
||
| if "test" in args.build_actions or "all" in args.build_actions: | ||
| print("** Testing %s **" % package_name) | ||
| build_package(args.package_dir, | ||
| swift_build_exec=args.swift_test_exec, | ||
| swiftc_exec=args.swiftc_exec, | ||
| sourcekit_searchpath=sourcekit_searchpath, | ||
| swiftsyntax_searchpath=swiftsyntax_searchpath, | ||
| # note: test uses a different build_dir so it doesn't interfere with the 'build' step's products before install | ||
| build_dir=os.path.join(args.build_dir, 'test-build'), | ||
| config='debug', | ||
| verbose=args.verbose) | ||
|
|
||
| if "install" in args.build_actions or "all" in args.build_actions: | ||
| print("** Installing %s **" % package_name) | ||
| stdlib_dir = os.path.join(os.path.dirname(os.path.dirname(args.swiftc_exec)), 'lib', 'swift', 'macosx') | ||
| install_package(args.package_dir, | ||
| install_dir=args.prefix, | ||
| sourcekit_searchpath=sourcekit_searchpath, | ||
| swiftsyntax_searchpath=swiftsyntax_searchpath, | ||
| build_dir=output_dir, | ||
| rpaths_to_delete=[stdlib_dir], | ||
| verbose=args.verbose) | ||
|
|
||
|
|
||
| def build_package(package_dir, swift_build_exec, swiftc_exec, sourcekit_searchpath, swiftsyntax_searchpath, build_dir, config='release', verbose=False): | ||
| env = dict(os.environ) | ||
| env['SWIFT_EXEC'] = swiftc_exec | ||
|
|
||
| swiftc_args = ['-lSwiftSyntax', '-I', swiftsyntax_searchpath, '-L', swiftsyntax_searchpath, '-Fsystem', sourcekit_searchpath] | ||
| linker_args = ['-rpath', swiftsyntax_searchpath, '-rpath', sourcekit_searchpath] | ||
| args = [swift_build_exec, '--package-path', package_dir, '-c', config, '--build-path', build_dir] + interleave('-Xswiftc', swiftc_args) + interleave('-Xlinker', linker_args) | ||
| check_call(args, env=env, verbose=verbose) | ||
|
|
||
|
|
||
| def install_package(package_dir, install_dir, sourcekit_searchpath, swiftsyntax_searchpath, build_dir, rpaths_to_delete=[], verbose=False): | ||
| bin_dir = os.path.join(install_dir, 'bin') | ||
| lib_dir = os.path.join(install_dir, 'lib', 'swift', 'macosx') | ||
|
|
||
| for directory in [bin_dir, lib_dir]: | ||
| if not os.path.exists(directory): | ||
| os.makedirs(directory) | ||
|
|
||
| # Install sk-stress-test and sk-swiftc-wrapper | ||
| for product in get_products(package_dir): | ||
| src = os.path.join(build_dir, product) | ||
| dest = os.path.join(bin_dir, product) | ||
| rpaths_to_delete += [sourcekit_searchpath, swiftsyntax_searchpath] | ||
| rpaths_to_add = ['@executable_path/../lib/swift/macosx', '@executable_path/../lib'] | ||
| swiftsyntax_src = os.path.join(swiftsyntax_searchpath, 'libSwiftSyntax.dylib') | ||
| loadpath_changes = {os.path.realpath(swiftsyntax_src): '@rpath/libswiftSwiftSyntax.dylib'} | ||
|
|
||
| install(src, dest, | ||
| rpaths_to_delete=rpaths_to_delete, | ||
| rpaths_to_add=rpaths_to_add, | ||
| loadpath_changes=loadpath_changes, | ||
| verbose=verbose) | ||
|
|
||
| def install(src, dest, rpaths_to_delete=[], rpaths_to_add=[], loadpath_changes={}, dylib_id=None, verbose=False): | ||
| copy_cmd=['rsync', '-a', src, dest] | ||
| print('installing %s to %s' % (os.path.basename(src), dest)) | ||
| check_call(copy_cmd, verbose=verbose) | ||
|
|
||
| if dylib_id is not None: | ||
| check_call(['install_name_tool', '-id', dylib_id, dest], verbose=verbose) | ||
|
|
||
| for rpath in rpaths_to_delete: | ||
| remove_rpath(dest, rpath, verbose=verbose) | ||
| for rpath in rpaths_to_add: | ||
| add_rpath(dest, rpath, verbose=verbose) | ||
|
|
||
| for key, value in loadpath_changes.iteritems(): | ||
| check_call(['install_name_tool', '-change', key, value, dest], verbose=verbose) | ||
|
|
||
|
|
||
| def build_swiftsyntax(swift_build_exec, swiftc_exec, build_dir, config='release', verbose=False): | ||
| workspace = os.path.dirname(os.path.dirname(PACKAGE_DIR)) | ||
| cmd = [os.path.join(workspace, 'swift-syntax', 'build-script.py'), | ||
| '--build-dir', os.path.join(PACKAGE_DIR, '.swiftsyntax_build'), | ||
| '--swiftc-exec', swiftc_exec, | ||
| '--swift-build-exec', swift_build_exec] | ||
|
|
||
| if config == 'release': | ||
| cmd += ['--release'] | ||
|
|
||
| env = dict(os.environ) | ||
| check_call(cmd, env=env, verbose=verbose) | ||
|
|
||
|
|
||
| def generate_xcodeproj(package_dir, swift_package_exec, sourcekit_searchpath, swiftsyntax_searchpath, verbose=False): | ||
| config_path = os.path.join(package_dir, 'Config.xcconfig') | ||
| with open(config_path, 'w') as config_file: | ||
| config_file.write(''' | ||
| SWIFT_INCLUDE_PATHS = {swiftsyntax_searchpath} $(inherited) | ||
| SYSTEM_FRAMEWORK_SEARCH_PATHS = {sourcekit_searchpath} $(inherited) | ||
| LIBRARY_SEARCH_PATHS = {swiftsyntax_searchpath} $(inherited) | ||
| LD_RUNPATH_SEARCH_PATHS = {sourcekit_searchpath} {swiftsyntax_searchpath} $(inherited) | ||
| '''.format(sourcekit_searchpath=sourcekit_searchpath, swiftsyntax_searchpath=swiftsyntax_searchpath)) | ||
|
|
||
| env = dict(os.environ) | ||
| args = [swift_package_exec, 'generate-xcodeproj', '--xcconfig-overrides', config_path, '--output', os.path.join(package_dir, 'SourceKitStressTester.xcodeproj')] | ||
| check_call(args, env=env, verbose=verbose) | ||
|
|
||
| def add_rpath(binary, rpath, verbose=False): | ||
| cmd = ['install_name_tool', '-add_rpath', rpath, binary] | ||
| check_call(cmd, verbose=verbose) | ||
|
|
||
|
|
||
| def remove_rpath(binary, rpath, verbose=False): | ||
| cmd = ['install_name_tool', '-delete_rpath', rpath, binary] | ||
| check_call(cmd, verbose=verbose) | ||
|
|
||
|
|
||
| def check_output(cmd, env=os.environ, verbose=False, **kwargs): | ||
| if verbose: | ||
| print(' '.join([escape_cmd_arg(arg) for arg in cmd])) | ||
| return subprocess.check_output(cmd, env=env, stderr=subprocess.STDOUT, **kwargs) | ||
|
|
||
|
|
||
| def check_call(cmd, env=os.environ, verbose=False, **kwargs): | ||
| if verbose: | ||
| print(' '.join([escape_cmd_arg(arg) for arg in cmd])) | ||
| return subprocess.check_call(cmd, env=env, stderr=subprocess.STDOUT, **kwargs) | ||
|
|
||
|
|
||
| def interleave(value, list): | ||
| return [item for pair in zip([value] * len(list), list) for item in pair] | ||
|
|
||
|
|
||
| def find_executable(executable, toolchain=None): | ||
| if os.path.isfile(executable) and os.access(executable, os.X_OK): | ||
| return executable | ||
| extra_args = ['--toolchain', toolchain] if toolchain else [] | ||
| return check_output(['xcrun', '-f', executable] + extra_args).rstrip() | ||
|
|
||
|
|
||
| def escape_cmd_arg(arg): | ||
| if '"' in arg or ' ' in arg: | ||
| return '"%s"' % arg.replace('"', '\\"') | ||
| else: | ||
| return arg | ||
|
|
||
| def get_products(package_dir): | ||
| # FIXME: We ought to be able to query SwiftPM for this info. | ||
| if package_dir.endswith("/SourceKitStressTester"): | ||
| return ['sk-stress-test', 'sk-swiftc-wrapper'] | ||
| elif package_dir.endswith("/SwiftEvolve"): | ||
| return ['swift-evolve'] | ||
| else: | ||
| return [] | ||
|
|
||
| if __name__ == '__main__': | ||
| main() |