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
)
127 printf_unfiltered (_("[New inferior %d (%s)]\n"),
129 target_pid_to_str (ptid_t (pid
)));
131 printf_unfiltered (_("[New inferior %d]\n"), inf
->num
);
137 struct delete_thread_of_inferior_arg
144 delete_thread_of_inferior (struct thread_info
*tp
, void *data
)
146 struct delete_thread_of_inferior_arg
*arg
147 = (struct delete_thread_of_inferior_arg
*) data
;
149 if (tp
->ptid
.pid () == arg
->pid
)
152 delete_thread_silent (tp
);
161 delete_inferior (struct inferior
*todel
)
163 struct inferior
*inf
, *infprev
;
164 struct delete_thread_of_inferior_arg arg
;
168 for (inf
= inferior_list
; inf
; infprev
= inf
, inf
= inf
->next
)
178 iterate_over_threads (delete_thread_of_inferior
, &arg
);
181 infprev
->next
= inf
->next
;
183 inferior_list
= inf
->next
;
185 gdb::observers::inferior_removed
.notify (inf
);
187 /* If this program space is rendered useless, remove it. */
188 if (program_space_empty_p (inf
->pspace
))
189 delete_program_space (inf
->pspace
);
194 /* If SILENT then be quiet -- don't announce a inferior exit, or the
195 exit of its threads. */
198 exit_inferior_1 (struct inferior
*inftoex
, int silent
)
200 struct inferior
*inf
;
201 struct delete_thread_of_inferior_arg arg
;
203 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
213 iterate_over_threads (delete_thread_of_inferior
, &arg
);
215 gdb::observers::inferior_exit
.notify (inf
);
221 if (inf
->vfork_parent
!= NULL
)
223 inf
->vfork_parent
->vfork_child
= NULL
;
224 inf
->vfork_parent
= NULL
;
226 if (inf
->vfork_child
!= NULL
)
228 inf
->vfork_child
->vfork_parent
= NULL
;
229 inf
->vfork_child
= NULL
;
232 inf
->pending_detach
= 0;
234 inf
->control
= inferior_control_state (NO_STOP_QUIETLY
);
238 exit_inferior (inferior
*inf
)
240 exit_inferior_1 (inf
, 0);
244 exit_inferior_silent (int pid
)
246 struct inferior
*inf
= find_inferior_pid (pid
);
248 exit_inferior_1 (inf
, 1);
252 exit_inferior_silent (inferior
*inf
)
254 exit_inferior_1 (inf
, 1);
257 /* See inferior.h. */
260 detach_inferior (inferior
*inf
)
262 /* Save the pid, since exit_inferior_1 will reset it. */
265 exit_inferior_1 (inf
, 0);
267 if (print_inferior_events
)
268 printf_unfiltered (_("[Inferior %d (%s) detached]\n"),
270 target_pid_to_str (ptid_t (pid
)));
274 inferior_appeared (struct inferior
*inf
, int pid
)
277 inf
->has_exit_code
= 0;
280 gdb::observers::inferior_appeared
.notify (inf
);
284 discard_all_inferiors (void)
286 struct inferior
*inf
;
288 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
291 exit_inferior_silent (inf
);
296 find_inferior_id (int num
)
298 struct inferior
*inf
;
300 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
308 find_inferior_pid (int pid
)
310 struct inferior
*inf
;
312 /* Looking for inferior pid == 0 is always wrong, and indicative of
313 a bug somewhere else. There may be more than one with pid == 0,
315 gdb_assert (pid
!= 0);
317 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
327 find_inferior_ptid (ptid_t ptid
)
329 return find_inferior_pid (ptid
.pid ());
332 /* See inferior.h. */
335 find_inferior_for_program_space (struct program_space
*pspace
)
337 struct inferior
*inf
= current_inferior ();
339 if (inf
->pspace
== pspace
)
342 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
344 if (inf
->pspace
== pspace
)
352 iterate_over_inferiors (int (*callback
) (struct inferior
*, void *),
355 struct inferior
*inf
, *infnext
;
357 for (inf
= inferior_list
; inf
; inf
= infnext
)
360 if ((*callback
) (inf
, data
))
368 have_inferiors (void)
370 struct inferior
*inf
;
372 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
379 /* Return the number of live inferiors. We account for the case
380 where an inferior might have a non-zero pid but no threads, as
381 in the middle of a 'mourn' operation. */
384 number_of_live_inferiors (void)
386 struct inferior
*inf
;
389 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
392 struct thread_info
*tp
;
394 ALL_NON_EXITED_THREADS (tp
)
395 if (tp
&& tp
->ptid
.pid () == inf
->pid
)
396 if (target_has_execution_1 (tp
->ptid
))
398 /* Found a live thread in this inferior, go to the next
408 /* Return true if there is at least one live inferior. */
411 have_live_inferiors (void)
413 return number_of_live_inferiors () > 0;
416 /* Prune away any unused inferiors, and then prune away no longer used
420 prune_inferiors (void)
422 struct inferior
*ss
, **ss_link
;
425 ss_link
= &inferior_list
;
428 if (!ss
->deletable ()
438 delete_inferior (ss
);
443 /* Simply returns the count of inferiors. */
446 number_of_inferiors (void)
448 struct inferior
*inf
;
451 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
457 /* Converts an inferior process id to a string. Like
458 target_pid_to_str, but special cases the null process. */
461 inferior_pid_to_str (int pid
)
464 return target_pid_to_str (ptid_t (pid
));
469 /* See inferior.h. */
472 print_selected_inferior (struct ui_out
*uiout
)
474 struct inferior
*inf
= current_inferior ();
475 const char *filename
= inf
->pspace
->pspace_exec_filename
;
477 if (filename
== NULL
)
478 filename
= _("<noexec>");
480 uiout
->message (_("[Switching to inferior %d [%s] (%s)]\n"),
481 inf
->num
, inferior_pid_to_str (inf
->pid
), filename
);
484 /* Prints the list of inferiors and their details on UIOUT. This is a
485 version of 'info_inferior_command' suitable for use from MI.
487 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
488 inferiors that should be printed. Otherwise, all inferiors are
492 print_inferior (struct ui_out
*uiout
, const char *requested_inferiors
)
494 struct inferior
*inf
;
497 /* Compute number of inferiors we will print. */
498 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
500 if (!number_is_in_list (requested_inferiors
, inf
->num
))
508 uiout
->message ("No inferiors.\n");
512 ui_out_emit_table
table_emitter (uiout
, 4, inf_count
, "inferiors");
513 uiout
->table_header (1, ui_left
, "current", "");
514 uiout
->table_header (4, ui_left
, "number", "Num");
515 uiout
->table_header (17, ui_left
, "target-id", "Description");
516 uiout
->table_header (17, ui_left
, "exec", "Executable");
518 uiout
->table_body ();
519 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
521 if (!number_is_in_list (requested_inferiors
, inf
->num
))
524 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
526 if (inf
== current_inferior ())
527 uiout
->field_string ("current", "*");
529 uiout
->field_skip ("current");
531 uiout
->field_int ("number", inf
->num
);
533 uiout
->field_string ("target-id", inferior_pid_to_str (inf
->pid
));
535 if (inf
->pspace
->pspace_exec_filename
!= NULL
)
536 uiout
->field_string ("exec", inf
->pspace
->pspace_exec_filename
);
538 uiout
->field_skip ("exec");
540 /* Print extra info that isn't really fit to always present in
541 tabular form. Currently we print the vfork parent/child
542 relationships, if any. */
543 if (inf
->vfork_parent
)
545 uiout
->text (_("\n\tis vfork child of inferior "));
546 uiout
->field_int ("vfork-parent", inf
->vfork_parent
->num
);
548 if (inf
->vfork_child
)
550 uiout
->text (_("\n\tis vfork parent of inferior "));
551 uiout
->field_int ("vfork-child", inf
->vfork_child
->num
);
559 detach_inferior_command (const char *args
, int from_tty
)
562 error (_("Requires argument (inferior id(s) to detach)"));
564 number_or_range_parser
parser (args
);
565 while (!parser
.finished ())
567 int num
= parser
.get_number ();
569 inferior
*inf
= find_inferior_id (num
);
572 warning (_("Inferior ID %d not known."), num
);
578 warning (_("Inferior ID %d is not running."), num
);
582 thread_info
*tp
= any_thread_of_inferior (inf
);
585 warning (_("Inferior ID %d has no threads."), num
);
589 switch_to_thread (tp
);
591 detach_command (NULL
, from_tty
);
596 kill_inferior_command (const char *args
, int from_tty
)
599 error (_("Requires argument (inferior id(s) to kill)"));
601 number_or_range_parser
parser (args
);
602 while (!parser
.finished ())
604 int num
= parser
.get_number ();
606 inferior
*inf
= find_inferior_id (num
);
609 warning (_("Inferior ID %d not known."), num
);
615 warning (_("Inferior ID %d is not running."), num
);
619 thread_info
*tp
= any_thread_of_inferior (inf
);
622 warning (_("Inferior ID %d has no threads."), num
);
626 switch_to_thread (tp
);
631 bfd_cache_close_all ();
635 inferior_command (const char *args
, int from_tty
)
637 struct inferior
*inf
;
640 num
= parse_and_eval_long (args
);
642 inf
= find_inferior_id (num
);
644 error (_("Inferior ID %d not known."), num
);
648 if (inf
!= current_inferior ())
650 thread_info
*tp
= any_thread_of_inferior (inf
);
652 error (_("Inferior has no threads."));
654 switch_to_thread (tp
);
657 gdb::observers::user_selected_context_changed
.notify
658 (USER_SELECTED_INFERIOR
659 | USER_SELECTED_THREAD
660 | USER_SELECTED_FRAME
);
664 set_current_inferior (inf
);
665 switch_to_no_thread ();
666 set_current_program_space (inf
->pspace
);
668 gdb::observers::user_selected_context_changed
.notify
669 (USER_SELECTED_INFERIOR
);
673 /* Print information about currently known inferiors. */
676 info_inferiors_command (const char *args
, int from_tty
)
678 print_inferior (current_uiout
, args
);
681 /* remove-inferior ID */
684 remove_inferior_command (const char *args
, int from_tty
)
686 if (args
== NULL
|| *args
== '\0')
687 error (_("Requires an argument (inferior id(s) to remove)"));
689 number_or_range_parser
parser (args
);
690 while (!parser
.finished ())
692 int num
= parser
.get_number ();
693 struct inferior
*inf
= find_inferior_id (num
);
697 warning (_("Inferior ID %d not known."), num
);
701 if (!inf
->deletable ())
703 warning (_("Can not remove current inferior %d."), num
);
709 warning (_("Can not remove active inferior %d."), num
);
713 delete_inferior (inf
);
718 add_inferior_with_spaces (void)
720 struct address_space
*aspace
;
721 struct program_space
*pspace
;
722 struct inferior
*inf
;
723 struct gdbarch_info info
;
725 /* If all inferiors share an address space on this system, this
726 doesn't really return a new address space; otherwise, it
728 aspace
= maybe_new_address_space ();
729 pspace
= new program_space (aspace
);
730 inf
= add_inferior (0);
731 inf
->pspace
= pspace
;
732 inf
->aspace
= pspace
->aspace
;
734 /* Setup the inferior's initial arch, based on information obtained
735 from the global "set ..." options. */
736 gdbarch_info_init (&info
);
737 inf
->gdbarch
= gdbarch_find_by_info (info
);
738 /* The "set ..." options reject invalid settings, so we should
739 always have a valid arch by now. */
740 gdb_assert (inf
->gdbarch
!= NULL
);
745 /* add-inferior [-copies N] [-exec FILENAME] */
748 add_inferior_command (const char *args
, int from_tty
)
751 gdb::unique_xmalloc_ptr
<char> exec
;
752 symfile_add_flags add_flags
= 0;
755 add_flags
|= SYMFILE_VERBOSE
;
759 gdb_argv
built_argv (args
);
761 for (char **argv
= built_argv
.get (); *argv
!= NULL
; argv
++)
765 if (strcmp (*argv
, "-copies") == 0)
769 error (_("No argument to -copies"));
770 copies
= parse_and_eval_long (*argv
);
772 else if (strcmp (*argv
, "-exec") == 0)
776 error (_("No argument to -exec"));
777 exec
.reset (tilde_expand (*argv
));
781 error (_("Invalid argument"));
785 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
787 for (i
= 0; i
< copies
; ++i
)
789 struct inferior
*inf
= add_inferior_with_spaces ();
791 printf_filtered (_("Added inferior %d\n"), inf
->num
);
795 /* Switch over temporarily, while reading executable and
797 set_current_program_space (inf
->pspace
);
798 set_current_inferior (inf
);
799 switch_to_no_thread ();
801 exec_file_attach (exec
.get (), from_tty
);
802 symbol_file_add_main (exec
.get (), add_flags
);
807 /* clone-inferior [-copies N] [ID] */
810 clone_inferior_command (const char *args
, int from_tty
)
813 struct inferior
*orginf
= NULL
;
817 gdb_argv
built_argv (args
);
819 char **argv
= built_argv
.get ();
820 for (; *argv
!= NULL
; argv
++)
824 if (strcmp (*argv
, "-copies") == 0)
828 error (_("No argument to -copies"));
829 copies
= parse_and_eval_long (*argv
);
832 error (_("Invalid copies number"));
841 /* The first non-option (-) argument specified the
843 num
= parse_and_eval_long (*argv
);
844 orginf
= find_inferior_id (num
);
847 error (_("Inferior ID %d not known."), num
);
851 error (_("Invalid argument"));
856 /* If no inferior id was specified, then the user wants to clone the
859 orginf
= current_inferior ();
861 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
863 for (i
= 0; i
< copies
; ++i
)
865 struct address_space
*aspace
;
866 struct program_space
*pspace
;
867 struct inferior
*inf
;
869 /* If all inferiors share an address space on this system, this
870 doesn't really return a new address space; otherwise, it
872 aspace
= maybe_new_address_space ();
873 pspace
= new program_space (aspace
);
874 inf
= add_inferior (0);
875 inf
->pspace
= pspace
;
876 inf
->aspace
= pspace
->aspace
;
877 inf
->gdbarch
= orginf
->gdbarch
;
879 /* If the original inferior had a user specified target
880 description, make the clone use it too. */
881 if (target_desc_info_from_user_p (inf
->tdesc_info
))
882 copy_inferior_target_desc_info (inf
, orginf
);
884 printf_filtered (_("Added inferior %d.\n"), inf
->num
);
886 set_current_inferior (inf
);
887 switch_to_no_thread ();
888 clone_program_space (pspace
, orginf
->pspace
);
892 /* Print notices when new inferiors are created and die. */
894 show_print_inferior_events (struct ui_file
*file
, int from_tty
,
895 struct cmd_list_element
*c
, const char *value
)
897 fprintf_filtered (file
, _("Printing of inferior events is %s.\n"), value
);
900 /* Return a new value for the selected inferior's id. */
902 static struct value
*
903 inferior_id_make_value (struct gdbarch
*gdbarch
, struct internalvar
*var
,
906 struct inferior
*inf
= current_inferior ();
908 return value_from_longest (builtin_type (gdbarch
)->builtin_int
, inf
->num
);
911 /* Implementation of `$_inferior' variable. */
913 static const struct internalvar_funcs inferior_funcs
=
915 inferior_id_make_value
,
923 initialize_inferiors (void)
925 struct cmd_list_element
*c
= NULL
;
927 /* There's always one inferior. Note that this function isn't an
928 automatic _initialize_foo function, since other _initialize_foo
929 routines may need to install their per-inferior data keys. We
930 can only allocate an inferior when all those modules have done
931 that. Do this after initialize_progspace, due to the
932 current_program_space reference. */
933 current_inferior_
= add_inferior_silent (0);
934 current_inferior_
->incref ();
935 current_inferior_
->pspace
= current_program_space
;
936 current_inferior_
->aspace
= current_program_space
->aspace
;
937 /* The architecture will be initialized shortly, by
938 initialize_current_architecture. */
940 add_info ("inferiors", info_inferiors_command
,
941 _("Print a list of inferiors being managed.\n\
942 Usage: info inferiors [ID]...\n\
943 If IDs are specified, the list is limited to just those inferiors.\n\
944 By default all inferiors are displayed."));
946 c
= add_com ("add-inferior", no_class
, add_inferior_command
, _("\
947 Add a new inferior.\n\
948 Usage: add-inferior [-copies N] [-exec FILENAME]\n\
949 N is the optional number of inferiors to add, default is 1.\n\
950 FILENAME is the file name of the executable to use\n\
952 set_cmd_completer (c
, filename_completer
);
954 add_com ("remove-inferiors", no_class
, remove_inferior_command
, _("\
955 Remove inferior ID (or list of IDs).\n\
956 Usage: remove-inferiors ID..."));
958 add_com ("clone-inferior", no_class
, clone_inferior_command
, _("\
959 Clone inferior ID.\n\
960 Usage: clone-inferior [-copies N] [ID]\n\
961 Add N copies of inferior ID. The new inferior has the same\n\
962 executable loaded as the copied inferior. If -copies is not specified,\n\
963 adds 1 copy. If ID is not specified, it is the current inferior\n\
966 add_cmd ("inferiors", class_run
, detach_inferior_command
, _("\
967 Detach from inferior ID (or list of IDS).\n\
968 Usage; detach inferiors ID..."),
971 add_cmd ("inferiors", class_run
, kill_inferior_command
, _("\
972 Kill inferior ID (or list of IDs).\n\
973 Usage: kill inferiors ID..."),
976 add_cmd ("inferior", class_run
, inferior_command
, _("\
977 Use this command to switch between inferiors.\n\
978 Usage: inferior ID\n\
979 The new inferior ID must be currently known."),
982 add_setshow_boolean_cmd ("inferior-events", no_class
,
983 &print_inferior_events
, _("\
984 Set printing of inferior events (e.g., inferior start and exit)."), _("\
985 Show printing of inferior events (e.g., inferior start and exit)."), NULL
,
987 show_print_inferior_events
,
988 &setprintlist
, &showprintlist
);
990 create_internalvar_type_lazy ("_inferior", &inferior_funcs
, NULL
);