1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2016 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 = (struct 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 = XNEW (struct inferior);
132 memset (inf, 0, sizeof (*inf));
135 inf->control.stop_soon = NO_STOP_QUIETLY;
137 inf->num = ++highest_inferior_num;
139 if (inferior_list == NULL)
143 struct inferior *last;
145 for (last = inferior_list; last->next != NULL; last = last->next)
150 inf->environment = make_environ ();
151 init_environ (inf->environment);
153 inferior_alloc_data (inf);
155 observer_notify_inferior_added (inf);
158 inferior_appeared (inf, pid);
164 add_inferior (int pid)
166 struct inferior *inf = add_inferior_silent (pid);
168 if (print_inferior_events)
169 printf_unfiltered (_("[New inferior %d]\n"), pid);
174 struct delete_thread_of_inferior_arg
181 delete_thread_of_inferior (struct thread_info *tp, void *data)
183 struct delete_thread_of_inferior_arg *arg
184 = (struct delete_thread_of_inferior_arg *) data;
186 if (ptid_get_pid (tp->ptid) == arg->pid)
189 delete_thread_silent (tp->ptid);
191 delete_thread (tp->ptid);
198 delete_inferior (struct inferior *todel)
200 struct inferior *inf, *infprev;
201 struct delete_thread_of_inferior_arg arg;
205 for (inf = inferior_list; inf; infprev = inf, inf = inf->next)
215 iterate_over_threads (delete_thread_of_inferior, &arg);
218 infprev->next = inf->next;
220 inferior_list = inf->next;
222 observer_notify_inferior_removed (inf);
224 /* If this program space is rendered useless, remove it. */
225 if (program_space_empty_p (inf->pspace))
226 delete_program_space (inf->pspace);
231 /* If SILENT then be quiet -- don't announce a inferior exit, or the
232 exit of its threads. */
235 exit_inferior_1 (struct inferior *inftoex, int silent)
237 struct inferior *inf;
238 struct delete_thread_of_inferior_arg arg;
240 for (inf = inferior_list; inf; inf = inf->next)
250 iterate_over_threads (delete_thread_of_inferior, &arg);
252 /* Notify the observers before removing the inferior from the list,
253 so that the observers have a chance to look it up. */
254 observer_notify_inferior_exit (inf);
258 if (inf->vfork_parent != NULL)
260 inf->vfork_parent->vfork_child = NULL;
261 inf->vfork_parent = NULL;
263 if (inf->vfork_child != NULL)
265 inf->vfork_child->vfork_parent = NULL;
266 inf->vfork_child = NULL;
269 inf->pending_detach = 0;
273 exit_inferior (int pid)
275 struct inferior *inf = find_inferior_pid (pid);
277 exit_inferior_1 (inf, 0);
279 if (print_inferior_events)
280 printf_unfiltered (_("[Inferior %d exited]\n"), pid);
284 exit_inferior_silent (int pid)
286 struct inferior *inf = find_inferior_pid (pid);
288 exit_inferior_1 (inf, 1);
292 exit_inferior_num_silent (int num)
294 struct inferior *inf = find_inferior_id (num);
296 exit_inferior_1 (inf, 1);
300 detach_inferior (int pid)
302 struct inferior *inf = find_inferior_pid (pid);
304 exit_inferior_1 (inf, 0);
306 if (print_inferior_events)
307 printf_unfiltered (_("[Inferior %d detached]\n"), pid);
311 inferior_appeared (struct inferior *inf, int pid)
314 inf->has_exit_code = 0;
317 observer_notify_inferior_appeared (inf);
321 discard_all_inferiors (void)
323 struct inferior *inf;
325 for (inf = inferior_list; inf; inf = inf->next)
328 exit_inferior_silent (inf->pid);
333 find_inferior_id (int num)
335 struct inferior *inf;
337 for (inf = inferior_list; inf; inf = inf->next)
345 find_inferior_pid (int pid)
347 struct inferior *inf;
349 /* Looking for inferior pid == 0 is always wrong, and indicative of
350 a bug somewhere else. There may be more than one with pid == 0,
352 gdb_assert (pid != 0);
354 for (inf = inferior_list; inf; inf = inf->next)
364 find_inferior_ptid (ptid_t ptid)
366 return find_inferior_pid (ptid_get_pid (ptid));
369 /* See inferior.h. */
372 find_inferior_for_program_space (struct program_space *pspace)
374 struct inferior *inf = current_inferior ();
376 if (inf->pspace == pspace)
379 for (inf = inferior_list; inf != NULL; inf = inf->next)
381 if (inf->pspace == pspace)
389 iterate_over_inferiors (int (*callback) (struct inferior *, void *),
392 struct inferior *inf, *infnext;
394 for (inf = inferior_list; inf; inf = infnext)
397 if ((*callback) (inf, data))
405 valid_gdb_inferior_id (int num)
407 struct inferior *inf;
409 for (inf = inferior_list; inf; inf = inf->next)
417 pid_to_gdb_inferior_id (int pid)
419 struct inferior *inf;
421 for (inf = inferior_list; inf; inf = inf->next)
429 gdb_inferior_id_to_pid (int num)
431 struct inferior *inferior = find_inferior_id (num);
433 return inferior->pid;
439 in_inferior_list (int pid)
441 struct inferior *inf;
443 for (inf = inferior_list; inf; inf = inf->next)
451 have_inferiors (void)
453 struct inferior *inf;
455 for (inf = inferior_list; inf; inf = inf->next)
462 /* Return the number of live inferiors. We account for the case
463 where an inferior might have a non-zero pid but no threads, as
464 in the middle of a 'mourn' operation. */
467 number_of_live_inferiors (void)
469 struct inferior *inf;
472 for (inf = inferior_list; inf; inf = inf->next)
475 struct thread_info *tp;
477 ALL_NON_EXITED_THREADS (tp)
478 if (tp && ptid_get_pid (tp->ptid) == inf->pid)
479 if (target_has_execution_1 (tp->ptid))
481 /* Found a live thread in this inferior, go to the next
491 /* Return true if there is at least one live inferior. */
494 have_live_inferiors (void)
496 return number_of_live_inferiors () > 0;
499 /* Prune away any unused inferiors, and then prune away no longer used
503 prune_inferiors (void)
505 struct inferior *ss, **ss_link;
506 struct inferior *current = current_inferior ();
509 ss_link = &inferior_list;
522 delete_inferior (ss);
527 /* Simply returns the count of inferiors. */
530 number_of_inferiors (void)
532 struct inferior *inf;
535 for (inf = inferior_list; inf != NULL; inf = inf->next)
541 /* Converts an inferior process id to a string. Like
542 target_pid_to_str, but special cases the null process. */
545 inferior_pid_to_str (int pid)
548 return target_pid_to_str (pid_to_ptid (pid));
553 /* Prints the list of inferiors and their details on UIOUT. This is a
554 version of 'info_inferior_command' suitable for use from MI.
556 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
557 inferiors that should be printed. Otherwise, all inferiors are
561 print_inferior (struct ui_out *uiout, char *requested_inferiors)
563 struct inferior *inf;
564 struct cleanup *old_chain;
567 /* Compute number of inferiors we will print. */
568 for (inf = inferior_list; inf; inf = inf->next)
570 if (!number_is_in_list (requested_inferiors, inf->num))
578 ui_out_message (uiout, 0, "No inferiors.\n");
582 old_chain = make_cleanup_ui_out_table_begin_end (uiout, 4, inf_count,
584 ui_out_table_header (uiout, 1, ui_left, "current", "");
585 ui_out_table_header (uiout, 4, ui_left, "number", "Num");
586 ui_out_table_header (uiout, 17, ui_left, "target-id", "Description");
587 ui_out_table_header (uiout, 17, ui_left, "exec", "Executable");
589 ui_out_table_body (uiout);
590 for (inf = inferior_list; inf; inf = inf->next)
592 struct cleanup *chain2;
594 if (!number_is_in_list (requested_inferiors, inf->num))
597 chain2 = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
599 if (inf == current_inferior ())
600 ui_out_field_string (uiout, "current", "*");
602 ui_out_field_skip (uiout, "current");
604 ui_out_field_int (uiout, "number", inf->num);
606 ui_out_field_string (uiout, "target-id",
607 inferior_pid_to_str (inf->pid));
609 if (inf->pspace->pspace_exec_filename != NULL)
610 ui_out_field_string (uiout, "exec", inf->pspace->pspace_exec_filename);
612 ui_out_field_skip (uiout, "exec");
614 /* Print extra info that isn't really fit to always present in
615 tabular form. Currently we print the vfork parent/child
616 relationships, if any. */
617 if (inf->vfork_parent)
619 ui_out_text (uiout, _("\n\tis vfork child of inferior "));
620 ui_out_field_int (uiout, "vfork-parent", inf->vfork_parent->num);
622 if (inf->vfork_child)
624 ui_out_text (uiout, _("\n\tis vfork parent of inferior "));
625 ui_out_field_int (uiout, "vfork-child", inf->vfork_child->num);
628 ui_out_text (uiout, "\n");
629 do_cleanups (chain2);
632 do_cleanups (old_chain);
636 detach_inferior_command (char *args, int from_tty)
639 struct thread_info *tp;
640 struct get_number_or_range_state state;
643 error (_("Requires argument (inferior id(s) to detach)"));
645 init_number_or_range (&state, args);
646 while (!state.finished)
648 num = get_number_or_range (&state);
650 if (!valid_gdb_inferior_id (num))
652 warning (_("Inferior ID %d not known."), num);
656 pid = gdb_inferior_id_to_pid (num);
659 warning (_("Inferior ID %d is not running."), num);
663 tp = any_thread_of_process (pid);
666 warning (_("Inferior ID %d has no threads."), num);
670 switch_to_thread (tp->ptid);
672 detach_command (NULL, from_tty);
677 kill_inferior_command (char *args, int from_tty)
680 struct thread_info *tp;
681 struct get_number_or_range_state state;
684 error (_("Requires argument (inferior id(s) to kill)"));
686 init_number_or_range (&state, args);
687 while (!state.finished)
689 num = get_number_or_range (&state);
691 if (!valid_gdb_inferior_id (num))
693 warning (_("Inferior ID %d not known."), num);
697 pid = gdb_inferior_id_to_pid (num);
700 warning (_("Inferior ID %d is not running."), num);
704 tp = any_thread_of_process (pid);
707 warning (_("Inferior ID %d has no threads."), num);
711 switch_to_thread (tp->ptid);
716 bfd_cache_close_all ();
720 inferior_command (char *args, int from_tty)
722 struct inferior *inf;
725 num = parse_and_eval_long (args);
727 inf = find_inferior_id (num);
729 error (_("Inferior ID %d not known."), num);
731 printf_filtered (_("[Switching to inferior %d [%s] (%s)]\n"),
733 inferior_pid_to_str (inf->pid),
734 (inf->pspace->pspace_exec_filename != NULL
735 ? inf->pspace->pspace_exec_filename
740 if (inf->pid != ptid_get_pid (inferior_ptid))
742 struct thread_info *tp;
744 tp = any_thread_of_process (inf->pid);
746 error (_("Inferior has no threads."));
748 switch_to_thread (tp->ptid);
751 printf_filtered (_("[Switching to thread %s (%s)] "),
752 print_thread_id (inferior_thread ()),
753 target_pid_to_str (inferior_ptid));
757 struct inferior *inf;
759 inf = find_inferior_id (num);
760 set_current_inferior (inf);
761 switch_to_thread (null_ptid);
762 set_current_program_space (inf->pspace);
765 if (inf->pid != 0 && is_running (inferior_ptid))
766 ui_out_text (current_uiout, "(running)\n");
767 else if (inf->pid != 0)
769 ui_out_text (current_uiout, "\n");
770 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC, 1);
774 /* Print information about currently known inferiors. */
777 info_inferiors_command (char *args, int from_tty)
779 print_inferior (current_uiout, args);
782 /* remove-inferior ID */
785 remove_inferior_command (char *args, int from_tty)
788 struct inferior *inf;
789 struct get_number_or_range_state state;
791 if (args == NULL || *args == '\0')
792 error (_("Requires an argument (inferior id(s) to remove)"));
794 init_number_or_range (&state, args);
795 while (!state.finished)
797 num = get_number_or_range (&state);
798 inf = find_inferior_id (num);
802 warning (_("Inferior ID %d not known."), num);
806 if (inf == current_inferior ())
808 warning (_("Can not remove current symbol inferior %d."), num);
814 warning (_("Can not remove active inferior %d."), num);
818 delete_inferior (inf);
823 add_inferior_with_spaces (void)
825 struct address_space *aspace;
826 struct program_space *pspace;
827 struct inferior *inf;
828 struct gdbarch_info info;
830 /* If all inferiors share an address space on this system, this
831 doesn't really return a new address space; otherwise, it
833 aspace = maybe_new_address_space ();
834 pspace = add_program_space (aspace);
835 inf = add_inferior (0);
836 inf->pspace = pspace;
837 inf->aspace = pspace->aspace;
839 /* Setup the inferior's initial arch, based on information obtained
840 from the global "set ..." options. */
841 gdbarch_info_init (&info);
842 inf->gdbarch = gdbarch_find_by_info (info);
843 /* The "set ..." options reject invalid settings, so we should
844 always have a valid arch by now. */
845 gdb_assert (inf->gdbarch != NULL);
850 /* add-inferior [-copies N] [-exec FILENAME] */
853 add_inferior_command (char *args, int from_tty)
858 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
862 argv = gdb_buildargv (args);
863 make_cleanup_freeargv (argv);
865 for (; *argv != NULL; argv++)
869 if (strcmp (*argv, "-copies") == 0)
873 error (_("No argument to -copies"));
874 copies = parse_and_eval_long (*argv);
876 else if (strcmp (*argv, "-exec") == 0)
880 error (_("No argument to -exec"));
881 exec = tilde_expand (*argv);
882 make_cleanup (xfree, exec);
886 error (_("Invalid argument"));
890 save_current_space_and_thread ();
892 for (i = 0; i < copies; ++i)
894 struct inferior *inf = add_inferior_with_spaces ();
896 printf_filtered (_("Added inferior %d\n"), inf->num);
900 /* Switch over temporarily, while reading executable and
902 set_current_program_space (inf->pspace);
903 set_current_inferior (inf);
904 switch_to_thread (null_ptid);
906 exec_file_attach (exec, from_tty);
907 symbol_file_add_main (exec, from_tty);
911 do_cleanups (old_chain);
914 /* clone-inferior [-copies N] [ID] */
917 clone_inferior_command (char *args, int from_tty)
921 struct inferior *orginf = NULL;
922 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
926 argv = gdb_buildargv (args);
927 make_cleanup_freeargv (argv);
929 for (; *argv != NULL; argv++)
933 if (strcmp (*argv, "-copies") == 0)
937 error (_("No argument to -copies"));
938 copies = parse_and_eval_long (*argv);
941 error (_("Invalid copies number"));
950 /* The first non-option (-) argument specified the
952 num = parse_and_eval_long (*argv);
953 orginf = find_inferior_id (num);
956 error (_("Inferior ID %d not known."), num);
960 error (_("Invalid argument"));
965 /* If no inferior id was specified, then the user wants to clone the
968 orginf = current_inferior ();
970 save_current_space_and_thread ();
972 for (i = 0; i < copies; ++i)
974 struct address_space *aspace;
975 struct program_space *pspace;
976 struct inferior *inf;
978 /* If all inferiors share an address space on this system, this
979 doesn't really return a new address space; otherwise, it
981 aspace = maybe_new_address_space ();
982 pspace = add_program_space (aspace);
983 inf = add_inferior (0);
984 inf->pspace = pspace;
985 inf->aspace = pspace->aspace;
986 inf->gdbarch = orginf->gdbarch;
988 /* If the original inferior had a user specified target
989 description, make the clone use it too. */
990 if (target_desc_info_from_user_p (inf->tdesc_info))
991 copy_inferior_target_desc_info (inf, orginf);
993 printf_filtered (_("Added inferior %d.\n"), inf->num);
995 set_current_inferior (inf);
996 switch_to_thread (null_ptid);
997 clone_program_space (pspace, orginf->pspace);
1000 do_cleanups (old_chain);
1003 /* Print notices when new inferiors are created and die. */
1005 show_print_inferior_events (struct ui_file *file, int from_tty,
1006 struct cmd_list_element *c, const char *value)
1008 fprintf_filtered (file, _("Printing of inferior events is %s.\n"), value);
1011 /* Return a new value for the selected inferior's id. */
1013 static struct value *
1014 inferior_id_make_value (struct gdbarch *gdbarch, struct internalvar *var,
1017 struct inferior *inf = current_inferior ();
1019 return value_from_longest (builtin_type (gdbarch)->builtin_int, inf->num);
1022 /* Implementation of `$_inferior' variable. */
1024 static const struct internalvar_funcs inferior_funcs =
1026 inferior_id_make_value,
1034 initialize_inferiors (void)
1036 struct cmd_list_element *c = NULL;
1038 /* There's always one inferior. Note that this function isn't an
1039 automatic _initialize_foo function, since other _initialize_foo
1040 routines may need to install their per-inferior data keys. We
1041 can only allocate an inferior when all those modules have done
1042 that. Do this after initialize_progspace, due to the
1043 current_program_space reference. */
1044 current_inferior_ = add_inferior (0);
1045 current_inferior_->pspace = current_program_space;
1046 current_inferior_->aspace = current_program_space->aspace;
1047 /* The architecture will be initialized shortly, by
1048 initialize_current_architecture. */
1050 add_info ("inferiors", info_inferiors_command,
1051 _("IDs of specified inferiors (all inferiors if no argument)."));
1053 c = add_com ("add-inferior", no_class, add_inferior_command, _("\
1054 Add a new inferior.\n\
1055 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
1056 N is the optional number of inferiors to add, default is 1.\n\
1057 FILENAME is the file name of the executable to use\n\
1058 as main program."));
1059 set_cmd_completer (c, filename_completer);
1061 add_com ("remove-inferiors", no_class, remove_inferior_command, _("\
1062 Remove inferior ID (or list of IDs).\n\
1063 Usage: remove-inferiors ID..."));
1065 add_com ("clone-inferior", no_class, clone_inferior_command, _("\
1066 Clone inferior ID.\n\
1067 Usage: clone-inferior [-copies <N>] [ID]\n\
1068 Add N copies of inferior ID. The new inferior has the same\n\
1069 executable loaded as the copied inferior. If -copies is not specified,\n\
1070 adds 1 copy. If ID is not specified, it is the current inferior\n\
1073 add_cmd ("inferiors", class_run, detach_inferior_command, _("\
1074 Detach from inferior ID (or list of IDS)."),
1077 add_cmd ("inferiors", class_run, kill_inferior_command, _("\
1078 Kill inferior ID (or list of IDs)."),
1081 add_cmd ("inferior", class_run, inferior_command, _("\
1082 Use this command to switch between inferiors.\n\
1083 The new inferior ID must be currently known."),
1086 add_setshow_boolean_cmd ("inferior-events", no_class,
1087 &print_inferior_events, _("\
1088 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1089 Show printing of inferior events (e.g., inferior start and exit)."), NULL,
1091 show_print_inferior_events,
1092 &setprintlist, &showprintlist);
1094 create_internalvar_type_lazy ("_inferior", &inferior_funcs, NULL);