FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-139951: Do not track immutable tuples in GC by efimov-mikhail · Pull Request #140204 · python/cpython · GitHub

Repository navigation

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .c  (1) .py  (2) .rst  (1) All 3 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
19 changes: 19 additions & 0 deletions Lib/test/test_capi/test_tuple.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ class TupleSubclass(tuple):


class CAPITest(unittest.TestCase):
def _not_tracked(self, t):
self.assertFalse(gc.is_tracked(t), t)

def _tracked(self, t):
self.assertTrue(gc.is_tracked(t), t)

def test_check(self):
# Test PyTuple_Check()
check = _testlimitedcapi.tuple_check
Expand Down Expand Up @@ -52,11 +58,14 @@ def test_tuple_new(self):
self.assertEqual(tup1, ())
self.assertEqual(size(tup1), 0)
self.assertIs(type(tup1), tuple)
self._not_tracked(tup1)

tup2 = tuple_new(1)
self.assertIs(type(tup2), tuple)
self.assertEqual(size(tup2), 1)
self.assertIsNot(tup2, tup1)
self.assertTrue(checknull(tup2, 0))
self._tracked(tup2)

self.assertRaises(SystemError, tuple_new, -1)
self.assertRaises(SystemError, tuple_new, PY_SSIZE_T_MIN)
Expand All @@ -69,6 +78,12 @@ def test_tuple_fromarray(self):
tup = tuple([i] for i in range(5))
copy = tuple_fromarray(tup)
self.assertEqual(copy, tup)
self._tracked(copy)

tup = tuple((42**i, 0) for i in range(5))
copy = tuple_fromarray(tup)
self.assertEqual(copy, tup)
self._not_tracked(copy)

tup = ()
copy = tuple_fromarray(tup)
Expand All @@ -92,6 +107,10 @@ def test_tuple_pack(self):
self.assertEqual(pack(1, [1]), ([1],))
self.assertEqual(pack(2, [1], [2]), ([1], [2]))

self._tracked(pack(1, [1]))
self._tracked(pack(2, [1], b'abc'))
self._not_tracked(pack(2, 42, b'abc'))

self.assertRaises(SystemError, pack, PY_SSIZE_T_MIN)
self.assertRaises(SystemError, pack, -1)
self.assertRaises(MemoryError, pack, PY_SSIZE_T_MAX)
Expand Down
26 changes: 23 additions & 3 deletions Lib/test/test_tuple.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -291,9 +291,8 @@ def test_repr(self):
self.assertEqual(repr(a2), "(0, 1, 2)")

def _not_tracked(self, t):
# Nested tuples can take several collections to untrack
gc.collect()
gc.collect()
# There is no need for gc.collect()
# since we don't track these tuples at all.
self.assertFalse(gc.is_tracked(t), t)

def _tracked(self, t):
Expand Down Expand Up @@ -323,6 +322,19 @@ def test_track_literals(self):
self._tracked((set(),))
self._tracked((x, y, z))

@support.cpython_only
def test_track_after_operations(self):
x, y, z = 1.5, "a", []

self._not_tracked((x, y) + (x, y))
self._tracked((x, y) + (z,))

self._not_tracked((x, y) * 5)
self._tracked((y, z) * 5)

self._not_tracked((x, y, z)[:2])
self._tracked((x, y, z)[2:])

def check_track_dynamic(self, tp, always_track):
x, y, z = 1.5, "a", []

Expand All @@ -343,6 +355,14 @@ def check_track_dynamic(self, tp, always_track):
self._tracked(tp(tuple([obj]) for obj in [x, y, z]))
self._tracked(tuple(tp([obj]) for obj in [x, y, z]))

t = tp([1, x, y, z])
self.assertEqual(type(t), tp)
self._tracked(t)
self.assertEqual(type(t[:]), tuple)
self._tracked(t[:])
self.assertEqual(type(t[:3]), tuple)
self._not_tracked(t[:3])

@support.cpython_only
def test_track_dynamic(self):
# Test GC-optimization of dynamically constructed tuples.
Expand Down
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Do not track immutable tuples in GC.
Patch by Sergey Miryanov and Mikhail Efimov
60 changes: 45 additions & 15 deletions Objects/tupleobject.c
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -145,17 +145,33 @@ _PyTuple_MaybeUntrack(PyObject *op)
t = (PyTupleObject *) op;
n = Py_SIZE(t);
for (i = 0; i < n; i++) {
PyObject *elt = PyTuple_GET_ITEM(t, i);
PyObject *item = t->ob_item[i];
/* Tuple with NULL elements aren't
fully constructed, don't untrack
them yet. */
if (!elt ||
_PyObject_GC_MAY_BE_TRACKED(elt))
if (!item ||
_PyObject_GC_MAY_BE_TRACKED(item))
return;
}
_PyObject_GC_UNTRACK(op);
}

/* gh-139951: This function helps to avoid performance issue in the GC,
* we don't track immutable tuples. */
static bool
Comment thread
efimov-mikhail marked this conversation as resolved.
tuple_need_tracking(PyTupleObject *self)
{
Py_ssize_t n = PyTuple_GET_SIZE(self);
for (Py_ssize_t i = 0; i < n; i++) {
PyObject *item = self->ob_item[i];
assert(item);
if (_PyObject_GC_MAY_BE_TRACKED(item)) {
return true;
}
}
return false;
}

PyObject *
PyTuple_Pack(Py_ssize_t n, ...)
{
Expand All @@ -169,19 +185,21 @@ PyTuple_Pack(Py_ssize_t n, ...)
}

va_start(vargs, n);
PyTupleObject *result = tuple_alloc(n);
if (result == NULL) {
PyTupleObject *tuple = tuple_alloc(n);
if (tuple == NULL) {
va_end(vargs);
return NULL;
}
items = result->ob_item;
items = tuple->ob_item;
for (i = 0; i < n; i++) {
o = va_arg(vargs, PyObject *);
items[i] = Py_NewRef(o);
}
va_end(vargs);
_PyObject_GC_TRACK(result);
return (PyObject *)result;
if (tuple_need_tracking(tuple)) {
_PyObject_GC_TRACK(tuple);
}
return (PyObject *)tuple;
}


Expand Down Expand Up @@ -381,7 +399,9 @@ PyTuple_FromArray(PyObject *const *src, Py_ssize_t n)
PyObject *item = src[i];
dst[i] = Py_NewRef(item);
}
_PyObject_GC_TRACK(tuple);
if (tuple_need_tracking(tuple)) {
_PyObject_GC_TRACK(tuple);
}
return (PyObject *)tuple;
}

Expand All @@ -399,7 +419,9 @@ _PyTuple_FromStackRefStealOnSuccess(const _PyStackRef *src, Py_ssize_t n)
for (Py_ssize_t i = 0; i < n; i++) {
dst[i] = PyStackRef_AsPyObjectSteal(src[i]);
}
_PyObject_GC_TRACK(tuple);
if (tuple_need_tracking(tuple)) {
_PyObject_GC_TRACK(tuple);
}
return (PyObject *)tuple;
}

Expand All @@ -421,7 +443,9 @@ _PyTuple_FromArraySteal(PyObject *const *src, Py_ssize_t n)
PyObject *item = src[i];
dst[i] = item;
}
_PyObject_GC_TRACK(tuple);
if (tuple_need_tracking(tuple)) {
_PyObject_GC_TRACK(tuple);
}
return (PyObject *)tuple;
}

Expand Down Expand Up @@ -494,7 +518,9 @@ tuple_concat(PyObject *aa, PyObject *bb)
dest[i] = Py_NewRef(v);
}

_PyObject_GC_TRACK(np);
if (_PyObject_GC_IS_TRACKED(a) || _PyObject_GC_IS_TRACKED(b)) {
_PyObject_GC_TRACK(np);
}
return (PyObject *)np;
}

Expand Down Expand Up @@ -543,8 +569,10 @@ tuple_repeat(PyObject *self, Py_ssize_t n)
_Py_memory_repeat((char *)np->ob_item, sizeof(PyObject *)*output_size,
sizeof(PyObject *)*input_size);
}
_PyObject_GC_TRACK(np);
return (PyObject *) np;
if (_PyObject_GC_IS_TRACKED(a)) {
_PyObject_GC_TRACK(np);
}
return (PyObject *)np;
}

/*[clinic input]
Expand Down Expand Up @@ -821,7 +849,9 @@ tuple_subscript(PyObject *op, PyObject* item)
dest[i] = it;
}

_PyObject_GC_TRACK(result);
if (tuple_need_tracking(result)) {
_PyObject_GC_TRACK(result);
}
return (PyObject *)result;
}
}
Expand Down
Loading

Back | FazBrowse Home | New Git URL