Remove "import ." notation.
[riscv-tests.git] / debug / testlib.py
index 0902983c88a41a7c03a986ca86dceea776bbef6a..c186a175a5cc9d50a8c26d7c49618fa474dd6e2f 100644 (file)
@@ -1,26 +1,25 @@
 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):
-    """Compile a single .c file into a binary."""
-    dst = os.path.splitext(args[0])[0]
-    cc = os.path.expandvars("$RISCV/bin/riscv64-unknown-elf-gcc")
-    cmd = [cc, "-g", "-O", "-o", dst]
+def compile(args, xlen=32):
+    cc = os.path.expandvars("$RISCV/bin/riscv%d-unknown-elf-gcc" % xlen)
+    cmd = [cc, "-g"]
     for arg in args:
         found = find_file(arg)
         if found:
@@ -30,7 +29,6 @@ def compile(*args):
     cmd = " ".join(cmd)
     result = os.system(cmd)
     assert result == 0, "%r failed" % cmd
-    return dst
 
 def unused_port():
     # http://stackoverflow.com/questions/2838244/get-open-tcp-port-in-python/2838309#2838309
@@ -42,13 +40,19 @@ def unused_port():
     return port
 
 class Spike(object):
-    def __init__(self, binary, halted=False, with_gdb=True, timeout=None):
+    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."""
-        cmd = []
+        if cmd:
+            cmd = shlex.split(cmd)
+        else:
+            cmd = ["spike"]
+        if (xlen == 32):
+            cmd += ["--isa", "RV32"]
+
         if timeout:
-            cmd += ["timeout", str(timeout)]
+            cmd = ["timeout", str(timeout)] + cmd
 
-        cmd += [find_file("spike")]
         if halted:
             cmd.append('-H')
         if with_gdb:
@@ -58,6 +62,8 @@ class Spike(object):
         if binary:
             cmd.append(binary)
         logfile = open("spike.log", "w")
+        logfile.write("+ %s\n" % " ".join(cmd))
+        logfile.flush()
         self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=logfile,
                 stderr=logfile)
 
@@ -71,8 +77,46 @@ 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=True):
+    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:
@@ -82,6 +126,7 @@ class Openocd(object):
         if debug:
             cmd.append("-d")
         logfile = open("openocd.log", "w")
+        logfile.write("+ %s\n" % " ".join(cmd))
         self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=logfile,
                 stderr=logfile)
         # TODO: Pick a random port
@@ -95,11 +140,13 @@ class Openocd(object):
             pass
 
 class Gdb(object):
-    def __init__(self):
-        path = os.path.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")
-        self.child = pexpect.spawn(path)
+    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.write("+ %s\n" % cmd)
         self.wait()
+        self.command("set confirm off")
         self.command("set width 0")
         self.command("set height 0")
         # Force consistency.
@@ -117,7 +164,9 @@ class Gdb(object):
 
     def c(self, wait=True):
         if wait:
-            return self.command("c")
+            output = self.command("c")
+            assert "Continuing" in output
+            return output
         else:
             self.child.sendline("c")
             self.child.expect("Continuing")
@@ -125,6 +174,7 @@ class Gdb(object):
     def interrupt(self):
         self.child.send("\003");
         self.child.expect("\(gdb\)")
+        return self.child.before.strip()
 
     def x(self, address, size='w'):
         output = self.command("x/%s %s" % (size, address))
@@ -132,9 +182,28 @@ class Gdb(object):
         return value
 
     def p(self, obj):
-        output = self.command("p %s" % obj)
-        value = int(output.split('=')[-1].strip())
+        output = self.command("p/x %s" % obj)
+        value = int(output.split('=')[-1].strip(), 0)
         return value
 
     def stepi(self):
-        return self.command("stepi")
+        output = self.command("stepi")
+        assert "Cannot" not in output
+        return output
+
+    def load(self):
+        output = self.command("load", timeout=60)
+        assert "failed" not in  output
+        assert "Transfer rate" in output
+
+    def b(self, location):
+        output = self.command("b %s" % location)
+        assert "not defined" not in output
+        assert "Breakpoint" in output
+        return output
+
+    def hbreak(self, location):
+        output = self.command("hbreak %s" % location)
+        assert "not defined" not in output
+        assert "Hardware assisted breakpoint" in output
+        return output