Skip to content

Commit df467a0

Browse files
committed
Store instance slots as atomic object pointers
PyMemberDef now carries type, offset, and flags. Slot values are atomic PyObject pointers with try-incref reads, so a concurrent store cannot free the memory under a reader. Objects placed in a slot stay published until QSBR reclaims them. Assisted-by: Grok:4.7
1 parent afad92b commit df467a0

10 files changed

Lines changed: 249 additions & 124 deletions

File tree

‎crates/capi/src/descrobject.rs‎

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ use crate::util::CStrExt;
66
use core::ffi::{c_char, c_int, c_void};
77
use core::ptr::NonNull;
88
use rustpython_vm::builtins::{
9-
DescriptorMemberDef, MemberGetter, MemberKind, MemberSetter, PyDescriptorOwned, PyGetSet,
10-
PyMappingProxy, PyMemberDescriptor, PyType,
9+
DescriptorMemberDef, MemberAccess, PY_READONLY, PY_RELATIVE_OFFSET, PY_T_BOOL, PY_T_OBJECT,
10+
PY_T_OBJECT_EX, PyDescriptorOwned, PyGetSet, PyMappingProxy, PyMemberDescriptor, PyType,
1111
};
1212
use rustpython_vm::common::lock::PyRwLock;
1313
use rustpython_vm::function::PySetterValue;
@@ -133,19 +133,14 @@ pub struct PyMemberDef {
133133
}
134134

135135
impl PyMemberDef {
136-
const PY_READONLY: c_int = 1;
137-
const PY_RELATIVE_OFFSET: c_int = 8;
138-
139136
pub(crate) fn build(
140137
&self,
141138
ty: &Py<PyType>,
142139
vm: &VirtualMachine,
143140
) -> PyResult<PyRef<PyMemberDescriptor>> {
144141
let name = unsafe { self.name.try_as_str(vm) }?;
145-
let kind = match self.type_code {
146-
6 => MemberKind::Object,
147-
16 => MemberKind::ObjectEx,
148-
14 => MemberKind::Bool,
142+
let type_code = match self.type_code {
143+
PY_T_OBJECT | PY_T_OBJECT_EX | PY_T_BOOL => self.type_code,
149144
_ => {
150145
return Err(vm.new_system_error(format!(
151146
"PyDescr_NewMember does not support member type code {}",
@@ -156,13 +151,14 @@ impl PyMemberDef {
156151
if self.offset < 0 {
157152
return Err(vm.new_system_error("PyDescr_NewMember does not support negative offsets"));
158153
}
159-
if self.flags & Self::PY_RELATIVE_OFFSET != 0 {
154+
if self.flags & PY_RELATIVE_OFFSET != 0 {
160155
return Err(
161156
vm.new_system_error("PyDescr_NewMember does not support Py_RELATIVE_OFFSET")
162157
);
163158
}
164159

165160
let doc = unsafe { self.doc.try_as_str_opt(vm) }?.map(str::to_owned);
161+
let readonly = self.flags & PY_READONLY != 0;
166162

167163
let descriptor = PyMemberDescriptor {
168164
common: PyDescriptorOwned {
@@ -172,15 +168,13 @@ impl PyMemberDef {
172168
},
173169
member: DescriptorMemberDef {
174170
name: name.to_owned(),
175-
kind,
176-
getter: MemberGetter::Offset(self.offset as usize),
177-
setter: if self.flags & Self::PY_READONLY != 0 {
178-
MemberSetter::Setter(None)
179-
} else {
180-
MemberSetter::Offset(self.offset as usize)
181-
},
171+
type_code,
172+
offset: self.offset,
173+
flags: if readonly { PY_READONLY } else { 0 },
182174
doc,
183175
},
176+
// Instance members live in the slot array. `offset` is that index.
177+
access: MemberAccess::Slot,
184178
};
185179

186180
Ok(descriptor.into_ref(&vm.ctx))

‎crates/derive-impl/src/pyclass.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1568,8 +1568,8 @@ impl ToTokens for GetSetNursery {
15681568
}
15691569
}
15701570

1571-
/// Member kind as string, matching `rustpython_vm::builtins::descriptor::MemberKind` variants.
1572-
/// None means ObjectEx (default). Valid values: "bool", "object".
1571+
/// Member type as string, matching `Py_T_*` codes.
1572+
/// None means `PY_T_OBJECT_EX`. Valid values: "bool", "object".
15731573
type MemberKindStr = Option<String>;
15741574

15751575
#[derive(Default)]
@@ -1660,13 +1660,13 @@ impl ToTokens for MemberNursery {
16601660
};
16611661
let member_kind = match entry.kind.as_deref() {
16621662
Some("bool") => {
1663-
quote!(::rustpython_vm::builtins::descriptor::MemberKind::Bool)
1663+
quote!(::rustpython_vm::builtins::descriptor::PY_T_BOOL)
16641664
}
16651665
Some("object") => {
1666-
quote!(::rustpython_vm::builtins::descriptor::MemberKind::Object)
1666+
quote!(::rustpython_vm::builtins::descriptor::PY_T_OBJECT)
16671667
}
16681668
_ => {
1669-
quote!(::rustpython_vm::builtins::descriptor::MemberKind::ObjectEx)
1669+
quote!(::rustpython_vm::builtins::descriptor::PY_T_OBJECT_EX)
16701670
}
16711671
};
16721672
let getter = entry.getter.as_ref().unwrap();

‎crates/vm/src/builtins/descriptor.rs‎

Lines changed: 126 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -329,41 +329,106 @@ impl Representable for PyClassMethodDescriptor {
329329
}
330330
}
331331

332-
#[derive(Debug)]
333-
pub enum MemberKind {
334-
Object = 6,
335-
Bool = 14,
336-
ObjectEx = 16,
337-
}
332+
/// `Py_T_*` type codes. Values match `PyMemberDef.type`.
333+
pub const PY_T_OBJECT: i32 = 6;
334+
pub const PY_T_BOOL: i32 = 14;
335+
pub const PY_T_OBJECT_EX: i32 = 16;
336+
337+
pub const PY_READONLY: i32 = 1;
338+
pub(crate) const PY_AUDIT_READ: i32 = 2;
339+
pub const PY_RELATIVE_OFFSET: i32 = 8;
338340

339341
pub(crate) type MemberSetterFunc =
340342
Option<fn(&VirtualMachine, PyObjectRef, PySetterValue) -> PyResult<()>>;
341343

342-
pub enum MemberGetter {
343-
Getter(fn(&VirtualMachine, PyObjectRef) -> PyResult),
344-
Offset(usize),
345-
TupleItem(usize),
344+
/// Where `PyMemberDef.offset` points.
345+
///
346+
/// Builtin payloads keep fields behind locks, so a byte offset from the
347+
/// object header does not address them. Slot members use `offset` as an
348+
/// index into the instance slot array. Function members ignore `offset`.
349+
#[derive(Clone, Copy)]
350+
pub enum MemberAccess {
351+
Func {
352+
get: fn(&VirtualMachine, PyObjectRef) -> PyResult,
353+
set: MemberSetterFunc,
354+
},
355+
Slot,
356+
TupleItem,
346357
}
347358

348-
pub enum MemberSetter {
349-
Setter(MemberSetterFunc),
350-
Offset(usize),
359+
impl core::fmt::Debug for MemberAccess {
360+
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
361+
match self {
362+
Self::Func { set, .. } => f.debug_struct("Func").field("set", &set.is_some()).finish(),
363+
Self::Slot => write!(f, "Slot"),
364+
Self::TupleItem => write!(f, "TupleItem"),
365+
}
366+
}
351367
}
352368

369+
/// Same fields as `PyMemberDef`: name, type, offset, flags, doc.
353370
pub struct PyMemberDef {
354371
pub name: String,
355-
pub kind: MemberKind,
356-
pub getter: MemberGetter,
357-
pub setter: MemberSetter,
372+
pub type_code: i32,
373+
pub offset: isize,
374+
pub flags: i32,
358375
pub doc: Option<String>,
359376
}
360377

361378
impl PyMemberDef {
379+
pub(crate) fn readonly(&self) -> bool {
380+
self.flags & PY_READONLY != 0
381+
}
382+
}
383+
384+
impl core::fmt::Debug for PyMemberDef {
385+
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
386+
f.debug_struct("PyMemberDef")
387+
.field("name", &self.name)
388+
.field("type", &self.type_code)
389+
.field("offset", &self.offset)
390+
.field("flags", &self.flags)
391+
.field("doc", &self.doc)
392+
.finish()
393+
}
394+
}
395+
396+
// = PyMemberDescrObject
397+
#[pyclass(name = "member_descriptor", module = false)]
398+
#[derive(Debug)]
399+
pub struct PyMemberDescriptor {
400+
pub common: PyDescriptorOwned,
401+
pub member: PyMemberDef,
402+
pub access: MemberAccess,
403+
}
404+
405+
impl PyMemberDescriptor {
406+
/// Slot index for an instance-slot member. `None` when the offset is not a slot.
407+
pub(crate) fn slot_offset(&self) -> Option<usize> {
408+
match self.access {
409+
MemberAccess::Slot => Some(self.member.offset as usize),
410+
_ => None,
411+
}
412+
}
413+
362414
fn get(&self, obj: PyObjectRef, vm: &VirtualMachine) -> PyResult {
363-
match self.getter {
364-
MemberGetter::Getter(getter) => (getter)(vm, obj),
365-
MemberGetter::Offset(offset) => get_slot_from_object(&obj, offset, self, vm),
366-
MemberGetter::TupleItem(index) => {
415+
if self.member.flags & PY_AUDIT_READ != 0 {
416+
vm.sys_module.get_attr("audit", vm)?.call(
417+
(
418+
vm.ctx.new_str("object.__getattr__"),
419+
obj.clone(),
420+
vm.ctx.new_str(self.member.name.as_str()),
421+
),
422+
vm,
423+
)?;
424+
}
425+
match self.access {
426+
MemberAccess::Func { get, .. } => get(vm, obj),
427+
MemberAccess::Slot => {
428+
get_slot_from_object(&obj, self.member.offset as usize, &self.member, vm)
429+
}
430+
MemberAccess::TupleItem => {
431+
let index = self.member.offset as usize;
367432
let tuple = obj.downcast_ref::<PyTuple>().ok_or_else(|| {
368433
vm.new_type_error("unexpected payload for struct sequence member")
369434
})?;
@@ -382,34 +447,22 @@ impl PyMemberDef {
382447
value: PySetterValue<PyObjectRef>,
383448
vm: &VirtualMachine,
384449
) -> PyResult<()> {
385-
match self.setter {
386-
MemberSetter::Setter(setter) => match setter {
387-
Some(setter) => (setter)(vm, obj, value),
450+
if self.member.readonly() {
451+
return Err(vm.new_attribute_error("readonly attribute"));
452+
}
453+
match self.access {
454+
MemberAccess::Func { set, .. } => match set {
455+
Some(set) => set(vm, obj, value),
388456
None => Err(vm.new_attribute_error("readonly attribute")),
389457
},
390-
MemberSetter::Offset(offset) => set_slot_at_object(&obj, offset, self, value, vm),
458+
MemberAccess::Slot => {
459+
set_slot_at_object(&obj, self.member.offset as usize, &self.member, value, vm)
460+
}
461+
MemberAccess::TupleItem => Err(vm.new_attribute_error("readonly attribute")),
391462
}
392463
}
393464
}
394465

395-
impl core::fmt::Debug for PyMemberDef {
396-
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
397-
f.debug_struct("PyMemberDef")
398-
.field("name", &self.name)
399-
.field("kind", &self.kind)
400-
.field("doc", &self.doc)
401-
.finish()
402-
}
403-
}
404-
405-
// = PyMemberDescrObject
406-
#[pyclass(name = "member_descriptor", module = false)]
407-
#[derive(Debug)]
408-
pub struct PyMemberDescriptor {
409-
pub common: PyDescriptorOwned,
410-
pub member: PyMemberDef,
411-
}
412-
413466
impl PyPayload for PyMemberDescriptor {
414467
fn class(ctx: &Context) -> &'static Py<PyType> {
415468
ctx.types.member_descriptor_type
@@ -494,65 +547,71 @@ impl PyMemberDescriptor {
494547
)));
495548
}
496549

497-
zelf.member.set(obj, value, vm)
550+
zelf.set(obj, value, vm)
498551
}
499552
}
500553

501-
// PyMember_GetOne
554+
// PyMember_GetOne for a value stored in the instance slot array.
502555
fn get_slot_from_object(
503556
obj: &PyObject,
504557
offset: usize,
505558
member: &PyMemberDef,
506559
vm: &VirtualMachine,
507560
) -> PyResult {
508-
let slot = match member.kind {
509-
MemberKind::Object => obj.get_slot(offset).unwrap_or_else(|| vm.ctx.none()),
510-
MemberKind::Bool => obj
561+
let slot = match member.type_code {
562+
PY_T_OBJECT => obj.get_slot(offset).unwrap_or_else(|| vm.ctx.none()),
563+
PY_T_BOOL => obj
511564
.get_slot(offset)
512565
.unwrap_or_else(|| vm.ctx.new_bool(false).into()),
513-
MemberKind::ObjectEx => obj.get_slot(offset).ok_or_else(|| {
514-
// '%T' : module.qualname
566+
PY_T_OBJECT_EX => obj.get_slot(offset).ok_or_else(|| {
515567
vm.new_attribute_error(format!(
516568
"'{}' object has no attribute '{}'",
517569
obj.class().fully_qualified_name(vm),
518570
member.name
519571
))
520572
})?,
573+
_ => {
574+
return Err(vm.new_system_error("bad memberdescr type"));
575+
}
521576
};
522577
Ok(slot)
523578
}
524579

525-
// PyMember_SetOne
580+
// PyMember_SetOne for a value stored in the instance slot array.
526581
fn set_slot_at_object(
527582
obj: &PyObject,
528583
offset: usize,
529584
member: &PyMemberDef,
530585
value: PySetterValue,
531586
vm: &VirtualMachine,
532587
) -> PyResult<()> {
533-
match member.kind {
534-
MemberKind::Object => match value {
588+
if matches!(value, PySetterValue::Delete)
589+
&& member.type_code != PY_T_OBJECT_EX
590+
&& member.type_code != PY_T_OBJECT
591+
{
592+
return Err(vm.new_type_error("can't delete numeric/char attribute"));
593+
}
594+
match member.type_code {
595+
PY_T_OBJECT => match value {
535596
PySetterValue::Assign(v) => {
536597
obj.set_slot(offset, Some(v));
537598
}
538599
PySetterValue::Delete => {
539600
obj.set_slot(offset, None);
540601
}
541602
},
542-
MemberKind::Bool => {
543-
match value {
544-
PySetterValue::Assign(v) => {
545-
if !v.class().is(vm.ctx.types.bool_type) {
546-
return Err(vm.new_type_error("attribute value type must be bool"));
547-
}
548-
obj.set_slot(offset, Some(v))
549-
}
550-
PySetterValue::Delete => {
551-
return Err(vm.new_type_error("can't delete numeric/char attribute"));
603+
PY_T_BOOL => match value {
604+
PySetterValue::Assign(v) => {
605+
if !v.class().is(vm.ctx.types.bool_type) {
606+
return Err(vm.new_type_error("attribute value type must be bool"));
552607
}
553-
};
554-
}
555-
MemberKind::ObjectEx => match value {
608+
obj.set_slot(offset, Some(v))
609+
}
610+
PySetterValue::Delete => {
611+
return Err(vm.new_type_error("can't delete numeric/char attribute"));
612+
}
613+
},
614+
PY_T_OBJECT_EX => match value {
556615
PySetterValue::Assign(v) => {
557616
obj.set_slot(offset, Some(v));
558617
}
@@ -563,6 +622,7 @@ fn set_slot_at_object(
563622
obj.set_slot(offset, None);
564623
}
565624
},
625+
_ => return Err(vm.new_system_error("bad memberdescr type")),
566626
}
567627

568628
Ok(())
@@ -597,7 +657,7 @@ impl GetDescriptor for PyMemberDescriptor {
597657
x.class().name()
598658
)));
599659
}
600-
descr.member.get(x, vm)
660+
descr.get(x, vm)
601661
}
602662
None => Ok(zelf),
603663
}

‎crates/vm/src/builtins/mod.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ pub(crate) mod union_;
100100
pub use union_::{PyUnion, make_union};
101101
pub(crate) mod descriptor;
102102
pub use descriptor::{
103-
MemberGetter, MemberKind, MemberSetter, PyDescriptorOwned, PyMemberDef as DescriptorMemberDef,
104-
PyMemberDescriptor,
103+
MemberAccess, PY_READONLY, PY_RELATIVE_OFFSET, PY_T_BOOL, PY_T_OBJECT, PY_T_OBJECT_EX,
104+
PyDescriptorOwned, PyMemberDef as DescriptorMemberDef, PyMemberDescriptor,
105105
};
106106

107107
pub use float::float_from_string as parse_float_from_string;

0 commit comments

Comments
 (0)