6 #include <sys/socket.h>
17 #include "gdbserver.h"
20 #define C_EBREAK 0x9002
21 #define EBREAK 0x00100073
24 unsigned int circular_buffer_t
<T
>::size() const
29 return end
+ capacity
- start
;
33 void circular_buffer_t
<T
>::consume(unsigned int bytes
)
35 start
= (start
+ bytes
) % capacity
;
39 unsigned int circular_buffer_t
<T
>::contiguous_empty_size() const
43 return capacity
- end
- 1;
45 return capacity
- end
;
47 return start
- end
- 1;
51 unsigned int circular_buffer_t
<T
>::contiguous_data_size() const
56 return capacity
- start
;
60 void circular_buffer_t
<T
>::data_added(unsigned int bytes
)
63 assert(end
<= capacity
);
69 void circular_buffer_t
<T
>::reset()
76 void circular_buffer_t
<T
>::append(const T
*src
, unsigned int count
)
78 unsigned int copy
= std::min(count
, contiguous_empty_size());
79 memcpy(contiguous_empty(), src
, copy
* sizeof(T
));
83 assert(count
< contiguous_empty_size());
84 memcpy(contiguous_empty(), src
, count
* sizeof(T
));
89 gdbserver_t::gdbserver_t(uint16_t port
, sim_t
*sim
) :
92 recv_buf(64 * 1024), send_buf(64 * 1024)
94 // TODO: listen on socket
95 socket_fd
= socket(AF_INET
, SOCK_STREAM
, 0);
96 if (socket_fd
== -1) {
97 fprintf(stderr
, "failed to make socket: %s (%d)\n", strerror(errno
), errno
);
101 fcntl(socket_fd
, F_SETFL
, O_NONBLOCK
);
103 if (setsockopt(socket_fd
, SOL_SOCKET
, SO_REUSEADDR
, &reuseaddr
,
104 sizeof(int)) == -1) {
105 fprintf(stderr
, "failed setsockopt: %s (%d)\n", strerror(errno
), errno
);
109 struct sockaddr_in addr
;
110 memset(&addr
, 0, sizeof(addr
));
111 addr
.sin_family
= AF_INET
;
112 addr
.sin_addr
.s_addr
= INADDR_ANY
;
113 addr
.sin_port
= htons(port
);
115 if (bind(socket_fd
, (struct sockaddr
*) &addr
, sizeof(addr
)) == -1) {
116 fprintf(stderr
, "failed to bind socket: %s (%d)\n", strerror(errno
), errno
);
120 if (listen(socket_fd
, 1) == -1) {
121 fprintf(stderr
, "failed to listen on socket: %s (%d)\n", strerror(errno
), errno
);
126 void gdbserver_t::accept()
128 client_fd
= ::accept(socket_fd
, NULL
, NULL
);
129 if (client_fd
== -1) {
130 if (errno
== EAGAIN
) {
131 // No client waiting to connect right now.
133 fprintf(stderr
, "failed to accept on socket: %s (%d)\n", strerror(errno
),
138 fcntl(client_fd
, F_SETFL
, O_NONBLOCK
);
141 extended_mode
= false;
143 // gdb wants the core to be halted when it attaches.
144 processor_t
*p
= sim
->get_core(0);
145 p
->set_halted(true, HR_ATTACHED
);
149 void gdbserver_t::read()
151 // Reading from a non-blocking socket still blocks if there is no data
154 size_t count
= recv_buf
.contiguous_empty_size();
156 ssize_t bytes
= ::read(client_fd
, recv_buf
.contiguous_empty(), count
);
158 if (errno
== EAGAIN
) {
159 // We'll try again the next call.
161 fprintf(stderr
, "failed to read on socket: %s (%d)\n", strerror(errno
), errno
);
164 } else if (bytes
== 0) {
165 // The remote disconnected.
167 processor_t
*p
= sim
->get_core(0);
168 p
->set_halted(false, HR_NONE
);
172 recv_buf
.data_added(bytes
);
176 void gdbserver_t::write()
178 if (send_buf
.empty())
181 while (!send_buf
.empty()) {
182 unsigned int count
= send_buf
.contiguous_data_size();
184 ssize_t bytes
= ::write(client_fd
, send_buf
.contiguous_data(), count
);
186 fprintf(stderr
, "failed to write to socket: %s (%d)\n", strerror(errno
), errno
);
188 } else if (bytes
== 0) {
189 // Client can't take any more data right now.
192 fprintf(stderr
, "wrote %ld bytes: ", bytes
);
193 for (unsigned int i
= 0; i
< bytes
; i
++) {
194 fprintf(stderr
, "%c", send_buf
[i
]);
196 fprintf(stderr
, "\n");
197 send_buf
.consume(bytes
);
202 void print_packet(const std::vector
<uint8_t> &packet
)
204 for (uint8_t c
: packet
) {
205 if (c
>= ' ' and c
<= '~')
206 fprintf(stderr
, "%c", c
);
208 fprintf(stderr
, "\\x%x", c
);
210 fprintf(stderr
, "\n");
213 uint8_t compute_checksum(const std::vector
<uint8_t> &packet
)
215 uint8_t checksum
= 0;
216 for (auto i
= packet
.begin() + 1; i
!= packet
.end() - 3; i
++ ) {
222 uint8_t character_hex_value(uint8_t character
)
224 if (character
>= '0' && character
<= '9')
225 return character
- '0';
226 if (character
>= 'a' && character
<= 'f')
227 return 10 + character
- 'a';
228 if (character
>= 'A' && character
<= 'F')
229 return 10 + character
- 'A';
233 uint8_t extract_checksum(const std::vector
<uint8_t> &packet
)
235 return character_hex_value(*(packet
.end() - 1)) +
236 16 * character_hex_value(*(packet
.end() - 2));
239 void gdbserver_t::process_requests()
241 // See https://sourceware.org/gdb/onlinedocs/gdb/Remote-Protocol.html
243 while (!recv_buf
.empty()) {
244 std::vector
<uint8_t> packet
;
245 for (unsigned int i
= 0; i
< recv_buf
.size(); i
++) {
246 uint8_t b
= recv_buf
[i
];
248 if (packet
.empty() && expect_ack
&& b
== '+') {
253 if (packet
.empty() && b
== 3) {
254 fprintf(stderr
, "Received interrupt\n");
261 // Start of new packet.
262 if (!packet
.empty()) {
263 fprintf(stderr
, "Received malformed %ld-byte packet from debug client: ",
265 print_packet(packet
);
273 // Packets consist of $<packet-data>#<checksum>
274 // where <checksum> is
275 if (packet
.size() >= 4 &&
276 packet
[packet
.size()-3] == '#') {
277 handle_packet(packet
);
278 recv_buf
.consume(i
+1);
282 // There's a partial packet in the buffer. Wait until we get more data to
290 void gdbserver_t::handle_halt_reason(const std::vector
<uint8_t> &packet
)
295 void gdbserver_t::handle_general_registers_read(const std::vector
<uint8_t> &packet
)
297 // Register order that gdb expects is:
298 // "x0", "x1", "x2", "x3", "x4", "x5", "x6", "x7",
299 // "x8", "x9", "x10", "x11", "x12", "x13", "x14", "x15",
300 // "x16", "x17", "x18", "x19", "x20", "x21", "x22", "x23",
301 // "x24", "x25", "x26", "x27", "x28", "x29", "x30", "x31",
303 // "f0", "f1", "f2", "f3", "f4", "f5", "f6", "f7",
304 // "f8", "f9", "f10", "f11", "f12", "f13", "f14", "f15",
305 // "f16", "f17", "f18", "f19", "f20", "f21", "f22", "f23",
306 // "f24", "f25", "f26", "f27", "f28", "f29", "f30", "f31",
308 // Each byte of register data is described by two hex digits. The bytes with
309 // the register are transmitted in target byte order. The size of each
310 // register and their position within the ‘g’ packet are determined by the
311 // gdb internal gdbarch functions DEPRECATED_REGISTER_RAW_SIZE and
312 // gdbarch_register_name.
315 running_checksum
= 0;
316 processor_t
*p
= sim
->get_core(0);
317 for (int r
= 0; r
< 32; r
++) {
318 send(p
->state
.XPR
[r
]);
320 send_running_checksum();
324 uint64_t consume_hex_number(std::vector
<uint8_t>::const_iterator
&iter
,
325 std::vector
<uint8_t>::const_iterator end
)
329 while (iter
!= end
) {
331 uint64_t c_value
= character_hex_value(c
);
341 void consume_string(std::string
&str
, std::vector
<uint8_t>::const_iterator
&iter
,
342 std::vector
<uint8_t>::const_iterator end
, uint8_t separator
)
344 while (iter
!= end
&& *iter
!= separator
) {
345 str
.append(1, (char) *iter
);
358 register_class_t clss
;
362 // gdb's register list is defined in riscv_gdb_reg_names gdb/riscv-tdep.c in
363 // its source tree. The definition here must match that one.
364 const register_access_t register_access
[] = {
431 #define DECLARE_CSR(name, num) { RC_CSR, num },
432 #include "encoding.h"
436 void gdbserver_t::handle_register_read(const std::vector
<uint8_t> &packet
)
440 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
441 unsigned int n
= consume_hex_number(iter
, packet
.end());
443 return send_packet("E01");
445 if (n
>= sizeof(register_access
) / sizeof(*register_access
))
446 return send_packet("E02");
448 processor_t
*p
= sim
->get_core(0);
450 running_checksum
= 0;
452 register_access_t access
= register_access
[n
];
453 switch (access
.clss
) {
455 send(p
->state
.XPR
[access
.index
]);
461 send(p
->state
.FPR
[access
.index
]);
465 send(p
->get_csr(access
.index
));
472 send_running_checksum();
476 void gdbserver_t::handle_memory_read(const std::vector
<uint8_t> &packet
)
479 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
480 reg_t address
= consume_hex_number(iter
, packet
.end());
482 return send_packet("E10");
484 reg_t length
= consume_hex_number(iter
, packet
.end());
486 return send_packet("E11");
489 running_checksum
= 0;
491 processor_t
*p
= sim
->get_core(0);
492 mmu_t
* mmu
= sim
->debug_mmu
;
494 for (reg_t i
= 0; i
< length
; i
++) {
495 sprintf(buffer
, "%02x", mmu
->load_uint8(address
+ i
));
498 send_running_checksum();
501 void gdbserver_t::handle_memory_binary_write(const std::vector
<uint8_t> &packet
)
503 // X addr,length:XX...
504 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
505 reg_t address
= consume_hex_number(iter
, packet
.end());
507 return send_packet("E20");
509 reg_t length
= consume_hex_number(iter
, packet
.end());
511 return send_packet("E21");
514 processor_t
*p
= sim
->get_core(0);
515 mmu_t
* mmu
= sim
->debug_mmu
;
516 for (unsigned int i
= 0; i
< length
; i
++) {
517 if (iter
== packet
.end()) {
518 return send_packet("E22");
520 mmu
->store_uint8(address
+ i
, *iter
);
524 return send_packet("E4b"); // EOVERFLOW
529 void gdbserver_t::handle_continue(const std::vector
<uint8_t> &packet
)
532 processor_t
*p
= sim
->get_core(0);
533 if (packet
[2] != '#') {
534 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
535 p
->state
.pc
= consume_hex_number(iter
, packet
.end());
537 return send_packet("E30");
540 p
->set_halted(false, HR_NONE
);
544 void gdbserver_t::handle_step(const std::vector
<uint8_t> &packet
)
547 processor_t
*p
= sim
->get_core(0);
548 if (packet
[2] != '#') {
549 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
550 p
->state
.pc
= consume_hex_number(iter
, packet
.end());
552 return send_packet("E40");
555 p
->set_single_step(true);
559 void gdbserver_t::handle_kill(const std::vector
<uint8_t> &packet
)
562 // The exact effect of this packet is not specified.
563 // Looks like OpenOCD disconnects?
567 void gdbserver_t::handle_extended(const std::vector
<uint8_t> &packet
)
569 // Enable extended mode. In extended mode, the remote server is made
570 // persistent. The ‘R’ packet is used to restart the program being debugged.
572 extended_mode
= true;
575 void software_breakpoint_t::insert(mmu_t
* mmu
)
578 instruction
= mmu
->load_uint16(address
);
579 mmu
->store_uint16(address
, C_EBREAK
);
581 instruction
= mmu
->load_uint32(address
);
582 mmu
->store_uint32(address
, EBREAK
);
584 fprintf(stderr
, ">>> Read %x from %lx\n", instruction
, address
);
587 void software_breakpoint_t::remove(mmu_t
* mmu
)
589 fprintf(stderr
, ">>> write %x to %lx\n", instruction
, address
);
591 mmu
->store_uint16(address
, instruction
);
593 mmu
->store_uint32(address
, instruction
);
597 void gdbserver_t::handle_breakpoint(const std::vector
<uint8_t> &packet
)
599 // insert: Z type,addr,kind
600 // remove: z type,addr,kind
602 software_breakpoint_t bp
;
603 bool insert
= (packet
[1] == 'Z');
604 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
605 int type
= consume_hex_number(iter
, packet
.end());
607 return send_packet("E50");
609 bp
.address
= consume_hex_number(iter
, packet
.end());
611 return send_packet("E51");
613 bp
.size
= consume_hex_number(iter
, packet
.end());
614 // There may be more options after a ; here, but we don't support that.
616 return send_packet("E52");
618 if (bp
.size
!= 2 && bp
.size
!= 4) {
619 return send_packet("E53");
622 processor_t
*p
= sim
->get_core(0);
626 breakpoints
[bp
.address
] = bp
;
629 bp
= breakpoints
[bp
.address
];
631 breakpoints
.erase(bp
.address
);
634 sim
->debug_mmu
->flush_icache();
635 return send_packet("OK");
638 void gdbserver_t::handle_query(const std::vector
<uint8_t> &packet
)
641 std::vector
<uint8_t>::const_iterator iter
= packet
.begin() + 2;
643 consume_string(name
, iter
, packet
.end(), ':');
644 if (iter
!= packet
.end())
646 if (name
== "Supported") {
648 running_checksum
= 0;
649 while (iter
!= packet
.end()) {
651 consume_string(feature
, iter
, packet
.end(), ';');
652 if (iter
!= packet
.end())
654 if (feature
== "swbreak+") {
658 return send_running_checksum();
661 fprintf(stderr
, "Unsupported query %s\n", name
.c_str());
662 return send_packet("");
665 void gdbserver_t::handle_packet(const std::vector
<uint8_t> &packet
)
667 if (compute_checksum(packet
) != extract_checksum(packet
)) {
668 fprintf(stderr
, "Received %ld-byte packet with invalid checksum\n", packet
.size());
669 fprintf(stderr
, "Computed checksum: %x\n", compute_checksum(packet
));
670 print_packet(packet
);
675 fprintf(stderr
, "Received %ld-byte packet from debug client: ", packet
.size());
676 print_packet(packet
);
681 return handle_extended(packet
);
683 return handle_halt_reason(packet
);
685 return handle_general_registers_read(packet
);
687 return handle_kill(packet
);
689 return handle_memory_read(packet
);
691 // return handle_memory_write(packet);
693 return handle_memory_binary_write(packet
);
695 return handle_register_read(packet
);
697 return handle_continue(packet
);
699 return handle_step(packet
);
702 return handle_breakpoint(packet
);
705 return handle_query(packet
);
709 fprintf(stderr
, "** Unsupported packet: ");
710 print_packet(packet
);
714 void gdbserver_t::handle_interrupt()
716 processor_t
*p
= sim
->get_core(0);
717 p
->set_halted(true, HR_INTERRUPT
);
718 send_packet("S02"); // Pretend program received SIGINT.
722 void gdbserver_t::handle()
724 processor_t
*p
= sim
->get_core(0);
725 if (running
&& p
->halted
) {
726 // The core was running, but now it's halted. Better tell gdb.
727 switch (p
->halt_reason
) {
729 fprintf(stderr
, "Internal error. Processor halted without reason.\n");
735 // There's no gdb code for this.
739 send_packet("T05swbreak:;");
743 // TODO: Actually include register values here
755 this->process_requests();
758 void gdbserver_t::send(const char* msg
)
760 unsigned int length
= strlen(msg
);
761 for (const char *c
= msg
; *c
; c
++)
762 running_checksum
+= *c
;
763 send_buf
.append((const uint8_t *) msg
, length
);
766 void gdbserver_t::send(uint64_t value
)
769 for (unsigned int i
= 0; i
< 8; i
++) {
770 sprintf(buffer
, "%02x", (int) (value
& 0xff));
776 void gdbserver_t::send(uint32_t value
)
779 for (unsigned int i
= 0; i
< 4; i
++) {
780 sprintf(buffer
, "%02x", (int) (value
& 0xff));
786 void gdbserver_t::send_packet(const char* data
)
789 running_checksum
= 0;
791 send_running_checksum();
795 void gdbserver_t::send_running_checksum()
797 char checksum_string
[4];
798 sprintf(checksum_string
, "#%02x", running_checksum
);
799 send(checksum_string
);