GH-96612: Skip incomplete frames in tracemalloc traces. (GH-96613)

markshannon · web-flow · commit 95e271b2266b · 2022-09-06T17:37:47.000+01:00
diff --git a/Lib/test/test_tracemalloc.py b/Lib/test/test_tracemalloc.py
@@ -360,6 +360,20 @@ def test_fork(self):
         else:
             support.wait_process(pid, exitcode=0)
 
+    def test_no_incomplete_frames(self):
+        tracemalloc.stop()
+        tracemalloc.start(8)
+
+        def f(x):
+            def g():
+                return x
+            return g
+
+        obj = f(0).__closure__[0]
+        traceback = tracemalloc.get_object_traceback(obj)
+        self.assertIn("test_tracemalloc", traceback[-1].filename)
+        self.assertNotIn("test_tracemalloc", traceback[-2].filename)
+
 
 class TestSnapshot(unittest.TestCase):
     maxDiff = 4000
diff --git a/Misc/NEWS.d/next/Core and Builtins/2022-09-06-14-26-36.gh-issue-96612.P4ZbeY.rst b/Misc/NEWS.d/next/Core and Builtins/2022-09-06-14-26-36.gh-issue-96612.P4ZbeY.rst
@@ -0,0 +1 @@
+Make sure that incomplete frames do not show up in tracemalloc traces.
diff --git a/Modules/_tracemalloc.c b/Modules/_tracemalloc.c
@@ -400,7 +400,13 @@ traceback_get_frames(traceback_t *traceback)
     }
 
     _PyInterpreterFrame *pyframe = tstate->cframe->current_frame;
-    for (; pyframe != NULL;) {
+    for (;;) {
+        while (pyframe && _PyFrame_IsIncomplete(pyframe)) {
+            pyframe = pyframe->previous;
+        }
+        if (pyframe == NULL) {
+            break;
+        }
         if (traceback->nframe < _Py_tracemalloc_config.max_nframe) {
             tracemalloc_get_frame(pyframe, &traceback->frames[traceback->nframe]);
             assert(traceback->frames[traceback->nframe].filename != NULL);
@@ -410,8 +416,7 @@ traceback_get_frames(traceback_t *traceback)
             traceback->total_nframe++;
         }
 
-        _PyInterpreterFrame *back = pyframe->previous;
-        pyframe = back;
+        pyframe = pyframe->previous;
     }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Make sure that incomplete frames do not show up in tracemalloc traces.`
Original file line number	Diff line number	Diff line change
`@@ -400,7 +400,13 @@ traceback_get_frames(traceback_t *traceback)`
`400`	`400`	`}`
`401`	`401`
`402`	`402`	`_PyInterpreterFrame *pyframe = tstate->cframe->current_frame;`
`403`		`- for (; pyframe != NULL;) {`
	`403`	`+ for (;;) {`
	`404`	`+ while (pyframe && _PyFrame_IsIncomplete(pyframe)) {`
	`405`	`+ pyframe = pyframe->previous;`
	`406`	`+ }`
	`407`	`+ if (pyframe == NULL) {`
	`408`	`+ break;`
	`409`	`+ }`
`404`	`410`	`if (traceback->nframe < _Py_tracemalloc_config.max_nframe) {`
`405`	`411`	`tracemalloc_get_frame(pyframe, &traceback->frames[traceback->nframe]);`
`406`	`412`	`assert(traceback->frames[traceback->nframe].filename != NULL);`
`@@ -410,8 +416,7 @@ traceback_get_frames(traceback_t *traceback)`
`410`	`416`	`traceback->total_nframe++;`
`411`	`417`	`}`
`412`	`418`
`413`		`- _PyInterpreterFrame *back = pyframe->previous;`
`414`		`- pyframe = back;`
	`419`	`+ pyframe = pyframe->previous;`
`415`	`420`	`}`
`416`	`421`	`}`
`417`	`422`