Skip to content

Commit a7f0268

Browse files
koubaakoubaa
authored
bpo-1635741: Port _blake2 module to multi-phase init (GH-21856)
Port the _blake2 extension module to the multi-phase initialization API (PEP 489).
1 parent 749ed85 commit a7f0268

File tree

4 files changed

+119
-118
lines changed

4 files changed

+119
-118
lines changed

‎Misc/NEWS.d/next/Core and Builtins/2020-08-13-07-18-05.bpo-1635741.FC13e7.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Port the :mod:`_blake2` extension module to the multi-phase initialization API (:pep:`489`).

‎Modules/_blake2/blake2b_impl.c

+17-40
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
#endif
3535

3636

37-
extern PyTypeObject PyBlake2_BLAKE2bType;
37+
extern PyType_Spec blake2b_type_spec;
3838

3939
typedef struct {
4040
PyObject_HEAD
@@ -391,47 +391,24 @@ py_blake2b_dealloc(PyObject *self)
391391
PyThread_free_lock(obj->lock);
392392
obj->lock = NULL;
393393
}
394+
395+
PyTypeObject *type = Py_TYPE(self);
394396
PyObject_Del(self);
397+
Py_DECREF(type);
395398
}
396399

400+
static PyType_Slot blake2b_type_slots[] = {
401+
{Py_tp_dealloc, py_blake2b_dealloc},
402+
{Py_tp_doc, (char *)py_blake2b_new__doc__},
403+
{Py_tp_methods, py_blake2b_methods},
404+
{Py_tp_getset, py_blake2b_getsetters},
405+
{Py_tp_new, py_blake2b_new},
406+
{0,0}
407+
};
397408

398-
PyTypeObject PyBlake2_BLAKE2bType = {
399-
PyVarObject_HEAD_INIT(NULL, 0)
400-
"_blake2.blake2b", /* tp_name */
401-
sizeof(BLAKE2bObject), /* tp_basicsize */
402-
0, /* tp_itemsize */
403-
py_blake2b_dealloc, /* tp_dealloc */
404-
0, /*tp_vectorcall_offset*/
405-
0, /* tp_getattr */
406-
0, /* tp_setattr */
407-
0, /* tp_as_async */
408-
0, /* tp_repr */
409-
0, /* tp_as_number */
410-
0, /* tp_as_sequence */
411-
0, /* tp_as_mapping */
412-
0, /* tp_hash */
413-
0, /* tp_call */
414-
0, /* tp_str */
415-
0, /* tp_getattro */
416-
0, /* tp_setattro */
417-
0, /* tp_as_buffer */
418-
Py_TPFLAGS_DEFAULT, /* tp_flags */
419-
py_blake2b_new__doc__, /* tp_doc */
420-
0, /* tp_traverse */
421-
0, /* tp_clear */
422-
0, /* tp_richcompare */
423-
0, /* tp_weaklistoffset */
424-
0, /* tp_iter */
425-
0, /* tp_iternext */
426-
py_blake2b_methods, /* tp_methods */
427-
0, /* tp_members */
428-
py_blake2b_getsetters, /* tp_getset */
429-
0, /* tp_base */
430-
0, /* tp_dict */
431-
0, /* tp_descr_get */
432-
0, /* tp_descr_set */
433-
0, /* tp_dictoffset */
434-
0, /* tp_init */
435-
0, /* tp_alloc */
436-
py_blake2b_new, /* tp_new */
409+
PyType_Spec blake2b_type_spec = {
410+
.name = "_blake2.blake2b",
411+
.basicsize = sizeof(BLAKE2bObject),
412+
.flags = Py_TPFLAGS_DEFAULT,
413+
.slots = blake2b_type_slots
437414
};

‎Modules/_blake2/blake2module.c

+84-37
Original file line numberDiff line numberDiff line change
@@ -12,62 +12,81 @@
1212

1313
#include "impl/blake2.h"
1414

15-
extern PyTypeObject PyBlake2_BLAKE2bType;
16-
extern PyTypeObject PyBlake2_BLAKE2sType;
17-
15+
extern PyType_Spec blake2b_type_spec;
16+
extern PyType_Spec blake2s_type_spec;
1817

1918
PyDoc_STRVAR(blake2mod__doc__,
2019
"_blake2b provides BLAKE2b for hashlib\n"
2120
);
2221

22+
typedef struct {
23+
PyTypeObject* blake2b_type;
24+
PyTypeObject* blake2s_type;
25+
} Blake2State;
26+
27+
static inline Blake2State*
28+
blake2_get_state(PyObject *module)
29+
{
30+
void *state = PyModule_GetState(module);
31+
assert(state != NULL);
32+
return (Blake2State *)state;
33+
}
2334

2435
static struct PyMethodDef blake2mod_functions[] = {
2536
{NULL, NULL}
2637
};
2738

28-
static struct PyModuleDef blake2_module = {
29-
PyModuleDef_HEAD_INIT,
30-
"_blake2",
31-
blake2mod__doc__,
32-
-1,
33-
blake2mod_functions,
34-
NULL,
35-
NULL,
36-
NULL,
37-
NULL
38-
};
39+
static int
40+
_blake2_traverse(PyObject *module, visitproc visit, void *arg)
41+
{
42+
Blake2State *state = blake2_get_state(module);
43+
Py_VISIT(state->blake2b_type);
44+
Py_VISIT(state->blake2s_type);
45+
return 0;
46+
}
47+
48+
static int
49+
_blake2_clear(PyObject *module)
50+
{
51+
Blake2State *state = blake2_get_state(module);
52+
Py_CLEAR(state->blake2b_type);
53+
Py_CLEAR(state->blake2s_type);
54+
return 0;
55+
}
56+
57+
static void
58+
_blake2_free(void *module)
59+
{
60+
_blake2_clear((PyObject *)module);
61+
}
3962

4063
#define ADD_INT(d, name, value) do { \
4164
PyObject *x = PyLong_FromLong(value); \
42-
if (!x) { \
43-
Py_DECREF(m); \
44-
return NULL; \
45-
} \
65+
if (!x) \
66+
return -1; \
4667
if (PyDict_SetItemString(d, name, x) < 0) { \
47-
Py_DECREF(m); \
48-
return NULL; \
68+
Py_DECREF(x); \
69+
return -1; \
4970
} \
5071
Py_DECREF(x); \
5172
} while(0)
5273

53-
54-
PyMODINIT_FUNC
55-
PyInit__blake2(void)
74+
static int
75+
blake2_exec(PyObject *m)
5676
{
57-
PyObject *m;
58-
PyObject *d;
77+
Blake2State* st = blake2_get_state(m);
5978

60-
m = PyModule_Create(&blake2_module);
61-
if (m == NULL)
62-
return NULL;
79+
st->blake2b_type = (PyTypeObject *)PyType_FromModuleAndSpec(
80+
m, &blake2b_type_spec, NULL);
6381

82+
if (NULL == st->blake2b_type)
83+
return -1;
6484
/* BLAKE2b */
65-
Py_SET_TYPE(&PyBlake2_BLAKE2bType, &PyType_Type);
66-
if (PyModule_AddType(m, &PyBlake2_BLAKE2bType) < 0) {
67-
return NULL;
85+
if (PyModule_AddType(m, st->blake2b_type) < 0) {
86+
return -1;
6887
}
6988

70-
d = PyBlake2_BLAKE2bType.tp_dict;
89+
PyObject *d = st->blake2b_type->tp_dict;
7190
ADD_INT(d, "SALT_SIZE", BLAKE2B_SALTBYTES);
7291
ADD_INT(d, "PERSON_SIZE", BLAKE2B_PERSONALBYTES);
7392
ADD_INT(d, "MAX_KEY_SIZE", BLAKE2B_KEYBYTES);
@@ -79,12 +98,17 @@ PyInit__blake2(void)
7998
PyModule_AddIntConstant(m, "BLAKE2B_MAX_DIGEST_SIZE", BLAKE2B_OUTBYTES);
8099

81100
/* BLAKE2s */
82-
Py_SET_TYPE(&PyBlake2_BLAKE2sType, &PyType_Type);
83-
if (PyModule_AddType(m, &PyBlake2_BLAKE2sType) < 0) {
84-
return NULL;
101+
st->blake2s_type = (PyTypeObject *)PyType_FromModuleAndSpec(
102+
m, &blake2s_type_spec, NULL);
103+
104+
if (NULL == st->blake2s_type)
105+
return -1;
106+
107+
if (PyModule_AddType(m, st->blake2s_type) < 0) {
108+
return -1;
85109
}
86110

87-
d = PyBlake2_BLAKE2sType.tp_dict;
111+
d = st->blake2s_type->tp_dict;
88112
ADD_INT(d, "SALT_SIZE", BLAKE2S_SALTBYTES);
89113
ADD_INT(d, "PERSON_SIZE", BLAKE2S_PERSONALBYTES);
90114
ADD_INT(d, "MAX_KEY_SIZE", BLAKE2S_KEYBYTES);
@@ -95,5 +119,28 @@ PyInit__blake2(void)
95119
PyModule_AddIntConstant(m, "BLAKE2S_MAX_KEY_SIZE", BLAKE2S_KEYBYTES);
96120
PyModule_AddIntConstant(m, "BLAKE2S_MAX_DIGEST_SIZE", BLAKE2S_OUTBYTES);
97121

98-
return m;
122+
return 0;
99123
}
124+
125+
static PyModuleDef_Slot _blake2_slots[] = {
126+
{Py_mod_exec, blake2_exec},
127+
{0, NULL}
128+
};
129+
130+
static struct PyModuleDef blake2_module = {
131+
PyModuleDef_HEAD_INIT,
132+
"_blake2",
133+
.m_doc = blake2mod__doc__,
134+
.m_size = sizeof(Blake2State),
135+
.m_methods = blake2mod_functions,
136+
.m_slots = _blake2_slots,
137+
.m_traverse = _blake2_traverse,
138+
.m_clear = _blake2_clear,
139+
.m_free = _blake2_free,
140+
};
141+
142+
PyMODINIT_FUNC
143+
PyInit__blake2(void)
144+
{
145+
return PyModuleDef_Init(&blake2_module);
146+
}

‎Modules/_blake2/blake2s_impl.c

+17-41
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@
3333
#include "impl/blake2s-ref.c"
3434
#endif
3535

36-
37-
extern PyTypeObject PyBlake2_BLAKE2sType;
36+
extern PyType_Spec blake2s_type_spec;
3837

3938
typedef struct {
4039
PyObject_HEAD
@@ -391,47 +390,24 @@ py_blake2s_dealloc(PyObject *self)
391390
PyThread_free_lock(obj->lock);
392391
obj->lock = NULL;
393392
}
393+
394+
PyTypeObject *type = Py_TYPE(self);
394395
PyObject_Del(self);
396+
Py_DECREF(type);
395397
}
396398

399+
static PyType_Slot blake2s_type_slots[] = {
400+
{Py_tp_dealloc, py_blake2s_dealloc},
401+
{Py_tp_doc, (char *)py_blake2s_new__doc__},
402+
{Py_tp_methods, py_blake2s_methods},
403+
{Py_tp_getset, py_blake2s_getsetters},
404+
{Py_tp_new, py_blake2s_new},
405+
{0,0}
406+
};
397407

398-
PyTypeObject PyBlake2_BLAKE2sType = {
399-
PyVarObject_HEAD_INIT(NULL, 0)
400-
"_blake2.blake2s", /* tp_name */
401-
sizeof(BLAKE2sObject), /* tp_basicsize */
402-
0, /* tp_itemsize */
403-
py_blake2s_dealloc, /* tp_dealloc */
404-
0, /*tp_vectorcall_offset*/
405-
0, /* tp_getattr */
406-
0, /* tp_setattr */
407-
0, /* tp_as_async */
408-
0, /* tp_repr */
409-
0, /* tp_as_number */
410-
0, /* tp_as_sequence */
411-
0, /* tp_as_mapping */
412-
0, /* tp_hash */
413-
0, /* tp_call */
414-
0, /* tp_str */
415-
0, /* tp_getattro */
416-
0, /* tp_setattro */
417-
0, /* tp_as_buffer */
418-
Py_TPFLAGS_DEFAULT, /* tp_flags */
419-
py_blake2s_new__doc__, /* tp_doc */
420-
0, /* tp_traverse */
421-
0, /* tp_clear */
422-
0, /* tp_richcompare */
423-
0, /* tp_weaklistoffset */
424-
0, /* tp_iter */
425-
0, /* tp_iternext */
426-
py_blake2s_methods, /* tp_methods */
427-
0, /* tp_members */
428-
py_blake2s_getsetters, /* tp_getset */
429-
0, /* tp_base */
430-
0, /* tp_dict */
431-
0, /* tp_descr_get */
432-
0, /* tp_descr_set */
433-
0, /* tp_dictoffset */
434-
0, /* tp_init */
435-
0, /* tp_alloc */
436-
py_blake2s_new, /* tp_new */
408+
PyType_Spec blake2s_type_spec = {
409+
.name = "_blake2.blake2s",
410+
.basicsize = sizeof(BLAKE2sObject),
411+
.flags = Py_TPFLAGS_DEFAULT,
412+
.slots = blake2s_type_slots
437413
};

0 commit comments

Comments
 (0)