1 /* Low-level child interface to ptrace.
3 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1998, 1999, 2000, 2001, 2002, 2004, 2005
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 2 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, write to the Free Software
21 Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 Boston, MA 02110-1301, USA. */
32 #include "gdb_assert.h"
33 #include "gdb_string.h"
34 #include "gdb_ptrace.h"
38 #include "inf-child.h"
40 /* HACK: Save the ptrace ops returned by inf_ptrace_target. */
41 static struct target_ops *ptrace_ops_hack;
44 #ifdef PT_GET_PROCESS_STATE
47 inf_ptrace_follow_fork (struct target_ops *ops, int follow_child)
52 /* FIXME: kettenis/20050720: This stuff should really be passed as
53 an argument by our caller. */
56 struct target_waitstatus status;
58 get_last_target_status (&ptid, &status);
59 gdb_assert (status.kind == TARGET_WAITKIND_FORKED);
61 pid = ptid_get_pid (ptid);
64 if (ptrace (PT_GET_PROCESS_STATE, pid,
65 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
66 perror_with_name (("ptrace"));
68 gdb_assert (pe.pe_report_event == PTRACE_FORK);
69 fpid = pe.pe_other_pid;
73 inferior_ptid = pid_to_ptid (fpid);
74 detach_breakpoints (pid);
76 /* Reset breakpoints in the child as appropriate. */
77 follow_inferior_reset_breakpoints ();
79 if (ptrace (PT_DETACH, pid, (PTRACE_TYPE_ARG3)1, 0) == -1)
80 perror_with_name (("ptrace"));
84 inferior_ptid = pid_to_ptid (pid);
85 detach_breakpoints (fpid);
87 if (ptrace (PT_DETACH, fpid, (PTRACE_TYPE_ARG3)1, 0) == -1)
88 perror_with_name (("ptrace"));
94 #endif /* PT_GET_PROCESS_STATE */
97 /* Prepare to be traced. */
102 /* "Trace me, Dr. Memory!" */
103 ptrace (PT_TRACE_ME, 0, (PTRACE_TYPE_ARG3)0, 0);
106 /* Start tracing PID. */
109 inf_ptrace_him (int pid)
111 push_target (ptrace_ops_hack);
113 /* On some targets, there must be some explicit synchronization
114 between the parent and child processes after the debugger
115 forks, and before the child execs the debuggee program. This
116 call basically gives permission for the child to exec. */
118 target_acknowledge_created_inferior (pid);
120 /* START_INFERIOR_TRAPS_EXPECTED is defined in inferior.h, and will
121 be 1 or 2 depending on whether we're starting without or with a
123 startup_inferior (START_INFERIOR_TRAPS_EXPECTED);
125 /* On some targets, there must be some explicit actions taken after
126 the inferior has been started up. */
127 target_post_startup_inferior (pid_to_ptid (pid));
130 /* Start a new inferior Unix child process. EXEC_FILE is the file to
131 run, ALLARGS is a string containing the arguments to the program.
132 ENV is the environment vector to pass. If FROM_TTY is non-zero, be
136 inf_ptrace_create_inferior (char *exec_file, char *allargs, char **env,
139 fork_inferior (exec_file, allargs, env, inf_ptrace_me, inf_ptrace_him,
142 /* We are at the first instruction we care about. */
143 observer_notify_inferior_created (¤t_target, from_tty);
145 /* Pedal to the metal... */
146 proceed ((CORE_ADDR) -1, TARGET_SIGNAL_0, 0);
149 #ifdef PT_GET_PROCESS_STATE
152 inf_ptrace_post_startup_inferior (ptid_t pid)
156 /* Set the initial event mask. */
157 memset (&pe, 0, sizeof pe);
158 pe.pe_set_event |= PTRACE_FORK;
159 if (ptrace (PT_SET_EVENT_MASK, ptid_get_pid (pid),
160 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
161 perror_with_name (("ptrace"));
166 /* Clean up a rotting corpse of an inferior after it died. */
169 inf_ptrace_mourn_inferior (void)
173 /* Wait just one more time to collect the inferior's exit status.
174 Do not check whether this succeeds though, since we may be
175 dealing with a process that we attached to. Such a process will
176 only report its exit status to its original parent. */
177 waitpid (ptid_get_pid (inferior_ptid), &status, 0);
179 unpush_target (ptrace_ops_hack);
180 generic_mourn_inferior ();
183 /* Attach to the process specified by ARGS. If FROM_TTY is non-zero,
184 be chatty about it. */
187 inf_ptrace_attach (char *args, int from_tty)
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"));
226 error (_("This system does not support attaching to a process"));
229 inferior_ptid = pid_to_ptid (pid);
230 push_target (ptrace_ops_hack);
232 /* Do this first, before anything has had a chance to query the
233 inferior's symbol table or similar. */
234 observer_notify_inferior_created (¤t_target, from_tty);
237 #ifdef PT_GET_PROCESS_STATE
240 inf_ptrace_post_attach (int pid)
244 /* Set the initial event mask. */
245 memset (&pe, 0, sizeof pe);
246 pe.pe_set_event |= PTRACE_FORK;
247 if (ptrace (PT_SET_EVENT_MASK, pid,
248 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
249 perror_with_name (("ptrace"));
254 /* Detach from the inferior, optionally passing it the signal
255 specified by ARGS. If FROM_TTY is non-zero, be chatty about it. */
258 inf_ptrace_detach (char *args, int from_tty)
260 pid_t pid = ptid_get_pid (inferior_ptid);
265 char *exec_file = get_exec_file (0);
268 printf_unfiltered (_("Detaching from program: %s, %s\n"), exec_file,
269 target_pid_to_str (pid_to_ptid (pid)));
270 gdb_flush (gdb_stdout);
276 /* We'd better not have left any breakpoints in the program or it'll
277 die when it hits one. Also note that this may only work if we
278 previously attached to the inferior. It *might* work if we
279 started the process ourselves. */
281 ptrace (PT_DETACH, pid, (PTRACE_TYPE_ARG3)1, sig);
283 perror_with_name (("ptrace"));
286 error (_("This system does not support detaching from a process"));
289 inferior_ptid = null_ptid;
290 unpush_target (ptrace_ops_hack);
293 /* Kill the inferior. */
296 inf_ptrace_kill (void)
298 pid_t pid = ptid_get_pid (inferior_ptid);
304 ptrace (PT_KILL, pid, (PTRACE_TYPE_ARG3)0, 0);
305 waitpid (pid, &status, 0);
307 target_mourn_inferior ();
310 /* Stop the inferior. */
313 inf_ptrace_stop (void)
315 /* Send a SIGINT to the process group. This acts just like the user
316 typed a ^C on the controlling terminal. Note that using a
317 negative process number in kill() is a System V-ism. The proper
318 BSD interface is killpg(). However, all modern BSDs support the
319 System V interface too. */
320 kill (-inferior_process_group, SIGINT);
323 /* Resume execution of thread PTID, or all threads if PTID is -1. If
324 STEP is nonzero, single-step it. If SIGNAL is nonzero, give it
328 inf_ptrace_resume (ptid_t ptid, int step, enum target_signal signal)
330 pid_t pid = ptid_get_pid (ptid);
331 int request = PT_CONTINUE;
334 /* Resume all threads. Traditionally ptrace() only supports
335 single-threaded processes, so simply resume the inferior. */
336 pid = ptid_get_pid (inferior_ptid);
340 /* If this system does not support PT_STEP, a higher level
341 function will have called single_step() to transmute the step
342 request into a continue request (by setting breakpoints on
343 all possible successor instructions), so we don't have to
344 worry about that here. */
348 /* An address of (PTRACE_TYPE_ARG3)1 tells ptrace to continue from
349 where it was. If GDB wanted it to start some other way, we have
350 already written a new program counter value to the child. */
352 ptrace (request, pid, (PTRACE_TYPE_ARG3)1, target_signal_to_host (signal));
354 perror_with_name (("ptrace"));
357 /* Wait for the child specified by PTID to do something. Return the
358 process ID of the child, or MINUS_ONE_PTID in case of error; store
359 the status in *OURSTATUS. */
362 inf_ptrace_wait (ptid_t ptid, struct target_waitstatus *ourstatus)
365 int status, save_errno;
374 pid = waitpid (ptid_get_pid (ptid), &status, 0);
377 while (pid == -1 && errno == EINTR);
380 clear_sigint_trap ();
384 fprintf_unfiltered (gdb_stderr,
385 _("Child process unexpectedly missing: %s.\n"),
386 safe_strerror (save_errno));
388 /* Claim it exited with unknown signal. */
389 ourstatus->kind = TARGET_WAITKIND_SIGNALLED;
390 ourstatus->value.sig = TARGET_SIGNAL_UNKNOWN;
391 return minus_one_ptid;
394 /* Ignore terminated detached child processes. */
395 if (!WIFSTOPPED (status) && pid != ptid_get_pid (inferior_ptid))
400 #ifdef PT_GET_PROCESS_STATE
401 if (WIFSTOPPED (status))
406 if (ptrace (PT_GET_PROCESS_STATE, pid,
407 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
408 perror_with_name (("ptrace"));
410 switch (pe.pe_report_event)
413 ourstatus->kind = TARGET_WAITKIND_FORKED;
414 ourstatus->value.related_pid = pe.pe_other_pid;
416 /* Make sure the other end of the fork is stopped too. */
417 fpid = waitpid (pe.pe_other_pid, &status, 0);
419 perror_with_name (("waitpid"));
421 if (ptrace (PT_GET_PROCESS_STATE, fpid,
422 (PTRACE_TYPE_ARG3)&pe, sizeof pe) == -1)
423 perror_with_name (("ptrace"));
425 gdb_assert (pe.pe_report_event == PTRACE_FORK);
426 gdb_assert (pe.pe_other_pid == pid);
427 if (fpid == ptid_get_pid (inferior_ptid))
429 ourstatus->value.related_pid = pe.pe_other_pid;
430 return pid_to_ptid (fpid);
433 return pid_to_ptid (pid);
438 store_waitstatus (ourstatus, status);
439 return pid_to_ptid (pid);
442 /* Attempt a transfer all LEN bytes starting at OFFSET between the
443 inferior's OBJECT:ANNEX space and GDB's READBUF/WRITEBUF buffer.
444 Return the number of bytes actually transferred. */
447 inf_ptrace_xfer_partial (struct target_ops *ops, enum target_object object,
448 const char *annex, gdb_byte *readbuf,
449 const gdb_byte *writebuf,
450 ULONGEST offset, LONGEST len)
452 pid_t pid = ptid_get_pid (inferior_ptid);
456 case TARGET_OBJECT_MEMORY:
458 /* OpenBSD 3.1, NetBSD 1.6 and FreeBSD 5.0 have a new PT_IO
459 request that promises to be much more efficient in reading
460 and writing data in the traced process's address space. */
462 struct ptrace_io_desc piod;
464 /* NOTE: We assume that there are no distinct address spaces
465 for instruction and data. However, on OpenBSD 3.9 and
466 later, PIOD_WRITE_D doesn't allow changing memory that's
467 mapped read-only. Since most code segments will be
468 read-only, using PIOD_WRITE_D will prevent us from
469 inserting breakpoints, so we use PIOD_WRITE_I instead. */
470 piod.piod_op = writebuf ? PIOD_WRITE_I : PIOD_READ_D;
471 piod.piod_addr = writebuf ? (void *) writebuf : readbuf;
472 piod.piod_offs = (void *) (long) offset;
476 if (ptrace (PT_IO, pid, (caddr_t)&piod, 0) == 0)
477 /* Return the actual number of bytes read or written. */
478 return piod.piod_len;
479 /* If the PT_IO request is somehow not supported, fallback on
480 using PT_WRITE_D/PT_READ_D. Otherwise we will return zero
481 to indicate failure. */
489 PTRACE_TYPE_RET word;
490 gdb_byte byte[sizeof (PTRACE_TYPE_RET)];
492 ULONGEST rounded_offset;
495 /* Round the start offset down to the next long word
497 rounded_offset = offset & -(ULONGEST) sizeof (PTRACE_TYPE_RET);
499 /* Since ptrace will transfer a single word starting at that
500 rounded_offset the partial_len needs to be adjusted down to
501 that (remember this function only does a single transfer).
502 Should the required length be even less, adjust it down
504 partial_len = (rounded_offset + sizeof (PTRACE_TYPE_RET)) - offset;
505 if (partial_len > len)
510 /* If OFFSET:PARTIAL_LEN is smaller than
511 ROUNDED_OFFSET:WORDSIZE then a read/modify write will
512 be needed. Read in the entire word. */
513 if (rounded_offset < offset
514 || (offset + partial_len
515 < rounded_offset + sizeof (PTRACE_TYPE_RET)))
516 /* Need part of initial word -- fetch it. */
517 buffer.word = ptrace (PT_READ_I, pid,
518 (PTRACE_TYPE_ARG3)(long)rounded_offset, 0);
520 /* Copy data to be written over corresponding part of
522 memcpy (buffer.byte + (offset - rounded_offset),
523 writebuf, partial_len);
526 ptrace (PT_WRITE_D, pid,
527 (PTRACE_TYPE_ARG3)(long)rounded_offset, buffer.word);
530 /* Using the appropriate one (I or D) is necessary for
531 Gould NP1, at least. */
533 ptrace (PT_WRITE_I, pid,
534 (PTRACE_TYPE_ARG3)(long)rounded_offset, buffer.word);
543 buffer.word = ptrace (PT_READ_I, pid,
544 (PTRACE_TYPE_ARG3)(long)rounded_offset, 0);
547 /* Copy appropriate bytes out of the buffer. */
548 memcpy (readbuf, buffer.byte + (offset - rounded_offset),
555 case TARGET_OBJECT_UNWIND_TABLE:
558 case TARGET_OBJECT_AUXV:
561 case TARGET_OBJECT_WCOOKIE:
569 /* Return non-zero if the thread specified by PTID is alive. */
572 inf_ptrace_thread_alive (ptid_t ptid)
574 /* ??? Is kill the right way to do this? */
575 return (kill (ptid_get_pid (ptid), 0) != -1);
578 /* Print status information about what we're accessing. */
581 inf_ptrace_files_info (struct target_ops *ignore)
583 printf_filtered (_("\tUsing the running image of %s %s.\n"),
584 attach_flag ? "attached" : "child",
585 target_pid_to_str (inferior_ptid));
588 /* Create a prototype ptrace target. The client can override it with
592 inf_ptrace_target (void)
594 struct target_ops *t = inf_child_target ();
596 t->to_attach = inf_ptrace_attach;
597 t->to_detach = inf_ptrace_detach;
598 t->to_resume = inf_ptrace_resume;
599 t->to_wait = inf_ptrace_wait;
600 t->to_files_info = inf_ptrace_files_info;
601 t->to_kill = inf_ptrace_kill;
602 t->to_create_inferior = inf_ptrace_create_inferior;
603 #ifdef PT_GET_PROCESS_STATE
604 t->to_follow_fork = inf_ptrace_follow_fork;
605 t->to_post_startup_inferior = inf_ptrace_post_startup_inferior;
606 t->to_post_attach = inf_ptrace_post_attach;
608 t->to_mourn_inferior = inf_ptrace_mourn_inferior;
609 t->to_thread_alive = inf_ptrace_thread_alive;
610 t->to_pid_to_str = normal_pid_to_str;
611 t->to_stop = inf_ptrace_stop;
612 t->to_xfer_partial = inf_ptrace_xfer_partial;
619 /* Pointer to a function that returns the offset within the user area
620 where a particular register is stored. */
621 static CORE_ADDR (*inf_ptrace_register_u_offset)(int);
623 /* Fetch register REGNUM from the inferior. */
626 inf_ptrace_fetch_register (int regnum)
630 PTRACE_TYPE_RET *buf;
633 if (CANNOT_FETCH_REGISTER (regnum))
635 regcache_raw_supply (current_regcache, regnum, NULL);
639 /* Cater for systems like GNU/Linux, that implement threads as
640 separate processes. */
641 pid = ptid_get_lwp (inferior_ptid);
643 pid = ptid_get_pid (inferior_ptid);
645 /* This isn't really an address, but ptrace thinks of it as one. */
646 addr = inf_ptrace_register_u_offset (regnum);
647 size = register_size (current_gdbarch, regnum);
649 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
652 /* Read the register contents from the inferior a chunk at a time. */
653 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
656 buf[i] = ptrace (PT_READ_U, pid, (PTRACE_TYPE_ARG3)addr, 0);
658 error (_("Couldn't read register %s (#%d): %s."),
659 REGISTER_NAME (regnum), regnum, safe_strerror (errno));
661 addr += sizeof (PTRACE_TYPE_RET);
663 regcache_raw_supply (current_regcache, regnum, buf);
666 /* Fetch register REGNUM from the inferior. If REGNUM is -1, do this
667 for all registers. */
670 inf_ptrace_fetch_registers (int regnum)
673 for (regnum = 0; regnum < NUM_REGS; regnum++)
674 inf_ptrace_fetch_register (regnum);
676 inf_ptrace_fetch_register (regnum);
679 /* Store register REGNUM into the inferior. */
682 inf_ptrace_store_register (int regnum)
686 PTRACE_TYPE_RET *buf;
689 if (CANNOT_STORE_REGISTER (regnum))
692 /* Cater for systems like GNU/Linux, that implement threads as
693 separate processes. */
694 pid = ptid_get_lwp (inferior_ptid);
696 pid = ptid_get_pid (inferior_ptid);
698 /* This isn't really an address, but ptrace thinks of it as one. */
699 addr = inf_ptrace_register_u_offset (regnum);
700 size = register_size (current_gdbarch, regnum);
702 gdb_assert ((size % sizeof (PTRACE_TYPE_RET)) == 0);
705 /* Write the register contents into the inferior a chunk at a time. */
706 regcache_raw_collect (current_regcache, regnum, buf);
707 for (i = 0; i < size / sizeof (PTRACE_TYPE_RET); i++)
710 ptrace (PT_WRITE_U, pid, (PTRACE_TYPE_ARG3)addr, buf[i]);
712 error (_("Couldn't write register %s (#%d): %s."),
713 REGISTER_NAME (regnum), regnum, safe_strerror (errno));
715 addr += sizeof (PTRACE_TYPE_RET);
719 /* Store register REGNUM back into the inferior. If REGNUM is -1, do
720 this for all registers. */
723 inf_ptrace_store_registers (int regnum)
726 for (regnum = 0; regnum < NUM_REGS; regnum++)
727 inf_ptrace_store_register (regnum);
729 inf_ptrace_store_register (regnum);
732 /* Create a "traditional" ptrace target. REGISTER_U_OFFSET should be
733 a function returning the offset within the user area where a
734 particular register is stored. */
737 inf_ptrace_trad_target (CORE_ADDR (*register_u_offset)(int))
739 struct target_ops *t = inf_ptrace_target();
741 gdb_assert (register_u_offset);
742 inf_ptrace_register_u_offset = register_u_offset;
743 t->to_fetch_registers = inf_ptrace_fetch_registers;
744 t->to_store_registers = inf_ptrace_store_registers;