1 /* GNU/Linux native-dependent code for debugging multiple forks.
3 Copyright (C) 2005-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/>. */
21 #include "arch-utils.h"
27 #include "gdb_assert.h"
28 #include "gdb_string.h"
29 #include "linux-fork.h"
30 #include "linux-nat.h"
31 #include "gdbthread.h"
34 #include <sys/ptrace.h>
36 #include "gdb_dirent.h"
39 struct fork_info *fork_list;
40 static int highest_fork_num;
42 /* Prevent warning from -Wmissing-prototypes. */
43 extern void _initialize_linux_fork (void);
45 /* Fork list data structure: */
48 struct fork_info *next;
51 int num; /* Convenient handle (GDB fork id). */
52 struct regcache *savedregs; /* Convenient for info fork, saves
53 having to actually switch contexts. */
54 int clobber_regs; /* True if we should restore saved regs. */
55 off_t *filepos; /* Set of open file descriptors' offsets. */
59 /* Fork list methods: */
64 return (fork_list != NULL);
67 /* Add a fork to the internal fork list. */
74 if (fork_list == NULL && pid != PIDGET (inferior_ptid))
76 /* Special case -- if this is the first fork in the list
77 (the list is hitherto empty), and if this new fork is
78 NOT the current inferior_ptid, then add inferior_ptid
79 first, as a special zeroeth fork id. */
80 highest_fork_num = -1;
81 add_fork (PIDGET (inferior_ptid)); /* safe recursion */
84 fp = XZALLOC (struct fork_info);
85 fp->ptid = ptid_build (pid, pid, 0);
86 fp->num = ++highest_fork_num;
93 free_fork (struct fork_info *fp)
95 /* Notes on step-resume breakpoints: since this is a concern for
96 threads, let's convince ourselves that it's not a concern for
97 forks. There are two ways for a fork_info to be created. First,
98 by the checkpoint command, in which case we're at a gdb prompt
99 and there can't be any step-resume breakpoint. Second, by a fork
100 in the user program, in which case we *may* have stepped into the
101 fork call, but regardless of whether we follow the parent or the
102 child, we will return to the same place and the step-resume
103 breakpoint, if any, will take care of itself as usual. And
104 unlike threads, we do not save a private copy of the step-resume
105 breakpoint -- so we're OK. */
110 regcache_xfree (fp->savedregs);
118 delete_fork (ptid_t ptid)
120 struct fork_info *fp, *fpprev;
124 linux_nat_forget_process (ptid_get_pid (ptid));
126 for (fp = fork_list; fp; fpprev = fp, fp = fp->next)
127 if (ptid_equal (fp->ptid, ptid))
134 fpprev->next = fp->next;
136 fork_list = fp->next;
140 /* Special case: if there is now only one process in the list,
141 and if it is (hopefully!) the current inferior_ptid, then
142 remove it, leaving the list empty -- we're now down to the
143 default case of debugging a single process. */
144 if (fork_list != NULL && fork_list->next == NULL &&
145 ptid_equal (fork_list->ptid, inferior_ptid))
147 /* Last fork -- delete from list and handle as solo process
148 (should be a safe recursion). */
149 delete_fork (inferior_ptid);
153 /* Find a fork_info by matching PTID. */
154 static struct fork_info *
155 find_fork_ptid (ptid_t ptid)
157 struct fork_info *fp;
159 for (fp = fork_list; fp; fp = fp->next)
160 if (ptid_equal (fp->ptid, ptid))
166 /* Find a fork_info by matching ID. */
167 static struct fork_info *
168 find_fork_id (int num)
170 struct fork_info *fp;
172 for (fp = fork_list; fp; fp = fp->next)
179 /* Find a fork_info by matching pid. */
180 extern struct fork_info *
181 find_fork_pid (pid_t pid)
183 struct fork_info *fp;
185 for (fp = fork_list; fp; fp = fp->next)
186 if (pid == ptid_get_pid (fp->ptid))
193 fork_id_to_ptid (int num)
195 struct fork_info *fork = find_fork_id (num);
199 return pid_to_ptid (-1);
203 init_fork_list (void)
205 struct fork_info *fp, *fpnext;
210 for (fp = fork_list; fp; fp = fpnext)
219 /* Fork list <-> gdb interface. */
221 /* Utility function for fork_load/fork_save.
222 Calls lseek in the (current) inferior process. */
225 call_lseek (int fd, off_t offset, int whence)
229 snprintf (&exp[0], sizeof (exp), "lseek (%d, %ld, %d)",
230 fd, (long) offset, whence);
231 return (off_t) parse_and_eval_long (&exp[0]);
234 /* Load infrun state for the fork PTID. */
237 fork_load_infrun_state (struct fork_info *fp)
239 extern void nullify_last_target_wait_ptid ();
242 linux_nat_switch_fork (fp->ptid);
244 if (fp->savedregs && fp->clobber_regs)
245 regcache_cpy (get_current_regcache (), fp->savedregs);
247 registers_changed ();
248 reinit_frame_cache ();
250 stop_pc = regcache_read_pc (get_current_regcache ());
251 nullify_last_target_wait_ptid ();
253 /* Now restore the file positions of open file descriptors. */
256 for (i = 0; i <= fp->maxfd; i++)
257 if (fp->filepos[i] != (off_t) -1)
258 call_lseek (i, fp->filepos[i], SEEK_SET);
259 /* NOTE: I can get away with using SEEK_SET and SEEK_CUR because
260 this is native-only. If it ever has to be cross, we'll have
265 /* Save infrun state for the fork PTID.
266 Exported for use by linux child_follow_fork. */
269 fork_save_infrun_state (struct fork_info *fp, int clobber_regs)
276 regcache_xfree (fp->savedregs);
278 fp->savedregs = regcache_dup (get_current_regcache ());
279 fp->clobber_regs = clobber_regs;
283 /* Now save the 'state' (file position) of all open file descriptors.
284 Unfortunately fork does not take care of that for us... */
285 snprintf (path, PATH_MAX, "/proc/%ld/fd", (long) PIDGET (fp->ptid));
286 if ((d = opendir (path)) != NULL)
291 while ((de = readdir (d)) != NULL)
293 /* Count open file descriptors (actually find highest
295 tmp = strtol (&de->d_name[0], NULL, 10);
299 /* Allocate array of file positions. */
300 fp->filepos = xrealloc (fp->filepos,
301 (fp->maxfd + 1) * sizeof (*fp->filepos));
303 /* Initialize to -1 (invalid). */
304 for (tmp = 0; tmp <= fp->maxfd; tmp++)
305 fp->filepos[tmp] = -1;
307 /* Now find actual file positions. */
309 while ((de = readdir (d)) != NULL)
310 if (isdigit (de->d_name[0]))
312 tmp = strtol (&de->d_name[0], NULL, 10);
313 fp->filepos[tmp] = call_lseek (tmp, 0, SEEK_CUR);
320 /* Kill 'em all, let God sort 'em out... */
323 linux_fork_killall (void)
325 /* Walk list and kill every pid. No need to treat the
326 current inferior_ptid as special (we do not return a
327 status for it) -- however any process may be a child
328 or a parent, so may get a SIGCHLD from a previously
329 killed child. Wait them all out. */
330 struct fork_info *fp;
334 for (fp = fork_list; fp; fp = fp->next)
336 pid = PIDGET (fp->ptid);
338 /* Use SIGKILL instead of PTRACE_KILL because the former works even
339 if the thread is running, while the later doesn't. */
341 ret = waitpid (pid, &status, 0);
342 /* We might get a SIGCHLD instead of an exit status. This is
343 aggravated by the first kill above - a child has just
344 died. MVS comment cut-and-pasted from linux-nat. */
345 } while (ret == pid && WIFSTOPPED (status));
347 init_fork_list (); /* Clear list, prepare to start fresh. */
350 /* The current inferior_ptid has exited, but there are other viable
351 forks to debug. Delete the exiting one and context-switch to the
355 linux_fork_mourn_inferior (void)
357 /* Wait just one more time to collect the inferior's exit status.
358 Do not check whether this succeeds though, since we may be
359 dealing with a process that we attached to. Such a process will
360 only report its exit status to its original parent. */
363 waitpid (ptid_get_pid (inferior_ptid), &status, 0);
365 /* OK, presumably inferior_ptid is the one who has exited.
366 We need to delete that one from the fork_list, and switch
367 to the next available fork. */
368 delete_fork (inferior_ptid);
370 /* There should still be a fork - if there's only one left,
371 delete_fork won't remove it, because we haven't updated
372 inferior_ptid yet. */
373 gdb_assert (fork_list);
375 fork_load_infrun_state (fork_list);
376 printf_filtered (_("[Switching to %s]\n"),
377 target_pid_to_str (inferior_ptid));
379 /* If there's only one fork, switch back to non-fork mode. */
380 if (fork_list->next == NULL)
381 delete_fork (inferior_ptid);
384 /* The current inferior_ptid is being detached, but there are other
385 viable forks to debug. Detach and delete it and context-switch to
386 the first available. */
389 linux_fork_detach (char *args, int from_tty)
391 /* OK, inferior_ptid is the one we are detaching from. We need to
392 delete it from the fork_list, and switch to the next available
395 if (ptrace (PTRACE_DETACH, PIDGET (inferior_ptid), 0, 0))
396 error (_("Unable to detach %s"), target_pid_to_str (inferior_ptid));
398 delete_fork (inferior_ptid);
400 /* There should still be a fork - if there's only one left,
401 delete_fork won't remove it, because we haven't updated
402 inferior_ptid yet. */
403 gdb_assert (fork_list);
405 fork_load_infrun_state (fork_list);
408 printf_filtered (_("[Switching to %s]\n"),
409 target_pid_to_str (inferior_ptid));
411 /* If there's only one fork, switch back to non-fork mode. */
412 if (fork_list->next == NULL)
413 delete_fork (inferior_ptid);
417 inferior_call_waitpid_cleanup (void *fp)
419 struct fork_info *oldfp = fp;
423 /* Switch back to inferior_ptid. */
424 remove_breakpoints ();
425 fork_load_infrun_state (oldfp);
426 insert_breakpoints ();
431 inferior_call_waitpid (ptid_t pptid, int pid)
433 struct objfile *waitpid_objf;
434 struct value *waitpid_fn = NULL;
435 struct value *argv[4], *retv;
436 struct gdbarch *gdbarch = get_current_arch ();
437 struct fork_info *oldfp = NULL, *newfp = NULL;
438 struct cleanup *old_cleanup;
441 if (!ptid_equal (pptid, inferior_ptid))
443 /* Switch to pptid. */
444 oldfp = find_fork_ptid (inferior_ptid);
445 gdb_assert (oldfp != NULL);
446 newfp = find_fork_ptid (pptid);
447 gdb_assert (newfp != NULL);
448 fork_save_infrun_state (oldfp, 1);
449 remove_breakpoints ();
450 fork_load_infrun_state (newfp);
451 insert_breakpoints ();
454 old_cleanup = make_cleanup (inferior_call_waitpid_cleanup, oldfp);
456 /* Get the waitpid_fn. */
457 if (lookup_minimal_symbol ("waitpid", NULL, NULL) != NULL)
458 waitpid_fn = find_function_in_inferior ("waitpid", &waitpid_objf);
459 if (!waitpid_fn && lookup_minimal_symbol ("_waitpid", NULL, NULL) != NULL)
460 waitpid_fn = find_function_in_inferior ("_waitpid", &waitpid_objf);
465 argv[0] = value_from_longest (builtin_type (gdbarch)->builtin_int, pid);
466 argv[1] = value_from_pointer (builtin_type (gdbarch)->builtin_data_ptr, 0);
467 argv[2] = value_from_longest (builtin_type (gdbarch)->builtin_int, 0);
470 retv = call_function_by_hand (waitpid_fn, 3, argv);
471 if (value_as_long (retv) < 0)
477 do_cleanups (old_cleanup);
481 /* Fork list <-> user interface. */
484 delete_checkpoint_command (char *args, int from_tty)
487 struct fork_info *fi;
490 error (_("Requires argument (checkpoint id to delete)"));
492 ptid = fork_id_to_ptid (parse_and_eval_long (args));
493 if (ptid_equal (ptid, minus_one_ptid))
494 error (_("No such checkpoint id, %s"), args);
496 if (ptid_equal (ptid, inferior_ptid))
498 Please switch to another checkpoint before deleting the current one"));
500 if (ptrace (PTRACE_KILL, PIDGET (ptid), 0, 0))
501 error (_("Unable to kill pid %s"), target_pid_to_str (ptid));
503 fi = find_fork_ptid (ptid);
505 pptid = fi->parent_ptid;
508 printf_filtered (_("Killed %s\n"), target_pid_to_str (ptid));
512 /* If fi->parent_ptid is not a part of lwp but it's a part of checkpoint
513 list, waitpid the ptid.
514 If fi->parent_ptid is a part of lwp and it is stoped, waitpid the
516 if ((!find_thread_ptid (pptid) && find_fork_ptid (pptid))
517 || (find_thread_ptid (pptid) && is_stopped (pptid)))
519 if (inferior_call_waitpid (pptid, PIDGET (ptid)))
520 warning (_("Unable to wait pid %s"), target_pid_to_str (ptid));
525 detach_checkpoint_command (char *args, int from_tty)
530 error (_("Requires argument (checkpoint id to detach)"));
532 ptid = fork_id_to_ptid (parse_and_eval_long (args));
533 if (ptid_equal (ptid, minus_one_ptid))
534 error (_("No such checkpoint id, %s"), args);
536 if (ptid_equal (ptid, inferior_ptid))
538 Please switch to another checkpoint before detaching the current one"));
540 if (ptrace (PTRACE_DETACH, PIDGET (ptid), 0, 0))
541 error (_("Unable to detach %s"), target_pid_to_str (ptid));
544 printf_filtered (_("Detached %s\n"), target_pid_to_str (ptid));
549 /* Print information about currently known checkpoints. */
552 info_checkpoints_command (char *arg, int from_tty)
554 struct gdbarch *gdbarch = get_current_arch ();
555 struct symtab_and_line sal;
556 struct fork_info *fp;
559 struct fork_info *printed = NULL;
562 requested = (int) parse_and_eval_long (arg);
564 for (fp = fork_list; fp; fp = fp->next)
566 if (requested > 0 && fp->num != requested)
570 if (ptid_equal (fp->ptid, inferior_ptid))
572 printf_filtered ("* ");
573 pc = regcache_read_pc (get_current_regcache ());
577 printf_filtered (" ");
578 pc = regcache_read_pc (fp->savedregs);
580 printf_filtered ("%d %s", fp->num, target_pid_to_str (fp->ptid));
582 printf_filtered (_(" (main process)"));
583 printf_filtered (_(" at "));
584 fputs_filtered (paddress (gdbarch, pc), gdb_stdout);
586 sal = find_pc_line (pc, 0);
588 printf_filtered (_(", file %s"),
589 symtab_to_filename_for_display (sal.symtab));
591 printf_filtered (_(", line %d"), sal.line);
592 if (!sal.symtab && !sal.line)
594 struct bound_minimal_symbol msym;
596 msym = lookup_minimal_symbol_by_pc (pc);
598 printf_filtered (", <%s>", SYMBOL_LINKAGE_NAME (msym.minsym));
601 putchar_filtered ('\n');
606 printf_filtered (_("No checkpoint number %d.\n"), requested);
608 printf_filtered (_("No checkpoints.\n"));
612 /* The PID of the process we're checkpointing. */
613 static int checkpointing_pid = 0;
616 linux_fork_checkpointing_p (int pid)
618 return (checkpointing_pid == pid);
621 /* Callback for iterate over threads. Used to check whether
622 the current inferior is multi-threaded. Returns true as soon
623 as it sees the second thread of the current inferior. */
626 inf_has_multiple_thread_cb (struct thread_info *tp, void *data)
628 int *count_p = (int *) data;
630 if (current_inferior ()->pid == ptid_get_pid (tp->ptid))
633 /* Stop the iteration if multiple threads have been detected. */
637 /* Return true if the current inferior is multi-threaded. */
640 inf_has_multiple_threads (void)
644 iterate_over_threads (inf_has_multiple_thread_cb, &count);
649 checkpoint_command (char *args, int from_tty)
651 struct objfile *fork_objf;
652 struct gdbarch *gdbarch;
653 struct target_waitstatus last_target_waitstatus;
654 ptid_t last_target_ptid;
655 struct value *fork_fn = NULL, *ret;
656 struct fork_info *fp;
658 struct cleanup *old_chain;
660 if (!target_has_execution)
661 error (_("The program is not being run."));
663 /* Ensure that the inferior is not multithreaded. */
664 update_thread_list ();
665 if (inf_has_multiple_threads ())
666 error (_("checkpoint: can't checkpoint multiple threads."));
668 /* Make the inferior fork, record its (and gdb's) state. */
670 if (lookup_minimal_symbol ("fork", NULL, NULL) != NULL)
671 fork_fn = find_function_in_inferior ("fork", &fork_objf);
673 if (lookup_minimal_symbol ("_fork", NULL, NULL) != NULL)
674 fork_fn = find_function_in_inferior ("fork", &fork_objf);
676 error (_("checkpoint: can't find fork function in inferior."));
678 gdbarch = get_objfile_arch (fork_objf);
679 ret = value_from_longest (builtin_type (gdbarch)->builtin_int, 0);
681 /* Tell linux-nat.c that we're checkpointing this inferior. */
682 old_chain = make_cleanup_restore_integer (&checkpointing_pid);
683 checkpointing_pid = PIDGET (inferior_ptid);
685 ret = call_function_by_hand (fork_fn, 0, &ret);
686 do_cleanups (old_chain);
687 if (!ret) /* Probably can't happen. */
688 error (_("checkpoint: call_function_by_hand returned null."));
690 retpid = value_as_long (ret);
691 get_last_target_status (&last_target_ptid, &last_target_waitstatus);
696 printf_filtered (_("checkpoint: fork returned pid %ld.\n"),
700 parent_pid = ptid_get_lwp (last_target_ptid);
702 parent_pid = ptid_get_pid (last_target_ptid);
703 printf_filtered (_(" gdb says parent = %ld.\n"),
708 fp = find_fork_pid (retpid);
710 error (_("Failed to find new fork"));
711 fork_save_infrun_state (fp, 1);
712 fp->parent_ptid = last_target_ptid;
716 linux_fork_context (struct fork_info *newfp, int from_tty)
718 /* Now we attempt to switch processes. */
719 struct fork_info *oldfp;
721 gdb_assert (newfp != NULL);
723 oldfp = find_fork_ptid (inferior_ptid);
724 gdb_assert (oldfp != NULL);
726 fork_save_infrun_state (oldfp, 1);
727 remove_breakpoints ();
728 fork_load_infrun_state (newfp);
729 insert_breakpoints ();
731 printf_filtered (_("Switching to %s\n"),
732 target_pid_to_str (inferior_ptid));
734 print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
737 /* Switch inferior process (checkpoint) context, by checkpoint id. */
739 restart_command (char *args, int from_tty)
741 struct fork_info *fp;
744 error (_("Requires argument (checkpoint id to restart)"));
746 if ((fp = find_fork_id (parse_and_eval_long (args))) == NULL)
747 error (_("Not found: checkpoint id %s"), args);
749 linux_fork_context (fp, from_tty);
753 _initialize_linux_fork (void)
757 /* Checkpoint command: create a fork of the inferior process
758 and set it aside for later debugging. */
760 add_com ("checkpoint", class_obscure, checkpoint_command, _("\
761 Fork a duplicate process (experimental)."));
763 /* Restart command: restore the context of a specified checkpoint
766 add_com ("restart", class_obscure, restart_command, _("\
767 restart <n>: restore program context from a checkpoint.\n\
768 Argument 'n' is checkpoint ID, as displayed by 'info checkpoints'."));
770 /* Delete checkpoint command: kill the process and remove it from
773 add_cmd ("checkpoint", class_obscure, delete_checkpoint_command, _("\
774 Delete a checkpoint (experimental)."),
777 /* Detach checkpoint command: release the process to run independently,
778 and remove it from the fork list. */
780 add_cmd ("checkpoint", class_obscure, detach_checkpoint_command, _("\
781 Detach from a checkpoint (experimental)."),
784 /* Info checkpoints command: list all forks/checkpoints
785 currently under gdb's control. */
787 add_info ("checkpoints", info_checkpoints_command,
788 _("IDs of currently known checkpoints."));