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
)
31 result
= os
.system(cmd
)
32 assert result
== 0, "%r failed" % cmd
35 # http://stackoverflow.com/questions/2838244/get-open-tcp-port-in-python/2838309#2838309
37 s
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
39 port
= s
.getsockname()[1]
46 def __init__(self
, cmd
, binary
=None, halted
=False, with_gdb
=True,
47 timeout
=None, xlen
=64):
48 """Launch spike. Return tuple of its process and the port it's running
51 cmd
= shlex
.split(cmd
)
55 cmd
+= ["--isa", "RV32"]
58 cmd
= ["timeout", str(timeout
)] + cmd
63 self
.port
= unused_port()
64 cmd
+= ['--gdb-port', str(self
.port
)]
69 logfile
= open(self
.logname
, "w")
70 logfile
.write("+ %s\n" % " ".join(cmd
))
72 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
73 stdout
=logfile
, stderr
=logfile
)
82 def wait(self
, *args
, **kwargs
):
83 return self
.process
.wait(*args
, **kwargs
)
86 def __init__(self
, simv
=None, debug
=False):
88 cmd
= shlex
.split(simv
)
91 cmd
+= ["+jtag_vpi_enable"]
93 cmd
[0] = cmd
[0] + "-debug"
94 cmd
+= ["+vcdplusfile=output/gdbserver.vpd"]
95 logfile
= open("simv.log", "w")
96 logfile
.write("+ %s\n" % " ".join(cmd
))
98 listenfile
= open("simv.log", "r")
100 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
101 stdout
=logfile
, stderr
=logfile
)
104 line
= listenfile
.readline()
107 if "Listening on port 5555" in line
:
117 class Openocd(object):
118 logname
= "openocd.log"
120 def __init__(self
, cmd
=None, config
=None, debug
=False):
122 cmd
= shlex
.split(cmd
)
126 cmd
+= ["-f", find_file(config
)]
129 logfile
= open(Openocd
.logname
, "w")
130 logfile
.write("+ %s\n" % " ".join(cmd
))
132 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
133 stdout
=logfile
, stderr
=logfile
)
134 # TODO: Pick a random port
137 # Wait for OpenOCD to have made it through riscv_examine(). When using
138 # OpenOCD to communicate with a simulator this may take a long time,
139 # and gdb will time out when trying to connect if we attempt too early.
143 log
= open(Openocd
.logname
).read()
144 if "Examined RISCV core" in log
:
146 if not self
.process
.poll() is None:
148 "OpenOCD exited before completing riscv_examine()")
149 if not messaged
and time
.time() - start
> 1:
151 print "Waiting for OpenOCD to examine RISCV core..."
160 class OpenocdCli(object):
161 def __init__(self
, port
=4444):
162 self
.child
= pexpect
.spawn("sh -c 'telnet localhost %d | tee openocd-cli.log'" % port
)
163 self
.child
.expect("> ")
165 def command(self
, cmd
):
166 self
.child
.sendline(cmd
)
167 self
.child
.expect("\n")
168 self
.child
.expect("> ")
169 return self
.child
.before
.strip()
171 class CannotAccess(Exception):
172 def __init__(self
, address
):
173 Exception.__init
__(self
)
174 self
.address
= address
178 cmd
=os
.path
.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")):
179 self
.child
= pexpect
.spawn(cmd
)
180 self
.child
.logfile
= open("gdb.log", "w")
181 self
.child
.logfile
.write("+ %s\n" % cmd
)
183 self
.command("set confirm off")
184 self
.command("set width 0")
185 self
.command("set height 0")
187 self
.command("set print entry-values no")
190 """Wait for prompt."""
191 self
.child
.expect(r
"\(gdb\)")
193 def command(self
, command
, timeout
=-1):
194 self
.child
.sendline(command
)
195 self
.child
.expect("\n", timeout
=timeout
)
196 self
.child
.expect(r
"\(gdb\)", timeout
=timeout
)
197 return self
.child
.before
.strip()
199 def c(self
, wait
=True):
201 output
= self
.command("c")
202 assert "Continuing" in output
205 self
.child
.sendline("c")
206 self
.child
.expect("Continuing")
209 self
.child
.send("\003")
210 self
.child
.expect(r
"\(gdb\)", timeout
=60)
211 return self
.child
.before
.strip()
213 def x(self
, address
, size
='w'):
214 output
= self
.command("x/%s %s" % (size
, address
))
215 value
= int(output
.split(':')[1].strip(), 0)
219 output
= self
.command("p/x %s" % obj
)
220 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
222 raise CannotAccess(int(m
.group(1), 0))
223 value
= int(output
.split('=')[-1].strip(), 0)
226 def p_string(self
, obj
):
227 output
= self
.command("p %s" % obj
)
228 value
= shlex
.split(output
.split('=')[-1].strip())[1]
232 output
= self
.command("stepi")
236 output
= self
.command("load", timeout
=60)
237 assert "failed" not in output
238 assert "Transfer rate" in output
240 def b(self
, location
):
241 output
= self
.command("b %s" % location
)
242 assert "not defined" not in output
243 assert "Breakpoint" in output
246 def hbreak(self
, location
):
247 output
= self
.command("hbreak %s" % location
)
248 assert "not defined" not in output
249 assert "Hardware assisted breakpoint" in output
252 def run_all_tests(module
, target
, tests
, fail_fast
):
253 good_results
= set(('pass', 'not_applicable'))
259 for name
in dir(module
):
260 definition
= getattr(module
, name
)
261 if type(definition
) == type and hasattr(definition
, 'test') and \
262 (not tests
or any(test
in name
for test
in tests
)):
263 instance
= definition(target
)
264 result
= instance
.run()
265 results
.setdefault(result
, []).append(name
)
267 if result
not in good_results
and fail_fast
:
270 header("ran %d tests in %.0fs" % (count
, time
.time() - start
), dash
=':')
273 for key
, value
in results
.iteritems():
274 print "%d tests returned %s" % (len(value
), key
)
275 if key
not in good_results
:
282 def add_test_run_options(parser
):
283 parser
.add_argument("--fail-fast", "-f", action
="store_true",
284 help="Exit as soon as any test fails.")
285 parser
.add_argument("test", nargs
='*',
286 help="Run only tests that are named here.")
288 def header(title
, dash
='-'):
289 dashes
= dash
* (36 - len(title
))
290 before
= dashes
[:len(dashes
)/2]
291 after
= dashes
[len(dashes
)/2:]
292 print "%s[ %s ]%s" % (before
, title
, after
)
294 class BaseTest(object):
298 def __init__(self
, target
):
301 self
.target_process
= None
305 def early_applicable(self
):
306 """Return a false value if the test has determined it cannot run
307 without ever needing to talk to the target or server."""
308 # pylint: disable=no-self-use
315 compile_args
= getattr(self
, 'compile_args', None)
317 if compile_args
not in BaseTest
.compiled
:
319 # pylint: disable=star-args
320 BaseTest
.compiled
[compile_args
] = \
321 self
.target
.compile(*compile_args
)
322 except Exception: # pylint: disable=broad-except
323 print "exception while compiling in %.2fs" % (
324 time
.time() - self
.start
)
327 traceback
.print_exc(file=sys
.stdout
)
330 self
.binary
= BaseTest
.compiled
.get(compile_args
)
332 def classSetup(self
):
334 self
.target_process
= self
.target
.target()
335 self
.server
= self
.target
.server()
336 self
.logs
.append(self
.server
.logname
)
338 def classTeardown(self
):
340 del self
.target_process
344 If compile_args is set, compile a program and set self.binary.
348 Then call test() and return the result, displaying relevant information
349 if an exception is raised.
352 print "Running", type(self
).__name
__, "...",
355 if not self
.early_applicable():
356 print "not_applicable"
357 return "not_applicable"
359 self
.start
= time
.time()
365 result
= self
.test() # pylint: disable=no-member
366 except Exception as e
: # pylint: disable=broad-except
367 if isinstance(e
, TestFailed
):
371 print "%s in %.2fs" % (result
, time
.time() - self
.start
)
373 if isinstance(e
, TestFailed
):
377 traceback
.print_exc(file=sys
.stdout
)
378 for log
in self
.logs
:
380 print open(log
, "r").read()
389 print "%s in %.2fs" % (result
, time
.time() - self
.start
)
392 class TestFailed(Exception):
393 def __init__(self
, message
):
394 Exception.__init
__(self
)
395 self
.message
= message
397 def assertEqual(a
, b
):
399 raise TestFailed("%r != %r" % (a
, b
))
401 def assertNotEqual(a
, b
):
403 raise TestFailed("%r == %r" % (a
, b
))
407 raise TestFailed("%r not in %r" % (a
, b
))
409 def assertNotIn(a
, b
):
411 raise TestFailed("%r in %r" % (a
, b
))
413 def assertGreater(a
, b
):
415 raise TestFailed("%r not greater than %r" % (a
, b
))
419 raise TestFailed("%r is not True" % a
)
421 def assertRegexpMatches(text
, regexp
):
422 if not re
.search(regexp
, text
):
423 raise TestFailed("can't find %r in %r" % (regexp
, text
))