SConscript revision 10710:9b71309d29f9 
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, time
34import glob
35from SCons.Script.SConscript import SConsEnvironment
36
37Import('env')
38
39env['DIFFOUT'] = File('diff-out')
40
41# get the termcap from the environment
42termcap = env['TERMCAP']
43
44# Dict that accumulates lists of tests by category (quick, medium, long)
45env.Tests = {}
46
47def contents(node):
48    return file(str(node)).read()
49
50# functions to parse return value from scons Execute()... not the same
51# as wait() etc., so python built-in os funcs don't work.
52def signaled(status):
53    return (status & 0x80) != 0;
54
55def signum(status):
56    return (status & 0x7f);
57
58# List of signals that indicate that we should retry the test rather
59# than consider it failed.
60retry_signals = (signal.SIGTERM, signal.SIGKILL, signal.SIGINT,
61                 signal.SIGQUIT, signal.SIGHUP)
62
63# regular expressions of lines to ignore when diffing outputs
64output_ignore_regexes = (
65    '^command line:',		# for stdout file
66    '^gem5 compiled ',		# for stderr file
67    '^gem5 started ',		# for stderr file
68    '^gem5 executing on ',	# for stderr file
69    '^Simulation complete at',	# for stderr file
70    '^Listening for',		# for stderr file
71    'listening for remote gdb',	# for stderr file
72    )
73
74output_ignore_args = ' '.join(["-I '"+s+"'" for s in output_ignore_regexes])
75
76output_ignore_args += ' --exclude=stats.txt --exclude=outdiff'
77
78def run_test(target, source, env):
79    """Check output from running test.
80
81    Targets are as follows:
82    target[0] : status
83
84    Sources are:
85    source[0] : gem5 binary
86    source[1] : tests/run.py script
87    source[2] : reference stats file
88
89    """
90    # make sure target files are all gone
91    for t in target:
92        if os.path.exists(t.abspath):
93            env.Execute(Delete(t.abspath))
94
95    tgt_dir = os.path.dirname(str(target[0]))
96
97    # Base command for running test.  We mess around with indirectly
98    # referring to files via SOURCES and TARGETS so that scons can mess
99    # with paths all it wants to and we still get the right files.
100    cmd = '${SOURCES[0]} -d %s -re ${SOURCES[1]} %s' % (tgt_dir, tgt_dir)
101
102    # Prefix test run with batch job submission command if appropriate.
103    # Batch command also supports timeout arg (in seconds, not minutes).
104    timeout = 15 * 60 # used to be a param, probably should be again
105    if env['BATCH']:
106        cmd = '%s -t %d %s' % (env['BATCH_CMD'], timeout, cmd)
107    # The slowest regression (bzip2) requires ~2.8 hours;
108    # 4 hours was chosen to be conservative.
109    elif env['TIMEOUT']:
110        cmd = 'timeout --foreground 4h %s' % cmd
111
112    # Create a default value for the status string, changed as needed
113    # based on the status.
114    status_str = "passed."
115
116    pre_exec_time = time.time()
117    status = env.Execute(env.subst(cmd, target=target, source=source))
118    if status == 0:
119        # gem5 terminated normally.
120        # Run diff on output & ref directories to find differences.
121        # Exclude the stats file since we will use diff-out on that.
122
123        # NFS file systems can be annoying and not have updated yet
124        # wait until we see the file modified
125        statsdiff = os.path.join(tgt_dir, 'statsdiff')
126        m_time = 0
127        nap = 0
128        while m_time < pre_exec_time and nap < 10:
129            try:
130                m_time = os.stat(statsdiff).st_mtime
131            except OSError:
132                pass
133            time.sleep(1)
134            nap += 1
135
136        outdiff = os.path.join(tgt_dir, 'outdiff')
137        # tack 'true' on the end so scons doesn't report diff's
138        # non-zero exit code as a build error
139        diffcmd = 'diff -ubrs %s ${SOURCES[2].dir} %s > %s; true' \
140                  % (output_ignore_args, tgt_dir, outdiff)
141        env.Execute(env.subst(diffcmd, target=target, source=source))
142        print "===== Output differences ====="
143        print contents(outdiff)
144        # Run diff-out on stats.txt file
145        diffcmd = '$DIFFOUT ${SOURCES[2]} %s > %s' \
146                  % (os.path.join(tgt_dir, 'stats.txt'), statsdiff)
147        diffcmd = env.subst(diffcmd, target=target, source=source)
148        diff_status = env.Execute(diffcmd, strfunction=None)
149        # If there is a difference, change the status string to say so
150        if diff_status != 0:
151            status_str = "CHANGED!"
152        print "===== Statistics differences ====="
153        print contents(statsdiff)
154
155    else: # gem5 exit status != 0
156        # Consider it a failed test unless the exit status is 2
157        status_str = "FAILED!"
158        # gem5 did not terminate properly, so no need to check the output
159        if env['TIMEOUT'] and status == 124:
160            status_str = "TIMED-OUT!"
161        elif signaled(status):
162            print 'gem5 terminated with signal', signum(status)
163            if signum(status) in retry_signals:
164                # Consider the test incomplete; don't create a 'status' output.
165                # Hand the return status to scons and let scons decide what
166                # to do about it (typically terminate unless run with -k).
167                return status
168        elif status == 2:
169            # The test was skipped, change the status string to say so
170            status_str = "skipped."
171        else:
172            print 'gem5 exited with non-zero status', status
173        # complete but failed execution (call to exit() with non-zero
174        # status, SIGABORT due to assertion failure, etc.)... fall through
175        # and generate FAILED status as if output comparison had failed
176
177    # Generate status file contents based on exit status of gem5 and diff-out
178    f = file(str(target[0]), 'w')
179    print >>f, tgt_dir, status_str
180    f.close()
181    # done
182    return 0
183
184def run_test_string(target, source, env):
185    return env.subst("Running test in ${TARGETS[0].dir}.",
186                     target=target, source=source)
187
188testAction = env.Action(run_test, run_test_string)
189
190def print_test(target, source, env):
191    # print the status with colours to make it easier to see what
192    # passed and what failed
193    line = contents(source[0])
194
195    # split the line to words and get the last one
196    words = line.split()
197    status = words[-1]
198
199    # if the test failed make it red, if it passed make it green, and
200    # skip the punctuation
201    if status == "FAILED!" or status == "TIMED-OUT!":
202        status = termcap.Red + status[:-1] + termcap.Normal + status[-1]
203    elif status == "CHANGED!":
204        status = termcap.Yellow + status[:-1] + termcap.Normal + status[-1]
205    elif status == "passed.":
206        status = termcap.Green + status[:-1] + termcap.Normal + status[-1]
207    elif status == "skipped.":
208        status = termcap.Cyan + status[:-1] + termcap.Normal + status[-1]
209
210    # put it back in the list and join with space
211    words[-1] = status
212    line = " ".join(words)
213
214    print '***** ' + line
215    return 0
216
217printAction = env.Action(print_test, strfunction = None)
218
219# Static vars for update_test:
220# - long-winded message about ignored sources
221ignore_msg = '''
222Note: The following file(s) will not be copied.  New non-standard
223      output files must be copied manually once before --update-ref will
224      recognize them as outputs.  Otherwise they are assumed to be
225      inputs and are ignored.
226'''
227# - reference files always needed
228needed_files = set(['simout', 'simerr', 'stats.txt', 'config.ini'])
229# - source files we always want to ignore
230known_ignores = set(['status', 'outdiff', 'statsdiff'])
231
232def update_test(target, source, env):
233    """Update reference test outputs.
234
235    Target is phony.  First two sources are the ref & new stats.txt file
236    files, respectively.  We actually copy everything in the
237    respective directories except the status & diff output files.
238
239    """
240    dest_dir = str(source[0].get_dir())
241    src_dir = str(source[1].get_dir())
242    dest_files = set(os.listdir(dest_dir))
243    src_files = set(os.listdir(src_dir))
244    # Copy all of the required files plus any existing dest files.
245    wanted_files = needed_files | dest_files
246    missing_files = wanted_files - src_files
247    if len(missing_files) > 0:
248        print "  WARNING: the following file(s) are missing " \
249              "and will not be updated:"
250        print "    ", " ,".join(missing_files)
251    copy_files = wanted_files - missing_files
252    warn_ignored_files = (src_files - copy_files) - known_ignores
253    if len(warn_ignored_files) > 0:
254        print ignore_msg,
255        print "       ", ", ".join(warn_ignored_files)
256    for f in copy_files:
257        if f in dest_files:
258            print "  Replacing file", f
259            dest_files.remove(f)
260        else:
261            print "  Creating new file", f
262        copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
263        copyAction.strfunction = None
264        env.Execute(copyAction)
265    return 0
266
267def update_test_string(target, source, env):
268    return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
269                     target=target, source=source)
270
271updateAction = env.Action(update_test, update_test_string)
272
273def test_builder(env, ref_dir):
274    """Define a test."""
275
276    path = list(ref_dir.split('/'))
277
278    # target path (where test output goes) consists of category, mode,
279    # name, isa, opsys, and config (skips the 'ref' component)
280    assert(path.pop(-4) == 'ref')
281    tgt_dir = os.path.join(*path[-6:])
282
283    # local closure for prepending target path to filename
284    def tgt(f):
285        return os.path.join(tgt_dir, f)
286
287    ref_stats = os.path.join(ref_dir, 'stats.txt')
288    new_stats = tgt('stats.txt')
289    status_file = tgt('status')
290
291    env.Command([status_file, new_stats],
292                [env.M5Binary, 'run.py', ref_stats],
293                testAction)
294
295    # phony target to echo status
296    if GetOption('update_ref'):
297        p = env.Command(tgt('_update'),
298                        [ref_stats, new_stats, status_file],
299                        updateAction)
300    else:
301        p = env.Command(tgt('_print'), [status_file], printAction)
302
303    env.AlwaysBuild(p)
304
305
306# Figure out applicable configs based on build type
307configs = []
308if env['TARGET_ISA'] == 'alpha':
309    configs += ['tsunami-simple-atomic',
310                'tsunami-simple-timing',
311                'tsunami-simple-atomic-dual',
312                'tsunami-simple-timing-dual',
313                'twosys-tsunami-simple-atomic',
314                'tsunami-o3', 'tsunami-o3-dual',
315                'tsunami-minor', 'tsunami-minor-dual',
316                'tsunami-switcheroo-full']
317if env['TARGET_ISA'] == 'sparc':
318    configs += ['t1000-simple-atomic',
319                't1000-simple-timing']
320if env['TARGET_ISA'] == 'arm':
321    configs += ['simple-atomic-dummychecker',
322                'o3-timing-checker',
323                'realview-simple-atomic',
324                'realview-simple-atomic-dual',
325                'realview-simple-timing',
326                'realview-simple-timing-dual',
327                'realview-o3',
328                'realview-o3-checker',
329                'realview-o3-dual',
330                'realview-minor',
331                'realview-minor-dual',
332                'realview-switcheroo-atomic',
333                'realview-switcheroo-timing',
334                'realview-switcheroo-o3',
335                'realview-switcheroo-full',
336                'realview64-simple-atomic',
337                'realview64-simple-atomic-dual',
338                'realview64-simple-timing',
339                'realview64-simple-timing-dual',
340                'realview64-o3',
341                'realview64-o3-checker',
342                'realview64-o3-dual',
343                'realview64-minor',
344                'realview64-minor-dual',
345                'realview64-switcheroo-atomic',
346                'realview64-switcheroo-timing',
347                'realview64-switcheroo-o3',
348                'realview64-switcheroo-full']
349if env['TARGET_ISA'] == 'x86':
350    configs += ['pc-simple-atomic',
351                'pc-simple-timing',
352                'pc-o3-timing',
353                'pc-switcheroo-full']
354
355configs += ['simple-atomic', 'simple-atomic-mp',
356            'simple-timing', 'simple-timing-mp',
357            'minor-timing', 'minor-timing-mp',
358            'o3-timing', 'o3-timing-mp',
359            'rubytest', 'memtest', 'memtest-filter',
360            'tgen-simple-mem', 'tgen-dram-ctrl']
361
362if env['PROTOCOL'] != 'None':
363    if env['PROTOCOL'] == 'MI_example':
364        configs += [c + "-ruby" for c in configs]
365    else:
366        configs = [c + "-ruby-" + env['PROTOCOL'] for c in configs]
367
368src = Dir('.').srcdir
369for config in configs:
370    dirs = src.glob('*/*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
371    for d in dirs:
372        d = str(d)
373        if not os.path.exists(os.path.join(d, 'skip')):
374            test_builder(env, d)
375