bpo-31787: Prevent refleaks when calling __init__() more than once (GH-3995)
(cherry picked from commit d019bc8319ea35e93bf4baa38098ff1b57cd3ee5)
Co-authored-by: Oren Milman <orenmn@gmail.com>
diff --git a/Lib/test/test_asyncio/test_tasks.py b/Lib/test/test_asyncio/test_tasks.py
index 19cf1e6..e5334c6 100644
--- a/Lib/test/test_asyncio/test_tasks.py
+++ b/Lib/test/test_asyncio/test_tasks.py
@@ -2373,6 +2373,20 @@
Task = getattr(tasks, '_CTask', None)
Future = getattr(futures, '_CFuture', None)
+ @support.refcount_test
+ def test_refleaks_in_task___init__(self):
+ gettotalrefcount = support.get_attribute(sys, 'gettotalrefcount')
+ @asyncio.coroutine
+ def coro():
+ pass
+ task = self.new_task(self.loop, coro())
+ self.loop.run_until_complete(task)
+ refs_before = gettotalrefcount()
+ for i in range(100):
+ task.__init__(coro(), loop=self.loop)
+ self.loop.run_until_complete(task)
+ self.assertAlmostEqual(gettotalrefcount() - refs_before, 0, delta=10)
+
@unittest.skipUnless(hasattr(futures, '_CFuture') and
hasattr(tasks, '_CTask'),
diff --git a/Lib/test/test_bz2.py b/Lib/test/test_bz2.py
index 58abdc1..003497f 100644
--- a/Lib/test/test_bz2.py
+++ b/Lib/test/test_bz2.py
@@ -13,6 +13,7 @@
import threading
from test.support import unlink
import _compression
+import sys
# Skip tests if the bz2 module doesn't exist.
@@ -816,6 +817,16 @@
# Previously, a second call could crash due to internal inconsistency
self.assertRaises(Exception, bzd.decompress, self.BAD_DATA * 30)
+ @support.refcount_test
+ def test_refleaks_in___init__(self):
+ gettotalrefcount = support.get_attribute(sys, 'gettotalrefcount')
+ bzd = BZ2Decompressor()
+ refs_before = gettotalrefcount()
+ for i in range(100):
+ bzd.__init__()
+ self.assertAlmostEqual(gettotalrefcount() - refs_before, 0, delta=10)
+
+
class CompressDecompressTest(BaseTest):
def testCompress(self):
data = bz2.compress(self.TEXT)
diff --git a/Lib/test/test_descr.py b/Lib/test/test_descr.py
index d24d005..0e7728e 100644
--- a/Lib/test/test_descr.py
+++ b/Lib/test/test_descr.py
@@ -1559,6 +1559,15 @@
del cm.x
self.assertNotHasAttr(cm, "x")
+ @support.refcount_test
+ def test_refleaks_in_classmethod___init__(self):
+ gettotalrefcount = support.get_attribute(sys, 'gettotalrefcount')
+ cm = classmethod(None)
+ refs_before = gettotalrefcount()
+ for i in range(100):
+ cm.__init__(None)
+ self.assertAlmostEqual(gettotalrefcount() - refs_before, 0, delta=10)
+
@support.impl_detail("the module 'xxsubtype' is internal")
def test_classmethods_in_c(self):
# Testing C-based class methods...
@@ -1614,6 +1623,15 @@
del sm.x
self.assertNotHasAttr(sm, "x")
+ @support.refcount_test
+ def test_refleaks_in_staticmethod___init__(self):
+ gettotalrefcount = support.get_attribute(sys, 'gettotalrefcount')
+ sm = staticmethod(None)
+ refs_before = gettotalrefcount()
+ for i in range(100):
+ sm.__init__(None)
+ self.assertAlmostEqual(gettotalrefcount() - refs_before, 0, delta=10)
+
@support.impl_detail("the module 'xxsubtype' is internal")
def test_staticmethods_in_c(self):
# Testing C-based static methods...
diff --git a/Lib/test/test_hashlib.py b/Lib/test/test_hashlib.py
index 751f748..f7df872 100644
--- a/Lib/test/test_hashlib.py
+++ b/Lib/test/test_hashlib.py
@@ -162,6 +162,15 @@
constructors = self.constructors_to_test.values()
return itertools.chain.from_iterable(constructors)
+ @support.refcount_test
+ def test_refleaks_in_hash___init__(self):
+ gettotalrefcount = support.get_attribute(sys, 'gettotalrefcount')
+ sha1_hash = c_hashlib.new('sha1')
+ refs_before = gettotalrefcount()
+ for i in range(100):
+ sha1_hash.__init__('sha1')
+ self.assertAlmostEqual(gettotalrefcount() - refs_before, 0, delta=10)
+
def test_hash_array(self):
a = array.array("b", range(10))
for cons in self.hash_constructors:
diff --git a/Lib/test/test_lzma.py b/Lib/test/test_lzma.py
index d7a8576..3dc2c1e 100644
--- a/Lib/test/test_lzma.py
+++ b/Lib/test/test_lzma.py
@@ -4,6 +4,8 @@
import pathlib
import pickle
import random
+import sys
+from test import support
import unittest
from test.support import (
@@ -364,6 +366,15 @@
with self.assertRaises(TypeError):
pickle.dumps(LZMADecompressor(), proto)
+ @support.refcount_test
+ def test_refleaks_in_decompressor___init__(self):
+ gettotalrefcount = support.get_attribute(sys, 'gettotalrefcount')
+ lzd = LZMADecompressor()
+ refs_before = gettotalrefcount()
+ for i in range(100):
+ lzd.__init__()
+ self.assertAlmostEqual(gettotalrefcount() - refs_before, 0, delta=10)
+
class CompressDecompressFunctionTestCase(unittest.TestCase):
diff --git a/Lib/test/test_property.py b/Lib/test/test_property.py
index 26b7d52..f6f8f5e 100644
--- a/Lib/test/test_property.py
+++ b/Lib/test/test_property.py
@@ -3,6 +3,7 @@
import sys
import unittest
+from test import support
class PropertyBase(Exception):
pass
@@ -173,6 +174,16 @@
sub.__class__.spam.__doc__ = 'Spam'
self.assertEqual(sub.__class__.spam.__doc__, 'Spam')
+ @support.refcount_test
+ def test_refleaks_in___init__(self):
+ gettotalrefcount = support.get_attribute(sys, 'gettotalrefcount')
+ fake_prop = property('fget', 'fset', 'fdel', 'doc')
+ refs_before = gettotalrefcount()
+ for i in range(100):
+ fake_prop.__init__('fget', 'fset', 'fdel', 'doc')
+ self.assertAlmostEqual(gettotalrefcount() - refs_before, 0, delta=10)
+
+
# Issue 5890: subclasses of property do not preserve method __doc__ strings
class PropertySub(property):
"""This is a subclass of property"""
diff --git a/Misc/NEWS.d/next/Library/2018-02-09-21-41-56.bpo-31787.owSZ2t.rst b/Misc/NEWS.d/next/Library/2018-02-09-21-41-56.bpo-31787.owSZ2t.rst
new file mode 100644
index 0000000..f0cde59
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2018-02-09-21-41-56.bpo-31787.owSZ2t.rst
@@ -0,0 +1,2 @@
+Fixed refleaks of ``__init__()`` methods in various modules.
+(Contributed by Oren Milman)
diff --git a/Modules/_asynciomodule.c b/Modules/_asynciomodule.c
index e82425b..d66cc4c 100644
--- a/Modules/_asynciomodule.c
+++ b/Modules/_asynciomodule.c
@@ -458,6 +458,7 @@
return 0;
}
+
static int
future_init(FutureObj *fut, PyObject *loop)
{
@@ -465,6 +466,19 @@
int is_true;
_Py_IDENTIFIER(get_debug);
+ // Same to FutureObj_clear() but not clearing fut->dict
+ Py_CLEAR(fut->fut_loop);
+ Py_CLEAR(fut->fut_callback0);
+ Py_CLEAR(fut->fut_context0);
+ Py_CLEAR(fut->fut_callbacks);
+ Py_CLEAR(fut->fut_result);
+ Py_CLEAR(fut->fut_exception);
+ Py_CLEAR(fut->fut_source_tb);
+
+ fut->fut_state = STATE_PENDING;
+ fut->fut_log_tb = 0;
+ fut->fut_blocking = 0;
+
if (loop == Py_None) {
loop = get_event_loop();
if (loop == NULL) {
@@ -474,7 +488,7 @@
else {
Py_INCREF(loop);
}
- Py_XSETREF(fut->fut_loop, loop);
+ fut->fut_loop = loop;
res = _PyObject_CallMethodId(fut->fut_loop, &PyId_get_debug, NULL);
if (res == NULL) {
@@ -486,16 +500,12 @@
return -1;
}
if (is_true) {
- Py_XSETREF(fut->fut_source_tb, _PyObject_CallNoArg(traceback_extract_stack));
+ fut->fut_source_tb = _PyObject_CallNoArg(traceback_extract_stack);
if (fut->fut_source_tb == NULL) {
return -1;
}
}
- fut->fut_callback0 = NULL;
- fut->fut_context0 = NULL;
- fut->fut_callbacks = NULL;
-
return 0;
}
@@ -1938,16 +1948,16 @@
return -1;
}
- self->task_context = PyContext_CopyCurrent();
+ Py_XSETREF(self->task_context, PyContext_CopyCurrent());
if (self->task_context == NULL) {
return -1;
}
- self->task_fut_waiter = NULL;
+ Py_CLEAR(self->task_fut_waiter);
self->task_must_cancel = 0;
self->task_log_destroy_pending = 1;
Py_INCREF(coro);
- self->task_coro = coro;
+ Py_XSETREF(self->task_coro, coro);
if (task_call_step_soon(self, NULL)) {
return -1;
diff --git a/Modules/_bz2module.c b/Modules/_bz2module.c
index dba0e19..0789b61 100644
--- a/Modules/_bz2module.c
+++ b/Modules/_bz2module.c
@@ -644,7 +644,7 @@
self->bzs_avail_in_real = 0;
self->input_buffer = NULL;
self->input_buffer_size = 0;
- self->unused_data = PyBytes_FromStringAndSize(NULL, 0);
+ Py_XSETREF(self->unused_data, PyBytes_FromStringAndSize(NULL, 0));
if (self->unused_data == NULL)
goto error;
diff --git a/Modules/_hashopenssl.c b/Modules/_hashopenssl.c
index 44d3f63..b6dcc06 100644
--- a/Modules/_hashopenssl.c
+++ b/Modules/_hashopenssl.c
@@ -369,8 +369,8 @@
return -1;
}
- self->name = name_obj;
- Py_INCREF(self->name);
+ Py_INCREF(name_obj);
+ Py_XSETREF(self->name, name_obj);
if (data_obj) {
if (view.len >= HASHLIB_GIL_MINSIZE) {
diff --git a/Modules/_lzmamodule.c b/Modules/_lzmamodule.c
index fd3bbb8..5bcd088 100644
--- a/Modules/_lzmamodule.c
+++ b/Modules/_lzmamodule.c
@@ -1173,7 +1173,7 @@
self->needs_input = 1;
self->input_buffer = NULL;
self->input_buffer_size = 0;
- self->unused_data = PyBytes_FromStringAndSize(NULL, 0);
+ Py_XSETREF(self->unused_data, PyBytes_FromStringAndSize(NULL, 0));
if (self->unused_data == NULL)
goto error;
diff --git a/Objects/descrobject.c b/Objects/descrobject.c
index a253018..6014039 100644
--- a/Objects/descrobject.c
+++ b/Objects/descrobject.c
@@ -1490,10 +1490,10 @@
Py_XINCREF(fdel);
Py_XINCREF(doc);
- self->prop_get = fget;
- self->prop_set = fset;
- self->prop_del = fdel;
- self->prop_doc = doc;
+ Py_XSETREF(self->prop_get, fget);
+ Py_XSETREF(self->prop_set, fset);
+ Py_XSETREF(self->prop_del, fdel);
+ Py_XSETREF(self->prop_doc, doc);
self->getter_doc = 0;
/* if no docstring given and the getter has one, use that one */
diff --git a/Objects/funcobject.c b/Objects/funcobject.c
index d376f9c..241685d 100644
--- a/Objects/funcobject.c
+++ b/Objects/funcobject.c
@@ -709,7 +709,7 @@
if (!PyArg_UnpackTuple(args, "classmethod", 1, 1, &callable))
return -1;
Py_INCREF(callable);
- cm->cm_callable = callable;
+ Py_XSETREF(cm->cm_callable, callable);
return 0;
}
@@ -890,7 +890,7 @@
if (!PyArg_UnpackTuple(args, "staticmethod", 1, 1, &callable))
return -1;
Py_INCREF(callable);
- sm->sm_callable = callable;
+ Py_XSETREF(sm->sm_callable, callable);
return 0;
}