[libcxxabi] Add a cmake build system.

[danalbert]

Summary

For those of us that don't like rebuilding the whole damn thing every
time.

Will add support for tests with lit in a later patch.

This does not yet support building the unwinder in src/Unwind.

[danalbert]

If anyone could test this on msvc I'd appreciate it. My install appears no longer be sane. I'll hack at it more on later...

CMakeLists.txt

129

Eric, forgot to address your comment. Will fix that in a moment.

src/CMakeLists.txt

28

Now using include_directories() instead of target_include_directories() so we don't require cmake 2.8.11.

29

thakis, you had asked about auto-detecting libc++ if building in tree. It was actually already done, just in src/CMakeLists.txt, not the root one.

[samsonov]

I don't really understand why (most of) compiler flags are set up in the root CMakeLists.txt, while the link flags are set up in src/CMakeLists.txt, but probably that's not a big deal.

Thanks for working on this!

src/CMakeLists.txt

40

Why not use "set" here?

58

Do you need to do the same for compile_flags?

[jroelofs]

CMakeLists.txt

61

BUG_REPORT_URL is used elsewhere in the llvm family... will that work here, rather than the hardcoded string?

[danalbert]

samsonov: I used libc++ as an example while setting this up, so some of the structural oddities may have originated there :) I believe the idea is that all the flags that get set up in the root are ones that would be true of anything built in the project (including tests), whereas the flags configured in src/ are specific to libc++abi.(so|a).

CMakeLists.txt

61

This block is specifically for out of tree builds, and BUG_REPORT_URL doesn't seem to be specified in the cmake files that get installed (whereas LLVM_PACKAGE_VERSION is).

src/CMakeLists.txt

58

I actually have no idea why this is here. I copied most of this from the libc++ cmake files and tuned as necessary.

It's done for the compile flags in the main CMakeLists.txt (applied to LIBCXXABI_CXX_*_FLAGS, as these can contain parts specified from the command line using ; as a delimiter). I don't see anything about the ldflags that would need replacement though... I'll remove it.

[danalbert]

Addresses Eric's request to be able to use the system includes.

[samsonov]

src/CMakeLists.txt

58

Well, link_flags is a CMake list type, its elements will be semicolon-separated if you add them with list(APPEND link_flags foo).

[danalbert]

src/CMakeLists.txt

27

Changed this to point directly to the include directory in case the headers aren't in a directory named "include".

[danalbert]

src/CMakeLists.txt

58

Ah, didn't know that (not very familiar with cmake). So is it necessary, or is cmake smart enough to do the replacement itself?

[compnerd]

src/CMakeLists.txt

3

Im not a big fan of GLOB. I think that the number of files is tractable enough that we could enumerate them explicitly.

[danalbert]

Fixed the issues with semicolon delimited lists for link_flags/compile_flags.
Moved away from glob.

[logan]

Also, I feel that it will be good to detect for <stdexcept> and <typeinfo> headers to ensure that libcxx include path has been correctly specified.

CMakeLists.txt

10

Is there any reason that we have to rely on llvm-config when we are building a standalone version? I thought libcxxabi does not rely on LLVM (or clang) headers and libraries (except the libcxx headers which should be specified by -DLIBCXXABI_LIBCXX_INCLUDES.)

www/index.html

95

One typo here:

-DLIBCXXABI_LIBCXX_INCLUDES=path/to/libcxx/include

Also, maybe we can suggest to use:

-DCMAKE_CXX_COMPILER=clang++

instead of setting the environment variable here?

[danalbert]

It also depends on llvm-config to find lit.py and the standard llvm cmake includes.

www/index.html

95

Oops, forgot to update the first part when I made that change. Good catch.

For the second part, is there any benefit to doing it that way?

[samsonov]

www/index.html

95

FWIW I agree with CMAKE_CXX_COMPILER note - it looks a bit more cmake-ish.

[danalbert]

Address some documentation errors.

[compnerd]

LGTM.

[logan]

LGTM.

[danalbert]

Submitted as r212286.

CMakeLists.txt

+#===============================================================================
+# Setup Project
+#===============================================================================
+
+cmake_minimum_required(VERSION 2.8.8)
+
+if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
+  project(libcxxabi)
+
+  # Rely on llvm-config.
+  set(CONFIG_OUTPUT)
+  find_program(LLVM_CONFIG "llvm-config")
+  if(LLVM_CONFIG)
+    message(STATUS "Found LLVM_CONFIG as ${LLVM_CONFIG}")
+    set(CONFIG_COMMAND ${LLVM_CONFIG}
+      "--bindir"
+      "--includedir"
+      "--libdir"
+      "--prefix"
+      "--src-root")
+    execute_process(
+      COMMAND ${CONFIG_COMMAND}
+      RESULT_VARIABLE HAD_ERROR
+      OUTPUT_VARIABLE CONFIG_OUTPUT
+    )
+    if(NOT HAD_ERROR)
+      string(REGEX REPLACE
+        "[ \t]*[\r\n]+[ \t]*" ";"
+        CONFIG_OUTPUT ${CONFIG_OUTPUT})
+    else()
+      string(REPLACE ";" " " CONFIG_COMMAND_STR "${CONFIG_COMMAND}")
+      message(STATUS "${CONFIG_COMMAND_STR}")
+      message(FATAL_ERROR "llvm-config failed with status ${HAD_ERROR}")
+    endif()
+  else()
+    message(FATAL_ERROR "llvm-config not found -- ${LLVM_CONFIG}")
+  endif()
+
+  list(GET CONFIG_OUTPUT 0 TOOLS_BINARY_DIR)
+  list(GET CONFIG_OUTPUT 1 INCLUDE_DIR)
+  list(GET CONFIG_OUTPUT 2 LIBRARY_DIR)
+  list(GET CONFIG_OUTPUT 3 LLVM_OBJ_ROOT)
+  list(GET CONFIG_OUTPUT 4 MAIN_SRC_DIR)
+
+  set(LLVM_TOOLS_BINARY_DIR ${TOOLS_BINARY_DIR} CACHE PATH "Path to llvm/bin")
+  set(LLVM_INCLUDE_DIR ${INCLUDE_DIR} CACHE PATH "Path to llvm/include")
+  set(LLVM_LIBRARY_DIR ${LIBRARY_DIR} CACHE PATH "Path to llvm/lib")
+  set(LLVM_BINARY_DIR ${LLVM_OBJ_ROOT} CACHE PATH "Path to LLVM build tree")
+  set(LLVM_MAIN_SRC_DIR ${MAIN_SRC_DIR} CACHE PATH "Path to LLVM source tree")
+
+  set(LLVM_CMAKE_PATH "${LLVM_BINARY_DIR}/share/llvm/cmake")
+  set(LLVMCONFIG_FILE "${LLVM_CMAKE_PATH}/LLVMConfig.cmake")
+  if(EXISTS ${LLVMCONFIG_FILE})
+    list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_PATH}")
+    include(${LLVMCONFIG_FILE})
+  else()
+    message(FATAL_ERROR "Not found: ${LLVMCONFIG_FILE}")
+  endif()
+
+  set(PACKAGE_NAME libcxxabi)
+  set(PACKAGE_VERSION "${LLVM_PACKAGE_VERSION}")
+  set(PACKAGE_STRING "${PACKAGE_NAME} ${PACKAGE_VERSION}")
+  set(PACKAGE_BUGREPORT "[e-mail]")
+
+  if(EXISTS ${LLVM_MAIN_SRC_DIR}/utils/lit/lit.py)
+    set(LLVM_LIT ${LLVM_MAIN_SRC_DIR}/utils/lit/lit.py)
+  else()
+    # Seek installed Lit.
+    find_program(LLVM_LIT "lit.py" ${LLVM_MAIN_SRC_DIR}/utils/lit
+      DOC "Path to lit.py")
+  endif()
+
+  if(LLVM_LIT)
+    # Define the default arguments to use with 'lit', and an option for the user
+    # to override.
+    set(LIT_ARGS_DEFAULT "-sv")
+    if (MSVC OR XCODE)
+      set(LIT_ARGS_DEFAULT "${LIT_ARGS_DEFAULT} --no-progress-bar")
+    endif()
+    set(LLVM_LIT_ARGS "${LIT_ARGS_DEFAULT}" CACHE STRING "Default options for lit")
+
+    # On Win32 hosts, provide an option to specify the path to the GnuWin32 tools.
+    if( WIN32 AND NOT CYGWIN )
+      set(LLVM_LIT_TOOLS_DIR "" CACHE PATH "Path to GnuWin32 tools")
+    endif()
+  else()
+    set(LLVM_INCLUDE_TESTS OFF)
+  endif()
+
+  set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+  set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+
+  set(LIBCXXABI_BUILT_STANDALONE 1)
+endif()
+
+#===============================================================================
+# Setup CMake Options
+#===============================================================================
+
+# Define options.
+option(LIBCXXABI_ENABLE_ASSERTIONS "Enable assertions independent of build mode." ON)
+option(LIBCXXABI_ENABLE_PEDANTIC "Compile with pedantic enabled." ON)
+option(LIBCXXABI_ENABLE_WERROR "Fail and stop if a warning is triggered." OFF)
+option(LIBCXXABI_ENABLE_SHARED "Build libc++abi as a shared library." OFF)
+
+#===============================================================================
+# Configure System
+#===============================================================================
+
+# Add path for custom modules
+set(CMAKE_MODULE_PATH
+  "${CMAKE_CURRENT_SOURCE_DIR}/cmake"
+  "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules"
+  ${CMAKE_MODULE_PATH}
+  )
+
+# Configure compiler.
+include(config-ix)
+
+#===============================================================================
+# Setup Compiler Flags
+#===============================================================================
+
+# Get required flags.
+macro(append_if list condition var)
+  if (${condition})
+    list(APPEND ${list} ${var})
+  endif()
+endmacro()
+
+if (LIBCXXABI_HAS_NOSTDINCXX_FLAG)
+  list(APPEND LIBCXXABI_CXX_REQUIRED_FLAGS -nostdinc++)
+endif()
+if (NOT LIBCXXABI_HAS_STDCXX11_FLAG)
+  message(FATAL_ERROR "Building libcxxabi requires a C++11 capable compiler.")
+endif()
+
+list(APPEND LIBCXXABI_CXX_REQUIRED_FLAGS -std=c++11)
+
+# Get warning flags
+if (NOT MSVC)
+  append_if(LIBCXXABI_CXX_WARNING_FLAGS LIBCXXABI_HAS_WALL_FLAG -Wall)
+  append_if(LIBCXXABI_CXX_WARNING_FLAGS LIBCXXABI_HAS_WNO_UNUSED_FUNCTION_FLAG -Wno-unused-function)
+  list(APPEND LIBCXXABI_CXX_REQUIRED_FLAGS -Werror=return-type)
+endif()
+
+append_if(LIBCXXABI_CXX_WARNING_FLAGS LIBCXXABI_HAS_W_FLAG -W)
+append_if(LIBCXXABI_CXX_WARNING_FLAGS LIBCXXABI_HAS_WNO_UNUSED_PARAMETER_FLAG -Wno-unused-parameter)
+append_if(LIBCXXABI_CXX_WARNING_FLAGS LIBCXXABI_HAS_WWRITE_STRINGS_FLAG -Wwrite-strings)
+append_if(LIBCXXABI_CXX_WARNING_FLAGS LIBCXXABI_HAS_WNO_LONG_LONG_FLAG -Wno-long-long)
+if (LIBCXXABI_ENABLE_WERROR)
+  append_if(LIBCXXABI_CXX_WARNING_FLAGS LIBCXXABI_HAS_WERROR_FLAG -Werror)
+  append_if(LIBCXXABI_CXX_WARNING_FLAGS LIBCXXABI_HAS_WX_FLAG -WX)
+else()
+  append_if(LIBCXXABI_CXX_WARNING_FLAGS LIBCXXABI_HAS_WNO_ERROR_FLAG -Wno-error)
+  append_if(LIBCXXABI_CXX_WARNING_FLAGS LIBCXXABI_HAS_NO_WX_FLAG -WX-)
+endif()
+if (LIBCXXABI_ENABLE_PEDANTIC)
+  append_if(LIBCXXABI_CXX_WARNING_FLAGS LIBCXXABI_HAS_PEDANTIC_FLAG -pedantic)
+endif()
+
+# Get feature flags.
+# Exceptions
+# Catches C++ exceptions only and tells the compiler to assume that extern C
+# functions never throw a C++ exception.
+append_if(LIBCXXABI_CXX_FEATURE_FLAGS LIBCXXABI_HAS_EHSC_FLAG -EHsc)
+
+# Assert
+string(TOUPPER "${CMAKE_BUILD_TYPE}" uppercase_CMAKE_BUILD_TYPE)
+if (LIBCXXABI_ENABLE_ASSERTIONS)
+  # MSVC doesn't like _DEBUG on release builds. See PR 4379.
+  if (NOT MSVC)
+    list(APPEND LIBCXXABI_CXX_FEATURE_FLAGS -D_DEBUG)
+  endif()
+  # On Release builds cmake automatically defines NDEBUG, so we
+  # explicitly undefine it:
+  if (uppercase_CMAKE_BUILD_TYPE STREQUAL "RELEASE")
+    list(APPEND LIBCXXABI_CXX_FEATURE_FLAGS -UNDEBUG)
+  endif()
+else()
+  if (NOT uppercase_CMAKE_BUILD_TYPE STREQUAL "RELEASE")
+    list(APPEND LIBCXXABI_CXX_FEATURE_FLAGS -DNDEBUG)
+  endif()
+endif()
+# Static library
+if (NOT LIBCXXABI_ENABLE_SHARED)
+  list(APPEND LIBCXXABI_CXX_FEATURE_FLAGS -D_LIBCPP_BUILD_STATIC)
+endif()
+
+# This is the _ONLY_ place where add_definitions is called.
+if (MSVC)
+  add_definitions(-D_CRT_SECURE_NO_WARNINGS)
+endif()
+
+string(REPLACE ";" " " LIBCXXABI_CXX_REQUIRED_FLAGS "${LIBCXXABI_CXX_REQUIRED_FLAGS}")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${LIBCXXABI_CXX_REQUIRED_FLAGS}")
+
+string(REPLACE ";" " " LIBCXXABI_CXX_WARNING_FLAGS "${LIBCXXABI_CXX_WARNING_FLAGS}")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${LIBCXXABI_CXX_WARNING_FLAGS}")
+
+string(REPLACE ";" " " LIBCXXABI_CXX_FEATURE_FLAGS "${LIBCXXABI_CXX_FEATURE_FLAGS}")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${LIBCXXABI_CXX_FEATURE_FLAGS}")
+
+#===============================================================================
+# Setup Source Code
+#===============================================================================
+
+include_directories(include)
+
+# Add source code. This also contains all of the logic for deciding linker flags
+# soname, etc...
+add_subdirectory(src)

cmake/config-ix.cmake

+include(CheckLibraryExists)
+include(CheckCXXCompilerFlag)
+
+# Check compiler flags
+check_cxx_compiler_flag(-std=c++11            LIBCXXABI_HAS_STDCXX11_FLAG)
+check_cxx_compiler_flag(-fPIC                 LIBCXXABI_HAS_FPIC_FLAG)
+check_cxx_compiler_flag(-nodefaultlibs        LIBCXXABI_HAS_NODEFAULTLIBS_FLAG)
+check_cxx_compiler_flag(-nostdinc++           LIBCXXABI_HAS_NOSTDINCXX_FLAG)
+check_cxx_compiler_flag(-Wall                 LIBCXXABI_HAS_WALL_FLAG)
+check_cxx_compiler_flag(-W                    LIBCXXABI_HAS_W_FLAG)
+check_cxx_compiler_flag(-Wno-unused-function  LIBCXXABI_HAS_WNO_UNUSED_FUNCTION_FLAG)
+check_cxx_compiler_flag(-Wno-unused-parameter LIBCXXABI_HAS_WNO_UNUSED_PARAMETER_FLAG)
+check_cxx_compiler_flag(-Wwrite-strings       LIBCXXABI_HAS_WWRITE_STRINGS_FLAG)
+check_cxx_compiler_flag(-Wno-long-long        LIBCXXABI_HAS_WNO_LONG_LONG_FLAG)
+check_cxx_compiler_flag(-pedantic             LIBCXXABI_HAS_PEDANTIC_FLAG)
+check_cxx_compiler_flag(-Werror               LIBCXXABI_HAS_WERROR_FLAG)
+check_cxx_compiler_flag(-Wno-error            LIBCXXABI_HAS_WNO_ERROR_FLAG)
+check_cxx_compiler_flag(-fno-rtti             LIBCXXABI_HAS_FNO_RTTI_FLAG)
+check_cxx_compiler_flag(/WX                   LIBCXXABI_HAS_WX_FLAG)
+check_cxx_compiler_flag(/WX-                  LIBCXXABI_HAS_NO_WX_FLAG)
+check_cxx_compiler_flag(/EHsc                 LIBCXXABI_HAS_EHSC_FLAG)
+check_cxx_compiler_flag(/EHs-                 LIBCXXABI_HAS_NO_EHS_FLAG)
+check_cxx_compiler_flag(/EHa-                 LIBCXXABI_HAS_NO_EHA_FLAG)
+check_cxx_compiler_flag(/GR-                  LIBCXXABI_HAS_NO_GR_FLAG)
+
+# Check libraries
+check_library_exists(c printf "" LIBCXXABI_HAS_C_LIB)

src/CMakeLists.txt

+# Get sources
+set(LIBCXXABI_SOURCES
+  abort_message.cpp
+  cxa_aux_runtime.cpp
+  cxa_default_handlers.cpp
+  cxa_demangle.cpp
+  cxa_exception.cpp
+  cxa_exception_storage.cpp
+  cxa_guard.cpp
+  cxa_handlers.cpp
+  cxa_new_delete.cpp
+  cxa_personality.cpp
+  cxa_unexpected.cpp
+  cxa_vector.cpp
+  cxa_virtual.cpp
+  exception.cpp
+  private_typeinfo.cpp
+  stdexcept.cpp
+  typeinfo.cpp
+)
+
+set(LIBCXXABI_HEADERS
+  ../include/cxxabi.h
+  ../include/libunwind.h
+  ../include/unwind.h
+)
+
+append_if(LIBCXXABI_HEADERS APPLE ../include/mach-o/compact_unwind_encoding.h)
+
+# Add all the headers to the project for IDEs.
+if (MSVC_IDE OR XCODE)
+  # Force them all into the headers dir on MSVC, otherwise they end up at
+  # project scope because they don't have extensions.
+  if (MSVC_IDE)
+    source_group("Header Files" FILES ${LIBCXXABI_HEADERS})
+  endif()
+endif()
+
+if (LIBCXXABI_ENABLE_SHARED)
+  add_library(cxxabi SHARED
+    ${LIBCXXABI_SOURCES}
+    ${LIBCXXABI_HEADERS}
+    )
+else()
+  add_library(cxxabi STATIC
+    ${LIBCXXABI_SOURCES}
+    ${LIBCXXABI_HEADERS}
+    )
+endif()
+
+if (LIBCXXABI_LIBCXX_INCLUDES)
+  include_directories("${LIBCXXABI_LIBCXX_INCLUDES}")
+elseif (NOT LIBCXXABI_BUILT_STANDALONE)
+  include_directories("${LLVM_MAIN_SRC_DIR}/projects/libcxx/include")
+else()
+  include_directories("${LLVM_INCLUDE_DIR}/c++/v1")
+endif()
+
+# Generate library list.
+set(libraries ${LIBCXXABI_CXX_ABI_LIBRARIES})
+append_if(libraries LIBCXXABI_HAS_C_LIB c)
+
+target_link_libraries(cxxabi ${libraries})
+
+# Setup flags.
+append_if(compile_flags LIBCXXABI_HAS_FPIC_FLAG -fPIC)
+append_if(link_flags LIBCXXABI_HAS_NODEFAULTLIBS_FLAG -nodefaultlibs)
+
+if ( APPLE )
+  if ( CMAKE_OSX_DEPLOYMENT_TARGET STREQUAL "10.6" )
+    list(APPEND compile_flags "-U__STRICT_ANSI__")
+    list(APPEND link_flags
+      "-compatibility_version 1"
+      "-current_version ${LIBCXXABI_VERSION}"
+      "-install_name /usr/lib/libc++abi.1.dylib"
+      "/usr/lib/libSystem.B.dylib")
+  else()
+    list(APPEND link_flags
+      "-compatibility_version 1"
+      "-install_name /usr/lib/libc++abi.1.dylib")
+  endif()
+endif()
+
+string(REPLACE ";" " " compile_flags "${compile_flags}")
+string(REPLACE ";" " " link_flags "${link_flags}")
+
+set_target_properties(cxxabi
+  PROPERTIES
+    COMPILE_FLAGS "${compile_flags}"
+    LINK_FLAGS    "${link_flags}"
+    OUTPUT_NAME   "c++abi"
+    VERSION       "1.0"
+    SOVERSION     "1"
+  )
+
+install(TARGETS cxxabi
+  LIBRARY DESTINATION lib
+  ARCHIVE DESTINATION lib
+  )

www/index.html

   <li><code>svn co http://llvm.org/svn/llvm-project/libcxxabi/trunk libcxxabi</code></li>
   </ul>
 
+  <p>To build:</p>
+  <ul>
+  <li>Check out libcxxabi into <code>llvm/projects</code></li>
+  <li><code>cd llvm</code></li>
+  <li><code>mkdir build &amp;&amp; cd build</code></li>
+  <li><code>cmake .. # on linux you may need to prefix with CC=clang CXX=clang++</code></li>
+  <li><code>make</code></li>
+  </ul>
+
+  <p>To do a standalone build:</p>
+  <ul>
+  <li><code>cd libcxxabi</code></li>
+  <li><code>mkdir build &amp;&amp; cd build</code></li>
+  <li><code>cmake -DLIBCXXABI_LIBCXX_PATH=path/to/libcxx .. # on linux you may need to prefix with CC=clang CXX=clang++</code></li>
+  <li><code>make</code></li>
+  </ul>
+
   <p>Send discussions to the
   (<a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">clang mailing list</a>).</p>