Decrease sleep time to 0.1s.
[riscv-tests.git] / debug / testlib.py
index 0da09a1236dc67bb405f479bace13ab168135faa..b8e9ad4d209c47e41865e4aab933ab6d99d90504 100644 (file)
@@ -2,7 +2,9 @@ import os.path
 import re
 import shlex
 import subprocess
+import sys
 import time
+import traceback
 
 import pexpect
 
@@ -102,8 +104,11 @@ class VcsSim(object):
             line = listenfile.readline()
             if not line:
                 time.sleep(1)
-            if "Listening on port 5555" in line:
+            match = re.match(r"^Listening on port (\d+)$", line)
+            if match:
                 done = True
+                self.port = int(match.group(1))
+                os.environ['JTAG_VPI_PORT'] = str(self.port)
 
     def __del__(self):
         try:
@@ -115,12 +120,7 @@ class VcsSim(object):
 class Openocd(object):
     logname = "openocd.log"
 
-    def __init__(self, cmd=None, config=None, debug=False, otherProcess=None):
-
-        # keep handles to other processes -- don't let them be
-        # garbage collected yet.
-
-        self.otherProcess = otherProcess
+    def __init__(self, cmd=None, config=None, debug=False):
         if cmd:
             cmd = shlex.split(cmd)
         else:
@@ -129,13 +129,17 @@ class Openocd(object):
             cmd += ["-f", find_file(config)]
         if debug:
             cmd.append("-d")
+
+        # This command needs to come before any config scripts on the command
+        # line, since they are executed in order.
+        # Tell OpenOCD to bind to an unused port.
+        cmd[1:1] = ["--command", "gdb_port %d" % 0]
+
         logfile = open(Openocd.logname, "w")
         logfile.write("+ %s\n" % " ".join(cmd))
         logfile.flush()
         self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE,
                 stdout=logfile, stderr=logfile)
-        # TODO: Pick a random port
-        self.port = 3333
 
         # Wait for OpenOCD to have made it through riscv_examine(). When using
         # OpenOCD to communicate with a simulator this may take a long time,
@@ -147,11 +151,37 @@ class Openocd(object):
             if "Examined RISCV core" in log:
                 break
             if not self.process.poll() is None:
-                raise Exception("OpenOCD exited before completing riscv_examine()")
+                raise Exception(
+                        "OpenOCD exited before completing riscv_examine()")
             if not messaged and time.time() - start > 1:
                 messaged = True
                 print "Waiting for OpenOCD to examine RISCV core..."
 
+        self.port = self._get_gdb_server_port()
+
+    def _get_gdb_server_port(self):
+        """Get port that OpenOCD's gdb server is listening on."""
+        MAX_ATTEMPTS = 50
+        PORT_REGEX = re.compile(r'(?P<port>\d+) \(LISTEN\)')
+        for _ in range(MAX_ATTEMPTS):
+            with open(os.devnull, 'w') as devnull:
+                output = subprocess.check_output([
+                    'lsof',
+                    '-a',  # Take the AND of the following selectors
+                    '-p{}'.format(self.process.pid),  # Filter on PID
+                    '-iTCP',  # Filter only TCP sockets
+                ], stderr=devnull)
+            matches = list(PORT_REGEX.finditer(output))
+            if len(matches) > 1:
+                raise Exception(
+                    "OpenOCD listening on multiple ports. Cannot uniquely "
+                    "identify gdb server port.")
+            elif matches:
+                [match] = matches
+                return int(match.group('port'))
+            time.sleep(0.1)
+        raise Exception("Timed out waiting for gdb server to obtain port.")
+
     def __del__(self):
         try:
             self.process.kill()
@@ -159,6 +189,32 @@ class Openocd(object):
         except OSError:
             pass
 
+class OpenocdCli(object):
+    def __init__(self, port=4444):
+        self.child = pexpect.spawn(
+                "sh -c 'telnet localhost %d | tee openocd-cli.log'" % port)
+        self.child.expect("> ")
+
+    def command(self, cmd):
+        self.child.sendline(cmd)
+        self.child.expect(cmd)
+        self.child.expect("\n")
+        self.child.expect("> ")
+        return self.child.before.strip("\t\r\n \0")
+
+    def reg(self, reg=''):
+        output = self.command("reg %s" % reg)
+        matches = re.findall(r"(\w+) \(/\d+\): (0x[0-9A-F]+)", output)
+        values = {r: int(v, 0) for r, v in matches}
+        if reg:
+            return values[reg]
+        return values
+
+    def load_image(self, image):
+        output = self.command("load_image %s" % image)
+        if 'invalid ELF file, only 32bits files are supported' in output:
+            raise TestNotApplicable(output)
+
 class CannotAccess(Exception):
     def __init__(self, address):
         Exception.__init__(self)
@@ -206,6 +262,13 @@ class Gdb(object):
         value = int(output.split(':')[1].strip(), 0)
         return value
 
+    def p_raw(self, obj):
+        output = self.command("p %s" % obj)
+        m = re.search("Cannot access memory at address (0x[0-9a-f]+)", output)
+        if m:
+            raise CannotAccess(int(m.group(1), 0))
+        return output.split('=')[-1].strip()
+
     def p(self, obj):
         output = self.command("p/x %s" % obj)
         m = re.search("Cannot access memory at address (0x[0-9a-f]+)", output)
@@ -239,3 +302,187 @@ class Gdb(object):
         assert "not defined" not in output
         assert "Hardware assisted breakpoint" in output
         return output
+
+def run_all_tests(module, target, tests, fail_fast):
+    good_results = set(('pass', 'not_applicable'))
+
+    start = time.time()
+
+    results = {}
+    count = 0
+    for name in dir(module):
+        definition = getattr(module, name)
+        if type(definition) == type and hasattr(definition, 'test') and \
+                (not tests or any(test in name for test in tests)):
+            instance = definition(target)
+            result = instance.run()
+            results.setdefault(result, []).append(name)
+            count += 1
+            if result not in good_results and fail_fast:
+                break
+
+    header("ran %d tests in %.0fs" % (count, time.time() - start), dash=':')
+
+    result = 0
+    for key, value in results.iteritems():
+        print "%d tests returned %s" % (len(value), key)
+        if key not in good_results:
+            result = 1
+            for test in value:
+                print "   ", test
+
+    return result
+
+def add_test_run_options(parser):
+    parser.add_argument("--fail-fast", "-f", action="store_true",
+            help="Exit as soon as any test fails.")
+    parser.add_argument("test", nargs='*',
+            help="Run only tests that are named here.")
+
+def header(title, dash='-'):
+    dashes = dash * (36 - len(title))
+    before = dashes[:len(dashes)/2]
+    after = dashes[len(dashes)/2:]
+    print "%s[ %s ]%s" % (before, title, after)
+
+class BaseTest(object):
+    compiled = {}
+    logs = []
+
+    def __init__(self, target):
+        self.target = target
+        self.server = None
+        self.target_process = None
+        self.binary = None
+        self.start = 0
+
+    def early_applicable(self):
+        """Return a false value if the test has determined it cannot run
+        without ever needing to talk to the target or server."""
+        # pylint: disable=no-self-use
+        return True
+
+    def setup(self):
+        pass
+
+    def compile(self):
+        compile_args = getattr(self, 'compile_args', None)
+        if compile_args:
+            if compile_args not in BaseTest.compiled:
+                try:
+                    # pylint: disable=star-args
+                    BaseTest.compiled[compile_args] = \
+                            self.target.compile(*compile_args)
+                except Exception: # pylint: disable=broad-except
+                    print "exception while compiling in %.2fs" % (
+                            time.time() - self.start)
+                    print "=" * 40
+                    header("Traceback")
+                    traceback.print_exc(file=sys.stdout)
+                    print "/" * 40
+                    return "exception"
+        self.binary = BaseTest.compiled.get(compile_args)
+
+    def classSetup(self):
+        self.compile()
+        self.target_process = self.target.target()
+        self.server = self.target.server()
+        self.logs.append(self.server.logname)
+
+    def classTeardown(self):
+        del self.server
+        del self.target_process
+
+    def run(self):
+        """
+        If compile_args is set, compile a program and set self.binary.
+
+        Call setup().
+
+        Then call test() and return the result, displaying relevant information
+        if an exception is raised.
+        """
+
+        print "Running", type(self).__name__, "...",
+        sys.stdout.flush()
+
+        if not self.early_applicable():
+            print "not_applicable"
+            return "not_applicable"
+
+        self.start = time.time()
+
+        self.classSetup()
+
+        try:
+            self.setup()
+            result = self.test()    # pylint: disable=no-member
+        except TestNotApplicable:
+            result = "not_applicable"
+        except Exception as e: # pylint: disable=broad-except
+            if isinstance(e, TestFailed):
+                result = "fail"
+            else:
+                result = "exception"
+            print "%s in %.2fs" % (result, time.time() - self.start)
+            print "=" * 40
+            if isinstance(e, TestFailed):
+                header("Message")
+                print e.message
+            header("Traceback")
+            traceback.print_exc(file=sys.stdout)
+            for log in self.logs:
+                header(log)
+                print open(log, "r").read()
+            print "/" * 40
+            return result
+
+        finally:
+            self.classTeardown()
+
+        if not result:
+            result = 'pass'
+        print "%s in %.2fs" % (result, time.time() - self.start)
+        return result
+
+class TestFailed(Exception):
+    def __init__(self, message):
+        Exception.__init__(self)
+        self.message = message
+
+class TestNotApplicable(Exception):
+    def __init__(self, message):
+        Exception.__init__(self)
+        self.message = message
+
+def assertEqual(a, b):
+    if a != b:
+        raise TestFailed("%r != %r" % (a, b))
+
+def assertNotEqual(a, b):
+    if a == b:
+        raise TestFailed("%r == %r" % (a, b))
+
+def assertIn(a, b):
+    if a not in b:
+        raise TestFailed("%r not in %r" % (a, b))
+
+def assertNotIn(a, b):
+    if a in b:
+        raise TestFailed("%r in %r" % (a, b))
+
+def assertGreater(a, b):
+    if not a > b:
+        raise TestFailed("%r not greater than %r" % (a, b))
+
+def assertLess(a, b):
+    if not a < b:
+        raise TestFailed("%r not less than %r" % (a, b))
+
+def assertTrue(a):
+    if not a:
+        raise TestFailed("%r is not True" % a)
+
+def assertRegexpMatches(text, regexp):
+    if not re.search(regexp, text):
+        raise TestFailed("can't find %r in %r" % (regexp, text))