SConscript revision 2997
12929Sktlim@umich.edu# -*- mode:python -*-
22929Sktlim@umich.edu
32932Sktlim@umich.edu# Copyright (c) 2004-2006 The Regents of The University of Michigan
42929Sktlim@umich.edu# All rights reserved.
52929Sktlim@umich.edu#
62929Sktlim@umich.edu# Redistribution and use in source and binary forms, with or without
72929Sktlim@umich.edu# modification, are permitted provided that the following conditions are
82929Sktlim@umich.edu# met: redistributions of source code must retain the above copyright
92929Sktlim@umich.edu# notice, this list of conditions and the following disclaimer;
102929Sktlim@umich.edu# redistributions in binary form must reproduce the above copyright
112929Sktlim@umich.edu# notice, this list of conditions and the following disclaimer in the
122929Sktlim@umich.edu# documentation and/or other materials provided with the distribution;
132929Sktlim@umich.edu# neither the name of the copyright holders nor the names of its
142929Sktlim@umich.edu# contributors may be used to endorse or promote products derived from
152929Sktlim@umich.edu# this software without specific prior written permission.
162929Sktlim@umich.edu#
172929Sktlim@umich.edu# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
182929Sktlim@umich.edu# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
192929Sktlim@umich.edu# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
202929Sktlim@umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
212929Sktlim@umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
222929Sktlim@umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
232929Sktlim@umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
242929Sktlim@umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
252929Sktlim@umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
262929Sktlim@umich.edu# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
272929Sktlim@umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
282932Sktlim@umich.edu#
292932Sktlim@umich.edu# Authors: Steve Reinhardt
302932Sktlim@umich.edu#          Kevin Lim
312929Sktlim@umich.edu
322929Sktlim@umich.eduimport os
332929Sktlim@umich.eduimport sys
342929Sktlim@umich.eduimport glob
352929Sktlim@umich.edufrom SCons.Script.SConscript import SConsEnvironment
362929Sktlim@umich.edu
372929Sktlim@umich.eduImport('env')
382929Sktlim@umich.edu
392929Sktlim@umich.eduenv['DIFFOUT'] = File('diff-out')
402929Sktlim@umich.edu
412929Sktlim@umich.edu# Dict that accumulates lists of tests by category (quick, medium, long)
422929Sktlim@umich.eduenv.Tests = {}
432929Sktlim@umich.edu
442929Sktlim@umich.edudef contents(node):
452929Sktlim@umich.edu    return file(str(node)).read()
462929Sktlim@umich.edu
472929Sktlim@umich.edudef check_test(target, source, env):
482929Sktlim@umich.edu    """Check output from running test.
492929Sktlim@umich.edu
502929Sktlim@umich.edu    Targets are as follows:
512929Sktlim@umich.edu    target[0] : outdiff
522929Sktlim@umich.edu    target[1] : statsdiff
532929Sktlim@umich.edu    target[2] : status
542929Sktlim@umich.edu
552929Sktlim@umich.edu    """
562929Sktlim@umich.edu    # make sure target files are all gone
572929Sktlim@umich.edu    for t in target:
582929Sktlim@umich.edu        if os.path.exists(t.abspath):
592929Sktlim@umich.edu            Execute(Delete(t.abspath))
602929Sktlim@umich.edu    # Run diff on output & ref directories to find differences.
612929Sktlim@umich.edu    # Exclude m5stats.txt since we will use diff-out on that.
622929Sktlim@umich.edu    Execute(env.subst('diff -ubr ${SOURCES[0].dir} ${SOURCES[1].dir} ' +
632929Sktlim@umich.edu                      '-I "^command line:" ' +		# for stdout file
642929Sktlim@umich.edu                      '-I "^M5 compiled on" ' +		# for stderr file
652929Sktlim@umich.edu                      '-I "^M5 simulation started" ' +	# for stderr file
662929Sktlim@umich.edu                      '-I "^Simulation complete at" ' +	# for stderr file
672929Sktlim@umich.edu                      '-I "^Listening for" ' +		# for stderr file
682929Sktlim@umich.edu                      '--exclude=m5stats.txt --exclude=SCCS ' +
692929Sktlim@umich.edu                      '--exclude=${TARGETS[0].file} ' +
702929Sktlim@umich.edu                      '> ${TARGETS[0]}', target=target, source=source), None)
712929Sktlim@umich.edu    print "===== Output differences ====="
722929Sktlim@umich.edu    print contents(target[0])
732929Sktlim@umich.edu    # Run diff-out on m5stats.txt file
742929Sktlim@umich.edu    status = Execute(env.subst('$DIFFOUT $SOURCES > ${TARGETS[1]}',
752929Sktlim@umich.edu                               target=target, source=source),
762929Sktlim@umich.edu                     strfunction=None)
772929Sktlim@umich.edu    print "===== Statistics differences ====="
782929Sktlim@umich.edu    print contents(target[1])
792929Sktlim@umich.edu    # Generate status file contents based on exit status of diff-out
802929Sktlim@umich.edu    if status == 0:
812929Sktlim@umich.edu        status_str = "passed."
822929Sktlim@umich.edu    else:
832929Sktlim@umich.edu        status_str = "FAILED!"
842929Sktlim@umich.edu    f = file(str(target[2]), 'w')
852929Sktlim@umich.edu    print >>f, env.subst('${TARGETS[2].dir}', target=target, source=source), \
862929Sktlim@umich.edu          status_str
872929Sktlim@umich.edu    f.close()
882929Sktlim@umich.edu    # done
892929Sktlim@umich.edu    return 0
902929Sktlim@umich.edu
912929Sktlim@umich.edudef check_test_string(target, source, env):
922929Sktlim@umich.edu    return env.subst("Comparing outputs in ${TARGETS[0].dir}.",
932929Sktlim@umich.edu                     target=target, source=source)
942929Sktlim@umich.edu
952929Sktlim@umich.edutestAction = env.Action(check_test, check_test_string)
962929Sktlim@umich.edu
972929Sktlim@umich.edudef print_test(target, source, env):
982929Sktlim@umich.edu    print '***** ' + contents(source[0])
992929Sktlim@umich.edu    return 0
1002929Sktlim@umich.edu
1012929Sktlim@umich.eduprintAction = env.Action(print_test, strfunction = None)
1022929Sktlim@umich.edu
1032929Sktlim@umich.edudef update_test(target, source, env):
1042929Sktlim@umich.edu    """Update reference test outputs.
1052929Sktlim@umich.edu
1062929Sktlim@umich.edu    Target is phony.  First two sources are the ref & new m5stats.txt
1072929Sktlim@umich.edu    files, respectively.  We actually copy everything in the
1082929Sktlim@umich.edu    respective directories except the status & diff output files.
1092929Sktlim@umich.edu
1102929Sktlim@umich.edu    """
1112929Sktlim@umich.edu    dest_dir = str(source[0].get_dir())
1122929Sktlim@umich.edu    src_dir = str(source[1].get_dir())
1132929Sktlim@umich.edu    dest_files = os.listdir(dest_dir)
1142929Sktlim@umich.edu    src_files = os.listdir(src_dir)
1152929Sktlim@umich.edu    # Exclude status & diff outputs
1162929Sktlim@umich.edu    for f in ('outdiff', 'statsdiff', 'status'):
1172929Sktlim@umich.edu        if f in src_files:
1182929Sktlim@umich.edu            src_files.remove(f)
1192929Sktlim@umich.edu    for f in src_files:
1202929Sktlim@umich.edu        if f in dest_files:
1212929Sktlim@umich.edu            print "  Replacing file", f
1222929Sktlim@umich.edu            dest_files.remove(f)
1232929Sktlim@umich.edu        else:
1242929Sktlim@umich.edu            print "  Creating new file", f
1252929Sktlim@umich.edu        copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
1262929Sktlim@umich.edu        copyAction.strfunction = None
1272929Sktlim@umich.edu        Execute(copyAction)
1282929Sktlim@umich.edu    # warn about any files in dest not overwritten (other than SCCS dir)
1292929Sktlim@umich.edu    if 'SCCS' in dest_files:
1302929Sktlim@umich.edu        dest_files.remove('SCCS')
1312929Sktlim@umich.edu    if dest_files:
1322929Sktlim@umich.edu        print "Warning: file(s) in", dest_dir, "not updated:",
1332929Sktlim@umich.edu        print ', '.join(dest_files)
1342929Sktlim@umich.edu    return 0
1352929Sktlim@umich.edu
1362929Sktlim@umich.edudef update_test_string(target, source, env):
1372929Sktlim@umich.edu    return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
1382929Sktlim@umich.edu                     target=target, source=source)
1392929Sktlim@umich.edu
1402929Sktlim@umich.eduupdateAction = env.Action(update_test, update_test_string)
1412929Sktlim@umich.edu
1422997Sstever@eecs.umich.edudef test_builder(env, ref_dir):
1432997Sstever@eecs.umich.edu    """Define a test."""
1442929Sktlim@umich.edu
1452997Sstever@eecs.umich.edu    (category, name, _ref, isa, opsys, config) = ref_dir.split('/')
1462997Sstever@eecs.umich.edu    assert(_ref == 'ref')
1472929Sktlim@umich.edu
1482997Sstever@eecs.umich.edu    # target path (where test output goes) is the same except without
1492997Sstever@eecs.umich.edu    # the 'ref' component
1502997Sstever@eecs.umich.edu    tgt_dir = os.path.join(category, name, isa, opsys, config)
1512929Sktlim@umich.edu
1522997Sstever@eecs.umich.edu    # prepend file name with tgt_dir
1532997Sstever@eecs.umich.edu    def tgt(f):
1542997Sstever@eecs.umich.edu        return os.path.join(tgt_dir, f)
1552997Sstever@eecs.umich.edu
1562997Sstever@eecs.umich.edu    ref_stats = os.path.join(ref_dir, 'm5stats.txt')
1572997Sstever@eecs.umich.edu    new_stats = tgt('m5stats.txt')
1582997Sstever@eecs.umich.edu    status_file = tgt('status')
1592997Sstever@eecs.umich.edu
1602997Sstever@eecs.umich.edu    # Base command for running test.  We mess around with indirectly
1612997Sstever@eecs.umich.edu    # referring to files via SOURCES and TARGETS so that scons can
1622997Sstever@eecs.umich.edu    # mess with paths all it wants to and we still get the right
1632997Sstever@eecs.umich.edu    # files.
1642997Sstever@eecs.umich.edu    base_cmd = '${SOURCES[0]} -d $TARGET.dir ${SOURCES[1]} %s' % tgt_dir
1652997Sstever@eecs.umich.edu    # stdout and stderr files
1662997Sstever@eecs.umich.edu    cmd_stdout = '${TARGETS[0]}'
1672997Sstever@eecs.umich.edu    cmd_stderr = '${TARGETS[1]}'
1682997Sstever@eecs.umich.edu
1692997Sstever@eecs.umich.edu    # Prefix test run with batch job submission command if appropriate.
1702997Sstever@eecs.umich.edu    # Output redirection is also different for batch runs.
1712997Sstever@eecs.umich.edu    # Batch command also supports timeout arg (in seconds, not minutes).
1722997Sstever@eecs.umich.edu    if env['BATCH']:
1732997Sstever@eecs.umich.edu        cmd = [env['BATCH_CMD'], '-t', str(timeout * 60),
1742997Sstever@eecs.umich.edu               '-o', cmd_stdout, '-e', cmd_stderr, base_cmd]
1752953Sktlim@umich.edu    else:
1762997Sstever@eecs.umich.edu        cmd = [base_cmd, '>', cmd_stdout, '2>', cmd_stderr]
1772997Sstever@eecs.umich.edu            
1782997Sstever@eecs.umich.edu    env.Command([tgt('stdout'), tgt('stderr'), new_stats],
1792997Sstever@eecs.umich.edu                [env.M5Binary, 'run.py'], ' '.join(cmd))
1802929Sktlim@umich.edu
1812997Sstever@eecs.umich.edu    # order of targets is important... see check_test
1822997Sstever@eecs.umich.edu    env.Command([tgt('outdiff'), tgt('statsdiff'), status_file],
1832997Sstever@eecs.umich.edu                [ref_stats, new_stats],
1842997Sstever@eecs.umich.edu                testAction)
1852929Sktlim@umich.edu
1862997Sstever@eecs.umich.edu    # phony target to echo status
1872997Sstever@eecs.umich.edu    if env['update_ref']:
1882997Sstever@eecs.umich.edu        p = env.Command(tgt('_update'),
1892997Sstever@eecs.umich.edu                        [ref_stats, new_stats, status_file],
1902997Sstever@eecs.umich.edu                        updateAction)
1912997Sstever@eecs.umich.edu    else:
1922997Sstever@eecs.umich.edu        p = env.Command(tgt('_print'), [status_file], printAction)
1932929Sktlim@umich.edu
1942997Sstever@eecs.umich.edu    env.AlwaysBuild(p)
1952929Sktlim@umich.edu
1962929Sktlim@umich.edu
1972929Sktlim@umich.educwd = os.getcwd()
1982929Sktlim@umich.eduos.chdir(str(Dir('.').srcdir))
1992997Sstever@eecs.umich.edufor config in ['simple-atomic']:
2002997Sstever@eecs.umich.edu    dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
2012997Sstever@eecs.umich.edu    for d in dirs:
2022997Sstever@eecs.umich.edu        test_builder(env, d)
2032929Sktlim@umich.eduos.chdir(cwd)
204