1 /* Low-level child interface to ptrace.
3 Copyright (C) 1988-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/>. */
28 #include "gdb_assert.h"
29 #include "gdb_string.h"
30 #include "gdb_ptrace.h"
34 #include "inf-ptrace.h"
35 #include "inf-child.h"
36 #include "gdbthread.h"
40 #ifdef PT_GET_PROCESS_STATE
43 inf_ptrace_follow_fork (struct target_ops *ops, int follow_child,
49 pid = ptid_get_pid (inferior_ptid);
51 if (ptrace (PT_GET_PROCESS_STATE, pid,
52 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
53 perror_with_name (("ptrace"));
55 gdb_assert (pe.pe_report_event == PTRACE_FORK);
56 fpid = pe.pe_other_pid;
60 struct inferior *parent_inf, *child_inf;
61 struct thread_info *tp;
63 parent_inf = find_inferior_pid (pid);
66 child_inf = add_inferior (fpid);
67 child_inf->attach_flag = parent_inf->attach_flag;
68 copy_terminal_info (child_inf, parent_inf);
69 child_inf->pspace = parent_inf->pspace;
70 child_inf->aspace = parent_inf->aspace;
72 /* Before detaching from the parent, remove all breakpoints from
74 remove_breakpoints ();
76 if (ptrace (PT_DETACH, pid, (PTRACE_TYPE_ARG3)1, 0) == -1)
77 perror_with_name (("ptrace"));
79 /* Switch inferior_ptid out of the parent's way. */
80 inferior_ptid = pid_to_ptid (fpid);
82 /* Delete the parent. */
83 detach_inferior (pid);
85 add_thread_silent (inferior_ptid);
89 /* Breakpoints have already been detached from the child by
92 if (ptrace (PT_DETACH, fpid, (PTRACE_TYPE_ARG3)1, 0) == -1)
93 perror_with_name (("ptrace"));
99 #endif /* PT_GET_PROCESS_STATE */
102 /* Prepare to be traced. */
107 /* "Trace me, Dr. Memory!" */
108 ptrace (PT_TRACE_ME, 0, (PTRACE_TYPE_ARG3)0, 0);
111 /* Start a new inferior Unix child process. EXEC_FILE is the file to
112 run, ALLARGS is a string containing the arguments to the program.
113 ENV is the environment vector to pass. If FROM_TTY is non-zero, be
117 inf_ptrace_create_inferior (struct target_ops *ops,
118 char *exec_file, char *allargs, char **env,
123 /* Do not change either targets above or the same target if already present.
124 The reason is the target stack is shared across multiple inferiors. */
125 int ops_already_pushed = target_is_pushed (ops);
126 struct cleanup *back_to = make_cleanup (null_cleanup, NULL);
128 if (! ops_already_pushed)
130 /* Clear possible core file with its process_stratum. */
132 make_cleanup_unpush_target (ops);
135 pid = fork_inferior (exec_file, allargs, env, inf_ptrace_me, NULL,
138 discard_cleanups (back_to);
140 /* START_INFERIOR_TRAPS_EXPECTED is defined in inferior.h, and will
141 be 1 or 2 depending on whether we're starting without or with a
143 startup_inferior (START_INFERIOR_TRAPS_EXPECTED);
145 /* On some targets, there must be some explicit actions taken after
146 the inferior has been started up. */
147 target_post_startup_inferior (pid_to_ptid (pid));
150 #ifdef PT_GET_PROCESS_STATE
153 inf_ptrace_post_startup_inferior (ptid_t pid)
157 /* Set the initial event mask. */
158 memset (&pe, 0, sizeof pe);
159 pe.pe_set_event |= PTRACE_FORK;
160 if (ptrace (PT_SET_EVENT_MASK, ptid_get_pid (pid),
161 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
162 perror_with_name (("ptrace"));
167 /* Clean up a rotting corpse of an inferior after it died. */
170 inf_ptrace_mourn_inferior (struct target_ops *ops)
174 /* Wait just one more time to collect the inferior's exit status.
175 Do not check whether this succeeds though, since we may be
176 dealing with a process that we attached to. Such a process will
177 only report its exit status to its original parent. */
178 waitpid (ptid_get_pid (inferior_ptid), &status, 0);
180 generic_mourn_inferior ();
182 if (!have_inferiors ())
186 /* Attach to the process specified by ARGS. If FROM_TTY is non-zero,
187 be chatty about it. */
190 inf_ptrace_attach (struct target_ops *ops, char *args, int from_tty)
194 struct inferior *inf;
196 /* Do not change either targets above or the same target if already present.
197 The reason is the target stack is shared across multiple inferiors. */
198 int ops_already_pushed = target_is_pushed (ops);
199 struct cleanup *back_to = make_cleanup (null_cleanup, NULL);
201 pid = parse_pid_to_attach (args);
203 if (pid == getpid ()) /* Trying to masturbate? */
204 error (_("I refuse to debug myself!"));
206 if (! ops_already_pushed)
208 /* target_pid_to_str already uses the target. Also clear possible core
209 file with its process_stratum. */
211 make_cleanup_unpush_target (ops);
216 exec_file = get_exec_file (0);
219 printf_unfiltered (_("Attaching to program: %s, %s\n"), exec_file,
220 target_pid_to_str (pid_to_ptid (pid)));
222 printf_unfiltered (_("Attaching to %s\n"),
223 target_pid_to_str (pid_to_ptid (pid)));
225 gdb_flush (gdb_stdout);
230 ptrace (PT_ATTACH, pid, (PTRACE_TYPE_ARG3)0, 0);
232 perror_with_name (("ptrace"));
234 error (_("This system does not support attaching to a process"));
237 inf = current_inferior ();
238 inferior_appeared (inf, pid);
239 inf->attach_flag = 1;
240 inferior_ptid = pid_to_ptid (pid);
242 /* Always add a main thread. If some target extends the ptrace
243 target, it should decorate the ptid later with more info. */
244 add_thread_silent (inferior_ptid);
246 discard_cleanups (back_to);
249 #ifdef PT_GET_PROCESS_STATE
252 inf_ptrace_post_attach (int pid)
256 /* Set the initial event mask. */
257 memset (&pe, 0, sizeof pe);
258 pe.pe_set_event |= PTRACE_FORK;
259 if (ptrace (PT_SET_EVENT_MASK, pid,
260 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
261 perror_with_name (("ptrace"));
266 /* Detach from the inferior, optionally passing it the signal
267 specified by ARGS. If FROM_TTY is non-zero, be chatty about it. */
270 inf_ptrace_detach (struct target_ops *ops, char *args, int from_tty)
272 pid_t pid = ptid_get_pid (inferior_ptid);
277 char *exec_file = get_exec_file (0);
280 printf_unfiltered (_("Detaching from program: %s, %s\n"), exec_file,
281 target_pid_to_str (pid_to_ptid (pid)));
282 gdb_flush (gdb_stdout);
288 /* We'd better not have left any breakpoints in the program or it'll
289 die when it hits one. Also note that this may only work if we
290 previously attached to the inferior. It *might* work if we
291 started the process ourselves. */
293 ptrace (PT_DETACH, pid, (PTRACE_TYPE_ARG3)1, sig);
295 perror_with_name (("ptrace"));
297 error (_("This system does not support detaching from a process"));
300 inferior_ptid = null_ptid;
301 detach_inferior (pid);
303 if (!have_inferiors ())
307 /* Kill the inferior. */
310 inf_ptrace_kill (struct target_ops *ops)
312 pid_t pid = ptid_get_pid (inferior_ptid);
318 ptrace (PT_KILL, pid, (PTRACE_TYPE_ARG3)0, 0);
319 waitpid (pid, &status, 0);
321 target_mourn_inferior ();
324 /* Stop the inferior. */
327 inf_ptrace_stop (ptid_t ptid)
329 /* Send a SIGINT to the process group. This acts just like the user
330 typed a ^C on the controlling terminal. Note that using a
331 negative process number in kill() is a System V-ism. The proper
332 BSD interface is killpg(). However, all modern BSDs support the
333 System V interface too. */
334 kill (-inferior_process_group (), SIGINT);
337 /* Resume execution of thread PTID, or all threads if PTID is -1. If
338 STEP is nonzero, single-step it. If SIGNAL is nonzero, give it
342 inf_ptrace_resume (struct target_ops *ops,
343 ptid_t ptid, int step, enum gdb_signal signal)
345 pid_t pid = ptid_get_pid (ptid);
349 /* Resume all threads. Traditionally ptrace() only supports
350 single-threaded processes, so simply resume the inferior. */
351 pid = ptid_get_pid (inferior_ptid);
353 if (catch_syscall_enabled () > 0)
354 request = PT_SYSCALL;
356 request = PT_CONTINUE;
360 /* If this system does not support PT_STEP, a higher level
361 function will have called single_step() to transmute the step
362 request into a continue request (by setting breakpoints on
363 all possible successor instructions), so we don't have to
364 worry about that here. */
368 /* An address of (PTRACE_TYPE_ARG3)1 tells ptrace to continue from
369 where it was. If GDB wanted it to start some other way, we have
370 already written a new program counter value to the child. */
372 ptrace (request, pid, (PTRACE_TYPE_ARG3)1, gdb_signal_to_host (signal));
374 perror_with_name (("ptrace"));
377 /* Wait for the child specified by PTID to do something. Return the
378 process ID of the child, or MINUS_ONE_PTID in case of error; store
379 the status in *OURSTATUS. */
382 inf_ptrace_wait (struct target_ops *ops,
383 ptid_t ptid, struct target_waitstatus *ourstatus, int options)
386 int status, save_errno;
394 pid = waitpid (ptid_get_pid (ptid), &status, 0);
397 while (pid == -1 && errno == EINTR);
399 clear_sigint_trap ();
403 fprintf_unfiltered (gdb_stderr,
404 _("Child process unexpectedly missing: %s.\n"),
405 safe_strerror (save_errno));
407 /* Claim it exited with unknown signal. */
408 ourstatus->kind = TARGET_WAITKIND_SIGNALLED;
409 ourstatus->value.sig = GDB_SIGNAL_UNKNOWN;
410 return inferior_ptid;
413 /* Ignore terminated detached child processes. */
414 if (!WIFSTOPPED (status) && pid != ptid_get_pid (inferior_ptid))
419 #ifdef PT_GET_PROCESS_STATE
420 if (WIFSTOPPED (status))
425 if (ptrace (PT_GET_PROCESS_STATE, pid,
426 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
427 perror_with_name (("ptrace"));
429 switch (pe.pe_report_event)
432 ourstatus->kind = TARGET_WAITKIND_FORKED;
433 ourstatus->value.related_pid = pid_to_ptid (pe.pe_other_pid);
435 /* Make sure the other end of the fork is stopped too. */
436 fpid = waitpid (pe.pe_other_pid, &status, 0);
438 perror_with_name (("waitpid"));
440 if (ptrace (PT_GET_PROCESS_STATE, fpid,
441 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
442 perror_with_name (("ptrace"));
444 gdb_assert (pe.pe_report_event == PTRACE_FORK);
445 gdb_assert (pe.pe_other_pid == pid);
446 if (fpid == ptid_get_pid (inferior_ptid))
448 ourstatus->value.related_pid = pid_to_ptid (pe.pe_other_pid);
449 return pid_to_ptid (fpid);
452 return pid_to_ptid (pid);
457 store_waitstatus (ourstatus, status);
458 return pid_to_ptid (pid);
461 /* Attempt a transfer all LEN bytes starting at OFFSET between the
462 inferior's OBJECT:ANNEX space and GDB's READBUF/WRITEBUF buffer.
463 Return the number of bytes actually transferred. */
466 inf_ptrace_xfer_partial (struct target_ops *ops, enum target_object object,
467 const char *annex, gdb_byte *readbuf,
468 const gdb_byte *writebuf,
469 ULONGEST offset, LONGEST len)
471 pid_t pid = ptid_get_pid (inferior_ptid);
475 case TARGET_OBJECT_MEMORY:
477 /* OpenBSD 3.1, NetBSD 1.6 and FreeBSD 5.0 have a new PT_IO
478 request that promises to be much more efficient in reading
479 and writing data in the traced process's address space. */
481 struct ptrace_io_desc piod;
483 /* NOTE: We assume that there are no distinct address spaces
484 for instruction and data. However, on OpenBSD 3.9 and
485 later, PIOD_WRITE_D doesn't allow changing memory that's
486 mapped read-only. Since most code segments will be
487 read-only, using PIOD_WRITE_D will prevent us from
488 inserting breakpoints, so we use PIOD_WRITE_I instead. */
489 piod.piod_op = writebuf ? PIOD_WRITE_I : PIOD_READ_D;
490 piod.piod_addr = writebuf ? (void *) writebuf : readbuf;
491 piod.piod_offs = (void *) (long) offset;
495 if (ptrace (PT_IO, pid, (caddr_t)&piod, 0) == 0)
496 /* Return the actual number of bytes read or written. */
497 return piod.piod_len;
498 /* If the PT_IO request is somehow not supported, fallback on
499 using PT_WRITE_D/PT_READ_D. Otherwise we will return zero
500 to indicate failure. */
508 PTRACE_TYPE_RET word;
509 gdb_byte byte[sizeof (PTRACE_TYPE_RET)];
511 ULONGEST rounded_offset;
514 /* Round the start offset down to the next long word
516 rounded_offset = offset & -(ULONGEST) sizeof (PTRACE_TYPE_RET);
518 /* Since ptrace will transfer a single word starting at that
519 rounded_offset the partial_len needs to be adjusted down to
520 that (remember this function only does a single transfer).
521 Should the required length be even less, adjust it down
523 partial_len = (rounded_offset + sizeof (PTRACE_TYPE_RET)) - offset;
524 if (partial_len > len)
529 /* If OFFSET:PARTIAL_LEN is smaller than
530 ROUNDED_OFFSET:WORDSIZE then a read/modify write will
531 be needed. Read in the entire word. */
532 if (rounded_offset < offset
533 || (offset + partial_len
534 < rounded_offset + sizeof (PTRACE_TYPE_RET)))
535 /* Need part of initial word -- fetch it. */
536 buffer.word = ptrace (PT_READ_I, pid,
537 (PTRACE_TYPE_ARG3)(uintptr_t)
540 /* Copy data to be written over corresponding part of
542 memcpy (buffer.byte + (offset - rounded_offset),
543 writebuf, partial_len);
546 ptrace (PT_WRITE_D, pid,
547 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
551 /* Using the appropriate one (I or D) is necessary for
552 Gould NP1, at least. */
554 ptrace (PT_WRITE_I, pid,
555 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
565 buffer.word = ptrace (PT_READ_I, pid,
566 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
570 /* Copy appropriate bytes out of the buffer. */
571 memcpy (readbuf, buffer.byte + (offset - rounded_offset),
578 case TARGET_OBJECT_UNWIND_TABLE:
581 case TARGET_OBJECT_AUXV:
582 #if defined (PT_IO) && defined (PIOD_READ_AUXV)
583 /* OpenBSD 4.5 has a new PIOD_READ_AUXV operation for the PT_IO
584 request that allows us to read the auxilliary vector. Other
585 BSD's may follow if they feel the need to support PIE. */
587 struct ptrace_io_desc piod;
591 piod.piod_op = PIOD_READ_AUXV;
592 piod.piod_addr = readbuf;
593 piod.piod_offs = (void *) (long) offset;
597 if (ptrace (PT_IO, pid, (caddr_t)&piod, 0) == 0)
598 /* Return the actual number of bytes read or written. */
599 return piod.piod_len;
604 case TARGET_OBJECT_WCOOKIE:
612 /* Return non-zero if the thread specified by PTID is alive. */
615 inf_ptrace_thread_alive (struct target_ops *ops, ptid_t ptid)
617 /* ??? Is kill the right way to do this? */
618 return (kill (ptid_get_pid (ptid), 0) != -1);
621 /* Print status information about what we're accessing. */
624 inf_ptrace_files_info (struct target_ops *ignore)
626 struct inferior *inf = current_inferior ();
628 printf_filtered (_("\tUsing the running image of %s %s.\n"),
629 inf->attach_flag ? "attached" : "child",
630 target_pid_to_str (inferior_ptid));
634 inf_ptrace_pid_to_str (struct target_ops *ops, ptid_t ptid)
636 return normal_pid_to_str (ptid);
639 #if defined (PT_IO) && defined (PIOD_READ_AUXV)
641 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
642 Return 0 if *READPTR is already at the end of the buffer.
643 Return -1 if there is insufficient buffer for a whole entry.
644 Return 1 if an entry was read into *TYPEP and *VALP. */
647 inf_ptrace_auxv_parse (struct target_ops *ops, gdb_byte **readptr,
648 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp)
650 struct type *int_type = builtin_type (target_gdbarch ())->builtin_int;
651 struct type *ptr_type = builtin_type (target_gdbarch ())->builtin_data_ptr;
652 const int sizeof_auxv_type = TYPE_LENGTH (int_type);
653 const int sizeof_auxv_val = TYPE_LENGTH (ptr_type);
654 enum bfd_endian byte_order = gdbarch_byte_order (target_gdbarch ());
655 gdb_byte *ptr = *readptr;
660 if (endptr - ptr < 2 * sizeof_auxv_val)
663 *typep = extract_unsigned_integer (ptr, sizeof_auxv_type, byte_order);
664 ptr += sizeof_auxv_val; /* Alignment. */
665 *valp = extract_unsigned_integer (ptr, sizeof_auxv_val, byte_order);
666 ptr += sizeof_auxv_val;
674 /* Create a prototype ptrace target. The client can override it with
678 inf_ptrace_target (void)
680 struct target_ops *t = inf_child_target ();
682 t->to_attach = inf_ptrace_attach;
683 t->to_detach = inf_ptrace_detach;
684 t->to_resume = inf_ptrace_resume;
685 t->to_wait = inf_ptrace_wait;
686 t->to_files_info = inf_ptrace_files_info;
687 t->to_kill = inf_ptrace_kill;
688 t->to_create_inferior = inf_ptrace_create_inferior;
689 #ifdef PT_GET_PROCESS_STATE
690 t->to_follow_fork = inf_ptrace_follow_fork;
691 t->to_post_startup_inferior = inf_ptrace_post_startup_inferior;
692 t->to_post_attach = inf_ptrace_post_attach;
694 t->to_mourn_inferior = inf_ptrace_mourn_inferior;
695 t->to_thread_alive = inf_ptrace_thread_alive;
696 t->to_pid_to_str = inf_ptrace_pid_to_str;
697 t->to_stop = inf_ptrace_stop;
698 t->to_xfer_partial = inf_ptrace_xfer_partial;
699 #if defined (PT_IO) && defined (PIOD_READ_AUXV)
700 t->to_auxv_parse = inf_ptrace_auxv_parse;
707 /* Pointer to a function that returns the offset within the user area
708 where a particular register is stored. */
709 static CORE_ADDR (*inf_ptrace_register_u_offset)(struct gdbarch *, int, int);
711 /* Fetch register REGNUM from the inferior. */
714 inf_ptrace_fetch_register (struct regcache *regcache, int regnum)
716 struct gdbarch *gdbarch = get_regcache_arch (regcache);
719 PTRACE_TYPE_RET *buf;
722 /* This isn't really an address, but ptrace thinks of it as one. */
723 addr = inf_ptrace_register_u_offset (gdbarch, regnum, 0);
724 if (addr == (CORE_ADDR)-1
725 || gdbarch_cannot_fetch_register (gdbarch, regnum))
727 regcache_raw_supply (regcache, regnum, NULL);
731 /* Cater for systems like GNU/Linux, that implement threads as
732 separate processes. */
733 pid = ptid_get_lwp (inferior_ptid);
735 pid = ptid_get_pid (inferior_ptid);
737 size = register_size (gdbarch, regnum);
738 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
741 /* Read the register contents from the inferior a chunk at a time. */
742 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
745 buf[i] = ptrace (PT_READ_U, pid, (PTRACE_TYPE_ARG3)(uintptr_t)addr, 0);
747 error (_("Couldn't read register %s (#%d): %s."),
748 gdbarch_register_name (gdbarch, regnum),
749 regnum, safe_strerror (errno));
751 addr += sizeof (PTRACE_TYPE_RET);
753 regcache_raw_supply (regcache, regnum, buf);
756 /* Fetch register REGNUM from the inferior. If REGNUM is -1, do this
757 for all registers. */
760 inf_ptrace_fetch_registers (struct target_ops *ops,
761 struct regcache *regcache, int regnum)
765 regnum < gdbarch_num_regs (get_regcache_arch (regcache));
767 inf_ptrace_fetch_register (regcache, regnum);
769 inf_ptrace_fetch_register (regcache, regnum);
772 /* Store register REGNUM into the inferior. */
775 inf_ptrace_store_register (const struct regcache *regcache, int regnum)
777 struct gdbarch *gdbarch = get_regcache_arch (regcache);
780 PTRACE_TYPE_RET *buf;
783 /* This isn't really an address, but ptrace thinks of it as one. */
784 addr = inf_ptrace_register_u_offset (gdbarch, regnum, 1);
785 if (addr == (CORE_ADDR)-1
786 || gdbarch_cannot_store_register (gdbarch, regnum))
789 /* Cater for systems like GNU/Linux, that implement threads as
790 separate processes. */
791 pid = ptid_get_lwp (inferior_ptid);
793 pid = ptid_get_pid (inferior_ptid);
795 size = register_size (gdbarch, regnum);
796 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
799 /* Write the register contents into the inferior a chunk at a time. */
800 regcache_raw_collect (regcache, regnum, buf);
801 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
804 ptrace (PT_WRITE_U, pid, (PTRACE_TYPE_ARG3)(uintptr_t)addr, buf[i]);
806 error (_("Couldn't write register %s (#%d): %s."),
807 gdbarch_register_name (gdbarch, regnum),
808 regnum, safe_strerror (errno));
810 addr += sizeof (PTRACE_TYPE_RET);
814 /* Store register REGNUM back into the inferior. If REGNUM is -1, do
815 this for all registers. */
818 inf_ptrace_store_registers (struct target_ops *ops,
819 struct regcache *regcache, int regnum)
823 regnum < gdbarch_num_regs (get_regcache_arch (regcache));
825 inf_ptrace_store_register (regcache, regnum);
827 inf_ptrace_store_register (regcache, regnum);
830 /* Create a "traditional" ptrace target. REGISTER_U_OFFSET should be
831 a function returning the offset within the user area where a
832 particular register is stored. */
835 inf_ptrace_trad_target (CORE_ADDR (*register_u_offset)
836 (struct gdbarch *, int, int))
838 struct target_ops *t = inf_ptrace_target();
840 gdb_assert (register_u_offset);
841 inf_ptrace_register_u_offset = register_u_offset;
842 t->to_fetch_registers = inf_ptrace_fetch_registers;
843 t->to_store_registers = inf_ptrace_store_registers;