gh-117657: TSAN Fix race in `PyMember_Get` and `PyMember_Set`, for `Py_T_OBJECT_EX` type by dpdani · Pull Request #119368 · python/cpython · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 Lib/test/test_descr.py
43 changes: 43 additions & 0 deletions Lib/test/test_free_threading/test_slots.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import threading
from test.support import threading_helper
from unittest import TestCase


def run_in_threads(targets):
"""Run `targets` in separate threads"""
threads = [
threading.Thread(target=target)
for target in targets
]
for thread in threads:
thread.start()
for thread in threads:
thread.join()


@threading_helper.requires_working_threading()
class TestSlots(TestCase):

def test_object(self):
class Spam:
__slots__ = [
"eggs",
]

def __init__(self, initial_value):
self.eggs = initial_value

spam = Spam(0)
iters = 20_000

def writer():
for _ in range(iters):
spam.eggs += 1

def reader():
for _ in range(iters):
eggs = spam.eggs
assert type(eggs) is int
assert 0 <= eggs <= iters

run_in_threads([writer, reader, reader, reader])
42 changes: 33 additions & 9 deletions Python/structmember.c
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,22 @@
#include "Python.h"
#include "pycore_abstract.h" // _PyNumber_Index()
#include "pycore_long.h" // _PyLong_IsNegative()
#include "pycore_object.h" // _Py_TryIncrefCompare(), FT_ATOMIC_*()
#include "pycore_critical_section.h"


static inline PyObject *
member_get_object(const char *addr, const char *obj_addr, PyMemberDef *l)
{
PyObject *v = FT_ATOMIC_LOAD_PTR(*(PyObject **) addr);
if (v == NULL) {
PyErr_Format(PyExc_AttributeError,
"'%T' object has no attribute '%s'",
(PyObject *)obj_addr, l->name);
}
return v;
}

PyObject *
PyMember_GetOne(const char *obj_addr, PyMemberDef *l)
{
Expand Down Expand Up @@ -75,15 +89,19 @@ PyMember_GetOne(const char *obj_addr, PyMemberDef *l)
Py_INCREF(v);
break;
case Py_T_OBJECT_EX:
v = *(PyObject **)addr;
if (v == NULL) {
PyObject *obj = (PyObject *)obj_addr;
PyTypeObject *tp = Py_TYPE(obj);
PyErr_Format(PyExc_AttributeError,
"'%.200s' object has no attribute '%s'",
tp->tp_name, l->name);
}
v = member_get_object(addr, obj_addr, l);
#ifndef Py_GIL_DISABLED
Py_XINCREF(v);
#else
if (v != NULL) {
if (!_Py_TryIncrefCompare((PyObject **) addr, v)) {
Py_BEGIN_CRITICAL_SECTION((PyObject *) obj_addr);
v = member_get_object(addr, obj_addr, l);
Py_XINCREF(v);
Py_END_CRITICAL_SECTION();
}
}
#endif
break;
case Py_T_LONGLONG:
v = PyLong_FromLongLong(*(long long *)addr);
Expand All @@ -92,6 +110,7 @@ PyMember_GetOne(const char *obj_addr, PyMemberDef *l)
v = PyLong_FromUnsignedLongLong(*(unsigned long long *)addr);
break;
case _Py_T_NONE:
// doesn't require free-threading code path
v = Py_NewRef(Py_None);
break;
default:
Expand All @@ -118,6 +137,9 @@ PyMember_SetOne(char *addr, PyMemberDef *l, PyObject *v)
return -1;
}

#ifdef Py_GIL_DISABLED
PyObject *obj = (PyObject *) addr;
#endif
addr += l->offset;

if ((l->flags & Py_READONLY))
Expand Down Expand Up @@ -281,8 +303,10 @@ PyMember_SetOne(char *addr, PyMemberDef *l, PyObject *v)
break;
case _Py_T_OBJECT:
case Py_T_OBJECT_EX:
Py_BEGIN_CRITICAL_SECTION(obj);
oldv = *(PyObject **)addr;
*(PyObject **)addr = Py_XNewRef(v);
FT_ATOMIC_STORE_PTR_RELEASE(*(PyObject **)addr, Py_XNewRef(v));
Py_END_CRITICAL_SECTION();
Py_XDECREF(oldv);
break;
case Py_T_CHAR: {
Expand Down
2 changes: 0 additions & 2 deletions Tools/tsan/suppressions_free_threading.txt