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
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 status = env.Execute(env.subst(cmd, target=target, source=source))
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 env.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 = env.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):
128 print 'M5 terminated with signal', signum(status)
129 if signum(status) in retry_signals:
130 # Consider the test incomplete; don't create a 'status' output.
131 # Hand the return status to scons and let scons decide what
132 # to do about it (typically terminate unless run with -k).
133 return status
134 else:
135 print 'M5 exited with non-zero status', status
136 # complete but failed execution (call to exit() with non-zero
137 # status, SIGABORT due to assertion failure, etc.)... fall through
138 # and generate FAILED status as if output comparison had failed
139
140 # Generate status file contents based on exit status of m5 or diff-out
141 if status == 0:
142 status_str = "passed."
143 else:
144 status_str = "FAILED!"
145 f = file(str(target[0]), 'w')
146 print >>f, tgt_dir, status_str
147 f.close()
148 # done
149 return 0
150
151def run_test_string(target, source, env):
152 return env.subst("Running test in ${TARGETS[0].dir}.",
153 target=target, source=source)
154
155testAction = env.Action(run_test, run_test_string)
156
157def print_test(target, source, env):
158 print '***** ' + contents(source[0])
159 return 0
160
161printAction = env.Action(print_test, strfunction = None)
162
163# Static vars for update_test:
164# - long-winded message about ignored sources
165ignore_msg = '''
166Note: The following file(s) will not be copied. New non-standard
167 output files must be copied manually once before update_ref will
168 recognize them as outputs. Otherwise they are assumed to be
169 inputs and are ignored.
170'''
171# - reference files always needed
172needed_files = set(['simout', 'simerr', 'stats.txt', 'config.ini'])
173# - source files we always want to ignore
174known_ignores = set(['status', 'outdiff', 'statsdiff'])
175
176def update_test(target, source, env):
177 """Update reference test outputs.
178
179 Target is phony. First two sources are the ref & new stats.txt file
180 files, respectively. We actually copy everything in the
181 respective directories except the status & diff output files.
182
183 """
184 dest_dir = str(source[0].get_dir())
185 src_dir = str(source[1].get_dir())
186 dest_files = set(os.listdir(dest_dir))
187 src_files = set(os.listdir(src_dir))
188 # Copy all of the required files plus any existing dest files.
189 wanted_files = needed_files | dest_files
190 missing_files = wanted_files - src_files
191 if len(missing_files) > 0:
192 print " WARNING: the following file(s) are missing " \
193 "and will not be updated:"
194 print " ", " ,".join(missing_files)
195 copy_files = wanted_files - missing_files
196 warn_ignored_files = (src_files - copy_files) - known_ignores
197 if len(warn_ignored_files) > 0:
198 print ignore_msg,
199 print " ", ", ".join(warn_ignored_files)
200 for f in copy_files:
201 if f in dest_files:
202 print " Replacing file", f
203 dest_files.remove(f)
204 else:
205 print " Creating new file", f
206 copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
207 copyAction.strfunction = None
208 env.Execute(copyAction)
209 return 0
210
211def update_test_string(target, source, env):
212 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
213 target=target, source=source)
214
215updateAction = env.Action(update_test, update_test_string)
216
217def test_builder(env, ref_dir):
218 """Define a test."""
219
220 (category, name, _ref, isa, opsys, config) = ref_dir.split('/')
221 assert(_ref == 'ref')
222
223 # target path (where test output goes) is the same except without
224 # the 'ref' component
225 tgt_dir = os.path.join(category, name, isa, opsys, config)
226
227 # prepend file name with tgt_dir
228 def tgt(f):
229 return os.path.join(tgt_dir, f)
230
231 ref_stats = os.path.join(ref_dir, 'stats.txt')
232 new_stats = tgt('stats.txt')
233 status_file = tgt('status')
234
235 env.Command([status_file],
236 [env.M5Binary, 'run.py', ref_stats],
237 testAction)
238
239 # phony target to echo status
240 if env['update_ref']:
241 p = env.Command(tgt('_update'),
242 [ref_stats, new_stats, status_file],
243 updateAction)
244 else:
245 p = env.Command(tgt('_print'), [status_file], printAction)
246
247 env.AlwaysBuild(p)
248
249
250# Figure out applicable configs based on build type
251configs = []
252if env['FULL_SYSTEM']:
253 if env['TARGET_ISA'] == 'alpha':
254 configs += ['tsunami-simple-atomic',
255 'tsunami-simple-timing',
256 'tsunami-simple-atomic-dual',
257 'tsunami-simple-timing-dual',
258 'twosys-tsunami-simple-atomic',
259 'tsunami-o3', 'tsunami-o3-dual']
260 if env['TARGET_ISA'] == 'sparc':
261 configs += ['t1000-simple-atomic',
262 't1000-simple-timing']
263
264else:
265 configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest',
266 'simple-atomic-mp', 'simple-timing-mp', 'o3-timing-mp']
267
| 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
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 status = env.Execute(env.subst(cmd, target=target, source=source))
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 env.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 = env.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):
128 print 'M5 terminated with signal', signum(status)
129 if signum(status) in retry_signals:
130 # Consider the test incomplete; don't create a 'status' output.
131 # Hand the return status to scons and let scons decide what
132 # to do about it (typically terminate unless run with -k).
133 return status
134 else:
135 print 'M5 exited with non-zero status', status
136 # complete but failed execution (call to exit() with non-zero
137 # status, SIGABORT due to assertion failure, etc.)... fall through
138 # and generate FAILED status as if output comparison had failed
139
140 # Generate status file contents based on exit status of m5 or diff-out
141 if status == 0:
142 status_str = "passed."
143 else:
144 status_str = "FAILED!"
145 f = file(str(target[0]), 'w')
146 print >>f, tgt_dir, status_str
147 f.close()
148 # done
149 return 0
150
151def run_test_string(target, source, env):
152 return env.subst("Running test in ${TARGETS[0].dir}.",
153 target=target, source=source)
154
155testAction = env.Action(run_test, run_test_string)
156
157def print_test(target, source, env):
158 print '***** ' + contents(source[0])
159 return 0
160
161printAction = env.Action(print_test, strfunction = None)
162
163# Static vars for update_test:
164# - long-winded message about ignored sources
165ignore_msg = '''
166Note: The following file(s) will not be copied. New non-standard
167 output files must be copied manually once before update_ref will
168 recognize them as outputs. Otherwise they are assumed to be
169 inputs and are ignored.
170'''
171# - reference files always needed
172needed_files = set(['simout', 'simerr', 'stats.txt', 'config.ini'])
173# - source files we always want to ignore
174known_ignores = set(['status', 'outdiff', 'statsdiff'])
175
176def update_test(target, source, env):
177 """Update reference test outputs.
178
179 Target is phony. First two sources are the ref & new stats.txt file
180 files, respectively. We actually copy everything in the
181 respective directories except the status & diff output files.
182
183 """
184 dest_dir = str(source[0].get_dir())
185 src_dir = str(source[1].get_dir())
186 dest_files = set(os.listdir(dest_dir))
187 src_files = set(os.listdir(src_dir))
188 # Copy all of the required files plus any existing dest files.
189 wanted_files = needed_files | dest_files
190 missing_files = wanted_files - src_files
191 if len(missing_files) > 0:
192 print " WARNING: the following file(s) are missing " \
193 "and will not be updated:"
194 print " ", " ,".join(missing_files)
195 copy_files = wanted_files - missing_files
196 warn_ignored_files = (src_files - copy_files) - known_ignores
197 if len(warn_ignored_files) > 0:
198 print ignore_msg,
199 print " ", ", ".join(warn_ignored_files)
200 for f in copy_files:
201 if f in dest_files:
202 print " Replacing file", f
203 dest_files.remove(f)
204 else:
205 print " Creating new file", f
206 copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
207 copyAction.strfunction = None
208 env.Execute(copyAction)
209 return 0
210
211def update_test_string(target, source, env):
212 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
213 target=target, source=source)
214
215updateAction = env.Action(update_test, update_test_string)
216
217def test_builder(env, ref_dir):
218 """Define a test."""
219
220 (category, name, _ref, isa, opsys, config) = ref_dir.split('/')
221 assert(_ref == 'ref')
222
223 # target path (where test output goes) is the same except without
224 # the 'ref' component
225 tgt_dir = os.path.join(category, name, isa, opsys, config)
226
227 # prepend file name with tgt_dir
228 def tgt(f):
229 return os.path.join(tgt_dir, f)
230
231 ref_stats = os.path.join(ref_dir, 'stats.txt')
232 new_stats = tgt('stats.txt')
233 status_file = tgt('status')
234
235 env.Command([status_file],
236 [env.M5Binary, 'run.py', ref_stats],
237 testAction)
238
239 # phony target to echo status
240 if env['update_ref']:
241 p = env.Command(tgt('_update'),
242 [ref_stats, new_stats, status_file],
243 updateAction)
244 else:
245 p = env.Command(tgt('_print'), [status_file], printAction)
246
247 env.AlwaysBuild(p)
248
249
250# Figure out applicable configs based on build type
251configs = []
252if env['FULL_SYSTEM']:
253 if env['TARGET_ISA'] == 'alpha':
254 configs += ['tsunami-simple-atomic',
255 'tsunami-simple-timing',
256 'tsunami-simple-atomic-dual',
257 'tsunami-simple-timing-dual',
258 'twosys-tsunami-simple-atomic',
259 'tsunami-o3', 'tsunami-o3-dual']
260 if env['TARGET_ISA'] == 'sparc':
261 configs += ['t1000-simple-atomic',
262 't1000-simple-timing']
263
264else:
265 configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest',
266 'simple-atomic-mp', 'simple-timing-mp', 'o3-timing-mp']
267
|