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