Add --gdb-port
[riscv-isa-sim.git] / riscv / gdbserver.cc
index a3663c9ac6e108fe0b956b263fa34f0a327eb9bf..0ab1aef2855961119a603f834b3771fba5b37157 100644 (file)
 #include "disasm.h"
 #include "sim.h"
 #include "gdbserver.h"
+#include "mmu.h"
+
+#define C_EBREAK        0x9002
+#define EBREAK          0x00100073
 
 template <typename T>
 unsigned int circular_buffer_t<T>::size() const
@@ -82,8 +86,6 @@ void circular_buffer_t<T>::append(const T *src, unsigned int count)
   }
 }
 
-// Code inspired by/copied from OpenOCD server/server.c.
-
 gdbserver_t::gdbserver_t(uint16_t port, sim_t *sim) :
   sim(sim),
   client_fd(0),
@@ -91,64 +93,55 @@ gdbserver_t::gdbserver_t(uint16_t port, sim_t *sim) :
 {
   socket_fd = socket(AF_INET, SOCK_STREAM, 0);
   if (socket_fd == -1) {
-    fprintf(stderr, "error creating socket: %s\n", strerror(errno));
+    fprintf(stderr, "failed to make socket: %s (%d)\n", strerror(errno), errno);
     abort();
   }
 
-  int so_reuseaddr_option = 1;
-  setsockopt(socket_fd,
-      SOL_SOCKET,
-      SO_REUSEADDR,
-      (void *)&so_reuseaddr_option,
-      sizeof(int));
-
-  int oldopts = fcntl(socket_fd, F_GETFL, 0);
-  fcntl(socket_fd, F_SETFL, oldopts | O_NONBLOCK);
+  fcntl(socket_fd, F_SETFL, O_NONBLOCK);
+  int reuseaddr = 1;
+  if (setsockopt(socket_fd, SOL_SOCKET, SO_REUSEADDR, &reuseaddr,
+        sizeof(int)) == -1) {
+    fprintf(stderr, "failed setsockopt: %s (%d)\n", strerror(errno), errno);
+    abort();
+  }
 
-  struct sockaddr_in sin;
-  memset(&sin, 0, sizeof(sin));
-  sin.sin_family = AF_INET;
-  sin.sin_addr.s_addr = INADDR_ANY;
-  sin.sin_port = htons(port);
+  struct sockaddr_in addr;
+  memset(&addr, 0, sizeof(addr));
+  addr.sin_family = AF_INET;
+  addr.sin_addr.s_addr = INADDR_ANY;
+  addr.sin_port = htons(port);
 
-  if (bind(socket_fd, (struct sockaddr *)&sin, sizeof(sin)) == -1) {
-    fprintf(stderr, "couldn't bind to socket: %s\n", strerror(errno));
+  if (bind(socket_fd, (struct sockaddr *) &addr, sizeof(addr)) == -1) {
+    fprintf(stderr, "failed to bind socket: %s (%d)\n", strerror(errno), errno);
     abort();
   }
 
-  /* These setsockopt()s must happen before the listen() */
-  int window_size = 128 * 1024;
-  setsockopt(socket_fd, SOL_SOCKET, SO_SNDBUF,
-      (char *)&window_size, sizeof(window_size));
-  setsockopt(socket_fd, SOL_SOCKET, SO_RCVBUF,
-      (char *)&window_size, sizeof(window_size));
-
   if (listen(socket_fd, 1) == -1) {
-    fprintf(stderr, "couldn't listen on socket: %s\n", strerror(errno));
+    fprintf(stderr, "failed to listen on socket: %s (%d)\n", strerror(errno), errno);
     abort();
   }
 }
 
 void gdbserver_t::accept()
 {
-  struct sockaddr client_addr;
-  socklen_t address_size = sizeof(client_addr);
-  client_fd = ::accept(socket_fd, &client_addr, &address_size);
+  client_fd = ::accept(socket_fd, NULL, NULL);
   if (client_fd == -1) {
     if (errno == EAGAIN) {
-      // We'll try again in the next call.
+      // No client waiting to connect right now.
     } else {
-      fprintf(stderr, "failed to accept on socket: %s (%d)\n", strerror(errno), errno);
+      fprintf(stderr, "failed to accept on socket: %s (%d)\n", strerror(errno),
+          errno);
       abort();
     }
   } else {
-    int oldopts = fcntl(client_fd, F_GETFL, 0);
-    fcntl(client_fd, F_SETFL, oldopts | O_NONBLOCK);
+    fcntl(client_fd, F_SETFL, O_NONBLOCK);
+
     expect_ack = false;
+    extended_mode = false;
 
     // gdb wants the core to be halted when it attaches.
     processor_t *p = sim->get_core(0);
-    p->set_halted(true);
+    p->set_halted(true, HR_ATTACHED);
   }
 }
 
@@ -170,11 +163,12 @@ void gdbserver_t::read()
   } else if (bytes == 0) {
     // The remote disconnected.
     client_fd = 0;
+    processor_t *p = sim->get_core(0);
+    p->set_halted(false, HR_NONE);
     recv_buf.reset();
     send_buf.reset();
   } else {
     recv_buf.data_added(bytes);
-    printf("Read %d bytes.\n", bytes);
   }
 }
 
@@ -194,11 +188,11 @@ void gdbserver_t::write()
       // Client can't take any more data right now.
       break;
     } else {
-      printf("wrote %ld bytes: ", bytes);
+      fprintf(stderr, "wrote %ld bytes: ", bytes);
       for (unsigned int i = 0; i < bytes; i++) {
-        printf("%c", send_buf[i]);
+        fprintf(stderr, "%c", send_buf[i]);
       }
-      printf("\n");
+      fprintf(stderr, "\n");
       send_buf.consume(bytes);
     }
   }
@@ -251,7 +245,6 @@ void gdbserver_t::process_requests()
       uint8_t b = recv_buf[i];
 
       if (packet.empty() && expect_ack && b == '+') {
-        fprintf(stderr, "Received ack\n");
         recv_buf.consume(1);
         break;
       }
@@ -266,7 +259,8 @@ void gdbserver_t::process_requests()
       if (b == '$') {
         // Start of new packet.
         if (!packet.empty()) {
-          fprintf(stderr, "Received malformed %ld-byte packet from debug client: ", packet.size());
+          fprintf(stderr, "Received malformed %ld-byte packet from debug client: ",
+              packet.size());
           print_packet(packet);
           recv_buf.consume(i);
           break;
@@ -287,8 +281,6 @@ void gdbserver_t::process_requests()
     // There's a partial packet in the buffer. Wait until we get more data to
     // process it.
     if (packet.size()) {
-      fprintf(stderr, "Partial packet: ");
-      print_packet(packet);
       break;
     }
   }
@@ -299,18 +291,13 @@ void gdbserver_t::handle_halt_reason(const std::vector<uint8_t> &packet)
   send_packet("S00");
 }
 
-void gdbserver_t::handle_read_general_registers(const std::vector<uint8_t> &packet)
+void gdbserver_t::handle_general_registers_read(const std::vector<uint8_t> &packet)
 {
   // Register order that gdb expects is:
   //   "x0",  "x1",  "x2",  "x3",  "x4",  "x5",  "x6",  "x7",
   //   "x8",  "x9",  "x10", "x11", "x12", "x13", "x14", "x15",
   //   "x16", "x17", "x18", "x19", "x20", "x21", "x22", "x23",
   //   "x24", "x25", "x26", "x27", "x28", "x29", "x30", "x31",
-  //   "pc",
-  //   "f0",  "f1",  "f2",  "f3",  "f4",  "f5",  "f6",  "f7",
-  //   "f8",  "f9",  "f10", "f11", "f12", "f13", "f14", "f15",
-  //   "f16", "f17", "f18", "f19", "f20", "f21", "f22", "f23",
-  //   "f24", "f25", "f26", "f27", "f28", "f29", "f30", "f31",
 
   // Each byte of register data is described by two hex digits. The bytes with
   // the register are transmitted in target byte order. The size of each
@@ -328,6 +315,8 @@ void gdbserver_t::handle_read_general_registers(const std::vector<uint8_t> &pack
   expect_ack = true;
 }
 
+// First byte is the most-significant one.
+// Eg. "08675309" becomes 0x08675309.
 uint64_t consume_hex_number(std::vector<uint8_t>::const_iterator &iter,
     std::vector<uint8_t>::const_iterator end)
 {
@@ -345,54 +334,133 @@ uint64_t consume_hex_number(std::vector<uint8_t>::const_iterator &iter,
   return value;
 }
 
-void gdbserver_t::handle_read_register(const std::vector<uint8_t> &packet)
+// First byte is the least-significant one.
+// Eg. "08675309" becomes 0x09536708
+uint64_t consume_hex_number_le(std::vector<uint8_t>::const_iterator &iter,
+    std::vector<uint8_t>::const_iterator end)
 {
-  // p n
+  uint64_t value = 0;
+  unsigned int shift = 4;
 
-  // Register order that gdb expects is:
-  //   "x0",  "x1",  "x2",  "x3",  "x4",  "x5",  "x6",  "x7",
-  //   "x8",  "x9",  "x10", "x11", "x12", "x13", "x14", "x15",
-  //   "x16", "x17", "x18", "x19", "x20", "x21", "x22", "x23",
-  //   "x24", "x25", "x26", "x27", "x28", "x29", "x30", "x31",
-  //   "pc",
-  //   "f0",  "f1",  "f2",  "f3",  "f4",  "f5",  "f6",  "f7",
-  //   "f8",  "f9",  "f10", "f11", "f12", "f13", "f14", "f15",
-  //   "f16", "f17", "f18", "f19", "f20", "f21", "f22", "f23",
-  //   "f24", "f25", "f26", "f27", "f28", "f29", "f30", "f31",
+  while (iter != end) {
+    uint8_t c = *iter;
+    uint64_t c_value = character_hex_value(c);
+    if (c_value > 15)
+      break;
+    iter++;
+    value |= c_value << shift;
+    if ((shift % 8) == 0)
+      shift += 12;
+    else
+      shift -= 4;
+  }
+  return value;
+}
+
+void consume_string(std::string &str, std::vector<uint8_t>::const_iterator &iter,
+    std::vector<uint8_t>::const_iterator end, uint8_t separator)
+{
+  while (iter != end && *iter != separator) {
+    str.append(1, (char) *iter);
+    iter++;
+  }
+}
+
+// gdb's register list is defined in riscv_gdb_reg_names gdb/riscv-tdep.c in
+// its source tree. We must interpret the numbers the same here.
+enum {
+  REG_XPR0 = 0,
+  REG_XPR31 = 31,
+  REG_PC = 32,
+  REG_FPR0 = 33,
+  REG_FPR31 = 64,
+  REG_CSR0 = 65,
+  REG_CSR4095 = 4160,
+  REG_END = 4161
+};
+
+void gdbserver_t::handle_register_read(const std::vector<uint8_t> &packet)
+{
+  // p n
 
   std::vector<uint8_t>::const_iterator iter = packet.begin() + 2;
   unsigned int n = consume_hex_number(iter, packet.end());
   if (*iter != '#')
-    return send_packet("E16"); // EINVAL
+    return send_packet("E01");
 
   processor_t *p = sim->get_core(0);
   send("$");
   running_checksum = 0;
-  if (n < 32) {
-    send(p->state.XPR[n]);
-  } else if (n == 0x20) {
+
+  if (n >= REG_XPR0 && n <= REG_XPR31) {
+    send(p->state.XPR[n - REG_XPR0]);
+  } else if (n == REG_PC) {
     send(p->state.pc);
+  } else if (n >= REG_FPR0 && n <= REG_FPR31) {
+    send(p->state.FPR[n - REG_FPR0]);
+  } else if (n >= REG_CSR0 && n <= REG_CSR4095) {
+    try {
+      send(p->get_csr(n - REG_CSR0));
+    } catch(trap_t& t) {
+      // It would be nicer to return an error here, but if you do that then gdb
+      // exits out of 'info registers all' as soon as it encounters a register
+      // that can't be read.
+      send((reg_t) 0);
+    }
   } else {
-    send("E16");        // EINVAL
+    return send_packet("E02");
   }
 
   send_running_checksum();
   expect_ack = true;
 }
 
-void gdbserver_t::handle_read_memory(const std::vector<uint8_t> &packet)
+void gdbserver_t::handle_register_write(const std::vector<uint8_t> &packet)
+{
+  // P n...=r...
+
+  std::vector<uint8_t>::const_iterator iter = packet.begin() + 2;
+  unsigned int n = consume_hex_number(iter, packet.end());
+  if (*iter != '=')
+    return send_packet("E05");
+  iter++;
+
+  reg_t value = consume_hex_number_le(iter, packet.end());
+  if (*iter != '#')
+    return send_packet("E06");
+
+  processor_t *p = sim->get_core(0);
+
+  if (n >= REG_XPR0 && n <= REG_XPR31) {
+    p->state.XPR.write(n - REG_XPR0, value);
+  } else if (n == REG_PC) {
+    p->state.pc = value;
+  } else if (n >= REG_FPR0 && n <= REG_FPR31) {
+    p->state.FPR.write(n - REG_FPR0, value);
+  } else if (n >= REG_CSR0 && n <= REG_CSR4095) {
+    try {
+      p->set_csr(n - REG_CSR0, value);
+    } catch(trap_t& t) {
+      return send_packet("EFF");
+    }
+  } else {
+    return send_packet("E07");
+  }
+
+  return send_packet("OK");
+}
+
+void gdbserver_t::handle_memory_read(const std::vector<uint8_t> &packet)
 {
   // m addr,length
   std::vector<uint8_t>::const_iterator iter = packet.begin() + 2;
   reg_t address = consume_hex_number(iter, packet.end());
-  printf("address=%lx %c\n", address, *iter);
   if (*iter != ',')
-    return send_packet("E16"); // EINVAL
+    return send_packet("E10");
   iter++;
   reg_t length = consume_hex_number(iter, packet.end());
-  printf("length=%lx %c\n", length, *iter);
   if (*iter != '#')
-    return send_packet("E16"); // EINVAL
+    return send_packet("E11");
 
   send("$");
   running_checksum = 0;
@@ -407,6 +475,170 @@ void gdbserver_t::handle_read_memory(const std::vector<uint8_t> &packet)
   send_running_checksum();
 }
 
+void gdbserver_t::handle_memory_binary_write(const std::vector<uint8_t> &packet)
+{
+  // X addr,length:XX...
+  std::vector<uint8_t>::const_iterator iter = packet.begin() + 2;
+  reg_t address = consume_hex_number(iter, packet.end());
+  if (*iter != ',')
+    return send_packet("E20");
+  iter++;
+  reg_t length = consume_hex_number(iter, packet.end());
+  if (*iter != ':')
+    return send_packet("E21");
+  iter++;
+
+  processor_t *p = sim->get_core(0);
+  mmu_t* mmu = sim->debug_mmu;
+  for (unsigned int i = 0; i < length; i++) {
+    if (iter == packet.end()) {
+      return send_packet("E22");
+    }
+    mmu->store_uint8(address + i, *iter);
+    iter++;
+  }
+  if (*iter != '#')
+    return send_packet("E4b"); // EOVERFLOW
+
+  send_packet("OK");
+}
+
+void gdbserver_t::handle_continue(const std::vector<uint8_t> &packet)
+{
+  // c [addr]
+  processor_t *p = sim->get_core(0);
+  if (packet[2] != '#') {
+    std::vector<uint8_t>::const_iterator iter = packet.begin() + 2;
+    p->state.pc = consume_hex_number(iter, packet.end());
+    if (*iter != '#')
+      return send_packet("E30");
+  }
+
+  p->set_halted(false, HR_NONE);
+  running = true;
+}
+
+void gdbserver_t::handle_step(const std::vector<uint8_t> &packet)
+{
+  // s [addr]
+  processor_t *p = sim->get_core(0);
+  if (packet[2] != '#') {
+    std::vector<uint8_t>::const_iterator iter = packet.begin() + 2;
+    p->state.pc = consume_hex_number(iter, packet.end());
+    if (*iter != '#')
+      return send_packet("E40");
+  }
+
+  p->set_single_step(true);
+  running = true;
+}
+
+void gdbserver_t::handle_kill(const std::vector<uint8_t> &packet)
+{
+  // k
+  // The exact effect of this packet is not specified.
+  // Looks like OpenOCD disconnects?
+  // TODO
+}
+
+void gdbserver_t::handle_extended(const std::vector<uint8_t> &packet)
+{
+  // Enable extended mode. In extended mode, the remote server is made
+  // persistent. The â€˜R’ packet is used to restart the program being debugged.
+  send_packet("OK");
+  extended_mode = true;
+}
+
+void software_breakpoint_t::insert(mmu_t* mmu)
+{
+  if (size == 2) {
+    instruction = mmu->load_uint16(address);
+    mmu->store_uint16(address, C_EBREAK);
+  } else {
+    instruction = mmu->load_uint32(address);
+    mmu->store_uint32(address, EBREAK);
+  }
+  fprintf(stderr, ">>> Read %x from %lx\n", instruction, address);
+}
+
+void software_breakpoint_t::remove(mmu_t* mmu)
+{
+  fprintf(stderr, ">>> write %x to %lx\n", instruction, address);
+  if (size == 2) {
+    mmu->store_uint16(address, instruction);
+  } else {
+    mmu->store_uint32(address, instruction);
+  }
+}
+
+void gdbserver_t::handle_breakpoint(const std::vector<uint8_t> &packet)
+{
+  // insert: Z type,addr,kind
+  // remove: z type,addr,kind
+
+  software_breakpoint_t bp;
+  bool insert = (packet[1] == 'Z');
+  std::vector<uint8_t>::const_iterator iter = packet.begin() + 2;
+  int type = consume_hex_number(iter, packet.end());
+  if (*iter != ',')
+    return send_packet("E50");
+  iter++;
+  bp.address = consume_hex_number(iter, packet.end());
+  if (*iter != ',')
+    return send_packet("E51");
+  iter++;
+  bp.size = consume_hex_number(iter, packet.end());
+  // There may be more options after a ; here, but we don't support that.
+  if (*iter != '#')
+    return send_packet("E52");
+
+  if (bp.size != 2 && bp.size != 4) {
+    return send_packet("E53");
+  }
+
+  processor_t *p = sim->get_core(0);
+  mmu_t* mmu = p->mmu;
+  if (insert) {
+    bp.insert(mmu);
+    breakpoints[bp.address] = bp;
+
+  } else {
+    bp = breakpoints[bp.address];
+    bp.remove(mmu);
+    breakpoints.erase(bp.address);
+  }
+  mmu->flush_icache();
+  sim->debug_mmu->flush_icache();
+  return send_packet("OK");
+}
+
+void gdbserver_t::handle_query(const std::vector<uint8_t> &packet)
+{
+  std::string name;
+  std::vector<uint8_t>::const_iterator iter = packet.begin() + 2;
+
+  consume_string(name, iter, packet.end(), ':');
+  if (iter != packet.end())
+    iter++;
+  if (name == "Supported") {
+    send("$");
+    running_checksum = 0;
+    while (iter != packet.end()) {
+      std::string feature;
+      consume_string(feature, iter, packet.end(), ';');
+      if (iter != packet.end())
+        iter++;
+      if (feature == "swbreak+") {
+        send("swbreak+;");
+      }
+    }
+    return send_running_checksum();
+  }
+
+  fprintf(stderr, "Unsupported query %s\n", name.c_str());
+  return send_packet("");
+}
+
 void gdbserver_t::handle_packet(const std::vector<uint8_t> &packet)
 {
   if (compute_checksum(packet) != extract_checksum(packet)) {
@@ -422,46 +654,76 @@ void gdbserver_t::handle_packet(const std::vector<uint8_t> &packet)
   send("+");
 
   switch (packet[1]) {
+    case '!':
+      return handle_extended(packet);
     case '?':
       return handle_halt_reason(packet);
     case 'g':
-      return handle_read_general_registers(packet);
+      return handle_general_registers_read(packet);
+    case 'k':
+      return handle_kill(packet);
     case 'm':
-      return handle_read_memory(packet);
+      return handle_memory_read(packet);
+//    case 'M':
+//      return handle_memory_write(packet);
+    case 'X':
+      return handle_memory_binary_write(packet);
     case 'p':
-      return handle_read_register(packet);
+      return handle_register_read(packet);
+    case 'P':
+      return handle_register_write(packet);
     case 'c':
       return handle_continue(packet);
+    case 's':
+      return handle_step(packet);
+    case 'z':
+    case 'Z':
+      return handle_breakpoint(packet);
+    case 'q':
+    case 'Q':
+      return handle_query(packet);
   }
 
   // Not supported.
+  fprintf(stderr, "** Unsupported packet: ");
+  print_packet(packet);
   send_packet("");
 }
 
 void gdbserver_t::handle_interrupt()
 {
   processor_t *p = sim->get_core(0);
-  p->set_halted(true);
+  p->set_halted(true, HR_INTERRUPT);
   send_packet("S02");   // Pretend program received SIGINT.
-}
-
-void gdbserver_t::handle_continue(const std::vector<uint8_t> &packet)
-{
-  // c [addr]
-  processor_t *p = sim->get_core(0);
-  if (packet[2] != '#') {
-    std::vector<uint8_t>::const_iterator iter = packet.begin() + 2;
-    p->state.pc = consume_hex_number(iter, packet.end());
-    if (*iter != '#')
-      return send_packet("E16"); // EINVAL
-  }
-
-  p->set_halted(false);
+  running = false;
 }
 
 void gdbserver_t::handle()
 {
   if (client_fd > 0) {
+    processor_t *p = sim->get_core(0);
+    if (running && p->halted) {
+      // The core was running, but now it's halted. Better tell gdb.
+      switch (p->halt_reason) {
+        case HR_NONE:
+          fprintf(stderr, "Internal error. Processor halted without reason.\n");
+          abort();
+        case HR_STEPPED:
+        case HR_INTERRUPT:
+        case HR_CMDLINE:
+        case HR_ATTACHED:
+          // There's no gdb code for this.
+          send_packet("T05");
+          break;
+        case HR_SWBP:
+          send_packet("T05swbreak:;");
+          break;
+      }
+      send_packet("T00");
+      // TODO: Actually include register values here
+      running = false;
+    }
+
     this->read();
     this->write();
 
@@ -484,7 +746,7 @@ void gdbserver_t::send(uint64_t value)
 {
   char buffer[3];
   for (unsigned int i = 0; i < 8; i++) {
-    sprintf(buffer, "%02x", value & 0xff);
+    sprintf(buffer, "%02x", (int) (value & 0xff));
     send(buffer);
     value >>= 8;
   }
@@ -494,7 +756,7 @@ void gdbserver_t::send(uint32_t value)
 {
   char buffer[3];
   for (unsigned int i = 0; i < 4; i++) {
-    sprintf(buffer, "%02x", value & 0xff);
+    sprintf(buffer, "%02x", (int) (value & 0xff));
     send(buffer);
     value >>= 8;
   }