Install with cargo

.github/workflows/ci.yaml

@@ -18,7 +18,9 @@ jobs:
         with:
           submodules: true
       - name: Setup
-        uses: ./.github/workflows/actions/setup
+        uses: dtolnay/rust-toolchain@stable
+        env:
+          LLVM_SYS_150_PREFIX: /home/runner/.wasker/clang+llvm-15.0.0-x86_64-linux-gnu-rhel-8.4
       - name: Run clippy
         run: cargo clippy --all-targets --all-features -- -D warnings
   test:
@@ -30,6 +32,8 @@ jobs:
         with:
           submodules: true
       - name: Setup
-        uses: ./.github/workflows/actions/setup
-      - name: Run test
+        uses: dtolnay/rust-toolchain@stable
+        env:
+          LLVM_SYS_150_PREFIX: /home/runner/.wasker/clang+llvm-15.0.0-x86_64-linux-gnu-rhel-8.4
+      - name: Run test 
         run: cargo test --all -- --nocapture

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "wasker"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 description = "Wasm compiler for running Wasm on your favorite kernel"
 license = "MIT"

README.md

@@ -18,94 +18,48 @@ This unresolved feature allows Wasker's output ELF file to be **linked with WASI
 
 Wasker empowers your favorite OS to serve as a Wasm runtime!
 
-
-# How to run Wasker
-Wasker compiler is based on LLVM (LLVM 15 currently).
-
 ![demo](./doc/assets/wasker.gif)
 
 
-## Option1 : Use Docker
-Clone repository
-```
-git clone [email protected]:Mewz-project/Wasker.git
-cd Wasker
-```
-
-Create directory for mount and place input Wasm/WAT file. 
-
-Please refer [examples](./examples) for building Wasm from Rust and Go. 
-Here, as an example, we'll use the already built `helloworld.wat` included in this repository.
-```
-mkdir -p mount
-mv helloworld.wat mount
-```
-
-Run Wasker via docker (It may take few minuits to pull image, so you can build image locally by `docker build -t wasker .`)
-
-ELF file will be generated under `mount` directory as `wasm.o`.
-
-```
-docker run -it --rm -v $PWD/mount:/work/mount -t ghcr.io/mewz-project/wasker:latest mount/helloworld.wat
-[2023-12-28T09:20:27Z INFO  wasker::compiler] input: mount/helloworld.wat
-[2023-12-28T09:20:27Z INFO  wasker::compiler] write to wasm.ll
-[2023-12-28T09:20:27Z INFO  wasker::compiler] write to wasm.o, it may take a while
-[2023-12-28T09:20:28Z INFO  wasker::compiler] Compile success
-```
-
-## Option2 : Use Devcontainer
-You can try Wasker on browser via Devcontainer.
+# Installation
+Wasker compiler is based on LLVM (LLVM 15 currently).
 
-Start Devcontainer
-- Click `Code` -> `Codespaces` -> `New codespace` on this repository page.
-- Wait for a while, then you can see VSCode on browser.
-- Open terminal on VSCode
+Suppose `cargo` is installed.
 
-Run Wasker
 ```
-cargo run helloworld.wat
+export LLVM_SYS_150_PREFIX=~/.wasker/clang+llvm-15.0.0-x86_64-linux-gnu-rhel-8.4/
+cargo install wasker
 ```
 
+# Run Wasker
 
-## Option3 : Build from source
-### Clone repository
-```
-git clone [email protected]:mewz-project/wasker.git
-cd Wasker
-```
-
-### Install LLVM locally
-The commands are a little different because you need an LLVM binary built for your architecture.
-#### AMD64
-```
-mkdir -p dependencies/llvm
-wget https://github.com/llvm/llvm-project/releases/download/llvmorg-15.0.0/clang+llvm-15.0.0-x86_64-linux-gnu-rhel-8.4.tar.xz -O /tmp/llvm-15.0.0.tar.xz
-tar -xvf /tmp/llvm-15.0.0.tar.xz -C dependencies/llvm
-export LLVM_SYS_150_PREFIX=$PWD/dependencies/llvm/clang+llvm-15.0.0-x86_64-linux-gnu-rhel-8.4
-```
+## Step1: Prepare Wasm binary
+Please refer [examples](./examples) for building Wasm from Rust and Go. 
 
-#### AArch64
 ```
-mkdir -p dependencies/llvm
-wget https://github.com/llvm/llvm-project/releases/download/llvmorg-15.0.0/clang+llvm-15.0.0-aarch64-linux-gnu.tar.xz -O /tmp/llvm-15.0.0.tar.xz
-tar -xvf /tmp/llvm-15.0.0.tar.xz -C dependencies/llvm
-export LLVM_SYS_150_PREFIX=$PWD/dependencies/llvm/clang+llvm-15.0.0-aarch64-linux-gnu
+cd examples/rust
+rustup target add wasm32-wasi
+cargo build --target wasm32-wasi
 ```
 
-### Run Wasker
+## Step2: Run Wasker
 ```
-cargo run helloworld.wat
+$ wasker examples/rust/target/wasm32-wasi/debug/rust.wasm
+[2024-03-19T12:10:20Z INFO  wasker::compiler] input: examples/rust/target/wasm32-wasi/debug/rust.wasm
+[2024-03-19T12:10:20Z INFO  wasker::compiler] write to ./wasm.ll
+[2024-03-19T12:10:20Z INFO  wasker::compiler] write to ./wasm.o, it may take a while
+[2024-03-19T12:10:21Z INFO  wasker::compiler] Compile success
 ```
 
-# How to use Wasker outputs
+## Step3: Run wasker output on Linux
 
 ELF file generated by Wasker is OS-independent: WASI calls from Wasm applications remain unresolved.
 
 Please write your own WASI wrapper for your favorite OS to be linked with Wasker output.
 
 Here, we'll show a [tiny example](./examples/wasi-wrapper/wasi-wrapper-linux.c) of running Wasker output on Linux.
 
-Link Wasker output and WASI wapper for Linux
+Compile WASI wapper for Linux and ink with Wasker output. 
 ```
 gcc -no-pie ./examples/wasi-wrapper/wasi-wrapper-linux.c ./wasm.o -o hello
 ```
@@ -117,3 +71,26 @@ Run!!
 
 Also please check [Mewz](https://github.com/Mewz-project/Mewz.git), a unikernel OS which has WASI interface. 
 ELF file generated by Wasker can be executed on Mewz without any modification.
+
+
+# Development
+
+## Option1 : Use Devcontainer
+You can try Wasker via Devcontainer.
+
+## Option2 : Build from source
+```
+git clone [email protected]:mewz-project/wasker.git
+cd Wasker
+export LLVM_SYS_150_PREFIX=~/.wasker/clang+llvm-15.0.0-x86_64-linux-gnu-rhel-8.4/
+cargo install wasker
+```
+By default, Wasker targets x86_64. If you want to target AArch64, please rewrite [build.rs](./build.rs) and override `LLVM_SYS_150_PREFIX` environment variable as follows.
+
+```rust
+# build.rs
+5: let target = format!("clang+llvm-{}-aarch64-linux-gnu-rhel-8.4", llvm_version);
+
+# shell
+export LLVM_SYS_150_PREFIX=~/.wasker/clang+llvm-15.0.0-aarch64-linux-gnu/
+```

build.rs

@@ -0,0 +1,46 @@
+use std::env;
+
+fn main() {
+    let llvm_version = "15.0.0";
+    let target = format!("clang+llvm-{}-x86_64-linux-gnu-rhel-8.4", llvm_version);
+    let home_dir = env::var("HOME").expect("fail to get home dir");
+    let wasker_dir = format!("{}/.wasker", home_dir);
+    let install_dir = format!("{}/{}", wasker_dir, target);
+
+    // Check if the specified version of LLVM is installed
+    if std::path::Path::new(&install_dir).exists() {
+        println!("LLVM is already installed in {}", install_dir);
+        return;
+    }
+    // Download LLVM from Github
+    println!("Downloading LLVM {}, it takes while...", llvm_version);
+    let url = format!(
+        "https://github.com/llvm/llvm-project/releases/download/llvmorg-{}/{}.tar.xz",
+        llvm_version, target
+    );
+    std::process::Command::new("wget")
+        .arg(&url)
+        .arg("-O")
+        .arg(format!("/tmp/{}.tar.xz", target))
+        .output()
+        .expect("Failed to download LLVM");
+
+    // Create directory
+    if !std::path::Path::new(&wasker_dir).exists() {
+        println!("Creating directory {:?}", wasker_dir);
+        std::fs::create_dir(&wasker_dir).expect("Failed to create directory");
+    }
+
+    // Extract the tar file
+    println!("Extracting tar file to {:?}", wasker_dir);
+    std::process::Command::new("tar")
+        .arg("-xf")
+        .arg(format!("/tmp/{}.tar.xz", target))
+        .arg("-C")
+        .arg(wasker_dir)
+        .output()
+        .expect("Failed to extract tar file");
+
+    // Remove the tar file
+    std::fs::remove_file(format!("/tmp/{}.tar.xz", target)).expect("Failed to remove tar file");
+}