86095e38c8fc88cd4f4889f2deb904c3adbd8801
11 # Note that gdb comes with its own testsuite. I was unable to figure out how to
12 # run that testsuite against the spike simulator.
15 for directory
in (os
.getcwd(), os
.path
.dirname(__file__
)):
16 fullpath
= os
.path
.join(directory
, path
)
17 if os
.path
.exists(fullpath
):
21 def compile(args
, xlen
=32): # pylint: disable=redefined-builtin
22 cc
= os
.path
.expandvars("$RISCV/bin/riscv64-unknown-elf-gcc")
25 cmd
.append("-march=rv32imac")
26 cmd
.append("-mabi=ilp32")
28 cmd
.append("-march=rv64imac")
29 cmd
.append("-mabi=lp64")
31 found
= find_file(arg
)
36 process
= subprocess
.Popen(cmd
, stdout
=subprocess
.PIPE
,
37 stderr
=subprocess
.PIPE
)
38 stdout
, stderr
= process
.communicate()
39 if process
.returncode
:
41 header("Compile failed")
42 print "+", " ".join(cmd
)
46 raise Exception("Compile failed!")
49 # http://stackoverflow.com/questions/2838244/get-open-tcp-port-in-python/2838309#2838309
51 s
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
53 port
= s
.getsockname()[1]
60 def __init__(self
, sim_cmd
, binary
=None, halted
=False, with_jtag_gdb
=True,
61 timeout
=None, xlen
=64):
62 """Launch spike. Return tuple of its process and the port it's running
65 cmd
= shlex
.split(sim_cmd
)
67 spike
= os
.path
.expandvars("$RISCV/bin/spike")
70 cmd
+= ["--isa", "RV32G"]
72 cmd
+= ["--isa", "RV64G"]
75 cmd
= ["timeout", str(timeout
)] + cmd
77 cmd
+= ["-m0x10000000:0x10000000"]
82 cmd
+= ['--rbb-port', '0']
83 os
.environ
['REMOTE_BITBANG_HOST'] = 'localhost'
84 cmd
.append('programs/infinite_loop')
87 logfile
= open(self
.logname
, "w")
88 logfile
.write("+ %s\n" % " ".join(cmd
))
90 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
91 stdout
=logfile
, stderr
=logfile
)
96 m
= re
.search(r
"Listening for remote bitbang connection on "
97 r
"port (\d+).", open(self
.logname
).read())
99 self
.port
= int(m
.group(1))
100 os
.environ
['REMOTE_BITBANG_PORT'] = m
.group(1)
103 assert self
.port
, "Didn't get spike message about bitbang " \
113 def wait(self
, *args
, **kwargs
):
114 return self
.process
.wait(*args
, **kwargs
)
116 class VcsSim(object):
117 def __init__(self
, sim_cmd
=None, debug
=False):
119 cmd
= shlex
.split(sim_cmd
)
122 cmd
+= ["+jtag_vpi_enable"]
124 cmd
[0] = cmd
[0] + "-debug"
125 cmd
+= ["+vcdplusfile=output/gdbserver.vpd"]
126 logfile
= open("simv.log", "w")
127 logfile
.write("+ %s\n" % " ".join(cmd
))
129 listenfile
= open("simv.log", "r")
130 listenfile
.seek(0, 2)
131 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
132 stdout
=logfile
, stderr
=logfile
)
135 line
= listenfile
.readline()
138 match
= re
.match(r
"^Listening on port (\d+)$", line
)
141 self
.port
= int(match
.group(1))
142 os
.environ
['JTAG_VPI_PORT'] = str(self
.port
)
151 class Openocd(object):
152 logname
= "openocd.log"
154 def __init__(self
, server_cmd
=None, config
=None, debug
=False):
156 cmd
= shlex
.split(server_cmd
)
158 openocd
= os
.path
.expandvars("$RISCV/bin/riscv-openocd")
163 # This command needs to come before any config scripts on the command
164 # line, since they are executed in order.
166 # Tell OpenOCD to bind gdb to an unused, ephemeral port.
169 # Disable tcl and telnet servers, since they are unused and because
170 # the port numbers will conflict if multiple OpenOCD processes are
171 # running on the same server.
175 "telnet_port disabled",
179 f
= find_file(config
)
181 print("Unable to read file " + config
)
188 logfile
= open(Openocd
.logname
, "w")
189 logfile
.write("+ %s\n" % " ".join(cmd
))
191 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
192 stdout
=logfile
, stderr
=logfile
)
194 # Wait for OpenOCD to have made it through riscv_examine(). When using
195 # OpenOCD to communicate with a simulator this may take a long time,
196 # and gdb will time out when trying to connect if we attempt too early.
200 log
= open(Openocd
.logname
).read()
201 if "Ready for Remote Connections" in log
:
203 if not self
.process
.poll() is None:
205 "OpenOCD exited before completing riscv_examine()")
206 if not messaged
and time
.time() - start
> 1:
208 print "Waiting for OpenOCD to examine RISCV core..."
210 self
.port
= self
._get
_gdb
_server
_port
()
212 def _get_gdb_server_port(self
):
213 """Get port that OpenOCD's gdb server is listening on."""
215 PORT_REGEX
= re
.compile(r
'(?P<port>\d+) \(LISTEN\)')
216 for _
in range(MAX_ATTEMPTS
):
217 with
open(os
.devnull
, 'w') as devnull
:
219 output
= subprocess
.check_output([
221 '-a', # Take the AND of the following selectors
222 '-p{}'.format(self
.process
.pid
), # Filter on PID
223 '-iTCP', # Filter only TCP sockets
225 except subprocess
.CalledProcessError
:
227 matches
= list(PORT_REGEX
.finditer(output
))
228 matches
= [m
for m
in matches
229 if m
.group('port') not in ('6666', '4444')]
233 "OpenOCD listening on multiple ports. Cannot uniquely "
234 "identify gdb server port.")
237 return int(match
.group('port'))
239 raise Exception("Timed out waiting for gdb server to obtain port.")
248 class OpenocdCli(object):
249 def __init__(self
, port
=4444):
250 self
.child
= pexpect
.spawn(
251 "sh -c 'telnet localhost %d | tee openocd-cli.log'" % port
)
252 self
.child
.expect("> ")
254 def command(self
, cmd
):
255 self
.child
.sendline(cmd
)
256 self
.child
.expect(cmd
)
257 self
.child
.expect("\n")
258 self
.child
.expect("> ")
259 return self
.child
.before
.strip("\t\r\n \0")
261 def reg(self
, reg
=''):
262 output
= self
.command("reg %s" % reg
)
263 matches
= re
.findall(r
"(\w+) \(/\d+\): (0x[0-9A-F]+)", output
)
264 values
= {r
: int(v
, 0) for r
, v
in matches
}
269 def load_image(self
, image
):
270 output
= self
.command("load_image %s" % image
)
271 if 'invalid ELF file, only 32bits files are supported' in output
:
272 raise TestNotApplicable(output
)
274 class CannotAccess(Exception):
275 def __init__(self
, address
):
276 Exception.__init
__(self
)
277 self
.address
= address
281 cmd
=os
.path
.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")):
282 self
.child
= pexpect
.spawn(cmd
)
283 self
.child
.logfile
= open("gdb.log", "w")
284 self
.child
.logfile
.write("+ %s\n" % cmd
)
286 self
.command("set confirm off")
287 self
.command("set width 0")
288 self
.command("set height 0")
290 self
.command("set print entry-values no")
293 """Wait for prompt."""
294 self
.child
.expect(r
"\(gdb\)")
296 def command(self
, command
, timeout
=6000):
297 self
.child
.sendline(command
)
298 self
.child
.expect("\n", timeout
=timeout
)
299 self
.child
.expect(r
"\(gdb\)", timeout
=timeout
)
300 return self
.child
.before
.strip()
302 def c(self
, wait
=True, timeout
=-1):
304 output
= self
.command("c", timeout
=timeout
)
305 assert "Continuing" in output
308 self
.child
.sendline("c")
309 self
.child
.expect("Continuing")
312 self
.child
.send("\003")
313 self
.child
.expect(r
"\(gdb\)", timeout
=6000)
314 return self
.child
.before
.strip()
316 def x(self
, address
, size
='w'):
317 output
= self
.command("x/%s %s" % (size
, address
))
318 value
= int(output
.split(':')[1].strip(), 0)
321 def p_raw(self
, obj
):
322 output
= self
.command("p %s" % obj
)
323 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
325 raise CannotAccess(int(m
.group(1), 0))
326 return output
.split('=')[-1].strip()
329 output
= self
.command("p/x %s" % obj
)
330 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
332 raise CannotAccess(int(m
.group(1), 0))
333 value
= int(output
.split('=')[-1].strip(), 0)
336 def p_string(self
, obj
):
337 output
= self
.command("p %s" % obj
)
338 value
= shlex
.split(output
.split('=')[-1].strip())[1]
342 output
= self
.command("stepi")
346 output
= self
.command("load", timeout
=6000)
347 assert "failed" not in output
348 assert "Transfer rate" in output
350 def b(self
, location
):
351 output
= self
.command("b %s" % location
)
352 assert "not defined" not in output
353 assert "Breakpoint" in output
356 def hbreak(self
, location
):
357 output
= self
.command("hbreak %s" % location
)
358 assert "not defined" not in output
359 assert "Hardware assisted breakpoint" in output
362 def run_all_tests(module
, target
, parsed
):
363 good_results
= set(('pass', 'not_applicable'))
370 global gdb_cmd
# pylint: disable=global-statement
375 self
.target
.misa
= parsed
.misa
377 todo
.append(("ExamineTarget", ExamineTarget
))
379 for name
in dir(module
):
380 definition
= getattr(module
, name
)
381 if type(definition
) == type and hasattr(definition
, 'test') and \
382 (not parsed
.test
or any(test
in name
for test
in parsed
.test
)):
383 todo
.append((name
, definition
))
385 for name
, definition
in todo
:
386 instance
= definition(target
)
387 result
= instance
.run()
388 results
.setdefault(result
, []).append(name
)
390 if result
not in good_results
and parsed
.fail_fast
:
393 header("ran %d tests in %.0fs" % (count
, time
.time() - start
), dash
=':')
396 for key
, value
in results
.iteritems():
397 print "%d tests returned %s" % (len(value
), key
)
398 if key
not in good_results
:
405 def add_test_run_options(parser
):
406 parser
.add_argument("--fail-fast", "-f", action
="store_true",
407 help="Exit as soon as any test fails.")
408 parser
.add_argument("test", nargs
='*',
409 help="Run only tests that are named here.")
410 parser
.add_argument("--gdb",
411 help="The command to use to start gdb.")
412 parser
.add_argument("--misa", "-m",
413 help="Don't run ExamineTarget, just assume the misa which is specified.")
415 def header(title
, dash
='-'):
417 dashes
= dash
* (36 - len(title
))
418 before
= dashes
[:len(dashes
)/2]
419 after
= dashes
[len(dashes
)/2:]
420 print "%s[ %s ]%s" % (before
, title
, after
)
426 lines
= open(path
, "r").readlines()
427 if len(lines
) > 1000:
428 for l
in lines
[:500]:
431 for l
in lines
[-500:]:
437 class BaseTest(object):
440 def __init__(self
, target
):
443 self
.target_process
= None
448 def early_applicable(self
):
449 """Return a false value if the test has determined it cannot run
450 without ever needing to talk to the target or server."""
451 # pylint: disable=no-self-use
458 compile_args
= getattr(self
, 'compile_args', None)
460 if compile_args
not in BaseTest
.compiled
:
461 # pylint: disable=star-args
462 BaseTest
.compiled
[compile_args
] = \
463 self
.target
.compile(*compile_args
)
464 self
.binary
= BaseTest
.compiled
.get(compile_args
)
466 def classSetup(self
):
468 self
.target_process
= self
.target
.target()
469 self
.server
= self
.target
.server()
470 self
.logs
.append(self
.server
.logname
)
472 def classTeardown(self
):
474 del self
.target_process
478 If compile_args is set, compile a program and set self.binary.
482 Then call test() and return the result, displaying relevant information
483 if an exception is raised.
486 print "Running", type(self
).__name
__, "...",
489 if not self
.early_applicable():
490 print "not_applicable"
491 return "not_applicable"
493 self
.start
= time
.time()
499 result
= self
.test() # pylint: disable=no-member
500 except TestNotApplicable
:
501 result
= "not_applicable"
502 except Exception as e
: # pylint: disable=broad-except
503 if isinstance(e
, TestFailed
):
507 print "%s in %.2fs" % (result
, time
.time() - self
.start
)
509 if isinstance(e
, TestFailed
):
513 traceback
.print_exc(file=sys
.stdout
)
514 for log
in self
.logs
:
524 print "%s in %.2fs" % (result
, time
.time() - self
.start
)
528 class GdbTest(BaseTest
):
529 def __init__(self
, target
):
530 BaseTest
.__init
__(self
, target
)
533 def classSetup(self
):
534 BaseTest
.classSetup(self
)
535 self
.logs
.append("gdb.log")
538 self
.gdb
= Gdb(gdb_cmd
)
543 self
.gdb
.command("file %s" % self
.binary
)
545 self
.gdb
.command("set arch riscv:rv%d" % self
.target
.xlen
)
546 self
.gdb
.command("set remotetimeout %d" % self
.target
.timeout_sec
)
549 "target extended-remote localhost:%d" % self
.server
.port
)
551 # FIXME: OpenOCD doesn't handle PRIV now
552 #self.gdb.p("$priv=3")
554 def classTeardown(self
):
556 BaseTest
.classTeardown(self
)
558 class ExamineTarget(GdbTest
):
560 self
.target
.misa
= self
.gdb
.p("$misa")
563 if (self
.target
.misa
>> 30) == 1:
565 elif (self
.target
.misa
>> 62) == 2:
567 elif (self
.target
.misa
>> 126) == 3:
573 if self
.target
.misa
& (1<<i
):
574 txt
+= chr(i
+ ord('A'))
577 class TestFailed(Exception):
578 def __init__(self
, message
):
579 Exception.__init
__(self
)
580 self
.message
= message
582 class TestNotApplicable(Exception):
583 def __init__(self
, message
):
584 Exception.__init
__(self
)
585 self
.message
= message
587 def assertEqual(a
, b
):
589 raise TestFailed("%r != %r" % (a
, b
))
591 def assertNotEqual(a
, b
):
593 raise TestFailed("%r == %r" % (a
, b
))
597 raise TestFailed("%r not in %r" % (a
, b
))
599 def assertNotIn(a
, b
):
601 raise TestFailed("%r in %r" % (a
, b
))
603 def assertGreater(a
, b
):
605 raise TestFailed("%r not greater than %r" % (a
, b
))
607 def assertLess(a
, b
):
609 raise TestFailed("%r not less than %r" % (a
, b
))
613 raise TestFailed("%r is not True" % a
)
615 def assertRegexpMatches(text
, regexp
):
616 if not re
.search(regexp
, text
):
617 raise TestFailed("can't find %r in %r" % (regexp
, text
))