1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2020 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 "gdbsupport/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 bool print_inferior_events
= true;
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 (inferior
*inf
)
226 exit_inferior_1 (inf
, 1);
229 /* See inferior.h. */
232 detach_inferior (inferior
*inf
)
234 /* Save the pid, since exit_inferior_1 will reset it. */
237 exit_inferior_1 (inf
, 0);
239 if (print_inferior_events
)
240 printf_unfiltered (_("[Inferior %d (%s) detached]\n"),
242 target_pid_to_str (ptid_t (pid
)).c_str ());
246 inferior_appeared (struct inferior
*inf
, int pid
)
248 /* If this is the first inferior with threads, reset the global
250 delete_exited_threads ();
251 if (!any_thread_p ())
255 inf
->has_exit_code
= 0;
258 gdb::observers::inferior_appeared
.notify (inf
);
262 discard_all_inferiors (void)
264 for (inferior
*inf
: all_non_exited_inferiors ())
265 exit_inferior_silent (inf
);
269 find_inferior_id (int num
)
271 for (inferior
*inf
: all_inferiors ())
279 find_inferior_pid (int pid
)
281 /* Looking for inferior pid == 0 is always wrong, and indicative of
282 a bug somewhere else. There may be more than one with pid == 0,
284 gdb_assert (pid
!= 0);
286 for (inferior
*inf
: all_inferiors ())
296 find_inferior_ptid (ptid_t ptid
)
298 return find_inferior_pid (ptid
.pid ());
301 /* See inferior.h. */
304 find_inferior_for_program_space (struct program_space
*pspace
)
306 struct inferior
*cur_inf
= current_inferior ();
308 if (cur_inf
->pspace
== pspace
)
311 for (inferior
*inf
: all_inferiors ())
312 if (inf
->pspace
== pspace
)
319 iterate_over_inferiors (int (*callback
) (struct inferior
*, void *),
322 for (inferior
*inf
: all_inferiors_safe ())
323 if ((*callback
) (inf
, data
))
330 have_inferiors (void)
332 for (inferior
*inf ATTRIBUTE_UNUSED
: all_non_exited_inferiors ())
338 /* Return the number of live inferiors. We account for the case
339 where an inferior might have a non-zero pid but no threads, as
340 in the middle of a 'mourn' operation. */
343 number_of_live_inferiors (void)
347 for (inferior
*inf
: all_non_exited_inferiors ())
348 if (inf
->has_execution ())
349 for (thread_info
*tp ATTRIBUTE_UNUSED
: inf
->non_exited_threads ())
351 /* Found a live thread in this inferior, go to the next
360 /* Return true if there is at least one live inferior. */
363 have_live_inferiors (void)
365 return number_of_live_inferiors () > 0;
368 /* Prune away any unused inferiors, and then prune away no longer used
372 prune_inferiors (void)
379 if (!ss
->deletable ()
387 inferior
*ss_next
= ss
->next
;
388 delete_inferior (ss
);
393 /* Simply returns the count of inferiors. */
396 number_of_inferiors (void)
398 auto rng
= all_inferiors ();
399 return std::distance (rng
.begin (), rng
.end ());
402 /* Converts an inferior process id to a string. Like
403 target_pid_to_str, but special cases the null process. */
406 inferior_pid_to_str (int pid
)
409 return target_pid_to_str (ptid_t (pid
));
414 /* See inferior.h. */
417 print_selected_inferior (struct ui_out
*uiout
)
419 struct inferior
*inf
= current_inferior ();
420 const char *filename
= inf
->pspace
->pspace_exec_filename
;
422 if (filename
== NULL
)
423 filename
= _("<noexec>");
425 uiout
->message (_("[Switching to inferior %d [%s] (%s)]\n"),
426 inf
->num
, inferior_pid_to_str (inf
->pid
).c_str (), filename
);
429 /* Prints the list of inferiors and their details on UIOUT. This is a
430 version of 'info_inferior_command' suitable for use from MI.
432 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
433 inferiors that should be printed. Otherwise, all inferiors are
437 print_inferior (struct ui_out
*uiout
, const char *requested_inferiors
)
441 /* Compute number of inferiors we will print. */
442 for (inferior
*inf
: all_inferiors ())
444 if (!number_is_in_list (requested_inferiors
, inf
->num
))
452 uiout
->message ("No inferiors.\n");
456 ui_out_emit_table
table_emitter (uiout
, 4, inf_count
, "inferiors");
457 uiout
->table_header (1, ui_left
, "current", "");
458 uiout
->table_header (4, ui_left
, "number", "Num");
459 uiout
->table_header (17, ui_left
, "target-id", "Description");
460 uiout
->table_header (17, ui_left
, "exec", "Executable");
462 uiout
->table_body ();
463 for (inferior
*inf
: all_inferiors ())
465 if (!number_is_in_list (requested_inferiors
, inf
->num
))
468 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
470 if (inf
== current_inferior ())
471 uiout
->field_string ("current", "*");
473 uiout
->field_skip ("current");
475 uiout
->field_signed ("number", inf
->num
);
477 uiout
->field_string ("target-id", inferior_pid_to_str (inf
->pid
));
479 if (inf
->pspace
->pspace_exec_filename
!= NULL
)
480 uiout
->field_string ("exec", inf
->pspace
->pspace_exec_filename
);
482 uiout
->field_skip ("exec");
484 /* Print extra info that isn't really fit to always present in
485 tabular form. Currently we print the vfork parent/child
486 relationships, if any. */
487 if (inf
->vfork_parent
)
489 uiout
->text (_("\n\tis vfork child of inferior "));
490 uiout
->field_signed ("vfork-parent", inf
->vfork_parent
->num
);
492 if (inf
->vfork_child
)
494 uiout
->text (_("\n\tis vfork parent of inferior "));
495 uiout
->field_signed ("vfork-child", inf
->vfork_child
->num
);
503 detach_inferior_command (const char *args
, int from_tty
)
506 error (_("Requires argument (inferior id(s) to detach)"));
508 number_or_range_parser
parser (args
);
509 while (!parser
.finished ())
511 int num
= parser
.get_number ();
513 inferior
*inf
= find_inferior_id (num
);
516 warning (_("Inferior ID %d not known."), num
);
522 warning (_("Inferior ID %d is not running."), num
);
526 thread_info
*tp
= any_thread_of_inferior (inf
);
529 warning (_("Inferior ID %d has no threads."), num
);
533 switch_to_thread (tp
);
535 detach_command (NULL
, from_tty
);
540 kill_inferior_command (const char *args
, int from_tty
)
543 error (_("Requires argument (inferior id(s) to kill)"));
545 number_or_range_parser
parser (args
);
546 while (!parser
.finished ())
548 int num
= parser
.get_number ();
550 inferior
*inf
= find_inferior_id (num
);
553 warning (_("Inferior ID %d not known."), num
);
559 warning (_("Inferior ID %d is not running."), num
);
563 thread_info
*tp
= any_thread_of_inferior (inf
);
566 warning (_("Inferior ID %d has no threads."), num
);
570 switch_to_thread (tp
);
575 bfd_cache_close_all ();
579 inferior_command (const char *args
, int from_tty
)
581 struct inferior
*inf
;
584 num
= parse_and_eval_long (args
);
586 inf
= find_inferior_id (num
);
588 error (_("Inferior ID %d not known."), num
);
592 if (inf
!= current_inferior ())
594 thread_info
*tp
= any_thread_of_inferior (inf
);
596 error (_("Inferior has no threads."));
598 switch_to_thread (tp
);
601 gdb::observers::user_selected_context_changed
.notify
602 (USER_SELECTED_INFERIOR
603 | USER_SELECTED_THREAD
604 | USER_SELECTED_FRAME
);
608 set_current_inferior (inf
);
609 switch_to_no_thread ();
610 set_current_program_space (inf
->pspace
);
612 gdb::observers::user_selected_context_changed
.notify
613 (USER_SELECTED_INFERIOR
);
617 /* Print information about currently known inferiors. */
620 info_inferiors_command (const char *args
, int from_tty
)
622 print_inferior (current_uiout
, args
);
625 /* remove-inferior ID */
628 remove_inferior_command (const char *args
, int from_tty
)
630 if (args
== NULL
|| *args
== '\0')
631 error (_("Requires an argument (inferior id(s) to remove)"));
633 number_or_range_parser
parser (args
);
634 while (!parser
.finished ())
636 int num
= parser
.get_number ();
637 struct inferior
*inf
= find_inferior_id (num
);
641 warning (_("Inferior ID %d not known."), num
);
645 if (!inf
->deletable ())
647 warning (_("Can not remove current inferior %d."), num
);
653 warning (_("Can not remove active inferior %d."), num
);
657 delete_inferior (inf
);
662 add_inferior_with_spaces (void)
664 struct address_space
*aspace
;
665 struct program_space
*pspace
;
666 struct inferior
*inf
;
667 struct gdbarch_info info
;
669 /* If all inferiors share an address space on this system, this
670 doesn't really return a new address space; otherwise, it
672 aspace
= maybe_new_address_space ();
673 pspace
= new program_space (aspace
);
674 inf
= add_inferior (0);
675 inf
->pspace
= pspace
;
676 inf
->aspace
= pspace
->aspace
;
678 /* Setup the inferior's initial arch, based on information obtained
679 from the global "set ..." options. */
680 gdbarch_info_init (&info
);
681 inf
->gdbarch
= gdbarch_find_by_info (info
);
682 /* The "set ..." options reject invalid settings, so we should
683 always have a valid arch by now. */
684 gdb_assert (inf
->gdbarch
!= NULL
);
689 /* add-inferior [-copies N] [-exec FILENAME] */
692 add_inferior_command (const char *args
, int from_tty
)
695 gdb::unique_xmalloc_ptr
<char> exec
;
696 symfile_add_flags add_flags
= 0;
699 add_flags
|= SYMFILE_VERBOSE
;
703 gdb_argv
built_argv (args
);
705 for (char **argv
= built_argv
.get (); *argv
!= NULL
; argv
++)
709 if (strcmp (*argv
, "-copies") == 0)
713 error (_("No argument to -copies"));
714 copies
= parse_and_eval_long (*argv
);
716 else if (strcmp (*argv
, "-exec") == 0)
720 error (_("No argument to -exec"));
721 exec
.reset (tilde_expand (*argv
));
725 error (_("Invalid argument"));
729 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
731 for (i
= 0; i
< copies
; ++i
)
733 struct inferior
*inf
= add_inferior_with_spaces ();
735 printf_filtered (_("Added inferior %d\n"), inf
->num
);
739 /* Switch over temporarily, while reading executable and
741 set_current_program_space (inf
->pspace
);
742 set_current_inferior (inf
);
743 switch_to_no_thread ();
745 exec_file_attach (exec
.get (), from_tty
);
746 symbol_file_add_main (exec
.get (), add_flags
);
751 /* clone-inferior [-copies N] [ID] */
754 clone_inferior_command (const char *args
, int from_tty
)
757 struct inferior
*orginf
= NULL
;
761 gdb_argv
built_argv (args
);
763 char **argv
= built_argv
.get ();
764 for (; *argv
!= NULL
; argv
++)
768 if (strcmp (*argv
, "-copies") == 0)
772 error (_("No argument to -copies"));
773 copies
= parse_and_eval_long (*argv
);
776 error (_("Invalid copies number"));
785 /* The first non-option (-) argument specified the
787 num
= parse_and_eval_long (*argv
);
788 orginf
= find_inferior_id (num
);
791 error (_("Inferior ID %d not known."), num
);
795 error (_("Invalid argument"));
800 /* If no inferior id was specified, then the user wants to clone the
803 orginf
= current_inferior ();
805 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
807 for (i
= 0; i
< copies
; ++i
)
809 struct address_space
*aspace
;
810 struct program_space
*pspace
;
811 struct inferior
*inf
;
813 /* If all inferiors share an address space on this system, this
814 doesn't really return a new address space; otherwise, it
816 aspace
= maybe_new_address_space ();
817 pspace
= new program_space (aspace
);
818 inf
= add_inferior (0);
819 inf
->pspace
= pspace
;
820 inf
->aspace
= pspace
->aspace
;
821 inf
->gdbarch
= orginf
->gdbarch
;
823 /* If the original inferior had a user specified target
824 description, make the clone use it too. */
825 if (target_desc_info_from_user_p (inf
->tdesc_info
))
826 copy_inferior_target_desc_info (inf
, orginf
);
828 printf_filtered (_("Added inferior %d.\n"), inf
->num
);
830 set_current_inferior (inf
);
831 switch_to_no_thread ();
832 clone_program_space (pspace
, orginf
->pspace
);
836 /* Print notices when new inferiors are created and die. */
838 show_print_inferior_events (struct ui_file
*file
, int from_tty
,
839 struct cmd_list_element
*c
, const char *value
)
841 fprintf_filtered (file
, _("Printing of inferior events is %s.\n"), value
);
844 /* Return a new value for the selected inferior's id. */
846 static struct value
*
847 inferior_id_make_value (struct gdbarch
*gdbarch
, struct internalvar
*var
,
850 struct inferior
*inf
= current_inferior ();
852 return value_from_longest (builtin_type (gdbarch
)->builtin_int
, inf
->num
);
855 /* Implementation of `$_inferior' variable. */
857 static const struct internalvar_funcs inferior_funcs
=
859 inferior_id_make_value
,
867 initialize_inferiors (void)
869 struct cmd_list_element
*c
= NULL
;
871 /* There's always one inferior. Note that this function isn't an
872 automatic _initialize_foo function, since other _initialize_foo
873 routines may need to install their per-inferior data keys. We
874 can only allocate an inferior when all those modules have done
875 that. Do this after initialize_progspace, due to the
876 current_program_space reference. */
877 current_inferior_
= add_inferior_silent (0);
878 current_inferior_
->incref ();
879 current_inferior_
->pspace
= current_program_space
;
880 current_inferior_
->aspace
= current_program_space
->aspace
;
881 /* The architecture will be initialized shortly, by
882 initialize_current_architecture. */
884 add_info ("inferiors", info_inferiors_command
,
885 _("Print a list of inferiors being managed.\n\
886 Usage: info inferiors [ID]...\n\
887 If IDs are specified, the list is limited to just those inferiors.\n\
888 By default all inferiors are displayed."));
890 c
= add_com ("add-inferior", no_class
, add_inferior_command
, _("\
891 Add a new inferior.\n\
892 Usage: add-inferior [-copies N] [-exec FILENAME]\n\
893 N is the optional number of inferiors to add, default is 1.\n\
894 FILENAME is the file name of the executable to use\n\
896 set_cmd_completer (c
, filename_completer
);
898 add_com ("remove-inferiors", no_class
, remove_inferior_command
, _("\
899 Remove inferior ID (or list of IDs).\n\
900 Usage: remove-inferiors ID..."));
902 add_com ("clone-inferior", no_class
, clone_inferior_command
, _("\
903 Clone inferior ID.\n\
904 Usage: clone-inferior [-copies N] [ID]\n\
905 Add N copies of inferior ID. The new inferior has the same\n\
906 executable loaded as the copied inferior. If -copies is not specified,\n\
907 adds 1 copy. If ID is not specified, it is the current inferior\n\
910 add_cmd ("inferiors", class_run
, detach_inferior_command
, _("\
911 Detach from inferior ID (or list of IDS).\n\
912 Usage; detach inferiors ID..."),
915 add_cmd ("inferiors", class_run
, kill_inferior_command
, _("\
916 Kill inferior ID (or list of IDs).\n\
917 Usage: kill inferiors ID..."),
920 add_cmd ("inferior", class_run
, inferior_command
, _("\
921 Use this command to switch between inferiors.\n\
922 Usage: inferior ID\n\
923 The new inferior ID must be currently known."),
926 add_setshow_boolean_cmd ("inferior-events", no_class
,
927 &print_inferior_events
, _("\
928 Set printing of inferior events (such as inferior start and exit)."), _("\
929 Show printing of inferior events (such as inferior start and exit)."), NULL
,
931 show_print_inferior_events
,
932 &setprintlist
, &showprintlist
);
934 create_internalvar_type_lazy ("_inferior", &inferior_funcs
, NULL
);