regress revision 8319:6a49ac49fd67 
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_SE,ALPHA_SE_MOESI_hammer,' \
44           'ALPHA_SE_MESI_CMP_directory,'  \
45           'ALPHA_SE_MOESI_CMP_directory,' \
46           'ALPHA_SE_MOESI_CMP_token,' \
47           'ALPHA_FS,' \
48           'MIPS_SE,' \
49           'POWER_SE,' \
50           'SPARC_SE,SPARC_FS,' \
51           'X86_SE,X86_FS,' \
52           'ARM_SE,ARM_FS',
53           help="comma-separated build targets to test (default: '%default')")
54add_option('--test-variants', default='opt',
55           help="comma-separated build variants to test (default: '%default')"\
56           ", set to '' for none")
57add_option('--compile-variants', default='debug,fast',
58           help="comma-separated build variants to compile only (not test) " \
59           "(default: '%default'), set to '' for none", metavar='VARIANTS')
60add_option('--scons-opts', default='', metavar='OPTS',
61           help='scons options')
62add_option('-j', '--jobs', type='int', default=1, metavar='N',
63           help='number of parallel jobs to use (0 to use all cores)')
64add_option('-k', '--keep-going', action='store_true',
65           help='keep going after errors')
66add_option('--update-ref', action='store_true',
67           help='update reference outputs')
68add_option('-D', '--build-dir', default='', metavar='DIR',
69           help='build directory location')
70add_option('-n', "--no-exec", default=False, action='store_true',
71           help="don't actually invoke scons, just echo SCons command line")
72
73(options, tests) = optparser.parse_args()
74
75
76# split a comma-separated list, but return an empty list if given the
77# empty string
78def split_if_nonempty(s):
79    if not s:
80        return []
81    return s.split(',')
82
83# split list options on ',' to get Python lists
84builds = split_if_nonempty(options.builds)
85test_variants = split_if_nonempty(options.test_variants)
86compile_variants = split_if_nonempty(options.compile_variants)
87
88options.build_dir = os.path.join(options.build_dir, 'build')
89
90# Call os.system() and raise exception if return status is non-zero
91def system(cmd):
92    try:
93        retcode = call(cmd, shell=True)
94        if retcode < 0:
95            print >>sys.stderr, "Child was terminated by signal", -retcode
96            print >>sys.stderr, "When attemping to execute: %s" % cmd
97            sys.exit(1)
98        elif retcode > 0:
99            print >>sys.stderr, "Child returned", retcode
100            print >>sys.stderr, "When attemping to execute: %s" % cmd
101            sys.exit(1)
102    except OSError, e:
103        print >>sys.stderr, "Execution failed:", e
104        print >>sys.stderr, "When attemping to execute: %s" % cmd
105        sys.exit(1)
106
107targets = []
108
109# start with compile-only targets, if any
110if compile_variants:
111    targets += ['%s/%s/m5.%s' % (options.build_dir, build, variant)
112                for variant in compile_variants
113                for build in builds]
114
115# By default run the 'quick' tests
116if not tests:
117    tests = ['quick']
118
119# set up test targets for scons
120if 'all' in tests:
121    targets += ['%s/%s/tests/%s' % (options.build_dir, build, variant)
122                for build in builds
123                for variant in test_variants]
124else:
125    # Ugly! Since we don't have any quick SPARC_FS tests remove the
126    # SPARC_FS target If we ever get a quick SPARC_FS test, this code
127    # should be removed
128    if 'quick' in tests and 'SPARC_FS' in builds:
129        builds.remove('SPARC_FS')
130    targets += ['%s/%s/tests/%s/%s' % (options.build_dir, build, variant, test)
131                for build in builds
132                for variant in test_variants
133                for test in tests]
134
135def cpu_count():
136    if 'bsd' in sys.platform or sys.platform == 'darwin':
137        try:
138            return int(os.popen('sysctl -n hw.ncpu').read())
139        except ValueError:
140            pass
141    else:
142        try:
143            return os.sysconf('SC_NPROCESSORS_ONLN')
144        except (ValueError, OSError, AttributeError):
145            pass
146
147    raise NotImplementedError('cannot determine number of cpus')
148
149scons_opts = options.scons_opts
150if options.jobs != 1:
151    if options.jobs == 0:
152        options.jobs = cpu_count()
153    scons_opts += ' -j %d' % options.jobs
154if options.keep_going:
155    scons_opts += ' -k'
156if options.update_ref:
157    scons_opts += ' --update-ref'
158
159cmd = 'scons --ignore-style %s %s' % (scons_opts, ' '.join(targets))
160if options.no_exec:
161    print cmd
162else:
163    system(cmd)
164    sys.exit(0)
165