summaryrefslogtreecommitdiffstats
path: root/docs/performance/memory/aggregate_view.md
blob: 9a4f01e01e2b71ef1a85640bd1dfa460a2f6ae28 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# Aggregate view

Before Firefox 48, this was the default view of a heap snapshot. After
Firefox 48, the default view is the [Tree map
view](tree_map_view.md), and you can switch to the
Aggregate view using the dropdown labeled \"View:\":

![](../img/memory-tool-switch-view.png)

The Aggregate view looks something like this:

![](../img/memory-tool-aggregate-view.png)

It presents a breakdown of the heap\'s contents, as a table. There are
three main ways to group the data:

-   Type
-   Call Stack
-   Inverted Call Stack

You can switch between them using the dropdown menu labeled \"Group
by:\" located at the top of the panel:

There\'s also a box labeled \"Filter\" at the top-right of the pane. You
can use this to filter the contents of the snapshot that are displayed,
so you can quickly see, for example, how many objects of a specific
class were allocated.

## Type

This is the default view, which looks something like this:

![](../img/memory-tool-aggregate-view.png)

It groups the things on the heap into types, including:

-   **JavaScript objects:** such as `Function` or `Array`
-   **DOM elements:** such as `HTMLSpanElement` or `Window`
-   **Strings:** listed as `"strings"`
-   **JavaScript sources:** listed as \"`JSScript"`
-   **Internal objects:** such as \"`js::Shape`\". These are prefixed
    with `"js::"`.

Each type gets a row in the table, and rows are ordered by the amount of
memory occupied by objects of that type. For example, in the screenshot
above you can see that JavaScript `Object`s account for most memory,
followed by strings.

-   The \"Total Count\" column shows you the number of objects of each
    category that are currently allocated.
-   The \"Total Bytes\" column shows you the number of bytes occupied by
    objects in each category, and that number as a percentage of the
    whole heap size for that tab.

The screenshots in this section are taken from a snapshot of the
[monster example page](monster_example.md).

For example, in the screenshot above, you can see that:

-   there are four `Array` objects
-   that account for 15% of the total heap.

Next to the type\'s name, there\'s an icon that contains three stars
arranged in a triangle:

![](../img/memory-tool-in-group-icon.png)

Click this to see every instance of that type. For example, the entry
for `Array` tells us that there are four `Array` objects in the
snapshot. If we click the star-triangle, we\'ll see all four `Array`
instances:

![](../img/memory-tool-in-group.png)

For each instance, you can see the [retained size and shallow
size](dominators.md#shallow_and_retained_size) of
that instance. In this case, you can see that the first three arrays
have a fairly large shallow size (5% of the total heap usage) and a much
larger retained size (26% of the total).

On the right-hand side is a pane that just says \"Select an item to view
its retaining paths\". If you select an item, you\'ll see the [Retaining
paths
panel](dominators_view.md#retaining_paths_panel)
for that item:

![](../img/memory-tool-in-group-retaining-paths.png)

<iframe width="595" height="325" src="https://www.youtube.com/embed/uLjzrvx_VCg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"></iframe>


## Call Stack

The Call Stack shows you exactly where in your code you are making heap
allocations.

Because tracing allocations has a runtime cost, it must be explicitly
enabled by checking \"Record call stacks\" *before* you allocate the
memory in the snapshot.

You\'ll then see a list of all the functions that allocated objects,
ordered by the size of the allocations they made:

![](../img/memory-tool-call-stack.png)
\
The first entry says that:

-   4,832,592 bytes, comprising 93% of the total heap usage, were
    allocated in a function at line 35 of \"alloc.js\", **or in
    functions called by that function**

We can use the disclosure triangle to drill down the call tree, to find
the exact place your code made those allocations.

It\'s easier to explain this with reference to a simple example. For
this we\'ll use the [DOM allocation
example](DOM_allocation_example.md). This page
runs a script that creates a large number of DOM nodes (200
`HTMLDivElement` objects and 4000 `HTMLSpanElement` objects).

Let\'s get an allocation trace:

1.  open the Memory tool
2.  check \"Record call stacks\"
3.  load
    <https://mdn.github.io/performance-scenarios/dom-allocs/alloc.html>
4.  take a snapshot
5.  select \"View/Aggregate\"
6.  select \"Group by/Call Stack\"

<iframe width="595" height="325" src="https://www.youtube.com/embed/DyLulu9eoKY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"></iframe>

You should see something like this:

![](../img/memory-tool-call-stack.png)

This is telling us that 93% of the total heap snapshot was allocated in
functions called from \"alloc.js\", line 35 (our initial
`createToolbars()` call).

We can use the disclosure arrow to expand the tree to find out exactly
where we\'re allocating memory:

![](../img/memory-tool-call-stack-expanded.png)

This is where the \"Bytes\" and \"Count\" columns are useful: they show
allocation size and number of allocations at that exact point.

So in the example above, we can see that we made 4002 allocations,
accounting for 89% of the total heap, in `createToolbarButton()`, at
[alloc.js line 9, position
23](https://github.com/mdn/performance-scenarios/blob/gh-pages/dom-allocs/scripts/alloc.js#L9):
that is, the exact point where we create the span
elements.

The file name and line number is a link: if we click it, we go directly
to that line in the debugger:

<iframe width="595" height="325" src="https://www.youtube.com/embed/zlnJcr1IFyY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"></iframe>


## Inverted Call Stack

The Call Stack view is top-down: it shows allocations that happen at
that point **or points deeper in the call tree**. So it\'s good for
getting an overview of where your program is memory-hungry. However,
this view means you have to drill a long way down to find the exact
place where the allocations are happening.

The \"Inverted Call Stack\" view helps with that. It gives you the
bottom-up view of the program showing the exact places where allocations
are happening, ranked by the size of allocation at each place. The
disclosure arrow then walks you back up the call tree towards the top
level.

Let\'s see what the example looks like when we select \"Inverted Call
Stack\":

![](../img/memory-tool-inverted-call-stack.png)

Now at the top we can immediately see the `createToolbarButton()` call
accounting for 89% of the heap usage in our page.

## no stack available

In the example above you\'ll note that 7% of the heap is marked \"(no
stack available)\". This is because not all heap usage results from your
JavaScript.

For example:

-   any scripts the page loads occupy heap space
-   sometimes an object is allocated when there is no JavaScript on the
    stack. For example, DOM Event objects are allocated
    before the JavaScript is run and event handlers are called.

Many real-world pages will have a much higher \"(no stack available)\"
share than 7%.