1 //===- X86InstrFormats.td - X86 Instruction Formats --------*- tablegen -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 //===----------------------------------------------------------------------===//
11 // X86 Instruction Format Definitions.
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
17 class Format<bits<6> val> {
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_C2 : Format<34>;
34 def MRM_C3 : Format<35>;
35 def MRM_C4 : Format<36>;
36 def MRM_C8 : Format<37>;
37 def MRM_C9 : Format<38>;
38 def MRM_E8 : Format<39>;
39 def MRM_F0 : Format<40>;
40 def MRM_F8 : Format<41>;
41 def MRM_F9 : Format<42>;
42 def RawFrmImm8 : Format<43>;
43 def RawFrmImm16 : Format<44>;
44 def MRM_D0 : Format<45>;
45 def MRM_D1 : Format<46>;
47 // ImmType - This specifies the immediate type used by an instruction. This is
48 // part of the ad-hoc solution used to emit machine instruction encodings by our
49 // machine code emitter.
50 class ImmType<bits<3> val> {
53 def NoImm : ImmType<0>;
54 def Imm8 : ImmType<1>;
55 def Imm8PCRel : ImmType<2>;
56 def Imm16 : ImmType<3>;
57 def Imm16PCRel : ImmType<4>;
58 def Imm32 : ImmType<5>;
59 def Imm32PCRel : ImmType<6>;
60 def Imm64 : ImmType<7>;
62 // FPFormat - This specifies what form this FP instruction has. This is used by
63 // the Floating-Point stackifier pass.
64 class FPFormat<bits<3> val> {
67 def NotFP : FPFormat<0>;
68 def ZeroArgFP : FPFormat<1>;
69 def OneArgFP : FPFormat<2>;
70 def OneArgFPRW : FPFormat<3>;
71 def TwoArgFP : FPFormat<4>;
72 def CompareFP : FPFormat<5>;
73 def CondMovFP : FPFormat<6>;
74 def SpecialFP : FPFormat<7>;
76 // Class specifying the SSE execution domain, used by the SSEDomainFix pass.
77 // Keep in sync with tables in X86InstrInfo.cpp.
78 class Domain<bits<2> val> {
81 def GenericDomain : Domain<0>;
82 def SSEPackedSingle : Domain<1>;
83 def SSEPackedDouble : Domain<2>;
84 def SSEPackedInt : Domain<3>;
86 // Prefix byte classes which are used to indicate to the ad-hoc machine code
87 // emitter that various prefix bytes are required.
88 class OpSize { bit hasOpSizePrefix = 1; }
89 class AdSize { bit hasAdSizePrefix = 1; }
90 class REX_W { bit hasREX_WPrefix = 1; }
91 class LOCK { bit hasLockPrefix = 1; }
92 class SegFS { bits<2> SegOvrBits = 1; }
93 class SegGS { bits<2> SegOvrBits = 2; }
94 class TB { bits<5> Prefix = 1; }
95 class REP { bits<5> Prefix = 2; }
96 class D8 { bits<5> Prefix = 3; }
97 class D9 { bits<5> Prefix = 4; }
98 class DA { bits<5> Prefix = 5; }
99 class DB { bits<5> Prefix = 6; }
100 class DC { bits<5> Prefix = 7; }
101 class DD { bits<5> Prefix = 8; }
102 class DE { bits<5> Prefix = 9; }
103 class DF { bits<5> Prefix = 10; }
104 class XD { bits<5> Prefix = 11; }
105 class XS { bits<5> Prefix = 12; }
106 class T8 { bits<5> Prefix = 13; }
107 class TA { bits<5> Prefix = 14; }
108 class A6 { bits<5> Prefix = 15; }
109 class A7 { bits<5> Prefix = 16; }
110 class TF { bits<5> Prefix = 17; }
111 class VEX { bit hasVEXPrefix = 1; }
112 class VEX_W { bit hasVEX_WPrefix = 1; }
113 class VEX_4V : VEX { bit hasVEX_4VPrefix = 1; }
114 class VEX_I8IMM { bit hasVEX_i8ImmReg = 1; }
115 class VEX_L { bit hasVEX_L = 1; }
116 class Has3DNow0F0FOpcode { bit has3DNow0F0FOpcode = 1; }
118 class X86Inst<bits<8> opcod, Format f, ImmType i, dag outs, dag ins,
119 string AsmStr, Domain d = GenericDomain>
121 let Namespace = "X86";
123 bits<8> Opcode = opcod;
125 bits<6> FormBits = Form.Value;
128 dag OutOperandList = outs;
129 dag InOperandList = ins;
130 string AsmString = AsmStr;
132 // If this is a pseudo instruction, mark it isCodeGenOnly.
133 let isCodeGenOnly = !eq(!cast<string>(f), "Pseudo");
136 // Attributes specific to X86 instructions...
138 bit hasOpSizePrefix = 0; // Does this inst have a 0x66 prefix?
139 bit hasAdSizePrefix = 0; // Does this inst have a 0x67 prefix?
141 bits<5> Prefix = 0; // Which prefix byte does this inst have?
142 bit hasREX_WPrefix = 0; // Does this inst require the REX.W prefix?
143 FPFormat FPForm = NotFP; // What flavor of FP instruction is this?
144 bit hasLockPrefix = 0; // Does this inst have a 0xF0 prefix?
145 bits<2> SegOvrBits = 0; // Segment override prefix.
146 Domain ExeDomain = d;
147 bit hasVEXPrefix = 0; // Does this inst require a VEX prefix?
148 bit hasVEX_WPrefix = 0; // Does this inst set the VEX_W field?
149 bit hasVEX_4VPrefix = 0; // Does this inst require the VEX.VVVV field?
150 bit hasVEX_i8ImmReg = 0; // Does this inst require the last source register
151 // to be encoded in a immediate field?
152 bit hasVEX_L = 0; // Does this inst use large (256-bit) registers?
153 bit has3DNow0F0FOpcode =0;// Wacky 3dNow! encoding?
155 // TSFlags layout should be kept in sync with X86InstrInfo.h.
156 let TSFlags{5-0} = FormBits;
157 let TSFlags{6} = hasOpSizePrefix;
158 let TSFlags{7} = hasAdSizePrefix;
159 let TSFlags{12-8} = Prefix;
160 let TSFlags{13} = hasREX_WPrefix;
161 let TSFlags{16-14} = ImmT.Value;
162 let TSFlags{19-17} = FPForm.Value;
163 let TSFlags{20} = hasLockPrefix;
164 let TSFlags{22-21} = SegOvrBits;
165 let TSFlags{24-23} = ExeDomain.Value;
166 let TSFlags{32-25} = Opcode;
167 let TSFlags{33} = hasVEXPrefix;
168 let TSFlags{34} = hasVEX_WPrefix;
169 let TSFlags{35} = hasVEX_4VPrefix;
170 let TSFlags{36} = hasVEX_i8ImmReg;
171 let TSFlags{37} = hasVEX_L;
172 let TSFlags{38} = has3DNow0F0FOpcode;
175 class PseudoI<dag oops, dag iops, list<dag> pattern>
176 : X86Inst<0, Pseudo, NoImm, oops, iops, ""> {
177 let Pattern = pattern;
180 class I<bits<8> o, Format f, dag outs, dag ins, string asm,
181 list<dag> pattern, Domain d = GenericDomain>
182 : X86Inst<o, f, NoImm, outs, ins, asm, d> {
183 let Pattern = pattern;
186 class Ii8 <bits<8> o, Format f, dag outs, dag ins, string asm,
187 list<dag> pattern, Domain d = GenericDomain>
188 : X86Inst<o, f, Imm8, outs, ins, asm, d> {
189 let Pattern = pattern;
192 class Ii8PCRel<bits<8> o, Format f, dag outs, dag ins, string asm,
194 : X86Inst<o, f, Imm8PCRel, outs, ins, asm> {
195 let Pattern = pattern;
198 class Ii16<bits<8> o, Format f, dag outs, dag ins, string asm,
200 : X86Inst<o, f, Imm16, outs, ins, asm> {
201 let Pattern = pattern;
204 class Ii32<bits<8> o, Format f, dag outs, dag ins, string asm,
206 : X86Inst<o, f, Imm32, outs, ins, asm> {
207 let Pattern = pattern;
211 class Ii16PCRel<bits<8> o, Format f, dag outs, dag ins, string asm,
213 : X86Inst<o, f, Imm16PCRel, outs, ins, asm> {
214 let Pattern = pattern;
218 class Ii32PCRel<bits<8> o, Format f, dag outs, dag ins, string asm,
220 : X86Inst<o, f, Imm32PCRel, outs, ins, asm> {
221 let Pattern = pattern;
225 // FPStack Instruction Templates:
226 // FPI - Floating Point Instruction template.
227 class FPI<bits<8> o, Format F, dag outs, dag ins, string asm>
228 : I<o, F, outs, ins, asm, []> {}
230 // FpI_ - Floating Point Pseudo Instruction template. Not Predicated.
231 class FpI_<dag outs, dag ins, FPFormat fp, list<dag> pattern>
232 : X86Inst<0, Pseudo, NoImm, outs, ins, ""> {
234 let Pattern = pattern;
237 // Templates for instructions that use a 16- or 32-bit segmented address as
238 // their only operand: lcall (FAR CALL) and ljmp (FAR JMP)
240 // Iseg16 - 16-bit segment selector, 16-bit offset
241 // Iseg32 - 16-bit segment selector, 32-bit offset
243 class Iseg16 <bits<8> o, Format f, dag outs, dag ins, string asm,
244 list<dag> pattern> : X86Inst<o, f, Imm16, outs, ins, asm> {
245 let Pattern = pattern;
249 class Iseg32 <bits<8> o, Format f, dag outs, dag ins, string asm,
250 list<dag> pattern> : X86Inst<o, f, Imm32, outs, ins, asm> {
251 let Pattern = pattern;
255 // SI - SSE 1 & 2 scalar instructions
256 class SI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
257 : I<o, F, outs, ins, asm, pattern> {
258 let Predicates = !if(hasVEXPrefix /* VEX */, [HasAVX],
259 !if(!eq(Prefix, 12 /* XS */), [HasSSE1], [HasSSE2]));
261 // AVX instructions have a 'v' prefix in the mnemonic
262 let AsmString = !if(hasVEXPrefix, !strconcat("v", asm), asm);
265 // SIi8 - SSE 1 & 2 scalar instructions
266 class SIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
268 : Ii8<o, F, outs, ins, asm, pattern> {
269 let Predicates = !if(hasVEXPrefix /* VEX */, [HasAVX],
270 !if(!eq(Prefix, 12 /* XS */), [HasSSE1], [HasSSE2]));
272 // AVX instructions have a 'v' prefix in the mnemonic
273 let AsmString = !if(hasVEXPrefix, !strconcat("v", asm), asm);
276 // PI - SSE 1 & 2 packed instructions
277 class PI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern,
279 : I<o, F, outs, ins, asm, pattern, d> {
280 let Predicates = !if(hasVEXPrefix /* VEX */, [HasAVX],
281 !if(hasOpSizePrefix /* OpSize */, [HasSSE2], [HasSSE1]));
283 // AVX instructions have a 'v' prefix in the mnemonic
284 let AsmString = !if(hasVEXPrefix, !strconcat("v", asm), asm);
287 // PIi8 - SSE 1 & 2 packed instructions with immediate
288 class PIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
289 list<dag> pattern, Domain d>
290 : Ii8<o, F, outs, ins, asm, pattern, d> {
291 let Predicates = !if(hasVEX_4VPrefix /* VEX */, [HasAVX],
292 !if(hasOpSizePrefix /* OpSize */, [HasSSE2], [HasSSE1]));
294 // AVX instructions have a 'v' prefix in the mnemonic
295 let AsmString = !if(hasVEX_4VPrefix, !strconcat("v", asm), asm);
298 // SSE1 Instruction Templates:
300 // SSI - SSE1 instructions with XS prefix.
301 // PSI - SSE1 instructions with TB prefix.
302 // PSIi8 - SSE1 instructions with ImmT == Imm8 and TB prefix.
303 // VSSI - SSE1 instructions with XS prefix in AVX form.
304 // VPSI - SSE1 instructions with TB prefix in AVX form.
306 class SSI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
307 : I<o, F, outs, ins, asm, pattern>, XS, Requires<[HasSSE1]>;
308 class SSIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
310 : Ii8<o, F, outs, ins, asm, pattern>, XS, Requires<[HasSSE1]>;
311 class PSI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
312 : I<o, F, outs, ins, asm, pattern, SSEPackedSingle>, TB,
314 class PSIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
316 : Ii8<o, F, outs, ins, asm, pattern, SSEPackedSingle>, TB,
318 class VSSI<bits<8> o, Format F, dag outs, dag ins, string asm,
320 : I<o, F, outs, ins, !strconcat("v", asm), pattern>, XS,
322 class VPSI<bits<8> o, Format F, dag outs, dag ins, string asm,
324 : I<o, F, outs, ins, !strconcat("v", asm), pattern, SSEPackedSingle>, TB,
327 // SSE2 Instruction Templates:
329 // SDI - SSE2 instructions with XD prefix.
330 // SDIi8 - SSE2 instructions with ImmT == Imm8 and XD prefix.
331 // SSDIi8 - SSE2 instructions with ImmT == Imm8 and XS prefix.
332 // PDI - SSE2 instructions with TB and OpSize prefixes.
333 // PDIi8 - SSE2 instructions with ImmT == Imm8 and TB and OpSize prefixes.
334 // VSDI - SSE2 instructions with XD prefix in AVX form.
335 // VPDI - SSE2 instructions with TB and OpSize prefixes in AVX form.
337 class SDI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
338 : I<o, F, outs, ins, asm, pattern>, XD, Requires<[HasSSE2]>;
339 class SDIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
341 : Ii8<o, F, outs, ins, asm, pattern>, XD, Requires<[HasSSE2]>;
342 class SSDIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
344 : Ii8<o, F, outs, ins, asm, pattern>, XS, Requires<[HasSSE2]>;
345 class PDI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
346 : I<o, F, outs, ins, asm, pattern, SSEPackedDouble>, TB, OpSize,
348 class PDIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
350 : Ii8<o, F, outs, ins, asm, pattern, SSEPackedDouble>, TB, OpSize,
352 class VSDI<bits<8> o, Format F, dag outs, dag ins, string asm,
354 : I<o, F, outs, ins, !strconcat("v", asm), pattern>, XD,
356 class VPDI<bits<8> o, Format F, dag outs, dag ins, string asm,
358 : I<o, F, outs, ins, !strconcat("v", asm), pattern, SSEPackedDouble>, TB,
359 OpSize, Requires<[HasAVX]>;
361 // SSE3 Instruction Templates:
363 // S3I - SSE3 instructions with TB and OpSize prefixes.
364 // S3SI - SSE3 instructions with XS prefix.
365 // S3DI - SSE3 instructions with XD prefix.
367 class S3SI<bits<8> o, Format F, dag outs, dag ins, string asm,
369 : I<o, F, outs, ins, asm, pattern, SSEPackedSingle>, XS,
371 class S3DI<bits<8> o, Format F, dag outs, dag ins, string asm,
373 : I<o, F, outs, ins, asm, pattern, SSEPackedDouble>, XD,
375 class S3I<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
376 : I<o, F, outs, ins, asm, pattern, SSEPackedDouble>, TB, OpSize,
380 // SSSE3 Instruction Templates:
382 // SS38I - SSSE3 instructions with T8 prefix.
383 // SS3AI - SSSE3 instructions with TA prefix.
385 // Note: SSSE3 instructions have 64-bit and 128-bit versions. The 64-bit version
386 // uses the MMX registers. We put those instructions here because they better
387 // fit into the SSSE3 instruction category rather than the MMX category.
389 class SS38I<bits<8> o, Format F, dag outs, dag ins, string asm,
391 : Ii8<o, F, outs, ins, asm, pattern, SSEPackedInt>, T8,
392 Requires<[HasSSSE3]>;
393 class SS3AI<bits<8> o, Format F, dag outs, dag ins, string asm,
395 : Ii8<o, F, outs, ins, asm, pattern, SSEPackedInt>, TA,
396 Requires<[HasSSSE3]>;
398 // SSE4.1 Instruction Templates:
400 // SS48I - SSE 4.1 instructions with T8 prefix.
401 // SS41AIi8 - SSE 4.1 instructions with TA prefix and ImmT == Imm8.
403 class SS48I<bits<8> o, Format F, dag outs, dag ins, string asm,
405 : I<o, F, outs, ins, asm, pattern, SSEPackedInt>, T8,
406 Requires<[HasSSE41]>;
407 class SS4AIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
409 : Ii8<o, F, outs, ins, asm, pattern, SSEPackedInt>, TA,
410 Requires<[HasSSE41]>;
412 // SSE4.2 Instruction Templates:
414 // SS428I - SSE 4.2 instructions with T8 prefix.
415 class SS428I<bits<8> o, Format F, dag outs, dag ins, string asm,
417 : I<o, F, outs, ins, asm, pattern, SSEPackedInt>, T8,
418 Requires<[HasSSE42]>;
420 // SS42FI - SSE 4.2 instructions with TF prefix.
421 class SS42FI<bits<8> o, Format F, dag outs, dag ins, string asm,
423 : I<o, F, outs, ins, asm, pattern>, TF, Requires<[HasSSE42]>;
425 // SS42AI = SSE 4.2 instructions with TA prefix
426 class SS42AI<bits<8> o, Format F, dag outs, dag ins, string asm,
428 : Ii8<o, F, outs, ins, asm, pattern, SSEPackedInt>, TA,
429 Requires<[HasSSE42]>;
431 // AVX Instruction Templates:
432 // Instructions introduced in AVX (no SSE equivalent forms)
434 // AVX8I - AVX instructions with T8 and OpSize prefix.
435 // AVXAIi8 - AVX instructions with TA, OpSize prefix and ImmT = Imm8.
436 class AVX8I<bits<8> o, Format F, dag outs, dag ins, string asm,
438 : I<o, F, outs, ins, asm, pattern, SSEPackedInt>, T8, OpSize,
440 class AVXAIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
442 : Ii8<o, F, outs, ins, asm, pattern, SSEPackedInt>, TA, OpSize,
445 // AES Instruction Templates:
448 // These use the same encoding as the SSE4.2 T8 and TA encodings.
449 class AES8I<bits<8> o, Format F, dag outs, dag ins, string asm,
451 : I<o, F, outs, ins, asm, pattern, SSEPackedInt>, T8,
454 class AESAI<bits<8> o, Format F, dag outs, dag ins, string asm,
456 : Ii8<o, F, outs, ins, asm, pattern, SSEPackedInt>, TA,
459 // CLMUL Instruction Templates
460 class CLMULIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
462 : Ii8<o, F, outs, ins, asm, pattern, SSEPackedInt>, TA,
463 OpSize, VEX_4V, Requires<[HasAVX, HasCLMUL]>;
465 // FMA3 Instruction Templates
466 class FMA3<bits<8> o, Format F, dag outs, dag ins, string asm,
468 : I<o, F, outs, ins, asm, pattern, SSEPackedInt>, T8,
469 OpSize, VEX_4V, Requires<[HasFMA3]>;
471 // X86-64 Instruction templates...
474 class RI<bits<8> o, Format F, dag outs, dag ins, string asm, list<dag> pattern>
475 : I<o, F, outs, ins, asm, pattern>, REX_W;
476 class RIi8 <bits<8> o, Format F, dag outs, dag ins, string asm,
478 : Ii8<o, F, outs, ins, asm, pattern>, REX_W;
479 class RIi32 <bits<8> o, Format F, dag outs, dag ins, string asm,
481 : Ii32<o, F, outs, ins, asm, pattern>, REX_W;
483 class RIi64<bits<8> o, Format f, dag outs, dag ins, string asm,
485 : X86Inst<o, f, Imm64, outs, ins, asm>, REX_W {
486 let Pattern = pattern;
490 class RSSI<bits<8> o, Format F, dag outs, dag ins, string asm,
492 : SSI<o, F, outs, ins, asm, pattern>, REX_W;
493 class RSDI<bits<8> o, Format F, dag outs, dag ins, string asm,
495 : SDI<o, F, outs, ins, asm, pattern>, REX_W;
496 class RPDI<bits<8> o, Format F, dag outs, dag ins, string asm,
498 : PDI<o, F, outs, ins, asm, pattern>, REX_W;
500 // MMX Instruction templates
503 // MMXI - MMX instructions with TB prefix.
504 // MMXI64 - MMX instructions with TB prefix valid only in 64 bit mode.
505 // MMX2I - MMX / SSE2 instructions with TB and OpSize prefixes.
506 // MMXIi8 - MMX instructions with ImmT == Imm8 and TB prefix.
507 // MMXIi8 - MMX instructions with ImmT == Imm8 and TB prefix.
508 // MMXID - MMX instructions with XD prefix.
509 // MMXIS - MMX instructions with XS prefix.
510 class MMXI<bits<8> o, Format F, dag outs, dag ins, string asm,
512 : I<o, F, outs, ins, asm, pattern>, TB, Requires<[HasMMX]>;
513 class MMXI64<bits<8> o, Format F, dag outs, dag ins, string asm,
515 : I<o, F, outs, ins, asm, pattern>, TB, Requires<[HasMMX,In64BitMode]>;
516 class MMXRI<bits<8> o, Format F, dag outs, dag ins, string asm,
518 : I<o, F, outs, ins, asm, pattern>, TB, REX_W, Requires<[HasMMX]>;
519 class MMX2I<bits<8> o, Format F, dag outs, dag ins, string asm,
521 : I<o, F, outs, ins, asm, pattern>, TB, OpSize, Requires<[HasMMX]>;
522 class MMXIi8<bits<8> o, Format F, dag outs, dag ins, string asm,
524 : Ii8<o, F, outs, ins, asm, pattern>, TB, Requires<[HasMMX]>;
525 class MMXID<bits<8> o, Format F, dag outs, dag ins, string asm,
527 : Ii8<o, F, outs, ins, asm, pattern>, XD, Requires<[HasMMX]>;
528 class MMXIS<bits<8> o, Format F, dag outs, dag ins, string asm,
530 : Ii8<o, F, outs, ins, asm, pattern>, XS, Requires<[HasMMX]>;