lib/Target/X86/X86InstrFormats.td

   1 //===- X86InstrFormats.td - X86 Instruction Formats --------*- tablegen -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 //===----------------------------------------------------------------------===//
  11 // X86 Instruction Format Definitions.
  12 //
  13
  14 // Format specifies the encoding used by the instruction.  This is part of the
  15 // ad-hoc solution used to emit machine instruction encodings by our machine
  16 // code emitter.
  17 class Format<bits<6> val> {
  18   bits<6> Value = val;
  19 }
  20
  21 def Pseudo     : Format<0>; def RawFrm     : Format<1>;
  22 def AddRegFrm  : Format<2>; def MRMDestReg : Format<3>;
  23 def MRMDestMem : Format<4>; def MRMSrcReg  : Format<5>;
  24 def MRMSrcMem  : Format<6>;
  25 def MRM0r  : Format<16>; def MRM1r  : Format<17>; def MRM2r  : Format<18>;
  26 def MRM3r  : Format<19>; def MRM4r  : Format<20>; def MRM5r  : Format<21>;
  27 def MRM6r  : Format<22>; def MRM7r  : Format<23>;
  28 def MRM0m  : Format<24>; def MRM1m  : Format<25>; def MRM2m  : Format<26>;
  29 def MRM3m  : Format<27>; def MRM4m  : Format<28>; def MRM5m  : Format<29>;
  30 def MRM6m  : Format<30>; def MRM7m  : Format<31>;
  31 def MRMInitReg : Format<32>;
  32 def MRM_C1 : Format<33>;
  33 def MRM_C8 : Format<34>;
  34 def MRM_C9 : Format<35>;
  35 def MRM_E8 : Format<36>;
  36 def MRM_F0 : Format<37>;
  37
  38
  39 // ImmType - This specifies the immediate type used by an instruction. This is
  40 // part of the ad-hoc solution used to emit machine instruction encodings by our
  41 // machine code emitter.
  42 class ImmType<bits<3> val> {
  43   bits<3> Value = val;
  44 }
  45 def NoImm  : ImmType<0>;
  46 def Imm8   : ImmType<1>;
  47 def Imm16  : ImmType<2>;
  48 def Imm32  : ImmType<3>;
  49 def Imm64  : ImmType<4>;
  50
  51 // FPFormat - This specifies what form this FP instruction has.  This is used by
  52 // the Floating-Point stackifier pass.
  53 class FPFormat<bits<3> val> {
  54   bits<3> Value = val;
  55 }
  56 def NotFP      : FPFormat<0>;
  57 def ZeroArgFP  : FPFormat<1>;
  58 def OneArgFP   : FPFormat<2>;
  59 def OneArgFPRW : FPFormat<3>;
  60 def TwoArgFP   : FPFormat<4>;
  61 def CompareFP  : FPFormat<5>;
  62 def CondMovFP  : FPFormat<6>;
  63 def SpecialFP  : FPFormat<7>;
  64
  65 // Prefix byte classes which are used to indicate to the ad-hoc machine code
  66 // emitter that various prefix bytes are required.
  67 class OpSize { bit hasOpSizePrefix = 1; }
  68 class AdSize { bit hasAdSizePrefix = 1; }
  69 class REX_W  { bit hasREX_WPrefix = 1; }
  70 class LOCK   { bit hasLockPrefix = 1; }
  71 class SegFS  { bits<2> SegOvrBits = 1; }
  72 class SegGS  { bits<2> SegOvrBits = 2; }
  73 class TB     { bits<4> Prefix = 1; }
  74 class REP    { bits<4> Prefix = 2; }
  75 class D8     { bits<4> Prefix = 3; }
  76 class D9     { bits<4> Prefix = 4; }
  77 class DA     { bits<4> Prefix = 5; }
  78 class DB     { bits<4> Prefix = 6; }
  79 class DC     { bits<4> Prefix = 7; }
  80 class DD     { bits<4> Prefix = 8; }
  81 class DE     { bits<4> Prefix = 9; }
  82 class DF     { bits<4> Prefix = 10; }
  83 class XD     { bits<4> Prefix = 11; }
  84 class XS     { bits<4> Prefix = 12; }
  85 class T8     { bits<4> Prefix = 13; }
  86 class TA     { bits<4> Prefix = 14; }
  87 class TF     { bits<4> Prefix = 15; }
  88
  89 class X86Inst<bits<8> opcod, Format f, ImmType i, dag outs, dag ins,
  90               string AsmStr>
  91   : Instruction {
  92   let Namespace = "X86";
  93
  94   bits<8> Opcode = opcod;
  95   Format Form = f;
  96   bits<6> FormBits = Form.Value;
  97   ImmType ImmT = i;
  98   bits<3> ImmTypeBits = ImmT.Value;
  99
 100   dag OutOperandList = outs;
 101   dag InOperandList = ins;
 102   string AsmString = AsmStr;
 103
 104   //
 105   // Attributes specific to X86 instructions...
 106   //
 107   bit hasOpSizePrefix = 0;  // Does this inst have a 0x66 prefix?
 108   bit hasAdSizePrefix = 0;  // Does this inst have a 0x67 prefix?
 109
 110   bits<4> Prefix = 0;       // Which prefix byte does this inst have?
 111   bit hasREX_WPrefix  = 0;  // Does this inst requires the REX.W prefix?
 112   FPFormat FPForm;          // What flavor of FP instruction is this?
 113   bits<3> FPFormBits = 0;
 114   bit hasLockPrefix = 0;    // Does this inst have a 0xF0 prefix?
 115   bits<2> SegOvrBits = 0;   // Segment override prefix.
 116 }
 117
 118 class I<bits<8> o, Format f, dag outs, dag ins, string asm, list<dag> pattern>
 119   : X86Inst<o, f, NoImm, outs, ins, asm> {
 120   let Pattern = pattern;
 121   let CodeSize = 3;
 122 }
 123 class Ii8 <bits<8> o, Format f, dag outs, dag ins, string asm,
 124            list<dag> pattern>
 125   : X86Inst<o, f, Imm8 , outs, ins, asm> {
 126   let Pattern = pattern;
 127   let CodeSize = 3;
 128 }
 129 class Ii16<bits<8> o, Format f, dag outs, dag ins, string asm,
 130            list<dag> pattern>
 131   : X86Inst<o, f, Imm16, outs, ins, asm> {
 132   let Pattern = pattern;
 133   let CodeSize = 3;
 134 }
 135 class Ii32<bits<8> o, Format f, dag outs, dag ins, string asm,
 136            list<dag> pattern>
 137   : X86Inst<o, f, Imm32, outs, ins, asm> {
 138   let Pattern = pattern;
 139   let CodeSize = 3;
 140 }
 141
 142 // FPStack Instruction Templates:
 143 // FPI - Floating Point Instruction template.
 144 class FPI<bits<8> o, Format F, dag outs, dag ins, string asm>
 145   : I<o, F, outs, ins, asm, []> {}
 146
 147 // FpI_ - Floating Point Psuedo Instruction template. Not Predicated.
 148 class FpI_<dag outs, dag ins, FPFormat fp, list<dag> pattern>
 149   : X86Inst<0, Pseudo, NoImm, outs, ins, ""> {
 150   let FPForm = fp; let FPFormBits = FPForm.Value;
 151   let Pattern = pattern;
 152 }
 153
 154 // Templates for instructions that use a 16- or 32-bit segmented address as
 155 //  their only operand: lcall (FAR CALL) and ljmp (FAR JMP)
 156 //
 157 //   Iseg16 - 16-bit segment selector, 16-bit offset
 158 //   Iseg32 - 16-bit segment selector, 32-bit offset
 159
 160 class Iseg16 <bits<8> o, Format f, dag outs, dag ins, string asm,
 161               list<dag> pattern> : X86Inst<o, f, NoImm, outs, ins, asm> {
 162   let Pattern = pattern;
 163   let CodeSize = 3;
 164 }
 165
 166 class Iseg32 <bits<8> o, Format f, dag outs, dag ins, string asm,
 167               list<dag> pattern> : X86Inst<o, f, NoImm, outs, ins, asm> {
 168   let Pattern = pattern;
 169   let CodeSize = 3;
 170 }
 171
 172 // SSE1 Instruction Templates:
 173 //
 174 //   SSI   - SSE1 instructions with XS prefix.
 175 //   PSI   - SSE1 instructions with TB prefix.
 176 //   PSIi8 - SSE1 instructions with ImmT == Imm8 and TB prefix.
 177
 178 class SSI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
 179       : I<o, F, outs, ins, asm, pattern>, XS, Requires<[HasSSE1]>;
 180 class SSIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
 181             list<dag> pattern>
 182       : Ii8<o, F, outs, ins, asm, pattern>, XS, Requires<[HasSSE1]>;
 183 class PSI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
 184       : I<o, F, outs, ins, asm, pattern>, TB, Requires<[HasSSE1]>;
 185 class PSIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
 186             list<dag> pattern>
 187       : Ii8<o, F, outs, ins, asm, pattern>, TB, Requires<[HasSSE1]>;
 188
 189 // SSE2 Instruction Templates:
 190 //
 191 //   SDI    - SSE2 instructions with XD prefix.
 192 //   SDIi8  - SSE2 instructions with ImmT == Imm8 and XD prefix.
 193 //   SSDIi8 - SSE2 instructions with ImmT == Imm8 and XS prefix.
 194 //   PDI    - SSE2 instructions with TB and OpSize prefixes.
 195 //   PDIi8  - SSE2 instructions with ImmT == Imm8 and TB and OpSize prefixes.
 196
 197 class SDI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
 198       : I<o, F, outs, ins, asm, pattern>, XD, Requires<[HasSSE2]>;
 199 class SDIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
 200             list<dag> pattern>
 201       : Ii8<o, F, outs, ins, asm, pattern>, XD, Requires<[HasSSE2]>;
 202 class SSDIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
 203              list<dag> pattern>
 204       : Ii8<o, F, outs, ins, asm, pattern>, XS, Requires<[HasSSE2]>;
 205 class PDI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
 206       : I<o, F, outs, ins, asm, pattern>, TB, OpSize, Requires<[HasSSE2]>;
 207 class PDIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
 208             list<dag> pattern>
 209       : Ii8<o, F, outs, ins, asm, pattern>, TB, OpSize, Requires<[HasSSE2]>;
 210
 211 // SSE3 Instruction Templates:
 212 //
 213 //   S3I   - SSE3 instructions with TB and OpSize prefixes.
 214 //   S3SI  - SSE3 instructions with XS prefix.
 215 //   S3DI  - SSE3 instructions with XD prefix.
 216
 217 class S3SI<bits<8> o, Format F, dag outs, dag ins, string asm,
 218            list<dag> pattern>
 219       : I<o, F, outs, ins, asm, pattern>, XS, Requires<[HasSSE3]>;
 220 class S3DI<bits<8> o, Format F, dag outs, dag ins, string asm,
 221            list<dag> pattern>
 222       : I<o, F, outs, ins, asm, pattern>, XD, Requires<[HasSSE3]>;
 223 class S3I<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
 224       : I<o, F, outs, ins, asm, pattern>, TB, OpSize, Requires<[HasSSE3]>;
 225
 226
 227 // SSSE3 Instruction Templates:
 228 //
 229 //   SS38I - SSSE3 instructions with T8 prefix.
 230 //   SS3AI - SSSE3 instructions with TA prefix.
 231 //
 232 // Note: SSSE3 instructions have 64-bit and 128-bit versions. The 64-bit version
 233 // uses the MMX registers. We put those instructions here because they better
 234 // fit into the SSSE3 instruction category rather than the MMX category.
 235
 236 class SS38I<bits<8> o, Format F, dag outs, dag ins, string asm,
 237             list<dag> pattern>
 238       : Ii8<o, F, outs, ins, asm, pattern>, T8, Requires<[HasSSSE3]>;
 239 class SS3AI<bits<8> o, Format F, dag outs, dag ins, string asm,
 240             list<dag> pattern>
 241       : Ii8<o, F, outs, ins, asm, pattern>, TA, Requires<[HasSSSE3]>;
 242
 243 // SSE4.1 Instruction Templates:
 244 //
 245 //   SS48I - SSE 4.1 instructions with T8 prefix.
 246 //   SS41AIi8 - SSE 4.1 instructions with TA prefix and ImmT == Imm8.
 247 //
 248 class SS48I<bits<8> o, Format F, dag outs, dag ins, string asm,
 249             list<dag> pattern>
 250       : I<o, F, outs, ins, asm, pattern>, T8, Requires<[HasSSE41]>;
 251 class SS4AIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
 252             list<dag> pattern>
 253       : Ii8<o, F, outs, ins, asm, pattern>, TA, Requires<[HasSSE41]>;
 254
 255 // SSE4.2 Instruction Templates:
 256 //
 257 //   SS428I - SSE 4.2 instructions with T8 prefix.
 258 class SS428I<bits<8> o, Format F, dag outs, dag ins, string asm,
 259              list<dag> pattern>
 260       : I<o, F, outs, ins, asm, pattern>, T8, Requires<[HasSSE42]>;
 261
 262 //   SS42FI - SSE 4.2 instructions with TF prefix.
 263 class SS42FI<bits<8> o, Format F, dag outs, dag ins, string asm,
 264               list<dag> pattern>
 265       : I<o, F, outs, ins, asm, pattern>, TF, Requires<[HasSSE42]>;
 266
 267 //   SS42AI = SSE 4.2 instructions with TA prefix
 268 class SS42AI<bits<8> o, Format F, dag outs, dag ins, string asm,
 269              list<dag> pattern>
 270       : I<o, F, outs, ins, asm, pattern>, TA, Requires<[HasSSE42]>;
 271
 272 // X86-64 Instruction templates...
 273 //
 274
 275 class RI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
 276       : I<o, F, outs, ins, asm, pattern>, REX_W;
 277 class RIi8 <bits<8> o, Format F, dag outs, dag ins, string asm,
 278             list<dag> pattern>
 279       : Ii8<o, F, outs, ins, asm, pattern>, REX_W;
 280 class RIi32 <bits<8> o, Format F, dag outs, dag ins, string asm,
 281              list<dag> pattern>
 282       : Ii32<o, F, outs, ins, asm, pattern>, REX_W;
 283
 284 class RIi64<bits<8> o, Format f, dag outs, dag ins, string asm,
 285             list<dag> pattern>
 286   : X86Inst<o, f, Imm64, outs, ins, asm>, REX_W {
 287   let Pattern = pattern;
 288   let CodeSize = 3;
 289 }
 290
 291 class RSSI<bits<8> o, Format F, dag outs, dag ins, string asm,
 292            list<dag> pattern>
 293       : SSI<o, F, outs, ins, asm, pattern>, REX_W;
 294 class RSDI<bits<8> o, Format F, dag outs, dag ins, string asm,
 295            list<dag> pattern>
 296       : SDI<o, F, outs, ins, asm, pattern>, REX_W;
 297 class RPDI<bits<8> o, Format F, dag outs, dag ins, string asm,
 298            list<dag> pattern>
 299       : PDI<o, F, outs, ins, asm, pattern>, REX_W;
 300
 301 // MMX Instruction templates
 302 //
 303
 304 // MMXI   - MMX instructions with TB prefix.
 305 // MMXI64 - MMX instructions with TB prefix valid only in 64 bit mode.
 306 // MMX2I  - MMX / SSE2 instructions with TB and OpSize prefixes.
 307 // MMXIi8 - MMX instructions with ImmT == Imm8 and TB prefix.
 308 // MMXIi8 - MMX instructions with ImmT == Imm8 and TB prefix.
 309 // MMXID  - MMX instructions with XD prefix.
 310 // MMXIS  - MMX instructions with XS prefix.
 311 class MMXI<bits<8> o, Format F, dag outs, dag ins, string asm,
 312            list<dag> pattern>
 313       : I<o, F, outs, ins, asm, pattern>, TB, Requires<[HasMMX]>;
 314 class MMXI64<bits<8> o, Format F, dag outs, dag ins, string asm,
 315              list<dag> pattern>
 316       : I<o, F, outs, ins, asm, pattern>, TB, Requires<[HasMMX,In64BitMode]>;
 317 class MMXRI<bits<8> o, Format F, dag outs, dag ins, string asm,
 318             list<dag> pattern>
 319       : I<o, F, outs, ins, asm, pattern>, TB, REX_W, Requires<[HasMMX]>;
 320 class MMX2I<bits<8> o, Format F, dag outs, dag ins, string asm,
 321             list<dag> pattern>
 322       : I<o, F, outs, ins, asm, pattern>, TB, OpSize, Requires<[HasMMX]>;
 323 class MMXIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
 324              list<dag> pattern>
 325       : Ii8<o, F, outs, ins, asm, pattern>, TB, Requires<[HasMMX]>;
 326 class MMXID<bits<8> o, Format F, dag outs, dag ins, string asm,
 327             list<dag> pattern>
 328       : Ii8<o, F, outs, ins, asm, pattern>, XD, Requires<[HasMMX]>;
 329 class MMXIS<bits<8> o, Format F, dag outs, dag ins, string asm,
 330             list<dag> pattern>
 331       : Ii8<o, F, outs, ins, asm, pattern>, XS, Requires<[HasMMX]>;