1 /* Remote target communications for serial-line targets in custom GDB protocol
2 Copyright 1988, 1991, 1992, 1993 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
20 /* Remote communication protocol.
22 A debug packet whose contents are <data>
23 is encapsulated for transmission in the form:
25 $ <data> # CSUM1 CSUM2
27 <data> must be ASCII alphanumeric and cannot include characters
30 CSUM1 and CSUM2 are ascii hex representation of an 8-bit
31 checksum of <data>, the most significant nibble is sent first.
32 the hex digits 0-9,a-f are used.
34 Receiver responds with:
36 + - if CSUM is correct and ready for next packet
37 - - if CSUM is incorrect
40 All values are encoded in ascii hex digits.
45 reply XX....X Each byte of register data
46 is described by two hex digits.
47 Registers are in the internal order
48 for GDB, and the bytes in a register
49 are in the same order the machine uses.
52 write regs GXX..XX Each byte of register data
53 is described by two hex digits.
57 read mem mAA..AA,LLLL AA..AA is address, LLLL is length.
58 reply XX..XX XX..XX is mem contents
59 Can be fewer bytes than requested
60 if able to read only part of the data.
63 write mem MAA..AA,LLLL:XX..XX
65 LLLL is number of bytes,
68 ENN for an error (this includes the case
69 where only part of the data was
72 cont cAA..AA AA..AA is address to resume
74 resume at same address.
76 step sAA..AA AA..AA is address to resume
78 resume at same address.
80 last signal ? Reply the current reason for stopping.
81 This is the same reply as is generated
82 for step or cont : SAA where AA is the
85 There is no immediate reply to step or cont.
86 The reply comes when the machine stops.
87 It is SAA AA is the "signal number"
89 or... TAAn...:r...;n:r...;n...:r...;
91 n... = register number
92 r... = register contents
96 toggle debug d toggle debug flag (see 386 & 68k stubs)
97 reset r reset -- see sparc stub.
98 reserved <other> On other requests, the stub should
99 ignore the request and send an empty
100 response ($#<checksum>). This way
101 we can extend the protocol and GDB
102 can tell whether the stub it is
103 talking to uses the old or the new.
110 #include "inferior.h"
115 #include "terminal.h"
120 #if !defined(DONT_USE_REMOTE)
122 #include <sys/types.h>
128 /* Prototypes for local functions */
131 remote_write_bytes PARAMS ((CORE_ADDR memaddr, unsigned char *myaddr, int len));
134 remote_read_bytes PARAMS ((CORE_ADDR memaddr, unsigned char *myaddr, int len));
137 remote_files_info PARAMS ((struct target_ops *ignore));
140 remote_xfer_memory PARAMS ((CORE_ADDR memaddr, char *myaddr, int len,
141 int should_write, struct target_ops *target));
144 remote_prepare_to_store PARAMS ((void));
147 remote_fetch_registers PARAMS ((int regno));
150 remote_resume PARAMS ((int pid, int step, int siggnal));
153 remote_start_remote PARAMS ((char *dummy));
156 remote_open PARAMS ((char *name, int from_tty));
159 remote_close PARAMS ((int quitting));
162 remote_store_registers PARAMS ((int regno));
165 getpkt PARAMS ((char *buf, int forever));
168 putpkt PARAMS ((char *buf));
171 remote_send PARAMS ((char *buf));
174 readchar PARAMS ((void));
177 remote_wait PARAMS ((WAITTYPE *status));
180 tohex PARAMS ((int nib));
183 fromhex PARAMS ((int a));
186 remote_detach PARAMS ((char *args, int from_tty));
189 remote_interrupt PARAMS ((int signo));
192 remote_interrupt_twice PARAMS ((int signo));
194 extern struct target_ops remote_ops; /* Forward decl */
196 /* This was 5 seconds, which is a long time to sit and wait.
197 Unless this is going though some terminal server or multiplexer or
198 other form of hairy serial connection, I would think 2 seconds would
200 static int timeout = 2;
206 /* Descriptor for I/O to remote machine. Initialize it to NULL so that
207 remote_open knows that we don't have a file open when the program
209 serial_t remote_desc = NULL;
213 /* Maximum number of bytes to read/write at once. The value here
214 is chosen to fill up a packet (the headers account for the 32). */
215 #define MAXBUFBYTES ((PBUFSIZ-32)/2)
217 /* Round up PBUFSIZ to hold all the registers, at least. */
218 #if REGISTER_BYTES > MAXBUFBYTES
220 #define PBUFSIZ (REGISTER_BYTES * 2 + 32)
223 /* Clean up connection to a remote debugger. */
227 remote_close (quitting)
231 SERIAL_CLOSE (remote_desc);
235 /* Stub for catch_errors. */
238 remote_start_remote (dummy)
241 /* Ack any packet which the remote side has already sent. */
242 /* I'm not sure this \r is needed; we don't use it any other time we
244 SERIAL_WRITE (remote_desc, "+\r", 2);
245 putpkt ("?"); /* initiate a query from remote machine */
247 start_remote (); /* Initialize gdb process mechanisms */
251 /* Open a connection to a remote debugger.
252 NAME is the filename used for communication. */
254 static DCACHE *remote_dcache;
257 remote_open (name, from_tty)
263 "To open a remote debug connection, you need to specify what serial\n\
264 device is attached to the remote system (e.g. /dev/ttya).");
266 target_preopen (from_tty);
268 unpush_target (&remote_ops);
270 remote_dcache = dcache_init (remote_read_bytes, remote_write_bytes);
272 remote_desc = SERIAL_OPEN (name);
274 perror_with_name (name);
280 if (sscanf (baud_rate, "%d", &rate) == 1)
281 if (SERIAL_SETBAUDRATE (remote_desc, rate))
283 SERIAL_CLOSE (remote_desc);
284 perror_with_name (name);
288 SERIAL_RAW (remote_desc);
292 puts_filtered ("Remote debugging using ");
293 puts_filtered (name);
294 puts_filtered ("\n");
296 push_target (&remote_ops); /* Switch to using remote target now */
298 /* Start the remote connection; if error (0), discard this target. */
299 immediate_quit++; /* Allow user to interrupt it */
300 if (!catch_errors (remote_start_remote, (char *)0,
301 "Couldn't establish connection to remote target\n", RETURN_MASK_ALL))
306 takes a program previously attached to and detaches it.
307 We better not have left any breakpoints
308 in the program or it'll die when it hits one.
309 Close the open connection to the remote debugger.
310 Use this when you want to detach and do something else
314 remote_detach (args, from_tty)
319 error ("Argument given to \"detach\" when remotely debugging.");
323 puts_filtered ("Ending remote debugging.\n");
326 /* Convert hex digit A to a number. */
332 if (a >= '0' && a <= '9')
334 else if (a >= 'a' && a <= 'f')
337 error ("Reply contains invalid hex digit");
341 /* Convert number NIB to a hex digit. */
353 /* Tell the remote machine to resume. */
356 remote_resume (pid, step, siggnal)
357 int pid, step, siggnal;
364 target_terminal_ours_for_output ();
365 printf_filtered ("Can't send signals to a remote system. ");
366 name = strsigno (siggnal);
368 printf_filtered (name);
370 printf_filtered ("Signal %d", siggnal);
371 printf_filtered (" not sent.\n");
372 target_terminal_inferior ();
375 dcache_flush (remote_dcache);
377 strcpy (buf, step ? "s": "c");
382 /* Send ^C to target to halt it. Target will respond, and send us a
386 remote_interrupt (signo)
389 /* If this doesn't work, try more severe steps. */
390 signal (signo, remote_interrupt_twice);
393 printf ("remote_interrupt called\n");
395 SERIAL_WRITE (remote_desc, "\003", 1); /* Send a ^C */
398 static void (*ofunc)();
400 /* The user typed ^C twice. */
402 remote_interrupt_twice (signo)
405 signal (signo, ofunc);
407 target_terminal_ours ();
408 if (query ("Interrupted while waiting for the program.\n\
409 Give up (and stop debugging it)? "))
411 target_mourn_inferior ();
412 return_to_top_level (RETURN_QUIT);
416 signal (signo, remote_interrupt);
417 target_terminal_inferior ();
421 /* Wait until the remote machine stops, then return,
422 storing status in STATUS just as `wait' would.
423 Returns "pid" (though it's not clear what, if anything, that
424 means in the case of this target). */
430 unsigned char buf[PBUFSIZ];
434 char regs[MAX_REGISTER_RAW_SIZE];
436 WSETEXIT ((*status), 0);
438 ofunc = (void (*)()) signal (SIGINT, remote_interrupt);
439 getpkt ((char *) buf, 1);
440 signal (SIGINT, ofunc);
443 error ("Remote failure reply: %s", buf);
446 /* Expedited reply, containing Signal, {regno, reg} repeat */
447 /* format is: 'Tssn...:r...;n...:r...;n...:r...;#cc', where
449 n... = register number
450 r... = register contents
453 p = &buf[3]; /* after Txx */
459 regno = strtol (p, &p1, 16); /* Read the register number */
462 error ("Remote sent badly formed register number: %s\nPacket: '%s'\n",
468 error ("Malformed packet (missing colon): %s\nPacket: '%s'\n",
471 if (regno >= NUM_REGS)
472 error ("Remote sent bad register number %d: %s\nPacket: '%s'\n",
475 for (i = 0; i < REGISTER_RAW_SIZE (regno); i++)
477 if (p[0] == 0 || p[1] == 0)
478 error ("Remote reply is too short: %s", buf);
479 regs[i] = fromhex (p[0]) * 16 + fromhex (p[1]);
484 error("Remote register badly formatted: %s", buf);
486 supply_register (regno, regs);
489 else if (buf[0] != 'S')
490 error ("Invalid remote reply: %s", buf);
492 WSETSTOP ((*status), (((fromhex (buf[1])) << 4) + (fromhex (buf[2]))));
497 /* Read the remote registers into the block REGS. */
498 /* Currently we just read all the registers, so we don't use regno. */
501 remote_fetch_registers (regno)
507 char regs[REGISTER_BYTES];
512 /* Reply describes registers byte by byte, each byte encoded as two
513 hex characters. Suck them all up, then supply them to the
514 register cacheing/storage mechanism. */
517 for (i = 0; i < REGISTER_BYTES; i++)
519 if (p[0] == 0 || p[1] == 0)
520 error ("Remote reply is too short: %s", buf);
521 regs[i] = fromhex (p[0]) * 16 + fromhex (p[1]);
524 for (i = 0; i < NUM_REGS; i++)
525 supply_register (i, ®s[REGISTER_BYTE(i)]);
528 /* Prepare to store registers. Since we send them all, we have to
529 read out the ones we don't want to change first. */
532 remote_prepare_to_store ()
534 /* Make sure the entire registers array is valid. */
535 read_register_bytes (0, (char *)NULL, REGISTER_BYTES);
538 /* Store the remote registers from the contents of the block REGISTERS.
539 FIXME, eventually just store one register if that's all that is needed. */
543 remote_store_registers (regno)
552 /* Command describes registers byte by byte,
553 each byte encoded as two hex characters. */
556 for (i = 0; i < REGISTER_BYTES; i++)
558 *p++ = tohex ((registers[i] >> 4) & 0xf);
559 *p++ = tohex (registers[i] & 0xf);
566 /* Read a word from remote address ADDR and return it.
567 This goes through the data cache. */
570 remote_fetch_word (addr)
576 extern CORE_ADDR text_start, text_end;
578 if (addr >= text_start && addr < text_end)
581 xfer_core_file (addr, &buffer, sizeof (int));
586 return dcache_fetch (remote_dcache, addr);
589 /* Write a word WORD into remote address ADDR.
590 This goes through the data cache. */
593 remote_store_word (addr, word)
597 dcache_poke (remote_dcache, addr, word);
601 /* Write memory data directly to the remote machine.
602 This does not inform the data cache; the data cache uses this.
603 MEMADDR is the address in the remote memory space.
604 MYADDR is the address of the buffer in our space.
605 LEN is the number of bytes.
607 Returns number of bytes transferred, or 0 for error. */
610 remote_write_bytes (memaddr, myaddr, len)
612 unsigned char *myaddr;
619 if (len > PBUFSIZ / 2 - 20)
622 sprintf (buf, "M%x,%x:", memaddr, len);
624 /* We send target system values byte by byte, in increasing byte addresses,
625 each byte encoded as two hex characters. */
627 p = buf + strlen (buf);
628 for (i = 0; i < len; i++)
630 *p++ = tohex ((myaddr[i] >> 4) & 0xf);
631 *p++ = tohex (myaddr[i] & 0xf);
640 /* There is no correspondance between what the remote protocol uses
641 for errors and errno codes. We would like a cleaner way of
642 representing errors (big enough to include errno codes, bfd_error
643 codes, and others). But for now just return EIO. */
650 /* Read memory data directly from the remote machine.
651 This does not use the data cache; the data cache uses this.
652 MEMADDR is the address in the remote memory space.
653 MYADDR is the address of the buffer in our space.
654 LEN is the number of bytes.
656 Returns number of bytes transferred, or 0 for error. */
659 remote_read_bytes (memaddr, myaddr, len)
661 unsigned char *myaddr;
668 if (len > PBUFSIZ / 2 - 1)
671 sprintf (buf, "m%x,%x", memaddr, len);
677 /* There is no correspondance between what the remote protocol uses
678 for errors and errno codes. We would like a cleaner way of
679 representing errors (big enough to include errno codes, bfd_error
680 codes, and others). But for now just return EIO. */
685 /* Reply describes memory byte by byte,
686 each byte encoded as two hex characters. */
689 for (i = 0; i < len; i++)
691 if (p[0] == 0 || p[1] == 0)
692 /* Reply is short. This means that we were able to read only part
693 of what we wanted to. */
695 myaddr[i] = fromhex (p[0]) * 16 + fromhex (p[1]);
701 /* Read or write LEN bytes from inferior memory at MEMADDR, transferring
702 to or from debugger address MYADDR. Write to inferior if SHOULD_WRITE is
703 nonzero. Returns length of data written or read; 0 for error. */
707 remote_xfer_memory(memaddr, myaddr, len, should_write, target)
712 struct target_ops *target; /* ignored */
716 int total_xferred = 0;
720 if (len > MAXBUFBYTES)
721 xfersize = MAXBUFBYTES;
726 bytes_xferred = remote_write_bytes (memaddr, myaddr, xfersize);
728 bytes_xferred = remote_read_bytes (memaddr, myaddr, xfersize);
730 /* If we get an error, we are done xferring. */
731 if (bytes_xferred == 0)
734 memaddr += bytes_xferred;
735 myaddr += bytes_xferred;
736 len -= bytes_xferred;
737 total_xferred += bytes_xferred;
739 return total_xferred;
743 remote_files_info (ignore)
744 struct target_ops *ignore;
746 puts_filtered ("Debugging a target over a serial line.\n");
749 /* Stuff for dealing with the packets which are part of this protocol.
750 See comment at top of file for details. */
752 /* Read a single character from the remote end, masking it down to 7 bits. */
759 ch = SERIAL_READCHAR (remote_desc, timeout);
767 /* Send the command in BUF to the remote machine,
768 and read the reply into BUF.
769 Report an error if we get an error reply. */
780 error ("Remote failure reply: %s", buf);
783 /* Send a packet to the remote machine, with error checking.
784 The data of the packet is in BUF. */
791 unsigned char csum = 0;
793 int cnt = strlen (buf);
797 /* Copy the packet into buffer BUF2, encapsulating it
798 and giving it a checksum. */
800 if (cnt > sizeof(buf2) - 5) /* Prosanity check */
806 for (i = 0; i < cnt; i++)
812 *p++ = tohex ((csum >> 4) & 0xf);
813 *p++ = tohex (csum & 0xf);
815 /* Send it over and over until we get a positive ack. */
822 printf ("Sending packet: %s...", buf2); fflush(stdout);
824 if (SERIAL_WRITE (remote_desc, buf2, p - buf2))
825 perror_with_name ("putpkt: write failed");
827 /* read until either a timeout occurs (-2) or '+' is read */
839 break; /* Retransmit buffer */
841 perror_with_name ("putpkt: couldn't read ACK");
843 error ("putpkt: EOF while trying to read ACK");
846 printf ("%02X %c ", ch&0xFF, ch);
849 break; /* Here to retransmit */
854 /* Read a packet from the remote machine, with error checking,
855 and store it in BUF. BUF is expected to be of size PBUFSIZ.
856 If FOREVER, wait forever rather than timing out; this is used
857 while the target is executing user code. */
860 getpkt (buf, forever)
867 unsigned char c1, c2;
869 #define MAX_RETRIES 10
873 /* This can loop forever if the remote side sends us characters
874 continuously, but if it pauses, we'll get a zero from readchar
875 because of timeout. Then we'll count that as a retry. */
878 if (c > 0 && c != '$')
881 if (c == SERIAL_TIMEOUT)
885 if (++retries >= MAX_RETRIES)
886 if (remote_debug) puts_filtered ("Timed out.\n");
891 error ("Remote connection closed");
892 if (c == SERIAL_ERROR)
893 perror_with_name ("Remote communication error");
895 /* Force csum to be zero here because of possible error retry. */
902 if (c == SERIAL_TIMEOUT)
905 puts_filtered ("Timeout in mid-packet, retrying\n");
906 goto whole; /* Start a new packet, count retries */
911 puts_filtered ("Saw new packet start in middle of old one\n");
912 goto whole; /* Start a new packet, count retries */
916 if (bp >= buf+PBUFSIZ-1)
919 puts_filtered ("Remote packet too long: ");
921 puts_filtered ("\n");
929 c1 = fromhex (readchar ());
930 c2 = fromhex (readchar ());
931 if ((csum & 0xff) == (c1 << 4) + c2)
933 printf_filtered ("Bad checksum, sentsum=0x%x, csum=0x%x, buf=",
934 (c1 << 4) + c2, csum & 0xff);
936 puts_filtered ("\n");
938 /* Try the whole thing again. */
940 if (++retries < MAX_RETRIES)
942 SERIAL_WRITE (remote_desc, "-", 1);
946 printf ("Ignoring packet error, continuing...\n");
953 SERIAL_WRITE (remote_desc, "+", 1);
956 fprintf (stderr,"Packet received: %s\n", buf);
963 /* Don't wait for it to die. I'm not really sure it matters whether
964 we do or not. For the existing stubs, kill is a noop. */
965 target_mourn_inferior ();
971 unpush_target (&remote_ops);
972 generic_mourn_inferior ();
975 #ifdef REMOTE_BREAKPOINT
977 /* On some machines, e.g. 68k, we may use a different breakpoint instruction
978 than other targets. */
979 static unsigned char break_insn[] = REMOTE_BREAKPOINT;
981 /* Check that it fits in BREAKPOINT_MAX bytes. */
982 static unsigned char check_break_insn_size[BREAKPOINT_MAX] = REMOTE_BREAKPOINT;
984 #else /* No REMOTE_BREAKPOINT. */
986 /* Same old breakpoint instruction. This code does nothing different
988 static unsigned char break_insn[] = BREAKPOINT;
990 #endif /* No REMOTE_BREAKPOINT. */
992 /* Insert a breakpoint on targets that don't have any better breakpoint
993 support. We read the contents of the target location and stash it,
994 then overwrite it with a breakpoint instruction. ADDR is the target
995 location in the target machine. CONTENTS_CACHE is a pointer to
996 memory allocated for saving the target contents. It is guaranteed
997 by the caller to be long enough to save sizeof BREAKPOINT bytes (this
998 is accomplished via BREAKPOINT_MAX). */
1001 remote_insert_breakpoint (addr, contents_cache)
1003 char *contents_cache;
1007 val = target_read_memory (addr, contents_cache, sizeof break_insn);
1010 val = target_write_memory (addr, (char *)break_insn, sizeof break_insn);
1016 remote_remove_breakpoint (addr, contents_cache)
1018 char *contents_cache;
1020 return target_write_memory (addr, contents_cache, sizeof break_insn);
1023 /* Define the target subroutine names */
1025 struct target_ops remote_ops = {
1026 "remote", /* to_shortname */
1027 "Remote serial target in gdb-specific protocol", /* to_longname */
1028 "Use a remote computer via a serial line, using a gdb-specific protocol.\n\
1029 Specify the serial device it is connected to (e.g. /dev/ttya).", /* to_doc */
1030 remote_open, /* to_open */
1031 remote_close, /* to_close */
1032 NULL, /* to_attach */
1033 remote_detach, /* to_detach */
1034 remote_resume, /* to_resume */
1035 remote_wait, /* to_wait */
1036 remote_fetch_registers, /* to_fetch_registers */
1037 remote_store_registers, /* to_store_registers */
1038 remote_prepare_to_store, /* to_prepare_to_store */
1039 remote_xfer_memory, /* to_xfer_memory */
1040 remote_files_info, /* to_files_info */
1042 remote_insert_breakpoint, /* to_insert_breakpoint */
1043 remote_remove_breakpoint, /* to_remove_breakpoint */
1045 NULL, /* to_terminal_init */
1046 NULL, /* to_terminal_inferior */
1047 NULL, /* to_terminal_ours_for_output */
1048 NULL, /* to_terminal_ours */
1049 NULL, /* to_terminal_info */
1050 remote_kill, /* to_kill */
1051 generic_load, /* to_load */
1052 NULL, /* to_lookup_symbol */
1053 NULL, /* to_create_inferior */
1054 remote_mourn, /* to_mourn_inferior */
1056 0, /* to_notice_signals */
1057 process_stratum, /* to_stratum */
1059 1, /* to_has_all_memory */
1060 1, /* to_has_memory */
1061 1, /* to_has_stack */
1062 1, /* to_has_registers */
1063 1, /* to_has_execution */
1064 NULL, /* sections */
1065 NULL, /* sections_end */
1066 OPS_MAGIC /* to_magic */
1070 _initialize_remote ()
1072 add_target (&remote_ops);