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?
26 // Using regnames.cc as source. The RVG Calling Convention of the 2.0 RISC-V
27 // spec says it should be 2 and 3.
30 static uint32_t bits(uint32_t value
, unsigned int hi
, unsigned int lo
) {
31 return (value
>> lo
) & ((1 << (hi
+1-lo
)) - 1);
34 static uint32_t bit(uint32_t value
, unsigned int b
) {
35 return (value
>> b
) & 1;
38 static uint32_t jal(unsigned int rd
, uint32_t imm
) {
39 return (bit(imm
, 20) << 31) |
40 (bits(imm
, 10, 1) << 21) |
41 (bit(imm
, 11) << 20) |
42 (bits(imm
, 19, 12) << 12) |
47 static uint32_t csrsi(unsigned int csr
, uint8_t imm
) {
49 (bits(imm
, 4, 0) << 15) |
53 static uint32_t csrr(unsigned int rd
, unsigned int csr
) {
54 return (csr
<< 20) | (rd
<< 7) | MATCH_CSRRS
;
57 static uint32_t sw(unsigned int src
, unsigned int base
, uint16_t offset
)
59 return (bits(offset
, 11, 5) << 25) |
62 (bits(offset
, 4, 0) << 7) |
66 static uint32_t sd(unsigned int src
, unsigned int base
, uint16_t offset
)
68 return (bits(offset
, 11, 5) << 25) |
71 (bits(offset
, 4, 0) << 7) |
76 unsigned int circular_buffer_t
<T
>::size() const
81 return end
+ capacity
- start
;
85 void circular_buffer_t
<T
>::consume(unsigned int bytes
)
87 start
= (start
+ bytes
) % capacity
;
91 unsigned int circular_buffer_t
<T
>::contiguous_empty_size() const
95 return capacity
- end
- 1;
97 return capacity
- end
;
99 return start
- end
- 1;
102 template <typename T
>
103 unsigned int circular_buffer_t
<T
>::contiguous_data_size() const
108 return capacity
- start
;
111 template <typename T
>
112 void circular_buffer_t
<T
>::data_added(unsigned int bytes
)
115 assert(end
<= capacity
);
120 template <typename T
>
121 void circular_buffer_t
<T
>::reset()
127 template <typename T
>
128 void circular_buffer_t
<T
>::append(const T
*src
, unsigned int count
)
130 unsigned int copy
= std::min(count
, contiguous_empty_size());
131 memcpy(contiguous_empty(), src
, copy
* sizeof(T
));
135 assert(count
< contiguous_empty_size());
136 memcpy(contiguous_empty(), src
, count
* sizeof(T
));
141 gdbserver_t::gdbserver_t(uint16_t port
, sim_t
*sim
) :
144 recv_buf(64 * 1024), send_buf(64 * 1024)
146 socket_fd
= socket(AF_INET
, SOCK_STREAM
, 0);
147 if (socket_fd
== -1) {
148 fprintf(stderr
, "failed to make socket: %s (%d)\n", strerror(errno
), errno
);
152 fcntl(socket_fd
, F_SETFL
, O_NONBLOCK
);
154 if (setsockopt(socket_fd
, SOL_SOCKET
, SO_REUSEADDR
, &reuseaddr
,
155 sizeof(int)) == -1) {
156 fprintf(stderr
, "failed setsockopt: %s (%d)\n", strerror(errno
), errno
);
160 struct sockaddr_in addr
;
161 memset(&addr
, 0, sizeof(addr
));
162 addr
.sin_family
= AF_INET
;
163 addr
.sin_addr
.s_addr
= INADDR_ANY
;
164 addr
.sin_port
= htons(port
);
166 if (bind(socket_fd
, (struct sockaddr
*) &addr
, sizeof(addr
)) == -1) {
167 fprintf(stderr
, "failed to bind socket: %s (%d)\n", strerror(errno
), errno
);
171 if (listen(socket_fd
, 1) == -1) {
172 fprintf(stderr
, "failed to listen on socket: %s (%d)\n", strerror(errno
), errno
);
177 void gdbserver_t::write_debug_ram(unsigned int index
, uint32_t value
)
179 sim
->debug_module
.ram_write32(index
, value
);
182 uint32_t gdbserver_t::read_debug_ram(unsigned int index
)
184 return sim
->debug_module
.ram_read32(index
);
187 void gdbserver_t::halt()
189 // TODO: For now we just assume the target is 64-bit.
190 write_debug_ram(0, csrsi(DCSR_ADDRESS
, DCSR_HALT_MASK
));
191 write_debug_ram(1, csrr(S0
, DPC_ADDRESS
));
192 write_debug_ram(2, sd(S0
, 0, (uint16_t) DEBUG_RAM_START
));
193 write_debug_ram(3, csrr(S0
, DCSR_ADDRESS
));
194 write_debug_ram(4, sd(S0
, 0, (uint16_t) DEBUG_RAM_START
+ 8));
195 write_debug_ram(5, jal(0, (uint32_t) (DEBUG_ROM_RESUME
- (DEBUG_RAM_START
+ 4*5))));
196 sim
->debug_module
.set_interrupt(0);
197 state
= STATE_HALTING
;
200 void gdbserver_t::accept()
202 client_fd
= ::accept(socket_fd
, NULL
, NULL
);
203 if (client_fd
== -1) {
204 if (errno
== EAGAIN
) {
205 // No client waiting to connect right now.
207 fprintf(stderr
, "failed to accept on socket: %s (%d)\n", strerror(errno
),
212 fcntl(client_fd
, F_SETFL
, O_NONBLOCK
);
215 extended_mode
= false;
217 // gdb wants the core to be halted when it attaches.
222 void gdbserver_t::read()
224 // Reading from a non-blocking socket still blocks if there is no data
227 size_t count
= recv_buf
.contiguous_empty_size();
229 ssize_t bytes
= ::read(client_fd
, recv_buf
.contiguous_empty(), count
);
231 if (errno
== EAGAIN
) {
232 // We'll try again the next call.
234 fprintf(stderr
, "failed to read on socket: %s (%d)\n", strerror(errno
), errno
);
237 } else if (bytes
== 0) {
238 // The remote disconnected.
240 processor_t
*p
= sim
->get_core(0);
241 // TODO p->set_halted(false, HR_NONE);
245 recv_buf
.data_added(bytes
);
249 void gdbserver_t::write()
251 if (send_buf
.empty())
254 while (!send_buf
.empty()) {
255 unsigned int count
= send_buf
.contiguous_data_size();
257 ssize_t bytes
= ::write(client_fd
, send_buf
.contiguous_data(), count
);
259 fprintf(stderr
, "failed to write to socket: %s (%d)\n", strerror(errno
), errno
);
261 } else if (bytes
== 0) {
262 // Client can't take any more data right now.
265 fprintf(stderr
, "wrote %ld bytes: ", bytes
);
266 for (unsigned int i
= 0; i
< bytes
; i
++) {
267 fprintf(stderr
, "%c", send_buf
[i
]);
269 fprintf(stderr
, "\n");
270 send_buf
.consume(bytes
);
275 void print_packet(const std::vector
<uint8_t> &packet
)
277 for (uint8_t c
: packet
) {
278 if (c
>= ' ' and c
<= '~')
279 fprintf(stderr
, "%c", c
);
281 fprintf(stderr
, "\\x%x", c
);
283 fprintf(stderr
, "\n");
286 uint8_t compute_checksum(const std::vector
<uint8_t> &packet
)
288 uint8_t checksum
= 0;
289 for (auto i
= packet
.begin() + 1; i
!= packet
.end() - 3; i
++ ) {
295 uint8_t character_hex_value(uint8_t character
)
297 if (character
>= '0' && character
<= '9')
298 return character
- '0';
299 if (character
>= 'a' && character
<= 'f')
300 return 10 + character
- 'a';
301 if (character
>= 'A' && character
<= 'F')
302 return 10 + character
- 'A';
306 uint8_t extract_checksum(const std::vector
<uint8_t> &packet
)
308 return character_hex_value(*(packet
.end() - 1)) +
309 16 * character_hex_value(*(packet
.end() - 2));
312 void gdbserver_t::process_requests()
314 // See https://sourceware.org/gdb/onlinedocs/gdb/Remote-Protocol.html
316 while (!recv_buf
.empty()) {
317 std::vector
<uint8_t> packet
;
318 for (unsigned int i
= 0; i
< recv_buf
.size(); i
++) {
319 uint8_t b
= recv_buf
[i
];
321 if (packet
.empty() && expect_ack
&& b
== '+') {
326 if (packet
.empty() && b
== 3) {
327 fprintf(stderr
, "Received interrupt\n");
334 // Start of new packet.
335 if (!packet
.empty()) {
336 fprintf(stderr
, "Received malformed %ld-byte packet from debug client: ",
338 print_packet(packet
);
346 // Packets consist of $<packet-data>#<checksum>
347 // where <checksum> is
348 if (packet
.size() >= 4 &&
349 packet
[packet
.size()-3] == '#') {
350 handle_packet(packet
);
351 recv_buf
.consume(i
+1);
355 // There's a partial packet in the buffer. Wait until we get more data to
363 void gdbserver_t::handle_halt_reason(const std::vector
<uint8_t> &packet
)
368 void die(const char* msg
)
370 fprintf(stderr
, "gdbserver code died: %s\n", msg
);
374 void gdbserver_t::handle_general_registers_read(const std::vector
<uint8_t> &packet
)
376 // Register order that gdb expects is:
377 // "x0", "x1", "x2", "x3", "x4", "x5", "x6", "x7",
378 // "x8", "x9", "x10", "x11", "x12", "x13", "x14", "x15",
379 // "x16", "x17", "x18", "x19", "x20", "x21", "x22", "x23",
380 // "x24", "x25", "x26", "x27", "x28", "x29", "x30", "x31",
382 // Each byte of register data is described by two hex digits. The bytes with
383 // the register are transmitted in target byte order. The size of each
384 // register and their position within the ‘g’ packet are determined by the
385 // gdb internal gdbarch functions DEPRECATED_REGISTER_RAW_SIZE and
386 // gdbarch_register_name.
389 running_checksum
= 0;
390 processor_t
*p
= sim
->get_core(0);
392 // x0 is always zero.
395 write_debug_ram(0, sd(1, 0, (uint16_t) DEBUG_RAM_START
+ 16));
396 write_debug_ram(1, sd(2, 0, (uint16_t) DEBUG_RAM_START
+ 0));
397 write_debug_ram(2, jal(0, (uint32_t) (DEBUG_ROM_RESUME
- (DEBUG_RAM_START
+ 4*2))));
398 sim
->debug_module
.set_interrupt(0);
399 state
= STATE_CONT_GENERAL_REGISTERS
;
403 void gdbserver_t::continue_general_registers_read()
405 send(((uint64_t) read_debug_ram(5) << 32) | read_debug_ram(4));
406 if (state_argument
>= 31) {
407 send_running_checksum();
409 state
= STATE_HALTED
;
411 send(((uint64_t) read_debug_ram(1) << 32) | read_debug_ram(0));
414 // TODO properly read s0 and s1
415 write_debug_ram(0, sd(state_argument
, 0, (uint16_t) DEBUG_RAM_START
+ 16));
416 write_debug_ram(1, sd(state_argument
+1, 0, (uint16_t) DEBUG_RAM_START
+ 0));
417 write_debug_ram(2, jal(0, (uint32_t) (DEBUG_ROM_RESUME
- (DEBUG_RAM_START
+ 4*2))));
418 sim
->debug_module
.set_interrupt(0);
419 state
= STATE_CONT_GENERAL_REGISTERS
;
423 // First byte is the most-significant one.
424 // Eg. "08675309" becomes 0x08675309.
425 uint64_t consume_hex_number(std::vector
<uint8_t>::const_iterator
&iter
,
426 std::vector
<uint8_t>::const_iterator end
)
430 while (iter
!= end
) {
432 uint64_t c_value
= character_hex_value(c
);
442 // First byte is the least-significant one.
443 // Eg. "08675309" becomes 0x09536708
444 uint64_t consume_hex_number_le(std::vector
<uint8_t>::const_iterator
&iter
,
445 std::vector
<uint8_t>::const_iterator end
)
448 unsigned int shift
= 4;
450 while (iter
!= end
) {
452 uint64_t c_value
= character_hex_value(c
);
456 value
|= c_value
<< shift
;
457 if ((shift
% 8) == 0)
465 void consume_string(std::string
&str
, std::vector
<uint8_t>::const_iterator
&iter
,
466 std::vector
<uint8_t>::const_iterator end
, uint8_t separator
)
468 while (iter
!= end
&& *iter
!= separator
) {
469 str
.append(1, (char) *iter
);
474 // gdb's register list is defined in riscv_gdb_reg_names gdb/riscv-tdep.c in
475 // its source tree. We must interpret the numbers the same here.
487 void gdbserver_t::handle_register_read(const std::vector
<uint8_t> &packet
)
491 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
492 unsigned int n
= consume_hex_number(iter
, packet
.end());
494 return send_packet("E01");
496 state
= STATE_CONT_REGISTER_READ
;
499 if (n
>= REG_XPR0
&& n
<= REG_XPR31
) {
500 die("handle_register_read");
501 // send(p->state.XPR[n - REG_XPR0]);
502 } else if (n
== REG_PC
) {
503 write_debug_ram(0, csrr(S0
, DPC_ADDRESS
));
504 write_debug_ram(1, sd(S0
, 0, (uint16_t) DEBUG_RAM_START
));
505 write_debug_ram(2, jal(0, (uint32_t) (DEBUG_ROM_RESUME
- (DEBUG_RAM_START
+ 4*2))));
506 sim
->debug_module
.set_interrupt(0);
507 } else if (n
>= REG_FPR0
&& n
<= REG_FPR31
) {
508 die("handle_register_read");
509 // send(p->state.FPR[n - REG_FPR0]);
510 } else if (n
>= REG_CSR0
&& n
<= REG_CSR4095
) {
512 die("handle_register_read");
513 // send(p->get_csr(n - REG_CSR0));
515 // It would be nicer to return an error here, but if you do that then gdb
516 // exits out of 'info registers all' as soon as it encounters a register
517 // that can't be read.
521 state
= STATE_HALTED
;
522 return send_packet("E02");
526 void gdbserver_t::continue_register_read()
529 running_checksum
= 0;
531 send(((uint64_t) read_debug_ram(1) << 32) | read_debug_ram(0));
533 send_running_checksum();
535 state
= STATE_HALTED
;
538 void gdbserver_t::handle_register_write(const std::vector
<uint8_t> &packet
)
542 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
543 unsigned int n
= consume_hex_number(iter
, packet
.end());
545 return send_packet("E05");
548 reg_t value
= consume_hex_number_le(iter
, packet
.end());
550 return send_packet("E06");
552 processor_t
*p
= sim
->get_core(0);
554 die("handle_register_write");
556 if (n >= REG_XPR0 && n <= REG_XPR31) {
557 p->state.XPR.write(n - REG_XPR0, value);
558 } else if (n == REG_PC) {
560 } else if (n >= REG_FPR0 && n <= REG_FPR31) {
561 p->state.FPR.write(n - REG_FPR0, value);
562 } else if (n >= REG_CSR0 && n <= REG_CSR4095) {
564 p->set_csr(n - REG_CSR0, value);
566 return send_packet("EFF");
569 return send_packet("E07");
573 return send_packet("OK");
576 void gdbserver_t::handle_memory_read(const std::vector
<uint8_t> &packet
)
579 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
580 reg_t address
= consume_hex_number(iter
, packet
.end());
582 return send_packet("E10");
584 reg_t length
= consume_hex_number(iter
, packet
.end());
586 return send_packet("E11");
589 running_checksum
= 0;
591 processor_t
*p
= sim
->get_core(0);
592 mmu_t
* mmu
= sim
->debug_mmu
;
594 for (reg_t i
= 0; i
< length
; i
++) {
595 sprintf(buffer
, "%02x", mmu
->load_uint8(address
+ i
));
598 send_running_checksum();
601 void gdbserver_t::handle_memory_binary_write(const std::vector
<uint8_t> &packet
)
603 // X addr,length:XX...
604 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
605 reg_t address
= consume_hex_number(iter
, packet
.end());
607 return send_packet("E20");
609 reg_t length
= consume_hex_number(iter
, packet
.end());
611 return send_packet("E21");
614 processor_t
*p
= sim
->get_core(0);
615 mmu_t
* mmu
= sim
->debug_mmu
;
616 for (unsigned int i
= 0; i
< length
; i
++) {
617 if (iter
== packet
.end()) {
618 return send_packet("E22");
620 mmu
->store_uint8(address
+ i
, *iter
);
624 return send_packet("E4b"); // EOVERFLOW
629 void gdbserver_t::handle_continue(const std::vector
<uint8_t> &packet
)
632 processor_t
*p
= sim
->get_core(0);
633 if (packet
[2] != '#') {
634 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
635 die("handle_continue");
636 // p->state.pc = consume_hex_number(iter, packet.end());
638 return send_packet("E30");
641 // TODO p->set_halted(false, HR_NONE);
642 // TODO running = true;
645 void gdbserver_t::handle_step(const std::vector
<uint8_t> &packet
)
648 processor_t
*p
= sim
->get_core(0);
649 if (packet
[2] != '#') {
650 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
652 //p->state.pc = consume_hex_number(iter, packet.end());
654 return send_packet("E40");
657 // TODO: p->set_single_step(true);
658 // TODO running = true;
661 void gdbserver_t::handle_kill(const std::vector
<uint8_t> &packet
)
664 // The exact effect of this packet is not specified.
665 // Looks like OpenOCD disconnects?
669 void gdbserver_t::handle_extended(const std::vector
<uint8_t> &packet
)
671 // Enable extended mode. In extended mode, the remote server is made
672 // persistent. The ‘R’ packet is used to restart the program being debugged.
674 extended_mode
= true;
677 void software_breakpoint_t::insert(mmu_t
* mmu
)
680 instruction
= mmu
->load_uint16(address
);
681 mmu
->store_uint16(address
, C_EBREAK
);
683 instruction
= mmu
->load_uint32(address
);
684 mmu
->store_uint32(address
, EBREAK
);
686 fprintf(stderr
, ">>> Read %x from %lx\n", instruction
, address
);
689 void software_breakpoint_t::remove(mmu_t
* mmu
)
691 fprintf(stderr
, ">>> write %x to %lx\n", instruction
, address
);
693 mmu
->store_uint16(address
, instruction
);
695 mmu
->store_uint32(address
, instruction
);
699 void gdbserver_t::handle_breakpoint(const std::vector
<uint8_t> &packet
)
701 // insert: Z type,addr,kind
702 // remove: z type,addr,kind
704 software_breakpoint_t bp
;
705 bool insert
= (packet
[1] == 'Z');
706 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
707 int type
= consume_hex_number(iter
, packet
.end());
709 return send_packet("E50");
711 bp
.address
= consume_hex_number(iter
, packet
.end());
713 return send_packet("E51");
715 bp
.size
= consume_hex_number(iter
, packet
.end());
716 // There may be more options after a ; here, but we don't support that.
718 return send_packet("E52");
720 if (bp
.size
!= 2 && bp
.size
!= 4) {
721 return send_packet("E53");
724 processor_t
*p
= sim
->get_core(0);
725 die("handle_breakpoint");
730 breakpoints[bp.address] = bp;
733 bp = breakpoints[bp.address];
735 breakpoints.erase(bp.address);
738 sim->debug_mmu->flush_icache();
740 return send_packet("OK");
743 void gdbserver_t::handle_query(const std::vector
<uint8_t> &packet
)
746 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
748 consume_string(name
, iter
, packet
.end(), ':');
749 if (iter
!= packet
.end())
751 if (name
== "Supported") {
753 running_checksum
= 0;
754 while (iter
!= packet
.end()) {
756 consume_string(feature
, iter
, packet
.end(), ';');
757 if (iter
!= packet
.end())
759 if (feature
== "swbreak+") {
763 return send_running_checksum();
766 fprintf(stderr
, "Unsupported query %s\n", name
.c_str());
767 return send_packet("");
770 void gdbserver_t::handle_packet(const std::vector
<uint8_t> &packet
)
772 if (compute_checksum(packet
) != extract_checksum(packet
)) {
773 fprintf(stderr
, "Received %ld-byte packet with invalid checksum\n", packet
.size());
774 fprintf(stderr
, "Computed checksum: %x\n", compute_checksum(packet
));
775 print_packet(packet
);
780 fprintf(stderr
, "Received %ld-byte packet from debug client: ", packet
.size());
781 print_packet(packet
);
786 return handle_extended(packet
);
788 return handle_halt_reason(packet
);
790 return handle_general_registers_read(packet
);
792 return handle_kill(packet
);
794 return handle_memory_read(packet
);
796 // return handle_memory_write(packet);
798 return handle_memory_binary_write(packet
);
800 return handle_register_read(packet
);
802 return handle_register_write(packet
);
804 return handle_continue(packet
);
806 return handle_step(packet
);
809 return handle_breakpoint(packet
);
812 return handle_query(packet
);
816 fprintf(stderr
, "** Unsupported packet: ");
817 print_packet(packet
);
821 void gdbserver_t::handle_interrupt()
823 processor_t
*p
= sim
->get_core(0);
824 // TODO p->set_halted(true, HR_INTERRUPT);
825 send_packet("S02"); // Pretend program received SIGINT.
826 // TODO running = false;
829 void gdbserver_t::handle()
832 processor_t
*p
= sim
->get_core(0);
834 bool interrupt
= sim
->debug_module
.get_interrupt(0);
836 if (state
== STATE_HALTING
&& !interrupt
) {
837 // gdb requested a halt and now it's done.
839 fprintf(stderr
, "DPC: 0x%x\n", read_debug_ram(0));
840 fprintf(stderr
, "DCSR: 0x%x\n", read_debug_ram(2));
841 state
= STATE_HALTED
;
846 case STATE_CONT_GENERAL_REGISTERS
:
847 continue_general_registers_read();
849 case STATE_CONT_REGISTER_READ
:
850 continue_register_read();
858 if (running && p->halted) {
859 // The core was running, but now it's halted. Better tell gdb.
860 switch (p->halt_reason) {
862 fprintf(stderr, "Internal error. Processor halted without reason.\n");
868 // There's no gdb code for this.
872 send_packet("T05swbreak:;");
876 // TODO: Actually include register values here
881 if (state
== STATE_HALTED
) {
894 this->process_requests();
897 void gdbserver_t::send(const char* msg
)
899 unsigned int length
= strlen(msg
);
900 for (const char *c
= msg
; *c
; c
++)
901 running_checksum
+= *c
;
902 send_buf
.append((const uint8_t *) msg
, length
);
905 void gdbserver_t::send(uint64_t value
)
908 for (unsigned int i
= 0; i
< 8; i
++) {
909 sprintf(buffer
, "%02x", (int) (value
& 0xff));
915 void gdbserver_t::send(uint32_t value
)
918 for (unsigned int i
= 0; i
< 4; i
++) {
919 sprintf(buffer
, "%02x", (int) (value
& 0xff));
925 void gdbserver_t::send_packet(const char* data
)
928 running_checksum
= 0;
930 send_running_checksum();
934 void gdbserver_t::send_running_checksum()
936 char checksum_string
[4];
937 sprintf(checksum_string
, "#%02x", running_checksum
);
938 send(checksum_string
);