Ignore MPRV in Debug Mode.
[riscv-isa-sim.git] / riscv / gdbserver.h
index d81790d4aebb6c4e5601fb9a680e20ea05d54ca0..621114635d28741acc1eed88ad78710d4bb33767 100644 (file)
@@ -1,6 +1,9 @@
 #ifndef _RISCV_GDBSERVER_H
 #define _RISCV_GDBSERVER_H
 
+#include <map>
+#include <queue>
+
 #include <stdint.h>
 
 class sim_t;
@@ -13,7 +16,7 @@ public:
   circular_buffer_t(unsigned int capacity) : data(new T[capacity]),
       start(0), end(0), capacity(capacity) {}
   circular_buffer_t() : start(0), end(0), capacity(0) {}
-  ~circular_buffer_t() { delete data; }
+  ~circular_buffer_t() { delete[] data; }
 
   T *data;
   unsigned int start;   // Data start, inclusive.
@@ -42,6 +45,42 @@ public:
   void append(const T *src, unsigned int count);
 };
 
+// Class to track software breakpoints that we set.
+class software_breakpoint_t
+{
+public:
+  reg_t address;
+  unsigned int size;
+  unsigned char instruction[4];
+};
+
+class gdbserver_t;
+
+class operation_t
+{
+  public:
+    operation_t(gdbserver_t& gdbserver) : gs(gdbserver), current_step(0) {}
+    virtual ~operation_t() {}
+
+    bool step() {
+      bool result = perform_step(current_step);
+      current_step++;
+      return result;
+    }
+
+    // Perform the next step of this operation (which is probably to write to
+    // Debug RAM and assert the debug interrupt).
+    // Return true if this operation is complete. In that case the object will
+    // be deleted.
+    // Return false if more steps are required the next time the debug
+    // interrupt is clear.
+    virtual bool perform_step(unsigned int step) = 0;
+
+  protected:
+    gdbserver_t& gs;
+    unsigned int current_step;
+};
+
 class gdbserver_t
 {
 public:
@@ -53,9 +92,67 @@ public:
   void handle();
 
   void handle_packet(const std::vector<uint8_t> &packet);
+  void handle_interrupt();
+
+  void handle_breakpoint(const std::vector<uint8_t> &packet);
+  void handle_continue(const std::vector<uint8_t> &packet);
+  void handle_extended(const std::vector<uint8_t> &packet);
+  void handle_general_registers_read(const std::vector<uint8_t> &packet);
+  void continue_general_registers_read();
   void handle_halt_reason(const std::vector<uint8_t> &packet);
-  void handle_read_general_registers(const std::vector<uint8_t> &packet);
-  void handle_read_memory(const std::vector<uint8_t> &packet);
+  void handle_kill(const std::vector<uint8_t> &packet);
+  void handle_memory_binary_write(const std::vector<uint8_t> &packet);
+  void handle_memory_read(const std::vector<uint8_t> &packet);
+  void handle_query(const std::vector<uint8_t> &packet);
+  void handle_register_read(const std::vector<uint8_t> &packet);
+  void continue_register_read();
+  void handle_register_write(const std::vector<uint8_t> &packet);
+  void handle_step(const std::vector<uint8_t> &packet);
+
+  bool connected() const { return client_fd > 0; }
+
+  // TODO: Move this into its own packet sending class?
+  // Add the given message to send_buf.
+  void send(const char* msg);
+  // Hex-encode a 64-bit value, and send it to gcc in target byte order (little
+  // endian).
+  void send(uint64_t value);
+  // Hex-encode a 32-bit value, and send it to gcc in target byte order (little
+  // endian).
+  void send(uint32_t value);
+  void send_packet(const char* data);
+  uint8_t running_checksum;
+  // Send "$" and clear running checksum.
+  void start_packet();
+  // Send "#" and checksum.
+  void end_packet(const char* data=NULL);
+
+  // Write value to the index'th word in Debug RAM.
+  void write_debug_ram(unsigned int index, uint32_t value);
+  uint32_t read_debug_ram(unsigned int index);
+
+  void set_interrupt(uint32_t hartid);
+
+  // Members that ought to be privated, but that we'd really like to access
+  // from operation classes.
+  reg_t saved_dpc;
+  reg_t saved_mbadaddr;
+  reg_t saved_mcause;
+  reg_t saved_mstatus;
+  reg_t dcsr;
+  reg_t sptbr;
+  bool sptbr_valid;
+  bool fence_i_required;
+
+  std::map<reg_t, reg_t> pte_cache;
+
+  reg_t translate(reg_t vaddr);
+  // Return the PRV_x that is used when the code under debug performs a memory
+  // access.
+  unsigned int privilege_mode();
+  // Return the VM_x that is used when the code under debug performs a memory
+  // access.
+  unsigned int virtual_memory();
 
 private:
   sim_t *sim;
@@ -65,6 +162,12 @@ private:
   circular_buffer_t<uint8_t> send_buf;
 
   bool expect_ack;
+  bool extended_mode;
+  // Used to track whether we think the target is running. If we think it is
+  // but it isn't, we need to tell gdb about it.
+  bool running;
+
+  std::map <reg_t, software_breakpoint_t*> breakpoints;
 
   // Read pending data from the client.
   void read();
@@ -73,11 +176,9 @@ private:
   void accept();
   // Process all complete requests in recv_buf.
   void process_requests();
-  // Add the given message to send_buf.
-  void send(const char* msg);
-  void send_packet(const char* data);
-  uint8_t running_checksum;
-  void send_running_checksum();
+
+  std::queue<operation_t*> operation_queue;
+  void add_operation(operation_t* operation);
 };
 
 #endif