// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license. use deno_core::error::bad_resource_id; use deno_core::error::generic_error; use deno_core::error::range_error; use deno_core::error::type_error; use deno_core::error::AnyError; use deno_core::include_js_files; use deno_core::op; use deno_core::serde_json; use deno_core::serde_json::json; use deno_core::serde_json::Value; 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 serde::Serialize; use std::borrow::Cow; use std::cell::RefCell; use std::collections::HashMap; use std::ffi::c_void; use std::ffi::CStr; use std::os::raw::c_char; use std::path::Path; use std::path::PathBuf; use std::ptr; use std::rc::Rc; pub struct Unstable(pub bool); fn check_unstable(state: &OpState, api_name: &str) { let unstable = state.borrow::(); if !unstable.0 { eprintln!( "Unstable API '{}'. The --unstable flag must be provided.", api_name ); std::process::exit(70); } } pub trait FfiPermissions { fn check(&mut self, path: Option<&Path>) -> Result<(), AnyError>; } #[derive(Clone)] struct Symbol { cif: libffi::middle::Cif, ptr: libffi::middle::CodePtr, parameter_types: Vec, result_type: NativeType, } #[allow(clippy::non_send_fields_in_send_ty)] unsafe impl Send for Symbol {} unsafe impl Sync for Symbol {} struct DynamicLibraryResource { lib: Library, symbols: HashMap, } impl Resource for DynamicLibraryResource { fn name(&self) -> Cow { "dynamicLibrary".into() } fn close(self: Rc) { drop(self) } } impl DynamicLibraryResource { fn register( &mut self, name: String, foreign_fn: ForeignFunction, ) -> Result<(), AnyError> { let symbol = match &foreign_fn.name { Some(symbol) => symbol, None => &name, }; // By default, Err returned by this function does not tell // which symbol wasn't exported. So we'll modify the error // message to include the name of symbol. let fn_ptr = match unsafe { self.lib.symbol::<*const c_void>(symbol) } { Ok(value) => Ok(value), Err(err) => Err(generic_error(format!( "Failed to register symbol {}: {}", symbol, err ))), }?; let ptr = libffi::middle::CodePtr::from_ptr(fn_ptr as _); let cif = libffi::middle::Cif::new( foreign_fn .parameters .clone() .into_iter() .map(libffi::middle::Type::from), foreign_fn.result.into(), ); self.symbols.insert( name, Symbol { cif, ptr, parameter_types: foreign_fn.parameters, result_type: foreign_fn.result, }, ); Ok(()) } fn get_static(&self, symbol: String) -> Result<*const c_void, AnyError> { // By default, Err returned by this function does not tell // which symbol wasn't exported. So we'll modify the error // message to include the name of symbol. match unsafe { self.lib.symbol::<*const c_void>(&symbol) } { Ok(value) => Ok(Ok(value)), Err(err) => Err(generic_error(format!( "Failed to register symbol {}: {}", symbol, err ))), }? } } pub fn init(unstable: bool) -> Extension { Extension::builder() .js(include_js_files!( prefix "deno:ext/ffi", "00_ffi.js", )) .ops(vec![ op_ffi_load::decl::

(), op_ffi_get_static::decl(), op_ffi_call::decl(), op_ffi_call_nonblocking::decl(), op_ffi_call_ptr::decl(), op_ffi_call_ptr_nonblocking::decl(), op_ffi_ptr_of::decl::

(), op_ffi_buf_copy_into::decl::

(), op_ffi_cstr_read::decl::

(), op_ffi_read_u8::decl::

(), op_ffi_read_i8::decl::

(), op_ffi_read_u16::decl::

(), op_ffi_read_i16::decl::

(), op_ffi_read_u32::decl::

(), op_ffi_read_i32::decl::

(), op_ffi_read_u64::decl::

(), op_ffi_read_f32::decl::

(), op_ffi_read_f64::decl::

(), ]) .state(move |state| { // Stolen from deno_webgpu, is there a better option? state.put(Unstable(unstable)); Ok(()) }) .build() } #[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq)] #[serde(rename_all = "lowercase")] enum NativeType { Void, U8, I8, U16, I16, U32, I32, U64, I64, USize, ISize, F32, F64, Pointer, } impl From for libffi::middle::Type { fn from(native_type: NativeType) -> Self { match native_type { NativeType::Void => libffi::middle::Type::void(), NativeType::U8 => libffi::middle::Type::u8(), NativeType::I8 => libffi::middle::Type::i8(), NativeType::U16 => libffi::middle::Type::u16(), NativeType::I16 => libffi::middle::Type::i16(), NativeType::U32 => libffi::middle::Type::u32(), NativeType::I32 => libffi::middle::Type::i32(), NativeType::U64 => libffi::middle::Type::u64(), NativeType::I64 => libffi::middle::Type::i64(), NativeType::USize => libffi::middle::Type::usize(), NativeType::ISize => libffi::middle::Type::isize(), NativeType::F32 => libffi::middle::Type::f32(), NativeType::F64 => libffi::middle::Type::f64(), NativeType::Pointer => libffi::middle::Type::pointer(), } } } #[repr(C)] union NativeValue { void_value: (), u8_value: u8, i8_value: i8, u16_value: u16, i16_value: i16, u32_value: u32, i32_value: i32, u64_value: u64, i64_value: i64, usize_value: usize, isize_value: isize, f32_value: f32, f64_value: f64, pointer: *const u8, } impl NativeValue { fn new(native_type: NativeType, value: Value) -> Result { let value = match native_type { NativeType::Void => Self { void_value: () }, NativeType::U8 => Self { u8_value: value_as_uint::(value)?, }, NativeType::I8 => Self { i8_value: value_as_int::(value)?, }, NativeType::U16 => Self { u16_value: value_as_uint::(value)?, }, NativeType::I16 => Self { i16_value: value_as_int::(value)?, }, NativeType::U32 => Self { u32_value: value_as_uint::(value)?, }, NativeType::I32 => Self { i32_value: value_as_int::(value)?, }, NativeType::U64 => Self { u64_value: value_as_uint::(value)?, }, NativeType::I64 => Self { i64_value: value_as_int::(value)?, }, NativeType::USize => Self { usize_value: value_as_uint::(value)?, }, NativeType::ISize => Self { isize_value: value_as_int::(value)?, }, NativeType::F32 => Self { f32_value: value_as_f32(value)?, }, NativeType::F64 => Self { f64_value: value_as_f64(value)?, }, NativeType::Pointer => { if value.is_null() { Self { pointer: ptr::null(), } } else { Self { pointer: u64::from(serde_json::from_value::(value)?) as *const u8, } } } }; Ok(value) } fn buffer(ptr: *const u8) -> Self { Self { pointer: ptr } } unsafe fn as_arg(&self, native_type: NativeType) -> Arg { match native_type { NativeType::Void => Arg::new(&self.void_value), NativeType::U8 => Arg::new(&self.u8_value), NativeType::I8 => Arg::new(&self.i8_value), NativeType::U16 => Arg::new(&self.u16_value), NativeType::I16 => Arg::new(&self.i16_value), NativeType::U32 => Arg::new(&self.u32_value), NativeType::I32 => Arg::new(&self.i32_value), NativeType::U64 => Arg::new(&self.u64_value), NativeType::I64 => Arg::new(&self.i64_value), NativeType::USize => Arg::new(&self.usize_value), NativeType::ISize => Arg::new(&self.isize_value), NativeType::F32 => Arg::new(&self.f32_value), NativeType::F64 => Arg::new(&self.f64_value), NativeType::Pointer => Arg::new(&self.pointer), } } } fn value_as_uint>(value: Value) -> Result { match value.as_u64().and_then(|v| T::try_from(v).ok()) { Some(value) => Ok(value), None => Err(type_error(format!( "Expected FFI argument to be an unsigned integer, but got {:?}", value ))), } } fn value_as_int>(value: Value) -> Result { match value.as_i64().and_then(|v| T::try_from(v).ok()) { Some(value) => Ok(value), None => Err(type_error(format!( "Expected FFI argument to be a signed integer, but got {:?}", value ))), } } fn value_as_f32(value: Value) -> Result { Ok(value_as_f64(value)? as f32) } fn value_as_f64(value: Value) -> Result { match value.as_f64() { Some(value) => Ok(value), None => Err(type_error(format!( "Expected FFI argument to be a double, but got {:?}", value ))), } } #[derive(Serialize, Deserialize, Debug, Clone, Copy)] struct U32x2(u32, u32); impl From for U32x2 { fn from(value: u64) -> Self { Self((value >> 32) as u32, value as u32) } } impl From for u64 { fn from(value: U32x2) -> Self { (value.0 as u64) << 32 | value.1 as u64 } } #[derive(Deserialize, Debug)] #[serde(rename_all = "camelCase")] struct ForeignFunction { name: Option, parameters: Vec, result: NativeType, } // ForeignStatic's name and type fields are read and used by // serde_v8 to determine which variant a ForeignSymbol is. // They are not used beyond that and are thus marked with underscores. #[derive(Deserialize, Debug)] struct ForeignStatic { #[serde(rename(deserialize = "name"))] _name: Option, #[serde(rename(deserialize = "type"))] _type: String, } #[derive(Deserialize, Debug)] #[serde(untagged)] enum ForeignSymbol { ForeignFunction(ForeignFunction), ForeignStatic(ForeignStatic), } #[derive(Deserialize, Debug)] struct FfiLoadArgs { path: String, symbols: HashMap, } // `path` is only used on Windows. #[allow(unused_variables)] pub(crate) fn format_error(e: dlopen::Error, path: String) -> String { match e { #[cfg(target_os = "windows")] // This calls FormatMessageW with library path // as replacement for the insert sequences. // Unlike libstd which passes the FORMAT_MESSAGE_IGNORE_INSERTS // flag without any arguments. // // https://github.com/denoland/deno/issues/11632 dlopen::Error::OpeningLibraryError(e) => { use std::ffi::OsStr; use std::os::windows::ffi::OsStrExt; use winapi::shared::minwindef::DWORD; use winapi::shared::winerror::ERROR_INSUFFICIENT_BUFFER; use winapi::um::errhandlingapi::GetLastError; use winapi::um::winbase::FormatMessageW; use winapi::um::winbase::FORMAT_MESSAGE_ARGUMENT_ARRAY; use winapi::um::winbase::FORMAT_MESSAGE_FROM_SYSTEM; use winapi::um::winnt::LANG_SYSTEM_DEFAULT; use winapi::um::winnt::MAKELANGID; use winapi::um::winnt::SUBLANG_SYS_DEFAULT; let err_num = match e.raw_os_error() { Some(err_num) => err_num, // This should never hit unless dlopen changes its error type. None => return e.to_string(), }; // Language ID (0x0800) let lang_id = MAKELANGID(LANG_SYSTEM_DEFAULT, SUBLANG_SYS_DEFAULT) as DWORD; let mut buf = vec![0; 500]; let path = OsStr::new(&path) .encode_wide() .chain(Some(0).into_iter()) .collect::>(); let arguments = [path.as_ptr()]; loop { unsafe { let length = FormatMessageW( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ARGUMENT_ARRAY, std::ptr::null_mut(), err_num as DWORD, lang_id as DWORD, buf.as_mut_ptr(), buf.len() as DWORD, arguments.as_ptr() as _, ); if length == 0 { let err_num = GetLastError(); if err_num == ERROR_INSUFFICIENT_BUFFER { buf.resize(buf.len() * 2, 0); continue; } // Something went wrong, just return the original error. return e.to_string(); } let msg = String::from_utf16_lossy(&buf[..length as usize]); return msg; } } } _ => e.to_string(), } } #[op] fn op_ffi_load( state: &mut deno_core::OpState, args: FfiLoadArgs, ) -> Result where FP: FfiPermissions + 'static, { let path = args.path; check_unstable(state, "Deno.dlopen"); let permissions = state.borrow_mut::(); permissions.check(Some(&PathBuf::from(&path)))?; let lib = Library::open(&path).map_err(|e| { dlopen::Error::OpeningLibraryError(std::io::Error::new( std::io::ErrorKind::Other, format_error(e, path), )) })?; let mut resource = DynamicLibraryResource { lib, symbols: HashMap::new(), }; for (symbol, foreign_symbol) in args.symbols { match foreign_symbol { ForeignSymbol::ForeignStatic(_) => { // No-op: Statics will be handled separately and are not part of the Rust-side resource. } ForeignSymbol::ForeignFunction(foreign_fn) => { resource.register(symbol, foreign_fn)?; } } } Ok(state.resource_table.add(resource)) } #[derive(Deserialize)] #[serde(rename_all = "camelCase")] struct FfiCallArgs { rid: ResourceId, symbol: String, parameters: Vec, buffers: Vec>, } #[derive(Deserialize)] #[serde(rename_all = "camelCase")] struct FfiCallPtrArgs { pointer: U32x2, def: ForeignFunction, parameters: Vec, buffers: Vec>, } impl From for FfiCallArgs { fn from(args: FfiCallPtrArgs) -> Self { FfiCallArgs { rid: 0, symbol: String::new(), parameters: args.parameters, buffers: args.buffers, } } } impl FfiCallPtrArgs { fn get_symbol(&self) -> Symbol { let fn_ptr: u64 = self.pointer.into(); let ptr = libffi::middle::CodePtr::from_ptr(fn_ptr as _); let cif = libffi::middle::Cif::new( self .def .parameters .clone() .into_iter() .map(libffi::middle::Type::from), self.def.result.into(), ); Symbol { cif, ptr, parameter_types: self.def.parameters.clone(), result_type: self.def.result, } } } fn ffi_call(args: FfiCallArgs, symbol: &Symbol) -> Result { let buffers: Vec> = args .buffers .iter() .map(|buffer| buffer.as_ref().map(|buffer| &buffer[..])) .collect(); let mut native_values: Vec = vec![]; for (&native_type, value) in symbol .parameter_types .iter() .zip(args.parameters.into_iter()) { match native_type { NativeType::Pointer => match value.as_u64() { Some(idx) => { let buf = buffers .get(idx as usize) .ok_or_else(|| { generic_error(format!("No buffer present at index {}", idx)) })? .unwrap(); native_values.push(NativeValue::buffer(buf.as_ptr())); } _ => { let value = NativeValue::new(native_type, value)?; native_values.push(value); } }, _ => { let value = NativeValue::new(native_type, value)?; native_values.push(value); } } } let call_args = symbol .parameter_types .iter() .zip(native_values.iter()) .map(|(&native_type, native_value)| unsafe { native_value.as_arg(native_type) }) .collect::>(); Ok(match symbol.result_type { NativeType::Void => { json!(unsafe { symbol.cif.call::<()>(symbol.ptr, &call_args) }) } NativeType::U8 => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::I8 => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::U16 => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::I16 => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::U32 => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::I32 => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::U64 => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::I64 => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::USize => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::ISize => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::F32 => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::F64 => { json!(unsafe { symbol.cif.call::(symbol.ptr, &call_args) }) } NativeType::Pointer => { json!(U32x2::from(unsafe { symbol.cif.call::<*const u8>(symbol.ptr, &call_args) } as u64)) } }) } #[op] fn op_ffi_call_ptr(args: FfiCallPtrArgs) -> Result { let symbol = args.get_symbol(); ffi_call(args.into(), &symbol) } #[op] async fn op_ffi_call_ptr_nonblocking( args: FfiCallPtrArgs, ) -> Result { let symbol = args.get_symbol(); tokio::task::spawn_blocking(move || ffi_call(args.into(), &symbol)) .await .unwrap() } #[derive(Deserialize)] #[serde(rename_all = "camelCase")] struct FfiGetArgs { rid: ResourceId, name: String, r#type: NativeType, } #[op] fn op_ffi_get_static( state: &mut deno_core::OpState, args: FfiGetArgs, ) -> Result { let resource = state .resource_table .get::(args.rid)?; let data_ptr = resource.get_static(args.name)? as *const u8; Ok(match args.r#type { NativeType::Void => { unreachable!(); } NativeType::U8 => { json!(unsafe { ptr::read_unaligned(data_ptr as *const u8) }) } NativeType::I8 => { json!(unsafe { ptr::read_unaligned(data_ptr as *const i8) }) } NativeType::U16 => { json!(unsafe { ptr::read_unaligned(data_ptr as *const u16) }) } NativeType::I16 => { json!(unsafe { ptr::read_unaligned(data_ptr as *const i16) }) } NativeType::U32 => { json!(unsafe { ptr::read_unaligned(data_ptr as *const u32) }) } NativeType::I32 => { json!(unsafe { ptr::read_unaligned(data_ptr as *const i32) }) } NativeType::U64 => { json!(unsafe { ptr::read_unaligned(data_ptr as *const u64) }) } NativeType::I64 => { json!(unsafe { ptr::read_unaligned(data_ptr as *const i64) }) } NativeType::USize => { json!(unsafe { ptr::read_unaligned(data_ptr as *const usize) }) } NativeType::ISize => { json!(unsafe { ptr::read_unaligned(data_ptr as *const isize) }) } NativeType::F32 => { json!(unsafe { ptr::read_unaligned(data_ptr as *const f32) }) } NativeType::F64 => { json!(unsafe { ptr::read_unaligned(data_ptr as *const f64) }) } NativeType::Pointer => { json!(U32x2::from(data_ptr as *const u8 as u64)) } }) } #[op] fn op_ffi_call( state: &mut deno_core::OpState, args: FfiCallArgs, ) -> Result { let resource = state .resource_table .get::(args.rid)?; let symbol = resource .symbols .get(&args.symbol) .ok_or_else(bad_resource_id)?; ffi_call(args, symbol) } /// A non-blocking FFI call. #[op] async fn op_ffi_call_nonblocking( state: Rc>, args: FfiCallArgs, ) -> Result { let resource = state .borrow() .resource_table .get::(args.rid)?; let symbols = &resource.symbols; let symbol = symbols .get(&args.symbol) .ok_or_else(bad_resource_id)? .clone(); tokio::task::spawn_blocking(move || ffi_call(args, &symbol)) .await .unwrap() } #[op] fn op_ffi_ptr_of( state: &mut deno_core::OpState, buf: ZeroCopyBuf, ) -> Result where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; Ok(U32x2::from(buf.as_ptr() as u64)) } #[op] fn op_ffi_buf_copy_into( state: &mut deno_core::OpState, (src, mut dst, len): (U32x2, ZeroCopyBuf, usize), ) -> Result<(), AnyError> where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; if dst.len() < len { Err(range_error( "Destination length is smaller than source length", )) } else { let src = u64::from(src) as *const u8; unsafe { ptr::copy(src, dst.as_mut_ptr(), len) }; Ok(()) } } #[op] fn op_ffi_cstr_read( state: &mut deno_core::OpState, ptr: U32x2, ) -> Result where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; let ptr = u64::from(ptr) as *const c_char; Ok(unsafe { CStr::from_ptr(ptr) }.to_str()?.to_string()) } #[op] fn op_ffi_read_u8( state: &mut deno_core::OpState, ptr: U32x2, ) -> Result where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; Ok(unsafe { ptr::read_unaligned(u64::from(ptr) as *const u8) }) } #[op] fn op_ffi_read_i8( state: &mut deno_core::OpState, ptr: U32x2, ) -> Result where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; Ok(unsafe { ptr::read_unaligned(u64::from(ptr) as *const i8) }) } #[op] fn op_ffi_read_u16( state: &mut deno_core::OpState, ptr: U32x2, ) -> Result where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; Ok(unsafe { ptr::read_unaligned(u64::from(ptr) as *const u16) }) } #[op] fn op_ffi_read_i16( state: &mut deno_core::OpState, ptr: U32x2, ) -> Result where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; Ok(unsafe { ptr::read_unaligned(u64::from(ptr) as *const i16) }) } #[op] fn op_ffi_read_u32( state: &mut deno_core::OpState, ptr: U32x2, ) -> Result where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; Ok(unsafe { ptr::read_unaligned(u64::from(ptr) as *const u32) }) } #[op] fn op_ffi_read_i32( state: &mut deno_core::OpState, ptr: U32x2, ) -> Result where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; Ok(unsafe { ptr::read_unaligned(u64::from(ptr) as *const i32) }) } #[op] fn op_ffi_read_u64( state: &mut deno_core::OpState, ptr: U32x2, ) -> Result where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; Ok(U32x2::from(unsafe { ptr::read_unaligned(u64::from(ptr) as *const u64) })) } #[op] fn op_ffi_read_f32( state: &mut deno_core::OpState, ptr: U32x2, ) -> Result where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; Ok(unsafe { ptr::read_unaligned(u64::from(ptr) as *const f32) }) } #[op] fn op_ffi_read_f64( state: &mut deno_core::OpState, ptr: U32x2, ) -> Result where FP: FfiPermissions + 'static, { let permissions = state.borrow_mut::(); permissions.check(None)?; Ok(unsafe { ptr::read_unaligned(u64::from(ptr) as *const f64) }) } #[cfg(test)] mod tests { #[cfg(target_os = "windows")] #[test] fn test_format_error() { use super::format_error; // BAD_EXE_FORMAT let err = dlopen::Error::OpeningLibraryError( std::io::Error::from_raw_os_error(0x000000C1), ); assert_eq!( format_error(err, "foo.dll".to_string()), "foo.dll is not a valid Win32 application.\r\n".to_string(), ); } }