Adding support for loading VM modules from dynamic libraries. (#13112)

Users can now produce native shared libraries that export one or more
symbols used to create VM modules allowing for multiple different
modules to be packaged in the same binary. These dynamic modules receive
a key-value list of parameters that they can use to customize their
behavior that can be programmatically specified by whatever is loading
them (python kwargs, or flag `?key=value&key=value` on the command
line).

On the hosting runtime side `iree_vm_dynamic_module_load_from_file`
makes it easy to load and use the modules as if they were local to the
binary. The command line tools have been updated to support multiple
`--module=` flags and load each module into the context. This also
allows for multiple vmfbs to be loaded and all kinds of linkage behavior
(could have a training driver in a native module that calls functions in
a compiled module loaded earlier, etc).

As part of this multiple `--module=` flags can be provided now to tools
for both bytecode and dynamic modules. To ensure all the tools are using
the same flag helper/loader I've switched iree-benchmark-module,
iree-check-module, and iree-run-module to require explicitly specifying
`--module=-` to load the module from stdin. This removes the need for
the "reading from stdin message" that uglied up stdout.

I wasn't able to figure out Tracy support here (at least on Windows) as
if tracing is globally enabled the shared libraries will get Tracy
linked in and start a new tracing context. It's noted today and a
warning is emitted when the sample is compiled with tracing enabled.
69 files changed
tree: da7b3c5d84a6f9f0c75337c254a97caaa6d7c18b
  1. .github/
  2. benchmarks/
  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. .gitignore
  22. .gitmodules
  23. .pylintrc
  24. .style.yapf
  25. .yamllint.yml
  26. AUTHORS
  27. BUILD.bazel
  28. CITATION.cff
  29. CMakeLists.txt
  30. configure_bazel.py
  31. CONTRIBUTING.md
  32. LICENSE
  33. README.md
  34. 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.