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