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 target_desc_info_free (inf
->tdesc_info
);
85 inferior::inferior (int pid_
)
86 : num (++highest_inferior_num
),
88 environment (gdb_environ::from_host_environ ()),
91 inferior_alloc_data (this);
93 m_target_stack
.push (get_dummy_target ());
97 inferior::set_tty (const char *terminal_name
)
99 if (terminal_name
!= nullptr && *terminal_name
!= '\0')
100 m_terminal
= make_unique_xstrdup (terminal_name
);
108 return m_terminal
.get ();
112 add_inferior_silent (int pid
)
114 inferior
*inf
= new inferior (pid
);
116 if (inferior_list
== NULL
)
122 for (last
= inferior_list
; last
->next
!= NULL
; last
= last
->next
)
127 gdb::observers::inferior_added
.notify (inf
);
130 inferior_appeared (inf
, pid
);
136 add_inferior (int pid
)
138 struct inferior
*inf
= add_inferior_silent (pid
);
140 if (print_inferior_events
)
143 printf_unfiltered (_("[New inferior %d (%s)]\n"),
145 target_pid_to_str (ptid_t (pid
)).c_str ());
147 printf_unfiltered (_("[New inferior %d]\n"), inf
->num
);
154 delete_inferior (struct inferior
*todel
)
156 struct inferior
*inf
, *infprev
;
160 for (inf
= inferior_list
; inf
; infprev
= inf
, inf
= inf
->next
)
167 for (thread_info
*tp
: inf
->threads_safe ())
168 delete_thread_silent (tp
);
171 infprev
->next
= inf
->next
;
173 inferior_list
= inf
->next
;
175 gdb::observers::inferior_removed
.notify (inf
);
177 /* If this program space is rendered useless, remove it. */
178 if (program_space_empty_p (inf
->pspace
))
184 /* If SILENT then be quiet -- don't announce a inferior exit, or the
185 exit of its threads. */
188 exit_inferior_1 (struct inferior
*inftoex
, int silent
)
190 struct inferior
*inf
;
192 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
199 for (thread_info
*tp
: inf
->threads_safe ())
202 delete_thread_silent (tp
);
207 gdb::observers::inferior_exit
.notify (inf
);
210 inf
->fake_pid_p
= false;
213 if (inf
->vfork_parent
!= NULL
)
215 inf
->vfork_parent
->vfork_child
= NULL
;
216 inf
->vfork_parent
= NULL
;
218 if (inf
->vfork_child
!= NULL
)
220 inf
->vfork_child
->vfork_parent
= NULL
;
221 inf
->vfork_child
= NULL
;
224 inf
->pending_detach
= 0;
226 inf
->control
= inferior_control_state (NO_STOP_QUIETLY
);
228 /* Clear the register cache and the frame cache. */
229 registers_changed ();
230 reinit_frame_cache ();
234 exit_inferior (inferior
*inf
)
236 exit_inferior_1 (inf
, 0);
240 exit_inferior_silent (inferior
*inf
)
242 exit_inferior_1 (inf
, 1);
245 /* See inferior.h. */
248 detach_inferior (inferior
*inf
)
250 /* Save the pid, since exit_inferior_1 will reset it. */
253 exit_inferior_1 (inf
, 0);
255 if (print_inferior_events
)
256 printf_unfiltered (_("[Inferior %d (%s) detached]\n"),
258 target_pid_to_str (ptid_t (pid
)).c_str ());
262 inferior_appeared (struct inferior
*inf
, int pid
)
264 /* If this is the first inferior with threads, reset the global
266 delete_exited_threads ();
267 if (!any_thread_p ())
271 inf
->has_exit_code
= 0;
274 gdb::observers::inferior_appeared
.notify (inf
);
278 find_inferior_id (int num
)
280 for (inferior
*inf
: all_inferiors ())
288 find_inferior_pid (process_stratum_target
*targ
, int pid
)
290 /* Looking for inferior pid == 0 is always wrong, and indicative of
291 a bug somewhere else. There may be more than one with pid == 0,
293 gdb_assert (pid
!= 0);
295 for (inferior
*inf
: all_inferiors (targ
))
305 find_inferior_ptid (process_stratum_target
*targ
, ptid_t ptid
)
307 return find_inferior_pid (targ
, ptid
.pid ());
310 /* See inferior.h. */
313 find_inferior_for_program_space (struct program_space
*pspace
)
315 struct inferior
*cur_inf
= current_inferior ();
317 if (cur_inf
->pspace
== pspace
)
320 for (inferior
*inf
: all_inferiors ())
321 if (inf
->pspace
== pspace
)
328 have_inferiors (void)
330 for (inferior
*inf ATTRIBUTE_UNUSED
: all_non_exited_inferiors ())
336 /* Return the number of live inferiors. We account for the case
337 where an inferior might have a non-zero pid but no threads, as
338 in the middle of a 'mourn' operation. */
341 number_of_live_inferiors (process_stratum_target
*proc_target
)
345 for (inferior
*inf
: all_non_exited_inferiors (proc_target
))
346 if (inf
->has_execution ())
347 for (thread_info
*tp ATTRIBUTE_UNUSED
: inf
->non_exited_threads ())
349 /* Found a live thread in this inferior, go to the next
358 /* Return true if there is at least one live inferior. */
361 have_live_inferiors (void)
363 return number_of_live_inferiors (NULL
) > 0;
366 /* Prune away any unused inferiors, and then prune away no longer used
370 prune_inferiors (void)
377 if (!ss
->deletable ()
385 inferior
*ss_next
= ss
->next
;
386 delete_inferior (ss
);
391 /* Simply returns the count of inferiors. */
394 number_of_inferiors (void)
396 auto rng
= all_inferiors ();
397 return std::distance (rng
.begin (), rng
.end ());
400 /* Converts an inferior process id to a string. Like
401 target_pid_to_str, but special cases the null process. */
404 inferior_pid_to_str (int pid
)
407 return target_pid_to_str (ptid_t (pid
));
412 /* See inferior.h. */
415 print_selected_inferior (struct ui_out
*uiout
)
417 struct inferior
*inf
= current_inferior ();
418 const char *filename
= inf
->pspace
->pspace_exec_filename
;
420 if (filename
== NULL
)
421 filename
= _("<noexec>");
423 uiout
->message (_("[Switching to inferior %d [%s] (%s)]\n"),
424 inf
->num
, inferior_pid_to_str (inf
->pid
).c_str (), filename
);
427 /* Helper for print_inferior. Returns the 'connection-id' string for
431 uiout_field_connection (process_stratum_target
*proc_target
)
433 if (proc_target
== NULL
)
437 else if (proc_target
->connection_string () != NULL
)
439 return string_printf ("%d (%s %s)",
440 proc_target
->connection_number
,
441 proc_target
->shortname (),
442 proc_target
->connection_string ());
446 return string_printf ("%d (%s)",
447 proc_target
->connection_number
,
448 proc_target
->shortname ());
452 /* Prints the list of inferiors and their details on UIOUT. This is a
453 version of 'info_inferior_command' suitable for use from MI.
455 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
456 inferiors that should be printed. Otherwise, all inferiors are
460 print_inferior (struct ui_out
*uiout
, const char *requested_inferiors
)
463 size_t connection_id_len
= 20;
465 /* Compute number of inferiors we will print. */
466 for (inferior
*inf
: all_inferiors ())
468 if (!number_is_in_list (requested_inferiors
, inf
->num
))
471 std::string conn
= uiout_field_connection (inf
->process_target ());
472 if (connection_id_len
< conn
.size ())
473 connection_id_len
= conn
.size ();
480 uiout
->message ("No inferiors.\n");
484 ui_out_emit_table
table_emitter (uiout
, 5, inf_count
, "inferiors");
485 uiout
->table_header (1, ui_left
, "current", "");
486 uiout
->table_header (4, ui_left
, "number", "Num");
487 uiout
->table_header (17, ui_left
, "target-id", "Description");
488 uiout
->table_header (connection_id_len
, ui_left
,
489 "connection-id", "Connection");
490 uiout
->table_header (17, ui_left
, "exec", "Executable");
492 uiout
->table_body ();
494 /* Restore the current thread after the loop because we switch the
495 inferior in the loop. */
496 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
497 inferior
*current_inf
= current_inferior ();
498 for (inferior
*inf
: all_inferiors ())
500 if (!number_is_in_list (requested_inferiors
, inf
->num
))
503 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
505 if (inf
== current_inf
)
506 uiout
->field_string ("current", "*");
508 uiout
->field_skip ("current");
510 uiout
->field_signed ("number", inf
->num
);
512 /* Because target_pid_to_str uses current_top_target,
513 switch the inferior. */
514 switch_to_inferior_no_thread (inf
);
516 uiout
->field_string ("target-id", inferior_pid_to_str (inf
->pid
));
518 std::string conn
= uiout_field_connection (inf
->process_target ());
519 uiout
->field_string ("connection-id", conn
.c_str ());
521 if (inf
->pspace
->pspace_exec_filename
!= NULL
)
522 uiout
->field_string ("exec", inf
->pspace
->pspace_exec_filename
);
524 uiout
->field_skip ("exec");
526 /* Print extra info that isn't really fit to always present in
527 tabular form. Currently we print the vfork parent/child
528 relationships, if any. */
529 if (inf
->vfork_parent
)
531 uiout
->text (_("\n\tis vfork child of inferior "));
532 uiout
->field_signed ("vfork-parent", inf
->vfork_parent
->num
);
534 if (inf
->vfork_child
)
536 uiout
->text (_("\n\tis vfork parent of inferior "));
537 uiout
->field_signed ("vfork-child", inf
->vfork_child
->num
);
545 detach_inferior_command (const char *args
, int from_tty
)
548 error (_("Requires argument (inferior id(s) to detach)"));
550 number_or_range_parser
parser (args
);
551 while (!parser
.finished ())
553 int num
= parser
.get_number ();
555 inferior
*inf
= find_inferior_id (num
);
558 warning (_("Inferior ID %d not known."), num
);
564 warning (_("Inferior ID %d is not running."), num
);
568 thread_info
*tp
= any_thread_of_inferior (inf
);
571 warning (_("Inferior ID %d has no threads."), num
);
575 switch_to_thread (tp
);
577 detach_command (NULL
, from_tty
);
582 kill_inferior_command (const char *args
, int from_tty
)
585 error (_("Requires argument (inferior id(s) to kill)"));
587 number_or_range_parser
parser (args
);
588 while (!parser
.finished ())
590 int num
= parser
.get_number ();
592 inferior
*inf
= find_inferior_id (num
);
595 warning (_("Inferior ID %d not known."), num
);
601 warning (_("Inferior ID %d is not running."), num
);
605 thread_info
*tp
= any_thread_of_inferior (inf
);
608 warning (_("Inferior ID %d has no threads."), num
);
612 switch_to_thread (tp
);
617 bfd_cache_close_all ();
620 /* See inferior.h. */
623 switch_to_inferior_no_thread (inferior
*inf
)
625 set_current_inferior (inf
);
626 switch_to_no_thread ();
627 set_current_program_space (inf
->pspace
);
631 inferior_command (const char *args
, int from_tty
)
633 struct inferior
*inf
;
636 num
= parse_and_eval_long (args
);
638 inf
= find_inferior_id (num
);
640 error (_("Inferior ID %d not known."), num
);
644 if (inf
!= current_inferior ())
646 thread_info
*tp
= any_thread_of_inferior (inf
);
648 error (_("Inferior has no threads."));
650 switch_to_thread (tp
);
653 gdb::observers::user_selected_context_changed
.notify
654 (USER_SELECTED_INFERIOR
655 | USER_SELECTED_THREAD
656 | USER_SELECTED_FRAME
);
660 switch_to_inferior_no_thread (inf
);
662 gdb::observers::user_selected_context_changed
.notify
663 (USER_SELECTED_INFERIOR
);
667 /* Print information about currently known inferiors. */
670 info_inferiors_command (const char *args
, int from_tty
)
672 print_inferior (current_uiout
, args
);
675 /* remove-inferior ID */
678 remove_inferior_command (const char *args
, int from_tty
)
680 if (args
== NULL
|| *args
== '\0')
681 error (_("Requires an argument (inferior id(s) to remove)"));
683 number_or_range_parser
parser (args
);
684 while (!parser
.finished ())
686 int num
= parser
.get_number ();
687 struct inferior
*inf
= find_inferior_id (num
);
691 warning (_("Inferior ID %d not known."), num
);
695 if (!inf
->deletable ())
697 warning (_("Can not remove current inferior %d."), num
);
703 warning (_("Can not remove active inferior %d."), num
);
707 delete_inferior (inf
);
712 add_inferior_with_spaces (void)
714 struct address_space
*aspace
;
715 struct program_space
*pspace
;
716 struct inferior
*inf
;
717 struct gdbarch_info info
;
719 /* If all inferiors share an address space on this system, this
720 doesn't really return a new address space; otherwise, it
722 aspace
= maybe_new_address_space ();
723 pspace
= new program_space (aspace
);
724 inf
= add_inferior (0);
725 inf
->pspace
= pspace
;
726 inf
->aspace
= pspace
->aspace
;
728 /* Setup the inferior's initial arch, based on information obtained
729 from the global "set ..." options. */
730 gdbarch_info_init (&info
);
731 inf
->gdbarch
= gdbarch_find_by_info (info
);
732 /* The "set ..." options reject invalid settings, so we should
733 always have a valid arch by now. */
734 gdb_assert (inf
->gdbarch
!= NULL
);
739 /* Switch to inferior NEW_INF, a new inferior, and unless
740 NO_CONNECTION is true, push the process_stratum_target of ORG_INF
744 switch_to_inferior_and_push_target (inferior
*new_inf
,
745 bool no_connection
, inferior
*org_inf
)
747 process_stratum_target
*proc_target
= org_inf
->process_target ();
749 /* Switch over temporarily, while reading executable and
751 switch_to_inferior_no_thread (new_inf
);
753 /* Reuse the target for new inferior. */
754 if (!no_connection
&& proc_target
!= NULL
)
756 push_target (proc_target
);
757 if (proc_target
->connection_string () != NULL
)
758 printf_filtered (_("Added inferior %d on connection %d (%s %s)\n"),
760 proc_target
->connection_number
,
761 proc_target
->shortname (),
762 proc_target
->connection_string ());
764 printf_filtered (_("Added inferior %d on connection %d (%s)\n"),
766 proc_target
->connection_number
,
767 proc_target
->shortname ());
770 printf_filtered (_("Added inferior %d\n"), new_inf
->num
);
773 /* add-inferior [-copies N] [-exec FILENAME] [-no-connection] */
776 add_inferior_command (const char *args
, int from_tty
)
779 gdb::unique_xmalloc_ptr
<char> exec
;
780 symfile_add_flags add_flags
= 0;
781 bool no_connection
= false;
784 add_flags
|= SYMFILE_VERBOSE
;
788 gdb_argv
built_argv (args
);
790 for (char **argv
= built_argv
.get (); *argv
!= NULL
; argv
++)
794 if (strcmp (*argv
, "-copies") == 0)
798 error (_("No argument to -copies"));
799 copies
= parse_and_eval_long (*argv
);
801 else if (strcmp (*argv
, "-no-connection") == 0)
802 no_connection
= true;
803 else if (strcmp (*argv
, "-exec") == 0)
807 error (_("No argument to -exec"));
808 exec
.reset (tilde_expand (*argv
));
812 error (_("Invalid argument"));
816 inferior
*orginf
= current_inferior ();
818 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
820 for (i
= 0; i
< copies
; ++i
)
822 inferior
*inf
= add_inferior_with_spaces ();
824 switch_to_inferior_and_push_target (inf
, no_connection
, orginf
);
828 exec_file_attach (exec
.get (), from_tty
);
829 symbol_file_add_main (exec
.get (), add_flags
);
834 /* clone-inferior [-copies N] [ID] [-no-connection] */
837 clone_inferior_command (const char *args
, int from_tty
)
840 struct inferior
*orginf
= NULL
;
841 bool no_connection
= false;
845 gdb_argv
built_argv (args
);
847 char **argv
= built_argv
.get ();
848 for (; *argv
!= NULL
; argv
++)
852 if (strcmp (*argv
, "-copies") == 0)
856 error (_("No argument to -copies"));
857 copies
= parse_and_eval_long (*argv
);
860 error (_("Invalid copies number"));
862 else if (strcmp (*argv
, "-no-connection") == 0)
863 no_connection
= true;
871 /* The first non-option (-) argument specified the
873 num
= parse_and_eval_long (*argv
);
874 orginf
= find_inferior_id (num
);
877 error (_("Inferior ID %d not known."), num
);
881 error (_("Invalid argument"));
886 /* If no inferior id was specified, then the user wants to clone the
889 orginf
= current_inferior ();
891 scoped_restore_current_pspace_and_thread restore_pspace_thread
;
893 for (i
= 0; i
< copies
; ++i
)
895 struct address_space
*aspace
;
896 struct program_space
*pspace
;
897 struct inferior
*inf
;
899 /* If all inferiors share an address space on this system, this
900 doesn't really return a new address space; otherwise, it
902 aspace
= maybe_new_address_space ();
903 pspace
= new program_space (aspace
);
904 inf
= add_inferior (0);
905 inf
->pspace
= pspace
;
906 inf
->aspace
= pspace
->aspace
;
907 inf
->gdbarch
= orginf
->gdbarch
;
909 switch_to_inferior_and_push_target (inf
, no_connection
, orginf
);
911 /* If the original inferior had a user specified target
912 description, make the clone use it too. */
913 if (target_desc_info_from_user_p (inf
->tdesc_info
))
914 copy_inferior_target_desc_info (inf
, orginf
);
916 clone_program_space (pspace
, orginf
->pspace
);
920 /* Print notices when new inferiors are created and die. */
922 show_print_inferior_events (struct ui_file
*file
, int from_tty
,
923 struct cmd_list_element
*c
, const char *value
)
925 fprintf_filtered (file
, _("Printing of inferior events is %s.\n"), value
);
928 /* Return a new value for the selected inferior's id. */
930 static struct value
*
931 inferior_id_make_value (struct gdbarch
*gdbarch
, struct internalvar
*var
,
934 struct inferior
*inf
= current_inferior ();
936 return value_from_longest (builtin_type (gdbarch
)->builtin_int
, inf
->num
);
939 /* Implementation of `$_inferior' variable. */
941 static const struct internalvar_funcs inferior_funcs
=
943 inferior_id_make_value
,
951 initialize_inferiors (void)
953 struct cmd_list_element
*c
= NULL
;
955 /* There's always one inferior. Note that this function isn't an
956 automatic _initialize_foo function, since other _initialize_foo
957 routines may need to install their per-inferior data keys. We
958 can only allocate an inferior when all those modules have done
959 that. Do this after initialize_progspace, due to the
960 current_program_space reference. */
961 current_inferior_
= add_inferior_silent (0);
962 current_inferior_
->incref ();
963 current_inferior_
->pspace
= current_program_space
;
964 current_inferior_
->aspace
= current_program_space
->aspace
;
965 /* The architecture will be initialized shortly, by
966 initialize_current_architecture. */
968 add_info ("inferiors", info_inferiors_command
,
969 _("Print a list of inferiors being managed.\n\
970 Usage: info inferiors [ID]...\n\
971 If IDs are specified, the list is limited to just those inferiors.\n\
972 By default all inferiors are displayed."));
974 c
= add_com ("add-inferior", no_class
, add_inferior_command
, _("\
975 Add a new inferior.\n\
976 Usage: add-inferior [-copies N] [-exec FILENAME] [-no-connection]\n\
977 N is the optional number of inferiors to add, default is 1.\n\
978 FILENAME is the file name of the executable to use\n\
980 By default, the new inferior inherits the current inferior's connection.\n\
981 If -no-connection is specified, the new inferior begins with\n\
982 no target connection yet."));
983 set_cmd_completer (c
, filename_completer
);
985 add_com ("remove-inferiors", no_class
, remove_inferior_command
, _("\
986 Remove inferior ID (or list of IDs).\n\
987 Usage: remove-inferiors ID..."));
989 add_com ("clone-inferior", no_class
, clone_inferior_command
, _("\
990 Clone inferior ID.\n\
991 Usage: clone-inferior [-copies N] [-no-connection] [ID]\n\
992 Add N copies of inferior ID. The new inferiors have the same\n\
993 executable loaded as the copied inferior. If -copies is not specified,\n\
994 adds 1 copy. If ID is not specified, it is the current inferior\n\
996 By default, the new inferiors inherit the copied inferior's connection.\n\
997 If -no-connection is specified, the new inferiors begin with\n\
998 no target connection yet."));
1000 add_cmd ("inferiors", class_run
, detach_inferior_command
, _("\
1001 Detach from inferior ID (or list of IDS).\n\
1002 Usage; detach inferiors ID..."),
1005 add_cmd ("inferiors", class_run
, kill_inferior_command
, _("\
1006 Kill inferior ID (or list of IDs).\n\
1007 Usage: kill inferiors ID..."),
1010 add_cmd ("inferior", class_run
, inferior_command
, _("\
1011 Use this command to switch between inferiors.\n\
1012 Usage: inferior ID\n\
1013 The new inferior ID must be currently known."),
1016 add_setshow_boolean_cmd ("inferior-events", no_class
,
1017 &print_inferior_events
, _("\
1018 Set printing of inferior events (such as inferior start and exit)."), _("\
1019 Show printing of inferior events (such as inferior start and exit)."), NULL
,
1021 show_print_inferior_events
,
1022 &setprintlist
, &showprintlist
);
1024 create_internalvar_type_lazy ("_inferior", &inferior_funcs
, NULL
);