Add gn args to metadata and metadata diffing

tools/binary_size/describe.py

 # Copyright 2017 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 """Methods for converting model objects to human-readable formats."""
 
 import datetime
 import itertools
 import time
 
 import models
@@ skipping 21 matching lines @@
 class Describer(object):
   def __init__(self, verbose=False):
     self.verbose = verbose
 
   def _DescribeSectionSizes(self, section_sizes):
     relevant_names = models.SECTION_TO_SECTION_NAME.values()
     section_names = sorted(k for k in section_sizes.iterkeys()
                            if k in relevant_names or k.startswith('.data'))
     total_bytes = sum(v for k, v in section_sizes.iteritems()
                       if k in section_names and k != '.bss')
+    yield ''
     yield 'Section Sizes (Total={:,} bytes):'.format(total_bytes)
     for name in section_names:
       size = section_sizes[name]
       if name == '.bss':
-        yield '{}: {:,} bytes (not included in totals)'.format(name, size)
+        yield '    {}: {:,} bytes (not included in totals)'.format(name, size)
       else:
         percent = float(size) / total_bytes if total_bytes else 0
-        yield '{}: {:,} bytes ({:.1%})'.format(name, size, percent)
+        yield '    {}: {:,} bytes ({:.1%})'.format(name, size, percent)
 
     if self.verbose:
       yield ''
       yield 'Other section sizes:'
       section_names = sorted(k for k in section_sizes.iterkeys()
                              if k not in section_names)
       for name in section_names:
-        yield '{}: {:,} bytes'.format(name, section_sizes[name])
+        yield '    {}: {:,} bytes'.format(name, section_sizes[name])
 
   def _DescribeSymbol(self, sym):
     # SymbolGroups are passed here when we don't want to expand them.
     if sym.IsGroup():
       if self.verbose:
         yield ('{} {:<8} {} (count={})  padding={}  '
                'size_without_padding={}').format(
                     sym.section, sym.size, sym.name, len(sym), sym.padding,
                     sym.size_without_padding)
       else:
@@ skipping 63 matching lines @@
       if diff.IsRemoved(sym):
         return '- '
       if sym.size:
         return '~ '
       return '= '
 
     diff = diff if self.verbose else diff.WhereNotUnchanged()
     group_desc = self._DescribeSymbolGroup(diff, prefix_func=prefix_func)
     return itertools.chain((header_str,), group_desc)
 
+  def _DescribeSizeInfoDiff(self, diff):
+    common_metadata = {k: v for k, v in diff.old_metadata.iteritems()
+                       if diff.new_metadata[k] == v}
+    old_metadata = {k: v for k, v in diff.old_metadata.iteritems()
+                    if k not in common_metadata}
+    new_metadata = {k: v for k, v in diff.new_metadata.iteritems()
+                    if k not in common_metadata}
+    metadata_desc = itertools.chain(
+        ('Common Metadata:',),
+        ('    %s' % line for line in DescribeMetadata(common_metadata)),
+        ('Old Metadata:',),
+        ('    %s' % line for line in DescribeMetadata(old_metadata)),
+        ('New Metadata:',),
+        ('    %s' % line for line in DescribeMetadata(new_metadata)))
+    section_desc = self._DescribeSectionSizes(diff.section_sizes)
+    group_desc = self.GenerateLines(diff.symbols)
+    return itertools.chain(metadata_desc, section_desc, ('',), group_desc)
+
+  def _DescribeSizeInfo(self, size_info):
+    metadata_desc = itertools.chain(
+        ('Metadata:',),
+        ('    %s' % line for line in DescribeMetadata(size_info.metadata)))
+    section_desc = self._DescribeSectionSizes(size_info.section_sizes)
+    group_desc = self.GenerateLines(size_info.symbols)
+    return itertools.chain(metadata_desc, section_desc, ('',), group_desc)
+
   def GenerateLines(self, obj):
+    if isinstance(obj, models.SizeInfoDiff):
+      return self._DescribeSizeInfoDiff(obj)
     if isinstance(obj, models.SizeInfo):
-      metadata_desc = 'Metadata: %s' % DescribeSizeInfoMetadata(obj)
-      section_desc = self._DescribeSectionSizes(obj.section_sizes)
-      group_desc = self.GenerateLines(obj.symbols)
-      return itertools.chain((metadata_desc,), section_desc, ('',), group_desc)
-
+      return self._DescribeSizeInfo(obj)
     if isinstance(obj, models.SymbolDiff):
       return self._DescribeSymbolDiff(obj)
-
     if isinstance(obj, models.SymbolGroup):
       return self._DescribeSymbolGroup(obj)
-
     if isinstance(obj, models.Symbol):
       return self._DescribeSymbol(obj)
-
     return (repr(obj),)
 
 
 def DescribeSizeInfoCoverage(size_info):
   """Yields lines describing how accurate |size_info| is."""
   for section in models.SECTION_TO_SECTION_NAME:
     if section == 'd':
       expected_size = sum(v for k, v in size_info.section_sizes.iteritems()
                           if k.startswith('.data'))
     else:
@@ skipping 25 matching lines @@
       yield '+ ' + one_stat(attributed_syms)
 
 
 def _UtcToLocal(utc):
   epoch = time.mktime(utc.timetuple())
   offset = (datetime.datetime.fromtimestamp(epoch) -
             datetime.datetime.utcfromtimestamp(epoch))
   return utc + offset
 
 
-def DescribeSizeInfoMetadata(size_info):
-  display_dict = size_info.metadata.copy()
+def DescribeMetadata(metadata):
+  display_dict = metadata.copy()
   timestamp = display_dict.get(models.METADATA_ELF_MTIME)
   if timestamp:
     timestamp_obj = datetime.datetime.utcfromtimestamp(timestamp)
     display_dict[models.METADATA_ELF_MTIME] = (
         _UtcToLocal(timestamp_obj).strftime('%Y-%m-%d %H:%M:%S'))
-  return ' '.join(sorted('%s=%s' % t for t in display_dict.iteritems()))
+  gn_args = display_dict.get(models.METADATA_GN_ARGS)
+  if gn_args:
+    display_dict[models.METADATA_GN_ARGS] = '; '.join(gn_args)
+  return sorted('%s=%s' % t for t in display_dict.iteritems())
 
 
 def GenerateLines(obj, verbose=False):
   return Describer(verbose).GenerateLines(obj)
 
 
 def WriteLines(lines, func):
   for l in lines:
     func(l)
     func('\n')