verify.py revision 13148:db08868ca25d 
1#!/usr/bin/env python2
2#
3# Copyright 2018 Google, Inc.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions are
7# met: redistributions of source code must retain the above copyright
8# notice, this list of conditions and the following disclaimer;
9# redistributions in binary form must reproduce the above copyright
10# notice, this list of conditions and the following disclaimer in the
11# documentation and/or other materials provided with the distribution;
12# neither the name of the copyright holders nor the names of its
13# contributors may be used to endorse or promote products derived from
14# this software without specific prior written permission.
15#
16# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27#
28# Authors: Gabe Black
29
30from __future__ import print_function
31
32import argparse
33import collections
34import difflib
35import functools
36import inspect
37import itertools
38import json
39import multiprocessing.pool
40import os
41import re
42import subprocess
43import sys
44
45script_path = os.path.abspath(inspect.getfile(inspect.currentframe()))
46script_dir = os.path.dirname(script_path)
47config_path = os.path.join(script_dir, 'config.py')
48
49systemc_rel_path = 'systemc'
50tests_rel_path = os.path.join(systemc_rel_path, 'tests')
51json_rel_path = os.path.join(tests_rel_path, 'tests.json')
52
53
54
55def scons(*args):
56    args = ['scons'] + list(args)
57    subprocess.check_call(args)
58
59
60
61class Test(object):
62    def __init__(self, target, suffix, build_dir, props):
63        self.target = target
64        self.suffix = suffix
65        self.build_dir = build_dir
66        self.props = {}
67
68        for key, val in props.iteritems():
69            self.set_prop(key, val)
70
71    def set_prop(self, key, val):
72        setattr(self, key, val)
73        self.props[key] = val
74
75    def dir(self):
76        return os.path.join(self.build_dir, tests_rel_path, self.path)
77
78    def src_dir(self):
79        return os.path.join(script_dir, self.path)
80
81    def expected_returncode_file(self):
82        return os.path.join(self.src_dir(), 'expected_returncode')
83
84    def golden_dir(self):
85        return os.path.join(self.src_dir(), 'golden')
86
87    def bin(self):
88        return '.'.join([self.name, self.suffix])
89
90    def full_path(self):
91        return os.path.join(self.dir(), self.bin())
92
93    def m5out_dir(self):
94        return os.path.join(self.dir(), 'm5out.' + self.suffix)
95
96    def returncode_file(self):
97        return os.path.join(self.m5out_dir(), 'returncode')
98
99
100
101test_phase_classes = {}
102
103class TestPhaseMeta(type):
104    def __init__(cls, name, bases, d):
105        if not d.pop('abstract', False):
106            test_phase_classes[d['name']] = cls
107
108        super(TestPhaseMeta, cls).__init__(name, bases, d)
109
110class TestPhaseBase(object):
111    __metaclass__ = TestPhaseMeta
112    abstract = True
113
114    def __init__(self, main_args, *args):
115        self.main_args = main_args
116        self.args = args
117
118    def __lt__(self, other):
119        return self.number < other.number
120
121class CompilePhase(TestPhaseBase):
122    name = 'compile'
123    number = 1
124
125    def run(self, tests):
126        targets = list([test.full_path() for test in tests])
127        scons_args = [ 'USE_SYSTEMC=1' ] + list(self.args) + targets
128        scons(*scons_args)
129
130class RunPhase(TestPhaseBase):
131    name = 'execute'
132    number = 2
133
134    def run(self, tests):
135        parser = argparse.ArgumentParser()
136        parser.add_argument('--timeout', type=int, metavar='SECONDS',
137                            help='Time limit for each run in seconds.',
138                            default=0)
139        parser.add_argument('-j', type=int, default=1,
140                help='How many tests to run in parallel.')
141        args = parser.parse_args(self.args)
142
143        timeout_cmd = [
144            'timeout',
145            '--kill-after', str(args.timeout * 2),
146            str(args.timeout)
147        ]
148        curdir = os.getcwd()
149        def run_test(test):
150            cmd = []
151            if args.timeout:
152                cmd.extend(timeout_cmd)
153            cmd.extend([
154                test.full_path(),
155                '-red', os.path.abspath(test.m5out_dir()),
156                '--listener-mode=off',
157                '--quiet',
158                config_path,
159                '--working-dir',
160                os.path.dirname(test.src_dir())
161            ])
162            # Ensure the output directory exists.
163            if not os.path.exists(test.m5out_dir()):
164                os.makedirs(test.m5out_dir())
165            try:
166                subprocess.check_call(cmd)
167            except subprocess.CalledProcessError, error:
168                returncode = error.returncode
169            else:
170                returncode = 0
171            os.chdir(curdir)
172            with open(test.returncode_file(), 'w') as rc:
173                rc.write('%d\n' % returncode)
174
175        runnable = filter(lambda t: not t.compile_only, tests)
176        if args.j == 1:
177            map(run_test, runnable)
178        else:
179            tp = multiprocessing.pool.ThreadPool(args.j)
180            map(lambda t: tp.apply_async(run_test, (t,)), runnable)
181            tp.close()
182            tp.join()
183
184class Checker(object):
185    def __init__(self, ref, test, tag):
186        self.ref = ref
187        self.test = test
188        self.tag = tag
189
190    def check(self):
191        with open(self.text) as test_f, open(self.ref) as ref_f:
192            return test_f.read() == ref_f.read()
193
194def tagged_filt(tag, num):
195    return (r'^\n{}: \({}{}\) .*\n(In file: .*\n)?'
196            r'(In process: [\w.]* @ .*\n)?').format(tag, tag[0], num)
197
198def error_filt(num):
199    return tagged_filt('Error', num)
200
201def warning_filt(num):
202    return tagged_filt('Warning', num)
203
204def info_filt(num):
205    return tagged_filt('Info', num)
206
207class LogChecker(Checker):
208    def merge_filts(*filts):
209        filts = map(lambda f: '(' + f + ')', filts)
210        filts = '|'.join(filts)
211        return re.compile(filts, flags=re.MULTILINE)
212
213    # The reporting mechanism will print the actual filename when running in
214    # gem5, and the "golden" output will say "<removed by verify.py>". We want
215    # to strip out both versions to make comparing the output sensible.
216    in_file_filt = r'^In file: ((<removed by verify\.pl>)|([a-zA-Z0-9.:_/]*))$'
217
218    ref_filt = merge_filts(
219        r'^\nInfo: /OSCI/SystemC: Simulation stopped by user.\n',
220        r'^SystemC Simulation\n',
221        r'^\nInfo: \(I804\) /IEEE_Std_1666/deprecated: ' +
222        r'You can turn off(.*\n){7}',
223        r'^\nInfo: \(I804\) /IEEE_Std_1666/deprecated: \n' +
224        r'    sc_clock\(const char(.*\n){3}',
225        warning_filt(540),
226        warning_filt(569),
227        warning_filt(571),
228        error_filt(525),
229        error_filt(541),
230        error_filt(542),
231        error_filt(543),
232        info_filt(804),
233        in_file_filt,
234    )
235    test_filt = merge_filts(
236        r'^Global frequency set at \d* ticks per second\n',
237        info_filt(804),
238        in_file_filt,
239    )
240
241    def __init__(self, ref, test, tag, out_dir):
242        super(LogChecker, self).__init__(ref, test, tag)
243        self.out_dir = out_dir
244
245    def apply_filters(self, data, filts):
246        re.sub(filt, '', data)
247
248    def check(self):
249        test_file = os.path.basename(self.test)
250        ref_file = os.path.basename(self.ref)
251        with open(self.test) as test_f, open(self.ref) as ref_f:
252            test = re.sub(self.test_filt, '', test_f.read())
253            ref = re.sub(self.ref_filt, '', ref_f.read())
254            diff_file = '.'.join([ref_file, 'diff'])
255            diff_path = os.path.join(self.out_dir, diff_file)
256            if test != ref:
257                with open(diff_path, 'w') as diff_f:
258                    for line in difflib.unified_diff(
259                            ref.splitlines(True), test.splitlines(True),
260                            fromfile=ref_file,
261                            tofile=test_file):
262                        diff_f.write(line)
263                return False
264            else:
265                if os.path.exists(diff_path):
266                    os.unlink(diff_path)
267        return True
268
269class GoldenDir(object):
270    def __init__(self, path, platform):
271        self.path = path
272        self.platform = platform
273
274        contents = os.listdir(path)
275        suffix = '.' + platform
276        suffixed = filter(lambda c: c.endswith(suffix), contents)
277        bases = map(lambda t: t[:-len(platform)], suffixed)
278        common = filter(lambda t: not t.startswith(tuple(bases)), contents)
279
280        self.entries = {}
281        class Entry(object):
282            def __init__(self, e_path):
283                self.used = False
284                self.path = os.path.join(path, e_path)
285
286            def use(self):
287                self.used = True
288
289        for entry in contents:
290            self.entries[entry] = Entry(entry)
291
292    def entry(self, name):
293        def match(n):
294            return (n == name) or n.startswith(name + '.')
295        matches = { n: e for n, e in self.entries.items() if match(n) }
296
297        for match in matches.values():
298            match.use()
299
300        platform_name = '.'.join([ name, self.platform ])
301        if platform_name in matches:
302            return matches[platform_name].path
303        if name in matches:
304            return matches[name].path
305        else:
306            return None
307
308    def unused(self):
309        items = self.entries.items()
310        items = filter(lambda i: not i[1].used, items)
311
312        items.sort()
313        sources = []
314        i = 0
315        while i < len(items):
316            root = items[i][0]
317            sources.append(root)
318            i += 1
319            while i < len(items) and items[i][0].startswith(root):
320                i += 1
321        return sources
322
323class VerifyPhase(TestPhaseBase):
324    name = 'verify'
325    number = 3
326
327    def reset_status(self):
328        self._passed = []
329        self._failed = {}
330
331    def passed(self, test):
332        self._passed.append(test)
333
334    def failed(self, test, cause, note=''):
335        test.set_prop('note', note)
336        self._failed.setdefault(cause, []).append(test)
337
338    def print_status(self):
339        total_passed = len(self._passed)
340        total_failed = sum(map(len, self._failed.values()))
341        print()
342        print('Passed: {passed:4} - Failed: {failed:4}'.format(
343                  passed=total_passed, failed=total_failed))
344
345    def write_result_file(self, path):
346        results = {
347            'passed': map(lambda t: t.props, self._passed),
348            'failed': {
349                cause: map(lambda t: t.props, tests) for
350                       cause, tests in self._failed.iteritems()
351            }
352        }
353        with open(path, 'w') as rf:
354            json.dump(results, rf)
355
356    def print_results(self):
357        print()
358        print('Passed:')
359        for path in sorted(list([ t.path for t in self._passed ])):
360            print('    ', path)
361
362        print()
363        print('Failed:')
364
365        causes = []
366        for cause, tests in sorted(self._failed.items()):
367            block = '  ' + cause.capitalize() + ':\n'
368            for test in sorted(tests, key=lambda t: t.path):
369                block += '    ' + test.path
370                if test.note:
371                    block += ' - ' + test.note
372                block += '\n'
373            causes.append(block)
374
375        print('\n'.join(causes))
376
377    def run(self, tests):
378        parser = argparse.ArgumentParser()
379        result_opts = parser.add_mutually_exclusive_group()
380        result_opts.add_argument('--result-file', action='store_true',
381                help='Create a results.json file in the current directory.')
382        result_opts.add_argument('--result-file-at', metavar='PATH',
383                help='Create a results json file at the given path.')
384        parser.add_argument('--print-results', action='store_true',
385                help='Print a list of tests that passed or failed')
386        args = parser.parse_args(self.args)
387
388        self.reset_status()
389
390        runnable = filter(lambda t: not t.compile_only, tests)
391        compile_only = filter(lambda t: t.compile_only, tests)
392
393        for test in compile_only:
394            if os.path.exists(test.full_path()):
395                self.passed(test)
396            else:
397                self.failed(test, 'compile failed')
398
399        for test in runnable:
400            with open(test.returncode_file()) as rc:
401                returncode = int(rc.read())
402
403            expected_returncode = 0
404            if os.path.exists(test.expected_returncode_file()):
405                with open(test.expected_returncode_file()) as erc:
406                    expected_returncode = int(erc.read())
407
408            if returncode == 124:
409                self.failed(test, 'time out')
410                continue
411            elif returncode != expected_returncode:
412                if expected_returncode == 0:
413                    self.failed(test, 'abort')
414                else:
415                    self.failed(test, 'missed abort')
416                continue
417
418            out_dir = test.m5out_dir()
419
420            Diff = collections.namedtuple(
421                    'Diff', 'ref, test, tag, ref_filter')
422
423            diffs = []
424
425            gd = GoldenDir(test.golden_dir(), 'linux64')
426
427            missing = []
428            log_file = '.'.join([test.name, 'log'])
429            log_path = gd.entry(log_file)
430            simout_path = os.path.join(out_dir, 'simout')
431            if not os.path.exists(simout_path):
432                missing.append('log output')
433            elif log_path:
434                diffs.append(LogChecker(log_path, simout_path,
435                                        log_file, out_dir))
436
437            for name in gd.unused():
438                test_path = os.path.join(out_dir, name)
439                ref_path = gd.entry(name)
440                if not os.path.exists(test_path):
441                    missing.append(name)
442                else:
443                    diffs.append(Checker(ref_path, test_path, name))
444
445            if missing:
446                self.failed(test, 'missing output', ' '.join(missing))
447                continue
448
449            failed_diffs = filter(lambda d: not d.check(), diffs)
450            if failed_diffs:
451                tags = map(lambda d: d.tag, failed_diffs)
452                self.failed(test, 'failed diffs', ' '.join(tags))
453                continue
454
455            self.passed(test)
456
457        if args.print_results:
458            self.print_results()
459
460        self.print_status()
461
462        result_path = None
463        if args.result_file:
464            result_path = os.path.join(os.getcwd(), 'results.json')
465        elif args.result_file_at:
466            result_path = args.result_file_at
467
468        if result_path:
469            self.write_result_file(result_path)
470
471
472parser = argparse.ArgumentParser(description='SystemC test utility')
473
474parser.add_argument('build_dir', metavar='BUILD_DIR',
475                    help='The build directory (ie. build/ARM).')
476
477parser.add_argument('--update-json', action='store_true',
478                    help='Update the json manifest of tests.')
479
480parser.add_argument('--flavor', choices=['debug', 'opt', 'fast'],
481                    default='opt',
482                    help='Flavor of binary to test.')
483
484parser.add_argument('--list', action='store_true',
485                    help='List the available tests')
486
487filter_opts = parser.add_mutually_exclusive_group()
488filter_opts.add_argument('--filter', default='True',
489                         help='Python expression which filters tests based '
490                         'on their properties')
491filter_opts.add_argument('--filter-file', default=None,
492                         type=argparse.FileType('r'),
493                         help='Same as --filter, but read from a file')
494
495def collect_phases(args):
496    phase_groups = [list(g) for k, g in
497                    itertools.groupby(args, lambda x: x != '--phase') if k]
498    main_args = parser.parse_args(phase_groups[0][1:])
499    phases = []
500    names = []
501    for group in phase_groups[1:]:
502        name = group[0]
503        if name in names:
504            raise RuntimeException('Phase %s specified more than once' % name)
505        phase = test_phase_classes[name]
506        phases.append(phase(main_args, *group[1:]))
507    phases.sort()
508    return main_args, phases
509
510main_args, phases = collect_phases(sys.argv)
511
512if len(phases) == 0:
513    phases = [
514        CompilePhase(main_args),
515        RunPhase(main_args),
516        VerifyPhase(main_args)
517    ]
518
519
520
521json_path = os.path.join(main_args.build_dir, json_rel_path)
522
523if main_args.update_json:
524    scons(os.path.join(json_path))
525
526with open(json_path) as f:
527    test_data = json.load(f)
528
529    if main_args.filter_file:
530        f = main_args.filter_file
531        filt = compile(f.read(), f.name, 'eval')
532    else:
533        filt = compile(main_args.filter, '<string>', 'eval')
534
535    filtered_tests = {
536        target: props for (target, props) in
537                    test_data.iteritems() if eval(filt, dict(props))
538    }
539
540    if len(filtered_tests) == 0:
541        print('All tests were filtered out.')
542        exit()
543
544    if main_args.list:
545        for target, props in sorted(filtered_tests.iteritems()):
546            print('%s.%s' % (target, main_args.flavor))
547            for key, val in props.iteritems():
548                print('    %s: %s' % (key, val))
549        print('Total tests: %d' % len(filtered_tests))
550    else:
551        tests_to_run = list([
552            Test(target, main_args.flavor, main_args.build_dir, props) for
553                target, props in sorted(filtered_tests.iteritems())
554        ])
555
556        for phase in phases:
557            phase.run(tests_to_run)
558