Benchmark: `--save-all-traces` argument

mojo/devtools/common/mojo_benchmark

 #!/usr/bin/env python
 # Copyright 2015 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.
 
 """Runner for Mojo application benchmarks."""
 
 import argparse
 import logging
 import os.path
@@ skipping 57 matching lines @@
       'shell-args': benchmark_spec.get('shell-args',
                                        []) + _COLD_START_SHELL_ARGS})
   variants.append({
       'variant_name': 'warm start',
       'app': benchmark_spec['app'],
       'duration': benchmark_spec['duration'],
       'measurements': benchmark_spec['measurements'],
       'shell-args': benchmark_spec.get('shell-args', [])})
   return variants
 
-

[ppi, 2015/10/29 13:33:43]

Keep this blank line, Python style guide wants two blank lines between
functions.

[nelly, 2015/10/29 14:20:17]

Done.

 def _run_benchmark(shell, shell_args, app, duration_seconds, measurements,
-                   verbose, android, output_file):
+                   verbose, android, output_file, trace_all):
   """Runs the given benchmark by running `benchmark.mojo` in mojo shell with
   appropriate arguments and returns the produced output.
 
   Returns:
     A tuple of (succeeded, error_msg, output).
   """
   timeout = duration_seconds + _EXTRA_TIMEOUT
   benchmark_args = []
   benchmark_args.append('--app=' + app)
   benchmark_args.append('--duration=' + str(duration_seconds))
 
   device_output_file = None
   if output_file:
     if android:
       device_output_file = os.path.join(shell.get_tmp_dir_path(), output_file)
       benchmark_args.append('--trace-output=' + device_output_file)
     else:
       benchmark_args.append('--trace-output=' + output_file)
 
+  if trace_all:
+    benchmark_args.append('--trace-all')
+
   for measurement in measurements:
     benchmark_args.append(measurement['spec'])
 
   shell_args = list(shell_args)
   shell_args.append(_BENCHMARK_APP)
   shell_args.append('--force-offline-by-default')
   shell_args.append('--args-for=%s %s' % (_BENCHMARK_APP,
                                           ' '.join(benchmark_args)))
 
   if verbose:
@@ skipping 33 matching lines @@
 
 
 def main():
   parser = argparse.ArgumentParser(
       formatter_class=argparse.RawDescriptionHelpFormatter,
       description=_DESCRIPTION)
   parser.add_argument('benchmark_list_file', type=file,
                       help='a file listing benchmarks to run')
   parser.add_argument('--save-traces', action='store_true',
                       help='save the traces produced by benchmarks to disk')
+  parser.add_argument('--trace-all', action='store_true',
+                      help='trace all categories; ignored if not used with ' +

[ppi, 2015/10/29 13:33:43]

Why ignore this if not used with --save-traces?

[nelly, 2015/10/29 14:20:17]

With the current implementation we always print in stdout the results of 
the measurements as specified in the (e.g. mojo/tools/data/)benchmarks 
file, even when the --trace-all argument is given. The role of --trace-all 
is to print all traces (not only the specified measurements) in a .trace 
file.

- If we decide that we want to print in stdout all results, the output 
will be too noisy (not really readable). 
- If we decide to keep the semantics and allow the --trace-all anyway 
this means that we produce and store traces we will never use.

+                           'the `--save-traces` argument')
   perf_dashboard.add_argparse_server_arguments(parser)
 
   # Common shell configuration arguments.
   shell_config.add_shell_arguments(parser)
   script_args = parser.parse_args()
   config = shell_config.get_shell_config(script_args)
 
   try:
     shell, common_shell_args = shell_arguments.get_shell(config, [])
   except shell_arguments.ShellConfigurationException as e:
     print e
     return 1
 
   target_os = 'android' if script_args.android else 'linux'
   benchmark_list_params = {"target_os": target_os}
   exec script_args.benchmark_list_file in benchmark_list_params
 
   exit_code = 0
   for benchmark_spec in benchmark_list_params['benchmarks']:
     benchmark_name = benchmark_spec['name']
 
     for variant_spec in _generate_benchmark_variants(benchmark_spec):
       variant_name = variant_spec['variant_name']
       app = variant_spec['app']
       duration = variant_spec['duration']
       shell_args = variant_spec.get('shell-args', []) + common_shell_args
       measurements = variant_spec['measurements']
 
       output_file = None
+      trace_all = False
       if script_args.save_traces:
         output_file = 'benchmark-%s-%s-%s.trace' % (
             benchmark_name.replace(' ', '_'),
             variant_name.replace(' ', '_'),
             time.strftime('%Y%m%d%H%M%S'))
+        if script_args.trace_all:
+            trace_all = True
+      elif script_args.trace_all:
+        print 'warning: --trace-all argument ignored (see usage).'
 
       chart_data_recorder = None
       if script_args.upload:
         chart_data_recorder = perf_dashboard.ChartDataRecorder(
             script_args.test_name)
 
       benchmark_succeeded, benchmark_error, output = _run_benchmark(
           shell, shell_args, app, duration, measurements, script_args.verbose,
-          script_args.android, output_file)
+          script_args.android, output_file, trace_all)
 
       print '[ %s ] %s ' % (benchmark_name, variant_name)
 
       some_measurements_failed = False
       if benchmark_succeeded:
         measurement_results = _parse_measurement_results(output)
         # Iterate over the list of specs, not the dictionary, to detect missing
         # results and preserve the required order.
         for measurement in measurements:
           if measurement['spec'] in measurement_results:
@@ skipping 25 matching lines @@
         perf_dashboard.upload_chart_data(
             script_args.master_name, script_args.bot_name,
             script_args.test_name, script_args.builder_name,
             script_args.build_number, chart_data_recorder.get_chart_data(),
             script_args.server_url, script_args.dry_run)
 
   return exit_code
 
 if __name__ == '__main__':
   sys.exit(main())