1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2017 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"
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
;
48 /* Print notices on inferior events (attach, detach, etc.), set with
49 `set print inferior-events'. */
50 static int print_inferior_events
= 0;
52 /* The Current Inferior. This is a strong reference. I.e., whenever
53 an inferior is the current inferior, its refcount is
55 static struct inferior
*current_inferior_
= NULL
;
58 current_inferior (void)
60 return current_inferior_
;
64 set_current_inferior (struct inferior
*inf
)
66 /* There's always an inferior. */
67 gdb_assert (inf
!= NULL
);
70 current_inferior_
->decref ();
71 current_inferior_
= inf
;
74 inferior::~inferior ()
78 discard_all_inferior_continuations (inf
);
79 inferior_free_data (inf
);
81 xfree (inf
->terminal
);
82 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 observer_notify_inferior_added (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]\n"), pid
);
130 struct delete_thread_of_inferior_arg
137 delete_thread_of_inferior (struct thread_info
*tp
, void *data
)
139 struct delete_thread_of_inferior_arg
*arg
140 = (struct delete_thread_of_inferior_arg
*) data
;
142 if (ptid_get_pid (tp
->ptid
) == arg
->pid
)
145 delete_thread_silent (tp
->ptid
);
147 delete_thread (tp
->ptid
);
154 delete_inferior (struct inferior
*todel
)
156 struct inferior
*inf
, *infprev
;
157 struct delete_thread_of_inferior_arg arg
;
161 for (inf
= inferior_list
; inf
; infprev
= inf
, inf
= inf
->next
)
171 iterate_over_threads (delete_thread_of_inferior
, &arg
);
174 infprev
->next
= inf
->next
;
176 inferior_list
= inf
->next
;
178 observer_notify_inferior_removed (inf
);
180 /* If this program space is rendered useless, remove it. */
181 if (program_space_empty_p (inf
->pspace
))
182 delete_program_space (inf
->pspace
);
187 /* If SILENT then be quiet -- don't announce a inferior exit, or the
188 exit of its threads. */
191 exit_inferior_1 (struct inferior
*inftoex
, int silent
)
193 struct inferior
*inf
;
194 struct delete_thread_of_inferior_arg arg
;
196 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
206 iterate_over_threads (delete_thread_of_inferior
, &arg
);
208 observer_notify_inferior_exit (inf
);
215 if (inf
->vfork_parent
!= NULL
)
217 inf
->vfork_parent
->vfork_child
= NULL
;
218 inf
->vfork_parent
= NULL
;
220 if (inf
->vfork_child
!= NULL
)
222 inf
->vfork_child
->vfork_parent
= NULL
;
223 inf
->vfork_child
= NULL
;
226 inf
->pending_detach
= 0;
230 exit_inferior (int pid
)
232 struct inferior
*inf
= find_inferior_pid (pid
);
234 exit_inferior_1 (inf
, 0);
236 if (print_inferior_events
)
237 printf_unfiltered (_("[Inferior %d exited]\n"), pid
);
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);
257 detach_inferior (int pid
)
259 struct inferior
*inf
= find_inferior_pid (pid
);
261 exit_inferior_1 (inf
, 0);
263 if (print_inferior_events
)
264 printf_unfiltered (_("[Inferior %d detached]\n"), pid
);
268 inferior_appeared (struct inferior
*inf
, int pid
)
271 inf
->has_exit_code
= 0;
274 observer_notify_inferior_appeared (inf
);
278 discard_all_inferiors (void)
280 struct inferior
*inf
;
282 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
285 exit_inferior_silent (inf
->pid
);
290 find_inferior_id (int num
)
292 struct inferior
*inf
;
294 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
302 find_inferior_pid (int pid
)
304 struct inferior
*inf
;
306 /* Looking for inferior pid == 0 is always wrong, and indicative of
307 a bug somewhere else. There may be more than one with pid == 0,
309 gdb_assert (pid
!= 0);
311 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
321 find_inferior_ptid (ptid_t ptid
)
323 return find_inferior_pid (ptid_get_pid (ptid
));
326 /* See inferior.h. */
329 find_inferior_for_program_space (struct program_space
*pspace
)
331 struct inferior
*inf
= current_inferior ();
333 if (inf
->pspace
== pspace
)
336 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
338 if (inf
->pspace
== pspace
)
346 iterate_over_inferiors (int (*callback
) (struct inferior
*, void *),
349 struct inferior
*inf
, *infnext
;
351 for (inf
= inferior_list
; inf
; inf
= infnext
)
354 if ((*callback
) (inf
, data
))
362 valid_gdb_inferior_id (int num
)
364 struct inferior
*inf
;
366 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
374 pid_to_gdb_inferior_id (int pid
)
376 struct inferior
*inf
;
378 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
386 gdb_inferior_id_to_pid (int num
)
388 struct inferior
*inferior
= find_inferior_id (num
);
390 return inferior
->pid
;
396 in_inferior_list (int pid
)
398 struct inferior
*inf
;
400 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
408 have_inferiors (void)
410 struct inferior
*inf
;
412 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
419 /* Return the number of live inferiors. We account for the case
420 where an inferior might have a non-zero pid but no threads, as
421 in the middle of a 'mourn' operation. */
424 number_of_live_inferiors (void)
426 struct inferior
*inf
;
429 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
432 struct thread_info
*tp
;
434 ALL_NON_EXITED_THREADS (tp
)
435 if (tp
&& ptid_get_pid (tp
->ptid
) == inf
->pid
)
436 if (target_has_execution_1 (tp
->ptid
))
438 /* Found a live thread in this inferior, go to the next
448 /* Return true if there is at least one live inferior. */
451 have_live_inferiors (void)
453 return number_of_live_inferiors () > 0;
456 /* Prune away any unused inferiors, and then prune away no longer used
460 prune_inferiors (void)
462 struct inferior
*ss
, **ss_link
;
465 ss_link
= &inferior_list
;
468 if (!ss
->deletable ()
478 delete_inferior (ss
);
483 /* Simply returns the count of inferiors. */
486 number_of_inferiors (void)
488 struct inferior
*inf
;
491 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
497 /* Converts an inferior process id to a string. Like
498 target_pid_to_str, but special cases the null process. */
501 inferior_pid_to_str (int pid
)
504 return target_pid_to_str (pid_to_ptid (pid
));
509 /* See inferior.h. */
512 print_selected_inferior (struct ui_out
*uiout
)
514 struct inferior
*inf
= current_inferior ();
515 const char *filename
= inf
->pspace
->pspace_exec_filename
;
517 if (filename
== NULL
)
518 filename
= _("<noexec>");
520 uiout
->message (_("[Switching to inferior %d [%s] (%s)]\n"),
521 inf
->num
, inferior_pid_to_str (inf
->pid
), filename
);
524 /* Prints the list of inferiors and their details on UIOUT. This is a
525 version of 'info_inferior_command' suitable for use from MI.
527 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
528 inferiors that should be printed. Otherwise, all inferiors are
532 print_inferior (struct ui_out
*uiout
, const char *requested_inferiors
)
534 struct inferior
*inf
;
537 /* Compute number of inferiors we will print. */
538 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
540 if (!number_is_in_list (requested_inferiors
, inf
->num
))
548 uiout
->message ("No inferiors.\n");
552 ui_out_emit_table
table_emitter (uiout
, 4, inf_count
, "inferiors");
553 uiout
->table_header (1, ui_left
, "current", "");
554 uiout
->table_header (4, ui_left
, "number", "Num");
555 uiout
->table_header (17, ui_left
, "target-id", "Description");
556 uiout
->table_header (17, ui_left
, "exec", "Executable");
558 uiout
->table_body ();
559 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
561 if (!number_is_in_list (requested_inferiors
, inf
->num
))
564 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
566 if (inf
== current_inferior ())
567 uiout
->field_string ("current", "*");
569 uiout
->field_skip ("current");
571 uiout
->field_int ("number", inf
->num
);
573 uiout
->field_string ("target-id", inferior_pid_to_str (inf
->pid
));
575 if (inf
->pspace
->pspace_exec_filename
!= NULL
)
576 uiout
->field_string ("exec", inf
->pspace
->pspace_exec_filename
);
578 uiout
->field_skip ("exec");
580 /* Print extra info that isn't really fit to always present in
581 tabular form. Currently we print the vfork parent/child
582 relationships, if any. */
583 if (inf
->vfork_parent
)
585 uiout
->text (_("\n\tis vfork child of inferior "));
586 uiout
->field_int ("vfork-parent", inf
->vfork_parent
->num
);
588 if (inf
->vfork_child
)
590 uiout
->text (_("\n\tis vfork parent of inferior "));
591 uiout
->field_int ("vfork-child", inf
->vfork_child
->num
);
599 detach_inferior_command (const char *args
, int from_tty
)
601 struct thread_info
*tp
;
604 error (_("Requires argument (inferior id(s) to detach)"));
606 number_or_range_parser
parser (args
);
607 while (!parser
.finished ())
609 int num
= parser
.get_number ();
611 if (!valid_gdb_inferior_id (num
))
613 warning (_("Inferior ID %d not known."), num
);
617 int pid
= gdb_inferior_id_to_pid (num
);
620 warning (_("Inferior ID %d is not running."), num
);
624 tp
= any_thread_of_process (pid
);
627 warning (_("Inferior ID %d has no threads."), num
);
631 switch_to_thread (tp
->ptid
);
633 detach_command (NULL
, from_tty
);
638 kill_inferior_command (const char *args
, int from_tty
)
640 struct thread_info
*tp
;
643 error (_("Requires argument (inferior id(s) to kill)"));
645 number_or_range_parser
parser (args
);
646 while (!parser
.finished ())
648 int num
= parser
.get_number ();
650 if (!valid_gdb_inferior_id (num
))
652 warning (_("Inferior ID %d not known."), num
);
656 int pid
= gdb_inferior_id_to_pid (num
);
659 warning (_("Inferior ID %d is not running."), num
);
663 tp
= any_thread_of_process (pid
);
666 warning (_("Inferior ID %d has no threads."), num
);
670 switch_to_thread (tp
->ptid
);
675 bfd_cache_close_all ();
679 inferior_command (const char *args
, int from_tty
)
681 struct inferior
*inf
;
684 num
= parse_and_eval_long (args
);
686 inf
= find_inferior_id (num
);
688 error (_("Inferior ID %d not known."), num
);
692 if (inf
->pid
!= ptid_get_pid (inferior_ptid
))
694 struct thread_info
*tp
;
696 tp
= any_thread_of_process (inf
->pid
);
698 error (_("Inferior has no threads."));
700 switch_to_thread (tp
->ptid
);
703 observer_notify_user_selected_context_changed
704 (USER_SELECTED_INFERIOR
705 | USER_SELECTED_THREAD
706 | USER_SELECTED_FRAME
);
710 set_current_inferior (inf
);
711 switch_to_thread (null_ptid
);
712 set_current_program_space (inf
->pspace
);
714 observer_notify_user_selected_context_changed (USER_SELECTED_INFERIOR
);
718 /* Print information about currently known inferiors. */
721 info_inferiors_command (const char *args
, int from_tty
)
723 print_inferior (current_uiout
, args
);
726 /* remove-inferior ID */
729 remove_inferior_command (const char *args
, int from_tty
)
731 if (args
== NULL
|| *args
== '\0')
732 error (_("Requires an argument (inferior id(s) to remove)"));
734 number_or_range_parser
parser (args
);
735 while (!parser
.finished ())
737 int num
= parser
.get_number ();
738 struct inferior
*inf
= find_inferior_id (num
);
742 warning (_("Inferior ID %d not known."), num
);
746 if (!inf
->deletable ())
748 warning (_("Can not remove current inferior %d."), num
);
754 warning (_("Can not remove active inferior %d."), num
);
758 delete_inferior (inf
);
763 add_inferior_with_spaces (void)
765 struct address_space
*aspace
;
766 struct program_space
*pspace
;
767 struct inferior
*inf
;
768 struct gdbarch_info info
;
770 /* If all inferiors share an address space on this system, this
771 doesn't really return a new address space; otherwise, it
773 aspace
= maybe_new_address_space ();
774 pspace
= add_program_space (aspace
);
775 inf
= add_inferior (0);
776 inf
->pspace
= pspace
;
777 inf
->aspace
= pspace
->aspace
;
779 /* Setup the inferior's initial arch, based on information obtained
780 from the global "set ..." options. */
781 gdbarch_info_init (&info
);
782 inf
->gdbarch
= gdbarch_find_by_info (info
);
783 /* The "set ..." options reject invalid settings, so we should
784 always have a valid arch by now. */
785 gdb_assert (inf
->gdbarch
!= NULL
);
790 /* add-inferior [-copies N] [-exec FILENAME] */
793 add_inferior_command (const char *args
, int from_tty
)
796 gdb::unique_xmalloc_ptr
<char> exec
;
797 symfile_add_flags add_flags
= 0;
800 add_flags
|= SYMFILE_VERBOSE
;
804 gdb_argv
built_argv (args
);
806 for (char **argv
= built_argv
.get (); *argv
!= NULL
; argv
++)
810 if (strcmp (*argv
, "-copies") == 0)
814 error (_("No argument to -copies"));
815 copies
= parse_and_eval_long (*argv
);
817 else if (strcmp (*argv
, "-exec") == 0)
821 error (_("No argument to -exec"));
822 exec
.reset (tilde_expand (*argv
));
826 error (_("Invalid argument"));
830 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
832 for (i
= 0; i
< copies
; ++i
)
834 struct inferior
*inf
= add_inferior_with_spaces ();
836 printf_filtered (_("Added inferior %d\n"), inf
->num
);
840 /* Switch over temporarily, while reading executable and
842 set_current_program_space (inf
->pspace
);
843 set_current_inferior (inf
);
844 switch_to_thread (null_ptid
);
846 exec_file_attach (exec
.get (), from_tty
);
847 symbol_file_add_main (exec
.get (), add_flags
);
852 /* clone-inferior [-copies N] [ID] */
855 clone_inferior_command (const char *args
, int from_tty
)
858 struct inferior
*orginf
= NULL
;
862 gdb_argv
built_argv (args
);
864 char **argv
= built_argv
.get ();
865 for (; *argv
!= NULL
; argv
++)
869 if (strcmp (*argv
, "-copies") == 0)
873 error (_("No argument to -copies"));
874 copies
= parse_and_eval_long (*argv
);
877 error (_("Invalid copies number"));
886 /* The first non-option (-) argument specified the
888 num
= parse_and_eval_long (*argv
);
889 orginf
= find_inferior_id (num
);
892 error (_("Inferior ID %d not known."), num
);
896 error (_("Invalid argument"));
901 /* If no inferior id was specified, then the user wants to clone the
904 orginf
= current_inferior ();
906 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
908 for (i
= 0; i
< copies
; ++i
)
910 struct address_space
*aspace
;
911 struct program_space
*pspace
;
912 struct inferior
*inf
;
914 /* If all inferiors share an address space on this system, this
915 doesn't really return a new address space; otherwise, it
917 aspace
= maybe_new_address_space ();
918 pspace
= add_program_space (aspace
);
919 inf
= add_inferior (0);
920 inf
->pspace
= pspace
;
921 inf
->aspace
= pspace
->aspace
;
922 inf
->gdbarch
= orginf
->gdbarch
;
924 /* If the original inferior had a user specified target
925 description, make the clone use it too. */
926 if (target_desc_info_from_user_p (inf
->tdesc_info
))
927 copy_inferior_target_desc_info (inf
, orginf
);
929 printf_filtered (_("Added inferior %d.\n"), inf
->num
);
931 set_current_inferior (inf
);
932 switch_to_thread (null_ptid
);
933 clone_program_space (pspace
, orginf
->pspace
);
937 /* Print notices when new inferiors are created and die. */
939 show_print_inferior_events (struct ui_file
*file
, int from_tty
,
940 struct cmd_list_element
*c
, const char *value
)
942 fprintf_filtered (file
, _("Printing of inferior events is %s.\n"), value
);
945 /* Return a new value for the selected inferior's id. */
947 static struct value
*
948 inferior_id_make_value (struct gdbarch
*gdbarch
, struct internalvar
*var
,
951 struct inferior
*inf
= current_inferior ();
953 return value_from_longest (builtin_type (gdbarch
)->builtin_int
, inf
->num
);
956 /* Implementation of `$_inferior' variable. */
958 static const struct internalvar_funcs inferior_funcs
=
960 inferior_id_make_value
,
968 initialize_inferiors (void)
970 struct cmd_list_element
*c
= NULL
;
972 /* There's always one inferior. Note that this function isn't an
973 automatic _initialize_foo function, since other _initialize_foo
974 routines may need to install their per-inferior data keys. We
975 can only allocate an inferior when all those modules have done
976 that. Do this after initialize_progspace, due to the
977 current_program_space reference. */
978 current_inferior_
= add_inferior (0);
979 current_inferior_
->incref ();
980 current_inferior_
->pspace
= current_program_space
;
981 current_inferior_
->aspace
= current_program_space
->aspace
;
982 /* The architecture will be initialized shortly, by
983 initialize_current_architecture. */
985 add_info ("inferiors", info_inferiors_command
,
986 _("IDs of specified inferiors (all inferiors if no argument)."));
988 c
= add_com ("add-inferior", no_class
, add_inferior_command
, _("\
989 Add a new inferior.\n\
990 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
991 N is the optional number of inferiors to add, default is 1.\n\
992 FILENAME is the file name of the executable to use\n\
994 set_cmd_completer (c
, filename_completer
);
996 add_com ("remove-inferiors", no_class
, remove_inferior_command
, _("\
997 Remove inferior ID (or list of IDs).\n\
998 Usage: remove-inferiors ID..."));
1000 add_com ("clone-inferior", no_class
, clone_inferior_command
, _("\
1001 Clone inferior ID.\n\
1002 Usage: clone-inferior [-copies <N>] [ID]\n\
1003 Add N copies of inferior ID. The new inferior has the same\n\
1004 executable loaded as the copied inferior. If -copies is not specified,\n\
1005 adds 1 copy. If ID is not specified, it is the current inferior\n\
1008 add_cmd ("inferiors", class_run
, detach_inferior_command
, _("\
1009 Detach from inferior ID (or list of IDS)."),
1012 add_cmd ("inferiors", class_run
, kill_inferior_command
, _("\
1013 Kill inferior ID (or list of IDs)."),
1016 add_cmd ("inferior", class_run
, inferior_command
, _("\
1017 Use this command to switch between inferiors.\n\
1018 The new inferior ID must be currently known."),
1021 add_setshow_boolean_cmd ("inferior-events", no_class
,
1022 &print_inferior_events
, _("\
1023 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1024 Show printing of inferior events (e.g., inferior start and exit)."), NULL
,
1026 show_print_inferior_events
,
1027 &setprintlist
, &showprintlist
);
1029 create_internalvar_type_lazy ("_inferior", &inferior_funcs
, NULL
);