wasm_nvim

wasm_nvim

Neovim插件开发的WebAssembly接口库

wasm_nvim是Neovim的WebAssembly接口库,连接Lua和WebAssembly。可使用任何支持WebAssembly的语言开发插件,维持单进程运行。测试显示性能远超LuaJIT。库提供内存管理、函数导出和API交互功能,有利于开发高效Neovim插件。

WASM_NVIMLuaNeovimWebAssembly插件开发Github开源项目

<u>:fire:WASM_NVIM:zap:</u>

目标:

编写一个库来实现Lua和wasm之间的接口,以实现插件和Neovim API之间的通信。该库使用Rust语言编写,通过Neovim API使用Lua动态加载,而不是通过RPC路由,这种方式会在两个或多个不同进程之间造成网络瓶颈。这种方法允许单一进程**(NEOVIM)**,同时还允许插件生态系统使用任何可以编译为wasm的编程语言。

性能:

  • 第一个测试是一个简单的性能测试实现,模仿了Bram的实现,仅在for循环中对数字进行求和。wasm比LuaJIT快99%,这主要是由于编程语言(在这种情况下是zig)的编译器优化。这主要展示了编译为wasm可能带来的编译优化优势,相比于LuaJIT的即时编译。

  • 第二个测试尝试获取0-10000之间的素数,并计算在5秒内可以完成的次数。这里没有常量,因此即使是编译成wasm也不应该像第一个测试那样优化掉几乎所有的操作。在这里,wasm比LuaJIT快99%。我没有为每种特定语言优化算法,而是使用了基本结构,并避免在zig/wasm端使用位操作或栈预分配。

  • 这张图片展示了测试结果:1690628636000

  • 要运行这个测试,只需执行以下命令:

    cargo make perf

    要求:

  • 总的来说,wasm在不使用任何特殊优化技术的情况下,平均应该比luajit更快。对于更广泛的luajit vs wasm比较,可以查看这里

注意:当前显示的性能测试结果来自Windows 10 PC。这是我拥有的机器。

阅读:

理论

我们需要在每个wasm模块上实现内存分配和释放函数,这是模块开发者需要自己创建的,因为主机**(这个rust库)**和wasm插件之间目前只能直接共享i32或f32类型的数据,但其他对象如缓冲区、结构体等需要超过32位的数据,因此我们使用内存指针与模块通信,以在主机端访问和操作数据,在适用的情况下,通常涉及JSON。

从发布包安装和设置

-- 从发布包下载共享库,如果你不想从源代码构建 -- 而只想直接使用,可以这样做。警告:仅支持Windows、Linux和macOS require("wasm_nvim_dl").download("windows") -- 将"windows"替换为"linux"或"macos"以适应相应的操作系统。 -- 加载wasm_nvim local wasm = require("wasm_nvim") -- 下一行扫描并将.wasm文件加载到空间中 -- 应该只调用一次,最好在init.lua中 wasm.setup { --debug = true -- 取消注释以查看打印的调试信息,适用于调试问题。 } -- 这里的tests是一个wasm文件,./wasm文件夹中的test.wasm -- 位于neovim运行时路径中。 -- luaExecExample是test.wasm模块暴露的函数示例。 wasm.tests.luaExecExample();

从源代码构建

cargo make build

然后将/target/release/中的共享库(.so或.dll)移动到neovim运行时路径的./lua文件夹中以使用它。

要求:

  • Cargo Make cargo install cargo-make

模块要求

  • 一个名为functionality的函数,需要暴露/导出,以便可以从wasm_nvim库调用。该函数返回一个JSON,定义了导出的函数、它们接受的参数以及返回值。

    示例:

    export fn functionality() u32 { var functions = ArrayList(Functionality).init(aloc); _ = functions.append(CreateFunctionality("hi", "void", "void")) catch undefined; var stringified = ArrayList(u8).init(aloc); json.stringify(functions.items, .{}, stringified.writer()) catch undefined; var unmanaged = stringified.moveToUnmanaged(); // 获取用于设置值的ID const id = get_id(); const addr = get_addr(&unmanaged.items[0]); //设置要作为此函数返回类型使用的值 set_value(id, addr, unmanaged.items.len); return id; }

    它返回一个ID,映射到由set_value()函数创建的JSON,该JSON指向一个定义模块导出的函数和参数的JSON字符串。在这种情况下,JSON看起来像这样:

    [{"name":"hi", "params": "void", "returns": "void"}]
    • Params字段:可以是"void"或其他任何内容,实际上并不重要。当为"void"时,表示由"name"标记的函数不消耗/接受任何参数。

    • Returns字段:与Params字段情况相同,除"void"以外的任何内容都表示函数返回某些内容,否则返回void。

      当wasm模块导出函数时,这些字段是必要的,以便可能调用它们的Lua端能够在函数返回值时获取值,或在函数期望某些值时传递值。

使用自定义接口实现Neovim API以获得更多wasm性能

这部分存在的原因是,我们目前无法直接与需要Lua函数作为引用或回调参数的Neovim API交互,因此用户可能需要将他们的wasm回调包装到Lua函数中,并从那一侧作为解决方案调用neovim api。 注意:如果你遇到需要Lua函数或回调作为参数的neovim api,请向./API.MD文件提交PR,将其添加到列表中,或者你也可以创建一个issue

Wasm_Nvim暴露的可被模块使用的有用函数

以下示例使用zig

  • extern "host" get_id() u32;

    获取一个唯一的id,用于在wasm模块和外部世界之间共享数据。

  • extern "host" get_addr(*u8) u32;

    从主机获取模块内存中的地址

  • extern "host" get_value_addr(id: u32) [*]u8;

    用于获取从模块外部世界创建的值的位置。这里指向的值由模块管理和释放。 注意:一旦调用,该值就会从外部世界的内存中清除,确保在调用get_value_size之前调用此函数,以便在调用此函数之前知道长度

  • extern "host" get_value_size(id: u32) u32;

    给定一个值的id,它返回位于给定id的值的大小。应该在get_value_addr之前调用,因为那会从内存中清除id。

  • extern "host" set_value(id: u32, loc: u32, size: u32) void;

    用于从wasm模块返回/设置值到wasm_nvim库或外部世界。使用此方法的用户应确保放弃指针所指向的任何内容的内存控制权。

  • extern "host" lua_exec(id: u32) void;

    执行通过get_idset_value组合创建并传递给主机的Lua脚本字符串,然后将字符串的id传递给此函数执行。

    注意:在某些neovim版本(例如Windows上的0.9.1)上,这会将加载的字符串打印到输出。

  • extern "host"lua_eval(id: u32) u32;

    类似于lua_exec,但这个函数评估表达式并返回映射到id的值。如果评估的表达式没有返回任何内容,返回的值将显示为"null",否则该值将包含结果的内容。

    注意:这是用于表达式的,传递给此函数的任何其他内容可能导致未定义的行为

教程

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多