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
--- 15 unchanged lines hidden (view full) ---
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 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 = 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 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:
140 status_str = "passed."
141 else:
142 status_str = "FAILED!"
143 f = file(str(target[0]), 'w')
144 print >>f, tgt_dir, status_str
145 f.close()
146 # done
147 return 0
148
149def run_test_string(target, source, env):
150 return env.subst("Running test in ${TARGETS[0].dir}.",
151 target=target, source=source)
152
153testAction = env.Action(run_test, run_test_string)
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:
--- 63 unchanged lines hidden (view full) ---
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
233 env.Command([status_file],
234 [env.M5Binary, 'run.py', ref_stats],
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:
--- 31 unchanged lines hidden ---
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
--- 15 unchanged lines hidden (view full) ---
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 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 = 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 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:
140 status_str = "passed."
141 else:
142 status_str = "FAILED!"
143 f = file(str(target[0]), 'w')
144 print >>f, tgt_dir, status_str
145 f.close()
146 # done
147 return 0
148
149def run_test_string(target, source, env):
150 return env.subst("Running test in ${TARGETS[0].dir}.",
151 target=target, source=source)
152
153testAction = env.Action(run_test, run_test_string)
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:
--- 63 unchanged lines hidden (view full) ---
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
233 env.Command([status_file],
234 [env.M5Binary, 'run.py', ref_stats],
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:
--- 31 unchanged lines hidden ---