SConscript revision 3021:3b67ff91f0d6
1# -*- mode:python -*- 2 3# Copyright (c) 2004-2006 The Regents of The University of Michigan 4# All rights reserved. 5# 6# Redistribution and use in source and binary forms, with or without 7# modification, are permitted provided that the following conditions are 8# met: redistributions of source code must retain the above copyright 9# notice, this list of conditions and the following disclaimer; 10# redistributions in binary form must reproduce the above copyright 11# notice, this list of conditions and the following disclaimer in the 12# documentation and/or other materials provided with the distribution; 13# neither the name of the copyright holders nor the names of its 14# contributors may be used to endorse or promote products derived from 15# this software without specific prior written permission. 16# 17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28# 29# Authors: Steve Reinhardt 30# Kevin Lim 31 32import os 33import sys 34import glob 35from SCons.Script.SConscript import SConsEnvironment 36 37Import('env') 38 39env['DIFFOUT'] = File('diff-out') 40 41# Dict that accumulates lists of tests by category (quick, medium, long) 42env.Tests = {} 43 44def contents(node): 45 return file(str(node)).read() 46 47def check_test(target, source, env): 48 """Check output from running test. 49 50 Targets are as follows: 51 target[0] : outdiff 52 target[1] : statsdiff 53 target[2] : status 54 55 """ 56 # make sure target files are all gone 57 for t in target: 58 if os.path.exists(t.abspath): 59 Execute(Delete(t.abspath)) 60 # Run diff on output & ref directories to find differences. 61 # Exclude m5stats.txt since we will use diff-out on that. 62 Execute(env.subst('diff -ubr ${SOURCES[0].dir} ${SOURCES[1].dir} ' + 63 '-I "^command line:" ' + # for stdout file 64 '-I "^M5 compiled " ' + # for stderr file 65 '-I "^M5 started " ' + # for stderr file 66 '-I "^M5 executing on " ' + # for stderr file 67 '-I "^Simulation complete at" ' + # for stderr file 68 '-I "^Listening for" ' + # for stderr file 69 '-I "listening for remote gdb" ' + # for stderr file 70 '--exclude=m5stats.txt --exclude=SCCS ' + 71 '--exclude=${TARGETS[0].file} ' + 72 '> ${TARGETS[0]}', target=target, source=source), None) 73 print "===== Output differences =====" 74 print contents(target[0]) 75 # Run diff-out on m5stats.txt file 76 status = Execute(env.subst('$DIFFOUT $SOURCES > ${TARGETS[1]}', 77 target=target, source=source), 78 strfunction=None) 79 print "===== Statistics differences =====" 80 print contents(target[1]) 81 # Generate status file contents based on exit status of diff-out 82 if status == 0: 83 status_str = "passed." 84 else: 85 status_str = "FAILED!" 86 f = file(str(target[2]), 'w') 87 print >>f, env.subst('${TARGETS[2].dir}', target=target, source=source), \ 88 status_str 89 f.close() 90 # done 91 return 0 92 93def check_test_string(target, source, env): 94 return env.subst("Comparing outputs in ${TARGETS[0].dir}.", 95 target=target, source=source) 96 97testAction = env.Action(check_test, check_test_string) 98 99def print_test(target, source, env): 100 print '***** ' + contents(source[0]) 101 return 0 102 103printAction = env.Action(print_test, strfunction = None) 104 105def update_test(target, source, env): 106 """Update reference test outputs. 107 108 Target is phony. First two sources are the ref & new m5stats.txt 109 files, respectively. We actually copy everything in the 110 respective directories except the status & diff output files. 111 112 """ 113 dest_dir = str(source[0].get_dir()) 114 src_dir = str(source[1].get_dir()) 115 dest_files = os.listdir(dest_dir) 116 src_files = os.listdir(src_dir) 117 # Exclude status & diff outputs 118 for f in ('outdiff', 'statsdiff', 'status'): 119 if f in src_files: 120 src_files.remove(f) 121 for f in src_files: 122 if f in dest_files: 123 print " Replacing file", f 124 dest_files.remove(f) 125 else: 126 print " Creating new file", f 127 copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f)) 128 copyAction.strfunction = None 129 Execute(copyAction) 130 # warn about any files in dest not overwritten (other than SCCS dir) 131 if 'SCCS' in dest_files: 132 dest_files.remove('SCCS') 133 if dest_files: 134 print "Warning: file(s) in", dest_dir, "not updated:", 135 print ', '.join(dest_files) 136 return 0 137 138def update_test_string(target, source, env): 139 return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}", 140 target=target, source=source) 141 142updateAction = env.Action(update_test, update_test_string) 143 144def test_builder(env, ref_dir): 145 """Define a test.""" 146 147 (category, name, _ref, isa, opsys, config) = ref_dir.split('/') 148 assert(_ref == 'ref') 149 150 # target path (where test output goes) is the same except without 151 # the 'ref' component 152 tgt_dir = os.path.join(category, name, isa, opsys, config) 153 154 # prepend file name with tgt_dir 155 def tgt(f): 156 return os.path.join(tgt_dir, f) 157 158 ref_stats = os.path.join(ref_dir, 'm5stats.txt') 159 new_stats = tgt('m5stats.txt') 160 status_file = tgt('status') 161 162 # Base command for running test. We mess around with indirectly 163 # referring to files via SOURCES and TARGETS so that scons can 164 # mess with paths all it wants to and we still get the right 165 # files. 166 base_cmd = '${SOURCES[0]} -d $TARGET.dir ${SOURCES[1]} %s' % tgt_dir 167 # stdout and stderr files 168 cmd_stdout = '${TARGETS[0]}' 169 cmd_stderr = '${TARGETS[1]}' 170 171 # Prefix test run with batch job submission command if appropriate. 172 # Output redirection is also different for batch runs. 173 # Batch command also supports timeout arg (in seconds, not minutes). 174 if env['BATCH']: 175 cmd = [env['BATCH_CMD'], '-t', str(timeout * 60), 176 '-o', cmd_stdout, '-e', cmd_stderr, base_cmd] 177 else: 178 cmd = [base_cmd, '>', cmd_stdout, '2>', cmd_stderr] 179 180 env.Command([tgt('stdout'), tgt('stderr'), new_stats], 181 [env.M5Binary, 'run.py'], ' '.join(cmd)) 182 183 # order of targets is important... see check_test 184 env.Command([tgt('outdiff'), tgt('statsdiff'), status_file], 185 [ref_stats, new_stats], 186 testAction) 187 188 # phony target to echo status 189 if env['update_ref']: 190 p = env.Command(tgt('_update'), 191 [ref_stats, new_stats, status_file], 192 updateAction) 193 else: 194 p = env.Command(tgt('_print'), [status_file], printAction) 195 196 env.AlwaysBuild(p) 197 198 199# Figure out applicable configs based on build type 200configs = [] 201if env['FULL_SYSTEM']: 202 if env['TARGET_ISA'] == 'alpha': 203 if not env['ALPHA_TLASER']: 204 configs += ['tsunami-simple-atomic', 205 'tsunami-simple-timing', 206 'tsunami-simple-atomic-dual', 207 'tsunami-simple-timing-dual'] 208else: 209 configs += ['simple-atomic', 'simple-timing'] 210 211cwd = os.getcwd() 212os.chdir(str(Dir('.').srcdir)) 213for config in configs: 214 dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config)) 215 for d in dirs: 216 test_builder(env, d) 217os.chdir(cwd) 218