Skip to content
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.

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

gh-117398: datetime: Access C-API via PyInterpreterState #118357

Closed
wants to merge 24 commits into from
Closed
Show file tree
Hide file tree
Changes from 8 commits
Commits
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
26 changes: 22 additions & 4 deletions Include/datetime.h
Original file line number Diff line number Diff line change
Expand Up @@ -187,17 +187,35 @@ typedef struct {

#define PyDateTime_CAPSULE_NAME "datetime.datetime_CAPI"

/* Internal use */
typedef struct {
PyDateTime_CAPI api;
PyDateTime_CAPI *(*_get_capi_by_interp)(void);
void (*_set_capi_by_interp)(PyDateTime_CAPI *);
} _pydatetime_capi;

/* This block is only used as part of the public API and should not be
* included in _datetimemodule.c, which does not use the C API capsule.
* See bpo-35081 for more details.
* */
#ifndef _PY_DATETIME_IMPL
/* Define global variable for the C API and a macro for setting it. */
static PyDateTime_CAPI *PyDateTimeAPI = NULL;

#define PyDateTime_IMPORT \
PyDateTimeAPI = (PyDateTime_CAPI *)PyCapsule_Import(PyDateTime_CAPSULE_NAME, 0)
static PyDateTime_CAPI *
_get_pydatetime_capi_dummy(void)
{
return NULL;
}
static PyDateTime_CAPI *(*_get_pydatetime_capi)(void) = _get_pydatetime_capi_dummy;
#define PyDateTimeAPI _get_pydatetime_capi()

static inline void pydatetime_import(void) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer to not leak such implementation detail at the ABI level, and so use a regular function rather than a static inline function. I would prefer that _pydatetime_capi is private.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How can I resolve non-Windows errors? I'm not sure how to use private struct members here.

Error:  _testcapi failed to import: /home/runner/work/cpython/cpython-builddir/
build/lib.linux-x86_64-3.13-pydebug/_testcapi.cpython-313d-x86_64-linux-gnu.so:
undefined symbol: _PyDateTimeAPI_Get

_pydatetime_capi *capi = PyCapsule_Import(PyDateTime_CAPSULE_NAME, 0);
if (capi) {
capi->_set_capi_by_interp((PyDateTime_CAPI *)capi);
_get_pydatetime_capi = capi->_get_capi_by_interp;
}
}
#define PyDateTime_IMPORT pydatetime_import()

/* Macro for access to the UTC singleton */
#define PyDateTime_TimeZone_UTC PyDateTimeAPI->TimeZone_UTC
Expand Down
1 change: 1 addition & 0 deletions Include/internal/pycore_interp.h
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@ struct _is {
// more comments.
struct _obmalloc_state *obmalloc;

void *datetime_capi;
PyObject *audit_hooks;
PyType_WatchCallback type_watchers[TYPE_MAX_WATCHERS];
PyCode_WatchCallback code_watchers[CODE_MAX_WATCHERS];
Expand Down
16 changes: 16 additions & 0 deletions Lib/test/test_capi/test_misc.py
Original file line number Diff line number Diff line change
Expand Up @@ -2282,6 +2282,22 @@ def test_module_state_shared_in_global(self):
subinterp_attr_id = os.read(r, 100)
self.assertEqual(main_attr_id, subinterp_attr_id)

@unittest.skipIf(_testmultiphase is None, "test requires _testmultiphase module")
def test_datetime_capi_client(self):
script = textwrap.dedent("""
import importlib.machinery
import importlib.util
fullname = '_test_datetime_capi_client'
origin = importlib.util.find_spec('_testmultiphase').origin
loader = importlib.machinery.ExtensionFileLoader(fullname, origin)
spec = importlib.util.spec_from_loader(fullname, loader)
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
""")
exec(script)
ret = support.run_in_subinterp(script)
self.assertEqual(ret, 0)


@requires_subinterpreters
class InterpreterConfigTests(unittest.TestCase):
Expand Down
18 changes: 17 additions & 1 deletion Modules/_datetimemodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,18 @@ static datetime_state _datetime_global_state;

#define STATIC_STATE() (&_datetime_global_state)

void
set_datetime_capi_by_interp(PyDateTime_CAPI *capi)
{
_PyInterpreterState_GET()->datetime_capi = capi;
}

PyDateTime_CAPI *
get_datetime_capi_by_interp(void)
{
return (PyDateTime_CAPI *)_PyInterpreterState_GET()->datetime_capi;
}

/* We require that C int be at least 32 bits, and use int virtually
* everywhere. In just a few cases we use a temp long, where a Python
* API returns a C long. In such cases, we have to ensure that the
Expand Down Expand Up @@ -6712,7 +6724,7 @@ static PyMethodDef module_methods[] = {
static inline PyDateTime_CAPI *
get_datetime_capi(void)
{
PyDateTime_CAPI *capi = PyMem_Malloc(sizeof(PyDateTime_CAPI));
PyDateTime_CAPI *capi = PyMem_Malloc(sizeof(_pydatetime_capi));
if (capi == NULL) {
PyErr_NoMemory();
return NULL;
Expand All @@ -6736,14 +6748,18 @@ get_datetime_capi(void)
datetime_state *st = STATIC_STATE();
assert(st->utc != NULL);
capi->TimeZone_UTC = st->utc; // borrowed ref
((_pydatetime_capi *)capi)->_set_capi_by_interp = set_datetime_capi_by_interp;
((_pydatetime_capi *)capi)->_get_capi_by_interp = get_datetime_capi_by_interp;
return capi;
}

static void
datetime_destructor(PyObject *op)
{
void *ptr = PyCapsule_GetPointer(op, PyDateTime_CAPSULE_NAME);
assert(!get_datetime_capi_by_interp() || ptr == get_datetime_capi_by_interp());
PyMem_Free(ptr);
set_datetime_capi_by_interp(NULL);
}

static int
Expand Down
34 changes: 34 additions & 0 deletions Modules/_testmultiphase.c
Original file line number Diff line number Diff line change
Expand Up @@ -952,3 +952,37 @@ PyInit__test_shared_gil_only(void)
{
return PyModuleDef_Init(&shared_gil_only_def);
}


#include "datetime.h"

static int
datetime_capi_client_exec(PyObject *m)
{
_get_pydatetime_capi = _get_pydatetime_capi_dummy;
if (PyDateTimeAPI != NULL) {
neonene marked this conversation as resolved.
Show resolved Hide resolved
neonene marked this conversation as resolved.
Show resolved Hide resolved
return -1;
}
PyDateTime_IMPORT;
neonene marked this conversation as resolved.
Show resolved Hide resolved
PyErr_Clear();
neonene marked this conversation as resolved.
Show resolved Hide resolved
if (PyDateTimeAPI != PyCapsule_Import(PyDateTime_CAPSULE_NAME, 0)) {
return -1;
}
PyErr_Clear();
return 0;
}

static PyModuleDef_Slot datetime_capi_client_slots[] = {
{Py_mod_exec, datetime_capi_client_exec},
{Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED},
{0, NULL},
};

static PyModuleDef datetime_capi_client_def = TEST_MODULE_DEF(
"_testmultiphase_datetime_capi_client", datetime_capi_client_slots, NULL);

PyMODINIT_FUNC
PyInit__test_datetime_capi_client(void)
{
return PyModuleDef_Init(&datetime_capi_client_def);
}
2 changes: 1 addition & 1 deletion Tools/c-analyzer/cpython/globals-to-fix.tsv
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ Modules/_tkinter.c - trbInCmd -
## initialized once

## other
Include/datetime.h - PyDateTimeAPI -
Include/datetime.h - _get_pydatetime_capi -
Modules/_ctypes/cfield.c _ctypes_get_fielddesc initialized -
Modules/_ctypes/malloc_closure.c - _pagesize -
Modules/_cursesmodule.c - initialised -
Expand Down
Loading