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 cleanup
*old_chain
;
466 struct inferior
*inf
;
468 old_chain
= make_cleanup_restore_current_thread ();
470 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
473 struct thread_info
*tp
;
475 tp
= any_thread_of_process (inf
->pid
);
478 switch_to_thread (tp
->ptid
);
480 if (target_has_execution
)
485 do_cleanups (old_chain
);
490 /* Prune away automatically added program spaces that aren't required
494 prune_inferiors (void)
496 struct inferior
*ss
, **ss_link
;
497 struct inferior
*current
= current_inferior ();
500 ss_link
= &inferior_list
;
513 delete_inferior_1 (ss
, 1);
517 prune_program_spaces ();
520 /* Simply returns the count of inferiors. */
523 number_of_inferiors (void)
525 struct inferior
*inf
;
528 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
534 /* Prints the list of inferiors and their details on UIOUT. This is a
535 version of 'info_inferior_command' suitable for use from MI.
537 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
538 inferiors that should be printed. Otherwise, all inferiors are
542 print_inferior (struct ui_out
*uiout
, char *requested_inferiors
)
544 struct inferior
*inf
;
545 struct cleanup
*old_chain
;
548 /* Compute number of inferiors we will print. */
549 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
551 if (!number_is_in_list (requested_inferiors
, inf
->num
))
559 ui_out_message (uiout
, 0, "No inferiors.\n");
563 old_chain
= make_cleanup_ui_out_table_begin_end (uiout
, 4, inf_count
,
565 ui_out_table_header (uiout
, 1, ui_left
, "current", "");
566 ui_out_table_header (uiout
, 4, ui_left
, "number", "Num");
567 ui_out_table_header (uiout
, 17, ui_left
, "target-id", "Description");
568 ui_out_table_header (uiout
, 17, ui_left
, "exec", "Executable");
570 ui_out_table_body (uiout
);
571 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
573 struct cleanup
*chain2
;
575 if (!number_is_in_list (requested_inferiors
, inf
->num
))
578 chain2
= make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
580 if (inf
== current_inferior ())
581 ui_out_field_string (uiout
, "current", "*");
583 ui_out_field_skip (uiout
, "current");
585 ui_out_field_int (uiout
, "number", inf
->num
);
588 ui_out_field_string (uiout
, "target-id",
589 target_pid_to_str (pid_to_ptid (inf
->pid
)));
591 ui_out_field_string (uiout
, "target-id", "<null>");
593 if (inf
->pspace
->ebfd
)
594 ui_out_field_string (uiout
, "exec",
595 bfd_get_filename (inf
->pspace
->ebfd
));
597 ui_out_field_skip (uiout
, "exec");
599 /* Print extra info that isn't really fit to always present in
600 tabular form. Currently we print the vfork parent/child
601 relationships, if any. */
602 if (inf
->vfork_parent
)
604 ui_out_text (uiout
, _("\n\tis vfork child of inferior "));
605 ui_out_field_int (uiout
, "vfork-parent", inf
->vfork_parent
->num
);
607 if (inf
->vfork_child
)
609 ui_out_text (uiout
, _("\n\tis vfork parent of inferior "));
610 ui_out_field_int (uiout
, "vfork-child", inf
->vfork_child
->num
);
613 ui_out_text (uiout
, "\n");
614 do_cleanups (chain2
);
617 do_cleanups (old_chain
);
621 detach_inferior_command (char *args
, int from_tty
)
624 struct thread_info
*tp
;
627 error (_("Requires argument (inferior id(s) to detach)"));
629 while (*args
!= '\0')
631 num
= get_number_or_range (&args
);
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
;
661 error (_("Requires argument (inferior id(s) to kill)"));
663 while (*args
!= '\0')
665 num
= get_number_or_range (&args
);
667 if (!valid_gdb_inferior_id (num
))
669 warning (_("Inferior ID %d not known."), num
);
673 pid
= gdb_inferior_id_to_pid (num
);
675 tp
= any_thread_of_process (pid
);
678 warning (_("Inferior ID %d has no threads."), num
);
682 switch_to_thread (tp
->ptid
);
687 bfd_cache_close_all ();
691 inferior_command (char *args
, int from_tty
)
693 struct inferior
*inf
;
696 num
= parse_and_eval_long (args
);
698 inf
= find_inferior_id (num
);
700 error (_("Inferior ID %d not known."), num
);
702 printf_filtered (_("[Switching to inferior %d [%s] (%s)]\n"),
704 target_pid_to_str (pid_to_ptid (inf
->pid
)),
706 ? bfd_get_filename (inf
->pspace
->ebfd
)
711 if (inf
->pid
!= ptid_get_pid (inferior_ptid
))
713 struct thread_info
*tp
;
715 tp
= any_thread_of_process (inf
->pid
);
717 error (_("Inferior has no threads."));
719 switch_to_thread (tp
->ptid
);
722 printf_filtered (_("[Switching to thread %d (%s)] "),
723 pid_to_thread_id (inferior_ptid
),
724 target_pid_to_str (inferior_ptid
));
728 struct inferior
*inf
;
730 inf
= find_inferior_id (num
);
731 set_current_inferior (inf
);
732 switch_to_thread (null_ptid
);
733 set_current_program_space (inf
->pspace
);
736 if (inf
->pid
!= 0 && is_running (inferior_ptid
))
737 ui_out_text (uiout
, "(running)\n");
738 else if (inf
->pid
!= 0)
740 ui_out_text (uiout
, "\n");
741 print_stack_frame (get_selected_frame (NULL
), 1, SRC_AND_LOC
);
745 /* Print information about currently known inferiors. */
748 info_inferiors_command (char *args
, int from_tty
)
750 print_inferior (uiout
, args
);
753 /* remove-inferior ID */
756 remove_inferior_command (char *args
, int from_tty
)
759 struct inferior
*inf
;
761 if (args
== NULL
|| *args
== '\0')
762 error (_("Requires an argument (inferior id(s) to remove)"));
764 while (*args
!= '\0')
766 num
= get_number_or_range (&args
);
767 inf
= find_inferior_id (num
);
771 warning (_("Inferior ID %d not known."), num
);
775 if (inf
== current_inferior ())
777 warning (_("Can not remove current symbol inferior %d."), num
);
783 warning (_("Can not remove active inferior %d."), num
);
787 delete_inferior_1 (inf
, 1);
792 add_inferior_with_spaces (void)
794 struct address_space
*aspace
;
795 struct program_space
*pspace
;
796 struct inferior
*inf
;
798 /* If all inferiors share an address space on this system, this
799 doesn't really return a new address space; otherwise, it
801 aspace
= maybe_new_address_space ();
802 pspace
= add_program_space (aspace
);
803 inf
= add_inferior (0);
804 inf
->pspace
= pspace
;
805 inf
->aspace
= pspace
->aspace
;
810 /* add-inferior [-copies N] [-exec FILENAME] */
813 add_inferior_command (char *args
, int from_tty
)
818 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
822 argv
= gdb_buildargv (args
);
823 make_cleanup_freeargv (argv
);
825 for (; *argv
!= NULL
; argv
++)
829 if (strcmp (*argv
, "-copies") == 0)
833 error (_("No argument to -copies"));
834 copies
= parse_and_eval_long (*argv
);
836 else if (strcmp (*argv
, "-exec") == 0)
840 error (_("No argument to -exec"));
845 error (_("Invalid argument"));
849 save_current_space_and_thread ();
851 for (i
= 0; i
< copies
; ++i
)
853 struct inferior
*inf
= add_inferior_with_spaces ();
855 printf_filtered (_("Added inferior %d\n"), inf
->num
);
859 /* Switch over temporarily, while reading executable and
861 set_current_program_space (inf
->pspace
);
862 set_current_inferior (inf
);
863 switch_to_thread (null_ptid
);
865 exec_file_attach (exec
, from_tty
);
866 symbol_file_add_main (exec
, from_tty
);
870 do_cleanups (old_chain
);
873 /* clone-inferior [-copies N] [ID] */
876 clone_inferior_command (char *args
, int from_tty
)
880 struct inferior
*orginf
= NULL
;
881 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
885 argv
= gdb_buildargv (args
);
886 make_cleanup_freeargv (argv
);
888 for (; *argv
!= NULL
; argv
++)
892 if (strcmp (*argv
, "-copies") == 0)
896 error (_("No argument to -copies"));
897 copies
= parse_and_eval_long (*argv
);
900 error (_("Invalid copies number"));
909 /* The first non-option (-) argument specified the
911 num
= parse_and_eval_long (*argv
);
912 orginf
= find_inferior_id (num
);
915 error (_("Inferior ID %d not known."), num
);
919 error (_("Invalid argument"));
924 /* If no inferior id was specified, then the user wants to clone the
927 orginf
= current_inferior ();
929 save_current_space_and_thread ();
931 for (i
= 0; i
< copies
; ++i
)
933 struct address_space
*aspace
;
934 struct program_space
*pspace
;
935 struct inferior
*inf
;
937 /* If all inferiors share an address space on this system, this
938 doesn't really return a new address space; otherwise, it
940 aspace
= maybe_new_address_space ();
941 pspace
= add_program_space (aspace
);
942 inf
= add_inferior (0);
943 inf
->pspace
= pspace
;
944 inf
->aspace
= pspace
->aspace
;
946 printf_filtered (_("Added inferior %d.\n"), inf
->num
);
948 set_current_inferior (inf
);
949 switch_to_thread (null_ptid
);
950 clone_program_space (pspace
, orginf
->pspace
);
953 do_cleanups (old_chain
);
956 /* Print notices when new inferiors are created and die. */
958 show_print_inferior_events (struct ui_file
*file
, int from_tty
,
959 struct cmd_list_element
*c
, const char *value
)
961 fprintf_filtered (file
, _("Printing of inferior events is %s.\n"), value
);
966 /* Keep a registry of per-inferior data-pointers required by other GDB
972 void (*cleanup
) (struct inferior
*, void *);
975 struct inferior_data_registration
977 struct inferior_data
*data
;
978 struct inferior_data_registration
*next
;
981 struct inferior_data_registry
983 struct inferior_data_registration
*registrations
;
984 unsigned num_registrations
;
987 static struct inferior_data_registry inferior_data_registry
990 const struct inferior_data
*
991 register_inferior_data_with_cleanup
992 (void (*cleanup
) (struct inferior
*, void *))
994 struct inferior_data_registration
**curr
;
996 /* Append new registration. */
997 for (curr
= &inferior_data_registry
.registrations
;
998 *curr
!= NULL
; curr
= &(*curr
)->next
);
1000 *curr
= XMALLOC (struct inferior_data_registration
);
1001 (*curr
)->next
= NULL
;
1002 (*curr
)->data
= XMALLOC (struct inferior_data
);
1003 (*curr
)->data
->index
= inferior_data_registry
.num_registrations
++;
1004 (*curr
)->data
->cleanup
= cleanup
;
1006 return (*curr
)->data
;
1009 const struct inferior_data
*
1010 register_inferior_data (void)
1012 return register_inferior_data_with_cleanup (NULL
);
1016 inferior_alloc_data (struct inferior
*inf
)
1018 gdb_assert (inf
->data
== NULL
);
1019 inf
->num_data
= inferior_data_registry
.num_registrations
;
1020 inf
->data
= XCALLOC (inf
->num_data
, void *);
1024 inferior_free_data (struct inferior
*inf
)
1026 gdb_assert (inf
->data
!= NULL
);
1027 clear_inferior_data (inf
);
1033 clear_inferior_data (struct inferior
*inf
)
1035 struct inferior_data_registration
*registration
;
1038 gdb_assert (inf
->data
!= NULL
);
1040 for (registration
= inferior_data_registry
.registrations
, i
= 0;
1042 registration
= registration
->next
, i
++)
1043 if (inf
->data
[i
] != NULL
&& registration
->data
->cleanup
)
1044 registration
->data
->cleanup (inf
, inf
->data
[i
]);
1046 memset (inf
->data
, 0, inf
->num_data
* sizeof (void *));
1050 set_inferior_data (struct inferior
*inf
,
1051 const struct inferior_data
*data
,
1054 gdb_assert (data
->index
< inf
->num_data
);
1055 inf
->data
[data
->index
] = value
;
1059 inferior_data (struct inferior
*inf
, const struct inferior_data
*data
)
1061 gdb_assert (data
->index
< inf
->num_data
);
1062 return inf
->data
[data
->index
];
1066 initialize_inferiors (void)
1068 /* There's always one inferior. Note that this function isn't an
1069 automatic _initialize_foo function, since other _initialize_foo
1070 routines may need to install their per-inferior data keys. We
1071 can only allocate an inferior when all those modules have done
1072 that. Do this after initialize_progspace, due to the
1073 current_program_space reference. */
1074 current_inferior_
= add_inferior (0);
1075 current_inferior_
->pspace
= current_program_space
;
1076 current_inferior_
->aspace
= current_program_space
->aspace
;
1078 add_info ("inferiors", info_inferiors_command
,
1079 _("IDs of specified inferiors (all inferiors if no argument)."));
1081 add_com ("add-inferior", no_class
, add_inferior_command
, _("\
1082 Add a new inferior.\n\
1083 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
1084 N is the optional number of inferiors to add, default is 1.\n\
1085 FILENAME is the file name of the executable to use\n\
1086 as main program."));
1088 add_com ("remove-inferiors", no_class
, remove_inferior_command
, _("\
1089 Remove inferior ID (or list of IDs).\n\
1090 Usage: remove-inferiors ID..."));
1092 add_com ("clone-inferior", no_class
, clone_inferior_command
, _("\
1093 Clone inferior ID.\n\
1094 Usage: clone-inferior [-copies <N>] [ID]\n\
1095 Add N copies of inferior ID. The new inferior has the same\n\
1096 executable loaded as the copied inferior. If -copies is not specified,\n\
1097 adds 1 copy. If ID is not specified, it is the current inferior\n\
1100 add_cmd ("inferiors", class_run
, detach_inferior_command
, _("\
1101 Detach from inferior ID (or list of IDS)."),
1104 add_cmd ("inferiors", class_run
, kill_inferior_command
, _("\
1105 Kill inferior ID (or list of IDs)."),
1108 add_cmd ("inferior", class_run
, inferior_command
, _("\
1109 Use this command to switch between inferiors.\n\
1110 The new inferior ID must be currently known."),
1113 add_setshow_boolean_cmd ("inferior-events", no_class
,
1114 &print_inferior_events
, _("\
1115 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1116 Show printing of inferior events (e.g., inferior start and exit)."), NULL
,
1118 show_print_inferior_events
,
1119 &setprintlist
, &showprintlist
);