Minor tweaks to trigger tests for openocd.
[riscv-tests.git] / debug / testlib.py
index b3f8f66a822f8529973fa5a46b89f4beba2da52c..987d71e511e0c11549c820fc81537d4b39123e47 100644 (file)
@@ -1,22 +1,21 @@
 import os.path
-import pexpect
 import shlex
 import subprocess
-import tempfile
-import testlib
-import unittest
+import time
+
+import pexpect
 
 # Note that gdb comes with its own testsuite. I was unable to figure out how to
 # run that testsuite against the spike simulator.
 
 def find_file(path):
-    for directory in (os.getcwd(), os.path.dirname(testlib.__file__)):
+    for directory in (os.getcwd(), os.path.dirname(__file__)):
         fullpath = os.path.join(directory, path)
         if os.path.exists(fullpath):
             return fullpath
     return None
 
-def compile(args, xlen=32):
+def compile(args, xlen=32): # pylint: disable=redefined-builtin
     cc = os.path.expandvars("$RISCV/bin/riscv%d-unknown-elf-gcc" % xlen)
     cmd = [cc, "-g"]
     for arg in args:
@@ -33,20 +32,23 @@ def unused_port():
     # http://stackoverflow.com/questions/2838244/get-open-tcp-port-in-python/2838309#2838309
     import socket
     s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-    s.bind(("",0))
+    s.bind(("", 0))
     port = s.getsockname()[1]
     s.close()
     return port
 
 class Spike(object):
-    def __init__(self, cmd, binary=None, halted=False, with_gdb=True, timeout=None,
-            xlen=64):
-        """Launch spike. Return tuple of its process and the port it's running on."""
+    logname = "spike.log"
+
+    def __init__(self, cmd, binary=None, halted=False, with_gdb=True,
+            timeout=None, xlen=64):
+        """Launch spike. Return tuple of its process and the port it's running
+        on."""
         if cmd:
             cmd = shlex.split(cmd)
         else:
             cmd = ["spike"]
-        if (xlen == 32):
+        if xlen == 32:
             cmd += ["--isa", "RV32"]
 
         if timeout:
@@ -57,14 +59,15 @@ class Spike(object):
         if with_gdb:
             self.port = unused_port()
             cmd += ['--gdb-port', str(self.port)]
+        cmd.append("-m32")
         cmd.append('pk')
         if binary:
             cmd.append(binary)
-        logfile = open("spike.log", "w")
+        logfile = open(self.logname, "w")
         logfile.write("+ %s\n" % " ".join(cmd))
         logfile.flush()
-        self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=logfile,
-                stderr=logfile)
+        self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE,
+                stdout=logfile, stderr=logfile)
 
     def __del__(self):
         try:
@@ -76,8 +79,47 @@ class Spike(object):
     def wait(self, *args, **kwargs):
         return self.process.wait(*args, **kwargs)
 
+class VcsSim(object):
+    def __init__(self, simv=None, debug=False):
+        if simv:
+            cmd = shlex.split(simv)
+        else:
+            cmd = ["simv"]
+        cmd += ["+jtag_vpi_enable"]
+        if debug:
+            cmd[0] = cmd[0] + "-debug"
+            cmd += ["+vcdplusfile=output/gdbserver.vpd"]
+        logfile = open("simv.log", "w")
+        logfile.write("+ %s\n" % " ".join(cmd))
+        logfile.flush()
+        listenfile = open("simv.log", "r")
+        listenfile.seek(0, 2)
+        self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE,
+                stdout=logfile, stderr=logfile)
+        done = False
+        while not done:
+            line = listenfile.readline()
+            if not line:
+                time.sleep(1)
+            if "Listening on port 5555" in line:
+                done = True
+
+    def __del__(self):
+        try:
+            self.process.kill()
+            self.process.wait()
+        except OSError:
+            pass
+
 class Openocd(object):
-    def __init__(self, cmd=None, config=None, debug=False):
+    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
         if cmd:
             cmd = shlex.split(cmd)
         else:
@@ -86,10 +128,11 @@ class Openocd(object):
             cmd += ["-f", find_file(config)]
         if debug:
             cmd.append("-d")
-        logfile = open("openocd.log", "w")
+        logfile = open(Openocd.logname, "w")
         logfile.write("+ %s\n" % " ".join(cmd))
-        self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=logfile,
-                stderr=logfile)
+        logfile.flush()
+        self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE,
+                stdout=logfile, stderr=logfile)
         # TODO: Pick a random port
         self.port = 3333
 
@@ -104,7 +147,7 @@ class Gdb(object):
     def __init__(self,
             cmd=os.path.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")):
         self.child = pexpect.spawn(cmd)
-        self.child.logfile = file("gdb.log", "w")
+        self.child.logfile = open("gdb.log", "w")
         self.child.logfile.write("+ %s\n" % cmd)
         self.wait()
         self.command("set confirm off")
@@ -115,12 +158,12 @@ class Gdb(object):
 
     def wait(self):
         """Wait for prompt."""
-        self.child.expect("\(gdb\)")
+        self.child.expect(r"\(gdb\)")
 
     def command(self, command, timeout=-1):
         self.child.sendline(command)
         self.child.expect("\n", timeout=timeout)
-        self.child.expect("\(gdb\)", timeout=timeout)
+        self.child.expect(r"\(gdb\)", timeout=timeout)
         return self.child.before.strip()
 
     def c(self, wait=True):
@@ -133,8 +176,8 @@ class Gdb(object):
             self.child.expect("Continuing")
 
     def interrupt(self):
-        self.child.send("\003");
-        self.child.expect("\(gdb\)")
+        self.child.send("\003")
+        self.child.expect(r"\(gdb\)", timeout=60)
         return self.child.before.strip()
 
     def x(self, address, size='w'):
@@ -147,6 +190,11 @@ class Gdb(object):
         value = int(output.split('=')[-1].strip(), 0)
         return value
 
+    def p_string(self, obj):
+        output = self.command("p %s" % obj)
+        value = shlex.split(output.split('=')[-1].strip())[1]
+        return value
+
     def stepi(self):
         output = self.command("stepi")
         assert "Cannot" not in output