Fix test_instant_halt.
[riscv-tests.git] / debug / gdbserver.py
index 87692abe0eb4d2a389aef28c04cf4aaf90aeddb9..6b7ac030b3f78239ff5ed324aa253036cbe1b25f 100755 (executable)
@@ -10,6 +10,26 @@ import time
 import random
 import binascii
 
+MSTATUS_UIE = 0x00000001
+MSTATUS_SIE = 0x00000002
+MSTATUS_HIE = 0x00000004
+MSTATUS_MIE = 0x00000008
+MSTATUS_UPIE = 0x00000010
+MSTATUS_SPIE = 0x00000020
+MSTATUS_HPIE = 0x00000040
+MSTATUS_MPIE = 0x00000080
+MSTATUS_SPP = 0x00000100
+MSTATUS_HPP = 0x00000600
+MSTATUS_MPP = 0x00001800
+MSTATUS_FS = 0x00006000
+MSTATUS_XS = 0x00018000
+MSTATUS_MPRV = 0x00020000
+MSTATUS_PUM = 0x00040000
+MSTATUS_MXR = 0x00080000
+MSTATUS_VM = 0x1F000000
+MSTATUS32_SD = 0x80000000
+MSTATUS64_SD = 0x8000000000000000
+
 def ihex_line(address, record_type, data):
     assert len(data) < 128
     line = ":%02X%04X%02X" % (len(data), address, record_type)
@@ -43,6 +63,10 @@ class SimpleRegisterTest(DeleteServer):
     def setUp(self):
         self.server = target.server()
         self.gdb = testlib.Gdb()
+        # For now gdb has to be told what the architecture is when it's not
+        # given an ELF file.
+        self.gdb.command("set arch riscv:rv%d" % target.xlen)
+
         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
 
         # 0x13 is nop
@@ -81,9 +105,12 @@ class SimpleMemoryTest(DeleteServer):
     def setUp(self):
         self.server = target.server()
         self.gdb = testlib.Gdb()
+        self.gdb.command("set arch riscv:rv%d" % target.xlen)
         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
 
     def access_test(self, size, data_type):
+        self.assertEqual(self.gdb.p("sizeof(%s)" % data_type),
+                size)
         a = 0x86753095555aaaa & ((1<<(size*8))-1)
         b = 0xdeadbeef12345678 & ((1<<(size*8))-1)
         self.gdb.p("*((%s*)0x%x) = 0x%x" % (data_type, target.ram, a))
@@ -98,7 +125,7 @@ class SimpleMemoryTest(DeleteServer):
         self.access_test(2, 'short')
 
     def test_32(self):
-        self.access_test(4, 'long')
+        self.access_test(4, 'int')
 
     def test_64(self):
         self.access_test(8, 'long long')
@@ -116,7 +143,7 @@ class SimpleMemoryTest(DeleteServer):
 
         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))
+            value = self.gdb.p("*((int*)0x%x)" % (target.ram + offset))
             written = ord(data[offset]) | \
                     (ord(data[offset+1]) << 8) | \
                     (ord(data[offset+2]) << 16) | \
@@ -134,14 +161,15 @@ class InstantHaltTest(DeleteServer):
     def setUp(self):
         self.server = target.server()
         self.gdb = testlib.Gdb()
+        self.gdb.command("set arch riscv:rv%d" % target.xlen)
         self.gdb.command("target extended-remote localhost:%d" % self.server.port)
 
     def test_instant_halt(self):
-        self.assertEqual(0x1000, self.gdb.p("$pc"))
-        # For some reason instret resets to 0.
-        self.assertLess(self.gdb.p("$instret"), 8)
-        self.gdb.stepi()
-        self.assertNotEqual(0x1000, self.gdb.p("$pc"))
+        self.assertEqual(target.reset_vector, self.gdb.p("$pc"))
+        # mcycle and minstret have no defined reset value.
+        mstatus = self.gdb.p("$mstatus")
+        self.assertEqual(mstatus & (MSTATUS_MIE | MSTATUS_MPRV |
+            MSTATUS_VM), 0)
 
     def test_change_pc(self):
         """Change the PC right as we come out of reset."""
@@ -157,7 +185,11 @@ class InstantHaltTest(DeleteServer):
 
 class DebugTest(DeleteServer):
     def setUp(self):
-        self.binary = target.compile("programs/debug.c", "programs/checksum.c")
+        # Include malloc so that gdb can make function calls. I suspect this
+        # malloc will silently blow through the memory set aside for it, so be
+        # careful.
+        self.binary = target.compile("programs/debug.c", "programs/checksum.c",
+                "programs/tiny-malloc.c", "-DDEFINE_MALLOC", "-DDEFINE_FREE")
         self.server = target.server()
         self.gdb = testlib.Gdb()
         self.gdb.command("file %s" % self.binary)
@@ -165,27 +197,58 @@ class DebugTest(DeleteServer):
         self.gdb.load()
         self.gdb.b("_exit")
 
-    def exit(self):
+    def exit(self, expected_result = 0xc86455d4):
         output = self.gdb.c()
         self.assertIn("Breakpoint", output)
-        #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)
+        self.assertIn("_exit", output)
+        self.assertEqual(self.gdb.p("status"), expected_result)
+
+    def test_function_call(self):
+        self.gdb.b("main:start")
+        self.gdb.c()
+        text = "Howdy, Earth!"
+        gdb_length = self.gdb.p('strlen("%s")' % text)
+        self.assertEqual(gdb_length, len(text))
+        self.exit()
+
+    def test_change_string(self):
+        text = "This little piggy went to the market."
+        self.gdb.b("main:start")
+        self.gdb.c()
+        self.gdb.p('fox = "%s"' % text)
+        self.exit(0x43b497b8)
 
     def test_turbostep(self):
         """Single step a bunch of times."""
         self.gdb.command("p i=0");
         last_pc = None
+        advances = 0
+        jumps = 0
         for _ in range(100):
             self.gdb.stepi()
-            pc = self.gdb.command("p $pc")
+            pc = self.gdb.p("$pc")
             self.assertNotEqual(last_pc, pc)
+            if (last_pc and pc > last_pc and pc - last_pc <= 4):
+                advances += 1
+            else:
+                jumps += 1
             last_pc = pc
+        # Some basic sanity that we're not running between breakpoints or
+        # something.
+        self.assertGreater(jumps, 10)
+        self.assertGreater(advances, 50)
 
     def test_exit(self):
         self.exit()
 
+    def test_symbols(self):
+        self.gdb.b("main")
+        self.gdb.b("rot13")
+        output = self.gdb.c()
+        self.assertIn(", main ", output)
+        output = self.gdb.c()
+        self.assertIn(", rot13 ", output)
+
     def test_breakpoint(self):
         self.gdb.b("rot13")
         # The breakpoint should be hit exactly 2 times.
@@ -196,7 +259,10 @@ class DebugTest(DeleteServer):
             #TODO self.assertIn("rot13 ", output)
         self.exit()
 
-    def test_hwbp(self):
+    def test_hwbp_1(self):
+        if target.instruction_hardware_breakpoint_count < 1:
+            return
+
         self.gdb.hbreak("rot13")
         # The breakpoint should be hit exactly 2 times.
         for i in range(2):
@@ -206,12 +272,29 @@ class DebugTest(DeleteServer):
             #TODO self.assertIn("rot13 ", output)
         self.exit()
 
+    def test_hwbp_2(self):
+        if target.instruction_hardware_breakpoint_count < 2:
+            return
+
+        self.gdb.hbreak("main")
+        self.gdb.hbreak("rot13")
+        # We should hit 3 breakpoints.
+        for i in range(3):
+            output = self.gdb.c()
+            self.gdb.p("$pc")
+            self.assertIn("Breakpoint ", output)
+            #TODO self.assertIn("rot13 ", output)
+        self.exit()
+
     def test_too_many_hwbp(self):
         for i in range(30):
             self.gdb.hbreak("*rot13 + %d" % (i * 4))
 
         output = self.gdb.c()
         self.assertIn("Cannot insert hardware breakpoint", output)
+        # Clean up, otherwise the hardware breakpoints stay set and future
+        # tests may fail.
+        self.gdb.command("D")
 
     def test_registers(self):
         # Get to a point in the code where some registers have actually been
@@ -257,6 +340,24 @@ class DebugTest(DeleteServer):
         self.gdb.p("i=0");
         self.exit()
 
+class StepTest(DeleteServer):
+    def setUp(self):
+        self.binary = target.compile("programs/step.S")
+        self.server = target.server()
+        self.gdb = testlib.Gdb()
+        self.gdb.command("file %s" % self.binary)
+        self.gdb.command("target extended-remote localhost:%d" % self.server.port)
+        self.gdb.load()
+        self.gdb.b("main")
+        self.gdb.c()
+
+    def test_step(self):
+        main = self.gdb.p("$pc")
+        for expected in (4, 8, 0xc, 0x10, 0x18, 0x1c, 0x28, 0x20, 0x2c, 0x2c):
+            self.gdb.stepi()
+            pc = self.gdb.p("$pc")
+            self.assertEqual("%x" % pc, "%x" % (expected + main))
+
 class RegsTest(DeleteServer):
     def setUp(self):
         self.binary = target.compile("programs/regs.S")
@@ -307,7 +408,7 @@ class RegsTest(DeleteServer):
 
 class DownloadTest(DeleteServer):
     def setUp(self):
-        length = 2**20
+        length = min(2**20, target.ram_size - 2048)
         fd = file("download.c", "w")
         fd.write("#include <stdint.h>\n")
         fd.write("unsigned int crc32a(uint8_t *message, unsigned int size);\n")
@@ -353,6 +454,7 @@ class MprvTest(DeleteServer):
     def test_mprv(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)")
         self.assertIn("0xbead", output)
@@ -375,6 +477,9 @@ class Spike64Target(Target):
     name = "spike"
     xlen = 64
     ram = 0x80010000
+    ram_size = 5 * 1024 * 1024
+    instruction_hardware_breakpoint_count = 0
+    reset_vector = 0x1000
 
     def server(self):
         return testlib.Spike(parsed.cmd, halted=True)
@@ -384,6 +489,9 @@ class Spike32Target(Target):
     directory = "spike"
     xlen = 32
     ram = 0x80010000
+    ram_size = 5 * 1024 * 1024
+    instruction_hardware_breakpoint_count = 0
+    reset_vector = 0x1000
 
     def server(self):
         return testlib.Spike(parsed.cmd, halted=True, xlen=32)
@@ -392,6 +500,8 @@ class MicroSemiTarget(Target):
     name = "m2gl_m2s"
     xlen = 32
     ram = 0x80000000
+    ram_size = 16 * 1024
+    instruction_hardware_breakpoint_count = 2
 
     def server(self):
         return testlib.Openocd(cmd=parsed.cmd,