1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2013 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"
30 #include "gdbthread.h"
34 #include "cli/cli-utils.h"
35 #include "continuations.h"
36 #include "arch-utils.h"
37 #include "target-descriptions.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
->has_exit_code
= 0;
280 inf
->pending_detach
= 0;
284 exit_inferior (int pid
)
286 struct inferior
*inf
= find_inferior_pid (pid
);
288 exit_inferior_1 (inf
, 0);
290 if (print_inferior_events
)
291 printf_unfiltered (_("[Inferior %d exited]\n"), pid
);
295 exit_inferior_silent (int pid
)
297 struct inferior
*inf
= find_inferior_pid (pid
);
299 exit_inferior_1 (inf
, 1);
303 exit_inferior_num_silent (int num
)
305 struct inferior
*inf
= find_inferior_id (num
);
307 exit_inferior_1 (inf
, 1);
311 detach_inferior (int pid
)
313 struct inferior
*inf
= find_inferior_pid (pid
);
315 exit_inferior_1 (inf
, 1);
317 if (print_inferior_events
)
318 printf_unfiltered (_("[Inferior %d detached]\n"), pid
);
322 inferior_appeared (struct inferior
*inf
, int pid
)
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
)
370 /* Find an inferior bound to PSPACE. */
373 find_inferior_for_program_space (struct program_space
*pspace
)
375 struct inferior
*inf
;
377 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
379 if (inf
->pspace
== pspace
)
387 iterate_over_inferiors (int (*callback
) (struct inferior
*, void *),
390 struct inferior
*inf
, *infnext
;
392 for (inf
= inferior_list
; inf
; inf
= infnext
)
395 if ((*callback
) (inf
, data
))
403 valid_gdb_inferior_id (int num
)
405 struct inferior
*inf
;
407 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
415 pid_to_gdb_inferior_id (int pid
)
417 struct inferior
*inf
;
419 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
427 gdb_inferior_id_to_pid (int num
)
429 struct inferior
*inferior
= find_inferior_id (num
);
431 return inferior
->pid
;
437 in_inferior_list (int pid
)
439 struct inferior
*inf
;
441 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
449 have_inferiors (void)
451 struct inferior
*inf
;
453 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
461 have_live_inferiors (void)
463 struct inferior
*inf
;
465 for (inf
= inferior_list
; inf
; inf
= inf
->next
)
468 struct thread_info
*tp
;
470 tp
= any_thread_of_process (inf
->pid
);
471 if (tp
&& target_has_execution_1 (tp
->ptid
))
478 /* Prune away automatically added program spaces that aren't required
482 prune_inferiors (void)
484 struct inferior
*ss
, **ss_link
;
485 struct inferior
*current
= current_inferior ();
488 ss_link
= &inferior_list
;
501 delete_inferior_1 (ss
, 1);
505 prune_program_spaces ();
508 /* Simply returns the count of inferiors. */
511 number_of_inferiors (void)
513 struct inferior
*inf
;
516 for (inf
= inferior_list
; inf
!= NULL
; inf
= inf
->next
)
522 /* Converts an inferior process id to a string. Like
523 target_pid_to_str, but special cases the null process. */
526 inferior_pid_to_str (int pid
)
529 return target_pid_to_str (pid_to_ptid (pid
));
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
);
587 ui_out_field_string (uiout
, "target-id",
588 inferior_pid_to_str (inf
->pid
));
590 if (inf
->pspace
->ebfd
)
591 ui_out_field_string (uiout
, "exec",
592 bfd_get_filename (inf
->pspace
->ebfd
));
594 ui_out_field_skip (uiout
, "exec");
596 /* Print extra info that isn't really fit to always present in
597 tabular form. Currently we print the vfork parent/child
598 relationships, if any. */
599 if (inf
->vfork_parent
)
601 ui_out_text (uiout
, _("\n\tis vfork child of inferior "));
602 ui_out_field_int (uiout
, "vfork-parent", inf
->vfork_parent
->num
);
604 if (inf
->vfork_child
)
606 ui_out_text (uiout
, _("\n\tis vfork parent of inferior "));
607 ui_out_field_int (uiout
, "vfork-child", inf
->vfork_child
->num
);
610 ui_out_text (uiout
, "\n");
611 do_cleanups (chain2
);
614 do_cleanups (old_chain
);
618 detach_inferior_command (char *args
, int from_tty
)
621 struct thread_info
*tp
;
622 struct get_number_or_range_state state
;
625 error (_("Requires argument (inferior id(s) to detach)"));
627 init_number_or_range (&state
, args
);
628 while (!state
.finished
)
630 num
= get_number_or_range (&state
);
632 if (!valid_gdb_inferior_id (num
))
634 warning (_("Inferior ID %d not known."), num
);
638 pid
= gdb_inferior_id_to_pid (num
);
640 tp
= any_thread_of_process (pid
);
643 warning (_("Inferior ID %d has no threads."), num
);
647 switch_to_thread (tp
->ptid
);
649 detach_command (NULL
, from_tty
);
654 kill_inferior_command (char *args
, int from_tty
)
657 struct thread_info
*tp
;
658 struct get_number_or_range_state state
;
661 error (_("Requires argument (inferior id(s) to kill)"));
663 init_number_or_range (&state
, args
);
664 while (!state
.finished
)
666 num
= get_number_or_range (&state
);
668 if (!valid_gdb_inferior_id (num
))
670 warning (_("Inferior ID %d not known."), num
);
674 pid
= gdb_inferior_id_to_pid (num
);
676 tp
= any_thread_of_process (pid
);
679 warning (_("Inferior ID %d has no threads."), num
);
683 switch_to_thread (tp
->ptid
);
688 bfd_cache_close_all ();
692 inferior_command (char *args
, int from_tty
)
694 struct inferior
*inf
;
697 num
= parse_and_eval_long (args
);
699 inf
= find_inferior_id (num
);
701 error (_("Inferior ID %d not known."), num
);
703 printf_filtered (_("[Switching to inferior %d [%s] (%s)]\n"),
705 inferior_pid_to_str (inf
->pid
),
707 ? bfd_get_filename (inf
->pspace
->ebfd
)
712 if (inf
->pid
!= ptid_get_pid (inferior_ptid
))
714 struct thread_info
*tp
;
716 tp
= any_thread_of_process (inf
->pid
);
718 error (_("Inferior has no threads."));
720 switch_to_thread (tp
->ptid
);
723 printf_filtered (_("[Switching to thread %d (%s)] "),
724 pid_to_thread_id (inferior_ptid
),
725 target_pid_to_str (inferior_ptid
));
729 struct inferior
*inf
;
731 inf
= find_inferior_id (num
);
732 set_current_inferior (inf
);
733 switch_to_thread (null_ptid
);
734 set_current_program_space (inf
->pspace
);
737 if (inf
->pid
!= 0 && is_running (inferior_ptid
))
738 ui_out_text (current_uiout
, "(running)\n");
739 else if (inf
->pid
!= 0)
741 ui_out_text (current_uiout
, "\n");
742 print_stack_frame (get_selected_frame (NULL
), 1, SRC_AND_LOC
);
746 /* Print information about currently known inferiors. */
749 info_inferiors_command (char *args
, int from_tty
)
751 print_inferior (current_uiout
, args
);
754 /* remove-inferior ID */
757 remove_inferior_command (char *args
, int from_tty
)
760 struct inferior
*inf
;
761 struct get_number_or_range_state state
;
763 if (args
== NULL
|| *args
== '\0')
764 error (_("Requires an argument (inferior id(s) to remove)"));
766 init_number_or_range (&state
, args
);
767 while (!state
.finished
)
769 num
= get_number_or_range (&state
);
770 inf
= find_inferior_id (num
);
774 warning (_("Inferior ID %d not known."), num
);
778 if (inf
== current_inferior ())
780 warning (_("Can not remove current symbol inferior %d."), num
);
786 warning (_("Can not remove active inferior %d."), num
);
790 delete_inferior_1 (inf
, 1);
795 add_inferior_with_spaces (void)
797 struct address_space
*aspace
;
798 struct program_space
*pspace
;
799 struct inferior
*inf
;
800 struct gdbarch_info info
;
802 /* If all inferiors share an address space on this system, this
803 doesn't really return a new address space; otherwise, it
805 aspace
= maybe_new_address_space ();
806 pspace
= add_program_space (aspace
);
807 inf
= add_inferior (0);
808 inf
->pspace
= pspace
;
809 inf
->aspace
= pspace
->aspace
;
811 /* Setup the inferior's initial arch, based on information obtained
812 from the global "set ..." options. */
813 gdbarch_info_init (&info
);
814 inf
->gdbarch
= gdbarch_find_by_info (info
);
815 /* The "set ..." options reject invalid settings, so we should
816 always have a valid arch by now. */
817 gdb_assert (inf
->gdbarch
!= NULL
);
822 /* add-inferior [-copies N] [-exec FILENAME] */
825 add_inferior_command (char *args
, int from_tty
)
830 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
834 argv
= gdb_buildargv (args
);
835 make_cleanup_freeargv (argv
);
837 for (; *argv
!= NULL
; argv
++)
841 if (strcmp (*argv
, "-copies") == 0)
845 error (_("No argument to -copies"));
846 copies
= parse_and_eval_long (*argv
);
848 else if (strcmp (*argv
, "-exec") == 0)
852 error (_("No argument to -exec"));
857 error (_("Invalid argument"));
861 save_current_space_and_thread ();
863 for (i
= 0; i
< copies
; ++i
)
865 struct inferior
*inf
= add_inferior_with_spaces ();
867 printf_filtered (_("Added inferior %d\n"), inf
->num
);
871 /* Switch over temporarily, while reading executable and
873 set_current_program_space (inf
->pspace
);
874 set_current_inferior (inf
);
875 switch_to_thread (null_ptid
);
877 exec_file_attach (exec
, from_tty
);
878 symbol_file_add_main (exec
, from_tty
);
882 do_cleanups (old_chain
);
885 /* clone-inferior [-copies N] [ID] */
888 clone_inferior_command (char *args
, int from_tty
)
892 struct inferior
*orginf
= NULL
;
893 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
897 argv
= gdb_buildargv (args
);
898 make_cleanup_freeargv (argv
);
900 for (; *argv
!= NULL
; argv
++)
904 if (strcmp (*argv
, "-copies") == 0)
908 error (_("No argument to -copies"));
909 copies
= parse_and_eval_long (*argv
);
912 error (_("Invalid copies number"));
921 /* The first non-option (-) argument specified the
923 num
= parse_and_eval_long (*argv
);
924 orginf
= find_inferior_id (num
);
927 error (_("Inferior ID %d not known."), num
);
931 error (_("Invalid argument"));
936 /* If no inferior id was specified, then the user wants to clone the
939 orginf
= current_inferior ();
941 save_current_space_and_thread ();
943 for (i
= 0; i
< copies
; ++i
)
945 struct address_space
*aspace
;
946 struct program_space
*pspace
;
947 struct inferior
*inf
;
949 /* If all inferiors share an address space on this system, this
950 doesn't really return a new address space; otherwise, it
952 aspace
= maybe_new_address_space ();
953 pspace
= add_program_space (aspace
);
954 inf
= add_inferior (0);
955 inf
->pspace
= pspace
;
956 inf
->aspace
= pspace
->aspace
;
957 inf
->gdbarch
= orginf
->gdbarch
;
959 /* If the original inferior had a user specified target
960 description, make the clone use it too. */
961 if (target_desc_info_from_user_p (inf
->tdesc_info
))
962 copy_inferior_target_desc_info (inf
, orginf
);
964 printf_filtered (_("Added inferior %d.\n"), inf
->num
);
966 set_current_inferior (inf
);
967 switch_to_thread (null_ptid
);
968 clone_program_space (pspace
, orginf
->pspace
);
971 do_cleanups (old_chain
);
974 /* Print notices when new inferiors are created and die. */
976 show_print_inferior_events (struct ui_file
*file
, int from_tty
,
977 struct cmd_list_element
*c
, const char *value
)
979 fprintf_filtered (file
, _("Printing of inferior events is %s.\n"), value
);
985 initialize_inferiors (void)
987 struct cmd_list_element
*c
= NULL
;
989 /* There's always one inferior. Note that this function isn't an
990 automatic _initialize_foo function, since other _initialize_foo
991 routines may need to install their per-inferior data keys. We
992 can only allocate an inferior when all those modules have done
993 that. Do this after initialize_progspace, due to the
994 current_program_space reference. */
995 current_inferior_
= add_inferior (0);
996 current_inferior_
->pspace
= current_program_space
;
997 current_inferior_
->aspace
= current_program_space
->aspace
;
998 /* The architecture will be initialized shortly, by
999 initialize_current_architecture. */
1001 add_info ("inferiors", info_inferiors_command
,
1002 _("IDs of specified inferiors (all inferiors if no argument)."));
1004 c
= add_com ("add-inferior", no_class
, add_inferior_command
, _("\
1005 Add a new inferior.\n\
1006 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
1007 N is the optional number of inferiors to add, default is 1.\n\
1008 FILENAME is the file name of the executable to use\n\
1009 as main program."));
1010 set_cmd_completer (c
, filename_completer
);
1012 add_com ("remove-inferiors", no_class
, remove_inferior_command
, _("\
1013 Remove inferior ID (or list of IDs).\n\
1014 Usage: remove-inferiors ID..."));
1016 add_com ("clone-inferior", no_class
, clone_inferior_command
, _("\
1017 Clone inferior ID.\n\
1018 Usage: clone-inferior [-copies <N>] [ID]\n\
1019 Add N copies of inferior ID. The new inferior has the same\n\
1020 executable loaded as the copied inferior. If -copies is not specified,\n\
1021 adds 1 copy. If ID is not specified, it is the current inferior\n\
1024 add_cmd ("inferiors", class_run
, detach_inferior_command
, _("\
1025 Detach from inferior ID (or list of IDS)."),
1028 add_cmd ("inferiors", class_run
, kill_inferior_command
, _("\
1029 Kill inferior ID (or list of IDs)."),
1032 add_cmd ("inferior", class_run
, inferior_command
, _("\
1033 Use this command to switch between inferiors.\n\
1034 The new inferior ID must be currently known."),
1037 add_setshow_boolean_cmd ("inferior-events", no_class
,
1038 &print_inferior_events
, _("\
1039 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1040 Show printing of inferior events (e.g., inferior start and exit)."), NULL
,
1042 show_print_inferior_events
,
1043 &setprintlist
, &showprintlist
);