make ffi error structure not found point to the correct culprit

This commit is contained in:
Skgland
2025-08-17 17:35:57 +02:00
committed by Bennet Bleßmann
parent 176858ad42
commit 3b5b768f4a
2 changed files with 111 additions and 163 deletions

View File

@@ -104,7 +104,7 @@ impl FunctionImpl {
) -> Result<Value, FfiError> { ) -> Result<Value, FfiError> {
let struct_type = structs_table let struct_type = structs_table
.get(&*return_type_name.as_str()) .get(&*return_type_name.as_str())
.ok_or(FfiError::StructNotFound)?; .ok_or(FfiError::StructNotFound(return_type_name))?;
let ffi_type = unsafe { *struct_type.ffi_type.as_raw_ptr() }; let ffi_type = unsafe { *struct_type.ffi_type.as_raw_ptr() };
let layout = Layout::from_size_align(ffi_type.size, ffi_type.alignment.into()) let layout = Layout::from_size_align(ffi_type.size, ffi_type.alignment.into())
@@ -175,10 +175,8 @@ struct StructImpl {
} }
impl StructImpl { impl StructImpl {
fn layout(&self) -> Result<Layout, FfiError> { fn layout(&self) -> Result<Layout, FfiError> {
let ffi_type = unsafe {*self.ffi_type.as_raw_ptr()}; let ffi_type = unsafe { *self.ffi_type.as_raw_ptr() };
Layout::from_size_align(ffi_type.size, ffi_type.alignment.into()) Layout::from_size_align(ffi_type.size, ffi_type.alignment.into())
.map_err(|_| FfiError::LayoutError) .map_err(|_| FfiError::LayoutError)
} }
@@ -190,10 +188,7 @@ impl StructImpl {
) -> Result<FfiStruct, FfiError> { ) -> Result<FfiStruct, FfiError> {
let args = ArgValue::build_args(struct_args, &self.fields, structs_table)?; let args = ArgValue::build_args(struct_args, &self.fields, structs_table)?;
let alloc = FfiStruct::new( let alloc = FfiStruct::new(self.layout()?, FfiAllocator::Rust)?;
self.layout()?,
FfiAllocator::Rust
)?;
let Ok(mut current_layout) = Layout::from_size_align(0, 1) else { let Ok(mut current_layout) = Layout::from_size_align(0, 1) else {
return Err(FfiError::LayoutError); return Err(FfiError::LayoutError);
@@ -321,7 +316,7 @@ impl StructImpl {
FfiType::F64 => read_float::<f64>(ptr, &mut layout), FfiType::F64 => read_float::<f64>(ptr, &mut layout),
FfiType::Struct(substruct) => { FfiType::Struct(substruct) => {
let Some(substruct_type) = struct_table.get(&*substruct.as_str()) else { let Some(substruct_type) = struct_table.get(&*substruct.as_str()) else {
return Err(FfiError::StructNotFound); return Err(FfiError::StructNotFound(*substruct));
}; };
let ffi_type = *substruct_type.ffi_type.as_raw_ptr(); let ffi_type = *substruct_type.ffi_type.as_raw_ptr();
@@ -350,7 +345,6 @@ impl StructImpl {
} }
} }
struct PointerArgs<'a, 'val> { struct PointerArgs<'a, 'val> {
memory: Vec<Arg>, memory: Vec<Arg>,
phantom: PhantomData<&'a mut ArgValue<'val>>, phantom: PhantomData<&'a mut ArgValue<'val>>,
@@ -451,7 +445,7 @@ impl FfiType {
Self::F64 => libffi::middle::Type::f64(), Self::F64 => libffi::middle::Type::f64(),
Self::Struct(struct_name) => structs_table Self::Struct(struct_name) => structs_table
.get(&*struct_name.as_str()) .get(&*struct_name.as_str())
.ok_or(FfiError::StructNotFound)? .ok_or(FfiError::StructNotFound(struct_name))?
.ffi_type .ffi_type
.clone(), .clone(),
}) })
@@ -500,7 +494,7 @@ impl<'val> ArgValue<'val> {
} }
let Some(struct_type) = structs_table.get(name) else { let Some(struct_type) = structs_table.get(name) else {
return Err(FfiError::StructNotFound); return Err(FfiError::StructNotFound(*atom));
}; };
Ok(Self::Struct(struct_type.build(structs_table, args)?)) Ok(Self::Struct(struct_type.build(structs_table, args)?))
@@ -534,7 +528,7 @@ struct FfiStruct {
#[derive(Debug, Clone, Copy)] #[derive(Debug, Clone, Copy)]
pub(crate) enum FfiAllocator { pub(crate) enum FfiAllocator {
Rust, Rust,
C C,
} }
impl TryFrom<Atom> for FfiAllocator { impl TryFrom<Atom> for FfiAllocator {
@@ -544,24 +538,19 @@ impl TryFrom<Atom> for FfiAllocator {
match value { match value {
atom!("rust") => Ok(Self::Rust), atom!("rust") => Ok(Self::Rust),
atom!("c") => Ok(Self::C), atom!("c") => Ok(Self::C),
_ => Err(()) _ => Err(()),
} }
} }
} }
impl FfiAllocator { impl FfiAllocator {
/// # Safety /// # Safety
/// ///
/// - layout must not have a size of 0 /// - layout must not have a size of 0
unsafe fn alloc(self, layout: Layout) -> Result<NonNull<c_void>, FfiError> { unsafe fn alloc(self, layout: Layout) -> Result<NonNull<c_void>, FfiError> {
let ptr = match self { let ptr = match self {
FfiAllocator::Rust => { FfiAllocator::Rust => unsafe { alloc::alloc(layout).cast() },
unsafe { alloc::alloc(layout).cast() } FfiAllocator::C => unsafe { libc::malloc(layout.size()) },
},
FfiAllocator::C => {
unsafe { libc::malloc(layout.size()) }
},
}; };
NonNull::new(ptr).ok_or(FfiError::AllocationFailed) NonNull::new(ptr).ok_or(FfiError::AllocationFailed)
@@ -574,15 +563,19 @@ impl FfiAllocator {
unsafe fn dealloc(self, layout: Layout, ptr: NonNull<c_void>) { unsafe fn dealloc(self, layout: Layout, ptr: NonNull<c_void>) {
match self { match self {
FfiAllocator::Rust => unsafe { alloc::dealloc(ptr.as_ptr().cast(), layout) }, FfiAllocator::Rust => unsafe { alloc::dealloc(ptr.as_ptr().cast(), layout) },
FfiAllocator::C => unsafe {libc::free(ptr.as_ptr())}, FfiAllocator::C => unsafe { libc::free(ptr.as_ptr()) },
} }
} }
} }
impl FfiStruct { impl FfiStruct {
fn new(layout: Layout, allocator: FfiAllocator) -> Result<Self, FfiError> { fn new(layout: Layout, allocator: FfiAllocator) -> Result<Self, FfiError> {
assert_ne!(layout.size() , 0); assert_ne!(layout.size(), 0);
Ok(FfiStruct { ptr: unsafe { allocator.alloc(layout) }?, layout , allocator}) Ok(FfiStruct {
ptr: unsafe { allocator.alloc(layout) }?,
layout,
allocator,
})
} }
} }
@@ -684,17 +677,23 @@ impl ForeignFunctionTable {
allocator: FfiAllocator, allocator: FfiAllocator,
kind: Atom, kind: Atom,
mut args: Value, mut args: Value,
arena: &mut Arena arena: &mut Arena,
) -> Result<Value, FfiError> { ) -> Result<Value, FfiError> {
fn allocate_primitive<T: Copy>(
fn allocate_primitive<T: Copy>(allocator: FfiAllocator, initial_value: T, arena: &mut Arena) -> Result<Value, FfiError> { allocator: FfiAllocator,
const { assert!(std::mem::size_of::<T>() != 0)}; initial_value: T,
arena: &mut Arena,
) -> Result<Value, FfiError> {
const { assert!(std::mem::size_of::<T>() != 0) };
let ptr = unsafe { allocator.alloc(Layout::new::<T>()) }?; let ptr = unsafe { allocator.alloc(Layout::new::<T>()) }?;
unsafe { ptr.cast::<T>().write(initial_value) }; unsafe { ptr.cast::<T>().write(initial_value) };
Ok(Value::Number(fixnum!(Number, ptr.as_ptr().expose_provenance(), arena))) Ok(Value::Number(fixnum!(
Number,
ptr.as_ptr().expose_provenance(),
arena
)))
} }
match FfiType::from_atom(&kind) { match FfiType::from_atom(&kind) {
FfiType::Void => Err(FfiError::InvalidFfiType), FfiType::Void => Err(FfiError::InvalidFfiType),
FfiType::Bool => { FfiType::Bool => {
@@ -705,72 +704,46 @@ impl ForeignFunctionTable {
_ => return Err(FfiError::ValueOutOfRange), _ => return Err(FfiError::ValueOutOfRange),
}; };
allocate_primitive::<bool>(allocator, init, arena) allocate_primitive::<bool>(allocator, init, arena)
}, }
FfiType::U8 => { FfiType::U8 => allocate_primitive::<u8>(allocator, args.as_int()?, arena),
allocate_primitive::<u8>(allocator, args.as_int()?, arena) FfiType::I8 => allocate_primitive::<i8>(allocator, args.as_int()?, arena),
}, FfiType::U16 => allocate_primitive::<u16>(allocator, args.as_int()?, arena),
FfiType::I8 => { FfiType::I16 => allocate_primitive::<i16>(allocator, args.as_int()?, arena),
allocate_primitive::<i8>(allocator, args.as_int()?, arena) FfiType::U32 => allocate_primitive::<u32>(allocator, args.as_int()?, arena),
}, FfiType::I32 => allocate_primitive::<i32>(allocator, args.as_int()?, arena),
FfiType::U16 => { FfiType::U64 => allocate_primitive::<u64>(allocator, args.as_int()?, arena),
allocate_primitive::<u16>(allocator, args.as_int()?, arena) FfiType::I64 => allocate_primitive::<i64>(allocator, args.as_int()?, arena),
}, FfiType::F32 => allocate_primitive::<f32>(allocator, args.as_float()? as f32, arena),
FfiType::I16 => { FfiType::F64 => allocate_primitive::<f64>(allocator, args.as_float()?, arena),
allocate_primitive::<i16>(allocator, args.as_int()?, arena) FfiType::Ptr => allocate_primitive::<*mut c_void>(allocator, args.as_ptr()?, arena),
},
FfiType::U32 => {
allocate_primitive::<u32>(allocator, args.as_int()?, arena)
},
FfiType::I32 => {
allocate_primitive::<i32>(allocator, args.as_int()?, arena)
},
FfiType::U64 => {
allocate_primitive::<u64>(allocator, args.as_int()?, arena)
},
FfiType::I64 => {
allocate_primitive::<i64>(allocator, args.as_int()?, arena)
},
FfiType::F32 => {
allocate_primitive::<f32>(allocator, args.as_float()? as f32, arena)
},
FfiType::F64 => {
allocate_primitive::<f64>(allocator, args.as_float()?, arena)
},
FfiType::Ptr => {
allocate_primitive::<*mut c_void>(allocator, args.as_ptr()?, arena)
},
FfiType::CStr => Err(FfiError::InvalidFfiType), FfiType::CStr => Err(FfiError::InvalidFfiType),
FfiType::Struct(_) => { FfiType::Struct(_) => {
let Some(struct_impl) = self.structs.get(&*kind.as_str()) else { let Some(struct_impl) = self.structs.get(&*kind.as_str()) else {
return Err(FfiError::InvalidStruct) return Err(FfiError::InvalidStruct);
}; };
let (_, args) = args.as_struct()?; let (_, args) = args.as_struct()?;
let ffi_struct = struct_impl.build(&self.structs, args)?; let ffi_struct = struct_impl.build(&self.structs, args)?;
let ptr = ManuallyDrop::new(ffi_struct).ptr; let ptr = ManuallyDrop::new(ffi_struct).ptr;
Ok(Value::Number(fixnum!(Number, ptr.as_ptr().expose_provenance(), arena))) Ok(Value::Number(fixnum!(
}, Number,
ptr.as_ptr().expose_provenance(),
arena
)))
}
} }
} }
pub fn read_ptr( pub fn read_ptr(
&mut self, &mut self,
kind: Atom, kind: Atom,
mut ptr: Value, mut ptr: Value,
arena: &mut Arena arena: &mut Arena,
) -> Result<Value, FfiError> { ) -> Result<Value, FfiError> {
unsafe fn read_int<T>(ptr: NonNull<c_void>, arena: &mut Arena) -> Value
unsafe fn read_int<T>(
ptr: NonNull<c_void>,
arena: &mut Arena,
) -> Value
where where
T: Copy + TryInto<i64> + MightNotFitInFixnum, T: Copy + TryInto<i64> + MightNotFitInFixnum,
Integer: From<T>, Integer: From<T>,
@@ -782,128 +755,87 @@ impl ForeignFunctionTable {
let ptr = ptr.as_ptr()?; let ptr = ptr.as_ptr()?;
let Some(ptr) = NonNull::new(ptr) else { let Some(ptr) = NonNull::new(ptr) else {
return Err(FfiError::ValueOutOfRange) return Err(FfiError::ValueOutOfRange);
}; };
match FfiType::from_atom(&kind) { match FfiType::from_atom(&kind) {
FfiType::Void => Err(FfiError::InvalidFfiType), FfiType::Void => Err(FfiError::InvalidFfiType),
FfiType::Bool | FfiType::U8 => { FfiType::Bool | FfiType::U8 => Ok(unsafe { read_int::<u8>(ptr, arena) }),
Ok(unsafe {read_int::<u8>(ptr, arena)}) FfiType::I8 => Ok(unsafe { read_int::<i8>(ptr, arena) }),
}, FfiType::U16 => Ok(unsafe { read_int::<u16>(ptr, arena) }),
FfiType::I8 => { FfiType::I16 => Ok(unsafe { read_int::<i16>(ptr, arena) }),
Ok(unsafe {read_int::<i8>(ptr, arena)}) FfiType::U32 => Ok(unsafe { read_int::<u32>(ptr, arena) }),
}, FfiType::I32 => Ok(unsafe { read_int::<i32>(ptr, arena) }),
FfiType::U16 => { FfiType::U64 => Ok(unsafe { read_int::<u64>(ptr, arena) }),
Ok(unsafe {read_int::<u16>(ptr, arena)}) FfiType::I64 => Ok(unsafe { read_int::<i64>(ptr, arena) }),
}, FfiType::F32 => Ok(Value::Number(Number::Float(
FfiType::I16 => { (unsafe { ptr.cast::<f32>().read() } as f64).into(),
Ok(unsafe {read_int::<i16>(ptr, arena)}) ))),
}, FfiType::F64 => Ok(Value::Number(Number::Float(
FfiType::U32 => { unsafe { ptr.cast::<f64>().read() }.into(),
Ok(unsafe {read_int::<u32>(ptr, arena)}) ))),
},
FfiType::I32 => {
Ok(unsafe {read_int::<i32>(ptr, arena)})
},
FfiType::U64 => {
Ok(unsafe {read_int::<u64>(ptr, arena)})
},
FfiType::I64 => {
Ok(unsafe {read_int::<i64>(ptr, arena)})
},
FfiType::F32 => {
Ok(Value::Number(Number::Float((unsafe { ptr.cast::<f32>().read() } as f64) .into())))
},
FfiType::F64 => {
Ok(Value::Number(Number::Float(unsafe { ptr.cast::<f64>().read() }.into())))
},
FfiType::Ptr => { FfiType::Ptr => {
let addr = unsafe { ptr.cast::<*mut c_void>().read() }.expose_provenance(); let addr = unsafe { ptr.cast::<*mut c_void>().read() }.expose_provenance();
Ok(Value::Number(fixnum!(Number, addr, arena))) Ok(Value::Number(fixnum!(Number, addr, arena)))
}, }
FfiType::CStr => { FfiType::CStr => Ok(Value::CString(
Ok(Value::CString(unsafe { CStr::from_ptr(ptr.as_ptr().cast()) }.to_owned())) unsafe { CStr::from_ptr(ptr.as_ptr().cast()) }.to_owned(),
}, )),
FfiType::Struct(_) => { FfiType::Struct(_) => {
let Some(struct_impl) = self.structs.get(&*kind.as_str()) else { let Some(struct_impl) = self.structs.get(&*kind.as_str()) else {
return Err(FfiError::InvalidStruct) return Err(FfiError::InvalidStruct);
}; };
struct_impl.read(ptr.as_ptr(), &kind.as_str(), &self.structs, arena) struct_impl.read(ptr.as_ptr(), &kind.as_str(), &self.structs, arena)
}, }
} }
} }
pub fn deallocate( pub fn deallocate(
&mut self, &mut self,
allocator: FfiAllocator, allocator: FfiAllocator,
kind: Atom, kind: Atom,
mut ptr: Value, mut ptr: Value,
) -> Result<(), FfiError> { ) -> Result<(), FfiError> {
fn deallocate_primitive<T: Copy>(allocator: FfiAllocator, ptr: NonNull<c_void>) { fn deallocate_primitive<T: Copy>(allocator: FfiAllocator, ptr: NonNull<c_void>) {
const { assert!(std::mem::size_of::<T>() != 0)}; const { assert!(std::mem::size_of::<T>() != 0) };
unsafe { allocator.dealloc(Layout::new::<T>(), ptr) }; unsafe { allocator.dealloc(Layout::new::<T>(), ptr) };
} }
let ptr = ptr.as_ptr()?; let ptr = ptr.as_ptr()?;
let Some(ptr) = NonNull::new(ptr) else { let Some(ptr) = NonNull::new(ptr) else {
return Err(FfiError::ValueOutOfRange) return Err(FfiError::ValueOutOfRange);
}; };
match FfiType::from_atom(&kind) { match FfiType::from_atom(&kind) {
FfiType::Void => return Err(FfiError::InvalidFfiType), FfiType::Void => return Err(FfiError::InvalidFfiType),
FfiType::Bool => { FfiType::Bool => deallocate_primitive::<bool>(allocator, ptr),
deallocate_primitive::<bool>(allocator, ptr) FfiType::U8 => deallocate_primitive::<u8>(allocator, ptr),
}, FfiType::I8 => deallocate_primitive::<i8>(allocator, ptr),
FfiType::U8 => { FfiType::U16 => deallocate_primitive::<u16>(allocator, ptr),
deallocate_primitive::<u8>(allocator, ptr) FfiType::I16 => deallocate_primitive::<i16>(allocator, ptr),
}, FfiType::U32 => deallocate_primitive::<u32>(allocator, ptr),
FfiType::I8 => { FfiType::I32 => deallocate_primitive::<i32>(allocator, ptr),
deallocate_primitive::<i8>(allocator, ptr) FfiType::U64 => deallocate_primitive::<u64>(allocator, ptr),
}, FfiType::I64 => deallocate_primitive::<i64>(allocator, ptr),
FfiType::U16 => { FfiType::F32 => deallocate_primitive::<f32>(allocator, ptr),
deallocate_primitive::<u16>(allocator, ptr) FfiType::F64 => deallocate_primitive::<f64>(allocator, ptr),
}, FfiType::Ptr => deallocate_primitive::<*mut c_void>(allocator, ptr),
FfiType::I16 => {
deallocate_primitive::<i16>(allocator, ptr)
},
FfiType::U32 => {
deallocate_primitive::<u32>(allocator, ptr)
},
FfiType::I32 => {
deallocate_primitive::<i32>(allocator, ptr)
},
FfiType::U64 => {
deallocate_primitive::<u64>(allocator, ptr)
},
FfiType::I64 => {
deallocate_primitive::<i64>(allocator, ptr)
},
FfiType::F32 => {
deallocate_primitive::<f32>(allocator, ptr)
},
FfiType::F64 => {
deallocate_primitive::<f64>(allocator, ptr)
},
FfiType::Ptr => {
deallocate_primitive::<*mut c_void>(allocator, ptr)
},
FfiType::CStr => return Err(FfiError::InvalidFfiType), FfiType::CStr => return Err(FfiError::InvalidFfiType),
FfiType::Struct(_) => { FfiType::Struct(_) => {
let Some(struct_impl) = self.structs.get(&*kind.as_str()) else { let Some(struct_impl) = self.structs.get(&*kind.as_str()) else {
return Err(FfiError::InvalidStruct) return Err(FfiError::InvalidStruct);
}; };
let layout = struct_impl.layout()?; let layout = struct_impl.layout()?;
drop(FfiStruct { ptr, layout, allocator}) drop(FfiStruct {
}, ptr,
layout,
allocator,
})
}
} }
Ok(()) Ok(())
} }
@@ -971,7 +903,7 @@ pub enum FfiError {
InvalidFfiType, InvalidFfiType,
InvalidStruct, InvalidStruct,
FunctionNotFound, FunctionNotFound,
StructNotFound, StructNotFound(Atom),
ArgCountMismatch, ArgCountMismatch,
AllocationFailed, AllocationFailed,
// LayoutError should never occour // LayoutError should never occour

View File

@@ -622,13 +622,29 @@ impl MachineState {
FfiError::InvalidArgument => atom!("invalid_argument"), FfiError::InvalidArgument => atom!("invalid_argument"),
FfiError::InvalidStruct => atom!("invalid_struct"), FfiError::InvalidStruct => atom!("invalid_struct"),
FfiError::FunctionNotFound => atom!("function_not_found"), FfiError::FunctionNotFound => atom!("function_not_found"),
FfiError::StructNotFound => atom!("struct_not_found"), FfiError::StructNotFound(culprit) => {
let stub = functor!(
atom!("ffi_error"),
[
atom_as_cell((atom!("struct_not_found"))),
atom_as_cell(culprit)
]
);
return MachineError {
stub,
location: None,
};
}
FfiError::ArgCountMismatch => atom!("mismatched_argument_count"), FfiError::ArgCountMismatch => atom!("mismatched_argument_count"),
FfiError::AllocationFailed => atom!("allocation_failed"), FfiError::AllocationFailed => atom!("allocation_failed"),
FfiError::LayoutError => atom!("layout_error"), FfiError::LayoutError => atom!("layout_error"),
FfiError::UnsupportedAbi => atom!("unsupported_abi"), FfiError::UnsupportedAbi => atom!("unsupported_abi"),
}; };
let stub = functor!(atom!("ffi_error"), [atom_as_cell(error_atom), cell(culprit)]); let stub = functor!(
atom!("ffi_error"),
[atom_as_cell(error_atom), cell(culprit)]
);
MachineError { MachineError {
stub, stub,