1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2019 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 "common/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 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
)).c_str ());
131 printf_unfiltered (_("[New inferior %d]\n"), inf
->num
);
138 delete_inferior (struct inferior
*todel
)
140 struct inferior
*inf
, *infprev
;
144 for (inf
= inferior_list
; inf
; infprev
= inf
, inf
= inf
->next
)
151 for (thread_info
*tp
: inf
->threads_safe ())
152 delete_thread_silent (tp
);
155 infprev
->next
= inf
->next
;
157 inferior_list
= inf
->next
;
159 gdb::observers::inferior_removed
.notify (inf
);
161 /* If this program space is rendered useless, remove it. */
162 if (program_space_empty_p (inf
->pspace
))
163 delete_program_space (inf
->pspace
);
168 /* If SILENT then be quiet -- don't announce a inferior exit, or the
169 exit of its threads. */
172 exit_inferior_1 (struct inferior
*inftoex
, int silent
)
174 struct inferior
*inf
;
176 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
183 for (thread_info
*tp
: inf
->threads_safe ())
186 delete_thread_silent (tp
);
191 gdb::observers::inferior_exit
.notify (inf
);
194 inf
->fake_pid_p
= false;
197 if (inf
->vfork_parent
!= NULL
)
199 inf
->vfork_parent
->vfork_child
= NULL
;
200 inf
->vfork_parent
= NULL
;
202 if (inf
->vfork_child
!= NULL
)
204 inf
->vfork_child
->vfork_parent
= NULL
;
205 inf
->vfork_child
= NULL
;
208 inf
->pending_detach
= 0;
210 inf
->control
= inferior_control_state (NO_STOP_QUIETLY
);
212 /* Clear the register cache and the frame cache. */
213 registers_changed ();
214 reinit_frame_cache ();
218 exit_inferior (inferior
*inf
)
220 exit_inferior_1 (inf
, 0);
224 exit_inferior_silent (int pid
)
226 struct inferior
*inf
= find_inferior_pid (pid
);
228 exit_inferior_1 (inf
, 1);
232 exit_inferior_silent (inferior
*inf
)
234 exit_inferior_1 (inf
, 1);
237 /* See inferior.h. */
240 detach_inferior (inferior
*inf
)
242 /* Save the pid, since exit_inferior_1 will reset it. */
245 exit_inferior_1 (inf
, 0);
247 if (print_inferior_events
)
248 printf_unfiltered (_("[Inferior %d (%s) detached]\n"),
250 target_pid_to_str (ptid_t (pid
)).c_str ());
254 inferior_appeared (struct inferior
*inf
, int pid
)
256 /* If this is the first inferior with threads, reset the global
258 if (!any_thread_p ())
262 inf
->has_exit_code
= 0;
265 gdb::observers::inferior_appeared
.notify (inf
);
269 discard_all_inferiors (void)
271 for (inferior
*inf
: all_non_exited_inferiors ())
272 exit_inferior_silent (inf
);
276 find_inferior_id (int num
)
278 for (inferior
*inf
: all_inferiors ())
286 find_inferior_pid (int pid
)
288 /* Looking for inferior pid == 0 is always wrong, and indicative of
289 a bug somewhere else. There may be more than one with pid == 0,
291 gdb_assert (pid
!= 0);
293 for (inferior
*inf
: all_inferiors ())
303 find_inferior_ptid (ptid_t ptid
)
305 return find_inferior_pid (ptid
.pid ());
308 /* See inferior.h. */
311 find_inferior_for_program_space (struct program_space
*pspace
)
313 struct inferior
*cur_inf
= current_inferior ();
315 if (cur_inf
->pspace
== pspace
)
318 for (inferior
*inf
: all_inferiors ())
319 if (inf
->pspace
== pspace
)
326 iterate_over_inferiors (int (*callback
) (struct inferior
*, void *),
329 for (inferior
*inf
: all_inferiors_safe ())
330 if ((*callback
) (inf
, data
))
337 have_inferiors (void)
339 for (inferior
*inf ATTRIBUTE_UNUSED
: all_non_exited_inferiors ())
345 /* Return the number of live inferiors. We account for the case
346 where an inferior might have a non-zero pid but no threads, as
347 in the middle of a 'mourn' operation. */
350 number_of_live_inferiors (void)
354 for (inferior
*inf
: all_non_exited_inferiors ())
355 if (target_has_execution_1 (ptid_t (inf
->pid
)))
356 for (thread_info
*tp ATTRIBUTE_UNUSED
: inf
->non_exited_threads ())
358 /* Found a live thread in this inferior, go to the next
367 /* Return true if there is at least one live inferior. */
370 have_live_inferiors (void)
372 return number_of_live_inferiors () > 0;
375 /* Prune away any unused inferiors, and then prune away no longer used
379 prune_inferiors (void)
381 struct inferior
*ss
, **ss_link
;
384 ss_link
= &inferior_list
;
387 if (!ss
->deletable ()
397 delete_inferior (ss
);
402 /* Simply returns the count of inferiors. */
405 number_of_inferiors (void)
407 auto rng
= all_inferiors ();
408 return std::distance (rng
.begin (), rng
.end ());
411 /* Converts an inferior process id to a string. Like
412 target_pid_to_str, but special cases the null process. */
415 inferior_pid_to_str (int pid
)
418 return target_pid_to_str (ptid_t (pid
));
423 /* See inferior.h. */
426 print_selected_inferior (struct ui_out
*uiout
)
428 struct inferior
*inf
= current_inferior ();
429 const char *filename
= inf
->pspace
->pspace_exec_filename
;
431 if (filename
== NULL
)
432 filename
= _("<noexec>");
434 uiout
->message (_("[Switching to inferior %d [%s] (%s)]\n"),
435 inf
->num
, inferior_pid_to_str (inf
->pid
).c_str (), filename
);
438 /* Prints the list of inferiors and their details on UIOUT. This is a
439 version of 'info_inferior_command' suitable for use from MI.
441 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
442 inferiors that should be printed. Otherwise, all inferiors are
446 print_inferior (struct ui_out
*uiout
, const char *requested_inferiors
)
450 /* Compute number of inferiors we will print. */
451 for (inferior
*inf
: all_inferiors ())
453 if (!number_is_in_list (requested_inferiors
, inf
->num
))
461 uiout
->message ("No inferiors.\n");
465 ui_out_emit_table
table_emitter (uiout
, 4, inf_count
, "inferiors");
466 uiout
->table_header (1, ui_left
, "current", "");
467 uiout
->table_header (4, ui_left
, "number", "Num");
468 uiout
->table_header (17, ui_left
, "target-id", "Description");
469 uiout
->table_header (17, ui_left
, "exec", "Executable");
471 uiout
->table_body ();
472 for (inferior
*inf
: all_inferiors ())
474 if (!number_is_in_list (requested_inferiors
, inf
->num
))
477 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
479 if (inf
== current_inferior ())
480 uiout
->field_string ("current", "*");
482 uiout
->field_skip ("current");
484 uiout
->field_int ("number", inf
->num
);
486 uiout
->field_string ("target-id", inferior_pid_to_str (inf
->pid
));
488 if (inf
->pspace
->pspace_exec_filename
!= NULL
)
489 uiout
->field_string ("exec", inf
->pspace
->pspace_exec_filename
);
491 uiout
->field_skip ("exec");
493 /* Print extra info that isn't really fit to always present in
494 tabular form. Currently we print the vfork parent/child
495 relationships, if any. */
496 if (inf
->vfork_parent
)
498 uiout
->text (_("\n\tis vfork child of inferior "));
499 uiout
->field_int ("vfork-parent", inf
->vfork_parent
->num
);
501 if (inf
->vfork_child
)
503 uiout
->text (_("\n\tis vfork parent of inferior "));
504 uiout
->field_int ("vfork-child", inf
->vfork_child
->num
);
512 detach_inferior_command (const char *args
, int from_tty
)
515 error (_("Requires argument (inferior id(s) to detach)"));
517 number_or_range_parser
parser (args
);
518 while (!parser
.finished ())
520 int num
= parser
.get_number ();
522 inferior
*inf
= find_inferior_id (num
);
525 warning (_("Inferior ID %d not known."), num
);
531 warning (_("Inferior ID %d is not running."), num
);
535 thread_info
*tp
= any_thread_of_inferior (inf
);
538 warning (_("Inferior ID %d has no threads."), num
);
542 switch_to_thread (tp
);
544 detach_command (NULL
, from_tty
);
549 kill_inferior_command (const char *args
, int from_tty
)
552 error (_("Requires argument (inferior id(s) to kill)"));
554 number_or_range_parser
parser (args
);
555 while (!parser
.finished ())
557 int num
= parser
.get_number ();
559 inferior
*inf
= find_inferior_id (num
);
562 warning (_("Inferior ID %d not known."), num
);
568 warning (_("Inferior ID %d is not running."), num
);
572 thread_info
*tp
= any_thread_of_inferior (inf
);
575 warning (_("Inferior ID %d has no threads."), num
);
579 switch_to_thread (tp
);
584 bfd_cache_close_all ();
588 inferior_command (const char *args
, int from_tty
)
590 struct inferior
*inf
;
593 num
= parse_and_eval_long (args
);
595 inf
= find_inferior_id (num
);
597 error (_("Inferior ID %d not known."), num
);
601 if (inf
!= current_inferior ())
603 thread_info
*tp
= any_thread_of_inferior (inf
);
605 error (_("Inferior has no threads."));
607 switch_to_thread (tp
);
610 gdb::observers::user_selected_context_changed
.notify
611 (USER_SELECTED_INFERIOR
612 | USER_SELECTED_THREAD
613 | USER_SELECTED_FRAME
);
617 set_current_inferior (inf
);
618 switch_to_no_thread ();
619 set_current_program_space (inf
->pspace
);
621 gdb::observers::user_selected_context_changed
.notify
622 (USER_SELECTED_INFERIOR
);
626 /* Print information about currently known inferiors. */
629 info_inferiors_command (const char *args
, int from_tty
)
631 print_inferior (current_uiout
, args
);
634 /* remove-inferior ID */
637 remove_inferior_command (const char *args
, int from_tty
)
639 if (args
== NULL
|| *args
== '\0')
640 error (_("Requires an argument (inferior id(s) to remove)"));
642 number_or_range_parser
parser (args
);
643 while (!parser
.finished ())
645 int num
= parser
.get_number ();
646 struct inferior
*inf
= find_inferior_id (num
);
650 warning (_("Inferior ID %d not known."), num
);
654 if (!inf
->deletable ())
656 warning (_("Can not remove current inferior %d."), num
);
662 warning (_("Can not remove active inferior %d."), num
);
666 delete_inferior (inf
);
671 add_inferior_with_spaces (void)
673 struct address_space
*aspace
;
674 struct program_space
*pspace
;
675 struct inferior
*inf
;
676 struct gdbarch_info info
;
678 /* If all inferiors share an address space on this system, this
679 doesn't really return a new address space; otherwise, it
681 aspace
= maybe_new_address_space ();
682 pspace
= new program_space (aspace
);
683 inf
= add_inferior (0);
684 inf
->pspace
= pspace
;
685 inf
->aspace
= pspace
->aspace
;
687 /* Setup the inferior's initial arch, based on information obtained
688 from the global "set ..." options. */
689 gdbarch_info_init (&info
);
690 inf
->gdbarch
= gdbarch_find_by_info (info
);
691 /* The "set ..." options reject invalid settings, so we should
692 always have a valid arch by now. */
693 gdb_assert (inf
->gdbarch
!= NULL
);
698 /* add-inferior [-copies N] [-exec FILENAME] */
701 add_inferior_command (const char *args
, int from_tty
)
704 gdb::unique_xmalloc_ptr
<char> exec
;
705 symfile_add_flags add_flags
= 0;
708 add_flags
|= SYMFILE_VERBOSE
;
712 gdb_argv
built_argv (args
);
714 for (char **argv
= built_argv
.get (); *argv
!= NULL
; argv
++)
718 if (strcmp (*argv
, "-copies") == 0)
722 error (_("No argument to -copies"));
723 copies
= parse_and_eval_long (*argv
);
725 else if (strcmp (*argv
, "-exec") == 0)
729 error (_("No argument to -exec"));
730 exec
.reset (tilde_expand (*argv
));
734 error (_("Invalid argument"));
738 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
740 for (i
= 0; i
< copies
; ++i
)
742 struct inferior
*inf
= add_inferior_with_spaces ();
744 printf_filtered (_("Added inferior %d\n"), inf
->num
);
748 /* Switch over temporarily, while reading executable and
750 set_current_program_space (inf
->pspace
);
751 set_current_inferior (inf
);
752 switch_to_no_thread ();
754 exec_file_attach (exec
.get (), from_tty
);
755 symbol_file_add_main (exec
.get (), add_flags
);
760 /* clone-inferior [-copies N] [ID] */
763 clone_inferior_command (const char *args
, int from_tty
)
766 struct inferior
*orginf
= NULL
;
770 gdb_argv
built_argv (args
);
772 char **argv
= built_argv
.get ();
773 for (; *argv
!= NULL
; argv
++)
777 if (strcmp (*argv
, "-copies") == 0)
781 error (_("No argument to -copies"));
782 copies
= parse_and_eval_long (*argv
);
785 error (_("Invalid copies number"));
794 /* The first non-option (-) argument specified the
796 num
= parse_and_eval_long (*argv
);
797 orginf
= find_inferior_id (num
);
800 error (_("Inferior ID %d not known."), num
);
804 error (_("Invalid argument"));
809 /* If no inferior id was specified, then the user wants to clone the
812 orginf
= current_inferior ();
814 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
816 for (i
= 0; i
< copies
; ++i
)
818 struct address_space
*aspace
;
819 struct program_space
*pspace
;
820 struct inferior
*inf
;
822 /* If all inferiors share an address space on this system, this
823 doesn't really return a new address space; otherwise, it
825 aspace
= maybe_new_address_space ();
826 pspace
= new program_space (aspace
);
827 inf
= add_inferior (0);
828 inf
->pspace
= pspace
;
829 inf
->aspace
= pspace
->aspace
;
830 inf
->gdbarch
= orginf
->gdbarch
;
832 /* If the original inferior had a user specified target
833 description, make the clone use it too. */
834 if (target_desc_info_from_user_p (inf
->tdesc_info
))
835 copy_inferior_target_desc_info (inf
, orginf
);
837 printf_filtered (_("Added inferior %d.\n"), inf
->num
);
839 set_current_inferior (inf
);
840 switch_to_no_thread ();
841 clone_program_space (pspace
, orginf
->pspace
);
845 /* Print notices when new inferiors are created and die. */
847 show_print_inferior_events (struct ui_file
*file
, int from_tty
,
848 struct cmd_list_element
*c
, const char *value
)
850 fprintf_filtered (file
, _("Printing of inferior events is %s.\n"), value
);
853 /* Return a new value for the selected inferior's id. */
855 static struct value
*
856 inferior_id_make_value (struct gdbarch
*gdbarch
, struct internalvar
*var
,
859 struct inferior
*inf
= current_inferior ();
861 return value_from_longest (builtin_type (gdbarch
)->builtin_int
, inf
->num
);
864 /* Implementation of `$_inferior' variable. */
866 static const struct internalvar_funcs inferior_funcs
=
868 inferior_id_make_value
,
876 initialize_inferiors (void)
878 struct cmd_list_element
*c
= NULL
;
880 /* There's always one inferior. Note that this function isn't an
881 automatic _initialize_foo function, since other _initialize_foo
882 routines may need to install their per-inferior data keys. We
883 can only allocate an inferior when all those modules have done
884 that. Do this after initialize_progspace, due to the
885 current_program_space reference. */
886 current_inferior_
= add_inferior_silent (0);
887 current_inferior_
->incref ();
888 current_inferior_
->pspace
= current_program_space
;
889 current_inferior_
->aspace
= current_program_space
->aspace
;
890 /* The architecture will be initialized shortly, by
891 initialize_current_architecture. */
893 add_info ("inferiors", info_inferiors_command
,
894 _("Print a list of inferiors being managed.\n\
895 Usage: info inferiors [ID]...\n\
896 If IDs are specified, the list is limited to just those inferiors.\n\
897 By default all inferiors are displayed."));
899 c
= add_com ("add-inferior", no_class
, add_inferior_command
, _("\
900 Add a new inferior.\n\
901 Usage: add-inferior [-copies N] [-exec FILENAME]\n\
902 N is the optional number of inferiors to add, default is 1.\n\
903 FILENAME is the file name of the executable to use\n\
905 set_cmd_completer (c
, filename_completer
);
907 add_com ("remove-inferiors", no_class
, remove_inferior_command
, _("\
908 Remove inferior ID (or list of IDs).\n\
909 Usage: remove-inferiors ID..."));
911 add_com ("clone-inferior", no_class
, clone_inferior_command
, _("\
912 Clone inferior ID.\n\
913 Usage: clone-inferior [-copies N] [ID]\n\
914 Add N copies of inferior ID. The new inferior has the same\n\
915 executable loaded as the copied inferior. If -copies is not specified,\n\
916 adds 1 copy. If ID is not specified, it is the current inferior\n\
919 add_cmd ("inferiors", class_run
, detach_inferior_command
, _("\
920 Detach from inferior ID (or list of IDS).\n\
921 Usage; detach inferiors ID..."),
924 add_cmd ("inferiors", class_run
, kill_inferior_command
, _("\
925 Kill inferior ID (or list of IDs).\n\
926 Usage: kill inferiors ID..."),
929 add_cmd ("inferior", class_run
, inferior_command
, _("\
930 Use this command to switch between inferiors.\n\
931 Usage: inferior ID\n\
932 The new inferior ID must be currently known."),
935 add_setshow_boolean_cmd ("inferior-events", no_class
,
936 &print_inferior_events
, _("\
937 Set printing of inferior events (such as inferior start and exit)."), _("\
938 Show printing of inferior events (such as inferior start and exit)."), NULL
,
940 show_print_inferior_events
,
941 &setprintlist
, &showprintlist
);
943 create_internalvar_type_lazy ("_inferior", &inferior_funcs
, NULL
);