summaryrefslogtreecommitdiffstats
path: root/docs/performance/memory/basic_operations.md
blob: 276c38bc2ee87969f4d0352d97fcaeaabedb9fbc (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
# Basic operations

## Opening the Memory tool

Before Firefox 50, the Memory tool is not enabled by default. To enable
it, open the developer tool settings, and check the "Memory" box under
"Default Firefox Developer Tools":

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

From Firefox 50 onwards, the Memory tool is enabled by default.

## Taking a heap snapshot

To take a snapshot of the heap, click the "Take snapshot" button, or
the camera icon on the left:

![memoryimage1](../img/memory-1-small.png)

The snapshot will occupy the large pane on the right-hand side. On the
left, you'll see an entry for the new snapshot, including its
timestamp, size, and controls to save or clear this snapshot:

![memoryimage2](../img/memory-2-small.png)

## Clearing a snapshot

To remove a snapshot, click the "X" icon:

![memoryimage3](../img/memory-3-small.png)

## Saving and loading snapshots

If you close the Memory tool, all unsaved snapshots will be discarded.
To save a snapshot click "Save":

![memoryimage4](../img/memory-4-small.png)

You'll be prompted for a name and location, and the file will be saved
with an `.fxsnapshot` extension.

To load a snapshot from an existing `.fxsnapshot` file, click the import
button, which looks like a rectangle with an arrow rising from it
(before Firefox 49, this button was labeled with the text
"Import\...\"):

![memoryimage5](../img/memory-5-small.png)

You'll be prompted to find a snapshot file on disk.

## Comparing snapshots

Starting in Firefox 45, you can diff two heap snapshots. The diff shows
you where memory was allocated or freed between the two snapshots.

To create a diff, click the button that looks like a Venn diagram next
to the camera icon (before Firefox 47, this looked like a \"+/-\" icon):

![memoryimage6](../img/memory-6-small.png)

You'll be prompted to select the snapshot to use as a baseline, then
the snapshot to compare. The tool then shows you the differences between
the two snapshots:

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


::: {.note}
When you're looking at a comparison, you can't use the Dominators view
or the Tree Map view.
:::

## Recording call stacks

The Memory tool can tell you exactly where in your code you are
allocating memory. However, recording this information has a run-time
cost, so you must ask the tool to record memory calls *before* the
memory is allocated, if you want to see memory call sites in the
snapshot. To do this, check "Record call stacks" (before Firefox 49
this was labeled "Record allocation stacks"):

![memoryimage7](../img/memory-7-small.png)