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