Fix CLANG_ENABLE_STATIC_ANALYZER=OFF building all analyzer source

[arichardson]

Summary

Since https://reviews.llvm.org/D87118, the StaticAnalyzer directory is
added unconditionally. In theory this should not cause the static analyzer
sources to be built unless they are referenced by another target. However,
the clang-cpp target (defined in clang/tools/clang-shlib) uses the
CLANG_STATIC_LIBS global property to determine which libraries need to
be included. To solve this issue, this patch avoids adding libraries to
that property if EXCLUDE_FROM_ALL is set.

In case something like this comes up again: cmake --graphviz=targets.dot
is quite useful to see why a target is included as part of ninja all.

[thakis]

Can you just set CLANG_TIDY_ENABLE_STATIC_ANALYZER=OFF too if you care about this?

[arichardson]

In D109611#2997236, @thakis wrote:

Can you just set CLANG_TIDY_ENABLE_STATIC_ANALYZER=OFF too if you care about this?

That doesn't have any effect on the libraries linked into clang-shlib. I am not building clang-tools-extra, so that does not make any difference.

[thakis]

This breaks the build for us:

Running cmake -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=ON '-DLLVM_ENABLE_PROJECTS=clang;compiler-rt;lld;chrometools;clang-tools-extra' -DLLVM_CHECK_ENABLED_PROJECTS=OFF '-DLLVM_TARGETS_TO_BUILD=AArch64;ARM;Mips;PowerPC;SystemZ;WebAssembly;X86' -DLLVM_ENABLE_PIC=OFF -DLLVM_ENABLE_UNWIND_TABLES=OFF -DLLVM_ENABLE_TERMINFO=OFF -DLLVM_ENABLE_Z3_SOLVER=OFF -DCLANG_PLUGIN_SUPPORT=OFF -DCLANG_ENABLE_STATIC_ANALYZER=OFF -DCLANG_ENABLE_ARCMT=OFF '-DBUG_REPORT_URL=https://crbug.com and run tools/clang/scripts/process_crashreports.py (only works inside Google) which will upload a report' -DLLVM_INCLUDE_GO_TESTS=OFF -DENABLE_X86_RELAX_RELOCATIONS=NO -DLLVM_ENABLE_DIA_SDK=OFF '-DCOMPILER_RT_SANITIZERS_TO_BUILD=asan;dfsan;msan;hwasan;tsan;cfi' -DLLVM_ENABLE_PER_TARGET_RUNTIME_DIR=OFF -DLLVM_LOCAL_RPATH=/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty/lib64 '-DCOMPILER_RT_TEST_COMPILER_CFLAGS=--gcc-toolchain=/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty -Wl,-rpath,/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty/lib64 -Wl,-rpath,/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty/lib32' -DLLVM_ENABLE_LIBXML2=FORCE_ON -DCMAKE_C_COMPILER=/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty/bin/gcc -DCMAKE_CXX_COMPILER=/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty/bin/g++ -DCOMPILER_RT_BUILD_CRT=OFF -DCOMPILER_RT_BUILD_LIBFUZZER=OFF -DCOMPILER_RT_BUILD_MEMPROF=OFF -DCOMPILER_RT_BUILD_ORC=OFF -DCOMPILER_RT_BUILD_PROFILE=ON -DCOMPILER_RT_BUILD_SANITIZERS=ON -DCOMPILER_RT_BUILD_XRAY=OFF -DCOMPILER_RT_BUILD_BUILTINS=OFF -DCMAKE_C_FLAGS=-DLLVM_FORCE_HEAD_REVISION -DCMAKE_CXX_FLAGS=-DLLVM_FORCE_HEAD_REVISION -DCMAKE_EXE_LINKER_FLAGS= -DCMAKE_SHARED_LINKER_FLAGS= -DCMAKE_MODULE_LINKER_FLAGS= -DCMAKE_INSTALL_PREFIX=/b/s/w/ir/cache/builder/src/third_party/llvm-build/Release+Asserts -DCHROMIUM_TOOLS_SRC=/b/s/w/ir/cache/builder/src/tools/clang '-DCHROMIUM_TOOLS=translation_unit;blink_gc_plugin;plugins' -DLLVM_DEFAULT_TARGET_TRIPLE=x86_64-unknown-linux-gnu /b/s/w/ir/cache/builder/src/third_party/llvm/llvm


-- Configuring done
CMake Error: install(EXPORT "ClangTargets" ...) includes target "clangTidy" which requires target "clangStaticAnalyzerCore" that is not in any export set.
CMake Error: install(EXPORT "ClangTargets" ...) includes target "clangTidy" which requires target "clangStaticAnalyzerFrontend" that is not in any export set.
CMake Error: install(EXPORT "ClangTargets" ...) includes target "clangTidyMPIModule" which requires target "clangStaticAnalyzerCheckers" that is not in any export set.
CMake Error in /b/s/w/ir/cache/builder/src/third_party/llvm/clang/cmake/modules/CMakeLists.txt:
  export called with target "clangTidy" which requires target
  "clangStaticAnalyzerCore" that is not in any export set.


CMake Error in /b/s/w/ir/cache/builder/src/third_party/llvm/clang/cmake/modules/CMakeLists.txt:
  export called with target "clangTidy" which requires target
  "clangStaticAnalyzerFrontend" that is not in any export set.


CMake Error in /b/s/w/ir/cache/builder/src/third_party/llvm/clang/cmake/modules/CMakeLists.txt:
  export called with target "clangTidyMPIModule" which requires target
  "clangStaticAnalyzerCheckers" that is not in any export set.

Are we holding it wrong?

[arichardson]

In D109611#3010353, @thakis wrote:

This breaks the build for us:

Running cmake -GNinja -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=ON '-DLLVM_ENABLE_PROJECTS=clang;compiler-rt;lld;chrometools;clang-tools-extra' -DLLVM_CHECK_ENABLED_PROJECTS=OFF '-DLLVM_TARGETS_TO_BUILD=AArch64;ARM;Mips;PowerPC;SystemZ;WebAssembly;X86' -DLLVM_ENABLE_PIC=OFF -DLLVM_ENABLE_UNWIND_TABLES=OFF -DLLVM_ENABLE_TERMINFO=OFF -DLLVM_ENABLE_Z3_SOLVER=OFF -DCLANG_PLUGIN_SUPPORT=OFF -DCLANG_ENABLE_STATIC_ANALYZER=OFF -DCLANG_ENABLE_ARCMT=OFF '-DBUG_REPORT_URL=https://crbug.com and run tools/clang/scripts/process_crashreports.py (only works inside Google) which will upload a report' -DLLVM_INCLUDE_GO_TESTS=OFF -DENABLE_X86_RELAX_RELOCATIONS=NO -DLLVM_ENABLE_DIA_SDK=OFF '-DCOMPILER_RT_SANITIZERS_TO_BUILD=asan;dfsan;msan;hwasan;tsan;cfi' -DLLVM_ENABLE_PER_TARGET_RUNTIME_DIR=OFF -DLLVM_LOCAL_RPATH=/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty/lib64 '-DCOMPILER_RT_TEST_COMPILER_CFLAGS=--gcc-toolchain=/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty -Wl,-rpath,/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty/lib64 -Wl,-rpath,/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty/lib32' -DLLVM_ENABLE_LIBXML2=FORCE_ON -DCMAKE_C_COMPILER=/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty/bin/gcc -DCMAKE_CXX_COMPILER=/b/s/w/ir/cache/builder/src/third_party/llvm-build-tools/gcc-10.2.0-trusty/bin/g++ -DCOMPILER_RT_BUILD_CRT=OFF -DCOMPILER_RT_BUILD_LIBFUZZER=OFF -DCOMPILER_RT_BUILD_MEMPROF=OFF -DCOMPILER_RT_BUILD_ORC=OFF -DCOMPILER_RT_BUILD_PROFILE=ON -DCOMPILER_RT_BUILD_SANITIZERS=ON -DCOMPILER_RT_BUILD_XRAY=OFF -DCOMPILER_RT_BUILD_BUILTINS=OFF -DCMAKE_C_FLAGS=-DLLVM_FORCE_HEAD_REVISION -DCMAKE_CXX_FLAGS=-DLLVM_FORCE_HEAD_REVISION -DCMAKE_EXE_LINKER_FLAGS= -DCMAKE_SHARED_LINKER_FLAGS= -DCMAKE_MODULE_LINKER_FLAGS= -DCMAKE_INSTALL_PREFIX=/b/s/w/ir/cache/builder/src/third_party/llvm-build/Release+Asserts -DCHROMIUM_TOOLS_SRC=/b/s/w/ir/cache/builder/src/tools/clang '-DCHROMIUM_TOOLS=translation_unit;blink_gc_plugin;plugins' -DLLVM_DEFAULT_TARGET_TRIPLE=x86_64-unknown-linux-gnu /b/s/w/ir/cache/builder/src/third_party/llvm/llvm


-- Configuring done
CMake Error: install(EXPORT "ClangTargets" ...) includes target "clangTidy" which requires target "clangStaticAnalyzerCore" that is not in any export set.
CMake Error: install(EXPORT "ClangTargets" ...) includes target "clangTidy" which requires target "clangStaticAnalyzerFrontend" that is not in any export set.
CMake Error: install(EXPORT "ClangTargets" ...) includes target "clangTidyMPIModule" which requires target "clangStaticAnalyzerCheckers" that is not in any export set.
CMake Error in /b/s/w/ir/cache/builder/src/third_party/llvm/clang/cmake/modules/CMakeLists.txt:
  export called with target "clangTidy" which requires target
  "clangStaticAnalyzerCore" that is not in any export set.


CMake Error in /b/s/w/ir/cache/builder/src/third_party/llvm/clang/cmake/modules/CMakeLists.txt:
  export called with target "clangTidy" which requires target
  "clangStaticAnalyzerFrontend" that is not in any export set.


CMake Error in /b/s/w/ir/cache/builder/src/third_party/llvm/clang/cmake/modules/CMakeLists.txt:
  export called with target "clangTidyMPIModule" which requires target
  "clangStaticAnalyzerCheckers" that is not in any export set.

Are we holding it wrong?

Hmm that sounds like it might be awkward to fix. I'll try to look into it ASAP (tomorrow morning UK time). In the mean time feel free to revert if this is a blocker for you.

[thakis]

Thanks, reverted in 9197834535364efff505580ef940ad41cd293275 for now.

Here's a shorter cmake invocation that repros it: cmake -GNinja -DCLANG_ENABLE_STATIC_ANALYZER=OFF ../llvm-project/llvm '-DLLVM_ENABLE_PROJECTS=llvm;clang;clang-tools-extra' -DCLANG_ENABLE_ARCMT=OFF

(i.e. just turn off CLANG_ENABLE_STATIC_ANALYZER but keep CLANG_TIDY_ENABLE_STATIC_ANALYZER on.)

[tbaeder]

I just noticed this as well. @arichardson, has there been any work towards a working solution?

[tbaeder]

@thakis After re-applying this patch locally, I can't see the breakage you described with the reproducer provided.

[hans]

I tried

cmake -GNinja -DCLANG_ENABLE_STATIC_ANALYZER=OFF -DLLVM_ENABLE_PROJECTS="llvm;clang;clang-tools-extra" -DCLANG_ENABLE_ARCMT=OFF ../llvm

and verified that the breakage occurs at 6d7b3d6b3a8dbd62650b6c3dae1fe904a8ae9048, doesn't occur on origin/main, but breaks again if I apply this patch on top of origin/main. So it seems nothing has changed. I also double checked that the error at 6d7b3d6b3a8dbd62650b6c3dae1fe904a8ae9048 happens both on my Linux and Windows box.

[arichardson]

I will try to get back to this soon, but it will probably not be this week.

[arichardson]

Have to fix cmake -GNinja -DCLANG_ENABLE_STATIC_ANALYZER=OFF -DLLVM_ENABLE_PROJECTS="llvm;clang;clang-tools-extra" -DCLANG_ENABLE_ARCMT=OFF ../llvm

clang/cmake/modules/AddClang.cmake

if(BUILD_SHARED_LIBS)
       set(LIBTYPE SHARED)
     else()
       set(LIBTYPE STATIC)
     endif()
     if(NOT XCODE)
       # The Xcode generator doesn't handle object libraries correctly.
       list(APPEND LIBTYPE OBJECT)
     endif()
+    if (NOT EXCLUDE_FROM_ALL)
+      # Only include libraries that don't have EXCLUDE_FROM_ALL set. This
+      # ensure that the clang static analyzer libraries are not compiled
+      # as part of clang-shlib if CLANG_ENABLE_STATIC_ANALYZER=OFF.
       set_property(GLOBAL APPEND PROPERTY CLANG_STATIC_LIBS ${name})
     endif()
+  endif()
   llvm_add_library(${name} ${LIBTYPE} ${ARG_UNPARSED_ARGUMENTS} ${srcs})
 
   set(libs ${name})
   if(ARG_SHARED AND ARG_STATIC)
     list(APPEND libs ${name}_static)
   endif()
 
   foreach(lib ${libs})
-    if(TARGET ${lib})
       target_link_libraries(${lib} INTERFACE ${LLVM_COMMON_LIBS})
+      if (EXCLUDE_FROM_ALL)
+        continue()
+      endif()
 
       if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY OR ARG_INSTALL_WITH_TOOLCHAIN)
         get_target_export_arg(${name} Clang export_to_clangtargets UMBRELLA clang-libraries)
         install(TARGETS ${lib}
           COMPONENT ${lib}
           ${export_to_clangtargets}
           LIBRARY DESTINATION lib${LLVM_LIBDIR_SUFFIX}
           ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX}

clang/lib/StaticAnalyzer/CMakeLists.txt

+# These directories can significantly impact build time, only build
+# them if anything depends on the clangStaticAnalyzer* libraries.
+if(NOT CLANG_ENABLE_STATIC_ANALYZER)
+  set_property(DIRECTORY PROPERTY EXCLUDE_FROM_ALL ON)
+  set(EXCLUDE_FROM_ALL ON)
+endif()
+
 add_subdirectory(Core)
 add_subdirectory(Checkers)
 add_subdirectory(Frontend)

llvm/cmake/modules/AddLLVM.cmake

 #   NO_INSTALL_RPATH
 #     Suppress default RPATH settings in shared libraries.
 #   PLUGIN_TOOL
 #     The tool (i.e. cmake target) that this plugin will link against
 #   COMPONENT_LIB
 #      This is used to specify that this is a component library of
 #      LLVM which means that the source resides in llvm/lib/ and it is a
 #      candidate for inclusion into libLLVM.so.
+#   EXCLUDE_FROM_ALL
+#      Do not build this library as part of the default target, only
+#      if explicitly requested or when linked against.
 #   )
 function(llvm_add_library name)
   cmake_parse_arguments(ARG
-    "MODULE;SHARED;STATIC;OBJECT;DISABLE_LLVM_LINK_LLVM_DYLIB;SONAME;NO_INSTALL_RPATH;COMPONENT_LIB"
+    "MODULE;SHARED;STATIC;OBJECT;DISABLE_LLVM_LINK_LLVM_DYLIB;SONAME;NO_INSTALL_RPATH;COMPONENT_LIB;EXCLUDE_FROM_ALL"
     "OUTPUT_NAME;PLUGIN_TOOL;ENTITLEMENTS;BUNDLE_PATH"
     "ADDITIONAL_HEADERS;DEPENDS;LINK_COMPONENTS;LINK_LIBS;OBJLIBS"
     ${ARGN})
   list(APPEND LLVM_COMMON_DEPENDS ${ARG_DEPENDS})
   if(ARG_ADDITIONAL_HEADERS)
     # Pass through ADDITIONAL_HEADERS.
     set(ARG_ADDITIONAL_HEADERS ADDITIONAL_HEADERS ${ARG_ADDITIONAL_HEADERS})
   endif()
llvm_add_library(${name_static} STATIC
       )
 
     # Bring in the target link info from our original target.
     target_link_directories(${name_static} PRIVATE $<TARGET_PROPERTY:${name},LINK_DIRECTORIES>)
     target_link_libraries(${name_static} PRIVATE $<TARGET_PROPERTY:${name},LINK_LIBRARIES>)
 
     # FIXME: Add name_static to anywhere in TARGET ${name}'s PROPERTY.
     set(ARG_STATIC)
+    if(ARG_EXCLUDE_FROM_ALL OR EXCLUDE_FROM_ALL)
+      set_target_properties(${name_static} PROPERTIES EXCLUDE_FROM_ALL ON)
+    endif()
   endif()
 
   if(ARG_MODULE)
     add_library(${name} MODULE ${ALL_FILES})
   elseif(ARG_SHARED)
     add_windows_version_resource_file(ALL_FILES ${ALL_FILES})
     add_library(${name} SHARED ${ALL_FILES})
   else()
     add_library(${name} STATIC ${ALL_FILES})
   endif()
 
+  if(ARG_EXCLUDE_FROM_ALL OR EXCLUDE_FROM_ALL)
+    set_target_properties(${name} PROPERTIES EXCLUDE_FROM_ALL ON)
+  endif()
+
   if(ARG_COMPONENT_LIB)
     set_target_properties(${name} PROPERTIES LLVM_COMPONENT TRUE)
     set_property(GLOBAL APPEND PROPERTY LLVM_COMPONENT_LIBS ${name})
   endif()
 
   if(NOT ARG_NO_INSTALL_RPATH)
     if(ARG_MODULE OR ARG_SHARED)
       llvm_setup_rpath(${name})