[cmake] Explicitly mark libraries defined in lib/ as "Component Libraries"

Summary:
Most libraries are defined in the lib/ directory but there are also a
few libraries defined in tools/ e.g. libLLVM, libLTO.  I'm defining
"Component Libraries" as libraries defined in lib/ that may be included in
libLLVM.so.  Explicitly marking the libraries in lib/ as component
libraries allows us to remove some fragile checks that attempt to
differentiate between lib/ libraries and tools/ libraires:

1. In tools/llvm-shlib, because
llvm_map_components_to_libnames(LIB_NAMES "all") returned a list of
all libraries defined in the whole project, there was custom code
needed to filter out libraries defined in tools/, none of which should
be included in libLLVM.so.  This code assumed that any library
defined as static was from lib/ and everything else should be
excluded.

With this change, llvm_map_components_to_libnames(LIB_NAMES, "all")
only returns libraries that have been added to the LLVM_COMPONENT_LIBS
global cmake property, so this custom filtering logic can be removed.
Doing this also fixes the build with BUILD_SHARED_LIBS=ON
and LLVM_BUILD_LLVM_DYLIB=ON.

2. There was some code in llvm_add_library that assumed that
libraries defined in lib/ would not have LLVM_LINK_COMPONENTS or
ARG_LINK_COMPONENTS set.  This is only true because libraries
defined lib lib/ use LLVMBuild.txt and don't set these values.
This code has been fixed now to check if the library has been
explicitly marked as a component library, which should now make it
easier to remove LLVMBuild at some point in the future.

I have tested this patch on Windows, MacOS and Linux with release builds
and the following combinations of CMake options:

- "" (No options)
- -DLLVM_BUILD_LLVM_DYLIB=ON
- -DLLVM_LINK_LLVM_DYLIB=ON
- -DBUILD_SHARED_LIBS=ON
- -DBUILD_SHARED_LIBS=ON -DLLVM_BUILD_LLVM_DYLIB=ON
- -DBUILD_SHARED_LIBS=ON -DLLVM_LINK_LLVM_DYLIB=ON

Reviewers: beanz, smeenai, compnerd, phosek

Reviewed By: beanz

Subscribers: wuzish, jholewinski, arsenm, dschuff, jyknight, dylanmckay, sdardis, nemanjai, jvesely, nhaehnle, mgorny, mehdi_amini, sbc100, jgravelle-google, hiraditya, aheejin, fedor.sergeev, asb, rbar, johnrusso, simoncook, apazos, sabuasal, niosHD, jrtc27, MaskRay, zzheng, edward-jones, atanasyan, steven_wu, rogfer01, MartinMosbeck, brucehoult, the_o, dexonsmith, PkmX, jocewei, jsji, dang, Jim, lenary, s.egerton, pzheng, sameer.abuasal, llvm-commits

Tags: #llvm

Differential Revision: https://reviews.llvm.org/D70179

Author: tstellar

llvm/cmake/modules/AddLLVM.cmake

@@ -397,10 +397,14 @@ endfunction(set_windows_version_resource_properties)
 #     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.
 #   )
 function(llvm_add_library name)
   cmake_parse_arguments(ARG
-    "MODULE;SHARED;STATIC;OBJECT;DISABLE_LLVM_LINK_LLVM_DYLIB;SONAME;NO_INSTALL_RPATH"
+    "MODULE;SHARED;STATIC;OBJECT;DISABLE_LLVM_LINK_LLVM_DYLIB;SONAME;NO_INSTALL_RPATH;COMPONENT_LIB"
     "OUTPUT_NAME;PLUGIN_TOOL;ENTITLEMENTS;BUNDLE_PATH"
     "ADDITIONAL_HEADERS;DEPENDS;LINK_COMPONENTS;LINK_LIBS;OBJLIBS"
     ${ARGN})
@@ -486,6 +490,11 @@ function(llvm_add_library name)
     add_library(${name} STATIC ${ALL_FILES})
   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})
@@ -570,7 +579,7 @@ function(llvm_add_library name)
   if(ARG_MODULE AND LLVM_EXPORT_SYMBOLS_FOR_PLUGINS AND ARG_PLUGIN_TOOL AND (WIN32 OR CYGWIN))
     # On DLL platforms symbols are imported from the tool by linking against it.
     set(llvm_libs ${ARG_PLUGIN_TOOL})
-  elseif (DEFINED LLVM_LINK_COMPONENTS OR DEFINED ARG_LINK_COMPONENTS)
+  elseif (NOT ARG_COMPONENT_LIB)
     if (LLVM_LINK_LLVM_DYLIB AND NOT ARG_DISABLE_LLVM_LINK_LLVM_DYLIB)
       set(llvm_libs LLVM)
     else()
@@ -669,6 +678,10 @@ function(add_llvm_install_targets target)
   endif()
 endfunction()
 
+function(add_llvm_component_library name)
+  add_llvm_library(${name} COMPONENT_LIB ${ARGN})
+endfunction()
+
 macro(add_llvm_library name)
   cmake_parse_arguments(ARG
     "SHARED;BUILDTREE_ONLY;MODULE;INSTALL_WITH_TOOLCHAIN"
@@ -1027,7 +1040,7 @@ macro(add_llvm_target target_name)
   include_directories(BEFORE
     ${CMAKE_CURRENT_BINARY_DIR}
     ${CMAKE_CURRENT_SOURCE_DIR})
-  add_llvm_library(LLVM${target_name} ${ARGN})
+  add_llvm_component_library(LLVM${target_name} ${ARGN})
   set( CURRENT_LLVM_TARGET LLVM${target_name} )
 endmacro(add_llvm_target)
 

llvm/cmake/modules/LLVM-Config.cmake

@@ -267,7 +267,8 @@ function(llvm_map_components_to_libnames out_libs)
     elseif( c STREQUAL "engine" )
       # already processed
     elseif( c STREQUAL "all" )
-      list(APPEND expanded_components ${LLVM_AVAILABLE_LIBS})
+      get_property(all_components GLOBAL PROPERTY LLVM_COMPONENT_LIBS)
+      list(APPEND expanded_components ${all_components})
     else()
       # Canonize the component name:
       string(TOUPPER "${c}" capitalized)

llvm/lib/Analysis/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMAnalysis
+add_llvm_component_library(LLVMAnalysis
   AliasAnalysis.cpp
   AliasAnalysisEvaluator.cpp
   AliasAnalysisSummary.cpp

llvm/lib/AsmParser/CMakeLists.txt

@@ -1,5 +1,5 @@
 # AsmParser
-add_llvm_library(LLVMAsmParser
+add_llvm_component_library(LLVMAsmParser
   LLLexer.cpp
   LLParser.cpp
   Parser.cpp

llvm/lib/BinaryFormat/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMBinaryFormat
+add_llvm_component_library(LLVMBinaryFormat
   AMDGPUMetadataVerifier.cpp
   Dwarf.cpp
   Magic.cpp

llvm/lib/Bitcode/Reader/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMBitReader
+add_llvm_component_library(LLVMBitReader
   BitcodeAnalyzer.cpp
   BitReader.cpp
   BitcodeReader.cpp

llvm/lib/Bitcode/Writer/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMBitWriter
+add_llvm_component_library(LLVMBitWriter
   BitWriter.cpp
   BitcodeWriter.cpp
   BitcodeWriterPass.cpp

llvm/lib/Bitstream/Reader/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMBitstreamReader
+add_llvm_component_library(LLVMBitstreamReader
   BitstreamReader.cpp
 
   ADDITIONAL_HEADER_DIRS

llvm/lib/CodeGen/AsmPrinter/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMAsmPrinter
+add_llvm_component_library(LLVMAsmPrinter
   AccelTable.cpp
   AddressPool.cpp
   ARMException.cpp

llvm/lib/CodeGen/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMCodeGen
+add_llvm_component_library(LLVMCodeGen
   AggressiveAntiDepBreaker.cpp
   AllocationOrder.cpp
   Analysis.cpp

llvm/lib/CodeGen/GlobalISel/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMGlobalISel
+add_llvm_component_library(LLVMGlobalISel
         CSEInfo.cpp
         GISelKnownBits.cpp
         CSEMIRBuilder.cpp

llvm/lib/CodeGen/MIRParser/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMMIRParser
+add_llvm_component_library(LLVMMIRParser
   MILexer.cpp
   MIParser.cpp
   MIRParser.cpp

llvm/lib/CodeGen/SelectionDAG/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMSelectionDAG
+add_llvm_component_library(LLVMSelectionDAG
   DAGCombiner.cpp
   FastISel.cpp
   FunctionLoweringInfo.cpp

llvm/lib/DebugInfo/CodeView/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMDebugInfoCodeView
+add_llvm_component_library(LLVMDebugInfoCodeView
   AppendingTypeTableBuilder.cpp
   CodeViewError.cpp
   CodeViewRecordIO.cpp

llvm/lib/DebugInfo/DWARF/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMDebugInfoDWARF
+add_llvm_component_library(LLVMDebugInfoDWARF
   DWARFAbbreviationDeclaration.cpp
   DWARFAddressRange.cpp
   DWARFAcceleratorTable.cpp

llvm/lib/DebugInfo/GSYM/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMDebugInfoGSYM
+add_llvm_component_library(LLVMDebugInfoGSYM
   Header.cpp
   FileWriter.cpp
   FunctionInfo.cpp

llvm/lib/DebugInfo/MSF/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMDebugInfoMSF
+add_llvm_component_library(LLVMDebugInfoMSF
   MappedBlockStream.cpp
   MSFBuilder.cpp
   MSFCommon.cpp

llvm/lib/DebugInfo/PDB/CMakeLists.txt

@@ -84,7 +84,7 @@ add_pdb_impl_folder(Native
 list(APPEND LIBPDB_ADDITIONAL_HEADER_DIRS "${LLVM_MAIN_INCLUDE_DIR}/llvm/DebugInfo/PDB/Native")
 list(APPEND LIBPDB_ADDITIONAL_HEADER_DIRS "${LLVM_MAIN_INCLUDE_DIR}/llvm/DebugInfo/PDB")
 
-add_llvm_library(LLVMDebugInfoPDB
+add_llvm_component_library(LLVMDebugInfoPDB
   GenericError.cpp
   IPDBSourceFile.cpp
   PDB.cpp

llvm/lib/DebugInfo/Symbolize/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMSymbolize
+add_llvm_component_library(LLVMSymbolize
   DIPrinter.cpp
   SymbolizableObjectFile.cpp
   Symbolize.cpp

llvm/lib/Demangle/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMDemangle
+add_llvm_component_library(LLVMDemangle
   Demangle.cpp
   ItaniumDemangle.cpp
   MicrosoftDemangle.cpp

llvm/lib/ExecutionEngine/CMakeLists.txt

@@ -1,6 +1,6 @@
 
 
-add_llvm_library(LLVMExecutionEngine
+add_llvm_component_library(LLVMExecutionEngine
   ExecutionEngine.cpp
   ExecutionEngineBindings.cpp
   GDBRegistrationListener.cpp

llvm/lib/ExecutionEngine/IntelJITEvents/CMakeLists.txt

@@ -7,7 +7,7 @@ endif()
 set(LLVM_INTEL_JIT_LIBS ${LLVM_PTHREAD_LIB} ${LLVM_INTEL_JIT_LIBS})
 
 
-add_llvm_library(LLVMIntelJITEvents
+add_llvm_component_library(LLVMIntelJITEvents
   IntelJITEventListener.cpp
   jitprofiling.c
 

llvm/lib/ExecutionEngine/Interpreter/CMakeLists.txt

@@ -6,7 +6,7 @@ if( FFI_INCLUDE_PATH )
   include_directories( ${FFI_INCLUDE_PATH} )
 endif()
 
-add_llvm_library(LLVMInterpreter
+add_llvm_component_library(LLVMInterpreter
   Execution.cpp
   ExternalFunctions.cpp
   Interpreter.cpp

llvm/lib/ExecutionEngine/JITLink/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMJITLink
+add_llvm_component_library(LLVMJITLink
   JITLink.cpp
   JITLinkGeneric.cpp
   JITLinkMemoryManager.cpp

llvm/lib/ExecutionEngine/MCJIT/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMMCJIT
+add_llvm_component_library(LLVMMCJIT
   MCJIT.cpp
 
   DEPENDS

llvm/lib/ExecutionEngine/OProfileJIT/CMakeLists.txt

@@ -1,7 +1,7 @@
 
 include_directories( ${LLVM_OPROFILE_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/.. )
 
-add_llvm_library(LLVMOProfileJIT
+add_llvm_component_library(LLVMOProfileJIT
   OProfileJITEventListener.cpp
   OProfileWrapper.cpp
   )

llvm/lib/ExecutionEngine/Orc/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMOrcJIT
+add_llvm_component_library(LLVMOrcJIT
   CompileOnDemandLayer.cpp
   CompileUtils.cpp
   Core.cpp

llvm/lib/ExecutionEngine/OrcError/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMOrcError
+add_llvm_component_library(LLVMOrcError
   OrcError.cpp
   RPCError.cpp
   ADDITIONAL_HEADER_DIRS

llvm/lib/ExecutionEngine/PerfJITEvents/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMPerfJITEvents
+add_llvm_component_library(LLVMPerfJITEvents
   PerfJITEventListener.cpp
   )
 

llvm/lib/ExecutionEngine/RuntimeDyld/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMRuntimeDyld
+add_llvm_component_library(LLVMRuntimeDyld
   JITSymbol.cpp
   RTDyldMemoryManager.cpp
   RuntimeDyld.cpp

llvm/lib/FuzzMutate/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMFuzzMutate
+add_llvm_component_library(LLVMFuzzMutate
   FuzzerCLI.cpp
   IRMutator.cpp
   OpDescriptor.cpp

llvm/lib/IR/CMakeLists.txt

@@ -2,7 +2,7 @@ set(LLVM_TARGET_DEFINITIONS AttributesCompatFunc.td)
 tablegen(LLVM AttributesCompatFunc.inc -gen-attrs)
 add_public_tablegen_target(AttributeCompatFuncTableGen)
 
-add_llvm_library(LLVMCore
+add_llvm_component_library(LLVMCore
   AbstractCallSite.cpp
   AsmWriter.cpp
   Attributes.cpp

llvm/lib/IRReader/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMIRReader
+add_llvm_component_library(LLVMIRReader
   IRReader.cpp
 
   ADDITIONAL_HEADER_DIRS

llvm/lib/LTO/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMLTO
+add_llvm_component_library(LLVMLTO
   Caching.cpp
   LTO.cpp
   LTOBackend.cpp

llvm/lib/LineEditor/CMakeLists.txt

@@ -2,7 +2,7 @@ if(HAVE_LIBEDIT)
   set(link_libs edit)
 endif()
 
-add_llvm_library(LLVMLineEditor
+add_llvm_component_library(LLVMLineEditor
   LineEditor.cpp
 
   ADDITIONAL_HEADER_DIRS

llvm/lib/Linker/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMLinker
+add_llvm_component_library(LLVMLinker
   IRMover.cpp
   LinkModules.cpp
 

llvm/lib/MC/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMMC
+add_llvm_component_library(LLVMMC
   ConstantPools.cpp
   ELFObjectWriter.cpp
   MCAsmBackend.cpp

llvm/lib/MC/MCDisassembler/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMMCDisassembler
+add_llvm_component_library(LLVMMCDisassembler
   Disassembler.cpp
   MCDisassembler.cpp
   MCExternalSymbolizer.cpp

llvm/lib/MC/MCParser/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMMCParser
+add_llvm_component_library(LLVMMCParser
   AsmLexer.cpp
   AsmParser.cpp
   COFFAsmParser.cpp

llvm/lib/MCA/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMMCA
+add_llvm_component_library(LLVMMCA
   CodeEmitter.cpp
   Context.cpp
   HWEventListener.cpp

llvm/lib/Object/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMObject
+add_llvm_component_library(LLVMObject
   Archive.cpp
   ArchiveWriter.cpp
   Binary.cpp

llvm/lib/ObjectYAML/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMObjectYAML
+add_llvm_component_library(LLVMObjectYAML
   CodeViewYAMLDebugSections.cpp
   CodeViewYAMLSymbols.cpp
   CodeViewYAMLTypeHashing.cpp

llvm/lib/Option/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMOption
+add_llvm_component_library(LLVMOption
   Arg.cpp
   ArgList.cpp
   Option.cpp

llvm/lib/Passes/CMakeLists.txt

@@ -2,7 +2,7 @@ if (MSVC)
   set_source_files_properties(PassBuilder.cpp PROPERTIES COMPILE_FLAGS /bigobj)
 endif()
 
-add_llvm_library(LLVMPasses
+add_llvm_component_library(LLVMPasses
   PassBuilder.cpp
   PassPlugin.cpp
   StandardInstrumentations.cpp

llvm/lib/ProfileData/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMProfileData
+add_llvm_component_library(LLVMProfileData
   GCOV.cpp
   InstrProf.cpp
   InstrProfReader.cpp

llvm/lib/ProfileData/Coverage/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMCoverage
+add_llvm_component_library(LLVMCoverage
   CoverageMapping.cpp
   CoverageMappingWriter.cpp
   CoverageMappingReader.cpp

llvm/lib/Remarks/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMRemarks
+add_llvm_component_library(LLVMRemarks
   BitstreamRemarkParser.cpp
   BitstreamRemarkSerializer.cpp
   Remark.cpp

llvm/lib/Support/CMakeLists.txt

@@ -51,7 +51,7 @@ else()
   set(Z3_LINK_FILES "")
 endif()
 
-add_llvm_library(LLVMSupport
+add_llvm_component_library(LLVMSupport
   AArch64TargetParser.cpp
   ABIBreak.cpp
   ARMTargetParser.cpp

llvm/lib/TableGen/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMTableGen
+add_llvm_component_library(LLVMTableGen
   Error.cpp
   JSONBackend.cpp
   Main.cpp

llvm/lib/Target/AArch64/AsmParser/CMakeLists.txt

@@ -1,6 +1,6 @@
 include_directories( ${CMAKE_CURRENT_BINARY_DIR}/.. ${CMAKE_CURRENT_SOURCE_DIR}/.. )
 
-add_llvm_library(LLVMAArch64AsmParser
+add_llvm_component_library(LLVMAArch64AsmParser
   AArch64AsmParser.cpp
   )
 

llvm/lib/Target/AArch64/Disassembler/CMakeLists.txt

@@ -1,6 +1,6 @@
 include_directories( ${CMAKE_CURRENT_BINARY_DIR}/.. ${CMAKE_CURRENT_SOURCE_DIR}/.. )
 
-add_llvm_library(LLVMAArch64Disassembler
+add_llvm_component_library(LLVMAArch64Disassembler
   AArch64Disassembler.cpp
   AArch64ExternalSymbolizer.cpp
   )

llvm/lib/Target/AArch64/MCTargetDesc/CMakeLists.txt

@@ -1,4 +1,4 @@
-add_llvm_library(LLVMAArch64Desc
+add_llvm_component_library(LLVMAArch64Desc
   AArch64AsmBackend.cpp
   AArch64ELFObjectWriter.cpp
   AArch64ELFStreamer.cpp