[CMake] Introduce header-only interface library for tablegen targets

[chapuni]

Summary

• Introduce add_library(INTERFACE) instead of add_custom_target
• LLVM_GENERATED_INCLUDES_BASE controls partitioning
  • ${LLVM_GENERATED_INCLUDES_BASE}/path/to/file.inc is emitted to ${LLVM_GENERATED_INCLUDES_BASE}/${target}/path/to/file.inc

clang-tools-extra/clang-doc/tool/CMakeLists.txt

 include_directories(${CMAKE_CURRENT_SOURCE_DIR}/..)
 
 add_clang_tool(clang-doc
   ClangDocMain.cpp
   )
 
 clang_target_link_libraries(clang-doc
   PRIVATE
   clangAST
   clangASTMatchers
   clangBasic
+  clangDriver
   clangFrontend
   clangTooling
   clangToolingCore
   )
 target_link_libraries(clang-doc
   PRIVATE
   clangDoc
   )
 
 install(FILES ../assets/clang-doc-default-stylesheet.css
   DESTINATION "${CMAKE_INSTALL_DATADIR}/clang"
   COMPONENT clang-doc)
 
 install(FILES ../assets/index.js
   DESTINATION "${CMAKE_INSTALL_DATADIR}/clang"
   COMPONENT clang-doc)

clang-tools-extra/pp-trace/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS
   Support
   )
 
 add_clang_tool(pp-trace
   PPTrace.cpp
   PPCallbacksTracker.cpp
   )
 
 clang_target_link_libraries(pp-trace
   PRIVATE
   clangAST
   clangBasic
+  clangDriver
   clangFrontend
   clangLex
   clangSerialization
   clangTooling
   )

clang/include/clang/Driver/CMakeLists.txt

+set(LLVM_GENERATED_INCLUDES_BASE ${CMAKE_CURRENT_BINARY_DIR}/../..)
 set(LLVM_TARGET_DEFINITIONS Options.td)
 tablegen(LLVM Options.inc -gen-opt-parser-defs)
-add_public_tablegen_target(ClangDriverOptions)
+add_public_tablegen_target(ClangDriverOptions EXPORT CLANG)

clang/lib/Driver/CMakeLists.txt

add_clang_library(clangDriver
   ToolChains/PPCLinux.cpp
   ToolChains/PPCFreeBSD.cpp
   ToolChains/InterfaceStubs.cpp
   ToolChains/ZOS.cpp
   Types.cpp
   XRayArgs.cpp
 
   DEPENDS
-  ClangDriverOptions
   RISCVTargetParserTableGen
 
   LINK_LIBS
   clangBasic
   ${system_libs}
+
+  PUBLIC
+  ClangDriverOptions
   )

clang/lib/Frontend/CMakeLists.txt

add_clang_library(clangFrontend
   TestModuleFileExtension.cpp
   TextDiagnostic.cpp
   TextDiagnosticBuffer.cpp
   TextDiagnosticPrinter.cpp
   VerifyDiagnosticConsumer.cpp
   InterfaceStubFunctionsConsumer.cpp
 
   DEPENDS
-  ClangDriverOptions
   intrinsics_gen
 
   LINK_LIBS
   clangAST
   clangBasic
   clangDriver
   clangEdit
   clangLex
   clangParse
   clangSema
   clangSerialization
   )

clang/lib/FrontendTool/CMakeLists.txt

if(CLANG_ENABLE_STATIC_ANALYZER)
   list(APPEND link_libs
     clangStaticAnalyzerFrontend
     )
 endif()
 
 add_clang_library(clangFrontendTool
   ExecuteCompilerInvocation.cpp
 
-  DEPENDS
-  ClangDriverOptions
-
   LINK_LIBS
   ${link_libs}
   )

clang/lib/Interpreter/CMakeLists.txt

 
 add_clang_library(clangInterpreter
   IncrementalExecutor.cpp
   IncrementalParser.cpp
   Interpreter.cpp
 
   DEPENDS
   intrinsics_gen
-  ClangDriverOptions
 
   LINK_LIBS
   clangAST
   clangAnalysis
   clangBasic
   clangCodeGen
   clangDriver
   clangFrontend
   clangFrontendTool
   clangLex
   clangParse
   clangSema
   clangSerialization
   )

clang/lib/Tooling/CMakeLists.txt

add_clang_library(clangTooling
   Refactoring.cpp
   RefactoringCallbacks.cpp
   StandaloneExecution.cpp
   NodeIntrospection.cpp
   ${BINARY_INCLUDE_DIR}/NodeIntrospection.inc
   Tooling.cpp
 
   DEPENDS
-  ClangDriverOptions
   omp_gen
 
   LINK_LIBS
   clangAST
   clangASTMatchers
   clangBasic
   clangDriver
   clangFormat
   clangFrontend
   clangLex
   clangRewrite
   clangSerialization
   clangToolingCore
   )

clang/lib/Tooling/DependencyScanning/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS
   ${LLVM_TARGETS_TO_BUILD}
   Core
   Option
   Support
   TargetParser
   )
 
 add_clang_library(clangDependencyScanning
   DependencyScanningFilesystem.cpp
   DependencyScanningService.cpp
   DependencyScanningWorker.cpp
   DependencyScanningTool.cpp
   ModuleDepCollector.cpp
 
-  DEPENDS
-  ClangDriverOptions
-
   LINK_LIBS
   clangAST
   clangBasic
   clangCodeGen
   clangDriver
   clangFrontend
   clangLex
   clangSerialization
   clangTooling
   )

clang/tools/libclang/CMakeLists.txt

if (UNIX AND ${CMAKE_SYSTEM_NAME} MATCHES "AIX")
     remove_definitions("-D_XOPEN_SOURCE=700")
 endif()
 
 add_clang_library(libclang ${ENABLE_SHARED} ${ENABLE_STATIC} INSTALL_WITH_TOOLCHAIN
   OUTPUT_NAME ${output_name}
   ${SOURCES}
 
   DEPENDS
-  ClangDriverOptions
   clang-resource-headers
 
   LINK_LIBS
   ${LIBS}
 
   LINK_COMPONENTS
   ${LLVM_TARGETS_TO_BUILD}
   Core

lldb/source/Plugins/Platform/MacOSX/CMakeLists.txt

LINK_LIBS
     lldbInterpreter
     lldbSymbol
     lldbTarget
     lldbUtility
     lldbPluginDynamicLoaderDarwinKernel
     lldbPluginObjectContainerMachOFileset
     lldbPluginPlatformPOSIX
     ${OBJC_LIBS}
+
+    ClangDriverOptions
+
   CLANG_LIBS
     clangBasic
   LINK_COMPONENTS
     Support
     TargetParser
     )
 
 add_dependencies(lldbPluginPlatformMacOSX
   LLDBPluginPlatformMacOSXPropertiesGen
   LLDBPluginPlatformMacOSXPropertiesEnumGen)

llvm/cmake/modules/TableGen.cmake

 # LLVM_TARGET_DEFINITIONS must contain the name of the .td file to process,
 # while LLVM_TARGET_DEPENDS may contain additional file dependencies.
 # Extra parameters for `tblgen' may come after `ofn' parameter.
 # Adds the name of the generated file to TABLEGEN_OUTPUT.
 include(LLVMDistributionSupport)
 
 function(tablegen project ofn)
+  if(LLVM_GENERATED_INCLUDES_BASE)
+    if(NOT LLVM_TABLEGEN_PUBLIC_TARGET)
+      # Defer to add_public_tablegen
+      list(JOIN ARGV "," argv_comma)
+      set_property(DIRECTORY APPEND PROPERTY TABLEGENS "${LLVM_TARGET_DEFINITIONS},${argv_comma}")
+      return()
+    endif()
+    # Make odir unique per target
+    file(RELATIVE_PATH prefix ${LLVM_GENERATED_INCLUDES_BASE} ${CMAKE_CURRENT_BINARY_DIR})
+    set(odir ${LLVM_GENERATED_INCLUDES_BASE}/${LLVM_TABLEGEN_PUBLIC_TARGET}/${prefix})
+    file(REMOVE ${CMAKE_CURRENT_BINARY_DIR}/${ofn})
+
+    install(FILES ${odir}/${ofn}
+      DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/${prefix}"
+      )
+  else()
+    set(odir ${CMAKE_CURRENT_BINARY_DIR})
+  endif()
+
   cmake_parse_arguments(ARG "" "" "DEPENDS;EXTRA_INCLUDES" ${ARGN})
   # Validate calling context.
   if(NOT ${project}_TABLEGEN_EXE)
     message(FATAL_ERROR "${project}_TABLEGEN_EXE not set")
   endif()
 
   # Use depfile instead of globbing arbitrary *.td(s) for Ninja.
   if(CMAKE_GENERATOR MATCHES "Ninja")
     # Make output path relative to build.ninja, assuming located on
     # ${CMAKE_BINARY_DIR}.
     # CMake emits build targets as relative paths but Ninja doesn't identify
     # absolute path (in *.d) as relative path (in build.ninja)
     # Note that tblgen is executed on ${CMAKE_BINARY_DIR} as working directory.
     file(RELATIVE_PATH ofn_rel
-      ${CMAKE_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/${ofn})
+      ${CMAKE_BINARY_DIR} ${odir}/${ofn})
     set(additional_cmdline
       -o ${ofn_rel}
       -d ${ofn_rel}.d
       WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
-      DEPFILE ${CMAKE_CURRENT_BINARY_DIR}/${ofn}.d
+      DEPFILE ${odir}/${ofn}.d
       )
     set(local_tds)
     set(global_tds)
   else()
     file(GLOB local_tds "*.td")
     file(GLOB_RECURSE global_tds "${LLVM_MAIN_INCLUDE_DIR}/llvm/*.td")
     set(additional_cmdline
-      -o ${CMAKE_CURRENT_BINARY_DIR}/${ofn}
+      -o ${odir}/${ofn}
       )
   endif()
 
   if (IS_ABSOLUTE ${LLVM_TARGET_DEFINITIONS})
     set(LLVM_TARGET_DEFINITIONS_ABSOLUTE ${LLVM_TARGET_DEFINITIONS})
   else()
     set(LLVM_TARGET_DEFINITIONS_ABSOLUTE
       ${CMAKE_CURRENT_SOURCE_DIR}/${LLVM_TARGET_DEFINITIONS})
function(tablegen project ofn)
   list(APPEND tblgen_includes ${ARG_EXTRA_INCLUDES})
   # Filter out empty items before prepending each entry with -I
   list(REMOVE_ITEM tblgen_includes "")
   list(TRANSFORM tblgen_includes PREPEND -I)
 
   set(tablegen_exe ${${project}_TABLEGEN_EXE})
   set(tablegen_depends ${${project}_TABLEGEN_TARGET} ${tablegen_exe})
 
-  add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${ofn}
+  add_custom_command(OUTPUT ${odir}/${ofn}
     COMMAND ${tablegen_exe} ${ARG_UNPARSED_ARGUMENTS} -I ${CMAKE_CURRENT_SOURCE_DIR}
     ${tblgen_includes}
     ${LLVM_TABLEGEN_FLAGS}
     ${LLVM_TARGET_DEFINITIONS_ABSOLUTE}
     ${tblgen_change_flag}
     ${additional_cmdline}
     # The file in LLVM_TARGET_DEFINITIONS may be not in the current
     # directory and local_tds may not contain it, so we must
     # explicitly list it here:
     DEPENDS ${ARG_DEPENDS} ${tablegen_depends}
       ${local_tds} ${global_tds}
     ${LLVM_TARGET_DEFINITIONS_ABSOLUTE}
     ${LLVM_TARGET_DEPENDS}
     COMMENT "Building ${ofn}..."
     )
 
   # `make clean' must remove all those generated files:
   set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES ${ofn})
 
-  set(TABLEGEN_OUTPUT ${TABLEGEN_OUTPUT} ${CMAKE_CURRENT_BINARY_DIR}/${ofn} PARENT_SCOPE)
-  set_source_files_properties(${CMAKE_CURRENT_BINARY_DIR}/${ofn} PROPERTIES
+  set(TABLEGEN_OUTPUT ${TABLEGEN_OUTPUT} ${odir}/${ofn} PARENT_SCOPE)
+  set_source_files_properties(${odir}/${ofn} PROPERTIES
     GENERATED 1)
 endfunction()
 
 # Creates a target for publicly exporting tablegen dependencies.
 function(add_public_tablegen_target target)
+  cmake_parse_arguments(ARG "" "EXPORT" "" ${ARGN})
+
+  if(LLVM_GENERATED_INCLUDES_BASE)
+    # Recall preceding tablegen(s)
+    set(LLVM_TABLEGEN_PUBLIC_TARGET ${target})
+    get_directory_property(tablegens TABLEGENS)
+    foreach(argv_comma ${tablegens})
+      string(REPLACE "," ";" tblgen_argv ${argv_comma})
+      list(POP_FRONT tblgen_argv LLVM_TARGET_DEFINITIONS)
+      list(GET tblgen_argv 0 tblgen_project)
+      tablegen(${tblgen_argv})
+    endforeach()
+    if(ARG_EXPORT)
+      set(tblgen_project ${ARG_EXPORT})
+    endif()
+  endif()
+
   if(NOT TABLEGEN_OUTPUT)
     message(FATAL_ERROR "Requires tablegen() definitions as TABLEGEN_OUTPUT.")
   endif()
+
+  if(LLVM_GENERATED_INCLUDES_BASE)
+    set(Tblgen_project ${tblgen_project})
+    if("${Tblgen_project}" STREQUAL "CLANG")
+      set(Tblgen_project "Clang")
+    endif()
+    add_library(${target} INTERFACE ${TABLEGEN_OUTPUT})
+    if(LLVM_GENERATED_INCLUDES_BASE)
+      target_include_directories(${target} INTERFACE
+  $<BUILD_INTERFACE:${LLVM_GENERATED_INCLUDES_BASE}/${target}>
+  )
+    endif()
+
+    get_target_export_arg(${target} ${Tblgen_project} export_to_llvmexports)
+    install(TARGETS ${target}
+      ${export_to_llvmexports}
+      LIBRARY DESTINATION lib${LLVM_LIBDIR_SUFFIX} COMPONENT ${target}
+      ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX} COMPONENT ${target}
+      RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}" COMPONENT ${target}
+      )
+    set_property(GLOBAL APPEND PROPERTY ${tblgen_project}_EXPORTS ${target})
+
+    # Flush
+    set_property(DIRECTORY PROPERTY TABLEGENS)
+  else()
     add_custom_target(${target}
       DEPENDS ${TABLEGEN_OUTPUT})
+  endif()
+
   if(LLVM_COMMON_DEPENDS)
     add_dependencies(${target} ${LLVM_COMMON_DEPENDS})
   endif()
   set_target_properties(${target} PROPERTIES FOLDER "Tablegenning")
   set(LLVM_COMMON_DEPENDS ${LLVM_COMMON_DEPENDS} ${target} PARENT_SCOPE)
+  set_property(DIRECTORY APPEND PROPERTY TABLEGEN_TARGETS ${target})
 endfunction()
 
 macro(add_tablegen target project)
   cmake_parse_arguments(ADD_TABLEGEN "" "DESTINATION;EXPORT" "" ${ARGN})
 
   set(${target}_OLD_LLVM_LINK_COMPONENTS ${LLVM_LINK_COMPONENTS})
   set(LLVM_LINK_COMPONENTS ${LLVM_LINK_COMPONENTS} TableGen)