如何将 Rust 结构的引用/指针传递给 C ffi 接口？

Question

我想做什么

我已经构建了一个 Rust 接口，我想通过 C（或 C# 但就问题而言并不重要）与之交互。因为似乎不可能使 C 可以访问 Rust Struct 我正在尝试构建一些我可以调用的包装函数，这些函数将在 Rust 中创建结构，调用结构的函数并最终手动从内存中释放结构。

为了做到这一点，我想我会将指向我在 init 函数中创建的 Struct 实例的指针传递回 C（或 C# 并将其临时存储为 IntPtr）。然后，当我调用其他函数时，我会再次将指针传递给 Rust，取消引用它并在取消引用的 Struct 上调用适当的函数，在此过程中对其进行变异。

我知道我将不得不使用不安全的代码来执行此操作，我对此很好。我可能还应该指出，我对 Rust 的生命周期管理知之甚少，而且很可能，我试图做的事情是不可能的，因为在某处很容易产生松散的指针。在这种情况下，我想知道我需要如何调整我的方法，因为我认为我不是第一个试图在 Rust 中从 C 中改变某种 state 的人。

我首先尝试了什么

所以首先我确保输出正确的库并向其中添加我的本机函数。在 Cargo.toml 中，我将 lib 类型设置为：

[lib]
crate-type = ["cdylib"]

然后我创建了一些函数来与结构交互并像这样公开它们：

#[no_mangle]
pub extern fn init() -> *mut MyStruct {
    let mut struct_instance = MyStruct::default();
    struct_instance.init();
    let raw_pointer_mut = &mut struct_instance as *mut MyStruct;
    return raw_pointer_mut;
}

#[no_mangle]
pub extern fn add_item(struct_instance_ref: *mut MyStruct) {
    unsafe {
        let struct_instance = &mut *struct_instance_ref;

        struct_instance.add_item();
    }
}

正如您在 init 函数中看到的那样，我正在创建结构，然后返回（可变）指针。

然后我在 add_item 函数中获取指针并使用它。

现在我尝试测试这个实现，因为我对指针仍然有效有一些疑问。在另一个 Rust 模块中，我加载了 .dll 和 .lib 文件（我在 Windows 上，但这与问题无关）然后相应地调用函数，如下所示：

fn main() {
    unsafe {
        let struct_pointer = init();
        add_item(struct_pointer);
        println!("The pointer adress: {:?}", struct_pointer);
    }
}

#[link(name = "my_library.dll")]
extern {
    fn init() -> *mut u32;
    fn add_item(struct_ref: *mut u32);
}

发生了什么：我确实得到了一些内存地址输出并且（因为我实际上是在实际实现中创建一个文件）我还可以看到函数按计划执行。然而，Struct 的字段似乎没有发生突变。它们基本上都是空的，在我调用add_item 函数之后它们不应该是空的（在我调用init 函数之后也不应该）。

之后我尝试了什么

我阅读了一些关于 Rust 生命周期管理的内容，因此尝试使用 Box 在 heap 上分配 Struct，如下所示：

#[no_mangle]
pub extern fn init() -> *mut Box<MyStruct> {
    let mut struct_instance = MyStruct::default();
    struct_instance.init();
    let raw_pointer_mut = &mut Box::new(struct_instance) as *mut Box<MyStruct>;
    return raw_pointer_mut;
}

#[no_mangle]
pub extern fn add_box(struct_instance_ref: *mut Box<MyStruct>) {
    unsafe {
        let struct_instance = &mut *struct_instance_ref;

        struct_instance.add_box();
    }
}

不幸的是结果和上面一样。

其他信息

我认为最好还包括Struct 的原则构成方式：

#[derive(Default)]
#[repr(C)]
pub struct MyStruct{
    // Some fields...
}

impl MyStruct{
    /// Initializes a new struct.
    pub fn init(&mut self) {
        self.some_field = whatever;
    }

    /// Adds an item to the struct.
    pub fn add_item(
        &mut self,
        maybe_more_data: of_type // Obviously the call in the external function would need to be adjusted to accomodate for that...
    ){
        some_other_function(self); // Calls another function in Rust, that will take the struct instance as an argument and mutate it.
    }
}

Answer 1

Rust 有一个强烈的 ownership 概念。问问自己：谁拥有MyStruct 实例？它是struct_instance 变量，其生命周期是init() 函数的作用域。所以init()返回后，实例被丢弃，返回一个无效的指针。

在堆上分配 MyStruct 将是解决方案，但不是您尝试的方式：实例被移动到堆中，但随后 Box 包装器绑定到相同的有问题的生命周期，因此它破坏了堆分配的对象。

一种解决方案是使用Box::into_raw 在盒子被丢弃之前将堆分配的值从盒子中取出：

#[no_mangle]
pub extern fn init() -> *mut MyStruct {
    let mut struct_instance = MyStruct::default();
    struct_instance.init();
    let box = Box::i(struct_instance);
    Box::into_raw(box)
}

要稍后销毁该值，请使用Box::from_raw 创建一个拥有它的新Box，然后让该框在超出范围时释放其包含的值：

#[no_mangle]
pub extern fn destroy(struct_instance: *mut MyStruct) {
    unsafe { Box::from_raw(struct_instance); }
}

这似乎是一个常见问题，因此可能有更惯用的解决方案。希望有经验的人能加入进来。