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