1 /* Low-level child interface to ptrace.
3 Copyright (C) 1988-1996, 1998-2002, 2004-2012 Free Software
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
29 #include "gdb_assert.h"
30 #include "gdb_string.h"
31 #include "gdb_ptrace.h"
35 #include "inf-ptrace.h"
36 #include "inf-child.h"
37 #include "gdbthread.h"
41 #ifdef PT_GET_PROCESS_STATE
44 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 = NULL;
128 if (! ops_already_pushed)
130 /* Clear possible core file with its process_stratum. */
132 back_to = make_cleanup_unpush_target (ops);
135 pid = fork_inferior (exec_file, allargs, env, inf_ptrace_me, NULL,
138 if (! ops_already_pushed)
139 discard_cleanups (back_to);
141 /* START_INFERIOR_TRAPS_EXPECTED is defined in inferior.h, and will
142 be 1 or 2 depending on whether we're starting without or with a
144 startup_inferior (START_INFERIOR_TRAPS_EXPECTED);
146 /* On some targets, there must be some explicit actions taken after
147 the inferior has been started up. */
148 target_post_startup_inferior (pid_to_ptid (pid));
151 #ifdef PT_GET_PROCESS_STATE
154 inf_ptrace_post_startup_inferior (ptid_t pid)
158 /* Set the initial event mask. */
159 memset (&pe, 0, sizeof pe);
160 pe.pe_set_event |= PTRACE_FORK;
161 if (ptrace (PT_SET_EVENT_MASK, ptid_get_pid (pid),
162 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
163 perror_with_name (("ptrace"));
168 /* Clean up a rotting corpse of an inferior after it died. */
171 inf_ptrace_mourn_inferior (struct target_ops *ops)
175 /* Wait just one more time to collect the inferior's exit status.
176 Do not check whether this succeeds though, since we may be
177 dealing with a process that we attached to. Such a process will
178 only report its exit status to its original parent. */
179 waitpid (ptid_get_pid (inferior_ptid), &status, 0);
181 generic_mourn_inferior ();
183 if (!have_inferiors ())
187 /* Attach to the process specified by ARGS. If FROM_TTY is non-zero,
188 be chatty about it. */
191 inf_ptrace_attach (struct target_ops *ops, char *args, int from_tty)
195 struct inferior *inf;
197 /* Do not change either targets above or the same target if already present.
198 The reason is the target stack is shared across multiple inferiors. */
199 int ops_already_pushed = target_is_pushed (ops);
200 struct cleanup *back_to = NULL;
202 pid = parse_pid_to_attach (args);
204 if (pid == getpid ()) /* Trying to masturbate? */
205 error (_("I refuse to debug myself!"));
207 if (! ops_already_pushed)
209 /* target_pid_to_str already uses the target. Also clear possible core
210 file with its process_stratum. */
212 back_to = make_cleanup_unpush_target (ops);
217 exec_file = get_exec_file (0);
220 printf_unfiltered (_("Attaching to program: %s, %s\n"), exec_file,
221 target_pid_to_str (pid_to_ptid (pid)));
223 printf_unfiltered (_("Attaching to %s\n"),
224 target_pid_to_str (pid_to_ptid (pid)));
226 gdb_flush (gdb_stdout);
231 ptrace (PT_ATTACH, pid, (PTRACE_TYPE_ARG3)0, 0);
233 perror_with_name (("ptrace"));
235 error (_("This system does not support attaching to a process"));
238 inf = current_inferior ();
239 inferior_appeared (inf, pid);
240 inf->attach_flag = 1;
241 inferior_ptid = pid_to_ptid (pid);
243 /* Always add a main thread. If some target extends the ptrace
244 target, it should decorate the ptid later with more info. */
245 add_thread_silent (inferior_ptid);
247 if (! ops_already_pushed)
248 discard_cleanups (back_to);
251 #ifdef PT_GET_PROCESS_STATE
254 inf_ptrace_post_attach (int pid)
258 /* Set the initial event mask. */
259 memset (&pe, 0, sizeof pe);
260 pe.pe_set_event |= PTRACE_FORK;
261 if (ptrace (PT_SET_EVENT_MASK, pid,
262 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
263 perror_with_name (("ptrace"));
268 /* Detach from the inferior, optionally passing it the signal
269 specified by ARGS. If FROM_TTY is non-zero, be chatty about it. */
272 inf_ptrace_detach (struct target_ops *ops, char *args, int from_tty)
274 pid_t pid = ptid_get_pid (inferior_ptid);
279 char *exec_file = get_exec_file (0);
282 printf_unfiltered (_("Detaching from program: %s, %s\n"), exec_file,
283 target_pid_to_str (pid_to_ptid (pid)));
284 gdb_flush (gdb_stdout);
290 /* We'd better not have left any breakpoints in the program or it'll
291 die when it hits one. Also note that this may only work if we
292 previously attached to the inferior. It *might* work if we
293 started the process ourselves. */
295 ptrace (PT_DETACH, pid, (PTRACE_TYPE_ARG3)1, sig);
297 perror_with_name (("ptrace"));
299 error (_("This system does not support detaching from a process"));
302 inferior_ptid = null_ptid;
303 detach_inferior (pid);
305 if (!have_inferiors ())
309 /* Kill the inferior. */
312 inf_ptrace_kill (struct target_ops *ops)
314 pid_t pid = ptid_get_pid (inferior_ptid);
320 ptrace (PT_KILL, pid, (PTRACE_TYPE_ARG3)0, 0);
321 waitpid (pid, &status, 0);
323 target_mourn_inferior ();
326 /* Stop the inferior. */
329 inf_ptrace_stop (ptid_t ptid)
331 /* Send a SIGINT to the process group. This acts just like the user
332 typed a ^C on the controlling terminal. Note that using a
333 negative process number in kill() is a System V-ism. The proper
334 BSD interface is killpg(). However, all modern BSDs support the
335 System V interface too. */
336 kill (-inferior_process_group (), SIGINT);
339 /* Resume execution of thread PTID, or all threads if PTID is -1. If
340 STEP is nonzero, single-step it. If SIGNAL is nonzero, give it
344 inf_ptrace_resume (struct target_ops *ops,
345 ptid_t ptid, int step, enum target_signal signal)
347 pid_t pid = ptid_get_pid (ptid);
351 /* Resume all threads. Traditionally ptrace() only supports
352 single-threaded processes, so simply resume the inferior. */
353 pid = ptid_get_pid (inferior_ptid);
355 if (catch_syscall_enabled () > 0)
356 request = PT_SYSCALL;
358 request = PT_CONTINUE;
362 /* If this system does not support PT_STEP, a higher level
363 function will have called single_step() to transmute the step
364 request into a continue request (by setting breakpoints on
365 all possible successor instructions), so we don't have to
366 worry about that here. */
370 /* An address of (PTRACE_TYPE_ARG3)1 tells ptrace to continue from
371 where it was. If GDB wanted it to start some other way, we have
372 already written a new program counter value to the child. */
374 ptrace (request, pid, (PTRACE_TYPE_ARG3)1, target_signal_to_host (signal));
376 perror_with_name (("ptrace"));
379 /* Wait for the child specified by PTID to do something. Return the
380 process ID of the child, or MINUS_ONE_PTID in case of error; store
381 the status in *OURSTATUS. */
384 inf_ptrace_wait (struct target_ops *ops,
385 ptid_t ptid, struct target_waitstatus *ourstatus, int options)
388 int status, save_errno;
396 pid = waitpid (ptid_get_pid (ptid), &status, 0);
399 while (pid == -1 && errno == EINTR);
401 clear_sigint_trap ();
405 fprintf_unfiltered (gdb_stderr,
406 _("Child process unexpectedly missing: %s.\n"),
407 safe_strerror (save_errno));
409 /* Claim it exited with unknown signal. */
410 ourstatus->kind = TARGET_WAITKIND_SIGNALLED;
411 ourstatus->value.sig = TARGET_SIGNAL_UNKNOWN;
412 return inferior_ptid;
415 /* Ignore terminated detached child processes. */
416 if (!WIFSTOPPED (status) && pid != ptid_get_pid (inferior_ptid))
421 #ifdef PT_GET_PROCESS_STATE
422 if (WIFSTOPPED (status))
427 if (ptrace (PT_GET_PROCESS_STATE, pid,
428 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
429 perror_with_name (("ptrace"));
431 switch (pe.pe_report_event)
434 ourstatus->kind = TARGET_WAITKIND_FORKED;
435 ourstatus->value.related_pid = pid_to_ptid (pe.pe_other_pid);
437 /* Make sure the other end of the fork is stopped too. */
438 fpid = waitpid (pe.pe_other_pid, &status, 0);
440 perror_with_name (("waitpid"));
442 if (ptrace (PT_GET_PROCESS_STATE, fpid,
443 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
444 perror_with_name (("ptrace"));
446 gdb_assert (pe.pe_report_event == PTRACE_FORK);
447 gdb_assert (pe.pe_other_pid == pid);
448 if (fpid == ptid_get_pid (inferior_ptid))
450 ourstatus->value.related_pid = pid_to_ptid (pe.pe_other_pid);
451 return pid_to_ptid (fpid);
454 return pid_to_ptid (pid);
459 store_waitstatus (ourstatus, status);
460 return pid_to_ptid (pid);
463 /* Attempt a transfer all LEN bytes starting at OFFSET between the
464 inferior's OBJECT:ANNEX space and GDB's READBUF/WRITEBUF buffer.
465 Return the number of bytes actually transferred. */
468 inf_ptrace_xfer_partial (struct target_ops *ops, enum target_object object,
469 const char *annex, gdb_byte *readbuf,
470 const gdb_byte *writebuf,
471 ULONGEST offset, LONGEST len)
473 pid_t pid = ptid_get_pid (inferior_ptid);
477 case TARGET_OBJECT_MEMORY:
479 /* OpenBSD 3.1, NetBSD 1.6 and FreeBSD 5.0 have a new PT_IO
480 request that promises to be much more efficient in reading
481 and writing data in the traced process's address space. */
483 struct ptrace_io_desc piod;
485 /* NOTE: We assume that there are no distinct address spaces
486 for instruction and data. However, on OpenBSD 3.9 and
487 later, PIOD_WRITE_D doesn't allow changing memory that's
488 mapped read-only. Since most code segments will be
489 read-only, using PIOD_WRITE_D will prevent us from
490 inserting breakpoints, so we use PIOD_WRITE_I instead. */
491 piod.piod_op = writebuf ? PIOD_WRITE_I : PIOD_READ_D;
492 piod.piod_addr = writebuf ? (void *) writebuf : readbuf;
493 piod.piod_offs = (void *) (long) offset;
497 if (ptrace (PT_IO, pid, (caddr_t)&piod, 0) == 0)
498 /* Return the actual number of bytes read or written. */
499 return piod.piod_len;
500 /* If the PT_IO request is somehow not supported, fallback on
501 using PT_WRITE_D/PT_READ_D. Otherwise we will return zero
502 to indicate failure. */
510 PTRACE_TYPE_RET word;
511 gdb_byte byte[sizeof (PTRACE_TYPE_RET)];
513 ULONGEST rounded_offset;
516 /* Round the start offset down to the next long word
518 rounded_offset = offset & -(ULONGEST) sizeof (PTRACE_TYPE_RET);
520 /* Since ptrace will transfer a single word starting at that
521 rounded_offset the partial_len needs to be adjusted down to
522 that (remember this function only does a single transfer).
523 Should the required length be even less, adjust it down
525 partial_len = (rounded_offset + sizeof (PTRACE_TYPE_RET)) - offset;
526 if (partial_len > len)
531 /* If OFFSET:PARTIAL_LEN is smaller than
532 ROUNDED_OFFSET:WORDSIZE then a read/modify write will
533 be needed. Read in the entire word. */
534 if (rounded_offset < offset
535 || (offset + partial_len
536 < rounded_offset + sizeof (PTRACE_TYPE_RET)))
537 /* Need part of initial word -- fetch it. */
538 buffer.word = ptrace (PT_READ_I, pid,
539 (PTRACE_TYPE_ARG3)(uintptr_t)
542 /* Copy data to be written over corresponding part of
544 memcpy (buffer.byte + (offset - rounded_offset),
545 writebuf, partial_len);
548 ptrace (PT_WRITE_D, pid,
549 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
553 /* Using the appropriate one (I or D) is necessary for
554 Gould NP1, at least. */
556 ptrace (PT_WRITE_I, pid,
557 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
567 buffer.word = ptrace (PT_READ_I, pid,
568 (PTRACE_TYPE_ARG3)(uintptr_t)rounded_offset,
572 /* Copy appropriate bytes out of the buffer. */
573 memcpy (readbuf, buffer.byte + (offset - rounded_offset),
580 case TARGET_OBJECT_UNWIND_TABLE:
583 case TARGET_OBJECT_AUXV:
584 #if defined (PT_IO) && defined (PIOD_READ_AUXV)
585 /* OpenBSD 4.5 has a new PIOD_READ_AUXV operation for the PT_IO
586 request that allows us to read the auxilliary vector. Other
587 BSD's may follow if they feel the need to support PIE. */
589 struct ptrace_io_desc piod;
593 piod.piod_op = PIOD_READ_AUXV;
594 piod.piod_addr = readbuf;
595 piod.piod_offs = (void *) (long) offset;
599 if (ptrace (PT_IO, pid, (caddr_t)&piod, 0) == 0)
600 /* Return the actual number of bytes read or written. */
601 return piod.piod_len;
606 case TARGET_OBJECT_WCOOKIE:
614 /* Return non-zero if the thread specified by PTID is alive. */
617 inf_ptrace_thread_alive (struct target_ops *ops, ptid_t ptid)
619 /* ??? Is kill the right way to do this? */
620 return (kill (ptid_get_pid (ptid), 0) != -1);
623 /* Print status information about what we're accessing. */
626 inf_ptrace_files_info (struct target_ops *ignore)
628 struct inferior *inf = current_inferior ();
630 printf_filtered (_("\tUsing the running image of %s %s.\n"),
631 inf->attach_flag ? "attached" : "child",
632 target_pid_to_str (inferior_ptid));
636 inf_ptrace_pid_to_str (struct target_ops *ops, ptid_t ptid)
638 return normal_pid_to_str (ptid);
641 #if defined (PT_IO) && defined (PIOD_READ_AUXV)
643 /* Read one auxv entry from *READPTR, not reading locations >= ENDPTR.
644 Return 0 if *READPTR is already at the end of the buffer.
645 Return -1 if there is insufficient buffer for a whole entry.
646 Return 1 if an entry was read into *TYPEP and *VALP. */
649 inf_ptrace_auxv_parse (struct target_ops *ops, gdb_byte **readptr,
650 gdb_byte *endptr, CORE_ADDR *typep, CORE_ADDR *valp)
652 struct type *int_type = builtin_type (target_gdbarch)->builtin_int;
653 struct type *ptr_type = builtin_type (target_gdbarch)->builtin_data_ptr;
654 const int sizeof_auxv_type = TYPE_LENGTH (int_type);
655 const int sizeof_auxv_val = TYPE_LENGTH (ptr_type);
656 enum bfd_endian byte_order = gdbarch_byte_order (target_gdbarch);
657 gdb_byte *ptr = *readptr;
662 if (endptr - ptr < 2 * sizeof_auxv_val)
665 *typep = extract_unsigned_integer (ptr, sizeof_auxv_type, byte_order);
666 ptr += sizeof_auxv_val; /* Alignment. */
667 *valp = extract_unsigned_integer (ptr, sizeof_auxv_val, byte_order);
668 ptr += sizeof_auxv_val;
676 /* Create a prototype ptrace target. The client can override it with
680 inf_ptrace_target (void)
682 struct target_ops *t = inf_child_target ();
684 t->to_attach = inf_ptrace_attach;
685 t->to_detach = inf_ptrace_detach;
686 t->to_resume = inf_ptrace_resume;
687 t->to_wait = inf_ptrace_wait;
688 t->to_files_info = inf_ptrace_files_info;
689 t->to_kill = inf_ptrace_kill;
690 t->to_create_inferior = inf_ptrace_create_inferior;
691 #ifdef PT_GET_PROCESS_STATE
692 t->to_follow_fork = inf_ptrace_follow_fork;
693 t->to_post_startup_inferior = inf_ptrace_post_startup_inferior;
694 t->to_post_attach = inf_ptrace_post_attach;
696 t->to_mourn_inferior = inf_ptrace_mourn_inferior;
697 t->to_thread_alive = inf_ptrace_thread_alive;
698 t->to_pid_to_str = inf_ptrace_pid_to_str;
699 t->to_stop = inf_ptrace_stop;
700 t->to_xfer_partial = inf_ptrace_xfer_partial;
701 #if defined (PT_IO) && defined (PIOD_READ_AUXV)
702 t->to_auxv_parse = inf_ptrace_auxv_parse;
709 /* Pointer to a function that returns the offset within the user area
710 where a particular register is stored. */
711 static CORE_ADDR (*inf_ptrace_register_u_offset)(struct gdbarch *, int, int);
713 /* Fetch register REGNUM from the inferior. */
716 inf_ptrace_fetch_register (struct regcache *regcache, int regnum)
718 struct gdbarch *gdbarch = get_regcache_arch (regcache);
721 PTRACE_TYPE_RET *buf;
724 /* This isn't really an address, but ptrace thinks of it as one. */
725 addr = inf_ptrace_register_u_offset (gdbarch, regnum, 0);
726 if (addr == (CORE_ADDR)-1
727 || gdbarch_cannot_fetch_register (gdbarch, regnum))
729 regcache_raw_supply (regcache, regnum, NULL);
733 /* Cater for systems like GNU/Linux, that implement threads as
734 separate processes. */
735 pid = ptid_get_lwp (inferior_ptid);
737 pid = ptid_get_pid (inferior_ptid);
739 size = register_size (gdbarch, regnum);
740 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
743 /* Read the register contents from the inferior a chunk at a time. */
744 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
747 buf[i] = ptrace (PT_READ_U, pid, (PTRACE_TYPE_ARG3)(uintptr_t)addr, 0);
749 error (_("Couldn't read register %s (#%d): %s."),
750 gdbarch_register_name (gdbarch, regnum),
751 regnum, safe_strerror (errno));
753 addr += sizeof (PTRACE_TYPE_RET);
755 regcache_raw_supply (regcache, regnum, buf);
758 /* Fetch register REGNUM from the inferior. If REGNUM is -1, do this
759 for all registers. */
762 inf_ptrace_fetch_registers (struct target_ops *ops,
763 struct regcache *regcache, int regnum)
767 regnum < gdbarch_num_regs (get_regcache_arch (regcache));
769 inf_ptrace_fetch_register (regcache, regnum);
771 inf_ptrace_fetch_register (regcache, regnum);
774 /* Store register REGNUM into the inferior. */
777 inf_ptrace_store_register (const struct regcache *regcache, int regnum)
779 struct gdbarch *gdbarch = get_regcache_arch (regcache);
782 PTRACE_TYPE_RET *buf;
785 /* This isn't really an address, but ptrace thinks of it as one. */
786 addr = inf_ptrace_register_u_offset (gdbarch, regnum, 1);
787 if (addr == (CORE_ADDR)-1
788 || gdbarch_cannot_store_register (gdbarch, regnum))
791 /* Cater for systems like GNU/Linux, that implement threads as
792 separate processes. */
793 pid = ptid_get_lwp (inferior_ptid);
795 pid = ptid_get_pid (inferior_ptid);
797 size = register_size (gdbarch, regnum);
798 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
801 /* Write the register contents into the inferior a chunk at a time. */
802 regcache_raw_collect (regcache, regnum, buf);
803 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
806 ptrace (PT_WRITE_U, pid, (PTRACE_TYPE_ARG3)(uintptr_t)addr, buf[i]);
808 error (_("Couldn't write register %s (#%d): %s."),
809 gdbarch_register_name (gdbarch, regnum),
810 regnum, safe_strerror (errno));
812 addr += sizeof (PTRACE_TYPE_RET);
816 /* Store register REGNUM back into the inferior. If REGNUM is -1, do
817 this for all registers. */
820 inf_ptrace_store_registers (struct target_ops *ops,
821 struct regcache *regcache, int regnum)
825 regnum < gdbarch_num_regs (get_regcache_arch (regcache));
827 inf_ptrace_store_register (regcache, regnum);
829 inf_ptrace_store_register (regcache, regnum);
832 /* Create a "traditional" ptrace target. REGISTER_U_OFFSET should be
833 a function returning the offset within the user area where a
834 particular register is stored. */
837 inf_ptrace_trad_target (CORE_ADDR (*register_u_offset)
838 (struct gdbarch *, int, int))
840 struct target_ops *t = inf_ptrace_target();
842 gdb_assert (register_u_offset);
843 inf_ptrace_register_u_offset = register_u_offset;
844 t->to_fetch_registers = inf_ptrace_fetch_registers;
845 t->to_store_registers = inf_ptrace_store_registers;