1d830ee9b4e417b166bc52bbac3ca1312bf76b46
[external/binutils.git] / gas / config / tc-i386.h
1 /* tc-i386.h -- Header file for tc-i386.c
2    Copyright (C) 1989, 92, 93, 94, 95, 96, 97, 98, 99, 2000
3    Free Software Foundation.
4
5    This file is part of GAS, the GNU Assembler.
6
7    GAS 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 2, or (at your option)
10    any later version.
11
12    GAS 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 GAS; see the file COPYING.  If not, write to the Free
19    Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20    02111-1307, USA.  */
21
22 #ifndef TC_I386
23 #define TC_I386 1
24
25 #ifdef ANSI_PROTOTYPES
26 struct fix;
27 #endif
28
29 #define TARGET_BYTES_BIG_ENDIAN 0
30
31 #ifdef TE_LYNX
32 #define TARGET_FORMAT           "coff-i386-lynx"
33 #endif
34
35 #ifdef BFD_ASSEMBLER
36 /* This is used to determine relocation types in tc-i386.c.  The first
37    parameter is the current relocation type, the second one is the desired
38    type.  The idea is that if the original type is already some kind of PIC
39    relocation, we leave it alone, otherwise we give it the desired type */
40
41 #define tc_fix_adjustable(X)  tc_i386_fix_adjustable(X)
42 extern int tc_i386_fix_adjustable PARAMS ((struct fix *));
43
44 /* This is the relocation type for direct references to GLOBAL_OFFSET_TABLE.
45  * It comes up in complicated expressions such as 
46  * _GLOBAL_OFFSET_TABLE_+[.-.L284], which cannot be expressed normally with
47  * the regular expressions.  The fixup specified here when used at runtime 
48  * implies that we should add the address of the GOT to the specified location,
49  * and as a result we have simplified the expression into something we can use.
50  */
51 #define TC_RELOC_GLOBAL_OFFSET_TABLE BFD_RELOC_386_GOTPC
52
53 /* This expression evaluates to false if the relocation is for a local object
54    for which we still want to do the relocation at runtime.  True if we
55    are willing to perform this relocation while building the .o file.
56    This is only used for pcrel relocations, so GOTOFF does not need to be
57    checked here.  I am not sure if some of the others are ever used with
58    pcrel, but it is easier to be safe than sorry. */
59
60 #define TC_RELOC_RTSYM_LOC_FIXUP(FIX)                           \
61   ((FIX)->fx_r_type != BFD_RELOC_386_PLT32                      \
62    && (FIX)->fx_r_type != BFD_RELOC_386_GOT32                   \
63    && (FIX)->fx_r_type != BFD_RELOC_386_GOTPC                   \
64    && ((FIX)->fx_addsy == NULL                                  \
65        || (! S_IS_EXTERNAL ((FIX)->fx_addsy)                    \
66            && ! S_IS_WEAK ((FIX)->fx_addsy)                     \
67            && S_IS_DEFINED ((FIX)->fx_addsy)                    \
68            && ! S_IS_COMMON ((FIX)->fx_addsy))))
69
70 #define TARGET_ARCH             bfd_arch_i386
71
72 #ifdef TE_NetBSD
73 #define AOUT_TARGET_FORMAT      "a.out-i386-netbsd"
74 #endif
75 #ifdef TE_386BSD
76 #define AOUT_TARGET_FORMAT      "a.out-i386-bsd"
77 #endif
78 #ifdef TE_LINUX
79 #define AOUT_TARGET_FORMAT      "a.out-i386-linux"
80 #endif
81 #ifdef TE_Mach
82 #define AOUT_TARGET_FORMAT      "a.out-mach3"
83 #endif
84 #ifdef TE_DYNIX
85 #define AOUT_TARGET_FORMAT      "a.out-i386-dynix"
86 #endif
87 #ifndef AOUT_TARGET_FORMAT
88 #define AOUT_TARGET_FORMAT      "a.out-i386"
89 #endif
90
91 #if ((defined (OBJ_MAYBE_ELF) && defined (OBJ_MAYBE_COFF)) \
92      || (defined (OBJ_MAYBE_ELF) && defined (OBJ_MAYBE_AOUT)) \
93      || (defined (OBJ_MAYBE_COFF) && defined (OBJ_MAYBE_AOUT)))
94 extern const char *i386_target_format PARAMS ((void));
95 #define TARGET_FORMAT i386_target_format ()
96 #else
97 #ifdef OBJ_ELF
98 #define TARGET_FORMAT           "elf32-i386"
99 #endif
100 #ifdef OBJ_AOUT
101 #define TARGET_FORMAT           AOUT_TARGET_FORMAT
102 #endif
103 #endif
104
105 #else /* ! BFD_ASSEMBLER */
106
107 /* COFF STUFF */
108
109 #define COFF_MAGIC I386MAGIC
110 #define BFD_ARCH bfd_arch_i386
111 #define COFF_FLAGS F_AR32WR
112 #define TC_COUNT_RELOC(x) ((x)->fx_addsy || (x)->fx_r_type==7)
113 #define TC_COFF_FIX2RTYPE(fixP) tc_coff_fix2rtype(fixP)
114 extern short tc_coff_fix2rtype PARAMS ((struct fix *));
115 #define TC_COFF_SIZEMACHDEP(frag) tc_coff_sizemachdep(frag)
116 extern int tc_coff_sizemachdep PARAMS ((fragS *frag));
117
118 #ifdef TE_GO32
119 /* DJGPP now expects some sections to be 2**4 aligned.  */
120 #define SUB_SEGMENT_ALIGN(SEG)                                          \
121   ((strcmp (obj_segment_name (SEG), ".text") == 0                       \
122     || strcmp (obj_segment_name (SEG), ".data") == 0                    \
123     || strncmp (obj_segment_name (SEG), ".gnu.linkonce.t", 15) == 0     \
124     || strncmp (obj_segment_name (SEG), ".gnu.linkonce.d", 15) == 0     \
125     || strncmp (obj_segment_name (SEG), ".gnu.linkonce.r", 15) == 0)    \
126    ? 4                                                                  \
127    : 2)
128 #else
129 #define SUB_SEGMENT_ALIGN(SEG) 2
130 #endif
131
132 #define TC_RVA_RELOC 7
133 /* Need this for PIC relocations */
134 #define NEED_FX_R_TYPE
135
136
137 #ifdef TE_386BSD
138 /* The BSDI linker apparently rejects objects with a machine type of
139    M_386 (100).  */
140 #define AOUT_MACHTYPE 0
141 #else
142 #define AOUT_MACHTYPE 100
143 #endif
144
145 #undef REVERSE_SORT_RELOCS
146
147 #endif /* ! BFD_ASSEMBLER */
148
149 #define TC_FORCE_RELOCATION(fixp) tc_i386_force_relocation(fixp)
150 extern int tc_i386_force_relocation PARAMS ((struct fix *));
151
152 #ifdef BFD_ASSEMBLER
153 #define NO_RELOC BFD_RELOC_NONE
154 #else
155 #define NO_RELOC 0
156 #endif
157 #define tc_coff_symbol_emit_hook(a)     ;       /* not used */
158
159 #ifndef BFD_ASSEMBLER
160 #ifndef OBJ_AOUT
161 #ifndef TE_PE
162 #ifndef TE_GO32
163 /* Local labels starts with .L */
164 #define LOCAL_LABEL(name) (name[0] == '.' \
165                  && (name[1] == 'L' || name[1] == 'X' || name[1] == '.'))
166 #endif
167 #endif
168 #endif
169 #endif
170
171 #define LOCAL_LABELS_FB 1
172
173 #define tc_aout_pre_write_hook(x)       {;}     /* not used */
174 #define tc_crawl_symbol_chain(a)        {;}     /* not used */
175 #define tc_headers_hook(a)              {;}     /* not used */
176
177 extern const char extra_symbol_chars[];
178 #define tc_symbol_chars extra_symbol_chars
179
180 #define MAX_OPERANDS 3          /* max operands per insn */
181 #define MAX_IMMEDIATE_OPERANDS 2/* max immediates per insn (lcall, ljmp) */
182 #define MAX_MEMORY_OPERANDS 2   /* max memory refs per insn (string ops) */
183
184 /* Prefixes will be emitted in the order defined below.
185    WAIT_PREFIX must be the first prefix since FWAIT is really is an
186    instruction, and so must come before any prefixes. */
187 #define WAIT_PREFIX     0
188 #define LOCKREP_PREFIX  1
189 #define ADDR_PREFIX     2
190 #define DATA_PREFIX     3
191 #define SEG_PREFIX      4
192 #define MAX_PREFIXES    5       /* max prefixes per opcode */
193
194 /* we define the syntax here (modulo base,index,scale syntax) */
195 #define REGISTER_PREFIX '%'
196 #define IMMEDIATE_PREFIX '$'
197 #define ABSOLUTE_PREFIX '*'
198
199 #define TWO_BYTE_OPCODE_ESCAPE 0x0f
200 #define NOP_OPCODE (char) 0x90
201
202 /* register numbers */
203 #define EBP_REG_NUM 5
204 #define ESP_REG_NUM 4
205
206 /* modrm_byte.regmem for twobyte escape */
207 #define ESCAPE_TO_TWO_BYTE_ADDRESSING ESP_REG_NUM
208 /* index_base_byte.index for no index register addressing */
209 #define NO_INDEX_REGISTER ESP_REG_NUM
210 /* index_base_byte.base for no base register addressing */
211 #define NO_BASE_REGISTER EBP_REG_NUM
212 #define NO_BASE_REGISTER_16 6
213
214 /* these are the instruction mnemonic suffixes.  */
215 #define WORD_MNEM_SUFFIX  'w'
216 #define BYTE_MNEM_SUFFIX  'b'
217 #define SHORT_MNEM_SUFFIX 's'
218 #define LONG_MNEM_SUFFIX  'l'
219 /* Intel Syntax */
220 #define LONG_DOUBLE_MNEM_SUFFIX 'x'
221 /* Intel Syntax */
222 #define DWORD_MNEM_SUFFIX 'd'
223
224 /* modrm.mode = REGMEM_FIELD_HAS_REG when a register is in there */
225 #define REGMEM_FIELD_HAS_REG 0x3/* always = 0x3 */
226 #define REGMEM_FIELD_HAS_MEM (~REGMEM_FIELD_HAS_REG)
227
228 #define END_OF_INSN '\0'
229
230 /* Intel Syntax */
231 /* Values 0-4 map onto scale factor */
232 #define BYTE_PTR     0
233 #define WORD_PTR     1
234 #define DWORD_PTR    2
235 #define QWORD_PTR    3
236 #define XWORD_PTR    4
237 #define SHORT        5
238 #define OFFSET_FLAT  6
239 #define FLAT         7
240 #define NONE_FOUND   8
241 /*
242   When an operand is read in it is classified by its type.  This type includes
243   all the possible ways an operand can be used.  Thus, '%eax' is both 'register
244   # 0' and 'The Accumulator'.  In our language this is expressed by OR'ing
245   'Reg32' (any 32 bit register) and 'Acc' (the accumulator).
246   Operands are classified so that we can match given operand types with
247   the opcode table in opcode/i386.h.
248   */
249 /* register */
250 #define Reg8               0x1  /* 8 bit reg */
251 #define Reg16              0x2  /* 16 bit reg */
252 #define Reg32              0x4  /* 32 bit reg */
253 /* immediate */
254 #define Imm8               0x8  /* 8 bit immediate */
255 #define Imm8S             0x10  /* 8 bit immediate sign extended */
256 #define Imm16             0x20  /* 16 bit immediate */
257 #define Imm32             0x40  /* 32 bit immediate */
258 #define Imm1              0x80  /* 1 bit immediate */
259 /* memory */
260 #define BaseIndex        0x100
261 /* Disp8,16,32 are used in different ways, depending on the
262    instruction.  For jumps, they specify the size of the PC relative
263    displacement, for baseindex type instructions, they specify the
264    size of the offset relative to the base register, and for memory
265    offset instructions such as `mov 1234,%al' they specify the size of
266    the offset relative to the segment base.  */
267 #define Disp8            0x200  /* 8 bit displacement */
268 #define Disp16           0x400  /* 16 bit displacement */
269 #define Disp32           0x800  /* 32 bit displacement */
270 /* specials */
271 #define InOutPortReg    0x1000  /* register to hold in/out port addr = dx */
272 #define ShiftCount      0x2000  /* register to hold shift cound = cl */
273 #define Control         0x4000  /* Control register */
274 #define Debug           0x8000  /* Debug register */
275 #define Test           0x10000  /* Test register */
276 #define FloatReg       0x20000  /* Float register */
277 #define FloatAcc       0x40000  /* Float stack top %st(0) */
278 #define SReg2          0x80000  /* 2 bit segment register */
279 #define SReg3         0x100000  /* 3 bit segment register */
280 #define Acc           0x200000  /* Accumulator %al or %ax or %eax */
281 #define JumpAbsolute  0x400000
282 #define RegMMX        0x800000  /* MMX register */
283 #define RegXMM       0x1000000  /* XMM registers in PIII */
284 #define EsSeg        0x2000000  /* String insn operand with fixed es segment */
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       0x4000000
291
292 #define Reg     (Reg8|Reg16|Reg32)      /* gen'l register */
293 #define WordReg (Reg16|Reg32)
294 #define ImplicitRegister (InOutPortReg|ShiftCount|Acc|FloatAcc)
295 #define Imm     (Imm8|Imm8S|Imm16|Imm32) /* gen'l immediate */
296 #define Disp    (Disp8|Disp16|Disp32)   /* General displacement */
297 #define AnyMem  (Disp|BaseIndex|InvMem) /* General memory */
298 /* The following aliases are defined because the opcode table
299    carefully specifies the allowed memory types for each instruction.
300    At the moment we can only tell a memory reference size by the
301    instruction suffix, so there's not much point in defining Mem8,
302    Mem16, Mem32 and Mem64 opcode modifiers - We might as well just use
303    the suffix directly to check memory operands.  */
304 #define LLongMem AnyMem         /* 64 bits (or more) */
305 #define LongMem AnyMem          /* 32 bit memory ref */
306 #define ShortMem AnyMem         /* 16 bit memory ref */
307 #define WordMem AnyMem          /* 16 or 32 bit memory ref */
308 #define ByteMem AnyMem          /* 8 bit memory ref */
309
310 #define SMALLEST_DISP_TYPE(num) \
311     (fits_in_signed_byte(num) ? (Disp8|Disp32) : Disp32)
312
313 typedef struct
314 {
315   /* instruction name sans width suffix ("mov" for movl insns) */
316   char *name;
317
318   /* how many operands */
319   unsigned int operands;
320
321   /* base_opcode is the fundamental opcode byte without optional
322      prefix(es).  */
323   unsigned int base_opcode;
324
325   /* extension_opcode is the 3 bit extension for group <n> insns.
326      This field is also used to store the 8-bit opcode suffix for the
327      AMD 3DNow! instructions.
328      If this template has no extension opcode (the usual case) use None */
329   unsigned int extension_opcode;
330 #define None 0xffff             /* If no extension_opcode is possible. */
331
332   /* the bits in opcode_modifier are used to generate the final opcode from
333      the base_opcode.  These bits also are used to detect alternate forms of
334      the same instruction */
335   unsigned int opcode_modifier;
336
337   /* opcode_modifier bits: */
338 #define W                  0x1  /* set if operands can be words or dwords
339                                    encoded the canonical way */
340 #define D                  0x2  /* D = 0 if Reg --> Regmem;
341                                    D = 1 if Regmem --> Reg:    MUST BE 0x2 */
342 #define Modrm              0x4
343 #define FloatR             0x8  /* src/dest swap for floats:   MUST BE 0x8 */
344 #define ShortForm         0x10  /* register is in low 3 bits of opcode */
345 #define FloatMF           0x20  /* FP insn memory format bit, sized by 0x4 */
346 #define Jump              0x40  /* special case for jump insns. */
347 #define JumpDword         0x80  /* call and jump */
348 #define JumpByte         0x100  /* loop and jecxz */
349 #define JumpInterSegment 0x200  /* special case for intersegment leaps/calls */
350 #define FloatD           0x400  /* direction for float insns:  MUST BE 0x400 */
351 #define Seg2ShortForm    0x800  /* encoding of load segment reg insns */
352 #define Seg3ShortForm   0x1000  /* fs/gs segment register insns. */
353 #define Size16          0x2000  /* needs size prefix if in 32-bit mode */
354 #define Size32          0x4000  /* needs size prefix if in 16-bit mode */
355 #define IgnoreSize      0x8000  /* instruction ignores operand size prefix */
356 #define DefaultSize    0x10000  /* default insn size depends on mode */
357 #define No_bSuf        0x20000  /* b suffix on instruction illegal */
358 #define No_wSuf        0x40000  /* w suffix on instruction illegal */
359 #define No_lSuf        0x80000  /* l suffix on instruction illegal */
360 #define No_sSuf       0x100000  /* s suffix on instruction illegal */
361 #define No_dSuf       0x200000  /* d suffix on instruction illegal */
362 #define No_xSuf       0x400000  /* x suffix on instruction illegal */
363 #define FWait         0x800000  /* instruction needs FWAIT */
364 #define IsString     0x1000000  /* quick test for string instructions */
365 #define regKludge    0x2000000  /* fake an extra reg operand for clr, imul */
366 #define IsPrefix     0x4000000  /* opcode is a prefix */
367 #define ImmExt       0x8000000  /* instruction has extension in 8 bit imm */
368 #define Ugh         0x80000000  /* deprecated fp insn, gets a warning */
369
370   /* operand_types[i] describes the type of operand i.  This is made
371      by OR'ing together all of the possible type masks.  (e.g.
372      'operand_types[i] = Reg|Imm' specifies that operand i can be
373      either a register or an immediate operand */
374   unsigned int operand_types[3];
375 }
376 template;
377
378 /*
379   'templates' is for grouping together 'template' structures for opcodes
380   of the same name.  This is only used for storing the insns in the grand
381   ole hash table of insns.
382   The templates themselves start at START and range up to (but not including)
383   END.
384   */
385 typedef struct
386   {
387     const template *start;
388     const template *end;
389   } templates;
390
391 /* these are for register name --> number & type hash lookup */
392 typedef struct
393   {
394     char *reg_name;
395     unsigned int reg_type;
396     unsigned int reg_num;
397   }
398 reg_entry;
399
400 typedef struct
401   {
402     char *seg_name;
403     unsigned int seg_prefix;
404   }
405 seg_entry;
406
407 /* 386 operand encoding bytes:  see 386 book for details of this. */
408 typedef struct
409   {
410     unsigned int regmem;        /* codes register or memory operand */
411     unsigned int reg;           /* codes register operand (or extended opcode) */
412     unsigned int mode;          /* how to interpret regmem & reg */
413   }
414 modrm_byte;
415
416 /* 386 opcode byte to code indirect addressing. */
417 typedef struct
418   {
419     unsigned base;
420     unsigned index;
421     unsigned scale;
422   }
423 sib_byte;
424
425 /* The name of the global offset table generated by the compiler. Allow
426    this to be overridden if need be. */
427 #ifndef GLOBAL_OFFSET_TABLE_NAME
428 #define GLOBAL_OFFSET_TABLE_NAME "_GLOBAL_OFFSET_TABLE_"
429 #endif
430
431 #ifdef BFD_ASSEMBLER
432 void i386_validate_fix PARAMS ((struct fix *));
433 #define TC_VALIDATE_FIX(FIXP,SEGTYPE,SKIP) i386_validate_fix(FIXP)
434 #endif
435
436 #endif /* TC_I386 */
437
438 #define md_operand(x)
439
440 extern const struct relax_type md_relax_table[];
441 #define TC_GENERIC_RELAX_TABLE md_relax_table
442
443 #define md_do_align(n, fill, len, max, around)                          \
444 if ((n) && !need_pass_2                                                 \
445     && (!(fill) || ((char)*(fill) == (char)0x90 && (len) == 1))         \
446     && subseg_text_p (now_seg))                                         \
447   {                                                                     \
448     char *p;                                                            \
449     p = frag_var (rs_align_code, 15, 1, (relax_substateT) max,          \
450                   (symbolS *) 0, (offsetT) (n), (char *) 0);            \
451     *p = 0x90;                                                          \
452     goto around;                                                        \
453   }
454
455 extern void i386_align_code PARAMS ((fragS *, int));
456
457 #define HANDLE_ALIGN(fragP)                                             \
458 if (fragP->fr_type == rs_align_code)                                    \
459   i386_align_code (fragP, (fragP->fr_next->fr_address                   \
460                            - fragP->fr_address                          \
461                            - fragP->fr_fix));
462
463 /* call md_apply_fix3 with segment instead of md_apply_fix */
464 #define MD_APPLY_FIX3
465
466 void i386_print_statistics PARAMS ((FILE *));
467 #define tc_print_statistics i386_print_statistics
468
469 #define md_number_to_chars number_to_chars_littleendian
470
471 #ifdef SCO_ELF
472 #define tc_init_after_args() sco_id ()
473 extern void sco_id PARAMS ((void));
474 #endif
475
476 #define DIFF_EXPR_OK    /* foo-. gets turned into PC relative relocs */
477
478 /* end of tc-i386.h */