[Android] Add an option to view the tracing record categories when running from python script.

build/android/adb_profile_chrome.py

 #!/usr/bin/env python
 #
 # Copyright 2013 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.
 
 import gzip
+import json
 import logging
 import optparse
 import os
 import re
 import select
 import shutil
 import sys
 import threading
 import time
 import webbrowser
@@ skipping 28 matching lines @@
     self._trace_interval = None
     self._trace_start_re = \
        re.compile(r'Logging performance trace to file')
     self._trace_finish_re = \
        re.compile(r'Profiler finished[.] Results are in (.*)[.]')
     self._device.old_interface.StartMonitoringLogcat(clear=False)
 
   def __str__(self):
     return 'chrome trace'
 
+  @staticmethod
+  def GetCategories(device, package_info):
+    device.old_interface.BroadcastIntent(
+        package_info.package, 'GPU_PROFILER_LIST_CATEGORY')
+    try:
+      json_category_list = device.old_interface.WaitForLogMatch(
+          re.compile(r'{"traceCategoriesList(.*)'), None, timeout=5).group(0)
+
+      record_categories = []
+      disabled_by_default_categories = []
+      try:
+        json_data = json.loads(json_category_list)['traceCategoriesList']
+        for item in json_data:
+          if item.startswith('disabled-by-default'):
+            disabled_by_default_categories.append(item)
+          else:
+            record_categories.append(item)
+      except (ValueError, KeyError, TypeError):
+        logging.error('JSON format error')

[Sami, 2014/05/06 14:29:51]

I'd prefer just passing these exceptions through since if anything like this
happens it is more useful to fail noisily with a backtrace.

[r.kasibhatla, 2014/05/06 15:22:29]

Done.

+
+      _PrintMessage('Record Categories:')

[Sami, 2014/05/06 14:29:51]

Instead of printing the results here, could you return a tuple
(record_categories, disabled_by_default_categories) and print them out at the
call site? That way we can use this function for other purposes  too (e.g.,
checking that we're using valid categories).

[r.kasibhatla, 2014/05/06 15:22:29]

In the original patch, I was returning the tuple, but changed to avoid the
unnecessary creation of lists at two places. Anyways, I reverted to previous
patch logic of returning the tuple. :)

+      _PrintMessage('\n'.join(str('\t%s' % item) \

[Sami, 2014/05/06 14:29:51]

Nit: "str" is unneeded here.

[r.kasibhatla, 2014/05/06 15:22:29]

Done.

+          for item in sorted(record_categories)))
+
+      _PrintMessage('\nDisabled by Default Categories:')
+      _PrintMessage('\n'.join(str('\t%s' % item) \

[Sami, 2014/05/06 14:29:51]

Ditto.

[r.kasibhatla, 2014/05/06 15:22:29]

Done.

+          for item in sorted(disabled_by_default_categories)))
+
+    except pexpect.TIMEOUT:

[Sami, 2014/05/06 14:29:51]

Please move this try/except block immediately around WaitForLogMatch since
that's the only place where we expect to get this exception.

[r.kasibhatla, 2014/05/06 15:22:29]

Done.

+      raise RuntimeError('Performance trace category list marker not found. '
+                         'Is the correct version of the browser running?')
+
   def StartTracing(self, interval):
     self._trace_interval = interval
     self._device.old_interface.SyncLogCat()
     self._device.old_interface.BroadcastIntent(
         self._package_info.package, 'GPU_PROFILER_START',
         '-e categories "%s"' % ','.join(self._categories),
         '-e continuous' if self._ring_buffer else '')
     # Chrome logs two different messages related to tracing:
     #
     # 1. "Logging performance trace to file"
@@ skipping 251 matching lines @@
                           'ring buffer and save its contents when stopping '
                           'instead of appending events into one long trace.',
                           action='store_true')
   parser.add_option_group(cont_options)
 
   categories = optparse.OptionGroup(parser, 'Trace categories')
   categories.add_option('-c', '--categories', help='Select Chrome tracing '
                         'categories with comma-delimited wildcards, '
                         'e.g., "*", "cat1*,-cat1a". Omit this option to trace '
                         'Chrome\'s default categories. Chrome tracing can be '
-                        'disabled with "--categories=\'\'".',
+                        'disabled with "--categories=\'\'". Use "list" to see '
+                        'the available categories.',
                         metavar='CHROME_CATEGORIES', dest='chrome_categories',
                         default=_DEFAULT_CHROME_CATEGORIES)
   categories.add_option('-s', '--systrace', help='Capture a systrace with the '
                         'chosen comma-delimited systrace categories. You can '
                         'also capture a combined Chrome + systrace by enabling '
                         'both types of categories. Use "list" to see the '
                         'available categories. Systrace is disabled by '
                         'default.', metavar='SYS_CATEGORIES',
                         dest='systrace_categories', default='')
   categories.add_option('--trace-cc',
@@ skipping 38 matching lines @@
 When in doubt, just try out --trace-frame-viewer.
 """)
 
   if options.verbose:
     logging.getLogger().setLevel(logging.DEBUG)
 
   devices = android_commands.GetAttachedDevices()
   if len(devices) != 1:
     parser.error('Exactly 1 device much be attached.')
   device = device_utils.DeviceUtils(devices[0])
+  package_info = _GetSupportedBrowsers()[options.browser]
+
+  if options.chrome_categories in ['list', 'help']:
+    _PrintMessage('Collecting data...', '\r')

[Sami, 2014/05/06 14:29:51]

Nit: please use eol='' to match the other functions here.

[r.kasibhatla, 2014/05/06 15:22:29]

Done.

+    ChromeTracingController.GetCategories(device, package_info)
+    return 0
 
   if options.systrace_categories in ['list', 'help']:
     _PrintMessage('\n'.join(SystraceController.GetCategories(device)))
     return 0
 
   if not options.time and not options.continuous:
     _PrintMessage('Time interval or continuous tracing should be specified.')
     return 1
 
   chrome_categories = _ComputeChromeCategories(options)
   systrace_categories = _ComputeSystraceCategories(options)
-  package_info = _GetSupportedBrowsers()[options.browser]
 
   if chrome_categories and 'webview' in systrace_categories:
     logging.warning('Using the "webview" category in systrace together with '
                     'Chrome tracing results in duplicate trace events.')
 
   controllers = []
   if chrome_categories:
     controllers.append(ChromeTracingController(device,
                                                package_info,
                                                chrome_categories,
@@ skipping 16 matching lines @@
                                 options.json)
   if options.view:
     if sys.platform == 'darwin':
       os.system('/usr/bin/open %s' % os.path.abspath(result))
     else:
       webbrowser.open(result)
 
 
 if __name__ == '__main__':
   sys.exit(main())