Skip to content

README.md

Latest commit

 

History

History
112 lines (84 loc) · 4.23 KB

README.md

File metadata and controls

112 lines (84 loc) · 4.23 KB
Raw

OS License: Apache-2.0 WITH LLVM-exception CI codecov

setup-mlir

This repository provides an action for setting up MLIR in GitHub Actions and installation scripts for setting up MLIR locally. Only Release builds are supported. macOS requires Apple silicon (arm64).

The MLIR binaries are built and distributed in the portable-mlir-toolchain repository.

List of available LLVM versions:

  • 21.1.8
  • 22.1.0
  • 22.1.1
  • 22.1.2
  • 22.1.3
  • 22.1.4
  • 22.1.5
  • 22.1.6
  • 22.1.7
  • 22.1.8
  • 23.1.0
  • 23.1.1
  • 23.1.2

List of available LLVM commit hashes:

  • 8f264586d7521b0e305ca7bb78825aa3382ffef7
  • 113f01aa82d055410f22a9d03b3468fa68600589
  • f8cb7987c64dcffb72414a40560055cb717dbf74

For more information on the available LLVM versions and commit hashes, see version-manifest.json.

GitHub Actions

- name: Set up MLIR
  uses: munich-quantum-software/setup-mlir@v1.5.0
  with:
    llvm-version: 23.1.2

This extracts a pre-built MLIR installation, adds the binaries to $PATH, and defines $LLVM_DIR and $MLIR_DIR.

Installation Scripts

If you want to use the pre-built MLIR installations locally, we also provide installation scripts. The scripts require the LLVM version or commit hash (e.g., 23.1.2 or f8cb798) and the desired installation directory to be passed. The scripts automatically download and use a platform-specific zstd binary for decompression, so only tar needs to be installed on the host system.

When run from a repository checkout or source archive, the installers use its version-manifest.json. Standalone or piped scripts read the manifest from main. To pin both script and manifest, download the repository's source archive at the desired commit and run its installer.

On Linux and macOS, use the following Bash command:

curl -LsSf https://github.com/munich-quantum-software/setup-mlir/releases/latest/download/setup-mlir.sh | bash -s -- -v 23.1.2 -p /path/to/installation

On Windows, use PowerShell 7.4 or newer, which supports the binary pipeline used for extraction. tar is included with Windows 10 and Windows 11.

pwsh -ExecutionPolicy ByPass -c "& ([scriptblock]::Create((irm https://github.com/munich-quantum-software/setup-mlir/releases/latest/download/setup-mlir.ps1))) -llvm_version 23.1.2 -install_prefix /path/to/installation"

Assertion-free release SDKs

Set assertions: false to select the native assertion-free SDK:

- uses: munich-quantum-software/setup-mlir@v1.5.0
  with:
    llvm-version: 23.1.2
    assertions: false

The installers accept -a OFF in Bash and -no_assertions in PowerShell. Assertions are enabled by default. Tool-cache directories separate the two variants. Use headers and libraries from the same variant because LLVM's assertion mode affects its ABI checks.

Each manifest entry describes one version, platform, and architecture. asset_name and download_url identify the SDK with assertions; noassert_asset_name and noassert_download_url identify the assertion-free SDK when available. Installers select the requested URL directly and report an unavailable variant before downloading assets. The optional fields are ignored by older actions.

The action uses its bundled manifest and checks main for versions absent from that manifest.