Skip to content
Open
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
17 changes: 17 additions & 0 deletions Lib/test/test_array.py
Original file line number Diff line number Diff line change
Expand Up @@ -1367,6 +1367,23 @@ def test_frombytearray(self):
b = array.array(self.typecode, a)
self.assertEqual(a, b)

def test_tofile_concurrent_mutation(self):
# Keep this test in sync with the implementation in
# Modules/arraymodule.c:array_array_tofile_impl()
Comment on lines +1370 to +1372
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
def test_tofile_concurrent_mutation(self):
# Keep this test in sync with the implementation in
# Modules/arraymodule.c:array_array_tofile_impl()
def test_tofile_concurrent_mutation(self):
# Prevent crash when a writer concurrently mutates the array.
# See https://github.com/python/cpython/issues/142884.
# Keep 'BLOCKSIZE' in sync with the array.tofile() C implementation.

BLOCKSIZE = 64 * 1024
victim = array.array('B', b'\0' * (BLOCKSIZE * 2))

class Writer:
cleared = False
def write(self, data):
if not self.cleared:
self.cleared = True
victim.clear()
return 0
Comment on lines +1377 to +1382
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
cleared = False
def write(self, data):
if not self.cleared:
self.cleared = True
victim.clear()
return 0
def write(self, data):
victim.clear()
return 0

We actually don't care about calling clear() multiple times.


victim.tofile(Writer())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
victim.tofile(Writer())
victim.tofile(Writer()) # should not crash



class IntegerNumberTest(NumberTest):
def test_type_error(self):
a = array.array(self.typecode)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
:mod:`array`: fix a crash in :mod:`array.array.tofile` when the array is concurrently modified by the writer.
36 changes: 26 additions & 10 deletions Modules/arraymodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -1587,27 +1587,41 @@ static PyObject *
array_array_tofile_impl(arrayobject *self, PyTypeObject *cls, PyObject *f)
/*[clinic end generated code: output=4560c628d9c18bc2 input=5a24da7a7b407b52]*/
{
Py_ssize_t nbytes = Py_SIZE(self) * self->ob_descr->itemsize;
/* Write 64K blocks at a time */
/* XXX Make the block size settable */
int BLOCKSIZE = 64*1024;
Py_ssize_t nblocks = (nbytes + BLOCKSIZE - 1) / BLOCKSIZE;
Py_ssize_t i;
Py_ssize_t BLOCKSIZE = 64*1024;
Py_ssize_t max_items = PY_SSIZE_T_MAX / self->ob_descr->itemsize;

if (Py_SIZE(self) == 0)
goto done;


array_state *state = get_array_state_by_class(cls);
assert(state != NULL);

for (i = 0; i < nblocks; i++) {
char* ptr = self->ob_item + i*BLOCKSIZE;
Py_ssize_t size = BLOCKSIZE;
Py_ssize_t offset = 0;
while (1) {
Py_ssize_t total_size = Py_SIZE(self);
if (self->ob_item == NULL || total_size == 0) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather check nullity of ob_item at the end, or include it in the loop condition as well.

break;
}

if (total_size > max_items) {
return PyErr_NoMemory();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why raise MemoryError? just break the loop. I think you can just do while (total_size <= max_items) as max_items doesn't change. This would simplify the loop.

}

Py_ssize_t current_nbytes = total_size * self->ob_descr->itemsize;
if (offset >= current_nbytes) {
break;
}

Py_ssize_t size = current_nbytes - offset;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer reverting this computation, that is, size = BLOCKSIZE and then cut it to what remains.

if (size > BLOCKSIZE) {
size = BLOCKSIZE;
}

char* ptr = self->ob_item + offset;
PyObject *bytes, *res;

if (i*BLOCKSIZE + size > nbytes)
size = nbytes - i*BLOCKSIZE;
bytes = PyBytes_FromStringAndSize(ptr, size);
if (bytes == NULL)
return NULL;
Expand All @@ -1616,6 +1630,8 @@ array_array_tofile_impl(arrayobject *self, PyTypeObject *cls, PyObject *f)
if (res == NULL)
return NULL;
Py_DECREF(res); /* drop write result */

offset += size;
}

done:
Expand Down
Loading