Add ability to build with Clang on macOS

.github/composite-actions/download-libraries/action.yml

@@ -11,11 +11,31 @@ inputs:
     description: 'Download googletest'
     default: true
 
-  install-boost:
+  install-boost-gcc:
     type: boolean
-    description: 'Install boost'
+    description: 'Install boost built with GCC'
     default: true
 
+  install-boost-clang:
+    type: boolean
+    description: 'Install boost built with clang'
+    default: false
+
+  install-boost-brew-clang:
+    type: boolean
+    description: 'Install boost built with Homebrew Clang'
+    default: false
+
+  install-gcc:
+    type: boolean
+    description: 'Install GCC toolset (compiler and build tools)'
+    default: true
+
+  install-clang:
+    type: boolean
+    description: 'Install clang toolset (compiler and build tools)'
+    default: false
+
 runs:
   using: 'composite'
   steps:
@@ -25,6 +45,19 @@ runs:
         sudo apt-get update -y
         sudo apt-get install gcc-10 g++-10 cmake build-essential -y
       shell: bash
+      if: inputs.install-gcc != 'false'
+
+    - name: Install clang
+      # llvm.sh installs all needed libraries, no need in build-essential
+      # "all" option is needed to install libc++ and libc++abi
+      run: |
+        sudo apt-get update -y
+        sudo apt-get install cmake make -y
+        wget https://apt.llvm.org/llvm.sh
+        chmod +x llvm.sh
+        sudo ./llvm.sh 17 all
+      shell: bash
+      if: inputs.install-clang != 'false'
 
     - name: Make lib directory
       run: |
@@ -35,7 +68,7 @@ runs:
       uses: ./.github/composite-actions/download-library
       with:
         directory: googletest
-        download-command: git clone https://github.com/google/googletest/ --branch release-1.12.1 --depth 1
+        download-command: git clone https://github.com/google/googletest/ --branch v1.14.0 --depth 1
       if: inputs.download-googletest != 'false'
 
     - name: Download easyloggingpp
@@ -72,13 +105,34 @@ runs:
         directory: boost
         download-command: wget -O boost_1_81_0.tar.gz https://sourceforge.net/projects/boost/files/boost/1.81.0/boost_1_81_0.tar.gz/download && tar xzvf boost_1_81_0.tar.gz && mv boost_1_81_0 boost
 
-    - name: Install Boost
+    - name: Install Boost built with GCC
       run: |
         cd lib/boost
         ./bootstrap.sh --prefix=/usr
         sudo ./b2 install --prefix=/usr
       shell: bash
-      if: inputs.install-boost != 'false'
+      if: inputs.install-boost-gcc != 'false'
+    - name: Install Boost built with clang
+      run: |
+        cd lib/boost
+        ./bootstrap.sh --prefix=/usr --with-toolset=clang
+        ./b2 clean
+        ./b2 toolset=clang cxxflags="-stdlib=libc++" linkflags="-stdlib=libc++"
+        sudo ./b2 install --prefix=/usr
+      shell: bash
+      if: inputs.install-boost-clang != 'false'
+    - name: Install Boost built with Homebrew Clang
+      # b2 doesn't recognize custom compilers, so some trick is needed:
+      # Also, /usr is read-only, so install into /usr/local
+      run: |
+        cd lib/boost
+        export PATH=$(brew --prefix llvm@17)/bin:$PATH
+        ./bootstrap.sh --prefix=/usr/local --with-toolset=clang
+        ./b2 clean
+        ./b2 toolset=clang cxxflags="-std=c++11 -stdlib=libc++" linkflags="-stdlib=libc++"
+        sudo ./b2 install --prefix=/usr/local
+      shell: bash
+      if: inputs.install-boost-brew-clang != 'false'
     - name: Download frozen
       uses: ./.github/composite-actions/download-library
       with:

.github/workflows/core-tests.yml

@@ -27,7 +27,7 @@ on:
       #- examples/**
   workflow_dispatch:
 jobs:
-  run_tests:
+  run_tests_gcc:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -44,6 +44,81 @@ jobs:
         uses: ./.github/composite-actions/download-datasets
       - name: Build
         run: |
+          export CC=gcc-10
+          export CXX=g++-10
+          if [[ "${{matrix.cfg.BUILD_TYPE}}" == "Debug" ]]; then
+            ./build.sh --debug --sanitizer=${{ matrix.cfg.SANITIZER }}
+          else
+            ./build.sh
+          fi
+      - name: Test
+        working-directory: ${{github.workspace}}/build/target
+        shell: bash
+        run: ./Desbordante_test --gtest_filter='*:-*HeavyDatasets*'
+  run_tests_clang:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        cfg:
+          - { BUILD_TYPE: Release }
+          - { BUILD_TYPE: Debug }
+          - { BUILD_TYPE: Debug, SANITIZER : ADDRESS }
+          - { BUILD_TYPE: Debug, SANITIZER : UB }
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download libraries
+        uses: ./.github/composite-actions/download-libraries
+        with:
+          install-gcc: false
+          install-clang: true
+          install-boost-gcc: false
+          install-boost-clang: true
+      - name: Download datasets
+        uses: ./.github/composite-actions/download-datasets
+      - name: Build
+        run: |
+          export CC=clang-17
+          export CXX=clang++-17
+          export CXXFLAGS="-stdlib=libc++"
+          export LDFLAGS="-lc++abi"
+          if [[ "${{matrix.cfg.BUILD_TYPE}}" == "Debug" ]]; then
+            ./build.sh --debug --sanitizer=${{ matrix.cfg.SANITIZER }}
+          else
+            ./build.sh
+          fi
+      - name: Test
+        working-directory: ${{github.workspace}}/build/target
+        shell: bash
+        run: ./Desbordante_test --gtest_filter='*:-*HeavyDatasets*'
+  run_tests_macos_clang:
+    runs-on: macos-14
+    strategy:
+      matrix:
+        cfg:
+          - { BUILD_TYPE: Release }
+          - { BUILD_TYPE: Debug }
+          - { BUILD_TYPE: Debug, SANITIZER : ADDRESS }
+          - { BUILD_TYPE: Debug, SANITIZER : UB }
+    steps:
+      - uses: actions/checkout@v3
+      - name: Download build system
+        run: brew install llvm@17 make
+        shell: bash
+      - name: Download libraries
+        uses: ./.github/composite-actions/download-libraries
+        with:
+          install-gcc: false
+          install-clang: false
+          install-boost-gcc: false
+          install-boost-clang: false
+          install-boost-brew-clang: true
+      - name: Download datasets
+        uses: ./.github/composite-actions/download-datasets
+      - name: Build
+        run: |
+          export CC=$(brew --prefix llvm@17)/bin/clang
+          export CXX=$(brew --prefix llvm@17)/bin/clang++
+          export BOOST_ROOT=/usr/local
           if [[ "${{matrix.cfg.BUILD_TYPE}}" == "Debug" ]]; then
             ./build.sh --debug --sanitizer=${{ matrix.cfg.SANITIZER }}
           else

.github/workflows/wheel.yml

@@ -75,7 +75,7 @@ jobs:
         with:
           download-pybind: true
           download-googletest: false
-          install-boost: false
+          install-boost-gcc: false
 
       - name: Build wheels
         uses: pypa/[email protected]

CMakeLists.txt

@@ -66,6 +66,22 @@ else()
     if (ASAN)
         # Set DEBUG build options specific for build with ASAN
         set(ASAN_OPTS "-fsanitize=address")
+
+        find_program(APT_FOUND apt-get)
+        if (APT_FOUND AND CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+            # alloc-dealloc-mismatch generates false positives on boost exceptions
+            # This applies only to Ubuntu package:
+            # https://github.com/llvm/llvm-project/issues/59432?ysclid=m4y0iqca2c577414782
+            # Disable this check on files listed in address_sanitizer_ignore_list.txt if compiler
+            # is Clang and apt-get is installed on system:
+            # FIXME(senichenkov): apt-get is not an ideal check -- maybe it wouldn't be so hard to
+            # ask apt-get if repository is ubuntu-...?
+            message("Running on Ubuntu")
+            message(WARNING "ASAN is broken in Ubuntu package, therefore alloc-dealloc-mismatch")
+            message(WARNING "check will be supressed. Consider using another distro for full ASAN coverage.")
+            string(JOIN ";" ASAN_OPTS "-fsanitize-ignorelist=${CMAKE_SOURCE_DIR}/address_sanitizer_ignore_list.txt")
+        endif()
+
         string(JOIN ";" DEBUG_BUILD_OPTS "${DEBUG_BUILD_OPTS}"
             "-O1"
             "-Wno-error" # Use of -Werror is discouraged with sanitizers
@@ -81,6 +97,12 @@ else()
             "-fno-sanitize=signed-integer-overflow" # Remove this when CustomRandom gets fixed
             "-fno-sanitize=shift" # Remove this when CustomRandom gets fixed
             "-fno-sanitize-recover=all") # For tests to fail if UBSan finds an error
+        if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND CMAKE_HOST_APPLE)
+            # Limit some UB sanitizer checks to "src" directory on macOS when building with Clang,
+            # because libraries (STL, googletest, boost, etc.) are somehow broken
+            string(JOIN ";" UBSAN_OPTS
+                "-fsanitize-ignorelist=${CMAKE_SOURCE_DIR}/ub_sanitizer_ignore_list.txt")
+        endif()
         string(JOIN ";" DEBUG_BUILD_OPTS "${DEBUG_BUILD_OPTS}"
             "-O1"
             "${UBSAN_OPTS}")
@@ -95,6 +117,16 @@ else()
         add_compile_options(-ggdb3)
     endif()
 
+    # Workaround clang-18 bug:
+    # https://github.com/llvm/llvm-project/issues/76515?ysclid=m406q4it5k674680045
+    if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+        string(FIND "${CMAKE_CXX_COMPILER_VERSION}" "18" IDX)
+        if (IDX EQUAL 0)  # clang major version is 18
+            message(WARNING "C++ compiler is Clang++-18. Supressing deprecated declaration warnings. Consider using another version of Clang")
+            string(JOIN ";" DEBUG_BUILD_OPTS "${DEBUG_BUILD_OPTS}" "-Wno-deprecated-declarations")
+        endif()
+    endif()
+
     add_compile_options("$<$<CONFIG:Debug>:${DEBUG_BUILD_OPTS}>")
     add_link_options("$<$<CONFIG:Debug>:${DEBUG_LINK_OPTS}>")
 
@@ -122,7 +154,7 @@ include_directories(SYSTEM "lib/easyloggingpp/src" "lib/better-enums/" "lib/emha
 
 # adding submodules
 if (COMPILE_TESTS)
-    add_subdirectory("lib/googletest")
+    add_subdirectory("lib/googletest" SYSTEM)
 endif()
 
 set( CMAKE_BUILD_TYPE_COPY "${CMAKE_BUILD_TYPE}" )