Files
swift-mirror/tools/SourceKit/cmake/modules/AddSwiftSourceKit.cmake
Kavon Farvardin 771c99f895 cmake: add support for bootstrapping with swiftly
For hosts that have a swiftly-managed Swift compiler, we could not
bootstrap using those tools, because of some hardcoded assumptions
about where the `/lib` directory lives, relative to the `/bin`
directory that contains the detected `swiftc`.

This patch adds specific support for detecting when the `swiftc`
is coming from a swiftly install and uses the correct paths.

I've tested this patch on my Linux machine that has swiftly 1.0.1,
with the Swift 6.1.2 toolchain.
2025-08-13 14:41:01 -07:00

613 lines
26 KiB
CMake

# Add default compiler and linker flags to 'target'.
#
# FIXME: this is a HACK. All SourceKit CMake code using this function should be
# rewritten to use 'add_swift_host_library' or 'add_swift_target_library'.
function(add_sourcekit_default_compiler_flags target)
# Add variant-specific flags.
_add_host_variant_c_compile_flags(${target})
_add_host_variant_link_flags(${target})
# Set compilation and link flags.
if(SWIFT_HOST_VARIANT_SDK STREQUAL "WINDOWS")
swift_windows_include_for_arch(${SWIFT_HOST_VARIANT_ARCH}
${SWIFT_HOST_VARIANT_ARCH}_INCLUDE)
target_include_directories(${target} SYSTEM PRIVATE
${${SWIFT_HOST_VARIANT_ARCH}_INCLUDE})
endif()
target_compile_options(${target} PRIVATE
-fblocks)
endfunction()
function(add_sourcekit_swift_runtime_link_flags target path HAS_SWIFT_MODULES)
set(RPATH_LIST)
# If we are linking in the Swift Swift parser, we at least need host tools
# to do it.
set(ASKD_BOOTSTRAPPING_MODE ${BOOTSTRAPPING_MODE})
if (NOT ASKD_BOOTSTRAPPING_MODE)
if (SWIFT_BUILD_SWIFT_SYNTAX)
set(ASKD_BOOTSTRAPPING_MODE HOSTTOOLS)
endif()
endif()
if(SWIFT_HOST_VARIANT_SDK IN_LIST SWIFT_DARWIN_PLATFORMS)
# Lists of rpaths that we are going to add to our executables.
#
# Please add each rpath separately below to the list, explaining why you are
# adding it.
set(sdk_dir "${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_ARCH_${SWIFT_HOST_VARIANT_ARCH}_PATH}/usr/lib/swift")
# If we found a swift compiler and are going to use swift code in swift
# host side tools but link with clang, add the appropriate -L paths so we
# find all of the necessary swift libraries on Darwin.
if (HAS_SWIFT_MODULES AND ASKD_BOOTSTRAPPING_MODE)
if(ASKD_BOOTSTRAPPING_MODE STREQUAL "HOSTTOOLS")
# Add in the toolchain directory so we can grab compatibility libraries
get_filename_component(TOOLCHAIN_BIN_DIR ${SWIFT_EXEC_FOR_SWIFT_MODULES} DIRECTORY)
get_filename_component(TOOLCHAIN_LIB_DIR "${TOOLCHAIN_BIN_DIR}/../lib/swift/macosx" ABSOLUTE)
target_link_directories(${target} PUBLIC ${TOOLCHAIN_LIB_DIR})
# Add the SDK directory for the host platform.
target_link_directories(${target} PRIVATE "${sdk_dir}")
# Include the abi stable system stdlib in our rpath.
list(APPEND RPATH_LIST "/usr/lib/swift")
elseif(ASKD_BOOTSTRAPPING_MODE STREQUAL "CROSSCOMPILE-WITH-HOSTLIBS")
# Intentionally don't add the lib dir of the cross-compiled compiler, so that
# the stdlib is not picked up from there, but from the SDK.
# This requires to explicitly add all the needed compatibility libraries. We
# can take them from the current build.
target_link_libraries(${target} PUBLIC HostCompatibilityLibs)
# Add the SDK directory for the host platform.
target_link_directories(${target} PRIVATE "${sdk_dir}")
# Include the abi stable system stdlib in our rpath.
list(APPEND RPATH_LIST "/usr/lib/swift")
elseif(ASKD_BOOTSTRAPPING_MODE STREQUAL "BOOTSTRAPPING-WITH-HOSTLIBS")
# Add the SDK directory for the host platform.
target_link_directories(${target} PRIVATE "${sdk_dir}")
# A backup in case the toolchain doesn't have one of the compatibility libraries.
target_link_directories(${target} PRIVATE
"${SWIFTLIB_DIR}/${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}")
# Include the abi stable system stdlib in our rpath.
list(APPEND RPATH_LIST "/usr/lib/swift")
elseif(ASKD_BOOTSTRAPPING_MODE STREQUAL "BOOTSTRAPPING")
# At build time link against the built swift libraries from the
# previous bootstrapping stage.
get_bootstrapping_swift_lib_dir(bs_lib_dir "")
target_link_directories(${target} PRIVATE ${bs_lib_dir})
# Required to pick up the built libswiftCompatibility<n>.a libraries
target_link_directories(${target} PRIVATE
"${SWIFTLIB_DIR}/${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}")
# At runtime link against the built swift libraries from the current
# bootstrapping stage.
file(RELATIVE_PATH relative_rtlib_path "${path}" "${SWIFTLIB_DIR}/${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}")
list(APPEND RPATH_LIST "@loader_path/${relative_rtlib_path}")
else()
message(FATAL_ERROR "Unknown ASKD_BOOTSTRAPPING_MODE '${ASKD_BOOTSTRAPPING_MODE}'")
endif()
# Workaround for a linker crash related to autolinking: rdar://77839981
set_property(TARGET ${target} APPEND_STRING PROPERTY
LINK_FLAGS " -lobjc ")
endif() # HAS_SWIFT_MODULES AND ASKD_BOOTSTRAPPING_MODE
elseif(SWIFT_HOST_VARIANT_SDK MATCHES "LINUX|ANDROID|FREEBSD|OPENBSD" AND HAS_SWIFT_MODULES AND ASKD_BOOTSTRAPPING_MODE)
set(swiftrt "swiftImageRegistrationObject${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_OBJECT_FORMAT}-${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}-${SWIFT_HOST_VARIANT_ARCH}")
if(ASKD_BOOTSTRAPPING_MODE MATCHES "HOSTTOOLS|CROSSCOMPILE")
if(ASKD_BOOTSTRAPPING_MODE MATCHES "HOSTTOOLS")
# At build time and run time, link against the swift libraries in the
# installed host toolchain.
get_filename_component(swift_bin_dir ${SWIFT_EXEC_FOR_SWIFT_MODULES} DIRECTORY)
get_filename_component(swift_dir ${swift_bin_dir} DIRECTORY)
# Detect and handle swiftly-managed hosts.
if(swift_bin_dir MATCHES ".*/swiftly/bin")
execute_process(COMMAND swiftly use --print-location
OUTPUT_VARIABLE swiftly_dir
ERROR_VARIABLE err)
if(err)
message(SEND_ERROR "Failed to find swiftly Swift compiler")
endif()
string(STRIP "${swiftly_dir}" swiftly_dir)
set(swift_dir "${swiftly_dir}/usr")
endif()
set(host_lib_dir "${swift_dir}/lib/swift/${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}")
else()
set(host_lib_dir "${SWIFTLIB_DIR}/${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}")
endif()
set(host_lib_arch_dir "${host_lib_dir}/${SWIFT_HOST_VARIANT_ARCH}")
set(swiftrt "${host_lib_arch_dir}/swiftrt${CMAKE_C_OUTPUT_EXTENSION}")
target_link_libraries(${target} PRIVATE ${swiftrt})
target_link_libraries(${target} PRIVATE "swiftCore")
target_link_directories(${target} PRIVATE ${host_lib_dir})
target_link_directories(${target} PRIVATE ${host_lib_arch_dir})
file(RELATIVE_PATH relative_rtlib_path "${path}" "${SWIFTLIB_DIR}/${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}")
list(APPEND RPATH_LIST "$ORIGIN/${relative_rtlib_path}")
# NOTE: SourceKit components are NOT executed before stdlib is built.
# So there's no need to add RUNPATH to builder's runtime libraries.
elseif(ASKD_BOOTSTRAPPING_MODE STREQUAL "BOOTSTRAPPING")
get_bootstrapping_swift_lib_dir(bs_lib_dir "")
target_link_directories(${target} PRIVATE ${bs_lib_dir})
target_link_libraries(${target} PRIVATE ${swiftrt})
target_link_libraries(${target} PRIVATE "swiftCore")
# At runtime link against the built swift libraries from the current
# bootstrapping stage.
file(RELATIVE_PATH relative_rtlib_path "${path}" "${SWIFTLIB_DIR}/${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}")
list(APPEND RPATH_LIST "$ORIGIN/${relative_rtlib_path}")
elseif(ASKD_BOOTSTRAPPING_MODE STREQUAL "BOOTSTRAPPING-WITH-HOSTLIBS")
message(FATAL_ERROR "ASKD_BOOTSTRAPPING_MODE 'BOOTSTRAPPING-WITH-HOSTLIBS' not supported on Linux")
else()
message(FATAL_ERROR "Unknown ASKD_BOOTSTRAPPING_MODE '${ASKD_BOOTSTRAPPING_MODE}'")
endif()
elseif(SWIFT_HOST_VARIANT_SDK STREQUAL "WINDOWS")
if(ASKD_BOOTSTRAPPING_MODE MATCHES "HOSTTOOLS")
set(swiftrt_obj
${SWIFT_PATH_TO_SWIFT_SDK}/usr/lib/swift/${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}/${SWIFT_HOST_VARIANT_ARCH}/swiftrt${CMAKE_C_OUTPUT_EXTENSION})
target_link_libraries(${target} PRIVATE ${swiftrt_obj})
endif()
endif()
if(SWIFT_BUILD_SWIFT_SYNTAX)
if(SWIFT_HOST_VARIANT_SDK IN_LIST SWIFT_DARWIN_PLATFORMS)
# Add rpath to the host Swift libraries.
file(RELATIVE_PATH relative_hostlib_path "${path}" "${SWIFTLIB_DIR}/host/compiler")
list(APPEND RPATH_LIST "@loader_path/${relative_hostlib_path}")
elseif(SWIFT_HOST_VARIANT_SDK MATCHES "LINUX|ANDROID|FREEBSD|OPENBSD")
# Add rpath to the host Swift libraries.
file(RELATIVE_PATH relative_hostlib_path "${path}" "${SWIFTLIB_DIR}/host/compiler")
list(APPEND RPATH_LIST "$ORIGIN/${relative_hostlib_path}")
else()
target_link_directories(${target} PRIVATE
${SWIFT_PATH_TO_SWIFT_SDK}/usr/lib/swift/${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}/${SWIFT_HOST_VARIANT_ARCH})
endif()
# For the "end step" of bootstrapping configurations on Darwin, need to be
# able to fall back to the SDK directory for libswiftCore et al.
if (BOOTSTRAPPING_MODE MATCHES "BOOTSTRAPPING.*")
if(SWIFT_HOST_VARIANT_SDK IN_LIST SWIFT_DARWIN_PLATFORMS)
target_link_directories(${target} PRIVATE "${sdk_dir}")
# Include the abi stable system stdlib in our rpath.
set(swift_runtime_rpath "/usr/lib/swift")
# Add in the toolchain directory so we can grab compatibility libraries
get_filename_component(TOOLCHAIN_BIN_DIR ${SWIFT_EXEC_FOR_SWIFT_MODULES} DIRECTORY)
get_filename_component(TOOLCHAIN_LIB_DIR "${TOOLCHAIN_BIN_DIR}/../lib/swift/${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}" ABSOLUTE)
target_link_directories(${target} PUBLIC ${TOOLCHAIN_LIB_DIR})
endif()
endif()
if(SWIFT_HOST_VARIANT_SDK IN_LIST SWIFT_DARWIN_PLATFORMS AND SWIFT_ALLOW_LINKING_SWIFT_CONTENT_IN_DARWIN_TOOLCHAIN)
get_filename_component(TOOLCHAIN_BIN_DIR ${CMAKE_Swift_COMPILER} DIRECTORY)
get_filename_component(TOOLCHAIN_LIB_DIR "${TOOLCHAIN_BIN_DIR}/../lib/swift/${SWIFT_SDK_${SWIFT_HOST_VARIANT_SDK}_LIB_SUBDIR}" ABSOLUTE)
target_link_directories(${target} BEFORE PUBLIC ${TOOLCHAIN_LIB_DIR})
endif()
endif()
set(RPATH_LIST ${RPATH_LIST} PARENT_SCOPE)
endfunction()
# Add a new SourceKit library.
#
# Usage:
# add_sourcekit_library(name # Name of the library
# [DEPENDS dep1 ...] # Targets this library depends on
# [LLVM_LINK_COMPONENTS comp1 ...] # LLVM components this library depends on
# [INSTALL_IN_COMPONENT comp] # The Swift installation component that this library belongs to.
# [SHARED]
# [HAS_SWIFT_MODULES] # Whether to link SwiftCompilerModules
# source1 [source2 source3 ...]) # Sources to add into this library
macro(add_sourcekit_library name)
cmake_parse_arguments(SOURCEKITLIB
"SHARED;HAS_SWIFT_MODULES"
"INSTALL_IN_COMPONENT"
"HEADERS;DEPENDS;LLVM_LINK_COMPONENTS"
${ARGN})
set(srcs ${SOURCEKITLIB_UNPARSED_ARGUMENTS})
llvm_process_sources(srcs ${srcs})
if(MSVC_IDE)
# Add public headers
file(RELATIVE_PATH lib_path
${SOURCEKIT_SOURCE_DIR}/lib/
${CMAKE_CURRENT_SOURCE_DIR}
)
if(NOT lib_path MATCHES "^[.][.]")
file(GLOB_RECURSE headers
${SOURCEKIT_SOURCE_DIR}/include/SourceKit/${lib_path}/*.h
${SOURCEKIT_SOURCE_DIR}/include/SourceKit/${lib_path}/*.def
)
set_source_files_properties(${headers} PROPERTIES HEADER_FILE_ONLY ON)
file(GLOB_RECURSE tds
${SOURCEKIT_SOURCE_DIR}/include/SourceKit/${lib_path}/*.td
)
source_group("TableGen descriptions" FILES ${tds})
set_source_files_properties(${tds} PROPERTIES HEADER_FILE_ONLY ON)
set(srcs ${srcs} ${headers} ${tds})
endif()
endif()
if (MODULE)
set(libkind MODULE)
elseif(SOURCEKITLIB_SHARED)
set(libkind SHARED)
else()
set(libkind)
endif()
add_library(${name} ${libkind} ${srcs})
if(NOT SWIFT_BUILT_STANDALONE AND SOURCEKIT_SWIFT_SWAP_COMPILER)
add_dependencies(${name} clang)
endif()
llvm_update_compile_flags(${name})
set_target_properties(${name} PROPERTIES LINKER_LANGUAGE CXX)
set_output_directory(${name}
BINARY_DIR ${SOURCEKIT_RUNTIME_OUTPUT_INTDIR}
LIBRARY_DIR ${SOURCEKIT_LIBRARY_OUTPUT_INTDIR})
if(LLVM_COMMON_DEPENDS)
add_dependencies(${name} ${LLVM_COMMON_DEPENDS})
endif(LLVM_COMMON_DEPENDS)
if(SOURCEKITLIB_DEPENDS)
add_dependencies(${name} ${SOURCEKITLIB_DEPENDS})
endif(SOURCEKITLIB_DEPENDS)
swift_common_llvm_config(${name} ${SOURCEKITLIB_LLVM_LINK_COMPONENTS})
if(SOURCEKITLIB_SHARED AND EXPORTED_SYMBOL_FILE)
add_llvm_symbol_exports(${name} ${EXPORTED_SYMBOL_FILE})
endif()
# Once the new Swift parser is linked, everything has Swift modules.
if (SWIFT_BUILD_SWIFT_SYNTAX AND SOURCEKITLIB_SHARED)
set(SOURCEKITLIB_HAS_SWIFT_MODULES ON)
endif()
if(SOURCEKITLIB_SHARED)
set(RPATH_LIST)
add_sourcekit_swift_runtime_link_flags(${name} ${SOURCEKIT_LIBRARY_OUTPUT_INTDIR} ${SOURCEKITLIB_HAS_SWIFT_MODULES})
if("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
set_target_properties(${name} PROPERTIES INSTALL_NAME_DIR "@rpath")
endif()
set_target_properties(${name} PROPERTIES BUILD_WITH_INSTALL_RPATH TRUE)
set_target_properties(${name} PROPERTIES INSTALL_RPATH "${RPATH_LIST}")
endif()
if("${SOURCEKITLIB_INSTALL_IN_COMPONENT}" STREQUAL "")
if(SOURCEKITLIB_SHARED)
set(SOURCEKITLIB_INSTALL_IN_COMPONENT tools)
else()
set(SOURCEKITLIB_INSTALL_IN_COMPONENT dev)
endif()
endif()
add_dependencies(${SOURCEKITLIB_INSTALL_IN_COMPONENT} ${name})
swift_install_in_component(TARGETS ${name}
LIBRARY
DESTINATION "lib${LLVM_LIBDIR_SUFFIX}"
COMPONENT "${SOURCEKITLIB_INSTALL_IN_COMPONENT}"
ARCHIVE
DESTINATION "lib${LLVM_LIBDIR_SUFFIX}"
COMPONENT "${SOURCEKITLIB_INSTALL_IN_COMPONENT}"
RUNTIME
DESTINATION "bin"
COMPONENT "${SOURCEKITLIB_INSTALL_IN_COMPONENT}")
swift_install_in_component(FILES ${SOURCEKITLIB_HEADERS}
DESTINATION "include/SourceKit"
COMPONENT "${SOURCEKITLIB_INSTALL_IN_COMPONENT}")
set_target_properties(${name} PROPERTIES FOLDER "SourceKit libraries")
add_sourcekit_default_compiler_flags("${name}")
swift_is_installing_component("${SOURCEKITLIB_INSTALL_IN_COMPONENT}" is_installing)
if(NOT is_installing)
set_property(GLOBAL APPEND PROPERTY SWIFT_BUILDTREE_EXPORTS ${name})
else()
set_property(GLOBAL APPEND PROPERTY SWIFT_EXPORTS ${name})
endif()
endmacro()
# Add a new SourceKit executable.
#
# Usage:
# add_sourcekit_executable(name # Name of the executable
# [LLVM_LINK_COMPONENTS comp1 ...] # LLVM components this executable
# # depends on
# source1 [source2 source3 ...]) # Sources to add into this executable
macro(add_sourcekit_executable name)
set(SOURCEKIT_EXECUTABLE_options)
set(SOURCEKIT_EXECUTABLE_single_parameter_options)
set(SOURCEKIT_EXECUTABLE_multiple_parameter_options LLVM_LINK_COMPONENTS)
cmake_parse_arguments(SOURCEKITEXE "${SOURCEKIT_EXECUTABLE_options}"
"${SOURCEKIT_EXECUTABLE_single_parameter_options}"
"${SOURCEKIT_EXECUTABLE_multiple_parameter_options}" ${ARGN})
add_executable(${name} ${SOURCEKITEXE_UNPARSED_ARGUMENTS})
if(NOT SWIFT_BUILT_STANDALONE AND SOURCEKIT_SWIFT_SWAP_COMPILER)
add_dependencies(${name} clang)
endif()
llvm_update_compile_flags(${name})
set_output_directory(${name}
BINARY_DIR ${SOURCEKIT_RUNTIME_OUTPUT_INTDIR}
LIBRARY_DIR ${SOURCEKIT_LIBRARY_OUTPUT_INTDIR})
# Add appropriate dependencies
if(LLVM_COMMON_DEPENDS)
add_dependencies(${name} ${LLVM_COMMON_DEPENDS})
endif()
swift_common_llvm_config(${name} ${SOURCEKITEXE_LLVM_LINK_COMPONENTS})
target_link_libraries(${name} PRIVATE ${LLVM_COMMON_LIBS})
set_target_properties(${name} PROPERTIES FOLDER "SourceKit executables")
add_sourcekit_default_compiler_flags("${name}")
set_target_properties(${name} PROPERTIES LINKER_LANGUAGE CXX)
endmacro()
# Add a new SourceKit framework.
#
# Usage:
# add_sourcekit_framework(name # Name of the framework
# [LLVM_LINK_COMPONENTS comp1 ...] # LLVM components this framework depends on
# [MODULEMAP modulemap] # Module map file for this framework
# [INSTALL_IN_COMPONENT comp] # The Swift installation component that this framework belongs to.
# [HAS_SWIFT_MODULES] # Whether to link SwiftCompilerModules
# source1 [source2 source3 ...]) # Sources to add into this framework
macro(add_sourcekit_framework name)
cmake_parse_arguments(SOURCEKITFW
"HAS_SWIFT_MODULES" "MODULEMAP;INSTALL_IN_COMPONENT" "LLVM_LINK_COMPONENTS" ${ARGN})
set(srcs ${SOURCEKITFW_UNPARSED_ARGUMENTS})
set(lib_dir ${SOURCEKIT_LIBRARY_OUTPUT_INTDIR})
set(framework_location "${lib_dir}/${name}.framework")
# Once the new Swift parser is linked, everything has Swift modules.
if (SWIFT_BUILD_SWIFT_SYNTAX)
set(SOURCEKITFW_HAS_SWIFT_MODULES ON)
endif()
if (NOT SOURCEKIT_DEPLOYMENT_OS MATCHES "^macosx")
set(FLAT_FRAMEWORK_NAME "${name}")
set(FLAT_FRAMEWORK_IDENTIFIER "org.swift.${name}")
set(FLAT_FRAMEWORK_SHORT_VERSION_STRING "1.0")
set(FLAT_FRAMEWORK_BUNDLE_VERSION "${SOURCEKIT_VERSION_STRING}")
set(FLAT_FRAMEWORK_DEPLOYMENT_TARGET "${SOURCEKIT_DEPLOYMENT_TARGET}")
configure_file(
"${SOURCEKIT_SOURCE_DIR}/cmake/FlatFrameworkInfo.plist.in"
"${CMAKE_CURRENT_BINARY_DIR}/${name}.Info.plist")
add_custom_command(OUTPUT "${framework_location}/Info.plist"
DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/${name}.Info.plist"
COMMAND ${CMAKE_COMMAND} -E copy_if_different
"${CMAKE_CURRENT_BINARY_DIR}/${name}.Info.plist" "${framework_location}/Info.plist")
list(APPEND srcs "${framework_location}/Info.plist")
endif()
llvm_process_sources(srcs ${srcs})
add_library(${name} SHARED ${srcs})
llvm_update_compile_flags(${name})
set_target_properties(${name} PROPERTIES LINKER_LANGUAGE CXX)
set(headers)
foreach(src ${srcs})
get_filename_component(extension ${src} EXT)
if(extension STREQUAL ".h")
list(APPEND headers ${src})
endif()
endforeach()
if(MSVC_IDE)
set_source_files_properties(${headers} PROPERTIES HEADER_FILE_ONLY ON)
endif(MSVC_IDE)
if(LLVM_COMMON_DEPENDS)
add_dependencies(${name} ${LLVM_COMMON_DEPENDS})
endif(LLVM_COMMON_DEPENDS)
swift_common_llvm_config(${name} ${SOURCEKITFW_LLVM_LINK_COMPONENTS})
if (EXPORTED_SYMBOL_FILE)
add_llvm_symbol_exports(${name} ${EXPORTED_SYMBOL_FILE})
endif()
if(SOURCEKITFW_MODULEMAP)
set(modulemap "${CMAKE_CURRENT_SOURCE_DIR}/${SOURCEKITFW_MODULEMAP}")
set_property(TARGET ${name} APPEND PROPERTY LINK_DEPENDS "${modulemap}")
if (SOURCEKIT_DEPLOYMENT_OS MATCHES "^macosx")
set(modules_dir "${framework_location}/Versions/A/Modules")
add_custom_command(TARGET ${name} PRE_BUILD
COMMAND ${CMAKE_COMMAND} -E copy "${modulemap}" "${modules_dir}/module.modulemap"
COMMAND ${CMAKE_COMMAND} -E create_symlink "Versions/Current/Modules" "${framework_location}/Modules")
else()
set(modules_dir "${framework_location}/Modules")
add_custom_command(TARGET ${name} PRE_BUILD
COMMAND ${CMAKE_COMMAND} -E copy "${modulemap}" "${modules_dir}/module.modulemap")
endif()
endif()
if (SOURCEKIT_DEPLOYMENT_OS MATCHES "^macosx")
set_output_directory(${name}
BINARY_DIR ${SOURCEKIT_RUNTIME_OUTPUT_INTDIR}
LIBRARY_DIR ${SOURCEKIT_LIBRARY_OUTPUT_INTDIR})
set(RPATH_LIST)
add_sourcekit_swift_runtime_link_flags(${name} "${framework_location}/Versions/A" ${SOURCEKITFW_HAS_SWIFT_MODULES})
file(RELATIVE_PATH relative_lib_path
"${framework_location}/Versions/A" "${SOURCEKIT_LIBRARY_OUTPUT_INTDIR}")
list(APPEND RPATH_LIST "@loader_path/${relative_lib_path}")
file(GENERATE OUTPUT "xpc_service_name.txt" CONTENT "org.swift.SourceKitService.${SOURCEKIT_VERSION_STRING}_${SOURCEKIT_TOOLCHAIN_NAME}")
target_sources(${name} PRIVATE "${CMAKE_CURRENT_BINARY_DIR}/xpc_service_name.txt")
set_target_properties(${name} PROPERTIES
BUILD_WITH_INSTALL_RPATH TRUE
FOLDER "SourceKit frameworks"
FRAMEWORK TRUE
INSTALL_NAME_DIR "@rpath"
INSTALL_RPATH "${RPATH_LIST}"
MACOSX_FRAMEWORK_INFO_PLIST "${SOURCEKIT_SOURCE_DIR}/cmake/MacOSXFrameworkInfo.plist.in"
MACOSX_FRAMEWORK_IDENTIFIER "org.swift.${name}"
MACOSX_FRAMEWORK_SHORT_VERSION_STRING "1.0"
MACOSX_FRAMEWORK_BUNDLE_VERSION "${SOURCEKIT_VERSION_STRING}"
PUBLIC_HEADER "${headers}"
RESOURCE "${CMAKE_CURRENT_BINARY_DIR}/xpc_service_name.txt")
add_dependencies(${SOURCEKITFW_INSTALL_IN_COMPONENT} ${name})
swift_install_in_component(TARGETS ${name}
FRAMEWORK
DESTINATION lib${LLVM_LIBDIR_SUFFIX}
COMPONENT ${SOURCEKITFW_INSTALL_IN_COMPONENT}
LIBRARY
DESTINATION lib${LLVM_LIBDIR_SUFFIX}
COMPONENT ${SOURCEKITFW_INSTALL_IN_COMPONENT}
ARCHIVE
DESTINATION lib${LLVM_LIBDIR_SUFFIX}
COMPONENT ${SOURCEKITFW_INSTALL_IN_COMPONENT}
RUNTIME
DESTINATION bin
COMPONENT ${SOURCEKITFW_INSTALL_IN_COMPONENT})
else()
set_output_directory(${name}
BINARY_DIR ${framework_location}
LIBRARY_DIR ${framework_location})
set(RPATH_LIST)
add_sourcekit_swift_runtime_link_flags(${name} "${framework_location}" SOURCEKITFW_HAS_SWIFT_MODULES RPATH_LIST)
file(RELATIVE_PATH relative_lib_path
"${framework_location}" "${SOURCEKIT_LIBRARY_OUTPUT_INTDIR}")
list(APPEND RPATH_LIST "@loader_path/${relative_lib_path}")
set_target_properties(${name} PROPERTIES
BUILD_WITH_INSTALL_RPATH TRUE
FOLDER "SourceKit frameworks"
INSTALL_NAME_DIR "@rpath/${name}.framework"
INSTALL_RPATH "${RPATH_LIST}"
PREFIX ""
SUFFIX "")
swift_install_in_component(DIRECTORY ${framework_location}
DESTINATION lib${LLVM_LIBDIR_SUFFIX}
COMPONENT ${SOURCEKITFW_INSTALL_IN_COMPONENT}
USE_SOURCE_PERMISSIONS)
foreach(hdr ${headers})
get_filename_component(hdrname ${hdr} NAME)
add_custom_command(TARGET ${name} PRE_BUILD
COMMAND ${CMAKE_COMMAND} -E copy "${hdr}" "${framework_location}/Headers/${hdrname}")
endforeach()
endif()
swift_is_installing_component("${SOURCEKITFW_INSTALL_IN_COMPONENT}" is_installing)
if(NOT is_installing)
set_property(GLOBAL APPEND PROPERTY SWIFT_BUILDTREE_EXPORTS ${name})
else()
set_property(GLOBAL APPEND PROPERTY SWIFT_EXPORTS ${name})
endif()
add_sourcekit_default_compiler_flags("${name}")
endmacro(add_sourcekit_framework)
# Add a new SourceKit XPC service to a framework.
#
# Usage:
# add_sourcekit_xpc_service(name # Name of the XPC service
# [LLVM_LINK_COMPONENTS comp1 ...] # LLVM components this service depends on
# [HAS_SWIFT_MODULES] # Whether to link SwiftCompilerModules
# source1 [source2 source3 ...]) # Sources to add into this service
macro(add_sourcekit_xpc_service name framework_target)
cmake_parse_arguments(SOURCEKITXPC "HAS_SWIFT_MODULES" "" "LLVM_LINK_COMPONENTS" ${ARGN})
set(srcs ${SOURCEKITXPC_UNPARSED_ARGUMENTS})
set(lib_dir ${SOURCEKIT_LIBRARY_OUTPUT_INTDIR})
set(framework_location "${lib_dir}/${framework_target}.framework")
if (SOURCEKIT_DEPLOYMENT_OS MATCHES "^macosx")
set(xpc_bundle_dir "${framework_location}/Versions/A/XPCServices/${name}.xpc")
set(xpc_contents_dir "${xpc_bundle_dir}/Contents")
set(xpc_bin_dir "${xpc_contents_dir}/MacOS")
else()
set(xpc_bundle_dir "${framework_location}/XPCServices/${name}.xpc")
set(xpc_contents_dir "${xpc_bundle_dir}")
set(xpc_bin_dir "${xpc_contents_dir}")
endif()
set(XPCSERVICE_NAME ${name})
set(XPCSERVICE_IDENTIFIER "org.swift.${name}.${SOURCEKIT_VERSION_STRING}_${SOURCEKIT_TOOLCHAIN_NAME}")
set(XPCSERVICE_BUNDLE_VERSION "${SOURCEKIT_VERSION_STRING}")
set(XPCSERVICE_SHORT_VERSION_STRING "1.0")
configure_file(
"${SOURCEKIT_SOURCE_DIR}/cmake/XPCServiceInfo.plist.in"
"${CMAKE_CURRENT_BINARY_DIR}/${name}.Info.plist")
add_custom_command(OUTPUT "${xpc_contents_dir}/Info.plist"
DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/${name}.Info.plist"
COMMAND ${CMAKE_COMMAND} -E copy_if_different
"${CMAKE_CURRENT_BINARY_DIR}/${name}.Info.plist" "${xpc_contents_dir}/Info.plist")
list(APPEND srcs "${xpc_contents_dir}/Info.plist")
add_llvm_executable(${name} ${srcs})
set_target_properties(${name} PROPERTIES FOLDER "XPC Services")
set_target_properties(${name} PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${xpc_bin_dir}")
set_output_directory(${name}
BINARY_DIR "${xpc_bin_dir}"
LIBRARY_DIR "${xpc_bin_dir}")
# Add appropriate dependencies
if(LLVM_COMMON_DEPENDS)
add_dependencies(${name} ${LLVM_COMMON_DEPENDS})
endif(LLVM_COMMON_DEPENDS)
swift_common_llvm_config(${name} ${SOURCEKITXPC_LLVM_LINK_COMPONENTS})
target_link_libraries(${name} PRIVATE ${LLVM_COMMON_LIBS})
set_target_properties(${name} PROPERTIES LINKER_LANGUAGE CXX)
add_dependencies(${framework_target} ${name})
set(RPATH_LIST)
add_sourcekit_swift_runtime_link_flags(${name} ${xpc_bin_dir} ${SOURCEKITXPC_HAS_SWIFT_MODULES})
file(RELATIVE_PATH relative_lib_path "${xpc_bin_dir}" "${lib_dir}")
list(APPEND RPATH_LIST "@loader_path/${relative_lib_path}")
# Add rpath for sourcekitdInProc
# lib/${framework_target}.framework/Versions/A/XPCServices/${name}.xpc/Contents/MacOS/${name}
set_target_properties(${name} PROPERTIES
BUILD_WITH_INSTALL_RPATH On
INSTALL_RPATH "${RPATH_LIST}"
INSTALL_NAME_DIR "@rpath")
if (SOURCEKIT_DEPLOYMENT_OS MATCHES "^macosx")
add_custom_command(TARGET ${name} POST_BUILD
COMMAND ${CMAKE_COMMAND} -E create_symlink "Versions/Current/XPCServices" XPCServices
WORKING_DIRECTORY ${framework_location})
endif()
# ASan does not play well with exported_symbol option. This should be fixed soon.
if(NOT SWIFT_ASAN_BUILD)
if("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
set_property(TARGET ${name} APPEND_STRING PROPERTY
LINK_FLAGS " -Wl,-exported_symbol,_main ")
endif()
endif()
add_sourcekit_default_compiler_flags("${name}")
endmacro()