Add get_gc_stats to RemoteUnwinder

Author: sergey-miryanov

Modules/_remote_debugging/clinic/module.c.h

@@ -16,7 +16,7 @@ extern "C" {
 typedef struct {
     PyObject *result;
     bool all_interpreters;
-} ReadGCStatsContext;
+} GetGCStatsContext;
 
 static int
 read_gc_stats(struct gc_stats *stats, int64_t iid, PyObject *result)
@@ -125,7 +125,7 @@ get_gc_stats_from_interpreter_state(RuntimeOffsets *offsets,
                                     int64_t iid,
                                     void *context)
 {
-    ReadGCStatsContext *ctx = (ReadGCStatsContext *)context;
+    GetGCStatsContext *ctx = (GetGCStatsContext *)context;
     if (!ctx->all_interpreters && iid > 0) {
         return 0;
     }

Modules/_remote_debugging/gc_stats.h

@@ -1031,13 +1031,77 @@ _remote_debugging_RemoteUnwinder_resume_threads_impl(RemoteUnwinderObject *self)
 #endif
 }
 
+static PyObject *
+get_gc_stats(RuntimeOffsets *offsets, bool all_interpreters)
+{
+    PyObject *result = PyList_New(0);
+    if (result == NULL) {
+        return NULL;
+    }
+    GetGCStatsContext ctx = {
+        .result = result,
+        .all_interpreters = all_interpreters,
+    };
+    if (0 > iterate_interpreters(offsets, get_gc_stats_from_interpreter_state, &ctx)) {
+        Py_CLEAR(result);
+        return NULL;
+    }
+
+    return result;
+}
+
+/*[clinic input]
+@permit_long_docstring_body
+@critical_section
+_remote_debugging.RemoteUnwinder.get_gc_stats
+
+    all_interpreters: bool = False
+        If True, return GC statistics from all interpreters.
+        If False, return only from main interpreter.
+
+Get garbage collector statistics from external Python process.
+
+Returns a list of dictionaries with GC statistics data.
+
+Returns:
+    List of dicts.
+    dict: A dictionary containing:
+        - gen:
+        - iid:
+        - ts_start:
+        - ts_stop:
+        - heap_size:
+        - collections:
+        - collected:
+        - uncollectable:
+        - candidates:
+        - duration:
+
+Raises:
+    RuntimeError:
+[clinic start generated code]*/
+
+static PyObject *
+_remote_debugging_RemoteUnwinder_get_gc_stats_impl(RemoteUnwinderObject *self,
+                                                   int all_interpreters)
+/*[clinic end generated code: output=ee2f7cb3e4ea7bc1 input=c025864b40478df2]*/
+{
+    RuntimeOffsets offsets = {
+        .handle = self->handle,
+        .runtime_start_address = self->runtime_start_address,
+        .debug_offsets = self->debug_offsets,
+    };
+    return get_gc_stats(&offsets, all_interpreters);
+}
+
 static PyMethodDef RemoteUnwinder_methods[] = {
     _REMOTE_DEBUGGING_REMOTEUNWINDER_GET_STACK_TRACE_METHODDEF
     _REMOTE_DEBUGGING_REMOTEUNWINDER_GET_ALL_AWAITED_BY_METHODDEF
     _REMOTE_DEBUGGING_REMOTEUNWINDER_GET_ASYNC_STACK_TRACE_METHODDEF
     _REMOTE_DEBUGGING_REMOTEUNWINDER_GET_STATS_METHODDEF
     _REMOTE_DEBUGGING_REMOTEUNWINDER_PAUSE_THREADS_METHODDEF
     _REMOTE_DEBUGGING_REMOTEUNWINDER_RESUME_THREADS_METHODDEF
+    _REMOTE_DEBUGGING_REMOTEUNWINDER_GET_GC_STATS_METHODDEF
     {NULL, NULL}
 };
 
@@ -1857,14 +1921,10 @@ Get garbage collector statistics from external Python process.
         - ts_start:
         - ts_stop:
         - heap_size:
-        - work_to_do:
         - collections:
-        - object_visits:
         - collected:
         - uncollectable:
         - candidates:
-        - objects_transitively_reachable:
-        - objects_not_transitively_reachable:
         - duration:
 
 Raises:
@@ -1874,7 +1934,7 @@ Get garbage collector statistics from external Python process.
 static PyObject *
 _remote_debugging_get_gc_stats_impl(PyObject *module, int pid,
                                     int all_interpreters)
-/*[clinic end generated code: output=d9dce5f7add149bb input=8f05aee4d4230428]*/
+/*[clinic end generated code: output=d9dce5f7add149bb input=6a2afe531da4cfda]*/
 {
     RuntimeOffsets offsets;
 
@@ -1905,19 +1965,10 @@ _remote_debugging_get_gc_stats_impl(PyObject *module, int pid,
         goto error;
     }
 
-    result = PyList_New(0);
-    if (result == NULL) {
-        goto error;
+    result = get_gc_stats(&offsets, all_interpreters);
+    if (result != NULL) {
+        goto done;
     }
-    ReadGCStatsContext ctx = {
-        .result = result,
-        .all_interpreters = all_interpreters,
-    };
-    if (0 > iterate_interpreters(&offsets, get_gc_stats_from_interpreter_state, &ctx)) {
-        goto error;
-    }
-
-    goto done;
 
 error:
     Py_CLEAR(result);