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"
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 private_inferior::~private_inferior () = default;
76 inferior::~inferior ()
80 discard_all_inferior_continuations (inf);
81 inferior_free_data (inf);
83 xfree (inf->terminal);
84 target_desc_info_free (inf->tdesc_info);
87 inferior::inferior (int pid_)
88 : num (++highest_inferior_num),
90 environment (gdb_environ::from_host_environ ()),
93 inferior_alloc_data (this);
97 add_inferior_silent (int pid)
99 inferior *inf = new inferior (pid);
101 if (inferior_list == NULL)
107 for (last = inferior_list; last->next != NULL; last = last->next)
112 observer_notify_inferior_added (inf);
115 inferior_appeared (inf, pid);
121 add_inferior (int pid)
123 struct inferior *inf = add_inferior_silent (pid);
125 if (print_inferior_events)
126 printf_unfiltered (_("[New inferior %d]\n"), pid);
131 struct delete_thread_of_inferior_arg
138 delete_thread_of_inferior (struct thread_info *tp, void *data)
140 struct delete_thread_of_inferior_arg *arg
141 = (struct delete_thread_of_inferior_arg *) data;
143 if (ptid_get_pid (tp->ptid) == arg->pid)
146 delete_thread_silent (tp->ptid);
148 delete_thread (tp->ptid);
155 delete_inferior (struct inferior *todel)
157 struct inferior *inf, *infprev;
158 struct delete_thread_of_inferior_arg arg;
162 for (inf = inferior_list; inf; infprev = inf, inf = inf->next)
172 iterate_over_threads (delete_thread_of_inferior, &arg);
175 infprev->next = inf->next;
177 inferior_list = inf->next;
179 observer_notify_inferior_removed (inf);
181 /* If this program space is rendered useless, remove it. */
182 if (program_space_empty_p (inf->pspace))
183 delete_program_space (inf->pspace);
188 /* If SILENT then be quiet -- don't announce a inferior exit, or the
189 exit of its threads. */
192 exit_inferior_1 (struct inferior *inftoex, int silent)
194 struct inferior *inf;
195 struct delete_thread_of_inferior_arg arg;
197 for (inf = inferior_list; inf; inf = inf->next)
207 iterate_over_threads (delete_thread_of_inferior, &arg);
209 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;
228 inf->control = {NO_STOP_QUIETLY};
232 exit_inferior (int pid)
234 struct inferior *inf = find_inferior_pid (pid);
236 exit_inferior_1 (inf, 0);
238 if (print_inferior_events)
239 printf_unfiltered (_("[Inferior %d exited]\n"), pid);
243 exit_inferior_silent (int pid)
245 struct inferior *inf = find_inferior_pid (pid);
247 exit_inferior_1 (inf, 1);
251 exit_inferior_num_silent (int num)
253 struct inferior *inf = find_inferior_id (num);
255 exit_inferior_1 (inf, 1);
258 /* See inferior.h. */
261 detach_inferior (inferior *inf)
263 /* Save the pid, since exit_inferior_1 will reset it. */
266 exit_inferior_1 (inf, 0);
268 if (print_inferior_events)
269 printf_unfiltered (_("[Inferior %d detached]\n"), pid);
272 /* See inferior.h. */
275 detach_inferior (int pid)
277 detach_inferior (find_inferior_pid (pid));
281 inferior_appeared (struct inferior *inf, int pid)
284 inf->has_exit_code = 0;
287 observer_notify_inferior_appeared (inf);
291 discard_all_inferiors (void)
293 struct inferior *inf;
295 for (inf = inferior_list; inf; inf = inf->next)
298 exit_inferior_silent (inf->pid);
303 find_inferior_id (int num)
305 struct inferior *inf;
307 for (inf = inferior_list; inf; inf = inf->next)
315 find_inferior_pid (int pid)
317 struct inferior *inf;
319 /* Looking for inferior pid == 0 is always wrong, and indicative of
320 a bug somewhere else. There may be more than one with pid == 0,
322 gdb_assert (pid != 0);
324 for (inf = inferior_list; inf; inf = inf->next)
334 find_inferior_ptid (ptid_t ptid)
336 return find_inferior_pid (ptid_get_pid (ptid));
339 /* See inferior.h. */
342 find_inferior_for_program_space (struct program_space *pspace)
344 struct inferior *inf = current_inferior ();
346 if (inf->pspace == pspace)
349 for (inf = inferior_list; inf != NULL; inf = inf->next)
351 if (inf->pspace == pspace)
359 iterate_over_inferiors (int (*callback) (struct inferior *, void *),
362 struct inferior *inf, *infnext;
364 for (inf = inferior_list; inf; inf = infnext)
367 if ((*callback) (inf, data))
375 valid_gdb_inferior_id (int num)
377 struct inferior *inf;
379 for (inf = inferior_list; inf; inf = inf->next)
387 pid_to_gdb_inferior_id (int pid)
389 struct inferior *inf;
391 for (inf = inferior_list; inf; inf = inf->next)
399 gdb_inferior_id_to_pid (int num)
401 struct inferior *inferior = find_inferior_id (num);
403 return inferior->pid;
409 in_inferior_list (int pid)
411 struct inferior *inf;
413 for (inf = inferior_list; inf; inf = inf->next)
421 have_inferiors (void)
423 struct inferior *inf;
425 for (inf = inferior_list; inf; inf = inf->next)
432 /* Return the number of live inferiors. We account for the case
433 where an inferior might have a non-zero pid but no threads, as
434 in the middle of a 'mourn' operation. */
437 number_of_live_inferiors (void)
439 struct inferior *inf;
442 for (inf = inferior_list; inf; inf = inf->next)
445 struct thread_info *tp;
447 ALL_NON_EXITED_THREADS (tp)
448 if (tp && ptid_get_pid (tp->ptid) == inf->pid)
449 if (target_has_execution_1 (tp->ptid))
451 /* Found a live thread in this inferior, go to the next
461 /* Return true if there is at least one live inferior. */
464 have_live_inferiors (void)
466 return number_of_live_inferiors () > 0;
469 /* Prune away any unused inferiors, and then prune away no longer used
473 prune_inferiors (void)
475 struct inferior *ss, **ss_link;
478 ss_link = &inferior_list;
481 if (!ss->deletable ()
491 delete_inferior (ss);
496 /* Simply returns the count of inferiors. */
499 number_of_inferiors (void)
501 struct inferior *inf;
504 for (inf = inferior_list; inf != NULL; inf = inf->next)
510 /* Converts an inferior process id to a string. Like
511 target_pid_to_str, but special cases the null process. */
514 inferior_pid_to_str (int pid)
517 return target_pid_to_str (pid_to_ptid (pid));
522 /* See inferior.h. */
525 print_selected_inferior (struct ui_out *uiout)
527 struct inferior *inf = current_inferior ();
528 const char *filename = inf->pspace->pspace_exec_filename;
530 if (filename == NULL)
531 filename = _("<noexec>");
533 uiout->message (_("[Switching to inferior %d [%s] (%s)]\n"),
534 inf->num, inferior_pid_to_str (inf->pid), filename);
537 /* Prints the list of inferiors and their details on UIOUT. This is a
538 version of 'info_inferior_command' suitable for use from MI.
540 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
541 inferiors that should be printed. Otherwise, all inferiors are
545 print_inferior (struct ui_out *uiout, const char *requested_inferiors)
547 struct inferior *inf;
550 /* Compute number of inferiors we will print. */
551 for (inf = inferior_list; inf; inf = inf->next)
553 if (!number_is_in_list (requested_inferiors, inf->num))
561 uiout->message ("No inferiors.\n");
565 ui_out_emit_table table_emitter (uiout, 4, inf_count, "inferiors");
566 uiout->table_header (1, ui_left, "current", "");
567 uiout->table_header (4, ui_left, "number", "Num");
568 uiout->table_header (17, ui_left, "target-id", "Description");
569 uiout->table_header (17, ui_left, "exec", "Executable");
571 uiout->table_body ();
572 for (inf = inferior_list; inf; inf = inf->next)
574 if (!number_is_in_list (requested_inferiors, inf->num))
577 ui_out_emit_tuple tuple_emitter (uiout, NULL);
579 if (inf == current_inferior ())
580 uiout->field_string ("current", "*");
582 uiout->field_skip ("current");
584 uiout->field_int ("number", inf->num);
586 uiout->field_string ("target-id", inferior_pid_to_str (inf->pid));
588 if (inf->pspace->pspace_exec_filename != NULL)
589 uiout->field_string ("exec", inf->pspace->pspace_exec_filename);
591 uiout->field_skip ("exec");
593 /* Print extra info that isn't really fit to always present in
594 tabular form. Currently we print the vfork parent/child
595 relationships, if any. */
596 if (inf->vfork_parent)
598 uiout->text (_("\n\tis vfork child of inferior "));
599 uiout->field_int ("vfork-parent", inf->vfork_parent->num);
601 if (inf->vfork_child)
603 uiout->text (_("\n\tis vfork parent of inferior "));
604 uiout->field_int ("vfork-child", inf->vfork_child->num);
612 detach_inferior_command (const char *args, int from_tty)
614 struct thread_info *tp;
617 error (_("Requires argument (inferior id(s) to detach)"));
619 number_or_range_parser parser (args);
620 while (!parser.finished ())
622 int num = parser.get_number ();
624 if (!valid_gdb_inferior_id (num))
626 warning (_("Inferior ID %d not known."), num);
630 int pid = gdb_inferior_id_to_pid (num);
633 warning (_("Inferior ID %d is not running."), num);
637 tp = any_thread_of_process (pid);
640 warning (_("Inferior ID %d has no threads."), num);
644 switch_to_thread (tp->ptid);
646 detach_command (NULL, from_tty);
651 kill_inferior_command (const char *args, int from_tty)
653 struct thread_info *tp;
656 error (_("Requires argument (inferior id(s) to kill)"));
658 number_or_range_parser parser (args);
659 while (!parser.finished ())
661 int num = parser.get_number ();
663 if (!valid_gdb_inferior_id (num))
665 warning (_("Inferior ID %d not known."), num);
669 int pid = gdb_inferior_id_to_pid (num);
672 warning (_("Inferior ID %d is not running."), num);
676 tp = any_thread_of_process (pid);
679 warning (_("Inferior ID %d has no threads."), num);
683 switch_to_thread (tp->ptid);
688 bfd_cache_close_all ();
692 inferior_command (const char *args, int from_tty)
694 struct inferior *inf;
697 num = parse_and_eval_long (args);
699 inf = find_inferior_id (num);
701 error (_("Inferior ID %d not known."), num);
705 if (inf->pid != ptid_get_pid (inferior_ptid))
707 struct thread_info *tp;
709 tp = any_thread_of_process (inf->pid);
711 error (_("Inferior has no threads."));
713 switch_to_thread (tp->ptid);
716 observer_notify_user_selected_context_changed
717 (USER_SELECTED_INFERIOR
718 | USER_SELECTED_THREAD
719 | USER_SELECTED_FRAME);
723 set_current_inferior (inf);
724 switch_to_thread (null_ptid);
725 set_current_program_space (inf->pspace);
727 observer_notify_user_selected_context_changed (USER_SELECTED_INFERIOR);
731 /* Print information about currently known inferiors. */
734 info_inferiors_command (const char *args, int from_tty)
736 print_inferior (current_uiout, args);
739 /* remove-inferior ID */
742 remove_inferior_command (const char *args, int from_tty)
744 if (args == NULL || *args == '\0')
745 error (_("Requires an argument (inferior id(s) to remove)"));
747 number_or_range_parser parser (args);
748 while (!parser.finished ())
750 int num = parser.get_number ();
751 struct inferior *inf = find_inferior_id (num);
755 warning (_("Inferior ID %d not known."), num);
759 if (!inf->deletable ())
761 warning (_("Can not remove current inferior %d."), num);
767 warning (_("Can not remove active inferior %d."), num);
771 delete_inferior (inf);
776 add_inferior_with_spaces (void)
778 struct address_space *aspace;
779 struct program_space *pspace;
780 struct inferior *inf;
781 struct gdbarch_info info;
783 /* If all inferiors share an address space on this system, this
784 doesn't really return a new address space; otherwise, it
786 aspace = maybe_new_address_space ();
787 pspace = new program_space (aspace);
788 inf = add_inferior (0);
789 inf->pspace = pspace;
790 inf->aspace = pspace->aspace;
792 /* Setup the inferior's initial arch, based on information obtained
793 from the global "set ..." options. */
794 gdbarch_info_init (&info);
795 inf->gdbarch = gdbarch_find_by_info (info);
796 /* The "set ..." options reject invalid settings, so we should
797 always have a valid arch by now. */
798 gdb_assert (inf->gdbarch != NULL);
803 /* add-inferior [-copies N] [-exec FILENAME] */
806 add_inferior_command (const char *args, int from_tty)
809 gdb::unique_xmalloc_ptr<char> exec;
810 symfile_add_flags add_flags = 0;
813 add_flags |= SYMFILE_VERBOSE;
817 gdb_argv built_argv (args);
819 for (char **argv = built_argv.get (); *argv != NULL; argv++)
823 if (strcmp (*argv, "-copies") == 0)
827 error (_("No argument to -copies"));
828 copies = parse_and_eval_long (*argv);
830 else if (strcmp (*argv, "-exec") == 0)
834 error (_("No argument to -exec"));
835 exec.reset (tilde_expand (*argv));
839 error (_("Invalid argument"));
843 scoped_restore_current_pspace_and_thread restore_pspace_thread;
845 for (i = 0; i < copies; ++i)
847 struct inferior *inf = add_inferior_with_spaces ();
849 printf_filtered (_("Added inferior %d\n"), inf->num);
853 /* Switch over temporarily, while reading executable and
855 set_current_program_space (inf->pspace);
856 set_current_inferior (inf);
857 switch_to_thread (null_ptid);
859 exec_file_attach (exec.get (), from_tty);
860 symbol_file_add_main (exec.get (), add_flags);
865 /* clone-inferior [-copies N] [ID] */
868 clone_inferior_command (const char *args, int from_tty)
871 struct inferior *orginf = NULL;
875 gdb_argv built_argv (args);
877 char **argv = built_argv.get ();
878 for (; *argv != NULL; argv++)
882 if (strcmp (*argv, "-copies") == 0)
886 error (_("No argument to -copies"));
887 copies = parse_and_eval_long (*argv);
890 error (_("Invalid copies number"));
899 /* The first non-option (-) argument specified the
901 num = parse_and_eval_long (*argv);
902 orginf = find_inferior_id (num);
905 error (_("Inferior ID %d not known."), num);
909 error (_("Invalid argument"));
914 /* If no inferior id was specified, then the user wants to clone the
917 orginf = current_inferior ();
919 scoped_restore_current_pspace_and_thread restore_pspace_thread;
921 for (i = 0; i < copies; ++i)
923 struct address_space *aspace;
924 struct program_space *pspace;
925 struct inferior *inf;
927 /* If all inferiors share an address space on this system, this
928 doesn't really return a new address space; otherwise, it
930 aspace = maybe_new_address_space ();
931 pspace = new program_space (aspace);
932 inf = add_inferior (0);
933 inf->pspace = pspace;
934 inf->aspace = pspace->aspace;
935 inf->gdbarch = orginf->gdbarch;
937 /* If the original inferior had a user specified target
938 description, make the clone use it too. */
939 if (target_desc_info_from_user_p (inf->tdesc_info))
940 copy_inferior_target_desc_info (inf, orginf);
942 printf_filtered (_("Added inferior %d.\n"), inf->num);
944 set_current_inferior (inf);
945 switch_to_thread (null_ptid);
946 clone_program_space (pspace, orginf->pspace);
950 /* Print notices when new inferiors are created and die. */
952 show_print_inferior_events (struct ui_file *file, int from_tty,
953 struct cmd_list_element *c, const char *value)
955 fprintf_filtered (file, _("Printing of inferior events is %s.\n"), value);
958 /* Return a new value for the selected inferior's id. */
960 static struct value *
961 inferior_id_make_value (struct gdbarch *gdbarch, struct internalvar *var,
964 struct inferior *inf = current_inferior ();
966 return value_from_longest (builtin_type (gdbarch)->builtin_int, inf->num);
969 /* Implementation of `$_inferior' variable. */
971 static const struct internalvar_funcs inferior_funcs =
973 inferior_id_make_value,
981 initialize_inferiors (void)
983 struct cmd_list_element *c = NULL;
985 /* There's always one inferior. Note that this function isn't an
986 automatic _initialize_foo function, since other _initialize_foo
987 routines may need to install their per-inferior data keys. We
988 can only allocate an inferior when all those modules have done
989 that. Do this after initialize_progspace, due to the
990 current_program_space reference. */
991 current_inferior_ = add_inferior (0);
992 current_inferior_->incref ();
993 current_inferior_->pspace = current_program_space;
994 current_inferior_->aspace = current_program_space->aspace;
995 /* The architecture will be initialized shortly, by
996 initialize_current_architecture. */
998 add_info ("inferiors", info_inferiors_command,
999 _("IDs of specified inferiors (all inferiors if no argument)."));
1001 c = add_com ("add-inferior", no_class, add_inferior_command, _("\
1002 Add a new inferior.\n\
1003 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
1004 N is the optional number of inferiors to add, default is 1.\n\
1005 FILENAME is the file name of the executable to use\n\
1006 as main program."));
1007 set_cmd_completer (c, filename_completer);
1009 add_com ("remove-inferiors", no_class, remove_inferior_command, _("\
1010 Remove inferior ID (or list of IDs).\n\
1011 Usage: remove-inferiors ID..."));
1013 add_com ("clone-inferior", no_class, clone_inferior_command, _("\
1014 Clone inferior ID.\n\
1015 Usage: clone-inferior [-copies <N>] [ID]\n\
1016 Add N copies of inferior ID. The new inferior has the same\n\
1017 executable loaded as the copied inferior. If -copies is not specified,\n\
1018 adds 1 copy. If ID is not specified, it is the current inferior\n\
1021 add_cmd ("inferiors", class_run, detach_inferior_command, _("\
1022 Detach from inferior ID (or list of IDS)."),
1025 add_cmd ("inferiors", class_run, kill_inferior_command, _("\
1026 Kill inferior ID (or list of IDs)."),
1029 add_cmd ("inferior", class_run, inferior_command, _("\
1030 Use this command to switch between inferiors.\n\
1031 The new inferior ID must be currently known."),
1034 add_setshow_boolean_cmd ("inferior-events", no_class,
1035 &print_inferior_events, _("\
1036 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1037 Show printing of inferior events (e.g., inferior start and exit)."), NULL,
1039 show_print_inferior_events,
1040 &setprintlist, &showprintlist);
1042 create_internalvar_type_lazy ("_inferior", &inferior_funcs, NULL);