1# -*- mode:python -*-
2
3# Copyright (c) 2004-2006 The Regents of The University of Michigan
4# All rights reserved.
5#
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.
16#
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.
28#
29# Authors: Steve Reinhardt
30# Kevin Lim
31
32import os, signal
33import sys, time
34import glob
35from SCons.Script.SConscript import SConsEnvironment
36
37Import('env')
38
39env['DIFFOUT'] = File('diff-out')
40
41# Dict that accumulates lists of tests by category (quick, medium, long)
42env.Tests = {}
43
44def contents(node):
45 return file(str(node)).read()
46
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.
49def signaled(status):
50 return (status & 0x80) != 0;
51
52def signum(status):
53 return (status & 0x7f);
54
55# List of signals that indicate that we should retry the test rather
56# than consider it failed.
57retry_signals = (signal.SIGTERM, signal.SIGKILL, signal.SIGINT,
58 signal.SIGQUIT, signal.SIGHUP)
59
60# regular expressions of lines to ignore when diffing outputs
61output_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
69 )
70
71output_ignore_args = ' '.join(["-I '"+s+"'" for s in output_ignore_regexes])
72
73output_ignore_args += ' --exclude=stats.txt --exclude=outdiff'
74
75def run_test(target, source, env):
76 """Check output from running test.
77
78 Targets are as follows:
79 target[0] : status
80
81 Sources are:
82 source[0] : M5 binary
83 source[1] : tests/run.py script
84 source[2] : reference stats file
85
86 """
87 # make sure target files are all gone
88 for t in target:
89 if os.path.exists(t.abspath):
90 env.Execute(Delete(t.abspath))
91
92 tgt_dir = os.path.dirname(str(target[0]))
93
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)
98
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
102 if env['BATCH']:
103 cmd = '%s -t %d %s' % (env['BATCH_CMD'], timeout, cmd)
104
105 pre_exec_time = time.time()
106 status = env.Execute(env.subst(cmd, target=target, source=source))
107 if status == 0:
108 # M5 terminated normally.
109 # Run diff on output & ref directories to find differences.
110 # Exclude the stats file since we will use diff-out on that.
111
112 # NFS file systems can be annoying and not have updated yet
113 # wait until we see the file modified
114 statsdiff = os.path.join(tgt_dir, 'statsdiff')
115 m_time = 0
116 nap = 0
117 while m_time < pre_exec_time and nap < 10:
118 try:
119 m_time = os.stat(statsdiff).st_mtime
120 except OSError:
121 pass
122 time.sleep(1)
123 nap += 1
124
125 outdiff = os.path.join(tgt_dir, 'outdiff')
126 # tack 'true' on the end so scons doesn't report diff's
127 # non-zero exit code as a build error
128 diffcmd = 'diff -ubrs %s ${SOURCES[2].dir} %s > %s; true' \
129 % (output_ignore_args, tgt_dir, outdiff)
130 env.Execute(env.subst(diffcmd, target=target, source=source))
131 print "===== Output differences ====="
132 print contents(outdiff)
133 # Run diff-out on stats.txt file
134 diffcmd = '$DIFFOUT ${SOURCES[2]} %s > %s' \
135 % (os.path.join(tgt_dir, 'stats.txt'), statsdiff)
136 diffcmd = env.subst(diffcmd, target=target, source=source)
137 status = env.Execute(diffcmd, strfunction=None)
138 print "===== Statistics differences ====="
139 print contents(statsdiff)
140
141 else: # m5 exit status != 0
142 # M5 did not terminate properly, so no need to check the output
143 if signaled(status):
144 print 'M5 terminated with signal', signum(status)
145 if signum(status) in retry_signals:
146 # Consider the test incomplete; don't create a 'status' output.
147 # Hand the return status to scons and let scons decide what
148 # to do about it (typically terminate unless run with -k).
149 return status
150 else:
151 print 'M5 exited with non-zero status', status
152 # complete but failed execution (call to exit() with non-zero
153 # status, SIGABORT due to assertion failure, etc.)... fall through
154 # and generate FAILED status as if output comparison had failed
155
156 # Generate status file contents based on exit status of m5 or diff-out
157 if status == 0:
158 status_str = "passed."
159 else:
160 status_str = "FAILED!"
161 f = file(str(target[0]), 'w')
162 print >>f, tgt_dir, status_str
163 f.close()
164 # done
165 return 0
166
167def run_test_string(target, source, env):
168 return env.subst("Running test in ${TARGETS[0].dir}.",
169 target=target, source=source)
170
171testAction = env.Action(run_test, run_test_string)
172
173def print_test(target, source, env):
174 print '***** ' + contents(source[0])
175 return 0
176
177printAction = env.Action(print_test, strfunction = None)
178
179# Static vars for update_test:
180# - long-winded message about ignored sources
181ignore_msg = '''
182Note: The following file(s) will not be copied. New non-standard
183 output files must be copied manually once before --update-ref will
184 recognize them as outputs. Otherwise they are assumed to be
185 inputs and are ignored.
186'''
187# - reference files always needed
188needed_files = set(['simout', 'simerr', 'stats.txt', 'config.ini'])
189# - source files we always want to ignore
190known_ignores = set(['status', 'outdiff', 'statsdiff'])
191
192def update_test(target, source, env):
193 """Update reference test outputs.
194
195 Target is phony. First two sources are the ref & new stats.txt file
196 files, respectively. We actually copy everything in the
197 respective directories except the status & diff output files.
198
199 """
200 dest_dir = str(source[0].get_dir())
201 src_dir = str(source[1].get_dir())
202 dest_files = set(os.listdir(dest_dir))
203 src_files = set(os.listdir(src_dir))
204 # Copy all of the required files plus any existing dest files.
205 wanted_files = needed_files | dest_files
206 missing_files = wanted_files - src_files
207 if len(missing_files) > 0:
208 print " WARNING: the following file(s) are missing " \
209 "and will not be updated:"
210 print " ", " ,".join(missing_files)
211 copy_files = wanted_files - missing_files
212 warn_ignored_files = (src_files - copy_files) - known_ignores
213 if len(warn_ignored_files) > 0:
214 print ignore_msg,
215 print " ", ", ".join(warn_ignored_files)
216 for f in copy_files:
217 if f in dest_files:
218 print " Replacing file", f
219 dest_files.remove(f)
220 else:
221 print " Creating new file", f
222 copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
223 copyAction.strfunction = None
224 env.Execute(copyAction)
225 return 0
226
227def update_test_string(target, source, env):
228 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
229 target=target, source=source)
230
231updateAction = env.Action(update_test, update_test_string)
232
233def test_builder(env, ref_dir):
234 """Define a test."""
235
236 (category, mode, name, _ref, isa, opsys, config) = ref_dir.split('/')
237 assert(_ref == 'ref')
238
239 # target path (where test output goes) is the same except without
240 # the 'ref' component
241 tgt_dir = os.path.join(category, mode, name, isa, opsys, config)
242
243 # prepend file name with tgt_dir
244 def tgt(f):
245 return os.path.join(tgt_dir, f)
246
247 ref_stats = os.path.join(ref_dir, 'stats.txt')
248 new_stats = tgt('stats.txt')
249 status_file = tgt('status')
250
251 env.Command([status_file],
252 [env.M5Binary, 'run.py', ref_stats],
253 testAction)
254
255 # phony target to echo status
256 if GetOption('update_ref'):
257 p = env.Command(tgt('_update'),
258 [ref_stats, new_stats, status_file],
259 updateAction)
260 else:
261 p = env.Command(tgt('_print'), [status_file], printAction)
262
263 env.AlwaysBuild(p)
264
265
266# Figure out applicable configs based on build type
267configs = []
268if env['TARGET_ISA'] == 'alpha':
269 configs += ['tsunami-simple-atomic',
270 'tsunami-simple-timing',
271 'tsunami-simple-atomic-dual',
272 'tsunami-simple-timing-dual',
273 'twosys-tsunami-simple-atomic',
274 'tsunami-o3', 'tsunami-o3-dual',
275 'tsunami-inorder']
276if env['TARGET_ISA'] == 'sparc':
277 configs += ['t1000-simple-atomic',
278 't1000-simple-timing']
279if env['TARGET_ISA'] == 'arm':
280 configs += ['simple-atomic-dummychecker',
281 'o3-timing-checker',
282 'realview-simple-atomic',
283 'realview-simple-atomic-dual',
284 'realview-simple-timing',
285 'realview-simple-timing-dual',
286 'realview-o3',
287 'realview-o3-checker',
288 'realview-o3-dual']
289if env['TARGET_ISA'] == 'x86':
290 configs += ['pc-simple-atomic',
291 'pc-simple-timing',
292 'pc-o3-timing']
293
294configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest',
295 'simple-atomic-mp', 'simple-timing-mp', 'o3-timing-mp',
296 'inorder-timing', 'rubytest']
297
298if env['PROTOCOL'] != 'None':
299 if env['PROTOCOL'] == 'MI_example':
300 configs += [c + "-ruby" for c in configs]
301 else:
302 configs = [c + "-ruby-" + env['PROTOCOL'] for c in configs]
303
304cwd = os.getcwd()
305os.chdir(str(Dir('.').srcdir))
306for config in configs:
307 dirs = glob.glob('*/*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
308 for d in dirs:
309 if not os.path.exists(os.path.join(d, 'skip')):
310 test_builder(env, d)
311os.chdir(cwd)