Adding support for sanitised builds

.github/workflows/sanitisers.yml

@@ -0,0 +1,200 @@
+name: Sanitiser Checks
+
+# on: workflow_dispatch
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  conan-cache:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    env:
+      HOST_TYPE: ci
+      REDIS_QUEUE_HOST: redis
+      REDIS_STATE_HOST: redis
+    container:
+      image: faasm/faabric:0.2.2
+    defaults:
+      run:
+        working-directory: /code/faabric
+    services:
+      redis:
+        image: redis
+    steps:
+      # --- Code update ---
+      - name: "Fetch ref"
+        run: git fetch origin ${GITHUB_REF}:ci-branch
+      - name: "Check out branch"
+        run: git checkout --force ci-branch
+      # --- Set-up ---
+      - name: "Ping redis"
+        run: redis-cli -h redis ping
+      # --- Build dependencies
+      - name: "Build dependencies to be shared by all sanitiser runs"
+        run: inv dev.cmake -b Debug
+      - name: "Upload built CMake dependencies"
+        uses: actions/upload-artifact@v2
+        with:
+          name: cmake-cache
+          path: /build/faabric
+
+  address-sanitiser:
+    if: github.event.pull_request.draft == false
+    needs: [conan-cache]
+    runs-on: ubuntu-latest
+    env:
+      HOST_TYPE: ci
+      REDIS_QUEUE_HOST: redis
+      REDIS_STATE_HOST: redis
+    container:
+      image: faasm/faabric:0.2.2
+    defaults:
+      run:
+        working-directory: /code/faabric
+    services:
+      redis:
+        image: redis
+    steps:
+      # --- Code update ---
+      - name: "Fetch ref"
+        run: git fetch origin ${GITHUB_REF}:ci-branch
+      - name: "Check out branch"
+        run: git checkout --force ci-branch
+      # --- Set-up ---
+      - name: "Ping redis"
+        run: redis-cli -h redis ping
+      # --- Build with thread sanitising
+      - name: "Download CMake dependencies"
+        uses: actions/download-artifact@v2
+        with:
+          name: cmake-cache
+          path: /build/faabric
+      - name: "Build tests with address sanitising"
+        run: inv dev.sanitise Address --noclean
+      - name: "Run tests with address sanitising on and print to stderr to file"
+        run: ./bin/faabric_tests > /dev/null
+        working-directory: /build/faabric/static
+        env:
+          ADSAN_OPTIONS: "verbosity=1:halt_on_error=1"
+
+  thread-sanitiser:
+    if: github.event.pull_request.draft == false
+    needs: [conan-cache]
+    runs-on: ubuntu-latest
+    env:
+      HOST_TYPE: ci
+      REDIS_QUEUE_HOST: redis
+      REDIS_STATE_HOST: redis
+    container:
+      image: faasm/faabric:0.2.2
+    defaults:
+      run:
+        working-directory: /code/faabric
+    services:
+      redis:
+        image: redis
+    steps:
+      # --- Code update ---
+      - name: "Fetch ref"
+        run: git fetch origin ${GITHUB_REF}:ci-branch
+      - name: "Check out branch"
+        run: git checkout --force ci-branch
+      # --- Set-up ---
+      - name: "Ping redis"
+        run: redis-cli -h redis ping
+      # --- Build with thread sanitising
+      - name: "Download CMake dependencies"
+        uses: actions/download-artifact@v2
+        with:
+          name: cmake-cache
+          path: /build/faabric
+      - name: "Build tests with thread sanitising"
+        run: inv dev.sanitise Thread --noclean
+      # --- Tests ---
+      - name: "Run tests with thread sanitising on and print stderr to file"
+        run: ./bin/faabric_tests > /dev/null
+        working-directory: /build/faabric/static
+        env:
+          TSAN_OPTIONS: "verbosity=1:halt_on_error=1"
+
+  undefined-sanitiser:
+    if: github.event.pull_request.draft == false
+    needs: [conan-cache]
+    runs-on: ubuntu-latest
+    env:
+      HOST_TYPE: ci
+      REDIS_QUEUE_HOST: redis
+      REDIS_STATE_HOST: redis
+    container:
+      image: faasm/faabric:0.2.2
+    defaults:
+      run:
+        working-directory: /code/faabric
+    services:
+      redis:
+        image: redis
+    steps:
+      # --- Code update ---
+      - name: "Fetch ref"
+        run: git fetch origin ${GITHUB_REF}:ci-branch
+      - name: "Check out branch"
+        run: git checkout --force ci-branch
+      # --- Set-up ---
+      - name: "Ping redis"
+        run: redis-cli -h redis ping
+      # --- Build with thread sanitising
+      - name: "Download CMake dependencies"
+        uses: actions/download-artifact@v2
+        with:
+          name: cmake-cache
+          path: /build/faabric
+      - name: "Build tests with undefined sanitising"
+        run: inv dev.sanitise Undefined --noclean
+      # --- Tests ---
+      - name: "Run tests with undefined sanitising on and print stderr to file"
+        run: ./bin/faabric_tests > /dev/null
+        working-directory: /build/faabric/static
+        env:
+          UBSAN_OPTIONS: "print_stacktrace=1:halt_on_error=1"
+
+  leak-sanitiser:
+    if: github.event.pull_request.draft == false
+    needs: [conan-cache]
+    runs-on: ubuntu-latest
+    env:
+      HOST_TYPE: ci
+      REDIS_QUEUE_HOST: redis
+      REDIS_STATE_HOST: redis
+    container:
+      image: faasm/faabric:0.2.2
+    defaults:
+      run:
+        working-directory: /code/faabric
+    services:
+      redis:
+        image: redis
+    steps:
+      # --- Code update ---
+      - name: "Fetch ref"
+        run: git fetch origin ${GITHUB_REF}:ci-branch
+      - name: "Check out branch"
+        run: git checkout --force ci-branch
+      # --- Set-up ---
+      - name: "Ping redis"
+        run: redis-cli -h redis ping
+      # --- Build with thread sanitising
+      - name: "Download CMake dependencies"
+        uses: actions/download-artifact@v2
+        with:
+          name: cmake-cache
+          path: /build/faabric
+      - name: "Build tests with leak sanitising"
+        run: inv dev.sanitise Leak --noclean
+      # --- Tests ---
+      - name: "Run tests with leak sanitising on and print stderr to file"
+        run: ./bin/faabric_tests > /dev/null
+        working-directory: /build/faabric/static

CMakeLists.txt

@@ -22,6 +22,19 @@ set(CMAKE_EXE_LINKER_FLAGS "-fuse-ld=lld")
 # Compile comamnds for clang tools
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
+# Set-up use of sanitisers
+if (FAABRIC_USE_SANITISER STREQUAL "Address")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address")
+elseif (FAABRIC_USE_SANITISER STREQUAL "Thread")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=thread")
+elseif (FAABRIC_USE_SANITISER STREQUAL "Undefined")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=undefined")
+elseif (FAABRIC_USE_SANITISER STREQUAL "Leak")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=leak")
+elseif (FAABRIC_USE_SANITISER STREQUAL "Memory")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=memory")
+endif()
+
 # Global include dir
 set(FAABRIC_INCLUDE_DIR ${CMAKE_CURRENT_LIST_DIR}/include)
 

tasks/dev.py

@@ -14,7 +14,7 @@
 
 
 @task
-def cmake(ctx, clean=False, shared=False, build="Debug"):
+def cmake(ctx, clean=False, shared=False, build="Debug", sanitise_mode="None"):
     """
     Configures the build
     """
@@ -40,6 +40,7 @@ def cmake(ctx, clean=False, shared=False, build="Debug"):
         "-DBUILD_SHARED_LIBS={}".format("ON" if shared else "OFF"),
         "-DCMAKE_CXX_COMPILER=/usr/bin/clang++-13",
         "-DCMAKE_C_COMPILER=/usr/bin/clang-13",
+        "-DFAABRIC_USE_SANITISER={}".format(sanitise_mode),
         PROJ_ROOT,
     ]
 
@@ -78,3 +79,25 @@ def install(ctx, target, shared=False):
         cwd=build_dir,
         shell=True,
     )
+
+
+@task
+def sanitise(ctx, mode, noclean=False, shared=False):
+    """
+    Build the tests with different sanitisers
+    """
+    mode_list = ["Address", "Thread", "Undefined", "Leak", "Memory"]
+    if mode not in mode_list:
+        print("Unrecognised sanitiser mode: {}".format(mode))
+        print("Sanitisier mode must be one in {}".format(mode_list))
+        return
+
+    cmake(
+        ctx,
+        clean=(not noclean),
+        shared=shared,
+        build="Debug",
+        sanitise_mode=mode,
+    )
+
+    cc(ctx, "faabric_tests", shared=shared)