WebAssembly编译之(3)-WASM编译实战之C/C++导出asm.js及wasm库

news/2025/2/13 5:31:36/

引言

上一节我们介绍了Ubuntu下的WASM的编译环境快速搭建。这一节我们继续WASM编译相关的介绍——如何导出C/C++编写的函数库

WASM 相关文档:
WebAssembly编译之(1)-asm.js及WebAssembly原理介绍
WebAssembly编译之(2)-Ubuntu搭建WASM编译环境

单个C++文件(*.cpp)的导出

我们首先介绍一个文件(*.cpp)如何导出进行Emscripten编译成asm.jswasm。我们还是先直接上c++代码

// HelloTools.cpp
#include <iostream>class HelloTools{public:void print(int a, int b);int add(int a, int b);
};void HelloTools::print(int a, int b){std::cout<<"a+b="<<a<<"+"<<b<<"="<<a+b<<std::endl;
}int HelloTools::add(int a, int b){int c = 0;c = a+b;print(a , b);return c;
}

这是个HelloTools.cpp是我们前面介绍c++时用写的一个HelloTools类文件。里面主要有一个add的方法;如何导出这个库如何编译成一个web前端可调用的js库呢?

我们首先用emcc命令编译一下看看什么结果

# 注意,首次执行我们需要激活一下环境变量,找到emsdk的源码路径,进入emsdk目录,激活环境变量
source ./emsdk_env.sh
# 进入项目
cd 1.singleCPP
# 开始编译
emcc HelloTools.cpp -o HelloTools.js

编译成功,生成了HelloTools.jsHelloTools.wasm,如何检查编译的结果呢,我们继续

node环境下测试wasm

我们首先简单写一段测试test.js脚本

// test.js
var em_module = require('./HelloTools.js');
console.log(em_module);
var toolObj = new em_module();
var sum = toolObj.add(10,20);
console.log(sum);

使用node命令执行该js

node test.js

注意,需要安装好预先安装好nodejs

结果如下:

{inspect: [Function (anonymous)],FS_createDataFile: [Function: createDataFile],FS_createPreloadedFile: [Function: createPreloadedFile],___wasm_call_ctors: [Function (anonymous)],___errno_location: [Function (anonymous)],_fflush: [Function (anonymous)],_emscripten_stack_init: [Function (anonymous)],_emscripten_stack_get_free: [Function (anonymous)],_emscripten_stack_get_base: [Function (anonymous)],_emscripten_stack_get_end: [Function (anonymous)],stackSave: [Function (anonymous)],stackRestore: [Function (anonymous)],stackAlloc: [Function (anonymous)],dynCall_jiji: [Function (anonymous)]
}
/home/1.singleCPP/test-node/HelloTools.js:147throw ex;^TypeError: em_module is not a constructorat Object.<anonymous> (/home/1.singleCPP/test-node/test.js:3:15)at Module._compile (internal/modules/cjs/loader.js:1085:14)at Object.Module._extensions..js (internal/modules/cjs/loader.js:1114:10)at Module.load (internal/modules/cjs/loader.js:950:32)at Function.Module._load (internal/modules/cjs/loader.js:790:12)at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:76:12)at internal/main/run_main_module.js:17:47

正常加载,但是后面无法创建实例,报了一堆错误,用法不对,这显然不是我们期待的;而前面打印的Module模块信息来看,视乎也没发现与我们HelloTools.cpp中类相关的任何标识。

浏览器中html测试wasm

为了方便调试测试,我们采用在chrome浏览器中进行测试(后续都在这个环境下测试讲解)。我们先创建一个html测试文件,html如下所示

<!doctype html>
<html><head><meta charset="utf-8"><title>Emscripten:HelloTools Class Test</title></head><body><script>Module = {};Module.onRuntimeInitialized = function() { //此时才能获得完整Module对象console.log(Module)}</script><script src="./HelloTools.js"></script></body>
</html>

启动一个web服务,这里emsdk考虑得比较周到,已经提供一个快速启动的web服务命令emrun

首先我们看一下整个项目的文件解构

- 1.singleCPP- test-html // html测试文件夹- HelloTools.js- HelloTools.wasm- index.html // html测试文件- test-node // node测试文件夹- HelloTools.js- HelloTools.wasm- test.js // node测试文件- HelloTools.cpp // c++ 源码

启动web服务

# 进入文件夹
cd test-node
# 启动web服务
emrun --no_browser --port 8080 .

打开chrome浏览器,按下F12开的调试面板,浏览http://localhost:8080,正常加载,并打印出如下内容

在这里插入图片描述
同样,我们还是未发现任何与HelloTools.cpp相关的标识、属性或方法;我们展开Module.asm属性,如下所示:
在这里插入图片描述

正确的C导出及Javascript调用姿势

我们先从简单的开始,看看C语言下的Emscripten编译器是如何导出接口的,而Javascirpt是又如何调用的导出的C的。先上一段C代码

// HelloToolFuns.c
#include  <stdio.h>int myAdd(int a,int b){int res = a+b;return res;
}int myMutilp(int a, int b){int s = a * b;return s;
}void sayHello() {printf("Hello World!(HelloToolFuns.c)\n");
}

我们使用emcc进行编译一下

emcc HelloToolFuns.c -o ./test-html/HelloToolFuns.js

注意,记得在index.html中修改一下js引用<script src="./HelloToolFuns.js"></script>

浏览器重新加载一下,然后在Console面板直接测试javascirpt如何调用c导出的wasm接口

Javascirpt调用C接口

cwrap及ccall是wasm提供的两个在javascript下调用c接口的方法,我们以HelloToolFuns.c为例介绍调用方式:

1)通过Module.cwrap调用C接口
// Module.cwrap
var myMutilp = Module.cwrap('myMutilp', 'number', ['number','number'])
var s = myMutilp(10,20)
console.log(s);

Module.cwrap的第一个参数是函数名,第二个参数是函数返回类型,第三个是参数类型;返回类型和参数类型中可以用类型有三个,分别是:number,string和array。

number -(是js中的number,对应着C中的整型,浮点型,一般指针)
string - (是JavaScript中的string,对应着C中的char,C中char表示一个字符串)
array - (是js中的数组或类型数组,对应C中的数组;如果是类型数组,必须为Uint8Array或者Int8Array)。

2)通过Module.ccall调用C接口
// Module.ccall
var s = Module.ccall('myMutilp', 'number', ['number','number'],[10,20])
console.log(s);

Module.ccall的用于与前面Module.cwrap略有不同,Module.ccall它的参数有四个,前面三个与Module.cwrap含义及类型相同,第四个为实际传入参数。且Module.ccall是直接调用执行需要的函数,而`Module.cwarp``只是返回了具体的函数实例。

我们选择第一种方式,在console面板中测试一下

const sayHello = Module.cwrap('sayHello')

在这里插入图片描述
遗憾的发现报错了,原来默认EMCC编译器是不会把这两个函数导出的,所以我们需要在编译时指定这导出这两个函数

emcc -s EXPORTED_RUNTIME_METHODS=['cwrap','ccall'] HelloToolFuns.c -o ./test-html/HelloToolFuns.js

注意:EXTRA_EXPORTED_RUNTIME_METHODS已经被废弃,应使用EXPORTED_RUNTIME_METHODS参数

但我们再次在浏览器中测试时,又有新的错误,如下所示:

const sayHello = Module.cwrap('sayHello')
sayHello()

在这里插入图片描述
无法调用sayHello方法,提示需要导出这个方法,如何导出呢?

我们在编译时,需要使用EXPORTED_FUNCTIONS指定导出的方法

emcc -s -EXPORTED_RUNTIME_METHODS=['cwrap','ccall'] -s EXPORTED_FUNCTIONS=['_sayHello'] HelloToolFuns.c -o ./test-html/HelloToolFuns.js

这里需要注意EXPORTED_FUNCTIONS中,导出时给函数名前加下划线“_”,如上命令参数:
sayHello的导出格式,需要写成_sayHello

我们再次进行测试:

const sayHello = Module.cwrap('sayHello')
sayHello()

在这里插入图片描述
成功调取HelloToolFuns.c的中的sayHello方法!

3)通过Module._<FunctionName>直接调用(推荐)

而实际上,当我们在编译时,设置了-s EXPORTED_FUNCTIONS=['_sayHello']后,可以直接通过Module._sayHello(),进行调用,而不不需要用Module.ccallModule.cwrap调用。

Module._sayHello()

在这里插入图片描述

显然是因为EMCC编译器在Module中帮我们自动注入HelloToolFuns.c中的了sayHello()这个方法。我们可以在HelloToolFuns.js这个胶水代码中,搜索一下sayHello;

// 部分代码
/** @type {function(...*):?} */
var _sayHello = Module["_sayHello"] = createExportWrapper("sayHello"); // createExportWrapper这个方法即用来创建C代码中导出的接口

通常,我们更推荐用户使用这种直接用Module._sayHello()方法进行进行调用

4)通过Module.asm.<FunctionName>直接调用

实际上我们查看HelloToolFuns.js的源码,还发现了wasm加载完成后,把整个asm的实例挂着到了Module.asm中,Module['asm']中保存了WebAssembly实例的导出对象——而导出函数恰是WebAssembly实例供外部调用最主要的入口。
所以,我们也可直接通过Module.asm中找到我们导出的sayHello方法

Module.asm.sayHello()

在这里插入图片描述
最后,我们可以总结一下以上四种方法,最便捷的,其实是后面两种,视乎更符合Javascript的开发方法;而通过胶水代码的分析,第三种与第四种的区别并不大,第三种只是对第四经过包裹之后挂着在Module下的。

关于HelloToolFuns.js这个胶水代码的解析我们另外再花时间分析介绍源码。这里我们只要知道,它最核心的工作就帮我们做了异步加载了HelloToolFuns.wasm并实例化,且暴露了一些接口给我们使用;如何你愿意的话,完全自己写这个js甚至是可以不需要这个js,自己在js中` WebAssembly.instantiate(binary, info),然后直接调用相关C导出的接口;

正确的C++导出及Javascirpt调用姿势(重点

(待续)


http://www.ppmy.cn/news/20300.html

相关文章

智能驾驶 车牌检测和识别(二)《YOLOv5实现车牌检测(含车牌检测数据集和训练代码)》

智能驾驶 车牌检测和识别&#xff08;二&#xff09;《YOLOv5实现车牌检测&#xff08;含车牌检测数据集和训练代码&#xff09;》 目录 智能驾驶 车牌检测和识别&#xff08;二&#xff09;《YOLOv5实现车牌检测&#xff08;含车牌检测数据集和训练代码&#xff09;》 1. 前…

Swig/CPP2Java

简介 实际工程可能存在如下部分&#xff1a;业务接口需要编程高效的语言&#xff08;如Python、Java等&#xff09;&#xff0c;易于部署维护&#xff1b;而核心算法部分&#xff0c;某些场景需要高效计算&#xff0c;会使用性能高效的语言&#xff08;如C/C等&#xff09;。 …

【数组】力扣75题:颜色分类

【数组】力扣75题&#xff1a;颜色分类力扣75题&#xff1a;颜色分类解法一&#xff1a;最简单&#xff0c;直接计算解法二&#xff1a;单指针法解法三&#xff1a;0&#xff0c;1双指针法解法四&#xff1a;0&#xff0c;2双指针法建议在看题目之前先了解数组的具体知识点&…

MATLAB算法实战应用案例精讲-【数模应用】概率生成模型(Generative Model)

前言 知识储备 表征学习 背后的核心思想representation learning ,不是试图直接对高维样本空间建模,而是使用一些低维潜在空间来描述训练集中的每个观察,然后学习一个映射函数,该函数可以在潜在空间中取一个点,将其映射到原始域中的一个点。换句话说,潜在空间中的每个…

[acwing周赛复盘] 第 88 场周赛20230128

[acwing周赛复盘] 第 88 场周赛20230128 一、本周周赛总结二、 4800. 下一个1. 题目描述2. 思路分析3. 代码实现三、4801. 强连通图1. 题目描述2. 思路分析3. 代码实现四、4802. 金明的假期1. 题目描述2. 思路分析3. 代码实现六、参考链接一、本周周赛总结 在T2卡了半天&#…

Python爬虫(2)-Selenium控制浏览器

Selenium中提供了不少的方法来操作浏览器 Selenium控制浏览器1.打开浏览器2.打开浏览器后可以控制浏览器前进和后退就使用3.浏览器刷新4.浏览器切换网页窗口5.关闭页面和退出浏览器6.设置窗口大小7.获取窗口位置8.最大化窗口9.最小化窗口11.无窗口运行10.全屏11.屏幕截图12.元素…

一名普通22届本科毕业生|前端程序员|22年年终总结

文章目录22年上半年&#xff1a;最后的学生时光隔离实习币基金迷茫困惑难受不要去想人生意义读书景点环境的力量再次隔离返校入职前的学习22年下半年&#xff1a;上班工作生活总结本来准备在22年年末写的&#xff0c;奈何那段时间工作太忙没抽出时间。现在是23年的1月27日&…

创建大量TCP连接时会受到什么因素的限制?

1.文件描述符资源 用户级限制 我们可以使用ulimit命令查看系统允许当前用户进程打开的文件数限制&#xff1a; ulimit -n 我们可以使用 ulimit -n 文件数 来修改不过这种设置是临时的&#xff0c;只在当前的session中有效。为永久修改用户级文件描述符数限制&#xff0c;可以…