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
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):
48 """Check output from running test.
49
50 Targets are as follows:
51 target[0] : outdiff
52 target[1] : statsdiff
53 target[2] : status
54
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))
60 # Run diff on output & ref directories to find differences.
61 # Exclude m5stats.txt 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 on" ' + # for stderr file
65 '-I "^M5 simulation started" ' + # for stderr file
66 '-I "^Simulation complete at" ' + # for stderr file
67 '-I "^Listening for" ' + # for stderr file
68 '--exclude=m5stats.txt --exclude=SCCS ' +
69 '--exclude=${TARGETS[0].file} ' +
70 '> ${TARGETS[0]}', target=target, source=source), None)
71 print "===== Output differences ====="
72 print contents(target[0])
73 # Run diff-out on m5stats.txt file
74 status = Execute(env.subst('$DIFFOUT $SOURCES > ${TARGETS[1]}',
75 target=target, source=source),
76 strfunction=None)
77 print "===== Statistics differences ====="
78 print contents(target[1])
79 # Generate status file contents based on exit status of diff-out
80 if status == 0:
81 status_str = "passed."
82 else:
83 status_str = "FAILED!"
84 f = file(str(target[2]), 'w')
85 print >>f, env.subst('${TARGETS[2].dir}', target=target, source=source), \
86 status_str
87 f.close()
88 # done
89 return 0
90
91def check_test_string(target, source, env):
92 return env.subst("Comparing outputs in ${TARGETS[0].dir}.",
93 target=target, source=source)
94
95testAction = env.Action(check_test, check_test_string)
96
97def print_test(target, source, env):
98 print '***** ' + contents(source[0])
99 return 0
100
101printAction = env.Action(print_test, strfunction = None)
102
103def update_test(target, source, env):
104 """Update reference test outputs.
105
106 Target is phony. First two sources are the ref & new m5stats.txt
107 files, respectively. We actually copy everything in the
108 respective directories except the status & diff output files.
109
110 """
111 dest_dir = str(source[0].get_dir())
112 src_dir = str(source[1].get_dir())
113 dest_files = os.listdir(dest_dir)
114 src_files = os.listdir(src_dir)
115 # Exclude status & diff outputs
116 for f in ('outdiff', 'statsdiff', 'status'):
117 if f in src_files:
118 src_files.remove(f)
119 for f in src_files:
120 if f in dest_files:
121 print " Replacing file", f
122 dest_files.remove(f)
123 else:
124 print " Creating new file", f
125 copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
126 copyAction.strfunction = None
127 Execute(copyAction)
128 # warn about any files in dest not overwritten (other than SCCS dir)
129 if 'SCCS' in dest_files:
130 dest_files.remove('SCCS')
131 if dest_files:
132 print "Warning: file(s) in", dest_dir, "not updated:",
133 print ', '.join(dest_files)
134 return 0
135
136def update_test_string(target, source, env):
137 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
138 target=target, source=source)
139
140updateAction = env.Action(update_test, update_test_string)
141
| 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
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):
48 """Check output from running test.
49
50 Targets are as follows:
51 target[0] : outdiff
52 target[1] : statsdiff
53 target[2] : status
54
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))
60 # Run diff on output & ref directories to find differences.
61 # Exclude m5stats.txt 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 on" ' + # for stderr file
65 '-I "^M5 simulation started" ' + # for stderr file
66 '-I "^Simulation complete at" ' + # for stderr file
67 '-I "^Listening for" ' + # for stderr file
68 '--exclude=m5stats.txt --exclude=SCCS ' +
69 '--exclude=${TARGETS[0].file} ' +
70 '> ${TARGETS[0]}', target=target, source=source), None)
71 print "===== Output differences ====="
72 print contents(target[0])
73 # Run diff-out on m5stats.txt file
74 status = Execute(env.subst('$DIFFOUT $SOURCES > ${TARGETS[1]}',
75 target=target, source=source),
76 strfunction=None)
77 print "===== Statistics differences ====="
78 print contents(target[1])
79 # Generate status file contents based on exit status of diff-out
80 if status == 0:
81 status_str = "passed."
82 else:
83 status_str = "FAILED!"
84 f = file(str(target[2]), 'w')
85 print >>f, env.subst('${TARGETS[2].dir}', target=target, source=source), \
86 status_str
87 f.close()
88 # done
89 return 0
90
91def check_test_string(target, source, env):
92 return env.subst("Comparing outputs in ${TARGETS[0].dir}.",
93 target=target, source=source)
94
95testAction = env.Action(check_test, check_test_string)
96
97def print_test(target, source, env):
98 print '***** ' + contents(source[0])
99 return 0
100
101printAction = env.Action(print_test, strfunction = None)
102
103def update_test(target, source, env):
104 """Update reference test outputs.
105
106 Target is phony. First two sources are the ref & new m5stats.txt
107 files, respectively. We actually copy everything in the
108 respective directories except the status & diff output files.
109
110 """
111 dest_dir = str(source[0].get_dir())
112 src_dir = str(source[1].get_dir())
113 dest_files = os.listdir(dest_dir)
114 src_files = os.listdir(src_dir)
115 # Exclude status & diff outputs
116 for f in ('outdiff', 'statsdiff', 'status'):
117 if f in src_files:
118 src_files.remove(f)
119 for f in src_files:
120 if f in dest_files:
121 print " Replacing file", f
122 dest_files.remove(f)
123 else:
124 print " Creating new file", f
125 copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
126 copyAction.strfunction = None
127 Execute(copyAction)
128 # warn about any files in dest not overwritten (other than SCCS dir)
129 if 'SCCS' in dest_files:
130 dest_files.remove('SCCS')
131 if dest_files:
132 print "Warning: file(s) in", dest_dir, "not updated:",
133 print ', '.join(dest_files)
134 return 0
135
136def update_test_string(target, source, env):
137 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
138 target=target, source=source)
139
140updateAction = env.Action(update_test, update_test_string)
141
|
142def test_builder(env, category, cpu_list=[], os_list=[], refdir='ref',
143 timeout=15):
144 """Define a test.
| 142def test_builder(env, ref_dir):
143 """Define a test."""
|
145
| 144
|
146 Args:
147 category -- string describing test category (e.g., 'quick')
148 cpu_list -- list of CPUs to runs this test on (blank means all compiled CPUs)
149 os_list -- list of OSs to run this test on
150 refdir -- subdirectory containing reference output (default 'ref')
151 timeout -- test timeout in minutes (only enforced on pool)
| 145 (category, name, _ref, isa, opsys, config) = ref_dir.split('/')
146 assert(_ref == 'ref')
|
152
| 147
|
153 """
| 148 # target path (where test output goes) is the same except without
149 # the 'ref' component
150 tgt_dir = os.path.join(category, name, isa, opsys, config)
|
154
| 151
|
155 default_refdir = False
156 if refdir == 'ref':
157 default_refdir = True
158 valid_cpu_list = []
159 if len(cpu_list) == 0:
160 valid_cpu_list = env['CPU_MODELS']
161 else:
162 for i in cpu_list:
163 if i in env['CPU_MODELS']:
164 valid_cpu_list.append(i)
165 cpu_list = valid_cpu_list
166 if env['TEST_CPU_MODELS']:
167 valid_cpu_list = []
168 for i in env['TEST_CPU_MODELS']:
169 if i in cpu_list:
170 valid_cpu_list.append(i)
171 cpu_list = valid_cpu_list
172# Code commented out that shows the general structure if we want to test
173# different OS's as well.
174# if len(os_list) == 0:
175# for test_cpu in cpu_list:
176# build_cpu_test(env, category, '', test_cpu, refdir, timeout)
177# else:
178# for test_os in os_list:
179# for test_cpu in cpu_list:
180# build_cpu_test(env, category, test_os, test_cpu, refdir,
181# timeout)
182 # Loop through CPU models and generate proper options, ref directories
183 for cpu in cpu_list:
184 test_os = ''
185 if cpu == "AtomicSimpleCPU":
186 cpu_option = ('','atomic/')
187 elif cpu == "TimingSimpleCPU":
188 cpu_option = ('--timing','timing/')
189 elif cpu == "O3CPU":
190 cpu_option = ('--detailed','detailed/')
191 else:
192 raise TypeError, "Unknown CPU model specified"
| 152 # prepend file name with tgt_dir
153 def tgt(f):
154 return os.path.join(tgt_dir, f)
|
193
| 155
|
194 if default_refdir:
195 # Reference stats located in ref/arch/os/cpu or ref/arch/cpu
196 # if no OS specified
197 test_refdir = os.path.join(refdir, env['TARGET_ISA'])
198 if test_os != '':
199 test_refdir = os.path.join(test_refdir, test_os)
200 cpu_refdir = os.path.join(test_refdir, cpu_option[1])
| 156 ref_stats = os.path.join(ref_dir, 'm5stats.txt')
157 new_stats = tgt('m5stats.txt')
158 status_file = tgt('status')
|
201
| 159
|
202 ref_stats = os.path.join(cpu_refdir, 'm5stats.txt')
| 160 # Base command for running test. We mess around with indirectly
161 # referring to files via SOURCES and TARGETS so that scons can
162 # mess with paths all it wants to and we still get the right
163 # files.
164 base_cmd = '${SOURCES[0]} -d $TARGET.dir ${SOURCES[1]} %s' % tgt_dir
165 # stdout and stderr files
166 cmd_stdout = '${TARGETS[0]}'
167 cmd_stderr = '${TARGETS[1]}'
|
203
| 168
|
204 # base command for running test
205 base_cmd = '${SOURCES[0]} -d $TARGET.dir ${SOURCES[1]}'
206 base_cmd = base_cmd + ' ' + cpu_option[0]
207 # stdout and stderr files
208 cmd_stdout = '${TARGETS[0]}'
209 cmd_stderr = '${TARGETS[1]}'
210
211 stdout_string = cpu_option[1] + 'stdout'
212 stderr_string = cpu_option[1] + 'stderr'
213 m5stats_string = cpu_option[1] + 'm5stats.txt'
214 outdiff_string = cpu_option[1] + 'outdiff'
215 statsdiff_string = cpu_option[1] + 'statsdiff'
216 status_string = cpu_option[1] + 'status'
217
218 # Prefix test run with batch job submission command if appropriate.
219 # Output redirection is also different for batch runs.
220 # Batch command also supports timeout arg (in seconds, not minutes).
221 if env['BATCH']:
222 cmd = [env['BATCH_CMD'], '-t', str(timeout * 60),
223 '-o', cmd_stdout, '-e', cmd_stderr, base_cmd]
224 else:
225 cmd = [base_cmd, '>', cmd_stdout, '2>', cmd_stderr]
| 169 # Prefix test run with batch job submission command if appropriate.
170 # Output redirection is also different for batch runs.
171 # Batch command also supports timeout arg (in seconds, not minutes).
172 if env['BATCH']:
173 cmd = [env['BATCH_CMD'], '-t', str(timeout * 60),
174 '-o', cmd_stdout, '-e', cmd_stderr, base_cmd]
175 else:
176 cmd = [base_cmd, '>', cmd_stdout, '2>', cmd_stderr]
|
226
| 177
|
227 env.Command([stdout_string, stderr_string, m5stats_string],
228 [env.M5Binary, 'run.py'], ' '.join(cmd))
| 178 env.Command([tgt('stdout'), tgt('stderr'), new_stats],
179 [env.M5Binary, 'run.py'], ' '.join(cmd))
|
229
| 180
|
230 # order of targets is important... see check_test
231 env.Command([outdiff_string, statsdiff_string, status_string],
232 [ref_stats, m5stats_string],
233 testAction)
| 181 # order of targets is important... see check_test
182 env.Command([tgt('outdiff'), tgt('statsdiff'), status_file],
183 [ref_stats, new_stats],
184 testAction)
|
234
| 185
|
235 # phony target to echo status
236 if env['update_ref']:
237 p = env.Command(cpu_option[1] + '_update',
238 [ref_stats, m5stats_string, status_string],
239 updateAction)
240 else:
241 p = env.Command(cpu_option[1] + '_print', [status_string],
242 printAction)
243 env.AlwaysBuild(p)
| 186 # phony target to echo status
187 if env['update_ref']:
188 p = env.Command(tgt('_update'),
189 [ref_stats, new_stats, status_file],
190 updateAction)
191 else:
192 p = env.Command(tgt('_print'), [status_file], printAction)
|
244
| 193
|
245 env.Tests.setdefault(category, [])
246 env.Tests[category] += p
| 194 env.AlwaysBuild(p)
|
247
| 195
|
248# Make test_builder a "wrapper" function. See SCons wiki page at
249# http://www.scons.org/cgi-bin/wiki/WrapperFunctions.
250SConsEnvironment.Test = test_builder
| |
251
252cwd = os.getcwd()
253os.chdir(str(Dir('.').srcdir))
| 196
197cwd = os.getcwd()
198os.chdir(str(Dir('.').srcdir))
|
254scripts = glob.glob('*/SConscript')
| 199for config in ['simple-atomic']:
200 dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
201 for d in dirs:
202 test_builder(env, d)
|
255os.chdir(cwd)
| 203os.chdir(cwd)
|
256
257for s in scripts:
258 SConscript(s, exports = 'env', duplicate = False)
259
260# Set up phony commands for various test categories
261allTests = []
262for (key, val) in env.Tests.iteritems():
263 env.Command(key, val, env.NoAction)
264 allTests += val
265
266# The 'all' target is redundant since just specifying the test
267# directory name (e.g., ALPHA_SE/test/opt) has the same effect.
268env.Command('all', allTests, env.NoAction)
| |
| |