Skip to content

gh-117398: datetime: Support per-interpreter C-API #117399

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

Closed
wants to merge 7 commits into from
Closed

gh-117398: datetime: Support per-interpreter C-API #117399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a4decc0
capi per interp (module)
neonene Mar 31, 2024
12ae163
silence warning
neonene Mar 31, 2024
2dc9010
use inline specifier
neonene Mar 31, 2024
e3abfce
experiment: switch to stable api
neonene Mar 31, 2024
080bb8a
revert experiment
neonene Mar 31, 2024
2e7a9a2
restore the capsule's mem management
neonene Mar 31, 2024
aede7e7
back to 2dc9010 to keep description
neonene Mar 31, 2024
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
12 changes: 9 additions & 3 deletions Include/datetime.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,8 @@ typedef struct {

} PyDateTime_CAPI;

PyAPI_FUNC(PyDateTime_CAPI *) get_datetime_capi(void);

#define PyDateTime_CAPSULE_NAME "datetime.datetime_CAPI"


Expand All @@ -194,10 +196,14 @@ typedef struct {
* */
#ifndef _PY_DATETIME_IMPL
/* Define global variable for the C API and a macro for setting it. */
static PyDateTime_CAPI *PyDateTimeAPI = NULL;
#define PyDateTimeAPI get_datetime_capi()

#define PyDateTime_IMPORT \
PyDateTimeAPI = (PyDateTime_CAPI *)PyCapsule_Import(PyDateTime_CAPSULE_NAME, 0)
static inline void pydatetime_import(void) {
PyDateTime_CAPI *capi = PyCapsule_Import(PyDateTime_CAPSULE_NAME, 0);
(void)capi;
assert(capi == get_datetime_capi());
}
#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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,7 @@ struct _is {
// more comments.
struct _obmalloc_state *obmalloc;

void *datetime_module_state;
PyObject *audit_hooks;
PyType_WatchCallback type_watchers[TYPE_MAX_WATCHERS];
PyCode_WatchCallback code_watchers[CODE_MAX_WATCHERS];
Expand Down
95 changes: 50 additions & 45 deletions Modules/_datetimemodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
#endif

#include "Python.h"
#include "pycore_interp.h"
#include "pycore_long.h" // _PyLong_GetOne()
#include "pycore_object.h" // _PyObject_Init()
#include "pycore_time.h" // _PyTime_ObjectToTime_t()
Expand Down Expand Up @@ -43,6 +44,8 @@
#define PyTimezone_Check(op) PyObject_TypeCheck(op, &PyDateTime_TimeZoneType)

typedef struct {
PyDateTime_CAPI capi;

/* Conversion factors. */
PyObject *us_per_ms; // 1_000
PyObject *us_per_second; // 1_000_000
Expand All @@ -61,7 +64,29 @@ typedef struct {

static datetime_state _datetime_global_state;

#define STATIC_STATE() (&_datetime_global_state)
static inline datetime_state *
get_module_state(PyObject *module)
{
return &_datetime_global_state;
}

static inline datetime_state *
get_module_state_by_interp(void)
{
PyInterpreterState *interp = _PyInterpreterState_GET();
void *state = interp->datetime_module_state;
assert(state != NULL);
return (datetime_state *)state;
}

PyDateTime_CAPI *
get_datetime_capi(void)
{
return &get_module_state_by_interp()->capi;
}

#define STATIC_STATE() get_module_state_by_interp()


/* 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
Expand Down Expand Up @@ -6701,44 +6726,27 @@ static PyMethodDef module_methods[] = {
{NULL, NULL}
};

/* Get a new C API by calling this function.
* Clients get at C API via PyDateTime_IMPORT, defined in datetime.h.
*/
static inline PyDateTime_CAPI *
get_datetime_capi(void)
{
PyDateTime_CAPI *capi = PyMem_Malloc(sizeof(PyDateTime_CAPI));
if (capi == NULL) {
PyErr_NoMemory();
return NULL;
}
capi->DateType = &PyDateTime_DateType;
capi->DateTimeType = &PyDateTime_DateTimeType;
capi->TimeType = &PyDateTime_TimeType;
capi->DeltaType = &PyDateTime_DeltaType;
capi->TZInfoType = &PyDateTime_TZInfoType;
capi->Date_FromDate = new_date_ex;
capi->DateTime_FromDateAndTime = new_datetime_ex;
capi->Time_FromTime = new_time_ex;
capi->Delta_FromDelta = new_delta_ex;
capi->TimeZone_FromTimeZone = new_timezone;
capi->DateTime_FromTimestamp = datetime_fromtimestamp;
capi->Date_FromTimestamp = datetime_date_fromtimestamp_capi;
capi->DateTime_FromDateAndTimeAndFold = new_datetime_ex2;
capi->Time_FromTimeAndFold = new_time_ex2;
static inline void
set_datetime_capi(datetime_state *st)
{
st->capi.DateType = &PyDateTime_DateType;
st->capi.DateTimeType = &PyDateTime_DateTimeType;
st->capi.TimeType = &PyDateTime_TimeType;
st->capi.DeltaType = &PyDateTime_DeltaType;
st->capi.TZInfoType = &PyDateTime_TZInfoType;
st->capi.Date_FromDate = new_date_ex;
st->capi.DateTime_FromDateAndTime = new_datetime_ex;
st->capi.Time_FromTime = new_time_ex;
st->capi.Delta_FromDelta = new_delta_ex;
st->capi.TimeZone_FromTimeZone = new_timezone;
st->capi.DateTime_FromTimestamp = datetime_fromtimestamp;
st->capi.Date_FromTimestamp = datetime_date_fromtimestamp_capi;
st->capi.DateTime_FromDateAndTimeAndFold = new_datetime_ex2;
st->capi.Time_FromTimeAndFold = new_time_ex2;
// Make sure this function is called after utc has
// been initialized.
datetime_state *st = STATIC_STATE();
assert(st->utc != NULL);
capi->TimeZone_UTC = st->utc; // borrowed ref
return capi;
}

static void
datetime_destructor(PyObject *op)
{
void *ptr = PyCapsule_GetPointer(op, PyDateTime_CAPSULE_NAME);
PyMem_Free(ptr);
st->capi.TimeZone_UTC = st->utc; // borrowed ref
}

static int
Expand Down Expand Up @@ -6823,6 +6831,10 @@ init_state(datetime_state *st)
static int
_datetime_exec(PyObject *module)
{
datetime_state *st = get_module_state(module);
PyInterpreterState *interp = _PyInterpreterState_GET();
interp->datetime_module_state = st;

// `&...` is not a constant expression according to a strict reading
// of C standards. Fill tp_base at run-time rather than statically.
// See https://bugs.python.org/issue40777
Expand Down Expand Up @@ -6889,7 +6901,6 @@ _datetime_exec(PyObject *module)
999999, Py_None, 0));
DATETIME_ADD_MACRO(d, "resolution", new_delta(0, 0, 1, 0));

datetime_state *st = STATIC_STATE();
if (init_state(st) < 0) {
goto error;
}
Expand Down Expand Up @@ -6924,18 +6935,12 @@ _datetime_exec(PyObject *module)
}

/* At last, set up and add the encapsulated C API */
PyDateTime_CAPI *capi = get_datetime_capi();
if (capi == NULL) {
goto error;
}
PyObject *capsule = PyCapsule_New(capi, PyDateTime_CAPSULE_NAME,
datetime_destructor);
set_datetime_capi(st);
PyObject *capsule = PyCapsule_New(&st->capi, PyDateTime_CAPSULE_NAME, NULL);
Copy link
Member

@Eclips4 Eclips4 Mar 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Can you explain why do you pass a NULL as a capsule destructor?
Is there any reason not to have destructor for this capsule?

Copy link
Contributor Author

@neonene neonene Mar 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

In this case, the capsule just views a memory allocated and freed by the moduleobject.

cpython/Objects/moduleobject.c

Lines 739 to 740 in bfc57d4

if (m->md_state != NULL)
PyMem_Free(m->md_state);

if (capsule == NULL) {
PyMem_Free(capi);
goto error;
}
if (PyModule_Add(module, "datetime_CAPI", capsule) < 0) {
PyMem_Free(capi);
goto error;
}

Expand Down
14 changes: 0 additions & 14 deletions Modules/_testcapi/datetime.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,9 @@
#include "datetime.h" // PyDateTimeAPI


static int test_run_counter = 0;

static PyObject *
test_datetime_capi(PyObject *self, PyObject *args)
{
if (PyDateTimeAPI) {
if (test_run_counter) {
/* Probably regrtest.py -R */
Py_RETURN_NONE;
}
else {
PyErr_SetString(PyExc_AssertionError,
"PyDateTime_CAPI somehow initialized");
return NULL;
}
}
test_run_counter++;
PyDateTime_IMPORT;

if (PyDateTimeAPI) {
Expand Down
Loading