feat: ffi string and buffer support #11648
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,13 +10,17 @@ use deno_core::Extension; | |
| use deno_core::OpState; | ||
| use deno_core::Resource; | ||
| use deno_core::ResourceId; | ||
| use deno_core::ZeroCopyBuf; | ||
| use dlopen::raw::Library; | ||
| use libffi::middle::Arg; | ||
| use serde::Deserialize; | ||
| use std::borrow::Cow; | ||
| use std::collections::HashMap; | ||
| use std::convert::TryFrom; | ||
| use std::ffi::c_void; | ||
| use std::ffi::CStr; | ||
| use std::ffi::CString; | ||
| use std::os::raw::c_char; | ||
| use std::rc::Rc; | ||
|
|
||
| pub struct Unstable(pub bool); | ||
|
|
@@ -50,6 +54,7 @@ struct Symbol { | |
| ptr: libffi::middle::CodePtr, | ||
| parameter_types: Vec<NativeType>, | ||
| result_type: NativeType, | ||
| result_length: Option<usize>, | ||
| } | ||
|
|
||
| struct DynamicLibraryResource { | ||
|
|
@@ -75,22 +80,22 @@ impl DynamicLibraryResource { | |
| ) -> Result<(), AnyError> { | ||
| let fn_ptr = unsafe { self.lib.symbol::<*const c_void>(&symbol) }?; | ||
| let ptr = libffi::middle::CodePtr::from_ptr(fn_ptr as _); | ||
| let parameter_types = | ||
| foreign_fn.parameters.into_iter().map(NativeType::from); | ||
| let result_type = NativeType::from(foreign_fn.result); | ||
| let cif = libffi::middle::Cif::new( | ||
| parameter_types.clone().map(libffi::middle::Type::from), | ||
| result_type.into(), | ||
| ); | ||
|
|
||
| self.symbols.insert( | ||
| symbol, | ||
| Symbol { | ||
| cif, | ||
| ptr, | ||
| parameter_types: parameter_types.collect(), | ||
| result_type, | ||
| result_length: foreign_fn.result_length, | ||
| }, | ||
| ); | ||
|
|
||
|
|
@@ -132,6 +137,8 @@ enum NativeType { | |
| ISize, | ||
| F32, | ||
| F64, | ||
| String, | ||
| Buffer, | ||
| } | ||
|
|
||
| impl From<NativeType> for libffi::middle::Type { | ||
|
|
@@ -150,85 +157,99 @@ impl From<NativeType> for libffi::middle::Type { | |
| NativeType::ISize => libffi::middle::Type::isize(), | ||
| NativeType::F32 => libffi::middle::Type::f32(), | ||
| NativeType::F64 => libffi::middle::Type::f64(), | ||
| NativeType::String => libffi::middle::Type::pointer(), | ||
| NativeType::Buffer => libffi::middle::Type::pointer(), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl From<String> for NativeType { | ||
| fn from(string: String) -> Self { | ||
| match string.as_str() { | ||
| "void" => NativeType::Void, | ||
| "u8" => NativeType::U8, | ||
| "i8" => NativeType::I8, | ||
| "u16" => NativeType::U16, | ||
| "i16" => NativeType::I16, | ||
| "u32" => NativeType::U32, | ||
| "i32" => NativeType::I32, | ||
| "u64" => NativeType::U64, | ||
| "i64" => NativeType::I64, | ||
| "usize" => NativeType::USize, | ||
| "isize" => NativeType::ISize, | ||
| "f32" => NativeType::F32, | ||
| "f64" => NativeType::F64, | ||
| "string" => NativeType::String, | ||
| "buffer" => NativeType::Buffer, | ||
| _ => unimplemented!(), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| enum NativeValue { | ||
| Void, | ||
| U8(u8), | ||
| I8(i8), | ||
| U16(u16), | ||
| I16(i16), | ||
| U32(u32), | ||
| I32(i32), | ||
| U64(u64), | ||
| I64(i64), | ||
| USize(usize), | ||
| ISize(isize), | ||
| F32(f32), | ||
| F64(f64), | ||
| String(*const i8), | ||
| Buffer(*const u8), | ||
| } | ||
|
|
||
| impl NativeValue { | ||
| fn from_value(native_type: NativeType, value: Value) -> Self { | ||
| match native_type { | ||
| NativeType::Void => Self::Void, | ||
| NativeType::U8 => Self::U8(value_as_uint::<u8>(value)), | ||
| NativeType::I8 => Self::I8(value_as_int::<i8>(value)), | ||
| NativeType::U16 => Self::U16(value_as_uint::<u16>(value)), | ||
| NativeType::I16 => Self::I16(value_as_int::<i16>(value)), | ||
| NativeType::U32 => Self::U32(value_as_uint::<u32>(value)), | ||
| NativeType::I32 => Self::I32(value_as_int::<i32>(value)), | ||
| NativeType::U64 => Self::U64(value_as_uint::<u64>(value)), | ||
| NativeType::I64 => Self::I64(value_as_int::<i64>(value)), | ||
| NativeType::USize => Self::USize(value_as_uint::<usize>(value)), | ||
| NativeType::ISize => Self::ISize(value_as_int::<isize>(value)), | ||
| NativeType::F32 => Self::F32(value_as_f32(value)), | ||
| NativeType::F64 => Self::F64(value_as_f64(value)), | ||
| NativeType::String => Self::String( | ||
| CString::new( | ||
| value | ||
| .as_str() | ||
| .expect("Expected ffi arg value to be a string"), | ||
| ) | ||
| .unwrap() | ||
| .into_raw(), | ||
|
There was a problem hiding this comment. This introduces a memory leak in most cases. There was a problem hiding this comment. agreed for the JS -> rust part but how are you going to get rust strings to javascript? passing writable buffer? how do you get its size? what if it doesn't fit? and how many copying/translating is expected to be there? and what about There was a problem hiding this comment. BTW: here's how The rust part is here: Link to the article: http://jakegoulding.com/rust-ffi-omnibus/string_return/ |
||
| ), | ||
| NativeType::Buffer => unreachable!(), | ||
| } | ||
| } | ||
|
|
||
| fn as_arg(&self) -> Arg { | ||
| match self { | ||
| Self::Void => Arg::new(&()), | ||
| Self::U8(value) => Arg::new(value), | ||
| Self::I8(value) => Arg::new(value), | ||
| Self::U16(value) => Arg::new(value), | ||
| Self::I16(value) => Arg::new(value), | ||
| Self::U32(value) => Arg::new(value), | ||
| Self::I32(value) => Arg::new(value), | ||
| Self::U64(value) => Arg::new(value), | ||
| Self::I64(value) => Arg::new(value), | ||
| Self::USize(value) => Arg::new(value), | ||
| Self::ISize(value) => Arg::new(value), | ||
| Self::F32(value) => Arg::new(value), | ||
| Self::F64(value) => Arg::new(value), | ||
| Self::String(value) => Arg::new(value), | ||
| Self::Buffer(value) => Arg::new(value), | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -258,9 +279,11 @@ fn value_as_f64(value: Value) -> f64 { | |
| } | ||
|
|
||
| #[derive(Deserialize, Debug)] | ||
| #[serde(rename_all = "camelCase")] | ||
| struct ForeignFunction { | ||
| parameters: Vec<String>, | ||
| result: String, | ||
| result_length: Option<usize>, | ||
| } | ||
|
|
||
| #[derive(Deserialize, Debug)] | ||
|
|
@@ -294,12 +317,13 @@ where | |
| Ok(state.resource_table.add(resource)) | ||
| } | ||
|
|
||
| #[derive(Deserialize)] | ||
| #[serde(rename_all = "camelCase")] | ||
| struct FfiCallArgs { | ||
| rid: ResourceId, | ||
| symbol: String, | ||
| parameters: Vec<Value>, | ||
| buffers: Vec<ZeroCopyBuf>, | ||
| } | ||
|
|
||
| fn op_ffi_call( | ||
|
|
@@ -316,20 +340,27 @@ fn op_ffi_call( | |
| .get(&args.symbol) | ||
| .ok_or_else(bad_resource_id)?; | ||
|
|
||
| let buffers: Vec<&[u8]> = | ||
| args.buffers.iter().map(|buffer| &buffer[..]).collect(); | ||
|
|
||
| let native_values = symbol | ||
| .parameter_types | ||
| .iter() | ||
| .zip(args.parameters.into_iter()) | ||
| .map(|(&native_type, value)| { | ||
| if let NativeType::Buffer = native_type { | ||
| let idx: usize = value_as_uint(value); | ||
| let ptr = buffers[idx].as_ptr(); | ||
| NativeValue::Buffer(ptr) | ||
| } else { | ||
| NativeValue::from_value(native_type, value) | ||
| } | ||
| }) | ||
| .collect::<Vec<_>>(); | ||
|
|
||
| let call_args = native_values | ||
| .iter() | ||
| .map(|native_value| native_value.as_arg()) | ||
| .collect::<Vec<_>>(); | ||
|
|
||
| Ok(match symbol.result_type { | ||
|
|
@@ -372,5 +403,21 @@ fn op_ffi_call( | |
| NativeType::F64 => { | ||
| json!(unsafe { symbol.cif.call::<f64>(symbol.ptr, &call_args) }) | ||
| } | ||
| NativeType::String => { | ||
| json!(unsafe { | ||
| let ptr = symbol.cif.call::<*const c_char>(symbol.ptr, &call_args); | ||
| let cstr = CStr::from_ptr(ptr); | ||
| cstr.to_str().unwrap() | ||
| }) | ||
| } | ||
| NativeType::Buffer => { | ||
| let ptr = unsafe { symbol.cif.call::<*const u8>(symbol.ptr, &call_args) }; | ||
| if let Some(len) = symbol.result_length { | ||
| let slice = unsafe { std::slice::from_raw_parts(ptr, len) }; | ||
|
There was a problem hiding this comment. I don't believe this can be used in a safe way without leaking memory. |
||
| json!(slice) | ||
| } else { | ||
| json!(ptr as usize) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this code threw
TypeErrorpreviously indlopenInvalidArgumentsbut now it only throwsError