replace clang LLVM_ENABLE_PLUGINS -> CLANG_PLUGIN_SUPPORT in tests

[vtjnash]

Summary

Fixes a build issue noted in D111100. Backport requested to 14.x once this lands.

[mgorny]

LLVMHello part LGTM. Dunno about the other part.

[cristian.adam]

This patch is having problems on Windows with MSVC 2019 and -D LLVM_EXPORT_SYMBOLS_FOR_PLUGINS=ON and -D "LLVM_ENABLE_PROJECTS=clang;clang-tools-extra".

CMake doesn't configure the project.

-- Clang version: 14.0.0
-- SampleAnalyzerPlugin ignored -- Loadable modules not supported on this platform.
CMake Error at C:/Projects/llvm-project/repo/clang/cmake/modules/AddClang.cmake:185 (target_link_libraries):
  Utility target "SampleAnalyzerPlugin" must not be used as the target of a
  target_link_libraries call.
Call Stack (most recent call first):
  C:/Projects/llvm-project/repo/clang/lib/Analysis/plugins/SampleAnalyzer/CMakeLists.txt:8 (clang_target_link_libraries)


-- CheckerDependencyHandlingAnalyzerPlugin ignored -- Loadable modules not supported on this platform.
CMake Error at C:/Projects/llvm-project/repo/clang/cmake/modules/AddClang.cmake:185 (target_link_libraries):
  Utility target "CheckerDependencyHandlingAnalyzerPlugin" must not be used
  as the target of a target_link_libraries call.
Call Stack (most recent call first):
  C:/Projects/llvm-project/repo/clang/lib/Analysis/plugins/CheckerDependencyHandling/CMakeLists.txt:8 (clang_target_link_libraries)


-- CheckerOptionHandlingAnalyzerPlugin ignored -- Loadable modules not supported on this platform.
CMake Error at C:/Projects/llvm-project/repo/clang/cmake/modules/AddClang.cmake:185 (target_link_libraries):
  Utility target "CheckerOptionHandlingAnalyzerPlugin" must not be used as
  the target of a target_link_libraries call.
Call Stack (most recent call first):
  C:/Projects/llvm-project/repo/clang/lib/Analysis/plugins/CheckerOptionHandling/CMakeLists.txt:8 (clang_target_link_libraries)

[vtjnash]

ensure CLANG_PLUGIN_SUPPORT setting is compatible with llvm_add_library

[vtjnash]

@cristian.adam Is this good now? You are blocking merging this, but I think it is ready to land, and I would like to not hold it up for other people if it is fixing their issues (and the issues you discovered too)

[cristian.adam]

In D119199#3309117, @vtjnash wrote:

@cristian.adam Is this good now? You are blocking merging this, but I think it is ready to land, and I would like to not hold it up for other people if it is fixing their issues (and the issues you discovered too)

I did a rebase on release/14.x, applied this commit and, got the same error:

-- SampleAnalyzerPlugin ignored -- Loadable modules not supported on this platform.
CMake Error at C:/Projects/llvm-project/repo/clang/cmake/modules/AddClang.cmake:185 (target_link_libraries):
  Utility target "SampleAnalyzerPlugin" must not be used as the target of a
  target_link_libraries call.
Call Stack (most recent call first):
  C:/Projects/llvm-project/repo/clang/lib/Analysis/plugins/SampleAnalyzer/CMakeLists.txt:8 (clang_target_link_libraries)


-- CheckerDependencyHandlingAnalyzerPlugin ignored -- Loadable modules not supported on this platform.
CMake Error at C:/Projects/llvm-project/repo/clang/cmake/modules/AddClang.cmake:185 (target_link_libraries):
  Utility target "CheckerDependencyHandlingAnalyzerPlugin" must not be used
  as the target of a target_link_libraries call.
Call Stack (most recent call first):
  C:/Projects/llvm-project/repo/clang/lib/Analysis/plugins/CheckerDependencyHandling/CMakeLists.txt:8 (clang_target_link_libraries)


-- CheckerOptionHandlingAnalyzerPlugin ignored -- Loadable modules not supported on this platform.
CMake Error at C:/Projects/llvm-project/repo/clang/cmake/modules/AddClang.cmake:185 (target_link_libraries):
  Utility target "CheckerOptionHandlingAnalyzerPlugin" must not be used as
  the target of a target_link_libraries call.
Call Stack (most recent call first):
  C:/Projects/llvm-project/repo/clang/lib/Analysis/plugins/CheckerOptionHandling/CMakeLists.txt:8 (clang_target_link_libraries)

I'll be away for a week, so I won't be blocking anybody now. I'll have to deal with building LLVM/Clang 14 when I come back.

[vtjnash]

Thanks, if you encounter more issues next week, let me know, and I will continue trying to adjust it to work for all config option combinations.

[simon_tatham]

Hi. This commit seems to have broken the following cmake command, on Windows (with HEAD pointing at 76cad51ba700233d6e3492eddcbb466b6adbc2eb):

cmake -DLLVM_ENABLE_PROJECTS=clang -DLLVM_EXPORT_SYMBOLS_FOR_PLUGINS=ON ..\llvm-project\llvm

The symptom is the same as @cristian.adam shows above:

-- SampleAnalyzerPlugin ignored -- Loadable modules not supported on this platform.
CMake Error at [...]/llvm-project/clang/cmake/modules/AddClang.cmake:185 (target_link_libraries):
  Utility target "SampleAnalyzerPlugin" must not be used as the target of a
  target_link_libraries call.
Call Stack (most recent call first):
  [...]/llvm-project/clang/lib/Analysis/plugins/SampleAnalyzer/CMakeLists.txt:8 (clang_target_link_libraries)

With HEAD pointing at the previous commit, clang/lib/Analysis/plugins/CMakeLists.txt does not add the SampleAnalyzer subdirectory at all, because LLVM_ENABLE_PLUGINS has the value OFF. But CLANG_PLUGIN_SUPPORT is ON, so now it does, and the above error happens.

If I try to work around this by setting CLANG_PLUGIN_SUPPORT to OFF as well ...

cmake -DLLVM_ENABLE_PROJECTS=clang -DLLVM_EXPORT_SYMBOLS_FOR_PLUGINS=ON -DCLANG_PLUGIN_SUPPORT=OFF ..\llvm-project\llvm

... then this error happens instead:

CMake Error at cmake/modules/AddLLVM.cmake:676 (target_link_libraries):
  Target "clang" of type EXECUTABLE may not be linked into another target.
  One may link only to INTERFACE, OBJECT, STATIC or SHARED libraries, or to
  executables with the ENABLE_EXPORTS property set.
Call Stack (most recent call first):
  cmake/modules/AddLLVM.cmake:808 (llvm_add_library)
  [...]/llvm-project/clang/examples/PrintFunctionNames/CMakeLists.txt:12 (add_llvm_library)

So, either way, the build fails.

[simon_tatham]

clang/tools/driver/CMakeLists.txt

53

I think we've managed to fix our build by changing this line so that it tests

if(CLANG_PLUGIN_SUPPORT OR LLVM_EXPORT_SYMBOLS_FOR_PLUGINS)

because that fixes the cmake complaint that you can't link against an executable that didn't have ENABLE_EXPORTS.

[cristian.adam]

release/14.x now configures but fails to build on MSVC2019 with -D LLVM_EXPORT_SYMBOLS_FOR_PLUGINS=ON like at https://reviews.llvm.org/D111100

FAILED: bin/CTTestTidyModule.dll
cmd.exe /C "cd . && C:\tools\cmake\bin\cmake.exe -E vs_link_dll --intdir=tools\clang\tools\extra\test\CMakeFiles\CTTestTidyModule.dir --rc=C:\PROGRA~2\WI3CF2~1\10\bin\100183~1.0\x64\rc.exe --mt=C:\PROGRA~2\WI3CF2~1\10\bin\100183~1.0\x64\mt.exe --manifests  -- C:\PROGRA~2\MICROS~1\2019\BUILDT~1\VC\Tools\MSVC\1429~1.301\bin\Hostx64\x64\link.exe /nologo tools\clang\tools\extra\test\CMakeFiles\CTTestTidyModule.dir\clang-tidy\CTTestTidyModule.cpp.obj  /out:bin\CTTestTidyModule.dll /implib:lib\CTTestTidyModule.lib /pdb:bin\CTTestTidyModule.pdb /dll /version:0.0 /machine:x64 /INCREMENTAL:NO  lib\clang-tidy.lib  kernel32.lib user32.lib gdi32.lib winspool.lib shell32.lib ole32.lib oleaut32.lib uuid.lib comdlg32.lib advapi32.lib  && cd ."
LINK: command "C:\PROGRA~2\MICROS~1\2019\BUILDT~1\VC\Tools\MSVC\1429~1.301\bin\Hostx64\x64\link.exe /nologo tools\clang\tools\extra\test\CMakeFiles\CTTestTidyModule.dir\clang-tidy\CTTestTidyModule.cpp.obj /out:bin\CTTestTidyModule.dll /implib:lib\CTTestTidyModule.lib /pdb:bin\CTTestTidyModule.pdb /dll /version:0.0 /machine:x64 /INCREMENTAL:NO lib\clang-tidy.lib kernel32.lib user32.lib gdi32.lib winspool.lib shell32.lib ole32.lib oleaut32.lib uuid.lib comdlg32.lib advapi32.lib /MANIFEST /MANIFESTFILE:bin\CTTestTidyModule.dll.manifest" failed (exit code 1120) with the following output:
CTTestTidyModule.cpp.obj : error LNK2001: unresolved external symbol "class clang::ast_matchers::internal::VariadicDynCastAllOfMatcher<class clang::Decl,class clang::TranslationUnitDecl> const clang::ast_matchers::translationUnitDecl" (?translationUnitDecl@ast_matchers@clang@@3V?$VariadicDynCastAllOfMatcher@VDecl@clang@@VTranslationUnitDecl@2@@internal@12@B)
bin\CTTestTidyModule.dll : fatal error LNK1120: 1 unresolved externals

[vtjnash]

Is that a bug in clang or in MSVC2019? We expected that CLANG_PLUGIN_SUPPORT=ON can expose problems with the Windows linker, and we add new tests here for verifying that configuration is functioning as expected. You might need to disable CLANG_PLUGIN_SUPPORT on that target?

[cristian.adam]

In D119199#3337699, @vtjnash wrote:

Is that a bug in clang or in MSVC2019? We expected that CLANG_PLUGIN_SUPPORT=ON can expose problems with the Windows linker, and we add new tests here for verifying that configuration is functioning as expected. You might need to disable CLANG_PLUGIN_SUPPORT on that target?

I don't know. I "fixed" it by commenting out the whole creation of the target, the same way as the LLVM_INSTALL_TOOLCHAIN_ONLY does, which would be the other workaround, to just use LLVM_INSTALL_TOOLCHAIN_ONLY.

diff --git a/clang-tools-extra/test/CMakeLists.txt b/clang-tools-extra/test/CMakeLists.txt
index 170e5f8bd197..e8b897893776 100644
--- a/clang-tools-extra/test/CMakeLists.txt
+++ b/clang-tools-extra/test/CMakeLists.txt
@@ -80,6 +80,7 @@ foreach(dep ${LLVM_UTILS_DEPS})
   endif()
 endforeach()

+#[[
 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
   llvm_add_library(
       CTTestTidyModule
@@ -106,6 +107,7 @@ if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
       endif()
   endif()
 endif()
+#]]

clang-tools-extra/test/CMakeLists.txt

 else ()
   set(LLVM_BUILD_MODE "%(build_mode)s")
 endif ()
 
 string(REPLACE ${CMAKE_CFG_INTDIR} ${LLVM_BUILD_MODE} CLANG_TOOLS_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR})
 
 llvm_canonicalize_cmake_booleans(
   CLANG_TIDY_ENABLE_STATIC_ANALYZER
-  LLVM_ENABLE_PLUGINS
+  CLANG_PLUGIN_SUPPORT
   LLVM_INSTALL_TOOLCHAIN_ONLY
   )
 
 configure_lit_site_cfg(
   ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.py.in
   ${CMAKE_CURRENT_BINARY_DIR}/lit.site.cfg.py
   MAIN_CONFIG
   ${CMAKE_CURRENT_SOURCE_DIR}/lit.cfg.py

 
 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
   llvm_add_library(
       CTTestTidyModule
       MODULE clang-tidy/CTTestTidyModule.cpp
       PLUGIN_TOOL clang-tidy
       DEPENDS clang-tidy-headers)
 
+  if(CLANG_BUILT_STANDALONE)
+    # LLVMHello library is needed below
+    if (EXISTS ${LLVM_MAIN_SRC_DIR}/lib/Transforms/Hello
+       AND NOT TARGET LLVMHello)
+      add_subdirectory(${LLVM_MAIN_SRC_DIR}/lib/Transforms/Hello
+        lib/Transforms/Hello)
+    endif()
+  endif()
+
   if(TARGET CTTestTidyModule)
       list(APPEND CLANG_TOOLS_TEST_DEPS CTTestTidyModule LLVMHello)
       target_include_directories(CTTestTidyModule PUBLIC BEFORE "${CLANG_TOOLS_SOURCE_DIR}")
-      if(LLVM_ENABLE_PLUGINS AND (WIN32 OR CYGWIN))
+      if(CLANG_PLUGIN_SUPPORT AND (WIN32 OR CYGWIN))
         set(LLVM_LINK_COMPONENTS
           Support
         )
       endif()
   endif()
 endif()
 
 add_lit_testsuite(check-clang-tools "Running the Clang extra tools' regression tests"

clang-tools-extra/test/lit.site.cfg.py.in

 @LIT_SITE_CFG_IN_HEADER@
 
 import sys
 
 config.llvm_tools_dir = "@LLVM_TOOLS_DIR@"
 config.llvm_libs_dir = "@LLVM_LIBS_DIR@"
 config.llvm_plugin_ext = "@LLVM_PLUGIN_EXT@"
 config.lit_tools_dir = "@LLVM_LIT_TOOLS_DIR@"
 config.clang_tools_binary_dir = "@CLANG_TOOLS_BINARY_DIR@"
 config.clang_tools_dir = "@CLANG_TOOLS_DIR@"
 config.clang_libs_dir = "@SHLIBDIR@"
 config.python_executable = "@Python3_EXECUTABLE@"
 config.target_triple = "@TARGET_TRIPLE@"
 config.clang_tidy_staticanalyzer = @CLANG_TIDY_ENABLE_STATIC_ANALYZER@
-config.has_plugins = @LLVM_ENABLE_PLUGINS@ & ~@LLVM_INSTALL_TOOLCHAIN_ONLY@
+config.has_plugins = @CLANG_PLUGIN_SUPPORT@ & ~@LLVM_INSTALL_TOOLCHAIN_ONLY@
 
 # Support substitution of the tools and libs dirs with user parameters. This is
 # used when we can't determine the tool dir at configuration time.
 try:
     config.clang_tools_dir = config.clang_tools_dir % lit_config.params
     config.llvm_tools_dir = config.llvm_tools_dir % lit_config.params
     config.llvm_libs_dir = config.llvm_libs_dir % lit_config.params
 except KeyError:

clang/CMakeLists.txt

if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
   endif()
 endif()
 
 add_definitions( -D_GNU_SOURCE )
 
 option(CLANG_BUILD_TOOLS
   "Build the Clang tools. If OFF, just generate build targets." ON)
 
+CMAKE_DEPENDENT_OPTION(CLANG_PLUGIN_SUPPORT
+  "Build clang with plugin support" ON
+  "LLVM_ENABLE_PLUGINS OR LLVM_EXPORT_SYMBOLS_FOR_PLUGINS" OFF)
+
 option(CLANG_ENABLE_ARCMT "Build ARCMT." ON)
 option(CLANG_ENABLE_STATIC_ANALYZER
   "Include static analyzer in clang binary." ON)
 
 option(CLANG_ENABLE_PROTO_FUZZER "Build Clang protobuf fuzzer." OFF)
 
 if(NOT CLANG_ENABLE_STATIC_ANALYZER AND CLANG_ENABLE_ARCMT)
   message(FATAL_ERROR "Cannot disable static analyzer while enabling ARCMT or Z3")

clang/examples/AnnotateFunctions/CMakeLists.txt

 add_llvm_library(AnnotateFunctions MODULE AnnotateFunctions.cpp PLUGIN_TOOL clang)
 
-if(LLVM_ENABLE_PLUGINS AND (WIN32 OR CYGWIN))
+if(CLANG_PLUGIN_SUPPORT AND (WIN32 OR CYGWIN))
   set(LLVM_LINK_COMPONENTS
     Support
   )
   clang_target_link_libraries(AnnotateFunctions PRIVATE
     clangAST
     clangBasic
     clangFrontend
     clangLex
     )
 endif()

clang/examples/Attribute/CMakeLists.txt

 add_llvm_library(Attribute MODULE Attribute.cpp PLUGIN_TOOL clang)
 
-if(LLVM_ENABLE_PLUGINS AND (WIN32 OR CYGWIN))
+if(CLANG_PLUGIN_SUPPORT AND (WIN32 OR CYGWIN))
   target_link_libraries(Attribute PRIVATE
     clangAST
     clangBasic
     clangFrontend
     clangLex
     LLVMSupport
     )
 endif()

clang/examples/CallSuperAttribute/CMakeLists.txt

 add_llvm_library(CallSuperAttr MODULE CallSuperAttrInfo.cpp PLUGIN_TOOL clang)
 
-if(LLVM_ENABLE_PLUGINS AND (WIN32 OR CYGWIN))
+if(CLANG_PLUGIN_SUPPORT AND (WIN32 OR CYGWIN))
   set(LLVM_LINK_COMPONENTS
     Support
   )
   clang_target_link_libraries(CallSuperAttr PRIVATE
     clangAST
     clangBasic
     clangFrontend
     clangLex
     )
 endif()

clang/examples/PluginsOrder/CMakeLists.txt

 add_llvm_library(PluginsOrder MODULE PluginsOrder.cpp PLUGIN_TOOL clang)
 
-if(LLVM_ENABLE_PLUGINS AND (WIN32 OR CYGWIN))
+if(CLANG_PLUGIN_SUPPORT AND (WIN32 OR CYGWIN))
   set(LLVM_LINK_COMPONENTS
     Support
   )
   clang_target_link_libraries(PluginsOrder PRIVATE
     clangAST
     clangFrontend
     )
 endif()

clang/examples/PrintFunctionNames/CMakeLists.txt

 # If we don't need RTTI or EH, there's no reason to export anything
 # from the plugin.
 if( NOT MSVC ) # MSVC mangles symbols differently, and
                # PrintFunctionNames.export contains C++ symbols.
   if( NOT LLVM_REQUIRES_RTTI )
     if( NOT LLVM_REQUIRES_EH )
       set(LLVM_EXPORTED_SYMBOL_FILE ${CMAKE_CURRENT_SOURCE_DIR}/PrintFunctionNames.exports)
     endif()
   endif()
 endif()
 
 add_llvm_library(PrintFunctionNames MODULE PrintFunctionNames.cpp PLUGIN_TOOL clang)
 
-if(LLVM_ENABLE_PLUGINS AND (WIN32 OR CYGWIN))
+if(CLANG_PLUGIN_SUPPORT AND (WIN32 OR CYGWIN))
   set(LLVM_LINK_COMPONENTS
     Support
   )
   clang_target_link_libraries(PrintFunctionNames PRIVATE
     clangAST
     clangBasic
     clangFrontend
     )
 endif()

clang/lib/Analysis/plugins/CMakeLists.txt

-if(CLANG_ENABLE_STATIC_ANALYZER AND LLVM_ENABLE_PLUGINS)
+if(CLANG_ENABLE_STATIC_ANALYZER AND CLANG_PLUGIN_SUPPORT)
   add_subdirectory(SampleAnalyzer)
   add_subdirectory(CheckerDependencyHandling)
   add_subdirectory(CheckerOptionHandling)
 endif()

clang/test/CMakeLists.txt

 # Test runner infrastructure for Clang. This configures the Clang test trees
 # for use by Lit, and delegates to LLVM's lit test handlers.
 
 if (CMAKE_CFG_INTDIR STREQUAL ".")
   set(LLVM_BUILD_MODE ".")
 else ()
   set(LLVM_BUILD_MODE "%(build_mode)s")
 endif ()
 
 string(REPLACE ${CMAKE_CFG_INTDIR} ${LLVM_BUILD_MODE} CLANG_TOOLS_DIR ${LLVM_RUNTIME_OUTPUT_INTDIR})
 
 llvm_canonicalize_cmake_booleans(
   CLANG_BUILD_EXAMPLES
   CLANG_DEFAULT_PIE_ON_LINUX
   CLANG_ENABLE_ARCMT
   CLANG_ENABLE_STATIC_ANALYZER
+  CLANG_PLUGIN_SUPPORT
   CLANG_SPAWN_CC1
   ENABLE_BACKTRACES
   LLVM_ENABLE_NEW_PASS_MANAGER
   LLVM_ENABLE_ZLIB
   LLVM_ENABLE_PER_TARGET_RUNTIME_DIR
-  LLVM_ENABLE_PLUGINS
   LLVM_ENABLE_THREADS
   LLVM_WITH_Z3
   )
 
 configure_lit_site_cfg(
   ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.py.in
   ${CMAKE_CURRENT_BINARY_DIR}/lit.site.cfg.py
   MAIN_CONFIG
list(APPEND CLANG_TEST_DEPS
     )
 
   if(TARGET llvm-lto)
     list(APPEND CLANG_TEST_DEPS llvm-lto)
   endif()
 endif()
 
 if (CLANG_ENABLE_STATIC_ANALYZER)
-  if (LLVM_ENABLE_PLUGINS)
+  if (CLANG_PLUGIN_SUPPORT)
     list(APPEND CLANG_TEST_DEPS
       SampleAnalyzerPlugin
       CheckerDependencyHandlingAnalyzerPlugin
       CheckerOptionHandlingAnalyzerPlugin
       )
   endif()
 endif()
 

clang/test/lit.site.cfg.py.in

 config.clang_examples = @CLANG_BUILD_EXAMPLES@
 config.enable_shared = @ENABLE_SHARED@
 config.enable_backtrace = @ENABLE_BACKTRACES@
 config.enable_experimental_new_pass_manager = @LLVM_ENABLE_NEW_PASS_MANAGER@
 config.enable_threads = @LLVM_ENABLE_THREADS@
 config.host_arch = "@HOST_ARCH@"
 config.python_executable = "@Python3_EXECUTABLE@"
 config.use_z3_solver = lit_config.params.get('USE_Z3_SOLVER', "@USE_Z3_SOLVER@")
-config.has_plugins = @LLVM_ENABLE_PLUGINS@
+config.has_plugins = @CLANG_PLUGIN_SUPPORT@
 config.clang_vendor_uti = "@CLANG_VENDOR_UTI@"
 config.llvm_external_lit = path(r"@LLVM_EXTERNAL_LIT@")
 
 # Support substitution of the tools and libs dirs with user parameters. This is
 # used when we can't determine the tool dir at configuration time.
 try:
     config.clang_tools_dir = config.clang_tools_dir % lit_config.params
     config.llvm_tools_dir = config.llvm_tools_dir % lit_config.params

clang/tools/driver/CMakeLists.txt

set( LLVM_LINK_COMPONENTS
   ObjCARCOpts
   Option
   ScalarOpts
   Support
   TransformUtils
   Vectorize
   )
 
-option(CLANG_PLUGIN_SUPPORT "Build clang with plugin support" ON)
-
 # Support plugins.
 if(CLANG_PLUGIN_SUPPORT)
   set(support_plugins SUPPORT_PLUGINS)
 endif()
 
 add_clang_tool(clang
   driver.cpp
   cc1_main.cpp

 
 if(WIN32 AND NOT CYGWIN)
   # Prevent versioning if the buildhost is targeting for Win32.
 else()
   set_target_properties(clang PROPERTIES VERSION ${CLANG_EXECUTABLE_VERSION})
 endif()
 
 # Support plugins.
 if(CLANG_PLUGIN_SUPPORT)
   export_executable_symbols_for_plugins(clang)
 endif()
 
 add_dependencies(clang clang-resource-headers)
 
 if(NOT CLANG_LINKS_TO_CREATE)
   set(CLANG_LINKS_TO_CREATE clang++ clang-cl clang-cpp)
 endif()