Fix reporting of "Own Memory" in TUI reporters

The `live` and `summary` reporters include a column for the number of bytes directly allocated by a particular function (called "Own Bytes" or "Own Memory", with a corresponding column for the percentage of memory directly allocated by that function). A bug in our summation led to us undercounting and misreporting these columns. Signed-off-by: Matt Wozniski <[email protected]>
bloomberg · May 29, 2024 · 667983c · 667983c
1 parent 0e3673d
commit 667983c
Show file tree

Hide file tree

Showing 4 changed files with 299 additions and 304 deletions.
diff --git a/news/617.bugfix.rst b/news/617.bugfix.rst
@@ -0,0 +1 @@
+Fix reporting of "Own Memory" in the ``live`` and ``summary`` reporters. A bug in our summation caused us to undercount functions' direct allocations.
diff --git a/src/memray/reporters/tui.py b/src/memray/reporters/tui.py
@@ -227,23 +227,17 @@ def aggregate_allocations(
             frame.n_allocations += allocation.n_allocations
             frame.thread_ids.add(allocation.tid)
             continue
-        (function, file_name, _), *caller_frames = stack_trace
-        location = Location(function=function, file=file_name)
-        processed_allocations[location] = AllocationEntry(
-            own_memory=allocation.size,
-            total_memory=allocation.size,
-            n_allocations=allocation.n_allocations,
-            thread_ids={allocation.tid},
-        )
 
         # Walk upwards and sum totals
-        visited = {location}
-        for function, file_name, _ in caller_frames:
+        visited = set()
+        for i, (function, file_name, _) in enumerate(stack_trace):
             location = Location(function=function, file=file_name)
             frame = processed_allocations[location]
             if location in visited:
                 continue
             visited.add(location)
+            if i == 0:
+                frame.own_memory += allocation.size
             frame.total_memory += allocation.size
             frame.n_allocations += allocation.n_allocations
             frame.thread_ids.add(allocation.tid)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Fix reporting of "Own Memory" in the ``live`` and ``summary`` reporters. A bug in our summation caused us to undercount functions' direct allocations.