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