[SuperSize] Tiger Viewer: Add symbol grouping by container.

This CL adds the "Container" option under "Group symbols by". This is
meaningful only for .size / .sizediff files with multiple containers.

Bug: 1040645
Change-Id: I93ea1548c3c11f7dbcbbdd4779e378715c1c373a
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2362989Reviewed-by: Andrew Grieve <agrieve@chromium.org>
Commit-Queue: Samuel Huang <huangs@chromium.org>
Cr-Commit-Position: refs/heads/master@{#799131}

tools/binary_size/libsupersize/caspian/BUILD.gn

@@ -78,7 +78,7 @@ if (is_wasm) {
       "-s",
       "ALLOW_MEMORY_GROWTH=1",
       "-s",
-      "EXPORTED_FUNCTIONS=['_LoadSizeFile','_LoadBeforeSizeFile','_BuildTree','_Open','_malloc','_free']",
+      "EXPORTED_FUNCTIONS=['_LoadSizeFile','_LoadBeforeSizeFile','_BuildTree','_Open','_QueryProperty','_malloc','_free']",
       "-s",
       "EXTRA_EXPORTED_RUNTIME_METHODS=['ccall','cwrap','UTF8ToString']",
     ]

tools/binary_size/libsupersize/caspian/caspian_web.cc

@@ -55,6 +55,11 @@ bool MatchesRegex(const GroupedPath& id_path,
   return RE2::PartialMatch(Re2StringPiece(sym.FullName()), regex);
 }
 
+bool IsMultiContainer() {
+  // If DeltaSizeInfo is active, still take |info| since it's the "after" info.
+  return info->containers.size() > 1 || !info->containers[0].name.empty();
+}
+
 }  // namespace
 
 extern "C" {
@@ -177,6 +182,8 @@ bool BuildTree(bool method_count_mode,
   std::cout << "group_by=" << group_by << std::endl;
   if (!strcmp(group_by, "source_path")) {
     lens = std::make_unique<IdPathLens>();
+  } else if (!strcmp(group_by, "container")) {
+    lens = std::make_unique<ContainerLens>();
   } else if (!strcmp(group_by, "component")) {
     lens = std::make_unique<ComponentLens>();
     sep = '>';
@@ -196,12 +203,22 @@ bool BuildTree(bool method_count_mode,
   return bool(diff_info);
 }
 
+// Returns a string that can be parsed to a JS object.
 const char* Open(const char* path) {
-  // Returns a string that can be parsed to a JS object.
   static std::string result;
   Json::Value v = builder->Open(path);
   result = JsonSerialize(v);
   return result.c_str();
 }
+
+// Returns global properties.
+const char* QueryProperty(const char* key) {
+  if (!strcmp(key, "isMultiContainer")) {
+    return IsMultiContainer() ? "true" : "false";
+  }
+  std::cerr << "Unknown property: " << key << std::endl;
+  exit(1);
+}
+
 }  // extern "C"
 }  // namespace caspian

tools/binary_size/libsupersize/caspian/lens.cc

@@ -11,6 +11,7 @@
 
 namespace {
 
+constexpr const char* kDefaultContainer = "(Default container)";
 constexpr const char* kNoComponent = "(No component)";
 
 bool PartialMatch(std::string_view view, const RE2& regex) {
@@ -33,6 +34,14 @@ std::string_view IdPathLens::ParentName(const BaseSymbol& symbol) {
   return "";
 }
 
+std::string_view ContainerLens::ParentName(const BaseSymbol& symbol) {
+  std::string component;
+  if (symbol.ContainerName() && *symbol.ContainerName()) {
+    return symbol.ContainerName();
+  }
+  return kDefaultContainer;
+}
+
 std::string_view ComponentLens::ParentName(const BaseSymbol& symbol) {
   std::string component;
   if (symbol.Component() && *symbol.Component()) {

tools/binary_size/libsupersize/caspian/lens.h

@@ -21,6 +21,11 @@ class IdPathLens : public BaseLens {
   std::string_view ParentName(const BaseSymbol& symbol) override;
 };
 
+class ContainerLens : public BaseLens {
+ public:
+  std::string_view ParentName(const BaseSymbol& symbol) override;
+};
+
 class ComponentLens : public BaseLens {
  public:
   std::string_view ParentName(const BaseSymbol& symbol) override;

tools/binary_size/libsupersize/static/shared.js

@@ -53,10 +53,17 @@
  * include DOM elements for styling.
  * @prop {number} value The size number used to create the other strings.
  */
+
 /**
  * @typedef {(node: TreeNode, unit: string) => GetSizeResult} GetSize
  */
 
+/**
+ * @typedef {object} SizeProperties Properties loaded from .size / .sizediff
+ * files.
+ * @prop {boolean} isMultiContainer Whether multiple containers exist.
+ */
+
 /**
  * Abberivated keys used by FileEntrys in the JSON data file. These must match
  * _COMPACT_*_KEY variables in html_report.py.

tools/binary_size/libsupersize/static/tree-ui.js

@@ -451,7 +451,11 @@ const newTreeElement = (() => {
     );
   }
 
-  window.supersize.treeReady.then(displayTree);
+  window.supersize.treeReady.then((message) => {
+    document.querySelector('#group-by-container')
+            .toggleAttribute('disabled', !message.isMultiContainer);
+    displayTree(message);
+  });
   window.supersize.worker.setOnProgressHandler(displayTree);
 
   _fileUpload.addEventListener('change', event => {

tools/binary_size/libsupersize/static/tree-worker-wasm.js

@@ -136,9 +136,12 @@ async function Open(name) {
 }
 
 // Placeholder input name until supplied via setInput()
-const fetcher = new DataFetcher('data.ndjson');
-let beforeFetcher = null;
-let sizeFileLoaded = false;
+const g_fetcher = new DataFetcher('data.ndjson');
+let g_beforeFetcher = null;
+let g_sizeFileLoaded = false;
+
+/** @type {SizeProperties} */
+let g_size_properties = null;
 
 async function loadSizeFile(isBefore, fetcher) {
   const sizeBuffer = await fetcher.loadSizeBuffer();
@@ -153,20 +156,34 @@ async function loadSizeFile(isBefore, fetcher) {
   Module._free(heapBuffer.byteOffset);
 }
 
+async function loadSizeProperties() {
+  const QueryProperty = Module.cwrap('QueryProperty', 'number', ['string']);
+  const getProperty = (key) => {
+    const stringPtr = QueryProperty(key);
+    const r = Module.UTF8ToString(stringPtr, 2 ** 16);
+    return r;
+  };
+  g_size_properties = {
+    isMultiContainer: (getProperty('isMultiContainer') === 'true')
+  };
+}
+
 async function buildTree(
     groupBy, includeRegex, excludeRegex, includeSections, minSymbolSize,
     flagToFilter, methodCountMode, onProgress) {
 
   onProgress({percent: 0.1, id: 0});
+  /** @type {Metadata} */
   return await LoadWasm.then(async () => {
-    if (!sizeFileLoaded) {
-      const current = loadSizeFile(false, fetcher);
-      const before =
-          beforeFetcher !== null ? loadSizeFile(true, beforeFetcher) : null;
-      await current;
-      await before;
+    if (!g_sizeFileLoaded) {
+      const load_promises = [];
+      load_promises.push(loadSizeFile(false, g_fetcher));
+      if (g_beforeFetcher !== null) {
+        load_promises.push(loadSizeFile(true, g_beforeFetcher));
+      }
+      await Promise.all(load_promises).then(loadSizeProperties);
       onProgress({percent: 0.4, id: 0});
-      sizeFileLoaded = true;
+      g_sizeFileLoaded = true;
     }
 
     const BuildTree = Module.cwrap(
@@ -186,6 +203,7 @@ async function buildTree(
       root,
       percent: 1.0,
       diffMode,
+      isMultiContainer: g_size_properties.isMultiContainer,
     };
   });
 }
@@ -251,19 +269,19 @@ const actions = {
       beforeUrl,
     } = parseOptions(options);
     if (accessToken) {
-      fetcher.setAccessToken(accessToken);
+      g_fetcher.setAccessToken(accessToken);
     }
     if (input === 'from-url://' && url) {
       // Display the data from the `load_url` query parameter
       console.info('Displaying data from', url);
-      fetcher.setInput(url);
+      g_fetcher.setInput(url);
     } else if (input != null) {
       console.info('Displaying uploaded data');
-      fetcher.setInput(input);
+      g_fetcher.setInput(input);
     }
 
     if (beforeUrl) {
-      beforeFetcher = new DataFetcher(beforeUrl);
+      g_beforeFetcher = new DataFetcher(beforeUrl);
     }
 
     return buildTree(
@@ -315,4 +333,3 @@ self.onmessage = async event => {
     runAction(id, action, data);
   }
 };
-

tools/binary_size/libsupersize/static/tree-worker.js

@@ -762,6 +762,7 @@ async function buildTree(groupBy, filterTest, methodCountMode, onProgress) {
       root: builder.formatNode(data.root || builder.rootNode),
       percent,
       diffMode: meta && meta.diff_mode,
+      isMultiContainer: false,
     };
     if (data.error) {
       message.error = data.error.message;

tools/binary_size/libsupersize/static/viewer.html

@@ -121,20 +121,39 @@
     <fieldset>
       <legend class="subhead">Group symbols by</legend>
       <div class="radio-wrapper">
-        <input type="radio" id="sourcepath" name="group_by" value="source_path" checked>
-        <label class="radio-label" for="sourcepath">Nothing</label>
+        <input type="radio"
+               id="group-by-sourcepath"
+               name="group_by"
+               value="source_path" checked>
+        <label class="radio-label" for="group-by-sourcepath">Nothing</label>
+      </div>
+      <div class="radio-wrapper show-if-multi-container">
+        <input type="radio"
+               id="group-by-container"
+               name="group_by"
+               value="container">
+        <label class="radio-label" for="group-by-container">Container</label>
       </div>
       <div class="radio-wrapper">
-        <input type="radio" id="component" name="group_by" value="component">
-        <label class="radio-label" for="component">Component</label>
+        <input type="radio"
+               id="group-by-component"
+               name="group_by"
+               value="component">
+        <label class="radio-label" for="group-by-component">Component</label>
       </div>
       <div class="radio-wrapper">
-        <input type="radio" id="template" name="group_by" value="template">
-        <label class="radio-label" for="template">Template</label>
+        <input type="radio"
+               id="group-by-template"
+               name="group_by"
+               value="template">
+        <label class="radio-label" for="group-by-template">Template</label>
       </div>
       <div class="radio-wrapper">
-        <input type="radio" id="generated_type" name="group_by" value="generated_type">
-        <label class="radio-label" for="generated_type">Generated type</label>
+        <input type="radio"
+               id="group-by-generated_type"
+               name="group_by"
+               value="generated_type">
+        <label class="radio-label" for="group-by-generated_type">Generated type</label>
       </div>
     </fieldset>