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 (pid_to_ptid (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 (ptid_get_pid (tp
->ptid
) == arg
->pid
)
147 delete_thread_silent (tp
->ptid
);
149 delete_thread (tp
->ptid
);
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
= {NO_STOP_QUIETLY
};
233 exit_inferior (int pid
)
235 struct inferior
*inf
= find_inferior_pid (pid
);
237 exit_inferior_1 (inf
, 0);
241 exit_inferior_silent (int pid
)
243 struct inferior
*inf
= find_inferior_pid (pid
);
245 exit_inferior_1 (inf
, 1);
249 exit_inferior_num_silent (int num
)
251 struct inferior
*inf
= find_inferior_id (num
);
253 exit_inferior_1 (inf
, 1);
256 /* See inferior.h. */
259 detach_inferior (inferior
*inf
)
261 /* Save the pid, since exit_inferior_1 will reset it. */
264 exit_inferior_1 (inf
, 0);
266 if (print_inferior_events
)
267 printf_unfiltered (_("[Inferior %d (%s) detached]\n"),
269 target_pid_to_str (pid_to_ptid (pid
)));
272 /* See inferior.h. */
275 detach_inferior (int pid
)
277 detach_inferior (find_inferior_pid (pid
));
281 inferior_appeared (struct inferior
*inf
, int pid
)
284 inf
->has_exit_code
= 0;
287 gdb::observers::inferior_appeared
.notify (inf
);
291 discard_all_inferiors (void)
293 struct inferior
*inf
;
295 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
298 exit_inferior_silent (inf
->pid
);
303 find_inferior_id (int num
)
305 struct inferior
*inf
;
307 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
315 find_inferior_pid (int pid
)
317 struct inferior
*inf
;
319 /* Looking for inferior pid == 0 is always wrong, and indicative of
320 a bug somewhere else. There may be more than one with pid == 0,
322 gdb_assert (pid
!= 0);
324 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
334 find_inferior_ptid (ptid_t ptid
)
336 return find_inferior_pid (ptid_get_pid (ptid
));
339 /* See inferior.h. */
342 find_inferior_for_program_space (struct program_space
*pspace
)
344 struct inferior
*inf
= current_inferior ();
346 if (inf
->pspace
== pspace
)
349 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
351 if (inf
->pspace
== pspace
)
359 iterate_over_inferiors (int (*callback
) (struct inferior
*, void *),
362 struct inferior
*inf
, *infnext
;
364 for (inf
= inferior_list
; inf
; inf
= infnext
)
367 if ((*callback
) (inf
, data
))
375 valid_gdb_inferior_id (int num
)
377 struct inferior
*inf
;
379 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
387 pid_to_gdb_inferior_id (int pid
)
389 struct inferior
*inf
;
391 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
399 gdb_inferior_id_to_pid (int num
)
401 struct inferior
*inferior
= find_inferior_id (num
);
403 return inferior
->pid
;
409 in_inferior_list (int pid
)
411 struct inferior
*inf
;
413 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
421 have_inferiors (void)
423 struct inferior
*inf
;
425 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
432 /* Return the number of live inferiors. We account for the case
433 where an inferior might have a non-zero pid but no threads, as
434 in the middle of a 'mourn' operation. */
437 number_of_live_inferiors (void)
439 struct inferior
*inf
;
442 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
445 struct thread_info
*tp
;
447 ALL_NON_EXITED_THREADS (tp
)
448 if (tp
&& ptid_get_pid (tp
->ptid
) == inf
->pid
)
449 if (target_has_execution_1 (tp
->ptid
))
451 /* Found a live thread in this inferior, go to the next
461 /* Return true if there is at least one live inferior. */
464 have_live_inferiors (void)
466 return number_of_live_inferiors () > 0;
469 /* Prune away any unused inferiors, and then prune away no longer used
473 prune_inferiors (void)
475 struct inferior
*ss
, **ss_link
;
478 ss_link
= &inferior_list
;
481 if (!ss
->deletable ()
491 delete_inferior (ss
);
496 /* Simply returns the count of inferiors. */
499 number_of_inferiors (void)
501 struct inferior
*inf
;
504 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
510 /* Converts an inferior process id to a string. Like
511 target_pid_to_str, but special cases the null process. */
514 inferior_pid_to_str (int pid
)
517 return target_pid_to_str (pid_to_ptid (pid
));
522 /* See inferior.h. */
525 print_selected_inferior (struct ui_out
*uiout
)
527 struct inferior
*inf
= current_inferior ();
528 const char *filename
= inf
->pspace
->pspace_exec_filename
;
530 if (filename
== NULL
)
531 filename
= _("<noexec>");
533 uiout
->message (_("[Switching to inferior %d [%s] (%s)]\n"),
534 inf
->num
, inferior_pid_to_str (inf
->pid
), filename
);
537 /* Prints the list of inferiors and their details on UIOUT. This is a
538 version of 'info_inferior_command' suitable for use from MI.
540 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
541 inferiors that should be printed. Otherwise, all inferiors are
545 print_inferior (struct ui_out
*uiout
, const char *requested_inferiors
)
547 struct inferior
*inf
;
550 /* Compute number of inferiors we will print. */
551 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
553 if (!number_is_in_list (requested_inferiors
, inf
->num
))
561 uiout
->message ("No inferiors.\n");
565 ui_out_emit_table
table_emitter (uiout
, 4, inf_count
, "inferiors");
566 uiout
->table_header (1, ui_left
, "current", "");
567 uiout
->table_header (4, ui_left
, "number", "Num");
568 uiout
->table_header (17, ui_left
, "target-id", "Description");
569 uiout
->table_header (17, ui_left
, "exec", "Executable");
571 uiout
->table_body ();
572 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
574 if (!number_is_in_list (requested_inferiors
, inf
->num
))
577 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
579 if (inf
== current_inferior ())
580 uiout
->field_string ("current", "*");
582 uiout
->field_skip ("current");
584 uiout
->field_int ("number", inf
->num
);
586 uiout
->field_string ("target-id", inferior_pid_to_str (inf
->pid
));
588 if (inf
->pspace
->pspace_exec_filename
!= NULL
)
589 uiout
->field_string ("exec", inf
->pspace
->pspace_exec_filename
);
591 uiout
->field_skip ("exec");
593 /* Print extra info that isn't really fit to always present in
594 tabular form. Currently we print the vfork parent/child
595 relationships, if any. */
596 if (inf
->vfork_parent
)
598 uiout
->text (_("\n\tis vfork child of inferior "));
599 uiout
->field_int ("vfork-parent", inf
->vfork_parent
->num
);
601 if (inf
->vfork_child
)
603 uiout
->text (_("\n\tis vfork parent of inferior "));
604 uiout
->field_int ("vfork-child", inf
->vfork_child
->num
);
612 detach_inferior_command (const char *args
, int from_tty
)
614 struct thread_info
*tp
;
617 error (_("Requires argument (inferior id(s) to detach)"));
619 number_or_range_parser
parser (args
);
620 while (!parser
.finished ())
622 int num
= parser
.get_number ();
624 if (!valid_gdb_inferior_id (num
))
626 warning (_("Inferior ID %d not known."), num
);
630 int pid
= gdb_inferior_id_to_pid (num
);
633 warning (_("Inferior ID %d is not running."), num
);
637 tp
= any_thread_of_process (pid
);
640 warning (_("Inferior ID %d has no threads."), num
);
644 switch_to_thread (tp
->ptid
);
646 detach_command (NULL
, from_tty
);
651 kill_inferior_command (const char *args
, int from_tty
)
653 struct thread_info
*tp
;
656 error (_("Requires argument (inferior id(s) to kill)"));
658 number_or_range_parser
parser (args
);
659 while (!parser
.finished ())
661 int num
= parser
.get_number ();
663 if (!valid_gdb_inferior_id (num
))
665 warning (_("Inferior ID %d not known."), num
);
669 int pid
= gdb_inferior_id_to_pid (num
);
672 warning (_("Inferior ID %d is not running."), num
);
676 tp
= any_thread_of_process (pid
);
679 warning (_("Inferior ID %d has no threads."), num
);
683 switch_to_thread (tp
->ptid
);
688 bfd_cache_close_all ();
692 inferior_command (const char *args
, int from_tty
)
694 struct inferior
*inf
;
697 num
= parse_and_eval_long (args
);
699 inf
= find_inferior_id (num
);
701 error (_("Inferior ID %d not known."), num
);
705 if (inf
->pid
!= ptid_get_pid (inferior_ptid
))
707 struct thread_info
*tp
;
709 tp
= any_thread_of_process (inf
->pid
);
711 error (_("Inferior has no threads."));
713 switch_to_thread (tp
->ptid
);
716 gdb::observers::user_selected_context_changed
.notify
717 (USER_SELECTED_INFERIOR
718 | USER_SELECTED_THREAD
719 | USER_SELECTED_FRAME
);
723 set_current_inferior (inf
);
724 switch_to_thread (null_ptid
);
725 set_current_program_space (inf
->pspace
);
727 gdb::observers::user_selected_context_changed
.notify
728 (USER_SELECTED_INFERIOR
);
732 /* Print information about currently known inferiors. */
735 info_inferiors_command (const char *args
, int from_tty
)
737 print_inferior (current_uiout
, args
);
740 /* remove-inferior ID */
743 remove_inferior_command (const char *args
, int from_tty
)
745 if (args
== NULL
|| *args
== '\0')
746 error (_("Requires an argument (inferior id(s) to remove)"));
748 number_or_range_parser
parser (args
);
749 while (!parser
.finished ())
751 int num
= parser
.get_number ();
752 struct inferior
*inf
= find_inferior_id (num
);
756 warning (_("Inferior ID %d not known."), num
);
760 if (!inf
->deletable ())
762 warning (_("Can not remove current inferior %d."), num
);
768 warning (_("Can not remove active inferior %d."), num
);
772 delete_inferior (inf
);
777 add_inferior_with_spaces (void)
779 struct address_space
*aspace
;
780 struct program_space
*pspace
;
781 struct inferior
*inf
;
782 struct gdbarch_info info
;
784 /* If all inferiors share an address space on this system, this
785 doesn't really return a new address space; otherwise, it
787 aspace
= maybe_new_address_space ();
788 pspace
= new program_space (aspace
);
789 inf
= add_inferior (0);
790 inf
->pspace
= pspace
;
791 inf
->aspace
= pspace
->aspace
;
793 /* Setup the inferior's initial arch, based on information obtained
794 from the global "set ..." options. */
795 gdbarch_info_init (&info
);
796 inf
->gdbarch
= gdbarch_find_by_info (info
);
797 /* The "set ..." options reject invalid settings, so we should
798 always have a valid arch by now. */
799 gdb_assert (inf
->gdbarch
!= NULL
);
804 /* add-inferior [-copies N] [-exec FILENAME] */
807 add_inferior_command (const char *args
, int from_tty
)
810 gdb::unique_xmalloc_ptr
<char> exec
;
811 symfile_add_flags add_flags
= 0;
814 add_flags
|= SYMFILE_VERBOSE
;
818 gdb_argv
built_argv (args
);
820 for (char **argv
= built_argv
.get (); *argv
!= NULL
; argv
++)
824 if (strcmp (*argv
, "-copies") == 0)
828 error (_("No argument to -copies"));
829 copies
= parse_and_eval_long (*argv
);
831 else if (strcmp (*argv
, "-exec") == 0)
835 error (_("No argument to -exec"));
836 exec
.reset (tilde_expand (*argv
));
840 error (_("Invalid argument"));
844 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
846 for (i
= 0; i
< copies
; ++i
)
848 struct inferior
*inf
= add_inferior_with_spaces ();
850 printf_filtered (_("Added inferior %d\n"), inf
->num
);
854 /* Switch over temporarily, while reading executable and
856 set_current_program_space (inf
->pspace
);
857 set_current_inferior (inf
);
858 switch_to_thread (null_ptid
);
860 exec_file_attach (exec
.get (), from_tty
);
861 symbol_file_add_main (exec
.get (), add_flags
);
866 /* clone-inferior [-copies N] [ID] */
869 clone_inferior_command (const char *args
, int from_tty
)
872 struct inferior
*orginf
= NULL
;
876 gdb_argv
built_argv (args
);
878 char **argv
= built_argv
.get ();
879 for (; *argv
!= NULL
; argv
++)
883 if (strcmp (*argv
, "-copies") == 0)
887 error (_("No argument to -copies"));
888 copies
= parse_and_eval_long (*argv
);
891 error (_("Invalid copies number"));
900 /* The first non-option (-) argument specified the
902 num
= parse_and_eval_long (*argv
);
903 orginf
= find_inferior_id (num
);
906 error (_("Inferior ID %d not known."), num
);
910 error (_("Invalid argument"));
915 /* If no inferior id was specified, then the user wants to clone the
918 orginf
= current_inferior ();
920 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
922 for (i
= 0; i
< copies
; ++i
)
924 struct address_space
*aspace
;
925 struct program_space
*pspace
;
926 struct inferior
*inf
;
928 /* If all inferiors share an address space on this system, this
929 doesn't really return a new address space; otherwise, it
931 aspace
= maybe_new_address_space ();
932 pspace
= new program_space (aspace
);
933 inf
= add_inferior (0);
934 inf
->pspace
= pspace
;
935 inf
->aspace
= pspace
->aspace
;
936 inf
->gdbarch
= orginf
->gdbarch
;
938 /* If the original inferior had a user specified target
939 description, make the clone use it too. */
940 if (target_desc_info_from_user_p (inf
->tdesc_info
))
941 copy_inferior_target_desc_info (inf
, orginf
);
943 printf_filtered (_("Added inferior %d.\n"), inf
->num
);
945 set_current_inferior (inf
);
946 switch_to_thread (null_ptid
);
947 clone_program_space (pspace
, orginf
->pspace
);
951 /* Print notices when new inferiors are created and die. */
953 show_print_inferior_events (struct ui_file
*file
, int from_tty
,
954 struct cmd_list_element
*c
, const char *value
)
956 fprintf_filtered (file
, _("Printing of inferior events is %s.\n"), value
);
959 /* Return a new value for the selected inferior's id. */
961 static struct value
*
962 inferior_id_make_value (struct gdbarch
*gdbarch
, struct internalvar
*var
,
965 struct inferior
*inf
= current_inferior ();
967 return value_from_longest (builtin_type (gdbarch
)->builtin_int
, inf
->num
);
970 /* Implementation of `$_inferior' variable. */
972 static const struct internalvar_funcs inferior_funcs
=
974 inferior_id_make_value
,
982 initialize_inferiors (void)
984 struct cmd_list_element
*c
= NULL
;
986 /* There's always one inferior. Note that this function isn't an
987 automatic _initialize_foo function, since other _initialize_foo
988 routines may need to install their per-inferior data keys. We
989 can only allocate an inferior when all those modules have done
990 that. Do this after initialize_progspace, due to the
991 current_program_space reference. */
992 current_inferior_
= add_inferior_silent (0);
993 current_inferior_
->incref ();
994 current_inferior_
->pspace
= current_program_space
;
995 current_inferior_
->aspace
= current_program_space
->aspace
;
996 /* The architecture will be initialized shortly, by
997 initialize_current_architecture. */
999 add_info ("inferiors", info_inferiors_command
,
1000 _("IDs of specified inferiors (all inferiors if no argument)."));
1002 c
= add_com ("add-inferior", no_class
, add_inferior_command
, _("\
1003 Add a new inferior.\n\
1004 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
1005 N is the optional number of inferiors to add, default is 1.\n\
1006 FILENAME is the file name of the executable to use\n\
1007 as main program."));
1008 set_cmd_completer (c
, filename_completer
);
1010 add_com ("remove-inferiors", no_class
, remove_inferior_command
, _("\
1011 Remove inferior ID (or list of IDs).\n\
1012 Usage: remove-inferiors ID..."));
1014 add_com ("clone-inferior", no_class
, clone_inferior_command
, _("\
1015 Clone inferior ID.\n\
1016 Usage: clone-inferior [-copies <N>] [ID]\n\
1017 Add N copies of inferior ID. The new inferior has the same\n\
1018 executable loaded as the copied inferior. If -copies is not specified,\n\
1019 adds 1 copy. If ID is not specified, it is the current inferior\n\
1022 add_cmd ("inferiors", class_run
, detach_inferior_command
, _("\
1023 Detach from inferior ID (or list of IDS)."),
1026 add_cmd ("inferiors", class_run
, kill_inferior_command
, _("\
1027 Kill inferior ID (or list of IDs)."),
1030 add_cmd ("inferior", class_run
, inferior_command
, _("\
1031 Use this command to switch between inferiors.\n\
1032 The new inferior ID must be currently known."),
1035 add_setshow_boolean_cmd ("inferior-events", no_class
,
1036 &print_inferior_events
, _("\
1037 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1038 Show printing of inferior events (e.g., inferior start and exit)."), NULL
,
1040 show_print_inferior_events
,
1041 &setprintlist
, &showprintlist
);
1043 create_internalvar_type_lazy ("_inferior", &inferior_funcs
, NULL
);