我是否应该在FFI的上下文中传递可变引用或转移变量的所有权?

时间:2016-09-16 15:05:20

标签: rust ffi c-strings widestring

我有一个程序通过C FFI(通过winapi-rs)使用Windows API。其中一个函数需要一个指向字符串指针的指针作为输出参数。该函数将其结果存储到此字符串中。我为此字符串使用了WideCString类型的变量。

我可以"只是"将一个可变引用传递给一个字符串引用到这个函数(在一个不安全的块内)或者我应该使用像.into_raw().from_raw()这样的函数,它还将变量的所有权移动到C功能?

这两个版本都可以编译和工作,但我想知道我是否直接购买任何缺点。

以下是我的代码中使用.into_raw.from_raw的相关行。

let mut widestr: WideCString = WideCString::from_str("test").unwrap(); //this is the string where the result should be stored
let mut security_descriptor_ptr: winnt::LPWSTR = widestr.into_raw();

let rtrn3 = unsafe {
    advapi32::ConvertSecurityDescriptorToStringSecurityDescriptorW(sd_buffer.as_mut_ptr() as *mut std::os::raw::c_void,
                                    1, 
                                    winnt::DACL_SECURITY_INFORMATION,
                                    &mut security_descriptor_ptr,
                                        ptr::null_mut())

};

if rtrn3 == 0 {
    match IOError::last_os_error().raw_os_error() {
        Some(1008) => println!("Need to fix this errror in get_acl_of_file."), // Do nothing. No idea, why this error occurs
        Some(e) => panic!("Unknown OS error in get_acl_of_file {}", e),
        None => panic!("That should not happen in get_acl_of_file!"),
    }
}

let mut rtr: WideCString = unsafe{WideCString::from_raw(security_descriptor_ptr)};

description of this parameter in MSDN说:

  

指向变量的指针,该变量接收指向 null 终止的安全描述符字符串的指针。有关字符串格式的说明,请参阅Security Descriptor String Format。要释放返回的缓冲区,请调用LocalFree函数。

我希望函数能够改变变量的值。根据定义,这不是指我移动所有权吗?

1 个答案:

答案 0 :(得分:4)

  

我希望函数能够改变变量的值。那不是 - 根据定义 - 意味着我正在移动所有权吗?

没有。思考所有权的一个关键方法是:当你完成所有权时,谁负责破坏价值。

主管C API(以及Microsoft通常属于此类别)文档期望的所有权规则,尽管有时这些词是倾斜的或承担某种程度的外部知识。这个特殊功能说:

  

要释放返回的缓冲区,请调用 LocalFree 函数。

这意味着ConvertSecurityDescriptorToStringSecurityDescriptorW将执行某种分配并将其返回给用户。检查函数声明,您还可以看到它们将该参数记录为“out”参数:

_Out_ LPTSTR               *StringSecurityDescriptor,

为什么这样做?因为调用者不知道要分配多少内存来存储字符串 1

通常,您将未初始化的内存的引用传递给函数,然后必须为您初始化它。

这个编译,但你没有提供足够的上下文来实际调用它,所以谁知道它是否有效:

extern crate advapi32;
extern crate winapi;
extern crate widestring;

use std::{mem, ptr, io};
use winapi::{winnt, PSECURITY_DESCRIPTOR};
use widestring::WideCString;

fn foo(sd_buffer: PSECURITY_DESCRIPTOR) -> WideCString {
    let mut security_descriptor = unsafe { mem::uninitialized() };

    let retval = unsafe {
        advapi32::ConvertSecurityDescriptorToStringSecurityDescriptorW(
            sd_buffer,
            1,
            winnt::DACL_SECURITY_INFORMATION,
            &mut security_descriptor,
            ptr::null_mut()
        )
    };

    if retval == 0 {
        match io::Error::last_os_error().raw_os_error() {
            Some(1008) => println!("Need to fix this errror in get_acl_of_file."), // Do nothing. No idea, why this error occurs
            Some(e) => panic!("Unknown OS error in get_acl_of_file {}", e),
            None => panic!("That should not happen in get_acl_of_file!"),
        }
    }

    unsafe { WideCString::from_raw(security_descriptor) }
}

fn main() {
    let x = foo(ptr::null_mut());
    println!("{:?}", x);
}
[dependencies]
winapi = { git = "https://github.com/nils-tekampe/winapi-rs/", rev = "1bb62e2c22d0f5833cfa9eec1db2c9cfc2a4a303" }
advapi32-sys = { git = "https://github.com/nils-tekampe/winapi-rs/", rev = "1bb62e2c22d0f5833cfa9eec1db2c9cfc2a4a303" }
widestring = "*"

直接回答您的问题:

  

我可以“只是”将一个可变引用传递给一个字符串引用到这个函数中(在一个不安全的块内)或者我应该使用像.into_raw()和.from_raw()这样的函数来移动所有权变量到C函数?

都不是。该函数不希望您将指针传递给字符串,它希望您将指针传递给 it 可以放置字符串的位置。

  

在我的例子中,我刚刚解释了(据我所知),宽带变量永远不会被C函数覆盖。它会覆盖对它的引用,但不会覆盖数据本身。

WideCString::from_str("test")分配的内存很可能完全泄露,因为在函数调用之后没有任何对该指针的引用。

  

这是C(WinAPI)函数总是自己分配缓冲区的一般规则(如果不遵循首先返回大小的两步法)?

我不相信C API之间存在任何通用规则,甚至C API内部 。特别是在拥有如此多API表面的微软公司。您需要阅读每种方法的文档。这是持续拖拽的一部分,可以使写作C感觉像是一个艰难的过程。

  对于我来说,将未初始化的内存交给这样的函数,我感觉很奇怪。

是的,因为实际上没有保证函数初始化它。实际上,如果发生故障,将其初始化将是浪费,所以它可能不会。另一件事Rust似乎有更好的解决方案。

请注意,在调用println!之类的内容之前,您不应该进行函数调用(例如last_os_error);那些函数调用可能会改变最后一个错误的值!

1 其他Windows API实际上需要一个多步骤进程 - 您使用NULL调用该函数,它返回您需要分配的字节数,然后你又叫它了