import tempfile
import time
import traceback
+import pipes
import pexpect
+print_log_names = False
+real_stdout = sys.stdout
+
# Note that gdb comes with its own testsuite. I was unable to figure out how to
# run that testsuite against the spike simulator.
raise Exception("Compile failed!")
class Spike(object):
- def __init__(self, target, halted=False, timeout=None, with_jtag_gdb=True):
+ def __init__(self, target, halted=False, timeout=None, with_jtag_gdb=True,
+ isa=None):
"""Launch spike. Return tuple of its process and the port it's running
on."""
self.process = None
+ self.isa = isa
if target.harts:
harts = target.harts
self.logfile = tempfile.NamedTemporaryFile(prefix="spike-",
suffix=".log")
self.logname = self.logfile.name
+ if print_log_names:
+ real_stdout.write("Temporary spike log: %s\n" % self.logname)
self.logfile.write("+ %s\n" % " ".join(cmd))
self.logfile.flush()
self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE,
assert len(set(t.xlen for t in harts)) == 1, \
"All spike harts must have the same XLEN"
- if harts[0].xlen == 32:
- cmd += ["--isa", "RV32G"]
+ if self.isa:
+ isa = self.isa
else:
- cmd += ["--isa", "RV64G"]
+ isa = "RV%dG" % harts[0].xlen
+
+ cmd += ["--isa", isa]
assert len(set(t.ram for t in harts)) == 1, \
"All spike harts must have the same RAM layout"
return self.process.wait(*args, **kwargs)
class VcsSim(object):
- logname = "simv.log"
+ logfile = tempfile.NamedTemporaryFile(prefix='simv', suffix='.log')
+ logname = logfile.name
- def __init__(self, sim_cmd=None, debug=False):
+ def __init__(self, sim_cmd=None, debug=False, timeout=300):
if sim_cmd:
cmd = shlex.split(sim_cmd)
else:
if debug:
cmd[0] = cmd[0] + "-debug"
cmd += ["+vcdplusfile=output/gdbserver.vpd"]
+
logfile = open(self.logname, "w")
+ if print_log_names:
+ real_stdout.write("Temporary VCS log: %s\n" % self.logname)
logfile.write("+ %s\n" % " ".join(cmd))
logfile.flush()
+
listenfile = open(self.logname, "r")
listenfile.seek(0, 2)
self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE,
stdout=logfile, stderr=logfile)
done = False
+ start = time.time()
while not done:
# Fail if VCS exits early
exit_code = self.process.poll()
self.port = int(match.group(1))
os.environ['JTAG_VPI_PORT'] = str(self.port)
+ if (time.time() - start) > timeout:
+ raise Exception("Timed out waiting for VCS to listen for JTAG "
+ "vpi")
+
def __del__(self):
try:
self.process.kill()
class Openocd(object):
logfile = tempfile.NamedTemporaryFile(prefix='openocd', suffix='.log')
logname = logfile.name
- print "OpenOCD Temporary Log File: %s" % logname
def __init__(self, server_cmd=None, config=None, debug=False, timeout=60):
self.timeout = timeout
cmd.append("-d")
logfile = open(Openocd.logname, "w")
- logfile.write("+ %s\n" % " ".join(cmd))
+ if print_log_names:
+ real_stdout.write("Temporary OpenOCD log: %s\n" % Openocd.logname)
+ env_entries = ("REMOTE_BITBANG_HOST", "REMOTE_BITBANG_PORT")
+ env_entries = [key for key in env_entries if key in os.environ]
+ logfile.write("+ %s%s\n" % (
+ "".join("%s=%s " % (key, os.environ[key]) for key in env_entries),
+ " ".join(map(pipes.quote, cmd))))
logfile.flush()
self.gdb_ports = []
"""A single gdb class which can interact with one or more gdb instances."""
# pylint: disable=too-many-public-methods
+ # pylint: disable=too-many-instance-attributes
def __init__(self, ports,
cmd=os.path.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb"),
- binary=None):
+ timeout=60, binary=None):
assert ports
+ self.ports = ports
+ self.cmd = cmd
+ self.timeout = timeout
+ self.binary = binary
+
self.stack = []
+ self.harts = {}
self.logfiles = []
self.children = []
logfile = tempfile.NamedTemporaryFile(prefix="gdb@%d-" % port,
suffix=".log")
self.logfiles.append(logfile)
+ if print_log_names:
+ real_stdout.write("Temporary gdb log: %s\n" % logfile.name)
child = pexpect.spawn(cmd)
child.logfile = logfile
child.logfile.write("+ %s\n" % cmd)
self.children.append(child)
self.active_child = self.children[0]
- self.harts = {}
- for port, child in zip(ports, self.children):
+ def connect(self):
+ for port, child in zip(self.ports, self.children):
self.select_child(child)
self.wait()
self.command("set confirm off")
self.command("set height 0")
# Force consistency.
self.command("set print entry-values no")
+ self.command("set remotetimeout %d" % self.timeout)
self.command("target extended-remote localhost:%d" % port)
- if binary:
- self.command("file %s" % binary)
+ if self.binary:
+ self.command("file %s" % self.binary)
threads = self.threads()
for t in threads:
hartid = None
self.active_child.expect("Continuing")
def c_all(self):
- """Resume every hart."""
+ """
+ Resume every hart.
+
+ This function works fine when using multiple gdb sessions, but the
+ caller must be careful when using it nonetheless. gdb's behavior is to
+ not set breakpoints until just before the hart is resumed, and then
+ clears them as soon as the hart halts. That means that you can't set
+ one software breakpoint, and expect multiple harts to hit it. It's
+ possible that the first hart completes set/run/halt/clear before the
+ second hart even gets to resume, so it will never hit the breakpoint.
+ """
with PrivateState(self):
for child in self.children:
child.sendline("c")
gdb_cmd = parsed.gdb
todo = []
+ examine_added = False
for hart in target.harts:
if parsed.misaval:
hart.misa = int(parsed.misaval, 16)
print "Using $misa from command line: 0x%x" % hart.misa
elif hart.misa:
print "Using $misa from hart definition: 0x%x" % hart.misa
- else:
- todo.append(("ExamineTarget", ExamineTarget, hart))
+ elif not examine_added:
+ todo.append(("ExamineTarget", ExamineTarget, None))
+ examine_added = True
for name in dir(module):
definition = getattr(module, name)
- if type(definition) == type and hasattr(definition, 'test') and \
+ if isinstance(definition, type) and hasattr(definition, 'test') and \
(not parsed.test or any(test in name for test in parsed.test)):
todo.append((name, definition, None))
log_fd.write("Test: %s\n" % name)
log_fd.write("Target: %s\n" % type(target).__name__)
start = time.time()
+ global real_stdout # pylint: disable=global-statement
real_stdout = sys.stdout
sys.stdout = log_fd
try:
- result = instance.run(real_stdout)
+ result = instance.run()
log_fd.write("Result: %s\n" % result)
finally:
sys.stdout = real_stdout
log_fd.write("Time elapsed: %.2fs\n" % (time.time() - start))
+ log_fd.flush()
print "[%s] %s in %.2fs" % (name, result, time.time() - start)
if result not in good_results and parsed.print_failures:
sys.stdout.write(open(log_name).read())
help="Exit as soon as any test fails.")
parser.add_argument("--print-failures", action="store_true",
help="When a test fails, print the log file to stdout.")
+ parser.add_argument("--print-log-names", "--pln", action="store_true",
+ help="Print names of temporary log files as soon as they are "
+ "created.")
parser.add_argument("test", nargs='*',
help="Run only tests that are named here.")
parser.add_argument("--gdb",
compile_args = getattr(self, 'compile_args', None)
if compile_args:
if compile_args not in BaseTest.compiled:
- # pylint: disable=star-args
BaseTest.compiled[compile_args] = \
self.target.compile(self.hart, *compile_args)
self.binary = BaseTest.compiled.get(compile_args)
def postMortem(self):
pass
- def run(self, real_stdout):
+ def run(self):
"""
If compile_args is set, compile a program and set self.binary.
try:
self.classSetup()
- real_stdout.write("[%s] Temporary logs: %s\n" % (
- type(self).__name__, ", ".join(self.logs)))
self.setup()
result = self.test() # pylint: disable=no-member
except TestNotApplicable:
BaseTest.classSetup(self)
if gdb_cmd:
- self.gdb = Gdb(self.server.gdb_ports, gdb_cmd, binary=self.binary)
+ self.gdb = Gdb(self.server.gdb_ports, gdb_cmd,
+ timeout=self.target.timeout_sec, binary=self.binary)
else:
- self.gdb = Gdb(self.server.gdb_ports, binary=self.binary)
+ self.gdb = Gdb(self.server.gdb_ports,
+ timeout=self.target.timeout_sec, binary=self.binary)
self.logs += self.gdb.lognames()
+ self.gdb.connect()
- if self.target:
- self.gdb.global_command("set arch riscv:rv%d" % self.hart.xlen)
- self.gdb.global_command("set remotetimeout %d" %
- self.target.timeout_sec)
+ self.gdb.global_command("set remotetimeout %d" %
+ self.target.timeout_sec)
for cmd in self.target.gdb_setup:
self.gdb.command(cmd)
class ExamineTarget(GdbTest):
def test(self):
- self.hart.misa = self.gdb.p("$misa")
-
- txt = "RV"
- if (self.hart.misa >> 30) == 1:
- txt += "32"
- elif (self.hart.misa >> 62) == 2:
- txt += "64"
- elif (self.hart.misa >> 126) == 3:
- txt += "128"
- else:
- raise TestFailed("Couldn't determine XLEN from $misa (0x%x)" %
- self.hart.misa)
+ for hart in self.target.harts:
+ self.gdb.select_hart(hart)
+
+ hart.misa = self.gdb.p("$misa")
+
+ txt = "RV"
+ misa_xlen = 0
+ if ((hart.misa & 0xFFFFFFFF) >> 30) == 1:
+ misa_xlen = 32
+ elif ((hart.misa & 0xFFFFFFFFFFFFFFFF) >> 62) == 2:
+ misa_xlen = 64
+ elif ((hart.misa & 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF) >> 126) == 3:
+ misa_xlen = 128
+ else:
+ raise TestFailed("Couldn't determine XLEN from $misa (0x%x)" %
+ self.hart.misa)
+
+ if misa_xlen != hart.xlen:
+ raise TestFailed("MISA reported XLEN of %d but we were "\
+ "expecting XLEN of %d\n" % (misa_xlen, hart.xlen))
+
+ txt += ("%d" % misa_xlen)
- for i in range(26):
- if self.hart.misa & (1<<i):
- txt += chr(i + ord('A'))
- print txt,
+ for i in range(26):
+ if hart.misa & (1<<i):
+ txt += chr(i + ord('A'))
+ print txt,
class TestFailed(Exception):
def __init__(self, message):