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