buildAndTestVitis.yml

# Copyright (C) 2023-2026 Advanced Micro Devices, Inc.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

name: Build and Test with Vitis 2025.1

permissions:
  contents: read

on:
  push:
    branches:
      - main
      - test-vitis
  pull_request:
  #merge_group:

  # Allows you to run this workflow manually from the Actions tab by
  # selecting CI and then "Run workflow" menu on the right branch
  # and clicking on "launch_tmate_terminal_for_debug".
  # Unfortunately this works only for the default branch.
  # So you can either
  # - change the default branch of the PR on the GitHub repository owning the PR
  #   and launching in Actions tab;
  # - or edit directly the step below which runs tmate and push to the
  #   PR, ignoring the manual workflow launch.
  workflow_dispatch:
      launch_tmate_terminal_for_debug:
        type: boolean
        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
        required: false
        default: false

defaults:
  run:
    shell: bash

concurrency:
  # A PR number if a pull request and otherwise the commit hash. This cancels
  # queued and in-progress runs for the same PR (presubmit) or commit
  # (postsubmit).
  group: ci-build-test-vitis-${{ github.event.number || github.sha }}-${{ github.event_name }}
  cancel-in-progress: true

env:
  DEBIAN_FRONTEND: noninteractive
  XILINXD_LICENSE_FILE: /opt/xilinx/Xilinx.lic
  VITIS: /opt/Xilinx/2025.1/Vitis
  CMAKE_ARGS: |
            -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
            -DCMAKE_C_COMPILER_LAUNCHER=ccache \
            -DCMAKE_EXE_LINKER_FLAGS_INIT="-fuse-ld=lld" \
            -DCMAKE_MODULE_LINKER_FLAGS_INIT="-fuse-ld=lld" \
            -DCMAKE_SHARED_LINKER_FLAGS_INIT="-fuse-ld=lld" \
            -DXRT_ROOT=/opt/xilinx/xrt \
            -DAIE_VITIS_COMPONENTS=AIE;AIE2 \
            -DAIE_ENABLE_PYTHON_PASSES=OFF \
            -DAIE_ENABLE_XRT_PYTHON_BINDINGS=ON
  LIT_OPTS: -sv --time-tests --timeout 600 --show-unsupported --show-excluded

jobs:
  build-tests:
    name: Run Tests on Vitis
    runs-on: ${{ matrix.runner_type }}
    strategy:
      fail-fast: false
      matrix:
        runner_type: [ ubuntu-vitis ]
    env:
      NPU_CACHE_HOME: ${{ github.workspace }}/iron-cache-${{ matrix.runner_type }}-${{ github.run_id }}
    steps:
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0  # v7.0.0
        with:
          submodules: "true"

      # Launch an ssh session via a proxy server if there is a need
      # for debug. This seems to live for 35 min max
      # https://github.com/mxschmitt/action-tmate
      - name: Setup tmate session
        uses: mxschmitt/action-tmate@35b54afac29c97fb54faba5b513f8fbd1882f113  # v3
        # To run this, launch it manually on the default branch and
        # click on "launch_tmate_terminal_for_debug"
        if: github.event_name == 'workflow_dispatch'
                && inputs.launch_tmate_terminal_for_debug

      - name: Run commands
        run: |
          sudo prlimit -lunlimited --pid $$
          pip cache purge
          source /opt/xilinx/xrt/setup.sh
          source ./utils/env_install.sh aie-venv --dev --extras

          sed -i.bak 's/OUTPUT_TIMEOUT = 10/OUTPUT_TIMEOUT = 100/g' \
            $(python -c 'import site; print(site.getsitepackages()[0])')/jupyter_client/runapp.py

          VERSION=$(utils/clone-llvm.sh --get-wheel-version)
          for attempt in 1 2 3; do
            rm -f mlir-*.whl
            if pip -q download mlir==$VERSION \
              -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/mlir-distro; then
              break
            fi
            if [ "$attempt" -eq 3 ]; then
              echo "Failed to download MLIR wheel after ${attempt} attempts" >&2
              exit 1
            fi
            sleep $((attempt * 5))
          done
          unzip -q mlir-*.whl
          # I have no clue why but the system clock on GHA containers is like 12 hours ahead.
          # That means wheels have file with time stamps in the future which makes ninja loop
          # forever when configuring. Set the time to some arbitrary stamp in the past just to be safe.
          find mlir -exec touch -a -m -t 201108231405.14 {} \;

          mkdir build
          pushd build

          # -j here to reduce the number of parallel chess jobs.
          LIT_OPTS="-j12 $LIT_OPTS"

          export PATH=$VITIS/bin:$VITIS/aietools/bin:$PATH

          cmake .. -G Ninja \
            -DCMAKE_BUILD_TYPE=Release \
            -DPython3_EXECUTABLE=$(which python) \
            -DLLVM_EXTERNAL_LIT=$(which lit) \
            -DCMAKE_INSTALL_PREFIX=$PWD/../mlir_aie \
            -DCMAKE_MODULE_PATH=$PWD/../cmake/modulesXilinx \
            -DMLIR_DIR=$PWD/../mlir/lib/cmake/mlir \
            $CMAKE_ARGS

          # Create runner-specific cache directory
          rm -rf $NPU_CACHE_HOME
          mkdir $NPU_CACHE_HOME

          ninja install
          ninja check-aie
          popd

      - name: Cleanup NPU_CACHE_HOME
        if: always()
        run: rm -rf $NPU_CACHE_HOME