如何通过原始指针将闭包作为参数传递给 C 函数？

Posted 2023-02-19

【中文标题】如何通过原始指针将闭包作为参数传递给 C 函数？

【英文标题】：How do I pass a closure through raw pointers as an argument to a C function?

【发布时间】：2016-12-24 01:21:23

【问题描述】：

我在 Rust 中使用 WinAPI，并且有一些函数（如 EnumWindows()）需要回调。回调通常接受一个附加参数（LPARAM 类型，它是 i64 的别名），您可以使用该参数将一些自定义数据传递给回调。

我已将 Vec<T> 对象作为 LPARAM 发送到 WinAPI 回调，它工作正常。例如，在我的情况下，将 lparam 值“解包”为 Vec<RECT> 如下所示：

unsafe extern "system" fn enumerate_callback(hwnd: HWND, lparam: LPARAM) -> BOOL 
    let rects = lparam as *mut Vec<RECT>;

我现在必须传递一个闭包，而不是传递一个向量。我不能使用函数指针，因为我的闭包必须捕获一些变量，如果我使用函数，这些变量将无法访问。在 C++ 中，我会使用 std::function<> 来完成我的特定任务，我认为在 Rust 中相应的抽象是一个闭包。

我的解包代码如下：

unsafe extern "system" fn enumerate_callback(hwnd: HWND, lparam: LPARAM) -> BOOL 
    let cb: &mut FnMut(HWND) -> bool = &mut *(lparam as *mut c_void as *mut FnMut(HWND) -> bool);
    // ...

SSCCE：

use std::os::raw::c_void;

fn enum_wnd_proc(some_value: i32, lparam: i32) 
    let closure: &mut FnMut(i32) -> bool =
        unsafe  (&mut *(lparam as *mut c_void as *mut FnMut(i32) -> bool)) ;

    println!("predicate() executed and returned: ", closure(some_value));


fn main() 
    let sum = 0;
    let mut closure = |some_value: i32| -> bool 
        sum += some_value;
        sum >= 100
    ;

    let lparam = (&mut closure as *mut c_void as *mut FnMut(i32) -> bool) as i32;
    enum_wnd_proc(20, lparam);

(Playground)

我收到以下错误：

error[E0277]: expected a `std::ops::FnMut<(i32,)>` closure, found `std::ffi::c_void`
 --> src/main.rs:5:26
  |
5 |         unsafe  (&mut *(lparam as *mut c_void as *mut FnMut(i32) -> bool)) ;
  |                          ^^^^^^^^^^^^^^^^^^^^^ expected an `FnMut<(i32,)>` closure, found `std::ffi::c_void`
  |
  = help: the trait `std::ops::FnMut<(i32,)>` is not implemented for `std::ffi::c_void`
  = note: required for the cast to the object type `dyn std::ops::FnMut(i32) -> bool`

error[E0606]: casting `&mut [closure@src/main.rs:12:23: 15:6 sum:_]` as `*mut std::ffi::c_void` is invalid
  --> src/main.rs:17:19
   |
17 |     let lparam = (&mut closure as *mut c_void as *mut FnMut(i32) -> bool) as i32;
   |                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^

error[E0606]: casting `*mut dyn std::ops::FnMut(i32) -> bool` as `i32` is invalid
  --> src/main.rs:17:18
   |
17 |     let lparam = (&mut closure as *mut c_void as *mut FnMut(i32) -> bool) as i32;
   |                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = help: cast through a thin pointer first

error[E0277]: expected a `std::ops::FnMut<(i32,)>` closure, found `std::ffi::c_void`
  --> src/main.rs:17:19
   |
17 |     let lparam = (&mut closure as *mut c_void as *mut FnMut(i32) -> bool) as i32;
   |                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^ expected an `FnMut<(i32,)>` closure, found `std::ffi::c_void`
   |
   = help: the trait `std::ops::FnMut<(i32,)>` is not implemented for `std::ffi::c_void`
   = note: required for the cast to the object type `dyn std::ops::FnMut(i32) -> bool`

我想知道：

有没有办法将函数/闭包传递给不同的函数并执行“类 C”强制转换？ 将闭包强制转换为 i64 值以将其传递给回调的正确方法是什么？

我使用的是稳定版的 Rust。

【参考方案1】：

首先，代码的一些逻辑错误：

在许多平台（如 64 位）上将指针强制转换为 i32 是不正确。指针可以使用所有这些位。截断一个指针，然后在截断的地址调用一个函数将导致非常糟糕的事情。通常，您希望使用机器大小的整数（usize 或 isize）。

sum 值需要是可变的。

问题的关键在于闭包是具体类型，其占用的大小对于程序员来说是未知的，但对于编译器来说是已知的。 C 函数仅限于采用机器大小的整数。

因为闭包实现了Fn* 特征之一，我们可以引用闭包对该特征的实现来生成一个特征对象。引用一个 trait 会导致一个 fat pointer 包含两个指针大小的值。在这种情况下，它包含一个指向封闭数据的指针和一个指向 vtable 的指针，即实现该 trait 的具体方法。

一般来说，任何对dynamically-sized type type 或Box 的引用都会生成一个胖指针。

在 64 位机器上，胖指针总共为 128 位，将其转换为机器大小的指针会再次截断数据，导致真正糟糕的事情发生。

解决方案，就像计算机科学中的其他一切一样，是添加更多抽象层：

use std::os::raw::c_void;

fn enum_wnd_proc(some_value: i32, lparam: usize) 
    let trait_obj_ref: &mut &mut FnMut(i32) -> bool = unsafe 
        let closure_pointer_pointer = lparam as *mut c_void;
        &mut *(closure_pointer_pointer as *mut _)
    ;
    println!(
        "predicate() executed and returned: ",
        trait_obj_ref(some_value)
    );


fn main() 
    let mut sum = 0;
    let mut closure = |some_value: i32| -> bool 
        println!("I'm summing  + ", sum, some_value);
        sum += some_value;
        sum >= 100
    ;

    let mut trait_obj: &mut FnMut(i32) -> bool = &mut closure;
    let trait_obj_ref = &mut trait_obj;

    let closure_pointer_pointer = trait_obj_ref as *mut _ as *mut c_void;
    let lparam = closure_pointer_pointer as usize;

    enum_wnd_proc(20, lparam);

我们对胖指针进行第二次引用，它创建了一个瘦指针。这个指针的大小只有一个机器整数。

也许图表会有所帮助（或伤害）？

Reference -> Trait object -> Concrete closure
 8 bytes       16 bytes         ?? bytes

因为我们使用的是原始指针，所以现在程序员有责任确保闭包在使用它的地方的寿命更长！如果enum_wnd_proc 将指针存储在某处，您必须非常小心在关闭后不要使用它。

---

附带说明，在转换 trait 对象时使用 mem::transmute：

use std::mem;
let closure_pointer_pointer: *mut c_void = unsafe  mem::transmute(trait_obj) ;

产生更好的错误消息：

error[E0512]: transmute called with types of different sizes
  --> src/main.rs:26:57
   |
26 |     let closure_pointer_pointer: *mut c_void = unsafe  mem::transmute(trait_obj) ;
   |                                                         ^^^^^^^^^^^^^^
   |
   = note: source type: &mut dyn std::ops::FnMut(i32) -> bool (128 bits)
   = note: target type: *mut std::ffi::c_void (64 bits)

Error E0512.

---

另见

Pass a Rust trait to C Rust FFI passing trait object as context to call callbacks on How do I create a Rust callback function to pass to a FFI function? How do I convert a Rust closure to a C-style callback?

【讨论】：

感谢您的详细解答。我完全同意你关于i32 和sum 的观点，我不知道为什么我将i32 放在我的示例代码中，实际值的类型为i64（我最初也提到过，但不知何故忘记在代码中更改它）。

唯一的一件事我还是不明白，为什么我们必须把指针指向一个指针？即使 closura/trait 是无大小的对象，并且由 2 个指针组成，它仍然是一个具有两个指针的结构，对吗？那么为什么我们不能获取一个指向该内存位置的指针，该对象存储在哪里并使用它呢？ （就像在 C 中一样，您可以在其中获取指向结构的指针，或指向 C++ 中的类的指针）

@ScienceSE 这基本上就是正在发生的事情。看看我的改写/图表是否有帮助？

所以我做对了，在 Rust 中，当您尝试将指针指向未调整大小的类型时，它会为您提供所谓的“胖指针”（比“实际指针”大） ，而不是“细指针”（与sizeof(void*) 一样大），如果您尝试获取指向 C 编程语言中的结构的指针？ （即它更像是一种语言“功能”，因为通常指针不大于sizeof(void*)，因为它包含一个地址，实际数据[指向的]存储在该地址）