Make tests work with broken 32-bit compiler.
[riscv-tests.git] / debug / testlib.py
1 import os.path
2 import pexpect
3 import shlex
4 import subprocess
5 import tempfile
6 import testlib
7 import unittest
8
9 # Note that gdb comes with its own testsuite. I was unable to figure out how to
10 # run that testsuite against the spike simulator.
11
12 def find_file(path):
13 for directory in (os.getcwd(), os.path.dirname(testlib.__file__)):
14 fullpath = os.path.join(directory, path)
15 if os.path.exists(fullpath):
16 return fullpath
17 return None
18
19 def compile(args, xlen=32):
20 """Compile a single .c file into a binary."""
21 dst = os.path.splitext(args[0])[0]
22 cc = os.path.expandvars("$RISCV/bin/riscv%d-unknown-elf-gcc" % xlen)
23 cmd = [cc, "-g", "-o", dst]
24 for arg in args:
25 found = find_file(arg)
26 if found:
27 cmd.append(found)
28 else:
29 cmd.append(arg)
30 cmd = " ".join(cmd)
31 result = os.system(cmd)
32 assert result == 0, "%r failed" % cmd
33 return dst
34
35 def unused_port():
36 # http://stackoverflow.com/questions/2838244/get-open-tcp-port-in-python/2838309#2838309
37 import socket
38 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
39 s.bind(("",0))
40 port = s.getsockname()[1]
41 s.close()
42 return port
43
44 class Spike(object):
45 def __init__(self, cmd, binary=None, halted=False, with_gdb=True, timeout=None,
46 xlen=64):
47 """Launch spike. Return tuple of its process and the port it's running on."""
48 if cmd:
49 cmd = shlex.split(cmd)
50 else:
51 cmd = ["spike"]
52 if (xlen == 32):
53 cmd += ["--isa", "RV32"]
54
55 if timeout:
56 cmd = ["timeout", str(timeout)] + cmd
57
58 if halted:
59 cmd.append('-H')
60 if with_gdb:
61 self.port = unused_port()
62 cmd += ['--gdb-port', str(self.port)]
63 cmd.append('pk')
64 if binary:
65 cmd.append(binary)
66 logfile = open("spike.log", "w")
67 logfile.write("+ %s\n" % " ".join(cmd))
68 self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=logfile,
69 stderr=logfile)
70
71 def __del__(self):
72 try:
73 self.process.kill()
74 self.process.wait()
75 except OSError:
76 pass
77
78 def wait(self, *args, **kwargs):
79 return self.process.wait(*args, **kwargs)
80
81 class Openocd(object):
82 def __init__(self, cmd=None, config=None, debug=True):
83 if cmd:
84 cmd = shlex.split(cmd)
85 else:
86 cmd = ["openocd"]
87 if config:
88 cmd += ["-f", find_file(config)]
89 if debug:
90 cmd.append("-d")
91 logfile = open("openocd.log", "w")
92 self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=logfile,
93 stderr=logfile)
94 # TODO: Pick a random port
95 self.port = 3333
96
97 def __del__(self):
98 try:
99 self.process.kill()
100 self.process.wait()
101 except OSError:
102 pass
103
104 class Gdb(object):
105 def __init__(self):
106 path = os.path.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb")
107 self.child = pexpect.spawn(path)
108 self.child.logfile = file("gdb.log", "w")
109 self.wait()
110 self.command("set confirm off")
111 self.command("set width 0")
112 self.command("set height 0")
113 # Force consistency.
114 self.command("set print entry-values no")
115
116 def wait(self):
117 """Wait for prompt."""
118 self.child.expect("\(gdb\)")
119
120 def command(self, command, timeout=-1):
121 self.child.sendline(command)
122 self.child.expect("\n", timeout=timeout)
123 self.child.expect("\(gdb\)", timeout=timeout)
124 return self.child.before.strip()
125
126 def c(self, wait=True):
127 if wait:
128 output = self.command("c")
129 assert "Continuing" in output
130 return output
131 else:
132 self.child.sendline("c")
133 self.child.expect("Continuing")
134
135 def interrupt(self):
136 self.child.send("\003");
137 self.child.expect("\(gdb\)")
138 return self.child.before.strip()
139
140 def x(self, address, size='w'):
141 output = self.command("x/%s %s" % (size, address))
142 value = int(output.split(':')[1].strip(), 0)
143 return value
144
145 def p(self, obj):
146 output = self.command("p/x %s" % obj)
147 value = int(output.split('=')[-1].strip(), 0)
148 return value
149
150 def stepi(self):
151 output = self.command("stepi")
152 assert "Cannot" not in output
153 return output
154
155 def load(self):
156 output = self.command("load")
157 assert "failed" not in output
158 assert "Transfer rate" in output
159
160 def b(self, location):
161 output = self.command("b %s" % location)
162 assert "not defined" not in output
163 assert "Breakpoint" in output
164 return output