[feature] #4126: add implementation for Box<str> FFI conversion

Signed-off-by: Marin Veršić <[email protected]>
hyperledger-iroha · Jan 11, 2024 · ab90379 · ab90379
1 parent 300a031
commit ab90379
Show file tree

Hide file tree

Showing 15 changed files with 265 additions and 189 deletions.
diff --git a/ffi/derive/src/lib.rs b/ffi/derive/src/lib.rs
@@ -260,7 +260,7 @@ pub fn ffi_type_derive(input: TokenStream) -> TokenStream {
 ///     /* function implementation */
 ///     FfiReturn::Ok
 /// }
-/// extern "C" fn Foo__bar(handle: *const Foo, output: *mut SliceRef<u8>) -> FfiReturn {
+/// extern "C" fn Foo__bar(handle: *const Foo, output: *mut RefSlice<u8>) -> FfiReturn {
 ///     /* function implementation */
 ///     FfiReturn::Ok
 /// }

diff --git a/ffi/derive/src/wrapper.rs b/ffi/derive/src/wrapper.rs
@@ -382,9 +382,9 @@ fn gen_impl_ffi(name: &Ident, generics: &syn2::Generics) -> TokenStream {
             type Ref<#lifetime> = &#lifetime iroha_ffi::Extern where #(#lifetime_bounded_where_clause),*;
             type RefMut<#lifetime> = &#lifetime mut iroha_ffi::Extern where #(#lifetime_bounded_where_clause),*;
             type Box = Box<iroha_ffi::Extern>;
-            type SliceBox = Box<[iroha_ffi::Extern]>;
-            type SliceRef<#lifetime> = &#lifetime [iroha_ffi::ir::Transparent] where #(#lifetime_bounded_where_clause),*;
-            type SliceRefMut<#lifetime> = &#lifetime mut [iroha_ffi::ir::Transparent] where #(#lifetime_bounded_where_clause),*;
+            type BoxedSlice = Box<[iroha_ffi::Extern]>;
+            type RefSlice<#lifetime> = &#lifetime [iroha_ffi::ir::Transparent] where #(#lifetime_bounded_where_clause),*;
+            type RefMutSlice<#lifetime> = &#lifetime mut [iroha_ffi::ir::Transparent] where #(#lifetime_bounded_where_clause),*;
             type Vec = Vec<iroha_ffi::ir::Transparent>;
             type Arr<const N: usize> = iroha_ffi::ir::Transparent;
         }

diff --git a/ffi/src/ir.rs b/ffi/src/ir.rs
@@ -103,16 +103,16 @@ pub trait IrTypeFamily {
     type RefMut<'itm>
     where
         Self: 'itm;
-    /// [`Ir`] type that [`Box<T>`] is mapped into
+    /// [`Ir`] type that [`Box<T>`] is mapped into for any `T: Sized`
     type Box;
     /// [`Ir`] type that `Box<[T]>` is mapped into
-    type SliceBox;
+    type BoxedSlice;
     /// [`Ir`] type that `&[T]` is mapped into
-    type SliceRef<'itm>
+    type RefSlice<'itm>
     where
         Self: 'itm;
     /// [`Ir`] type that `&mut [T]` is mapped into
-    type SliceRefMut<'itm>
+    type RefMutSlice<'itm>
     where
         Self: 'itm;
     /// [`Ir`] type that [`Vec<T>`] is mapped into
@@ -126,60 +126,60 @@ impl<R: Cloned> IrTypeFamily for R {
     // NOTE: Unused
     type RefMut<'itm> = () where Self: 'itm;
     type Box = Box<Self>;
-    type SliceBox = Box<[Self]>;
-    type SliceRef<'itm> = &'itm [Self] where Self: 'itm;
+    type BoxedSlice = Box<[Self]>;
+    type RefSlice<'itm> = &'itm [Self] where Self: 'itm;
     // NOTE: Unused
-    type SliceRefMut<'itm> = () where Self: 'itm;
+    type RefMutSlice<'itm> = () where Self: 'itm;
     type Vec = Vec<Self>;
     type Arr<const N: usize> = [Self; N];
 }
 impl IrTypeFamily for Robust {
     type Ref<'itm> = Transparent;
     type RefMut<'itm> = Transparent;
     type Box = Box<Self>;
-    type SliceBox = Box<[Self]>;
-    type SliceRef<'itm> = &'itm [Self];
-    type SliceRefMut<'itm> = &'itm mut [Self];
+    type BoxedSlice = Box<[Self]>;
+    type RefSlice<'itm> = &'itm [Self];
+    type RefMutSlice<'itm> = &'itm mut [Self];
     type Vec = Vec<Self>;
     type Arr<const N: usize> = Self;
 }
 impl IrTypeFamily for Opaque {
     type Ref<'itm> = Transparent;
     type RefMut<'itm> = Transparent;
     type Box = Box<Self>;
-    type SliceBox = Box<[Self]>;
-    type SliceRef<'itm> = &'itm [Self];
-    type SliceRefMut<'itm> = &'itm mut [Self];
+    type BoxedSlice = Box<[Self]>;
+    type RefSlice<'itm> = &'itm [Self];
+    type RefMutSlice<'itm> = &'itm mut [Self];
     type Vec = Vec<Self>;
     type Arr<const N: usize> = [Self; N];
 }
 impl IrTypeFamily for Transparent {
     type Ref<'itm> = Self;
     type RefMut<'itm> = Self;
     type Box = Box<Self>;
-    type SliceBox = Box<[Self]>;
-    type SliceRef<'itm> = &'itm [Self];
-    type SliceRefMut<'itm> = &'itm mut [Self];
+    type BoxedSlice = Box<[Self]>;
+    type RefSlice<'itm> = &'itm [Self];
+    type RefMutSlice<'itm> = &'itm mut [Self];
     type Vec = Vec<Self>;
     type Arr<const N: usize> = Self;
 }
 impl IrTypeFamily for &Extern {
     type Ref<'itm> = &'itm Self where Self: 'itm;
     type RefMut<'itm> = &'itm mut Self where Self: 'itm;
     type Box = Box<Self>;
-    type SliceBox = Box<[Self]>;
-    type SliceRef<'itm> = &'itm [Self] where Self: 'itm;
-    type SliceRefMut<'itm> = &'itm mut [Self] where Self: 'itm;
+    type BoxedSlice = Box<[Self]>;
+    type RefSlice<'itm> = &'itm [Self] where Self: 'itm;
+    type RefMutSlice<'itm> = &'itm mut [Self] where Self: 'itm;
     type Vec = Vec<Self>;
     type Arr<const N: usize> = [Self; N];
 }
 impl IrTypeFamily for &mut Extern {
     type Ref<'itm> = &'itm Self where Self: 'itm;
     type RefMut<'itm> = &'itm mut Self where Self: 'itm;
     type Box = Box<Self>;
-    type SliceBox = Box<[Self]>;
-    type SliceRef<'itm> = &'itm [Self] where Self: 'itm;
-    type SliceRefMut<'itm> = &'itm mut [Self] where Self: 'itm;
+    type BoxedSlice = Box<[Self]>;
+    type RefSlice<'itm> = &'itm [Self] where Self: 'itm;
+    type RefMutSlice<'itm> = &'itm mut [Self] where Self: 'itm;
     type Vec = Vec<Self>;
     type Arr<const N: usize> = [Self; N];
 }
@@ -221,27 +221,27 @@ impl<R: Ir> Ir for Box<[R]>
 where
     R::Type: IrTypeFamily,
 {
-    type Type = <R::Type as IrTypeFamily>::SliceBox;
+    type Type = <R::Type as IrTypeFamily>::BoxedSlice;
 }
 impl<'itm, R: Ir> Ir for &'itm [R]
 where
     R::Type: IrTypeFamily,
 {
-    type Type = <R::Type as IrTypeFamily>::SliceRef<'itm>;
+    type Type = <R::Type as IrTypeFamily>::RefSlice<'itm>;
 }
 #[cfg(feature = "non_robust_ref_mut")]
 impl<'itm, R: Ir> Ir for &'itm mut [R]
 where
     R::Type: IrTypeFamily,
 {
-    type Type = <R::Type as IrTypeFamily>::SliceRefMut<'itm>;
+    type Type = <R::Type as IrTypeFamily>::RefMutSlice<'itm>;
 }
 #[cfg(not(feature = "non_robust_ref_mut"))]
 impl<'itm, R: Ir + InfallibleTransmute> Ir for &'itm mut [R]
 where
     R::Type: IrTypeFamily,
 {
-    type Type = <R::Type as IrTypeFamily>::SliceRefMut<'itm>;
+    type Type = <R::Type as IrTypeFamily>::RefMutSlice<'itm>;
 }
 impl<R: Ir> Ir for Vec<R>
 where

diff --git a/ffi/src/lib.rs b/ffi/src/lib.rs
@@ -223,7 +223,7 @@ pub struct LocalRef<'data, R>(R, core::marker::PhantomData<&'data ()>);
 /// ```
 #[derive(Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
 #[repr(transparent)]
-pub struct LocalSlice<'data, R>(alloc::vec::Vec<R>, core::marker::PhantomData<&'data ()>);
+pub struct LocalSlice<'data, R>(alloc::boxed::Box<[R]>, core::marker::PhantomData<&'data ()>);
 
 /// Result of execution of an FFI function
 #[derive(Debug, Display, Clone, Copy, PartialEq, Eq)]

diff --git a/ffi/src/primitives.rs b/ffi/src/primitives.rs
@@ -30,8 +30,8 @@ mod wasm {
         type Ref<'itm> = Transparent;
         type RefMut<'itm> = Transparent;
         type Box = Box<Robust>;
-        type SliceRef<'itm> = &'itm [Robust];
-        type SliceRefMut<'itm> = &'itm mut [Robust];
+        type RefSlice<'itm> = &'itm [Robust];
+        type RefMutSlice<'itm> = &'itm mut [Robust];
         type Vec = Vec<Robust>;
         type Arr<const N: usize> = Robust;
     }