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, 2011
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 /* Do not change either targets above or the same target if already present.
125 The reason is the target stack is shared across multiple inferiors. */
126 int ops_already_pushed
= target_is_pushed (ops
);
127 struct cleanup
*back_to
= NULL
;
129 if (! ops_already_pushed
)
131 /* Clear possible core file with its process_stratum. */
133 back_to
= make_cleanup_unpush_target (ops
);
136 pid
= fork_inferior (exec_file
, allargs
, env
, inf_ptrace_me
, NULL
,
139 if (! ops_already_pushed
)
140 discard_cleanups (back_to
);
142 /* START_INFERIOR_TRAPS_EXPECTED is defined in inferior.h, and will
143 be 1 or 2 depending on whether we're starting without or with a
145 startup_inferior (START_INFERIOR_TRAPS_EXPECTED
);
147 /* On some targets, there must be some explicit actions taken after
148 the inferior has been started up. */
149 target_post_startup_inferior (pid_to_ptid (pid
));
152 #ifdef PT_GET_PROCESS_STATE
155 inf_ptrace_post_startup_inferior (ptid_t pid
)
159 /* Set the initial event mask. */
160 memset (&pe
, 0, sizeof pe
);
161 pe
.pe_set_event
|= PTRACE_FORK
;
162 if (ptrace (PT_SET_EVENT_MASK
, ptid_get_pid (pid
),
163 (PTRACE_TYPE_ARG3
)&pe
, sizeof pe
) == -1)
164 perror_with_name (("ptrace"));
169 /* Clean up a rotting corpse of an inferior after it died. */
172 inf_ptrace_mourn_inferior (struct target_ops
*ops
)
176 /* Wait just one more time to collect the inferior's exit status.
177 Do not check whether this succeeds though, since we may be
178 dealing with a process that we attached to. Such a process will
179 only report its exit status to its original parent. */
180 waitpid (ptid_get_pid (inferior_ptid
), &status
, 0);
182 generic_mourn_inferior ();
184 if (!have_inferiors ())
188 /* Attach to the process specified by ARGS. If FROM_TTY is non-zero,
189 be chatty about it. */
192 inf_ptrace_attach (struct target_ops
*ops
, char *args
, int from_tty
)
196 struct inferior
*inf
;
198 /* Do not change either targets above or the same target if already present.
199 The reason is the target stack is shared across multiple inferiors. */
200 int ops_already_pushed
= target_is_pushed (ops
);
201 struct cleanup
*back_to
= NULL
;
203 pid
= parse_pid_to_attach (args
);
205 if (pid
== getpid ()) /* Trying to masturbate? */
206 error (_("I refuse to debug myself!"));
208 if (! ops_already_pushed
)
210 /* target_pid_to_str already uses the target. Also clear possible core
211 file with its process_stratum. */
213 back_to
= make_cleanup_unpush_target (ops
);
218 exec_file
= get_exec_file (0);
221 printf_unfiltered (_("Attaching to program: %s, %s\n"), exec_file
,
222 target_pid_to_str (pid_to_ptid (pid
)));
224 printf_unfiltered (_("Attaching to %s\n"),
225 target_pid_to_str (pid_to_ptid (pid
)));
227 gdb_flush (gdb_stdout
);
232 ptrace (PT_ATTACH
, pid
, (PTRACE_TYPE_ARG3
)0, 0);
234 perror_with_name (("ptrace"));
236 error (_("This system does not support attaching to a process"));
239 inf
= current_inferior ();
240 inferior_appeared (inf
, pid
);
241 inf
->attach_flag
= 1;
242 inferior_ptid
= pid_to_ptid (pid
);
244 /* Always add a main thread. If some target extends the ptrace
245 target, it should decorate the ptid later with more info. */
246 add_thread_silent (inferior_ptid
);
248 if (! ops_already_pushed
)
249 discard_cleanups (back_to
);
252 #ifdef PT_GET_PROCESS_STATE
255 inf_ptrace_post_attach (int pid
)
259 /* Set the initial event mask. */
260 memset (&pe
, 0, sizeof pe
);
261 pe
.pe_set_event
|= PTRACE_FORK
;
262 if (ptrace (PT_SET_EVENT_MASK
, pid
,
263 (PTRACE_TYPE_ARG3
)&pe
, sizeof pe
) == -1)
264 perror_with_name (("ptrace"));
269 /* Detach from the inferior, optionally passing it the signal
270 specified by ARGS. If FROM_TTY is non-zero, be chatty about it. */
273 inf_ptrace_detach (struct target_ops
*ops
, char *args
, int from_tty
)
275 pid_t pid
= ptid_get_pid (inferior_ptid
);
280 char *exec_file
= get_exec_file (0);
283 printf_unfiltered (_("Detaching from program: %s, %s\n"), exec_file
,
284 target_pid_to_str (pid_to_ptid (pid
)));
285 gdb_flush (gdb_stdout
);
291 /* We'd better not have left any breakpoints in the program or it'll
292 die when it hits one. Also note that this may only work if we
293 previously attached to the inferior. It *might* work if we
294 started the process ourselves. */
296 ptrace (PT_DETACH
, pid
, (PTRACE_TYPE_ARG3
)1, sig
);
298 perror_with_name (("ptrace"));
300 error (_("This system does not support detaching from a process"));
303 inferior_ptid
= null_ptid
;
304 detach_inferior (pid
);
306 if (!have_inferiors ())
310 /* Kill the inferior. */
313 inf_ptrace_kill (struct target_ops
*ops
)
315 pid_t pid
= ptid_get_pid (inferior_ptid
);
321 ptrace (PT_KILL
, pid
, (PTRACE_TYPE_ARG3
)0, 0);
322 waitpid (pid
, &status
, 0);
324 target_mourn_inferior ();
327 /* Stop the inferior. */
330 inf_ptrace_stop (ptid_t ptid
)
332 /* Send a SIGINT to the process group. This acts just like the user
333 typed a ^C on the controlling terminal. Note that using a
334 negative process number in kill() is a System V-ism. The proper
335 BSD interface is killpg(). However, all modern BSDs support the
336 System V interface too. */
337 kill (-inferior_process_group (), SIGINT
);
340 /* Resume execution of thread PTID, or all threads if PTID is -1. If
341 STEP is nonzero, single-step it. If SIGNAL is nonzero, give it
345 inf_ptrace_resume (struct target_ops
*ops
,
346 ptid_t ptid
, int step
, enum target_signal signal
)
348 pid_t pid
= ptid_get_pid (ptid
);
352 /* Resume all threads. Traditionally ptrace() only supports
353 single-threaded processes, so simply resume the inferior. */
354 pid
= ptid_get_pid (inferior_ptid
);
356 if (catch_syscall_enabled () > 0)
357 request
= PT_SYSCALL
;
359 request
= PT_CONTINUE
;
363 /* If this system does not support PT_STEP, a higher level
364 function will have called single_step() to transmute the step
365 request into a continue request (by setting breakpoints on
366 all possible successor instructions), so we don't have to
367 worry about that here. */
371 /* An address of (PTRACE_TYPE_ARG3)1 tells ptrace to continue from
372 where it was. If GDB wanted it to start some other way, we have
373 already written a new program counter value to the child. */
375 ptrace (request
, pid
, (PTRACE_TYPE_ARG3
)1, target_signal_to_host (signal
));
377 perror_with_name (("ptrace"));
380 /* Wait for the child specified by PTID to do something. Return the
381 process ID of the child, or MINUS_ONE_PTID in case of error; store
382 the status in *OURSTATUS. */
385 inf_ptrace_wait (struct target_ops
*ops
,
386 ptid_t ptid
, struct target_waitstatus
*ourstatus
, int options
)
389 int status
, save_errno
;
397 pid
= waitpid (ptid_get_pid (ptid
), &status
, 0);
400 while (pid
== -1 && errno
== EINTR
);
402 clear_sigint_trap ();
406 fprintf_unfiltered (gdb_stderr
,
407 _("Child process unexpectedly missing: %s.\n"),
408 safe_strerror (save_errno
));
410 /* Claim it exited with unknown signal. */
411 ourstatus
->kind
= TARGET_WAITKIND_SIGNALLED
;
412 ourstatus
->value
.sig
= TARGET_SIGNAL_UNKNOWN
;
413 return inferior_ptid
;
416 /* Ignore terminated detached child processes. */
417 if (!WIFSTOPPED (status
) && pid
!= ptid_get_pid (inferior_ptid
))
422 #ifdef PT_GET_PROCESS_STATE
423 if (WIFSTOPPED (status
))
428 if (ptrace (PT_GET_PROCESS_STATE
, pid
,
429 (PTRACE_TYPE_ARG3
)&pe
, sizeof pe
) == -1)
430 perror_with_name (("ptrace"));
432 switch (pe
.pe_report_event
)
435 ourstatus
->kind
= TARGET_WAITKIND_FORKED
;
436 ourstatus
->value
.related_pid
= pid_to_ptid (pe
.pe_other_pid
);
438 /* Make sure the other end of the fork is stopped too. */
439 fpid
= waitpid (pe
.pe_other_pid
, &status
, 0);
441 perror_with_name (("waitpid"));
443 if (ptrace (PT_GET_PROCESS_STATE
, fpid
,
444 (PTRACE_TYPE_ARG3
)&pe
, sizeof pe
) == -1)
445 perror_with_name (("ptrace"));
447 gdb_assert (pe
.pe_report_event
== PTRACE_FORK
);
448 gdb_assert (pe
.pe_other_pid
== pid
);
449 if (fpid
== ptid_get_pid (inferior_ptid
))
451 ourstatus
->value
.related_pid
= pid_to_ptid (pe
.pe_other_pid
);
452 return pid_to_ptid (fpid
);
455 return pid_to_ptid (pid
);
460 store_waitstatus (ourstatus
, status
);
461 return pid_to_ptid (pid
);
464 /* Attempt a transfer all LEN bytes starting at OFFSET between the
465 inferior's OBJECT:ANNEX space and GDB's READBUF/WRITEBUF buffer.
466 Return the number of bytes actually transferred. */
469 inf_ptrace_xfer_partial (struct target_ops
*ops
, enum target_object object
,
470 const char *annex
, gdb_byte
*readbuf
,
471 const gdb_byte
*writebuf
,
472 ULONGEST offset
, LONGEST len
)
474 pid_t pid
= ptid_get_pid (inferior_ptid
);
478 case TARGET_OBJECT_MEMORY
:
480 /* OpenBSD 3.1, NetBSD 1.6 and FreeBSD 5.0 have a new PT_IO
481 request that promises to be much more efficient in reading
482 and writing data in the traced process's address space. */
484 struct ptrace_io_desc piod
;
486 /* NOTE: We assume that there are no distinct address spaces
487 for instruction and data. However, on OpenBSD 3.9 and
488 later, PIOD_WRITE_D doesn't allow changing memory that's
489 mapped read-only. Since most code segments will be
490 read-only, using PIOD_WRITE_D will prevent us from
491 inserting breakpoints, so we use PIOD_WRITE_I instead. */
492 piod
.piod_op
= writebuf
? PIOD_WRITE_I
: PIOD_READ_D
;
493 piod
.piod_addr
= writebuf
? (void *) writebuf
: readbuf
;
494 piod
.piod_offs
= (void *) (long) offset
;
498 if (ptrace (PT_IO
, pid
, (caddr_t
)&piod
, 0) == 0)
499 /* Return the actual number of bytes read or written. */
500 return piod
.piod_len
;
501 /* If the PT_IO request is somehow not supported, fallback on
502 using PT_WRITE_D/PT_READ_D. Otherwise we will return zero
503 to indicate failure. */
511 PTRACE_TYPE_RET word
;
512 gdb_byte byte
[sizeof (PTRACE_TYPE_RET
)];
514 ULONGEST rounded_offset
;
517 /* Round the start offset down to the next long word
519 rounded_offset
= offset
& -(ULONGEST
) sizeof (PTRACE_TYPE_RET
);
521 /* Since ptrace will transfer a single word starting at that
522 rounded_offset the partial_len needs to be adjusted down to
523 that (remember this function only does a single transfer).
524 Should the required length be even less, adjust it down
526 partial_len
= (rounded_offset
+ sizeof (PTRACE_TYPE_RET
)) - offset
;
527 if (partial_len
> len
)
532 /* If OFFSET:PARTIAL_LEN is smaller than
533 ROUNDED_OFFSET:WORDSIZE then a read/modify write will
534 be needed. Read in the entire word. */
535 if (rounded_offset
< offset
536 || (offset
+ partial_len
537 < rounded_offset
+ sizeof (PTRACE_TYPE_RET
)))
538 /* Need part of initial word -- fetch it. */
539 buffer
.word
= ptrace (PT_READ_I
, pid
,
540 (PTRACE_TYPE_ARG3
)(uintptr_t)
543 /* Copy data to be written over corresponding part of
545 memcpy (buffer
.byte
+ (offset
- rounded_offset
),
546 writebuf
, partial_len
);
549 ptrace (PT_WRITE_D
, pid
,
550 (PTRACE_TYPE_ARG3
)(uintptr_t)rounded_offset
,
554 /* Using the appropriate one (I or D) is necessary for
555 Gould NP1, at least. */
557 ptrace (PT_WRITE_I
, pid
,
558 (PTRACE_TYPE_ARG3
)(uintptr_t)rounded_offset
,
568 buffer
.word
= ptrace (PT_READ_I
, pid
,
569 (PTRACE_TYPE_ARG3
)(uintptr_t)rounded_offset
,
573 /* Copy appropriate bytes out of the buffer. */
574 memcpy (readbuf
, buffer
.byte
+ (offset
- rounded_offset
),
581 case TARGET_OBJECT_UNWIND_TABLE
:
584 case TARGET_OBJECT_AUXV
:
587 case TARGET_OBJECT_WCOOKIE
:
595 /* Return non-zero if the thread specified by PTID is alive. */
598 inf_ptrace_thread_alive (struct target_ops
*ops
, ptid_t ptid
)
600 /* ??? Is kill the right way to do this? */
601 return (kill (ptid_get_pid (ptid
), 0) != -1);
604 /* Print status information about what we're accessing. */
607 inf_ptrace_files_info (struct target_ops
*ignore
)
609 struct inferior
*inf
= current_inferior ();
611 printf_filtered (_("\tUsing the running image of %s %s.\n"),
612 inf
->attach_flag
? "attached" : "child",
613 target_pid_to_str (inferior_ptid
));
617 inf_ptrace_pid_to_str (struct target_ops
*ops
, ptid_t ptid
)
619 return normal_pid_to_str (ptid
);
622 /* Create a prototype ptrace target. The client can override it with
626 inf_ptrace_target (void)
628 struct target_ops
*t
= inf_child_target ();
630 t
->to_attach
= inf_ptrace_attach
;
631 t
->to_detach
= inf_ptrace_detach
;
632 t
->to_resume
= inf_ptrace_resume
;
633 t
->to_wait
= inf_ptrace_wait
;
634 t
->to_files_info
= inf_ptrace_files_info
;
635 t
->to_kill
= inf_ptrace_kill
;
636 t
->to_create_inferior
= inf_ptrace_create_inferior
;
637 #ifdef PT_GET_PROCESS_STATE
638 t
->to_follow_fork
= inf_ptrace_follow_fork
;
639 t
->to_post_startup_inferior
= inf_ptrace_post_startup_inferior
;
640 t
->to_post_attach
= inf_ptrace_post_attach
;
642 t
->to_mourn_inferior
= inf_ptrace_mourn_inferior
;
643 t
->to_thread_alive
= inf_ptrace_thread_alive
;
644 t
->to_pid_to_str
= inf_ptrace_pid_to_str
;
645 t
->to_stop
= inf_ptrace_stop
;
646 t
->to_xfer_partial
= inf_ptrace_xfer_partial
;
652 /* Pointer to a function that returns the offset within the user area
653 where a particular register is stored. */
654 static CORE_ADDR (*inf_ptrace_register_u_offset
)(struct gdbarch
*, int, int);
656 /* Fetch register REGNUM from the inferior. */
659 inf_ptrace_fetch_register (struct regcache
*regcache
, int regnum
)
661 struct gdbarch
*gdbarch
= get_regcache_arch (regcache
);
664 PTRACE_TYPE_RET
*buf
;
667 /* This isn't really an address, but ptrace thinks of it as one. */
668 addr
= inf_ptrace_register_u_offset (gdbarch
, regnum
, 0);
669 if (addr
== (CORE_ADDR
)-1
670 || gdbarch_cannot_fetch_register (gdbarch
, regnum
))
672 regcache_raw_supply (regcache
, regnum
, NULL
);
676 /* Cater for systems like GNU/Linux, that implement threads as
677 separate processes. */
678 pid
= ptid_get_lwp (inferior_ptid
);
680 pid
= ptid_get_pid (inferior_ptid
);
682 size
= register_size (gdbarch
, regnum
);
683 gdb_assert ((size
% sizeof (PTRACE_TYPE_RET
)) == 0);
686 /* Read the register contents from the inferior a chunk at a time. */
687 for (i
= 0; i
< size
/ sizeof (PTRACE_TYPE_RET
); i
++)
690 buf
[i
] = ptrace (PT_READ_U
, pid
, (PTRACE_TYPE_ARG3
)(uintptr_t)addr
, 0);
692 error (_("Couldn't read register %s (#%d): %s."),
693 gdbarch_register_name (gdbarch
, regnum
),
694 regnum
, safe_strerror (errno
));
696 addr
+= sizeof (PTRACE_TYPE_RET
);
698 regcache_raw_supply (regcache
, regnum
, buf
);
701 /* Fetch register REGNUM from the inferior. If REGNUM is -1, do this
702 for all registers. */
705 inf_ptrace_fetch_registers (struct target_ops
*ops
,
706 struct regcache
*regcache
, int regnum
)
710 regnum
< gdbarch_num_regs (get_regcache_arch (regcache
));
712 inf_ptrace_fetch_register (regcache
, regnum
);
714 inf_ptrace_fetch_register (regcache
, regnum
);
717 /* Store register REGNUM into the inferior. */
720 inf_ptrace_store_register (const struct regcache
*regcache
, int regnum
)
722 struct gdbarch
*gdbarch
= get_regcache_arch (regcache
);
725 PTRACE_TYPE_RET
*buf
;
728 /* This isn't really an address, but ptrace thinks of it as one. */
729 addr
= inf_ptrace_register_u_offset (gdbarch
, regnum
, 1);
730 if (addr
== (CORE_ADDR
)-1
731 || gdbarch_cannot_store_register (gdbarch
, regnum
))
734 /* Cater for systems like GNU/Linux, that implement threads as
735 separate processes. */
736 pid
= ptid_get_lwp (inferior_ptid
);
738 pid
= ptid_get_pid (inferior_ptid
);
740 size
= register_size (gdbarch
, regnum
);
741 gdb_assert ((size
% sizeof (PTRACE_TYPE_RET
)) == 0);
744 /* Write the register contents into the inferior a chunk at a time. */
745 regcache_raw_collect (regcache
, regnum
, buf
);
746 for (i
= 0; i
< size
/ sizeof (PTRACE_TYPE_RET
); i
++)
749 ptrace (PT_WRITE_U
, pid
, (PTRACE_TYPE_ARG3
)(uintptr_t)addr
, buf
[i
]);
751 error (_("Couldn't write register %s (#%d): %s."),
752 gdbarch_register_name (gdbarch
, regnum
),
753 regnum
, safe_strerror (errno
));
755 addr
+= sizeof (PTRACE_TYPE_RET
);
759 /* Store register REGNUM back into the inferior. If REGNUM is -1, do
760 this for all registers. */
763 inf_ptrace_store_registers (struct target_ops
*ops
,
764 struct regcache
*regcache
, int regnum
)
768 regnum
< gdbarch_num_regs (get_regcache_arch (regcache
));
770 inf_ptrace_store_register (regcache
, regnum
);
772 inf_ptrace_store_register (regcache
, regnum
);
775 /* Create a "traditional" ptrace target. REGISTER_U_OFFSET should be
776 a function returning the offset within the user area where a
777 particular register is stored. */
780 inf_ptrace_trad_target (CORE_ADDR (*register_u_offset
)
781 (struct gdbarch
*, int, int))
783 struct target_ops
*t
= inf_ptrace_target();
785 gdb_assert (register_u_offset
);
786 inf_ptrace_register_u_offset
= register_u_offset
;
787 t
->to_fetch_registers
= inf_ptrace_fetch_registers
;
788 t
->to_store_registers
= inf_ptrace_store_registers
;