Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hyouteki/irl
A simpler version of what LLVM is at its core; "An optimizer and transpiler of its very own LLVM IR to various architecture's ISA".
https://github.com/hyouteki/irl
compiler-infrastructure intermediate-representation language llvm rust
Last synced: 4 months ago
JSON representation
A simpler version of what LLVM is at its core; "An optimizer and transpiler of its very own LLVM IR to various architecture's ISA".
- Host: GitHub
- URL: https://github.com/hyouteki/irl
- Owner: hyouteki
- License: gpl-3.0
- Created: 2024-06-15T16:44:16.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-08-17T07:43:42.000Z (6 months ago)
- Last Synced: 2024-10-01T03:40:54.237Z (4 months ago)
- Topics: compiler-infrastructure, intermediate-representation, language, llvm, rust
- Language: Rust
- Homepage:
- Size: 294 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Intermediate Representation Language
> Planned to be a simpler version of what LLVM is at its core; "An optimizer and transpiler of its very own LLVM IR to various architecture's ISA".
### Grammar
``` asm
function L, n
arg id
id = op
id = op1 arith op2
id = unary op
goto L
label L
if (op1 relop op2) goto L
id = op1 relop op2
param op
id = call L, n
ret op
```
### IRL Architecture
In the IRL architecture, the initial step involves converting the source code into an [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) (Abstract Syntax Tree) using the frontend ([`fe`](./src/fe)) module. The resulting AST then passes through a middleware ([`mw`](./src/mw)) module that invokes AST passes for correction and validation. Two default AST passes include [`validate_iden_pass`](./src/mw/validate_iden_pass.rs), which ensures all identifiers used in instructions are valid, and [`add_goto_pass`](./src/mw/add_goto_pass.rs), which inserts `goto` statements before necessary label instructions.
The corrected AST then proceeds to the optimization ([`opt`](./src/opt)) module, where it is transformed into a [CFG](https://en.wikipedia.org/wiki/Control-flow_graph) (Control Flow Graph). This module applies Compiler Passes to the CFG to optimize it, including [`reduce_pass`](./src/opt/reduce_pass.rs) for simplifying the CFG, [`constant_fold_pass`](./src/opt/constant_propagation_pass.rs) for folding constants, and `reaching_definition_pass` for eliminating redundant instructions.
The optimized CFG is then passed to the translation ([`trn`](./src/trn)) module, which translates it into assembly code tailored to the target architecture.
### Supported Targets
| flag | Status | Notes |
|------------------------|----------------|----------------------------------|
| `fasm-linux-x86_64` | ✔️ Supported | Full functionality available |
| `fasm-windows-x86_64` | ✖️ Planned | Future support under development |
| `wasm` | ✖️ Planned | Future support under development |
### Getting Started
``` asm
function fib, 1
arg n
a = 0
b = 1
i = 1
label begin
if (i == n) goto end
t = b
b = a + b
a = t
i = i + 1
goto begin
label end
ret b
function main, 0
param 6
a = call fib, 1
param a
tmp = call print, 1
ret 0
```
``` console
$ cargo run -- compile -r -f ./eg/fib.irl --cfg --fasm-linux-x86_64
8
$ echo $?
0
```
> Generated control flow graph of this example
>
> 
### CLI Documentation
```md
Compile source code to target(s)
Usage: irl.exe compile [OPTIONS] --filepath
Options:
-f, --filepath Source file path
--cfg Output control flow graph of the program as a svg
-d, --debug Dumps debug info onto stdout
-v, --verbose Sets info level to verbose
-r, --run Runs the binary after compilation
--wat Generates WAT (Web Assembly Text)
--wasm Generates WASM (Web Assembly)
--fasm-linux-x86_64 Generates FASM (Flat Assembly)
-h, --help Print help
```
### Examples
- [Fibonacci](./eg/fib.irl)
- [Constant Propagation Analysis test](./eg/constant_propagation_test.irl)
### Dependencies
- [graphviz - Graph Visualization Tools](https://graphviz.org/download/)
- [flatassembler - tgrysztar](https://flatassembler.net/)
- [wabt - webassembly](https://github.com/WebAssembly/wabt)
### Courtesy
- [fasm-mode - emacsattic](https://github.com/emacsattic/fasm-mode/)