1 /* Low-level child interface to ptrace.
3 Copyright (C) 1988-2016 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/>. */
27 #include "nat/gdb_ptrace.h"
31 #include "inf-ptrace.h"
32 #include "inf-child.h"
33 #include "gdbthread.h"
37 #ifdef PT_GET_PROCESS_STATE
39 /* Target hook for follow_fork. On entry and at return inferior_ptid is
40 the ptid of the followed inferior. */
43 inf_ptrace_follow_fork (struct target_ops *ops, int follow_child,
48 struct thread_info *tp = inferior_thread ();
49 pid_t child_pid = ptid_get_pid (tp->pending_follow.value.related_pid);
51 /* Breakpoints have already been detached from the child by
54 if (ptrace (PT_DETACH, child_pid, (PTRACE_TYPE_ARG3)1, 0) == -1)
55 perror_with_name (("ptrace"));
62 inf_ptrace_insert_fork_catchpoint (struct target_ops *self, int pid)
68 inf_ptrace_remove_fork_catchpoint (struct target_ops *self, int pid)
73 #endif /* PT_GET_PROCESS_STATE */
76 /* Prepare to be traced. */
81 /* "Trace me, Dr. Memory!" */
82 ptrace (PT_TRACE_ME, 0, (PTRACE_TYPE_ARG3)0, 0);
85 /* Start a new inferior Unix child process. EXEC_FILE is the file to
86 run, ALLARGS is a string containing the arguments to the program.
87 ENV is the environment vector to pass. If FROM_TTY is non-zero, be
91 inf_ptrace_create_inferior (struct target_ops *ops,
92 char *exec_file, char *allargs, char **env,
97 /* Do not change either targets above or the same target if already present.
98 The reason is the target stack is shared across multiple inferiors. */
99 int ops_already_pushed = target_is_pushed (ops);
100 struct cleanup *back_to = make_cleanup (null_cleanup, NULL);
102 if (! ops_already_pushed)
104 /* Clear possible core file with its process_stratum. */
106 make_cleanup_unpush_target (ops);
109 pid = fork_inferior (exec_file, allargs, env, inf_ptrace_me, NULL,
112 discard_cleanups (back_to);
114 startup_inferior (START_INFERIOR_TRAPS_EXPECTED);
116 /* On some targets, there must be some explicit actions taken after
117 the inferior has been started up. */
118 target_post_startup_inferior (pid_to_ptid (pid));
121 #ifdef PT_GET_PROCESS_STATE
124 inf_ptrace_post_startup_inferior (struct target_ops *self, ptid_t pid)
128 /* Set the initial event mask. */
129 memset (&pe, 0, sizeof pe);
130 pe.pe_set_event |= PTRACE_FORK;
131 if (ptrace (PT_SET_EVENT_MASK, ptid_get_pid (pid),
132 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
133 perror_with_name (("ptrace"));
138 /* Clean up a rotting corpse of an inferior after it died. */
141 inf_ptrace_mourn_inferior (struct target_ops *ops)
145 /* Wait just one more time to collect the inferior's exit status.
146 Do not check whether this succeeds though, since we may be
147 dealing with a process that we attached to. Such a process will
148 only report its exit status to its original parent. */
149 waitpid (ptid_get_pid (inferior_ptid), &status, 0);
151 inf_child_mourn_inferior (ops);
154 /* Attach to the process specified by ARGS. If FROM_TTY is non-zero,
155 be chatty about it. */
158 inf_ptrace_attach (struct target_ops *ops, const char *args, int from_tty)
162 struct inferior *inf;
164 /* Do not change either targets above or the same target if already present.
165 The reason is the target stack is shared across multiple inferiors. */
166 int ops_already_pushed = target_is_pushed (ops);
167 struct cleanup *back_to = make_cleanup (null_cleanup, NULL);
169 pid = parse_pid_to_attach (args);
171 if (pid == getpid ()) /* Trying to masturbate? */
172 error (_("I refuse to debug myself!"));
174 if (! ops_already_pushed)
176 /* target_pid_to_str already uses the target. Also clear possible core
177 file with its process_stratum. */
179 make_cleanup_unpush_target (ops);
184 exec_file = get_exec_file (0);
187 printf_unfiltered (_("Attaching to program: %s, %s\n"), exec_file,
188 target_pid_to_str (pid_to_ptid (pid)));
190 printf_unfiltered (_("Attaching to %s\n"),
191 target_pid_to_str (pid_to_ptid (pid)));
193 gdb_flush (gdb_stdout);
198 ptrace (PT_ATTACH, pid, (PTRACE_TYPE_ARG3)0, 0);
200 perror_with_name (("ptrace"));
202 error (_("This system does not support attaching to a process"));
205 inf = current_inferior ();
206 inferior_appeared (inf, pid);
207 inf->attach_flag = 1;
208 inferior_ptid = pid_to_ptid (pid);
210 /* Always add a main thread. If some target extends the ptrace
211 target, it should decorate the ptid later with more info. */
212 add_thread_silent (inferior_ptid);
214 discard_cleanups (back_to);
217 #ifdef PT_GET_PROCESS_STATE
220 inf_ptrace_post_attach (struct target_ops *self, int pid)
224 /* Set the initial event mask. */
225 memset (&pe, 0, sizeof pe);
226 pe.pe_set_event |= PTRACE_FORK;
227 if (ptrace (PT_SET_EVENT_MASK, pid,
228 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
229 perror_with_name (("ptrace"));
234 /* Detach from the inferior, optionally passing it the signal
235 specified by ARGS. If FROM_TTY is non-zero, be chatty about it. */
238 inf_ptrace_detach (struct target_ops *ops, const char *args, int from_tty)
240 pid_t pid = ptid_get_pid (inferior_ptid);
243 target_announce_detach (from_tty);
248 /* We'd better not have left any breakpoints in the program or it'll
249 die when it hits one. Also note that this may only work if we
250 previously attached to the inferior. It *might* work if we
251 started the process ourselves. */
253 ptrace (PT_DETACH, pid, (PTRACE_TYPE_ARG3)1, sig);
255 perror_with_name (("ptrace"));
257 error (_("This system does not support detaching from a process"));
260 inf_ptrace_detach_success (ops);
263 /* See inf-ptrace.h. */
266 inf_ptrace_detach_success (struct target_ops *ops)
268 pid_t pid = ptid_get_pid (inferior_ptid);
270 inferior_ptid = null_ptid;
271 detach_inferior (pid);
273 inf_child_maybe_unpush_target (ops);
276 /* Kill the inferior. */
279 inf_ptrace_kill (struct target_ops *ops)
281 pid_t pid = ptid_get_pid (inferior_ptid);
287 ptrace (PT_KILL, pid, (PTRACE_TYPE_ARG3)0, 0);
288 waitpid (pid, &status, 0);
290 target_mourn_inferior ();
293 /* Interrupt the inferior. */
296 inf_ptrace_interrupt (struct target_ops *self, ptid_t ptid)
298 /* Send a SIGINT to the process group. This acts just like the user
299 typed a ^C on the controlling terminal. Note that using a
300 negative process number in kill() is a System V-ism. The proper
301 BSD interface is killpg(). However, all modern BSDs support the
302 System V interface too. */
303 kill (-inferior_process_group (), SIGINT);
306 /* Return which PID to pass to ptrace in order to observe/control the
307 tracee identified by PTID. */
310 get_ptrace_pid (ptid_t ptid)
314 /* If we have an LWPID to work with, use it. Otherwise, we're
315 dealing with a non-threaded program/target. */
316 pid = ptid_get_lwp (ptid);
318 pid = ptid_get_pid (ptid);
322 /* Resume execution of thread PTID, or all threads if PTID is -1. If
323 STEP is nonzero, single-step it. If SIGNAL is nonzero, give it
327 inf_ptrace_resume (struct target_ops *ops,
328 ptid_t ptid, int step, enum gdb_signal signal)
333 if (ptid_equal (minus_one_ptid, ptid))
334 /* Resume all threads. Traditionally ptrace() only supports
335 single-threaded processes, so simply resume the inferior. */
336 pid = ptid_get_pid (inferior_ptid);
338 pid = get_ptrace_pid (ptid);
340 if (catch_syscall_enabled () > 0)
341 request = PT_SYSCALL;
343 request = PT_CONTINUE;
347 /* If this system does not support PT_STEP, a higher level
348 function will have called single_step() to transmute the step
349 request into a continue request (by setting breakpoints on
350 all possible successor instructions), so we don't have to
351 worry about that here. */
355 /* An address of (PTRACE_TYPE_ARG3)1 tells ptrace to continue from
356 where it was. If GDB wanted it to start some other way, we have
357 already written a new program counter value to the child. */
359 ptrace (request, pid, (PTRACE_TYPE_ARG3)1, gdb_signal_to_host (signal));
361 perror_with_name (("ptrace"));
364 /* Wait for the child specified by PTID to do something. Return the
365 process ID of the child, or MINUS_ONE_PTID in case of error; store
366 the status in *OURSTATUS. */
369 inf_ptrace_wait (struct target_ops *ops,
370 ptid_t ptid, struct target_waitstatus *ourstatus, int options)
373 int status, save_errno;
381 pid = waitpid (ptid_get_pid (ptid), &status, 0);
384 while (pid == -1 && errno == EINTR);
386 clear_sigint_trap ();
390 fprintf_unfiltered (gdb_stderr,
391 _("Child process unexpectedly missing: %s.\n"),
392 safe_strerror (save_errno));
394 /* Claim it exited with unknown signal. */
395 ourstatus->kind = TARGET_WAITKIND_SIGNALLED;
396 ourstatus->value.sig = GDB_SIGNAL_UNKNOWN;
397 return inferior_ptid;
400 /* Ignore terminated detached child processes. */
401 if (!WIFSTOPPED (status) && pid != ptid_get_pid (inferior_ptid))
406 #ifdef PT_GET_PROCESS_STATE
407 if (WIFSTOPPED (status))
412 if (ptrace (PT_GET_PROCESS_STATE, pid,
413 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
414 perror_with_name (("ptrace"));
416 switch (pe.pe_report_event)
419 ourstatus->kind = TARGET_WAITKIND_FORKED;
420 ourstatus->value.related_pid = pid_to_ptid (pe.pe_other_pid);
422 /* Make sure the other end of the fork is stopped too. */
423 fpid = waitpid (pe.pe_other_pid, &status, 0);
425 perror_with_name (("waitpid"));
427 if (ptrace (PT_GET_PROCESS_STATE, fpid,
428 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
429 perror_with_name (("ptrace"));
431 gdb_assert (pe.pe_report_event == PTRACE_FORK);
432 gdb_assert (pe.pe_other_pid == pid);
433 if (fpid == ptid_get_pid (inferior_ptid))
435 ourstatus->value.related_pid = pid_to_ptid (pe.pe_other_pid);
436 return pid_to_ptid (fpid);
439 return pid_to_ptid (pid);
444 store_waitstatus (ourstatus, status);
445 return pid_to_ptid (pid);
448 /* Implement the to_xfer_partial target_ops method. */
450 static enum target_xfer_status
451 inf_ptrace_xfer_partial (struct target_ops *ops, enum target_object object,
452 const char *annex, gdb_byte *readbuf,
453 const gdb_byte *writebuf,
454 ULONGEST offset, ULONGEST len, ULONGEST *xfered_len)
456 pid_t pid = ptid_get_pid (inferior_ptid);
460 case TARGET_OBJECT_MEMORY:
462 /* OpenBSD 3.1, NetBSD 1.6 and FreeBSD 5.0 have a new PT_IO
463 request that promises to be much more efficient in reading
464 and writing data in the traced process's address space. */
466 struct ptrace_io_desc piod;
468 /* NOTE: We assume that there are no distinct address spaces
469 for instruction and data. However, on OpenBSD 3.9 and
470 later, PIOD_WRITE_D doesn't allow changing memory that's
471 mapped read-only. Since most code segments will be
472 read-only, using PIOD_WRITE_D will prevent us from
473 inserting breakpoints, so we use PIOD_WRITE_I instead. */
474 piod.piod_op = writebuf ? PIOD_WRITE_I : PIOD_READ_D;
475 piod.piod_addr = writebuf ? (void *) writebuf : readbuf;
476 piod.piod_offs = (void *) (long) offset;
480 if (ptrace (PT_IO, pid, (caddr_t)&piod, 0) == 0)
482 /* Return the actual number of bytes read or written. */
483 *xfered_len = piod.piod_len;
484 return (piod.piod_len == 0) ? TARGET_XFER_EOF : TARGET_XFER_OK;
486 /* If the PT_IO request is somehow not supported, fallback on
487 using PT_WRITE_D/PT_READ_D. Otherwise we will return zero
488 to indicate failure. */
490 return TARGET_XFER_EOF;
496 PTRACE_TYPE_RET word;
497 gdb_byte byte[sizeof (PTRACE_TYPE_RET)];
499 ULONGEST rounded_offset;
500 ULONGEST partial_len;
502 /* Round the start offset down to the next long word
504 rounded_offset = offset & -(ULONGEST) sizeof (PTRACE_TYPE_RET);
506 /* Since ptrace will transfer a single word starting at that
507 rounded_offset the partial_len needs to be adjusted down to
508 that (remember this function only does a single transfer).
509 Should the required length be even less, adjust it down
511 partial_len = (rounded_offset + sizeof (PTRACE_TYPE_RET)) - offset;
512 if (partial_len > len)
517 /* If OFFSET:PARTIAL_LEN is smaller than
518 ROUNDED_OFFSET:WORDSIZE then a read/modify write will
519 be needed. Read in the entire word. */
520 if (rounded_offset < offset
521 || (offset + partial_len
522 < rounded_offset + sizeof (PTRACE_TYPE_RET)))
523 /* Need part of initial word -- fetch it. */
524 buffer.word = ptrace (PT_READ_I, pid,
525 (PTRACE_TYPE_ARG3)(uintptr_t)
528 /* Copy data to be written over corresponding part of
530 memcpy (buffer.byte + (offset - rounded_offset),
531 writebuf, partial_len);
534 ptrace (PT_WRITE_D, pid,
535 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
539 /* Using the appropriate one (I or D) is necessary for
540 Gould NP1, at least. */
542 ptrace (PT_WRITE_I, pid,
543 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
546 return TARGET_XFER_EOF;
553 buffer.word = ptrace (PT_READ_I, pid,
554 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
557 return TARGET_XFER_EOF;
558 /* Copy appropriate bytes out of the buffer. */
559 memcpy (readbuf, buffer.byte + (offset - rounded_offset),
563 *xfered_len = partial_len;
564 return TARGET_XFER_OK;
567 case TARGET_OBJECT_UNWIND_TABLE:
568 return TARGET_XFER_E_IO;
570 case TARGET_OBJECT_AUXV:
571 #if defined (PT_IO) && defined (PIOD_READ_AUXV)
572 /* OpenBSD 4.5 has a new PIOD_READ_AUXV operation for the PT_IO
573 request that allows us to read the auxilliary vector. Other
574 BSD's may follow if they feel the need to support PIE. */
576 struct ptrace_io_desc piod;
579 return TARGET_XFER_E_IO;
580 piod.piod_op = PIOD_READ_AUXV;
581 piod.piod_addr = readbuf;
582 piod.piod_offs = (void *) (long) offset;
586 if (ptrace (PT_IO, pid, (caddr_t)&piod, 0) == 0)
588 /* Return the actual number of bytes read or written. */
589 *xfered_len = piod.piod_len;
590 return (piod.piod_len == 0) ? TARGET_XFER_EOF : TARGET_XFER_OK;
594 return TARGET_XFER_E_IO;
596 case TARGET_OBJECT_WCOOKIE:
597 return TARGET_XFER_E_IO;
600 return TARGET_XFER_E_IO;
604 /* Return non-zero if the thread specified by PTID is alive. */
607 inf_ptrace_thread_alive (struct target_ops *ops, ptid_t ptid)
609 /* ??? Is kill the right way to do this? */
610 return (kill (ptid_get_pid (ptid), 0) != -1);
613 /* Print status information about what we're accessing. */
616 inf_ptrace_files_info (struct target_ops *ignore)
618 struct inferior *inf = current_inferior ();
620 printf_filtered (_("\tUsing the running image of %s %s.\n"),
621 inf->attach_flag ? "attached" : "child",
622 target_pid_to_str (inferior_ptid));
626 inf_ptrace_pid_to_str (struct target_ops *ops, ptid_t ptid)
628 return normal_pid_to_str (ptid);
631 #if defined (PT_IO) && defined (PIOD_READ_AUXV)
633 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
634 Return 0 if *READPTR is already at the end of the buffer.
635 Return -1 if there is insufficient buffer for a whole entry.
636 Return 1 if an entry was read into *TYPEP and *VALP. */
639 inf_ptrace_auxv_parse (struct target_ops *ops, gdb_byte **readptr,
640 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp)
642 struct type *int_type = builtin_type (target_gdbarch ())->builtin_int;
643 struct type *ptr_type = builtin_type (target_gdbarch ())->builtin_data_ptr;
644 const int sizeof_auxv_type = TYPE_LENGTH (int_type);
645 const int sizeof_auxv_val = TYPE_LENGTH (ptr_type);
646 enum bfd_endian byte_order = gdbarch_byte_order (target_gdbarch ());
647 gdb_byte *ptr = *readptr;
652 if (endptr - ptr < 2 * sizeof_auxv_val)
655 *typep = extract_unsigned_integer (ptr, sizeof_auxv_type, byte_order);
656 ptr += sizeof_auxv_val; /* Alignment. */
657 *valp = extract_unsigned_integer (ptr, sizeof_auxv_val, byte_order);
658 ptr += sizeof_auxv_val;
666 /* Create a prototype ptrace target. The client can override it with
670 inf_ptrace_target (void)
672 struct target_ops *t = inf_child_target ();
674 t->to_attach = inf_ptrace_attach;
675 t->to_detach = inf_ptrace_detach;
676 t->to_resume = inf_ptrace_resume;
677 t->to_wait = inf_ptrace_wait;
678 t->to_files_info = inf_ptrace_files_info;
679 t->to_kill = inf_ptrace_kill;
680 t->to_create_inferior = inf_ptrace_create_inferior;
681 #ifdef PT_GET_PROCESS_STATE
682 t->to_follow_fork = inf_ptrace_follow_fork;
683 t->to_insert_fork_catchpoint = inf_ptrace_insert_fork_catchpoint;
684 t->to_remove_fork_catchpoint = inf_ptrace_remove_fork_catchpoint;
685 t->to_post_startup_inferior = inf_ptrace_post_startup_inferior;
686 t->to_post_attach = inf_ptrace_post_attach;
688 t->to_mourn_inferior = inf_ptrace_mourn_inferior;
689 t->to_thread_alive = inf_ptrace_thread_alive;
690 t->to_pid_to_str = inf_ptrace_pid_to_str;
691 t->to_interrupt = inf_ptrace_interrupt;
692 t->to_xfer_partial = inf_ptrace_xfer_partial;
693 #if defined (PT_IO) && defined (PIOD_READ_AUXV)
694 t->to_auxv_parse = inf_ptrace_auxv_parse;
701 /* Pointer to a function that returns the offset within the user area
702 where a particular register is stored. */
703 static CORE_ADDR (*inf_ptrace_register_u_offset)(struct gdbarch *, int, int);
705 /* Fetch register REGNUM from the inferior. */
708 inf_ptrace_fetch_register (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, 0);
718 if (addr == (CORE_ADDR)-1
719 || gdbarch_cannot_fetch_register (gdbarch, regnum))
721 regcache_raw_supply (regcache, regnum, NULL);
725 /* Cater for systems like GNU/Linux, that implement threads as
726 separate processes. */
727 pid = ptid_get_lwp (inferior_ptid);
729 pid = ptid_get_pid (inferior_ptid);
731 size = register_size (gdbarch, regnum);
732 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
733 buf = (PTRACE_TYPE_RET *) alloca (size);
735 /* Read the register contents from the inferior a chunk at a time. */
736 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
739 buf[i] = ptrace (PT_READ_U, pid, (PTRACE_TYPE_ARG3)(uintptr_t)addr, 0);
741 error (_("Couldn't read register %s (#%d): %s."),
742 gdbarch_register_name (gdbarch, regnum),
743 regnum, safe_strerror (errno));
745 addr += sizeof (PTRACE_TYPE_RET);
747 regcache_raw_supply (regcache, regnum, buf);
750 /* Fetch register REGNUM from the inferior. If REGNUM is -1, do this
751 for all registers. */
754 inf_ptrace_fetch_registers (struct target_ops *ops,
755 struct regcache *regcache, int regnum)
759 regnum < gdbarch_num_regs (get_regcache_arch (regcache));
761 inf_ptrace_fetch_register (regcache, regnum);
763 inf_ptrace_fetch_register (regcache, regnum);
766 /* Store register REGNUM into the inferior. */
769 inf_ptrace_store_register (const struct regcache *regcache, int regnum)
771 struct gdbarch *gdbarch = get_regcache_arch (regcache);
774 PTRACE_TYPE_RET *buf;
777 /* This isn't really an address, but ptrace thinks of it as one. */
778 addr = inf_ptrace_register_u_offset (gdbarch, regnum, 1);
779 if (addr == (CORE_ADDR)-1
780 || gdbarch_cannot_store_register (gdbarch, regnum))
783 /* Cater for systems like GNU/Linux, that implement threads as
784 separate processes. */
785 pid = ptid_get_lwp (inferior_ptid);
787 pid = ptid_get_pid (inferior_ptid);
789 size = register_size (gdbarch, regnum);
790 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
791 buf = (PTRACE_TYPE_RET *) alloca (size);
793 /* Write the register contents into the inferior a chunk at a time. */
794 regcache_raw_collect (regcache, regnum, buf);
795 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
798 ptrace (PT_WRITE_U, pid, (PTRACE_TYPE_ARG3)(uintptr_t)addr, buf[i]);
800 error (_("Couldn't write register %s (#%d): %s."),
801 gdbarch_register_name (gdbarch, regnum),
802 regnum, safe_strerror (errno));
804 addr += sizeof (PTRACE_TYPE_RET);
808 /* Store register REGNUM back into the inferior. If REGNUM is -1, do
809 this for all registers. */
812 inf_ptrace_store_registers (struct target_ops *ops,
813 struct regcache *regcache, int regnum)
817 regnum < gdbarch_num_regs (get_regcache_arch (regcache));
819 inf_ptrace_store_register (regcache, regnum);
821 inf_ptrace_store_register (regcache, regnum);
824 /* Create a "traditional" ptrace target. REGISTER_U_OFFSET should be
825 a function returning the offset within the user area where a
826 particular register is stored. */
829 inf_ptrace_trad_target (CORE_ADDR (*register_u_offset)
830 (struct gdbarch *, int, int))
832 struct target_ops *t = inf_ptrace_target();
834 gdb_assert (register_u_offset);
835 inf_ptrace_register_u_offset = register_u_offset;
836 t->to_fetch_registers = inf_ptrace_fetch_registers;
837 t->to_store_registers = inf_ptrace_store_registers;