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