1 /* Low-level child interface to ptrace.
3 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998,
4 1999, 2000, 2001, 2002, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
30 #include "gdb_assert.h"
31 #include "gdb_string.h"
32 #include "gdb_ptrace.h"
36 #include "inf-ptrace.h"
37 #include "inf-child.h"
38 #include "gdbthread.h"
42 #ifdef PT_GET_PROCESS_STATE
45 inf_ptrace_follow_fork (struct target_ops *ops, int follow_child)
50 pid = ptid_get_pid (inferior_ptid);
52 if (ptrace (PT_GET_PROCESS_STATE, pid,
53 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
54 perror_with_name (("ptrace"));
56 gdb_assert (pe.pe_report_event == PTRACE_FORK);
57 fpid = pe.pe_other_pid;
61 struct inferior *parent_inf, *child_inf;
62 struct thread_info *tp;
64 parent_inf = find_inferior_pid (pid);
67 child_inf = add_inferior (fpid);
68 child_inf->attach_flag = parent_inf->attach_flag;
69 copy_terminal_info (child_inf, parent_inf);
70 child_inf->pspace = parent_inf->pspace;
71 child_inf->aspace = parent_inf->aspace;
73 /* Before detaching from the parent, remove all breakpoints from
75 remove_breakpoints ();
77 if (ptrace (PT_DETACH, pid, (PTRACE_TYPE_ARG3)1, 0) == -1)
78 perror_with_name (("ptrace"));
80 /* Switch inferior_ptid out of the parent's way. */
81 inferior_ptid = pid_to_ptid (fpid);
83 /* Delete the parent. */
84 detach_inferior (pid);
86 add_thread_silent (inferior_ptid);
90 /* Breakpoints have already been detached from the child by
93 if (ptrace (PT_DETACH, fpid, (PTRACE_TYPE_ARG3)1, 0) == -1)
94 perror_with_name (("ptrace"));
100 #endif /* PT_GET_PROCESS_STATE */
103 /* Prepare to be traced. */
108 /* "Trace me, Dr. Memory!" */
109 ptrace (PT_TRACE_ME, 0, (PTRACE_TYPE_ARG3)0, 0);
112 /* Start a new inferior Unix child process. EXEC_FILE is the file to
113 run, ALLARGS is a string containing the arguments to the program.
114 ENV is the environment vector to pass. If FROM_TTY is non-zero, be
118 inf_ptrace_create_inferior (struct target_ops *ops,
119 char *exec_file, char *allargs, char **env,
124 pid = fork_inferior (exec_file, allargs, env, inf_ptrace_me, NULL,
129 /* On some targets, there must be some explicit synchronization
130 between the parent and child processes after the debugger
131 forks, and before the child execs the debuggee program. This
132 call basically gives permission for the child to exec. */
134 target_acknowledge_created_inferior (pid);
136 /* START_INFERIOR_TRAPS_EXPECTED is defined in inferior.h, and will
137 be 1 or 2 depending on whether we're starting without or with a
139 startup_inferior (START_INFERIOR_TRAPS_EXPECTED);
141 /* On some targets, there must be some explicit actions taken after
142 the inferior has been started up. */
143 target_post_startup_inferior (pid_to_ptid (pid));
146 #ifdef PT_GET_PROCESS_STATE
149 inf_ptrace_post_startup_inferior (ptid_t pid)
153 /* Set the initial event mask. */
154 memset (&pe, 0, sizeof pe);
155 pe.pe_set_event |= PTRACE_FORK;
156 if (ptrace (PT_SET_EVENT_MASK, ptid_get_pid (pid),
157 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
158 perror_with_name (("ptrace"));
163 /* Clean up a rotting corpse of an inferior after it died. */
166 inf_ptrace_mourn_inferior (struct target_ops *ops)
170 /* Wait just one more time to collect the inferior's exit status.
171 Do not check whether this succeeds though, since we may be
172 dealing with a process that we attached to. Such a process will
173 only report its exit status to its original parent. */
174 waitpid (ptid_get_pid (inferior_ptid), &status, 0);
176 generic_mourn_inferior ();
178 if (!have_inferiors ())
182 /* Attach to the process specified by ARGS. If FROM_TTY is non-zero,
183 be chatty about it. */
186 inf_ptrace_attach (struct target_ops *ops, char *args, int from_tty)
190 struct inferior *inf;
192 pid = parse_pid_to_attach (args);
194 if (pid == getpid ()) /* Trying to masturbate? */
195 error (_("I refuse to debug myself!"));
199 exec_file = get_exec_file (0);
202 printf_unfiltered (_("Attaching to program: %s, %s\n"), exec_file,
203 target_pid_to_str (pid_to_ptid (pid)));
205 printf_unfiltered (_("Attaching to %s\n"),
206 target_pid_to_str (pid_to_ptid (pid)));
208 gdb_flush (gdb_stdout);
213 ptrace (PT_ATTACH, pid, (PTRACE_TYPE_ARG3)0, 0);
215 perror_with_name (("ptrace"));
217 error (_("This system does not support attaching to a process"));
220 inf = current_inferior ();
221 inferior_appeared (inf, pid);
222 inf->attach_flag = 1;
223 inferior_ptid = pid_to_ptid (pid);
225 /* Always add a main thread. If some target extends the ptrace
226 target, it should decorate the ptid later with more info. */
227 add_thread_silent (inferior_ptid);
232 #ifdef PT_GET_PROCESS_STATE
235 inf_ptrace_post_attach (int pid)
239 /* Set the initial event mask. */
240 memset (&pe, 0, sizeof pe);
241 pe.pe_set_event |= PTRACE_FORK;
242 if (ptrace (PT_SET_EVENT_MASK, pid,
243 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
244 perror_with_name (("ptrace"));
249 /* Detach from the inferior, optionally passing it the signal
250 specified by ARGS. If FROM_TTY is non-zero, be chatty about it. */
253 inf_ptrace_detach (struct target_ops *ops, char *args, int from_tty)
255 pid_t pid = ptid_get_pid (inferior_ptid);
260 char *exec_file = get_exec_file (0);
263 printf_unfiltered (_("Detaching from program: %s, %s\n"), exec_file,
264 target_pid_to_str (pid_to_ptid (pid)));
265 gdb_flush (gdb_stdout);
271 /* We'd better not have left any breakpoints in the program or it'll
272 die when it hits one. Also note that this may only work if we
273 previously attached to the inferior. It *might* work if we
274 started the process ourselves. */
276 ptrace (PT_DETACH, pid, (PTRACE_TYPE_ARG3)1, sig);
278 perror_with_name (("ptrace"));
280 error (_("This system does not support detaching from a process"));
283 inferior_ptid = null_ptid;
284 detach_inferior (pid);
286 if (!have_inferiors ())
290 /* Kill the inferior. */
293 inf_ptrace_kill (struct target_ops *ops)
295 pid_t pid = ptid_get_pid (inferior_ptid);
301 ptrace (PT_KILL, pid, (PTRACE_TYPE_ARG3)0, 0);
302 waitpid (pid, &status, 0);
304 target_mourn_inferior ();
307 /* Stop the inferior. */
310 inf_ptrace_stop (ptid_t ptid)
312 /* Send a SIGINT to the process group. This acts just like the user
313 typed a ^C on the controlling terminal. Note that using a
314 negative process number in kill() is a System V-ism. The proper
315 BSD interface is killpg(). However, all modern BSDs support the
316 System V interface too. */
317 kill (-inferior_process_group (), SIGINT);
320 /* Resume execution of thread PTID, or all threads if PTID is -1. If
321 STEP is nonzero, single-step it. If SIGNAL is nonzero, give it
325 inf_ptrace_resume (struct target_ops *ops,
326 ptid_t ptid, int step, enum target_signal signal)
328 pid_t pid = ptid_get_pid (ptid);
332 /* Resume all threads. Traditionally ptrace() only supports
333 single-threaded processes, so simply resume the inferior. */
334 pid = ptid_get_pid (inferior_ptid);
336 if (catch_syscall_enabled () > 0)
337 request = PT_SYSCALL;
339 request = PT_CONTINUE;
343 /* If this system does not support PT_STEP, a higher level
344 function will have called single_step() to transmute the step
345 request into a continue request (by setting breakpoints on
346 all possible successor instructions), so we don't have to
347 worry about that here. */
351 /* An address of (PTRACE_TYPE_ARG3)1 tells ptrace to continue from
352 where it was. If GDB wanted it to start some other way, we have
353 already written a new program counter value to the child. */
355 ptrace (request, pid, (PTRACE_TYPE_ARG3)1, target_signal_to_host (signal));
357 perror_with_name (("ptrace"));
360 /* Wait for the child specified by PTID to do something. Return the
361 process ID of the child, or MINUS_ONE_PTID in case of error; store
362 the status in *OURSTATUS. */
365 inf_ptrace_wait (struct target_ops *ops,
366 ptid_t ptid, struct target_waitstatus *ourstatus, int options)
369 int status, save_errno;
377 pid = waitpid (ptid_get_pid (ptid), &status, 0);
380 while (pid == -1 && errno == EINTR);
382 clear_sigint_trap ();
386 fprintf_unfiltered (gdb_stderr,
387 _("Child process unexpectedly missing: %s.\n"),
388 safe_strerror (save_errno));
390 /* Claim it exited with unknown signal. */
391 ourstatus->kind = TARGET_WAITKIND_SIGNALLED;
392 ourstatus->value.sig = TARGET_SIGNAL_UNKNOWN;
393 return inferior_ptid;
396 /* Ignore terminated detached child processes. */
397 if (!WIFSTOPPED (status) && pid != ptid_get_pid (inferior_ptid))
402 #ifdef PT_GET_PROCESS_STATE
403 if (WIFSTOPPED (status))
408 if (ptrace (PT_GET_PROCESS_STATE, pid,
409 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
410 perror_with_name (("ptrace"));
412 switch (pe.pe_report_event)
415 ourstatus->kind = TARGET_WAITKIND_FORKED;
416 ourstatus->value.related_pid = pid_to_ptid (pe.pe_other_pid);
418 /* Make sure the other end of the fork is stopped too. */
419 fpid = waitpid (pe.pe_other_pid, &status, 0);
421 perror_with_name (("waitpid"));
423 if (ptrace (PT_GET_PROCESS_STATE, fpid,
424 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
425 perror_with_name (("ptrace"));
427 gdb_assert (pe.pe_report_event == PTRACE_FORK);
428 gdb_assert (pe.pe_other_pid == pid);
429 if (fpid == ptid_get_pid (inferior_ptid))
431 ourstatus->value.related_pid = pid_to_ptid (pe.pe_other_pid);
432 return pid_to_ptid (fpid);
435 return pid_to_ptid (pid);
440 store_waitstatus (ourstatus, status);
441 return pid_to_ptid (pid);
444 /* Attempt a transfer all LEN bytes starting at OFFSET between the
445 inferior's OBJECT:ANNEX space and GDB's READBUF/WRITEBUF buffer.
446 Return the number of bytes actually transferred. */
449 inf_ptrace_xfer_partial (struct target_ops *ops, enum target_object object,
450 const char *annex, gdb_byte *readbuf,
451 const gdb_byte *writebuf,
452 ULONGEST offset, LONGEST len)
454 pid_t pid = ptid_get_pid (inferior_ptid);
458 case TARGET_OBJECT_MEMORY:
460 /* OpenBSD 3.1, NetBSD 1.6 and FreeBSD 5.0 have a new PT_IO
461 request that promises to be much more efficient in reading
462 and writing data in the traced process's address space. */
464 struct ptrace_io_desc piod;
466 /* NOTE: We assume that there are no distinct address spaces
467 for instruction and data. However, on OpenBSD 3.9 and
468 later, PIOD_WRITE_D doesn't allow changing memory that's
469 mapped read-only. Since most code segments will be
470 read-only, using PIOD_WRITE_D will prevent us from
471 inserting breakpoints, so we use PIOD_WRITE_I instead. */
472 piod.piod_op = writebuf ? PIOD_WRITE_I : PIOD_READ_D;
473 piod.piod_addr = writebuf ? (void *) writebuf : readbuf;
474 piod.piod_offs = (void *) (long) offset;
478 if (ptrace (PT_IO, pid, (caddr_t)&piod, 0) == 0)
479 /* Return the actual number of bytes read or written. */
480 return piod.piod_len;
481 /* If the PT_IO request is somehow not supported, fallback on
482 using PT_WRITE_D/PT_READ_D. Otherwise we will return zero
483 to indicate failure. */
491 PTRACE_TYPE_RET word;
492 gdb_byte byte[sizeof (PTRACE_TYPE_RET)];
494 ULONGEST rounded_offset;
497 /* Round the start offset down to the next long word
499 rounded_offset = offset & -(ULONGEST) sizeof (PTRACE_TYPE_RET);
501 /* Since ptrace will transfer a single word starting at that
502 rounded_offset the partial_len needs to be adjusted down to
503 that (remember this function only does a single transfer).
504 Should the required length be even less, adjust it down
506 partial_len = (rounded_offset + sizeof (PTRACE_TYPE_RET)) - offset;
507 if (partial_len > len)
512 /* If OFFSET:PARTIAL_LEN is smaller than
513 ROUNDED_OFFSET:WORDSIZE then a read/modify write will
514 be needed. Read in the entire word. */
515 if (rounded_offset < offset
516 || (offset + partial_len
517 < rounded_offset + sizeof (PTRACE_TYPE_RET)))
518 /* Need part of initial word -- fetch it. */
519 buffer.word = ptrace (PT_READ_I, pid,
520 (PTRACE_TYPE_ARG3)(uintptr_t)
523 /* Copy data to be written over corresponding part of
525 memcpy (buffer.byte + (offset - rounded_offset),
526 writebuf, partial_len);
529 ptrace (PT_WRITE_D, pid,
530 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
534 /* Using the appropriate one (I or D) is necessary for
535 Gould NP1, at least. */
537 ptrace (PT_WRITE_I, pid,
538 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
548 buffer.word = ptrace (PT_READ_I, pid,
549 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
553 /* Copy appropriate bytes out of the buffer. */
554 memcpy (readbuf, buffer.byte + (offset - rounded_offset),
561 case TARGET_OBJECT_UNWIND_TABLE:
564 case TARGET_OBJECT_AUXV:
567 case TARGET_OBJECT_WCOOKIE:
575 /* Return non-zero if the thread specified by PTID is alive. */
578 inf_ptrace_thread_alive (struct target_ops *ops, ptid_t ptid)
580 /* ??? Is kill the right way to do this? */
581 return (kill (ptid_get_pid (ptid), 0) != -1);
584 /* Print status information about what we're accessing. */
587 inf_ptrace_files_info (struct target_ops *ignore)
589 struct inferior *inf = current_inferior ();
591 printf_filtered (_("\tUsing the running image of %s %s.\n"),
592 inf->attach_flag ? "attached" : "child",
593 target_pid_to_str (inferior_ptid));
597 inf_ptrace_pid_to_str (struct target_ops *ops, ptid_t ptid)
599 return normal_pid_to_str (ptid);
602 /* Create a prototype ptrace target. The client can override it with
606 inf_ptrace_target (void)
608 struct target_ops *t = inf_child_target ();
610 t->to_attach = inf_ptrace_attach;
611 t->to_detach = inf_ptrace_detach;
612 t->to_resume = inf_ptrace_resume;
613 t->to_wait = inf_ptrace_wait;
614 t->to_files_info = inf_ptrace_files_info;
615 t->to_kill = inf_ptrace_kill;
616 t->to_create_inferior = inf_ptrace_create_inferior;
617 #ifdef PT_GET_PROCESS_STATE
618 t->to_follow_fork = inf_ptrace_follow_fork;
619 t->to_post_startup_inferior = inf_ptrace_post_startup_inferior;
620 t->to_post_attach = inf_ptrace_post_attach;
622 t->to_mourn_inferior = inf_ptrace_mourn_inferior;
623 t->to_thread_alive = inf_ptrace_thread_alive;
624 t->to_pid_to_str = inf_ptrace_pid_to_str;
625 t->to_stop = inf_ptrace_stop;
626 t->to_xfer_partial = inf_ptrace_xfer_partial;
632 /* Pointer to a function that returns the offset within the user area
633 where a particular register is stored. */
634 static CORE_ADDR (*inf_ptrace_register_u_offset)(struct gdbarch *, int, int);
636 /* Fetch register REGNUM from the inferior. */
639 inf_ptrace_fetch_register (struct regcache *regcache, int regnum)
641 struct gdbarch *gdbarch = get_regcache_arch (regcache);
644 PTRACE_TYPE_RET *buf;
647 /* This isn't really an address, but ptrace thinks of it as one. */
648 addr = inf_ptrace_register_u_offset (gdbarch, regnum, 0);
649 if (addr == (CORE_ADDR)-1
650 || gdbarch_cannot_fetch_register (gdbarch, regnum))
652 regcache_raw_supply (regcache, regnum, NULL);
656 /* Cater for systems like GNU/Linux, that implement threads as
657 separate processes. */
658 pid = ptid_get_lwp (inferior_ptid);
660 pid = ptid_get_pid (inferior_ptid);
662 size = register_size (gdbarch, regnum);
663 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
666 /* Read the register contents from the inferior a chunk at a time. */
667 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
670 buf[i] = ptrace (PT_READ_U, pid, (PTRACE_TYPE_ARG3)(uintptr_t)addr, 0);
672 error (_("Couldn't read register %s (#%d): %s."),
673 gdbarch_register_name (gdbarch, regnum),
674 regnum, safe_strerror (errno));
676 addr += sizeof (PTRACE_TYPE_RET);
678 regcache_raw_supply (regcache, regnum, buf);
681 /* Fetch register REGNUM from the inferior. If REGNUM is -1, do this
682 for all registers. */
685 inf_ptrace_fetch_registers (struct target_ops *ops,
686 struct regcache *regcache, int regnum)
690 regnum < gdbarch_num_regs (get_regcache_arch (regcache));
692 inf_ptrace_fetch_register (regcache, regnum);
694 inf_ptrace_fetch_register (regcache, regnum);
697 /* Store register REGNUM into the inferior. */
700 inf_ptrace_store_register (const struct regcache *regcache, int regnum)
702 struct gdbarch *gdbarch = get_regcache_arch (regcache);
705 PTRACE_TYPE_RET *buf;
708 /* This isn't really an address, but ptrace thinks of it as one. */
709 addr = inf_ptrace_register_u_offset (gdbarch, regnum, 1);
710 if (addr == (CORE_ADDR)-1
711 || gdbarch_cannot_store_register (gdbarch, regnum))
714 /* Cater for systems like GNU/Linux, that implement threads as
715 separate processes. */
716 pid = ptid_get_lwp (inferior_ptid);
718 pid = ptid_get_pid (inferior_ptid);
720 size = register_size (gdbarch, regnum);
721 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
724 /* Write the register contents into the inferior a chunk at a time. */
725 regcache_raw_collect (regcache, regnum, buf);
726 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
729 ptrace (PT_WRITE_U, pid, (PTRACE_TYPE_ARG3)(uintptr_t)addr, buf[i]);
731 error (_("Couldn't write register %s (#%d): %s."),
732 gdbarch_register_name (gdbarch, regnum),
733 regnum, safe_strerror (errno));
735 addr += sizeof (PTRACE_TYPE_RET);
739 /* Store register REGNUM back into the inferior. If REGNUM is -1, do
740 this for all registers. */
743 inf_ptrace_store_registers (struct target_ops *ops,
744 struct regcache *regcache, int regnum)
748 regnum < gdbarch_num_regs (get_regcache_arch (regcache));
750 inf_ptrace_store_register (regcache, regnum);
752 inf_ptrace_store_register (regcache, regnum);
755 /* Create a "traditional" ptrace target. REGISTER_U_OFFSET should be
756 a function returning the offset within the user area where a
757 particular register is stored. */
760 inf_ptrace_trad_target (CORE_ADDR (*register_u_offset)
761 (struct gdbarch *, int, int))
763 struct target_ops *t = inf_ptrace_target();
765 gdb_assert (register_u_offset);
766 inf_ptrace_register_u_offset = register_u_offset;
767 t->to_fetch_registers = inf_ptrace_fetch_registers;
768 t->to_store_registers = inf_ptrace_store_registers;