14 # Note that gdb comes with its own testsuite. I was unable to figure out how to
15 # run that testsuite against the spike simulator.
18 for directory
in (os
.getcwd(), os
.path
.dirname(__file__
)):
19 fullpath
= os
.path
.join(directory
, path
)
20 if os
.path
.exists(fullpath
):
24 def compile(args
, xlen
=32): # pylint: disable=redefined-builtin
25 cc
= os
.path
.expandvars("$RISCV/bin/riscv64-unknown-elf-gcc")
28 cmd
.append("-march=rv32imac")
29 cmd
.append("-mabi=ilp32")
31 cmd
.append("-march=rv64imac")
32 cmd
.append("-mabi=lp64")
34 found
= find_file(arg
)
39 process
= subprocess
.Popen(cmd
, stdout
=subprocess
.PIPE
,
40 stderr
=subprocess
.PIPE
)
41 stdout
, stderr
= process
.communicate()
42 if process
.returncode
:
44 header("Compile failed")
45 print "+", " ".join(cmd
)
49 raise Exception("Compile failed!")
52 # http://stackoverflow.com/questions/2838244/get-open-tcp-port-in-python/2838309#2838309
54 s
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
56 port
= s
.getsockname()[1]
61 logname
= "spike-%d.log" % os
.getpid()
63 def __init__(self
, target
, halted
=False, timeout
=None, with_jtag_gdb
=True):
64 """Launch spike. Return tuple of its process and the port it's running
67 cmd
= shlex
.split(target
.sim_cmd
)
69 spike
= os
.path
.expandvars("$RISCV/bin/spike")
72 cmd
+= ["--isa", "RV32G"]
74 cmd
+= ["--isa", "RV64G"]
75 cmd
+= ["-m0x%x:0x%x" % (target
.ram
, target
.ram_size
)]
78 cmd
= ["timeout", str(timeout
)] + cmd
83 cmd
+= ['--rbb-port', '0']
84 os
.environ
['REMOTE_BITBANG_HOST'] = 'localhost'
85 self
.infinite_loop
= target
.compile(
86 "programs/checksum.c", "programs/tiny-malloc.c",
87 "programs/infinite_loop.S", "-DDEFINE_MALLOC", "-DDEFINE_FREE")
88 cmd
.append(self
.infinite_loop
)
89 logfile
= open(self
.logname
, "w")
90 logfile
.write("+ %s\n" % " ".join(cmd
))
92 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
93 stdout
=logfile
, stderr
=logfile
)
98 m
= re
.search(r
"Listening for remote bitbang connection on "
99 r
"port (\d+).", open(self
.logname
).read())
101 self
.port
= int(m
.group(1))
102 os
.environ
['REMOTE_BITBANG_PORT'] = m
.group(1)
105 assert self
.port
, "Didn't get spike message about bitbang " \
115 def wait(self
, *args
, **kwargs
):
116 return self
.process
.wait(*args
, **kwargs
)
118 class VcsSim(object):
121 def __init__(self
, sim_cmd
=None, debug
=False):
123 cmd
= shlex
.split(sim_cmd
)
126 cmd
+= ["+jtag_vpi_enable"]
128 cmd
[0] = cmd
[0] + "-debug"
129 cmd
+= ["+vcdplusfile=output/gdbserver.vpd"]
130 logfile
= open(self
.logname
, "w")
131 logfile
.write("+ %s\n" % " ".join(cmd
))
133 listenfile
= open(self
.logname
, "r")
134 listenfile
.seek(0, 2)
135 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
136 stdout
=logfile
, stderr
=logfile
)
139 # Fail if VCS exits early
140 exit_code
= self
.process
.poll()
141 if exit_code
is not None:
142 raise RuntimeError('VCS simulator exited early with status %d'
145 line
= listenfile
.readline()
148 match
= re
.match(r
"^Listening on port (\d+)$", line
)
151 self
.port
= int(match
.group(1))
152 os
.environ
['JTAG_VPI_PORT'] = str(self
.port
)
161 class Openocd(object):
162 logfile
= tempfile
.NamedTemporaryFile(prefix
='openocd', suffix
='.log')
163 logname
= logfile
.name
164 print "OpenOCD Temporary Log File: %s" % logname
166 def __init__(self
, server_cmd
=None, config
=None, debug
=False, timeout
=60):
168 cmd
= shlex
.split(server_cmd
)
170 openocd
= os
.path
.expandvars("$RISCV/bin/openocd")
175 # This command needs to come before any config scripts on the command
176 # line, since they are executed in order.
178 # Tell OpenOCD to bind gdb to an unused, ephemeral port.
181 # Disable tcl and telnet servers, since they are unused and because
182 # the port numbers will conflict if multiple OpenOCD processes are
183 # running on the same server.
187 "telnet_port disabled",
191 f
= find_file(config
)
193 print "Unable to read file " + config
200 logfile
= open(Openocd
.logname
, "w")
201 logfile
.write("+ %s\n" % " ".join(cmd
))
203 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
204 stdout
=logfile
, stderr
=logfile
)
207 # Wait for OpenOCD to have made it through riscv_examine(). When
208 # using OpenOCD to communicate with a simulator this may take a
209 # long time, and gdb will time out when trying to connect if we
214 log
= open(Openocd
.logname
).read()
215 m
= re
.search(r
"Listening on port (\d+) for gdb connections",
218 self
.port
= int(m
.group(1))
221 if not self
.process
.poll() is None:
223 "OpenOCD exited before completing riscv_examine()")
224 if not messaged
and time
.time() - start
> 1:
226 print "Waiting for OpenOCD to start..."
227 if (time
.time() - start
) > timeout
:
228 raise Exception("ERROR: Timed out waiting for OpenOCD to "
232 header("OpenOCD log")
233 sys
.stdout
.write(log
)
240 except (OSError, AttributeError):
243 class OpenocdCli(object):
244 def __init__(self
, port
=4444):
245 self
.child
= pexpect
.spawn(
246 "sh -c 'telnet localhost %d | tee openocd-cli.log'" % port
)
247 self
.child
.expect("> ")
249 def command(self
, cmd
):
250 self
.child
.sendline(cmd
)
251 self
.child
.expect(cmd
)
252 self
.child
.expect("\n")
253 self
.child
.expect("> ")
254 return self
.child
.before
.strip("\t\r\n \0")
256 def reg(self
, reg
=''):
257 output
= self
.command("reg %s" % reg
)
258 matches
= re
.findall(r
"(\w+) \(/\d+\): (0x[0-9A-F]+)", output
)
259 values
= {r
: int(v
, 0) for r
, v
in matches
}
264 def load_image(self
, image
):
265 output
= self
.command("load_image %s" % image
)
266 if 'invalid ELF file, only 32bits files are supported' in output
:
267 raise TestNotApplicable(output
)
269 class CannotAccess(Exception):
270 def __init__(self
, address
):
271 Exception.__init
__(self
)
272 self
.address
= address
274 Thread
= collections
.namedtuple('Thread', ('id', 'target_id', 'name',
278 logfile
= tempfile
.NamedTemporaryFile(prefix
="gdb", suffix
=".log")
279 logname
= logfile
.name
280 print "GDB Temporary Log File: %s" % logname
283 cmd
=os
.path
.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")):
284 self
.child
= pexpect
.spawn(cmd
)
285 self
.child
.logfile
= open(self
.logname
, "w")
286 self
.child
.logfile
.write("+ %s\n" % cmd
)
288 self
.command("set confirm off")
289 self
.command("set width 0")
290 self
.command("set height 0")
292 self
.command("set print entry-values no")
295 """Wait for prompt."""
296 self
.child
.expect(r
"\(gdb\)")
298 def command(self
, command
, timeout
=6000):
299 self
.child
.sendline(command
)
300 self
.child
.expect("\n", timeout
=timeout
)
301 self
.child
.expect(r
"\(gdb\)", timeout
=timeout
)
302 return self
.child
.before
.strip()
304 def c(self
, wait
=True, timeout
=-1, async=False):
310 output
= self
.command("c%s" % async, timeout
=timeout
)
311 assert "Continuing" in output
314 self
.child
.sendline("c%s" % async)
315 self
.child
.expect("Continuing")
318 self
.child
.send("\003")
319 self
.child
.expect(r
"\(gdb\)", timeout
=6000)
320 return self
.child
.before
.strip()
322 def x(self
, address
, size
='w'):
323 output
= self
.command("x/%s %s" % (size
, address
))
324 value
= int(output
.split(':')[1].strip(), 0)
327 def p_raw(self
, obj
):
328 output
= self
.command("p %s" % obj
)
329 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
331 raise CannotAccess(int(m
.group(1), 0))
332 return output
.split('=')[-1].strip()
335 output
= self
.command("p/x %s" % obj
)
336 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
338 raise CannotAccess(int(m
.group(1), 0))
339 value
= int(output
.split('=')[-1].strip(), 0)
342 def p_string(self
, obj
):
343 output
= self
.command("p %s" % obj
)
344 value
= shlex
.split(output
.split('=')[-1].strip())[1]
348 output
= self
.command("stepi", timeout
=60)
352 output
= self
.command("load", timeout
=6000)
353 assert "failed" not in output
354 assert "Transfer rate" in output
356 def b(self
, location
):
357 output
= self
.command("b %s" % location
)
358 assert "not defined" not in output
359 assert "Breakpoint" in output
362 def hbreak(self
, location
):
363 output
= self
.command("hbreak %s" % location
)
364 assert "not defined" not in output
365 assert "Hardware assisted breakpoint" in output
369 output
= self
.command("info threads")
371 for line
in output
.splitlines():
373 r
"[\s\*]*(\d+)\s*Thread (\d+)\s*\(Name: ([^\)]+)\s*(.*)",
376 threads
.append(Thread(*m
.groups()))
378 threads
.append(Thread('1', '1', 'Default', '???'))
381 def thread(self
, thread
):
382 return self
.command("thread %s" % thread
.id)
384 def run_all_tests(module
, target
, parsed
):
385 if not os
.path
.exists(parsed
.logs
):
386 os
.makedirs(parsed
.logs
)
388 overall_start
= time
.time()
390 global gdb_cmd
# pylint: disable=global-statement
395 target
.misa
= int(parsed
.misaval
, 16)
396 print "Using $misa from command line: 0x%x" % target
.misa
398 print "Using $misa from target definition: 0x%x" % target
.misa
400 todo
.append(("ExamineTarget", ExamineTarget
))
402 for name
in dir(module
):
403 definition
= getattr(module
, name
)
404 if type(definition
) == type and hasattr(definition
, 'test') and \
405 (not parsed
.test
or any(test
in name
for test
in parsed
.test
)):
406 todo
.append((name
, definition
))
408 results
, count
= run_tests(parsed
, target
, todo
)
410 header("ran %d tests in %.0fs" % (count
, time
.time() - overall_start
),
413 return print_results(results
)
415 good_results
= set(('pass', 'not_applicable'))
416 def run_tests(parsed
, target
, todo
):
420 for name
, definition
in todo
:
421 instance
= definition(target
)
422 log_name
= os
.path
.join(parsed
.logs
, "%s-%s-%s.log" %
423 (time
.strftime("%Y%m%d-%H%M%S"), type(target
).__name
__, name
))
424 log_fd
= open(log_name
, 'w')
425 print "Running %s > %s ..." % (name
, log_name
),
427 log_fd
.write("Test: %s\n" % name
)
428 log_fd
.write("Target: %s\n" % type(target
).__name
__)
430 real_stdout
= sys
.stdout
433 result
= instance
.run()
434 log_fd
.write("Result: %s\n" % result
)
436 sys
.stdout
= real_stdout
437 log_fd
.write("Time elapsed: %.2fs\n" % (time
.time() - start
))
438 print "%s in %.2fs" % (result
, time
.time() - start
)
439 if result
not in good_results
and parsed
.print_failures
:
440 sys
.stdout
.write(open(log_name
).read())
442 results
.setdefault(result
, []).append((name
, log_name
))
444 if result
not in good_results
and parsed
.fail_fast
:
447 return results
, count
449 def print_results(results
):
451 for key
, value
in results
.iteritems():
452 print "%d tests returned %s" % (len(value
), key
)
453 if key
not in good_results
:
455 for name
, log_name
in value
:
456 print " %s > %s" % (name
, log_name
)
460 def add_test_run_options(parser
):
461 parser
.add_argument("--logs", default
="logs",
462 help="Store logs in the specified directory.")
463 parser
.add_argument("--fail-fast", "-f", action
="store_true",
464 help="Exit as soon as any test fails.")
465 parser
.add_argument("--print-failures", action
="store_true",
466 help="When a test fails, print the log file to stdout.")
467 parser
.add_argument("test", nargs
='*',
468 help="Run only tests that are named here.")
469 parser
.add_argument("--gdb",
470 help="The command to use to start gdb.")
471 parser
.add_argument("--misaval",
472 help="Don't run ExamineTarget, just assume the misa value which is "
475 def header(title
, dash
='-', length
=78):
477 dashes
= dash
* (length
- 4 - len(title
))
478 before
= dashes
[:len(dashes
)/2]
479 after
= dashes
[len(dashes
)/2:]
480 print "%s[ %s ]%s" % (before
, title
, after
)
486 lines
= open(path
, "r").readlines()
491 class BaseTest(object):
494 def __init__(self
, target
):
497 self
.target_process
= None
502 def early_applicable(self
):
503 """Return a false value if the test has determined it cannot run
504 without ever needing to talk to the target or server."""
505 # pylint: disable=no-self-use
512 compile_args
= getattr(self
, 'compile_args', None)
514 if compile_args
not in BaseTest
.compiled
:
515 # pylint: disable=star-args
516 BaseTest
.compiled
[compile_args
] = \
517 self
.target
.compile(*compile_args
)
518 self
.binary
= BaseTest
.compiled
.get(compile_args
)
520 def classSetup(self
):
522 self
.target_process
= self
.target
.create()
523 if self
.target_process
:
524 self
.logs
.append(self
.target_process
.logname
)
526 self
.server
= self
.target
.server()
527 self
.logs
.append(self
.server
.logname
)
529 for log
in self
.logs
:
533 def classTeardown(self
):
535 del self
.target_process
539 If compile_args is set, compile a program and set self.binary.
543 Then call test() and return the result, displaying relevant information
544 if an exception is raised.
549 if not self
.early_applicable():
550 return "not_applicable"
552 self
.start
= time
.time()
557 result
= self
.test() # pylint: disable=no-member
558 except TestNotApplicable
:
559 result
= "not_applicable"
560 except Exception as e
: # pylint: disable=broad-except
561 if isinstance(e
, TestFailed
):
565 if isinstance(e
, TestFailed
):
569 traceback
.print_exc(file=sys
.stdout
)
573 for log
in self
.logs
:
575 header("End of logs")
583 class GdbTest(BaseTest
):
584 def __init__(self
, target
):
585 BaseTest
.__init
__(self
, target
)
588 def classSetup(self
):
589 BaseTest
.classSetup(self
)
592 self
.gdb
= Gdb(gdb_cmd
)
596 self
.logs
.append(self
.gdb
.logname
)
599 self
.gdb
.command("file %s" % self
.binary
)
601 self
.gdb
.command("set arch riscv:rv%d" % self
.target
.xlen
)
602 self
.gdb
.command("set remotetimeout %d" % self
.target
.timeout_sec
)
605 "target extended-remote localhost:%d" % self
.server
.port
)
606 # Select a random thread.
607 # TODO: Allow a command line option to force a specific thread.
608 thread
= random
.choice(self
.gdb
.threads())
609 self
.gdb
.thread(thread
)
611 for cmd
in self
.target
.gdb_setup
:
612 self
.gdb
.command(cmd
)
614 # FIXME: OpenOCD doesn't handle PRIV now
615 #self.gdb.p("$priv=3")
617 def classTeardown(self
):
619 BaseTest
.classTeardown(self
)
621 class ExamineTarget(GdbTest
):
623 self
.target
.misa
= self
.gdb
.p("$misa")
626 if (self
.target
.misa
>> 30) == 1:
628 elif (self
.target
.misa
>> 62) == 2:
630 elif (self
.target
.misa
>> 126) == 3:
633 raise TestFailed("Couldn't determine XLEN from $misa (0x%x)" %
637 if self
.target
.misa
& (1<<i
):
638 txt
+= chr(i
+ ord('A'))
641 class TestFailed(Exception):
642 def __init__(self
, message
):
643 Exception.__init
__(self
)
644 self
.message
= message
646 class TestNotApplicable(Exception):
647 def __init__(self
, message
):
648 Exception.__init
__(self
)
649 self
.message
= message
651 def assertEqual(a
, b
):
653 raise TestFailed("%r != %r" % (a
, b
))
655 def assertNotEqual(a
, b
):
657 raise TestFailed("%r == %r" % (a
, b
))
661 raise TestFailed("%r not in %r" % (a
, b
))
663 def assertNotIn(a
, b
):
665 raise TestFailed("%r in %r" % (a
, b
))
667 def assertGreater(a
, b
):
669 raise TestFailed("%r not greater than %r" % (a
, b
))
671 def assertLess(a
, b
):
673 raise TestFailed("%r not less than %r" % (a
, b
))
677 raise TestFailed("%r is not True" % a
)
679 def assertRegexpMatches(text
, regexp
):
680 if not re
.search(regexp
, text
):
681 raise TestFailed("can't find %r in %r" % (regexp
, text
))