Adds support for HAL executable object linkage.
Objects are passed through flow/stream and handled by the HAL
infrastructure during interface materialization (where we create the
variants based on target configuration). Each backend then gets the
objects specified for it and can use those in backend-dependent ways.

For now the LLVM-CPU backend only supports external function calls
useful for microkernels and such. This allows for a majority of IREE's
features when defining flow/stream executables that call out to externs
(binding/operand packing/optimization, inlining, linking, and
automatic multi-targeting). In the future support can be added for
generating the boilerplate for external device functions called all the
way from (annotated) source inputs.

The GPU backends (CUDA/Vulkan SPIR-V) currently only support entire
top-level function definition (CUDA kernels or SPIR-V compute shaders).
In the future support can be added for linking (PTX linking or
spirv-link) to enable the microkernel-style substitution of ops that
supports fusion and interface optimization.

Objects can be embedded as data or referenced by file path allowing for
both JIT and precompilation approaches (a codegen backend could take
some input IR, produce via an external tool some objects, and then
rewrite the IR to reference those objects). Because paths are hard the
`--iree-hal-executable-object-search-path=` flag can be used (repeatedly)
to add search paths. When coming from frontends it's probably best to
rely on embedding.
25 files changed
tree: 47246e46e3e6f399455a66878742b16319ec9de0
  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. .dockerignore
  19. .gitignore
  20. .gitmodules
  21. .pylintrc
  22. .style.yapf
  23. .yamllint.yml
  24. AUTHORS
  25. BUILD.bazel
  26. CITATION.cff
  27. CMakeLists.txt
  28. configure_bazel.py
  29. CONTRIBUTING.md
  30. LICENSE
  31. README.md
  32. 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.