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 # get the termcap from the environment
42 termcap = env['TERMCAP']
44 # Dict that accumulates lists of tests by category (quick, medium, long)
48 return file(str(node)).read()
50 # functions to parse return value from scons Execute()... not the same
51 # as wait() etc., so python built-in os funcs don't work.
53 return (status & 0x80) != 0;
56 return (status & 0x7f);
58 # List of signals that indicate that we should retry the test rather
59 # than consider it failed.
60 retry_signals = (signal.SIGTERM, signal.SIGKILL, signal.SIGINT,
61 signal.SIGQUIT, signal.SIGHUP)
63 # regular expressions of lines to ignore when diffing outputs
64 output_ignore_regexes = (
65 '^command line:', # for stdout file
66 '^gem5 compiled ', # for stderr file
67 '^gem5 started ', # for stderr file
68 '^gem5 executing on ', # for stderr file
69 '^Simulation complete at', # for stderr file
70 '^Listening for', # for stderr file
71 'listening for remote gdb', # for stderr file
74 output_ignore_args = ' '.join(["-I '"+s+"'" for s in output_ignore_regexes])
76 output_ignore_args += ' --exclude=stats.txt --exclude=outdiff'
78 def run_test(target, source, env):
79 """Check output from running test.
81 Targets are as follows:
85 source[0] : gem5 binary
86 source[1] : tests/run.py script
87 source[2] : reference stats file
90 # make sure target files are all gone
92 if os.path.exists(t.abspath):
93 env.Execute(Delete(t.abspath))
95 tgt_dir = os.path.dirname(str(target[0]))
97 # Base command for running test. We mess around with indirectly
98 # referring to files via SOURCES and TARGETS so that scons can mess
99 # with paths all it wants to and we still get the right files.
100 cmd = '${SOURCES[0]} -d %s -re ${SOURCES[1]} %s' % (tgt_dir, tgt_dir)
102 # Prefix test run with batch job submission command if appropriate.
103 # Batch command also supports timeout arg (in seconds, not minutes).
104 timeout = 15 * 60 # used to be a param, probably should be again
106 cmd = '%s -t %d %s' % (env['BATCH_CMD'], timeout, cmd)
108 # Create a default value for the status string, changed as needed
109 # based on the status.
110 status_str = "passed."
112 pre_exec_time = time.time()
113 status = env.Execute(env.subst(cmd, target=target, source=source))
115 # gem5 terminated normally.
116 # Run diff on output & ref directories to find differences.
117 # Exclude the stats file since we will use diff-out on that.
119 # NFS file systems can be annoying and not have updated yet
120 # wait until we see the file modified
121 statsdiff = os.path.join(tgt_dir, 'statsdiff')
124 while m_time < pre_exec_time and nap < 10:
126 m_time = os.stat(statsdiff).st_mtime
132 outdiff = os.path.join(tgt_dir, 'outdiff')
133 # tack 'true' on the end so scons doesn't report diff's
134 # non-zero exit code as a build error
135 diffcmd = 'diff -ubrs %s ${SOURCES[2].dir} %s > %s; true' \
136 % (output_ignore_args, tgt_dir, outdiff)
137 env.Execute(env.subst(diffcmd, target=target, source=source))
138 print "===== Output differences ====="
139 print contents(outdiff)
140 # Run diff-out on stats.txt file
141 diffcmd = '$DIFFOUT ${SOURCES[2]} %s > %s' \
142 % (os.path.join(tgt_dir, 'stats.txt'), statsdiff)
143 diffcmd = env.subst(diffcmd, target=target, source=source)
144 diff_status = env.Execute(diffcmd, strfunction=None)
145 # If there is a difference, change the status string to say so
147 status_str = "CHANGED!"
148 print "===== Statistics differences ====="
149 print contents(statsdiff)
151 else: # gem5 exit status != 0
152 # Consider it a failed test unless the exit status is 2
153 status_str = "FAILED!"
154 # gem5 did not terminate properly, so no need to check the output
156 print 'gem5 terminated with signal', signum(status)
157 if signum(status) in retry_signals:
158 # Consider the test incomplete; don't create a 'status' output.
159 # Hand the return status to scons and let scons decide what
160 # to do about it (typically terminate unless run with -k).
163 # The test was skipped, change the status string to say so
164 status_str = "skipped."
166 print 'gem5 exited with non-zero status', status
167 # complete but failed execution (call to exit() with non-zero
168 # status, SIGABORT due to assertion failure, etc.)... fall through
169 # and generate FAILED status as if output comparison had failed
171 # Generate status file contents based on exit status of gem5 and diff-out
172 f = file(str(target[0]), 'w')
173 print >>f, tgt_dir, status_str
178 def run_test_string(target, source, env):
179 return env.subst("Running test in ${TARGETS[0].dir}.",
180 target=target, source=source)
182 testAction = env.Action(run_test, run_test_string)
184 def print_test(target, source, env):
185 # print the status with colours to make it easier to see what
186 # passed and what failed
187 line = contents(source[0])
189 # split the line to words and get the last one
193 # if the test failed make it red, if it passed make it green, and
194 # skip the punctuation
195 if status == "FAILED!":
196 status = termcap.Red + status[:-1] + termcap.Normal + status[-1]
197 elif status == "CHANGED!":
198 status = termcap.Yellow + status[:-1] + termcap.Normal + status[-1]
199 elif status == "passed.":
200 status = termcap.Green + status[:-1] + termcap.Normal + status[-1]
201 elif status == "skipped.":
202 status = termcap.Cyan + status[:-1] + termcap.Normal + status[-1]
204 # put it back in the list and join with space
206 line = " ".join(words)
208 print '***** ' + line
211 printAction = env.Action(print_test, strfunction = None)
213 # Static vars for update_test:
214 # - long-winded message about ignored sources
216 Note: The following file(s) will not be copied. New non-standard
217 output files must be copied manually once before --update-ref will
218 recognize them as outputs. Otherwise they are assumed to be
219 inputs and are ignored.
221 # - reference files always needed
222 needed_files = set(['simout', 'simerr', 'stats.txt', 'config.ini'])
223 # - source files we always want to ignore
224 known_ignores = set(['status', 'outdiff', 'statsdiff'])
226 def update_test(target, source, env):
227 """Update reference test outputs.
229 Target is phony. First two sources are the ref & new stats.txt file
230 files, respectively. We actually copy everything in the
231 respective directories except the status & diff output files.
234 dest_dir = str(source[0].get_dir())
235 src_dir = str(source[1].get_dir())
236 dest_files = set(os.listdir(dest_dir))
237 src_files = set(os.listdir(src_dir))
238 # Copy all of the required files plus any existing dest files.
239 wanted_files = needed_files | dest_files
240 missing_files = wanted_files - src_files
241 if len(missing_files) > 0:
242 print " WARNING: the following file(s) are missing " \
243 "and will not be updated:"
244 print " ", " ,".join(missing_files)
245 copy_files = wanted_files - missing_files
246 warn_ignored_files = (src_files - copy_files) - known_ignores
247 if len(warn_ignored_files) > 0:
249 print " ", ", ".join(warn_ignored_files)
252 print " Replacing file", f
255 print " Creating new file", f
256 copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
257 copyAction.strfunction = None
258 env.Execute(copyAction)
261 def update_test_string(target, source, env):
262 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
263 target=target, source=source)
265 updateAction = env.Action(update_test, update_test_string)
267 def test_builder(env, ref_dir):
270 (category, mode, name, _ref, isa, opsys, config) = ref_dir.split('/')
271 assert(_ref == 'ref')
273 # target path (where test output goes) is the same except without
274 # the 'ref' component
275 tgt_dir = os.path.join(category, mode, name, isa, opsys, config)
277 # prepend file name with tgt_dir
279 return os.path.join(tgt_dir, f)
281 ref_stats = os.path.join(ref_dir, 'stats.txt')
282 new_stats = tgt('stats.txt')
283 status_file = tgt('status')
285 env.Command([status_file, new_stats],
286 [env.M5Binary, 'run.py', ref_stats],
289 # phony target to echo status
290 if GetOption('update_ref'):
291 p = env.Command(tgt('_update'),
292 [ref_stats, new_stats, status_file],
295 p = env.Command(tgt('_print'), [status_file], printAction)
300 # Figure out applicable configs based on build type
302 if env['TARGET_ISA'] == 'alpha':
303 configs += ['tsunami-simple-atomic',
304 'tsunami-simple-timing',
305 'tsunami-simple-atomic-dual',
306 'tsunami-simple-timing-dual',
307 'twosys-tsunami-simple-atomic',
308 'tsunami-o3', 'tsunami-o3-dual',
310 'tsunami-switcheroo-full']
311 if env['TARGET_ISA'] == 'sparc':
312 configs += ['t1000-simple-atomic',
313 't1000-simple-timing']
314 if env['TARGET_ISA'] == 'arm':
315 configs += ['simple-atomic-dummychecker',
317 'realview-simple-atomic',
318 'realview-simple-atomic-dual',
319 'realview-simple-timing',
320 'realview-simple-timing-dual',
322 'realview-o3-checker',
324 'realview-switcheroo-atomic',
325 'realview-switcheroo-timing',
326 'realview-switcheroo-o3',
327 'realview-switcheroo-full']
328 if env['TARGET_ISA'] == 'x86':
329 configs += ['pc-simple-atomic',
332 'pc-switcheroo-full']
334 configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest',
335 'simple-atomic-mp', 'simple-timing-mp', 'o3-timing-mp',
336 'inorder-timing', 'rubytest', 'tgen-simple-mem',
339 if env['PROTOCOL'] != 'None':
340 if env['PROTOCOL'] == 'MI_example':
341 configs += [c + "-ruby" for c in configs]
343 configs = [c + "-ruby-" + env['PROTOCOL'] for c in configs]
346 os.chdir(str(Dir('.').srcdir))
347 for config in configs:
348 dirs = glob.glob('*/*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
350 if not os.path.exists(os.path.join(d, 'skip')):