https://github.com/python/cpython/commit/1e4a4344af4f5fdc7157b195c7d333d088540035
commit: 1e4a4344af4f5fdc7157b195c7d333d088540035
branch: main
author: Bénédikt Tran <[email protected]>
committer: picnixz <[email protected]>
date: 2025-02-23T10:34:11Z
summary:
gh-111178: fix UBSan failures in `Modules/_struct.c` (#129793)
Fix some UBSan failures for `PyStructObject` and `unpackiterobject`.
We also perform some cleanup by suppressing unused return values and renaming
the
unused parameter in `METH_NOARGS` and getter methods to `dummy` and `closure`
respectively for semantic purposes.
files:
M Modules/_struct.c
diff --git a/Modules/_struct.c b/Modules/_struct.c
index 21582b945be23d..f096998cb714e7 100644
--- a/Modules/_struct.c
+++ b/Modules/_struct.c
@@ -73,7 +73,8 @@ typedef struct {
PyObject *weakreflist; /* List of weak references */
} PyStructObject;
-#define PyStruct_Check(op, state) PyObject_TypeCheck(op, (PyTypeObject
*)(state)->PyStructType)
+#define PyStructObject_CAST(op) ((PyStructObject *)(op))
+#define PyStruct_Check(op, state) PyObject_TypeCheck(op, (PyTypeObject
*)(state)->PyStructType)
/* Define various structs to figure out the alignments of types */
@@ -1853,33 +1854,36 @@ Struct___init___impl(PyStructObject *self, PyObject
*format)
}
static int
-s_clear(PyStructObject *s)
+s_clear(PyObject *op)
{
+ PyStructObject *s = PyStructObject_CAST(op);
Py_CLEAR(s->s_format);
return 0;
}
static int
-s_traverse(PyStructObject *s, visitproc visit, void *arg)
+s_traverse(PyObject *op, visitproc visit, void *arg)
{
+ PyStructObject *s = PyStructObject_CAST(op);
Py_VISIT(Py_TYPE(s));
Py_VISIT(s->s_format);
return 0;
}
static void
-s_dealloc(PyStructObject *s)
+s_dealloc(PyObject *op)
{
+ PyStructObject *s = PyStructObject_CAST(op);
PyTypeObject *tp = Py_TYPE(s);
PyObject_GC_UnTrack(s);
- if (s->weakreflist != NULL)
- PyObject_ClearWeakRefs((PyObject *)s);
+ if (s->weakreflist != NULL) {
+ PyObject_ClearWeakRefs(op);
+ }
if (s->s_codes != NULL) {
PyMem_Free(s->s_codes);
}
Py_XDECREF(s->s_format);
- freefunc free_func = PyType_GetSlot(Py_TYPE(s), Py_tp_free);
- free_func(s);
+ tp->tp_free(s);
Py_DECREF(tp);
}
@@ -2026,9 +2030,12 @@ typedef struct {
Py_ssize_t index;
} unpackiterobject;
+#define unpackiterobject_CAST(op) ((unpackiterobject *)(op))
+
static void
-unpackiter_dealloc(unpackiterobject *self)
+unpackiter_dealloc(PyObject *op)
{
+ unpackiterobject *self = unpackiterobject_CAST(op);
/* bpo-31095: UnTrack is needed before calling any callbacks */
PyTypeObject *tp = Py_TYPE(self);
PyObject_GC_UnTrack(self);
@@ -2039,8 +2046,9 @@ unpackiter_dealloc(unpackiterobject *self)
}
static int
-unpackiter_traverse(unpackiterobject *self, visitproc visit, void *arg)
+unpackiter_traverse(PyObject *op, visitproc visit, void *arg)
{
+ unpackiterobject *self = unpackiterobject_CAST(op);
Py_VISIT(Py_TYPE(self));
Py_VISIT(self->so);
Py_VISIT(self->buf.obj);
@@ -2048,28 +2056,33 @@ unpackiter_traverse(unpackiterobject *self, visitproc
visit, void *arg)
}
static PyObject *
-unpackiter_len(unpackiterobject *self, PyObject *Py_UNUSED(ignored))
+unpackiter_len(PyObject *op, PyObject *Py_UNUSED(dummy))
{
Py_ssize_t len;
- if (self->so == NULL)
+ unpackiterobject *self = unpackiterobject_CAST(op);
+ if (self->so == NULL) {
len = 0;
- else
+ }
+ else {
len = (self->buf.len - self->index) / self->so->s_size;
+ }
return PyLong_FromSsize_t(len);
}
static PyMethodDef unpackiter_methods[] = {
- {"__length_hint__", (PyCFunction) unpackiter_len, METH_NOARGS, NULL},
+ {"__length_hint__", unpackiter_len, METH_NOARGS, NULL},
{NULL, NULL} /* sentinel */
};
static PyObject *
-unpackiter_iternext(unpackiterobject *self)
+unpackiter_iternext(PyObject *op)
{
+ unpackiterobject *self = unpackiterobject_CAST(op);
_structmodulestate *state = get_struct_state_iterinst(self);
PyObject *result;
- if (self->so == NULL)
+ if (self->so == NULL) {
return NULL;
+ }
if (self->index >= self->buf.len) {
/* Iterator exhausted */
Py_CLEAR(self->so);
@@ -2078,7 +2091,7 @@ unpackiter_iternext(unpackiterobject *self)
}
assert(self->index + self->so->s_size <= self->buf.len);
result = s_unpack_internal(self->so,
- (char*) self->buf.buf + self->index,
+ (char*)self->buf.buf + self->index,
state);
self->index += self->so->s_size;
return result;
@@ -2264,7 +2277,7 @@ s_pack(PyObject *self, PyObject *const *args, Py_ssize_t
nargs)
_structmodulestate *state = get_struct_state_structinst(self);
/* Validate arguments. */
- soself = (PyStructObject *)self;
+ soself = PyStructObject_CAST(self);
assert(PyStruct_Check(self, state));
assert(soself->s_codes != NULL);
if (nargs != soself->s_len)
@@ -2309,7 +2322,7 @@ s_pack_into(PyObject *self, PyObject *const *args,
Py_ssize_t nargs)
_structmodulestate *state = get_struct_state_structinst(self);
/* Validate arguments. +1 is for the first arg as buffer. */
- soself = (PyStructObject *)self;
+ soself = PyStructObject_CAST(self);
assert(PyStruct_Check(self, state));
assert(soself->s_codes != NULL);
if (nargs != (soself->s_len + 2))
@@ -2395,15 +2408,17 @@ s_pack_into(PyObject *self, PyObject *const *args,
Py_ssize_t nargs)
}
static PyObject *
-s_get_format(PyStructObject *self, void *unused)
+s_get_format(PyObject *op, void *Py_UNUSED(closure))
{
+ PyStructObject *self = PyStructObject_CAST(op);
return PyUnicode_FromStringAndSize(PyBytes_AS_STRING(self->s_format),
PyBytes_GET_SIZE(self->s_format));
}
static PyObject *
-s_get_size(PyStructObject *self, void *unused)
+s_get_size(PyObject *op, void *Py_UNUSED(closure))
{
+ PyStructObject *self = PyStructObject_CAST(op);
return PyLong_FromSsize_t(self->s_size);
}
@@ -2411,8 +2426,9 @@ PyDoc_STRVAR(s_sizeof__doc__,
"S.__sizeof__() -> size of S in memory, in bytes");
static PyObject *
-s_sizeof(PyStructObject *self, void *unused)
+s_sizeof(PyObject *op, PyObject *Py_UNUSED(dummy))
{
+ PyStructObject *self = PyStructObject_CAST(op);
size_t size = _PyObject_SIZE(Py_TYPE(self)) + sizeof(formatcode);
for (formatcode *code = self->s_codes; code->fmtdef != NULL; code++) {
size += sizeof(formatcode);
@@ -2421,8 +2437,9 @@ s_sizeof(PyStructObject *self, void *unused)
}
static PyObject *
-s_repr(PyStructObject *self)
+s_repr(PyObject *op)
{
+ PyStructObject *self = PyStructObject_CAST(op);
PyObject* fmt = PyUnicode_FromStringAndSize(
PyBytes_AS_STRING(self->s_format), PyBytes_GET_SIZE(self->s_format));
if (fmt == NULL) {
@@ -2441,7 +2458,7 @@ static struct PyMethodDef s_methods[] = {
{"pack_into", _PyCFunction_CAST(s_pack_into), METH_FASTCALL,
s_pack_into__doc__},
STRUCT_UNPACK_METHODDEF
STRUCT_UNPACK_FROM_METHODDEF
- {"__sizeof__", (PyCFunction)s_sizeof, METH_NOARGS, s_sizeof__doc__},
+ {"__sizeof__", s_sizeof, METH_NOARGS, s_sizeof__doc__},
{NULL, NULL} /* sentinel */
};
@@ -2451,8 +2468,8 @@ static PyMemberDef s_members[] = {
};
static PyGetSetDef s_getsetlist[] = {
- {"format", (getter)s_get_format, (setter)NULL, PyDoc_STR("struct format
string"), NULL},
- {"size", (getter)s_get_size, (setter)NULL, PyDoc_STR("struct size in
bytes"), NULL},
+ {"format", s_get_format, NULL, PyDoc_STR("struct format string"), NULL},
+ {"size", s_get_size, NULL, PyDoc_STR("struct size in bytes"), NULL},
{NULL} /* sentinel */
};
@@ -2508,7 +2525,7 @@ cache_struct_converter(PyObject *module, PyObject *fmt,
PyStructObject **ptr)
return 0;
}
if (s_object != NULL) {
- *ptr = (PyStructObject *)s_object;
+ *ptr = PyStructObject_CAST(s_object);
return Py_CLEANUP_SUPPORTED;
}
@@ -2751,7 +2768,7 @@ _structmodule_clear(PyObject *module)
static void
_structmodule_free(void *module)
{
- _structmodule_clear((PyObject *)module);
+ (void)_structmodule_clear((PyObject *)module);
}
static int
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
