1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2018 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"
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 int print_inferior_events
= 1;
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);
96 add_inferior_silent (int pid
)
98 inferior
*inf
= new inferior (pid
);
100 if (inferior_list
== NULL
)
106 for (last
= inferior_list
; last
->next
!= NULL
; last
= last
->next
)
111 gdb::observers::inferior_added
.notify (inf
);
114 inferior_appeared (inf
, pid
);
120 add_inferior (int pid
)
122 struct inferior
*inf
= add_inferior_silent (pid
);
124 if (print_inferior_events
)
125 printf_unfiltered (_("[New inferior %d (%s)]\n"),
127 target_pid_to_str (ptid_t (pid
)));
132 struct delete_thread_of_inferior_arg
139 delete_thread_of_inferior (struct thread_info
*tp
, void *data
)
141 struct delete_thread_of_inferior_arg
*arg
142 = (struct delete_thread_of_inferior_arg
*) data
;
144 if (tp
->ptid
.pid () == arg
->pid
)
147 delete_thread_silent (tp
);
156 delete_inferior (struct inferior
*todel
)
158 struct inferior
*inf
, *infprev
;
159 struct delete_thread_of_inferior_arg arg
;
163 for (inf
= inferior_list
; inf
; infprev
= inf
, inf
= inf
->next
)
173 iterate_over_threads (delete_thread_of_inferior
, &arg
);
176 infprev
->next
= inf
->next
;
178 inferior_list
= inf
->next
;
180 gdb::observers::inferior_removed
.notify (inf
);
182 /* If this program space is rendered useless, remove it. */
183 if (program_space_empty_p (inf
->pspace
))
184 delete_program_space (inf
->pspace
);
189 /* If SILENT then be quiet -- don't announce a inferior exit, or the
190 exit of its threads. */
193 exit_inferior_1 (struct inferior
*inftoex
, int silent
)
195 struct inferior
*inf
;
196 struct delete_thread_of_inferior_arg arg
;
198 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
208 iterate_over_threads (delete_thread_of_inferior
, &arg
);
210 gdb::observers::inferior_exit
.notify (inf
);
216 if (inf
->vfork_parent
!= NULL
)
218 inf
->vfork_parent
->vfork_child
= NULL
;
219 inf
->vfork_parent
= NULL
;
221 if (inf
->vfork_child
!= NULL
)
223 inf
->vfork_child
->vfork_parent
= NULL
;
224 inf
->vfork_child
= NULL
;
227 inf
->pending_detach
= 0;
229 inf
->control
= inferior_control_state (NO_STOP_QUIETLY
);
233 exit_inferior (inferior
*inf
)
235 exit_inferior_1 (inf
, 0);
239 exit_inferior_silent (int pid
)
241 struct inferior
*inf
= find_inferior_pid (pid
);
243 exit_inferior_1 (inf
, 1);
247 exit_inferior_silent (inferior
*inf
)
249 exit_inferior_1 (inf
, 1);
252 /* See inferior.h. */
255 detach_inferior (inferior
*inf
)
257 /* Save the pid, since exit_inferior_1 will reset it. */
260 exit_inferior_1 (inf
, 0);
262 if (print_inferior_events
)
263 printf_unfiltered (_("[Inferior %d (%s) detached]\n"),
265 target_pid_to_str (ptid_t (pid
)));
269 inferior_appeared (struct inferior
*inf
, int pid
)
272 inf
->has_exit_code
= 0;
275 gdb::observers::inferior_appeared
.notify (inf
);
279 discard_all_inferiors (void)
281 struct inferior
*inf
;
283 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
286 exit_inferior_silent (inf
);
291 find_inferior_id (int num
)
293 struct inferior
*inf
;
295 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
303 find_inferior_pid (int pid
)
305 struct inferior
*inf
;
307 /* Looking for inferior pid == 0 is always wrong, and indicative of
308 a bug somewhere else. There may be more than one with pid == 0,
310 gdb_assert (pid
!= 0);
312 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
322 find_inferior_ptid (ptid_t ptid
)
324 return find_inferior_pid (ptid
.pid ());
327 /* See inferior.h. */
330 find_inferior_for_program_space (struct program_space
*pspace
)
332 struct inferior
*inf
= current_inferior ();
334 if (inf
->pspace
== pspace
)
337 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
339 if (inf
->pspace
== pspace
)
347 iterate_over_inferiors (int (*callback
) (struct inferior
*, void *),
350 struct inferior
*inf
, *infnext
;
352 for (inf
= inferior_list
; inf
; inf
= infnext
)
355 if ((*callback
) (inf
, data
))
363 have_inferiors (void)
365 struct inferior
*inf
;
367 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
374 /* Return the number of live inferiors. We account for the case
375 where an inferior might have a non-zero pid but no threads, as
376 in the middle of a 'mourn' operation. */
379 number_of_live_inferiors (void)
381 struct inferior
*inf
;
384 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
387 struct thread_info
*tp
;
389 ALL_NON_EXITED_THREADS (tp
)
390 if (tp
&& tp
->ptid
.pid () == inf
->pid
)
391 if (target_has_execution_1 (tp
->ptid
))
393 /* Found a live thread in this inferior, go to the next
403 /* Return true if there is at least one live inferior. */
406 have_live_inferiors (void)
408 return number_of_live_inferiors () > 0;
411 /* Prune away any unused inferiors, and then prune away no longer used
415 prune_inferiors (void)
417 struct inferior
*ss
, **ss_link
;
420 ss_link
= &inferior_list
;
423 if (!ss
->deletable ()
433 delete_inferior (ss
);
438 /* Simply returns the count of inferiors. */
441 number_of_inferiors (void)
443 struct inferior
*inf
;
446 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
452 /* Converts an inferior process id to a string. Like
453 target_pid_to_str, but special cases the null process. */
456 inferior_pid_to_str (int pid
)
459 return target_pid_to_str (ptid_t (pid
));
464 /* See inferior.h. */
467 print_selected_inferior (struct ui_out
*uiout
)
469 struct inferior
*inf
= current_inferior ();
470 const char *filename
= inf
->pspace
->pspace_exec_filename
;
472 if (filename
== NULL
)
473 filename
= _("<noexec>");
475 uiout
->message (_("[Switching to inferior %d [%s] (%s)]\n"),
476 inf
->num
, inferior_pid_to_str (inf
->pid
), filename
);
479 /* Prints the list of inferiors and their details on UIOUT. This is a
480 version of 'info_inferior_command' suitable for use from MI.
482 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
483 inferiors that should be printed. Otherwise, all inferiors are
487 print_inferior (struct ui_out
*uiout
, const char *requested_inferiors
)
489 struct inferior
*inf
;
492 /* Compute number of inferiors we will print. */
493 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
495 if (!number_is_in_list (requested_inferiors
, inf
->num
))
503 uiout
->message ("No inferiors.\n");
507 ui_out_emit_table
table_emitter (uiout
, 4, inf_count
, "inferiors");
508 uiout
->table_header (1, ui_left
, "current", "");
509 uiout
->table_header (4, ui_left
, "number", "Num");
510 uiout
->table_header (17, ui_left
, "target-id", "Description");
511 uiout
->table_header (17, ui_left
, "exec", "Executable");
513 uiout
->table_body ();
514 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
516 if (!number_is_in_list (requested_inferiors
, inf
->num
))
519 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
521 if (inf
== current_inferior ())
522 uiout
->field_string ("current", "*");
524 uiout
->field_skip ("current");
526 uiout
->field_int ("number", inf
->num
);
528 uiout
->field_string ("target-id", inferior_pid_to_str (inf
->pid
));
530 if (inf
->pspace
->pspace_exec_filename
!= NULL
)
531 uiout
->field_string ("exec", inf
->pspace
->pspace_exec_filename
);
533 uiout
->field_skip ("exec");
535 /* Print extra info that isn't really fit to always present in
536 tabular form. Currently we print the vfork parent/child
537 relationships, if any. */
538 if (inf
->vfork_parent
)
540 uiout
->text (_("\n\tis vfork child of inferior "));
541 uiout
->field_int ("vfork-parent", inf
->vfork_parent
->num
);
543 if (inf
->vfork_child
)
545 uiout
->text (_("\n\tis vfork parent of inferior "));
546 uiout
->field_int ("vfork-child", inf
->vfork_child
->num
);
554 detach_inferior_command (const char *args
, int from_tty
)
557 error (_("Requires argument (inferior id(s) to detach)"));
559 number_or_range_parser
parser (args
);
560 while (!parser
.finished ())
562 int num
= parser
.get_number ();
564 inferior
*inf
= find_inferior_id (num
);
567 warning (_("Inferior ID %d not known."), num
);
573 warning (_("Inferior ID %d is not running."), num
);
577 thread_info
*tp
= any_thread_of_inferior (inf
);
580 warning (_("Inferior ID %d has no threads."), num
);
584 switch_to_thread (tp
);
586 detach_command (NULL
, from_tty
);
591 kill_inferior_command (const char *args
, int from_tty
)
594 error (_("Requires argument (inferior id(s) to kill)"));
596 number_or_range_parser
parser (args
);
597 while (!parser
.finished ())
599 int num
= parser
.get_number ();
601 inferior
*inf
= find_inferior_id (num
);
604 warning (_("Inferior ID %d not known."), num
);
610 warning (_("Inferior ID %d is not running."), num
);
614 thread_info
*tp
= any_thread_of_inferior (inf
);
617 warning (_("Inferior ID %d has no threads."), num
);
621 switch_to_thread (tp
);
626 bfd_cache_close_all ();
630 inferior_command (const char *args
, int from_tty
)
632 struct inferior
*inf
;
635 num
= parse_and_eval_long (args
);
637 inf
= find_inferior_id (num
);
639 error (_("Inferior ID %d not known."), num
);
643 if (inf
!= current_inferior ())
645 thread_info
*tp
= any_thread_of_inferior (inf
);
647 error (_("Inferior has no threads."));
649 switch_to_thread (tp
);
652 gdb::observers::user_selected_context_changed
.notify
653 (USER_SELECTED_INFERIOR
654 | USER_SELECTED_THREAD
655 | USER_SELECTED_FRAME
);
659 set_current_inferior (inf
);
660 switch_to_no_thread ();
661 set_current_program_space (inf
->pspace
);
663 gdb::observers::user_selected_context_changed
.notify
664 (USER_SELECTED_INFERIOR
);
668 /* Print information about currently known inferiors. */
671 info_inferiors_command (const char *args
, int from_tty
)
673 print_inferior (current_uiout
, args
);
676 /* remove-inferior ID */
679 remove_inferior_command (const char *args
, int from_tty
)
681 if (args
== NULL
|| *args
== '\0')
682 error (_("Requires an argument (inferior id(s) to remove)"));
684 number_or_range_parser
parser (args
);
685 while (!parser
.finished ())
687 int num
= parser
.get_number ();
688 struct inferior
*inf
= find_inferior_id (num
);
692 warning (_("Inferior ID %d not known."), num
);
696 if (!inf
->deletable ())
698 warning (_("Can not remove current inferior %d."), num
);
704 warning (_("Can not remove active inferior %d."), num
);
708 delete_inferior (inf
);
713 add_inferior_with_spaces (void)
715 struct address_space
*aspace
;
716 struct program_space
*pspace
;
717 struct inferior
*inf
;
718 struct gdbarch_info info
;
720 /* If all inferiors share an address space on this system, this
721 doesn't really return a new address space; otherwise, it
723 aspace
= maybe_new_address_space ();
724 pspace
= new program_space (aspace
);
725 inf
= add_inferior (0);
726 inf
->pspace
= pspace
;
727 inf
->aspace
= pspace
->aspace
;
729 /* Setup the inferior's initial arch, based on information obtained
730 from the global "set ..." options. */
731 gdbarch_info_init (&info
);
732 inf
->gdbarch
= gdbarch_find_by_info (info
);
733 /* The "set ..." options reject invalid settings, so we should
734 always have a valid arch by now. */
735 gdb_assert (inf
->gdbarch
!= NULL
);
740 /* add-inferior [-copies N] [-exec FILENAME] */
743 add_inferior_command (const char *args
, int from_tty
)
746 gdb::unique_xmalloc_ptr
<char> exec
;
747 symfile_add_flags add_flags
= 0;
750 add_flags
|= SYMFILE_VERBOSE
;
754 gdb_argv
built_argv (args
);
756 for (char **argv
= built_argv
.get (); *argv
!= NULL
; argv
++)
760 if (strcmp (*argv
, "-copies") == 0)
764 error (_("No argument to -copies"));
765 copies
= parse_and_eval_long (*argv
);
767 else if (strcmp (*argv
, "-exec") == 0)
771 error (_("No argument to -exec"));
772 exec
.reset (tilde_expand (*argv
));
776 error (_("Invalid argument"));
780 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
782 for (i
= 0; i
< copies
; ++i
)
784 struct inferior
*inf
= add_inferior_with_spaces ();
786 printf_filtered (_("Added inferior %d\n"), inf
->num
);
790 /* Switch over temporarily, while reading executable and
792 set_current_program_space (inf
->pspace
);
793 set_current_inferior (inf
);
794 switch_to_no_thread ();
796 exec_file_attach (exec
.get (), from_tty
);
797 symbol_file_add_main (exec
.get (), add_flags
);
802 /* clone-inferior [-copies N] [ID] */
805 clone_inferior_command (const char *args
, int from_tty
)
808 struct inferior
*orginf
= NULL
;
812 gdb_argv
built_argv (args
);
814 char **argv
= built_argv
.get ();
815 for (; *argv
!= NULL
; argv
++)
819 if (strcmp (*argv
, "-copies") == 0)
823 error (_("No argument to -copies"));
824 copies
= parse_and_eval_long (*argv
);
827 error (_("Invalid copies number"));
836 /* The first non-option (-) argument specified the
838 num
= parse_and_eval_long (*argv
);
839 orginf
= find_inferior_id (num
);
842 error (_("Inferior ID %d not known."), num
);
846 error (_("Invalid argument"));
851 /* If no inferior id was specified, then the user wants to clone the
854 orginf
= current_inferior ();
856 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
858 for (i
= 0; i
< copies
; ++i
)
860 struct address_space
*aspace
;
861 struct program_space
*pspace
;
862 struct inferior
*inf
;
864 /* If all inferiors share an address space on this system, this
865 doesn't really return a new address space; otherwise, it
867 aspace
= maybe_new_address_space ();
868 pspace
= new program_space (aspace
);
869 inf
= add_inferior (0);
870 inf
->pspace
= pspace
;
871 inf
->aspace
= pspace
->aspace
;
872 inf
->gdbarch
= orginf
->gdbarch
;
874 /* If the original inferior had a user specified target
875 description, make the clone use it too. */
876 if (target_desc_info_from_user_p (inf
->tdesc_info
))
877 copy_inferior_target_desc_info (inf
, orginf
);
879 printf_filtered (_("Added inferior %d.\n"), inf
->num
);
881 set_current_inferior (inf
);
882 switch_to_no_thread ();
883 clone_program_space (pspace
, orginf
->pspace
);
887 /* Print notices when new inferiors are created and die. */
889 show_print_inferior_events (struct ui_file
*file
, int from_tty
,
890 struct cmd_list_element
*c
, const char *value
)
892 fprintf_filtered (file
, _("Printing of inferior events is %s.\n"), value
);
895 /* Return a new value for the selected inferior's id. */
897 static struct value
*
898 inferior_id_make_value (struct gdbarch
*gdbarch
, struct internalvar
*var
,
901 struct inferior
*inf
= current_inferior ();
903 return value_from_longest (builtin_type (gdbarch
)->builtin_int
, inf
->num
);
906 /* Implementation of `$_inferior' variable. */
908 static const struct internalvar_funcs inferior_funcs
=
910 inferior_id_make_value
,
918 initialize_inferiors (void)
920 struct cmd_list_element
*c
= NULL
;
922 /* There's always one inferior. Note that this function isn't an
923 automatic _initialize_foo function, since other _initialize_foo
924 routines may need to install their per-inferior data keys. We
925 can only allocate an inferior when all those modules have done
926 that. Do this after initialize_progspace, due to the
927 current_program_space reference. */
928 current_inferior_
= add_inferior_silent (0);
929 current_inferior_
->incref ();
930 current_inferior_
->pspace
= current_program_space
;
931 current_inferior_
->aspace
= current_program_space
->aspace
;
932 /* The architecture will be initialized shortly, by
933 initialize_current_architecture. */
935 add_info ("inferiors", info_inferiors_command
,
936 _("Print a list of inferiors being managed.\n\
937 Usage: info inferiors [ID]...\n\
938 If IDs are specified, the list is limited to just those inferiors.\n\
939 By default all inferiors are displayed."));
941 c
= add_com ("add-inferior", no_class
, add_inferior_command
, _("\
942 Add a new inferior.\n\
943 Usage: add-inferior [-copies N] [-exec FILENAME]\n\
944 N is the optional number of inferiors to add, default is 1.\n\
945 FILENAME is the file name of the executable to use\n\
947 set_cmd_completer (c
, filename_completer
);
949 add_com ("remove-inferiors", no_class
, remove_inferior_command
, _("\
950 Remove inferior ID (or list of IDs).\n\
951 Usage: remove-inferiors ID..."));
953 add_com ("clone-inferior", no_class
, clone_inferior_command
, _("\
954 Clone inferior ID.\n\
955 Usage: clone-inferior [-copies N] [ID]\n\
956 Add N copies of inferior ID. The new inferior has the same\n\
957 executable loaded as the copied inferior. If -copies is not specified,\n\
958 adds 1 copy. If ID is not specified, it is the current inferior\n\
961 add_cmd ("inferiors", class_run
, detach_inferior_command
, _("\
962 Detach from inferior ID (or list of IDS).\n\
963 Usage; detach inferiors ID..."),
966 add_cmd ("inferiors", class_run
, kill_inferior_command
, _("\
967 Kill inferior ID (or list of IDs).\n\
968 Usage: kill inferiors ID..."),
971 add_cmd ("inferior", class_run
, inferior_command
, _("\
972 Use this command to switch between inferiors.\n\
973 Usage: inferior ID\n\
974 The new inferior ID must be currently known."),
977 add_setshow_boolean_cmd ("inferior-events", no_class
,
978 &print_inferior_events
, _("\
979 Set printing of inferior events (e.g., inferior start and exit)."), _("\
980 Show printing of inferior events (e.g., inferior start and exit)."), NULL
,
982 show_print_inferior_events
,
983 &setprintlist
, &showprintlist
);
985 create_internalvar_type_lazy ("_inferior", &inferior_funcs
, NULL
);