14 MSTATUS_UIE
= 0x00000001
15 MSTATUS_SIE
= 0x00000002
16 MSTATUS_HIE
= 0x00000004
17 MSTATUS_MIE
= 0x00000008
18 MSTATUS_UPIE
= 0x00000010
19 MSTATUS_SPIE
= 0x00000020
20 MSTATUS_HPIE
= 0x00000040
21 MSTATUS_MPIE
= 0x00000080
22 MSTATUS_SPP
= 0x00000100
23 MSTATUS_HPP
= 0x00000600
24 MSTATUS_MPP
= 0x00001800
25 MSTATUS_FS
= 0x00006000
26 MSTATUS_XS
= 0x00018000
27 MSTATUS_MPRV
= 0x00020000
28 MSTATUS_PUM
= 0x00040000
29 MSTATUS_MXR
= 0x00080000
30 MSTATUS_VM
= 0x1F000000
31 MSTATUS32_SD
= 0x80000000
32 MSTATUS64_SD
= 0x8000000000000000
36 return testlib
.Gdb(parsed
.gdb
)
40 def ihex_line(address
, record_type
, data
):
41 assert len(data
) < 128
42 line
= ":%02X%04X%02X" % (len(data
), address
, record_type
)
44 check
+= address
% 256
50 line
+= "%02X" % value
51 line
+= "%02X\n" % ((256-check
)%256)
55 assert line
.startswith(":")
57 data_len
= int(line
[:2], 16)
58 address
= int(line
[2:6], 16)
59 record_type
= int(line
[6:8], 16)
61 for i
in range(data_len
):
62 data
+= "%c" % int(line
[8+2*i
:10+2*i
], 16)
63 return record_type
, address
, data
65 class DeleteServer(unittest
.TestCase
):
69 class SimpleRegisterTest(DeleteServer
):
71 self
.server
= target
.server()
73 # For now gdb has to be told what the architecture is when it's not
75 self
.gdb
.command("set arch riscv:rv%d" % target
.xlen
)
76 self
.gdb
.command("set remotetimeout %d" % target
.timeout
)
77 self
.gdb
.command("target extended-remote localhost:%d" % self
.server
.port
)
80 self
.gdb
.command("p *((int*) 0x%x)=0x13" % target
.ram
)
81 self
.gdb
.command("p *((int*) 0x%x)=0x13" % (target
.ram
+ 4))
82 self
.gdb
.command("p *((int*) 0x%x)=0x13" % (target
.ram
+ 8))
83 self
.gdb
.p("$pc=0x%x" % target
.ram
)
85 def check_reg(self
, name
):
86 a
= random
.randrange(1<<target
.xlen
)
87 b
= random
.randrange(1<<target
.xlen
)
88 self
.gdb
.p("$%s=0x%x" % (name
, a
))
90 self
.assertEqual(self
.gdb
.p("$%s" % name
), a
)
91 self
.gdb
.p("$%s=0x%x" % (name
, b
))
93 self
.assertEqual(self
.gdb
.p("$%s" % name
), b
)
96 # S0 is saved/restored in DSCRATCH
100 # S1 is saved/restored in Debug RAM
104 # T0 is not saved/restored at all
108 # T2 is not saved/restored at all
111 class SimpleMemoryTest(DeleteServer
):
113 self
.server
= target
.server()
115 self
.gdb
.command("set arch riscv:rv%d" % target
.xlen
)
116 self
.gdb
.command("set remotetimeout %d" % target
.timeout
)
117 self
.gdb
.command("target extended-remote localhost:%d" % self
.server
.port
)
119 def access_test(self
, size
, data_type
):
120 self
.assertEqual(self
.gdb
.p("sizeof(%s)" % data_type
),
122 a
= 0x86753095555aaaa & ((1<<(size
*8))-1)
123 b
= 0xdeadbeef12345678 & ((1<<(size
*8))-1)
124 self
.gdb
.p("*((%s*)0x%x) = 0x%x" % (data_type
, target
.ram
, a
))
125 self
.gdb
.p("*((%s*)0x%x) = 0x%x" % (data_type
, target
.ram
+ size
, b
))
126 self
.assertEqual(self
.gdb
.p("*((%s*)0x%x)" % (data_type
, target
.ram
)), a
)
127 self
.assertEqual(self
.gdb
.p("*((%s*)0x%x)" % (data_type
, target
.ram
+ size
)), b
)
130 self
.access_test(1, 'char')
133 self
.access_test(2, 'short')
136 self
.access_test(4, 'int')
139 self
.access_test(8, 'long long')
141 def test_block(self
):
144 a
= tempfile
.NamedTemporaryFile(suffix
=".ihex")
146 for i
in range(length
/ line_length
):
147 line_data
= "".join(["%c" % random
.randrange(256) for _
in range(line_length
)])
149 a
.write(ihex_line(i
* line_length
, 0, line_data
))
152 self
.gdb
.command("restore %s 0x%x" % (a
.name
, target
.ram
))
153 for offset
in range(0, length
, 19*4) + [length
-4]:
154 value
= self
.gdb
.p("*((int*)0x%x)" % (target
.ram
+ offset
))
155 written
= ord(data
[offset
]) | \
156 (ord(data
[offset
+1]) << 8) | \
157 (ord(data
[offset
+2]) << 16) | \
158 (ord(data
[offset
+3]) << 24)
159 self
.assertEqual(value
, written
)
161 b
= tempfile
.NamedTemporaryFile(suffix
=".ihex")
162 self
.gdb
.command("dump ihex memory %s 0x%x 0x%x" % (b
.name
, target
.ram
,
163 target
.ram
+ length
))
165 record_type
, address
, line_data
= ihex_parse(line
)
166 if (record_type
== 0):
167 self
.assertEqual(line_data
, data
[address
:address
+len(line_data
)])
169 class InstantHaltTest(DeleteServer
):
171 self
.server
= target
.server()
173 self
.gdb
.command("set arch riscv:rv%d" % target
.xlen
)
174 self
.gdb
.command("set remotetimeout %d" % target
.timeout
)
175 self
.gdb
.command("target extended-remote localhost:%d" % self
.server
.port
)
177 def test_instant_halt(self
):
178 self
.assertEqual(target
.reset_vector
, self
.gdb
.p("$pc"))
179 # mcycle and minstret have no defined reset value.
180 mstatus
= self
.gdb
.p("$mstatus")
181 self
.assertEqual(mstatus
& (MSTATUS_MIE | MSTATUS_MPRV |
184 def test_change_pc(self
):
185 """Change the PC right as we come out of reset."""
187 self
.gdb
.command("p *((int*) 0x%x)=0x13" % target
.ram
)
188 self
.gdb
.command("p *((int*) 0x%x)=0x13" % (target
.ram
+ 4))
189 self
.gdb
.command("p *((int*) 0x%x)=0x13" % (target
.ram
+ 8))
190 self
.gdb
.p("$pc=0x%x" % target
.ram
)
192 self
.assertEqual((target
.ram
+ 4), self
.gdb
.p("$pc"))
194 self
.assertEqual((target
.ram
+ 8), self
.gdb
.p("$pc"))
196 class DebugTest(DeleteServer
):
198 # Include malloc so that gdb can make function calls. I suspect this
199 # malloc will silently blow through the memory set aside for it, so be
201 self
.binary
= target
.compile("programs/debug.c", "programs/checksum.c",
202 "programs/tiny-malloc.c", "-DDEFINE_MALLOC", "-DDEFINE_FREE")
203 self
.server
= target
.server()
205 self
.gdb
.command("file %s" % self
.binary
)
206 self
.gdb
.command("set remotetimeout %d" % target
.timeout
)
207 self
.gdb
.command("target extended-remote localhost:%d" % self
.server
.port
)
211 def exit(self
, expected_result
= 0xc86455d4):
212 output
= self
.gdb
.c()
213 self
.assertIn("Breakpoint", output
)
214 self
.assertIn("_exit", output
)
215 self
.assertEqual(self
.gdb
.p("status"), expected_result
)
217 def test_function_call(self
):
218 self
.gdb
.b("main:start")
220 text
= "Howdy, Earth!"
221 gdb_length
= self
.gdb
.p('strlen("%s")' % text
)
222 self
.assertEqual(gdb_length
, len(text
))
225 def test_change_string(self
):
226 text
= "This little piggy went to the market."
227 self
.gdb
.b("main:start")
229 self
.gdb
.p('fox = "%s"' % text
)
230 self
.exit(0x43b497b8)
232 def test_turbostep(self
):
233 """Single step a bunch of times."""
234 self
.gdb
.command("p i=0");
240 pc
= self
.gdb
.p("$pc")
241 self
.assertNotEqual(last_pc
, pc
)
242 if (last_pc
and pc
> last_pc
and pc
- last_pc
<= 4):
247 # Some basic sanity that we're not running between breakpoints or
249 self
.assertGreater(jumps
, 10)
250 self
.assertGreater(advances
, 50)
255 def test_symbols(self
):
258 output
= self
.gdb
.c()
259 self
.assertIn(", main ", output
)
260 output
= self
.gdb
.c()
261 self
.assertIn(", rot13 ", output
)
263 def test_breakpoint(self
):
265 # The breakpoint should be hit exactly 2 times.
267 output
= self
.gdb
.c()
269 self
.assertIn("Breakpoint ", output
)
270 #TODO self.assertIn("rot13 ", output)
273 def test_hwbp_1(self
):
274 if target
.instruction_hardware_breakpoint_count
< 1:
277 self
.gdb
.hbreak("rot13")
278 # The breakpoint should be hit exactly 2 times.
280 output
= self
.gdb
.c()
282 self
.assertIn("Breakpoint ", output
)
283 #TODO self.assertIn("rot13 ", output)
286 def test_hwbp_2(self
):
287 if target
.instruction_hardware_breakpoint_count
< 2:
290 self
.gdb
.hbreak("main")
291 self
.gdb
.hbreak("rot13")
292 # We should hit 3 breakpoints.
294 output
= self
.gdb
.c()
296 self
.assertIn("Breakpoint ", output
)
297 #TODO self.assertIn("rot13 ", output)
300 def test_too_many_hwbp(self
):
302 self
.gdb
.hbreak("*rot13 + %d" % (i
* 4))
304 output
= self
.gdb
.c()
305 self
.assertIn("Cannot insert hardware breakpoint", output
)
306 # Clean up, otherwise the hardware breakpoints stay set and future
308 self
.gdb
.command("D")
310 def test_registers(self
):
311 # Get to a point in the code where some registers have actually been
316 # Try both forms to test gdb.
317 for cmd
in ("info all-registers", "info registers all"):
318 output
= self
.gdb
.command(cmd
)
319 self
.assertNotIn("Could not", output
)
320 for reg
in ('zero', 'ra', 'sp', 'gp', 'tp'):
321 self
.assertIn(reg
, output
)
324 # mcpuid is one of the few registers that should have the high bit set
326 # Leave this commented out until gdb and spike agree on the encoding of
327 # mcpuid (which is going to be renamed to misa in any case).
328 #self.assertRegexpMatches(output, ".*mcpuid *0x80")
331 # The instret register should always be changing.
334 # instret = self.gdb.p("$instret")
335 # self.assertNotEqual(instret, last_instret)
336 # last_instret = instret
341 def test_interrupt(self
):
342 """Sending gdb ^C while the program is running should cause it to halt."""
343 self
.gdb
.b("main:start")
346 self
.gdb
.c(wait
=False)
348 output
= self
.gdb
.interrupt()
349 #TODO: assert "main" in output
350 self
.assertGreater(self
.gdb
.p("j"), 10)
354 class StepTest(DeleteServer
):
356 self
.binary
= target
.compile("programs/step.S")
357 self
.server
= target
.server()
359 self
.gdb
.command("file %s" % self
.binary
)
360 self
.gdb
.command("set remotetimeout %d" % target
.timeout
)
361 self
.gdb
.command("target extended-remote localhost:%d" % self
.server
.port
)
367 main
= self
.gdb
.p("$pc")
368 for expected
in (4, 8, 0xc, 0x10, 0x18, 0x1c, 0x28, 0x20, 0x2c, 0x2c):
370 pc
= self
.gdb
.p("$pc")
371 self
.assertEqual("%x" % pc
, "%x" % (expected
+ main
))
373 class RegsTest(DeleteServer
):
375 self
.binary
= target
.compile("programs/regs.S")
376 self
.server
= target
.server()
378 self
.gdb
.command("file %s" % self
.binary
)
379 self
.gdb
.command("set remotetimeout %d" % target
.timeout
)
380 self
.gdb
.command("target extended-remote localhost:%d" % self
.server
.port
)
383 self
.gdb
.b("handle_trap")
386 def test_write_gprs(self
):
387 regs
= [("x%d" % n
) for n
in range(2, 32)]
389 self
.gdb
.p("$pc=write_regs")
390 for i
, r
in enumerate(regs
):
391 self
.gdb
.command("p $%s=%d" % (r
, (0xdeadbeef<<i
)+17))
392 self
.gdb
.command("p $x1=data")
393 self
.gdb
.command("b all_done")
394 output
= self
.gdb
.c()
395 self
.assertIn("Breakpoint ", output
)
397 # Just to get this data in the log.
398 self
.gdb
.command("x/30gx data")
399 self
.gdb
.command("info registers")
400 for n
in range(len(regs
)):
401 self
.assertEqual(self
.gdb
.x("data+%d" % (8*n
), 'g'),
402 ((0xdeadbeef<<n
)+17) & ((1<<target
.xlen
)-1))
404 def test_write_csrs(self
):
405 # As much a test of gdb as of the simulator.
406 self
.gdb
.p("$mscratch=0")
408 self
.assertEqual(self
.gdb
.p("$mscratch"), 0)
409 self
.gdb
.p("$mscratch=123")
411 self
.assertEqual(self
.gdb
.p("$mscratch"), 123)
413 self
.gdb
.command("p $pc=write_regs")
414 self
.gdb
.command("p $a0=data")
415 self
.gdb
.command("b all_done")
416 self
.gdb
.command("c")
418 self
.assertEqual(123, self
.gdb
.p("$mscratch"))
419 self
.assertEqual(123, self
.gdb
.p("$x1"))
420 self
.assertEqual(123, self
.gdb
.p("$csr832"))
422 class DownloadTest(DeleteServer
):
424 length
= min(2**20, target
.ram_size
- 2048)
425 download_c
= tempfile
.NamedTemporaryFile(prefix
="download_", suffix
=".c")
426 download_c
.write("#include <stdint.h>\n")
427 download_c
.write("unsigned int crc32a(uint8_t *message, unsigned int size);\n")
428 download_c
.write("uint32_t length = %d;\n" % length
)
429 download_c
.write("uint8_t d[%d] = {\n" % length
)
431 for i
in range(length
/ 16):
432 download_c
.write(" /* 0x%04x */ " % (i
* 16));
434 value
= random
.randrange(1<<8)
435 download_c
.write("%d, " % value
)
436 self
.crc
= binascii
.crc32("%c" % value
, self
.crc
)
437 download_c
.write("\n");
438 download_c
.write("};\n");
439 download_c
.write("uint8_t *data = &d[0];\n");
440 download_c
.write("uint32_t main() { return crc32a(data, length); }\n")
446 self
.binary
= target
.compile(download_c
.name
, "programs/checksum.c")
447 self
.server
= target
.server()
449 self
.gdb
.command("file %s" % self
.binary
)
450 self
.gdb
.command("set remotetimeout %d" % target
.timeout
)
451 self
.gdb
.command("target extended-remote localhost:%d" % self
.server
.port
)
453 def test_download(self
):
454 output
= self
.gdb
.load()
455 self
.gdb
.command("b _exit")
457 self
.assertEqual(self
.gdb
.p("status"), self
.crc
)
459 class MprvTest(DeleteServer
):
461 self
.binary
= target
.compile("programs/mprv.S")
462 self
.server
= target
.server()
464 self
.gdb
.command("file %s" % self
.binary
)
465 self
.gdb
.command("set remotetimeout %d" % target
.timeout
)
466 self
.gdb
.command("target extended-remote localhost:%d" % self
.server
.port
)
470 """Test that the debugger can access memory when MPRV is set."""
471 self
.gdb
.c(wait
=False)
474 output
= self
.gdb
.command("p/x *(int*)(((char*)&data)-0x80000000)")
475 self
.assertIn("0xbead", output
)
477 class PrivTest(DeleteServer
):
479 self
.binary
= target
.compile("programs/priv.S")
480 self
.server
= target
.server()
482 self
.gdb
.command("file %s" % self
.binary
)
483 self
.gdb
.command("set remotetimeout %d" % target
.timeout
)
484 self
.gdb
.command("target extended-remote localhost:%d" % self
.server
.port
)
487 misa
= self
.gdb
.p("$misa")
488 self
.supported
= set()
490 self
.supported
.add(0)
492 self
.supported
.add(1)
494 self
.supported
.add(2)
495 self
.supported
.add(3)
498 """Test reading/writing priv."""
499 for privilege
in range(4):
500 self
.gdb
.p("$priv=%d" % privilege
)
502 actual
= self
.gdb
.p("$priv")
503 self
.assertIn(actual
, self
.supported
)
504 if privilege
in self
.supported
:
505 self
.assertEqual(actual
, privilege
)
507 def test_change(self
):
508 """Test that the core's privilege level actually changes."""
510 if 0 not in self
.supported
:
511 # TODO: return not applicable
518 self
.gdb
.p("$priv=3")
519 main
= self
.gdb
.p("$pc")
521 self
.assertEqual("%x" % self
.gdb
.p("$pc"), "%x" % (main
+4))
524 self
.gdb
.p("$priv=0")
526 # Should have taken an exception, so be nowhere near main.
527 pc
= self
.gdb
.p("$pc")
528 self
.assertTrue(pc
< main
or pc
> main
+ 0x100)
530 class Target(object):
535 raise NotImplementedError
537 def compile(self
, *sources
):
538 binary_name
= "%s_%s" % (
540 os
.path
.basename(os
.path
.splitext(sources
[0])[0]))
542 self
.temporary_binary
= tempfile
.NamedTemporaryFile(
543 prefix
=binary_name
+ "_")
544 binary_name
= self
.temporary_binary
.name
545 testlib
.compile(sources
+
546 ("programs/entry.S", "programs/init.c",
548 "-T", "targets/%s/link.lds" % (self
.directory
or self
.name
),
555 class SpikeTarget(Target
):
558 ram_size
= 5 * 1024 * 1024
559 instruction_hardware_breakpoint_count
= 0
560 reset_vector
= 0x1000
562 class Spike64Target(SpikeTarget
):
567 return testlib
.Spike(parsed
.cmd
, halted
=True)
569 class Spike32Target(SpikeTarget
):
574 return testlib
.Spike(parsed
.cmd
, halted
=True, xlen
=32)
576 class FreedomE300Target(Target
):
577 name
= "freedom-e300"
581 instruction_hardware_breakpoint_count
= 2
584 return testlib
.Openocd(cmd
=parsed
.cmd
,
585 config
="targets/%s/openocd.cfg" % self
.name
)
587 class FreedomE300SimTarget(Target
):
588 name
= "freedom-e300-sim"
592 ram_size
= 256 * 1024 * 1024
593 instruction_hardware_breakpoint_count
= 2
596 sim
= testlib
.VcsSim(simv
=parsed
.run
, debug
=False)
597 x
= testlib
.Openocd(cmd
=parsed
.cmd
,
598 config
="targets/%s/openocd.cfg" % self
.name
,
604 class FreedomU500SimTarget(Target
):
605 name
= "freedom-u500-sim"
609 ram_size
= 256 * 1024 * 1024
610 instruction_hardware_breakpoint_count
= 2
613 sim
= testlib
.VcsSim(simv
=parsed
.run
, debug
=False)
614 x
= testlib
.Openocd(cmd
=parsed
.cmd
,
615 config
="targets/%s/openocd.cfg" % self
.name
,
624 FreedomE300SimTarget
,
625 FreedomU500SimTarget
]
628 parser
= argparse
.ArgumentParser(
630 Example command line from the real world:
631 Run all RegsTest cases against a physical FPGA, with custom openocd command:
632 ./gdbserver.py --freedom-e-300 --cmd "$HOME/SiFive/openocd/src/openocd -s $HOME/SiFive/openocd/tcl -d" -- -vf RegsTest
634 group
= parser
.add_mutually_exclusive_group(required
=True)
636 group
.add_argument("--%s" % t
.name
, action
="store_const", const
=t
,
638 parser
.add_argument("--run",
639 help="The command to use to start the actual target (e.g. simulation)")
640 parser
.add_argument("--cmd",
641 help="The command to use to start the debug server.")
642 parser
.add_argument("--gdb",
643 help="The command to use to start gdb.")
644 parser
.add_argument("--isolate", action
="store_true",
645 help="Try to run in such a way that multiple instances can run at "
646 "the same time. This may make it harder to debug a failure if it "
648 parser
.add_argument("unittest", nargs
="*")
650 parsed
= parser
.parse_args()
653 target
= parsed
.target()
654 unittest
.main(argv
=[sys
.argv
[0]] + parsed
.unittest
)
656 # TROUBLESHOOTING TIPS
657 # If a particular test fails, run just that one test, eg.:
658 # ./tests/gdbserver.py MprvTest.test_mprv
659 # Then inspect gdb.log and spike.log to see what happened in more detail.
661 if __name__
== '__main__':