1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2019 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"
29 #include "observable.h"
32 #include "common/environ.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"
38 #include "progspace-and-thread.h"
40 /* Keep a registry of per-inferior data-pointers required by other GDB
43 DEFINE_REGISTRY (inferior, REGISTRY_ACCESS_FIELD)
45 struct inferior *inferior_list = NULL;
46 static int highest_inferior_num;
49 int print_inferior_events = 1;
51 /* The Current Inferior. This is a strong reference. I.e., whenever
52 an inferior is the current inferior, its refcount is
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);
69 current_inferior_->decref ();
70 current_inferior_ = inf;
73 private_inferior::~private_inferior () = default;
75 inferior::~inferior ()
79 discard_all_inferior_continuations (inf);
80 inferior_free_data (inf);
82 xfree (inf->terminal);
83 target_desc_info_free (inf->tdesc_info);
86 inferior::inferior (int pid_)
87 : num (++highest_inferior_num),
89 environment (gdb_environ::from_host_environ ()),
92 inferior_alloc_data (this);
96 add_inferior_silent (int pid)
98 inferior *inf = new inferior (pid);
100 if (inferior_list == NULL)
106 for (last = inferior_list; last->next != NULL; last = last->next)
111 gdb::observers::inferior_added.notify (inf);
114 inferior_appeared (inf, pid);
120 add_inferior (int pid)
122 struct inferior *inf = add_inferior_silent (pid);
124 if (print_inferior_events)
127 printf_unfiltered (_("[New inferior %d (%s)]\n"),
129 target_pid_to_str (ptid_t (pid)));
131 printf_unfiltered (_("[New inferior %d]\n"), inf->num);
138 delete_inferior (struct inferior *todel)
140 struct inferior *inf, *infprev;
144 for (inf = inferior_list; inf; infprev = inf, inf = inf->next)
151 for (thread_info *tp : inf->threads_safe ())
152 delete_thread_silent (tp);
155 infprev->next = inf->next;
157 inferior_list = inf->next;
159 gdb::observers::inferior_removed.notify (inf);
161 /* If this program space is rendered useless, remove it. */
162 if (program_space_empty_p (inf->pspace))
163 delete_program_space (inf->pspace);
168 /* If SILENT then be quiet -- don't announce a inferior exit, or the
169 exit of its threads. */
172 exit_inferior_1 (struct inferior *inftoex, int silent)
174 struct inferior *inf;
176 for (inf = inferior_list; inf; inf = inf->next)
183 for (thread_info *tp : inf->threads_safe ())
186 delete_thread_silent (tp);
191 gdb::observers::inferior_exit.notify (inf);
197 if (inf->vfork_parent != NULL)
199 inf->vfork_parent->vfork_child = NULL;
200 inf->vfork_parent = NULL;
202 if (inf->vfork_child != NULL)
204 inf->vfork_child->vfork_parent = NULL;
205 inf->vfork_child = NULL;
208 inf->pending_detach = 0;
210 inf->control = inferior_control_state (NO_STOP_QUIETLY);
214 exit_inferior (inferior *inf)
216 exit_inferior_1 (inf, 0);
220 exit_inferior_silent (int pid)
222 struct inferior *inf = find_inferior_pid (pid);
224 exit_inferior_1 (inf, 1);
228 exit_inferior_silent (inferior *inf)
230 exit_inferior_1 (inf, 1);
233 /* See inferior.h. */
236 detach_inferior (inferior *inf)
238 /* Save the pid, since exit_inferior_1 will reset it. */
241 exit_inferior_1 (inf, 0);
243 if (print_inferior_events)
244 printf_unfiltered (_("[Inferior %d (%s) detached]\n"),
246 target_pid_to_str (ptid_t (pid)));
250 inferior_appeared (struct inferior *inf, int pid)
252 /* If this is the first inferior with threads, reset the global
254 if (!any_thread_p ())
258 inf->has_exit_code = 0;
261 gdb::observers::inferior_appeared.notify (inf);
265 discard_all_inferiors (void)
267 for (inferior *inf : all_non_exited_inferiors ())
268 exit_inferior_silent (inf);
272 find_inferior_id (int num)
274 for (inferior *inf : all_inferiors ())
282 find_inferior_pid (int pid)
284 /* Looking for inferior pid == 0 is always wrong, and indicative of
285 a bug somewhere else. There may be more than one with pid == 0,
287 gdb_assert (pid != 0);
289 for (inferior *inf : all_inferiors ())
299 find_inferior_ptid (ptid_t ptid)
301 return find_inferior_pid (ptid.pid ());
304 /* See inferior.h. */
307 find_inferior_for_program_space (struct program_space *pspace)
309 struct inferior *cur_inf = current_inferior ();
311 if (cur_inf->pspace == pspace)
314 for (inferior *inf : all_inferiors ())
315 if (inf->pspace == pspace)
322 iterate_over_inferiors (int (*callback) (struct inferior *, void *),
325 for (inferior *inf : all_inferiors_safe ())
326 if ((*callback) (inf, data))
333 have_inferiors (void)
335 for (inferior *inf ATTRIBUTE_UNUSED : all_non_exited_inferiors ())
341 /* Return the number of live inferiors. We account for the case
342 where an inferior might have a non-zero pid but no threads, as
343 in the middle of a 'mourn' operation. */
346 number_of_live_inferiors (void)
350 for (inferior *inf : all_non_exited_inferiors ())
351 if (target_has_execution_1 (ptid_t (inf->pid)))
352 for (thread_info *tp ATTRIBUTE_UNUSED : inf->non_exited_threads ())
354 /* Found a live thread in this inferior, go to the next
363 /* Return true if there is at least one live inferior. */
366 have_live_inferiors (void)
368 return number_of_live_inferiors () > 0;
371 /* Prune away any unused inferiors, and then prune away no longer used
375 prune_inferiors (void)
377 struct inferior *ss, **ss_link;
380 ss_link = &inferior_list;
383 if (!ss->deletable ()
393 delete_inferior (ss);
398 /* Simply returns the count of inferiors. */
401 number_of_inferiors (void)
403 auto rng = all_inferiors ();
404 return std::distance (rng.begin (), rng.end ());
407 /* Converts an inferior process id to a string. Like
408 target_pid_to_str, but special cases the null process. */
411 inferior_pid_to_str (int pid)
414 return target_pid_to_str (ptid_t (pid));
419 /* See inferior.h. */
422 print_selected_inferior (struct ui_out *uiout)
424 struct inferior *inf = current_inferior ();
425 const char *filename = inf->pspace->pspace_exec_filename;
427 if (filename == NULL)
428 filename = _("<noexec>");
430 uiout->message (_("[Switching to inferior %d [%s] (%s)]\n"),
431 inf->num, inferior_pid_to_str (inf->pid), filename);
434 /* Prints the list of inferiors and their details on UIOUT. This is a
435 version of 'info_inferior_command' suitable for use from MI.
437 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
438 inferiors that should be printed. Otherwise, all inferiors are
442 print_inferior (struct ui_out *uiout, const char *requested_inferiors)
446 /* Compute number of inferiors we will print. */
447 for (inferior *inf : all_inferiors ())
449 if (!number_is_in_list (requested_inferiors, inf->num))
457 uiout->message ("No inferiors.\n");
461 ui_out_emit_table table_emitter (uiout, 4, inf_count, "inferiors");
462 uiout->table_header (1, ui_left, "current", "");
463 uiout->table_header (4, ui_left, "number", "Num");
464 uiout->table_header (17, ui_left, "target-id", "Description");
465 uiout->table_header (17, ui_left, "exec", "Executable");
467 uiout->table_body ();
468 for (inferior *inf : all_inferiors ())
470 if (!number_is_in_list (requested_inferiors, inf->num))
473 ui_out_emit_tuple tuple_emitter (uiout, NULL);
475 if (inf == current_inferior ())
476 uiout->field_string ("current", "*");
478 uiout->field_skip ("current");
480 uiout->field_int ("number", inf->num);
482 uiout->field_string ("target-id", inferior_pid_to_str (inf->pid));
484 if (inf->pspace->pspace_exec_filename != NULL)
485 uiout->field_string ("exec", inf->pspace->pspace_exec_filename);
487 uiout->field_skip ("exec");
489 /* Print extra info that isn't really fit to always present in
490 tabular form. Currently we print the vfork parent/child
491 relationships, if any. */
492 if (inf->vfork_parent)
494 uiout->text (_("\n\tis vfork child of inferior "));
495 uiout->field_int ("vfork-parent", inf->vfork_parent->num);
497 if (inf->vfork_child)
499 uiout->text (_("\n\tis vfork parent of inferior "));
500 uiout->field_int ("vfork-child", inf->vfork_child->num);
508 detach_inferior_command (const char *args, int from_tty)
511 error (_("Requires argument (inferior id(s) to detach)"));
513 number_or_range_parser parser (args);
514 while (!parser.finished ())
516 int num = parser.get_number ();
518 inferior *inf = find_inferior_id (num);
521 warning (_("Inferior ID %d not known."), num);
527 warning (_("Inferior ID %d is not running."), num);
531 thread_info *tp = any_thread_of_inferior (inf);
534 warning (_("Inferior ID %d has no threads."), num);
538 switch_to_thread (tp);
540 detach_command (NULL, from_tty);
545 kill_inferior_command (const char *args, int from_tty)
548 error (_("Requires argument (inferior id(s) to kill)"));
550 number_or_range_parser parser (args);
551 while (!parser.finished ())
553 int num = parser.get_number ();
555 inferior *inf = find_inferior_id (num);
558 warning (_("Inferior ID %d not known."), num);
564 warning (_("Inferior ID %d is not running."), num);
568 thread_info *tp = any_thread_of_inferior (inf);
571 warning (_("Inferior ID %d has no threads."), num);
575 switch_to_thread (tp);
580 bfd_cache_close_all ();
584 inferior_command (const char *args, int from_tty)
586 struct inferior *inf;
589 num = parse_and_eval_long (args);
591 inf = find_inferior_id (num);
593 error (_("Inferior ID %d not known."), num);
597 if (inf != current_inferior ())
599 thread_info *tp = any_thread_of_inferior (inf);
601 error (_("Inferior has no threads."));
603 switch_to_thread (tp);
606 gdb::observers::user_selected_context_changed.notify
607 (USER_SELECTED_INFERIOR
608 | USER_SELECTED_THREAD
609 | USER_SELECTED_FRAME);
613 set_current_inferior (inf);
614 switch_to_no_thread ();
615 set_current_program_space (inf->pspace);
617 gdb::observers::user_selected_context_changed.notify
618 (USER_SELECTED_INFERIOR);
622 /* Print information about currently known inferiors. */
625 info_inferiors_command (const char *args, int from_tty)
627 print_inferior (current_uiout, args);
630 /* remove-inferior ID */
633 remove_inferior_command (const char *args, int from_tty)
635 if (args == NULL || *args == '\0')
636 error (_("Requires an argument (inferior id(s) to remove)"));
638 number_or_range_parser parser (args);
639 while (!parser.finished ())
641 int num = parser.get_number ();
642 struct inferior *inf = find_inferior_id (num);
646 warning (_("Inferior ID %d not known."), num);
650 if (!inf->deletable ())
652 warning (_("Can not remove current inferior %d."), num);
658 warning (_("Can not remove active inferior %d."), num);
662 delete_inferior (inf);
667 add_inferior_with_spaces (void)
669 struct address_space *aspace;
670 struct program_space *pspace;
671 struct inferior *inf;
672 struct gdbarch_info info;
674 /* If all inferiors share an address space on this system, this
675 doesn't really return a new address space; otherwise, it
677 aspace = maybe_new_address_space ();
678 pspace = new program_space (aspace);
679 inf = add_inferior (0);
680 inf->pspace = pspace;
681 inf->aspace = pspace->aspace;
683 /* Setup the inferior's initial arch, based on information obtained
684 from the global "set ..." options. */
685 gdbarch_info_init (&info);
686 inf->gdbarch = gdbarch_find_by_info (info);
687 /* The "set ..." options reject invalid settings, so we should
688 always have a valid arch by now. */
689 gdb_assert (inf->gdbarch != NULL);
694 /* add-inferior [-copies N] [-exec FILENAME] */
697 add_inferior_command (const char *args, int from_tty)
700 gdb::unique_xmalloc_ptr<char> exec;
701 symfile_add_flags add_flags = 0;
704 add_flags |= SYMFILE_VERBOSE;
708 gdb_argv built_argv (args);
710 for (char **argv = built_argv.get (); *argv != NULL; argv++)
714 if (strcmp (*argv, "-copies") == 0)
718 error (_("No argument to -copies"));
719 copies = parse_and_eval_long (*argv);
721 else if (strcmp (*argv, "-exec") == 0)
725 error (_("No argument to -exec"));
726 exec.reset (tilde_expand (*argv));
730 error (_("Invalid argument"));
734 scoped_restore_current_pspace_and_thread restore_pspace_thread;
736 for (i = 0; i < copies; ++i)
738 struct inferior *inf = add_inferior_with_spaces ();
740 printf_filtered (_("Added inferior %d\n"), inf->num);
744 /* Switch over temporarily, while reading executable and
746 set_current_program_space (inf->pspace);
747 set_current_inferior (inf);
748 switch_to_no_thread ();
750 exec_file_attach (exec.get (), from_tty);
751 symbol_file_add_main (exec.get (), add_flags);
756 /* clone-inferior [-copies N] [ID] */
759 clone_inferior_command (const char *args, int from_tty)
762 struct inferior *orginf = NULL;
766 gdb_argv built_argv (args);
768 char **argv = built_argv.get ();
769 for (; *argv != NULL; argv++)
773 if (strcmp (*argv, "-copies") == 0)
777 error (_("No argument to -copies"));
778 copies = parse_and_eval_long (*argv);
781 error (_("Invalid copies number"));
790 /* The first non-option (-) argument specified the
792 num = parse_and_eval_long (*argv);
793 orginf = find_inferior_id (num);
796 error (_("Inferior ID %d not known."), num);
800 error (_("Invalid argument"));
805 /* If no inferior id was specified, then the user wants to clone the
808 orginf = current_inferior ();
810 scoped_restore_current_pspace_and_thread restore_pspace_thread;
812 for (i = 0; i < copies; ++i)
814 struct address_space *aspace;
815 struct program_space *pspace;
816 struct inferior *inf;
818 /* If all inferiors share an address space on this system, this
819 doesn't really return a new address space; otherwise, it
821 aspace = maybe_new_address_space ();
822 pspace = new program_space (aspace);
823 inf = add_inferior (0);
824 inf->pspace = pspace;
825 inf->aspace = pspace->aspace;
826 inf->gdbarch = orginf->gdbarch;
828 /* If the original inferior had a user specified target
829 description, make the clone use it too. */
830 if (target_desc_info_from_user_p (inf->tdesc_info))
831 copy_inferior_target_desc_info (inf, orginf);
833 printf_filtered (_("Added inferior %d.\n"), inf->num);
835 set_current_inferior (inf);
836 switch_to_no_thread ();
837 clone_program_space (pspace, orginf->pspace);
841 /* Print notices when new inferiors are created and die. */
843 show_print_inferior_events (struct ui_file *file, int from_tty,
844 struct cmd_list_element *c, const char *value)
846 fprintf_filtered (file, _("Printing of inferior events is %s.\n"), value);
849 /* Return a new value for the selected inferior's id. */
851 static struct value *
852 inferior_id_make_value (struct gdbarch *gdbarch, struct internalvar *var,
855 struct inferior *inf = current_inferior ();
857 return value_from_longest (builtin_type (gdbarch)->builtin_int, inf->num);
860 /* Implementation of `$_inferior' variable. */
862 static const struct internalvar_funcs inferior_funcs =
864 inferior_id_make_value,
872 initialize_inferiors (void)
874 struct cmd_list_element *c = NULL;
876 /* There's always one inferior. Note that this function isn't an
877 automatic _initialize_foo function, since other _initialize_foo
878 routines may need to install their per-inferior data keys. We
879 can only allocate an inferior when all those modules have done
880 that. Do this after initialize_progspace, due to the
881 current_program_space reference. */
882 current_inferior_ = add_inferior_silent (0);
883 current_inferior_->incref ();
884 current_inferior_->pspace = current_program_space;
885 current_inferior_->aspace = current_program_space->aspace;
886 /* The architecture will be initialized shortly, by
887 initialize_current_architecture. */
889 add_info ("inferiors", info_inferiors_command,
890 _("Print a list of inferiors being managed.\n\
891 Usage: info inferiors [ID]...\n\
892 If IDs are specified, the list is limited to just those inferiors.\n\
893 By default all inferiors are displayed."));
895 c = add_com ("add-inferior", no_class, add_inferior_command, _("\
896 Add a new inferior.\n\
897 Usage: add-inferior [-copies N] [-exec FILENAME]\n\
898 N is the optional number of inferiors to add, default is 1.\n\
899 FILENAME is the file name of the executable to use\n\
901 set_cmd_completer (c, filename_completer);
903 add_com ("remove-inferiors", no_class, remove_inferior_command, _("\
904 Remove inferior ID (or list of IDs).\n\
905 Usage: remove-inferiors ID..."));
907 add_com ("clone-inferior", no_class, clone_inferior_command, _("\
908 Clone inferior ID.\n\
909 Usage: clone-inferior [-copies N] [ID]\n\
910 Add N copies of inferior ID. The new inferior has the same\n\
911 executable loaded as the copied inferior. If -copies is not specified,\n\
912 adds 1 copy. If ID is not specified, it is the current inferior\n\
915 add_cmd ("inferiors", class_run, detach_inferior_command, _("\
916 Detach from inferior ID (or list of IDS).\n\
917 Usage; detach inferiors ID..."),
920 add_cmd ("inferiors", class_run, kill_inferior_command, _("\
921 Kill inferior ID (or list of IDs).\n\
922 Usage: kill inferiors ID..."),
925 add_cmd ("inferior", class_run, inferior_command, _("\
926 Use this command to switch between inferiors.\n\
927 Usage: inferior ID\n\
928 The new inferior ID must be currently known."),
931 add_setshow_boolean_cmd ("inferior-events", no_class,
932 &print_inferior_events, _("\
933 Set printing of inferior events (e.g., inferior start and exit)."), _("\
934 Show printing of inferior events (e.g., inferior start and exit)."), NULL,
936 show_print_inferior_events,
937 &setprintlist, &showprintlist);
939 create_internalvar_type_lazy ("_inferior", &inferior_funcs, NULL);