1 /* Native-dependent code for GNU/Linux i386.
3 Copyright 1999, 2000, 2001, 2002, 2003, 2004 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 2 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, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
26 #include "linux-nat.h"
28 #include "gdb_assert.h"
29 #include "gdb_string.h"
30 #include <sys/ptrace.h>
32 #include <sys/procfs.h>
42 #ifdef HAVE_SYS_DEBUGREG_H
43 #include <sys/debugreg.h>
47 #define DR_FIRSTADDR 0
62 /* Prototypes for supply_gregset etc. */
65 /* Prototypes for i387_supply_fsave etc. */
66 #include "i387-tdep.h"
68 /* Defines for XMM0_REGNUM etc. */
69 #include "i386-tdep.h"
71 /* Defines I386_LINUX_ORIG_EAX_REGNUM. */
72 #include "i386-linux-tdep.h"
74 /* Defines ps_err_e, struct ps_prochandle. */
75 #include "gdb_proc_service.h"
77 /* Prototypes for local functions. */
78 static void dummy_sse_values (void);
81 /* The register sets used in GNU/Linux ELF core-dumps are identical to
82 the register sets in `struct user' that is used for a.out
83 core-dumps, and is also used by `ptrace'. The corresponding types
84 are `elf_gregset_t' for the general-purpose registers (with
85 `elf_greg_t' the type of a single GP register) and `elf_fpregset_t'
86 for the floating-point registers.
88 Those types used to be available under the names `gregset_t' and
89 `fpregset_t' too, and this file used those names in the past. But
90 those names are now used for the register sets used in the
91 `mcontext_t' type, and have a different size and layout. */
93 /* Mapping between the general-purpose registers in `struct user'
94 format and GDB's register array layout. */
101 -1, -1, -1, -1, /* st0, st1, st2, st3 */
102 -1, -1, -1, -1, /* st4, st5, st6, st7 */
103 -1, -1, -1, -1, /* fctrl, fstat, ftag, fiseg */
104 -1, -1, -1, -1, /* fioff, foseg, fooff, fop */
105 -1, -1, -1, -1, /* xmm0, xmm1, xmm2, xmm3 */
106 -1, -1, -1, -1, /* xmm4, xmm5, xmm6, xmm6 */
111 /* Which ptrace request retrieves which registers?
112 These apply to the corresponding SET requests as well. */
114 #define GETREGS_SUPPLIES(regno) \
115 ((0 <= (regno) && (regno) <= 15) || (regno) == I386_LINUX_ORIG_EAX_REGNUM)
117 #define GETFPREGS_SUPPLIES(regno) \
118 (FP0_REGNUM <= (regno) && (regno) <= LAST_FPU_CTRL_REGNUM)
120 #define GETFPXREGS_SUPPLIES(regno) \
121 (FP0_REGNUM <= (regno) && (regno) <= MXCSR_REGNUM)
123 /* Does the current host support the GETREGS request? */
124 int have_ptrace_getregs =
125 #ifdef HAVE_PTRACE_GETREGS
132 /* Does the current host support the GETFPXREGS request? The header
133 file may or may not define it, and even if it is defined, the
134 kernel will return EIO if it's running on a pre-SSE processor.
136 My instinct is to attach this to some architecture- or
137 target-specific data structure, but really, a particular GDB
138 process can only run on top of one kernel at a time. So it's okay
139 for this to be a simple variable. */
140 int have_ptrace_getfpxregs =
141 #ifdef HAVE_PTRACE_GETFPXREGS
149 /* Support for the user struct. */
151 /* Return the address of register REGNUM. BLOCKEND is the value of
152 u.u_ar0, which should point to the registers. */
155 register_u_addr (CORE_ADDR blockend, int regnum)
157 return (blockend + 4 * regmap[regnum]);
160 /* Return the size of the user struct. */
165 return (sizeof (struct user));
169 /* Accessing registers through the U area, one at a time. */
171 /* Fetch one register. */
174 fetch_register (int regno)
179 gdb_assert (!have_ptrace_getregs);
180 if (cannot_fetch_register (regno))
182 regcache_raw_supply (current_regcache, regno, NULL);
186 /* GNU/Linux LWP ID's are process ID's. */
187 tid = TIDGET (inferior_ptid);
189 tid = PIDGET (inferior_ptid); /* Not a threaded program. */
192 val = ptrace (PTRACE_PEEKUSER, tid, register_addr (regno, 0), 0);
194 error ("Couldn't read register %s (#%d): %s.", REGISTER_NAME (regno),
195 regno, safe_strerror (errno));
197 regcache_raw_supply (current_regcache, regno, &val);
200 /* Store one register. */
203 store_register (int regno)
208 gdb_assert (!have_ptrace_getregs);
209 if (cannot_store_register (regno))
212 /* GNU/Linux LWP ID's are process ID's. */
213 tid = TIDGET (inferior_ptid);
215 tid = PIDGET (inferior_ptid); /* Not a threaded program. */
218 regcache_raw_collect (current_regcache, regno, &val);
219 ptrace (PTRACE_POKEUSER, tid, register_addr (regno, 0), val);
221 error ("Couldn't write register %s (#%d): %s.", REGISTER_NAME (regno),
222 regno, safe_strerror (errno));
226 /* Transfering the general-purpose registers between GDB, inferiors
229 /* Fill GDB's register array with the general-purpose register values
233 supply_gregset (elf_gregset_t *gregsetp)
235 elf_greg_t *regp = (elf_greg_t *) gregsetp;
238 for (i = 0; i < I386_NUM_GREGS; i++)
239 regcache_raw_supply (current_regcache, i, regp + regmap[i]);
241 if (I386_LINUX_ORIG_EAX_REGNUM < NUM_REGS)
242 regcache_raw_supply (current_regcache, I386_LINUX_ORIG_EAX_REGNUM,
246 /* Fill register REGNO (if it is a general-purpose register) in
247 *GREGSETPS with the value in GDB's register array. If REGNO is -1,
248 do this for all registers. */
251 fill_gregset (elf_gregset_t *gregsetp, int regno)
253 elf_greg_t *regp = (elf_greg_t *) gregsetp;
256 for (i = 0; i < I386_NUM_GREGS; i++)
257 if (regno == -1 || regno == i)
258 regcache_raw_collect (current_regcache, i, regp + regmap[i]);
260 if ((regno == -1 || regno == I386_LINUX_ORIG_EAX_REGNUM)
261 && I386_LINUX_ORIG_EAX_REGNUM < NUM_REGS)
262 regcache_raw_collect (current_regcache, I386_LINUX_ORIG_EAX_REGNUM,
266 #ifdef HAVE_PTRACE_GETREGS
268 /* Fetch all general-purpose registers from process/thread TID and
269 store their values in GDB's register array. */
276 if (ptrace (PTRACE_GETREGS, tid, 0, (int) ®s) < 0)
280 /* The kernel we're running on doesn't support the GETREGS
281 request. Reset `have_ptrace_getregs'. */
282 have_ptrace_getregs = 0;
286 perror_with_name ("Couldn't get registers");
289 supply_gregset (®s);
292 /* Store all valid general-purpose registers in GDB's register array
293 into the process/thread specified by TID. */
296 store_regs (int tid, int regno)
300 if (ptrace (PTRACE_GETREGS, tid, 0, (int) ®s) < 0)
301 perror_with_name ("Couldn't get registers");
303 fill_gregset (®s, regno);
305 if (ptrace (PTRACE_SETREGS, tid, 0, (int) ®s) < 0)
306 perror_with_name ("Couldn't write registers");
311 static void fetch_regs (int tid) {}
312 static void store_regs (int tid, int regno) {}
317 /* Transfering floating-point registers between GDB, inferiors and cores. */
319 /* Fill GDB's register array with the floating-point register values in
323 supply_fpregset (elf_fpregset_t *fpregsetp)
325 i387_supply_fsave (current_regcache, -1, fpregsetp);
329 /* Fill register REGNO (if it is a floating-point register) in
330 *FPREGSETP with the value in GDB's register array. If REGNO is -1,
331 do this for all registers. */
334 fill_fpregset (elf_fpregset_t *fpregsetp, int regno)
336 i387_fill_fsave ((char *) fpregsetp, regno);
339 #ifdef HAVE_PTRACE_GETREGS
341 /* Fetch all floating-point registers from process/thread TID and store
342 thier values in GDB's register array. */
345 fetch_fpregs (int tid)
347 elf_fpregset_t fpregs;
349 if (ptrace (PTRACE_GETFPREGS, tid, 0, (int) &fpregs) < 0)
350 perror_with_name ("Couldn't get floating point status");
352 supply_fpregset (&fpregs);
355 /* Store all valid floating-point registers in GDB's register array
356 into the process/thread specified by TID. */
359 store_fpregs (int tid, int regno)
361 elf_fpregset_t fpregs;
363 if (ptrace (PTRACE_GETFPREGS, tid, 0, (int) &fpregs) < 0)
364 perror_with_name ("Couldn't get floating point status");
366 fill_fpregset (&fpregs, regno);
368 if (ptrace (PTRACE_SETFPREGS, tid, 0, (int) &fpregs) < 0)
369 perror_with_name ("Couldn't write floating point status");
374 static void fetch_fpregs (int tid) {}
375 static void store_fpregs (int tid, int regno) {}
380 /* Transfering floating-point and SSE registers to and from GDB. */
382 #ifdef HAVE_PTRACE_GETFPXREGS
384 /* Fill GDB's register array with the floating-point and SSE register
385 values in *FPXREGSETP. */
388 supply_fpxregset (elf_fpxregset_t *fpxregsetp)
390 i387_supply_fxsave (current_regcache, -1, fpxregsetp);
393 /* Fill register REGNO (if it is a floating-point or SSE register) in
394 *FPXREGSETP with the value in GDB's register array. If REGNO is
395 -1, do this for all registers. */
398 fill_fpxregset (elf_fpxregset_t *fpxregsetp, int regno)
400 i387_fill_fxsave ((char *) fpxregsetp, regno);
403 /* Fetch all registers covered by the PTRACE_GETFPXREGS request from
404 process/thread TID and store their values in GDB's register array.
405 Return non-zero if successful, zero otherwise. */
408 fetch_fpxregs (int tid)
410 elf_fpxregset_t fpxregs;
412 if (! have_ptrace_getfpxregs)
415 if (ptrace (PTRACE_GETFPXREGS, tid, 0, (int) &fpxregs) < 0)
419 have_ptrace_getfpxregs = 0;
423 perror_with_name ("Couldn't read floating-point and SSE registers");
426 supply_fpxregset (&fpxregs);
430 /* Store all valid registers in GDB's register array covered by the
431 PTRACE_SETFPXREGS request into the process/thread specified by TID.
432 Return non-zero if successful, zero otherwise. */
435 store_fpxregs (int tid, int regno)
437 elf_fpxregset_t fpxregs;
439 if (! have_ptrace_getfpxregs)
442 if (ptrace (PTRACE_GETFPXREGS, tid, 0, &fpxregs) == -1)
446 have_ptrace_getfpxregs = 0;
450 perror_with_name ("Couldn't read floating-point and SSE registers");
453 fill_fpxregset (&fpxregs, regno);
455 if (ptrace (PTRACE_SETFPXREGS, tid, 0, &fpxregs) == -1)
456 perror_with_name ("Couldn't write floating-point and SSE registers");
461 /* Fill the XMM registers in the register array with dummy values. For
462 cases where we don't have access to the XMM registers. I think
463 this is cleaner than printing a warning. For a cleaner solution,
464 we should gdbarchify the i386 family. */
467 dummy_sse_values (void)
469 struct gdbarch_tdep *tdep = gdbarch_tdep (current_gdbarch);
470 /* C doesn't have a syntax for NaN's, so write it out as an array of
472 static long dummy[4] = { 0xffffffff, 0xffffffff, 0xffffffff, 0xffffffff };
473 static long mxcsr = 0x1f80;
476 for (reg = 0; reg < tdep->num_xmm_regs; reg++)
477 regcache_raw_supply (current_regcache, XMM0_REGNUM + reg, (char *) dummy);
478 if (tdep->num_xmm_regs > 0)
479 regcache_raw_supply (current_regcache, MXCSR_REGNUM, (char *) &mxcsr);
484 static int fetch_fpxregs (int tid) { return 0; }
485 static int store_fpxregs (int tid, int regno) { return 0; }
486 static void dummy_sse_values (void) {}
488 #endif /* HAVE_PTRACE_GETFPXREGS */
491 /* Transferring arbitrary registers between GDB and inferior. */
493 /* Check if register REGNO in the child process is accessible.
494 If we are accessing registers directly via the U area, only the
495 general-purpose registers are available.
496 All registers should be accessible if we have GETREGS support. */
499 cannot_fetch_register (int regno)
501 gdb_assert (regno >= 0 && regno < NUM_REGS);
502 return (!have_ptrace_getregs && regmap[regno] == -1);
506 cannot_store_register (int regno)
508 gdb_assert (regno >= 0 && regno < NUM_REGS);
509 return (!have_ptrace_getregs && regmap[regno] == -1);
512 /* Fetch register REGNO from the child process. If REGNO is -1, do
513 this for all registers (including the floating point and SSE
517 fetch_inferior_registers (int regno)
521 /* Use the old method of peeking around in `struct user' if the
522 GETREGS request isn't available. */
523 if (!have_ptrace_getregs)
527 for (i = 0; i < NUM_REGS; i++)
528 if (regno == -1 || regno == i)
534 /* GNU/Linux LWP ID's are process ID's. */
535 tid = TIDGET (inferior_ptid);
537 tid = PIDGET (inferior_ptid); /* Not a threaded program. */
539 /* Use the PTRACE_GETFPXREGS request whenever possible, since it
540 transfers more registers in one system call, and we'll cache the
541 results. But remember that fetch_fpxregs can fail, and return
547 /* The call above might reset `have_ptrace_getregs'. */
548 if (!have_ptrace_getregs)
550 fetch_inferior_registers (regno);
554 if (fetch_fpxregs (tid))
560 if (GETREGS_SUPPLIES (regno))
566 if (GETFPXREGS_SUPPLIES (regno))
568 if (fetch_fpxregs (tid))
571 /* Either our processor or our kernel doesn't support the SSE
572 registers, so read the FP registers in the traditional way,
573 and fill the SSE registers with dummy values. It would be
574 more graceful to handle differences in the register set using
575 gdbarch. Until then, this will at least make things work
581 internal_error (__FILE__, __LINE__,
582 "Got request for bad register number %d.", regno);
585 /* Store register REGNO back into the child process. If REGNO is -1,
586 do this for all registers (including the floating point and SSE
589 store_inferior_registers (int regno)
593 /* Use the old method of poking around in `struct user' if the
594 SETREGS request isn't available. */
595 if (!have_ptrace_getregs)
599 for (i = 0; i < NUM_REGS; i++)
600 if (regno == -1 || regno == i)
606 /* GNU/Linux LWP ID's are process ID's. */
607 tid = TIDGET (inferior_ptid);
609 tid = PIDGET (inferior_ptid); /* Not a threaded program. */
611 /* Use the PTRACE_SETFPXREGS requests whenever possible, since it
612 transfers more registers in one system call. But remember that
613 store_fpxregs can fail, and return zero. */
616 store_regs (tid, regno);
617 if (store_fpxregs (tid, regno))
619 store_fpregs (tid, regno);
623 if (GETREGS_SUPPLIES (regno))
625 store_regs (tid, regno);
629 if (GETFPXREGS_SUPPLIES (regno))
631 if (store_fpxregs (tid, regno))
634 /* Either our processor or our kernel doesn't support the SSE
635 registers, so just write the FP registers in the traditional
637 store_fpregs (tid, regno);
641 internal_error (__FILE__, __LINE__,
642 "Got request to store bad register number %d.", regno);
646 /* Support for debug registers. */
649 i386_linux_dr_get (int regnum)
654 /* FIXME: kettenis/2001-01-29: It's not clear what we should do with
655 multi-threaded processes here. For now, pretend there is just
657 tid = PIDGET (inferior_ptid);
659 /* FIXME: kettenis/2001-03-27: Calling perror_with_name if the
660 ptrace call fails breaks debugging remote targets. The correct
661 way to fix this is to add the hardware breakpoint and watchpoint
662 stuff to the target vectore. For now, just return zero if the
663 ptrace call fails. */
665 value = ptrace (PTRACE_PEEKUSER, tid,
666 offsetof (struct user, u_debugreg[regnum]), 0);
669 perror_with_name ("Couldn't read debug register");
678 i386_linux_dr_set (int regnum, unsigned long value)
682 /* FIXME: kettenis/2001-01-29: It's not clear what we should do with
683 multi-threaded processes here. For now, pretend there is just
685 tid = PIDGET (inferior_ptid);
688 ptrace (PTRACE_POKEUSER, tid,
689 offsetof (struct user, u_debugreg[regnum]), value);
691 perror_with_name ("Couldn't write debug register");
695 i386_linux_dr_set_control (unsigned long control)
697 i386_linux_dr_set (DR_CONTROL, control);
701 i386_linux_dr_set_addr (int regnum, CORE_ADDR addr)
703 gdb_assert (regnum >= 0 && regnum <= DR_LASTADDR - DR_FIRSTADDR);
705 i386_linux_dr_set (DR_FIRSTADDR + regnum, addr);
709 i386_linux_dr_reset_addr (int regnum)
711 gdb_assert (regnum >= 0 && regnum <= DR_LASTADDR - DR_FIRSTADDR);
713 i386_linux_dr_set (DR_FIRSTADDR + regnum, 0L);
717 i386_linux_dr_get_status (void)
719 return i386_linux_dr_get (DR_STATUS);
723 /* Called by libthread_db. Returns a pointer to the thread local
724 storage (or its descriptor). */
727 ps_get_thread_area (const struct ps_prochandle *ph,
728 lwpid_t lwpid, int idx, void **base)
730 /* NOTE: cagney/2003-08-26: The definition of this buffer is found
731 in the kernel header <asm-i386/ldt.h>. It, after padding, is 4 x
732 4 byte integers in size: `entry_number', `base_addr', `limit',
733 and a bunch of status bits.
735 The values returned by this ptrace call should be part of the
736 regcache buffer, and ps_get_thread_area should channel its
737 request through the regcache. That way remote targets could
738 provide the value using the remote protocol and not this direct
741 Is this function needed? I'm guessing that the `base' is the
742 address of a a descriptor that libthread_db uses to find the
743 thread local address base that GDB needs. Perhaps that
744 descriptor is defined by the ABI. Anyway, given that
745 libthread_db calls this function without prompting (gdb
746 requesting tls base) I guess it needs info in there anyway. */
747 unsigned int desc[4];
748 gdb_assert (sizeof (int) == 4);
750 #ifndef PTRACE_GET_THREAD_AREA
751 #define PTRACE_GET_THREAD_AREA 25
754 if (ptrace (PTRACE_GET_THREAD_AREA, lwpid,
755 (void *) idx, (unsigned long) &desc) < 0)
758 *(int *)base = desc[1];
763 /* The instruction for a GNU/Linux system call is:
767 static const unsigned char linux_syscall[] = { 0xcd, 0x80 };
769 #define LINUX_SYSCALL_LEN (sizeof linux_syscall)
771 /* The system call number is stored in the %eax register. */
772 #define LINUX_SYSCALL_REGNUM 0 /* %eax */
774 /* We are specifically interested in the sigreturn and rt_sigreturn
777 #ifndef SYS_sigreturn
778 #define SYS_sigreturn 0x77
780 #ifndef SYS_rt_sigreturn
781 #define SYS_rt_sigreturn 0xad
784 /* Offset to saved processor flags, from <asm/sigcontext.h>. */
785 #define LINUX_SIGCONTEXT_EFLAGS_OFFSET (64)
787 /* Resume execution of the inferior process.
788 If STEP is nonzero, single-step it.
789 If SIGNAL is nonzero, give it that signal. */
792 child_resume (ptid_t ptid, int step, enum target_signal signal)
794 int pid = PIDGET (ptid);
796 int request = PTRACE_CONT;
799 /* Resume all threads. */
800 /* I think this only gets used in the non-threaded case, where "resume
801 all threads" and "resume inferior_ptid" are the same. */
802 pid = PIDGET (inferior_ptid);
806 CORE_ADDR pc = read_pc_pid (pid_to_ptid (pid));
807 unsigned char buf[LINUX_SYSCALL_LEN];
809 request = PTRACE_SINGLESTEP;
811 /* Returning from a signal trampoline is done by calling a
812 special system call (sigreturn or rt_sigreturn, see
813 i386-linux-tdep.c for more information). This system call
814 restores the registers that were saved when the signal was
815 raised, including %eflags. That means that single-stepping
816 won't work. Instead, we'll have to modify the signal context
817 that's about to be restored, and set the trace flag there. */
819 /* First check if PC is at a system call. */
820 if (deprecated_read_memory_nobpt (pc, (char *) buf, LINUX_SYSCALL_LEN) == 0
821 && memcmp (buf, linux_syscall, LINUX_SYSCALL_LEN) == 0)
823 int syscall = read_register_pid (LINUX_SYSCALL_REGNUM,
826 /* Then check the system call number. */
827 if (syscall == SYS_sigreturn || syscall == SYS_rt_sigreturn)
829 CORE_ADDR sp = read_register (I386_ESP_REGNUM);
831 unsigned long int eflags;
833 if (syscall == SYS_rt_sigreturn)
834 addr = read_memory_integer (sp + 8, 4) + 20;
836 /* Set the trace flag in the context that's about to be
838 addr += LINUX_SIGCONTEXT_EFLAGS_OFFSET;
839 read_memory (addr, (char *) &eflags, 4);
841 write_memory (addr, (char *) &eflags, 4);
846 if (ptrace (request, pid, 0, target_signal_to_host (signal)) == -1)
847 perror_with_name ("ptrace");
851 child_post_startup_inferior (ptid_t ptid)
853 i386_cleanup_dregs ();
854 linux_child_post_startup_inferior (ptid);