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