util/regress

   1 #! /usr/bin/env python
   2 # Copyright (c) 2005-2007 The Regents of The University of Michigan
   3 # All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions are
   7 # met: redistributions of source code must retain the above copyright
   8 # notice, this list of conditions and the following disclaimer;
   9 # redistributions in binary form must reproduce the above copyright
  10 # notice, this list of conditions and the following disclaimer in the
  11 # documentation and/or other materials provided with the distribution;
  12 # neither the name of the copyright holders nor the names of its
  13 # contributors may be used to endorse or promote products derived from
  14 # this software without specific prior written permission.
  15 #
  16 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 #
  28 # Authors: Steve Reinhardt
  29
  30 import sys
  31 import os
  32 import optparse
  33 import datetime
  34 from subprocess import call
  35
  36 progname = os.path.basename(sys.argv[0])
  37
  38 optparser = optparse.OptionParser()
  39 add_option = optparser.add_option
  40 add_option('-v', '--verbose', dest='verbose', action='store_true',
  41            default=False,
  42            help='echo commands before executing')
  43 add_option('--builds', dest='builds',
  44            default='ALPHA_SE,ALPHA_SE_MOESI_hammer,' \
  45            'ALPHA_SE_MESI_CMP_directory,'  \
  46            'ALPHA_SE_MOESI_CMP_directory,' \
  47            'ALPHA_SE_MOESI_CMP_token,' \
  48            'ALPHA_FS,' \
  49            'MIPS_SE,' \
  50            'POWER_SE,' \
  51            'SPARC_SE,SPARC_FS,' \
  52            'X86_SE,X86_FS,' \
  53            'ARM_SE,ARM_FS',
  54            help="comma-separated build targets to test (default: '%default')")
  55 add_option('--variants', dest='variants', default='fast',
  56            help="comma-separated build variants to test (default: '%default')")
  57 add_option('--scons-opts', dest='scons_opts', default='', metavar='OPTS',
  58            help='scons options')
  59 add_option('-j', '--jobs', type='int', default=1,
  60            help='number of parallel jobs to use')
  61 add_option('-k', '--keep-going', action='store_true',
  62            help='keep going after errors')
  63 add_option('-D', '--build-dir', default='',
  64            help='build directory location')
  65 add_option('-n', "--no-exec", default=False, action='store_true',
  66            help="don't actually invoke scons, just echo SCons command line")
  67
  68 (options, tests) = optparser.parse_args()
  69
  70
  71 # split list options on ',' to get Python lists
  72 builds = options.builds.split(',')
  73 variants = options.variants.split(',')
  74
  75 options.build_dir = os.path.join(options.build_dir, 'build')
  76
  77 # Call os.system() and raise exception if return status is non-zero
  78 def system(cmd):
  79     try:
  80         retcode = call(cmd, shell=True)
  81         if retcode < 0:
  82             print >>sys.stderr, "Child was terminated by signal", -retcode
  83             print >>sys.stderr, "When attemping to execute: %s" % cmd
  84             sys.exit(1)
  85         elif retcode > 0:
  86             print >>sys.stderr, "Child returned", retcode
  87             print >>sys.stderr, "When attemping to execute: %s" % cmd
  88             sys.exit(1)
  89     except OSError, e:
  90         print >>sys.stderr, "Execution failed:", e
  91         print >>sys.stderr, "When attemping to execute: %s" % cmd
  92         sys.exit(1)
  93
  94 # Quote string s so it can be passed as a shell arg
  95 def shellquote(s):
  96     if ' ' in s:
  97         s = "'%s'" % s
  98     return s
  99
 100 if not tests:
 101     print "No tests specified, just building binaries."
 102     targets = ['%s/%s/m5.%s' % (options.build_dir, build, variant)
 103                for build in builds
 104                for variant in variants]
 105 elif 'all' in tests:
 106     targets = ['%s/%s/tests/%s' % (options.build_dir, build, variant)
 107                for build in builds
 108                for variant in variants]
 109 else:
 110     # Ugly! Since we don't have any quick SPARC_FS tests remove the SPARC_FS target
 111     # If we ever get a quick SPARC_FS test, this code should be removed
 112     if 'quick' in tests and 'SPARC_FS' in builds:
 113         builds.remove('SPARC_FS')
 114     targets = ['%s/%s/tests/%s/%s' % (options.build_dir, build, variant, test)
 115                for build in builds
 116                for variant in variants
 117                for test in tests]
 118
 119 def cpu_count():
 120     if 'bsd' in sys.platform or sys.platform == 'darwin':
 121         try:
 122             return int(os.popen('sysctl -n hw.ncpu').read())
 123         except ValueError:
 124             pass
 125     else:
 126         try:
 127             return os.sysconf('SC_NPROCESSORS_ONLN')
 128         except (ValueError, OSError, AttributeError):
 129             pass
 130
 131     raise NotImplementedError('cannot determine number of cpus')
 132
 133 scons_opts = options.scons_opts
 134 if options.jobs != 1:
 135     if options.jobs == 0:
 136         options.jobs = cpu_count()
 137     scons_opts += ' -j %d' % options.jobs
 138 if options.keep_going:
 139     scons_opts += ' -k'
 140
 141 cmd = 'scons --ignore-style %s %s' % (scons_opts, ' '.join(targets))
 142 if options.no_exec:
 143     print cmd
 144 else:
 145     system(cmd)
 146     sys.exit(0)