Refactor the HAL CTS for out of tree / individual drivers. (#7887)

Fixes https://github.com/google/iree/issues/4643

This refactors the Hardware Abstraction Layer's Conformance Test Suite into a set of libraries and parameterized test suites that can be instantiated for individual HAL drivers using a new CMake function. This way, we can filter tests/drivers within the build system and can support drivers that are not added to the global test registry.

The tests are still written as googletest [Value-Parameterized Tests](https://google.github.io/googletest/advanced.html#value-parameterized-tests), but they are now _abstract tests_ as well. The CMake function creates a concrete implementation of each test in the suite using a template file. Here is an example of a generated test file:

```c++
// clang-format off
#define IREE_CTS_TEST_FILE_PATH "iree/hal/cts/descriptor_set_layout_test.h"
#define IREE_CTS_TEST_CLASS_NAME DescriptorSetLayoutTest
#define IREE_CTS_DRIVER_NAME "vmvx"
// clang-format on

#include IREE_CTS_TEST_FILE_PATH

#include "iree/hal/cts/cts_test_base.h"
#include "iree/testing/gtest.h"

namespace iree {
namespace hal {
namespace cts {

INSTANTIATE_TEST_SUITE_P(CTS, IREE_CTS_TEST_CLASS_NAME,
                         ::testing::Values(IREE_CTS_DRIVER_NAME),
                         GenerateTestName());

}  // namespace cts
}  // namespace hal
}  // namespace iree
```

(I referenced https://crascit.com/2017/04/18/generated-sources-in-cmake-builds/ for guidance on generating files from templates in CMake)

This also drops support for running these tests through Bazel. Support could be added back, but the file and test generation is sufficiently weird that I'd rather not support both build systems. I also think we have sufficient CI coverage for the HAL in open source (where nearly all HAL development happens) using CMake that Bazel support won't be very useful.
28 files changed
tree: 6fba754f78be9a9466df9f609d5c95ab3bb5288b
  1. .github/
  2. benchmarks/
  3. bindings/
  4. build_tools/
  5. colab/
  6. docs/
  7. experimental/
  8. integrations/
  9. iree/
  10. llvm-external-projects/
  11. scripts/
  12. third_party/
  13. .bazelignore
  14. .bazelrc
  15. .bazelversion
  16. .clang-format
  17. .gitignore
  18. .gitmodules
  19. .pylintrc
  20. .style.yapf
  21. .yamllint.yml
  22. AUTHORS
  23. BUILD.bazel
  24. CMakeLists.txt
  25. configure_bazel.py
  26. CONTRIBUTING.md
  27. LICENSE
  28. README.md
  29. SUBMODULE_VERSIONS.txt
  30. WORKSPACE
README.md

IREE: Intermediate Representation Execution Environment

IREE (Intermediate Representation Execution Environment, pronounced as “eerie”) is an MLIR-based end-to-end compiler and runtime that lowers Machine Learning (ML) models to a unified IR that scales up to meet the needs of the datacenter and down to satisfy the constraints and special considerations of mobile and edge deployments.

See our website for project details, user guides, and instructions on building from source.

Project Status

IREE is still in its early phase. We have settled down on the overarching infrastructure and are actively improving various software components as well as project logistics. It is still quite far from ready for everyday use and is made available without any support at the moment. With that said, we welcome any kind of feedback on any communication channels!

Communication Channels

Related Project Channels

  • MLIR topic within LLVM Discourse: IREE is enabled by and heavily relies on MLIR. IREE sometimes is referred to in certain MLIR discussions. Useful if you are also interested in MLIR evolution.

Build Status

CI SystemBuild SystemPlatformArchitectureConfiguration / ComponentStatus
KokoroBazelLinuxx86-64kokoro status bazel/linux/x86-swiftshader/core
KokoroCMake & BazelLinuxx86-64 (swiftshader)Integrationskokoro status cmake-bazel/linux/x86-swiftshader
KokoroCMake & BazelLinuxx86-64 (turing)Integrationskokoro status cmake-bazel/linux/x86-turing
KokoroCMakeLinuxx86-64 (swiftshader)kokoro status cmake/linux/x86-swiftshader
KokoroCMakeLinuxx86-64 (swiftshader)asankokoro status cmake/linux/x86-swiftshader-asan
KokoroCMakeLinuxx86-64 (turing)kokoro status cmake/linux/x86-turing
KokoroCMakeAndroidarm64-v8aRuntime (build only)kokoro status cmake/android/arm64-v8a
KokoroCMakeBare Metalrisc-v-32Runtimekokoro status cmake/baremetal/riscv32
KokoroCMakeLinuxrisc-v-64Runtimekokoro status cmake/linux/riscv64
BuildkiteCMakeAndroidarm64-v8aRuntimebuildkite status iree-android-arm64-v8a
BuildKiteCMakeAndroidarm64-v8aRuntime Benchmarksbuildkite status iree-benchmark
BuildKiteCMakeLinuxx86-64Tracing + Standalone Runtimebuildkite status iree-build-configurations

Architecture Overview

IREE Architecture

See our website for more information.

Presentations and Talks

  • 2021-06-09: IREE Runtime Design Tech Talk (recording and slides)
  • 2020-08-20: IREE CodeGen: MLIR Open Design Meeting Presentation (recording and slides)
  • 2020-03-18: Interactive HAL IR Walkthrough (recording)
  • 2020-01-31: End-to-end MLIR Workflow in IREE: MLIR Open Design Meeting Presentation (recording and slides)

License

IREE is licensed under the terms of the Apache 2.0 License with LLVM Exceptions. See LICENSE for more information.