Skip to content

Commit 0dc5e45

Browse files
sobolevnvstinner
andcommitted
[3.14] gh-152254: Fix a crash in PyObject_ClearManagedDict under memory pressure (GH-152255)
(cherry picked from commit 369d8bc) Co-authored-by: sobolevn <mail@sobolevn.me> Co-authored-by: Victor Stinner <vstinner@python.org>
1 parent 919f2ce commit 0dc5e45

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
@@ -273,6 +273,83 @@ def func(x):
273273
for i in [0, 1, 2]:
274274
self.assertFalse(_testcapi.pyobject_is_unique_temporary_new_object())
275275

276+
def test_object_clear_managed_dict(self):
277+
# PyObject_ClearManagedDict
278+
clear_managed_dict = _testcapi.pyobject_clear_managed_dict
279+
ManagedDictType = _testcapi.ManagedDictType
280+
281+
obj = ManagedDictType()
282+
obj.value = 'first'
283+
# asserting `__dict__` is a must to materialize the value before clean:
284+
self.assertEqual(obj.__dict__, {'value': 'first'})
285+
self.assertIs(type(obj.__dict__), dict)
286+
clear_managed_dict(obj)
287+
self.assertEqual(obj.__dict__, {})
288+
self.assertIs(type(obj.__dict__), dict)
289+
290+
# big object:
291+
obj = ManagedDictType()
292+
existing_dict = {f'attr_{x}': x for x in range(100)}
293+
obj.__dict__ = existing_dict
294+
self.assertIs(obj.__dict__, existing_dict)
295+
clear_managed_dict(obj)
296+
self.assertEqual(obj.__dict__, {})
297+
self.assertIs(type(obj.__dict__), dict)
298+
299+
# empty dict:
300+
obj = ManagedDictType()
301+
self.assertEqual(obj.__dict__, {})
302+
self.assertIs(type(obj.__dict__), dict)
303+
clear_managed_dict(obj)
304+
self.assertEqual(obj.__dict__, {})
305+
self.assertIs(type(obj.__dict__), dict)
306+
307+
# double clear:
308+
obj = ManagedDictType()
309+
obj.value = 'first'
310+
self.assertEqual(obj.__dict__, {'value': 'first'})
311+
clear_managed_dict(obj)
312+
clear_managed_dict(obj)
313+
self.assertEqual(obj.__dict__, {})
314+
self.assertIs(type(obj.__dict__), dict)
315+
316+
# unmaterialized:
317+
obj = ManagedDictType()
318+
obj.value = 'first'
319+
clear_managed_dict(obj)
320+
self.assertEqual(obj.__dict__, {})
321+
self.assertIs(type(obj.__dict__), dict)
322+
323+
# CRASHES: clear_managed_dict(NULL)
324+
325+
@threading_helper.requires_working_threading()
326+
@support.nomemtest
327+
def test_object_clear_managed_dict_ft_memory_error(self):
328+
# gh-152254: Test PyObject_ClearManagedDict() error.
329+
# The setup must contain: object owned by another thread
330+
# and the attempt to clear the managed dict with no memory left.
331+
clear_managed_dict = _testcapi.pyobject_clear_managed_dict
332+
ManagedDictType = _testcapi.ManagedDictType
333+
334+
obj = ManagedDictType()
335+
obj.value = 'first'
336+
self.assertEqual(len(obj.__dict__), 1)
337+
338+
def worker():
339+
# This needs to be in a separate thread for the crash to happen:
340+
with support.catch_unraisable_exception() as ex:
341+
# `PyObject_ClearManagedDict()` used to crash:
342+
_testcapi.call_with_nomemory(0, 1, clear_managed_dict, obj)
343+
self.assertIsNotNone(ex.unraisable)
344+
self.assertIs(ex.unraisable.exc_type, MemoryError)
345+
self.assertIn('managed dict', ex.unraisable.err_msg)
346+
self.assertEqual(obj.__dict__, {})
347+
self.assertIs(type(obj.__dict__), dict)
348+
349+
threading_helper.run_concurrently([worker])
350+
self.assertEqual(obj.__dict__, {})
351+
self.assertIs(type(obj.__dict__), dict)
352+
276353

277354
class RefTracerTest(unittest.TestCase):
278355
@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
@@ -509,6 +516,7 @@ static PyMethodDef test_methods[] = {
509516
{"pyobject_enable_deferred_refcount", pyobject_enable_deferred_refcount, METH_O},
510517
{"pyobject_is_unique_temporary", pyobject_is_unique_temporary, METH_O},
511518
{"pyobject_is_unique_temporary_new_object", pyobject_is_unique_temporary_new_object, METH_NOARGS},
519+
{"pyobject_clear_managed_dict", pyobject_clear_managed_dict, METH_O},
512520
{"test_py_try_inc_ref", test_py_try_inc_ref, METH_NOARGS},
513521
{"test_xincref_doesnt_leak",test_xincref_doesnt_leak, METH_NOARGS},
514522
{"test_incref_doesnt_leak", test_incref_doesnt_leak, METH_NOARGS},

‎Objects/dictobject.c‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7530,6 +7530,7 @@ PyObject_ClearManagedDict(PyObject *obj)
75307530
Py_BEGIN_CRITICAL_SECTION(dict);
75317531
PyInterpreterState *interp = _PyInterpreterState_GET();
75327532
PyDictKeysObject *oldkeys = dict->ma_keys;
7533+
ensure_shared_on_resize(dict);
75337534
set_keys(dict, Py_EMPTY_KEYS);
75347535
dict->ma_values = NULL;
75357536
dictkeys_decref(interp, oldkeys, IS_DICT_SHARED(dict));

0 commit comments

Comments
 (0)