1include(ExternalProject) 2 3# llvm_ExternalProject_BuildCmd(out_var target) 4# Utility function for constructing command lines for external project targets 5function(llvm_ExternalProject_BuildCmd out_var target bin_dir) 6 cmake_parse_arguments(ARG "" "CONFIGURATION" "" ${ARGN}) 7 if(NOT ARG_CONFIGURATION) 8 set(ARG_CONFIGURATION "$<CONFIG>") 9 endif() 10 if (CMAKE_GENERATOR MATCHES "Make") 11 # Use special command for Makefiles to support parallelism. 12 set(${out_var} "$(MAKE)" "-C" "${bin_dir}" "${target}" PARENT_SCOPE) 13 else() 14 set(${out_var} ${CMAKE_COMMAND} --build ${bin_dir} --target ${target} 15 --config ${ARG_CONFIGURATION} PARENT_SCOPE) 16 endif() 17endfunction() 18 19# is_msvc_triple(out_var triple) 20# Checks whether the passed triple refers to an MSVC environment 21function(is_msvc_triple out_var triple) 22 if (triple MATCHES ".*-windows-msvc.*") 23 set(${out_var} TRUE PARENT_SCOPE) 24 else() 25 set(${out_var} FALSE PARENT_SCOPE) 26 endif() 27endfunction() 28 29 30# llvm_ExternalProject_Add(name source_dir ... 31# USE_TOOLCHAIN 32# Use just-built tools (see TOOLCHAIN_TOOLS) 33# EXCLUDE_FROM_ALL 34# Exclude this project from the all target 35# NO_INSTALL 36# Don't generate install targets for this project 37# ALWAYS_CLEAN 38# Always clean the sub-project before building 39# CMAKE_ARGS arguments... 40# Optional cmake arguments to pass when configuring the project 41# TOOLCHAIN_TOOLS targets... 42# Targets for toolchain tools (defaults to clang;lld) 43# DEPENDS targets... 44# Targets that this project depends on 45# EXTRA_TARGETS targets... 46# Extra targets in the subproject to generate targets for 47# PASSTHROUGH_PREFIXES prefix... 48# Extra variable prefixes (name is always included) to pass down 49# STRIP_TOOL path 50# Use provided strip tool instead of the default one. 51# TARGET_TRIPLE triple 52# Optional target triple to pass to the compiler 53# ) 54function(llvm_ExternalProject_Add name source_dir) 55 cmake_parse_arguments(ARG 56 "USE_TOOLCHAIN;EXCLUDE_FROM_ALL;NO_INSTALL;ALWAYS_CLEAN" 57 "SOURCE_DIR" 58 "CMAKE_ARGS;TOOLCHAIN_TOOLS;RUNTIME_LIBRARIES;DEPENDS;EXTRA_TARGETS;PASSTHROUGH_PREFIXES;STRIP_TOOL;TARGET_TRIPLE" 59 ${ARGN}) 60 canonicalize_tool_name(${name} nameCanon) 61 62 foreach(arg ${ARG_CMAKE_ARGS}) 63 if(arg MATCHES "^-DCMAKE_SYSTEM_NAME=") 64 string(REGEX REPLACE "^-DCMAKE_SYSTEM_NAME=(.*)$" "\\1" _cmake_system_name "${arg}") 65 endif() 66 endforeach() 67 68 # If CMAKE_SYSTEM_NAME is not set explicitly in the arguments passed to us, 69 # reflect CMake's own default. 70 if (NOT _cmake_system_name) 71 set(_cmake_system_name "${CMAKE_HOST_SYSTEM_NAME}") 72 endif() 73 74 if(NOT ARG_TARGET_TRIPLE) 75 set(target_triple ${LLVM_DEFAULT_TARGET_TRIPLE}) 76 else() 77 set(target_triple ${ARG_TARGET_TRIPLE}) 78 endif() 79 80 is_msvc_triple(is_msvc_target ${target_triple}) 81 82 if(NOT ARG_TOOLCHAIN_TOOLS) 83 set(ARG_TOOLCHAIN_TOOLS clang) 84 # AIX 64-bit XCOFF and big AR format is not yet supported in some of these tools. 85 if(NOT _cmake_system_name STREQUAL AIX) 86 list(APPEND ARG_TOOLCHAIN_TOOLS lld llvm-ar llvm-ranlib llvm-nm llvm-objdump) 87 if(_cmake_system_name STREQUAL Darwin) 88 list(APPEND ARG_TOOLCHAIN_TOOLS llvm-libtool-darwin llvm-lipo) 89 elseif(is_msvc_target) 90 list(APPEND ARG_TOOLCHAIN_TOOLS llvm-lib) 91 else() 92 # TODO: These tools don't fully support Mach-O format yet. 93 list(APPEND ARG_TOOLCHAIN_TOOLS llvm-objcopy llvm-strip llvm-readelf) 94 endif() 95 endif() 96 endif() 97 foreach(tool ${ARG_TOOLCHAIN_TOOLS}) 98 if(TARGET ${tool}) 99 list(APPEND TOOLCHAIN_TOOLS ${tool}) 100 101 # $<TARGET_FILE:tgt> only works on add_executable or add_library targets 102 # The below logic mirrors cmake's own implementation 103 get_target_property(target_type "${tool}" TYPE) 104 if(NOT target_type STREQUAL "OBJECT_LIBRARY" AND 105 NOT target_type STREQUAL "UTILITY" AND 106 NOT target_type STREQUAL "GLOBAL_TARGET" AND 107 NOT target_type STREQUAL "INTERFACE_LIBRARY") 108 list(APPEND TOOLCHAIN_BINS $<TARGET_FILE:${tool}>) 109 endif() 110 111 endif() 112 endforeach() 113 114 if(NOT ARG_RUNTIME_LIBRARIES) 115 set(ARG_RUNTIME_LIBRARIES compiler-rt libcxx) 116 endif() 117 foreach(lib ${ARG_RUNTIME_LIBRARIES}) 118 if(TARGET ${lib}) 119 list(APPEND RUNTIME_LIBRARIES ${lib}) 120 endif() 121 endforeach() 122 123 if(ARG_ALWAYS_CLEAN) 124 set(always_clean clean) 125 endif() 126 127 list(FIND TOOLCHAIN_TOOLS clang FOUND_CLANG) 128 if(FOUND_CLANG GREATER -1) 129 set(CLANG_IN_TOOLCHAIN On) 130 endif() 131 132 if(RUNTIME_LIBRARIES AND CLANG_IN_TOOLCHAIN) 133 list(APPEND TOOLCHAIN_BINS ${RUNTIME_LIBRARIES}) 134 endif() 135 136 set(STAMP_DIR ${CMAKE_CURRENT_BINARY_DIR}/${name}-stamps/) 137 set(BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/${name}-bins/) 138 139 add_custom_target(${name}-clear 140 COMMAND ${CMAKE_COMMAND} -E remove_directory ${BINARY_DIR} 141 COMMAND ${CMAKE_COMMAND} -E remove_directory ${STAMP_DIR} 142 COMMENT "Clobbering ${name} build and stamp directories" 143 USES_TERMINAL 144 ) 145 146 # Find all variables that start with a prefix and propagate them through 147 get_cmake_property(variableNames VARIABLES) 148 149 list(APPEND ARG_PASSTHROUGH_PREFIXES ${nameCanon}) 150 foreach(prefix ${ARG_PASSTHROUGH_PREFIXES}) 151 foreach(variableName ${variableNames}) 152 if(variableName MATCHES "^${prefix}") 153 string(REPLACE ";" "|" value "${${variableName}}") 154 list(APPEND PASSTHROUGH_VARIABLES 155 -D${variableName}=${value}) 156 endif() 157 endforeach() 158 endforeach() 159 160 if(ARG_USE_TOOLCHAIN AND NOT CMAKE_CROSSCOMPILING) 161 if(CLANG_IN_TOOLCHAIN) 162 if(is_msvc_target) 163 set(compiler_args -DCMAKE_C_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang-cl${CMAKE_EXECUTABLE_SUFFIX} 164 -DCMAKE_CXX_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang-cl${CMAKE_EXECUTABLE_SUFFIX} 165 -DCMAKE_ASM_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang-cl${CMAKE_EXECUTABLE_SUFFIX}) 166 else() 167 set(compiler_args -DCMAKE_C_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang${CMAKE_EXECUTABLE_SUFFIX} 168 -DCMAKE_CXX_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang++${CMAKE_EXECUTABLE_SUFFIX} 169 -DCMAKE_ASM_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang${CMAKE_EXECUTABLE_SUFFIX}) 170 endif() 171 endif() 172 if(lld IN_LIST TOOLCHAIN_TOOLS) 173 if(is_msvc_target) 174 list(APPEND compiler_args -DCMAKE_LINKER=${LLVM_RUNTIME_OUTPUT_INTDIR}/lld-link${CMAKE_EXECUTABLE_SUFFIX}) 175 elseif(NOT _cmake_system_name STREQUAL Darwin) 176 list(APPEND compiler_args -DCMAKE_LINKER=${LLVM_RUNTIME_OUTPUT_INTDIR}/ld.lld${CMAKE_EXECUTABLE_SUFFIX}) 177 endif() 178 endif() 179 if(llvm-ar IN_LIST TOOLCHAIN_TOOLS) 180 if(is_msvc_target) 181 list(APPEND compiler_args -DCMAKE_AR=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-lib${CMAKE_EXECUTABLE_SUFFIX}) 182 else() 183 list(APPEND compiler_args -DCMAKE_AR=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-ar${CMAKE_EXECUTABLE_SUFFIX}) 184 endif() 185 endif() 186 if(llvm-libtool-darwin IN_LIST TOOLCHAIN_TOOLS) 187 list(APPEND compiler_args -DCMAKE_LIBTOOL=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-libtool-darwin${CMAKE_EXECUTABLE_SUFFIX}) 188 endif() 189 if(llvm-lipo IN_LIST TOOLCHAIN_TOOLS) 190 list(APPEND compiler_args -DCMAKE_LIPO=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-lipo${CMAKE_EXECUTABLE_SUFFIX}) 191 endif() 192 if(llvm-ranlib IN_LIST TOOLCHAIN_TOOLS) 193 list(APPEND compiler_args -DCMAKE_RANLIB=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-ranlib${CMAKE_EXECUTABLE_SUFFIX}) 194 endif() 195 if(llvm-nm IN_LIST TOOLCHAIN_TOOLS) 196 list(APPEND compiler_args -DCMAKE_NM=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-nm${CMAKE_EXECUTABLE_SUFFIX}) 197 endif() 198 if(llvm-objdump IN_LIST TOOLCHAIN_TOOLS) 199 list(APPEND compiler_args -DCMAKE_OBJDUMP=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-objdump${CMAKE_EXECUTABLE_SUFFIX}) 200 endif() 201 if(llvm-objcopy IN_LIST TOOLCHAIN_TOOLS) 202 list(APPEND compiler_args -DCMAKE_OBJCOPY=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-objcopy${CMAKE_EXECUTABLE_SUFFIX}) 203 endif() 204 if(llvm-strip IN_LIST TOOLCHAIN_TOOLS AND NOT ARG_STRIP_TOOL) 205 list(APPEND compiler_args -DCMAKE_STRIP=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-strip${CMAKE_EXECUTABLE_SUFFIX}) 206 endif() 207 if(llvm-readelf IN_LIST TOOLCHAIN_TOOLS) 208 list(APPEND compiler_args -DCMAKE_READELF=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-readelf${CMAKE_EXECUTABLE_SUFFIX}) 209 endif() 210 list(APPEND ARG_DEPENDS ${TOOLCHAIN_TOOLS}) 211 endif() 212 213 if(ARG_STRIP_TOOL) 214 list(APPEND compiler_args -DCMAKE_STRIP=${ARG_STRIP_TOOL}) 215 endif() 216 217 add_custom_command( 218 OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${name}-clobber-stamp 219 DEPENDS ${ARG_DEPENDS} 220 COMMAND ${CMAKE_COMMAND} -E touch ${BINARY_DIR}/CMakeCache.txt 221 COMMAND ${CMAKE_COMMAND} -E touch ${STAMP_DIR}/${name}-mkdir 222 COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/${name}-clobber-stamp 223 COMMENT "Clobbering bootstrap build and stamp directories" 224 ) 225 226 add_custom_target(${name}-clobber 227 DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${name}-clobber-stamp) 228 229 if(ARG_EXCLUDE_FROM_ALL) 230 set(exclude EXCLUDE_FROM_ALL 1) 231 endif() 232 233 if(CMAKE_SYSROOT) 234 set(sysroot_arg -DCMAKE_SYSROOT=${CMAKE_SYSROOT}) 235 endif() 236 237 if(CMAKE_CROSSCOMPILING) 238 set(compiler_args -DCMAKE_ASM_COMPILER=${CMAKE_ASM_COMPILER} 239 -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} 240 -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} 241 -DCMAKE_LINKER=${CMAKE_LINKER} 242 -DCMAKE_AR=${CMAKE_AR} 243 -DCMAKE_RANLIB=${CMAKE_RANLIB} 244 -DCMAKE_NM=${CMAKE_NM} 245 -DCMAKE_OBJCOPY=${CMAKE_OBJCOPY} 246 -DCMAKE_OBJDUMP=${CMAKE_OBJDUMP} 247 -DCMAKE_STRIP=${CMAKE_STRIP}) 248 set(llvm_config_path ${LLVM_CONFIG_PATH}) 249 250 if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") 251 string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" CLANG_VERSION 252 ${PACKAGE_VERSION}) 253 set(resource_dir "${LLVM_LIBRARY_DIR}/clang/${CLANG_VERSION}") 254 set(flag_types ASM C CXX MODULE_LINKER SHARED_LINKER EXE_LINKER) 255 foreach(type ${flag_types}) 256 set(${type}_flag -DCMAKE_${type}_FLAGS=-resource-dir=${resource_dir}) 257 endforeach() 258 string(REPLACE ";" "|" flag_string "${flag_types}") 259 foreach(arg ${ARG_CMAKE_ARGS}) 260 if(arg MATCHES "^-DCMAKE_(${flag_string})_FLAGS") 261 foreach(type ${flag_types}) 262 if(arg MATCHES "^-DCMAKE_${type}_FLAGS") 263 string(REGEX REPLACE "^-DCMAKE_${type}_FLAGS=(.*)$" "\\1" flag_value "${arg}") 264 set(${type}_flag "${${type}_flag} ${flag_value}") 265 endif() 266 endforeach() 267 else() 268 list(APPEND cmake_args ${arg}) 269 endif() 270 endforeach() 271 foreach(type ${flag_types}) 272 list(APPEND cmake_args ${${type}_flag}) 273 endforeach() 274 endif() 275 else() 276 set(llvm_config_path "$<TARGET_FILE:llvm-config>") 277 set(cmake_args ${ARG_CMAKE_ARGS}) 278 endif() 279 280 if(ARG_TARGET_TRIPLE) 281 list(APPEND compiler_args -DCMAKE_C_COMPILER_TARGET=${ARG_TARGET_TRIPLE}) 282 list(APPEND compiler_args -DCMAKE_CXX_COMPILER_TARGET=${ARG_TARGET_TRIPLE}) 283 list(APPEND compiler_args -DCMAKE_ASM_COMPILER_TARGET=${ARG_TARGET_TRIPLE}) 284 endif() 285 286 ExternalProject_Add(${name} 287 DEPENDS ${ARG_DEPENDS} llvm-config 288 ${name}-clobber 289 PREFIX ${CMAKE_BINARY_DIR}/projects/${name} 290 SOURCE_DIR ${source_dir} 291 STAMP_DIR ${STAMP_DIR} 292 BINARY_DIR ${BINARY_DIR} 293 ${exclude} 294 CMAKE_ARGS ${${nameCanon}_CMAKE_ARGS} 295 ${compiler_args} 296 -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} 297 ${sysroot_arg} 298 -DLLVM_BINARY_DIR=${PROJECT_BINARY_DIR} 299 -DLLVM_CONFIG_PATH=${llvm_config_path} 300 -DLLVM_ENABLE_WERROR=${LLVM_ENABLE_WERROR} 301 -DLLVM_HOST_TRIPLE=${LLVM_HOST_TRIPLE} 302 -DLLVM_HAVE_LINK_VERSION_SCRIPT=${LLVM_HAVE_LINK_VERSION_SCRIPT} 303 -DLLVM_USE_RELATIVE_PATHS_IN_DEBUG_INFO=${LLVM_USE_RELATIVE_PATHS_IN_DEBUG_INFO} 304 -DLLVM_USE_RELATIVE_PATHS_IN_FILES=${LLVM_USE_RELATIVE_PATHS_IN_FILES} 305 -DLLVM_LIT_ARGS=${LLVM_LIT_ARGS} 306 -DLLVM_SOURCE_PREFIX=${LLVM_SOURCE_PREFIX} 307 -DPACKAGE_VERSION=${PACKAGE_VERSION} 308 -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} 309 -DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM} 310 -DCMAKE_EXPORT_COMPILE_COMMANDS=1 311 ${cmake_args} 312 ${PASSTHROUGH_VARIABLES} 313 INSTALL_COMMAND "" 314 STEP_TARGETS configure build 315 BUILD_ALWAYS 1 316 USES_TERMINAL_CONFIGURE 1 317 USES_TERMINAL_BUILD 1 318 USES_TERMINAL_INSTALL 1 319 LIST_SEPARATOR | 320 ) 321 322 if(ARG_USE_TOOLCHAIN) 323 set(force_deps DEPENDS ${TOOLCHAIN_BINS}) 324 endif() 325 326 llvm_ExternalProject_BuildCmd(run_clean clean ${BINARY_DIR}) 327 ExternalProject_Add_Step(${name} clean 328 COMMAND ${run_clean} 329 COMMENT "Cleaning ${name}..." 330 DEPENDEES configure 331 ${force_deps} 332 WORKING_DIRECTORY ${BINARY_DIR} 333 EXCLUDE_FROM_MAIN 1 334 USES_TERMINAL 1 335 ) 336 ExternalProject_Add_StepTargets(${name} clean) 337 338 if(ARG_USE_TOOLCHAIN) 339 add_dependencies(${name}-clean ${name}-clobber) 340 set_target_properties(${name}-clean PROPERTIES 341 SOURCES ${CMAKE_CURRENT_BINARY_DIR}/${name}-clobber-stamp) 342 endif() 343 344 if(NOT ARG_NO_INSTALL) 345 install(CODE "execute_process\(COMMAND \${CMAKE_COMMAND} -DCMAKE_INSTALL_PREFIX=\${CMAKE_INSTALL_PREFIX} -DCMAKE_INSTALL_DO_STRIP=\${CMAKE_INSTALL_DO_STRIP} -P ${BINARY_DIR}/cmake_install.cmake\)" 346 COMPONENT ${name}) 347 348 add_llvm_install_targets(install-${name} 349 DEPENDS ${name} 350 COMPONENT ${name}) 351 endif() 352 353 # Add top-level targets 354 foreach(target ${ARG_EXTRA_TARGETS}) 355 if(DEFINED ${target}) 356 set(external_target "${${target}}") 357 else() 358 set(external_target "${target}") 359 endif() 360 llvm_ExternalProject_BuildCmd(build_runtime_cmd ${external_target} ${BINARY_DIR}) 361 add_custom_target(${target} 362 COMMAND ${build_runtime_cmd} 363 DEPENDS ${name}-configure 364 WORKING_DIRECTORY ${BINARY_DIR} 365 VERBATIM 366 USES_TERMINAL) 367 endforeach() 368endfunction() 369