Files
wasmer/lib/compiler-llvm/README.md
2020-07-15 12:39:06 -07:00

52 lines
1.2 KiB
Markdown

# Wasmer Compiler - LLVM
This is the `wasmer-compiler-llvm` crate, which contains a
compiler implementation based on LLVM.
## Usage
First, add this crate into your `Cargo.toml` dependencies:
```toml
wasmer-compiler-llvm = "1.0.0-alpha.1"
```
And then:
```rust
use wasmer::{Store, JIT};
use wasmer_compiler_llvm::LLVM;
let compiler = LLVM::new();
// Put it into an engine and add it to the store
let store = Store::new(&JIT::new(&compiler).engine());
```
*Note: you can find a [full working example using LLVM compiler here](https://github.com/wasmerio/wasmer-reborn/blob/master/examples/compiler-llvm.rs).*
## When to use LLVM
We recommend using LLVM as the default compiler when running WebAssembly
files on any **production** system, as it offers maximum peformance near
to native speeds.
## Requirements
The llvm compiler requires a valid installation of LLVM in your system.
It currently requires **LLVM 10**.
You can install LLVM easily on your debian-like system via this command:
```bash
bash -c "$(wget -O - https://apt.llvm.org/llvm.sh)"
```
Or in macOS:
```bash
brew install llvm
```
Or via any of the [pre-built binaries that LLVM offers](https://releases.llvm.org/download.html).