1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2014 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);
104 xfree (inf->private);
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, 1);
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 gdb_assert (pid != 0);
363 for (inf = inferior_list; inf; inf = inf->next)
373 find_inferior_ptid (ptid_t ptid)
375 return find_inferior_pid (ptid_get_pid (ptid));
378 /* See inferior.h. */
381 find_inferior_for_program_space (struct program_space *pspace)
383 struct inferior *inf = current_inferior ();
385 if (inf->pspace == pspace)
388 for (inf = inferior_list; inf != NULL; inf = inf->next)
390 if (inf->pspace == pspace)
398 iterate_over_inferiors (int (*callback) (struct inferior *, void *),
401 struct inferior *inf, *infnext;
403 for (inf = inferior_list; inf; inf = infnext)
406 if ((*callback) (inf, data))
414 valid_gdb_inferior_id (int num)
416 struct inferior *inf;
418 for (inf = inferior_list; inf; inf = inf->next)
426 pid_to_gdb_inferior_id (int pid)
428 struct inferior *inf;
430 for (inf = inferior_list; inf; inf = inf->next)
438 gdb_inferior_id_to_pid (int num)
440 struct inferior *inferior = find_inferior_id (num);
442 return inferior->pid;
448 in_inferior_list (int pid)
450 struct inferior *inf;
452 for (inf = inferior_list; inf; inf = inf->next)
460 have_inferiors (void)
462 struct inferior *inf;
464 for (inf = inferior_list; inf; inf = inf->next)
472 have_live_inferiors (void)
474 struct inferior *inf;
476 for (inf = inferior_list; inf; inf = inf->next)
479 struct thread_info *tp;
481 tp = any_thread_of_process (inf->pid);
482 if (tp && target_has_execution_1 (tp->ptid))
489 /* Prune away any unused inferiors, and then prune away no longer used
493 prune_inferiors (void)
495 struct inferior *ss, **ss_link;
496 struct inferior *current = current_inferior ();
499 ss_link = &inferior_list;
512 delete_inferior_1 (ss, 1);
516 prune_program_spaces ();
519 /* Simply returns the count of inferiors. */
522 number_of_inferiors (void)
524 struct inferior *inf;
527 for (inf = inferior_list; inf != NULL; inf = inf->next)
533 /* Converts an inferior process id to a string. Like
534 target_pid_to_str, but special cases the null process. */
537 inferior_pid_to_str (int pid)
540 return target_pid_to_str (pid_to_ptid (pid));
545 /* Prints the list of inferiors and their details on UIOUT. This is a
546 version of 'info_inferior_command' suitable for use from MI.
548 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
549 inferiors that should be printed. Otherwise, all inferiors are
553 print_inferior (struct ui_out *uiout, char *requested_inferiors)
555 struct inferior *inf;
556 struct cleanup *old_chain;
559 /* Compute number of inferiors we will print. */
560 for (inf = inferior_list; inf; inf = inf->next)
562 if (!number_is_in_list (requested_inferiors, inf->num))
570 ui_out_message (uiout, 0, "No inferiors.\n");
574 old_chain = make_cleanup_ui_out_table_begin_end (uiout, 4, inf_count,
576 ui_out_table_header (uiout, 1, ui_left, "current", "");
577 ui_out_table_header (uiout, 4, ui_left, "number", "Num");
578 ui_out_table_header (uiout, 17, ui_left, "target-id", "Description");
579 ui_out_table_header (uiout, 17, ui_left, "exec", "Executable");
581 ui_out_table_body (uiout);
582 for (inf = inferior_list; inf; inf = inf->next)
584 struct cleanup *chain2;
586 if (!number_is_in_list (requested_inferiors, inf->num))
589 chain2 = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
591 if (inf == current_inferior ())
592 ui_out_field_string (uiout, "current", "*");
594 ui_out_field_skip (uiout, "current");
596 ui_out_field_int (uiout, "number", inf->num);
598 ui_out_field_string (uiout, "target-id",
599 inferior_pid_to_str (inf->pid));
601 if (inf->pspace->pspace_exec_filename != NULL)
602 ui_out_field_string (uiout, "exec", inf->pspace->pspace_exec_filename);
604 ui_out_field_skip (uiout, "exec");
606 /* Print extra info that isn't really fit to always present in
607 tabular form. Currently we print the vfork parent/child
608 relationships, if any. */
609 if (inf->vfork_parent)
611 ui_out_text (uiout, _("\n\tis vfork child of inferior "));
612 ui_out_field_int (uiout, "vfork-parent", inf->vfork_parent->num);
614 if (inf->vfork_child)
616 ui_out_text (uiout, _("\n\tis vfork parent of inferior "));
617 ui_out_field_int (uiout, "vfork-child", inf->vfork_child->num);
620 ui_out_text (uiout, "\n");
621 do_cleanups (chain2);
624 do_cleanups (old_chain);
628 detach_inferior_command (char *args, int from_tty)
631 struct thread_info *tp;
632 struct get_number_or_range_state state;
635 error (_("Requires argument (inferior id(s) to detach)"));
637 init_number_or_range (&state, args);
638 while (!state.finished)
640 num = get_number_or_range (&state);
642 if (!valid_gdb_inferior_id (num))
644 warning (_("Inferior ID %d not known."), num);
648 pid = gdb_inferior_id_to_pid (num);
650 tp = any_thread_of_process (pid);
653 warning (_("Inferior ID %d has no threads."), num);
657 switch_to_thread (tp->ptid);
659 detach_command (NULL, from_tty);
664 kill_inferior_command (char *args, int from_tty)
667 struct thread_info *tp;
668 struct get_number_or_range_state state;
671 error (_("Requires argument (inferior id(s) to kill)"));
673 init_number_or_range (&state, args);
674 while (!state.finished)
676 num = get_number_or_range (&state);
678 if (!valid_gdb_inferior_id (num))
680 warning (_("Inferior ID %d not known."), num);
684 pid = gdb_inferior_id_to_pid (num);
686 tp = any_thread_of_process (pid);
689 warning (_("Inferior ID %d has no threads."), num);
693 switch_to_thread (tp->ptid);
698 bfd_cache_close_all ();
702 inferior_command (char *args, int from_tty)
704 struct inferior *inf;
707 num = parse_and_eval_long (args);
709 inf = find_inferior_id (num);
711 error (_("Inferior ID %d not known."), num);
713 printf_filtered (_("[Switching to inferior %d [%s] (%s)]\n"),
715 inferior_pid_to_str (inf->pid),
716 (inf->pspace->pspace_exec_filename != NULL
717 ? inf->pspace->pspace_exec_filename
722 if (inf->pid != ptid_get_pid (inferior_ptid))
724 struct thread_info *tp;
726 tp = any_thread_of_process (inf->pid);
728 error (_("Inferior has no threads."));
730 switch_to_thread (tp->ptid);
733 printf_filtered (_("[Switching to thread %d (%s)] "),
734 pid_to_thread_id (inferior_ptid),
735 target_pid_to_str (inferior_ptid));
739 struct inferior *inf;
741 inf = find_inferior_id (num);
742 set_current_inferior (inf);
743 switch_to_thread (null_ptid);
744 set_current_program_space (inf->pspace);
747 if (inf->pid != 0 && is_running (inferior_ptid))
748 ui_out_text (current_uiout, "(running)\n");
749 else if (inf->pid != 0)
751 ui_out_text (current_uiout, "\n");
752 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC, 1);
756 /* Print information about currently known inferiors. */
759 info_inferiors_command (char *args, int from_tty)
761 print_inferior (current_uiout, args);
764 /* remove-inferior ID */
767 remove_inferior_command (char *args, int from_tty)
770 struct inferior *inf;
771 struct get_number_or_range_state state;
773 if (args == NULL || *args == '\0')
774 error (_("Requires an argument (inferior id(s) to remove)"));
776 init_number_or_range (&state, args);
777 while (!state.finished)
779 num = get_number_or_range (&state);
780 inf = find_inferior_id (num);
784 warning (_("Inferior ID %d not known."), num);
788 if (inf == current_inferior ())
790 warning (_("Can not remove current symbol inferior %d."), num);
796 warning (_("Can not remove active inferior %d."), num);
800 delete_inferior_1 (inf, 1);
803 prune_program_spaces ();
807 add_inferior_with_spaces (void)
809 struct address_space *aspace;
810 struct program_space *pspace;
811 struct inferior *inf;
812 struct gdbarch_info info;
814 /* If all inferiors share an address space on this system, this
815 doesn't really return a new address space; otherwise, it
817 aspace = maybe_new_address_space ();
818 pspace = add_program_space (aspace);
819 inf = add_inferior (0);
820 inf->pspace = pspace;
821 inf->aspace = pspace->aspace;
823 /* Setup the inferior's initial arch, based on information obtained
824 from the global "set ..." options. */
825 gdbarch_info_init (&info);
826 inf->gdbarch = gdbarch_find_by_info (info);
827 /* The "set ..." options reject invalid settings, so we should
828 always have a valid arch by now. */
829 gdb_assert (inf->gdbarch != NULL);
834 /* add-inferior [-copies N] [-exec FILENAME] */
837 add_inferior_command (char *args, int from_tty)
842 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
846 argv = gdb_buildargv (args);
847 make_cleanup_freeargv (argv);
849 for (; *argv != NULL; argv++)
853 if (strcmp (*argv, "-copies") == 0)
857 error (_("No argument to -copies"));
858 copies = parse_and_eval_long (*argv);
860 else if (strcmp (*argv, "-exec") == 0)
864 error (_("No argument to -exec"));
865 exec = tilde_expand (*argv);
866 make_cleanup (xfree, exec);
870 error (_("Invalid argument"));
874 save_current_space_and_thread ();
876 for (i = 0; i < copies; ++i)
878 struct inferior *inf = add_inferior_with_spaces ();
880 printf_filtered (_("Added inferior %d\n"), inf->num);
884 /* Switch over temporarily, while reading executable and
886 set_current_program_space (inf->pspace);
887 set_current_inferior (inf);
888 switch_to_thread (null_ptid);
890 exec_file_attach (exec, from_tty);
891 symbol_file_add_main (exec, from_tty);
895 do_cleanups (old_chain);
898 /* clone-inferior [-copies N] [ID] */
901 clone_inferior_command (char *args, int from_tty)
905 struct inferior *orginf = NULL;
906 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
910 argv = gdb_buildargv (args);
911 make_cleanup_freeargv (argv);
913 for (; *argv != NULL; argv++)
917 if (strcmp (*argv, "-copies") == 0)
921 error (_("No argument to -copies"));
922 copies = parse_and_eval_long (*argv);
925 error (_("Invalid copies number"));
934 /* The first non-option (-) argument specified the
936 num = parse_and_eval_long (*argv);
937 orginf = find_inferior_id (num);
940 error (_("Inferior ID %d not known."), num);
944 error (_("Invalid argument"));
949 /* If no inferior id was specified, then the user wants to clone the
952 orginf = current_inferior ();
954 save_current_space_and_thread ();
956 for (i = 0; i < copies; ++i)
958 struct address_space *aspace;
959 struct program_space *pspace;
960 struct inferior *inf;
962 /* If all inferiors share an address space on this system, this
963 doesn't really return a new address space; otherwise, it
965 aspace = maybe_new_address_space ();
966 pspace = add_program_space (aspace);
967 inf = add_inferior (0);
968 inf->pspace = pspace;
969 inf->aspace = pspace->aspace;
970 inf->gdbarch = orginf->gdbarch;
972 /* If the original inferior had a user specified target
973 description, make the clone use it too. */
974 if (target_desc_info_from_user_p (inf->tdesc_info))
975 copy_inferior_target_desc_info (inf, orginf);
977 printf_filtered (_("Added inferior %d.\n"), inf->num);
979 set_current_inferior (inf);
980 switch_to_thread (null_ptid);
981 clone_program_space (pspace, orginf->pspace);
984 do_cleanups (old_chain);
987 /* Print notices when new inferiors are created and die. */
989 show_print_inferior_events (struct ui_file *file, int from_tty,
990 struct cmd_list_element *c, const char *value)
992 fprintf_filtered (file, _("Printing of inferior events is %s.\n"), value);
998 initialize_inferiors (void)
1000 struct cmd_list_element *c = NULL;
1002 /* There's always one inferior. Note that this function isn't an
1003 automatic _initialize_foo function, since other _initialize_foo
1004 routines may need to install their per-inferior data keys. We
1005 can only allocate an inferior when all those modules have done
1006 that. Do this after initialize_progspace, due to the
1007 current_program_space reference. */
1008 current_inferior_ = add_inferior (0);
1009 current_inferior_->pspace = current_program_space;
1010 current_inferior_->aspace = current_program_space->aspace;
1011 /* The architecture will be initialized shortly, by
1012 initialize_current_architecture. */
1014 add_info ("inferiors", info_inferiors_command,
1015 _("IDs of specified inferiors (all inferiors if no argument)."));
1017 c = add_com ("add-inferior", no_class, add_inferior_command, _("\
1018 Add a new inferior.\n\
1019 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
1020 N is the optional number of inferiors to add, default is 1.\n\
1021 FILENAME is the file name of the executable to use\n\
1022 as main program."));
1023 set_cmd_completer (c, filename_completer);
1025 add_com ("remove-inferiors", no_class, remove_inferior_command, _("\
1026 Remove inferior ID (or list of IDs).\n\
1027 Usage: remove-inferiors ID..."));
1029 add_com ("clone-inferior", no_class, clone_inferior_command, _("\
1030 Clone inferior ID.\n\
1031 Usage: clone-inferior [-copies <N>] [ID]\n\
1032 Add N copies of inferior ID. The new inferior has the same\n\
1033 executable loaded as the copied inferior. If -copies is not specified,\n\
1034 adds 1 copy. If ID is not specified, it is the current inferior\n\
1037 add_cmd ("inferiors", class_run, detach_inferior_command, _("\
1038 Detach from inferior ID (or list of IDS)."),
1041 add_cmd ("inferiors", class_run, kill_inferior_command, _("\
1042 Kill inferior ID (or list of IDs)."),
1045 add_cmd ("inferior", class_run, inferior_command, _("\
1046 Use this command to switch between inferiors.\n\
1047 The new inferior ID must be currently known."),
1050 add_setshow_boolean_cmd ("inferior-events", no_class,
1051 &print_inferior_events, _("\
1052 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1053 Show printing of inferior events (e.g., inferior start and exit)."), NULL,
1055 show_print_inferior_events,
1056 &setprintlist, &showprintlist);