Add a new library, libclang-cxx

[pirama]

Summary

The current libclang.so exports only the symbols required for the stable
C api. This is opposed to libLLVM.so, which exports all the symbols
from the LLVM libraries, including those from the C++ API. This patch
adds libclang-cxx.so that is similar to libLLVM.so and exports all
symbols from the clang libraries. The motivation for this library is to
be used by Clang tools that use Clang's C++ api. They no longer need to
link against the individual static libraries.

[pirama]

This implements the new library proposed in http://lists.llvm.org/pipermail/cfe-dev/2018-August/058736.html.

[pirama]

Add empty source file to silence CMake warning.
Support more platforms, similar to libLLVM.so

[pirama]

As I mentioned in the discussion, we decided to carry build rules for the proposed library in downstream. I've updated this to make it more general, and will leave it open in case there's more interest to revive it in the future.

[lebedev.ri]

The motivation for this library is to
be used by Clang tools that use Clang's C++ api. They no longer need to
link against the individual static libraries.

I would personally consider that to be a regression.
It hides layering violations.
Of course, in downstream one might not care.

[kristina]

I'm in support as long as it's a configuration option defaulting similar to LLVM's one. Should likely follow the same naming convention as LLVM, ie. clang-shlib. Clang has a lot of tools it ships with especially if you consider extras, I think this is one of the cases where an exception for libClang-8.so can be made as long as it's not a default. It would make builds of things like clang-tidy much faster without requiring a fully shared library build.

IIRC libclang is a tool in itself, and is not mandatory for Clang driver tool build which is the most fundamental part to most customers, while this new library is not. There are a lot of things the downstream discussions have not covered it seems since this only accounts for for a full Clang+Tools+ARCMT+StaticAnalyzer+Extra (ie. tidy, include fixer) build. This just fails to account for so much. The pairing of libclang and the new shared library defeats the entire point of it altogether, since libclang is not required by the driver. Nor by most in-tree tools.

[kristina]

To elaborate, consider a scenario where a customer wants to build the clang driver, diagtool and just for the sake of the argument change-namespace from extras. Clang tools do not provide nearly the same level of control as most LLVM tools, so in that scenario, you'd have to maintain your own CMakeLists.txt for clang tools(/extra) to neuter unwanted artifacts like clang-tidy or libclang.so (the C API re-exporter) etc.

Unless I deeply misunderstand the functionality of toggles within LLVM's main build system, the only way of neutering those artifacts while still being able to use libclang-cxx.so would be surgery on several CMakeLists as it's not the same as, say, LLVM_TOOL_LLVM_YAML_NUMERIC_PARSER_FUZZER_BUILD=Off which is possible for top level LLVM tools.

CMakeLists.txt

 endif()
 
 # Clang version information
 set(CLANG_EXECUTABLE_VERSION
     "${CLANG_VERSION_MAJOR}" CACHE STRING
     "Major version number that will be appended to the clang executable name")
 set(LIBCLANG_LIBRARY_VERSION
     "${CLANG_VERSION_MAJOR}" CACHE STRING
-    "Major version number that will be appended to the libclang library")
+    "Major version number that will be appended to the libclang, libclang_cxx libraries")
 mark_as_advanced(CLANG_EXECUTABLE_VERSION LIBCLANG_LIBRARY_VERSION)
 
 option(CLANG_INCLUDE_TESTS
        "Generate build targets for the Clang unit tests."
        ${LLVM_INCLUDE_TESTS})
 
 add_subdirectory(utils/TableGen)
 

tools/CMakeLists.txt

 # subdirectory. It contains tools developed as part of the Clang/LLVM project
 # on top of the Clang tooling platform. We keep them in a separate repository
 # to keep the primary Clang repository small and focused.
 # It also may be included by LLVM_EXTERNAL_CLANG_TOOLS_EXTRA_SOURCE_DIR.
 add_llvm_external_project(clang-tools-extra extra)
 
 # libclang may require clang-tidy in clang-tools-extra.
 add_clang_subdirectory(libclang)
+add_clang_subdirectory(libclang-cxx)

tools/libclang-cxx/CMakeLists.txt

+set(LIBS
+  clangBasic
+  clangCodeGen
+  clangDriver
+  clangFrontend
+  clangFrontendTool
+)
+
+if (CLANG_ENABLE_ARCMT)
+  list(APPEND LIBS clangARCMigrate)
+endif ()
+
+if (TARGET clangTidyPlugin)
+  add_definitions(-DCLANG_TOOL_EXTRA_BUILD)
+  list(APPEND LIBS clangTidyPlugin)
+  list(APPEND LIBS clangIncludeFixerPlugin)
+  if(LLVM_ENABLE_MODULES)
+    list(APPEND LLVM_COMPILE_FLAGS "-fmodules-ignore-macro=CLANG_TOOL_EXTRA_BUILD")
+  endif()
+endif ()
+
+find_library(DL_LIBRARY_PATH dl)
+if (DL_LIBRARY_PATH)
+  list(APPEND LIBS dl)
+endif()
+
+if( LLVM_ENABLE_PIC )
+  set(ENABLE_SHARED SHARED)
+endif()
+
+if(NOT LLVM_ENABLE_PIC AND NOT WIN32)
+  set(ENABLE_STATIC STATIC)
+endif()
+
+if(WIN32)
+  set(output_name "libclang_cxx")
+else()
+  set(output_name "clang_cxx")
+endif()
+
+set(LIBS -Wl,--whole-archive ${LIBS} -Wl,--no-whole-archive)
+
+add_clang_library(libclang_cxx ${ENABLE_SHARED} ${ENABLE_STATIC}
+  OUTPUT_NAME ${output_name}
+
+  LINK_LIBS
+  ${LIBS}
+  )
+
+if(ENABLE_SHARED)
+  if(WIN32)
+    set_target_properties(libclang_cxx
+      PROPERTIES
+      VERSION ${LIBCLANG_LIBRARY_VERSION}
+      DEFINE_SYMBOL _CINDEX_LIB_)
+  elseif(APPLE)
+      set(LIBCLANG_CXX_LINK_FLAGS " -Wl,-compatibility_version -Wl,1")
+      set(LIBCLANG_CXX_LINK_FLAGS "${LIBCLANG_CXX_LINK_FLAGS} -Wl,-current_version -Wl,${LLVM_VERSION_MAJOR}.${LLVM_VERSION_MINOR}.${LLVM_VERSION_PATCH}")
+
+    set_property(TARGET libclang_cxx APPEND_STRING PROPERTY
+        LINK_FLAGS ${LIBCLANG_CXX_LINK_FLAGS})
+  else()
+    set_target_properties(libclang_cxx
+      PROPERTIES
+      VERSION ${LIBCLANG_LIBRARY_VERSION}
+      DEFINE_SYMBOL _CINDEX_LIB_)
+    # FIXME: _CINDEX_LIB_ affects dllexport/dllimport on Win32.
+    if(LLVM_ENABLE_MODULES AND NOT WIN32)
+      target_compile_options(libclang_cxx PRIVATE
+        "-fmodules-ignore-macro=_CINDEX_LIB_"
+        )
+    endif()
+  endif()
+endif()