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 " ' + # 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=m5stats.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 m5stats.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
82 if status == 0:
83 status_str = "passed."
84 else:
85 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
89 f.close()
90 # done
91 return 0
92
93def check_test_string(target, source, env):
94 return env.subst("Comparing outputs in ${TARGETS[0].dir}.",
95 target=target, source=source)
96
97testAction = env.Action(check_test, check_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
| 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 " ' + # 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=m5stats.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 m5stats.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
82 if status == 0:
83 status_str = "passed."
84 else:
85 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
89 f.close()
90 # done
91 return 0
92
93def check_test_string(target, source, env):
94 return env.subst("Comparing outputs in ${TARGETS[0].dir}.",
95 target=target, source=source)
96
97testAction = env.Action(check_test, check_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(['stdout', 'stderr', 'm5stats.txt', 'config.ini'])
115# - source files we always want to ignore
116known_ignores = set(['status', 'outdiff', 'statsdiff'])
117
|
105def update_test(target, source, env):
106 """Update reference test outputs.
107
108 Target is phony. First two sources are the ref & new m5stats.txt
109 files, respectively. We actually copy everything in the
110 respective directories except the status & diff output files.
111
112 """
113 dest_dir = str(source[0].get_dir())
114 src_dir = str(source[1].get_dir())
| 118def update_test(target, source, env):
119 """Update reference test outputs.
120
121 Target is phony. First two sources are the ref & new m5stats.txt
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())
|
115 dest_files = os.listdir(dest_dir)
116 src_files = os.listdir(src_dir)
117 for f in ('stdout', 'stderr', 'm5stats.txt', 'config.ini'):
| 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:
|
118 if f in dest_files:
119 print " Replacing file", f
120 dest_files.remove(f)
121 else:
122 print " Creating new file", f
123 copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
124 copyAction.strfunction = None
125 Execute(copyAction)
| 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)
|
126 # warn about any files in dest not overwritten (other than SCCS dir)
127 if 'SCCS' in dest_files:
128 dest_files.remove('SCCS')
129 if dest_files:
130 print "Warning: file(s) in", dest_dir, "not updated:",
131 print ', '.join(dest_files)
| |
132 return 0
133
134def update_test_string(target, source, env):
135 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
136 target=target, source=source)
137
138updateAction = env.Action(update_test, update_test_string)
139
140def test_builder(env, ref_dir):
141 """Define a test."""
142
143 (category, name, _ref, isa, opsys, config) = ref_dir.split('/')
144 assert(_ref == 'ref')
145
146 # target path (where test output goes) is the same except without
147 # the 'ref' component
148 tgt_dir = os.path.join(category, name, isa, opsys, config)
149
150 # prepend file name with tgt_dir
151 def tgt(f):
152 return os.path.join(tgt_dir, f)
153
154 ref_stats = os.path.join(ref_dir, 'm5stats.txt')
155 new_stats = tgt('m5stats.txt')
156 status_file = tgt('status')
157
158 # Base command for running test. We mess around with indirectly
159 # referring to files via SOURCES and TARGETS so that scons can
160 # mess with paths all it wants to and we still get the right
161 # files.
162 base_cmd = '${SOURCES[0]} -d $TARGET.dir ${SOURCES[1]} %s' % tgt_dir
163 # stdout and stderr files
164 cmd_stdout = '${TARGETS[0]}'
165 cmd_stderr = '${TARGETS[1]}'
166
167 # Prefix test run with batch job submission command if appropriate.
168 # Output redirection is also different for batch runs.
169 # Batch command also supports timeout arg (in seconds, not minutes).
170 timeout = 15 # used to be a param, probably should be again
171 if env['BATCH']:
172 cmd = [env['BATCH_CMD'], '-t', str(timeout * 60),
173 '-o', cmd_stdout, '-e', cmd_stderr, base_cmd]
174 else:
175 cmd = [base_cmd, '>', cmd_stdout, '2>', cmd_stderr]
176
177 env.Command([tgt('stdout'), tgt('stderr'), new_stats],
178 [env.M5Binary, 'run.py'], ' '.join(cmd))
179
180 # order of targets is important... see check_test
181 env.Command([tgt('outdiff'), tgt('statsdiff'), status_file],
182 [ref_stats, new_stats],
183 testAction)
184
185 # phony target to echo status
186 if env['update_ref']:
187 p = env.Command(tgt('_update'),
188 [ref_stats, new_stats, status_file],
189 updateAction)
190 else:
191 p = env.Command(tgt('_print'), [status_file], printAction)
192
193 env.AlwaysBuild(p)
194
195
196# Figure out applicable configs based on build type
197configs = []
198if env['FULL_SYSTEM']:
199 if env['TARGET_ISA'] == 'alpha':
200 if not env['ALPHA_TLASER']:
201 configs += ['tsunami-simple-atomic',
202 'tsunami-simple-timing',
203 'tsunami-simple-atomic-dual',
204 'tsunami-simple-timing-dual',
205 'twosys-tsunami-simple-atomic']
206 if env['TARGET_ISA'] == 'sparc':
207 configs += ['t1000-simple-atomic',
208 't1000-simple-timing']
209
210else:
211 configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest']
212
213cwd = os.getcwd()
214os.chdir(str(Dir('.').srcdir))
215for config in configs:
216 dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
217 for d in dirs:
218 test_builder(env, d)
219os.chdir(cwd)
| 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, 'm5stats.txt')
174 new_stats = tgt('m5stats.txt')
175 status_file = tgt('status')
176
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 base_cmd = '${SOURCES[0]} -d $TARGET.dir ${SOURCES[1]} %s' % tgt_dir
182 # stdout and stderr files
183 cmd_stdout = '${TARGETS[0]}'
184 cmd_stderr = '${TARGETS[1]}'
185
186 # Prefix test run with batch job submission command if appropriate.
187 # Output redirection is also different for batch runs.
188 # Batch command also supports timeout arg (in seconds, not minutes).
189 timeout = 15 # used to be a param, probably should be again
190 if env['BATCH']:
191 cmd = [env['BATCH_CMD'], '-t', str(timeout * 60),
192 '-o', cmd_stdout, '-e', cmd_stderr, base_cmd]
193 else:
194 cmd = [base_cmd, '>', cmd_stdout, '2>', cmd_stderr]
195
196 env.Command([tgt('stdout'), tgt('stderr'), new_stats],
197 [env.M5Binary, 'run.py'], ' '.join(cmd))
198
199 # order of targets is important... see check_test
200 env.Command([tgt('outdiff'), tgt('statsdiff'), status_file],
201 [ref_stats, new_stats],
202 testAction)
203
204 # phony target to echo status
205 if env['update_ref']:
206 p = env.Command(tgt('_update'),
207 [ref_stats, new_stats, status_file],
208 updateAction)
209 else:
210 p = env.Command(tgt('_print'), [status_file], printAction)
211
212 env.AlwaysBuild(p)
213
214
215# Figure out applicable configs based on build type
216configs = []
217if env['FULL_SYSTEM']:
218 if env['TARGET_ISA'] == 'alpha':
219 if not env['ALPHA_TLASER']:
220 configs += ['tsunami-simple-atomic',
221 'tsunami-simple-timing',
222 'tsunami-simple-atomic-dual',
223 'tsunami-simple-timing-dual',
224 'twosys-tsunami-simple-atomic']
225 if env['TARGET_ISA'] == 'sparc':
226 configs += ['t1000-simple-atomic',
227 't1000-simple-timing']
228
229else:
230 configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest']
231
232cwd = os.getcwd()
233os.chdir(str(Dir('.').srcdir))
234for config in configs:
235 dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
236 for d in dirs:
237 test_builder(env, d)
238os.chdir(cwd)
|