crosperf.py revision f2a3ef46f75d2196a93d3ed27f4d1fcf22b54fbe 
1#!/usr/bin/python
2
3# Copyright 2011 Google Inc. All Rights Reserved.
4"""The driver script for running performance benchmarks on ChromeOS."""
5
6import atexit
7import optparse
8import os
9import signal
10import sys
11from experiment_runner import ExperimentRunner
12from experiment_runner import MockExperimentRunner
13from experiment_factory import ExperimentFactory
14from experiment_file import ExperimentFile
15from help import Help
16from settings_factory import GlobalSettings
17from utils import logger
18
19import test_flag
20
21
22class MyIndentedHelpFormatter(optparse.IndentedHelpFormatter):
23
24  def format_description(self, description):
25    return description
26
27
28def SetupParserOptions(parser):
29  """Add all options to the parser."""
30  parser.add_option('--dry_run',
31                    dest='dry_run',
32                    help=('Parse the experiment file and '
33                          'show what will be done'),
34                    action='store_true',
35                    default=False)
36  # Allow each of the global fields to be overridden by passing in
37  # options. Add each global field as an option.
38  option_settings = GlobalSettings('')
39  for field_name in option_settings.fields:
40    field = option_settings.fields[field_name]
41    parser.add_option('--%s' % field.name,
42                      dest=field.name,
43                      help=field.description,
44                      action='store')
45
46
47def ConvertOptionsToSettings(options):
48  """Convert options passed in into global settings."""
49  option_settings = GlobalSettings('option_settings')
50  for option_name in options.__dict__:
51    if (options.__dict__[option_name] is not None and
52        option_name in option_settings.fields):
53      option_settings.SetField(option_name, options.__dict__[option_name])
54  return option_settings
55
56
57def Cleanup(experiment):
58  """Handler function which is registered to the atexit handler."""
59  experiment.Cleanup()
60
61
62def CallExitHandler(signum, _):
63  """Signal handler that transforms a signal into a call to exit.
64
65  This is useful because functionality registered by "atexit" will
66  be called. It also means you can "catch" the signal by catching
67  the SystemExit exception.
68  """
69  sys.exit(128 + signum)
70
71
72def Main(argv):
73  parser = optparse.OptionParser(usage=Help().GetUsage(),
74                                 description=Help().GetHelp(),
75                                 formatter=MyIndentedHelpFormatter(),
76                                 version='%prog 3.0')
77
78  parser.add_option('--noschedv2',
79                    dest='noschedv2',
80                    default=False,
81                    action='store_true',
82                    help=('Do not use new scheduler. '
83                          'Use original scheduler instead.'))
84  parser.add_option('-l',
85                    '--log_dir',
86                    dest='log_dir',
87                    default='',
88                    help='The log_dir, default is under <crosperf_logs>/logs')
89
90  SetupParserOptions(parser)
91  options, args = parser.parse_args(argv)
92
93  # Convert the relevant options that are passed in into a settings
94  # object which will override settings in the experiment file.
95  option_settings = ConvertOptionsToSettings(options)
96  log_dir = os.path.abspath(os.path.expanduser(options.log_dir))
97  logger.GetLogger(log_dir)
98
99  if len(args) == 2:
100    experiment_filename = args[1]
101  else:
102    parser.error('Invalid number arguments.')
103
104  working_directory = os.getcwd()
105  if options.dry_run:
106    test_flag.SetTestMode(True)
107
108  experiment_file = ExperimentFile(
109      open(experiment_filename, 'rb'), option_settings)
110  if not experiment_file.GetGlobalSettings().GetField('name'):
111    experiment_name = os.path.basename(experiment_filename)
112    experiment_file.GetGlobalSettings().SetField('name', experiment_name)
113  experiment = ExperimentFactory().GetExperiment(experiment_file,
114                                                 working_directory, log_dir)
115
116  json_report = experiment_file.GetGlobalSettings().GetField('json_report')
117
118  signal.signal(signal.SIGTERM, CallExitHandler)
119  atexit.register(Cleanup, experiment)
120
121  if options.dry_run:
122    runner = MockExperimentRunner(experiment, json_report)
123  else:
124    runner = ExperimentRunner(experiment,
125                              json_report,
126                              using_schedv2=(not options.noschedv2))
127
128  runner.Run()
129
130
131if __name__ == '__main__':
132  Main(sys.argv)
133