1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
|
#!/usr/bin/env python2
#
# Copyright 2018 Google, Inc.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# 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: Gabe Black
from __future__ import print_function
import argparse
import collections
import difflib
import functools
import inspect
import itertools
import json
import multiprocessing.pool
import os
import re
import subprocess
import sys
script_path = os.path.abspath(inspect.getfile(inspect.currentframe()))
script_dir = os.path.dirname(script_path)
config_path = os.path.join(script_dir, 'config.py')
systemc_rel_path = 'systemc'
tests_rel_path = os.path.join(systemc_rel_path, 'tests')
json_rel_path = os.path.join(tests_rel_path, 'tests.json')
def scons(*args):
args = ['scons'] + list(args)
subprocess.check_call(args)
class Test(object):
def __init__(self, target, suffix, build_dir, props):
self.target = target
self.suffix = suffix
self.build_dir = build_dir
self.props = {}
for key, val in props.iteritems():
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)
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')
def bin(self):
return '.'.join([self.name, self.suffix])
def full_path(self):
return os.path.join(self.dir(), self.bin())
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 = {}
class TestPhaseMeta(type):
def __init__(cls, name, bases, d):
if not d.pop('abstract', False):
test_phase_classes[d['name']] = cls
super(TestPhaseMeta, cls).__init__(name, bases, d)
class TestPhaseBase(object):
__metaclass__ = TestPhaseMeta
abstract = True
def __init__(self, main_args, *args):
self.main_args = main_args
self.args = args
def __lt__(self, other):
return self.number < other.number
class CompilePhase(TestPhaseBase):
name = 'compile'
number = 1
def run(self, tests):
targets = list([test.full_path() for test in tests])
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):
name = 'execute'
number = 2
def run(self, tests):
parser = argparse.ArgumentParser()
parser.add_argument('--timeout', type=int, metavar='SECONDS',
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)
timeout_cmd = [
'timeout',
'--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(),
'-rd', os.path.abspath(test.m5out_dir()),
'--listener-mode=off',
'--quiet',
config_path,
'--working-dir',
os.path.dirname(test.src_dir())
])
# 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 j == 1:
map(run_test, runnable)
else:
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.text) 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 LogChecker(Checker):
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 __init__(self, ref, test, tag, out_dir):
super(LogChecker, self).__init__(ref, test, tag)
self.out_dir = out_dir
def apply_filters(self, data, filts):
re.sub(filt, '', data)
def check(self):
test_file = os.path.basename(self.test)
ref_file = os.path.basename(self.ref)
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())
diff_file = '.'.join([ref_file, 'diff'])
diff_path = os.path.join(self.out_dir, diff_file)
if test != ref:
with open(diff_path, 'w') as diff_f:
for line in difflib.unified_diff(
ref.splitlines(True), test.splitlines(True),
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 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):
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)
else:
diffs.append(Checker(ref_path, test_path, name))
if missing:
self.failed(test, 'missing output', ' '.join(missing))
continue
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')
parser.add_argument('build_dir', metavar='BUILD_DIR',
help='The build directory (ie. build/ARM).')
parser.add_argument('--update-json', action='store_true',
help='Update the json manifest of tests.')
parser.add_argument('--flavor', choices=['debug', 'opt', 'fast'],
default='opt',
help='Flavor of binary to test.')
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 '
'on their properties')
filter_opts.add_argument('--filter-file', default=None,
type=argparse.FileType('r'),
help='Same as --filter, but read from a file')
def collect_phases(args):
phase_groups = [list(g) for k, g in
itertools.groupby(args, lambda x: x != '--phase') if k]
main_args = parser.parse_args(phase_groups[0][1:])
phases = []
names = []
for group in phase_groups[1:]:
name = group[0]
if name in names:
raise RuntimeException('Phase %s specified more than once' % name)
phase = test_phase_classes[name]
phases.append(phase(main_args, *group[1:]))
phases.sort()
return main_args, phases
main_args, phases = collect_phases(sys.argv)
if len(phases) == 0:
phases = [
CompilePhase(main_args),
RunPhase(main_args),
VerifyPhase(main_args)
]
json_path = os.path.join(main_args.build_dir, json_rel_path)
if main_args.update_json:
scons(os.path.join(json_path))
with open(json_path) as f:
test_data = json.load(f)
if main_args.filter_file:
f = main_args.filter_file
filt = compile(f.read(), f.name, 'eval')
else:
filt = compile(main_args.filter, '<string>', 'eval')
filtered_tests = {
target: props for (target, props) in
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))
for key, val in props.iteritems():
print(' %s: %s' % (key, val))
print('Total tests: %d' % len(filtered_tests))
else:
tests_to_run = list([
Test(target, main_args.flavor, main_args.build_dir, props) for
target, props in sorted(filtered_tests.iteritems())
])
for phase in phases:
phase.run(tests_to_run)
|