debug: Make the 'out of reset' tests actually apply reset
[riscv-tests.git] / debug / gdbserver.py
index 4e8cb5bbbbae3b3196800a893a6bcb02070fd176..5ac0153c469cf566fa3a811491475ca5dd4e9796 100755 (executable)
@@ -2,15 +2,17 @@
 
 import argparse
 import binascii
-import os
 import random
-import re
 import sys
 import tempfile
 import time
-import traceback
+import os
 
+import targets
 import testlib
+from testlib import assertEqual, assertNotEqual, assertIn, assertNotIn
+from testlib import assertGreater, assertRegexpMatches, assertLess
+from testlib import GdbTest
 
 MSTATUS_UIE = 0x00000001
 MSTATUS_SIE = 0x00000002
@@ -34,30 +36,6 @@ MSTATUS64_SD = 0x8000000000000000
 
 # pylint: disable=abstract-method
 
-def gdb(
-        target=None,
-        port=None,
-        binary=None
-        ):
-
-    g = None
-    if parsed.gdb:
-        g = testlib.Gdb(parsed.gdb)
-    else:
-        g = testlib.Gdb()
-
-    if binary:
-        g.command("file %s" % binary)
-    if target:
-        g.command("set arch riscv:rv%d" % target.xlen)
-        g.command("set remotetimeout %d" % target.timeout_sec)
-    if port:
-        g.command("target extended-remote localhost:%d" % port)
-
-    g.p("$priv=3")
-
-    return g
-
 def ihex_line(address, record_type, data):
     assert len(data) < 128
     line = ":%02X%04X%02X" % (len(data), address, record_type)
@@ -86,148 +64,6 @@ def ihex_parse(line):
 def readable_binary_string(s):
     return "".join("%02x" % ord(c) for c in s)
 
-def header(title):
-    dashes = '-' * (36 - len(title))
-    before = dashes[:len(dashes)/2]
-    after = dashes[len(dashes)/2:]
-    print "%s[ %s ]%s" % (before, title, after)
-
-class GdbTest(object):
-    compiled = {}
-
-    def __init__(self, target):
-        self.target = target
-        self.server = None
-        self.binary = None
-        self.gdb = None
-
-    def setUp(self):
-        pass
-
-    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.
-        """
-        self.server = self.target.server()
-
-        print "Running", type(self).__name__, "...",
-        sys.stdout.flush()
-
-        start = time.time()
-
-        compile_args = getattr(self, 'compile_args', None)
-        if compile_args:
-            if compile_args not in GdbTest.compiled:
-                try:
-                    # pylint: disable=star-args
-                    GdbTest.compiled[compile_args] = \
-                            self.target.compile(*compile_args)
-                except Exception: # pylint: disable=broad-except
-                    print "exception while compiling in %.2fs" % (
-                            time.time() - start)
-                    print "=" * 40
-                    header("Traceback")
-                    traceback.print_exc(file=sys.stdout)
-                    print "/" * 40
-                    return "exception"
-        self.binary = GdbTest.compiled.get(compile_args)
-
-        self.gdb = gdb(self.target, self.server.port, self.binary)
-
-        try:
-            self.setUp()
-            result = self.test()    # pylint: disable=no-member
-        except Exception as e: # pylint: disable=broad-except
-            if isinstance(e, TestFailed):
-                result = "fail"
-            else:
-                result = "exception"
-            print "%s in %.2fs" % (result, time.time() - start)
-            print "=" * 40
-            if isinstance(e, TestFailed):
-                header("Message")
-                print e.message
-            header("Traceback")
-            traceback.print_exc(file=sys.stdout)
-            header("gdb.log")
-            print open("gdb.log", "r").read()
-            header(self.server.logname)
-            print open(self.server.logname, "r").read()
-            print "/" * 40
-            return result
-
-        finally:
-            del self.server
-            del self.gdb
-
-        if not result:
-            result = 'pass'
-        print "%s in %.2fs" % (result, time.time() - start)
-        return result
-
-class TestFailed(Exception):
-    def __init__(self, message):
-        Exception.__init__(self)
-        self.message = message
-
-def run_all_tests(target, tests):
-    results = {}
-    module = sys.modules[__name__]
-    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)
-
-    print ":" * 40
-
-    good_results = set(('pass', 'not_applicable'))
-
-    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 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 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))
-
 class SimpleRegisterTest(GdbTest):
     def check_reg(self, name):
         a = random.randrange(1<<self.target.xlen)
@@ -239,11 +75,13 @@ class SimpleRegisterTest(GdbTest):
         self.gdb.stepi()
         assertEqual(self.gdb.p("$%s" % name), b)
 
-    def setUp(self):
+    def setup(self):
         # 0x13 is nop
         self.gdb.command("p *((int*) 0x%x)=0x13" % self.target.ram)
         self.gdb.command("p *((int*) 0x%x)=0x13" % (self.target.ram + 4))
         self.gdb.command("p *((int*) 0x%x)=0x13" % (self.target.ram + 8))
+        self.gdb.command("p *((int*) 0x%x)=0x13" % (self.target.ram + 12))
+        self.gdb.command("p *((int*) 0x%x)=0x13" % (self.target.ram + 16))
         self.gdb.p("$pc=0x%x" % self.target.ram)
 
 class SimpleS0Test(SimpleRegisterTest):
@@ -262,6 +100,25 @@ class SimpleT1Test(SimpleRegisterTest):
     def test(self):
         self.check_reg("t1")
 
+class SimpleF18Test(SimpleRegisterTest):
+    def check_reg(self, name):
+        self.gdb.p_raw("$mstatus=$mstatus | 0x00006000")
+        self.gdb.stepi()
+        a = random.random()
+        b = random.random()
+        self.gdb.p_raw("$%s=%f" % (name, a))
+        self.gdb.stepi()
+        assertLess(abs(float(self.gdb.p_raw("$%s" % name)) - a), .001)
+        self.gdb.p_raw("$%s=%f" % (name, b))
+        self.gdb.stepi()
+        assertLess(abs(float(self.gdb.p_raw("$%s" % name)) - b), .001)
+
+    def early_applicable(self):
+        return self.target.extensionSupported('F')
+
+    def test(self):
+        self.check_reg("f18")
+
 class SimpleMemoryTest(GdbTest):
     def access_test(self, size, data_type):
         assertEqual(self.gdb.p("sizeof(%s)" % data_type), size)
@@ -291,6 +148,29 @@ class MemTest64(SimpleMemoryTest):
     def test(self):
         self.access_test(8, 'long long')
 
+# FIXME: I'm not passing back invalid addresses correctly in read/write memory.
+#class MemTestReadInvalid(SimpleMemoryTest):
+#    def test(self):
+#        # This test relies on 'gdb_report_data_abort enable' being executed in
+#        # the openocd.cfg file.
+#        try:
+#            self.gdb.p("*((int*)0xdeadbeef)")
+#            assert False, "Read should have failed."
+#        except testlib.CannotAccess as e:
+#            assertEqual(e.address, 0xdeadbeef)
+#        self.gdb.p("*((int*)0x%x)" % self.target.ram)
+#
+#class MemTestWriteInvalid(SimpleMemoryTest):
+#    def test(self):
+#        # This test relies on 'gdb_report_data_abort enable' being executed in
+#        # the openocd.cfg file.
+#        try:
+#            self.gdb.p("*((int*)0xdeadbeef)=8675309")
+#            assert False, "Write should have failed."
+#        except testlib.CannotAccess as e:
+#            assertEqual(e.address, 0xdeadbeef)
+#        self.gdb.p("*((int*)0x%x)=6874742" % self.target.ram)
+
 class MemTestBlock(GdbTest):
     def test(self):
         length = 1024
@@ -325,6 +205,9 @@ class MemTestBlock(GdbTest):
 
 class InstantHaltTest(GdbTest):
     def test(self):
+        """Assert that reset is really resetting what it should."""
+        self.gdb.command("monitor reset halt")
+        self.gdb.command("flushregs")
         assertEqual(self.target.reset_vector, self.gdb.p("$pc"))
         # mcycle and minstret have no defined reset value.
         mstatus = self.gdb.p("$mstatus")
@@ -335,6 +218,8 @@ class InstantChangePc(GdbTest):
     def test(self):
         """Change the PC right as we come out of reset."""
         # 0x13 is nop
+        self.gdb.command("monitor reset halt")
+        self.gdb.command("flushregs")
         self.gdb.command("p *((int*) 0x%x)=0x13" % self.target.ram)
         self.gdb.command("p *((int*) 0x%x)=0x13" % (self.target.ram + 4))
         self.gdb.command("p *((int*) 0x%x)=0x13" % (self.target.ram + 8))
@@ -350,7 +235,7 @@ class DebugTest(GdbTest):
     compile_args = ("programs/debug.c", "programs/checksum.c",
             "programs/tiny-malloc.c", "-DDEFINE_MALLOC", "-DDEFINE_FREE")
 
-    def setUp(self):
+    def setup(self):
         self.gdb.load()
         self.gdb.b("_exit")
 
@@ -360,6 +245,16 @@ class DebugTest(GdbTest):
         assertIn("_exit", output)
         assertEqual(self.gdb.p("status"), expected_result)
 
+class DebugCompareSections(DebugTest):
+    def test(self):
+        output = self.gdb.command("compare-sections")
+        matched = 0
+        for line in output.splitlines():
+            if line.startswith("Section"):
+                assert line.endswith("matched.")
+                matched += 1
+        assertGreater(matched, 1)
+
 class DebugFunctionCall(DebugTest):
     def test(self):
         self.gdb.b("main:start")
@@ -385,7 +280,7 @@ class DebugTurbostep(DebugTest):
         last_pc = None
         advances = 0
         jumps = 0
-        for _ in range(100):
+        for _ in range(10):
             self.gdb.stepi()
             pc = self.gdb.p("$pc")
             assertNotEqual(last_pc, pc)
@@ -396,8 +291,8 @@ class DebugTurbostep(DebugTest):
             last_pc = pc
         # Some basic sanity that we're not running between breakpoints or
         # something.
-        assertGreater(jumps, 10)
-        assertGreater(advances, 50)
+        assertGreater(jumps, 1)
+        assertGreater(advances, 5)
 
 class DebugExit(DebugTest):
     def test(self):
@@ -473,7 +368,6 @@ class Registers(DebugTest):
         # Try both forms to test gdb.
         for cmd in ("info all-registers", "info registers all"):
             output = self.gdb.command(cmd)
-            assertNotIn("Could not", output)
             for reg in ('zero', 'ra', 'sp', 'gp', 'tp'):
                 assertIn(reg, output)
 
@@ -503,31 +397,97 @@ class UserInterrupt(DebugTest):
         self.gdb.c()
         self.gdb.p("i=123")
         self.gdb.c(wait=False)
-        time.sleep(0.1)
+        time.sleep(0.5)
         output = self.gdb.interrupt()
         assert "main" in output
         assertGreater(self.gdb.p("j"), 10)
         self.gdb.p("i=0")
         self.exit()
 
+class MulticoreTest(GdbTest):
+    compile_args = ("programs/infinite_loop.S", )
+
+    def setup(self):
+        self.gdb.load()
+        self.gdb.b("main")
+        self.gdb.b("main_end")
+        self.gdb.command("set non-stop on")
+        self.gdb.c()
+
+    def test(self):
+        threads = self.gdb.threads()
+        if len(threads) < 2:
+            return 'not_applicable'
+        # Run through the entire loop.
+        for t in threads:
+            self.gdb.thread(t)
+            self.gdb.p("$pc=_start")
+        # Run to main
+        for t in threads:
+            self.gdb.thread(t)
+            self.gdb.c()
+        for t in self.gdb.threads():
+            assertIn("main", t.frame)
+        # Run to end
+        for t in threads:
+            self.gdb.thread(t)
+            self.gdb.c()
+        hart_ids = []
+        for t in self.gdb.threads():
+            assertIn("main_end", t.frame)
+            # Check register values.
+            self.gdb.thread(t)
+            hart_id = self.gdb.p("$x1")
+            assertNotIn(hart_id, hart_ids)
+            hart_ids.append(hart_id)
+            for n in range(2, 32):
+                value = self.gdb.p("$x%d" % n)
+                assertEqual(value, hart_ids[-1] + n - 1)
+
+        # Confirmed that we read different register values for different harts.
+        # Write a new value to x1, and run through the add sequence again.
+
+        # This part isn't working right, because gdb doesn't resume Thread 2
+        # when asked. I don't know the root cause for that, but up to this
+        # point the test is still useful.
+
+#        for t in threads:
+#            self.gdb.thread(t)
+#            self.gdb.p("$x1=0x%x" % (int(t.id) + 0x800))
+#            self.gdb.p("$pc=main_post_csrr")
+#        for t in threads:
+#            self.gdb.thread(t)
+#            self.gdb.c()
+#        for t in self.gdb.threads():
+#            assertIn("main_end", t.frame)
+#            # Check register values.
+#            self.gdb.thread(t)
+#            for n in range(1, 32):
+#                value = self.gdb.p("$x%d" % n)
+#                assertEqual(value, int(t.id) + 0x800 + n - 1)
+
 class StepTest(GdbTest):
     compile_args = ("programs/step.S", )
 
-    def setUp(self):
+    def setup(self):
         self.gdb.load()
         self.gdb.b("main")
         self.gdb.c()
 
     def test(self):
         main_address = self.gdb.p("$pc")
-        for expected in (4, 8, 0xc, 0x10, 0x18, 0x1c, 0x28, 0x20, 0x2c, 0x2c):
+        if self.target.extensionSupported("c"):
+            sequence = (4, 8, 0xc, 0xe, 0x14, 0x18, 0x22, 0x1c, 0x24, 0x24)
+        else:
+            sequence = (4, 8, 0xc, 0x10, 0x18, 0x1c, 0x28, 0x20, 0x2c, 0x2c)
+        for expected in sequence:
             self.gdb.stepi()
             pc = self.gdb.p("$pc")
-            assertEqual("%x" % pc, "%x" % (expected + main_address))
+            assertEqual("%x" % (pc - main_address), "%x" % expected)
 
 class TriggerTest(GdbTest):
     compile_args = ("programs/trigger.S", )
-    def setUp(self):
+    def setup(self):
         self.gdb.load()
         self.gdb.b("_exit")
         self.gdb.b("main")
@@ -547,14 +507,15 @@ class TriggerExecuteInstant(TriggerTest):
         self.gdb.c()
         assertEqual(self.gdb.p("$pc"), main_address+4)
 
-class TriggerLoadAddress(TriggerTest):
-    def test(self):
-        self.gdb.command("rwatch *((&data)+1)")
-        output = self.gdb.c()
-        assertIn("read_loop", output)
-        assertEqual(self.gdb.p("$a0"),
-                self.gdb.p("(&data)+1"))
-        self.exit()
+# FIXME: Triggers aren't quite working yet
+#class TriggerLoadAddress(TriggerTest):
+#    def test(self):
+#        self.gdb.command("rwatch *((&data)+1)")
+#        output = self.gdb.c()
+#        assertIn("read_loop", output)
+#        assertEqual(self.gdb.p("$a0"),
+#                self.gdb.p("(&data)+1"))
+#        self.exit()
 
 class TriggerLoadAddressInstant(TriggerTest):
     """Test a load address breakpoint on the first instruction executed out of
@@ -569,14 +530,15 @@ class TriggerLoadAddressInstant(TriggerTest):
         assertIn(self.gdb.p("$pc"), [read_loop, read_loop + 4])
         assertEqual(self.gdb.p("$a0"), self.gdb.p("&data"))
 
-class TriggerStoreAddress(TriggerTest):
-    def test(self):
-        self.gdb.command("watch *((&data)+3)")
-        output = self.gdb.c()
-        assertIn("write_loop", output)
-        assertEqual(self.gdb.p("$a0"),
-                self.gdb.p("(&data)+3"))
-        self.exit()
+# FIXME: Triggers aren't quite working yet
+#class TriggerStoreAddress(TriggerTest):
+#    def test(self):
+#        self.gdb.command("watch *((&data)+3)")
+#        output = self.gdb.c()
+#        assertIn("write_loop", output)
+#        assertEqual(self.gdb.p("$a0"),
+#                self.gdb.p("(&data)+3"))
+#        self.exit()
 
 class TriggerStoreAddressInstant(TriggerTest):
     def test(self):
@@ -592,21 +554,51 @@ class TriggerStoreAddressInstant(TriggerTest):
         assertEqual(self.gdb.p("$a0"), self.gdb.p("&data"))
 
 class TriggerDmode(TriggerTest):
+    def check_triggers(self, tdata1_lsbs, tdata2):
+        dmode = 1 << (self.target.xlen-5)
+
+        triggers = []
+
+        if self.target.xlen == 32:
+            xlen_type = 'int'
+        elif self.target.xlen == 64:
+            xlen_type = 'long long'
+        else:
+            raise NotImplementedError
+
+        dmode_count = 0
+        i = 0
+        for i in range(16):
+            tdata1 = self.gdb.p("((%s *)&data)[%d]" % (xlen_type, 2*i))
+            if tdata1 == 0:
+                break
+            tdata2 = self.gdb.p("((%s *)&data)[%d]" % (xlen_type, 2*i+1))
+
+            if tdata1 & dmode:
+                dmode_count += 1
+            else:
+                assertEqual(tdata1 & 0xffff, tdata1_lsbs)
+                assertEqual(tdata2, tdata2)
+
+        assertGreater(i, 1)
+        assertEqual(dmode_count, 1)
+
+        return triggers
+
     def test(self):
-        return 'not_applicable'
-        # pylint: disable=unreachable
-        # Temporarily not applicable until spike is fixed to match the spec
-        # change.
-        self.gdb.command("hbreak handle_trap")
-        self.gdb.p("$pc=write_valid")
+        self.gdb.command("hbreak write_load_trigger")
+        self.gdb.b("clear_triggers")
+        self.gdb.p("$pc=write_store_trigger")
+        output = self.gdb.c()
+        assertIn("write_load_trigger", output)
+        self.check_triggers((1<<6) | (1<<1), 0xdeadbee0)
         output = self.gdb.c()
-        assertIn("handle_trap", output)
-        assertIn("mcause=2", output)
-        assertIn("mepc=%d" % self.gdb.p("&write_invalid_illegal"), output)
+        assertIn("clear_triggers", output)
+        self.check_triggers((1<<6) | (1<<0), 0xfeedac00)
 
 class RegsTest(GdbTest):
     compile_args = ("programs/regs.S", )
-    def setUp(self):
+    def setup(self):
         self.gdb.load()
         self.gdb.b("main")
         self.gdb.b("handle_trap")
@@ -641,8 +633,8 @@ class WriteCsrs(RegsTest):
         self.gdb.stepi()
         assertEqual(self.gdb.p("$mscratch"), 123)
 
-        self.gdb.command("p $pc=write_regs")
-        self.gdb.command("p $a0=data")
+        self.gdb.p("$pc=write_regs")
+        self.gdb.p("$x1=data")
         self.gdb.command("b all_done")
         self.gdb.command("c")
 
@@ -651,260 +643,133 @@ class WriteCsrs(RegsTest):
         assertEqual(123, self.gdb.p("$csr832"))
 
 class DownloadTest(GdbTest):
-    def setUp(self):
-        length = min(2**20, self.target.ram_size - 2048)
-        download_c = tempfile.NamedTemporaryFile(prefix="download_",
-                suffix=".c")
-        download_c.write("#include <stdint.h>\n")
-        download_c.write(
+    def setup(self):
+        # pylint: disable=attribute-defined-outside-init
+        length = min(2**10, self.target.ram_size - 2048)
+        self.download_c = tempfile.NamedTemporaryFile(prefix="download_",
+                suffix=".c", delete=False)
+        self.download_c.write("#include <stdint.h>\n")
+        self.download_c.write(
                 "unsigned int crc32a(uint8_t *message, unsigned int size);\n")
-        download_c.write("uint32_t length = %d;\n" % length)
-        download_c.write("uint8_t d[%d] = {\n" % length)
+        self.download_c.write("uint32_t length = %d;\n" % length)
+        self.download_c.write("uint8_t d[%d] = {\n" % length)
         self.crc = 0
+        assert length % 16 == 0
         for i in range(length / 16):
-            download_c.write("  /* 0x%04x */ " % (i * 16))
+            self.download_c.write("  /* 0x%04x */ " % (i * 16))
             for _ in range(16):
                 value = random.randrange(1<<8)
-                download_c.write("%d, " % value)
+                self.download_c.write("0x%02x, " % value)
                 self.crc = binascii.crc32("%c" % value, self.crc)
-            download_c.write("\n")
-        download_c.write("};\n")
-        download_c.write("uint8_t *data = &d[0];\n")
-        download_c.write("uint32_t main() { return crc32a(data, length); }\n")
-        download_c.flush()
+            self.download_c.write("\n")
+        self.download_c.write("};\n")
+        self.download_c.write("uint8_t *data = &d[0];\n")
+        self.download_c.write(
+                "uint32_t main() { return crc32a(data, length); }\n")
+        self.download_c.flush()
 
         if self.crc < 0:
             self.crc += 2**32
 
-        self.binary = self.target.compile(download_c.name,
+        self.binary = self.target.compile(self.download_c.name,
                 "programs/checksum.c")
         self.gdb.command("file %s" % self.binary)
 
     def test(self):
         self.gdb.load()
         self.gdb.command("b _exit")
-        self.gdb.c()
+        self.gdb.c(timeout=60)
         assertEqual(self.gdb.p("status"), self.crc)
-
-class MprvTest(GdbTest):
-    compile_args = ("programs/mprv.S", )
-    def setUp(self):
-        self.gdb.load()
-
-    def test(self):
-        """Test that the debugger can access memory when MPRV is set."""
-        self.gdb.c(wait=False)
-        time.sleep(0.5)
-        self.gdb.interrupt()
-        output = self.gdb.command("p/x *(int*)(((char*)&data)-0x80000000)")
-        assertIn("0xbead", output)
-
-class PrivTest(GdbTest):
-    compile_args = ("programs/priv.S", )
-    def setUp(self):
-        self.gdb.load()
-
-        misa = self.gdb.p("$misa")
-        self.supported = set()
-        if misa & (1<<20):
-            self.supported.add(0)
-        if misa & (1<<18):
-            self.supported.add(1)
-        if misa & (1<<7):
-            self.supported.add(2)
-        self.supported.add(3)
-
-class PrivRw(PrivTest):
-    def test(self):
-        """Test reading/writing priv."""
-        for privilege in range(4):
-            self.gdb.p("$priv=%d" % privilege)
-            self.gdb.stepi()
-            actual = self.gdb.p("$priv")
-            assertIn(actual, self.supported)
-            if privilege in self.supported:
-                assertEqual(actual, privilege)
-
-class PrivChange(PrivTest):
-    def test(self):
-        """Test that the core's privilege level actually changes."""
-
-        if 0 not in self.supported:
-            return 'not_applicable'
-
-        self.gdb.b("main")
-        self.gdb.c()
-
-        # Machine mode
-        self.gdb.p("$priv=3")
-        main_address = self.gdb.p("$pc")
-        self.gdb.stepi()
-        assertEqual("%x" % self.gdb.p("$pc"), "%x" % (main_address+4))
-
-        # User mode
-        self.gdb.p("$priv=0")
-        self.gdb.stepi()
-        # Should have taken an exception, so be nowhere near main.
-        pc = self.gdb.p("$pc")
-        assertTrue(pc < main_address or pc > main_address + 0x100)
-
-class Target(object):
-    name = "name"
-    xlen = 0
-    directory = None
-    timeout_sec = 2
-    temporary_files = []
-    temporary_binary = None
-
-    def server(self):
-        raise NotImplementedError
-
-    def compile(self, *sources):
-        binary_name = "%s_%s-%d" % (
-                self.name,
-                os.path.basename(os.path.splitext(sources[0])[0]),
-                self.xlen)
-        if parsed.isolate:
-            self.temporary_binary = tempfile.NamedTemporaryFile(
-                    prefix=binary_name + "_")
-            binary_name = self.temporary_binary.name
-            Target.temporary_files.append(self.temporary_binary)
-        testlib.compile(sources +
-                ("programs/entry.S", "programs/init.c",
-                    "-I", "../env",
-                    "-T", "targets/%s/link.lds" % (self.directory or self.name),
-                    "-nostartfiles",
-                    "-mcmodel=medany",
-                    "-o", binary_name),
-                xlen=self.xlen)
-        return binary_name
-
-class SpikeTarget(Target):
-    directory = "spike"
-    ram = 0x80010000
-    ram_size = 5 * 1024 * 1024
-    instruction_hardware_breakpoint_count = 4
-    reset_vector = 0x1000
-
-class Spike64Target(SpikeTarget):
-    name = "spike64"
-    xlen = 64
-
-    def server(self):
-        return testlib.Spike(parsed.cmd, halted=True)
-
-class Spike32Target(SpikeTarget):
-    name = "spike32"
-    xlen = 32
-
-    def server(self):
-        return testlib.Spike(parsed.cmd, halted=True, xlen=32)
-
-class FreedomE300Target(Target):
-    name = "freedom-e300"
-    xlen = 32
-    ram = 0x80000000
-    ram_size = 16 * 1024
-    instruction_hardware_breakpoint_count = 2
-
-    def server(self):
-        return testlib.Openocd(cmd=parsed.cmd,
-                config="targets/%s/openocd.cfg" % self.name)
-
-class FreedomE300SimTarget(Target):
-    name = "freedom-e300-sim"
-    xlen = 32
-    timeout_sec = 240
-    ram = 0x80000000
-    ram_size = 256 * 1024 * 1024
-    instruction_hardware_breakpoint_count = 2
-
-    def server(self):
-        sim = testlib.VcsSim(simv=parsed.run, debug=False)
-        openocd = testlib.Openocd(cmd=parsed.cmd,
-                            config="targets/%s/openocd.cfg" % self.name,
-                            otherProcess=sim)
-        time.sleep(20)
-        return openocd
-
-class FreedomU500Target(Target):
-    name = "freedom-u500"
-    xlen = 64
-    ram = 0x80000000
-    ram_size = 16 * 1024
-    instruction_hardware_breakpoint_count = 2
-
-    def server(self):
-        return testlib.Openocd(cmd=parsed.cmd,
-                config="targets/%s/openocd.cfg" % self.name)
-
-class FreedomU500SimTarget(Target):
-    name = "freedom-u500-sim"
-    xlen = 64
-    timeout_sec = 240
-    ram = 0x80000000
-    ram_size = 256 * 1024 * 1024
-    instruction_hardware_breakpoint_count = 2
-
-    def server(self):
-        sim = testlib.VcsSim(simv=parsed.run, debug=False)
-        openocd = testlib.Openocd(cmd=parsed.cmd,
-                            config="targets/%s/openocd.cfg" % self.name,
-                            otherProcess=sim)
-        time.sleep(20)
-        return openocd
-
-targets = [
-        Spike32Target,
-        Spike64Target,
-        FreedomE300Target,
-        FreedomU500Target,
-        FreedomE300SimTarget,
-        FreedomU500SimTarget]
+        os.unlink(self.download_c.name)
+
+# FIXME: PRIV isn't implemented in the current OpenOCD
+#class MprvTest(GdbTest):
+#    compile_args = ("programs/mprv.S", )
+#    def setup(self):
+#        self.gdb.load()
+#
+#    def test(self):
+#        """Test that the debugger can access memory when MPRV is set."""
+#        self.gdb.c(wait=False)
+#        time.sleep(0.5)
+#        self.gdb.interrupt()
+#        output = self.gdb.command("p/x *(int*)(((char*)&data)-0x80000000)")
+#        assertIn("0xbead", output)
+#
+#class PrivTest(GdbTest):
+#    compile_args = ("programs/priv.S", )
+#    def setup(self):
+#        # pylint: disable=attribute-defined-outside-init
+#        self.gdb.load()
+#
+#        misa = self.target.misa
+#        self.supported = set()
+#        if misa & (1<<20):
+#            self.supported.add(0)
+#        if misa & (1<<18):
+#            self.supported.add(1)
+#        if misa & (1<<7):
+#            self.supported.add(2)
+#        self.supported.add(3)
+#
+#class PrivRw(PrivTest):
+#    def test(self):
+#        """Test reading/writing priv."""
+#        for privilege in range(4):
+#            self.gdb.p("$priv=%d" % privilege)
+#            self.gdb.stepi()
+#            actual = self.gdb.p("$priv")
+#            assertIn(actual, self.supported)
+#            if privilege in self.supported:
+#                assertEqual(actual, privilege)
+#
+#class PrivChange(PrivTest):
+#    def test(self):
+#        """Test that the core's privilege level actually changes."""
+#
+#        if 0 not in self.supported:
+#            return 'not_applicable'
+#
+#        self.gdb.b("main")
+#        self.gdb.c()
+#
+#        # Machine mode
+#        self.gdb.p("$priv=3")
+#        main_address = self.gdb.p("$pc")
+#        self.gdb.stepi()
+#        assertEqual("%x" % self.gdb.p("$pc"), "%x" % (main_address+4))
+#
+#        # User mode
+#        self.gdb.p("$priv=0")
+#        self.gdb.stepi()
+#        # Should have taken an exception, so be nowhere near main.
+#        pc = self.gdb.p("$pc")
+#        assertTrue(pc < main_address or pc > main_address + 0x100)
 
 parsed = None
 def main():
     parser = argparse.ArgumentParser(
+            description="Test that gdb can talk to a RISC-V target.",
             epilog="""
             Example command line from the real world:
             Run all RegsTest cases against a physical FPGA, with custom openocd command:
-            ./gdbserver.py --freedom-e300 --cmd "$HOME/SiFive/openocd/src/openocd -s $HOME/SiFive/openocd/tcl -d" RegsTest
+            ./gdbserver.py --freedom-e300 --server_cmd "$HOME/SiFive/openocd/src/openocd -s $HOME/SiFive/openocd/tcl -d" Simple
             """)
-    group = parser.add_mutually_exclusive_group(required=True)
-    for t in targets:
-        group.add_argument("--%s" % t.name, action="store_const", const=t,
-                dest="target")
-    parser.add_argument("--run",
-            help="The command to use to start the actual target (e.g. "
-            "simulation)")
-    parser.add_argument("--cmd",
-            help="The command to use to start the debug server.")
-    parser.add_argument("--gdb",
-            help="The command to use to start gdb.")
-
-    xlen_group = parser.add_mutually_exclusive_group()
-    xlen_group.add_argument("--32", action="store_const", const=32, dest="xlen",
-            help="Force the target to be 32-bit.")
-    xlen_group.add_argument("--64", action="store_const", const=64, dest="xlen",
-            help="Force the target to be 64-bit.")
-
-    parser.add_argument("--isolate", action="store_true",
-            help="Try to run in such a way that multiple instances can run at "
-            "the same time. This may make it harder to debug a failure if it "
-            "does occur.")
-
-    parser.add_argument("test", nargs='*',
-            help="Run only tests that are named here.")
+    targets.add_target_options(parser)
+
+    testlib.add_test_run_options(parser)
 
     # TODO: remove global
     global parsed   # pylint: disable=global-statement
     parsed = parser.parse_args()
+    target = targets.target(parsed)
 
-    target = parsed.target()
     if parsed.xlen:
         target.xlen = parsed.xlen
 
-    return run_all_tests(target, parsed.test)
+    module = sys.modules[__name__]
+
+    return testlib.run_all_tests(module, target, parsed)
 
 # TROUBLESHOOTING TIPS
 # If a particular test fails, run just that one test, eg.: