Skip to content

gh-116946: fully implement GC protocol for _hashlib objects #138289

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
merged 3 commits into from
Sep 1, 2025
Merged

gh-116946: fully implement GC protocol for _hashlib objects #138289

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c79e13
fully implement GC protocol for `_hashlib` objects
picnixz Aug 31, 2025
119c19e
fix: `tp_traverse` is not inherited
picnixz Aug 31, 2025
23c4d91
smash diff
picnixz Aug 31, 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
51 changes: 41 additions & 10 deletions Modules/_hashopenssl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,7 +752,9 @@ py_wrapper_EVP_MD_CTX_new(void)
static HASHobject *
new_hash_object(PyTypeObject *type)
{
HASHobject *retval = PyObject_New(HASHobject, type);
assert(type != NULL);
assert(type->tp_alloc != NULL);
HASHobject *retval = (HASHobject *)type->tp_alloc(type, 0);
if (retval == NULL) {
return NULL;
}
Expand Down Expand Up @@ -792,13 +794,21 @@ _hashlib_HASH_hash(HASHobject *self, const void *vp, Py_ssize_t len)
static void
_hashlib_HASH_dealloc(PyObject *op)
{
PyTypeObject *tp = Py_TYPE(op);
PyObject_GC_UnTrack(op);
HASHobject *self = HASHobject_CAST(op);
PyTypeObject *tp = Py_TYPE(self);
EVP_MD_CTX_free(self->ctx);
PyObject_Free(self);
tp->tp_free(self);
Py_DECREF(tp);
}

static int
_hashlib_HASH_traverse(PyObject *op, visitproc visit, void *arg)
{
Py_VISIT(Py_TYPE(op));
return 0;
}

static int
_hashlib_HASH_copy_locked(HASHobject *self, EVP_MD_CTX *new_ctx_p)
{
Expand Down Expand Up @@ -993,6 +1003,7 @@ PyDoc_STRVAR(HASHobject_type_doc,

static PyType_Slot HASHobject_type_slots[] = {
{Py_tp_dealloc, _hashlib_HASH_dealloc},
{Py_tp_traverse, _hashlib_HASH_traverse},
{Py_tp_repr, _hashlib_HASH_repr},
{Py_tp_doc, (char *)HASHobject_type_doc},
{Py_tp_methods, HASH_methods},
Expand All @@ -1008,6 +1019,7 @@ static PyType_Spec HASHobject_type_spec = {
| Py_TPFLAGS_BASETYPE
| Py_TPFLAGS_DISALLOW_INSTANTIATION
| Py_TPFLAGS_IMMUTABLETYPE
| Py_TPFLAGS_HAVE_GC
),
.slots = HASHobject_type_slots
};
Expand Down Expand Up @@ -1165,6 +1177,8 @@ PyDoc_STRVAR(HASHXOFobject_type_doc,
"digest_size -- number of bytes in this hashes output");

static PyType_Slot HASHXOFobject_type_slots[] = {
{Py_tp_dealloc, _hashlib_HASH_dealloc},
{Py_tp_traverse, _hashlib_HASH_traverse},
{Py_tp_doc, (char *)HASHXOFobject_type_doc},
{Py_tp_methods, HASHXOFobject_methods},
{Py_tp_getset, HASHXOFobject_getsets},
Expand All @@ -1179,6 +1193,7 @@ static PyType_Spec HASHXOFobject_type_spec = {
| Py_TPFLAGS_BASETYPE
| Py_TPFLAGS_DISALLOW_INSTANTIATION
| Py_TPFLAGS_IMMUTABLETYPE
| Py_TPFLAGS_HAVE_GC
),
.slots = HASHXOFobject_type_slots
};
Expand Down Expand Up @@ -1902,7 +1917,8 @@ _hashlib_hmac_new_impl(PyObject *module, Py_buffer *key, PyObject *msg_obj,
goto error;
}

self = PyObject_New(HMACobject, state->HMAC_type);
assert(state->HMAC_type != NULL);
self = (HMACobject *)state->HMAC_type->tp_alloc(state->HMAC_type, 0);
if (self == NULL) {
goto error;
}
Expand Down Expand Up @@ -2008,7 +2024,8 @@ _hashlib_HMAC_copy_impl(HMACobject *self)
return NULL;
}

retval = PyObject_New(HMACobject, Py_TYPE(self));
PyTypeObject *type = Py_TYPE(self);
retval = (HMACobject *)type->tp_alloc(type, 0);
if (retval == NULL) {
HMAC_CTX_free(ctx);
return NULL;
Expand All @@ -2022,16 +2039,24 @@ _hashlib_HMAC_copy_impl(HMACobject *self)
static void
_hmac_dealloc(PyObject *op)
{
PyTypeObject *tp = Py_TYPE(op);
PyObject_GC_UnTrack(op);
HMACobject *self = HMACobject_CAST(op);
PyTypeObject *tp = Py_TYPE(self);
if (self->ctx != NULL) {
HMAC_CTX_free(self->ctx);
self->ctx = NULL;
}
PyObject_Free(self);
tp->tp_free(self);
Py_DECREF(tp);
}

static int
_hashlib_HMAC_traverse(PyObject *op, visitproc visit, void *arg)
{
Py_VISIT(Py_TYPE(op));
return 0;
}

static PyObject *
_hmac_repr(PyObject *op)
{
Expand Down Expand Up @@ -2198,15 +2223,21 @@ static PyType_Slot HMACtype_slots[] = {
{Py_tp_doc, (char *)hmactype_doc},
{Py_tp_repr, _hmac_repr},
{Py_tp_dealloc, _hmac_dealloc},
{Py_tp_traverse, _hashlib_HMAC_traverse},
{Py_tp_methods, HMAC_methods},
{Py_tp_getset, HMAC_getset},
{0, NULL}
};

PyType_Spec HMACtype_spec = {
"_hashlib.HMAC", /* name */
sizeof(HMACobject), /* basicsize */
.flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_DISALLOW_INSTANTIATION | Py_TPFLAGS_IMMUTABLETYPE,
.name = "_hashlib.HMAC",
.basicsize = sizeof(HMACobject),
.flags = (
Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_DISALLOW_INSTANTIATION
| Py_TPFLAGS_IMMUTABLETYPE
| Py_TPFLAGS_HAVE_GC
),
.slots = HMACtype_slots,
};

Expand Down
Loading