1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2012 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/>. */
26 #include "gdbthread.h"
29 #include "gdbthread.h"
33 #include "cli/cli-utils.h"
34 #include "continuations.h"
36 void _initialize_inferiors (void);
38 static void inferior_alloc_data (struct inferior *inf);
39 static void inferior_free_data (struct inferior *inf);
41 struct inferior *inferior_list = NULL;
42 static int highest_inferior_num;
44 /* Print notices on inferior events (attach, detach, etc.), set with
45 `set print inferior-events'. */
46 static int print_inferior_events = 0;
48 /* The Current Inferior. */
49 static struct inferior *current_inferior_ = NULL;
52 current_inferior (void)
54 return current_inferior_;
58 set_current_inferior (struct inferior *inf)
60 /* There's always an inferior. */
61 gdb_assert (inf != NULL);
63 current_inferior_ = inf;
66 /* A cleanups callback, helper for save_current_program_space
70 restore_inferior (void *arg)
72 struct inferior *saved_inferior = arg;
74 set_current_inferior (saved_inferior);
77 /* Save the current program space so that it may be restored by a later
78 call to do_cleanups. Returns the struct cleanup pointer needed for
79 later doing the cleanup. */
82 save_current_inferior (void)
84 struct cleanup *old_chain = make_cleanup (restore_inferior,
91 free_inferior (struct inferior *inf)
93 discard_all_inferior_continuations (inf);
94 inferior_free_data (inf);
96 xfree (inf->terminal);
97 free_environ (inf->environment);
103 init_inferior_list (void)
105 struct inferior *inf, *infnext;
107 highest_inferior_num = 0;
111 for (inf = inferior_list; inf; inf = infnext)
117 inferior_list = NULL;
121 add_inferior_silent (int pid)
123 struct inferior *inf;
125 inf = xmalloc (sizeof (*inf));
126 memset (inf, 0, sizeof (*inf));
129 inf->control.stop_soon = NO_STOP_QUIETLY;
131 inf->num = ++highest_inferior_num;
132 inf->next = inferior_list;
135 inf->environment = make_environ ();
136 init_environ (inf->environment);
138 inferior_alloc_data (inf);
140 observer_notify_inferior_added (inf);
143 inferior_appeared (inf, pid);
149 add_inferior (int pid)
151 struct inferior *inf = add_inferior_silent (pid);
153 if (print_inferior_events)
154 printf_unfiltered (_("[New inferior %d]\n"), pid);
159 struct delete_thread_of_inferior_arg
166 delete_thread_of_inferior (struct thread_info *tp, void *data)
168 struct delete_thread_of_inferior_arg *arg = data;
170 if (ptid_get_pid (tp->ptid) == arg->pid)
173 delete_thread_silent (tp->ptid);
175 delete_thread (tp->ptid);
182 delete_threads_of_inferior (int pid)
184 struct inferior *inf;
185 struct delete_thread_of_inferior_arg arg;
187 for (inf = inferior_list; inf; inf = inf->next)
197 iterate_over_threads (delete_thread_of_inferior, &arg);
200 /* If SILENT then be quiet -- don't announce a inferior death, or the
201 exit of its threads. */
204 delete_inferior_1 (struct inferior *todel, int silent)
206 struct inferior *inf, *infprev;
207 struct delete_thread_of_inferior_arg arg;
211 for (inf = inferior_list; inf; infprev = inf, inf = inf->next)
221 iterate_over_threads (delete_thread_of_inferior, &arg);
224 infprev->next = inf->next;
226 inferior_list = inf->next;
228 observer_notify_inferior_removed (inf);
234 delete_inferior (int pid)
236 struct inferior *inf = find_inferior_pid (pid);
238 delete_inferior_1 (inf, 0);
240 if (print_inferior_events)
241 printf_unfiltered (_("[Inferior %d exited]\n"), pid);
245 delete_inferior_silent (int pid)
247 struct inferior *inf = find_inferior_pid (pid);
249 delete_inferior_1 (inf, 1);
253 /* If SILENT then be quiet -- don't announce a inferior exit, or the
254 exit of its threads. */
257 exit_inferior_1 (struct inferior *inftoex, int silent)
259 struct inferior *inf;
260 struct delete_thread_of_inferior_arg arg;
262 for (inf = inferior_list; inf; inf = inf->next)
272 iterate_over_threads (delete_thread_of_inferior, &arg);
274 /* Notify the observers before removing the inferior from the list,
275 so that the observers have a chance to look it up. */
276 observer_notify_inferior_exit (inf);
280 if (inf->vfork_parent != NULL)
282 inf->vfork_parent->vfork_child = NULL;
283 inf->vfork_parent = NULL;
286 inf->has_exit_code = 0;
291 exit_inferior (int pid)
293 struct inferior *inf = find_inferior_pid (pid);
295 exit_inferior_1 (inf, 0);
297 if (print_inferior_events)
298 printf_unfiltered (_("[Inferior %d exited]\n"), pid);
302 exit_inferior_silent (int pid)
304 struct inferior *inf = find_inferior_pid (pid);
306 exit_inferior_1 (inf, 1);
310 exit_inferior_num_silent (int num)
312 struct inferior *inf = find_inferior_id (num);
314 exit_inferior_1 (inf, 1);
318 detach_inferior (int pid)
320 struct inferior *inf = find_inferior_pid (pid);
322 exit_inferior_1 (inf, 1);
324 if (print_inferior_events)
325 printf_unfiltered (_("[Inferior %d detached]\n"), pid);
329 inferior_appeared (struct inferior *inf, int pid)
333 observer_notify_inferior_appeared (inf);
337 discard_all_inferiors (void)
339 struct inferior *inf;
341 for (inf = inferior_list; inf; inf = inf->next)
344 exit_inferior_silent (inf->pid);
349 find_inferior_id (int num)
351 struct inferior *inf;
353 for (inf = inferior_list; inf; inf = inf->next)
361 find_inferior_pid (int pid)
363 struct inferior *inf;
365 /* Looking for inferior pid == 0 is always wrong, and indicative of
366 a bug somewhere else. There may be more than one with pid == 0,
368 gdb_assert (pid != 0);
370 for (inf = inferior_list; inf; inf = inf->next)
377 /* Find an inferior bound to PSPACE. */
380 find_inferior_for_program_space (struct program_space *pspace)
382 struct inferior *inf;
384 for (inf = inferior_list; inf != NULL; inf = inf->next)
386 if (inf->pspace == pspace)
394 iterate_over_inferiors (int (*callback) (struct inferior *, void *),
397 struct inferior *inf, *infnext;
399 for (inf = inferior_list; inf; inf = infnext)
402 if ((*callback) (inf, data))
410 valid_gdb_inferior_id (int num)
412 struct inferior *inf;
414 for (inf = inferior_list; inf; inf = inf->next)
422 pid_to_gdb_inferior_id (int pid)
424 struct inferior *inf;
426 for (inf = inferior_list; inf; inf = inf->next)
434 gdb_inferior_id_to_pid (int num)
436 struct inferior *inferior = find_inferior_id (num);
438 return inferior->pid;
444 in_inferior_list (int pid)
446 struct inferior *inf;
448 for (inf = inferior_list; inf; inf = inf->next)
456 have_inferiors (void)
458 struct inferior *inf;
460 for (inf = inferior_list; inf; inf = inf->next)
468 have_live_inferiors (void)
470 struct inferior *inf;
472 for (inf = inferior_list; inf; inf = inf->next)
475 struct thread_info *tp;
477 tp = any_thread_of_process (inf->pid);
478 if (tp && target_has_execution_1 (tp->ptid))
485 /* Prune away automatically added program spaces that aren't required
489 prune_inferiors (void)
491 struct inferior *ss, **ss_link;
492 struct inferior *current = current_inferior ();
495 ss_link = &inferior_list;
508 delete_inferior_1 (ss, 1);
512 prune_program_spaces ();
515 /* Simply returns the count of inferiors. */
518 number_of_inferiors (void)
520 struct inferior *inf;
523 for (inf = inferior_list; inf != NULL; inf = inf->next)
529 /* Prints the list of inferiors and their details on UIOUT. This is a
530 version of 'info_inferior_command' suitable for use from MI.
532 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
533 inferiors that should be printed. Otherwise, all inferiors are
537 print_inferior (struct ui_out *uiout, char *requested_inferiors)
539 struct inferior *inf;
540 struct cleanup *old_chain;
543 /* Compute number of inferiors we will print. */
544 for (inf = inferior_list; inf; inf = inf->next)
546 if (!number_is_in_list (requested_inferiors, inf->num))
554 ui_out_message (uiout, 0, "No inferiors.\n");
558 old_chain = make_cleanup_ui_out_table_begin_end (uiout, 4, inf_count,
560 ui_out_table_header (uiout, 1, ui_left, "current", "");
561 ui_out_table_header (uiout, 4, ui_left, "number", "Num");
562 ui_out_table_header (uiout, 17, ui_left, "target-id", "Description");
563 ui_out_table_header (uiout, 17, ui_left, "exec", "Executable");
565 ui_out_table_body (uiout);
566 for (inf = inferior_list; inf; inf = inf->next)
568 struct cleanup *chain2;
570 if (!number_is_in_list (requested_inferiors, inf->num))
573 chain2 = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
575 if (inf == current_inferior ())
576 ui_out_field_string (uiout, "current", "*");
578 ui_out_field_skip (uiout, "current");
580 ui_out_field_int (uiout, "number", inf->num);
583 ui_out_field_string (uiout, "target-id",
584 target_pid_to_str (pid_to_ptid (inf->pid)));
586 ui_out_field_string (uiout, "target-id", "<null>");
588 if (inf->pspace->ebfd)
589 ui_out_field_string (uiout, "exec",
590 bfd_get_filename (inf->pspace->ebfd));
592 ui_out_field_skip (uiout, "exec");
594 /* Print extra info that isn't really fit to always present in
595 tabular form. Currently we print the vfork parent/child
596 relationships, if any. */
597 if (inf->vfork_parent)
599 ui_out_text (uiout, _("\n\tis vfork child of inferior "));
600 ui_out_field_int (uiout, "vfork-parent", inf->vfork_parent->num);
602 if (inf->vfork_child)
604 ui_out_text (uiout, _("\n\tis vfork parent of inferior "));
605 ui_out_field_int (uiout, "vfork-child", inf->vfork_child->num);
608 ui_out_text (uiout, "\n");
609 do_cleanups (chain2);
612 do_cleanups (old_chain);
616 detach_inferior_command (char *args, int from_tty)
619 struct thread_info *tp;
620 struct get_number_or_range_state state;
623 error (_("Requires argument (inferior id(s) to detach)"));
625 init_number_or_range (&state, args);
626 while (!state.finished)
628 num = get_number_or_range (&state);
630 if (!valid_gdb_inferior_id (num))
632 warning (_("Inferior ID %d not known."), num);
636 pid = gdb_inferior_id_to_pid (num);
638 tp = any_thread_of_process (pid);
641 warning (_("Inferior ID %d has no threads."), num);
645 switch_to_thread (tp->ptid);
647 detach_command (NULL, from_tty);
652 kill_inferior_command (char *args, int from_tty)
655 struct thread_info *tp;
656 struct get_number_or_range_state state;
659 error (_("Requires argument (inferior id(s) to kill)"));
661 init_number_or_range (&state, args);
662 while (!state.finished)
664 num = get_number_or_range (&state);
666 if (!valid_gdb_inferior_id (num))
668 warning (_("Inferior ID %d not known."), num);
672 pid = gdb_inferior_id_to_pid (num);
674 tp = any_thread_of_process (pid);
677 warning (_("Inferior ID %d has no threads."), num);
681 switch_to_thread (tp->ptid);
686 bfd_cache_close_all ();
690 inferior_command (char *args, int from_tty)
692 struct inferior *inf;
695 num = parse_and_eval_long (args);
697 inf = find_inferior_id (num);
699 error (_("Inferior ID %d not known."), num);
701 printf_filtered (_("[Switching to inferior %d [%s] (%s)]\n"),
703 target_pid_to_str (pid_to_ptid (inf->pid)),
705 ? bfd_get_filename (inf->pspace->ebfd)
710 if (inf->pid != ptid_get_pid (inferior_ptid))
712 struct thread_info *tp;
714 tp = any_thread_of_process (inf->pid);
716 error (_("Inferior has no threads."));
718 switch_to_thread (tp->ptid);
721 printf_filtered (_("[Switching to thread %d (%s)] "),
722 pid_to_thread_id (inferior_ptid),
723 target_pid_to_str (inferior_ptid));
727 struct inferior *inf;
729 inf = find_inferior_id (num);
730 set_current_inferior (inf);
731 switch_to_thread (null_ptid);
732 set_current_program_space (inf->pspace);
735 if (inf->pid != 0 && is_running (inferior_ptid))
736 ui_out_text (current_uiout, "(running)\n");
737 else if (inf->pid != 0)
739 ui_out_text (current_uiout, "\n");
740 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
744 /* Print information about currently known inferiors. */
747 info_inferiors_command (char *args, int from_tty)
749 print_inferior (current_uiout, args);
752 /* remove-inferior ID */
755 remove_inferior_command (char *args, int from_tty)
758 struct inferior *inf;
759 struct get_number_or_range_state state;
761 if (args == NULL || *args == '\0')
762 error (_("Requires an argument (inferior id(s) to remove)"));
764 init_number_or_range (&state, args);
765 while (!state.finished)
767 num = get_number_or_range (&state);
768 inf = find_inferior_id (num);
772 warning (_("Inferior ID %d not known."), num);
776 if (inf == current_inferior ())
778 warning (_("Can not remove current symbol inferior %d."), num);
784 warning (_("Can not remove active inferior %d."), num);
788 delete_inferior_1 (inf, 1);
793 add_inferior_with_spaces (void)
795 struct address_space *aspace;
796 struct program_space *pspace;
797 struct inferior *inf;
799 /* If all inferiors share an address space on this system, this
800 doesn't really return a new address space; otherwise, it
802 aspace = maybe_new_address_space ();
803 pspace = add_program_space (aspace);
804 inf = add_inferior (0);
805 inf->pspace = pspace;
806 inf->aspace = pspace->aspace;
811 /* add-inferior [-copies N] [-exec FILENAME] */
814 add_inferior_command (char *args, int from_tty)
819 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
823 argv = gdb_buildargv (args);
824 make_cleanup_freeargv (argv);
826 for (; *argv != NULL; argv++)
830 if (strcmp (*argv, "-copies") == 0)
834 error (_("No argument to -copies"));
835 copies = parse_and_eval_long (*argv);
837 else if (strcmp (*argv, "-exec") == 0)
841 error (_("No argument to -exec"));
846 error (_("Invalid argument"));
850 save_current_space_and_thread ();
852 for (i = 0; i < copies; ++i)
854 struct inferior *inf = add_inferior_with_spaces ();
856 printf_filtered (_("Added inferior %d\n"), inf->num);
860 /* Switch over temporarily, while reading executable and
862 set_current_program_space (inf->pspace);
863 set_current_inferior (inf);
864 switch_to_thread (null_ptid);
866 exec_file_attach (exec, from_tty);
867 symbol_file_add_main (exec, from_tty);
871 do_cleanups (old_chain);
874 /* clone-inferior [-copies N] [ID] */
877 clone_inferior_command (char *args, int from_tty)
881 struct inferior *orginf = NULL;
882 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
886 argv = gdb_buildargv (args);
887 make_cleanup_freeargv (argv);
889 for (; *argv != NULL; argv++)
893 if (strcmp (*argv, "-copies") == 0)
897 error (_("No argument to -copies"));
898 copies = parse_and_eval_long (*argv);
901 error (_("Invalid copies number"));
910 /* The first non-option (-) argument specified the
912 num = parse_and_eval_long (*argv);
913 orginf = find_inferior_id (num);
916 error (_("Inferior ID %d not known."), num);
920 error (_("Invalid argument"));
925 /* If no inferior id was specified, then the user wants to clone the
928 orginf = current_inferior ();
930 save_current_space_and_thread ();
932 for (i = 0; i < copies; ++i)
934 struct address_space *aspace;
935 struct program_space *pspace;
936 struct inferior *inf;
938 /* If all inferiors share an address space on this system, this
939 doesn't really return a new address space; otherwise, it
941 aspace = maybe_new_address_space ();
942 pspace = add_program_space (aspace);
943 inf = add_inferior (0);
944 inf->pspace = pspace;
945 inf->aspace = pspace->aspace;
947 printf_filtered (_("Added inferior %d.\n"), inf->num);
949 set_current_inferior (inf);
950 switch_to_thread (null_ptid);
951 clone_program_space (pspace, orginf->pspace);
954 do_cleanups (old_chain);
957 /* Print notices when new inferiors are created and die. */
959 show_print_inferior_events (struct ui_file *file, int from_tty,
960 struct cmd_list_element *c, const char *value)
962 fprintf_filtered (file, _("Printing of inferior events is %s.\n"), value);
967 /* Keep a registry of per-inferior data-pointers required by other GDB
973 void (*cleanup) (struct inferior *, void *);
976 struct inferior_data_registration
978 struct inferior_data *data;
979 struct inferior_data_registration *next;
982 struct inferior_data_registry
984 struct inferior_data_registration *registrations;
985 unsigned num_registrations;
988 static struct inferior_data_registry inferior_data_registry
991 const struct inferior_data *
992 register_inferior_data_with_cleanup
993 (void (*cleanup) (struct inferior *, void *))
995 struct inferior_data_registration **curr;
997 /* Append new registration. */
998 for (curr = &inferior_data_registry.registrations;
999 *curr != NULL; curr = &(*curr)->next);
1001 *curr = XMALLOC (struct inferior_data_registration);
1002 (*curr)->next = NULL;
1003 (*curr)->data = XMALLOC (struct inferior_data);
1004 (*curr)->data->index = inferior_data_registry.num_registrations++;
1005 (*curr)->data->cleanup = cleanup;
1007 return (*curr)->data;
1010 const struct inferior_data *
1011 register_inferior_data (void)
1013 return register_inferior_data_with_cleanup (NULL);
1017 inferior_alloc_data (struct inferior *inf)
1019 gdb_assert (inf->data == NULL);
1020 inf->num_data = inferior_data_registry.num_registrations;
1021 inf->data = XCALLOC (inf->num_data, void *);
1025 inferior_free_data (struct inferior *inf)
1027 gdb_assert (inf->data != NULL);
1028 clear_inferior_data (inf);
1034 clear_inferior_data (struct inferior *inf)
1036 struct inferior_data_registration *registration;
1039 gdb_assert (inf->data != NULL);
1041 for (registration = inferior_data_registry.registrations, i = 0;
1043 registration = registration->next, i++)
1044 if (inf->data[i] != NULL && registration->data->cleanup)
1045 registration->data->cleanup (inf, inf->data[i]);
1047 memset (inf->data, 0, inf->num_data * sizeof (void *));
1051 set_inferior_data (struct inferior *inf,
1052 const struct inferior_data *data,
1055 gdb_assert (data->index < inf->num_data);
1056 inf->data[data->index] = value;
1060 inferior_data (struct inferior *inf, const struct inferior_data *data)
1062 gdb_assert (data->index < inf->num_data);
1063 return inf->data[data->index];
1067 initialize_inferiors (void)
1069 /* There's always one inferior. Note that this function isn't an
1070 automatic _initialize_foo function, since other _initialize_foo
1071 routines may need to install their per-inferior data keys. We
1072 can only allocate an inferior when all those modules have done
1073 that. Do this after initialize_progspace, due to the
1074 current_program_space reference. */
1075 current_inferior_ = add_inferior (0);
1076 current_inferior_->pspace = current_program_space;
1077 current_inferior_->aspace = current_program_space->aspace;
1079 add_info ("inferiors", info_inferiors_command,
1080 _("IDs of specified inferiors (all inferiors if no argument)."));
1082 add_com ("add-inferior", no_class, add_inferior_command, _("\
1083 Add a new inferior.\n\
1084 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
1085 N is the optional number of inferiors to add, default is 1.\n\
1086 FILENAME is the file name of the executable to use\n\
1087 as main program."));
1089 add_com ("remove-inferiors", no_class, remove_inferior_command, _("\
1090 Remove inferior ID (or list of IDs).\n\
1091 Usage: remove-inferiors ID..."));
1093 add_com ("clone-inferior", no_class, clone_inferior_command, _("\
1094 Clone inferior ID.\n\
1095 Usage: clone-inferior [-copies <N>] [ID]\n\
1096 Add N copies of inferior ID. The new inferior has the same\n\
1097 executable loaded as the copied inferior. If -copies is not specified,\n\
1098 adds 1 copy. If ID is not specified, it is the current inferior\n\
1101 add_cmd ("inferiors", class_run, detach_inferior_command, _("\
1102 Detach from inferior ID (or list of IDS)."),
1105 add_cmd ("inferiors", class_run, kill_inferior_command, _("\
1106 Kill inferior ID (or list of IDs)."),
1109 add_cmd ("inferior", class_run, inferior_command, _("\
1110 Use this command to switch between inferiors.\n\
1111 The new inferior ID must be currently known."),
1114 add_setshow_boolean_cmd ("inferior-events", no_class,
1115 &print_inferior_events, _("\
1116 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1117 Show printing of inferior events (e.g., inferior start and exit)."), NULL,
1119 show_print_inferior_events,
1120 &setprintlist, &showprintlist);