Skip to content

Unify PyObject dereferencing in c-api #8292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
bschoenmaeckers wants to merge 4 commits into
base: main
Choose a base branch
from
+969 −594
Draft

Unify PyObject dereferencing in c-api #8292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4f9b2ef
Add codecs support to c-apo
bschoenmaeckers Jul 13, 2026
a65d9c4
Reduce code duplication
bschoenmaeckers Jul 15, 2026
c710ae8
Add `FfiPtrExt` for uniform pointer dereferences
bschoenmaeckers Jul 16, 2026
c88dc32
Panic on NULL ptrs
bschoenmaeckers Jul 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 33 additions & 33 deletions crates/capi/src/abstract_.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
use crate::util::CStrExt;
use crate::util::FfiPtrExt;
use crate::{PyObject, pystate::with_vm};
use alloc::slice;
use core::ffi::{CStr, c_char, c_int};
use core::ffi::{c_char, c_int};
pub use iter::*;
pub use mapping::*;
pub use number::*;
Expand Down Expand Up @@ -41,10 +43,10 @@ pub unsafe extern "C" fn PyObject_Call(
kwargs: *mut PyObject,
) -> *mut PyObject {
with_vm(|vm| {
let callable = unsafe { &*callable };
let args = tuple_to_args(unsafe { &*args }.try_downcast_ref::<PyTuple>(vm)?);
let callable = unsafe { callable.assume_borrowed() };
let args = tuple_to_args(unsafe { args.assume_borrowed_and_cast::<PyTuple>(vm) }?);

let kwargs: Option<KwArgs> = unsafe { kwargs.as_ref() }
let kwargs: Option<KwArgs> = unsafe { kwargs.assume_borrowed_or_opt() }
.map(|kwargs| dict_to_kwargs(vm, kwargs.try_downcast_ref::<PyDict>(vm)?))
.transpose()?;

Expand All @@ -54,7 +56,7 @@ pub unsafe extern "C" fn PyObject_Call(

#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyObject_CallNoArgs(callable: *mut PyObject) -> *mut PyObject {
with_vm(|vm| unsafe { &*callable }.call((), vm))
with_vm(|vm| unsafe { callable.assume_borrowed() }.call((), vm))
}

#[unsafe(no_mangle)]
Expand All @@ -63,8 +65,8 @@ pub unsafe extern "C" fn PyObject_CallObject(
args: *mut PyObject,
) -> *mut PyObject {
with_vm(|vm| {
let callable = unsafe { &*callable };
if let Some(args) = unsafe { args.as_ref() } {
let callable = unsafe { callable.assume_borrowed() };
if let Some(args) = unsafe { args.assume_borrowed_or_opt() } {
callable.call(tuple_to_args(args.try_downcast_ref::<PyTuple>(vm)?), vm)
} else {
callable.call((), vm)
Expand All @@ -84,7 +86,7 @@ pub unsafe extern "C" fn PyObject_Vectorcall(

let kwnames: Option<&[PyObjectRef]> = unsafe {
kwnames
.as_ref()
.assume_borrowed_or_opt()
.map(|tuple| Ok(&***tuple.try_downcast_ref::<PyTuple>(vm)?))
.transpose()?
};
Expand All @@ -99,7 +101,7 @@ pub unsafe extern "C" fn PyObject_Vectorcall(
.collect::<Vec<_>>()
};

let callable = unsafe { &*callable };
let callable = unsafe { callable.assume_borrowed() };
callable.vectorcall(args, num_positional_args, kwnames, vm)
})
}
Expand All @@ -122,8 +124,8 @@ pub unsafe extern "C" fn PyObject_VectorcallMethod(
.split_first()
.expect("args_len > 0 should guarantee a receiver");

let method_name = unsafe { (&*name).try_downcast_ref::<PyStr>(vm)? };
let callable = unsafe { (&**receiver).get_attr(method_name, vm)? };
let method_name = unsafe { name.assume_borrowed_and_cast::<PyStr>(vm)? };
let callable = unsafe { receiver.assume_borrowed().get_attr(method_name, vm)? };

Ok(unsafe {
PyObject_Vectorcall(
Expand All @@ -143,14 +145,14 @@ pub unsafe extern "C" fn PyVectorcall_Call(
kwargs: *mut PyObject,
) -> *mut PyObject {
with_vm(|vm| {
let callable = unsafe { &*callable };
let tuple = unsafe { &*tuple }.try_downcast_ref::<PyTuple>(vm)?;
let callable = unsafe { callable.assume_borrowed() };
let tuple = unsafe { tuple.assume_borrowed_and_cast::<PyTuple>(vm) }?;

let mut args = tuple.iter().cloned().collect::<Vec<_>>();
let num_positional_args = args.len();

let mut kwnames = Vec::new();
if let Some(kwargs) = unsafe { kwargs.as_ref() } {
if let Some(kwargs) = unsafe { kwargs.assume_borrowed_or_opt() } {
let kwargs = kwargs.try_downcast_ref::<PyDict>(vm)?;
for (key, value) in kwargs.items_vec() {
let key = key
Expand All @@ -175,8 +177,8 @@ pub unsafe extern "C" fn PyVectorcall_Call(
#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyObject_GetItem(obj: *mut PyObject, key: *mut PyObject) -> *mut PyObject {
with_vm(|vm| {
let obj = unsafe { &*obj };
let key = unsafe { &*key };
let obj = unsafe { obj.assume_borrowed() };
let key = unsafe { key.assume_borrowed() };
obj.get_item(key, vm)
})
}
Expand All @@ -188,29 +190,27 @@ pub unsafe extern "C" fn PyObject_SetItem(
value: *mut PyObject,
) -> c_int {
with_vm(|vm| {
let obj = unsafe { &*obj };
let key = unsafe { &*key };
let value = unsafe { &*value }.to_owned();
let obj = unsafe { obj.assume_borrowed() };
let key = unsafe { key.assume_borrowed() };
let value = unsafe { value.assume_borrowed() }.to_owned();
obj.set_item(key, value, vm)
})
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyObject_DelItem(obj: *mut PyObject, key: *mut PyObject) -> c_int {
with_vm(|vm| {
let obj = unsafe { &*obj };
let key = unsafe { &*key };
let obj = unsafe { obj.assume_borrowed() };
let key = unsafe { key.assume_borrowed() };
obj.del_item(key, vm)
})
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyObject_DelItemString(obj: *mut PyObject, key: *const c_char) -> c_int {
with_vm(|vm| {
let obj = unsafe { &*obj };
let key = unsafe { CStr::from_ptr(key) }
.to_str()
.map_err(|_| vm.new_value_error("mapping key must be valid UTF-8"))?;
let obj = unsafe { obj.assume_borrowed() };
let key = unsafe { key.try_as_str(vm) }?;
obj.del_item(key, vm)
})
}
Expand All @@ -221,8 +221,8 @@ pub unsafe extern "C" fn PyObject_Format(
format_spec: *mut PyObject,
) -> *mut PyObject {
with_vm(|vm| {
let obj = unsafe { &*obj };
let spec = unsafe { format_spec.as_ref() }
let obj = unsafe { obj.assume_borrowed() };
let spec = unsafe { format_spec.assume_borrowed_or_opt() }
.map(|spec| spec.try_downcast_ref::<PyStr>(vm))
.transpose()?
.unwrap_or_else(|| vm.ctx.empty_str);
Expand All @@ -233,25 +233,25 @@ pub unsafe extern "C" fn PyObject_Format(
#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyObject_IsSubclass(derived: *mut PyObject, cls: *mut PyObject) -> c_int {
with_vm(|vm| {
let derived = unsafe { &*derived };
let cls = unsafe { &*cls };
let derived = unsafe { derived.assume_borrowed() };
let cls = unsafe { cls.assume_borrowed() };
derived.is_subclass(cls, vm)
})
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyObject_IsInstance(inst: *mut PyObject, cls: *mut PyObject) -> c_int {
with_vm(|vm| {
let inst = unsafe { &*inst };
let cls = unsafe { &*cls };
let inst = unsafe { inst.assume_borrowed() };
let cls = unsafe { cls.assume_borrowed() };
inst.is_instance(cls, vm)
})
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyObject_Size(obj: *mut PyObject) -> isize {
with_vm(|vm| {
let obj = unsafe { &*obj };
let obj = unsafe { obj.assume_borrowed() };
obj.length(vm)
})
}
Expand All @@ -263,7 +263,7 @@ pub unsafe extern "C" fn PyObject_Length(obj: *mut PyObject) -> isize {

#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyObject_Type(obj: *mut PyObject) -> *mut PyObject {
with_vm(|_vm| unsafe { &*obj }.obj_type())
with_vm(|_vm| unsafe { obj.assume_borrowed() }.obj_type())
}

#[cfg(test)]
Expand Down
20 changes: 10 additions & 10 deletions crates/capi/src/abstract_/iter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use crate::util::FfiPtrExt;
use crate::{PyObject, pystate::with_vm};
use core::ffi::c_int;
use rustpython_vm::PyObjectRef;
Expand All @@ -6,13 +7,13 @@ use rustpython_vm::protocol::{PyIter, PyIterReturn};

#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyIter_Check(obj: *mut PyObject) -> c_int {
with_vm(|_vm| Ok(PyIter::check(unsafe { &*obj })))
with_vm(|_vm| Ok(PyIter::check(unsafe { obj.assume_borrowed() })))
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyAIter_Check(obj: *mut PyObject) -> c_int {
with_vm(|vm| {
Ok(unsafe { &*obj }
Ok(unsafe { obj.assume_borrowed() }
.class()
.has_attr(rustpython_vm::identifier!(vm, __anext__)))
})
Expand All @@ -21,14 +22,14 @@ pub unsafe extern "C" fn PyAIter_Check(obj: *mut PyObject) -> c_int {
#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyObject_GetIter(obj: *mut PyObject) -> *mut PyObject {
with_vm(|vm| {
let obj = unsafe { &*obj };
let obj = unsafe { obj.assume_borrowed() };
obj.get_iter(vm).map(PyObjectRef::from)
})
}

#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyObject_GetAIter(obj: *mut PyObject) -> *mut PyObject {
with_vm(|vm| unsafe { &*obj }.get_aiter(vm))
with_vm(|vm| unsafe { obj.assume_borrowed() }.get_aiter(vm))
}

#[unsafe(no_mangle)]
Expand All @@ -38,7 +39,7 @@ pub unsafe extern "C" fn PyIter_NextItem(iter: *mut PyObject, item: *mut *mut Py
*item = core::ptr::null_mut();
}

let iter = PyIter::new(unsafe { &*iter });
let iter = PyIter::new(unsafe { iter.assume_borrowed() });
match iter.next(vm)? {
PyIterReturn::Return(next_item) => {
unsafe {
Expand All @@ -54,7 +55,7 @@ pub unsafe extern "C" fn PyIter_NextItem(iter: *mut PyObject, item: *mut *mut Py
#[unsafe(no_mangle)]
pub unsafe extern "C" fn PyIter_Next(iter: *mut PyObject) -> *mut PyObject {
with_vm(|vm| {
let iter = PyIter::new(unsafe { &*iter });
let iter = PyIter::new(unsafe { iter.assume_borrowed() });
match iter.next(vm)? {
PyIterReturn::Return(next_item) => Ok(next_item.into_raw().as_ptr()),
PyIterReturn::StopIteration(_) => Ok(core::ptr::null_mut()),
Expand All @@ -73,14 +74,13 @@ pub unsafe extern "C" fn PyIter_Send(
*presult = core::ptr::null_mut();
}

let iter_obj = unsafe { &*iter };
let arg_obj = unsafe { &*arg };
let iter_obj = unsafe { iter.assume_borrowed() };
let arg_obj = unsafe { arg.assume_borrowed() };

let ret = if vm.is_none(arg_obj) {
PyIter::new(iter_obj).next(vm)?
} else {
iter_obj
.try_downcast_ref::<PyGenerator>(vm)?
unsafe { iter.assume_borrowed_and_cast::<PyGenerator>(vm) }?
.as_coro()
.send(iter_obj, arg_obj.to_owned(), vm)?
};
Expand Down
Loading