SConscript revision 8334
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
326007Ssteve.reinhardt@amd.comimport os, signal
337735SAli.Saidi@ARM.comimport sys, time
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
476007Ssteve.reinhardt@amd.com# functions to parse return value from scons Execute()... not the same
486007Ssteve.reinhardt@amd.com# as wait() etc., so python built-in os funcs don't work.
496007Ssteve.reinhardt@amd.comdef signaled(status):
506007Ssteve.reinhardt@amd.com    return (status & 0x80) != 0;
516007Ssteve.reinhardt@amd.com
526007Ssteve.reinhardt@amd.comdef signum(status):
536007Ssteve.reinhardt@amd.com    return (status & 0x7f);
546007Ssteve.reinhardt@amd.com
556007Ssteve.reinhardt@amd.com# List of signals that indicate that we should retry the test rather
566007Ssteve.reinhardt@amd.com# than consider it failed.
576007Ssteve.reinhardt@amd.comretry_signals = (signal.SIGTERM, signal.SIGKILL, signal.SIGINT,
586007Ssteve.reinhardt@amd.com                 signal.SIGQUIT, signal.SIGHUP)
596007Ssteve.reinhardt@amd.com
606007Ssteve.reinhardt@amd.com# regular expressions of lines to ignore when diffing outputs
616007Ssteve.reinhardt@amd.comoutput_ignore_regexes = (
626007Ssteve.reinhardt@amd.com    '^command line:',		# for stdout file
636007Ssteve.reinhardt@amd.com    '^M5 compiled ',		# for stderr file
646007Ssteve.reinhardt@amd.com    '^M5 started ',		# for stderr file
656007Ssteve.reinhardt@amd.com    '^M5 executing on ',	# for stderr file
666007Ssteve.reinhardt@amd.com    '^Simulation complete at',	# for stderr file
676007Ssteve.reinhardt@amd.com    '^Listening for',		# for stderr file
686007Ssteve.reinhardt@amd.com    'listening for remote gdb',	# for stderr file
696007Ssteve.reinhardt@amd.com    )
706007Ssteve.reinhardt@amd.com
716007Ssteve.reinhardt@amd.comoutput_ignore_args = ' '.join(["-I '"+s+"'" for s in output_ignore_regexes])
726007Ssteve.reinhardt@amd.com
736007Ssteve.reinhardt@amd.comoutput_ignore_args += ' --exclude=stats.txt --exclude=outdiff'
746007Ssteve.reinhardt@amd.com
756007Ssteve.reinhardt@amd.comdef run_test(target, source, env):
762929Sktlim@umich.edu    """Check output from running test.
772929Sktlim@umich.edu
782929Sktlim@umich.edu    Targets are as follows:
796007Ssteve.reinhardt@amd.com    target[0] : status
806007Ssteve.reinhardt@amd.com
816007Ssteve.reinhardt@amd.com    Sources are:
826007Ssteve.reinhardt@amd.com    source[0] : M5 binary
836007Ssteve.reinhardt@amd.com    source[1] : tests/run.py script
846007Ssteve.reinhardt@amd.com    source[2] : reference stats file
852929Sktlim@umich.edu
862929Sktlim@umich.edu    """
872929Sktlim@umich.edu    # make sure target files are all gone
882929Sktlim@umich.edu    for t in target:
892929Sktlim@umich.edu        if os.path.exists(t.abspath):
906011Ssteve.reinhardt@amd.com            env.Execute(Delete(t.abspath))
916007Ssteve.reinhardt@amd.com
926007Ssteve.reinhardt@amd.com    tgt_dir = os.path.dirname(str(target[0]))
936007Ssteve.reinhardt@amd.com
946007Ssteve.reinhardt@amd.com    # Base command for running test.  We mess around with indirectly
956007Ssteve.reinhardt@amd.com    # referring to files via SOURCES and TARGETS so that scons can mess
966007Ssteve.reinhardt@amd.com    # with paths all it wants to and we still get the right files.
976007Ssteve.reinhardt@amd.com    cmd = '${SOURCES[0]} -d %s -re ${SOURCES[1]} %s' % (tgt_dir, tgt_dir)
986007Ssteve.reinhardt@amd.com
996007Ssteve.reinhardt@amd.com    # Prefix test run with batch job submission command if appropriate.
1006007Ssteve.reinhardt@amd.com    # Batch command also supports timeout arg (in seconds, not minutes).
1016007Ssteve.reinhardt@amd.com    timeout = 15 * 60 # used to be a param, probably should be again
1026007Ssteve.reinhardt@amd.com    if env['BATCH']:
1036007Ssteve.reinhardt@amd.com        cmd = '%s -t %d %s' % (env['BATCH_CMD'], timeout, cmd)
1046007Ssteve.reinhardt@amd.com
1057735SAli.Saidi@ARM.com    pre_exec_time = time.time()
1066011Ssteve.reinhardt@amd.com    status = env.Execute(env.subst(cmd, target=target, source=source))
1076007Ssteve.reinhardt@amd.com    if status == 0:
1086007Ssteve.reinhardt@amd.com        # M5 terminated normally.
1096007Ssteve.reinhardt@amd.com        # Run diff on output & ref directories to find differences.
1106007Ssteve.reinhardt@amd.com        # Exclude the stats file since we will use diff-out on that.
1117735SAli.Saidi@ARM.com
1127735SAli.Saidi@ARM.com        # NFS file systems can be annoying and not have updated yet
1137735SAli.Saidi@ARM.com        # wait until we see the file modified
1147735SAli.Saidi@ARM.com        statsdiff = os.path.join(tgt_dir, 'statsdiff')
1157735SAli.Saidi@ARM.com        m_time = 0
1167735SAli.Saidi@ARM.com        nap = 0
1177735SAli.Saidi@ARM.com        while m_time < pre_exec_time and nap < 10:
1187735SAli.Saidi@ARM.com            try:
1197735SAli.Saidi@ARM.com                m_time = os.stat(statsdiff).st_mtime
1207735SAli.Saidi@ARM.com            except OSError:
1217735SAli.Saidi@ARM.com                pass
1227735SAli.Saidi@ARM.com            time.sleep(1)
1237735SAli.Saidi@ARM.com            nap += 1
1247735SAli.Saidi@ARM.com
1256007Ssteve.reinhardt@amd.com        outdiff = os.path.join(tgt_dir, 'outdiff')
1267685Ssteve.reinhardt@amd.com        diffcmd = 'diff -ubrs %s ${SOURCES[2].dir} %s > %s' \
1276007Ssteve.reinhardt@amd.com                  % (output_ignore_args, tgt_dir, outdiff)
1286011Ssteve.reinhardt@amd.com        env.Execute(env.subst(diffcmd, target=target, source=source))
1296007Ssteve.reinhardt@amd.com        print "===== Output differences ====="
1306007Ssteve.reinhardt@amd.com        print contents(outdiff)
1316007Ssteve.reinhardt@amd.com        # Run diff-out on stats.txt file
1326007Ssteve.reinhardt@amd.com        diffcmd = '$DIFFOUT ${SOURCES[2]} %s > %s' \
1336007Ssteve.reinhardt@amd.com                  % (os.path.join(tgt_dir, 'stats.txt'), statsdiff)
1346007Ssteve.reinhardt@amd.com        diffcmd = env.subst(diffcmd, target=target, source=source)
1356011Ssteve.reinhardt@amd.com        status = env.Execute(diffcmd, strfunction=None)
1366007Ssteve.reinhardt@amd.com        print "===== Statistics differences ====="
1376007Ssteve.reinhardt@amd.com        print contents(statsdiff)
1386007Ssteve.reinhardt@amd.com
1396007Ssteve.reinhardt@amd.com    else: # m5 exit status != 0
1406007Ssteve.reinhardt@amd.com        # M5 did not terminate properly, so no need to check the output
1416008Ssteve.reinhardt@amd.com        if signaled(status):
1426007Ssteve.reinhardt@amd.com            print 'M5 terminated with signal', signum(status)
1436008Ssteve.reinhardt@amd.com            if signum(status) in retry_signals:
1446008Ssteve.reinhardt@amd.com                # Consider the test incomplete; don't create a 'status' output.
1456008Ssteve.reinhardt@amd.com                # Hand the return status to scons and let scons decide what
1466008Ssteve.reinhardt@amd.com                # to do about it (typically terminate unless run with -k).
1476008Ssteve.reinhardt@amd.com                return status
1486008Ssteve.reinhardt@amd.com        else:
1496008Ssteve.reinhardt@amd.com            print 'M5 exited with non-zero status', status
1506007Ssteve.reinhardt@amd.com        # complete but failed execution (call to exit() with non-zero
1516007Ssteve.reinhardt@amd.com        # status, SIGABORT due to assertion failure, etc.)... fall through
1526007Ssteve.reinhardt@amd.com        # and generate FAILED status as if output comparison had failed
1536007Ssteve.reinhardt@amd.com
1546007Ssteve.reinhardt@amd.com    # Generate status file contents based on exit status of m5 or diff-out
1552929Sktlim@umich.edu    if status == 0:
1562929Sktlim@umich.edu        status_str = "passed."
1572929Sktlim@umich.edu    else:
1582929Sktlim@umich.edu        status_str = "FAILED!"
1596007Ssteve.reinhardt@amd.com    f = file(str(target[0]), 'w')
1606007Ssteve.reinhardt@amd.com    print >>f, tgt_dir, status_str
1612929Sktlim@umich.edu    f.close()
1622929Sktlim@umich.edu    # done
1632929Sktlim@umich.edu    return 0
1642929Sktlim@umich.edu
1656007Ssteve.reinhardt@amd.comdef run_test_string(target, source, env):
1666007Ssteve.reinhardt@amd.com    return env.subst("Running test in ${TARGETS[0].dir}.",
1672929Sktlim@umich.edu                     target=target, source=source)
1682929Sktlim@umich.edu
1696007Ssteve.reinhardt@amd.comtestAction = env.Action(run_test, run_test_string)
1702929Sktlim@umich.edu
1712929Sktlim@umich.edudef print_test(target, source, env):
1722929Sktlim@umich.edu    print '***** ' + contents(source[0])
1732929Sktlim@umich.edu    return 0
1742929Sktlim@umich.edu
1752929Sktlim@umich.eduprintAction = env.Action(print_test, strfunction = None)
1762929Sktlim@umich.edu
1774937Sstever@gmail.com# Static vars for update_test:
1784937Sstever@gmail.com# - long-winded message about ignored sources
1794937Sstever@gmail.comignore_msg = '''
1804937Sstever@gmail.comNote: The following file(s) will not be copied.  New non-standard
1818120Sgblack@eecs.umich.edu      output files must be copied manually once before --update-ref will
1824937Sstever@gmail.com      recognize them as outputs.  Otherwise they are assumed to be
1834937Sstever@gmail.com      inputs and are ignored.
1844937Sstever@gmail.com'''
1854937Sstever@gmail.com# - reference files always needed
1865773Snate@binkert.orgneeded_files = set(['simout', 'simerr', 'stats.txt', 'config.ini'])
1874937Sstever@gmail.com# - source files we always want to ignore
1884937Sstever@gmail.comknown_ignores = set(['status', 'outdiff', 'statsdiff'])
1894937Sstever@gmail.com
1902929Sktlim@umich.edudef update_test(target, source, env):
1912929Sktlim@umich.edu    """Update reference test outputs.
1922929Sktlim@umich.edu
1935773Snate@binkert.org    Target is phony.  First two sources are the ref & new stats.txt file
1942929Sktlim@umich.edu    files, respectively.  We actually copy everything in the
1952929Sktlim@umich.edu    respective directories except the status & diff output files.
1962929Sktlim@umich.edu
1972929Sktlim@umich.edu    """
1982929Sktlim@umich.edu    dest_dir = str(source[0].get_dir())
1992929Sktlim@umich.edu    src_dir = str(source[1].get_dir())
2004937Sstever@gmail.com    dest_files = set(os.listdir(dest_dir))
2014937Sstever@gmail.com    src_files = set(os.listdir(src_dir))
2024937Sstever@gmail.com    # Copy all of the required files plus any existing dest files.
2034937Sstever@gmail.com    wanted_files = needed_files | dest_files
2044937Sstever@gmail.com    missing_files = wanted_files - src_files
2054937Sstever@gmail.com    if len(missing_files) > 0:
2064937Sstever@gmail.com        print "  WARNING: the following file(s) are missing " \
2074937Sstever@gmail.com              "and will not be updated:"
2084937Sstever@gmail.com        print "    ", " ,".join(missing_files)
2094937Sstever@gmail.com    copy_files = wanted_files - missing_files
2104937Sstever@gmail.com    warn_ignored_files = (src_files - copy_files) - known_ignores
2114937Sstever@gmail.com    if len(warn_ignored_files) > 0:
2124937Sstever@gmail.com        print ignore_msg,
2134937Sstever@gmail.com        print "       ", ", ".join(warn_ignored_files)
2144937Sstever@gmail.com    for f in copy_files:
2152929Sktlim@umich.edu        if f in dest_files:
2162929Sktlim@umich.edu            print "  Replacing file", f
2172929Sktlim@umich.edu            dest_files.remove(f)
2182929Sktlim@umich.edu        else:
2192929Sktlim@umich.edu            print "  Creating new file", f
2202929Sktlim@umich.edu        copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
2212929Sktlim@umich.edu        copyAction.strfunction = None
2226011Ssteve.reinhardt@amd.com        env.Execute(copyAction)
2232929Sktlim@umich.edu    return 0
2242929Sktlim@umich.edu
2252929Sktlim@umich.edudef update_test_string(target, source, env):
2262929Sktlim@umich.edu    return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
2272929Sktlim@umich.edu                     target=target, source=source)
2282929Sktlim@umich.edu
2292929Sktlim@umich.eduupdateAction = env.Action(update_test, update_test_string)
2302929Sktlim@umich.edu
2312997Sstever@eecs.umich.edudef test_builder(env, ref_dir):
2322997Sstever@eecs.umich.edu    """Define a test."""
2332929Sktlim@umich.edu
2342997Sstever@eecs.umich.edu    (category, name, _ref, isa, opsys, config) = ref_dir.split('/')
2352997Sstever@eecs.umich.edu    assert(_ref == 'ref')
2362929Sktlim@umich.edu
2372997Sstever@eecs.umich.edu    # target path (where test output goes) is the same except without
2382997Sstever@eecs.umich.edu    # the 'ref' component
2392997Sstever@eecs.umich.edu    tgt_dir = os.path.join(category, name, isa, opsys, config)
2402929Sktlim@umich.edu
2412997Sstever@eecs.umich.edu    # prepend file name with tgt_dir
2422997Sstever@eecs.umich.edu    def tgt(f):
2432997Sstever@eecs.umich.edu        return os.path.join(tgt_dir, f)
2442997Sstever@eecs.umich.edu
2455773Snate@binkert.org    ref_stats = os.path.join(ref_dir, 'stats.txt')
2465773Snate@binkert.org    new_stats = tgt('stats.txt')
2472997Sstever@eecs.umich.edu    status_file = tgt('status')
2482997Sstever@eecs.umich.edu
2496007Ssteve.reinhardt@amd.com    env.Command([status_file],
2506007Ssteve.reinhardt@amd.com                [env.M5Binary, 'run.py', ref_stats],
2512997Sstever@eecs.umich.edu                testAction)
2522929Sktlim@umich.edu
2532997Sstever@eecs.umich.edu    # phony target to echo status
2548120Sgblack@eecs.umich.edu    if GetOption('update_ref'):
2552997Sstever@eecs.umich.edu        p = env.Command(tgt('_update'),
2562997Sstever@eecs.umich.edu                        [ref_stats, new_stats, status_file],
2572997Sstever@eecs.umich.edu                        updateAction)
2582997Sstever@eecs.umich.edu    else:
2592997Sstever@eecs.umich.edu        p = env.Command(tgt('_print'), [status_file], printAction)
2602929Sktlim@umich.edu
2612997Sstever@eecs.umich.edu    env.AlwaysBuild(p)
2622929Sktlim@umich.edu
2632929Sktlim@umich.edu
2643005Sstever@eecs.umich.edu# Figure out applicable configs based on build type
2653005Sstever@eecs.umich.educonfigs = []
2663005Sstever@eecs.umich.eduif env['FULL_SYSTEM']:
2673005Sstever@eecs.umich.edu    if env['TARGET_ISA'] == 'alpha':
2686025Snate@binkert.org        configs += ['tsunami-simple-atomic',
2696025Snate@binkert.org                    'tsunami-simple-timing',
2706025Snate@binkert.org                    'tsunami-simple-atomic-dual',
2716025Snate@binkert.org                    'tsunami-simple-timing-dual',
2726025Snate@binkert.org                    'twosys-tsunami-simple-atomic',
2736025Snate@binkert.org                    'tsunami-o3', 'tsunami-o3-dual']
2744130Ssaidi@eecs.umich.edu    if env['TARGET_ISA'] == 'sparc':
2754130Ssaidi@eecs.umich.edu        configs += ['t1000-simple-atomic',
2764130Ssaidi@eecs.umich.edu                    't1000-simple-timing']
2777735SAli.Saidi@ARM.com    if env['TARGET_ISA'] == 'arm':
2787735SAli.Saidi@ARM.com        configs += ['realview-simple-atomic',
2798150SAli.Saidi@ARM.com                    'realview-simple-timing',
2808150SAli.Saidi@ARM.com                    'realview-o3']
2817926Sgblack@eecs.umich.edu    if env['TARGET_ISA'] == 'x86':
2827926Sgblack@eecs.umich.edu        configs += ['pc-simple-atomic',
2837926Sgblack@eecs.umich.edu                    'pc-simple-timing']
2843691Shsul@eecs.umich.edu
2853005Sstever@eecs.umich.eduelse:
2865721Shsul@eecs.umich.edu    configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest',
2876194Sksewell@umich.edu                'simple-atomic-mp', 'simple-timing-mp', 'o3-timing-mp',
2886928SBrad.Beckmann@amd.com                'inorder-timing', 'rubytest']
2893005Sstever@eecs.umich.edu
2906168Snate@binkert.orgif env['RUBY']:
2916928SBrad.Beckmann@amd.com    # With Ruby, A protocol must be specified in the environment
2926928SBrad.Beckmann@amd.com    assert(env['PROTOCOL'])
2936928SBrad.Beckmann@amd.com
2946928SBrad.Beckmann@amd.com    #
2956928SBrad.Beckmann@amd.com    # Is there a way to determine what is Protocol EnumVariable
2966928SBrad.Beckmann@amd.com    # default and eliminate the need to hard code the default protocol below?
2976928SBrad.Beckmann@amd.com    #
2986928SBrad.Beckmann@amd.com    # If the binary includes the default ruby protocol, run both ruby and
2996928SBrad.Beckmann@amd.com    # non-ruby versions of the tests.  Otherwise just run the ruby versions.
3006928SBrad.Beckmann@amd.com    #
3016928SBrad.Beckmann@amd.com    if env['PROTOCOL'] == 'MI_example':
3026928SBrad.Beckmann@amd.com        configs += [c + "-ruby" for c in configs]
3036928SBrad.Beckmann@amd.com    else:
3046928SBrad.Beckmann@amd.com        configs = [c + "-ruby-" + env['PROTOCOL'] for c in configs]
3056166Ssteve.reinhardt@amd.com
3062929Sktlim@umich.educwd = os.getcwd()
3072929Sktlim@umich.eduos.chdir(str(Dir('.').srcdir))
3083005Sstever@eecs.umich.edufor config in configs:
3092997Sstever@eecs.umich.edu    dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
3102997Sstever@eecs.umich.edu    for d in dirs:
3116293Ssteve.reinhardt@amd.com        if not os.path.exists(os.path.join(d, 'skip')):
3126293Ssteve.reinhardt@amd.com            test_builder(env, d)
3132929Sktlim@umich.eduos.chdir(cwd)
314