ci.yml

name: CI

on:
  push:
    branches: [main]
  pull_request:
  workflow_dispatch:

concurrency:
  group: ci-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

env:
  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"
  CMAKE_BUILD_PARALLEL_LEVEL: "2"
  URING_UARCH_SHA: 9bb51fa7ef3ce69745f076595e3ccc1eb31e50d3

jobs:
  cli-and-lint:
    name: CLI, format, and tidy
    runs-on: ubuntu-24.04
    timeout-minutes: 90
    env:
      URING_CLANG_TIDY_BIN: clang-tidy-23
    steps:
      - name: Checkout sources
        uses: actions/checkout@v5
        with:
          persist-credentials: false
      - name: Install system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y build-essential ca-certificates ccache curl git gnupg ninja-build pkg-config python3 xz-utils
          curl -fsSL https://apt.llvm.org/llvm-snapshot.gpg.key | sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc >/dev/null
          echo "deb http://apt.llvm.org/noble/ llvm-toolchain-noble-23 main" | sudo tee /etc/apt/sources.list.d/llvm.list >/dev/null
          sudo apt-get update
          sudo apt-get install -y clang-tidy-23
      - name: Install CMake 4.0+
        uses: lukka/get-cmake@latest
        with:
          cmakeVersion: latest
      - name: Install uv
        uses: astral-sh/setup-uv@v6
        with:
          enable-cache: true
      - name: Cache prebuilt toolchains
        uses: actions/cache@v4
        with:
          path: ~/.local/toolchain
          key: uring-toolchain-v0.0.1-ubuntu22-${{ runner.os }}
          restore-keys: |
            uring-toolchain-v0.0.1-ubuntu22-${{ runner.os }}
      - name: Fetch uarch
        run: |
          set -euo pipefail
          rm -rf "${RUNNER_TEMP}/uarch"
          git init -q "${RUNNER_TEMP}/uarch"
          git -C "${RUNNER_TEMP}/uarch" remote add origin https://github.com/trunkszi/uarch.git
          git -C "${RUNNER_TEMP}/uarch" fetch --depth 1 origin "${URING_UARCH_SHA}"
          git -C "${RUNNER_TEMP}/uarch" checkout --detach FETCH_HEAD
      - name: Provision toolchains
        run: |
          set -euo pipefail
          for sdk in clang-glibc gcc-glibc; do
            cmake -S . -B "${{ runner.temp }}/provision-${sdk}" -G Ninja \
              -DURING_TOOLCHAIN_NAME="${sdk}" \
              -DURING_UARCH_SOURCE_DIR="${RUNNER_TEMP}/uarch" \
              -DURING_BUILD_TESTS=OFF \
              -DURING_BUILD_EXAMPLES=OFF \
              -DURING_BUILD_TOOLS=OFF \
              -DURING_BUILD_BENCHES=OFF \
              -DCMAKE_BUILD_TYPE=Release
          done
      - name: Install uarch
        run: |
          set -euo pipefail
          prefix="${RUNNER_TEMP}/uarch-prefix"
          compiler="${HOME}/.local/toolchain/clang-glibc/bin/clang++"
          test -x "${compiler}"
          cmake -S "${RUNNER_TEMP}/uarch" -B "${RUNNER_TEMP}/uarch-build" -G Ninja \
            -DCMAKE_BUILD_TYPE=Release \
            -DCMAKE_CXX_COMPILER="${compiler}" \
            -DCMAKE_INSTALL_PREFIX="${prefix}" \
            -DUARCH_BUILD_TESTS=OFF \
            -DUARCH_BUILD_EXAMPLES=OFF \
            -DUARCH_BUILD_TOOLS=OFF \
            -DUARCH_BUILD_BENCHES=OFF \
            -DUARCH_AUTO_DOWNLOAD_TOOLCHAIN=OFF
          cmake --build "${RUNNER_TEMP}/uarch-build" --target uarch_detect --parallel 2
          cmake --install "${RUNNER_TEMP}/uarch-build"
          echo "CMAKE_PREFIX_PATH=${prefix}" >> "${GITHUB_ENV}"
      - name: Sync the CLI environment
        run: uv sync --locked --directory scripts/cli
      - name: CLI unit tests
        run: python3 -m unittest discover -s scripts/cli/tests
      - name: Check formatting
        run: ./uring format --check
      - name: Clang-tidy
        run: |
          clang-tidy-23 --version
          clang-tidy-23 --verify-config
          ./uring tidy --preset clang-glibc-release

  release-and-verify:
    name: release ${{ matrix.toolchain }}
    runs-on: ubuntu-24.04
    timeout-minutes: 120
    strategy:
      fail-fast: false
      matrix:
        toolchain: [clang-glibc, gcc-glibc, clang-musl, gcc-musl]
    steps:
      - name: Checkout sources
        uses: actions/checkout@v5
        with:
          persist-credentials: false
      - name: Install system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y build-essential ccache git ninja-build pkg-config python3 xz-utils
      - name: Install CMake 4.0+
        uses: lukka/get-cmake@latest
        with:
          cmakeVersion: latest
      - name: Install uv
        uses: astral-sh/setup-uv@v6
        with:
          enable-cache: true
      - name: Cache prebuilt toolchains
        uses: actions/cache@v4
        with:
          path: ~/.local/toolchain
          key: uring-toolchain-v0.0.1-ubuntu22-${{ runner.os }}-${{ matrix.toolchain }}
          restore-keys: |
            uring-toolchain-v0.0.1-ubuntu22-${{ runner.os }}-
      - name: Fetch uarch
        run: |
          set -euo pipefail
          rm -rf "${RUNNER_TEMP}/uarch"
          git init -q "${RUNNER_TEMP}/uarch"
          git -C "${RUNNER_TEMP}/uarch" remote add origin https://github.com/trunkszi/uarch.git
          git -C "${RUNNER_TEMP}/uarch" fetch --depth 1 origin "${URING_UARCH_SHA}"
          git -C "${RUNNER_TEMP}/uarch" checkout --detach FETCH_HEAD
      - name: Provision toolchains
        run: |
          set -euo pipefail
          seen=""
          for sdk in clang-glibc gcc-glibc ${{ matrix.toolchain }}; do
            case " ${seen} " in
              *" ${sdk} "*) continue ;;
            esac
            seen="${seen} ${sdk}"
            cmake -S . -B "${{ runner.temp }}/provision-${sdk}" -G Ninja \
              -DURING_TOOLCHAIN_NAME="${sdk}" \
              -DURING_UARCH_SOURCE_DIR="${RUNNER_TEMP}/uarch" \
              -DURING_BUILD_TESTS=OFF \
              -DURING_BUILD_EXAMPLES=OFF \
              -DURING_BUILD_TOOLS=OFF \
              -DURING_BUILD_BENCHES=OFF \
              -DCMAKE_BUILD_TYPE=Release
          done
      - name: Install uarch
        run: |
          set -euo pipefail
          prefix="${RUNNER_TEMP}/uarch-prefix"
          case "${{ matrix.toolchain }}" in
            clang-glibc) compiler="${HOME}/.local/toolchain/clang-glibc/bin/clang++" ;;
            gcc-glibc) compiler="${HOME}/.local/toolchain/gcc-glibc/bin/x86_64-unknown-linux-gnu-g++" ;;
            clang-musl) compiler="${HOME}/.local/toolchain/clang-musl/bin/x86_64-unknown-linux-musl-clang++" ;;
            gcc-musl) compiler="${HOME}/.local/toolchain/gcc-musl/bin/x86_64-unknown-linux-musl-g++" ;;
          esac
          test -x "${compiler}"
          cmake -S "${RUNNER_TEMP}/uarch" -B "${RUNNER_TEMP}/uarch-build" -G Ninja \
            -DCMAKE_BUILD_TYPE=Release \
            -DCMAKE_CXX_COMPILER="${compiler}" \
            -DCMAKE_INSTALL_PREFIX="${prefix}" \
            -DUARCH_BUILD_TESTS=OFF \
            -DUARCH_BUILD_EXAMPLES=OFF \
            -DUARCH_BUILD_TOOLS=OFF \
            -DUARCH_BUILD_BENCHES=OFF \
            -DUARCH_AUTO_DOWNLOAD_TOOLCHAIN=OFF
          cmake --build "${RUNNER_TEMP}/uarch-build" --target uarch_detect --parallel 2
          cmake --install "${RUNNER_TEMP}/uarch-build"
          echo "CMAKE_PREFIX_PATH=${prefix}" >> "${GITHUB_ENV}"
      - name: Sync the CLI environment
        run: uv sync --locked --directory scripts/cli
      - name: Release tests and verify
        run: |
          if [[ -r /proc/sys/kernel/io_uring_disabled && "$(cat /proc/sys/kernel/io_uring_disabled)" != "0" ]]; then
            sudo sysctl -w kernel.io_uring_disabled=0
          fi
          ulimit -l unlimited 2>/dev/null || true
          ./uring test --preset "${{ matrix.toolchain }}-release"
          ./uring verify all --preset "${{ matrix.toolchain }}-release"
      - name: Verify installed CMake package consumer
        run: |
          set -euo pipefail
          preset="${{ matrix.toolchain }}-release"
          prefix="${RUNNER_TEMP}/uring-prefix"
          compiler="$(sed -n 's/^CMAKE_CXX_COMPILER:[^=]*=//p' "build/${preset}/CMakeCache.txt")"
          test -n "${compiler}" && test -x "${compiler}"
          cmake --install "build/${preset}" --prefix "${prefix}"
          consumer="${RUNNER_TEMP}/uring-consumer"
          mkdir -p "${consumer}"
          cat > "${consumer}/CMakeLists.txt" <<'EOF'
          cmake_minimum_required(VERSION 3.30)
          project(uring_consumer LANGUAGES CXX)
          set(CMAKE_CXX_STANDARD 26)
          set(CMAKE_CXX_STANDARD_REQUIRED ON)
          set(CMAKE_CXX_EXTENSIONS OFF)
          find_package(uring CONFIG REQUIRED)
          add_executable(consumer main.cc)
          target_link_libraries(consumer PRIVATE uring::uring)
          uarch_configure_runtime(consumer)
          EOF
          cat > "${consumer}/main.cc" <<'EOF'
          #include <uring/uring.hpp>
          int main() {
            uring::ring::ScriptedRing ring(8);
            return ring.Params().sq_entries == 8U ? 0 : 1;
          }
          EOF
          cmake -S "${consumer}" -B "${consumer}/build" -G Ninja \
            -DCMAKE_CXX_COMPILER="${compiler}" \
            -DCMAKE_PREFIX_PATH="${prefix};${CMAKE_PREFIX_PATH}" \
            -DCMAKE_BUILD_TYPE=Release
          cmake --build "${consumer}/build"
          "${consumer}/build/consumer"

  sanitizers:
    name: ${{ matrix.preset }}
    runs-on: ubuntu-24.04
    timeout-minutes: 120
    strategy:
      fail-fast: false
      matrix:
        include:
          - preset: clang-glibc-asan-ubsan
            compiler: clang-glibc
          - preset: gcc-glibc-asan-ubsan
            compiler: gcc-glibc
    steps:
      - name: Checkout sources
        uses: actions/checkout@v5
        with:
          persist-credentials: false
      - name: Install system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y build-essential ccache git ninja-build pkg-config python3 xz-utils
      - name: Install CMake 4.0+
        uses: lukka/get-cmake@latest
        with:
          cmakeVersion: latest
      - name: Install uv
        uses: astral-sh/setup-uv@v6
        with:
          enable-cache: true
      - name: Cache prebuilt toolchains
        uses: actions/cache@v4
        with:
          path: ~/.local/toolchain
          key: uring-toolchain-v0.0.1-ubuntu22-${{ runner.os }}
          restore-keys: |
            uring-toolchain-v0.0.1-ubuntu22-${{ runner.os }}
      - name: Fetch uarch
        run: |
          set -euo pipefail
          rm -rf "${RUNNER_TEMP}/uarch"
          git init -q "${RUNNER_TEMP}/uarch"
          git -C "${RUNNER_TEMP}/uarch" remote add origin https://github.com/trunkszi/uarch.git
          git -C "${RUNNER_TEMP}/uarch" fetch --depth 1 origin "${URING_UARCH_SHA}"
          git -C "${RUNNER_TEMP}/uarch" checkout --detach FETCH_HEAD
      - name: Provision toolchains
        run: |
          set -euo pipefail
          seen=""
          for sdk in clang-glibc gcc-glibc ${{ matrix.compiler }}; do
            case " ${seen} " in
              *" ${sdk} "*) continue ;;
            esac
            seen="${seen} ${sdk}"
            cmake -S . -B "${{ runner.temp }}/provision-${sdk}" -G Ninja \
              -DURING_TOOLCHAIN_NAME="${sdk}" \
              -DURING_UARCH_SOURCE_DIR="${RUNNER_TEMP}/uarch" \
              -DURING_BUILD_TESTS=OFF \
              -DURING_BUILD_EXAMPLES=OFF \
              -DURING_BUILD_TOOLS=OFF \
              -DURING_BUILD_BENCHES=OFF \
              -DCMAKE_BUILD_TYPE=Release
          done
      - name: Install uarch
        run: |
          set -euo pipefail
          prefix="${RUNNER_TEMP}/uarch-prefix"
          case "${{ matrix.compiler }}" in
            clang-glibc) compiler="${HOME}/.local/toolchain/clang-glibc/bin/clang++" ;;
            gcc-glibc) compiler="${HOME}/.local/toolchain/gcc-glibc/bin/x86_64-unknown-linux-gnu-g++" ;;
          esac
          test -x "${compiler}"
          cmake -S "${RUNNER_TEMP}/uarch" -B "${RUNNER_TEMP}/uarch-build" -G Ninja \
            -DCMAKE_BUILD_TYPE=Release \
            -DCMAKE_CXX_COMPILER="${compiler}" \
            -DCMAKE_INSTALL_PREFIX="${prefix}" \
            -DUARCH_BUILD_TESTS=OFF \
            -DUARCH_BUILD_EXAMPLES=OFF \
            -DUARCH_BUILD_TOOLS=OFF \
            -DUARCH_BUILD_BENCHES=OFF \
            -DUARCH_AUTO_DOWNLOAD_TOOLCHAIN=OFF
          cmake --build "${RUNNER_TEMP}/uarch-build" --target uarch_detect --parallel 2
          cmake --install "${RUNNER_TEMP}/uarch-build"
          echo "CMAKE_PREFIX_PATH=${prefix}" >> "${GITHUB_ENV}"
      - name: Sync the CLI environment
        run: uv sync --locked --directory scripts/cli
      - name: Sanitizer tests
        run: |
          if [[ -r /proc/sys/kernel/io_uring_disabled && "$(cat /proc/sys/kernel/io_uring_disabled)" != "0" ]]; then
            sudo sysctl -w kernel.io_uring_disabled=0
          fi
          ulimit -l unlimited 2>/dev/null || true
          ./uring test --preset "${{ matrix.preset }}"
      - name: Verify installed CMake package consumer
        run: |
          set -euo pipefail
          preset="${{ matrix.preset }}"
          prefix="${RUNNER_TEMP}/uring-prefix"
          compiler="$(sed -n 's/^CMAKE_CXX_COMPILER:[^=]*=//p' "build/${preset}/CMakeCache.txt")"
          test -n "${compiler}" && test -x "${compiler}"
          cmake --install "build/${preset}" --prefix "${prefix}"
          consumer="${RUNNER_TEMP}/uring-consumer"
          mkdir -p "${consumer}"
          cat > "${consumer}/CMakeLists.txt" <<'EOF'
          cmake_minimum_required(VERSION 3.30)
          project(uring_consumer LANGUAGES CXX)
          set(CMAKE_CXX_STANDARD 26)
          set(CMAKE_CXX_STANDARD_REQUIRED ON)
          set(CMAKE_CXX_EXTENSIONS OFF)
          find_package(uring CONFIG REQUIRED)
          add_executable(consumer main.cc)
          target_link_libraries(consumer PRIVATE uring::uring)
          uarch_configure_runtime(consumer)
          EOF
          cat > "${consumer}/main.cc" <<'EOF'
          #include <uring/uring.hpp>
          int main() {
            uring::ring::ScriptedRing ring(8);
            return ring.Params().sq_entries == 8U ? 0 : 1;
          }
          EOF
          cmake -S "${consumer}" -B "${consumer}/build" -G Ninja \
            -DCMAKE_CXX_COMPILER="${compiler}" \
            -DCMAKE_PREFIX_PATH="${prefix};${CMAKE_PREFIX_PATH}" \
            -DCMAKE_BUILD_TYPE=Release
          cmake --build "${consumer}/build"
          "${consumer}/build/consumer"