1 /* Memory-access and commands for inferior process, for GDB.
2 Copyright (C) 1988-1991 Free Software Foundation, Inc.
4 This file is part of GDB.
6 GDB 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 1, or (at your option)
11 GDB 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 GDB; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20 /* Remote communication protocol.
21 All values are encoded in ascii hex digits.
26 reply XX....X Each byte of register data
27 is described by two hex digits.
28 Registers are in the internal order
29 for GDB, and the bytes in a register
30 are in the same order the machine uses.
33 write regs GXX..XX Each byte of register data
34 is described by two hex digits.
38 read mem mAA..AA,LLLL AA..AA is address, LLLL is length.
39 reply XX..XX XX..XX is mem contents
42 write mem MAA..AA,LLLL:XX..XX
44 LLLL is number of bytes,
49 cont cAA..AA AA..AA is address to resume
51 resume at same address.
53 step sAA..AA AA..AA is address to resume
55 resume at same address.
57 last signal ? Reply the current reason for stopping.
58 This is the same reply as is generated
59 for step or cont : SAA where AA is the
62 There is no immediate reply to step or cont.
63 The reply comes when the machine stops.
64 It is SAA AA is the "signal number"
81 #include <sys/types.h>
86 extern int memory_insert_breakpoint ();
87 extern int memory_remove_breakpoint ();
88 extern void add_syms_addr_command ();
89 extern struct value *call_function_by_hand();
90 extern void start_remote ();
92 extern struct target_ops remote_ops; /* Forward decl */
95 static int timeout = 5;
101 /* Descriptor for I/O to remote machine. Initialize it to -1 so that
102 remote_open knows that we don't have a file open when the program
104 int remote_desc = -1;
108 /* Maximum number of bytes to read/write at once. The value here
109 is chosen to fill up a packet (the headers account for the 32). */
110 #define MAXBUFBYTES ((PBUFSIZ-32)/2)
112 static void remote_send ();
113 static void putpkt ();
114 static void getpkt ();
116 static void dcache_flush ();
120 /* Called when SIGALRM signal sent due to alarm() timeout. */
126 printf ("remote_timer called\n");
132 /* Initialize remote connection */
139 /* Clean up connection to a remote debugger. */
142 remote_close (quitting)
145 if (remote_desc >= 0)
150 /* Open a connection to a remote debugger.
151 NAME is the filename used for communication. */
154 remote_open (name, from_tty)
162 "To open a remote debug connection, you need to specify what serial\n\
163 device is attached to the remote system (e.g. /dev/ttya).");
171 remote_desc = open (name, O_RDWR);
173 perror_with_name (name);
175 ioctl (remote_desc, TIOCGETP, &sg);
177 sg.c_cc[VMIN] = 0; /* read with timeout. */
178 sg.c_cc[VTIME] = timeout * 10;
179 sg.c_lflag &= ~(ICANON | ECHO);
183 ioctl (remote_desc, TIOCSETP, &sg);
186 printf ("Remote debugging using %s\n", name);
187 push_target (&remote_ops); /* Switch to using remote target now */
188 start_remote (); /* Initialize gdb process mechanisms */
191 #ifndef NO_SIGINTERRUPT
192 /* Cause SIGALRM's to make reads fail. */
193 if (siginterrupt (SIGALRM, 1) != 0)
194 perror ("remote_open: error in siginterrupt");
197 /* Set up read timeout timer. */
198 if ((void (*)) signal (SIGALRM, remote_timer) == (void (*)) -1)
199 perror ("remote_open: error in signal");
202 putpkt ("?"); /* initiate a query from remote machine */
206 takes a program previously attached to and detaches it.
207 We better not have left any breakpoints
208 in the program or it'll die when it hits one.
209 Close the open connection to the remote debugger.
210 Use this when you want to detach and do something else
214 remote_detach (args, from_tty)
219 error ("Argument given to \"detach\" when remotely debugging.");
223 printf ("Ending remote debugging.\n");
226 /* Convert hex digit A to a number. */
232 if (a >= '0' && a <= '9')
234 else if (a >= 'a' && a <= 'f')
237 error ("Reply contains invalid hex digit");
241 /* Convert number NIB to a hex digit. */
253 /* Tell the remote machine to resume. */
256 remote_resume (step, siggnal)
262 error ("Can't send signals to a remote system.");
268 strcpy (buf, step ? "s": "c");
273 /* Wait until the remote machine stops, then return,
274 storing status in STATUS just as `wait' would. */
280 unsigned char buf[PBUFSIZ];
282 WSETEXIT ((*status), 0);
285 error ("Remote failure reply: %s", buf);
287 error ("Invalid remote reply: %s", buf);
288 WSETSTOP ((*status), (((fromhex (buf[1])) << 4) + (fromhex (buf[2]))));
291 /* Read the remote registers into the block REGS. */
294 remote_fetch_registers (regno)
300 char regs[REGISTER_BYTES];
305 /* Reply describes registers byte by byte, each byte encoded as two
306 hex characters. Suck them all up, then supply them to the
307 register cacheing/storage mechanism. */
310 for (i = 0; i < REGISTER_BYTES; i++)
312 if (p[0] == 0 || p[1] == 0)
313 error ("Remote reply is too short: %s", buf);
314 regs[i] = fromhex (p[0]) * 16 + fromhex (p[1]);
317 for (i = 0; i < NUM_REGS; i++)
318 supply_register (i, ®s[REGISTER_BYTE(i)]);
322 /* Prepare to store registers. Since we send them all, we have to
323 read out the ones we don't want to change first. */
326 remote_prepare_to_store ()
328 remote_fetch_registers (-1);
331 /* Store the remote registers from the contents of the block REGISTERS.
332 FIXME, eventually just store one register if that's all that is needed. */
335 remote_store_registers (regno)
344 /* Command describes registers byte by byte,
345 each byte encoded as two hex characters. */
348 for (i = 0; i < REGISTER_BYTES; i++)
350 *p++ = tohex ((registers[i] >> 4) & 0xf);
351 *p++ = tohex (registers[i] & 0xf);
360 /* Read a word from remote address ADDR and return it.
361 This goes through the data cache. */
364 remote_fetch_word (addr)
369 extern CORE_ADDR text_start, text_end;
371 if (addr >= text_start && addr < text_end)
374 xfer_core_file (addr, &buffer, sizeof (int));
378 return dcache_fetch (addr);
381 /* Write a word WORD into remote address ADDR.
382 This goes through the data cache. */
385 remote_store_word (addr, word)
389 dcache_poke (addr, word);
393 /* Write memory data directly to the remote machine.
394 This does not inform the data cache; the data cache uses this.
395 MEMADDR is the address in the remote memory space.
396 MYADDR is the address of the buffer in our space.
397 LEN is the number of bytes. */
400 remote_write_bytes (memaddr, myaddr, len)
409 if (len > PBUFSIZ / 2 - 20)
412 sprintf (buf, "M%x,%x:", memaddr, len);
414 /* Command describes registers byte by byte,
415 each byte encoded as two hex characters. */
417 p = buf + strlen (buf);
418 for (i = 0; i < len; i++)
420 *p++ = tohex ((myaddr[i] >> 4) & 0xf);
421 *p++ = tohex (myaddr[i] & 0xf);
428 /* Read memory data directly from the remote machine.
429 This does not use the data cache; the data cache uses this.
430 MEMADDR is the address in the remote memory space.
431 MYADDR is the address of the buffer in our space.
432 LEN is the number of bytes. */
435 remote_read_bytes (memaddr, myaddr, len)
444 if (len > PBUFSIZ / 2 - 1)
447 sprintf (buf, "m%x,%x", memaddr, len);
450 /* Reply describes registers byte by byte,
451 each byte encoded as two hex characters. */
454 for (i = 0; i < len; i++)
456 if (p[0] == 0 || p[1] == 0)
457 error ("Remote reply is too short: %s", buf);
458 myaddr[i] = fromhex (p[0]) * 16 + fromhex (p[1]);
463 /* Read or write LEN bytes from inferior memory at MEMADDR, transferring
464 to or from debugger address MYADDR. Write to inferior if WRITE is
465 nonzero. Returns length of data written or read; 0 for error. */
468 remote_xfer_inferior_memory(memaddr, myaddr, len, write)
478 if (len > MAXBUFBYTES)
479 xfersize = MAXBUFBYTES;
484 remote_write_bytes(memaddr, myaddr, xfersize);
486 remote_read_bytes (memaddr, myaddr, xfersize);
491 return origlen; /* no error possible */
497 printf ("remote files info missing here. FIXME.\n");
502 A debug packet whose contents are <data>
503 is encapsulated for transmission in the form:
505 $ <data> # CSUM1 CSUM2
507 <data> must be ASCII alphanumeric and cannot include characters
510 CSUM1 and CSUM2 are ascii hex representation of an 8-bit
511 checksum of <data>, the most significant nibble is sent first.
512 the hex digits 0-9,a-f are used.
514 Receiver responds with:
516 + - if CSUM is correct and ready for next packet
517 - - if CSUM is incorrect
528 /* termio does the timeout for us. */
529 read (remote_desc, &buf, 1);
532 read (remote_desc, &buf, 1);
539 /* Send the command in BUF to the remote machine,
540 and read the reply into BUF.
541 Report an error if we get an error reply. */
552 error ("Remote failure reply: %s", buf);
555 /* Send a packet to the remote machine, with error checking.
556 The data of the packet is in BUF. */
563 unsigned char csum = 0;
565 int cnt = strlen (buf);
569 /* Copy the packet into buffer BUF2, encapsulating it
570 and giving it a checksum. */
575 for (i = 0; i < cnt; i++)
581 *p++ = tohex ((csum >> 4) & 0xf);
582 *p++ = tohex (csum & 0xf);
584 /* Send it over and over until we get a positive ack. */
590 printf ("Sending packet: %s (%s)\n", buf2, buf);
592 write (remote_desc, buf2, p - buf2);
594 /* read until either a timeout occurs (\0) or '+' is read */
597 } while ((ch != '+') && (ch != '\0'));
601 /* Read a packet from the remote machine, with error checking,
602 and store it in BUF. */
611 unsigned char c1, c2;
613 /* allow immediate quit while reading from device, it could be hung */
618 /* Force csum to be zero here because of possible error retry. */
621 while ((c = readchar()) != '$');
634 c1 = fromhex (readchar ());
635 c2 = fromhex (readchar ());
636 if ((csum & 0xff) == (c1 << 4) + c2)
638 printf ("Bad checksum, sentsum=0x%x, csum=0x%x, buf=%s\n",
639 (c1 << 4) + c2, csum & 0xff, buf);
640 write (remote_desc, "-", 1);
645 write (remote_desc, "+", 1);
648 fprintf (stderr,"Packet received :%s\n", buf);
651 /* The data cache leads to incorrect results because it doesn't know about
652 volatile variables, thus making it impossible to debug functions which
653 use hardware registers. Therefore it is #if 0'd out. Effect on
654 performance is some, for backtraces of functions with a few
655 arguments each. For functions with many arguments, the stack
656 frames don't fit in the cache blocks, which makes the cache less
657 helpful. Disabling the cache is a big performance win for fetching
658 large structures, because the cache code fetched data in 16-byte
661 /* The data cache records all the data read from the remote machine
662 since the last time it stopped.
664 Each cache block holds 16 bytes of data
665 starting at a multiple-of-16 address. */
667 #define DCACHE_SIZE 64 /* Number of cache blocks */
669 struct dcache_block {
670 struct dcache_block *next, *last;
671 unsigned int addr; /* Address for which data is recorded. */
675 struct dcache_block dcache_free, dcache_valid;
677 /* Free all the data cache blocks, thus discarding all cached data. */
682 register struct dcache_block *db;
684 while ((db = dcache_valid.next) != &dcache_valid)
687 insque (db, &dcache_free);
692 * If addr is present in the dcache, return the address of the block
696 struct dcache_block *
699 register struct dcache_block *db;
704 /* Search all cache blocks for one that is at this address. */
705 db = dcache_valid.next;
706 while (db != &dcache_valid)
708 if ((addr & 0xfffffff0) == db->addr)
715 /* Return the int data at address ADDR in dcache block DC. */
718 dcache_value (db, addr)
719 struct dcache_block *db;
724 return (db->data[(addr>>2)&3]);
727 /* Get a free cache block, put it on the valid list,
728 and return its address. The caller should store into the block
729 the address and data that it describes. */
731 struct dcache_block *
734 register struct dcache_block *db;
736 if ((db = dcache_free.next) == &dcache_free)
737 /* If we can't get one from the free list, take last valid */
738 db = dcache_valid.last;
741 insque (db, &dcache_valid);
745 /* Return the contents of the word at address ADDR in the remote machine,
746 using the data cache. */
752 register struct dcache_block *db;
754 db = dcache_hit (addr);
757 db = dcache_alloc ();
758 remote_read_bytes (addr & ~0xf, db->data, 16);
759 db->addr = addr & ~0xf;
761 return (dcache_value (db, addr));
764 /* Write the word at ADDR both in the data cache and in the remote machine. */
766 dcache_poke (addr, data)
770 register struct dcache_block *db;
772 /* First make sure the word is IN the cache. DB is its cache block. */
773 db = dcache_hit (addr);
776 db = dcache_alloc ();
777 remote_read_bytes (addr & ~0xf, db->data, 16);
778 db->addr = addr & ~0xf;
781 /* Modify the word in the cache. */
782 db->data[(addr>>2)&3] = data;
784 /* Send the changed word. */
785 remote_write_bytes (addr, &data, 4);
788 /* Initialize the data cache. */
793 register struct dcache_block *db;
795 db = (struct dcache_block *) xmalloc (sizeof (struct dcache_block) *
797 dcache_free.next = dcache_free.last = &dcache_free;
798 dcache_valid.next = dcache_valid.last = &dcache_valid;
799 for (i=0;i<DCACHE_SIZE;i++,db++)
800 insque (db, &dcache_free);
804 /* Define the target subroutine names */
806 struct target_ops remote_ops = {
807 "remote", "Remote serial target in gdb-specific protocol",
808 remote_open, remote_close,
809 0, remote_detach, remote_resume, remote_wait, /* attach */
810 remote_fetch_registers, remote_store_registers,
811 remote_prepare_to_store, 0, 0, /* conv_from, conv_to */
812 remote_xfer_inferior_memory, remote_files_info,
813 0, 0, /* insert_breakpoint, remove_breakpoint, */
814 0, 0, 0, 0, 0, /* Terminal crud */
816 0, add_syms_addr_command, /* load */
817 call_function_by_hand,
818 0, /* lookup_symbol */
819 0, 0, /* create_inferior FIXME, mourn_inferior FIXME */
820 process_stratum, 0, /* next */
821 1, 1, 1, 1, 1, /* all mem, mem, stack, regs, exec */
822 OPS_MAGIC, /* Always the last thing */
826 _initialize_remote ()
828 add_target (&remote_ops);