fixes #10 - more portable linking of libbfd (#11)

* more portable linking of libbfd

* add optional linux dependency binutils-dev to build script

Author: d99kris

CMakeLists.txt

@@ -1,9 +1,9 @@
 # Project
 cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
 project(heapusage VERSION 1.0 LANGUAGES C CXX)
-set(COMMON_FLAGS "-funwind-tables -g -Wall -Wextra -Wpedantic -Wshadow -Wpointer-arith -Wcast-qual \
-                  -Wno-missing-braces -Wswitch-default -Wcast-align -Wunreachable-code -Wundef \
-                  -Wuninitialized")
+set(COMMON_FLAGS "-funwind-tables -g -Wall -Wextra -Wpedantic -Wshadow -Wpointer-arith \
+                  -Wcast-qual -Wno-missing-braces -Wswitch-default -Wcast-align \
+                  -Wunreachable-code -Wuninitialized")
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=c99 ${COMMON_FLAGS} -Wstrict-prototypes \
                    -Wmissing-prototypes")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMMON_FLAGS}")
@@ -13,22 +13,19 @@ set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
-# Optional dependency - binutils / binutils-dev - for filename/line-numbers in callstacks
-include(FindPackageHandleStandardArgs)
-find_path(BFD_INCLUDE_PATH bfd.h PATH /usr/include /usr/local/include /usr/local/opt/*/include)
-find_library(BFD_LIBRARIES bfd PATH /lib /usr/lib /usr/local/lib /usr/local/opt/*/lib)
-find_package_handle_standard_args(BFD DEFAULT_MSG BFD_LIBRARIES BFD_INCLUDE_PATH)
-if(BFD_FOUND)
-  set(EXTRA_LIBRARIES "${BFD_LIBRARIES}")
-  include_directories("ext/backward-cpp" ${BFD_INCLUDE_DIR})
-  add_definitions(-DHAS_BFD)
-endif()
-
 # Library
 add_library(heapusage SHARED src/humain.cpp src/hulog.cpp src/humalloc.cpp)
 target_compile_features(heapusage PRIVATE cxx_variadic_templates)
 install(TARGETS heapusage LIBRARY DESTINATION lib)
-target_link_libraries(heapusage ${EXTRA_LIBRARIES} pthread dl)
+target_link_libraries(heapusage pthread dl)
+
+# Dependency backward-cpp providing more detailed stacktraces on Linux, when
+# either of the following is present (only ONE needed):
+#   libbfd    - sudo apt install binutils-dev
+#   libdw     - sudo apt install libdw-dev
+#   libdwarf  - sudo apt install libdwarf-dev
+add_subdirectory(ext/backward-cpp)
+add_backward(heapusage)
 
 # Utility
 configure_file(src/heapusage ${CMAKE_CURRENT_BINARY_DIR}/heapusage COPYONLY)

make.sh

@@ -70,7 +70,7 @@ if [[ "${DEPS}" == "1" ]]; then
   if [ "${OS}" == "Linux" ]; then
     DISTRO="$(lsb_release -i | awk -F':\t' '{print $2}')"
     if [[ "${DISTRO}" == "Ubuntu" ]]; then
-      true || exiterr "deps failed (linux), exiting."
+      sudo apt update && sudo apt -y install build-essential cmake binutils-dev || exiterr "deps failed (linux), exiting."
     else
       exiterr "deps failed (unsupported linux distro ${DISTRO}), exiting."
     fi

src/heapusage

@@ -46,7 +46,7 @@ showusage()
 
 showversion()
 {
-  echo "heapusage v2.01"
+  echo "heapusage v2.02"
   echo ""
   echo "Copyright (C) 2017-2021 Kristofer Berggren"
   echo ""

src/heapusage.1

@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man.
-.TH HEAPUSAGE "1" "November 2021" "heapusage v2.01" "User Commands"
+.TH HEAPUSAGE "1" "December 2021" "heapusage v2.02" "User Commands"
 .SH NAME
 heapusage \- find memory leaks in applications
 .SH SYNOPSIS

src/hulog.cpp

@@ -26,23 +26,11 @@
 #include <string>
 #include <vector>
 
-#ifdef HAS_BFD
-/* Silence warnings */
-#define BACKWARD_HAS_LIBUNWIND 0
-#define BACKWARD_HAS_UNWIND 0 
-#define BACKWARD_HAS_BACKTRACE 1
-#define BACKWARD_HAS_BACKTRACE_SYMBOL 1
-#define BACKWARD_HAS_DW 0
-#define BACKWARD_HAS_DWARF 0
 #if defined(__APPLE__)
 #define _XOPEN_SOURCE 0
 #define _POSIX_C_SOURCE 0
 #endif
-
-/* Backward cpp with bfd / binutils */
-#define BACKWARD_HAS_BFD 1
 #include "backward.hpp"
-#endif
 
 #include "hulog.h"
 #include "humain.h"
@@ -499,7 +487,7 @@ static std::string addr_to_symbol(void *addr)
   }
   else
   {
-#ifdef HAS_BFD
+#if (BACKWARD_HAS_BFD == 1) || (BACKWARD_HAS_DW == 1) || (BACKWARD_HAS_DWARF == 1)
     backward::TraceResolver trace_resolver;
     trace_resolver.load_addresses(&addr, 1);
     backward::Trace trace(addr, 0);