SConscript revision 9435
113481Sgiacomo.travaglini@arm.com# -*- mode:python -*- 213481Sgiacomo.travaglini@arm.com 313481Sgiacomo.travaglini@arm.com# Copyright (c) 2004-2006 The Regents of The University of Michigan 413481Sgiacomo.travaglini@arm.com# All rights reserved. 513481Sgiacomo.travaglini@arm.com# 613481Sgiacomo.travaglini@arm.com# Redistribution and use in source and binary forms, with or without 713481Sgiacomo.travaglini@arm.com# modification, are permitted provided that the following conditions are 813481Sgiacomo.travaglini@arm.com# met: redistributions of source code must retain the above copyright 913481Sgiacomo.travaglini@arm.com# notice, this list of conditions and the following disclaimer; 1013481Sgiacomo.travaglini@arm.com# redistributions in binary form must reproduce the above copyright 1113481Sgiacomo.travaglini@arm.com# notice, this list of conditions and the following disclaimer in the 1213481Sgiacomo.travaglini@arm.com# documentation and/or other materials provided with the distribution; 1313481Sgiacomo.travaglini@arm.com# neither the name of the copyright holders nor the names of its 1413481Sgiacomo.travaglini@arm.com# contributors may be used to endorse or promote products derived from 1513481Sgiacomo.travaglini@arm.com# this software without specific prior written permission. 1613481Sgiacomo.travaglini@arm.com# 1713481Sgiacomo.travaglini@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1813481Sgiacomo.travaglini@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1913481Sgiacomo.travaglini@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2013481Sgiacomo.travaglini@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2113481Sgiacomo.travaglini@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2213481Sgiacomo.travaglini@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2313481Sgiacomo.travaglini@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2413481Sgiacomo.travaglini@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2513481Sgiacomo.travaglini@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2613481Sgiacomo.travaglini@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2713481Sgiacomo.travaglini@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2813481Sgiacomo.travaglini@arm.com# 2913481Sgiacomo.travaglini@arm.com# Authors: Steve Reinhardt 3013481Sgiacomo.travaglini@arm.com# Kevin Lim 3113481Sgiacomo.travaglini@arm.com 3213481Sgiacomo.travaglini@arm.comimport os, signal 3313481Sgiacomo.travaglini@arm.comimport sys, time 3413481Sgiacomo.travaglini@arm.comimport glob 3513481Sgiacomo.travaglini@arm.comfrom SCons.Script.SConscript import SConsEnvironment 3613481Sgiacomo.travaglini@arm.com 3713481Sgiacomo.travaglini@arm.comImport('env') 3813481Sgiacomo.travaglini@arm.com 3913481Sgiacomo.travaglini@arm.comenv['DIFFOUT'] = File('diff-out') 4013481Sgiacomo.travaglini@arm.com 4113481Sgiacomo.travaglini@arm.com# get the termcap from the environment 4213481Sgiacomo.travaglini@arm.comtermcap = env['TERMCAP'] 4313481Sgiacomo.travaglini@arm.com 4413481Sgiacomo.travaglini@arm.com# Dict that accumulates lists of tests by category (quick, medium, long) 4513481Sgiacomo.travaglini@arm.comenv.Tests = {} 4613481Sgiacomo.travaglini@arm.com 4713481Sgiacomo.travaglini@arm.comdef contents(node): 4813481Sgiacomo.travaglini@arm.com return file(str(node)).read() 4913481Sgiacomo.travaglini@arm.com 5013481Sgiacomo.travaglini@arm.com# functions to parse return value from scons Execute()... not the same 5113481Sgiacomo.travaglini@arm.com# as wait() etc., so python built-in os funcs don't work. 5213481Sgiacomo.travaglini@arm.comdef signaled(status): 5313481Sgiacomo.travaglini@arm.com return (status & 0x80) != 0; 5413481Sgiacomo.travaglini@arm.com 5513481Sgiacomo.travaglini@arm.comdef signum(status): 5613481Sgiacomo.travaglini@arm.com return (status & 0x7f); 5713481Sgiacomo.travaglini@arm.com 5813481Sgiacomo.travaglini@arm.com# List of signals that indicate that we should retry the test rather 5913481Sgiacomo.travaglini@arm.com# than consider it failed. 6013481Sgiacomo.travaglini@arm.comretry_signals = (signal.SIGTERM, signal.SIGKILL, signal.SIGINT, 6113481Sgiacomo.travaglini@arm.com signal.SIGQUIT, signal.SIGHUP) 6213481Sgiacomo.travaglini@arm.com 6313481Sgiacomo.travaglini@arm.com# regular expressions of lines to ignore when diffing outputs 6413481Sgiacomo.travaglini@arm.comoutput_ignore_regexes = ( 6513481Sgiacomo.travaglini@arm.com '^command line:', # for stdout file 6613481Sgiacomo.travaglini@arm.com '^gem5 compiled ', # for stderr file 6713481Sgiacomo.travaglini@arm.com '^gem5 started ', # for stderr file 6813481Sgiacomo.travaglini@arm.com '^gem5 executing on ', # for stderr file 6913481Sgiacomo.travaglini@arm.com '^Simulation complete at', # for stderr file 7013481Sgiacomo.travaglini@arm.com '^Listening for', # for stderr file 7113481Sgiacomo.travaglini@arm.com 'listening for remote gdb', # for stderr file 7213481Sgiacomo.travaglini@arm.com ) 7313481Sgiacomo.travaglini@arm.com 7413481Sgiacomo.travaglini@arm.comoutput_ignore_args = ' '.join(["-I '"+s+"'" for s in output_ignore_regexes]) 7513481Sgiacomo.travaglini@arm.com 7613481Sgiacomo.travaglini@arm.comoutput_ignore_args += ' --exclude=stats.txt --exclude=outdiff' 7713481Sgiacomo.travaglini@arm.com 7813481Sgiacomo.travaglini@arm.comdef run_test(target, source, env): 7913481Sgiacomo.travaglini@arm.com """Check output from running test. 8013481Sgiacomo.travaglini@arm.com 8113481Sgiacomo.travaglini@arm.com Targets are as follows: 8213481Sgiacomo.travaglini@arm.com target[0] : status 8313481Sgiacomo.travaglini@arm.com 8413481Sgiacomo.travaglini@arm.com Sources are: 8513481Sgiacomo.travaglini@arm.com source[0] : M5 binary 8613481Sgiacomo.travaglini@arm.com source[1] : tests/run.py script 8713481Sgiacomo.travaglini@arm.com source[2] : reference stats file 8813481Sgiacomo.travaglini@arm.com 8913481Sgiacomo.travaglini@arm.com """ 9013481Sgiacomo.travaglini@arm.com # make sure target files are all gone 9113481Sgiacomo.travaglini@arm.com for t in target: 9213481Sgiacomo.travaglini@arm.com if os.path.exists(t.abspath): 9313481Sgiacomo.travaglini@arm.com env.Execute(Delete(t.abspath)) 9413481Sgiacomo.travaglini@arm.com 9513481Sgiacomo.travaglini@arm.com tgt_dir = os.path.dirname(str(target[0])) 9613481Sgiacomo.travaglini@arm.com 9713481Sgiacomo.travaglini@arm.com # Base command for running test. We mess around with indirectly 9813481Sgiacomo.travaglini@arm.com # referring to files via SOURCES and TARGETS so that scons can mess 9913481Sgiacomo.travaglini@arm.com # with paths all it wants to and we still get the right files. 10013481Sgiacomo.travaglini@arm.com cmd = '${SOURCES[0]} -d %s -re ${SOURCES[1]} %s' % (tgt_dir, tgt_dir) 10113481Sgiacomo.travaglini@arm.com 10213481Sgiacomo.travaglini@arm.com # Prefix test run with batch job submission command if appropriate. 10313481Sgiacomo.travaglini@arm.com # Batch command also supports timeout arg (in seconds, not minutes). 10413481Sgiacomo.travaglini@arm.com timeout = 15 * 60 # used to be a param, probably should be again 10513481Sgiacomo.travaglini@arm.com if env['BATCH']: 10613481Sgiacomo.travaglini@arm.com cmd = '%s -t %d %s' % (env['BATCH_CMD'], timeout, cmd) 10713481Sgiacomo.travaglini@arm.com 10813481Sgiacomo.travaglini@arm.com pre_exec_time = time.time() 10913481Sgiacomo.travaglini@arm.com status = env.Execute(env.subst(cmd, target=target, source=source)) 11013481Sgiacomo.travaglini@arm.com if status == 0: 11113481Sgiacomo.travaglini@arm.com # M5 terminated normally. 11213481Sgiacomo.travaglini@arm.com # Run diff on output & ref directories to find differences. 11313481Sgiacomo.travaglini@arm.com # Exclude the stats file since we will use diff-out on that. 11413481Sgiacomo.travaglini@arm.com 11513481Sgiacomo.travaglini@arm.com # NFS file systems can be annoying and not have updated yet 11613481Sgiacomo.travaglini@arm.com # wait until we see the file modified 11713481Sgiacomo.travaglini@arm.com statsdiff = os.path.join(tgt_dir, 'statsdiff') 11813481Sgiacomo.travaglini@arm.com m_time = 0 11913481Sgiacomo.travaglini@arm.com nap = 0 12013481Sgiacomo.travaglini@arm.com while m_time < pre_exec_time and nap < 10: 12113481Sgiacomo.travaglini@arm.com try: 12213481Sgiacomo.travaglini@arm.com m_time = os.stat(statsdiff).st_mtime 12313481Sgiacomo.travaglini@arm.com except OSError: 12413481Sgiacomo.travaglini@arm.com pass 12513481Sgiacomo.travaglini@arm.com time.sleep(1) 12613481Sgiacomo.travaglini@arm.com nap += 1 12713481Sgiacomo.travaglini@arm.com 12813481Sgiacomo.travaglini@arm.com outdiff = os.path.join(tgt_dir, 'outdiff') 12913481Sgiacomo.travaglini@arm.com # tack 'true' on the end so scons doesn't report diff's 13013481Sgiacomo.travaglini@arm.com # non-zero exit code as a build error 13113481Sgiacomo.travaglini@arm.com diffcmd = 'diff -ubrs %s ${SOURCES[2].dir} %s > %s; true' \ 13213481Sgiacomo.travaglini@arm.com % (output_ignore_args, tgt_dir, outdiff) 13313481Sgiacomo.travaglini@arm.com env.Execute(env.subst(diffcmd, target=target, source=source)) 13413481Sgiacomo.travaglini@arm.com print "===== Output differences =====" 13513481Sgiacomo.travaglini@arm.com print contents(outdiff) 13613481Sgiacomo.travaglini@arm.com # Run diff-out on stats.txt file 13713481Sgiacomo.travaglini@arm.com diffcmd = '$DIFFOUT ${SOURCES[2]} %s > %s' \ 13813481Sgiacomo.travaglini@arm.com % (os.path.join(tgt_dir, 'stats.txt'), statsdiff) 13913481Sgiacomo.travaglini@arm.com diffcmd = env.subst(diffcmd, target=target, source=source) 14013481Sgiacomo.travaglini@arm.com status = env.Execute(diffcmd, strfunction=None) 14113481Sgiacomo.travaglini@arm.com print "===== Statistics differences =====" 14213481Sgiacomo.travaglini@arm.com print contents(statsdiff) 14313481Sgiacomo.travaglini@arm.com 14413481Sgiacomo.travaglini@arm.com else: # m5 exit status != 0 14513481Sgiacomo.travaglini@arm.com # M5 did not terminate properly, so no need to check the output 14613481Sgiacomo.travaglini@arm.com if signaled(status): 14713481Sgiacomo.travaglini@arm.com print 'M5 terminated with signal', signum(status) 14813481Sgiacomo.travaglini@arm.com if signum(status) in retry_signals: 14913481Sgiacomo.travaglini@arm.com # Consider the test incomplete; don't create a 'status' output. 15013481Sgiacomo.travaglini@arm.com # Hand the return status to scons and let scons decide what 15113481Sgiacomo.travaglini@arm.com # to do about it (typically terminate unless run with -k). 15213481Sgiacomo.travaglini@arm.com return status 15313481Sgiacomo.travaglini@arm.com elif status == 2: 15413481Sgiacomo.travaglini@arm.com # The test was skipped 15513481Sgiacomo.travaglini@arm.com pass 15613481Sgiacomo.travaglini@arm.com else: 15713481Sgiacomo.travaglini@arm.com print 'M5 exited with non-zero status', status 15813481Sgiacomo.travaglini@arm.com # complete but failed execution (call to exit() with non-zero 15913481Sgiacomo.travaglini@arm.com # status, SIGABORT due to assertion failure, etc.)... fall through 16013481Sgiacomo.travaglini@arm.com # and generate FAILED status as if output comparison had failed 16113481Sgiacomo.travaglini@arm.com 16213481Sgiacomo.travaglini@arm.com # Generate status file contents based on exit status of m5 or diff-out 16313481Sgiacomo.travaglini@arm.com if status == 0: 16413481Sgiacomo.travaglini@arm.com status_str = "passed." 16513481Sgiacomo.travaglini@arm.com elif status == 2: 16613481Sgiacomo.travaglini@arm.com status_str = "skipped." 16713481Sgiacomo.travaglini@arm.com else: 16813481Sgiacomo.travaglini@arm.com status_str = "FAILED!" 16913481Sgiacomo.travaglini@arm.com f = file(str(target[0]), 'w') 17013481Sgiacomo.travaglini@arm.com print >>f, tgt_dir, status_str 17113481Sgiacomo.travaglini@arm.com f.close() 17213481Sgiacomo.travaglini@arm.com # done 17313481Sgiacomo.travaglini@arm.com return 0 17413481Sgiacomo.travaglini@arm.com 17513481Sgiacomo.travaglini@arm.comdef run_test_string(target, source, env): 17613481Sgiacomo.travaglini@arm.com return env.subst("Running test in ${TARGETS[0].dir}.", 17713481Sgiacomo.travaglini@arm.com target=target, source=source) 17813481Sgiacomo.travaglini@arm.com 17913481Sgiacomo.travaglini@arm.comtestAction = env.Action(run_test, run_test_string) 18013481Sgiacomo.travaglini@arm.com 18113481Sgiacomo.travaglini@arm.comdef print_test(target, source, env): 18213481Sgiacomo.travaglini@arm.com # print the status with colours to make it easier to see what 18313481Sgiacomo.travaglini@arm.com # passed and what failed 18413481Sgiacomo.travaglini@arm.com line = contents(source[0]) 18513481Sgiacomo.travaglini@arm.com 18613481Sgiacomo.travaglini@arm.com # split the line to words and get the last one 18713481Sgiacomo.travaglini@arm.com words = line.split() 18813481Sgiacomo.travaglini@arm.com status = words[-1] 18913481Sgiacomo.travaglini@arm.com 19013481Sgiacomo.travaglini@arm.com # if the test failed make it red, if it passed make it green, and 19113481Sgiacomo.travaglini@arm.com # skip the punctuation 19213481Sgiacomo.travaglini@arm.com if status == "FAILED!": 19313481Sgiacomo.travaglini@arm.com status = termcap.Red + status[:-1] + termcap.Normal + status[-1] 19413481Sgiacomo.travaglini@arm.com elif status == "passed.": 19513481Sgiacomo.travaglini@arm.com status = termcap.Green + status[:-1] + termcap.Normal + status[-1] 19613481Sgiacomo.travaglini@arm.com elif status == "skipped.": 19713481Sgiacomo.travaglini@arm.com status = termcap.Yellow + status[:-1] + termcap.Normal + status[-1] 19813481Sgiacomo.travaglini@arm.com 19913481Sgiacomo.travaglini@arm.com # put it back in the list and join with space 20013481Sgiacomo.travaglini@arm.com words[-1] = status 20113481Sgiacomo.travaglini@arm.com line = " ".join(words) 20213481Sgiacomo.travaglini@arm.com 20313481Sgiacomo.travaglini@arm.com print '***** ' + line 20413481Sgiacomo.travaglini@arm.com return 0 20513481Sgiacomo.travaglini@arm.com 20613481Sgiacomo.travaglini@arm.comprintAction = env.Action(print_test, strfunction = None) 20713481Sgiacomo.travaglini@arm.com 20813481Sgiacomo.travaglini@arm.com# Static vars for update_test: 20913481Sgiacomo.travaglini@arm.com# - long-winded message about ignored sources 21013481Sgiacomo.travaglini@arm.comignore_msg = ''' 21113481Sgiacomo.travaglini@arm.comNote: The following file(s) will not be copied. New non-standard 21213481Sgiacomo.travaglini@arm.com output files must be copied manually once before --update-ref will 21313481Sgiacomo.travaglini@arm.com recognize them as outputs. Otherwise they are assumed to be 21413481Sgiacomo.travaglini@arm.com inputs and are ignored. 21513481Sgiacomo.travaglini@arm.com''' 21613481Sgiacomo.travaglini@arm.com# - reference files always needed 21713481Sgiacomo.travaglini@arm.comneeded_files = set(['simout', 'simerr', 'stats.txt', 'config.ini']) 21813481Sgiacomo.travaglini@arm.com# - source files we always want to ignore 21913481Sgiacomo.travaglini@arm.comknown_ignores = set(['status', 'outdiff', 'statsdiff']) 22013481Sgiacomo.travaglini@arm.com 22113481Sgiacomo.travaglini@arm.comdef update_test(target, source, env): 22213481Sgiacomo.travaglini@arm.com """Update reference test outputs. 22313481Sgiacomo.travaglini@arm.com 22413481Sgiacomo.travaglini@arm.com Target is phony. First two sources are the ref & new stats.txt file 22513481Sgiacomo.travaglini@arm.com files, respectively. We actually copy everything in the 22613481Sgiacomo.travaglini@arm.com respective directories except the status & diff output files. 22713481Sgiacomo.travaglini@arm.com 22813481Sgiacomo.travaglini@arm.com """ 22913481Sgiacomo.travaglini@arm.com dest_dir = str(source[0].get_dir()) 23013481Sgiacomo.travaglini@arm.com src_dir = str(source[1].get_dir()) 23113481Sgiacomo.travaglini@arm.com dest_files = set(os.listdir(dest_dir)) 23213481Sgiacomo.travaglini@arm.com src_files = set(os.listdir(src_dir)) 23313481Sgiacomo.travaglini@arm.com # Copy all of the required files plus any existing dest files. 23413481Sgiacomo.travaglini@arm.com wanted_files = needed_files | dest_files 23513481Sgiacomo.travaglini@arm.com missing_files = wanted_files - src_files 23613481Sgiacomo.travaglini@arm.com if len(missing_files) > 0: 23713481Sgiacomo.travaglini@arm.com print " WARNING: the following file(s) are missing " \ 23813481Sgiacomo.travaglini@arm.com "and will not be updated:" 23913481Sgiacomo.travaglini@arm.com print " ", " ,".join(missing_files) 24013481Sgiacomo.travaglini@arm.com copy_files = wanted_files - missing_files 24113481Sgiacomo.travaglini@arm.com warn_ignored_files = (src_files - copy_files) - known_ignores 24213481Sgiacomo.travaglini@arm.com if len(warn_ignored_files) > 0: 24313481Sgiacomo.travaglini@arm.com print ignore_msg, 24413481Sgiacomo.travaglini@arm.com print " ", ", ".join(warn_ignored_files) 24513481Sgiacomo.travaglini@arm.com for f in copy_files: 24613481Sgiacomo.travaglini@arm.com if f in dest_files: 247 print " Replacing file", f 248 dest_files.remove(f) 249 else: 250 print " Creating new file", f 251 copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f)) 252 copyAction.strfunction = None 253 env.Execute(copyAction) 254 return 0 255 256def update_test_string(target, source, env): 257 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}", 258 target=target, source=source) 259 260updateAction = env.Action(update_test, update_test_string) 261 262def test_builder(env, ref_dir): 263 """Define a test.""" 264 265 (category, mode, name, _ref, isa, opsys, config) = ref_dir.split('/') 266 assert(_ref == 'ref') 267 268 # target path (where test output goes) is the same except without 269 # the 'ref' component 270 tgt_dir = os.path.join(category, mode, name, isa, opsys, config) 271 272 # prepend file name with tgt_dir 273 def tgt(f): 274 return os.path.join(tgt_dir, f) 275 276 ref_stats = os.path.join(ref_dir, 'stats.txt') 277 new_stats = tgt('stats.txt') 278 status_file = tgt('status') 279 280 env.Command([status_file], 281 [env.M5Binary, 'run.py', ref_stats], 282 testAction) 283 284 # phony target to echo status 285 if GetOption('update_ref'): 286 p = env.Command(tgt('_update'), 287 [ref_stats, new_stats, status_file], 288 updateAction) 289 else: 290 p = env.Command(tgt('_print'), [status_file], printAction) 291 292 env.AlwaysBuild(p) 293 294 295# Figure out applicable configs based on build type 296configs = [] 297if env['TARGET_ISA'] == 'alpha': 298 configs += ['tsunami-simple-atomic', 299 'tsunami-simple-timing', 300 'tsunami-simple-atomic-dual', 301 'tsunami-simple-timing-dual', 302 'twosys-tsunami-simple-atomic', 303 'tsunami-o3', 'tsunami-o3-dual', 304 'tsunami-inorder'] 305if env['TARGET_ISA'] == 'sparc': 306 configs += ['t1000-simple-atomic', 307 't1000-simple-timing'] 308if env['TARGET_ISA'] == 'arm': 309 configs += ['simple-atomic-dummychecker', 310 'o3-timing-checker', 311 'realview-simple-atomic', 312 'realview-simple-atomic-dual', 313 'realview-simple-timing', 314 'realview-simple-timing-dual', 315 'realview-o3', 316 'realview-o3-checker', 317 'realview-o3-dual'] 318if env['TARGET_ISA'] == 'x86': 319 configs += ['pc-simple-atomic', 320 'pc-simple-timing', 321 'pc-o3-timing'] 322 323configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest', 324 'simple-atomic-mp', 'simple-timing-mp', 'o3-timing-mp', 325 'inorder-timing', 'rubytest', 'tgen-simple-mem', 326 'tgen-simple-dram'] 327 328if env['PROTOCOL'] != 'None': 329 if env['PROTOCOL'] == 'MI_example': 330 configs += [c + "-ruby" for c in configs] 331 else: 332 configs = [c + "-ruby-" + env['PROTOCOL'] for c in configs] 333 334cwd = os.getcwd() 335os.chdir(str(Dir('.').srcdir)) 336for config in configs: 337 dirs = glob.glob('*/*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config)) 338 for d in dirs: 339 if not os.path.exists(os.path.join(d, 'skip')): 340 test_builder(env, d) 341os.chdir(cwd) 342