xref: /llvm-project/lld/CMakeLists.txt (revision 30e983c40c71390c6c9506a8e4f914b85d009c3d)
1cmake_minimum_required(VERSION 3.20.0)
2set(LLVM_SUBPROJECT_TITLE "LLD")
3
4if(NOT DEFINED LLVM_COMMON_CMAKE_UTILS)
5  set(LLVM_COMMON_CMAKE_UTILS ${CMAKE_CURRENT_SOURCE_DIR}/../cmake)
6endif()
7include(${LLVM_COMMON_CMAKE_UTILS}/Modules/CMakePolicy.cmake
8  NO_POLICY_SCOPE)
9
10# If we are not building as a part of LLVM, build LLD as an
11# standalone project, using LLVM as an external library:
12if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
13  project(lld)
14  set(LLD_BUILT_STANDALONE TRUE)
15endif()
16
17# Must go below project(..)
18include(GNUInstallDirs)
19
20if(LLD_BUILT_STANDALONE)
21  set(CMAKE_CXX_STANDARD 17 CACHE STRING "C++ standard to conform to")
22  set(CMAKE_CXX_STANDARD_REQUIRED YES)
23  set(CMAKE_CXX_EXTENSIONS NO)
24
25  set(CMAKE_INCLUDE_CURRENT_DIR ON)
26
27  find_package(LLVM REQUIRED HINTS "${LLVM_CMAKE_DIR}")
28  list(APPEND CMAKE_MODULE_PATH "${LLVM_DIR}")
29
30  # Turn into CACHE PATHs for overwriting
31  set(LLVM_INCLUDE_DIRS ${LLVM_INCLUDE_DIRS} CACHE PATH "Path to llvm/include and any other header dirs needed")
32  set(LLVM_BINARY_DIR "${LLVM_BINARY_DIR}" CACHE PATH "Path to LLVM build tree")
33  set(LLVM_MAIN_SRC_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../llvm" CACHE PATH "Path to LLVM source tree")
34
35  find_program(LLVM_TABLEGEN_EXE "llvm-tblgen" ${LLVM_TOOLS_BINARY_DIR}
36    NO_DEFAULT_PATH)
37
38  # They are used as destination of target generators.
39  set(LLVM_RUNTIME_OUTPUT_INTDIR ${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/bin)
40  set(LLVM_LIBRARY_OUTPUT_INTDIR ${CMAKE_BINARY_DIR}/${CMAKE_CFG_INTDIR}/lib${LLVM_LIBDIR_SUFFIX})
41
42  include(AddLLVM)
43  include(TableGen)
44  include(HandleLLVMOptions)
45  include(GetErrcMessages)
46  include(CheckAtomic)
47
48  set(PACKAGE_VERSION "${LLVM_PACKAGE_VERSION}")
49
50  include_directories(${LLVM_INCLUDE_DIRS})
51  link_directories(${LLVM_LIBRARY_DIRS})
52
53  if(LLVM_INCLUDE_TESTS)
54    find_package(Python3 ${LLVM_MINIMUM_PYTHON_VERSION} REQUIRED
55      COMPONENTS Interpreter)
56
57    # Check prebuilt llvm/utils.
58    if(EXISTS ${LLVM_TOOLS_BINARY_DIR}/FileCheck${CMAKE_EXECUTABLE_SUFFIX}
59        AND EXISTS ${LLVM_TOOLS_BINARY_DIR}/not${CMAKE_EXECUTABLE_SUFFIX})
60      set(LLVM_UTILS_PROVIDED ON)
61    endif()
62
63    if(EXISTS ${LLVM_MAIN_SRC_DIR}/utils/lit/lit.py)
64      # Note: path not really used, except for checking if lit was found
65      set(LLVM_EXTERNAL_LIT ${LLVM_MAIN_SRC_DIR}/utils/lit/lit.py)
66      if(NOT LLVM_UTILS_PROVIDED)
67        add_subdirectory(${LLVM_MAIN_SRC_DIR}/utils/FileCheck utils/FileCheck)
68        add_subdirectory(${LLVM_MAIN_SRC_DIR}/utils/not utils/not)
69        set(LLVM_UTILS_PROVIDED ON)
70        set(LLD_TEST_DEPS FileCheck not)
71      endif()
72
73      if (NOT TARGET llvm_gtest)
74        message(FATAL_ERROR "llvm-gtest not found. Please install llvm-gtest or disable tests with -DLLVM_INCLUDE_TESTS=OFF")
75      endif()
76    else()
77      # Seek installed Lit.
78      find_program(LLVM_EXTERNAL_LIT
79                   NAMES llvm-lit lit.py lit
80                   PATHS "${LLVM_MAIN_SRC_DIR}/utils/lit"
81                   DOC "Path to lit.py")
82    endif()
83
84    if(LLVM_EXTERNAL_LIT)
85      # Define the default arguments to use with 'lit', and an option for the user
86      # to override.
87      set(LIT_ARGS_DEFAULT "-sv")
88      if (MSVC OR XCODE)
89        set(LIT_ARGS_DEFAULT "${LIT_ARGS_DEFAULT} --no-progress-bar")
90      endif()
91      set(LLVM_LIT_ARGS "${LIT_ARGS_DEFAULT}" CACHE STRING "Default options for lit")
92
93      get_errc_messages(LLVM_LIT_ERRC_MESSAGES)
94
95      # On Win32 hosts, provide an option to specify the path to the GnuWin32 tools.
96      if(WIN32 AND NOT CYGWIN)
97        set(LLVM_LIT_TOOLS_DIR "" CACHE PATH "Path to GnuWin32 tools")
98      endif()
99    else()
100      set(LLVM_INCLUDE_TESTS OFF)
101    endif()
102  endif()
103endif() # standalone
104
105set(LLD_TOOLS_INSTALL_DIR "${CMAKE_INSTALL_BINDIR}" CACHE PATH
106    "Path for binary subdirectory (defaults to '${CMAKE_INSTALL_BINDIR}')")
107mark_as_advanced(LLD_TOOLS_INSTALL_DIR)
108
109set(LLD_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
110set(LLD_INCLUDE_DIR ${LLD_SOURCE_DIR}/include )
111set(LLD_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
112
113set(LLD_VENDOR ${PACKAGE_VENDOR} CACHE STRING
114  "Vendor-specific text for showing with version information.")
115
116if(LLD_VENDOR)
117  add_definitions(-DLLD_VENDOR="${LLD_VENDOR}")
118endif()
119
120# Compute the LLD version from the LLVM version.
121string(REGEX MATCH "[0-9]+\\.[0-9]+(\\.[0-9]+)?" LLD_VERSION
122  ${PACKAGE_VERSION})
123message(STATUS "LLD version: ${LLD_VERSION}")
124
125string(REGEX REPLACE "([0-9]+)\\.[0-9]+(\\.[0-9]+)?" "\\1" LLD_VERSION_MAJOR
126  ${LLD_VERSION})
127string(REGEX REPLACE "[0-9]+\\.([0-9]+)(\\.[0-9]+)?" "\\1" LLD_VERSION_MINOR
128  ${LLD_VERSION})
129
130# Configure the Version.inc file.
131configure_file(
132  ${CMAKE_CURRENT_SOURCE_DIR}/include/lld/Common/Version.inc.in
133  ${CMAKE_CURRENT_BINARY_DIR}/include/lld/Common/Version.inc)
134
135
136if (CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
137  message(FATAL_ERROR "In-source builds are not allowed. CMake would overwrite "
138"the makefiles distributed with LLVM. Please create a directory and run cmake "
139"from there, passing the path to this source directory as the last argument. "
140"This process created the file `CMakeCache.txt' and the directory "
141"`CMakeFiles'. Please delete them.")
142endif()
143
144# Add path for custom modules.
145list(INSERT CMAKE_MODULE_PATH 0
146  "${LLD_SOURCE_DIR}/cmake/modules"
147  "${LLVM_COMMON_CMAKE_UTILS}/Modules"
148  )
149
150include(AddLLD)
151
152option(LLD_USE_VTUNE
153       "Enable VTune user task tracking."
154       OFF)
155if (LLD_USE_VTUNE)
156  find_package(VTune)
157  if (VTUNE_FOUND)
158    include_directories(${VTune_INCLUDE_DIRS})
159    list(APPEND LLVM_COMMON_LIBS ${VTune_LIBRARIES})
160    add_definitions(-DLLD_HAS_VTUNE)
161  endif()
162endif()
163
164option(LLD_BUILD_TOOLS
165  "Build the lld tools. If OFF, just generate build targets." ON)
166
167option(LLD_DEFAULT_LD_LLD_IS_MINGW
168    "Use MinGW as the default backend for ld.lld. If OFF, ELF will be used." OFF)
169if (LLD_DEFAULT_LD_LLD_IS_MINGW)
170  add_definitions("-DLLD_DEFAULT_LD_LLD_IS_MINGW=1")
171endif()
172
173if (MSVC)
174  add_definitions(-wd4530) # Suppress 'warning C4530: C++ exception handler used, but unwind semantics are not enabled.'
175  add_definitions(-wd4062) # Suppress 'warning C4062: enumerator X in switch of enum Y is not handled' from system header.
176endif()
177
178include_directories(BEFORE
179  ${CMAKE_CURRENT_BINARY_DIR}/include
180  ${CMAKE_CURRENT_SOURCE_DIR}/include
181  )
182
183if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
184  install(DIRECTORY include/
185    DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
186    FILES_MATCHING
187    PATTERN "*.h"
188    )
189endif()
190
191add_subdirectory(Common)
192add_subdirectory(tools/lld)
193
194if (LLVM_INCLUDE_TESTS)
195  add_custom_target(LLDUnitTests)
196  set_target_properties(LLDUnitTests PROPERTIES FOLDER "LLD/Tests")
197  if (TARGET llvm_gtest)
198    add_subdirectory(unittests)
199  endif()
200  add_subdirectory(test)
201endif()
202
203add_subdirectory(docs)
204add_subdirectory(COFF)
205add_subdirectory(ELF)
206add_subdirectory(MachO)
207add_subdirectory(MinGW)
208add_subdirectory(wasm)
209
210add_subdirectory(cmake/modules)
211