1 #! /usr/bin/env python2
2 # Copyright (c) 2005-2007 The Regents of The University of Michigan
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.
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.
28 # Authors: Steve Reinhardt
34 from subprocess
import call
36 progname
= os
.path
.basename(sys
.argv
[0])
38 optparser
= optparse
.OptionParser()
39 add_option
= optparser
.add_option
40 add_option('-v', '--verbose', action
='store_true', default
=False,
41 help='echo commands before executing')
42 add_option('--builds',
46 'NULL_MOESI_hammer,' \
47 'NULL_MESI_Two_Level,' \
48 'NULL_MOESI_CMP_directory,' \
49 'NULL_MOESI_CMP_token,' \
52 'X86,X86_MESI_Two_Level,' \
56 help="comma-separated build targets to test (default: '%default')")
59 help="comma-separated modes to test (default: '%default')")
60 add_option('--test-variants', default
='opt',
61 help="comma-separated build variants to test (default: '%default')"\
62 ", set to '' for none")
63 add_option('--compile-variants', default
='debug,fast',
64 help="comma-separated build variants to compile only (not test) " \
65 "(default: '%default'), set to '' for none", metavar
='VARIANTS')
66 add_option('--scons-opts', default
='', metavar
='OPTS',
68 add_option('-j', '--jobs', type='int', default
=1, metavar
='N',
69 help='number of parallel jobs to use (0 to use all cores)')
70 add_option('-k', '--keep-going', action
='store_true',
71 help='keep going after errors')
72 add_option('--update-ref', action
='store_true',
73 help='update reference outputs')
74 add_option('-D', '--build-dir', default
='', metavar
='DIR',
75 help='build directory location')
76 add_option('-n', "--no-exec", default
=False, action
='store_true',
77 help="don't actually invoke scons, just echo SCons command line")
79 (options
, tests
) = optparser
.parse_args()
82 # split a comma-separated list, but return an empty list if given the
84 def split_if_nonempty(s
):
89 # split list options on ',' to get Python lists
90 builds
= split_if_nonempty(options
.builds
)
91 modes
= split_if_nonempty(options
.modes
)
92 test_variants
= split_if_nonempty(options
.test_variants
)
93 compile_variants
= split_if_nonempty(options
.compile_variants
)
95 options
.build_dir
= os
.path
.join(options
.build_dir
, 'build')
97 # Call os.system() and raise exception if return status is non-zero
100 retcode
= call(cmd
, shell
=True)
102 print >>sys
.stderr
, "Child was terminated by signal", -retcode
103 print >>sys
.stderr
, "When attemping to execute: %s" % cmd
106 print >>sys
.stderr
, "Child returned", retcode
107 print >>sys
.stderr
, "When attemping to execute: %s" % cmd
110 print >>sys
.stderr
, "Execution failed:", e
111 print >>sys
.stderr
, "When attemping to execute: %s" % cmd
116 # start with compile-only targets, if any
118 targets
+= ['%s/%s/gem5.%s' % (options
.build_dir
, build
, variant
)
119 for variant
in compile_variants
122 # By default run the 'quick' tests, all expands to quick and long
126 tests
= ['quick', 'long']
128 # set up test targets for scons, since we don't have any quick SPARC
129 # full-system tests exclude it
130 targets
+= ['%s/%s/tests/%s/%s/%s' % (options
.build_dir
, build
, variant
, test
,
133 for variant
in test_variants
136 if not (build
== 'SPARC' and test
== 'quick' and mode
== 'fs')]
139 if 'bsd' in sys
.platform
or sys
.platform
== 'darwin':
141 return int(os
.popen('sysctl -n hw.ncpu').read())
146 return os
.sysconf('SC_NPROCESSORS_ONLN')
147 except (ValueError, OSError, AttributeError):
150 raise NotImplementedError('cannot determine number of cpus')
152 scons_opts
= options
.scons_opts
153 if options
.jobs
!= 1:
154 if options
.jobs
== 0:
155 options
.jobs
= cpu_count()
156 scons_opts
+= ' -j %d' % options
.jobs
157 if options
.keep_going
:
159 if options
.update_ref
:
160 scons_opts
+= ' --update-ref'
162 # We generally compile gem5.fast only to make sure it compiles OK;
163 # it's not very useful to run as a regression test since assertions
164 # are disabled. Thus there's not much point spending time on
165 # link-time optimization.
166 scons_opts
+= ' --no-lto'
168 cmd
= 'scons --ignore-style %s %s' % (scons_opts
, ' '.join(targets
))