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
| 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
| 32import os, signal
|
33import sys
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
| 33import sys
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
|
47def check_test(target, source, env):
| 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):
|
48 """Check output from running test.
49
50 Targets are as follows:
| 76 """Check output from running test.
77
78 Targets are as follows:
|
51 target[0] : outdiff
52 target[1] : statsdiff
53 target[2] : status
| 79 target[0] : status
|
54
| 80
|
| 81 Sources are:
82 source[0] : M5 binary
83 source[1] : tests/run.py script
84 source[2] : reference stats file
85
|
55 """
56 # make sure target files are all gone
57 for t in target:
58 if os.path.exists(t.abspath):
59 Execute(Delete(t.abspath))
| 86 """
87 # make sure target files are all gone
88 for t in target:
89 if os.path.exists(t.abspath):
90 Execute(Delete(t.abspath))
|
60 # Run diff on output & ref directories to find differences.
61 # Exclude the stats file since we will use diff-out on that.
62 Execute(env.subst('diff -ubr ${SOURCES[0].dir} ${SOURCES[1].dir} ' +
63 '-I "^command line:" ' + # for stdout file
64 '-I "^M5 compiled " ' + # for stderr file
65 '-I "^M5 started " ' + # for stderr file
66 '-I "^M5 executing on " ' + # for stderr file
67 '-I "^Simulation complete at" ' + # for stderr file
68 '-I "^Listening for" ' + # for stderr file
69 '-I "listening for remote gdb" ' + # for stderr file
70 '--exclude=stats.txt --exclude=SCCS ' +
71 '--exclude=${TARGETS[0].file} ' +
72 '> ${TARGETS[0]}', target=target, source=source), None)
73 print "===== Output differences ====="
74 print contents(target[0])
75 # Run diff-out on stats.txt file
76 status = Execute(env.subst('$DIFFOUT $SOURCES > ${TARGETS[1]}',
77 target=target, source=source),
78 strfunction=None)
79 print "===== Statistics differences ====="
80 print contents(target[1])
81 # Generate status file contents based on exit status of diff-out
| 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 status = Execute(env.subst(cmd, target=target, source=source))
|
82 if status == 0:
| 106 if status == 0:
|
| 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)
124
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)
132 return 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
137
138 # Generate status file contents based on exit status of m5 or diff-out
139 if status == 0:
|
83 status_str = "passed."
84 else:
85 status_str = "FAILED!"
| 140 status_str = "passed."
141 else:
142 status_str = "FAILED!"
|
86 f = file(str(target[2]), 'w')
87 print >>f, env.subst('${TARGETS[2].dir}', target=target, source=source), \
88 status_str
| 143 f = file(str(target[0]), 'w')
144 print >>f, tgt_dir, status_str
|
89 f.close()
90 # done
91 return 0
92
| 145 f.close()
146 # done
147 return 0
148
|
93def check_test_string(target, source, env):
94 return env.subst("Comparing outputs in ${TARGETS[0].dir}.",
| 149def run_test_string(target, source, env):
150 return env.subst("Running test in ${TARGETS[0].dir}.",
|
95 target=target, source=source)
96
| 151 target=target, source=source)
152
|
97testAction = env.Action(check_test, check_test_string)
| 153testAction = env.Action(run_test, run_test_string)
|
98
99def print_test(target, source, env):
100 print '***** ' + contents(source[0])
101 return 0
102
103printAction = env.Action(print_test, strfunction = None)
104
105# Static vars for update_test:
106# - long-winded message about ignored sources
107ignore_msg = '''
108Note: The following file(s) will not be copied. New non-standard
109 output files must be copied manually once before update_ref will
110 recognize them as outputs. Otherwise they are assumed to be
111 inputs and are ignored.
112'''
113# - reference files always needed
114needed_files = set(['simout', 'simerr', 'stats.txt', 'config.ini'])
115# - source files we always want to ignore
116known_ignores = set(['status', 'outdiff', 'statsdiff'])
117
118def update_test(target, source, env):
119 """Update reference test outputs.
120
121 Target is phony. First two sources are the ref & new stats.txt file
122 files, respectively. We actually copy everything in the
123 respective directories except the status & diff output files.
124
125 """
126 dest_dir = str(source[0].get_dir())
127 src_dir = str(source[1].get_dir())
128 dest_files = set(os.listdir(dest_dir))
129 src_files = set(os.listdir(src_dir))
130 # Copy all of the required files plus any existing dest files.
131 wanted_files = needed_files | dest_files
132 missing_files = wanted_files - src_files
133 if len(missing_files) > 0:
134 print " WARNING: the following file(s) are missing " \
135 "and will not be updated:"
136 print " ", " ,".join(missing_files)
137 copy_files = wanted_files - missing_files
138 warn_ignored_files = (src_files - copy_files) - known_ignores
139 if len(warn_ignored_files) > 0:
140 print ignore_msg,
141 print " ", ", ".join(warn_ignored_files)
142 for f in copy_files:
143 if f in dest_files:
144 print " Replacing file", f
145 dest_files.remove(f)
146 else:
147 print " Creating new file", f
148 copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
149 copyAction.strfunction = None
150 Execute(copyAction)
151 return 0
152
153def update_test_string(target, source, env):
154 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
155 target=target, source=source)
156
157updateAction = env.Action(update_test, update_test_string)
158
159def test_builder(env, ref_dir):
160 """Define a test."""
161
162 (category, name, _ref, isa, opsys, config) = ref_dir.split('/')
163 assert(_ref == 'ref')
164
165 # target path (where test output goes) is the same except without
166 # the 'ref' component
167 tgt_dir = os.path.join(category, name, isa, opsys, config)
168
169 # prepend file name with tgt_dir
170 def tgt(f):
171 return os.path.join(tgt_dir, f)
172
173 ref_stats = os.path.join(ref_dir, 'stats.txt')
174 new_stats = tgt('stats.txt')
175 status_file = tgt('status')
176
| 154
155def print_test(target, source, env):
156 print '***** ' + contents(source[0])
157 return 0
158
159printAction = env.Action(print_test, strfunction = None)
160
161# Static vars for update_test:
162# - long-winded message about ignored sources
163ignore_msg = '''
164Note: 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.
168'''
169# - reference files always needed
170needed_files = set(['simout', 'simerr', 'stats.txt', 'config.ini'])
171# - source files we always want to ignore
172known_ignores = set(['status', 'outdiff', 'statsdiff'])
173
174def update_test(target, source, env):
175 """Update reference test outputs.
176
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.
180
181 """
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:
196 print ignore_msg,
197 print " ", ", ".join(warn_ignored_files)
198 for f in copy_files:
199 if f in dest_files:
200 print " Replacing file", f
201 dest_files.remove(f)
202 else:
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
206 Execute(copyAction)
207 return 0
208
209def update_test_string(target, source, env):
210 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
211 target=target, source=source)
212
213updateAction = env.Action(update_test, update_test_string)
214
215def test_builder(env, ref_dir):
216 """Define a test."""
217
218 (category, name, _ref, isa, opsys, config) = ref_dir.split('/')
219 assert(_ref == 'ref')
220
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)
224
225 # prepend file name with tgt_dir
226 def tgt(f):
227 return os.path.join(tgt_dir, f)
228
229 ref_stats = os.path.join(ref_dir, 'stats.txt')
230 new_stats = tgt('stats.txt')
231 status_file = tgt('status')
232
|
177 # Base command for running test. We mess around with indirectly
178 # referring to files via SOURCES and TARGETS so that scons can
179 # mess with paths all it wants to and we still get the right
180 # files.
181 cmd = '${SOURCES[0]} -d $TARGET.dir -re ${SOURCES[1]} %s' % tgt_dir
182
183 # Prefix test run with batch job submission command if appropriate.
184 # Batch command also supports timeout arg (in seconds, not minutes).
185 timeout = 15 * 60 # used to be a param, probably should be again
186 if env['BATCH']:
187 cmd = '%s -t %d %s' % (env['BATCH_CMD'], timeout, cmd)
188
189 env.Command([tgt('simout'), tgt('simerr'), new_stats],
190 [env.M5Binary, 'run.py'], cmd)
191
192 # order of targets is important... see check_test
193 env.Command([tgt('outdiff'), tgt('statsdiff'), status_file],
194 [ref_stats, new_stats],
| 233 env.Command([status_file],
234 [env.M5Binary, 'run.py', ref_stats],
|
195 testAction)
196
197 # phony target to echo status
198 if env['update_ref']:
199 p = env.Command(tgt('_update'),
200 [ref_stats, new_stats, status_file],
201 updateAction)
202 else:
203 p = env.Command(tgt('_print'), [status_file], printAction)
204
205 env.AlwaysBuild(p)
206
207
208# Figure out applicable configs based on build type
209configs = []
210if env['FULL_SYSTEM']:
211 if env['TARGET_ISA'] == 'alpha':
212 if not env['ALPHA_TLASER']:
213 configs += ['tsunami-simple-atomic',
214 'tsunami-simple-timing',
215 'tsunami-simple-atomic-dual',
216 'tsunami-simple-timing-dual',
217 'twosys-tsunami-simple-atomic',
218 'tsunami-o3', 'tsunami-o3-dual']
219 if env['TARGET_ISA'] == 'sparc':
220 configs += ['t1000-simple-atomic',
221 't1000-simple-timing']
222
223else:
224 configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest',
225 'simple-atomic-mp', 'simple-timing-mp']
226
227cwd = os.getcwd()
228os.chdir(str(Dir('.').srcdir))
229for config in configs:
230 dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
231 for d in dirs:
232 test_builder(env, d)
233os.chdir(cwd)
| 235 testAction)
236
237 # phony target to echo status
238 if env['update_ref']:
239 p = env.Command(tgt('_update'),
240 [ref_stats, new_stats, status_file],
241 updateAction)
242 else:
243 p = env.Command(tgt('_print'), [status_file], printAction)
244
245 env.AlwaysBuild(p)
246
247
248# Figure out applicable configs based on build type
249configs = []
250if 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']
262
263else:
264 configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest',
265 'simple-atomic-mp', 'simple-timing-mp']
266
267cwd = os.getcwd()
268os.chdir(str(Dir('.').srcdir))
269for config in configs:
270 dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
271 for d in dirs:
272 test_builder(env, d)
273os.chdir(cwd)
|