serge-sans-paille updated this revision to Diff 202795.
serge-sans-paille added a comment.
Herald added a project: clang.
Herald added a subscriber: cfe-commits.
- provide minimal documentation
- fix testing configuration
- validate locally with both shared and static libraries, using monorepo or
tool layout
- update sample https://sergesanspaille.fedorapeople.org/bye.tgz
@Meinersbur thanks a lot for the previous review! lld integration, as well as
new PM integration, will be for another commit, in order to prevent this review
from growing too large
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D61446/new/
https://reviews.llvm.org/D61446
Files:
clang/tools/driver/CMakeLists.txt
clang/tools/driver/cc1_main.cpp
llvm/CMakeLists.txt
llvm/cmake/modules/AddLLVM.cmake
llvm/docs/WritingAnLLVMPass.rst
llvm/include/llvm/Config/llvm-config.h.cmake
llvm/tools/CMakeLists.txt
llvm/tools/bugpoint/CMakeLists.txt
llvm/tools/bugpoint/bugpoint.cpp
llvm/tools/opt/CMakeLists.txt
llvm/tools/opt/NewPMDriver.cpp
llvm/tools/opt/opt.cpp
llvm/utils/gn/secondary/llvm/include/llvm/Config/BUILD.gn
polly/CMakeLists.txt
Index: polly/CMakeLists.txt
===================================================================
--- polly/CMakeLists.txt
+++ polly/CMakeLists.txt
@@ -208,3 +208,7 @@
add_custom_target(polly-update-format DEPENDS ${update_format_depends})
set_target_properties(polly-update-format PROPERTIES FOLDER "Polly")
+register_llvm_extension(polly)
+
+# Polly-ACC requires the NVPTX target to be present in the executable it is linked to
+set_property(TARGET bugpoint APPEND PROPERTY LLVM_COMPILER_EXTENSIONS LLVMTarget)
Index: llvm/utils/gn/secondary/llvm/include/llvm/Config/BUILD.gn
===================================================================
--- llvm/utils/gn/secondary/llvm/include/llvm/Config/BUILD.gn
+++ llvm/utils/gn/secondary/llvm/include/llvm/Config/BUILD.gn
@@ -321,7 +321,6 @@
output = "$target_gen_dir/llvm-config.h"
values = [
"LLVM_ENABLE_DUMP=",
- "LINK_POLLY_INTO_TOOLS=",
"LLVM_DEFAULT_TARGET_TRIPLE=$llvm_target_triple",
"LLVM_HAS_ATOMICS=1",
"LLVM_HOST_TRIPLE=$llvm_current_triple",
Index: llvm/tools/opt/opt.cpp
===================================================================
--- llvm/tools/opt/opt.cpp
+++ llvm/tools/opt/opt.cpp
@@ -470,11 +470,11 @@
getCodeModel(), GetCodeGenOptLevel());
}
-#ifdef LINK_POLLY_INTO_TOOLS
-namespace polly {
-void initializePollyPasses(llvm::PassRegistry &Registry);
-}
-#endif
+#define HANDLE_EXTENSION(Ns, Ext) \
+ namespace Ns { \
+ void initialize##Ext##Passes(llvm::PassRegistry &Registry); \
+ }
+#include "llvm/Support/Extension.def"
//===----------------------------------------------------------------------===//
// main for opt
@@ -529,9 +529,8 @@
initializeWasmEHPreparePass(Registry);
initializeWriteBitcodePassPass(Registry);
-#ifdef LINK_POLLY_INTO_TOOLS
- polly::initializePollyPasses(Registry);
-#endif
+#define HANDLE_EXTENSION(Ns, Ext) Ns::initialize##Ext##Passes(Registry);
+#include "llvm/Support/Extension.def"
cl::ParseCommandLineOptions(argc, argv,
"llvm .bc -> .bc modular optimizer and analysis printer\n");
Index: llvm/tools/opt/NewPMDriver.cpp
===================================================================
--- llvm/tools/opt/NewPMDriver.cpp
+++ llvm/tools/opt/NewPMDriver.cpp
@@ -202,11 +202,11 @@
});
}
-#ifdef LINK_POLLY_INTO_TOOLS
-namespace polly {
-void RegisterPollyPasses(PassBuilder &);
-}
-#endif
+#define HANDLE_EXTENSION(Ns, Ext) \
+ namespace Ns { \
+ void Register##Ext##Passes(PassBuilder &); \
+ }
+#include "llvm/Support/Extension.def"
bool llvm::runPassPipeline(StringRef Arg0, Module &M, TargetMachine *TM,
ToolOutputFile *Out, ToolOutputFile *ThinLTOLinkOut,
@@ -290,9 +290,8 @@
return false;
});
-#ifdef LINK_POLLY_INTO_TOOLS
- polly::RegisterPollyPasses(PB);
-#endif
+#define HANDLE_EXTENSION(Ns, Ext) Ns::Register##Ext##Passes(PB);
+#include "llvm/Support/Extension.def"
// Specially handle the alias analysis manager so that we can register
// a custom pipeline of AA passes with it.
Index: llvm/tools/opt/CMakeLists.txt
===================================================================
--- llvm/tools/opt/CMakeLists.txt
+++ llvm/tools/opt/CMakeLists.txt
@@ -37,7 +37,4 @@
intrinsics_gen
)
export_executable_symbols(opt)
-
-if(WITH_POLLY AND LINK_POLLY_INTO_TOOLS)
- target_link_libraries(opt PRIVATE Polly)
-endif(WITH_POLLY AND LINK_POLLY_INTO_TOOLS)
+target_link_libraries(opt PRIVATE $<TARGET_PROPERTY:LLVM_COMPILER_EXTENSIONS>)
Index: llvm/tools/bugpoint/bugpoint.cpp
===================================================================
--- llvm/tools/bugpoint/bugpoint.cpp
+++ llvm/tools/bugpoint/bugpoint.cpp
@@ -109,11 +109,11 @@
};
}
-#ifdef LINK_POLLY_INTO_TOOLS
-namespace polly {
-void initializePollyPasses(llvm::PassRegistry &Registry);
-}
-#endif
+#define HANDLE_EXTENSION(Ns, Ext) \
+ namespace Ns { \
+ void initialize##Ext##Passes(llvm::PassRegistry &Registry); \
+ }
+#include "llvm/Support/Extension.def"
int main(int argc, char **argv) {
#ifndef DEBUG_BUGPOINT
@@ -134,9 +134,8 @@
initializeInstrumentation(Registry);
initializeTarget(Registry);
-#ifdef LINK_POLLY_INTO_TOOLS
- polly::initializePollyPasses(Registry);
-#endif
+#define HANDLE_EXTENSION(Ns, Ext) Ns::initialize##Ext##Passes(Registry);
+#include "llvm/Support/Extension.def"
if (std::getenv("bar") == (char*) -1) {
InitializeAllTargets();
Index: llvm/tools/bugpoint/CMakeLists.txt
===================================================================
--- llvm/tools/bugpoint/CMakeLists.txt
+++ llvm/tools/bugpoint/CMakeLists.txt
@@ -36,9 +36,4 @@
intrinsics_gen
)
export_executable_symbols(bugpoint)
-
-if(WITH_POLLY AND LINK_POLLY_INTO_TOOLS)
- target_link_libraries(bugpoint PRIVATE Polly)
- # Ensure LLVMTarget can resolve dependences in Polly.
- target_link_libraries(bugpoint PRIVATE LLVMTarget)
-endif(WITH_POLLY AND LINK_POLLY_INTO_TOOLS)
+target_link_libraries(bugpoint PRIVATE $<TARGET_PROPERTY:LLVM_COMPILER_EXTENSIONS>)
Index: llvm/tools/CMakeLists.txt
===================================================================
--- llvm/tools/CMakeLists.txt
+++ llvm/tools/CMakeLists.txt
@@ -9,14 +9,6 @@
# traversing each directory.
create_llvm_tool_options()
-# Build polly before the tools: the tools link against polly when
-# LINK_POLLY_INTO_TOOLS is set.
-if(WITH_POLLY)
- add_llvm_external_project(polly)
-else()
- set(LLVM_TOOL_POLLY_BUILD Off)
-endif()
-
if(NOT LLVM_BUILD_LLVM_DYLIB AND NOT LLVM_BUILD_LLVM_C_DYLIB)
set(LLVM_TOOL_LLVM_SHLIB_BUILD Off)
endif()
@@ -46,6 +38,11 @@
add_llvm_external_project(lld)
add_llvm_external_project(lldb)
+# projects sensible to extension property (namely clang, opt and bugpoint)
+# must be declared before extensions
+add_llvm_external_project(opt)
+add_llvm_external_project(bugpoint)
+
# Automatically add remaining sub-directories containing a 'CMakeLists.txt'
# file as external projects.
add_llvm_implicit_projects()
Index: llvm/include/llvm/Config/llvm-config.h.cmake
===================================================================
--- llvm/include/llvm/Config/llvm-config.h.cmake
+++ llvm/include/llvm/Config/llvm-config.h.cmake
@@ -17,9 +17,6 @@
/* Define if LLVM_ENABLE_DUMP is enabled */
#cmakedefine LLVM_ENABLE_DUMP
-/* Define if we link Polly to the tools */
-#cmakedefine LINK_POLLY_INTO_TOOLS
-
/* Target triple LLVM will generate code for by default */
#cmakedefine LLVM_DEFAULT_TARGET_TRIPLE "${LLVM_DEFAULT_TARGET_TRIPLE}"
Index: llvm/docs/WritingAnLLVMPass.rst
===================================================================
--- llvm/docs/WritingAnLLVMPass.rst
+++ llvm/docs/WritingAnLLVMPass.rst
@@ -1219,6 +1219,32 @@
this internal state. This method is called after the ``run*`` method for the
class, before the next call of ``run*`` in your pass.
+Building out-of-tree passes
+===========================
+
+LLVM provides a mechanism to automatically register compiler passes for ``clang``,
+``opt`` and ``bugpoint``. One first needs to create an independant project and add
+it to either ``tools/`` or, using the MonoRepo layout, at the root of the repo alongside
+other projects. This project must contain the following minimal ``CMakeLists.txt``:
+
+.. code-block:: cmake
+
+ add_llvm_library(Name
+ source0.cpp)
+ register_llvm_extension(Name)
+
+The project should define the following functions to perform the appropriate pass initialization/registration:
+
+- ``void initialize${Name}Passes(llvm::PassRegistry &Registry)`` that calls the initializer of dependant passes/analyse;
+- ``void register${Name}Passes(llvm::legacy::PassManagerBase &PM)`` that registers all the extension passes to ``opt``, legacy PM;
+- ``void Register${Name}Passes(llvm::PassBuilder &PB)`` that registers all the extension passes to ``opt``, new PM.
+
+Out-of-tree passes are compiled and link statically by default, but it's possible to set the following variables to change this behavior:
+
+- ``LINK_${NAME}_INTO_TOOLS``, when sets to ``OFF``, turns the project into a dynamically loaded extension.
+- ``LLVM_${NAME}_BUILD``, when sets to ``OFF`` deactivate the extension.
+
+
Registering dynamically loaded passes
=====================================
Index: llvm/cmake/modules/AddLLVM.cmake
===================================================================
--- llvm/cmake/modules/AddLLVM.cmake
+++ llvm/cmake/modules/AddLLVM.cmake
@@ -790,6 +790,42 @@
llvm_codesign(${name} ENTITLEMENTS ${ARG_ENTITLEMENTS})
endmacro(add_llvm_executable name)
+# register_llvm_extension(name)
+# Register ${name} as an llvm compiler extension.
+# A compiler extension must define three functions in namespace ${name}
+# - void initialize${Name}Passes(llvm::PassRegistry &Registry) that calls the initializer of dependant passes/ analyse
+# - void register${Name}Passes(llvm::legacy::PassManagerBase &PM) that registers all the extension passes to `opt`, legacy PM
+# - void Register${Name}Passes(llvm::PassBuilder &PB) that registers all the extension passes to `opt`, new PM
+
+function(register_llvm_extension llvm_extension)
+ string(TOLOWER ${llvm_extension} llvm_extension_namespace)
+
+ string(TOUPPER ${llvm_extension} llvm_extension_upper)
+ string(SUBSTRING ${llvm_extension_upper} 0 1 llvm_extension_upper_first)
+ string(SUBSTRING ${llvm_extension_namespace} 1 -1 llvm_extension_lower_tail)
+ string(CONCAT llvm_extension_project ${llvm_extension_upper_first} ${llvm_extension_lower_tail})
+
+ option(LINK_${llvm_extension_upper}_INTO_TOOLS "Statically link ${llvm_extension_project} into tools (if available)" ON)
+ option(LLVM_${llvm_extension_upper}_BUILD "Build LLVM with ${llvm_extension_project}" ON)
+
+ if(LLVM_${llvm_extension_upper}_BUILD)
+ message(STATUS "Registering ${llvm_extension_project} as a compiler extension (static build: ${LINK_${llvm_extension_upper}_INTO_TOOLS})")
+ if(LINK_${llvm_extension_upper}_INTO_TOOLS)
+ set_property(GLOBAL APPEND PROPERTY LLVM_EXTENSIONS ${name})
+
+ set(LLVM_ALL_EXTENSION_TARGETS clang;bugpoint;opt)
+ foreach(tool ${LLVM_ALL_EXTENSION_TARGETS})
+ if(TARGET ${tool})
+ set_property(TARGET ${tool} APPEND PROPERTY LLVM_COMPILER_EXTENSIONS ${llvm_extension_project})
+ endif()
+ endforeach()
+ endif()
+ else()
+ message(STATUS "Skipping compiler extension ${llvm_extension_project}")
+ endif()
+endfunction(register_llvm_extension)
+
+
function(export_executable_symbols target)
if (LLVM_EXPORTED_SYMBOL_FILE)
# The symbol file should contain the symbols we want the executable to
Index: llvm/CMakeLists.txt
===================================================================
--- llvm/CMakeLists.txt
+++ llvm/CMakeLists.txt
@@ -494,29 +494,6 @@
option(LLVM_USE_SPLIT_DWARF
"Use -gsplit-dwarf when compiling llvm." OFF)
-option(LLVM_POLLY_LINK_INTO_TOOLS "Statically link Polly into tools (if available)" ON)
-option(LLVM_POLLY_BUILD "Build LLVM with Polly" ON)
-
-if (EXISTS ${LLVM_MAIN_SRC_DIR}/tools/polly/CMakeLists.txt)
- set(POLLY_IN_TREE TRUE)
-elseif(LLVM_EXTERNAL_POLLY_SOURCE_DIR)
- set(POLLY_IN_TREE TRUE)
-else()
- set(POLLY_IN_TREE FALSE)
-endif()
-
-if (LLVM_POLLY_BUILD AND POLLY_IN_TREE)
- set(WITH_POLLY ON)
-else()
- set(WITH_POLLY OFF)
-endif()
-
-if (LLVM_POLLY_LINK_INTO_TOOLS AND WITH_POLLY)
- set(LINK_POLLY_INTO_TOOLS ON)
-else()
- set(LINK_POLLY_INTO_TOOLS OFF)
-endif()
-
# Define an option controlling whether we should build for 32-bit on 64-bit
# platforms, where supported.
if( CMAKE_SIZEOF_VOID_P EQUAL 8 AND NOT WIN32 )
@@ -1143,3 +1120,29 @@
add_subdirectory(utils/benchmark)
add_subdirectory(benchmarks)
endif()
+
+# generate X Macro file for extension handling. It provides a
+# HANDLE_EXTENSION(extension_namespace, ExtensionProject) call for each extension
+# allowing client code to define HANDLE_EXTENSION to have a specific code be run for
+# each extension.
+get_property(LLVM_EXTENSIONS GLOBAL PROPERTY LLVM_EXTENSIONS)
+file(WRITE "${CMAKE_BINARY_DIR}/include/llvm/Support/Extension.def.tmp" "//extension handlers\n")
+foreach(llvm_extension ${LLVM_EXTENSIONS})
+ string(TOLOWER ${llvm_extension} llvm_extension_namespace)
+
+ string(TOUPPER ${llvm_extension} llvm_extension_upper)
+ string(SUBSTRING ${llvm_extension_upper} 0 1 llvm_extension_upper_first)
+ string(SUBSTRING ${llvm_extension_namespace} 1 -1 llvm_extension_lower_tail)
+ string(CONCAT llvm_extension_project ${llvm_extension_upper_first} ${llvm_extension_lower_tail})
+
+ if(LINK_${llvm_extension_upper}_INTO_TOOLS)
+ file(APPEND "${CMAKE_BINARY_DIR}/include/llvm/Support/Extension.def.tmp" "HANDLE_EXTENSION(${llvm_extension_namespace}, ${llvm_extension_project})\n")
+ endif()
+endforeach()
+file(APPEND "${CMAKE_BINARY_DIR}/include/llvm/Support/Extension.def.tmp" "#undef HANDLE_EXTENSION\n")
+
+# only replace if there's an actual change
+execute_process(COMMAND ${CMAKE_COMMAND} -E copy_if_different "${CMAKE_BINARY_DIR}/include/llvm/Support/Extension.def.tmp" "${CMAKE_BINARY_DIR}/include/llvm/Support/Extension.def")
+file(REMOVE "${CMAKE_BINARY_DIR}/include/llvm/Support/Extension.def.tmp")
+
+
Index: clang/tools/driver/cc1_main.cpp
===================================================================
--- clang/tools/driver/cc1_main.cpp
+++ clang/tools/driver/cc1_main.cpp
@@ -69,11 +69,11 @@
exit(GenCrashDiag ? 70 : 1);
}
-#ifdef LINK_POLLY_INTO_TOOLS
-namespace polly {
-void initializePollyPasses(llvm::PassRegistry &Registry);
-}
-#endif
+#define HANDLE_EXTENSION(Ns, Ext) \
+ namespace Ns { \
+ void initialize##Ext##Passes(llvm::PassRegistry &Registry); \
+ }
+#include "llvm/Support/Extension.def"
#ifdef CLANG_HAVE_RLIMITS
#if defined(__linux__) && defined(__PIE__)
@@ -183,10 +183,12 @@
llvm::InitializeAllAsmPrinters();
llvm::InitializeAllAsmParsers();
-#ifdef LINK_POLLY_INTO_TOOLS
- llvm::PassRegistry &Registry = *llvm::PassRegistry::getPassRegistry();
- polly::initializePollyPasses(Registry);
-#endif
+#define HANDLE_EXTENSION(Ns, Ext) \
+ { \
+ llvm::PassRegistry &Registry = *llvm::PassRegistry::getPassRegistry(); \
+ Ns::initialize##Ext##Passes(Registry); \
+ }
+#include "llvm/Support/Extension.def"
// Buffer diagnostics from argument parsing so that we can output them using a
// well formed diagnostic object.
Index: clang/tools/driver/CMakeLists.txt
===================================================================
--- clang/tools/driver/CMakeLists.txt
+++ clang/tools/driver/CMakeLists.txt
@@ -123,6 +123,4 @@
endif()
endif()
-if(WITH_POLLY AND LINK_POLLY_INTO_TOOLS)
- target_link_libraries(clang PRIVATE Polly)
-endif(WITH_POLLY AND LINK_POLLY_INTO_TOOLS)
+target_link_libraries(clang PRIVATE $<TARGET_PROPERTY:LLVM_COMPILER_EXTENSIONS>)
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
