使用 WasmEdge 的 WebAssembly 函數來擴展 Golang 應用程序

GO 編程語言（Golang）是一種易於使用且安全的編程語言，可編譯爲高性能的原生應用程序。Golang 是編寫軟件基礎設施和框架的流行選擇。git

軟件框架的一個關鍵要求是，用戶可以使用本身的代碼對其進行擴展和定製。可是，在 Golang 應用中，向現有應用程序添加用戶定義的函數或擴展並不容易。一般，須要經過組合框架的源代碼和用戶定義的函數在源代碼級別進行集成。雖然可使用 Golang 建立動態共享模塊，但普遍用於邊緣計算的系統是基於 ARM 的，缺乏對共享模塊的支持。此外，源代碼集成和動態模塊都沒有爲用戶定義的函數提供隔離。這些擴展可能會干擾框架自己。而且集成多方的用戶定義函數會不安全。所以，Golang 做爲「雲原生」的語言，須要更好的擴展機制。github

WebAssembly 提供了一種強大、靈活、安全且簡單的擴展機制，能夠將用戶定義的函數嵌入到 Golang 應用程序中。WebAssembly 最初爲 Web 瀏覽器而發明，但愈來愈多地用於獨立和服務端應用程序，WebAssembly 是其字節碼應用程序的輕量級軟件容器。WebAssembly 是高性能、可移植的，並支持多種編程語言。golang

在本教程中，咱們將討論如何從 Golang 應用程序運行 WebAssembly 函數。 WebAssembly 函數是用 Rust 編寫的。WebAsembly 函數與 Golang 主機應用程序有着很好的隔離，同時函數之間彼此也進行了隔離。web

準備工做

顯然，咱們須要安裝 Golang，這裏假設你已經安裝了。編程

Golang 版本應該高於 1.15，咱們的示例才能工做。數組

下一步，請安裝 WasmEdge 共享庫。 WasmEdge 是一個由 CNCF 託管的領先的 WebAssembly Runtime 。咱們將使用 WasmEdge 在 Golang 應用程序中嵌入和運行 WebAssembly 程序。瀏覽器

$ wget https://github.com/second-state/WasmEdge-go/releases/download/v0.8.1/install_wasmedge.sh
$ chmod +x ./install_wasmedge.sh
$ sudo ./install_wasmedge.sh /usr/local

最後，因爲咱們的 demo WebAssembly 函數是用 Rust 編寫的，所以還須要安裝 Rust 編譯器和 rustwasmc 工具鏈。安全

嵌入一個函數

目前，咱們須要 Rust 編譯器版本 1.50 或更低版本才能讓 WebAssembly 函數與 WasmEdge 的 Golang API 一塊兒使用。一旦 interface type 規範最終肯定並獲得支持，咱們會遇上最新的Rust 編譯器版本。app

此示例中，咱們將演示如何從 Golang 應用程序調用一些簡單的 WebAssembly 函數。這些函數是用 Rust 編寫的，須要複雜的調用參數和返回值。編譯器工具須要 #[wasm_bindgen]宏來自動生成正確的代碼以將調用參數從 Golang 傳到 WebAssembly。框架

WebAssembly 規範僅支持一些開箱即用的簡單數據類型。 Wasm 不支持字符串和數組等類型。爲了將 Golang 中的豐富類型傳到 WebAssembly，編譯器須要將它們轉換爲簡單的整數。例如，它將字符串轉換爲整數內存地址和整數長度。嵌入在 rustwasmc 中的 wasm_bindgen 工具會自動進行這種轉換。

use wasm_bindgen::prelude::*;
use num_integer::lcm;
use sha3::{Digest, Sha3_256, Keccak256};

#[wasm_bindgen]
pub fn say(s: &str) -> String {
  let r = String::from("hello ");
  return r + s;
}

#[wasm_bindgen]
pub fn obfusticate(s: String) -> String {
  (&s).chars().map(|c| {
    match c {
      'A' ..= 'M' | 'a' ..= 'm' => ((c as u8) + 13) as char,
      'N' ..= 'Z' | 'n' ..= 'z' => ((c as u8) - 13) as char,
      _ => c
    }
  }).collect()
}

#[wasm_bindgen]
pub fn lowest_common_multiple(a: i32, b: i32) -> i32 {
  let r = lcm(a, b);
  return r;
}

#[wasm_bindgen]
pub fn sha3_digest(v: Vec<u8>) -> Vec<u8> {
  return Sha3_256::digest(&v).as_slice().to_vec();
}

#[wasm_bindgen]
pub fn keccak_digest(s: &[u8]) -> Vec<u8> {
  return Keccak256::digest(s).as_slice().to_vec();
}

首先，咱們使用 rustwasmc 工具將 Rust 源代碼編譯爲 WebAssembly 字節碼函數。請使用 Rust 1.50 或者更低版本。

$ rustup default 1.50.0
$ cd rust_bindgen_funcs
$ rustwasmc build
# The output WASM will be pkg/rust_bindgen_funcs_lib_bg.wasm

Golang 源代碼要運行的在 WasmEdge 中的 WebAssembly 函數示例以下。 ExecuteBindgen() 函數調用 WebAssembly 函數並使用 #[wasm_bindgen] 傳入參數。

package main

import (
    "fmt"
    "os"
    "github.com/second-state/WasmEdge-go/wasmedge"
)

func main() {
    /// Expected Args[0]: program name (./bindgen_funcs)
    /// Expected Args[1]: wasm or wasm-so file (rust_bindgen_funcs_lib_bg.wasm))

    wasmedge.SetLogErrorLevel()

    var conf = wasmedge.NewConfigure(wasmedge.WASI)
    var vm = wasmedge.NewVMWithConfig(conf)
    var wasi = vm.GetImportObject(wasmedge.WASI)
    wasi.InitWasi(
        os.Args[1:],     /// The args
        os.Environ(),    /// The envs
        []string{".:."}, /// The mapping directories
        []string{},      /// The preopens will be empty
    )

    /// Instantiate wasm
    vm.LoadWasmFile(os.Args[1])
    vm.Validate()
    vm.Instantiate()

    /// Run bindgen functions
    var res interface{}
    var err error
    
    res, err = vm.ExecuteBindgen("say", wasmedge.Bindgen_return_array, []byte("bindgen funcs test"))
    if err == nil {
        fmt.Println("Run bindgen -- say:", string(res.([]byte)))
    } 
    res, err = vm.ExecuteBindgen("obfusticate", wasmedge.Bindgen_return_array, []byte("A quick brown fox jumps over the lazy dog"))
    if err == nil {
        fmt.Println("Run bindgen -- obfusticate:", string(res.([]byte)))
    } 
    res, err = vm.ExecuteBindgen("lowest_common_multiple", wasmedge.Bindgen_return_i32, int32(123), int32(2))
    if err == nil {
        fmt.Println("Run bindgen -- lowest_common_multiple:", res.(int32))
    } 
    res, err = vm.ExecuteBindgen("sha3_digest", wasmedge.Bindgen_return_array, []byte("This is an important message"))
    if err == nil {
        fmt.Println("Run bindgen -- sha3_digest:", res.([]byte))
    } 
    res, err = vm.ExecuteBindgen("keccak_digest", wasmedge.Bindgen_return_array, []byte("This is an important message"))
    if err == nil {
        fmt.Println("Run bindgen -- keccak_digest:", res.([]byte))
    } 

    vm.Delete()
    conf.Delete()
}

接下來，讓咱們使用 WasmEdge Golang SDK 構建 Golang 應用程序。

$ go get -u github.com/second-state/WasmEdge-go/wasmedge
$ go build

運行 Golang 應用程序，它將運行嵌入在 WasmEdge Runtime 中的 WebAssembly 函數。

$ ./bindgen_funcs rust_bindgen_funcs/pkg/rust_bindgen_funcs_lib_bg.wasm
Run bindgen -- say: hello bindgen funcs test
Run bindgen -- obfusticate: N dhvpx oebja sbk whzcf bire gur ynml qbt
Run bindgen -- lowest_common_multiple: 246
Run bindgen -- sha3_digest: [87 27 231 209 189 105 251 49 159 10 211 250 15 159 154 181 43 218 26 141 56 199 25 45 60 10 20 163 54 211 195 203]
Run bindgen -- keccak_digest: [126 194 241 200 151 116 227 33 216 99 159 22 107 3 177 169 216 191 114 156 174 193 32 159 246 228 245 133 52 75 55 27]

嵌入一整個程序

你可使用最新的 Rust 編譯器和 main.rs 建立一個單獨的 WasmEdge 應用，而後將其嵌入一個 Golang 應用中。

除了函數， WasmEdge Golang SDK 也能夠嵌入獨立的 WebAssembly 應用程序，即，將一個帶有 main() 函數的 Rust 應用編譯爲 WebAssembly。

咱們的demo Rust 應用程序從一個文件中讀取。注意這裏不須要 #{wasm_bindgen] ，由於 WebAssembly 程序的輸入和輸出數據如今由 STDIN 和 STDOUT 傳遞。

use std::env;
use std::fs::File;
use std::io::{self, BufRead};

fn main() {
    // Get the argv.
    let args: Vec<String> = env::args().collect();
    if args.len() <= 1 {
        println!("Rust: ERROR - No input file name.");
        return;
    }

    // Open the file.
    println!("Rust: Opening input file \"{}\"...", args[1]);
    let file = match File::open(&args[1]) {
        Err(why) => {
            println!("Rust: ERROR - Open file \"{}\" failed: {}", args[1], why);
            return;
        },
        Ok(file) => file,
    };

    // Read lines.
    let reader = io::BufReader::new(file);
    let mut texts:Vec<String> = Vec::new();
    for line in reader.lines() {
        if let Ok(text) = line {
            texts.push(text);
        }
    }
    println!("Rust: Read input file \"{}\" succeeded.", args[1]);

    // Get stdin to print lines.
    println!("Rust: Please input the line number to print the line of file.");
    let stdin = io::stdin();
    for line in stdin.lock().lines() {
        let input = line.unwrap();
        match input.parse::<usize>() {
            Ok(n) => if n > 0 && n <= texts.len() {
                println!("{}", texts[n - 1]);
            } else {
                println!("Rust: ERROR - Line \"{}\" is out of range.", n);
            },
            Err(e) => println!("Rust: ERROR - Input \"{}\" is not an integer: {}", input, e),
        }
    }
    println!("Rust: Process end.");
}

使用 rustwasmc 工具將應用程序編譯爲 WebAssembly。

$ cd rust_readfile
$ rustwasmc build
# The output file will be pkg/rust_readfile.wasm

Golang 源代碼運行在 WasmEdge 中 WebAssembly 函數，以下：

package main

import (
    "os"
    "github.com/second-state/WasmEdge-go/wasmedge"
)

func main() {
    wasmedge.SetLogErrorLevel()

    var conf = wasmedge.NewConfigure(wasmedge.REFERENCE_TYPES)
    conf.AddConfig(wasmedge.WASI)
    var vm = wasmedge.NewVMWithConfig(conf)
    var wasi = vm.GetImportObject(wasmedge.WASI)
    wasi.InitWasi(
        os.Args[1:],     /// The args
        os.Environ(),    /// The envs
        []string{".:."}, /// The mapping directories
        []string{},      /// The preopens will be empty
    )

    /// Instantiate wasm. _start refers to the main() function
    vm.RunWasmFile(os.Args[1], "_start")

    vm.Delete()
    conf.Delete()
}

接下來，讓咱們使用 WasmEdge Golang SDK 構建 Golang 應用程序。

$ go get -u github.com/second-state/WasmEdge-go
$ go build

運行 Golang 應用。

$ ./read_file rust_readfile/pkg/rust_readfile.wasm file.txt
Rust: Opening input file "file.txt"...
Rust: Read input file "file.txt" succeeded.
Rust: Please input the line number to print the line of file.
# Input "5" and press Enter.
5
# The output will be the 5th line of `file.txt`:
abcDEF___!@#$%^
# To terminate the program, send the EOF (Ctrl + D).
^D
# The output will print the terminate message:
Rust: Process end.

接下來

本文中，咱們展現了在 Golang 應用程序中嵌入 WebAssembly 函數的兩種方法：嵌入一個 WebAssembly 函數以及嵌入一個完整的程序。更多示例能夠參考 WasmEdge-go-examples GitHub repo。

下一篇文章，咱們將研究將 AI 推理（圖像識別）函數嵌入到基於 Golang 的實時流數據處理框架的完整示例。這在智能工廠和汽車中有實際應用。