xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/i386-linux-tdep.h (revision 8b657b0747480f8989760d71343d6dd33f8d4cf9)
1 /* Target-dependent code for GNU/Linux x86.
2 
3    Copyright (C) 2002-2023 Free Software Foundation, Inc.
4 
5    This file is part of GDB.
6 
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.
11 
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.
16 
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/>.  */
19 
20 #ifndef I386_LINUX_TDEP_H
21 #define I386_LINUX_TDEP_H
22 
23 /* The Linux kernel pretends there is an additional "orig_eax"
24    register.  Since GDB needs access to that register to be able to
25    properly restart system calls when necessary (see
26    i386-linux-tdep.c) we need our own versions of a number of
27    functions that deal with GDB's register cache.  */
28 
29 /* Register number for the "orig_eax" pseudo-register.  If this
30    pseudo-register contains a value >= 0 it is interpreted as the
31    system call number that the kernel is supposed to restart.  */
32 #define I386_LINUX_ORIG_EAX_REGNUM (I386_PKRU_REGNUM + 1)
33 
34 /* Total number of registers for GNU/Linux.  */
35 #define I386_LINUX_NUM_REGS (I386_LINUX_ORIG_EAX_REGNUM + 1)
36 
37 /* Get XSAVE extended state xcr0 from core dump.  */
38 extern uint64_t i386_linux_core_read_xcr0 (bfd *abfd);
39 
40 /* Handle and display information related to the MPX bound violation
41    to the user.  */
42 extern void i386_linux_report_signal_info (struct gdbarch *gdbarch,
43 					   struct ui_out *uiout,
44 					   enum gdb_signal siggnal);
45 
46 /* Return the target description according to XCR0.  */
47 extern const struct target_desc *i386_linux_read_description (uint64_t xcr0);
48 
49 /* Format of XSAVE extended state is:
50 	struct
51 	{
52 	  fxsave_bytes[0..463]
53 	  sw_usable_bytes[464..511]
54 	  xstate_hdr_bytes[512..575]
55 	  avx_bytes[576..831]
56 	  mpx_bytes [960..1032]
57 	  avx512_k_regs[1088..1152]
58 	  avx512_zmmh_regs0-7[1153..1407]
59 	  avx512_zmmh_regs8-15[1408..1663]
60 	  avx512_zmm_regs16-31[1664..2687]
61 	  pkru[2688..2752]
62 	  future_state etc
63 	};
64 
65   Same memory layout will be used for the coredump NT_X86_XSTATE
66   representing the XSAVE extended state registers.
67 
68   The first 8 bytes of the sw_usable_bytes[464..467] is the OS enabled
69   extended state mask, which is the same as the extended control register
70   0 (the XFEATURE_ENABLED_MASK register), XCR0.  We can use this mask
71   together with the mask saved in the xstate_hdr_bytes to determine what
72   states the processor/OS supports and what state, used or initialized,
73   the process/thread is in.  */
74 #define I386_LINUX_XSAVE_XCR0_OFFSET 464
75 
76 extern int i386_linux_gregset_reg_offset[];
77 
78 /* Return x86 siginfo type.  */
79 extern struct type *x86_linux_get_siginfo_type (struct gdbarch *gdbarch);
80 
81 #endif /* i386-linux-tdep.h */
82