Google Git
Sign in
opensecura / 3p / openxla / iree / 7649deef68154ebb02eb44d95a96cf0fcead7602
commit7649deef68154ebb02eb44d95a96cf0fcead7602[log] [tgz]
authorScott Todd <scotttodd@google.com>Mon Jul 18 11:31:46 2022 -0700
committerGitHub <noreply@github.com>Mon Jul 18 11:31:46 2022 -0700
treea60a1e2135806424a0db84cb764febbd3daf129f
parent5ee9df1cdc1ea8360ddf4968776255dd150cabb3 [diff]
Expand on documentation for IREE_ENABLE_LLD. (#9793)

Revisiting some of the work in https://github.com/iree-org/iree/pull/2098.

I tried setting `IREE_ENABLE_LLD`, expecting it to build a supported version lld as needed, as `LLVM_ENABLE_LLD` [claims to do](https://llvm.org/docs/CMake.html#llvm-use-linker:~:text=LLVM_ENABLE_LLD%3ABOOL):
> `LLVM_ENABLE_LLD:BOOL`
> This option is equivalent to `-DLLVM_USE_LINKER=lld`, except during a 2-stage build where a dependency is added from the first stage to the second ensuring that lld is built before stage2 begins.

However, our option does _not_ do that. I'm tempted to drop `IREE_ENABLE_LLD` entirely, since we can't realistically do that sort of 2-stage build as just a downstream user of LLVM and other libraries.

Short of removing the misleading option (then updating our scripts and docs and asking developers to switch to the explicit option), I opted to add more comments to help future developers with troubleshooting.

Also mixed up in this are https://github.com/iree-org/iree/issues/7473 and https://github.com/iree-org/iree/pull/7474, which tried to set/use `IREE_ENABLE_LLD` on a platform (OSX) where lld is not actually supported (?). I moved that check from CMake branches to `cmake_dependent_option`.
2 files changed
tree: a60a1e2135806424a0db84cb764febbd3daf129f
  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.

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.

Build Status

CI SystemBuild SystemPlatformArchitectureConfiguration / ComponentStatus
KokoroBazelLinuxx86-64kokoro status bazel/linux/x86-swiftshader/core
KokoroCMake & BazelLinuxx86-64 (swiftshader)Integrationskokoro status cmake-bazel/linux/x86-swiftshader
KokoroCMake & BazelLinuxx86-64 (turing)Integrationskokoro status cmake-bazel/linux/x86-turing
KokoroCMakeLinuxx86-64 (swiftshader)kokoro status cmake/linux/x86-swiftshader
KokoroCMakeLinuxx86-64 (swiftshader)asankokoro status cmake/linux/x86-swiftshader-asan
KokoroCMakeLinuxx86-64 (turing)kokoro status cmake/linux/x86-turing
KokoroCMakeAndroidarm64-v8aRuntime (build only)kokoro status cmake/android/arm64-v8a
KokoroCMakeBare Metalrisc-v-32Runtimekokoro status cmake/baremetal/riscv32
KokoroCMakeLinuxrisc-v-64Runtimekokoro status cmake/linux/riscv64
BuildkiteCMakeAndroidarm64-v8aRuntimebuildkite status iree-android-arm64-v8a
BuildKiteCMakeAndroidarm64-v8aRuntime Benchmarksbuildkite status iree-benchmark
BuildKiteCMakeLinuxx86-64Tracing + Standalone Runtimebuildkite status iree-build-configurations

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.