Convertor from LLVM to Yul

If you want to build using LLVM frontend, please use corresponding language standard library.

• Rust: patine

Many platfrom can't get prebuilt binary library for LLVM. So we suggested compile LLVM manually. Please refer llvm-sys documentation to build it.

export LLVM_SYS_170_PREFIX=<path-to-llvm-directory>
cargo build

Use rust example. Follow these instructions to build testable LLVM IR file.

1. Clone patine repo

git clone https://github.com/tiannian/patine

2. Build store example

RUSTFLAGS="--emit=llvm-ir" cargo build --release --example=store

3. Link llvm

llvm-link target/release/deps/patine_core-*.ll \
          target/release/deps/patine_std-*.ll \
          target/release/examples/store-*.ll \
          -o store.dc
llvm-dis store.dc

4. Copy store.dc.ll to llvm2yul directory.

5. Compile this repo.

export LLVM_SYS_170_PREFIX=<path-to-llvm-directory>
RUST_LOG=llvm2yul=debug cargo r --example=compiler

1. Iterate object's all function.
2. Compile function
   1. Compile Header
   2. Compile Block.
   3. Compile Termiantor
   4. Compile Body

In this step, llvm2yul will flat struct.

• Compile phi instruction
• Compile call instruction. struct will be flatten
• Compile load
• Compile store
• Compile select

• Compile Ret
• Compile Br
• Compile CondBr
• Compile Switch
• Compile Unreachable

Replace function call into builtin

• 64 / 32 bit with 256 align as primitive type. Primitive type use parameter and return value directly.
• Map LLVM IR instruction to yul
  1. ExtractValue
  2. InsertValue
  3. Alloca
  4. Load
  5. Store
  6. GetElementPtr
  7. PtrToInt
  8. IntToPtr
  9. Phi
  10. Select
  11. Call
• Map LLVM IR Type to yul
  1. Void
  2. Integer
  3. Pointer
  4. Array
  5. Struct
  6. NamedStruct
• Map LLVM IR Constant to yul
  1. Int
  2. Null
  3. AggregateZero
  4. Struct
  5. Array
  6. GlobalReference
  7. Poison
  8. Ptr2Int
  9. Int2Ptr
• Flatten LLVM IR Struct or Array
• Map LLVM IR function call to yul.
  • Use FFI function to map yul builtin function.
  • allocate function as builtin function
• Map block termiantor to control flow.
  • Ret (leave)
  • Br
  • CondBr
  • Switch (switch)
  • Unreachable (invaild)
• Map LLVM IR funtion to yul
  • Primitive parameter type
  • Primitive return type
  • Nested struct parameter and return support.
• Make unsupported display clearily