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 relpath
= os
.path
.relpath(fullpath
)
21 if len(relpath
) >= len(fullpath
):
23 if os
.path
.exists(relpath
):
27 def compile(args
, xlen
=32): # pylint: disable=redefined-builtin
28 cc
= os
.path
.expandvars("$RISCV/bin/riscv64-unknown-elf-gcc")
31 cmd
.append("-march=rv32imac")
32 cmd
.append("-mabi=ilp32")
34 cmd
.append("-march=rv64imac")
35 cmd
.append("-mabi=lp64")
37 found
= find_file(arg
)
43 print "+", " ".join(cmd
)
44 process
= subprocess
.Popen(cmd
, stdout
=subprocess
.PIPE
,
45 stderr
=subprocess
.PIPE
)
46 stdout
, stderr
= process
.communicate()
47 if process
.returncode
:
51 raise Exception("Compile failed!")
54 # http://stackoverflow.com/questions/2838244/get-open-tcp-port-in-python/2838309#2838309
56 s
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
58 port
= s
.getsockname()[1]
63 logname
= "spike-%d.log" % os
.getpid()
65 def __init__(self
, target
, halted
=False, timeout
=None, with_jtag_gdb
=True):
66 """Launch spike. Return tuple of its process and the port it's running
76 cmd
= shlex
.split(target
.sim_cmd
)
78 spike
= os
.path
.expandvars("$RISCV/bin/spike")
81 cmd
+= ["-p%d" % len(harts
)]
83 assert len(set(t
.xlen
for t
in harts
)) == 1, \
84 "All spike harts must have the same XLEN"
86 if harts
[0].xlen
== 32:
87 cmd
+= ["--isa", "RV32G"]
89 cmd
+= ["--isa", "RV64G"]
91 assert len(set(t
.ram
for t
in harts
)) == 1, \
92 "All spike harts must have the same RAM layout"
93 assert len(set(t
.ram_size
for t
in harts
)) == 1, \
94 "All spike harts must have the same RAM layout"
95 cmd
+= ["-m0x%x:0x%x" % (harts
[0].ram
, harts
[0].ram_size
)]
98 cmd
= ["timeout", str(timeout
)] + cmd
103 cmd
+= ['--rbb-port', '0']
104 os
.environ
['REMOTE_BITBANG_HOST'] = 'localhost'
105 self
.infinite_loop
= target
.compile(harts
[0],
106 "programs/checksum.c", "programs/tiny-malloc.c",
107 "programs/infinite_loop.S", "-DDEFINE_MALLOC", "-DDEFINE_FREE")
108 cmd
.append(self
.infinite_loop
)
109 logfile
= open(self
.logname
, "w")
110 logfile
.write("+ %s\n" % " ".join(cmd
))
112 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
113 stdout
=logfile
, stderr
=logfile
)
118 m
= re
.search(r
"Listening for remote bitbang connection on "
119 r
"port (\d+).", open(self
.logname
).read())
121 self
.port
= int(m
.group(1))
122 os
.environ
['REMOTE_BITBANG_PORT'] = m
.group(1)
125 assert self
.port
, "Didn't get spike message about bitbang " \
136 def wait(self
, *args
, **kwargs
):
137 return self
.process
.wait(*args
, **kwargs
)
139 class VcsSim(object):
142 def __init__(self
, sim_cmd
=None, debug
=False):
144 cmd
= shlex
.split(sim_cmd
)
147 cmd
+= ["+jtag_vpi_enable"]
149 cmd
[0] = cmd
[0] + "-debug"
150 cmd
+= ["+vcdplusfile=output/gdbserver.vpd"]
151 logfile
= open(self
.logname
, "w")
152 logfile
.write("+ %s\n" % " ".join(cmd
))
154 listenfile
= open(self
.logname
, "r")
155 listenfile
.seek(0, 2)
156 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
157 stdout
=logfile
, stderr
=logfile
)
160 # Fail if VCS exits early
161 exit_code
= self
.process
.poll()
162 if exit_code
is not None:
163 raise RuntimeError('VCS simulator exited early with status %d'
166 line
= listenfile
.readline()
169 match
= re
.match(r
"^Listening on port (\d+)$", line
)
172 self
.port
= int(match
.group(1))
173 os
.environ
['JTAG_VPI_PORT'] = str(self
.port
)
182 class Openocd(object):
183 logfile
= tempfile
.NamedTemporaryFile(prefix
='openocd', suffix
='.log')
184 logname
= logfile
.name
185 print "OpenOCD Temporary Log File: %s" % logname
187 def __init__(self
, server_cmd
=None, config
=None, debug
=False, timeout
=60):
188 self
.timeout
= timeout
191 cmd
= shlex
.split(server_cmd
)
193 openocd
= os
.path
.expandvars("$RISCV/bin/openocd")
198 # This command needs to come before any config scripts on the command
199 # line, since they are executed in order.
201 # Tell OpenOCD to bind gdb to an unused, ephemeral port.
204 # Disable tcl and telnet servers, since they are unused and because
205 # the port numbers will conflict if multiple OpenOCD processes are
206 # running on the same server.
210 "telnet_port disabled",
214 f
= find_file(config
)
216 print "Unable to read file " + config
223 logfile
= open(Openocd
.logname
, "w")
224 logfile
.write("+ %s\n" % " ".join(cmd
))
229 self
.process
= self
.start(cmd
, logfile
)
231 def start(self
, cmd
, logfile
):
232 process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
233 stdout
=logfile
, stderr
=logfile
)
236 # Wait for OpenOCD to have made it through riscv_examine(). When
237 # using OpenOCD to communicate with a simulator this may take a
238 # long time, and gdb will time out when trying to connect if we
243 log
= open(Openocd
.logname
).read()
244 m
= re
.search(r
"Listening on port (\d+) for gdb connections",
248 self
.port
= int(m
.group(1))
249 self
.ports
.append(int(m
.group(1)))
251 if "telnet server disabled" in log
:
254 if not process
.poll() is None:
256 "OpenOCD exited before completing riscv_examine()")
257 if not messaged
and time
.time() - start
> 1:
259 print "Waiting for OpenOCD to start..."
260 if (time
.time() - start
) > self
.timeout
:
261 raise Exception("ERROR: Timed out waiting for OpenOCD to "
265 header("OpenOCD log")
266 sys
.stdout
.write(log
)
273 except (OSError, AttributeError):
276 class OpenocdCli(object):
277 def __init__(self
, port
=4444):
278 self
.child
= pexpect
.spawn(
279 "sh -c 'telnet localhost %d | tee openocd-cli.log'" % port
)
280 self
.child
.expect("> ")
282 def command(self
, cmd
):
283 self
.child
.sendline(cmd
)
284 self
.child
.expect(cmd
)
285 self
.child
.expect("\n")
286 self
.child
.expect("> ")
287 return self
.child
.before
.strip("\t\r\n \0")
289 def reg(self
, reg
=''):
290 output
= self
.command("reg %s" % reg
)
291 matches
= re
.findall(r
"(\w+) \(/\d+\): (0x[0-9A-F]+)", output
)
292 values
= {r
: int(v
, 0) for r
, v
in matches
}
297 def load_image(self
, image
):
298 output
= self
.command("load_image %s" % image
)
299 if 'invalid ELF file, only 32bits files are supported' in output
:
300 raise TestNotApplicable(output
)
302 class CannotAccess(Exception):
303 def __init__(self
, address
):
304 Exception.__init
__(self
)
305 self
.address
= address
307 Thread
= collections
.namedtuple('Thread', ('id', 'target_id', 'name',
311 logfile
= tempfile
.NamedTemporaryFile(prefix
="gdb", suffix
=".log")
312 logname
= logfile
.name
313 print "GDB Temporary Log File: %s" % logname
316 cmd
=os
.path
.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")):
317 self
.child
= pexpect
.spawn(cmd
)
318 self
.child
.logfile
= open(self
.logname
, "w")
319 self
.child
.logfile
.write("+ %s\n" % cmd
)
321 self
.command("set confirm off")
322 self
.command("set width 0")
323 self
.command("set height 0")
325 self
.command("set print entry-values no")
327 def select_hart(self
, hart
):
328 output
= self
.command("thread %d" % (hart
.index
+ 1))
329 assert "Unknown" not in output
332 """Wait for prompt."""
333 self
.child
.expect(r
"\(gdb\)")
335 def command(self
, command
, timeout
=6000):
336 """timeout is in seconds"""
337 self
.child
.sendline(command
)
338 self
.child
.expect("\n", timeout
=timeout
)
339 self
.child
.expect(r
"\(gdb\)", timeout
=timeout
)
340 return self
.child
.before
.strip()
342 def c(self
, wait
=True, timeout
=-1, async=False):
348 output
= self
.command("c%s" % async, timeout
=timeout
)
349 assert "Continuing" in output
352 self
.child
.sendline("c%s" % async)
353 self
.child
.expect("Continuing")
356 self
.child
.send("\003")
357 self
.child
.expect(r
"\(gdb\)", timeout
=6000)
358 return self
.child
.before
.strip()
360 def x(self
, address
, size
='w'):
361 output
= self
.command("x/%s %s" % (size
, address
))
362 value
= int(output
.split(':')[1].strip(), 0)
365 def p_raw(self
, obj
):
366 output
= self
.command("p %s" % obj
)
367 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
369 raise CannotAccess(int(m
.group(1), 0))
370 return output
.split('=')[-1].strip()
372 def parse_string(self
, text
):
374 if text
.startswith("{") and text
.endswith("}"):
376 return [self
.parse_string(t
) for t
in inner
.split(", ")]
377 elif text
.startswith('"') and text
.endswith('"'):
382 def p(self
, obj
, fmt
="/x"):
383 output
= self
.command("p%s %s" % (fmt
, obj
))
384 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
386 raise CannotAccess(int(m
.group(1), 0))
387 rhs
= output
.split('=')[-1]
388 return self
.parse_string(rhs
)
390 def p_string(self
, obj
):
391 output
= self
.command("p %s" % obj
)
392 value
= shlex
.split(output
.split('=')[-1].strip())[1]
396 output
= self
.command("stepi", timeout
=60)
400 output
= self
.command("load", timeout
=6000)
401 assert "failed" not in output
402 assert "Transfer rate" in output
404 def b(self
, location
):
405 output
= self
.command("b %s" % location
)
406 assert "not defined" not in output
407 assert "Breakpoint" in output
410 def hbreak(self
, location
):
411 output
= self
.command("hbreak %s" % location
)
412 assert "not defined" not in output
413 assert "Hardware assisted breakpoint" in output
417 output
= self
.command("info threads")
419 for line
in output
.splitlines():
421 r
"[\s\*]*(\d+)\s*Thread (\d+)\s*\(Name: ([^\)]+)\s*(.*)",
424 threads
.append(Thread(*m
.groups()))
426 threads
.append(Thread('1', '1', 'Default', '???'))
429 def thread(self
, thread
):
430 return self
.command("thread %s" % thread
.id)
432 def run_all_tests(module
, target
, parsed
):
433 if not os
.path
.exists(parsed
.logs
):
434 os
.makedirs(parsed
.logs
)
436 overall_start
= time
.time()
438 global gdb_cmd
# pylint: disable=global-statement
442 for hart
in target
.harts
:
444 hart
.misa
= int(parsed
.misaval
, 16)
445 print "Using $misa from command line: 0x%x" % hart
.misa
447 print "Using $misa from hart definition: 0x%x" % hart
.misa
449 todo
.append(("ExamineTarget", ExamineTarget
, hart
))
451 for name
in dir(module
):
452 definition
= getattr(module
, name
)
453 if type(definition
) == type and hasattr(definition
, 'test') and \
454 (not parsed
.test
or any(test
in name
for test
in parsed
.test
)):
455 todo
.append((name
, definition
, None))
457 results
, count
= run_tests(parsed
, target
, todo
)
459 header("ran %d tests in %.0fs" % (count
, time
.time() - overall_start
),
462 return print_results(results
)
464 good_results
= set(('pass', 'not_applicable'))
465 def run_tests(parsed
, target
, todo
):
469 for name
, definition
, hart
in todo
:
470 log_name
= os
.path
.join(parsed
.logs
, "%s-%s-%s.log" %
471 (time
.strftime("%Y%m%d-%H%M%S"), type(target
).__name
__, name
))
472 log_fd
= open(log_name
, 'w')
473 print "Running %s > %s ..." % (name
, log_name
),
474 instance
= definition(target
, hart
)
476 log_fd
.write("Test: %s\n" % name
)
477 log_fd
.write("Target: %s\n" % type(target
).__name
__)
479 real_stdout
= sys
.stdout
482 result
= instance
.run()
483 log_fd
.write("Result: %s\n" % result
)
485 sys
.stdout
= real_stdout
486 log_fd
.write("Time elapsed: %.2fs\n" % (time
.time() - start
))
487 print "%s in %.2fs" % (result
, time
.time() - start
)
488 if result
not in good_results
and parsed
.print_failures
:
489 sys
.stdout
.write(open(log_name
).read())
491 results
.setdefault(result
, []).append((name
, log_name
))
493 if result
not in good_results
and parsed
.fail_fast
:
496 return results
, count
498 def print_results(results
):
500 for key
, value
in results
.iteritems():
501 print "%d tests returned %s" % (len(value
), key
)
502 if key
not in good_results
:
504 for name
, log_name
in value
:
505 print " %s > %s" % (name
, log_name
)
509 def add_test_run_options(parser
):
510 parser
.add_argument("--logs", default
="logs",
511 help="Store logs in the specified directory.")
512 parser
.add_argument("--fail-fast", "-f", action
="store_true",
513 help="Exit as soon as any test fails.")
514 parser
.add_argument("--print-failures", action
="store_true",
515 help="When a test fails, print the log file to stdout.")
516 parser
.add_argument("test", nargs
='*',
517 help="Run only tests that are named here.")
518 parser
.add_argument("--gdb",
519 help="The command to use to start gdb.")
520 parser
.add_argument("--misaval",
521 help="Don't run ExamineTarget, just assume the misa value which is "
524 def header(title
, dash
='-', length
=78):
526 dashes
= dash
* (length
- 4 - len(title
))
527 before
= dashes
[:len(dashes
)/2]
528 after
= dashes
[len(dashes
)/2:]
529 print "%s[ %s ]%s" % (before
, title
, after
)
535 lines
= open(path
, "r").readlines()
540 class BaseTest(object):
543 def __init__(self
, target
, hart
=None):
548 self
.hart
= random
.choice(target
.harts
)
549 self
.hart
= target
.harts
[-1] #<<<
551 self
.target_process
= None
556 def early_applicable(self
):
557 """Return a false value if the test has determined it cannot run
558 without ever needing to talk to the target or server."""
559 # pylint: disable=no-self-use
566 compile_args
= getattr(self
, 'compile_args', None)
568 if compile_args
not in BaseTest
.compiled
:
569 # pylint: disable=star-args
570 BaseTest
.compiled
[compile_args
] = \
571 self
.target
.compile(self
.hart
, *compile_args
)
572 self
.binary
= BaseTest
.compiled
.get(compile_args
)
574 def classSetup(self
):
576 self
.target_process
= self
.target
.create()
577 if self
.target_process
:
578 self
.logs
.append(self
.target_process
.logname
)
580 self
.server
= self
.target
.server()
581 self
.logs
.append(self
.server
.logname
)
583 for log
in self
.logs
:
587 def classTeardown(self
):
589 del self
.target_process
591 def postMortem(self
):
596 If compile_args is set, compile a program and set self.binary.
600 Then call test() and return the result, displaying relevant information
601 if an exception is raised.
606 if not self
.early_applicable():
607 return "not_applicable"
609 self
.start
= time
.time()
614 result
= self
.test() # pylint: disable=no-member
615 except TestNotApplicable
:
616 result
= "not_applicable"
617 except Exception as e
: # pylint: disable=broad-except
618 if isinstance(e
, TestFailed
):
622 if isinstance(e
, TestFailed
):
626 traceback
.print_exc(file=sys
.stdout
)
631 for log
in self
.logs
:
633 header("End of logs")
641 class GdbTest(BaseTest
):
642 def __init__(self
, target
, hart
=None):
643 BaseTest
.__init
__(self
, target
, hart
=hart
)
646 def classSetup(self
):
647 BaseTest
.classSetup(self
)
650 self
.gdb
= Gdb(gdb_cmd
)
654 self
.logs
.append(self
.gdb
.logname
)
657 self
.gdb
.command("file %s" % self
.binary
)
659 self
.gdb
.command("set arch riscv:rv%d" % self
.hart
.xlen
)
660 self
.gdb
.command("set remotetimeout %d" % self
.target
.timeout_sec
)
663 "target extended-remote localhost:%d" % self
.server
.port
)
664 self
.gdb
.select_hart(self
.hart
)
666 for cmd
in self
.target
.gdb_setup
:
667 self
.gdb
.command(cmd
)
669 # FIXME: OpenOCD doesn't handle PRIV now
670 #self.gdb.p("$priv=3")
672 def postMortem(self
):
676 self
.gdb
.command("info registers all", timeout
=10)
678 def classTeardown(self
):
680 BaseTest
.classTeardown(self
)
682 class GdbSingleHartTest(GdbTest
):
683 def classSetup(self
):
684 GdbTest
.classSetup(self
)
686 for hart
in self
.target
.harts
:
687 # Park all harts that we're not using in a safe place.
688 if hart
!= self
.hart
:
689 self
.gdb
.select_hart(hart
)
690 self
.gdb
.p("$pc=loop_forever")
691 self
.gdb
.select_hart(self
.hart
)
693 class ExamineTarget(GdbTest
):
695 self
.target
.misa
= self
.gdb
.p("$misa")
698 if (self
.target
.misa
>> 30) == 1:
700 elif (self
.target
.misa
>> 62) == 2:
702 elif (self
.target
.misa
>> 126) == 3:
705 raise TestFailed("Couldn't determine XLEN from $misa (0x%x)" %
709 if self
.target
.misa
& (1<<i
):
710 txt
+= chr(i
+ ord('A'))
713 class TestFailed(Exception):
714 def __init__(self
, message
):
715 Exception.__init
__(self
)
716 self
.message
= message
718 class TestNotApplicable(Exception):
719 def __init__(self
, message
):
720 Exception.__init
__(self
)
721 self
.message
= message
723 def assertEqual(a
, b
):
725 raise TestFailed("%r != %r" % (a
, b
))
727 def assertNotEqual(a
, b
):
729 raise TestFailed("%r == %r" % (a
, b
))
733 raise TestFailed("%r not in %r" % (a
, b
))
735 def assertNotIn(a
, b
):
737 raise TestFailed("%r in %r" % (a
, b
))
739 def assertGreater(a
, b
):
741 raise TestFailed("%r not greater than %r" % (a
, b
))
743 def assertLess(a
, b
):
745 raise TestFailed("%r not less than %r" % (a
, b
))
749 raise TestFailed("%r is not True" % a
)
751 def assertRegexpMatches(text
, regexp
):
752 if not re
.search(regexp
, text
):
753 raise TestFailed("can't find %r in %r" % (regexp
, text
))