Merge development into f-SolverConfigParams

Author: fabianbs96

.clang-tidy

@@ -5,12 +5,16 @@ Checks: '-*,
            -misc-non-private-member-variables-in-classes,
            -misc-no-recursion,
          readability-*,
+           -readability-function-cognitive-complexity,
            -readability-else-after*,
            -readability-simplify-boolean-expr,
            -readability-implicit-bool-cast,
            -readability-static-definition-in-anonymous-namespace,
            -readability-implicit-bool-conversion,
            -readability-magic-numbers,
+           -readability-function-cognitive-complexity,
+           -readability-convert-member-functions-to-static,
+           -readability-isolate-declaration,
          cppcoreguidelines-*,
            -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
            -cppcoreguidelines-owning-memory,
@@ -20,8 +24,10 @@ Checks: '-*,
            -cppcoreguidelines-init-variables,
            -cppcoreguidelines-macro-usage,
          bugprone-*,
+           -bugprone-easily-swappable-parameters,
          modernize-*,
            -modernize-use-trailing-return-type,
+           -modernize-pass-by-value,
          performance-*,
          clang-analyzer-*,
         '
@@ -43,6 +49,10 @@ CheckOptions:
     value:           CamelCase
   - key:             readability-identifier-naming.VariableCase
     value:           CamelCase
+  - key:             readability-identifier-naming.VariableIgnoredRegexp
+    value:           (c|d|d1|d2|d3|d4|d5|d5_restoredCtx|eP|f|f3|f4|f5|fCalleeSummary|g|n|dPrime|fPrime)
+  - key:             readability-identifier-naming.ParameterIgnoredRegexp
+    value:           (d|d1|d2|d3|d4|d5|eP|f|n)
   - key:             cppcoreguidelines-special-member-functions.AllowSoleDefaultDtor
     value:           1
   - key:             cppcoreguidelines-special-member-functions.AllowMissingMoveFunctions

.github/workflows/ci.yml

@@ -0,0 +1,75 @@
+name: Phasar CI
+
+on:
+  push:
+    branches: [ master, development ]
+  pull_request:
+    branches: [ master, development ]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: true
+      matrix:
+        compiler: [ [clang++-12, clang-12] ]
+        build: [ Debug, Release ]
+
+    continue-on-error: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          submodules: recursive
+
+      - name: Install Basic Dependencies
+        shell: bash
+        run: |
+          sudo apt-get update
+          sudo apt-get -y install --no-install-recommends \
+              cmake \
+              ninja-build \
+              libstdc++6 \
+              libboost-all-dev
+
+      - name: Install Phasar Dependencies
+        shell: bash
+        run: |
+          ./utils/InstallAptDependencies.sh
+
+      - name: Install Strategy Dependencies
+        shell: bash
+        run: |
+          sudo apt-key adv --fetch-keys https://apt.llvm.org/llvm-snapshot.gpg.key
+          sudo add-apt-repository -y 'deb http://apt.llvm.org/focal/ llvm-toolchain-focal-12 main'
+          sudo apt-get update
+          sudo apt-get -y install --no-install-recommends \
+              ${{ matrix.compiler[1] }} \
+              llvm-12-dev \
+              libllvm12 \
+              libclang-common-12-dev \
+              libclang-12-dev \
+              libclang-cpp12-dev \
+              clang-tidy-12
+
+      - name: Building Phasar in ${{ matrix.build }} with ${{ matrix.compiler[0] }}
+        env:
+          BUILD_TYPE: ${{ matrix.build }}
+          CXX: ${{ matrix.compiler[0] }}
+          CC: ${{ matrix.compiler[1] }}
+        shell: bash
+        run: |
+          mkdir build
+          cd build
+          cmake .. \
+            -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
+            -DCMAKE_CXX_COMPILER=$CXX \
+            -G Ninja
+          cmake --build .
+
+      - name: Run Unittests
+        shell: bash
+        run: |
+          cd build
+          cmake --build . --target check-phasar-unittests

.github/workflows/pre-commit.yml

@@ -0,0 +1,18 @@
+name: pre-commit
+
+on:
+  pull_request:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - uses: actions/setup-python@v2
+
+    - uses: pre-commit/action@v2.0.0
+      with:
+        extra_args: --from-ref origin/development --to-ref HEAD

.github/workflows/reviewdog-clang-format.yml

@@ -0,0 +1,51 @@
+name: Phasar clang-format review runner
+
+on:
+  pull_request:
+    branches: [ master, development ]
+
+jobs:
+  format:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        tool: [ clang-format ]
+        include:
+          - tool: clang-format
+            install: |
+              sudo apt-key adv --fetch-keys https://apt.llvm.org/llvm-snapshot.gpg.key
+              sudo add-apt-repository -y 'deb http://apt.llvm.org/focal/ llvm-toolchain-focal-12 main'
+              sudo apt-get update
+              sudo apt-get -y install --no-install-recommends clang-format-12
+            regex: \.(h|c|hpp|cpp)$
+            command: clang-format-12 --style=file -i
+
+    continue-on-error: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Install Dependencies
+        shell: bash
+        run: ${{ matrix.install }}
+
+      - name: Fetch Base Branch
+        shell: bash
+        run: |
+          git fetch --depth=1 origin +refs/heads/${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}
+
+      - name: Run Tool
+        shell: bash
+        run: |
+          FILES=$(git diff --name-only --diff-filter=AM origin/${{ github.base_ref }} HEAD | egrep "${{ matrix.regex }}" || true)
+          [ -z "$FILES" ] || (${{ matrix.command }} $FILES && git diff --diff-filter=M $FILES)
+
+      - name: Add Suggestions
+        uses: reviewdog/action-suggester@v1
+        with:
+          tool_name: ${{ matrix.tool }}
+          filter_mode: diff_context
+          level: warning

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: requirements-txt-fixer
+-   repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: 'v12.0.1'
+    hooks:
+    -   id: clang-format

CMakeLists.txt

@@ -15,14 +15,22 @@ set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
+include(GNUInstallDirs)
+
 set_property(GLOBAL PROPERTY TARGET_MESSAGES OFF)
 
 if (NOT CMAKE_BUILD_TYPE)
-  set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Build mode ('Debug' or 'Release', default is 'Debug')" FORCE)
+  set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Build mode ('DebugSan' or 'Debug' or 'Release', default is 'Debug')" FORCE)
 endif ()
-if(CMAKE_BUILD_TYPE STREQUAL "Debug")
+
+if(CMAKE_BUILD_TYPE STREQUAL "DebugSan")
+  message(STATUS "Selected Debug Build with sanitizers")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -MP -fvisibility-inlines-hidden -fstack-protector-strong -ffunction-sections -fdata-sections -pipe -g -fno-omit-frame-pointer -fsanitize=address,undefined")
+elseif(CMAKE_BUILD_TYPE STREQUAL "Debug")
+  message(STATUS "Selected Debug Build")
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -MP -fvisibility-inlines-hidden -fstack-protector-strong -ffunction-sections -fdata-sections -pipe -g")
 else()
+  message(STATUS "Selected Release Build")
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -MP -fvisibility-inlines-hidden -fstack-protector-strong -ffunction-sections -fdata-sections -pipe -march=native")
 endif()
 
@@ -41,7 +49,6 @@ file(STRINGS ${PHASAR_SRC_DIR}/include/phasar/Config/Version.h VERSION_NUMBER_FI
 string(REPLACE " " ";" VERSION_NUMBER_FILE ${VERSION_NUMBER_FILE})
 list(GET VERSION_NUMBER_FILE 2 VERSION_NUMBER_PHASAR)
 
-
 include("phasar_macros")
 
 option(PHASAR_BUILD_UNITTESTS "Build all tests (default is ON)" ON)
@@ -50,6 +57,8 @@ option(PHASAR_BUILD_OPENSSL_TS_UNITTESTS "Build OPENSSL typestate tests (require
 
 option(PHASAR_BUILD_IR "Build IR test code (default is ON)" ON)
 
+option(PHASAR_ENABLE_CLANG_TIDY_DURING_BUILD "Run clang-tidy during build (default is OFF)" OFF)
+
 option(PHASAR_BUILD_DOC "Build documentation" OFF)
 
 option(PHASAR_DEBUG_LIBDEPS "Debug internal library dependencies (private linkage)" OFF)
@@ -94,12 +103,13 @@ endif()
 configure_file(config.h.in config.h @ONLY)
 include_directories(${CMAKE_CURRENT_BINARY_DIR})
 
-
 include_directories(
   ${PHASAR_SRC_DIR}/include
 )
 
-set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
+set(PHASAR_INSTALL_LIBDIR ${CMAKE_INSTALL_LIBDIR}/phasar)
+
+set(CMAKE_INSTALL_RPATH ${CMAKE_INSTALL_PREFIX}/${PHASAR_INSTALL_LIBDIR})
 set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
 
 if (LLVM_ENABLE_LIBCXX)
@@ -117,17 +127,38 @@ find_package(Boost 1.65.1 COMPONENTS filesystem graph system program_options log
 #find_package(Boost 1.72.0 COMPONENTS filesystem graph system program_options log ${BOOST_THREAD} REQUIRED)
 include_directories(${Boost_INCLUDE_DIRS})
 
-# JSON library
-option(JSON_BuildTests OFF)
-set(JSON_Install ON)
-add_subdirectory(external/json EXCLUDE_FROM_ALL)
+# Disable clang-tidy for the external projects
+set(CMAKE_CXX_CLANG_TIDY "")
+
+# We need to work around the behavior of nlohmann_json_schema_validator and nlohmann_json here
+# The validator needs the json part, but if you include it, the library of nlohmann_json_schema_validator
+# is not installed, leading to linker error. But just including nlohmann_json is not sufficient, as
+# in the installed state the nlohmann_json_schema_validator needs the nlohmann_json package which needs
+# to be installed.
+# The following workaround may collapse or become unnecessary once the issue is
+# changed or fixed in nlohmann_json_schema_validator.
+
+#Override option of nlohmann_json_schema_validator to not build its tests
+set(BUILD_TESTS OFF CACHE BOOL "Build json-schema-validator-tests")
+
+# Make nlohmann_json_schema_validator happy by telling it how to find the single include of nlohmann_json
 include_directories(external/json/single_include/)
 
-# JSON Schema Validator
-set(BUILD_TESTS OFF)
-set(BUILD_EXAMPLES OFF)
-add_subdirectory(external/json-schema-validator EXCLUDE_FROM_ALL)
-include_directories(external/json-schema-validator/src)
+if (PHASAR_IN_TREE)
+  set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS nlohmann_json_schema_validator)
+endif()
+
+set(nlohmann_json_DIR ${PHASAR_SRC_DIR}/external/json/single_include/)
+
+# Json Schema Validator
+set(JSON_VALIDATOR_INSTALL ON)
+add_subdirectory(external/json-schema-validator)
+include_directories(external/json-schema-validator/src/)
+
+# now we finally add the subdirectory
+set(JSON_BuildTests OFF)
+set(JSON_Install ON)
+add_subdirectory(external/json)
 
 # Googletest
 if (NOT PHASAR_IN_TREE)
@@ -166,7 +197,7 @@ endif()
 # Clang
 # The clang-cpp shared library is now the preferred way to link dynamically against libclang if we build out of tree.
 if(NOT PHASAR_IN_TREE)
-  find_library(CLANG_LIBRARY NAMES clang-cpp REQUIRED HINTS ${LLVM_LIBRARY_DIRS})
+  find_library(CLANG_LIBRARY NAMES clang-cpp libclang-cpp REQUIRED HINTS ${LLVM_LIBRARY_DIRS})
   if(${CLANG_LIBRARY} STREQUAL "CLANG_LIBRARY-NOTFOUND")
     set(NEED_LIBCLANG_COMPONENT_LIBS on)
   endif()
@@ -214,8 +245,17 @@ endif()
 add_subdirectory(external/WALi-OpenNWA)
 include_directories(external/WALi-OpenNWA/Source/wali/include)
 
+# Set up clang-tidy to run during PhASAR's compilation to indicate code smells
+if (PHASAR_ENABLE_CLANG_TIDY_DURING_BUILD)
+  message(STATUS "Enabled clang-tidy during build")
+  set(CMAKE_CXX_CLANG_TIDY
+    clang-tidy;
+    -header-filter=include/phasar.*h$;
+    # -warnings-as-errors=*;
+  )
+endif ()
 
-# Add the Phasar subdirectories
+# Add PhASAR's subdirectories
 add_subdirectory(include)
 add_subdirectory(lib)