Add SHARK user guide to root of docs directory (archived) #1138
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Copyright 2024 Advanced Micro Devices, Inc. | |
| # | |
| # Licensed under the Apache License v2.0 with LLVM Exceptions. | |
| # See https://llvm.org/LICENSE.txt for license information. | |
| # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | |
| name: CI - shortfin - ASan | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| paths: | |
| - '.github/workflows/ci_linux_x64_asan-libshortfin.yml' | |
| - 'shortfin/**' | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - '.github/workflows/ci_linux_x64_asan-libshortfin.yml' | |
| - 'shortfin/**' | |
| permissions: | |
| contents: read | |
| 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). The workflow name is prepended to avoid conflicts between | |
| # different workflows. | |
| group: ${{ github.workflow }}-${{ github.event.number || github.sha }} | |
| cancel-in-progress: true | |
| env: | |
| PYENV_ROOT: ${{ github.workspace }}/pyenv | |
| PYENV_REF: 96b3fb2fc3bee85650cb22e2cb06c83c24509a6d # v2.4.17 | |
| PYTHON_VER: 3.12.7 | |
| CACHE_ASAN_VER: 2 | |
| CACHE_DEPS_VER: 1 | |
| IREE_SOURCE_DIR: ${{ github.workspace }}/iree | |
| LIBSHORTFIN_DIR: ${{ github.workspace }}/shortfin/ | |
| jobs: | |
| setup-python-asan: | |
| name: Setup Python ASan | |
| runs-on: ubuntu-24.04 | |
| env: | |
| # The Python build process leaks. Here we just disable leak checking vs | |
| # being more precise. | |
| ASAN_OPTIONS: detect_leaks=0 | |
| steps: | |
| - name: Cache Python ASan | |
| id: cache-python-asan | |
| uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2 | |
| with: | |
| path: ${{ env.PYENV_ROOT }} | |
| key: ${{ runner.os }}-python-asan-${{ env.PYENV_REF }}-${{ env.PYTHON_VER }}-v${{ env.CACHE_ASAN_VER }} | |
| lookup-only: 'true' | |
| - name: Install dependencies | |
| if: steps.cache-python-asan.outputs.cache-hit != 'true' | |
| run: | | |
| sudo apt update | |
| sudo apt install clang lld cmake ninja-build | |
| sudo apt install build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev curl git libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev | |
| - name: Checkout pyenv | |
| if: steps.cache-python-asan.outputs.cache-hit != 'true' | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| repository: pyenv/pyenv | |
| ref: ${{ env.PYENV_REF }} | |
| path: ${{ env.PYENV_ROOT }} | |
| - name: Install pyenv & Python | |
| if: steps.cache-python-asan.outputs.cache-hit != 'true' | |
| working-directory: ${{ env.PYENV_ROOT }} | |
| run: | | |
| src/configure && make -C src | |
| export PATH=${{ env.PYENV_ROOT }}/bin:$PATH && eval "$(pyenv init -)" | |
| CC=clang-18 CXX=clang++-18 LDFLAGS="-lstdc++" PYTHON_CONFIGURE_OPTS="--with-address-sanitizer" pyenv install -v ${{ env.PYTHON_VER }} | |
| pyenv global ${{ env.PYTHON_VER }} | |
| build-and-test: | |
| name: Build and test shortfin | |
| needs: [setup-python-asan] | |
| runs-on: ubuntu-24.04 | |
| env: | |
| # We can't count on being leak free in general (i.e. pip, etc) so disable | |
| # leak checker by default. Here we suppress any ASAN features needed to | |
| # pass the build. Test configuration is done specially just for that step. | |
| ASAN_OPTIONS: detect_leaks=0,detect_odr_violation=0 | |
| LSAN_OPTIONS: suppressions=${{ github.workspace }}/shortfin/build_tools/python_lsan_suppressions.txt | |
| steps: | |
| - name: Install dependencies | |
| run: | | |
| sudo apt update | |
| sudo apt install clang lld cmake ninja-build | |
| - name: Checkout repository | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| submodules: false | |
| - name: Checkout IREE repo | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| repository: iree-org/iree | |
| path: ${{ env.IREE_SOURCE_DIR }} | |
| submodules: false | |
| ref: iree-2.9.0rc20241108 | |
| - name: Initalize IREE submodules | |
| working-directory: ${{ env.IREE_SOURCE_DIR }} | |
| run : | | |
| git submodule update --init --depth 1 -- third_party/benchmark | |
| git submodule update --init --depth 1 -- third_party/cpuinfo/ | |
| git submodule update --init --depth 1 -- third_party/flatcc | |
| git submodule update --init --depth 1 -- third_party/googletest | |
| git submodule update --init --depth 1 -- third_party/hip-build-deps/ | |
| - name: Restore Python dependencies cache | |
| id: cache-python-deps-restore | |
| uses: actions/cache/restore@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2 | |
| with: | |
| path: ${{ env.PYENV_ROOT }} | |
| key: ${{ runner.os }}-python-deps-${{ hashFiles('shortfin/requirements-tests.txt') }}-v${{ env.CACHE_DEPS_VER }} | |
| - name: Restore Python ASan cache | |
| id: cache-python-asan | |
| if: steps.cache-python-deps-restore.outputs.cache-hit != 'true' | |
| uses: actions/cache/restore@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2 | |
| with: | |
| path: ${{ env.PYENV_ROOT }} | |
| key: ${{ runner.os }}-python-asan-${{ env.PYENV_REF }}-${{ env.PYTHON_VER }}-v${{ env.CACHE_ASAN_VER }} | |
| - name: Set path | |
| run: | |
| echo "${{ env.PYENV_ROOT }}/bin" >> $GITHUB_PATH | |
| - name: Install Python dependencies | |
| if: steps.cache-python-deps-restore.outputs.cache-hit != 'true' | |
| working-directory: ${{ env.LIBSHORTFIN_DIR }} | |
| run: | | |
| eval "$(pyenv init -)" | |
| pip install -r requirements-tests.txt | |
| pip install -r requirements-iree-compiler.txt | |
| pip freeze | |
| - name: Save Python dependencies cache | |
| if: steps.cache-python-deps-restore.outputs.cache-hit != 'true' | |
| id: cache-python-deps-save | |
| uses: actions/cache/save@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2 | |
| with: | |
| path: ${{ env.PYENV_ROOT }} | |
| key: ${{ steps.cache-python-deps-restore.outputs.cache-primary-key }} | |
| - name: Build shortfin | |
| working-directory: ${{ env.LIBSHORTFIN_DIR }} | |
| run: | | |
| eval "$(pyenv init -)" | |
| SHORTFIN_IREE_SOURCE_DIR="${{ env.IREE_SOURCE_DIR }}" \ | |
| SHORTFIN_ENABLE_ASAN=ON \ | |
| SHORTFIN_DEV_MODE=ON \ | |
| SHORTFIN_RUN_CTESTS=ON \ | |
| pip install -v -e . | |
| - name: Run pytest | |
| if: ${{ !cancelled() }} | |
| env: | |
| # TODO(#151): Don't ignore ODR violations | |
| ASAN_OPTIONS: detect_odr_violation=0 | |
| working-directory: ${{ env.LIBSHORTFIN_DIR }} | |
| run: | | |
| eval "$(pyenv init -)" | |
| pytest -s |