-
Notifications
You must be signed in to change notification settings - Fork 3
/
LeakHunterQuery.java
1462 lines (1318 loc) · 67.9 KB
/
LeakHunterQuery.java
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*******************************************************************************
* Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* SAP AG - initial API and implementation
* Andrew Johnson - improve progress monitor checking
*******************************************************************************/
package org.eclipse.mat.inspections;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.Stack;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Pattern;
import org.eclipse.mat.SnapshotException;
import org.eclipse.mat.collect.ArrayIntBig;
import org.eclipse.mat.collect.BitField;
import org.eclipse.mat.collect.SetInt;
import org.eclipse.mat.inspections.FindLeaksQuery.AccumulationPoint;
import org.eclipse.mat.inspections.FindLeaksQuery.SuspectRecord;
import org.eclipse.mat.inspections.FindLeaksQuery.SuspectRecordGroupOfObjects;
import org.eclipse.mat.inspections.threads.ThreadInfoQuery;
import org.eclipse.mat.inspections.util.ObjectTreeFactory;
import org.eclipse.mat.internal.Messages;
import org.eclipse.mat.internal.snapshot.inspections.MultiplePath2GCRootsQuery;
import org.eclipse.mat.query.BytesFormat;
import org.eclipse.mat.query.IContextObject;
import org.eclipse.mat.query.IContextObjectSet;
import org.eclipse.mat.query.IQuery;
import org.eclipse.mat.query.IResult;
import org.eclipse.mat.query.IResultTree;
import org.eclipse.mat.query.ISelectionProvider;
import org.eclipse.mat.query.annotations.Argument;
import org.eclipse.mat.query.annotations.Argument.Advice;
import org.eclipse.mat.query.annotations.CommandName;
import org.eclipse.mat.query.annotations.HelpUrl;
import org.eclipse.mat.query.annotations.Icon;
import org.eclipse.mat.query.refined.RefinedResultBuilder;
import org.eclipse.mat.query.refined.RefinedTree;
import org.eclipse.mat.query.results.CompositeResult;
import org.eclipse.mat.query.results.ListResult;
import org.eclipse.mat.query.results.TextResult;
import org.eclipse.mat.report.ITestResult;
import org.eclipse.mat.report.Params;
import org.eclipse.mat.report.QuerySpec;
import org.eclipse.mat.report.SectionSpec;
import org.eclipse.mat.snapshot.ClassHistogramRecord;
import org.eclipse.mat.snapshot.Histogram;
import org.eclipse.mat.snapshot.IMultiplePathsFromGCRootsComputer;
import org.eclipse.mat.snapshot.ISnapshot;
import org.eclipse.mat.snapshot.MultiplePathsFromGCRootsClassRecord;
import org.eclipse.mat.snapshot.MultiplePathsFromGCRootsRecord;
import org.eclipse.mat.snapshot.extension.IThreadInfo;
import org.eclipse.mat.snapshot.extension.ITroubleTicketResolver;
import org.eclipse.mat.snapshot.model.GCRootInfo;
import org.eclipse.mat.snapshot.model.IClass;
import org.eclipse.mat.snapshot.model.IClassLoader;
import org.eclipse.mat.snapshot.model.IObject;
import org.eclipse.mat.snapshot.model.IStackFrame;
import org.eclipse.mat.snapshot.model.IThreadStack;
import org.eclipse.mat.snapshot.query.Icons;
import org.eclipse.mat.snapshot.query.ObjectListResult;
import org.eclipse.mat.snapshot.query.PieFactory;
import org.eclipse.mat.snapshot.query.SnapshotQuery;
import org.eclipse.mat.snapshot.registry.TroubleTicketResolverRegistry;
import org.eclipse.mat.util.HTMLUtils;
import org.eclipse.mat.util.IProgressListener;
import org.eclipse.mat.util.MessageUtil;
import com.ibm.icu.text.NumberFormat;
@CommandName("leakhunter")
@Icon("/META-INF/icons/leak.gif")
@HelpUrl("/org.eclipse.mat.ui.help/tasks/runningleaksuspectreport.html")
public class LeakHunterQuery implements IQuery
{
private final static Set<String> REFERENCE_FIELD_SET = new HashSet<String>(Arrays
.asList(new String[] { "referent" })); //$NON-NLS-1$
static final String SYSTEM_CLASSLOADER = Messages.LeakHunterQuery_SystemClassLoader;
// Use per-instance formatters to avoid thread safety problems
NumberFormat percentFormatter;
{
// Use com.ibm.icu
percentFormatter = NumberFormat.getPercentInstance();
percentFormatter.setMinimumFractionDigits(2);
percentFormatter.setMaximumFractionDigits(2);
}
NumberFormat numberFormatter = NumberFormat.getNumberInstance();
BytesFormat bytesFormatter = BytesFormat.getInstance();
@Argument
public ISnapshot snapshot;
@Argument(isMandatory = false)
public int threshold_percent = 10;
@Argument(isMandatory = false)
public int max_paths = 10000;
@Argument(isMandatory = false, advice = Advice.CLASS_NAME_PATTERN, flag = "skip")
public Pattern skipPattern = Pattern.compile("java.*|com\\.sun\\..*"); //$NON-NLS-1$
private long totalHeap;
private IProgressListener listener;
public IResult execute(IProgressListener listener) throws Exception
{
this.listener = listener;
totalHeap = snapshot.getSnapshotInfo().getUsedHeapSize();
/* call find_leaks */
listener.subTask(Messages.LeakHunterQuery_FindingProblemSuspects);
FindLeaksQuery.SuspectsResultTable findLeaksResult = callFindLeaks(listener);
SuspectRecord[] leakSuspects = findLeaksResult.getData();
SectionSpec result = new SectionSpec(Messages.LeakHunterQuery_LeakHunter);
listener.subTask(Messages.LeakHunterQuery_PreparingResults);
if (leakSuspects.length > 0)
{
PieFactory pie = new PieFactory(snapshot);
for (int num = 0; num < leakSuspects.length; num++)
{
SuspectRecord rec = leakSuspects[num];
pie.addSlice(rec.suspect.getObjectId(), MessageUtil.format(Messages.LeakHunterQuery_ProblemSuspect, (num + 1)), rec.suspect.getUsedHeapSize(),
rec.getSuspectRetained());
}
result.add(new QuerySpec(Messages.LeakHunterQuery_Overview, pie.build()));
HashMap<Integer, List<Integer>> accPoint2ProblemNr = new HashMap<Integer, List<Integer>>();
int problemNum = 0;
for (SuspectRecord rec : leakSuspects)
{
problemNum++;
AccumulationPoint ap = rec.getAccumulationPoint();
if (ap != null)
{
List<Integer> numbers = accPoint2ProblemNr.get(ap.getObject().getObjectId());
if (numbers == null)
{
numbers = new ArrayList<Integer>(2);
accPoint2ProblemNr.put(ap.getObject().getObjectId(), numbers);
}
numbers.add(problemNum);
}
CompositeResult suspectDetails = getLeakSuspectDescription(rec, listener);
suspectDetails.setStatus(ITestResult.Status.ERROR);
QuerySpec spec = new QuerySpec(MessageUtil.format(Messages.LeakHunterQuery_ProblemSuspect, problemNum));
spec.setResult(suspectDetails);
spec.set(Params.Rendering.PATTERN, Params.Rendering.PATTERN_OVERVIEW_DETAILS);
spec.set(Params.Html.IS_IMPORTANT, Boolean.TRUE.toString());
result.add(spec);
}
// give hints for problems which could be related
List<CompositeResult> hints = findCommonPathForSuspects(accPoint2ProblemNr);
for (int k = 0; k < hints.size(); k++)
{
QuerySpec spec = new QuerySpec(MessageUtil.format(Messages.LeakHunterQuery_Hint, (k + 1)));
spec.setResult(hints.get(k));
spec.set(Params.Rendering.PATTERN, Params.Rendering.PATTERN_OVERVIEW_DETAILS);
spec.set(Params.Html.IS_IMPORTANT, Boolean.TRUE.toString());
result.add(spec);
}
}
if (result.getChildren().size() != 0)
{
return result;
}
else
{
return new TextResult(Messages.LeakHunterQuery_NothingFound);
}
}
FindLeaksQuery.SuspectsResultTable callFindLeaks(IProgressListener listener) throws Exception
{
return (FindLeaksQuery.SuspectsResultTable) SnapshotQuery.lookup("find_leaks", snapshot) //$NON-NLS-1$
.setArgument("threshold_percent", threshold_percent) //$NON-NLS-1$
.setArgument("max_paths", max_paths) //$NON-NLS-1$
.execute(listener);
}
private boolean isThreadRelated(SuspectRecord suspect) throws SnapshotException
{
return isThread(suspect.getSuspect().getObjectId());
}
private boolean isThread(int objectId) throws SnapshotException
{
GCRootInfo[] gcRootInfo = snapshot.getGCRootInfo(objectId);
if (gcRootInfo != null)
{
for (GCRootInfo singleInfo : gcRootInfo)
{
if (singleInfo.getType() == GCRootInfo.Type.THREAD_OBJ) { return true; }
}
}
return false;
}
private CompositeResult getLeakSuspectDescription(SuspectRecord suspect, IProgressListener listener)
throws SnapshotException
{
if (suspect instanceof SuspectRecordGroupOfObjects)
{
return getLeakDescriptionGroupOfObjects((SuspectRecordGroupOfObjects) suspect, listener);
}
else
{
return getLeakDescriptionSingleObject(suspect, listener);
}
}
private CompositeResult getLeakDescriptionSingleObject(SuspectRecord suspect, IProgressListener listener)
throws SnapshotException
{
StringBuilder overview = new StringBuilder(256);
TextResult overviewResult = new TextResult(); // used to create links
// from it to other
// results
Set<String> keywords = new LinkedHashSet<String>();
List<IObject> objectsForTroubleTicketInfo = new ArrayList<IObject>(2);
int suspectId = suspect.getSuspect().getObjectId();
/* get dominator info */
boolean isThreadRelated = isThreadRelated(suspect);
if (isThreadRelated) // a thread bound problem
{
overview.append("<p>"); //$NON-NLS-1$
overview.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_Thread, //
HTMLUtils.escapeText(suspect.getSuspect().getDisplayName()), //
formatRetainedHeap(suspect.getSuspectRetained(), totalHeap)));
overview.append("</p>"); //$NON-NLS-1$
}
else if (snapshot.isClassLoader(suspectId))
{
IClassLoader suspectClassloader = (IClassLoader) suspect.getSuspect();
objectsForTroubleTicketInfo.add(suspectClassloader);
String classloaderName = getClassLoaderName(suspectClassloader, keywords);
overview.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_ClassLoader, //
classloaderName, formatRetainedHeap(suspect.getSuspectRetained(), totalHeap)));
}
else if (snapshot.isClass(suspectId))
{
String className = ((IClass) suspect.getSuspect()).getName();
keywords.add(className);
IClassLoader suspectClassloader = (IClassLoader) snapshot.getObject(((IClass) suspect.getSuspect())
.getClassLoaderId());
// involvedClassloaders.add(suspectClassloader);
objectsForTroubleTicketInfo.add(suspect.getSuspect());
String classloaderName = getClassLoaderName(suspectClassloader, keywords);
overview.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_Class, //
HTMLUtils.escapeText(className), classloaderName, formatRetainedHeap(suspect.getSuspectRetained(), totalHeap)));
}
else
{
String className = suspect.getSuspect().getClazz().getName();
keywords.add(className);
IClassLoader suspectClassloader = (IClassLoader) snapshot.getObject(suspect.getSuspect().getClazz()
.getClassLoaderId());
// involvedClassloaders.add(suspectClassloader);
objectsForTroubleTicketInfo.add(suspect.getSuspect());
String classloaderName = getClassLoaderName(suspectClassloader, keywords);
overview.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_Instance, //
HTMLUtils.escapeText(className), classloaderName, formatRetainedHeap(suspect.getSuspectRetained(), totalHeap)));
/*
* if the class name matches the skip pattern, try to find the first
* referrer which does not match the pattern
*/
if (skipPattern.matcher(className).matches() && !isThreadRelated)
{
int referrerId = findReferrer(suspect.getSuspect().getObjectId());
if (referrerId != -1)
{
IObject referrer = snapshot.getObject(referrerId);
IObject referrerClassloader = null;
if (snapshot.isClassLoader(referrerId))
{
referrerClassloader = referrer;
objectsForTroubleTicketInfo.add(suspectClassloader);
String referrerClassloaderName = getClassLoaderName(referrerClassloader, keywords);
overview.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_ReferencedBy,
referrerClassloaderName));
}
else if (snapshot.isClass(referrerId))
{
referrerClassloader = snapshot.getObject(((IClass) referrer).getClassLoaderId());
// involvedClassloaders.add(suspectClassloader);
objectsForTroubleTicketInfo.add(referrer);
String referrerClassloaderName = getClassLoaderName(referrerClassloader, keywords);
overview.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_ReferencedByClass, className,
referrerClassloaderName));
}
else
{
if (isThread(referrerId))
{
isThreadRelated = true;
suspectId = referrerId;
IObject suspectObject = snapshot.getObject(suspectId);
suspect = new SuspectRecord(suspectObject, suspectObject.getRetainedHeapSize(), suspect.getAccumulationPoint());
}
referrerClassloader = snapshot.getObject(referrer.getClazz().getClassLoaderId());
// involvedClassloaders.add(suspectClassloader);
objectsForTroubleTicketInfo.add(referrer);
String referrerClassloaderName = getClassLoaderName(referrerClassloader, keywords);
overview.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_ReferencedByInstance, HTMLUtils.escapeText(referrer
.getDisplayName()), referrerClassloaderName));
if (isThreadRelated)
{
overview.append("<p>"); //$NON-NLS-1$
overview.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_Thread, //
HTMLUtils.escapeText(suspect.getSuspect().getDisplayName()), //
formatRetainedHeap(suspect.getSuspectRetained(), totalHeap)));
overview.append("</p>"); //$NON-NLS-1$
}
}
}
}
}
/* get accumulation point info */
if (suspect.getAccumulationPoint() != null)
{
IObject accumulationObject = suspect.getAccumulationPoint().getObject();
int accumulationPointId = accumulationObject.getObjectId();
if (snapshot.isClassLoader(accumulationPointId))
{
IClassLoader accPointClassloader = (IClassLoader) accumulationObject;
objectsForTroubleTicketInfo.add(accPointClassloader);
String classloaderName = getClassLoaderName(accPointClassloader, keywords);
overview.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_AccumulatedBy, classloaderName, formatRetainedHeap(suspect.getAccumulationPoint().getRetainedHeapSize(), totalHeap)));
}
else if (snapshot.isClass(accumulationPointId))
{
IClass clazz = (IClass) accumulationObject;
keywords.add(clazz.getName());
IClassLoader accPointClassloader = (IClassLoader) snapshot.getObject(clazz.getClassLoaderId());
// involvedClassloaders.add(accPointClassloader);
objectsForTroubleTicketInfo.add(accumulationObject);
String classloaderName = getClassLoaderName(accPointClassloader, keywords);
overview.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_AccumulatedByLoadedBy, HTMLUtils.escapeText(clazz.getName()),
classloaderName, formatRetainedHeap(suspect.getAccumulationPoint().getRetainedHeapSize(), totalHeap)));
}
else
{
String className = accumulationObject.getClazz().getName();
keywords.add(className);
IClassLoader accPointClassloader = (IClassLoader) snapshot.getObject(accumulationObject.getClazz()
.getClassLoaderId());
// involvedClassloaders.add(accPointClassloader);
objectsForTroubleTicketInfo.add(accumulationObject);
String classloaderName = getClassLoaderName(accPointClassloader, keywords);
overview.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_AccumulatedByInstance, HTMLUtils.escapeText(className),
classloaderName, formatRetainedHeap(suspect.getAccumulationPoint().getRetainedHeapSize(), totalHeap)));
}
}
/* extract request information for thread related problems */
ThreadInfoQuery.Result threadDetails = null;
if (isThreadRelated)
{
threadDetails = extractThreadData(suspect, keywords, objectsForTroubleTicketInfo, overview, overviewResult);
}
/* append keywords */
appendKeywords(keywords, overview);
// add CSN components data
appendTroubleTicketInformation(objectsForTroubleTicketInfo, overview);
/*
* Prepare the composite result from the different pieces
*/
CompositeResult composite = new CompositeResult();
overviewResult.setText(overview.toString());
composite.addResult(Messages.LeakHunterQuery_Description, overviewResult);
IObject describedObject = (suspect.getAccumulationPoint() != null) ? suspect.getAccumulationPoint().getObject()
: suspect.getSuspect();
// add a path to the accumulation point
try
{
IResult result = SnapshotQuery.lookup("path2gc", snapshot) //$NON-NLS-1$
.setArgument("object", describedObject) //$NON-NLS-1$
.execute(listener);
QuerySpec qs = new QuerySpec(Messages.LeakHunterQuery_ShortestPaths, result);
qs.setCommand("path2gc 0x" + Long.toHexString(describedObject.getObjectAddress())); //$NON-NLS-1$
composite.addResult(qs);
if (!isThreadRelated && result instanceof IResultTree && result instanceof ISelectionProvider)
{
IResultTree tree = (IResultTree)result;
ISelectionProvider sel = (ISelectionProvider)result;
for (Object row : tree.getElements())
{
int r[] = findEndTree(tree, sel, row, describedObject.getObjectId());
if (r != null)
{
if (isThread(r[0]))
{
isThreadRelated = true;
AccumulationPoint ap = new AccumulationPoint(snapshot.getObject(r[1]));
SuspectRecord suspect2 = new SuspectRecord(snapshot.getObject(r[0]), totalHeap, ap);
StringBuilder overview2 = new StringBuilder();
TextResult threadOverview = new TextResult();
Set<String>keywords2 = new LinkedHashSet<String>();
objectsForTroubleTicketInfo.add(suspect2.getSuspect());
threadDetails = extractThreadData(suspect2, keywords2, objectsForTroubleTicketInfo, overview2, threadOverview);
/* append keywords */
appendKeywords(keywords2, overview2);
// add CSN components data
appendTroubleTicketInformation(objectsForTroubleTicketInfo, overview2);
threadOverview.setText(overview2.toString());
composite.addResult(Messages.LeakHunterQuery_ThreadRootShortestPath, threadOverview);
break;
}
}
}
}
}
catch (Exception e)
{
throw new SnapshotException(Messages.LeakHunterQuery_ErrorShortestPaths, e);
}
// show the acc. point in the dominator tree
IResult objectInDominatorTree = showInDominatorTree(describedObject.getObjectId());
QuerySpec qs = new QuerySpec(Messages.LeakHunterQuery_AccumulatedObjects, objectInDominatorTree);
qs.setCommand("show_dominator_tree 0x" + Long.toHexString(describedObject.getObjectAddress())); //$NON-NLS-1$
composite.addResult(qs);
// add histogram of dominated.
IResult histogramOfDominated = getHistogramOfDominated(describedObject.getObjectId());
if (histogramOfDominated != null)
{
qs = new QuerySpec(Messages.LeakHunterQuery_AccumulatedObjectsByClass, histogramOfDominated);
qs.setCommand("show_dominator_tree 0x" + Long.toHexString(describedObject.getObjectAddress()) + " -groupby BY_CLASS"); //$NON-NLS-1$//$NON-NLS-2$
composite.addResult(qs);
IResult result = SnapshotQuery.lookup("show_retained_set", snapshot) //$NON-NLS-1$
.setArgument("objects", describedObject) //$NON-NLS-1$
.execute(listener);
qs = new QuerySpec(Messages.LeakHunterQuery_AllAccumulatedObjectsByClass, result);
qs.setCommand("show_retained_set 0x" + Long.toHexString(describedObject.getObjectAddress())); //$NON-NLS-1$
composite.addResult(qs);
}
if (threadDetails != null)
{
qs = new QuerySpec(Messages.LeakHunterQuery_ThreadDetails, threadDetails);
qs.setCommand("thread_details 0x" + Long.toHexString(suspect.getSuspect().getObjectAddress())); //$NON-NLS-1$
composite.addResult(qs);
}
return composite;
}
private CompositeResult getLeakDescriptionGroupOfObjects(SuspectRecordGroupOfObjects suspect, IProgressListener listener)
throws SnapshotException
{
StringBuilder builder = new StringBuilder(256);
Set<String> keywords = new LinkedHashSet<String>();
List<IObject> involvedClassLoaders = new ArrayList<IObject>(2);
/* get leak suspect info */
String className = ((IClass) suspect.getSuspect()).getName();
keywords.add(className);
IClassLoader classloader = (IClassLoader) snapshot
.getObject(((IClass) suspect.getSuspect()).getClassLoaderId());
involvedClassLoaders.add(suspect.getSuspect());
String classloaderName = getClassLoaderName(classloader, keywords);
String numberOfInstances = numberFormatter.format(suspect.getSuspectInstances().length);
builder.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_InstancesOccupy, numberOfInstances, HTMLUtils.escapeText(className),
classloaderName, formatRetainedHeap(suspect.getSuspectRetained(), totalHeap)));
int[] suspectInstances = suspect.getSuspectInstances();
List<IObject> bigSuspectInstances = new ArrayList<IObject>();
for (int j = 0; j < suspectInstances.length; j++)
{
IObject inst = snapshot.getObject(suspectInstances[j]);
if (inst.getRetainedHeapSize() < (totalHeap / 100))
break;
bigSuspectInstances.add(inst);
}
if (bigSuspectInstances.size() > 0)
{
builder.append("<p>").append(Messages.LeakHunterQuery_BiggestInstances); //$NON-NLS-1$
builder.append("</p>"); //$NON-NLS-1$
builder.append("<ul title=\"").append(escapeHTMLAttribute(Messages.LeakHunterQuery_BiggestInstances)).append("\">"); //$NON-NLS-1$ //$NON-NLS-2$
for (IObject inst : bigSuspectInstances)
{
builder.append("<li>").append(HTMLUtils.escapeText(inst.getDisplayName())); //$NON-NLS-1$
builder.append(" - ") //$NON-NLS-1$
.append(
MessageUtil.format(Messages.LeakHunterQuery_Msg_Bytes,
formatRetainedHeap(inst.getRetainedHeapSize(),
totalHeap)));
builder.append("</li>"); //$NON-NLS-1$
}
builder.append("</ul>"); //$NON-NLS-1$
}
/* get accumulation point info */
if (suspect.getAccumulationPoint() != null)
{
builder.append("<p>"); //$NON-NLS-1$
int accumulationPointId = suspect.getAccumulationPoint().getObject().getObjectId();
if (snapshot.isClassLoader(accumulationPointId))
{
involvedClassLoaders.add((IClassLoader) suspect.getAccumulationPoint().getObject());
classloaderName = getClassLoaderName(suspect.getAccumulationPoint().getObject(), keywords);
builder.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_ReferencedFromClassLoader,
classloaderName, formatRetainedHeap(suspect.getAccumulationPoint().getRetainedHeapSize(), totalHeap)));
}
else if (snapshot.isClass(accumulationPointId))
{
className = ((IClass) suspect.getAccumulationPoint().getObject()).getName();
keywords.add(className);
IClassLoader accPointClassloader = (IClassLoader) snapshot.getObject(((IClass) suspect
.getAccumulationPoint().getObject()).getClassLoaderId());
// involvedClassLoaders.add(accPointClassloader);
involvedClassLoaders.add(suspect.getAccumulationPoint().getObject());
classloaderName = getClassLoaderName(accPointClassloader, keywords);
builder.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_ReferencedFromClass, className,
classloaderName, formatRetainedHeap(suspect.getAccumulationPoint().getRetainedHeapSize(), totalHeap)));
}
else
{
className = suspect.getAccumulationPoint().getObject().getClazz().getName();
keywords.add(className);
IClassLoader accPointClassloader = (IClassLoader) snapshot.getObject(suspect.getAccumulationPoint()
.getObject().getClazz().getClassLoaderId());
// involvedClassLoaders.add(accPointClassloader);
involvedClassLoaders.add(suspect.getAccumulationPoint().getObject());
classloaderName = getClassLoaderName(accPointClassloader, keywords);
builder.append(MessageUtil.format(Messages.LeakHunterQuery_Msg_ReferencedFromInstance, className,
classloaderName, formatRetainedHeap(suspect.getAccumulationPoint().getRetainedHeapSize(), totalHeap)));
}
builder.append("</p>"); //$NON-NLS-1$
}
ThreadInfoQuery.Result threadDetails = null;
// append keywords
appendKeywords(keywords, builder);
// add CSN components data
appendTroubleTicketInformation(involvedClassLoaders, builder);
/*
* Prepare the composite result from the different pieces
*/
CompositeResult composite = new CompositeResult();
composite.addResult(Messages.LeakHunterQuery_Description, new TextResult(builder.toString(), true));
/*
* Show more details about the big instances
*/
if (bigSuspectInstances.size() > 0)
{
PieFactory pie = new PieFactory(snapshot, totalHeap);
int big[] = new int[bigSuspectInstances.size()];
long totalBig = 0;
long usedBig = 0;
for (int i = 0; i < bigSuspectInstances.size(); ++i)
{
IObject iObject = bigSuspectInstances.get(i);
big[i] = iObject.getObjectId();
pie.addSlice(big[i], iObject.getDisplayName(), iObject.getUsedHeapSize(), iObject.getRetainedHeapSize());
totalBig += iObject.getRetainedHeapSize();
usedBig += iObject.getUsedHeapSize();
}
long totalSuspects = 0;
long usedSuspects = 0;
for (int s : suspectInstances)
{
IObject inst = snapshot.getObject(s);
totalSuspects += inst.getRetainedHeapSize();
usedSuspects += inst.getUsedHeapSize();
}
pie.addSlice(-1, Messages.LeakHunterQuery_OtherSuspectInstances, usedSuspects - usedBig, totalSuspects - totalBig);
QuerySpec specPie = new QuerySpec(Messages.LeakHunterQuery_BiggestInstancesOverview, pie.build());
specPie.set(Params.Html.COLLAPSED, Boolean.TRUE.toString());
composite.addResult(specPie);
QuerySpec spec = new QuerySpec(Messages.LeakHunterQuery_BiggestInstancesHeading,
new ObjectListResult.Outbound(snapshot, big));
try
{
StringBuilder sb = new StringBuilder("list_objects"); //$NON-NLS-1$
for (int i : big)
{
sb.append(" 0x").append(Long.toHexString(snapshot.mapIdToAddress(i))); //$NON-NLS-1$
}
spec.setCommand(sb.toString());
}
catch (SnapshotException e)
{} // Ignore if problem
spec.set(Params.Html.COLLAPSED, Boolean.TRUE.toString());
composite.addResult(spec);
}
AccumulationPoint accPoint = suspect.getAccumulationPoint();
if (accPoint != null)
{
QuerySpec qs = new QuerySpec(Messages.LeakHunterQuery_CommonPath, //
MultiplePath2GCRootsQuery.create(snapshot, suspect.getPathsComputer(), suspect.getCommonPath(), listener));
int paths[];
if (suspect.suspectInstances.length <= 25)
{
// Use all the objects
paths = suspect.suspectInstances;
}
else if (suspect.getCommonPath().length > 0)
{
// Just use the last of the common path
paths = new int[] { suspect.getCommonPath()[suspect.getCommonPath().length - 1] };
}
else
{
paths = new int[0];
}
if (paths.length > 0)
{
StringBuilder sb = new StringBuilder("merge_shortest_paths"); //$NON-NLS-1$
for (int objId : paths)
{
long addr = snapshot.mapIdToAddress(objId);
sb.append(" 0x").append(Long.toHexString(addr)); //$NON-NLS-1$
}
qs.setCommand(sb.toString());
}
composite.addResult(qs);
int path[] = suspect.getCommonPath();
if (path.length > 0)
{
if (isThread(path[0]))
{
AccumulationPoint ap = new AccumulationPoint(path.length > 1 ? snapshot.getObject(path[1]) : null);
SuspectRecord suspect2 = new SuspectRecord(snapshot.getObject(path[0]), totalHeap, ap);
StringBuilder overview2 = new StringBuilder();
TextResult threadOverview = new TextResult();
Set<String>keywords2 = new LinkedHashSet<String>();
List<IObject> objectsForTroubleTicketInfo = new ArrayList<IObject>(2);
objectsForTroubleTicketInfo.add(suspect2.getSuspect());
threadDetails = extractThreadData(suspect2, keywords2, objectsForTroubleTicketInfo, overview2, threadOverview);
/* append keywords */
appendKeywords(keywords2, overview2);
// add CSN components data
appendTroubleTicketInformation(objectsForTroubleTicketInfo, overview2);
threadOverview.setText(overview2.toString());
composite.addResult(Messages.LeakHunterQuery_ThreadRootShortestPath, threadOverview);
}
}
}
else
{
IResult result = findReferencePattern(suspect);
if (result != null)
{
String msg = (suspect.getSuspectInstances().length > max_paths) ?
MessageUtil.format(Messages.LeakHunterQuery_ReferencePatternFor, max_paths) :
Messages.LeakHunterQuery_ReferencePattern;
QuerySpec qs = new QuerySpec(msg, result);
IObject io = suspect.getSuspect();
if (io instanceof IClass)
{
String cn = OQLclassName((IClass)io);
qs.setCommand("merge_shortest_paths SELECT * FROM " + cn + " s WHERE dominatorof(s) = null; -groupby FROM_GC_ROOTS_BY_CLASS"); //$NON-NLS-1$ //$NON-NLS-2$
}
composite.addResult(qs);
}
}
if (threadDetails != null)
{
QuerySpec qs = new QuerySpec(Messages.LeakHunterQuery_ThreadDetails, threadDetails);
qs.setCommand("thread_details 0x" + Long.toHexString(suspect.getSuspect().getObjectAddress())); //$NON-NLS-1$
composite.addResult(qs);
}
return composite;
}
private String escapeHTMLAttribute(String msg)
{
return HTMLUtils.escapeText(msg).replaceAll("\"", ""e;").replaceAll("'", "'"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
}
/**
* Find the end of the path to GC roots.
* Relies on end being selected.
* @param tree the tree
* @param sel the selection provider (the tree)
* @param row the current row
* @param prev previous object in tree
* @return array [root object, previous object traversed] or
* null if no selected object at root
*/
private int[] findEndTree(IResultTree tree, ISelectionProvider sel, Object row, int prev)
{
if (sel.isSelected(row))
{
IContextObject x = tree.getContext(row);
if (x != null && x.getObjectId() >= 0)
return new int[] {x.getObjectId(), prev};
}
if (sel.isExpanded(row))
{
// Recurse
IContextObject x = tree.getContext(row);
if (x != null)
prev = x.getObjectId();
List<?> children = tree.getChildren(row);
if (children != null)
{
for (Object r2 : children)
{
int ret[] = findEndTree(tree, sel, r2, prev);
if (ret != null)
return ret;
}
}
}
return null;
}
private String OQLclassName(IClass ic)
{
String className = ic.getName();
// Check class name is sensible and will parse (not a full Java identifier test)
// and is unique
try
{
Collection<IClass> classesByName = ic.getSnapshot().getClassesByName(className, false);
if (className.matches("\\p{javaJavaIdentifierStart}[\\p{javaJavaIdentifierStart}\\p{javaJavaIdentifierPart}.]*") && classesByName != null && classesByName.size() == 1) //$NON-NLS-1$
{
return className;
}
}
catch (SnapshotException e)
{
}
return "0x" + Long.toHexString(ic.getObjectAddress()); //$NON-NLS-1$
}
private String formatRetainedHeap(long retained, long totalHeap)
{
return bytesFormatter.format(retained) + " (" //$NON-NLS-1$
+ percentFormatter.format((double) retained / (double) totalHeap) + ")"; //$NON-NLS-1$
}
private Map<String, String> getTroubleTicketMapping(ITroubleTicketResolver resolver, List<IObject> classloaders)
throws SnapshotException
{
Map<String, String> mapping = new HashMap<String, String>();
for (IObject suspect : classloaders)
{
String ticket = null;
String key = null;
if (suspect instanceof IClassLoader)
{
ticket = resolver.resolveByClassLoader((IClassLoader) suspect, listener);
if (ticket != null && !"".equals(ticket.trim())) //$NON-NLS-1$
{
key = suspect.getClassSpecificName();
if (key == null) key = suspect.getTechnicalName();
}
}
else
{
IClass clazz = (suspect instanceof IClass) ? (IClass) suspect : suspect.getClazz();
ticket = resolver.resolveByClass(clazz, listener);
key = clazz.getName();
}
if (ticket != null)
{
String old = mapping.put(ticket, key);
if (old != null) mapping.put(ticket, key + ", " + old); //$NON-NLS-1$
}
}
return mapping;
}
private String getName(IObject object)
{
String name = object.getClassSpecificName();
if (name == null)
{
name = object.getTechnicalName();
}
return name;
}
/**
* Get the name of the class loader.
* @param classloader
* @param keywords
* @return The name with HTML escapes already applied.
*/
private String getClassLoaderName(IObject classloader, Set<String> keywords)
{
if (classloader.getObjectAddress() == 0)
{
return SYSTEM_CLASSLOADER;
}
else
{
String classloaderName = getName(classloader);
if (keywords != null)
{
// Do not want the address in the keyword, so do not use getTechnicalName()
String keywordName = classloader.getClassSpecificName();
if (keywordName == null)
keywordName = classloader.getClazz().getName();
keywords.add(keywordName);
}
return HTMLUtils.escapeText(classloaderName);
}
}
private IResult showInDominatorTree(int objectId) throws SnapshotException
{
// show the acc. point in the dominator tree
Stack<Integer> tmp = new Stack<Integer>();
int e = objectId;
while (e != -1)
{
tmp.push(e);
e = snapshot.getImmediateDominatorId(e);
}
ObjectTreeFactory.TreePathBuilder treeBuilder = new ObjectTreeFactory.TreePathBuilder(snapshot
.getSnapshotInfo().getUsedHeapSize());
treeBuilder.setIsOutgoing();
treeBuilder.addBranch(tmp.pop());
while (tmp.size() > 0)
{
e = tmp.pop();
treeBuilder.addChild(e, e == objectId);
}
int[] dominatedByAccPoint = snapshot.getImmediateDominatedIds(objectId);
for (int i = 0; i < 20 && i < dominatedByAccPoint.length; i++)
{
treeBuilder.addSibling(dominatedByAccPoint[i], false);
}
return treeBuilder.build(snapshot);
}
private IResult getHistogramOfDominated(int objectId) throws SnapshotException
{
int[] dominatedByAccPoint = snapshot.getImmediateDominatedIds(objectId);
Histogram h = snapshot.getHistogram(dominatedByAccPoint, listener);
if (listener.isCanceled())
throw new IProgressListener.OperationCanceledException();
ClassHistogramRecord[] records = h.getClassHistogramRecords().toArray(new ClassHistogramRecord[0]);
for (ClassHistogramRecord record : records)
{
record.setRetainedHeapSize(snapshot.getMinRetainedSize(record.getObjectIds(), listener));
}
Arrays.sort(records, Histogram.reverseComparator(Histogram.COMPARATOR_FOR_RETAINEDHEAPSIZE));
ArrayList<ClassHistogramRecord> suspects = new ArrayList<ClassHistogramRecord>();
int limit = 0;
for (ClassHistogramRecord record : records)
{
if (limit >= 20)
break;
suspects.add(record);
limit++;
}
ListResult result = new ListResult(ClassHistogramRecord.class, suspects, "label", //$NON-NLS-1$
"numberOfObjects", "usedHeapSize", "retainedHeapSize") //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
{
@Override
public URL getIcon(Object row)
{
return Icons.forObject(snapshot, ((ClassHistogramRecord) row).getClassId());
}
@Override
public IContextObject getContext(final Object row)
{
return new IContextObjectSet()
{
public int getObjectId()
{
return ((ClassHistogramRecord) row).getClassId();
}
public int[] getObjectIds()
{
return ((ClassHistogramRecord) row).getObjectIds();
}
public String getOQL()
{
return null;
}
};
}
};
return result;
}
private void appendKeywords(Set<String> keywords, StringBuilder builder)
{
String title = Messages.LeakHunterQuery_Keywords;
builder.append("<p><strong>").append(title).append("</strong>"); //$NON-NLS-1$ //$NON-NLS-2$
builder.append("</p>"); //$NON-NLS-1$
builder.append("<ul style=\"list-style-type:none;\" title=\"").append(escapeHTMLAttribute(title)).append("\">"); //$NON-NLS-1$ //$NON-NLS-2$
for (String s : keywords)
builder.append("<li>").append(HTMLUtils.escapeText(s)).append("</li>"); //$NON-NLS-1$ //$NON-NLS-2$
builder.append("</ul>"); //$NON-NLS-1$
}
private void appendTroubleTicketInformation(List<IObject> classloaders, StringBuilder builder)
throws SnapshotException
{
for (ITroubleTicketResolver resolver : TroubleTicketResolverRegistry.instance().delegates())
{
Map<String, String> mapping = getTroubleTicketMapping(resolver, classloaders);
if (!mapping.isEmpty())
{
String title = resolver.getTicketSystem();
builder.append("<p><strong>").append(HTMLUtils.escapeText(title)).append("</strong>"); //$NON-NLS-1$ //$NON-NLS-2$
builder.append("</p>"); //$NON-NLS-1$
builder.append("<ul style=\"list-style-type:none;\" title=\"").append(escapeHTMLAttribute(title)).append("\">"); //$NON-NLS-1$ //$NON-NLS-2$
for (Map.Entry<String, String> entry : mapping.entrySet())
{
builder.append("<li>").append( //$NON-NLS-1$
MessageUtil.format(Messages.LeakHunterQuery_TicketForSuspect, HTMLUtils.escapeText(entry.getKey()), HTMLUtils.escapeText(entry
.getValue()))).append("</li>"); //$NON-NLS-1$
}
builder.append("</ul>"); //$NON-NLS-1$
}
}
}
private ThreadInfoQuery.Result extractThreadData(SuspectRecord suspect, Set<String> keywords,