SConscript revision 2953
16157Snate@binkert.org# -*- mode:python -*-
26157Snate@binkert.org
36157Snate@binkert.org# Copyright (c) 2004-2006 The Regents of The University of Michigan
46157Snate@binkert.org# All rights reserved.
56157Snate@binkert.org#
66157Snate@binkert.org# Redistribution and use in source and binary forms, with or without
76157Snate@binkert.org# modification, are permitted provided that the following conditions are
86157Snate@binkert.org# met: redistributions of source code must retain the above copyright
96157Snate@binkert.org# notice, this list of conditions and the following disclaimer;
106157Snate@binkert.org# redistributions in binary form must reproduce the above copyright
116157Snate@binkert.org# notice, this list of conditions and the following disclaimer in the
126157Snate@binkert.org# documentation and/or other materials provided with the distribution;
136157Snate@binkert.org# neither the name of the copyright holders nor the names of its
146157Snate@binkert.org# contributors may be used to endorse or promote products derived from
156157Snate@binkert.org# this software without specific prior written permission.
166157Snate@binkert.org#
176157Snate@binkert.org# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
186157Snate@binkert.org# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
196157Snate@binkert.org# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
206157Snate@binkert.org# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
216157Snate@binkert.org# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
226157Snate@binkert.org# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
236157Snate@binkert.org# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
246157Snate@binkert.org# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
256157Snate@binkert.org# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
266157Snate@binkert.org# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
276157Snate@binkert.org# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
286157Snate@binkert.org#
296157Snate@binkert.org# Authors: Steve Reinhardt
306157Snate@binkert.org#          Kevin Lim
316157Snate@binkert.org
326157Snate@binkert.orgimport os
336157Snate@binkert.orgimport sys
346657Snate@binkert.orgimport glob
356157Snate@binkert.orgfrom SCons.Script.SConscript import SConsEnvironment
366157Snate@binkert.org
376157Snate@binkert.orgImport('env')
386168Snate@binkert.org
396168Snate@binkert.orgenv['DIFFOUT'] = File('diff-out')
406168Snate@binkert.org
416157Snate@binkert.org# Dict that accumulates lists of tests by category (quick, medium, long)
426157Snate@binkert.orgenv.Tests = {}
436657Snate@binkert.org
446657Snate@binkert.orgdef contents(node):
456657Snate@binkert.org    return file(str(node)).read()
466657Snate@binkert.org
476657Snate@binkert.orgdef check_test(target, source, env):
486657Snate@binkert.org    """Check output from running test.
496657Snate@binkert.org
506657Snate@binkert.org    Targets are as follows:
516657Snate@binkert.org    target[0] : outdiff
526657Snate@binkert.org    target[1] : statsdiff
536157Snate@binkert.org    target[2] : status
546157Snate@binkert.org
556157Snate@binkert.org    """
566157Snate@binkert.org    # make sure target files are all gone
576657Snate@binkert.org    for t in target:
586657Snate@binkert.org        if os.path.exists(t.abspath):
596657Snate@binkert.org            Execute(Delete(t.abspath))
606878Ssteve.reinhardt@amd.com    # Run diff on output & ref directories to find differences.
616657Snate@binkert.org    # Exclude m5stats.txt since we will use diff-out on that.
626657Snate@binkert.org    Execute(env.subst('diff -ubr ${SOURCES[0].dir} ${SOURCES[1].dir} ' +
636657Snate@binkert.org                      '-I "^command line:" ' +		# for stdout file
646657Snate@binkert.org                      '-I "^M5 compiled on" ' +		# for stderr file
656657Snate@binkert.org                      '-I "^M5 simulation started" ' +	# for stderr file
666657Snate@binkert.org                      '-I "^Simulation complete at" ' +	# for stderr file
676657Snate@binkert.org                      '-I "^Listening for" ' +		# for stderr file
686657Snate@binkert.org                      '--exclude=m5stats.txt --exclude=SCCS ' +
696657Snate@binkert.org                      '--exclude=${TARGETS[0].file} ' +
706657Snate@binkert.org                      '> ${TARGETS[0]}', target=target, source=source), None)
716657Snate@binkert.org    print "===== Output differences ====="
726714Ssteve.reinhardt@amd.com    print contents(target[0])
736877Ssteve.reinhardt@amd.com    # Run diff-out on m5stats.txt file
746877Ssteve.reinhardt@amd.com    status = Execute(env.subst('$DIFFOUT $SOURCES > ${TARGETS[1]}',
756877Ssteve.reinhardt@amd.com                               target=target, source=source),
766877Ssteve.reinhardt@amd.com                     strfunction=None)
776877Ssteve.reinhardt@amd.com    print "===== Statistics differences ====="
786877Ssteve.reinhardt@amd.com    print contents(target[1])
796877Ssteve.reinhardt@amd.com    # Generate status file contents based on exit status of diff-out
806877Ssteve.reinhardt@amd.com    if status == 0:
816877Ssteve.reinhardt@amd.com        status_str = "passed."
826877Ssteve.reinhardt@amd.com    else:
836877Ssteve.reinhardt@amd.com        status_str = "FAILED!"
846877Ssteve.reinhardt@amd.com    f = file(str(target[2]), 'w')
856877Ssteve.reinhardt@amd.com    print >>f, env.subst('${TARGETS[2].dir}', target=target, source=source), \
866877Ssteve.reinhardt@amd.com          status_str
876877Ssteve.reinhardt@amd.com    f.close()
886877Ssteve.reinhardt@amd.com    # done
896877Ssteve.reinhardt@amd.com    return 0
906925SBrad.Beckmann@amd.com
916925SBrad.Beckmann@amd.comdef check_test_string(target, source, env):
926925SBrad.Beckmann@amd.com    return env.subst("Comparing outputs in ${TARGETS[0].dir}.",
936925SBrad.Beckmann@amd.com                     target=target, source=source)
946925SBrad.Beckmann@amd.com
956657Snate@binkert.orgtestAction = env.Action(check_test, check_test_string)
966657Snate@binkert.org
976657Snate@binkert.orgdef print_test(target, source, env):
986657Snate@binkert.org    print '***** ' + contents(source[0])
996157Snate@binkert.org    return 0
1006157Snate@binkert.org
1016157Snate@binkert.orgprintAction = env.Action(print_test, strfunction = None)
1026157Snate@binkert.org
1036157Snate@binkert.orgdef update_test(target, source, env):
1046157Snate@binkert.org    """Update reference test outputs.
1056157Snate@binkert.org
1066157Snate@binkert.org    Target is phony.  First two sources are the ref & new m5stats.txt
1076657Snate@binkert.org    files, respectively.  We actually copy everything in the
1086657Snate@binkert.org    respective directories except the status & diff output files.
1096657Snate@binkert.org
1106286Snate@binkert.org    """
1116657Snate@binkert.org    dest_dir = str(source[0].get_dir())
1126657Snate@binkert.org    src_dir = str(source[1].get_dir())
1136657Snate@binkert.org    dest_files = os.listdir(dest_dir)
1146657Snate@binkert.org    src_files = os.listdir(src_dir)
1156657Snate@binkert.org    # Exclude status & diff outputs
1166657Snate@binkert.org    for f in ('outdiff', 'statsdiff', 'status'):
1176657Snate@binkert.org        if f in src_files:
1186657Snate@binkert.org            src_files.remove(f)
1196657Snate@binkert.org    for f in src_files:
1206925SBrad.Beckmann@amd.com        if f in dest_files:
1216925SBrad.Beckmann@amd.com            print "  Replacing file", f
1226925SBrad.Beckmann@amd.com            dest_files.remove(f)
1236925SBrad.Beckmann@amd.com        else:
1246925SBrad.Beckmann@amd.com            print "  Creating new file", f
1256657Snate@binkert.org        copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
1266657Snate@binkert.org        copyAction.strfunction = None
1276157Snate@binkert.org        Execute(copyAction)
1286157Snate@binkert.org    # warn about any files in dest not overwritten (other than SCCS dir)
1296157Snate@binkert.org    if 'SCCS' in dest_files:
1306157Snate@binkert.org        dest_files.remove('SCCS')
1316157Snate@binkert.org    if dest_files:
1326657Snate@binkert.org        print "Warning: file(s) in", dest_dir, "not updated:",
1336657Snate@binkert.org        print ', '.join(dest_files)
1346657Snate@binkert.org    return 0
1356157Snate@binkert.org
1366877Ssteve.reinhardt@amd.comdef update_test_string(target, source, env):
1376877Ssteve.reinhardt@amd.com    return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
1386877Ssteve.reinhardt@amd.com                     target=target, source=source)
1396877Ssteve.reinhardt@amd.com
1406877Ssteve.reinhardt@amd.comupdateAction = env.Action(update_test, update_test_string)
1416877Ssteve.reinhardt@amd.com
1426877Ssteve.reinhardt@amd.comdef test_builder(env, category, cpu_list=[], os_list=[], refdir='ref',
143                 timeout=15):
144    """Define a test.
145
146    Args:
147    category -- string describing test category (e.g., 'quick')
148    cpu_list -- list of CPUs to runs this test on (blank means all compiled CPUs)
149    os_list -- list of OSs to run this test on
150    refdir -- subdirectory containing reference output (default 'ref')
151    timeout -- test timeout in minutes (only enforced on pool)
152
153    """
154
155    default_refdir = False
156    if refdir == 'ref':
157        default_refdir = True
158    valid_cpu_list = []
159    if len(cpu_list) == 0:
160        valid_cpu_list = env['CPU_MODELS']
161    else:
162        for i in cpu_list:
163            if i in env['CPU_MODELS']:
164                valid_cpu_list.append(i)
165    cpu_list = valid_cpu_list
166    if env['TEST_CPU_MODELS']:
167        valid_cpu_list = []
168        for i in env['TEST_CPU_MODELS']:
169            if i in cpu_list:
170                valid_cpu_list.append(i)
171        cpu_list = valid_cpu_list
172# Code commented out that shows the general structure if we want to test
173# different OS's as well.
174#    if len(os_list) == 0:
175#        for test_cpu in cpu_list:
176#            build_cpu_test(env, category, '', test_cpu, refdir, timeout)
177#    else:
178#        for test_os in os_list:
179#            for test_cpu in cpu_list:
180#                build_cpu_test(env, category, test_os, test_cpu, refdir,
181#                               timeout)
182    # Loop through CPU models and generate proper options, ref directories
183    for cpu in cpu_list:
184        test_os = ''
185        if cpu == "AtomicSimpleCPU":
186            cpu_option = ('','atomic/')
187        elif cpu == "TimingSimpleCPU":
188            cpu_option = ('--timing','timing/')
189        elif cpu == "O3CPU":
190            cpu_option = ('--detailed','detailed/')
191        else:
192            raise TypeError, "Unknown CPU model specified"
193
194        if default_refdir:
195            # Reference stats located in ref/arch/os/cpu or ref/arch/cpu
196            # if no OS specified
197            test_refdir = os.path.join(refdir, env['TARGET_ISA'])
198            if test_os != '':
199                test_refdir = os.path.join(test_refdir, test_os)
200            cpu_refdir = os.path.join(test_refdir, cpu_option[1])
201
202        ref_stats = os.path.join(cpu_refdir, 'm5stats.txt')
203
204        # base command for running test
205        base_cmd = '${SOURCES[0]} -d $TARGET.dir ${SOURCES[1]}'
206        base_cmd = base_cmd + ' ' + cpu_option[0]
207        # stdout and stderr files
208        cmd_stdout = '${TARGETS[0]}'
209        cmd_stderr = '${TARGETS[1]}'
210
211        stdout_string = cpu_option[1] + 'stdout'
212        stderr_string = cpu_option[1] + 'stderr'
213        m5stats_string = cpu_option[1] + 'm5stats.txt'
214        outdiff_string =  cpu_option[1] + 'outdiff'
215        statsdiff_string = cpu_option[1] + 'statsdiff'
216        status_string = cpu_option[1] + 'status'
217
218        # Prefix test run with batch job submission command if appropriate.
219        # Output redirection is also different for batch runs.
220        # Batch command also supports timeout arg (in seconds, not minutes).
221        if env['BATCH']:
222            cmd = [env['BATCH_CMD'], '-t', str(timeout * 60),
223                   '-o', cmd_stdout, '-e', cmd_stderr, base_cmd]
224        else:
225            cmd = [base_cmd, '>', cmd_stdout, '2>', cmd_stderr]
226            
227        env.Command([stdout_string, stderr_string, m5stats_string],
228                    [env.M5Binary, 'run.py'], ' '.join(cmd))
229
230        # order of targets is important... see check_test
231        env.Command([outdiff_string, statsdiff_string, status_string],
232                    [ref_stats, m5stats_string],
233                    testAction)
234
235        # phony target to echo status
236        if env['update_ref']:
237            p = env.Command(cpu_option[1] + '_update',
238                            [ref_stats, m5stats_string, status_string],
239                            updateAction)
240        else:
241            p = env.Command(cpu_option[1] + '_print', [status_string],
242                            printAction)
243        env.AlwaysBuild(p)
244
245        env.Tests.setdefault(category, [])
246        env.Tests[category] += p
247
248# Make test_builder a "wrapper" function.  See SCons wiki page at
249# http://www.scons.org/cgi-bin/wiki/WrapperFunctions.
250SConsEnvironment.Test = test_builder
251
252cwd = os.getcwd()
253os.chdir(str(Dir('.').srcdir))
254scripts = glob.glob('*/SConscript')
255os.chdir(cwd)
256
257for s in scripts:
258    SConscript(s, exports = 'env', duplicate = False)
259
260# Set up phony commands for various test categories
261allTests = []
262for (key, val) in env.Tests.iteritems():
263    env.Command(key, val, env.NoAction)
264    allTests += val
265
266# The 'all' target is redundant since just specifying the test
267# directory name (e.g., ALPHA_SE/test/opt) has the same effect.
268env.Command('all', allTests, env.NoAction)
269