X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=debug%2Ftestlib.py;h=09baf1bec6bb522fb7d85631f2112c61dd1270de;hb=5b1cac645fd867174e1ca23934c0d5f80445e88c;hp=3eeace91ff326600f51f2a77d59327cd95b39b01;hpb=910f39c9b46a883d58f0b77ae847c535834a48da;p=riscv-tests.git diff --git a/debug/testlib.py b/debug/testlib.py index 3eeace9..09baf1b 100644 --- a/debug/testlib.py +++ b/debug/testlib.py @@ -1,4 +1,5 @@ import collections +import os import os.path import random import re @@ -8,9 +9,13 @@ import sys 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. @@ -50,22 +55,14 @@ def compile(args, xlen=32): # pylint: disable=redefined-builtin header("") raise Exception("Compile failed!") -def unused_port(): - # http://stackoverflow.com/questions/2838244/get-open-tcp-port-in-python/2838309#2838309 - import socket - s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) - s.bind(("", 0)) - port = s.getsockname()[1] - s.close() - return port - class Spike(object): - logname = "spike-%d.log" % os.getpid() - - 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, progbufsize=None): """Launch spike. Return tuple of its process and the port it's running on.""" self.process = None + self.isa = isa + self.progbufsize = progbufsize if target.harts: harts = target.harts @@ -77,11 +74,15 @@ class Spike(object): "programs/checksum.c", "programs/tiny-malloc.c", "programs/infinite_loop.S", "-DDEFINE_MALLOC", "-DDEFINE_FREE") cmd.append(self.infinite_loop) - logfile = open(self.logname, "w") - logfile.write("+ %s\n" % " ".join(cmd)) - logfile.flush() + 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, - stdout=logfile, stderr=logfile) + stdout=self.logfile, stderr=self.logfile) if with_jtag_gdb: self.port = None @@ -111,10 +112,17 @@ class Spike(object): 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] + cmd += ["--debug-auth"] + + if not self.progbufsize is None: + cmd += ["--progsize", str(self.progbufsize)] + cmd += ["--debug-sba", "32"] assert len(set(t.ram for t in harts)) == 1, \ "All spike harts must have the same RAM layout" @@ -145,9 +153,10 @@ class Spike(object): 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: @@ -156,14 +165,19 @@ class VcsSim(object): 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() @@ -180,6 +194,10 @@ class VcsSim(object): 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() @@ -190,7 +208,6 @@ class VcsSim(object): 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 @@ -229,11 +246,16 @@ class Openocd(object): 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.ports = [] - self.port = None + self.gdb_ports = [] self.process = self.start(cmd, logfile) def start(self, cmd, logfile): @@ -247,31 +269,32 @@ class Openocd(object): # attempt too early. start = time.time() messaged = False + fd = open(Openocd.logname, "r") while True: - log = open(Openocd.logname).read() + line = fd.readline() + if not line: + if not process.poll() is None: + raise Exception("OpenOCD exited early.") + time.sleep(0.1) + continue + m = re.search(r"Listening on port (\d+) for gdb connections", - log) + line) if m: - if not self.ports: - self.port = int(m.group(1)) - self.ports.append(int(m.group(1))) + self.gdb_ports.append(int(m.group(1))) - if "telnet server disabled" in log: - break + if "telnet server disabled" in line: + return process - if not process.poll() is None: - raise Exception( - "OpenOCD exited before completing riscv_examine()") if not messaged and time.time() - start > 1: messaged = True print "Waiting for OpenOCD to start..." if (time.time() - start) > self.timeout: - raise Exception("ERROR: Timed out waiting for OpenOCD to " + raise Exception("Timed out waiting for OpenOCD to " "listen for gdb") - return process + except Exception: - header("OpenOCD log") - sys.stdout.write(log) + print_log(Openocd.logname) raise def __del__(self): @@ -312,58 +335,173 @@ class CannotAccess(Exception): Exception.__init__(self) self.address = address -Thread = collections.namedtuple('Thread', ('id', 'target_id', 'name', - 'frame')) +class CouldNotFetch(Exception): + def __init__(self, regname, explanation): + Exception.__init__(self) + self.regname = regname + self.explanation = explanation + +Thread = collections.namedtuple('Thread', ('id', 'description', 'target_id', + 'name', 'frame')) class Gdb(object): - logfile = tempfile.NamedTemporaryFile(prefix="gdb", suffix=".log") - logname = logfile.name - print "GDB Temporary Log File: %s" % logname - - def __init__(self, - cmd=os.path.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")): - self.child = pexpect.spawn(cmd) - self.child.logfile = open(self.logname, "w") - self.child.logfile.write("+ %s\n" % cmd) - self.wait() - self.command("set confirm off") - self.command("set width 0") - self.command("set height 0") - # Force consistency. - self.command("set print entry-values no") + """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"), + 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 = [] + for port in ports: + 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] + + 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 width 0") + 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 self.binary: + self.command("file %s" % self.binary) + threads = self.threads() + for t in threads: + hartid = None + if t.name: + m = re.search(r"Hart (\d+)", t.name) + if m: + hartid = int(m.group(1)) + if hartid is None: + if self.harts: + hartid = max(self.harts) + 1 + else: + hartid = 0 + # solo: True iff this is the only thread on this child + self.harts[hartid] = {'child': child, + 'thread': t, + 'solo': len(threads) == 1} + + def __del__(self): + for child in self.children: + del child + + def one_hart_per_gdb(self): + return all(h['solo'] for h in self.harts.itervalues()) + + def lognames(self): + return [logfile.name for logfile in self.logfiles] + + def select_child(self, child): + self.active_child = child def select_hart(self, hart): - output = self.command("thread %d" % (hart.index + 1)) - assert "Unknown" not in output + h = self.harts[hart.id] + self.select_child(h['child']) + if not h['solo']: + output = self.command("thread %s" % h['thread'].id, ops=5) + assert "Unknown" not in output - def wait(self): - """Wait for prompt.""" - self.child.expect(r"\(gdb\)") + def push_state(self): + self.stack.append({ + 'active_child': self.active_child + }) - def command(self, command, timeout=6000): - """timeout is in seconds""" - self.child.sendline(command) - self.child.expect("\n", timeout=timeout) - self.child.expect(r"\(gdb\)", timeout=timeout) - return self.child.before.strip() + def pop_state(self): + state = self.stack.pop() + self.active_child = state['active_child'] - def c(self, wait=True, timeout=-1, async=False): + def wait(self): + """Wait for prompt.""" + self.active_child.expect(r"\(gdb\)") + + def command(self, command, ops=1): + """ops is the estimated number of operations gdb will have to perform + to perform this command. It is used to compute a timeout based on + self.timeout.""" + timeout = ops * self.timeout + self.active_child.sendline(command) + self.active_child.expect("\n", timeout=timeout) + self.active_child.expect(r"\(gdb\)", timeout=timeout) + return self.active_child.before.strip() + + def global_command(self, command): + """Execute this command on every gdb that we control.""" + with PrivateState(self): + for child in self.children: + self.select_child(child) + self.command(command) + + def c(self, wait=True, async=False): + """ + Dumb c command. + In RTOS mode, gdb will resume all harts. + In multi-gdb mode, this command will just go to the current gdb, so + will only resume one hart. + """ if async: async = "&" else: async = "" + ops = 10 if wait: - output = self.command("c%s" % async, timeout=timeout) + output = self.command("c%s" % async, ops=ops) assert "Continuing" in output return output else: - self.child.sendline("c%s" % async) - self.child.expect("Continuing") + self.active_child.sendline("c%s" % async) + self.active_child.expect("Continuing", timeout=ops * self.timeout) + + def c_all(self): + """ + 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") + child.expect("Continuing") + + # Now wait for them all to halt + for child in self.children: + child.expect(r"\(gdb\)") def interrupt(self): - self.child.send("\003") - self.child.expect(r"\(gdb\)", timeout=6000) - return self.child.before.strip() + self.active_child.send("\003") + self.active_child.expect(r"\(gdb\)", timeout=6000) + return self.active_child.before.strip() def x(self, address, size='w'): output = self.command("x/%s %s" % (size, address)) @@ -392,6 +530,9 @@ class Gdb(object): m = re.search("Cannot access memory at address (0x[0-9a-f]+)", output) if m: raise CannotAccess(int(m.group(1), 0)) + m = re.search(r"Could not fetch register \"(\w+)\"; (.*)$", output) + if m: + raise CouldNotFetch(m.group(1), m.group(2)) rhs = output.split('=')[-1] return self.parse_string(rhs) @@ -401,45 +542,66 @@ class Gdb(object): return value def stepi(self): - output = self.command("stepi", timeout=60) + output = self.command("stepi", ops=10) return output def load(self): - output = self.command("load", timeout=6000) + output = self.command("load", ops=1000) assert "failed" not in output assert "Transfer rate" in output + output = self.command("compare-sections", ops=1000) + assert "MIS" not in output def b(self, location): - output = self.command("b %s" % location) + output = self.command("b %s" % location, ops=5) assert "not defined" not in output assert "Breakpoint" in output return output def hbreak(self, location): - output = self.command("hbreak %s" % location) + output = self.command("hbreak %s" % location, ops=5) assert "not defined" not in output assert "Hardware assisted breakpoint" in output return output def threads(self): - output = self.command("info threads") + output = self.command("info threads", ops=100) threads = [] for line in output.splitlines(): m = re.match( - r"[\s\*]*(\d+)\s*Thread (\d+)\s*\(Name: ([^\)]+)\s*(.*)", - line) + r"[\s\*]*(\d+)\s*" + r"(Remote target|Thread (\d+)\s*\(Name: ([^\)]+))" + r"\s*(.*)", line) if m: threads.append(Thread(*m.groups())) - if not threads: - threads.append(Thread('1', '1', 'Default', '???')) + assert threads + #>>>if not threads: + #>>> threads.append(Thread('1', '1', 'Default', '???')) return threads def thread(self, thread): return self.command("thread %s" % thread.id) + def where(self): + return self.command("where 1") + +class PrivateState(object): + def __init__(self, gdb): + self.gdb = gdb + + def __enter__(self): + self.gdb.push_state() + + def __exit__(self, _type, _value, _traceback): + self.gdb.pop_state() + def run_all_tests(module, target, parsed): - if not os.path.exists(parsed.logs): + try: os.makedirs(parsed.logs) + except OSError: + # There's a race where multiple instances of the test program might + # decide to create the logs directory at the same time. + pass overall_start = time.time() @@ -447,18 +609,20 @@ def run_all_tests(module, target, parsed): 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)) @@ -478,21 +642,24 @@ def run_tests(parsed, target, todo): log_name = os.path.join(parsed.logs, "%s-%s-%s.log" % (time.strftime("%Y%m%d-%H%M%S"), type(target).__name__, name)) log_fd = open(log_name, 'w') - print "Running %s > %s ..." % (name, log_name), + print "[%s] Starting > %s" % (name, log_name) instance = definition(target, hart) sys.stdout.flush() 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() log_fd.write("Result: %s\n" % result) + log_fd.write("Logfile: %s\n" % log_name) finally: sys.stdout = real_stdout log_fd.write("Time elapsed: %.2fs\n" % (time.time() - start)) - print "%s in %.2fs" % (result, 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()) sys.stdout.flush() @@ -521,6 +688,9 @@ def add_test_run_options(parser): 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", @@ -540,8 +710,7 @@ def header(title, dash='-', length=78): def print_log(path): header(path) - lines = open(path, "r").readlines() - for l in lines: + for l in open(path, "r"): sys.stdout.write(l) print @@ -574,7 +743,6 @@ class BaseTest(object): 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) @@ -632,7 +800,12 @@ class BaseTest(object): print e.message header("Traceback") traceback.print_exc(file=sys.stdout) - self.postMortem() + try: + self.postMortem() + except Exception as e: # pylint: disable=broad-except + header("postMortem Exception") + print e + traceback.print_exc(file=sys.stdout) return result finally: @@ -655,25 +828,23 @@ class GdbTest(BaseTest): BaseTest.classSetup(self) if gdb_cmd: - self.gdb = Gdb(gdb_cmd) + self.gdb = Gdb(self.server.gdb_ports, gdb_cmd, + timeout=self.target.timeout_sec, binary=self.binary) else: - self.gdb = Gdb() + self.gdb = Gdb(self.server.gdb_ports, + timeout=self.target.timeout_sec, binary=self.binary) - self.logs.append(self.gdb.logname) + self.logs += self.gdb.lognames() + self.gdb.connect() - if self.binary: - self.gdb.command("file %s" % self.binary) - if self.target: - self.gdb.command("set arch riscv:rv%d" % self.hart.xlen) - self.gdb.command("set remotetimeout %d" % self.target.timeout_sec) - if self.server.port: - self.gdb.command( - "target extended-remote localhost:%d" % self.server.port) - self.gdb.select_hart(self.hart) + self.gdb.global_command("set remotetimeout %d" % + self.target.timeout_sec) for cmd in self.target.gdb_setup: self.gdb.command(cmd) + self.gdb.select_hart(self.hart) + # FIXME: OpenOCD doesn't handle PRIV now #self.gdb.p("$priv=3") @@ -681,7 +852,10 @@ class GdbTest(BaseTest): if not self.gdb: return self.gdb.interrupt() - self.gdb.command("info registers all", timeout=10) + self.gdb.command("disassemble", ops=20) + self.gdb.command("info registers all", ops=100) + self.gdb.command("flush regs") + self.gdb.command("info threads", ops=100) def classTeardown(self): del self.gdb @@ -696,27 +870,38 @@ class GdbSingleHartTest(GdbTest): if hart != self.hart: self.gdb.select_hart(hart) self.gdb.p("$pc=loop_forever") + self.gdb.select_hart(self.hart) 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<