tests/SConscript - public/gem5 - Git at Google

 # -*- mode:python -*-

 # Copyright (c) 2004-2006 The Regents of The University of Michigan
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met: redistributions of source code must retain the above copyright
 # notice, this list of conditions and the following disclaimer;
 # redistributions in binary form must reproduce the above copyright
 # notice, this list of conditions and the following disclaimer in the
 # documentation and/or other materials provided with the distribution;
 # neither the name of the copyright holders nor the names of its
 # contributors may be used to endorse or promote products derived from
 # this software without specific prior written permission.
 #
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 # Authors: Steve Reinhardt
 #          Kevin Lim

 import os
 import sys
 import glob
 from SCons.Script.SConscript import SConsEnvironment

 Import('env')

 env['DIFFOUT'] = File('diff-out')

 # Dict that accumulates lists of tests by category (quick, medium, long)
 env.Tests = {}

 def contents(node):
     return file(str(node)).read()

 def check_test(target, source, env):
     """Check output from running test.

     Targets are as follows:
     target[0] : outdiff
     target[1] : statsdiff
     target[2] : status

     """
     # make sure target files are all gone
     for t in target:
         if os.path.exists(t.abspath):
             Execute(Delete(t.abspath))
     # Run diff on output & ref directories to find differences.
     # Exclude m5stats.txt since we will use diff-out on that.
     Execute(env.subst('diff -ubr ${SOURCES[0].dir} ${SOURCES[1].dir} ' +
                       '-I "^command line:" ' +		# for stdout file
                       '-I "^M5 compiled " ' +		# for stderr file
                       '-I "^M5 started " ' +		# for stderr file
                       '-I "^M5 executing on " ' +	# for stderr file
                       '-I "^Simulation complete at" ' +	# for stderr file
                       '-I "^Listening for" ' +		# for stderr file
                       '-I "listening for remote gdb" ' + # for stderr file
                       '--exclude=m5stats.txt --exclude=SCCS ' +
                       '--exclude=${TARGETS[0].file} ' +
                       '> ${TARGETS[0]}', target=target, source=source), None)
     print "===== Output differences ====="
     print contents(target[0])
     # Run diff-out on m5stats.txt file
     status = Execute(env.subst('$DIFFOUT $SOURCES > ${TARGETS[1]}',
                                target=target, source=source),
                      strfunction=None)
     print "===== Statistics differences ====="
     print contents(target[1])
     # Generate status file contents based on exit status of diff-out
     if status == 0:
         status_str = "passed."
     else:
         status_str = "FAILED!"
     f = file(str(target[2]), 'w')
     print >>f, env.subst('${TARGETS[2].dir}', target=target, source=source), \
           status_str
     f.close()
     # done
     return 0

 def check_test_string(target, source, env):
     return env.subst("Comparing outputs in ${TARGETS[0].dir}.",
                      target=target, source=source)

 testAction = env.Action(check_test, check_test_string)

 def print_test(target, source, env):
     print '***** ' + contents(source[0])
     return 0

 printAction = env.Action(print_test, strfunction = None)

 # Static vars for update_test:
 # - long-winded message about ignored sources
 ignore_msg = '''
 Note: The following file(s) will not be copied.  New non-standard
       output files must be copied manually once before update_ref will
       recognize them as outputs.  Otherwise they are assumed to be
       inputs and are ignored.
 '''
 # - reference files always needed
 needed_files = set(['stdout', 'stderr', 'm5stats.txt', 'config.ini'])
 # - source files we always want to ignore
 known_ignores = set(['status', 'outdiff', 'statsdiff'])

 def update_test(target, source, env):
     """Update reference test outputs.

     Target is phony.  First two sources are the ref & new m5stats.txt
     files, respectively.  We actually copy everything in the
     respective directories except the status & diff output files.

     """
     dest_dir = str(source[0].get_dir())
     src_dir = str(source[1].get_dir())
     dest_files = set(os.listdir(dest_dir))
     src_files = set(os.listdir(src_dir))
     # Copy all of the required files plus any existing dest files.
     wanted_files = needed_files | dest_files
     missing_files = wanted_files - src_files
     if len(missing_files) > 0:
         print "  WARNING: the following file(s) are missing " \
               "and will not be updated:"
         print "    ", " ,".join(missing_files)
     copy_files = wanted_files - missing_files
     warn_ignored_files = (src_files - copy_files) - known_ignores
     if len(warn_ignored_files) > 0:
         print ignore_msg,
         print "       ", ", ".join(warn_ignored_files)
     for f in copy_files:
         if f in dest_files:
             print "  Replacing file", f
             dest_files.remove(f)
         else:
             print "  Creating new file", f
         copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
         copyAction.strfunction = None
         Execute(copyAction)
     return 0

 def update_test_string(target, source, env):
     return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
                      target=target, source=source)

 updateAction = env.Action(update_test, update_test_string)

 def test_builder(env, ref_dir):
     """Define a test."""

     (category, name, _ref, isa, opsys, config) = ref_dir.split('/')
     assert(_ref == 'ref')

     # target path (where test output goes) is the same except without
     # the 'ref' component
     tgt_dir = os.path.join(category, name, isa, opsys, config)

     # prepend file name with tgt_dir
     def tgt(f):
         return os.path.join(tgt_dir, f)

     ref_stats = os.path.join(ref_dir, 'm5stats.txt')
     new_stats = tgt('m5stats.txt')
     status_file = tgt('status')

     # Base command for running test.  We mess around with indirectly
     # referring to files via SOURCES and TARGETS so that scons can
     # mess with paths all it wants to and we still get the right
     # files.
     base_cmd = '${SOURCES[0]} -d $TARGET.dir ${SOURCES[1]} %s' % tgt_dir
     # stdout and stderr files
     cmd_stdout = '${TARGETS[0]}'
     cmd_stderr = '${TARGETS[1]}'

     # Prefix test run with batch job submission command if appropriate.
     # Output redirection is also different for batch runs.
     # Batch command also supports timeout arg (in seconds, not minutes).
     timeout = 15 # used to be a param, probably should be again
     if env['BATCH']:
         cmd = [env['BATCH_CMD'], '-t', str(timeout * 60),
                '-o', cmd_stdout, '-e', cmd_stderr, base_cmd]
     else:
         cmd = [base_cmd, '>', cmd_stdout, '2>', cmd_stderr]

     env.Command([tgt('stdout'), tgt('stderr'), new_stats],
                 [env.M5Binary, 'run.py'], ' '.join(cmd))

     # order of targets is important... see check_test
     env.Command([tgt('outdiff'), tgt('statsdiff'), status_file],
                 [ref_stats, new_stats],
                 testAction)

     # phony target to echo status
     if env['update_ref']:
         p = env.Command(tgt('_update'),
                         [ref_stats, new_stats, status_file],
                         updateAction)
     else:
         p = env.Command(tgt('_print'), [status_file], printAction)

     env.AlwaysBuild(p)


 # Figure out applicable configs based on build type
 configs = []
 if env['FULL_SYSTEM']:
     if env['TARGET_ISA'] == 'alpha':
         if not env['ALPHA_TLASER']:
             configs += ['tsunami-simple-atomic',
                         'tsunami-simple-timing',
                         'tsunami-simple-atomic-dual',
                         'tsunami-simple-timing-dual',
                         'twosys-tsunami-simple-atomic']
     if env['TARGET_ISA'] == 'sparc':
         configs += ['t1000-simple-atomic',
                     't1000-simple-timing']

 else:
     configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest']

 cwd = os.getcwd()
 os.chdir(str(Dir('.').srcdir))
 for config in configs:
     dirs = glob.glob('*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
     for d in dirs:
         test_builder(env, d)
 os.chdir(cwd)
	# -- mode:python --

	# Copyright (c) 2004-2006 The Regents of The University of Michigan
	# All rights reserved.
	#
	# Redistribution and use in source and binary forms, with or without
	# modification, are permitted provided that the following conditions are
	# met: redistributions of source code must retain the above copyright
	# notice, this list of conditions and the following disclaimer;
	# redistributions in binary form must reproduce the above copyright
	# notice, this list of conditions and the following disclaimer in the
	# documentation and/or other materials provided with the distribution;
	# neither the name of the copyright holders nor the names of its
	# contributors may be used to endorse or promote products derived from
	# this software without specific prior written permission.
	#
	# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	#
	# Authors: Steve Reinhardt
	# Kevin Lim

	import os
	import sys
	import glob
	from SCons.Script.SConscript import SConsEnvironment

	Import('env')

	env['DIFFOUT'] = File('diff-out')

	# Dict that accumulates lists of tests by category (quick, medium, long)
	env.Tests = {}

	def contents(node):
	return file(str(node)).read()

	def check_test(target, source, env):
	"""Check output from running test.

	Targets are as follows:
	target[0] : outdiff
	target[1] : statsdiff
	target[2] : status

	"""
	# make sure target files are all gone
	for t in target:
	if os.path.exists(t.abspath):
	Execute(Delete(t.abspath))
	# Run diff on output & ref directories to find differences.
	# Exclude m5stats.txt since we will use diff-out on that.
	Execute(env.subst('diff -ubr ${SOURCES[0].dir} ${SOURCES[1].dir} ' +
	'-I "^command line:" ' + # for stdout file
	'-I "^M5 compiled " ' + # for stderr file
	'-I "^M5 started " ' + # for stderr file
	'-I "^M5 executing on " ' + # for stderr file
	'-I "^Simulation complete at" ' + # for stderr file
	'-I "^Listening for" ' + # for stderr file
	'-I "listening for remote gdb" ' + # for stderr file
	'--exclude=m5stats.txt --exclude=SCCS ' +
	'--exclude=${TARGETS[0].file} ' +
	'> ${TARGETS[0]}', target=target, source=source), None)
	print "===== Output differences ====="
	print contents(target[0])
	# Run diff-out on m5stats.txt file
	status = Execute(env.subst('$DIFFOUT $SOURCES > ${TARGETS[1]}',
	target=target, source=source),
	strfunction=None)
	print "===== Statistics differences ====="
	print contents(target[1])
	# Generate status file contents based on exit status of diff-out
	if status == 0:
	status_str = "passed."
	else:
	status_str = "FAILED!"
	f = file(str(target[2]), 'w')
	print >>f, env.subst('${TARGETS[2].dir}', target=target, source=source), \
	status_str
	f.close()
	# done
	return 0

	def check_test_string(target, source, env):
	return env.subst("Comparing outputs in ${TARGETS[0].dir}.",
	target=target, source=source)

	testAction = env.Action(check_test, check_test_string)

	def print_test(target, source, env):
	print '***** ' + contents(source[0])
	return 0

	printAction = env.Action(print_test, strfunction = None)

	# Static vars for update_test:
	# - long-winded message about ignored sources
	ignore_msg = '''
	Note: The following file(s) will not be copied. New non-standard
	output files must be copied manually once before update_ref will
	recognize them as outputs. Otherwise they are assumed to be
	inputs and are ignored.
	'''
	# - reference files always needed
	needed_files = set(['stdout', 'stderr', 'm5stats.txt', 'config.ini'])
	# - source files we always want to ignore
	known_ignores = set(['status', 'outdiff', 'statsdiff'])

	def update_test(target, source, env):
	"""Update reference test outputs.

	Target is phony. First two sources are the ref & new m5stats.txt
	files, respectively. We actually copy everything in the
	respective directories except the status & diff output files.

	"""
	dest_dir = str(source[0].get_dir())
	src_dir = str(source[1].get_dir())
	dest_files = set(os.listdir(dest_dir))
	src_files = set(os.listdir(src_dir))
	# Copy all of the required files plus any existing dest files.
	wanted_files = needed_files \| dest_files
	missing_files = wanted_files - src_files
	if len(missing_files) > 0:
	print " WARNING: the following file(s) are missing " \
	"and will not be updated:"
	print " ", " ,".join(missing_files)
	copy_files = wanted_files - missing_files
	warn_ignored_files = (src_files - copy_files) - known_ignores
	if len(warn_ignored_files) > 0:
	print ignore_msg,
	print " ", ", ".join(warn_ignored_files)
	for f in copy_files:
	if f in dest_files:
	print " Replacing file", f
	dest_files.remove(f)
	else:
	print " Creating new file", f
	copyAction = Copy(os.path.join(dest_dir, f), os.path.join(src_dir, f))
	copyAction.strfunction = None
	Execute(copyAction)
	return 0

	def update_test_string(target, source, env):
	return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
	target=target, source=source)

	updateAction = env.Action(update_test, update_test_string)

	def test_builder(env, ref_dir):
	"""Define a test."""

	(category, name, _ref, isa, opsys, config) = ref_dir.split('/')
	assert(_ref == 'ref')

	# target path (where test output goes) is the same except without
	# the 'ref' component
	tgt_dir = os.path.join(category, name, isa, opsys, config)

	# prepend file name with tgt_dir
	def tgt(f):
	return os.path.join(tgt_dir, f)

	ref_stats = os.path.join(ref_dir, 'm5stats.txt')
	new_stats = tgt('m5stats.txt')
	status_file = tgt('status')

	# Base command for running test. We mess around with indirectly
	# referring to files via SOURCES and TARGETS so that scons can
	# mess with paths all it wants to and we still get the right
	# files.
	base_cmd = '${SOURCES[0]} -d $TARGET.dir ${SOURCES[1]} %s' % tgt_dir
	# stdout and stderr files
	cmd_stdout = '${TARGETS[0]}'
	cmd_stderr = '${TARGETS[1]}'

	# Prefix test run with batch job submission command if appropriate.
	# Output redirection is also different for batch runs.
	# Batch command also supports timeout arg (in seconds, not minutes).
	timeout = 15 # used to be a param, probably should be again
	if env['BATCH']:
	cmd = [env['BATCH_CMD'], '-t', str(timeout * 60),
	'-o', cmd_stdout, '-e', cmd_stderr, base_cmd]
	else:
	cmd = [base_cmd, '>', cmd_stdout, '2>', cmd_stderr]

	env.Command([tgt('stdout'), tgt('stderr'), new_stats],
	[env.M5Binary, 'run.py'], ' '.join(cmd))

	# order of targets is important... see check_test
	env.Command([tgt('outdiff'), tgt('statsdiff'), status_file],
	[ref_stats, new_stats],
	testAction)

	# phony target to echo status
	if env['update_ref']:
	p = env.Command(tgt('_update'),
	[ref_stats, new_stats, status_file],
	updateAction)
	else:
	p = env.Command(tgt('_print'), [status_file], printAction)

	env.AlwaysBuild(p)


	# Figure out applicable configs based on build type
	configs = []
	if env['FULL_SYSTEM']:
	if env['TARGET_ISA'] == 'alpha':
	if not env['ALPHA_TLASER']:
	configs += ['tsunami-simple-atomic',
	'tsunami-simple-timing',
	'tsunami-simple-atomic-dual',
	'tsunami-simple-timing-dual',
	'twosys-tsunami-simple-atomic']
	if env['TARGET_ISA'] == 'sparc':
	configs += ['t1000-simple-atomic',
	't1000-simple-timing']

	else:
	configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest']

	cwd = os.getcwd()
	os.chdir(str(Dir('.').srcdir))
	for config in configs:
	dirs = glob.glob('//ref/%s/*/%s' % (env['TARGET_ISA'], config))
	for d in dirs:
	test_builder(env, d)
	os.chdir(cwd)