Embedding executable source contents in binaries for tracing. (#16757)

This adds a new `CaptureExecutableSourcesPass` that allows for capture
of individual `hal.executable.variant` ops at any number of compilation
stages. Unlike the `DumpExecutableSourcesPass` this does not change the
original source locations in the IR and instead captures both the
textual IR and the remapped locations within it of each executable
export at the time the pass is run. The textual IR is stored as
resources and associated with the variants through linking and made
available to serialization for embedding in target-specific formats.

Because this increases compilation time (generating all of the sources
multiple times per executable is expensive) and bloats binaries the
capture is only enabled with the `--iree-hal-executable-debug-level=3`
or greater flag set (default is `=2`).

As part of this PR the CPU, Vulkan, and legacy ROCM formats have been
updated to store the new information and source it at runtime. This is a
breaking change to the executable library binary format. I'm not quite
happy with it, but it's probably good enough for the next 6mo-1yr.

To make this more usable a copy button has been added to the tracy
source view: https://github.com/wolfpld/tracy/pull/750
Now clicking on a dispatch in the CPU or GPU timeline will show the
source and the copy button can be used to get it in the clipboard. The
source can then be run through `iree-compile
--compile-mode=hal-executable` to generate binaries.

![image](https://github.com/openxla/iree/assets/75337/e690e1f8-52a7-40db-a3aa-5fd7e781791b)

Fixes #15699. Closes #16223.
48 files changed
tree: e0d0892f9edca456d0bafb0f8e6049b55b33b7b9
  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 IREE Discord 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

License

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