Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Brillvm readme #321

Merged
merged 2 commits into from
May 17, 2024
Merged

Update Brillvm readme #321

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ac5a49
Update Brillvm readme
Pat-Lafon May 4, 2024
619c45f
Add a missing space
sampsyo May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion bril-rs/brillvm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,21 @@ A couple of notes about flags:
- `-r <file>` can be used to provide a path to the runtime library `rt.bc` if it is not contained in the same directory.
- `<args>` All other arguments should be passable as normal if in `-i` mode.

Valid Bril programs are assumed as input with no attempt at error handling. Each compiler `.ll` file is verified before being emitted. If the line `llvm_prog.verify().unwrap();` raises an error then open an issue with your Bril program!
Valid Bril programs are assumed as input with no attempt at error handling. Each
compiler `.ll` file is verified before being emitted. If the line
`llvm_prog.verify().unwrap();` raises an error then open an issue with your Bril
program!

### Phi Nodes

Bril's specification of phi nodes is not equivalent to LLVM's specification of
phi nodes. For example, in LLVM, phi nodes must be located at the start of a basic
block.

Brillvm does not require that your Bril code be in SSA form (as it assumes
the LLVM `mem2reg` pass will be sufficient if that is needed) but if you choose
to supply Bril code with `phi` operations, Brillvm will assume that they follow
LLVM's additional constraints.

## TroubleShooting

Expand Down
Loading