Skip to content

Commit 8f766e3

Browse files
author
serge-sans-paille
committed
Update compiler extension integration into the build system
The approach here is to create a new (empty) component, `Extensions', where all statically compiled extensions dynamically register their dependencies. That way we're more natively compatible with LLVMBuild and llvm-config. Fixes: https://bugs.llvm.org/show_bug.cgi?id=44870 Differential Revision: https://reviews.llvm.org/D78192
1 parent ebdb893 commit 8f766e3

File tree

12 files changed

+113
-24
lines changed

12 files changed

+113
-24
lines changed

‎clang/lib/CodeGen/CMakeLists.txt‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ set(LLVM_LINK_COMPONENTS
55
Core
66
Coroutines
77
Coverage
8+
Extensions
89
FrontendOpenMP
910
IPO
1011
IRReader
@@ -96,8 +97,6 @@ add_clang_library(clangCodeGen
9697
TargetInfo.cpp
9798
VarBypassDetector.cpp
9899

99-
ENABLE_PLUGINS
100-
101100
DEPENDS
102101
${codegen_deps}
103102

‎llvm/cmake/modules/AddLLVM.cmake‎

Lines changed: 60 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ endfunction(set_windows_version_resource_properties)
409409
# )
410410
function(llvm_add_library name)
411411
cmake_parse_arguments(ARG
412-
"MODULE;SHARED;STATIC;OBJECT;DISABLE_LLVM_LINK_LLVM_DYLIB;SONAME;NO_INSTALL_RPATH;COMPONENT_LIB;ENABLE_PLUGINS"
412+
"MODULE;SHARED;STATIC;OBJECT;DISABLE_LLVM_LINK_LLVM_DYLIB;SONAME;NO_INSTALL_RPATH;COMPONENT_LIB"
413413
"OUTPUT_NAME;PLUGIN_TOOL;ENTITLEMENTS;BUNDLE_PATH"
414414
"ADDITIONAL_HEADERS;DEPENDS;LINK_COMPONENTS;LINK_LIBS;OBJLIBS"
415415
${ARGN})
@@ -423,9 +423,6 @@ function(llvm_add_library name)
423423
else()
424424
llvm_process_sources(ALL_FILES ${ARG_UNPARSED_ARGUMENTS} ${ARG_ADDITIONAL_HEADERS})
425425
endif()
426-
if(ARG_ENABLE_PLUGINS)
427-
set_property(GLOBAL APPEND PROPERTY LLVM_PLUGIN_TARGETS ${name})
428-
endif()
429426

430427
if(ARG_MODULE)
431428
if(ARG_SHARED OR ARG_STATIC)
@@ -758,7 +755,7 @@ endmacro(add_llvm_library name)
758755

759756
macro(add_llvm_executable name)
760757
cmake_parse_arguments(ARG
761-
"DISABLE_LLVM_LINK_LLVM_DYLIB;IGNORE_EXTERNALIZE_DEBUGINFO;NO_INSTALL_RPATH;SUPPORT_PLUGINS;ENABLE_PLUGINS"
758+
"DISABLE_LLVM_LINK_LLVM_DYLIB;IGNORE_EXTERNALIZE_DEBUGINFO;NO_INSTALL_RPATH;SUPPORT_PLUGINS"
762759
"ENTITLEMENTS;BUNDLE_PATH"
763760
"DEPENDS"
764761
${ARGN})
@@ -845,9 +842,6 @@ macro(add_llvm_executable name)
845842
# API for all shared libaries loaded by this executable.
846843
target_link_libraries(${name} PRIVATE ${LLVM_PTHREAD_LIB})
847844
endif()
848-
if(ARG_ENABLE_PLUGINS)
849-
set_property(GLOBAL APPEND PROPERTY LLVM_PLUGIN_TARGETS ${name})
850-
endif()
851845

852846
llvm_codesign(${name} ENTITLEMENTS ${ARG_ENTITLEMENTS} BUNDLE_PATH ${ARG_BUNDLE_PATH})
853847
endmacro(add_llvm_executable name)
@@ -920,18 +914,18 @@ function(process_llvm_pass_plugins)
920914
include(LLVMConfigExtensions)
921915
endif()
922916

923-
# Add static plugins to each plugin target.
917+
# Add static plugins to the Extension component
924918
foreach(llvm_extension ${LLVM_STATIC_EXTENSIONS})
925-
get_property(llvm_plugin_targets GLOBAL PROPERTY LLVM_PLUGIN_TARGETS)
926-
foreach(llvm_plugin_target ${llvm_plugin_targets})
927-
set_property(TARGET ${llvm_plugin_target} APPEND PROPERTY LINK_LIBRARIES ${llvm_extension})
928-
set_property(TARGET ${llvm_plugin_target} APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${llvm_extension})
929-
endforeach()
919+
set_property(TARGET LLVMExtensions APPEND PROPERTY LINK_LIBRARIES ${llvm_extension})
920+
set_property(TARGET LLVMExtensions APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${llvm_extension})
930921
endforeach()
931922

932-
# Eventually generate the extension header, and store config to a cmake file
923+
# Eventually generate the extension headers, and store config to a cmake file
933924
# for usage in third-party configuration.
934925
if(ARG_GEN_CONFIG)
926+
927+
## Part 1: Extension header to be included whenever we need extension
928+
# processing.
935929
set(LLVM_INSTALL_PACKAGE_DIR lib${LLVM_LIBDIR_SUFFIX}/cmake/llvm)
936930
set(llvm_cmake_builddir "${LLVM_BINARY_DIR}/${LLVM_INSTALL_PACKAGE_DIR}")
937931
file(WRITE
@@ -954,6 +948,57 @@ function(process_llvm_pass_plugins)
954948
"${ExtensionDef}.tmp"
955949
"${ExtensionDef}")
956950
file(REMOVE "${ExtensionDef}.tmp")
951+
952+
## Part 2: Extension header that captures each extension dependency, to be
953+
# used by llvm-config.
954+
set(ExtensionDeps "${LLVM_BINARY_DIR}/tools/llvm-config/ExtensionDependencies.inc")
955+
956+
# Max needed to correctly size the required library array.
957+
set(llvm_plugin_max_deps_length 0)
958+
foreach(llvm_extension ${LLVM_STATIC_EXTENSIONS})
959+
get_property(llvm_plugin_deps TARGET ${llvm_extension} PROPERTY LINK_LIBRARIES)
960+
list(LENGTH llvm_plugin_deps llvm_plugin_deps_length)
961+
if(llvm_plugin_deps_length GREATER llvm_plugin_max_deps_length)
962+
set(llvm_plugin_max_deps_length ${llvm_plugin_deps_length})
963+
endif()
964+
endforeach()
965+
966+
list(LENGTH LLVM_STATIC_EXTENSIONS llvm_static_extension_count)
967+
file(WRITE
968+
"${ExtensionDeps}.tmp"
969+
"#include <array>\n\
970+
struct ExtensionDescriptor {\n\
971+
const char* Name;\n\
972+
const char* const RequiredLibraries[1 + 1 + ${llvm_plugin_max_deps_length}];\n\
973+
};\n\
974+
std::array<ExtensionDescriptor, ${llvm_static_extension_count}> AvailableExtensions{\n")
975+
976+
foreach(llvm_extension ${LLVM_STATIC_EXTENSIONS})
977+
get_property(llvm_plugin_deps TARGET ${llvm_extension} PROPERTY LINK_LIBRARIES)
978+
979+
file(APPEND "${ExtensionDeps}.tmp" "{\"${llvm_extension}\", {")
980+
foreach(llvm_plugin_dep ${llvm_plugin_deps})
981+
# Turn library dependency back to component name, if possible.
982+
# That way llvm-config can avoid redundant dependencies.
983+
STRING(REGEX REPLACE "^-l" "" plugin_dep_name ${llvm_plugin_dep})
984+
STRING(REGEX MATCH "^LLVM" is_llvm_library ${plugin_dep_name})
985+
if(is_llvm_library)
986+
STRING(REGEX REPLACE "^LLVM" "" plugin_dep_name ${plugin_dep_name})
987+
STRING(TOLOWER ${plugin_dep_name} plugin_dep_name)
988+
endif()
989+
file(APPEND "${ExtensionDeps}.tmp" "\"${plugin_dep_name}\", ")
990+
endforeach()
991+
992+
# Self + mandatory trailing null, because the number of RequiredLibraries differs between extensions.
993+
file(APPEND "${ExtensionDeps}.tmp" \"${llvm_extension}\", "nullptr}},\n")
994+
endforeach()
995+
file(APPEND "${ExtensionDeps}.tmp" "};\n")
996+
997+
# only replace if there's an actual change
998+
execute_process(COMMAND ${CMAKE_COMMAND} -E copy_if_different
999+
"${ExtensionDeps}.tmp"
1000+
"${ExtensionDeps}")
1001+
file(REMOVE "${ExtensionDeps}.tmp")
9571002
endif()
9581003
endfunction()
9591004

‎llvm/lib/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ add_subdirectory(BinaryFormat)
99
add_subdirectory(Bitcode)
1010
add_subdirectory(Bitstream)
1111
add_subdirectory(DWARFLinker)
12+
add_subdirectory(Extensions)
1213
add_subdirectory(Frontend)
1314
add_subdirectory(Transforms)
1415
add_subdirectory(Linker)

‎llvm/lib/Extensions/CMakeLists.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
add_llvm_component_library(LLVMExtensions
2+
Extensions.cpp
3+
)

‎llvm/lib/Extensions/Extensions.cpp‎

Whitespace-only changes.

‎llvm/lib/Extensions/LLVMBuild.txt‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
;===- ./lib/Extensions/LLVMBuild.txt -------------------------------*- Conf -*--===;
2+
;
3+
; Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4+
; See https://llvm.org/LICENSE.txt for license information.
5+
; SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6+
;
7+
;===------------------------------------------------------------------------===;
8+
;
9+
; This is an LLVMBuild description file for the components in this subdirectory.
10+
;
11+
; For more information on the LLVMBuild system, please see:
12+
;
13+
; http://llvm.org/docs/LLVMBuild.html
14+
;
15+
;===------------------------------------------------------------------------===;
16+
17+
[component_0]
18+
type = Library
19+
name = Extensions
20+
parent = Libraries
21+
required_libraries =

‎llvm/lib/LLVMBuild.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ subdirectories =
2525
Demangle
2626
DWARFLinker
2727
ExecutionEngine
28+
Extensions
2829
Frontend
2930
FuzzMutate
3031
LineEditor

‎llvm/lib/LTO/CMakeLists.txt‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ add_llvm_component_library(LLVMLTO
1010

1111
ADDITIONAL_HEADER_DIRS
1212
${LLVM_MAIN_INCLUDE_DIR}/llvm/LTO
13-
14-
ENABLE_PLUGINS
15-
1613
DEPENDS
1714
intrinsics_gen
1815
llvm_vcsrevision_h

‎llvm/lib/LTO/LLVMBuild.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ required_libraries =
2626
BitWriter
2727
CodeGen
2828
Core
29+
Extensions
2930
IPO
3031
InstCombine
3132
Linker

‎llvm/tools/bugpoint/CMakeLists.txt‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ set(LLVM_LINK_COMPONENTS
66
Analysis
77
BitWriter
88
CodeGen
9+
Extensions
910
Core
1011
IPO
1112
IRReader
@@ -32,8 +33,6 @@ add_llvm_tool(bugpoint
3233
ToolRunner.cpp
3334
bugpoint.cpp
3435

35-
ENABLE_PLUGINS
36-
3736
DEPENDS
3837
intrinsics_gen
3938
SUPPORT_PLUGINS

0 commit comments

Comments
 (0)