-#!/usr/bin/python
+#!/usr/bin/env python
-import os
-import sys
import argparse
-import testlib
-import unittest
+import binascii
+import random
+import sys
import tempfile
import time
-import random
-import binascii
+
+import targets
+import testlib
+from testlib import assertEqual, assertNotEqual, assertIn
+from testlib import assertGreater, assertTrue, assertRegexpMatches, assertLess
+
+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
+
+# 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
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
+def readable_binary_string(s):
+ return "".join("%02x" % ord(c) for c in s)
-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)
+class GdbTest(testlib.BaseTest):
+ def __init__(self, target):
+ testlib.BaseTest.__init__(self, target)
+ self.gdb = None
- # 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 classSetup(self):
+ testlib.BaseTest.classSetup(self)
+ self.logs.append("gdb.log")
+ self.gdb = gdb(self.target, self.server.port, self.binary)
+ def classTeardown(self):
+ del self.gdb
+ testlib.BaseTest.classTeardown(self)
+
+class SimpleRegisterTest(GdbTest):
def check_reg(self, name):
- a = random.randrange(1<<target.xlen)
- b = random.randrange(1<<target.xlen)
+ a = random.randrange(1<<self.target.xlen)
+ b = random.randrange(1<<self.target.xlen)
self.gdb.p("$%s=0x%x" % (name, a))
self.gdb.stepi()
- self.assertEqual(self.gdb.p("$%s" % name), a)
+ 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)
+ assertEqual(self.gdb.p("$%s" % name), b)
+
+ 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.p("$pc=0x%x" % self.target.ram)
- def test_s0(self):
- # S0 is saved/restored in DSCRATCH
+class SimpleS0Test(SimpleRegisterTest):
+ def test(self):
self.check_reg("s0")
- def test_s1(self):
- # S1 is saved/restored in Debug RAM
+class SimpleS1Test(SimpleRegisterTest):
+ def test(self):
self.check_reg("s1")
- def test_t0(self):
- # T0 is not saved/restored at all
- self.check_reg("t2")
+class SimpleT0Test(SimpleRegisterTest):
+ def test(self):
+ self.check_reg("t0")
- def test_t2(self):
- # T2 is not saved/restored at all
- self.check_reg("t2")
+class SimpleT1Test(SimpleRegisterTest):
+ def test(self):
+ self.check_reg("t1")
-class SimpleMemoryTest(DeleteServer):
- def setUp(self):
- self.server = target.server()
- self.gdb = testlib.Gdb()
- self.gdb.command("target extended-remote localhost:%d" % self.server.port)
+class SimpleF18Test(SimpleRegisterTest):
+ def check_reg(self, name):
+ 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 test(self):
+ misa = self.gdb.p("$misa")
+ if not misa & (1<<(ord('F')-ord('A'))):
+ return 'not_applicable'
+ self.check_reg("f18")
+
+class SimpleMemoryTest(GdbTest):
def access_test(self, size, data_type):
+ 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))
- self.gdb.p("*((%s*)0x%x) = 0x%x" % (data_type, target.ram + size, b))
- self.assertEqual(self.gdb.p("*((%s*)0x%x)" % (data_type, target.ram)), a)
- self.assertEqual(self.gdb.p("*((%s*)0x%x)" % (data_type, target.ram + size)), b)
-
- def test_8(self):
+ self.gdb.p("*((%s*)0x%x) = 0x%x" % (data_type, self.target.ram, a))
+ self.gdb.p("*((%s*)0x%x) = 0x%x" % (data_type, self.target.ram + size,
+ b))
+ assertEqual(self.gdb.p("*((%s*)0x%x)" % (data_type, self.target.ram)),
+ a)
+ assertEqual(self.gdb.p("*((%s*)0x%x)" % (
+ data_type, self.target.ram + size)), b)
+
+class MemTest8(SimpleMemoryTest):
+ def test(self):
self.access_test(1, 'char')
- def test_16(self):
+class MemTest16(SimpleMemoryTest):
+ def test(self):
self.access_test(2, 'short')
- def test_32(self):
- self.access_test(4, 'long')
+class MemTest32(SimpleMemoryTest):
+ def test(self):
+ self.access_test(4, 'int')
- def test_64(self):
+class MemTest64(SimpleMemoryTest):
+ def test(self):
self.access_test(8, 'long long')
- def test_block(self):
+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
line_length = 16
- fd = file("write.ihex", "w")
+ a = tempfile.NamedTemporaryFile(suffix=".ihex")
data = ""
for i in range(length / line_length):
- line_data = "".join(["%c" % random.randrange(256) for _ in range(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()
+ a.write(ihex_line(i * line_length, 0, line_data))
+ a.flush()
- self.gdb.command("restore write.ihex 0x%x" % target.ram)
+ self.gdb.command("restore %s 0x%x" % (a.name, self.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)" % (self.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)
+ 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"):
+ b = tempfile.NamedTemporaryFile(suffix=".ihex")
+ self.gdb.command("dump ihex memory %s 0x%x 0x%x" % (b.name,
+ self.target.ram, self.target.ram + length))
+ for line in b:
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()
- self.gdb = testlib.Gdb()
- 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"))
-
- def test_change_pc(self):
+ if record_type == 0:
+ assertEqual(readable_binary_string(line_data),
+ readable_binary_string(
+ data[address:address+len(line_data)]))
+
+class InstantHaltTest(GdbTest):
+ def test(self):
+ assertEqual(self.target.reset_vector, self.gdb.p("$pc"))
+ # mcycle and minstret have no defined reset value.
+ mstatus = self.gdb.p("$mstatus")
+ assertEqual(mstatus & (MSTATUS_MIE | MSTATUS_MPRV |
+ MSTATUS_VM), 0)
+
+class InstantChangePc(GdbTest):
+ def test(self):
"""Change the PC right as we come out of reset."""
# 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)
+ 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.p("$pc=0x%x" % self.target.ram)
self.gdb.stepi()
- self.assertEqual((target.ram + 4), self.gdb.p("$pc"))
+ assertEqual((self.target.ram + 4), self.gdb.p("$pc"))
self.gdb.stepi()
- self.assertEqual((target.ram + 8), self.gdb.p("$pc"))
+ assertEqual((self.target.ram + 8), self.gdb.p("$pc"))
-class DebugTest(DeleteServer):
- def setUp(self):
- self.binary = target.compile("programs/debug.c", "programs/checksum.c")
- 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)
+class DebugTest(GdbTest):
+ # 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.
+ compile_args = ("programs/debug.c", "programs/checksum.c",
+ "programs/tiny-malloc.c", "-DDEFINE_MALLOC", "-DDEFINE_FREE")
+
+ def setup(self):
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)
+ assertIn("Breakpoint", output)
+ 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")
+ self.gdb.c()
+ assertEqual(self.gdb.p('fib(6)'), 8)
+ assertEqual(self.gdb.p('fib(7)'), 13)
+ self.exit()
+
+class DebugChangeString(DebugTest):
+ def test(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):
+class DebugTurbostep(DebugTest):
+ def test(self):
"""Single step a bunch of times."""
- self.gdb.command("p i=0");
+ self.gdb.b("main:start")
+ self.gdb.c()
+ 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")
- self.assertNotEqual(last_pc, pc)
+ pc = self.gdb.p("$pc")
+ 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.
+ assertGreater(jumps, 10)
+ assertGreater(advances, 50)
- def test_exit(self):
+class DebugExit(DebugTest):
+ def test(self):
self.exit()
- def test_breakpoint(self):
+class DebugSymbols(DebugTest):
+ def test(self):
+ self.gdb.b("main")
+ self.gdb.b("rot13")
+ output = self.gdb.c()
+ assertIn(", main ", output)
+ output = self.gdb.c()
+ assertIn(", rot13 ", output)
+
+class DebugBreakpoint(DebugTest):
+ def test(self):
self.gdb.b("rot13")
# The breakpoint should be hit exactly 2 times.
- for i in range(2):
+ for _ in range(2):
output = self.gdb.c()
self.gdb.p("$pc")
- self.assertIn("Breakpoint ", output)
- #TODO self.assertIn("rot13 ", output)
+ assertIn("Breakpoint ", output)
+ assertIn("rot13 ", output)
self.exit()
- def test_registers(self):
+class Hwbp1(DebugTest):
+ def test(self):
+ if self.target.instruction_hardware_breakpoint_count < 1:
+ return 'not_applicable'
+
+ self.gdb.hbreak("rot13")
+ # The breakpoint should be hit exactly 2 times.
+ for _ in range(2):
+ output = self.gdb.c()
+ self.gdb.p("$pc")
+ assertRegexpMatches(output, r"[bB]reakpoint")
+ assertIn("rot13 ", output)
+ self.exit()
+
+class Hwbp2(DebugTest):
+ def test(self):
+ if self.target.instruction_hardware_breakpoint_count < 2:
+ return 'not_applicable'
+
+ self.gdb.hbreak("main")
+ self.gdb.hbreak("rot13")
+ # We should hit 3 breakpoints.
+ for expected in ("main", "rot13", "rot13"):
+ output = self.gdb.c()
+ self.gdb.p("$pc")
+ assertRegexpMatches(output, r"[bB]reakpoint")
+ assertIn("%s " % expected, output)
+ self.exit()
+
+class TooManyHwbp(DebugTest):
+ def run(self):
+ for i in range(30):
+ self.gdb.hbreak("*rot13 + %d" % (i * 4))
+
+ output = self.gdb.c()
+ assertIn("Cannot insert hardware breakpoint", output)
+ # Clean up, otherwise the hardware breakpoints stay set and future
+ # tests may fail.
+ self.gdb.command("D")
+
+class Registers(DebugTest):
+ def test(self):
# Get to a point in the code where some registers have actually been
# used.
self.gdb.b("rot13")
# 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)
+ assertIn(reg, output)
#TODO
# 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")
+ #assertRegexpMatches(output, ".*mcpuid *0x80")
#TODO:
# The instret register should always be changing.
#last_instret = None
#for _ in range(5):
# instret = self.gdb.p("$instret")
- # self.assertNotEqual(instret, last_instret)
+ # assertNotEqual(instret, last_instret)
# last_instret = instret
# self.gdb.stepi()
self.exit()
- def test_interrupt(self):
- """Sending gdb ^C while the program is running should cause it to halt."""
+class UserInterrupt(DebugTest):
+ def test(self):
+ """Sending gdb ^C while the program is running should cause it to
+ halt."""
self.gdb.b("main:start")
self.gdb.c()
- self.gdb.p("i=123");
+ self.gdb.p("i=123")
self.gdb.c(wait=False)
time.sleep(0.1)
output = self.gdb.interrupt()
- #TODO: assert "main" in output
- self.assertGreater(self.gdb.p("j"), 10)
- self.gdb.p("i=0");
+ assert "main" in output
+ assertGreater(self.gdb.p("j"), 10)
+ self.gdb.p("i=0")
self.exit()
-class RegsTest(DeleteServer):
- def setUp(self):
- self.binary = target.compile("programs/regs.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)
+class StepTest(GdbTest):
+ compile_args = ("programs/step.S", )
+
+ 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):
+ self.gdb.stepi()
+ pc = self.gdb.p("$pc")
+ assertEqual("%x" % pc, "%x" % (expected + main_address))
+
+class TriggerTest(GdbTest):
+ compile_args = ("programs/trigger.S", )
+ def setup(self):
+ self.gdb.load()
+ self.gdb.b("_exit")
+ self.gdb.b("main")
+ self.gdb.c()
+
+ def exit(self):
+ output = self.gdb.c()
+ assertIn("Breakpoint", output)
+ assertIn("_exit", output)
+
+class TriggerExecuteInstant(TriggerTest):
+ """Test an execute breakpoint on the first instruction executed out of
+ debug mode."""
+ def test(self):
+ main_address = self.gdb.p("$pc")
+ self.gdb.command("hbreak *0x%x" % (main_address + 4))
+ 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()
+
+class TriggerLoadAddressInstant(TriggerTest):
+ """Test a load address breakpoint on the first instruction executed out of
+ debug mode."""
+ def test(self):
+ self.gdb.command("b just_before_read_loop")
+ self.gdb.c()
+ read_loop = self.gdb.p("&read_loop")
+ self.gdb.command("rwatch data")
+ self.gdb.c()
+ # Accept hitting the breakpoint before or after the load instruction.
+ 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()
+
+class TriggerStoreAddressInstant(TriggerTest):
+ def test(self):
+ """Test a store address breakpoint on the first instruction executed out
+ of debug mode."""
+ self.gdb.command("b just_before_write_loop")
+ self.gdb.c()
+ write_loop = self.gdb.p("&write_loop")
+ self.gdb.command("watch data")
+ self.gdb.c()
+ # Accept hitting the breakpoint before or after the store instruction.
+ assertIn(self.gdb.p("$pc"), [write_loop, write_loop + 4])
+ 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):
+ 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("clear_triggers", output)
+ self.check_triggers((1<<6) | (1<<0), 0xfeedac00)
+
+class RegsTest(GdbTest):
+ compile_args = ("programs/regs.S", )
+ def setup(self):
self.gdb.load()
self.gdb.b("main")
self.gdb.b("handle_trap")
self.gdb.c()
- def test_write_gprs(self):
+class WriteGprs(RegsTest):
+ def test(self):
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 $x1=data")
+ self.gdb.p("$%s=%d" % (r, (0xdeadbeef<<i)+17))
+ self.gdb.p("$x1=data")
self.gdb.command("b all_done")
output = self.gdb.c()
- self.assertIn("Breakpoint ", output)
+ assertIn("Breakpoint ", 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) & ((1<<target.xlen)-1))
+ assertEqual(self.gdb.x("data+%d" % (8*n), 'g'),
+ ((0xdeadbeef<<n)+17) & ((1<<self.target.xlen)-1))
- def test_write_csrs(self):
+class WriteCsrs(RegsTest):
+ def test(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)
+ assertEqual(self.gdb.p("$mscratch"), 0)
self.gdb.p("$mscratch=123")
self.gdb.stepi()
- self.assertEqual(self.gdb.p("$mscratch"), 123)
+ assertEqual(self.gdb.p("$mscratch"), 123)
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(123, self.gdb.p("$mscratch"))
- self.assertEqual(123, self.gdb.p("$x1"))
- self.assertEqual(123, self.gdb.p("$csr832"))
-
-class DownloadTest(DeleteServer):
- def setUp(self):
- length = 2**20
- fd = file("download.c", "w")
- fd.write("#include <stdint.h>\n")
- fd.write("unsigned int crc32a(uint8_t *message, unsigned int size);\n")
- fd.write("uint32_t length = %d;\n" % length)
- fd.write("uint8_t d[%d] = {\n" % length)
+ assertEqual(123, self.gdb.p("$mscratch"))
+ assertEqual(123, self.gdb.p("$x1"))
+ assertEqual(123, self.gdb.p("$csr832"))
+
+class DownloadTest(GdbTest):
+ def setup(self):
+ # pylint: disable=attribute-defined-outside-init
+ 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(
+ "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.crc = 0
for i in range(length / 16):
- fd.write(" /* 0x%04x */ " % (i * 16));
+ download_c.write(" /* 0x%04x */ " % (i * 16))
for _ in range(16):
value = random.randrange(1<<8)
- fd.write("%d, " % value)
+ download_c.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.write("uint32_t main() { return crc32a(data, length); }\n")
- fd.close()
+ 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()
if self.crc < 0:
self.crc += 2**32
- self.binary = target.compile("download.c", "programs/checksum.c")
- self.server = target.server()
- self.gdb = testlib.Gdb()
+ self.binary = self.target.compile(download_c.name,
+ "programs/checksum.c")
self.gdb.command("file %s" % self.binary)
- self.gdb.command("target extended-remote localhost:%d" % self.server.port)
- def test_download(self):
- output = self.gdb.load()
+ def test(self):
+ self.gdb.load()
self.gdb.command("b _exit")
self.gdb.c()
- self.assertEqual(self.gdb.p("status"), self.crc)
+ assertEqual(self.gdb.p("status"), self.crc)
-class MprvTest(DeleteServer):
- def setUp(self):
- self.binary = target.compile("programs/mprv.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)
+class MprvTest(GdbTest):
+ compile_args = ("programs/mprv.S", )
+ def setup(self):
self.gdb.load()
- def test_mprv(self):
+ 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)")
- self.assertIn("0xbead", output)
-
-class Target(object):
- directory = None
-
- def server(self):
- raise NotImplementedError
-
- def compile(self, *sources):
- return testlib.compile(sources +
- ("programs/entry.S", "programs/init.c",
- "-I", "../env",
- "-T", "targets/%s/link.lds" % (self.directory or self.name),
- "-nostartfiles",
- "-mcmodel=medany"), xlen=self.xlen)
-
-class Spike64Target(Target):
- name = "spike"
- xlen = 64
- ram = 0x80010000
-
- 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
- ram = 0x80000000
-
- def server(self):
- return testlib.Openocd(cmd=parsed.cmd,
- config="targets/%s/openocd.cfg" % self.name)
-
-targets = [
- Spike32Target,
- Spike64Target,
- MicroSemiTarget
- ]
+ 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.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)
+
+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 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
+ 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" 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("--cmd",
- help="The command to use to start the debug server.")
- parser.add_argument("unittest", nargs="*")
- global parsed
+ targets.add_target_options(parser)
+ parser.add_argument("--gdb",
+ help="The command to use to start gdb.")
+
+ testlib.add_test_run_options(parser)
+
+ # TODO: remove global
+ global parsed # pylint: disable=global-statement
parsed = parser.parse_args()
- global target
- target = parsed.target()
- unittest.main(argv=[sys.argv[0]] + parsed.unittest)
+ target = parsed.target(parsed.cmd, parsed.run, parsed.isolate)
+ if parsed.xlen:
+ target.xlen = parsed.xlen
+
+ module = sys.modules[__name__]
+
+ return testlib.run_all_tests(module, target, parsed.test, parsed.fail_fast)
# TROUBLESHOOTING TIPS
# If a particular test fails, run just that one test, eg.:
-# ./tests/gdbserver.py MprvTest.test_mprv
+# ./gdbserver.py MprvTest.test_mprv
# Then inspect gdb.log and spike.log to see what happened in more detail.
if __name__ == '__main__':
projects / riscv-tests.git / blobdiff