Expand embedded linker discovery and improve error messages. (#7575)

This path didn't _quite_ work out of the box for development builds. This expands the search space to make automatic discovery more likely.

The LLVM backend's embedded linker requires `lld` to be discoverable and we make an attempt to build it from source:
https://github.com/google/iree/blob/222828129144c8bfb603b4647aa969afb64a5a45/iree/tools/CMakeLists.txt#L395-L401

However, the `lld` binary ends up in `iree-build\third_party\llvm-project\llvm\bin` for builds (`install` does put `lld` next to the other IREE tools). This now searches that path in the build tree and includes more information in error messages:
```
Searching environment for one of these tools: [iree-lld.exe, lld.exe, ld.lld.exe, lld-link.exe]
Searching for tool at path 'D:\dev\projects\iree\..\iree-build\iree\tools'
Searching for tool at path 'D:\dev\projects\iree\..\iree-build\iree\tools/../../third_party/llvm-project/llvm/bin/'

(success)
Found tool in build tree at path "D:\dev\projects\iree-build\third_party\llvm-project\llvm\bin\lld.exe"

(failure)
error: embedded linker tool (typically `lld`) not found after searching:
  * -iree-llvm-embedded-linker-path= flag
  * IREE_LLVMAOT_EMBEDDED_LINKER_PATH environment variable
  * common locations at relative file paths
  * system PATH
Run with -debug-only=llvmaot-linker for search details
```

We do also have `iree-lld` now, but that lives in [llvm-external-projects/iree-compiler-api/python/](https://github.com/google/iree/blob/main/llvm-external-projects/iree-compiler-api/python/), not [iree/tools/](https://github.com/google/iree/tree/main/iree/tools/).

A workaround we _don't_ want to encourage is to install `lld` directly at the system level. Using the built-from-source binary has less risk of compatibility issues.
6 files changed
tree: 3469c5616d41fb570e0a204e965c75de5c313cf9
  1. .github/
  2. benchmarks/
  3. bindings/
  4. build_tools/
  5. colab/
  6. docs/
  7. experimental/
  8. integrations/
  9. iree/
  10. llvm-external-projects/
  11. scripts/
  12. third_party/
  13. .bazelignore
  14. .bazelrc
  15. .bazelversion
  16. .clang-format
  17. .gitignore
  18. .gitmodules
  19. .style.yapf
  20. .yamllint.yml
  21. AUTHORS
  22. BUILD.bazel
  23. CMakeLists.txt
  24. configure_bazel.py
  25. CONTRIBUTING.md
  26. LICENSE
  27. README.md
  28. SUBMODULE_VERSIONS.txt
  29. 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

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.