Test static hwloc build on macos

.github/docker/ubuntu-20.04.Dockerfile

@@ -24,7 +24,6 @@ ARG BASE_DEPS="\
 
 # UMF's dependencies
 ARG UMF_DEPS="\
-	libjemalloc-dev \
 	libhwloc-dev \
 	libtbb-dev"
 
@@ -34,6 +33,7 @@ ARG TEST_DEPS="\
 
 # Miscellaneous for our builds/CI (optional)
 ARG MISC_DEPS="\
+	automake \
 	clang \
 	g++-7 \
 	python3-pip \

.github/docker/ubuntu-22.04.Dockerfile

@@ -24,7 +24,6 @@ ARG BASE_DEPS="\
 
 # UMF's dependencies
 ARG UMF_DEPS="\
-	libjemalloc-dev \
 	libhwloc-dev \
 	libtbb-dev"
 
@@ -34,6 +33,7 @@ ARG TEST_DEPS="\
 
 # Miscellaneous for our builds/CI (optional)
 ARG MISC_DEPS="\
+	automake \
 	clang \
 	python3-pip \
 	sudo \

.github/scripts/run-codespell.py

@@ -0,0 +1,40 @@
+"""
+ Copyright (C) 2024 Intel Corporation
+
+ Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
+ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+"""
+
+import subprocess  # nosec B404
+import logging
+import sys
+
+logging.basicConfig(
+    level=logging.INFO, format="[%(levelname)s]: [%(asctime)s] %(message)s"
+)
+
+
+def codespell_scan():
+    try:
+        codespell_result = subprocess.run(  # nosec
+            [
+                "codespell",
+                "-H",
+                "--quiet-level=3",
+                "--skip=./.git,./.venv,./.github/workflows/.spellcheck-conf.toml",
+            ],
+            text=True,
+            stdout=subprocess.PIPE,
+        )
+        if codespell_result.returncode != 0:
+            for line in codespell_result.stdout.splitlines():
+                logging.error(line.strip())
+            sys.exit(1)
+        else:
+            logging.info("No spelling errors found")
+    except subprocess.CalledProcessError as ex:
+        logging.error(ex)
+        sys.exit(1)
+
+
+codespell_scan()

.github/workflows/coverity.yml

@@ -31,7 +31,7 @@ jobs:
     - name: Install apt packages
       run: |
         sudo apt-get update
-        sudo apt-get install -y cmake hwloc libhwloc-dev libjemalloc-dev libnuma-dev libtbb-dev
+        sudo apt-get install -y cmake hwloc libhwloc-dev libnuma-dev libtbb-dev
 
     - name: Download Coverity
       run: |

.github/workflows/docs.yml

@@ -14,44 +14,14 @@ permissions:
   contents: read
 
 jobs:
-  build:
-    name: Build docs
-    runs-on: ${{ github.repository_owner == 'oneapi-src' && 'intel-ubuntu-22.04' || 'ubuntu-latest' }}
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-      with:
-        fetch-depth: 0
-
-    - name: Install doxygen
-      run: |
-        sudo apt-get update
-        sudo apt-get install -y doxygen
-
-    # Latest distros do not allow global pip installation
-    - name: Install Python requirements in venv
-      run: |
-        python3 -m venv .venv
-        . .venv/bin/activate
-        echo "$PATH" >> $GITHUB_PATH
-        python3 -m pip install -r third_party/requirements.txt
-
-    - name: Setup PATH for python
-      run: echo "$HOME/.local/bin" >> $GITHUB_PATH
-
-    - name: Build the documentation
-      working-directory: scripts
-      run: python3 generate_docs.py
-
-    - name: Upload artifact
-      uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8 # v3.0.0
-      with:
-        path: docs/html
+  DocsBuild:
+    uses: ./.github/workflows/reusable_docs_build.yml
+    with:
+      upload: true
 
-  deploy:
+  DocsDeploy:
     name: Deploy docs to GitHub Pages
-    needs: build
+    needs: DocsBuild
 
     permissions:
       pages: write

.github/workflows/nightly.yml

@@ -67,7 +67,7 @@ jobs:
     - name: Install apt packages
       run: |
         sudo apt-get update
-        sudo apt-get install -y cmake hwloc libhwloc-dev libjemalloc-dev libnuma-dev libtbb-dev valgrind
+        sudo apt-get install -y cmake hwloc libhwloc-dev libnuma-dev libtbb-dev valgrind
 
     - name: Configure CMake
       run: >

.github/workflows/reusable_basic.yml

@@ -7,8 +7,6 @@ permissions:
   contents: read
 
 env:
-  # for installation testing - it should match with version set in CMake
-  UMF_VERSION: 0.10.1
   BUILD_DIR : "${{github.workspace}}/build"
   INSTL_DIR : "${{github.workspace}}/../install-dir"
   COVERAGE_DIR : "${{github.workspace}}/coverage"
@@ -76,15 +74,15 @@ jobs:
             disable_hwloc: 'OFF'
             link_hwloc_statically: 'OFF'
           # test icx compiler
-          # - os: 'ubuntu-22.04'
-            # build_type: Release
-            # compiler: {c: icx, cxx: icpx}
-            # shared_library: 'ON'
-            # level_zero_provider: 'ON'
-            # cuda_provider: 'ON'
-            # install_tbb: 'ON'
-            # disable_hwloc: 'OFF'
-            # link_hwloc_statically: 'OFF'
+          - os: 'ubuntu-22.04'
+            build_type: Release
+            compiler: {c: icx, cxx: icpx}
+            shared_library: 'ON'
+            level_zero_provider: 'ON'
+            cuda_provider: 'ON'
+            install_tbb: 'ON'
+            disable_hwloc: 'OFF'
+            link_hwloc_statically: 'OFF'
           # test without installing TBB
           - os: 'ubuntu-22.04'
             build_type: Release
@@ -124,7 +122,7 @@ jobs:
     - name: Install apt packages
       run: |
         sudo apt-get update
-        sudo apt-get install -y clang cmake libnuma-dev libjemalloc-dev lcov
+        sudo apt-get install -y clang cmake libnuma-dev lcov
 
     - name: Install TBB apt package
       if: matrix.install_tbb == 'ON'
@@ -147,8 +145,10 @@ jobs:
     - name: Install libhwloc
       run: .github/scripts/install_hwloc.sh
 
-    - name: Set ptrace value for IPC test
-      run: sudo bash -c "echo 0 > /proc/sys/kernel/yama/ptrace_scope"
+    - name: Get UMF version
+      run: |
+        VERSION=$(git describe --tags --abbrev=0 | grep -oP '\d+\.\d+\.\d+')
+        echo "UMF_VERSION=$VERSION" >> $GITHUB_ENV
 
     - name: Configure build
       run: >
@@ -179,8 +179,7 @@ jobs:
     - name: Run tests
       working-directory: ${{env.BUILD_DIR}}
       run: |
-        ${{ matrix.compiler.cxx == 'icpx' && '. /opt/intel/oneapi/setvars.sh' || true }}
-        ctest --output-on-failure # run all tests for better coverage
+        LD_LIBRARY_PATH=${{env.BUILD_DIR}}/lib/ ctest --output-on-failure # run all tests for better coverage
 
     - name: Check coverage
       if:  ${{ matrix.build_type == 'Debug' && matrix.compiler.c == 'gcc' }}
@@ -209,7 +208,6 @@ jobs:
         --install-dir ${{env.INSTL_DIR}}
         --build-type ${{matrix.build_type}}
         --disjoint-pool
-        --jemalloc-pool
         ${{ matrix.install_tbb == 'ON' && matrix.disable_hwloc != 'ON' && matrix.shared_library == 'ON' && '--proxy' || '' }}
         --umf-version ${{env.UMF_VERSION}}
         ${{ matrix.shared_library == 'ON' && '--shared-library' || '' }}
@@ -267,6 +265,12 @@ jobs:
       run: vcpkg install
       shell: pwsh # Specifies PowerShell as the shell for running the script.
 
+    - name: Get UMF version
+      run: |
+        $version = (git describe --tags --abbrev=0 | Select-String -Pattern '\d+\.\d+\.\d+').Matches.Value
+        echo "UMF_VERSION=$version" >> $env:GITHUB_ENV
+      shell: pwsh
+
     - name: Configure build
       run: >
         cmake
@@ -300,7 +304,6 @@ jobs:
         --install-dir ${{env.INSTL_DIR}}
         --build-type ${{matrix.build_type}}
         --disjoint-pool
-        --jemalloc-pool
         ${{matrix.shared_library == 'ON' && '--proxy' || '' }}
         --umf-version ${{env.UMF_VERSION}}
         ${{ matrix.shared_library == 'ON' && '--shared-library' || ''}}
@@ -335,7 +338,7 @@ jobs:
         -B ${{env.BUILD_DIR}}
         -DCMAKE_INSTALL_PREFIX="${{env.INSTL_DIR}}"
         -DUMF_BUILD_SHARED_LIBRARY=ON
-        -DUMF_BUILD_EXAMPLES=OFF
+        -DUMF_BUILD_EXAMPLES=ON
         -DUMF_FORMAT_CODE_STYLE=OFF
         -DUMF_DEVELOPER_MODE=ON
         -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
@@ -378,7 +381,7 @@ jobs:
         -B ${{env.BUILD_DIR}}
         -DCMAKE_INSTALL_PREFIX="${{env.INSTL_DIR}}"
         -DUMF_BUILD_SHARED_LIBRARY=OFF
-        -DUMF_BUILD_EXAMPLES=OFF
+        -DUMF_BUILD_EXAMPLES=ON
         -DUMF_FORMAT_CODE_STYLE=OFF
         -DUMF_DEVELOPER_MODE=ON
         -DUMF_BUILD_LIBUMF_POOL_DISJOINT=ON
@@ -468,8 +471,17 @@ jobs:
         echo "$PATH" >> $GITHUB_PATH
         python3 -m pip install -r third_party/requirements.txt
 
+    - name: Install dependencies
+      run: brew install jemalloc tbb automake
+
     - name: Install hwloc
-      run: brew install hwloc jemalloc tbb
+      if: matrix.os == 'macos-14'
+      run: brew install hwloc
+
+    - name: Get UMF version
+      run: |
+        VERSION=$(git describe --tags --abbrev=0 | grep -Eo '\d+\.\d+\.\d+')
+        echo "UMF_VERSION=$VERSION" >> $GITHUB_ENV
 
     - name: Configure build
       run: >
@@ -484,6 +496,7 @@ jobs:
         -DUMF_BUILD_LIBUMF_POOL_JEMALLOC=ON
         -DUMF_BUILD_SHARED_LIBRARY=ON
         -DUMF_TESTS_FAIL_ON_SKIP=ON
+        ${{ matrix.os != 'macos-14' && '-DUMF_LINK_HWLOC_STATICALLY=ON' || '' }}
 
     - name: Build UMF
       run: cmake --build ${{env.BUILD_DIR}} -j $(sysctl -n hw.logicalcpu)
@@ -495,7 +508,6 @@ jobs:
         --install-dir ${{env.INSTL_DIR}}
         --build-type ${{env.BUILD_TYPE}}
         --disjoint-pool
-        --jemalloc-pool
         --proxy
         --umf-version ${{env.UMF_VERSION}}
         --shared-library

.github/workflows/reusable_benchmarks.yml

@@ -34,7 +34,7 @@ jobs:
         if: matrix.os == 'ubuntu-latest'
         run: |
           sudo apt-get update
-          sudo apt-get install -y cmake libhwloc-dev libnuma-dev libjemalloc-dev libtbb-dev
+          sudo apt-get install -y cmake libhwloc-dev libnuma-dev libtbb-dev
 
       - name: Initialize vcpkg
         if: matrix.os == 'windows-latest'

.github/workflows/reusable_checks.yml

@@ -21,15 +21,16 @@ jobs:
     - name: Install dependencies
       run: |
         sudo apt-get update
-        sudo apt-get install -y black cmake clang-format-15 cmake-format libhwloc-dev
+        sudo apt-get install -y black cmake clang-format-15 cmake-format libhwloc-dev doxygen
 
     # Latest distros do not allow global pip installation
     - name: Install Python requirements in venv
       run: |
         python3 -m venv .venv
         . .venv/bin/activate
         echo "$PATH" >> $GITHUB_PATH
-        python3 -m pip install bandit
+        python3 -m pip install -r third_party/requirements.txt
+        python3 -m pip install bandit codespell
 
     - name: Configure CMake
       run: >
@@ -52,11 +53,24 @@ jobs:
     - name: Check Python formatting
       run: cmake --build build --target black-format-check
 
+    - name: Run check-license
+      run: |
+        ./scripts/check_license/check_headers.sh . "Apache-2.0 WITH LLVM-exception" -v
+
     - name: Run a spell check
       uses: crate-ci/typos@b63f421581dce830bda2f597a678cb7776b41877 # v1.18.2
       with:
         config: ./.github/workflows/.spellcheck-conf.toml
 
+    - name: Run codespell
+      run: python3 ./.github/scripts/run-codespell.py
+
+    - name: Check spelling in docs
+      run: |
+        cmake -B build
+        cmake --build build --target docs
+        sphinx-build -b spelling ./build/docs_build/config ./build/docs_build/spelling_log -W
+
     # Run Bandit recursively, but omit _deps directory (with 3rd party code) and python's venv
     - name: Run Bandit
       run: python3 -m bandit -r . -x '/_deps/,/.venv/'

.github/workflows/reusable_codeql.yml

@@ -62,7 +62,7 @@ jobs:
       if: matrix.os == 'ubuntu-latest'
       run: |
         sudo apt-get update
-        sudo apt-get install -y cmake clang libhwloc-dev libnuma-dev libjemalloc-dev libtbb-dev
+        sudo apt-get install -y cmake clang libhwloc-dev libnuma-dev libtbb-dev
 
     # Latest distros do not allow global pip installation
     - name: "[Lin] Install Python requirements in venv"

.github/workflows/reusable_dax.yml

@@ -31,6 +31,7 @@ env:
   INSTL_DIR : "${{github.workspace}}/../install-dir"
   COVERAGE_DIR : "${{github.workspace}}/coverage"
   COVERAGE_NAME : "exports-coverage-dax"
+  DAX_TESTS: "./test/umf_test-provider_file_memory ./test/umf_test-provider_devdax_memory"
 
 jobs:
   dax:
@@ -106,8 +107,6 @@ jobs:
           UMF_TESTS_FSDAX_PATH_2=${{env.UMF_TESTS_FSDAX_PATH_2}}
           ctest -C ${{matrix.build_type}} -V -R "file|fsdax"
 
-      # TODO: enable the provider_devdax_memory_ipc test when the IPC tests with the proxy library are fixed
-      # see the issue: https://github.com/oneapi-src/unified-memory-framework/issues/864
       - name: Run the DEVDAX tests with the proxy library
         # proxy library is built only if libumf is a shared library
         if: ${{ matrix.shared_library == 'ON' }}
@@ -116,10 +115,8 @@ jobs:
           LD_PRELOAD=./lib/libumf_proxy.so
           UMF_TESTS_DEVDAX_PATH="/dev/dax${{env.DEVDAX_NAMESPACE}}"
           UMF_TESTS_DEVDAX_SIZE="$(ndctl list --namespace=namespace${{env.DEVDAX_NAMESPACE}} | grep size | cut -d':' -f2 | cut -d',' -f1)"
-          ctest -C ${{matrix.build_type}} -V -R devdax -E provider_devdax_memory_ipc
+          ctest -C ${{matrix.build_type}} -V -R devdax
 
-      # TODO: enable the provider_file_memory_ipc test when the IPC tests with the proxy library are fixed
-      # see the issue: https://github.com/oneapi-src/unified-memory-framework/issues/864
       - name: Run the FSDAX tests with the proxy library
         # proxy library is built only if libumf is a shared library
         if: ${{ matrix.shared_library == 'ON' }}
@@ -128,7 +125,13 @@ jobs:
           LD_PRELOAD=./lib/libumf_proxy.so
           UMF_TESTS_FSDAX_PATH=${{env.UMF_TESTS_FSDAX_PATH}}
           UMF_TESTS_FSDAX_PATH_2=${{env.UMF_TESTS_FSDAX_PATH_2}}
-          ctest -C ${{matrix.build_type}} -V -R "file|fsdax" -E provider_file_memory_ipc
+          ctest -C ${{matrix.build_type}} -V -R "file|fsdax"
+
+      - name: Run DAX tests under valgrind
+        run: |
+          ${{github.workspace}}/test/test_valgrind.sh ${{github.workspace}} ${{env.BUILD_DIR}} memcheck "${{env.DAX_TESTS}}"
+          ${{github.workspace}}/test/test_valgrind.sh ${{github.workspace}} ${{env.BUILD_DIR}} drd "${{env.DAX_TESTS}}"
+          ${{github.workspace}}/test/test_valgrind.sh ${{github.workspace}} ${{env.BUILD_DIR}} helgrind "${{env.DAX_TESTS}}"
 
       - name: Check coverage
         if:  ${{ matrix.build_type == 'Debug' }}