Skip to content

Commit

Permalink
Move ASAN over to new CI system
Browse files Browse the repository at this point in the history
  • Loading branch information
rsuderman committed Jul 29, 2022
1 parent 62163ab commit fe4a8b7
Show file tree
Hide file tree
Showing 3 changed files with 170 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,24 @@ jobs:
build_tools/cmake/run_tf_tests.sh \
"${BUILD_DIR}"
asan:
runs-on:
# Hacks, and order matters. See the comment at the top of the file.
- self-hosted
- runner-group=${{ github.event_name == 'pull_request' && 'presubmit' || 'postsubmit' }}
- cpu
- os-family=Linux
steps:
- name: "Checking out repository"
uses: actions/checkout@7884fcad6b5d53d10323aee724dc68d8b9096a2e # v2
with:
submodules: true
- name: "Building and testing with AddressSanitizer"
run: |
./build_tools/github_actions/docker_run.sh \
gcr.io/iree-oss/swiftshader@sha256:542de3bac7f6173add3651f75c4c681f4a8e2d23815332dd82afe85c7d598445 \
./build_tools/cmake/build_and_test_asan.sh
tsan:
runs-on:
# Hacks, and order matters. See the comment at the top of the file.
Expand Down Expand Up @@ -362,6 +380,7 @@ jobs:
- test_all
- test_gpu
- host_tools_assertions
- asan
- tsan
- riscv32
if: always()
Expand Down
148 changes: 148 additions & 0 deletions build_tools/cmake/build_and_test_asan.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
#!/bin/bash

# Copyright 2020 The IREE Authors
#
# 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

# Note: this script diverges from the non-ASan build in a few ways:
# * The CMake build sets `IREE_ENABLE_ASAN=ON`
# * Omit optional components that don't work with ASan (e.g. Python bindings)
# * Some tests that fail under ASan are individually excluded
#
# The desired build directory can be passed as
# the first argument. Otherwise, it uses the environment variable
# IREE_TSAN_BUILD_DIR, defaulting to "build-tsan". Designed for CI, but
# can be run manually. This reuses the build directory if it already exists.
#
# Build and test the project with CMake with ASan enabled and using
# SwiftShader's software Vulkan driver.
# ASan docs: https://clang.llvm.org/docs/AddressSanitizer.html


set -xeuo pipefail

ROOT_DIR="${ROOT_DIR:-$(git rev-parse --show-toplevel)}"
cd "${ROOT_DIR}"

CMAKE_BIN=${CMAKE_BIN:-$(which cmake)}
BUILD_DIR="${1:-${IREE_TSAN_BUILD_DIR:-build-asan}}"
IREE_ENABLE_ASSERTIONS="${IREE_ENABLE_ASSERTIONS:-ON}"
IREE_ENABLE_CCACHE="${IREE_ENABLE_CCACHE:-OFF}"

"$CMAKE_BIN" --version
ninja --version

if [[ -d "${BUILD_DIR}" ]]; then
echo "Build directory '${BUILD_DIR}' already exists. Will use cached results there."
else
echo "Build directory '${BUILD_DIR}' does not already exist. Creating a new one."
mkdir "${BUILD_DIR}"
fi

CMAKE_ARGS=(
"-G" "Ninja"
"-DCMAKE_BUILD_TYPE=RelWithDebInfo"
"-DIREE_ENABLE_ASAN=ON"
"-B" "${BUILD_DIR?}"

# Also check if microbenchmarks are buildable.
"-DIREE_BUILD_MICROBENCHMARKS=ON"

"-DIREE_ENABLE_ASSERTIONS=${IREE_ENABLE_ASSERTIONS}"
"-DIREE_ENABLE_CCACHE=${IREE_ENABLE_CCACHE}"

# Enable CUDA compiler and runtime builds unconditionally. Our CI images all
# have enough deps to at least build CUDA support and compile CUDA binaries
# (but not necessarily test on real hardware).
"-DIREE_HAL_DRIVER_CUDA=ON"
"-DIREE_TARGET_BACKEND_CUDA=ON"
)

echo "Configuring CMake"
"${CMAKE_BIN?}" "${CMAKE_ARGS[@]?}"

echo "Building all"
echo "------------"
"${CMAKE_BIN?}" --build "${BUILD_DIR?}" -- -k 0

echo "Building test deps"
echo "------------------"
"${CMAKE_BIN?}" --build "${BUILD_DIR?}" --target iree-test-deps -- -k 0

echo "Building microbenchmark suites"
echo "------------------"
"${CMAKE_BIN?}" --build "${BUILD_DIR?}" --target iree-microbenchmark-suites -- -k 0

# Respect the user setting, but default to as many jobs as we have cores.
export CTEST_PARALLEL_LEVEL=${CTEST_PARALLEL_LEVEL:-$(nproc)}

# Respect the user setting, but default to turning on Vulkan.
export IREE_VULKAN_DISABLE=${IREE_VULKAN_DISABLE:-0}
# Respect the user setting, but default to turning off CUDA.
export IREE_CUDA_DISABLE=${IREE_CUDA_DISABLE:-1}
# The VK_KHR_shader_float16_int8 extension is optional prior to Vulkan 1.2.
# We test on SwiftShader as a baseline, which does not support this extension.
export IREE_VULKAN_F16_DISABLE=${IREE_VULKAN_F16_DISABLE:-1}

# Tests to exclude by label. In addition to any custom labels (which are carried
# over from Bazel tags), every test should be labeled with its directory.
declare -a label_exclude_args=(
# Exclude specific labels.
# Put the whole label with anchors for exact matches.
# For example:
# ^nokokoro$
^nokokoro$

# Exclude all tests in a directory.
# Put the whole directory with anchors for exact matches.
# For example:
# ^bindings/python/iree/runtime$

# Exclude all tests in some subdirectories.
# Put the whole parent directory with only a starting anchor.
# Use a trailing slash to avoid prefix collisions.
# For example:
# ^bindings/
)

if [[ "${IREE_VULKAN_DISABLE?}" == 1 ]]; then
label_exclude_args+=("^driver=vulkan$")
fi
if [[ "${IREE_CUDA_DISABLE?}" == 1 ]]; then
label_exclude_args+=("^driver=cuda$")
fi

if [[ "${IREE_VULKAN_F16_DISABLE?}" == 1 ]]; then
label_exclude_args+=("^vulkan_uses_vk_khr_shader_float16_int8$")
fi

label_exclude_regex="($(IFS="|" ; echo "${label_exclude_args[*]?}"))"

# These tests currently have asan failures
# TODO(#5715): Fix these
declare -a excluded_tests=(
"iree/samples/simple_embedding/simple_embedding_vulkan_test"
)

# Prefix with `^` anchor
excluded_tests=( "${excluded_tests[@]/#/^}" )
# Suffix with `$` anchor
excluded_tests=( "${excluded_tests[@]/%/$}" )

# Join on `|` and wrap in parens
excluded_tests_regex="($(IFS="|" ; echo "${excluded_tests[*]?}"))"

cd ${BUILD_DIR?}

echo "******************** Running main project ctests ************************"
ctest \
--timeout 900 \
--output-on-failure \
--no-tests=error \
--label-exclude "${label_exclude_regex}" \
--exclude-regex "${excluded_tests_regex?}"

echo "******************** llvm-external-projects tests ***********************"
cmake --build . --target check-iree-dialects -- -k 0
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,9 @@ label_exclude_regex="($(IFS="|" ; echo "${label_exclude_args[*]?}"))"
# TODO(#5715): Fix these
declare -a excluded_tests=(
"iree/samples/simple_embedding/simple_embedding_vulkan_test"
"iree/tools/test/iree-benchmark-module.mlir.test"
"iree/tools/test/iree-run-module.mlir.test"
"iree/tools/test/multiple_exported_functions.mlir.test"
)

# Prefix with `^` anchor
Expand Down

0 comments on commit fe4a8b7

Please sign in to comment.