Fix build error in aix-thread.c
[deliverable/binutils-gdb.git] / gdb / i386-tdep.h
CommitLineData
5716833c
MK
1/* Target-dependent code for the i386.
2
61baf725 3 Copyright (C) 2001-2017 Free Software Foundation, Inc.
9a82579f
JS
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
a9762ec7 9 the Free Software Foundation; either version 3 of the License, or
9a82579f
JS
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
a9762ec7 18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
9a82579f
JS
19
20#ifndef I386_TDEP_H
21#define I386_TDEP_H
22
da3331ec 23struct frame_info;
5716833c
MK
24struct gdbarch;
25struct reggroup;
c783cbd6 26struct regset;
5439edaa 27struct regcache;
da3331ec 28
96297dab
MK
29/* GDB's i386 target supports both the 32-bit Intel Architecture
30 (IA-32) and the 64-bit AMD x86-64 architecture. Internally it uses
31 a similar register layout for both.
32
33 - General purpose registers
34 - FPU data registers
35 - FPU control registers
36 - SSE data registers
37 - SSE control register
38
39 The general purpose registers for the x86-64 architecture are quite
3e8c568d 40 different from IA-32. Therefore, gdbarch_fp0_regnum
96297dab
MK
41 determines the register number at which the FPU data registers
42 start. The number of FPU data and control registers is the same
43 for both architectures. The number of SSE registers however,
44 differs and is determined by the num_xmm_regs member of `struct
45 gdbarch_tdep'. */
46
8201327c 47/* Convention for returning structures. */
3ce1502b 48
8201327c
MK
49enum struct_return
50{
51 pcc_struct_return, /* Return "short" structures in memory. */
52 reg_struct_return /* Return "short" structures in registers. */
3ce1502b
MK
53};
54
96297dab
MK
55/* i386 architecture specific information. */
56struct gdbarch_tdep
57{
473f17b0 58 /* General-purpose registers. */
473f17b0
MK
59 int *gregset_reg_offset;
60 int gregset_num_regs;
61 size_t sizeof_gregset;
62
63 /* Floating-point registers. */
473f17b0
MK
64 size_t sizeof_fpregset;
65
5716833c
MK
66 /* Register number for %st(0). The register numbers for the other
67 registers follow from this one. Set this to -1 to indicate the
68 absence of an FPU. */
69 int st0_regnum;
70
1ba53b71
L
71 /* Number of MMX registers. */
72 int num_mmx_regs;
73
5716833c
MK
74 /* Register number for %mm0. Set this to -1 to indicate the absence
75 of MMX support. */
76 int mm0_regnum;
77
c131fcee
L
78 /* Number of pseudo YMM registers. */
79 int num_ymm_regs;
80
81 /* Register number for %ymm0. Set this to -1 to indicate the absence
82 of pseudo YMM register support. */
83 int ymm0_regnum;
84
01f9f808
MS
85 /* Number of AVX512 OpMask registers (K-registers) */
86 int num_k_regs;
87
88 /* Register number for %k0. Set this to -1 to indicate the absence
89 of AVX512 OpMask register support. */
90 int k0_regnum;
91
92 /* Number of pseudo ZMM registers ($zmm0-$zmm31). */
93 int num_zmm_regs;
94
95 /* Register number for %zmm0. Set this to -1 to indicate the absence
96 of pseudo ZMM register support. */
97 int zmm0_regnum;
98
1ba53b71
L
99 /* Number of byte registers. */
100 int num_byte_regs;
101
102 /* Register pseudo number for %al. */
103 int al_regnum;
104
105 /* Number of pseudo word registers. */
106 int num_word_regs;
107
108 /* Register number for %ax. */
109 int ax_regnum;
110
111 /* Number of pseudo dword registers. */
112 int num_dword_regs;
113
114 /* Register number for %eax. Set this to -1 to indicate the absence
115 of pseudo dword register support. */
116 int eax_regnum;
117
90884b2b
L
118 /* Number of core registers. */
119 int num_core_regs;
120
96297dab
MK
121 /* Number of SSE registers. */
122 int num_xmm_regs;
8201327c 123
01f9f808
MS
124 /* Number of SSE registers added in AVX512. */
125 int num_xmm_avx512_regs;
126
127 /* Register number of XMM16, the first XMM register added in AVX512. */
128 int xmm16_regnum;
129
130 /* Number of YMM registers added in AVX512. */
131 int num_ymm_avx512_regs;
132
133 /* Register number of YMM16, the first YMM register added in AVX512. */
134 int ymm16_regnum;
135
c131fcee 136 /* Bits of the extended control register 0 (the XFEATURE_ENABLED_MASK
1777feb0
MS
137 register), excluding the x87 bit, which are supported by this GDB. */
138
c131fcee
L
139 uint64_t xcr0;
140
141 /* Offset of XCR0 in XSAVE extended state. */
142 int xsave_xcr0_offset;
143
90884b2b
L
144 /* Register names. */
145 const char **register_names;
146
c131fcee
L
147 /* Register number for %ymm0h. Set this to -1 to indicate the absence
148 of upper YMM register support. */
149 int ymm0h_regnum;
150
151 /* Upper YMM register names. Only used for tdesc_numbered_register. */
152 const char **ymmh_register_names;
153
01f9f808
MS
154 /* Register number for %ymm16h. Set this to -1 to indicate the absence
155 of support for YMM16-31. */
156 int ymm16h_regnum;
157
158 /* YMM16-31 register names. Only used for tdesc_numbered_register. */
159 const char **ymm16h_register_names;
160
1dbcd68c
WT
161 /* Register number for %bnd0r. Set this to -1 to indicate the absence
162 bound registers. */
163 int bnd0r_regnum;
164
165 /* Register number for pseudo register %bnd0. Set this to -1 to indicate the absence
166 bound registers. */
167 int bnd0_regnum;
168
169 /* Register number for %bndcfgu. Set this to -1 to indicate the absence
170 bound control registers. */
171 int bndcfgu_regnum;
172
173 /* MPX register names. Only used for tdesc_numbered_register. */
174 const char **mpx_register_names;
175
01f9f808
MS
176 /* Register number for %zmm0h. Set this to -1 to indicate the absence
177 of ZMM_HI256 register support. */
178 int zmm0h_regnum;
179
180 /* OpMask register names. */
181 const char **k_register_names;
182
183 /* ZMM register names. Only used for tdesc_numbered_register. */
184 const char **zmmh_register_names;
185
186 /* XMM16-31 register names. Only used for tdesc_numbered_register. */
187 const char **xmm_avx512_register_names;
188
189 /* YMM16-31 register names. Only used for tdesc_numbered_register. */
190 const char **ymm_avx512_register_names;
191
51547df6
MS
192 /* Number of PKEYS registers. */
193 int num_pkeys_regs;
194
195 /* Register number for PKRU register. */
196 int pkru_regnum;
197
198 /* PKEYS register names. */
199 const char **pkeys_register_names;
200
90884b2b
L
201 /* Target description. */
202 const struct target_desc *tdesc;
203
204 /* Register group function. */
c5bcd278 205 gdbarch_register_reggroup_p_ftype *register_reggroup_p;
90884b2b 206
8201327c
MK
207 /* Offset of saved PC in jmp_buf. */
208 int jb_pc_offset;
209
210 /* Convention for returning structures. */
211 enum struct_return struct_return;
212
8201327c
MK
213 /* Address range where sigtramp lives. */
214 CORE_ADDR sigtramp_start;
215 CORE_ADDR sigtramp_end;
216
911bc6ee
MK
217 /* Detect sigtramp. */
218 int (*sigtramp_p) (struct frame_info *);
219
21d0e8a4
MK
220 /* Get address of sigcontext for sigtramp. */
221 CORE_ADDR (*sigcontext_addr) (struct frame_info *);
222
a3386186
MK
223 /* Offset of registers in `struct sigcontext'. */
224 int *sc_reg_offset;
225 int sc_num_regs;
226
227 /* Offset of saved PC and SP in `struct sigcontext'. Usage of these
228 is deprecated, please use `sc_reg_offset' instead. */
8201327c 229 int sc_pc_offset;
21d0e8a4 230 int sc_sp_offset;
794ac428
UW
231
232 /* ISA-specific data types. */
233 struct type *i386_mmx_type;
c131fcee 234 struct type *i386_ymm_type;
01f9f808 235 struct type *i386_zmm_type;
27067745 236 struct type *i387_ext_type;
1dbcd68c 237 struct type *i386_bnd_type;
7ad10968
HZ
238
239 /* Process record/replay target. */
cf648174
HZ
240 /* The map for registers because the AMD64's registers order
241 in GDB is not same as I386 instructions. */
242 const int *record_regmap;
7ad10968
HZ
243 /* Parse intx80 args. */
244 int (*i386_intx80_record) (struct regcache *regcache);
245 /* Parse sysenter args. */
246 int (*i386_sysenter_record) (struct regcache *regcache);
cf648174
HZ
247 /* Parse syscall args. */
248 int (*i386_syscall_record) (struct regcache *regcache);
8f0435f7
AA
249
250 /* Regsets. */
251 const struct regset *fpregset;
96297dab
MK
252};
253
254/* Floating-point registers. */
255
96297dab
MK
256/* All FPU control regusters (except for FIOFF and FOOFF) are 16-bit
257 (at most) in the FPU, but are zero-extended to 32 bits in GDB's
258 register cache. */
259
23a34459
AC
260/* Return non-zero if REGNUM matches the FP register and the FP
261 register set is active. */
20a6ec49
MD
262extern int i386_fp_regnum_p (struct gdbarch *, int);
263extern int i386_fpc_regnum_p (struct gdbarch *, int);
96297dab 264
a3386186
MK
265/* Register numbers of various important registers. */
266
bcf48cc7
MK
267enum i386_regnum
268{
269 I386_EAX_REGNUM, /* %eax */
270 I386_ECX_REGNUM, /* %ecx */
271 I386_EDX_REGNUM, /* %edx */
272 I386_EBX_REGNUM, /* %ebx */
273 I386_ESP_REGNUM, /* %esp */
274 I386_EBP_REGNUM, /* %ebp */
275 I386_ESI_REGNUM, /* %esi */
276 I386_EDI_REGNUM, /* %edi */
277 I386_EIP_REGNUM, /* %eip */
278 I386_EFLAGS_REGNUM, /* %eflags */
2666fb59
MK
279 I386_CS_REGNUM, /* %cs */
280 I386_SS_REGNUM, /* %ss */
e9ff708b
AC
281 I386_DS_REGNUM, /* %ds */
282 I386_ES_REGNUM, /* %es */
283 I386_FS_REGNUM, /* %fs */
284 I386_GS_REGNUM, /* %gs */
90884b2b 285 I386_ST0_REGNUM, /* %st(0) */
c131fcee
L
286 I386_MXCSR_REGNUM = 40, /* %mxcsr */
287 I386_YMM0H_REGNUM, /* %ymm0h */
1dbcd68c
WT
288 I386_YMM7H_REGNUM = I386_YMM0H_REGNUM + 7,
289 I386_BND0R_REGNUM,
290 I386_BND3R_REGNUM = I386_BND0R_REGNUM + 3,
291 I386_BNDCFGU_REGNUM,
01f9f808
MS
292 I386_BNDSTATUS_REGNUM,
293 I386_K0_REGNUM, /* %k0 */
294 I386_K7_REGNUM = I386_K0_REGNUM + 7,
295 I386_ZMM0H_REGNUM, /* %zmm0h */
51547df6
MS
296 I386_ZMM7H_REGNUM = I386_ZMM0H_REGNUM + 7,
297 I386_PKRU_REGNUM
bcf48cc7 298};
a3386186 299
cf648174
HZ
300/* Register numbers of RECORD_REGMAP. */
301
302enum record_i386_regnum
303{
304 X86_RECORD_REAX_REGNUM,
305 X86_RECORD_RECX_REGNUM,
306 X86_RECORD_REDX_REGNUM,
307 X86_RECORD_REBX_REGNUM,
308 X86_RECORD_RESP_REGNUM,
309 X86_RECORD_REBP_REGNUM,
310 X86_RECORD_RESI_REGNUM,
311 X86_RECORD_REDI_REGNUM,
312 X86_RECORD_R8_REGNUM,
313 X86_RECORD_R9_REGNUM,
314 X86_RECORD_R10_REGNUM,
315 X86_RECORD_R11_REGNUM,
316 X86_RECORD_R12_REGNUM,
317 X86_RECORD_R13_REGNUM,
318 X86_RECORD_R14_REGNUM,
319 X86_RECORD_R15_REGNUM,
320 X86_RECORD_REIP_REGNUM,
321 X86_RECORD_EFLAGS_REGNUM,
322 X86_RECORD_CS_REGNUM,
323 X86_RECORD_SS_REGNUM,
324 X86_RECORD_DS_REGNUM,
325 X86_RECORD_ES_REGNUM,
326 X86_RECORD_FS_REGNUM,
327 X86_RECORD_GS_REGNUM,
328};
329
8201327c 330#define I386_NUM_GREGS 16
8201327c
MK
331#define I386_NUM_XREGS 9
332
90884b2b 333#define I386_SSE_NUM_REGS (I386_MXCSR_REGNUM + 1)
c131fcee 334#define I386_AVX_NUM_REGS (I386_YMM7H_REGNUM + 1)
1dbcd68c 335#define I386_MPX_NUM_REGS (I386_BNDSTATUS_REGNUM + 1)
01f9f808 336#define I386_AVX512_NUM_REGS (I386_ZMM7H_REGNUM + 1)
51547df6 337#define I386_PKEYS_NUM_REGS (I386_PKRU_REGNUM + 1)
8201327c 338
00f8375e 339/* Size of the largest register. */
01f9f808 340#define I386_MAX_REGISTER_SIZE 64
00f8375e 341
97de3545
JB
342extern struct target_desc *tdesc_i386;
343
5ae96ec1 344/* Types for i386-specific registers. */
27067745 345extern struct type *i387_ext_type (struct gdbarch *gdbarch);
794ac428 346
1ba53b71
L
347/* Checks of different pseudo-registers. */
348extern int i386_byte_regnum_p (struct gdbarch *gdbarch, int regnum);
349extern int i386_word_regnum_p (struct gdbarch *gdbarch, int regnum);
350extern int i386_dword_regnum_p (struct gdbarch *gdbarch, int regnum);
c131fcee 351extern int i386_xmm_regnum_p (struct gdbarch *gdbarch, int regnum);
01f9f808 352extern int i386_xmm_avx512_regnum_p (struct gdbarch * gdbarch, int regnum);
c131fcee 353extern int i386_ymm_regnum_p (struct gdbarch *gdbarch, int regnum);
01f9f808 354extern int i386_ymm_avx512_regnum_p (struct gdbarch *gdbarch, int regnum);
1dbcd68c 355extern int i386_bnd_regnum_p (struct gdbarch *gdbarch, int regnum);
01f9f808
MS
356extern int i386_k_regnum_p (struct gdbarch *gdbarch, int regnum);
357extern int i386_zmm_regnum_p (struct gdbarch *gdbarch, int regnum);
358extern int i386_zmmh_regnum_p (struct gdbarch *gdbarch, int regnum);
51547df6 359extern bool i386_pkru_regnum_p (struct gdbarch *gdbarch, int regnum);
1ba53b71
L
360
361extern const char *i386_pseudo_register_name (struct gdbarch *gdbarch,
362 int regnum);
fff4548b
MK
363extern struct type *i386_pseudo_register_type (struct gdbarch *gdbarch,
364 int regnum);
1ba53b71 365
3543a589
TT
366extern void i386_pseudo_register_read_into_value (struct gdbarch *gdbarch,
367 struct regcache *regcache,
368 int regnum,
369 struct value *result);
370
1ba53b71
L
371extern void i386_pseudo_register_write (struct gdbarch *gdbarch,
372 struct regcache *regcache,
373 int regnum, const gdb_byte *buf);
374
62e5fd57
MK
375extern int i386_ax_pseudo_register_collect (struct gdbarch *gdbarch,
376 struct agent_expr *ax,
377 int regnum);
378
508fbfea
MK
379/* Segment selectors. */
380#define I386_SEL_RPL 0x0003 /* Requester's Privilege Level mask. */
1777feb0
MS
381#define I386_SEL_UPL 0x0003 /* User Privilige Level. */
382#define I386_SEL_KPL 0x0000 /* Kernel Privilige Level. */
508fbfea 383
237fc4c9
PA
384/* The length of the longest i386 instruction (according to
385 include/asm-i386/kprobes.h in Linux 2.6. */
386#define I386_MAX_INSN_LEN (16)
387
1cce71eb 388/* Functions exported from i386-tdep.c. */
e17a4113
UW
389extern CORE_ADDR i386_pe_skip_trampoline_code (struct frame_info *frame,
390 CORE_ADDR pc, char *name);
1777feb0
MS
391extern CORE_ADDR i386_skip_main_prologue (struct gdbarch *gdbarch,
392 CORE_ADDR pc);
1cce71eb 393
4bd207ef
TG
394/* Return whether the THIS_FRAME corresponds to a sigtramp routine. */
395extern int i386_sigtramp_p (struct frame_info *this_frame);
396
38c968cf
AC
397/* Return non-zero if REGNUM is a member of the specified group. */
398extern int i386_register_reggroup_p (struct gdbarch *gdbarch, int regnum,
399 struct reggroup *group);
400
20187ed5
MK
401/* Supply register REGNUM from the general-purpose register set REGSET
402 to register cache REGCACHE. If REGNUM is -1, do this for all
403 registers in REGSET. */
404extern void i386_supply_gregset (const struct regset *regset,
405 struct regcache *regcache, int regnum,
406 const void *gregs, size_t len);
3d171c85 407
ecc37a5a
AA
408/* General-purpose register set. */
409extern const struct regset i386_gregset;
20187ed5 410
8f0435f7
AA
411/* Floating-point register set. */
412extern const struct regset i386_fpregset;
413
490496c3
AA
414/* Default iterator over core file register note sections. */
415extern void
416 i386_iterate_over_regset_sections (struct gdbarch *gdbarch,
417 iterate_over_regset_sections_cb *cb,
418 void *cb_data,
419 const struct regcache *regcache);
237fc4c9 420
b55078be
DE
421extern struct displaced_step_closure *i386_displaced_step_copy_insn
422 (struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to,
423 struct regcache *regs);
237fc4c9
PA
424extern void i386_displaced_step_fixup (struct gdbarch *gdbarch,
425 struct displaced_step_closure *closure,
426 CORE_ADDR from, CORE_ADDR to,
427 struct regcache *regs);
428
8201327c
MK
429/* Initialize a basic ELF architecture variant. */
430extern void i386_elf_init_abi (struct gdbarch_info, struct gdbarch *);
431
432/* Initialize a SVR4 architecture variant. */
433extern void i386_svr4_init_abi (struct gdbarch_info, struct gdbarch *);
a6b808b4
HZ
434
435extern int i386_process_record (struct gdbarch *gdbarch,
436 struct regcache *regcache, CORE_ADDR addr);
97de3545 437extern const struct target_desc *i386_target_description (uint64_t xcr0);
55aa24fb 438
012b3a21
WT
439/* Return true iff the current target is MPX enabled. */
440extern int i386_mpx_enabled (void);
de0b6abb 441\f
8201327c 442
03b62bbb 443/* Functions and variables exported from i386-bsd-tdep.c. */
8201327c 444
3cac699e 445extern void i386bsd_init_abi (struct gdbarch_info, struct gdbarch *);
5d93ae8c
MK
446extern CORE_ADDR i386fbsd_sigtramp_start_addr;
447extern CORE_ADDR i386fbsd_sigtramp_end_addr;
448extern CORE_ADDR i386obsd_sigtramp_start_addr;
449extern CORE_ADDR i386obsd_sigtramp_end_addr;
de0b6abb
MK
450extern int i386fbsd4_sc_reg_offset[];
451extern int i386fbsd_sc_reg_offset[];
452extern int i386nbsd_sc_reg_offset[];
453extern int i386obsd_sc_reg_offset[];
454extern int i386bsd_sc_reg_offset[];
3ce1502b 455
55aa24fb
SDJ
456/* SystemTap related functions. */
457
458extern int i386_stap_is_single_operand (struct gdbarch *gdbarch,
459 const char *s);
460
461extern int i386_stap_parse_special_token (struct gdbarch *gdbarch,
462 struct stap_parse_info *p);
463
96297dab 464#endif /* i386-tdep.h */
This page took 1.398618 seconds and 4 git commands to generate.