Skip to content

bpo-1635741: Port _struct to multiphase initialization #23398

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
corona10 merged 2 commits into from
Nov 19, 2020
Merged

bpo-1635741: Port _struct to multiphase initialization #23398

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
324e9ee
bpo-1635741: Prepare _struct for multiphase initialization
tiran Nov 19, 2020
a151e8c
Move struct cache to module state, enable multiphase
tiran Nov 19, 2020
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
Move struct cache to module state, enable multiphase 
Signed-off-by: Christian Heimes <christian@python.org>
  • Loading branch information
@tiran
tiran committed Nov 19, 2020
commit a151e8c52f07e22a7ca53829d0d5f389c6cddab3
2 changes: 1 addition & 1 deletion Misc/NEWS.d/next/C API/2020-11-19-12-06-43.bpo-1635741.KEfZpn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Prepare _struct extension module for multiphase initialization
Port _struct extension module to multiphase initialization (:pep:`489`)
80 changes: 41 additions & 39 deletions Modules/_struct.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ class Struct "PyStructObject *" "&PyStructType"
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=9b032058a83ed7c3]*/

typedef struct {
PyObject *cache;
PyObject *PyStructType;
PyObject *unpackiter_type;
PyObject *StructError;
Expand All @@ -30,7 +31,6 @@ get_struct_state(PyObject *module)

static struct PyModuleDef _structmodule;

#define _structmodulestate_global get_struct_state(PyState_FindModule(&_structmodule))
#define get_struct_state_structinst(self) \
(get_struct_state(_PyType_GetModuleByDef(Py_TYPE(self), &_structmodule)))
#define get_struct_state_iterinst(self) \
Expand Down Expand Up @@ -103,12 +103,20 @@ class cache_struct_converter(CConverter):
converter = 'cache_struct_converter'
c_default = "NULL"

def parse_arg(self, argname, displayname):
return """
if (!{converter}(module, {argname}, &{paramname})) {{{{
goto exit;
}}}}
""".format(argname=argname, paramname=self.name,
converter=self.converter)

def cleanup(self):
return "Py_XDECREF(%s);\n" % self.name
[python start generated code]*/
/*[python end generated code: output=da39a3ee5e6b4b0d input=49957cca130ffb63]*/
/*[python end generated code: output=da39a3ee5e6b4b0d input=d6746621c2fb1a7d]*/

static int cache_struct_converter(PyObject *, PyStructObject **);
static int cache_struct_converter(PyObject *, PyObject *, PyStructObject **);

#include "clinic/_struct.c.h"

Expand Down Expand Up @@ -2093,27 +2101,26 @@ static PyType_Spec PyStructType_spec = {
/* ---- Standalone functions ---- */

#define MAXCACHE 100
static PyObject *cache = NULL;

static int
cache_struct_converter(PyObject *fmt, PyStructObject **ptr)
cache_struct_converter(PyObject *module, PyObject *fmt, PyStructObject **ptr)
{
PyObject * s_object;
_structmodulestate *state = _structmodulestate_global;
_structmodulestate *state = get_struct_state(module);

if (fmt == NULL) {
Py_DECREF(*ptr);
*ptr = NULL;
return 1;
}

if (cache == NULL) {
cache = PyDict_New();
if (cache == NULL)
if (state->cache == NULL) {
state->cache = PyDict_New();
if (state->cache == NULL)
return 0;
}

s_object = PyDict_GetItemWithError(cache, fmt);
s_object = PyDict_GetItemWithError(state->cache, fmt);
if (s_object != NULL) {
Py_INCREF(s_object);
*ptr = (PyStructObject *)s_object;
Expand All @@ -2125,10 +2132,10 @@ cache_struct_converter(PyObject *fmt, PyStructObject **ptr)

s_object = PyObject_CallOneArg(state->PyStructType, fmt);
if (s_object != NULL) {
if (PyDict_GET_SIZE(cache) >= MAXCACHE)
PyDict_Clear(cache);
if (PyDict_GET_SIZE(state->cache) >= MAXCACHE)
PyDict_Clear(state->cache);
/* Attempt to cache the result */
if (PyDict_SetItem(cache, fmt, s_object) == -1)
if (PyDict_SetItem(state->cache, fmt, s_object) == -1)
PyErr_Clear();
*ptr = (PyStructObject *)s_object;
return Py_CLEANUP_SUPPORTED;
Expand All @@ -2146,7 +2153,7 @@ static PyObject *
_clearcache_impl(PyObject *module)
/*[clinic end generated code: output=ce4fb8a7bf7cb523 input=463eaae04bab3211]*/
{
Py_CLEAR(cache);
Py_CLEAR(get_struct_state(module)->cache);
Py_RETURN_NONE;
}

Expand Down Expand Up @@ -2174,7 +2181,7 @@ Return a bytes object containing the values v1, v2, ... packed according\n\
to the format string. See help(struct) for more on format strings.");

static PyObject *
pack(PyObject *self, PyObject *const *args, Py_ssize_t nargs)
pack(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
{
PyObject *s_object = NULL;
PyObject *format, *result;
Expand All @@ -2185,7 +2192,7 @@ pack(PyObject *self, PyObject *const *args, Py_ssize_t nargs)
}
format = args[0];

if (!cache_struct_converter(format, (PyStructObject **)&s_object)) {
if (!cache_struct_converter(module, format, (PyStructObject **)&s_object)) {
return NULL;
}
result = s_pack(s_object, args + 1, nargs - 1);
Expand All @@ -2202,7 +2209,7 @@ that the offset is a required argument. See help(struct) for more\n\
on format strings.");

static PyObject *
pack_into(PyObject *self, PyObject *const *args, Py_ssize_t nargs)
pack_into(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
{
PyObject *s_object = NULL;
PyObject *format, *result;
Expand All @@ -2213,7 +2220,7 @@ pack_into(PyObject *self, PyObject *const *args, Py_ssize_t nargs)
}
format = args[0];

if (!cache_struct_converter(format, (PyStructObject **)&s_object)) {
if (!cache_struct_converter(module, format, (PyStructObject **)&s_object)) {
return NULL;
}
result = s_pack_into(s_object, args + 1, nargs - 1);
Expand Down Expand Up @@ -2338,6 +2345,7 @@ _structmodule_traverse(PyObject *module, visitproc visit, void *arg)
{
_structmodulestate *state = get_struct_state(module);
if (state) {
Py_VISIT(state->cache);
Py_VISIT(state->PyStructType);
Py_VISIT(state->unpackiter_type);
Py_VISIT(state->StructError);
Expand All @@ -2350,6 +2358,7 @@ _structmodule_clear(PyObject *module)
{
_structmodulestate *state = get_struct_state(module);
if (state) {
Py_CLEAR(state->cache);
Py_CLEAR(state->PyStructType);
Py_CLEAR(state->unpackiter_type);
Py_CLEAR(state->StructError);
Expand Down Expand Up @@ -2435,34 +2444,27 @@ _structmodule_exec(PyObject *m)
}

return 0;

}

static PyModuleDef_Slot _structmodule_slots[] = {
{Py_mod_exec, _structmodule_exec},
{0, NULL}
};

static struct PyModuleDef _structmodule = {
PyModuleDef_HEAD_INIT,
"_struct",
module_doc,
sizeof(_structmodulestate),
module_functions,
NULL,
_structmodule_traverse,
_structmodule_clear,
_structmodule_free,
.m_name = "_struct",
.m_doc = module_doc,
.m_size = sizeof(_structmodulestate),
.m_methods = module_functions,
.m_slots = _structmodule_slots,
.m_traverse = _structmodule_traverse,
.m_clear = _structmodule_clear,
.m_free = _structmodule_free,
};

PyMODINIT_FUNC
PyInit__struct(void)
{
PyObject *m;

m = PyModule_Create(&_structmodule);
if (m == NULL)
return NULL;

if (_structmodule_exec(m) < 0) {
Py_DECREF(m);
return NULL;
}
return m;

return PyModuleDef_Init(&_structmodule);
}
10 changes: 5 additions & 5 deletions Modules/clinic/_struct.c.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.