Merge pull request #9945 from iree-org/benvanik-hal-inline

This adds two new semi-experimental execution models: `inline-static` and `inline-dynamic`. Unlike the full `async-*` models we use by default with command buffers, submission queues, and fences these execute as if the host and device are the same (local in-process shared memory CPU) and running synchronously. This change to synchronous behavior allows us to elide nearly the entirety of the HAL and only keep around a minimal surface area used for passing buffers/views across the ABI. Even when executing synchronously there are still reasons to use the full HAL (ability to sandbox, replay optimized command buffers, interop with hosting applications using async behavior, etc) but in very tiny deployments not pulling all of that in is a massive savings.

The `inline-static` mode works with the `vmvx-inline` HAL target to produce a completely inlined VM program using the vmvx module for codegen translation. The compiler flow is nearly identical to the full HAL only when lowering out of the stream dialect we switch to the minimal `hal_inline` dialect and inline the codegen-produced executable contents right into the module.
Example iree-compile flags for static inline vmvx (note `vmvx-inline` is the only supported backend!):
```
--iree-execution-model=inline-static
--iree-hal-target-backends=vmvx-inline
```
Example `unidirectional_lstm.mlir`: https://gist.github.com/benvanik/216e3963a464d278192b6d5cbd8ee10b

The `inline-dynamic` mode is mostly the same but instead of inlining the executables it leaves them as dynamically loadable executables and reuses the HAL's local executable loader infrastructure. This means any codegen target that we can load via the full HAL when running locally can also be used here, such as embedded elfs, system dynamic libraries, vmvx, static libraries, or any future things (wasm/etc). 

For dynamic inline codegen, using LLVM codegen for producing ELFs and then loading them at runtime:
```
--iree-execution-model=inline-dynamic
--iree-hal-target-backends=llvm-cpu
```
Example `unidirectional_lstm.mlir`: https://gist.github.com/benvanik/7ee9879875c8eb1bf5be85e2b2d2cf0f

More extensive testing is required as well as examples showing how to use this with emitc and the new vmvx microkernels. This initial submission is enough for prototyping as the compiler portions are mostly done. There's remaining optimization work required but most of that is done at the stream dialect level (reducing copies/etc) and not specific to this work.
tree: 6950d109953fc3cd7ba718c5251bd15e99b59b3e
  1. .github/
  2. benchmarks/
  3. build_tools/
  4. compiler/
  5. docs/
  6. experimental/
  7. integrations/
  8. llvm-external-projects/
  9. runtime/
  10. samples/
  11. tests/
  12. third_party/
  13. tools/
  14. .bazelignore
  15. .bazelrc
  16. .bazelversion
  17. .clang-format
  18. .gitignore
  19. .gitmodules
  20. .pylintrc
  21. .style.yapf
  22. .yamllint.yml
  23. AUTHORS
  24. BUILD.bazel
  25. CITATION.cff
  26. CMakeLists.txt
  27. configure_bazel.py
  28. CONTRIBUTING.md
  29. LICENSE
  30. README.md
  31. 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.

CI Status

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.

Architecture Overview

IREE Architecture 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.