2 个不稳定版本
0.2.0 | 2024年7月2日 |
---|---|
0.1.0 | 2024年6月28日 |
#351 in FFI
每月47次下载
65KB
2K SLoC
Rust2Go
Rust2Go是一个项目,为用户提供了一种简单高效的方法,可以从Rust中调用Golang,并具有本地的异步支持。
功能
- Rust到Golang的同步和异步调用
- 高效的数据交换:没有序列化或套接字通信,而是FFI
- 简单的接口设计:除了原生的Rust外,没有发明新的IDL
使用方法
- 在受限制的Rust语法中定义结构体和调用接口,并将生成的代码包含在同一文件中。
- 使用
rust2go-cli --src src/user.rs --dst go/gen.go
- 为您的项目编写
build.rs
。 - 然后,您可以使用生成的实现来在Rust项目中调用Golang!
有关详细示例,请查看示例项目。
关键设计
详细设计细节可以在本文中找到: Rust-Go FFI框架的设计与实现。
为什么快?
为了达到最佳性能,本项目不基于通信,而是基于FFI来传递特殊编码的数据。为了将内存操作减少到最小,满足特定内存布局的数据直接通过引用传递,而不是复制。
例如,Vec<u8>
和 String
以指针和长度表示。然而,如 Vec<String>
或 Vec<Vec<u8>>
这样的结构需要中间表示。为了将内存分配次数减少到一次,我使用预先计算的大小缓冲区来存储这些中间结构。
内存安全
在 Golang 端,它接收的数据是从 Rust 引用的。Rust 端将尽力确保在调用期间数据的有效性。因此,Golang 端可以任意实现处理程序,但在数据超出函数生命周期时需要手动深拷贝。
在 Rust 端,需要确保在 future 释放时,回调 ffi 操作的槽指针和用户参数是有效的。这通过实现原子槽结构和提供一个 [drop_safe]
属性来实现,要求用户传递具有所有权的参数。
工具链要求
- Golang: >=1.18
- 对于 >=1.18 且 < 1.20:使用
--go118
生成 golang 代码 - 对于 >=1.20:正常生成 golang 代码
- 对于 >=1.18 且 < 1.20:使用
- Rust: >=1.75 如果要使用异步
里程碑
初始化版本
- IDL(在 Rust 中解析)
- Go 代码生成
- 构建脚本助手
- 基本数据类型和转换生成
- Rust 实现生成
- Future 和基本同步原语的使用
基本能力增强
- 支持更复杂的数据类型
- 支持用户传递引用
- 更优雅的代码生成实现
- 更好的构建缓存控制
- 支持 Golang 接口(将用户代码与生成代码分开)
- 支持动态链接
- Golang 辅助库
性能优化
- 基于共享内存的实现
扩展功能
- 支持从 Golang 调用 Rust
致谢
本项目受到 fcplug 的启发。
依赖项
~0.4–9MB
~74K SLoC