Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paradigmxyz/revmc
JIT and AOT compiler for the Ethereum Virtual Machine, built on Revm.
https://github.com/paradigmxyz/revmc
aot compiler cranelift evm jit llvm
Last synced: about 3 hours ago
JSON representation
JIT and AOT compiler for the Ethereum Virtual Machine, built on Revm.
- Host: GitHub
- URL: https://github.com/paradigmxyz/revmc
- Owner: paradigmxyz
- License: apache-2.0
- Created: 2024-03-10T16:27:36.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-06T17:57:48.000Z (16 days ago)
- Last Synced: 2025-01-22T12:14:08.064Z (about 9 hours ago)
- Topics: aot, compiler, cranelift, evm, jit, llvm
- Language: Rust
- Homepage:
- Size: 5.56 MB
- Stars: 224
- Watchers: 6
- Forks: 25
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# revmc
Experimental [JIT] and [AOT] compiler for the [Ethereum Virtual Machine][EVM].
The compiler implementation is abstracted over an intermediate representation backend. It performs very well, as demonstrated below from our criterion benchmarks, and exposes an intuitive API via Revm.
This repository hosts two backend implementations:
- [LLVM] ([`revmc-llvm`]): main backend with full test coverage;
- [Cranelift] ([`revmc-cranelift`]); currently not functional due to missing `i256` support in Cranelift. This will likely require a custom fork of Cranelift.
[JIT]: https://en.wikipedia.org/wiki/Just-in-time_compilation
[AOT]: https://en.wikipedia.org/wiki/Ahead-of-time_compilation
[EVM]: https://ethereum.org/en/developers/docs/evm/
[LLVM]: https://llvm.org/
[`revmc-llvm`]: /crates/revmc-llvm
[Cranelift]: https://cranelift.dev/
[`revmc-cranelift`]: /crates/revmc-cranelift
## Requirements
- Latest stable Rust version
### LLVM backend
- Linux or macOS, Windows is not supported
- LLVM 18
- On Debian-based Linux distros: see [apt.llvm.org](https://apt.llvm.org/)
- On Arch-based Linux distros: `pacman -S llvm`
- On macOS: `brew install llvm@18`
- The following environment variables may be required:
```bash
prefix=$(llvm-config --prefix)
# or
#prefix=$(llvm-config-18 --prefix)
# on macOS:
#prefix=$(brew --prefix llvm@18)
export LLVM_SYS_180_PREFIX=$prefix
```
## Usage
The compiler is implemented as a library and can be used as such through the `revmc` crate.
A minimal runtime is required to run AOT-compiled bytecodes. A default runtime implementation is
provided through symbols exported in the `revmc-builtins` crate and must be exported in the final
binary. This can be achieved with the following build script:
```rust,ignore
fn main() {
revmc_build::emit();
}
```
You can check out the [examples](/examples) directory for example usage.
## Credits
The initial compiler implementation was inspired by [`paradigmxyz/jitevm`](https://github.com/paradigmxyz/jitevm).
#### License
Licensed under either of Apache License, Version
2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in these crates by you, as defined in the Apache-2.0 license,
shall be dual licensed as above, without any additional terms or conditions.