1 /* Multi-process control for GDB, the GNU debugger.
3 Copyright (C) 2008-2018 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"
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)
125 printf_unfiltered (_("[New inferior %d (%s)]\n"),
127 target_pid_to_str (pid_to_ptid (pid)));
132 struct delete_thread_of_inferior_arg
139 delete_thread_of_inferior (struct thread_info *tp, void *data)
141 struct delete_thread_of_inferior_arg *arg
142 = (struct delete_thread_of_inferior_arg *) data;
144 if (ptid_get_pid (tp->ptid) == arg->pid)
147 delete_thread_silent (tp);
156 delete_inferior (struct inferior *todel)
158 struct inferior *inf, *infprev;
159 struct delete_thread_of_inferior_arg arg;
163 for (inf = inferior_list; inf; infprev = inf, inf = inf->next)
173 iterate_over_threads (delete_thread_of_inferior, &arg);
176 infprev->next = inf->next;
178 inferior_list = inf->next;
180 gdb::observers::inferior_removed.notify (inf);
182 /* If this program space is rendered useless, remove it. */
183 if (program_space_empty_p (inf->pspace))
184 delete_program_space (inf->pspace);
189 /* If SILENT then be quiet -- don't announce a inferior exit, or the
190 exit of its threads. */
193 exit_inferior_1 (struct inferior *inftoex, int silent)
195 struct inferior *inf;
196 struct delete_thread_of_inferior_arg arg;
198 for (inf = inferior_list; inf; inf = inf->next)
208 iterate_over_threads (delete_thread_of_inferior, &arg);
210 gdb::observers::inferior_exit.notify (inf);
216 if (inf->vfork_parent != NULL)
218 inf->vfork_parent->vfork_child = NULL;
219 inf->vfork_parent = NULL;
221 if (inf->vfork_child != NULL)
223 inf->vfork_child->vfork_parent = NULL;
224 inf->vfork_child = NULL;
227 inf->pending_detach = 0;
229 inf->control = {NO_STOP_QUIETLY};
233 exit_inferior (inferior *inf)
236 exit_inferior_1 (inf, 0);
240 exit_inferior_silent (int pid)
242 struct inferior *inf = find_inferior_pid (pid);
244 exit_inferior_1 (inf, 1);
248 exit_inferior_silent (inferior *inf)
250 exit_inferior_1 (inf, 1);
254 exit_inferior_num_silent (int num)
256 struct inferior *inf = find_inferior_id (num);
258 exit_inferior_1 (inf, 1);
261 /* See inferior.h. */
264 detach_inferior (inferior *inf)
266 /* Save the pid, since exit_inferior_1 will reset it. */
269 exit_inferior_1 (inf, 0);
271 if (print_inferior_events)
272 printf_unfiltered (_("[Inferior %d (%s) detached]\n"),
274 target_pid_to_str (pid_to_ptid (pid)));
278 inferior_appeared (struct inferior *inf, int pid)
281 inf->has_exit_code = 0;
284 gdb::observers::inferior_appeared.notify (inf);
288 discard_all_inferiors (void)
290 struct inferior *inf;
292 for (inf = inferior_list; inf; inf = inf->next)
295 exit_inferior_silent (inf);
300 find_inferior_id (int num)
302 struct inferior *inf;
304 for (inf = inferior_list; inf; inf = inf->next)
312 find_inferior_pid (int pid)
314 struct inferior *inf;
316 /* Looking for inferior pid == 0 is always wrong, and indicative of
317 a bug somewhere else. There may be more than one with pid == 0,
319 gdb_assert (pid != 0);
321 for (inf = inferior_list; inf; inf = inf->next)
331 find_inferior_ptid (ptid_t ptid)
333 return find_inferior_pid (ptid_get_pid (ptid));
336 /* See inferior.h. */
339 find_inferior_for_program_space (struct program_space *pspace)
341 struct inferior *inf = current_inferior ();
343 if (inf->pspace == pspace)
346 for (inf = inferior_list; inf != NULL; inf = inf->next)
348 if (inf->pspace == pspace)
356 iterate_over_inferiors (int (*callback) (struct inferior *, void *),
359 struct inferior *inf, *infnext;
361 for (inf = inferior_list; inf; inf = infnext)
364 if ((*callback) (inf, data))
372 have_inferiors (void)
374 struct inferior *inf;
376 for (inf = inferior_list; inf; inf = inf->next)
383 /* Return the number of live inferiors. We account for the case
384 where an inferior might have a non-zero pid but no threads, as
385 in the middle of a 'mourn' operation. */
388 number_of_live_inferiors (void)
390 struct inferior *inf;
393 for (inf = inferior_list; inf; inf = inf->next)
396 struct thread_info *tp;
398 ALL_NON_EXITED_THREADS (tp)
399 if (tp && ptid_get_pid (tp->ptid) == inf->pid)
400 if (target_has_execution_1 (tp->ptid))
402 /* Found a live thread in this inferior, go to the next
412 /* Return true if there is at least one live inferior. */
415 have_live_inferiors (void)
417 return number_of_live_inferiors () > 0;
420 /* Prune away any unused inferiors, and then prune away no longer used
424 prune_inferiors (void)
426 struct inferior *ss, **ss_link;
429 ss_link = &inferior_list;
432 if (!ss->deletable ()
442 delete_inferior (ss);
447 /* Simply returns the count of inferiors. */
450 number_of_inferiors (void)
452 struct inferior *inf;
455 for (inf = inferior_list; inf != NULL; inf = inf->next)
461 /* Converts an inferior process id to a string. Like
462 target_pid_to_str, but special cases the null process. */
465 inferior_pid_to_str (int pid)
468 return target_pid_to_str (pid_to_ptid (pid));
473 /* See inferior.h. */
476 print_selected_inferior (struct ui_out *uiout)
478 struct inferior *inf = current_inferior ();
479 const char *filename = inf->pspace->pspace_exec_filename;
481 if (filename == NULL)
482 filename = _("<noexec>");
484 uiout->message (_("[Switching to inferior %d [%s] (%s)]\n"),
485 inf->num, inferior_pid_to_str (inf->pid), filename);
488 /* Prints the list of inferiors and their details on UIOUT. This is a
489 version of 'info_inferior_command' suitable for use from MI.
491 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
492 inferiors that should be printed. Otherwise, all inferiors are
496 print_inferior (struct ui_out *uiout, const char *requested_inferiors)
498 struct inferior *inf;
501 /* Compute number of inferiors we will print. */
502 for (inf = inferior_list; inf; inf = inf->next)
504 if (!number_is_in_list (requested_inferiors, inf->num))
512 uiout->message ("No inferiors.\n");
516 ui_out_emit_table table_emitter (uiout, 4, inf_count, "inferiors");
517 uiout->table_header (1, ui_left, "current", "");
518 uiout->table_header (4, ui_left, "number", "Num");
519 uiout->table_header (17, ui_left, "target-id", "Description");
520 uiout->table_header (17, ui_left, "exec", "Executable");
522 uiout->table_body ();
523 for (inf = inferior_list; inf; inf = inf->next)
525 if (!number_is_in_list (requested_inferiors, inf->num))
528 ui_out_emit_tuple tuple_emitter (uiout, NULL);
530 if (inf == current_inferior ())
531 uiout->field_string ("current", "*");
533 uiout->field_skip ("current");
535 uiout->field_int ("number", inf->num);
537 uiout->field_string ("target-id", inferior_pid_to_str (inf->pid));
539 if (inf->pspace->pspace_exec_filename != NULL)
540 uiout->field_string ("exec", inf->pspace->pspace_exec_filename);
542 uiout->field_skip ("exec");
544 /* Print extra info that isn't really fit to always present in
545 tabular form. Currently we print the vfork parent/child
546 relationships, if any. */
547 if (inf->vfork_parent)
549 uiout->text (_("\n\tis vfork child of inferior "));
550 uiout->field_int ("vfork-parent", inf->vfork_parent->num);
552 if (inf->vfork_child)
554 uiout->text (_("\n\tis vfork parent of inferior "));
555 uiout->field_int ("vfork-child", inf->vfork_child->num);
563 detach_inferior_command (const char *args, int from_tty)
566 error (_("Requires argument (inferior id(s) to detach)"));
568 number_or_range_parser parser (args);
569 while (!parser.finished ())
571 int num = parser.get_number ();
573 inferior *inf = find_inferior_id (num);
576 warning (_("Inferior ID %d not known."), num);
582 warning (_("Inferior ID %d is not running."), num);
586 thread_info *tp = any_thread_of_inferior (inf);
589 warning (_("Inferior ID %d has no threads."), num);
593 switch_to_thread (tp);
595 detach_command (NULL, from_tty);
600 kill_inferior_command (const char *args, int from_tty)
603 error (_("Requires argument (inferior id(s) to kill)"));
605 number_or_range_parser parser (args);
606 while (!parser.finished ())
608 int num = parser.get_number ();
610 inferior *inf = find_inferior_id (num);
613 warning (_("Inferior ID %d not known."), num);
619 warning (_("Inferior ID %d is not running."), num);
623 thread_info *tp = any_thread_of_inferior (inf);
626 warning (_("Inferior ID %d has no threads."), num);
630 switch_to_thread (tp);
635 bfd_cache_close_all ();
639 inferior_command (const char *args, int from_tty)
641 struct inferior *inf;
644 num = parse_and_eval_long (args);
646 inf = find_inferior_id (num);
648 error (_("Inferior ID %d not known."), num);
652 if (inf != current_inferior ())
654 thread_info *tp = any_thread_of_inferior (inf);
656 error (_("Inferior has no threads."));
658 switch_to_thread (tp);
661 gdb::observers::user_selected_context_changed.notify
662 (USER_SELECTED_INFERIOR
663 | USER_SELECTED_THREAD
664 | USER_SELECTED_FRAME);
668 set_current_inferior (inf);
669 switch_to_no_thread ();
670 set_current_program_space (inf->pspace);
672 gdb::observers::user_selected_context_changed.notify
673 (USER_SELECTED_INFERIOR);
677 /* Print information about currently known inferiors. */
680 info_inferiors_command (const char *args, int from_tty)
682 print_inferior (current_uiout, args);
685 /* remove-inferior ID */
688 remove_inferior_command (const char *args, int from_tty)
690 if (args == NULL || *args == '\0')
691 error (_("Requires an argument (inferior id(s) to remove)"));
693 number_or_range_parser parser (args);
694 while (!parser.finished ())
696 int num = parser.get_number ();
697 struct inferior *inf = find_inferior_id (num);
701 warning (_("Inferior ID %d not known."), num);
705 if (!inf->deletable ())
707 warning (_("Can not remove current inferior %d."), num);
713 warning (_("Can not remove active inferior %d."), num);
717 delete_inferior (inf);
722 add_inferior_with_spaces (void)
724 struct address_space *aspace;
725 struct program_space *pspace;
726 struct inferior *inf;
727 struct gdbarch_info info;
729 /* If all inferiors share an address space on this system, this
730 doesn't really return a new address space; otherwise, it
732 aspace = maybe_new_address_space ();
733 pspace = new program_space (aspace);
734 inf = add_inferior (0);
735 inf->pspace = pspace;
736 inf->aspace = pspace->aspace;
738 /* Setup the inferior's initial arch, based on information obtained
739 from the global "set ..." options. */
740 gdbarch_info_init (&info);
741 inf->gdbarch = gdbarch_find_by_info (info);
742 /* The "set ..." options reject invalid settings, so we should
743 always have a valid arch by now. */
744 gdb_assert (inf->gdbarch != NULL);
749 /* add-inferior [-copies N] [-exec FILENAME] */
752 add_inferior_command (const char *args, int from_tty)
755 gdb::unique_xmalloc_ptr<char> exec;
756 symfile_add_flags add_flags = 0;
759 add_flags |= SYMFILE_VERBOSE;
763 gdb_argv built_argv (args);
765 for (char **argv = built_argv.get (); *argv != NULL; argv++)
769 if (strcmp (*argv, "-copies") == 0)
773 error (_("No argument to -copies"));
774 copies = parse_and_eval_long (*argv);
776 else if (strcmp (*argv, "-exec") == 0)
780 error (_("No argument to -exec"));
781 exec.reset (tilde_expand (*argv));
785 error (_("Invalid argument"));
789 scoped_restore_current_pspace_and_thread restore_pspace_thread;
791 for (i = 0; i < copies; ++i)
793 struct inferior *inf = add_inferior_with_spaces ();
795 printf_filtered (_("Added inferior %d\n"), inf->num);
799 /* Switch over temporarily, while reading executable and
801 set_current_program_space (inf->pspace);
802 set_current_inferior (inf);
803 switch_to_no_thread ();
805 exec_file_attach (exec.get (), from_tty);
806 symbol_file_add_main (exec.get (), add_flags);
811 /* clone-inferior [-copies N] [ID] */
814 clone_inferior_command (const char *args, int from_tty)
817 struct inferior *orginf = NULL;
821 gdb_argv built_argv (args);
823 char **argv = built_argv.get ();
824 for (; *argv != NULL; argv++)
828 if (strcmp (*argv, "-copies") == 0)
832 error (_("No argument to -copies"));
833 copies = parse_and_eval_long (*argv);
836 error (_("Invalid copies number"));
845 /* The first non-option (-) argument specified the
847 num = parse_and_eval_long (*argv);
848 orginf = find_inferior_id (num);
851 error (_("Inferior ID %d not known."), num);
855 error (_("Invalid argument"));
860 /* If no inferior id was specified, then the user wants to clone the
863 orginf = current_inferior ();
865 scoped_restore_current_pspace_and_thread restore_pspace_thread;
867 for (i = 0; i < copies; ++i)
869 struct address_space *aspace;
870 struct program_space *pspace;
871 struct inferior *inf;
873 /* If all inferiors share an address space on this system, this
874 doesn't really return a new address space; otherwise, it
876 aspace = maybe_new_address_space ();
877 pspace = new program_space (aspace);
878 inf = add_inferior (0);
879 inf->pspace = pspace;
880 inf->aspace = pspace->aspace;
881 inf->gdbarch = orginf->gdbarch;
883 /* If the original inferior had a user specified target
884 description, make the clone use it too. */
885 if (target_desc_info_from_user_p (inf->tdesc_info))
886 copy_inferior_target_desc_info (inf, orginf);
888 printf_filtered (_("Added inferior %d.\n"), inf->num);
890 set_current_inferior (inf);
891 switch_to_no_thread ();
892 clone_program_space (pspace, orginf->pspace);
896 /* Print notices when new inferiors are created and die. */
898 show_print_inferior_events (struct ui_file *file, int from_tty,
899 struct cmd_list_element *c, const char *value)
901 fprintf_filtered (file, _("Printing of inferior events is %s.\n"), value);
904 /* Return a new value for the selected inferior's id. */
906 static struct value *
907 inferior_id_make_value (struct gdbarch *gdbarch, struct internalvar *var,
910 struct inferior *inf = current_inferior ();
912 return value_from_longest (builtin_type (gdbarch)->builtin_int, inf->num);
915 /* Implementation of `$_inferior' variable. */
917 static const struct internalvar_funcs inferior_funcs =
919 inferior_id_make_value,
927 initialize_inferiors (void)
929 struct cmd_list_element *c = NULL;
931 /* There's always one inferior. Note that this function isn't an
932 automatic _initialize_foo function, since other _initialize_foo
933 routines may need to install their per-inferior data keys. We
934 can only allocate an inferior when all those modules have done
935 that. Do this after initialize_progspace, due to the
936 current_program_space reference. */
937 current_inferior_ = add_inferior_silent (0);
938 current_inferior_->incref ();
939 current_inferior_->pspace = current_program_space;
940 current_inferior_->aspace = current_program_space->aspace;
941 /* The architecture will be initialized shortly, by
942 initialize_current_architecture. */
944 add_info ("inferiors", info_inferiors_command,
945 _("Print a list of inferiors being managed.\n\
946 Usage: info inferiors [ID]...\n\
947 If IDs are specified, the list is limited to just those inferiors.\n\
948 By default all inferiors are displayed."));
950 c = add_com ("add-inferior", no_class, add_inferior_command, _("\
951 Add a new inferior.\n\
952 Usage: add-inferior [-copies N] [-exec FILENAME]\n\
953 N is the optional number of inferiors to add, default is 1.\n\
954 FILENAME is the file name of the executable to use\n\
956 set_cmd_completer (c, filename_completer);
958 add_com ("remove-inferiors", no_class, remove_inferior_command, _("\
959 Remove inferior ID (or list of IDs).\n\
960 Usage: remove-inferiors ID..."));
962 add_com ("clone-inferior", no_class, clone_inferior_command, _("\
963 Clone inferior ID.\n\
964 Usage: clone-inferior [-copies N] [ID]\n\
965 Add N copies of inferior ID. The new inferior has the same\n\
966 executable loaded as the copied inferior. If -copies is not specified,\n\
967 adds 1 copy. If ID is not specified, it is the current inferior\n\
970 add_cmd ("inferiors", class_run, detach_inferior_command, _("\
971 Detach from inferior ID (or list of IDS).\n\
972 Usage; detach inferiors ID..."),
975 add_cmd ("inferiors", class_run, kill_inferior_command, _("\
976 Kill inferior ID (or list of IDs).\n\
977 Usage: kill inferiors ID..."),
980 add_cmd ("inferior", class_run, inferior_command, _("\
981 Use this command to switch between inferiors.\n\
982 Usage: inferior ID\n\
983 The new inferior ID must be currently known."),
986 add_setshow_boolean_cmd ("inferior-events", no_class,
987 &print_inferior_events, _("\
988 Set printing of inferior events (e.g., inferior start and exit)."), _("\
989 Show printing of inferior events (e.g., inferior start and exit)."), NULL,
991 show_print_inferior_events,
992 &setprintlist, &showprintlist);
994 create_internalvar_type_lazy ("_inferior", &inferior_funcs, NULL);