6 #include <sys/socket.h>
17 #include "gdbserver.h"
20 #define C_EBREAK 0x9002
21 #define EBREAK 0x00100073
23 // Functions to generate RISC-V opcodes.
24 // TODO: Does this already exist somewhere?
27 static uint32_t bits(uint32_t value
, unsigned int hi
, unsigned int lo
) {
28 return (value
>> lo
) & ((1 << (hi
+1-lo
)) - 1);
31 static uint32_t bit(uint32_t value
, unsigned int b
) {
32 return (value
>> b
) & 1;
35 static uint32_t jal(unsigned int rd
, uint32_t imm
) {
36 return (bit(imm
, 20) << 31) |
37 (bits(imm
, 10, 1) << 21) |
38 (bit(imm
, 11) << 20) |
39 (bits(imm
, 19, 12) << 12) |
44 static uint32_t csrsi(unsigned int csr
, uint8_t imm
) {
46 (bits(imm
, 4, 0) << 15) |
50 static uint32_t csrr(unsigned int rd
, unsigned int csr
) {
51 return (csr
<< 20) | (rd
<< 15) | MATCH_CSRRS
;
54 static uint32_t sw(unsigned int src
, unsigned int base
, uint16_t offset
)
56 return (bits(offset
, 11, 5) << 25) |
59 (bits(offset
, 4, 0) << 7) |
64 unsigned int circular_buffer_t
<T
>::size() const
69 return end
+ capacity
- start
;
73 void circular_buffer_t
<T
>::consume(unsigned int bytes
)
75 start
= (start
+ bytes
) % capacity
;
79 unsigned int circular_buffer_t
<T
>::contiguous_empty_size() const
83 return capacity
- end
- 1;
85 return capacity
- end
;
87 return start
- end
- 1;
91 unsigned int circular_buffer_t
<T
>::contiguous_data_size() const
96 return capacity
- start
;
100 void circular_buffer_t
<T
>::data_added(unsigned int bytes
)
103 assert(end
<= capacity
);
108 template <typename T
>
109 void circular_buffer_t
<T
>::reset()
115 template <typename T
>
116 void circular_buffer_t
<T
>::append(const T
*src
, unsigned int count
)
118 unsigned int copy
= std::min(count
, contiguous_empty_size());
119 memcpy(contiguous_empty(), src
, copy
* sizeof(T
));
123 assert(count
< contiguous_empty_size());
124 memcpy(contiguous_empty(), src
, count
* sizeof(T
));
129 gdbserver_t::gdbserver_t(uint16_t port
, sim_t
*sim
) :
132 recv_buf(64 * 1024), send_buf(64 * 1024)
134 socket_fd
= socket(AF_INET
, SOCK_STREAM
, 0);
135 if (socket_fd
== -1) {
136 fprintf(stderr
, "failed to make socket: %s (%d)\n", strerror(errno
), errno
);
140 fcntl(socket_fd
, F_SETFL
, O_NONBLOCK
);
142 if (setsockopt(socket_fd
, SOL_SOCKET
, SO_REUSEADDR
, &reuseaddr
,
143 sizeof(int)) == -1) {
144 fprintf(stderr
, "failed setsockopt: %s (%d)\n", strerror(errno
), errno
);
148 struct sockaddr_in addr
;
149 memset(&addr
, 0, sizeof(addr
));
150 addr
.sin_family
= AF_INET
;
151 addr
.sin_addr
.s_addr
= INADDR_ANY
;
152 addr
.sin_port
= htons(port
);
154 if (bind(socket_fd
, (struct sockaddr
*) &addr
, sizeof(addr
)) == -1) {
155 fprintf(stderr
, "failed to bind socket: %s (%d)\n", strerror(errno
), errno
);
159 if (listen(socket_fd
, 1) == -1) {
160 fprintf(stderr
, "failed to listen on socket: %s (%d)\n", strerror(errno
), errno
);
165 void gdbserver_t::write_debug_ram(unsigned int index
, uint32_t value
)
167 sim
->debug_module
.ram_write32(index
, value
);
170 void gdbserver_t::halt()
172 processor_t
*p
= sim
->get_core(0);
173 write_debug_ram(0, csrsi(DCSR_ADDRESS
, DCSR_HALT_OFFSET
));
174 write_debug_ram(1, csrr(S1
, DPC_ADDRESS
));
175 write_debug_ram(2, sw(S1
, 0, (uint16_t) DEBUG_RAM_START
));
176 write_debug_ram(3, csrr(S1
, DCSR_ADDRESS
));
177 write_debug_ram(4, sw(S1
, 0, (uint16_t) DEBUG_RAM_START
+ 8));
178 write_debug_ram(5, jal(0, (uint32_t) (DEBUG_ROM_RESUME
- (DEBUG_RAM_START
+ 4*5))));
179 sim
->debug_module
.set_interrupt(p
->id
);
180 state
= STATE_HALTING
;
183 void gdbserver_t::accept()
185 client_fd
= ::accept(socket_fd
, NULL
, NULL
);
186 if (client_fd
== -1) {
187 if (errno
== EAGAIN
) {
188 // No client waiting to connect right now.
190 fprintf(stderr
, "failed to accept on socket: %s (%d)\n", strerror(errno
),
195 fcntl(client_fd
, F_SETFL
, O_NONBLOCK
);
198 extended_mode
= false;
200 // gdb wants the core to be halted when it attaches.
205 void gdbserver_t::read()
207 // Reading from a non-blocking socket still blocks if there is no data
210 size_t count
= recv_buf
.contiguous_empty_size();
212 ssize_t bytes
= ::read(client_fd
, recv_buf
.contiguous_empty(), count
);
214 if (errno
== EAGAIN
) {
215 // We'll try again the next call.
217 fprintf(stderr
, "failed to read on socket: %s (%d)\n", strerror(errno
), errno
);
220 } else if (bytes
== 0) {
221 // The remote disconnected.
223 processor_t
*p
= sim
->get_core(0);
224 // TODO p->set_halted(false, HR_NONE);
228 recv_buf
.data_added(bytes
);
232 void gdbserver_t::write()
234 if (send_buf
.empty())
237 while (!send_buf
.empty()) {
238 unsigned int count
= send_buf
.contiguous_data_size();
240 ssize_t bytes
= ::write(client_fd
, send_buf
.contiguous_data(), count
);
242 fprintf(stderr
, "failed to write to socket: %s (%d)\n", strerror(errno
), errno
);
244 } else if (bytes
== 0) {
245 // Client can't take any more data right now.
248 fprintf(stderr
, "wrote %ld bytes: ", bytes
);
249 for (unsigned int i
= 0; i
< bytes
; i
++) {
250 fprintf(stderr
, "%c", send_buf
[i
]);
252 fprintf(stderr
, "\n");
253 send_buf
.consume(bytes
);
258 void print_packet(const std::vector
<uint8_t> &packet
)
260 for (uint8_t c
: packet
) {
261 if (c
>= ' ' and c
<= '~')
262 fprintf(stderr
, "%c", c
);
264 fprintf(stderr
, "\\x%x", c
);
266 fprintf(stderr
, "\n");
269 uint8_t compute_checksum(const std::vector
<uint8_t> &packet
)
271 uint8_t checksum
= 0;
272 for (auto i
= packet
.begin() + 1; i
!= packet
.end() - 3; i
++ ) {
278 uint8_t character_hex_value(uint8_t character
)
280 if (character
>= '0' && character
<= '9')
281 return character
- '0';
282 if (character
>= 'a' && character
<= 'f')
283 return 10 + character
- 'a';
284 if (character
>= 'A' && character
<= 'F')
285 return 10 + character
- 'A';
289 uint8_t extract_checksum(const std::vector
<uint8_t> &packet
)
291 return character_hex_value(*(packet
.end() - 1)) +
292 16 * character_hex_value(*(packet
.end() - 2));
295 void gdbserver_t::process_requests()
297 // See https://sourceware.org/gdb/onlinedocs/gdb/Remote-Protocol.html
299 while (!recv_buf
.empty()) {
300 std::vector
<uint8_t> packet
;
301 for (unsigned int i
= 0; i
< recv_buf
.size(); i
++) {
302 uint8_t b
= recv_buf
[i
];
304 if (packet
.empty() && expect_ack
&& b
== '+') {
309 if (packet
.empty() && b
== 3) {
310 fprintf(stderr
, "Received interrupt\n");
317 // Start of new packet.
318 if (!packet
.empty()) {
319 fprintf(stderr
, "Received malformed %ld-byte packet from debug client: ",
321 print_packet(packet
);
329 // Packets consist of $<packet-data>#<checksum>
330 // where <checksum> is
331 if (packet
.size() >= 4 &&
332 packet
[packet
.size()-3] == '#') {
333 handle_packet(packet
);
334 recv_buf
.consume(i
+1);
338 // There's a partial packet in the buffer. Wait until we get more data to
346 void gdbserver_t::handle_halt_reason(const std::vector
<uint8_t> &packet
)
351 void gdbserver_t::handle_general_registers_read(const std::vector
<uint8_t> &packet
)
353 // Register order that gdb expects is:
354 // "x0", "x1", "x2", "x3", "x4", "x5", "x6", "x7",
355 // "x8", "x9", "x10", "x11", "x12", "x13", "x14", "x15",
356 // "x16", "x17", "x18", "x19", "x20", "x21", "x22", "x23",
357 // "x24", "x25", "x26", "x27", "x28", "x29", "x30", "x31",
359 // Each byte of register data is described by two hex digits. The bytes with
360 // the register are transmitted in target byte order. The size of each
361 // register and their position within the ‘g’ packet are determined by the
362 // gdb internal gdbarch functions DEPRECATED_REGISTER_RAW_SIZE and
363 // gdbarch_register_name.
366 running_checksum
= 0;
367 processor_t
*p
= sim
->get_core(0);
368 for (int r
= 0; r
< 32; r
++) {
369 send(p
->state
.XPR
[r
]);
371 send_running_checksum();
375 // First byte is the most-significant one.
376 // Eg. "08675309" becomes 0x08675309.
377 uint64_t consume_hex_number(std::vector
<uint8_t>::const_iterator
&iter
,
378 std::vector
<uint8_t>::const_iterator end
)
382 while (iter
!= end
) {
384 uint64_t c_value
= character_hex_value(c
);
394 // First byte is the least-significant one.
395 // Eg. "08675309" becomes 0x09536708
396 uint64_t consume_hex_number_le(std::vector
<uint8_t>::const_iterator
&iter
,
397 std::vector
<uint8_t>::const_iterator end
)
400 unsigned int shift
= 4;
402 while (iter
!= end
) {
404 uint64_t c_value
= character_hex_value(c
);
408 value
|= c_value
<< shift
;
409 if ((shift
% 8) == 0)
417 void consume_string(std::string
&str
, std::vector
<uint8_t>::const_iterator
&iter
,
418 std::vector
<uint8_t>::const_iterator end
, uint8_t separator
)
420 while (iter
!= end
&& *iter
!= separator
) {
421 str
.append(1, (char) *iter
);
426 // gdb's register list is defined in riscv_gdb_reg_names gdb/riscv-tdep.c in
427 // its source tree. We must interpret the numbers the same here.
439 void gdbserver_t::handle_register_read(const std::vector
<uint8_t> &packet
)
443 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
444 unsigned int n
= consume_hex_number(iter
, packet
.end());
446 return send_packet("E01");
448 processor_t
*p
= sim
->get_core(0);
450 running_checksum
= 0;
452 if (n
>= REG_XPR0
&& n
<= REG_XPR31
) {
453 send(p
->state
.XPR
[n
- REG_XPR0
]);
454 } else if (n
== REG_PC
) {
456 } else if (n
>= REG_FPR0
&& n
<= REG_FPR31
) {
457 send(p
->state
.FPR
[n
- REG_FPR0
]);
458 } else if (n
>= REG_CSR0
&& n
<= REG_CSR4095
) {
460 send(p
->get_csr(n
- REG_CSR0
));
462 // It would be nicer to return an error here, but if you do that then gdb
463 // exits out of 'info registers all' as soon as it encounters a register
464 // that can't be read.
468 return send_packet("E02");
471 send_running_checksum();
475 void gdbserver_t::handle_register_write(const std::vector
<uint8_t> &packet
)
479 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
480 unsigned int n
= consume_hex_number(iter
, packet
.end());
482 return send_packet("E05");
485 reg_t value
= consume_hex_number_le(iter
, packet
.end());
487 return send_packet("E06");
489 processor_t
*p
= sim
->get_core(0);
491 if (n
>= REG_XPR0
&& n
<= REG_XPR31
) {
492 p
->state
.XPR
.write(n
- REG_XPR0
, value
);
493 } else if (n
== REG_PC
) {
495 } else if (n
>= REG_FPR0
&& n
<= REG_FPR31
) {
496 p
->state
.FPR
.write(n
- REG_FPR0
, value
);
497 } else if (n
>= REG_CSR0
&& n
<= REG_CSR4095
) {
499 p
->set_csr(n
- REG_CSR0
, value
);
501 return send_packet("EFF");
504 return send_packet("E07");
507 return send_packet("OK");
510 void gdbserver_t::handle_memory_read(const std::vector
<uint8_t> &packet
)
513 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
514 reg_t address
= consume_hex_number(iter
, packet
.end());
516 return send_packet("E10");
518 reg_t length
= consume_hex_number(iter
, packet
.end());
520 return send_packet("E11");
523 running_checksum
= 0;
525 processor_t
*p
= sim
->get_core(0);
526 mmu_t
* mmu
= sim
->debug_mmu
;
528 for (reg_t i
= 0; i
< length
; i
++) {
529 sprintf(buffer
, "%02x", mmu
->load_uint8(address
+ i
));
532 send_running_checksum();
535 void gdbserver_t::handle_memory_binary_write(const std::vector
<uint8_t> &packet
)
537 // X addr,length:XX...
538 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
539 reg_t address
= consume_hex_number(iter
, packet
.end());
541 return send_packet("E20");
543 reg_t length
= consume_hex_number(iter
, packet
.end());
545 return send_packet("E21");
548 processor_t
*p
= sim
->get_core(0);
549 mmu_t
* mmu
= sim
->debug_mmu
;
550 for (unsigned int i
= 0; i
< length
; i
++) {
551 if (iter
== packet
.end()) {
552 return send_packet("E22");
554 mmu
->store_uint8(address
+ i
, *iter
);
558 return send_packet("E4b"); // EOVERFLOW
563 void gdbserver_t::handle_continue(const std::vector
<uint8_t> &packet
)
566 processor_t
*p
= sim
->get_core(0);
567 if (packet
[2] != '#') {
568 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
569 p
->state
.pc
= consume_hex_number(iter
, packet
.end());
571 return send_packet("E30");
574 // TODO p->set_halted(false, HR_NONE);
575 // TODO running = true;
578 void gdbserver_t::handle_step(const std::vector
<uint8_t> &packet
)
581 processor_t
*p
= sim
->get_core(0);
582 if (packet
[2] != '#') {
583 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
584 p
->state
.pc
= consume_hex_number(iter
, packet
.end());
586 return send_packet("E40");
589 // TODO: p->set_single_step(true);
590 // TODO running = true;
593 void gdbserver_t::handle_kill(const std::vector
<uint8_t> &packet
)
596 // The exact effect of this packet is not specified.
597 // Looks like OpenOCD disconnects?
601 void gdbserver_t::handle_extended(const std::vector
<uint8_t> &packet
)
603 // Enable extended mode. In extended mode, the remote server is made
604 // persistent. The ‘R’ packet is used to restart the program being debugged.
606 extended_mode
= true;
609 void software_breakpoint_t::insert(mmu_t
* mmu
)
612 instruction
= mmu
->load_uint16(address
);
613 mmu
->store_uint16(address
, C_EBREAK
);
615 instruction
= mmu
->load_uint32(address
);
616 mmu
->store_uint32(address
, EBREAK
);
618 fprintf(stderr
, ">>> Read %x from %lx\n", instruction
, address
);
621 void software_breakpoint_t::remove(mmu_t
* mmu
)
623 fprintf(stderr
, ">>> write %x to %lx\n", instruction
, address
);
625 mmu
->store_uint16(address
, instruction
);
627 mmu
->store_uint32(address
, instruction
);
631 void gdbserver_t::handle_breakpoint(const std::vector
<uint8_t> &packet
)
633 // insert: Z type,addr,kind
634 // remove: z type,addr,kind
636 software_breakpoint_t bp
;
637 bool insert
= (packet
[1] == 'Z');
638 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
639 int type
= consume_hex_number(iter
, packet
.end());
641 return send_packet("E50");
643 bp
.address
= consume_hex_number(iter
, packet
.end());
645 return send_packet("E51");
647 bp
.size
= consume_hex_number(iter
, packet
.end());
648 // There may be more options after a ; here, but we don't support that.
650 return send_packet("E52");
652 if (bp
.size
!= 2 && bp
.size
!= 4) {
653 return send_packet("E53");
656 processor_t
*p
= sim
->get_core(0);
660 breakpoints
[bp
.address
] = bp
;
663 bp
= breakpoints
[bp
.address
];
665 breakpoints
.erase(bp
.address
);
668 sim
->debug_mmu
->flush_icache();
669 return send_packet("OK");
672 void gdbserver_t::handle_query(const std::vector
<uint8_t> &packet
)
675 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
677 consume_string(name
, iter
, packet
.end(), ':');
678 if (iter
!= packet
.end())
680 if (name
== "Supported") {
682 running_checksum
= 0;
683 while (iter
!= packet
.end()) {
685 consume_string(feature
, iter
, packet
.end(), ';');
686 if (iter
!= packet
.end())
688 if (feature
== "swbreak+") {
692 return send_running_checksum();
695 fprintf(stderr
, "Unsupported query %s\n", name
.c_str());
696 return send_packet("");
699 void gdbserver_t::handle_packet(const std::vector
<uint8_t> &packet
)
701 if (compute_checksum(packet
) != extract_checksum(packet
)) {
702 fprintf(stderr
, "Received %ld-byte packet with invalid checksum\n", packet
.size());
703 fprintf(stderr
, "Computed checksum: %x\n", compute_checksum(packet
));
704 print_packet(packet
);
709 fprintf(stderr
, "Received %ld-byte packet from debug client: ", packet
.size());
710 print_packet(packet
);
715 return handle_extended(packet
);
717 return handle_halt_reason(packet
);
719 return handle_general_registers_read(packet
);
721 return handle_kill(packet
);
723 return handle_memory_read(packet
);
725 // return handle_memory_write(packet);
727 return handle_memory_binary_write(packet
);
729 return handle_register_read(packet
);
731 return handle_register_write(packet
);
733 return handle_continue(packet
);
735 return handle_step(packet
);
738 return handle_breakpoint(packet
);
741 return handle_query(packet
);
745 fprintf(stderr
, "** Unsupported packet: ");
746 print_packet(packet
);
750 void gdbserver_t::handle_interrupt()
752 processor_t
*p
= sim
->get_core(0);
753 // TODO p->set_halted(true, HR_INTERRUPT);
754 send_packet("S02"); // Pretend program received SIGINT.
755 // TODO running = false;
758 void gdbserver_t::handle()
761 processor_t
*p
= sim
->get_core(0);
763 if (state
== STATE_HALTING
&& sim
->debug_module
.get_interrupt(p
->id
) == 0) {
764 // gdb requested a halt and now it's done.
766 state
= STATE_HALTED
;
770 if (running && p->halted) {
771 // The core was running, but now it's halted. Better tell gdb.
772 switch (p->halt_reason) {
774 fprintf(stderr, "Internal error. Processor halted without reason.\n");
780 // There's no gdb code for this.
784 send_packet("T05swbreak:;");
788 // TODO: Actually include register values here
800 this->process_requests();
803 void gdbserver_t::send(const char* msg
)
805 unsigned int length
= strlen(msg
);
806 for (const char *c
= msg
; *c
; c
++)
807 running_checksum
+= *c
;
808 send_buf
.append((const uint8_t *) msg
, length
);
811 void gdbserver_t::send(uint64_t value
)
814 for (unsigned int i
= 0; i
< 8; i
++) {
815 sprintf(buffer
, "%02x", (int) (value
& 0xff));
821 void gdbserver_t::send(uint32_t value
)
824 for (unsigned int i
= 0; i
< 4; i
++) {
825 sprintf(buffer
, "%02x", (int) (value
& 0xff));
831 void gdbserver_t::send_packet(const char* data
)
834 running_checksum
= 0;
836 send_running_checksum();
840 void gdbserver_t::send_running_checksum()
842 char checksum_string
[4];
843 sprintf(checksum_string
, "#%02x", running_checksum
);
844 send(checksum_string
);