Skip to content

gh-111178: fix UBSan failures in Modules/_collectionsmodule.c #129773

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
picnixz merged 10 commits into from
Feb 17, 2025
Merged

gh-111178: fix UBSan failures in Modules/_collectionsmodule.c #129773

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
22e4df8
fix UBSan failures for `dequeobject`
picnixz Jan 25, 2025
a19302d
fix UBSan failures for `dequeiterobject`
picnixz Jan 25, 2025
7a6384e
fix UBSan failures for `defdictobject`
picnixz Jan 25, 2025
6268c5e
fix UBSan failures for `tuplegetterobject`
picnixz Jan 25, 2025
337cb29
suppress unused return values
picnixz Jan 25, 2025
cd3775b
use 'dummy' for NOARGS method
picnixz Feb 6, 2025
e825058
Merge remote-tracking branch 'upstream/main' into fix/ubsan/collectio…
picnixz Feb 7, 2025
46da2c4
Do not add an underscore to the macro if none is needed.
picnixz Feb 8, 2025
b245b68
Remove unnecessary cast
picnixz Feb 8, 2025
ef6141a
Merge branch 'main' into fix/ubsan/collections-111178
picnixz Feb 17, 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
fix UBSan failures for dequeiterobject
  • Loading branch information
@picnixz
picnixz committed Jan 25, 2025
commit a19302d3051c90efe5ce66d6b506233811ac552c
34 changes: 21 additions & 13 deletions Modules/_collectionsmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1898,6 +1898,8 @@ typedef struct {
Py_ssize_t counter; /* number of items remaining for iteration */
} dequeiterobject;

#define _dequeiterobject_CAST(op) ((dequeiterobject *)(op))

static PyObject *
deque_iter(PyObject *self)
{
Expand All @@ -1920,22 +1922,24 @@ deque_iter(PyObject *self)
}

static int
dequeiter_traverse(dequeiterobject *dio, visitproc visit, void *arg)
dequeiter_traverse(PyObject *op, visitproc visit, void *arg)
{
dequeiterobject *dio = _dequeiterobject_CAST(op);
Py_VISIT(Py_TYPE(dio));
Py_VISIT(dio->deque);
return 0;
}

static int
dequeiter_clear(dequeiterobject *dio)
dequeiter_clear(PyObject *op)
{
dequeiterobject *dio = _dequeiterobject_CAST(op);
Py_CLEAR(dio->deque);
return 0;
}

static void
dequeiter_dealloc(dequeiterobject *dio)
dequeiter_dealloc(PyObject *dio)
{
/* bpo-31095: UnTrack is needed before calling any callbacks */
PyTypeObject *tp = Py_TYPE(dio);
Expand Down Expand Up @@ -1973,9 +1977,10 @@ dequeiter_next_lock_held(dequeiterobject *it, dequeobject *deque)
}

static PyObject *
dequeiter_next(dequeiterobject *it)
dequeiter_next(PyObject *op)
{
PyObject *result;
dequeiterobject *it = _dequeiterobject_CAST(op);
// It's safe to access it->deque without holding the per-object lock for it
// here; it->deque is only assigned during construction of it.
dequeobject *deque = it->deque;
Expand All @@ -1997,12 +2002,12 @@ dequeiter_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
return NULL;
assert(type == state->dequeiter_type);

it = (dequeiterobject*)deque_iter((dequeobject *)deque);
it = (dequeiterobject*)deque_iter(deque);
if (!it)
return NULL;
/* consume items from the queue */
for(i=0; i<index; i++) {
PyObject *item = dequeiter_next(it);
PyObject *item = dequeiter_next((PyObject *)it);
if (item) {
Py_DECREF(item);
} else {
Expand All @@ -2022,32 +2027,34 @@ dequeiter_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
}

static PyObject *
dequeiter_len(dequeiterobject *it, PyObject *Py_UNUSED(ignored))
dequeiter_len(PyObject *op, PyObject *Py_UNUSED(args))
{
dequeiterobject *it = _dequeiterobject_CAST(op);
Py_ssize_t len = FT_ATOMIC_LOAD_SSIZE(it->counter);
return PyLong_FromSsize_t(len);
}

PyDoc_STRVAR(length_hint_doc, "Private method returning an estimate of len(list(it)).");

static PyObject *
dequeiter_reduce(dequeiterobject *it, PyObject *Py_UNUSED(ignored))
dequeiter_reduce(PyObject *op, PyObject *Py_UNUSED(args))
{
dequeiterobject *it = _dequeiterobject_CAST(op);
PyTypeObject *ty = Py_TYPE(it);
// It's safe to access it->deque without holding the per-object lock for it
// here; it->deque is only assigned during construction of it.
dequeobject *deque = it->deque;
Py_ssize_t size, counter;
Py_BEGIN_CRITICAL_SECTION2(it, deque);
size = Py_SIZE(deque);
size = Py_SIZE((PyObject *)deque);
Comment thread
picnixz marked this conversation as resolved.
Outdated
Comment thread
picnixz marked this conversation as resolved.
Outdated
counter = it->counter;
Py_END_CRITICAL_SECTION2();
return Py_BuildValue("O(On)", ty, deque, size - counter);
}

static PyMethodDef dequeiter_methods[] = {
{"__length_hint__", (PyCFunction)dequeiter_len, METH_NOARGS, length_hint_doc},
{"__reduce__", (PyCFunction)dequeiter_reduce, METH_NOARGS, reduce_doc},
{"__length_hint__", dequeiter_len, METH_NOARGS, length_hint_doc},
{"__reduce__", dequeiter_reduce, METH_NOARGS, reduce_doc},
{NULL, NULL} /* sentinel */
};

Expand Down Expand Up @@ -2121,9 +2128,10 @@ dequereviter_next_lock_held(dequeiterobject *it, dequeobject *deque)
}

static PyObject *
dequereviter_next(dequeiterobject *it)
dequereviter_next(PyObject *self)
{
PyObject *item;
dequeiterobject *it = _dequeiterobject_CAST(self);
// It's safe to access it->deque without holding the per-object lock for it
// here; it->deque is only assigned during construction of it.
dequeobject *deque = it->deque;
Expand All @@ -2149,7 +2157,7 @@ dequereviter_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
return NULL;
/* consume items from the queue */
for(i=0; i<index; i++) {
PyObject *item = dequereviter_next(it);
PyObject *item = dequereviter_next((PyObject *)it);
if (item) {
Py_DECREF(item);
} else {
Expand Down