lambdaclass / cairo_sierra_2_MLIR

A compiler to convert Cairo's intermediate representation "Sierra" code to MLIR.

Cairo Sierra to MLIR compiler

A compiler to convert Cairo's intermediate representation "Sierra" code to MLIR.

Documentation

There is an mdbook in the docs folder. Build and read it with

make book

Dependencies

• mdbook
• LLVM 16+ with MLIR
• Rust

CLI Interface

Usage: cli --input <INPUT> <COMMAND>

Commands:
  compile  Compile to MLIR with LLVM dialect, ready to be converted by `mlir-translate --mlir-to-llvmir`
  run      Compile and run a program. The entry point must be a function without arguments
  help     Print this message or the help of the given subcommand(s)

Options:
  -i, --input <INPUT>  The input sierra file
  -h, --help           Print help (see more with '--help')
  -V, --version        Print version

Setup

Install mdbook and other documentation dependencies:

cargo install mdbook mdbook-toc mdbook-mermaid

Install LLVM with MLIR. You can use the official packages provided by LLVM.

If you've compiled LLVM manually, or installed it in a non-standard path, then please set the environment variable MLIR_SYS_160_PREFIX accordingly.

To build LLVM manually, follow this steps:

wget https://github.com/llvm/llvm-project/releases/download/llvmorg-16.0.0/llvm-project-16.0.0.src.tar.xz

mkdir ~/mlir
tar -xf llvm-project-16.0.0.src.tar.xz
cd llvm-project-16.0.0.src.tar
mkdir build
cd build

cmake -G Ninja ../llvm \
   -DLLVM_ENABLE_PROJECTS=mlir \
   -DLLVM_BUILD_EXAMPLES=ON \
   -DLLVM_TARGETS_TO_BUILD="X86;AArch64;NVPTX;AMDGPU" \
   -DCMAKE_BUILD_TYPE=RelWithDebInfo \
   -DLLVM_ENABLE_ASSERTIONS=ON \
   -DLLVM_INSTALL_UTILS=ON \
   -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DLLVM_ENABLE_LLD=ON \
   -DCMAKE_INSTALL_PREFIX=~/mlir

Setup a environment variable called MLIR_SYS_160_PREFIX pointing to the mlir directory:

MLIR_SYS_160_PREFIX=~/mlir

Benchmarking

cargo bench

MLIR Resources

• https://mlir.llvm.org/docs/Tutorials/

Translate output MLIR to LLVM IR

mlir-translate --mlir-to-llvmir output.mlir -o output.ll

# Compile with clang
clang -O3 output.ll -o program
./program

# With JIT
lli output.ll