SConscript revision 5525
111106Spower.jg@gmail.com# -*- mode:python -*- 211106Spower.jg@gmail.com 311390Ssteve.reinhardt@amd.com# Copyright (c) 2004-2006 The Regents of The University of Michigan 411390Ssteve.reinhardt@amd.com# All rights reserved. 511390Ssteve.reinhardt@amd.com# 611106Spower.jg@gmail.com# Redistribution and use in source and binary forms, with or without 711456Sandreas.hansson@arm.com# modification, are permitted provided that the following conditions are 811456Sandreas.hansson@arm.com# met: redistributions of source code must retain the above copyright 911456Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer; 1011456Sandreas.hansson@arm.com# redistributions in binary form must reproduce the above copyright 1111456Sandreas.hansson@arm.com# notice, this list of conditions and the following disclaimer in the 1211390Ssteve.reinhardt@amd.com# documentation and/or other materials provided with the distribution; 1311390Ssteve.reinhardt@amd.com# neither the name of the copyright holders nor the names of its 1411106Spower.jg@gmail.com# contributors may be used to endorse or promote products derived from 1511106Spower.jg@gmail.com# this software without specific prior written permission. 1611106Spower.jg@gmail.com# 1711106Spower.jg@gmail.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1811106Spower.jg@gmail.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1911106Spower.jg@gmail.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2011106Spower.jg@gmail.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2111106Spower.jg@gmail.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2211106Spower.jg@gmail.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2311106Spower.jg@gmail.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2411390Ssteve.reinhardt@amd.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2511390Ssteve.reinhardt@amd.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2611390Ssteve.reinhardt@amd.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2711390Ssteve.reinhardt@amd.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2811390Ssteve.reinhardt@amd.com# 2911390Ssteve.reinhardt@amd.com# Authors: Steve Reinhardt 3011390Ssteve.reinhardt@amd.com# Kevin Lim 3111390Ssteve.reinhardt@amd.com 3211106Spower.jg@gmail.comimport os 3311106Spower.jg@gmail.comimport sys 3411106Spower.jg@gmail.comimport glob 3511106Spower.jg@gmail.comfrom SCons.Script.SConscript import SConsEnvironment 3611106Spower.jg@gmail.com 3711106Spower.jg@gmail.comImport('env') 3811106Spower.jg@gmail.com 3911106Spower.jg@gmail.comenv['DIFFOUT'] = File('diff-out') 4011106Spower.jg@gmail.com 4111106Spower.jg@gmail.com# Dict that accumulates lists of tests by category (quick, medium, long) 4211106Spower.jg@gmail.comenv.Tests = {} 4311106Spower.jg@gmail.com 4411106Spower.jg@gmail.comdef contents(node): 4511106Spower.jg@gmail.com return file(str(node)).read() 4611106Spower.jg@gmail.com 4711106Spower.jg@gmail.comdef check_test(target, source, env): 4811106Spower.jg@gmail.com """Check output from running test. 4911106Spower.jg@gmail.com 5011106Spower.jg@gmail.com Targets are as follows: 5111106Spower.jg@gmail.com target[0] : outdiff 5211106Spower.jg@gmail.com target[1] : statsdiff 5311106Spower.jg@gmail.com target[2] : status 5411106Spower.jg@gmail.com 5511106Spower.jg@gmail.com """ 5611106Spower.jg@gmail.com # make sure target files are all gone 5711106Spower.jg@gmail.com for t in target: 5811106Spower.jg@gmail.com if os.path.exists(t.abspath): 5911106Spower.jg@gmail.com Execute(Delete(t.abspath)) 6011106Spower.jg@gmail.com # Run diff on output & ref directories to find differences. 6111106Spower.jg@gmail.com # Exclude m5stats.txt since we will use diff-out on that. 6211106Spower.jg@gmail.com Execute(env.subst('diff -ubr ${SOURCES[0].dir} ${SOURCES[1].dir} ' + 6311106Spower.jg@gmail.com '-I "^command line:" ' + # for stdout file 6411106Spower.jg@gmail.com '-I "^M5 compiled " ' + # for stderr file 6511106Spower.jg@gmail.com '-I "^M5 started " ' + # for stderr file 6611106Spower.jg@gmail.com '-I "^M5 executing on " ' + # for stderr file 6711106Spower.jg@gmail.com '-I "^Simulation complete at" ' + # for stderr file 6811106Spower.jg@gmail.com '-I "^Listening for" ' + # for stderr file 6911106Spower.jg@gmail.com '-I "listening for remote gdb" ' + # for stderr file 7011106Spower.jg@gmail.com '--exclude=m5stats.txt --exclude=SCCS ' + 7111106Spower.jg@gmail.com '--exclude=${TARGETS[0].file} ' + 7211106Spower.jg@gmail.com '> ${TARGETS[0]}', target=target, source=source), None) 7311106Spower.jg@gmail.com print "===== Output differences =====" 7411106Spower.jg@gmail.com print contents(target[0]) 7511106Spower.jg@gmail.com # Run diff-out on m5stats.txt file 7611106Spower.jg@gmail.com status = Execute(env.subst('$DIFFOUT $SOURCES > ${TARGETS[1]}', 7711106Spower.jg@gmail.com target=target, source=source), 7811390Ssteve.reinhardt@amd.com strfunction=None) 7911106Spower.jg@gmail.com print "===== Statistics differences =====" 8011106Spower.jg@gmail.com print contents(target[1]) 8111106Spower.jg@gmail.com # Generate status file contents based on exit status of diff-out 8211106Spower.jg@gmail.com if status == 0: 8311106Spower.jg@gmail.com status_str = "passed." 8411106Spower.jg@gmail.com else: 8511106Spower.jg@gmail.com status_str = "FAILED!" 8611106Spower.jg@gmail.com f = file(str(target[2]), 'w') 8711106Spower.jg@gmail.com print >>f, env.subst('${TARGETS[2].dir}', target=target, source=source), \ 8811106Spower.jg@gmail.com status_str 8911106Spower.jg@gmail.com f.close() 9011106Spower.jg@gmail.com # done 9111106Spower.jg@gmail.com return 0 9211106Spower.jg@gmail.com 9311106Spower.jg@gmail.comdef check_test_string(target, source, env): 9411106Spower.jg@gmail.com return env.subst("Comparing outputs in ${TARGETS[0].dir}.", 9511106Spower.jg@gmail.com target=target, source=source) 9611106Spower.jg@gmail.com 9711106Spower.jg@gmail.comtestAction = env.Action(check_test, check_test_string) 9811106Spower.jg@gmail.com 9911106Spower.jg@gmail.comdef print_test(target, source, env): 10011106Spower.jg@gmail.com print '***** ' + contents(source[0]) 10111106Spower.jg@gmail.com return 0 10211106Spower.jg@gmail.com 10311106Spower.jg@gmail.comprintAction = env.Action(print_test, strfunction = None) 10411106Spower.jg@gmail.com 10511106Spower.jg@gmail.com# Static vars for update_test: 10611106Spower.jg@gmail.com# - long-winded message about ignored sources 10711106Spower.jg@gmail.comignore_msg = ''' 10811106Spower.jg@gmail.comNote: The following file(s) will not be copied. New non-standard 10911106Spower.jg@gmail.com output files must be copied manually once before update_ref will 11011106Spower.jg@gmail.com recognize them as outputs. Otherwise they are assumed to be 11111106Spower.jg@gmail.com inputs and are ignored. 11211106Spower.jg@gmail.com''' 11311106Spower.jg@gmail.com# - reference files always needed 11411106Spower.jg@gmail.comneeded_files = set(['stdout', 'stderr', 'm5stats.txt', 'config.ini']) 11511106Spower.jg@gmail.com# - source files we always want to ignore 11611106Spower.jg@gmail.comknown_ignores = set(['status', 'outdiff', 'statsdiff']) 11711106Spower.jg@gmail.com 11811106Spower.jg@gmail.comdef update_test(target, source, env): 11911106Spower.jg@gmail.com """Update reference test outputs. 12011106Spower.jg@gmail.com 12111106Spower.jg@gmail.com Target is phony. First two sources are the ref & new m5stats.txt 12211106Spower.jg@gmail.com files, respectively. We actually copy everything in the 12311106Spower.jg@gmail.com respective directories except the status & diff output files. 12411106Spower.jg@gmail.com 12511106Spower.jg@gmail.com """ 12611106Spower.jg@gmail.com dest_dir = str(source[0].get_dir()) 12711106Spower.jg@gmail.com src_dir = str(source[1].get_dir()) 12811106Spower.jg@gmail.com dest_files = set(os.listdir(dest_dir)) 12911106Spower.jg@gmail.com src_files = set(os.listdir(src_dir)) 13011106Spower.jg@gmail.com # Copy all of the required files plus any existing dest files. 13111106Spower.jg@gmail.com wanted_files = needed_files | dest_files 13211106Spower.jg@gmail.com missing_files = wanted_files - src_files 13311106Spower.jg@gmail.com if len(missing_files) > 0: 13411106Spower.jg@gmail.com print " WARNING: the following file(s) are missing " \ 13511106Spower.jg@gmail.com "and will not be updated:" 13611106Spower.jg@gmail.com print " ", " ,".join(missing_files) 13711106Spower.jg@gmail.com copy_files = wanted_files - missing_files 13811106Spower.jg@gmail.com warn_ignored_files = (src_files - copy_files) - known_ignores 13911106Spower.jg@gmail.com if len(warn_ignored_files) > 0: 14011106Spower.jg@gmail.com print ignore_msg, 14111106Spower.jg@gmail.com print " ", ", ".join(warn_ignored_files) 14211106Spower.jg@gmail.com for f in copy_files: 14311106Spower.jg@gmail.com if f in dest_files: 14411106Spower.jg@gmail.com print " Replacing file", f 14511106Spower.jg@gmail.com dest_files.remove(f) 14611106Spower.jg@gmail.com else: 14711106Spower.jg@gmail.com print " Creating new file", f 14811106Spower.jg@gmail.com copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f)) 14911106Spower.jg@gmail.com copyAction.strfunction = None 15011106Spower.jg@gmail.com Execute(copyAction) 15111106Spower.jg@gmail.com return 0 15211106Spower.jg@gmail.com 15311106Spower.jg@gmail.comdef update_test_string(target, source, env): 15411106Spower.jg@gmail.com return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}", 15511106Spower.jg@gmail.com target=target, source=source) 15611106Spower.jg@gmail.com 15711106Spower.jg@gmail.comupdateAction = env.Action(update_test, update_test_string) 15811106Spower.jg@gmail.com 15911106Spower.jg@gmail.comdef test_builder(env, ref_dir): 16011106Spower.jg@gmail.com """Define a test.""" 16111106Spower.jg@gmail.com 16211106Spower.jg@gmail.com (category, name, _ref, isa, opsys, config) = ref_dir.split('/') 16311106Spower.jg@gmail.com assert(_ref == 'ref') 16411106Spower.jg@gmail.com 16511106Spower.jg@gmail.com # target path (where test output goes) is the same except without 16611106Spower.jg@gmail.com # the 'ref' component 16711106Spower.jg@gmail.com tgt_dir = os.path.join(category, name, isa, opsys, config) 16811106Spower.jg@gmail.com 16911106Spower.jg@gmail.com # prepend file name with tgt_dir 17011106Spower.jg@gmail.com def tgt(f): 17111106Spower.jg@gmail.com return os.path.join(tgt_dir, f) 17211106Spower.jg@gmail.com 17311106Spower.jg@gmail.com ref_stats = os.path.join(ref_dir, 'm5stats.txt') 17411106Spower.jg@gmail.com new_stats = tgt('m5stats.txt') 17511106Spower.jg@gmail.com status_file = tgt('status') 17611106Spower.jg@gmail.com 17711106Spower.jg@gmail.com # Base command for running test. We mess around with indirectly 17811106Spower.jg@gmail.com # referring to files via SOURCES and TARGETS so that scons can 17911106Spower.jg@gmail.com # mess with paths all it wants to and we still get the right 18011106Spower.jg@gmail.com # files. 18111106Spower.jg@gmail.com cmd = '${SOURCES[0]} -d $TARGET.dir' 18211106Spower.jg@gmail.com cmd += ' -re --stdout-file ${TARGETS[0]} --stderr-file ${TARGETS[1]}' 18311106Spower.jg@gmail.com cmd += ' ${SOURCES[1]} %s' % tgt_dir 18411106Spower.jg@gmail.com 18511106Spower.jg@gmail.com # Prefix test run with batch job submission command if appropriate. 18611106Spower.jg@gmail.com # Batch command also supports timeout arg (in seconds, not minutes). 18711106Spower.jg@gmail.com timeout = 15 * 60 # used to be a param, probably should be again 18811106Spower.jg@gmail.com if env['BATCH']: 18911106Spower.jg@gmail.com cmd = '%s -t %d %s' % (env['BATCH_CMD'], timeout, cmd) 19011390Ssteve.reinhardt@amd.com 19111390Ssteve.reinhardt@amd.com env.Command([tgt('stdout'), tgt('stderr'), new_stats], 19211390Ssteve.reinhardt@amd.com [env.M5Binary, 'run.py'], cmd) 19311390Ssteve.reinhardt@amd.com 19411390Ssteve.reinhardt@amd.com # order of targets is important... see check_test 19511390Ssteve.reinhardt@amd.com env.Command([tgt('outdiff'), tgt('statsdiff'), status_file], 19611390Ssteve.reinhardt@amd.com [ref_stats, new_stats], 19711390Ssteve.reinhardt@amd.com testAction) 19811106Spower.jg@gmail.com 19911106Spower.jg@gmail.com # phony target to echo status 20011106Spower.jg@gmail.com if env['update_ref']: 20111106Spower.jg@gmail.com p = env.Command(tgt('_update'), 20211390Ssteve.reinhardt@amd.com [ref_stats, new_stats, status_file], 20311390Ssteve.reinhardt@amd.com updateAction) 20411106Spower.jg@gmail.com else: 20511390Ssteve.reinhardt@amd.com p = env.Command(tgt('_print'), [status_file], printAction) 20611106Spower.jg@gmail.com 20711390Ssteve.reinhardt@amd.com env.AlwaysBuild(p) 20811390Ssteve.reinhardt@amd.com 20911106Spower.jg@gmail.com 21011390Ssteve.reinhardt@amd.com# Figure out applicable configs based on build type 21111106Spower.jg@gmail.comconfigs = [] 21211106Spower.jg@gmail.comif env['FULL_SYSTEM']: 21311390Ssteve.reinhardt@amd.com if env['TARGET_ISA'] == 'alpha': 21411390Ssteve.reinhardt@amd.com if not env['ALPHA_TLASER']: 21511106Spower.jg@gmail.com configs += ['tsunami-simple-atomic', 21611106Spower.jg@gmail.com 'tsunami-simple-timing', 21711106Spower.jg@gmail.com 'tsunami-simple-atomic-dual', 21811390Ssteve.reinhardt@amd.com 'tsunami-simple-timing-dual', 21911106Spower.jg@gmail.com 'twosys-tsunami-simple-atomic'] 22011390Ssteve.reinhardt@amd.com if env['TARGET_ISA'] == 'sparc': 22111106Spower.jg@gmail.com configs += ['t1000-simple-atomic', 22211390Ssteve.reinhardt@amd.com 't1000-simple-timing'] 22311390Ssteve.reinhardt@amd.com 22411390Ssteve.reinhardt@amd.comelse: 22511390Ssteve.reinhardt@amd.com configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest'] 22611390Ssteve.reinhardt@amd.com 22711106Spower.jg@gmail.comcwd = os.getcwd() 22811106Spower.jg@gmail.comos.chdir(str(Dir('.').srcdir)) 22911390Ssteve.reinhardt@amd.comfor config in configs: 23011390Ssteve.reinhardt@amd.com dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config)) 23111390Ssteve.reinhardt@amd.com for d in dirs: 23211390Ssteve.reinhardt@amd.com test_builder(env, d) 23311390Ssteve.reinhardt@amd.comos.chdir(cwd) 23411106Spower.jg@gmail.com