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