Automatic date update in version.in
[binutils-gdb.git] / gas / config / tc-i386.h
blob7aae7a33dc1478d4893af36d54b72dd7e8cf0ace
1 /* tc-i386.h -- Header file for tc-i386.c
2 Copyright (C) 1989-2024 Free Software Foundation, Inc.
4 This file is part of GAS, the GNU Assembler.
6 GAS is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3, or (at your option)
9 any later version.
11 GAS is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GAS; see the file COPYING. If not, write to the Free
18 Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
19 02110-1301, USA. */
21 #ifndef TC_I386
22 #define TC_I386 1
24 #include "opcodes/i386-opc.h"
26 struct fix;
28 #define TARGET_BYTES_BIG_ENDIAN 0
30 #define TARGET_ARCH (i386_arch ())
31 #define TARGET_MACH (i386_mach ())
32 extern enum bfd_architecture i386_arch (void);
33 extern unsigned long i386_mach (void);
35 #ifdef TE_FreeBSD
36 #define AOUT_TARGET_FORMAT "a.out-i386-freebsd"
37 #endif
38 #ifdef TE_NetBSD
39 #define AOUT_TARGET_FORMAT "a.out-i386-netbsd"
40 #endif
41 #ifdef TE_386BSD
42 #define AOUT_TARGET_FORMAT "a.out-i386-bsd"
43 #endif
44 #ifdef TE_LINUX
45 #define AOUT_TARGET_FORMAT "a.out-i386-linux"
46 #endif
47 #ifdef TE_Mach
48 #define AOUT_TARGET_FORMAT "a.out-mach3"
49 #endif
50 #ifdef TE_DYNIX
51 #define AOUT_TARGET_FORMAT "a.out-i386-dynix"
52 #endif
53 #ifndef AOUT_TARGET_FORMAT
54 #define AOUT_TARGET_FORMAT "a.out-i386"
55 #endif
57 #ifdef TE_FreeBSD
58 #define ELF_TARGET_FORMAT "elf32-i386-freebsd"
59 #define ELF_TARGET_FORMAT64 "elf64-x86-64-freebsd"
60 #elif defined (TE_VXWORKS)
61 #define ELF_TARGET_FORMAT "elf32-i386-vxworks"
62 #elif defined TE_CLOUDABI
63 #define ELF_TARGET_FORMAT64 "elf64-x86-64-cloudabi"
64 #endif
66 #ifdef TE_SOLARIS
67 #define ELF_TARGET_FORMAT "elf32-i386-sol2"
68 #define ELF_TARGET_FORMAT64 "elf64-x86-64-sol2"
69 #endif
71 #ifndef ELF_TARGET_FORMAT
72 #define ELF_TARGET_FORMAT "elf32-i386"
73 #endif
75 #ifndef ELF_TARGET_FORMAT64
76 #define ELF_TARGET_FORMAT64 "elf64-x86-64"
77 #endif
79 #ifndef ELF_TARGET_FORMAT32
80 #define ELF_TARGET_FORMAT32 "elf32-x86-64"
81 #endif
83 #ifndef ELF_TARGET_IAMCU_FORMAT
84 #define ELF_TARGET_IAMCU_FORMAT "elf32-iamcu"
85 #endif
87 #if ((defined (OBJ_MAYBE_COFF) && defined (OBJ_MAYBE_AOUT)) \
88 || defined (OBJ_ELF) || defined (OBJ_MAYBE_ELF) \
89 || defined (TE_PE) || defined (TE_PEP) || defined (OBJ_MACH_O))
90 extern const char *i386_target_format (void);
91 #define TARGET_FORMAT i386_target_format ()
92 #else
93 #ifdef TE_GO32
94 #define TARGET_FORMAT "coff-go32"
95 #endif
96 #ifdef OBJ_AOUT
97 #define TARGET_FORMAT AOUT_TARGET_FORMAT
98 #endif
99 #endif
101 #define SUB_SEGMENT_ALIGN(SEG, FRCHAIN) 0
103 /* '$' may be used as immediate prefix. */
104 #undef LOCAL_LABELS_DOLLAR
105 #define LOCAL_LABELS_DOLLAR 0
106 #undef LOCAL_LABELS_FB
107 #define LOCAL_LABELS_FB 1
109 extern const char extra_symbol_chars[];
110 #define tc_symbol_chars extra_symbol_chars
112 extern const char *i386_comment_chars;
113 #define tc_comment_chars i386_comment_chars
115 /* The name of the global offset table generated by the compiler. Allow
116 this to be overridden if need be. */
117 #ifndef GLOBAL_OFFSET_TABLE_NAME
118 #define GLOBAL_OFFSET_TABLE_NAME "_GLOBAL_OFFSET_TABLE_"
119 #endif
121 #define TC_PARSE_CONS_EXPRESSION(EXP, NBYTES) x86_cons (EXP, NBYTES)
122 extern bfd_reloc_code_real_type x86_cons (expressionS *, int);
124 #define TC_CONS_FIX_NEW(FRAG, OFF, LEN, EXP, RELOC) \
125 x86_cons_fix_new(FRAG, OFF, LEN, EXP, RELOC)
126 extern void x86_cons_fix_new
127 (fragS *, unsigned int, unsigned int, expressionS *, bfd_reloc_code_real_type);
129 #define X_PRECISION 5
130 #define X_PRECISION_PAD 0
132 #define TC_ADDRESS_BYTES x86_address_bytes
133 extern int x86_address_bytes (void);
135 #define DIFF_EXPR_OK /* foo-. gets turned into PC relative relocs */
137 #define NO_RELOC BFD_RELOC_NONE
139 int i386_validate_fix (struct fix *);
140 #define TC_VALIDATE_FIX(FIX,SEGTYPE,SKIP) do { \
141 if (!i386_validate_fix(FIX)) goto SKIP; \
142 } while (0)
144 #if defined (OBJ_ELF) || defined (OBJ_MAYBE_ELF)
145 #define tc_fix_adjustable(X) tc_i386_fix_adjustable(X)
146 extern int tc_i386_fix_adjustable (struct fix *);
147 #else
148 #define tc_fix_adjustable(X) ((void)(X), 1)
149 #endif
151 /* Values passed to md_apply_fix don't include the symbol value. */
152 #define MD_APPLY_SYM_VALUE(FIX) 0
154 /* ELF wants external syms kept, as does PE COFF. */
155 #if defined (TE_PE) && defined (STRICT_PE_FORMAT)
156 #define EXTERN_FORCE_RELOC \
157 (IS_ELF || OUTPUT_FLAVOR == bfd_target_coff_flavour)
158 #else
159 #define EXTERN_FORCE_RELOC IS_ELF
160 #endif
162 /* This expression evaluates to true if the relocation is for a local
163 object for which we still want to do the relocation at runtime.
164 False if we are willing to perform this relocation while building
165 the .o file. GOTOFF and GOT32 do not need to be checked here because
166 they are not pcrel. .*/
168 #define TC_FORCE_RELOCATION_LOCAL(FIX) \
169 (GENERIC_FORCE_RELOCATION_LOCAL (FIX) \
170 || (FIX)->fx_r_type == BFD_RELOC_386_PLT32 \
171 || (FIX)->fx_r_type == BFD_RELOC_386_GOTPC \
172 || (FIX)->fx_r_type == BFD_RELOC_X86_64_GOTPCREL \
173 || (FIX)->fx_r_type == BFD_RELOC_X86_64_GOTPCRELX \
174 || (FIX)->fx_r_type == BFD_RELOC_X86_64_REX_GOTPCRELX \
175 || (FIX)->fx_r_type == BFD_RELOC_X86_64_CODE_4_GOTPCRELX)
177 #define TC_FORCE_RELOCATION_ABS(FIX) \
178 (TC_FORCE_RELOCATION (FIX) \
179 || (FIX)->fx_r_type == BFD_RELOC_386_GOT32 \
180 || (FIX)->fx_r_type == BFD_RELOC_386_GOT32X \
181 || (FIX)->fx_r_type == BFD_RELOC_X86_64_GOTPCREL \
182 || (FIX)->fx_r_type == BFD_RELOC_X86_64_GOTPCRELX \
183 || (FIX)->fx_r_type == BFD_RELOC_X86_64_REX_GOTPCRELX \
184 || (FIX)->fx_r_type == BFD_RELOC_X86_64_CODE_4_GOTPCRELX)
186 extern int i386_parse_name (char *, expressionS *, char *);
187 #define md_parse_name(s, e, m, c) i386_parse_name (s, e, c)
189 extern operatorT i386_operator (const char *name, unsigned int operands, char *);
190 #define md_operator i386_operator
192 extern int i386_need_index_operator (void);
193 #define md_need_index_operator i386_need_index_operator
195 #ifdef BFD64
196 extern bool i386_record_operator
197 (operatorT, const expressionS *, const expressionS *);
198 #define md_optimize_expr(l, o, r) i386_record_operator (o, l, r)
199 #endif
201 #define md_register_arithmetic 0
203 extern const struct relax_type md_relax_table[];
204 #define TC_GENERIC_RELAX_TABLE md_relax_table
206 extern int optimize_align_code;
208 #define md_do_align(n, fill, len, max, around) \
209 if ((n) \
210 && !need_pass_2 \
211 && optimize_align_code \
212 && (!(fill) \
213 || ((char)*(fill) == (char)0x90 && (len) == 1)) \
214 && subseg_text_p (now_seg)) \
216 frag_align_code ((n), (max)); \
217 goto around; \
220 #define MAX_MEM_FOR_RS_ALIGN_CODE \
221 (alignment ? ((size_t) 1 << alignment) - 1 : (size_t) 1)
223 extern void i386_cons_align (int);
224 #define md_cons_align(nbytes) i386_cons_align (nbytes)
226 #if !defined (OBJ_AOUT) && !defined (OBJ_MAYBE_AOUT)
227 #define md_section_align(seg, value) ((void)(seg), (value))
228 #endif
230 void i386_print_statistics (FILE *);
231 #define tc_print_statistics i386_print_statistics
233 void i386_md_end (void);
234 #define md_end i386_md_end
236 extern unsigned int i386_frag_max_var (fragS *);
237 #define md_frag_max_var i386_frag_max_var
239 extern long i386_generic_table_relax_frag (segT, fragS *, long);
240 #define md_generic_table_relax_frag(segment, fragP, stretch) \
241 i386_generic_table_relax_frag (segment, fragP, stretch)
243 #define md_number_to_chars number_to_chars_littleendian
245 enum processor_type
247 PROCESSOR_UNKNOWN,
248 PROCESSOR_GENERIC32,
249 PROCESSOR_GENERIC64,
250 PROCESSOR_I386,
251 PROCESSOR_I486,
252 PROCESSOR_PENTIUM,
253 PROCESSOR_I686,
254 PROCESSOR_PENTIUMPRO,
255 PROCESSOR_PENTIUM4,
256 PROCESSOR_NOCONA,
257 PROCESSOR_CORE,
258 PROCESSOR_CORE2,
259 PROCESSOR_COREI7,
260 PROCESSOR_IAMCU,
261 PROCESSOR_K6,
262 PROCESSOR_ATHLON,
263 PROCESSOR_K8,
264 PROCESSOR_AMDFAM10,
265 PROCESSOR_BD,
266 PROCESSOR_ZNVER,
267 PROCESSOR_BT,
268 /* Keep this last. */
269 PROCESSOR_NONE
272 extern i386_cpu_flags cpu_arch_flags;
273 extern enum processor_type cpu_arch_tune;
274 extern enum processor_type cpu_arch_isa;
275 extern i386_cpu_flags cpu_arch_isa_flags;
277 /* We support four different modes. I386_FLAG_CODE variable is used to
278 distinguish three of these. */
280 extern enum i386_flag_code {
281 CODE_32BIT,
282 CODE_16BIT,
283 CODE_64BIT
284 } i386_flag_code;
286 struct i386_segment_info {
287 /* Type of previous "instruction", e.g. .byte or stand-alone prefix. */
288 struct last_insn {
289 const char *file;
290 const char *name;
291 unsigned int line;
292 enum last_insn_kind
294 last_insn_other = 0,
295 last_insn_directive,
296 last_insn_prefix
297 } kind;
298 } last_insn;
299 subsegT subseg;
300 struct i386_segment_info *next;
303 #define TC_SEGMENT_INFO_TYPE struct i386_segment_info
305 struct i386_tc_frag_data
307 union
309 fragS *padding_fragP;
310 fragS *branch_fragP;
311 } u;
312 addressT padding_address;
313 enum processor_type isa;
314 enum processor_type tune;
315 enum i386_flag_code code;
316 unsigned int max_bytes;
317 unsigned char length;
318 unsigned char last_length;
319 unsigned char max_prefix_length;
320 unsigned char prefix_length;
321 unsigned char default_prefix;
322 unsigned char cmp_size;
323 unsigned int mf_type : 3;
324 unsigned int classified : 1;
325 unsigned int branch_type : 3;
326 unsigned int cpunop : 1;
327 unsigned int isanop : 1;
328 unsigned int last_insn_normal : 1;
331 /* We need to emit the right NOP pattern in .align frags. This is
332 done after the text-to-bits assembly pass, so we need to mark it with
333 the isa/tune settings at the time the .align was assembled. */
334 #define TC_FRAG_TYPE struct i386_tc_frag_data
336 #define TC_FRAG_INIT(FRAGP, MAX_BYTES) \
337 do \
339 (FRAGP)->tc_frag_data.u.padding_fragP = NULL; \
340 (FRAGP)->tc_frag_data.padding_address = 0; \
341 (FRAGP)->tc_frag_data.isa = cpu_arch_isa; \
342 (FRAGP)->tc_frag_data.tune = cpu_arch_tune; \
343 (FRAGP)->tc_frag_data.cpunop = cpu_arch_flags.bitfield.cpunop; \
344 (FRAGP)->tc_frag_data.isanop = cpu_arch_isa_flags.bitfield.cpunop; \
345 (FRAGP)->tc_frag_data.code = i386_flag_code; \
346 (FRAGP)->tc_frag_data.max_bytes = (MAX_BYTES); \
347 (FRAGP)->tc_frag_data.length = 0; \
348 (FRAGP)->tc_frag_data.last_length = 0; \
349 (FRAGP)->tc_frag_data.max_prefix_length = 0; \
350 (FRAGP)->tc_frag_data.prefix_length = 0; \
351 (FRAGP)->tc_frag_data.default_prefix = 0; \
352 (FRAGP)->tc_frag_data.cmp_size = 0; \
353 (FRAGP)->tc_frag_data.classified = 0; \
354 (FRAGP)->tc_frag_data.branch_type = 0; \
355 (FRAGP)->tc_frag_data.mf_type = 0; \
356 (FRAGP)->tc_frag_data.last_insn_normal \
357 = (seg_info(now_seg)->tc_segment_info_data.last_insn.kind \
358 == last_insn_other); \
360 while (0)
362 #define WORKING_DOT_WORD 1
364 /* How to generate NOPs for .nop direct directive. */
365 extern void i386_generate_nops (fragS *, char *, offsetT, int);
366 #define md_generate_nops(frag, where, amount, control) \
367 i386_generate_nops ((frag), (where), (amount), (control))
369 #define HANDLE_ALIGN(fragP) \
370 if (fragP->fr_type == rs_align_code) \
372 offsetT __count = (fragP->fr_next->fr_address \
373 - fragP->fr_address \
374 - fragP->fr_fix); \
375 if (__count > 0 \
376 && (unsigned int) __count <= fragP->tc_frag_data.max_bytes) \
377 md_generate_nops (fragP, fragP->fr_literal + fragP->fr_fix, \
378 __count, 0); \
381 /* We want .cfi_* pseudo-ops for generating unwind info. */
382 #define TARGET_USE_CFIPOP 1
384 extern unsigned int x86_dwarf2_return_column;
385 #define DWARF2_DEFAULT_RETURN_COLUMN x86_dwarf2_return_column
387 extern int x86_cie_data_alignment;
388 #define DWARF2_CIE_DATA_ALIGNMENT x86_cie_data_alignment
390 extern int x86_dwarf2_addr_size (void);
391 #define DWARF2_ADDR_SIZE(bfd) x86_dwarf2_addr_size ()
393 #define tc_parse_to_dw2regnum tc_x86_parse_to_dw2regnum
394 extern void tc_x86_parse_to_dw2regnum (expressionS *);
396 #define tc_cfi_frame_initial_instructions tc_x86_frame_initial_instructions
397 extern void tc_x86_frame_initial_instructions (void);
399 /* DWARF register number of the frame-pointer register in 64-bit mode. */
400 #define REG_FP 6
401 /* DWARF register number of the stack-pointer register in 64-bit mode. */
402 #define REG_SP 7
404 #define md_elf_section_type(str,len) i386_elf_section_type (str, len)
405 extern int i386_elf_section_type (const char *, size_t);
407 #define md_elf_section_change_hook i386_elf_section_change_hook
408 extern void i386_elf_section_change_hook (void);
410 #ifdef TE_SOLARIS
411 #define md_fix_up_eh_frame(sec) i386_solaris_fix_up_eh_frame (sec)
412 extern void i386_solaris_fix_up_eh_frame (segT);
413 #endif
415 /* Support for SHF_X86_64_LARGE */
416 extern bfd_vma x86_64_section_letter (int, const char **);
417 #define md_elf_section_letter(LETTER, PTR_MSG) x86_64_section_letter (LETTER, PTR_MSG)
419 #if defined (OBJ_ELF) || defined (OBJ_MAYBE_ELF)
420 extern void x86_cleanup (void);
421 #define md_cleanup() x86_cleanup ()
423 #define TARGET_USE_GINSN 1
424 /* Allow GAS to synthesize DWARF CFI for hand-written asm.
425 PS: TARGET_USE_CFIPOP is a pre-condition. */
426 #define TARGET_USE_SCFI 1
427 /* Identify the maximum DWARF register number of all the registers being
428 tracked for SCFI. This is the last DWARF register number of the set
429 of SP, BP, and all callee-saved registers. For AMD64, this means
430 R15 (15). Use SCFI_CALLEE_SAVED_REG_P to identify which registers
431 are callee-saved from this set. */
432 #define SCFI_MAX_REG_ID 15
433 /* Some ABIs, like AMD64, use stack for call instruction. For such an ABI,
434 identify the initial (CFA) offset from RSP at the entry of function. */
435 #define SCFI_INIT_CFA_OFFSET 8
437 #define SCFI_CALLEE_SAVED_REG_P(dw2reg) x86_scfi_callee_saved_p (dw2reg)
438 extern bool x86_scfi_callee_saved_p (uint32_t dw2reg_num);
440 /* Whether SFrame stack trace info is supported. */
441 extern bool x86_support_sframe_p (void);
442 #define support_sframe_p x86_support_sframe_p
444 /* The stack-pointer register number for SFrame stack trace info. */
445 extern unsigned int x86_sframe_cfa_sp_reg;
446 #define SFRAME_CFA_SP_REG x86_sframe_cfa_sp_reg
448 /* The frame-pointer register number for SFrame stack trace info. */
449 extern unsigned int x86_sframe_cfa_fp_reg;
450 #define SFRAME_CFA_FP_REG x86_sframe_cfa_fp_reg
452 /* Specify if RA tracking is needed. */
453 extern bool x86_sframe_ra_tracking_p (void);
454 #define sframe_ra_tracking_p x86_sframe_ra_tracking_p
456 /* Specify the fixed offset to recover RA from CFA.
457 (useful only when RA tracking is not needed). */
458 extern offsetT x86_sframe_cfa_ra_offset (void);
459 #define sframe_cfa_ra_offset x86_sframe_cfa_ra_offset
461 /* The abi/arch indentifier for SFrame. */
462 extern unsigned char x86_sframe_get_abi_arch (void);
463 #define sframe_get_abi_arch x86_sframe_get_abi_arch
465 #endif
467 #ifdef TE_PE
469 #define O_secrel O_md1
471 #define TC_DWARF2_EMIT_OFFSET tc_pe_dwarf2_emit_offset
472 void tc_pe_dwarf2_emit_offset (symbolS *, unsigned int);
474 #endif /* TE_PE */
476 /* X_add_symbol:X_op_symbol (Intel mode only) */
477 #define O_full_ptr O_md2
479 #ifdef OBJ_MACH_O
481 #define TC_FORCE_RELOCATION(FIX) (obj_mach_o_force_reloc (FIX))
483 #define TC_FORCE_RELOCATION_SUB_SAME(FIX,SEG) \
484 (obj_mach_o_force_reloc_sub_same (FIX, SEG))
486 #define TC_FORCE_RELOCATION_SUB_LOCAL(FIX,SEG) \
487 (obj_mach_o_force_reloc_sub_local (FIX, SEG))
489 #define TC_VALIDATE_FIX_SUB(FIX, SEG) 1
491 #endif /* OBJ_MACH_O */
493 #endif /* TC_I386 */