regress revision 9843:1ddfb0679c75 
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
30import sys
31import os
32import optparse
33import datetime
34from subprocess import call
35
36progname = os.path.basename(sys.argv[0])
37
38optparser = optparse.OptionParser()
39add_option = optparser.add_option
40add_option('-v', '--verbose', action='store_true', default=False,
41           help='echo commands before executing')
42add_option('--builds',
43           default='ALPHA,ALPHA_MOESI_hammer,' \
44           'ALPHA_MESI_CMP_directory,'  \
45           'ALPHA_MOESI_CMP_directory,' \
46           'ALPHA_MOESI_CMP_token,' \
47           'MIPS,' \
48           'POWER,' \
49           'SPARC,' \
50           'X86,X86_MESI_CMP_directory,' \
51           'ARM',
52           help="comma-separated build targets to test (default: '%default')")
53add_option('--modes',
54           default='se,fs',
55           help="comma-separated modes to test (default: '%default')")
56add_option('--test-variants', default='opt',
57           help="comma-separated build variants to test (default: '%default')"\
58           ", set to '' for none")
59add_option('--compile-variants', default='debug,fast',
60           help="comma-separated build variants to compile only (not test) " \
61           "(default: '%default'), set to '' for none", metavar='VARIANTS')
62add_option('--scons-opts', default='', metavar='OPTS',
63           help='scons options')
64add_option('-j', '--jobs', type='int', default=1, metavar='N',
65           help='number of parallel jobs to use (0 to use all cores)')
66add_option('-k', '--keep-going', action='store_true',
67           help='keep going after errors')
68add_option('--update-ref', action='store_true',
69           help='update reference outputs')
70add_option('-D', '--build-dir', default='', metavar='DIR',
71           help='build directory location')
72add_option('-n', "--no-exec", default=False, action='store_true',
73           help="don't actually invoke scons, just echo SCons command line")
74
75(options, tests) = optparser.parse_args()
76
77
78# split a comma-separated list, but return an empty list if given the
79# empty string
80def split_if_nonempty(s):
81    if not s:
82        return []
83    return s.split(',')
84
85# split list options on ',' to get Python lists
86builds = split_if_nonempty(options.builds)
87modes = split_if_nonempty(options.modes)
88test_variants = split_if_nonempty(options.test_variants)
89compile_variants = split_if_nonempty(options.compile_variants)
90
91options.build_dir = os.path.join(options.build_dir, 'build')
92
93# Call os.system() and raise exception if return status is non-zero
94def system(cmd):
95    try:
96        retcode = call(cmd, shell=True)
97        if retcode < 0:
98            print >>sys.stderr, "Child was terminated by signal", -retcode
99            print >>sys.stderr, "When attemping to execute: %s" % cmd
100            sys.exit(1)
101        elif retcode > 0:
102            print >>sys.stderr, "Child returned", retcode
103            print >>sys.stderr, "When attemping to execute: %s" % cmd
104            sys.exit(1)
105    except OSError, e:
106        print >>sys.stderr, "Execution failed:", e
107        print >>sys.stderr, "When attemping to execute: %s" % cmd
108        sys.exit(1)
109
110targets = []
111
112# start with compile-only targets, if any
113if compile_variants:
114    targets += ['%s/%s/gem5.%s' % (options.build_dir, build, variant)
115                for variant in compile_variants
116                for build in builds]
117
118# By default run the 'quick' tests, all expands to quick and long
119if not tests:
120    tests = ['quick']
121elif 'all' in tests:
122    tests = ['quick', 'long']
123
124# set up test targets for scons, since we don't have any quick SPARC
125# full-system tests exclude it
126targets += ['%s/%s/tests/%s/%s/%s' % (options.build_dir, build, variant, test,
127                                      mode)
128            for build in builds
129            for variant in test_variants
130            for test in tests
131            for mode in modes
132            if not (build == 'SPARC' and test == 'quick' and mode == 'fs')]
133
134def cpu_count():
135    if 'bsd' in sys.platform or sys.platform == 'darwin':
136        try:
137            return int(os.popen('sysctl -n hw.ncpu').read())
138        except ValueError:
139            pass
140    else:
141        try:
142            return os.sysconf('SC_NPROCESSORS_ONLN')
143        except (ValueError, OSError, AttributeError):
144            pass
145
146    raise NotImplementedError('cannot determine number of cpus')
147
148scons_opts = options.scons_opts
149if options.jobs != 1:
150    if options.jobs == 0:
151        options.jobs = cpu_count()
152    scons_opts += ' -j %d' % options.jobs
153if options.keep_going:
154    scons_opts += ' -k'
155if options.update_ref:
156    scons_opts += ' --update-ref'
157
158# We generally compile gem5.fast only to make sure it compiles OK;
159# it's not very useful to run as a regression test since assertions
160# are disabled.  Thus there's not much point spending time on
161# link-time optimization.
162scons_opts += ' --no-lto'
163
164cmd = 'scons --ignore-style %s %s' % (scons_opts, ' '.join(targets))
165if options.no_exec:
166    print cmd
167else:
168    system(cmd)
169    sys.exit(0)
170