SConscript revision 7735
1545SN/A# -*- mode:python -*- 22512SN/A 3545SN/A# Copyright (c) 2004-2006 The Regents of The University of Michigan 4545SN/A# All rights reserved. 5545SN/A# 6545SN/A# Redistribution and use in source and binary forms, with or without 7545SN/A# modification, are permitted provided that the following conditions are 8545SN/A# met: redistributions of source code must retain the above copyright 9545SN/A# notice, this list of conditions and the following disclaimer; 10545SN/A# redistributions in binary form must reproduce the above copyright 11545SN/A# notice, this list of conditions and the following disclaimer in the 12545SN/A# documentation and/or other materials provided with the distribution; 13545SN/A# neither the name of the copyright holders nor the names of its 14545SN/A# contributors may be used to endorse or promote products derived from 15545SN/A# this software without specific prior written permission. 16545SN/A# 17545SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18545SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19545SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20545SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21545SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22545SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23545SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24545SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25545SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26545SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 272665Ssaidi@eecs.umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 282665Ssaidi@eecs.umich.edu# 292665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt 30545SN/A# Kevin Lim 31545SN/A 322657Ssaidi@eecs.umich.eduimport os, signal 33545SN/Aimport sys, time 34679SN/Aimport glob 352901Ssaidi@eecs.umich.edufrom SCons.Script.SConscript import SConsEnvironment 36545SN/A 372489SN/AImport('env') 382901Ssaidi@eecs.umich.edu 392901Ssaidi@eecs.umich.eduenv['DIFFOUT'] = File('diff-out') 402901Ssaidi@eecs.umich.edu 412489SN/A# Dict that accumulates lists of tests by category (quick, medium, long) 422489SN/Aenv.Tests = {} 432489SN/A 442489SN/Adef contents(node): 452630SN/A return file(str(node)).read() 462489SN/A 472489SN/A# functions to parse return value from scons Execute()... not the same 482489SN/A# as wait() etc., so python built-in os funcs don't work. 492489SN/Adef signaled(status): 502489SN/A return (status & 0x80) != 0; 512630SN/A 522489SN/Adef signum(status): 532489SN/A return (status & 0x7f); 542489SN/A 552489SN/A# List of signals that indicate that we should retry the test rather 562489SN/A# than consider it failed. 572521SN/Aretry_signals = (signal.SIGTERM, signal.SIGKILL, signal.SIGINT, 582489SN/A signal.SIGQUIT, signal.SIGHUP) 592521SN/A 602521SN/A# regular expressions of lines to ignore when diffing outputs 612489SN/Aoutput_ignore_regexes = ( 622489SN/A '^command line:', # for stdout file 632489SN/A '^M5 compiled ', # for stderr file 642657Ssaidi@eecs.umich.edu '^M5 started ', # for stderr file 652489SN/A '^M5 executing on ', # for stderr file 662489SN/A '^Simulation complete at', # for stderr file 672784Ssaidi@eecs.umich.edu '^Listening for', # for stderr file 682784Ssaidi@eecs.umich.edu 'listening for remote gdb', # for stderr file 692784Ssaidi@eecs.umich.edu ) 702784Ssaidi@eecs.umich.edu 712784Ssaidi@eecs.umich.eduoutput_ignore_args = ' '.join(["-I '"+s+"'" for s in output_ignore_regexes]) 722657Ssaidi@eecs.umich.edu 732901Ssaidi@eecs.umich.eduoutput_ignore_args += ' --exclude=stats.txt --exclude=outdiff' 742901Ssaidi@eecs.umich.edu 752901Ssaidi@eecs.umich.edudef run_test(target, source, env): 762901Ssaidi@eecs.umich.edu """Check output from running test. 772489SN/A 782489SN/A Targets are as follows: 792384SN/A target[0] : status 802384SN/A 812384SN/A Sources are: 822901Ssaidi@eecs.umich.edu source[0] : M5 binary 832901Ssaidi@eecs.umich.edu source[1] : tests/run.py script 842641Sstever@eecs.umich.edu source[2] : reference stats file 852901Ssaidi@eecs.umich.edu 862901Ssaidi@eecs.umich.edu """ 872901Ssaidi@eecs.umich.edu # make sure target files are all gone 882901Ssaidi@eecs.umich.edu for t in target: 892901Ssaidi@eecs.umich.edu if os.path.exists(t.abspath): 902384SN/A env.Execute(Delete(t.abspath)) 912630SN/A 922384SN/A tgt_dir = os.path.dirname(str(target[0])) 932384SN/A 942846Ssaidi@eecs.umich.edu # Base command for running test. We mess around with indirectly 952846Ssaidi@eecs.umich.edu # referring to files via SOURCES and TARGETS so that scons can mess 962846Ssaidi@eecs.umich.edu # with paths all it wants to and we still get the right files. 972846Ssaidi@eecs.umich.edu cmd = '${SOURCES[0]} -d %s -re ${SOURCES[1]} %s' % (tgt_dir, tgt_dir) 982846Ssaidi@eecs.umich.edu 992846Ssaidi@eecs.umich.edu # Prefix test run with batch job submission command if appropriate. 1002846Ssaidi@eecs.umich.edu # Batch command also supports timeout arg (in seconds, not minutes). 1012846Ssaidi@eecs.umich.edu timeout = 15 * 60 # used to be a param, probably should be again 1022846Ssaidi@eecs.umich.edu if env['BATCH']: 1032846Ssaidi@eecs.umich.edu cmd = '%s -t %d %s' % (env['BATCH_CMD'], timeout, cmd) 1042384SN/A 1052657Ssaidi@eecs.umich.edu pre_exec_time = time.time() 1062384SN/A status = env.Execute(env.subst(cmd, target=target, source=source)) 1072630SN/A if status == 0: 1082384SN/A # M5 terminated normally. 1092784Ssaidi@eecs.umich.edu # Run diff on output & ref directories to find differences. 1102846Ssaidi@eecs.umich.edu # Exclude the stats file since we will use diff-out on that. 1112784Ssaidi@eecs.umich.edu 1122784Ssaidi@eecs.umich.edu # NFS file systems can be annoying and not have updated yet 1132784Ssaidi@eecs.umich.edu # wait until we see the file modified 1142784Ssaidi@eecs.umich.edu statsdiff = os.path.join(tgt_dir, 'statsdiff') 1152784Ssaidi@eecs.umich.edu m_time = 0 1162784Ssaidi@eecs.umich.edu nap = 0 1172641Sstever@eecs.umich.edu while m_time < pre_exec_time and nap < 10: 1182384SN/A try: 119545SN/A m_time = os.stat(statsdiff).st_mtime 1202901Ssaidi@eecs.umich.edu except OSError: 1212901Ssaidi@eecs.umich.edu pass 1222901Ssaidi@eecs.umich.edu time.sleep(1) 1232901Ssaidi@eecs.umich.edu nap += 1 1242901Ssaidi@eecs.umich.edu 1252901Ssaidi@eecs.umich.edu outdiff = os.path.join(tgt_dir, 'outdiff') 1262901Ssaidi@eecs.umich.edu diffcmd = 'diff -ubrs %s ${SOURCES[2].dir} %s > %s' \ 1272901Ssaidi@eecs.umich.edu % (output_ignore_args, tgt_dir, outdiff) 1282901Ssaidi@eecs.umich.edu env.Execute(env.subst(diffcmd, target=target, source=source)) 129545SN/A print "===== Output differences =====" 130545SN/A print contents(outdiff) 1312384SN/A # Run diff-out on stats.txt file 1322489SN/A diffcmd = '$DIFFOUT ${SOURCES[2]} %s > %s' \ 133545SN/A % (os.path.join(tgt_dir, 'stats.txt'), statsdiff) 134545SN/A diffcmd = env.subst(diffcmd, target=target, source=source) 1352542SN/A status = env.Execute(diffcmd, strfunction=None) 1362541SN/A print "===== Statistics differences =====" 1372541SN/A print contents(statsdiff) 1382541SN/A 1392541SN/A else: # m5 exit status != 0 1402541SN/A # M5 did not terminate properly, so no need to check the output 1412541SN/A if signaled(status): 1422541SN/A print 'M5 terminated with signal', signum(status) 1432901Ssaidi@eecs.umich.edu if signum(status) in retry_signals: 1442901Ssaidi@eecs.umich.edu # Consider the test incomplete; don't create a 'status' output. 1452901Ssaidi@eecs.umich.edu # Hand the return status to scons and let scons decide what 1462901Ssaidi@eecs.umich.edu # to do about it (typically terminate unless run with -k). 1472901Ssaidi@eecs.umich.edu return status 1482901Ssaidi@eecs.umich.edu else: 1492901Ssaidi@eecs.umich.edu print 'M5 exited with non-zero status', status 1502901Ssaidi@eecs.umich.edu # complete but failed execution (call to exit() with non-zero 1512901Ssaidi@eecs.umich.edu # status, SIGABORT due to assertion failure, etc.)... fall through 1522901Ssaidi@eecs.umich.edu # and generate FAILED status as if output comparison had failed 1532901Ssaidi@eecs.umich.edu 1542901Ssaidi@eecs.umich.edu # Generate status file contents based on exit status of m5 or diff-out 1552901Ssaidi@eecs.umich.edu if status == 0: 1562539SN/A status_str = "passed." 1572539SN/A else: 1582539SN/A status_str = "FAILED!" 1592539SN/A f = file(str(target[0]), 'w') 1602539SN/A print >>f, tgt_dir, status_str 1612539SN/A f.close() 1622539SN/A # done 1632539SN/A return 0 1642489SN/A 1652901Ssaidi@eecs.umich.edudef run_test_string(target, source, env): 1662901Ssaidi@eecs.umich.edu return env.subst("Running test in ${TARGETS[0].dir}.", 1672901Ssaidi@eecs.umich.edu target=target, source=source) 1682489SN/A 1692489SN/AtestAction = env.Action(run_test, run_test_string) 1702489SN/A 1712630SN/Adef print_test(target, source, env): 1722384SN/A print '***** ' + contents(source[0]) 1732685Ssaidi@eecs.umich.edu return 0 1742685Ssaidi@eecs.umich.edu 1752685Ssaidi@eecs.umich.eduprintAction = env.Action(print_test, strfunction = None) 1762685Ssaidi@eecs.umich.edu 1772685Ssaidi@eecs.umich.edu# Static vars for update_test: 1782685Ssaidi@eecs.umich.edu# - long-winded message about ignored sources 1792685Ssaidi@eecs.umich.eduignore_msg = ''' 1802685Ssaidi@eecs.umich.eduNote: The following file(s) will not be copied. New non-standard 1812565SN/A output files must be copied manually once before update_ref will 1822685Ssaidi@eecs.umich.edu recognize them as outputs. Otherwise they are assumed to be 1832685Ssaidi@eecs.umich.edu inputs and are ignored. 1842641Sstever@eecs.umich.edu''' 1852685Ssaidi@eecs.umich.edu# - reference files always needed 1862685Ssaidi@eecs.umich.eduneeded_files = set(['simout', 'simerr', 'stats.txt', 'config.ini']) 1872685Ssaidi@eecs.umich.edu# - source files we always want to ignore 1882657Ssaidi@eecs.umich.eduknown_ignores = set(['status', 'outdiff', 'statsdiff']) 1892685Ssaidi@eecs.umich.edu 1902685Ssaidi@eecs.umich.edudef update_test(target, source, env): 1912685Ssaidi@eecs.umich.edu """Update reference test outputs. 1922685Ssaidi@eecs.umich.edu 1932685Ssaidi@eecs.umich.edu Target is phony. First two sources are the ref & new stats.txt file 1942685Ssaidi@eecs.umich.edu files, respectively. We actually copy everything in the 1952630SN/A respective directories except the status & diff output files. 1962630SN/A 1972901Ssaidi@eecs.umich.edu """ 1982901Ssaidi@eecs.umich.edu dest_dir = str(source[0].get_dir()) 1992901Ssaidi@eecs.umich.edu src_dir = str(source[1].get_dir()) 2002901Ssaidi@eecs.umich.edu dest_files = set(os.listdir(dest_dir)) 2012901Ssaidi@eecs.umich.edu src_files = set(os.listdir(src_dir)) 2022569SN/A # Copy all of the required files plus any existing dest files. 2032685Ssaidi@eecs.umich.edu wanted_files = needed_files | dest_files 2042565SN/A missing_files = wanted_files - src_files 2052569SN/A if len(missing_files) > 0: 2062657Ssaidi@eecs.umich.edu print " WARNING: the following file(s) are missing " \ 2072384SN/A "and will not be updated:" 208679SN/A print " ", " ,".join(missing_files) 2092521SN/A copy_files = wanted_files - missing_files 2102565SN/A warn_ignored_files = (src_files - copy_files) - known_ignores 2112565SN/A if len(warn_ignored_files) > 0: 2122384SN/A print ignore_msg, 2132901Ssaidi@eecs.umich.edu print " ", ", ".join(warn_ignored_files) 2142901Ssaidi@eecs.umich.edu for f in copy_files: 2152901Ssaidi@eecs.umich.edu if f in dest_files: 2162901Ssaidi@eecs.umich.edu print " Replacing file", f 2172901Ssaidi@eecs.umich.edu dest_files.remove(f) 2182901Ssaidi@eecs.umich.edu else: 2192901Ssaidi@eecs.umich.edu print " Creating new file", f 2202901Ssaidi@eecs.umich.edu copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f)) 2212901Ssaidi@eecs.umich.edu copyAction.strfunction = None 2222901Ssaidi@eecs.umich.edu env.Execute(copyAction) 2232901Ssaidi@eecs.umich.edu return 0 2242901Ssaidi@eecs.umich.edu 2252901Ssaidi@eecs.umich.edudef update_test_string(target, source, env): 2262901Ssaidi@eecs.umich.edu return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}", 2272901Ssaidi@eecs.umich.edu target=target, source=source) 2282901Ssaidi@eecs.umich.edu 2292901Ssaidi@eecs.umich.eduupdateAction = env.Action(update_test, update_test_string) 2302901Ssaidi@eecs.umich.edu 2312901Ssaidi@eecs.umich.edudef test_builder(env, ref_dir): 2322901Ssaidi@eecs.umich.edu """Define a test.""" 2332901Ssaidi@eecs.umich.edu 2342901Ssaidi@eecs.umich.edu (category, name, _ref, isa, opsys, config) = ref_dir.split('/') 2352901Ssaidi@eecs.umich.edu assert(_ref == 'ref') 2362384SN/A 2372489SN/A # target path (where test output goes) is the same except without 2382489SN/A # the 'ref' component 2392489SN/A tgt_dir = os.path.join(category, name, isa, opsys, config) 2402659Ssaidi@eecs.umich.edu 2412659Ssaidi@eecs.umich.edu # prepend file name with tgt_dir 2422659Ssaidi@eecs.umich.edu def tgt(f): 2432659Ssaidi@eecs.umich.edu return os.path.join(tgt_dir, f) 2442659Ssaidi@eecs.umich.edu 2452659Ssaidi@eecs.umich.edu ref_stats = os.path.join(ref_dir, 'stats.txt') 2462659Ssaidi@eecs.umich.edu new_stats = tgt('stats.txt') 2472659Ssaidi@eecs.umich.edu status_file = tgt('status') 2482659Ssaidi@eecs.umich.edu 2492659Ssaidi@eecs.umich.edu env.Command([status_file], 2502659Ssaidi@eecs.umich.edu [env.M5Binary, 'run.py', ref_stats], 2512657Ssaidi@eecs.umich.edu testAction) 2522489SN/A 2532641Sstever@eecs.umich.edu # phony target to echo status 2542641Sstever@eecs.umich.edu if env['update_ref']: 2552489SN/A p = env.Command(tgt('_update'), 2562641Sstever@eecs.umich.edu [ref_stats, new_stats, status_file], 2572641Sstever@eecs.umich.edu updateAction) 2582384SN/A else: 2592384SN/A p = env.Command(tgt('_print'), [status_file], printAction) 2602384SN/A 2612901Ssaidi@eecs.umich.edu env.AlwaysBuild(p) 2622901Ssaidi@eecs.umich.edu 2632685Ssaidi@eecs.umich.edu 2642384SN/A# Figure out applicable configs based on build type 2652406SN/Aconfigs = [] 2662406SN/Aif env['FULL_SYSTEM']: 2672663Sstever@eecs.umich.edu if env['TARGET_ISA'] == 'alpha': 2682641Sstever@eecs.umich.edu configs += ['tsunami-simple-atomic', 2692641Sstever@eecs.umich.edu 'tsunami-simple-timing', 2702384SN/A 'tsunami-simple-atomic-dual', 2712566SN/A 'tsunami-simple-timing-dual', 2722685Ssaidi@eecs.umich.edu 'twosys-tsunami-simple-atomic', 2732641Sstever@eecs.umich.edu 'tsunami-o3', 'tsunami-o3-dual'] 2742685Ssaidi@eecs.umich.edu if env['TARGET_ISA'] == 'sparc': 2752641Sstever@eecs.umich.edu configs += ['t1000-simple-atomic', 2762565SN/A 't1000-simple-timing'] 2772565SN/A if env['TARGET_ISA'] == 'arm': 2782566SN/A configs += ['realview-simple-atomic', 2792384SN/A 'realview-simple-timing'] 2802901Ssaidi@eecs.umich.edu 2812384SN/Aelse: 2822384SN/A configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest', 2832384SN/A 'simple-atomic-mp', 'simple-timing-mp', 'o3-timing-mp', 2842384SN/A 'inorder-timing', 'rubytest'] 2852685Ssaidi@eecs.umich.edu 2862384SN/Aif env['RUBY']: 2872901Ssaidi@eecs.umich.edu # With Ruby, A protocol must be specified in the environment 2882901Ssaidi@eecs.umich.edu assert(env['PROTOCOL']) 2892901Ssaidi@eecs.umich.edu 2902902Ssaidi@eecs.umich.edu # 2912901Ssaidi@eecs.umich.edu # Is there a way to determine what is Protocol EnumVariable 2922901Ssaidi@eecs.umich.edu # default and eliminate the need to hard code the default protocol below? 2932901Ssaidi@eecs.umich.edu # 2942901Ssaidi@eecs.umich.edu # If the binary includes the default ruby protocol, run both ruby and 2952901Ssaidi@eecs.umich.edu # non-ruby versions of the tests. Otherwise just run the ruby versions. 2962901Ssaidi@eecs.umich.edu # 2972901Ssaidi@eecs.umich.edu if env['PROTOCOL'] == 'MI_example': 2982901Ssaidi@eecs.umich.edu configs += [c + "-ruby" for c in configs] 2992901Ssaidi@eecs.umich.edu else: 3002901Ssaidi@eecs.umich.edu configs = [c + "-ruby-" + env['PROTOCOL'] for c in configs] 3012901Ssaidi@eecs.umich.edu 3022901Ssaidi@eecs.umich.educwd = os.getcwd() 3032901Ssaidi@eecs.umich.eduos.chdir(str(Dir('.').srcdir)) 3042901Ssaidi@eecs.umich.edufor config in configs: 3052902Ssaidi@eecs.umich.edu dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config)) 3062902Ssaidi@eecs.umich.edu for d in dirs: 3072901Ssaidi@eecs.umich.edu if not os.path.exists(os.path.join(d, 'skip')): 3082901Ssaidi@eecs.umich.edu test_builder(env, d) 3092901Ssaidi@eecs.umich.eduos.chdir(cwd) 3102384SN/A