import argparse
import binascii
-import os
import random
-import re
import sys
import tempfile
import time
-import traceback
+import targets
import testlib
+from testlib import assertEqual, assertNotEqual, assertIn
+from testlib import assertGreater, assertTrue, assertRegexpMatches, assertLess
+from testlib import GdbTest
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, fail_fast):
- good_results = set(('pass', 'not_applicable'))
-
- 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)
- if result not in good_results and fail_fast:
- break
-
- print ":" * 40
-
- 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)
-
-def assertRegexpMatches(text, regexp):
- if not re.search(regexp, text):
- raise TestFailed("can't find %r in %r" % (regexp, text))
-
class SimpleRegisterTest(GdbTest):
def check_reg(self, name):
a = random.randrange(1<<self.target.xlen)
self.gdb.stepi()
assertEqual(self.gdb.p("$%s" % name), 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))
def test(self):
self.check_reg("t1")
+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 early_applicable(self):
+ return self.target.extensionSupported('F')
+
+ def test(self):
+ self.check_reg("f18")
+
class SimpleMemoryTest(GdbTest):
def access_test(self, size, data_type):
assertEqual(self.gdb.p("sizeof(%s)" % data_type), size)
def test(self):
self.access_test(8, 'long long')
+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
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")
# 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)
self.gdb.c()
self.gdb.p("i=123")
self.gdb.c(wait=False)
- time.sleep(0.1)
+ time.sleep(0.5)
output = self.gdb.interrupt()
assert "main" in output
assertGreater(self.gdb.p("j"), 10)
class StepTest(GdbTest):
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.target.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 TriggerTest(GdbTest):
compile_args = ("programs/trigger.S", )
- def setUp(self):
+ def setup(self):
self.gdb.load()
self.gdb.b("_exit")
self.gdb.b("main")
class RegsTest(GdbTest):
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.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):
+ 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")
class MprvTest(GdbTest):
compile_args = ("programs/mprv.S", )
- def setUp(self):
+ def setup(self):
self.gdb.load()
def test(self):
class PrivTest(GdbTest):
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.target.misa
self.supported = set()
if misa & (1<<20):
self.supported.add(0)
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 --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("--fail-fast", "-f", action="store_true",
- help="Exit as soon as any test fails.")
-
- 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 = parsed.target()
+ target = parsed.target(parsed.cmd, parsed.run, parsed.isolate)
if parsed.xlen:
target.xlen = parsed.xlen
- return run_all_tests(target, parsed.test, parsed.fail_fast)
+ module = sys.modules[__name__]
+
+ 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