aboutsummaryrefslogtreecommitdiff
path: root/tests/gdbserver.py
blob: f16a3cc623b219b3cead07ff77815d3046d58cae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
#!/usr/bin/python

import os
import testlib
import unittest
import tempfile
import time
import random
import binascii

class DeleteSpike(unittest.TestCase):
    def tearDown(self):
        del self.spike

class InstantHaltTest(DeleteSpike):
    def setUp(self):
        self.binary = testlib.compile("debug.c")
        self.spike = testlib.Spike(self.binary, halted=True)
        self.gdb = testlib.Gdb()
        self.gdb.command("file %s" % self.binary)
        self.gdb.command("target extended-remote localhost:%d" % self.spike.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.command("stepi")
        self.assertNotEqual(0x1000, self.gdb.p("$pc"))

    def test_change_pc(self):
        """Change the PC right as we come out of reset."""
        # 0x13 is nop
        self.gdb.command("p *((int*) 0x80000000)=0x13")
        self.gdb.command("p *((int*) 0x80000004)=0x13")
        self.gdb.command("p *((int*) 0x80000008)=0x13")
        self.gdb.command("p $pc=0x80000000")
        self.gdb.command("stepi")
        self.assertEqual(0x80000004, self.gdb.p("$pc"))
        self.gdb.command("stepi")
        self.assertEqual(0x80000008, self.gdb.p("$pc"))

class DebugTest(DeleteSpike):
    def setUp(self):
        self.binary = testlib.compile("debug.c")
        self.spike = testlib.Spike(self.binary, halted=False)
        self.gdb = testlib.Gdb()
        self.gdb.command("file %s" % self.binary)
        self.gdb.command("target extended-remote localhost:%d" % self.spike.port)

    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")
            pc = self.gdb.command("p $pc")
            self.assertNotEqual(last_pc, pc)
            last_pc = pc

    def test_exit(self):
        self.gdb.command("p i=0");
        output = self.gdb.command("c")
        self.assertIn("Continuing", output)
        self.assertIn("Remote connection closed", output)

    def test_breakpoint(self):
        self.gdb.command("p i=0");
        self.gdb.command("b print_row")
        # The breakpoint should be hit exactly 10 times.
        for i in range(10):
            output = self.gdb.command("c")
            self.assertIn("Continuing", output)
            self.assertIn("length=%d" % i, output)
            self.assertIn("Breakpoint 1", output)
        output = self.gdb.command("c")
        self.assertIn("Continuing", output)
        self.assertIn("Remote connection closed", output)

    def test_registers(self):
        self.gdb.command("p i=0");
        # Try both forms to test gdb.
        for cmd in ("info all-registers", "info registers all"):
            output = self.gdb.command(cmd)
            self.assertNotIn("Could not", output)
            for reg in ('zero', 'ra', 'sp', 'gp', 'tp'):
                self.assertIn(reg, output)
        # mcpuid is one of the few registers that should have the high bit set
        # (for rv64).
        # Leave this commented out until gdb and spike agree on the encoding of
        # mcpuid (which is going to be renamed to misa in any case).
        #self.assertRegexpMatches(output, ".*mcpuid *0x80")

        # The instret register should always be changing.
        last_instret = None
        for _ in range(5):
            instret = self.gdb.p("$instret")
            self.assertNotEqual(instret, last_instret)
            last_instret = instret
            self.gdb.command("stepi")

    def test_interrupt(self):
        """Sending gdb ^C while the program is running should cause it to halt."""
        self.gdb.c(wait=False)
        time.sleep(0.1)
        self.gdb.interrupt()
        self.gdb.command("p i=123");
        self.gdb.c(wait=False)
        time.sleep(0.1)
        self.gdb.interrupt()
        self.gdb.command("p i=0");
        output = self.gdb.c()
        self.assertIn("Continuing", output)
        self.assertIn("Remote connection closed", output)

class RegsTest(DeleteSpike):
    def setUp(self):
        self.binary = testlib.compile("regs.s")
        self.spike = testlib.Spike(self.binary, halted=False)
        self.gdb = testlib.Gdb()
        self.gdb.command("file %s" % self.binary)
        self.gdb.command("target extended-remote localhost:%d" % self.spike.port)

    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")

        self.gdb.command("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("b all_done")
        output = self.gdb.command("c")
        self.assertIn("Breakpoint 1", output)

        # Just to get this data in the log.
        self.gdb.command("x/30gx data")
        self.gdb.command("info registers")
        for n in range(len(regs)):
            self.assertEqual(self.gdb.x("data+%d" % (8*n), 'g'),
                    (0xdeadbeef<<n)+17)

    def test_write_csrs(self):
        # As much a test of gdb as of the simulator.
        self.gdb.p("$mscratch=0")
        self.gdb.stepi()
        self.assertEqual(self.gdb.p("$mscratch"), 0)
        self.gdb.p("$mscratch=123")
        self.gdb.stepi()
        self.assertEqual(self.gdb.p("$mscratch"), 123)

        self.gdb.command("p $fflags=9")
        self.gdb.command("p $pc=write_regs")
        self.gdb.command("p $a0=data")
        self.gdb.command("b all_done")
        self.gdb.command("c")

        self.assertEqual(9, self.gdb.p("$fflags"))
        self.assertEqual(9, self.gdb.p("$x1"))
        self.assertEqual(9, self.gdb.p("$csr1"))

class DownloadTest(DeleteSpike):
    def setUp(self):
        length = 2**20
        fd = file("data.c", "w")
        fd.write("#include <stdint.h>\n")
        fd.write("uint32_t length = %d;\n" % length)
        fd.write("uint8_t d[%d] = {\n" % length)
        self.crc = 0
        for i in range(length / 16):
            fd.write("  /* 0x%04x */ " % (i * 16));
            for _ in range(16):
                value = random.randrange(1<<8)
                fd.write("%d, " % value)
                self.crc = binascii.crc32("%c" % value, self.crc)
            fd.write("\n");
        fd.write("};\n");
        fd.write("uint8_t *data = &d[0];\n");
        fd.close()

        self.binary = testlib.compile("checksum.c", "data.c", "start.S",
                "-mcmodel=medany",
                "-T", "standalone.lds",
                "-nostartfiles"
                )
        self.spike = testlib.Spike(None, halted=True)
        self.gdb = testlib.Gdb()
        self.gdb.command("file %s" % self.binary)
        self.gdb.command("target extended-remote localhost:%d" % self.spike.port)

    def test_download(self):
        output = self.gdb.command("load")
        self.assertNotIn("failed", output)
        self.assertIn("Transfer rate", output)
        self.gdb.command("b done")
        self.gdb.c()
        result = self.gdb.p("$a0")
        self.assertEqual(self.crc, result)

class MprvTest(DeleteSpike):
    def setUp(self):
        self.binary = testlib.compile("mprv.S", "-T", "standalone.lds",
                "-nostartfiles")
        self.spike = testlib.Spike(None, halted=True)
        self.gdb = testlib.Gdb()
        self.gdb.command("file %s" % self.binary)
        self.gdb.command("target extended-remote localhost:%d" % self.spike.port)
        self.gdb.command("load")

    def test_mprv(self):
        """Test that the debugger can access memory when MPRV is set."""
        self.gdb.c(wait=False)
        self.gdb.interrupt()
        output = self.gdb.command("p/x *(int*)(((char*)&data)-0x80000000)")
        self.assertIn("0xbead", output)

if __name__ == '__main__':
    # TROUBLESHOOTING TIPS
    # If a particular test fails, run just that one test, eg.:
    # ./tests/gdbserver.py MprvTest.test_mprv
    # Then inspect gdb.log and spike.log to see what happened in more detail.
    unittest.main()