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
, cmd
, binary
=None, halted
=False, with_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(cmd
)
69 cmd
+= ["--isa", "RV32"]
72 cmd
= ["timeout", str(timeout
)] + cmd
77 self
.port
= unused_port()
78 cmd
+= ['--gdb-port', str(self
.port
)]
83 logfile
= open(self
.logname
, "w")
84 logfile
.write("+ %s\n" % " ".join(cmd
))
86 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
87 stdout
=logfile
, stderr
=logfile
)
96 def wait(self
, *args
, **kwargs
):
97 return self
.process
.wait(*args
, **kwargs
)
100 def __init__(self
, simv
=None, debug
=False):
102 cmd
= shlex
.split(simv
)
105 cmd
+= ["+jtag_vpi_enable"]
107 cmd
[0] = cmd
[0] + "-debug"
108 cmd
+= ["+vcdplusfile=output/gdbserver.vpd"]
109 logfile
= open("simv.log", "w")
110 logfile
.write("+ %s\n" % " ".join(cmd
))
112 listenfile
= open("simv.log", "r")
113 listenfile
.seek(0, 2)
114 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
115 stdout
=logfile
, stderr
=logfile
)
118 line
= listenfile
.readline()
121 match
= re
.match(r
"^Listening on port (\d+)$", line
)
124 self
.port
= int(match
.group(1))
125 os
.environ
['JTAG_VPI_PORT'] = str(self
.port
)
134 class Openocd(object):
135 logname
= "openocd.log"
137 def __init__(self
, cmd
=None, config
=None, debug
=False):
139 cmd
= shlex
.split(cmd
)
143 cmd
+= ["-f", find_file(config
)]
147 # This command needs to come before any config scripts on the command
148 # line, since they are executed in order.
150 # Tell OpenOCD to bind gdb to an unused, ephemeral port.
153 # Disable tcl and telnet servers, since they are unused and because
154 # the port numbers will conflict if multiple OpenOCD processes are
155 # running on the same server.
159 "telnet_port disabled",
162 logfile
= open(Openocd
.logname
, "w")
163 logfile
.write("+ %s\n" % " ".join(cmd
))
165 self
.process
= subprocess
.Popen(cmd
, stdin
=subprocess
.PIPE
,
166 stdout
=logfile
, stderr
=logfile
)
168 # Wait for OpenOCD to have made it through riscv_examine(). When using
169 # OpenOCD to communicate with a simulator this may take a long time,
170 # and gdb will time out when trying to connect if we attempt too early.
174 log
= open(Openocd
.logname
).read()
175 if "OK GO NOW" in log
:
177 if not self
.process
.poll() is None:
179 "OpenOCD exited before completing riscv_examine()")
180 if not messaged
and time
.time() - start
> 1:
182 print "Waiting for OpenOCD to examine RISCV core..."
184 self
.port
= self
._get
_gdb
_server
_port
()
186 def _get_gdb_server_port(self
):
187 """Get port that OpenOCD's gdb server is listening on."""
189 PORT_REGEX
= re
.compile(r
'(?P<port>\d+) \(LISTEN\)')
190 for _
in range(MAX_ATTEMPTS
):
191 with
open(os
.devnull
, 'w') as devnull
:
193 output
= subprocess
.check_output([
195 '-a', # Take the AND of the following selectors
196 '-p{}'.format(self
.process
.pid
), # Filter on PID
197 '-iTCP', # Filter only TCP sockets
199 except subprocess
.CalledProcessError
:
201 matches
= list(PORT_REGEX
.finditer(output
))
202 matches
= [m
for m
in matches
203 if m
.group('port') not in ('6666', '4444')]
207 "OpenOCD listening on multiple ports. Cannot uniquely "
208 "identify gdb server port.")
211 return int(match
.group('port'))
213 raise Exception("Timed out waiting for gdb server to obtain port.")
222 class OpenocdCli(object):
223 def __init__(self
, port
=4444):
224 self
.child
= pexpect
.spawn(
225 "sh -c 'telnet localhost %d | tee openocd-cli.log'" % port
)
226 self
.child
.expect("> ")
228 def command(self
, cmd
):
229 self
.child
.sendline(cmd
)
230 self
.child
.expect(cmd
)
231 self
.child
.expect("\n")
232 self
.child
.expect("> ")
233 return self
.child
.before
.strip("\t\r\n \0")
235 def reg(self
, reg
=''):
236 output
= self
.command("reg %s" % reg
)
237 matches
= re
.findall(r
"(\w+) \(/\d+\): (0x[0-9A-F]+)", output
)
238 values
= {r
: int(v
, 0) for r
, v
in matches
}
243 def load_image(self
, image
):
244 output
= self
.command("load_image %s" % image
)
245 if 'invalid ELF file, only 32bits files are supported' in output
:
246 raise TestNotApplicable(output
)
248 class CannotAccess(Exception):
249 def __init__(self
, address
):
250 Exception.__init
__(self
)
251 self
.address
= address
255 cmd
=os
.path
.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")):
256 self
.child
= pexpect
.spawn(cmd
)
257 self
.child
.logfile
= open("gdb.log", "w")
258 self
.child
.logfile
.write("+ %s\n" % cmd
)
260 self
.command("set confirm off")
261 self
.command("set width 0")
262 self
.command("set height 0")
264 self
.command("set print entry-values no")
267 """Wait for prompt."""
268 self
.child
.expect(r
"\(gdb\)")
270 def command(self
, command
, timeout
=6000):
271 self
.child
.sendline(command
)
272 self
.child
.expect("\n", timeout
=timeout
)
273 self
.child
.expect(r
"\(gdb\)", timeout
=timeout
)
274 return self
.child
.before
.strip()
276 def c(self
, wait
=True):
278 output
= self
.command("c")
279 assert "Continuing" in output
282 self
.child
.sendline("c")
283 self
.child
.expect("Continuing")
286 self
.child
.send("\003")
287 self
.child
.expect(r
"\(gdb\)", timeout
=6000)
288 return self
.child
.before
.strip()
290 def x(self
, address
, size
='w'):
291 output
= self
.command("x/%s %s" % (size
, address
))
292 value
= int(output
.split(':')[1].strip(), 0)
295 def p_raw(self
, obj
):
296 output
= self
.command("p %s" % obj
)
297 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
299 raise CannotAccess(int(m
.group(1), 0))
300 return output
.split('=')[-1].strip()
303 output
= self
.command("p/x %s" % obj
)
304 m
= re
.search("Cannot access memory at address (0x[0-9a-f]+)", output
)
306 raise CannotAccess(int(m
.group(1), 0))
307 value
= int(output
.split('=')[-1].strip(), 0)
310 def p_string(self
, obj
):
311 output
= self
.command("p %s" % obj
)
312 value
= shlex
.split(output
.split('=')[-1].strip())[1]
316 output
= self
.command("stepi")
320 output
= self
.command("load", timeout
=6000)
321 assert "failed" not in output
322 assert "Transfer rate" in output
324 def b(self
, location
):
325 output
= self
.command("b %s" % location
)
326 assert "not defined" not in output
327 assert "Breakpoint" in output
330 def hbreak(self
, location
):
331 output
= self
.command("hbreak %s" % location
)
332 assert "not defined" not in output
333 assert "Hardware assisted breakpoint" in output
336 def run_all_tests(module
, target
, parsed
):
337 good_results
= set(('pass', 'not_applicable'))
344 global gdb_cmd
# pylint: disable=global-statement
347 todo
= [("ExamineTarget", ExamineTarget
)]
348 for name
in dir(module
):
349 definition
= getattr(module
, name
)
350 if type(definition
) == type and hasattr(definition
, 'test') and \
351 (not parsed
.test
or any(test
in name
for test
in parsed
.test
)):
352 todo
.append((name
, definition
))
354 for name
, definition
in todo
:
355 instance
= definition(target
)
356 result
= instance
.run()
357 results
.setdefault(result
, []).append(name
)
359 if result
not in good_results
and parsed
.fail_fast
:
362 header("ran %d tests in %.0fs" % (count
, time
.time() - start
), dash
=':')
365 for key
, value
in results
.iteritems():
366 print "%d tests returned %s" % (len(value
), key
)
367 if key
not in good_results
:
374 def add_test_run_options(parser
):
375 parser
.add_argument("--fail-fast", "-f", action
="store_true",
376 help="Exit as soon as any test fails.")
377 parser
.add_argument("test", nargs
='*',
378 help="Run only tests that are named here.")
379 parser
.add_argument("--gdb",
380 help="The command to use to start gdb.")
382 def header(title
, dash
='-'):
384 dashes
= dash
* (36 - len(title
))
385 before
= dashes
[:len(dashes
)/2]
386 after
= dashes
[len(dashes
)/2:]
387 print "%s[ %s ]%s" % (before
, title
, after
)
393 lines
= open(path
, "r").readlines()
394 if len(lines
) > 1000:
395 for l
in lines
[:500]:
398 for l
in lines
[-500:]:
404 class BaseTest(object):
407 def __init__(self
, target
):
410 self
.target_process
= None
415 def early_applicable(self
):
416 """Return a false value if the test has determined it cannot run
417 without ever needing to talk to the target or server."""
418 # pylint: disable=no-self-use
425 compile_args
= getattr(self
, 'compile_args', None)
427 if compile_args
not in BaseTest
.compiled
:
428 # pylint: disable=star-args
429 BaseTest
.compiled
[compile_args
] = \
430 self
.target
.compile(*compile_args
)
431 self
.binary
= BaseTest
.compiled
.get(compile_args
)
433 def classSetup(self
):
435 self
.target_process
= self
.target
.target()
436 self
.server
= self
.target
.server()
437 self
.logs
.append(self
.server
.logname
)
439 def classTeardown(self
):
441 del self
.target_process
445 If compile_args is set, compile a program and set self.binary.
449 Then call test() and return the result, displaying relevant information
450 if an exception is raised.
453 print "Running", type(self
).__name
__, "...",
456 if not self
.early_applicable():
457 print "not_applicable"
458 return "not_applicable"
460 self
.start
= time
.time()
466 result
= self
.test() # pylint: disable=no-member
467 except TestNotApplicable
:
468 result
= "not_applicable"
469 except Exception as e
: # pylint: disable=broad-except
470 if isinstance(e
, TestFailed
):
474 print "%s in %.2fs" % (result
, time
.time() - self
.start
)
476 if isinstance(e
, TestFailed
):
480 traceback
.print_exc(file=sys
.stdout
)
481 for log
in self
.logs
:
491 print "%s in %.2fs" % (result
, time
.time() - self
.start
)
495 class GdbTest(BaseTest
):
496 def __init__(self
, target
):
497 BaseTest
.__init
__(self
, target
)
500 def classSetup(self
):
501 BaseTest
.classSetup(self
)
502 self
.logs
.append("gdb.log")
505 self
.gdb
= Gdb(gdb_cmd
)
510 self
.gdb
.command("file %s" % self
.binary
)
512 self
.gdb
.command("set arch riscv:rv%d" % self
.target
.xlen
)
513 self
.gdb
.command("set remotetimeout %d" % self
.target
.timeout_sec
)
516 "target extended-remote localhost:%d" % self
.server
.port
)
518 self
.gdb
.p("$priv=3")
520 def classTeardown(self
):
522 BaseTest
.classTeardown(self
)
524 class ExamineTarget(GdbTest
):
526 self
.target
.misa
= self
.gdb
.p("$misa")
529 if (self
.target
.misa
>> 30) == 1:
531 elif (self
.target
.misa
>> 62) == 2:
533 elif (self
.target
.misa
>> 126) == 3:
539 if self
.target
.misa
& (1<<i
):
540 txt
+= chr(i
+ ord('A'))
543 class TestFailed(Exception):
544 def __init__(self
, message
):
545 Exception.__init
__(self
)
546 self
.message
= message
548 class TestNotApplicable(Exception):
549 def __init__(self
, message
):
550 Exception.__init
__(self
)
551 self
.message
= message
553 def assertEqual(a
, b
):
555 raise TestFailed("%r != %r" % (a
, b
))
557 def assertNotEqual(a
, b
):
559 raise TestFailed("%r == %r" % (a
, b
))
563 raise TestFailed("%r not in %r" % (a
, b
))
565 def assertNotIn(a
, b
):
567 raise TestFailed("%r in %r" % (a
, b
))
569 def assertGreater(a
, b
):
571 raise TestFailed("%r not greater than %r" % (a
, b
))
573 def assertLess(a
, b
):
575 raise TestFailed("%r not less than %r" % (a
, b
))
579 raise TestFailed("%r is not True" % a
)
581 def assertRegexpMatches(text
, regexp
):
582 if not re
.search(regexp
, text
):
583 raise TestFailed("can't find %r in %r" % (regexp
, text
))