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# llvm_ExternalProject_Add(name source_dir ... 20# USE_TOOLCHAIN 21# Use just-built tools (see TOOLCHAIN_TOOLS) 22# EXCLUDE_FROM_ALL 23# Exclude this project from the all target 24# NO_INSTALL 25# Don't generate install targets for this project 26# ALWAYS_CLEAN 27# Always clean the sub-project before building 28# CMAKE_ARGS arguments... 29# Optional cmake arguments to pass when configuring the project 30# TOOLCHAIN_TOOLS targets... 31# Targets for toolchain tools (defaults to clang;lld) 32# DEPENDS targets... 33# Targets that this project depends on 34# EXTRA_TARGETS targets... 35# Extra targets in the subproject to generate targets for 36# PASSTHROUGH_PREFIXES prefix... 37# Extra variable prefixes (name is always included) to pass down 38# STRIP_TOOL path 39# Use provided strip tool instead of the default one. 40# ) 41function(llvm_ExternalProject_Add name source_dir) 42 cmake_parse_arguments(ARG 43 "USE_TOOLCHAIN;EXCLUDE_FROM_ALL;NO_INSTALL;ALWAYS_CLEAN" 44 "SOURCE_DIR" 45 "CMAKE_ARGS;TOOLCHAIN_TOOLS;RUNTIME_LIBRARIES;DEPENDS;EXTRA_TARGETS;PASSTHROUGH_PREFIXES;STRIP_TOOL" 46 ${ARGN}) 47 canonicalize_tool_name(${name} nameCanon) 48 49 foreach(arg ${ARG_CMAKE_ARGS}) 50 if(arg MATCHES "^-DCMAKE_SYSTEM_NAME=") 51 string(REGEX REPLACE "^-DCMAKE_SYSTEM_NAME=(.*)$" "\\1" _cmake_system_name "${arg}") 52 endif() 53 endforeach() 54 55 if(NOT ARG_TOOLCHAIN_TOOLS) 56 set(ARG_TOOLCHAIN_TOOLS clang lld llvm-ar llvm-lipo llvm-ranlib llvm-nm llvm-objdump) 57 if(NOT _cmake_system_name STREQUAL Darwin) 58 # TODO: These tools don't fully support Mach-O format yet. 59 list(APPEND ARG_TOOLCHAIN_TOOLS llvm-objcopy llvm-strip) 60 endif() 61 endif() 62 foreach(tool ${ARG_TOOLCHAIN_TOOLS}) 63 if(TARGET ${tool}) 64 list(APPEND TOOLCHAIN_TOOLS ${tool}) 65 list(APPEND TOOLCHAIN_BINS $<TARGET_FILE:${tool}>) 66 endif() 67 endforeach() 68 69 if(NOT ARG_RUNTIME_LIBRARIES) 70 set(ARG_RUNTIME_LIBRARIES compiler-rt libcxx) 71 endif() 72 foreach(lib ${ARG_RUNTIME_LIBRARIES}) 73 if(TARGET ${lib}) 74 list(APPEND RUNTIME_LIBRARIES ${lib}) 75 endif() 76 endforeach() 77 78 if(ARG_ALWAYS_CLEAN) 79 set(always_clean clean) 80 endif() 81 82 list(FIND TOOLCHAIN_TOOLS clang FOUND_CLANG) 83 if(FOUND_CLANG GREATER -1) 84 set(CLANG_IN_TOOLCHAIN On) 85 endif() 86 87 if(RUNTIME_LIBRARIES AND CLANG_IN_TOOLCHAIN) 88 list(APPEND TOOLCHAIN_BINS ${RUNTIME_LIBRARIES}) 89 endif() 90 91 set(STAMP_DIR ${CMAKE_CURRENT_BINARY_DIR}/${name}-stamps/) 92 set(BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/${name}-bins/) 93 94 add_custom_target(${name}-clear 95 COMMAND ${CMAKE_COMMAND} -E remove_directory ${BINARY_DIR} 96 COMMAND ${CMAKE_COMMAND} -E remove_directory ${STAMP_DIR} 97 COMMENT "Clobbering ${name} build and stamp directories" 98 USES_TERMINAL 99 ) 100 101 # Find all variables that start with a prefix and propagate them through 102 get_cmake_property(variableNames VARIABLES) 103 104 list(APPEND ARG_PASSTHROUGH_PREFIXES ${nameCanon}) 105 foreach(prefix ${ARG_PASSTHROUGH_PREFIXES}) 106 foreach(variableName ${variableNames}) 107 if(variableName MATCHES "^${prefix}") 108 string(REPLACE ";" "|" value "${${variableName}}") 109 list(APPEND PASSTHROUGH_VARIABLES 110 -D${variableName}=${value}) 111 endif() 112 endforeach() 113 endforeach() 114 115 if(ARG_USE_TOOLCHAIN AND NOT CMAKE_CROSSCOMPILING) 116 if(CLANG_IN_TOOLCHAIN) 117 if(_cmake_system_name STREQUAL Windows) 118 set(compiler_args -DCMAKE_C_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang-cl${CMAKE_EXECUTABLE_SUFFIX} 119 -DCMAKE_CXX_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang-cl${CMAKE_EXECUTABLE_SUFFIX} 120 -DCMAKE_ASM_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang-cl${CMAKE_EXECUTABLE_SUFFIX}) 121 else() 122 set(compiler_args -DCMAKE_C_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang${CMAKE_EXECUTABLE_SUFFIX} 123 -DCMAKE_CXX_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang++${CMAKE_EXECUTABLE_SUFFIX} 124 -DCMAKE_ASM_COMPILER=${LLVM_RUNTIME_OUTPUT_INTDIR}/clang${CMAKE_EXECUTABLE_SUFFIX}) 125 endif() 126 endif() 127 if(lld IN_LIST TOOLCHAIN_TOOLS) 128 if(_cmake_system_name STREQUAL Windows) 129 list(APPEND compiler_args -DCMAKE_LINKER=${LLVM_RUNTIME_OUTPUT_INTDIR}/lld-link${CMAKE_EXECUTABLE_SUFFIX}) 130 else() 131 list(APPEND compiler_args -DCMAKE_LINKER=${LLVM_RUNTIME_OUTPUT_INTDIR}/ld.lld${CMAKE_EXECUTABLE_SUFFIX}) 132 endif() 133 endif() 134 if(llvm-ar IN_LIST TOOLCHAIN_TOOLS) 135 list(APPEND compiler_args -DCMAKE_AR=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-ar${CMAKE_EXECUTABLE_SUFFIX}) 136 endif() 137 if(llvm-lipo IN_LIST TOOLCHAIN_TOOLS) 138 list(APPEND compiler_args -DCMAKE_LIPO=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-lipo${CMAKE_EXECUTABLE_SUFFIX}) 139 endif() 140 if(llvm-ranlib IN_LIST TOOLCHAIN_TOOLS) 141 list(APPEND compiler_args -DCMAKE_RANLIB=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-ranlib${CMAKE_EXECUTABLE_SUFFIX}) 142 endif() 143 if(llvm-nm IN_LIST TOOLCHAIN_TOOLS) 144 list(APPEND compiler_args -DCMAKE_NM=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-nm${CMAKE_EXECUTABLE_SUFFIX}) 145 endif() 146 if(llvm-objdump IN_LIST TOOLCHAIN_TOOLS) 147 list(APPEND compiler_args -DCMAKE_OBJDUMP=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-objdump${CMAKE_EXECUTABLE_SUFFIX}) 148 endif() 149 if(llvm-objcopy IN_LIST TOOLCHAIN_TOOLS) 150 list(APPEND compiler_args -DCMAKE_OBJCOPY=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-objcopy${CMAKE_EXECUTABLE_SUFFIX}) 151 endif() 152 if(llvm-strip IN_LIST TOOLCHAIN_TOOLS AND NOT ARG_STRIP_TOOL) 153 list(APPEND compiler_args -DCMAKE_STRIP=${LLVM_RUNTIME_OUTPUT_INTDIR}/llvm-strip${CMAKE_EXECUTABLE_SUFFIX}) 154 endif() 155 list(APPEND ARG_DEPENDS ${TOOLCHAIN_TOOLS}) 156 endif() 157 158 if(ARG_STRIP_TOOL) 159 list(APPEND compiler_args -DCMAKE_STRIP=${ARG_STRIP_TOOL}) 160 endif() 161 162 add_custom_command( 163 OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${name}-clobber-stamp 164 DEPENDS ${ARG_DEPENDS} 165 COMMAND ${CMAKE_COMMAND} -E touch ${BINARY_DIR}/CMakeCache.txt 166 COMMAND ${CMAKE_COMMAND} -E touch ${STAMP_DIR}/${name}-mkdir 167 COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/${name}-clobber-stamp 168 COMMENT "Clobbering bootstrap build and stamp directories" 169 ) 170 171 add_custom_target(${name}-clobber 172 DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${name}-clobber-stamp) 173 174 if(ARG_EXCLUDE_FROM_ALL) 175 set(exclude EXCLUDE_FROM_ALL 1) 176 endif() 177 178 if(CMAKE_SYSROOT) 179 set(sysroot_arg -DCMAKE_SYSROOT=${CMAKE_SYSROOT}) 180 endif() 181 182 if(CMAKE_CROSSCOMPILING) 183 set(compiler_args -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} 184 -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} 185 -DCMAKE_LINKER=${CMAKE_LINKER} 186 -DCMAKE_AR=${CMAKE_AR} 187 -DCMAKE_RANLIB=${CMAKE_RANLIB} 188 -DCMAKE_NM=${CMAKE_NM} 189 -DCMAKE_OBJCOPY=${CMAKE_OBJCOPY} 190 -DCMAKE_OBJDUMP=${CMAKE_OBJDUMP} 191 -DCMAKE_STRIP=${CMAKE_STRIP}) 192 set(llvm_config_path ${LLVM_CONFIG_PATH}) 193 194 if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") 195 string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" CLANG_VERSION 196 ${PACKAGE_VERSION}) 197 set(resource_dir "${LLVM_LIBRARY_DIR}/clang/${CLANG_VERSION}") 198 set(flag_types ASM C CXX MODULE_LINKER SHARED_LINKER EXE_LINKER) 199 foreach(type ${flag_types}) 200 set(${type}_flag -DCMAKE_${type}_FLAGS=-resource-dir=${resource_dir}) 201 endforeach() 202 string(REPLACE ";" "|" flag_string "${flag_types}") 203 foreach(arg ${ARG_CMAKE_ARGS}) 204 if(arg MATCHES "^-DCMAKE_(${flag_string})_FLAGS") 205 foreach(type ${flag_types}) 206 if(arg MATCHES "^-DCMAKE_${type}_FLAGS") 207 string(REGEX REPLACE "^-DCMAKE_${type}_FLAGS=(.*)$" "\\1" flag_value "${arg}") 208 set(${type}_flag "${${type}_flag} ${flag_value}") 209 endif() 210 endforeach() 211 else() 212 list(APPEND cmake_args ${arg}) 213 endif() 214 endforeach() 215 foreach(type ${flag_types}) 216 list(APPEND cmake_args ${${type}_flag}) 217 endforeach() 218 endif() 219 else() 220 set(llvm_config_path "$<TARGET_FILE:llvm-config>") 221 set(cmake_args ${ARG_CMAKE_ARGS}) 222 endif() 223 224 ExternalProject_Add(${name} 225 DEPENDS ${ARG_DEPENDS} llvm-config 226 ${name}-clobber 227 PREFIX ${CMAKE_BINARY_DIR}/projects/${name} 228 SOURCE_DIR ${source_dir} 229 STAMP_DIR ${STAMP_DIR} 230 BINARY_DIR ${BINARY_DIR} 231 ${exclude} 232 CMAKE_ARGS ${${nameCanon}_CMAKE_ARGS} 233 ${compiler_args} 234 -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} 235 ${sysroot_arg} 236 -DLLVM_BINARY_DIR=${PROJECT_BINARY_DIR} 237 -DLLVM_CONFIG_PATH=${llvm_config_path} 238 -DLLVM_ENABLE_WERROR=${LLVM_ENABLE_WERROR} 239 -DLLVM_HOST_TRIPLE=${LLVM_HOST_TRIPLE} 240 -DLLVM_HAVE_LINK_VERSION_SCRIPT=${LLVM_HAVE_LINK_VERSION_SCRIPT} 241 -DLLVM_USE_RELATIVE_PATHS_IN_DEBUG_INFO=${LLVM_USE_RELATIVE_PATHS_IN_DEBUG_INFO} 242 -DLLVM_USE_RELATIVE_PATHS_IN_FILES=${LLVM_USE_RELATIVE_PATHS_IN_FILES} 243 -DLLVM_SOURCE_PREFIX=${LLVM_SOURCE_PREFIX} 244 -DPACKAGE_VERSION=${PACKAGE_VERSION} 245 -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} 246 -DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM} 247 -DCMAKE_EXPORT_COMPILE_COMMANDS=1 248 ${cmake_args} 249 ${PASSTHROUGH_VARIABLES} 250 INSTALL_COMMAND "" 251 STEP_TARGETS configure build 252 BUILD_ALWAYS 1 253 USES_TERMINAL_CONFIGURE 1 254 USES_TERMINAL_BUILD 1 255 USES_TERMINAL_INSTALL 1 256 LIST_SEPARATOR | 257 ) 258 259 if(ARG_USE_TOOLCHAIN) 260 set(force_deps DEPENDS ${TOOLCHAIN_BINS}) 261 endif() 262 263 llvm_ExternalProject_BuildCmd(run_clean clean ${BINARY_DIR}) 264 ExternalProject_Add_Step(${name} clean 265 COMMAND ${run_clean} 266 COMMENT "Cleaning ${name}..." 267 DEPENDEES configure 268 ${force_deps} 269 WORKING_DIRECTORY ${BINARY_DIR} 270 EXCLUDE_FROM_MAIN 1 271 USES_TERMINAL 1 272 ) 273 ExternalProject_Add_StepTargets(${name} clean) 274 275 if(ARG_USE_TOOLCHAIN) 276 add_dependencies(${name}-clean ${name}-clobber) 277 set_target_properties(${name}-clean PROPERTIES 278 SOURCES ${CMAKE_CURRENT_BINARY_DIR}/${name}-clobber-stamp) 279 endif() 280 281 if(NOT ARG_NO_INSTALL) 282 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\)" 283 COMPONENT ${name}) 284 285 add_llvm_install_targets(install-${name} 286 DEPENDS ${name} 287 COMPONENT ${name}) 288 endif() 289 290 # Add top-level targets 291 foreach(target ${ARG_EXTRA_TARGETS}) 292 if(DEFINED ${target}) 293 set(external_target "${${target}}") 294 else() 295 set(external_target "${target}") 296 endif() 297 llvm_ExternalProject_BuildCmd(build_runtime_cmd ${external_target} ${BINARY_DIR}) 298 add_custom_target(${target} 299 COMMAND ${build_runtime_cmd} 300 DEPENDS ${name}-configure 301 WORKING_DIRECTORY ${BINARY_DIR} 302 VERBATIM 303 USES_TERMINAL) 304 endforeach() 305endfunction() 306