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