1 //===-- X86BaseInfo.h - Top level definitions for X86 -------- --*- C++ -*-===//
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 // This file contains small standalone helper functions and enum definitions for
11 // the X86 target useful for the compiler back-end and the MC libraries.
12 // As such, it deliberately does not include references to LLVM core
13 // code gen types, passes, etc..
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_LIB_TARGET_X86_MCTARGETDESC_X86BASEINFO_H
18 #define LLVM_LIB_TARGET_X86_MCTARGETDESC_X86BASEINFO_H
20 #include "X86MCTargetDesc.h"
21 #include "llvm/MC/MCInstrDesc.h"
22 #include "llvm/Support/DataTypes.h"
23 #include "llvm/Support/ErrorHandling.h"
28 // Enums for memory operand decoding. Each memory operand is represented with
29 // a 5 operand sequence in the form:
30 // [BaseReg, ScaleAmt, IndexReg, Disp, Segment]
31 // These enums help decode this.
38 /// AddrSegmentReg - The operand # of the segment in the memory operand.
41 /// AddrNumOperands - Total number of operands in a memory reference.
46 /// X86II - This namespace holds all of the target specific flags that
47 /// instruction info tracks.
50 /// Target Operand Flag enum.
52 //===------------------------------------------------------------------===//
53 // X86 Specific MachineOperand flags.
57 /// MO_GOT_ABSOLUTE_ADDRESS - On a symbol operand, this represents a
59 /// SYMBOL_LABEL + [. - PICBASELABEL]
60 MO_GOT_ABSOLUTE_ADDRESS,
62 /// MO_PIC_BASE_OFFSET - On a symbol operand this indicates that the
63 /// immediate should get the value of the symbol minus the PIC base label:
64 /// SYMBOL_LABEL - PICBASELABEL
67 /// MO_GOT - On a symbol operand this indicates that the immediate is the
68 /// offset to the GOT entry for the symbol name from the base of the GOT.
70 /// See the X86-64 ELF ABI supplement for more details.
74 /// MO_GOTOFF - On a symbol operand this indicates that the immediate is
75 /// the offset to the location of the symbol name from the base of the GOT.
77 /// See the X86-64 ELF ABI supplement for more details.
78 /// SYMBOL_LABEL @GOTOFF
81 /// MO_GOTPCREL - On a symbol operand this indicates that the immediate is
82 /// offset to the GOT entry for the symbol name from the current code
85 /// See the X86-64 ELF ABI supplement for more details.
86 /// SYMBOL_LABEL @GOTPCREL
89 /// MO_PLT - On a symbol operand this indicates that the immediate is
90 /// offset to the PLT entry of symbol name from the current code location.
92 /// See the X86-64 ELF ABI supplement for more details.
96 /// MO_TLSGD - On a symbol operand this indicates that the immediate is
97 /// the offset of the GOT entry with the TLS index structure that contains
98 /// the module number and variable offset for the symbol. Used in the
99 /// general dynamic TLS access model.
101 /// See 'ELF Handling for Thread-Local Storage' for more details.
102 /// SYMBOL_LABEL @TLSGD
105 /// MO_TLSLD - On a symbol operand this indicates that the immediate is
106 /// the offset of the GOT entry with the TLS index for the module that
107 /// contains the symbol. When this index is passed to a call to
108 /// __tls_get_addr, the function will return the base address of the TLS
109 /// block for the symbol. Used in the x86-64 local dynamic TLS access model.
111 /// See 'ELF Handling for Thread-Local Storage' for more details.
112 /// SYMBOL_LABEL @TLSLD
115 /// MO_TLSLDM - On a symbol operand this indicates that the immediate is
116 /// the offset of the GOT entry with the TLS index for the module that
117 /// contains the symbol. When this index is passed to a call to
118 /// ___tls_get_addr, the function will return the base address of the TLS
119 /// block for the symbol. Used in the IA32 local dynamic TLS access model.
121 /// See 'ELF Handling for Thread-Local Storage' for more details.
122 /// SYMBOL_LABEL @TLSLDM
125 /// MO_GOTTPOFF - On a symbol operand this indicates that the immediate is
126 /// the offset of the GOT entry with the thread-pointer offset for the
127 /// symbol. Used in the x86-64 initial exec TLS access model.
129 /// See 'ELF Handling for Thread-Local Storage' for more details.
130 /// SYMBOL_LABEL @GOTTPOFF
133 /// MO_INDNTPOFF - On a symbol operand this indicates that the immediate is
134 /// the absolute address of the GOT entry with the negative thread-pointer
135 /// offset for the symbol. Used in the non-PIC IA32 initial exec TLS access
138 /// See 'ELF Handling for Thread-Local Storage' for more details.
139 /// SYMBOL_LABEL @INDNTPOFF
142 /// MO_TPOFF - On a symbol operand this indicates that the immediate is
143 /// the thread-pointer offset for the symbol. Used in the x86-64 local
144 /// exec TLS access model.
146 /// See 'ELF Handling for Thread-Local Storage' for more details.
147 /// SYMBOL_LABEL @TPOFF
150 /// MO_DTPOFF - On a symbol operand this indicates that the immediate is
151 /// the offset of the GOT entry with the TLS offset of the symbol. Used
152 /// in the local dynamic TLS access model.
154 /// See 'ELF Handling for Thread-Local Storage' for more details.
155 /// SYMBOL_LABEL @DTPOFF
158 /// MO_NTPOFF - On a symbol operand this indicates that the immediate is
159 /// the negative thread-pointer offset for the symbol. Used in the IA32
160 /// local exec TLS access model.
162 /// See 'ELF Handling for Thread-Local Storage' for more details.
163 /// SYMBOL_LABEL @NTPOFF
166 /// MO_GOTNTPOFF - On a symbol operand this indicates that the immediate is
167 /// the offset of the GOT entry with the negative thread-pointer offset for
168 /// the symbol. Used in the PIC IA32 initial exec TLS access model.
170 /// See 'ELF Handling for Thread-Local Storage' for more details.
171 /// SYMBOL_LABEL @GOTNTPOFF
174 /// MO_DLLIMPORT - On a symbol operand "FOO", this indicates that the
175 /// reference is actually to the "__imp_FOO" symbol. This is used for
176 /// dllimport linkage on windows.
179 /// MO_DARWIN_STUB - On a symbol operand "FOO", this indicates that the
180 /// reference is actually to the "FOO$stub" symbol. This is used for calls
181 /// and jumps to external functions on Tiger and earlier.
184 /// MO_DARWIN_NONLAZY - On a symbol operand "FOO", this indicates that the
185 /// reference is actually to the "FOO$non_lazy_ptr" symbol, which is a
186 /// non-PIC-base-relative reference to a non-hidden dyld lazy pointer stub.
189 /// MO_DARWIN_NONLAZY_PIC_BASE - On a symbol operand "FOO", this indicates
190 /// that the reference is actually to "FOO$non_lazy_ptr - PICBASE", which is
191 /// a PIC-base-relative reference to a non-hidden dyld lazy pointer stub.
192 MO_DARWIN_NONLAZY_PIC_BASE,
194 /// MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE - On a symbol operand "FOO", this
195 /// indicates that the reference is actually to "FOO$non_lazy_ptr -PICBASE",
196 /// which is a PIC-base-relative reference to a hidden dyld lazy pointer
198 MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE,
200 /// MO_TLVP - On a symbol operand this indicates that the immediate is
203 /// This is the TLS offset for the Darwin TLS mechanism.
206 /// MO_TLVP_PIC_BASE - On a symbol operand this indicates that the immediate
207 /// is some TLS offset from the picbase.
209 /// This is the 32-bit TLS offset for Darwin TLS in PIC mode.
212 /// MO_SECREL - On a symbol operand this indicates that the immediate is
213 /// the offset from beginning of section.
215 /// This is the TLS offset for the COFF/Windows TLS mechanism.
218 /// MO_NOPREFIX - On a symbol operand this indicates that the symbol should
219 /// not be mangled with a prefix.
224 //===------------------------------------------------------------------===//
225 // Instruction encodings. These are the standard/most common forms for X86
229 // PseudoFrm - This represents an instruction that is a pseudo instruction
230 // or one that has not been implemented yet. It is illegal to code generate
231 // it, but tolerated for intermediate implementation stages.
234 /// Raw - This form is for instructions that don't have any operands, so
235 /// they are just a fixed opcode value, like 'leave'.
238 /// AddRegFrm - This form is used for instructions like 'push r32' that have
239 /// their one register operand added to their opcode.
242 /// MRMDestReg - This form is used for instructions that use the Mod/RM byte
243 /// to specify a destination, which in this case is a register.
247 /// MRMDestMem - This form is used for instructions that use the Mod/RM byte
248 /// to specify a destination, which in this case is memory.
252 /// MRMSrcReg - This form is used for instructions that use the Mod/RM byte
253 /// to specify a source, which in this case is a register.
257 /// MRMSrcMem - This form is used for instructions that use the Mod/RM byte
258 /// to specify a source, which in this case is memory.
262 /// RawFrmMemOffs - This form is for instructions that store an absolute
263 /// memory offset as an immediate with a possible segment override.
266 /// RawFrmSrc - This form is for instructions that use the source index
267 /// register SI/ESI/RSI with a possible segment override.
270 /// RawFrmDst - This form is for instructions that use the destination index
271 /// register DI/EDI/ESI.
274 /// RawFrmSrc - This form is for instructions that use the source index
275 /// register SI/ESI/ERI with a possible segment override, and also the
276 /// destination index register DI/ESI/RDI.
279 /// RawFrmImm8 - This is used for the ENTER instruction, which has two
280 /// immediates, the first of which is a 16-bit immediate (specified by
281 /// the imm encoding) and the second is a 8-bit fixed value.
284 /// RawFrmImm16 - This is used for CALL FAR instructions, which have two
285 /// immediates, the first of which is a 16 or 32-bit immediate (specified by
286 /// the imm encoding) and the second is a 16-bit fixed value. In the AMD
287 /// manual, this operand is described as pntr16:32 and pntr16:16
290 /// MRMX[rm] - The forms are used to represent instructions that use a
291 /// Mod/RM byte, and don't use the middle field for anything.
292 MRMXr = 14, MRMXm = 15,
294 /// MRM[0-7][rm] - These forms are used to represent instructions that use
295 /// a Mod/RM byte, and use the middle field to hold extended opcode
296 /// information. In the intel manual these are represented as /0, /1, ...
299 // First, instructions that operate on a register r/m operand...
300 MRM0r = 16, MRM1r = 17, MRM2r = 18, MRM3r = 19, // Format /0 /1 /2 /3
301 MRM4r = 20, MRM5r = 21, MRM6r = 22, MRM7r = 23, // Format /4 /5 /6 /7
303 // Next, instructions that operate on a memory r/m operand...
304 MRM0m = 24, MRM1m = 25, MRM2m = 26, MRM3m = 27, // Format /0 /1 /2 /3
305 MRM4m = 28, MRM5m = 29, MRM6m = 30, MRM7m = 31, // Format /4 /5 /6 /7
307 //// MRM_XX - A mod/rm byte of exactly 0xXX.
308 MRM_C0 = 32, MRM_C1 = 33, MRM_C2 = 34, MRM_C3 = 35,
309 MRM_C4 = 36, MRM_C5 = 37, MRM_C6 = 38, MRM_C7 = 39,
310 MRM_C8 = 40, MRM_C9 = 41, MRM_CA = 42, MRM_CB = 43,
311 MRM_CC = 44, MRM_CD = 45, MRM_CE = 46, MRM_CF = 47,
312 MRM_D0 = 48, MRM_D1 = 49, MRM_D2 = 50, MRM_D3 = 51,
313 MRM_D4 = 52, MRM_D5 = 53, MRM_D6 = 54, MRM_D7 = 55,
314 MRM_D8 = 56, MRM_D9 = 57, MRM_DA = 58, MRM_DB = 59,
315 MRM_DC = 60, MRM_DD = 61, MRM_DE = 62, MRM_DF = 63,
316 MRM_E0 = 64, MRM_E1 = 65, MRM_E2 = 66, MRM_E3 = 67,
317 MRM_E4 = 68, MRM_E5 = 69, MRM_E6 = 70, MRM_E7 = 71,
318 MRM_E8 = 72, MRM_E9 = 73, MRM_EA = 74, MRM_EB = 75,
319 MRM_EC = 76, MRM_ED = 77, MRM_EE = 78, MRM_EF = 79,
320 MRM_F0 = 80, MRM_F1 = 81, MRM_F2 = 82, MRM_F3 = 83,
321 MRM_F4 = 84, MRM_F5 = 85, MRM_F6 = 86, MRM_F7 = 87,
322 MRM_F8 = 88, MRM_F9 = 89, MRM_FA = 90, MRM_FB = 91,
323 MRM_FC = 92, MRM_FD = 93, MRM_FE = 94, MRM_FF = 95,
327 //===------------------------------------------------------------------===//
330 // OpSize - OpSizeFixed implies instruction never needs a 0x66 prefix.
331 // OpSize16 means this is a 16-bit instruction and needs 0x66 prefix in
332 // 32-bit mode. OpSize32 means this is a 32-bit instruction needs a 0x66
333 // prefix in 16-bit mode.
335 OpSizeMask = 0x3 << OpSizeShift,
337 OpSizeFixed = 0 << OpSizeShift,
338 OpSize16 = 1 << OpSizeShift,
339 OpSize32 = 2 << OpSizeShift,
341 // AsSize - AdSizeX implies this instruction determines its need of 0x67
342 // prefix from a normal ModRM memory operand. The other types indicate that
343 // an operand is encoded with a specific width and a prefix is needed if
344 // it differs from the current mode.
345 AdSizeShift = OpSizeShift + 2,
346 AdSizeMask = 0x3 << AdSizeShift,
348 AdSizeX = 1 << AdSizeShift,
349 AdSize16 = 1 << AdSizeShift,
350 AdSize32 = 2 << AdSizeShift,
351 AdSize64 = 3 << AdSizeShift,
353 //===------------------------------------------------------------------===//
354 // OpPrefix - There are several prefix bytes that are used as opcode
355 // extensions. These are 0x66, 0xF3, and 0xF2. If this field is 0 there is
358 OpPrefixShift = AdSizeShift + 2,
359 OpPrefixMask = 0x7 << OpPrefixShift,
361 // PS, PD - Prefix code for packed single and double precision vector
362 // floating point operations performed in the SSE registers.
363 PS = 1 << OpPrefixShift, PD = 2 << OpPrefixShift,
365 // XS, XD - These prefix codes are for single and double precision scalar
366 // floating point operations performed in the SSE registers.
367 XS = 3 << OpPrefixShift, XD = 4 << OpPrefixShift,
369 //===------------------------------------------------------------------===//
370 // OpMap - This field determines which opcode map this instruction
371 // belongs to. i.e. one-byte, two-byte, 0x0f 0x38, 0x0f 0x3a, etc.
373 OpMapShift = OpPrefixShift + 3,
374 OpMapMask = 0x7 << OpMapShift,
376 // OB - OneByte - Set if this instruction has a one byte opcode.
377 OB = 0 << OpMapShift,
379 // TB - TwoByte - Set if this instruction has a two byte opcode, which
380 // starts with a 0x0F byte before the real opcode.
381 TB = 1 << OpMapShift,
383 // T8, TA - Prefix after the 0x0F prefix.
384 T8 = 2 << OpMapShift, TA = 3 << OpMapShift,
386 // XOP8 - Prefix to include use of imm byte.
387 XOP8 = 4 << OpMapShift,
389 // XOP9 - Prefix to exclude use of imm byte.
390 XOP9 = 5 << OpMapShift,
392 // XOPA - Prefix to encode 0xA in VEX.MMMM of XOP instructions.
393 XOPA = 6 << OpMapShift,
395 //===------------------------------------------------------------------===//
396 // REX_W - REX prefixes are instruction prefixes used in 64-bit mode.
397 // They are used to specify GPRs and SSE registers, 64-bit operand size,
398 // etc. We only cares about REX.W and REX.R bits and only the former is
399 // statically determined.
401 REXShift = OpMapShift + 3,
402 REX_W = 1 << REXShift,
404 //===------------------------------------------------------------------===//
405 // This three-bit field describes the size of an immediate operand. Zero is
406 // unused so that we can tell if we forgot to set a value.
407 ImmShift = REXShift + 1,
408 ImmMask = 15 << ImmShift,
409 Imm8 = 1 << ImmShift,
410 Imm8PCRel = 2 << ImmShift,
411 Imm16 = 3 << ImmShift,
412 Imm16PCRel = 4 << ImmShift,
413 Imm32 = 5 << ImmShift,
414 Imm32PCRel = 6 << ImmShift,
415 Imm32S = 7 << ImmShift,
416 Imm64 = 8 << ImmShift,
418 //===------------------------------------------------------------------===//
419 // FP Instruction Classification... Zero is non-fp instruction.
421 // FPTypeMask - Mask for all of the FP types...
422 FPTypeShift = ImmShift + 4,
423 FPTypeMask = 7 << FPTypeShift,
425 // NotFP - The default, set for instructions that do not use FP registers.
426 NotFP = 0 << FPTypeShift,
428 // ZeroArgFP - 0 arg FP instruction which implicitly pushes ST(0), f.e. fld0
429 ZeroArgFP = 1 << FPTypeShift,
431 // OneArgFP - 1 arg FP instructions which implicitly read ST(0), such as fst
432 OneArgFP = 2 << FPTypeShift,
434 // OneArgFPRW - 1 arg FP instruction which implicitly read ST(0) and write a
435 // result back to ST(0). For example, fcos, fsqrt, etc.
437 OneArgFPRW = 3 << FPTypeShift,
439 // TwoArgFP - 2 arg FP instructions which implicitly read ST(0), and an
440 // explicit argument, storing the result to either ST(0) or the implicit
441 // argument. For example: fadd, fsub, fmul, etc...
442 TwoArgFP = 4 << FPTypeShift,
444 // CompareFP - 2 arg FP instructions which implicitly read ST(0) and an
445 // explicit argument, but have no destination. Example: fucom, fucomi, ...
446 CompareFP = 5 << FPTypeShift,
448 // CondMovFP - "2 operand" floating point conditional move instructions.
449 CondMovFP = 6 << FPTypeShift,
451 // SpecialFP - Special instruction forms. Dispatch by opcode explicitly.
452 SpecialFP = 7 << FPTypeShift,
455 LOCKShift = FPTypeShift + 3,
456 LOCK = 1 << LOCKShift,
459 REPShift = LOCKShift + 1,
462 // Execution domain for SSE instructions.
463 // 0 means normal, non-SSE instruction.
464 SSEDomainShift = REPShift + 1,
467 EncodingShift = SSEDomainShift + 2,
468 EncodingMask = 0x3 << EncodingShift,
470 // VEX - encoding using 0xC4/0xC5
471 VEX = 1 << EncodingShift,
473 /// XOP - Opcode prefix used by XOP instructions.
474 XOP = 2 << EncodingShift,
476 // VEX_EVEX - Specifies that this instruction use EVEX form which provides
477 // syntax support up to 32 512-bit register operands and up to 7 16-bit
478 // mask operands as well as source operand data swizzling/memory operand
479 // conversion, eviction hint, and rounding mode.
480 EVEX = 3 << EncodingShift,
483 OpcodeShift = EncodingShift + 2,
485 /// VEX_W - Has a opcode specific functionality, but is used in the same
486 /// way as REX_W is for regular SSE instructions.
487 VEX_WShift = OpcodeShift + 8,
488 VEX_W = 1ULL << VEX_WShift,
490 /// VEX_4V - Used to specify an additional AVX/SSE register. Several 2
491 /// address instructions in SSE are represented as 3 address ones in AVX
492 /// and the additional register is encoded in VEX_VVVV prefix.
493 VEX_4VShift = VEX_WShift + 1,
494 VEX_4V = 1ULL << VEX_4VShift,
496 /// VEX_4VOp3 - Similar to VEX_4V, but used on instructions that encode
497 /// operand 3 with VEX.vvvv.
498 VEX_4VOp3Shift = VEX_4VShift + 1,
499 VEX_4VOp3 = 1ULL << VEX_4VOp3Shift,
501 /// VEX_I8IMM - Specifies that the last register used in a AVX instruction,
502 /// must be encoded in the i8 immediate field. This usually happens in
503 /// instructions with 4 operands.
504 VEX_I8IMMShift = VEX_4VOp3Shift + 1,
505 VEX_I8IMM = 1ULL << VEX_I8IMMShift,
507 /// VEX_L - Stands for a bit in the VEX opcode prefix meaning the current
508 /// instruction uses 256-bit wide registers. This is usually auto detected
509 /// if a VR256 register is used, but some AVX instructions also have this
510 /// field marked when using a f256 memory references.
511 VEX_LShift = VEX_I8IMMShift + 1,
512 VEX_L = 1ULL << VEX_LShift,
514 // VEX_LIG - Specifies that this instruction ignores the L-bit in the VEX
515 // prefix. Usually used for scalar instructions. Needed by disassembler.
516 VEX_LIGShift = VEX_LShift + 1,
517 VEX_LIG = 1ULL << VEX_LIGShift,
519 // TODO: we should combine VEX_L and VEX_LIG together to form a 2-bit field
520 // with following encoding:
524 // - 11 LIG (but, in insn encoding, leave VEX.L and EVEX.L in zeros.
525 // this will save 1 tsflag bit
527 // EVEX_K - Set if this instruction requires masking
528 EVEX_KShift = VEX_LIGShift + 1,
529 EVEX_K = 1ULL << EVEX_KShift,
531 // EVEX_Z - Set if this instruction has EVEX.Z field set.
532 EVEX_ZShift = EVEX_KShift + 1,
533 EVEX_Z = 1ULL << EVEX_ZShift,
535 // EVEX_L2 - Set if this instruction has EVEX.L' field set.
536 EVEX_L2Shift = EVEX_ZShift + 1,
537 EVEX_L2 = 1ULL << EVEX_L2Shift,
539 // EVEX_B - Set if this instruction has EVEX.B field set.
540 EVEX_BShift = EVEX_L2Shift + 1,
541 EVEX_B = 1ULL << EVEX_BShift,
543 // The scaling factor for the AVX512's 8-bit compressed displacement.
544 CD8_Scale_Shift = EVEX_BShift + 1,
545 CD8_Scale_Mask = 127ULL << CD8_Scale_Shift,
547 /// Has3DNow0F0FOpcode - This flag indicates that the instruction uses the
548 /// wacky 0x0F 0x0F prefix for 3DNow! instructions. The manual documents
549 /// this as having a 0x0F prefix with a 0x0F opcode, and each instruction
550 /// storing a classifier in the imm8 field. To simplify our implementation,
551 /// we handle this by storeing the classifier in the opcode field and using
552 /// this flag to indicate that the encoder should do the wacky 3DNow! thing.
553 Has3DNow0F0FOpcodeShift = CD8_Scale_Shift + 7,
554 Has3DNow0F0FOpcode = 1ULL << Has3DNow0F0FOpcodeShift,
556 /// MemOp4 - Used to indicate swapping of operand 3 and 4 to be encoded in
557 /// ModRM or I8IMM. This is used for FMA4 and XOP instructions.
558 MemOp4Shift = Has3DNow0F0FOpcodeShift + 1,
559 MemOp4 = 1ULL << MemOp4Shift,
561 /// Explicitly specified rounding control
562 EVEX_RCShift = MemOp4Shift + 1,
563 EVEX_RC = 1ULL << EVEX_RCShift
566 // getBaseOpcodeFor - This function returns the "base" X86 opcode for the
567 // specified machine instruction.
569 inline unsigned char getBaseOpcodeFor(uint64_t TSFlags) {
570 return TSFlags >> X86II::OpcodeShift;
573 inline bool hasImm(uint64_t TSFlags) {
574 return (TSFlags & X86II::ImmMask) != 0;
577 /// getSizeOfImm - Decode the "size of immediate" field from the TSFlags field
578 /// of the specified instruction.
579 inline unsigned getSizeOfImm(uint64_t TSFlags) {
580 switch (TSFlags & X86II::ImmMask) {
581 default: llvm_unreachable("Unknown immediate size");
583 case X86II::Imm8PCRel: return 1;
585 case X86II::Imm16PCRel: return 2;
588 case X86II::Imm32PCRel: return 4;
589 case X86II::Imm64: return 8;
593 /// isImmPCRel - Return true if the immediate of the specified instruction's
594 /// TSFlags indicates that it is pc relative.
595 inline unsigned isImmPCRel(uint64_t TSFlags) {
596 switch (TSFlags & X86II::ImmMask) {
597 default: llvm_unreachable("Unknown immediate size");
598 case X86II::Imm8PCRel:
599 case X86II::Imm16PCRel:
600 case X86II::Imm32PCRel:
611 /// isImmSigned - Return true if the immediate of the specified instruction's
612 /// TSFlags indicates that it is signed.
613 inline unsigned isImmSigned(uint64_t TSFlags) {
614 switch (TSFlags & X86II::ImmMask) {
615 default: llvm_unreachable("Unknown immediate signedness");
619 case X86II::Imm8PCRel:
621 case X86II::Imm16PCRel:
623 case X86II::Imm32PCRel:
629 /// getOperandBias - compute any additional adjustment needed to
630 /// the offset to the start of the memory operand
631 /// in this instruction.
632 /// If this is a two-address instruction,skip one of the register operands.
633 /// FIXME: This should be handled during MCInst lowering.
634 inline int getOperandBias(const MCInstrDesc& Desc)
636 unsigned NumOps = Desc.getNumOperands();
638 if (NumOps > 1 && Desc.getOperandConstraint(1, MCOI::TIED_TO) == 0)
640 else if (NumOps > 3 && Desc.getOperandConstraint(2, MCOI::TIED_TO) == 0 &&
641 Desc.getOperandConstraint(3, MCOI::TIED_TO) == 1)
642 // Special case for AVX-512 GATHER with 2 TIED_TO operands
643 // Skip the first 2 operands: dst, mask_wb
645 else if (NumOps > 3 && Desc.getOperandConstraint(2, MCOI::TIED_TO) == 0 &&
646 Desc.getOperandConstraint(NumOps - 1, MCOI::TIED_TO) == 1)
647 // Special case for GATHER with 2 TIED_TO operands
648 // Skip the first 2 operands: dst, mask_wb
650 else if (NumOps > 2 && Desc.getOperandConstraint(NumOps - 2, MCOI::TIED_TO) == 0)
656 /// getMemoryOperandNo - The function returns the MCInst operand # for the
657 /// first field of the memory operand. If the instruction doesn't have a
658 /// memory operand, this returns -1.
660 /// Note that this ignores tied operands. If there is a tied register which
661 /// is duplicated in the MCInst (e.g. "EAX = addl EAX, [mem]") it is only
662 /// counted as one operand.
664 inline int getMemoryOperandNo(uint64_t TSFlags, unsigned Opcode) {
665 bool HasVEX_4V = TSFlags & X86II::VEX_4V;
666 bool HasMemOp4 = TSFlags & X86II::MemOp4;
667 bool HasEVEX_K = TSFlags & X86II::EVEX_K;
669 switch (TSFlags & X86II::FormMask) {
670 default: llvm_unreachable("Unknown FormMask value in getMemoryOperandNo!");
673 case X86II::AddRegFrm:
674 case X86II::MRMDestReg:
675 case X86II::MRMSrcReg:
676 case X86II::RawFrmImm8:
677 case X86II::RawFrmImm16:
678 case X86II::RawFrmMemOffs:
679 case X86II::RawFrmSrc:
680 case X86II::RawFrmDst:
681 case X86II::RawFrmDstSrc:
683 case X86II::MRMDestMem:
685 case X86II::MRMSrcMem:
686 // Start from 1, skip any registers encoded in VEX_VVVV or I8IMM, or a
688 return 1 + HasVEX_4V + HasMemOp4 + HasEVEX_K;
690 case X86II::MRM0r: case X86II::MRM1r:
691 case X86II::MRM2r: case X86II::MRM3r:
692 case X86II::MRM4r: case X86II::MRM5r:
693 case X86II::MRM6r: case X86II::MRM7r:
696 case X86II::MRM0m: case X86II::MRM1m:
697 case X86II::MRM2m: case X86II::MRM3m:
698 case X86II::MRM4m: case X86II::MRM5m:
699 case X86II::MRM6m: case X86II::MRM7m:
700 // Start from 0, skip registers encoded in VEX_VVVV or a mask register.
701 return 0 + HasVEX_4V + HasEVEX_K;
702 case X86II::MRM_C0: case X86II::MRM_C1: case X86II::MRM_C2:
703 case X86II::MRM_C3: case X86II::MRM_C4: case X86II::MRM_C8:
704 case X86II::MRM_C9: case X86II::MRM_CA: case X86II::MRM_CB:
705 case X86II::MRM_CF: case X86II::MRM_D0: case X86II::MRM_D1:
706 case X86II::MRM_D4: case X86II::MRM_D5: case X86II::MRM_D6:
707 case X86II::MRM_D7: case X86II::MRM_D8: case X86II::MRM_D9:
708 case X86II::MRM_DA: case X86II::MRM_DB: case X86II::MRM_DC:
709 case X86II::MRM_DD: case X86II::MRM_DE: case X86II::MRM_DF:
710 case X86II::MRM_E0: case X86II::MRM_E1: case X86II::MRM_E2:
711 case X86II::MRM_E3: case X86II::MRM_E4: case X86II::MRM_E5:
712 case X86II::MRM_E8: case X86II::MRM_E9: case X86II::MRM_EA:
713 case X86II::MRM_EB: case X86II::MRM_EC: case X86II::MRM_ED:
714 case X86II::MRM_EE: case X86II::MRM_F0: case X86II::MRM_F1:
715 case X86II::MRM_F2: case X86II::MRM_F3: case X86II::MRM_F4:
716 case X86II::MRM_F5: case X86II::MRM_F6: case X86II::MRM_F7:
717 case X86II::MRM_F8: case X86II::MRM_F9: case X86II::MRM_FA:
718 case X86II::MRM_FB: case X86II::MRM_FC: case X86II::MRM_FD:
719 case X86II::MRM_FE: case X86II::MRM_FF:
724 /// isX86_64ExtendedReg - Is the MachineOperand a x86-64 extended (r8 or
725 /// higher) register? e.g. r8, xmm8, xmm13, etc.
726 inline bool isX86_64ExtendedReg(unsigned RegNo) {
727 if ((RegNo > X86::XMM7 && RegNo <= X86::XMM15) ||
728 (RegNo > X86::XMM23 && RegNo <= X86::XMM31) ||
729 (RegNo > X86::YMM7 && RegNo <= X86::YMM15) ||
730 (RegNo > X86::YMM23 && RegNo <= X86::YMM31) ||
731 (RegNo > X86::ZMM7 && RegNo <= X86::ZMM15) ||
732 (RegNo > X86::ZMM23 && RegNo <= X86::ZMM31))
737 case X86::R8: case X86::R9: case X86::R10: case X86::R11:
738 case X86::R12: case X86::R13: case X86::R14: case X86::R15:
739 case X86::R8D: case X86::R9D: case X86::R10D: case X86::R11D:
740 case X86::R12D: case X86::R13D: case X86::R14D: case X86::R15D:
741 case X86::R8W: case X86::R9W: case X86::R10W: case X86::R11W:
742 case X86::R12W: case X86::R13W: case X86::R14W: case X86::R15W:
743 case X86::R8B: case X86::R9B: case X86::R10B: case X86::R11B:
744 case X86::R12B: case X86::R13B: case X86::R14B: case X86::R15B:
745 case X86::CR8: case X86::CR9: case X86::CR10: case X86::CR11:
746 case X86::CR12: case X86::CR13: case X86::CR14: case X86::CR15:
752 /// is32ExtendedReg - Is the MemoryOperand a 32 extended (zmm16 or higher)
753 /// registers? e.g. zmm21, etc.
754 static inline bool is32ExtendedReg(unsigned RegNo) {
755 return ((RegNo > X86::XMM15 && RegNo <= X86::XMM31) ||
756 (RegNo > X86::YMM15 && RegNo <= X86::YMM31) ||
757 (RegNo > X86::ZMM15 && RegNo <= X86::ZMM31));
761 inline bool isX86_64NonExtLowByteReg(unsigned reg) {
762 return (reg == X86::SPL || reg == X86::BPL ||
763 reg == X86::SIL || reg == X86::DIL);