opcodes/i386-opc.h

   1 /* Declarations for Intel 80386 opcode table
   2    Copyright 2007
   3    Free Software Foundation, Inc.
   4
   5    This file is part of the GNU opcodes library.
   6
   7    This library 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, or (at your option)
  10    any later version.
  11
  12    It is distributed in the hope that it will be useful, but WITHOUT
  13    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  15    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, 51 Franklin Street - Fifth Floor, Boston, MA
  20    02110-1301, USA.  */
  21
  22 #include "opcode/i386.h"
  23 #ifdef HAVE_LIMITS_H
  24 #include <limits.h>
  25 #endif
  26
  27 #ifndef CHAR_BIT
  28 #define CHAR_BIT 8
  29 #endif
  30
  31 /* Position of cpu flags bitfiled.  */
  32
  33 /* i186 or better required */
  34 #define Cpu186          0
  35 /* i286 or better required */
  36 #define Cpu286          (Cpu186 + 1)
  37 /* i386 or better required */
  38 #define Cpu386          (Cpu286 + 1)
  39 /* i486 or better required */
  40 #define Cpu486          (Cpu386 + 1)
  41 /* i585 or better required */
  42 #define Cpu586          (Cpu486 + 1)
  43 /* i686 or better required */
  44 #define Cpu686          (Cpu586 + 1)
  45 /* Pentium4 or better required */
  46 #define CpuP4           (Cpu686 + 1)
  47 /* AMD K6 or better required*/
  48 #define CpuK6           (CpuP4 + 1)
  49 /* AMD K8 or better required */
  50 #define CpuK8           (CpuK6 + 1)
  51 /* MMX support required */
  52 #define CpuMMX          (CpuK8 + 1)
  53 /* extended MMX support (with SSE or 3DNow!Ext) required */
  54 #define CpuMMX2         (CpuMMX + 1)
  55 /* SSE support required */
  56 #define CpuSSE          (CpuMMX2 + 1)
  57 /* SSE2 support required */
  58 #define CpuSSE2         (CpuSSE + 1)
  59 /* 3dnow! support required */
  60 #define Cpu3dnow        (CpuSSE2 + 1)
  61 /* 3dnow! Extensions support required */
  62 #define Cpu3dnowA       (Cpu3dnow + 1)
  63 /* SSE3 support required */
  64 #define CpuSSE3         (Cpu3dnowA + 1)
  65 /* VIA PadLock required */
  66 #define CpuPadLock      (CpuSSE3 + 1)
  67 /* AMD Secure Virtual Machine Ext-s required */
  68 #define CpuSVME         (CpuPadLock + 1)
  69 /* VMX Instructions required */
  70 #define CpuVMX          (CpuSVME + 1)
  71 /* SMX Instructions required */
  72 #define CpuSMX          (CpuVMX + 1)
  73 /* SSSE3 support required */
  74 #define CpuSSSE3        (CpuSMX + 1)
  75 /* SSE4a support required */
  76 #define CpuSSE4a        (CpuSSSE3 + 1)
  77 /* ABM New Instructions required */
  78 #define CpuABM          (CpuSSE4a + 1)
  79 /* SSE4.1 support required */
  80 #define CpuSSE4_1       (CpuABM + 1)
  81 /* SSE4.2 support required */
  82 #define CpuSSE4_2       (CpuSSE4_1 + 1)
  83 /* SSE5 support required */
  84 #define CpuSSE5         (CpuSSE4_2 + 1)
  85 /* SSE4.1 or SSE5 support required */
  86 #define CpuSSE4_1_Or_5  (CpuSSE5 + 1)
  87 /* 64bit support available, used by -march= in assembler.  */
  88 #define CpuLM           (CpuSSE4_1_Or_5 + 1)
  89 /* 64bit support required  */
  90 #define Cpu64           (CpuLM + 1)
  91 /* Not supported in the 64bit mode  */
  92 #define CpuNo64         (Cpu64 + 1)
  93 /* The last bitfield in i386_cpu_flags.  */
  94 #define CpuMax          CpuNo64
  95
  96 #define CpuNumOfUints \
  97   (CpuMax / sizeof (unsigned int) / CHAR_BIT + 1)
  98 #define CpuNumOfBits \
  99   (CpuNumOfUints * sizeof (unsigned int) * CHAR_BIT)
 100
 101 /* If you get a compiler error for zero width of the unused field,
 102    comment it out.  */
 103 #define CpuUnused       (CpuMax + 1)
 104
 105 /* We can check if an instruction is available with array instead
 106    of bitfield. */
 107 typedef union i386_cpu_flags
 108 {
 109   struct
 110     {
 111       unsigned int cpui186:1;
 112       unsigned int cpui286:1;
 113       unsigned int cpui386:1;
 114       unsigned int cpui486:1;
 115       unsigned int cpui586:1;
 116       unsigned int cpui686:1;
 117       unsigned int cpup4:1;
 118       unsigned int cpuk6:1;
 119       unsigned int cpuk8:1;
 120       unsigned int cpummx:1;
 121       unsigned int cpummx2:1;
 122       unsigned int cpusse:1;
 123       unsigned int cpusse2:1;
 124       unsigned int cpua3dnow:1;
 125       unsigned int cpua3dnowa:1;
 126       unsigned int cpusse3:1;
 127       unsigned int cpupadlock:1;
 128       unsigned int cpusvme:1;
 129       unsigned int cpuvmx:1;
 130       unsigned int cpusmx:1;
 131       unsigned int cpussse3:1;
 132       unsigned int cpusse4a:1;
 133       unsigned int cpuabm:1;
 134       unsigned int cpusse4_1:1;
 135       unsigned int cpusse4_2:1;
 136       unsigned int cpusse5:1;
 137       unsigned int cpusse4_1_or_5:1;
 138       unsigned int cpulm:1;
 139       unsigned int cpu64:1;
 140       unsigned int cpuno64:1;
 141 #ifdef CpuUnused
 142       unsigned int unused:(CpuNumOfBits - CpuUnused);
 143 #endif
 144     } bitfield;
 145   unsigned int array[CpuNumOfUints];
 146 } i386_cpu_flags;
 147
 148 /* Position of opcode_modifier bits.  */
 149
 150 /* has direction bit. */
 151 #define D                       0
 152 /* set if operands can be words or dwords encoded the canonical way */
 153 #define W                       (D + 1)
 154 /* insn has a modrm byte. */
 155 #define Modrm                   (W + 1)
 156 /* register is in low 3 bits of opcode */
 157 #define ShortForm               (Modrm + 1)
 158 /* special case for jump insns.  */
 159 #define Jump                    (ShortForm + 1)
 160 /* call and jump */
 161 #define JumpDword               (Jump + 1)
 162 /* loop and jecxz */
 163 #define JumpByte                (JumpDword + 1)
 164 /* special case for intersegment leaps/calls */
 165 #define JumpInterSegment        (JumpByte + 1)
 166 /* FP insn memory format bit, sized by 0x4 */
 167 #define FloatMF                 (JumpInterSegment + 1)
 168 /* src/dest swap for floats. */
 169 #define FloatR                  (FloatMF + 1)
 170 /* has float insn direction bit. */
 171 #define FloatD                  (FloatR + 1)
 172 /* needs size prefix if in 32-bit mode */
 173 #define Size16                  (FloatD + 1)
 174 /* needs size prefix if in 16-bit mode */
 175 #define Size32                  (Size16 + 1)
 176 /* needs size prefix if in 64-bit mode */
 177 #define Size64                  (Size32 + 1)
 178 /* instruction ignores operand size prefix */
 179 #define IgnoreSize              (Size64 + 1)
 180 /* default insn size depends on mode */
 181 #define DefaultSize             (IgnoreSize + 1)
 182 /* b suffix on instruction illegal */
 183 #define No_bSuf                 (DefaultSize + 1)
 184 /* w suffix on instruction illegal */
 185 #define No_wSuf                 (No_bSuf + 1)
 186 /* l suffix on instruction illegal */
 187 #define No_lSuf                 (No_wSuf + 1)
 188 /* s suffix on instruction illegal */
 189 #define No_sSuf                 (No_lSuf + 1)
 190 /* q suffix on instruction illegal */
 191 #define No_qSuf                 (No_sSuf + 1)
 192 /* long double suffix on instruction illegal */
 193 #define No_ldSuf                (No_qSuf + 1)
 194 /* x suffix on instruction illegal */
 195 #define No_xSuf                 (No_ldSuf + 1)
 196 /* check PTR size on instruction */
 197 #define CheckSize               (No_xSuf + 1)
 198 /* BYTE PTR on instruction */
 199 #define Byte                    (CheckSize + 1)
 200 /* WORD PTR on instruction */
 201 #define Word                    (Byte + 1)
 202 /* DWORD PTR on instruction */
 203 #define Dword                   (Word + 1)
 204 /* QWORD PTR on instruction */
 205 #define QWord                   (Dword + 1)
 206 /* XMMWORD PTR on instruction */
 207 #define Xmmword                 (QWord + 1)
 208 /* instruction needs FWAIT */
 209 #define FWait                   (Xmmword + 1)
 210 /* quick test for string instructions */
 211 #define IsString                (FWait + 1)
 212 /* fake an extra reg operand for clr, imul and special register
 213    processing for some instructions.  */
 214 #define RegKludge               (IsString + 1)
 215 /* The first operand must be xmm0 */
 216 #define FirstXmm0               (RegKludge + 1)
 217 /* BYTE is OK in Intel syntax. */
 218 #define ByteOkIntel             (FirstXmm0 + 1)
 219 /* Convert to DWORD */
 220 #define ToDword                 (ByteOkIntel + 1)
 221 /* Convert to QWORD */
 222 #define ToQword                 (ToDword + 1)
 223 /* Address prefix changes operand 0 */
 224 #define AddrPrefixOp0           (ToQword + 1)
 225 /* opcode is a prefix */
 226 #define IsPrefix                (AddrPrefixOp0 + 1)
 227 /* instruction has extension in 8 bit imm */
 228 #define ImmExt                  (IsPrefix + 1)
 229 /* instruction don't need Rex64 prefix.  */
 230 #define NoRex64                 (ImmExt + 1)
 231 /* instruction require Rex64 prefix.  */
 232 #define Rex64                   (NoRex64 + 1)
 233 /* deprecated fp insn, gets a warning */
 234 #define Ugh                     (Rex64 + 1)
 235 #define Drex                    (Ugh + 1)
 236 /* instruction needs DREX with multiple encodings for memory ops */
 237 #define Drexv                   (Drex + 1)
 238 /* special DREX for comparisons */
 239 #define Drexc                   (Drexv + 1)
 240 /* Compatible with old (<= 2.8.1) versions of gcc  */
 241 #define OldGcc                  (Drexc + 1)
 242 /* AT&T mnemonic.  */
 243 #define ATTMnemonic             (OldGcc + 1)
 244 /* Intel mnemonic.  */
 245 #define IntelMnemonic           (ATTMnemonic + 1)
 246 /* The last bitfield in i386_opcode_modifier.  */
 247 #define Opcode_Modifier_Max     IntelMnemonic
 248
 249 typedef struct i386_opcode_modifier
 250 {
 251   unsigned int d:1;
 252   unsigned int w:1;
 253   unsigned int modrm:1;
 254   unsigned int shortform:1;
 255   unsigned int jump:1;
 256   unsigned int jumpdword:1;
 257   unsigned int jumpbyte:1;
 258   unsigned int jumpintersegment:1;
 259   unsigned int floatmf:1;
 260   unsigned int floatr:1;
 261   unsigned int floatd:1;
 262   unsigned int size16:1;
 263   unsigned int size32:1;
 264   unsigned int size64:1;
 265   unsigned int ignoresize:1;
 266   unsigned int defaultsize:1;
 267   unsigned int no_bsuf:1;
 268   unsigned int no_wsuf:1;
 269   unsigned int no_lsuf:1;
 270   unsigned int no_ssuf:1;
 271   unsigned int no_qsuf:1;
 272   unsigned int no_ldsuf:1;
 273   unsigned int no_xsuf:1;
 274   unsigned int checksize:1;
 275   unsigned int byte:1;
 276   unsigned int word:1;
 277   unsigned int dword:1;
 278   unsigned int qword:1;
 279   unsigned int xmmword:1;
 280   unsigned int fwait:1;
 281   unsigned int isstring:1;
 282   unsigned int regkludge:1;
 283   unsigned int firstxmm0:1;
 284   unsigned int byteokintel:1;
 285   unsigned int todword:1;
 286   unsigned int toqword:1;
 287   unsigned int addrprefixop0:1;
 288   unsigned int isprefix:1;
 289   unsigned int immext:1;
 290   unsigned int norex64:1;
 291   unsigned int rex64:1;
 292   unsigned int ugh:1;
 293   unsigned int drex:1;
 294   unsigned int drexv:1;
 295   unsigned int drexc:1;
 296   unsigned int oldgcc:1;
 297   unsigned int attmnemonic:1;
 298   unsigned int intelmnemonic:1;
 299 } i386_opcode_modifier;
 300
 301 /* Position of operand_type bits.  */
 302
 303 /* Registers  */
 304
 305 /* 8 bit reg */
 306 #define Reg8                    0
 307 /* 16 bit reg */
 308 #define Reg16                   (Reg8 + 1)
 309 /* 32 bit reg */
 310 #define Reg32                   (Reg16 + 1)
 311 /* 64 bit reg */
 312 #define Reg64                   (Reg32 + 1)
 313
 314 /* immediate */
 315
 316 /* 8 bit immediate */
 317 #define Imm8                    (Reg64 + 1)
 318 /* 8 bit immediate sign extended */
 319 #define Imm8S                   (Imm8 + 1)
 320 /* 16 bit immediate */
 321 #define Imm16                   (Imm8S + 1)
 322 /* 32 bit immediate */
 323 #define Imm32                   (Imm16 + 1)
 324 /* 32 bit immediate sign extended */
 325 #define Imm32S                  (Imm32 + 1)
 326 /* 64 bit immediate */
 327 #define Imm64                   (Imm32S + 1)
 328 /* 1 bit immediate */
 329 #define Imm1                    (Imm64 + 1)
 330
 331 /* memory */
 332
 333 #define BaseIndex               (Imm1 + 1)
 334 /* Disp8,16,32 are used in different ways, depending on the
 335    instruction.  For jumps, they specify the size of the PC relative
 336    displacement, for baseindex type instructions, they specify the
 337    size of the offset relative to the base register, and for memory
 338    offset instructions such as `mov 1234,%al' they specify the size of
 339    the offset relative to the segment base.  */
 340 /* 8 bit displacement */
 341 #define Disp8                   (BaseIndex + 1)
 342 /* 16 bit displacement */
 343 #define Disp16                  (Disp8 + 1)
 344 /* 32 bit displacement */
 345 #define Disp32                  (Disp16 + 1)
 346 /* 32 bit signed displacement */
 347 #define Disp32S                 (Disp32 + 1)
 348 /* 64 bit displacement */
 349 #define Disp64                  (Disp32S + 1)
 350
 351 /* specials */
 352
 353 /* register to hold in/out port addr = dx */
 354 #define InOutPortReg            (Disp64 + 1)
 355 /* register to hold shift count = cl */
 356 #define ShiftCount              (InOutPortReg + 1)
 357 /* Control register */
 358 #define Control                 (ShiftCount + 1)
 359 /* Debug register */
 360 #define Debug                   (Control + 1)
 361 /* Test register */
 362 #define Test                    (Debug + 1)
 363 /* Float register */
 364 #define FloatReg                (Test + 1)
 365 /* Float stack top %st(0) */
 366 #define FloatAcc                (FloatReg + 1)
 367 /* 2 bit segment register */
 368 #define SReg2                   (FloatAcc + 1)
 369 /* 3 bit segment register */
 370 #define SReg3                   (SReg2 + 1)
 371 /* Accumulator %al or %ax or %eax */
 372 #define Acc                     (SReg3 + 1)
 373 #define JumpAbsolute            (Acc + 1)
 374 /* MMX register */
 375 #define RegMMX                  (JumpAbsolute + 1)
 376 /* XMM registers in PIII */
 377 #define RegXMM                  (RegMMX + 1)
 378 /* String insn operand with fixed es segment */
 379 #define EsSeg                   (RegXMM + 1)
 380
 381 /* RegMem is for instructions with a modrm byte where the register
 382    destination operand should be encoded in the mod and regmem fields.
 383    Normally, it will be encoded in the reg field. We add a RegMem
 384    flag to the destination register operand to indicate that it should
 385    be encoded in the regmem field.  */
 386 #define RegMem                  (EsSeg + 1)
 387
 388 /* The last bitfield in i386_operand_type.  */
 389 #define OTMax                   RegMem
 390
 391 #define OTNumOfUints \
 392   (OTMax / sizeof (unsigned int) / CHAR_BIT + 1)
 393 #define OTNumOfBits \
 394   (OTNumOfUints * sizeof (unsigned int) * CHAR_BIT)
 395
 396 /* If you get a compiler error for zero width of the unused field,
 397    comment it out.  */
 398 #if 0
 399 #define OTUnused                (OTMax + 1)
 400 #endif
 401
 402 typedef union i386_operand_type
 403 {
 404   struct
 405     {
 406       unsigned int reg8:1;
 407       unsigned int reg16:1;
 408       unsigned int reg32:1;
 409       unsigned int reg64:1;
 410       unsigned int imm8:1;
 411       unsigned int imm8s:1;
 412       unsigned int imm16:1;
 413       unsigned int imm32:1;
 414       unsigned int imm32s:1;
 415       unsigned int imm64:1;
 416       unsigned int imm1:1;
 417       unsigned int baseindex:1;
 418       unsigned int disp8:1;
 419       unsigned int disp16:1;
 420       unsigned int disp32:1;
 421       unsigned int disp32s:1;
 422       unsigned int disp64:1;
 423       unsigned int inoutportreg:1;
 424       unsigned int shiftcount:1;
 425       unsigned int control:1;
 426       unsigned int debug:1;
 427       unsigned int test:1;
 428       unsigned int floatreg:1;
 429       unsigned int floatacc:1;
 430       unsigned int sreg2:1;
 431       unsigned int sreg3:1;
 432       unsigned int acc:1;
 433       unsigned int jumpabsolute:1;
 434       unsigned int regmmx:1;
 435       unsigned int regxmm:1;
 436       unsigned int esseg:1;
 437       unsigned int regmem:1;
 438 #ifdef OTUnused
 439       unsigned int unused:(OTNumOfBits - OTUnused);
 440 #endif
 441     } bitfield;
 442   unsigned int array[OTNumOfUints];
 443 } i386_operand_type;
 444
 445 typedef struct template
 446 {
 447   /* instruction name sans width suffix ("mov" for movl insns) */
 448   char *name;
 449
 450   /* how many operands */
 451   unsigned int operands;
 452
 453   /* base_opcode is the fundamental opcode byte without optional
 454      prefix(es).  */
 455   unsigned int base_opcode;
 456 #define Opcode_D        0x2 /* Direction bit:
 457                                set if Reg --> Regmem;
 458                                unset if Regmem --> Reg. */
 459 #define Opcode_FloatR   0x8 /* Bit to swap src/dest for float insns. */
 460 #define Opcode_FloatD 0x400 /* Direction bit for float insns. */
 461
 462   /* extension_opcode is the 3 bit extension for group <n> insns.
 463      This field is also used to store the 8-bit opcode suffix for the
 464      AMD 3DNow! instructions.
 465      If this template has no extension opcode (the usual case) use None
 466      Instructions with Drex use this to specify 2 bits for OC */
 467   unsigned int extension_opcode;
 468 #define None 0xffff             /* If no extension_opcode is possible.  */
 469
 470   /* Opcode length.  */
 471   unsigned char opcode_length;
 472
 473   /* cpu feature flags */
 474   i386_cpu_flags cpu_flags;
 475
 476   /* the bits in opcode_modifier are used to generate the final opcode from
 477      the base_opcode.  These bits also are used to detect alternate forms of
 478      the same instruction */
 479   i386_opcode_modifier opcode_modifier;
 480
 481   /* operand_types[i] describes the type of operand i.  This is made
 482      by OR'ing together all of the possible type masks.  (e.g.
 483      'operand_types[i] = Reg|Imm' specifies that operand i can be
 484      either a register or an immediate operand.  */
 485   i386_operand_type operand_types[MAX_OPERANDS];
 486 }
 487 template;
 488
 489 extern const template i386_optab[];
 490
 491 /* these are for register name --> number & type hash lookup */
 492 typedef struct
 493 {
 494   char *reg_name;
 495   i386_operand_type reg_type;
 496   unsigned int reg_flags;
 497 #define RegRex      0x1  /* Extended register.  */
 498 #define RegRex64    0x2  /* Extended 8 bit register.  */
 499   unsigned int reg_num;
 500 #define RegRip  ((unsigned int ) ~0)
 501 #define RegEip  (RegRip - 1)
 502 /* EIZ and RIZ are fake index registers.  */
 503 #define RegEiz  (RegEip - 1)
 504 #define RegRiz  (RegEiz - 1)
 505 }
 506 reg_entry;
 507
 508 /* Entries in i386_regtab.  */
 509 #define REGNAM_AL 1
 510 #define REGNAM_AX 25
 511 #define REGNAM_EAX 41
 512
 513 extern const reg_entry i386_regtab[];
 514 extern const unsigned int i386_regtab_size;
 515
 516 typedef struct
 517 {
 518   char *seg_name;
 519   unsigned int seg_prefix;
 520 }
 521 seg_entry;
 522
 523 extern const seg_entry cs;
 524 extern const seg_entry ds;
 525 extern const seg_entry ss;
 526 extern const seg_entry es;
 527 extern const seg_entry fs;
 528 extern const seg_entry gs;