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 static uint32_t bits(uint32_t value
, unsigned int hi
, unsigned int lo
) {
27 return (value
>> lo
) & ((1 << (hi
+1-lo
)) - 1);
29 static uint32_t bit(uint32_t value
, unsigned int b
) {
30 return (value
>> b
) & 1;
33 static uint32_t jal(unsigned int rd
, uint32_t imm
) {
34 return (bit(imm
, 20) << 31) |
35 (bits(imm
, 10, 1) << 21) |
36 (bit(imm
, 11) << 20) |
37 (bits(imm
, 19, 12) << 12) |
43 unsigned int circular_buffer_t
<T
>::size() const
48 return end
+ capacity
- start
;
52 void circular_buffer_t
<T
>::consume(unsigned int bytes
)
54 start
= (start
+ bytes
) % capacity
;
58 unsigned int circular_buffer_t
<T
>::contiguous_empty_size() const
62 return capacity
- end
- 1;
64 return capacity
- end
;
66 return start
- end
- 1;
70 unsigned int circular_buffer_t
<T
>::contiguous_data_size() const
75 return capacity
- start
;
79 void circular_buffer_t
<T
>::data_added(unsigned int bytes
)
82 assert(end
<= capacity
);
88 void circular_buffer_t
<T
>::reset()
95 void circular_buffer_t
<T
>::append(const T
*src
, unsigned int count
)
97 unsigned int copy
= std::min(count
, contiguous_empty_size());
98 memcpy(contiguous_empty(), src
, copy
* sizeof(T
));
102 assert(count
< contiguous_empty_size());
103 memcpy(contiguous_empty(), src
, count
* sizeof(T
));
108 gdbserver_t::gdbserver_t(uint16_t port
, sim_t
*sim
) :
111 recv_buf(64 * 1024), send_buf(64 * 1024)
113 socket_fd
= socket(AF_INET
, SOCK_STREAM
, 0);
114 if (socket_fd
== -1) {
115 fprintf(stderr
, "failed to make socket: %s (%d)\n", strerror(errno
), errno
);
119 fcntl(socket_fd
, F_SETFL
, O_NONBLOCK
);
121 if (setsockopt(socket_fd
, SOL_SOCKET
, SO_REUSEADDR
, &reuseaddr
,
122 sizeof(int)) == -1) {
123 fprintf(stderr
, "failed setsockopt: %s (%d)\n", strerror(errno
), errno
);
127 struct sockaddr_in addr
;
128 memset(&addr
, 0, sizeof(addr
));
129 addr
.sin_family
= AF_INET
;
130 addr
.sin_addr
.s_addr
= INADDR_ANY
;
131 addr
.sin_port
= htons(port
);
133 if (bind(socket_fd
, (struct sockaddr
*) &addr
, sizeof(addr
)) == -1) {
134 fprintf(stderr
, "failed to bind socket: %s (%d)\n", strerror(errno
), errno
);
138 if (listen(socket_fd
, 1) == -1) {
139 fprintf(stderr
, "failed to listen on socket: %s (%d)\n", strerror(errno
), errno
);
144 void gdbserver_t::write_debug_ram(unsigned int index
, uint32_t value
)
146 char *ram
= sim
->debug_ram() + 4 * index
;
147 ram
[0] = value
& 0xff;
148 ram
[1] = (value
>> 8) & 0xff;
149 ram
[2] = (value
>> 16) & 0xff;
150 ram
[3] = (value
>> 24) & 0xff;
153 void gdbserver_t::accept()
155 client_fd
= ::accept(socket_fd
, NULL
, NULL
);
156 if (client_fd
== -1) {
157 if (errno
== EAGAIN
) {
158 // No client waiting to connect right now.
160 fprintf(stderr
, "failed to accept on socket: %s (%d)\n", strerror(errno
),
165 fcntl(client_fd
, F_SETFL
, O_NONBLOCK
);
168 extended_mode
= false;
170 // gdb wants the core to be halted when it attaches.
171 processor_t
*p
= sim
->get_core(0);
172 write_debug_ram(0, jal(0, (uint32_t) (DEBUG_ROM_START
+ 4 - DEBUG_RAM_START
)));
177 void gdbserver_t::read()
179 // Reading from a non-blocking socket still blocks if there is no data
182 size_t count
= recv_buf
.contiguous_empty_size();
184 ssize_t bytes
= ::read(client_fd
, recv_buf
.contiguous_empty(), count
);
186 if (errno
== EAGAIN
) {
187 // We'll try again the next call.
189 fprintf(stderr
, "failed to read on socket: %s (%d)\n", strerror(errno
), errno
);
192 } else if (bytes
== 0) {
193 // The remote disconnected.
195 processor_t
*p
= sim
->get_core(0);
196 // TODO p->set_halted(false, HR_NONE);
200 recv_buf
.data_added(bytes
);
204 void gdbserver_t::write()
206 if (send_buf
.empty())
209 while (!send_buf
.empty()) {
210 unsigned int count
= send_buf
.contiguous_data_size();
212 ssize_t bytes
= ::write(client_fd
, send_buf
.contiguous_data(), count
);
214 fprintf(stderr
, "failed to write to socket: %s (%d)\n", strerror(errno
), errno
);
216 } else if (bytes
== 0) {
217 // Client can't take any more data right now.
220 fprintf(stderr
, "wrote %ld bytes: ", bytes
);
221 for (unsigned int i
= 0; i
< bytes
; i
++) {
222 fprintf(stderr
, "%c", send_buf
[i
]);
224 fprintf(stderr
, "\n");
225 send_buf
.consume(bytes
);
230 void print_packet(const std::vector
<uint8_t> &packet
)
232 for (uint8_t c
: packet
) {
233 if (c
>= ' ' and c
<= '~')
234 fprintf(stderr
, "%c", c
);
236 fprintf(stderr
, "\\x%x", c
);
238 fprintf(stderr
, "\n");
241 uint8_t compute_checksum(const std::vector
<uint8_t> &packet
)
243 uint8_t checksum
= 0;
244 for (auto i
= packet
.begin() + 1; i
!= packet
.end() - 3; i
++ ) {
250 uint8_t character_hex_value(uint8_t character
)
252 if (character
>= '0' && character
<= '9')
253 return character
- '0';
254 if (character
>= 'a' && character
<= 'f')
255 return 10 + character
- 'a';
256 if (character
>= 'A' && character
<= 'F')
257 return 10 + character
- 'A';
261 uint8_t extract_checksum(const std::vector
<uint8_t> &packet
)
263 return character_hex_value(*(packet
.end() - 1)) +
264 16 * character_hex_value(*(packet
.end() - 2));
267 void gdbserver_t::process_requests()
269 // See https://sourceware.org/gdb/onlinedocs/gdb/Remote-Protocol.html
271 while (!recv_buf
.empty()) {
272 std::vector
<uint8_t> packet
;
273 for (unsigned int i
= 0; i
< recv_buf
.size(); i
++) {
274 uint8_t b
= recv_buf
[i
];
276 if (packet
.empty() && expect_ack
&& b
== '+') {
281 if (packet
.empty() && b
== 3) {
282 fprintf(stderr
, "Received interrupt\n");
289 // Start of new packet.
290 if (!packet
.empty()) {
291 fprintf(stderr
, "Received malformed %ld-byte packet from debug client: ",
293 print_packet(packet
);
301 // Packets consist of $<packet-data>#<checksum>
302 // where <checksum> is
303 if (packet
.size() >= 4 &&
304 packet
[packet
.size()-3] == '#') {
305 handle_packet(packet
);
306 recv_buf
.consume(i
+1);
310 // There's a partial packet in the buffer. Wait until we get more data to
318 void gdbserver_t::handle_halt_reason(const std::vector
<uint8_t> &packet
)
323 void gdbserver_t::handle_general_registers_read(const std::vector
<uint8_t> &packet
)
325 // Register order that gdb expects is:
326 // "x0", "x1", "x2", "x3", "x4", "x5", "x6", "x7",
327 // "x8", "x9", "x10", "x11", "x12", "x13", "x14", "x15",
328 // "x16", "x17", "x18", "x19", "x20", "x21", "x22", "x23",
329 // "x24", "x25", "x26", "x27", "x28", "x29", "x30", "x31",
331 // Each byte of register data is described by two hex digits. The bytes with
332 // the register are transmitted in target byte order. The size of each
333 // register and their position within the ‘g’ packet are determined by the
334 // gdb internal gdbarch functions DEPRECATED_REGISTER_RAW_SIZE and
335 // gdbarch_register_name.
338 running_checksum
= 0;
339 processor_t
*p
= sim
->get_core(0);
340 for (int r
= 0; r
< 32; r
++) {
341 send(p
->state
.XPR
[r
]);
343 send_running_checksum();
347 // First byte is the most-significant one.
348 // Eg. "08675309" becomes 0x08675309.
349 uint64_t consume_hex_number(std::vector
<uint8_t>::const_iterator
&iter
,
350 std::vector
<uint8_t>::const_iterator end
)
354 while (iter
!= end
) {
356 uint64_t c_value
= character_hex_value(c
);
366 // First byte is the least-significant one.
367 // Eg. "08675309" becomes 0x09536708
368 uint64_t consume_hex_number_le(std::vector
<uint8_t>::const_iterator
&iter
,
369 std::vector
<uint8_t>::const_iterator end
)
372 unsigned int shift
= 4;
374 while (iter
!= end
) {
376 uint64_t c_value
= character_hex_value(c
);
380 value
|= c_value
<< shift
;
381 if ((shift
% 8) == 0)
389 void consume_string(std::string
&str
, std::vector
<uint8_t>::const_iterator
&iter
,
390 std::vector
<uint8_t>::const_iterator end
, uint8_t separator
)
392 while (iter
!= end
&& *iter
!= separator
) {
393 str
.append(1, (char) *iter
);
398 // gdb's register list is defined in riscv_gdb_reg_names gdb/riscv-tdep.c in
399 // its source tree. We must interpret the numbers the same here.
411 void gdbserver_t::handle_register_read(const std::vector
<uint8_t> &packet
)
415 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
416 unsigned int n
= consume_hex_number(iter
, packet
.end());
418 return send_packet("E01");
420 processor_t
*p
= sim
->get_core(0);
422 running_checksum
= 0;
424 if (n
>= REG_XPR0
&& n
<= REG_XPR31
) {
425 send(p
->state
.XPR
[n
- REG_XPR0
]);
426 } else if (n
== REG_PC
) {
428 } else if (n
>= REG_FPR0
&& n
<= REG_FPR31
) {
429 send(p
->state
.FPR
[n
- REG_FPR0
]);
430 } else if (n
>= REG_CSR0
&& n
<= REG_CSR4095
) {
432 send(p
->get_csr(n
- REG_CSR0
));
434 // It would be nicer to return an error here, but if you do that then gdb
435 // exits out of 'info registers all' as soon as it encounters a register
436 // that can't be read.
440 return send_packet("E02");
443 send_running_checksum();
447 void gdbserver_t::handle_register_write(const std::vector
<uint8_t> &packet
)
451 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
452 unsigned int n
= consume_hex_number(iter
, packet
.end());
454 return send_packet("E05");
457 reg_t value
= consume_hex_number_le(iter
, packet
.end());
459 return send_packet("E06");
461 processor_t
*p
= sim
->get_core(0);
463 if (n
>= REG_XPR0
&& n
<= REG_XPR31
) {
464 p
->state
.XPR
.write(n
- REG_XPR0
, value
);
465 } else if (n
== REG_PC
) {
467 } else if (n
>= REG_FPR0
&& n
<= REG_FPR31
) {
468 p
->state
.FPR
.write(n
- REG_FPR0
, value
);
469 } else if (n
>= REG_CSR0
&& n
<= REG_CSR4095
) {
471 p
->set_csr(n
- REG_CSR0
, value
);
473 return send_packet("EFF");
476 return send_packet("E07");
479 return send_packet("OK");
482 void gdbserver_t::handle_memory_read(const std::vector
<uint8_t> &packet
)
485 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
486 reg_t address
= consume_hex_number(iter
, packet
.end());
488 return send_packet("E10");
490 reg_t length
= consume_hex_number(iter
, packet
.end());
492 return send_packet("E11");
495 running_checksum
= 0;
497 processor_t
*p
= sim
->get_core(0);
498 mmu_t
* mmu
= sim
->debug_mmu
;
500 for (reg_t i
= 0; i
< length
; i
++) {
501 sprintf(buffer
, "%02x", mmu
->load_uint8(address
+ i
));
504 send_running_checksum();
507 void gdbserver_t::handle_memory_binary_write(const std::vector
<uint8_t> &packet
)
509 // X addr,length:XX...
510 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
511 reg_t address
= consume_hex_number(iter
, packet
.end());
513 return send_packet("E20");
515 reg_t length
= consume_hex_number(iter
, packet
.end());
517 return send_packet("E21");
520 processor_t
*p
= sim
->get_core(0);
521 mmu_t
* mmu
= sim
->debug_mmu
;
522 for (unsigned int i
= 0; i
< length
; i
++) {
523 if (iter
== packet
.end()) {
524 return send_packet("E22");
526 mmu
->store_uint8(address
+ i
, *iter
);
530 return send_packet("E4b"); // EOVERFLOW
535 void gdbserver_t::handle_continue(const std::vector
<uint8_t> &packet
)
538 processor_t
*p
= sim
->get_core(0);
539 if (packet
[2] != '#') {
540 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
541 p
->state
.pc
= consume_hex_number(iter
, packet
.end());
543 return send_packet("E30");
546 // TODO p->set_halted(false, HR_NONE);
550 void gdbserver_t::handle_step(const std::vector
<uint8_t> &packet
)
553 processor_t
*p
= sim
->get_core(0);
554 if (packet
[2] != '#') {
555 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
556 p
->state
.pc
= consume_hex_number(iter
, packet
.end());
558 return send_packet("E40");
561 // TODO: p->set_single_step(true);
565 void gdbserver_t::handle_kill(const std::vector
<uint8_t> &packet
)
568 // The exact effect of this packet is not specified.
569 // Looks like OpenOCD disconnects?
573 void gdbserver_t::handle_extended(const std::vector
<uint8_t> &packet
)
575 // Enable extended mode. In extended mode, the remote server is made
576 // persistent. The ‘R’ packet is used to restart the program being debugged.
578 extended_mode
= true;
581 void software_breakpoint_t::insert(mmu_t
* mmu
)
584 instruction
= mmu
->load_uint16(address
);
585 mmu
->store_uint16(address
, C_EBREAK
);
587 instruction
= mmu
->load_uint32(address
);
588 mmu
->store_uint32(address
, EBREAK
);
590 fprintf(stderr
, ">>> Read %x from %lx\n", instruction
, address
);
593 void software_breakpoint_t::remove(mmu_t
* mmu
)
595 fprintf(stderr
, ">>> write %x to %lx\n", instruction
, address
);
597 mmu
->store_uint16(address
, instruction
);
599 mmu
->store_uint32(address
, instruction
);
603 void gdbserver_t::handle_breakpoint(const std::vector
<uint8_t> &packet
)
605 // insert: Z type,addr,kind
606 // remove: z type,addr,kind
608 software_breakpoint_t bp
;
609 bool insert
= (packet
[1] == 'Z');
610 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
611 int type
= consume_hex_number(iter
, packet
.end());
613 return send_packet("E50");
615 bp
.address
= consume_hex_number(iter
, packet
.end());
617 return send_packet("E51");
619 bp
.size
= consume_hex_number(iter
, packet
.end());
620 // There may be more options after a ; here, but we don't support that.
622 return send_packet("E52");
624 if (bp
.size
!= 2 && bp
.size
!= 4) {
625 return send_packet("E53");
628 processor_t
*p
= sim
->get_core(0);
632 breakpoints
[bp
.address
] = bp
;
635 bp
= breakpoints
[bp
.address
];
637 breakpoints
.erase(bp
.address
);
640 sim
->debug_mmu
->flush_icache();
641 return send_packet("OK");
644 void gdbserver_t::handle_query(const std::vector
<uint8_t> &packet
)
647 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
649 consume_string(name
, iter
, packet
.end(), ':');
650 if (iter
!= packet
.end())
652 if (name
== "Supported") {
654 running_checksum
= 0;
655 while (iter
!= packet
.end()) {
657 consume_string(feature
, iter
, packet
.end(), ';');
658 if (iter
!= packet
.end())
660 if (feature
== "swbreak+") {
664 return send_running_checksum();
667 fprintf(stderr
, "Unsupported query %s\n", name
.c_str());
668 return send_packet("");
671 void gdbserver_t::handle_packet(const std::vector
<uint8_t> &packet
)
673 if (compute_checksum(packet
) != extract_checksum(packet
)) {
674 fprintf(stderr
, "Received %ld-byte packet with invalid checksum\n", packet
.size());
675 fprintf(stderr
, "Computed checksum: %x\n", compute_checksum(packet
));
676 print_packet(packet
);
681 fprintf(stderr
, "Received %ld-byte packet from debug client: ", packet
.size());
682 print_packet(packet
);
687 return handle_extended(packet
);
689 return handle_halt_reason(packet
);
691 return handle_general_registers_read(packet
);
693 return handle_kill(packet
);
695 return handle_memory_read(packet
);
697 // return handle_memory_write(packet);
699 return handle_memory_binary_write(packet
);
701 return handle_register_read(packet
);
703 return handle_register_write(packet
);
705 return handle_continue(packet
);
707 return handle_step(packet
);
710 return handle_breakpoint(packet
);
713 return handle_query(packet
);
717 fprintf(stderr
, "** Unsupported packet: ");
718 print_packet(packet
);
722 void gdbserver_t::handle_interrupt()
724 processor_t
*p
= sim
->get_core(0);
725 // TODO p->set_halted(true, HR_INTERRUPT);
726 send_packet("S02"); // Pretend program received SIGINT.
730 void gdbserver_t::handle()
733 processor_t
*p
= sim
->get_core(0);
735 if (running && p->halted) {
736 // The core was running, but now it's halted. Better tell gdb.
737 switch (p->halt_reason) {
739 fprintf(stderr, "Internal error. Processor halted without reason.\n");
745 // There's no gdb code for this.
749 send_packet("T05swbreak:;");
753 // TODO: Actually include register values here
765 this->process_requests();
768 void gdbserver_t::send(const char* msg
)
770 unsigned int length
= strlen(msg
);
771 for (const char *c
= msg
; *c
; c
++)
772 running_checksum
+= *c
;
773 send_buf
.append((const uint8_t *) msg
, length
);
776 void gdbserver_t::send(uint64_t value
)
779 for (unsigned int i
= 0; i
< 8; i
++) {
780 sprintf(buffer
, "%02x", (int) (value
& 0xff));
786 void gdbserver_t::send(uint32_t value
)
789 for (unsigned int i
= 0; i
< 4; i
++) {
790 sprintf(buffer
, "%02x", (int) (value
& 0xff));
796 void gdbserver_t::send_packet(const char* data
)
799 running_checksum
= 0;
801 send_running_checksum();
805 void gdbserver_t::send_running_checksum()
807 char checksum_string
[4];
808 sprintf(checksum_string
, "#%02x", running_checksum
);
809 send(checksum_string
);