1 /* Native-dependent code for FreeBSD/amd64.
3 Copyright (C) 2003-2024 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/>. */
26 #include <sys/types.h>
27 #include <sys/ptrace.h>
28 #include <sys/sysctl.h>
30 #include <machine/reg.h>
32 #include "amd64-tdep.h"
33 #include "amd64-fbsd-tdep.h"
34 #include "i387-tdep.h"
35 #include "amd64-nat.h"
37 #include "x86-fbsd-nat.h"
39 class amd64_fbsd_nat_target final
: public x86_fbsd_nat_target
42 void fetch_registers (struct regcache
*, int) override
;
43 void store_registers (struct regcache
*, int) override
;
45 const struct target_desc
*read_description () override
;
48 static amd64_fbsd_nat_target the_amd64_fbsd_nat_target
;
50 /* This is a layout of the amd64 'struct reg' but with i386
53 static const struct regcache_map_entry amd64_fbsd32_gregmap
[] =
55 { 8, REGCACHE_MAP_SKIP
, 8 },
56 { 1, I386_EDI_REGNUM
, 8 },
57 { 1, I386_ESI_REGNUM
, 8 },
58 { 1, I386_EBP_REGNUM
, 8 },
59 { 1, I386_EBX_REGNUM
, 8 },
60 { 1, I386_EDX_REGNUM
, 8 },
61 { 1, I386_ECX_REGNUM
, 8 },
62 { 1, I386_EAX_REGNUM
, 8 },
63 { 1, REGCACHE_MAP_SKIP
, 4 }, /* trapno */
64 { 1, I386_FS_REGNUM
, 2 },
65 { 1, I386_GS_REGNUM
, 2 },
66 { 1, REGCACHE_MAP_SKIP
, 4 }, /* err */
67 { 1, I386_ES_REGNUM
, 2 },
68 { 1, I386_DS_REGNUM
, 2 },
69 { 1, I386_EIP_REGNUM
, 8 },
70 { 1, I386_CS_REGNUM
, 8 },
71 { 1, I386_EFLAGS_REGNUM
, 8 },
72 { 1, I386_ESP_REGNUM
, 0 },
73 { 1, I386_SS_REGNUM
, 8 },
77 static const struct regset amd64_fbsd32_gregset
=
79 amd64_fbsd32_gregmap
, regcache_supply_regset
, regcache_collect_regset
82 /* Return the regset to use for 'struct reg' for the GDBARCH. */
84 static const struct regset
*
85 find_gregset (struct gdbarch
*gdbarch
)
87 if (gdbarch_bfd_arch_info (gdbarch
)->bits_per_word
== 32)
88 return &amd64_fbsd32_gregset
;
90 return &amd64_fbsd_gregset
;
93 /* Fetch register REGNUM from the inferior. If REGNUM is -1, do this
97 amd64_fbsd_nat_target::fetch_registers (struct regcache
*regcache
, int regnum
)
99 struct gdbarch
*gdbarch
= regcache
->arch ();
100 #if defined(PT_GETFSBASE) || defined(PT_GETGSBASE)
101 const i386_gdbarch_tdep
*tdep
= gdbarch_tdep
<i386_gdbarch_tdep
> (gdbarch
);
103 pid_t pid
= get_ptrace_pid (regcache
->ptid ());
104 const struct regset
*gregset
= find_gregset (gdbarch
);
106 if (fetch_register_set
<struct reg
> (regcache
, regnum
, PT_GETREGS
, gregset
))
113 if (regnum
== -1 || regnum
== tdep
->fsbase_regnum
)
117 if (ptrace (PT_GETFSBASE
, pid
, (PTRACE_TYPE_ARG3
) &base
, 0) == -1)
118 perror_with_name (_("Couldn't get segment register fs_base"));
120 regcache
->raw_supply (tdep
->fsbase_regnum
, &base
);
126 if (regnum
== -1 || regnum
== tdep
->fsbase_regnum
+ 1)
130 if (ptrace (PT_GETGSBASE
, pid
, (PTRACE_TYPE_ARG3
) &base
, 0) == -1)
131 perror_with_name (_("Couldn't get segment register gs_base"));
133 regcache
->raw_supply (tdep
->fsbase_regnum
+ 1, &base
);
139 /* There is no amd64_fxsave_supplies or amd64_xsave_supplies.
140 Instead, the earlier register sets return early if the request
141 was for a specific register that was already satisified to avoid
142 fetching the FPU/XSAVE state unnecessarily. */
144 #ifdef PT_GETXSTATE_INFO
145 if (m_xsave_info
.xsave_len
!= 0)
147 void *xstateregs
= alloca (m_xsave_info
.xsave_len
);
149 if (ptrace (PT_GETXSTATE
, pid
, (PTRACE_TYPE_ARG3
) xstateregs
, 0) == -1)
150 perror_with_name (_("Couldn't get extended state status"));
152 amd64_supply_xsave (regcache
, regnum
, xstateregs
);
159 if (ptrace (PT_GETFPREGS
, pid
, (PTRACE_TYPE_ARG3
) &fpregs
, 0) == -1)
160 perror_with_name (_("Couldn't get floating point status"));
162 amd64_supply_fxsave (regcache
, regnum
, &fpregs
);
165 /* Store register REGNUM back into the inferior. If REGNUM is -1, do
166 this for all registers. */
169 amd64_fbsd_nat_target::store_registers (struct regcache
*regcache
, int regnum
)
171 struct gdbarch
*gdbarch
= regcache
->arch ();
172 #if defined(PT_GETFSBASE) || defined(PT_GETGSBASE)
173 const i386_gdbarch_tdep
*tdep
= gdbarch_tdep
<i386_gdbarch_tdep
> (gdbarch
);
175 pid_t pid
= get_ptrace_pid (regcache
->ptid ());
176 const struct regset
*gregset
= find_gregset (gdbarch
);
178 if (store_register_set
<struct reg
> (regcache
, regnum
, PT_GETREGS
, PT_SETREGS
,
186 if (regnum
== -1 || regnum
== tdep
->fsbase_regnum
)
190 /* Clear the full base value to support 32-bit targets. */
192 regcache
->raw_collect (tdep
->fsbase_regnum
, &base
);
194 if (ptrace (PT_SETFSBASE
, pid
, (PTRACE_TYPE_ARG3
) &base
, 0) == -1)
195 perror_with_name (_("Couldn't write segment register fs_base"));
201 if (regnum
== -1 || regnum
== tdep
->fsbase_regnum
+ 1)
205 /* Clear the full base value to support 32-bit targets. */
207 regcache
->raw_collect (tdep
->fsbase_regnum
+ 1, &base
);
209 if (ptrace (PT_SETGSBASE
, pid
, (PTRACE_TYPE_ARG3
) &base
, 0) == -1)
210 perror_with_name (_("Couldn't write segment register gs_base"));
216 /* There is no amd64_fxsave_supplies or amd64_xsave_supplies.
217 Instead, the earlier register sets return early if the request
218 was for a specific register that was already satisified to avoid
219 fetching the FPU/XSAVE state unnecessarily. */
221 #ifdef PT_GETXSTATE_INFO
222 if (m_xsave_info
.xsave_len
!= 0)
224 void *xstateregs
= alloca (m_xsave_info
.xsave_len
);
226 if (ptrace (PT_GETXSTATE
, pid
, (PTRACE_TYPE_ARG3
) xstateregs
, 0) == -1)
227 perror_with_name (_("Couldn't get extended state status"));
229 amd64_collect_xsave (regcache
, regnum
, xstateregs
, 0);
231 if (ptrace (PT_SETXSTATE
, pid
, (PTRACE_TYPE_ARG3
) xstateregs
,
232 m_xsave_info
.xsave_len
) == -1)
233 perror_with_name (_("Couldn't write extended state status"));
240 if (ptrace (PT_GETFPREGS
, pid
, (PTRACE_TYPE_ARG3
) &fpregs
, 0) == -1)
241 perror_with_name (_("Couldn't get floating point status"));
243 amd64_collect_fxsave (regcache
, regnum
, &fpregs
);
245 if (ptrace (PT_SETFPREGS
, pid
, (PTRACE_TYPE_ARG3
) &fpregs
, 0) == -1)
246 perror_with_name (_("Couldn't write floating point status"));
249 /* Support for debugging kernel virtual memory images. */
251 #include <machine/pcb.h>
252 #include <osreldate.h>
257 amd64fbsd_supply_pcb (struct regcache
*regcache
, struct pcb
*pcb
)
259 /* The following is true for FreeBSD 5.2:
261 The pcb contains %rip, %rbx, %rsp, %rbp, %r12, %r13, %r14, %r15,
262 %ds, %es, %fs and %gs. This accounts for all callee-saved
263 registers specified by the psABI and then some. Here %esp
264 contains the stack pointer at the point just after the call to
265 cpu_switch(). From this information we reconstruct the register
266 state as it would like when we just returned from cpu_switch(). */
268 /* The stack pointer shouldn't be zero. */
269 if (pcb
->pcb_rsp
== 0)
273 regcache
->raw_supply (AMD64_RIP_REGNUM
, &pcb
->pcb_rip
);
274 regcache
->raw_supply (AMD64_RBX_REGNUM
, &pcb
->pcb_rbx
);
275 regcache
->raw_supply (AMD64_RSP_REGNUM
, &pcb
->pcb_rsp
);
276 regcache
->raw_supply (AMD64_RBP_REGNUM
, &pcb
->pcb_rbp
);
277 regcache
->raw_supply (12, &pcb
->pcb_r12
);
278 regcache
->raw_supply (13, &pcb
->pcb_r13
);
279 regcache
->raw_supply (14, &pcb
->pcb_r14
);
280 regcache
->raw_supply (15, &pcb
->pcb_r15
);
281 #if (__FreeBSD_version < 800075) && (__FreeBSD_kernel_version < 800075)
282 /* struct pcb provides the pcb_ds/pcb_es/pcb_fs/pcb_gs fields only
283 up until __FreeBSD_version 800074: The removal of these fields
284 occurred on 2009-04-01 while the __FreeBSD_version number was
285 bumped to 800075 on 2009-04-06. So 800075 is the closest version
286 number where we should not try to access these fields. */
287 regcache
->raw_supply (AMD64_DS_REGNUM
, &pcb
->pcb_ds
);
288 regcache
->raw_supply (AMD64_ES_REGNUM
, &pcb
->pcb_es
);
289 regcache
->raw_supply (AMD64_FS_REGNUM
, &pcb
->pcb_fs
);
290 regcache
->raw_supply (AMD64_GS_REGNUM
, &pcb
->pcb_gs
);
297 /* Implement the read_description method. */
299 const struct target_desc
*
300 amd64_fbsd_nat_target::read_description ()
305 if (inferior_ptid
== null_ptid
)
306 return this->beneath ()->read_description ();
308 if (ptrace (PT_GETREGS
, inferior_ptid
.pid (),
309 (PTRACE_TYPE_ARG3
) ®s
, 0) == -1)
310 perror_with_name (_("Couldn't get registers"));
311 is64
= (regs
.r_cs
== GSEL (GUCODE_SEL
, SEL_UPL
));
312 #ifdef PT_GETXSTATE_INFO
313 probe_xsave_layout (inferior_ptid
.pid ());
314 if (m_xsave_info
.xsave_len
!= 0)
317 return amd64_target_description (m_xsave_info
.xsave_mask
, true);
319 return i386_target_description (m_xsave_info
.xsave_mask
, true);
323 return amd64_target_description (X86_XSTATE_SSE_MASK
, true);
325 return i386_target_description (X86_XSTATE_SSE_MASK
, true);
328 void _initialize_amd64fbsd_nat ();
330 _initialize_amd64fbsd_nat ()
332 add_inf_child_target (&the_amd64_fbsd_nat_target
);
334 /* Support debugging kernel virtual memory images. */
335 bsd_kvm_add_target (amd64fbsd_supply_pcb
);