X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=src%2Fsystemc%2Ftests%2Fverify.py;h=27273ea8f77b7baea4fd579d3b599256090f16c3;hb=2ede803d7c29065c1e42442b495f773c03c68270;hp=cface476189712198df1c59de7d140aee8d0b770;hpb=c1e24eda83ef1621842a24e810c8656dfe0fcbbc;p=gem5.git

diff --git a/src/systemc/tests/verify.py b/src/systemc/tests/verify.py
index cface4761..27273ea8f 100755
--- a/src/systemc/tests/verify.py
+++ b/src/systemc/tests/verify.py
@@ -30,13 +30,15 @@
 from __future__ import print_function
 
 import argparse
+import collections
+import difflib
 import functools
 import inspect
 import itertools
 import json
-import logging
 import multiprocessing.pool
 import os
+import re
 import subprocess
 import sys
 
@@ -50,8 +52,6 @@ json_rel_path = os.path.join(tests_rel_path, 'tests.json')
 
 
 
-logging.basicConfig(level=logging.INFO)
-
 def scons(*args):
     args = ['scons'] + list(args)
     subprocess.check_call(args)
@@ -63,9 +63,14 @@ class Test(object):
         self.target = target
         self.suffix = suffix
         self.build_dir = build_dir
+        self.props = {}
 
         for key, val in props.iteritems():
-            setattr(self, key, val)
+            self.set_prop(key, val)
+
+    def set_prop(self, key, val):
+        setattr(self, key, val)
+        self.props[key] = val
 
     def dir(self):
         return os.path.join(self.build_dir, tests_rel_path, self.path)
@@ -73,6 +78,9 @@ class Test(object):
     def src_dir(self):
         return os.path.join(script_dir, self.path)
 
+    def expected_returncode_file(self):
+        return os.path.join(self.src_dir(), 'expected_returncode')
+
     def golden_dir(self):
         return os.path.join(self.src_dir(), 'golden')
 
@@ -85,6 +93,9 @@ class Test(object):
     def m5out_dir(self):
         return os.path.join(self.dir(), 'm5out.' + self.suffix)
 
+    def returncode_file(self):
+        return os.path.join(self.m5out_dir(), 'returncode')
+
 
 
 test_phase_classes = {}
@@ -113,7 +124,14 @@ class CompilePhase(TestPhaseBase):
 
     def run(self, tests):
         targets = list([test.full_path() for test in tests])
-        scons_args = list(self.args) + targets
+
+        parser = argparse.ArgumentParser()
+        parser.add_argument('-j', type=int, default=0)
+        args, leftovers = parser.parse_known_args(self.args)
+        if args.j == 0:
+            self.args = ('-j', str(self.main_args.j)) + self.args
+
+        scons_args = [ 'USE_SYSTEMC=1' ] + list(self.args) + targets
         scons(*scons_args)
 
 class RunPhase(TestPhaseBase):
@@ -123,9 +141,10 @@ class RunPhase(TestPhaseBase):
     def run(self, tests):
         parser = argparse.ArgumentParser()
         parser.add_argument('--timeout', type=int, metavar='SECONDS',
-                            help='Time limit for each run in seconds.',
-                            default=0)
-        parser.add_argument('-j', type=int, default=1,
+                            help='Time limit for each run in seconds, '
+                            '0 to disable.',
+                            default=60)
+        parser.add_argument('-j', type=int, default=0,
                 help='How many tests to run in parallel.')
         args = parser.parse_args(self.args)
 
@@ -134,37 +153,348 @@ class RunPhase(TestPhaseBase):
             '--kill-after', str(args.timeout * 2),
             str(args.timeout)
         ]
+        curdir = os.getcwd()
         def run_test(test):
             cmd = []
             if args.timeout:
                 cmd.extend(timeout_cmd)
             cmd.extend([
                 test.full_path(),
-                '-red', test.m5out_dir(),
+                '-rd', os.path.abspath(test.m5out_dir()),
                 '--listener-mode=off',
-                config_path
+                '--quiet',
+                config_path,
+                '--working-dir',
+                os.path.dirname(test.src_dir())
             ])
-            subprocess.check_call(cmd)
+            # Ensure the output directory exists.
+            if not os.path.exists(test.m5out_dir()):
+                os.makedirs(test.m5out_dir())
+            try:
+                subprocess.check_call(cmd)
+            except subprocess.CalledProcessError, error:
+                returncode = error.returncode
+            else:
+                returncode = 0
+            os.chdir(curdir)
+            with open(test.returncode_file(), 'w') as rc:
+                rc.write('%d\n' % returncode)
+
+        j = self.main_args.j if args.j == 0 else args.j
 
         runnable = filter(lambda t: not t.compile_only, tests)
-        if args.j == 1:
+        if j == 1:
             map(run_test, runnable)
         else:
-            tp = multiprocessing.pool.ThreadPool(args.j)
+            tp = multiprocessing.pool.ThreadPool(j)
             map(lambda t: tp.apply_async(run_test, (t,)), runnable)
             tp.close()
             tp.join()
 
+class Checker(object):
+    def __init__(self, ref, test, tag):
+        self.ref = ref
+        self.test = test
+        self.tag = tag
+
+    def check(self):
+        with open(self.test) as test_f, open(self.ref) as ref_f:
+            return test_f.read() == ref_f.read()
+
+def tagged_filt(tag, num):
+    return (r'\n{}: \({}{}\) .*\n(In file: .*\n)?'
+            r'(In process: [\w.]* @ .*\n)?').format(tag, tag[0], num)
+
+def error_filt(num):
+    return tagged_filt('Error', num)
+
+def warning_filt(num):
+    return tagged_filt('Warning', num)
+
+def info_filt(num):
+    return tagged_filt('Info', num)
+
+class DiffingChecker(Checker):
+    def __init__(self, ref, test, tag, out_dir):
+        super(DiffingChecker, self).__init__(ref, test, tag)
+        self.out_dir = out_dir
+
+    def diffing_check(self, ref_lines, test_lines):
+        test_file = os.path.basename(self.test)
+        ref_file = os.path.basename(self.ref)
+
+        diff_file = '.'.join([ref_file, 'diff'])
+        diff_path = os.path.join(self.out_dir, diff_file)
+        if test_lines != ref_lines:
+            with open(diff_path, 'w') as diff_f:
+                for line in difflib.unified_diff(
+                        ref_lines, test_lines,
+                        fromfile=ref_file,
+                        tofile=test_file):
+                    diff_f.write(line)
+            return False
+        else:
+            if os.path.exists(diff_path):
+                os.unlink(diff_path)
+            return True
+
+class LogChecker(DiffingChecker):
+    def merge_filts(*filts):
+        filts = map(lambda f: '(' + f + ')', filts)
+        filts = '|'.join(filts)
+        return re.compile(filts, flags=re.MULTILINE)
+
+    # The reporting mechanism will print the actual filename when running in
+    # gem5, and the "golden" output will say "<removed by verify.py>". We want
+    # to strip out both versions to make comparing the output sensible.
+    in_file_filt = r'^In file: ((<removed by verify\.pl>)|([a-zA-Z0-9.:_/]*))$'
+
+    ref_filt = merge_filts(
+        r'^\nInfo: /OSCI/SystemC: Simulation stopped by user.\n',
+        r'^SystemC Simulation\n',
+        r'^\nInfo: \(I804\) /IEEE_Std_1666/deprecated: ' +
+        r'You can turn off(.*\n){7}',
+        r'^\nInfo: \(I804\) /IEEE_Std_1666/deprecated: \n' +
+        r'    sc_clock\(const char(.*\n){3}',
+        warning_filt(540),
+        warning_filt(571),
+        info_filt(804),
+        in_file_filt,
+    )
+    test_filt = merge_filts(
+        r'^Global frequency set at \d* ticks per second\n',
+        r'^info: Entering event queue @ \d*\.  Starting simulation\.\.\.\n',
+        r'warn: [^(]+\([^)]*\)( \[with [^]]*\])? not implemented\.\n',
+        r'warn: Ignoring request to set stack size\.\n',
+        info_filt(804),
+        in_file_filt,
+    )
+
+    def apply_filters(self, data, filts):
+        re.sub(filt, '', data)
+
+    def check(self):
+        with open(self.test) as test_f, open(self.ref) as ref_f:
+            test = re.sub(self.test_filt, '', test_f.read())
+            ref = re.sub(self.ref_filt, '', ref_f.read())
+            return self.diffing_check(ref.splitlines(True),
+                                      test.splitlines(True))
+
+class VcdChecker(DiffingChecker):
+    def check(self):
+        with open (self.test) as test_f, open(self.ref) as ref_f:
+            ref = ref_f.read().splitlines(True)
+            test = test_f.read().splitlines(True)
+            # Strip off the first seven lines of the test output which are
+            # date and version information.
+            test = test[7:]
+
+            return self.diffing_check(ref, test)
+
+class GoldenDir(object):
+    def __init__(self, path, platform):
+        self.path = path
+        self.platform = platform
+
+        contents = os.listdir(path)
+        suffix = '.' + platform
+        suffixed = filter(lambda c: c.endswith(suffix), contents)
+        bases = map(lambda t: t[:-len(platform)], suffixed)
+        common = filter(lambda t: not t.startswith(tuple(bases)), contents)
+
+        self.entries = {}
+        class Entry(object):
+            def __init__(self, e_path):
+                self.used = False
+                self.path = os.path.join(path, e_path)
+
+            def use(self):
+                self.used = True
+
+        for entry in contents:
+            self.entries[entry] = Entry(entry)
+
+    def entry(self, name):
+        def match(n):
+            return (n == name) or n.startswith(name + '.')
+        matches = { n: e for n, e in self.entries.items() if match(n) }
+
+        for match in matches.values():
+            match.use()
+
+        platform_name = '.'.join([ name, self.platform ])
+        if platform_name in matches:
+            return matches[platform_name].path
+        if name in matches:
+            return matches[name].path
+        else:
+            return None
+
+    def unused(self):
+        items = self.entries.items()
+        items = filter(lambda i: not i[1].used, items)
+
+        items.sort()
+        sources = []
+        i = 0
+        while i < len(items):
+            root = items[i][0]
+            sources.append(root)
+            i += 1
+            while i < len(items) and items[i][0].startswith(root):
+                i += 1
+        return sources
+
 class VerifyPhase(TestPhaseBase):
     name = 'verify'
     number = 3
 
+    def reset_status(self):
+        self._passed = []
+        self._failed = {}
+
+    def passed(self, test):
+        self._passed.append(test)
+
+    def failed(self, test, cause, note=''):
+        test.set_prop('note', note)
+        self._failed.setdefault(cause, []).append(test)
+
+    def print_status(self):
+        total_passed = len(self._passed)
+        total_failed = sum(map(len, self._failed.values()))
+        print()
+        print('Passed: {passed:4} - Failed: {failed:4}'.format(
+                  passed=total_passed, failed=total_failed))
+
+    def write_result_file(self, path):
+        results = {
+            'passed': map(lambda t: t.props, self._passed),
+            'failed': {
+                cause: map(lambda t: t.props, tests) for
+                       cause, tests in self._failed.iteritems()
+            }
+        }
+        with open(path, 'w') as rf:
+            json.dump(results, rf)
+
+    def print_results(self):
+        print()
+        print('Passed:')
+        for path in sorted(list([ t.path for t in self._passed ])):
+            print('    ', path)
+
+        print()
+        print('Failed:')
+
+        causes = []
+        for cause, tests in sorted(self._failed.items()):
+            block = '  ' + cause.capitalize() + ':\n'
+            for test in sorted(tests, key=lambda t: t.path):
+                block += '    ' + test.path
+                if test.note:
+                    block += ' - ' + test.note
+                block += '\n'
+            causes.append(block)
+
+        print('\n'.join(causes))
+
     def run(self, tests):
-        for test in tests:
-            if test.compile_only:
+        parser = argparse.ArgumentParser()
+        result_opts = parser.add_mutually_exclusive_group()
+        result_opts.add_argument('--result-file', action='store_true',
+                help='Create a results.json file in the current directory.')
+        result_opts.add_argument('--result-file-at', metavar='PATH',
+                help='Create a results json file at the given path.')
+        parser.add_argument('--no-print-results', action='store_true',
+                help='Don\'t print a list of tests that passed or failed')
+        args = parser.parse_args(self.args)
+
+        self.reset_status()
+
+        runnable = filter(lambda t: not t.compile_only, tests)
+        compile_only = filter(lambda t: t.compile_only, tests)
+
+        for test in compile_only:
+            if os.path.exists(test.full_path()):
+                self.passed(test)
+            else:
+                self.failed(test, 'compile failed')
+
+        for test in runnable:
+            with open(test.returncode_file()) as rc:
+                returncode = int(rc.read())
+
+            expected_returncode = 0
+            if os.path.exists(test.expected_returncode_file()):
+                with open(test.expected_returncode_file()) as erc:
+                    expected_returncode = int(erc.read())
+
+            if returncode == 124:
+                self.failed(test, 'time out')
+                continue
+            elif returncode != expected_returncode:
+                if expected_returncode == 0:
+                    self.failed(test, 'abort')
+                else:
+                    self.failed(test, 'missed abort')
+                continue
+
+            out_dir = test.m5out_dir()
+
+            Diff = collections.namedtuple(
+                    'Diff', 'ref, test, tag, ref_filter')
+
+            diffs = []
+
+            gd = GoldenDir(test.golden_dir(), 'linux64')
+
+            missing = []
+            log_file = '.'.join([test.name, 'log'])
+            log_path = gd.entry(log_file)
+            simout_path = os.path.join(out_dir, 'simout')
+            if not os.path.exists(simout_path):
+                missing.append('log output')
+            elif log_path:
+                diffs.append(LogChecker(log_path, simout_path,
+                                        log_file, out_dir))
+
+            for name in gd.unused():
+                test_path = os.path.join(out_dir, name)
+                ref_path = gd.entry(name)
+                if not os.path.exists(test_path):
+                    missing.append(name)
+                elif name.endswith('.vcd'):
+                    diffs.append(VcdChecker(ref_path, test_path,
+                                            name, out_dir))
+                else:
+                    diffs.append(Checker(ref_path, test_path, name))
+
+            if missing:
+                self.failed(test, 'missing output', ' '.join(missing))
                 continue
-            logging.info("Would verify %s", test.m5out_dir())
 
+            failed_diffs = filter(lambda d: not d.check(), diffs)
+            if failed_diffs:
+                tags = map(lambda d: d.tag, failed_diffs)
+                self.failed(test, 'failed diffs', ' '.join(tags))
+                continue
+
+            self.passed(test)
+
+        if not args.no_print_results:
+            self.print_results()
+
+        self.print_status()
+
+        result_path = None
+        if args.result_file:
+            result_path = os.path.join(os.getcwd(), 'results.json')
+        elif args.result_file_at:
+            result_path = args.result_file_at
+
+        if result_path:
+            self.write_result_file(result_path)
 
 
 parser = argparse.ArgumentParser(description='SystemC test utility')
@@ -182,6 +512,10 @@ parser.add_argument('--flavor', choices=['debug', 'opt', 'fast'],
 parser.add_argument('--list', action='store_true',
                     help='List the available tests')
 
+parser.add_argument('-j', type=int, default=1,
+                    help='Default level of parallelism, can be overriden '
+                    'for individual stages')
+
 filter_opts = parser.add_mutually_exclusive_group()
 filter_opts.add_argument('--filter', default='True',
                          help='Python expression which filters tests based '
@@ -235,6 +569,10 @@ with open(json_path) as f:
                     test_data.iteritems() if eval(filt, dict(props))
     }
 
+    if len(filtered_tests) == 0:
+        print('All tests were filtered out.')
+        exit()
+
     if main_args.list:
         for target, props in sorted(filtered_tests.iteritems()):
             print('%s.%s' % (target, main_args.flavor))