1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
25 #include "completer.h"
27 #include "gdbthread.h"
29 #include "observable.h"
32 #include "gdbsupport/environ.h"
33 #include "cli/cli-utils.h"
34 #include "continuations.h"
35 #include "arch-utils.h"
36 #include "target-descriptions.h"
37 #include "readline/tilde.h"
38 #include "progspace-and-thread.h"
40 /* Keep a registry of per-inferior data-pointers required by other GDB
43 DEFINE_REGISTRY (inferior
, REGISTRY_ACCESS_FIELD
)
45 struct inferior
*inferior_list
= NULL
;
46 static int highest_inferior_num
;
49 bool print_inferior_events
= true;
51 /* The Current Inferior. This is a strong reference. I.e., whenever
52 an inferior is the current inferior, its refcount is
54 static struct inferior
*current_inferior_
= NULL
;
57 current_inferior (void)
59 return current_inferior_
;
63 set_current_inferior (struct inferior
*inf
)
65 /* There's always an inferior. */
66 gdb_assert (inf
!= NULL
);
69 current_inferior_
->decref ();
70 current_inferior_
= inf
;
73 private_inferior::~private_inferior () = default;
75 inferior::~inferior ()
79 discard_all_inferior_continuations (inf
);
80 inferior_free_data (inf
);
82 xfree (inf
->terminal
);
83 target_desc_info_free (inf
->tdesc_info
);
86 inferior::inferior (int pid_
)
87 : num (++highest_inferior_num
),
89 environment (gdb_environ::from_host_environ ()),
92 inferior_alloc_data (this);
94 m_target_stack
.push (get_dummy_target ());
98 add_inferior_silent (int pid
)
100 inferior
*inf
= new inferior (pid
);
102 if (inferior_list
== NULL
)
108 for (last
= inferior_list
; last
->next
!= NULL
; last
= last
->next
)
113 gdb::observers::inferior_added
.notify (inf
);
116 inferior_appeared (inf
, pid
);
122 add_inferior (int pid
)
124 struct inferior
*inf
= add_inferior_silent (pid
);
126 if (print_inferior_events
)
129 printf_unfiltered (_("[New inferior %d (%s)]\n"),
131 target_pid_to_str (ptid_t (pid
)).c_str ());
133 printf_unfiltered (_("[New inferior %d]\n"), inf
->num
);
140 delete_inferior (struct inferior
*todel
)
142 struct inferior
*inf
, *infprev
;
146 for (inf
= inferior_list
; inf
; infprev
= inf
, inf
= inf
->next
)
153 for (thread_info
*tp
: inf
->threads_safe ())
154 delete_thread_silent (tp
);
157 infprev
->next
= inf
->next
;
159 inferior_list
= inf
->next
;
161 gdb::observers::inferior_removed
.notify (inf
);
163 /* If this program space is rendered useless, remove it. */
164 if (program_space_empty_p (inf
->pspace
))
165 delete_program_space (inf
->pspace
);
170 /* If SILENT then be quiet -- don't announce a inferior exit, or the
171 exit of its threads. */
174 exit_inferior_1 (struct inferior
*inftoex
, int silent
)
176 struct inferior
*inf
;
178 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
185 for (thread_info
*tp
: inf
->threads_safe ())
188 delete_thread_silent (tp
);
193 gdb::observers::inferior_exit
.notify (inf
);
196 inf
->fake_pid_p
= false;
199 if (inf
->vfork_parent
!= NULL
)
201 inf
->vfork_parent
->vfork_child
= NULL
;
202 inf
->vfork_parent
= NULL
;
204 if (inf
->vfork_child
!= NULL
)
206 inf
->vfork_child
->vfork_parent
= NULL
;
207 inf
->vfork_child
= NULL
;
210 inf
->pending_detach
= 0;
212 inf
->control
= inferior_control_state (NO_STOP_QUIETLY
);
214 /* Clear the register cache and the frame cache. */
215 registers_changed ();
216 reinit_frame_cache ();
220 exit_inferior (inferior
*inf
)
222 exit_inferior_1 (inf
, 0);
226 exit_inferior_silent (inferior
*inf
)
228 exit_inferior_1 (inf
, 1);
231 /* See inferior.h. */
234 detach_inferior (inferior
*inf
)
236 /* Save the pid, since exit_inferior_1 will reset it. */
239 exit_inferior_1 (inf
, 0);
241 if (print_inferior_events
)
242 printf_unfiltered (_("[Inferior %d (%s) detached]\n"),
244 target_pid_to_str (ptid_t (pid
)).c_str ());
248 inferior_appeared (struct inferior
*inf
, int pid
)
250 /* If this is the first inferior with threads, reset the global
252 delete_exited_threads ();
253 if (!any_thread_p ())
257 inf
->has_exit_code
= 0;
260 gdb::observers::inferior_appeared
.notify (inf
);
264 discard_all_inferiors (void)
266 for (inferior
*inf
: all_non_exited_inferiors ())
267 exit_inferior_silent (inf
);
271 find_inferior_id (int num
)
273 for (inferior
*inf
: all_inferiors ())
281 find_inferior_pid (process_stratum_target
*targ
, int pid
)
283 /* Looking for inferior pid == 0 is always wrong, and indicative of
284 a bug somewhere else. There may be more than one with pid == 0,
286 gdb_assert (pid
!= 0);
288 for (inferior
*inf
: all_inferiors (targ
))
298 find_inferior_ptid (process_stratum_target
*targ
, ptid_t ptid
)
300 return find_inferior_pid (targ
, ptid
.pid ());
303 /* See inferior.h. */
306 find_inferior_for_program_space (struct program_space
*pspace
)
308 struct inferior
*cur_inf
= current_inferior ();
310 if (cur_inf
->pspace
== pspace
)
313 for (inferior
*inf
: all_inferiors ())
314 if (inf
->pspace
== pspace
)
321 iterate_over_inferiors (int (*callback
) (struct inferior
*, void *),
324 for (inferior
*inf
: all_inferiors_safe ())
325 if ((*callback
) (inf
, data
))
332 have_inferiors (void)
334 for (inferior
*inf ATTRIBUTE_UNUSED
: all_non_exited_inferiors ())
340 /* Return the number of live inferiors. We account for the case
341 where an inferior might have a non-zero pid but no threads, as
342 in the middle of a 'mourn' operation. */
345 number_of_live_inferiors (process_stratum_target
*proc_target
)
349 for (inferior
*inf
: all_non_exited_inferiors (proc_target
))
350 if (inf
->has_execution ())
351 for (thread_info
*tp ATTRIBUTE_UNUSED
: inf
->non_exited_threads ())
353 /* Found a live thread in this inferior, go to the next
362 /* Return true if there is at least one live inferior. */
365 have_live_inferiors (void)
367 return number_of_live_inferiors (NULL
) > 0;
370 /* Prune away any unused inferiors, and then prune away no longer used
374 prune_inferiors (void)
381 if (!ss
->deletable ()
389 inferior
*ss_next
= ss
->next
;
390 delete_inferior (ss
);
395 /* Simply returns the count of inferiors. */
398 number_of_inferiors (void)
400 auto rng
= all_inferiors ();
401 return std::distance (rng
.begin (), rng
.end ());
404 /* Converts an inferior process id to a string. Like
405 target_pid_to_str, but special cases the null process. */
408 inferior_pid_to_str (int pid
)
411 return target_pid_to_str (ptid_t (pid
));
416 /* See inferior.h. */
419 print_selected_inferior (struct ui_out
*uiout
)
421 struct inferior
*inf
= current_inferior ();
422 const char *filename
= inf
->pspace
->pspace_exec_filename
;
424 if (filename
== NULL
)
425 filename
= _("<noexec>");
427 uiout
->message (_("[Switching to inferior %d [%s] (%s)]\n"),
428 inf
->num
, inferior_pid_to_str (inf
->pid
).c_str (), filename
);
431 /* Prints the list of inferiors and their details on UIOUT. This is a
432 version of 'info_inferior_command' suitable for use from MI.
434 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
435 inferiors that should be printed. Otherwise, all inferiors are
439 print_inferior (struct ui_out
*uiout
, const char *requested_inferiors
)
443 /* Compute number of inferiors we will print. */
444 for (inferior
*inf
: all_inferiors ())
446 if (!number_is_in_list (requested_inferiors
, inf
->num
))
454 uiout
->message ("No inferiors.\n");
458 ui_out_emit_table
table_emitter (uiout
, 4, inf_count
, "inferiors");
459 uiout
->table_header (1, ui_left
, "current", "");
460 uiout
->table_header (4, ui_left
, "number", "Num");
461 uiout
->table_header (17, ui_left
, "target-id", "Description");
462 uiout
->table_header (17, ui_left
, "exec", "Executable");
464 uiout
->table_body ();
465 for (inferior
*inf
: all_inferiors ())
467 if (!number_is_in_list (requested_inferiors
, inf
->num
))
470 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
472 if (inf
== current_inferior ())
473 uiout
->field_string ("current", "*");
475 uiout
->field_skip ("current");
477 uiout
->field_signed ("number", inf
->num
);
479 uiout
->field_string ("target-id", inferior_pid_to_str (inf
->pid
));
481 if (inf
->pspace
->pspace_exec_filename
!= NULL
)
482 uiout
->field_string ("exec", inf
->pspace
->pspace_exec_filename
);
484 uiout
->field_skip ("exec");
486 /* Print extra info that isn't really fit to always present in
487 tabular form. Currently we print the vfork parent/child
488 relationships, if any. */
489 if (inf
->vfork_parent
)
491 uiout
->text (_("\n\tis vfork child of inferior "));
492 uiout
->field_signed ("vfork-parent", inf
->vfork_parent
->num
);
494 if (inf
->vfork_child
)
496 uiout
->text (_("\n\tis vfork parent of inferior "));
497 uiout
->field_signed ("vfork-child", inf
->vfork_child
->num
);
505 detach_inferior_command (const char *args
, int from_tty
)
508 error (_("Requires argument (inferior id(s) to detach)"));
510 number_or_range_parser
parser (args
);
511 while (!parser
.finished ())
513 int num
= parser
.get_number ();
515 inferior
*inf
= find_inferior_id (num
);
518 warning (_("Inferior ID %d not known."), num
);
524 warning (_("Inferior ID %d is not running."), num
);
528 thread_info
*tp
= any_thread_of_inferior (inf
);
531 warning (_("Inferior ID %d has no threads."), num
);
535 switch_to_thread (tp
);
537 detach_command (NULL
, from_tty
);
542 kill_inferior_command (const char *args
, int from_tty
)
545 error (_("Requires argument (inferior id(s) to kill)"));
547 number_or_range_parser
parser (args
);
548 while (!parser
.finished ())
550 int num
= parser
.get_number ();
552 inferior
*inf
= find_inferior_id (num
);
555 warning (_("Inferior ID %d not known."), num
);
561 warning (_("Inferior ID %d is not running."), num
);
565 thread_info
*tp
= any_thread_of_inferior (inf
);
568 warning (_("Inferior ID %d has no threads."), num
);
572 switch_to_thread (tp
);
577 bfd_cache_close_all ();
580 /* See inferior.h. */
583 switch_to_inferior_no_thread (inferior
*inf
)
585 set_current_inferior (inf
);
586 switch_to_no_thread ();
587 set_current_program_space (inf
->pspace
);
591 inferior_command (const char *args
, int from_tty
)
593 struct inferior
*inf
;
596 num
= parse_and_eval_long (args
);
598 inf
= find_inferior_id (num
);
600 error (_("Inferior ID %d not known."), num
);
604 if (inf
!= current_inferior ())
606 thread_info
*tp
= any_thread_of_inferior (inf
);
608 error (_("Inferior has no threads."));
610 switch_to_thread (tp
);
613 gdb::observers::user_selected_context_changed
.notify
614 (USER_SELECTED_INFERIOR
615 | USER_SELECTED_THREAD
616 | USER_SELECTED_FRAME
);
620 switch_to_inferior_no_thread (inf
);
622 gdb::observers::user_selected_context_changed
.notify
623 (USER_SELECTED_INFERIOR
);
627 /* Print information about currently known inferiors. */
630 info_inferiors_command (const char *args
, int from_tty
)
632 print_inferior (current_uiout
, args
);
635 /* remove-inferior ID */
638 remove_inferior_command (const char *args
, int from_tty
)
640 if (args
== NULL
|| *args
== '\0')
641 error (_("Requires an argument (inferior id(s) to remove)"));
643 number_or_range_parser
parser (args
);
644 while (!parser
.finished ())
646 int num
= parser
.get_number ();
647 struct inferior
*inf
= find_inferior_id (num
);
651 warning (_("Inferior ID %d not known."), num
);
655 if (!inf
->deletable ())
657 warning (_("Can not remove current inferior %d."), num
);
663 warning (_("Can not remove active inferior %d."), num
);
667 delete_inferior (inf
);
672 add_inferior_with_spaces (void)
674 struct address_space
*aspace
;
675 struct program_space
*pspace
;
676 struct inferior
*inf
;
677 struct gdbarch_info info
;
679 /* If all inferiors share an address space on this system, this
680 doesn't really return a new address space; otherwise, it
682 aspace
= maybe_new_address_space ();
683 pspace
= new program_space (aspace
);
684 inf
= add_inferior (0);
685 inf
->pspace
= pspace
;
686 inf
->aspace
= pspace
->aspace
;
688 /* Setup the inferior's initial arch, based on information obtained
689 from the global "set ..." options. */
690 gdbarch_info_init (&info
);
691 inf
->gdbarch
= gdbarch_find_by_info (info
);
692 /* The "set ..." options reject invalid settings, so we should
693 always have a valid arch by now. */
694 gdb_assert (inf
->gdbarch
!= NULL
);
699 /* Switch to inferior NEW_INF, a new inferior, and unless
700 NO_CONNECTION is true, push the process_stratum_target of ORG_INF
704 switch_to_inferior_and_push_target (inferior
*new_inf
,
705 bool no_connection
, inferior
*org_inf
)
707 process_stratum_target
*proc_target
= org_inf
->process_target ();
709 /* Switch over temporarily, while reading executable and
711 switch_to_inferior_no_thread (new_inf
);
713 /* Reuse the target for new inferior. */
714 if (!no_connection
&& proc_target
!= NULL
)
715 push_target (proc_target
);
717 printf_filtered (_("Added inferior %d\n"), new_inf
->num
);
720 /* add-inferior [-copies N] [-exec FILENAME] [-no-connection] */
723 add_inferior_command (const char *args
, int from_tty
)
726 gdb::unique_xmalloc_ptr
<char> exec
;
727 symfile_add_flags add_flags
= 0;
728 bool no_connection
= false;
731 add_flags
|= SYMFILE_VERBOSE
;
735 gdb_argv
built_argv (args
);
737 for (char **argv
= built_argv
.get (); *argv
!= NULL
; argv
++)
741 if (strcmp (*argv
, "-copies") == 0)
745 error (_("No argument to -copies"));
746 copies
= parse_and_eval_long (*argv
);
748 else if (strcmp (*argv
, "-no-connection") == 0)
749 no_connection
= true;
750 else if (strcmp (*argv
, "-exec") == 0)
754 error (_("No argument to -exec"));
755 exec
.reset (tilde_expand (*argv
));
759 error (_("Invalid argument"));
763 inferior
*orginf
= current_inferior ();
765 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
767 for (i
= 0; i
< copies
; ++i
)
769 inferior
*inf
= add_inferior_with_spaces ();
771 switch_to_inferior_and_push_target (inf
, no_connection
, orginf
);
775 exec_file_attach (exec
.get (), from_tty
);
776 symbol_file_add_main (exec
.get (), add_flags
);
781 /* clone-inferior [-copies N] [ID] [-no-connection] */
784 clone_inferior_command (const char *args
, int from_tty
)
787 struct inferior
*orginf
= NULL
;
788 bool no_connection
= false;
792 gdb_argv
built_argv (args
);
794 char **argv
= built_argv
.get ();
795 for (; *argv
!= NULL
; argv
++)
799 if (strcmp (*argv
, "-copies") == 0)
803 error (_("No argument to -copies"));
804 copies
= parse_and_eval_long (*argv
);
807 error (_("Invalid copies number"));
809 else if (strcmp (*argv
, "-no-connection") == 0)
810 no_connection
= true;
818 /* The first non-option (-) argument specified the
820 num
= parse_and_eval_long (*argv
);
821 orginf
= find_inferior_id (num
);
824 error (_("Inferior ID %d not known."), num
);
828 error (_("Invalid argument"));
833 /* If no inferior id was specified, then the user wants to clone the
836 orginf
= current_inferior ();
838 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
840 for (i
= 0; i
< copies
; ++i
)
842 struct address_space
*aspace
;
843 struct program_space
*pspace
;
844 struct inferior
*inf
;
846 /* If all inferiors share an address space on this system, this
847 doesn't really return a new address space; otherwise, it
849 aspace
= maybe_new_address_space ();
850 pspace
= new program_space (aspace
);
851 inf
= add_inferior (0);
852 inf
->pspace
= pspace
;
853 inf
->aspace
= pspace
->aspace
;
854 inf
->gdbarch
= orginf
->gdbarch
;
856 switch_to_inferior_and_push_target (inf
, no_connection
, orginf
);
858 /* If the original inferior had a user specified target
859 description, make the clone use it too. */
860 if (target_desc_info_from_user_p (inf
->tdesc_info
))
861 copy_inferior_target_desc_info (inf
, orginf
);
863 clone_program_space (pspace
, orginf
->pspace
);
867 /* Print notices when new inferiors are created and die. */
869 show_print_inferior_events (struct ui_file
*file
, int from_tty
,
870 struct cmd_list_element
*c
, const char *value
)
872 fprintf_filtered (file
, _("Printing of inferior events is %s.\n"), value
);
875 /* Return a new value for the selected inferior's id. */
877 static struct value
*
878 inferior_id_make_value (struct gdbarch
*gdbarch
, struct internalvar
*var
,
881 struct inferior
*inf
= current_inferior ();
883 return value_from_longest (builtin_type (gdbarch
)->builtin_int
, inf
->num
);
886 /* Implementation of `$_inferior' variable. */
888 static const struct internalvar_funcs inferior_funcs
=
890 inferior_id_make_value
,
898 initialize_inferiors (void)
900 struct cmd_list_element
*c
= NULL
;
902 /* There's always one inferior. Note that this function isn't an
903 automatic _initialize_foo function, since other _initialize_foo
904 routines may need to install their per-inferior data keys. We
905 can only allocate an inferior when all those modules have done
906 that. Do this after initialize_progspace, due to the
907 current_program_space reference. */
908 current_inferior_
= add_inferior_silent (0);
909 current_inferior_
->incref ();
910 current_inferior_
->pspace
= current_program_space
;
911 current_inferior_
->aspace
= current_program_space
->aspace
;
912 /* The architecture will be initialized shortly, by
913 initialize_current_architecture. */
915 add_info ("inferiors", info_inferiors_command
,
916 _("Print a list of inferiors being managed.\n\
917 Usage: info inferiors [ID]...\n\
918 If IDs are specified, the list is limited to just those inferiors.\n\
919 By default all inferiors are displayed."));
921 c
= add_com ("add-inferior", no_class
, add_inferior_command
, _("\
922 Add a new inferior.\n\
923 Usage: add-inferior [-copies N] [-exec FILENAME] [-no-connection]\n\
924 N is the optional number of inferiors to add, default is 1.\n\
925 FILENAME is the file name of the executable to use\n\
927 By default, the new inferior inherits the current inferior's connection.\n\
928 If -no-connection is specified, the new inferior begins with\n\
929 no target connection yet."));
930 set_cmd_completer (c
, filename_completer
);
932 add_com ("remove-inferiors", no_class
, remove_inferior_command
, _("\
933 Remove inferior ID (or list of IDs).\n\
934 Usage: remove-inferiors ID..."));
936 add_com ("clone-inferior", no_class
, clone_inferior_command
, _("\
937 Clone inferior ID.\n\
938 Usage: clone-inferior [-copies N] [-no-connection] [ID]\n\
939 Add N copies of inferior ID. The new inferiors have the same\n\
940 executable loaded as the copied inferior. If -copies is not specified,\n\
941 adds 1 copy. If ID is not specified, it is the current inferior\n\
943 By default, the new inferiors inherit the copied inferior's connection.\n\
944 If -no-connection is specified, the new inferiors begin with\n\
945 no target connection yet."));
947 add_cmd ("inferiors", class_run
, detach_inferior_command
, _("\
948 Detach from inferior ID (or list of IDS).\n\
949 Usage; detach inferiors ID..."),
952 add_cmd ("inferiors", class_run
, kill_inferior_command
, _("\
953 Kill inferior ID (or list of IDs).\n\
954 Usage: kill inferiors ID..."),
957 add_cmd ("inferior", class_run
, inferior_command
, _("\
958 Use this command to switch between inferiors.\n\
959 Usage: inferior ID\n\
960 The new inferior ID must be currently known."),
963 add_setshow_boolean_cmd ("inferior-events", no_class
,
964 &print_inferior_events
, _("\
965 Set printing of inferior events (such as inferior start and exit)."), _("\
966 Show printing of inferior events (such as inferior start and exit)."), NULL
,
968 show_print_inferior_events
,
969 &setprintlist
, &showprintlist
);
971 create_internalvar_type_lazy ("_inferior", &inferior_funcs
, NULL
);