Skip to content

gh-111178: fix UBSan failures in Modules/_io/*.c #129083

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
encukou merged 19 commits into from
Feb 8, 2025
Merged

gh-111178: fix UBSan failures in Modules/_io/*.c #129083

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
37bc556
fix UBSan failures for `buffered`
picnixz Jan 20, 2025
36f5adc
fix UBSan failures for `rwpair`
picnixz Jan 20, 2025
2a02293
fix UBSan failures for `bytesio`
picnixz Jan 20, 2025
fc3cd12
fix UBSan failures for `bytesiobuf`
picnixz Jan 20, 2025
cd728f5
fix UBSan failures for `iobase`
picnixz Jan 20, 2025
0da5a81
fix UBSan failures for `stringio`
picnixz Jan 20, 2025
9889af8
fix UBSan failures for `nldecoder_object`
picnixz Jan 20, 2025
19ed68d
fix UBSan failures for `textio`
picnixz Jan 20, 2025
249ec3e
fix UBSan failures for `winconsoleio`
picnixz Jan 20, 2025
cf44141
reduce diff
picnixz Jan 20, 2025
a9b3ca6
add some new lines
picnixz Jan 20, 2025
9cb97c2
Merge remote-tracking branch 'upstream/main' into fix/ubsan/io-111178
picnixz Jan 25, 2025
416d740
post-merge fix
picnixz Jan 25, 2025
c6f2d0e
use 'ignored' for NOARGS method and 'args' for others
picnixz Feb 6, 2025
ec1e15d
use 'dummy' for NOARGS method
picnixz Feb 6, 2025
14c0684
Merge remote-tracking branch 'upstream/main' into fix/ubsan/io-111178
picnixz Feb 7, 2025
b192d6c
Merge branch 'main' into fix/ubsan/io-111178
picnixz Feb 7, 2025
bb95ac0
Do not add an underscore to the macro if none is needed.
picnixz Feb 8, 2025
2340cae
Do Do not use `_` + capital letter in cast macros as it is also UB.
picnixz Feb 8, 2025
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
Prev Previous commit
Next Next commit
Do not add an underscore to the macro if none is needed.
  • Loading branch information
@picnixz
picnixz committed Feb 8, 2025
commit bb95ac083f694a2c18755f38563b00f71d983c93
38 changes: 19 additions & 19 deletions Modules/_io/bufferedio.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ typedef struct {
PyObject *weakreflist;
} buffered;

#define _buffered_CAST(op) ((buffered *)(op))
#define buffered_CAST(op) ((buffered *)(op))

/*
Implementation notes:
Expand Down Expand Up @@ -403,7 +403,7 @@ _enter_buffered_busy(buffered *self)
static int
buffered_clear(PyObject *op)
{
buffered *self = _buffered_CAST(op);
buffered *self = buffered_CAST(op);
self->ok = 0;
Py_CLEAR(self->raw);
Py_CLEAR(self->dict);
Expand All @@ -413,7 +413,7 @@ buffered_clear(PyObject *op)
static void
buffered_dealloc(PyObject *op)
{
buffered *self = _buffered_CAST(op);
buffered *self = buffered_CAST(op);
PyTypeObject *tp = Py_TYPE(self);
self->finalizing = 1;
if (_PyIOBase_finalize(op) < 0)
Expand Down Expand Up @@ -2231,7 +2231,7 @@ typedef struct {
PyObject *weakreflist;
} rwpair;

#define _rwpair_CAST(op) ((rwpair *)(op))
#define rwpair_CAST(op) ((rwpair *)(op))

/*[clinic input]
_io.BufferedRWPair.__init__
Expand Down Expand Up @@ -2284,7 +2284,7 @@ _io_BufferedRWPair___init___impl(rwpair *self, PyObject *reader,
static int
bufferedrwpair_traverse(PyObject *op, visitproc visit, void *arg)
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
Py_VISIT(Py_TYPE(self));
Py_VISIT(self->dict);
Py_VISIT(self->reader);
Expand All @@ -2295,7 +2295,7 @@ bufferedrwpair_traverse(PyObject *op, visitproc visit, void *arg)
static int
bufferedrwpair_clear(PyObject *op)
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
Py_CLEAR(self->reader);
Py_CLEAR(self->writer);
Py_CLEAR(self->dict);
Expand All @@ -2305,7 +2305,7 @@ bufferedrwpair_clear(PyObject *op)
static void
bufferedrwpair_dealloc(PyObject *op)
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
PyTypeObject *tp = Py_TYPE(self);
_PyObject_GC_UNTRACK(self);
if (self->weakreflist != NULL)
Expand Down Expand Up @@ -2339,70 +2339,70 @@ _forward_call(buffered *self, PyObject *name, PyObject *args)
static PyObject *
bufferedrwpair_read(PyObject *op, PyObject *args)
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
return _forward_call(self->reader, &_Py_ID(read), args);
}

static PyObject *
bufferedrwpair_peek(PyObject *op, PyObject *args)
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
return _forward_call(self->reader, &_Py_ID(peek), args);
}

static PyObject *
bufferedrwpair_read1(PyObject *op, PyObject *args)
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
return _forward_call(self->reader, &_Py_ID(read1), args);
}

static PyObject *
bufferedrwpair_readinto(PyObject *op, PyObject *args)
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
return _forward_call(self->reader, &_Py_ID(readinto), args);
}

static PyObject *
bufferedrwpair_readinto1(PyObject *op, PyObject *args)
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
return _forward_call(self->reader, &_Py_ID(readinto1), args);
}

static PyObject *
bufferedrwpair_write(PyObject *op, PyObject *args)
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
return _forward_call(self->writer, &_Py_ID(write), args);
}

static PyObject *
bufferedrwpair_flush(PyObject *op, PyObject *Py_UNUSED(dummy))
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
return _forward_call(self->writer, &_Py_ID(flush), NULL);
}

static PyObject *
bufferedrwpair_readable(PyObject *op, PyObject *Py_UNUSED(dummy))
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
return _forward_call(self->reader, &_Py_ID(readable), NULL);
}

static PyObject *
bufferedrwpair_writable(PyObject *op, PyObject *Py_UNUSED(dummy))
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
return _forward_call(self->writer, &_Py_ID(writable), NULL);
}

static PyObject *
bufferedrwpair_close(PyObject *op, PyObject *Py_UNUSED(dummy))
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
PyObject *exc = NULL;
PyObject *ret = _forward_call(self->writer, &_Py_ID(close), NULL);
if (ret == NULL) {
Expand All @@ -2422,7 +2422,7 @@ bufferedrwpair_close(PyObject *op, PyObject *Py_UNUSED(dummy))
static PyObject *
bufferedrwpair_isatty(PyObject *op, PyObject *Py_UNUSED(dummy))
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
PyObject *ret = _forward_call(self->writer, &_Py_ID(isatty), NULL);

if (ret != Py_False) {
Expand All @@ -2437,7 +2437,7 @@ bufferedrwpair_isatty(PyObject *op, PyObject *Py_UNUSED(dummy))
static PyObject *
bufferedrwpair_closed_get(PyObject *op, void *Py_UNUSED(dummy))
{
rwpair *self = _rwpair_CAST(op);
rwpair *self = rwpair_CAST(op);
if (self->writer == NULL) {
PyErr_SetString(PyExc_RuntimeError,
"the BufferedRWPair object is being garbage-collected");
Expand Down
32 changes: 16 additions & 16 deletions Modules/_io/bytesio.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ typedef struct {
Py_ssize_t exports;
} bytesio;

#define _bytesio_CAST(op) ((bytesio *)(op))
#define bytesio_CAST(op) ((bytesio *)(op))

typedef struct {
PyObject_HEAD
bytesio *source;
} bytesiobuf;

#define _bytesiobuf_CAST(op) ((bytesiobuf *)(op))
#define bytesiobuf_CAST(op) ((bytesiobuf *)(op))

/* The bytesio object can be in three states:
* Py_REFCNT(buf) == 1, exports == 0.
Expand Down Expand Up @@ -245,7 +245,7 @@ write_bytes(bytesio *self, PyObject *b)
static PyObject *
bytesio_get_closed(PyObject *op, void *Py_UNUSED(closure))
{
bytesio *self = _bytesio_CAST(op);
bytesio *self = bytesio_CAST(op);
if (self->buf == NULL) {
Py_RETURN_TRUE;
}
Expand Down Expand Up @@ -628,7 +628,7 @@ static PyObject *
bytesio_iternext(PyObject *op)
{
Py_ssize_t n;
bytesio *self = _bytesio_CAST(op);
bytesio *self = bytesio_CAST(op);

CHECK_CLOSED(self);

Expand Down Expand Up @@ -791,7 +791,7 @@ _io_BytesIO_close_impl(bytesio *self)
static PyObject *
bytesio_getstate(PyObject *op, PyObject *Py_UNUSED(dummy))
{
bytesio *self = _bytesio_CAST(op);
bytesio *self = bytesio_CAST(op);
PyObject *initvalue = _io_BytesIO_getvalue_impl(self);
PyObject *dict;
PyObject *state;
Expand Down Expand Up @@ -821,7 +821,7 @@ bytesio_setstate(PyObject *op, PyObject *state)
PyObject *position_obj;
PyObject *dict;
Py_ssize_t pos;
bytesio *self = _bytesio_CAST(op);
bytesio *self = bytesio_CAST(op);

assert(state != NULL);

Expand Down Expand Up @@ -893,7 +893,7 @@ bytesio_setstate(PyObject *op, PyObject *state)
static void
bytesio_dealloc(PyObject *op)
{
bytesio *self = _bytesio_CAST(op);
bytesio *self = bytesio_CAST(op);
PyTypeObject *tp = Py_TYPE(self);
_PyObject_GC_UNTRACK(self);
if (self->exports > 0) {
Expand Down Expand Up @@ -972,7 +972,7 @@ _io_BytesIO___init___impl(bytesio *self, PyObject *initvalue)
static PyObject *
bytesio_sizeof(PyObject *op, PyObject *Py_UNUSED(dummy))
{
bytesio *self = _bytesio_CAST(op);
bytesio *self = bytesio_CAST(op);
size_t res = _PyObject_SIZE(Py_TYPE(self));
if (self->buf && !SHARED_BUF(self)) {
size_t s = _PySys_GetSizeOf(self->buf);
Expand All @@ -987,7 +987,7 @@ bytesio_sizeof(PyObject *op, PyObject *Py_UNUSED(dummy))
static int
bytesio_traverse(PyObject *op, visitproc visit, void *arg)
{
bytesio *self = _bytesio_CAST(op);
bytesio *self = bytesio_CAST(op);
Py_VISIT(Py_TYPE(self));
Py_VISIT(self->dict);
Py_VISIT(self->buf);
Expand All @@ -997,7 +997,7 @@ bytesio_traverse(PyObject *op, visitproc visit, void *arg)
static int
bytesio_clear(PyObject *op)
{
bytesio *self = _bytesio_CAST(op);
bytesio *self = bytesio_CAST(op);
Py_CLEAR(self->dict);
if (self->exports == 0) {
Py_CLEAR(self->buf);
Expand Down Expand Up @@ -1079,8 +1079,8 @@ PyType_Spec bytesio_spec = {
static int
bytesiobuf_getbuffer(PyObject *op, Py_buffer *view, int flags)
{
bytesiobuf *obj = _bytesiobuf_CAST(op);
bytesio *b = _bytesio_CAST(obj->source);
bytesiobuf *obj = bytesiobuf_CAST(op);
bytesio *b = bytesio_CAST(obj->source);

if (view == NULL) {
PyErr_SetString(PyExc_BufferError,
Expand All @@ -1103,15 +1103,15 @@ bytesiobuf_getbuffer(PyObject *op, Py_buffer *view, int flags)
static void
bytesiobuf_releasebuffer(PyObject *op, Py_buffer *Py_UNUSED(view))
{
bytesiobuf *obj = _bytesiobuf_CAST(op);
bytesio *b = _bytesio_CAST(obj->source);
bytesiobuf *obj = bytesiobuf_CAST(op);
bytesio *b = bytesio_CAST(obj->source);
b->exports--;
}

static int
bytesiobuf_traverse(PyObject *op, visitproc visit, void *arg)
{
bytesiobuf *self = _bytesiobuf_CAST(op);
bytesiobuf *self = bytesiobuf_CAST(op);
Py_VISIT(Py_TYPE(self));
Py_VISIT(self->source);
return 0;
Expand All @@ -1120,7 +1120,7 @@ bytesiobuf_traverse(PyObject *op, visitproc visit, void *arg)
static void
bytesiobuf_dealloc(PyObject *op)
{
bytesiobuf *self = _bytesiobuf_CAST(op);
bytesiobuf *self = bytesiobuf_CAST(op);
PyTypeObject *tp = Py_TYPE(self);
/* bpo-31095: UnTrack is needed before calling any callbacks */
PyObject_GC_UnTrack(op);
Expand Down
8 changes: 4 additions & 4 deletions Modules/_io/iobase.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ typedef struct {
PyObject *weakreflist;
} iobase;

#define _iobase_CAST(op) ((iobase *)(op))
#define iobase_CAST(op) ((iobase *)(op))

PyDoc_STRVAR(iobase_doc,
"The abstract base class for all I/O classes.\n"
Expand Down Expand Up @@ -347,7 +347,7 @@ _PyIOBase_finalize(PyObject *self)
static int
iobase_traverse(PyObject *op, visitproc visit, void *arg)
{
iobase *self = _iobase_CAST(op);
iobase *self = iobase_CAST(op);
Py_VISIT(Py_TYPE(self));
Py_VISIT(self->dict);
return 0;
Expand All @@ -356,7 +356,7 @@ iobase_traverse(PyObject *op, visitproc visit, void *arg)
static int
iobase_clear(PyObject *op)
{
iobase *self = _iobase_CAST(op);
iobase *self = iobase_CAST(op);
Py_CLEAR(self->dict);
return 0;
}
Expand All @@ -371,7 +371,7 @@ iobase_dealloc(PyObject *op)
However, if the derived class declares a __slots__, those slots are
already gone.
*/
iobase *self = _iobase_CAST(op);
iobase *self = iobase_CAST(op);
if (_PyIOBase_finalize(op) < 0) {
/* When called from a heap type's dealloc, the type will be
decref'ed on return (see e.g. subtype_dealloc in typeobject.c). */
Expand Down
10 changes: 5 additions & 5 deletions Modules/_io/stringio.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ typedef struct {
_PyIO_State *module_state;
} stringio;

#define _stringio_CAST(op) ((stringio *)(op))
#define stringio_CAST(op) ((stringio *)(op))

#define clinic_state() (find_io_state_by_def(Py_TYPE(self)))
#include "clinic/stringio.c.h"
Expand Down Expand Up @@ -407,7 +407,7 @@ static PyObject *
stringio_iternext(PyObject *op)
{
PyObject *line;
stringio *self = _stringio_CAST(op);
stringio *self = stringio_CAST(op);

CHECK_INITIALIZED(self);
CHECK_CLOSED(self);
Expand Down Expand Up @@ -595,7 +595,7 @@ _io_StringIO_close_impl(stringio *self)
static int
stringio_traverse(PyObject *op, visitproc visit, void *arg)
{
stringio *self = _stringio_CAST(op);
stringio *self = stringio_CAST(op);
Py_VISIT(Py_TYPE(self));
Py_VISIT(self->readnl);
Py_VISIT(self->writenl);
Expand All @@ -607,7 +607,7 @@ stringio_traverse(PyObject *op, visitproc visit, void *arg)
static int
stringio_clear(PyObject *op)
{
stringio *self = _stringio_CAST(op);
stringio *self = stringio_CAST(op);
Py_CLEAR(self->readnl);
Py_CLEAR(self->writenl);
Py_CLEAR(self->decoder);
Expand All @@ -618,7 +618,7 @@ stringio_clear(PyObject *op)
static void
stringio_dealloc(PyObject *op)
{
stringio *self = _stringio_CAST(op);
stringio *self = stringio_CAST(op);
PyTypeObject *tp = Py_TYPE(self);
_PyObject_GC_UNTRACK(self);
self->ok = 0;
Expand Down
Loading