]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gas/config/tc-i386.h
2005-05-05 Paul Brook <paul@codesourcery.com>
[thirdparty/binutils-gdb.git] / gas / config / tc-i386.h
1 /* tc-i386.h -- Header file for tc-i386.c
2 Copyright 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004
4 Free Software Foundation, Inc.
5
6 This file is part of GAS, the GNU Assembler.
7
8 GAS is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
12
13 GAS is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GAS; see the file COPYING. If not, write to the Free
20 Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
21 02110-1301, USA. */
22
23 #ifndef TC_I386
24 #define TC_I386 1
25
26 #ifndef BFD_ASSEMBLER
27 #error So, do you know what you are doing?
28 #endif
29
30 #ifdef ANSI_PROTOTYPES
31 struct fix;
32 #endif
33
34 #define TARGET_BYTES_BIG_ENDIAN 0
35
36 #define TARGET_ARCH bfd_arch_i386
37 #define TARGET_MACH (i386_mach ())
38 extern unsigned long i386_mach (void);
39
40 #ifdef TE_FreeBSD
41 #define AOUT_TARGET_FORMAT "a.out-i386-freebsd"
42 #endif
43 #ifdef TE_NetBSD
44 #define AOUT_TARGET_FORMAT "a.out-i386-netbsd"
45 #endif
46 #ifdef TE_386BSD
47 #define AOUT_TARGET_FORMAT "a.out-i386-bsd"
48 #endif
49 #ifdef TE_LINUX
50 #define AOUT_TARGET_FORMAT "a.out-i386-linux"
51 #endif
52 #ifdef TE_Mach
53 #define AOUT_TARGET_FORMAT "a.out-mach3"
54 #endif
55 #ifdef TE_DYNIX
56 #define AOUT_TARGET_FORMAT "a.out-i386-dynix"
57 #endif
58 #ifndef AOUT_TARGET_FORMAT
59 #define AOUT_TARGET_FORMAT "a.out-i386"
60 #endif
61
62 #ifdef TE_FreeBSD
63 #define ELF_TARGET_FORMAT "elf32-i386-freebsd"
64 #elif defined (TE_VXWORKS)
65 #define ELF_TARGET_FORMAT "elf32-i386-vxworks"
66 #endif
67
68 #ifndef ELF_TARGET_FORMAT
69 #define ELF_TARGET_FORMAT "elf32-i386"
70 #endif
71
72 #if ((defined (OBJ_MAYBE_COFF) && defined (OBJ_MAYBE_AOUT)) \
73 || defined (OBJ_ELF) || defined (OBJ_MAYBE_ELF))
74 extern const char *i386_target_format PARAMS ((void));
75 #define TARGET_FORMAT i386_target_format ()
76 #else
77 #ifdef OBJ_ELF
78 #define TARGET_FORMAT ELF_TARGET_FORMAT
79 #endif
80 #ifdef OBJ_AOUT
81 #define TARGET_FORMAT AOUT_TARGET_FORMAT
82 #endif
83 #endif
84
85 #if (defined (OBJ_MAYBE_ELF) || defined (OBJ_ELF))
86 #define md_end i386_elf_emit_arch_note
87 extern void i386_elf_emit_arch_note PARAMS ((void));
88 #endif
89
90 #define SUB_SEGMENT_ALIGN(SEG, FRCHAIN) 0
91
92 #define LOCAL_LABELS_FB 1
93
94 extern const char extra_symbol_chars[];
95 #define tc_symbol_chars extra_symbol_chars
96
97 #define MAX_OPERANDS 3 /* max operands per insn */
98 #define MAX_IMMEDIATE_OPERANDS 2/* max immediates per insn (lcall, ljmp) */
99 #define MAX_MEMORY_OPERANDS 2 /* max memory refs per insn (string ops) */
100
101 /* Prefixes will be emitted in the order defined below.
102 WAIT_PREFIX must be the first prefix since FWAIT is really is an
103 instruction, and so must come before any prefixes. */
104 #define WAIT_PREFIX 0
105 #define LOCKREP_PREFIX 1
106 #define ADDR_PREFIX 2
107 #define DATA_PREFIX 3
108 #define SEG_PREFIX 4
109 #define REX_PREFIX 5 /* must come last. */
110 #define MAX_PREFIXES 6 /* max prefixes per opcode */
111
112 /* we define the syntax here (modulo base,index,scale syntax) */
113 #define REGISTER_PREFIX '%'
114 #define IMMEDIATE_PREFIX '$'
115 #define ABSOLUTE_PREFIX '*'
116
117 #define TWO_BYTE_OPCODE_ESCAPE 0x0f
118 #define NOP_OPCODE (char) 0x90
119
120 /* register numbers */
121 #define EBP_REG_NUM 5
122 #define ESP_REG_NUM 4
123
124 /* modrm_byte.regmem for twobyte escape */
125 #define ESCAPE_TO_TWO_BYTE_ADDRESSING ESP_REG_NUM
126 /* index_base_byte.index for no index register addressing */
127 #define NO_INDEX_REGISTER ESP_REG_NUM
128 /* index_base_byte.base for no base register addressing */
129 #define NO_BASE_REGISTER EBP_REG_NUM
130 #define NO_BASE_REGISTER_16 6
131
132 /* these are the instruction mnemonic suffixes. */
133 #define WORD_MNEM_SUFFIX 'w'
134 #define BYTE_MNEM_SUFFIX 'b'
135 #define SHORT_MNEM_SUFFIX 's'
136 #define LONG_MNEM_SUFFIX 'l'
137 #define QWORD_MNEM_SUFFIX 'q'
138 /* Intel Syntax */
139 #define LONG_DOUBLE_MNEM_SUFFIX 'x'
140
141 /* modrm.mode = REGMEM_FIELD_HAS_REG when a register is in there */
142 #define REGMEM_FIELD_HAS_REG 0x3/* always = 0x3 */
143 #define REGMEM_FIELD_HAS_MEM (~REGMEM_FIELD_HAS_REG)
144
145 #define END_OF_INSN '\0'
146
147 typedef struct
148 {
149 /* instruction name sans width suffix ("mov" for movl insns) */
150 char *name;
151
152 /* how many operands */
153 unsigned int operands;
154
155 /* base_opcode is the fundamental opcode byte without optional
156 prefix(es). */
157 unsigned int base_opcode;
158
159 /* extension_opcode is the 3 bit extension for group <n> insns.
160 This field is also used to store the 8-bit opcode suffix for the
161 AMD 3DNow! instructions.
162 If this template has no extension opcode (the usual case) use None */
163 unsigned int extension_opcode;
164 #define None 0xffff /* If no extension_opcode is possible. */
165
166 /* cpu feature flags */
167 unsigned int cpu_flags;
168 #define Cpu086 0x1 /* Any old cpu will do, 0 does the same */
169 #define Cpu186 0x2 /* i186 or better required */
170 #define Cpu286 0x4 /* i286 or better required */
171 #define Cpu386 0x8 /* i386 or better required */
172 #define Cpu486 0x10 /* i486 or better required */
173 #define Cpu586 0x20 /* i585 or better required */
174 #define Cpu686 0x40 /* i686 or better required */
175 #define CpuP4 0x80 /* Pentium4 or better required */
176 #define CpuK6 0x100 /* AMD K6 or better required*/
177 #define CpuAthlon 0x200 /* AMD Athlon or better required*/
178 #define CpuSledgehammer 0x400 /* Sledgehammer or better required */
179 #define CpuMMX 0x800 /* MMX support required */
180 #define CpuMMX2 0x1000 /* extended MMX support (with SSE or 3DNow!Ext) required */
181 #define CpuSSE 0x2000 /* Streaming SIMD extensions required */
182 #define CpuSSE2 0x4000 /* Streaming SIMD extensions 2 required */
183 #define Cpu3dnow 0x8000 /* 3dnow! support required */
184 #define Cpu3dnowA 0x10000 /* 3dnow!Extensions support required */
185 #define CpuPNI 0x20000 /* Prescott New Instructions required */
186 #define CpuPadLock 0x40000 /* VIA PadLock required */
187
188 /* These flags are set by gas depending on the flag_code. */
189 #define Cpu64 0x4000000 /* 64bit support required */
190 #define CpuNo64 0x8000000 /* Not supported in the 64bit mode */
191
192 /* The default value for unknown CPUs - enable all features to avoid problems. */
193 #define CpuUnknownFlags (Cpu086|Cpu186|Cpu286|Cpu386|Cpu486|Cpu586|Cpu686|CpuP4|CpuSledgehammer|CpuMMX|CpuMMX2|CpuSSE|CpuSSE2|CpuPNI|Cpu3dnow|Cpu3dnowA|CpuK6|CpuAthlon|CpuPadLock)
194
195 /* the bits in opcode_modifier are used to generate the final opcode from
196 the base_opcode. These bits also are used to detect alternate forms of
197 the same instruction */
198 unsigned int opcode_modifier;
199
200 /* opcode_modifier bits: */
201 #define W 0x1 /* set if operands can be words or dwords
202 encoded the canonical way */
203 #define D 0x2 /* D = 0 if Reg --> Regmem;
204 D = 1 if Regmem --> Reg: MUST BE 0x2 */
205 #define Modrm 0x4
206 #define FloatR 0x8 /* src/dest swap for floats: MUST BE 0x8 */
207 #define ShortForm 0x10 /* register is in low 3 bits of opcode */
208 #define FloatMF 0x20 /* FP insn memory format bit, sized by 0x4 */
209 #define Jump 0x40 /* special case for jump insns. */
210 #define JumpDword 0x80 /* call and jump */
211 #define JumpByte 0x100 /* loop and jecxz */
212 #define JumpInterSegment 0x200 /* special case for intersegment leaps/calls */
213 #define FloatD 0x400 /* direction for float insns: MUST BE 0x400 */
214 #define Seg2ShortForm 0x800 /* encoding of load segment reg insns */
215 #define Seg3ShortForm 0x1000 /* fs/gs segment register insns. */
216 #define Size16 0x2000 /* needs size prefix if in 32-bit mode */
217 #define Size32 0x4000 /* needs size prefix if in 16-bit mode */
218 #define Size64 0x8000 /* needs size prefix if in 16-bit mode */
219 #define IgnoreSize 0x10000 /* instruction ignores operand size prefix */
220 #define DefaultSize 0x20000 /* default insn size depends on mode */
221 #define No_bSuf 0x40000 /* b suffix on instruction illegal */
222 #define No_wSuf 0x80000 /* w suffix on instruction illegal */
223 #define No_lSuf 0x100000 /* l suffix on instruction illegal */
224 #define No_sSuf 0x200000 /* s suffix on instruction illegal */
225 #define No_qSuf 0x400000 /* q suffix on instruction illegal */
226 #define No_xSuf 0x800000 /* x suffix on instruction illegal */
227 #define FWait 0x1000000 /* instruction needs FWAIT */
228 #define IsString 0x2000000 /* quick test for string instructions */
229 #define regKludge 0x4000000 /* fake an extra reg operand for clr, imul */
230 #define IsPrefix 0x8000000 /* opcode is a prefix */
231 #define ImmExt 0x10000000 /* instruction has extension in 8 bit imm */
232 #define NoRex64 0x20000000 /* instruction don't need Rex64 prefix. */
233 #define Rex64 0x40000000 /* instruction require Rex64 prefix. */
234 #define Ugh 0x80000000 /* deprecated fp insn, gets a warning */
235
236 /* operand_types[i] describes the type of operand i. This is made
237 by OR'ing together all of the possible type masks. (e.g.
238 'operand_types[i] = Reg|Imm' specifies that operand i can be
239 either a register or an immediate operand. */
240 unsigned int operand_types[3];
241
242 /* operand_types[i] bits */
243 /* register */
244 #define Reg8 0x1 /* 8 bit reg */
245 #define Reg16 0x2 /* 16 bit reg */
246 #define Reg32 0x4 /* 32 bit reg */
247 #define Reg64 0x8 /* 64 bit reg */
248 /* immediate */
249 #define Imm8 0x10 /* 8 bit immediate */
250 #define Imm8S 0x20 /* 8 bit immediate sign extended */
251 #define Imm16 0x40 /* 16 bit immediate */
252 #define Imm32 0x80 /* 32 bit immediate */
253 #define Imm32S 0x100 /* 32 bit immediate sign extended */
254 #define Imm64 0x200 /* 64 bit immediate */
255 #define Imm1 0x400 /* 1 bit immediate */
256 /* memory */
257 #define BaseIndex 0x800
258 /* Disp8,16,32 are used in different ways, depending on the
259 instruction. For jumps, they specify the size of the PC relative
260 displacement, for baseindex type instructions, they specify the
261 size of the offset relative to the base register, and for memory
262 offset instructions such as `mov 1234,%al' they specify the size of
263 the offset relative to the segment base. */
264 #define Disp8 0x1000 /* 8 bit displacement */
265 #define Disp16 0x2000 /* 16 bit displacement */
266 #define Disp32 0x4000 /* 32 bit displacement */
267 #define Disp32S 0x8000 /* 32 bit signed displacement */
268 #define Disp64 0x10000 /* 64 bit displacement */
269 /* specials */
270 #define InOutPortReg 0x20000 /* register to hold in/out port addr = dx */
271 #define ShiftCount 0x40000 /* register to hold shift cound = cl */
272 #define Control 0x80000 /* Control register */
273 #define Debug 0x100000 /* Debug register */
274 #define Test 0x200000 /* Test register */
275 #define FloatReg 0x400000 /* Float register */
276 #define FloatAcc 0x800000 /* Float stack top %st(0) */
277 #define SReg2 0x1000000 /* 2 bit segment register */
278 #define SReg3 0x2000000 /* 3 bit segment register */
279 #define Acc 0x4000000 /* Accumulator %al or %ax or %eax */
280 #define JumpAbsolute 0x8000000
281 #define RegMMX 0x10000000 /* MMX register */
282 #define RegXMM 0x20000000 /* XMM registers in PIII */
283 #define EsSeg 0x40000000 /* String insn operand with fixed es segment */
284
285 /* InvMem is for instructions with a modrm byte that only allow a
286 general register encoding in the i.tm.mode and i.tm.regmem fields,
287 eg. control reg moves. They really ought to support a memory form,
288 but don't, so we add an InvMem flag to the register operand to
289 indicate that it should be encoded in the i.tm.regmem field. */
290 #define InvMem 0x80000000
291
292 #define Reg (Reg8|Reg16|Reg32|Reg64) /* gen'l register */
293 #define WordReg (Reg16|Reg32|Reg64)
294 #define ImplicitRegister (InOutPortReg|ShiftCount|Acc|FloatAcc)
295 #define Imm (Imm8|Imm8S|Imm16|Imm32S|Imm32|Imm64) /* gen'l immediate */
296 #define EncImm (Imm8|Imm16|Imm32|Imm32S) /* Encodable gen'l immediate */
297 #define Disp (Disp8|Disp16|Disp32|Disp32S|Disp64) /* General displacement */
298 #define AnyMem (Disp8|Disp16|Disp32|Disp32S|BaseIndex|InvMem) /* General memory */
299 /* The following aliases are defined because the opcode table
300 carefully specifies the allowed memory types for each instruction.
301 At the moment we can only tell a memory reference size by the
302 instruction suffix, so there's not much point in defining Mem8,
303 Mem16, Mem32 and Mem64 opcode modifiers - We might as well just use
304 the suffix directly to check memory operands. */
305 #define LLongMem AnyMem /* 64 bits (or more) */
306 #define LongMem AnyMem /* 32 bit memory ref */
307 #define ShortMem AnyMem /* 16 bit memory ref */
308 #define WordMem AnyMem /* 16 or 32 bit memory ref */
309 #define ByteMem AnyMem /* 8 bit memory ref */
310 }
311 template;
312
313 /*
314 'templates' is for grouping together 'template' structures for opcodes
315 of the same name. This is only used for storing the insns in the grand
316 ole hash table of insns.
317 The templates themselves start at START and range up to (but not including)
318 END.
319 */
320 typedef struct
321 {
322 const template *start;
323 const template *end;
324 }
325 templates;
326
327 /* these are for register name --> number & type hash lookup */
328 typedef struct
329 {
330 char *reg_name;
331 unsigned int reg_type;
332 unsigned int reg_flags;
333 #define RegRex 0x1 /* Extended register. */
334 #define RegRex64 0x2 /* Extended 8 bit register. */
335 unsigned int reg_num;
336 }
337 reg_entry;
338
339 typedef struct
340 {
341 char *seg_name;
342 unsigned int seg_prefix;
343 }
344 seg_entry;
345
346 /* 386 operand encoding bytes: see 386 book for details of this. */
347 typedef struct
348 {
349 unsigned int regmem; /* codes register or memory operand */
350 unsigned int reg; /* codes register operand (or extended opcode) */
351 unsigned int mode; /* how to interpret regmem & reg */
352 }
353 modrm_byte;
354
355 /* x86-64 extension prefix. */
356 typedef int rex_byte;
357 #define REX_OPCODE 0x40
358
359 /* Indicates 64 bit operand size. */
360 #define REX_MODE64 8
361 /* High extension to reg field of modrm byte. */
362 #define REX_EXTX 4
363 /* High extension to SIB index field. */
364 #define REX_EXTY 2
365 /* High extension to base field of modrm or SIB, or reg field of opcode. */
366 #define REX_EXTZ 1
367
368 /* 386 opcode byte to code indirect addressing. */
369 typedef struct
370 {
371 unsigned base;
372 unsigned index;
373 unsigned scale;
374 }
375 sib_byte;
376
377 /* x86 arch names and features */
378 typedef struct
379 {
380 const char *name; /* arch name */
381 unsigned int flags; /* cpu feature flags */
382 }
383 arch_entry;
384
385 /* The name of the global offset table generated by the compiler. Allow
386 this to be overridden if need be. */
387 #ifndef GLOBAL_OFFSET_TABLE_NAME
388 #define GLOBAL_OFFSET_TABLE_NAME "_GLOBAL_OFFSET_TABLE_"
389 #endif
390
391 #ifndef LEX_AT
392 #define TC_PARSE_CONS_EXPRESSION(EXP, NBYTES) x86_cons (EXP, NBYTES)
393 extern void x86_cons PARAMS ((expressionS *, int));
394
395 #define TC_CONS_FIX_NEW(FRAG,OFF,LEN,EXP) x86_cons_fix_new(FRAG, OFF, LEN, EXP)
396 extern void x86_cons_fix_new
397 PARAMS ((fragS *, unsigned int, unsigned int, expressionS *));
398 #endif
399
400 #ifdef TE_PE
401 #define TC_CONS_FIX_NEW(FRAG,OFF,LEN,EXP) x86_pe_cons_fix_new(FRAG, OFF, LEN, EXP)
402 extern void x86_pe_cons_fix_new
403 PARAMS ((fragS *, unsigned int, unsigned int, expressionS *));
404 #endif
405
406 #define DIFF_EXPR_OK /* foo-. gets turned into PC relative relocs */
407
408 #define NO_RELOC BFD_RELOC_NONE
409
410 void i386_validate_fix PARAMS ((struct fix *));
411 #define TC_VALIDATE_FIX(FIX,SEGTYPE,SKIP) i386_validate_fix(FIX)
412
413 #define tc_fix_adjustable(X) tc_i386_fix_adjustable(X)
414 extern int tc_i386_fix_adjustable PARAMS ((struct fix *));
415
416 /* Values passed to md_apply_fix3 don't include the symbol value. */
417 #define MD_APPLY_SYM_VALUE(FIX) 0
418
419 /* ELF wants external syms kept, as does PE COFF. */
420 #if defined (TE_PE) && defined (STRICT_PE_FORMAT)
421 #define EXTERN_FORCE_RELOC \
422 (OUTPUT_FLAVOR == bfd_target_elf_flavour \
423 || OUTPUT_FLAVOR == bfd_target_coff_flavour)
424 #else
425 #define EXTERN_FORCE_RELOC \
426 (OUTPUT_FLAVOR == bfd_target_elf_flavour)
427 #endif
428
429 /* This expression evaluates to true if the relocation is for a local
430 object for which we still want to do the relocation at runtime.
431 False if we are willing to perform this relocation while building
432 the .o file. GOTOFF does not need to be checked here because it is
433 not pcrel. I am not sure if some of the others are ever used with
434 pcrel, but it is easier to be safe than sorry. */
435
436 #define TC_FORCE_RELOCATION_LOCAL(FIX) \
437 (!(FIX)->fx_pcrel \
438 || (FIX)->fx_plt \
439 || (FIX)->fx_r_type == BFD_RELOC_386_PLT32 \
440 || (FIX)->fx_r_type == BFD_RELOC_386_GOT32 \
441 || (FIX)->fx_r_type == BFD_RELOC_386_GOTPC \
442 || TC_FORCE_RELOCATION (FIX))
443
444 #define md_operand(x)
445
446 extern const struct relax_type md_relax_table[];
447 #define TC_GENERIC_RELAX_TABLE md_relax_table
448
449 extern int optimize_align_code;
450
451 #define md_do_align(n, fill, len, max, around) \
452 if ((n) \
453 && !need_pass_2 \
454 && optimize_align_code \
455 && (!(fill) \
456 || ((char)*(fill) == (char)0x90 && (len) == 1)) \
457 && subseg_text_p (now_seg)) \
458 { \
459 frag_align_code ((n), (max)); \
460 goto around; \
461 }
462
463 #define MAX_MEM_FOR_RS_ALIGN_CODE 15
464
465 extern void i386_align_code PARAMS ((fragS *, int));
466
467 #define HANDLE_ALIGN(fragP) \
468 if (fragP->fr_type == rs_align_code) \
469 i386_align_code (fragP, (fragP->fr_next->fr_address \
470 - fragP->fr_address \
471 - fragP->fr_fix));
472
473 void i386_print_statistics PARAMS ((FILE *));
474 #define tc_print_statistics i386_print_statistics
475
476 #define md_number_to_chars number_to_chars_littleendian
477
478 #ifdef SCO_ELF
479 #define tc_init_after_args() sco_id ()
480 extern void sco_id PARAMS ((void));
481 #endif
482
483 /* We want .cfi_* pseudo-ops for generating unwind info. */
484 #define TARGET_USE_CFIPOP 1
485
486 extern unsigned int x86_dwarf2_return_column;
487 #define DWARF2_DEFAULT_RETURN_COLUMN x86_dwarf2_return_column
488
489 extern int x86_cie_data_alignment;
490 #define DWARF2_CIE_DATA_ALIGNMENT x86_cie_data_alignment
491
492 #define tc_regname_to_dw2regnum tc_x86_regname_to_dw2regnum
493 extern int tc_x86_regname_to_dw2regnum PARAMS ((const char *regname));
494
495 #define tc_cfi_frame_initial_instructions tc_x86_frame_initial_instructions
496 extern void tc_x86_frame_initial_instructions PARAMS ((void));
497
498 #define md_elf_section_type(str,len) i386_elf_section_type (str, len)
499 extern int i386_elf_section_type PARAMS ((const char *, size_t len));
500
501 #ifdef TE_PE
502
503 #define O_secrel O_md1
504
505 #define TC_DWARF2_EMIT_OFFSET tc_pe_dwarf2_emit_offset
506 void tc_pe_dwarf2_emit_offset (symbolS *, unsigned int);
507
508 #endif /* TE_PE */
509
510 #endif /* TC_I386 */