debug/gdbserver.py

   1 #!/usr/bin/env python
   2
   3 import argparse
   4 import binascii
   5 import random
   6 import sys
   7 import tempfile
   8 import time
   9 import os
  10
  11 import targets
  12 import testlib
  13 from testlib import assertEqual, assertNotEqual, assertIn, assertNotIn
  14 from testlib import assertGreater, assertRegexpMatches, assertLess
  15 from testlib import GdbTest, GdbSingleHartTest, TestFailed, assertTrue
  16
  17 MSTATUS_UIE = 0x00000001
  18 MSTATUS_SIE = 0x00000002
  19 MSTATUS_HIE = 0x00000004
  20 MSTATUS_MIE = 0x00000008
  21 MSTATUS_UPIE = 0x00000010
  22 MSTATUS_SPIE = 0x00000020
  23 MSTATUS_HPIE = 0x00000040
  24 MSTATUS_MPIE = 0x00000080
  25 MSTATUS_SPP = 0x00000100
  26 MSTATUS_HPP = 0x00000600
  27 MSTATUS_MPP = 0x00001800
  28 MSTATUS_FS = 0x00006000
  29 MSTATUS_XS = 0x00018000
  30 MSTATUS_MPRV = 0x00020000
  31 MSTATUS_PUM = 0x00040000
  32 MSTATUS_MXR = 0x00080000
  33 MSTATUS_VM = 0x1F000000
  34 MSTATUS32_SD = 0x80000000
  35 MSTATUS64_SD = 0x8000000000000000
  36
  37 # pylint: disable=abstract-method
  38
  39 def ihex_line(address, record_type, data):
  40     assert len(data) < 128
  41     line = ":%02X%04X%02X" % (len(data), address, record_type)
  42     check = len(data)
  43     check += address % 256
  44     check += address >> 8
  45     check += record_type
  46     for char in data:
  47         value = ord(char)
  48         check += value
  49         line += "%02X" % value
  50     line += "%02X\n" % ((256-check)%256)
  51     return line
  52
  53 def ihex_parse(line):
  54     assert line.startswith(":")
  55     line = line[1:]
  56     data_len = int(line[:2], 16)
  57     address = int(line[2:6], 16)
  58     record_type = int(line[6:8], 16)
  59     data = ""
  60     for i in range(data_len):
  61         data += "%c" % int(line[8+2*i:10+2*i], 16)
  62     return record_type, address, data
  63
  64 def readable_binary_string(s):
  65     return "".join("%02x" % ord(c) for c in s)
  66
  67 class SimpleRegisterTest(GdbTest):
  68     def check_reg(self, name, alias):
  69         a = random.randrange(1<<self.hart.xlen)
  70         b = random.randrange(1<<self.hart.xlen)
  71         self.gdb.p("$%s=0x%x" % (name, a))
  72         assertEqual(self.gdb.p("$%s" % alias), a)
  73         self.gdb.stepi()
  74         assertEqual(self.gdb.p("$%s" % name), a)
  75         assertEqual(self.gdb.p("$%s" % alias), a)
  76         self.gdb.p("$%s=0x%x" % (alias, b))
  77         assertEqual(self.gdb.p("$%s" % name), b)
  78         self.gdb.stepi()
  79         assertEqual(self.gdb.p("$%s" % name), b)
  80         assertEqual(self.gdb.p("$%s" % alias), b)
  81
  82     def setup(self):
  83         # 0x13 is nop
  84         self.gdb.command("p *((int*) 0x%x)=0x13" % self.hart.ram)
  85         self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 4))
  86         self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 8))
  87         self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 12))
  88         self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 16))
  89         self.gdb.p("$pc=0x%x" % self.hart.ram)
  90
  91 class SimpleS0Test(SimpleRegisterTest):
  92     def test(self):
  93         self.check_reg("s0", "x8")
  94
  95 class SimpleS1Test(SimpleRegisterTest):
  96     def test(self):
  97         self.check_reg("s1", "x9")
  98
  99 class SimpleT0Test(SimpleRegisterTest):
 100     def test(self):
 101         self.check_reg("t0", "x5")
 102
 103 class SimpleT1Test(SimpleRegisterTest):
 104     def test(self):
 105         self.check_reg("t1", "x6")
 106
 107 class SimpleF18Test(SimpleRegisterTest):
 108     def check_reg(self, name, alias):
 109         if self.hart.extensionSupported('F'):
 110             self.gdb.p_raw("$mstatus=$mstatus | 0x00006000")
 111             self.gdb.stepi()
 112             a = random.random()
 113             b = random.random()
 114             self.gdb.p_raw("$%s=%f" % (name, a))
 115             assertLess(abs(float(self.gdb.p_raw("$%s" % alias)) - a), .001)
 116             self.gdb.stepi()
 117             assertLess(abs(float(self.gdb.p_raw("$%s" % name)) - a), .001)
 118             assertLess(abs(float(self.gdb.p_raw("$%s" % alias)) - a), .001)
 119             self.gdb.p_raw("$%s=%f" % (alias, b))
 120             assertLess(abs(float(self.gdb.p_raw("$%s" % name)) - b), .001)
 121             self.gdb.stepi()
 122             assertLess(abs(float(self.gdb.p_raw("$%s" % name)) - b), .001)
 123             assertLess(abs(float(self.gdb.p_raw("$%s" % alias)) - b), .001)
 124
 125             size = self.gdb.p("sizeof($%s)" % name)
 126             if self.hart.extensionSupported('D'):
 127                 assertEqual(size, 8)
 128             else:
 129                 assertEqual(size, 4)
 130         else:
 131             output = self.gdb.p_raw("$" + name)
 132             assertEqual(output, "void")
 133             output = self.gdb.p_raw("$" + alias)
 134             assertEqual(output, "void")
 135
 136     def test(self):
 137         self.check_reg("f18", "fs2")
 138
 139 class SimpleNoExistTest(GdbTest):
 140     def test(self):
 141         try:
 142             self.gdb.p("$csr2288")
 143             assert False, "Reading csr2288 should have failed"
 144         except testlib.CouldNotFetch:
 145             pass
 146         try:
 147             self.gdb.p("$csr2288=5")
 148             assert False, "Writing csr2288 should have failed"
 149         except testlib.CouldNotFetch:
 150             pass
 151
 152 class SimpleMemoryTest(GdbTest):
 153     def access_test(self, size, data_type):
 154         assertEqual(self.gdb.p("sizeof(%s)" % data_type), size)
 155         a = 0x86753095555aaaa & ((1<<(size*8))-1)
 156         b = 0xdeadbeef12345678 & ((1<<(size*8))-1)
 157         addrA = self.hart.ram
 158         addrB = self.hart.ram + self.hart.ram_size - size
 159         self.gdb.p("*((%s*)0x%x) = 0x%x" % (data_type, addrA, a))
 160         self.gdb.p("*((%s*)0x%x) = 0x%x" % (data_type, addrB, b))
 161         assertEqual(self.gdb.p("*((%s*)0x%x)" % (data_type, addrA)), a)
 162         assertEqual(self.gdb.p("*((%s*)0x%x)" % (data_type, addrB)), b)
 163
 164 class MemTest8(SimpleMemoryTest):
 165     def test(self):
 166         self.access_test(1, 'char')
 167
 168 class MemTest16(SimpleMemoryTest):
 169     def test(self):
 170         self.access_test(2, 'short')
 171
 172 class MemTest32(SimpleMemoryTest):
 173     def test(self):
 174         self.access_test(4, 'int')
 175
 176 class MemTest64(SimpleMemoryTest):
 177     def test(self):
 178         self.access_test(8, 'long long')
 179
 180 # FIXME: I'm not passing back invalid addresses correctly in read/write memory.
 181 #class MemTestReadInvalid(SimpleMemoryTest):
 182 #    def test(self):
 183 #        # This test relies on 'gdb_report_data_abort enable' being executed in
 184 #        # the openocd.cfg file.
 185 #        try:
 186 #            self.gdb.p("*((int*)0xdeadbeef)")
 187 #            assert False, "Read should have failed."
 188 #        except testlib.CannotAccess as e:
 189 #            assertEqual(e.address, 0xdeadbeef)
 190 #        self.gdb.p("*((int*)0x%x)" % self.hart.ram)
 191 #
 192 #class MemTestWriteInvalid(SimpleMemoryTest):
 193 #    def test(self):
 194 #        # This test relies on 'gdb_report_data_abort enable' being executed in
 195 #        # the openocd.cfg file.
 196 #        try:
 197 #            self.gdb.p("*((int*)0xdeadbeef)=8675309")
 198 #            assert False, "Write should have failed."
 199 #        except testlib.CannotAccess as e:
 200 #            assertEqual(e.address, 0xdeadbeef)
 201 #        self.gdb.p("*((int*)0x%x)=6874742" % self.hart.ram)
 202
 203 class MemTestBlock(GdbTest):
 204     length = 1024
 205     line_length = 16
 206
 207     def test(self):
 208         a = tempfile.NamedTemporaryFile(suffix=".ihex")
 209         data = ""
 210         for i in range(self.length / self.line_length):
 211             line_data = "".join(["%c" % random.randrange(256)
 212                 for _ in range(self.line_length)])
 213             data += line_data
 214             a.write(ihex_line(i * self.line_length, 0, line_data))
 215         a.flush()
 216
 217         self.gdb.command("shell cat %s" % a.name)
 218         self.gdb.command("restore %s 0x%x" % (a.name, self.hart.ram))
 219         increment = 19 * 4
 220         for offset in range(0, self.length, increment) + [self.length-4]:
 221             value = self.gdb.p("*((int*)0x%x)" % (self.hart.ram + offset))
 222             written = ord(data[offset]) | \
 223                     (ord(data[offset+1]) << 8) | \
 224                     (ord(data[offset+2]) << 16) | \
 225                     (ord(data[offset+3]) << 24)
 226             assertEqual(value, written)
 227
 228         b = tempfile.NamedTemporaryFile(suffix=".ihex")
 229         self.gdb.command("dump ihex memory %s 0x%x 0x%x" % (b.name,
 230             self.hart.ram, self.hart.ram + self.length))
 231         self.gdb.command("shell cat %s" % b.name)
 232         for line in b.xreadlines():
 233             record_type, address, line_data = ihex_parse(line)
 234             if record_type == 0:
 235                 written_data = data[address:address+len(line_data)]
 236                 if line_data != written_data:
 237                     raise TestFailed(
 238                             "Data mismatch at 0x%x; wrote %s but read %s" % (
 239                                 address, readable_binary_string(written_data),
 240                                 readable_binary_string(line_data)))
 241
 242 class InstantHaltTest(GdbTest):
 243     def test(self):
 244         """Assert that reset is really resetting what it should."""
 245         self.gdb.command("monitor reset halt")
 246         self.gdb.command("flushregs")
 247         threads = self.gdb.threads()
 248         pcs = []
 249         for t in threads:
 250             self.gdb.thread(t)
 251             pcs.append(self.gdb.p("$pc"))
 252         for pc in pcs:
 253             assertIn(pc, self.hart.reset_vectors)
 254         # mcycle and minstret have no defined reset value.
 255         mstatus = self.gdb.p("$mstatus")
 256         assertEqual(mstatus & (MSTATUS_MIE | MSTATUS_MPRV |
 257             MSTATUS_VM), 0)
 258
 259 class InstantChangePc(GdbTest):
 260     def test(self):
 261         """Change the PC right as we come out of reset."""
 262         # 0x13 is nop
 263         self.gdb.command("monitor reset halt")
 264         self.gdb.command("flushregs")
 265         self.gdb.command("p *((int*) 0x%x)=0x13" % self.hart.ram)
 266         self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 4))
 267         self.gdb.command("p *((int*) 0x%x)=0x13" % (self.hart.ram + 8))
 268         self.gdb.p("$pc=0x%x" % self.hart.ram)
 269         self.gdb.stepi()
 270         assertEqual((self.hart.ram + 4), self.gdb.p("$pc"))
 271         self.gdb.stepi()
 272         assertEqual((self.hart.ram + 8), self.gdb.p("$pc"))
 273
 274 class DebugTest(GdbSingleHartTest):
 275     # Include malloc so that gdb can make function calls. I suspect this malloc
 276     # will silently blow through the memory set aside for it, so be careful.
 277     compile_args = ("programs/debug.c", "programs/checksum.c",
 278             "programs/tiny-malloc.c", "-DDEFINE_MALLOC", "-DDEFINE_FREE")
 279
 280     def setup(self):
 281         self.gdb.load()
 282         self.gdb.b("_exit")
 283
 284     def exit(self, expected_result=0xc86455d4):
 285         output = self.gdb.c()
 286         assertIn("Breakpoint", output)
 287         assertIn("_exit", output)
 288         assertEqual(self.gdb.p("status"), expected_result)
 289
 290 class DebugCompareSections(DebugTest):
 291     def test(self):
 292         output = self.gdb.command("compare-sections")
 293         matched = 0
 294         for line in output.splitlines():
 295             if line.startswith("Section"):
 296                 assert line.endswith("matched.")
 297                 matched += 1
 298         assertGreater(matched, 1)
 299
 300 class DebugFunctionCall(DebugTest):
 301     def test(self):
 302         self.gdb.b("main:start")
 303         self.gdb.c()
 304         assertEqual(self.gdb.p('fib(6)'), 8)
 305         assertEqual(self.gdb.p('fib(7)'), 13)
 306         self.exit()
 307
 308 class DebugChangeString(DebugTest):
 309     def test(self):
 310         text = "This little piggy went to the market."
 311         self.gdb.b("main:start")
 312         self.gdb.c()
 313         self.gdb.p('fox = "%s"' % text)
 314         self.exit(0x43b497b8)
 315
 316 class DebugTurbostep(DebugTest):
 317     def test(self):
 318         """Single step a bunch of times."""
 319         self.gdb.b("main:start")
 320         self.gdb.c()
 321         self.gdb.command("p i=0")
 322         last_pc = None
 323         advances = 0
 324         jumps = 0
 325         for _ in range(10):
 326             self.gdb.stepi()
 327             pc = self.gdb.p("$pc")
 328             assertNotEqual(last_pc, pc)
 329             if last_pc and pc > last_pc and pc - last_pc <= 4:
 330                 advances += 1
 331             else:
 332                 jumps += 1
 333             last_pc = pc
 334         # Some basic sanity that we're not running between breakpoints or
 335         # something.
 336         assertGreater(jumps, 1)
 337         assertGreater(advances, 5)
 338
 339 class DebugExit(DebugTest):
 340     def test(self):
 341         self.exit()
 342
 343 class DebugSymbols(DebugTest):
 344     def test(self):
 345         self.gdb.b("main")
 346         self.gdb.b("rot13")
 347         output = self.gdb.c()
 348         assertIn(", main ", output)
 349         output = self.gdb.c()
 350         assertIn(", rot13 ", output)
 351
 352 class DebugBreakpoint(DebugTest):
 353     def test(self):
 354         self.gdb.b("rot13")
 355         # The breakpoint should be hit exactly 2 times.
 356         for _ in range(2):
 357             output = self.gdb.c()
 358             self.gdb.p("$pc")
 359             assertIn("Breakpoint ", output)
 360             assertIn("rot13 ", output)
 361         self.exit()
 362
 363 class Hwbp1(DebugTest):
 364     def test(self):
 365         if self.hart.instruction_hardware_breakpoint_count < 1:
 366             return 'not_applicable'
 367
 368         if not self.hart.honors_tdata1_hmode:
 369             # Run to main before setting the breakpoint, because startup code
 370             # will otherwise clear the trigger that we set.
 371             self.gdb.b("main")
 372             self.gdb.c()
 373
 374         self.gdb.hbreak("rot13")
 375         # The breakpoint should be hit exactly 2 times.
 376         for _ in range(2):
 377             output = self.gdb.c()
 378             self.gdb.p("$pc")
 379             assertRegexpMatches(output, r"[bB]reakpoint")
 380             assertIn("rot13 ", output)
 381         self.exit()
 382
 383 class Hwbp2(DebugTest):
 384     def test(self):
 385         if self.hart.instruction_hardware_breakpoint_count < 2:
 386             return 'not_applicable'
 387
 388         self.gdb.hbreak("main")
 389         self.gdb.hbreak("rot13")
 390         # We should hit 3 breakpoints.
 391         for expected in ("main", "rot13", "rot13"):
 392             output = self.gdb.c()
 393             self.gdb.p("$pc")
 394             assertRegexpMatches(output, r"[bB]reakpoint")
 395             assertIn("%s " % expected, output)
 396         self.exit()
 397
 398 class TooManyHwbp(DebugTest):
 399     def test(self):
 400         for i in range(30):
 401             self.gdb.hbreak("*rot13 + %d" % (i * 4))
 402
 403         output = self.gdb.c()
 404         assertIn("Cannot insert hardware breakpoint", output)
 405         # Clean up, otherwise the hardware breakpoints stay set and future
 406         # tests may fail.
 407         self.gdb.command("D")
 408
 409 class Registers(DebugTest):
 410     def test(self):
 411         # Get to a point in the code where some registers have actually been
 412         # used.
 413         self.gdb.b("rot13")
 414         self.gdb.c()
 415         self.gdb.c()
 416         # Try both forms to test gdb.
 417         for cmd in ("info all-registers", "info registers all"):
 418             output = self.gdb.command(cmd)
 419             for reg in ('zero', 'ra', 'sp', 'gp', 'tp'):
 420                 assertIn(reg, output)
 421             for line in output.splitlines():
 422                 assertRegexpMatches(line, r"^\S")
 423
 424         #TODO
 425         # mcpuid is one of the few registers that should have the high bit set
 426         # (for rv64).
 427         # Leave this commented out until gdb and spike agree on the encoding of
 428         # mcpuid (which is going to be renamed to misa in any case).
 429         #assertRegexpMatches(output, ".*mcpuid *0x80")
 430
 431         #TODO:
 432         # The instret register should always be changing.
 433         #last_instret = None
 434         #for _ in range(5):
 435         #    instret = self.gdb.p("$instret")
 436         #    assertNotEqual(instret, last_instret)
 437         #    last_instret = instret
 438         #    self.gdb.stepi()
 439
 440         self.exit()
 441
 442 class UserInterrupt(DebugTest):
 443     def test(self):
 444         """Sending gdb ^C while the program is running should cause it to
 445         halt."""
 446         self.gdb.b("main:start")
 447         self.gdb.c()
 448         self.gdb.p("i=123")
 449         self.gdb.c(wait=False)
 450         time.sleep(2)
 451         output = self.gdb.interrupt()
 452         assert "main" in output
 453         assertGreater(self.gdb.p("j"), 10)
 454         self.gdb.p("i=0")
 455         self.exit()
 456
 457 class InterruptTest(GdbSingleHartTest):
 458     compile_args = ("programs/interrupt.c",)
 459
 460     def early_applicable(self):
 461         return self.target.supports_clint_mtime
 462
 463     def setup(self):
 464         self.gdb.load()
 465
 466     def test(self):
 467         self.gdb.b("main")
 468         output = self.gdb.c()
 469         assertIn(" main ", output)
 470         self.gdb.b("trap_entry")
 471         output = self.gdb.c()
 472         assertIn(" trap_entry ", output)
 473         assertEqual(self.gdb.p("$mip") & 0x80, 0x80)
 474         assertEqual(self.gdb.p("interrupt_count"), 0)
 475         # You'd expect local to still be 0, but it looks like spike doesn't
 476         # jump to the interrupt handler immediately after the write to
 477         # mtimecmp.
 478         assertLess(self.gdb.p("local"), 1000)
 479         self.gdb.command("delete breakpoints")
 480         for _ in range(10):
 481             self.gdb.c(wait=False)
 482             time.sleep(2)
 483             self.gdb.interrupt()
 484             interrupt_count = self.gdb.p("interrupt_count")
 485             local = self.gdb.p("local")
 486             if interrupt_count > 1000 and \
 487                     local > 1000:
 488                 return
 489
 490         assertGreater(interrupt_count, 1000)
 491         assertGreater(local, 1000)
 492
 493     def postMortem(self):
 494         GdbSingleHartTest.postMortem(self)
 495         self.gdb.p("*((long long*) 0x200bff8)")
 496         self.gdb.p("*((long long*) 0x2004000)")
 497         self.gdb.p("interrupt_count")
 498         self.gdb.p("local")
 499
 500 class MulticoreRegTest(GdbTest):
 501     compile_args = ("programs/infinite_loop.S", "-DMULTICORE")
 502
 503     def early_applicable(self):
 504         return len(self.target.harts) > 1
 505
 506     def setup(self):
 507         self.gdb.load()
 508         for hart in self.target.harts:
 509             self.gdb.select_hart(hart)
 510             self.gdb.p("$pc=_start")
 511
 512     def test(self):
 513         # Run to main
 514         for hart in self.target.harts:
 515             self.gdb.select_hart(hart)
 516             self.gdb.b("main")
 517             self.gdb.c()
 518             assertIn("main", self.gdb.where())
 519             self.gdb.command("delete breakpoints")
 520
 521         # Run through the entire loop.
 522         for hart in self.target.harts:
 523             self.gdb.select_hart(hart)
 524             self.gdb.b("main_end")
 525             self.gdb.c()
 526             assertIn("main_end", self.gdb.where())
 527
 528         hart_ids = []
 529         for hart in self.target.harts:
 530             self.gdb.select_hart(hart)
 531             # Check register values.
 532             hart_id = self.gdb.p("$x1")
 533             assertNotIn(hart_id, hart_ids)
 534             hart_ids.append(hart_id)
 535             for n in range(2, 32):
 536                 value = self.gdb.p("$x%d" % n)
 537                 assertEqual(value, hart_ids[-1] + n - 1)
 538
 539         # Confirmed that we read different register values for different harts.
 540         # Write a new value to x1, and run through the add sequence again.
 541
 542         for hart in self.target.harts:
 543             self.gdb.select_hart(hart)
 544             self.gdb.p("$x1=0x%x" % (hart.index * 0x800))
 545             self.gdb.p("$pc=main_post_csrr")
 546             self.gdb.c()
 547         for hart in self.target.harts:
 548             self.gdb.select_hart(hart)
 549             assertIn("main", self.gdb.where())
 550             # Check register values.
 551             for n in range(1, 32):
 552                 value = self.gdb.p("$x%d" % n)
 553                 assertEqual(value, hart.index * 0x800 + n - 1)
 554
 555 class MulticoreRunHaltStepiTest(GdbTest):
 556     compile_args = ("programs/multicore.c", "-DMULTICORE")
 557
 558     def early_applicable(self):
 559         return len(self.target.harts) > 1
 560
 561     def setup(self):
 562         self.gdb.load()
 563         for hart in self.target.harts:
 564             self.gdb.select_hart(hart)
 565             self.gdb.p("$pc=_start")
 566
 567     def test(self):
 568         previous_hart_count = [0 for h in self.target.harts]
 569         previous_interrupt_count = [0 for h in self.target.harts]
 570         for _ in range(10):
 571             self.gdb.c(wait=False)
 572             time.sleep(2)
 573             self.gdb.interrupt()
 574             self.gdb.p("$mie")
 575             self.gdb.p("$mip")
 576             self.gdb.p("$mstatus")
 577             self.gdb.p("$priv")
 578             self.gdb.p("buf", fmt="")
 579             hart_count = self.gdb.p("hart_count")
 580             interrupt_count = self.gdb.p("interrupt_count")
 581             for i, h in enumerate(self.target.harts):
 582                 assertGreater(hart_count[i], previous_hart_count[i])
 583                 assertGreater(interrupt_count[i], previous_interrupt_count[i])
 584                 self.gdb.select_hart(h)
 585                 pc = self.gdb.p("$pc")
 586                 self.gdb.stepi()
 587                 stepped_pc = self.gdb.p("$pc")
 588                 assertNotEqual(pc, stepped_pc)
 589
 590 class MulticoreRunAllHaltOne(GdbTest):
 591     compile_args = ("programs/multicore.c", "-DMULTICORE")
 592
 593     def early_applicable(self):
 594         return len(self.target.harts) > 1
 595
 596     def setup(self):
 597         self.gdb.select_hart(self.target.harts[0])
 598         self.gdb.load()
 599         for hart in self.target.harts:
 600             self.gdb.select_hart(hart)
 601             self.gdb.p("$pc=_start")
 602
 603     def test(self):
 604         if not self.gdb.one_hart_per_gdb():
 605             return 'not_applicable'
 606
 607         # Run harts in reverse order
 608         for h in reversed(self.target.harts):
 609             self.gdb.select_hart(h)
 610             self.gdb.c(wait=False)
 611
 612         self.gdb.interrupt()
 613         # Give OpenOCD time to call poll() on both harts, which is what causes
 614         # the bug.
 615         time.sleep(1)
 616         self.gdb.p("buf", fmt="")
 617
 618 class StepTest(GdbSingleHartTest):
 619     compile_args = ("programs/step.S", )
 620
 621     def setup(self):
 622         self.gdb.load()
 623         self.gdb.b("main")
 624         self.gdb.c()
 625
 626     def test(self):
 627         main_address = self.gdb.p("$pc")
 628         if self.hart.extensionSupported("c"):
 629             sequence = (4, 8, 0xc, 0xe, 0x14, 0x18, 0x22, 0x1c, 0x24, 0x24)
 630         else:
 631             sequence = (4, 8, 0xc, 0x10, 0x18, 0x1c, 0x28, 0x20, 0x2c, 0x2c)
 632         for expected in sequence:
 633             self.gdb.stepi()
 634             pc = self.gdb.p("$pc")
 635             assertEqual("%x" % (pc - main_address), "%x" % expected)
 636
 637 class TriggerTest(GdbSingleHartTest):
 638     compile_args = ("programs/trigger.S", )
 639     def setup(self):
 640         self.gdb.load()
 641         self.gdb.b("_exit")
 642         self.gdb.b("main")
 643         self.gdb.c()
 644
 645     def exit(self):
 646         output = self.gdb.c()
 647         assertIn("Breakpoint", output)
 648         assertIn("_exit", output)
 649
 650 class TriggerExecuteInstant(TriggerTest):
 651     """Test an execute breakpoint on the first instruction executed out of
 652     debug mode."""
 653     def test(self):
 654         main_address = self.gdb.p("$pc")
 655         self.gdb.command("hbreak *0x%x" % (main_address + 4))
 656         self.gdb.c()
 657         assertEqual(self.gdb.p("$pc"), main_address+4)
 658
 659 # FIXME: Triggers aren't quite working yet
 660 #class TriggerLoadAddress(TriggerTest):
 661 #    def test(self):
 662 #        self.gdb.command("rwatch *((&data)+1)")
 663 #        output = self.gdb.c()
 664 #        assertIn("read_loop", output)
 665 #        assertEqual(self.gdb.p("$a0"),
 666 #                self.gdb.p("(&data)+1"))
 667 #        self.exit()
 668
 669 class TriggerLoadAddressInstant(TriggerTest):
 670     """Test a load address breakpoint on the first instruction executed out of
 671     debug mode."""
 672     def test(self):
 673         self.gdb.command("b just_before_read_loop")
 674         self.gdb.c()
 675         read_loop = self.gdb.p("&read_loop")
 676         read_again = self.gdb.p("&read_again")
 677         self.gdb.command("rwatch data")
 678         self.gdb.c()
 679         # Accept hitting the breakpoint before or after the load instruction.
 680         assertIn(self.gdb.p("$pc"), [read_loop, read_loop + 4])
 681         assertEqual(self.gdb.p("$a0"), self.gdb.p("&data"))
 682
 683         self.gdb.c()
 684         assertIn(self.gdb.p("$pc"), [read_again, read_again + 4])
 685         assertEqual(self.gdb.p("$a0"), self.gdb.p("&data"))
 686
 687 # FIXME: Triggers aren't quite working yet
 688 #class TriggerStoreAddress(TriggerTest):
 689 #    def test(self):
 690 #        self.gdb.command("watch *((&data)+3)")
 691 #        output = self.gdb.c()
 692 #        assertIn("write_loop", output)
 693 #        assertEqual(self.gdb.p("$a0"),
 694 #                self.gdb.p("(&data)+3"))
 695 #        self.exit()
 696
 697 class TriggerStoreAddressInstant(TriggerTest):
 698     def test(self):
 699         """Test a store address breakpoint on the first instruction executed out
 700         of debug mode."""
 701         self.gdb.command("b just_before_write_loop")
 702         self.gdb.c()
 703         write_loop = self.gdb.p("&write_loop")
 704         self.gdb.command("watch data")
 705         self.gdb.c()
 706         # Accept hitting the breakpoint before or after the store instruction.
 707         assertIn(self.gdb.p("$pc"), [write_loop, write_loop + 4])
 708         assertEqual(self.gdb.p("$a0"), self.gdb.p("&data"))
 709
 710 class TriggerDmode(TriggerTest):
 711     def early_applicable(self):
 712         return self.hart.honors_tdata1_hmode
 713
 714     def check_triggers(self, tdata1_lsbs, tdata2):
 715         dmode = 1 << (self.hart.xlen-5)
 716
 717         triggers = []
 718
 719         if self.hart.xlen == 32:
 720             xlen_type = 'int'
 721         elif self.hart.xlen == 64:
 722             xlen_type = 'long long'
 723         else:
 724             raise NotImplementedError
 725
 726         dmode_count = 0
 727         i = 0
 728         for i in range(16):
 729             tdata1 = self.gdb.p("((%s *)&data)[%d]" % (xlen_type, 2*i))
 730             if tdata1 == 0:
 731                 break
 732             tdata2 = self.gdb.p("((%s *)&data)[%d]" % (xlen_type, 2*i+1))
 733
 734             if tdata1 & dmode:
 735                 dmode_count += 1
 736             else:
 737                 assertEqual(tdata1 & 0xffff, tdata1_lsbs)
 738                 assertEqual(tdata2, tdata2)
 739
 740         assertGreater(i, 1)
 741         assertEqual(dmode_count, 1)
 742
 743         return triggers
 744
 745     def test(self):
 746         self.gdb.command("hbreak write_load_trigger")
 747         self.gdb.b("clear_triggers")
 748         self.gdb.p("$pc=write_store_trigger")
 749         output = self.gdb.c()
 750         assertIn("write_load_trigger", output)
 751         self.check_triggers((1<<6) | (1<<1), 0xdeadbee0)
 752         output = self.gdb.c()
 753         assertIn("clear_triggers", output)
 754         self.check_triggers((1<<6) | (1<<0), 0xfeedac00)
 755
 756 class RegsTest(GdbSingleHartTest):
 757     compile_args = ("programs/regs.S", )
 758     def setup(self):
 759         self.gdb.load()
 760         self.gdb.b("main")
 761         self.gdb.b("handle_trap")
 762         self.gdb.c()
 763
 764 class WriteGprs(RegsTest):
 765     def test(self):
 766         regs = [("x%d" % n) for n in range(2, 32)]
 767
 768         self.gdb.p("$pc=write_regs")
 769         for i, r in enumerate(regs):
 770             self.gdb.p("$%s=%d" % (r, (0xdeadbeef<<i)+17))
 771         self.gdb.p("$x1=data")
 772         self.gdb.command("b all_done")
 773         output = self.gdb.c()
 774         assertIn("Breakpoint ", output)
 775
 776         # Just to get this data in the log.
 777         self.gdb.command("x/30gx data")
 778         self.gdb.command("info registers")
 779         for n in range(len(regs)):
 780             assertEqual(self.gdb.x("data+%d" % (8*n), 'g'),
 781                     ((0xdeadbeef<<n)+17) & ((1<<self.hart.xlen)-1))
 782
 783 class WriteCsrs(RegsTest):
 784     def test(self):
 785         # As much a test of gdb as of the simulator.
 786         self.gdb.p("$mscratch=0")
 787         self.gdb.stepi()
 788         assertEqual(self.gdb.p("$mscratch"), 0)
 789         self.gdb.p("$mscratch=123")
 790         self.gdb.stepi()
 791         assertEqual(self.gdb.p("$mscratch"), 123)
 792
 793         self.gdb.p("$pc=write_regs")
 794         self.gdb.p("$x1=data")
 795         self.gdb.command("b all_done")
 796         self.gdb.command("c")
 797
 798         assertEqual(123, self.gdb.p("$mscratch"))
 799         assertEqual(123, self.gdb.p("$x1"))
 800         assertEqual(123, self.gdb.p("$csr832"))
 801
 802 class DownloadTest(GdbTest):
 803     def setup(self):
 804         # pylint: disable=attribute-defined-outside-init
 805         length = min(2**10, self.hart.ram_size - 2048)
 806         self.download_c = tempfile.NamedTemporaryFile(prefix="download_",
 807                 suffix=".c", delete=False)
 808         self.download_c.write("#include <stdint.h>\n")
 809         self.download_c.write(
 810                 "unsigned int crc32a(uint8_t *message, unsigned int size);\n")
 811         self.download_c.write("uint32_t length = %d;\n" % length)
 812         self.download_c.write("uint8_t d[%d] = {\n" % length)
 813         self.crc = 0
 814         assert length % 16 == 0
 815         for i in range(length / 16):
 816             self.download_c.write("  /* 0x%04x */ " % (i * 16))
 817             for _ in range(16):
 818                 value = random.randrange(1<<8)
 819                 self.download_c.write("0x%02x, " % value)
 820                 self.crc = binascii.crc32("%c" % value, self.crc)
 821             self.download_c.write("\n")
 822         self.download_c.write("};\n")
 823         self.download_c.write("uint8_t *data = &d[0];\n")
 824         self.download_c.write(
 825                 "uint32_t main() { return crc32a(data, length); }\n")
 826         self.download_c.flush()
 827
 828         if self.crc < 0:
 829             self.crc += 2**32
 830
 831         self.binary = self.target.compile(self.hart, self.download_c.name,
 832                 "programs/checksum.c")
 833         self.gdb.command("file %s" % self.binary)
 834
 835     def test(self):
 836         # Some hart will compete the CRC calculation first!
 837         # Let them race in RTOS mode.
 838         # In non-RTOS mode, only one hart will continue.
 839         # This loop will fail because the others won't know
 840         # about '_start'. But if that is the case, they
 841         # won't run on the `continue` either, so we don't really care.
 842         try:
 843             self.gdb.load()
 844             for hart in self.target.harts:
 845                 self.gdb.select_hart(hart)
 846                 self.gdb.p("$pc=_start")
 847         except ValueError: #invalid literal for int() with base 0: 'No symbol table is loaded.  Use the "file" command.'
 848             pass
 849         finally:
 850
 851         self.gdb.select_hart(self.hart)
 852         self.gdb.c()
 853         assertEqual(self.gdb.p("status"), self.crc)
 854         os.unlink(self.download_c.name)
 855
 856 #class MprvTest(GdbSingleHartTest):
 857 #    compile_args = ("programs/mprv.S", )
 858 #    def setup(self):
 859 #        self.gdb.load()
 860 #
 861 #    def test(self):
 862 #        """Test that the debugger can access memory when MPRV is set."""
 863 #        self.gdb.c(wait=False)
 864 #        time.sleep(0.5)
 865 #        self.gdb.interrupt()
 866 #        output = self.gdb.command("p/x *(int*)(((char*)&data)-0x80000000)")
 867 #        assertIn("0xbead", output)
 868
 869 class PrivTest(GdbSingleHartTest):
 870     compile_args = ("programs/priv.S", )
 871     def setup(self):
 872         # pylint: disable=attribute-defined-outside-init
 873         self.gdb.load()
 874
 875         misa = self.hart.misa
 876         self.supported = set()
 877         if misa & (1<<20):
 878             self.supported.add(0)
 879         if misa & (1<<18):
 880             self.supported.add(1)
 881         if misa & (1<<7):
 882             self.supported.add(2)
 883         self.supported.add(3)
 884
 885 class PrivRw(PrivTest):
 886     def test(self):
 887         """Test reading/writing priv."""
 888         # Disable physical memory protection by allowing U mode access to all
 889         # memory.
 890         try:
 891             self.gdb.p("$pmpcfg0=0xf")  # TOR, R, W, X
 892             self.gdb.p("$pmpaddr0=0x%x" %
 893                     ((self.hart.ram + self.hart.ram_size) >> 2))
 894         except testlib.CouldNotFetch:
 895             # PMP registers are optional
 896             pass
 897
 898         # Ensure Virtual Memory is disabled if applicable (SATP register is not
 899         # reset)
 900         try:
 901             self.gdb.p("$satp=0")
 902         except testlib.CouldNotFetch:
 903             # SATP only exists if you have S mode.
 904             pass
 905
 906         # Leave the PC at _start, where the first 4 instructions should be
 907         # legal in any mode.
 908         for privilege in range(4):
 909             self.gdb.p("$priv=%d" % privilege)
 910             self.gdb.stepi()
 911             actual = self.gdb.p("$priv")
 912             assertIn(actual, self.supported)
 913             if privilege in self.supported:
 914                 assertEqual(actual, privilege)
 915
 916 class PrivChange(PrivTest):
 917     def test(self):
 918         """Test that the core's privilege level actually changes."""
 919
 920         if 0 not in self.supported:
 921             return 'not_applicable'
 922
 923         self.gdb.b("main")
 924         self.gdb.c()
 925
 926         # Machine mode
 927         self.gdb.p("$priv=3")
 928         main_address = self.gdb.p("$pc")
 929         self.gdb.stepi()
 930         assertEqual("%x" % self.gdb.p("$pc"), "%x" % (main_address+4))
 931
 932         # User mode
 933         self.gdb.p("$priv=0")
 934         self.gdb.stepi()
 935         # Should have taken an exception, so be nowhere near main.
 936         pc = self.gdb.p("$pc")
 937         assertTrue(pc < main_address or pc > main_address + 0x100)
 938
 939 parsed = None
 940 def main():
 941     parser = argparse.ArgumentParser(
 942             description="Test that gdb can talk to a RISC-V target.",
 943             epilog="""
 944             Example command line from the real world:
 945             Run all RegsTest cases against a physical FPGA, with custom openocd command:
 946             ./gdbserver.py --freedom-e300 --server_cmd "$HOME/SiFive/openocd/src/openocd -s $HOME/SiFive/openocd/tcl -d" Simple
 947             """)
 948     targets.add_target_options(parser)
 949
 950     testlib.add_test_run_options(parser)
 951
 952     # TODO: remove global
 953     global parsed   # pylint: disable=global-statement
 954     parsed = parser.parse_args()
 955     target = targets.target(parsed)
 956     testlib.print_log_names = parsed.print_log_names
 957
 958     module = sys.modules[__name__]
 959
 960     return testlib.run_all_tests(module, target, parsed)
 961
 962 # TROUBLESHOOTING TIPS
 963 # If a particular test fails, run just that one test, eg.:
 964 # ./gdbserver.py MprvTest.test_mprv
 965 # Then inspect gdb.log and spike.log to see what happened in more detail.
 966
 967 if __name__ == '__main__':
 968     sys.exit(main())