Merge pull request #6947 from yandex/add_gdb_index

Add gdb index to builds with debug info

CMakeLists.txt

@@ -156,6 +156,26 @@ endif ()
 # Make sure the final executable has symbols exported
 set (CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -rdynamic")
 
+option (ADD_GDB_INDEX_FOR_GOLD "Set to add .gdb-index to resulting binaries for gold linker. NOOP if lld is used." 0)
+if (NOT CMAKE_BUILD_TYPE_UC STREQUAL "RELEASE")
+    if (LINKER_NAME STREQUAL "lld")
+        set (CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--gdb-index")
+        set (CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--gdb-index")
+        message (STATUS "Adding .gdb-index via --gdb-index linker option.")
+    # we use another tool for gdb-index, because gold linker removes section .debug_aranges, which used inside clickhouse stacktraces
+    # http://sourceware-org.1504.n7.nabble.com/gold-No-debug-aranges-section-when-linking-with-gdb-index-td540965.html#a556932
+    elseif (LINKER_NAME STREQUAL "gold" AND ADD_GDB_INDEX_FOR_GOLD)
+        find_program (GDB_ADD_INDEX_EXE NAMES "gdb-add-index" DOC "Path to gdb-add-index executable")
+        if (NOT GDB_ADD_INDEX_EXE)
+            set (USE_GDB_ADD_INDEX 0)
+            message (WARNING "Cannot add gdb index to binaries, because gold linker is used, but gdb-add-index executable not found.")
+        else()
+            set (USE_GDB_ADD_INDEX 1)
+            message (STATUS "gdb-add-index found: ${GDB_ADD_INDEX_EXE}")
+        endif()
+    endif ()
+endif()
+
 cmake_host_system_information(RESULT AVAILABLE_PHYSICAL_MEMORY QUERY AVAILABLE_PHYSICAL_MEMORY) # Not available under freebsd
 if(NOT AVAILABLE_PHYSICAL_MEMORY OR AVAILABLE_PHYSICAL_MEMORY GREATER 8000)
     option(COMPILER_PIPE "-pipe compiler option [less /tmp usage, more ram usage]" ON)
@@ -290,18 +310,6 @@ else ()
     set (CLICKHOUSE_ETC_DIR "${CMAKE_INSTALL_PREFIX}/etc")
 endif ()
 
-option (UNBUNDLED "Try find all libraries in system. We recommend to avoid this mode for production builds, because we cannot guarantee exact versions and variants of libraries your system has installed. This mode exists for enthusiastic developers who search for trouble. Also it is useful for maintainers of OS packages." OFF)
-if (UNBUNDLED)
-    set(NOT_UNBUNDLED 0)
-else ()
-    set(NOT_UNBUNDLED 1)
-endif ()
-
-# Using system libs can cause lot of warnings in includes.
-if (UNBUNDLED OR NOT (OS_LINUX OR APPLE) OR ARCH_32)
-    option (NO_WERROR "Disable -Werror compiler option" ON)
-endif ()
-
 message (STATUS "Building for: ${CMAKE_SYSTEM} ${CMAKE_SYSTEM_PROCESSOR} ${CMAKE_LIBRARY_ARCHITECTURE} ; USE_STATIC_LIBRARIES=${USE_STATIC_LIBRARIES} MAKE_STATIC_LIBRARIES=${MAKE_STATIC_LIBRARIES} SPLIT_SHARED=${SPLIT_SHARED_LIBRARIES} UNBUNDLED=${UNBUNDLED} CCACHE=${CCACHE_FOUND} ${CCACHE_VERSION}")
 
 include(GNUInstallDirs)

dbms/programs/CMakeLists.txt

@@ -205,6 +205,9 @@ else ()
 
     add_custom_target (clickhouse-bundle ALL DEPENDS ${CLICKHOUSE_BUNDLE})
 
+    if (USE_GDB_ADD_INDEX)
+        add_custom_command(TARGET clickhouse POST_BUILD COMMAND ${GDB_ADD_INDEX_EXE} clickhouse COMMENT "Adding .gdb-index to clickhouse" VERBATIM)
+    endif()
 endif ()
 
 if (TARGET clickhouse-server AND TARGET copy-headers)

dbms/programs/odbc-bridge/CMakeLists.txt

@@ -42,6 +42,10 @@ set_target_properties(clickhouse-odbc-bridge PROPERTIES RUNTIME_OUTPUT_DIRECTORY
 
 clickhouse_program_link_split_binary(odbc-bridge)
 
+if (USE_GDB_ADD_INDEX)
+    add_custom_command(TARGET clickhouse-odbc-bridge POST_BUILD COMMAND ${GDB_ADD_INDEX_EXE} ../clickhouse-odbc-bridge COMMENT "Adding .gdb-index to clickhouse-odbc-bridge" VERBATIM)
+endif()
+
 install(TARGETS clickhouse-odbc-bridge RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT clickhouse)
 
 if(ENABLE_TESTS)

docker/packager/binary/Dockerfile

@@ -55,7 +55,8 @@ RUN apt-get update -y \
             git \
             tzdata \
             gperf \
-            cmake
+            cmake \
+            gdb
 
 COPY build.sh /
 CMD ["/bin/bash", "/build.sh"]

docker/packager/deb/Dockerfile

@@ -78,8 +78,10 @@ RUN apt-get --allow-unauthenticated update -y \
             gperf \
             alien \
             libcapnp-dev \
-            cmake
+            cmake \
+            gdb
 
 
 COPY build.sh /
+
 CMD ["/bin/bash", "/build.sh"]

docker/packager/packager

@@ -105,7 +105,7 @@ def run_vagrant_box_with_env(image_path, output_dir, ch_root):
 
 def parse_env_variables(build_type, compiler, sanitizer, package_type, cache, distcc_hosts, unbundled, split_binary, version, author, official, alien_pkgs, with_coverage):
     result = []
-    cmake_flags = ['$CMAKE_FLAGS']
+    cmake_flags = ['$CMAKE_FLAGS', '-DADD_GDB_INDEX_FOR_GOLD=1']
 
     cc = compiler
     cxx = cc.replace('gcc', 'g++').replace('clang', 'clang++')