如何将一个结构数组从Rust返回到C#

时间:2015-11-07 09:51:29

标签: c# interop rust marshalling dynamic-arrays

我正在学习Rust,因为我试图找到一个用C / C ++替代C#的替代方法。

如何编写Rust代码,如下面的C代码?到目前为止,这是我的Rust代码,没有选择编组它:

pub struct PackChar { id: u32, val_str: String, }

#[no_mangle]
pub extern fn get_packs_char(size: u32) -> Vec<PackChar> {

    let mut out_vec = Vec::new();

    for i in 0 .. size {
        let int_0 = '0' as u32;
        let last_char_val = int_0 + i % (126 - int_0);
        let last_char = char::from_u32(last_char_val).unwrap();
        let buffer = format!("abcdefgHi{}", last_char);

        let pack_char = PackChar {
            id: i,
            val_str: buffer,
        };

        out_vec.push(pack_char);
    }

    out_vec
}

上面的代码尝试重现以下C代码,我可以按原样与其进行互操作。

void GetPacksChar(int size, PackChar** DpArrPnt)
{
    int TmpStrSize = 10;
    *DpArrPnt = (PackChar*)CoTaskMemAlloc( size * sizeof(PackChar));
    PackChar* CurPackPnt = *DpArrPnt;
    char dummyString[]= "abcdefgHij";
    for (int i = 0; i < size; i++,CurPackPnt++)
    {
        dummyString[TmpStrSize-1] = '0' + i % (126 - '0');
        CurPackPnt->IntVal = i;
        CurPackPnt->buffer = strdup(dummyString);
    }
}

可以通过C#中的DLL导入访问此C代码,如下所示:

[Dllimport("DllPath", CallingConvention = CallingConvention.Cdecl)]
public static extern void GetPacksChar(uint length, PackChar** ArrayStructs)

PackChar* MyPacksChar;
GetPacksChar(10, &MyPacksChar);
PackChar* CurrentPack = MyPacksChar;
var contLst = new List<PackChar>();
for (uint i = 0; i < ArrL; i++, CurrentPack++)
    contlist.Add(new PackChar() {
        IntVal = CurrentPack->IntVal, buffer = contLst->buffer
    });

1 个答案:

答案 0 :(得分:5)

让我们将其分解为您的Rust代码需要满足的各种要求:

  1. DLL需要使用正确的名称GetPacksChar公开函数。这是因为您使用C#中的名称GetPacksChar声明它,并且名称必须匹配。
  2. 该函数需要正确的调用约定,在本例中为extern "C"。这是因为您将函数声明为来自C#的CallingConvention = CallingConvention.Cdecl,它与Rust中的extern "C"调用约定相匹配。
  3. 该函数需要正确的签名,在这种情况下,使用Rust等效于uintPackChar**并且不返回任何内容。这与函数签名fn (u32, *mut *mut PackChar)匹配。
  4. PackChar的声明需要在C#和Rust之间匹配。我将在下面进行讨论。
  5. 该函数需要复制原始C函数的行为。我将在下面进行讨论。
  6. 最简单的部分是在Rust中声明函数:

    #[no_mangle]
    pub extern "C" fn GetPacksChar(length: u32, array_ptr: *mut *mut PackChar) {}
    

    接下来我们需要解决PackChar问题。根据它在C#代码中的使用方式,它看起来应该声明:

    #[repr(C)]
    pub struct PackChar {
        pub IntVal: i32,
        pub buffer: *mut u8,
    }
    

    断开这一点,#[repr(C)]告诉Rust编译器以与C编译器相同的方式在内存中安排PackChar,这很重要,因为你告诉C#它正在调用C {{1} 1}}和IntVal都来自C#和原始C版本。 {C}版本中buffer被声明为IntVal,因此我们在Rust版本中使用inti32被视为C中的字节数组,因此我们在Rust中使用buffer

    请注意,C#中*mut u8的定义应与C / Rust中的声明匹配,因此:

    PackChar

    现在剩下的就是重现Rust中C函数的原始行为:

    public struct PackChar {
        public int IntVal;
        public char* buffer;
    }
    

    上述要点:

    • 我们必须在#[no_mangle] pub extern "C" fn GetPacksChar(len: u32, array_ptr: *const *mut PackChar) { static DUMMY_STR: &'static [u8] = b"abcdefgHij\0"; // Allocate space for an array of `len` `PackChar` objects. let bytes_to_alloc = len * mem::size_of::<PackChar>(); *array_ptr = CoTaskMemAlloc(bytes_to_alloc) as *mut PackChar; // Convert the raw array of `PackChar` objects into a Rust slice and // initialize each element of the array. let mut array = slice::from_raw_parts(len as usize, *array_ptr); for (index, pack_char) in array.iter_mut().enumerate() { pack_char.IntVal = index; pack_char.buffer = strdup(DUMMY_STR as ptr); pack_char.buffer[DUMMY_STR.len() - 1] = b'0' + index % (126 - b'0'); } } 中手动包含空终止字符(\0),因为它意味着是一个C字符串。
    • 我们称DUMMY_STRCoTaskMemAlloc()为C函数。 strdup()位于libc crate,您可以在the ole32-sys crate找到。
    • 该函数声明为strdup()因为我们必须做一些不安全的事情,比如调用C函数和执行unsafe

    希望有所帮助!