GDB (xrefs)
/tmp/gdb-7.10/gdb/i386-tdep.h
Go to the documentation of this file.
1 /* Target-dependent code for the i386.
2 
3  Copyright (C) 2001-2015 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_TDEP_H
21 #define I386_TDEP_H
22 
23 struct frame_info;
24 struct gdbarch;
25 struct reggroup;
26 struct regset;
27 struct regcache;
28 
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
40  different from IA-32. Therefore, gdbarch_fp0_regnum
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 
47 /* Convention for returning structures. */
48 
49 enum struct_return
50 {
51  pcc_struct_return, /* Return "short" structures in memory. */
52  reg_struct_return /* Return "short" structures in registers. */
53 };
54 
55 /* i386 architecture specific information. */
56 struct gdbarch_tdep
57 {
58  /* General-purpose registers. */
62 
63  /* Floating-point registers. */
65 
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. */
70 
71  /* Number of MMX registers. */
73 
74  /* Register number for %mm0. Set this to -1 to indicate the absence
75  of MMX support. */
77 
78  /* Number of pseudo YMM registers. */
80 
81  /* Register number for %ymm0. Set this to -1 to indicate the absence
82  of pseudo YMM register support. */
84 
85  /* Number of AVX512 OpMask registers (K-registers) */
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). */
94 
95  /* Register number for %zmm0. Set this to -1 to indicate the absence
96  of pseudo ZMM register support. */
98 
99  /* Number of byte registers. */
101 
102  /* Register pseudo number for %al. */
104 
105  /* Number of pseudo word registers. */
107 
108  /* Register number for %ax. */
110 
111  /* Number of pseudo dword registers. */
113 
114  /* Register number for %eax. Set this to -1 to indicate the absence
115  of pseudo dword register support. */
117 
118  /* Number of core registers. */
120 
121  /* Number of SSE registers. */
123 
124  /* Number of SSE registers added in AVX512. */
126 
127  /* Register number of XMM16, the first XMM register added in AVX512. */
129 
130  /* Number of YMM registers added in AVX512. */
132 
133  /* Register number of YMM16, the first YMM register added in AVX512. */
135 
136  /* Bits of the extended control register 0 (the XFEATURE_ENABLED_MASK
137  register), excluding the x87 bit, which are supported by this GDB. */
138 
139  uint64_t xcr0;
140 
141  /* Offset of XCR0 in XSAVE extended state. */
143 
144  /* Register names. */
145  const char **register_names;
146 
147  /* Register number for %ymm0h. Set this to -1 to indicate the absence
148  of upper YMM register support. */
150 
151  /* Upper YMM register names. Only used for tdesc_numbered_register. */
152  const char **ymmh_register_names;
153 
154  /* Register number for %ymm16h. Set this to -1 to indicate the absence
155  of support for YMM16-31. */
157 
158  /* YMM16-31 register names. Only used for tdesc_numbered_register. */
159  const char **ymm16h_register_names;
160 
161  /* Register number for %bnd0r. Set this to -1 to indicate the absence
162  bound registers. */
164 
165  /* Register number for pseudo register %bnd0. Set this to -1 to indicate the absence
166  bound registers. */
168 
169  /* Register number for %bndcfgu. Set this to -1 to indicate the absence
170  bound control registers. */
172 
173  /* MPX register names. Only used for tdesc_numbered_register. */
174  const char **mpx_register_names;
175 
176  /* Register number for %zmm0h. Set this to -1 to indicate the absence
177  of ZMM_HI256 register support. */
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. */
188 
189  /* YMM16-31 register names. Only used for tdesc_numbered_register. */
191 
192  /* Target description. */
193  const struct target_desc *tdesc;
194 
195  /* Register group function. */
196  const void *register_reggroup_p;
197 
198  /* Offset of saved PC in jmp_buf. */
200 
201  /* Convention for returning structures. */
202  enum struct_return struct_return;
203 
204  /* Address range where sigtramp lives. */
207 
208  /* Detect sigtramp. */
209  int (*sigtramp_p) (struct frame_info *);
210 
211  /* Get address of sigcontext for sigtramp. */
212  CORE_ADDR (*sigcontext_addr) (struct frame_info *);
213 
214  /* Offset of registers in `struct sigcontext'. */
217 
218  /* Offset of saved PC and SP in `struct sigcontext'. Usage of these
219  is deprecated, please use `sc_reg_offset' instead. */
220  int sc_pc_offset;
222 
223  /* ISA-specific data types. */
229 
230  /* Process record/replay target. */
231  /* The map for registers because the AMD64's registers order
232  in GDB is not same as I386 instructions. */
233  const int *record_regmap;
234  /* Parse intx80 args. */
236  /* Parse sysenter args. */
238  /* Parse syscall args. */
240 
241  /* Regsets. */
242  const struct regset *fpregset;
243 };
244 
245 /* Floating-point registers. */
246 
247 /* All FPU control regusters (except for FIOFF and FOOFF) are 16-bit
248  (at most) in the FPU, but are zero-extended to 32 bits in GDB's
249  register cache. */
250 
251 /* Return non-zero if REGNUM matches the FP register and the FP
252  register set is active. */
253 extern int i386_fp_regnum_p (struct gdbarch *, int);
254 extern int i386_fpc_regnum_p (struct gdbarch *, int);
255 
256 /* Register numbers of various important registers. */
257 
259 {
260  I386_EAX_REGNUM, /* %eax */
261  I386_ECX_REGNUM, /* %ecx */
262  I386_EDX_REGNUM, /* %edx */
263  I386_EBX_REGNUM, /* %ebx */
264  I386_ESP_REGNUM, /* %esp */
265  I386_EBP_REGNUM, /* %ebp */
266  I386_ESI_REGNUM, /* %esi */
267  I386_EDI_REGNUM, /* %edi */
268  I386_EIP_REGNUM, /* %eip */
269  I386_EFLAGS_REGNUM, /* %eflags */
270  I386_CS_REGNUM, /* %cs */
271  I386_SS_REGNUM, /* %ss */
272  I386_DS_REGNUM, /* %ds */
273  I386_ES_REGNUM, /* %es */
274  I386_FS_REGNUM, /* %fs */
275  I386_GS_REGNUM, /* %gs */
276  I386_ST0_REGNUM, /* %st(0) */
277  I386_MXCSR_REGNUM = 40, /* %mxcsr */
278  I386_YMM0H_REGNUM, /* %ymm0h */
284  I386_K0_REGNUM, /* %k0 */
286  I386_ZMM0H_REGNUM, /* %zmm0h */
288 };
289 
290 /* Register numbers of RECORD_REGMAP. */
291 
293 {
318 };
319 
320 #define I386_NUM_GREGS 16
321 #define I386_NUM_XREGS 9
322 
323 #define I386_SSE_NUM_REGS (I386_MXCSR_REGNUM + 1)
324 #define I386_AVX_NUM_REGS (I386_YMM7H_REGNUM + 1)
325 #define I386_MPX_NUM_REGS (I386_BNDSTATUS_REGNUM + 1)
326 #define I386_AVX512_NUM_REGS (I386_ZMM7H_REGNUM + 1)
327 
328 /* Size of the largest register. */
329 #define I386_MAX_REGISTER_SIZE 64
330 
331 extern struct target_desc *tdesc_i386;
332 
333 /* Types for i386-specific registers. */
334 extern struct type *i387_ext_type (struct gdbarch *gdbarch);
335 
336 /* Checks of different pseudo-registers. */
337 extern int i386_byte_regnum_p (struct gdbarch *gdbarch, int regnum);
338 extern int i386_word_regnum_p (struct gdbarch *gdbarch, int regnum);
339 extern int i386_dword_regnum_p (struct gdbarch *gdbarch, int regnum);
340 extern int i386_xmm_regnum_p (struct gdbarch *gdbarch, int regnum);
341 extern int i386_xmm_avx512_regnum_p (struct gdbarch * gdbarch, int regnum);
342 extern int i386_ymm_regnum_p (struct gdbarch *gdbarch, int regnum);
343 extern int i386_ymm_avx512_regnum_p (struct gdbarch *gdbarch, int regnum);
344 extern int i386_bnd_regnum_p (struct gdbarch *gdbarch, int regnum);
345 extern int i386_k_regnum_p (struct gdbarch *gdbarch, int regnum);
346 extern int i386_zmm_regnum_p (struct gdbarch *gdbarch, int regnum);
347 extern int i386_zmmh_regnum_p (struct gdbarch *gdbarch, int regnum);
348 
349 extern const char *i386_pseudo_register_name (struct gdbarch *gdbarch,
350  int regnum);
351 extern struct type *i386_pseudo_register_type (struct gdbarch *gdbarch,
352  int regnum);
353 
355  struct regcache *regcache,
356  int regnum,
357  struct value *result);
358 
359 extern void i386_pseudo_register_write (struct gdbarch *gdbarch,
360  struct regcache *regcache,
361  int regnum, const gdb_byte *buf);
362 
363 /* Segment selectors. */
364 #define I386_SEL_RPL 0x0003 /* Requester's Privilege Level mask. */
365 #define I386_SEL_UPL 0x0003 /* User Privilige Level. */
366 #define I386_SEL_KPL 0x0000 /* Kernel Privilige Level. */
367 
368 /* The length of the longest i386 instruction (according to
369  include/asm-i386/kprobes.h in Linux 2.6. */
370 #define I386_MAX_INSN_LEN (16)
371 
372 /* Functions exported from i386-tdep.c. */
374  CORE_ADDR pc, char *name);
376  CORE_ADDR pc);
377 
378 /* Return whether the THIS_FRAME corresponds to a sigtramp routine. */
379 extern int i386_sigtramp_p (struct frame_info *this_frame);
380 
381 /* Return non-zero if REGNUM is a member of the specified group. */
382 extern int i386_register_reggroup_p (struct gdbarch *gdbarch, int regnum,
383  struct reggroup *group);
384 
385 /* Supply register REGNUM from the general-purpose register set REGSET
386  to register cache REGCACHE. If REGNUM is -1, do this for all
387  registers in REGSET. */
388 extern void i386_supply_gregset (const struct regset *regset,
389  struct regcache *regcache, int regnum,
390  const void *gregs, size_t len);
391 
392 /* General-purpose register set. */
393 extern const struct regset i386_gregset;
394 
395 /* Floating-point register set. */
396 extern const struct regset i386_fpregset;
397 
398 /* Default iterator over core file register note sections. */
399 extern void
402  void *cb_data,
403  const struct regcache *regcache);
404 
407  struct regcache *regs);
408 extern void i386_displaced_step_fixup (struct gdbarch *gdbarch,
409  struct displaced_step_closure *closure,
411  struct regcache *regs);
412 
413 /* Initialize a basic ELF architecture variant. */
414 extern void i386_elf_init_abi (struct gdbarch_info, struct gdbarch *);
415 
416 /* Initialize a SVR4 architecture variant. */
417 extern void i386_svr4_init_abi (struct gdbarch_info, struct gdbarch *);
418 
419 extern int i386_process_record (struct gdbarch *gdbarch,
420  struct regcache *regcache, CORE_ADDR addr);
421 extern const struct target_desc *i386_target_description (uint64_t xcr0);
422 
423 
424 
425 /* Functions and variables exported from i386bsd-tdep.c. */
426 
427 extern void i386bsd_init_abi (struct gdbarch_info, struct gdbarch *);
432 extern int i386fbsd4_sc_reg_offset[];
433 extern int i386fbsd_sc_reg_offset[];
434 extern int i386nbsd_sc_reg_offset[];
435 extern int i386obsd_sc_reg_offset[];
436 extern int i386bsd_sc_reg_offset[];
437 
438 /* SystemTap related functions. */
439 
440 extern int i386_stap_is_single_operand (struct gdbarch *gdbarch,
441  const char *s);
442 
443 extern int i386_stap_parse_special_token (struct gdbarch *gdbarch,
444  struct stap_parse_info *p);
445 
446 #endif /* i386-tdep.h */
int jb_pc_offset
Definition: i386-tdep.h:199
int xsave_xcr0_offset
Definition: i386-tdep.h:142
i386_regnum
Definition: i386-tdep.h:258
int zmm0_regnum
Definition: i386-tdep.h:97
struct type * i386_bnd_type
Definition: i386-tdep.h:228
int xmm16_regnum
Definition: i386-tdep.h:128
int num_core_regs
Definition: i386-tdep.h:119
void i386bsd_init_abi(struct gdbarch_info, struct gdbarch *)
Definition: i386bsd-tdep.c:75
bfd_vma CORE_ADDR
Definition: common-types.h:41
const char ** mpx_register_names
Definition: i386-tdep.h:174
int i386_bnd_regnum_p(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:308
int sc_num_regs
Definition: i386-tdep.h:216
const char ** ymm16h_register_names
Definition: i386-tdep.h:159
int(* i386_intx80_record)(struct regcache *regcache)
Definition: i386-tdep.h:235
CORE_ADDR sigtramp_start
Definition: i386-tdep.h:205
int ymm16_regnum
Definition: i386-tdep.h:134
int i386_k_regnum_p(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:239
void i386_displaced_step_fixup(struct gdbarch *gdbarch, struct displaced_step_closure *closure, CORE_ADDR from, CORE_ADDR to, struct regcache *regs)
Definition: i386-tdep.c:812
struct displaced_step_closure * i386_displaced_step_copy_insn(struct gdbarch *gdbarch, CORE_ADDR from, CORE_ADDR to, struct regcache *regs)
Definition: i386-tdep.c:775
int num_mmx_regs
Definition: i386-tdep.h:72
int i386fbsd_sc_reg_offset[]
int i386_xmm_avx512_regnum_p(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:338
int i386obsd_sc_reg_offset[]
int(* i386_syscall_record)(struct regcache *regcache)
Definition: i386-tdep.h:239
int num_word_regs
Definition: i386-tdep.h:106
CORE_ADDR sigtramp_end
Definition: i386-tdep.h:206
const struct target_desc * i386_target_description(uint64_t xcr0)
Definition: i386-tdep.c:8604
int i386_ymm_regnum_p(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:267
CORE_ADDR(* sigcontext_addr)(struct frame_info *)
Definition: alpha-tdep.h:82
int sc_pc_offset
Definition: alpha-tdep.h:95
struct type * i387_ext_type(struct gdbarch *gdbarch)
Definition: i386-tdep.c:2984
int num_zmm_regs
Definition: i386-tdep.h:93
int ymm0h_regnum
Definition: i386-tdep.h:149
size_t sizeof_fpregset
Definition: i386-tdep.h:64
int i386_xmm_regnum_p(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:323
CORE_ADDR i386_skip_main_prologue(struct gdbarch *gdbarch, CORE_ADDR pc)
Definition: i386-tdep.c:1901
int num_ymm_regs
Definition: i386-tdep.h:79
int i386_byte_regnum_p(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:176
CORE_ADDR i386fbsd_sigtramp_start_addr
int ymm0_regnum
Definition: i386-tdep.h:83
int num_xmm_avx512_regs
Definition: i386-tdep.h:125
struct target_desc * tdesc_i386
Definition: i386.c:8
int i386_dword_regnum_p(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:198
Definition: regset.h:34
struct type * i386_zmm_type
Definition: i386-tdep.h:226
int(* i386_sysenter_record)(struct regcache *regcache)
Definition: i386-tdep.h:237
int i386nbsd_sc_reg_offset[]
Definition: i386nbsd-tdep.c:58
const char *const name
Definition: aarch64-tdep.c:68
int * from
Definition: varobj.h:282
int i386fbsd4_sc_reg_offset[]
const char ** ymmh_register_names
Definition: i386-tdep.h:152
int num_k_regs
Definition: i386-tdep.h:86
struct type * i387_ext_type
Definition: i386-tdep.h:227
struct_return
Definition: arm-tdep.h:148
int num_ymm_avx512_regs
Definition: i386-tdep.h:131
CORE_ADDR i386fbsd_sigtramp_end_addr
Definition: gdbtypes.h:749
struct type * i386_pseudo_register_type(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:3186
const void * register_reggroup_p
Definition: i386-tdep.h:196
int i386_zmmh_regnum_p(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:213
int sc_sp_offset
Definition: i386-tdep.h:221
const char ** zmmh_register_names
Definition: i386-tdep.h:184
int num_byte_regs
Definition: i386-tdep.h:100
int regnum
Definition: aarch64-tdep.c:69
void( iterate_over_regset_sections_cb)(const char *sect_name, int size, const struct regset *regset, const char *human_name, void *cb_data)
Definition: gdbarch.h:98
int i386_zmm_regnum_p(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:226
const char ** xmm_avx512_register_names
Definition: i386-tdep.h:187
const char * i386_pseudo_register_name(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:439
CORE_ADDR i386obsd_sigtramp_start_addr
Definition: value.c:172
int * gregset_reg_offset
Definition: i386-tdep.h:59
int i386_process_record(struct gdbarch *gdbarch, struct regcache *regcache, CORE_ADDR addr)
Definition: i386-tdep.c:4950
int st0_regnum
Definition: i386-tdep.h:69
const char const char int
Definition: command.h:229
bfd_byte gdb_byte
Definition: common-types.h:38
int ymm16h_regnum
Definition: i386-tdep.h:156
int(* sigtramp_p)(struct frame_info *)
Definition: i386-tdep.h:209
struct type * i386_ymm_type
Definition: i386-tdep.h:225
uint64_t xcr0
Definition: i386-tdep.h:139
struct type * i386_mmx_type
Definition: i386-tdep.h:224
const int * record_regmap
Definition: i386-tdep.h:233
int num_xmm_regs
Definition: i386-tdep.h:122
void i386_pseudo_register_write(struct gdbarch *gdbarch, struct regcache *regcache, int regnum, const gdb_byte *buf)
Definition: i386-tdep.c:3448
int i386_ymm_avx512_regnum_p(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:293
size_t sizeof_gregset
Definition: i386-tdep.h:61
int eax_regnum
Definition: i386-tdep.h:116
void i386_elf_init_abi(struct gdbarch_info, struct gdbarch *)
Definition: i386-tdep.c:4332
int i386bsd_sc_reg_offset[]
Definition: i386bsd-tdep.c:54
int i386_stap_is_single_operand(struct gdbarch *gdbarch, const char *s)
Definition: i386-tdep.c:3951
const char ** ymm_avx512_register_names
Definition: i386-tdep.h:190
int i386_stap_parse_special_token(struct gdbarch *gdbarch, struct stap_parse_info *p)
Definition: i386-tdep.c:4271
const struct target_desc * tdesc
Definition: i386-tdep.h:193
const struct regset * fpregset
Definition: i386-tdep.h:242
int i386_word_regnum_p(struct gdbarch *gdbarch, int regnum)
Definition: i386-tdep.c:187
int * sc_reg_offset
Definition: i386-tdep.h:215
CORE_ADDR i386_pe_skip_trampoline_code(struct frame_info *frame, CORE_ADDR pc, char *name)
Definition: i386-tdep.c:3848
CORE_ADDR i386obsd_sigtramp_end_addr
int i386_register_reggroup_p(struct gdbarch *gdbarch, int regnum, struct reggroup *group)
Definition: i386-tdep.c:4437
void i386_svr4_init_abi(struct gdbarch_info, struct gdbarch *)
Definition: i386-tdep.c:4362
int i386_fp_regnum_p(struct gdbarch *, int)
Definition: i386-tdep.c:364
int int * to
Definition: varobj.h:282
void i386_supply_gregset(const struct regset *regset, struct regcache *regcache, int regnum, const void *gregs, size_t len)
Definition: i386-tdep.c:3730
int mm0_regnum
Definition: i386-tdep.h:76
void i386_pseudo_register_read_into_value(struct gdbarch *gdbarch, struct regcache *regcache, int regnum, struct value *result)
Definition: i386-tdep.c:3238
const char ** k_register_names
Definition: i386-tdep.h:181
int k0_regnum
Definition: i386-tdep.h:90
record_i386_regnum
Definition: i386-tdep.h:292
int gregset_num_regs
Definition: i386-tdep.h:60
int bnd0r_regnum
Definition: i386-tdep.h:163
const struct regset i386_fpregset
Definition: i386-tdep.c:3824
const struct regset i386_gregset
Definition: i386-tdep.c:3819
int i386_fpc_regnum_p(struct gdbarch *, int)
Definition: i386-tdep.c:376
int bnd0_regnum
Definition: i386-tdep.h:167
int i386_sigtramp_p(struct frame_info *this_frame)
Definition: i386-tdep.c:3879
int zmm0h_regnum
Definition: i386-tdep.h:178
int num_dword_regs
Definition: i386-tdep.h:112
void i386_iterate_over_regset_sections(struct gdbarch *gdbarch, iterate_over_regset_sections_cb *cb, void *cb_data, const struct regcache *regcache)
Definition: i386-tdep.c:3832
const ULONGEST const LONGEST len
Definition: target.h:309
int bndcfgu_regnum
Definition: i386-tdep.h:171
const char ** register_names
Definition: i386-tdep.h:145