Reworking constant upload with a HAL file API. (#14665)

This changes the compiler-generated map/staging IR into file reads that
are managed by the runtime HAL targets. In this initial version only one
type of file is supported that wraps host memory and exposes it via the
file API. For targets that don't natively support file streaming a
utility for asynchronously streaming files using an iree_loop_t is
available and all targets currently use that. In the future targets like
CUDA/Metal/Direct3D12 can use cuFile/MTLIOCommandBuffer/DirectStorage to
directly stream file contents from/to disk.

Future changes will expand the iree_hal_file_t vtable with what can be
reliably implemented or guarded with feature flags. When any form of
asynchronous loop is implemented (such as a task-system fiber loop)
we'll be able to perform overlapped copies to reduce total transfer
latency by letting the CPU and GPU do their respective staging
operations concurrently. Today only synchronous loops are used so it's
fully serialized.

Now that the compiler doesn't emit staging with
iree_allocator_allocate_buffer's initial_data that can be removed in
#14605 to remove the primary use of the existing buffer_transfer util.
The remaining places using it can be switched to memory file streaming
instead such as numpy IO and support much larger content.

This is a breaking HAL change and all existing VMFBs will fail to load
on newer runtimes.

CPU and CUDA targets benefit from this as should all other backends
though some may need to have zero-copy paths added - they'll at least
benefit from streaming and bounded staging buffer sizes. Vulkan has been
optimized a bit and the follow-on sparse bindings support improves it
further.

Vulkan dedicated GPU w/ 1GB model before this change (1024MB + 1024MB of
staging, even when mmapped):

![image](https://github.com/openxla/iree/assets/75337/62b4b144-efe6-4116-8192-3f7bbfbbfaeb)

Vulkan dedicated GPU w/ 1GB model now (1024MB + ~64MB of staging used as
streamed from a memory mapped file):

![image](https://github.com/openxla/iree/assets/75337/4e44a186-9c11-4d83-951b-b6bc1ad6e3f2)

Vulkan integrated GPU w/ 1GB model now (1024MB of host memory imported
and used directly with no copies):

![image](https://github.com/openxla/iree/assets/75337/0d036ede-0aac-45be-b069-6bb8d6e06cb6)

Progress on #14607.
104 files changed
tree: 926ef1fba7700666224cbdf89f3aabca1f082708
  1. .devcontainer/
  2. .github/
  3. build_tools/
  4. compiler/
  5. docs/
  6. experimental/
  7. integrations/
  8. lib/
  9. llvm-external-projects/
  10. runtime/
  11. samples/
  12. tests/
  13. third_party/
  14. tools/
  15. .bazel_to_cmake.cfg.py
  16. .bazelignore
  17. .bazelrc
  18. .bazelversion
  19. .clang-format
  20. .dockerignore
  21. .git-blame-ignore-revs
  22. .gitignore
  23. .gitmodules
  24. .yamllint.yml
  25. AUTHORS
  26. BUILD.bazel
  27. CITATION.cff
  28. CMakeLists.txt
  29. configure_bazel.py
  30. CONTRIBUTING.md
  31. LICENSE
  32. README.md
  33. 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.