Skip to content

Separate Debug from PyPayload #6320

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

Merged
youknowone merged 1 commit into from
Dec 2, 2025
Merged

Separate Debug from PyPayload #6320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion crates/vm/src/builtins/dict.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -751,7 +751,7 @@ impl ExactSizeIterator for DictIter<'_> {

#[pyclass]
trait DictView: PyPayload + PyClassDef + Iterable + Representable {
type ReverseIter: PyPayload;
type ReverseIter: PyPayload + std::fmt::Debug;

fn dict(&self) -> &PyDictRef;
fn item(vm: &VirtualMachine, key: PyObjectRef, value: PyObjectRef) -> PyObjectRef;
Expand Down
92 changes: 41 additions & 51 deletions crates/vm/src/object/core.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
use super::{
PyAtomicRef,
ext::{AsObject, PyRefExact, PyResult},
payload::PyObjectPayload,
payload::PyPayload,
};
use crate::object::traverse::{MaybeTraverse, Traverse, TraverseFn};
use crate::object::traverse_object::PyObjVTable;
Expand Down Expand Up @@ -76,10 +76,10 @@ use std::{
#[derive(Debug)]
pub(super) struct Erased;

pub(super) unsafe fn drop_dealloc_obj<T: PyObjectPayload>(x: *mut PyObject) {
pub(super) unsafe fn drop_dealloc_obj<T: PyPayload>(x: *mut PyObject) {
drop(unsafe { Box::from_raw(x as *mut PyInner<T>) });
}
pub(super) unsafe fn debug_obj<T: PyObjectPayload>(
pub(super) unsafe fn debug_obj<T: PyPayload + std::fmt::Debug>(
x: &PyObject,
f: &mut fmt::Formatter<'_>,
) -> fmt::Result {
Expand All @@ -88,10 +88,7 @@ pub(super) unsafe fn debug_obj<T: PyObjectPayload>(
}

/// Call `try_trace` on payload
pub(super) unsafe fn try_trace_obj<T: PyObjectPayload>(
x: &PyObject,
tracer_fn: &mut TraverseFn<'_>,
) {
pub(super) unsafe fn try_trace_obj<T: PyPayload>(x: &PyObject, tracer_fn: &mut TraverseFn<'_>) {
let x = unsafe { &*(x as *const PyObject as *const PyInner<T>) };
let payload = &x.payload;
payload.try_traverse(tracer_fn)
Expand Down Expand Up @@ -441,7 +438,7 @@ impl InstanceDict {
}
}

impl<T: PyObjectPayload> PyInner<T> {
impl<T: PyPayload + std::fmt::Debug> PyInner<T> {
fn new(payload: T, typ: PyTypeRef, dict: Option<PyDictRef>) -> Box<Self> {
let member_count = typ.slots.member_count;
Box::new(Self {
Expand Down Expand Up @@ -531,15 +528,15 @@ impl PyObjectRef {
/// If the downcast fails, the original ref is returned in as `Err` so
/// another downcast can be attempted without unnecessary cloning.
#[inline(always)]
pub fn downcast<T: PyObjectPayload>(self) -> Result<PyRef<T>, Self> {
pub fn downcast<T: PyPayload>(self) -> Result<PyRef<T>, Self> {
if self.downcastable::<T>() {
Ok(unsafe { self.downcast_unchecked() })
} else {
Err(self)
}
}

pub fn try_downcast<T: PyObjectPayload>(self, vm: &VirtualMachine) -> PyResult<PyRef<T>> {
pub fn try_downcast<T: PyPayload>(self, vm: &VirtualMachine) -> PyResult<PyRef<T>> {
T::try_downcast_from(&self, vm)?;
Ok(unsafe { self.downcast_unchecked() })
}
Expand All @@ -565,10 +562,7 @@ impl PyObjectRef {
/// If the downcast fails, the original ref is returned in as `Err` so
/// another downcast can be attempted without unnecessary cloning.
#[inline]
pub fn downcast_exact<T: PyObjectPayload + crate::PyPayload>(
self,
vm: &VirtualMachine,
) -> Result<PyRefExact<T>, Self> {
pub fn downcast_exact<T: PyPayload>(self, vm: &VirtualMachine) -> Result<PyRefExact<T>, Self> {
if self.class().is(T::class(&vm.ctx)) {
// TODO: is this always true?
assert!(
Expand Down Expand Up @@ -638,7 +632,7 @@ impl PyObject {

#[deprecated(note = "use downcastable instead")]
#[inline(always)]
pub fn payload_is<T: PyObjectPayload>(&self) -> bool {
pub fn payload_is<T: PyPayload>(&self) -> bool {
self.0.typeid == T::payload_type_id()
}

Expand All @@ -648,7 +642,7 @@ impl PyObject {
/// The actual payload type must be T.
#[deprecated(note = "use downcast_unchecked_ref instead")]
#[inline(always)]
pub const unsafe fn payload_unchecked<T: PyObjectPayload>(&self) -> &T {
pub const unsafe fn payload_unchecked<T: PyPayload>(&self) -> &T {
// we cast to a PyInner<T> first because we don't know T's exact offset because of
// varying alignment, but once we get a PyInner<T> the compiler can get it for us
let inner = unsafe { &*(&self.0 as *const PyInner<Erased> as *const PyInner<T>) };
Expand All @@ -657,7 +651,7 @@ impl PyObject {

#[deprecated(note = "use downcast_ref instead")]
#[inline(always)]
pub fn payload<T: PyObjectPayload>(&self) -> Option<&T> {
pub fn payload<T: PyPayload>(&self) -> Option<&T> {
#[allow(deprecated)]
if self.payload_is::<T>() {
#[allow(deprecated)]
Expand All @@ -678,10 +672,7 @@ impl PyObject {

#[deprecated(note = "use downcast_ref_if_exact instead")]
#[inline(always)]
pub fn payload_if_exact<T: PyObjectPayload + crate::PyPayload>(
&self,
vm: &VirtualMachine,
) -> Option<&T> {
pub fn payload_if_exact<T: PyPayload>(&self, vm: &VirtualMachine) -> Option<&T> {
if self.class().is(T::class(&vm.ctx)) {
#[allow(deprecated)]
self.payload()
Expand Down Expand Up @@ -730,12 +721,12 @@ impl PyObject {

/// Check if this object can be downcast to T.
#[inline(always)]
pub fn downcastable<T: PyObjectPayload>(&self) -> bool {
pub fn downcastable<T: PyPayload>(&self) -> bool {
T::downcastable_from(self)
}

/// Attempt to downcast this reference to a subclass.
pub fn try_downcast_ref<'a, T: PyObjectPayload>(
pub fn try_downcast_ref<'a, T: PyPayload>(
&'a self,
vm: &VirtualMachine,
) -> PyResult<&'a Py<T>> {
Expand All @@ -745,7 +736,7 @@ impl PyObject {

/// Attempt to downcast this reference to a subclass.
#[inline(always)]
pub fn downcast_ref<T: PyObjectPayload>(&self) -> Option<&Py<T>> {
pub fn downcast_ref<T: PyPayload>(&self) -> Option<&Py<T>> {
if self.downcastable::<T>() {
// SAFETY: just checked that the payload is T, and PyRef is repr(transparent) over
// PyObjectRef
Expand All @@ -756,10 +747,7 @@ impl PyObject {
}

#[inline(always)]
pub fn downcast_ref_if_exact<T: PyObjectPayload + crate::PyPayload>(
&self,
vm: &VirtualMachine,
) -> Option<&Py<T>> {
pub fn downcast_ref_if_exact<T: PyPayload>(&self, vm: &VirtualMachine) -> Option<&Py<T>> {
self.class()
.is(T::class(&vm.ctx))
.then(|| unsafe { self.downcast_unchecked_ref::<T>() })
Expand All @@ -768,7 +756,7 @@ impl PyObject {
/// # Safety
/// T must be the exact payload type
#[inline(always)]
pub unsafe fn downcast_unchecked_ref<T: PyObjectPayload>(&self) -> &Py<T> {
pub unsafe fn downcast_unchecked_ref<T: PyPayload>(&self) -> &Py<T> {
debug_assert!(self.downcastable::<T>());
// SAFETY: requirements forwarded from caller
unsafe { &*(self as *const Self as *const Py<T>) }
Expand Down Expand Up @@ -875,7 +863,7 @@ impl AsRef<PyObject> for PyObjectRef {
}
}

impl<'a, T: PyObjectPayload> From<&'a Py<T>> for &'a PyObject {
impl<'a, T: PyPayload> From<&'a Py<T>> for &'a PyObject {
#[inline(always)]
fn from(py_ref: &'a Py<T>) -> Self {
py_ref.as_object()
Expand Down Expand Up @@ -908,7 +896,7 @@ impl fmt::Debug for PyObjectRef {
#[repr(transparent)]
pub struct Py<T>(PyInner<T>);

impl<T: PyObjectPayload> Py<T> {
impl<T: PyPayload> Py<T> {
pub fn downgrade(
&self,
callback: Option<PyObjectRef>,
Expand Down Expand Up @@ -947,7 +935,7 @@ impl<T> Deref for Py<T> {
}
}

impl<T: PyObjectPayload> Borrow<PyObject> for Py<T> {
impl<T: PyPayload> Borrow<PyObject> for Py<T> {
#[inline(always)]
fn borrow(&self) -> &PyObject {
unsafe { &*(&self.0 as *const PyInner<T> as *const PyObject) }
Expand All @@ -956,7 +944,7 @@ impl<T: PyObjectPayload> Borrow<PyObject> for Py<T> {

impl<T> std::hash::Hash for Py<T>
where
T: std::hash::Hash + PyObjectPayload,
T: std::hash::Hash + PyPayload,
{
#[inline]
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
Expand All @@ -966,27 +954,27 @@ where

impl<T> PartialEq for Py<T>
where
T: PartialEq + PyObjectPayload,
T: PartialEq + PyPayload,
{
#[inline]
fn eq(&self, other: &Self) -> bool {
self.deref().eq(other.deref())
}
}

impl<T> Eq for Py<T> where T: Eq + PyObjectPayload {}
impl<T> Eq for Py<T> where T: Eq + PyPayload {}

impl<T> AsRef<PyObject> for Py<T>
where
T: PyObjectPayload,
T: PyPayload,
{
#[inline(always)]
fn as_ref(&self) -> &PyObject {
self.borrow()
}
}

impl<T: PyObjectPayload> fmt::Debug for Py<T> {
impl<T: PyPayload + std::fmt::Debug> fmt::Debug for Py<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
(**self).fmt(f)
}
Expand Down Expand Up @@ -1035,7 +1023,7 @@ impl<T> Clone for PyRef<T> {
}
}

impl<T: PyObjectPayload> PyRef<T> {
impl<T: PyPayload> PyRef<T> {
// #[inline(always)]
// pub(crate) const fn into_non_null(self) -> NonNull<Py<T>> {
// let ptr = self.ptr;
Expand Down Expand Up @@ -1065,24 +1053,26 @@ impl<T: PyObjectPayload> PyRef<T> {
}
}

pub const fn leak(pyref: Self) -> &'static Py<T> {
let ptr = pyref.ptr;
std::mem::forget(pyref);
unsafe { ptr.as_ref() }
}
}

impl<T: PyPayload + std::fmt::Debug> PyRef<T> {
#[inline(always)]
pub fn new_ref(payload: T, typ: crate::builtins::PyTypeRef, dict: Option<PyDictRef>) -> Self {
let inner = Box::into_raw(PyInner::new(payload, typ, dict));
Self {
ptr: unsafe { NonNull::new_unchecked(inner.cast::<Py<T>>()) },
}
}

pub const fn leak(pyref: Self) -> &'static Py<T> {
let ptr = pyref.ptr;
std::mem::forget(pyref);
unsafe { ptr.as_ref() }
}
}

impl<T> Borrow<PyObject> for PyRef<T>
where
T: PyObjectPayload,
T: PyPayload,
{
#[inline(always)]
fn borrow(&self) -> &PyObject {
Expand All @@ -1092,7 +1082,7 @@ where

impl<T> AsRef<PyObject> for PyRef<T>
where
T: PyObjectPayload,
T: PyPayload,
{
#[inline(always)]
fn as_ref(&self) -> &PyObject {
Expand Down Expand Up @@ -1133,7 +1123,7 @@ impl<T> Deref for PyRef<T> {

impl<T> std::hash::Hash for PyRef<T>
where
T: std::hash::Hash + PyObjectPayload,
T: std::hash::Hash + PyPayload,
{
#[inline]
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
Expand All @@ -1143,23 +1133,23 @@ where

impl<T> PartialEq for PyRef<T>
where
T: PartialEq + PyObjectPayload,
T: PartialEq + PyPayload,
{
#[inline]
fn eq(&self, other: &Self) -> bool {
self.deref().eq(other.deref())
}
}

impl<T> Eq for PyRef<T> where T: Eq + PyObjectPayload {}
impl<T> Eq for PyRef<T> where T: Eq + PyPayload {}

#[repr(transparent)]
pub struct PyWeakRef<T: PyObjectPayload> {
pub struct PyWeakRef<T: PyPayload> {
weak: PyRef<PyWeak>,
_marker: PhantomData<T>,
}

impl<T: PyObjectPayload> PyWeakRef<T> {
impl<T: PyPayload> PyWeakRef<T> {
pub fn upgrade(&self) -> Option<PyRef<T>> {
self.weak
.upgrade()
Expand Down
Loading
Loading