#!/usr/bin/env python
-import os
-import sys
import argparse
+import binascii
+import random
+import sys
import tempfile
import time
-import random
-import binascii
-import traceback
+import os
+import targets
import testlib
+from testlib import assertEqual, assertNotEqual, assertIn, assertNotIn
+from testlib import assertGreater, assertRegexpMatches, assertLess
+from testlib import GdbTest, GdbSingleHartTest, TestFailed
+from testlib import assertTrue
MSTATUS_UIE = 0x00000001
MSTATUS_SIE = 0x00000002
# 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
line = ":%02X%04X%02X" % (len(data), address, record_type)
def readable_binary_string(s):
return "".join("%02x" % ord(c) for c in s)
-def header(title):
- dashes = '-' * (36 - len(title))
- before = dashes[:len(dashes)/2]
- after = dashes[len(dashes)/2:]
- print "%s[ %s ]%s" % (before, title, after)
-
-class GdbTest(object):
- compiled = {}
-
- def __init__(self, target):
- self.target = target
- self.server = None
- self.binary = None
- self.gdb = None
-
- def setUp(self):
- pass
-
- def run(self):
- """
- If compile_args is set, compile a program and set self.binary.
-
- Call setUp().
-
- Then call test() and return the result, displaying relevant information
- if an exception is raised.
- """
- self.server = self.target.server()
-
- print "Running", type(self).__name__, "...",
- sys.stdout.flush()
-
- start = time.time()
-
- compile_args = getattr(self, 'compile_args', None)
- if compile_args:
- if compile_args not in GdbTest.compiled:
- try:
- # pylint: disable=star-args
- GdbTest.compiled[compile_args] = \
- self.target.compile(*compile_args)
- except Exception: # pylint: disable=broad-except
- print "exception while compiling in %.2fs" % (
- time.time() - start)
- print "=" * 40
- header("Traceback")
- traceback.print_exc(file=sys.stdout)
- print "/" * 40
- return "exception"
- self.binary = GdbTest.compiled.get(compile_args)
-
- self.gdb = gdb(self.target, self.server.port, self.binary)
-
- try:
- self.setUp()
- result = self.test() # pylint: disable=no-member
- except Exception as e: # pylint: disable=broad-except
- if isinstance(e, TestFailed):
- result = "fail"
- else:
- result = "exception"
- print "%s in %.2fs" % (result, time.time() - start)
- print "=" * 40
- if isinstance(e, TestFailed):
- header("Message")
- print e.message
- header("Traceback")
- traceback.print_exc(file=sys.stdout)
- header("gdb.log")
- print open("gdb.log", "r").read()
- header(self.server.logname)
- print open(self.server.logname, "r").read()
- print "/" * 40
- return result
-
- finally:
- del self.server
- del self.gdb
-
- if not result:
- result = 'pass'
- print "%s in %.2fs" % (result, time.time() - start)
- return result
-
-class TestFailed(Exception):
- def __init__(self, message):
- Exception.__init__(self)
- self.message = message
-
-def run_all_tests(target, tests):
- results = {}
- module = sys.modules[__name__]
- for name in dir(module):
- definition = getattr(module, name)
- if type(definition) == type and hasattr(definition, 'test') and \
- (not tests or any(test in name for test in tests)):
- instance = definition(target)
- result = instance.run()
- results.setdefault(result, []).append(name)
-
- print ":" * 40
-
- good_results = set(('pass', 'not_applicable'))
-
- result = 0
- for key, value in results.iteritems():
- print "%d tests returned %s" % (len(value), key)
- if key not in good_results:
- result = 1
- for test in value:
- print " ", test
-
- return result
-
-def assertEqual(a, b):
- if a != b:
- raise TestFailed("%r != %r" % (a, b))
-
-def assertNotEqual(a, b):
- if a == b:
- raise TestFailed("%r == %r" % (a, b))
-
-def assertIn(a, b):
- if a not in b:
- raise TestFailed("%r not in %r" % (a, b))
-
-def assertNotIn(a, b):
- if a in b:
- raise TestFailed("%r in %r" % (a, b))
-
-def assertGreater(a, b):
- if not a > b:
- raise TestFailed("%r not greater than %r" % (a, b))
-
-def assertTrue(a):
- if not a:
- raise TestFailed("%r is not True" % a)
-
class SimpleRegisterTest(GdbTest):
- def check_reg(self, name):
- a = random.randrange(1<<self.target.xlen)
- b = random.randrange(1<<self.target.xlen)
+ def check_reg(self, name, alias):
+ a = random.randrange(1<<self.hart.xlen)
+ b = random.randrange(1<<self.hart.xlen)
self.gdb.p("$%s=0x%x" % (name, a))
+ assertEqual(self.gdb.p("$%s" % alias), a)
self.gdb.stepi()
assertEqual(self.gdb.p("$%s" % name), a)
- self.gdb.p("$%s=0x%x" % (name, b))
+ assertEqual(self.gdb.p("$%s" % alias), a)
+ self.gdb.p("$%s=0x%x" % (alias, b))
+ assertEqual(self.gdb.p("$%s" % name), b)
self.gdb.stepi()
assertEqual(self.gdb.p("$%s" % name), b)
+ assertEqual(self.gdb.p("$%s" % alias), b)
- def setUp(self):
+ 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)
+ self.gdb.command("p *((int*) 0x%x)=0x13" % self.hart.ram)
+ self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 4))
+ self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 8))
+ self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 12))
+ self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 16))
+ self.gdb.p("$pc=0x%x" % self.hart.ram)
class SimpleS0Test(SimpleRegisterTest):
def test(self):
- self.check_reg("s0")
+ self.check_reg("s0", "x8")
class SimpleS1Test(SimpleRegisterTest):
def test(self):
- self.check_reg("s1")
+ self.check_reg("s1", "x9")
class SimpleT0Test(SimpleRegisterTest):
def test(self):
- self.check_reg("t0")
+ self.check_reg("t0", "x5")
class SimpleT1Test(SimpleRegisterTest):
def test(self):
- self.check_reg("t1")
+ self.check_reg("t1", "x6")
+
+class SimpleF18Test(SimpleRegisterTest):
+ def check_reg(self, name, alias):
+ if self.hart.extensionSupported('F'):
+ self.gdb.p_raw("$mstatus=$mstatus | 0x00006000")
+ self.gdb.stepi()
+ a = random.random()
+ b = random.random()
+ self.gdb.p_raw("$%s=%f" % (name, a))
+ assertLess(abs(float(self.gdb.p_raw("$%s" % alias)) - a), .001)
+ self.gdb.stepi()
+ assertLess(abs(float(self.gdb.p_raw("$%s" % name)) - a), .001)
+ assertLess(abs(float(self.gdb.p_raw("$%s" % alias)) - a), .001)
+ self.gdb.p_raw("$%s=%f" % (alias, b))
+ assertLess(abs(float(self.gdb.p_raw("$%s" % name)) - b), .001)
+ self.gdb.stepi()
+ assertLess(abs(float(self.gdb.p_raw("$%s" % name)) - b), .001)
+ assertLess(abs(float(self.gdb.p_raw("$%s" % alias)) - b), .001)
+
+ size = self.gdb.p("sizeof($%s)" % name)
+ if self.hart.extensionSupported('D'):
+ assertEqual(size, 8)
+ else:
+ assertEqual(size, 4)
+ else:
+ output = self.gdb.p_raw("$" + name)
+ assertEqual(output, "void")
+ output = self.gdb.p_raw("$" + alias)
+ assertEqual(output, "void")
+
+ def test(self):
+ self.check_reg("f18", "fs2")
+
+class CustomRegisterTest(SimpleRegisterTest):
+ def early_applicable(self):
+ return self.target.implements_custom_test
+
+ def check_custom(self, magic):
+ regs = {k: v for k, v in self.gdb.info_registers("all").iteritems()
+ if k.startswith("custom")}
+ assertEqual(set(regs.keys()),
+ set(("custom1",
+ "custom12345",
+ "custom12346",
+ "custom12347",
+ "custom12348")))
+ for name, value in regs.iteritems():
+ number = int(name[6:])
+ if number % 2:
+ expect = number + magic
+ assertIn(value, (expect, expect + (1<<32)))
+ else:
+ assertIn("Could not fetch register", value)
+
+ def test(self):
+ self.check_custom(0)
+
+ # Now test writing
+ magic = 6667
+ self.gdb.p("$custom12345=%d" % (12345 + magic))
+ self.gdb.stepi()
+
+ self.check_custom(magic)
+
+class SimpleNoExistTest(GdbTest):
+ def test(self):
+ try:
+ self.gdb.p("$csr2288")
+ assert False, "Reading csr2288 should have failed"
+ except testlib.CouldNotFetch:
+ pass
+ try:
+ self.gdb.p("$csr2288=5")
+ assert False, "Writing csr2288 should have failed"
+ except testlib.CouldNotFetch:
+ pass
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, 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)
+ addrA = self.hart.ram
+ addrB = self.hart.ram + self.hart.ram_size - size
+ self.gdb.p("*((%s*)0x%x) = 0x%x" % (data_type, addrA, a))
+ self.gdb.p("*((%s*)0x%x) = 0x%x" % (data_type, addrB, b))
+ assertEqual(self.gdb.p("*((%s*)0x%x)" % (data_type, addrA)), a)
+ assertEqual(self.gdb.p("*((%s*)0x%x)" % (data_type, addrB)), b)
class MemTest8(SimpleMemoryTest):
def test(self):
def test(self):
self.access_test(8, 'long long')
+# FIXME: I'm not passing back invalid addresses correctly in read/write memory.
+#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.hart.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.hart.ram)
+
class MemTestBlock(GdbTest):
+ length = 1024
+ line_length = 16
+
def test(self):
- length = 1024
- line_length = 16
a = tempfile.NamedTemporaryFile(suffix=".ihex")
data = ""
- for i in range(length / line_length):
+ for i in range(self.length / self.line_length):
line_data = "".join(["%c" % random.randrange(256)
- for _ in range(line_length)])
+ for _ in range(self.line_length)])
data += line_data
- a.write(ihex_line(i * line_length, 0, line_data))
+ a.write(ihex_line(i * self.line_length, 0, line_data))
a.flush()
- 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("*((int*)0x%x)" % (self.target.ram + offset))
+ self.gdb.command("shell cat %s" % a.name)
+ self.gdb.command("restore %s 0x%x" % (a.name, self.hart.ram))
+ increment = 19 * 4
+ for offset in range(0, self.length, increment) + [self.length-4]:
+ value = self.gdb.p("*((int*)0x%x)" % (self.hart.ram + offset))
written = ord(data[offset]) | \
(ord(data[offset+1]) << 8) | \
(ord(data[offset+2]) << 16) | \
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:
+ self.hart.ram, self.hart.ram + self.length))
+ self.gdb.command("shell cat %s" % b.name)
+ for line in b.xreadlines():
record_type, address, line_data = ihex_parse(line)
if record_type == 0:
- assertEqual(readable_binary_string(line_data),
- readable_binary_string(
- data[address:address+len(line_data)]))
+ written_data = data[address:address+len(line_data)]
+ if line_data != written_data:
+ raise TestFailed(
+ "Data mismatch at 0x%x; wrote %s but read %s" % (
+ address, readable_binary_string(written_data),
+ readable_binary_string(line_data)))
class InstantHaltTest(GdbTest):
def test(self):
- assertEqual(self.target.reset_vector, self.gdb.p("$pc"))
+ """Assert that reset is really resetting what it should."""
+ self.gdb.command("monitor reset halt")
+ self.gdb.command("flushregs")
+ threads = self.gdb.threads()
+ pcs = []
+ for t in threads:
+ self.gdb.thread(t)
+ pcs.append(self.gdb.p("$pc"))
+ for pc in pcs:
+ assertIn(pc, self.hart.reset_vectors)
# mcycle and minstret have no defined reset value.
mstatus = self.gdb.p("$mstatus")
assertEqual(mstatus & (MSTATUS_MIE | MSTATUS_MPRV |
def test(self):
"""Change the PC right as we come out of reset."""
# 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)
+ self.gdb.command("monitor reset halt")
+ self.gdb.command("flushregs")
+ self.gdb.command("p *((int*) 0x%x)=0x13" % self.hart.ram)
+ self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 4))
+ self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 8))
+ self.gdb.p("$pc=0x%x" % self.hart.ram)
self.gdb.stepi()
- assertEqual((self.target.ram + 4), self.gdb.p("$pc"))
+ assertEqual((self.hart.ram + 4), self.gdb.p("$pc"))
self.gdb.stepi()
- assertEqual((self.target.ram + 8), self.gdb.p("$pc"))
+ assertEqual((self.hart.ram + 8), self.gdb.p("$pc"))
-class DebugTest(GdbTest):
+class DebugTest(GdbSingleHartTest):
# 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):
+ def setup(self):
self.gdb.load()
self.gdb.b("_exit")
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")
last_pc = None
advances = 0
jumps = 0
- for _ in range(100):
+ for _ in range(10):
self.gdb.stepi()
pc = self.gdb.p("$pc")
assertNotEqual(last_pc, pc)
last_pc = pc
# Some basic sanity that we're not running between breakpoints or
# something.
- assertGreater(jumps, 10)
- assertGreater(advances, 50)
+ assertGreater(jumps, 1)
+ assertGreater(advances, 5)
class DebugExit(DebugTest):
def test(self):
class Hwbp1(DebugTest):
def test(self):
- if self.target.instruction_hardware_breakpoint_count < 1:
+ if self.hart.instruction_hardware_breakpoint_count < 1:
return 'not_applicable'
+ if not self.hart.honors_tdata1_hmode:
+ # Run to main before setting the breakpoint, because startup code
+ # will otherwise clear the trigger that we set.
+ self.gdb.b("main")
+ self.gdb.c()
+
self.gdb.hbreak("rot13")
# The breakpoint should be hit exactly 2 times.
for _ in range(2):
output = self.gdb.c()
self.gdb.p("$pc")
- assertIn("Breakpoint ", output)
+ assertRegexpMatches(output, r"[bB]reakpoint")
assertIn("rot13 ", output)
self.exit()
class Hwbp2(DebugTest):
def test(self):
- if self.target.instruction_hardware_breakpoint_count < 2:
+ if self.hart.instruction_hardware_breakpoint_count < 2:
return 'not_applicable'
self.gdb.hbreak("main")
for expected in ("main", "rot13", "rot13"):
output = self.gdb.c()
self.gdb.p("$pc")
- assertIn("Breakpoint ", output)
+ assertRegexpMatches(output, r"[bB]reakpoint")
assertIn("%s " % expected, output)
self.exit()
class TooManyHwbp(DebugTest):
- def run(self):
+ def test(self):
for i in range(30):
self.gdb.hbreak("*rot13 + %d" % (i * 4))
# Try both forms to test gdb.
for cmd in ("info all-registers", "info registers all"):
output = self.gdb.command(cmd)
- assertNotIn("Could not", output)
for reg in ('zero', 'ra', 'sp', 'gp', 'tp'):
assertIn(reg, output)
+ for line in output.splitlines():
+ assertRegexpMatches(line, r"^\S")
#TODO
# mcpuid is one of the few registers that should have the high bit set
self.gdb.c()
self.gdb.p("i=123")
self.gdb.c(wait=False)
- time.sleep(0.1)
+ time.sleep(2)
output = self.gdb.interrupt()
assert "main" in output
assertGreater(self.gdb.p("j"), 10)
self.gdb.p("i=0")
self.exit()
-class StepTest(GdbTest):
+class InterruptTest(GdbSingleHartTest):
+ compile_args = ("programs/interrupt.c",)
+
+ def early_applicable(self):
+ return self.target.supports_clint_mtime
+
+ def setup(self):
+ self.gdb.load()
+
+ def test(self):
+ self.gdb.b("main")
+ output = self.gdb.c()
+ assertIn(" main ", output)
+ self.gdb.b("trap_entry")
+ output = self.gdb.c()
+ assertIn(" trap_entry ", output)
+ assertEqual(self.gdb.p("$mip") & 0x80, 0x80)
+ assertEqual(self.gdb.p("interrupt_count"), 0)
+ # You'd expect local to still be 0, but it looks like spike doesn't
+ # jump to the interrupt handler immediately after the write to
+ # mtimecmp.
+ assertLess(self.gdb.p("local"), 1000)
+ self.gdb.command("delete breakpoints")
+ for _ in range(10):
+ self.gdb.c(wait=False)
+ time.sleep(2)
+ self.gdb.interrupt()
+ interrupt_count = self.gdb.p("interrupt_count")
+ local = self.gdb.p("local")
+ if interrupt_count > 1000 and \
+ local > 1000:
+ return
+
+ assertGreater(interrupt_count, 1000)
+ assertGreater(local, 1000)
+
+ def postMortem(self):
+ GdbSingleHartTest.postMortem(self)
+ self.gdb.p("*((long long*) 0x200bff8)")
+ self.gdb.p("*((long long*) 0x2004000)")
+ self.gdb.p("interrupt_count")
+ self.gdb.p("local")
+
+class MulticoreRegTest(GdbTest):
+ compile_args = ("programs/infinite_loop.S", "-DMULTICORE")
+
+ def early_applicable(self):
+ return len(self.target.harts) > 1
+
+ def setup(self):
+ self.gdb.load()
+ for hart in self.target.harts:
+ self.gdb.select_hart(hart)
+ self.gdb.p("$pc=_start")
+
+ def test(self):
+ # Run to main
+ for hart in self.target.harts:
+ self.gdb.select_hart(hart)
+ self.gdb.b("main")
+ self.gdb.c()
+ assertIn("main", self.gdb.where())
+ self.gdb.command("delete breakpoints")
+
+ # Run through the entire loop.
+ for hart in self.target.harts:
+ self.gdb.select_hart(hart)
+ self.gdb.b("main_end")
+ self.gdb.c()
+ assertIn("main_end", self.gdb.where())
+
+ hart_ids = []
+ for hart in self.target.harts:
+ self.gdb.select_hart(hart)
+ # Check register values.
+ hart_id = self.gdb.p("$x1")
+ assertNotIn(hart_id, hart_ids)
+ hart_ids.append(hart_id)
+ for n in range(2, 32):
+ value = self.gdb.p("$x%d" % n)
+ assertEqual(value, hart_ids[-1] + n - 1)
+
+ # Confirmed that we read different register values for different harts.
+ # Write a new value to x1, and run through the add sequence again.
+
+ for hart in self.target.harts:
+ self.gdb.select_hart(hart)
+ self.gdb.p("$x1=0x%x" % (hart.index * 0x800))
+ self.gdb.p("$pc=main_post_csrr")
+ self.gdb.c()
+ for hart in self.target.harts:
+ self.gdb.select_hart(hart)
+ assertIn("main", self.gdb.where())
+ # Check register values.
+ for n in range(1, 32):
+ value = self.gdb.p("$x%d" % n)
+ assertEqual(value, hart.index * 0x800 + n - 1)
+
+#class MulticoreRunHaltStepiTest(GdbTest):
+# compile_args = ("programs/multicore.c", "-DMULTICORE")
+#
+# def early_applicable(self):
+# return len(self.target.harts) > 1
+#
+# def setup(self):
+# self.gdb.load()
+# for hart in self.target.harts:
+# self.gdb.select_hart(hart)
+# self.gdb.p("$mhartid")
+# self.gdb.p("$pc=_start")
+#
+# def test(self):
+# previous_hart_count = [0 for h in self.target.harts]
+# previous_interrupt_count = [0 for h in self.target.harts]
+# # Check 10 times
+# for i in range(10):
+# # 3 attempts for each time we want the check to pass
+# for attempt in range(3):
+# self.gdb.global_command("echo round %d attempt %d\\n" % (i,
+# attempt))
+# self.gdb.c_all(wait=False)
+# time.sleep(2)
+# self.gdb.interrupt_all()
+# hart_count = self.gdb.p("hart_count")
+# interrupt_count = self.gdb.p("interrupt_count")
+# ok = True
+# for i, h in enumerate(self.target.harts):
+# if hart_count[i] <= previous_hart_count[i]:
+# ok = False
+# break
+# if interrupt_count[i] <= previous_interrupt_count[i]:
+# ok = False
+# break
+# self.gdb.p("$mie")
+# self.gdb.p("$mip")
+# self.gdb.p("$mstatus")
+# self.gdb.p("$priv")
+# self.gdb.p("buf", fmt="")
+# self.gdb.select_hart(h)
+# pc = self.gdb.p("$pc")
+# self.gdb.stepi()
+# stepped_pc = self.gdb.p("$pc")
+# assertNotEqual(pc, stepped_pc)
+# previous_hart_count = hart_count
+# previous_interrupt_count = interrupt_count
+# if ok:
+# break
+# else:
+# assert False, \
+# "hart count or interrupt didn't increment as expected"
+
+class MulticoreRunAllHaltOne(GdbTest):
+ compile_args = ("programs/multicore.c", "-DMULTICORE")
+
+ def early_applicable(self):
+ return len(self.target.harts) > 1
+
+ def setup(self):
+ self.gdb.select_hart(self.target.harts[0])
+ self.gdb.load()
+ for hart in self.target.harts:
+ self.gdb.select_hart(hart)
+ self.gdb.p("$pc=_start")
+
+ def test(self):
+ if not self.gdb.one_hart_per_gdb():
+ return 'not_applicable'
+
+ # Run harts in reverse order
+ for h in reversed(self.target.harts):
+ self.gdb.select_hart(h)
+ self.gdb.c(wait=False)
+
+ self.gdb.interrupt()
+ # Give OpenOCD time to call poll() on both harts, which is what causes
+ # the bug.
+ time.sleep(1)
+ self.gdb.p("buf", fmt="")
+
+class MulticoreRtosSwitchActiveHartTest(GdbTest):
+ compile_args = ("programs/multicore.c", "-DMULTICORE")
+
+ def early_applicable(self):
+ return len(self.target.harts) > 1
+
+ def setup(self):
+ self.gdb.select_hart(self.target.harts[0])
+ self.gdb.load()
+ for hart in self.target.harts:
+ self.gdb.select_hart(hart)
+ self.gdb.p("$pc=_start")
+
+ def test(self):
+ if self.gdb.one_hart_per_gdb():
+ return 'not_applicable'
+
+ # Set breakpoint near '_start' label to increase the chances of a
+ # situation when all harts hit breakpoint immediately and
+ # simultaneously.
+ self.gdb.b("set_trap_handler")
+
+ # Check that all harts hit breakpoint one by one.
+ for _ in range(len(self.target.harts)):
+ output = self.gdb.c()
+ assertIn("hit Breakpoint", output)
+ assertIn("set_trap_handler", output)
+ assertNotIn("received signal SIGTRAP", output)
+
+class StepTest(GdbSingleHartTest):
compile_args = ("programs/step.S", )
- def setUp(self):
+ 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):
+ if self.hart.extensionSupported("c"):
+ sequence = (4, 8, 0xc, 0xe, 0x14, 0x18, 0x22, 0x1c, 0x24, 0x24)
+ else:
+ sequence = (4, 8, 0xc, 0x10, 0x18, 0x1c, 0x28, 0x20, 0x2c, 0x2c)
+ for expected in sequence:
self.gdb.stepi()
pc = self.gdb.p("$pc")
- assertEqual("%x" % pc, "%x" % (expected + main_address))
+ assertEqual("%x" % (pc - main_address), "%x" % expected)
+
+class JumpHbreak(GdbSingleHartTest):
+ """'jump' resumes execution at location. Execution stops again immediately
+ if there is a breakpoint there.
+ That second line can be trouble."""
+ compile_args = ("programs/trigger.S", )
+
+ def early_applicable(self):
+ return self.hart.instruction_hardware_breakpoint_count >= 1
-class TriggerTest(GdbTest):
+ def setup(self):
+ self.gdb.load()
+ self.gdb.hbreak("main")
+ self.gdb.c()
+ self.gdb.command("delete 1")
+
+ def test(self):
+ self.gdb.b("read_loop")
+ self.gdb.command("hbreak just_before_read_loop")
+ output = self.gdb.command("jump just_before_read_loop")
+ assertRegexpMatches(output, r"Breakpoint \d, just_before_read_loop ")
+ output = self.gdb.c()
+ assertRegexpMatches(output, r"Breakpoint \d, read_loop ")
+
+class TriggerTest(GdbSingleHartTest):
compile_args = ("programs/trigger.S", )
- def setUp(self):
+ def setup(self):
self.gdb.load()
self.gdb.b("_exit")
self.gdb.b("main")
assertIn("_exit", output)
class TriggerExecuteInstant(TriggerTest):
+ """Test an execute breakpoint on the first instruction executed out of
+ debug mode."""
def test(self):
- """Test an execute breakpoint on the first instruction executed out of
- debug mode."""
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()
+# FIXME: Triggers aren't quite working yet
+#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):
- """Test a load address breakpoint on the first instruction executed out
- of debug mode."""
self.gdb.command("b just_before_read_loop")
self.gdb.c()
read_loop = self.gdb.p("&read_loop")
- self.gdb.command("rwatch data")
+ read_again = self.gdb.p("&read_again")
+ data = self.gdb.p("&data")
+ self.gdb.command("rwatch *0x%x" % 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()
+ self.gdb.c()
+ assertIn(self.gdb.p("$pc"), [read_again, read_again + 4])
+ assertEqual(self.gdb.p("$a0"), self.gdb.p("&data"))
-class TriggerStoreAddressInstance(TriggerTest):
+# FIXME: Triggers aren't quite working yet
+#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()
+ data = self.gdb.p("&data")
+ self.gdb.command("watch *0x%x" % data)
+ output = self.gdb.c()
+ if "_exit (status=0)" in output:
+ # We ran to _exit. It looks as if we didn't hit the trigger at all.
+ # However this can be "correct" behavior. gdb's definition of
+ # "watch" is to run until the value in memory changes. To do this
+ # it reads the memory value when the trigger is set, and then when
+ # the halt happens. Because our triggers can fire just before the
+ # write happens, when gdb does this check the memory hasn't
+ # changed. So it silently resumes running.
+ # https://github.com/riscv/riscv-openocd/issues/295 tracks this
+ # problem. Until it's fixed, we're going to allow running to _exit.
+ return
+
# 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 early_applicable(self):
+ return self.hart.honors_tdata1_hmode
+
+ def check_triggers(self, tdata1_lsbs, tdata2):
+ dmode = 1 << (self.hart.xlen-5)
+
+ triggers = []
+
+ if self.hart.xlen == 32:
+ xlen_type = 'int'
+ elif self.hart.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 handle_trap")
- self.gdb.p("$pc=write_valid")
+ 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("handle_trap", output)
- assertIn("mcause=2", output)
- assertIn("mepc=%d" % self.gdb.p("&write_invalid_illegal"), output)
+ assertIn("clear_triggers", output)
+ self.check_triggers((1<<6) | (1<<0), 0xfeedac00)
-class RegsTest(GdbTest):
+class RegsTest(GdbSingleHartTest):
compile_args = ("programs/regs.S", )
- def setUp(self):
+ def setup(self):
self.gdb.load()
self.gdb.b("main")
self.gdb.b("handle_trap")
self.gdb.command("info registers")
for n in range(len(regs)):
assertEqual(self.gdb.x("data+%d" % (8*n), 'g'),
- ((0xdeadbeef<<n)+17) & ((1<<self.target.xlen)-1))
+ ((0xdeadbeef<<n)+17) & ((1<<self.hart.xlen)-1))
class WriteCsrs(RegsTest):
def test(self):
self.gdb.stepi()
assertEqual(self.gdb.p("$mscratch"), 123)
- self.gdb.command("p $pc=write_regs")
- self.gdb.command("p $a0=data")
+ self.gdb.p("$pc=write_regs")
+ self.gdb.p("$x1=data")
self.gdb.command("b all_done")
self.gdb.command("c")
assertEqual(123, self.gdb.p("$csr832"))
class DownloadTest(GdbTest):
- def setUp(self):
- 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(
+ def setup(self):
+ # pylint: disable=attribute-defined-outside-init
+ length = min(2**10, self.hart.ram_size - 2048)
+ self.download_c = tempfile.NamedTemporaryFile(prefix="download_",
+ suffix=".c", delete=False)
+ self.download_c.write("#include <stdint.h>\n")
+ self.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.download_c.write("uint32_t length = %d;\n" % length)
+ self.download_c.write("uint8_t d[%d] = {\n" % length)
self.crc = 0
+ assert length % 16 == 0
for i in range(length / 16):
- download_c.write(" /* 0x%04x */ " % (i * 16))
+ self.download_c.write(" /* 0x%04x */ " % (i * 16))
for _ in range(16):
value = random.randrange(1<<8)
- download_c.write("%d, " % value)
+ self.download_c.write("0x%02x, " % value)
self.crc = binascii.crc32("%c" % value, self.crc)
- 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()
+ self.download_c.write("\n")
+ self.download_c.write("};\n")
+ self.download_c.write("uint8_t *data = &d[0];\n")
+ self.download_c.write(
+ "uint32_t main() { return crc32a(data, length); }\n")
+ self.download_c.flush()
if self.crc < 0:
self.crc += 2**32
- self.binary = self.target.compile(download_c.name,
+ self.binary = self.target.compile(self.hart, self.download_c.name,
"programs/checksum.c")
- self.gdb.command("file %s" % self.binary)
+ self.gdb.global_command("file %s" % self.binary)
def test(self):
self.gdb.load()
+ self.parkOtherHarts()
self.gdb.command("b _exit")
self.gdb.c()
assertEqual(self.gdb.p("status"), self.crc)
-
-class MprvTest(GdbTest):
- compile_args = ("programs/mprv.S", )
- def setUp(self):
- self.gdb.load()
-
- 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)")
- assertIn("0xbead", output)
-
-class PrivTest(GdbTest):
+ os.unlink(self.download_c.name)
+
+#class MprvTest(GdbSingleHartTest):
+# compile_args = ("programs/mprv.S", )
+# def setup(self):
+# self.gdb.load()
+#
+# 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)")
+# assertIn("0xbead", output)
+
+class PrivTest(GdbSingleHartTest):
compile_args = ("programs/priv.S", )
- def setUp(self):
+ def setup(self):
+ # pylint: disable=attribute-defined-outside-init
self.gdb.load()
- misa = self.gdb.p("$misa")
+ misa = self.hart.misa
self.supported = set()
if misa & (1<<20):
self.supported.add(0)
self.supported.add(2)
self.supported.add(3)
+ # Disable physical memory protection by allowing U mode access to all
+ # memory.
+ try:
+ self.gdb.p("$pmpcfg0=0xf") # TOR, R, W, X
+ self.gdb.p("$pmpaddr0=0x%x" %
+ ((self.hart.ram + self.hart.ram_size) >> 2))
+ except testlib.CouldNotFetch:
+ # PMP registers are optional
+ pass
+
+ # Ensure Virtual Memory is disabled if applicable (SATP register is not
+ # reset)
+ try:
+ self.gdb.p("$satp=0")
+ except testlib.CouldNotFetch:
+ # SATP only exists if you have S mode.
+ pass
+
class PrivRw(PrivTest):
def test(self):
"""Test reading/writing priv."""
+ # Leave the PC at _start, where the first 4 instructions should be
+ # legal in any mode.
for privilege in range(4):
self.gdb.p("$priv=%d" % privilege)
self.gdb.stepi()
pc = self.gdb.p("$pc")
assertTrue(pc < main_address or pc > main_address + 0x100)
-class Target(object):
- name = "name"
- xlen = 0
- directory = None
- timeout_sec = 2
- temporary_files = []
- temporary_binary = None
-
- def server(self):
- raise NotImplementedError
-
- def compile(self, *sources):
- binary_name = "%s_%s-%d" % (
- self.name,
- os.path.basename(os.path.splitext(sources[0])[0]),
- self.xlen)
- if parsed.isolate:
- self.temporary_binary = tempfile.NamedTemporaryFile(
- prefix=binary_name + "_")
- binary_name = self.temporary_binary.name
- Target.temporary_files.append(self.temporary_binary)
- testlib.compile(sources +
- ("programs/entry.S", "programs/init.c",
- "-I", "../env",
- "-T", "targets/%s/link.lds" % (self.directory or self.name),
- "-nostartfiles",
- "-mcmodel=medany",
- "-o", binary_name),
- xlen=self.xlen)
- return binary_name
-
-class SpikeTarget(Target):
- directory = "spike"
- ram = 0x80010000
- ram_size = 5 * 1024 * 1024
- instruction_hardware_breakpoint_count = 4
- reset_vector = 0x1000
-
-class Spike64Target(SpikeTarget):
- name = "spike64"
- xlen = 64
-
- def server(self):
- return testlib.Spike(parsed.cmd, halted=True)
-
-class Spike32Target(SpikeTarget):
- name = "spike32"
- xlen = 32
-
- def server(self):
- return testlib.Spike(parsed.cmd, halted=True, xlen=32)
-
-class FreedomE300Target(Target):
- name = "freedom-e300"
- xlen = 32
- ram = 0x80000000
- ram_size = 16 * 1024
- instruction_hardware_breakpoint_count = 2
-
- def server(self):
- return testlib.Openocd(cmd=parsed.cmd,
- config="targets/%s/openocd.cfg" % self.name)
-
-class FreedomE300SimTarget(Target):
- name = "freedom-e300-sim"
- xlen = 32
- timeout_sec = 240
- ram = 0x80000000
- ram_size = 256 * 1024 * 1024
- instruction_hardware_breakpoint_count = 2
-
- def server(self):
- sim = testlib.VcsSim(simv=parsed.run, debug=False)
- openocd = testlib.Openocd(cmd=parsed.cmd,
- config="targets/%s/openocd.cfg" % self.name,
- otherProcess=sim)
- time.sleep(20)
- return openocd
-
-class FreedomU500Target(Target):
- name = "freedom-u500"
- xlen = 64
- ram = 0x80000000
- ram_size = 16 * 1024
- instruction_hardware_breakpoint_count = 2
-
- def server(self):
- return testlib.Openocd(cmd=parsed.cmd,
- config="targets/%s/openocd.cfg" % self.name)
-
-class FreedomU500SimTarget(Target):
- name = "freedom-u500-sim"
- xlen = 64
- timeout_sec = 240
- ram = 0x80000000
- ram_size = 256 * 1024 * 1024
- instruction_hardware_breakpoint_count = 2
-
- def server(self):
- sim = testlib.VcsSim(simv=parsed.run, debug=False)
- openocd = testlib.Openocd(cmd=parsed.cmd,
- config="targets/%s/openocd.cfg" % self.name,
- otherProcess=sim)
- time.sleep(20)
- return openocd
-
-targets = [
- Spike32Target,
- Spike64Target,
- FreedomE300Target,
- FreedomU500Target,
- FreedomE300SimTarget,
- FreedomU500SimTarget]
-
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 physical FPGA, with custom openocd command:
- ./gdbserver.py --freedom-e300 --cmd "$HOME/SiFive/openocd/src/openocd -s $HOME/SiFive/openocd/tcl -d" RegsTest
+ ./gdbserver.py --freedom-e300 --server_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("--run",
- help="The command to use to start the actual target (e.g. "
- "simulation)")
- parser.add_argument("--cmd",
- help="The command to use to start the debug server.")
- parser.add_argument("--gdb",
- help="The command to use to start gdb.")
-
- xlen_group = parser.add_mutually_exclusive_group()
- xlen_group.add_argument("--32", action="store_const", const=32, dest="xlen",
- help="Force the target to be 32-bit.")
- xlen_group.add_argument("--64", action="store_const", const=64, dest="xlen",
- help="Force the target to be 64-bit.")
-
- parser.add_argument("--isolate", action="store_true",
- help="Try to run in such a way that multiple instances can run at "
- "the same time. This may make it harder to debug a failure if it "
- "does occur.")
-
- parser.add_argument("test", nargs='*',
- help="Run only tests that are named here.")
+ targets.add_target_options(parser)
+
+ testlib.add_test_run_options(parser)
# TODO: remove global
global parsed # pylint: disable=global-statement
parsed = parser.parse_args()
+ target = targets.target(parsed)
+ testlib.print_log_names = parsed.print_log_names
- target = parsed.target()
- if parsed.xlen:
- target.xlen = parsed.xlen
+ module = sys.modules[__name__]
- return run_all_tests(target, parsed.test)
+ return testlib.run_all_tests(module, target, parsed)
# TROUBLESHOOTING TIPS
# If a particular test fails, run just that one test, eg.:
projects / riscv-tests.git / blobdiff