Skip to content

[llvm] optionally install backend headers #115837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[llvm] optionally install backend headers #115837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions llvm/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1355,6 +1355,17 @@ if (LLVM_INCLUDE_UTILS)
add_subdirectory(utils/llvm-lit)
endif()

set(LLVM_INSTALL_BACKEND_HEADERS
OFF
CACHE BOOL "Install back-end specific headers and table-genned files")
if(LLVM_INSTALL_BACKEND_HEADERS AND LLVM_INSTALL_TOOLCHAIN_ONLY)
message(
FATAL_ERROR
"LLVM_INSTALL_BACKEND_HEADERS only works if "
"LLVM_INSTALL_TOOLCHAIN_ONLY is set to OFF as it installs component "
"library headers")
endif()

if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
install(DIRECTORY include/llvm include/llvm-c
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
Expand All @@ -1367,6 +1378,41 @@ if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
PATTERN "LICENSE.TXT"
)

if (LLVM_INSTALL_BACKEND_HEADERS)
# Install table-genned files into include install dir.
install(DIRECTORY ${CMAKE_BINARY_DIR}/lib/
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/llvm"
COMPONENT llvm-headers
FILES_MATCHING
PATTERN "*.inc"
PATTERN "*.h"
PATTERN "*.def"
PATTERN "CMakeFiles" EXCLUDE
)

# Installing a generated config is not ideal, but
# lots of generated headers depend on it. It's assumed
# that exported static libraries will be consumed with the
# same toolchain LLVM was built with.
install(DIRECTORY ${CMAKE_BINARY_DIR}/include/
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
COMPONENT llvm-headers
FILES_MATCHING
PATTERN "*config.h"
)

# Such installs lead to lots of empty directories because
# of a cmake issue:
# https://gitlab.kitware.com/cmake/cmake/-/issues/17122
foreach(target ${LLVM_TARGETS_TO_BUILD})
install(DIRECTORY lib/Target/${target}/
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/llvm/Target/${target}"
COMPONENT llvm-headers
FILES_MATCHING
PATTERN "*.h"
)
endforeach()
endif()
install(DIRECTORY ${LLVM_INCLUDE_DIR}/llvm ${LLVM_INCLUDE_DIR}/llvm-c
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
COMPONENT llvm-headers
Expand Down
7 changes: 7 additions & 0 deletions llvm/docs/BuildingADistribution.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,3 +255,10 @@ that are already documented include: *LLVM_TARGETS_TO_BUILD*, *LLVM_ENABLE_PROJE
default ``install`` target. Including the development tools is not recommended
for distributions as many of the LLVM tools are only intended for development
and testing use.

**LLVM_INSTALL_BACKEND_HEADERS**:BOOL
This option defaults to ``Off``: When set to ``On`` it installs backend
headers for specified Targets. It allows to use LLVM's backend info out of
project tree. Note that this option does not work if
LLVM_INSTALL_TOOLCHAIN_ONLY set to ``On`` as it is meant to install component
library headers
Loading