1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2013 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"
30 #include "gdbthread.h"
34 #include "cli/cli-utils.h"
35 #include "continuations.h"
36 #include "arch-utils.h"
37 #include "target-descriptions.h"
38 #include "readline/tilde.h"
40 void _initialize_inferiors (void);
42 /* Keep a registry of per-inferior data-pointers required by other GDB
45 DEFINE_REGISTRY (inferior, REGISTRY_ACCESS_FIELD)
47 struct inferior *inferior_list = NULL;
48 static int highest_inferior_num;
50 /* Print notices on inferior events (attach, detach, etc.), set with
51 `set print inferior-events'. */
52 static int print_inferior_events = 0;
54 /* The Current Inferior. */
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);
69 current_inferior_ = inf;
72 /* A cleanups callback, helper for save_current_program_space
76 restore_inferior (void *arg)
78 struct inferior *saved_inferior = arg;
80 set_current_inferior (saved_inferior);
83 /* Save the current program space so that it may be restored by a later
84 call to do_cleanups. Returns the struct cleanup pointer needed for
85 later doing the cleanup. */
88 save_current_inferior (void)
90 struct cleanup *old_chain = make_cleanup (restore_inferior,
97 free_inferior (struct inferior *inf)
99 discard_all_inferior_continuations (inf);
100 inferior_free_data (inf);
102 xfree (inf->terminal);
103 free_environ (inf->environment);
104 target_desc_info_free (inf->tdesc_info);
105 xfree (inf->private);
110 init_inferior_list (void)
112 struct inferior *inf, *infnext;
114 highest_inferior_num = 0;
118 for (inf = inferior_list; inf; inf = infnext)
124 inferior_list = NULL;
128 add_inferior_silent (int pid)
130 struct inferior *inf;
132 inf = xmalloc (sizeof (*inf));
133 memset (inf, 0, sizeof (*inf));
136 inf->control.stop_soon = NO_STOP_QUIETLY;
138 inf->num = ++highest_inferior_num;
139 inf->next = inferior_list;
142 inf->environment = make_environ ();
143 init_environ (inf->environment);
145 inferior_alloc_data (inf);
147 observer_notify_inferior_added (inf);
150 inferior_appeared (inf, pid);
156 add_inferior (int pid)
158 struct inferior *inf = add_inferior_silent (pid);
160 if (print_inferior_events)
161 printf_unfiltered (_("[New inferior %d]\n"), pid);
166 struct delete_thread_of_inferior_arg
173 delete_thread_of_inferior (struct thread_info *tp, void *data)
175 struct delete_thread_of_inferior_arg *arg = data;
177 if (ptid_get_pid (tp->ptid) == arg->pid)
180 delete_thread_silent (tp->ptid);
182 delete_thread (tp->ptid);
188 /* If SILENT then be quiet -- don't announce a inferior death, or the
189 exit of its threads. */
192 delete_inferior_1 (struct inferior *todel, int silent)
194 struct inferior *inf, *infprev;
195 struct delete_thread_of_inferior_arg arg;
199 for (inf = inferior_list; inf; infprev = inf, inf = inf->next)
209 iterate_over_threads (delete_thread_of_inferior, &arg);
212 infprev->next = inf->next;
214 inferior_list = inf->next;
216 observer_notify_inferior_removed (inf);
222 delete_inferior (int pid)
224 struct inferior *inf = find_inferior_pid (pid);
226 delete_inferior_1 (inf, 0);
228 if (print_inferior_events)
229 printf_unfiltered (_("[Inferior %d exited]\n"), pid);
233 delete_inferior_silent (int pid)
235 struct inferior *inf = find_inferior_pid (pid);
237 delete_inferior_1 (inf, 1);
241 /* If SILENT then be quiet -- don't announce a inferior exit, or the
242 exit of its threads. */
245 exit_inferior_1 (struct inferior *inftoex, int silent)
247 struct inferior *inf;
248 struct delete_thread_of_inferior_arg arg;
250 for (inf = inferior_list; inf; inf = inf->next)
260 iterate_over_threads (delete_thread_of_inferior, &arg);
262 /* Notify the observers before removing the inferior from the list,
263 so that the observers have a chance to look it up. */
264 observer_notify_inferior_exit (inf);
268 if (inf->vfork_parent != NULL)
270 inf->vfork_parent->vfork_child = NULL;
271 inf->vfork_parent = NULL;
273 if (inf->vfork_child != NULL)
275 inf->vfork_child->vfork_parent = NULL;
276 inf->vfork_child = NULL;
279 inf->has_exit_code = 0;
281 inf->pending_detach = 0;
285 exit_inferior (int pid)
287 struct inferior *inf = find_inferior_pid (pid);
289 exit_inferior_1 (inf, 0);
291 if (print_inferior_events)
292 printf_unfiltered (_("[Inferior %d exited]\n"), pid);
296 exit_inferior_silent (int pid)
298 struct inferior *inf = find_inferior_pid (pid);
300 exit_inferior_1 (inf, 1);
304 exit_inferior_num_silent (int num)
306 struct inferior *inf = find_inferior_id (num);
308 exit_inferior_1 (inf, 1);
312 detach_inferior (int pid)
314 struct inferior *inf = find_inferior_pid (pid);
316 exit_inferior_1 (inf, 1);
318 if (print_inferior_events)
319 printf_unfiltered (_("[Inferior %d detached]\n"), pid);
323 inferior_appeared (struct inferior *inf, int pid)
327 observer_notify_inferior_appeared (inf);
331 discard_all_inferiors (void)
333 struct inferior *inf;
335 for (inf = inferior_list; inf; inf = inf->next)
338 exit_inferior_silent (inf->pid);
343 find_inferior_id (int num)
345 struct inferior *inf;
347 for (inf = inferior_list; inf; inf = inf->next)
355 find_inferior_pid (int pid)
357 struct inferior *inf;
359 /* Looking for inferior pid == 0 is always wrong, and indicative of
360 a bug somewhere else. There may be more than one with pid == 0,
362 gdb_assert (pid != 0);
364 for (inf = inferior_list; inf; inf = inf->next)
371 /* Find an inferior bound to PSPACE. */
374 find_inferior_for_program_space (struct program_space *pspace)
376 struct inferior *inf;
378 for (inf = inferior_list; inf != NULL; inf = inf->next)
380 if (inf->pspace == pspace)
388 iterate_over_inferiors (int (*callback) (struct inferior *, void *),
391 struct inferior *inf, *infnext;
393 for (inf = inferior_list; inf; inf = infnext)
396 if ((*callback) (inf, data))
404 valid_gdb_inferior_id (int num)
406 struct inferior *inf;
408 for (inf = inferior_list; inf; inf = inf->next)
416 pid_to_gdb_inferior_id (int pid)
418 struct inferior *inf;
420 for (inf = inferior_list; inf; inf = inf->next)
428 gdb_inferior_id_to_pid (int num)
430 struct inferior *inferior = find_inferior_id (num);
432 return inferior->pid;
438 in_inferior_list (int pid)
440 struct inferior *inf;
442 for (inf = inferior_list; inf; inf = inf->next)
450 have_inferiors (void)
452 struct inferior *inf;
454 for (inf = inferior_list; inf; inf = inf->next)
462 have_live_inferiors (void)
464 struct inferior *inf;
466 for (inf = inferior_list; inf; inf = inf->next)
469 struct thread_info *tp;
471 tp = any_thread_of_process (inf->pid);
472 if (tp && target_has_execution_1 (tp->ptid))
479 /* Prune away automatically added program spaces that aren't required
483 prune_inferiors (void)
485 struct inferior *ss, **ss_link;
486 struct inferior *current = current_inferior ();
489 ss_link = &inferior_list;
502 delete_inferior_1 (ss, 1);
506 prune_program_spaces ();
509 /* Simply returns the count of inferiors. */
512 number_of_inferiors (void)
514 struct inferior *inf;
517 for (inf = inferior_list; inf != NULL; inf = inf->next)
523 /* Converts an inferior process id to a string. Like
524 target_pid_to_str, but special cases the null process. */
527 inferior_pid_to_str (int pid)
530 return target_pid_to_str (pid_to_ptid (pid));
535 /* Prints the list of inferiors and their details on UIOUT. This is a
536 version of 'info_inferior_command' suitable for use from MI.
538 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
539 inferiors that should be printed. Otherwise, all inferiors are
543 print_inferior (struct ui_out *uiout, char *requested_inferiors)
545 struct inferior *inf;
546 struct cleanup *old_chain;
549 /* Compute number of inferiors we will print. */
550 for (inf = inferior_list; inf; inf = inf->next)
552 if (!number_is_in_list (requested_inferiors, inf->num))
560 ui_out_message (uiout, 0, "No inferiors.\n");
564 old_chain = make_cleanup_ui_out_table_begin_end (uiout, 4, inf_count,
566 ui_out_table_header (uiout, 1, ui_left, "current", "");
567 ui_out_table_header (uiout, 4, ui_left, "number", "Num");
568 ui_out_table_header (uiout, 17, ui_left, "target-id", "Description");
569 ui_out_table_header (uiout, 17, ui_left, "exec", "Executable");
571 ui_out_table_body (uiout);
572 for (inf = inferior_list; inf; inf = inf->next)
574 struct cleanup *chain2;
576 if (!number_is_in_list (requested_inferiors, inf->num))
579 chain2 = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
581 if (inf == current_inferior ())
582 ui_out_field_string (uiout, "current", "*");
584 ui_out_field_skip (uiout, "current");
586 ui_out_field_int (uiout, "number", inf->num);
588 ui_out_field_string (uiout, "target-id",
589 inferior_pid_to_str (inf->pid));
591 if (inf->pspace->ebfd)
592 ui_out_field_string (uiout, "exec",
593 bfd_get_filename (inf->pspace->ebfd));
595 ui_out_field_skip (uiout, "exec");
597 /* Print extra info that isn't really fit to always present in
598 tabular form. Currently we print the vfork parent/child
599 relationships, if any. */
600 if (inf->vfork_parent)
602 ui_out_text (uiout, _("\n\tis vfork child of inferior "));
603 ui_out_field_int (uiout, "vfork-parent", inf->vfork_parent->num);
605 if (inf->vfork_child)
607 ui_out_text (uiout, _("\n\tis vfork parent of inferior "));
608 ui_out_field_int (uiout, "vfork-child", inf->vfork_child->num);
611 ui_out_text (uiout, "\n");
612 do_cleanups (chain2);
615 do_cleanups (old_chain);
619 detach_inferior_command (char *args, int from_tty)
622 struct thread_info *tp;
623 struct get_number_or_range_state state;
626 error (_("Requires argument (inferior id(s) to detach)"));
628 init_number_or_range (&state, args);
629 while (!state.finished)
631 num = get_number_or_range (&state);
633 if (!valid_gdb_inferior_id (num))
635 warning (_("Inferior ID %d not known."), num);
639 pid = gdb_inferior_id_to_pid (num);
641 tp = any_thread_of_process (pid);
644 warning (_("Inferior ID %d has no threads."), num);
648 switch_to_thread (tp->ptid);
650 detach_command (NULL, from_tty);
655 kill_inferior_command (char *args, int from_tty)
658 struct thread_info *tp;
659 struct get_number_or_range_state state;
662 error (_("Requires argument (inferior id(s) to kill)"));
664 init_number_or_range (&state, args);
665 while (!state.finished)
667 num = get_number_or_range (&state);
669 if (!valid_gdb_inferior_id (num))
671 warning (_("Inferior ID %d not known."), num);
675 pid = gdb_inferior_id_to_pid (num);
677 tp = any_thread_of_process (pid);
680 warning (_("Inferior ID %d has no threads."), num);
684 switch_to_thread (tp->ptid);
689 bfd_cache_close_all ();
693 inferior_command (char *args, int from_tty)
695 struct inferior *inf;
698 num = parse_and_eval_long (args);
700 inf = find_inferior_id (num);
702 error (_("Inferior ID %d not known."), num);
704 printf_filtered (_("[Switching to inferior %d [%s] (%s)]\n"),
706 inferior_pid_to_str (inf->pid),
708 ? bfd_get_filename (inf->pspace->ebfd)
713 if (inf->pid != ptid_get_pid (inferior_ptid))
715 struct thread_info *tp;
717 tp = any_thread_of_process (inf->pid);
719 error (_("Inferior has no threads."));
721 switch_to_thread (tp->ptid);
724 printf_filtered (_("[Switching to thread %d (%s)] "),
725 pid_to_thread_id (inferior_ptid),
726 target_pid_to_str (inferior_ptid));
730 struct inferior *inf;
732 inf = find_inferior_id (num);
733 set_current_inferior (inf);
734 switch_to_thread (null_ptid);
735 set_current_program_space (inf->pspace);
738 if (inf->pid != 0 && is_running (inferior_ptid))
739 ui_out_text (current_uiout, "(running)\n");
740 else if (inf->pid != 0)
742 ui_out_text (current_uiout, "\n");
743 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
747 /* Print information about currently known inferiors. */
750 info_inferiors_command (char *args, int from_tty)
752 print_inferior (current_uiout, args);
755 /* remove-inferior ID */
758 remove_inferior_command (char *args, int from_tty)
761 struct inferior *inf;
762 struct get_number_or_range_state state;
764 if (args == NULL || *args == '\0')
765 error (_("Requires an argument (inferior id(s) to remove)"));
767 init_number_or_range (&state, args);
768 while (!state.finished)
770 num = get_number_or_range (&state);
771 inf = find_inferior_id (num);
775 warning (_("Inferior ID %d not known."), num);
779 if (inf == current_inferior ())
781 warning (_("Can not remove current symbol inferior %d."), num);
787 warning (_("Can not remove active inferior %d."), num);
791 delete_inferior_1 (inf, 1);
796 add_inferior_with_spaces (void)
798 struct address_space *aspace;
799 struct program_space *pspace;
800 struct inferior *inf;
801 struct gdbarch_info info;
803 /* If all inferiors share an address space on this system, this
804 doesn't really return a new address space; otherwise, it
806 aspace = maybe_new_address_space ();
807 pspace = add_program_space (aspace);
808 inf = add_inferior (0);
809 inf->pspace = pspace;
810 inf->aspace = pspace->aspace;
812 /* Setup the inferior's initial arch, based on information obtained
813 from the global "set ..." options. */
814 gdbarch_info_init (&info);
815 inf->gdbarch = gdbarch_find_by_info (info);
816 /* The "set ..." options reject invalid settings, so we should
817 always have a valid arch by now. */
818 gdb_assert (inf->gdbarch != NULL);
823 /* add-inferior [-copies N] [-exec FILENAME] */
826 add_inferior_command (char *args, int from_tty)
831 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
835 argv = gdb_buildargv (args);
836 make_cleanup_freeargv (argv);
838 for (; *argv != NULL; argv++)
842 if (strcmp (*argv, "-copies") == 0)
846 error (_("No argument to -copies"));
847 copies = parse_and_eval_long (*argv);
849 else if (strcmp (*argv, "-exec") == 0)
853 error (_("No argument to -exec"));
854 exec = tilde_expand (*argv);
855 make_cleanup (xfree, exec);
859 error (_("Invalid argument"));
863 save_current_space_and_thread ();
865 for (i = 0; i < copies; ++i)
867 struct inferior *inf = add_inferior_with_spaces ();
869 printf_filtered (_("Added inferior %d\n"), inf->num);
873 /* Switch over temporarily, while reading executable and
875 set_current_program_space (inf->pspace);
876 set_current_inferior (inf);
877 switch_to_thread (null_ptid);
879 exec_file_attach (exec, from_tty);
880 symbol_file_add_main (exec, from_tty);
884 do_cleanups (old_chain);
887 /* clone-inferior [-copies N] [ID] */
890 clone_inferior_command (char *args, int from_tty)
894 struct inferior *orginf = NULL;
895 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
899 argv = gdb_buildargv (args);
900 make_cleanup_freeargv (argv);
902 for (; *argv != NULL; argv++)
906 if (strcmp (*argv, "-copies") == 0)
910 error (_("No argument to -copies"));
911 copies = parse_and_eval_long (*argv);
914 error (_("Invalid copies number"));
923 /* The first non-option (-) argument specified the
925 num = parse_and_eval_long (*argv);
926 orginf = find_inferior_id (num);
929 error (_("Inferior ID %d not known."), num);
933 error (_("Invalid argument"));
938 /* If no inferior id was specified, then the user wants to clone the
941 orginf = current_inferior ();
943 save_current_space_and_thread ();
945 for (i = 0; i < copies; ++i)
947 struct address_space *aspace;
948 struct program_space *pspace;
949 struct inferior *inf;
951 /* If all inferiors share an address space on this system, this
952 doesn't really return a new address space; otherwise, it
954 aspace = maybe_new_address_space ();
955 pspace = add_program_space (aspace);
956 inf = add_inferior (0);
957 inf->pspace = pspace;
958 inf->aspace = pspace->aspace;
959 inf->gdbarch = orginf->gdbarch;
961 /* If the original inferior had a user specified target
962 description, make the clone use it too. */
963 if (target_desc_info_from_user_p (inf->tdesc_info))
964 copy_inferior_target_desc_info (inf, orginf);
966 printf_filtered (_("Added inferior %d.\n"), inf->num);
968 set_current_inferior (inf);
969 switch_to_thread (null_ptid);
970 clone_program_space (pspace, orginf->pspace);
973 do_cleanups (old_chain);
976 /* Print notices when new inferiors are created and die. */
978 show_print_inferior_events (struct ui_file *file, int from_tty,
979 struct cmd_list_element *c, const char *value)
981 fprintf_filtered (file, _("Printing of inferior events is %s.\n"), value);
987 initialize_inferiors (void)
989 struct cmd_list_element *c = NULL;
991 /* There's always one inferior. Note that this function isn't an
992 automatic _initialize_foo function, since other _initialize_foo
993 routines may need to install their per-inferior data keys. We
994 can only allocate an inferior when all those modules have done
995 that. Do this after initialize_progspace, due to the
996 current_program_space reference. */
997 current_inferior_ = add_inferior (0);
998 current_inferior_->pspace = current_program_space;
999 current_inferior_->aspace = current_program_space->aspace;
1000 /* The architecture will be initialized shortly, by
1001 initialize_current_architecture. */
1003 add_info ("inferiors", info_inferiors_command,
1004 _("IDs of specified inferiors (all inferiors if no argument)."));
1006 c = add_com ("add-inferior", no_class, add_inferior_command, _("\
1007 Add a new inferior.\n\
1008 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
1009 N is the optional number of inferiors to add, default is 1.\n\
1010 FILENAME is the file name of the executable to use\n\
1011 as main program."));
1012 set_cmd_completer (c, filename_completer);
1014 add_com ("remove-inferiors", no_class, remove_inferior_command, _("\
1015 Remove inferior ID (or list of IDs).\n\
1016 Usage: remove-inferiors ID..."));
1018 add_com ("clone-inferior", no_class, clone_inferior_command, _("\
1019 Clone inferior ID.\n\
1020 Usage: clone-inferior [-copies <N>] [ID]\n\
1021 Add N copies of inferior ID. The new inferior has the same\n\
1022 executable loaded as the copied inferior. If -copies is not specified,\n\
1023 adds 1 copy. If ID is not specified, it is the current inferior\n\
1026 add_cmd ("inferiors", class_run, detach_inferior_command, _("\
1027 Detach from inferior ID (or list of IDS)."),
1030 add_cmd ("inferiors", class_run, kill_inferior_command, _("\
1031 Kill inferior ID (or list of IDs)."),
1034 add_cmd ("inferior", class_run, inferior_command, _("\
1035 Use this command to switch between inferiors.\n\
1036 The new inferior ID must be currently known."),
1039 add_setshow_boolean_cmd ("inferior-events", no_class,
1040 &print_inferior_events, _("\
1041 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1042 Show printing of inferior events (e.g., inferior start and exit)."), NULL,
1044 show_print_inferior_events,
1045 &setprintlist, &showprintlist);