Some CI and cmake changes (#9)

Author: jeremy-rifkin

.clang-tidy

@@ -0,0 +1,6 @@
+---
+Checks: '-*,clang-diagnostic-*,clang-analyzer-*,bugprone-*,cert-*,clang-analyzer-*,concurrency-*,cppcoreguidelines-*,misc-*,modernize-*,performance-*,portability-*,readability-*,-cppcoreguidelines-macro-usage,-modernize-use-trailing-return-type,-misc-non-private-member-variables-in-classes,-cppcoreguidelines-pro-type-reinterpret-cast,-cppcoreguidelines-pro-type-vararg,-cppcoreguidelines-avoid-c-arrays,-modernize-avoid-c-arrays,-cppcoreguidelines-pro-bounds-pointer-arithmetic,-readability-else-after-return,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-cert-dcl50-cpp,-cppcoreguidelines-init-variables,-readability-implicit-bool-conversion,-cppcoreguidelines-pro-bounds-constant-array-index,-cppcoreguidelines-owning-memory,-cppcoreguidelines-pro-type-member-init,-readability-isolate-declaration,-cppcoreguidelines-avoid-magic-numbers,-readability-magic-numbers,-cppcoreguidelines-pro-type-union-access,-cppcoreguidelines-pro-type-cstyle-cast,-readability-named-parameter,-cppcoreguidelines-avoid-goto,-readability-uppercase-literal-suffix,-performance-avoid-endl,-bugprone-easily-swappable-parameters'
+WarningsAsErrors: '*'
+HeaderFilterRegex: ''
+AnalyzeTemporaryDtors: false
+FormatStyle: none

.github/workflows/build.yml

@@ -43,7 +43,7 @@ jobs:
             -D${{matrix.symbols}}=On \
             -D${{matrix.demangle}}=On \
             -DCPPTRACE_BACKTRACE_PATH=/usr/lib/gcc/x86_64-linux-gnu/10/include/backtrace.h
-           make
+           make -j
   build-macos:
     runs-on: macos-13
     strategy:
@@ -79,7 +79,7 @@ jobs:
             -D${{matrix.unwind}}=On \
             -D${{matrix.symbols}}=On \
             -D${{matrix.demangle}}=On
-           make
+           make -j
   build-windows:
     runs-on: windows-2019
     strategy:
@@ -143,7 +143,7 @@ jobs:
             -DCMAKE_CXX_STANDARD=${{matrix.std}} \
             -DCPPTRACE_BACKTRACE_PATH=/usr/lib/gcc/x86_64-linux-gnu/10/include/backtrace.h \
             ${{matrix.config}}
-           make
+           make -j
   build-macos-full-or-auto:
     runs-on: macos-13
     strategy:
@@ -164,7 +164,7 @@ jobs:
             -DCMAKE_CXX_COMPILER=${{matrix.compiler}} \
             -DCMAKE_CXX_STANDARD=${{matrix.std}} \
             ${{matrix.config}}
-           make
+           make -j
   # TODO: -DCMAKE_CXX_STANDARD isn't being honored?
   # build-linux-full-or-auto-23:
   #   runs-on: ubuntu-22.04

.github/workflows/lint.yml

@@ -0,0 +1,18 @@
+name: lint
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: dependencies
+      run: |
+           sudo apt install clang-tidy
+    - name: clang-tidy
+      run: |
+           chmod +x lint.sh
+           ./lint.sh -DCPPTRACE_BACKTRACE_PATH=\"/usr/lib/gcc/x86_64-linux-gnu/10/include/backtrace.h\"

.github/workflows/performance-tests.yml

@@ -37,7 +37,7 @@ jobs:
             -DCPPTRACE_BACKTRACE_PATH=/usr/lib/gcc/x86_64-linux-gnu/11/include/backtrace.h \
             -DCPPTRACE_BUILD_SPEEDTEST=On \
             -DBUILD_SHARED_LIBS=On
-           make
+           make -j
     - name: test
       working-directory: build
       run: |

.github/workflows/test.yml

@@ -48,7 +48,7 @@ jobs:
             -DCPPTRACE_BUILD_TEST=On \
             $(if [ "${{matrix.symbols}}" = "CPPTRACE_GET_SYMBOLS_WITH_LIBDL" ]; then echo "-DCPPTRACE_BUILD_TEST_RDYNAMIC=On"; else echo ""; fi) \
             -DBUILD_SHARED_LIBS=On
-           make
+           make -j
     - name: test
       working-directory: build
       run: |
@@ -91,7 +91,7 @@ jobs:
             -DCPPTRACE_BUILD_TEST=On \
             $(if [ "${{matrix.symbols}}" = "CPPTRACE_GET_SYMBOLS_WITH_LIBDL" ]; then echo "-DCPPTRACE_BUILD_TEST_RDYNAMIC=On"; else echo ""; fi) \
             -DBUILD_SHARED_LIBS=On
-           make
+           make -j
     - name: test
       working-directory: build
       run: |
@@ -168,7 +168,7 @@ jobs:
             ${{matrix.config}} \
             -DCPPTRACE_BUILD_TEST=On \
             -DBUILD_SHARED_LIBS=On
-           make
+           make -j
     - name: test
       working-directory: build
       run: |
@@ -195,7 +195,7 @@ jobs:
             ${{matrix.config}} \
             -DCPPTRACE_BUILD_TEST=On \
             -DBUILD_SHARED_LIBS=On
-           make
+           make -j
     - name: test
       working-directory: build
       run: |

.gitignore

@@ -1,6 +1,4 @@
 .vscode
-build
-build2
 a.out
-test/build
-repro*/
+build*
+repro*

CMakeLists.txt

@@ -6,7 +6,7 @@ endif()
 
 project(
   cpptrace
-  VERSION 1.0.0
+  VERSION 0.0.1
   LANGUAGES CXX
 )
 
@@ -28,6 +28,7 @@ target_include_directories(
   $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/cpptrace/cpptrace>
 )
 
+# TODO
 target_compile_features(
   cpptrace
   PUBLIC
@@ -44,7 +45,8 @@ set_target_properties(
 target_compile_options(
   cpptrace
   PRIVATE
-  $<$<NOT:$<CXX_COMPILER_ID:MSVC>>:-Wall -Wextra -Werror=return-type -Wshadow>
+  $<$<NOT:$<CXX_COMPILER_ID:MSVC>>:-Wall -Wextra -Werror=return-type -Wshadow -Wundef>
+  $<$<CXX_COMPILER_ID:GNU>:-Wuseless-cast -Wnonnull-compare>
   $<$<CXX_COMPILER_ID:MSVC>:/W4 /WX /permissive->
 )
 

include/cpptrace/cpptrace.hpp

@@ -1,7 +1,6 @@
 #ifndef CPPTRACE_HPP
 #define CPPTRACE_HPP
 
-#include <cstddef>
 #include <cstdint>
 #include <string>
 #include <vector>

lint.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+status=0
+while read f
+do
+    echo checking $f
+    flags="-DCPPTRACE_FULL_TRACE_WITH_LIBBACKTRACE -DCPPTRACE_FULL_TRACE_WITH_STACKTRACE -DCPPTRACE_GET_SYMBOLS_WITH_LIBBACKTRACE -DCPPTRACE_GET_SYMBOLS_WITH_LIBDL -DCPPTRACE_GET_SYMBOLS_WITH_ADDR2LINE -DCPPTRACE_GET_SYMBOLS_WITH_NOTHING -DCPPTRACE_UNWIND_WITH_EXECINFO -DCPPTRACE_UNWIND_WITH_NOTHING -DCPPTRACE_DEMANGLE_WITH_CXXABI -DCPPTRACE_DEMANGLE_WITH_NOTHING"
+    clang-tidy $f -- -std=c++11 -Iinclude $@ $flags
+    ret=$?
+    if [ $ret -ne 0 ]; then
+        status=1
+    fi
+done <<< $(find include src -name "*.hpp" -o -name "*.cpp" -not -path "test/speedtest.cpp" -not -path "src/full/full_trace_with_stacktrace.cpp")
+exit $status

src/cpptrace.cpp

@@ -1,6 +1,7 @@
 #include <cpptrace/cpptrace.hpp>
 
 #include <cstddef>
+#include <cstdint>
 #include <string>
 #include <vector>
 #include <iostream>
@@ -48,13 +49,13 @@ namespace cpptrace {
 namespace cpptrace {
     void print_trace(std::uint32_t skip) {
         std::cerr<<"Stack trace (most recent call first):"<<std::endl;
-        std::size_t i = 0;
+        std::size_t counter = 0;
         const auto trace = generate_trace(skip + 1);
         // +1 to skip one frame
         for(auto it = trace.begin() + 1; it != trace.end(); it++) {
             const auto& frame = *it;
             std::cerr
-                << i++
+                << counter++
                 << " "
                 << frame.filename
                 << ":"

src/demangle/cpptrace_demangle.hpp

@@ -1,8 +1,6 @@
 #ifndef CPPTRACE_DEMANGLE_HPP
 #define CPPTRACE_DEMANGLE_HPP
 
-#include <cpptrace/cpptrace.hpp>
-
 #include <string>
 
 namespace cpptrace {

src/demangle/demangle_with_cxxabi.cpp

@@ -1,6 +1,5 @@
 #ifdef CPPTRACE_DEMANGLE_WITH_CXXABI
 
-#include <cpptrace/cpptrace.hpp>
 #include "cpptrace_demangle.hpp"
 
 #include <cxxabi.h>
@@ -14,9 +13,10 @@ namespace cpptrace {
             int status;
             char* demangled = abi::__cxa_demangle(name.c_str(), nullptr, nullptr, &status);
             if(demangled) {
-                std::string s = demangled;
+                std::string str = demangled;
+                // NOLINTNEXTLINE(cppcoreguidelines-no-malloc)
                 free(demangled);
-                return s;
+                return str;
             } else {
                 return name;
             }

src/demangle/demangle_with_nothing.cpp

@@ -1,9 +1,7 @@
 #ifdef CPPTRACE_DEMANGLE_WITH_NOTHING
 
-#include <cpptrace/cpptrace.hpp>
 #include "cpptrace_demangle.hpp"
 
-#include <cstdlib>
 #include <string>
 
 namespace cpptrace {

src/full/full_trace_with_libbacktrace.cpp

@@ -1,10 +1,11 @@
 #ifdef CPPTRACE_FULL_TRACE_WITH_LIBBACKTRACE
 
 #include <cpptrace/cpptrace.hpp>
-#include "cpptrace_full_trace.hpp"
 #include "../platform/cpptrace_program_name.hpp"
 #include "../platform/cpptrace_common.hpp"
 
+#include <cstddef>
+#include <cstdint>
 #include <vector>
 
 #ifdef CPPTRACE_BACKTRACE_PATH
@@ -16,7 +17,9 @@
 namespace cpptrace {
     namespace detail {
         struct trace_data {
+            // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members)
             std::vector<stacktrace_frame>& frames;
+            // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members)
             size_t& skip;
         };
 
@@ -47,6 +50,7 @@ namespace cpptrace {
 
         backtrace_state* get_backtrace_state() {
             // backtrace_create_state must be called only one time per program
+            // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
             static backtrace_state* state = nullptr;
             static bool called = false;
             if(!called) {
@@ -67,7 +71,7 @@ namespace cpptrace {
                     // fallback, try to at least recover the symbol name with backtrace_syminfo
                     backtrace_syminfo(
                         get_backtrace_state(),
-                        reinterpret_cast<uintptr_t>(frame.address),
+                        frame.address,
                         syminfo_callback,
                         error_callback,
                         &frame

src/platform/cpptrace_common.hpp

@@ -13,16 +13,21 @@
 #define CPPTRACE_MAYBE_UNUSED __attribute__((unused))
 #endif
 
-#include <stdlib.h>
-#include <stdio.h>
+#include <cstdint>
+#include <cstdio>
+#include <cstdlib>
+#include <ios>
+#include <sstream>
 #include <string>
+#include <utility>
 #include <vector>
-#include <sstream>
 
 // Lightweight std::source_location.
 struct source_location {
+    // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members)
     const char* const file;
     //const char* const function; // disabled for now due to static constexpr restrictions
+    // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members)
     const int line;
     constexpr source_location(
         //const char* _function /*= __builtin_FUNCTION()*/,
@@ -44,14 +49,20 @@ static void primitive_assert_impl(
         const char* action = verify ? "verification" : "assertion";
         const char* name   = verify ? "verify"       : "assert";
         if(message == nullptr) {
-            fprintf(stderr, "Cpptrace %s failed at %s:%d: %s\n",
-                action, location.file, location.line, signature);
+            (void) fprintf(
+                stderr,
+                "Cpptrace %s failed at %s:%d: %s\n",
+                action, location.file, location.line, signature
+            );
         } else {
-            fprintf(stderr, "Cpptrace %s failed at %s:%d: %s: %s\n",
-                action, location.file, location.line, signature, message);
+            (void) fprintf(
+                stderr,
+                "Cpptrace %s failed at %s:%d: %s: %s\n",
+                action, location.file, location.line, signature, message
+            );
         }
-        fprintf(stderr, "    primitive_%s(%s);\n", name, expression);
-        abort();
+        (void) fprintf(stderr, "    primitive_%s(%s);\n", name, expression);
+        std::abort();
     }
 }
 
@@ -70,15 +81,15 @@ void nothing() {}
 #endif
 
 CPPTRACE_MAYBE_UNUSED
-static std::vector<std::string> split(const std::string& s, const std::string& delims) {
+static std::vector<std::string> split(const std::string& str, const std::string& delims) {
     std::vector<std::string> vec;
     size_t old_pos = 0;
     size_t pos = 0;
-    while((pos = s.find_first_of(delims, old_pos)) != std::string::npos) {
-        vec.emplace_back(s.substr(old_pos, pos - old_pos));
+    while((pos = str.find_first_of(delims, old_pos)) != std::string::npos) {
+        vec.emplace_back(str.substr(old_pos, pos - old_pos));
         old_pos = pos + 1;
     }
-    vec.emplace_back(std::string(s.substr(old_pos)));
+    vec.emplace_back(str.substr(old_pos));
     return vec;
 }
 
@@ -98,22 +109,22 @@ static std::string join(const C& container, const std::string& delim) {
     return str;
 }
 
-constexpr const char* const ws = " \t\n\r\f\v";
+constexpr const char* const whitespace = " \t\n\r\f\v";
 
 CPPTRACE_MAYBE_UNUSED
-static std::string trim(const std::string& s) {
-    if(s == "") {
+static std::string trim(const std::string& str) {
+    if(str.empty()) {
         return "";
     }
-    size_t l = s.find_first_not_of(ws);
-    size_t r = s.find_last_not_of(ws) + 1;
-    return s.substr(l, r - l);
+    const size_t left = str.find_first_not_of(whitespace);
+    const size_t right = str.find_last_not_of(whitespace) + 1;
+    return str.substr(left, right - left);
 }
 
 CPPTRACE_MAYBE_UNUSED
 static std::string to_hex(uintptr_t addr) {
     std::stringstream sstream;
-    sstream<<std::hex<<uintptr_t(addr);
+    sstream<<std::hex<<addr;
     return std::move(sstream).str();
 }