tests/SConscript

   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
  32 import os, signal
  33 import sys, time
  34 import glob
  35 from SCons.Script.SConscript import SConsEnvironment
  36
  37 Import('env')
  38
  39 env['DIFFOUT'] = File('diff-out')
  40
  41 # get the termcap from the environment
  42 termcap = env['TERMCAP']
  43
  44 # Dict that accumulates lists of tests by category (quick, medium, long)
  45 env.Tests = {}
  46
  47 def contents(node):
  48     return file(str(node)).read()
  49
  50 # functions to parse return value from scons Execute()... not the same
  51 # as wait() etc., so python built-in os funcs don't work.
  52 def signaled(status):
  53     return (status & 0x80) != 0;
  54
  55 def signum(status):
  56     return (status & 0x7f);
  57
  58 # List of signals that indicate that we should retry the test rather
  59 # than consider it failed.
  60 retry_signals = (signal.SIGTERM, signal.SIGKILL, signal.SIGINT,
  61                  signal.SIGQUIT, signal.SIGHUP)
  62
  63 # regular expressions of lines to ignore when diffing outputs
  64 output_ignore_regexes = (
  65     '^command line:',           # for stdout file
  66     '^gem5 compiled ',          # for stderr file
  67     '^gem5 started ',           # for stderr file
  68     '^gem5 executing on ',      # for stderr file
  69     '^Simulation complete at',  # for stderr file
  70     '^Listening for',           # for stderr file
  71     'listening for remote gdb', # for stderr file
  72     )
  73
  74 output_ignore_args = ' '.join(["-I '"+s+"'" for s in output_ignore_regexes])
  75
  76 output_ignore_args += ' --exclude=stats.txt --exclude=outdiff'
  77
  78 def run_test(target, source, env):
  79     """Check output from running test.
  80
  81     Targets are as follows:
  82     target[0] : status
  83
  84     Sources are:
  85     source[0] : M5 binary
  86     source[1] : tests/run.py script
  87     source[2] : reference stats file
  88
  89     """
  90     # make sure target files are all gone
  91     for t in target:
  92         if os.path.exists(t.abspath):
  93             env.Execute(Delete(t.abspath))
  94
  95     tgt_dir = os.path.dirname(str(target[0]))
  96
  97     # Base command for running test.  We mess around with indirectly
  98     # referring to files via SOURCES and TARGETS so that scons can mess
  99     # with paths all it wants to and we still get the right files.
 100     cmd = '${SOURCES[0]} -d %s -re ${SOURCES[1]} %s' % (tgt_dir, tgt_dir)
 101
 102     # Prefix test run with batch job submission command if appropriate.
 103     # Batch command also supports timeout arg (in seconds, not minutes).
 104     timeout = 15 * 60 # used to be a param, probably should be again
 105     if env['BATCH']:
 106         cmd = '%s -t %d %s' % (env['BATCH_CMD'], timeout, cmd)
 107
 108     pre_exec_time = time.time()
 109     status = env.Execute(env.subst(cmd, target=target, source=source))
 110     if status == 0:
 111         # M5 terminated normally.
 112         # Run diff on output & ref directories to find differences.
 113         # Exclude the stats file since we will use diff-out on that.
 114
 115         # NFS file systems can be annoying and not have updated yet
 116         # wait until we see the file modified
 117         statsdiff = os.path.join(tgt_dir, 'statsdiff')
 118         m_time = 0
 119         nap = 0
 120         while m_time < pre_exec_time and nap < 10:
 121             try:
 122                 m_time = os.stat(statsdiff).st_mtime
 123             except OSError:
 124                 pass
 125             time.sleep(1)
 126             nap += 1
 127
 128         outdiff = os.path.join(tgt_dir, 'outdiff')
 129         # tack 'true' on the end so scons doesn't report diff's
 130         # non-zero exit code as a build error
 131         diffcmd = 'diff -ubrs %s ${SOURCES[2].dir} %s > %s; true' \
 132                   % (output_ignore_args, tgt_dir, outdiff)
 133         env.Execute(env.subst(diffcmd, target=target, source=source))
 134         print "===== Output differences ====="
 135         print contents(outdiff)
 136         # Run diff-out on stats.txt file
 137         diffcmd = '$DIFFOUT ${SOURCES[2]} %s > %s' \
 138                   % (os.path.join(tgt_dir, 'stats.txt'), statsdiff)
 139         diffcmd = env.subst(diffcmd, target=target, source=source)
 140         status = env.Execute(diffcmd, strfunction=None)
 141         print "===== Statistics differences ====="
 142         print contents(statsdiff)
 143
 144     else: # m5 exit status != 0
 145         # M5 did not terminate properly, so no need to check the output
 146         if signaled(status):
 147             print 'M5 terminated with signal', signum(status)
 148             if signum(status) in retry_signals:
 149                 # Consider the test incomplete; don't create a 'status' output.
 150                 # Hand the return status to scons and let scons decide what
 151                 # to do about it (typically terminate unless run with -k).
 152                 return status
 153         elif status == 2:
 154             # The test was skipped
 155             pass
 156         else:
 157             print 'M5 exited with non-zero status', status
 158         # complete but failed execution (call to exit() with non-zero
 159         # status, SIGABORT due to assertion failure, etc.)... fall through
 160         # and generate FAILED status as if output comparison had failed
 161
 162     # Generate status file contents based on exit status of m5 or diff-out
 163     if status == 0:
 164         status_str = "passed."
 165     elif status == 2:
 166         status_str = "skipped."
 167     else:
 168         status_str = "FAILED!"
 169     f = file(str(target[0]), 'w')
 170     print >>f, tgt_dir, status_str
 171     f.close()
 172     # done
 173     return 0
 174
 175 def run_test_string(target, source, env):
 176     return env.subst("Running test in ${TARGETS[0].dir}.",
 177                      target=target, source=source)
 178
 179 testAction = env.Action(run_test, run_test_string)
 180
 181 def print_test(target, source, env):
 182     # print the status with colours to make it easier to see what
 183     # passed and what failed
 184     line = contents(source[0])
 185
 186     # split the line to words and get the last one
 187     words = line.split()
 188     status = words[-1]
 189
 190     # if the test failed make it red, if it passed make it green, and
 191     # skip the punctuation
 192     if status == "FAILED!":
 193         status = termcap.Red + status[:-1] + termcap.Normal + status[-1]
 194     elif status == "passed.":
 195         status = termcap.Green + status[:-1] + termcap.Normal + status[-1]
 196     elif status == "skipped.":
 197         status = termcap.Yellow + status[:-1] + termcap.Normal + status[-1]
 198
 199     # put it back in the list and join with space
 200     words[-1] = status
 201     line = " ".join(words)
 202
 203     print '***** ' + line
 204     return 0
 205
 206 printAction = env.Action(print_test, strfunction = None)
 207
 208 # Static vars for update_test:
 209 # - long-winded message about ignored sources
 210 ignore_msg = '''
 211 Note: The following file(s) will not be copied.  New non-standard
 212       output files must be copied manually once before --update-ref will
 213       recognize them as outputs.  Otherwise they are assumed to be
 214       inputs and are ignored.
 215 '''
 216 # - reference files always needed
 217 needed_files = set(['simout', 'simerr', 'stats.txt', 'config.ini'])
 218 # - source files we always want to ignore
 219 known_ignores = set(['status', 'outdiff', 'statsdiff'])
 220
 221 def update_test(target, source, env):
 222     """Update reference test outputs.
 223
 224     Target is phony.  First two sources are the ref & new stats.txt file
 225     files, respectively.  We actually copy everything in the
 226     respective directories except the status & diff output files.
 227
 228     """
 229     dest_dir = str(source[0].get_dir())
 230     src_dir = str(source[1].get_dir())
 231     dest_files = set(os.listdir(dest_dir))
 232     src_files = set(os.listdir(src_dir))
 233     # Copy all of the required files plus any existing dest files.
 234     wanted_files = needed_files | dest_files
 235     missing_files = wanted_files - src_files
 236     if len(missing_files) > 0:
 237         print "  WARNING: the following file(s) are missing " \
 238               "and will not be updated:"
 239         print "    ", " ,".join(missing_files)
 240     copy_files = wanted_files - missing_files
 241     warn_ignored_files = (src_files - copy_files) - known_ignores
 242     if len(warn_ignored_files) > 0:
 243         print ignore_msg,
 244         print "       ", ", ".join(warn_ignored_files)
 245     for f in copy_files:
 246         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
 256 def update_test_string(target, source, env):
 257     return env.subst("Updating ${SOURCES[0].dir} from ${SOURCES[1].dir}",
 258                      target=target, source=source)
 259
 260 updateAction = env.Action(update_test, update_test_string)
 261
 262 def 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
 296 configs = []
 297 if 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',
 305                 'tsunami-switcheroo-full']
 306 if env['TARGET_ISA'] == 'sparc':
 307     configs += ['t1000-simple-atomic',
 308                 't1000-simple-timing']
 309 if env['TARGET_ISA'] == 'arm':
 310     configs += ['simple-atomic-dummychecker',
 311                 'o3-timing-checker',
 312                 'realview-simple-atomic',
 313                 'realview-simple-atomic-dual',
 314                 'realview-simple-timing',
 315                 'realview-simple-timing-dual',
 316                 'realview-o3',
 317                 'realview-o3-checker',
 318                 'realview-o3-dual',
 319                 'realview-switcheroo-atomic',
 320                 'realview-switcheroo-timing',
 321                 'realview-switcheroo-o3',
 322                 'realview-switcheroo-full']
 323 if env['TARGET_ISA'] == 'x86':
 324     configs += ['pc-simple-atomic',
 325                 'pc-simple-timing',
 326                 'pc-o3-timing']
 327
 328 configs += ['simple-atomic', 'simple-timing', 'o3-timing', 'memtest',
 329             'simple-atomic-mp', 'simple-timing-mp', 'o3-timing-mp',
 330             'inorder-timing', 'rubytest', 'tgen-simple-mem',
 331             'tgen-simple-dram']
 332
 333 if env['PROTOCOL'] != 'None':
 334     if env['PROTOCOL'] == 'MI_example':
 335         configs += [c + "-ruby" for c in configs]
 336     else:
 337         configs = [c + "-ruby-" + env['PROTOCOL'] for c in configs]
 338
 339 cwd = os.getcwd()
 340 os.chdir(str(Dir('.').srcdir))
 341 for config in configs:
 342     dirs = glob.glob('*/*/*/ref/%s/*/%s' % (env['TARGET_ISA'], config))
 343     for d in dirs:
 344         if not os.path.exists(os.path.join(d, 'skip')):
 345             test_builder(env, d)
 346 os.chdir(cwd)