/
ObjectUnboundGrowthAnalysis.ts
224 lines (201 loc) · 6.09 KB
/
ObjectUnboundGrowthAnalysis.ts
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @oncall web_perf_infra
*/
import type {
BaseOption,
IHeapNode,
IHeapSnapshot,
IMemoryAnalystOptions,
} from '@memlab/core';
import type {AnalyzeSnapshotResult, HeapAnalysisOptions} from '../PluginUtils';
import fs from 'fs';
import {
config,
info,
memoryBarChart,
serializer,
utils,
TraceFinder,
} from '@memlab/core';
import BaseAnalysis from '../BaseAnalysis';
import SnapshotDirectoryOption from '../options/HeapAnalysisSnapshotDirectoryOption';
import pluginUtils from '../PluginUtils';
class ObjectUnboundGrowthAnalysis extends BaseAnalysis {
getCommandName(): string {
return 'unbound-object';
}
/** @internal */
getDescription(): string {
return (
'Check unbound object growth ' +
'(a single object with growing retained size)'
);
}
/** @internal */
getOptions(): BaseOption[] {
return [new SnapshotDirectoryOption()];
}
/** @internal */
public async analyzeSnapshotFromFile(
file: string,
): Promise<AnalyzeSnapshotResult> {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const f = file;
throw utils.haltOrThrow(
`${this.constructor.name} does not support analyzeSnapshotFromFile`,
);
}
/** @internal */
async process(options: HeapAnalysisOptions): Promise<void> {
const snapshotDir = pluginUtils.getSnapshotDirForAnalysis(options);
const opt = snapshotDir ? {minSnapshots: 2, snapshotDir} : {};
config.chaseWeakMapEdge = false;
await this.checkUnbound(opt);
}
private async checkUnbound(options: IMemoryAnalystOptions = {}) {
memoryBarChart.plotMemoryBarChart(options);
utils.checkSnapshots(options);
await this.detectUnboundGrowth(options);
}
// find any objects that keeps growing
private async detectUnboundGrowth(options: IMemoryAnalystOptions = {}) {
const nodeInfo = Object.create(null);
let hasCheckedFirstSnapshot = false;
let snapshot: IHeapSnapshot | null = null;
const isValidNode = (node: IHeapNode) =>
node.type === 'object' ||
node.type === 'closure' ||
node.type === 'regexp';
const initNodeInfo = (node: IHeapNode) => {
if (!isValidNode(node)) {
return;
}
const n = node.retainedSize;
nodeInfo[node.id] = {
type: node.type,
name: node.name,
min: n,
max: n,
history: [n],
node,
};
};
const updateNodeInfo = (node: IHeapNode) => {
const item = nodeInfo[node.id];
if (!item) {
return;
}
if (node.name !== item.name || node.type !== item.type) {
nodeInfo[node.id] = null;
return;
}
const n = node.retainedSize;
// only monotonic increase?
if (config.monotonicUnboundGrowthOnly && n < item.max) {
nodeInfo[node.id] = null;
return;
}
item.history.push(n);
item.max = Math.max(item.max, n);
item.min = Math.min(item.min, n);
};
// summarize the heap objects info in current heap snapshot
// this is mainly used for better understanding of the % of
// objects released and allocated over time
const maybeSummarizeNodeInfo = () => {
if (!config.verbose) {
return;
}
let n = 0;
for (const k in nodeInfo) {
if (nodeInfo[k]) {
++n;
}
}
info.lowLevel(`Objects tracked: ${n}`);
};
info.overwrite('Checking unbounded objects...');
const snapshotFiles = options.snapshotDir
? // load snapshots from a directory
utils.getSnapshotFilesInDir(options.snapshotDir)
: // load snapshots based on the visit sequence meta data
utils.getSnapshotFilesFromTabsOrder();
for (const file of snapshotFiles) {
// force GC before loading each snapshot
if (global.gc) {
global.gc();
}
// load and preprocess heap snapshot
const opt = {buildNodeIdIndex: true, verbose: true};
snapshot = await utils.getSnapshotFromFile(file, opt);
this.calculateRetainedSizes(snapshot);
// keep track of heap objects
if (!hasCheckedFirstSnapshot) {
// record Ids in the snapshot
snapshot.nodes.forEach(initNodeInfo);
hasCheckedFirstSnapshot = true;
} else {
snapshot.nodes.forEach(updateNodeInfo);
maybeSummarizeNodeInfo();
}
}
// exit if no heap snapshot found
if (!hasCheckedFirstSnapshot) {
return;
}
// post process and print the unbounded objects
const idsInLastSnapshot = new Set();
snapshot?.nodes.forEach(node => {
idsInLastSnapshot.add(node.id);
});
let ids = [];
for (const key in nodeInfo) {
const id = parseInt(key, 10);
const item = nodeInfo[id];
if (!item) {
continue;
}
if (!idsInLastSnapshot.has(id)) {
continue;
}
if (item.min === item.max) {
continue;
}
// filter out non-significant leaks
if (item.history[item.history.length - 1] < config.unboundSizeThreshold) {
continue;
}
ids.push({id, ...item});
}
if (ids.length === 0) {
info.midLevel('No increasing objects found.');
return;
}
ids = ids
.sort(
(o1, o2) =>
o2.history[o2.history.length - 1] - o1.history[o1.history.length - 1],
)
.slice(0, 20);
// print on terminal
const str = serializer.summarizeUnboundedObjects(ids, {color: true});
info.topLevel('Top growing objects in sizes:');
info.lowLevel(' (Use `memlab trace --node-id=@ID` to get trace)');
info.topLevel('\n' + str);
// save results to file
const csv = serializer.summarizeUnboundedObjectsToCSV(ids);
fs.writeFileSync(config.unboundObjectCSV, csv, 'UTF-8');
}
private calculateRetainedSizes(snapshot: IHeapSnapshot): void {
const finder = new TraceFinder();
// dominator and retained size
finder.calculateAllNodesRetainedSizes(snapshot);
}
}
export default ObjectUnboundGrowthAnalysis;