1include(GNUInstallDirs)
2include(LLVMDistributionSupport)
3include(LLVMProcessSources)
4include(LLVM-Config)
5include(DetermineGCCCompatible)
6
7function(llvm_update_compile_flags name)
8  get_property(sources TARGET ${name} PROPERTY SOURCES)
9  if("${sources}" MATCHES "\\.c(;|$)")
10    set(update_src_props ON)
11  endif()
12
13  list(APPEND LLVM_COMPILE_CFLAGS " ${LLVM_COMPILE_FLAGS}")
14
15  # LLVM_REQUIRES_EH is an internal flag that individual targets can use to
16  # force EH
17  if(LLVM_REQUIRES_EH OR LLVM_ENABLE_EH)
18    if(NOT (LLVM_REQUIRES_RTTI OR LLVM_ENABLE_RTTI))
19      message(AUTHOR_WARNING "Exception handling requires RTTI. Enabling RTTI for ${name}")
20      set(LLVM_REQUIRES_RTTI ON)
21    endif()
22    if(MSVC)
23      list(APPEND LLVM_COMPILE_FLAGS "/EHsc")
24    endif()
25  else()
26    if(LLVM_COMPILER_IS_GCC_COMPATIBLE)
27      list(APPEND LLVM_COMPILE_FLAGS "-fno-exceptions")
28      if(LLVM_ENABLE_UNWIND_TABLES)
29        list(APPEND LLVM_COMPILE_FLAGS "-funwind-tables")
30      else()
31        list(APPEND LLVM_COMPILE_FLAGS "-fno-unwind-tables")
32        list(APPEND LLVM_COMPILE_FLAGS "-fno-asynchronous-unwind-tables")
33      endif()
34    elseif(MSVC)
35      list(APPEND LLVM_COMPILE_DEFINITIONS _HAS_EXCEPTIONS=0)
36      list(APPEND LLVM_COMPILE_FLAGS "/EHs-c-")
37    elseif (CMAKE_CXX_COMPILER_ID MATCHES "XL")
38      list(APPEND LLVM_COMPILE_FLAGS "-qnoeh")
39    endif()
40  endif()
41
42  # LLVM_REQUIRES_RTTI is an internal flag that individual
43  # targets can use to force RTTI
44  set(LLVM_CONFIG_HAS_RTTI YES CACHE INTERNAL "")
45  if(NOT (LLVM_REQUIRES_RTTI OR LLVM_ENABLE_RTTI))
46    set(LLVM_CONFIG_HAS_RTTI NO CACHE INTERNAL "")
47    list(APPEND LLVM_COMPILE_DEFINITIONS GTEST_HAS_RTTI=0)
48    if (LLVM_COMPILER_IS_GCC_COMPATIBLE)
49      list(APPEND LLVM_COMPILE_FLAGS "-fno-rtti")
50    elseif (MSVC)
51      list(APPEND LLVM_COMPILE_FLAGS "/GR-")
52    elseif (CMAKE_CXX_COMPILER_ID MATCHES "XL")
53      list(APPEND LLVM_COMPILE_FLAGS "-qnortti")
54    endif ()
55  elseif(MSVC)
56    list(APPEND LLVM_COMPILE_FLAGS "/GR")
57  endif()
58
59  # Assume that;
60  #   - LLVM_COMPILE_FLAGS is list.
61  #   - PROPERTY COMPILE_FLAGS is string.
62  string(REPLACE ";" " " target_compile_flags " ${LLVM_COMPILE_FLAGS}")
63  string(REPLACE ";" " " target_compile_cflags " ${LLVM_COMPILE_CFLAGS}")
64
65  if(update_src_props)
66    foreach(fn ${sources})
67      get_filename_component(suf ${fn} EXT)
68      if("${suf}" STREQUAL ".cpp")
69        set_property(SOURCE ${fn} APPEND_STRING PROPERTY
70          COMPILE_FLAGS "${target_compile_flags}")
71      endif()
72      if("${suf}" STREQUAL ".c")
73        set_property(SOURCE ${fn} APPEND_STRING PROPERTY
74          COMPILE_FLAGS "${target_compile_cflags}")
75      endif()
76    endforeach()
77  else()
78    # Update target props, since all sources are C++.
79    set_property(TARGET ${name} APPEND_STRING PROPERTY
80      COMPILE_FLAGS "${target_compile_flags}")
81  endif()
82
83  set_property(TARGET ${name} APPEND PROPERTY COMPILE_DEFINITIONS ${LLVM_COMPILE_DEFINITIONS})
84endfunction()
85
86function(add_llvm_symbol_exports target_name export_file)
87  if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
88    set(native_export_file "${target_name}.exports")
89    add_custom_command(OUTPUT ${native_export_file}
90      COMMAND sed -e "s/^/_/" < ${export_file} > ${native_export_file}
91      DEPENDS ${export_file}
92      VERBATIM
93      COMMENT "Creating export file for ${target_name}")
94    set_property(TARGET ${target_name} APPEND_STRING PROPERTY
95                 LINK_FLAGS " -Wl,-exported_symbols_list,\"${CMAKE_CURRENT_BINARY_DIR}/${native_export_file}\"")
96  elseif(${CMAKE_SYSTEM_NAME} MATCHES "AIX")
97    # FIXME: `-Wl,-bE:` bypasses whatever handling there is in the build
98    # compiler driver to defer to the specified export list.
99    set(native_export_file "${export_file}")
100    set_property(TARGET ${target_name} APPEND_STRING PROPERTY
101                 LINK_FLAGS " -Wl,-bE:${export_file}")
102  elseif(LLVM_HAVE_LINK_VERSION_SCRIPT)
103    # Gold and BFD ld require a version script rather than a plain list.
104    set(native_export_file "${target_name}.exports")
105    # FIXME: Don't write the "local:" line on OpenBSD.
106    # in the export file, also add a linker script to version LLVM symbols (form: LLVM_N.M)
107    add_custom_command(OUTPUT ${native_export_file}
108      COMMAND "${Python3_EXECUTABLE}" "-c"
109      "import sys; \
110       lines = ['    ' + l.rstrip() for l in sys.stdin] + ['  local: *;']; \
111       print('LLVM_${LLVM_VERSION_MAJOR}.${LLVM_VERSION_MINOR} {'); \
112       print('  global:') if len(lines) > 1 else None; \
113       print(';\\n'.join(lines) + '\\n};')"
114      < ${export_file} > ${native_export_file}
115      DEPENDS ${export_file}
116      VERBATIM
117      COMMENT "Creating export file for ${target_name}")
118    if (${LLVM_LINKER_IS_SOLARISLD})
119      set_property(TARGET ${target_name} APPEND_STRING PROPERTY
120                   LINK_FLAGS "  -Wl,-M,\"${CMAKE_CURRENT_BINARY_DIR}/${native_export_file}\"")
121    else()
122      set_property(TARGET ${target_name} APPEND_STRING PROPERTY
123                   LINK_FLAGS "  -Wl,--version-script,\"${CMAKE_CURRENT_BINARY_DIR}/${native_export_file}\"")
124    endif()
125  elseif(WIN32)
126    set(native_export_file "${target_name}.def")
127
128    add_custom_command(OUTPUT ${native_export_file}
129      COMMAND "${Python3_EXECUTABLE}" -c "import sys;print(''.join(['EXPORTS\\n']+sys.stdin.readlines(),))"
130        < ${export_file} > ${native_export_file}
131      DEPENDS ${export_file}
132      VERBATIM
133      COMMENT "Creating export file for ${target_name}")
134    set(export_file_linker_flag "${CMAKE_CURRENT_BINARY_DIR}/${native_export_file}")
135    if(MSVC)
136      # cl.exe or clang-cl, i.e. MSVC style command line interface
137      set(export_file_linker_flag "/DEF:\"${export_file_linker_flag}\"")
138    elseif(CMAKE_CXX_SIMULATE_ID STREQUAL "MSVC")
139      # clang in msvc mode, calling a link.exe/lld-link style linker
140      set(export_file_linker_flag "-Wl,/DEF:\"${export_file_linker_flag}\"")
141    elseif(MINGW)
142      # ${export_file_linker_flag}, which is the plain file name, works as is
143      # when passed to the compiler driver, which then passes it on to the
144      # linker as an input file.
145      set(export_file_linker_flag "\"${export_file_linker_flag}\"")
146    else()
147      message(FATAL_ERROR "Unsupported Windows toolchain")
148    endif()
149    set_property(TARGET ${target_name} APPEND_STRING PROPERTY
150                 LINK_FLAGS " ${export_file_linker_flag}")
151  endif()
152
153  add_custom_target(${target_name}_exports DEPENDS ${native_export_file})
154  set_target_properties(${target_name}_exports PROPERTIES FOLDER "Misc")
155
156  get_property(srcs TARGET ${target_name} PROPERTY SOURCES)
157  foreach(src ${srcs})
158    get_filename_component(extension ${src} EXT)
159    if(extension STREQUAL ".cpp")
160      set(first_source_file ${src})
161      break()
162    endif()
163  endforeach()
164
165  # Force re-linking when the exports file changes. Actually, it
166  # forces recompilation of the source file. The LINK_DEPENDS target
167  # property only works for makefile-based generators.
168  # FIXME: This is not safe because this will create the same target
169  # ${native_export_file} in several different file:
170  # - One where we emitted ${target_name}_exports
171  # - One where we emitted the build command for the following object.
172  # set_property(SOURCE ${first_source_file} APPEND PROPERTY
173  #   OBJECT_DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${native_export_file})
174
175  set_property(DIRECTORY APPEND
176    PROPERTY ADDITIONAL_MAKE_CLEAN_FILES ${native_export_file})
177
178  add_dependencies(${target_name} ${target_name}_exports)
179
180  # Add dependency to *_exports later -- CMake issue 14747
181  list(APPEND LLVM_COMMON_DEPENDS ${target_name}_exports)
182  set(LLVM_COMMON_DEPENDS ${LLVM_COMMON_DEPENDS} PARENT_SCOPE)
183endfunction(add_llvm_symbol_exports)
184
185if (NOT DEFINED LLVM_LINKER_DETECTED AND NOT WIN32)
186  # Detect what linker we have here.
187  if(APPLE)
188    # Linkers with ld64-compatible flags.
189    set(version_flag "-Wl,-v")
190  else()
191    # Linkers with BFD ld-compatible flags.
192    set(version_flag "-Wl,--version")
193  endif()
194
195  if (CMAKE_HOST_WIN32)
196    set(DEVNULL "NUL")
197  else()
198    set(DEVNULL "/dev/null")
199  endif()
200
201  if(LLVM_USE_LINKER)
202    set(command ${CMAKE_C_COMPILER} -fuse-ld=${LLVM_USE_LINKER} ${version_flag} -o ${DEVNULL})
203  else()
204    separate_arguments(flags UNIX_COMMAND "${CMAKE_EXE_LINKER_FLAGS}")
205    set(command ${CMAKE_C_COMPILER} ${flags} ${version_flag} -o ${DEVNULL})
206  endif()
207  execute_process(
208    COMMAND ${command}
209    OUTPUT_VARIABLE stdout
210    ERROR_VARIABLE stderr
211    )
212
213  if(APPLE)
214    if("${stderr}" MATCHES "PROGRAM:ld")
215      set(LLVM_LINKER_DETECTED YES CACHE INTERNAL "")
216      set(LLVM_LINKER_IS_APPLE YES CACHE INTERNAL "")
217      message(STATUS "Linker detection: Apple")
218    elseif("${stderr}" MATCHES "^LLD" OR
219           "${stdout}" MATCHES "^LLD")
220      set(LLVM_LINKER_DETECTED YES CACHE INTERNAL "")
221      set(LLVM_LINKER_IS_LLD YES CACHE INTERNAL "")
222      message(STATUS "Linker detection: lld")
223    else()
224      set(LLVM_LINKER_DETECTED NO CACHE INTERNAL "")
225      message(STATUS "Linker detection: unknown")
226    endif()
227  else()
228    if("${stdout}" MATCHES "^mold")
229      set(LLVM_LINKER_DETECTED YES CACHE INTERNAL "")
230      set(LLVM_LINKER_IS_MOLD YES CACHE INTERNAL "")
231      message(STATUS "Linker detection: mold")
232    elseif("${stdout}" MATCHES "GNU gold")
233      set(LLVM_LINKER_DETECTED YES CACHE INTERNAL "")
234      set(LLVM_LINKER_IS_GOLD YES CACHE INTERNAL "")
235      message(STATUS "Linker detection: GNU Gold")
236    elseif("${stdout}" MATCHES "^LLD")
237      set(LLVM_LINKER_DETECTED YES CACHE INTERNAL "")
238      set(LLVM_LINKER_IS_LLD YES CACHE INTERNAL "")
239      message(STATUS "Linker detection: LLD")
240    elseif("${stdout}" MATCHES "GNU ld")
241      set(LLVM_LINKER_DETECTED YES CACHE INTERNAL "")
242      set(LLVM_LINKER_IS_GNULD YES CACHE INTERNAL "")
243      message(STATUS "Linker detection: GNU ld")
244    elseif("${stderr}" MATCHES "(illumos)" OR
245           "${stdout}" MATCHES "(illumos)")
246      set(LLVM_LINKER_DETECTED YES CACHE INTERNAL "")
247      set(LLVM_LINKER_IS_SOLARISLD YES CACHE INTERNAL "")
248      set(LLVM_LINKER_IS_SOLARISLD_ILLUMOS YES CACHE INTERNAL "")
249      message(STATUS "Linker detection: Solaris ld (illumos)")
250    elseif("${stderr}" MATCHES "Solaris Link Editors" OR
251           "${stdout}" MATCHES "Solaris Link Editors")
252      set(LLVM_LINKER_DETECTED YES CACHE INTERNAL "")
253      set(LLVM_LINKER_IS_SOLARISLD YES CACHE INTERNAL "")
254      message(STATUS "Linker detection: Solaris ld")
255    else()
256      set(LLVM_LINKER_DETECTED NO CACHE INTERNAL "")
257      message(STATUS "Linker detection: unknown")
258    endif()
259  endif()
260
261  if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
262    include(CheckLinkerFlag)
263    # Linkers that support Darwin allow a setting to internalize all symbol exports,
264    # aiding in reducing binary size and often is applicable for executables.
265    check_linker_flag(C "-Wl,-no_exported_symbols" LLVM_LINKER_SUPPORTS_NO_EXPORTED_SYMBOLS)
266
267    if (NOT LLVM_USE_LINKER)
268      # Apple's linker complains about duplicate libraries, which CMake likes to do
269      # to support ELF platforms. To silence that warning, we can use
270      # -no_warn_duplicate_libraries, but only in versions of the linker that
271      # support that flag.
272      check_linker_flag(C "-Wl,-no_warn_duplicate_libraries" LLVM_LINKER_SUPPORTS_NO_WARN_DUPLICATE_LIBRARIES)
273    else()
274      set(LLVM_LINKER_SUPPORTS_NO_WARN_DUPLICATE_LIBRARIES OFF CACHE INTERNAL "")
275    endif()
276
277  else()
278    set(LLVM_LINKER_SUPPORTS_NO_EXPORTED_SYMBOLS OFF CACHE INTERNAL "")
279  endif()
280endif()
281
282function(add_link_opts target_name)
283  get_llvm_distribution(${target_name} in_distribution in_distribution_var)
284  if(NOT in_distribution)
285    # Don't LTO optimize targets that aren't part of any distribution.
286    if (LLVM_ENABLE_LTO)
287      # We may consider avoiding LTO altogether by using -fembed-bitcode
288      # and teaching the linker to select machine code from .o files, see
289      # https://lists.llvm.org/pipermail/llvm-dev/2021-April/149843.html
290      if((UNIX OR MINGW) AND LINKER_IS_LLD)
291        set_property(TARGET ${target_name} APPEND_STRING PROPERTY
292                      LINK_FLAGS " -Wl,--lto-O0")
293      elseif(LINKER_IS_LLD_LINK)
294        set_property(TARGET ${target_name} APPEND_STRING PROPERTY
295                      LINK_FLAGS " /opt:lldlto=0")
296      elseif(APPLE AND NOT uppercase_LLVM_ENABLE_LTO STREQUAL "THIN")
297        set_property(TARGET ${target_name} APPEND_STRING PROPERTY
298                      LINK_FLAGS " -Wl,-mllvm,-O0")
299      endif()
300    endif()
301  endif()
302
303  # Don't use linker optimizations in debug builds since it slows down the
304  # linker in a context where the optimizations are not important.
305  if (NOT uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG")
306    if(NOT LLVM_NO_DEAD_STRIP)
307      if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
308        # ld64's implementation of -dead_strip breaks tools that use plugins.
309        set_property(TARGET ${target_name} APPEND_STRING PROPERTY
310                     LINK_FLAGS " -Wl,-dead_strip")
311      elseif(${CMAKE_SYSTEM_NAME} MATCHES "SunOS" AND LLVM_LINKER_IS_SOLARISLD)
312        # Support for ld -z discard-unused=sections was only added in
313        # Solaris 11.4.  GNU ld ignores it, but warns every time.
314        include(LLVMCheckLinkerFlag)
315        llvm_check_linker_flag(CXX "-Wl,-z,discard-unused=sections" LINKER_SUPPORTS_Z_DISCARD_UNUSED)
316        if (LINKER_SUPPORTS_Z_DISCARD_UNUSED)
317          set_property(TARGET ${target_name} APPEND_STRING PROPERTY
318                       LINK_FLAGS " -Wl,-z,discard-unused=sections")
319        endif()
320      elseif(NOT MSVC AND NOT CMAKE_SYSTEM_NAME MATCHES "AIX|OS390")
321        # TODO Revisit this later on z/OS.
322        set_property(TARGET ${target_name} APPEND_STRING PROPERTY
323                     LINK_FLAGS " -Wl,--gc-sections")
324      endif()
325    else() #LLVM_NO_DEAD_STRIP
326      if(${CMAKE_SYSTEM_NAME} MATCHES "AIX")
327        set_property(TARGET ${target_name} APPEND_STRING PROPERTY
328                     LINK_FLAGS " -Wl,-bnogc")
329      endif()
330    endif()
331  endif()
332
333  if(LLVM_LINKER_SUPPORTS_NO_WARN_DUPLICATE_LIBRARIES)
334    set_property(TARGET ${target_name} APPEND_STRING PROPERTY
335                 LINK_FLAGS " -Wl,-no_warn_duplicate_libraries")
336  endif()
337
338  if(ARG_SUPPORT_PLUGINS AND ${CMAKE_SYSTEM_NAME} MATCHES "AIX")
339    set_property(TARGET ${target_name} APPEND_STRING PROPERTY
340                 LINK_FLAGS " -Wl,-brtl")
341  endif()
342endfunction(add_link_opts)
343
344# Set each output directory according to ${CMAKE_CONFIGURATION_TYPES}.
345# Note: Don't set variables CMAKE_*_OUTPUT_DIRECTORY any more,
346# or a certain builder, for eaxample, msbuild.exe, would be confused.
347function(set_output_directory target)
348  cmake_parse_arguments(ARG "" "BINARY_DIR;LIBRARY_DIR" "" ${ARGN})
349
350  # module_dir -- corresponding to LIBRARY_OUTPUT_DIRECTORY.
351  # It affects output of add_library(MODULE).
352  if(WIN32 OR CYGWIN)
353    # DLL platform
354    set(module_dir ${ARG_BINARY_DIR})
355  else()
356    set(module_dir ${ARG_LIBRARY_DIR})
357  endif()
358  if(NOT "${CMAKE_CFG_INTDIR}" STREQUAL ".")
359    foreach(build_mode ${CMAKE_CONFIGURATION_TYPES})
360      string(TOUPPER "${build_mode}" CONFIG_SUFFIX)
361      if(ARG_BINARY_DIR)
362        string(REPLACE ${CMAKE_CFG_INTDIR} ${build_mode} bi ${ARG_BINARY_DIR})
363        set_target_properties(${target} PROPERTIES "RUNTIME_OUTPUT_DIRECTORY_${CONFIG_SUFFIX}" ${bi})
364      endif()
365      if(ARG_LIBRARY_DIR)
366        string(REPLACE ${CMAKE_CFG_INTDIR} ${build_mode} li ${ARG_LIBRARY_DIR})
367        set_target_properties(${target} PROPERTIES "ARCHIVE_OUTPUT_DIRECTORY_${CONFIG_SUFFIX}" ${li})
368      endif()
369      if(module_dir)
370        string(REPLACE ${CMAKE_CFG_INTDIR} ${build_mode} mi ${module_dir})
371        set_target_properties(${target} PROPERTIES "LIBRARY_OUTPUT_DIRECTORY_${CONFIG_SUFFIX}" ${mi})
372      endif()
373    endforeach()
374  else()
375    if(ARG_BINARY_DIR)
376      set_target_properties(${target} PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${ARG_BINARY_DIR})
377    endif()
378    if(ARG_LIBRARY_DIR)
379      set_target_properties(${target} PROPERTIES ARCHIVE_OUTPUT_DIRECTORY ${ARG_LIBRARY_DIR})
380    endif()
381    if(module_dir)
382      set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${module_dir})
383    endif()
384  endif()
385endfunction()
386
387# If on Windows and building with MSVC, add the resource script containing the
388# VERSIONINFO data to the project.  This embeds version resource information
389# into the output .exe or .dll.
390# TODO: Enable for MinGW Windows builds too.
391#
392function(add_windows_version_resource_file OUT_VAR)
393  set(sources ${ARGN})
394  if (MSVC AND CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows")
395    set(resource_file ${LLVM_SOURCE_DIR}/resources/windows_version_resource.rc)
396    if(EXISTS ${resource_file})
397      set(sources ${sources} ${resource_file})
398      source_group("Resource Files" ${resource_file})
399      set(windows_resource_file ${resource_file} PARENT_SCOPE)
400    endif()
401  endif(MSVC AND CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows")
402
403  set(${OUT_VAR} ${sources} PARENT_SCOPE)
404endfunction(add_windows_version_resource_file)
405
406# set_windows_version_resource_properties(name resource_file...
407#   VERSION_MAJOR int
408#     Optional major version number (defaults to LLVM_VERSION_MAJOR)
409#   VERSION_MINOR int
410#     Optional minor version number (defaults to LLVM_VERSION_MINOR)
411#   VERSION_PATCHLEVEL int
412#     Optional patchlevel version number (defaults to LLVM_VERSION_PATCH)
413#   VERSION_STRING
414#     Optional version string (defaults to PACKAGE_VERSION)
415#   PRODUCT_NAME
416#     Optional product name string (defaults to "LLVM")
417#   )
418function(set_windows_version_resource_properties name resource_file)
419  cmake_parse_arguments(ARG
420    ""
421    "VERSION_MAJOR;VERSION_MINOR;VERSION_PATCHLEVEL;VERSION_STRING;PRODUCT_NAME"
422    ""
423    ${ARGN})
424
425  if (NOT DEFINED ARG_VERSION_MAJOR)
426    if (${LLVM_VERSION_MAJOR})
427      set(ARG_VERSION_MAJOR ${LLVM_VERSION_MAJOR})
428    else()
429      set(ARG_VERSION_MAJOR 0)
430    endif()
431  endif()
432
433  if (NOT DEFINED ARG_VERSION_MINOR)
434    if (${LLVM_VERSION_MINOR})
435      set(ARG_VERSION_MINOR ${LLVM_VERSION_MINOR})
436    else()
437      set(ARG_VERSION_MINOR 0)
438    endif()
439  endif()
440
441  if (NOT DEFINED ARG_VERSION_PATCHLEVEL)
442    if (${LLVM_VERSION_PATCH})
443      set(ARG_VERSION_PATCHLEVEL ${LLVM_VERSION_PATCH})
444    else()
445      set(ARG_VERSION_PATCHLEVEL 0)
446    endif()
447  endif()
448
449  if (NOT DEFINED ARG_VERSION_STRING)
450    if (${PACKAGE_VERSION})
451      set(ARG_VERSION_STRING ${PACKAGE_VERSION})
452    else()
453      set(ARG_VERSION_STRING 0)
454    endif()
455  endif()
456
457  if (NOT DEFINED ARG_PRODUCT_NAME)
458    set(ARG_PRODUCT_NAME "LLVM")
459  endif()
460
461  set_property(SOURCE ${resource_file}
462               PROPERTY COMPILE_FLAGS /nologo)
463  set_property(SOURCE ${resource_file}
464               PROPERTY COMPILE_DEFINITIONS
465               "RC_VERSION_FIELD_1=${ARG_VERSION_MAJOR}"
466               "RC_VERSION_FIELD_2=${ARG_VERSION_MINOR}"
467               "RC_VERSION_FIELD_3=${ARG_VERSION_PATCHLEVEL}"
468               "RC_VERSION_FIELD_4=0"
469               "RC_FILE_VERSION=\"${ARG_VERSION_STRING}\""
470               "RC_INTERNAL_NAME=\"${name}\""
471               "RC_PRODUCT_NAME=\"${ARG_PRODUCT_NAME}\""
472               "RC_PRODUCT_VERSION=\"${ARG_VERSION_STRING}\"")
473endfunction(set_windows_version_resource_properties)
474
475# llvm_add_library(name sources...
476#   SHARED;STATIC
477#     STATIC by default w/o BUILD_SHARED_LIBS.
478#     SHARED by default w/  BUILD_SHARED_LIBS.
479#   OBJECT
480#     Also create an OBJECT library target. Default if STATIC && SHARED.
481#   MODULE
482#     Target ${name} might not be created on unsupported platforms.
483#     Check with "if(TARGET ${name})".
484#   DISABLE_LLVM_LINK_LLVM_DYLIB
485#     Do not link this library to libLLVM, even if
486#     LLVM_LINK_LLVM_DYLIB is enabled.
487#   OUTPUT_NAME name
488#     Corresponds to OUTPUT_NAME in target properties.
489#   DEPENDS targets...
490#     Same semantics as add_dependencies().
491#   LINK_COMPONENTS components...
492#     Same as the variable LLVM_LINK_COMPONENTS.
493#   LINK_LIBS lib_targets...
494#     Same semantics as target_link_libraries().
495#   ADDITIONAL_HEADERS
496#     May specify header files for IDE generators.
497#   SONAME
498#     Should set SONAME link flags and create symlinks
499#   NO_INSTALL_RPATH
500#     Suppress default RPATH settings in shared libraries.
501#   PLUGIN_TOOL
502#     The tool (i.e. cmake target) that this plugin will link against
503#   COMPONENT_LIB
504#      This is used to specify that this is a component library of
505#      LLVM which means that the source resides in llvm/lib/ and it is a
506#      candidate for inclusion into libLLVM.so.
507#   )
508function(llvm_add_library name)
509  cmake_parse_arguments(ARG
510    "MODULE;SHARED;STATIC;OBJECT;DISABLE_LLVM_LINK_LLVM_DYLIB;SONAME;NO_INSTALL_RPATH;COMPONENT_LIB"
511    "OUTPUT_NAME;PLUGIN_TOOL;ENTITLEMENTS;BUNDLE_PATH"
512    "ADDITIONAL_HEADERS;DEPENDS;LINK_COMPONENTS;LINK_LIBS;OBJLIBS"
513    ${ARGN})
514  list(APPEND LLVM_COMMON_DEPENDS ${ARG_DEPENDS})
515  if(ARG_ADDITIONAL_HEADERS)
516    # Pass through ADDITIONAL_HEADERS.
517    set(ARG_ADDITIONAL_HEADERS ADDITIONAL_HEADERS ${ARG_ADDITIONAL_HEADERS})
518  endif()
519  if(ARG_OBJLIBS)
520    set(ALL_FILES ${ARG_OBJLIBS})
521  else()
522    llvm_process_sources(ALL_FILES ${ARG_UNPARSED_ARGUMENTS} ${ARG_ADDITIONAL_HEADERS})
523  endif()
524
525  if(ARG_MODULE)
526    if(ARG_SHARED OR ARG_STATIC)
527      message(WARNING "MODULE with SHARED|STATIC doesn't make sense.")
528    endif()
529    # Plugins that link against a tool are allowed even when plugins in general are not
530    if(NOT LLVM_ENABLE_PLUGINS AND NOT (ARG_PLUGIN_TOOL AND LLVM_EXPORT_SYMBOLS_FOR_PLUGINS))
531      message(STATUS "${name} ignored -- Loadable modules not supported on this platform.")
532      return()
533    endif()
534  else()
535    if(ARG_PLUGIN_TOOL)
536      message(WARNING "PLUGIN_TOOL without MODULE doesn't make sense.")
537    endif()
538    if(BUILD_SHARED_LIBS AND NOT ARG_STATIC)
539      set(ARG_SHARED TRUE)
540    endif()
541    if(NOT ARG_SHARED)
542      set(ARG_STATIC TRUE)
543    endif()
544  endif()
545
546  # Generate objlib
547  if((ARG_SHARED AND ARG_STATIC) OR ARG_OBJECT)
548    # Generate an obj library for both targets.
549    set(obj_name "obj.${name}")
550    add_library(${obj_name} OBJECT EXCLUDE_FROM_ALL
551      ${ALL_FILES}
552      )
553    llvm_update_compile_flags(${obj_name})
554    if(CMAKE_GENERATOR STREQUAL "Xcode")
555      set(DUMMY_FILE ${CMAKE_CURRENT_BINARY_DIR}/Dummy.c)
556      file(WRITE ${DUMMY_FILE} "// This file intentionally empty\n")
557      set_property(SOURCE ${DUMMY_FILE} APPEND_STRING PROPERTY COMPILE_FLAGS "-Wno-empty-translation-unit")
558    endif()
559    set(ALL_FILES "$<TARGET_OBJECTS:${obj_name}>" ${DUMMY_FILE})
560
561    # Do add_dependencies(obj) later due to CMake issue 14747.
562    list(APPEND objlibs ${obj_name})
563
564    # Bring in the target include directories from our original target.
565    target_include_directories(${obj_name} PRIVATE $<TARGET_PROPERTY:${name},INCLUDE_DIRECTORIES>)
566
567    set_target_properties(${obj_name} PROPERTIES FOLDER "Object Libraries")
568    if(ARG_DEPENDS)
569      add_dependencies(${obj_name} ${ARG_DEPENDS})
570    endif()
571    # Treat link libraries like PUBLIC dependencies.  LINK_LIBS might
572    # result in generating header files.  Add a dependendency so that
573    # the generated header is created before this object library.
574    if(ARG_LINK_LIBS)
575      cmake_parse_arguments(LINK_LIBS_ARG
576        ""
577        ""
578        "PUBLIC;PRIVATE"
579        ${ARG_LINK_LIBS})
580      foreach(link_lib ${LINK_LIBS_ARG_PUBLIC})
581        if(LLVM_PTHREAD_LIB)
582          # Can't specify a dependence on -lpthread
583          if(NOT ${link_lib} STREQUAL ${LLVM_PTHREAD_LIB})
584            add_dependencies(${obj_name} ${link_lib})
585          endif()
586        else()
587          add_dependencies(${obj_name} ${link_lib})
588        endif()
589      endforeach()
590    endif()
591  endif()
592
593  if(ARG_SHARED AND ARG_STATIC)
594    # static
595    set(name_static "${name}_static")
596    if(ARG_OUTPUT_NAME)
597      set(output_name OUTPUT_NAME "${ARG_OUTPUT_NAME}")
598    endif()
599    # DEPENDS has been appended to LLVM_COMMON_LIBS.
600    llvm_add_library(${name_static} STATIC
601      ${output_name}
602      OBJLIBS ${ALL_FILES} # objlib
603      LINK_LIBS ${ARG_LINK_LIBS}
604      LINK_COMPONENTS ${ARG_LINK_COMPONENTS}
605      )
606
607    # Bring in the target link info from our original target.
608    target_link_directories(${name_static} PRIVATE $<TARGET_PROPERTY:${name},LINK_DIRECTORIES>)
609    target_link_libraries(${name_static} PRIVATE $<TARGET_PROPERTY:${name},LINK_LIBRARIES>)
610
611    # FIXME: Add name_static to anywhere in TARGET ${name}'s PROPERTY.
612    set(ARG_STATIC)
613  endif()
614
615  if(ARG_MODULE)
616    add_library(${name} MODULE ${ALL_FILES})
617  elseif(ARG_SHARED)
618    add_windows_version_resource_file(ALL_FILES ${ALL_FILES})
619    add_library(${name} SHARED ${ALL_FILES})
620  else()
621    add_library(${name} STATIC ${ALL_FILES})
622  endif()
623
624  if(ARG_COMPONENT_LIB)
625    set_target_properties(${name} PROPERTIES LLVM_COMPONENT TRUE)
626    set_property(GLOBAL APPEND PROPERTY LLVM_COMPONENT_LIBS ${name})
627  endif()
628
629  if(NOT ARG_NO_INSTALL_RPATH)
630    if(ARG_MODULE OR ARG_SHARED)
631      llvm_setup_rpath(${name})
632    endif()
633  endif()
634
635  setup_dependency_debugging(${name} ${LLVM_COMMON_DEPENDS})
636
637  if(DEFINED windows_resource_file)
638    set_windows_version_resource_properties(${name} ${windows_resource_file})
639    set(windows_resource_file ${windows_resource_file} PARENT_SCOPE)
640  endif()
641
642  set_output_directory(${name} BINARY_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR} LIBRARY_DIR ${LLVM_LIBRARY_OUTPUT_INTDIR})
643  # $<TARGET_OBJECTS> doesn't require compile flags.
644  if(NOT obj_name)
645    llvm_update_compile_flags(${name})
646  endif()
647  add_link_opts( ${name} )
648  if(ARG_OUTPUT_NAME)
649    set_target_properties(${name}
650      PROPERTIES
651      OUTPUT_NAME ${ARG_OUTPUT_NAME}
652      )
653  endif()
654
655  if(ARG_MODULE)
656    set_target_properties(${name} PROPERTIES
657      PREFIX ""
658      SUFFIX ${LLVM_PLUGIN_EXT}
659      )
660  endif()
661
662  if(ARG_SHARED)
663    if(MSVC)
664      set_target_properties(${name} PROPERTIES
665        PREFIX ""
666        )
667    endif()
668
669    # Set SOVERSION on shared libraries that lack explicit SONAME
670    # specifier, on *nix systems that are not Darwin.
671    if(UNIX AND NOT APPLE AND NOT ARG_SONAME)
672      set_target_properties(${name}
673        PROPERTIES
674        # Since 18.1.0, the ABI version is indicated by the major and minor version.
675        SOVERSION ${LLVM_VERSION_MAJOR}.${LLVM_VERSION_MINOR}${LLVM_VERSION_SUFFIX}
676        VERSION ${LLVM_VERSION_MAJOR}.${LLVM_VERSION_MINOR}${LLVM_VERSION_SUFFIX})
677    endif()
678  endif()
679
680  if(ARG_MODULE OR ARG_SHARED)
681    # Do not add -Dname_EXPORTS to the command-line when building files in this
682    # target. Doing so is actively harmful for the modules build because it
683    # creates extra module variants, and not useful because we don't use these
684    # macros.
685    set_target_properties( ${name} PROPERTIES DEFINE_SYMBOL "" )
686
687    if (LLVM_EXPORTED_SYMBOL_FILE)
688      add_llvm_symbol_exports( ${name} ${LLVM_EXPORTED_SYMBOL_FILE} )
689    endif()
690  endif()
691
692  if(ARG_SHARED)
693    if(NOT APPLE AND ARG_SONAME)
694      get_target_property(output_name ${name} OUTPUT_NAME)
695      if(${output_name} STREQUAL "output_name-NOTFOUND")
696        set(output_name ${name})
697      endif()
698      set(library_name ${output_name}-${LLVM_VERSION_MAJOR}${LLVM_VERSION_SUFFIX})
699      set(api_name ${output_name}-${LLVM_VERSION_MAJOR}.${LLVM_VERSION_MINOR}.${LLVM_VERSION_PATCH}${LLVM_VERSION_SUFFIX})
700      set_target_properties(${name} PROPERTIES OUTPUT_NAME ${library_name})
701      if(UNIX)
702        llvm_install_library_symlink(${api_name} ${library_name} SHARED
703          COMPONENT ${name})
704        llvm_install_library_symlink(${output_name} ${library_name} SHARED
705          COMPONENT ${name})
706      endif()
707    endif()
708  endif()
709
710  if(ARG_STATIC)
711    set(libtype PUBLIC)
712  else()
713    # We can use PRIVATE since SO knows its dependent libs.
714    set(libtype PRIVATE)
715  endif()
716
717  if(ARG_MODULE AND LLVM_EXPORT_SYMBOLS_FOR_PLUGINS AND ARG_PLUGIN_TOOL AND (WIN32 OR CYGWIN))
718    # On DLL platforms symbols are imported from the tool by linking against it.
719    set(llvm_libs ${ARG_PLUGIN_TOOL})
720  elseif (NOT ARG_COMPONENT_LIB)
721    if (LLVM_LINK_LLVM_DYLIB AND NOT ARG_DISABLE_LLVM_LINK_LLVM_DYLIB)
722      set(llvm_libs LLVM)
723    else()
724      llvm_map_components_to_libnames(llvm_libs
725       ${ARG_LINK_COMPONENTS}
726       ${LLVM_LINK_COMPONENTS}
727       )
728    endif()
729  else()
730    # Components have not been defined explicitly in CMake, so add the
731    # dependency information for this library through their name, and let
732    # LLVMBuildResolveComponentsLink resolve the mapping.
733    #
734    # It would be nice to verify that we have the dependencies for this library
735    # name, but using get_property(... SET) doesn't suffice to determine if a
736    # property has been set to an empty value.
737    set_property(TARGET ${name} PROPERTY LLVM_LINK_COMPONENTS ${ARG_LINK_COMPONENTS} ${LLVM_LINK_COMPONENTS})
738
739    # This property is an internal property only used to make sure the
740    # link step applied in LLVMBuildResolveComponentsLink uses the same
741    # property as the target_link_libraries call below.
742    set_property(TARGET ${name} PROPERTY LLVM_LIBTYPE ${libtype})
743  endif()
744
745  target_link_libraries(${name} ${libtype}
746      ${ARG_LINK_LIBS}
747      ${lib_deps}
748      ${llvm_libs}
749      )
750
751  if(LLVM_COMMON_DEPENDS)
752    add_dependencies(${name} ${LLVM_COMMON_DEPENDS})
753    # Add dependencies also to objlibs.
754    # CMake issue 14747 --  add_dependencies() might be ignored to objlib's user.
755    foreach(objlib ${objlibs})
756      add_dependencies(${objlib} ${LLVM_COMMON_DEPENDS})
757    endforeach()
758  endif()
759
760  add_custom_linker_flags(${name})
761
762  if(ARG_SHARED OR ARG_MODULE)
763    llvm_externalize_debuginfo(${name})
764    llvm_codesign(${name} ENTITLEMENTS ${ARG_ENTITLEMENTS} BUNDLE_PATH ${ARG_BUNDLE_PATH})
765  endif()
766  # clang and newer versions of ninja use high-resolutions timestamps,
767  # but older versions of libtool on Darwin don't, so the archive will
768  # often get an older timestamp than the last object that was added
769  # or updated.  To fix this, we add a custom command to touch archive
770  # after it's been built so that ninja won't rebuild it unnecessarily
771  # the next time it's run.
772  if(ARG_STATIC AND LLVM_TOUCH_STATIC_LIBRARIES)
773    add_custom_command(TARGET ${name}
774      POST_BUILD
775      COMMAND touch ${LLVM_LIBRARY_DIR}/${CMAKE_STATIC_LIBRARY_PREFIX}${name}${CMAKE_STATIC_LIBRARY_SUFFIX}
776      )
777  endif()
778endfunction()
779
780function(add_llvm_install_targets target)
781  cmake_parse_arguments(ARG "" "COMPONENT;PREFIX;SYMLINK" "DEPENDS" ${ARGN})
782  if(ARG_COMPONENT)
783    set(component_option -DCMAKE_INSTALL_COMPONENT="${ARG_COMPONENT}")
784  endif()
785  if(ARG_PREFIX)
786    set(prefix_option -DCMAKE_INSTALL_PREFIX="${ARG_PREFIX}")
787  endif()
788
789  set(file_dependencies)
790  set(target_dependencies)
791  foreach(dependency ${ARG_DEPENDS})
792    if(TARGET ${dependency})
793      list(APPEND target_dependencies ${dependency})
794    else()
795      list(APPEND file_dependencies ${dependency})
796    endif()
797  endforeach()
798
799  add_custom_target(${target}
800                    DEPENDS ${file_dependencies}
801                    COMMAND "${CMAKE_COMMAND}"
802                            ${component_option}
803                            ${prefix_option}
804                            -P "${CMAKE_BINARY_DIR}/cmake_install.cmake"
805                    USES_TERMINAL)
806  set_target_properties(${target} PROPERTIES FOLDER "Component Install Targets")
807  add_custom_target(${target}-stripped
808                    DEPENDS ${file_dependencies}
809                    COMMAND "${CMAKE_COMMAND}"
810                            ${component_option}
811                            ${prefix_option}
812                            -DCMAKE_INSTALL_DO_STRIP=1
813                            -P "${CMAKE_BINARY_DIR}/cmake_install.cmake"
814                    USES_TERMINAL)
815  set_target_properties(${target}-stripped PROPERTIES FOLDER "Component Install Targets (Stripped)")
816  if(target_dependencies)
817    add_dependencies(${target} ${target_dependencies})
818    add_dependencies(${target}-stripped ${target_dependencies})
819  endif()
820
821  if(ARG_SYMLINK)
822    add_dependencies(${target} install-${ARG_SYMLINK})
823    add_dependencies(${target}-stripped install-${ARG_SYMLINK}-stripped)
824  endif()
825endfunction()
826
827# Define special targets that behave like a component group. They don't have any
828# source attached but other components can add themselves to them. If the
829# component supports is a Target and it supports JIT compilation, HAS_JIT must
830# be passed. One can use ADD_TO_COMPONENT option from add_llvm_component_library
831# to link extra component into an existing group.
832function(add_llvm_component_group name)
833  cmake_parse_arguments(ARG "HAS_JIT" "" "LINK_COMPONENTS" ${ARGN})
834  add_custom_target(${name})
835  if(ARG_HAS_JIT)
836    set_property(TARGET ${name} PROPERTY COMPONENT_HAS_JIT ON)
837  endif()
838  if(ARG_LINK_COMPONENTS)
839    set_property(TARGET ${name} PROPERTY LLVM_LINK_COMPONENTS ${ARG_LINK_COMPONENTS})
840  endif()
841endfunction()
842
843# An LLVM component is a cmake target with the following cmake properties
844# eventually set:
845#   - LLVM_COMPONENT_NAME: the name of the component, which can be the name of
846#     the associated library or the one specified through COMPONENT_NAME
847#   - LLVM_LINK_COMPONENTS: a list of component this component depends on
848#   - COMPONENT_HAS_JIT: (only for group component) whether this target group
849#     supports JIT compilation
850# Additionnaly, the ADD_TO_COMPONENT <component> option make it possible to add this
851# component to the LLVM_LINK_COMPONENTS of <component>.
852function(add_llvm_component_library name)
853  cmake_parse_arguments(ARG
854    ""
855    "COMPONENT_NAME;ADD_TO_COMPONENT"
856    ""
857    ${ARGN})
858  add_llvm_library(${name} COMPONENT_LIB ${ARG_UNPARSED_ARGUMENTS})
859  string(REGEX REPLACE "^LLVM" "" component_name ${name})
860  set_property(TARGET ${name} PROPERTY LLVM_COMPONENT_NAME ${component_name})
861
862  if(ARG_COMPONENT_NAME)
863    set_property(GLOBAL PROPERTY LLVM_COMPONENT_NAME_${ARG_COMPONENT_NAME} ${component_name})
864  endif()
865
866  if(ARG_ADD_TO_COMPONENT)
867    set_property(TARGET ${ARG_ADD_TO_COMPONENT} APPEND PROPERTY LLVM_LINK_COMPONENTS ${component_name})
868  endif()
869
870endfunction()
871
872macro(add_llvm_library name)
873  cmake_parse_arguments(ARG
874    "SHARED;BUILDTREE_ONLY;MODULE;INSTALL_WITH_TOOLCHAIN"
875    ""
876    ""
877    ${ARGN})
878  if(ARG_MODULE)
879    llvm_add_library(${name} MODULE ${ARG_UNPARSED_ARGUMENTS})
880  elseif( BUILD_SHARED_LIBS OR ARG_SHARED )
881    llvm_add_library(${name} SHARED ${ARG_UNPARSED_ARGUMENTS})
882  else()
883    llvm_add_library(${name} ${ARG_UNPARSED_ARGUMENTS})
884  endif()
885
886  # Libraries that are meant to only be exposed via the build tree only are
887  # never installed and are only exported as a target in the special build tree
888  # config file.
889  if (NOT ARG_BUILDTREE_ONLY AND NOT ARG_MODULE)
890    set_property( GLOBAL APPEND PROPERTY LLVM_LIBS ${name} )
891    set(in_llvm_libs YES)
892  endif()
893
894  if (ARG_MODULE AND NOT TARGET ${name})
895    # Add empty "phony" target
896    add_custom_target(${name})
897  elseif( EXCLUDE_FROM_ALL )
898    set_target_properties( ${name} PROPERTIES EXCLUDE_FROM_ALL ON)
899  elseif(ARG_BUILDTREE_ONLY)
900    set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS_BUILDTREE_ONLY ${name})
901  else()
902    if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY OR ARG_INSTALL_WITH_TOOLCHAIN)
903      if(in_llvm_libs)
904        set(umbrella UMBRELLA llvm-libraries)
905      else()
906        set(umbrella)
907      endif()
908
909      get_target_export_arg(${name} LLVM export_to_llvmexports ${umbrella})
910      install(TARGETS ${name}
911              ${export_to_llvmexports}
912              LIBRARY DESTINATION lib${LLVM_LIBDIR_SUFFIX} COMPONENT ${name}
913              ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX} COMPONENT ${name}
914              RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}" COMPONENT ${name})
915
916      if (NOT LLVM_ENABLE_IDE)
917        add_llvm_install_targets(install-${name}
918                                 DEPENDS ${name}
919                                 COMPONENT ${name})
920      endif()
921    endif()
922    set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS ${name})
923  endif()
924  if (ARG_MODULE)
925    set_target_properties(${name} PROPERTIES FOLDER "Loadable modules")
926  else()
927    set_target_properties(${name} PROPERTIES FOLDER "Libraries")
928  endif()
929endmacro(add_llvm_library name)
930
931macro(generate_llvm_objects name)
932  cmake_parse_arguments(ARG "GENERATE_DRIVER" "" "DEPENDS" ${ARGN})
933
934  llvm_process_sources( ALL_FILES ${ARG_UNPARSED_ARGUMENTS} )
935
936  list(APPEND LLVM_COMMON_DEPENDS ${ARG_DEPENDS})
937
938  # Generate objlib
939  if(LLVM_ENABLE_OBJLIB OR (ARG_GENERATE_DRIVER AND LLVM_TOOL_LLVM_DRIVER_BUILD))
940    # Generate an obj library for both targets.
941    set(obj_name "obj.${name}")
942    add_library(${obj_name} OBJECT EXCLUDE_FROM_ALL
943      ${ALL_FILES}
944      )
945    llvm_update_compile_flags(${obj_name})
946    set(ALL_FILES "$<TARGET_OBJECTS:${obj_name}>")
947    if(ARG_DEPENDS)
948      add_dependencies(${obj_name} ${ARG_DEPENDS})
949    endif()
950
951    set_target_properties(${obj_name} PROPERTIES FOLDER "Object Libraries")
952  endif()
953
954  if (ARG_GENERATE_DRIVER)
955    string(REPLACE "-" "_" TOOL_NAME ${name})
956    foreach(path ${CMAKE_MODULE_PATH})
957      if(EXISTS ${path}/llvm-driver-template.cpp.in)
958        configure_file(
959          ${path}/llvm-driver-template.cpp.in
960          ${CMAKE_CURRENT_BINARY_DIR}/${name}-driver.cpp)
961        break()
962      endif()
963    endforeach()
964
965    list(APPEND ALL_FILES ${CMAKE_CURRENT_BINARY_DIR}/${name}-driver.cpp)
966
967    if (LLVM_TOOL_LLVM_DRIVER_BUILD
968        AND (NOT LLVM_DISTRIBUTION_COMPONENTS OR ${name} IN_LIST LLVM_DISTRIBUTION_COMPONENTS)
969       )
970      set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_COMPONENTS ${LLVM_LINK_COMPONENTS})
971      set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_DEPS ${ARG_DEPENDS} ${LLVM_COMMON_DEPENDS})
972      set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_OBJLIBS "${obj_name}")
973
974      set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_TOOLS ${name})
975      set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_TOOL_ALIASES_${name} ${name})
976      target_link_libraries(${obj_name} ${LLVM_PTHREAD_LIB})
977      llvm_config(${obj_name} ${USE_SHARED} ${LLVM_LINK_COMPONENTS} )
978    endif()
979  endif()
980endmacro()
981
982macro(add_llvm_executable name)
983  cmake_parse_arguments(ARG
984    "DISABLE_LLVM_LINK_LLVM_DYLIB;IGNORE_EXTERNALIZE_DEBUGINFO;NO_INSTALL_RPATH;SUPPORT_PLUGINS"
985    "ENTITLEMENTS;BUNDLE_PATH"
986    ""
987    ${ARGN})
988  generate_llvm_objects(${name} ${ARG_UNPARSED_ARGUMENTS})
989  add_windows_version_resource_file(ALL_FILES ${ALL_FILES})
990
991  if(XCODE)
992    # Note: the dummy.cpp source file provides no definitions. However,
993    # it forces Xcode to properly link the static library.
994    list(APPEND ALL_FILES "${LLVM_MAIN_SRC_DIR}/cmake/dummy.cpp")
995  endif()
996
997  if( EXCLUDE_FROM_ALL )
998    add_executable(${name} EXCLUDE_FROM_ALL ${ALL_FILES})
999  else()
1000    add_executable(${name} ${ALL_FILES})
1001  endif()
1002
1003  setup_dependency_debugging(${name} ${LLVM_COMMON_DEPENDS})
1004
1005  if(NOT ARG_NO_INSTALL_RPATH)
1006    llvm_setup_rpath(${name})
1007  elseif(NOT "${LLVM_LOCAL_RPATH}" STREQUAL "")
1008    # Enable BUILD_WITH_INSTALL_RPATH unless CMAKE_BUILD_RPATH is set.
1009    if("${CMAKE_BUILD_RPATH}" STREQUAL "")
1010      set_property(TARGET ${name} PROPERTY BUILD_WITH_INSTALL_RPATH ON)
1011    endif()
1012
1013    set_property(TARGET ${name} PROPERTY INSTALL_RPATH "${LLVM_LOCAL_RPATH}")
1014  endif()
1015
1016  if(DEFINED windows_resource_file)
1017    set_windows_version_resource_properties(${name} ${windows_resource_file})
1018  endif()
1019
1020  # $<TARGET_OBJECTS> doesn't require compile flags.
1021  if(NOT LLVM_ENABLE_OBJLIB)
1022    llvm_update_compile_flags(${name})
1023  endif()
1024
1025  if (ARG_SUPPORT_PLUGINS AND NOT ${CMAKE_SYSTEM_NAME} MATCHES "AIX")
1026    set(LLVM_NO_DEAD_STRIP On)
1027  endif()
1028
1029  add_link_opts( ${name} )
1030
1031  # Do not add -Dname_EXPORTS to the command-line when building files in this
1032  # target. Doing so is actively harmful for the modules build because it
1033  # creates extra module variants, and not useful because we don't use these
1034  # macros.
1035  set_target_properties( ${name} PROPERTIES DEFINE_SYMBOL "" )
1036
1037  if (LLVM_EXPORTED_SYMBOL_FILE)
1038    add_llvm_symbol_exports( ${name} ${LLVM_EXPORTED_SYMBOL_FILE} )
1039  endif(LLVM_EXPORTED_SYMBOL_FILE)
1040
1041  if (DEFINED LLVM_ENABLE_EXPORTED_SYMBOLS_IN_EXECUTABLES AND
1042      NOT LLVM_ENABLE_EXPORTED_SYMBOLS_IN_EXECUTABLES)
1043    if(LLVM_LINKER_SUPPORTS_NO_EXPORTED_SYMBOLS)
1044      set_property(TARGET ${name} APPEND_STRING PROPERTY
1045        LINK_FLAGS " -Wl,-no_exported_symbols")
1046    else()
1047      message(FATAL_ERROR
1048        "LLVM_ENABLE_EXPORTED_SYMBOLS_IN_EXECUTABLES cannot be disabled when linker does not support \"-no_exported_symbols\"")
1049    endif()
1050  endif()
1051
1052  if (LLVM_LINK_LLVM_DYLIB AND NOT ARG_DISABLE_LLVM_LINK_LLVM_DYLIB)
1053    set(USE_SHARED USE_SHARED)
1054  endif()
1055
1056  set(EXCLUDE_FROM_ALL OFF)
1057  set_output_directory(${name} BINARY_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR} LIBRARY_DIR ${LLVM_LIBRARY_OUTPUT_INTDIR})
1058  llvm_config( ${name} ${USE_SHARED} ${LLVM_LINK_COMPONENTS} )
1059  if( LLVM_COMMON_DEPENDS )
1060    add_dependencies( ${name} ${LLVM_COMMON_DEPENDS} )
1061    foreach(objlib ${obj_name})
1062      add_dependencies(${objlib} ${LLVM_COMMON_DEPENDS})
1063    endforeach()
1064  endif( LLVM_COMMON_DEPENDS )
1065
1066  add_custom_linker_flags(${name})
1067
1068  if(NOT ARG_IGNORE_EXTERNALIZE_DEBUGINFO)
1069    llvm_externalize_debuginfo(${name})
1070  endif()
1071  if (LLVM_PTHREAD_LIB)
1072    # libpthreads overrides some standard library symbols, so main
1073    # executable must be linked with it in order to provide consistent
1074    # API for all shared libaries loaded by this executable.
1075    target_link_libraries(${name} PRIVATE ${LLVM_PTHREAD_LIB})
1076  endif()
1077
1078  if(HAVE_LLVM_LIBC)
1079    target_link_libraries(${name} PRIVATE llvmlibc)
1080  endif()
1081
1082  llvm_codesign(${name} ENTITLEMENTS ${ARG_ENTITLEMENTS} BUNDLE_PATH ${ARG_BUNDLE_PATH})
1083endmacro(add_llvm_executable name)
1084
1085# add_llvm_pass_plugin(name [NO_MODULE] ...)
1086#   Add ${name} as an llvm plugin.
1087#   If option LLVM_${name_upper}_LINK_INTO_TOOLS is set to ON, the plugin is registered statically.
1088#   Otherwise a pluggable shared library is registered.
1089#
1090#   If NO_MODULE is specified, when option LLVM_${name_upper}_LINK_INTO_TOOLS is set to OFF,
1091#   only an object library is built, and no module is built. This is specific to the Polly use case.
1092#
1093#   The SUBPROJECT argument contains the LLVM project the plugin belongs
1094#   to. If set, the plugin will link statically by default it if the
1095#   project was enabled.
1096function(add_llvm_pass_plugin name)
1097  cmake_parse_arguments(ARG
1098    "NO_MODULE" "SUBPROJECT" ""
1099    ${ARGN})
1100
1101  string(TOUPPER ${name} name_upper)
1102
1103  # Enable the plugin by default if it was explicitly enabled by the user.
1104  # Note: If was set to "all", LLVM's CMakeLists.txt replaces it with a
1105  # list of all projects, counting as explicitly enabled.
1106  set(link_into_tools_default OFF)
1107  if (ARG_SUBPROJECT AND LLVM_TOOL_${name_upper}_BUILD)
1108    set(link_into_tools_default ON)
1109  endif()
1110  option(LLVM_${name_upper}_LINK_INTO_TOOLS "Statically link ${name} into tools (if available)" ${link_into_tools_default})
1111
1112  # If we statically link the plugin, don't use llvm dylib because we're going
1113  # to be part of it.
1114  if(LLVM_${name_upper}_LINK_INTO_TOOLS)
1115      list(APPEND ARG_UNPARSED_ARGUMENTS DISABLE_LLVM_LINK_LLVM_DYLIB)
1116  endif()
1117
1118  if(LLVM_${name_upper}_LINK_INTO_TOOLS)
1119    list(REMOVE_ITEM ARG_UNPARSED_ARGUMENTS BUILDTREE_ONLY)
1120    # process_llvm_pass_plugins takes care of the actual linking, just create an
1121    # object library as of now
1122    add_llvm_library(${name} OBJECT ${ARG_UNPARSED_ARGUMENTS})
1123    target_compile_definitions(${name} PRIVATE LLVM_${name_upper}_LINK_INTO_TOOLS)
1124    set_property(TARGET ${name} APPEND PROPERTY COMPILE_DEFINITIONS LLVM_LINK_INTO_TOOLS)
1125    if (TARGET intrinsics_gen)
1126      add_dependencies(obj.${name} intrinsics_gen)
1127    endif()
1128    if (TARGET omp_gen)
1129      add_dependencies(obj.${name} omp_gen)
1130    endif()
1131    if (TARGET acc_gen)
1132      add_dependencies(obj.${name} acc_gen)
1133    endif()
1134    set_property(GLOBAL APPEND PROPERTY LLVM_STATIC_EXTENSIONS ${name})
1135  elseif(NOT ARG_NO_MODULE)
1136    add_llvm_library(${name} MODULE ${ARG_UNPARSED_ARGUMENTS})
1137  else()
1138    add_llvm_library(${name} OBJECT ${ARG_UNPARSED_ARGUMENTS})
1139  endif()
1140  message(STATUS "Registering ${name} as a pass plugin (static build: ${LLVM_${name_upper}_LINK_INTO_TOOLS})")
1141
1142endfunction(add_llvm_pass_plugin)
1143
1144# process_llvm_pass_plugins([GEN_CONFIG])
1145#
1146# Correctly set lib dependencies between plugins and tools, based on tools
1147# registered with the ENABLE_PLUGINS option.
1148#
1149# if GEN_CONFIG option is set, also generate X Macro file for extension
1150# handling. It provides a HANDLE_EXTENSION(extension_namespace, ExtensionProject)
1151# call for each extension allowing client code to define
1152# HANDLE_EXTENSION to have a specific code be run for each extension.
1153#
1154function(process_llvm_pass_plugins)
1155  cmake_parse_arguments(ARG
1156      "GEN_CONFIG" "" ""
1157    ${ARGN})
1158
1159  if(ARG_GEN_CONFIG)
1160      get_property(LLVM_STATIC_EXTENSIONS GLOBAL PROPERTY LLVM_STATIC_EXTENSIONS)
1161  else()
1162      include(LLVMConfigExtensions)
1163  endif()
1164
1165  # Add static plugins to the Extension component
1166  foreach(llvm_extension ${LLVM_STATIC_EXTENSIONS})
1167      set_property(TARGET LLVMExtensions APPEND PROPERTY LINK_LIBRARIES ${llvm_extension})
1168      set_property(TARGET LLVMExtensions APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${llvm_extension})
1169  endforeach()
1170
1171  # Eventually generate the extension headers, and store config to a cmake file
1172  # for usage in third-party configuration.
1173  if(ARG_GEN_CONFIG)
1174
1175      ## Part 1: Extension header to be included whenever we need extension
1176      #  processing.
1177      if(NOT DEFINED LLVM_INSTALL_PACKAGE_DIR)
1178          message(FATAL_ERROR "LLVM_INSTALL_PACKAGE_DIR must be defined and writable. GEN_CONFIG should only be passe when building LLVM proper.")
1179      endif()
1180      # LLVM_INSTALL_PACKAGE_DIR might be absolute, so don't reuse below.
1181      string(REPLACE "${CMAKE_CFG_INTDIR}" "." llvm_cmake_builddir "${LLVM_LIBRARY_DIR}")
1182      set(llvm_cmake_builddir "${llvm_cmake_builddir}/cmake/llvm")
1183      file(WRITE
1184          "${llvm_cmake_builddir}/LLVMConfigExtensions.cmake"
1185          "set(LLVM_STATIC_EXTENSIONS ${LLVM_STATIC_EXTENSIONS})")
1186      install(FILES
1187          ${llvm_cmake_builddir}/LLVMConfigExtensions.cmake
1188          DESTINATION ${LLVM_INSTALL_PACKAGE_DIR}
1189          COMPONENT cmake-exports)
1190
1191      set(ExtensionDef "${LLVM_BINARY_DIR}/include/llvm/Support/Extension.def")
1192      file(WRITE "${ExtensionDef}.tmp" "//extension handlers\n")
1193      foreach(llvm_extension ${LLVM_STATIC_EXTENSIONS})
1194          file(APPEND "${ExtensionDef}.tmp" "HANDLE_EXTENSION(${llvm_extension})\n")
1195      endforeach()
1196      file(APPEND "${ExtensionDef}.tmp" "#undef HANDLE_EXTENSION\n")
1197
1198      # only replace if there's an actual change
1199      execute_process(COMMAND ${CMAKE_COMMAND} -E copy_if_different
1200          "${ExtensionDef}.tmp"
1201          "${ExtensionDef}")
1202      file(REMOVE "${ExtensionDef}.tmp")
1203
1204      ## Part 2: Extension header that captures each extension dependency, to be
1205      #  used by llvm-config.
1206      set(ExtensionDeps "${LLVM_BINARY_DIR}/tools/llvm-config/ExtensionDependencies.inc")
1207
1208      # Max needed to correctly size the required library array.
1209      set(llvm_plugin_max_deps_length 0)
1210      foreach(llvm_extension ${LLVM_STATIC_EXTENSIONS})
1211        get_property(llvm_plugin_deps TARGET ${llvm_extension} PROPERTY LINK_LIBRARIES)
1212        list(LENGTH llvm_plugin_deps llvm_plugin_deps_length)
1213        if(llvm_plugin_deps_length GREATER llvm_plugin_max_deps_length)
1214            set(llvm_plugin_max_deps_length ${llvm_plugin_deps_length})
1215        endif()
1216      endforeach()
1217
1218      list(LENGTH LLVM_STATIC_EXTENSIONS llvm_static_extension_count)
1219      file(WRITE
1220          "${ExtensionDeps}.tmp"
1221          "#include <array>\n\
1222           struct ExtensionDescriptor {\n\
1223              const char* Name;\n\
1224              const char* RequiredLibraries[1 + 1 + ${llvm_plugin_max_deps_length}];\n\
1225           };\n\
1226           std::array<ExtensionDescriptor, ${llvm_static_extension_count}> AvailableExtensions{\n")
1227
1228      foreach(llvm_extension ${LLVM_STATIC_EXTENSIONS})
1229        get_property(llvm_plugin_deps TARGET ${llvm_extension} PROPERTY LINK_LIBRARIES)
1230
1231        file(APPEND "${ExtensionDeps}.tmp" "ExtensionDescriptor{\"${llvm_extension}\", {")
1232        foreach(llvm_plugin_dep ${llvm_plugin_deps})
1233            # Turn library dependency back to component name, if possible.
1234            # That way llvm-config can avoid redundant dependencies.
1235            STRING(REGEX REPLACE "^-l" ""  plugin_dep_name ${llvm_plugin_dep})
1236            STRING(REGEX MATCH "^LLVM" is_llvm_library ${plugin_dep_name})
1237            if(is_llvm_library)
1238                STRING(REGEX REPLACE "^LLVM" ""  plugin_dep_name ${plugin_dep_name})
1239                STRING(TOLOWER ${plugin_dep_name} plugin_dep_name)
1240            endif()
1241            file(APPEND "${ExtensionDeps}.tmp" "\"${plugin_dep_name}\", ")
1242        endforeach()
1243
1244        # Self + mandatory trailing null, because the number of RequiredLibraries differs between extensions.
1245        file(APPEND "${ExtensionDeps}.tmp" \"${llvm_extension}\", "nullptr}},\n")
1246      endforeach()
1247      file(APPEND "${ExtensionDeps}.tmp" "};\n")
1248
1249      # only replace if there's an actual change
1250      execute_process(COMMAND ${CMAKE_COMMAND} -E copy_if_different
1251          "${ExtensionDeps}.tmp"
1252          "${ExtensionDeps}")
1253      file(REMOVE "${ExtensionDeps}.tmp")
1254  endif()
1255endfunction()
1256
1257function(export_executable_symbols target)
1258  if (LLVM_EXPORTED_SYMBOL_FILE)
1259    # The symbol file should contain the symbols we want the executable to
1260    # export
1261    set_target_properties(${target} PROPERTIES ENABLE_EXPORTS 1)
1262  elseif (LLVM_EXPORT_SYMBOLS_FOR_PLUGINS)
1263    # Extract the symbols to export from the static libraries that the
1264    # executable links against.
1265    set_target_properties(${target} PROPERTIES ENABLE_EXPORTS 1)
1266    set(exported_symbol_file ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/${target}.symbols)
1267    # We need to consider not just the direct link dependencies, but also the
1268    # transitive link dependencies. Do this by starting with the set of direct
1269    # dependencies, then the dependencies of those dependencies, and so on.
1270    get_target_property(new_libs ${target} LINK_LIBRARIES)
1271    set(link_libs ${new_libs})
1272    while(NOT "${new_libs}" STREQUAL "")
1273      foreach(lib ${new_libs})
1274        if(TARGET ${lib})
1275          get_target_property(lib_type ${lib} TYPE)
1276          if("${lib_type}" STREQUAL "STATIC_LIBRARY")
1277            list(APPEND static_libs ${lib})
1278          else()
1279            list(APPEND other_libs ${lib})
1280          endif()
1281          get_target_property(transitive_libs ${lib} INTERFACE_LINK_LIBRARIES)
1282          foreach(transitive_lib ${transitive_libs})
1283            if(TARGET ${transitive_lib} AND NOT ${transitive_lib} IN_LIST link_libs)
1284              list(APPEND newer_libs ${transitive_lib})
1285              list(APPEND link_libs ${transitive_lib})
1286            endif()
1287          endforeach(transitive_lib)
1288        endif()
1289      endforeach(lib)
1290      set(new_libs ${newer_libs})
1291      set(newer_libs "")
1292    endwhile()
1293    list(REMOVE_DUPLICATES static_libs)
1294    if (MSVC)
1295      set(mangling microsoft)
1296    else()
1297      set(mangling itanium)
1298    endif()
1299    get_host_tool_path(llvm-nm LLVM_NM llvm_nm_exe llvm_nm_target)
1300    get_host_tool_path(llvm-readobj LLVM_READOBJ llvm_readobj_exe llvm_readobj_target)
1301    add_custom_command(OUTPUT ${exported_symbol_file}
1302                       COMMAND "${Python3_EXECUTABLE}"
1303                         ${LLVM_MAIN_SRC_DIR}/utils/extract_symbols.py
1304                         --mangling=${mangling} ${static_libs}
1305                         -o ${exported_symbol_file}
1306                         --nm=${llvm_nm_exe}
1307                         --readobj=${llvm_readobj_exe}
1308                       WORKING_DIRECTORY ${LLVM_LIBRARY_OUTPUT_INTDIR}
1309                       DEPENDS ${LLVM_MAIN_SRC_DIR}/utils/extract_symbols.py
1310                         ${static_libs} ${llvm_nm_target} ${llvm_readobj_target}
1311                       VERBATIM
1312                       COMMENT "Generating export list for ${target}")
1313    add_llvm_symbol_exports( ${target} ${exported_symbol_file} )
1314    # If something links against this executable then we want a
1315    # transitive link against only the libraries whose symbols
1316    # we aren't exporting.
1317    set_target_properties(${target} PROPERTIES INTERFACE_LINK_LIBRARIES "${other_libs}")
1318    # The default import library suffix that cmake uses for cygwin/mingw is
1319    # ".dll.a", but for clang.exe that causes a collision with libclang.dll,
1320    # where the import libraries of both get named libclang.dll.a. Use a suffix
1321    # of ".exe.a" to avoid this.
1322    if(CYGWIN OR MINGW)
1323      set_target_properties(${target} PROPERTIES IMPORT_SUFFIX ".exe.a")
1324    endif()
1325  elseif(NOT (WIN32 OR CYGWIN))
1326    # On Windows auto-exporting everything doesn't work because of the limit on
1327    # the size of the exported symbol table, but on other platforms we can do
1328    # it without any trouble.
1329    set_target_properties(${target} PROPERTIES ENABLE_EXPORTS 1)
1330    # CMake doesn't set CMAKE_EXE_EXPORTS_${lang}_FLAG on Solaris, so
1331    # ENABLE_EXPORTS has no effect.  While Solaris ld defaults to -rdynamic
1332    # behaviour, GNU ld needs it.
1333    if (APPLE OR ${CMAKE_SYSTEM_NAME} STREQUAL "SunOS")
1334      set_property(TARGET ${target} APPEND_STRING PROPERTY
1335        LINK_FLAGS " -rdynamic")
1336    endif()
1337  endif()
1338endfunction()
1339
1340# Export symbols if LLVM plugins are enabled.
1341function(export_executable_symbols_for_plugins target)
1342  if(LLVM_ENABLE_PLUGINS OR LLVM_EXPORT_SYMBOLS_FOR_PLUGINS)
1343    export_executable_symbols(${target})
1344  endif()
1345endfunction()
1346
1347if(NOT LLVM_TOOLCHAIN_TOOLS)
1348  set (LLVM_TOOLCHAIN_TOOLS
1349    llvm-ar
1350    llvm-cov
1351    llvm-cxxfilt
1352    llvm-dlltool
1353    llvm-dwp
1354    llvm-ranlib
1355    llvm-lib
1356    llvm-mca
1357    llvm-ml
1358    llvm-nm
1359    llvm-objcopy
1360    llvm-objdump
1361    llvm-pdbutil
1362    llvm-rc
1363    llvm-readobj
1364    llvm-size
1365    llvm-strings
1366    llvm-strip
1367    llvm-profdata
1368    llvm-symbolizer
1369    # symlink version of some of above tools that are enabled by
1370    # LLVM_INSTALL_BINUTILS_SYMLINKS.
1371    addr2line
1372    ar
1373    c++filt
1374    ranlib
1375    nm
1376    objcopy
1377    objdump
1378    readelf
1379    size
1380    strings
1381    strip
1382    )
1383  # Build llvm-mt if libxml2 is enabled. Can be used by runtimes.
1384  if (LLVM_ENABLE_LIBXML2)
1385    list(APPEND LLVM_TOOLCHAIN_TOOLS llvm-mt)
1386  endif()
1387endif()
1388
1389macro(llvm_add_tool project name)
1390  cmake_parse_arguments(ARG "DEPENDS;GENERATE_DRIVER" "" "" ${ARGN})
1391  if( NOT LLVM_BUILD_TOOLS )
1392    set(EXCLUDE_FROM_ALL ON)
1393  endif()
1394  if(ARG_GENERATE_DRIVER
1395     AND LLVM_TOOL_LLVM_DRIVER_BUILD
1396     AND (NOT LLVM_DISTRIBUTION_COMPONENTS OR ${name} IN_LIST LLVM_DISTRIBUTION_COMPONENTS)
1397    )
1398    generate_llvm_objects(${name} ${ARGN})
1399    add_custom_target(${name} DEPENDS llvm-driver)
1400  else()
1401    add_llvm_executable(${name} ${ARGN})
1402
1403    if ( ${name} IN_LIST LLVM_TOOLCHAIN_TOOLS OR NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
1404      if( LLVM_BUILD_TOOLS )
1405        get_target_export_arg(${name} LLVM export_to_llvmexports)
1406        install(TARGETS ${name}
1407                ${export_to_llvmexports}
1408                RUNTIME DESTINATION ${${project}_TOOLS_INSTALL_DIR}
1409                COMPONENT ${name})
1410
1411        if (NOT LLVM_ENABLE_IDE)
1412          add_llvm_install_targets(install-${name}
1413                                  DEPENDS ${name}
1414                                  COMPONENT ${name})
1415        endif()
1416      endif()
1417    endif()
1418    if( LLVM_BUILD_TOOLS )
1419      set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS ${name})
1420    endif()
1421    set_target_properties(${name} PROPERTIES FOLDER "Tools")
1422  endif()
1423endmacro(llvm_add_tool project name)
1424
1425macro(add_llvm_tool name)
1426  llvm_add_tool(LLVM ${ARGV})
1427endmacro()
1428
1429
1430macro(add_llvm_example name)
1431  if( NOT LLVM_BUILD_EXAMPLES )
1432    set(EXCLUDE_FROM_ALL ON)
1433  endif()
1434  add_llvm_executable(${name} ${ARGN})
1435  if( LLVM_BUILD_EXAMPLES )
1436    install(TARGETS ${name} RUNTIME DESTINATION "${LLVM_EXAMPLES_INSTALL_DIR}")
1437  endif()
1438  set_target_properties(${name} PROPERTIES FOLDER "Examples")
1439endmacro(add_llvm_example name)
1440
1441macro(add_llvm_example_library name)
1442  if( NOT LLVM_BUILD_EXAMPLES )
1443    set(EXCLUDE_FROM_ALL ON)
1444    add_llvm_library(${name} BUILDTREE_ONLY ${ARGN})
1445  else()
1446    add_llvm_library(${name} ${ARGN})
1447  endif()
1448
1449  set_target_properties(${name} PROPERTIES FOLDER "Examples")
1450endmacro(add_llvm_example_library name)
1451
1452# This is a macro that is used to create targets for executables that are needed
1453# for development, but that are not intended to be installed by default.
1454macro(add_llvm_utility name)
1455  if ( NOT LLVM_BUILD_UTILS )
1456    set(EXCLUDE_FROM_ALL ON)
1457  endif()
1458
1459  add_llvm_executable(${name} DISABLE_LLVM_LINK_LLVM_DYLIB ${ARGN})
1460  set_target_properties(${name} PROPERTIES FOLDER "Utils")
1461  if ( ${name} IN_LIST LLVM_TOOLCHAIN_UTILITIES OR NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
1462    if (LLVM_INSTALL_UTILS AND LLVM_BUILD_UTILS)
1463      get_target_export_arg(${name} LLVM export_to_llvmexports)
1464      install(TARGETS ${name}
1465              ${export_to_llvmexports}
1466              RUNTIME DESTINATION ${LLVM_UTILS_INSTALL_DIR}
1467              COMPONENT ${name})
1468
1469      if (NOT LLVM_ENABLE_IDE)
1470        add_llvm_install_targets(install-${name}
1471                                 DEPENDS ${name}
1472                                 COMPONENT ${name})
1473      endif()
1474      set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS ${name})
1475    elseif(LLVM_BUILD_UTILS)
1476      set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS_BUILDTREE_ONLY ${name})
1477    endif()
1478  endif()
1479endmacro(add_llvm_utility name)
1480
1481macro(add_llvm_fuzzer name)
1482  cmake_parse_arguments(ARG "" "DUMMY_MAIN" "" ${ARGN})
1483  if( LLVM_LIB_FUZZING_ENGINE )
1484    set(LLVM_OPTIONAL_SOURCES ${ARG_DUMMY_MAIN})
1485    add_llvm_executable(${name} ${ARG_UNPARSED_ARGUMENTS})
1486    target_link_libraries(${name} PRIVATE ${LLVM_LIB_FUZZING_ENGINE})
1487    set_target_properties(${name} PROPERTIES FOLDER "Fuzzers")
1488  elseif( LLVM_USE_SANITIZE_COVERAGE )
1489    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=fuzzer")
1490    set(LLVM_OPTIONAL_SOURCES ${ARG_DUMMY_MAIN})
1491    add_llvm_executable(${name} ${ARG_UNPARSED_ARGUMENTS})
1492    set_target_properties(${name} PROPERTIES FOLDER "Fuzzers")
1493  elseif( ARG_DUMMY_MAIN )
1494    add_llvm_executable(${name} ${ARG_DUMMY_MAIN} ${ARG_UNPARSED_ARGUMENTS})
1495    set_target_properties(${name} PROPERTIES FOLDER "Fuzzers")
1496  endif()
1497endmacro()
1498
1499macro(add_llvm_target target_name)
1500  include_directories(BEFORE
1501    ${CMAKE_CURRENT_BINARY_DIR}
1502    ${CMAKE_CURRENT_SOURCE_DIR})
1503  add_llvm_component_library(LLVM${target_name} ${ARGN})
1504  set( CURRENT_LLVM_TARGET LLVM${target_name} )
1505endmacro(add_llvm_target)
1506
1507function(canonicalize_tool_name name output)
1508  string(REPLACE "${CMAKE_CURRENT_SOURCE_DIR}/" "" nameStrip ${name})
1509  string(REPLACE "-" "_" nameUNDERSCORE ${nameStrip})
1510  string(TOUPPER ${nameUNDERSCORE} nameUPPER)
1511  set(${output} "${nameUPPER}" PARENT_SCOPE)
1512endfunction(canonicalize_tool_name)
1513
1514# Custom add_subdirectory wrapper
1515# Takes in a project name (i.e. LLVM), the subdirectory name, and an optional
1516# path if it differs from the name.
1517function(add_llvm_subdirectory project type name)
1518  set(add_llvm_external_dir "${ARGN}")
1519  if("${add_llvm_external_dir}" STREQUAL "")
1520    set(add_llvm_external_dir ${name})
1521  endif()
1522  canonicalize_tool_name(${name} nameUPPER)
1523  set(canonical_full_name ${project}_${type}_${nameUPPER})
1524  get_property(already_processed GLOBAL PROPERTY ${canonical_full_name}_PROCESSED)
1525  if(already_processed)
1526    return()
1527  endif()
1528  set_property(GLOBAL PROPERTY ${canonical_full_name}_PROCESSED YES)
1529
1530  if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${add_llvm_external_dir}/CMakeLists.txt)
1531    # Treat it as in-tree subproject.
1532    option(${canonical_full_name}_BUILD
1533           "Whether to build ${name} as part of ${project}" On)
1534    mark_as_advanced(${project}_${type}_${name}_BUILD)
1535    if(${canonical_full_name}_BUILD)
1536      add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/${add_llvm_external_dir} ${add_llvm_external_dir})
1537    endif()
1538  else()
1539    set(LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR
1540      "${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR}"
1541      CACHE PATH "Path to ${name} source directory")
1542    set(${canonical_full_name}_BUILD_DEFAULT ON)
1543    if(NOT LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR OR NOT EXISTS ${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR})
1544      set(${canonical_full_name}_BUILD_DEFAULT OFF)
1545    endif()
1546    if("${LLVM_EXTERNAL_${nameUPPER}_BUILD}" STREQUAL "OFF")
1547      set(${canonical_full_name}_BUILD_DEFAULT OFF)
1548    endif()
1549    option(${canonical_full_name}_BUILD
1550      "Whether to build ${name} as part of LLVM"
1551      ${${canonical_full_name}_BUILD_DEFAULT})
1552    if (${canonical_full_name}_BUILD)
1553      if(EXISTS ${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR})
1554        add_subdirectory(${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR} ${add_llvm_external_dir})
1555      elseif(NOT "${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR}" STREQUAL "")
1556        message(WARNING "Nonexistent directory for ${name}: ${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR}")
1557      endif()
1558    endif()
1559  endif()
1560endfunction()
1561
1562# Add external project that may want to be built as part of llvm such as Clang,
1563# lld, and Polly. This adds two options. One for the source directory of the
1564# project, which defaults to ${CMAKE_CURRENT_SOURCE_DIR}/${name}. Another to
1565# enable or disable building it with everything else.
1566# Additional parameter can be specified as the name of directory.
1567macro(add_llvm_external_project name)
1568  add_llvm_subdirectory(LLVM TOOL ${name} ${ARGN})
1569endmacro()
1570
1571macro(add_llvm_tool_subdirectory name)
1572  add_llvm_external_project(${name})
1573endmacro(add_llvm_tool_subdirectory)
1574
1575macro(add_custom_linker_flags name)
1576  if (LLVM_${name}_LINKER_FLAGS)
1577    message(DEBUG "Applying ${LLVM_${name}_LINKER_FLAGS} to ${name}")
1578    target_link_options(${name} PRIVATE ${LLVM_${name}_LINKER_FLAGS})
1579  endif()
1580endmacro()
1581
1582function(get_project_name_from_src_var var output)
1583  string(REGEX MATCH "LLVM_EXTERNAL_(.*)_SOURCE_DIR"
1584         MACHED_TOOL "${var}")
1585  if(MACHED_TOOL)
1586    set(${output} ${CMAKE_MATCH_1} PARENT_SCOPE)
1587  else()
1588    set(${output} PARENT_SCOPE)
1589  endif()
1590endfunction()
1591
1592function(create_subdirectory_options project type)
1593  file(GLOB sub-dirs "${CMAKE_CURRENT_SOURCE_DIR}/*")
1594  foreach(dir ${sub-dirs})
1595    if(IS_DIRECTORY "${dir}" AND EXISTS "${dir}/CMakeLists.txt")
1596      canonicalize_tool_name(${dir} name)
1597      option(${project}_${type}_${name}_BUILD
1598           "Whether to build ${name} as part of ${project}" On)
1599      mark_as_advanced(${project}_${type}_${name}_BUILD)
1600    endif()
1601  endforeach()
1602endfunction(create_subdirectory_options)
1603
1604function(create_llvm_tool_options)
1605  create_subdirectory_options(LLVM TOOL)
1606endfunction(create_llvm_tool_options)
1607
1608function(llvm_add_implicit_projects project)
1609  set(list_of_implicit_subdirs "")
1610  file(GLOB sub-dirs "${CMAKE_CURRENT_SOURCE_DIR}/*")
1611  foreach(dir ${sub-dirs})
1612    if(IS_DIRECTORY "${dir}" AND EXISTS "${dir}/CMakeLists.txt")
1613      canonicalize_tool_name(${dir} name)
1614      # I don't like special casing things by order, but the llvm-driver ends up
1615      # linking the object libraries from all the tools that opt-in, so adding
1616      # it separately at the end is probably the simplest case.
1617      if("${name}" STREQUAL "LLVM_DRIVER")
1618        continue()
1619      endif()
1620      if (${project}_TOOL_${name}_BUILD)
1621        get_filename_component(fn "${dir}" NAME)
1622        list(APPEND list_of_implicit_subdirs "${fn}")
1623      endif()
1624    endif()
1625  endforeach()
1626
1627  foreach(external_proj ${list_of_implicit_subdirs})
1628    add_llvm_subdirectory(${project} TOOL "${external_proj}" ${ARGN})
1629  endforeach()
1630endfunction(llvm_add_implicit_projects)
1631
1632function(add_llvm_implicit_projects)
1633  llvm_add_implicit_projects(LLVM)
1634endfunction(add_llvm_implicit_projects)
1635
1636# Generic support for adding a unittest.
1637function(add_unittest test_suite test_name)
1638  if( NOT LLVM_BUILD_TESTS )
1639    set(EXCLUDE_FROM_ALL ON)
1640  endif()
1641
1642  if (SUPPORTS_VARIADIC_MACROS_FLAG)
1643    list(APPEND LLVM_COMPILE_FLAGS "-Wno-variadic-macros")
1644  endif ()
1645  # Some parts of gtest rely on this GNU extension, don't warn on it.
1646  if(SUPPORTS_GNU_ZERO_VARIADIC_MACRO_ARGUMENTS_FLAG)
1647    list(APPEND LLVM_COMPILE_FLAGS "-Wno-gnu-zero-variadic-macro-arguments")
1648  endif()
1649
1650  if (NOT DEFINED LLVM_REQUIRES_RTTI)
1651    set(LLVM_REQUIRES_RTTI OFF)
1652  endif()
1653
1654  list(APPEND LLVM_LINK_COMPONENTS Support) # gtest needs it for raw_ostream
1655  add_llvm_executable(${test_name} IGNORE_EXTERNALIZE_DEBUGINFO NO_INSTALL_RPATH ${ARGN})
1656
1657  # The runtime benefits of LTO don't outweight the compile time costs for tests.
1658  if(LLVM_ENABLE_LTO)
1659    if((UNIX OR MINGW) AND LINKER_IS_LLD)
1660      if(LLVM_ENABLE_FATLTO AND NOT APPLE)
1661        # When using FatLTO, just use relocatable linking.
1662        set_property(TARGET ${test_name} APPEND_STRING PROPERTY
1663                      LINK_FLAGS " -Wl,--no-fat-lto-objects")
1664      else()
1665        set_property(TARGET ${test_name} APPEND_STRING PROPERTY
1666                      LINK_FLAGS " -Wl,--lto-O0")
1667      endif()
1668    elseif(LINKER_IS_LLD_LINK)
1669      set_property(TARGET ${test_name} APPEND_STRING PROPERTY
1670                    LINK_FLAGS " /opt:lldlto=0")
1671    elseif(APPLE AND NOT uppercase_LLVM_ENABLE_LTO STREQUAL "THIN")
1672      set_property(TARGET ${target_name} APPEND_STRING PROPERTY
1673                    LINK_FLAGS " -Wl,-mllvm,-O0")
1674    endif()
1675  endif()
1676
1677  target_link_options(${test_name} PRIVATE "${LLVM_UNITTEST_LINK_FLAGS}")
1678
1679  set(outdir ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR})
1680  set_output_directory(${test_name} BINARY_DIR ${outdir} LIBRARY_DIR ${outdir})
1681  # libpthreads overrides some standard library symbols, so main
1682  # executable must be linked with it in order to provide consistent
1683  # API for all shared libaries loaded by this executable.
1684  target_link_libraries(${test_name} PRIVATE llvm_gtest_main llvm_gtest ${LLVM_PTHREAD_LIB})
1685
1686  add_dependencies(${test_suite} ${test_name})
1687  get_target_property(test_suite_folder ${test_suite} FOLDER)
1688  if (test_suite_folder)
1689    set_property(TARGET ${test_name} PROPERTY FOLDER "${test_suite_folder}")
1690  endif ()
1691endfunction()
1692
1693# Use for test binaries that call llvm::getInputFileDirectory(). Use of this
1694# is discouraged.
1695function(add_unittest_with_input_files test_suite test_name)
1696  set(LLVM_UNITTEST_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
1697  configure_file(
1698    ${LLVM_MAIN_SRC_DIR}/unittests/unittest.cfg.in
1699    ${CMAKE_CURRENT_BINARY_DIR}/llvm.srcdir.txt)
1700
1701  add_unittest(${test_suite} ${test_name} ${ARGN})
1702endfunction()
1703
1704# Generic support for adding a benchmark.
1705function(add_benchmark benchmark_name)
1706  if( NOT LLVM_BUILD_BENCHMARKS )
1707    set(EXCLUDE_FROM_ALL ON)
1708  endif()
1709
1710  add_llvm_executable(${benchmark_name} IGNORE_EXTERNALIZE_DEBUGINFO NO_INSTALL_RPATH ${ARGN})
1711  set(outdir ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR})
1712  set_output_directory(${benchmark_name} BINARY_DIR ${outdir} LIBRARY_DIR ${outdir})
1713  set_property(TARGET ${benchmark_name} PROPERTY FOLDER "Utils")
1714  target_link_libraries(${benchmark_name} PRIVATE benchmark)
1715endfunction()
1716
1717# This function canonicalize the CMake variables passed by names
1718# from CMake boolean to 0/1 suitable for passing into Python or C++,
1719# in place.
1720function(llvm_canonicalize_cmake_booleans)
1721  foreach(var ${ARGN})
1722    if(${var})
1723      set(${var} 1 PARENT_SCOPE)
1724    else()
1725      set(${var} 0 PARENT_SCOPE)
1726    endif()
1727  endforeach()
1728endfunction(llvm_canonicalize_cmake_booleans)
1729
1730macro(set_llvm_build_mode)
1731  # Configuration-time: See Unit/lit.site.cfg.in
1732  if (CMAKE_CFG_INTDIR STREQUAL ".")
1733    set(LLVM_BUILD_MODE ".")
1734  else ()
1735    set(LLVM_BUILD_MODE "%(build_mode)s")
1736  endif ()
1737endmacro()
1738
1739# Takes a list of path names in pathlist and a base directory, and returns
1740# a list of paths relative to the base directory in out_pathlist.
1741# Paths that are on a different drive than the basedir (on Windows) or that
1742# contain symlinks are returned absolute.
1743# Use with LLVM_LIT_PATH_FUNCTION below.
1744function(make_paths_relative out_pathlist basedir pathlist)
1745  # Passing ARG_PATH_VALUES as-is to execute_process() makes cmake strip
1746  # empty list entries. So escape the ;s in the list and do the splitting
1747  # ourselves. cmake has no relpath function, so use Python for that.
1748  string(REPLACE ";" "\\;" pathlist_escaped "${pathlist}")
1749  execute_process(COMMAND "${Python3_EXECUTABLE}" "-c" "\n
1750import os, sys\n
1751base = sys.argv[1]
1752def haslink(p):\n
1753    if not p or p == os.path.dirname(p): return False\n
1754    return os.path.islink(p) or haslink(os.path.dirname(p))\n
1755def relpath(p):\n
1756    if not p: return ''\n
1757    if os.path.splitdrive(p)[0] != os.path.splitdrive(base)[0]: return p\n
1758    if haslink(p) or haslink(base): return p\n
1759    return os.path.relpath(p, base)\n
1760if len(sys.argv) < 3: sys.exit(0)\n
1761sys.stdout.write(';'.join(relpath(p) for p in sys.argv[2].split(';')))"
1762    ${basedir}
1763    ${pathlist_escaped}
1764    OUTPUT_VARIABLE pathlist_relative
1765    ERROR_VARIABLE error
1766    RESULT_VARIABLE result)
1767  if (NOT result EQUAL 0)
1768    message(FATAL_ERROR "make_paths_relative() failed due to error '${result}', with stderr\n${error}")
1769  endif()
1770  set(${out_pathlist} "${pathlist_relative}" PARENT_SCOPE)
1771endfunction()
1772
1773# Converts a file that's relative to the current python file to an absolute
1774# path. Since this uses __file__, it has to be emitted into python files that
1775# use it and can't be in a lit module. Use with make_paths_relative().
1776string(CONCAT LLVM_LIT_PATH_FUNCTION
1777  "# Allow generated file to be relocatable.\n"
1778  "import os\n"
1779  "import platform\n"
1780  "def path(p):\n"
1781  "    if not p: return ''\n"
1782  "    # Follows lit.util.abs_path_preserve_drive, which cannot be imported here.\n"
1783  "    if platform.system() == 'Windows':\n"
1784  "        return os.path.abspath(os.path.join(os.path.dirname(__file__), p))\n"
1785  "    else:\n"
1786  "        return os.path.realpath(os.path.join(os.path.dirname(__file__), p))\n"
1787  )
1788
1789# This function provides an automatic way to 'configure'-like generate a file
1790# based on a set of common and custom variables, specifically targeting the
1791# variables needed for the 'lit.site.cfg' files. This function bundles the
1792# common variables that any Lit instance is likely to need, and custom
1793# variables can be passed in.
1794# The keyword PATHS is followed by a list of cmake variable names that are
1795# mentioned as `path("@varname@")` in the lit.cfg.py.in file. Variables in that
1796# list are treated as paths that are relative to the directory the generated
1797# lit.cfg.py file is in, and the `path()` function converts the relative
1798# path back to absolute form. This makes it possible to move a build directory
1799# containing lit.cfg.py files from one machine to another.
1800function(configure_lit_site_cfg site_in site_out)
1801  cmake_parse_arguments(ARG "" "" "MAIN_CONFIG;PATHS" ${ARGN})
1802
1803  if ("${ARG_MAIN_CONFIG}" STREQUAL "")
1804    get_filename_component(INPUT_DIR ${site_in} DIRECTORY)
1805    set(ARG_MAIN_CONFIG "${INPUT_DIR}/lit.cfg")
1806  endif()
1807
1808  foreach(c ${LLVM_TARGETS_TO_BUILD})
1809    set(TARGETS_BUILT "${TARGETS_BUILT} ${c}")
1810  endforeach(c)
1811  set(TARGETS_TO_BUILD ${TARGETS_BUILT})
1812
1813  set(SHLIBEXT "${LTDL_SHLIB_EXT}")
1814
1815  set_llvm_build_mode()
1816
1817  # For standalone builds of subprojects, these might not be the build tree but
1818  # a provided binary tree.
1819  set(LLVM_SOURCE_DIR ${LLVM_MAIN_SRC_DIR})
1820  set(LLVM_BINARY_DIR ${LLVM_BINARY_DIR})
1821  string(REPLACE "${CMAKE_CFG_INTDIR}" "${LLVM_BUILD_MODE}" LLVM_TOOLS_DIR "${LLVM_TOOLS_BINARY_DIR}")
1822  string(REPLACE "${CMAKE_CFG_INTDIR}" "${LLVM_BUILD_MODE}" LLVM_LIBS_DIR  "${LLVM_LIBRARY_DIR}")
1823  # Like LLVM_{TOOLS,LIBS}_DIR, but pointing at the build tree.
1824  string(REPLACE "${CMAKE_CFG_INTDIR}" "${LLVM_BUILD_MODE}" CURRENT_TOOLS_DIR "${LLVM_RUNTIME_OUTPUT_INTDIR}")
1825  string(REPLACE "${CMAKE_CFG_INTDIR}" "${LLVM_BUILD_MODE}" CURRENT_LIBS_DIR  "${LLVM_LIBRARY_OUTPUT_INTDIR}")
1826  string(REPLACE "${CMAKE_CFG_INTDIR}" "${LLVM_BUILD_MODE}" SHLIBDIR "${LLVM_SHLIB_OUTPUT_INTDIR}")
1827
1828  # FIXME: "ENABLE_SHARED" doesn't make sense, since it is used just for
1829  # plugins. We may rename it.
1830  if(LLVM_ENABLE_PLUGINS)
1831    set(ENABLE_SHARED "1")
1832  else()
1833    set(ENABLE_SHARED "0")
1834  endif()
1835
1836  if(LLVM_ENABLE_ASSERTIONS)
1837    set(ENABLE_ASSERTIONS "1")
1838  else()
1839    set(ENABLE_ASSERTIONS "0")
1840  endif()
1841
1842  set(HOST_OS ${CMAKE_SYSTEM_NAME})
1843  set(HOST_ARCH ${CMAKE_SYSTEM_PROCESSOR})
1844
1845  set(HOST_CC "${CMAKE_C_COMPILER} ${CMAKE_C_COMPILER_ARG1}")
1846  set(HOST_CXX "${CMAKE_CXX_COMPILER} ${CMAKE_CXX_COMPILER_ARG1}")
1847  set(HOST_LDFLAGS "${CMAKE_EXE_LINKER_FLAGS}")
1848
1849  string(CONCAT LIT_SITE_CFG_IN_HEADER
1850    "# Autogenerated from ${site_in}\n# Do not edit!\n\n"
1851    "${LLVM_LIT_PATH_FUNCTION}"
1852    )
1853
1854  # Override config_target_triple (and the env)
1855  if(LLVM_TARGET_TRIPLE_ENV)
1856    # This is expanded into the heading.
1857    string(CONCAT LIT_SITE_CFG_IN_HEADER "${LIT_SITE_CFG_IN_HEADER}"
1858      "import os\n"
1859      "target_env = \"${LLVM_TARGET_TRIPLE_ENV}\"\n"
1860      "config.target_triple = config.environment[target_env] = os.environ.get(target_env, \"${LLVM_TARGET_TRIPLE}\")\n"
1861      )
1862
1863    # This is expanded to; config.target_triple = ""+config.target_triple+""
1864    set(LLVM_TARGET_TRIPLE "\"+config.target_triple+\"")
1865  endif()
1866
1867  if (ARG_PATHS)
1868    # Walk ARG_PATHS and collect the current value of the variables in there.
1869    # list(APPEND) ignores empty elements exactly if the list is empty,
1870    # so start the list with a dummy element and drop it, to make sure that
1871    # even empty values make it into the values list.
1872    set(ARG_PATH_VALUES "dummy")
1873    foreach(path ${ARG_PATHS})
1874      list(APPEND ARG_PATH_VALUES "${${path}}")
1875    endforeach()
1876    list(REMOVE_AT ARG_PATH_VALUES 0)
1877
1878    get_filename_component(OUTPUT_DIR ${site_out} DIRECTORY)
1879    make_paths_relative(
1880        ARG_PATH_VALUES_RELATIVE "${OUTPUT_DIR}" "${ARG_PATH_VALUES}")
1881
1882    list(LENGTH ARG_PATHS len_paths)
1883    list(LENGTH ARG_PATH_VALUES len_path_values)
1884    list(LENGTH ARG_PATH_VALUES_RELATIVE len_path_value_rels)
1885    if ((NOT ${len_paths} EQUAL ${len_path_values}) OR
1886        (NOT ${len_paths} EQUAL ${len_path_value_rels}))
1887      message(SEND_ERROR "PATHS lengths got confused")
1888    endif()
1889
1890    # Transform variables mentioned in ARG_PATHS to relative paths for
1891    # the configure_file() call. Variables are copied to subscopeds by cmake,
1892    # so this only modifies the local copy of the variables.
1893    math(EXPR arg_path_limit "${len_paths} - 1")
1894    foreach(i RANGE ${arg_path_limit})
1895      list(GET ARG_PATHS ${i} val1)
1896      list(GET ARG_PATH_VALUES_RELATIVE ${i} val2)
1897      set(${val1} ${val2})
1898    endforeach()
1899  endif()
1900
1901  configure_file(${site_in} ${site_out} @ONLY)
1902
1903  if (EXISTS "${ARG_MAIN_CONFIG}")
1904    # Remember main config / generated site config for llvm-lit.in.
1905    get_property(LLVM_LIT_CONFIG_FILES GLOBAL PROPERTY LLVM_LIT_CONFIG_FILES)
1906    list(APPEND LLVM_LIT_CONFIG_FILES "${ARG_MAIN_CONFIG}" "${site_out}")
1907    set_property(GLOBAL PROPERTY LLVM_LIT_CONFIG_FILES ${LLVM_LIT_CONFIG_FILES})
1908  endif()
1909endfunction()
1910
1911function(dump_all_cmake_variables)
1912  get_cmake_property(_variableNames VARIABLES)
1913  foreach (_variableName ${_variableNames})
1914    message(STATUS "${_variableName}=${${_variableName}}")
1915  endforeach()
1916endfunction()
1917
1918function(get_llvm_lit_path base_dir file_name)
1919  cmake_parse_arguments(ARG "ALLOW_EXTERNAL" "" "" ${ARGN})
1920
1921  if (ARG_ALLOW_EXTERNAL)
1922    set (LLVM_EXTERNAL_LIT "" CACHE STRING "Command used to spawn lit")
1923    if ("${LLVM_EXTERNAL_LIT}" STREQUAL "")
1924      set(LLVM_EXTERNAL_LIT "${LLVM_DEFAULT_EXTERNAL_LIT}")
1925    endif()
1926
1927    if (NOT "${LLVM_EXTERNAL_LIT}" STREQUAL "")
1928      if (EXISTS ${LLVM_EXTERNAL_LIT})
1929        get_filename_component(LIT_FILE_NAME ${LLVM_EXTERNAL_LIT} NAME)
1930        get_filename_component(LIT_BASE_DIR ${LLVM_EXTERNAL_LIT} DIRECTORY)
1931        set(${file_name} ${LIT_FILE_NAME} PARENT_SCOPE)
1932        set(${base_dir} ${LIT_BASE_DIR} PARENT_SCOPE)
1933        return()
1934      elseif (NOT DEFINED CACHE{LLVM_EXTERNAL_LIT_MISSING_WARNED_ONCE})
1935        message(WARNING "LLVM_EXTERNAL_LIT set to ${LLVM_EXTERNAL_LIT}, but the path does not exist.")
1936        set(LLVM_EXTERNAL_LIT_MISSING_WARNED_ONCE YES CACHE INTERNAL "")
1937      endif()
1938    endif()
1939  endif()
1940
1941  set(lit_file_name "llvm-lit")
1942  if (CMAKE_HOST_WIN32 AND NOT CYGWIN)
1943    # llvm-lit needs suffix.py for multiprocess to find a main module.
1944    set(lit_file_name "${lit_file_name}.py")
1945  endif ()
1946  set(${file_name} ${lit_file_name} PARENT_SCOPE)
1947
1948  get_property(LLVM_LIT_BASE_DIR GLOBAL PROPERTY LLVM_LIT_BASE_DIR)
1949  if (NOT "${LLVM_LIT_BASE_DIR}" STREQUAL "")
1950    set(${base_dir} ${LLVM_LIT_BASE_DIR} PARENT_SCOPE)
1951  endif()
1952
1953  # Allow individual projects to provide an override
1954  if (NOT "${LLVM_LIT_OUTPUT_DIR}" STREQUAL "")
1955    set(LLVM_LIT_BASE_DIR ${LLVM_LIT_OUTPUT_DIR})
1956  elseif(NOT "${LLVM_RUNTIME_OUTPUT_INTDIR}" STREQUAL "")
1957    set(LLVM_LIT_BASE_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR})
1958  else()
1959    set(LLVM_LIT_BASE_DIR "")
1960  endif()
1961
1962  # Cache this so we don't have to do it again and have subsequent calls
1963  # potentially disagree on the value.
1964  set_property(GLOBAL PROPERTY LLVM_LIT_BASE_DIR ${LLVM_LIT_BASE_DIR})
1965  set(${base_dir} ${LLVM_LIT_BASE_DIR} PARENT_SCOPE)
1966endfunction()
1967
1968# A raw function to create a lit target. This is used to implement the testuite
1969# management functions.
1970function(add_lit_target target comment)
1971  cmake_parse_arguments(ARG "" "" "PARAMS;DEPENDS;ARGS" ${ARGN})
1972  set(LIT_ARGS "${ARG_ARGS} ${LLVM_LIT_ARGS}")
1973  separate_arguments(LIT_ARGS)
1974  if (NOT CMAKE_CFG_INTDIR STREQUAL ".")
1975    list(APPEND LIT_ARGS --param build_mode=${CMAKE_CFG_INTDIR})
1976  endif ()
1977
1978  # Get the path to the lit to *run* tests with.  This can be overriden by
1979  # the user by specifying -DLLVM_EXTERNAL_LIT=<path-to-lit.py>
1980  get_llvm_lit_path(
1981    lit_base_dir
1982    lit_file_name
1983    ALLOW_EXTERNAL
1984    )
1985
1986  set(LIT_COMMAND "${Python3_EXECUTABLE};${lit_base_dir}/${lit_file_name}")
1987  list(APPEND LIT_COMMAND ${LIT_ARGS})
1988  foreach(param ${ARG_PARAMS})
1989    list(APPEND LIT_COMMAND --param ${param})
1990  endforeach()
1991  if (ARG_UNPARSED_ARGUMENTS)
1992    add_custom_target(${target}
1993      COMMAND ${LIT_COMMAND} ${ARG_UNPARSED_ARGUMENTS}
1994      COMMENT "${comment}"
1995      USES_TERMINAL
1996      )
1997  else()
1998    add_custom_target(${target}
1999      COMMAND ${CMAKE_COMMAND} -E echo "${target} does nothing, no tools built.")
2000    message(STATUS "${target} does nothing.")
2001  endif()
2002
2003  if (ARG_DEPENDS)
2004    add_dependencies(${target} ${ARG_DEPENDS})
2005  endif()
2006
2007  # Tests should be excluded from "Build Solution".
2008  set_target_properties(${target} PROPERTIES EXCLUDE_FROM_DEFAULT_BUILD ON)
2009endfunction()
2010
2011# Convert a target name like check-clang to a variable name like CLANG.
2012function(umbrella_lit_testsuite_var target outvar)
2013  if (NOT target MATCHES "^check-")
2014    message(FATAL_ERROR "umbrella lit suites must be check-*, not '${target}'")
2015  endif()
2016  string(SUBSTRING "${target}" 6 -1 var)
2017  string(REPLACE "-" "_" var ${var})
2018  string(TOUPPER "${var}" var)
2019  set(${outvar} "${var}" PARENT_SCOPE)
2020endfunction()
2021
2022# Start recording all lit test suites for a combined 'check-foo' target.
2023# The recording continues until umbrella_lit_testsuite_end() creates the target.
2024function(umbrella_lit_testsuite_begin target)
2025  umbrella_lit_testsuite_var(${target} name)
2026  set_property(GLOBAL APPEND PROPERTY LLVM_LIT_UMBRELLAS ${name})
2027endfunction()
2028
2029# Create a combined 'check-foo' target for a set of related test suites.
2030# It runs all suites added since the matching umbrella_lit_testsuite_end() call.
2031# Tests marked EXCLUDE_FROM_CHECK_ALL are not gathered.
2032function(umbrella_lit_testsuite_end target)
2033  umbrella_lit_testsuite_var(${target} name)
2034
2035  get_property(testsuites GLOBAL PROPERTY LLVM_${name}_LIT_TESTSUITES)
2036  get_property(params GLOBAL PROPERTY LLVM_${name}_LIT_PARAMS)
2037  get_property(depends GLOBAL PROPERTY LLVM_${name}_LIT_DEPENDS)
2038  get_property(extra_args GLOBAL PROPERTY LLVM_${name}_LIT_EXTRA_ARGS)
2039  # Additional test targets are not gathered, but may be set externally.
2040  get_property(additional_test_targets
2041               GLOBAL PROPERTY LLVM_${name}_ADDITIONAL_TEST_TARGETS)
2042
2043  string(TOLOWER ${name} name)
2044  add_lit_target(${target}
2045    "Running ${name} regression tests"
2046    ${testsuites}
2047    PARAMS ${params}
2048    DEPENDS ${depends} ${additional_test_targets}
2049    ARGS ${extra_args}
2050    )
2051endfunction()
2052
2053# A function to add a set of lit test suites to be driven through 'check-*' targets.
2054function(add_lit_testsuite target comment)
2055  cmake_parse_arguments(ARG "EXCLUDE_FROM_CHECK_ALL" "" "PARAMS;DEPENDS;ARGS" ${ARGN})
2056
2057  # EXCLUDE_FROM_ALL excludes the test ${target} out of check-all.
2058  if(NOT ARG_EXCLUDE_FROM_CHECK_ALL)
2059    get_property(gather_names GLOBAL PROPERTY LLVM_LIT_UMBRELLAS)
2060    foreach(name ${gather_names})
2061    # Register the testsuites, params and depends for the umbrella check rule.
2062      set_property(GLOBAL APPEND PROPERTY LLVM_${name}_LIT_TESTSUITES ${ARG_UNPARSED_ARGUMENTS})
2063      set_property(GLOBAL APPEND PROPERTY LLVM_${name}_LIT_PARAMS ${ARG_PARAMS})
2064      set_property(GLOBAL APPEND PROPERTY LLVM_${name}_LIT_DEPENDS ${ARG_DEPENDS})
2065      set_property(GLOBAL APPEND PROPERTY LLVM_${name}_LIT_EXTRA_ARGS ${ARG_ARGS})
2066    endforeach()
2067  endif()
2068
2069  # Produce a specific suffixed check rule.
2070  add_lit_target(${target} ${comment}
2071    ${ARG_UNPARSED_ARGUMENTS}
2072    PARAMS ${ARG_PARAMS}
2073    DEPENDS ${ARG_DEPENDS}
2074    ARGS ${ARG_ARGS}
2075    )
2076endfunction()
2077
2078function(add_lit_testsuites project directory)
2079  if (NOT LLVM_ENABLE_IDE)
2080    cmake_parse_arguments(ARG "EXCLUDE_FROM_CHECK_ALL" "FOLDER" "PARAMS;DEPENDS;ARGS" ${ARGN})
2081
2082    if (NOT ARG_FOLDER)
2083      set(ARG_FOLDER "Test Subdirectories")
2084    endif()
2085
2086    # Search recursively for test directories by assuming anything not
2087    # in a directory called Inputs contains tests.
2088    file(GLOB_RECURSE to_process LIST_DIRECTORIES true ${directory}/*)
2089    foreach(lit_suite ${to_process})
2090      if(NOT IS_DIRECTORY ${lit_suite})
2091        continue()
2092      endif()
2093      string(FIND ${lit_suite} Inputs is_inputs)
2094      string(FIND ${lit_suite} Output is_output)
2095      if (NOT (is_inputs EQUAL -1 AND is_output EQUAL -1))
2096        continue()
2097      endif()
2098
2099      # Create a check- target for the directory.
2100      string(REPLACE ${directory} "" name_slash ${lit_suite})
2101      if (name_slash)
2102        string(REPLACE "/" "-" name_slash ${name_slash})
2103        string(REPLACE "\\" "-" name_dashes ${name_slash})
2104        string(TOLOWER "${project}${name_dashes}" name_var)
2105        add_lit_target("check-${name_var}" "Running lit suite ${lit_suite}"
2106          ${lit_suite}
2107          ${EXCLUDE_FROM_CHECK_ALL}
2108          PARAMS ${ARG_PARAMS}
2109          DEPENDS ${ARG_DEPENDS}
2110          ARGS ${ARG_ARGS}
2111        )
2112        set_target_properties(check-${name_var} PROPERTIES FOLDER ${ARG_FOLDER})
2113      endif()
2114    endforeach()
2115  endif()
2116endfunction()
2117
2118function(llvm_install_library_symlink name dest type)
2119  cmake_parse_arguments(ARG "FULL_DEST" "COMPONENT" "" ${ARGN})
2120  foreach(path ${CMAKE_MODULE_PATH})
2121    if(EXISTS ${path}/LLVMInstallSymlink.cmake)
2122      set(INSTALL_SYMLINK ${path}/LLVMInstallSymlink.cmake)
2123      break()
2124    endif()
2125  endforeach()
2126
2127  set(component ${ARG_COMPONENT})
2128  if(NOT component)
2129    set(component ${name})
2130  endif()
2131
2132  set(full_name ${CMAKE_${type}_LIBRARY_PREFIX}${name}${CMAKE_${type}_LIBRARY_SUFFIX})
2133  if (ARG_FULL_DEST)
2134    set(full_dest ${dest})
2135  else()
2136    set(full_dest ${CMAKE_${type}_LIBRARY_PREFIX}${dest}${CMAKE_${type}_LIBRARY_SUFFIX})
2137  endif()
2138
2139  if(LLVM_USE_SYMLINKS)
2140    set(LLVM_LINK_OR_COPY create_symlink)
2141  else()
2142    set(LLVM_LINK_OR_COPY copy)
2143  endif()
2144
2145  set(output_dir lib${LLVM_LIBDIR_SUFFIX})
2146  if(WIN32 AND "${type}" STREQUAL "SHARED")
2147    set(output_dir "${CMAKE_INSTALL_BINDIR}")
2148  endif()
2149
2150  install(SCRIPT ${INSTALL_SYMLINK}
2151          CODE "install_symlink(\"${full_name}\" \"${full_dest}\" \"${output_dir}\" \"${LLVM_LINK_OR_COPY}\")"
2152          COMPONENT ${component})
2153
2154endfunction()
2155
2156function(llvm_install_symlink project name dest)
2157  get_property(LLVM_DRIVER_TOOLS GLOBAL PROPERTY LLVM_DRIVER_TOOLS)
2158  if(LLVM_TOOL_LLVM_DRIVER_BUILD
2159     AND ${dest} IN_LIST LLVM_DRIVER_TOOLS
2160     AND (NOT LLVM_DISTRIBUTION_COMPONENTS OR ${dest} IN_LIST LLVM_DISTRIBUTION_COMPONENTS)
2161    )
2162    return()
2163  endif()
2164  cmake_parse_arguments(ARG "ALWAYS_GENERATE" "COMPONENT" "" ${ARGN})
2165  foreach(path ${CMAKE_MODULE_PATH})
2166    if(EXISTS ${path}/LLVMInstallSymlink.cmake)
2167      set(INSTALL_SYMLINK ${path}/LLVMInstallSymlink.cmake)
2168      break()
2169    endif()
2170  endforeach()
2171
2172  if(ARG_COMPONENT)
2173    set(component ${ARG_COMPONENT})
2174  else()
2175    if(ARG_ALWAYS_GENERATE)
2176      set(component ${dest})
2177    else()
2178      set(component ${name})
2179    endif()
2180  endif()
2181
2182  set(full_name ${name}${CMAKE_EXECUTABLE_SUFFIX})
2183  set(full_dest ${dest}${CMAKE_EXECUTABLE_SUFFIX})
2184  if (${dest} STREQUAL "llvm-driver")
2185    set(full_dest llvm${CMAKE_EXECUTABLE_SUFFIX})
2186  endif()
2187
2188  if(LLVM_USE_SYMLINKS)
2189    set(LLVM_LINK_OR_COPY create_symlink)
2190  else()
2191    set(LLVM_LINK_OR_COPY copy)
2192  endif()
2193
2194  set(output_dir "${${project}_TOOLS_INSTALL_DIR}")
2195
2196  install(SCRIPT ${INSTALL_SYMLINK}
2197          CODE "install_symlink(\"${full_name}\" \"${full_dest}\" \"${output_dir}\" \"${LLVM_LINK_OR_COPY}\")"
2198          COMPONENT ${component})
2199
2200  if (NOT LLVM_ENABLE_IDE AND NOT ARG_ALWAYS_GENERATE)
2201    add_llvm_install_targets(install-${name}
2202                             DEPENDS ${name} ${dest}
2203                             COMPONENT ${component}
2204                             SYMLINK ${dest})
2205  endif()
2206endfunction()
2207
2208function(llvm_add_tool_symlink project link_name target)
2209  cmake_parse_arguments(ARG "ALWAYS_GENERATE" "OUTPUT_DIR" "" ${ARGN})
2210
2211  get_property(LLVM_DRIVER_TOOLS GLOBAL PROPERTY LLVM_DRIVER_TOOLS)
2212
2213  if (${target} IN_LIST LLVM_DRIVER_TOOLS)
2214    set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_TOOL_ALIASES_${target} ${link_name})
2215  endif()
2216  set(dest_binary "$<TARGET_FILE:${target}>")
2217
2218  # This got a bit gross... For multi-configuration generators the target
2219  # properties return the resolved value of the string, not the build system
2220  # expression. To reconstruct the platform-agnostic path we have to do some
2221  # magic. First we grab one of the types, and a type-specific path. Then from
2222  # the type-specific path we find the last occurrence of the type in the path,
2223  # and replace it with CMAKE_CFG_INTDIR. This allows the build step to be type
2224  # agnostic again.
2225  if(NOT ARG_OUTPUT_DIR)
2226    # If you're not overriding the OUTPUT_DIR, we can make the link relative in
2227    # the same directory.
2228    if(LLVM_USE_SYMLINKS)
2229      set(dest_binary "$<TARGET_FILE_NAME:${target}>")
2230    endif()
2231    if(CMAKE_CONFIGURATION_TYPES)
2232      list(GET CMAKE_CONFIGURATION_TYPES 0 first_type)
2233      string(TOUPPER ${first_type} first_type_upper)
2234      set(first_type_suffix _${first_type_upper})
2235    endif()
2236    get_target_property(target_type ${target} TYPE)
2237    if(${target_type} STREQUAL "STATIC_LIBRARY")
2238      get_target_property(ARG_OUTPUT_DIR ${target} ARCHIVE_OUTPUT_DIRECTORY${first_type_suffix})
2239    elseif(UNIX AND ${target_type} STREQUAL "SHARED_LIBRARY")
2240      get_target_property(ARG_OUTPUT_DIR ${target} LIBRARY_OUTPUT_DIRECTORY${first_type_suffix})
2241    else()
2242      get_target_property(ARG_OUTPUT_DIR ${target} RUNTIME_OUTPUT_DIRECTORY${first_type_suffix})
2243    endif()
2244    if(CMAKE_CONFIGURATION_TYPES)
2245      string(FIND "${ARG_OUTPUT_DIR}" "/${first_type}/" type_start REVERSE)
2246      string(SUBSTRING "${ARG_OUTPUT_DIR}" 0 ${type_start} path_prefix)
2247      string(SUBSTRING "${ARG_OUTPUT_DIR}" ${type_start} -1 path_suffix)
2248      string(REPLACE "/${first_type}/" "/${CMAKE_CFG_INTDIR}/"
2249             path_suffix ${path_suffix})
2250      set(ARG_OUTPUT_DIR ${path_prefix}${path_suffix})
2251    endif()
2252  endif()
2253
2254  if(LLVM_USE_SYMLINKS)
2255    set(LLVM_LINK_OR_COPY create_symlink)
2256  else()
2257    set(LLVM_LINK_OR_COPY copy)
2258  endif()
2259
2260  set(output_path "${ARG_OUTPUT_DIR}/${link_name}${CMAKE_EXECUTABLE_SUFFIX}")
2261
2262  set(target_name ${link_name})
2263  if(TARGET ${link_name})
2264    set(target_name ${link_name}-link)
2265  endif()
2266
2267
2268  if(ARG_ALWAYS_GENERATE)
2269    set_property(DIRECTORY APPEND PROPERTY
2270      ADDITIONAL_MAKE_CLEAN_FILES ${dest_binary})
2271    add_custom_command(TARGET ${target} POST_BUILD
2272      COMMAND ${CMAKE_COMMAND} -E ${LLVM_LINK_OR_COPY} "${dest_binary}" "${output_path}")
2273  else()
2274    add_custom_command(OUTPUT ${output_path}
2275                     COMMAND ${CMAKE_COMMAND} -E ${LLVM_LINK_OR_COPY} "${dest_binary}" "${output_path}"
2276                     DEPENDS ${target})
2277
2278    # TODO: Make use of generator expressions below once CMake 3.19 or higher is the minimum supported version.
2279    set(should_build_all)
2280    get_target_property(target_excluded_from_all ${target} EXCLUDE_FROM_ALL)
2281    if (NOT target_excluded_from_all)
2282      set(should_build_all ALL)
2283    endif()
2284    add_custom_target(${target_name} ${should_build_all} DEPENDS ${target} ${output_path})
2285    set_target_properties(${target_name} PROPERTIES FOLDER Tools)
2286
2287    # Make sure both the link and target are toolchain tools
2288    if (${link_name} IN_LIST LLVM_TOOLCHAIN_TOOLS AND ${target} IN_LIST LLVM_TOOLCHAIN_TOOLS)
2289      set(TOOL_IS_TOOLCHAIN ON)
2290    endif()
2291
2292    if ((TOOL_IS_TOOLCHAIN OR NOT LLVM_INSTALL_TOOLCHAIN_ONLY) AND LLVM_BUILD_TOOLS)
2293      llvm_install_symlink("${project}" ${link_name} ${target})
2294    endif()
2295  endif()
2296endfunction()
2297
2298function(add_llvm_tool_symlink link_name target)
2299  llvm_add_tool_symlink(LLVM ${ARGV})
2300endfunction()
2301
2302function(llvm_externalize_debuginfo name)
2303  if(NOT LLVM_EXTERNALIZE_DEBUGINFO)
2304    return()
2305  endif()
2306
2307  if(NOT LLVM_EXTERNALIZE_DEBUGINFO_SKIP_STRIP)
2308    if(APPLE)
2309      if(NOT CMAKE_STRIP)
2310        set(CMAKE_STRIP xcrun strip)
2311      endif()
2312      set(strip_command COMMAND ${CMAKE_STRIP} -S -x $<TARGET_FILE:${name}>)
2313    else()
2314      set(strip_command COMMAND ${CMAKE_STRIP} -g -x $<TARGET_FILE:${name}>)
2315    endif()
2316  endif()
2317
2318  if(APPLE)
2319    if(LLVM_EXTERNALIZE_DEBUGINFO_EXTENSION)
2320      set(file_ext ${LLVM_EXTERNALIZE_DEBUGINFO_EXTENSION})
2321    else()
2322      set(file_ext dSYM)
2323    endif()
2324
2325    set(output_name "$<TARGET_FILE_NAME:${name}>.${file_ext}")
2326
2327    if(LLVM_EXTERNALIZE_DEBUGINFO_OUTPUT_DIR)
2328      set(output_path "-o=${LLVM_EXTERNALIZE_DEBUGINFO_OUTPUT_DIR}/${output_name}")
2329    else()
2330      set(output_path "-o=${output_name}")
2331    endif()
2332
2333    if(CMAKE_CXX_FLAGS MATCHES "-flto"
2334      OR CMAKE_CXX_FLAGS_${uppercase_CMAKE_BUILD_TYPE} MATCHES "-flto")
2335
2336      set(lto_object ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/${name}-lto.o)
2337      set_property(TARGET ${name} APPEND_STRING PROPERTY
2338        LINK_FLAGS " -Wl,-object_path_lto,${lto_object}")
2339    endif()
2340    if(NOT CMAKE_DSYMUTIL)
2341      set(CMAKE_DSYMUTIL xcrun dsymutil)
2342    endif()
2343    add_custom_command(TARGET ${name} POST_BUILD
2344      COMMAND ${CMAKE_DSYMUTIL} ${output_path} $<TARGET_FILE:${name}>
2345      ${strip_command}
2346      )
2347  else()
2348    add_custom_command(TARGET ${name} POST_BUILD
2349      COMMAND ${CMAKE_OBJCOPY} --only-keep-debug $<TARGET_FILE:${name}> $<TARGET_FILE:${name}>.debug
2350      ${strip_command} -R .gnu_debuglink
2351      COMMAND ${CMAKE_OBJCOPY} --add-gnu-debuglink=$<TARGET_FILE:${name}>.debug $<TARGET_FILE:${name}>
2352      )
2353  endif()
2354endfunction()
2355
2356# Usage: llvm_codesign(name [FORCE] [ENTITLEMENTS file] [BUNDLE_PATH path])
2357function(llvm_codesign name)
2358  cmake_parse_arguments(ARG "FORCE" "ENTITLEMENTS;BUNDLE_PATH" "" ${ARGN})
2359
2360  if(NOT LLVM_CODESIGNING_IDENTITY)
2361    return()
2362  endif()
2363
2364  if(CMAKE_GENERATOR STREQUAL "Xcode")
2365    set_target_properties(${name} PROPERTIES
2366      XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY ${LLVM_CODESIGNING_IDENTITY}
2367    )
2368    if(DEFINED ARG_ENTITLEMENTS)
2369      set_target_properties(${name} PROPERTIES
2370        XCODE_ATTRIBUTE_CODE_SIGN_ENTITLEMENTS ${ARG_ENTITLEMENTS}
2371      )
2372    endif()
2373  elseif(APPLE AND CMAKE_HOST_SYSTEM_NAME MATCHES Darwin)
2374    if(NOT CMAKE_CODESIGN)
2375      set(CMAKE_CODESIGN xcrun codesign)
2376    endif()
2377    if(NOT CMAKE_CODESIGN_ALLOCATE)
2378      execute_process(
2379        COMMAND xcrun -f codesign_allocate
2380        OUTPUT_STRIP_TRAILING_WHITESPACE
2381        OUTPUT_VARIABLE CMAKE_CODESIGN_ALLOCATE
2382      )
2383    endif()
2384    if(DEFINED ARG_ENTITLEMENTS)
2385      set(pass_entitlements --entitlements ${ARG_ENTITLEMENTS})
2386    endif()
2387
2388    if (NOT ARG_BUNDLE_PATH)
2389      set(ARG_BUNDLE_PATH $<TARGET_FILE:${name}>)
2390    endif()
2391
2392    # ld64 now always codesigns the binaries it creates. Apply the force arg
2393    # unconditionally so that we can - for example - add entitlements to the
2394    # targets that need it.
2395    set(force_flag "-f")
2396
2397    add_custom_command(
2398      TARGET ${name} POST_BUILD
2399      COMMAND ${CMAKE_COMMAND} -E
2400              env CODESIGN_ALLOCATE=${CMAKE_CODESIGN_ALLOCATE}
2401              ${CMAKE_CODESIGN} -s ${LLVM_CODESIGNING_IDENTITY}
2402              ${pass_entitlements} ${force_flag} ${ARG_BUNDLE_PATH}
2403    )
2404  endif()
2405endfunction()
2406
2407function(llvm_setup_rpath name)
2408  if(CMAKE_INSTALL_RPATH)
2409    return()
2410  endif()
2411
2412  if(LLVM_INSTALL_PREFIX AND NOT (LLVM_INSTALL_PREFIX STREQUAL CMAKE_INSTALL_PREFIX))
2413    set(extra_libdir ${LLVM_LIBRARY_DIR})
2414  elseif(LLVM_BUILD_LIBRARY_DIR)
2415    set(extra_libdir ${LLVM_LIBRARY_DIR})
2416  endif()
2417
2418  if (APPLE)
2419    set(_install_name_dir INSTALL_NAME_DIR "@rpath")
2420    set(_install_rpath "@loader_path/../lib${LLVM_LIBDIR_SUFFIX}" ${extra_libdir})
2421  elseif(${CMAKE_SYSTEM_NAME} MATCHES "AIX" AND BUILD_SHARED_LIBS)
2422    # $ORIGIN is not interpreted at link time by aix ld.
2423    # Since BUILD_SHARED_LIBS is only recommended for use by developers,
2424    # hardcode the rpath to build/install lib dir first in this mode.
2425    # FIXME: update this when there is better solution.
2426    set(_install_rpath "${LLVM_LIBRARY_OUTPUT_INTDIR}" "${CMAKE_INSTALL_PREFIX}/lib${LLVM_LIBDIR_SUFFIX}" ${extra_libdir})
2427  elseif(UNIX)
2428    set(_build_rpath "\$ORIGIN/../lib${LLVM_LIBDIR_SUFFIX}" ${extra_libdir})
2429    set(_install_rpath "\$ORIGIN/../lib${LLVM_LIBDIR_SUFFIX}")
2430    if(${CMAKE_SYSTEM_NAME} MATCHES "(FreeBSD|DragonFly)")
2431      set_property(TARGET ${name} APPEND_STRING PROPERTY
2432                   LINK_FLAGS " -Wl,-z,origin ")
2433    endif()
2434    if(LLVM_LINKER_IS_GNULD AND NOT ${LLVM_LIBRARY_OUTPUT_INTDIR} STREQUAL "")
2435      # $ORIGIN is not interpreted at link time by ld.bfd
2436      set_property(TARGET ${name} APPEND_STRING PROPERTY
2437                   LINK_FLAGS " -Wl,-rpath-link,${LLVM_LIBRARY_OUTPUT_INTDIR} ")
2438    endif()
2439  else()
2440    return()
2441  endif()
2442
2443  # Enable BUILD_WITH_INSTALL_RPATH unless CMAKE_BUILD_RPATH is set and not
2444  # building for macOS or AIX, as those platforms seemingly require it.
2445  # On AIX, the tool chain doesn't support modifying rpaths/libpaths for XCOFF
2446  # on install at the moment, so BUILD_WITH_INSTALL_RPATH is required.
2447  if("${CMAKE_BUILD_RPATH}" STREQUAL "")
2448    if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin|AIX")
2449      set_property(TARGET ${name} PROPERTY BUILD_WITH_INSTALL_RPATH ON)
2450    else()
2451      set_property(TARGET ${name} APPEND PROPERTY BUILD_RPATH "${_build_rpath}")
2452    endif()
2453  endif()
2454
2455  set_target_properties(${name} PROPERTIES
2456                        INSTALL_RPATH "${_install_rpath}"
2457                        ${_install_name_dir})
2458endfunction()
2459
2460function(setup_dependency_debugging name)
2461  if(NOT LLVM_DEPENDENCY_DEBUGGING)
2462    return()
2463  endif()
2464
2465  if("intrinsics_gen" IN_LIST ARGN)
2466    return()
2467  endif()
2468
2469  set(deny_attributes_inc "(deny file* (literal \"${LLVM_BINARY_DIR}/include/llvm/IR/Attributes.inc\"))")
2470  set(deny_intrinsics_inc "(deny file* (literal \"${LLVM_BINARY_DIR}/include/llvm/IR/Intrinsics.inc\"))")
2471
2472  set(sandbox_command "sandbox-exec -p '(version 1) (allow default) ${deny_attributes_inc} ${deny_intrinsics_inc}'")
2473  set_target_properties(${name} PROPERTIES RULE_LAUNCH_COMPILE ${sandbox_command})
2474endfunction()
2475
2476# If the sources at the given `path` are under version control, set `out_var`
2477# to the the path of a file which will be modified when the VCS revision
2478# changes, attempting to create that file if it does not exist; if no such
2479# file exists and one cannot be created, instead set `out_var` to the
2480# empty string.
2481#
2482# If the sources are not under version control, do not define `out_var`.
2483function(find_first_existing_vc_file path out_var)
2484  if(NOT EXISTS "${path}")
2485    return()
2486  endif()
2487  find_package(Git)
2488  if(GIT_FOUND)
2489    execute_process(COMMAND ${GIT_EXECUTABLE} rev-parse --git-dir
2490      WORKING_DIRECTORY ${path}
2491      RESULT_VARIABLE git_result
2492      OUTPUT_VARIABLE git_output
2493      ERROR_QUIET)
2494    if(git_result EQUAL 0)
2495      string(STRIP "${git_output}" git_output)
2496      get_filename_component(git_dir ${git_output} ABSOLUTE BASE_DIR ${path})
2497      # Some branchless cases (e.g. 'repo') may not yet have .git/logs/HEAD
2498      if (NOT EXISTS "${git_dir}/logs/HEAD")
2499        execute_process(COMMAND ${CMAKE_COMMAND} -E touch HEAD
2500          WORKING_DIRECTORY "${git_dir}/logs"
2501          RESULT_VARIABLE touch_head_result
2502          ERROR_QUIET)
2503        if (NOT touch_head_result EQUAL 0)
2504          set(${out_var} "" PARENT_SCOPE)
2505          return()
2506        endif()
2507      endif()
2508      set(${out_var} "${git_dir}/logs/HEAD" PARENT_SCOPE)
2509    endif()
2510  endif()
2511endfunction()
2512
2513function(get_host_tool_path tool_name setting_name exe_var_name target_var_name)
2514  set(${setting_name}_DEFAULT "")
2515
2516  if(LLVM_NATIVE_TOOL_DIR)
2517    if(EXISTS "${LLVM_NATIVE_TOOL_DIR}/${tool_name}${LLVM_HOST_EXECUTABLE_SUFFIX}")
2518      set(${setting_name}_DEFAULT "${LLVM_NATIVE_TOOL_DIR}/${tool_name}${LLVM_HOST_EXECUTABLE_SUFFIX}")
2519    endif()
2520  endif()
2521
2522  set(${setting_name} "${${setting_name}_DEFAULT}" CACHE
2523    STRING "Host ${tool_name} executable. Saves building if cross-compiling.")
2524
2525  if(${setting_name})
2526    set(exe_name ${${setting_name}})
2527    set(target_name "")
2528  elseif(LLVM_USE_HOST_TOOLS)
2529    get_native_tool_path(${tool_name} exe_name)
2530    set(target_name ${exe_name})
2531  else()
2532    set(exe_name $<TARGET_FILE:${tool_name}>)
2533    set(target_name ${tool_name})
2534  endif()
2535  set(${exe_var_name} "${exe_name}" CACHE STRING "")
2536  set(${target_var_name} "${target_name}" CACHE STRING "")
2537endfunction()
2538
2539function(setup_host_tool tool_name setting_name exe_var_name target_var_name)
2540  get_host_tool_path(${tool_name} ${setting_name} ${exe_var_name} ${target_var_name})
2541  # Set up a native tool build if necessary
2542  if(LLVM_USE_HOST_TOOLS AND NOT ${setting_name})
2543    build_native_tool(${tool_name} exe_name DEPENDS ${tool_name})
2544    add_custom_target(${target_var_name} DEPENDS ${exe_name})
2545  endif()
2546endfunction()
2547