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"
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;
48 /* Print notices on inferior events (attach, detach, etc.), set with
49 `set print inferior-events'. */
50 static int print_inferior_events = 0;
52 /* The Current Inferior. This is a strong reference. I.e., whenever
53 an inferior is the current inferior, its refcount is
55 static struct inferior *current_inferior_ = NULL;
58 current_inferior (void)
60 return current_inferior_;
64 set_current_inferior (struct inferior *inf)
66 /* There's always an inferior. */
67 gdb_assert (inf != NULL);
70 current_inferior_->decref ();
71 current_inferior_ = inf;
74 private_inferior::~private_inferior () = default;
76 inferior::~inferior ()
80 discard_all_inferior_continuations (inf);
81 inferior_free_data (inf);
83 xfree (inf->terminal);
84 target_desc_info_free (inf->tdesc_info);
87 inferior::inferior (int pid_)
88 : num (++highest_inferior_num),
90 environment (gdb_environ::from_host_environ ()),
93 inferior_alloc_data (this);
97 add_inferior_silent (int pid)
99 inferior *inf = new inferior (pid);
101 if (inferior_list == NULL)
107 for (last = inferior_list; last->next != NULL; last = last->next)
112 observer_notify_inferior_added (inf);
115 inferior_appeared (inf, pid);
121 add_inferior (int pid)
123 struct inferior *inf = add_inferior_silent (pid);
125 if (print_inferior_events)
126 printf_unfiltered (_("[New inferior %d]\n"), pid);
131 struct delete_thread_of_inferior_arg
138 delete_thread_of_inferior (struct thread_info *tp, void *data)
140 struct delete_thread_of_inferior_arg *arg
141 = (struct delete_thread_of_inferior_arg *) data;
143 if (ptid_get_pid (tp->ptid) == arg->pid)
146 delete_thread_silent (tp->ptid);
148 delete_thread (tp->ptid);
155 delete_inferior (struct inferior *todel)
157 struct inferior *inf, *infprev;
158 struct delete_thread_of_inferior_arg arg;
162 for (inf = inferior_list; inf; infprev = inf, inf = inf->next)
172 iterate_over_threads (delete_thread_of_inferior, &arg);
175 infprev->next = inf->next;
177 inferior_list = inf->next;
179 observer_notify_inferior_removed (inf);
181 /* If this program space is rendered useless, remove it. */
182 if (program_space_empty_p (inf->pspace))
183 delete_program_space (inf->pspace);
188 /* If SILENT then be quiet -- don't announce a inferior exit, or the
189 exit of its threads. */
192 exit_inferior_1 (struct inferior *inftoex, int silent)
194 struct inferior *inf;
195 struct delete_thread_of_inferior_arg arg;
197 for (inf = inferior_list; inf; inf = inf->next)
207 iterate_over_threads (delete_thread_of_inferior, &arg);
209 observer_notify_inferior_exit (inf);
215 if (inf->vfork_parent != NULL)
217 inf->vfork_parent->vfork_child = NULL;
218 inf->vfork_parent = NULL;
220 if (inf->vfork_child != NULL)
222 inf->vfork_child->vfork_parent = NULL;
223 inf->vfork_child = NULL;
226 inf->pending_detach = 0;
230 exit_inferior (int pid)
232 struct inferior *inf = find_inferior_pid (pid);
234 exit_inferior_1 (inf, 0);
236 if (print_inferior_events)
237 printf_unfiltered (_("[Inferior %d exited]\n"), pid);
241 exit_inferior_silent (int pid)
243 struct inferior *inf = find_inferior_pid (pid);
245 exit_inferior_1 (inf, 1);
249 exit_inferior_num_silent (int num)
251 struct inferior *inf = find_inferior_id (num);
253 exit_inferior_1 (inf, 1);
256 /* See inferior.h. */
259 detach_inferior (inferior *inf)
261 /* Save the pid, since exit_inferior_1 will reset it. */
264 exit_inferior_1 (inf, 0);
266 if (print_inferior_events)
267 printf_unfiltered (_("[Inferior %d detached]\n"), pid);
270 /* See inferior.h. */
273 detach_inferior (int pid)
275 detach_inferior (find_inferior_pid (pid));
279 inferior_appeared (struct inferior *inf, int pid)
282 inf->has_exit_code = 0;
285 observer_notify_inferior_appeared (inf);
289 discard_all_inferiors (void)
291 struct inferior *inf;
293 for (inf = inferior_list; inf; inf = inf->next)
296 exit_inferior_silent (inf->pid);
301 find_inferior_id (int num)
303 struct inferior *inf;
305 for (inf = inferior_list; inf; inf = inf->next)
313 find_inferior_pid (int pid)
315 struct inferior *inf;
317 /* Looking for inferior pid == 0 is always wrong, and indicative of
318 a bug somewhere else. There may be more than one with pid == 0,
320 gdb_assert (pid != 0);
322 for (inf = inferior_list; inf; inf = inf->next)
332 find_inferior_ptid (ptid_t ptid)
334 return find_inferior_pid (ptid_get_pid (ptid));
337 /* See inferior.h. */
340 find_inferior_for_program_space (struct program_space *pspace)
342 struct inferior *inf = current_inferior ();
344 if (inf->pspace == pspace)
347 for (inf = inferior_list; inf != NULL; inf = inf->next)
349 if (inf->pspace == pspace)
357 iterate_over_inferiors (int (*callback) (struct inferior *, void *),
360 struct inferior *inf, *infnext;
362 for (inf = inferior_list; inf; inf = infnext)
365 if ((*callback) (inf, data))
373 valid_gdb_inferior_id (int num)
375 struct inferior *inf;
377 for (inf = inferior_list; inf; inf = inf->next)
385 pid_to_gdb_inferior_id (int pid)
387 struct inferior *inf;
389 for (inf = inferior_list; inf; inf = inf->next)
397 gdb_inferior_id_to_pid (int num)
399 struct inferior *inferior = find_inferior_id (num);
401 return inferior->pid;
407 in_inferior_list (int pid)
409 struct inferior *inf;
411 for (inf = inferior_list; inf; inf = inf->next)
419 have_inferiors (void)
421 struct inferior *inf;
423 for (inf = inferior_list; inf; inf = inf->next)
430 /* Return the number of live inferiors. We account for the case
431 where an inferior might have a non-zero pid but no threads, as
432 in the middle of a 'mourn' operation. */
435 number_of_live_inferiors (void)
437 struct inferior *inf;
440 for (inf = inferior_list; inf; inf = inf->next)
443 struct thread_info *tp;
445 ALL_NON_EXITED_THREADS (tp)
446 if (tp && ptid_get_pid (tp->ptid) == inf->pid)
447 if (target_has_execution_1 (tp->ptid))
449 /* Found a live thread in this inferior, go to the next
459 /* Return true if there is at least one live inferior. */
462 have_live_inferiors (void)
464 return number_of_live_inferiors () > 0;
467 /* Prune away any unused inferiors, and then prune away no longer used
471 prune_inferiors (void)
473 struct inferior *ss, **ss_link;
476 ss_link = &inferior_list;
479 if (!ss->deletable ()
489 delete_inferior (ss);
494 /* Simply returns the count of inferiors. */
497 number_of_inferiors (void)
499 struct inferior *inf;
502 for (inf = inferior_list; inf != NULL; inf = inf->next)
508 /* Converts an inferior process id to a string. Like
509 target_pid_to_str, but special cases the null process. */
512 inferior_pid_to_str (int pid)
515 return target_pid_to_str (pid_to_ptid (pid));
520 /* See inferior.h. */
523 print_selected_inferior (struct ui_out *uiout)
525 struct inferior *inf = current_inferior ();
526 const char *filename = inf->pspace->pspace_exec_filename;
528 if (filename == NULL)
529 filename = _("<noexec>");
531 uiout->message (_("[Switching to inferior %d [%s] (%s)]\n"),
532 inf->num, inferior_pid_to_str (inf->pid), filename);
535 /* Prints the list of inferiors and their details on UIOUT. This is a
536 version of 'info_inferior_command' suitable for use from MI.
538 If REQUESTED_INFERIORS is not NULL, it's a list of GDB ids of the
539 inferiors that should be printed. Otherwise, all inferiors are
543 print_inferior (struct ui_out *uiout, const char *requested_inferiors)
545 struct inferior *inf;
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 uiout->message ("No inferiors.\n");
563 ui_out_emit_table table_emitter (uiout, 4, inf_count, "inferiors");
564 uiout->table_header (1, ui_left, "current", "");
565 uiout->table_header (4, ui_left, "number", "Num");
566 uiout->table_header (17, ui_left, "target-id", "Description");
567 uiout->table_header (17, ui_left, "exec", "Executable");
569 uiout->table_body ();
570 for (inf = inferior_list; inf; inf = inf->next)
572 if (!number_is_in_list (requested_inferiors, inf->num))
575 ui_out_emit_tuple tuple_emitter (uiout, NULL);
577 if (inf == current_inferior ())
578 uiout->field_string ("current", "*");
580 uiout->field_skip ("current");
582 uiout->field_int ("number", inf->num);
584 uiout->field_string ("target-id", inferior_pid_to_str (inf->pid));
586 if (inf->pspace->pspace_exec_filename != NULL)
587 uiout->field_string ("exec", inf->pspace->pspace_exec_filename);
589 uiout->field_skip ("exec");
591 /* Print extra info that isn't really fit to always present in
592 tabular form. Currently we print the vfork parent/child
593 relationships, if any. */
594 if (inf->vfork_parent)
596 uiout->text (_("\n\tis vfork child of inferior "));
597 uiout->field_int ("vfork-parent", inf->vfork_parent->num);
599 if (inf->vfork_child)
601 uiout->text (_("\n\tis vfork parent of inferior "));
602 uiout->field_int ("vfork-child", inf->vfork_child->num);
610 detach_inferior_command (const char *args, int from_tty)
612 struct thread_info *tp;
615 error (_("Requires argument (inferior id(s) to detach)"));
617 number_or_range_parser parser (args);
618 while (!parser.finished ())
620 int num = parser.get_number ();
622 if (!valid_gdb_inferior_id (num))
624 warning (_("Inferior ID %d not known."), num);
628 int pid = gdb_inferior_id_to_pid (num);
631 warning (_("Inferior ID %d is not running."), num);
635 tp = any_thread_of_process (pid);
638 warning (_("Inferior ID %d has no threads."), num);
642 switch_to_thread (tp->ptid);
644 detach_command (NULL, from_tty);
649 kill_inferior_command (const char *args, int from_tty)
651 struct thread_info *tp;
654 error (_("Requires argument (inferior id(s) to kill)"));
656 number_or_range_parser parser (args);
657 while (!parser.finished ())
659 int num = parser.get_number ();
661 if (!valid_gdb_inferior_id (num))
663 warning (_("Inferior ID %d not known."), num);
667 int pid = gdb_inferior_id_to_pid (num);
670 warning (_("Inferior ID %d is not running."), num);
674 tp = any_thread_of_process (pid);
677 warning (_("Inferior ID %d has no threads."), num);
681 switch_to_thread (tp->ptid);
686 bfd_cache_close_all ();
690 inferior_command (const char *args, int from_tty)
692 struct inferior *inf;
695 num = parse_and_eval_long (args);
697 inf = find_inferior_id (num);
699 error (_("Inferior ID %d not known."), num);
703 if (inf->pid != ptid_get_pid (inferior_ptid))
705 struct thread_info *tp;
707 tp = any_thread_of_process (inf->pid);
709 error (_("Inferior has no threads."));
711 switch_to_thread (tp->ptid);
714 observer_notify_user_selected_context_changed
715 (USER_SELECTED_INFERIOR
716 | USER_SELECTED_THREAD
717 | USER_SELECTED_FRAME);
721 set_current_inferior (inf);
722 switch_to_thread (null_ptid);
723 set_current_program_space (inf->pspace);
725 observer_notify_user_selected_context_changed (USER_SELECTED_INFERIOR);
729 /* Print information about currently known inferiors. */
732 info_inferiors_command (const char *args, int from_tty)
734 print_inferior (current_uiout, args);
737 /* remove-inferior ID */
740 remove_inferior_command (const char *args, int from_tty)
742 if (args == NULL || *args == '\0')
743 error (_("Requires an argument (inferior id(s) to remove)"));
745 number_or_range_parser parser (args);
746 while (!parser.finished ())
748 int num = parser.get_number ();
749 struct inferior *inf = find_inferior_id (num);
753 warning (_("Inferior ID %d not known."), num);
757 if (!inf->deletable ())
759 warning (_("Can not remove current inferior %d."), num);
765 warning (_("Can not remove active inferior %d."), num);
769 delete_inferior (inf);
774 add_inferior_with_spaces (void)
776 struct address_space *aspace;
777 struct program_space *pspace;
778 struct inferior *inf;
779 struct gdbarch_info info;
781 /* If all inferiors share an address space on this system, this
782 doesn't really return a new address space; otherwise, it
784 aspace = maybe_new_address_space ();
785 pspace = add_program_space (aspace);
786 inf = add_inferior (0);
787 inf->pspace = pspace;
788 inf->aspace = pspace->aspace;
790 /* Setup the inferior's initial arch, based on information obtained
791 from the global "set ..." options. */
792 gdbarch_info_init (&info);
793 inf->gdbarch = gdbarch_find_by_info (info);
794 /* The "set ..." options reject invalid settings, so we should
795 always have a valid arch by now. */
796 gdb_assert (inf->gdbarch != NULL);
801 /* add-inferior [-copies N] [-exec FILENAME] */
804 add_inferior_command (const char *args, int from_tty)
807 gdb::unique_xmalloc_ptr<char> exec;
808 symfile_add_flags add_flags = 0;
811 add_flags |= SYMFILE_VERBOSE;
815 gdb_argv built_argv (args);
817 for (char **argv = built_argv.get (); *argv != NULL; argv++)
821 if (strcmp (*argv, "-copies") == 0)
825 error (_("No argument to -copies"));
826 copies = parse_and_eval_long (*argv);
828 else if (strcmp (*argv, "-exec") == 0)
832 error (_("No argument to -exec"));
833 exec.reset (tilde_expand (*argv));
837 error (_("Invalid argument"));
841 scoped_restore_current_pspace_and_thread restore_pspace_thread;
843 for (i = 0; i < copies; ++i)
845 struct inferior *inf = add_inferior_with_spaces ();
847 printf_filtered (_("Added inferior %d\n"), inf->num);
851 /* Switch over temporarily, while reading executable and
853 set_current_program_space (inf->pspace);
854 set_current_inferior (inf);
855 switch_to_thread (null_ptid);
857 exec_file_attach (exec.get (), from_tty);
858 symbol_file_add_main (exec.get (), add_flags);
863 /* clone-inferior [-copies N] [ID] */
866 clone_inferior_command (const char *args, int from_tty)
869 struct inferior *orginf = NULL;
873 gdb_argv built_argv (args);
875 char **argv = built_argv.get ();
876 for (; *argv != NULL; argv++)
880 if (strcmp (*argv, "-copies") == 0)
884 error (_("No argument to -copies"));
885 copies = parse_and_eval_long (*argv);
888 error (_("Invalid copies number"));
897 /* The first non-option (-) argument specified the
899 num = parse_and_eval_long (*argv);
900 orginf = find_inferior_id (num);
903 error (_("Inferior ID %d not known."), num);
907 error (_("Invalid argument"));
912 /* If no inferior id was specified, then the user wants to clone the
915 orginf = current_inferior ();
917 scoped_restore_current_pspace_and_thread restore_pspace_thread;
919 for (i = 0; i < copies; ++i)
921 struct address_space *aspace;
922 struct program_space *pspace;
923 struct inferior *inf;
925 /* If all inferiors share an address space on this system, this
926 doesn't really return a new address space; otherwise, it
928 aspace = maybe_new_address_space ();
929 pspace = add_program_space (aspace);
930 inf = add_inferior (0);
931 inf->pspace = pspace;
932 inf->aspace = pspace->aspace;
933 inf->gdbarch = orginf->gdbarch;
935 /* If the original inferior had a user specified target
936 description, make the clone use it too. */
937 if (target_desc_info_from_user_p (inf->tdesc_info))
938 copy_inferior_target_desc_info (inf, orginf);
940 printf_filtered (_("Added inferior %d.\n"), inf->num);
942 set_current_inferior (inf);
943 switch_to_thread (null_ptid);
944 clone_program_space (pspace, orginf->pspace);
948 /* Print notices when new inferiors are created and die. */
950 show_print_inferior_events (struct ui_file *file, int from_tty,
951 struct cmd_list_element *c, const char *value)
953 fprintf_filtered (file, _("Printing of inferior events is %s.\n"), value);
956 /* Return a new value for the selected inferior's id. */
958 static struct value *
959 inferior_id_make_value (struct gdbarch *gdbarch, struct internalvar *var,
962 struct inferior *inf = current_inferior ();
964 return value_from_longest (builtin_type (gdbarch)->builtin_int, inf->num);
967 /* Implementation of `$_inferior' variable. */
969 static const struct internalvar_funcs inferior_funcs =
971 inferior_id_make_value,
979 initialize_inferiors (void)
981 struct cmd_list_element *c = NULL;
983 /* There's always one inferior. Note that this function isn't an
984 automatic _initialize_foo function, since other _initialize_foo
985 routines may need to install their per-inferior data keys. We
986 can only allocate an inferior when all those modules have done
987 that. Do this after initialize_progspace, due to the
988 current_program_space reference. */
989 current_inferior_ = add_inferior (0);
990 current_inferior_->incref ();
991 current_inferior_->pspace = current_program_space;
992 current_inferior_->aspace = current_program_space->aspace;
993 /* The architecture will be initialized shortly, by
994 initialize_current_architecture. */
996 add_info ("inferiors", info_inferiors_command,
997 _("IDs of specified inferiors (all inferiors if no argument)."));
999 c = add_com ("add-inferior", no_class, add_inferior_command, _("\
1000 Add a new inferior.\n\
1001 Usage: add-inferior [-copies <N>] [-exec <FILENAME>]\n\
1002 N is the optional number of inferiors to add, default is 1.\n\
1003 FILENAME is the file name of the executable to use\n\
1004 as main program."));
1005 set_cmd_completer (c, filename_completer);
1007 add_com ("remove-inferiors", no_class, remove_inferior_command, _("\
1008 Remove inferior ID (or list of IDs).\n\
1009 Usage: remove-inferiors ID..."));
1011 add_com ("clone-inferior", no_class, clone_inferior_command, _("\
1012 Clone inferior ID.\n\
1013 Usage: clone-inferior [-copies <N>] [ID]\n\
1014 Add N copies of inferior ID. The new inferior has the same\n\
1015 executable loaded as the copied inferior. If -copies is not specified,\n\
1016 adds 1 copy. If ID is not specified, it is the current inferior\n\
1019 add_cmd ("inferiors", class_run, detach_inferior_command, _("\
1020 Detach from inferior ID (or list of IDS)."),
1023 add_cmd ("inferiors", class_run, kill_inferior_command, _("\
1024 Kill inferior ID (or list of IDs)."),
1027 add_cmd ("inferior", class_run, inferior_command, _("\
1028 Use this command to switch between inferiors.\n\
1029 The new inferior ID must be currently known."),
1032 add_setshow_boolean_cmd ("inferior-events", no_class,
1033 &print_inferior_events, _("\
1034 Set printing of inferior events (e.g., inferior start and exit)."), _("\
1035 Show printing of inferior events (e.g., inferior start and exit)."), NULL,
1037 show_print_inferior_events,
1038 &setprintlist, &showprintlist);
1040 create_internalvar_type_lazy ("_inferior", &inferior_funcs, NULL);