1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
|
import collections
import os
import os.path
import random
import re
import shlex
import subprocess
import sys
import tempfile
import time
import traceback
import pipes
import pexpect
print_log_names = False
real_stdout = sys.stdout
# Note that gdb comes with its own testsuite. I was unable to figure out how to
# run that testsuite against the spike simulator.
def find_file(path):
for directory in (os.getcwd(), os.path.dirname(__file__)):
fullpath = os.path.join(directory, path)
relpath = os.path.relpath(fullpath)
if len(relpath) >= len(fullpath):
relpath = fullpath
if os.path.exists(relpath):
return relpath
return None
class CompileError(Exception):
def __init__(self, stdout, stderr):
super().__init__()
self.stdout = stdout
self.stderr = stderr
gcc_cmd = None
def compile(args): # pylint: disable=redefined-builtin
if gcc_cmd:
cmd = [gcc_cmd]
else:
cmd = ["riscv64-unknown-elf-gcc"]
cmd.append("-g")
for arg in args:
found = find_file(arg)
if found:
cmd.append(found)
else:
cmd.append(arg)
header("Compile")
print("+", " ".join(cmd))
process = subprocess.Popen(cmd, stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
stdout, stderr = process.communicate()
if process.returncode:
print(stdout.decode('ascii'), end=" ")
print(stderr.decode('ascii'), end=" ")
header("")
raise CompileError(stdout, stderr)
class Spike:
# pylint: disable=too-many-instance-attributes
# pylint: disable=too-many-locals
def __init__(self, target, halted=False, timeout=None, with_jtag_gdb=True,
isa=None, progbufsize=None, dmi_rti=None, abstract_rti=None,
support_hasel=True, support_abstract_csr=True,
support_haltgroups=True, vlen=128, elen=64, slen=128):
"""Launch spike. Return tuple of its process and the port it's running
on."""
self.process = None
self.isa = isa
self.progbufsize = progbufsize
self.dmi_rti = dmi_rti
self.abstract_rti = abstract_rti
self.support_abstract_csr = support_abstract_csr
self.support_hasel = support_hasel
self.support_haltgroups = support_haltgroups
self.vlen = vlen
self.elen = elen
self.slen = slen
if target.harts:
harts = target.harts
else:
harts = [target]
cmd = self.command(target, harts, halted, timeout, with_jtag_gdb)
self.infinite_loop = target.compile(harts[0],
"programs/checksum.c", "programs/tiny-malloc.c",
"programs/infinite_loop.S", "-DDEFINE_MALLOC", "-DDEFINE_FREE")
cmd.append(self.infinite_loop)
self.logfile = tempfile.NamedTemporaryFile(prefix="spike-",
suffix=".log")
self.logname = self.logfile.name
if print_log_names:
real_stdout.write("Temporary spike log: %s\n" % self.logname)
self.logfile.write(("+ %s\n" % " ".join(cmd)).encode())
self.logfile.flush()
self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE,
stdout=self.logfile, stderr=self.logfile)
if with_jtag_gdb:
self.port = None
for _ in range(30):
m = re.search(r"Listening for remote bitbang connection on "
r"port (\d+).", open(self.logname).read())
if m:
self.port = int(m.group(1))
os.environ['REMOTE_BITBANG_PORT'] = m.group(1)
break
time.sleep(0.11)
if not self.port:
print_log(self.logname)
raise Exception("Didn't get spike message about bitbang "
"connection")
# pylint: disable=too-many-branches
def command(self, target, harts, halted, timeout, with_jtag_gdb):
# pylint: disable=no-self-use
if target.sim_cmd:
cmd = shlex.split(target.sim_cmd)
else:
cmd = ["spike"]
cmd += ["-p%d" % len(harts)]
assert len(set(t.xlen for t in harts)) == 1, \
"All spike harts must have the same XLEN"
if self.isa:
isa = self.isa
else:
isa = "RV%dG" % harts[0].xlen
cmd += ["--isa", isa]
cmd += ["--dm-auth"]
if not self.progbufsize is None:
cmd += ["--dm-progsize", str(self.progbufsize)]
cmd += ["--dm-sba", "32"]
if not self.dmi_rti is None:
cmd += ["--dmi-rti", str(self.dmi_rti)]
if not self.abstract_rti is None:
cmd += ["--dm-abstract-rti", str(self.abstract_rti)]
if not self.support_abstract_csr:
cmd.append("--dm-no-abstract-csr")
if not self.support_hasel:
cmd.append("--dm-no-hasel")
if not self.support_haltgroups:
cmd.append("--dm-no-halt-groups")
if 'V' in isa[2:]:
cmd.append("--varch=vlen:%d,elen:%d,slen:%d" % (self.vlen,
self.elen, self.slen))
assert len(set(t.ram for t in harts)) == 1, \
"All spike harts must have the same RAM layout"
assert len(set(t.ram_size for t in harts)) == 1, \
"All spike harts must have the same RAM layout"
os.environ['WORK_AREA'] = '0x%x' % harts[0].ram
cmd += ["-m0x%x:0x%x" % (harts[0].ram, harts[0].ram_size)]
if timeout:
cmd = ["timeout", str(timeout)] + cmd
if halted:
cmd.append('-H')
if with_jtag_gdb:
cmd += ['--rbb-port', '0']
os.environ['REMOTE_BITBANG_HOST'] = 'localhost'
return cmd
def __del__(self):
if self.process:
try:
self.process.kill()
self.process.wait()
except OSError:
pass
def wait(self, *args, **kwargs):
return self.process.wait(*args, **kwargs)
class VcsSim:
logfile = tempfile.NamedTemporaryFile(prefix='simv', suffix='.log')
logname = logfile.name
def __init__(self, sim_cmd=None, debug=False, timeout=300):
if sim_cmd:
cmd = shlex.split(sim_cmd)
else:
cmd = ["simv"]
cmd += ["+jtag_vpi_enable"]
if debug:
cmd[0] = cmd[0] + "-debug"
cmd += ["+vcdplusfile=output/gdbserver.vpd"]
logfile = open(self.logname, "w")
if print_log_names:
real_stdout.write("Temporary VCS log: %s\n" % self.logname)
logfile.write("+ %s\n" % " ".join(cmd))
logfile.flush()
listenfile = open(self.logname, "r")
listenfile.seek(0, 2)
self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE,
stdout=logfile, stderr=logfile)
done = False
start = time.time()
while not done:
# Fail if VCS exits early
exit_code = self.process.poll()
if exit_code is not None:
raise RuntimeError('VCS simulator exited early with status %d'
% exit_code)
line = listenfile.readline()
if not line:
time.sleep(1)
match = re.match(r"^Listening on port (\d+)$", line)
if match:
done = True
self.port = int(match.group(1))
os.environ['JTAG_VPI_PORT'] = str(self.port)
if (time.time() - start) > timeout:
raise Exception("Timed out waiting for VCS to listen for JTAG "
"vpi")
def __del__(self):
try:
self.process.kill()
self.process.wait()
except OSError:
pass
class Openocd:
logfile = tempfile.NamedTemporaryFile(prefix='openocd', suffix='.log')
logname = logfile.name
def __init__(self, server_cmd=None, config=None, debug=False, timeout=60):
self.timeout = timeout
if server_cmd:
cmd = shlex.split(server_cmd)
else:
cmd = ["openocd"]
if debug:
cmd.append("-d")
# This command needs to come before any config scripts on the command
# line, since they are executed in order.
cmd += [
# Tell OpenOCD to bind gdb to an unused, ephemeral port.
"--command",
"gdb_port 0",
# Disable tcl and telnet servers, since they are unused and because
# the port numbers will conflict if multiple OpenOCD processes are
# running on the same server.
"--command",
"tcl_port disabled",
"--command",
"telnet_port disabled",
]
if config:
self.config_file = find_file(config)
if self.config_file is None:
print("Unable to read file", config)
sys.exit(1)
cmd += ["-f", self.config_file]
if debug:
cmd.append("-d")
raw_logfile = open(Openocd.logname, "wb")
try:
spike_dasm = subprocess.Popen("spike-dasm", stdin=subprocess.PIPE,
stdout=raw_logfile, stderr=raw_logfile)
logfile = spike_dasm.stdin
except FileNotFoundError:
logfile = raw_logfile
if print_log_names:
real_stdout.write("Temporary OpenOCD log: %s\n" % Openocd.logname)
env_entries = ("REMOTE_BITBANG_HOST", "REMOTE_BITBANG_PORT",
"WORK_AREA")
env_entries = [key for key in env_entries if key in os.environ]
logfile.write(("+ %s%s\n" % (
"".join("%s=%s " % (key, os.environ[key]) for key in env_entries),
" ".join(map(pipes.quote, cmd)))).encode())
logfile.flush()
self.gdb_ports = []
self.process = self.start(cmd, logfile)
def start(self, cmd, logfile):
process = subprocess.Popen(cmd, stdin=subprocess.PIPE,
stdout=logfile, stderr=logfile)
try:
# Wait for OpenOCD to have made it through riscv_examine(). When
# using OpenOCD to communicate with a simulator this may take a
# long time, and gdb will time out when trying to connect if we
# attempt too early.
start = time.time()
messaged = False
fd = open(Openocd.logname, "r")
while True:
line = fd.readline()
if not line:
if not process.poll() is None:
raise Exception("OpenOCD exited early.")
time.sleep(0.1)
continue
m = re.search(r"Listening on port (\d+) for gdb connections",
line)
if m:
self.gdb_ports.append(int(m.group(1)))
if "telnet server disabled" in line:
return process
if not messaged and time.time() - start > 1:
messaged = True
print("Waiting for OpenOCD to start...")
if (time.time() - start) > self.timeout:
raise Exception("Timed out waiting for OpenOCD to "
"listen for gdb")
except Exception:
print_log(Openocd.logname)
raise
def __del__(self):
try:
self.process.terminate()
start = time.time()
while time.time() < start + 10:
if self.process.poll():
break
else:
self.process.kill()
except (OSError, AttributeError):
pass
def smp(self):
"""Return true iff OpenOCD internally sees the harts as part of an SMP
group."""
for line in open(self.config_file, "r"):
if "target smp" in line:
return True
return False
class OpenocdCli:
def __init__(self, port=4444):
self.child = pexpect.spawn(
"sh -c 'telnet localhost %d | tee openocd-cli.log'" % port)
self.child.expect("> ")
def command(self, cmd):
self.child.sendline(cmd)
self.child.expect(cmd)
self.child.expect("\n")
self.child.expect("> ")
return self.child.before.strip("\t\r\n \0").decode("utf-8")
def reg(self, reg=''):
output = self.command("reg %s" % reg)
matches = re.findall(r"(\w+) \(/\d+\): (0x[0-9A-F]+)", output)
values = {r: int(v, 0) for r, v in matches}
if reg:
return values[reg]
return values
def load_image(self, image):
output = self.command("load_image %s" % image)
if 'invalid ELF file, only 32bits files are supported' in output:
raise TestNotApplicable(output)
class CannotAccess(Exception):
def __init__(self, address):
Exception.__init__(self)
self.address = address
class CannotInsertBreakpoint(Exception):
def __init__(self, number):
Exception.__init__(self)
self.number = number
class CouldNotFetch(Exception):
def __init__(self, regname, explanation):
Exception.__init__(self)
self.regname = regname
self.explanation = explanation
class NoSymbol(Exception):
def __init__(self, symbol):
Exception.__init__(self)
self.symbol = symbol
Thread = collections.namedtuple('Thread', ('id', 'description', 'target_id',
'name', 'frame'))
class Repeat:
def __init__(self, count):
self.count = count
def tokenize(text):
index = 0
while index < len(text):
for regex, fn in (
(r"[\s]+", lambda m: None),
(r"[,{}=]", lambda m: m.group(0)),
(r"0x[\da-fA-F]+", lambda m: int(m.group(0)[2:], 16)),
(r"-?\d*\.\d+(e[-+]\d+)?", lambda m: float(m.group(0))),
(r"-?\d+", lambda m: int(m.group(0))),
(r"-?nan\(0x[a-f0-9]+\)", lambda m: float("nan")),
(r"<repeats (\d+) times>", lambda m: Repeat(int(m.group(1)))),
(r"Could not fetch register \"(\w+)\"; (.*)$",
lambda m: CouldNotFetch(m.group(1), m.group(2))),
(r"Cannot access memory at address (0x[0-9a-f]+)",
lambda m: CannotAccess(int(m.group(1), 0))),
(r"Cannot insert breakpoint (\d+).",
lambda m: CannotInsertBreakpoint(int(m.group(1)))),
(r'No symbol "(\w+)" in current context.',
lambda m: NoSymbol(m.group(1))),
(r'"([^"]*)"', lambda m: m.group(1)),
(r"[a-zA-Z][a-zA-Z\d]*", lambda m: m.group(0)),
):
m = re.match(regex, text[index:])
if m:
index += len(m.group(0))
token = fn(m)
if not token is None:
yield token
break
else:
raise Exception(repr(text[index:]))
def parse_dict(tokens):
assert tokens[0] == "{"
tokens.pop(0)
result = {}
while True:
key = tokens.pop(0)
assert tokens.pop(0) == "="
value = parse_tokens(tokens)
result[key] = value
token = tokens.pop(0)
if token == "}":
return result
assert token == ","
def parse_list(tokens):
assert tokens[0] == "{"
tokens.pop(0)
result = []
while True:
result.append(tokens.pop(0))
token = tokens.pop(0)
if isinstance(token, Repeat):
result += [result[-1]] * (token.count - 1)
token = tokens.pop(0)
if token == "}":
return result
assert token == ","
def parse_dict_or_list(tokens):
assert tokens[0] == "{"
if tokens[2] == "=":
return parse_dict(tokens)
else:
return parse_list(tokens)
def parse_tokens(tokens):
if isinstance(tokens[0], Exception):
raise tokens[0]
if isinstance(tokens[0], (float, int)):
return tokens.pop(0)
if tokens[0] == "{":
return parse_dict_or_list(tokens)
if isinstance(tokens[0], str):
return tokens.pop(0)
raise Exception("Unsupported tokens: %r" % tokens)
def parse_rhs(text):
tokens = list(tokenize(text))
result = parse_tokens(tokens)
if tokens:
raise Exception("Unexpected input: %r" % tokens)
return result
class Gdb:
"""A single gdb class which can interact with one or more gdb instances."""
# pylint: disable=too-many-public-methods
# pylint: disable=too-many-instance-attributes
reset_delays = (127, 181, 17, 13, 83, 151, 31, 67, 131, 167, 23, 41, 61,
11, 149, 107, 163, 73, 47, 43, 173, 7, 109, 101, 103, 191, 2, 139,
97, 193, 157, 3, 29, 79, 113, 5, 89, 19, 37, 71, 179, 59, 137, 53)
def __init__(self, ports,
cmd="riscv64-unknown-elf-gdb",
timeout=60, binary=None):
assert ports
self.ports = ports
self.cmd = cmd
self.timeout = timeout
self.binary = binary
self.reset_delay_index = 0
self.stack = []
self.harts = {}
self.logfiles = []
self.children = []
for port in ports:
logfile = tempfile.NamedTemporaryFile(prefix="gdb@%d-" % port,
suffix=".log")
self.logfiles.append(logfile)
if print_log_names:
real_stdout.write("Temporary gdb log: %s\n" % logfile.name)
child = pexpect.spawn(cmd)
child.logfile = logfile
child.logfile.write(("+ %s\n" % cmd).encode())
self.children.append(child)
self.active_child = self.children[0]
def connect(self):
for port, child in zip(self.ports, self.children):
self.select_child(child)
self.wait()
self.command("set style enabled off")
self.command("set confirm off")
self.command("set width 0")
self.command("set height 0")
# Force consistency.
self.command("set print entry-values no")
self.command("set remotetimeout %d" % self.timeout)
self.command("target extended-remote localhost:%d" % port, ops=10)
if self.binary:
self.command("file %s" % self.binary)
threads = self.threads()
for t in threads:
hartid = None
if t.name:
m = re.search(r"Hart (\d+)", t.name)
if m:
hartid = int(m.group(1))
if hartid is None:
if self.harts:
hartid = max(self.harts) + 1
else:
hartid = 0
# solo: True iff this is the only thread on this child
self.harts[hartid] = {'child': child,
'thread': t,
'solo': len(threads) == 1}
def __del__(self):
for child in self.children:
del child
def one_hart_per_gdb(self):
return all(h['solo'] for h in self.harts.values())
def lognames(self):
return [logfile.name for logfile in self.logfiles]
def select_child(self, child):
self.active_child = child
def select_hart(self, hart):
h = self.harts[hart.id]
self.select_child(h['child'])
if not h['solo']:
output = self.command("thread %s" % h['thread'].id, ops=5)
assert "Unknown" not in output
def push_state(self):
self.stack.append({
'active_child': self.active_child
})
def pop_state(self):
state = self.stack.pop()
self.active_child = state['active_child']
def wait(self):
"""Wait for prompt."""
self.active_child.expect(r"\(gdb\)")
def command(self, command, ops=1, reset_delays=0):
"""ops is the estimated number of operations gdb will have to perform
to perform this command. It is used to compute a timeout based on
self.timeout."""
if not reset_delays is None:
if reset_delays == 0:
reset_delays = self.reset_delays[self.reset_delay_index]
self.reset_delay_index = (self.reset_delay_index + 1) % \
len(self.reset_delays)
self.command("monitor riscv reset_delays %d" % reset_delays,
reset_delays=None)
timeout = ops * self.timeout
self.active_child.sendline(command)
self.active_child.expect("\n", timeout=timeout)
self.active_child.expect(r"\(gdb\)", timeout=timeout)
return self.active_child.before.strip().decode("utf-8")
def global_command(self, command):
"""Execute this command on every gdb that we control."""
with PrivateState(self):
for child in self.children:
self.select_child(child)
self.command(command)
def c(self, wait=True, sync=True, checkOutput=True, ops=20):
"""
Dumb c command.
In RTOS mode, gdb will resume all harts.
In multi-gdb mode, this command will just go to the current gdb, so
will only resume one hart.
"""
if sync:
sync = ""
else:
sync = "&"
if wait:
output = self.command("c%s" % sync, ops=ops)
if checkOutput:
assert "Continuing" in output
assert "Could not insert hardware" not in output
return output
else:
self.active_child.sendline("c%s" % sync)
self.active_child.expect("Continuing", timeout=ops * self.timeout)
return ""
def c_all(self, wait=True):
"""
Resume every hart.
This function works fine when using multiple gdb sessions, but the
caller must be careful when using it nonetheless. gdb's behavior is to
not set breakpoints until just before the hart is resumed, and then
clears them as soon as the hart halts. That means that you can't set
one software breakpoint, and expect multiple harts to hit it. It's
possible that the first hart completes set/run/halt/clear before the
second hart even gets to resume, so it will never hit the breakpoint.
"""
with PrivateState(self):
for child in self.children:
child.sendline("c")
child.expect("Continuing")
if wait:
for child in self.children:
child.expect(r"\(gdb\)")
def interrupt(self, ops=1):
self.active_child.send("\003")
self.active_child.expect(r"\(gdb\)", timeout=self.timeout * ops)
return self.active_child.before.strip().decode()
def interrupt_all(self):
for child in self.children:
self.select_child(child)
self.interrupt()
def x(self, address, size='w', count=1):
output = self.command("x/%d%s %s" % (count, size, address))
values = []
for line in output.splitlines():
for value in line.split(':')[1].strip().split():
values.append(int(value, 0))
if len(values) == 1:
return values[0]
return values
def p_raw(self, obj):
output = self.command("p %s" % obj)
m = re.search("Cannot access memory at address (0x[0-9a-f]+)", output)
if m:
raise CannotAccess(int(m.group(1), 0))
return output.split('=', 1)[-1].strip()
def p(self, obj, fmt="/x", ops=1):
output = self.command("p%s %s" % (fmt, obj), ops=ops).splitlines()[-1]
rhs = output.split('=', 1)[-1]
return parse_rhs(rhs)
def p_fpr(self, obj, ops=1):
result = self.p(obj, fmt="", ops=ops)
if isinstance(result, dict):
return result['double']
return result
def p_string(self, obj):
output = self.command("p %s" % obj)
value = shlex.split(output.split('=')[-1].strip())[1]
return value
def info_registers(self, group):
output = self.command("info registers %s" % group, ops=5)
result = {}
for line in output.splitlines():
m = re.match(r"(\w+)\s+({.*})(?:\s+(\(.*\)))?", line)
if m:
parts = m.groups()
else:
parts = line.split()
name = parts[0]
if "Could not fetch" in line:
result[name] = " ".join(parts[1:])
else:
result[name] = parse_rhs(parts[1])
return result
def stepi(self):
output = self.command("stepi", ops=10)
return output
def load(self):
output = self.command("load", ops=1000)
assert "failed" not in output
assert "Transfer rate" in output
output = self.command("compare-sections", ops=1000)
assert "matched" in output
assert "MIS" not in output
def b(self, location):
output = self.command("b %s" % location, ops=5)
assert "not defined" not in output
assert "Breakpoint" in output
m = re.search(r"Breakpoint (\d+),? ", output)
assert m, output
return int(m.group(1))
def hbreak(self, location):
output = self.command("hbreak %s" % location, ops=5)
assert "not defined" not in output
assert "Hardware assisted breakpoint" in output
return output
def watch(self, expr):
output = self.command("watch %s" % expr, ops=5)
assert "not defined" not in output
assert "atchpoint" in output
return output
def swatch(self, expr):
self.command("show can-use-hw-watchpoints")
self.command("set can-use-hw-watchpoints 0")
output = self.command("watch %s" % expr, ops=5)
assert "not defined" not in output
assert "atchpoint" in output
self.command("set can-use-hw-watchpoints 1")
return output
def threads(self):
output = self.command("info threads", ops=100)
threads = []
for line in output.splitlines():
m = re.match(
r"[\s\*]*(\d+)\s*"
r"(Remote target|Thread (\d+)\s*\(Name: ([^\)]+))"
r"\s*(.*)", line)
if m:
threads.append(Thread(*m.groups()))
assert threads
#>>>if not threads:
#>>> threads.append(Thread('1', '1', 'Default', '???'))
return threads
def thread(self, thread):
return self.command("thread %s" % thread.id)
def where(self):
return self.command("where 1")
class PrivateState:
def __init__(self, gdb):
self.gdb = gdb
def __enter__(self):
self.gdb.push_state()
def __exit__(self, _type, _value, _traceback):
self.gdb.pop_state()
def run_all_tests(module, target, parsed):
todo = []
for name in dir(module):
definition = getattr(module, name)
if isinstance(definition, type) and hasattr(definition, 'test') and \
(not parsed.test or any(test in name for test in parsed.test)):
todo.append((name, definition, None))
if parsed.list_tests:
for name, definition, hart in todo:
print(name)
return 0
try:
os.makedirs(parsed.logs)
except OSError:
# There's a race where multiple instances of the test program might
# decide to create the logs directory at the same time.
pass
overall_start = time.time()
global gdb_cmd # pylint: disable=global-statement
gdb_cmd = parsed.gdb
global gcc_cmd # pylint: disable=global-statement
gcc_cmd = parsed.gcc
examine_added = False
for hart in target.harts:
if parsed.misaval:
hart.misa = int(parsed.misaval, 16)
print("Using $misa from command line: 0x%x" % hart.misa)
elif hart.misa:
print("Using $misa from hart definition: 0x%x" % hart.misa)
elif not examine_added:
todo.insert(0, ("ExamineTarget", ExamineTarget, None))
examine_added = True
results, count = run_tests(parsed, target, todo)
header("ran %d tests in %.0fs" % (count, time.time() - overall_start),
dash=':')
return print_results(results)
good_results = set(('pass', 'not_applicable'))
def run_tests(parsed, target, todo):
results = {}
count = 0
for name, definition, hart in todo:
log_name = os.path.join(parsed.logs, "%s-%s-%s.log" %
(time.strftime("%Y%m%d-%H%M%S"), type(target).__name__, name))
log_fd = open(log_name, 'w')
print("[%s] Starting > %s" % (name, log_name))
instance = definition(target, hart)
sys.stdout.flush()
log_fd.write("Test: %s\n" % name)
log_fd.write("Target: %s\n" % type(target).__name__)
start = time.time()
global real_stdout # pylint: disable=global-statement
real_stdout = sys.stdout
sys.stdout = log_fd
try:
result = instance.run()
log_fd.write("Result: %s\n" % result)
log_fd.write("Logfile: %s\n" % log_name)
log_fd.write("Reproduce: %s %s %s\n" % (sys.argv[0], parsed.target,
name))
finally:
sys.stdout = real_stdout
log_fd.write("Time elapsed: %.2fs\n" % (time.time() - start))
log_fd.flush()
print("[%s] %s in %.2fs" % (name, result, time.time() - start))
if result not in good_results and parsed.print_failures:
sys.stdout.write(open(log_name).read())
sys.stdout.flush()
results.setdefault(result, []).append((name, log_name))
count += 1
if result not in good_results and parsed.fail_fast:
break
return results, count
def print_results(results):
result = 0
for key, value in results.items():
print("%d tests returned %s" % (len(value), key))
if key not in good_results:
result = 1
for name, log_name in value:
print(" %s > %s" % (name, log_name))
return result
def add_test_run_options(parser):
parser.add_argument("--logs", default="logs",
help="Store logs in the specified directory.")
parser.add_argument("--fail-fast", "-f", action="store_true",
help="Exit as soon as any test fails.")
parser.add_argument("--print-failures", action="store_true",
help="When a test fails, print the log file to stdout.")
parser.add_argument("--print-log-names", "--pln", action="store_true",
help="Print names of temporary log files as soon as they are "
"created.")
parser.add_argument("--list-tests", action="store_true",
help="Print out a list of tests, and exit immediately.")
parser.add_argument("test", nargs='*',
help="Run only tests that are named here.")
parser.add_argument("--gcc",
help="The command to use to start gcc.")
parser.add_argument("--gdb",
help="The command to use to start gdb.")
parser.add_argument("--misaval",
help="Don't run ExamineTarget, just assume the misa value which is "
"specified.")
def header(title, dash='-', length=78):
if title:
dashes = dash * (length - 4 - len(title))
before = dashes[:len(dashes)//2]
after = dashes[len(dashes)//2:]
print("%s[ %s ]%s" % (before, title, after))
else:
print(dash * length)
def print_log_handle(name, handle):
header(name)
for l in handle:
sys.stdout.write(l)
print()
def print_log(path):
print_log_handle(path, open(path, "r"))
class BaseTest:
compiled = {}
def __init__(self, target, hart=None):
self.target = target
if hart:
self.hart = hart
else:
self.hart = random.choice(target.harts)
self.server = None
self.target_process = None
self.binary = None
self.start = 0
self.logs = []
def early_applicable(self):
"""Return a false value if the test has determined it cannot run
without ever needing to talk to the target or server."""
# pylint: disable=no-self-use
return True
def setup(self):
pass
def compile(self):
compile_args = getattr(self, 'compile_args', None)
if compile_args:
if compile_args not in BaseTest.compiled:
BaseTest.compiled[compile_args] = \
self.target.compile(self.hart, *compile_args)
self.binary = BaseTest.compiled.get(compile_args)
def classSetup(self):
self.compile()
self.target_process = self.target.create()
if self.target_process:
self.logs.append(self.target_process.logname)
try:
self.server = self.target.server()
self.logs.append(self.server.logname)
except Exception:
for log in self.logs:
print_log(log)
raise
def classTeardown(self):
del self.server
del self.target_process
def postMortem(self):
pass
def run(self):
"""
If compile_args is set, compile a program and set self.binary.
Call setup().
Then call test() and return the result, displaying relevant information
if an exception is raised.
"""
sys.stdout.flush()
if self.__class__.__name__ in self.target.skip_tests or \
not self.early_applicable():
return "not_applicable"
self.start = time.time()
try:
self.classSetup()
self.setup()
result = self.test() # pylint: disable=no-member
except TestNotApplicable:
result = "not_applicable"
except Exception as e: # pylint: disable=broad-except
if isinstance(e, TestFailed):
result = "fail"
else:
result = "exception"
if isinstance(e, TestFailed):
# pylint: disable=no-member
header("Message")
print(e.message)
header("Traceback")
traceback.print_exc(file=sys.stdout)
try:
self.postMortem()
except Exception as e: # pylint: disable=broad-except
header("postMortem Exception")
print(e)
traceback.print_exc(file=sys.stdout)
return result
finally:
# Get handles to logs before the files are deleted.
logs = []
for log in self.logs:
logs.append((log, open(log, "r")))
self.classTeardown()
for name, handle in logs:
print_log_handle(name, handle)
header("End of logs")
if not result:
result = 'pass'
return result
gdb_cmd = None
class GdbTest(BaseTest):
def __init__(self, target, hart=None):
BaseTest.__init__(self, target, hart=hart)
self.gdb = None
def write_nop_program(self, count):
for i in range(count):
# 0x13 is nop
self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + i * 4))
self.gdb.p("$pc=0x%x" % self.hart.ram)
def classSetup(self):
BaseTest.classSetup(self)
if gdb_cmd:
self.gdb = Gdb(self.server.gdb_ports, gdb_cmd,
timeout=self.target.timeout_sec, binary=self.binary)
else:
self.gdb = Gdb(self.server.gdb_ports,
timeout=self.target.timeout_sec, binary=self.binary)
self.logs += self.gdb.lognames()
self.gdb.connect()
self.gdb.global_command("set remotetimeout %d" %
self.target.timeout_sec)
for cmd in self.target.gdb_setup:
self.gdb.command(cmd)
self.gdb.select_hart(self.hart)
# FIXME: OpenOCD doesn't handle PRIV now
#self.gdb.p("$priv=3")
def postMortem(self):
if not self.gdb:
return
self.gdb.interrupt()
self.gdb.command("info breakpoints", reset_delays=None)
self.gdb.command("disassemble", ops=20, reset_delays=None)
self.gdb.command("info registers all", ops=20, reset_delays=None)
self.gdb.command("flush regs", reset_delays=None)
self.gdb.command("info threads", ops=20, reset_delays=None)
def classTeardown(self):
del self.gdb
BaseTest.classTeardown(self)
def parkOtherHarts(self):
"""Park harts besides the currently selected one in loop_forever()."""
for hart in self.target.harts:
# Park all harts that we're not using in a safe place.
if hart != self.hart:
self.gdb.select_hart(hart)
self.gdb.p("$pc=loop_forever")
self.gdb.select_hart(self.hart)
def disable_pmp(self):
# Disable physical memory protection by allowing U mode access to all
# memory.
try:
self.gdb.p("$pmpcfg0=0xf") # TOR, R, W, X
self.gdb.p("$pmpaddr0=0x%x" %
((self.hart.ram + self.hart.ram_size) >> 2))
except CouldNotFetch:
# PMP registers are optional
pass
class GdbSingleHartTest(GdbTest):
def classSetup(self):
GdbTest.classSetup(self)
self.parkOtherHarts()
class ExamineTarget(GdbTest):
def test(self):
for hart in self.target.harts:
self.gdb.select_hart(hart)
hart.misa = self.gdb.p("$misa")
txt = "RV"
misa_xlen = 0
if ((hart.misa & 0xFFFFFFFF) >> 30) == 1:
misa_xlen = 32
elif ((hart.misa & 0xFFFFFFFFFFFFFFFF) >> 62) == 2:
misa_xlen = 64
elif ((hart.misa & 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF) >> 126) == 3:
misa_xlen = 128
else:
raise TestFailed("Couldn't determine XLEN from $misa (0x%x)" %
self.hart.misa)
if misa_xlen != hart.xlen:
raise TestFailed("MISA reported XLEN of %d but we were "\
"expecting XLEN of %d\n" % (misa_xlen, hart.xlen))
txt += ("%d" % misa_xlen)
for i in range(26):
if hart.misa & (1<<i):
txt += chr(i + ord('A'))
print(txt, end=" ")
class TestFailed(Exception):
def __init__(self, message, comment=None):
Exception.__init__(self)
self.message = message
if comment:
self.message += ": %s" % comment
class TestNotApplicable(Exception):
def __init__(self, message=""):
Exception.__init__(self)
self.message = message
def assertEqual(a, b):
if a != b:
raise TestFailed("%r != %r" % (a, b))
def assertNotEqual(a, b, comment=None):
if a == b:
raise TestFailed("%r == %r" % (a, b), comment)
def assertIn(a, b):
if a not in b:
raise TestFailed("%r not in %r" % (a, b))
def assertNotIn(a, b, comment=None):
if a in b:
raise TestFailed("%r in %r" % (a, b), comment)
def assertGreater(a, b):
if not a > b:
raise TestFailed("%r not greater than %r" % (a, b))
def assertLess(a, b, comment=None):
if not a < b:
raise TestFailed("%r not less than %r" % (a, b), comment)
def assertTrue(a):
if not a:
raise TestFailed("%r is not True" % a)
def assertRegex(text, regexp):
if not re.search(regexp, text):
raise TestFailed("can't find %r in %r" % (regexp, text))
|