* Makefile.in (linuw_low_h): Move higher.
[binutils-gdb.git] / gdb / remote.c
blob950f71e3c0e5fd5f13c42512b690ae65991d9c49
1 /* Remote target communications for serial-line targets in custom GDB protocol
3 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
4 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
5 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 /* See the GDB User Guide for details of the GDB remote protocol. */
24 #include "defs.h"
25 #include "gdb_string.h"
26 #include <ctype.h>
27 #include <fcntl.h>
28 #include "inferior.h"
29 #include "bfd.h"
30 #include "symfile.h"
31 #include "exceptions.h"
32 #include "target.h"
33 /*#include "terminal.h" */
34 #include "gdbcmd.h"
35 #include "objfiles.h"
36 #include "gdb-stabs.h"
37 #include "gdbthread.h"
38 #include "remote.h"
39 #include "regcache.h"
40 #include "value.h"
41 #include "gdb_assert.h"
42 #include "observer.h"
43 #include "solib.h"
44 #include "cli/cli-decode.h"
45 #include "cli/cli-setshow.h"
46 #include "target-descriptions.h"
48 #include <ctype.h>
49 #include <sys/time.h>
51 #include "event-loop.h"
52 #include "event-top.h"
53 #include "inf-loop.h"
55 #include <signal.h>
56 #include "serial.h"
58 #include "gdbcore.h" /* for exec_bfd */
60 #include "remote-fileio.h"
61 #include "gdb/fileio.h"
62 #include "gdb_stat.h"
64 #include "memory-map.h"
66 /* The size to align memory write packets, when practical. The protocol
67 does not guarantee any alignment, and gdb will generate short
68 writes and unaligned writes, but even as a best-effort attempt this
69 can improve bulk transfers. For instance, if a write is misaligned
70 relative to the target's data bus, the stub may need to make an extra
71 round trip fetching data from the target. This doesn't make a
72 huge difference, but it's easy to do, so we try to be helpful.
74 The alignment chosen is arbitrary; usually data bus width is
75 important here, not the possibly larger cache line size. */
76 enum { REMOTE_ALIGN_WRITES = 16 };
78 /* Prototypes for local functions. */
79 static void cleanup_sigint_signal_handler (void *dummy);
80 static void initialize_sigint_signal_handler (void);
81 static int getpkt_sane (char **buf, long *sizeof_buf, int forever);
82 static int getpkt_or_notif_sane (char **buf, long *sizeof_buf,
83 int forever);
85 static void handle_remote_sigint (int);
86 static void handle_remote_sigint_twice (int);
87 static void async_remote_interrupt (gdb_client_data);
88 void async_remote_interrupt_twice (gdb_client_data);
90 static void remote_files_info (struct target_ops *ignore);
92 static void remote_prepare_to_store (struct regcache *regcache);
94 static void remote_open (char *name, int from_tty);
96 static void extended_remote_open (char *name, int from_tty);
98 static void remote_open_1 (char *, int, struct target_ops *, int extended_p);
100 static void remote_close (int quitting);
102 static void remote_mourn (struct target_ops *ops);
104 static void extended_remote_restart (void);
106 static void extended_remote_mourn (struct target_ops *);
108 static void remote_mourn_1 (struct target_ops *);
110 static void remote_send (char **buf, long *sizeof_buf_p);
112 static int readchar (int timeout);
114 static void remote_kill (struct target_ops *ops);
116 static int tohex (int nib);
118 static int remote_can_async_p (void);
120 static int remote_is_async_p (void);
122 static void remote_async (void (*callback) (enum inferior_event_type event_type,
123 void *context), void *context);
125 static int remote_async_mask (int new_mask);
127 static void remote_detach (struct target_ops *ops, char *args, int from_tty);
129 static void remote_interrupt (int signo);
131 static void remote_interrupt_twice (int signo);
133 static void interrupt_query (void);
135 static void set_general_thread (struct ptid ptid);
136 static void set_continue_thread (struct ptid ptid);
138 static void get_offsets (void);
140 static void skip_frame (void);
142 static long read_frame (char **buf_p, long *sizeof_buf);
144 static int hexnumlen (ULONGEST num);
146 static void init_remote_ops (void);
148 static void init_extended_remote_ops (void);
150 static void remote_stop (ptid_t);
152 static int ishex (int ch, int *val);
154 static int stubhex (int ch);
156 static int hexnumstr (char *, ULONGEST);
158 static int hexnumnstr (char *, ULONGEST, int);
160 static CORE_ADDR remote_address_masked (CORE_ADDR);
162 static void print_packet (char *);
164 static unsigned long crc32 (unsigned char *, int, unsigned int);
166 static void compare_sections_command (char *, int);
168 static void packet_command (char *, int);
170 static int stub_unpack_int (char *buff, int fieldlength);
172 static ptid_t remote_current_thread (ptid_t oldptid);
174 static void remote_find_new_threads (void);
176 static void record_currthread (ptid_t currthread);
178 static int fromhex (int a);
180 static int hex2bin (const char *hex, gdb_byte *bin, int count);
182 static int bin2hex (const gdb_byte *bin, char *hex, int count);
184 static int putpkt_binary (char *buf, int cnt);
186 static void check_binary_download (CORE_ADDR addr);
188 struct packet_config;
190 static void show_packet_config_cmd (struct packet_config *config);
192 static void update_packet_config (struct packet_config *config);
194 static void set_remote_protocol_packet_cmd (char *args, int from_tty,
195 struct cmd_list_element *c);
197 static void show_remote_protocol_packet_cmd (struct ui_file *file,
198 int from_tty,
199 struct cmd_list_element *c,
200 const char *value);
202 static char *write_ptid (char *buf, const char *endbuf, ptid_t ptid);
203 static ptid_t read_ptid (char *buf, char **obuf);
205 static void remote_query_supported (void);
207 static void remote_check_symbols (struct objfile *objfile);
209 void _initialize_remote (void);
211 struct stop_reply;
212 static struct stop_reply *stop_reply_xmalloc (void);
213 static void stop_reply_xfree (struct stop_reply *);
214 static void do_stop_reply_xfree (void *arg);
215 static void remote_parse_stop_reply (char *buf, struct stop_reply *);
216 static void push_stop_reply (struct stop_reply *);
217 static void remote_get_pending_stop_replies (void);
218 static void discard_pending_stop_replies (int pid);
219 static int peek_stop_reply (ptid_t ptid);
221 static void remote_async_inferior_event_handler (gdb_client_data);
222 static void remote_async_get_pending_events_handler (gdb_client_data);
224 static void remote_terminal_ours (void);
226 static int remote_read_description_p (struct target_ops *target);
228 /* The non-stop remote protocol provisions for one pending stop reply.
229 This is where we keep it until it is acknowledged. */
231 static struct stop_reply *pending_stop_reply = NULL;
233 /* For "remote". */
235 static struct cmd_list_element *remote_cmdlist;
237 /* For "set remote" and "show remote". */
239 static struct cmd_list_element *remote_set_cmdlist;
240 static struct cmd_list_element *remote_show_cmdlist;
242 /* Description of the remote protocol state for the currently
243 connected target. This is per-target state, and independent of the
244 selected architecture. */
246 struct remote_state
248 /* A buffer to use for incoming packets, and its current size. The
249 buffer is grown dynamically for larger incoming packets.
250 Outgoing packets may also be constructed in this buffer.
251 BUF_SIZE is always at least REMOTE_PACKET_SIZE;
252 REMOTE_PACKET_SIZE should be used to limit the length of outgoing
253 packets. */
254 char *buf;
255 long buf_size;
257 /* If we negotiated packet size explicitly (and thus can bypass
258 heuristics for the largest packet size that will not overflow
259 a buffer in the stub), this will be set to that packet size.
260 Otherwise zero, meaning to use the guessed size. */
261 long explicit_packet_size;
263 /* remote_wait is normally called when the target is running and
264 waits for a stop reply packet. But sometimes we need to call it
265 when the target is already stopped. We can send a "?" packet
266 and have remote_wait read the response. Or, if we already have
267 the response, we can stash it in BUF and tell remote_wait to
268 skip calling getpkt. This flag is set when BUF contains a
269 stop reply packet and the target is not waiting. */
270 int cached_wait_status;
272 /* True, if in no ack mode. That is, neither GDB nor the stub will
273 expect acks from each other. The connection is assumed to be
274 reliable. */
275 int noack_mode;
277 /* True if we're connected in extended remote mode. */
278 int extended;
280 /* True if the stub reported support for multi-process
281 extensions. */
282 int multi_process_aware;
284 /* True if we resumed the target and we're waiting for the target to
285 stop. In the mean time, we can't start another command/query.
286 The remote server wouldn't be ready to process it, so we'd
287 timeout waiting for a reply that would never come and eventually
288 we'd close the connection. This can happen in asynchronous mode
289 because we allow GDB commands while the target is running. */
290 int waiting_for_stop_reply;
292 /* True if the stub reports support for non-stop mode. */
293 int non_stop_aware;
295 /* True if the stub reports support for vCont;t. */
296 int support_vCont_t;
299 /* Returns true if the multi-process extensions are in effect. */
300 static int
301 remote_multi_process_p (struct remote_state *rs)
303 return rs->extended && rs->multi_process_aware;
306 /* This data could be associated with a target, but we do not always
307 have access to the current target when we need it, so for now it is
308 static. This will be fine for as long as only one target is in use
309 at a time. */
310 static struct remote_state remote_state;
312 static struct remote_state *
313 get_remote_state_raw (void)
315 return &remote_state;
318 /* Description of the remote protocol for a given architecture. */
320 struct packet_reg
322 long offset; /* Offset into G packet. */
323 long regnum; /* GDB's internal register number. */
324 LONGEST pnum; /* Remote protocol register number. */
325 int in_g_packet; /* Always part of G packet. */
326 /* long size in bytes; == register_size (target_gdbarch, regnum);
327 at present. */
328 /* char *name; == gdbarch_register_name (target_gdbarch, regnum);
329 at present. */
332 struct remote_arch_state
334 /* Description of the remote protocol registers. */
335 long sizeof_g_packet;
337 /* Description of the remote protocol registers indexed by REGNUM
338 (making an array gdbarch_num_regs in size). */
339 struct packet_reg *regs;
341 /* This is the size (in chars) of the first response to the ``g''
342 packet. It is used as a heuristic when determining the maximum
343 size of memory-read and memory-write packets. A target will
344 typically only reserve a buffer large enough to hold the ``g''
345 packet. The size does not include packet overhead (headers and
346 trailers). */
347 long actual_register_packet_size;
349 /* This is the maximum size (in chars) of a non read/write packet.
350 It is also used as a cap on the size of read/write packets. */
351 long remote_packet_size;
355 /* Handle for retreving the remote protocol data from gdbarch. */
356 static struct gdbarch_data *remote_gdbarch_data_handle;
358 static struct remote_arch_state *
359 get_remote_arch_state (void)
361 return gdbarch_data (target_gdbarch, remote_gdbarch_data_handle);
364 /* Fetch the global remote target state. */
366 static struct remote_state *
367 get_remote_state (void)
369 /* Make sure that the remote architecture state has been
370 initialized, because doing so might reallocate rs->buf. Any
371 function which calls getpkt also needs to be mindful of changes
372 to rs->buf, but this call limits the number of places which run
373 into trouble. */
374 get_remote_arch_state ();
376 return get_remote_state_raw ();
379 static int
380 compare_pnums (const void *lhs_, const void *rhs_)
382 const struct packet_reg * const *lhs = lhs_;
383 const struct packet_reg * const *rhs = rhs_;
385 if ((*lhs)->pnum < (*rhs)->pnum)
386 return -1;
387 else if ((*lhs)->pnum == (*rhs)->pnum)
388 return 0;
389 else
390 return 1;
393 static void *
394 init_remote_state (struct gdbarch *gdbarch)
396 int regnum, num_remote_regs, offset;
397 struct remote_state *rs = get_remote_state_raw ();
398 struct remote_arch_state *rsa;
399 struct packet_reg **remote_regs;
401 rsa = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct remote_arch_state);
403 /* Use the architecture to build a regnum<->pnum table, which will be
404 1:1 unless a feature set specifies otherwise. */
405 rsa->regs = GDBARCH_OBSTACK_CALLOC (gdbarch,
406 gdbarch_num_regs (gdbarch),
407 struct packet_reg);
408 for (regnum = 0; regnum < gdbarch_num_regs (gdbarch); regnum++)
410 struct packet_reg *r = &rsa->regs[regnum];
412 if (register_size (gdbarch, regnum) == 0)
413 /* Do not try to fetch zero-sized (placeholder) registers. */
414 r->pnum = -1;
415 else
416 r->pnum = gdbarch_remote_register_number (gdbarch, regnum);
418 r->regnum = regnum;
421 /* Define the g/G packet format as the contents of each register
422 with a remote protocol number, in order of ascending protocol
423 number. */
425 remote_regs = alloca (gdbarch_num_regs (gdbarch)
426 * sizeof (struct packet_reg *));
427 for (num_remote_regs = 0, regnum = 0;
428 regnum < gdbarch_num_regs (gdbarch);
429 regnum++)
430 if (rsa->regs[regnum].pnum != -1)
431 remote_regs[num_remote_regs++] = &rsa->regs[regnum];
433 qsort (remote_regs, num_remote_regs, sizeof (struct packet_reg *),
434 compare_pnums);
436 for (regnum = 0, offset = 0; regnum < num_remote_regs; regnum++)
438 remote_regs[regnum]->in_g_packet = 1;
439 remote_regs[regnum]->offset = offset;
440 offset += register_size (gdbarch, remote_regs[regnum]->regnum);
443 /* Record the maximum possible size of the g packet - it may turn out
444 to be smaller. */
445 rsa->sizeof_g_packet = offset;
447 /* Default maximum number of characters in a packet body. Many
448 remote stubs have a hardwired buffer size of 400 bytes
449 (c.f. BUFMAX in m68k-stub.c and i386-stub.c). BUFMAX-1 is used
450 as the maximum packet-size to ensure that the packet and an extra
451 NUL character can always fit in the buffer. This stops GDB
452 trashing stubs that try to squeeze an extra NUL into what is
453 already a full buffer (As of 1999-12-04 that was most stubs). */
454 rsa->remote_packet_size = 400 - 1;
456 /* This one is filled in when a ``g'' packet is received. */
457 rsa->actual_register_packet_size = 0;
459 /* Should rsa->sizeof_g_packet needs more space than the
460 default, adjust the size accordingly. Remember that each byte is
461 encoded as two characters. 32 is the overhead for the packet
462 header / footer. NOTE: cagney/1999-10-26: I suspect that 8
463 (``$NN:G...#NN'') is a better guess, the below has been padded a
464 little. */
465 if (rsa->sizeof_g_packet > ((rsa->remote_packet_size - 32) / 2))
466 rsa->remote_packet_size = (rsa->sizeof_g_packet * 2 + 32);
468 /* Make sure that the packet buffer is plenty big enough for
469 this architecture. */
470 if (rs->buf_size < rsa->remote_packet_size)
472 rs->buf_size = 2 * rsa->remote_packet_size;
473 rs->buf = xrealloc (rs->buf, rs->buf_size);
476 return rsa;
479 /* Return the current allowed size of a remote packet. This is
480 inferred from the current architecture, and should be used to
481 limit the length of outgoing packets. */
482 static long
483 get_remote_packet_size (void)
485 struct remote_state *rs = get_remote_state ();
486 struct remote_arch_state *rsa = get_remote_arch_state ();
488 if (rs->explicit_packet_size)
489 return rs->explicit_packet_size;
491 return rsa->remote_packet_size;
494 static struct packet_reg *
495 packet_reg_from_regnum (struct remote_arch_state *rsa, long regnum)
497 if (regnum < 0 && regnum >= gdbarch_num_regs (target_gdbarch))
498 return NULL;
499 else
501 struct packet_reg *r = &rsa->regs[regnum];
502 gdb_assert (r->regnum == regnum);
503 return r;
507 static struct packet_reg *
508 packet_reg_from_pnum (struct remote_arch_state *rsa, LONGEST pnum)
510 int i;
511 for (i = 0; i < gdbarch_num_regs (target_gdbarch); i++)
513 struct packet_reg *r = &rsa->regs[i];
514 if (r->pnum == pnum)
515 return r;
517 return NULL;
520 /* FIXME: graces/2002-08-08: These variables should eventually be
521 bound to an instance of the target object (as in gdbarch-tdep()),
522 when such a thing exists. */
524 /* This is set to the data address of the access causing the target
525 to stop for a watchpoint. */
526 static CORE_ADDR remote_watch_data_address;
528 /* This is non-zero if target stopped for a watchpoint. */
529 static int remote_stopped_by_watchpoint_p;
531 static struct target_ops remote_ops;
533 static struct target_ops extended_remote_ops;
535 static int remote_async_mask_value = 1;
537 /* FIXME: cagney/1999-09-23: Even though getpkt was called with
538 ``forever'' still use the normal timeout mechanism. This is
539 currently used by the ASYNC code to guarentee that target reads
540 during the initial connect always time-out. Once getpkt has been
541 modified to return a timeout indication and, in turn
542 remote_wait()/wait_for_inferior() have gained a timeout parameter
543 this can go away. */
544 static int wait_forever_enabled_p = 1;
547 /* This variable chooses whether to send a ^C or a break when the user
548 requests program interruption. Although ^C is usually what remote
549 systems expect, and that is the default here, sometimes a break is
550 preferable instead. */
552 static int remote_break;
554 /* Descriptor for I/O to remote machine. Initialize it to NULL so that
555 remote_open knows that we don't have a file open when the program
556 starts. */
557 static struct serial *remote_desc = NULL;
559 /* This variable sets the number of bits in an address that are to be
560 sent in a memory ("M" or "m") packet. Normally, after stripping
561 leading zeros, the entire address would be sent. This variable
562 restricts the address to REMOTE_ADDRESS_SIZE bits. HISTORY: The
563 initial implementation of remote.c restricted the address sent in
564 memory packets to ``host::sizeof long'' bytes - (typically 32
565 bits). Consequently, for 64 bit targets, the upper 32 bits of an
566 address was never sent. Since fixing this bug may cause a break in
567 some remote targets this variable is principly provided to
568 facilitate backward compatibility. */
570 static int remote_address_size;
572 /* Temporary to track who currently owns the terminal. See
573 remote_terminal_* for more details. */
575 static int remote_async_terminal_ours_p;
577 /* The executable file to use for "run" on the remote side. */
579 static char *remote_exec_file = "";
582 /* User configurable variables for the number of characters in a
583 memory read/write packet. MIN (rsa->remote_packet_size,
584 rsa->sizeof_g_packet) is the default. Some targets need smaller
585 values (fifo overruns, et.al.) and some users need larger values
586 (speed up transfers). The variables ``preferred_*'' (the user
587 request), ``current_*'' (what was actually set) and ``forced_*''
588 (Positive - a soft limit, negative - a hard limit). */
590 struct memory_packet_config
592 char *name;
593 long size;
594 int fixed_p;
597 /* Compute the current size of a read/write packet. Since this makes
598 use of ``actual_register_packet_size'' the computation is dynamic. */
600 static long
601 get_memory_packet_size (struct memory_packet_config *config)
603 struct remote_state *rs = get_remote_state ();
604 struct remote_arch_state *rsa = get_remote_arch_state ();
606 /* NOTE: The somewhat arbitrary 16k comes from the knowledge (folk
607 law?) that some hosts don't cope very well with large alloca()
608 calls. Eventually the alloca() code will be replaced by calls to
609 xmalloc() and make_cleanups() allowing this restriction to either
610 be lifted or removed. */
611 #ifndef MAX_REMOTE_PACKET_SIZE
612 #define MAX_REMOTE_PACKET_SIZE 16384
613 #endif
614 /* NOTE: 20 ensures we can write at least one byte. */
615 #ifndef MIN_REMOTE_PACKET_SIZE
616 #define MIN_REMOTE_PACKET_SIZE 20
617 #endif
618 long what_they_get;
619 if (config->fixed_p)
621 if (config->size <= 0)
622 what_they_get = MAX_REMOTE_PACKET_SIZE;
623 else
624 what_they_get = config->size;
626 else
628 what_they_get = get_remote_packet_size ();
629 /* Limit the packet to the size specified by the user. */
630 if (config->size > 0
631 && what_they_get > config->size)
632 what_they_get = config->size;
634 /* Limit it to the size of the targets ``g'' response unless we have
635 permission from the stub to use a larger packet size. */
636 if (rs->explicit_packet_size == 0
637 && rsa->actual_register_packet_size > 0
638 && what_they_get > rsa->actual_register_packet_size)
639 what_they_get = rsa->actual_register_packet_size;
641 if (what_they_get > MAX_REMOTE_PACKET_SIZE)
642 what_they_get = MAX_REMOTE_PACKET_SIZE;
643 if (what_they_get < MIN_REMOTE_PACKET_SIZE)
644 what_they_get = MIN_REMOTE_PACKET_SIZE;
646 /* Make sure there is room in the global buffer for this packet
647 (including its trailing NUL byte). */
648 if (rs->buf_size < what_they_get + 1)
650 rs->buf_size = 2 * what_they_get;
651 rs->buf = xrealloc (rs->buf, 2 * what_they_get);
654 return what_they_get;
657 /* Update the size of a read/write packet. If they user wants
658 something really big then do a sanity check. */
660 static void
661 set_memory_packet_size (char *args, struct memory_packet_config *config)
663 int fixed_p = config->fixed_p;
664 long size = config->size;
665 if (args == NULL)
666 error (_("Argument required (integer, `fixed' or `limited')."));
667 else if (strcmp (args, "hard") == 0
668 || strcmp (args, "fixed") == 0)
669 fixed_p = 1;
670 else if (strcmp (args, "soft") == 0
671 || strcmp (args, "limit") == 0)
672 fixed_p = 0;
673 else
675 char *end;
676 size = strtoul (args, &end, 0);
677 if (args == end)
678 error (_("Invalid %s (bad syntax)."), config->name);
679 #if 0
680 /* Instead of explicitly capping the size of a packet to
681 MAX_REMOTE_PACKET_SIZE or dissallowing it, the user is
682 instead allowed to set the size to something arbitrarily
683 large. */
684 if (size > MAX_REMOTE_PACKET_SIZE)
685 error (_("Invalid %s (too large)."), config->name);
686 #endif
688 /* Extra checks? */
689 if (fixed_p && !config->fixed_p)
691 if (! query (_("The target may not be able to correctly handle a %s\n"
692 "of %ld bytes. Change the packet size? "),
693 config->name, size))
694 error (_("Packet size not changed."));
696 /* Update the config. */
697 config->fixed_p = fixed_p;
698 config->size = size;
701 static void
702 show_memory_packet_size (struct memory_packet_config *config)
704 printf_filtered (_("The %s is %ld. "), config->name, config->size);
705 if (config->fixed_p)
706 printf_filtered (_("Packets are fixed at %ld bytes.\n"),
707 get_memory_packet_size (config));
708 else
709 printf_filtered (_("Packets are limited to %ld bytes.\n"),
710 get_memory_packet_size (config));
713 static struct memory_packet_config memory_write_packet_config =
715 "memory-write-packet-size",
718 static void
719 set_memory_write_packet_size (char *args, int from_tty)
721 set_memory_packet_size (args, &memory_write_packet_config);
724 static void
725 show_memory_write_packet_size (char *args, int from_tty)
727 show_memory_packet_size (&memory_write_packet_config);
730 static long
731 get_memory_write_packet_size (void)
733 return get_memory_packet_size (&memory_write_packet_config);
736 static struct memory_packet_config memory_read_packet_config =
738 "memory-read-packet-size",
741 static void
742 set_memory_read_packet_size (char *args, int from_tty)
744 set_memory_packet_size (args, &memory_read_packet_config);
747 static void
748 show_memory_read_packet_size (char *args, int from_tty)
750 show_memory_packet_size (&memory_read_packet_config);
753 static long
754 get_memory_read_packet_size (void)
756 long size = get_memory_packet_size (&memory_read_packet_config);
757 /* FIXME: cagney/1999-11-07: Functions like getpkt() need to get an
758 extra buffer size argument before the memory read size can be
759 increased beyond this. */
760 if (size > get_remote_packet_size ())
761 size = get_remote_packet_size ();
762 return size;
766 /* Generic configuration support for packets the stub optionally
767 supports. Allows the user to specify the use of the packet as well
768 as allowing GDB to auto-detect support in the remote stub. */
770 enum packet_support
772 PACKET_SUPPORT_UNKNOWN = 0,
773 PACKET_ENABLE,
774 PACKET_DISABLE
777 struct packet_config
779 const char *name;
780 const char *title;
781 enum auto_boolean detect;
782 enum packet_support support;
785 /* Analyze a packet's return value and update the packet config
786 accordingly. */
788 enum packet_result
790 PACKET_ERROR,
791 PACKET_OK,
792 PACKET_UNKNOWN
795 static void
796 update_packet_config (struct packet_config *config)
798 switch (config->detect)
800 case AUTO_BOOLEAN_TRUE:
801 config->support = PACKET_ENABLE;
802 break;
803 case AUTO_BOOLEAN_FALSE:
804 config->support = PACKET_DISABLE;
805 break;
806 case AUTO_BOOLEAN_AUTO:
807 config->support = PACKET_SUPPORT_UNKNOWN;
808 break;
812 static void
813 show_packet_config_cmd (struct packet_config *config)
815 char *support = "internal-error";
816 switch (config->support)
818 case PACKET_ENABLE:
819 support = "enabled";
820 break;
821 case PACKET_DISABLE:
822 support = "disabled";
823 break;
824 case PACKET_SUPPORT_UNKNOWN:
825 support = "unknown";
826 break;
828 switch (config->detect)
830 case AUTO_BOOLEAN_AUTO:
831 printf_filtered (_("Support for the `%s' packet is auto-detected, currently %s.\n"),
832 config->name, support);
833 break;
834 case AUTO_BOOLEAN_TRUE:
835 case AUTO_BOOLEAN_FALSE:
836 printf_filtered (_("Support for the `%s' packet is currently %s.\n"),
837 config->name, support);
838 break;
842 static void
843 add_packet_config_cmd (struct packet_config *config, const char *name,
844 const char *title, int legacy)
846 char *set_doc;
847 char *show_doc;
848 char *cmd_name;
850 config->name = name;
851 config->title = title;
852 config->detect = AUTO_BOOLEAN_AUTO;
853 config->support = PACKET_SUPPORT_UNKNOWN;
854 set_doc = xstrprintf ("Set use of remote protocol `%s' (%s) packet",
855 name, title);
856 show_doc = xstrprintf ("Show current use of remote protocol `%s' (%s) packet",
857 name, title);
858 /* set/show TITLE-packet {auto,on,off} */
859 cmd_name = xstrprintf ("%s-packet", title);
860 add_setshow_auto_boolean_cmd (cmd_name, class_obscure,
861 &config->detect, set_doc, show_doc, NULL, /* help_doc */
862 set_remote_protocol_packet_cmd,
863 show_remote_protocol_packet_cmd,
864 &remote_set_cmdlist, &remote_show_cmdlist);
865 /* set/show remote NAME-packet {auto,on,off} -- legacy. */
866 if (legacy)
868 char *legacy_name;
869 legacy_name = xstrprintf ("%s-packet", name);
870 add_alias_cmd (legacy_name, cmd_name, class_obscure, 0,
871 &remote_set_cmdlist);
872 add_alias_cmd (legacy_name, cmd_name, class_obscure, 0,
873 &remote_show_cmdlist);
877 static enum packet_result
878 packet_check_result (const char *buf)
880 if (buf[0] != '\0')
882 /* The stub recognized the packet request. Check that the
883 operation succeeded. */
884 if (buf[0] == 'E'
885 && isxdigit (buf[1]) && isxdigit (buf[2])
886 && buf[3] == '\0')
887 /* "Enn" - definitly an error. */
888 return PACKET_ERROR;
890 /* Always treat "E." as an error. This will be used for
891 more verbose error messages, such as E.memtypes. */
892 if (buf[0] == 'E' && buf[1] == '.')
893 return PACKET_ERROR;
895 /* The packet may or may not be OK. Just assume it is. */
896 return PACKET_OK;
898 else
899 /* The stub does not support the packet. */
900 return PACKET_UNKNOWN;
903 static enum packet_result
904 packet_ok (const char *buf, struct packet_config *config)
906 enum packet_result result;
908 result = packet_check_result (buf);
909 switch (result)
911 case PACKET_OK:
912 case PACKET_ERROR:
913 /* The stub recognized the packet request. */
914 switch (config->support)
916 case PACKET_SUPPORT_UNKNOWN:
917 if (remote_debug)
918 fprintf_unfiltered (gdb_stdlog,
919 "Packet %s (%s) is supported\n",
920 config->name, config->title);
921 config->support = PACKET_ENABLE;
922 break;
923 case PACKET_DISABLE:
924 internal_error (__FILE__, __LINE__,
925 _("packet_ok: attempt to use a disabled packet"));
926 break;
927 case PACKET_ENABLE:
928 break;
930 break;
931 case PACKET_UNKNOWN:
932 /* The stub does not support the packet. */
933 switch (config->support)
935 case PACKET_ENABLE:
936 if (config->detect == AUTO_BOOLEAN_AUTO)
937 /* If the stub previously indicated that the packet was
938 supported then there is a protocol error.. */
939 error (_("Protocol error: %s (%s) conflicting enabled responses."),
940 config->name, config->title);
941 else
942 /* The user set it wrong. */
943 error (_("Enabled packet %s (%s) not recognized by stub"),
944 config->name, config->title);
945 break;
946 case PACKET_SUPPORT_UNKNOWN:
947 if (remote_debug)
948 fprintf_unfiltered (gdb_stdlog,
949 "Packet %s (%s) is NOT supported\n",
950 config->name, config->title);
951 config->support = PACKET_DISABLE;
952 break;
953 case PACKET_DISABLE:
954 break;
956 break;
959 return result;
962 enum {
963 PACKET_vCont = 0,
964 PACKET_X,
965 PACKET_qSymbol,
966 PACKET_P,
967 PACKET_p,
968 PACKET_Z0,
969 PACKET_Z1,
970 PACKET_Z2,
971 PACKET_Z3,
972 PACKET_Z4,
973 PACKET_vFile_open,
974 PACKET_vFile_pread,
975 PACKET_vFile_pwrite,
976 PACKET_vFile_close,
977 PACKET_vFile_unlink,
978 PACKET_qXfer_auxv,
979 PACKET_qXfer_features,
980 PACKET_qXfer_libraries,
981 PACKET_qXfer_memory_map,
982 PACKET_qXfer_spu_read,
983 PACKET_qXfer_spu_write,
984 PACKET_qXfer_osdata,
985 PACKET_qGetTLSAddr,
986 PACKET_qSupported,
987 PACKET_QPassSignals,
988 PACKET_qSearch_memory,
989 PACKET_vAttach,
990 PACKET_vRun,
991 PACKET_QStartNoAckMode,
992 PACKET_vKill,
993 PACKET_qXfer_siginfo_read,
994 PACKET_qXfer_siginfo_write,
995 PACKET_qAttached,
996 PACKET_MAX
999 static struct packet_config remote_protocol_packets[PACKET_MAX];
1001 static void
1002 set_remote_protocol_packet_cmd (char *args, int from_tty,
1003 struct cmd_list_element *c)
1005 struct packet_config *packet;
1007 for (packet = remote_protocol_packets;
1008 packet < &remote_protocol_packets[PACKET_MAX];
1009 packet++)
1011 if (&packet->detect == c->var)
1013 update_packet_config (packet);
1014 return;
1017 internal_error (__FILE__, __LINE__, "Could not find config for %s",
1018 c->name);
1021 static void
1022 show_remote_protocol_packet_cmd (struct ui_file *file, int from_tty,
1023 struct cmd_list_element *c,
1024 const char *value)
1026 struct packet_config *packet;
1028 for (packet = remote_protocol_packets;
1029 packet < &remote_protocol_packets[PACKET_MAX];
1030 packet++)
1032 if (&packet->detect == c->var)
1034 show_packet_config_cmd (packet);
1035 return;
1038 internal_error (__FILE__, __LINE__, "Could not find config for %s",
1039 c->name);
1042 /* Should we try one of the 'Z' requests? */
1044 enum Z_packet_type
1046 Z_PACKET_SOFTWARE_BP,
1047 Z_PACKET_HARDWARE_BP,
1048 Z_PACKET_WRITE_WP,
1049 Z_PACKET_READ_WP,
1050 Z_PACKET_ACCESS_WP,
1051 NR_Z_PACKET_TYPES
1054 /* For compatibility with older distributions. Provide a ``set remote
1055 Z-packet ...'' command that updates all the Z packet types. */
1057 static enum auto_boolean remote_Z_packet_detect;
1059 static void
1060 set_remote_protocol_Z_packet_cmd (char *args, int from_tty,
1061 struct cmd_list_element *c)
1063 int i;
1064 for (i = 0; i < NR_Z_PACKET_TYPES; i++)
1066 remote_protocol_packets[PACKET_Z0 + i].detect = remote_Z_packet_detect;
1067 update_packet_config (&remote_protocol_packets[PACKET_Z0 + i]);
1071 static void
1072 show_remote_protocol_Z_packet_cmd (struct ui_file *file, int from_tty,
1073 struct cmd_list_element *c,
1074 const char *value)
1076 int i;
1077 for (i = 0; i < NR_Z_PACKET_TYPES; i++)
1079 show_packet_config_cmd (&remote_protocol_packets[PACKET_Z0 + i]);
1083 /* Should we try the 'ThreadInfo' query packet?
1085 This variable (NOT available to the user: auto-detect only!)
1086 determines whether GDB will use the new, simpler "ThreadInfo"
1087 query or the older, more complex syntax for thread queries.
1088 This is an auto-detect variable (set to true at each connect,
1089 and set to false when the target fails to recognize it). */
1091 static int use_threadinfo_query;
1092 static int use_threadextra_query;
1094 /* Tokens for use by the asynchronous signal handlers for SIGINT. */
1095 static struct async_signal_handler *sigint_remote_twice_token;
1096 static struct async_signal_handler *sigint_remote_token;
1099 /* Asynchronous signal handle registered as event loop source for
1100 when we have pending events ready to be passed to the core. */
1102 static struct async_event_handler *remote_async_inferior_event_token;
1104 /* Asynchronous signal handle registered as event loop source for when
1105 the remote sent us a %Stop notification. The registered callback
1106 will do a vStopped sequence to pull the rest of the events out of
1107 the remote side into our event queue. */
1109 static struct async_event_handler *remote_async_get_pending_events_token;
1112 static ptid_t magic_null_ptid;
1113 static ptid_t not_sent_ptid;
1114 static ptid_t any_thread_ptid;
1116 /* These are the threads which we last sent to the remote system. The
1117 TID member will be -1 for all or -2 for not sent yet. */
1119 static ptid_t general_thread;
1120 static ptid_t continue_thread;
1122 /* Find out if the stub attached to PID (and hence GDB should offer to
1123 detach instead of killing it when bailing out). */
1125 static int
1126 remote_query_attached (int pid)
1128 struct remote_state *rs = get_remote_state ();
1130 if (remote_protocol_packets[PACKET_qAttached].support == PACKET_DISABLE)
1131 return 0;
1133 if (remote_multi_process_p (rs))
1134 sprintf (rs->buf, "qAttached:%x", pid);
1135 else
1136 sprintf (rs->buf, "qAttached");
1138 putpkt (rs->buf);
1139 getpkt (&rs->buf, &rs->buf_size, 0);
1141 switch (packet_ok (rs->buf,
1142 &remote_protocol_packets[PACKET_qAttached]) == PACKET_OK)
1144 case PACKET_OK:
1145 if (strcmp (rs->buf, "1") == 0)
1146 return 1;
1147 break;
1148 case PACKET_ERROR:
1149 warning (_("Remote failure reply: %s"), rs->buf);
1150 break;
1151 case PACKET_UNKNOWN:
1152 break;
1155 return 0;
1158 /* Add PID to GDB's inferior table. Since we can be connected to a
1159 remote system before before knowing about any inferior, mark the
1160 target with execution when we find the first inferior. If ATTACHED
1161 is 1, then we had just attached to this inferior. If it is 0, then
1162 we just created this inferior. If it is -1, then try querying the
1163 remote stub to find out if it had attached to the inferior or
1164 not. */
1166 static struct inferior *
1167 remote_add_inferior (int pid, int attached)
1169 struct remote_state *rs = get_remote_state ();
1170 struct inferior *inf;
1172 /* Check whether this process we're learning about is to be
1173 considered attached, or if is to be considered to have been
1174 spawned by the stub. */
1175 if (attached == -1)
1176 attached = remote_query_attached (pid);
1178 inf = add_inferior (pid);
1180 inf->attach_flag = attached;
1182 /* This may be the first inferior we hear about. */
1183 if (!target_has_execution)
1185 if (rs->extended)
1186 target_mark_running (&extended_remote_ops);
1187 else
1188 target_mark_running (&remote_ops);
1191 return inf;
1194 /* Add thread PTID to GDB's thread list. Tag it as executing/running
1195 according to RUNNING. */
1197 static void
1198 remote_add_thread (ptid_t ptid, int running)
1200 add_thread (ptid);
1202 set_executing (ptid, running);
1203 set_running (ptid, running);
1206 /* Come here when we learn about a thread id from the remote target.
1207 It may be the first time we hear about such thread, so take the
1208 opportunity to add it to GDB's thread list. In case this is the
1209 first time we're noticing its corresponding inferior, add it to
1210 GDB's inferior list as well. */
1212 static void
1213 remote_notice_new_inferior (ptid_t currthread, int running)
1215 struct remote_state *rs = get_remote_state ();
1217 /* If this is a new thread, add it to GDB's thread list.
1218 If we leave it up to WFI to do this, bad things will happen. */
1220 if (in_thread_list (currthread) && is_exited (currthread))
1222 /* We're seeing an event on a thread id we knew had exited.
1223 This has to be a new thread reusing the old id. Add it. */
1224 remote_add_thread (currthread, running);
1225 return;
1228 if (!in_thread_list (currthread))
1230 struct inferior *inf = NULL;
1232 if (ptid_equal (pid_to_ptid (ptid_get_pid (currthread)), inferior_ptid))
1234 /* inferior_ptid has no thread member yet. This can happen
1235 with the vAttach -> remote_wait,"TAAthread:" path if the
1236 stub doesn't support qC. This is the first stop reported
1237 after an attach, so this is the main thread. Update the
1238 ptid in the thread list. */
1239 thread_change_ptid (inferior_ptid, currthread);
1240 return;
1243 if (ptid_equal (magic_null_ptid, inferior_ptid))
1245 /* inferior_ptid is not set yet. This can happen with the
1246 vRun -> remote_wait,"TAAthread:" path if the stub
1247 doesn't support qC. This is the first stop reported
1248 after an attach, so this is the main thread. Update the
1249 ptid in the thread list. */
1250 thread_change_ptid (inferior_ptid, currthread);
1251 return;
1254 /* When connecting to a target remote, or to a target
1255 extended-remote which already was debugging an inferior, we
1256 may not know about it yet. Add it before adding its child
1257 thread, so notifications are emitted in a sensible order. */
1258 if (!in_inferior_list (ptid_get_pid (currthread)))
1259 inf = remote_add_inferior (ptid_get_pid (currthread), -1);
1261 /* This is really a new thread. Add it. */
1262 remote_add_thread (currthread, running);
1264 /* If we found a new inferior, let the common code do whatever
1265 it needs to with it (e.g., read shared libraries, insert
1266 breakpoints). */
1267 if (inf != NULL)
1268 notice_new_inferior (currthread, running, 0);
1272 /* Call this function as a result of
1273 1) A halt indication (T packet) containing a thread id
1274 2) A direct query of currthread
1275 3) Successful execution of set thread
1278 static void
1279 record_currthread (ptid_t currthread)
1281 general_thread = currthread;
1283 if (ptid_equal (currthread, minus_one_ptid))
1284 /* We're just invalidating the local thread mirror. */
1285 return;
1287 remote_notice_new_inferior (currthread, 0);
1290 static char *last_pass_packet;
1292 /* If 'QPassSignals' is supported, tell the remote stub what signals
1293 it can simply pass through to the inferior without reporting. */
1295 static void
1296 remote_pass_signals (void)
1298 if (remote_protocol_packets[PACKET_QPassSignals].support != PACKET_DISABLE)
1300 char *pass_packet, *p;
1301 int numsigs = (int) TARGET_SIGNAL_LAST;
1302 int count = 0, i;
1304 gdb_assert (numsigs < 256);
1305 for (i = 0; i < numsigs; i++)
1307 if (signal_stop_state (i) == 0
1308 && signal_print_state (i) == 0
1309 && signal_pass_state (i) == 1)
1310 count++;
1312 pass_packet = xmalloc (count * 3 + strlen ("QPassSignals:") + 1);
1313 strcpy (pass_packet, "QPassSignals:");
1314 p = pass_packet + strlen (pass_packet);
1315 for (i = 0; i < numsigs; i++)
1317 if (signal_stop_state (i) == 0
1318 && signal_print_state (i) == 0
1319 && signal_pass_state (i) == 1)
1321 if (i >= 16)
1322 *p++ = tohex (i >> 4);
1323 *p++ = tohex (i & 15);
1324 if (count)
1325 *p++ = ';';
1326 else
1327 break;
1328 count--;
1331 *p = 0;
1332 if (!last_pass_packet || strcmp (last_pass_packet, pass_packet))
1334 struct remote_state *rs = get_remote_state ();
1335 char *buf = rs->buf;
1337 putpkt (pass_packet);
1338 getpkt (&rs->buf, &rs->buf_size, 0);
1339 packet_ok (buf, &remote_protocol_packets[PACKET_QPassSignals]);
1340 if (last_pass_packet)
1341 xfree (last_pass_packet);
1342 last_pass_packet = pass_packet;
1344 else
1345 xfree (pass_packet);
1349 /* If PTID is MAGIC_NULL_PTID, don't set any thread. If PTID is
1350 MINUS_ONE_PTID, set the thread to -1, so the stub returns the
1351 thread. If GEN is set, set the general thread, if not, then set
1352 the step/continue thread. */
1353 static void
1354 set_thread (struct ptid ptid, int gen)
1356 struct remote_state *rs = get_remote_state ();
1357 ptid_t state = gen ? general_thread : continue_thread;
1358 char *buf = rs->buf;
1359 char *endbuf = rs->buf + get_remote_packet_size ();
1361 if (ptid_equal (state, ptid))
1362 return;
1364 *buf++ = 'H';
1365 *buf++ = gen ? 'g' : 'c';
1366 if (ptid_equal (ptid, magic_null_ptid))
1367 xsnprintf (buf, endbuf - buf, "0");
1368 else if (ptid_equal (ptid, any_thread_ptid))
1369 xsnprintf (buf, endbuf - buf, "0");
1370 else if (ptid_equal (ptid, minus_one_ptid))
1371 xsnprintf (buf, endbuf - buf, "-1");
1372 else
1373 write_ptid (buf, endbuf, ptid);
1374 putpkt (rs->buf);
1375 getpkt (&rs->buf, &rs->buf_size, 0);
1376 if (gen)
1377 general_thread = ptid;
1378 else
1379 continue_thread = ptid;
1382 static void
1383 set_general_thread (struct ptid ptid)
1385 set_thread (ptid, 1);
1388 static void
1389 set_continue_thread (struct ptid ptid)
1391 set_thread (ptid, 0);
1394 /* Change the remote current process. Which thread within the process
1395 ends up selected isn't important, as long as it is the same process
1396 as what INFERIOR_PTID points to.
1398 This comes from that fact that there is no explicit notion of
1399 "selected process" in the protocol. The selected process for
1400 general operations is the process the selected general thread
1401 belongs to. */
1403 static void
1404 set_general_process (void)
1406 struct remote_state *rs = get_remote_state ();
1408 /* If the remote can't handle multiple processes, don't bother. */
1409 if (!remote_multi_process_p (rs))
1410 return;
1412 /* We only need to change the remote current thread if it's pointing
1413 at some other process. */
1414 if (ptid_get_pid (general_thread) != ptid_get_pid (inferior_ptid))
1415 set_general_thread (inferior_ptid);
1419 /* Return nonzero if the thread PTID is still alive on the remote
1420 system. */
1422 static int
1423 remote_thread_alive (struct target_ops *ops, ptid_t ptid)
1425 struct remote_state *rs = get_remote_state ();
1426 int tid = ptid_get_tid (ptid);
1427 char *p, *endp;
1429 if (ptid_equal (ptid, magic_null_ptid))
1430 /* The main thread is always alive. */
1431 return 1;
1433 if (ptid_get_pid (ptid) != 0 && ptid_get_tid (ptid) == 0)
1434 /* The main thread is always alive. This can happen after a
1435 vAttach, if the remote side doesn't support
1436 multi-threading. */
1437 return 1;
1439 p = rs->buf;
1440 endp = rs->buf + get_remote_packet_size ();
1442 *p++ = 'T';
1443 write_ptid (p, endp, ptid);
1445 putpkt (rs->buf);
1446 getpkt (&rs->buf, &rs->buf_size, 0);
1447 return (rs->buf[0] == 'O' && rs->buf[1] == 'K');
1450 /* About these extended threadlist and threadinfo packets. They are
1451 variable length packets but, the fields within them are often fixed
1452 length. They are redundent enough to send over UDP as is the
1453 remote protocol in general. There is a matching unit test module
1454 in libstub. */
1456 #define OPAQUETHREADBYTES 8
1458 /* a 64 bit opaque identifier */
1459 typedef unsigned char threadref[OPAQUETHREADBYTES];
1461 /* WARNING: This threadref data structure comes from the remote O.S.,
1462 libstub protocol encoding, and remote.c. it is not particularly
1463 changable. */
1465 /* Right now, the internal structure is int. We want it to be bigger.
1466 Plan to fix this.
1469 typedef int gdb_threadref; /* Internal GDB thread reference. */
1471 /* gdb_ext_thread_info is an internal GDB data structure which is
1472 equivalent to the reply of the remote threadinfo packet. */
1474 struct gdb_ext_thread_info
1476 threadref threadid; /* External form of thread reference. */
1477 int active; /* Has state interesting to GDB?
1478 regs, stack. */
1479 char display[256]; /* Brief state display, name,
1480 blocked/suspended. */
1481 char shortname[32]; /* To be used to name threads. */
1482 char more_display[256]; /* Long info, statistics, queue depth,
1483 whatever. */
1486 /* The volume of remote transfers can be limited by submitting
1487 a mask containing bits specifying the desired information.
1488 Use a union of these values as the 'selection' parameter to
1489 get_thread_info. FIXME: Make these TAG names more thread specific.
1492 #define TAG_THREADID 1
1493 #define TAG_EXISTS 2
1494 #define TAG_DISPLAY 4
1495 #define TAG_THREADNAME 8
1496 #define TAG_MOREDISPLAY 16
1498 #define BUF_THREAD_ID_SIZE (OPAQUETHREADBYTES * 2)
1500 char *unpack_varlen_hex (char *buff, ULONGEST *result);
1502 static char *unpack_nibble (char *buf, int *val);
1504 static char *pack_nibble (char *buf, int nibble);
1506 static char *pack_hex_byte (char *pkt, int /* unsigned char */ byte);
1508 static char *unpack_byte (char *buf, int *value);
1510 static char *pack_int (char *buf, int value);
1512 static char *unpack_int (char *buf, int *value);
1514 static char *unpack_string (char *src, char *dest, int length);
1516 static char *pack_threadid (char *pkt, threadref *id);
1518 static char *unpack_threadid (char *inbuf, threadref *id);
1520 void int_to_threadref (threadref *id, int value);
1522 static int threadref_to_int (threadref *ref);
1524 static void copy_threadref (threadref *dest, threadref *src);
1526 static int threadmatch (threadref *dest, threadref *src);
1528 static char *pack_threadinfo_request (char *pkt, int mode,
1529 threadref *id);
1531 static int remote_unpack_thread_info_response (char *pkt,
1532 threadref *expectedref,
1533 struct gdb_ext_thread_info
1534 *info);
1537 static int remote_get_threadinfo (threadref *threadid,
1538 int fieldset, /*TAG mask */
1539 struct gdb_ext_thread_info *info);
1541 static char *pack_threadlist_request (char *pkt, int startflag,
1542 int threadcount,
1543 threadref *nextthread);
1545 static int parse_threadlist_response (char *pkt,
1546 int result_limit,
1547 threadref *original_echo,
1548 threadref *resultlist,
1549 int *doneflag);
1551 static int remote_get_threadlist (int startflag,
1552 threadref *nextthread,
1553 int result_limit,
1554 int *done,
1555 int *result_count,
1556 threadref *threadlist);
1558 typedef int (*rmt_thread_action) (threadref *ref, void *context);
1560 static int remote_threadlist_iterator (rmt_thread_action stepfunction,
1561 void *context, int looplimit);
1563 static int remote_newthread_step (threadref *ref, void *context);
1566 /* Write a PTID to BUF. ENDBUF points to one-passed-the-end of the
1567 buffer we're allowed to write to. Returns
1568 BUF+CHARACTERS_WRITTEN. */
1570 static char *
1571 write_ptid (char *buf, const char *endbuf, ptid_t ptid)
1573 int pid, tid;
1574 struct remote_state *rs = get_remote_state ();
1576 if (remote_multi_process_p (rs))
1578 pid = ptid_get_pid (ptid);
1579 if (pid < 0)
1580 buf += xsnprintf (buf, endbuf - buf, "p-%x.", -pid);
1581 else
1582 buf += xsnprintf (buf, endbuf - buf, "p%x.", pid);
1584 tid = ptid_get_tid (ptid);
1585 if (tid < 0)
1586 buf += xsnprintf (buf, endbuf - buf, "-%x", -tid);
1587 else
1588 buf += xsnprintf (buf, endbuf - buf, "%x", tid);
1590 return buf;
1593 /* Extract a PTID from BUF. If non-null, OBUF is set to the to one
1594 passed the last parsed char. Returns null_ptid on error. */
1596 static ptid_t
1597 read_ptid (char *buf, char **obuf)
1599 char *p = buf;
1600 char *pp;
1601 ULONGEST pid = 0, tid = 0;
1602 ptid_t ptid;
1604 if (*p == 'p')
1606 /* Multi-process ptid. */
1607 pp = unpack_varlen_hex (p + 1, &pid);
1608 if (*pp != '.')
1609 error (_("invalid remote ptid: %s\n"), p);
1611 p = pp;
1612 pp = unpack_varlen_hex (p + 1, &tid);
1613 if (obuf)
1614 *obuf = pp;
1615 return ptid_build (pid, 0, tid);
1618 /* No multi-process. Just a tid. */
1619 pp = unpack_varlen_hex (p, &tid);
1621 /* Since the stub is not sending a process id, then default to
1622 what's in inferior_ptid, unless it's null at this point. If so,
1623 then since there's no way to know the pid of the reported
1624 threads, use the magic number. */
1625 if (ptid_equal (inferior_ptid, null_ptid))
1626 pid = ptid_get_pid (magic_null_ptid);
1627 else
1628 pid = ptid_get_pid (inferior_ptid);
1630 if (obuf)
1631 *obuf = pp;
1632 return ptid_build (pid, 0, tid);
1635 /* Encode 64 bits in 16 chars of hex. */
1637 static const char hexchars[] = "0123456789abcdef";
1639 static int
1640 ishex (int ch, int *val)
1642 if ((ch >= 'a') && (ch <= 'f'))
1644 *val = ch - 'a' + 10;
1645 return 1;
1647 if ((ch >= 'A') && (ch <= 'F'))
1649 *val = ch - 'A' + 10;
1650 return 1;
1652 if ((ch >= '0') && (ch <= '9'))
1654 *val = ch - '0';
1655 return 1;
1657 return 0;
1660 static int
1661 stubhex (int ch)
1663 if (ch >= 'a' && ch <= 'f')
1664 return ch - 'a' + 10;
1665 if (ch >= '0' && ch <= '9')
1666 return ch - '0';
1667 if (ch >= 'A' && ch <= 'F')
1668 return ch - 'A' + 10;
1669 return -1;
1672 static int
1673 stub_unpack_int (char *buff, int fieldlength)
1675 int nibble;
1676 int retval = 0;
1678 while (fieldlength)
1680 nibble = stubhex (*buff++);
1681 retval |= nibble;
1682 fieldlength--;
1683 if (fieldlength)
1684 retval = retval << 4;
1686 return retval;
1689 char *
1690 unpack_varlen_hex (char *buff, /* packet to parse */
1691 ULONGEST *result)
1693 int nibble;
1694 ULONGEST retval = 0;
1696 while (ishex (*buff, &nibble))
1698 buff++;
1699 retval = retval << 4;
1700 retval |= nibble & 0x0f;
1702 *result = retval;
1703 return buff;
1706 static char *
1707 unpack_nibble (char *buf, int *val)
1709 *val = fromhex (*buf++);
1710 return buf;
1713 static char *
1714 pack_nibble (char *buf, int nibble)
1716 *buf++ = hexchars[(nibble & 0x0f)];
1717 return buf;
1720 static char *
1721 pack_hex_byte (char *pkt, int byte)
1723 *pkt++ = hexchars[(byte >> 4) & 0xf];
1724 *pkt++ = hexchars[(byte & 0xf)];
1725 return pkt;
1728 static char *
1729 unpack_byte (char *buf, int *value)
1731 *value = stub_unpack_int (buf, 2);
1732 return buf + 2;
1735 static char *
1736 pack_int (char *buf, int value)
1738 buf = pack_hex_byte (buf, (value >> 24) & 0xff);
1739 buf = pack_hex_byte (buf, (value >> 16) & 0xff);
1740 buf = pack_hex_byte (buf, (value >> 8) & 0x0ff);
1741 buf = pack_hex_byte (buf, (value & 0xff));
1742 return buf;
1745 static char *
1746 unpack_int (char *buf, int *value)
1748 *value = stub_unpack_int (buf, 8);
1749 return buf + 8;
1752 #if 0 /* Currently unused, uncomment when needed. */
1753 static char *pack_string (char *pkt, char *string);
1755 static char *
1756 pack_string (char *pkt, char *string)
1758 char ch;
1759 int len;
1761 len = strlen (string);
1762 if (len > 200)
1763 len = 200; /* Bigger than most GDB packets, junk??? */
1764 pkt = pack_hex_byte (pkt, len);
1765 while (len-- > 0)
1767 ch = *string++;
1768 if ((ch == '\0') || (ch == '#'))
1769 ch = '*'; /* Protect encapsulation. */
1770 *pkt++ = ch;
1772 return pkt;
1774 #endif /* 0 (unused) */
1776 static char *
1777 unpack_string (char *src, char *dest, int length)
1779 while (length--)
1780 *dest++ = *src++;
1781 *dest = '\0';
1782 return src;
1785 static char *
1786 pack_threadid (char *pkt, threadref *id)
1788 char *limit;
1789 unsigned char *altid;
1791 altid = (unsigned char *) id;
1792 limit = pkt + BUF_THREAD_ID_SIZE;
1793 while (pkt < limit)
1794 pkt = pack_hex_byte (pkt, *altid++);
1795 return pkt;
1799 static char *
1800 unpack_threadid (char *inbuf, threadref *id)
1802 char *altref;
1803 char *limit = inbuf + BUF_THREAD_ID_SIZE;
1804 int x, y;
1806 altref = (char *) id;
1808 while (inbuf < limit)
1810 x = stubhex (*inbuf++);
1811 y = stubhex (*inbuf++);
1812 *altref++ = (x << 4) | y;
1814 return inbuf;
1817 /* Externally, threadrefs are 64 bits but internally, they are still
1818 ints. This is due to a mismatch of specifications. We would like
1819 to use 64bit thread references internally. This is an adapter
1820 function. */
1822 void
1823 int_to_threadref (threadref *id, int value)
1825 unsigned char *scan;
1827 scan = (unsigned char *) id;
1829 int i = 4;
1830 while (i--)
1831 *scan++ = 0;
1833 *scan++ = (value >> 24) & 0xff;
1834 *scan++ = (value >> 16) & 0xff;
1835 *scan++ = (value >> 8) & 0xff;
1836 *scan++ = (value & 0xff);
1839 static int
1840 threadref_to_int (threadref *ref)
1842 int i, value = 0;
1843 unsigned char *scan;
1845 scan = *ref;
1846 scan += 4;
1847 i = 4;
1848 while (i-- > 0)
1849 value = (value << 8) | ((*scan++) & 0xff);
1850 return value;
1853 static void
1854 copy_threadref (threadref *dest, threadref *src)
1856 int i;
1857 unsigned char *csrc, *cdest;
1859 csrc = (unsigned char *) src;
1860 cdest = (unsigned char *) dest;
1861 i = 8;
1862 while (i--)
1863 *cdest++ = *csrc++;
1866 static int
1867 threadmatch (threadref *dest, threadref *src)
1869 /* Things are broken right now, so just assume we got a match. */
1870 #if 0
1871 unsigned char *srcp, *destp;
1872 int i, result;
1873 srcp = (char *) src;
1874 destp = (char *) dest;
1876 result = 1;
1877 while (i-- > 0)
1878 result &= (*srcp++ == *destp++) ? 1 : 0;
1879 return result;
1880 #endif
1881 return 1;
1885 threadid:1, # always request threadid
1886 context_exists:2,
1887 display:4,
1888 unique_name:8,
1889 more_display:16
1892 /* Encoding: 'Q':8,'P':8,mask:32,threadid:64 */
1894 static char *
1895 pack_threadinfo_request (char *pkt, int mode, threadref *id)
1897 *pkt++ = 'q'; /* Info Query */
1898 *pkt++ = 'P'; /* process or thread info */
1899 pkt = pack_int (pkt, mode); /* mode */
1900 pkt = pack_threadid (pkt, id); /* threadid */
1901 *pkt = '\0'; /* terminate */
1902 return pkt;
1905 /* These values tag the fields in a thread info response packet. */
1906 /* Tagging the fields allows us to request specific fields and to
1907 add more fields as time goes by. */
1909 #define TAG_THREADID 1 /* Echo the thread identifier. */
1910 #define TAG_EXISTS 2 /* Is this process defined enough to
1911 fetch registers and its stack? */
1912 #define TAG_DISPLAY 4 /* A short thing maybe to put on a window */
1913 #define TAG_THREADNAME 8 /* string, maps 1-to-1 with a thread is. */
1914 #define TAG_MOREDISPLAY 16 /* Whatever the kernel wants to say about
1915 the process. */
1917 static int
1918 remote_unpack_thread_info_response (char *pkt, threadref *expectedref,
1919 struct gdb_ext_thread_info *info)
1921 struct remote_state *rs = get_remote_state ();
1922 int mask, length;
1923 int tag;
1924 threadref ref;
1925 char *limit = pkt + rs->buf_size; /* Plausible parsing limit. */
1926 int retval = 1;
1928 /* info->threadid = 0; FIXME: implement zero_threadref. */
1929 info->active = 0;
1930 info->display[0] = '\0';
1931 info->shortname[0] = '\0';
1932 info->more_display[0] = '\0';
1934 /* Assume the characters indicating the packet type have been
1935 stripped. */
1936 pkt = unpack_int (pkt, &mask); /* arg mask */
1937 pkt = unpack_threadid (pkt, &ref);
1939 if (mask == 0)
1940 warning (_("Incomplete response to threadinfo request."));
1941 if (!threadmatch (&ref, expectedref))
1942 { /* This is an answer to a different request. */
1943 warning (_("ERROR RMT Thread info mismatch."));
1944 return 0;
1946 copy_threadref (&info->threadid, &ref);
1948 /* Loop on tagged fields , try to bail if somthing goes wrong. */
1950 /* Packets are terminated with nulls. */
1951 while ((pkt < limit) && mask && *pkt)
1953 pkt = unpack_int (pkt, &tag); /* tag */
1954 pkt = unpack_byte (pkt, &length); /* length */
1955 if (!(tag & mask)) /* Tags out of synch with mask. */
1957 warning (_("ERROR RMT: threadinfo tag mismatch."));
1958 retval = 0;
1959 break;
1961 if (tag == TAG_THREADID)
1963 if (length != 16)
1965 warning (_("ERROR RMT: length of threadid is not 16."));
1966 retval = 0;
1967 break;
1969 pkt = unpack_threadid (pkt, &ref);
1970 mask = mask & ~TAG_THREADID;
1971 continue;
1973 if (tag == TAG_EXISTS)
1975 info->active = stub_unpack_int (pkt, length);
1976 pkt += length;
1977 mask = mask & ~(TAG_EXISTS);
1978 if (length > 8)
1980 warning (_("ERROR RMT: 'exists' length too long."));
1981 retval = 0;
1982 break;
1984 continue;
1986 if (tag == TAG_THREADNAME)
1988 pkt = unpack_string (pkt, &info->shortname[0], length);
1989 mask = mask & ~TAG_THREADNAME;
1990 continue;
1992 if (tag == TAG_DISPLAY)
1994 pkt = unpack_string (pkt, &info->display[0], length);
1995 mask = mask & ~TAG_DISPLAY;
1996 continue;
1998 if (tag == TAG_MOREDISPLAY)
2000 pkt = unpack_string (pkt, &info->more_display[0], length);
2001 mask = mask & ~TAG_MOREDISPLAY;
2002 continue;
2004 warning (_("ERROR RMT: unknown thread info tag."));
2005 break; /* Not a tag we know about. */
2007 return retval;
2010 static int
2011 remote_get_threadinfo (threadref *threadid, int fieldset, /* TAG mask */
2012 struct gdb_ext_thread_info *info)
2014 struct remote_state *rs = get_remote_state ();
2015 int result;
2017 pack_threadinfo_request (rs->buf, fieldset, threadid);
2018 putpkt (rs->buf);
2019 getpkt (&rs->buf, &rs->buf_size, 0);
2021 if (rs->buf[0] == '\0')
2022 return 0;
2024 result = remote_unpack_thread_info_response (rs->buf + 2,
2025 threadid, info);
2026 return result;
2029 /* Format: i'Q':8,i"L":8,initflag:8,batchsize:16,lastthreadid:32 */
2031 static char *
2032 pack_threadlist_request (char *pkt, int startflag, int threadcount,
2033 threadref *nextthread)
2035 *pkt++ = 'q'; /* info query packet */
2036 *pkt++ = 'L'; /* Process LIST or threadLIST request */
2037 pkt = pack_nibble (pkt, startflag); /* initflag 1 bytes */
2038 pkt = pack_hex_byte (pkt, threadcount); /* threadcount 2 bytes */
2039 pkt = pack_threadid (pkt, nextthread); /* 64 bit thread identifier */
2040 *pkt = '\0';
2041 return pkt;
2044 /* Encoding: 'q':8,'M':8,count:16,done:8,argthreadid:64,(threadid:64)* */
2046 static int
2047 parse_threadlist_response (char *pkt, int result_limit,
2048 threadref *original_echo, threadref *resultlist,
2049 int *doneflag)
2051 struct remote_state *rs = get_remote_state ();
2052 char *limit;
2053 int count, resultcount, done;
2055 resultcount = 0;
2056 /* Assume the 'q' and 'M chars have been stripped. */
2057 limit = pkt + (rs->buf_size - BUF_THREAD_ID_SIZE);
2058 /* done parse past here */
2059 pkt = unpack_byte (pkt, &count); /* count field */
2060 pkt = unpack_nibble (pkt, &done);
2061 /* The first threadid is the argument threadid. */
2062 pkt = unpack_threadid (pkt, original_echo); /* should match query packet */
2063 while ((count-- > 0) && (pkt < limit))
2065 pkt = unpack_threadid (pkt, resultlist++);
2066 if (resultcount++ >= result_limit)
2067 break;
2069 if (doneflag)
2070 *doneflag = done;
2071 return resultcount;
2074 static int
2075 remote_get_threadlist (int startflag, threadref *nextthread, int result_limit,
2076 int *done, int *result_count, threadref *threadlist)
2078 struct remote_state *rs = get_remote_state ();
2079 static threadref echo_nextthread;
2080 int result = 1;
2082 /* Trancate result limit to be smaller than the packet size. */
2083 if ((((result_limit + 1) * BUF_THREAD_ID_SIZE) + 10) >= get_remote_packet_size ())
2084 result_limit = (get_remote_packet_size () / BUF_THREAD_ID_SIZE) - 2;
2086 pack_threadlist_request (rs->buf, startflag, result_limit, nextthread);
2087 putpkt (rs->buf);
2088 getpkt (&rs->buf, &rs->buf_size, 0);
2090 if (*rs->buf == '\0')
2091 *result_count = 0;
2092 else
2093 *result_count =
2094 parse_threadlist_response (rs->buf + 2, result_limit, &echo_nextthread,
2095 threadlist, done);
2097 if (!threadmatch (&echo_nextthread, nextthread))
2099 /* FIXME: This is a good reason to drop the packet. */
2100 /* Possably, there is a duplicate response. */
2101 /* Possabilities :
2102 retransmit immediatly - race conditions
2103 retransmit after timeout - yes
2104 exit
2105 wait for packet, then exit
2107 warning (_("HMM: threadlist did not echo arg thread, dropping it."));
2108 return 0; /* I choose simply exiting. */
2110 if (*result_count <= 0)
2112 if (*done != 1)
2114 warning (_("RMT ERROR : failed to get remote thread list."));
2115 result = 0;
2117 return result; /* break; */
2119 if (*result_count > result_limit)
2121 *result_count = 0;
2122 warning (_("RMT ERROR: threadlist response longer than requested."));
2123 return 0;
2125 return result;
2128 /* This is the interface between remote and threads, remotes upper
2129 interface. */
2131 /* remote_find_new_threads retrieves the thread list and for each
2132 thread in the list, looks up the thread in GDB's internal list,
2133 adding the thread if it does not already exist. This involves
2134 getting partial thread lists from the remote target so, polling the
2135 quit_flag is required. */
2138 /* About this many threadisds fit in a packet. */
2140 #define MAXTHREADLISTRESULTS 32
2142 static int
2143 remote_threadlist_iterator (rmt_thread_action stepfunction, void *context,
2144 int looplimit)
2146 int done, i, result_count;
2147 int startflag = 1;
2148 int result = 1;
2149 int loopcount = 0;
2150 static threadref nextthread;
2151 static threadref resultthreadlist[MAXTHREADLISTRESULTS];
2153 done = 0;
2154 while (!done)
2156 if (loopcount++ > looplimit)
2158 result = 0;
2159 warning (_("Remote fetch threadlist -infinite loop-."));
2160 break;
2162 if (!remote_get_threadlist (startflag, &nextthread, MAXTHREADLISTRESULTS,
2163 &done, &result_count, resultthreadlist))
2165 result = 0;
2166 break;
2168 /* Clear for later iterations. */
2169 startflag = 0;
2170 /* Setup to resume next batch of thread references, set nextthread. */
2171 if (result_count >= 1)
2172 copy_threadref (&nextthread, &resultthreadlist[result_count - 1]);
2173 i = 0;
2174 while (result_count--)
2175 if (!(result = (*stepfunction) (&resultthreadlist[i++], context)))
2176 break;
2178 return result;
2181 static int
2182 remote_newthread_step (threadref *ref, void *context)
2184 int pid = ptid_get_pid (inferior_ptid);
2185 ptid_t ptid = ptid_build (pid, 0, threadref_to_int (ref));
2187 if (!in_thread_list (ptid))
2188 add_thread (ptid);
2189 return 1; /* continue iterator */
2192 #define CRAZY_MAX_THREADS 1000
2194 static ptid_t
2195 remote_current_thread (ptid_t oldpid)
2197 struct remote_state *rs = get_remote_state ();
2198 char *p = rs->buf;
2199 int tid;
2200 int pid;
2202 putpkt ("qC");
2203 getpkt (&rs->buf, &rs->buf_size, 0);
2204 if (rs->buf[0] == 'Q' && rs->buf[1] == 'C')
2205 return read_ptid (&rs->buf[2], NULL);
2206 else
2207 return oldpid;
2210 /* Find new threads for info threads command.
2211 * Original version, using John Metzler's thread protocol.
2214 static void
2215 remote_find_new_threads (void)
2217 remote_threadlist_iterator (remote_newthread_step, 0,
2218 CRAZY_MAX_THREADS);
2222 * Find all threads for info threads command.
2223 * Uses new thread protocol contributed by Cisco.
2224 * Falls back and attempts to use the older method (above)
2225 * if the target doesn't respond to the new method.
2228 static void
2229 remote_threads_info (struct target_ops *ops)
2231 struct remote_state *rs = get_remote_state ();
2232 char *bufp;
2233 ptid_t new_thread;
2235 if (remote_desc == 0) /* paranoia */
2236 error (_("Command can only be used when connected to the remote target."));
2238 if (use_threadinfo_query)
2240 putpkt ("qfThreadInfo");
2241 getpkt (&rs->buf, &rs->buf_size, 0);
2242 bufp = rs->buf;
2243 if (bufp[0] != '\0') /* q packet recognized */
2245 while (*bufp++ == 'm') /* reply contains one or more TID */
2249 new_thread = read_ptid (bufp, &bufp);
2250 if (!ptid_equal (new_thread, null_ptid))
2252 /* In non-stop mode, we assume new found threads
2253 are running until proven otherwise with a
2254 stop reply. In all-stop, we can only get
2255 here if all threads are stopped. */
2256 int running = non_stop ? 1 : 0;
2258 remote_notice_new_inferior (new_thread, running);
2261 while (*bufp++ == ','); /* comma-separated list */
2262 putpkt ("qsThreadInfo");
2263 getpkt (&rs->buf, &rs->buf_size, 0);
2264 bufp = rs->buf;
2266 return; /* done */
2270 /* Only qfThreadInfo is supported in non-stop mode. */
2271 if (non_stop)
2272 return;
2274 /* Else fall back to old method based on jmetzler protocol. */
2275 use_threadinfo_query = 0;
2276 remote_find_new_threads ();
2277 return;
2281 * Collect a descriptive string about the given thread.
2282 * The target may say anything it wants to about the thread
2283 * (typically info about its blocked / runnable state, name, etc.).
2284 * This string will appear in the info threads display.
2286 * Optional: targets are not required to implement this function.
2289 static char *
2290 remote_threads_extra_info (struct thread_info *tp)
2292 struct remote_state *rs = get_remote_state ();
2293 int result;
2294 int set;
2295 threadref id;
2296 struct gdb_ext_thread_info threadinfo;
2297 static char display_buf[100]; /* arbitrary... */
2298 int n = 0; /* position in display_buf */
2300 if (remote_desc == 0) /* paranoia */
2301 internal_error (__FILE__, __LINE__,
2302 _("remote_threads_extra_info"));
2304 if (ptid_equal (tp->ptid, magic_null_ptid)
2305 || (ptid_get_pid (tp->ptid) != 0 && ptid_get_tid (tp->ptid) == 0))
2306 /* This is the main thread which was added by GDB. The remote
2307 server doesn't know about it. */
2308 return NULL;
2310 if (use_threadextra_query)
2312 char *b = rs->buf;
2313 char *endb = rs->buf + get_remote_packet_size ();
2315 xsnprintf (b, endb - b, "qThreadExtraInfo,");
2316 b += strlen (b);
2317 write_ptid (b, endb, tp->ptid);
2319 putpkt (rs->buf);
2320 getpkt (&rs->buf, &rs->buf_size, 0);
2321 if (rs->buf[0] != 0)
2323 n = min (strlen (rs->buf) / 2, sizeof (display_buf));
2324 result = hex2bin (rs->buf, (gdb_byte *) display_buf, n);
2325 display_buf [result] = '\0';
2326 return display_buf;
2330 /* If the above query fails, fall back to the old method. */
2331 use_threadextra_query = 0;
2332 set = TAG_THREADID | TAG_EXISTS | TAG_THREADNAME
2333 | TAG_MOREDISPLAY | TAG_DISPLAY;
2334 int_to_threadref (&id, ptid_get_tid (tp->ptid));
2335 if (remote_get_threadinfo (&id, set, &threadinfo))
2336 if (threadinfo.active)
2338 if (*threadinfo.shortname)
2339 n += xsnprintf (&display_buf[0], sizeof (display_buf) - n,
2340 " Name: %s,", threadinfo.shortname);
2341 if (*threadinfo.display)
2342 n += xsnprintf (&display_buf[n], sizeof (display_buf) - n,
2343 " State: %s,", threadinfo.display);
2344 if (*threadinfo.more_display)
2345 n += xsnprintf (&display_buf[n], sizeof (display_buf) - n,
2346 " Priority: %s", threadinfo.more_display);
2348 if (n > 0)
2350 /* For purely cosmetic reasons, clear up trailing commas. */
2351 if (',' == display_buf[n-1])
2352 display_buf[n-1] = ' ';
2353 return display_buf;
2356 return NULL;
2360 /* Restart the remote side; this is an extended protocol operation. */
2362 static void
2363 extended_remote_restart (void)
2365 struct remote_state *rs = get_remote_state ();
2367 /* Send the restart command; for reasons I don't understand the
2368 remote side really expects a number after the "R". */
2369 xsnprintf (rs->buf, get_remote_packet_size (), "R%x", 0);
2370 putpkt (rs->buf);
2372 remote_fileio_reset ();
2375 /* Clean up connection to a remote debugger. */
2377 static void
2378 remote_close (int quitting)
2380 if (remote_desc == NULL)
2381 return; /* already closed */
2383 /* Make sure we leave stdin registered in the event loop, and we
2384 don't leave the async SIGINT signal handler installed. */
2385 remote_terminal_ours ();
2387 serial_close (remote_desc);
2388 remote_desc = NULL;
2390 /* We don't have a connection to the remote stub anymore. Get rid
2391 of all the inferiors and their threads we were controlling. */
2392 discard_all_inferiors ();
2394 /* We're no longer interested in any of these events. */
2395 discard_pending_stop_replies (-1);
2397 if (remote_async_inferior_event_token)
2398 delete_async_event_handler (&remote_async_inferior_event_token);
2399 if (remote_async_get_pending_events_token)
2400 delete_async_event_handler (&remote_async_get_pending_events_token);
2403 /* Query the remote side for the text, data and bss offsets. */
2405 static void
2406 get_offsets (void)
2408 struct remote_state *rs = get_remote_state ();
2409 char *buf;
2410 char *ptr;
2411 int lose, num_segments = 0, do_sections, do_segments;
2412 CORE_ADDR text_addr, data_addr, bss_addr, segments[2];
2413 struct section_offsets *offs;
2414 struct symfile_segment_data *data;
2416 if (symfile_objfile == NULL)
2417 return;
2419 putpkt ("qOffsets");
2420 getpkt (&rs->buf, &rs->buf_size, 0);
2421 buf = rs->buf;
2423 if (buf[0] == '\000')
2424 return; /* Return silently. Stub doesn't support
2425 this command. */
2426 if (buf[0] == 'E')
2428 warning (_("Remote failure reply: %s"), buf);
2429 return;
2432 /* Pick up each field in turn. This used to be done with scanf, but
2433 scanf will make trouble if CORE_ADDR size doesn't match
2434 conversion directives correctly. The following code will work
2435 with any size of CORE_ADDR. */
2436 text_addr = data_addr = bss_addr = 0;
2437 ptr = buf;
2438 lose = 0;
2440 if (strncmp (ptr, "Text=", 5) == 0)
2442 ptr += 5;
2443 /* Don't use strtol, could lose on big values. */
2444 while (*ptr && *ptr != ';')
2445 text_addr = (text_addr << 4) + fromhex (*ptr++);
2447 if (strncmp (ptr, ";Data=", 6) == 0)
2449 ptr += 6;
2450 while (*ptr && *ptr != ';')
2451 data_addr = (data_addr << 4) + fromhex (*ptr++);
2453 else
2454 lose = 1;
2456 if (!lose && strncmp (ptr, ";Bss=", 5) == 0)
2458 ptr += 5;
2459 while (*ptr && *ptr != ';')
2460 bss_addr = (bss_addr << 4) + fromhex (*ptr++);
2462 if (bss_addr != data_addr)
2463 warning (_("Target reported unsupported offsets: %s"), buf);
2465 else
2466 lose = 1;
2468 else if (strncmp (ptr, "TextSeg=", 8) == 0)
2470 ptr += 8;
2471 /* Don't use strtol, could lose on big values. */
2472 while (*ptr && *ptr != ';')
2473 text_addr = (text_addr << 4) + fromhex (*ptr++);
2474 num_segments = 1;
2476 if (strncmp (ptr, ";DataSeg=", 9) == 0)
2478 ptr += 9;
2479 while (*ptr && *ptr != ';')
2480 data_addr = (data_addr << 4) + fromhex (*ptr++);
2481 num_segments++;
2484 else
2485 lose = 1;
2487 if (lose)
2488 error (_("Malformed response to offset query, %s"), buf);
2489 else if (*ptr != '\0')
2490 warning (_("Target reported unsupported offsets: %s"), buf);
2492 offs = ((struct section_offsets *)
2493 alloca (SIZEOF_N_SECTION_OFFSETS (symfile_objfile->num_sections)));
2494 memcpy (offs, symfile_objfile->section_offsets,
2495 SIZEOF_N_SECTION_OFFSETS (symfile_objfile->num_sections));
2497 data = get_symfile_segment_data (symfile_objfile->obfd);
2498 do_segments = (data != NULL);
2499 do_sections = num_segments == 0;
2501 if (num_segments > 0)
2503 segments[0] = text_addr;
2504 segments[1] = data_addr;
2506 /* If we have two segments, we can still try to relocate everything
2507 by assuming that the .text and .data offsets apply to the whole
2508 text and data segments. Convert the offsets given in the packet
2509 to base addresses for symfile_map_offsets_to_segments. */
2510 else if (data && data->num_segments == 2)
2512 segments[0] = data->segment_bases[0] + text_addr;
2513 segments[1] = data->segment_bases[1] + data_addr;
2514 num_segments = 2;
2516 /* If the object file has only one segment, assume that it is text
2517 rather than data; main programs with no writable data are rare,
2518 but programs with no code are useless. Of course the code might
2519 have ended up in the data segment... to detect that we would need
2520 the permissions here. */
2521 else if (data && data->num_segments == 1)
2523 segments[0] = data->segment_bases[0] + text_addr;
2524 num_segments = 1;
2526 /* There's no way to relocate by segment. */
2527 else
2528 do_segments = 0;
2530 if (do_segments)
2532 int ret = symfile_map_offsets_to_segments (symfile_objfile->obfd, data,
2533 offs, num_segments, segments);
2535 if (ret == 0 && !do_sections)
2536 error (_("Can not handle qOffsets TextSeg response with this symbol file"));
2538 if (ret > 0)
2539 do_sections = 0;
2542 if (data)
2543 free_symfile_segment_data (data);
2545 if (do_sections)
2547 offs->offsets[SECT_OFF_TEXT (symfile_objfile)] = text_addr;
2549 /* This is a temporary kludge to force data and bss to use the same offsets
2550 because that's what nlmconv does now. The real solution requires changes
2551 to the stub and remote.c that I don't have time to do right now. */
2553 offs->offsets[SECT_OFF_DATA (symfile_objfile)] = data_addr;
2554 offs->offsets[SECT_OFF_BSS (symfile_objfile)] = data_addr;
2557 objfile_relocate (symfile_objfile, offs);
2560 /* Callback for iterate_over_threads. Set the STOP_REQUESTED flags in
2561 threads we know are stopped already. This is used during the
2562 initial remote connection in non-stop mode --- threads that are
2563 reported as already being stopped are left stopped. */
2565 static int
2566 set_stop_requested_callback (struct thread_info *thread, void *data)
2568 /* If we have a stop reply for this thread, it must be stopped. */
2569 if (peek_stop_reply (thread->ptid))
2570 set_stop_requested (thread->ptid, 1);
2572 return 0;
2575 /* Stub for catch_exception. */
2577 struct start_remote_args
2579 int from_tty;
2581 /* The current target. */
2582 struct target_ops *target;
2584 /* Non-zero if this is an extended-remote target. */
2585 int extended_p;
2588 static void
2589 remote_start_remote (struct ui_out *uiout, void *opaque)
2591 struct start_remote_args *args = opaque;
2592 struct remote_state *rs = get_remote_state ();
2593 struct packet_config *noack_config;
2594 char *wait_status = NULL;
2596 immediate_quit++; /* Allow user to interrupt it. */
2598 /* Ack any packet which the remote side has already sent. */
2599 serial_write (remote_desc, "+", 1);
2601 /* The first packet we send to the target is the optional "supported
2602 packets" request. If the target can answer this, it will tell us
2603 which later probes to skip. */
2604 remote_query_supported ();
2606 /* Next, we possibly activate noack mode.
2608 If the QStartNoAckMode packet configuration is set to AUTO,
2609 enable noack mode if the stub reported a wish for it with
2610 qSupported.
2612 If set to TRUE, then enable noack mode even if the stub didn't
2613 report it in qSupported. If the stub doesn't reply OK, the
2614 session ends with an error.
2616 If FALSE, then don't activate noack mode, regardless of what the
2617 stub claimed should be the default with qSupported. */
2619 noack_config = &remote_protocol_packets[PACKET_QStartNoAckMode];
2621 if (noack_config->detect == AUTO_BOOLEAN_TRUE
2622 || (noack_config->detect == AUTO_BOOLEAN_AUTO
2623 && noack_config->support == PACKET_ENABLE))
2625 putpkt ("QStartNoAckMode");
2626 getpkt (&rs->buf, &rs->buf_size, 0);
2627 if (packet_ok (rs->buf, noack_config) == PACKET_OK)
2628 rs->noack_mode = 1;
2631 if (args->extended_p)
2633 /* Tell the remote that we are using the extended protocol. */
2634 putpkt ("!");
2635 getpkt (&rs->buf, &rs->buf_size, 0);
2638 /* Next, if the target can specify a description, read it. We do
2639 this before anything involving memory or registers. */
2640 target_find_description ();
2642 /* On OSs where the list of libraries is global to all
2643 processes, we fetch them early. */
2644 if (gdbarch_has_global_solist (target_gdbarch))
2645 solib_add (NULL, args->from_tty, args->target, auto_solib_add);
2647 if (non_stop)
2649 if (!rs->non_stop_aware)
2650 error (_("Non-stop mode requested, but remote does not support non-stop"));
2652 putpkt ("QNonStop:1");
2653 getpkt (&rs->buf, &rs->buf_size, 0);
2655 if (strcmp (rs->buf, "OK") != 0)
2656 error ("Remote refused setting non-stop mode with: %s", rs->buf);
2658 /* Find about threads and processes the stub is already
2659 controlling. We default to adding them in the running state.
2660 The '?' query below will then tell us about which threads are
2661 stopped. */
2662 remote_threads_info (args->target);
2664 else if (rs->non_stop_aware)
2666 /* Don't assume that the stub can operate in all-stop mode.
2667 Request it explicitely. */
2668 putpkt ("QNonStop:0");
2669 getpkt (&rs->buf, &rs->buf_size, 0);
2671 if (strcmp (rs->buf, "OK") != 0)
2672 error ("Remote refused setting all-stop mode with: %s", rs->buf);
2675 /* Check whether the target is running now. */
2676 putpkt ("?");
2677 getpkt (&rs->buf, &rs->buf_size, 0);
2679 if (!non_stop)
2681 if (rs->buf[0] == 'W' || rs->buf[0] == 'X')
2683 if (args->extended_p)
2685 /* We're connected, but not running. Drop out before we
2686 call start_remote. */
2687 target_mark_exited (args->target);
2688 return;
2690 else
2691 error (_("The target is not running (try extended-remote?)"));
2693 else
2695 /* Save the reply for later. */
2696 wait_status = alloca (strlen (rs->buf) + 1);
2697 strcpy (wait_status, rs->buf);
2700 /* Let the stub know that we want it to return the thread. */
2701 set_continue_thread (minus_one_ptid);
2703 /* Without this, some commands which require an active target
2704 (such as kill) won't work. This variable serves (at least)
2705 double duty as both the pid of the target process (if it has
2706 such), and as a flag indicating that a target is active.
2707 These functions should be split out into seperate variables,
2708 especially since GDB will someday have a notion of debugging
2709 several processes. */
2710 inferior_ptid = magic_null_ptid;
2712 /* Now, if we have thread information, update inferior_ptid. */
2713 inferior_ptid = remote_current_thread (inferior_ptid);
2715 remote_add_inferior (ptid_get_pid (inferior_ptid), -1);
2717 /* Always add the main thread. */
2718 add_thread_silent (inferior_ptid);
2720 get_offsets (); /* Get text, data & bss offsets. */
2722 /* If we could not find a description using qXfer, and we know
2723 how to do it some other way, try again. This is not
2724 supported for non-stop; it could be, but it is tricky if
2725 there are no stopped threads when we connect. */
2726 if (remote_read_description_p (args->target)
2727 && gdbarch_target_desc (target_gdbarch) == NULL)
2729 target_clear_description ();
2730 target_find_description ();
2733 /* Use the previously fetched status. */
2734 gdb_assert (wait_status != NULL);
2735 strcpy (rs->buf, wait_status);
2736 rs->cached_wait_status = 1;
2738 immediate_quit--;
2739 start_remote (args->from_tty); /* Initialize gdb process mechanisms. */
2741 else
2743 /* In non-stop, we will either get an "OK", meaning that there
2744 are no stopped threads at this time; or, a regular stop
2745 reply. In the latter case, there may be more than one thread
2746 stopped --- we pull them all out using the vStopped
2747 mechanism. */
2748 if (strcmp (rs->buf, "OK") != 0)
2750 struct stop_reply *stop_reply;
2751 struct cleanup *old_chain;
2753 stop_reply = stop_reply_xmalloc ();
2754 old_chain = make_cleanup (do_stop_reply_xfree, stop_reply);
2756 remote_parse_stop_reply (rs->buf, stop_reply);
2757 discard_cleanups (old_chain);
2759 /* get_pending_stop_replies acks this one, and gets the rest
2760 out. */
2761 pending_stop_reply = stop_reply;
2762 remote_get_pending_stop_replies ();
2764 /* Make sure that threads that were stopped remain
2765 stopped. */
2766 iterate_over_threads (set_stop_requested_callback, NULL);
2769 if (target_can_async_p ())
2770 target_async (inferior_event_handler, 0);
2772 if (thread_count () == 0)
2774 if (args->extended_p)
2776 /* We're connected, but not running. Drop out before we
2777 call start_remote. */
2778 target_mark_exited (args->target);
2779 return;
2781 else
2782 error (_("The target is not running (try extended-remote?)"));
2785 if (args->extended_p)
2786 target_mark_running (args->target);
2788 /* Let the stub know that we want it to return the thread. */
2790 /* Force the stub to choose a thread. */
2791 set_general_thread (null_ptid);
2793 /* Query it. */
2794 inferior_ptid = remote_current_thread (minus_one_ptid);
2795 if (ptid_equal (inferior_ptid, minus_one_ptid))
2796 error (_("remote didn't report the current thread in non-stop mode"));
2798 get_offsets (); /* Get text, data & bss offsets. */
2800 /* In non-stop mode, any cached wait status will be stored in
2801 the stop reply queue. */
2802 gdb_assert (wait_status == NULL);
2804 init_wait_for_inferior ();
2807 /* If we connected to a live target, do some additional setup. */
2808 if (target_has_execution)
2810 if (exec_bfd) /* No use without an exec file. */
2811 remote_check_symbols (symfile_objfile);
2814 /* If code is shared between processes, then breakpoints are global
2815 too; Insert them now. */
2816 if (gdbarch_has_global_solist (target_gdbarch)
2817 && breakpoints_always_inserted_mode ())
2818 insert_breakpoints ();
2821 /* Open a connection to a remote debugger.
2822 NAME is the filename used for communication. */
2824 static void
2825 remote_open (char *name, int from_tty)
2827 remote_open_1 (name, from_tty, &remote_ops, 0);
2830 /* Open a connection to a remote debugger using the extended
2831 remote gdb protocol. NAME is the filename used for communication. */
2833 static void
2834 extended_remote_open (char *name, int from_tty)
2836 remote_open_1 (name, from_tty, &extended_remote_ops, 1 /*extended_p */);
2839 /* Generic code for opening a connection to a remote target. */
2841 static void
2842 init_all_packet_configs (void)
2844 int i;
2845 for (i = 0; i < PACKET_MAX; i++)
2846 update_packet_config (&remote_protocol_packets[i]);
2849 /* Symbol look-up. */
2851 static void
2852 remote_check_symbols (struct objfile *objfile)
2854 struct remote_state *rs = get_remote_state ();
2855 char *msg, *reply, *tmp;
2856 struct minimal_symbol *sym;
2857 int end;
2859 if (remote_protocol_packets[PACKET_qSymbol].support == PACKET_DISABLE)
2860 return;
2862 /* Make sure the remote is pointing at the right process. */
2863 set_general_process ();
2865 /* Allocate a message buffer. We can't reuse the input buffer in RS,
2866 because we need both at the same time. */
2867 msg = alloca (get_remote_packet_size ());
2869 /* Invite target to request symbol lookups. */
2871 putpkt ("qSymbol::");
2872 getpkt (&rs->buf, &rs->buf_size, 0);
2873 packet_ok (rs->buf, &remote_protocol_packets[PACKET_qSymbol]);
2874 reply = rs->buf;
2876 while (strncmp (reply, "qSymbol:", 8) == 0)
2878 tmp = &reply[8];
2879 end = hex2bin (tmp, (gdb_byte *) msg, strlen (tmp) / 2);
2880 msg[end] = '\0';
2881 sym = lookup_minimal_symbol (msg, NULL, NULL);
2882 if (sym == NULL)
2883 xsnprintf (msg, get_remote_packet_size (), "qSymbol::%s", &reply[8]);
2884 else
2886 CORE_ADDR sym_addr = SYMBOL_VALUE_ADDRESS (sym);
2888 /* If this is a function address, return the start of code
2889 instead of any data function descriptor. */
2890 sym_addr = gdbarch_convert_from_func_ptr_addr (target_gdbarch,
2891 sym_addr,
2892 &current_target);
2894 xsnprintf (msg, get_remote_packet_size (), "qSymbol:%s:%s",
2895 paddr_nz (sym_addr), &reply[8]);
2898 putpkt (msg);
2899 getpkt (&rs->buf, &rs->buf_size, 0);
2900 reply = rs->buf;
2904 static struct serial *
2905 remote_serial_open (char *name)
2907 static int udp_warning = 0;
2909 /* FIXME: Parsing NAME here is a hack. But we want to warn here instead
2910 of in ser-tcp.c, because it is the remote protocol assuming that the
2911 serial connection is reliable and not the serial connection promising
2912 to be. */
2913 if (!udp_warning && strncmp (name, "udp:", 4) == 0)
2915 warning (_("\
2916 The remote protocol may be unreliable over UDP.\n\
2917 Some events may be lost, rendering further debugging impossible."));
2918 udp_warning = 1;
2921 return serial_open (name);
2924 /* This type describes each known response to the qSupported
2925 packet. */
2926 struct protocol_feature
2928 /* The name of this protocol feature. */
2929 const char *name;
2931 /* The default for this protocol feature. */
2932 enum packet_support default_support;
2934 /* The function to call when this feature is reported, or after
2935 qSupported processing if the feature is not supported.
2936 The first argument points to this structure. The second
2937 argument indicates whether the packet requested support be
2938 enabled, disabled, or probed (or the default, if this function
2939 is being called at the end of processing and this feature was
2940 not reported). The third argument may be NULL; if not NULL, it
2941 is a NUL-terminated string taken from the packet following
2942 this feature's name and an equals sign. */
2943 void (*func) (const struct protocol_feature *, enum packet_support,
2944 const char *);
2946 /* The corresponding packet for this feature. Only used if
2947 FUNC is remote_supported_packet. */
2948 int packet;
2951 static void
2952 remote_supported_packet (const struct protocol_feature *feature,
2953 enum packet_support support,
2954 const char *argument)
2956 if (argument)
2958 warning (_("Remote qSupported response supplied an unexpected value for"
2959 " \"%s\"."), feature->name);
2960 return;
2963 if (remote_protocol_packets[feature->packet].support
2964 == PACKET_SUPPORT_UNKNOWN)
2965 remote_protocol_packets[feature->packet].support = support;
2968 static void
2969 remote_packet_size (const struct protocol_feature *feature,
2970 enum packet_support support, const char *value)
2972 struct remote_state *rs = get_remote_state ();
2974 int packet_size;
2975 char *value_end;
2977 if (support != PACKET_ENABLE)
2978 return;
2980 if (value == NULL || *value == '\0')
2982 warning (_("Remote target reported \"%s\" without a size."),
2983 feature->name);
2984 return;
2987 errno = 0;
2988 packet_size = strtol (value, &value_end, 16);
2989 if (errno != 0 || *value_end != '\0' || packet_size < 0)
2991 warning (_("Remote target reported \"%s\" with a bad size: \"%s\"."),
2992 feature->name, value);
2993 return;
2996 if (packet_size > MAX_REMOTE_PACKET_SIZE)
2998 warning (_("limiting remote suggested packet size (%d bytes) to %d"),
2999 packet_size, MAX_REMOTE_PACKET_SIZE);
3000 packet_size = MAX_REMOTE_PACKET_SIZE;
3003 /* Record the new maximum packet size. */
3004 rs->explicit_packet_size = packet_size;
3007 static void
3008 remote_multi_process_feature (const struct protocol_feature *feature,
3009 enum packet_support support, const char *value)
3011 struct remote_state *rs = get_remote_state ();
3012 rs->multi_process_aware = (support == PACKET_ENABLE);
3015 static void
3016 remote_non_stop_feature (const struct protocol_feature *feature,
3017 enum packet_support support, const char *value)
3019 struct remote_state *rs = get_remote_state ();
3020 rs->non_stop_aware = (support == PACKET_ENABLE);
3023 static struct protocol_feature remote_protocol_features[] = {
3024 { "PacketSize", PACKET_DISABLE, remote_packet_size, -1 },
3025 { "qXfer:auxv:read", PACKET_DISABLE, remote_supported_packet,
3026 PACKET_qXfer_auxv },
3027 { "qXfer:features:read", PACKET_DISABLE, remote_supported_packet,
3028 PACKET_qXfer_features },
3029 { "qXfer:libraries:read", PACKET_DISABLE, remote_supported_packet,
3030 PACKET_qXfer_libraries },
3031 { "qXfer:memory-map:read", PACKET_DISABLE, remote_supported_packet,
3032 PACKET_qXfer_memory_map },
3033 { "qXfer:spu:read", PACKET_DISABLE, remote_supported_packet,
3034 PACKET_qXfer_spu_read },
3035 { "qXfer:spu:write", PACKET_DISABLE, remote_supported_packet,
3036 PACKET_qXfer_spu_write },
3037 { "qXfer:osdata:read", PACKET_DISABLE, remote_supported_packet,
3038 PACKET_qXfer_osdata },
3039 { "QPassSignals", PACKET_DISABLE, remote_supported_packet,
3040 PACKET_QPassSignals },
3041 { "QStartNoAckMode", PACKET_DISABLE, remote_supported_packet,
3042 PACKET_QStartNoAckMode },
3043 { "multiprocess", PACKET_DISABLE, remote_multi_process_feature, -1 },
3044 { "QNonStop", PACKET_DISABLE, remote_non_stop_feature, -1 },
3045 { "qXfer:siginfo:read", PACKET_DISABLE, remote_supported_packet,
3046 PACKET_qXfer_siginfo_read },
3047 { "qXfer:siginfo:write", PACKET_DISABLE, remote_supported_packet,
3048 PACKET_qXfer_siginfo_write },
3051 static void
3052 remote_query_supported (void)
3054 struct remote_state *rs = get_remote_state ();
3055 char *next;
3056 int i;
3057 unsigned char seen [ARRAY_SIZE (remote_protocol_features)];
3059 /* The packet support flags are handled differently for this packet
3060 than for most others. We treat an error, a disabled packet, and
3061 an empty response identically: any features which must be reported
3062 to be used will be automatically disabled. An empty buffer
3063 accomplishes this, since that is also the representation for a list
3064 containing no features. */
3066 rs->buf[0] = 0;
3067 if (remote_protocol_packets[PACKET_qSupported].support != PACKET_DISABLE)
3069 if (rs->extended)
3070 putpkt ("qSupported:multiprocess+");
3071 else
3072 putpkt ("qSupported");
3074 getpkt (&rs->buf, &rs->buf_size, 0);
3076 /* If an error occured, warn, but do not return - just reset the
3077 buffer to empty and go on to disable features. */
3078 if (packet_ok (rs->buf, &remote_protocol_packets[PACKET_qSupported])
3079 == PACKET_ERROR)
3081 warning (_("Remote failure reply: %s"), rs->buf);
3082 rs->buf[0] = 0;
3086 memset (seen, 0, sizeof (seen));
3088 next = rs->buf;
3089 while (*next)
3091 enum packet_support is_supported;
3092 char *p, *end, *name_end, *value;
3094 /* First separate out this item from the rest of the packet. If
3095 there's another item after this, we overwrite the separator
3096 (terminated strings are much easier to work with). */
3097 p = next;
3098 end = strchr (p, ';');
3099 if (end == NULL)
3101 end = p + strlen (p);
3102 next = end;
3104 else
3106 *end = '\0';
3107 next = end + 1;
3109 if (end == p)
3111 warning (_("empty item in \"qSupported\" response"));
3112 continue;
3116 name_end = strchr (p, '=');
3117 if (name_end)
3119 /* This is a name=value entry. */
3120 is_supported = PACKET_ENABLE;
3121 value = name_end + 1;
3122 *name_end = '\0';
3124 else
3126 value = NULL;
3127 switch (end[-1])
3129 case '+':
3130 is_supported = PACKET_ENABLE;
3131 break;
3133 case '-':
3134 is_supported = PACKET_DISABLE;
3135 break;
3137 case '?':
3138 is_supported = PACKET_SUPPORT_UNKNOWN;
3139 break;
3141 default:
3142 warning (_("unrecognized item \"%s\" in \"qSupported\" response"), p);
3143 continue;
3145 end[-1] = '\0';
3148 for (i = 0; i < ARRAY_SIZE (remote_protocol_features); i++)
3149 if (strcmp (remote_protocol_features[i].name, p) == 0)
3151 const struct protocol_feature *feature;
3153 seen[i] = 1;
3154 feature = &remote_protocol_features[i];
3155 feature->func (feature, is_supported, value);
3156 break;
3160 /* If we increased the packet size, make sure to increase the global
3161 buffer size also. We delay this until after parsing the entire
3162 qSupported packet, because this is the same buffer we were
3163 parsing. */
3164 if (rs->buf_size < rs->explicit_packet_size)
3166 rs->buf_size = rs->explicit_packet_size;
3167 rs->buf = xrealloc (rs->buf, rs->buf_size);
3170 /* Handle the defaults for unmentioned features. */
3171 for (i = 0; i < ARRAY_SIZE (remote_protocol_features); i++)
3172 if (!seen[i])
3174 const struct protocol_feature *feature;
3176 feature = &remote_protocol_features[i];
3177 feature->func (feature, feature->default_support, NULL);
3182 static void
3183 remote_open_1 (char *name, int from_tty, struct target_ops *target, int extended_p)
3185 struct remote_state *rs = get_remote_state ();
3187 if (name == 0)
3188 error (_("To open a remote debug connection, you need to specify what\n"
3189 "serial device is attached to the remote system\n"
3190 "(e.g. /dev/ttyS0, /dev/ttya, COM1, etc.)."));
3192 /* See FIXME above. */
3193 if (!target_async_permitted)
3194 wait_forever_enabled_p = 1;
3196 /* If we're connected to a running target, target_preopen will kill it.
3197 But if we're connected to a target system with no running process,
3198 then we will still be connected when it returns. Ask this question
3199 first, before target_preopen has a chance to kill anything. */
3200 if (remote_desc != NULL && !target_has_execution)
3202 if (!from_tty
3203 || query (_("Already connected to a remote target. Disconnect? ")))
3204 pop_target ();
3205 else
3206 error (_("Still connected."));
3209 target_preopen (from_tty);
3211 unpush_target (target);
3213 /* This time without a query. If we were connected to an
3214 extended-remote target and target_preopen killed the running
3215 process, we may still be connected. If we are starting "target
3216 remote" now, the extended-remote target will not have been
3217 removed by unpush_target. */
3218 if (remote_desc != NULL && !target_has_execution)
3219 pop_target ();
3221 /* Make sure we send the passed signals list the next time we resume. */
3222 xfree (last_pass_packet);
3223 last_pass_packet = NULL;
3225 remote_fileio_reset ();
3226 reopen_exec_file ();
3227 reread_symbols ();
3229 remote_desc = remote_serial_open (name);
3230 if (!remote_desc)
3231 perror_with_name (name);
3233 if (baud_rate != -1)
3235 if (serial_setbaudrate (remote_desc, baud_rate))
3237 /* The requested speed could not be set. Error out to
3238 top level after closing remote_desc. Take care to
3239 set remote_desc to NULL to avoid closing remote_desc
3240 more than once. */
3241 serial_close (remote_desc);
3242 remote_desc = NULL;
3243 perror_with_name (name);
3247 serial_raw (remote_desc);
3249 /* If there is something sitting in the buffer we might take it as a
3250 response to a command, which would be bad. */
3251 serial_flush_input (remote_desc);
3253 if (from_tty)
3255 puts_filtered ("Remote debugging using ");
3256 puts_filtered (name);
3257 puts_filtered ("\n");
3259 push_target (target); /* Switch to using remote target now. */
3261 /* Assume that the target is not running, until we learn otherwise. */
3262 if (extended_p)
3263 target_mark_exited (target);
3265 /* Register extra event sources in the event loop. */
3266 remote_async_inferior_event_token
3267 = create_async_event_handler (remote_async_inferior_event_handler,
3268 NULL);
3269 remote_async_get_pending_events_token
3270 = create_async_event_handler (remote_async_get_pending_events_handler,
3271 NULL);
3273 /* Reset the target state; these things will be queried either by
3274 remote_query_supported or as they are needed. */
3275 init_all_packet_configs ();
3276 rs->cached_wait_status = 0;
3277 rs->explicit_packet_size = 0;
3278 rs->noack_mode = 0;
3279 rs->multi_process_aware = 0;
3280 rs->extended = extended_p;
3281 rs->non_stop_aware = 0;
3282 rs->waiting_for_stop_reply = 0;
3284 general_thread = not_sent_ptid;
3285 continue_thread = not_sent_ptid;
3287 /* Probe for ability to use "ThreadInfo" query, as required. */
3288 use_threadinfo_query = 1;
3289 use_threadextra_query = 1;
3291 if (target_async_permitted)
3293 /* With this target we start out by owning the terminal. */
3294 remote_async_terminal_ours_p = 1;
3296 /* FIXME: cagney/1999-09-23: During the initial connection it is
3297 assumed that the target is already ready and able to respond to
3298 requests. Unfortunately remote_start_remote() eventually calls
3299 wait_for_inferior() with no timeout. wait_forever_enabled_p gets
3300 around this. Eventually a mechanism that allows
3301 wait_for_inferior() to expect/get timeouts will be
3302 implemented. */
3303 wait_forever_enabled_p = 0;
3306 /* First delete any symbols previously loaded from shared libraries. */
3307 no_shared_libraries (NULL, 0);
3309 /* Start afresh. */
3310 init_thread_list ();
3312 /* Start the remote connection. If error() or QUIT, discard this
3313 target (we'd otherwise be in an inconsistent state) and then
3314 propogate the error on up the exception chain. This ensures that
3315 the caller doesn't stumble along blindly assuming that the
3316 function succeeded. The CLI doesn't have this problem but other
3317 UI's, such as MI do.
3319 FIXME: cagney/2002-05-19: Instead of re-throwing the exception,
3320 this function should return an error indication letting the
3321 caller restore the previous state. Unfortunately the command
3322 ``target remote'' is directly wired to this function making that
3323 impossible. On a positive note, the CLI side of this problem has
3324 been fixed - the function set_cmd_context() makes it possible for
3325 all the ``target ....'' commands to share a common callback
3326 function. See cli-dump.c. */
3328 struct gdb_exception ex;
3329 struct start_remote_args args;
3331 args.from_tty = from_tty;
3332 args.target = target;
3333 args.extended_p = extended_p;
3335 ex = catch_exception (uiout, remote_start_remote, &args, RETURN_MASK_ALL);
3336 if (ex.reason < 0)
3338 /* Pop the partially set up target - unless something else did
3339 already before throwing the exception. */
3340 if (remote_desc != NULL)
3341 pop_target ();
3342 if (target_async_permitted)
3343 wait_forever_enabled_p = 1;
3344 throw_exception (ex);
3348 if (target_async_permitted)
3349 wait_forever_enabled_p = 1;
3352 /* This takes a program previously attached to and detaches it. After
3353 this is done, GDB can be used to debug some other program. We
3354 better not have left any breakpoints in the target program or it'll
3355 die when it hits one. */
3357 static void
3358 remote_detach_1 (char *args, int from_tty, int extended)
3360 int pid = ptid_get_pid (inferior_ptid);
3361 struct remote_state *rs = get_remote_state ();
3363 if (args)
3364 error (_("Argument given to \"detach\" when remotely debugging."));
3366 if (!target_has_execution)
3367 error (_("No process to detach from."));
3369 /* Tell the remote target to detach. */
3370 if (remote_multi_process_p (rs))
3371 sprintf (rs->buf, "D;%x", pid);
3372 else
3373 strcpy (rs->buf, "D");
3375 putpkt (rs->buf);
3376 getpkt (&rs->buf, &rs->buf_size, 0);
3378 if (rs->buf[0] == 'O' && rs->buf[1] == 'K')
3380 else if (rs->buf[0] == '\0')
3381 error (_("Remote doesn't know how to detach"));
3382 else
3383 error (_("Can't detach process."));
3385 if (from_tty)
3387 if (remote_multi_process_p (rs))
3388 printf_filtered (_("Detached from remote %s.\n"),
3389 target_pid_to_str (pid_to_ptid (pid)));
3390 else
3392 if (extended)
3393 puts_filtered (_("Detached from remote process.\n"));
3394 else
3395 puts_filtered (_("Ending remote debugging.\n"));
3399 discard_pending_stop_replies (pid);
3400 target_mourn_inferior ();
3403 static void
3404 remote_detach (struct target_ops *ops, char *args, int from_tty)
3406 remote_detach_1 (args, from_tty, 0);
3409 static void
3410 extended_remote_detach (struct target_ops *ops, char *args, int from_tty)
3412 remote_detach_1 (args, from_tty, 1);
3415 /* Same as remote_detach, but don't send the "D" packet; just disconnect. */
3417 static void
3418 remote_disconnect (struct target_ops *target, char *args, int from_tty)
3420 if (args)
3421 error (_("Argument given to \"disconnect\" when remotely debugging."));
3423 /* Make sure we unpush even the extended remote targets; mourn
3424 won't do it. So call remote_mourn_1 directly instead of
3425 target_mourn_inferior. */
3426 remote_mourn_1 (target);
3428 if (from_tty)
3429 puts_filtered ("Ending remote debugging.\n");
3432 /* Attach to the process specified by ARGS. If FROM_TTY is non-zero,
3433 be chatty about it. */
3435 static void
3436 extended_remote_attach_1 (struct target_ops *target, char *args, int from_tty)
3438 struct remote_state *rs = get_remote_state ();
3439 int pid;
3440 char *dummy;
3441 char *wait_status = NULL;
3443 if (!args)
3444 error_no_arg (_("process-id to attach"));
3446 dummy = args;
3447 pid = strtol (args, &dummy, 0);
3448 /* Some targets don't set errno on errors, grrr! */
3449 if (pid == 0 && args == dummy)
3450 error (_("Illegal process-id: %s."), args);
3452 if (remote_protocol_packets[PACKET_vAttach].support == PACKET_DISABLE)
3453 error (_("This target does not support attaching to a process"));
3455 sprintf (rs->buf, "vAttach;%x", pid);
3456 putpkt (rs->buf);
3457 getpkt (&rs->buf, &rs->buf_size, 0);
3459 if (packet_ok (rs->buf, &remote_protocol_packets[PACKET_vAttach]) == PACKET_OK)
3461 if (from_tty)
3462 printf_unfiltered (_("Attached to %s\n"),
3463 target_pid_to_str (pid_to_ptid (pid)));
3465 if (!non_stop)
3467 /* Save the reply for later. */
3468 wait_status = alloca (strlen (rs->buf) + 1);
3469 strcpy (wait_status, rs->buf);
3471 else if (strcmp (rs->buf, "OK") != 0)
3472 error (_("Attaching to %s failed with: %s"),
3473 target_pid_to_str (pid_to_ptid (pid)),
3474 rs->buf);
3476 else if (remote_protocol_packets[PACKET_vAttach].support == PACKET_DISABLE)
3477 error (_("This target does not support attaching to a process"));
3478 else
3479 error (_("Attaching to %s failed"),
3480 target_pid_to_str (pid_to_ptid (pid)));
3482 inferior_ptid = pid_to_ptid (pid);
3484 /* Now, if we have thread information, update inferior_ptid. */
3485 inferior_ptid = remote_current_thread (inferior_ptid);
3487 remote_add_inferior (pid, 1);
3489 if (non_stop)
3490 /* Get list of threads. */
3491 remote_threads_info (target);
3492 else
3493 /* Add the main thread to the thread list. */
3494 add_thread_silent (inferior_ptid);
3496 /* Next, if the target can specify a description, read it. We do
3497 this before anything involving memory or registers. */
3498 target_find_description ();
3500 if (!non_stop)
3502 /* Use the previously fetched status. */
3503 gdb_assert (wait_status != NULL);
3505 if (target_can_async_p ())
3507 struct stop_reply *stop_reply;
3508 struct cleanup *old_chain;
3510 stop_reply = stop_reply_xmalloc ();
3511 old_chain = make_cleanup (do_stop_reply_xfree, stop_reply);
3512 remote_parse_stop_reply (wait_status, stop_reply);
3513 discard_cleanups (old_chain);
3514 push_stop_reply (stop_reply);
3516 target_async (inferior_event_handler, 0);
3518 else
3520 gdb_assert (wait_status != NULL);
3521 strcpy (rs->buf, wait_status);
3522 rs->cached_wait_status = 1;
3525 else
3526 gdb_assert (wait_status == NULL);
3529 static void
3530 extended_remote_attach (struct target_ops *ops, char *args, int from_tty)
3532 extended_remote_attach_1 (ops, args, from_tty);
3535 /* Convert hex digit A to a number. */
3537 static int
3538 fromhex (int a)
3540 if (a >= '0' && a <= '9')
3541 return a - '0';
3542 else if (a >= 'a' && a <= 'f')
3543 return a - 'a' + 10;
3544 else if (a >= 'A' && a <= 'F')
3545 return a - 'A' + 10;
3546 else
3547 error (_("Reply contains invalid hex digit %d"), a);
3550 static int
3551 hex2bin (const char *hex, gdb_byte *bin, int count)
3553 int i;
3555 for (i = 0; i < count; i++)
3557 if (hex[0] == 0 || hex[1] == 0)
3559 /* Hex string is short, or of uneven length.
3560 Return the count that has been converted so far. */
3561 return i;
3563 *bin++ = fromhex (hex[0]) * 16 + fromhex (hex[1]);
3564 hex += 2;
3566 return i;
3569 /* Convert number NIB to a hex digit. */
3571 static int
3572 tohex (int nib)
3574 if (nib < 10)
3575 return '0' + nib;
3576 else
3577 return 'a' + nib - 10;
3580 static int
3581 bin2hex (const gdb_byte *bin, char *hex, int count)
3583 int i;
3584 /* May use a length, or a nul-terminated string as input. */
3585 if (count == 0)
3586 count = strlen ((char *) bin);
3588 for (i = 0; i < count; i++)
3590 *hex++ = tohex ((*bin >> 4) & 0xf);
3591 *hex++ = tohex (*bin++ & 0xf);
3593 *hex = 0;
3594 return i;
3597 /* Check for the availability of vCont. This function should also check
3598 the response. */
3600 static void
3601 remote_vcont_probe (struct remote_state *rs)
3603 char *buf;
3605 strcpy (rs->buf, "vCont?");
3606 putpkt (rs->buf);
3607 getpkt (&rs->buf, &rs->buf_size, 0);
3608 buf = rs->buf;
3610 /* Make sure that the features we assume are supported. */
3611 if (strncmp (buf, "vCont", 5) == 0)
3613 char *p = &buf[5];
3614 int support_s, support_S, support_c, support_C;
3616 support_s = 0;
3617 support_S = 0;
3618 support_c = 0;
3619 support_C = 0;
3620 rs->support_vCont_t = 0;
3621 while (p && *p == ';')
3623 p++;
3624 if (*p == 's' && (*(p + 1) == ';' || *(p + 1) == 0))
3625 support_s = 1;
3626 else if (*p == 'S' && (*(p + 1) == ';' || *(p + 1) == 0))
3627 support_S = 1;
3628 else if (*p == 'c' && (*(p + 1) == ';' || *(p + 1) == 0))
3629 support_c = 1;
3630 else if (*p == 'C' && (*(p + 1) == ';' || *(p + 1) == 0))
3631 support_C = 1;
3632 else if (*p == 't' && (*(p + 1) == ';' || *(p + 1) == 0))
3633 rs->support_vCont_t = 1;
3635 p = strchr (p, ';');
3638 /* If s, S, c, and C are not all supported, we can't use vCont. Clearing
3639 BUF will make packet_ok disable the packet. */
3640 if (!support_s || !support_S || !support_c || !support_C)
3641 buf[0] = 0;
3644 packet_ok (buf, &remote_protocol_packets[PACKET_vCont]);
3647 /* Resume the remote inferior by using a "vCont" packet. The thread
3648 to be resumed is PTID; STEP and SIGGNAL indicate whether the
3649 resumed thread should be single-stepped and/or signalled. If PTID
3650 equals minus_one_ptid, then all threads are resumed; the thread to
3651 be stepped and/or signalled is given in the global INFERIOR_PTID.
3652 This function returns non-zero iff it resumes the inferior.
3654 This function issues a strict subset of all possible vCont commands at the
3655 moment. */
3657 static int
3658 remote_vcont_resume (ptid_t ptid, int step, enum target_signal siggnal)
3660 struct remote_state *rs = get_remote_state ();
3661 char *p;
3662 char *endp;
3664 if (remote_protocol_packets[PACKET_vCont].support == PACKET_SUPPORT_UNKNOWN)
3665 remote_vcont_probe (rs);
3667 if (remote_protocol_packets[PACKET_vCont].support == PACKET_DISABLE)
3668 return 0;
3670 p = rs->buf;
3671 endp = rs->buf + get_remote_packet_size ();
3673 /* If we could generate a wider range of packets, we'd have to worry
3674 about overflowing BUF. Should there be a generic
3675 "multi-part-packet" packet? */
3677 if (ptid_equal (ptid, magic_null_ptid))
3679 /* MAGIC_NULL_PTID means that we don't have any active threads,
3680 so we don't have any TID numbers the inferior will
3681 understand. Make sure to only send forms that do not specify
3682 a TID. */
3683 if (step && siggnal != TARGET_SIGNAL_0)
3684 xsnprintf (p, endp - p, "vCont;S%02x", siggnal);
3685 else if (step)
3686 xsnprintf (p, endp - p, "vCont;s");
3687 else if (siggnal != TARGET_SIGNAL_0)
3688 xsnprintf (p, endp - p, "vCont;C%02x", siggnal);
3689 else
3690 xsnprintf (p, endp - p, "vCont;c");
3692 else if (ptid_equal (ptid, minus_one_ptid))
3694 /* Resume all threads, with preference for INFERIOR_PTID. */
3695 if (step && siggnal != TARGET_SIGNAL_0)
3697 /* Step inferior_ptid with signal. */
3698 p += xsnprintf (p, endp - p, "vCont;S%02x:", siggnal);
3699 p = write_ptid (p, endp, inferior_ptid);
3700 /* And continue others. */
3701 p += xsnprintf (p, endp - p, ";c");
3703 else if (step)
3705 /* Step inferior_ptid. */
3706 p += xsnprintf (p, endp - p, "vCont;s:");
3707 p = write_ptid (p, endp, inferior_ptid);
3708 /* And continue others. */
3709 p += xsnprintf (p, endp - p, ";c");
3711 else if (siggnal != TARGET_SIGNAL_0)
3713 /* Continue inferior_ptid with signal. */
3714 p += xsnprintf (p, endp - p, "vCont;C%02x:", siggnal);
3715 p = write_ptid (p, endp, inferior_ptid);
3716 /* And continue others. */
3717 p += xsnprintf (p, endp - p, ";c");
3719 else
3720 xsnprintf (p, endp - p, "vCont;c");
3722 else
3724 /* Scheduler locking; resume only PTID. */
3725 if (step && siggnal != TARGET_SIGNAL_0)
3727 /* Step ptid with signal. */
3728 p += xsnprintf (p, endp - p, "vCont;S%02x:", siggnal);
3729 p = write_ptid (p, endp, ptid);
3731 else if (step)
3733 /* Step ptid. */
3734 p += xsnprintf (p, endp - p, "vCont;s:");
3735 p = write_ptid (p, endp, ptid);
3737 else if (siggnal != TARGET_SIGNAL_0)
3739 /* Continue ptid with signal. */
3740 p += xsnprintf (p, endp - p, "vCont;C%02x:", siggnal);
3741 p = write_ptid (p, endp, ptid);
3743 else
3745 /* Continue ptid. */
3746 p += xsnprintf (p, endp - p, "vCont;c:");
3747 p = write_ptid (p, endp, ptid);
3751 gdb_assert (strlen (rs->buf) < get_remote_packet_size ());
3752 putpkt (rs->buf);
3754 if (non_stop)
3756 /* In non-stop, the stub replies to vCont with "OK". The stop
3757 reply will be reported asynchronously by means of a `%Stop'
3758 notification. */
3759 getpkt (&rs->buf, &rs->buf_size, 0);
3760 if (strcmp (rs->buf, "OK") != 0)
3761 error (_("Unexpected vCont reply in non-stop mode: %s"), rs->buf);
3764 return 1;
3767 /* Tell the remote machine to resume. */
3769 static enum target_signal last_sent_signal = TARGET_SIGNAL_0;
3771 static int last_sent_step;
3773 static void
3774 remote_resume (struct target_ops *ops,
3775 ptid_t ptid, int step, enum target_signal siggnal)
3777 struct remote_state *rs = get_remote_state ();
3778 char *buf;
3780 last_sent_signal = siggnal;
3781 last_sent_step = step;
3783 /* Update the inferior on signals to silently pass, if they've changed. */
3784 remote_pass_signals ();
3786 /* The vCont packet doesn't need to specify threads via Hc. */
3787 if (remote_vcont_resume (ptid, step, siggnal))
3788 goto done;
3790 /* All other supported resume packets do use Hc, so set the continue
3791 thread. */
3792 if (ptid_equal (ptid, minus_one_ptid))
3793 set_continue_thread (any_thread_ptid);
3794 else
3795 set_continue_thread (ptid);
3797 buf = rs->buf;
3798 if (execution_direction == EXEC_REVERSE)
3800 /* We don't pass signals to the target in reverse exec mode. */
3801 if (info_verbose && siggnal != TARGET_SIGNAL_0)
3802 warning (" - Can't pass signal %d to target in reverse: ignored.\n",
3803 siggnal);
3804 strcpy (buf, step ? "bs" : "bc");
3806 else if (siggnal != TARGET_SIGNAL_0)
3808 buf[0] = step ? 'S' : 'C';
3809 buf[1] = tohex (((int) siggnal >> 4) & 0xf);
3810 buf[2] = tohex (((int) siggnal) & 0xf);
3811 buf[3] = '\0';
3813 else
3814 strcpy (buf, step ? "s" : "c");
3816 putpkt (buf);
3818 done:
3819 /* We are about to start executing the inferior, let's register it
3820 with the event loop. NOTE: this is the one place where all the
3821 execution commands end up. We could alternatively do this in each
3822 of the execution commands in infcmd.c. */
3823 /* FIXME: ezannoni 1999-09-28: We may need to move this out of here
3824 into infcmd.c in order to allow inferior function calls to work
3825 NOT asynchronously. */
3826 if (target_can_async_p ())
3827 target_async (inferior_event_handler, 0);
3829 /* We've just told the target to resume. The remote server will
3830 wait for the inferior to stop, and then send a stop reply. In
3831 the mean time, we can't start another command/query ourselves
3832 because the stub wouldn't be ready to process it. This applies
3833 only to the base all-stop protocol, however. In non-stop (which
3834 only supports vCont), the stub replies with an "OK", and is
3835 immediate able to process further serial input. */
3836 if (!non_stop)
3837 rs->waiting_for_stop_reply = 1;
3841 /* Set up the signal handler for SIGINT, while the target is
3842 executing, ovewriting the 'regular' SIGINT signal handler. */
3843 static void
3844 initialize_sigint_signal_handler (void)
3846 signal (SIGINT, handle_remote_sigint);
3849 /* Signal handler for SIGINT, while the target is executing. */
3850 static void
3851 handle_remote_sigint (int sig)
3853 signal (sig, handle_remote_sigint_twice);
3854 mark_async_signal_handler_wrapper (sigint_remote_token);
3857 /* Signal handler for SIGINT, installed after SIGINT has already been
3858 sent once. It will take effect the second time that the user sends
3859 a ^C. */
3860 static void
3861 handle_remote_sigint_twice (int sig)
3863 signal (sig, handle_remote_sigint);
3864 mark_async_signal_handler_wrapper (sigint_remote_twice_token);
3867 /* Perform the real interruption of the target execution, in response
3868 to a ^C. */
3869 static void
3870 async_remote_interrupt (gdb_client_data arg)
3872 if (remote_debug)
3873 fprintf_unfiltered (gdb_stdlog, "remote_interrupt called\n");
3875 target_stop (inferior_ptid);
3878 /* Perform interrupt, if the first attempt did not succeed. Just give
3879 up on the target alltogether. */
3880 void
3881 async_remote_interrupt_twice (gdb_client_data arg)
3883 if (remote_debug)
3884 fprintf_unfiltered (gdb_stdlog, "remote_interrupt_twice called\n");
3886 interrupt_query ();
3889 /* Reinstall the usual SIGINT handlers, after the target has
3890 stopped. */
3891 static void
3892 cleanup_sigint_signal_handler (void *dummy)
3894 signal (SIGINT, handle_sigint);
3897 /* Send ^C to target to halt it. Target will respond, and send us a
3898 packet. */
3899 static void (*ofunc) (int);
3901 /* The command line interface's stop routine. This function is installed
3902 as a signal handler for SIGINT. The first time a user requests a
3903 stop, we call remote_stop to send a break or ^C. If there is no
3904 response from the target (it didn't stop when the user requested it),
3905 we ask the user if he'd like to detach from the target. */
3906 static void
3907 remote_interrupt (int signo)
3909 /* If this doesn't work, try more severe steps. */
3910 signal (signo, remote_interrupt_twice);
3912 gdb_call_async_signal_handler (sigint_remote_token, 1);
3915 /* The user typed ^C twice. */
3917 static void
3918 remote_interrupt_twice (int signo)
3920 signal (signo, ofunc);
3921 gdb_call_async_signal_handler (sigint_remote_twice_token, 1);
3922 signal (signo, remote_interrupt);
3925 /* Non-stop version of target_stop. Uses `vCont;t' to stop a remote
3926 thread, all threads of a remote process, or all threads of all
3927 processes. */
3929 static void
3930 remote_stop_ns (ptid_t ptid)
3932 struct remote_state *rs = get_remote_state ();
3933 char *p = rs->buf;
3934 char *endp = rs->buf + get_remote_packet_size ();
3935 struct stop_reply *reply, *next;
3937 if (remote_protocol_packets[PACKET_vCont].support == PACKET_SUPPORT_UNKNOWN)
3938 remote_vcont_probe (rs);
3940 if (!rs->support_vCont_t)
3941 error (_("Remote server does not support stopping threads"));
3943 if (ptid_equal (ptid, minus_one_ptid))
3944 p += xsnprintf (p, endp - p, "vCont;t");
3945 else
3947 ptid_t nptid;
3949 /* Step inferior_ptid. */
3950 p += xsnprintf (p, endp - p, "vCont;t:");
3952 if (ptid_is_pid (ptid))
3953 /* All (-1) threads of process. */
3954 nptid = ptid_build (ptid_get_pid (ptid), 0, -1);
3955 else
3957 /* Small optimization: if we already have a stop reply for
3958 this thread, no use in telling the stub we want this
3959 stopped. */
3960 if (peek_stop_reply (ptid))
3961 return;
3963 nptid = ptid;
3966 p = write_ptid (p, endp, nptid);
3969 /* In non-stop, we get an immediate OK reply. The stop reply will
3970 come in asynchronously by notification. */
3971 putpkt (rs->buf);
3972 getpkt (&rs->buf, &rs->buf_size, 0);
3973 if (strcmp (rs->buf, "OK") != 0)
3974 error (_("Stopping %s failed: %s"), target_pid_to_str (ptid), rs->buf);
3977 /* All-stop version of target_stop. Sends a break or a ^C to stop the
3978 remote target. It is undefined which thread of which process
3979 reports the stop. */
3981 static void
3982 remote_stop_as (ptid_t ptid)
3984 struct remote_state *rs = get_remote_state ();
3986 /* If the inferior is stopped already, but the core didn't know
3987 about it yet, just ignore the request. The cached wait status
3988 will be collected in remote_wait. */
3989 if (rs->cached_wait_status)
3990 return;
3992 /* Send a break or a ^C, depending on user preference. */
3994 if (remote_break)
3995 serial_send_break (remote_desc);
3996 else
3997 serial_write (remote_desc, "\003", 1);
4000 /* This is the generic stop called via the target vector. When a target
4001 interrupt is requested, either by the command line or the GUI, we
4002 will eventually end up here. */
4004 static void
4005 remote_stop (ptid_t ptid)
4007 if (remote_debug)
4008 fprintf_unfiltered (gdb_stdlog, "remote_stop called\n");
4010 if (non_stop)
4011 remote_stop_ns (ptid);
4012 else
4013 remote_stop_as (ptid);
4016 /* Ask the user what to do when an interrupt is received. */
4018 static void
4019 interrupt_query (void)
4021 target_terminal_ours ();
4023 if (target_can_async_p ())
4025 signal (SIGINT, handle_sigint);
4026 deprecated_throw_reason (RETURN_QUIT);
4028 else
4030 if (query (_("Interrupted while waiting for the program.\n\
4031 Give up (and stop debugging it)? ")))
4033 pop_target ();
4034 deprecated_throw_reason (RETURN_QUIT);
4038 target_terminal_inferior ();
4041 /* Enable/disable target terminal ownership. Most targets can use
4042 terminal groups to control terminal ownership. Remote targets are
4043 different in that explicit transfer of ownership to/from GDB/target
4044 is required. */
4046 static void
4047 remote_terminal_inferior (void)
4049 if (!target_async_permitted)
4050 /* Nothing to do. */
4051 return;
4053 /* FIXME: cagney/1999-09-27: Shouldn't need to test for
4054 sync_execution here. This function should only be called when
4055 GDB is resuming the inferior in the forground. A background
4056 resume (``run&'') should leave GDB in control of the terminal and
4057 consequently should not call this code. */
4058 if (!sync_execution)
4059 return;
4060 /* FIXME: cagney/1999-09-27: Closely related to the above. Make
4061 calls target_terminal_*() idenpotent. The event-loop GDB talking
4062 to an asynchronous target with a synchronous command calls this
4063 function from both event-top.c and infrun.c/infcmd.c. Once GDB
4064 stops trying to transfer the terminal to the target when it
4065 shouldn't this guard can go away. */
4066 if (!remote_async_terminal_ours_p)
4067 return;
4068 delete_file_handler (input_fd);
4069 remote_async_terminal_ours_p = 0;
4070 initialize_sigint_signal_handler ();
4071 /* NOTE: At this point we could also register our selves as the
4072 recipient of all input. Any characters typed could then be
4073 passed on down to the target. */
4076 static void
4077 remote_terminal_ours (void)
4079 if (!target_async_permitted)
4080 /* Nothing to do. */
4081 return;
4083 /* See FIXME in remote_terminal_inferior. */
4084 if (!sync_execution)
4085 return;
4086 /* See FIXME in remote_terminal_inferior. */
4087 if (remote_async_terminal_ours_p)
4088 return;
4089 cleanup_sigint_signal_handler (NULL);
4090 add_file_handler (input_fd, stdin_event_handler, 0);
4091 remote_async_terminal_ours_p = 1;
4094 void
4095 remote_console_output (char *msg)
4097 char *p;
4099 for (p = msg; p[0] && p[1]; p += 2)
4101 char tb[2];
4102 char c = fromhex (p[0]) * 16 + fromhex (p[1]);
4103 tb[0] = c;
4104 tb[1] = 0;
4105 fputs_unfiltered (tb, gdb_stdtarg);
4107 gdb_flush (gdb_stdtarg);
4110 typedef struct cached_reg
4112 int num;
4113 gdb_byte data[MAX_REGISTER_SIZE];
4114 } cached_reg_t;
4116 DEF_VEC_O(cached_reg_t);
4118 struct stop_reply
4120 struct stop_reply *next;
4122 ptid_t ptid;
4124 struct target_waitstatus ws;
4126 VEC(cached_reg_t) *regcache;
4128 int stopped_by_watchpoint_p;
4129 CORE_ADDR watch_data_address;
4131 int solibs_changed;
4132 int replay_event;
4135 /* The list of already fetched and acknowledged stop events. */
4136 static struct stop_reply *stop_reply_queue;
4138 static struct stop_reply *
4139 stop_reply_xmalloc (void)
4141 struct stop_reply *r = XMALLOC (struct stop_reply);
4142 r->next = NULL;
4143 return r;
4146 static void
4147 stop_reply_xfree (struct stop_reply *r)
4149 if (r != NULL)
4151 VEC_free (cached_reg_t, r->regcache);
4152 xfree (r);
4156 /* Discard all pending stop replies of inferior PID. If PID is -1,
4157 discard everything. */
4159 static void
4160 discard_pending_stop_replies (int pid)
4162 struct stop_reply *prev = NULL, *reply, *next;
4164 /* Discard the in-flight notification. */
4165 if (pending_stop_reply != NULL
4166 && (pid == -1
4167 || ptid_get_pid (pending_stop_reply->ptid) == pid))
4169 stop_reply_xfree (pending_stop_reply);
4170 pending_stop_reply = NULL;
4173 /* Discard the stop replies we have already pulled with
4174 vStopped. */
4175 for (reply = stop_reply_queue; reply; reply = next)
4177 next = reply->next;
4178 if (pid == -1
4179 || ptid_get_pid (reply->ptid) == pid)
4181 if (reply == stop_reply_queue)
4182 stop_reply_queue = reply->next;
4183 else
4184 prev->next = reply->next;
4186 stop_reply_xfree (reply);
4188 else
4189 prev = reply;
4193 /* Cleanup wrapper. */
4195 static void
4196 do_stop_reply_xfree (void *arg)
4198 struct stop_reply *r = arg;
4199 stop_reply_xfree (r);
4202 /* Look for a queued stop reply belonging to PTID. If one is found,
4203 remove it from the queue, and return it. Returns NULL if none is
4204 found. If there are still queued events left to process, tell the
4205 event loop to get back to target_wait soon. */
4207 static struct stop_reply *
4208 queued_stop_reply (ptid_t ptid)
4210 struct stop_reply *it, *prev;
4211 struct stop_reply head;
4213 head.next = stop_reply_queue;
4214 prev = &head;
4216 it = head.next;
4218 if (!ptid_equal (ptid, minus_one_ptid))
4219 for (; it; prev = it, it = it->next)
4220 if (ptid_equal (ptid, it->ptid))
4221 break;
4223 if (it)
4225 prev->next = it->next;
4226 it->next = NULL;
4229 stop_reply_queue = head.next;
4231 if (stop_reply_queue)
4232 /* There's still at least an event left. */
4233 mark_async_event_handler (remote_async_inferior_event_token);
4235 return it;
4238 /* Push a fully parsed stop reply in the stop reply queue. Since we
4239 know that we now have at least one queued event left to pass to the
4240 core side, tell the event loop to get back to target_wait soon. */
4242 static void
4243 push_stop_reply (struct stop_reply *new_event)
4245 struct stop_reply *event;
4247 if (stop_reply_queue)
4249 for (event = stop_reply_queue;
4250 event && event->next;
4251 event = event->next)
4254 event->next = new_event;
4256 else
4257 stop_reply_queue = new_event;
4259 mark_async_event_handler (remote_async_inferior_event_token);
4262 /* Returns true if we have a stop reply for PTID. */
4264 static int
4265 peek_stop_reply (ptid_t ptid)
4267 struct stop_reply *it;
4269 for (it = stop_reply_queue; it; it = it->next)
4270 if (ptid_equal (ptid, it->ptid))
4272 if (it->ws.kind == TARGET_WAITKIND_STOPPED)
4273 return 1;
4276 return 0;
4279 /* Parse the stop reply in BUF. Either the function succeeds, and the
4280 result is stored in EVENT, or throws an error. */
4282 static void
4283 remote_parse_stop_reply (char *buf, struct stop_reply *event)
4285 struct remote_arch_state *rsa = get_remote_arch_state ();
4286 ULONGEST addr;
4287 char *p;
4289 event->ptid = null_ptid;
4290 event->ws.kind = TARGET_WAITKIND_IGNORE;
4291 event->ws.value.integer = 0;
4292 event->solibs_changed = 0;
4293 event->replay_event = 0;
4294 event->stopped_by_watchpoint_p = 0;
4295 event->regcache = NULL;
4297 switch (buf[0])
4299 case 'T': /* Status with PC, SP, FP, ... */
4301 gdb_byte regs[MAX_REGISTER_SIZE];
4303 /* Expedited reply, containing Signal, {regno, reg} repeat. */
4304 /* format is: 'Tssn...:r...;n...:r...;n...:r...;#cc', where
4305 ss = signal number
4306 n... = register number
4307 r... = register contents
4310 p = &buf[3]; /* after Txx */
4311 while (*p)
4313 char *p1;
4314 char *p_temp;
4315 int fieldsize;
4316 LONGEST pnum = 0;
4318 /* If the packet contains a register number, save it in
4319 pnum and set p1 to point to the character following it.
4320 Otherwise p1 points to p. */
4322 /* If this packet is an awatch packet, don't parse the 'a'
4323 as a register number. */
4325 if (strncmp (p, "awatch", strlen("awatch")) != 0)
4327 /* Read the ``P'' register number. */
4328 pnum = strtol (p, &p_temp, 16);
4329 p1 = p_temp;
4331 else
4332 p1 = p;
4334 if (p1 == p) /* No register number present here. */
4336 p1 = strchr (p, ':');
4337 if (p1 == NULL)
4338 error (_("Malformed packet(a) (missing colon): %s\n\
4339 Packet: '%s'\n"),
4340 p, buf);
4341 if (strncmp (p, "thread", p1 - p) == 0)
4342 event->ptid = read_ptid (++p1, &p);
4343 else if ((strncmp (p, "watch", p1 - p) == 0)
4344 || (strncmp (p, "rwatch", p1 - p) == 0)
4345 || (strncmp (p, "awatch", p1 - p) == 0))
4347 event->stopped_by_watchpoint_p = 1;
4348 p = unpack_varlen_hex (++p1, &addr);
4349 event->watch_data_address = (CORE_ADDR) addr;
4351 else if (strncmp (p, "library", p1 - p) == 0)
4353 p1++;
4354 p_temp = p1;
4355 while (*p_temp && *p_temp != ';')
4356 p_temp++;
4358 event->solibs_changed = 1;
4359 p = p_temp;
4361 else if (strncmp (p, "replaylog", p1 - p) == 0)
4363 /* NO_HISTORY event.
4364 p1 will indicate "begin" or "end", but
4365 it makes no difference for now, so ignore it. */
4366 event->replay_event = 1;
4367 p_temp = strchr (p1 + 1, ';');
4368 if (p_temp)
4369 p = p_temp;
4371 else
4373 /* Silently skip unknown optional info. */
4374 p_temp = strchr (p1 + 1, ';');
4375 if (p_temp)
4376 p = p_temp;
4379 else
4381 struct packet_reg *reg = packet_reg_from_pnum (rsa, pnum);
4382 cached_reg_t cached_reg;
4384 p = p1;
4386 if (*p != ':')
4387 error (_("Malformed packet(b) (missing colon): %s\n\
4388 Packet: '%s'\n"),
4389 p, buf);
4390 ++p;
4392 if (reg == NULL)
4393 error (_("Remote sent bad register number %s: %s\n\
4394 Packet: '%s'\n"),
4395 phex_nz (pnum, 0), p, buf);
4397 cached_reg.num = reg->regnum;
4399 fieldsize = hex2bin (p, cached_reg.data,
4400 register_size (target_gdbarch,
4401 reg->regnum));
4402 p += 2 * fieldsize;
4403 if (fieldsize < register_size (target_gdbarch,
4404 reg->regnum))
4405 warning (_("Remote reply is too short: %s"), buf);
4407 VEC_safe_push (cached_reg_t, event->regcache, &cached_reg);
4410 if (*p != ';')
4411 error (_("Remote register badly formatted: %s\nhere: %s"),
4412 buf, p);
4413 ++p;
4416 /* fall through */
4417 case 'S': /* Old style status, just signal only. */
4418 if (event->solibs_changed)
4419 event->ws.kind = TARGET_WAITKIND_LOADED;
4420 else if (event->replay_event)
4421 event->ws.kind = TARGET_WAITKIND_NO_HISTORY;
4422 else
4424 event->ws.kind = TARGET_WAITKIND_STOPPED;
4425 event->ws.value.sig = (enum target_signal)
4426 (((fromhex (buf[1])) << 4) + (fromhex (buf[2])));
4428 break;
4429 case 'W': /* Target exited. */
4430 case 'X':
4432 char *p;
4433 int pid;
4434 ULONGEST value;
4436 /* GDB used to accept only 2 hex chars here. Stubs should
4437 only send more if they detect GDB supports multi-process
4438 support. */
4439 p = unpack_varlen_hex (&buf[1], &value);
4441 if (buf[0] == 'W')
4443 /* The remote process exited. */
4444 event->ws.kind = TARGET_WAITKIND_EXITED;
4445 event->ws.value.integer = value;
4447 else
4449 /* The remote process exited with a signal. */
4450 event->ws.kind = TARGET_WAITKIND_SIGNALLED;
4451 event->ws.value.sig = (enum target_signal) value;
4454 /* If no process is specified, assume inferior_ptid. */
4455 pid = ptid_get_pid (inferior_ptid);
4456 if (*p == '\0')
4458 else if (*p == ';')
4460 p++;
4462 if (p == '\0')
4464 else if (strncmp (p,
4465 "process:", sizeof ("process:") - 1) == 0)
4467 ULONGEST upid;
4468 p += sizeof ("process:") - 1;
4469 unpack_varlen_hex (p, &upid);
4470 pid = upid;
4472 else
4473 error (_("unknown stop reply packet: %s"), buf);
4475 else
4476 error (_("unknown stop reply packet: %s"), buf);
4477 event->ptid = pid_to_ptid (pid);
4479 break;
4482 if (non_stop && ptid_equal (event->ptid, null_ptid))
4483 error (_("No process or thread specified in stop reply: %s"), buf);
4486 /* When the stub wants to tell GDB about a new stop reply, it sends a
4487 stop notification (%Stop). Those can come it at any time, hence,
4488 we have to make sure that any pending putpkt/getpkt sequence we're
4489 making is finished, before querying the stub for more events with
4490 vStopped. E.g., if we started a vStopped sequence immediatelly
4491 upon receiving the %Stop notification, something like this could
4492 happen:
4494 1.1) --> Hg 1
4495 1.2) <-- OK
4496 1.3) --> g
4497 1.4) <-- %Stop
4498 1.5) --> vStopped
4499 1.6) <-- (registers reply to step #1.3)
4501 Obviously, the reply in step #1.6 would be unexpected to a vStopped
4502 query.
4504 To solve this, whenever we parse a %Stop notification sucessfully,
4505 we mark the REMOTE_ASYNC_GET_PENDING_EVENTS_TOKEN, and carry on
4506 doing whatever we were doing:
4508 2.1) --> Hg 1
4509 2.2) <-- OK
4510 2.3) --> g
4511 2.4) <-- %Stop
4512 <GDB marks the REMOTE_ASYNC_GET_PENDING_EVENTS_TOKEN>
4513 2.5) <-- (registers reply to step #2.3)
4515 Eventualy after step #2.5, we return to the event loop, which
4516 notices there's an event on the
4517 REMOTE_ASYNC_GET_PENDING_EVENTS_TOKEN event and calls the
4518 associated callback --- the function below. At this point, we're
4519 always safe to start a vStopped sequence. :
4521 2.6) --> vStopped
4522 2.7) <-- T05 thread:2
4523 2.8) --> vStopped
4524 2.9) --> OK
4527 static void
4528 remote_get_pending_stop_replies (void)
4530 struct remote_state *rs = get_remote_state ();
4531 int ret;
4533 if (pending_stop_reply)
4535 /* acknowledge */
4536 putpkt ("vStopped");
4538 /* Now we can rely on it. */
4539 push_stop_reply (pending_stop_reply);
4540 pending_stop_reply = NULL;
4542 while (1)
4544 getpkt (&rs->buf, &rs->buf_size, 0);
4545 if (strcmp (rs->buf, "OK") == 0)
4546 break;
4547 else
4549 struct cleanup *old_chain;
4550 struct stop_reply *stop_reply = stop_reply_xmalloc ();
4552 old_chain = make_cleanup (do_stop_reply_xfree, stop_reply);
4553 remote_parse_stop_reply (rs->buf, stop_reply);
4555 /* acknowledge */
4556 putpkt ("vStopped");
4558 if (stop_reply->ws.kind != TARGET_WAITKIND_IGNORE)
4560 /* Now we can rely on it. */
4561 discard_cleanups (old_chain);
4562 push_stop_reply (stop_reply);
4564 else
4565 /* We got an unknown stop reply. */
4566 do_cleanups (old_chain);
4573 /* Called when it is decided that STOP_REPLY holds the info of the
4574 event that is to be returned to the core. This function always
4575 destroys STOP_REPLY. */
4577 static ptid_t
4578 process_stop_reply (struct stop_reply *stop_reply,
4579 struct target_waitstatus *status)
4581 ptid_t ptid;
4583 *status = stop_reply->ws;
4584 ptid = stop_reply->ptid;
4586 /* If no thread/process was reported by the stub, assume the current
4587 inferior. */
4588 if (ptid_equal (ptid, null_ptid))
4589 ptid = inferior_ptid;
4591 if (status->kind != TARGET_WAITKIND_EXITED
4592 && status->kind != TARGET_WAITKIND_SIGNALLED)
4594 /* Expedited registers. */
4595 if (stop_reply->regcache)
4597 cached_reg_t *reg;
4598 int ix;
4600 for (ix = 0;
4601 VEC_iterate(cached_reg_t, stop_reply->regcache, ix, reg);
4602 ix++)
4603 regcache_raw_supply (get_thread_regcache (ptid),
4604 reg->num, reg->data);
4605 VEC_free (cached_reg_t, stop_reply->regcache);
4608 remote_stopped_by_watchpoint_p = stop_reply->stopped_by_watchpoint_p;
4609 remote_watch_data_address = stop_reply->watch_data_address;
4611 remote_notice_new_inferior (ptid, 0);
4614 stop_reply_xfree (stop_reply);
4615 return ptid;
4618 /* The non-stop mode version of target_wait. */
4620 static ptid_t
4621 remote_wait_ns (ptid_t ptid, struct target_waitstatus *status)
4623 struct remote_state *rs = get_remote_state ();
4624 struct remote_arch_state *rsa = get_remote_arch_state ();
4625 ptid_t event_ptid = null_ptid;
4626 struct stop_reply *stop_reply;
4627 int ret;
4629 /* If in non-stop mode, get out of getpkt even if a
4630 notification is received. */
4632 ret = getpkt_or_notif_sane (&rs->buf, &rs->buf_size,
4633 0 /* forever */);
4634 while (1)
4636 if (ret != -1)
4637 switch (rs->buf[0])
4639 case 'E': /* Error of some sort. */
4640 /* We're out of sync with the target now. Did it continue
4641 or not? We can't tell which thread it was in non-stop,
4642 so just ignore this. */
4643 warning (_("Remote failure reply: %s"), rs->buf);
4644 break;
4645 case 'O': /* Console output. */
4646 remote_console_output (rs->buf + 1);
4647 break;
4648 default:
4649 warning (_("Invalid remote reply: %s"), rs->buf);
4650 break;
4653 /* Acknowledge a pending stop reply that may have arrived in the
4654 mean time. */
4655 if (pending_stop_reply != NULL)
4656 remote_get_pending_stop_replies ();
4658 /* If indeed we noticed a stop reply, we're done. */
4659 stop_reply = queued_stop_reply (ptid);
4660 if (stop_reply != NULL)
4661 return process_stop_reply (stop_reply, status);
4663 /* Still no event. If we're in asynchronous mode, then just
4664 return to the event loop. */
4665 if (remote_is_async_p ())
4667 status->kind = TARGET_WAITKIND_IGNORE;
4668 return minus_one_ptid;
4671 /* Otherwise, asynchronous mode is masked, so do a blocking
4672 wait. */
4673 ret = getpkt_or_notif_sane (&rs->buf, &rs->buf_size,
4674 1 /* forever */);
4678 /* Wait until the remote machine stops, then return, storing status in
4679 STATUS just as `wait' would. */
4681 static ptid_t
4682 remote_wait_as (ptid_t ptid, struct target_waitstatus *status)
4684 struct remote_state *rs = get_remote_state ();
4685 struct remote_arch_state *rsa = get_remote_arch_state ();
4686 ptid_t event_ptid = null_ptid;
4687 ULONGEST addr;
4688 int solibs_changed = 0;
4689 char *buf, *p;
4690 struct stop_reply *stop_reply;
4692 status->kind = TARGET_WAITKIND_IGNORE;
4693 status->value.integer = 0;
4695 stop_reply = queued_stop_reply (ptid);
4696 if (stop_reply != NULL)
4697 return process_stop_reply (stop_reply, status);
4699 if (rs->cached_wait_status)
4700 /* Use the cached wait status, but only once. */
4701 rs->cached_wait_status = 0;
4702 else
4704 int ret;
4706 if (!target_is_async_p ())
4708 ofunc = signal (SIGINT, remote_interrupt);
4709 /* If the user hit C-c before this packet, or between packets,
4710 pretend that it was hit right here. */
4711 if (quit_flag)
4713 quit_flag = 0;
4714 remote_interrupt (SIGINT);
4718 /* FIXME: cagney/1999-09-27: If we're in async mode we should
4719 _never_ wait for ever -> test on target_is_async_p().
4720 However, before we do that we need to ensure that the caller
4721 knows how to take the target into/out of async mode. */
4722 ret = getpkt_sane (&rs->buf, &rs->buf_size, wait_forever_enabled_p);
4723 if (!target_is_async_p ())
4724 signal (SIGINT, ofunc);
4727 buf = rs->buf;
4729 remote_stopped_by_watchpoint_p = 0;
4731 /* We got something. */
4732 rs->waiting_for_stop_reply = 0;
4734 switch (buf[0])
4736 case 'E': /* Error of some sort. */
4737 /* We're out of sync with the target now. Did it continue or
4738 not? Not is more likely, so report a stop. */
4739 warning (_("Remote failure reply: %s"), buf);
4740 status->kind = TARGET_WAITKIND_STOPPED;
4741 status->value.sig = TARGET_SIGNAL_0;
4742 break;
4743 case 'F': /* File-I/O request. */
4744 remote_fileio_request (buf);
4745 break;
4746 case 'T': case 'S': case 'X': case 'W':
4748 struct stop_reply *stop_reply;
4749 struct cleanup *old_chain;
4751 stop_reply = stop_reply_xmalloc ();
4752 old_chain = make_cleanup (do_stop_reply_xfree, stop_reply);
4753 remote_parse_stop_reply (buf, stop_reply);
4754 discard_cleanups (old_chain);
4755 event_ptid = process_stop_reply (stop_reply, status);
4756 break;
4758 case 'O': /* Console output. */
4759 remote_console_output (buf + 1);
4761 /* The target didn't really stop; keep waiting. */
4762 rs->waiting_for_stop_reply = 1;
4764 break;
4765 case '\0':
4766 if (last_sent_signal != TARGET_SIGNAL_0)
4768 /* Zero length reply means that we tried 'S' or 'C' and the
4769 remote system doesn't support it. */
4770 target_terminal_ours_for_output ();
4771 printf_filtered
4772 ("Can't send signals to this remote system. %s not sent.\n",
4773 target_signal_to_name (last_sent_signal));
4774 last_sent_signal = TARGET_SIGNAL_0;
4775 target_terminal_inferior ();
4777 strcpy ((char *) buf, last_sent_step ? "s" : "c");
4778 putpkt ((char *) buf);
4780 /* We just told the target to resume, so a stop reply is in
4781 order. */
4782 rs->waiting_for_stop_reply = 1;
4783 break;
4785 /* else fallthrough */
4786 default:
4787 warning (_("Invalid remote reply: %s"), buf);
4788 /* Keep waiting. */
4789 rs->waiting_for_stop_reply = 1;
4790 break;
4793 if (status->kind == TARGET_WAITKIND_IGNORE)
4794 /* Nothing interesting happened. */
4795 return minus_one_ptid;
4796 else if (status->kind != TARGET_WAITKIND_EXITED
4797 && status->kind != TARGET_WAITKIND_SIGNALLED)
4799 if (!ptid_equal (event_ptid, null_ptid))
4800 record_currthread (event_ptid);
4801 else
4802 event_ptid = inferior_ptid;
4804 else
4805 /* A process exit. Invalidate our notion of current thread. */
4806 record_currthread (minus_one_ptid);
4808 return event_ptid;
4811 /* Wait until the remote machine stops, then return, storing status in
4812 STATUS just as `wait' would. */
4814 static ptid_t
4815 remote_wait (struct target_ops *ops,
4816 ptid_t ptid, struct target_waitstatus *status)
4818 ptid_t event_ptid;
4820 if (non_stop)
4821 event_ptid = remote_wait_ns (ptid, status);
4822 else
4824 /* In synchronous mode, keep waiting until the target stops. In
4825 asynchronous mode, always return to the event loop. */
4829 event_ptid = remote_wait_as (ptid, status);
4831 while (status->kind == TARGET_WAITKIND_IGNORE
4832 && !target_can_async_p ());
4835 if (target_can_async_p ())
4837 /* If there are are events left in the queue tell the event loop
4838 to return here. */
4839 if (stop_reply_queue)
4840 mark_async_event_handler (remote_async_inferior_event_token);
4843 return event_ptid;
4846 /* Fetch a single register using a 'p' packet. */
4848 static int
4849 fetch_register_using_p (struct regcache *regcache, struct packet_reg *reg)
4851 struct remote_state *rs = get_remote_state ();
4852 char *buf, *p;
4853 char regp[MAX_REGISTER_SIZE];
4854 int i;
4856 if (remote_protocol_packets[PACKET_p].support == PACKET_DISABLE)
4857 return 0;
4859 if (reg->pnum == -1)
4860 return 0;
4862 p = rs->buf;
4863 *p++ = 'p';
4864 p += hexnumstr (p, reg->pnum);
4865 *p++ = '\0';
4866 remote_send (&rs->buf, &rs->buf_size);
4868 buf = rs->buf;
4870 switch (packet_ok (buf, &remote_protocol_packets[PACKET_p]))
4872 case PACKET_OK:
4873 break;
4874 case PACKET_UNKNOWN:
4875 return 0;
4876 case PACKET_ERROR:
4877 error (_("Could not fetch register \"%s\""),
4878 gdbarch_register_name (get_regcache_arch (regcache), reg->regnum));
4881 /* If this register is unfetchable, tell the regcache. */
4882 if (buf[0] == 'x')
4884 regcache_raw_supply (regcache, reg->regnum, NULL);
4885 return 1;
4888 /* Otherwise, parse and supply the value. */
4889 p = buf;
4890 i = 0;
4891 while (p[0] != 0)
4893 if (p[1] == 0)
4894 error (_("fetch_register_using_p: early buf termination"));
4896 regp[i++] = fromhex (p[0]) * 16 + fromhex (p[1]);
4897 p += 2;
4899 regcache_raw_supply (regcache, reg->regnum, regp);
4900 return 1;
4903 /* Fetch the registers included in the target's 'g' packet. */
4905 static int
4906 send_g_packet (void)
4908 struct remote_state *rs = get_remote_state ();
4909 int i, buf_len;
4910 char *p;
4911 char *regs;
4913 sprintf (rs->buf, "g");
4914 remote_send (&rs->buf, &rs->buf_size);
4916 /* We can get out of synch in various cases. If the first character
4917 in the buffer is not a hex character, assume that has happened
4918 and try to fetch another packet to read. */
4919 while ((rs->buf[0] < '0' || rs->buf[0] > '9')
4920 && (rs->buf[0] < 'A' || rs->buf[0] > 'F')
4921 && (rs->buf[0] < 'a' || rs->buf[0] > 'f')
4922 && rs->buf[0] != 'x') /* New: unavailable register value. */
4924 if (remote_debug)
4925 fprintf_unfiltered (gdb_stdlog,
4926 "Bad register packet; fetching a new packet\n");
4927 getpkt (&rs->buf, &rs->buf_size, 0);
4930 buf_len = strlen (rs->buf);
4932 /* Sanity check the received packet. */
4933 if (buf_len % 2 != 0)
4934 error (_("Remote 'g' packet reply is of odd length: %s"), rs->buf);
4936 return buf_len / 2;
4939 static void
4940 process_g_packet (struct regcache *regcache)
4942 struct gdbarch *gdbarch = get_regcache_arch (regcache);
4943 struct remote_state *rs = get_remote_state ();
4944 struct remote_arch_state *rsa = get_remote_arch_state ();
4945 int i, buf_len;
4946 char *p;
4947 char *regs;
4949 buf_len = strlen (rs->buf);
4951 /* Further sanity checks, with knowledge of the architecture. */
4952 if (buf_len > 2 * rsa->sizeof_g_packet)
4953 error (_("Remote 'g' packet reply is too long: %s"), rs->buf);
4955 /* Save the size of the packet sent to us by the target. It is used
4956 as a heuristic when determining the max size of packets that the
4957 target can safely receive. */
4958 if (rsa->actual_register_packet_size == 0)
4959 rsa->actual_register_packet_size = buf_len;
4961 /* If this is smaller than we guessed the 'g' packet would be,
4962 update our records. A 'g' reply that doesn't include a register's
4963 value implies either that the register is not available, or that
4964 the 'p' packet must be used. */
4965 if (buf_len < 2 * rsa->sizeof_g_packet)
4967 rsa->sizeof_g_packet = buf_len / 2;
4969 for (i = 0; i < gdbarch_num_regs (gdbarch); i++)
4971 if (rsa->regs[i].pnum == -1)
4972 continue;
4974 if (rsa->regs[i].offset >= rsa->sizeof_g_packet)
4975 rsa->regs[i].in_g_packet = 0;
4976 else
4977 rsa->regs[i].in_g_packet = 1;
4981 regs = alloca (rsa->sizeof_g_packet);
4983 /* Unimplemented registers read as all bits zero. */
4984 memset (regs, 0, rsa->sizeof_g_packet);
4986 /* Reply describes registers byte by byte, each byte encoded as two
4987 hex characters. Suck them all up, then supply them to the
4988 register cacheing/storage mechanism. */
4990 p = rs->buf;
4991 for (i = 0; i < rsa->sizeof_g_packet; i++)
4993 if (p[0] == 0 || p[1] == 0)
4994 /* This shouldn't happen - we adjusted sizeof_g_packet above. */
4995 internal_error (__FILE__, __LINE__,
4996 "unexpected end of 'g' packet reply");
4998 if (p[0] == 'x' && p[1] == 'x')
4999 regs[i] = 0; /* 'x' */
5000 else
5001 regs[i] = fromhex (p[0]) * 16 + fromhex (p[1]);
5002 p += 2;
5006 int i;
5007 for (i = 0; i < gdbarch_num_regs (gdbarch); i++)
5009 struct packet_reg *r = &rsa->regs[i];
5010 if (r->in_g_packet)
5012 if (r->offset * 2 >= strlen (rs->buf))
5013 /* This shouldn't happen - we adjusted in_g_packet above. */
5014 internal_error (__FILE__, __LINE__,
5015 "unexpected end of 'g' packet reply");
5016 else if (rs->buf[r->offset * 2] == 'x')
5018 gdb_assert (r->offset * 2 < strlen (rs->buf));
5019 /* The register isn't available, mark it as such (at
5020 the same time setting the value to zero). */
5021 regcache_raw_supply (regcache, r->regnum, NULL);
5023 else
5024 regcache_raw_supply (regcache, r->regnum,
5025 regs + r->offset);
5031 static void
5032 fetch_registers_using_g (struct regcache *regcache)
5034 send_g_packet ();
5035 process_g_packet (regcache);
5038 static void
5039 remote_fetch_registers (struct target_ops *ops,
5040 struct regcache *regcache, int regnum)
5042 struct remote_state *rs = get_remote_state ();
5043 struct remote_arch_state *rsa = get_remote_arch_state ();
5044 int i;
5046 set_general_thread (inferior_ptid);
5048 if (regnum >= 0)
5050 struct packet_reg *reg = packet_reg_from_regnum (rsa, regnum);
5051 gdb_assert (reg != NULL);
5053 /* If this register might be in the 'g' packet, try that first -
5054 we are likely to read more than one register. If this is the
5055 first 'g' packet, we might be overly optimistic about its
5056 contents, so fall back to 'p'. */
5057 if (reg->in_g_packet)
5059 fetch_registers_using_g (regcache);
5060 if (reg->in_g_packet)
5061 return;
5064 if (fetch_register_using_p (regcache, reg))
5065 return;
5067 /* This register is not available. */
5068 regcache_raw_supply (regcache, reg->regnum, NULL);
5070 return;
5073 fetch_registers_using_g (regcache);
5075 for (i = 0; i < gdbarch_num_regs (get_regcache_arch (regcache)); i++)
5076 if (!rsa->regs[i].in_g_packet)
5077 if (!fetch_register_using_p (regcache, &rsa->regs[i]))
5079 /* This register is not available. */
5080 regcache_raw_supply (regcache, i, NULL);
5084 /* Prepare to store registers. Since we may send them all (using a
5085 'G' request), we have to read out the ones we don't want to change
5086 first. */
5088 static void
5089 remote_prepare_to_store (struct regcache *regcache)
5091 struct remote_arch_state *rsa = get_remote_arch_state ();
5092 int i;
5093 gdb_byte buf[MAX_REGISTER_SIZE];
5095 /* Make sure the entire registers array is valid. */
5096 switch (remote_protocol_packets[PACKET_P].support)
5098 case PACKET_DISABLE:
5099 case PACKET_SUPPORT_UNKNOWN:
5100 /* Make sure all the necessary registers are cached. */
5101 for (i = 0; i < gdbarch_num_regs (get_regcache_arch (regcache)); i++)
5102 if (rsa->regs[i].in_g_packet)
5103 regcache_raw_read (regcache, rsa->regs[i].regnum, buf);
5104 break;
5105 case PACKET_ENABLE:
5106 break;
5110 /* Helper: Attempt to store REGNUM using the P packet. Return fail IFF
5111 packet was not recognized. */
5113 static int
5114 store_register_using_P (const struct regcache *regcache, struct packet_reg *reg)
5116 struct gdbarch *gdbarch = get_regcache_arch (regcache);
5117 struct remote_state *rs = get_remote_state ();
5118 struct remote_arch_state *rsa = get_remote_arch_state ();
5119 /* Try storing a single register. */
5120 char *buf = rs->buf;
5121 gdb_byte regp[MAX_REGISTER_SIZE];
5122 char *p;
5124 if (remote_protocol_packets[PACKET_P].support == PACKET_DISABLE)
5125 return 0;
5127 if (reg->pnum == -1)
5128 return 0;
5130 xsnprintf (buf, get_remote_packet_size (), "P%s=", phex_nz (reg->pnum, 0));
5131 p = buf + strlen (buf);
5132 regcache_raw_collect (regcache, reg->regnum, regp);
5133 bin2hex (regp, p, register_size (gdbarch, reg->regnum));
5134 remote_send (&rs->buf, &rs->buf_size);
5136 switch (packet_ok (rs->buf, &remote_protocol_packets[PACKET_P]))
5138 case PACKET_OK:
5139 return 1;
5140 case PACKET_ERROR:
5141 error (_("Could not write register \"%s\""),
5142 gdbarch_register_name (gdbarch, reg->regnum));
5143 case PACKET_UNKNOWN:
5144 return 0;
5145 default:
5146 internal_error (__FILE__, __LINE__, _("Bad result from packet_ok"));
5150 /* Store register REGNUM, or all registers if REGNUM == -1, from the
5151 contents of the register cache buffer. FIXME: ignores errors. */
5153 static void
5154 store_registers_using_G (const struct regcache *regcache)
5156 struct remote_state *rs = get_remote_state ();
5157 struct remote_arch_state *rsa = get_remote_arch_state ();
5158 gdb_byte *regs;
5159 char *p;
5161 /* Extract all the registers in the regcache copying them into a
5162 local buffer. */
5164 int i;
5165 regs = alloca (rsa->sizeof_g_packet);
5166 memset (regs, 0, rsa->sizeof_g_packet);
5167 for (i = 0; i < gdbarch_num_regs (get_regcache_arch (regcache)); i++)
5169 struct packet_reg *r = &rsa->regs[i];
5170 if (r->in_g_packet)
5171 regcache_raw_collect (regcache, r->regnum, regs + r->offset);
5175 /* Command describes registers byte by byte,
5176 each byte encoded as two hex characters. */
5177 p = rs->buf;
5178 *p++ = 'G';
5179 /* remote_prepare_to_store insures that rsa->sizeof_g_packet gets
5180 updated. */
5181 bin2hex (regs, p, rsa->sizeof_g_packet);
5182 remote_send (&rs->buf, &rs->buf_size);
5185 /* Store register REGNUM, or all registers if REGNUM == -1, from the contents
5186 of the register cache buffer. FIXME: ignores errors. */
5188 static void
5189 remote_store_registers (struct target_ops *ops,
5190 struct regcache *regcache, int regnum)
5192 struct remote_state *rs = get_remote_state ();
5193 struct remote_arch_state *rsa = get_remote_arch_state ();
5194 int i;
5196 set_general_thread (inferior_ptid);
5198 if (regnum >= 0)
5200 struct packet_reg *reg = packet_reg_from_regnum (rsa, regnum);
5201 gdb_assert (reg != NULL);
5203 /* Always prefer to store registers using the 'P' packet if
5204 possible; we often change only a small number of registers.
5205 Sometimes we change a larger number; we'd need help from a
5206 higher layer to know to use 'G'. */
5207 if (store_register_using_P (regcache, reg))
5208 return;
5210 /* For now, don't complain if we have no way to write the
5211 register. GDB loses track of unavailable registers too
5212 easily. Some day, this may be an error. We don't have
5213 any way to read the register, either... */
5214 if (!reg->in_g_packet)
5215 return;
5217 store_registers_using_G (regcache);
5218 return;
5221 store_registers_using_G (regcache);
5223 for (i = 0; i < gdbarch_num_regs (get_regcache_arch (regcache)); i++)
5224 if (!rsa->regs[i].in_g_packet)
5225 if (!store_register_using_P (regcache, &rsa->regs[i]))
5226 /* See above for why we do not issue an error here. */
5227 continue;
5231 /* Return the number of hex digits in num. */
5233 static int
5234 hexnumlen (ULONGEST num)
5236 int i;
5238 for (i = 0; num != 0; i++)
5239 num >>= 4;
5241 return max (i, 1);
5244 /* Set BUF to the minimum number of hex digits representing NUM. */
5246 static int
5247 hexnumstr (char *buf, ULONGEST num)
5249 int len = hexnumlen (num);
5250 return hexnumnstr (buf, num, len);
5254 /* Set BUF to the hex digits representing NUM, padded to WIDTH characters. */
5256 static int
5257 hexnumnstr (char *buf, ULONGEST num, int width)
5259 int i;
5261 buf[width] = '\0';
5263 for (i = width - 1; i >= 0; i--)
5265 buf[i] = "0123456789abcdef"[(num & 0xf)];
5266 num >>= 4;
5269 return width;
5272 /* Mask all but the least significant REMOTE_ADDRESS_SIZE bits. */
5274 static CORE_ADDR
5275 remote_address_masked (CORE_ADDR addr)
5277 int address_size = remote_address_size;
5278 /* If "remoteaddresssize" was not set, default to target address size. */
5279 if (!address_size)
5280 address_size = gdbarch_addr_bit (target_gdbarch);
5282 if (address_size > 0
5283 && address_size < (sizeof (ULONGEST) * 8))
5285 /* Only create a mask when that mask can safely be constructed
5286 in a ULONGEST variable. */
5287 ULONGEST mask = 1;
5288 mask = (mask << address_size) - 1;
5289 addr &= mask;
5291 return addr;
5294 /* Convert BUFFER, binary data at least LEN bytes long, into escaped
5295 binary data in OUT_BUF. Set *OUT_LEN to the length of the data
5296 encoded in OUT_BUF, and return the number of bytes in OUT_BUF
5297 (which may be more than *OUT_LEN due to escape characters). The
5298 total number of bytes in the output buffer will be at most
5299 OUT_MAXLEN. */
5301 static int
5302 remote_escape_output (const gdb_byte *buffer, int len,
5303 gdb_byte *out_buf, int *out_len,
5304 int out_maxlen)
5306 int input_index, output_index;
5308 output_index = 0;
5309 for (input_index = 0; input_index < len; input_index++)
5311 gdb_byte b = buffer[input_index];
5313 if (b == '$' || b == '#' || b == '}')
5315 /* These must be escaped. */
5316 if (output_index + 2 > out_maxlen)
5317 break;
5318 out_buf[output_index++] = '}';
5319 out_buf[output_index++] = b ^ 0x20;
5321 else
5323 if (output_index + 1 > out_maxlen)
5324 break;
5325 out_buf[output_index++] = b;
5329 *out_len = input_index;
5330 return output_index;
5333 /* Convert BUFFER, escaped data LEN bytes long, into binary data
5334 in OUT_BUF. Return the number of bytes written to OUT_BUF.
5335 Raise an error if the total number of bytes exceeds OUT_MAXLEN.
5337 This function reverses remote_escape_output. It allows more
5338 escaped characters than that function does, in particular because
5339 '*' must be escaped to avoid the run-length encoding processing
5340 in reading packets. */
5342 static int
5343 remote_unescape_input (const gdb_byte *buffer, int len,
5344 gdb_byte *out_buf, int out_maxlen)
5346 int input_index, output_index;
5347 int escaped;
5349 output_index = 0;
5350 escaped = 0;
5351 for (input_index = 0; input_index < len; input_index++)
5353 gdb_byte b = buffer[input_index];
5355 if (output_index + 1 > out_maxlen)
5357 warning (_("Received too much data from remote target;"
5358 " ignoring overflow."));
5359 return output_index;
5362 if (escaped)
5364 out_buf[output_index++] = b ^ 0x20;
5365 escaped = 0;
5367 else if (b == '}')
5368 escaped = 1;
5369 else
5370 out_buf[output_index++] = b;
5373 if (escaped)
5374 error (_("Unmatched escape character in target response."));
5376 return output_index;
5379 /* Determine whether the remote target supports binary downloading.
5380 This is accomplished by sending a no-op memory write of zero length
5381 to the target at the specified address. It does not suffice to send
5382 the whole packet, since many stubs strip the eighth bit and
5383 subsequently compute a wrong checksum, which causes real havoc with
5384 remote_write_bytes.
5386 NOTE: This can still lose if the serial line is not eight-bit
5387 clean. In cases like this, the user should clear "remote
5388 X-packet". */
5390 static void
5391 check_binary_download (CORE_ADDR addr)
5393 struct remote_state *rs = get_remote_state ();
5395 switch (remote_protocol_packets[PACKET_X].support)
5397 case PACKET_DISABLE:
5398 break;
5399 case PACKET_ENABLE:
5400 break;
5401 case PACKET_SUPPORT_UNKNOWN:
5403 char *p;
5405 p = rs->buf;
5406 *p++ = 'X';
5407 p += hexnumstr (p, (ULONGEST) addr);
5408 *p++ = ',';
5409 p += hexnumstr (p, (ULONGEST) 0);
5410 *p++ = ':';
5411 *p = '\0';
5413 putpkt_binary (rs->buf, (int) (p - rs->buf));
5414 getpkt (&rs->buf, &rs->buf_size, 0);
5416 if (rs->buf[0] == '\0')
5418 if (remote_debug)
5419 fprintf_unfiltered (gdb_stdlog,
5420 "binary downloading NOT suppported by target\n");
5421 remote_protocol_packets[PACKET_X].support = PACKET_DISABLE;
5423 else
5425 if (remote_debug)
5426 fprintf_unfiltered (gdb_stdlog,
5427 "binary downloading suppported by target\n");
5428 remote_protocol_packets[PACKET_X].support = PACKET_ENABLE;
5430 break;
5435 /* Write memory data directly to the remote machine.
5436 This does not inform the data cache; the data cache uses this.
5437 HEADER is the starting part of the packet.
5438 MEMADDR is the address in the remote memory space.
5439 MYADDR is the address of the buffer in our space.
5440 LEN is the number of bytes.
5441 PACKET_FORMAT should be either 'X' or 'M', and indicates if we
5442 should send data as binary ('X'), or hex-encoded ('M').
5444 The function creates packet of the form
5445 <HEADER><ADDRESS>,<LENGTH>:<DATA>
5447 where encoding of <DATA> is termined by PACKET_FORMAT.
5449 If USE_LENGTH is 0, then the <LENGTH> field and the preceding comma
5450 are omitted.
5452 Returns the number of bytes transferred, or 0 (setting errno) for
5453 error. Only transfer a single packet. */
5455 static int
5456 remote_write_bytes_aux (const char *header, CORE_ADDR memaddr,
5457 const gdb_byte *myaddr, int len,
5458 char packet_format, int use_length)
5460 struct remote_state *rs = get_remote_state ();
5461 char *p;
5462 char *plen = NULL;
5463 int plenlen = 0;
5464 int todo;
5465 int nr_bytes;
5466 int payload_size;
5467 int payload_length;
5468 int header_length;
5470 if (packet_format != 'X' && packet_format != 'M')
5471 internal_error (__FILE__, __LINE__,
5472 "remote_write_bytes_aux: bad packet format");
5474 if (len <= 0)
5475 return 0;
5477 payload_size = get_memory_write_packet_size ();
5479 /* The packet buffer will be large enough for the payload;
5480 get_memory_packet_size ensures this. */
5481 rs->buf[0] = '\0';
5483 /* Compute the size of the actual payload by subtracting out the
5484 packet header and footer overhead: "$M<memaddr>,<len>:...#nn".
5486 payload_size -= strlen ("$,:#NN");
5487 if (!use_length)
5488 /* The comma won't be used. */
5489 payload_size += 1;
5490 header_length = strlen (header);
5491 payload_size -= header_length;
5492 payload_size -= hexnumlen (memaddr);
5494 /* Construct the packet excluding the data: "<header><memaddr>,<len>:". */
5496 strcat (rs->buf, header);
5497 p = rs->buf + strlen (header);
5499 /* Compute a best guess of the number of bytes actually transfered. */
5500 if (packet_format == 'X')
5502 /* Best guess at number of bytes that will fit. */
5503 todo = min (len, payload_size);
5504 if (use_length)
5505 payload_size -= hexnumlen (todo);
5506 todo = min (todo, payload_size);
5508 else
5510 /* Num bytes that will fit. */
5511 todo = min (len, payload_size / 2);
5512 if (use_length)
5513 payload_size -= hexnumlen (todo);
5514 todo = min (todo, payload_size / 2);
5517 if (todo <= 0)
5518 internal_error (__FILE__, __LINE__,
5519 _("minumum packet size too small to write data"));
5521 /* If we already need another packet, then try to align the end
5522 of this packet to a useful boundary. */
5523 if (todo > 2 * REMOTE_ALIGN_WRITES && todo < len)
5524 todo = ((memaddr + todo) & ~(REMOTE_ALIGN_WRITES - 1)) - memaddr;
5526 /* Append "<memaddr>". */
5527 memaddr = remote_address_masked (memaddr);
5528 p += hexnumstr (p, (ULONGEST) memaddr);
5530 if (use_length)
5532 /* Append ",". */
5533 *p++ = ',';
5535 /* Append <len>. Retain the location/size of <len>. It may need to
5536 be adjusted once the packet body has been created. */
5537 plen = p;
5538 plenlen = hexnumstr (p, (ULONGEST) todo);
5539 p += plenlen;
5542 /* Append ":". */
5543 *p++ = ':';
5544 *p = '\0';
5546 /* Append the packet body. */
5547 if (packet_format == 'X')
5549 /* Binary mode. Send target system values byte by byte, in
5550 increasing byte addresses. Only escape certain critical
5551 characters. */
5552 payload_length = remote_escape_output (myaddr, todo, p, &nr_bytes,
5553 payload_size);
5555 /* If not all TODO bytes fit, then we'll need another packet. Make
5556 a second try to keep the end of the packet aligned. Don't do
5557 this if the packet is tiny. */
5558 if (nr_bytes < todo && nr_bytes > 2 * REMOTE_ALIGN_WRITES)
5560 int new_nr_bytes;
5562 new_nr_bytes = (((memaddr + nr_bytes) & ~(REMOTE_ALIGN_WRITES - 1))
5563 - memaddr);
5564 if (new_nr_bytes != nr_bytes)
5565 payload_length = remote_escape_output (myaddr, new_nr_bytes,
5566 p, &nr_bytes,
5567 payload_size);
5570 p += payload_length;
5571 if (use_length && nr_bytes < todo)
5573 /* Escape chars have filled up the buffer prematurely,
5574 and we have actually sent fewer bytes than planned.
5575 Fix-up the length field of the packet. Use the same
5576 number of characters as before. */
5577 plen += hexnumnstr (plen, (ULONGEST) nr_bytes, plenlen);
5578 *plen = ':'; /* overwrite \0 from hexnumnstr() */
5581 else
5583 /* Normal mode: Send target system values byte by byte, in
5584 increasing byte addresses. Each byte is encoded as a two hex
5585 value. */
5586 nr_bytes = bin2hex (myaddr, p, todo);
5587 p += 2 * nr_bytes;
5590 putpkt_binary (rs->buf, (int) (p - rs->buf));
5591 getpkt (&rs->buf, &rs->buf_size, 0);
5593 if (rs->buf[0] == 'E')
5595 /* There is no correspondance between what the remote protocol
5596 uses for errors and errno codes. We would like a cleaner way
5597 of representing errors (big enough to include errno codes,
5598 bfd_error codes, and others). But for now just return EIO. */
5599 errno = EIO;
5600 return 0;
5603 /* Return NR_BYTES, not TODO, in case escape chars caused us to send
5604 fewer bytes than we'd planned. */
5605 return nr_bytes;
5608 /* Write memory data directly to the remote machine.
5609 This does not inform the data cache; the data cache uses this.
5610 MEMADDR is the address in the remote memory space.
5611 MYADDR is the address of the buffer in our space.
5612 LEN is the number of bytes.
5614 Returns number of bytes transferred, or 0 (setting errno) for
5615 error. Only transfer a single packet. */
5618 remote_write_bytes (CORE_ADDR memaddr, const gdb_byte *myaddr, int len)
5620 char *packet_format = 0;
5622 /* Check whether the target supports binary download. */
5623 check_binary_download (memaddr);
5625 switch (remote_protocol_packets[PACKET_X].support)
5627 case PACKET_ENABLE:
5628 packet_format = "X";
5629 break;
5630 case PACKET_DISABLE:
5631 packet_format = "M";
5632 break;
5633 case PACKET_SUPPORT_UNKNOWN:
5634 internal_error (__FILE__, __LINE__,
5635 _("remote_write_bytes: bad internal state"));
5636 default:
5637 internal_error (__FILE__, __LINE__, _("bad switch"));
5640 return remote_write_bytes_aux (packet_format,
5641 memaddr, myaddr, len, packet_format[0], 1);
5644 /* Read memory data directly from the remote machine.
5645 This does not use the data cache; the data cache uses this.
5646 MEMADDR is the address in the remote memory space.
5647 MYADDR is the address of the buffer in our space.
5648 LEN is the number of bytes.
5650 Returns number of bytes transferred, or 0 for error. */
5652 /* NOTE: cagney/1999-10-18: This function (and its siblings in other
5653 remote targets) shouldn't attempt to read the entire buffer.
5654 Instead it should read a single packet worth of data and then
5655 return the byte size of that packet to the caller. The caller (its
5656 caller and its callers caller ;-) already contains code for
5657 handling partial reads. */
5660 remote_read_bytes (CORE_ADDR memaddr, gdb_byte *myaddr, int len)
5662 struct remote_state *rs = get_remote_state ();
5663 int max_buf_size; /* Max size of packet output buffer. */
5664 int origlen;
5666 if (len <= 0)
5667 return 0;
5669 max_buf_size = get_memory_read_packet_size ();
5670 /* The packet buffer will be large enough for the payload;
5671 get_memory_packet_size ensures this. */
5673 origlen = len;
5674 while (len > 0)
5676 char *p;
5677 int todo;
5678 int i;
5680 todo = min (len, max_buf_size / 2); /* num bytes that will fit */
5682 /* construct "m"<memaddr>","<len>" */
5683 /* sprintf (rs->buf, "m%lx,%x", (unsigned long) memaddr, todo); */
5684 memaddr = remote_address_masked (memaddr);
5685 p = rs->buf;
5686 *p++ = 'm';
5687 p += hexnumstr (p, (ULONGEST) memaddr);
5688 *p++ = ',';
5689 p += hexnumstr (p, (ULONGEST) todo);
5690 *p = '\0';
5692 putpkt (rs->buf);
5693 getpkt (&rs->buf, &rs->buf_size, 0);
5695 if (rs->buf[0] == 'E'
5696 && isxdigit (rs->buf[1]) && isxdigit (rs->buf[2])
5697 && rs->buf[3] == '\0')
5699 /* There is no correspondance between what the remote
5700 protocol uses for errors and errno codes. We would like
5701 a cleaner way of representing errors (big enough to
5702 include errno codes, bfd_error codes, and others). But
5703 for now just return EIO. */
5704 errno = EIO;
5705 return 0;
5708 /* Reply describes memory byte by byte,
5709 each byte encoded as two hex characters. */
5711 p = rs->buf;
5712 if ((i = hex2bin (p, myaddr, todo)) < todo)
5714 /* Reply is short. This means that we were able to read
5715 only part of what we wanted to. */
5716 return i + (origlen - len);
5718 myaddr += todo;
5719 memaddr += todo;
5720 len -= todo;
5722 return origlen;
5726 /* Remote notification handler. */
5728 static void
5729 handle_notification (char *buf, size_t length)
5731 if (strncmp (buf, "Stop:", 5) == 0)
5733 if (pending_stop_reply)
5734 /* We've already parsed the in-flight stop-reply, but the stub
5735 for some reason thought we didn't, possibly due to timeout
5736 on its side. Just ignore it. */
5738 else
5740 struct cleanup *old_chain;
5741 struct stop_reply *reply = stop_reply_xmalloc ();
5742 old_chain = make_cleanup (do_stop_reply_xfree, reply);
5744 remote_parse_stop_reply (buf + 5, reply);
5746 discard_cleanups (old_chain);
5748 /* Be careful to only set it after parsing, since an error
5749 may be thrown then. */
5750 pending_stop_reply = reply;
5752 /* Notify the event loop there's a stop reply to acknowledge
5753 and that there may be more events to fetch. */
5754 mark_async_event_handler (remote_async_get_pending_events_token);
5757 else
5758 /* We ignore notifications we don't recognize, for compatibility
5759 with newer stubs. */
5764 /* Read or write LEN bytes from inferior memory at MEMADDR,
5765 transferring to or from debugger address BUFFER. Write to inferior
5766 if SHOULD_WRITE is nonzero. Returns length of data written or
5767 read; 0 for error. TARGET is unused. */
5769 static int
5770 remote_xfer_memory (CORE_ADDR mem_addr, gdb_byte *buffer, int mem_len,
5771 int should_write, struct mem_attrib *attrib,
5772 struct target_ops *target)
5774 int res;
5776 set_general_thread (inferior_ptid);
5778 if (should_write)
5779 res = remote_write_bytes (mem_addr, buffer, mem_len);
5780 else
5781 res = remote_read_bytes (mem_addr, buffer, mem_len);
5783 return res;
5786 /* Sends a packet with content determined by the printf format string
5787 FORMAT and the remaining arguments, then gets the reply. Returns
5788 whether the packet was a success, a failure, or unknown. */
5790 static enum packet_result
5791 remote_send_printf (const char *format, ...)
5793 struct remote_state *rs = get_remote_state ();
5794 int max_size = get_remote_packet_size ();
5796 va_list ap;
5797 va_start (ap, format);
5799 rs->buf[0] = '\0';
5800 if (vsnprintf (rs->buf, max_size, format, ap) >= max_size)
5801 internal_error (__FILE__, __LINE__, "Too long remote packet.");
5803 if (putpkt (rs->buf) < 0)
5804 error (_("Communication problem with target."));
5806 rs->buf[0] = '\0';
5807 getpkt (&rs->buf, &rs->buf_size, 0);
5809 return packet_check_result (rs->buf);
5812 static void
5813 restore_remote_timeout (void *p)
5815 int value = *(int *)p;
5816 remote_timeout = value;
5819 /* Flash writing can take quite some time. We'll set
5820 effectively infinite timeout for flash operations.
5821 In future, we'll need to decide on a better approach. */
5822 static const int remote_flash_timeout = 1000;
5824 static void
5825 remote_flash_erase (struct target_ops *ops,
5826 ULONGEST address, LONGEST length)
5828 int saved_remote_timeout = remote_timeout;
5829 enum packet_result ret;
5831 struct cleanup *back_to = make_cleanup (restore_remote_timeout,
5832 &saved_remote_timeout);
5833 remote_timeout = remote_flash_timeout;
5835 ret = remote_send_printf ("vFlashErase:%s,%s",
5836 paddr (address),
5837 phex (length, 4));
5838 switch (ret)
5840 case PACKET_UNKNOWN:
5841 error (_("Remote target does not support flash erase"));
5842 case PACKET_ERROR:
5843 error (_("Error erasing flash with vFlashErase packet"));
5844 default:
5845 break;
5848 do_cleanups (back_to);
5851 static LONGEST
5852 remote_flash_write (struct target_ops *ops,
5853 ULONGEST address, LONGEST length,
5854 const gdb_byte *data)
5856 int saved_remote_timeout = remote_timeout;
5857 int ret;
5858 struct cleanup *back_to = make_cleanup (restore_remote_timeout,
5859 &saved_remote_timeout);
5861 remote_timeout = remote_flash_timeout;
5862 ret = remote_write_bytes_aux ("vFlashWrite:", address, data, length, 'X', 0);
5863 do_cleanups (back_to);
5865 return ret;
5868 static void
5869 remote_flash_done (struct target_ops *ops)
5871 int saved_remote_timeout = remote_timeout;
5872 int ret;
5873 struct cleanup *back_to = make_cleanup (restore_remote_timeout,
5874 &saved_remote_timeout);
5876 remote_timeout = remote_flash_timeout;
5877 ret = remote_send_printf ("vFlashDone");
5878 do_cleanups (back_to);
5880 switch (ret)
5882 case PACKET_UNKNOWN:
5883 error (_("Remote target does not support vFlashDone"));
5884 case PACKET_ERROR:
5885 error (_("Error finishing flash operation"));
5886 default:
5887 break;
5891 static void
5892 remote_files_info (struct target_ops *ignore)
5894 puts_filtered ("Debugging a target over a serial line.\n");
5897 /* Stuff for dealing with the packets which are part of this protocol.
5898 See comment at top of file for details. */
5900 /* Read a single character from the remote end. */
5902 static int
5903 readchar (int timeout)
5905 int ch;
5907 ch = serial_readchar (remote_desc, timeout);
5909 if (ch >= 0)
5910 return ch;
5912 switch ((enum serial_rc) ch)
5914 case SERIAL_EOF:
5915 pop_target ();
5916 error (_("Remote connection closed"));
5917 /* no return */
5918 case SERIAL_ERROR:
5919 perror_with_name (_("Remote communication error"));
5920 /* no return */
5921 case SERIAL_TIMEOUT:
5922 break;
5924 return ch;
5927 /* Send the command in *BUF to the remote machine, and read the reply
5928 into *BUF. Report an error if we get an error reply. Resize
5929 *BUF using xrealloc if necessary to hold the result, and update
5930 *SIZEOF_BUF. */
5932 static void
5933 remote_send (char **buf,
5934 long *sizeof_buf)
5936 putpkt (*buf);
5937 getpkt (buf, sizeof_buf, 0);
5939 if ((*buf)[0] == 'E')
5940 error (_("Remote failure reply: %s"), *buf);
5943 /* Return a pointer to an xmalloc'ed string representing an escaped
5944 version of BUF, of len N. E.g. \n is converted to \\n, \t to \\t,
5945 etc. The caller is responsible for releasing the returned
5946 memory. */
5948 static char *
5949 escape_buffer (const char *buf, int n)
5951 struct cleanup *old_chain;
5952 struct ui_file *stb;
5953 char *str;
5954 long length;
5956 stb = mem_fileopen ();
5957 old_chain = make_cleanup_ui_file_delete (stb);
5959 fputstrn_unfiltered (buf, n, 0, stb);
5960 str = ui_file_xstrdup (stb, &length);
5961 do_cleanups (old_chain);
5962 return str;
5965 /* Display a null-terminated packet on stdout, for debugging, using C
5966 string notation. */
5968 static void
5969 print_packet (char *buf)
5971 puts_filtered ("\"");
5972 fputstr_filtered (buf, '"', gdb_stdout);
5973 puts_filtered ("\"");
5977 putpkt (char *buf)
5979 return putpkt_binary (buf, strlen (buf));
5982 /* Send a packet to the remote machine, with error checking. The data
5983 of the packet is in BUF. The string in BUF can be at most
5984 get_remote_packet_size () - 5 to account for the $, # and checksum,
5985 and for a possible /0 if we are debugging (remote_debug) and want
5986 to print the sent packet as a string. */
5988 static int
5989 putpkt_binary (char *buf, int cnt)
5991 struct remote_state *rs = get_remote_state ();
5992 int i;
5993 unsigned char csum = 0;
5994 char *buf2 = alloca (cnt + 6);
5996 int ch;
5997 int tcount = 0;
5998 char *p;
6000 /* Catch cases like trying to read memory or listing threads while
6001 we're waiting for a stop reply. The remote server wouldn't be
6002 ready to handle this request, so we'd hang and timeout. We don't
6003 have to worry about this in synchronous mode, because in that
6004 case it's not possible to issue a command while the target is
6005 running. This is not a problem in non-stop mode, because in that
6006 case, the stub is always ready to process serial input. */
6007 if (!non_stop && target_can_async_p () && rs->waiting_for_stop_reply)
6008 error (_("Cannot execute this command while the target is running."));
6010 /* We're sending out a new packet. Make sure we don't look at a
6011 stale cached response. */
6012 rs->cached_wait_status = 0;
6014 /* Copy the packet into buffer BUF2, encapsulating it
6015 and giving it a checksum. */
6017 p = buf2;
6018 *p++ = '$';
6020 for (i = 0; i < cnt; i++)
6022 csum += buf[i];
6023 *p++ = buf[i];
6025 *p++ = '#';
6026 *p++ = tohex ((csum >> 4) & 0xf);
6027 *p++ = tohex (csum & 0xf);
6029 /* Send it over and over until we get a positive ack. */
6031 while (1)
6033 int started_error_output = 0;
6035 if (remote_debug)
6037 struct cleanup *old_chain;
6038 char *str;
6040 *p = '\0';
6041 str = escape_buffer (buf2, p - buf2);
6042 old_chain = make_cleanup (xfree, str);
6043 fprintf_unfiltered (gdb_stdlog, "Sending packet: %s...", str);
6044 gdb_flush (gdb_stdlog);
6045 do_cleanups (old_chain);
6047 if (serial_write (remote_desc, buf2, p - buf2))
6048 perror_with_name (_("putpkt: write failed"));
6050 /* If this is a no acks version of the remote protocol, send the
6051 packet and move on. */
6052 if (rs->noack_mode)
6053 break;
6055 /* Read until either a timeout occurs (-2) or '+' is read.
6056 Handle any notification that arrives in the mean time. */
6057 while (1)
6059 ch = readchar (remote_timeout);
6061 if (remote_debug)
6063 switch (ch)
6065 case '+':
6066 case '-':
6067 case SERIAL_TIMEOUT:
6068 case '$':
6069 case '%':
6070 if (started_error_output)
6072 putchar_unfiltered ('\n');
6073 started_error_output = 0;
6078 switch (ch)
6080 case '+':
6081 if (remote_debug)
6082 fprintf_unfiltered (gdb_stdlog, "Ack\n");
6083 return 1;
6084 case '-':
6085 if (remote_debug)
6086 fprintf_unfiltered (gdb_stdlog, "Nak\n");
6087 case SERIAL_TIMEOUT:
6088 tcount++;
6089 if (tcount > 3)
6090 return 0;
6091 break; /* Retransmit buffer. */
6092 case '$':
6094 if (remote_debug)
6095 fprintf_unfiltered (gdb_stdlog,
6096 "Packet instead of Ack, ignoring it\n");
6097 /* It's probably an old response sent because an ACK
6098 was lost. Gobble up the packet and ack it so it
6099 doesn't get retransmitted when we resend this
6100 packet. */
6101 skip_frame ();
6102 serial_write (remote_desc, "+", 1);
6103 continue; /* Now, go look for +. */
6106 case '%':
6108 int val;
6110 /* If we got a notification, handle it, and go back to looking
6111 for an ack. */
6112 /* We've found the start of a notification. Now
6113 collect the data. */
6114 val = read_frame (&rs->buf, &rs->buf_size);
6115 if (val >= 0)
6117 if (remote_debug)
6119 struct cleanup *old_chain;
6120 char *str;
6122 str = escape_buffer (rs->buf, val);
6123 old_chain = make_cleanup (xfree, str);
6124 fprintf_unfiltered (gdb_stdlog,
6125 " Notification received: %s\n",
6126 str);
6127 do_cleanups (old_chain);
6129 handle_notification (rs->buf, val);
6130 /* We're in sync now, rewait for the ack. */
6131 tcount = 0;
6133 else
6135 if (remote_debug)
6137 if (!started_error_output)
6139 started_error_output = 1;
6140 fprintf_unfiltered (gdb_stdlog, "putpkt: Junk: ");
6142 fputc_unfiltered (ch & 0177, gdb_stdlog);
6143 fprintf_unfiltered (gdb_stdlog, "%s", rs->buf);
6146 continue;
6148 /* fall-through */
6149 default:
6150 if (remote_debug)
6152 if (!started_error_output)
6154 started_error_output = 1;
6155 fprintf_unfiltered (gdb_stdlog, "putpkt: Junk: ");
6157 fputc_unfiltered (ch & 0177, gdb_stdlog);
6159 continue;
6161 break; /* Here to retransmit. */
6164 #if 0
6165 /* This is wrong. If doing a long backtrace, the user should be
6166 able to get out next time we call QUIT, without anything as
6167 violent as interrupt_query. If we want to provide a way out of
6168 here without getting to the next QUIT, it should be based on
6169 hitting ^C twice as in remote_wait. */
6170 if (quit_flag)
6172 quit_flag = 0;
6173 interrupt_query ();
6175 #endif
6177 return 0;
6180 /* Come here after finding the start of a frame when we expected an
6181 ack. Do our best to discard the rest of this packet. */
6183 static void
6184 skip_frame (void)
6186 int c;
6188 while (1)
6190 c = readchar (remote_timeout);
6191 switch (c)
6193 case SERIAL_TIMEOUT:
6194 /* Nothing we can do. */
6195 return;
6196 case '#':
6197 /* Discard the two bytes of checksum and stop. */
6198 c = readchar (remote_timeout);
6199 if (c >= 0)
6200 c = readchar (remote_timeout);
6202 return;
6203 case '*': /* Run length encoding. */
6204 /* Discard the repeat count. */
6205 c = readchar (remote_timeout);
6206 if (c < 0)
6207 return;
6208 break;
6209 default:
6210 /* A regular character. */
6211 break;
6216 /* Come here after finding the start of the frame. Collect the rest
6217 into *BUF, verifying the checksum, length, and handling run-length
6218 compression. NUL terminate the buffer. If there is not enough room,
6219 expand *BUF using xrealloc.
6221 Returns -1 on error, number of characters in buffer (ignoring the
6222 trailing NULL) on success. (could be extended to return one of the
6223 SERIAL status indications). */
6225 static long
6226 read_frame (char **buf_p,
6227 long *sizeof_buf)
6229 unsigned char csum;
6230 long bc;
6231 int c;
6232 char *buf = *buf_p;
6233 struct remote_state *rs = get_remote_state ();
6235 csum = 0;
6236 bc = 0;
6238 while (1)
6240 c = readchar (remote_timeout);
6241 switch (c)
6243 case SERIAL_TIMEOUT:
6244 if (remote_debug)
6245 fputs_filtered ("Timeout in mid-packet, retrying\n", gdb_stdlog);
6246 return -1;
6247 case '$':
6248 if (remote_debug)
6249 fputs_filtered ("Saw new packet start in middle of old one\n",
6250 gdb_stdlog);
6251 return -1; /* Start a new packet, count retries. */
6252 case '#':
6254 unsigned char pktcsum;
6255 int check_0 = 0;
6256 int check_1 = 0;
6258 buf[bc] = '\0';
6260 check_0 = readchar (remote_timeout);
6261 if (check_0 >= 0)
6262 check_1 = readchar (remote_timeout);
6264 if (check_0 == SERIAL_TIMEOUT || check_1 == SERIAL_TIMEOUT)
6266 if (remote_debug)
6267 fputs_filtered ("Timeout in checksum, retrying\n",
6268 gdb_stdlog);
6269 return -1;
6271 else if (check_0 < 0 || check_1 < 0)
6273 if (remote_debug)
6274 fputs_filtered ("Communication error in checksum\n",
6275 gdb_stdlog);
6276 return -1;
6279 /* Don't recompute the checksum; with no ack packets we
6280 don't have any way to indicate a packet retransmission
6281 is necessary. */
6282 if (rs->noack_mode)
6283 return bc;
6285 pktcsum = (fromhex (check_0) << 4) | fromhex (check_1);
6286 if (csum == pktcsum)
6287 return bc;
6289 if (remote_debug)
6291 struct cleanup *old_chain;
6292 char *str;
6294 str = escape_buffer (buf, bc);
6295 old_chain = make_cleanup (xfree, str);
6296 fprintf_unfiltered (gdb_stdlog,
6298 Bad checksum, sentsum=0x%x, csum=0x%x, buf=%s\n",
6299 pktcsum, csum, str);
6300 do_cleanups (old_chain);
6302 /* Number of characters in buffer ignoring trailing
6303 NULL. */
6304 return -1;
6306 case '*': /* Run length encoding. */
6308 int repeat;
6309 csum += c;
6311 c = readchar (remote_timeout);
6312 csum += c;
6313 repeat = c - ' ' + 3; /* Compute repeat count. */
6315 /* The character before ``*'' is repeated. */
6317 if (repeat > 0 && repeat <= 255 && bc > 0)
6319 if (bc + repeat - 1 >= *sizeof_buf - 1)
6321 /* Make some more room in the buffer. */
6322 *sizeof_buf += repeat;
6323 *buf_p = xrealloc (*buf_p, *sizeof_buf);
6324 buf = *buf_p;
6327 memset (&buf[bc], buf[bc - 1], repeat);
6328 bc += repeat;
6329 continue;
6332 buf[bc] = '\0';
6333 printf_filtered (_("Invalid run length encoding: %s\n"), buf);
6334 return -1;
6336 default:
6337 if (bc >= *sizeof_buf - 1)
6339 /* Make some more room in the buffer. */
6340 *sizeof_buf *= 2;
6341 *buf_p = xrealloc (*buf_p, *sizeof_buf);
6342 buf = *buf_p;
6345 buf[bc++] = c;
6346 csum += c;
6347 continue;
6352 /* Read a packet from the remote machine, with error checking, and
6353 store it in *BUF. Resize *BUF using xrealloc if necessary to hold
6354 the result, and update *SIZEOF_BUF. If FOREVER, wait forever
6355 rather than timing out; this is used (in synchronous mode) to wait
6356 for a target that is is executing user code to stop. */
6357 /* FIXME: ezannoni 2000-02-01 this wrapper is necessary so that we
6358 don't have to change all the calls to getpkt to deal with the
6359 return value, because at the moment I don't know what the right
6360 thing to do it for those. */
6361 void
6362 getpkt (char **buf,
6363 long *sizeof_buf,
6364 int forever)
6366 int timed_out;
6368 timed_out = getpkt_sane (buf, sizeof_buf, forever);
6372 /* Read a packet from the remote machine, with error checking, and
6373 store it in *BUF. Resize *BUF using xrealloc if necessary to hold
6374 the result, and update *SIZEOF_BUF. If FOREVER, wait forever
6375 rather than timing out; this is used (in synchronous mode) to wait
6376 for a target that is is executing user code to stop. If FOREVER ==
6377 0, this function is allowed to time out gracefully and return an
6378 indication of this to the caller. Otherwise return the number of
6379 bytes read. If EXPECTING_NOTIF, consider receiving a notification
6380 enough reason to return to the caller. */
6382 static int
6383 getpkt_or_notif_sane_1 (char **buf, long *sizeof_buf, int forever,
6384 int expecting_notif)
6386 struct remote_state *rs = get_remote_state ();
6387 int c;
6388 int tries;
6389 int timeout;
6390 int val;
6392 /* We're reading a new response. Make sure we don't look at a
6393 previously cached response. */
6394 rs->cached_wait_status = 0;
6396 strcpy (*buf, "timeout");
6398 if (forever)
6399 timeout = watchdog > 0 ? watchdog : -1;
6400 else if (expecting_notif)
6401 timeout = 0; /* There should already be a char in the buffer. If
6402 not, bail out. */
6403 else
6404 timeout = remote_timeout;
6406 #define MAX_TRIES 3
6408 /* Process any number of notifications, and then return when
6409 we get a packet. */
6410 for (;;)
6412 /* If we get a timeout or bad checksm, retry up to MAX_TRIES
6413 times. */
6414 for (tries = 1; tries <= MAX_TRIES; tries++)
6416 /* This can loop forever if the remote side sends us
6417 characters continuously, but if it pauses, we'll get
6418 SERIAL_TIMEOUT from readchar because of timeout. Then
6419 we'll count that as a retry.
6421 Note that even when forever is set, we will only wait
6422 forever prior to the start of a packet. After that, we
6423 expect characters to arrive at a brisk pace. They should
6424 show up within remote_timeout intervals. */
6426 c = readchar (timeout);
6427 while (c != SERIAL_TIMEOUT && c != '$' && c != '%');
6429 if (c == SERIAL_TIMEOUT)
6431 if (expecting_notif)
6432 return -1; /* Don't complain, it's normal to not get
6433 anything in this case. */
6435 if (forever) /* Watchdog went off? Kill the target. */
6437 QUIT;
6438 pop_target ();
6439 error (_("Watchdog timeout has expired. Target detached."));
6441 if (remote_debug)
6442 fputs_filtered ("Timed out.\n", gdb_stdlog);
6444 else
6446 /* We've found the start of a packet or notification.
6447 Now collect the data. */
6448 val = read_frame (buf, sizeof_buf);
6449 if (val >= 0)
6450 break;
6453 serial_write (remote_desc, "-", 1);
6456 if (tries > MAX_TRIES)
6458 /* We have tried hard enough, and just can't receive the
6459 packet/notification. Give up. */
6460 printf_unfiltered (_("Ignoring packet error, continuing...\n"));
6462 /* Skip the ack char if we're in no-ack mode. */
6463 if (!rs->noack_mode)
6464 serial_write (remote_desc, "+", 1);
6465 return -1;
6468 /* If we got an ordinary packet, return that to our caller. */
6469 if (c == '$')
6471 if (remote_debug)
6473 struct cleanup *old_chain;
6474 char *str;
6476 str = escape_buffer (*buf, val);
6477 old_chain = make_cleanup (xfree, str);
6478 fprintf_unfiltered (gdb_stdlog, "Packet received: %s\n", str);
6479 do_cleanups (old_chain);
6482 /* Skip the ack char if we're in no-ack mode. */
6483 if (!rs->noack_mode)
6484 serial_write (remote_desc, "+", 1);
6485 return val;
6488 /* If we got a notification, handle it, and go back to looking
6489 for a packet. */
6490 else
6492 gdb_assert (c == '%');
6494 if (remote_debug)
6496 struct cleanup *old_chain;
6497 char *str;
6499 str = escape_buffer (*buf, val);
6500 old_chain = make_cleanup (xfree, str);
6501 fprintf_unfiltered (gdb_stdlog,
6502 " Notification received: %s\n",
6503 str);
6504 do_cleanups (old_chain);
6507 handle_notification (*buf, val);
6509 /* Notifications require no acknowledgement. */
6511 if (expecting_notif)
6512 return -1;
6517 static int
6518 getpkt_sane (char **buf, long *sizeof_buf, int forever)
6520 return getpkt_or_notif_sane_1 (buf, sizeof_buf, forever, 0);
6523 static int
6524 getpkt_or_notif_sane (char **buf, long *sizeof_buf, int forever)
6526 return getpkt_or_notif_sane_1 (buf, sizeof_buf, forever, 1);
6530 static void
6531 remote_kill (struct target_ops *ops)
6533 /* Use catch_errors so the user can quit from gdb even when we
6534 aren't on speaking terms with the remote system. */
6535 catch_errors ((catch_errors_ftype *) putpkt, "k", "", RETURN_MASK_ERROR);
6537 /* Don't wait for it to die. I'm not really sure it matters whether
6538 we do or not. For the existing stubs, kill is a noop. */
6539 target_mourn_inferior ();
6542 static int
6543 remote_vkill (int pid, struct remote_state *rs)
6545 if (remote_protocol_packets[PACKET_vKill].support == PACKET_DISABLE)
6546 return -1;
6548 /* Tell the remote target to detach. */
6549 sprintf (rs->buf, "vKill;%x", pid);
6550 putpkt (rs->buf);
6551 getpkt (&rs->buf, &rs->buf_size, 0);
6553 if (packet_ok (rs->buf,
6554 &remote_protocol_packets[PACKET_vKill]) == PACKET_OK)
6555 return 0;
6556 else if (remote_protocol_packets[PACKET_vKill].support == PACKET_DISABLE)
6557 return -1;
6558 else
6559 return 1;
6562 static void
6563 extended_remote_kill (struct target_ops *ops)
6565 int res;
6566 int pid = ptid_get_pid (inferior_ptid);
6567 struct remote_state *rs = get_remote_state ();
6569 res = remote_vkill (pid, rs);
6570 if (res == -1 && !remote_multi_process_p (rs))
6572 /* Don't try 'k' on a multi-process aware stub -- it has no way
6573 to specify the pid. */
6575 putpkt ("k");
6576 #if 0
6577 getpkt (&rs->buf, &rs->buf_size, 0);
6578 if (rs->buf[0] != 'O' || rs->buf[0] != 'K')
6579 res = 1;
6580 #else
6581 /* Don't wait for it to die. I'm not really sure it matters whether
6582 we do or not. For the existing stubs, kill is a noop. */
6583 res = 0;
6584 #endif
6587 if (res != 0)
6588 error (_("Can't kill process"));
6590 target_mourn_inferior ();
6593 static void
6594 remote_mourn (struct target_ops *ops)
6596 remote_mourn_1 (ops);
6599 /* Worker function for remote_mourn. */
6600 static void
6601 remote_mourn_1 (struct target_ops *target)
6603 unpush_target (target);
6605 /* remote_close takes care of doing most of the clean up. */
6606 generic_mourn_inferior ();
6609 static int
6610 select_new_thread_callback (struct thread_info *th, void* data)
6612 if (!is_exited (th->ptid))
6614 switch_to_thread (th->ptid);
6615 printf_filtered (_("[Switching to %s]\n"),
6616 target_pid_to_str (inferior_ptid));
6617 return 1;
6619 return 0;
6622 static void
6623 extended_remote_mourn_1 (struct target_ops *target)
6625 struct remote_state *rs = get_remote_state ();
6627 /* In case we got here due to an error, but we're going to stay
6628 connected. */
6629 rs->waiting_for_stop_reply = 0;
6631 /* We're no longer interested in these events. */
6632 discard_pending_stop_replies (ptid_get_pid (inferior_ptid));
6634 /* If the current general thread belonged to the process we just
6635 detached from or has exited, the remote side current general
6636 thread becomes undefined. Considering a case like this:
6638 - We just got here due to a detach.
6639 - The process that we're detaching from happens to immediately
6640 report a global breakpoint being hit in non-stop mode, in the
6641 same thread we had selected before.
6642 - GDB attaches to this process again.
6643 - This event happens to be the next event we handle.
6645 GDB would consider that the current general thread didn't need to
6646 be set on the stub side (with Hg), since for all it knew,
6647 GENERAL_THREAD hadn't changed.
6649 Notice that although in all-stop mode, the remote server always
6650 sets the current thread to the thread reporting the stop event,
6651 that doesn't happen in non-stop mode; in non-stop, the stub *must
6652 not* change the current thread when reporting a breakpoint hit,
6653 due to the decoupling of event reporting and event handling.
6655 To keep things simple, we always invalidate our notion of the
6656 current thread. */
6657 record_currthread (minus_one_ptid);
6659 /* Unlike "target remote", we do not want to unpush the target; then
6660 the next time the user says "run", we won't be connected. */
6662 /* Call common code to mark the inferior as not running. */
6663 generic_mourn_inferior ();
6665 if (have_inferiors ())
6667 extern void nullify_last_target_wait_ptid ();
6668 /* Multi-process case. The current process has exited, but
6669 there are other processes to debug. Switch to the first
6670 available. */
6671 iterate_over_threads (select_new_thread_callback, NULL);
6672 nullify_last_target_wait_ptid ();
6674 else
6676 if (!remote_multi_process_p (rs))
6678 /* Check whether the target is running now - some remote stubs
6679 automatically restart after kill. */
6680 putpkt ("?");
6681 getpkt (&rs->buf, &rs->buf_size, 0);
6683 if (rs->buf[0] == 'S' || rs->buf[0] == 'T')
6685 /* Assume that the target has been restarted. Set inferior_ptid
6686 so that bits of core GDB realizes there's something here, e.g.,
6687 so that the user can say "kill" again. */
6688 inferior_ptid = magic_null_ptid;
6690 else
6692 /* Mark this (still pushed) target as not executable until we
6693 restart it. */
6694 target_mark_exited (target);
6697 else
6698 /* Always remove execution if this was the last process. */
6699 target_mark_exited (target);
6703 static void
6704 extended_remote_mourn (struct target_ops *ops)
6706 extended_remote_mourn_1 (ops);
6709 static int
6710 extended_remote_run (char *args)
6712 struct remote_state *rs = get_remote_state ();
6713 char *p;
6714 int len;
6716 /* If the user has disabled vRun support, or we have detected that
6717 support is not available, do not try it. */
6718 if (remote_protocol_packets[PACKET_vRun].support == PACKET_DISABLE)
6719 return -1;
6721 strcpy (rs->buf, "vRun;");
6722 len = strlen (rs->buf);
6724 if (strlen (remote_exec_file) * 2 + len >= get_remote_packet_size ())
6725 error (_("Remote file name too long for run packet"));
6726 len += 2 * bin2hex ((gdb_byte *) remote_exec_file, rs->buf + len, 0);
6728 gdb_assert (args != NULL);
6729 if (*args)
6731 struct cleanup *back_to;
6732 int i;
6733 char **argv;
6735 argv = gdb_buildargv (args);
6736 back_to = make_cleanup ((void (*) (void *)) freeargv, argv);
6737 for (i = 0; argv[i] != NULL; i++)
6739 if (strlen (argv[i]) * 2 + 1 + len >= get_remote_packet_size ())
6740 error (_("Argument list too long for run packet"));
6741 rs->buf[len++] = ';';
6742 len += 2 * bin2hex ((gdb_byte *) argv[i], rs->buf + len, 0);
6744 do_cleanups (back_to);
6747 rs->buf[len++] = '\0';
6749 putpkt (rs->buf);
6750 getpkt (&rs->buf, &rs->buf_size, 0);
6752 if (packet_ok (rs->buf, &remote_protocol_packets[PACKET_vRun]) == PACKET_OK)
6754 /* We have a wait response; we don't need it, though. All is well. */
6755 return 0;
6757 else if (remote_protocol_packets[PACKET_vRun].support == PACKET_DISABLE)
6758 /* It wasn't disabled before, but it is now. */
6759 return -1;
6760 else
6762 if (remote_exec_file[0] == '\0')
6763 error (_("Running the default executable on the remote target failed; "
6764 "try \"set remote exec-file\"?"));
6765 else
6766 error (_("Running \"%s\" on the remote target failed"),
6767 remote_exec_file);
6771 /* In the extended protocol we want to be able to do things like
6772 "run" and have them basically work as expected. So we need
6773 a special create_inferior function. We support changing the
6774 executable file and the command line arguments, but not the
6775 environment. */
6777 static void
6778 extended_remote_create_inferior_1 (char *exec_file, char *args,
6779 char **env, int from_tty)
6781 /* If running asynchronously, register the target file descriptor
6782 with the event loop. */
6783 if (target_can_async_p ())
6784 target_async (inferior_event_handler, 0);
6786 /* Now restart the remote server. */
6787 if (extended_remote_run (args) == -1)
6789 /* vRun was not supported. Fail if we need it to do what the
6790 user requested. */
6791 if (remote_exec_file[0])
6792 error (_("Remote target does not support \"set remote exec-file\""));
6793 if (args[0])
6794 error (_("Remote target does not support \"set args\" or run <ARGS>"));
6796 /* Fall back to "R". */
6797 extended_remote_restart ();
6800 /* Clean up from the last time we ran, before we mark the target
6801 running again. This will mark breakpoints uninserted, and
6802 get_offsets may insert breakpoints. */
6803 init_thread_list ();
6804 init_wait_for_inferior ();
6806 /* Now mark the inferior as running before we do anything else. */
6807 inferior_ptid = magic_null_ptid;
6809 /* Now, if we have thread information, update inferior_ptid. */
6810 inferior_ptid = remote_current_thread (inferior_ptid);
6812 remote_add_inferior (ptid_get_pid (inferior_ptid), 0);
6813 add_thread_silent (inferior_ptid);
6815 /* Get updated offsets, if the stub uses qOffsets. */
6816 get_offsets ();
6819 static void
6820 extended_remote_create_inferior (struct target_ops *ops,
6821 char *exec_file, char *args,
6822 char **env, int from_tty)
6824 extended_remote_create_inferior_1 (exec_file, args, env, from_tty);
6828 /* Insert a breakpoint. On targets that have software breakpoint
6829 support, we ask the remote target to do the work; on targets
6830 which don't, we insert a traditional memory breakpoint. */
6832 static int
6833 remote_insert_breakpoint (struct bp_target_info *bp_tgt)
6835 /* Try the "Z" s/w breakpoint packet if it is not already disabled.
6836 If it succeeds, then set the support to PACKET_ENABLE. If it
6837 fails, and the user has explicitly requested the Z support then
6838 report an error, otherwise, mark it disabled and go on. */
6840 if (remote_protocol_packets[PACKET_Z0].support != PACKET_DISABLE)
6842 CORE_ADDR addr = bp_tgt->placed_address;
6843 struct remote_state *rs;
6844 char *p;
6845 int bpsize;
6847 gdbarch_breakpoint_from_pc (target_gdbarch, &addr, &bpsize);
6849 rs = get_remote_state ();
6850 p = rs->buf;
6852 *(p++) = 'Z';
6853 *(p++) = '0';
6854 *(p++) = ',';
6855 addr = (ULONGEST) remote_address_masked (addr);
6856 p += hexnumstr (p, addr);
6857 sprintf (p, ",%d", bpsize);
6859 putpkt (rs->buf);
6860 getpkt (&rs->buf, &rs->buf_size, 0);
6862 switch (packet_ok (rs->buf, &remote_protocol_packets[PACKET_Z0]))
6864 case PACKET_ERROR:
6865 return -1;
6866 case PACKET_OK:
6867 bp_tgt->placed_address = addr;
6868 bp_tgt->placed_size = bpsize;
6869 return 0;
6870 case PACKET_UNKNOWN:
6871 break;
6875 return memory_insert_breakpoint (bp_tgt);
6878 static int
6879 remote_remove_breakpoint (struct bp_target_info *bp_tgt)
6881 CORE_ADDR addr = bp_tgt->placed_address;
6882 struct remote_state *rs = get_remote_state ();
6883 int bp_size;
6885 if (remote_protocol_packets[PACKET_Z0].support != PACKET_DISABLE)
6887 char *p = rs->buf;
6889 *(p++) = 'z';
6890 *(p++) = '0';
6891 *(p++) = ',';
6893 addr = (ULONGEST) remote_address_masked (bp_tgt->placed_address);
6894 p += hexnumstr (p, addr);
6895 sprintf (p, ",%d", bp_tgt->placed_size);
6897 putpkt (rs->buf);
6898 getpkt (&rs->buf, &rs->buf_size, 0);
6900 return (rs->buf[0] == 'E');
6903 return memory_remove_breakpoint (bp_tgt);
6906 static int
6907 watchpoint_to_Z_packet (int type)
6909 switch (type)
6911 case hw_write:
6912 return Z_PACKET_WRITE_WP;
6913 break;
6914 case hw_read:
6915 return Z_PACKET_READ_WP;
6916 break;
6917 case hw_access:
6918 return Z_PACKET_ACCESS_WP;
6919 break;
6920 default:
6921 internal_error (__FILE__, __LINE__,
6922 _("hw_bp_to_z: bad watchpoint type %d"), type);
6926 static int
6927 remote_insert_watchpoint (CORE_ADDR addr, int len, int type)
6929 struct remote_state *rs = get_remote_state ();
6930 char *p;
6931 enum Z_packet_type packet = watchpoint_to_Z_packet (type);
6933 if (remote_protocol_packets[PACKET_Z0 + packet].support == PACKET_DISABLE)
6934 return -1;
6936 sprintf (rs->buf, "Z%x,", packet);
6937 p = strchr (rs->buf, '\0');
6938 addr = remote_address_masked (addr);
6939 p += hexnumstr (p, (ULONGEST) addr);
6940 sprintf (p, ",%x", len);
6942 putpkt (rs->buf);
6943 getpkt (&rs->buf, &rs->buf_size, 0);
6945 switch (packet_ok (rs->buf, &remote_protocol_packets[PACKET_Z0 + packet]))
6947 case PACKET_ERROR:
6948 case PACKET_UNKNOWN:
6949 return -1;
6950 case PACKET_OK:
6951 return 0;
6953 internal_error (__FILE__, __LINE__,
6954 _("remote_insert_watchpoint: reached end of function"));
6958 static int
6959 remote_remove_watchpoint (CORE_ADDR addr, int len, int type)
6961 struct remote_state *rs = get_remote_state ();
6962 char *p;
6963 enum Z_packet_type packet = watchpoint_to_Z_packet (type);
6965 if (remote_protocol_packets[PACKET_Z0 + packet].support == PACKET_DISABLE)
6966 return -1;
6968 sprintf (rs->buf, "z%x,", packet);
6969 p = strchr (rs->buf, '\0');
6970 addr = remote_address_masked (addr);
6971 p += hexnumstr (p, (ULONGEST) addr);
6972 sprintf (p, ",%x", len);
6973 putpkt (rs->buf);
6974 getpkt (&rs->buf, &rs->buf_size, 0);
6976 switch (packet_ok (rs->buf, &remote_protocol_packets[PACKET_Z0 + packet]))
6978 case PACKET_ERROR:
6979 case PACKET_UNKNOWN:
6980 return -1;
6981 case PACKET_OK:
6982 return 0;
6984 internal_error (__FILE__, __LINE__,
6985 _("remote_remove_watchpoint: reached end of function"));
6989 int remote_hw_watchpoint_limit = -1;
6990 int remote_hw_breakpoint_limit = -1;
6992 static int
6993 remote_check_watch_resources (int type, int cnt, int ot)
6995 if (type == bp_hardware_breakpoint)
6997 if (remote_hw_breakpoint_limit == 0)
6998 return 0;
6999 else if (remote_hw_breakpoint_limit < 0)
7000 return 1;
7001 else if (cnt <= remote_hw_breakpoint_limit)
7002 return 1;
7004 else
7006 if (remote_hw_watchpoint_limit == 0)
7007 return 0;
7008 else if (remote_hw_watchpoint_limit < 0)
7009 return 1;
7010 else if (ot)
7011 return -1;
7012 else if (cnt <= remote_hw_watchpoint_limit)
7013 return 1;
7015 return -1;
7018 static int
7019 remote_stopped_by_watchpoint (void)
7021 return remote_stopped_by_watchpoint_p;
7024 static int
7025 remote_stopped_data_address (struct target_ops *target, CORE_ADDR *addr_p)
7027 int rc = 0;
7028 if (remote_stopped_by_watchpoint ())
7030 *addr_p = remote_watch_data_address;
7031 rc = 1;
7034 return rc;
7038 static int
7039 remote_insert_hw_breakpoint (struct bp_target_info *bp_tgt)
7041 CORE_ADDR addr;
7042 struct remote_state *rs;
7043 char *p;
7045 /* The length field should be set to the size of a breakpoint
7046 instruction, even though we aren't inserting one ourselves. */
7048 gdbarch_breakpoint_from_pc
7049 (target_gdbarch, &bp_tgt->placed_address, &bp_tgt->placed_size);
7051 if (remote_protocol_packets[PACKET_Z1].support == PACKET_DISABLE)
7052 return -1;
7054 rs = get_remote_state ();
7055 p = rs->buf;
7057 *(p++) = 'Z';
7058 *(p++) = '1';
7059 *(p++) = ',';
7061 addr = remote_address_masked (bp_tgt->placed_address);
7062 p += hexnumstr (p, (ULONGEST) addr);
7063 sprintf (p, ",%x", bp_tgt->placed_size);
7065 putpkt (rs->buf);
7066 getpkt (&rs->buf, &rs->buf_size, 0);
7068 switch (packet_ok (rs->buf, &remote_protocol_packets[PACKET_Z1]))
7070 case PACKET_ERROR:
7071 case PACKET_UNKNOWN:
7072 return -1;
7073 case PACKET_OK:
7074 return 0;
7076 internal_error (__FILE__, __LINE__,
7077 _("remote_insert_hw_breakpoint: reached end of function"));
7081 static int
7082 remote_remove_hw_breakpoint (struct bp_target_info *bp_tgt)
7084 CORE_ADDR addr;
7085 struct remote_state *rs = get_remote_state ();
7086 char *p = rs->buf;
7088 if (remote_protocol_packets[PACKET_Z1].support == PACKET_DISABLE)
7089 return -1;
7091 *(p++) = 'z';
7092 *(p++) = '1';
7093 *(p++) = ',';
7095 addr = remote_address_masked (bp_tgt->placed_address);
7096 p += hexnumstr (p, (ULONGEST) addr);
7097 sprintf (p, ",%x", bp_tgt->placed_size);
7099 putpkt (rs->buf);
7100 getpkt (&rs->buf, &rs->buf_size, 0);
7102 switch (packet_ok (rs->buf, &remote_protocol_packets[PACKET_Z1]))
7104 case PACKET_ERROR:
7105 case PACKET_UNKNOWN:
7106 return -1;
7107 case PACKET_OK:
7108 return 0;
7110 internal_error (__FILE__, __LINE__,
7111 _("remote_remove_hw_breakpoint: reached end of function"));
7114 /* Table used by the crc32 function to calcuate the checksum. */
7116 static unsigned long crc32_table[256] =
7117 {0, 0};
7119 static unsigned long
7120 crc32 (unsigned char *buf, int len, unsigned int crc)
7122 if (!crc32_table[1])
7124 /* Initialize the CRC table and the decoding table. */
7125 int i, j;
7126 unsigned int c;
7128 for (i = 0; i < 256; i++)
7130 for (c = i << 24, j = 8; j > 0; --j)
7131 c = c & 0x80000000 ? (c << 1) ^ 0x04c11db7 : (c << 1);
7132 crc32_table[i] = c;
7136 while (len--)
7138 crc = (crc << 8) ^ crc32_table[((crc >> 24) ^ *buf) & 255];
7139 buf++;
7141 return crc;
7144 /* compare-sections command
7146 With no arguments, compares each loadable section in the exec bfd
7147 with the same memory range on the target, and reports mismatches.
7148 Useful for verifying the image on the target against the exec file.
7149 Depends on the target understanding the new "qCRC:" request. */
7151 /* FIXME: cagney/1999-10-26: This command should be broken down into a
7152 target method (target verify memory) and generic version of the
7153 actual command. This will allow other high-level code (especially
7154 generic_load()) to make use of this target functionality. */
7156 static void
7157 compare_sections_command (char *args, int from_tty)
7159 struct remote_state *rs = get_remote_state ();
7160 asection *s;
7161 unsigned long host_crc, target_crc;
7162 extern bfd *exec_bfd;
7163 struct cleanup *old_chain;
7164 char *tmp;
7165 char *sectdata;
7166 const char *sectname;
7167 bfd_size_type size;
7168 bfd_vma lma;
7169 int matched = 0;
7170 int mismatched = 0;
7172 if (!exec_bfd)
7173 error (_("command cannot be used without an exec file"));
7174 if (!current_target.to_shortname ||
7175 strcmp (current_target.to_shortname, "remote") != 0)
7176 error (_("command can only be used with remote target"));
7178 for (s = exec_bfd->sections; s; s = s->next)
7180 if (!(s->flags & SEC_LOAD))
7181 continue; /* skip non-loadable section */
7183 size = bfd_get_section_size (s);
7184 if (size == 0)
7185 continue; /* skip zero-length section */
7187 sectname = bfd_get_section_name (exec_bfd, s);
7188 if (args && strcmp (args, sectname) != 0)
7189 continue; /* not the section selected by user */
7191 matched = 1; /* do this section */
7192 lma = s->lma;
7193 /* FIXME: assumes lma can fit into long. */
7194 xsnprintf (rs->buf, get_remote_packet_size (), "qCRC:%lx,%lx",
7195 (long) lma, (long) size);
7196 putpkt (rs->buf);
7198 /* Be clever; compute the host_crc before waiting for target
7199 reply. */
7200 sectdata = xmalloc (size);
7201 old_chain = make_cleanup (xfree, sectdata);
7202 bfd_get_section_contents (exec_bfd, s, sectdata, 0, size);
7203 host_crc = crc32 ((unsigned char *) sectdata, size, 0xffffffff);
7205 getpkt (&rs->buf, &rs->buf_size, 0);
7206 if (rs->buf[0] == 'E')
7207 error (_("target memory fault, section %s, range 0x%s -- 0x%s"),
7208 sectname, paddr (lma), paddr (lma + size));
7209 if (rs->buf[0] != 'C')
7210 error (_("remote target does not support this operation"));
7212 for (target_crc = 0, tmp = &rs->buf[1]; *tmp; tmp++)
7213 target_crc = target_crc * 16 + fromhex (*tmp);
7215 printf_filtered ("Section %s, range 0x%s -- 0x%s: ",
7216 sectname, paddr (lma), paddr (lma + size));
7217 if (host_crc == target_crc)
7218 printf_filtered ("matched.\n");
7219 else
7221 printf_filtered ("MIS-MATCHED!\n");
7222 mismatched++;
7225 do_cleanups (old_chain);
7227 if (mismatched > 0)
7228 warning (_("One or more sections of the remote executable does not match\n\
7229 the loaded file\n"));
7230 if (args && !matched)
7231 printf_filtered (_("No loaded section named '%s'.\n"), args);
7234 /* Write LEN bytes from WRITEBUF into OBJECT_NAME/ANNEX at OFFSET
7235 into remote target. The number of bytes written to the remote
7236 target is returned, or -1 for error. */
7238 static LONGEST
7239 remote_write_qxfer (struct target_ops *ops, const char *object_name,
7240 const char *annex, const gdb_byte *writebuf,
7241 ULONGEST offset, LONGEST len,
7242 struct packet_config *packet)
7244 int i, buf_len;
7245 ULONGEST n;
7246 gdb_byte *wbuf;
7247 struct remote_state *rs = get_remote_state ();
7248 int max_size = get_memory_write_packet_size ();
7250 if (packet->support == PACKET_DISABLE)
7251 return -1;
7253 /* Insert header. */
7254 i = snprintf (rs->buf, max_size,
7255 "qXfer:%s:write:%s:%s:",
7256 object_name, annex ? annex : "",
7257 phex_nz (offset, sizeof offset));
7258 max_size -= (i + 1);
7260 /* Escape as much data as fits into rs->buf. */
7261 buf_len = remote_escape_output
7262 (writebuf, len, (rs->buf + i), &max_size, max_size);
7264 if (putpkt_binary (rs->buf, i + buf_len) < 0
7265 || getpkt_sane (&rs->buf, &rs->buf_size, 0) < 0
7266 || packet_ok (rs->buf, packet) != PACKET_OK)
7267 return -1;
7269 unpack_varlen_hex (rs->buf, &n);
7270 return n;
7273 /* Read OBJECT_NAME/ANNEX from the remote target using a qXfer packet.
7274 Data at OFFSET, of up to LEN bytes, is read into READBUF; the
7275 number of bytes read is returned, or 0 for EOF, or -1 for error.
7276 The number of bytes read may be less than LEN without indicating an
7277 EOF. PACKET is checked and updated to indicate whether the remote
7278 target supports this object. */
7280 static LONGEST
7281 remote_read_qxfer (struct target_ops *ops, const char *object_name,
7282 const char *annex,
7283 gdb_byte *readbuf, ULONGEST offset, LONGEST len,
7284 struct packet_config *packet)
7286 static char *finished_object;
7287 static char *finished_annex;
7288 static ULONGEST finished_offset;
7290 struct remote_state *rs = get_remote_state ();
7291 unsigned int total = 0;
7292 LONGEST i, n, packet_len;
7294 if (packet->support == PACKET_DISABLE)
7295 return -1;
7297 /* Check whether we've cached an end-of-object packet that matches
7298 this request. */
7299 if (finished_object)
7301 if (strcmp (object_name, finished_object) == 0
7302 && strcmp (annex ? annex : "", finished_annex) == 0
7303 && offset == finished_offset)
7304 return 0;
7306 /* Otherwise, we're now reading something different. Discard
7307 the cache. */
7308 xfree (finished_object);
7309 xfree (finished_annex);
7310 finished_object = NULL;
7311 finished_annex = NULL;
7314 /* Request only enough to fit in a single packet. The actual data
7315 may not, since we don't know how much of it will need to be escaped;
7316 the target is free to respond with slightly less data. We subtract
7317 five to account for the response type and the protocol frame. */
7318 n = min (get_remote_packet_size () - 5, len);
7319 snprintf (rs->buf, get_remote_packet_size () - 4, "qXfer:%s:read:%s:%s,%s",
7320 object_name, annex ? annex : "",
7321 phex_nz (offset, sizeof offset),
7322 phex_nz (n, sizeof n));
7323 i = putpkt (rs->buf);
7324 if (i < 0)
7325 return -1;
7327 rs->buf[0] = '\0';
7328 packet_len = getpkt_sane (&rs->buf, &rs->buf_size, 0);
7329 if (packet_len < 0 || packet_ok (rs->buf, packet) != PACKET_OK)
7330 return -1;
7332 if (rs->buf[0] != 'l' && rs->buf[0] != 'm')
7333 error (_("Unknown remote qXfer reply: %s"), rs->buf);
7335 /* 'm' means there is (or at least might be) more data after this
7336 batch. That does not make sense unless there's at least one byte
7337 of data in this reply. */
7338 if (rs->buf[0] == 'm' && packet_len == 1)
7339 error (_("Remote qXfer reply contained no data."));
7341 /* Got some data. */
7342 i = remote_unescape_input (rs->buf + 1, packet_len - 1, readbuf, n);
7344 /* 'l' is an EOF marker, possibly including a final block of data,
7345 or possibly empty. If we have the final block of a non-empty
7346 object, record this fact to bypass a subsequent partial read. */
7347 if (rs->buf[0] == 'l' && offset + i > 0)
7349 finished_object = xstrdup (object_name);
7350 finished_annex = xstrdup (annex ? annex : "");
7351 finished_offset = offset + i;
7354 return i;
7357 static LONGEST
7358 remote_xfer_partial (struct target_ops *ops, enum target_object object,
7359 const char *annex, gdb_byte *readbuf,
7360 const gdb_byte *writebuf, ULONGEST offset, LONGEST len)
7362 struct remote_state *rs;
7363 int i;
7364 char *p2;
7365 char query_type;
7367 set_general_thread (inferior_ptid);
7369 rs = get_remote_state ();
7371 /* Handle memory using the standard memory routines. */
7372 if (object == TARGET_OBJECT_MEMORY)
7374 int xfered;
7375 errno = 0;
7377 /* If the remote target is connected but not running, we should
7378 pass this request down to a lower stratum (e.g. the executable
7379 file). */
7380 if (!target_has_execution)
7381 return 0;
7383 if (writebuf != NULL)
7384 xfered = remote_write_bytes (offset, writebuf, len);
7385 else
7386 xfered = remote_read_bytes (offset, readbuf, len);
7388 if (xfered > 0)
7389 return xfered;
7390 else if (xfered == 0 && errno == 0)
7391 return 0;
7392 else
7393 return -1;
7396 /* Handle SPU memory using qxfer packets. */
7397 if (object == TARGET_OBJECT_SPU)
7399 if (readbuf)
7400 return remote_read_qxfer (ops, "spu", annex, readbuf, offset, len,
7401 &remote_protocol_packets
7402 [PACKET_qXfer_spu_read]);
7403 else
7404 return remote_write_qxfer (ops, "spu", annex, writebuf, offset, len,
7405 &remote_protocol_packets
7406 [PACKET_qXfer_spu_write]);
7409 /* Handle extra signal info using qxfer packets. */
7410 if (object == TARGET_OBJECT_SIGNAL_INFO)
7412 if (readbuf)
7413 return remote_read_qxfer (ops, "siginfo", annex, readbuf, offset, len,
7414 &remote_protocol_packets
7415 [PACKET_qXfer_siginfo_read]);
7416 else
7417 return remote_write_qxfer (ops, "siginfo", annex, writebuf, offset, len,
7418 &remote_protocol_packets
7419 [PACKET_qXfer_siginfo_write]);
7422 /* Only handle flash writes. */
7423 if (writebuf != NULL)
7425 LONGEST xfered;
7427 switch (object)
7429 case TARGET_OBJECT_FLASH:
7430 xfered = remote_flash_write (ops, offset, len, writebuf);
7432 if (xfered > 0)
7433 return xfered;
7434 else if (xfered == 0 && errno == 0)
7435 return 0;
7436 else
7437 return -1;
7439 default:
7440 return -1;
7444 /* Map pre-existing objects onto letters. DO NOT do this for new
7445 objects!!! Instead specify new query packets. */
7446 switch (object)
7448 case TARGET_OBJECT_AVR:
7449 query_type = 'R';
7450 break;
7452 case TARGET_OBJECT_AUXV:
7453 gdb_assert (annex == NULL);
7454 return remote_read_qxfer (ops, "auxv", annex, readbuf, offset, len,
7455 &remote_protocol_packets[PACKET_qXfer_auxv]);
7457 case TARGET_OBJECT_AVAILABLE_FEATURES:
7458 return remote_read_qxfer
7459 (ops, "features", annex, readbuf, offset, len,
7460 &remote_protocol_packets[PACKET_qXfer_features]);
7462 case TARGET_OBJECT_LIBRARIES:
7463 return remote_read_qxfer
7464 (ops, "libraries", annex, readbuf, offset, len,
7465 &remote_protocol_packets[PACKET_qXfer_libraries]);
7467 case TARGET_OBJECT_MEMORY_MAP:
7468 gdb_assert (annex == NULL);
7469 return remote_read_qxfer (ops, "memory-map", annex, readbuf, offset, len,
7470 &remote_protocol_packets[PACKET_qXfer_memory_map]);
7472 case TARGET_OBJECT_OSDATA:
7473 /* Should only get here if we're connected. */
7474 gdb_assert (remote_desc);
7475 return remote_read_qxfer
7476 (ops, "osdata", annex, readbuf, offset, len,
7477 &remote_protocol_packets[PACKET_qXfer_osdata]);
7479 default:
7480 return -1;
7483 /* Note: a zero OFFSET and LEN can be used to query the minimum
7484 buffer size. */
7485 if (offset == 0 && len == 0)
7486 return (get_remote_packet_size ());
7487 /* Minimum outbuf size is get_remote_packet_size (). If LEN is not
7488 large enough let the caller deal with it. */
7489 if (len < get_remote_packet_size ())
7490 return -1;
7491 len = get_remote_packet_size ();
7493 /* Except for querying the minimum buffer size, target must be open. */
7494 if (!remote_desc)
7495 error (_("remote query is only available after target open"));
7497 gdb_assert (annex != NULL);
7498 gdb_assert (readbuf != NULL);
7500 p2 = rs->buf;
7501 *p2++ = 'q';
7502 *p2++ = query_type;
7504 /* We used one buffer char for the remote protocol q command and
7505 another for the query type. As the remote protocol encapsulation
7506 uses 4 chars plus one extra in case we are debugging
7507 (remote_debug), we have PBUFZIZ - 7 left to pack the query
7508 string. */
7509 i = 0;
7510 while (annex[i] && (i < (get_remote_packet_size () - 8)))
7512 /* Bad caller may have sent forbidden characters. */
7513 gdb_assert (isprint (annex[i]) && annex[i] != '$' && annex[i] != '#');
7514 *p2++ = annex[i];
7515 i++;
7517 *p2 = '\0';
7518 gdb_assert (annex[i] == '\0');
7520 i = putpkt (rs->buf);
7521 if (i < 0)
7522 return i;
7524 getpkt (&rs->buf, &rs->buf_size, 0);
7525 strcpy ((char *) readbuf, rs->buf);
7527 return strlen ((char *) readbuf);
7530 static int
7531 remote_search_memory (struct target_ops* ops,
7532 CORE_ADDR start_addr, ULONGEST search_space_len,
7533 const gdb_byte *pattern, ULONGEST pattern_len,
7534 CORE_ADDR *found_addrp)
7536 struct remote_state *rs = get_remote_state ();
7537 int max_size = get_memory_write_packet_size ();
7538 struct packet_config *packet =
7539 &remote_protocol_packets[PACKET_qSearch_memory];
7540 /* number of packet bytes used to encode the pattern,
7541 this could be more than PATTERN_LEN due to escape characters */
7542 int escaped_pattern_len;
7543 /* amount of pattern that was encodable in the packet */
7544 int used_pattern_len;
7545 int i;
7546 int found;
7547 ULONGEST found_addr;
7549 /* Don't go to the target if we don't have to.
7550 This is done before checking packet->support to avoid the possibility that
7551 a success for this edge case means the facility works in general. */
7552 if (pattern_len > search_space_len)
7553 return 0;
7554 if (pattern_len == 0)
7556 *found_addrp = start_addr;
7557 return 1;
7560 /* If we already know the packet isn't supported, fall back to the simple
7561 way of searching memory. */
7563 if (packet->support == PACKET_DISABLE)
7565 /* Target doesn't provided special support, fall back and use the
7566 standard support (copy memory and do the search here). */
7567 return simple_search_memory (ops, start_addr, search_space_len,
7568 pattern, pattern_len, found_addrp);
7571 /* Insert header. */
7572 i = snprintf (rs->buf, max_size,
7573 "qSearch:memory:%s;%s;",
7574 paddr_nz (start_addr),
7575 phex_nz (search_space_len, sizeof (search_space_len)));
7576 max_size -= (i + 1);
7578 /* Escape as much data as fits into rs->buf. */
7579 escaped_pattern_len =
7580 remote_escape_output (pattern, pattern_len, (rs->buf + i),
7581 &used_pattern_len, max_size);
7583 /* Bail if the pattern is too large. */
7584 if (used_pattern_len != pattern_len)
7585 error ("Pattern is too large to transmit to remote target.");
7587 if (putpkt_binary (rs->buf, i + escaped_pattern_len) < 0
7588 || getpkt_sane (&rs->buf, &rs->buf_size, 0) < 0
7589 || packet_ok (rs->buf, packet) != PACKET_OK)
7591 /* The request may not have worked because the command is not
7592 supported. If so, fall back to the simple way. */
7593 if (packet->support == PACKET_DISABLE)
7595 return simple_search_memory (ops, start_addr, search_space_len,
7596 pattern, pattern_len, found_addrp);
7598 return -1;
7601 if (rs->buf[0] == '0')
7602 found = 0;
7603 else if (rs->buf[0] == '1')
7605 found = 1;
7606 if (rs->buf[1] != ',')
7607 error (_("Unknown qSearch:memory reply: %s"), rs->buf);
7608 unpack_varlen_hex (rs->buf + 2, &found_addr);
7609 *found_addrp = found_addr;
7611 else
7612 error (_("Unknown qSearch:memory reply: %s"), rs->buf);
7614 return found;
7617 static void
7618 remote_rcmd (char *command,
7619 struct ui_file *outbuf)
7621 struct remote_state *rs = get_remote_state ();
7622 char *p = rs->buf;
7624 if (!remote_desc)
7625 error (_("remote rcmd is only available after target open"));
7627 /* Send a NULL command across as an empty command. */
7628 if (command == NULL)
7629 command = "";
7631 /* The query prefix. */
7632 strcpy (rs->buf, "qRcmd,");
7633 p = strchr (rs->buf, '\0');
7635 if ((strlen (rs->buf) + strlen (command) * 2 + 8/*misc*/) > get_remote_packet_size ())
7636 error (_("\"monitor\" command ``%s'' is too long."), command);
7638 /* Encode the actual command. */
7639 bin2hex ((gdb_byte *) command, p, 0);
7641 if (putpkt (rs->buf) < 0)
7642 error (_("Communication problem with target."));
7644 /* get/display the response */
7645 while (1)
7647 char *buf;
7649 /* XXX - see also tracepoint.c:remote_get_noisy_reply(). */
7650 rs->buf[0] = '\0';
7651 getpkt (&rs->buf, &rs->buf_size, 0);
7652 buf = rs->buf;
7653 if (buf[0] == '\0')
7654 error (_("Target does not support this command."));
7655 if (buf[0] == 'O' && buf[1] != 'K')
7657 remote_console_output (buf + 1); /* 'O' message from stub. */
7658 continue;
7660 if (strcmp (buf, "OK") == 0)
7661 break;
7662 if (strlen (buf) == 3 && buf[0] == 'E'
7663 && isdigit (buf[1]) && isdigit (buf[2]))
7665 error (_("Protocol error with Rcmd"));
7667 for (p = buf; p[0] != '\0' && p[1] != '\0'; p += 2)
7669 char c = (fromhex (p[0]) << 4) + fromhex (p[1]);
7670 fputc_unfiltered (c, outbuf);
7672 break;
7676 static VEC(mem_region_s) *
7677 remote_memory_map (struct target_ops *ops)
7679 VEC(mem_region_s) *result = NULL;
7680 char *text = target_read_stralloc (&current_target,
7681 TARGET_OBJECT_MEMORY_MAP, NULL);
7683 if (text)
7685 struct cleanup *back_to = make_cleanup (xfree, text);
7686 result = parse_memory_map (text);
7687 do_cleanups (back_to);
7690 return result;
7693 static void
7694 packet_command (char *args, int from_tty)
7696 struct remote_state *rs = get_remote_state ();
7698 if (!remote_desc)
7699 error (_("command can only be used with remote target"));
7701 if (!args)
7702 error (_("remote-packet command requires packet text as argument"));
7704 puts_filtered ("sending: ");
7705 print_packet (args);
7706 puts_filtered ("\n");
7707 putpkt (args);
7709 getpkt (&rs->buf, &rs->buf_size, 0);
7710 puts_filtered ("received: ");
7711 print_packet (rs->buf);
7712 puts_filtered ("\n");
7715 #if 0
7716 /* --------- UNIT_TEST for THREAD oriented PACKETS ------------------- */
7718 static void display_thread_info (struct gdb_ext_thread_info *info);
7720 static void threadset_test_cmd (char *cmd, int tty);
7722 static void threadalive_test (char *cmd, int tty);
7724 static void threadlist_test_cmd (char *cmd, int tty);
7726 int get_and_display_threadinfo (threadref *ref);
7728 static void threadinfo_test_cmd (char *cmd, int tty);
7730 static int thread_display_step (threadref *ref, void *context);
7732 static void threadlist_update_test_cmd (char *cmd, int tty);
7734 static void init_remote_threadtests (void);
7736 #define SAMPLE_THREAD 0x05060708 /* Truncated 64 bit threadid. */
7738 static void
7739 threadset_test_cmd (char *cmd, int tty)
7741 int sample_thread = SAMPLE_THREAD;
7743 printf_filtered (_("Remote threadset test\n"));
7744 set_general_thread (sample_thread);
7748 static void
7749 threadalive_test (char *cmd, int tty)
7751 int sample_thread = SAMPLE_THREAD;
7752 int pid = ptid_get_pid (inferior_ptid);
7753 ptid_t ptid = ptid_build (pid, 0, sample_thread);
7755 if (remote_thread_alive (ptid))
7756 printf_filtered ("PASS: Thread alive test\n");
7757 else
7758 printf_filtered ("FAIL: Thread alive test\n");
7761 void output_threadid (char *title, threadref *ref);
7763 void
7764 output_threadid (char *title, threadref *ref)
7766 char hexid[20];
7768 pack_threadid (&hexid[0], ref); /* Convert threead id into hex. */
7769 hexid[16] = 0;
7770 printf_filtered ("%s %s\n", title, (&hexid[0]));
7773 static void
7774 threadlist_test_cmd (char *cmd, int tty)
7776 int startflag = 1;
7777 threadref nextthread;
7778 int done, result_count;
7779 threadref threadlist[3];
7781 printf_filtered ("Remote Threadlist test\n");
7782 if (!remote_get_threadlist (startflag, &nextthread, 3, &done,
7783 &result_count, &threadlist[0]))
7784 printf_filtered ("FAIL: threadlist test\n");
7785 else
7787 threadref *scan = threadlist;
7788 threadref *limit = scan + result_count;
7790 while (scan < limit)
7791 output_threadid (" thread ", scan++);
7795 void
7796 display_thread_info (struct gdb_ext_thread_info *info)
7798 output_threadid ("Threadid: ", &info->threadid);
7799 printf_filtered ("Name: %s\n ", info->shortname);
7800 printf_filtered ("State: %s\n", info->display);
7801 printf_filtered ("other: %s\n\n", info->more_display);
7805 get_and_display_threadinfo (threadref *ref)
7807 int result;
7808 int set;
7809 struct gdb_ext_thread_info threadinfo;
7811 set = TAG_THREADID | TAG_EXISTS | TAG_THREADNAME
7812 | TAG_MOREDISPLAY | TAG_DISPLAY;
7813 if (0 != (result = remote_get_threadinfo (ref, set, &threadinfo)))
7814 display_thread_info (&threadinfo);
7815 return result;
7818 static void
7819 threadinfo_test_cmd (char *cmd, int tty)
7821 int athread = SAMPLE_THREAD;
7822 threadref thread;
7823 int set;
7825 int_to_threadref (&thread, athread);
7826 printf_filtered ("Remote Threadinfo test\n");
7827 if (!get_and_display_threadinfo (&thread))
7828 printf_filtered ("FAIL cannot get thread info\n");
7831 static int
7832 thread_display_step (threadref *ref, void *context)
7834 /* output_threadid(" threadstep ",ref); *//* simple test */
7835 return get_and_display_threadinfo (ref);
7838 static void
7839 threadlist_update_test_cmd (char *cmd, int tty)
7841 printf_filtered ("Remote Threadlist update test\n");
7842 remote_threadlist_iterator (thread_display_step, 0, CRAZY_MAX_THREADS);
7845 static void
7846 init_remote_threadtests (void)
7848 add_com ("tlist", class_obscure, threadlist_test_cmd, _("\
7849 Fetch and print the remote list of thread identifiers, one pkt only"));
7850 add_com ("tinfo", class_obscure, threadinfo_test_cmd,
7851 _("Fetch and display info about one thread"));
7852 add_com ("tset", class_obscure, threadset_test_cmd,
7853 _("Test setting to a different thread"));
7854 add_com ("tupd", class_obscure, threadlist_update_test_cmd,
7855 _("Iterate through updating all remote thread info"));
7856 add_com ("talive", class_obscure, threadalive_test,
7857 _(" Remote thread alive test "));
7860 #endif /* 0 */
7862 /* Convert a thread ID to a string. Returns the string in a static
7863 buffer. */
7865 static char *
7866 remote_pid_to_str (struct target_ops *ops, ptid_t ptid)
7868 static char buf[64];
7869 struct remote_state *rs = get_remote_state ();
7871 if (ptid_equal (magic_null_ptid, ptid))
7873 xsnprintf (buf, sizeof buf, "Thread <main>");
7874 return buf;
7876 else if (remote_multi_process_p (rs)
7877 && ptid_get_tid (ptid) != 0 && ptid_get_pid (ptid) != 0)
7879 xsnprintf (buf, sizeof buf, "Thread %d.%ld",
7880 ptid_get_pid (ptid), ptid_get_tid (ptid));
7881 return buf;
7883 else if (ptid_get_tid (ptid) != 0)
7885 xsnprintf (buf, sizeof buf, "Thread %ld",
7886 ptid_get_tid (ptid));
7887 return buf;
7890 return normal_pid_to_str (ptid);
7893 /* Get the address of the thread local variable in OBJFILE which is
7894 stored at OFFSET within the thread local storage for thread PTID. */
7896 static CORE_ADDR
7897 remote_get_thread_local_address (struct target_ops *ops,
7898 ptid_t ptid, CORE_ADDR lm, CORE_ADDR offset)
7900 if (remote_protocol_packets[PACKET_qGetTLSAddr].support != PACKET_DISABLE)
7902 struct remote_state *rs = get_remote_state ();
7903 char *p = rs->buf;
7904 char *endp = rs->buf + get_remote_packet_size ();
7905 enum packet_result result;
7907 strcpy (p, "qGetTLSAddr:");
7908 p += strlen (p);
7909 p = write_ptid (p, endp, ptid);
7910 *p++ = ',';
7911 p += hexnumstr (p, offset);
7912 *p++ = ',';
7913 p += hexnumstr (p, lm);
7914 *p++ = '\0';
7916 putpkt (rs->buf);
7917 getpkt (&rs->buf, &rs->buf_size, 0);
7918 result = packet_ok (rs->buf, &remote_protocol_packets[PACKET_qGetTLSAddr]);
7919 if (result == PACKET_OK)
7921 ULONGEST result;
7923 unpack_varlen_hex (rs->buf, &result);
7924 return result;
7926 else if (result == PACKET_UNKNOWN)
7927 throw_error (TLS_GENERIC_ERROR,
7928 _("Remote target doesn't support qGetTLSAddr packet"));
7929 else
7930 throw_error (TLS_GENERIC_ERROR,
7931 _("Remote target failed to process qGetTLSAddr request"));
7933 else
7934 throw_error (TLS_GENERIC_ERROR,
7935 _("TLS not supported or disabled on this target"));
7936 /* Not reached. */
7937 return 0;
7940 /* Support for inferring a target description based on the current
7941 architecture and the size of a 'g' packet. While the 'g' packet
7942 can have any size (since optional registers can be left off the
7943 end), some sizes are easily recognizable given knowledge of the
7944 approximate architecture. */
7946 struct remote_g_packet_guess
7948 int bytes;
7949 const struct target_desc *tdesc;
7951 typedef struct remote_g_packet_guess remote_g_packet_guess_s;
7952 DEF_VEC_O(remote_g_packet_guess_s);
7954 struct remote_g_packet_data
7956 VEC(remote_g_packet_guess_s) *guesses;
7959 static struct gdbarch_data *remote_g_packet_data_handle;
7961 static void *
7962 remote_g_packet_data_init (struct obstack *obstack)
7964 return OBSTACK_ZALLOC (obstack, struct remote_g_packet_data);
7967 void
7968 register_remote_g_packet_guess (struct gdbarch *gdbarch, int bytes,
7969 const struct target_desc *tdesc)
7971 struct remote_g_packet_data *data
7972 = gdbarch_data (gdbarch, remote_g_packet_data_handle);
7973 struct remote_g_packet_guess new_guess, *guess;
7974 int ix;
7976 gdb_assert (tdesc != NULL);
7978 for (ix = 0;
7979 VEC_iterate (remote_g_packet_guess_s, data->guesses, ix, guess);
7980 ix++)
7981 if (guess->bytes == bytes)
7982 internal_error (__FILE__, __LINE__,
7983 "Duplicate g packet description added for size %d",
7984 bytes);
7986 new_guess.bytes = bytes;
7987 new_guess.tdesc = tdesc;
7988 VEC_safe_push (remote_g_packet_guess_s, data->guesses, &new_guess);
7991 /* Return 1 if remote_read_description would do anything on this target
7992 and architecture, 0 otherwise. */
7994 static int
7995 remote_read_description_p (struct target_ops *target)
7997 struct remote_g_packet_data *data
7998 = gdbarch_data (target_gdbarch, remote_g_packet_data_handle);
8000 if (!VEC_empty (remote_g_packet_guess_s, data->guesses))
8001 return 1;
8003 return 0;
8006 static const struct target_desc *
8007 remote_read_description (struct target_ops *target)
8009 struct remote_g_packet_data *data
8010 = gdbarch_data (target_gdbarch, remote_g_packet_data_handle);
8012 /* Do not try this during initial connection, when we do not know
8013 whether there is a running but stopped thread. */
8014 if (!target_has_execution || ptid_equal (inferior_ptid, null_ptid))
8015 return NULL;
8017 if (!VEC_empty (remote_g_packet_guess_s, data->guesses))
8019 struct remote_g_packet_guess *guess;
8020 int ix;
8021 int bytes = send_g_packet ();
8023 for (ix = 0;
8024 VEC_iterate (remote_g_packet_guess_s, data->guesses, ix, guess);
8025 ix++)
8026 if (guess->bytes == bytes)
8027 return guess->tdesc;
8029 /* We discard the g packet. A minor optimization would be to
8030 hold on to it, and fill the register cache once we have selected
8031 an architecture, but it's too tricky to do safely. */
8034 return NULL;
8037 /* Remote file transfer support. This is host-initiated I/O, not
8038 target-initiated; for target-initiated, see remote-fileio.c. */
8040 /* If *LEFT is at least the length of STRING, copy STRING to
8041 *BUFFER, update *BUFFER to point to the new end of the buffer, and
8042 decrease *LEFT. Otherwise raise an error. */
8044 static void
8045 remote_buffer_add_string (char **buffer, int *left, char *string)
8047 int len = strlen (string);
8049 if (len > *left)
8050 error (_("Packet too long for target."));
8052 memcpy (*buffer, string, len);
8053 *buffer += len;
8054 *left -= len;
8056 /* NUL-terminate the buffer as a convenience, if there is
8057 room. */
8058 if (*left)
8059 **buffer = '\0';
8062 /* If *LEFT is large enough, hex encode LEN bytes from BYTES into
8063 *BUFFER, update *BUFFER to point to the new end of the buffer, and
8064 decrease *LEFT. Otherwise raise an error. */
8066 static void
8067 remote_buffer_add_bytes (char **buffer, int *left, const gdb_byte *bytes,
8068 int len)
8070 if (2 * len > *left)
8071 error (_("Packet too long for target."));
8073 bin2hex (bytes, *buffer, len);
8074 *buffer += 2 * len;
8075 *left -= 2 * len;
8077 /* NUL-terminate the buffer as a convenience, if there is
8078 room. */
8079 if (*left)
8080 **buffer = '\0';
8083 /* If *LEFT is large enough, convert VALUE to hex and add it to
8084 *BUFFER, update *BUFFER to point to the new end of the buffer, and
8085 decrease *LEFT. Otherwise raise an error. */
8087 static void
8088 remote_buffer_add_int (char **buffer, int *left, ULONGEST value)
8090 int len = hexnumlen (value);
8092 if (len > *left)
8093 error (_("Packet too long for target."));
8095 hexnumstr (*buffer, value);
8096 *buffer += len;
8097 *left -= len;
8099 /* NUL-terminate the buffer as a convenience, if there is
8100 room. */
8101 if (*left)
8102 **buffer = '\0';
8105 /* Parse an I/O result packet from BUFFER. Set RETCODE to the return
8106 value, *REMOTE_ERRNO to the remote error number or zero if none
8107 was included, and *ATTACHMENT to point to the start of the annex
8108 if any. The length of the packet isn't needed here; there may
8109 be NUL bytes in BUFFER, but they will be after *ATTACHMENT.
8111 Return 0 if the packet could be parsed, -1 if it could not. If
8112 -1 is returned, the other variables may not be initialized. */
8114 static int
8115 remote_hostio_parse_result (char *buffer, int *retcode,
8116 int *remote_errno, char **attachment)
8118 char *p, *p2;
8120 *remote_errno = 0;
8121 *attachment = NULL;
8123 if (buffer[0] != 'F')
8124 return -1;
8126 errno = 0;
8127 *retcode = strtol (&buffer[1], &p, 16);
8128 if (errno != 0 || p == &buffer[1])
8129 return -1;
8131 /* Check for ",errno". */
8132 if (*p == ',')
8134 errno = 0;
8135 *remote_errno = strtol (p + 1, &p2, 16);
8136 if (errno != 0 || p + 1 == p2)
8137 return -1;
8138 p = p2;
8141 /* Check for ";attachment". If there is no attachment, the
8142 packet should end here. */
8143 if (*p == ';')
8145 *attachment = p + 1;
8146 return 0;
8148 else if (*p == '\0')
8149 return 0;
8150 else
8151 return -1;
8154 /* Send a prepared I/O packet to the target and read its response.
8155 The prepared packet is in the global RS->BUF before this function
8156 is called, and the answer is there when we return.
8158 COMMAND_BYTES is the length of the request to send, which may include
8159 binary data. WHICH_PACKET is the packet configuration to check
8160 before attempting a packet. If an error occurs, *REMOTE_ERRNO
8161 is set to the error number and -1 is returned. Otherwise the value
8162 returned by the function is returned.
8164 ATTACHMENT and ATTACHMENT_LEN should be non-NULL if and only if an
8165 attachment is expected; an error will be reported if there's a
8166 mismatch. If one is found, *ATTACHMENT will be set to point into
8167 the packet buffer and *ATTACHMENT_LEN will be set to the
8168 attachment's length. */
8170 static int
8171 remote_hostio_send_command (int command_bytes, int which_packet,
8172 int *remote_errno, char **attachment,
8173 int *attachment_len)
8175 struct remote_state *rs = get_remote_state ();
8176 int ret, bytes_read;
8177 char *attachment_tmp;
8179 if (!remote_desc
8180 || remote_protocol_packets[which_packet].support == PACKET_DISABLE)
8182 *remote_errno = FILEIO_ENOSYS;
8183 return -1;
8186 putpkt_binary (rs->buf, command_bytes);
8187 bytes_read = getpkt_sane (&rs->buf, &rs->buf_size, 0);
8189 /* If it timed out, something is wrong. Don't try to parse the
8190 buffer. */
8191 if (bytes_read < 0)
8193 *remote_errno = FILEIO_EINVAL;
8194 return -1;
8197 switch (packet_ok (rs->buf, &remote_protocol_packets[which_packet]))
8199 case PACKET_ERROR:
8200 *remote_errno = FILEIO_EINVAL;
8201 return -1;
8202 case PACKET_UNKNOWN:
8203 *remote_errno = FILEIO_ENOSYS;
8204 return -1;
8205 case PACKET_OK:
8206 break;
8209 if (remote_hostio_parse_result (rs->buf, &ret, remote_errno,
8210 &attachment_tmp))
8212 *remote_errno = FILEIO_EINVAL;
8213 return -1;
8216 /* Make sure we saw an attachment if and only if we expected one. */
8217 if ((attachment_tmp == NULL && attachment != NULL)
8218 || (attachment_tmp != NULL && attachment == NULL))
8220 *remote_errno = FILEIO_EINVAL;
8221 return -1;
8224 /* If an attachment was found, it must point into the packet buffer;
8225 work out how many bytes there were. */
8226 if (attachment_tmp != NULL)
8228 *attachment = attachment_tmp;
8229 *attachment_len = bytes_read - (*attachment - rs->buf);
8232 return ret;
8235 /* Open FILENAME on the remote target, using FLAGS and MODE. Return a
8236 remote file descriptor, or -1 if an error occurs (and set
8237 *REMOTE_ERRNO). */
8239 static int
8240 remote_hostio_open (const char *filename, int flags, int mode,
8241 int *remote_errno)
8243 struct remote_state *rs = get_remote_state ();
8244 char *p = rs->buf;
8245 int left = get_remote_packet_size () - 1;
8247 remote_buffer_add_string (&p, &left, "vFile:open:");
8249 remote_buffer_add_bytes (&p, &left, (const gdb_byte *) filename,
8250 strlen (filename));
8251 remote_buffer_add_string (&p, &left, ",");
8253 remote_buffer_add_int (&p, &left, flags);
8254 remote_buffer_add_string (&p, &left, ",");
8256 remote_buffer_add_int (&p, &left, mode);
8258 return remote_hostio_send_command (p - rs->buf, PACKET_vFile_open,
8259 remote_errno, NULL, NULL);
8262 /* Write up to LEN bytes from WRITE_BUF to FD on the remote target.
8263 Return the number of bytes written, or -1 if an error occurs (and
8264 set *REMOTE_ERRNO). */
8266 static int
8267 remote_hostio_pwrite (int fd, const gdb_byte *write_buf, int len,
8268 ULONGEST offset, int *remote_errno)
8270 struct remote_state *rs = get_remote_state ();
8271 char *p = rs->buf;
8272 int left = get_remote_packet_size ();
8273 int out_len;
8275 remote_buffer_add_string (&p, &left, "vFile:pwrite:");
8277 remote_buffer_add_int (&p, &left, fd);
8278 remote_buffer_add_string (&p, &left, ",");
8280 remote_buffer_add_int (&p, &left, offset);
8281 remote_buffer_add_string (&p, &left, ",");
8283 p += remote_escape_output (write_buf, len, p, &out_len,
8284 get_remote_packet_size () - (p - rs->buf));
8286 return remote_hostio_send_command (p - rs->buf, PACKET_vFile_pwrite,
8287 remote_errno, NULL, NULL);
8290 /* Read up to LEN bytes FD on the remote target into READ_BUF
8291 Return the number of bytes read, or -1 if an error occurs (and
8292 set *REMOTE_ERRNO). */
8294 static int
8295 remote_hostio_pread (int fd, gdb_byte *read_buf, int len,
8296 ULONGEST offset, int *remote_errno)
8298 struct remote_state *rs = get_remote_state ();
8299 char *p = rs->buf;
8300 char *attachment;
8301 int left = get_remote_packet_size ();
8302 int ret, attachment_len;
8303 int read_len;
8305 remote_buffer_add_string (&p, &left, "vFile:pread:");
8307 remote_buffer_add_int (&p, &left, fd);
8308 remote_buffer_add_string (&p, &left, ",");
8310 remote_buffer_add_int (&p, &left, len);
8311 remote_buffer_add_string (&p, &left, ",");
8313 remote_buffer_add_int (&p, &left, offset);
8315 ret = remote_hostio_send_command (p - rs->buf, PACKET_vFile_pread,
8316 remote_errno, &attachment,
8317 &attachment_len);
8319 if (ret < 0)
8320 return ret;
8322 read_len = remote_unescape_input (attachment, attachment_len,
8323 read_buf, len);
8324 if (read_len != ret)
8325 error (_("Read returned %d, but %d bytes."), ret, (int) read_len);
8327 return ret;
8330 /* Close FD on the remote target. Return 0, or -1 if an error occurs
8331 (and set *REMOTE_ERRNO). */
8333 static int
8334 remote_hostio_close (int fd, int *remote_errno)
8336 struct remote_state *rs = get_remote_state ();
8337 char *p = rs->buf;
8338 int left = get_remote_packet_size () - 1;
8340 remote_buffer_add_string (&p, &left, "vFile:close:");
8342 remote_buffer_add_int (&p, &left, fd);
8344 return remote_hostio_send_command (p - rs->buf, PACKET_vFile_close,
8345 remote_errno, NULL, NULL);
8348 /* Unlink FILENAME on the remote target. Return 0, or -1 if an error
8349 occurs (and set *REMOTE_ERRNO). */
8351 static int
8352 remote_hostio_unlink (const char *filename, int *remote_errno)
8354 struct remote_state *rs = get_remote_state ();
8355 char *p = rs->buf;
8356 int left = get_remote_packet_size () - 1;
8358 remote_buffer_add_string (&p, &left, "vFile:unlink:");
8360 remote_buffer_add_bytes (&p, &left, (const gdb_byte *) filename,
8361 strlen (filename));
8363 return remote_hostio_send_command (p - rs->buf, PACKET_vFile_unlink,
8364 remote_errno, NULL, NULL);
8367 static int
8368 remote_fileio_errno_to_host (int errnum)
8370 switch (errnum)
8372 case FILEIO_EPERM:
8373 return EPERM;
8374 case FILEIO_ENOENT:
8375 return ENOENT;
8376 case FILEIO_EINTR:
8377 return EINTR;
8378 case FILEIO_EIO:
8379 return EIO;
8380 case FILEIO_EBADF:
8381 return EBADF;
8382 case FILEIO_EACCES:
8383 return EACCES;
8384 case FILEIO_EFAULT:
8385 return EFAULT;
8386 case FILEIO_EBUSY:
8387 return EBUSY;
8388 case FILEIO_EEXIST:
8389 return EEXIST;
8390 case FILEIO_ENODEV:
8391 return ENODEV;
8392 case FILEIO_ENOTDIR:
8393 return ENOTDIR;
8394 case FILEIO_EISDIR:
8395 return EISDIR;
8396 case FILEIO_EINVAL:
8397 return EINVAL;
8398 case FILEIO_ENFILE:
8399 return ENFILE;
8400 case FILEIO_EMFILE:
8401 return EMFILE;
8402 case FILEIO_EFBIG:
8403 return EFBIG;
8404 case FILEIO_ENOSPC:
8405 return ENOSPC;
8406 case FILEIO_ESPIPE:
8407 return ESPIPE;
8408 case FILEIO_EROFS:
8409 return EROFS;
8410 case FILEIO_ENOSYS:
8411 return ENOSYS;
8412 case FILEIO_ENAMETOOLONG:
8413 return ENAMETOOLONG;
8415 return -1;
8418 static char *
8419 remote_hostio_error (int errnum)
8421 int host_error = remote_fileio_errno_to_host (errnum);
8423 if (host_error == -1)
8424 error (_("Unknown remote I/O error %d"), errnum);
8425 else
8426 error (_("Remote I/O error: %s"), safe_strerror (host_error));
8429 static void
8430 remote_hostio_close_cleanup (void *opaque)
8432 int fd = *(int *) opaque;
8433 int remote_errno;
8435 remote_hostio_close (fd, &remote_errno);
8439 static void *
8440 remote_bfd_iovec_open (struct bfd *abfd, void *open_closure)
8442 const char *filename = bfd_get_filename (abfd);
8443 int fd, remote_errno;
8444 int *stream;
8446 gdb_assert (remote_filename_p (filename));
8448 fd = remote_hostio_open (filename + 7, FILEIO_O_RDONLY, 0, &remote_errno);
8449 if (fd == -1)
8451 errno = remote_fileio_errno_to_host (remote_errno);
8452 bfd_set_error (bfd_error_system_call);
8453 return NULL;
8456 stream = xmalloc (sizeof (int));
8457 *stream = fd;
8458 return stream;
8461 static int
8462 remote_bfd_iovec_close (struct bfd *abfd, void *stream)
8464 int fd = *(int *)stream;
8465 int remote_errno;
8467 xfree (stream);
8469 /* Ignore errors on close; these may happen if the remote
8470 connection was already torn down. */
8471 remote_hostio_close (fd, &remote_errno);
8473 return 1;
8476 static file_ptr
8477 remote_bfd_iovec_pread (struct bfd *abfd, void *stream, void *buf,
8478 file_ptr nbytes, file_ptr offset)
8480 int fd = *(int *)stream;
8481 int remote_errno;
8482 file_ptr pos, bytes;
8484 pos = 0;
8485 while (nbytes > pos)
8487 bytes = remote_hostio_pread (fd, (char *)buf + pos, nbytes - pos,
8488 offset + pos, &remote_errno);
8489 if (bytes == 0)
8490 /* Success, but no bytes, means end-of-file. */
8491 break;
8492 if (bytes == -1)
8494 errno = remote_fileio_errno_to_host (remote_errno);
8495 bfd_set_error (bfd_error_system_call);
8496 return -1;
8499 pos += bytes;
8502 return pos;
8505 static int
8506 remote_bfd_iovec_stat (struct bfd *abfd, void *stream, struct stat *sb)
8508 /* FIXME: We should probably implement remote_hostio_stat. */
8509 sb->st_size = INT_MAX;
8510 return 0;
8514 remote_filename_p (const char *filename)
8516 return strncmp (filename, "remote:", 7) == 0;
8519 bfd *
8520 remote_bfd_open (const char *remote_file, const char *target)
8522 return bfd_openr_iovec (remote_file, target,
8523 remote_bfd_iovec_open, NULL,
8524 remote_bfd_iovec_pread,
8525 remote_bfd_iovec_close,
8526 remote_bfd_iovec_stat);
8529 void
8530 remote_file_put (const char *local_file, const char *remote_file, int from_tty)
8532 struct cleanup *back_to, *close_cleanup;
8533 int retcode, fd, remote_errno, bytes, io_size;
8534 FILE *file;
8535 gdb_byte *buffer;
8536 int bytes_in_buffer;
8537 int saw_eof;
8538 ULONGEST offset;
8540 if (!remote_desc)
8541 error (_("command can only be used with remote target"));
8543 file = fopen (local_file, "rb");
8544 if (file == NULL)
8545 perror_with_name (local_file);
8546 back_to = make_cleanup_fclose (file);
8548 fd = remote_hostio_open (remote_file, (FILEIO_O_WRONLY | FILEIO_O_CREAT
8549 | FILEIO_O_TRUNC),
8550 0700, &remote_errno);
8551 if (fd == -1)
8552 remote_hostio_error (remote_errno);
8554 /* Send up to this many bytes at once. They won't all fit in the
8555 remote packet limit, so we'll transfer slightly fewer. */
8556 io_size = get_remote_packet_size ();
8557 buffer = xmalloc (io_size);
8558 make_cleanup (xfree, buffer);
8560 close_cleanup = make_cleanup (remote_hostio_close_cleanup, &fd);
8562 bytes_in_buffer = 0;
8563 saw_eof = 0;
8564 offset = 0;
8565 while (bytes_in_buffer || !saw_eof)
8567 if (!saw_eof)
8569 bytes = fread (buffer + bytes_in_buffer, 1, io_size - bytes_in_buffer,
8570 file);
8571 if (bytes == 0)
8573 if (ferror (file))
8574 error (_("Error reading %s."), local_file);
8575 else
8577 /* EOF. Unless there is something still in the
8578 buffer from the last iteration, we are done. */
8579 saw_eof = 1;
8580 if (bytes_in_buffer == 0)
8581 break;
8585 else
8586 bytes = 0;
8588 bytes += bytes_in_buffer;
8589 bytes_in_buffer = 0;
8591 retcode = remote_hostio_pwrite (fd, buffer, bytes, offset, &remote_errno);
8593 if (retcode < 0)
8594 remote_hostio_error (remote_errno);
8595 else if (retcode == 0)
8596 error (_("Remote write of %d bytes returned 0!"), bytes);
8597 else if (retcode < bytes)
8599 /* Short write. Save the rest of the read data for the next
8600 write. */
8601 bytes_in_buffer = bytes - retcode;
8602 memmove (buffer, buffer + retcode, bytes_in_buffer);
8605 offset += retcode;
8608 discard_cleanups (close_cleanup);
8609 if (remote_hostio_close (fd, &remote_errno))
8610 remote_hostio_error (remote_errno);
8612 if (from_tty)
8613 printf_filtered (_("Successfully sent file \"%s\".\n"), local_file);
8614 do_cleanups (back_to);
8617 void
8618 remote_file_get (const char *remote_file, const char *local_file, int from_tty)
8620 struct cleanup *back_to, *close_cleanup;
8621 int retcode, fd, remote_errno, bytes, io_size;
8622 FILE *file;
8623 gdb_byte *buffer;
8624 ULONGEST offset;
8626 if (!remote_desc)
8627 error (_("command can only be used with remote target"));
8629 fd = remote_hostio_open (remote_file, FILEIO_O_RDONLY, 0, &remote_errno);
8630 if (fd == -1)
8631 remote_hostio_error (remote_errno);
8633 file = fopen (local_file, "wb");
8634 if (file == NULL)
8635 perror_with_name (local_file);
8636 back_to = make_cleanup_fclose (file);
8638 /* Send up to this many bytes at once. They won't all fit in the
8639 remote packet limit, so we'll transfer slightly fewer. */
8640 io_size = get_remote_packet_size ();
8641 buffer = xmalloc (io_size);
8642 make_cleanup (xfree, buffer);
8644 close_cleanup = make_cleanup (remote_hostio_close_cleanup, &fd);
8646 offset = 0;
8647 while (1)
8649 bytes = remote_hostio_pread (fd, buffer, io_size, offset, &remote_errno);
8650 if (bytes == 0)
8651 /* Success, but no bytes, means end-of-file. */
8652 break;
8653 if (bytes == -1)
8654 remote_hostio_error (remote_errno);
8656 offset += bytes;
8658 bytes = fwrite (buffer, 1, bytes, file);
8659 if (bytes == 0)
8660 perror_with_name (local_file);
8663 discard_cleanups (close_cleanup);
8664 if (remote_hostio_close (fd, &remote_errno))
8665 remote_hostio_error (remote_errno);
8667 if (from_tty)
8668 printf_filtered (_("Successfully fetched file \"%s\".\n"), remote_file);
8669 do_cleanups (back_to);
8672 void
8673 remote_file_delete (const char *remote_file, int from_tty)
8675 int retcode, remote_errno;
8677 if (!remote_desc)
8678 error (_("command can only be used with remote target"));
8680 retcode = remote_hostio_unlink (remote_file, &remote_errno);
8681 if (retcode == -1)
8682 remote_hostio_error (remote_errno);
8684 if (from_tty)
8685 printf_filtered (_("Successfully deleted file \"%s\".\n"), remote_file);
8688 static void
8689 remote_put_command (char *args, int from_tty)
8691 struct cleanup *back_to;
8692 char **argv;
8694 if (args == NULL)
8695 error_no_arg (_("file to put"));
8697 argv = gdb_buildargv (args);
8698 back_to = make_cleanup_freeargv (argv);
8699 if (argv[0] == NULL || argv[1] == NULL || argv[2] != NULL)
8700 error (_("Invalid parameters to remote put"));
8702 remote_file_put (argv[0], argv[1], from_tty);
8704 do_cleanups (back_to);
8707 static void
8708 remote_get_command (char *args, int from_tty)
8710 struct cleanup *back_to;
8711 char **argv;
8713 if (args == NULL)
8714 error_no_arg (_("file to get"));
8716 argv = gdb_buildargv (args);
8717 back_to = make_cleanup_freeargv (argv);
8718 if (argv[0] == NULL || argv[1] == NULL || argv[2] != NULL)
8719 error (_("Invalid parameters to remote get"));
8721 remote_file_get (argv[0], argv[1], from_tty);
8723 do_cleanups (back_to);
8726 static void
8727 remote_delete_command (char *args, int from_tty)
8729 struct cleanup *back_to;
8730 char **argv;
8732 if (args == NULL)
8733 error_no_arg (_("file to delete"));
8735 argv = gdb_buildargv (args);
8736 back_to = make_cleanup_freeargv (argv);
8737 if (argv[0] == NULL || argv[1] != NULL)
8738 error (_("Invalid parameters to remote delete"));
8740 remote_file_delete (argv[0], from_tty);
8742 do_cleanups (back_to);
8745 static void
8746 remote_command (char *args, int from_tty)
8748 help_list (remote_cmdlist, "remote ", -1, gdb_stdout);
8751 static int remote_target_can_reverse = 1;
8753 static int
8754 remote_can_execute_reverse (void)
8756 return remote_target_can_reverse;
8759 static int
8760 remote_supports_non_stop (void)
8762 return 1;
8765 static int
8766 remote_supports_multi_process (void)
8768 struct remote_state *rs = get_remote_state ();
8769 return remote_multi_process_p (rs);
8772 static void
8773 init_remote_ops (void)
8775 remote_ops.to_shortname = "remote";
8776 remote_ops.to_longname = "Remote serial target in gdb-specific protocol";
8777 remote_ops.to_doc =
8778 "Use a remote computer via a serial line, using a gdb-specific protocol.\n\
8779 Specify the serial device it is connected to\n\
8780 (e.g. /dev/ttyS0, /dev/ttya, COM1, etc.).";
8781 remote_ops.to_open = remote_open;
8782 remote_ops.to_close = remote_close;
8783 remote_ops.to_detach = remote_detach;
8784 remote_ops.to_disconnect = remote_disconnect;
8785 remote_ops.to_resume = remote_resume;
8786 remote_ops.to_wait = remote_wait;
8787 remote_ops.to_fetch_registers = remote_fetch_registers;
8788 remote_ops.to_store_registers = remote_store_registers;
8789 remote_ops.to_prepare_to_store = remote_prepare_to_store;
8790 remote_ops.deprecated_xfer_memory = remote_xfer_memory;
8791 remote_ops.to_files_info = remote_files_info;
8792 remote_ops.to_insert_breakpoint = remote_insert_breakpoint;
8793 remote_ops.to_remove_breakpoint = remote_remove_breakpoint;
8794 remote_ops.to_stopped_by_watchpoint = remote_stopped_by_watchpoint;
8795 remote_ops.to_stopped_data_address = remote_stopped_data_address;
8796 remote_ops.to_can_use_hw_breakpoint = remote_check_watch_resources;
8797 remote_ops.to_insert_hw_breakpoint = remote_insert_hw_breakpoint;
8798 remote_ops.to_remove_hw_breakpoint = remote_remove_hw_breakpoint;
8799 remote_ops.to_insert_watchpoint = remote_insert_watchpoint;
8800 remote_ops.to_remove_watchpoint = remote_remove_watchpoint;
8801 remote_ops.to_kill = remote_kill;
8802 remote_ops.to_load = generic_load;
8803 remote_ops.to_mourn_inferior = remote_mourn;
8804 remote_ops.to_thread_alive = remote_thread_alive;
8805 remote_ops.to_find_new_threads = remote_threads_info;
8806 remote_ops.to_pid_to_str = remote_pid_to_str;
8807 remote_ops.to_extra_thread_info = remote_threads_extra_info;
8808 remote_ops.to_stop = remote_stop;
8809 remote_ops.to_xfer_partial = remote_xfer_partial;
8810 remote_ops.to_rcmd = remote_rcmd;
8811 remote_ops.to_log_command = serial_log_command;
8812 remote_ops.to_get_thread_local_address = remote_get_thread_local_address;
8813 remote_ops.to_stratum = process_stratum;
8814 remote_ops.to_has_all_memory = 1;
8815 remote_ops.to_has_memory = 1;
8816 remote_ops.to_has_stack = 1;
8817 remote_ops.to_has_registers = 1;
8818 remote_ops.to_has_execution = 1;
8819 remote_ops.to_has_thread_control = tc_schedlock; /* can lock scheduler */
8820 remote_ops.to_can_execute_reverse = remote_can_execute_reverse;
8821 remote_ops.to_magic = OPS_MAGIC;
8822 remote_ops.to_memory_map = remote_memory_map;
8823 remote_ops.to_flash_erase = remote_flash_erase;
8824 remote_ops.to_flash_done = remote_flash_done;
8825 remote_ops.to_read_description = remote_read_description;
8826 remote_ops.to_search_memory = remote_search_memory;
8827 remote_ops.to_can_async_p = remote_can_async_p;
8828 remote_ops.to_is_async_p = remote_is_async_p;
8829 remote_ops.to_async = remote_async;
8830 remote_ops.to_async_mask = remote_async_mask;
8831 remote_ops.to_terminal_inferior = remote_terminal_inferior;
8832 remote_ops.to_terminal_ours = remote_terminal_ours;
8833 remote_ops.to_supports_non_stop = remote_supports_non_stop;
8834 remote_ops.to_supports_multi_process = remote_supports_multi_process;
8837 /* Set up the extended remote vector by making a copy of the standard
8838 remote vector and adding to it. */
8840 static void
8841 init_extended_remote_ops (void)
8843 extended_remote_ops = remote_ops;
8845 extended_remote_ops.to_shortname = "extended-remote";
8846 extended_remote_ops.to_longname =
8847 "Extended remote serial target in gdb-specific protocol";
8848 extended_remote_ops.to_doc =
8849 "Use a remote computer via a serial line, using a gdb-specific protocol.\n\
8850 Specify the serial device it is connected to (e.g. /dev/ttya).";
8851 extended_remote_ops.to_open = extended_remote_open;
8852 extended_remote_ops.to_create_inferior = extended_remote_create_inferior;
8853 extended_remote_ops.to_mourn_inferior = extended_remote_mourn;
8854 extended_remote_ops.to_detach = extended_remote_detach;
8855 extended_remote_ops.to_attach = extended_remote_attach;
8856 extended_remote_ops.to_kill = extended_remote_kill;
8859 static int
8860 remote_can_async_p (void)
8862 if (!target_async_permitted)
8863 /* We only enable async when the user specifically asks for it. */
8864 return 0;
8866 /* We're async whenever the serial device is. */
8867 return remote_async_mask_value && serial_can_async_p (remote_desc);
8870 static int
8871 remote_is_async_p (void)
8873 if (!target_async_permitted)
8874 /* We only enable async when the user specifically asks for it. */
8875 return 0;
8877 /* We're async whenever the serial device is. */
8878 return remote_async_mask_value && serial_is_async_p (remote_desc);
8881 /* Pass the SERIAL event on and up to the client. One day this code
8882 will be able to delay notifying the client of an event until the
8883 point where an entire packet has been received. */
8885 static void (*async_client_callback) (enum inferior_event_type event_type,
8886 void *context);
8887 static void *async_client_context;
8888 static serial_event_ftype remote_async_serial_handler;
8890 static void
8891 remote_async_serial_handler (struct serial *scb, void *context)
8893 /* Don't propogate error information up to the client. Instead let
8894 the client find out about the error by querying the target. */
8895 async_client_callback (INF_REG_EVENT, async_client_context);
8898 static void
8899 remote_async_inferior_event_handler (gdb_client_data data)
8901 inferior_event_handler (INF_REG_EVENT, NULL);
8904 static void
8905 remote_async_get_pending_events_handler (gdb_client_data data)
8907 remote_get_pending_stop_replies ();
8910 static void
8911 remote_async (void (*callback) (enum inferior_event_type event_type,
8912 void *context), void *context)
8914 if (remote_async_mask_value == 0)
8915 internal_error (__FILE__, __LINE__,
8916 _("Calling remote_async when async is masked"));
8918 if (callback != NULL)
8920 serial_async (remote_desc, remote_async_serial_handler, NULL);
8921 async_client_callback = callback;
8922 async_client_context = context;
8924 else
8925 serial_async (remote_desc, NULL, NULL);
8928 static int
8929 remote_async_mask (int new_mask)
8931 int curr_mask = remote_async_mask_value;
8932 remote_async_mask_value = new_mask;
8933 return curr_mask;
8936 static void
8937 set_remote_cmd (char *args, int from_tty)
8939 help_list (remote_set_cmdlist, "set remote ", -1, gdb_stdout);
8942 static void
8943 show_remote_cmd (char *args, int from_tty)
8945 /* We can't just use cmd_show_list here, because we want to skip
8946 the redundant "show remote Z-packet" and the legacy aliases. */
8947 struct cleanup *showlist_chain;
8948 struct cmd_list_element *list = remote_show_cmdlist;
8950 showlist_chain = make_cleanup_ui_out_tuple_begin_end (uiout, "showlist");
8951 for (; list != NULL; list = list->next)
8952 if (strcmp (list->name, "Z-packet") == 0)
8953 continue;
8954 else if (list->type == not_set_cmd)
8955 /* Alias commands are exactly like the original, except they
8956 don't have the normal type. */
8957 continue;
8958 else
8960 struct cleanup *option_chain
8961 = make_cleanup_ui_out_tuple_begin_end (uiout, "option");
8962 ui_out_field_string (uiout, "name", list->name);
8963 ui_out_text (uiout, ": ");
8964 if (list->type == show_cmd)
8965 do_setshow_command ((char *) NULL, from_tty, list);
8966 else
8967 cmd_func (list, NULL, from_tty);
8968 /* Close the tuple. */
8969 do_cleanups (option_chain);
8972 /* Close the tuple. */
8973 do_cleanups (showlist_chain);
8977 /* Function to be called whenever a new objfile (shlib) is detected. */
8978 static void
8979 remote_new_objfile (struct objfile *objfile)
8981 if (remote_desc != 0) /* Have a remote connection. */
8982 remote_check_symbols (objfile);
8985 void
8986 _initialize_remote (void)
8988 struct remote_state *rs;
8990 /* architecture specific data */
8991 remote_gdbarch_data_handle =
8992 gdbarch_data_register_post_init (init_remote_state);
8993 remote_g_packet_data_handle =
8994 gdbarch_data_register_pre_init (remote_g_packet_data_init);
8996 /* Initialize the per-target state. At the moment there is only one
8997 of these, not one per target. Only one target is active at a
8998 time. The default buffer size is unimportant; it will be expanded
8999 whenever a larger buffer is needed. */
9000 rs = get_remote_state_raw ();
9001 rs->buf_size = 400;
9002 rs->buf = xmalloc (rs->buf_size);
9004 init_remote_ops ();
9005 add_target (&remote_ops);
9007 init_extended_remote_ops ();
9008 add_target (&extended_remote_ops);
9010 /* Hook into new objfile notification. */
9011 observer_attach_new_objfile (remote_new_objfile);
9013 /* Set up signal handlers. */
9014 sigint_remote_token =
9015 create_async_signal_handler (async_remote_interrupt, NULL);
9016 sigint_remote_twice_token =
9017 create_async_signal_handler (inferior_event_handler_wrapper, NULL);
9019 #if 0
9020 init_remote_threadtests ();
9021 #endif
9023 /* set/show remote ... */
9025 add_prefix_cmd ("remote", class_maintenance, set_remote_cmd, _("\
9026 Remote protocol specific variables\n\
9027 Configure various remote-protocol specific variables such as\n\
9028 the packets being used"),
9029 &remote_set_cmdlist, "set remote ",
9030 0 /* allow-unknown */, &setlist);
9031 add_prefix_cmd ("remote", class_maintenance, show_remote_cmd, _("\
9032 Remote protocol specific variables\n\
9033 Configure various remote-protocol specific variables such as\n\
9034 the packets being used"),
9035 &remote_show_cmdlist, "show remote ",
9036 0 /* allow-unknown */, &showlist);
9038 add_cmd ("compare-sections", class_obscure, compare_sections_command, _("\
9039 Compare section data on target to the exec file.\n\
9040 Argument is a single section name (default: all loaded sections)."),
9041 &cmdlist);
9043 add_cmd ("packet", class_maintenance, packet_command, _("\
9044 Send an arbitrary packet to a remote target.\n\
9045 maintenance packet TEXT\n\
9046 If GDB is talking to an inferior via the GDB serial protocol, then\n\
9047 this command sends the string TEXT to the inferior, and displays the\n\
9048 response packet. GDB supplies the initial `$' character, and the\n\
9049 terminating `#' character and checksum."),
9050 &maintenancelist);
9052 add_setshow_boolean_cmd ("remotebreak", no_class, &remote_break, _("\
9053 Set whether to send break if interrupted."), _("\
9054 Show whether to send break if interrupted."), _("\
9055 If set, a break, instead of a cntrl-c, is sent to the remote target."),
9056 NULL, NULL, /* FIXME: i18n: Whether to send break if interrupted is %s. */
9057 &setlist, &showlist);
9059 /* Install commands for configuring memory read/write packets. */
9061 add_cmd ("remotewritesize", no_class, set_memory_write_packet_size, _("\
9062 Set the maximum number of bytes per memory write packet (deprecated)."),
9063 &setlist);
9064 add_cmd ("remotewritesize", no_class, show_memory_write_packet_size, _("\
9065 Show the maximum number of bytes per memory write packet (deprecated)."),
9066 &showlist);
9067 add_cmd ("memory-write-packet-size", no_class,
9068 set_memory_write_packet_size, _("\
9069 Set the maximum number of bytes per memory-write packet.\n\
9070 Specify the number of bytes in a packet or 0 (zero) for the\n\
9071 default packet size. The actual limit is further reduced\n\
9072 dependent on the target. Specify ``fixed'' to disable the\n\
9073 further restriction and ``limit'' to enable that restriction."),
9074 &remote_set_cmdlist);
9075 add_cmd ("memory-read-packet-size", no_class,
9076 set_memory_read_packet_size, _("\
9077 Set the maximum number of bytes per memory-read packet.\n\
9078 Specify the number of bytes in a packet or 0 (zero) for the\n\
9079 default packet size. The actual limit is further reduced\n\
9080 dependent on the target. Specify ``fixed'' to disable the\n\
9081 further restriction and ``limit'' to enable that restriction."),
9082 &remote_set_cmdlist);
9083 add_cmd ("memory-write-packet-size", no_class,
9084 show_memory_write_packet_size,
9085 _("Show the maximum number of bytes per memory-write packet."),
9086 &remote_show_cmdlist);
9087 add_cmd ("memory-read-packet-size", no_class,
9088 show_memory_read_packet_size,
9089 _("Show the maximum number of bytes per memory-read packet."),
9090 &remote_show_cmdlist);
9092 add_setshow_zinteger_cmd ("hardware-watchpoint-limit", no_class,
9093 &remote_hw_watchpoint_limit, _("\
9094 Set the maximum number of target hardware watchpoints."), _("\
9095 Show the maximum number of target hardware watchpoints."), _("\
9096 Specify a negative limit for unlimited."),
9097 NULL, NULL, /* FIXME: i18n: The maximum number of target hardware watchpoints is %s. */
9098 &remote_set_cmdlist, &remote_show_cmdlist);
9099 add_setshow_zinteger_cmd ("hardware-breakpoint-limit", no_class,
9100 &remote_hw_breakpoint_limit, _("\
9101 Set the maximum number of target hardware breakpoints."), _("\
9102 Show the maximum number of target hardware breakpoints."), _("\
9103 Specify a negative limit for unlimited."),
9104 NULL, NULL, /* FIXME: i18n: The maximum number of target hardware breakpoints is %s. */
9105 &remote_set_cmdlist, &remote_show_cmdlist);
9107 add_setshow_integer_cmd ("remoteaddresssize", class_obscure,
9108 &remote_address_size, _("\
9109 Set the maximum size of the address (in bits) in a memory packet."), _("\
9110 Show the maximum size of the address (in bits) in a memory packet."), NULL,
9111 NULL,
9112 NULL, /* FIXME: i18n: */
9113 &setlist, &showlist);
9115 add_packet_config_cmd (&remote_protocol_packets[PACKET_X],
9116 "X", "binary-download", 1);
9118 add_packet_config_cmd (&remote_protocol_packets[PACKET_vCont],
9119 "vCont", "verbose-resume", 0);
9121 add_packet_config_cmd (&remote_protocol_packets[PACKET_QPassSignals],
9122 "QPassSignals", "pass-signals", 0);
9124 add_packet_config_cmd (&remote_protocol_packets[PACKET_qSymbol],
9125 "qSymbol", "symbol-lookup", 0);
9127 add_packet_config_cmd (&remote_protocol_packets[PACKET_P],
9128 "P", "set-register", 1);
9130 add_packet_config_cmd (&remote_protocol_packets[PACKET_p],
9131 "p", "fetch-register", 1);
9133 add_packet_config_cmd (&remote_protocol_packets[PACKET_Z0],
9134 "Z0", "software-breakpoint", 0);
9136 add_packet_config_cmd (&remote_protocol_packets[PACKET_Z1],
9137 "Z1", "hardware-breakpoint", 0);
9139 add_packet_config_cmd (&remote_protocol_packets[PACKET_Z2],
9140 "Z2", "write-watchpoint", 0);
9142 add_packet_config_cmd (&remote_protocol_packets[PACKET_Z3],
9143 "Z3", "read-watchpoint", 0);
9145 add_packet_config_cmd (&remote_protocol_packets[PACKET_Z4],
9146 "Z4", "access-watchpoint", 0);
9148 add_packet_config_cmd (&remote_protocol_packets[PACKET_qXfer_auxv],
9149 "qXfer:auxv:read", "read-aux-vector", 0);
9151 add_packet_config_cmd (&remote_protocol_packets[PACKET_qXfer_features],
9152 "qXfer:features:read", "target-features", 0);
9154 add_packet_config_cmd (&remote_protocol_packets[PACKET_qXfer_libraries],
9155 "qXfer:libraries:read", "library-info", 0);
9157 add_packet_config_cmd (&remote_protocol_packets[PACKET_qXfer_memory_map],
9158 "qXfer:memory-map:read", "memory-map", 0);
9160 add_packet_config_cmd (&remote_protocol_packets[PACKET_qXfer_spu_read],
9161 "qXfer:spu:read", "read-spu-object", 0);
9163 add_packet_config_cmd (&remote_protocol_packets[PACKET_qXfer_spu_write],
9164 "qXfer:spu:write", "write-spu-object", 0);
9166 add_packet_config_cmd (&remote_protocol_packets[PACKET_qXfer_osdata],
9167 "qXfer:osdata:read", "osdata", 0);
9169 add_packet_config_cmd (&remote_protocol_packets[PACKET_qXfer_siginfo_read],
9170 "qXfer:siginfo:read", "read-siginfo-object", 0);
9172 add_packet_config_cmd (&remote_protocol_packets[PACKET_qXfer_siginfo_write],
9173 "qXfer:siginfo:write", "write-siginfo-object", 0);
9175 add_packet_config_cmd (&remote_protocol_packets[PACKET_qGetTLSAddr],
9176 "qGetTLSAddr", "get-thread-local-storage-address",
9179 add_packet_config_cmd (&remote_protocol_packets[PACKET_qSupported],
9180 "qSupported", "supported-packets", 0);
9182 add_packet_config_cmd (&remote_protocol_packets[PACKET_qSearch_memory],
9183 "qSearch:memory", "search-memory", 0);
9185 add_packet_config_cmd (&remote_protocol_packets[PACKET_vFile_open],
9186 "vFile:open", "hostio-open", 0);
9188 add_packet_config_cmd (&remote_protocol_packets[PACKET_vFile_pread],
9189 "vFile:pread", "hostio-pread", 0);
9191 add_packet_config_cmd (&remote_protocol_packets[PACKET_vFile_pwrite],
9192 "vFile:pwrite", "hostio-pwrite", 0);
9194 add_packet_config_cmd (&remote_protocol_packets[PACKET_vFile_close],
9195 "vFile:close", "hostio-close", 0);
9197 add_packet_config_cmd (&remote_protocol_packets[PACKET_vFile_unlink],
9198 "vFile:unlink", "hostio-unlink", 0);
9200 add_packet_config_cmd (&remote_protocol_packets[PACKET_vAttach],
9201 "vAttach", "attach", 0);
9203 add_packet_config_cmd (&remote_protocol_packets[PACKET_vRun],
9204 "vRun", "run", 0);
9206 add_packet_config_cmd (&remote_protocol_packets[PACKET_QStartNoAckMode],
9207 "QStartNoAckMode", "noack", 0);
9209 add_packet_config_cmd (&remote_protocol_packets[PACKET_vKill],
9210 "vKill", "kill", 0);
9212 add_packet_config_cmd (&remote_protocol_packets[PACKET_qAttached],
9213 "qAttached", "query-attached", 0);
9215 /* Keep the old ``set remote Z-packet ...'' working. Each individual
9216 Z sub-packet has its own set and show commands, but users may
9217 have sets to this variable in their .gdbinit files (or in their
9218 documentation). */
9219 add_setshow_auto_boolean_cmd ("Z-packet", class_obscure,
9220 &remote_Z_packet_detect, _("\
9221 Set use of remote protocol `Z' packets"), _("\
9222 Show use of remote protocol `Z' packets "), _("\
9223 When set, GDB will attempt to use the remote breakpoint and watchpoint\n\
9224 packets."),
9225 set_remote_protocol_Z_packet_cmd,
9226 show_remote_protocol_Z_packet_cmd, /* FIXME: i18n: Use of remote protocol `Z' packets is %s. */
9227 &remote_set_cmdlist, &remote_show_cmdlist);
9229 add_prefix_cmd ("remote", class_files, remote_command, _("\
9230 Manipulate files on the remote system\n\
9231 Transfer files to and from the remote target system."),
9232 &remote_cmdlist, "remote ",
9233 0 /* allow-unknown */, &cmdlist);
9235 add_cmd ("put", class_files, remote_put_command,
9236 _("Copy a local file to the remote system."),
9237 &remote_cmdlist);
9239 add_cmd ("get", class_files, remote_get_command,
9240 _("Copy a remote file to the local system."),
9241 &remote_cmdlist);
9243 add_cmd ("delete", class_files, remote_delete_command,
9244 _("Delete a remote file."),
9245 &remote_cmdlist);
9247 remote_exec_file = xstrdup ("");
9248 add_setshow_string_noescape_cmd ("exec-file", class_files,
9249 &remote_exec_file, _("\
9250 Set the remote pathname for \"run\""), _("\
9251 Show the remote pathname for \"run\""), NULL, NULL, NULL,
9252 &remote_set_cmdlist, &remote_show_cmdlist);
9254 /* Eventually initialize fileio. See fileio.c */
9255 initialize_remote_fileio (remote_set_cmdlist, remote_show_cmdlist);
9257 /* Take advantage of the fact that the LWP field is not used, to tag
9258 special ptids with it set to != 0. */
9259 magic_null_ptid = ptid_build (42000, 1, -1);
9260 not_sent_ptid = ptid_build (42000, 1, -2);
9261 any_thread_ptid = ptid_build (42000, 1, 0);