Skip to content

GH-140515: Add collection time to gc callbacks #140516

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 1 commit into from
Closed

GH-140515: Add collection time to gc callbacks #140516

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 30 additions & 13 deletions Python/gc.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1838,18 +1838,32 @@ gc_collect_region(PyThreadState *tstate,
*/
static void
do_gc_callback(GCState *gcstate, const char *phase,
int generation, struct gc_collection_stats *stats)
int generation, struct gc_collection_stats *stats,
PyTime_t *t1, PyTime_t *t2)
{
assert(!PyErr_Occurred());

/* The local variable cannot be rebound, check it for sanity */
assert(PyList_CheckExact(gcstate->callbacks));
PyObject *info = NULL;
if (PyList_GET_SIZE(gcstate->callbacks) != 0) {
info = Py_BuildValue("{sisnsn}",
"generation", generation,
"collected", stats->collected,
"uncollectable", stats->uncollectable);
PyTime_t dt = 0;
if (t1 && t2 && *t1 > 0 && *t2 > 0) {
dt = *t2 - *t1;
}
if (dt > 0) {
info = Py_BuildValue("{sisnsnsd}",
"generation", generation,
"collected", stats->collected,
"uncollectable", stats->uncollectable,
"collection_time", PyTime_AsSecondsDouble(dt));
}
else {
info = Py_BuildValue("{sisnsn}",
"generation", generation,
"collected", stats->collected,
"uncollectable", stats->uncollectable);
}
if (info == NULL) {
PyErr_FormatUnraisable("Exception ignored while invoking gc callbacks");
return;
Expand Down Expand Up @@ -1884,12 +1898,13 @@ do_gc_callback(GCState *gcstate, const char *phase,

static void
invoke_gc_callback(GCState *gcstate, const char *phase,
int generation, struct gc_collection_stats *stats)
int generation, struct gc_collection_stats *stats,
PyTime_t *t1, PyTime_t *t2)
{
if (gcstate->callbacks == NULL) {
return;
}
do_gc_callback(gcstate, phase, generation, stats);
do_gc_callback(gcstate, phase, generation, stats, t1, t2);
}

static int
Expand Down Expand Up @@ -2077,17 +2092,18 @@ _PyGC_Collect(PyThreadState *tstate, int generation, _PyGC_Reason reason)

struct gc_collection_stats stats = { 0 };
if (reason != _Py_GC_REASON_SHUTDOWN) {
invoke_gc_callback(gcstate, "start", generation, &stats);
invoke_gc_callback(gcstate, "start", generation, &stats, NULL, NULL);
}
PyTime_t t1;
if (gcstate->debug & _PyGC_DEBUG_STATS) {
PySys_WriteStderr("gc: collecting generation %d...\n", generation);
(void)PyTime_PerfCounterRaw(&t1);
show_stats_each_generations(gcstate);
}
if (PyDTrace_GC_START_ENABLED()) {
PyDTrace_GC_START(generation);
}
PyTime_t t1 = {0};
(void)PyTime_PerfCounterRaw(&t1);

PyObject *exc = _PyErr_GetRaisedException(tstate);
switch(generation) {
case 0:
Expand All @@ -2102,11 +2118,14 @@ _PyGC_Collect(PyThreadState *tstate, int generation, _PyGC_Reason reason)
default:
Py_UNREACHABLE();
}
PyTime_t t2 = {0};
(void)PyTime_PerfCounterRaw(&t2);

if (PyDTrace_GC_DONE_ENABLED()) {
PyDTrace_GC_DONE(stats.uncollectable + stats.collected);
}
if (reason != _Py_GC_REASON_SHUTDOWN) {
invoke_gc_callback(gcstate, "stop", generation, &stats);
invoke_gc_callback(gcstate, "stop", generation, &stats, &t1, &t2);
}
_PyErr_SetRaisedException(tstate, exc);
GC_STAT_ADD(generation, objects_collected, stats.collected);
Expand All @@ -2121,8 +2140,6 @@ _PyGC_Collect(PyThreadState *tstate, int generation, _PyGC_Reason reason)
_Py_atomic_store_int(&gcstate->collecting, 0);

if (gcstate->debug & _PyGC_DEBUG_STATS) {
PyTime_t t2;
(void)PyTime_PerfCounterRaw(&t2);
double d = PyTime_AsSecondsDouble(t2 - t1);
PySys_WriteStderr(
"gc: done, %zd unreachable, %zd uncollectable, %.4fs elapsed\n",
Expand Down
Loading