• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用JSVM-API接口进行WebAssembly模块相关开发
2
3## 简介
4
5JSVM-API WebAssembly 接口提供了 WebAssembly 字节码编译、WebAssembly 函数优化、WebAssembly cache 序列化和反序列化的能力。
6
7## 基本概念
8
9- **wasm module**：表示一个 WebAssembly 模块，(WebAssembly 简称为wasm)，通过 `OH_JSVM_CompileWasmModule` 接口可以从 wasm 字节码或 wasm cache 创建 wasm module。通过 `OH_JSVM_IsWasmModuleObject` 接口可以判断一个 JSVM_Value 是否是一个 wasm module。
10- **wasm function**：表示 wasm module 中定义的函数，wasm function 在导出后被外部代码使用。`OH_JSVM_CompileWasmFunction` 接口提供了将 wasm function 编译为优化后的机器码的能力，方便开发者对指定 wasm function 提前编译和函数粒度的并行编译。
11- **wasm cache**：对 wasm module 中的机器码进行序列化，生成的数据被称为 wasm cache。wasm cache 的创建和释放接口分别为 `OH_JSVM_CreateWasmCache` 和 `OH_JSVM_ReleaseCache` (对应的 cacheType 为 `JSVM_CACHE_TYPE_WASM`)。
12
13## 接口说明
14
15| 接口                          | 功能说明                                                                                 |
16| --------------------------- | ------------------------------------------------------------------------------------ |
17| OH_JSVM_CompileWasmModule   | 将 wasm 字节码同步编译为 wasm module。如果提供了 cache 参数，先尝试将 cache 反序列为 wasm module，反序列化失败时再执行编译。 |
18| OH_JSVM_CompileWasmFunction | 将 wasm module 中指定编号的函数编译为优化后的机器码，目前只使能了最高的优化等级，函数编号的合法性由接口调用者保证。                     |
19| OH_JSVM_IsWasmModuleObject  | 判断传入的值是否是一个 wasm module。                                                             |
20| OH_JSVM_CreateWasmCache     | 将 wasm module 中的机器码序列化为 wasm cache，如果 wasm module 不包含机器码，则会序列化失败。                    |
21| OH_JSVM_ReleaseCache        | 释放由 JSVM 接口生成的 cache。传入的 cacheType 和 cacheData 必须匹配，否则会产生未定义行为。                      |
22
23## 使用示例
24
25JSVM-API 接口开发流程参考 [使用JSVM-API实现JS与C/C++语言交互开发流程](use-jsvm-process.md)，本文仅对接口对应 C++ 相关代码进行展示。
26
27cpp 部分代码：
28
29```cpp
30// hello.cpp
31#include "napi/native_api.h"
32#include "ark_runtime/jsvm.h"
33#include <hilog/log.h>
34
35#ifndef CHECK
36#define CHECK(cond)                                  \
37    do {                                             \
38        if (!(cond)) {                               \
39            OH_LOG_ERROR(LOG_APP, "CHECK FAILED");   \
40            abort();                                 \
41        }                                            \
42    } while (0)
43#endif
44
45// 判断一个 JSVM_Value 是否是 wasm module
46static bool IsWasmModuleObject(JSVM_Env env, JSVM_Value value) {
47    bool result;
48    JSVM_Status status = OH_JSVM_IsWasmModuleObject(env, value, &result);
49    CHECK(status == JSVM_OK);
50    return result;
51}
52
53// 由 C 字符串创建 JSVM string
54static JSVM_Value CreateString(JSVM_Env env, const char *str) {
55    JSVM_Value jsvmStr;
56    JSVM_Status status = OH_JSVM_CreateStringUtf8(env, str, JSVM_AUTO_LENGTH, &jsvmStr);
57    CHECK(status == JSVM_OK);
58    return jsvmStr;
59}
60
61// 由 C int32_t 创建 JSVM number
62static JSVM_Value CreateInt32(JSVM_Env env, int32_t val) {
63    JSVM_Value jsvmInt32;
64    JSVM_Status status = OH_JSVM_CreateInt32(env, val, &jsvmInt32);
65    CHECK(status == JSVM_OK);
66    return jsvmInt32;
67}
68
69// 对 wasm module 进行实例化
70static JSVM_Value InstantiateWasmModule(JSVM_Env env, JSVM_Value wasmModule) {
71    JSVM_Status status = JSVM_OK;
72    JSVM_Value globalThis;
73    status = OH_JSVM_GetGlobal(env, &globalThis);
74    CHECK(status == JSVM_OK);
75
76    JSVM_Value webAssembly;
77    status = OH_JSVM_GetProperty(env, globalThis, CreateString(env, "WebAssembly"), &webAssembly);
78    CHECK(status == JSVM_OK);
79
80    JSVM_Value webAssemblyInstance;
81    status = OH_JSVM_GetProperty(env, webAssembly, CreateString(env, "Instance"), &webAssemblyInstance);
82    CHECK(status == JSVM_OK);
83
84    JSVM_Value instance;
85    JSVM_Value argv[] = {wasmModule};
86    status = OH_JSVM_NewInstance(env, WebAssemblyInstance, 1, argv, &instance);
87    CHECK(status == JSVM_OK);
88    return instance;
89}
90
91// 获取 wasm 字节码 (add 模块)
92static std::vector<uint8_t> GetAddWasmBuffer() {
93    // 以下 wasmBuffer 对应的 wasm 字节码文本格式如下所示，只包含了一个函数 add
94    // (module
95    //   (func $add (param $lhs i32) (param $rhs i32) (result i32)
96    //     local.get $lhs
97    //     local.get $rhs
98    //     i32.add
99    //   )
100    //   (export "add" (func $add))
101    // )
102    std::vector<uint8_t> wasmBuffer = {0x00, 0x61, 0x73, 0x6d, 0x01, 0x00, 0x00, 0x00, 0x01, 0x07, 0x01,
103                                       0x60, 0x02, 0x7f, 0x7f, 0x01, 0x7f, 0x03, 0x02, 0x01, 0x00, 0x07,
104                                       0x07, 0x01, 0x03, 0x61, 0x64, 0x64, 0x00, 0x00, 0x0a, 0x09, 0x01,
105                                       0x07, 0x00, 0x20, 0x00, 0x20, 0x01, 0x6a, 0x0b};
106    return wasmBuffer;
107}
108
109// 验证 wasm instance 功能 (add 模块)
110static void VerifyAddWasmInstance(JSVM_Env env, JSVM_Value wasmInstance) {
111    JSVM_Status status = JSVM_OK;
112    // 从 wasm instance 获取 exports.add 函数
113    JSVM_Value exports;
114    status = OH_JSVM_GetProperty(env, wasmInstance, CreateString(env, "exports"), &exports);
115    CHECK(status == JSVM_OK);
116
117    JSVM_Value add;
118    status = OH_JSVM_GetProperty(env, exports, CreateString(env, "add"), &add);
119    CHECK(status == JSVM_OK);
120
121    // 执行 exports.add(1, 2)，期望得到结果 3
122    JSVM_Value undefined;
123    OH_JSVM_GetUndefined(env, &undefined);
124    JSVM_Value one = CreateInt32(env, 1);
125    JSVM_Value two = CreateInt32(env, 2);
126    JSVM_Value argv[] = {one, two};
127    JSVM_Value result;
128    status = OH_JSVM_CallFunction(env, undefined, add, 2, argv, &result);
129    CHECK(status == JSVM_OK);
130    int32_t resultInt32;
131    OH_JSVM_GetValueInt32(env, result, &resultInt32);
132    CHECK(resultInt32 == 3);
133}
134
135// WebAssembly demo 主函数
136static JSVM_Value WasmDemo(JSVM_Env env, JSVM_CallbackInfo info) {
137    JSVM_Status status = JSVM_OK;
138    std::vector<uint8_t> wasmBuffer = GetAddWasmBuffer();
139    uint8_t *wasmBytecode = wasmBuffer.data();
140    size_t wasmBytecodeLength = wasmBuffer.size();
141    JSVM_Value wasmModule;
142    // 根据 wasm 字节码得到 wasm module
143    status = OH_JSVM_CompileWasmModule(env, wasmBytecode, wasmBytecodeLength, NULL, 0, NULL, &wasmModule);
144    CHECK(status == JSVM_OK);
145    CHECK(IsWasmModuleObject(env, wasmModule));
146
147    // 对当前 wasm module 中定义的第一个函数 (即 add) 执行编译优化
148    int32_t functionIndex = 0;
149    // 注意：当前只支持 high level optimization，即传入 JSVM_WASM_OPT_BASELINE 和传入 JSVM_WASM_OPT_HIGH 效果是一样的
150    status = OH_JSVM_CompileWasmFunction(env, wasmModule, functionIndex, JSVM_WASM_OPT_HIGH);
151    CHECK(status == JSVM_OK);
152    // 对编译得到的 wasm module 进行实例化
153    JSVM_Value wasmInstance = InstantiateWasmModule(env, wasmModule);
154    // 对实例化的 wasm instance 中的函数进行功能验证
155    VerifyAddWasmInstance(env, wasmInstance);
156
157    // 创建 wasm cache
158    const uint8_t *wasmCacheData = NULL;
159    size_t wasmCacheLength = 0;
160    status = OH_JSVM_CreateWasmCache(env, wasmModule, &wasmCacheData, &wasmCacheLength);
161    CHECK(status == JSVM_OK);
162    // 期望 wasm cache 创建成功
163    CHECK(wasmCacheData != NULL);
164    CHECK(wasmCacheLength > 0);
165
166    // 通过将 wasm cache 赋值来模拟 cache 持久化，实际使用场景可能将 wasm cache 保存到文件
167    std::vector<uint8_t> cacheBuffer(wasmCacheData, wasmCacheData + wasmCacheLength);
168
169    // cache 一旦保存完成后，需要显式释放，以免发生内存泄露
170    // 注意：传入的 JSVM_CacheType 必须匹配
171    status = OH_JSVM_ReleaseCache(env, wasmCacheData, JSVM_CACHE_TYPE_WASM);
172    CHECK(status == JSVM_OK);
173
174    // 使用 wasm code 反序列化来生成 wasm module
175    bool cacheRejected;
176    JSVM_Value wasmModule2;
177    status = OH_JSVM_CompileWasmModule(env, wasmBytecode, wasmBytecodeLength, cacheBuffer.data(), cacheBuffer.size(),
178                                       &cacheRejected, &wasmModule2);
179    CHECK(status == JSVM_OK);
180    // 传入的 wasm cache 如果是匹配的，且内部校验通过 (如版本)，则会接受 cache
181    CHECK(cacheRejected == false);
182    CHECK(IsWasmModuleObject(env, wasmModule2));
183
184    // 对反序列化得到的 wasmModule2 进行同样的操作：函数编译、实例化、验证功能，期望也都是通过的
185    status = OH_JSVM_CompileWasmFunction(env, wasmModule2, functionIndex, JSVM_WASM_OPT_HIGH);
186    CHECK(status == JSVM_OK);
187    JSVM_Value wasmInstance2 = InstantiateWasmModule(env, wasmModule);
188    VerifyAddWasmInstance(env, wasmInstance2);
189
190    JSVM_Value result;
191    OH_JSVM_GetBoolean(env, true, &result);
192    return result;
193}
194
195// WasmDemo 方法注册回调
196static JSVM_CallbackStruct param[] = {
197    {.data = nullptr, .callback = WasmDemo}
198};
199static JSVM_CallbackStruct *method = param;
200// 将 C++ callback WasmDemo 函数注册为 JSVM globalThis.wasmDemo 属性，供 JS 侧调用
201static JSVM_PropertyDescriptor descriptor[] = {
202    {"wasmDemo", nullptr, method++, nullptr, nullptr, nullptr, JSVM_DEFAULT},
203};
204
205// 样例测试js
206const char *srcCallNative = R"JS(wasmDemo())JS";
207```