Fix cut and paste bug in test_change_pc
[riscv-tests.git] / debug / gdbserver.py
index 61d4330bd7aecd9f0eddf086eefcc253016089de..5f39db1f253a3c23d8448a27a11eb5fcbe8cc435 100755 (executable)
@@ -10,11 +10,74 @@ import time
 import random
 import binascii
 
+def ihex_line(address, record_type, data):
+    assert len(data) < 128
+    line = ":%02X%04X%02X" % (len(data), address, record_type)
+    check = len(data)
+    check += address % 256
+    check += address >> 8
+    check += record_type
+    for char in data:
+        value = ord(char)
+        check += value
+        line += "%02X" % value
+    line += "%02X\n" % ((256-check)%256)
+    return line
+
+def ihex_parse(line):
+    assert line.startswith(":")
+    line = line[1:]
+    data_len = int(line[:2], 16)
+    address = int(line[2:6], 16)
+    record_type = int(line[6:8], 16)
+    data = ""
+    for i in range(data_len):
+        data += "%c" % int(line[8+2*i:10+2*i], 16)
+    return record_type, address, data
+
 class DeleteServer(unittest.TestCase):
     def tearDown(self):
         del self.server
 
-class MemoryTest(DeleteServer):
+class SimpleRegisterTest(DeleteServer):
+    def setUp(self):
+        self.server = target.server()
+        self.gdb = testlib.Gdb()
+        self.gdb.command("target extended-remote localhost:%d" % self.server.port)
+
+        # 0x13 is nop
+        self.gdb.command("p *((int*) 0x%x)=0x13" % target.ram)
+        self.gdb.command("p *((int*) 0x%x)=0x13" % (target.ram + 4))
+        self.gdb.command("p *((int*) 0x%x)=0x13" % (target.ram + 8))
+        self.gdb.p("$pc=0x%x" % target.ram)
+
+    def check_reg(self, name):
+        a = random.randrange(1<<target.xlen)
+        b = random.randrange(1<<target.xlen)
+        self.gdb.p("$%s=0x%x" % (name, a))
+        self.gdb.stepi()
+        self.assertEqual(self.gdb.p("$%s" % name), a)
+        self.gdb.p("$%s=0x%x" % (name, b))
+        self.gdb.stepi()
+        self.assertEqual(self.gdb.p("$%s" % name), b)
+
+    def test_s0(self):
+        # S0 is saved/restored in DSCRATCH
+        self.check_reg("s0")
+
+    def test_s1(self):
+        # S1 is saved/restored in Debug RAM
+        self.check_reg("s1")
+
+    def test_t0(self):
+        # T0 is not saved/restored at all
+        self.check_reg("t2")
+
+    def test_t2(self):
+        # T2 is not saved/restored at all
+        self.check_reg("t2")
+
+class SimpleMemoryTest(DeleteServer):
     def setUp(self):
         self.server = target.server()
         self.gdb = testlib.Gdb()
@@ -40,6 +103,33 @@ class MemoryTest(DeleteServer):
     def test_64(self):
         self.access_test(8, 'long long')
 
+    def test_block(self):
+        length = 1024
+        line_length = 16
+        fd = file("write.ihex", "w")
+        data = ""
+        for i in range(length / line_length):
+            line_data = "".join(["%c" % random.randrange(256) for _ in range(line_length)])
+            data += line_data
+            fd.write(ihex_line(i * line_length, 0, line_data))
+        fd.close()
+
+        self.gdb.command("restore write.ihex 0x%x" % target.ram)
+        for offset in range(0, length, 19*4) + [length-4]:
+            value = self.gdb.p("*((long*)0x%x)" % (target.ram + offset))
+            written = ord(data[offset]) | \
+                    (ord(data[offset+1]) << 8) | \
+                    (ord(data[offset+2]) << 16) | \
+                    (ord(data[offset+3]) << 24)
+            self.assertEqual(value, written)
+
+        self.gdb.command("dump ihex memory read.ihex 0x%x 0x%x" % (target.ram,
+            target.ram + length))
+        for line in file("read.ihex"):
+            record_type, address, line_data = ihex_parse(line)
+            if (record_type == 0):
+                self.assertEqual(line_data, data[address:address+len(line_data)])
+
 class InstantHaltTest(DeleteServer):
     def setUp(self):
         self.server = target.server()
@@ -50,7 +140,7 @@ class InstantHaltTest(DeleteServer):
         self.assertEqual(0x1000, self.gdb.p("$pc"))
         # For some reason instret resets to 0.
         self.assertLess(self.gdb.p("$instret"), 8)
-        self.gdb.command("stepi")
+        self.gdb.stepi()
         self.assertNotEqual(0x1000, self.gdb.p("$pc"))
 
     def test_change_pc(self):
@@ -60,10 +150,10 @@ class InstantHaltTest(DeleteServer):
         self.gdb.command("p *((int*) 0x%x)=0x13" % (target.ram + 4))
         self.gdb.command("p *((int*) 0x%x)=0x13" % (target.ram + 8))
         self.gdb.p("$pc=0x%x" % target.ram)
-        self.gdb.command("stepi")
-        self.assertEqual((target.ram + 4), self.gdb.p("$pc"))
-        self.gdb.command("stepi")
+        self.gdb.stepi()
         self.assertEqual((target.ram + 4), self.gdb.p("$pc"))
+        self.gdb.stepi()
+        self.assertEqual((target.ram + 8), self.gdb.p("$pc"))
 
 class DebugTest(DeleteServer):
     def setUp(self):
@@ -78,15 +168,17 @@ class DebugTest(DeleteServer):
     def exit(self):
         output = self.gdb.c()
         self.assertIn("Breakpoint", output)
-        self.assertIn("_exit", output)
-        self.assertEqual(self.gdb.p("status"), 0xc86455d4)
+        #TODO self.assertIn("_exit", output)
+        #TODO self.assertEqual(self.gdb.p("status"), 0xc86455d4)
+        # Use a0 until gdb can resolve "status"
+        self.assertEqual(self.gdb.p("$a0") & 0xffffffff, 0xc86455d4)
 
     def test_turbostep(self):
         """Single step a bunch of times."""
         self.gdb.command("p i=0");
         last_pc = None
         for _ in range(100):
-            self.gdb.command("stepi")
+            self.gdb.stepi()
             pc = self.gdb.command("p $pc")
             self.assertNotEqual(last_pc, pc)
             last_pc = pc
@@ -99,7 +191,9 @@ class DebugTest(DeleteServer):
         # The breakpoint should be hit exactly 2 times.
         for i in range(2):
             output = self.gdb.c()
+            self.gdb.p("$pc")
             self.assertIn("Breakpoint ", output)
+            #TODO self.assertIn("rot13 ", output)
         self.exit()
 
     def test_registers(self):
@@ -129,7 +223,7 @@ class DebugTest(DeleteServer):
         #    instret = self.gdb.p("$instret")
         #    self.assertNotEqual(instret, last_instret)
         #    last_instret = instret
-        #    self.gdb.command("stepi")
+        #    self.gdb.stepi()
 
         self.exit()
 
@@ -137,11 +231,11 @@ class DebugTest(DeleteServer):
         """Sending gdb ^C while the program is running should cause it to halt."""
         self.gdb.b("main:start")
         self.gdb.c()
-        self.gdb.command("p i=123");
+        self.gdb.p("i=123");
         self.gdb.c(wait=False)
         time.sleep(0.1)
         output = self.gdb.interrupt()
-        assert "main" in output
+        #TODO: assert "main" in output
         self.assertGreater(self.gdb.p("j"), 10)
         self.gdb.p("i=0");
         self.exit()
@@ -153,23 +247,18 @@ class RegsTest(DeleteServer):
         self.gdb = testlib.Gdb()
         self.gdb.command("file %s" % self.binary)
         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
-        self.gdb.command("load")
+        self.gdb.load()
         self.gdb.b("main")
         self.gdb.b("handle_trap")
         self.gdb.c()
 
     def test_write_gprs(self):
-        # Note a0 is missing from this list since it's used to hold the
-        # address.
-        regs = ("ra", "sp", "gp", "tp", "t0", "t1", "t2", "fp", "s1",
-                "a1", "a2", "a3", "a4", "a5", "a6", "a7", "s2", "s3", "s4",
-                "s5", "s6", "s7", "s8", "s9", "s10", "s11", "t3", "t4", "t5",
-                "t6")
+        regs = [("x%d" % n) for n in range(2, 32)]
 
         self.gdb.p("$pc=write_regs")
         for i, r in enumerate(regs):
             self.gdb.command("p $%s=%d" % (r, (0xdeadbeef<<i)+17))
-        self.gdb.command("p $a0=data")
+        self.gdb.command("p $x1=data")
         self.gdb.command("b all_done")
         output = self.gdb.c()
         self.assertIn("Breakpoint ", output)
@@ -179,7 +268,7 @@ class RegsTest(DeleteServer):
         self.gdb.command("info registers")
         for n in range(len(regs)):
             self.assertEqual(self.gdb.x("data+%d" % (8*n), 'g'),
-                    (0xdeadbeef<<n)+17)
+                    ((0xdeadbeef<<n)+17) & ((1<<target.xlen)-1))
 
     def test_write_csrs(self):
         # As much a test of gdb as of the simulator.
@@ -252,6 +341,8 @@ class MprvTest(DeleteServer):
         self.assertIn("0xbead", output)
 
 class Target(object):
+    directory = None
+
     def server(self):
         raise NotImplementedError
 
@@ -259,11 +350,11 @@ class Target(object):
         return testlib.compile(sources +
                 ("programs/entry.S", "programs/init.c",
                     "-I", "../env",
-                    "-T", "targets/%s/link.lds" % self.name,
+                    "-T", "targets/%s/link.lds" % (self.directory or self.name),
                     "-nostartfiles",
                     "-mcmodel=medany"), xlen=self.xlen)
 
-class SpikeTarget(Target):
+class Spike64Target(Target):
     name = "spike"
     xlen = 64
     ram = 0x80010000
@@ -271,6 +362,15 @@ class SpikeTarget(Target):
     def server(self):
         return testlib.Spike(parsed.cmd, halted=True)
 
+class Spike32Target(Target):
+    name = "spike32"
+    directory = "spike"
+    xlen = 32
+    ram = 0x80010000
+
+    def server(self):
+        return testlib.Spike(parsed.cmd, halted=True, xlen=32)
+
 class MicroSemiTarget(Target):
     name = "m2gl_m2s"
     xlen = 32
@@ -281,12 +381,18 @@ class MicroSemiTarget(Target):
                 config="targets/%s/openocd.cfg" % self.name)
 
 targets = [
-        SpikeTarget,
+        Spike32Target,
+        Spike64Target,
         MicroSemiTarget
         ]
 
 def main():
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(
+            epilog="""
+            Example command line from the real world:
+            Run all RegsTest cases against a MicroSemi m2gl_m2s board, with custom openocd command:
+            ./gdbserver.py --m2gl_m2s --cmd "$HOME/SiFive/openocd/src/openocd -s $HOME/SiFive/openocd/tcl -d" -- -vf RegsTest
+            """)
     group = parser.add_mutually_exclusive_group(required=True)
     for t in targets:
         group.add_argument("--%s" % t.name, action="store_const", const=t,