1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008, 2009, 2010, 2011 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"
35 void _initialize_inferiors (void);
37 static void inferior_alloc_data (struct inferior
*inf
);
38 static void inferior_free_data (struct inferior
*inf
);
40 struct inferior
*inferior_list
= NULL
;
41 static int highest_inferior_num
;
43 /* Print notices on inferior events (attach, detach, etc.), set with
44 `set print inferior-events'. */
45 static int print_inferior_events
= 0;
47 /* The Current Inferior. */
48 static struct inferior
*current_inferior_
= NULL
;
51 current_inferior (void)
53 return current_inferior_
;
57 set_current_inferior (struct inferior
*inf
)
59 /* There's always an inferior. */
60 gdb_assert (inf
!= NULL
);
62 current_inferior_
= inf
;
65 /* A cleanups callback, helper for save_current_program_space
69 restore_inferior (void *arg
)
71 struct inferior
*saved_inferior
= arg
;
73 set_current_inferior (saved_inferior
);
76 /* Save the current program space so that it may be restored by a later
77 call to do_cleanups. Returns the struct cleanup pointer needed for
78 later doing the cleanup. */
81 save_current_inferior (void)
83 struct cleanup
*old_chain
= make_cleanup (restore_inferior
,
90 free_inferior (struct inferior
*inf
)
92 discard_all_inferior_continuations (inf
);
93 inferior_free_data (inf
);
95 xfree (inf
->terminal
);
96 free_environ (inf
->environment
);
102 init_inferior_list (void)
104 struct inferior
*inf
, *infnext
;
106 highest_inferior_num
= 0;
110 for (inf
= inferior_list
; inf
; inf
= infnext
)
116 inferior_list
= NULL
;
120 add_inferior_silent (int pid
)
122 struct inferior
*inf
;
124 inf
= xmalloc (sizeof (*inf
));
125 memset (inf
, 0, sizeof (*inf
));
128 inf
->control
.stop_soon
= NO_STOP_QUIETLY
;
130 inf
->num
= ++highest_inferior_num
;
131 inf
->next
= inferior_list
;
134 inf
->environment
= make_environ ();
135 init_environ (inf
->environment
);
137 inferior_alloc_data (inf
);
139 observer_notify_inferior_added (inf
);
142 inferior_appeared (inf
, pid
);
148 add_inferior (int pid
)
150 struct inferior
*inf
= add_inferior_silent (pid
);
152 if (print_inferior_events
)
153 printf_unfiltered (_("[New inferior %d]\n"), pid
);
158 struct delete_thread_of_inferior_arg
165 delete_thread_of_inferior (struct thread_info
*tp
, void *data
)
167 struct delete_thread_of_inferior_arg
*arg
= data
;
169 if (ptid_get_pid (tp
->ptid
) == arg
->pid
)
172 delete_thread_silent (tp
->ptid
);
174 delete_thread (tp
->ptid
);
181 delete_threads_of_inferior (int pid
)
183 struct inferior
*inf
;
184 struct delete_thread_of_inferior_arg arg
;
186 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
196 iterate_over_threads (delete_thread_of_inferior
, &arg
);
199 /* If SILENT then be quiet -- don't announce a inferior death, or the
200 exit of its threads. */
203 delete_inferior_1 (struct inferior
*todel
, int silent
)
205 struct inferior
*inf
, *infprev
;
206 struct delete_thread_of_inferior_arg arg
;
210 for (inf
= inferior_list
; inf
; infprev
= inf
, inf
= inf
->next
)
220 iterate_over_threads (delete_thread_of_inferior
, &arg
);
223 infprev
->next
= inf
->next
;
225 inferior_list
= inf
->next
;
227 observer_notify_inferior_removed (inf
);
233 delete_inferior (int pid
)
235 struct inferior
*inf
= find_inferior_pid (pid
);
237 delete_inferior_1 (inf
, 0);
239 if (print_inferior_events
)
240 printf_unfiltered (_("[Inferior %d exited]\n"), pid
);
244 delete_inferior_silent (int pid
)
246 struct inferior
*inf
= find_inferior_pid (pid
);
248 delete_inferior_1 (inf
, 1);
252 /* If SILENT then be quiet -- don't announce a inferior exit, or the
253 exit of its threads. */
256 exit_inferior_1 (struct inferior
*inftoex
, int silent
)
258 struct inferior
*inf
;
259 struct delete_thread_of_inferior_arg arg
;
261 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
271 iterate_over_threads (delete_thread_of_inferior
, &arg
);
273 /* Notify the observers before removing the inferior from the list,
274 so that the observers have a chance to look it up. */
275 observer_notify_inferior_exit (inf
);
278 if (inf
->vfork_parent
!= NULL
)
280 inf
->vfork_parent
->vfork_child
= NULL
;
281 inf
->vfork_parent
= NULL
;
286 exit_inferior (int pid
)
288 struct inferior
*inf
= find_inferior_pid (pid
);
290 exit_inferior_1 (inf
, 0);
292 if (print_inferior_events
)
293 printf_unfiltered (_("[Inferior %d exited]\n"), pid
);
297 exit_inferior_silent (int pid
)
299 struct inferior
*inf
= find_inferior_pid (pid
);
301 exit_inferior_1 (inf
, 1);
305 exit_inferior_num_silent (int num
)
307 struct inferior
*inf
= find_inferior_id (num
);
309 exit_inferior_1 (inf
, 1);
313 detach_inferior (int pid
)
315 struct inferior
*inf
= find_inferior_pid (pid
);
317 exit_inferior_1 (inf
, 1);
319 if (print_inferior_events
)
320 printf_unfiltered (_("[Inferior %d detached]\n"), pid
);
324 inferior_appeared (struct inferior
*inf
, int pid
)
328 observer_notify_inferior_appeared (inf
);
332 discard_all_inferiors (void)
334 struct inferior
*inf
;
336 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
339 exit_inferior_silent (inf
->pid
);
344 find_inferior_id (int num
)
346 struct inferior
*inf
;
348 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
356 find_inferior_pid (int pid
)
358 struct inferior
*inf
;
360 /* Looking for inferior pid == 0 is always wrong, and indicative of
361 a bug somewhere else. There may be more than one with pid == 0,
363 gdb_assert (pid
!= 0);
365 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
372 /* Find an inferior bound to PSPACE. */
375 find_inferior_for_program_space (struct program_space
*pspace
)
377 struct inferior
*inf
;
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
)
463 have_live_inferiors (void)
465 struct inferior
*inf
;
467 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
470 struct thread_info
*tp
;
472 tp
= any_thread_of_process (inf
->pid
);
473 if (tp
&& target_has_execution_1 (tp
->ptid
))
480 /* Prune away automatically added program spaces that aren't required
484 prune_inferiors (void)
486 struct inferior
*ss
, **ss_link
;
487 struct inferior
*current
= current_inferior ();
490 ss_link
= &inferior_list
;
503 delete_inferior_1 (ss
, 1);
507 prune_program_spaces ();
510 /* Simply returns the count of inferiors. */
513 number_of_inferiors (void)
515 struct inferior
*inf
;
518 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
524 /* Prints the list of inferiors and their details on UIOUT. This is a
525 version of 'info_inferior_command' suitable for use from MI.
527 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
528 inferiors that should be printed. Otherwise, all inferiors are
532 print_inferior (struct ui_out
*uiout
, char *requested_inferiors
)
534 struct inferior
*inf
;
535 struct cleanup
*old_chain
;
538 /* Compute number of inferiors we will print. */
539 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
541 if (!number_is_in_list (requested_inferiors
, inf
->num
))
549 ui_out_message (uiout
, 0, "No inferiors.\n");
553 old_chain
= make_cleanup_ui_out_table_begin_end (uiout
, 4, inf_count
,
555 ui_out_table_header (uiout
, 1, ui_left
, "current", "");
556 ui_out_table_header (uiout
, 4, ui_left
, "number", "Num");
557 ui_out_table_header (uiout
, 17, ui_left
, "target-id", "Description");
558 ui_out_table_header (uiout
, 17, ui_left
, "exec", "Executable");
560 ui_out_table_body (uiout
);
561 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
563 struct cleanup
*chain2
;
565 if (!number_is_in_list (requested_inferiors
, inf
->num
))
568 chain2
= make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
570 if (inf
== current_inferior ())
571 ui_out_field_string (uiout
, "current", "*");
573 ui_out_field_skip (uiout
, "current");
575 ui_out_field_int (uiout
, "number", inf
->num
);
578 ui_out_field_string (uiout
, "target-id",
579 target_pid_to_str (pid_to_ptid (inf
->pid
)));
581 ui_out_field_string (uiout
, "target-id", "<null>");
583 if (inf
->pspace
->ebfd
)
584 ui_out_field_string (uiout
, "exec",
585 bfd_get_filename (inf
->pspace
->ebfd
));
587 ui_out_field_skip (uiout
, "exec");
589 /* Print extra info that isn't really fit to always present in
590 tabular form. Currently we print the vfork parent/child
591 relationships, if any. */
592 if (inf
->vfork_parent
)
594 ui_out_text (uiout
, _("\n\tis vfork child of inferior "));
595 ui_out_field_int (uiout
, "vfork-parent", inf
->vfork_parent
->num
);
597 if (inf
->vfork_child
)
599 ui_out_text (uiout
, _("\n\tis vfork parent of inferior "));
600 ui_out_field_int (uiout
, "vfork-child", inf
->vfork_child
->num
);
603 ui_out_text (uiout
, "\n");
604 do_cleanups (chain2
);
607 do_cleanups (old_chain
);
611 detach_inferior_command (char *args
, int from_tty
)
614 struct thread_info
*tp
;
615 struct get_number_or_range_state state
;
618 error (_("Requires argument (inferior id(s) to detach)"));
620 init_number_or_range (&state
, args
);
621 while (!state
.finished
)
623 num
= get_number_or_range (&state
);
625 if (!valid_gdb_inferior_id (num
))
627 warning (_("Inferior ID %d not known."), num
);
631 pid
= gdb_inferior_id_to_pid (num
);
633 tp
= any_thread_of_process (pid
);
636 warning (_("Inferior ID %d has no threads."), num
);
640 switch_to_thread (tp
->ptid
);
642 detach_command (NULL
, from_tty
);
647 kill_inferior_command (char *args
, int from_tty
)
650 struct thread_info
*tp
;
651 struct get_number_or_range_state state
;
654 error (_("Requires argument (inferior id(s) to kill)"));
656 init_number_or_range (&state
, args
);
657 while (!state
.finished
)
659 num
= get_number_or_range (&state
);
661 if (!valid_gdb_inferior_id (num
))
663 warning (_("Inferior ID %d not known."), num
);
667 pid
= gdb_inferior_id_to_pid (num
);
669 tp
= any_thread_of_process (pid
);
672 warning (_("Inferior ID %d has no threads."), num
);
676 switch_to_thread (tp
->ptid
);
681 bfd_cache_close_all ();
685 inferior_command (char *args
, int from_tty
)
687 struct inferior
*inf
;
690 num
= parse_and_eval_long (args
);
692 inf
= find_inferior_id (num
);
694 error (_("Inferior ID %d not known."), num
);
696 printf_filtered (_("[Switching to inferior %d [%s] (%s)]\n"),
698 target_pid_to_str (pid_to_ptid (inf
->pid
)),
700 ? bfd_get_filename (inf
->pspace
->ebfd
)
705 if (inf
->pid
!= ptid_get_pid (inferior_ptid
))
707 struct thread_info
*tp
;
709 tp
= any_thread_of_process (inf
->pid
);
711 error (_("Inferior has no threads."));
713 switch_to_thread (tp
->ptid
);
716 printf_filtered (_("[Switching to thread %d (%s)] "),
717 pid_to_thread_id (inferior_ptid
),
718 target_pid_to_str (inferior_ptid
));
722 struct inferior
*inf
;
724 inf
= find_inferior_id (num
);
725 set_current_inferior (inf
);
726 switch_to_thread (null_ptid
);
727 set_current_program_space (inf
->pspace
);
730 if (inf
->pid
!= 0 && is_running (inferior_ptid
))
731 ui_out_text (uiout
, "(running)\n");
732 else if (inf
->pid
!= 0)
734 ui_out_text (uiout
, "\n");
735 print_stack_frame (get_selected_frame (NULL
), 1, SRC_AND_LOC
);
739 /* Print information about currently known inferiors. */
742 info_inferiors_command (char *args
, int from_tty
)
744 print_inferior (uiout
, args
);
747 /* remove-inferior ID */
750 remove_inferior_command (char *args
, int from_tty
)
753 struct inferior
*inf
;
754 struct get_number_or_range_state state
;
756 if (args
== NULL
|| *args
== '\0')
757 error (_("Requires an argument (inferior id(s) to remove)"));
759 init_number_or_range (&state
, args
);
760 while (!state
.finished
)
762 num
= get_number_or_range (&state
);
763 inf
= find_inferior_id (num
);
767 warning (_("Inferior ID %d not known."), num
);
771 if (inf
== current_inferior ())
773 warning (_("Can not remove current symbol inferior %d."), num
);
779 warning (_("Can not remove active inferior %d."), num
);
783 delete_inferior_1 (inf
, 1);
788 add_inferior_with_spaces (void)
790 struct address_space
*aspace
;
791 struct program_space
*pspace
;
792 struct inferior
*inf
;
794 /* If all inferiors share an address space on this system, this
795 doesn't really return a new address space; otherwise, it
797 aspace
= maybe_new_address_space ();
798 pspace
= add_program_space (aspace
);
799 inf
= add_inferior (0);
800 inf
->pspace
= pspace
;
801 inf
->aspace
= pspace
->aspace
;
806 /* add-inferior [-copies N] [-exec FILENAME] */
809 add_inferior_command (char *args
, int from_tty
)
814 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
818 argv
= gdb_buildargv (args
);
819 make_cleanup_freeargv (argv
);
821 for (; *argv
!= NULL
; argv
++)
825 if (strcmp (*argv
, "-copies") == 0)
829 error (_("No argument to -copies"));
830 copies
= parse_and_eval_long (*argv
);
832 else if (strcmp (*argv
, "-exec") == 0)
836 error (_("No argument to -exec"));
841 error (_("Invalid argument"));
845 save_current_space_and_thread ();
847 for (i
= 0; i
< copies
; ++i
)
849 struct inferior
*inf
= add_inferior_with_spaces ();
851 printf_filtered (_("Added inferior %d\n"), inf
->num
);
855 /* Switch over temporarily, while reading executable and
857 set_current_program_space (inf
->pspace
);
858 set_current_inferior (inf
);
859 switch_to_thread (null_ptid
);
861 exec_file_attach (exec
, from_tty
);
862 symbol_file_add_main (exec
, from_tty
);
866 do_cleanups (old_chain
);
869 /* clone-inferior [-copies N] [ID] */
872 clone_inferior_command (char *args
, int from_tty
)
876 struct inferior
*orginf
= NULL
;
877 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
881 argv
= gdb_buildargv (args
);
882 make_cleanup_freeargv (argv
);
884 for (; *argv
!= NULL
; argv
++)
888 if (strcmp (*argv
, "-copies") == 0)
892 error (_("No argument to -copies"));
893 copies
= parse_and_eval_long (*argv
);
896 error (_("Invalid copies number"));
905 /* The first non-option (-) argument specified the
907 num
= parse_and_eval_long (*argv
);
908 orginf
= find_inferior_id (num
);
911 error (_("Inferior ID %d not known."), num
);
915 error (_("Invalid argument"));
920 /* If no inferior id was specified, then the user wants to clone the
923 orginf
= current_inferior ();
925 save_current_space_and_thread ();
927 for (i
= 0; i
< copies
; ++i
)
929 struct address_space
*aspace
;
930 struct program_space
*pspace
;
931 struct inferior
*inf
;
933 /* If all inferiors share an address space on this system, this
934 doesn't really return a new address space; otherwise, it
936 aspace
= maybe_new_address_space ();
937 pspace
= add_program_space (aspace
);
938 inf
= add_inferior (0);
939 inf
->pspace
= pspace
;
940 inf
->aspace
= pspace
->aspace
;
942 printf_filtered (_("Added inferior %d.\n"), inf
->num
);
944 set_current_inferior (inf
);
945 switch_to_thread (null_ptid
);
946 clone_program_space (pspace
, orginf
->pspace
);
949 do_cleanups (old_chain
);
952 /* Print notices when new inferiors are created and die. */
954 show_print_inferior_events (struct ui_file
*file
, int from_tty
,
955 struct cmd_list_element
*c
, const char *value
)
957 fprintf_filtered (file
, _("Printing of inferior events is %s.\n"), value
);
962 /* Keep a registry of per-inferior data-pointers required by other GDB
968 void (*cleanup
) (struct inferior
*, void *);
971 struct inferior_data_registration
973 struct inferior_data
*data
;
974 struct inferior_data_registration
*next
;
977 struct inferior_data_registry
979 struct inferior_data_registration
*registrations
;
980 unsigned num_registrations
;
983 static struct inferior_data_registry inferior_data_registry
986 const struct inferior_data
*
987 register_inferior_data_with_cleanup
988 (void (*cleanup
) (struct inferior
*, void *))
990 struct inferior_data_registration
**curr
;
992 /* Append new registration. */
993 for (curr
= &inferior_data_registry
.registrations
;
994 *curr
!= NULL
; curr
= &(*curr
)->next
);
996 *curr
= XMALLOC (struct inferior_data_registration
);
997 (*curr
)->next
= NULL
;
998 (*curr
)->data
= XMALLOC (struct inferior_data
);
999 (*curr
)->data
->index
= inferior_data_registry
.num_registrations
++;
1000 (*curr
)->data
->cleanup
= cleanup
;
1002 return (*curr
)->data
;
1005 const struct inferior_data
*
1006 register_inferior_data (void)
1008 return register_inferior_data_with_cleanup (NULL
);
1012 inferior_alloc_data (struct inferior
*inf
)
1014 gdb_assert (inf
->data
== NULL
);
1015 inf
->num_data
= inferior_data_registry
.num_registrations
;
1016 inf
->data
= XCALLOC (inf
->num_data
, void *);
1020 inferior_free_data (struct inferior
*inf
)
1022 gdb_assert (inf
->data
!= NULL
);
1023 clear_inferior_data (inf
);
1029 clear_inferior_data (struct inferior
*inf
)
1031 struct inferior_data_registration
*registration
;
1034 gdb_assert (inf
->data
!= NULL
);
1036 for (registration
= inferior_data_registry
.registrations
, i
= 0;
1038 registration
= registration
->next
, i
++)
1039 if (inf
->data
[i
] != NULL
&& registration
->data
->cleanup
)
1040 registration
->data
->cleanup (inf
, inf
->data
[i
]);
1042 memset (inf
->data
, 0, inf
->num_data
* sizeof (void *));
1046 set_inferior_data (struct inferior
*inf
,
1047 const struct inferior_data
*data
,
1050 gdb_assert (data
->index
< inf
->num_data
);
1051 inf
->data
[data
->index
] = value
;
1055 inferior_data (struct inferior
*inf
, const struct inferior_data
*data
)
1057 gdb_assert (data
->index
< inf
->num_data
);
1058 return inf
->data
[data
->index
];
1062 initialize_inferiors (void)
1064 /* There's always one inferior. Note that this function isn't an
1065 automatic _initialize_foo function, since other _initialize_foo
1066 routines may need to install their per-inferior data keys. We
1067 can only allocate an inferior when all those modules have done
1068 that. Do this after initialize_progspace, due to the
1069 current_program_space reference. */
1070 current_inferior_
= add_inferior (0);
1071 current_inferior_
->pspace
= current_program_space
;
1072 current_inferior_
->aspace
= current_program_space
->aspace
;
1074 add_info ("inferiors", info_inferiors_command
,
1075 _("IDs of specified inferiors (all inferiors if no argument)."));
1077 add_com ("add-inferior", no_class
, add_inferior_command
, _("\
1078 Add a new inferior.\n\
1079 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
1080 N is the optional number of inferiors to add, default is 1.\n\
1081 FILENAME is the file name of the executable to use\n\
1082 as main program."));
1084 add_com ("remove-inferiors", no_class
, remove_inferior_command
, _("\
1085 Remove inferior ID (or list of IDs).\n\
1086 Usage: remove-inferiors ID..."));
1088 add_com ("clone-inferior", no_class
, clone_inferior_command
, _("\
1089 Clone inferior ID.\n\
1090 Usage: clone-inferior [-copies <N>] [ID]\n\
1091 Add N copies of inferior ID. The new inferior has the same\n\
1092 executable loaded as the copied inferior. If -copies is not specified,\n\
1093 adds 1 copy. If ID is not specified, it is the current inferior\n\
1096 add_cmd ("inferiors", class_run
, detach_inferior_command
, _("\
1097 Detach from inferior ID (or list of IDS)."),
1100 add_cmd ("inferiors", class_run
, kill_inferior_command
, _("\
1101 Kill inferior ID (or list of IDs)."),
1104 add_cmd ("inferior", class_run
, inferior_command
, _("\
1105 Use this command to switch between inferiors.\n\
1106 The new inferior ID must be currently known."),
1109 add_setshow_boolean_cmd ("inferior-events", no_class
,
1110 &print_inferior_events
, _("\
1111 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1112 Show printing of inferior events (e.g., inferior start and exit)."), NULL
,
1114 show_print_inferior_events
,
1115 &setprintlist
, &showprintlist
);