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()),
155 '-rd', 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(514),
229 error_filt(515),
230 error_filt(525),
231 error_filt(541),
232 error_filt(542),
233 error_filt(543),
228 info_filt(804),
229 in_file_filt,
230 )
231 test_filt = merge_filts(
232 r'^Global frequency set at \d* ticks per second\n',
233 r'^info: Entering event queue @ \d*\. Starting simulation\.\.\.\n',
234 r'warn: [^(]+\([^)]*\)( \[with [^]]*\])? not implemented\.\n',
235 info_filt(804),
236 in_file_filt,
237 )
238
239 def __init__(self, ref, test, tag, out_dir):
240 super(LogChecker, self).__init__(ref, test, tag)
241 self.out_dir = out_dir
242
243 def apply_filters(self, data, filts):
244 re.sub(filt, '', data)
245
246 def check(self):
247 test_file = os.path.basename(self.test)
248 ref_file = os.path.basename(self.ref)
249 with open(self.test) as test_f, open(self.ref) as ref_f:
250 test = re.sub(self.test_filt, '', test_f.read())
251 ref = re.sub(self.ref_filt, '', ref_f.read())
252 diff_file = '.'.join([ref_file, 'diff'])
253 diff_path = os.path.join(self.out_dir, diff_file)
254 if test != ref:
255 with open(diff_path, 'w') as diff_f:
256 for line in difflib.unified_diff(
257 ref.splitlines(True), test.splitlines(True),
258 fromfile=ref_file,
259 tofile=test_file):
260 diff_f.write(line)
261 return False
262 else:
263 if os.path.exists(diff_path):
264 os.unlink(diff_path)
265 return True
266
267class GoldenDir(object):
268 def __init__(self, path, platform):
269 self.path = path
270 self.platform = platform
271
272 contents = os.listdir(path)
273 suffix = '.' + platform
274 suffixed = filter(lambda c: c.endswith(suffix), contents)
275 bases = map(lambda t: t[:-len(platform)], suffixed)
276 common = filter(lambda t: not t.startswith(tuple(bases)), contents)
277
278 self.entries = {}
279 class Entry(object):
280 def __init__(self, e_path):
281 self.used = False
282 self.path = os.path.join(path, e_path)
283
284 def use(self):
285 self.used = True
286
287 for entry in contents:
288 self.entries[entry] = Entry(entry)
289
290 def entry(self, name):
291 def match(n):
292 return (n == name) or n.startswith(name + '.')
293 matches = { n: e for n, e in self.entries.items() if match(n) }
294
295 for match in matches.values():
296 match.use()
297
298 platform_name = '.'.join([ name, self.platform ])
299 if platform_name in matches:
300 return matches[platform_name].path
301 if name in matches:
302 return matches[name].path
303 else:
304 return None
305
306 def unused(self):
307 items = self.entries.items()
308 items = filter(lambda i: not i[1].used, items)
309
310 items.sort()
311 sources = []
312 i = 0
313 while i < len(items):
314 root = items[i][0]
315 sources.append(root)
316 i += 1
317 while i < len(items) and items[i][0].startswith(root):
318 i += 1
319 return sources
320
321class VerifyPhase(TestPhaseBase):
322 name = 'verify'
323 number = 3
324
325 def reset_status(self):
326 self._passed = []
327 self._failed = {}
328
329 def passed(self, test):
330 self._passed.append(test)
331
332 def failed(self, test, cause, note=''):
333 test.set_prop('note', note)
334 self._failed.setdefault(cause, []).append(test)
335
336 def print_status(self):
337 total_passed = len(self._passed)
338 total_failed = sum(map(len, self._failed.values()))
339 print()
340 print('Passed: {passed:4} - Failed: {failed:4}'.format(
341 passed=total_passed, failed=total_failed))
342
343 def write_result_file(self, path):
344 results = {
345 'passed': map(lambda t: t.props, self._passed),
346 'failed': {
347 cause: map(lambda t: t.props, tests) for
348 cause, tests in self._failed.iteritems()
349 }
350 }
351 with open(path, 'w') as rf:
352 json.dump(results, rf)
353
354 def print_results(self):
355 print()
356 print('Passed:')
357 for path in sorted(list([ t.path for t in self._passed ])):
358 print(' ', path)
359
360 print()
361 print('Failed:')
362
363 causes = []
364 for cause, tests in sorted(self._failed.items()):
365 block = ' ' + cause.capitalize() + ':\n'
366 for test in sorted(tests, key=lambda t: t.path):
367 block += ' ' + test.path
368 if test.note:
369 block += ' - ' + test.note
370 block += '\n'
371 causes.append(block)
372
373 print('\n'.join(causes))
374
375 def run(self, tests):
376 parser = argparse.ArgumentParser()
377 result_opts = parser.add_mutually_exclusive_group()
378 result_opts.add_argument('--result-file', action='store_true',
379 help='Create a results.json file in the current directory.')
380 result_opts.add_argument('--result-file-at', metavar='PATH',
381 help='Create a results json file at the given path.')
382 parser.add_argument('--print-results', action='store_true',
383 help='Print a list of tests that passed or failed')
384 args = parser.parse_args(self.args)
385
386 self.reset_status()
387
388 runnable = filter(lambda t: not t.compile_only, tests)
389 compile_only = filter(lambda t: t.compile_only, tests)
390
391 for test in compile_only:
392 if os.path.exists(test.full_path()):
393 self.passed(test)
394 else:
395 self.failed(test, 'compile failed')
396
397 for test in runnable:
398 with open(test.returncode_file()) as rc:
399 returncode = int(rc.read())
400
401 expected_returncode = 0
402 if os.path.exists(test.expected_returncode_file()):
403 with open(test.expected_returncode_file()) as erc:
404 expected_returncode = int(erc.read())
405
406 if returncode == 124:
407 self.failed(test, 'time out')
408 continue
409 elif returncode != expected_returncode:
410 if expected_returncode == 0:
411 self.failed(test, 'abort')
412 else:
413 self.failed(test, 'missed abort')
414 continue
415
416 out_dir = test.m5out_dir()
417
418 Diff = collections.namedtuple(
419 'Diff', 'ref, test, tag, ref_filter')
420
421 diffs = []
422
423 gd = GoldenDir(test.golden_dir(), 'linux64')
424
425 missing = []
426 log_file = '.'.join([test.name, 'log'])
427 log_path = gd.entry(log_file)
428 simout_path = os.path.join(out_dir, 'simout')
429 if not os.path.exists(simout_path):
430 missing.append('log output')
431 elif log_path:
432 diffs.append(LogChecker(log_path, simout_path,
433 log_file, out_dir))
434
435 for name in gd.unused():
436 test_path = os.path.join(out_dir, name)
437 ref_path = gd.entry(name)
438 if not os.path.exists(test_path):
439 missing.append(name)
440 else:
441 diffs.append(Checker(ref_path, test_path, name))
442
443 if missing:
444 self.failed(test, 'missing output', ' '.join(missing))
445 continue
446
447 failed_diffs = filter(lambda d: not d.check(), diffs)
448 if failed_diffs:
449 tags = map(lambda d: d.tag, failed_diffs)
450 self.failed(test, 'failed diffs', ' '.join(tags))
451 continue
452
453 self.passed(test)
454
455 if args.print_results:
456 self.print_results()
457
458 self.print_status()
459
460 result_path = None
461 if args.result_file:
462 result_path = os.path.join(os.getcwd(), 'results.json')
463 elif args.result_file_at:
464 result_path = args.result_file_at
465
466 if result_path:
467 self.write_result_file(result_path)
468
469
470parser = argparse.ArgumentParser(description='SystemC test utility')
471
472parser.add_argument('build_dir', metavar='BUILD_DIR',
473 help='The build directory (ie. build/ARM).')
474
475parser.add_argument('--update-json', action='store_true',
476 help='Update the json manifest of tests.')
477
478parser.add_argument('--flavor', choices=['debug', 'opt', 'fast'],
479 default='opt',
480 help='Flavor of binary to test.')
481
482parser.add_argument('--list', action='store_true',
483 help='List the available tests')
484
485filter_opts = parser.add_mutually_exclusive_group()
486filter_opts.add_argument('--filter', default='True',
487 help='Python expression which filters tests based '
488 'on their properties')
489filter_opts.add_argument('--filter-file', default=None,
490 type=argparse.FileType('r'),
491 help='Same as --filter, but read from a file')
492
493def collect_phases(args):
494 phase_groups = [list(g) for k, g in
495 itertools.groupby(args, lambda x: x != '--phase') if k]
496 main_args = parser.parse_args(phase_groups[0][1:])
497 phases = []
498 names = []
499 for group in phase_groups[1:]:
500 name = group[0]
501 if name in names:
502 raise RuntimeException('Phase %s specified more than once' % name)
503 phase = test_phase_classes[name]
504 phases.append(phase(main_args, *group[1:]))
505 phases.sort()
506 return main_args, phases
507
508main_args, phases = collect_phases(sys.argv)
509
510if len(phases) == 0:
511 phases = [
512 CompilePhase(main_args),
513 RunPhase(main_args),
514 VerifyPhase(main_args)
515 ]
516
517
518
519json_path = os.path.join(main_args.build_dir, json_rel_path)
520
521if main_args.update_json:
522 scons(os.path.join(json_path))
523
524with open(json_path) as f:
525 test_data = json.load(f)
526
527 if main_args.filter_file:
528 f = main_args.filter_file
529 filt = compile(f.read(), f.name, 'eval')
530 else:
531 filt = compile(main_args.filter, '<string>', 'eval')
532
533 filtered_tests = {
534 target: props for (target, props) in
535 test_data.iteritems() if eval(filt, dict(props))
536 }
537
538 if len(filtered_tests) == 0:
539 print('All tests were filtered out.')
540 exit()
541
542 if main_args.list:
543 for target, props in sorted(filtered_tests.iteritems()):
544 print('%s.%s' % (target, main_args.flavor))
545 for key, val in props.iteritems():
546 print(' %s: %s' % (key, val))
547 print('Total tests: %d' % len(filtered_tests))
548 else:
549 tests_to_run = list([
550 Test(target, main_args.flavor, main_args.build_dir, props) for
551 target, props in sorted(filtered_tests.iteritems())
552 ])
553
554 for phase in phases:
555 phase.run(tests_to_run)