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