util: In build_cross_gcc, set LIMITS_H_TEST=true.
[gem5.git] / util / regress
index 067f9f0922fb4efb5e46f69abc6a7ebd6fbb298c..1f1404c94e64d106646d43c082c94a8af27e233c 100755 (executable)
@@ -1,5 +1,5 @@
-#! /usr/bin/env python
-# Copyright (c) 2005 The Regents of The University of Michigan
+#! /usr/bin/env python2.7
+# Copyright (c) 2005-2007 The Regents of The University of Michigan
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # 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
 
 import sys
 import os
 import optparse
 import datetime
-
-#
-# Regression invocation:
-#
-# regress \
-#      --workdir poolfs \
-#      --scons-opts 'BATCH=yes USE_MYSQL=no -j 30 -Q' \
-#      --recurse
+from subprocess import call
 
 progname = os.path.basename(sys.argv[0])
 
 optparser = optparse.OptionParser()
-optparser.add_option('-v', '--verbose', dest='verbose', action='store_true',
-                     default=False,
-                     help='echo commands before executing')
-optparser.add_option('--scratch', dest='scratch', action='store_true',
-                     default=False,
-                     help='rebuld from scratch')
-optparser.add_option('--builds', dest='builds',
-                     default='ALPHA_SE,ALPHA_FS,ALPHA_FS_TL',
-                     help='comma-separated list of builds to test')
-optparser.add_option('--variants', dest='variants',
-                     default='opt',
-                     help='comma-separated list of build variants to test')
-optparser.add_option('--workdir', dest='workdir',
-                     help='directory for checked-out source trees')
-optparser.add_option('--scons-opts', dest='scons_opts', default='',
-                     help='scons options')
-optparser.add_option('--no-pull', dest='pull', action='store_false',
-                     default=True,
-                     help="don't pull changes from repository")
-optparser.add_option('--recurse', dest='recurse', action='store_true',
-                     default=False,
-                     help='call recursively to get summary up front')
+add_option = optparser.add_option
+add_option('-v', '--verbose', action='store_true', default=False,
+           help='echo commands before executing')
+add_option('--builds',
+           default='ARM,' \
+           'MIPS,' \
+           'NULL,' \
+           'NULL_MOESI_hammer,' \
+           'NULL_MESI_Two_Level,'  \
+           'NULL_MOESI_CMP_directory,' \
+           'NULL_MOESI_CMP_token,' \
+           'POWER,' \
+           'SPARC,' \
+           'X86,X86_MESI_Two_Level,' \
+           'RISCV,' \
+           'HSAIL_X86',
+           help="comma-separated build targets to test (default: '%default')")
+add_option('--modes',
+           default='se,fs',
+           help="comma-separated modes to test (default: '%default')")
+add_option('--test-variants', default='opt',
+           help="comma-separated build variants to test (default: '%default')"\
+           ", set to '' for none")
+add_option('--compile-variants', default='debug,fast',
+           help="comma-separated build variants to compile only (not test) " \
+           "(default: '%default'), set to '' for none", metavar='VARIANTS')
+add_option('--scons-opts', default='', metavar='OPTS',
+           help='scons options')
+add_option('-j', '--jobs', type='int', default=1, metavar='N',
+           help='number of parallel jobs to use (0 to use all cores)')
+add_option('-k', '--keep-going', action='store_true',
+           help='keep going after errors')
+add_option('--update-ref', action='store_true',
+           help='update reference outputs')
+add_option('-D', '--build-dir', default='', metavar='DIR',
+           help='build directory location')
+add_option('-n', "--no-exec", default=False, action='store_true',
+           help="don't actually invoke scons, just echo SCons command line")
 
 (options, tests) = optparser.parse_args()
 
 
+# split a comma-separated list, but return an empty list if given the
+# empty string
+def split_if_nonempty(s):
+    if not s:
+        return []
+    return s.split(',')
+
 # split list options on ',' to get Python lists
-builds = options.builds.split(',')
-variants = options.variants.split(',')
+builds = split_if_nonempty(options.builds)
+modes = split_if_nonempty(options.modes)
+test_variants = split_if_nonempty(options.test_variants)
+compile_variants = split_if_nonempty(options.compile_variants)
 
-# Repositories to clone/update
-repos = ['m5', 'm5-test', 'ext']
+options.build_dir = os.path.join(options.build_dir, 'build')
 
 # Call os.system() and raise exception if return status is non-zero
 def system(cmd):
-    if options.verbose:
-        print cmd
-    status = os.system(cmd)
-    if status != 0:
-        upper = (status & 0xff00) >> 8
-        lower = (status & 0xff)
-        raise OSError, "shell command '%s' failed, status %d:%d" \
-              % (cmd, upper, lower)
-
-# Quote string s so it can be passed as a shell arg
-def shellquote(s):
-    if ' ' in s:
-        s = "'%s'" % s
-    return s
-
-# The '--recurse' option invokes scons once to perform any necessary
-# rebuilds/test runs with the (possibly verbose) output placed in a
-# log file, then (if the buld was successful) returns scons to print a
-# summary of the results.
-if options.recurse:
-    sys.argv.remove('--recurse')  # avoid infinite recursion...
-    timestr = datetime.datetime.now().isoformat('-')[:19]
-    logfile = '%s-%s' % (progname, timestr)
-    # quote args for shell
-    qargs = [shellquote(a) for a in sys.argv]
-    # always run the sub-job in verbose mode
-    qargs.append('-v')
-    cmd = '%s > %s 2>&1' % (' '.join(qargs), logfile)
     try:
-        system(cmd)
-    except OSError, exc:
-        print "Error: recursive invocation failed, aborting."
-        print exc
-        print "======================="
-        os.system('cat %s' % logfile)
+        retcode = call(cmd, shell=True)
+        if retcode < 0:
+            print >>sys.stderr, "Child was terminated by signal", -retcode
+            print >>sys.stderr, "When attemping to execute: %s" % cmd
+            sys.exit(1)
+        elif retcode > 0:
+            print >>sys.stderr, "Child returned", retcode
+            print >>sys.stderr, "When attemping to execute: %s" % cmd
+            sys.exit(1)
+    except OSError, e:
+        print >>sys.stderr, "Execution failed:", e
+        print >>sys.stderr, "When attemping to execute: %s" % cmd
         sys.exit(1)
-    # recursive call succeeded... re-run to generate summary
-    # don't *re*-build from scratch now
-    options.scratch = False
-    # no need to re-pull since the recursive call shoudl have done that
-    options.pull = False
-    print "Recursive invocation successful, see %s for output." % logfile
-
-try:
-    if options.workdir:
-        if options.verbose:
-            print 'cd', options.workdir
-        os.chdir(options.workdir)
-
-    if options.scratch:
-        for dir in repos:
-            system('rm -rf %s' % dir)
-            system('bk clone /bk/%s' % dir)
-    elif options.pull:
-        for dir in repos:
-            system('cd %s; bk pull' % dir)
-
-    if not tests:
-        print "No tests specified."
-        sys.exit(1)
-
-    if options.verbose:
-        print 'cd m5/build'
-    os.chdir('m5/build')
-
-    targets = ['%s/test/%s/%s' % (build, variant, test)
-               for build in builds for variant in variants for test in tests]
-
-    system('scons %s %s' % (options.scons_opts, ' '.join(targets)))
 
+targets = []
+
+# start with compile-only targets, if any
+if compile_variants:
+    targets += ['%s/%s/gem5.%s' % (options.build_dir, build, variant)
+                for variant in compile_variants
+                for build in builds]
+
+# By default run the 'quick' tests, all expands to quick and long
+if not tests:
+    tests = ['quick']
+elif 'all' in tests:
+    tests = ['quick', 'long']
+
+# set up test targets for scons, since we don't have any quick SPARC
+# full-system tests exclude it
+targets += ['%s/%s/tests/%s/%s/%s' % (options.build_dir, build, variant, test,
+                                      mode)
+            for build in builds
+            for variant in test_variants
+            for test in tests
+            for mode in modes
+            if not (build == 'SPARC' and test == 'quick' and mode == 'fs')]
+
+def cpu_count():
+    if 'bsd' in sys.platform or sys.platform == 'darwin':
+        try:
+            return int(os.popen('sysctl -n hw.ncpu').read())
+        except ValueError:
+            pass
+    else:
+        try:
+            return os.sysconf('SC_NPROCESSORS_ONLN')
+        except (ValueError, OSError, AttributeError):
+            pass
+
+    raise NotImplementedError('cannot determine number of cpus')
+
+scons_opts = options.scons_opts
+if options.jobs != 1:
+    if options.jobs == 0:
+        options.jobs = cpu_count()
+    scons_opts += ' -j %d' % options.jobs
+if options.keep_going:
+    scons_opts += ' -k'
+if options.update_ref:
+    scons_opts += ' --update-ref'
+
+# We generally compile gem5.fast only to make sure it compiles OK;
+# it's not very useful to run as a regression test since assertions
+# are disabled.  Thus there's not much point spending time on
+# link-time optimization.
+scons_opts += ' --no-lto'
+
+cmd = 'scons --ignore-style %s %s' % (scons_opts, ' '.join(targets))
+if options.no_exec:
+    print cmd
+else:
+    system(cmd)
     sys.exit(0)
-
-except OSError, exc:
-    print "%s: " % progname, exc
-    sys.exit(1)