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/riscv%d-unknown-elf-gcc" % xlen
)
25 found
= find_file(arg
)
30 process
= subprocess
.Popen(cmd
, stdout
=subprocess
.PIPE
,
31 stderr
=subprocess
.PIPE
)
32 stdout
, stderr
= process
.communicate()
33 if process
.returncode
:
35 header("Compile failed")
36 print "+", " ".join(cmd
)
40 raise Exception("Compile failed!")
43 # http://stackoverflow.com/questions/2838244/get-open-tcp-port-in-python/2838309#2838309
45 s
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
47 port
= s
.getsockname()[1]
54 def __init__(self
, cmd
, binary
=None, halted
=False, with_gdb
=True,
55 timeout
=None, xlen
=64):
56 """Launch spike. Return tuple of its process and the port it's running
59 cmd
= shlex
.split(cmd
)
63 cmd
+= ["--isa", "RV32"]
66 cmd
= ["timeout", str(timeout
)] + cmd
71 self
.port
= unused_port()
72 cmd
+= ['--gdb-port', str(self
.port
)]
77 logfile
= open(self
.logname
, "w")
78 logfile
.write("+ %s\n" % " ".join(cmd
))
80 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
81 stdout
=logfile
, stderr
=logfile
)
90 def wait(self
, *args
, **kwargs
):
91 return self
.process
.wait(*args
, **kwargs
)
94 def __init__(self
, simv
=None, debug
=False):
96 cmd
= shlex
.split(simv
)
99 cmd
+= ["+jtag_vpi_enable"]
101 cmd
[0] = cmd
[0] + "-debug"
102 cmd
+= ["+vcdplusfile=output/gdbserver.vpd"]
103 logfile
= open("simv.log", "w")
104 logfile
.write("+ %s\n" % " ".join(cmd
))
106 listenfile
= open("simv.log", "r")
107 listenfile
.seek(0, 2)
108 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
109 stdout
=logfile
, stderr
=logfile
)
112 line
= listenfile
.readline()
115 match
= re
.match(r
"^Listening on port (\d+)$", line
)
118 self
.port
= int(match
.group(1))
119 os
.environ
['JTAG_VPI_PORT'] = str(self
.port
)
128 class Openocd(object):
129 logname
= "openocd.log"
131 def __init__(self
, cmd
=None, config
=None, debug
=False):
133 cmd
= shlex
.split(cmd
)
137 cmd
+= ["-f", find_file(config
)]
141 # This command needs to come before any config scripts on the command
142 # line, since they are executed in order.
143 # Tell OpenOCD to bind to an unused port.
144 cmd
[1:1] = ["--command", "gdb_port %d" % 0]
146 logfile
= open(Openocd
.logname
, "w")
147 logfile
.write("+ %s\n" % " ".join(cmd
))
149 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
150 stdout
=logfile
, stderr
=logfile
)
152 # Wait for OpenOCD to have made it through riscv_examine(). When using
153 # OpenOCD to communicate with a simulator this may take a long time,
154 # and gdb will time out when trying to connect if we attempt too early.
158 log
= open(Openocd
.logname
).read()
159 if "Examined RISCV core" in log
:
161 if not self
.process
.poll() is None:
163 "OpenOCD exited before completing riscv_examine()")
164 if not messaged
and time
.time() - start
> 1:
166 print "Waiting for OpenOCD to examine RISCV core..."
168 self
.port
= self
._get
_gdb
_server
_port
()
170 def _get_gdb_server_port(self
):
171 """Get port that OpenOCD's gdb server is listening on."""
173 PORT_REGEX
= re
.compile(r
'(?P<port>\d+) \(LISTEN\)')
174 for _
in range(MAX_ATTEMPTS
):
175 with
open(os
.devnull
, 'w') as devnull
:
177 output
= subprocess
.check_output([
179 '-a', # Take the AND of the following selectors
180 '-p{}'.format(self
.process
.pid
), # Filter on PID
181 '-iTCP', # Filter only TCP sockets
183 except subprocess
.CalledProcessError
:
185 matches
= list(PORT_REGEX
.finditer(output
))
186 matches
= [m
for m
in matches
187 if m
.group('port') not in ('6666', '4444')]
191 "OpenOCD listening on multiple ports. Cannot uniquely "
192 "identify gdb server port.")
195 return int(match
.group('port'))
197 raise Exception("Timed out waiting for gdb server to obtain port.")
206 class OpenocdCli(object):
207 def __init__(self
, port
=4444):
208 self
.child
= pexpect
.spawn(
209 "sh -c 'telnet localhost %d | tee openocd-cli.log'" % port
)
210 self
.child
.expect("> ")
212 def command(self
, cmd
):
213 self
.child
.sendline(cmd
)
214 self
.child
.expect(cmd
)
215 self
.child
.expect("\n")
216 self
.child
.expect("> ")
217 return self
.child
.before
.strip("\t\r\n \0")
219 def reg(self
, reg
=''):
220 output
= self
.command("reg %s" % reg
)
221 matches
= re
.findall(r
"(\w+) \(/\d+\): (0x[0-9A-F]+)", output
)
222 values
= {r
: int(v
, 0) for r
, v
in matches
}
227 def load_image(self
, image
):
228 output
= self
.command("load_image %s" % image
)
229 if 'invalid ELF file, only 32bits files are supported' in output
:
230 raise TestNotApplicable(output
)
232 class CannotAccess(Exception):
233 def __init__(self
, address
):
234 Exception.__init
__(self
)
235 self
.address
= address
239 cmd
=os
.path
.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")):
240 self
.child
= pexpect
.spawn(cmd
)
241 self
.child
.logfile
= open("gdb.log", "w")
242 self
.child
.logfile
.write("+ %s\n" % cmd
)
244 self
.command("set confirm off")
245 self
.command("set width 0")
246 self
.command("set height 0")
248 self
.command("set print entry-values no")
251 """Wait for prompt."""
252 self
.child
.expect(r
"\(gdb\)")
254 def command(self
, command
, timeout
=-1):
255 self
.child
.sendline(command
)
256 self
.child
.expect("\n", timeout
=timeout
)
257 self
.child
.expect(r
"\(gdb\)", timeout
=timeout
)
258 return self
.child
.before
.strip()
260 def c(self
, wait
=True):
262 output
= self
.command("c")
263 assert "Continuing" in output
266 self
.child
.sendline("c")
267 self
.child
.expect("Continuing")
270 self
.child
.send("\003")
271 self
.child
.expect(r
"\(gdb\)", timeout
=60)
272 return self
.child
.before
.strip()
274 def x(self
, address
, size
='w'):
275 output
= self
.command("x/%s %s" % (size
, address
))
276 value
= int(output
.split(':')[1].strip(), 0)
279 def p_raw(self
, obj
):
280 output
= self
.command("p %s" % obj
)
281 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
283 raise CannotAccess(int(m
.group(1), 0))
284 return output
.split('=')[-1].strip()
287 output
= self
.command("p/x %s" % obj
)
288 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
290 raise CannotAccess(int(m
.group(1), 0))
291 value
= int(output
.split('=')[-1].strip(), 0)
294 def p_string(self
, obj
):
295 output
= self
.command("p %s" % obj
)
296 value
= shlex
.split(output
.split('=')[-1].strip())[1]
300 output
= self
.command("stepi")
304 output
= self
.command("load", timeout
=60)
305 assert "failed" not in output
306 assert "Transfer rate" in output
308 def b(self
, location
):
309 output
= self
.command("b %s" % location
)
310 assert "not defined" not in output
311 assert "Breakpoint" in output
314 def hbreak(self
, location
):
315 output
= self
.command("hbreak %s" % location
)
316 assert "not defined" not in output
317 assert "Hardware assisted breakpoint" in output
320 def run_all_tests(module
, target
, tests
, fail_fast
):
321 good_results
= set(('pass', 'not_applicable'))
327 for name
in dir(module
):
328 definition
= getattr(module
, name
)
329 if type(definition
) == type and hasattr(definition
, 'test') and \
330 (not tests
or any(test
in name
for test
in tests
)):
331 instance
= definition(target
)
332 result
= instance
.run()
333 results
.setdefault(result
, []).append(name
)
335 if result
not in good_results
and fail_fast
:
338 header("ran %d tests in %.0fs" % (count
, time
.time() - start
), dash
=':')
341 for key
, value
in results
.iteritems():
342 print "%d tests returned %s" % (len(value
), key
)
343 if key
not in good_results
:
350 def add_test_run_options(parser
):
351 parser
.add_argument("--fail-fast", "-f", action
="store_true",
352 help="Exit as soon as any test fails.")
353 parser
.add_argument("test", nargs
='*',
354 help="Run only tests that are named here.")
356 def header(title
, dash
='-'):
358 dashes
= dash
* (36 - len(title
))
359 before
= dashes
[:len(dashes
)/2]
360 after
= dashes
[len(dashes
)/2:]
361 print "%s[ %s ]%s" % (before
, title
, after
)
365 class BaseTest(object):
369 def __init__(self
, target
):
372 self
.target_process
= None
376 def early_applicable(self
):
377 """Return a false value if the test has determined it cannot run
378 without ever needing to talk to the target or server."""
379 # pylint: disable=no-self-use
386 compile_args
= getattr(self
, 'compile_args', None)
388 if compile_args
not in BaseTest
.compiled
:
389 # pylint: disable=star-args
390 BaseTest
.compiled
[compile_args
] = \
391 self
.target
.compile(*compile_args
)
392 self
.binary
= BaseTest
.compiled
.get(compile_args
)
394 def classSetup(self
):
396 self
.target_process
= self
.target
.target()
397 self
.server
= self
.target
.server()
398 self
.logs
.append(self
.server
.logname
)
400 def classTeardown(self
):
402 del self
.target_process
406 If compile_args is set, compile a program and set self.binary.
410 Then call test() and return the result, displaying relevant information
411 if an exception is raised.
414 print "Running", type(self
).__name
__, "...",
417 if not self
.early_applicable():
418 print "not_applicable"
419 return "not_applicable"
421 self
.start
= time
.time()
427 result
= self
.test() # pylint: disable=no-member
428 except TestNotApplicable
:
429 result
= "not_applicable"
430 except Exception as e
: # pylint: disable=broad-except
431 if isinstance(e
, TestFailed
):
435 print "%s in %.2fs" % (result
, time
.time() - self
.start
)
437 if isinstance(e
, TestFailed
):
441 traceback
.print_exc(file=sys
.stdout
)
442 for log
in self
.logs
:
444 print open(log
, "r").read()
453 print "%s in %.2fs" % (result
, time
.time() - self
.start
)
456 class TestFailed(Exception):
457 def __init__(self
, message
):
458 Exception.__init
__(self
)
459 self
.message
= message
461 class TestNotApplicable(Exception):
462 def __init__(self
, message
):
463 Exception.__init
__(self
)
464 self
.message
= message
466 def assertEqual(a
, b
):
468 raise TestFailed("%r != %r" % (a
, b
))
470 def assertNotEqual(a
, b
):
472 raise TestFailed("%r == %r" % (a
, b
))
476 raise TestFailed("%r not in %r" % (a
, b
))
478 def assertNotIn(a
, b
):
480 raise TestFailed("%r in %r" % (a
, b
))
482 def assertGreater(a
, b
):
484 raise TestFailed("%r not greater than %r" % (a
, b
))
486 def assertLess(a
, b
):
488 raise TestFailed("%r not less than %r" % (a
, b
))
492 raise TestFailed("%r is not True" % a
)
494 def assertRegexpMatches(text
, regexp
):
495 if not re
.search(regexp
, text
):
496 raise TestFailed("can't find %r in %r" % (regexp
, text
))