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
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 inf->pspace = parent_inf->pspace;
71 inf->pspace = 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)
191 struct inferior *inf;
194 error_no_arg (_("process-id to attach"));
197 pid = strtol (args, &dummy, 0);
198 /* Some targets don't set errno on errors, grrr! */
199 if (pid == 0 && args == dummy)
200 error (_("Illegal process-id: %s."), args);
202 if (pid == getpid ()) /* Trying to masturbate? */
203 error (_("I refuse to debug myself!"));
207 exec_file = get_exec_file (0);
210 printf_unfiltered (_("Attaching to program: %s, %s\n"), exec_file,
211 target_pid_to_str (pid_to_ptid (pid)));
213 printf_unfiltered (_("Attaching to %s\n"),
214 target_pid_to_str (pid_to_ptid (pid)));
216 gdb_flush (gdb_stdout);
221 ptrace (PT_ATTACH, pid, (PTRACE_TYPE_ARG3)0, 0);
223 perror_with_name (("ptrace"));
225 error (_("This system does not support attaching to a process"));
228 inf = current_inferior ();
229 inferior_appeared (inf, pid);
230 inf->attach_flag = 1;
231 inferior_ptid = pid_to_ptid (pid);
233 /* Always add a main thread. If some target extends the ptrace
234 target, it should decorate the ptid later with more info. */
235 add_thread_silent (inferior_ptid);
240 #ifdef PT_GET_PROCESS_STATE
243 inf_ptrace_post_attach (int pid)
247 /* Set the initial event mask. */
248 memset (&pe, 0, sizeof pe);
249 pe.pe_set_event |= PTRACE_FORK;
250 if (ptrace (PT_SET_EVENT_MASK, pid,
251 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
252 perror_with_name (("ptrace"));
257 /* Detach from the inferior, optionally passing it the signal
258 specified by ARGS. If FROM_TTY is non-zero, be chatty about it. */
261 inf_ptrace_detach (struct target_ops *ops, char *args, int from_tty)
263 pid_t pid = ptid_get_pid (inferior_ptid);
268 char *exec_file = get_exec_file (0);
271 printf_unfiltered (_("Detaching from program: %s, %s\n"), exec_file,
272 target_pid_to_str (pid_to_ptid (pid)));
273 gdb_flush (gdb_stdout);
279 /* We'd better not have left any breakpoints in the program or it'll
280 die when it hits one. Also note that this may only work if we
281 previously attached to the inferior. It *might* work if we
282 started the process ourselves. */
284 ptrace (PT_DETACH, pid, (PTRACE_TYPE_ARG3)1, sig);
286 perror_with_name (("ptrace"));
288 error (_("This system does not support detaching from a process"));
291 inferior_ptid = null_ptid;
292 detach_inferior (pid);
294 if (!have_inferiors ())
298 /* Kill the inferior. */
301 inf_ptrace_kill (struct target_ops *ops)
303 pid_t pid = ptid_get_pid (inferior_ptid);
309 ptrace (PT_KILL, pid, (PTRACE_TYPE_ARG3)0, 0);
310 waitpid (pid, &status, 0);
312 target_mourn_inferior ();
315 /* Stop the inferior. */
318 inf_ptrace_stop (ptid_t ptid)
320 /* Send a SIGINT to the process group. This acts just like the user
321 typed a ^C on the controlling terminal. Note that using a
322 negative process number in kill() is a System V-ism. The proper
323 BSD interface is killpg(). However, all modern BSDs support the
324 System V interface too. */
325 kill (-inferior_process_group (), SIGINT);
328 /* Resume execution of thread PTID, or all threads if PTID is -1. If
329 STEP is nonzero, single-step it. If SIGNAL is nonzero, give it
333 inf_ptrace_resume (struct target_ops *ops,
334 ptid_t ptid, int step, enum target_signal signal)
336 pid_t pid = ptid_get_pid (ptid);
340 /* Resume all threads. Traditionally ptrace() only supports
341 single-threaded processes, so simply resume the inferior. */
342 pid = ptid_get_pid (inferior_ptid);
344 if (catch_syscall_enabled () > 0)
345 request = PT_SYSCALL;
347 request = PT_CONTINUE;
351 /* If this system does not support PT_STEP, a higher level
352 function will have called single_step() to transmute the step
353 request into a continue request (by setting breakpoints on
354 all possible successor instructions), so we don't have to
355 worry about that here. */
359 /* An address of (PTRACE_TYPE_ARG3)1 tells ptrace to continue from
360 where it was. If GDB wanted it to start some other way, we have
361 already written a new program counter value to the child. */
363 ptrace (request, pid, (PTRACE_TYPE_ARG3)1, target_signal_to_host (signal));
365 perror_with_name (("ptrace"));
368 /* Wait for the child specified by PTID to do something. Return the
369 process ID of the child, or MINUS_ONE_PTID in case of error; store
370 the status in *OURSTATUS. */
373 inf_ptrace_wait (struct target_ops *ops,
374 ptid_t ptid, struct target_waitstatus *ourstatus, int options)
377 int status, save_errno;
385 pid = waitpid (ptid_get_pid (ptid), &status, 0);
388 while (pid == -1 && errno == EINTR);
390 clear_sigint_trap ();
394 fprintf_unfiltered (gdb_stderr,
395 _("Child process unexpectedly missing: %s.\n"),
396 safe_strerror (save_errno));
398 /* Claim it exited with unknown signal. */
399 ourstatus->kind = TARGET_WAITKIND_SIGNALLED;
400 ourstatus->value.sig = TARGET_SIGNAL_UNKNOWN;
401 return inferior_ptid;
404 /* Ignore terminated detached child processes. */
405 if (!WIFSTOPPED (status) && pid != ptid_get_pid (inferior_ptid))
410 #ifdef PT_GET_PROCESS_STATE
411 if (WIFSTOPPED (status))
416 if (ptrace (PT_GET_PROCESS_STATE, pid,
417 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
418 perror_with_name (("ptrace"));
420 switch (pe.pe_report_event)
423 ourstatus->kind = TARGET_WAITKIND_FORKED;
424 ourstatus->value.related_pid = pid_to_ptid (pe.pe_other_pid);
426 /* Make sure the other end of the fork is stopped too. */
427 fpid = waitpid (pe.pe_other_pid, &status, 0);
429 perror_with_name (("waitpid"));
431 if (ptrace (PT_GET_PROCESS_STATE, fpid,
432 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
433 perror_with_name (("ptrace"));
435 gdb_assert (pe.pe_report_event == PTRACE_FORK);
436 gdb_assert (pe.pe_other_pid == pid);
437 if (fpid == ptid_get_pid (inferior_ptid))
439 ourstatus->value.related_pid = pid_to_ptid (pe.pe_other_pid);
440 return pid_to_ptid (fpid);
443 return pid_to_ptid (pid);
448 store_waitstatus (ourstatus, status);
449 return pid_to_ptid (pid);
452 /* Attempt a transfer all LEN bytes starting at OFFSET between the
453 inferior's OBJECT:ANNEX space and GDB's READBUF/WRITEBUF buffer.
454 Return the number of bytes actually transferred. */
457 inf_ptrace_xfer_partial (struct target_ops *ops, enum target_object object,
458 const char *annex, gdb_byte *readbuf,
459 const gdb_byte *writebuf,
460 ULONGEST offset, LONGEST len)
462 pid_t pid = ptid_get_pid (inferior_ptid);
466 case TARGET_OBJECT_MEMORY:
468 /* OpenBSD 3.1, NetBSD 1.6 and FreeBSD 5.0 have a new PT_IO
469 request that promises to be much more efficient in reading
470 and writing data in the traced process's address space. */
472 struct ptrace_io_desc piod;
474 /* NOTE: We assume that there are no distinct address spaces
475 for instruction and data. However, on OpenBSD 3.9 and
476 later, PIOD_WRITE_D doesn't allow changing memory that's
477 mapped read-only. Since most code segments will be
478 read-only, using PIOD_WRITE_D will prevent us from
479 inserting breakpoints, so we use PIOD_WRITE_I instead. */
480 piod.piod_op = writebuf ? PIOD_WRITE_I : PIOD_READ_D;
481 piod.piod_addr = writebuf ? (void *) writebuf : readbuf;
482 piod.piod_offs = (void *) (long) offset;
486 if (ptrace (PT_IO, pid, (caddr_t)&piod, 0) == 0)
487 /* Return the actual number of bytes read or written. */
488 return piod.piod_len;
489 /* If the PT_IO request is somehow not supported, fallback on
490 using PT_WRITE_D/PT_READ_D. Otherwise we will return zero
491 to indicate failure. */
499 PTRACE_TYPE_RET word;
500 gdb_byte byte[sizeof (PTRACE_TYPE_RET)];
502 ULONGEST rounded_offset;
505 /* Round the start offset down to the next long word
507 rounded_offset = offset & -(ULONGEST) sizeof (PTRACE_TYPE_RET);
509 /* Since ptrace will transfer a single word starting at that
510 rounded_offset the partial_len needs to be adjusted down to
511 that (remember this function only does a single transfer).
512 Should the required length be even less, adjust it down
514 partial_len = (rounded_offset + sizeof (PTRACE_TYPE_RET)) - offset;
515 if (partial_len > len)
520 /* If OFFSET:PARTIAL_LEN is smaller than
521 ROUNDED_OFFSET:WORDSIZE then a read/modify write will
522 be needed. Read in the entire word. */
523 if (rounded_offset < offset
524 || (offset + partial_len
525 < rounded_offset + sizeof (PTRACE_TYPE_RET)))
526 /* Need part of initial word -- fetch it. */
527 buffer.word = ptrace (PT_READ_I, pid,
528 (PTRACE_TYPE_ARG3)(uintptr_t)
531 /* Copy data to be written over corresponding part of
533 memcpy (buffer.byte + (offset - rounded_offset),
534 writebuf, partial_len);
537 ptrace (PT_WRITE_D, pid,
538 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
542 /* Using the appropriate one (I or D) is necessary for
543 Gould NP1, at least. */
545 ptrace (PT_WRITE_I, pid,
546 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
556 buffer.word = ptrace (PT_READ_I, pid,
557 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
561 /* Copy appropriate bytes out of the buffer. */
562 memcpy (readbuf, buffer.byte + (offset - rounded_offset),
569 case TARGET_OBJECT_UNWIND_TABLE:
572 case TARGET_OBJECT_AUXV:
575 case TARGET_OBJECT_WCOOKIE:
583 /* Return non-zero if the thread specified by PTID is alive. */
586 inf_ptrace_thread_alive (struct target_ops *ops, ptid_t ptid)
588 /* ??? Is kill the right way to do this? */
589 return (kill (ptid_get_pid (ptid), 0) != -1);
592 /* Print status information about what we're accessing. */
595 inf_ptrace_files_info (struct target_ops *ignore)
597 struct inferior *inf = current_inferior ();
599 printf_filtered (_("\tUsing the running image of %s %s.\n"),
600 inf->attach_flag ? "attached" : "child",
601 target_pid_to_str (inferior_ptid));
605 inf_ptrace_pid_to_str (struct target_ops *ops, ptid_t ptid)
607 return normal_pid_to_str (ptid);
610 /* Create a prototype ptrace target. The client can override it with
614 inf_ptrace_target (void)
616 struct target_ops *t = inf_child_target ();
618 t->to_attach = inf_ptrace_attach;
619 t->to_detach = inf_ptrace_detach;
620 t->to_resume = inf_ptrace_resume;
621 t->to_wait = inf_ptrace_wait;
622 t->to_files_info = inf_ptrace_files_info;
623 t->to_kill = inf_ptrace_kill;
624 t->to_create_inferior = inf_ptrace_create_inferior;
625 #ifdef PT_GET_PROCESS_STATE
626 t->to_follow_fork = inf_ptrace_follow_fork;
627 t->to_post_startup_inferior = inf_ptrace_post_startup_inferior;
628 t->to_post_attach = inf_ptrace_post_attach;
630 t->to_mourn_inferior = inf_ptrace_mourn_inferior;
631 t->to_thread_alive = inf_ptrace_thread_alive;
632 t->to_pid_to_str = inf_ptrace_pid_to_str;
633 t->to_stop = inf_ptrace_stop;
634 t->to_xfer_partial = inf_ptrace_xfer_partial;
640 /* Pointer to a function that returns the offset within the user area
641 where a particular register is stored. */
642 static CORE_ADDR (*inf_ptrace_register_u_offset)(struct gdbarch *, int, int);
644 /* Fetch register REGNUM from the inferior. */
647 inf_ptrace_fetch_register (struct regcache *regcache, int regnum)
649 struct gdbarch *gdbarch = get_regcache_arch (regcache);
652 PTRACE_TYPE_RET *buf;
655 /* This isn't really an address, but ptrace thinks of it as one. */
656 addr = inf_ptrace_register_u_offset (gdbarch, regnum, 0);
657 if (addr == (CORE_ADDR)-1
658 || gdbarch_cannot_fetch_register (gdbarch, regnum))
660 regcache_raw_supply (regcache, regnum, NULL);
664 /* Cater for systems like GNU/Linux, that implement threads as
665 separate processes. */
666 pid = ptid_get_lwp (inferior_ptid);
668 pid = ptid_get_pid (inferior_ptid);
670 size = register_size (gdbarch, regnum);
671 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
674 /* Read the register contents from the inferior a chunk at a time. */
675 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
678 buf[i] = ptrace (PT_READ_U, pid, (PTRACE_TYPE_ARG3)(uintptr_t)addr, 0);
680 error (_("Couldn't read register %s (#%d): %s."),
681 gdbarch_register_name (gdbarch, regnum),
682 regnum, safe_strerror (errno));
684 addr += sizeof (PTRACE_TYPE_RET);
686 regcache_raw_supply (regcache, regnum, buf);
689 /* Fetch register REGNUM from the inferior. If REGNUM is -1, do this
690 for all registers. */
693 inf_ptrace_fetch_registers (struct target_ops *ops,
694 struct regcache *regcache, int regnum)
698 regnum < gdbarch_num_regs (get_regcache_arch (regcache));
700 inf_ptrace_fetch_register (regcache, regnum);
702 inf_ptrace_fetch_register (regcache, regnum);
705 /* Store register REGNUM into the inferior. */
708 inf_ptrace_store_register (const struct regcache *regcache, int regnum)
710 struct gdbarch *gdbarch = get_regcache_arch (regcache);
713 PTRACE_TYPE_RET *buf;
716 /* This isn't really an address, but ptrace thinks of it as one. */
717 addr = inf_ptrace_register_u_offset (gdbarch, regnum, 1);
718 if (addr == (CORE_ADDR)-1
719 || gdbarch_cannot_store_register (gdbarch, regnum))
722 /* Cater for systems like GNU/Linux, that implement threads as
723 separate processes. */
724 pid = ptid_get_lwp (inferior_ptid);
726 pid = ptid_get_pid (inferior_ptid);
728 size = register_size (gdbarch, regnum);
729 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
732 /* Write the register contents into the inferior a chunk at a time. */
733 regcache_raw_collect (regcache, regnum, buf);
734 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
737 ptrace (PT_WRITE_U, pid, (PTRACE_TYPE_ARG3)(uintptr_t)addr, buf[i]);
739 error (_("Couldn't write register %s (#%d): %s."),
740 gdbarch_register_name (gdbarch, regnum),
741 regnum, safe_strerror (errno));
743 addr += sizeof (PTRACE_TYPE_RET);
747 /* Store register REGNUM back into the inferior. If REGNUM is -1, do
748 this for all registers. */
751 inf_ptrace_store_registers (struct target_ops *ops,
752 struct regcache *regcache, int regnum)
756 regnum < gdbarch_num_regs (get_regcache_arch (regcache));
758 inf_ptrace_store_register (regcache, regnum);
760 inf_ptrace_store_register (regcache, regnum);
763 /* Create a "traditional" ptrace target. REGISTER_U_OFFSET should be
764 a function returning the offset within the user area where a
765 particular register is stored. */
768 inf_ptrace_trad_target (CORE_ADDR (*register_u_offset)
769 (struct gdbarch *, int, int))
771 struct target_ops *t = inf_ptrace_target();
773 gdb_assert (register_u_offset);
774 inf_ptrace_register_u_offset = register_u_offset;
775 t->to_fetch_registers = inf_ptrace_fetch_registers;
776 t->to_store_registers = inf_ptrace_store_registers;