X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=debug%2Ftestlib.py;h=90702bf605652b08372a3a96f2b0b4af07403cf7;hb=8e0f6a0b1a33d35f2248628af7333ede093341d0;hp=95578eeb5de00097918389a267984317a77d05e0;hpb=c689ccb0e52f03a5bf469ddc6a5faf4f6c21870a;p=riscv-tests.git diff --git a/debug/testlib.py b/debug/testlib.py index 95578ee..90702bf 100644 --- a/debug/testlib.py +++ b/debug/testlib.py @@ -1,4 +1,5 @@ import collections +import os import os.path import random import re @@ -11,14 +12,20 @@ import traceback 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. def find_file(path): for directory in (os.getcwd(), os.path.dirname(__file__)): fullpath = os.path.join(directory, path) - if os.path.exists(fullpath): - return fullpath + relpath = os.path.relpath(fullpath) + if len(relpath) >= len(fullpath): + relpath = fullpath + if os.path.exists(relpath): + return relpath return None def compile(args, xlen=32): # pylint: disable=redefined-builtin @@ -36,43 +43,81 @@ def compile(args, xlen=32): # pylint: disable=redefined-builtin cmd.append(found) else: cmd.append(arg) + header("Compile") + print "+", " ".join(cmd) process = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE) stdout, stderr = process.communicate() if process.returncode: - print - header("Compile failed") - print "+", " ".join(cmd) print stdout, print stderr, 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): """Launch spike. Return tuple of its process and the port it's running on.""" + self.process = None + + if target.harts: + harts = target.harts + else: + harts = [target] + + cmd = self.command(target, harts, halted, timeout, with_jtag_gdb) + self.infinite_loop = target.compile(harts[0], + "programs/checksum.c", "programs/tiny-malloc.c", + "programs/infinite_loop.S", "-DDEFINE_MALLOC", "-DDEFINE_FREE") + cmd.append(self.infinite_loop) + 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=self.logfile, stderr=self.logfile) + + if with_jtag_gdb: + self.port = None + for _ in range(30): + m = re.search(r"Listening for remote bitbang connection on " + r"port (\d+).", open(self.logname).read()) + if m: + self.port = int(m.group(1)) + os.environ['REMOTE_BITBANG_PORT'] = m.group(1) + break + time.sleep(0.11) + if not self.port: + print_log(self.logname) + raise Exception("Didn't get spike message about bitbang " + "connection") + + def command(self, target, harts, halted, timeout, with_jtag_gdb): + # pylint: disable=no-self-use if target.sim_cmd: cmd = shlex.split(target.sim_cmd) else: spike = os.path.expandvars("$RISCV/bin/spike") cmd = [spike] - if target.xlen == 32: + + cmd += ["-p%d" % len(harts)] + + 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"] else: cmd += ["--isa", "RV64G"] - cmd += ["-m0x%x:0x%x" % (target.ram, target.ram_size)] + + assert len(set(t.ram for t in harts)) == 1, \ + "All spike harts must have the same RAM layout" + assert len(set(t.ram_size for t in harts)) == 1, \ + "All spike harts must have the same RAM layout" + cmd += ["-m0x%x:0x%x" % (harts[0].ram, harts[0].ram_size)] if timeout: cmd = ["timeout", str(timeout)] + cmd @@ -82,35 +127,16 @@ class Spike(object): if with_jtag_gdb: cmd += ['--rbb-port', '0'] os.environ['REMOTE_BITBANG_HOST'] = 'localhost' - self.infinite_loop = target.compile( - "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.process = subprocess.Popen(cmd, stdin=subprocess.PIPE, - stdout=logfile, stderr=logfile) - if with_jtag_gdb: - self.port = None - for _ in range(30): - m = re.search(r"Listening for remote bitbang connection on " - r"port (\d+).", open(self.logname).read()) - if m: - self.port = int(m.group(1)) - os.environ['REMOTE_BITBANG_PORT'] = m.group(1) - break - time.sleep(0.11) - assert self.port, "Didn't get spike message about bitbang " \ - "connection" + return cmd def __del__(self): - try: - self.process.kill() - self.process.wait() - except OSError: - pass + if self.process: + try: + self.process.kill() + self.process.wait() + except OSError: + pass def wait(self, *args, **kwargs): return self.process.wait(*args, **kwargs) @@ -161,9 +187,10 @@ class VcsSim(object): class Openocd(object): logfile = tempfile.NamedTemporaryFile(prefix='openocd', suffix='.log') logname = logfile.name - print "OpenOCD Temp Logfile: %s " % logname def __init__(self, server_cmd=None, config=None, debug=False, timeout=60): + self.timeout = timeout + if server_cmd: cmd = shlex.split(server_cmd) else: @@ -197,10 +224,17 @@ class Openocd(object): if debug: cmd.append("-d") - logfile = Openocd.logfile + logfile = open(Openocd.logname, "w") + if print_log_names: + real_stdout.write("Temporary OpenOCD log: %s\n" % Openocd.logname) logfile.write("+ %s\n" % " ".join(cmd)) logfile.flush() - self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE, + + self.gdb_ports = [] + self.process = self.start(cmd, logfile) + + def start(self, cmd, logfile): + process = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=logfile, stderr=logfile) try: @@ -210,27 +244,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: - self.port = int(m.group(1)) - break + self.gdb_ports.append(int(m.group(1))) + + if "telnet server disabled" in line: + return process - if not self.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) > timeout: - raise Exception("ERROR: Timed out waiting for OpenOCD to " + if (time.time() - start) > self.timeout: + raise Exception("Timed out waiting for OpenOCD to " "listen for gdb") except Exception: - header("OpenOCD log") - sys.stdout.write(log) + print_log(Openocd.logname) raise def __del__(self): @@ -271,36 +310,119 @@ class CannotAccess(Exception): Exception.__init__(self) self.address = address -Thread = collections.namedtuple('Thread', ('id', 'target_id', 'name', - 'frame')) +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 file: %s" % logname - - def __init__(self, - cmd=os.path.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")): - self.child = pexpect.spawn(cmd) - 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 + self.harts[hartid] = (child, t) + + def __del__(self): + for child in self.children: + del child + + 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): + child, thread = self.harts[hart.id] + self.select_child(child) + output = self.command("thread %s" % thread.id) + assert "Unknown" not in output + + def push_state(self): + self.stack.append({ + 'active_child': self.active_child + }) + + def pop_state(self): + state = self.stack.pop() + self.active_child = state['active_child'] def wait(self): """Wait for prompt.""" - self.child.expect(r"\(gdb\)") + self.active_child.expect(r"\(gdb\)") def command(self, command, timeout=6000): - self.child.sendline(command) - self.child.expect("\n", timeout=timeout) - self.child.expect(r"\(gdb\)", timeout=timeout) - return self.child.before.strip() + """timeout is in seconds""" + 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, timeout=-1, 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: @@ -310,13 +432,34 @@ class Gdb(object): 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") + + 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)) @@ -330,13 +473,23 @@ class Gdb(object): raise CannotAccess(int(m.group(1), 0)) return output.split('=')[-1].strip() - def p(self, obj): - output = self.command("p/x %s" % obj) + def parse_string(self, text): + text = text.strip() + if text.startswith("{") and text.endswith("}"): + inner = text[1:-1] + return [self.parse_string(t) for t in inner.split(", ")] + elif text.startswith('"') and text.endswith('"'): + return text[1:-1] + else: + return int(text, 0) + + def p(self, obj, fmt="/x"): + output = self.command("p%s %s" % (fmt, obj)) m = re.search("Cannot access memory at address (0x[0-9a-f]+)", output) if m: raise CannotAccess(int(m.group(1), 0)) - value = int(output.split('=')[-1].strip(), 0) - return value + rhs = output.split('=')[-1] + return self.parse_string(rhs) def p_string(self, obj): output = self.command("p %s" % obj) @@ -369,17 +522,32 @@ class Gdb(object): 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): os.makedirs(parsed.logs) @@ -390,19 +558,22 @@ def run_all_tests(module, target, parsed): gdb_cmd = parsed.gdb todo = [] - if parsed.misaval: - target.misa = int(parsed.misaval, 16) - print "Using $misa from command line: 0x%x" % target.misa - elif target.misa: - print "Using $misa from target definition: 0x%x" % target.misa - else: - todo.append(("ExamineTarget", ExamineTarget)) + 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 + 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)) + todo.append((name, definition, None)) results, count = run_tests(parsed, target, todo) @@ -416,16 +587,17 @@ def run_tests(parsed, target, todo): results = {} count = 0 - for name, definition in todo: - instance = definition(target) + for name, definition, hart in 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: @@ -434,7 +606,7 @@ def run_tests(parsed, target, todo): finally: sys.stdout = real_stdout log_fd.write("Time elapsed: %.2fs\n" % (time.time() - start)) - print "%s in %.2fs" % (result, time.time() - start) + 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() @@ -463,6 +635,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", @@ -482,16 +657,20 @@ 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 class BaseTest(object): compiled = {} - def __init__(self, target): + def __init__(self, target, hart=None): self.target = target + if hart: + self.hart = hart + else: + self.hart = random.choice(target.harts) + self.hart = target.harts[-1] #<<< self.server = None self.target_process = None self.binary = None @@ -511,9 +690,8 @@ 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(*compile_args) + self.target.compile(self.hart, *compile_args) self.binary = BaseTest.compiled.get(compile_args) def classSetup(self): @@ -533,6 +711,9 @@ class BaseTest(object): del self.server del self.target_process + def postMortem(self): + pass + def run(self): """ If compile_args is set, compile a program and set self.binary. @@ -566,6 +747,12 @@ class BaseTest(object): print e.message header("Traceback") traceback.print_exc(file=sys.stdout) + 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: @@ -580,62 +767,85 @@ class BaseTest(object): gdb_cmd = None class GdbTest(BaseTest): - def __init__(self, target): - BaseTest.__init__(self, target) + def __init__(self, target, hart=None): + BaseTest.__init__(self, target, hart=hart) self.gdb = None def classSetup(self): 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.logs.append(self.gdb.logname) - - if self.binary: - self.gdb.command("file %s" % self.binary) - if self.target: - self.gdb.command("set arch riscv:rv%d" % self.target.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) - # Select a random thread. - # TODO: Allow a command line option to force a specific thread. - thread = random.choice(self.gdb.threads()) - self.gdb.thread(thread) + self.gdb = Gdb(self.server.gdb_ports, + timeout=self.target.timeout_sec, binary=self.binary) + + self.logs += self.gdb.lognames() + self.gdb.connect() + + self.gdb.global_command("set arch riscv:rv%d" % self.hart.xlen) + 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") + def postMortem(self): + if not self.gdb: + return + self.gdb.interrupt() + self.gdb.command("info registers all", timeout=10) + def classTeardown(self): del self.gdb BaseTest.classTeardown(self) +class GdbSingleHartTest(GdbTest): + def classSetup(self): + GdbTest.classSetup(self) + + for hart in self.target.harts: + # Park all harts that we're not using in a safe place. + 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.target.misa = self.gdb.p("$misa") - - txt = "RV" - if (self.target.misa >> 30) == 1: - txt += "32" - elif (self.target.misa >> 62) == 2: - txt += "64" - elif (self.target.misa >> 126) == 3: - txt += "128" - else: - raise TestFailed("Couldn't determine XLEN from $misa (0x%x)" % - self.target.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.target.misa & (1<