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