[gdb/testsuite] Factor out proc with_lock
[binutils-gdb.git] / gdbserver / server.cc
blob789af36d9a42cbd496abba574cdaced7338da159
1 /* Main code for remote server for GDB.
2 Copyright (C) 1989-2024 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #include "gdbthread.h"
20 #include "gdbsupport/agent.h"
21 #include "notif.h"
22 #include "tdesc.h"
23 #include "gdbsupport/rsp-low.h"
24 #include "gdbsupport/signals-state-save-restore.h"
25 #include <ctype.h>
26 #include <unistd.h>
27 #if HAVE_SIGNAL_H
28 #include <signal.h>
29 #endif
30 #include "gdbsupport/gdb_vecs.h"
31 #include "gdbsupport/gdb_wait.h"
32 #include "gdbsupport/btrace-common.h"
33 #include "gdbsupport/filestuff.h"
34 #include "tracepoint.h"
35 #include "dll.h"
36 #include "hostio.h"
37 #include <vector>
38 #include <unordered_map>
39 #include "gdbsupport/common-inferior.h"
40 #include "gdbsupport/job-control.h"
41 #include "gdbsupport/environ.h"
42 #include "filenames.h"
43 #include "gdbsupport/pathstuff.h"
44 #ifdef USE_XML
45 #include "xml-builtin.h"
46 #endif
48 #include "gdbsupport/selftest.h"
49 #include "gdbsupport/scope-exit.h"
50 #include "gdbsupport/gdb_select.h"
51 #include "gdbsupport/scoped_restore.h"
52 #include "gdbsupport/search.h"
54 /* PBUFSIZ must also be at least as big as IPA_CMD_BUF_SIZE, because
55 the client state data is passed directly to some agent
56 functions. */
57 static_assert (PBUFSIZ >= IPA_CMD_BUF_SIZE);
59 #define require_running_or_return(BUF) \
60 if (!target_running ()) \
61 { \
62 write_enn (BUF); \
63 return; \
66 #define require_running_or_break(BUF) \
67 if (!target_running ()) \
68 { \
69 write_enn (BUF); \
70 break; \
73 /* The environment to pass to the inferior when creating it. */
75 static gdb_environ our_environ;
77 bool server_waiting;
79 static bool extended_protocol;
80 static bool response_needed;
81 static bool exit_requested;
83 /* --once: Exit after the first connection has closed. */
84 bool run_once;
86 /* Whether to report TARGET_WAITKIND_NO_RESUMED events. */
87 static bool report_no_resumed;
89 /* The event loop checks this to decide whether to continue accepting
90 events. */
91 static bool keep_processing_events = true;
93 bool non_stop;
95 static struct {
96 /* Set the PROGRAM_PATH. Here we adjust the path of the provided
97 binary if needed. */
98 void set (const char *path)
100 m_path = path;
102 /* Make sure we're using the absolute path of the inferior when
103 creating it. */
104 if (!contains_dir_separator (m_path.c_str ()))
106 int reg_file_errno;
108 /* Check if the file is in our CWD. If it is, then we prefix
109 its name with CURRENT_DIRECTORY. Otherwise, we leave the
110 name as-is because we'll try searching for it in $PATH. */
111 if (is_regular_file (m_path.c_str (), &reg_file_errno))
112 m_path = gdb_abspath (m_path.c_str ());
116 /* Return the PROGRAM_PATH. */
117 const char *get ()
118 { return m_path.empty () ? nullptr : m_path.c_str (); }
120 private:
121 /* The program name, adjusted if needed. */
122 std::string m_path;
123 } program_path;
124 static std::vector<char *> program_args;
125 static std::string wrapper_argv;
127 /* The PID of the originally created or attached inferior. Used to
128 send signals to the process when GDB sends us an asynchronous interrupt
129 (user hitting Control-C in the client), and to wait for the child to exit
130 when no longer debugging it. */
132 unsigned long signal_pid;
134 /* Set if you want to disable optional thread related packets support
135 in gdbserver, for the sake of testing GDB against stubs that don't
136 support them. */
137 bool disable_packet_vCont;
138 bool disable_packet_Tthread;
139 bool disable_packet_qC;
140 bool disable_packet_qfThreadInfo;
141 bool disable_packet_T;
143 static unsigned char *mem_buf;
145 /* A sub-class of 'struct notif_event' for stop, holding information
146 relative to a single stop reply. We keep a queue of these to
147 push to GDB in non-stop mode. */
149 struct vstop_notif : public notif_event
151 /* Thread or process that got the event. */
152 ptid_t ptid;
154 /* Event info. */
155 struct target_waitstatus status;
158 /* The current btrace configuration. This is gdbserver's mirror of GDB's
159 btrace configuration. */
160 static struct btrace_config current_btrace_conf;
162 /* The client remote protocol state. */
164 static client_state g_client_state;
166 client_state &
167 get_client_state ()
169 client_state &cs = g_client_state;
170 return cs;
174 /* Put a stop reply to the stop reply queue. */
176 static void
177 queue_stop_reply (ptid_t ptid, const target_waitstatus &status)
179 struct vstop_notif *new_notif = new struct vstop_notif;
181 new_notif->ptid = ptid;
182 new_notif->status = status;
184 notif_event_enque (&notif_stop, new_notif);
187 static bool
188 remove_all_on_match_ptid (struct notif_event *event, ptid_t filter_ptid)
190 struct vstop_notif *vstop_event = (struct vstop_notif *) event;
192 return vstop_event->ptid.matches (filter_ptid);
195 /* See server.h. */
197 void
198 discard_queued_stop_replies (ptid_t ptid)
200 std::list<notif_event *>::iterator iter, next, end;
201 end = notif_stop.queue.end ();
202 for (iter = notif_stop.queue.begin (); iter != end; iter = next)
204 next = iter;
205 ++next;
207 if (iter == notif_stop.queue.begin ())
209 /* The head of the list contains the notification that was
210 already sent to GDB. So we can't remove it, otherwise
211 when GDB sends the vStopped, it would ack the _next_
212 notification, which hadn't been sent yet! */
213 continue;
216 if (remove_all_on_match_ptid (*iter, ptid))
218 delete *iter;
219 notif_stop.queue.erase (iter);
224 static void
225 vstop_notif_reply (struct notif_event *event, char *own_buf)
227 struct vstop_notif *vstop = (struct vstop_notif *) event;
229 prepare_resume_reply (own_buf, vstop->ptid, vstop->status);
232 /* Helper for in_queued_stop_replies. */
234 static bool
235 in_queued_stop_replies_ptid (struct notif_event *event, ptid_t filter_ptid)
237 struct vstop_notif *vstop_event = (struct vstop_notif *) event;
239 if (vstop_event->ptid.matches (filter_ptid))
240 return true;
242 /* Don't resume fork children that GDB does not know about yet. */
243 if ((vstop_event->status.kind () == TARGET_WAITKIND_FORKED
244 || vstop_event->status.kind () == TARGET_WAITKIND_VFORKED
245 || vstop_event->status.kind () == TARGET_WAITKIND_THREAD_CLONED)
246 && vstop_event->status.child_ptid ().matches (filter_ptid))
247 return true;
249 return false;
252 /* See server.h. */
255 in_queued_stop_replies (ptid_t ptid)
257 for (notif_event *event : notif_stop.queue)
259 if (in_queued_stop_replies_ptid (event, ptid))
260 return true;
263 return false;
266 struct notif_server notif_stop =
268 "vStopped", "Stop", {}, vstop_notif_reply,
271 static int
272 target_running (void)
274 return get_first_thread () != NULL;
277 /* See gdbsupport/common-inferior.h. */
279 const char *
280 get_exec_wrapper ()
282 return !wrapper_argv.empty () ? wrapper_argv.c_str () : NULL;
285 /* See gdbsupport/common-inferior.h. */
287 const char *
288 get_exec_file (int err)
290 if (err && program_path.get () == NULL)
291 error (_("No executable file specified."));
293 return program_path.get ();
296 /* See server.h. */
298 gdb_environ *
299 get_environ ()
301 return &our_environ;
304 static int
305 attach_inferior (int pid)
307 client_state &cs = get_client_state ();
308 /* myattach should return -1 if attaching is unsupported,
309 0 if it succeeded, and call error() otherwise. */
311 if (find_process_pid (pid) != nullptr)
312 error ("Already attached to process %d\n", pid);
314 if (myattach (pid) != 0)
315 return -1;
317 fprintf (stderr, "Attached; pid = %d\n", pid);
318 fflush (stderr);
320 /* FIXME - It may be that we should get the SIGNAL_PID from the
321 attach function, so that it can be the main thread instead of
322 whichever we were told to attach to. */
323 signal_pid = pid;
325 if (!non_stop)
327 cs.last_ptid = mywait (ptid_t (pid), &cs.last_status, 0, 0);
329 /* GDB knows to ignore the first SIGSTOP after attaching to a running
330 process using the "attach" command, but this is different; it's
331 just using "target remote". Pretend it's just starting up. */
332 if (cs.last_status.kind () == TARGET_WAITKIND_STOPPED
333 && cs.last_status.sig () == GDB_SIGNAL_STOP)
334 cs.last_status.set_stopped (GDB_SIGNAL_TRAP);
336 current_thread->last_resume_kind = resume_stop;
337 current_thread->last_status = cs.last_status;
340 return 0;
343 /* Decode a qXfer read request. Return 0 if everything looks OK,
344 or -1 otherwise. */
346 static int
347 decode_xfer_read (char *buf, CORE_ADDR *ofs, unsigned int *len)
349 /* After the read marker and annex, qXfer looks like a
350 traditional 'm' packet. */
351 decode_m_packet (buf, ofs, len);
353 return 0;
356 static int
357 decode_xfer (char *buf, char **object, char **rw, char **annex, char **offset)
359 /* Extract and NUL-terminate the object. */
360 *object = buf;
361 while (*buf && *buf != ':')
362 buf++;
363 if (*buf == '\0')
364 return -1;
365 *buf++ = 0;
367 /* Extract and NUL-terminate the read/write action. */
368 *rw = buf;
369 while (*buf && *buf != ':')
370 buf++;
371 if (*buf == '\0')
372 return -1;
373 *buf++ = 0;
375 /* Extract and NUL-terminate the annex. */
376 *annex = buf;
377 while (*buf && *buf != ':')
378 buf++;
379 if (*buf == '\0')
380 return -1;
381 *buf++ = 0;
383 *offset = buf;
384 return 0;
387 /* Write the response to a successful qXfer read. Returns the
388 length of the (binary) data stored in BUF, corresponding
389 to as much of DATA/LEN as we could fit. IS_MORE controls
390 the first character of the response. */
391 static int
392 write_qxfer_response (char *buf, const gdb_byte *data, int len, int is_more)
394 int out_len;
396 if (is_more)
397 buf[0] = 'm';
398 else
399 buf[0] = 'l';
401 return remote_escape_output (data, len, 1, (unsigned char *) buf + 1,
402 &out_len, PBUFSIZ - 2) + 1;
405 /* Handle btrace enabling in BTS format. */
407 static void
408 handle_btrace_enable_bts (struct thread_info *thread)
410 if (thread->btrace != NULL)
411 error (_("Btrace already enabled."));
413 current_btrace_conf.format = BTRACE_FORMAT_BTS;
414 thread->btrace = target_enable_btrace (thread, &current_btrace_conf);
417 /* Handle btrace enabling in Intel Processor Trace format. */
419 static void
420 handle_btrace_enable_pt (struct thread_info *thread)
422 if (thread->btrace != NULL)
423 error (_("Btrace already enabled."));
425 current_btrace_conf.format = BTRACE_FORMAT_PT;
426 thread->btrace = target_enable_btrace (thread, &current_btrace_conf);
429 /* Handle btrace disabling. */
431 static void
432 handle_btrace_disable (struct thread_info *thread)
435 if (thread->btrace == NULL)
436 error (_("Branch tracing not enabled."));
438 if (target_disable_btrace (thread->btrace) != 0)
439 error (_("Could not disable branch tracing."));
441 thread->btrace = NULL;
444 /* Handle the "Qbtrace" packet. */
446 static int
447 handle_btrace_general_set (char *own_buf)
449 client_state &cs = get_client_state ();
450 struct thread_info *thread;
451 char *op;
453 if (!startswith (own_buf, "Qbtrace:"))
454 return 0;
456 op = own_buf + strlen ("Qbtrace:");
458 if (cs.general_thread == null_ptid
459 || cs.general_thread == minus_one_ptid)
461 strcpy (own_buf, "E.Must select a single thread.");
462 return -1;
465 thread = find_thread_ptid (cs.general_thread);
466 if (thread == NULL)
468 strcpy (own_buf, "E.No such thread.");
469 return -1;
474 if (strcmp (op, "bts") == 0)
475 handle_btrace_enable_bts (thread);
476 else if (strcmp (op, "pt") == 0)
477 handle_btrace_enable_pt (thread);
478 else if (strcmp (op, "off") == 0)
479 handle_btrace_disable (thread);
480 else
481 error (_("Bad Qbtrace operation. Use bts, pt, or off."));
483 write_ok (own_buf);
485 catch (const gdb_exception_error &exception)
487 sprintf (own_buf, "E.%s", exception.what ());
490 return 1;
493 /* Handle the "Qbtrace-conf" packet. */
495 static int
496 handle_btrace_conf_general_set (char *own_buf)
498 client_state &cs = get_client_state ();
499 struct thread_info *thread;
500 char *op;
502 if (!startswith (own_buf, "Qbtrace-conf:"))
503 return 0;
505 op = own_buf + strlen ("Qbtrace-conf:");
507 if (cs.general_thread == null_ptid
508 || cs.general_thread == minus_one_ptid)
510 strcpy (own_buf, "E.Must select a single thread.");
511 return -1;
514 thread = find_thread_ptid (cs.general_thread);
515 if (thread == NULL)
517 strcpy (own_buf, "E.No such thread.");
518 return -1;
521 if (startswith (op, "bts:size="))
523 unsigned long size;
524 char *endp = NULL;
526 errno = 0;
527 size = strtoul (op + strlen ("bts:size="), &endp, 16);
528 if (endp == NULL || *endp != 0 || errno != 0 || size > UINT_MAX)
530 strcpy (own_buf, "E.Bad size value.");
531 return -1;
534 current_btrace_conf.bts.size = (unsigned int) size;
536 else if (strncmp (op, "pt:size=", strlen ("pt:size=")) == 0)
538 unsigned long size;
539 char *endp = NULL;
541 errno = 0;
542 size = strtoul (op + strlen ("pt:size="), &endp, 16);
543 if (endp == NULL || *endp != 0 || errno != 0 || size > UINT_MAX)
545 strcpy (own_buf, "E.Bad size value.");
546 return -1;
549 current_btrace_conf.pt.size = (unsigned int) size;
551 else
553 strcpy (own_buf, "E.Bad Qbtrace configuration option.");
554 return -1;
557 write_ok (own_buf);
558 return 1;
561 /* Create the qMemTags packet reply given TAGS.
563 Returns true if parsing succeeded and false otherwise. */
565 static bool
566 create_fetch_memtags_reply (char *reply, const gdb::byte_vector &tags)
568 /* It is an error to pass a zero-sized tag vector. */
569 gdb_assert (tags.size () != 0);
571 std::string packet ("m");
573 /* Write the tag data. */
574 packet += bin2hex (tags.data (), tags.size ());
576 /* Check if the reply is too big for the packet to handle. */
577 if (PBUFSIZ < packet.size ())
578 return false;
580 strcpy (reply, packet.c_str ());
581 return true;
584 /* Parse the QMemTags request into ADDR, LEN and TAGS.
586 Returns true if parsing succeeded and false otherwise. */
588 static bool
589 parse_store_memtags_request (char *request, CORE_ADDR *addr, size_t *len,
590 gdb::byte_vector &tags, int *type)
592 gdb_assert (startswith (request, "QMemTags:"));
594 const char *p = request + strlen ("QMemTags:");
596 /* Read address and length. */
597 unsigned int length = 0;
598 p = decode_m_packet_params (p, addr, &length, ':');
599 *len = length;
601 /* Read the tag type. */
602 ULONGEST tag_type = 0;
603 p = unpack_varlen_hex (p, &tag_type);
604 *type = (int) tag_type;
606 /* Make sure there is a colon after the type. */
607 if (*p != ':')
608 return false;
610 /* Skip the colon. */
611 p++;
613 /* Read the tag data. */
614 tags = hex2bin (p);
616 return true;
619 /* Parse thread options starting at *P and return them. On exit,
620 advance *P past the options. */
622 static gdb_thread_options
623 parse_gdb_thread_options (const char **p)
625 ULONGEST options = 0;
626 *p = unpack_varlen_hex (*p, &options);
627 return (gdb_thread_option) options;
630 /* Handle all of the extended 'Q' packets. */
632 static void
633 handle_general_set (char *own_buf)
635 client_state &cs = get_client_state ();
636 if (startswith (own_buf, "QPassSignals:"))
638 int numsigs = (int) GDB_SIGNAL_LAST, i;
639 const char *p = own_buf + strlen ("QPassSignals:");
640 CORE_ADDR cursig;
642 p = decode_address_to_semicolon (&cursig, p);
643 for (i = 0; i < numsigs; i++)
645 if (i == cursig)
647 cs.pass_signals[i] = 1;
648 if (*p == '\0')
649 /* Keep looping, to clear the remaining signals. */
650 cursig = -1;
651 else
652 p = decode_address_to_semicolon (&cursig, p);
654 else
655 cs.pass_signals[i] = 0;
657 strcpy (own_buf, "OK");
658 return;
661 if (startswith (own_buf, "QProgramSignals:"))
663 int numsigs = (int) GDB_SIGNAL_LAST, i;
664 const char *p = own_buf + strlen ("QProgramSignals:");
665 CORE_ADDR cursig;
667 cs.program_signals_p = 1;
669 p = decode_address_to_semicolon (&cursig, p);
670 for (i = 0; i < numsigs; i++)
672 if (i == cursig)
674 cs.program_signals[i] = 1;
675 if (*p == '\0')
676 /* Keep looping, to clear the remaining signals. */
677 cursig = -1;
678 else
679 p = decode_address_to_semicolon (&cursig, p);
681 else
682 cs.program_signals[i] = 0;
684 strcpy (own_buf, "OK");
685 return;
688 if (startswith (own_buf, "QCatchSyscalls:"))
690 const char *p = own_buf + sizeof ("QCatchSyscalls:") - 1;
691 int enabled = -1;
692 CORE_ADDR sysno;
693 struct process_info *process;
695 if (!target_running () || !target_supports_catch_syscall ())
697 write_enn (own_buf);
698 return;
701 if (strcmp (p, "0") == 0)
702 enabled = 0;
703 else if (p[0] == '1' && (p[1] == ';' || p[1] == '\0'))
704 enabled = 1;
705 else
707 fprintf (stderr, "Unknown catch-syscalls mode requested: %s\n",
708 own_buf);
709 write_enn (own_buf);
710 return;
713 process = current_process ();
714 process->syscalls_to_catch.clear ();
716 if (enabled)
718 p += 1;
719 if (*p == ';')
721 p += 1;
722 while (*p != '\0')
724 p = decode_address_to_semicolon (&sysno, p);
725 process->syscalls_to_catch.push_back (sysno);
728 else
729 process->syscalls_to_catch.push_back (ANY_SYSCALL);
732 write_ok (own_buf);
733 return;
736 if (strcmp (own_buf, "QEnvironmentReset") == 0)
738 our_environ = gdb_environ::from_host_environ ();
740 write_ok (own_buf);
741 return;
744 if (startswith (own_buf, "QEnvironmentHexEncoded:"))
746 const char *p = own_buf + sizeof ("QEnvironmentHexEncoded:") - 1;
747 /* The final form of the environment variable. FINAL_VAR will
748 hold the 'VAR=VALUE' format. */
749 std::string final_var = hex2str (p);
750 std::string var_name, var_value;
752 remote_debug_printf ("[QEnvironmentHexEncoded received '%s']", p);
753 remote_debug_printf ("[Environment variable to be set: '%s']",
754 final_var.c_str ());
756 size_t pos = final_var.find ('=');
757 if (pos == std::string::npos)
759 warning (_("Unexpected format for environment variable: '%s'"),
760 final_var.c_str ());
761 write_enn (own_buf);
762 return;
765 var_name = final_var.substr (0, pos);
766 var_value = final_var.substr (pos + 1, std::string::npos);
768 our_environ.set (var_name.c_str (), var_value.c_str ());
770 write_ok (own_buf);
771 return;
774 if (startswith (own_buf, "QEnvironmentUnset:"))
776 const char *p = own_buf + sizeof ("QEnvironmentUnset:") - 1;
777 std::string varname = hex2str (p);
779 remote_debug_printf ("[QEnvironmentUnset received '%s']", p);
780 remote_debug_printf ("[Environment variable to be unset: '%s']",
781 varname.c_str ());
783 our_environ.unset (varname.c_str ());
785 write_ok (own_buf);
786 return;
789 if (strcmp (own_buf, "QStartNoAckMode") == 0)
791 remote_debug_printf ("[noack mode enabled]");
793 cs.noack_mode = 1;
794 write_ok (own_buf);
795 return;
798 if (startswith (own_buf, "QNonStop:"))
800 char *mode = own_buf + 9;
801 int req = -1;
802 const char *req_str;
804 if (strcmp (mode, "0") == 0)
805 req = 0;
806 else if (strcmp (mode, "1") == 0)
807 req = 1;
808 else
810 /* We don't know what this mode is, so complain to
811 GDB. */
812 fprintf (stderr, "Unknown non-stop mode requested: %s\n",
813 own_buf);
814 write_enn (own_buf);
815 return;
818 req_str = req ? "non-stop" : "all-stop";
819 if (the_target->start_non_stop (req == 1) != 0)
821 fprintf (stderr, "Setting %s mode failed\n", req_str);
822 write_enn (own_buf);
823 return;
826 non_stop = (req != 0);
828 remote_debug_printf ("[%s mode enabled]", req_str);
830 write_ok (own_buf);
831 return;
834 if (startswith (own_buf, "QDisableRandomization:"))
836 char *packet = own_buf + strlen ("QDisableRandomization:");
837 ULONGEST setting;
839 unpack_varlen_hex (packet, &setting);
840 cs.disable_randomization = setting;
842 remote_debug_printf (cs.disable_randomization
843 ? "[address space randomization disabled]"
844 : "[address space randomization enabled]");
846 write_ok (own_buf);
847 return;
850 if (target_supports_tracepoints ()
851 && handle_tracepoint_general_set (own_buf))
852 return;
854 if (startswith (own_buf, "QAgent:"))
856 char *mode = own_buf + strlen ("QAgent:");
857 int req = 0;
859 if (strcmp (mode, "0") == 0)
860 req = 0;
861 else if (strcmp (mode, "1") == 0)
862 req = 1;
863 else
865 /* We don't know what this value is, so complain to GDB. */
866 sprintf (own_buf, "E.Unknown QAgent value");
867 return;
870 /* Update the flag. */
871 use_agent = req;
872 remote_debug_printf ("[%s agent]", req ? "Enable" : "Disable");
873 write_ok (own_buf);
874 return;
877 if (handle_btrace_general_set (own_buf))
878 return;
880 if (handle_btrace_conf_general_set (own_buf))
881 return;
883 if (startswith (own_buf, "QThreadEvents:"))
885 char *mode = own_buf + strlen ("QThreadEvents:");
886 enum tribool req = TRIBOOL_UNKNOWN;
888 if (strcmp (mode, "0") == 0)
889 req = TRIBOOL_FALSE;
890 else if (strcmp (mode, "1") == 0)
891 req = TRIBOOL_TRUE;
892 else
894 /* We don't know what this mode is, so complain to GDB. */
895 std::string err
896 = string_printf ("E.Unknown thread-events mode requested: %s\n",
897 mode);
898 strcpy (own_buf, err.c_str ());
899 return;
902 cs.report_thread_events = (req == TRIBOOL_TRUE);
904 remote_debug_printf ("[thread events are now %s]\n",
905 cs.report_thread_events ? "enabled" : "disabled");
907 write_ok (own_buf);
908 return;
911 if (startswith (own_buf, "QThreadOptions;"))
913 const char *p = own_buf + strlen ("QThreadOptions");
915 gdb_thread_options supported_options = target_supported_thread_options ();
916 if (supported_options == 0)
918 /* Something went wrong -- we don't support any option, but
919 GDB sent the packet anyway. */
920 write_enn (own_buf);
921 return;
924 /* We could store the options directly in thread->thread_options
925 without this map, but that would mean that a QThreadOptions
926 packet with a wildcard like "QThreadOptions;0;3:TID" would
927 result in the debug logs showing:
929 [options for TID are now 0x0]
930 [options for TID are now 0x3]
932 It's nicer if we only print the final options for each TID,
933 and if we only print about it if the options changed compared
934 to the options that were previously set on the thread. */
935 std::unordered_map<thread_info *, gdb_thread_options> set_options;
937 while (*p != '\0')
939 if (p[0] != ';')
941 write_enn (own_buf);
942 return;
944 p++;
946 /* Read the options. */
948 gdb_thread_options options = parse_gdb_thread_options (&p);
950 if ((options & ~supported_options) != 0)
952 /* GDB asked for an unknown or unsupported option, so
953 error out. */
954 std::string err
955 = string_printf ("E.Unknown thread options requested: %s\n",
956 to_string (options).c_str ());
957 strcpy (own_buf, err.c_str ());
958 return;
961 ptid_t ptid;
963 if (p[0] == ';' || p[0] == '\0')
964 ptid = minus_one_ptid;
965 else if (p[0] == ':')
967 const char *q;
969 ptid = read_ptid (p + 1, &q);
971 if (p == q)
973 write_enn (own_buf);
974 return;
976 p = q;
977 if (p[0] != ';' && p[0] != '\0')
979 write_enn (own_buf);
980 return;
983 else
985 write_enn (own_buf);
986 return;
989 /* Convert PID.-1 => PID.0 for ptid.matches. */
990 if (ptid.lwp () == -1)
991 ptid = ptid_t (ptid.pid ());
993 for_each_thread ([&] (thread_info *thread)
995 if (ptid_of (thread).matches (ptid))
996 set_options[thread] = options;
1000 for (const auto &iter : set_options)
1002 thread_info *thread = iter.first;
1003 gdb_thread_options options = iter.second;
1005 if (thread->thread_options != options)
1007 threads_debug_printf ("[options for %s are now %s]\n",
1008 target_pid_to_str (ptid_of (thread)).c_str (),
1009 to_string (options).c_str ());
1011 thread->thread_options = options;
1015 write_ok (own_buf);
1016 return;
1019 if (startswith (own_buf, "QStartupWithShell:"))
1021 const char *value = own_buf + strlen ("QStartupWithShell:");
1023 if (strcmp (value, "1") == 0)
1024 startup_with_shell = true;
1025 else if (strcmp (value, "0") == 0)
1026 startup_with_shell = false;
1027 else
1029 /* Unknown value. */
1030 fprintf (stderr, "Unknown value to startup-with-shell: %s\n",
1031 own_buf);
1032 write_enn (own_buf);
1033 return;
1036 remote_debug_printf ("[Inferior will %s started with shell]",
1037 startup_with_shell ? "be" : "not be");
1039 write_ok (own_buf);
1040 return;
1043 if (startswith (own_buf, "QSetWorkingDir:"))
1045 const char *p = own_buf + strlen ("QSetWorkingDir:");
1047 if (*p != '\0')
1049 std::string path = hex2str (p);
1051 remote_debug_printf ("[Set the inferior's current directory to %s]",
1052 path.c_str ());
1054 set_inferior_cwd (std::move (path));
1056 else
1058 /* An empty argument means that we should clear out any
1059 previously set cwd for the inferior. */
1060 set_inferior_cwd ("");
1062 remote_debug_printf ("[Unset the inferior's current directory; will "
1063 "use gdbserver's cwd]");
1065 write_ok (own_buf);
1067 return;
1071 /* Handle store memory tags packets. */
1072 if (startswith (own_buf, "QMemTags:")
1073 && target_supports_memory_tagging ())
1075 gdb::byte_vector tags;
1076 CORE_ADDR addr = 0;
1077 size_t len = 0;
1078 int type = 0;
1080 require_running_or_return (own_buf);
1082 bool ret = parse_store_memtags_request (own_buf, &addr, &len, tags,
1083 &type);
1085 if (ret)
1086 ret = the_target->store_memtags (addr, len, tags, type);
1088 if (!ret)
1089 write_enn (own_buf);
1090 else
1091 write_ok (own_buf);
1093 return;
1096 /* Otherwise we didn't know what packet it was. Say we didn't
1097 understand it. */
1098 own_buf[0] = 0;
1101 static const char *
1102 get_features_xml (const char *annex)
1104 const struct target_desc *desc = current_target_desc ();
1106 /* `desc->xmltarget' defines what to return when looking for the
1107 "target.xml" file. Its contents can either be verbatim XML code
1108 (prefixed with a '@') or else the name of the actual XML file to
1109 be used in place of "target.xml".
1111 This variable is set up from the auto-generated
1112 init_registers_... routine for the current target. */
1114 if (strcmp (annex, "target.xml") == 0)
1116 const char *ret = tdesc_get_features_xml (desc);
1118 if (*ret == '@')
1119 return ret + 1;
1120 else
1121 annex = ret;
1124 #ifdef USE_XML
1126 int i;
1128 /* Look for the annex. */
1129 for (i = 0; xml_builtin[i][0] != NULL; i++)
1130 if (strcmp (annex, xml_builtin[i][0]) == 0)
1131 break;
1133 if (xml_builtin[i][0] != NULL)
1134 return xml_builtin[i][1];
1136 #endif
1138 return NULL;
1141 static void
1142 monitor_show_help (void)
1144 monitor_output ("The following monitor commands are supported:\n");
1145 monitor_output (" set debug on\n");
1146 monitor_output (" Enable general debugging messages\n");
1147 monitor_output (" set debug off\n");
1148 monitor_output (" Disable all debugging messages\n");
1149 monitor_output (" set debug COMPONENT <off|on>\n");
1150 monitor_output (" Enable debugging messages for COMPONENT, which is\n");
1151 monitor_output (" one of: all, threads, remote, event-loop.\n");
1152 monitor_output (" set debug-hw-points <0|1>\n");
1153 monitor_output (" Enable h/w breakpoint/watchpoint debugging messages\n");
1154 monitor_output (" set debug-format option1[,option2,...]\n");
1155 monitor_output (" Add additional information to debugging messages\n");
1156 monitor_output (" Options: all, none, timestamp\n");
1157 monitor_output (" exit\n");
1158 monitor_output (" Quit GDBserver\n");
1161 /* Read trace frame or inferior memory. Returns the number of bytes
1162 actually read, zero when no further transfer is possible, and -1 on
1163 error. Return of a positive value smaller than LEN does not
1164 indicate there's no more to be read, only the end of the transfer.
1165 E.g., when GDB reads memory from a traceframe, a first request may
1166 be served from a memory block that does not cover the whole request
1167 length. A following request gets the rest served from either
1168 another block (of the same traceframe) or from the read-only
1169 regions. */
1171 static int
1172 gdb_read_memory (CORE_ADDR memaddr, unsigned char *myaddr, int len)
1174 client_state &cs = get_client_state ();
1175 int res;
1177 if (cs.current_traceframe >= 0)
1179 ULONGEST nbytes;
1180 ULONGEST length = len;
1182 if (traceframe_read_mem (cs.current_traceframe,
1183 memaddr, myaddr, len, &nbytes))
1184 return -1;
1185 /* Data read from trace buffer, we're done. */
1186 if (nbytes > 0)
1187 return nbytes;
1188 if (!in_readonly_region (memaddr, length))
1189 return -1;
1190 /* Otherwise we have a valid readonly case, fall through. */
1191 /* (assume no half-trace half-real blocks for now) */
1194 if (set_desired_process ())
1195 res = read_inferior_memory (memaddr, myaddr, len);
1196 else
1197 res = 1;
1199 return res == 0 ? len : -1;
1202 /* Write trace frame or inferior memory. Actually, writing to trace
1203 frames is forbidden. */
1205 static int
1206 gdb_write_memory (CORE_ADDR memaddr, const unsigned char *myaddr, int len)
1208 client_state &cs = get_client_state ();
1209 if (cs.current_traceframe >= 0)
1210 return EIO;
1211 else
1213 int ret;
1215 if (set_desired_process ())
1216 ret = target_write_memory (memaddr, myaddr, len);
1217 else
1218 ret = EIO;
1219 return ret;
1223 /* Handle qSearch:memory packets. */
1225 static void
1226 handle_search_memory (char *own_buf, int packet_len)
1228 CORE_ADDR start_addr;
1229 CORE_ADDR search_space_len;
1230 gdb_byte *pattern;
1231 unsigned int pattern_len;
1232 int found;
1233 CORE_ADDR found_addr;
1234 int cmd_name_len = sizeof ("qSearch:memory:") - 1;
1236 pattern = (gdb_byte *) malloc (packet_len);
1237 if (pattern == NULL)
1238 error ("Unable to allocate memory to perform the search");
1240 if (decode_search_memory_packet (own_buf + cmd_name_len,
1241 packet_len - cmd_name_len,
1242 &start_addr, &search_space_len,
1243 pattern, &pattern_len) < 0)
1245 free (pattern);
1246 error ("Error in parsing qSearch:memory packet");
1249 auto read_memory = [] (CORE_ADDR addr, gdb_byte *result, size_t len)
1251 return gdb_read_memory (addr, result, len) == len;
1254 found = simple_search_memory (read_memory, start_addr, search_space_len,
1255 pattern, pattern_len, &found_addr);
1257 if (found > 0)
1258 sprintf (own_buf, "1,%lx", (long) found_addr);
1259 else if (found == 0)
1260 strcpy (own_buf, "0");
1261 else
1262 strcpy (own_buf, "E00");
1264 free (pattern);
1267 /* Handle the "D" packet. */
1269 static void
1270 handle_detach (char *own_buf)
1272 client_state &cs = get_client_state ();
1274 process_info *process;
1276 if (cs.multi_process)
1278 /* skip 'D;' */
1279 int pid = strtol (&own_buf[2], NULL, 16);
1281 process = find_process_pid (pid);
1283 else
1285 process = (current_thread != nullptr
1286 ? get_thread_process (current_thread)
1287 : nullptr);
1290 if (process == NULL)
1292 write_enn (own_buf);
1293 return;
1296 if ((tracing && disconnected_tracing) || any_persistent_commands (process))
1298 if (tracing && disconnected_tracing)
1299 fprintf (stderr,
1300 "Disconnected tracing in effect, "
1301 "leaving gdbserver attached to the process\n");
1303 if (any_persistent_commands (process))
1304 fprintf (stderr,
1305 "Persistent commands are present, "
1306 "leaving gdbserver attached to the process\n");
1308 /* Make sure we're in non-stop/async mode, so we we can both
1309 wait for an async socket accept, and handle async target
1310 events simultaneously. There's also no point either in
1311 having the target stop all threads, when we're going to
1312 pass signals down without informing GDB. */
1313 if (!non_stop)
1315 threads_debug_printf ("Forcing non-stop mode");
1317 non_stop = true;
1318 the_target->start_non_stop (true);
1321 process->gdb_detached = 1;
1323 /* Detaching implicitly resumes all threads. */
1324 target_continue_no_signal (minus_one_ptid);
1326 write_ok (own_buf);
1327 return;
1330 fprintf (stderr, "Detaching from process %d\n", process->pid);
1331 stop_tracing ();
1333 /* We'll need this after PROCESS has been destroyed. */
1334 int pid = process->pid;
1336 /* If this process has an unreported fork child, that child is not known to
1337 GDB, so GDB won't take care of detaching it. We must do it here.
1339 Here, we specifically don't want to use "safe iteration", as detaching
1340 another process might delete the next thread in the iteration, which is
1341 the one saved by the safe iterator. We will never delete the currently
1342 iterated on thread, so standard iteration should be safe. */
1343 for (thread_info *thread : all_threads)
1345 /* Only threads that are of the process we are detaching. */
1346 if (thread->id.pid () != pid)
1347 continue;
1349 /* Only threads that have a pending fork event. */
1350 target_waitkind kind;
1351 thread_info *child = target_thread_pending_child (thread, &kind);
1352 if (child == nullptr || kind == TARGET_WAITKIND_THREAD_CLONED)
1353 continue;
1355 process_info *fork_child_process = get_thread_process (child);
1356 gdb_assert (fork_child_process != nullptr);
1358 int fork_child_pid = fork_child_process->pid;
1360 if (detach_inferior (fork_child_process) != 0)
1361 warning (_("Failed to detach fork child %s, child of %s"),
1362 target_pid_to_str (ptid_t (fork_child_pid)).c_str (),
1363 target_pid_to_str (thread->id).c_str ());
1366 if (detach_inferior (process) != 0)
1367 write_enn (own_buf);
1368 else
1370 discard_queued_stop_replies (ptid_t (pid));
1371 write_ok (own_buf);
1373 if (extended_protocol || target_running ())
1375 /* There is still at least one inferior remaining or
1376 we are in extended mode, so don't terminate gdbserver,
1377 and instead treat this like a normal program exit. */
1378 cs.last_status.set_exited (0);
1379 cs.last_ptid = ptid_t (pid);
1381 switch_to_thread (nullptr);
1383 else
1385 putpkt (own_buf);
1386 remote_close ();
1388 /* If we are attached, then we can exit. Otherwise, we
1389 need to hang around doing nothing, until the child is
1390 gone. */
1391 join_inferior (pid);
1392 exit (0);
1397 /* Parse options to --debug-format= and "monitor set debug-format".
1398 ARG is the text after "--debug-format=" or "monitor set debug-format".
1399 IS_MONITOR is non-zero if we're invoked via "monitor set debug-format".
1400 This triggers calls to monitor_output.
1401 The result is an empty string if all options were parsed ok, otherwise an
1402 error message which the caller must free.
1404 N.B. These commands affect all debug format settings, they are not
1405 cumulative. If a format is not specified, it is turned off.
1406 However, we don't go to extra trouble with things like
1407 "monitor set debug-format all,none,timestamp".
1408 Instead we just parse them one at a time, in order.
1410 The syntax for "monitor set debug" we support here is not identical
1411 to gdb's "set debug foo on|off" because we also use this function to
1412 parse "--debug-format=foo,bar". */
1414 static std::string
1415 parse_debug_format_options (const char *arg, int is_monitor)
1417 /* First turn all debug format options off. */
1418 debug_timestamp = 0;
1420 /* First remove leading spaces, for "monitor set debug-format". */
1421 while (isspace (*arg))
1422 ++arg;
1424 std::vector<gdb::unique_xmalloc_ptr<char>> options
1425 = delim_string_to_char_ptr_vec (arg, ',');
1427 for (const gdb::unique_xmalloc_ptr<char> &option : options)
1429 if (strcmp (option.get (), "all") == 0)
1431 debug_timestamp = 1;
1432 if (is_monitor)
1433 monitor_output ("All extra debug format options enabled.\n");
1435 else if (strcmp (option.get (), "none") == 0)
1437 debug_timestamp = 0;
1438 if (is_monitor)
1439 monitor_output ("All extra debug format options disabled.\n");
1441 else if (strcmp (option.get (), "timestamp") == 0)
1443 debug_timestamp = 1;
1444 if (is_monitor)
1445 monitor_output ("Timestamps will be added to debug output.\n");
1447 else if (*option == '\0')
1449 /* An empty option, e.g., "--debug-format=foo,,bar", is ignored. */
1450 continue;
1452 else
1453 return string_printf ("Unknown debug-format argument: \"%s\"\n",
1454 option.get ());
1457 return std::string ();
1460 /* A wrapper to enable, or disable a debug flag. These are debug flags
1461 that control the debug output from gdbserver, that developers might
1462 want, this is not something most end users will need. */
1464 struct debug_opt
1466 /* NAME is the name of this debug option, this should be a simple string
1467 containing no whitespace, starting with a letter from isalpha(), and
1468 contain only isalnum() characters and '_' underscore and '-' hyphen.
1470 SETTER is a callback function used to set the debug variable. This
1471 callback will be passed true to enable the debug setting, or false to
1472 disable the debug setting. */
1473 debug_opt (const char *name, std::function<void (bool)> setter)
1474 : m_name (name),
1475 m_setter (setter)
1477 gdb_assert (isalpha (*name));
1480 /* Called to enable or disable the debug setting. */
1481 void set (bool enable) const
1483 m_setter (enable);
1486 /* Return the name of this debug option. */
1487 const char *name () const
1488 { return m_name; }
1490 private:
1491 /* The name of this debug option. */
1492 const char *m_name;
1494 /* The callback to update the debug setting. */
1495 std::function<void (bool)> m_setter;
1498 /* The set of all debug options that gdbserver supports. These are the
1499 options that can be passed to the command line '--debug=...' flag, or to
1500 the monitor command 'monitor set debug ...'. */
1502 static std::vector<debug_opt> all_debug_opt {
1503 {"threads", [] (bool enable)
1505 debug_threads = enable;
1507 {"remote", [] (bool enable)
1509 remote_debug = enable;
1511 {"event-loop", [] (bool enable)
1513 debug_event_loop = (enable ? debug_event_loop_kind::ALL
1514 : debug_event_loop_kind::OFF);
1518 /* Parse the options to --debug=...
1520 OPTIONS is the string of debug components which should be enabled (or
1521 disabled), and must not be nullptr. An empty OPTIONS string is valid,
1522 in which case a default set of debug components will be enabled.
1524 An unknown, or otherwise invalid debug component will result in an
1525 exception being thrown.
1527 OPTIONS can consist of multiple debug component names separated by a
1528 comma. Debugging for each component will be turned on. The special
1529 component 'all' can be used to enable debugging for all components.
1531 A component can also be prefixed with '-' to disable debugging of that
1532 component, so a user might use: '--debug=all,-remote', to enable all
1533 debugging, except for the remote (protocol) component. Components are
1534 processed left to write in the OPTIONS list. */
1536 static void
1537 parse_debug_options (const char *options)
1539 gdb_assert (options != nullptr);
1541 /* Empty options means the "default" set. This exists mostly for
1542 backwards compatibility with gdbserver's legacy behaviour. */
1543 if (*options == '\0')
1544 options = "+threads";
1546 while (*options != '\0')
1548 const char *end = strchrnul (options, ',');
1550 bool enable = *options != '-';
1551 if (*options == '-' || *options == '+')
1552 ++options;
1554 std::string opt (options, end - options);
1556 if (opt.size () == 0)
1557 error ("invalid empty debug option");
1559 bool is_opt_all = opt == "all";
1561 bool found = false;
1562 for (const auto &debug_opt : all_debug_opt)
1563 if (is_opt_all || opt == debug_opt.name ())
1565 debug_opt.set (enable);
1566 found = true;
1567 if (!is_opt_all)
1568 break;
1571 if (!found)
1572 error ("unknown debug option '%s'", opt.c_str ());
1574 options = (*end == ',') ? end + 1 : end;
1578 /* Called from the 'monitor' command handler, to handle general 'set debug'
1579 monitor commands with one of the formats:
1581 set debug COMPONENT VALUE
1582 set debug VALUE
1584 In both of these command formats VALUE can be 'on', 'off', '1', or '0'
1585 with 1/0 being equivalent to on/off respectively.
1587 In the no-COMPONENT version of the command, if VALUE is 'on' (or '1')
1588 then the component 'threads' is assumed, this is for backward
1589 compatibility, but maybe in the future we might find a better "default"
1590 set of debug flags to enable.
1592 In the no-COMPONENT version of the command, if VALUE is 'off' (or '0')
1593 then all debugging is turned off.
1595 Otherwise, COMPONENT must be one of the known debug components, and that
1596 component is either enabled or disabled as appropriate.
1598 The string MON contains either 'COMPONENT VALUE' or just the 'VALUE' for
1599 the second command format, the 'set debug ' has been stripped off
1600 already.
1602 Return a string containing an error message if something goes wrong,
1603 this error can be returned as part of the monitor command output. If
1604 everything goes correctly then the debug global will have been updated,
1605 and an empty string is returned. */
1607 static std::string
1608 handle_general_monitor_debug (const char *mon)
1610 mon = skip_spaces (mon);
1612 if (*mon == '\0')
1613 return "No debug component name found.\n";
1615 /* Find the first word within MON. This is either the component name,
1616 or the value if no component has been given. */
1617 const char *end = skip_to_space (mon);
1618 std::string component (mon, end - mon);
1619 if (component.find (',') != component.npos || component[0] == '-'
1620 || component[0] == '+')
1621 return "Invalid character found in debug component name.\n";
1623 /* In ACTION_STR we create a string that will be passed to the
1624 parse_debug_options string. This will be either '+COMPONENT' or
1625 '-COMPONENT' depending on whether we want to enable or disable
1626 COMPONENT. */
1627 std::string action_str;
1629 /* If parse_debug_options succeeds, then MSG will be returned to the user
1630 as the output of the monitor command. */
1631 std::string msg;
1633 /* Check for 'set debug off', this disables all debug output. */
1634 if (component == "0" || component == "off")
1636 if (*skip_spaces (end) != '\0')
1637 return string_printf
1638 ("Junk '%s' found at end of 'set debug %s' command.\n",
1639 skip_spaces (end), std::string (mon, end - mon).c_str ());
1641 action_str = "-all";
1642 msg = "All debug output disabled.\n";
1644 /* Check for 'set debug on', this disables a general set of debug. */
1645 else if (component == "1" || component == "on")
1647 if (*skip_spaces (end) != '\0')
1648 return string_printf
1649 ("Junk '%s' found at end of 'set debug %s' command.\n",
1650 skip_spaces (end), std::string (mon, end - mon).c_str ());
1652 action_str = "+threads";
1653 msg = "General debug output enabled.\n";
1655 /* Otherwise we should have 'set debug COMPONENT VALUE'. Extract the two
1656 parts and validate. */
1657 else
1659 /* Figure out the value the user passed. */
1660 const char *value_start = skip_spaces (end);
1661 if (*value_start == '\0')
1662 return string_printf ("Missing value for 'set debug %s' command.\n",
1663 mon);
1665 const char *after_value = skip_to_space (value_start);
1666 if (*skip_spaces (after_value) != '\0')
1667 return string_printf
1668 ("Junk '%s' found at end of 'set debug %s' command.\n",
1669 skip_spaces (after_value),
1670 std::string (mon, after_value - mon).c_str ());
1672 std::string value (value_start, after_value - value_start);
1674 /* Check VALUE to see if we are enabling, or disabling. */
1675 bool enable;
1676 if (value == "0" || value == "off")
1677 enable = false;
1678 else if (value == "1" || value == "on")
1679 enable = true;
1680 else
1681 return string_printf ("Invalid value '%s' for 'set debug %s'.\n",
1682 value.c_str (),
1683 std::string (mon, end - mon).c_str ());
1685 action_str = std::string (enable ? "+" : "-") + component;
1686 msg = string_printf ("Debug output for '%s' %s.\n", component.c_str (),
1687 enable ? "enabled" : "disabled");
1690 gdb_assert (!msg.empty ());
1691 gdb_assert (!action_str.empty ());
1695 parse_debug_options (action_str.c_str ());
1696 monitor_output (msg.c_str ());
1698 catch (const gdb_exception_error &exception)
1700 return string_printf ("Error: %s\n", exception.what ());
1703 return {};
1706 /* Handle monitor commands not handled by target-specific handlers. */
1708 static void
1709 handle_monitor_command (char *mon, char *own_buf)
1711 if (startswith (mon, "set debug "))
1713 std::string error_msg
1714 = handle_general_monitor_debug (mon + sizeof ("set debug ") - 1);
1716 if (!error_msg.empty ())
1718 monitor_output (error_msg.c_str ());
1719 monitor_show_help ();
1720 write_enn (own_buf);
1723 else if (strcmp (mon, "set debug-hw-points 1") == 0)
1725 show_debug_regs = 1;
1726 monitor_output ("H/W point debugging output enabled.\n");
1728 else if (strcmp (mon, "set debug-hw-points 0") == 0)
1730 show_debug_regs = 0;
1731 monitor_output ("H/W point debugging output disabled.\n");
1733 else if (startswith (mon, "set debug-format "))
1735 std::string error_msg
1736 = parse_debug_format_options (mon + sizeof ("set debug-format ") - 1,
1739 if (!error_msg.empty ())
1741 monitor_output (error_msg.c_str ());
1742 monitor_show_help ();
1743 write_enn (own_buf);
1746 else if (strcmp (mon, "set debug-file") == 0)
1747 debug_set_output (nullptr);
1748 else if (startswith (mon, "set debug-file "))
1749 debug_set_output (mon + sizeof ("set debug-file ") - 1);
1750 else if (strcmp (mon, "help") == 0)
1751 monitor_show_help ();
1752 else if (strcmp (mon, "exit") == 0)
1753 exit_requested = true;
1754 else
1756 monitor_output ("Unknown monitor command.\n\n");
1757 monitor_show_help ();
1758 write_enn (own_buf);
1762 /* Associates a callback with each supported qXfer'able object. */
1764 struct qxfer
1766 /* The object this handler handles. */
1767 const char *object;
1769 /* Request that the target transfer up to LEN 8-bit bytes of the
1770 target's OBJECT. The OFFSET, for a seekable object, specifies
1771 the starting point. The ANNEX can be used to provide additional
1772 data-specific information to the target.
1774 Return the number of bytes actually transfered, zero when no
1775 further transfer is possible, -1 on error, -2 when the transfer
1776 is not supported, and -3 on a verbose error message that should
1777 be preserved. Return of a positive value smaller than LEN does
1778 not indicate the end of the object, only the end of the transfer.
1780 One, and only one, of readbuf or writebuf must be non-NULL. */
1781 int (*xfer) (const char *annex,
1782 gdb_byte *readbuf, const gdb_byte *writebuf,
1783 ULONGEST offset, LONGEST len);
1786 /* Handle qXfer:auxv:read. */
1788 static int
1789 handle_qxfer_auxv (const char *annex,
1790 gdb_byte *readbuf, const gdb_byte *writebuf,
1791 ULONGEST offset, LONGEST len)
1793 if (!the_target->supports_read_auxv () || writebuf != NULL)
1794 return -2;
1796 if (annex[0] != '\0' || current_thread == NULL)
1797 return -1;
1799 return the_target->read_auxv (current_thread->id.pid (), offset, readbuf,
1800 len);
1803 /* Handle qXfer:exec-file:read. */
1805 static int
1806 handle_qxfer_exec_file (const char *annex,
1807 gdb_byte *readbuf, const gdb_byte *writebuf,
1808 ULONGEST offset, LONGEST len)
1810 ULONGEST pid;
1811 int total_len;
1813 if (!the_target->supports_pid_to_exec_file () || writebuf != NULL)
1814 return -2;
1816 if (annex[0] == '\0')
1818 if (current_thread == NULL)
1819 return -1;
1821 pid = pid_of (current_thread);
1823 else
1825 annex = unpack_varlen_hex (annex, &pid);
1826 if (annex[0] != '\0')
1827 return -1;
1830 if (pid <= 0)
1831 return -1;
1833 const char *file = the_target->pid_to_exec_file (pid);
1834 if (file == NULL)
1835 return -1;
1837 total_len = strlen (file);
1839 if (offset > total_len)
1840 return -1;
1842 if (offset + len > total_len)
1843 len = total_len - offset;
1845 memcpy (readbuf, file + offset, len);
1846 return len;
1849 /* Handle qXfer:features:read. */
1851 static int
1852 handle_qxfer_features (const char *annex,
1853 gdb_byte *readbuf, const gdb_byte *writebuf,
1854 ULONGEST offset, LONGEST len)
1856 const char *document;
1857 size_t total_len;
1859 if (writebuf != NULL)
1860 return -2;
1862 if (!target_running ())
1863 return -1;
1865 /* Grab the correct annex. */
1866 document = get_features_xml (annex);
1867 if (document == NULL)
1868 return -1;
1870 total_len = strlen (document);
1872 if (offset > total_len)
1873 return -1;
1875 if (offset + len > total_len)
1876 len = total_len - offset;
1878 memcpy (readbuf, document + offset, len);
1879 return len;
1882 /* Handle qXfer:libraries:read. */
1884 static int
1885 handle_qxfer_libraries (const char *annex,
1886 gdb_byte *readbuf, const gdb_byte *writebuf,
1887 ULONGEST offset, LONGEST len)
1889 if (writebuf != NULL)
1890 return -2;
1892 if (annex[0] != '\0' || current_thread == NULL)
1893 return -1;
1895 std::string document = "<library-list version=\"1.0\">\n";
1897 process_info *proc = current_process ();
1898 for (const dll_info &dll : proc->all_dlls)
1899 document += string_printf
1900 (" <library name=\"%s\"><segment address=\"0x%s\"/></library>\n",
1901 dll.name.c_str (), paddress (dll.base_addr));
1903 document += "</library-list>\n";
1905 if (offset > document.length ())
1906 return -1;
1908 if (offset + len > document.length ())
1909 len = document.length () - offset;
1911 memcpy (readbuf, &document[offset], len);
1913 return len;
1916 /* Handle qXfer:libraries-svr4:read. */
1918 static int
1919 handle_qxfer_libraries_svr4 (const char *annex,
1920 gdb_byte *readbuf, const gdb_byte *writebuf,
1921 ULONGEST offset, LONGEST len)
1923 if (writebuf != NULL)
1924 return -2;
1926 if (current_thread == NULL
1927 || !the_target->supports_qxfer_libraries_svr4 ())
1928 return -1;
1930 return the_target->qxfer_libraries_svr4 (annex, readbuf, writebuf,
1931 offset, len);
1934 /* Handle qXfer:osadata:read. */
1936 static int
1937 handle_qxfer_osdata (const char *annex,
1938 gdb_byte *readbuf, const gdb_byte *writebuf,
1939 ULONGEST offset, LONGEST len)
1941 if (!the_target->supports_qxfer_osdata () || writebuf != NULL)
1942 return -2;
1944 return the_target->qxfer_osdata (annex, readbuf, NULL, offset, len);
1947 /* Handle qXfer:siginfo:read and qXfer:siginfo:write. */
1949 static int
1950 handle_qxfer_siginfo (const char *annex,
1951 gdb_byte *readbuf, const gdb_byte *writebuf,
1952 ULONGEST offset, LONGEST len)
1954 if (!the_target->supports_qxfer_siginfo ())
1955 return -2;
1957 if (annex[0] != '\0' || current_thread == NULL)
1958 return -1;
1960 return the_target->qxfer_siginfo (annex, readbuf, writebuf, offset, len);
1963 /* Handle qXfer:statictrace:read. */
1965 static int
1966 handle_qxfer_statictrace (const char *annex,
1967 gdb_byte *readbuf, const gdb_byte *writebuf,
1968 ULONGEST offset, LONGEST len)
1970 client_state &cs = get_client_state ();
1971 ULONGEST nbytes;
1973 if (writebuf != NULL)
1974 return -2;
1976 if (annex[0] != '\0' || current_thread == NULL
1977 || cs.current_traceframe == -1)
1978 return -1;
1980 if (traceframe_read_sdata (cs.current_traceframe, offset,
1981 readbuf, len, &nbytes))
1982 return -1;
1983 return nbytes;
1986 /* Helper for handle_qxfer_threads_proper.
1987 Emit the XML to describe the thread of INF. */
1989 static void
1990 handle_qxfer_threads_worker (thread_info *thread, std::string *buffer)
1992 ptid_t ptid = ptid_of (thread);
1993 char ptid_s[100];
1994 int core = target_core_of_thread (ptid);
1995 char core_s[21];
1996 const char *name = target_thread_name (ptid);
1997 int handle_len;
1998 gdb_byte *handle;
1999 bool handle_status = target_thread_handle (ptid, &handle, &handle_len);
2001 /* If this is a (v)fork/clone child (has a (v)fork/clone parent),
2002 GDB does not yet know about this thread, and must not know about
2003 it until it gets the corresponding (v)fork/clone event. Exclude
2004 this thread from the list. */
2005 if (target_thread_pending_parent (thread) != nullptr)
2006 return;
2008 write_ptid (ptid_s, ptid);
2010 string_xml_appendf (*buffer, "<thread id=\"%s\"", ptid_s);
2012 if (core != -1)
2014 sprintf (core_s, "%d", core);
2015 string_xml_appendf (*buffer, " core=\"%s\"", core_s);
2018 if (name != NULL)
2019 string_xml_appendf (*buffer, " name=\"%s\"", name);
2021 if (handle_status)
2023 char *handle_s = (char *) alloca (handle_len * 2 + 1);
2024 bin2hex (handle, handle_s, handle_len);
2025 string_xml_appendf (*buffer, " handle=\"%s\"", handle_s);
2028 string_xml_appendf (*buffer, "/>\n");
2031 /* Helper for handle_qxfer_threads. Return true on success, false
2032 otherwise. */
2034 static bool
2035 handle_qxfer_threads_proper (std::string *buffer)
2037 *buffer += "<threads>\n";
2039 /* The target may need to access memory and registers (e.g. via
2040 libthread_db) to fetch thread properties. Even if don't need to
2041 stop threads to access memory, we still will need to be able to
2042 access registers, and other ptrace accesses like
2043 PTRACE_GET_THREAD_AREA that require a paused thread. Pause all
2044 threads here, so that we pause each thread at most once for all
2045 accesses. */
2046 if (non_stop)
2047 target_pause_all (true);
2049 for_each_thread ([&] (thread_info *thread)
2051 handle_qxfer_threads_worker (thread, buffer);
2054 if (non_stop)
2055 target_unpause_all (true);
2057 *buffer += "</threads>\n";
2058 return true;
2061 /* Handle qXfer:threads:read. */
2063 static int
2064 handle_qxfer_threads (const char *annex,
2065 gdb_byte *readbuf, const gdb_byte *writebuf,
2066 ULONGEST offset, LONGEST len)
2068 static std::string result;
2070 if (writebuf != NULL)
2071 return -2;
2073 if (annex[0] != '\0')
2074 return -1;
2076 if (offset == 0)
2078 /* When asked for data at offset 0, generate everything and store into
2079 'result'. Successive reads will be served off 'result'. */
2080 result.clear ();
2082 bool res = handle_qxfer_threads_proper (&result);
2084 if (!res)
2085 return -1;
2088 if (offset >= result.length ())
2090 /* We're out of data. */
2091 result.clear ();
2092 return 0;
2095 if (len > result.length () - offset)
2096 len = result.length () - offset;
2098 memcpy (readbuf, result.c_str () + offset, len);
2100 return len;
2103 /* Handle qXfer:traceframe-info:read. */
2105 static int
2106 handle_qxfer_traceframe_info (const char *annex,
2107 gdb_byte *readbuf, const gdb_byte *writebuf,
2108 ULONGEST offset, LONGEST len)
2110 client_state &cs = get_client_state ();
2111 static std::string result;
2113 if (writebuf != NULL)
2114 return -2;
2116 if (!target_running () || annex[0] != '\0' || cs.current_traceframe == -1)
2117 return -1;
2119 if (offset == 0)
2121 /* When asked for data at offset 0, generate everything and
2122 store into 'result'. Successive reads will be served off
2123 'result'. */
2124 result.clear ();
2126 traceframe_read_info (cs.current_traceframe, &result);
2129 if (offset >= result.length ())
2131 /* We're out of data. */
2132 result.clear ();
2133 return 0;
2136 if (len > result.length () - offset)
2137 len = result.length () - offset;
2139 memcpy (readbuf, result.c_str () + offset, len);
2140 return len;
2143 /* Handle qXfer:fdpic:read. */
2145 static int
2146 handle_qxfer_fdpic (const char *annex, gdb_byte *readbuf,
2147 const gdb_byte *writebuf, ULONGEST offset, LONGEST len)
2149 if (!the_target->supports_read_loadmap ())
2150 return -2;
2152 if (current_thread == NULL)
2153 return -1;
2155 return the_target->read_loadmap (annex, offset, readbuf, len);
2158 /* Handle qXfer:btrace:read. */
2160 static int
2161 handle_qxfer_btrace (const char *annex,
2162 gdb_byte *readbuf, const gdb_byte *writebuf,
2163 ULONGEST offset, LONGEST len)
2165 client_state &cs = get_client_state ();
2166 static std::string cache;
2167 struct thread_info *thread;
2168 enum btrace_read_type type;
2169 int result;
2171 if (writebuf != NULL)
2172 return -2;
2174 if (cs.general_thread == null_ptid
2175 || cs.general_thread == minus_one_ptid)
2177 strcpy (cs.own_buf, "E.Must select a single thread.");
2178 return -3;
2181 thread = find_thread_ptid (cs.general_thread);
2182 if (thread == NULL)
2184 strcpy (cs.own_buf, "E.No such thread.");
2185 return -3;
2188 if (thread->btrace == NULL)
2190 strcpy (cs.own_buf, "E.Btrace not enabled.");
2191 return -3;
2194 if (strcmp (annex, "all") == 0)
2195 type = BTRACE_READ_ALL;
2196 else if (strcmp (annex, "new") == 0)
2197 type = BTRACE_READ_NEW;
2198 else if (strcmp (annex, "delta") == 0)
2199 type = BTRACE_READ_DELTA;
2200 else
2202 strcpy (cs.own_buf, "E.Bad annex.");
2203 return -3;
2206 if (offset == 0)
2208 cache.clear ();
2212 result = target_read_btrace (thread->btrace, &cache, type);
2213 if (result != 0)
2214 memcpy (cs.own_buf, cache.c_str (), cache.length ());
2216 catch (const gdb_exception_error &exception)
2218 sprintf (cs.own_buf, "E.%s", exception.what ());
2219 result = -1;
2222 if (result != 0)
2223 return -3;
2225 else if (offset > cache.length ())
2227 cache.clear ();
2228 return -3;
2231 if (len > cache.length () - offset)
2232 len = cache.length () - offset;
2234 memcpy (readbuf, cache.c_str () + offset, len);
2236 return len;
2239 /* Handle qXfer:btrace-conf:read. */
2241 static int
2242 handle_qxfer_btrace_conf (const char *annex,
2243 gdb_byte *readbuf, const gdb_byte *writebuf,
2244 ULONGEST offset, LONGEST len)
2246 client_state &cs = get_client_state ();
2247 static std::string cache;
2248 struct thread_info *thread;
2249 int result;
2251 if (writebuf != NULL)
2252 return -2;
2254 if (annex[0] != '\0')
2255 return -1;
2257 if (cs.general_thread == null_ptid
2258 || cs.general_thread == minus_one_ptid)
2260 strcpy (cs.own_buf, "E.Must select a single thread.");
2261 return -3;
2264 thread = find_thread_ptid (cs.general_thread);
2265 if (thread == NULL)
2267 strcpy (cs.own_buf, "E.No such thread.");
2268 return -3;
2271 if (thread->btrace == NULL)
2273 strcpy (cs.own_buf, "E.Btrace not enabled.");
2274 return -3;
2277 if (offset == 0)
2279 cache.clear ();
2283 result = target_read_btrace_conf (thread->btrace, &cache);
2284 if (result != 0)
2285 memcpy (cs.own_buf, cache.c_str (), cache.length ());
2287 catch (const gdb_exception_error &exception)
2289 sprintf (cs.own_buf, "E.%s", exception.what ());
2290 result = -1;
2293 if (result != 0)
2294 return -3;
2296 else if (offset > cache.length ())
2298 cache.clear ();
2299 return -3;
2302 if (len > cache.length () - offset)
2303 len = cache.length () - offset;
2305 memcpy (readbuf, cache.c_str () + offset, len);
2307 return len;
2310 static const struct qxfer qxfer_packets[] =
2312 { "auxv", handle_qxfer_auxv },
2313 { "btrace", handle_qxfer_btrace },
2314 { "btrace-conf", handle_qxfer_btrace_conf },
2315 { "exec-file", handle_qxfer_exec_file},
2316 { "fdpic", handle_qxfer_fdpic},
2317 { "features", handle_qxfer_features },
2318 { "libraries", handle_qxfer_libraries },
2319 { "libraries-svr4", handle_qxfer_libraries_svr4 },
2320 { "osdata", handle_qxfer_osdata },
2321 { "siginfo", handle_qxfer_siginfo },
2322 { "statictrace", handle_qxfer_statictrace },
2323 { "threads", handle_qxfer_threads },
2324 { "traceframe-info", handle_qxfer_traceframe_info },
2327 static int
2328 handle_qxfer (char *own_buf, int packet_len, int *new_packet_len_p)
2330 int i;
2331 char *object;
2332 char *rw;
2333 char *annex;
2334 char *offset;
2336 if (!startswith (own_buf, "qXfer:"))
2337 return 0;
2339 /* Grab the object, r/w and annex. */
2340 if (decode_xfer (own_buf + 6, &object, &rw, &annex, &offset) < 0)
2342 write_enn (own_buf);
2343 return 1;
2346 for (i = 0;
2347 i < sizeof (qxfer_packets) / sizeof (qxfer_packets[0]);
2348 i++)
2350 const struct qxfer *q = &qxfer_packets[i];
2352 if (strcmp (object, q->object) == 0)
2354 if (strcmp (rw, "read") == 0)
2356 unsigned char *data;
2357 int n;
2358 CORE_ADDR ofs;
2359 unsigned int len;
2361 /* Grab the offset and length. */
2362 if (decode_xfer_read (offset, &ofs, &len) < 0)
2364 write_enn (own_buf);
2365 return 1;
2368 /* Read one extra byte, as an indicator of whether there is
2369 more. */
2370 if (len > PBUFSIZ - 2)
2371 len = PBUFSIZ - 2;
2372 data = (unsigned char *) malloc (len + 1);
2373 if (data == NULL)
2375 write_enn (own_buf);
2376 return 1;
2378 n = (*q->xfer) (annex, data, NULL, ofs, len + 1);
2379 if (n == -2)
2381 free (data);
2382 return 0;
2384 else if (n == -3)
2386 /* Preserve error message. */
2388 else if (n < 0)
2389 write_enn (own_buf);
2390 else if (n > len)
2391 *new_packet_len_p = write_qxfer_response (own_buf, data, len, 1);
2392 else
2393 *new_packet_len_p = write_qxfer_response (own_buf, data, n, 0);
2395 free (data);
2396 return 1;
2398 else if (strcmp (rw, "write") == 0)
2400 int n;
2401 unsigned int len;
2402 CORE_ADDR ofs;
2403 unsigned char *data;
2405 strcpy (own_buf, "E00");
2406 data = (unsigned char *) malloc (packet_len - (offset - own_buf));
2407 if (data == NULL)
2409 write_enn (own_buf);
2410 return 1;
2412 if (decode_xfer_write (offset, packet_len - (offset - own_buf),
2413 &ofs, &len, data) < 0)
2415 free (data);
2416 write_enn (own_buf);
2417 return 1;
2420 n = (*q->xfer) (annex, NULL, data, ofs, len);
2421 if (n == -2)
2423 free (data);
2424 return 0;
2426 else if (n == -3)
2428 /* Preserve error message. */
2430 else if (n < 0)
2431 write_enn (own_buf);
2432 else
2433 sprintf (own_buf, "%x", n);
2435 free (data);
2436 return 1;
2439 return 0;
2443 return 0;
2446 /* Compute 32 bit CRC from inferior memory.
2448 On success, return 32 bit CRC.
2449 On failure, return (unsigned long long) -1. */
2451 static unsigned long long
2452 crc32 (CORE_ADDR base, int len, unsigned int crc)
2454 while (len--)
2456 unsigned char byte = 0;
2458 /* Return failure if memory read fails. */
2459 if (read_inferior_memory (base, &byte, 1) != 0)
2460 return (unsigned long long) -1;
2462 crc = xcrc32 (&byte, 1, crc);
2463 base++;
2465 return (unsigned long long) crc;
2468 /* Parse the qMemTags packet request into ADDR and LEN. */
2470 static void
2471 parse_fetch_memtags_request (char *request, CORE_ADDR *addr, size_t *len,
2472 int *type)
2474 gdb_assert (startswith (request, "qMemTags:"));
2476 const char *p = request + strlen ("qMemTags:");
2478 /* Read address and length. */
2479 unsigned int length = 0;
2480 p = decode_m_packet_params (p, addr, &length, ':');
2481 *len = length;
2483 /* Read the tag type. */
2484 ULONGEST tag_type = 0;
2485 p = unpack_varlen_hex (p, &tag_type);
2486 *type = (int) tag_type;
2489 /* Add supported btrace packets to BUF. */
2491 static void
2492 supported_btrace_packets (char *buf)
2494 strcat (buf, ";Qbtrace:bts+");
2495 strcat (buf, ";Qbtrace-conf:bts:size+");
2496 strcat (buf, ";Qbtrace:pt+");
2497 strcat (buf, ";Qbtrace-conf:pt:size+");
2498 strcat (buf, ";Qbtrace:off+");
2499 strcat (buf, ";qXfer:btrace:read+");
2500 strcat (buf, ";qXfer:btrace-conf:read+");
2503 /* Handle all of the extended 'q' packets. */
2505 static void
2506 handle_query (char *own_buf, int packet_len, int *new_packet_len_p)
2508 client_state &cs = get_client_state ();
2509 static std::list<thread_info *>::const_iterator thread_iter;
2511 /* Reply the current thread id. */
2512 if (strcmp ("qC", own_buf) == 0 && !disable_packet_qC)
2514 ptid_t ptid;
2515 require_running_or_return (own_buf);
2517 if (cs.general_thread != null_ptid && cs.general_thread != minus_one_ptid)
2518 ptid = cs.general_thread;
2519 else
2521 thread_iter = all_threads.begin ();
2522 ptid = (*thread_iter)->id;
2525 sprintf (own_buf, "QC");
2526 own_buf += 2;
2527 write_ptid (own_buf, ptid);
2528 return;
2531 if (strcmp ("qSymbol::", own_buf) == 0)
2533 scoped_restore_current_thread restore_thread;
2535 /* For qSymbol, GDB only changes the current thread if the
2536 previous current thread was of a different process. So if
2537 the previous thread is gone, we need to pick another one of
2538 the same process. This can happen e.g., if we followed an
2539 exec in a non-leader thread. */
2540 if (current_thread == NULL)
2542 thread_info *any_thread
2543 = find_any_thread_of_pid (cs.general_thread.pid ());
2544 switch_to_thread (any_thread);
2546 /* Just in case, if we didn't find a thread, then bail out
2547 instead of crashing. */
2548 if (current_thread == NULL)
2550 write_enn (own_buf);
2551 return;
2555 /* GDB is suggesting new symbols have been loaded. This may
2556 mean a new shared library has been detected as loaded, so
2557 take the opportunity to check if breakpoints we think are
2558 inserted, still are. Note that it isn't guaranteed that
2559 we'll see this when a shared library is loaded, and nor will
2560 we see this for unloads (although breakpoints in unloaded
2561 libraries shouldn't trigger), as GDB may not find symbols for
2562 the library at all. We also re-validate breakpoints when we
2563 see a second GDB breakpoint for the same address, and or when
2564 we access breakpoint shadows. */
2565 validate_breakpoints ();
2567 if (target_supports_tracepoints ())
2568 tracepoint_look_up_symbols ();
2570 if (current_thread != NULL)
2571 the_target->look_up_symbols ();
2573 strcpy (own_buf, "OK");
2574 return;
2577 if (!disable_packet_qfThreadInfo)
2579 if (strcmp ("qfThreadInfo", own_buf) == 0)
2581 require_running_or_return (own_buf);
2582 thread_iter = all_threads.begin ();
2584 *own_buf++ = 'm';
2585 ptid_t ptid = (*thread_iter)->id;
2586 write_ptid (own_buf, ptid);
2587 thread_iter++;
2588 return;
2591 if (strcmp ("qsThreadInfo", own_buf) == 0)
2593 require_running_or_return (own_buf);
2594 if (thread_iter != all_threads.end ())
2596 *own_buf++ = 'm';
2597 ptid_t ptid = (*thread_iter)->id;
2598 write_ptid (own_buf, ptid);
2599 thread_iter++;
2600 return;
2602 else
2604 sprintf (own_buf, "l");
2605 return;
2610 if (the_target->supports_read_offsets ()
2611 && strcmp ("qOffsets", own_buf) == 0)
2613 CORE_ADDR text, data;
2615 require_running_or_return (own_buf);
2616 if (the_target->read_offsets (&text, &data))
2617 sprintf (own_buf, "Text=%lX;Data=%lX;Bss=%lX",
2618 (long)text, (long)data, (long)data);
2619 else
2620 write_enn (own_buf);
2622 return;
2625 /* Protocol features query. */
2626 if (startswith (own_buf, "qSupported")
2627 && (own_buf[10] == ':' || own_buf[10] == '\0'))
2629 char *p = &own_buf[10];
2630 int gdb_supports_qRelocInsn = 0;
2632 /* Process each feature being provided by GDB. The first
2633 feature will follow a ':', and latter features will follow
2634 ';'. */
2635 if (*p == ':')
2637 std::vector<std::string> qsupported;
2638 std::vector<const char *> unknowns;
2640 /* Two passes, to avoid nested strtok calls in
2641 target_process_qsupported. */
2642 char *saveptr;
2643 for (p = strtok_r (p + 1, ";", &saveptr);
2644 p != NULL;
2645 p = strtok_r (NULL, ";", &saveptr))
2646 qsupported.emplace_back (p);
2648 for (const std::string &feature : qsupported)
2650 if (feature == "multiprocess+")
2652 /* GDB supports and wants multi-process support if
2653 possible. */
2654 if (target_supports_multi_process ())
2655 cs.multi_process = 1;
2657 else if (feature == "qRelocInsn+")
2659 /* GDB supports relocate instruction requests. */
2660 gdb_supports_qRelocInsn = 1;
2662 else if (feature == "swbreak+")
2664 /* GDB wants us to report whether a trap is caused
2665 by a software breakpoint and for us to handle PC
2666 adjustment if necessary on this target. */
2667 if (target_supports_stopped_by_sw_breakpoint ())
2668 cs.swbreak_feature = 1;
2670 else if (feature == "hwbreak+")
2672 /* GDB wants us to report whether a trap is caused
2673 by a hardware breakpoint. */
2674 if (target_supports_stopped_by_hw_breakpoint ())
2675 cs.hwbreak_feature = 1;
2677 else if (feature == "fork-events+")
2679 /* GDB supports and wants fork events if possible. */
2680 if (target_supports_fork_events ())
2681 cs.report_fork_events = 1;
2683 else if (feature == "vfork-events+")
2685 /* GDB supports and wants vfork events if possible. */
2686 if (target_supports_vfork_events ())
2687 cs.report_vfork_events = 1;
2689 else if (feature == "exec-events+")
2691 /* GDB supports and wants exec events if possible. */
2692 if (target_supports_exec_events ())
2693 cs.report_exec_events = 1;
2695 else if (feature == "vContSupported+")
2696 cs.vCont_supported = 1;
2697 else if (feature == "QThreadEvents+")
2699 else if (feature == "QThreadOptions+")
2701 else if (feature == "no-resumed+")
2703 /* GDB supports and wants TARGET_WAITKIND_NO_RESUMED
2704 events. */
2705 report_no_resumed = true;
2707 else if (feature == "memory-tagging+")
2709 /* GDB supports memory tagging features. */
2710 if (target_supports_memory_tagging ())
2711 cs.memory_tagging_feature = true;
2713 else
2715 /* Move the unknown features all together. */
2716 unknowns.push_back (feature.c_str ());
2720 /* Give the target backend a chance to process the unknown
2721 features. */
2722 target_process_qsupported (unknowns);
2725 sprintf (own_buf,
2726 "PacketSize=%x;QPassSignals+;QProgramSignals+;"
2727 "QStartupWithShell+;QEnvironmentHexEncoded+;"
2728 "QEnvironmentReset+;QEnvironmentUnset+;"
2729 "QSetWorkingDir+",
2730 PBUFSIZ - 1);
2732 if (target_supports_catch_syscall ())
2733 strcat (own_buf, ";QCatchSyscalls+");
2735 if (the_target->supports_qxfer_libraries_svr4 ())
2736 strcat (own_buf, ";qXfer:libraries-svr4:read+"
2737 ";augmented-libraries-svr4-read+");
2738 else
2740 /* We do not have any hook to indicate whether the non-SVR4 target
2741 backend supports qXfer:libraries:read, so always report it. */
2742 strcat (own_buf, ";qXfer:libraries:read+");
2745 if (the_target->supports_read_auxv ())
2746 strcat (own_buf, ";qXfer:auxv:read+");
2748 if (the_target->supports_qxfer_siginfo ())
2749 strcat (own_buf, ";qXfer:siginfo:read+;qXfer:siginfo:write+");
2751 if (the_target->supports_read_loadmap ())
2752 strcat (own_buf, ";qXfer:fdpic:read+");
2754 /* We always report qXfer:features:read, as targets may
2755 install XML files on a subsequent call to arch_setup.
2756 If we reported to GDB on startup that we don't support
2757 qXfer:feature:read at all, we will never be re-queried. */
2758 strcat (own_buf, ";qXfer:features:read+");
2760 if (cs.transport_is_reliable)
2761 strcat (own_buf, ";QStartNoAckMode+");
2763 if (the_target->supports_qxfer_osdata ())
2764 strcat (own_buf, ";qXfer:osdata:read+");
2766 if (target_supports_multi_process ())
2767 strcat (own_buf, ";multiprocess+");
2769 if (target_supports_fork_events ())
2770 strcat (own_buf, ";fork-events+");
2772 if (target_supports_vfork_events ())
2773 strcat (own_buf, ";vfork-events+");
2775 if (target_supports_exec_events ())
2776 strcat (own_buf, ";exec-events+");
2778 if (target_supports_non_stop ())
2779 strcat (own_buf, ";QNonStop+");
2781 if (target_supports_disable_randomization ())
2782 strcat (own_buf, ";QDisableRandomization+");
2784 strcat (own_buf, ";qXfer:threads:read+");
2786 if (target_supports_tracepoints ())
2788 strcat (own_buf, ";ConditionalTracepoints+");
2789 strcat (own_buf, ";TraceStateVariables+");
2790 strcat (own_buf, ";TracepointSource+");
2791 strcat (own_buf, ";DisconnectedTracing+");
2792 if (gdb_supports_qRelocInsn && target_supports_fast_tracepoints ())
2793 strcat (own_buf, ";FastTracepoints+");
2794 strcat (own_buf, ";StaticTracepoints+");
2795 strcat (own_buf, ";InstallInTrace+");
2796 strcat (own_buf, ";qXfer:statictrace:read+");
2797 strcat (own_buf, ";qXfer:traceframe-info:read+");
2798 strcat (own_buf, ";EnableDisableTracepoints+");
2799 strcat (own_buf, ";QTBuffer:size+");
2800 strcat (own_buf, ";tracenz+");
2803 if (target_supports_hardware_single_step ()
2804 || target_supports_software_single_step () )
2806 strcat (own_buf, ";ConditionalBreakpoints+");
2808 strcat (own_buf, ";BreakpointCommands+");
2810 if (target_supports_agent ())
2811 strcat (own_buf, ";QAgent+");
2813 if (the_target->supports_btrace ())
2814 supported_btrace_packets (own_buf);
2816 if (target_supports_stopped_by_sw_breakpoint ())
2817 strcat (own_buf, ";swbreak+");
2819 if (target_supports_stopped_by_hw_breakpoint ())
2820 strcat (own_buf, ";hwbreak+");
2822 if (the_target->supports_pid_to_exec_file ())
2823 strcat (own_buf, ";qXfer:exec-file:read+");
2825 strcat (own_buf, ";vContSupported+");
2827 gdb_thread_options supported_options = target_supported_thread_options ();
2828 if (supported_options != 0)
2830 char *end_buf = own_buf + strlen (own_buf);
2831 sprintf (end_buf, ";QThreadOptions=%s",
2832 phex_nz (supported_options, sizeof (supported_options)));
2835 strcat (own_buf, ";QThreadEvents+");
2837 strcat (own_buf, ";no-resumed+");
2839 if (target_supports_memory_tagging ())
2840 strcat (own_buf, ";memory-tagging+");
2842 /* Reinitialize components as needed for the new connection. */
2843 hostio_handle_new_gdb_connection ();
2844 target_handle_new_gdb_connection ();
2846 return;
2849 /* Thread-local storage support. */
2850 if (the_target->supports_get_tls_address ()
2851 && startswith (own_buf, "qGetTLSAddr:"))
2853 char *p = own_buf + 12;
2854 CORE_ADDR parts[2], address = 0;
2855 int i, err;
2856 ptid_t ptid = null_ptid;
2858 require_running_or_return (own_buf);
2860 for (i = 0; i < 3; i++)
2862 char *p2;
2863 int len;
2865 if (p == NULL)
2866 break;
2868 p2 = strchr (p, ',');
2869 if (p2)
2871 len = p2 - p;
2872 p2++;
2874 else
2876 len = strlen (p);
2877 p2 = NULL;
2880 if (i == 0)
2881 ptid = read_ptid (p, NULL);
2882 else
2883 decode_address (&parts[i - 1], p, len);
2884 p = p2;
2887 if (p != NULL || i < 3)
2888 err = 1;
2889 else
2891 struct thread_info *thread = find_thread_ptid (ptid);
2893 if (thread == NULL)
2894 err = 2;
2895 else
2896 err = the_target->get_tls_address (thread, parts[0], parts[1],
2897 &address);
2900 if (err == 0)
2902 strcpy (own_buf, paddress(address));
2903 return;
2905 else if (err > 0)
2907 write_enn (own_buf);
2908 return;
2911 /* Otherwise, pretend we do not understand this packet. */
2914 /* Windows OS Thread Information Block address support. */
2915 if (the_target->supports_get_tib_address ()
2916 && startswith (own_buf, "qGetTIBAddr:"))
2918 const char *annex;
2919 int n;
2920 CORE_ADDR tlb;
2921 ptid_t ptid = read_ptid (own_buf + 12, &annex);
2923 n = the_target->get_tib_address (ptid, &tlb);
2924 if (n == 1)
2926 strcpy (own_buf, paddress(tlb));
2927 return;
2929 else if (n == 0)
2931 write_enn (own_buf);
2932 return;
2934 return;
2937 /* Handle "monitor" commands. */
2938 if (startswith (own_buf, "qRcmd,"))
2940 char *mon = (char *) malloc (PBUFSIZ);
2941 int len = strlen (own_buf + 6);
2943 if (mon == NULL)
2945 write_enn (own_buf);
2946 return;
2949 if ((len % 2) != 0
2950 || hex2bin (own_buf + 6, (gdb_byte *) mon, len / 2) != len / 2)
2952 write_enn (own_buf);
2953 free (mon);
2954 return;
2956 mon[len / 2] = '\0';
2958 write_ok (own_buf);
2960 if (the_target->handle_monitor_command (mon) == 0)
2961 /* Default processing. */
2962 handle_monitor_command (mon, own_buf);
2964 free (mon);
2965 return;
2968 if (startswith (own_buf, "qSearch:memory:"))
2970 require_running_or_return (own_buf);
2971 handle_search_memory (own_buf, packet_len);
2972 return;
2975 if (strcmp (own_buf, "qAttached") == 0
2976 || startswith (own_buf, "qAttached:"))
2978 struct process_info *process;
2980 if (own_buf[sizeof ("qAttached") - 1])
2982 int pid = strtoul (own_buf + sizeof ("qAttached:") - 1, NULL, 16);
2983 process = find_process_pid (pid);
2985 else
2987 require_running_or_return (own_buf);
2988 process = current_process ();
2991 if (process == NULL)
2993 write_enn (own_buf);
2994 return;
2997 strcpy (own_buf, process->attached ? "1" : "0");
2998 return;
3001 if (startswith (own_buf, "qCRC:"))
3003 /* CRC check (compare-section). */
3004 const char *comma;
3005 ULONGEST base;
3006 int len;
3007 unsigned long long crc;
3009 require_running_or_return (own_buf);
3010 comma = unpack_varlen_hex (own_buf + 5, &base);
3011 if (*comma++ != ',')
3013 write_enn (own_buf);
3014 return;
3016 len = strtoul (comma, NULL, 16);
3017 crc = crc32 (base, len, 0xffffffff);
3018 /* Check for memory failure. */
3019 if (crc == (unsigned long long) -1)
3021 write_enn (own_buf);
3022 return;
3024 sprintf (own_buf, "C%lx", (unsigned long) crc);
3025 return;
3028 if (handle_qxfer (own_buf, packet_len, new_packet_len_p))
3029 return;
3031 if (target_supports_tracepoints () && handle_tracepoint_query (own_buf))
3032 return;
3034 /* Handle fetch memory tags packets. */
3035 if (startswith (own_buf, "qMemTags:")
3036 && target_supports_memory_tagging ())
3038 gdb::byte_vector tags;
3039 CORE_ADDR addr = 0;
3040 size_t len = 0;
3041 int type = 0;
3043 require_running_or_return (own_buf);
3045 parse_fetch_memtags_request (own_buf, &addr, &len, &type);
3047 bool ret = the_target->fetch_memtags (addr, len, tags, type);
3049 if (ret)
3050 ret = create_fetch_memtags_reply (own_buf, tags);
3052 if (!ret)
3053 write_enn (own_buf);
3055 *new_packet_len_p = strlen (own_buf);
3056 return;
3059 /* Otherwise we didn't know what packet it was. Say we didn't
3060 understand it. */
3061 own_buf[0] = 0;
3064 static void gdb_wants_all_threads_stopped (void);
3065 static void resume (struct thread_resume *actions, size_t n);
3067 /* The callback that is passed to visit_actioned_threads. */
3068 typedef int (visit_actioned_threads_callback_ftype)
3069 (const struct thread_resume *, struct thread_info *);
3071 /* Call CALLBACK for any thread to which ACTIONS applies to. Returns
3072 true if CALLBACK returns true. Returns false if no matching thread
3073 is found or CALLBACK results false.
3074 Note: This function is itself a callback for find_thread. */
3076 static bool
3077 visit_actioned_threads (thread_info *thread,
3078 const struct thread_resume *actions,
3079 size_t num_actions,
3080 visit_actioned_threads_callback_ftype *callback)
3082 for (size_t i = 0; i < num_actions; i++)
3084 const struct thread_resume *action = &actions[i];
3086 if (action->thread == minus_one_ptid
3087 || action->thread == thread->id
3088 || ((action->thread.pid ()
3089 == thread->id.pid ())
3090 && action->thread.lwp () == -1))
3092 if ((*callback) (action, thread))
3093 return true;
3097 return false;
3100 /* Callback for visit_actioned_threads. If the thread has a pending
3101 status to report, report it now. */
3103 static int
3104 handle_pending_status (const struct thread_resume *resumption,
3105 struct thread_info *thread)
3107 client_state &cs = get_client_state ();
3108 if (thread->status_pending_p)
3110 thread->status_pending_p = 0;
3112 cs.last_status = thread->last_status;
3113 cs.last_ptid = thread->id;
3114 prepare_resume_reply (cs.own_buf, cs.last_ptid, cs.last_status);
3115 return 1;
3117 return 0;
3120 /* Parse vCont packets. */
3121 static void
3122 handle_v_cont (char *own_buf)
3124 const char *p;
3125 int n = 0, i = 0;
3126 struct thread_resume *resume_info;
3127 struct thread_resume default_action { null_ptid };
3129 /* Count the number of semicolons in the packet. There should be one
3130 for every action. */
3131 p = &own_buf[5];
3132 while (p)
3134 n++;
3135 p++;
3136 p = strchr (p, ';');
3139 resume_info = (struct thread_resume *) malloc (n * sizeof (resume_info[0]));
3140 if (resume_info == NULL)
3141 goto err;
3143 p = &own_buf[5];
3144 while (*p)
3146 p++;
3148 memset (&resume_info[i], 0, sizeof resume_info[i]);
3150 if (p[0] == 's' || p[0] == 'S')
3151 resume_info[i].kind = resume_step;
3152 else if (p[0] == 'r')
3153 resume_info[i].kind = resume_step;
3154 else if (p[0] == 'c' || p[0] == 'C')
3155 resume_info[i].kind = resume_continue;
3156 else if (p[0] == 't')
3157 resume_info[i].kind = resume_stop;
3158 else
3159 goto err;
3161 if (p[0] == 'S' || p[0] == 'C')
3163 char *q;
3164 int sig = strtol (p + 1, &q, 16);
3165 if (p == q)
3166 goto err;
3167 p = q;
3169 if (!gdb_signal_to_host_p ((enum gdb_signal) sig))
3170 goto err;
3171 resume_info[i].sig = gdb_signal_to_host ((enum gdb_signal) sig);
3173 else if (p[0] == 'r')
3175 ULONGEST addr;
3177 p = unpack_varlen_hex (p + 1, &addr);
3178 resume_info[i].step_range_start = addr;
3180 if (*p != ',')
3181 goto err;
3183 p = unpack_varlen_hex (p + 1, &addr);
3184 resume_info[i].step_range_end = addr;
3186 else
3188 p = p + 1;
3191 if (p[0] == 0)
3193 resume_info[i].thread = minus_one_ptid;
3194 default_action = resume_info[i];
3196 /* Note: we don't increment i here, we'll overwrite this entry
3197 the next time through. */
3199 else if (p[0] == ':')
3201 const char *q;
3202 ptid_t ptid = read_ptid (p + 1, &q);
3204 if (p == q)
3205 goto err;
3206 p = q;
3207 if (p[0] != ';' && p[0] != 0)
3208 goto err;
3210 resume_info[i].thread = ptid;
3212 i++;
3216 if (i < n)
3217 resume_info[i] = default_action;
3219 resume (resume_info, n);
3220 free (resume_info);
3221 return;
3223 err:
3224 write_enn (own_buf);
3225 free (resume_info);
3226 return;
3229 /* Resume target with ACTIONS, an array of NUM_ACTIONS elements. */
3231 static void
3232 resume (struct thread_resume *actions, size_t num_actions)
3234 client_state &cs = get_client_state ();
3235 if (!non_stop)
3237 /* Check if among the threads that GDB wants actioned, there's
3238 one with a pending status to report. If so, skip actually
3239 resuming/stopping and report the pending event
3240 immediately. */
3242 thread_info *thread_with_status = find_thread ([&] (thread_info *thread)
3244 return visit_actioned_threads (thread, actions, num_actions,
3245 handle_pending_status);
3248 if (thread_with_status != NULL)
3249 return;
3251 enable_async_io ();
3254 the_target->resume (actions, num_actions);
3256 if (non_stop)
3257 write_ok (cs.own_buf);
3258 else
3260 cs.last_ptid = mywait (minus_one_ptid, &cs.last_status, 0, 1);
3262 if (cs.last_status.kind () == TARGET_WAITKIND_NO_RESUMED
3263 && !report_no_resumed)
3265 /* The client does not support this stop reply. At least
3266 return error. */
3267 sprintf (cs.own_buf, "E.No unwaited-for children left.");
3268 disable_async_io ();
3269 return;
3272 if (cs.last_status.kind () != TARGET_WAITKIND_EXITED
3273 && cs.last_status.kind () != TARGET_WAITKIND_SIGNALLED
3274 && cs.last_status.kind () != TARGET_WAITKIND_THREAD_EXITED
3275 && cs.last_status.kind () != TARGET_WAITKIND_NO_RESUMED)
3276 current_thread->last_status = cs.last_status;
3278 /* From the client's perspective, all-stop mode always stops all
3279 threads implicitly (and the target backend has already done
3280 so by now). Tag all threads as "want-stopped", so we don't
3281 resume them implicitly without the client telling us to. */
3282 gdb_wants_all_threads_stopped ();
3283 prepare_resume_reply (cs.own_buf, cs.last_ptid, cs.last_status);
3284 disable_async_io ();
3286 if (cs.last_status.kind () == TARGET_WAITKIND_EXITED
3287 || cs.last_status.kind () == TARGET_WAITKIND_SIGNALLED)
3288 target_mourn_inferior (cs.last_ptid);
3292 /* Attach to a new program. */
3293 static void
3294 handle_v_attach (char *own_buf)
3296 client_state &cs = get_client_state ();
3298 int pid = strtol (own_buf + 8, NULL, 16);
3302 if (attach_inferior (pid) == 0)
3304 /* Don't report shared library events after attaching, even if
3305 some libraries are preloaded. GDB will always poll the
3306 library list. Avoids the "stopped by shared library event"
3307 notice on the GDB side. */
3308 current_process ()->dlls_changed = false;
3310 if (non_stop)
3312 /* In non-stop, we don't send a resume reply. Stop events
3313 will follow up using the normal notification
3314 mechanism. */
3315 write_ok (own_buf);
3317 else
3318 prepare_resume_reply (own_buf, cs.last_ptid, cs.last_status);
3320 else
3322 /* Not supported. */
3323 own_buf[0] = 0;
3326 catch (const gdb_exception_error &exception)
3328 sprintf (own_buf, "E.%s", exception.what ());
3332 /* Decode an argument from the vRun packet buffer. PTR points to the
3333 first hex-encoded character in the buffer, and LEN is the number of
3334 characters to read from the packet buffer.
3336 If the argument decoding is successful, return a buffer containing the
3337 decoded argument, including a null terminator at the end.
3339 If the argument decoding fails for any reason, return nullptr. */
3341 static gdb::unique_xmalloc_ptr<char>
3342 decode_v_run_arg (const char *ptr, size_t len)
3344 /* Two hex characters are required for each decoded byte. */
3345 if (len % 2 != 0)
3346 return nullptr;
3348 /* The length in bytes needed for the decoded argument. */
3349 len /= 2;
3351 /* Buffer to decode the argument into. The '+ 1' is for the null
3352 terminator we will add. */
3353 char *arg = (char *) xmalloc (len + 1);
3355 /* Decode the argument from the packet and add a null terminator. We do
3356 this within a try block as invalid characters within the PTR buffer
3357 will cause hex2bin to throw an exception. Our caller relies on us
3358 returning nullptr in order to clean up some memory allocations. */
3361 hex2bin (ptr, (gdb_byte *) arg, len);
3362 arg[len] = '\0';
3364 catch (const gdb_exception_error &exception)
3366 return nullptr;
3369 return gdb::unique_xmalloc_ptr<char> (arg);
3372 /* Run a new program. */
3373 static void
3374 handle_v_run (char *own_buf)
3376 client_state &cs = get_client_state ();
3377 char *p, *next_p;
3378 std::vector<char *> new_argv;
3379 gdb::unique_xmalloc_ptr<char> new_program_name;
3380 int i;
3382 for (i = 0, p = own_buf + strlen ("vRun;");
3383 /* Exit condition is at the end of the loop. */;
3384 p = next_p + 1, ++i)
3386 next_p = strchr (p, ';');
3387 if (next_p == NULL)
3388 next_p = p + strlen (p);
3390 if (i == 0 && p == next_p)
3392 /* No program specified. */
3393 gdb_assert (new_program_name == nullptr);
3395 else if (p == next_p)
3397 /* Empty argument. */
3398 new_argv.push_back (xstrdup (""));
3400 else
3402 /* The length of the argument string in the packet. */
3403 size_t len = next_p - p;
3405 gdb::unique_xmalloc_ptr<char> arg = decode_v_run_arg (p, len);
3406 if (arg == nullptr)
3408 write_enn (own_buf);
3409 free_vector_argv (new_argv);
3410 return;
3413 if (i == 0)
3414 new_program_name = std::move (arg);
3415 else
3416 new_argv.push_back (arg.release ());
3418 if (*next_p == '\0')
3419 break;
3422 if (new_program_name == nullptr)
3424 /* GDB didn't specify a program to run. Use the program from the
3425 last run with the new argument list. */
3426 if (program_path.get () == nullptr)
3428 write_enn (own_buf);
3429 free_vector_argv (new_argv);
3430 return;
3433 else
3434 program_path.set (new_program_name.get ());
3436 /* Free the old argv and install the new one. */
3437 free_vector_argv (program_args);
3438 program_args = new_argv;
3442 target_create_inferior (program_path.get (), program_args);
3444 catch (const gdb_exception_error &exception)
3446 sprintf (own_buf, "E.%s", exception.what ());
3447 return;
3450 if (cs.last_status.kind () == TARGET_WAITKIND_STOPPED)
3452 prepare_resume_reply (own_buf, cs.last_ptid, cs.last_status);
3454 /* In non-stop, sending a resume reply doesn't set the general
3455 thread, but GDB assumes a vRun sets it (this is so GDB can
3456 query which is the main thread of the new inferior. */
3457 if (non_stop)
3458 cs.general_thread = cs.last_ptid;
3460 else
3461 write_enn (own_buf);
3464 /* Kill process. */
3465 static void
3466 handle_v_kill (char *own_buf)
3468 client_state &cs = get_client_state ();
3469 int pid;
3470 char *p = &own_buf[6];
3471 if (cs.multi_process)
3472 pid = strtol (p, NULL, 16);
3473 else
3474 pid = signal_pid;
3476 process_info *proc = find_process_pid (pid);
3478 if (proc != nullptr && kill_inferior (proc) == 0)
3480 cs.last_status.set_signalled (GDB_SIGNAL_KILL);
3481 cs.last_ptid = ptid_t (pid);
3482 discard_queued_stop_replies (cs.last_ptid);
3483 write_ok (own_buf);
3485 else
3486 write_enn (own_buf);
3489 /* Handle all of the extended 'v' packets. */
3490 void
3491 handle_v_requests (char *own_buf, int packet_len, int *new_packet_len)
3493 client_state &cs = get_client_state ();
3494 if (!disable_packet_vCont)
3496 if (strcmp (own_buf, "vCtrlC") == 0)
3498 the_target->request_interrupt ();
3499 write_ok (own_buf);
3500 return;
3503 if (startswith (own_buf, "vCont;"))
3505 handle_v_cont (own_buf);
3506 return;
3509 if (startswith (own_buf, "vCont?"))
3511 strcpy (own_buf, "vCont;c;C;t");
3513 if (target_supports_hardware_single_step ()
3514 || target_supports_software_single_step ()
3515 || !cs.vCont_supported)
3517 /* If target supports single step either by hardware or by
3518 software, add actions s and S to the list of supported
3519 actions. On the other hand, if GDB doesn't request the
3520 supported vCont actions in qSupported packet, add s and
3521 S to the list too. */
3522 own_buf = own_buf + strlen (own_buf);
3523 strcpy (own_buf, ";s;S");
3526 if (target_supports_range_stepping ())
3528 own_buf = own_buf + strlen (own_buf);
3529 strcpy (own_buf, ";r");
3531 return;
3535 if (startswith (own_buf, "vFile:")
3536 && handle_vFile (own_buf, packet_len, new_packet_len))
3537 return;
3539 if (startswith (own_buf, "vAttach;"))
3541 if ((!extended_protocol || !cs.multi_process) && target_running ())
3543 fprintf (stderr, "Already debugging a process\n");
3544 write_enn (own_buf);
3545 return;
3547 handle_v_attach (own_buf);
3548 return;
3551 if (startswith (own_buf, "vRun;"))
3553 if ((!extended_protocol || !cs.multi_process) && target_running ())
3555 fprintf (stderr, "Already debugging a process\n");
3556 write_enn (own_buf);
3557 return;
3559 handle_v_run (own_buf);
3560 return;
3563 if (startswith (own_buf, "vKill;"))
3565 if (!target_running ())
3567 fprintf (stderr, "No process to kill\n");
3568 write_enn (own_buf);
3569 return;
3571 handle_v_kill (own_buf);
3572 return;
3575 if (handle_notif_ack (own_buf, packet_len))
3576 return;
3578 /* Otherwise we didn't know what packet it was. Say we didn't
3579 understand it. */
3580 own_buf[0] = 0;
3581 return;
3584 /* Resume thread and wait for another event. In non-stop mode,
3585 don't really wait here, but return immediately to the event
3586 loop. */
3587 static void
3588 myresume (char *own_buf, int step, int sig)
3590 client_state &cs = get_client_state ();
3591 struct thread_resume resume_info[2];
3592 int n = 0;
3593 int valid_cont_thread;
3595 valid_cont_thread = (cs.cont_thread != null_ptid
3596 && cs.cont_thread != minus_one_ptid);
3598 if (step || sig || valid_cont_thread)
3600 resume_info[0].thread = current_ptid;
3601 if (step)
3602 resume_info[0].kind = resume_step;
3603 else
3604 resume_info[0].kind = resume_continue;
3605 resume_info[0].sig = sig;
3606 n++;
3609 if (!valid_cont_thread)
3611 resume_info[n].thread = minus_one_ptid;
3612 resume_info[n].kind = resume_continue;
3613 resume_info[n].sig = 0;
3614 n++;
3617 resume (resume_info, n);
3620 /* Callback for for_each_thread. Make a new stop reply for each
3621 stopped thread. */
3623 static void
3624 queue_stop_reply_callback (thread_info *thread)
3626 /* For now, assume targets that don't have this callback also don't
3627 manage the thread's last_status field. */
3628 if (!the_target->supports_thread_stopped ())
3630 struct vstop_notif *new_notif = new struct vstop_notif;
3632 new_notif->ptid = thread->id;
3633 new_notif->status = thread->last_status;
3634 /* Pass the last stop reply back to GDB, but don't notify
3635 yet. */
3636 notif_event_enque (&notif_stop, new_notif);
3638 else
3640 if (target_thread_stopped (thread))
3642 threads_debug_printf
3643 ("Reporting thread %s as already stopped with %s",
3644 target_pid_to_str (thread->id).c_str (),
3645 thread->last_status.to_string ().c_str ());
3647 gdb_assert (thread->last_status.kind () != TARGET_WAITKIND_IGNORE);
3649 /* Pass the last stop reply back to GDB, but don't notify
3650 yet. */
3651 queue_stop_reply (thread->id, thread->last_status);
3656 /* Set this inferior threads's state as "want-stopped". We won't
3657 resume this thread until the client gives us another action for
3658 it. */
3660 static void
3661 gdb_wants_thread_stopped (thread_info *thread)
3663 thread->last_resume_kind = resume_stop;
3665 if (thread->last_status.kind () == TARGET_WAITKIND_IGNORE)
3667 /* Most threads are stopped implicitly (all-stop); tag that with
3668 signal 0. */
3669 thread->last_status.set_stopped (GDB_SIGNAL_0);
3673 /* Set all threads' states as "want-stopped". */
3675 static void
3676 gdb_wants_all_threads_stopped (void)
3678 for_each_thread (gdb_wants_thread_stopped);
3681 /* Callback for for_each_thread. If the thread is stopped with an
3682 interesting event, mark it as having a pending event. */
3684 static void
3685 set_pending_status_callback (thread_info *thread)
3687 if (thread->last_status.kind () != TARGET_WAITKIND_STOPPED
3688 || (thread->last_status.sig () != GDB_SIGNAL_0
3689 /* A breakpoint, watchpoint or finished step from a previous
3690 GDB run isn't considered interesting for a new GDB run.
3691 If we left those pending, the new GDB could consider them
3692 random SIGTRAPs. This leaves out real async traps. We'd
3693 have to peek into the (target-specific) siginfo to
3694 distinguish those. */
3695 && thread->last_status.sig () != GDB_SIGNAL_TRAP))
3696 thread->status_pending_p = 1;
3699 /* Status handler for the '?' packet. */
3701 static void
3702 handle_status (char *own_buf)
3704 client_state &cs = get_client_state ();
3706 /* GDB is connected, don't forward events to the target anymore. */
3707 for_each_process ([] (process_info *process) {
3708 process->gdb_detached = 0;
3711 /* In non-stop mode, we must send a stop reply for each stopped
3712 thread. In all-stop mode, just send one for the first stopped
3713 thread we find. */
3715 if (non_stop)
3717 for_each_thread (queue_stop_reply_callback);
3719 /* The first is sent immediatly. OK is sent if there is no
3720 stopped thread, which is the same handling of the vStopped
3721 packet (by design). */
3722 notif_write_event (&notif_stop, cs.own_buf);
3724 else
3726 thread_info *thread = NULL;
3728 target_pause_all (false);
3729 target_stabilize_threads ();
3730 gdb_wants_all_threads_stopped ();
3732 /* We can only report one status, but we might be coming out of
3733 non-stop -- if more than one thread is stopped with
3734 interesting events, leave events for the threads we're not
3735 reporting now pending. They'll be reported the next time the
3736 threads are resumed. Start by marking all interesting events
3737 as pending. */
3738 for_each_thread (set_pending_status_callback);
3740 /* Prefer the last thread that reported an event to GDB (even if
3741 that was a GDB_SIGNAL_TRAP). */
3742 if (cs.last_status.kind () != TARGET_WAITKIND_IGNORE
3743 && cs.last_status.kind () != TARGET_WAITKIND_EXITED
3744 && cs.last_status.kind () != TARGET_WAITKIND_SIGNALLED)
3745 thread = find_thread_ptid (cs.last_ptid);
3747 /* If the last event thread is not found for some reason, look
3748 for some other thread that might have an event to report. */
3749 if (thread == NULL)
3750 thread = find_thread ([] (thread_info *thr_arg)
3752 return thr_arg->status_pending_p;
3755 /* If we're still out of luck, simply pick the first thread in
3756 the thread list. */
3757 if (thread == NULL)
3758 thread = get_first_thread ();
3760 if (thread != NULL)
3762 struct thread_info *tp = (struct thread_info *) thread;
3764 /* We're reporting this event, so it's no longer
3765 pending. */
3766 tp->status_pending_p = 0;
3768 /* GDB assumes the current thread is the thread we're
3769 reporting the status for. */
3770 cs.general_thread = thread->id;
3771 set_desired_thread ();
3773 gdb_assert (tp->last_status.kind () != TARGET_WAITKIND_IGNORE);
3774 prepare_resume_reply (own_buf, tp->id, tp->last_status);
3776 else
3777 strcpy (own_buf, "W00");
3781 static void
3782 gdbserver_version (void)
3784 printf ("GNU gdbserver %s%s\n"
3785 "Copyright (C) 2024 Free Software Foundation, Inc.\n"
3786 "gdbserver is free software, covered by the "
3787 "GNU General Public License.\n"
3788 "This gdbserver was configured as \"%s\"\n",
3789 PKGVERSION, version, host_name);
3792 static void
3793 gdbserver_usage (FILE *stream)
3795 fprintf (stream, "Usage:\tgdbserver [OPTIONS] COMM PROG [ARGS ...]\n"
3796 "\tgdbserver [OPTIONS] --attach COMM PID\n"
3797 "\tgdbserver [OPTIONS] --multi COMM\n"
3798 "\n"
3799 "COMM may either be a tty device (for serial debugging),\n"
3800 "HOST:PORT to listen for a TCP connection, or '-' or 'stdio' to use \n"
3801 "stdin/stdout of gdbserver.\n"
3802 "PROG is the executable program. ARGS are arguments passed to inferior.\n"
3803 "PID is the process ID to attach to, when --attach is specified.\n"
3804 "\n"
3805 "Operating modes:\n"
3806 "\n"
3807 " --attach Attach to running process PID.\n"
3808 " --multi Start server without a specific program, and\n"
3809 " only quit when explicitly commanded.\n"
3810 " --once Exit after the first connection has closed.\n"
3811 " --help Print this message and then exit.\n"
3812 " --version Display version information and exit.\n"
3813 "\n"
3814 "Other options:\n"
3815 "\n"
3816 " --wrapper WRAPPER -- Run WRAPPER to start new programs.\n"
3817 " --disable-randomization\n"
3818 " Run PROG with address space randomization disabled.\n"
3819 " --no-disable-randomization\n"
3820 " Don't disable address space randomization when\n"
3821 " starting PROG.\n"
3822 " --startup-with-shell\n"
3823 " Start PROG using a shell. I.e., execs a shell that\n"
3824 " then execs PROG. (default)\n"
3825 " --no-startup-with-shell\n"
3826 " Exec PROG directly instead of using a shell.\n"
3827 " Disables argument globbing and variable substitution\n"
3828 " on UNIX-like systems.\n"
3829 "\n"
3830 "Debug options:\n"
3831 "\n"
3832 " --debug[=OPT1,OPT2,...]\n"
3833 " Enable debugging output.\n"
3834 " Options:\n"
3835 " all, threads, event-loop, remote\n"
3836 " With no options, 'threads' is assumed.\n"
3837 " Prefix an option with '-' to disable\n"
3838 " debugging of that component.\n"
3839 " --debug-format=OPT1[,OPT2,...]\n"
3840 " Specify extra content in debugging output.\n"
3841 " Options:\n"
3842 " all\n"
3843 " none\n"
3844 " timestamp\n"
3845 " --disable-packet=OPT1[,OPT2,...]\n"
3846 " Disable support for RSP packets or features.\n"
3847 " Options:\n"
3848 " vCont, T, Tthread, qC, qfThreadInfo and \n"
3849 " threads (disable all threading packets).\n"
3850 "\n"
3851 "For more information, consult the GDB manual (available as on-line \n"
3852 "info or a printed manual).\n");
3853 if (REPORT_BUGS_TO[0] && stream == stdout)
3854 fprintf (stream, "Report bugs to \"%s\".\n", REPORT_BUGS_TO);
3857 static void
3858 gdbserver_show_disableable (FILE *stream)
3860 fprintf (stream, "Disableable packets:\n"
3861 " vCont \tAll vCont packets\n"
3862 " qC \tQuerying the current thread\n"
3863 " qfThreadInfo\tThread listing\n"
3864 " Tthread \tPassing the thread specifier in the "
3865 "T stop reply packet\n"
3866 " threads \tAll of the above\n"
3867 " T \tAll 'T' packets\n");
3870 /* Start up the event loop. This is the entry point to the event
3871 loop. */
3873 static void
3874 start_event_loop ()
3876 /* Loop until there is nothing to do. This is the entry point to
3877 the event loop engine. If nothing is ready at this time, wait
3878 for something to happen (via wait_for_event), then process it.
3879 Return when there are no longer event sources to wait for. */
3881 keep_processing_events = true;
3882 while (keep_processing_events)
3884 /* Any events already waiting in the queue? */
3885 int res = gdb_do_one_event ();
3887 /* Was there an error? */
3888 if (res == -1)
3889 break;
3892 /* We are done with the event loop. There are no more event sources
3893 to listen to. So we exit gdbserver. */
3896 static void
3897 kill_inferior_callback (process_info *process)
3899 kill_inferior (process);
3900 discard_queued_stop_replies (ptid_t (process->pid));
3903 /* Call this when exiting gdbserver with possible inferiors that need
3904 to be killed or detached from. */
3906 static void
3907 detach_or_kill_for_exit (void)
3909 /* First print a list of the inferiors we will be killing/detaching.
3910 This is to assist the user, for example, in case the inferior unexpectedly
3911 dies after we exit: did we screw up or did the inferior exit on its own?
3912 Having this info will save some head-scratching. */
3914 if (have_started_inferiors_p ())
3916 fprintf (stderr, "Killing process(es):");
3918 for_each_process ([] (process_info *process) {
3919 if (!process->attached)
3920 fprintf (stderr, " %d", process->pid);
3923 fprintf (stderr, "\n");
3925 if (have_attached_inferiors_p ())
3927 fprintf (stderr, "Detaching process(es):");
3929 for_each_process ([] (process_info *process) {
3930 if (process->attached)
3931 fprintf (stderr, " %d", process->pid);
3934 fprintf (stderr, "\n");
3937 /* Now we can kill or detach the inferiors. */
3938 for_each_process ([] (process_info *process) {
3939 int pid = process->pid;
3941 if (process->attached)
3942 detach_inferior (process);
3943 else
3944 kill_inferior (process);
3946 discard_queued_stop_replies (ptid_t (pid));
3950 /* Value that will be passed to exit(3) when gdbserver exits. */
3951 static int exit_code;
3953 /* Wrapper for detach_or_kill_for_exit that catches and prints
3954 errors. */
3956 static void
3957 detach_or_kill_for_exit_cleanup ()
3961 detach_or_kill_for_exit ();
3963 catch (const gdb_exception &exception)
3965 fflush (stdout);
3966 fprintf (stderr, "Detach or kill failed: %s\n",
3967 exception.what ());
3968 exit_code = 1;
3972 #if GDB_SELF_TEST
3974 namespace selftests {
3976 static void
3977 test_memory_tagging_functions (void)
3979 /* Setup testing. */
3980 gdb::char_vector packet;
3981 gdb::byte_vector tags, bv;
3982 std::string expected;
3983 packet.resize (32000);
3984 CORE_ADDR addr;
3985 size_t len;
3986 int type;
3988 /* Test parsing a qMemTags request. */
3990 /* Valid request, addr, len and type updated. */
3991 addr = 0xff;
3992 len = 255;
3993 type = 255;
3994 strcpy (packet.data (), "qMemTags:0,0:0");
3995 parse_fetch_memtags_request (packet.data (), &addr, &len, &type);
3996 SELF_CHECK (addr == 0 && len == 0 && type == 0);
3998 /* Valid request, addr, len and type updated. */
3999 addr = 0;
4000 len = 0;
4001 type = 0;
4002 strcpy (packet.data (), "qMemTags:deadbeef,ff:5");
4003 parse_fetch_memtags_request (packet.data (), &addr, &len, &type);
4004 SELF_CHECK (addr == 0xdeadbeef && len == 255 && type == 5);
4006 /* Test creating a qMemTags reply. */
4008 /* Non-empty tag data. */
4009 bv.resize (0);
4011 for (int i = 0; i < 5; i++)
4012 bv.push_back (i);
4014 expected = "m0001020304";
4015 SELF_CHECK (create_fetch_memtags_reply (packet.data (), bv) == true);
4016 SELF_CHECK (strcmp (packet.data (), expected.c_str ()) == 0);
4018 /* Test parsing a QMemTags request. */
4020 /* Valid request and empty tag data: addr, len, type and tags updated. */
4021 addr = 0xff;
4022 len = 255;
4023 type = 255;
4024 tags.resize (5);
4025 strcpy (packet.data (), "QMemTags:0,0:0:");
4026 SELF_CHECK (parse_store_memtags_request (packet.data (),
4027 &addr, &len, tags, &type) == true);
4028 SELF_CHECK (addr == 0 && len == 0 && type == 0 && tags.size () == 0);
4030 /* Valid request and non-empty tag data: addr, len, type
4031 and tags updated. */
4032 addr = 0;
4033 len = 0;
4034 type = 0;
4035 tags.resize (0);
4036 strcpy (packet.data (),
4037 "QMemTags:deadbeef,ff:5:0001020304");
4038 SELF_CHECK (parse_store_memtags_request (packet.data (), &addr, &len, tags,
4039 &type) == true);
4040 SELF_CHECK (addr == 0xdeadbeef && len == 255 && type == 5
4041 && tags.size () == 5);
4044 } // namespace selftests
4045 #endif /* GDB_SELF_TEST */
4047 /* Main function. This is called by the real "main" function,
4048 wrapped in a TRY_CATCH that handles any uncaught exceptions. */
4050 static void ATTRIBUTE_NORETURN
4051 captured_main (int argc, char *argv[])
4053 int bad_attach;
4054 int pid;
4055 char *arg_end;
4056 const char *port = NULL;
4057 char **next_arg = &argv[1];
4058 volatile int multi_mode = 0;
4059 volatile int attach = 0;
4060 int was_running;
4061 bool selftest = false;
4062 #if GDB_SELF_TEST
4063 std::vector<const char *> selftest_filters;
4065 selftests::register_test ("remote_memory_tagging",
4066 selftests::test_memory_tagging_functions);
4067 #endif
4069 current_directory = getcwd (NULL, 0);
4070 client_state &cs = get_client_state ();
4072 if (current_directory == NULL)
4074 error (_("Could not find current working directory: %s"),
4075 safe_strerror (errno));
4078 while (*next_arg != NULL && **next_arg == '-')
4080 if (strcmp (*next_arg, "--version") == 0)
4082 gdbserver_version ();
4083 exit (0);
4085 else if (strcmp (*next_arg, "--help") == 0)
4087 gdbserver_usage (stdout);
4088 exit (0);
4090 else if (strcmp (*next_arg, "--attach") == 0)
4091 attach = 1;
4092 else if (strcmp (*next_arg, "--multi") == 0)
4093 multi_mode = 1;
4094 else if (strcmp (*next_arg, "--wrapper") == 0)
4096 char **tmp;
4098 next_arg++;
4100 tmp = next_arg;
4101 while (*next_arg != NULL && strcmp (*next_arg, "--") != 0)
4103 wrapper_argv += *next_arg;
4104 wrapper_argv += ' ';
4105 next_arg++;
4108 if (!wrapper_argv.empty ())
4110 /* Erase the last whitespace. */
4111 wrapper_argv.erase (wrapper_argv.end () - 1);
4114 if (next_arg == tmp || *next_arg == NULL)
4116 gdbserver_usage (stderr);
4117 exit (1);
4120 /* Consume the "--". */
4121 *next_arg = NULL;
4123 else if (startswith (*next_arg, "--debug="))
4127 parse_debug_options ((*next_arg) + sizeof ("--debug=") - 1);
4129 catch (const gdb_exception_error &exception)
4131 fflush (stdout);
4132 fprintf (stderr, "gdbserver: %s\n", exception.what ());
4133 exit (1);
4136 else if (strcmp (*next_arg, "--debug") == 0)
4140 parse_debug_options ("");
4142 catch (const gdb_exception_error &exception)
4144 fflush (stdout);
4145 fprintf (stderr, "gdbserver: %s\n", exception.what ());
4146 exit (1);
4149 else if (startswith (*next_arg, "--debug-format="))
4151 std::string error_msg
4152 = parse_debug_format_options ((*next_arg)
4153 + sizeof ("--debug-format=") - 1, 0);
4155 if (!error_msg.empty ())
4157 fprintf (stderr, "%s", error_msg.c_str ());
4158 exit (1);
4161 else if (startswith (*next_arg, "--debug-file="))
4162 debug_set_output ((*next_arg) + sizeof ("--debug-file=") -1);
4163 else if (strcmp (*next_arg, "--disable-packet") == 0)
4165 gdbserver_show_disableable (stdout);
4166 exit (0);
4168 else if (startswith (*next_arg, "--disable-packet="))
4170 char *packets = *next_arg += sizeof ("--disable-packet=") - 1;
4171 char *saveptr;
4172 for (char *tok = strtok_r (packets, ",", &saveptr);
4173 tok != NULL;
4174 tok = strtok_r (NULL, ",", &saveptr))
4176 if (strcmp ("vCont", tok) == 0)
4177 disable_packet_vCont = true;
4178 else if (strcmp ("Tthread", tok) == 0)
4179 disable_packet_Tthread = true;
4180 else if (strcmp ("qC", tok) == 0)
4181 disable_packet_qC = true;
4182 else if (strcmp ("qfThreadInfo", tok) == 0)
4183 disable_packet_qfThreadInfo = true;
4184 else if (strcmp ("T", tok) == 0)
4185 disable_packet_T = true;
4186 else if (strcmp ("threads", tok) == 0)
4188 disable_packet_vCont = true;
4189 disable_packet_Tthread = true;
4190 disable_packet_qC = true;
4191 disable_packet_qfThreadInfo = true;
4193 else
4195 fprintf (stderr, "Don't know how to disable \"%s\".\n\n",
4196 tok);
4197 gdbserver_show_disableable (stderr);
4198 exit (1);
4202 else if (strcmp (*next_arg, "-") == 0)
4204 /* "-" specifies a stdio connection and is a form of port
4205 specification. */
4206 port = STDIO_CONNECTION_NAME;
4207 next_arg++;
4208 break;
4210 else if (strcmp (*next_arg, "--disable-randomization") == 0)
4211 cs.disable_randomization = 1;
4212 else if (strcmp (*next_arg, "--no-disable-randomization") == 0)
4213 cs.disable_randomization = 0;
4214 else if (strcmp (*next_arg, "--startup-with-shell") == 0)
4215 startup_with_shell = true;
4216 else if (strcmp (*next_arg, "--no-startup-with-shell") == 0)
4217 startup_with_shell = false;
4218 else if (strcmp (*next_arg, "--once") == 0)
4219 run_once = true;
4220 else if (strcmp (*next_arg, "--selftest") == 0)
4221 selftest = true;
4222 else if (startswith (*next_arg, "--selftest="))
4224 selftest = true;
4226 #if GDB_SELF_TEST
4227 const char *filter = *next_arg + strlen ("--selftest=");
4228 if (*filter == '\0')
4230 fprintf (stderr, _("Error: selftest filter is empty.\n"));
4231 exit (1);
4234 selftest_filters.push_back (filter);
4235 #endif
4237 else
4239 fprintf (stderr, "Unknown argument: %s\n", *next_arg);
4240 exit (1);
4243 next_arg++;
4244 continue;
4247 if (port == NULL)
4249 port = *next_arg;
4250 next_arg++;
4252 if ((port == NULL || (!attach && !multi_mode && *next_arg == NULL))
4253 && !selftest)
4255 gdbserver_usage (stderr);
4256 exit (1);
4259 /* Remember stdio descriptors. LISTEN_DESC must not be listed, it will be
4260 opened by remote_prepare. */
4261 notice_open_fds ();
4263 save_original_signals_state (false);
4265 /* We need to know whether the remote connection is stdio before
4266 starting the inferior. Inferiors created in this scenario have
4267 stdin,stdout redirected. So do this here before we call
4268 start_inferior. */
4269 if (port != NULL)
4270 remote_prepare (port);
4272 bad_attach = 0;
4273 pid = 0;
4275 /* --attach used to come after PORT, so allow it there for
4276 compatibility. */
4277 if (*next_arg != NULL && strcmp (*next_arg, "--attach") == 0)
4279 attach = 1;
4280 next_arg++;
4283 if (attach
4284 && (*next_arg == NULL
4285 || (*next_arg)[0] == '\0'
4286 || (pid = strtoul (*next_arg, &arg_end, 0)) == 0
4287 || *arg_end != '\0'
4288 || next_arg[1] != NULL))
4289 bad_attach = 1;
4291 if (bad_attach)
4293 gdbserver_usage (stderr);
4294 exit (1);
4297 /* Gather information about the environment. */
4298 our_environ = gdb_environ::from_host_environ ();
4300 initialize_async_io ();
4301 initialize_low ();
4302 have_job_control ();
4303 if (target_supports_tracepoints ())
4304 initialize_tracepoint ();
4306 mem_buf = (unsigned char *) xmalloc (PBUFSIZ);
4308 if (selftest)
4310 #if GDB_SELF_TEST
4311 selftests::run_tests (selftest_filters);
4312 #else
4313 printf (_("Selftests have been disabled for this build.\n"));
4314 #endif
4315 throw_quit ("Quit");
4318 if (pid == 0 && *next_arg != NULL)
4320 int i, n;
4322 n = argc - (next_arg - argv);
4323 program_path.set (next_arg[0]);
4324 for (i = 1; i < n; i++)
4325 program_args.push_back (xstrdup (next_arg[i]));
4327 /* Wait till we are at first instruction in program. */
4328 target_create_inferior (program_path.get (), program_args);
4330 /* We are now (hopefully) stopped at the first instruction of
4331 the target process. This assumes that the target process was
4332 successfully created. */
4334 else if (pid != 0)
4336 if (attach_inferior (pid) == -1)
4337 error ("Attaching not supported on this target");
4339 /* Otherwise succeeded. */
4341 else
4343 cs.last_status.set_exited (0);
4344 cs.last_ptid = minus_one_ptid;
4347 SCOPE_EXIT { detach_or_kill_for_exit_cleanup (); };
4349 /* Don't report shared library events on the initial connection,
4350 even if some libraries are preloaded. Avoids the "stopped by
4351 shared library event" notice on gdb side. */
4352 if (current_thread != nullptr)
4353 current_process ()->dlls_changed = false;
4355 if (cs.last_status.kind () == TARGET_WAITKIND_EXITED
4356 || cs.last_status.kind () == TARGET_WAITKIND_SIGNALLED)
4357 was_running = 0;
4358 else
4359 was_running = 1;
4361 if (!was_running && !multi_mode)
4362 error ("No program to debug");
4364 while (1)
4366 cs.noack_mode = 0;
4367 cs.multi_process = 0;
4368 cs.report_fork_events = 0;
4369 cs.report_vfork_events = 0;
4370 cs.report_exec_events = 0;
4371 /* Be sure we're out of tfind mode. */
4372 cs.current_traceframe = -1;
4373 cs.cont_thread = null_ptid;
4374 cs.swbreak_feature = 0;
4375 cs.hwbreak_feature = 0;
4376 cs.vCont_supported = 0;
4377 cs.memory_tagging_feature = false;
4379 remote_open (port);
4383 /* Wait for events. This will return when all event sources
4384 are removed from the event loop. */
4385 start_event_loop ();
4387 /* If an exit was requested (using the "monitor exit"
4388 command), terminate now. */
4389 if (exit_requested)
4390 throw_quit ("Quit");
4392 /* The only other way to get here is for getpkt to fail:
4394 - If --once was specified, we're done.
4396 - If not in extended-remote mode, and we're no longer
4397 debugging anything, simply exit: GDB has disconnected
4398 after processing the last process exit.
4400 - Otherwise, close the connection and reopen it at the
4401 top of the loop. */
4402 if (run_once || (!extended_protocol && !target_running ()))
4403 throw_quit ("Quit");
4405 fprintf (stderr,
4406 "Remote side has terminated connection. "
4407 "GDBserver will reopen the connection.\n");
4409 /* Get rid of any pending statuses. An eventual reconnection
4410 (by the same GDB instance or another) will refresh all its
4411 state from scratch. */
4412 discard_queued_stop_replies (minus_one_ptid);
4413 for_each_thread ([] (thread_info *thread)
4415 thread->status_pending_p = 0;
4418 if (tracing)
4420 if (disconnected_tracing)
4422 /* Try to enable non-stop/async mode, so we we can
4423 both wait for an async socket accept, and handle
4424 async target events simultaneously. There's also
4425 no point either in having the target always stop
4426 all threads, when we're going to pass signals
4427 down without informing GDB. */
4428 if (!non_stop)
4430 if (the_target->start_non_stop (true))
4431 non_stop = 1;
4433 /* Detaching implicitly resumes all threads;
4434 simply disconnecting does not. */
4437 else
4439 fprintf (stderr,
4440 "Disconnected tracing disabled; "
4441 "stopping trace run.\n");
4442 stop_tracing ();
4446 catch (const gdb_exception_error &exception)
4448 fflush (stdout);
4449 fprintf (stderr, "gdbserver: %s\n", exception.what ());
4451 if (response_needed)
4453 write_enn (cs.own_buf);
4454 putpkt (cs.own_buf);
4457 if (run_once)
4458 throw_quit ("Quit");
4463 /* Main function. */
4466 main (int argc, char *argv[])
4468 setlocale (LC_CTYPE, "");
4472 captured_main (argc, argv);
4474 catch (const gdb_exception &exception)
4476 if (exception.reason == RETURN_ERROR)
4478 fflush (stdout);
4479 fprintf (stderr, "%s\n", exception.what ());
4480 fprintf (stderr, "Exiting\n");
4481 exit_code = 1;
4484 exit (exit_code);
4487 gdb_assert_not_reached ("captured_main should never return");
4490 /* Process options coming from Z packets for a breakpoint. PACKET is
4491 the packet buffer. *PACKET is updated to point to the first char
4492 after the last processed option. */
4494 static void
4495 process_point_options (struct gdb_breakpoint *bp, const char **packet)
4497 const char *dataptr = *packet;
4498 int persist;
4500 /* Check if data has the correct format. */
4501 if (*dataptr != ';')
4502 return;
4504 dataptr++;
4506 while (*dataptr)
4508 if (*dataptr == ';')
4509 ++dataptr;
4511 if (*dataptr == 'X')
4513 /* Conditional expression. */
4514 threads_debug_printf ("Found breakpoint condition.");
4515 if (!add_breakpoint_condition (bp, &dataptr))
4516 dataptr = strchrnul (dataptr, ';');
4518 else if (startswith (dataptr, "cmds:"))
4520 dataptr += strlen ("cmds:");
4521 threads_debug_printf ("Found breakpoint commands %s.", dataptr);
4522 persist = (*dataptr == '1');
4523 dataptr += 2;
4524 if (add_breakpoint_commands (bp, &dataptr, persist))
4525 dataptr = strchrnul (dataptr, ';');
4527 else
4529 fprintf (stderr, "Unknown token %c, ignoring.\n",
4530 *dataptr);
4531 /* Skip tokens until we find one that we recognize. */
4532 dataptr = strchrnul (dataptr, ';');
4535 *packet = dataptr;
4538 /* Event loop callback that handles a serial event. The first byte in
4539 the serial buffer gets us here. We expect characters to arrive at
4540 a brisk pace, so we read the rest of the packet with a blocking
4541 getpkt call. */
4543 static int
4544 process_serial_event (void)
4546 client_state &cs = get_client_state ();
4547 int signal;
4548 unsigned int len;
4549 CORE_ADDR mem_addr;
4550 unsigned char sig;
4551 int packet_len;
4552 int new_packet_len = -1;
4554 disable_async_io ();
4556 response_needed = false;
4557 packet_len = getpkt (cs.own_buf);
4558 if (packet_len <= 0)
4560 remote_close ();
4561 /* Force an event loop break. */
4562 return -1;
4564 response_needed = true;
4566 char ch = cs.own_buf[0];
4567 switch (ch)
4569 case 'q':
4570 handle_query (cs.own_buf, packet_len, &new_packet_len);
4571 break;
4572 case 'Q':
4573 handle_general_set (cs.own_buf);
4574 break;
4575 case 'D':
4576 handle_detach (cs.own_buf);
4577 break;
4578 case '!':
4579 extended_protocol = true;
4580 write_ok (cs.own_buf);
4581 break;
4582 case '?':
4583 handle_status (cs.own_buf);
4584 break;
4585 case 'H':
4586 if (cs.own_buf[1] == 'c' || cs.own_buf[1] == 'g' || cs.own_buf[1] == 's')
4588 require_running_or_break (cs.own_buf);
4590 ptid_t thread_id = read_ptid (&cs.own_buf[2], NULL);
4592 if (thread_id == null_ptid || thread_id == minus_one_ptid)
4593 thread_id = null_ptid;
4594 else if (thread_id.is_pid ())
4596 /* The ptid represents a pid. */
4597 thread_info *thread = find_any_thread_of_pid (thread_id.pid ());
4599 if (thread == NULL)
4601 write_enn (cs.own_buf);
4602 break;
4605 thread_id = thread->id;
4607 else
4609 /* The ptid represents a lwp/tid. */
4610 if (find_thread_ptid (thread_id) == NULL)
4612 write_enn (cs.own_buf);
4613 break;
4617 if (cs.own_buf[1] == 'g')
4619 if (thread_id == null_ptid)
4621 /* GDB is telling us to choose any thread. Check if
4622 the currently selected thread is still valid. If
4623 it is not, select the first available. */
4624 thread_info *thread = find_thread_ptid (cs.general_thread);
4625 if (thread == NULL)
4626 thread = get_first_thread ();
4627 thread_id = thread->id;
4630 cs.general_thread = thread_id;
4631 set_desired_thread ();
4632 gdb_assert (current_thread != NULL);
4634 else if (cs.own_buf[1] == 'c')
4635 cs.cont_thread = thread_id;
4637 write_ok (cs.own_buf);
4639 else
4641 /* Silently ignore it so that gdb can extend the protocol
4642 without compatibility headaches. */
4643 cs.own_buf[0] = '\0';
4645 break;
4646 case 'g':
4647 require_running_or_break (cs.own_buf);
4648 if (cs.current_traceframe >= 0)
4650 struct regcache *regcache
4651 = new_register_cache (current_target_desc ());
4653 if (fetch_traceframe_registers (cs.current_traceframe,
4654 regcache, -1) == 0)
4655 registers_to_string (regcache, cs.own_buf);
4656 else
4657 write_enn (cs.own_buf);
4658 free_register_cache (regcache);
4660 else
4662 struct regcache *regcache;
4664 if (!set_desired_thread ())
4665 write_enn (cs.own_buf);
4666 else
4668 regcache = get_thread_regcache (current_thread, 1);
4669 registers_to_string (regcache, cs.own_buf);
4672 break;
4673 case 'G':
4674 require_running_or_break (cs.own_buf);
4675 if (cs.current_traceframe >= 0)
4676 write_enn (cs.own_buf);
4677 else
4679 struct regcache *regcache;
4681 if (!set_desired_thread ())
4682 write_enn (cs.own_buf);
4683 else
4685 regcache = get_thread_regcache (current_thread, 1);
4686 registers_from_string (regcache, &cs.own_buf[1]);
4687 write_ok (cs.own_buf);
4690 break;
4691 case 'm':
4693 require_running_or_break (cs.own_buf);
4694 decode_m_packet (&cs.own_buf[1], &mem_addr, &len);
4695 int res = gdb_read_memory (mem_addr, mem_buf, len);
4696 if (res < 0)
4697 write_enn (cs.own_buf);
4698 else
4699 bin2hex (mem_buf, cs.own_buf, res);
4701 break;
4702 case 'M':
4703 require_running_or_break (cs.own_buf);
4704 decode_M_packet (&cs.own_buf[1], &mem_addr, &len, &mem_buf);
4705 if (gdb_write_memory (mem_addr, mem_buf, len) == 0)
4706 write_ok (cs.own_buf);
4707 else
4708 write_enn (cs.own_buf);
4709 break;
4710 case 'X':
4711 require_running_or_break (cs.own_buf);
4712 if (decode_X_packet (&cs.own_buf[1], packet_len - 1,
4713 &mem_addr, &len, &mem_buf) < 0
4714 || gdb_write_memory (mem_addr, mem_buf, len) != 0)
4715 write_enn (cs.own_buf);
4716 else
4717 write_ok (cs.own_buf);
4718 break;
4719 case 'C':
4720 require_running_or_break (cs.own_buf);
4721 hex2bin (cs.own_buf + 1, &sig, 1);
4722 if (gdb_signal_to_host_p ((enum gdb_signal) sig))
4723 signal = gdb_signal_to_host ((enum gdb_signal) sig);
4724 else
4725 signal = 0;
4726 myresume (cs.own_buf, 0, signal);
4727 break;
4728 case 'S':
4729 require_running_or_break (cs.own_buf);
4730 hex2bin (cs.own_buf + 1, &sig, 1);
4731 if (gdb_signal_to_host_p ((enum gdb_signal) sig))
4732 signal = gdb_signal_to_host ((enum gdb_signal) sig);
4733 else
4734 signal = 0;
4735 myresume (cs.own_buf, 1, signal);
4736 break;
4737 case 'c':
4738 require_running_or_break (cs.own_buf);
4739 signal = 0;
4740 myresume (cs.own_buf, 0, signal);
4741 break;
4742 case 's':
4743 require_running_or_break (cs.own_buf);
4744 signal = 0;
4745 myresume (cs.own_buf, 1, signal);
4746 break;
4747 case 'Z': /* insert_ ... */
4748 /* Fallthrough. */
4749 case 'z': /* remove_ ... */
4751 char *dataptr;
4752 ULONGEST addr;
4753 int kind;
4754 char type = cs.own_buf[1];
4755 int res;
4756 const int insert = ch == 'Z';
4757 const char *p = &cs.own_buf[3];
4759 p = unpack_varlen_hex (p, &addr);
4760 kind = strtol (p + 1, &dataptr, 16);
4762 if (insert)
4764 struct gdb_breakpoint *bp;
4766 bp = set_gdb_breakpoint (type, addr, kind, &res);
4767 if (bp != NULL)
4769 res = 0;
4771 /* GDB may have sent us a list of *point parameters to
4772 be evaluated on the target's side. Read such list
4773 here. If we already have a list of parameters, GDB
4774 is telling us to drop that list and use this one
4775 instead. */
4776 clear_breakpoint_conditions_and_commands (bp);
4777 const char *options = dataptr;
4778 process_point_options (bp, &options);
4781 else
4782 res = delete_gdb_breakpoint (type, addr, kind);
4784 if (res == 0)
4785 write_ok (cs.own_buf);
4786 else if (res == 1)
4787 /* Unsupported. */
4788 cs.own_buf[0] = '\0';
4789 else
4790 write_enn (cs.own_buf);
4791 break;
4793 case 'k':
4794 response_needed = false;
4795 if (!target_running ())
4796 /* The packet we received doesn't make sense - but we can't
4797 reply to it, either. */
4798 return 0;
4800 fprintf (stderr, "Killing all inferiors\n");
4802 for_each_process (kill_inferior_callback);
4804 /* When using the extended protocol, we wait with no program
4805 running. The traditional protocol will exit instead. */
4806 if (extended_protocol)
4808 cs.last_status.set_exited (GDB_SIGNAL_KILL);
4809 return 0;
4811 else
4812 exit (0);
4814 case 'T':
4816 require_running_or_break (cs.own_buf);
4818 ptid_t thread_id = read_ptid (&cs.own_buf[1], NULL);
4819 if (find_thread_ptid (thread_id) == NULL)
4821 write_enn (cs.own_buf);
4822 break;
4825 if (mythread_alive (thread_id))
4826 write_ok (cs.own_buf);
4827 else
4828 write_enn (cs.own_buf);
4830 break;
4831 case 'R':
4832 response_needed = false;
4834 /* Restarting the inferior is only supported in the extended
4835 protocol. */
4836 if (extended_protocol)
4838 if (target_running ())
4839 for_each_process (kill_inferior_callback);
4841 fprintf (stderr, "GDBserver restarting\n");
4843 /* Wait till we are at 1st instruction in prog. */
4844 if (program_path.get () != NULL)
4846 target_create_inferior (program_path.get (), program_args);
4848 if (cs.last_status.kind () == TARGET_WAITKIND_STOPPED)
4850 /* Stopped at the first instruction of the target
4851 process. */
4852 cs.general_thread = cs.last_ptid;
4854 else
4856 /* Something went wrong. */
4857 cs.general_thread = null_ptid;
4860 else
4862 cs.last_status.set_exited (GDB_SIGNAL_KILL);
4864 return 0;
4866 else
4868 /* It is a request we don't understand. Respond with an
4869 empty packet so that gdb knows that we don't support this
4870 request. */
4871 cs.own_buf[0] = '\0';
4872 break;
4874 case 'v':
4875 /* Extended (long) request. */
4876 handle_v_requests (cs.own_buf, packet_len, &new_packet_len);
4877 break;
4879 default:
4880 /* It is a request we don't understand. Respond with an empty
4881 packet so that gdb knows that we don't support this
4882 request. */
4883 cs.own_buf[0] = '\0';
4884 break;
4887 if (new_packet_len != -1)
4888 putpkt_binary (cs.own_buf, new_packet_len);
4889 else
4890 putpkt (cs.own_buf);
4892 response_needed = false;
4894 if (exit_requested)
4895 return -1;
4897 return 0;
4900 /* Event-loop callback for serial events. */
4902 void
4903 handle_serial_event (int err, gdb_client_data client_data)
4905 threads_debug_printf ("handling possible serial event");
4907 /* Really handle it. */
4908 if (process_serial_event () < 0)
4910 keep_processing_events = false;
4911 return;
4914 /* Be sure to not change the selected thread behind GDB's back.
4915 Important in the non-stop mode asynchronous protocol. */
4916 set_desired_thread ();
4919 /* Push a stop notification on the notification queue. */
4921 static void
4922 push_stop_notification (ptid_t ptid, const target_waitstatus &status)
4924 struct vstop_notif *vstop_notif = new struct vstop_notif;
4926 vstop_notif->status = status;
4927 vstop_notif->ptid = ptid;
4928 /* Push Stop notification. */
4929 notif_push (&notif_stop, vstop_notif);
4932 /* Event-loop callback for target events. */
4934 void
4935 handle_target_event (int err, gdb_client_data client_data)
4937 client_state &cs = get_client_state ();
4938 threads_debug_printf ("handling possible target event");
4940 cs.last_ptid = mywait (minus_one_ptid, &cs.last_status,
4941 TARGET_WNOHANG, 1);
4943 if (cs.last_status.kind () == TARGET_WAITKIND_NO_RESUMED)
4945 if (gdb_connected () && report_no_resumed)
4946 push_stop_notification (null_ptid, cs.last_status);
4948 else if (cs.last_status.kind () != TARGET_WAITKIND_IGNORE)
4950 int pid = cs.last_ptid.pid ();
4951 struct process_info *process = find_process_pid (pid);
4952 int forward_event = !gdb_connected () || process->gdb_detached;
4954 if (cs.last_status.kind () == TARGET_WAITKIND_EXITED
4955 || cs.last_status.kind () == TARGET_WAITKIND_SIGNALLED)
4957 mark_breakpoints_out (process);
4958 target_mourn_inferior (cs.last_ptid);
4960 else if (cs.last_status.kind () == TARGET_WAITKIND_THREAD_EXITED)
4962 else
4964 /* We're reporting this thread as stopped. Update its
4965 "want-stopped" state to what the client wants, until it
4966 gets a new resume action. */
4967 current_thread->last_resume_kind = resume_stop;
4968 current_thread->last_status = cs.last_status;
4971 if (forward_event)
4973 if (!target_running ())
4975 /* The last process exited. We're done. */
4976 exit (0);
4979 if (cs.last_status.kind () == TARGET_WAITKIND_EXITED
4980 || cs.last_status.kind () == TARGET_WAITKIND_SIGNALLED
4981 || cs.last_status.kind () == TARGET_WAITKIND_THREAD_EXITED)
4983 else
4985 /* A thread stopped with a signal, but gdb isn't
4986 connected to handle it. Pass it down to the
4987 inferior, as if it wasn't being traced. */
4988 enum gdb_signal signal;
4990 threads_debug_printf ("GDB not connected; forwarding event %d for"
4991 " [%s]",
4992 (int) cs.last_status.kind (),
4993 target_pid_to_str (cs.last_ptid).c_str ());
4995 if (cs.last_status.kind () == TARGET_WAITKIND_STOPPED)
4996 signal = cs.last_status.sig ();
4997 else
4998 signal = GDB_SIGNAL_0;
4999 target_continue (cs.last_ptid, signal);
5002 else
5004 push_stop_notification (cs.last_ptid, cs.last_status);
5006 if (cs.last_status.kind () == TARGET_WAITKIND_THREAD_EXITED
5007 && !target_any_resumed ())
5009 target_waitstatus ws;
5010 ws.set_no_resumed ();
5011 push_stop_notification (null_ptid, ws);
5016 /* Be sure to not change the selected thread behind GDB's back.
5017 Important in the non-stop mode asynchronous protocol. */
5018 set_desired_thread ();
5021 /* See gdbsupport/event-loop.h. */
5024 invoke_async_signal_handlers ()
5026 return 0;
5029 /* See gdbsupport/event-loop.h. */
5032 check_async_event_handlers ()
5034 return 0;
5037 /* See gdbsupport/errors.h */
5039 void
5040 flush_streams ()
5042 fflush (stdout);
5043 fflush (stderr);
5046 /* See gdbsupport/gdb_select.h. */
5049 gdb_select (int n, fd_set *readfds, fd_set *writefds,
5050 fd_set *exceptfds, struct timeval *timeout)
5052 return select (n, readfds, writefds, exceptfds, timeout);
5055 #if GDB_SELF_TEST
5056 namespace selftests
5059 void
5060 reset ()
5063 } // namespace selftests
5064 #endif /* GDB_SELF_TEST */