Skip to content

Commit 369d8bc

Browse files
sobolevnvstinner
andauthored
gh-152254: Fix a crash in PyObject_ClearManagedDict under memory pressure (#152255)
Co-authored-by: Victor Stinner <vstinner@python.org>
1 parent 8750d38 commit 369d8bc

4 files changed

Lines changed: 88 additions & 0 deletions

File tree

‎Lib/test/test_capi/test_object.py‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,83 @@ def test_pyobject_dump(self):
354354
output = self.pyobject_dump(NULL)
355355
self.assertRegex(output, r'<object at .* is freed>')
356356

357+
def test_object_clear_managed_dict(self):
358+
# PyObject_ClearManagedDict
359+
clear_managed_dict = _testcapi.pyobject_clear_managed_dict
360+
ManagedDictType = _testcapi.ManagedDictType
361+
362+
obj = ManagedDictType()
363+
obj.value = 'first'
364+
# asserting `__dict__` is a must to materialize the value before clean:
365+
self.assertEqual(obj.__dict__, {'value': 'first'})
366+
self.assertIs(type(obj.__dict__), dict)
367+
clear_managed_dict(obj)
368+
self.assertEqual(obj.__dict__, {})
369+
self.assertIs(type(obj.__dict__), dict)
370+
371+
# big object:
372+
obj = ManagedDictType()
373+
existing_dict = {f'attr_{x}': x for x in range(100)}
374+
obj.__dict__ = existing_dict
375+
self.assertIs(obj.__dict__, existing_dict)
376+
clear_managed_dict(obj)
377+
self.assertEqual(obj.__dict__, {})
378+
self.assertIs(type(obj.__dict__), dict)
379+
380+
# empty dict:
381+
obj = ManagedDictType()
382+
self.assertEqual(obj.__dict__, {})
383+
self.assertIs(type(obj.__dict__), dict)
384+
clear_managed_dict(obj)
385+
self.assertEqual(obj.__dict__, {})
386+
self.assertIs(type(obj.__dict__), dict)
387+
388+
# double clear:
389+
obj = ManagedDictType()
390+
obj.value = 'first'
391+
self.assertEqual(obj.__dict__, {'value': 'first'})
392+
clear_managed_dict(obj)
393+
clear_managed_dict(obj)
394+
self.assertEqual(obj.__dict__, {})
395+
self.assertIs(type(obj.__dict__), dict)
396+
397+
# unmaterialized:
398+
obj = ManagedDictType()
399+
obj.value = 'first'
400+
clear_managed_dict(obj)
401+
self.assertEqual(obj.__dict__, {})
402+
self.assertIs(type(obj.__dict__), dict)
403+
404+
# CRASHES: clear_managed_dict(NULL)
405+
406+
@threading_helper.requires_working_threading()
407+
@support.nomemtest
408+
def test_object_clear_managed_dict_ft_memory_error(self):
409+
# gh-152254: Test PyObject_ClearManagedDict() error.
410+
# The setup must contain: object owned by another thread
411+
# and the attempt to clear the managed dict with no memory left.
412+
clear_managed_dict = _testcapi.pyobject_clear_managed_dict
413+
ManagedDictType = _testcapi.ManagedDictType
414+
415+
obj = ManagedDictType()
416+
obj.value = 'first'
417+
self.assertEqual(len(obj.__dict__), 1)
418+
419+
def worker():
420+
# This needs to be in a separate thread for the crash to happen:
421+
with support.catch_unraisable_exception() as ex:
422+
# `PyObject_ClearManagedDict()` used to crash:
423+
_testcapi.call_with_nomemory(0, 1, clear_managed_dict, obj)
424+
self.assertIsNotNone(ex.unraisable)
425+
self.assertIs(ex.unraisable.exc_type, MemoryError)
426+
self.assertIn('managed dict', ex.unraisable.err_msg)
427+
self.assertEqual(obj.__dict__, {})
428+
self.assertIs(type(obj.__dict__), dict)
429+
430+
threading_helper.run_concurrently([worker])
431+
self.assertEqual(obj.__dict__, {})
432+
self.assertIs(type(obj.__dict__), dict)
433+
357434

358435
class RefTracerTest(unittest.TestCase):
359436
@support.requires_resource('cpu')
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Fix a crash during the clean up of managed dict objects under a memory
2+
pressure in :c:func:`PyObject_ClearManagedDict`.

‎Modules/_testcapi/object.c‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,13 @@ pyobject_is_unique_temporary_new_object(PyObject *self, PyObject *unused)
153153
return PyLong_FromLong(result);
154154
}
155155

156+
static PyObject *
157+
pyobject_clear_managed_dict(PyObject *self, PyObject *obj)
158+
{
159+
PyObject_ClearManagedDict(obj);
160+
Py_RETURN_NONE;
161+
}
162+
156163
static int MyObject_dealloc_called = 0;
157164

158165
static void
@@ -358,6 +365,7 @@ static PyMethodDef test_methods[] = {
358365
{"pyobject_enable_deferred_refcount", pyobject_enable_deferred_refcount, METH_O},
359366
{"pyobject_is_unique_temporary", pyobject_is_unique_temporary, METH_O},
360367
{"pyobject_is_unique_temporary_new_object", pyobject_is_unique_temporary_new_object, METH_NOARGS},
368+
{"pyobject_clear_managed_dict", pyobject_clear_managed_dict, METH_O},
361369
{"test_py_try_inc_ref", test_py_try_inc_ref, METH_NOARGS},
362370
{"test_py_set_immortal", test_py_set_immortal, METH_NOARGS},
363371
#ifdef Py_REF_DEBUG

‎Objects/dictobject.c‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8146,6 +8146,7 @@ PyObject_ClearManagedDict(PyObject *obj)
81468146
/* Clear the dict */
81478147
Py_BEGIN_CRITICAL_SECTION(dict);
81488148
PyDictKeysObject *oldkeys = dict->ma_keys;
8149+
ensure_shared_on_resize(dict);
81498150
set_keys(dict, Py_EMPTY_KEYS);
81508151
dict->ma_values = NULL;
81518152
dictkeys_decref(oldkeys, IS_DICT_SHARED(dict));

0 commit comments

Comments
 (0)