ReleaseNotes: C API policy; by Eric Christopher
[oota-llvm.git] / cmake / modules / AddLLVM.cmake
1 include(LLVMProcessSources)
2 include(LLVM-Config)
3 include(DetermineGCCCompatible)
4
5 function(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
12   # targets can use to force EH
13   if((LLVM_REQUIRES_EH OR LLVM_ENABLE_EH) AND NOT CLANG_CL)
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   else()
19     if(LLVM_COMPILER_IS_GCC_COMPATIBLE)
20       list(APPEND LLVM_COMPILE_FLAGS "-fno-exceptions")
21     elseif(MSVC)
22       list(APPEND LLVM_COMPILE_DEFINITIONS _HAS_EXCEPTIONS=0)
23       list(APPEND LLVM_COMPILE_FLAGS "/EHs-c-")
24     endif()
25   endif()
26
27   # LLVM_REQUIRES_RTTI is an internal flag that individual
28   # targets can use to force RTTI
29   set(LLVM_CONFIG_HAS_RTTI YES CACHE INTERNAL "")
30   if(NOT (LLVM_REQUIRES_RTTI OR LLVM_ENABLE_RTTI))
31     set(LLVM_CONFIG_HAS_RTTI NO CACHE INTERNAL "")
32     list(APPEND LLVM_COMPILE_DEFINITIONS GTEST_HAS_RTTI=0)
33     if (LLVM_COMPILER_IS_GCC_COMPATIBLE)
34       list(APPEND LLVM_COMPILE_FLAGS "-fno-rtti")
35     elseif (MSVC)
36       list(APPEND LLVM_COMPILE_FLAGS "/GR-")
37     endif ()
38   endif()
39
40   # Assume that;
41   #   - LLVM_COMPILE_FLAGS is list.
42   #   - PROPERTY COMPILE_FLAGS is string.
43   string(REPLACE ";" " " target_compile_flags " ${LLVM_COMPILE_FLAGS}")
44
45   if(update_src_props)
46     foreach(fn ${sources})
47       get_filename_component(suf ${fn} EXT)
48       if("${suf}" STREQUAL ".cpp")
49         set_property(SOURCE ${fn} APPEND_STRING PROPERTY
50           COMPILE_FLAGS "${target_compile_flags}")
51       endif()
52     endforeach()
53   else()
54     # Update target props, since all sources are C++.
55     set_property(TARGET ${name} APPEND_STRING PROPERTY
56       COMPILE_FLAGS "${target_compile_flags}")
57   endif()
58
59   set_property(TARGET ${name} APPEND PROPERTY COMPILE_DEFINITIONS ${LLVM_COMPILE_DEFINITIONS})
60 endfunction()
61
62 function(add_llvm_symbol_exports target_name export_file)
63   if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
64     set(native_export_file "${target_name}.exports")
65     add_custom_command(OUTPUT ${native_export_file}
66       COMMAND sed -e "s/^/_/" < ${export_file} > ${native_export_file}
67       DEPENDS ${export_file}
68       VERBATIM
69       COMMENT "Creating export file for ${target_name}")
70     set_property(TARGET ${target_name} APPEND_STRING PROPERTY
71                  LINK_FLAGS " -Wl,-exported_symbols_list,${CMAKE_CURRENT_BINARY_DIR}/${native_export_file}")
72   elseif(LLVM_HAVE_LINK_VERSION_SCRIPT)
73     # Gold and BFD ld require a version script rather than a plain list.
74     set(native_export_file "${target_name}.exports")
75     # FIXME: Don't write the "local:" line on OpenBSD.
76     add_custom_command(OUTPUT ${native_export_file}
77       COMMAND echo "{" > ${native_export_file}
78       COMMAND grep -q "[[:alnum:]]" ${export_file} && echo "  global:" >> ${native_export_file} || :
79       COMMAND sed -e "s/$/;/" -e "s/^/    /" < ${export_file} >> ${native_export_file}
80       COMMAND echo "  local: *;" >> ${native_export_file}
81       COMMAND echo "};" >> ${native_export_file}
82       DEPENDS ${export_file}
83       VERBATIM
84       COMMENT "Creating export file for ${target_name}")
85     if (${CMAKE_SYSTEM_NAME} MATCHES "SunOS")
86       set_property(TARGET ${target_name} APPEND_STRING PROPERTY
87                    LINK_FLAGS "  -Wl,-M,${CMAKE_CURRENT_BINARY_DIR}/${native_export_file}")
88     else()
89       set_property(TARGET ${target_name} APPEND_STRING PROPERTY
90                    LINK_FLAGS "  -Wl,--version-script,${CMAKE_CURRENT_BINARY_DIR}/${native_export_file}")
91     endif()
92   else()
93     set(native_export_file "${target_name}.def")
94
95     add_custom_command(OUTPUT ${native_export_file}
96       COMMAND ${PYTHON_EXECUTABLE} -c "import sys;print(''.join(['EXPORTS\\n']+sys.stdin.readlines(),))"
97         < ${export_file} > ${native_export_file}
98       DEPENDS ${export_file}
99       VERBATIM
100       COMMENT "Creating export file for ${target_name}")
101     set(export_file_linker_flag "${CMAKE_CURRENT_BINARY_DIR}/${native_export_file}")
102     if(MSVC)
103       set(export_file_linker_flag "/DEF:\"${export_file_linker_flag}\"")
104     endif()
105     set_property(TARGET ${target_name} APPEND_STRING PROPERTY
106                  LINK_FLAGS " ${export_file_linker_flag}")
107   endif()
108
109   add_custom_target(${target_name}_exports DEPENDS ${native_export_file})
110   set_target_properties(${target_name}_exports PROPERTIES FOLDER "Misc")
111
112   get_property(srcs TARGET ${target_name} PROPERTY SOURCES)
113   foreach(src ${srcs})
114     get_filename_component(extension ${src} EXT)
115     if(extension STREQUAL ".cpp")
116       set(first_source_file ${src})
117       break()
118     endif()
119   endforeach()
120
121   # Force re-linking when the exports file changes. Actually, it
122   # forces recompilation of the source file. The LINK_DEPENDS target
123   # property only works for makefile-based generators.
124   # FIXME: This is not safe because this will create the same target
125   # ${native_export_file} in several different file:
126   # - One where we emitted ${target_name}_exports
127   # - One where we emitted the build command for the following object.
128   # set_property(SOURCE ${first_source_file} APPEND PROPERTY
129   #   OBJECT_DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${native_export_file})
130
131   set_property(DIRECTORY APPEND
132     PROPERTY ADDITIONAL_MAKE_CLEAN_FILES ${native_export_file})
133
134   add_dependencies(${target_name} ${target_name}_exports)
135
136   # Add dependency to *_exports later -- CMake issue 14747
137   list(APPEND LLVM_COMMON_DEPENDS ${target_name}_exports)
138   set(LLVM_COMMON_DEPENDS ${LLVM_COMMON_DEPENDS} PARENT_SCOPE)
139 endfunction(add_llvm_symbol_exports)
140
141 if(NOT WIN32 AND NOT APPLE)
142   execute_process(
143     COMMAND ${CMAKE_C_COMPILER} -Wl,--version
144     OUTPUT_VARIABLE stdout
145     ERROR_QUIET
146     )
147   if("${stdout}" MATCHES "GNU gold")
148     set(LLVM_LINKER_IS_GOLD ON)
149   endif()
150 endif()
151
152 function(add_link_opts target_name)
153   # Don't use linker optimizations in debug builds since it slows down the
154   # linker in a context where the optimizations are not important.
155   if (NOT uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG")
156
157     # Pass -O3 to the linker. This enabled different optimizations on different
158     # linkers.
159     if(NOT (${CMAKE_SYSTEM_NAME} MATCHES "Darwin|SunOS" OR WIN32))
160       set_property(TARGET ${target_name} APPEND_STRING PROPERTY
161                    LINK_FLAGS " -Wl,-O3")
162     endif()
163
164     if(LLVM_LINKER_IS_GOLD)
165       # With gold gc-sections is always safe.
166       set_property(TARGET ${target_name} APPEND_STRING PROPERTY
167                    LINK_FLAGS " -Wl,--gc-sections")
168       # Note that there is a bug with -Wl,--icf=safe so it is not safe
169       # to enable. See https://sourceware.org/bugzilla/show_bug.cgi?id=17704.
170     endif()
171
172     if(NOT LLVM_NO_DEAD_STRIP)
173       if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
174         # ld64's implementation of -dead_strip breaks tools that use plugins.
175         set_property(TARGET ${target_name} APPEND_STRING PROPERTY
176                      LINK_FLAGS " -Wl,-dead_strip")
177       elseif(${CMAKE_SYSTEM_NAME} MATCHES "SunOS")
178         set_property(TARGET ${target_name} APPEND_STRING PROPERTY
179                      LINK_FLAGS " -Wl,-z -Wl,discard-unused=sections")
180       elseif(NOT WIN32 AND NOT LLVM_LINKER_IS_GOLD)
181         # Object files are compiled with -ffunction-data-sections.
182         # Versions of bfd ld < 2.23.1 have a bug in --gc-sections that breaks
183         # tools that use plugins. Always pass --gc-sections once we require
184         # a newer linker.
185         set_property(TARGET ${target_name} APPEND_STRING PROPERTY
186                      LINK_FLAGS " -Wl,--gc-sections")
187       endif()
188     endif()
189   endif()
190 endfunction(add_link_opts)
191
192 # Set each output directory according to ${CMAKE_CONFIGURATION_TYPES}.
193 # Note: Don't set variables CMAKE_*_OUTPUT_DIRECTORY any more,
194 # or a certain builder, for eaxample, msbuild.exe, would be confused.
195 function(set_output_directory target)
196   cmake_parse_arguments(ARG "" "BINARY_DIR;LIBRARY_DIR" "" ${ARGN})
197
198   # module_dir -- corresponding to LIBRARY_OUTPUT_DIRECTORY.
199   # It affects output of add_library(MODULE).
200   if(WIN32 OR CYGWIN)
201     # DLL platform
202     set(module_dir ${ARG_BINARY_DIR})
203   else()
204     set(module_dir ${ARG_LIBRARY_DIR})
205   endif()
206   if(NOT "${CMAKE_CFG_INTDIR}" STREQUAL ".")
207     foreach(build_mode ${CMAKE_CONFIGURATION_TYPES})
208       string(TOUPPER "${build_mode}" CONFIG_SUFFIX)
209       if(ARG_BINARY_DIR)
210         string(REPLACE ${CMAKE_CFG_INTDIR} ${build_mode} bi ${ARG_BINARY_DIR})
211         set_target_properties(${target} PROPERTIES "RUNTIME_OUTPUT_DIRECTORY_${CONFIG_SUFFIX}" ${bi})
212       endif()
213       if(ARG_LIBRARY_DIR)
214         string(REPLACE ${CMAKE_CFG_INTDIR} ${build_mode} li ${ARG_LIBRARY_DIR})
215         set_target_properties(${target} PROPERTIES "ARCHIVE_OUTPUT_DIRECTORY_${CONFIG_SUFFIX}" ${li})
216       endif()
217       if(module_dir)
218         string(REPLACE ${CMAKE_CFG_INTDIR} ${build_mode} mi ${module_dir})
219         set_target_properties(${target} PROPERTIES "LIBRARY_OUTPUT_DIRECTORY_${CONFIG_SUFFIX}" ${mi})
220       endif()
221     endforeach()
222   else()
223     if(ARG_BINARY_DIR)
224       set_target_properties(${target} PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${ARG_BINARY_DIR})
225     endif()
226     if(ARG_LIBRARY_DIR)
227       set_target_properties(${target} PROPERTIES ARCHIVE_OUTPUT_DIRECTORY ${ARG_LIBRARY_DIR})
228     endif()
229     if(module_dir)
230       set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${module_dir})
231     endif()
232   endif()
233 endfunction()
234
235 # If on Windows and building with MSVC, add the resource script containing the
236 # VERSIONINFO data to the project.  This embeds version resource information
237 # into the output .exe or .dll.
238 # TODO: Enable for MinGW Windows builds too.
239 #
240 function(add_windows_version_resource_file OUT_VAR)
241   set(sources ${ARGN})
242   if (MSVC)
243     set(resource_file ${LLVM_SOURCE_DIR}/resources/windows_version_resource.rc)
244     if(EXISTS ${resource_file})
245       set(sources ${sources} ${resource_file})
246       source_group("Resource Files" ${resource_file})
247       set(windows_resource_file ${resource_file} PARENT_SCOPE)
248     endif()
249   endif(MSVC)
250
251   set(${OUT_VAR} ${sources} PARENT_SCOPE)
252 endfunction(add_windows_version_resource_file)
253
254 # set_windows_version_resource_properties(name resource_file...
255 #   VERSION_MAJOR int
256 #     Optional major version number (defaults to LLVM_VERSION_MAJOR)
257 #   VERSION_MINOR int
258 #     Optional minor version number (defaults to LLVM_VERSION_MINOR)
259 #   VERSION_PATCHLEVEL int
260 #     Optional patchlevel version number (defaults to LLVM_VERSION_PATCH)
261 #   VERSION_STRING
262 #     Optional version string (defaults to PACKAGE_VERSION)
263 #   PRODUCT_NAME
264 #     Optional product name string (defaults to "LLVM")
265 #   )
266 function(set_windows_version_resource_properties name resource_file)
267   cmake_parse_arguments(ARG
268     ""
269     "VERSION_MAJOR;VERSION_MINOR;VERSION_PATCHLEVEL;VERSION_STRING;PRODUCT_NAME"
270     ""
271     ${ARGN})
272
273   if (NOT DEFINED ARG_VERSION_MAJOR)
274     set(ARG_VERSION_MAJOR ${LLVM_VERSION_MAJOR})
275   endif()
276
277   if (NOT DEFINED ARG_VERSION_MINOR)
278     set(ARG_VERSION_MINOR ${LLVM_VERSION_MINOR})
279   endif()
280
281   if (NOT DEFINED ARG_VERSION_PATCHLEVEL)
282     set(ARG_VERSION_PATCHLEVEL ${LLVM_VERSION_PATCH})
283   endif()
284
285   if (NOT DEFINED ARG_VERSION_STRING)
286     set(ARG_VERSION_STRING ${PACKAGE_VERSION})
287   endif()
288
289   if (NOT DEFINED ARG_PRODUCT_NAME)
290     set(ARG_PRODUCT_NAME "LLVM")
291   endif()
292
293   set_property(SOURCE ${resource_file}
294                PROPERTY COMPILE_FLAGS /nologo)
295   set_property(SOURCE ${resource_file}
296                PROPERTY COMPILE_DEFINITIONS
297                "RC_VERSION_FIELD_1=${ARG_VERSION_MAJOR}"
298                "RC_VERSION_FIELD_2=${ARG_VERSION_MINOR}"
299                "RC_VERSION_FIELD_3=${ARG_VERSION_PATCHLEVEL}"
300                "RC_VERSION_FIELD_4=0"
301                "RC_FILE_VERSION=\"${ARG_VERSION_STRING}\""
302                "RC_INTERNAL_NAME=\"${name}\""
303                "RC_PRODUCT_NAME=\"${ARG_PRODUCT_NAME}\""
304                "RC_PRODUCT_VERSION=\"${ARG_VERSION_STRING}\"")
305 endfunction(set_windows_version_resource_properties)
306
307 # llvm_add_library(name sources...
308 #   SHARED;STATIC
309 #     STATIC by default w/o BUILD_SHARED_LIBS.
310 #     SHARED by default w/  BUILD_SHARED_LIBS.
311 #   OBJECT
312 #     Also create an OBJECT library target. Default if STATIC && SHARED.
313 #   MODULE
314 #     Target ${name} might not be created on unsupported platforms.
315 #     Check with "if(TARGET ${name})".
316 #   DISABLE_LLVM_LINK_LLVM_DYLIB
317 #     Do not link this library to libLLVM, even if
318 #     LLVM_LINK_LLVM_DYLIB is enabled.
319 #   OUTPUT_NAME name
320 #     Corresponds to OUTPUT_NAME in target properties.
321 #   DEPENDS targets...
322 #     Same semantics as add_dependencies().
323 #   LINK_COMPONENTS components...
324 #     Same as the variable LLVM_LINK_COMPONENTS.
325 #   LINK_LIBS lib_targets...
326 #     Same semantics as target_link_libraries().
327 #   ADDITIONAL_HEADERS
328 #     May specify header files for IDE generators.
329 #   SONAME
330 #     Should set SONAME link flags and create symlinks
331 #   )
332 function(llvm_add_library name)
333   cmake_parse_arguments(ARG
334     "MODULE;SHARED;STATIC;OBJECT;DISABLE_LLVM_LINK_LLVM_DYLIB;SONAME"
335     "OUTPUT_NAME"
336     "ADDITIONAL_HEADERS;DEPENDS;LINK_COMPONENTS;LINK_LIBS;OBJLIBS"
337     ${ARGN})
338   list(APPEND LLVM_COMMON_DEPENDS ${ARG_DEPENDS})
339   if(ARG_ADDITIONAL_HEADERS)
340     # Pass through ADDITIONAL_HEADERS.
341     set(ARG_ADDITIONAL_HEADERS ADDITIONAL_HEADERS ${ARG_ADDITIONAL_HEADERS})
342   endif()
343   if(ARG_OBJLIBS)
344     set(ALL_FILES ${ARG_OBJLIBS})
345   else()
346     llvm_process_sources(ALL_FILES ${ARG_UNPARSED_ARGUMENTS} ${ARG_ADDITIONAL_HEADERS})
347   endif()
348
349   if(ARG_MODULE)
350     if(ARG_SHARED OR ARG_STATIC)
351       message(WARNING "MODULE with SHARED|STATIC doesn't make sense.")
352     endif()
353     if(NOT LLVM_ENABLE_PLUGINS)
354       message(STATUS "${name} ignored -- Loadable modules not supported on this platform.")
355       return()
356     endif()
357   else()
358     if(BUILD_SHARED_LIBS AND NOT ARG_STATIC)
359       set(ARG_SHARED TRUE)
360     endif()
361     if(NOT ARG_SHARED)
362       set(ARG_STATIC TRUE)
363     endif()
364   endif()
365
366   # Generate objlib
367   if((ARG_SHARED AND ARG_STATIC) OR ARG_OBJECT)
368     # Generate an obj library for both targets.
369     set(obj_name "obj.${name}")
370     add_library(${obj_name} OBJECT EXCLUDE_FROM_ALL
371       ${ALL_FILES}
372       )
373     llvm_update_compile_flags(${obj_name})
374     set(ALL_FILES "$<TARGET_OBJECTS:${obj_name}>")
375
376     # Do add_dependencies(obj) later due to CMake issue 14747.
377     list(APPEND objlibs ${obj_name})
378
379     set_target_properties(${obj_name} PROPERTIES FOLDER "Object Libraries")
380   endif()
381
382   if(ARG_SHARED AND ARG_STATIC)
383     # static
384     set(name_static "${name}_static")
385     if(ARG_OUTPUT_NAME)
386       set(output_name OUTPUT_NAME "${ARG_OUTPUT_NAME}")
387     endif()
388     # DEPENDS has been appended to LLVM_COMMON_LIBS.
389     llvm_add_library(${name_static} STATIC
390       ${output_name}
391       OBJLIBS ${ALL_FILES} # objlib
392       LINK_LIBS ${ARG_LINK_LIBS}
393       LINK_COMPONENTS ${ARG_LINK_COMPONENTS}
394       )
395     # FIXME: Add name_static to anywhere in TARGET ${name}'s PROPERTY.
396     set(ARG_STATIC)
397   endif()
398
399   if(ARG_MODULE)
400     add_library(${name} MODULE ${ALL_FILES})
401   elseif(ARG_SHARED)
402     add_windows_version_resource_file(ALL_FILES ${ALL_FILES})
403     add_library(${name} SHARED ${ALL_FILES})
404   else()
405     add_library(${name} STATIC ${ALL_FILES})
406   endif()
407
408   if(DEFINED windows_resource_file)
409     set_windows_version_resource_properties(${name} ${windows_resource_file})
410     set(windows_resource_file ${windows_resource_file} PARENT_SCOPE)
411   endif()
412
413   set_output_directory(${name} BINARY_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR} LIBRARY_DIR ${LLVM_LIBRARY_OUTPUT_INTDIR})
414   # $<TARGET_OBJECTS> doesn't require compile flags.
415   if(NOT obj_name)
416     llvm_update_compile_flags(${name})
417   endif()
418   add_link_opts( ${name} )
419   if(ARG_OUTPUT_NAME)
420     set_target_properties(${name}
421       PROPERTIES
422       OUTPUT_NAME ${ARG_OUTPUT_NAME}
423       )
424   endif()
425
426   if(ARG_MODULE)
427     set_target_properties(${name} PROPERTIES
428       PREFIX ""
429       SUFFIX ${LLVM_PLUGIN_EXT}
430       )
431   endif()
432
433   if(ARG_SHARED)
434     if(WIN32)
435       set_target_properties(${name} PROPERTIES
436         PREFIX ""
437         )
438     endif()
439   endif()
440
441   if(ARG_MODULE OR ARG_SHARED)
442     # Do not add -Dname_EXPORTS to the command-line when building files in this
443     # target. Doing so is actively harmful for the modules build because it
444     # creates extra module variants, and not useful because we don't use these
445     # macros.
446     set_target_properties( ${name} PROPERTIES DEFINE_SYMBOL "" )
447
448     if (LLVM_EXPORTED_SYMBOL_FILE)
449       add_llvm_symbol_exports( ${name} ${LLVM_EXPORTED_SYMBOL_FILE} )
450     endif()
451   endif()
452
453   if(ARG_SHARED AND UNIX)
454     if(NOT APPLE AND ARG_SONAME)
455       get_target_property(output_name ${name} OUTPUT_NAME)
456       if(${output_name} STREQUAL "output_name-NOTFOUND")
457         set(output_name ${name})
458       endif()
459       set(library_name ${output_name}-${LLVM_VERSION_MAJOR}.${LLVM_VERSION_MINOR}${LLVM_VERSION_SUFFIX})
460       set(api_name ${output_name}-${LLVM_VERSION_MAJOR}.${LLVM_VERSION_MINOR}.${LLVM_VERSION_PATCH}${LLVM_VERSION_SUFFIX})
461       set_target_properties(${name} PROPERTIES OUTPUT_NAME ${library_name})
462       llvm_install_library_symlink(${api_name} ${library_name} SHARED
463         COMPONENT ${name}
464         ALWAYS_GENERATE)
465       llvm_install_library_symlink(${output_name} ${library_name} SHARED
466         COMPONENT ${name}
467         ALWAYS_GENERATE)
468     endif()
469   endif()
470
471   if (DEFINED LLVM_LINK_COMPONENTS OR DEFINED ARG_LINK_COMPONENTS)
472     if (LLVM_LINK_LLVM_DYLIB AND NOT ARG_DISABLE_LLVM_LINK_LLVM_DYLIB)
473       set(llvm_libs LLVM)
474     else()
475       llvm_map_components_to_libnames(llvm_libs
476        ${ARG_LINK_COMPONENTS}
477        ${LLVM_LINK_COMPONENTS}
478        )
479     endif()
480   else()
481     # Components have not been defined explicitly in CMake, so add the
482     # dependency information for this library as defined by LLVMBuild.
483     #
484     # It would be nice to verify that we have the dependencies for this library
485     # name, but using get_property(... SET) doesn't suffice to determine if a
486     # property has been set to an empty value.
487     get_property(lib_deps GLOBAL PROPERTY LLVMBUILD_LIB_DEPS_${name})
488   endif()
489
490   if(CMAKE_VERSION VERSION_LESS 2.8.12)
491     # Link libs w/o keywords, assuming PUBLIC.
492     target_link_libraries(${name}
493       ${ARG_LINK_LIBS}
494       ${lib_deps}
495       ${llvm_libs}
496       )
497   elseif(ARG_STATIC)
498     target_link_libraries(${name} INTERFACE
499       ${ARG_LINK_LIBS}
500       ${lib_deps}
501       ${llvm_libs}
502       )
503   else()
504     # We can use PRIVATE since SO knows its dependent libs.
505     target_link_libraries(${name} PRIVATE
506       ${ARG_LINK_LIBS}
507       ${lib_deps}
508       ${llvm_libs}
509       )
510   endif()
511
512   if(LLVM_COMMON_DEPENDS)
513     add_dependencies(${name} ${LLVM_COMMON_DEPENDS})
514     # Add dependencies also to objlibs.
515     # CMake issue 14747 --  add_dependencies() might be ignored to objlib's user.
516     foreach(objlib ${objlibs})
517       add_dependencies(${objlib} ${LLVM_COMMON_DEPENDS})
518     endforeach()
519   endif()
520
521   if(ARG_SHARED OR ARG_MODULE)
522     llvm_externalize_debuginfo(${name})
523   endif()
524 endfunction()
525
526 macro(add_llvm_library name)
527   cmake_parse_arguments(ARG
528     "SHARED"
529     ""
530     ""
531     ${ARGN})
532   if( BUILD_SHARED_LIBS )
533     llvm_add_library(${name} SHARED ${ARGN})
534   else()
535     llvm_add_library(${name} ${ARGN})
536   endif()
537   # The gtest libraries should not be installed or exported as a target
538   if ("${name}" STREQUAL gtest OR "${name}" STREQUAL gtest_main)
539     set(_is_gtest TRUE)
540   else()
541     set(_is_gtest FALSE)
542     set_property( GLOBAL APPEND PROPERTY LLVM_LIBS ${name} )
543   endif()
544
545   if( EXCLUDE_FROM_ALL )
546     set_target_properties( ${name} PROPERTIES EXCLUDE_FROM_ALL ON)
547   elseif(NOT _is_gtest)
548     if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY OR ${name} STREQUAL "LTO")
549       set(install_dir lib${LLVM_LIBDIR_SUFFIX})
550       if(ARG_SHARED OR BUILD_SHARED_LIBS)
551         if(WIN32 OR CYGWIN OR MINGW)
552           set(install_type RUNTIME)
553           set(install_dir bin)
554         else()
555           set(install_type LIBRARY)
556         endif()
557       else()
558         set(install_type ARCHIVE)
559       endif()
560
561       install(TARGETS ${name}
562             EXPORT LLVMExports
563             ${install_type} DESTINATION ${install_dir}
564             COMPONENT ${name})
565
566       if (NOT CMAKE_CONFIGURATION_TYPES)
567         add_custom_target(install-${name}
568                           DEPENDS ${name}
569                           COMMAND "${CMAKE_COMMAND}"
570                                   -DCMAKE_INSTALL_COMPONENT=${name}
571                                   -P "${CMAKE_BINARY_DIR}/cmake_install.cmake")
572       endif()
573     endif()
574     set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS ${name})
575   endif()
576   set_target_properties(${name} PROPERTIES FOLDER "Libraries")
577 endmacro(add_llvm_library name)
578
579 macro(add_llvm_loadable_module name)
580   llvm_add_library(${name} MODULE ${ARGN})
581   if(NOT TARGET ${name})
582     # Add empty "phony" target
583     add_custom_target(${name})
584   else()
585     if( EXCLUDE_FROM_ALL )
586       set_target_properties( ${name} PROPERTIES EXCLUDE_FROM_ALL ON)
587     else()
588       if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
589         if(WIN32 OR CYGWIN)
590           # DLL platform
591           set(dlldir "bin")
592         else()
593           set(dlldir "lib${LLVM_LIBDIR_SUFFIX}")
594         endif()
595         install(TARGETS ${name}
596           EXPORT LLVMExports
597           LIBRARY DESTINATION ${dlldir}
598           ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX})
599       endif()
600       set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS ${name})
601     endif()
602   endif()
603
604   set_target_properties(${name} PROPERTIES FOLDER "Loadable modules")
605 endmacro(add_llvm_loadable_module name)
606
607
608 macro(add_llvm_executable name)
609   cmake_parse_arguments(ARG "DISABLE_LLVM_LINK_LLVM_DYLIB;IGNORE_EXTERNALIZE_DEBUGINFO" "" "" ${ARGN})
610   llvm_process_sources( ALL_FILES ${ARG_UNPARSED_ARGUMENTS} )
611
612   # Generate objlib
613   if(LLVM_ENABLE_OBJLIB)
614     # Generate an obj library for both targets.
615     set(obj_name "obj.${name}")
616     add_library(${obj_name} OBJECT EXCLUDE_FROM_ALL
617       ${ALL_FILES}
618       )
619     llvm_update_compile_flags(${obj_name})
620     set(ALL_FILES "$<TARGET_OBJECTS:${obj_name}>")
621
622     set_target_properties(${obj_name} PROPERTIES FOLDER "Object Libraries")
623   endif()
624
625   add_windows_version_resource_file(ALL_FILES ${ALL_FILES})
626
627   if(XCODE)
628     # Note: the dummy.cpp source file provides no definitions. However,
629     # it forces Xcode to properly link the static library.
630     list(APPEND ALL_FILES "${LLVM_MAIN_SRC_DIR}/cmake/dummy.cpp")
631   endif()
632
633   if( EXCLUDE_FROM_ALL )
634     add_executable(${name} EXCLUDE_FROM_ALL ${ALL_FILES})
635   else()
636     add_executable(${name} ${ALL_FILES})
637   endif()
638
639   if(DEFINED windows_resource_file)
640     set_windows_version_resource_properties(${name} ${windows_resource_file})
641   endif()
642
643   # $<TARGET_OBJECTS> doesn't require compile flags.
644   if(NOT LLVM_ENABLE_OBJLIB)
645     llvm_update_compile_flags(${name})
646   endif()
647   add_link_opts( ${name} )
648
649   # Do not add -Dname_EXPORTS to the command-line when building files in this
650   # target. Doing so is actively harmful for the modules build because it
651   # creates extra module variants, and not useful because we don't use these
652   # macros.
653   set_target_properties( ${name} PROPERTIES DEFINE_SYMBOL "" )
654
655   if (LLVM_EXPORTED_SYMBOL_FILE)
656     add_llvm_symbol_exports( ${name} ${LLVM_EXPORTED_SYMBOL_FILE} )
657   endif(LLVM_EXPORTED_SYMBOL_FILE)
658
659   if (LLVM_LINK_LLVM_DYLIB AND NOT ARG_DISABLE_LLVM_LINK_LLVM_DYLIB)
660     set(USE_SHARED USE_SHARED)
661   endif()
662
663   set(EXCLUDE_FROM_ALL OFF)
664   set_output_directory(${name} BINARY_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR} LIBRARY_DIR ${LLVM_LIBRARY_OUTPUT_INTDIR})
665   llvm_config( ${name} ${USE_SHARED} ${LLVM_LINK_COMPONENTS} )
666   if( LLVM_COMMON_DEPENDS )
667     add_dependencies( ${name} ${LLVM_COMMON_DEPENDS} )
668   endif( LLVM_COMMON_DEPENDS )
669
670   if(NOT ARG_IGNORE_EXTERNALIZE_DEBUGINFO)
671     llvm_externalize_debuginfo(${name})
672   endif()
673 endmacro(add_llvm_executable name)
674
675 function(export_executable_symbols target)
676   if (NOT MSVC) # MSVC's linker doesn't support exporting all symbols.
677     set_target_properties(${target} PROPERTIES ENABLE_EXPORTS 1)
678     if (APPLE)
679       set_property(TARGET ${target} APPEND_STRING PROPERTY
680         LINK_FLAGS " -rdynamic")
681     endif()
682   endif()
683 endfunction()
684
685 if(NOT LLVM_TOOLCHAIN_TOOLS)
686   set (LLVM_TOOLCHAIN_TOOLS
687     llvm-ar
688     llvm-ranlib
689     llvm-lib
690     llvm-objdump
691     )
692 endif()
693
694 macro(add_llvm_tool name)
695   if( NOT LLVM_BUILD_TOOLS )
696     set(EXCLUDE_FROM_ALL ON)
697   endif()
698   add_llvm_executable(${name} ${ARGN})
699
700   list(FIND LLVM_TOOLCHAIN_TOOLS ${name} LLVM_IS_${name}_TOOLCHAIN_TOOL)
701   if (LLVM_IS_${name}_TOOLCHAIN_TOOL GREATER -1 OR NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
702     if( LLVM_BUILD_TOOLS )
703       install(TARGETS ${name}
704               EXPORT LLVMExports
705               RUNTIME DESTINATION bin
706               COMPONENT ${name})
707
708       if (NOT CMAKE_CONFIGURATION_TYPES)
709         add_custom_target(install-${name}
710                           DEPENDS ${name}
711                           COMMAND "${CMAKE_COMMAND}"
712                                   -DCMAKE_INSTALL_COMPONENT=${name}
713                                   -P "${CMAKE_BINARY_DIR}/cmake_install.cmake")
714       endif()
715     endif()
716   endif()
717   if( LLVM_BUILD_TOOLS )
718     set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS ${name})
719   endif()
720   set_target_properties(${name} PROPERTIES FOLDER "Tools")
721 endmacro(add_llvm_tool name)
722
723
724 macro(add_llvm_example name)
725   if( NOT LLVM_BUILD_EXAMPLES )
726     set(EXCLUDE_FROM_ALL ON)
727   endif()
728   add_llvm_executable(${name} ${ARGN})
729   if( LLVM_BUILD_EXAMPLES )
730     install(TARGETS ${name} RUNTIME DESTINATION examples)
731   endif()
732   set_target_properties(${name} PROPERTIES FOLDER "Examples")
733 endmacro(add_llvm_example name)
734
735
736 macro(add_llvm_utility name)
737   add_llvm_executable(${name} DISABLE_LLVM_LINK_LLVM_DYLIB ${ARGN})
738   set_target_properties(${name} PROPERTIES FOLDER "Utils")
739   if( LLVM_INSTALL_UTILS )
740     install (TARGETS ${name}
741       RUNTIME DESTINATION bin
742       COMPONENT ${name})
743     if (NOT CMAKE_CONFIGURATION_TYPES)
744       add_custom_target(install-${name}
745                         DEPENDS ${name}
746                         COMMAND "${CMAKE_COMMAND}"
747                                 -DCMAKE_INSTALL_COMPONENT=${name}
748                                 -P "${CMAKE_BINARY_DIR}/cmake_install.cmake")
749     endif()
750   endif()
751 endmacro(add_llvm_utility name)
752
753
754 macro(add_llvm_target target_name)
755   include_directories(BEFORE
756     ${CMAKE_CURRENT_BINARY_DIR}
757     ${CMAKE_CURRENT_SOURCE_DIR})
758   add_llvm_library(LLVM${target_name} ${ARGN})
759   set( CURRENT_LLVM_TARGET LLVM${target_name} )
760 endmacro(add_llvm_target)
761
762 function(canonicalize_tool_name name output)
763   string(REPLACE "${CMAKE_CURRENT_SOURCE_DIR}/" "" nameStrip ${name})
764   string(REPLACE "-" "_" nameUNDERSCORE ${nameStrip})
765   string(TOUPPER ${nameUNDERSCORE} nameUPPER)
766   set(${output} "${nameUPPER}" PARENT_SCOPE)
767 endfunction(canonicalize_tool_name)
768
769 # Custom add_subdirectory wrapper
770 # Takes in a project name (i.e. LLVM), the the subdirectory name, and an
771 # and an optional path if it differs from the name.
772 macro(add_llvm_subdirectory project type name)
773   set(add_llvm_external_dir "${ARGN}")
774   if("${add_llvm_external_dir}" STREQUAL "")
775     set(add_llvm_external_dir ${name})
776   endif()
777   canonicalize_tool_name(${name} nameUPPER)
778   if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${add_llvm_external_dir}/CMakeLists.txt)
779     # Treat it as in-tree subproject.
780     option(${project}_${type}_${nameUPPER}_BUILD
781            "Whether to build ${name} as part of ${project}" On)
782     mark_as_advanced(${project}_${type}_${name}_BUILD)
783     if(${project}_${type}_${nameUPPER}_BUILD)
784       add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/${add_llvm_external_dir} ${add_llvm_external_dir})
785       # Don't process it in add_llvm_implicit_projects().
786       set(${project}_${type}_${nameUPPER}_BUILD OFF)
787     endif()
788   else()
789     set(LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR
790       "${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR}"
791       CACHE PATH "Path to ${name} source directory")
792     set(${project}_${type}_${nameUPPER}_BUILD_DEFAULT ON)
793     if(NOT LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR OR NOT EXISTS ${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR})
794       set(${project}_${type}_${nameUPPER}_BUILD_DEFAULT OFF)
795     endif()
796     if("${LLVM_EXTERNAL_${nameUPPER}_BUILD}" STREQUAL "OFF")
797       set(${project}_${type}_${nameUPPER}_BUILD_DEFAULT OFF)
798     endif()
799     option(${project}_${type}_${nameUPPER}_BUILD
800       "Whether to build ${name} as part of LLVM"
801       ${${project}_${type}_${nameUPPER}_BUILD_DEFAULT})
802     if (${project}_${type}_${nameUPPER}_BUILD)
803       if(EXISTS ${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR})
804         add_subdirectory(${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR} ${add_llvm_external_dir})
805       elseif(NOT "${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR}" STREQUAL "")
806         message(WARNING "Nonexistent directory for ${name}: ${LLVM_EXTERNAL_${nameUPPER}_SOURCE_DIR}")
807       endif()
808       # FIXME: It'd be redundant.
809       set(${project}_${type}_${nameUPPER}_BUILD Off)
810     endif()
811   endif()
812 endmacro()
813
814 # Add external project that may want to be built as part of llvm such as Clang,
815 # lld, and Polly. This adds two options. One for the source directory of the
816 # project, which defaults to ${CMAKE_CURRENT_SOURCE_DIR}/${name}. Another to
817 # enable or disable building it with everything else.
818 # Additional parameter can be specified as the name of directory.
819 macro(add_llvm_external_project name)
820   add_llvm_subdirectory(LLVM TOOL ${name} ${ARGN})
821 endmacro()
822
823 macro(add_llvm_tool_subdirectory name)
824   add_llvm_external_project(${name})
825 endmacro(add_llvm_tool_subdirectory)
826
827 function(get_project_name_from_src_var var output)
828   string(REGEX MATCH "LLVM_EXTERNAL_(.*)_SOURCE_DIR"
829          MACHED_TOOL "${var}")
830   if(MACHED_TOOL)
831     set(${output} ${CMAKE_MATCH_1} PARENT_SCOPE)
832   else()
833     set(${output} PARENT_SCOPE)
834   endif()
835 endfunction()
836
837 function(create_subdirectory_options project type)
838   file(GLOB sub-dirs "${CMAKE_CURRENT_SOURCE_DIR}/*")
839   foreach(dir ${sub-dirs})
840     if(IS_DIRECTORY "${dir}" AND EXISTS "${dir}/CMakeLists.txt")
841       canonicalize_tool_name(${dir} name)
842       option(${project}_${type}_${name}_BUILD
843            "Whether to build ${name} as part of ${project}" On)
844       mark_as_advanced(${project}_${type}_${name}_BUILD)
845     endif()
846   endforeach()
847 endfunction(create_subdirectory_options)
848
849 function(create_llvm_tool_options)
850   create_subdirectory_options(LLVM TOOL)
851 endfunction(create_llvm_tool_options)
852
853 function(add_llvm_implicit_projects)
854   set(list_of_implicit_subdirs "")
855   file(GLOB sub-dirs "${CMAKE_CURRENT_SOURCE_DIR}/*")
856   foreach(dir ${sub-dirs})
857     if(IS_DIRECTORY "${dir}" AND EXISTS "${dir}/CMakeLists.txt")
858       canonicalize_tool_name(${dir} name)
859       if (LLVM_TOOL_${name}_BUILD)
860         get_filename_component(fn "${dir}" NAME)
861         list(APPEND list_of_implicit_subdirs "${fn}")
862       endif()
863     endif()
864   endforeach()
865
866   foreach(external_proj ${list_of_implicit_subdirs})
867     add_llvm_external_project("${external_proj}")
868   endforeach()
869 endfunction(add_llvm_implicit_projects)
870
871 # Generic support for adding a unittest.
872 function(add_unittest test_suite test_name)
873   if( NOT LLVM_BUILD_TESTS )
874     set(EXCLUDE_FROM_ALL ON)
875   endif()
876
877   include_directories(${LLVM_MAIN_SRC_DIR}/utils/unittest/googletest/include)
878   if (NOT LLVM_ENABLE_THREADS)
879     list(APPEND LLVM_COMPILE_DEFINITIONS GTEST_HAS_PTHREAD=0)
880   endif ()
881
882   if (SUPPORTS_NO_VARIADIC_MACROS_FLAG)
883     list(APPEND LLVM_COMPILE_FLAGS "-Wno-variadic-macros")
884   endif ()
885
886   set(LLVM_REQUIRES_RTTI OFF)
887
888   list(APPEND LLVM_LINK_COMPONENTS Support) # gtest needs it for raw_ostream
889   add_llvm_executable(${test_name} IGNORE_EXTERNALIZE_DEBUGINFO ${ARGN})
890   set(outdir ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR})
891   set_output_directory(${test_name} BINARY_DIR ${outdir} LIBRARY_DIR ${outdir})
892   target_link_libraries(${test_name} gtest_main gtest)
893
894   add_dependencies(${test_suite} ${test_name})
895   get_target_property(test_suite_folder ${test_suite} FOLDER)
896   if (NOT ${test_suite_folder} STREQUAL "NOTFOUND")
897     set_property(TARGET ${test_name} PROPERTY FOLDER "${test_suite_folder}")
898   endif ()
899 endfunction()
900
901 function(llvm_add_go_executable binary pkgpath)
902   cmake_parse_arguments(ARG "ALL" "" "DEPENDS;GOFLAGS" ${ARGN})
903
904   if(LLVM_BINDINGS MATCHES "go")
905     # FIXME: This should depend only on the libraries Go needs.
906     get_property(llvmlibs GLOBAL PROPERTY LLVM_LIBS)
907     set(binpath ${CMAKE_BINARY_DIR}/bin/${binary}${CMAKE_EXECUTABLE_SUFFIX})
908     set(cc "${CMAKE_C_COMPILER} ${CMAKE_C_COMPILER_ARG1}")
909     set(cxx "${CMAKE_CXX_COMPILER} ${CMAKE_CXX_COMPILER_ARG1}")
910     set(cppflags "")
911     get_property(include_dirs DIRECTORY PROPERTY INCLUDE_DIRECTORIES)
912     foreach(d ${include_dirs})
913       set(cppflags "${cppflags} -I${d}")
914     endforeach(d)
915     set(ldflags "${CMAKE_EXE_LINKER_FLAGS}")
916     if (LLVM_LINK_LLVM_DYLIB)
917       set(linkmode "dylib")
918     else()
919       set(linkmode "component-libs")
920     endif()
921     add_custom_command(OUTPUT ${binpath}
922       COMMAND ${CMAKE_BINARY_DIR}/bin/llvm-go "go=${GO_EXECUTABLE}" "cc=${cc}" "cxx=${cxx}" "cppflags=${cppflags}" "ldflags=${ldflags}" "linkmode=${linkmode}"
923               ${ARG_GOFLAGS} build -o ${binpath} ${pkgpath}
924       DEPENDS llvm-config ${CMAKE_BINARY_DIR}/bin/llvm-go${CMAKE_EXECUTABLE_SUFFIX}
925               ${llvmlibs} ${ARG_DEPENDS}
926       COMMENT "Building Go executable ${binary}"
927       VERBATIM)
928     if (ARG_ALL)
929       add_custom_target(${binary} ALL DEPENDS ${binpath})
930     else()
931       add_custom_target(${binary} DEPENDS ${binpath})
932     endif()
933   endif()
934 endfunction()
935
936 # This function provides an automatic way to 'configure'-like generate a file
937 # based on a set of common and custom variables, specifically targeting the
938 # variables needed for the 'lit.site.cfg' files. This function bundles the
939 # common variables that any Lit instance is likely to need, and custom
940 # variables can be passed in.
941 function(configure_lit_site_cfg input output)
942   foreach(c ${LLVM_TARGETS_TO_BUILD})
943     set(TARGETS_BUILT "${TARGETS_BUILT} ${c}")
944   endforeach(c)
945   set(TARGETS_TO_BUILD ${TARGETS_BUILT})
946
947   set(SHLIBEXT "${LTDL_SHLIB_EXT}")
948
949   # Configuration-time: See Unit/lit.site.cfg.in
950   if (CMAKE_CFG_INTDIR STREQUAL ".")
951     set(LLVM_BUILD_MODE ".")
952   else ()
953     set(LLVM_BUILD_MODE "%(build_mode)s")
954   endif ()
955
956   # They below might not be the build tree but provided binary tree.
957   set(LLVM_SOURCE_DIR ${LLVM_MAIN_SRC_DIR})
958   set(LLVM_BINARY_DIR ${LLVM_BINARY_DIR})
959   string(REPLACE ${CMAKE_CFG_INTDIR} ${LLVM_BUILD_MODE} LLVM_TOOLS_DIR ${LLVM_TOOLS_BINARY_DIR})
960   string(REPLACE ${CMAKE_CFG_INTDIR} ${LLVM_BUILD_MODE} LLVM_LIBS_DIR  ${LLVM_LIBRARY_DIR})
961
962   # SHLIBDIR points the build tree.
963   string(REPLACE ${CMAKE_CFG_INTDIR} ${LLVM_BUILD_MODE} SHLIBDIR "${LLVM_SHLIB_OUTPUT_INTDIR}")
964
965   set(PYTHON_EXECUTABLE ${PYTHON_EXECUTABLE})
966   # FIXME: "ENABLE_SHARED" doesn't make sense, since it is used just for
967   # plugins. We may rename it.
968   if(LLVM_ENABLE_PLUGINS)
969     set(ENABLE_SHARED "1")
970   else()
971     set(ENABLE_SHARED "0")
972   endif()
973
974   if(LLVM_ENABLE_ASSERTIONS AND NOT MSVC_IDE)
975     set(ENABLE_ASSERTIONS "1")
976   else()
977     set(ENABLE_ASSERTIONS "0")
978   endif()
979
980   set(HOST_OS ${CMAKE_SYSTEM_NAME})
981   set(HOST_ARCH ${CMAKE_SYSTEM_PROCESSOR})
982
983   set(HOST_CC "${CMAKE_C_COMPILER} ${CMAKE_C_COMPILER_ARG1}")
984   set(HOST_CXX "${CMAKE_CXX_COMPILER} ${CMAKE_CXX_COMPILER_ARG1}")
985   set(HOST_LDFLAGS "${CMAKE_EXE_LINKER_FLAGS}")
986
987   configure_file(${input} ${output} @ONLY)
988 endfunction()
989
990 # A raw function to create a lit target. This is used to implement the testuite
991 # management functions.
992 function(add_lit_target target comment)
993   cmake_parse_arguments(ARG "" "" "PARAMS;DEPENDS;ARGS" ${ARGN})
994   set(LIT_ARGS "${ARG_ARGS} ${LLVM_LIT_ARGS}")
995   separate_arguments(LIT_ARGS)
996   if (NOT CMAKE_CFG_INTDIR STREQUAL ".")
997     list(APPEND LIT_ARGS --param build_mode=${CMAKE_CFG_INTDIR})
998   endif ()
999   if (LLVM_MAIN_SRC_DIR)
1000     set (LIT_COMMAND ${PYTHON_EXECUTABLE} ${LLVM_MAIN_SRC_DIR}/utils/lit/lit.py)
1001   else()
1002     find_program(LIT_COMMAND llvm-lit)
1003   endif ()
1004   list(APPEND LIT_COMMAND ${LIT_ARGS})
1005   foreach(param ${ARG_PARAMS})
1006     list(APPEND LIT_COMMAND --param ${param})
1007   endforeach()
1008   if (ARG_UNPARSED_ARGUMENTS)
1009     add_custom_target(${target}
1010       COMMAND ${LIT_COMMAND} ${ARG_UNPARSED_ARGUMENTS}
1011       COMMENT "${comment}"
1012       ${cmake_3_2_USES_TERMINAL}
1013       )
1014   else()
1015     add_custom_target(${target}
1016       COMMAND ${CMAKE_COMMAND} -E echo "${target} does nothing, no tools built.")
1017     message(STATUS "${target} does nothing.")
1018   endif()
1019   if (ARG_DEPENDS)
1020     add_dependencies(${target} ${ARG_DEPENDS})
1021   endif()
1022
1023   # Tests should be excluded from "Build Solution".
1024   set_target_properties(${target} PROPERTIES EXCLUDE_FROM_DEFAULT_BUILD ON)
1025 endfunction()
1026
1027 # A function to add a set of lit test suites to be driven through 'check-*' targets.
1028 function(add_lit_testsuite target comment)
1029   cmake_parse_arguments(ARG "" "" "PARAMS;DEPENDS;ARGS" ${ARGN})
1030
1031   # EXCLUDE_FROM_ALL excludes the test ${target} out of check-all.
1032   if(NOT EXCLUDE_FROM_ALL)
1033     # Register the testsuites, params and depends for the global check rule.
1034     set_property(GLOBAL APPEND PROPERTY LLVM_LIT_TESTSUITES ${ARG_UNPARSED_ARGUMENTS})
1035     set_property(GLOBAL APPEND PROPERTY LLVM_LIT_PARAMS ${ARG_PARAMS})
1036     set_property(GLOBAL APPEND PROPERTY LLVM_LIT_DEPENDS ${ARG_DEPENDS})
1037     set_property(GLOBAL APPEND PROPERTY LLVM_LIT_EXTRA_ARGS ${ARG_ARGS})
1038   endif()
1039
1040   # Produce a specific suffixed check rule.
1041   add_lit_target(${target} ${comment}
1042     ${ARG_UNPARSED_ARGUMENTS}
1043     PARAMS ${ARG_PARAMS}
1044     DEPENDS ${ARG_DEPENDS}
1045     ARGS ${ARG_ARGS}
1046     )
1047 endfunction()
1048
1049 function(add_lit_testsuites project directory)
1050   if (NOT CMAKE_CONFIGURATION_TYPES)
1051     cmake_parse_arguments(ARG "" "" "PARAMS;DEPENDS;ARGS" ${ARGN})
1052     file(GLOB_RECURSE litCfg ${directory}/lit*.cfg)
1053     set(lit_suites)
1054     foreach(f ${litCfg})
1055       get_filename_component(dir ${f} DIRECTORY)
1056       set(lit_suites ${lit_suites} ${dir})
1057     endforeach()
1058     list(REMOVE_DUPLICATES lit_suites)
1059     foreach(dir ${lit_suites})
1060       string(REPLACE ${directory} "" name_slash ${dir})
1061       if (name_slash)
1062         string(REPLACE "/" "-" name_slash ${name_slash})
1063         string(REPLACE "\\" "-" name_dashes ${name_slash})
1064         string(TOLOWER "${project}${name_dashes}" name_var)
1065         add_lit_target("check-${name_var}" "Running lit suite ${dir}"
1066           ${dir}
1067           PARAMS ${ARG_PARAMS}
1068           DEPENDS ${ARG_DEPENDS}
1069           ARGS ${ARG_ARGS}
1070         )
1071       endif()
1072     endforeach()
1073   endif()
1074 endfunction()
1075
1076 function(llvm_install_library_symlink name dest type)
1077   cmake_parse_arguments(ARG "ALWAYS_GENERATE" "COMPONENT" "" ${ARGN})
1078   foreach(path ${CMAKE_MODULE_PATH})
1079     if(EXISTS ${path}/LLVMInstallSymlink.cmake)
1080       set(INSTALL_SYMLINK ${path}/LLVMInstallSymlink.cmake)
1081       break()
1082     endif()
1083   endforeach()
1084
1085   set(component ${ARG_COMPONENT})
1086   if(NOT component)
1087     set(component ${name})
1088   endif()
1089
1090   set(full_name ${CMAKE_${type}_LIBRARY_PREFIX}${name}${CMAKE_${type}_LIBRARY_SUFFIX})
1091   set(full_dest ${CMAKE_${type}_LIBRARY_PREFIX}${dest}${CMAKE_${type}_LIBRARY_SUFFIX})
1092
1093   set(output_dir lib${LLVM_LIBDIR_SUFFIX})
1094   if(WIN32 AND "${type}" STREQUAL "SHARED")
1095     set(output_dir bin)
1096   endif()
1097
1098   install(SCRIPT ${INSTALL_SYMLINK}
1099           CODE "install_symlink(${full_name} ${full_dest} ${output_dir})"
1100           COMPONENT ${component})
1101
1102   if (NOT CMAKE_CONFIGURATION_TYPES AND NOT ARG_ALWAYS_GENERATE)
1103     add_custom_target(install-${name}
1104                       DEPENDS ${name} ${dest} install-${dest}
1105                       COMMAND "${CMAKE_COMMAND}"
1106                               -DCMAKE_INSTALL_COMPONENT=${name}
1107                               -P "${CMAKE_BINARY_DIR}/cmake_install.cmake")
1108   endif()
1109 endfunction()
1110
1111 function(llvm_install_symlink name dest)
1112   cmake_parse_arguments(ARG "ALWAYS_GENERATE" "" "" ${ARGN})
1113   foreach(path ${CMAKE_MODULE_PATH})
1114     if(EXISTS ${path}/LLVMInstallSymlink.cmake)
1115       set(INSTALL_SYMLINK ${path}/LLVMInstallSymlink.cmake)
1116       break()
1117     endif()
1118   endforeach()
1119
1120   if(ARG_ALWAYS_GENERATE)
1121     set(component ${dest})
1122   else()
1123     set(component ${name})
1124   endif()
1125
1126   set(full_name ${name}${CMAKE_EXECUTABLE_SUFFIX})
1127   set(full_dest ${dest}${CMAKE_EXECUTABLE_SUFFIX})
1128
1129   install(SCRIPT ${INSTALL_SYMLINK}
1130           CODE "install_symlink(${full_name} ${full_dest} bin)"
1131           COMPONENT ${component})
1132
1133   if (NOT CMAKE_CONFIGURATION_TYPES AND NOT ARG_ALWAYS_GENERATE)
1134     add_custom_target(install-${name}
1135                       DEPENDS ${name} ${dest} install-${dest}
1136                       COMMAND "${CMAKE_COMMAND}"
1137                               -DCMAKE_INSTALL_COMPONENT=${name}
1138                               -P "${CMAKE_BINARY_DIR}/cmake_install.cmake")
1139   endif()
1140 endfunction()
1141
1142 function(add_llvm_tool_symlink name dest)
1143   cmake_parse_arguments(ARG "ALWAYS_GENERATE" "" "" ${ARGN})
1144   if(UNIX)
1145     set(LLVM_LINK_OR_COPY create_symlink)
1146     set(dest_binary "${dest}${CMAKE_EXECUTABLE_SUFFIX}")
1147   else()
1148     set(LLVM_LINK_OR_COPY copy)
1149     set(dest_binary "${LLVM_RUNTIME_OUTPUT_INTDIR}/${dest}${CMAKE_EXECUTABLE_SUFFIX}")
1150   endif()
1151
1152   set(output_path "${LLVM_RUNTIME_OUTPUT_INTDIR}/${name}${CMAKE_EXECUTABLE_SUFFIX}")
1153
1154   if(ARG_ALWAYS_GENERATE)
1155     set_property(DIRECTORY APPEND PROPERTY
1156       ADDITIONAL_MAKE_CLEAN_FILES ${dest_binary})
1157     add_custom_command(TARGET ${dest} POST_BUILD
1158       COMMAND ${CMAKE_COMMAND} -E ${LLVM_LINK_OR_COPY} "${dest_binary}" "${output_path}")
1159   else()
1160     add_custom_command(OUTPUT ${output_path}
1161                      COMMAND ${CMAKE_COMMAND} -E ${LLVM_LINK_OR_COPY} "${dest_binary}" "${output_path}"
1162                      DEPENDS ${dest})
1163     add_custom_target(${name} ALL DEPENDS ${output_path})
1164     set_target_properties(${name} PROPERTIES FOLDER Tools)
1165
1166     # Make sure the parent tool is a toolchain tool, otherwise exclude this tool
1167     list(FIND LLVM_TOOLCHAIN_TOOLS ${dest} LLVM_IS_${dest}_TOOLCHAIN_TOOL)
1168     if (NOT LLVM_IS_${dest}_TOOLCHAIN_TOOL GREATER -1)
1169       set(LLVM_IS_${name}_TOOLCHAIN_TOOL ${LLVM_IS_${dest}_TOOLCHAIN_TOOL})
1170     else()
1171       list(FIND LLVM_TOOLCHAIN_TOOLS ${name} LLVM_IS_${name}_TOOLCHAIN_TOOL)
1172     endif()
1173
1174     # LLVM_IS_${name}_TOOLCHAIN_TOOL will only be greater than -1 if both this
1175     # tool and its parent tool are in LLVM_TOOLCHAIN_TOOLS
1176     if (LLVM_IS_${name}_TOOLCHAIN_TOOL GREATER -1 OR NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
1177       if( LLVM_BUILD_TOOLS )
1178         llvm_install_symlink(${name} ${dest})
1179       endif()
1180     endif()
1181   endif()
1182 endfunction()
1183
1184 function(llvm_externalize_debuginfo name)
1185   if(NOT LLVM_EXTERNALIZE_DEBUGINFO)
1186     return()
1187   endif()
1188
1189   if(APPLE)
1190     if(CMAKE_CXX_FLAGS MATCHES "-flto"
1191       OR CMAKE_CXX_FLAGS_${uppercase_CMAKE_BUILD_TYPE} MATCHES "-flto")
1192
1193       set(lto_object ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/${name}-lto.o)
1194       set_property(TARGET ${name} APPEND_STRING PROPERTY
1195         LINK_FLAGS " -Wl,-object_path_lto,${lto_object}")
1196     endif()
1197     add_custom_command(TARGET ${name} POST_BUILD
1198       COMMAND xcrun dsymutil $<TARGET_FILE:${name}>
1199       COMMAND xcrun strip -Sl $<TARGET_FILE:${name}>)
1200   else()
1201     message(FATAL_ERROR "LLVM_EXTERNALIZE_DEBUGINFO isn't implemented for non-darwin platforms!")
1202   endif()
1203 endfunction()