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 match
= re
.match(r
"^Listening on port (\d+)$", line
)
110 self
.port
= int(match
.group(1))
111 os
.environ
['JTAG_VPI_PORT'] = str(self
.port
)
120 class Openocd(object):
121 logname
= "openocd.log"
123 def __init__(self
, cmd
=None, config
=None, debug
=False):
125 cmd
= shlex
.split(cmd
)
129 cmd
+= ["-f", find_file(config
)]
133 # This command needs to come before any config scripts on the command
134 # line, since they are executed in order.
135 # Tell OpenOCD to bind to an unused port.
136 cmd
[1:1] = ["--command", "gdb_port %d" % 0]
138 logfile
= open(Openocd
.logname
, "w")
139 logfile
.write("+ %s\n" % " ".join(cmd
))
141 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
142 stdout
=logfile
, stderr
=logfile
)
144 # Wait for OpenOCD to have made it through riscv_examine(). When using
145 # OpenOCD to communicate with a simulator this may take a long time,
146 # and gdb will time out when trying to connect if we attempt too early.
150 log
= open(Openocd
.logname
).read()
151 if "Examined RISCV core" in log
:
153 if not self
.process
.poll() is None:
155 "OpenOCD exited before completing riscv_examine()")
156 if not messaged
and time
.time() - start
> 1:
158 print "Waiting for OpenOCD to examine RISCV core..."
160 self
.port
= self
._get
_gdb
_server
_port
()
162 def _get_gdb_server_port(self
):
163 """Get port that OpenOCD's gdb server is listening on."""
165 PORT_REGEX
= re
.compile(r
'(?P<port>\d+) \(LISTEN\)')
166 for _
in range(MAX_ATTEMPTS
):
167 with
open(os
.devnull
, 'w') as devnull
:
168 output
= subprocess
.check_output([
170 '-a', # Take the AND of the following selectors
171 '-p{}'.format(self
.process
.pid
), # Filter on PID
172 '-iTCP', # Filter only TCP sockets
174 matches
= list(PORT_REGEX
.finditer(output
))
177 "OpenOCD listening on multiple ports. Cannot uniquely "
178 "identify gdb server port.")
181 return int(match
.group('port'))
183 raise Exception("Timed out waiting for gdb server to obtain port.")
192 class OpenocdCli(object):
193 def __init__(self
, port
=4444):
194 self
.child
= pexpect
.spawn(
195 "sh -c 'telnet localhost %d | tee openocd-cli.log'" % port
)
196 self
.child
.expect("> ")
198 def command(self
, cmd
):
199 self
.child
.sendline(cmd
)
200 self
.child
.expect(cmd
)
201 self
.child
.expect("\n")
202 self
.child
.expect("> ")
203 return self
.child
.before
.strip("\t\r\n \0")
205 def reg(self
, reg
=''):
206 output
= self
.command("reg %s" % reg
)
207 matches
= re
.findall(r
"(\w+) \(/\d+\): (0x[0-9A-F]+)", output
)
208 values
= {r
: int(v
, 0) for r
, v
in matches
}
213 def load_image(self
, image
):
214 output
= self
.command("load_image %s" % image
)
215 if 'invalid ELF file, only 32bits files are supported' in output
:
216 raise TestNotApplicable(output
)
218 class CannotAccess(Exception):
219 def __init__(self
, address
):
220 Exception.__init
__(self
)
221 self
.address
= address
225 cmd
=os
.path
.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")):
226 self
.child
= pexpect
.spawn(cmd
)
227 self
.child
.logfile
= open("gdb.log", "w")
228 self
.child
.logfile
.write("+ %s\n" % cmd
)
230 self
.command("set confirm off")
231 self
.command("set width 0")
232 self
.command("set height 0")
234 self
.command("set print entry-values no")
237 """Wait for prompt."""
238 self
.child
.expect(r
"\(gdb\)")
240 def command(self
, command
, timeout
=-1):
241 self
.child
.sendline(command
)
242 self
.child
.expect("\n", timeout
=timeout
)
243 self
.child
.expect(r
"\(gdb\)", timeout
=timeout
)
244 return self
.child
.before
.strip()
246 def c(self
, wait
=True):
248 output
= self
.command("c")
249 assert "Continuing" in output
252 self
.child
.sendline("c")
253 self
.child
.expect("Continuing")
256 self
.child
.send("\003")
257 self
.child
.expect(r
"\(gdb\)", timeout
=60)
258 return self
.child
.before
.strip()
260 def x(self
, address
, size
='w'):
261 output
= self
.command("x/%s %s" % (size
, address
))
262 value
= int(output
.split(':')[1].strip(), 0)
265 def p_raw(self
, obj
):
266 output
= self
.command("p %s" % obj
)
267 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
269 raise CannotAccess(int(m
.group(1), 0))
270 return output
.split('=')[-1].strip()
273 output
= self
.command("p/x %s" % obj
)
274 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
276 raise CannotAccess(int(m
.group(1), 0))
277 value
= int(output
.split('=')[-1].strip(), 0)
280 def p_string(self
, obj
):
281 output
= self
.command("p %s" % obj
)
282 value
= shlex
.split(output
.split('=')[-1].strip())[1]
286 output
= self
.command("stepi")
290 output
= self
.command("load", timeout
=60)
291 assert "failed" not in output
292 assert "Transfer rate" in output
294 def b(self
, location
):
295 output
= self
.command("b %s" % location
)
296 assert "not defined" not in output
297 assert "Breakpoint" in output
300 def hbreak(self
, location
):
301 output
= self
.command("hbreak %s" % location
)
302 assert "not defined" not in output
303 assert "Hardware assisted breakpoint" in output
306 def run_all_tests(module
, target
, tests
, fail_fast
):
307 good_results
= set(('pass', 'not_applicable'))
313 for name
in dir(module
):
314 definition
= getattr(module
, name
)
315 if type(definition
) == type and hasattr(definition
, 'test') and \
316 (not tests
or any(test
in name
for test
in tests
)):
317 instance
= definition(target
)
318 result
= instance
.run()
319 results
.setdefault(result
, []).append(name
)
321 if result
not in good_results
and fail_fast
:
324 header("ran %d tests in %.0fs" % (count
, time
.time() - start
), dash
=':')
327 for key
, value
in results
.iteritems():
328 print "%d tests returned %s" % (len(value
), key
)
329 if key
not in good_results
:
336 def add_test_run_options(parser
):
337 parser
.add_argument("--fail-fast", "-f", action
="store_true",
338 help="Exit as soon as any test fails.")
339 parser
.add_argument("test", nargs
='*',
340 help="Run only tests that are named here.")
342 def header(title
, dash
='-'):
343 dashes
= dash
* (36 - len(title
))
344 before
= dashes
[:len(dashes
)/2]
345 after
= dashes
[len(dashes
)/2:]
346 print "%s[ %s ]%s" % (before
, title
, after
)
348 class BaseTest(object):
352 def __init__(self
, target
):
355 self
.target_process
= None
359 def early_applicable(self
):
360 """Return a false value if the test has determined it cannot run
361 without ever needing to talk to the target or server."""
362 # pylint: disable=no-self-use
369 compile_args
= getattr(self
, 'compile_args', None)
371 if compile_args
not in BaseTest
.compiled
:
373 # pylint: disable=star-args
374 BaseTest
.compiled
[compile_args
] = \
375 self
.target
.compile(*compile_args
)
376 except Exception: # pylint: disable=broad-except
377 print "exception while compiling in %.2fs" % (
378 time
.time() - self
.start
)
381 traceback
.print_exc(file=sys
.stdout
)
384 self
.binary
= BaseTest
.compiled
.get(compile_args
)
386 def classSetup(self
):
388 self
.target_process
= self
.target
.target()
389 self
.server
= self
.target
.server()
390 self
.logs
.append(self
.server
.logname
)
392 def classTeardown(self
):
394 del self
.target_process
398 If compile_args is set, compile a program and set self.binary.
402 Then call test() and return the result, displaying relevant information
403 if an exception is raised.
406 print "Running", type(self
).__name
__, "...",
409 if not self
.early_applicable():
410 print "not_applicable"
411 return "not_applicable"
413 self
.start
= time
.time()
419 result
= self
.test() # pylint: disable=no-member
420 except TestNotApplicable
:
421 result
= "not_applicable"
422 except Exception as e
: # pylint: disable=broad-except
423 if isinstance(e
, TestFailed
):
427 print "%s in %.2fs" % (result
, time
.time() - self
.start
)
429 if isinstance(e
, TestFailed
):
433 traceback
.print_exc(file=sys
.stdout
)
434 for log
in self
.logs
:
436 print open(log
, "r").read()
445 print "%s in %.2fs" % (result
, time
.time() - self
.start
)
448 class TestFailed(Exception):
449 def __init__(self
, message
):
450 Exception.__init
__(self
)
451 self
.message
= message
453 class TestNotApplicable(Exception):
454 def __init__(self
, message
):
455 Exception.__init
__(self
)
456 self
.message
= message
458 def assertEqual(a
, b
):
460 raise TestFailed("%r != %r" % (a
, b
))
462 def assertNotEqual(a
, b
):
464 raise TestFailed("%r == %r" % (a
, b
))
468 raise TestFailed("%r not in %r" % (a
, b
))
470 def assertNotIn(a
, b
):
472 raise TestFailed("%r in %r" % (a
, b
))
474 def assertGreater(a
, b
):
476 raise TestFailed("%r not greater than %r" % (a
, b
))
478 def assertLess(a
, b
):
480 raise TestFailed("%r not less than %r" % (a
, b
))
484 raise TestFailed("%r is not True" % a
)
486 def assertRegexpMatches(text
, regexp
):
487 if not re
.search(regexp
, text
):
488 raise TestFailed("can't find %r in %r" % (regexp
, text
))