3 # Copyright (c) 2004-2006 The Regents of The University of Michigan
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions are
8 # met: redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer;
10 # redistributions in binary form must reproduce the above copyright
11 # notice, this list of conditions and the following disclaimer in the
12 # documentation and/or other materials provided with the distribution;
13 # neither the name of the copyright holders nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 # Authors: Steve Reinhardt
35 from SCons.Script.SConscript import SConsEnvironment
39 env['DIFFOUT'] = File('diff-out')
41 # Dict that accumulates lists of tests by category (quick, medium, long)
45 return file(str(node)).read()
47 # functions to parse return value from scons Execute()... not the same
48 # as wait() etc., so python built-in os funcs don't work.
50 return (status & 0x80) != 0;
53 return (status & 0x7f);
55 # List of signals that indicate that we should retry the test rather
56 # than consider it failed.
57 retry_signals = (signal.SIGTERM, signal.SIGKILL, signal.SIGINT,
58 signal.SIGQUIT, signal.SIGHUP)
60 # regular expressions of lines to ignore when diffing outputs
61 output_ignore_regexes = (
62 '^command line:', # for stdout file
63 '^M5 compiled ', # for stderr file
64 '^M5 started ', # for stderr file
65 '^M5 executing on ', # for stderr file
66 '^Simulation complete at', # for stderr file
67 '^Listening for', # for stderr file
68 'listening for remote gdb', # for stderr file
71 output_ignore_args = ' '.join(["-I '"+s+"'" for s in output_ignore_regexes])
73 output_ignore_args += ' --exclude=stats.txt --exclude=outdiff'
75 def run_test(target, source, env):
76 """Check output from running test.
78 Targets are as follows:
83 source[1] : tests/run.py script
84 source[2] : reference stats file
87 # make sure target files are all gone
89 if os.path.exists(t.abspath):
90 Execute(Delete(t.abspath))
92 tgt_dir = os.path.dirname(str(target[0]))
94 # Base command for running test. We mess around with indirectly
95 # referring to files via SOURCES and TARGETS so that scons can mess
96 # with paths all it wants to and we still get the right files.
97 cmd = '${SOURCES[0]} -d %s -re ${SOURCES[1]} %s' % (tgt_dir, tgt_dir)
99 # Prefix test run with batch job submission command if appropriate.
100 # Batch command also supports timeout arg (in seconds, not minutes).
101 timeout = 15 * 60 # used to be a param, probably should be again
103 cmd = '%s -t %d %s' % (env['BATCH_CMD'], timeout, cmd)
105 status = Execute(env.subst(cmd, target=target, source=source))
107 # M5 terminated normally.
108 # Run diff on output & ref directories to find differences.
109 # Exclude the stats file since we will use diff-out on that.
110 outdiff = os.path.join(tgt_dir, 'outdiff')
111 diffcmd = 'diff -ubr %s ${SOURCES[2].dir} %s > %s' \
112 % (output_ignore_args, tgt_dir, outdiff)
113 Execute(env.subst(diffcmd, target=target, source=source))
114 print "===== Output differences ====="
115 print contents(outdiff)
116 # Run diff-out on stats.txt file
117 statsdiff = os.path.join(tgt_dir, 'statsdiff')
118 diffcmd = '$DIFFOUT ${SOURCES[2]} %s > %s' \
119 % (os.path.join(tgt_dir, 'stats.txt'), statsdiff)
120 diffcmd = env.subst(diffcmd, target=target, source=source)
121 status = Execute(diffcmd, strfunction=None)
122 print "===== Statistics differences ====="
123 print contents(statsdiff)
125 else: # m5 exit status != 0
126 # M5 did not terminate properly, so no need to check the output
127 if signaled(status) and signum(status) in retry_signals:
128 # Consider the test incomplete; don't create a 'status' output.
129 # Hand the return status to scons and let scons decide what
130 # to do about it (typically terminate unless run with -k).
131 print 'M5 terminated with signal', signum(status)
133 # complete but failed execution (call to exit() with non-zero
134 # status, SIGABORT due to assertion failure, etc.)... fall through
135 # and generate FAILED status as if output comparison had failed
136 print 'M5 exited with non-zero status', status
138 # Generate status file contents based on exit status of m5 or diff-out
140 status_str = "passed."
142 status_str = "FAILED!"
143 f = file(str(target[0]), 'w')
144 print >>f, tgt_dir, status_str
149 def run_test_string(target, source, env):
150 return env.subst("Running test in ${TARGETS[0].dir}.",
151 target=target, source=source)
153 testAction = env.Action(run_test, run_test_string)
155 def print_test(target, source, env):
156 print '***** ' + contents(source[0])
159 printAction = env.Action(print_test, strfunction = None)
161 # Static vars for update_test:
162 # - long-winded message about ignored sources
164 Note: The following file(s) will not be copied. New non-standard
165 output files must be copied manually once before update_ref will
166 recognize them as outputs. Otherwise they are assumed to be
167 inputs and are ignored.
169 # - reference files always needed
170 needed_files = set(['simout', 'simerr', 'stats.txt', 'config.ini'])
171 # - source files we always want to ignore
172 known_ignores = set(['status', 'outdiff', 'statsdiff'])
174 def update_test(target, source, env):
175 """Update reference test outputs.
177 Target is phony. First two sources are the ref & new stats.txt file
178 files, respectively. We actually copy everything in the
179 respective directories except the status & diff output files.
182 dest_dir = str(source[0].get_dir())
183 src_dir = str(source[1].get_dir())
184 dest_files = set(os.listdir(dest_dir))
185 src_files = set(os.listdir(src_dir))
186 # Copy all of the required files plus any existing dest files.
187 wanted_files = needed_files | dest_files
188 missing_files = wanted_files - src_files
189 if len(missing_files) > 0:
190 print " WARNING: the following file(s) are missing " \
191 "and will not be updated:"
192 print " ", " ,".join(missing_files)
193 copy_files = wanted_files - missing_files
194 warn_ignored_files = (src_files - copy_files) - known_ignores
195 if len(warn_ignored_files) > 0:
197 print " ", ", ".join(warn_ignored_files)
200 print " Replacing file", f
203 print " Creating new file", f
204 copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
205 copyAction.strfunction = None
209 def update_test_string(target, source, env):
210 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
211 target=target, source=source)
213 updateAction = env.Action(update_test, update_test_string)
215 def test_builder(env, ref_dir):
218 (category, name, _ref, isa, opsys, config) = ref_dir.split('/')
219 assert(_ref == 'ref')
221 # target path (where test output goes) is the same except without
222 # the 'ref' component
223 tgt_dir = os.path.join(category, name, isa, opsys, config)
225 # prepend file name with tgt_dir
227 return os.path.join(tgt_dir, f)
229 ref_stats = os.path.join(ref_dir, 'stats.txt')
230 new_stats = tgt('stats.txt')
231 status_file = tgt('status')
233 env.Command([status_file],
234 [env.M5Binary, 'run.py', ref_stats],
237 # phony target to echo status
238 if env['update_ref']:
239 p = env.Command(tgt('_update'),
240 [ref_stats, new_stats, status_file],
243 p = env.Command(tgt('_print'), [status_file], printAction)
248 # Figure out applicable configs based on build type
250 if env['FULL_SYSTEM']:
251 if env['TARGET_ISA'] == 'alpha':
252 if not env['ALPHA_TLASER']:
253 configs += ['tsunami-simple-atomic',
254 'tsunami-simple-timing',
255 'tsunami-simple-atomic-dual',
256 'tsunami-simple-timing-dual',
257 'twosys-tsunami-simple-atomic',
258 'tsunami-o3', 'tsunami-o3-dual']
259 if env['TARGET_ISA'] == 'sparc':
260 configs += ['t1000-simple-atomic',
261 't1000-simple-timing']
264 configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest',
265 'simple-atomic-mp', 'simple-timing-mp']
268 os.chdir(str(Dir('.').srcdir))
269 for config in configs:
270 dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))