1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2015 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"
39 void _initialize_inferiors (void);
41 /* Keep a registry of per-inferior data-pointers required by other GDB
44 DEFINE_REGISTRY (inferior, REGISTRY_ACCESS_FIELD)
46 struct inferior *inferior_list = NULL;
47 static int highest_inferior_num;
49 /* Print notices on inferior events (attach, detach, etc.), set with
50 `set print inferior-events'. */
51 static int print_inferior_events = 0;
53 /* The Current Inferior. */
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);
68 current_inferior_ = inf;
71 /* A cleanups callback, helper for save_current_program_space
75 restore_inferior (void *arg)
77 struct inferior *saved_inferior = arg;
79 set_current_inferior (saved_inferior);
82 /* Save the current program space so that it may be restored by a later
83 call to do_cleanups. Returns the struct cleanup pointer needed for
84 later doing the cleanup. */
87 save_current_inferior (void)
89 struct cleanup *old_chain = make_cleanup (restore_inferior,
96 free_inferior (struct inferior *inf)
98 discard_all_inferior_continuations (inf);
99 inferior_free_data (inf);
101 xfree (inf->terminal);
102 free_environ (inf->environment);
103 target_desc_info_free (inf->tdesc_info);
109 init_inferior_list (void)
111 struct inferior *inf, *infnext;
113 highest_inferior_num = 0;
117 for (inf = inferior_list; inf; inf = infnext)
123 inferior_list = NULL;
127 add_inferior_silent (int pid)
129 struct inferior *inf;
131 inf = xmalloc (sizeof (*inf));
132 memset (inf, 0, sizeof (*inf));
135 inf->control.stop_soon = NO_STOP_QUIETLY;
137 inf->num = ++highest_inferior_num;
138 inf->next = inferior_list;
141 inf->environment = make_environ ();
142 init_environ (inf->environment);
144 inferior_alloc_data (inf);
146 observer_notify_inferior_added (inf);
149 inferior_appeared (inf, pid);
155 add_inferior (int pid)
157 struct inferior *inf = add_inferior_silent (pid);
159 if (print_inferior_events)
160 printf_unfiltered (_("[New inferior %d]\n"), pid);
165 struct delete_thread_of_inferior_arg
172 delete_thread_of_inferior (struct thread_info *tp, void *data)
174 struct delete_thread_of_inferior_arg *arg = data;
176 if (ptid_get_pid (tp->ptid) == arg->pid)
179 delete_thread_silent (tp->ptid);
181 delete_thread (tp->ptid);
187 /* If SILENT then be quiet -- don't announce a inferior death, or the
188 exit of its threads. */
191 delete_inferior_1 (struct inferior *todel, int silent)
193 struct inferior *inf, *infprev;
194 struct delete_thread_of_inferior_arg arg;
198 for (inf = inferior_list; inf; infprev = inf, inf = inf->next)
208 iterate_over_threads (delete_thread_of_inferior, &arg);
211 infprev->next = inf->next;
213 inferior_list = inf->next;
215 observer_notify_inferior_removed (inf);
221 delete_inferior (int pid)
223 struct inferior *inf = find_inferior_pid (pid);
225 delete_inferior_1 (inf, 0);
227 if (print_inferior_events)
228 printf_unfiltered (_("[Inferior %d exited]\n"), pid);
232 delete_inferior_silent (int pid)
234 struct inferior *inf = find_inferior_pid (pid);
236 delete_inferior_1 (inf, 1);
240 /* If SILENT then be quiet -- don't announce a inferior exit, or the
241 exit of its threads. */
244 exit_inferior_1 (struct inferior *inftoex, int silent)
246 struct inferior *inf;
247 struct delete_thread_of_inferior_arg arg;
249 for (inf = inferior_list; inf; inf = inf->next)
259 iterate_over_threads (delete_thread_of_inferior, &arg);
261 /* Notify the observers before removing the inferior from the list,
262 so that the observers have a chance to look it up. */
263 observer_notify_inferior_exit (inf);
267 if (inf->vfork_parent != NULL)
269 inf->vfork_parent->vfork_child = NULL;
270 inf->vfork_parent = NULL;
272 if (inf->vfork_child != NULL)
274 inf->vfork_child->vfork_parent = NULL;
275 inf->vfork_child = NULL;
278 inf->pending_detach = 0;
282 exit_inferior (int pid)
284 struct inferior *inf = find_inferior_pid (pid);
286 exit_inferior_1 (inf, 0);
288 if (print_inferior_events)
289 printf_unfiltered (_("[Inferior %d exited]\n"), pid);
293 exit_inferior_silent (int pid)
295 struct inferior *inf = find_inferior_pid (pid);
297 exit_inferior_1 (inf, 1);
301 exit_inferior_num_silent (int num)
303 struct inferior *inf = find_inferior_id (num);
305 exit_inferior_1 (inf, 1);
309 detach_inferior (int pid)
311 struct inferior *inf = find_inferior_pid (pid);
313 exit_inferior_1 (inf, 0);
315 if (print_inferior_events)
316 printf_unfiltered (_("[Inferior %d detached]\n"), pid);
320 inferior_appeared (struct inferior *inf, int pid)
323 inf->has_exit_code = 0;
326 observer_notify_inferior_appeared (inf);
330 discard_all_inferiors (void)
332 struct inferior *inf;
334 for (inf = inferior_list; inf; inf = inf->next)
337 exit_inferior_silent (inf->pid);
342 find_inferior_id (int num)
344 struct inferior *inf;
346 for (inf = inferior_list; inf; inf = inf->next)
354 find_inferior_pid (int pid)
356 struct inferior *inf;
358 /* Looking for inferior pid == 0 is always wrong, and indicative of
359 a bug somewhere else. There may be more than one with pid == 0,
361 for (inf = inferior_list; inf; inf = inf->next)
371 find_inferior_ptid (ptid_t ptid)
373 return find_inferior_pid (ptid_get_pid (ptid));
376 /* See inferior.h. */
379 find_inferior_for_program_space (struct program_space *pspace)
381 struct inferior *inf = current_inferior ();
383 if (inf->pspace == pspace)
386 for (inf = inferior_list; inf != NULL; inf = inf->next)
388 if (inf->pspace == pspace)
396 iterate_over_inferiors (int (*callback) (struct inferior *, void *),
399 struct inferior *inf, *infnext;
401 for (inf = inferior_list; inf; inf = infnext)
404 if ((*callback) (inf, data))
412 valid_gdb_inferior_id (int num)
414 struct inferior *inf;
416 for (inf = inferior_list; inf; inf = inf->next)
424 pid_to_gdb_inferior_id (int pid)
426 struct inferior *inf;
428 for (inf = inferior_list; inf; inf = inf->next)
436 gdb_inferior_id_to_pid (int num)
438 struct inferior *inferior = find_inferior_id (num);
440 return inferior->pid;
446 in_inferior_list (int pid)
448 struct inferior *inf;
450 for (inf = inferior_list; inf; inf = inf->next)
458 have_inferiors (void)
460 struct inferior *inf;
462 for (inf = inferior_list; inf; inf = inf->next)
470 have_live_inferiors (void)
472 struct inferior *inf;
474 for (inf = inferior_list; inf; inf = inf->next)
477 struct thread_info *tp;
479 tp = any_thread_of_process (inf->pid);
480 if (tp && target_has_execution_1 (tp->ptid))
487 /* Prune away any unused inferiors, and then prune away no longer used
491 prune_inferiors (void)
493 struct inferior *ss, **ss_link;
494 struct inferior *current = current_inferior ();
497 ss_link = &inferior_list;
510 delete_inferior_1 (ss, 1);
514 prune_program_spaces ();
517 /* Simply returns the count of inferiors. */
520 number_of_inferiors (void)
522 struct inferior *inf;
525 for (inf = inferior_list; inf != NULL; inf = inf->next)
531 /* Converts an inferior process id to a string. Like
532 target_pid_to_str, but special cases the null process. */
535 inferior_pid_to_str (int pid)
537 if (kernel_debugger || pid != 0)
538 return target_pid_to_str (pid_to_ptid (pid));
543 /* Prints the list of inferiors and their details on UIOUT. This is a
544 version of 'info_inferior_command' suitable for use from MI.
546 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
547 inferiors that should be printed. Otherwise, all inferiors are
551 print_inferior (struct ui_out *uiout, char *requested_inferiors)
553 struct inferior *inf;
554 struct cleanup *old_chain;
557 /* Compute number of inferiors we will print. */
558 for (inf = inferior_list; inf; inf = inf->next)
560 if (!number_is_in_list (requested_inferiors, inf->num))
568 ui_out_message (uiout, 0, "No inferiors.\n");
572 old_chain = make_cleanup_ui_out_table_begin_end (uiout, 4, inf_count,
574 ui_out_table_header (uiout, 1, ui_left, "current", "");
575 ui_out_table_header (uiout, 4, ui_left, "number", "Num");
576 ui_out_table_header (uiout, 17, ui_left, "target-id", "Description");
577 ui_out_table_header (uiout, 17, ui_left, "exec", "Executable");
579 ui_out_table_body (uiout);
580 for (inf = inferior_list; inf; inf = inf->next)
582 struct cleanup *chain2;
584 if (!number_is_in_list (requested_inferiors, inf->num))
587 chain2 = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
589 if (inf == current_inferior ())
590 ui_out_field_string (uiout, "current", "*");
592 ui_out_field_skip (uiout, "current");
594 ui_out_field_int (uiout, "number", inf->num);
596 ui_out_field_string (uiout, "target-id",
597 inferior_pid_to_str (inf->pid));
599 if (inf->pspace->pspace_exec_filename != NULL)
600 ui_out_field_string (uiout, "exec", inf->pspace->pspace_exec_filename);
602 ui_out_field_skip (uiout, "exec");
604 /* Print extra info that isn't really fit to always present in
605 tabular form. Currently we print the vfork parent/child
606 relationships, if any. */
607 if (inf->vfork_parent)
609 ui_out_text (uiout, _("\n\tis vfork child of inferior "));
610 ui_out_field_int (uiout, "vfork-parent", inf->vfork_parent->num);
612 if (inf->vfork_child)
614 ui_out_text (uiout, _("\n\tis vfork parent of inferior "));
615 ui_out_field_int (uiout, "vfork-child", inf->vfork_child->num);
618 ui_out_text (uiout, "\n");
619 do_cleanups (chain2);
622 do_cleanups (old_chain);
626 detach_inferior_command (char *args, int from_tty)
629 struct thread_info *tp;
630 struct get_number_or_range_state state;
633 error (_("Requires argument (inferior id(s) to detach)"));
635 init_number_or_range (&state, args);
636 while (!state.finished)
638 num = get_number_or_range (&state);
640 if (!valid_gdb_inferior_id (num))
642 warning (_("Inferior ID %d not known."), num);
646 pid = gdb_inferior_id_to_pid (num);
648 tp = any_thread_of_process (pid);
651 warning (_("Inferior ID %d has no threads."), num);
655 switch_to_thread (tp->ptid);
657 detach_command (NULL, from_tty);
662 kill_inferior_command (char *args, int from_tty)
665 struct thread_info *tp;
666 struct get_number_or_range_state state;
669 error (_("Requires argument (inferior id(s) to kill)"));
671 init_number_or_range (&state, args);
672 while (!state.finished)
674 num = get_number_or_range (&state);
676 if (!valid_gdb_inferior_id (num))
678 warning (_("Inferior ID %d not known."), num);
682 pid = gdb_inferior_id_to_pid (num);
684 tp = any_thread_of_process (pid);
687 warning (_("Inferior ID %d has no threads."), num);
691 switch_to_thread (tp->ptid);
696 bfd_cache_close_all ();
700 inferior_command (char *args, int from_tty)
702 struct inferior *inf;
705 num = parse_and_eval_long (args);
707 inf = find_inferior_id (num);
709 error (_("Inferior ID %d not known."), num);
711 printf_filtered (_("[Switching to inferior %d [%s] (%s)]\n"),
713 inferior_pid_to_str (inf->pid),
714 (inf->pspace->pspace_exec_filename != NULL
715 ? inf->pspace->pspace_exec_filename
720 if (inf->pid != ptid_get_pid (inferior_ptid))
722 struct thread_info *tp;
724 tp = any_thread_of_process (inf->pid);
726 error (_("Inferior has no threads."));
728 switch_to_thread (tp->ptid);
731 printf_filtered (_("[Switching to thread %d (%s)] "),
732 pid_to_thread_id (inferior_ptid),
733 target_pid_to_str (inferior_ptid));
737 struct inferior *inf;
739 inf = find_inferior_id (num);
740 set_current_inferior (inf);
741 switch_to_thread (null_ptid);
742 set_current_program_space (inf->pspace);
745 if (inf->pid != 0 && is_running (inferior_ptid))
746 ui_out_text (current_uiout, "(running)\n");
747 else if (inf->pid != 0)
749 ui_out_text (current_uiout, "\n");
750 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC, 1);
754 /* Print information about currently known inferiors. */
757 info_inferiors_command (char *args, int from_tty)
759 print_inferior (current_uiout, args);
762 /* remove-inferior ID */
765 remove_inferior_command (char *args, int from_tty)
768 struct inferior *inf;
769 struct get_number_or_range_state state;
771 if (args == NULL || *args == '\0')
772 error (_("Requires an argument (inferior id(s) to remove)"));
774 init_number_or_range (&state, args);
775 while (!state.finished)
777 num = get_number_or_range (&state);
778 inf = find_inferior_id (num);
782 warning (_("Inferior ID %d not known."), num);
786 if (inf == current_inferior ())
788 warning (_("Can not remove current symbol inferior %d."), num);
794 warning (_("Can not remove active inferior %d."), num);
798 delete_inferior_1 (inf, 1);
801 prune_program_spaces ();
805 add_inferior_with_spaces (void)
807 struct address_space *aspace;
808 struct program_space *pspace;
809 struct inferior *inf;
810 struct gdbarch_info info;
812 /* If all inferiors share an address space on this system, this
813 doesn't really return a new address space; otherwise, it
815 aspace = maybe_new_address_space ();
816 pspace = add_program_space (aspace);
817 inf = add_inferior (0);
818 inf->pspace = pspace;
819 inf->aspace = pspace->aspace;
821 /* Setup the inferior's initial arch, based on information obtained
822 from the global "set ..." options. */
823 gdbarch_info_init (&info);
824 inf->gdbarch = gdbarch_find_by_info (info);
825 /* The "set ..." options reject invalid settings, so we should
826 always have a valid arch by now. */
827 gdb_assert (inf->gdbarch != NULL);
832 /* add-inferior [-copies N] [-exec FILENAME] */
835 add_inferior_command (char *args, int from_tty)
840 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
844 argv = gdb_buildargv (args);
845 make_cleanup_freeargv (argv);
847 for (; *argv != NULL; argv++)
851 if (strcmp (*argv, "-copies") == 0)
855 error (_("No argument to -copies"));
856 copies = parse_and_eval_long (*argv);
858 else if (strcmp (*argv, "-exec") == 0)
862 error (_("No argument to -exec"));
863 exec = tilde_expand (*argv);
864 make_cleanup (xfree, exec);
868 error (_("Invalid argument"));
872 save_current_space_and_thread ();
874 for (i = 0; i < copies; ++i)
876 struct inferior *inf = add_inferior_with_spaces ();
878 printf_filtered (_("Added inferior %d\n"), inf->num);
882 /* Switch over temporarily, while reading executable and
884 set_current_program_space (inf->pspace);
885 set_current_inferior (inf);
886 switch_to_thread (null_ptid);
888 exec_file_attach (exec, from_tty);
889 symbol_file_add_main (exec, from_tty);
893 do_cleanups (old_chain);
896 /* clone-inferior [-copies N] [ID] */
899 clone_inferior_command (char *args, int from_tty)
903 struct inferior *orginf = NULL;
904 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
908 argv = gdb_buildargv (args);
909 make_cleanup_freeargv (argv);
911 for (; *argv != NULL; argv++)
915 if (strcmp (*argv, "-copies") == 0)
919 error (_("No argument to -copies"));
920 copies = parse_and_eval_long (*argv);
923 error (_("Invalid copies number"));
932 /* The first non-option (-) argument specified the
934 num = parse_and_eval_long (*argv);
935 orginf = find_inferior_id (num);
938 error (_("Inferior ID %d not known."), num);
942 error (_("Invalid argument"));
947 /* If no inferior id was specified, then the user wants to clone the
950 orginf = current_inferior ();
952 save_current_space_and_thread ();
954 for (i = 0; i < copies; ++i)
956 struct address_space *aspace;
957 struct program_space *pspace;
958 struct inferior *inf;
960 /* If all inferiors share an address space on this system, this
961 doesn't really return a new address space; otherwise, it
963 aspace = maybe_new_address_space ();
964 pspace = add_program_space (aspace);
965 inf = add_inferior (0);
966 inf->pspace = pspace;
967 inf->aspace = pspace->aspace;
968 inf->gdbarch = orginf->gdbarch;
970 /* If the original inferior had a user specified target
971 description, make the clone use it too. */
972 if (target_desc_info_from_user_p (inf->tdesc_info))
973 copy_inferior_target_desc_info (inf, orginf);
975 printf_filtered (_("Added inferior %d.\n"), inf->num);
977 set_current_inferior (inf);
978 switch_to_thread (null_ptid);
979 clone_program_space (pspace, orginf->pspace);
982 do_cleanups (old_chain);
985 /* Print notices when new inferiors are created and die. */
987 show_print_inferior_events (struct ui_file *file, int from_tty,
988 struct cmd_list_element *c, const char *value)
990 fprintf_filtered (file, _("Printing of inferior events is %s.\n"), value);
996 initialize_inferiors (void)
998 struct cmd_list_element *c = NULL;
1000 /* There's always one inferior. Note that this function isn't an
1001 automatic _initialize_foo function, since other _initialize_foo
1002 routines may need to install their per-inferior data keys. We
1003 can only allocate an inferior when all those modules have done
1004 that. Do this after initialize_progspace, due to the
1005 current_program_space reference. */
1006 current_inferior_ = add_inferior (0);
1007 current_inferior_->pspace = current_program_space;
1008 current_inferior_->aspace = current_program_space->aspace;
1009 /* The architecture will be initialized shortly, by
1010 initialize_current_architecture. */
1012 add_info ("inferiors", info_inferiors_command,
1013 _("IDs of specified inferiors (all inferiors if no argument)."));
1015 c = add_com ("add-inferior", no_class, add_inferior_command, _("\
1016 Add a new inferior.\n\
1017 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
1018 N is the optional number of inferiors to add, default is 1.\n\
1019 FILENAME is the file name of the executable to use\n\
1020 as main program."));
1021 set_cmd_completer (c, filename_completer);
1023 add_com ("remove-inferiors", no_class, remove_inferior_command, _("\
1024 Remove inferior ID (or list of IDs).\n\
1025 Usage: remove-inferiors ID..."));
1027 add_com ("clone-inferior", no_class, clone_inferior_command, _("\
1028 Clone inferior ID.\n\
1029 Usage: clone-inferior [-copies <N>] [ID]\n\
1030 Add N copies of inferior ID. The new inferior has the same\n\
1031 executable loaded as the copied inferior. If -copies is not specified,\n\
1032 adds 1 copy. If ID is not specified, it is the current inferior\n\
1035 add_cmd ("inferiors", class_run, detach_inferior_command, _("\
1036 Detach from inferior ID (or list of IDS)."),
1039 add_cmd ("inferiors", class_run, kill_inferior_command, _("\
1040 Kill inferior ID (or list of IDs)."),
1043 add_cmd ("inferior", class_run, inferior_command, _("\
1044 Use this command to switch between inferiors.\n\
1045 The new inferior ID must be currently known."),
1048 add_setshow_boolean_cmd ("inferior-events", no_class,
1049 &print_inferior_events, _("\
1050 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1051 Show printing of inferior events (e.g., inferior start and exit)."), NULL,
1053 show_print_inferior_events,
1054 &setprintlist, &showprintlist);