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 (ptid_t (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 (tp->ptid.pid () == 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);
253 /* See inferior.h. */
256 detach_inferior (inferior *inf)
258 /* Save the pid, since exit_inferior_1 will reset it. */
261 exit_inferior_1 (inf, 0);
263 if (print_inferior_events)
264 printf_unfiltered (_("[Inferior %d (%s) detached]\n"),
266 target_pid_to_str (ptid_t (pid)));
270 inferior_appeared (struct inferior *inf, int pid)
273 inf->has_exit_code = 0;
276 gdb::observers::inferior_appeared.notify (inf);
280 discard_all_inferiors (void)
282 struct inferior *inf;
284 for (inf = inferior_list; inf; inf = inf->next)
287 exit_inferior_silent (inf);
292 find_inferior_id (int num)
294 struct inferior *inf;
296 for (inf = inferior_list; inf; inf = inf->next)
304 find_inferior_pid (int pid)
306 struct inferior *inf;
308 /* Looking for inferior pid == 0 is always wrong, and indicative of
309 a bug somewhere else. There may be more than one with pid == 0,
311 gdb_assert (pid != 0);
313 for (inf = inferior_list; inf; inf = inf->next)
323 find_inferior_ptid (ptid_t ptid)
325 return find_inferior_pid (ptid.pid ());
328 /* See inferior.h. */
331 find_inferior_for_program_space (struct program_space *pspace)
333 struct inferior *inf = current_inferior ();
335 if (inf->pspace == pspace)
338 for (inf = inferior_list; inf != NULL; inf = inf->next)
340 if (inf->pspace == pspace)
348 iterate_over_inferiors (int (*callback) (struct inferior *, void *),
351 struct inferior *inf, *infnext;
353 for (inf = inferior_list; inf; inf = infnext)
356 if ((*callback) (inf, data))
364 have_inferiors (void)
366 struct inferior *inf;
368 for (inf = inferior_list; inf; inf = inf->next)
375 /* Return the number of live inferiors. We account for the case
376 where an inferior might have a non-zero pid but no threads, as
377 in the middle of a 'mourn' operation. */
380 number_of_live_inferiors (void)
382 struct inferior *inf;
385 for (inf = inferior_list; inf; inf = inf->next)
388 struct thread_info *tp;
390 ALL_NON_EXITED_THREADS (tp)
391 if (tp && tp->ptid.pid () == inf->pid)
392 if (target_has_execution_1 (tp->ptid))
394 /* Found a live thread in this inferior, go to the next
404 /* Return true if there is at least one live inferior. */
407 have_live_inferiors (void)
409 return number_of_live_inferiors () > 0;
412 /* Prune away any unused inferiors, and then prune away no longer used
416 prune_inferiors (void)
418 struct inferior *ss, **ss_link;
421 ss_link = &inferior_list;
424 if (!ss->deletable ()
434 delete_inferior (ss);
439 /* Simply returns the count of inferiors. */
442 number_of_inferiors (void)
444 struct inferior *inf;
447 for (inf = inferior_list; inf != NULL; inf = inf->next)
453 /* Converts an inferior process id to a string. Like
454 target_pid_to_str, but special cases the null process. */
457 inferior_pid_to_str (int pid)
460 return target_pid_to_str (ptid_t (pid));
465 /* See inferior.h. */
468 print_selected_inferior (struct ui_out *uiout)
470 struct inferior *inf = current_inferior ();
471 const char *filename = inf->pspace->pspace_exec_filename;
473 if (filename == NULL)
474 filename = _("<noexec>");
476 uiout->message (_("[Switching to inferior %d [%s] (%s)]\n"),
477 inf->num, inferior_pid_to_str (inf->pid), filename);
480 /* Prints the list of inferiors and their details on UIOUT. This is a
481 version of 'info_inferior_command' suitable for use from MI.
483 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
484 inferiors that should be printed. Otherwise, all inferiors are
488 print_inferior (struct ui_out *uiout, const char *requested_inferiors)
490 struct inferior *inf;
493 /* Compute number of inferiors we will print. */
494 for (inf = inferior_list; inf; inf = inf->next)
496 if (!number_is_in_list (requested_inferiors, inf->num))
504 uiout->message ("No inferiors.\n");
508 ui_out_emit_table table_emitter (uiout, 4, inf_count, "inferiors");
509 uiout->table_header (1, ui_left, "current", "");
510 uiout->table_header (4, ui_left, "number", "Num");
511 uiout->table_header (17, ui_left, "target-id", "Description");
512 uiout->table_header (17, ui_left, "exec", "Executable");
514 uiout->table_body ();
515 for (inf = inferior_list; inf; inf = inf->next)
517 if (!number_is_in_list (requested_inferiors, inf->num))
520 ui_out_emit_tuple tuple_emitter (uiout, NULL);
522 if (inf == current_inferior ())
523 uiout->field_string ("current", "*");
525 uiout->field_skip ("current");
527 uiout->field_int ("number", inf->num);
529 uiout->field_string ("target-id", inferior_pid_to_str (inf->pid));
531 if (inf->pspace->pspace_exec_filename != NULL)
532 uiout->field_string ("exec", inf->pspace->pspace_exec_filename);
534 uiout->field_skip ("exec");
536 /* Print extra info that isn't really fit to always present in
537 tabular form. Currently we print the vfork parent/child
538 relationships, if any. */
539 if (inf->vfork_parent)
541 uiout->text (_("\n\tis vfork child of inferior "));
542 uiout->field_int ("vfork-parent", inf->vfork_parent->num);
544 if (inf->vfork_child)
546 uiout->text (_("\n\tis vfork parent of inferior "));
547 uiout->field_int ("vfork-child", inf->vfork_child->num);
555 detach_inferior_command (const char *args, int from_tty)
558 error (_("Requires argument (inferior id(s) to detach)"));
560 number_or_range_parser parser (args);
561 while (!parser.finished ())
563 int num = parser.get_number ();
565 inferior *inf = find_inferior_id (num);
568 warning (_("Inferior ID %d not known."), num);
574 warning (_("Inferior ID %d is not running."), num);
578 thread_info *tp = any_thread_of_inferior (inf);
581 warning (_("Inferior ID %d has no threads."), num);
585 switch_to_thread (tp);
587 detach_command (NULL, from_tty);
592 kill_inferior_command (const char *args, int from_tty)
595 error (_("Requires argument (inferior id(s) to kill)"));
597 number_or_range_parser parser (args);
598 while (!parser.finished ())
600 int num = parser.get_number ();
602 inferior *inf = find_inferior_id (num);
605 warning (_("Inferior ID %d not known."), num);
611 warning (_("Inferior ID %d is not running."), num);
615 thread_info *tp = any_thread_of_inferior (inf);
618 warning (_("Inferior ID %d has no threads."), num);
622 switch_to_thread (tp);
627 bfd_cache_close_all ();
631 inferior_command (const char *args, int from_tty)
633 struct inferior *inf;
636 num = parse_and_eval_long (args);
638 inf = find_inferior_id (num);
640 error (_("Inferior ID %d not known."), num);
644 if (inf != current_inferior ())
646 thread_info *tp = any_thread_of_inferior (inf);
648 error (_("Inferior has no threads."));
650 switch_to_thread (tp);
653 gdb::observers::user_selected_context_changed.notify
654 (USER_SELECTED_INFERIOR
655 | USER_SELECTED_THREAD
656 | USER_SELECTED_FRAME);
660 set_current_inferior (inf);
661 switch_to_no_thread ();
662 set_current_program_space (inf->pspace);
664 gdb::observers::user_selected_context_changed.notify
665 (USER_SELECTED_INFERIOR);
669 /* Print information about currently known inferiors. */
672 info_inferiors_command (const char *args, int from_tty)
674 print_inferior (current_uiout, args);
677 /* remove-inferior ID */
680 remove_inferior_command (const char *args, int from_tty)
682 if (args == NULL || *args == '\0')
683 error (_("Requires an argument (inferior id(s) to remove)"));
685 number_or_range_parser parser (args);
686 while (!parser.finished ())
688 int num = parser.get_number ();
689 struct inferior *inf = find_inferior_id (num);
693 warning (_("Inferior ID %d not known."), num);
697 if (!inf->deletable ())
699 warning (_("Can not remove current inferior %d."), num);
705 warning (_("Can not remove active inferior %d."), num);
709 delete_inferior (inf);
714 add_inferior_with_spaces (void)
716 struct address_space *aspace;
717 struct program_space *pspace;
718 struct inferior *inf;
719 struct gdbarch_info info;
721 /* If all inferiors share an address space on this system, this
722 doesn't really return a new address space; otherwise, it
724 aspace = maybe_new_address_space ();
725 pspace = new program_space (aspace);
726 inf = add_inferior (0);
727 inf->pspace = pspace;
728 inf->aspace = pspace->aspace;
730 /* Setup the inferior's initial arch, based on information obtained
731 from the global "set ..." options. */
732 gdbarch_info_init (&info);
733 inf->gdbarch = gdbarch_find_by_info (info);
734 /* The "set ..." options reject invalid settings, so we should
735 always have a valid arch by now. */
736 gdb_assert (inf->gdbarch != NULL);
741 /* add-inferior [-copies N] [-exec FILENAME] */
744 add_inferior_command (const char *args, int from_tty)
747 gdb::unique_xmalloc_ptr<char> exec;
748 symfile_add_flags add_flags = 0;
751 add_flags |= SYMFILE_VERBOSE;
755 gdb_argv built_argv (args);
757 for (char **argv = built_argv.get (); *argv != NULL; argv++)
761 if (strcmp (*argv, "-copies") == 0)
765 error (_("No argument to -copies"));
766 copies = parse_and_eval_long (*argv);
768 else if (strcmp (*argv, "-exec") == 0)
772 error (_("No argument to -exec"));
773 exec.reset (tilde_expand (*argv));
777 error (_("Invalid argument"));
781 scoped_restore_current_pspace_and_thread restore_pspace_thread;
783 for (i = 0; i < copies; ++i)
785 struct inferior *inf = add_inferior_with_spaces ();
787 printf_filtered (_("Added inferior %d\n"), inf->num);
791 /* Switch over temporarily, while reading executable and
793 set_current_program_space (inf->pspace);
794 set_current_inferior (inf);
795 switch_to_no_thread ();
797 exec_file_attach (exec.get (), from_tty);
798 symbol_file_add_main (exec.get (), add_flags);
803 /* clone-inferior [-copies N] [ID] */
806 clone_inferior_command (const char *args, int from_tty)
809 struct inferior *orginf = NULL;
813 gdb_argv built_argv (args);
815 char **argv = built_argv.get ();
816 for (; *argv != NULL; argv++)
820 if (strcmp (*argv, "-copies") == 0)
824 error (_("No argument to -copies"));
825 copies = parse_and_eval_long (*argv);
828 error (_("Invalid copies number"));
837 /* The first non-option (-) argument specified the
839 num = parse_and_eval_long (*argv);
840 orginf = find_inferior_id (num);
843 error (_("Inferior ID %d not known."), num);
847 error (_("Invalid argument"));
852 /* If no inferior id was specified, then the user wants to clone the
855 orginf = current_inferior ();
857 scoped_restore_current_pspace_and_thread restore_pspace_thread;
859 for (i = 0; i < copies; ++i)
861 struct address_space *aspace;
862 struct program_space *pspace;
863 struct inferior *inf;
865 /* If all inferiors share an address space on this system, this
866 doesn't really return a new address space; otherwise, it
868 aspace = maybe_new_address_space ();
869 pspace = new program_space (aspace);
870 inf = add_inferior (0);
871 inf->pspace = pspace;
872 inf->aspace = pspace->aspace;
873 inf->gdbarch = orginf->gdbarch;
875 /* If the original inferior had a user specified target
876 description, make the clone use it too. */
877 if (target_desc_info_from_user_p (inf->tdesc_info))
878 copy_inferior_target_desc_info (inf, orginf);
880 printf_filtered (_("Added inferior %d.\n"), inf->num);
882 set_current_inferior (inf);
883 switch_to_no_thread ();
884 clone_program_space (pspace, orginf->pspace);
888 /* Print notices when new inferiors are created and die. */
890 show_print_inferior_events (struct ui_file *file, int from_tty,
891 struct cmd_list_element *c, const char *value)
893 fprintf_filtered (file, _("Printing of inferior events is %s.\n"), value);
896 /* Return a new value for the selected inferior's id. */
898 static struct value *
899 inferior_id_make_value (struct gdbarch *gdbarch, struct internalvar *var,
902 struct inferior *inf = current_inferior ();
904 return value_from_longest (builtin_type (gdbarch)->builtin_int, inf->num);
907 /* Implementation of `$_inferior' variable. */
909 static const struct internalvar_funcs inferior_funcs =
911 inferior_id_make_value,
919 initialize_inferiors (void)
921 struct cmd_list_element *c = NULL;
923 /* There's always one inferior. Note that this function isn't an
924 automatic _initialize_foo function, since other _initialize_foo
925 routines may need to install their per-inferior data keys. We
926 can only allocate an inferior when all those modules have done
927 that. Do this after initialize_progspace, due to the
928 current_program_space reference. */
929 current_inferior_ = add_inferior_silent (0);
930 current_inferior_->incref ();
931 current_inferior_->pspace = current_program_space;
932 current_inferior_->aspace = current_program_space->aspace;
933 /* The architecture will be initialized shortly, by
934 initialize_current_architecture. */
936 add_info ("inferiors", info_inferiors_command,
937 _("Print a list of inferiors being managed.\n\
938 Usage: info inferiors [ID]...\n\
939 If IDs are specified, the list is limited to just those inferiors.\n\
940 By default all inferiors are displayed."));
942 c = add_com ("add-inferior", no_class, add_inferior_command, _("\
943 Add a new inferior.\n\
944 Usage: add-inferior [-copies N] [-exec FILENAME]\n\
945 N is the optional number of inferiors to add, default is 1.\n\
946 FILENAME is the file name of the executable to use\n\
948 set_cmd_completer (c, filename_completer);
950 add_com ("remove-inferiors", no_class, remove_inferior_command, _("\
951 Remove inferior ID (or list of IDs).\n\
952 Usage: remove-inferiors ID..."));
954 add_com ("clone-inferior", no_class, clone_inferior_command, _("\
955 Clone inferior ID.\n\
956 Usage: clone-inferior [-copies N] [ID]\n\
957 Add N copies of inferior ID. The new inferior has the same\n\
958 executable loaded as the copied inferior. If -copies is not specified,\n\
959 adds 1 copy. If ID is not specified, it is the current inferior\n\
962 add_cmd ("inferiors", class_run, detach_inferior_command, _("\
963 Detach from inferior ID (or list of IDS).\n\
964 Usage; detach inferiors ID..."),
967 add_cmd ("inferiors", class_run, kill_inferior_command, _("\
968 Kill inferior ID (or list of IDs).\n\
969 Usage: kill inferiors ID..."),
972 add_cmd ("inferior", class_run, inferior_command, _("\
973 Use this command to switch between inferiors.\n\
974 Usage: inferior ID\n\
975 The new inferior ID must be currently known."),
978 add_setshow_boolean_cmd ("inferior-events", no_class,
979 &print_inferior_events, _("\
980 Set printing of inferior events (e.g., inferior start and exit)."), _("\
981 Show printing of inferior events (e.g., inferior start and exit)."), NULL,
983 show_print_inferior_events,
984 &setprintlist, &showprintlist);
986 create_internalvar_type_lazy ("_inferior", &inferior_funcs, NULL);