Skip to content

gh-111049: Fix crash during garbage collection of the BytesIO buffer object #111221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
serhiy-storchaka merged 10 commits into from
Dec 14, 2023
Merged

gh-111049: Fix crash during garbage collection of the BytesIO buffer object #111221

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d2d8ed2
gh-111049: Fix crash during garbage collection of the BytesIO buffer …
serhiy-storchaka Oct 23, 2023
131142b
Remove debugging remnants.
serhiy-storchaka Oct 23, 2023
160896f
Merge branch 'main' into crash-bytesio-getbuffer-gc
serhiy-storchaka Oct 25, 2023
10ed7d0
Merge branch 'main' into crash-bytesio-getbuffer-gc
serhiy-storchaka Oct 25, 2023
57fa654
Merge remote-tracking branch 'refs/remotes/origin/crash-bytesio-getbu…
serhiy-storchaka Oct 25, 2023
cb70991
Address review comments.
serhiy-storchaka Oct 30, 2023
046362f
Merge branch 'main' into crash-bytesio-getbuffer-gc
serhiy-storchaka Oct 30, 2023
47f20ea
Merge branch 'main' into crash-bytesio-getbuffer-gc
erlend-aasland Dec 11, 2023
be1ea22
Merge branch 'main' into crash-bytesio-getbuffer-gc
serhiy-storchaka Dec 14, 2023
621345b
Remove XXX comments.
serhiy-storchaka Dec 14, 2023
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
Next Next commit
gh-111049: Fix crash during garbage collection of the BytesIO buffer … 
…object
  • Loading branch information
@serhiy-storchaka
serhiy-storchaka committed Oct 23, 2023
commit d2d8ed2ab582ae011c970b5369ef6d08da67ca5b
21 changes: 21 additions & 0 deletions Lib/test/test_memoryio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@
import unittest
from test import support

import gc
import io
import _pyio as pyio
import pickle
import sys
import weakref

class IntLike:
def __init__(self, num):
Expand Down Expand Up @@ -463,6 +465,25 @@ def test_getbuffer(self):
memio.close()
self.assertRaises(ValueError, memio.getbuffer)

def test_getbuffer_gc_collect(self):
memio = self.ioclass(b"1234567890")
buf = memio.getbuffer()
memiowr = weakref.ref(memio)
bufwr = weakref.ref(buf)
# Create a reference loop.
a = [buf]
a.append(a)
# XXX The Python implementation emits an unraisable exception.
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
with support.catch_unraisable_exception():
del memio
del buf
del a
# XXX The C implementation emits an unraisable exception.
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
with support.catch_unraisable_exception():
gc.collect()
self.assertIsNone(memiowr())
self.assertIsNone(bufwr())

def test_read1(self):
buf = self.buftype("1234567890")
self.assertEqual(self.ioclass(buf).read1(), buf)
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2023-10-23-18-42-26.gh-issue-111049.Ys7-o_.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix crash during garbage collection of the :class:`io.BytesIO` buffer
object.
15 changes: 5 additions & 10 deletions Modules/_io/bytesio.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ check_exports(bytesio *self)
if (self->exports > 0) {
PyErr_SetString(PyExc_BufferError,
"Existing exports of data: object cannot be re-sized");
// abort();
return 1;
}
return 0;
Expand Down Expand Up @@ -989,7 +990,9 @@ static int
bytesio_clear(bytesio *self)
{
Py_CLEAR(self->dict);
Py_CLEAR(self->buf);
if (self->exports == 0) {
Py_CLEAR(self->buf);
}
Comment thread
erlend-aasland marked this conversation as resolved.
return 0;
}

Expand Down Expand Up @@ -1094,13 +1097,6 @@ bytesiobuf_releasebuffer(bytesiobuf *obj, Py_buffer *view)
b->exports--;
}

static int
bytesiobuf_clear(bytesiobuf *self)
{
Py_CLEAR(self->source);
return 0;
}

static int
bytesiobuf_traverse(bytesiobuf *self, visitproc visit, void *arg)
{
Expand All @@ -1115,15 +1111,14 @@ bytesiobuf_dealloc(bytesiobuf *self)
PyTypeObject *tp = Py_TYPE(self);
/* bpo-31095: UnTrack is needed before calling any callbacks */
PyObject_GC_UnTrack(self);
(void)bytesiobuf_clear(self);
Py_CLEAR(self->source);
tp->tp_free(self);
Py_DECREF(tp);
}

static PyType_Slot bytesiobuf_slots[] = {
{Py_tp_dealloc, bytesiobuf_dealloc},
{Py_tp_traverse, bytesiobuf_traverse},
{Py_tp_clear, bytesiobuf_clear},

// Buffer protocol
{Py_bf_getbuffer, bytesiobuf_getbuffer},
Expand Down