tests/gem5/verifier.py

   1 # Copyright (c) 2017 Mark D. Hill and David A. Wood
   2 # All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met: redistributions of source code must retain the above copyright
   7 # notice, this list of conditions and the following disclaimer;
   8 # redistributions in binary form must reproduce the above copyright
   9 # notice, this list of conditions and the following disclaimer in the
  10 # documentation and/or other materials provided with the distribution;
  11 # neither the name of the copyright holders nor the names of its
  12 # contributors may be used to endorse or promote products derived from
  13 # this software without specific prior written permission.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  18 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  19 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26
  27 '''
  28 Built in test cases that verify particular details about a gem5 run.
  29 '''
  30 import re
  31
  32 from testlib import test_util
  33 from testlib.configuration import constants
  34 from testlib.helper import joinpath, diff_out_file
  35
  36 class Verifier(object):
  37     def __init__(self, fixtures=tuple()):
  38         self.fixtures = fixtures
  39
  40     def _test(self, *args, **kwargs):
  41         # Use a callback wrapper to make stack
  42         # traces easier to understand.
  43         self.test(*args, **kwargs)
  44
  45     def instantiate_test(self, name_pfx):
  46         name = '-'.join([name_pfx, self.__class__.__name__])
  47         return test_util.TestFunction(self._test,
  48                 name=name, fixtures=self.fixtures)
  49
  50 class MatchGoldStandard(Verifier):
  51     '''
  52     Compares a standard output to the test output and passes if they match,
  53     fails if they do not.
  54     '''
  55     def __init__(self, standard_filename, ignore_regex=None,
  56                  test_filename='simout'):
  57         '''
  58         :param standard_filename: The path of the standard file to compare
  59         output to.
  60
  61         :param ignore_regex: A string, compiled regex, or iterable containing
  62         either which will be ignored in 'standard' and test output files when
  63         diffing.
  64         '''
  65         super(MatchGoldStandard, self).__init__()
  66         self.standard_filename = standard_filename
  67         self.test_filename = test_filename
  68
  69         self.ignore_regex = _iterable_regex(ignore_regex)
  70
  71     def test(self, params):
  72         # We need a tempdir fixture from our parent verifier suite.
  73         fixtures = params.fixtures
  74         # Get the file from the tempdir of the test.
  75         tempdir = fixtures[constants.tempdir_fixture_name].path
  76         self.test_filename = joinpath(tempdir, self.test_filename)
  77
  78         diff = diff_out_file(self.standard_filename,
  79                             self.test_filename,
  80                             ignore_regexes=self.ignore_regex,
  81                             logger=params.log)
  82         if diff is not None:
  83             test_util.fail('Stdout did not match:\n%s\nSee %s for full results'
  84                       % (diff, tempdir))
  85
  86     def _generic_instance_warning(self, kwargs):
  87         '''
  88         Method for helper classes to tell users to use this more generic class
  89         if they are going to manually override the test_filename param.
  90         '''
  91         if 'test_filename' in kwargs:
  92             raise ValueError('If you are setting test_filename use the more'
  93                              ' generic %s'
  94                              ' instead' % MatchGoldStandard.__name__)
  95
  96 class DerivedGoldStandard(MatchGoldStandard):
  97     __ignore_regex_sentinel = object()
  98     _file = None
  99     _default_ignore_regex = []
 100
 101     def __init__(self, standard_filename,
 102                  ignore_regex=__ignore_regex_sentinel, **kwargs):
 103
 104         if ignore_regex == self.__ignore_regex_sentinel:
 105             ignore_regex = self._default_ignore_regex
 106
 107         self._generic_instance_warning(kwargs)
 108
 109         super(DerivedGoldStandard, self).__init__(
 110             standard_filename,
 111             test_filename=self._file,
 112             ignore_regex=ignore_regex,
 113             **kwargs)
 114
 115 class MatchStdout(DerivedGoldStandard):
 116     _file = constants.gem5_simulation_stdout
 117     _default_ignore_regex = [
 118             re.compile('^\s+$'), # Remove blank lines.
 119             re.compile('^gem5 Simulator System'),
 120             re.compile('^gem5 is copyrighted software'),
 121             re.compile('^Redirecting (stdout|stderr) to'),
 122             re.compile('^gem5 version '),
 123             re.compile('^gem5 compiled '),
 124             re.compile('^gem5 started '),
 125             re.compile('^gem5 executing on '),
 126             re.compile('^command line:'),
 127             re.compile("^Couldn't import dot_parser,"),
 128             re.compile("^info: kernel located at:"),
 129             re.compile("^info: Standard input is not a terminal"),
 130             re.compile("^Couldn't unlink "),
 131             re.compile("^Using GPU kernel code file\(s\) "),
 132         ]
 133
 134 class MatchStdoutNoPerf(MatchStdout):
 135     _file = constants.gem5_simulation_stdout
 136     _default_ignore_regex = MatchStdout._default_ignore_regex + [
 137             re.compile('^Exiting @ tick'),
 138         ]
 139
 140 class MatchStderr(DerivedGoldStandard):
 141     _file = constants.gem5_simulation_stderr
 142     _default_ignore_regex = []
 143
 144 class MatchStats(DerivedGoldStandard):
 145     # TODO: Likely will want to change this verifier since we have the weird
 146     # perl script right now. A simple diff probably isn't going to work.
 147     _file = constants.gem5_simulation_stats
 148     _default_ignore_regex = []
 149
 150 class MatchConfigINI(DerivedGoldStandard):
 151     _file = constants.gem5_simulation_config_ini
 152     _default_ignore_regex = (
 153             re.compile("^(executable|readfile|kernel|image_file)="),
 154             re.compile("^(cwd|input|codefile)="),
 155             )
 156
 157 class MatchConfigJSON(DerivedGoldStandard):
 158     _file = constants.gem5_simulation_config_json
 159     _default_ignore_regex = (
 160             re.compile(r'''^\s*"(executable|readfile|kernel|image_file)":'''),
 161             re.compile(r'''^\s*"(cwd|input|codefile)":'''),
 162             )
 163
 164 class MatchRegex(Verifier):
 165     def __init__(self, regex, match_stderr=True, match_stdout=True):
 166         super(MatchRegex, self).__init__()
 167         self.regex = _iterable_regex(regex)
 168         self.match_stderr = match_stderr
 169         self.match_stdout = match_stdout
 170
 171     def test(self, params):
 172         fixtures = params.fixtures
 173         # Get the file from the tempdir of the test.
 174         tempdir = fixtures[constants.tempdir_fixture_name].path
 175
 176         def parse_file(fname):
 177             with open(fname, 'r') as file_:
 178                 for line in file_:
 179                     for regex in self.regex:
 180                         if re.match(regex, line):
 181                             return True
 182         if self.match_stdout:
 183             if parse_file(joinpath(tempdir,
 184                                    constants.gem5_simulation_stdout)):
 185                 return # Success
 186         if self.match_stderr:
 187             if parse_file(joinpath(tempdir,
 188                                    constants.gem5_simulation_stderr)):
 189                 return # Success
 190         test_util.fail('Could not match regex.')
 191
 192 _re_type = type(re.compile(''))
 193 def _iterable_regex(regex):
 194     if isinstance(regex, _re_type) or isinstance(regex, str):
 195         regex = (regex,)
 196     return regex