Observatory: Add view of dominator tree with siblings merged by class.

runtime/observatory/lib/src/elements/heap_snapshot.dart

 // Copyright (c) 2015, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 import 'dart:async';
 import 'dart:html';
 import 'dart:math' as Math;
 import 'package:observatory/models.dart' as M;
 import 'package:observatory/src/elements/class_ref.dart';
 import 'package:observatory/src/elements/containers/virtual_tree.dart';
 import 'package:observatory/src/elements/helpers/any_ref.dart';
 import 'package:observatory/src/elements/helpers/nav_bar.dart';
 import 'package:observatory/src/elements/helpers/nav_menu.dart';
 import 'package:observatory/src/elements/helpers/rendering_scheduler.dart';
 import 'package:observatory/src/elements/helpers/tag.dart';
 import 'package:observatory/src/elements/nav/isolate_menu.dart';
 import 'package:observatory/src/elements/nav/notify.dart';
 import 'package:observatory/src/elements/nav/refresh.dart';
 import 'package:observatory/src/elements/nav/top_menu.dart';
 import 'package:observatory/src/elements/nav/vm_menu.dart';
 import 'package:observatory/utils.dart';
 
-enum HeapSnapshotTreeMode { dominatorTree, groupByClass }
+enum HeapSnapshotTreeMode { dominatorTree, mergedDominatorTree, groupByClass }
 
 class HeapSnapshotElement extends HtmlElement implements Renderable {
   static const tag =
       const Tag<HeapSnapshotElement>('heap-snapshot', dependencies: const [
     ClassRefElement.tag,
     NavTopMenuElement.tag,
     NavVMMenuElement.tag,
     NavIsolateMenuElement.tag,
     NavRefreshElement.tag,
     NavNotifyElement.tag,
@@ skipping 221 matching lines @@
             'plus its own shallow size, and is the amount of memory '
             'that would be freed if the object became garbage.';
         report.addAll([
           new DivElement()
             ..classes = ['content-centered-big', 'explanation']
             ..text = text
             ..title = text,
           _tree
         ]);
         break;
+      case HeapSnapshotTreeMode.mergedDominatorTree:
+        _tree = new VirtualTreeElement(
+            _createMergedDominator, _updateMergedDominator,
+            _getChildrenMergedDominator,
+            items: _getChildrenMergedDominator(_snapshot.mergedDominatorTree),
+            queue: _r.queue);
+        _tree.expand(_snapshot.mergedDominatorTree);
+        final text = 'In a heap dominator tree, an object X is a parent of '
+            'object Y if every path from the root to Y goes through '
+            'X. This allows you to find "choke points" that are '
+            'holding onto a lot of memory. If an object becomes '
+            'garbage, all its children in the dominator tree become '
+            'garbage as well. '
+            'The retained size of an object is the sum of the '
+            'retained sizes of its children in the dominator tree '

[Cutch, 2016/11/14 17:24:13]

This text should explain what "merge" means in more detail.

[rmacnak, 2016/11/15 00:44:15]

Done.

+            'plus its own shallow size, and is the amount of memory '
+            'that would be freed if the object became garbage.';
+        report.addAll([
+          new DivElement()
+            ..classes = ['content-centered-big', 'explanation']
+            ..text = text
+            ..title = text,
+          _tree
+        ]);
+        break;
       case HeapSnapshotTreeMode.groupByClass:
         final items = _snapshot.classReferences.toList();
         items.sort((a, b) => b.shallowSize - a.shallowSize);
         _tree = new VirtualTreeElement(
             _createGroup, _updateGroup, _getChildrenGroup,
             items: items, queue: _r.queue);
         _tree.expand(_snapshot.dominatorTree);
         report.add(_tree);
         break;
       default:
@@ skipping 13 matching lines @@
         new ButtonElement()
           ..classes = ['expander']
           ..onClick.listen((_) => toggle(autoToggleSingleChildNodes: true)),
         new SpanElement()
           ..classes = ['percentage']
           ..title = 'percentage of heap being retained',
         new SpanElement()..classes = ['name']
       ];
   }
 
+  static Element _createMergedDominator(toggle) {
+    return new DivElement()
+      ..classes = ['tree-item']
+      ..children = [
+        new SpanElement()
+          ..classes = ['size']
+          ..title = 'retained size',
+        new SpanElement()..classes = ['lines'],
+        new ButtonElement()
+          ..classes = ['expander']
+          ..onClick.listen((_) => toggle(autoToggleSingleChildNodes: true)),
+        new SpanElement()
+          ..classes = ['percentage']
+          ..title = 'percentage of heap being retained',
+        new SpanElement()..classes = ['name']
+      ];
+  }
+
   static Element _createGroup(toggle) {
     return new DivElement()
       ..classes = ['tree-item']
       ..children = [
         new SpanElement()
           ..classes = ['size']
           ..title = 'shallow size',
         new SpanElement()..classes = ['lines'],
         new ButtonElement()
           ..classes = ['expander']
           ..onClick.listen((_) => toggle(autoToggleSingleChildNodes: true)),
         new SpanElement()
           ..classes = ['count']
           ..title = 'shallow size',
         new SpanElement()..classes = ['name']
       ];
   }
 
   static const int kMaxChildren = 100;
   static const int kMinRetainedSize = 4096;
 
   static _getChildrenDominator(M.HeapSnapshotDominatorNode node) {
     final list = node.children.toList();
     list.sort((a, b) => b.retainedSize - a.retainedSize);
     return list
         .where((child) => child.retainedSize >= kMinRetainedSize)
         .take(kMaxChildren);
   }
+  static _getChildrenMergedDominator(M.HeapSnapshotMergedDominatorNode node) {
+    final list = node.children.toList();
+    list.sort((a, b) => b.retainedSize - a.retainedSize);
+    return list
+        .where((child) => child.retainedSize >= kMinRetainedSize)
+        .take(kMaxChildren);
+  }
 
   static _getChildrenGroup(item) {
     if (item is M.HeapSnapshotClassReferences) {
       if (item.inbounds.isNotEmpty || item.outbounds.isNotEmpty) {
         return [item.inbounds, item.outbounds];
       }
     } else if (item is Iterable) {
       return item.toList()..sort((a, b) => b.shallowSize - a.shallowSize);
     }
     return const [];
@@ skipping 14 matching lines @@
       ..classes = ['name']
       ..text = 'Loading...';
     element.children[4] = wrapper;
     node.object.then((object) {
       wrapper
         ..text = ''
         ..children = [anyRef(_isolate, object, _instances, queue: _r.queue)];
     });
   }
 
+  void _updateMergedDominator(
+      HtmlElement element, M.HeapSnapshotMergedDominatorNode node, int depth) {
+    element.children[0].text = Utils.formatSize(node.retainedSize);
+    _updateLines(element.children[1].children, depth);
+    if (_getChildrenMergedDominator(node).isNotEmpty) {
+      element.children[2].text = _tree.isExpanded(node) ? '▼' : '►';
+    } else {
+      element.children[2].text = '';
+    }
+    element.children[3].text =
+        Utils.formatPercentNormalized(node.retainedSize * 1.0 / _snapshot.size);
+    final wrapper = new SpanElement()
+      ..classes = ['name']
+      ..text = 'Loading...';
+    element.children[4] = wrapper;
+    node.klass.then((klass) {
+      wrapper
+        ..text = ''
+        ..children = [
+          new SpanElement()..text = '${node.instanceCount} instances of ',
+          anyRef(_isolate, klass, _instances, queue: _r.queue)
+        ];
+    });
+  }
+
   void _updateGroup(HtmlElement element, item, int depth) {
     _updateLines(element.children[1].children, depth);
     if (item is M.HeapSnapshotClassReferences) {
       element.children[0].text = Utils.formatSize(item.shallowSize);
       element.children[2].text = _tree.isExpanded(item) ? '▼' : '►';
       element.children[3].text = '${item.instances} instances of ';
       element.children[4] = new ClassRefElement(_isolate, item.clazz,
           queue: _r.queue)..classes = ['name'];
     } else if (item is Iterable) {
       element.children[0].text = '';
@@ skipping 43 matching lines @@
     }
     while (lines.length < n) {
       lines.add(new SpanElement());
     }
   }
 
   static String modeToString(HeapSnapshotTreeMode mode) {
     switch (mode) {
       case HeapSnapshotTreeMode.dominatorTree:
         return 'Dominator tree';
+      case HeapSnapshotTreeMode.mergedDominatorTree:
+        return 'Dominator tree (merged siblings by class)';
       case HeapSnapshotTreeMode.groupByClass:
         return 'Group by class';
     }
     throw new Exception('Unknown ProfileTreeMode');
   }
 
   List<Element> _createModeSelect() {
     var s;
     return [
       s = new SelectElement()
         ..classes = ['analysis-select']
         ..value = modeToString(_mode)
         ..children = HeapSnapshotTreeMode.values.map((mode) {
           return new OptionElement(
               value: modeToString(mode),
               selected: _mode == mode)..text = modeToString(mode);
         }).toList(growable: false)
         ..onChange.listen((_) {
           _mode = HeapSnapshotTreeMode.values[s.selectedIndex];
           _r.dirty();
         })
     ];
   }
 }