1 //===- X86RecognizableInstr.cpp - Disassembler instruction spec --*- 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 is part of the X86 Disassembler Emitter.
11 // It contains the implementation of a single recognizable instruction.
12 // Documentation for the disassembler emitter in general can be found in
13 // X86DisasemblerEmitter.h.
15 //===----------------------------------------------------------------------===//
17 #include "X86DisassemblerShared.h"
18 #include "X86RecognizableInstr.h"
19 #include "X86ModRMFilters.h"
21 #include "llvm/Support/ErrorHandling.h"
50 // A clone of X86 since we can't depend on something that is generated.
60 MRM0r = 16, MRM1r = 17, MRM2r = 18, MRM3r = 19,
61 MRM4r = 20, MRM5r = 21, MRM6r = 22, MRM7r = 23,
62 MRM0m = 24, MRM1m = 25, MRM2m = 26, MRM3m = 27,
63 MRM4m = 28, MRM5m = 29, MRM6m = 30, MRM7m = 31,
67 #define MAP(from, to) MRM_##from = to,
76 D8 = 3, D9 = 4, DA = 5, DB = 6,
77 DC = 7, DD = 8, DE = 9, DF = 10,
80 A6 = 15, A7 = 16, T8XD = 17, T8XS = 18, TAXD = 19
84 // If rows are added to the opcode extension tables, then corresponding entries
85 // must be added here.
87 // If the row corresponds to a single byte (i.e., 8f), then add an entry for
88 // that byte to ONE_BYTE_EXTENSION_TABLES.
90 // If the row corresponds to two bytes where the first is 0f, add an entry for
91 // the second byte to TWO_BYTE_EXTENSION_TABLES.
93 // If the row corresponds to some other set of bytes, you will need to modify
94 // the code in RecognizableInstr::emitDecodePath() as well, and add new prefixes
95 // to the X86 TD files, except in two cases: if the first two bytes of such a
96 // new combination are 0f 38 or 0f 3a, you just have to add maps called
97 // THREE_BYTE_38_EXTENSION_TABLES and THREE_BYTE_3A_EXTENSION_TABLES and add a
98 // switch(Opcode) just below the case X86Local::T8: or case X86Local::TA: line
99 // in RecognizableInstr::emitDecodePath().
101 #define ONE_BYTE_EXTENSION_TABLES \
102 EXTENSION_TABLE(80) \
103 EXTENSION_TABLE(81) \
104 EXTENSION_TABLE(82) \
105 EXTENSION_TABLE(83) \
106 EXTENSION_TABLE(8f) \
107 EXTENSION_TABLE(c0) \
108 EXTENSION_TABLE(c1) \
109 EXTENSION_TABLE(c6) \
110 EXTENSION_TABLE(c7) \
111 EXTENSION_TABLE(d0) \
112 EXTENSION_TABLE(d1) \
113 EXTENSION_TABLE(d2) \
114 EXTENSION_TABLE(d3) \
115 EXTENSION_TABLE(f6) \
116 EXTENSION_TABLE(f7) \
117 EXTENSION_TABLE(fe) \
120 #define TWO_BYTE_EXTENSION_TABLES \
121 EXTENSION_TABLE(00) \
122 EXTENSION_TABLE(01) \
123 EXTENSION_TABLE(18) \
124 EXTENSION_TABLE(71) \
125 EXTENSION_TABLE(72) \
126 EXTENSION_TABLE(73) \
127 EXTENSION_TABLE(ae) \
128 EXTENSION_TABLE(ba) \
131 #define THREE_BYTE_38_EXTENSION_TABLES \
134 using namespace X86Disassembler;
136 /// needsModRMForDecode - Indicates whether a particular instruction requires a
137 /// ModR/M byte for the instruction to be properly decoded. For example, a
138 /// MRMDestReg instruction needs the Mod field in the ModR/M byte to be set to
141 /// @param form - The form of the instruction.
142 /// @return - true if the form implies that a ModR/M byte is required, false
144 static bool needsModRMForDecode(uint8_t form) {
145 if (form == X86Local::MRMDestReg ||
146 form == X86Local::MRMDestMem ||
147 form == X86Local::MRMSrcReg ||
148 form == X86Local::MRMSrcMem ||
149 (form >= X86Local::MRM0r && form <= X86Local::MRM7r) ||
150 (form >= X86Local::MRM0m && form <= X86Local::MRM7m))
156 /// isRegFormat - Indicates whether a particular form requires the Mod field of
157 /// the ModR/M byte to be 0b11.
159 /// @param form - The form of the instruction.
160 /// @return - true if the form implies that Mod must be 0b11, false
162 static bool isRegFormat(uint8_t form) {
163 if (form == X86Local::MRMDestReg ||
164 form == X86Local::MRMSrcReg ||
165 (form >= X86Local::MRM0r && form <= X86Local::MRM7r))
171 /// byteFromBitsInit - Extracts a value at most 8 bits in width from a BitsInit.
172 /// Useful for switch statements and the like.
174 /// @param init - A reference to the BitsInit to be decoded.
175 /// @return - The field, with the first bit in the BitsInit as the lowest
177 static uint8_t byteFromBitsInit(BitsInit &init) {
178 int width = init.getNumBits();
180 assert(width <= 8 && "Field is too large for uint8_t!");
187 for (index = 0; index < width; index++) {
188 if (static_cast<BitInit*>(init.getBit(index))->getValue())
197 /// byteFromRec - Extract a value at most 8 bits in with from a Record given the
198 /// name of the field.
200 /// @param rec - The record from which to extract the value.
201 /// @param name - The name of the field in the record.
202 /// @return - The field, as translated by byteFromBitsInit().
203 static uint8_t byteFromRec(const Record* rec, const std::string &name) {
204 BitsInit* bits = rec->getValueAsBitsInit(name);
205 return byteFromBitsInit(*bits);
208 RecognizableInstr::RecognizableInstr(DisassemblerTables &tables,
209 const CodeGenInstruction &insn,
214 Name = Rec->getName();
215 Spec = &tables.specForUID(UID);
217 if (!Rec->isSubClassOf("X86Inst")) {
218 ShouldBeEmitted = false;
222 Prefix = byteFromRec(Rec, "Prefix");
223 Opcode = byteFromRec(Rec, "Opcode");
224 Form = byteFromRec(Rec, "FormBits");
225 SegOvr = byteFromRec(Rec, "SegOvrBits");
227 HasOpSizePrefix = Rec->getValueAsBit("hasOpSizePrefix");
228 HasAdSizePrefix = Rec->getValueAsBit("hasAdSizePrefix");
229 HasREX_WPrefix = Rec->getValueAsBit("hasREX_WPrefix");
230 HasVEXPrefix = Rec->getValueAsBit("hasVEXPrefix");
231 HasVEX_4VPrefix = Rec->getValueAsBit("hasVEX_4VPrefix");
232 HasVEX_4VOp3Prefix = Rec->getValueAsBit("hasVEX_4VOp3Prefix");
233 HasVEX_WPrefix = Rec->getValueAsBit("hasVEX_WPrefix");
234 HasMemOp4Prefix = Rec->getValueAsBit("hasMemOp4Prefix");
235 IgnoresVEX_L = Rec->getValueAsBit("ignoresVEX_L");
236 HasLockPrefix = Rec->getValueAsBit("hasLockPrefix");
237 IsCodeGenOnly = Rec->getValueAsBit("isCodeGenOnly");
239 Name = Rec->getName();
240 AsmString = Rec->getValueAsString("AsmString");
242 Operands = &insn.Operands.OperandList;
244 IsSSE = (HasOpSizePrefix && (Name.find("16") == Name.npos)) ||
245 (Name.find("CRC32") != Name.npos);
246 HasFROperands = hasFROperands();
247 HasVEX_LPrefix = has256BitOperands() || Rec->getValueAsBit("hasVEX_L");
249 // Check for 64-bit inst which does not require REX
252 // FIXME: Is there some better way to check for In64BitMode?
253 std::vector<Record*> Predicates = Rec->getValueAsListOfDefs("Predicates");
254 for (unsigned i = 0, e = Predicates.size(); i != e; ++i) {
255 if (Predicates[i]->getName().find("32Bit") != Name.npos) {
259 if (Predicates[i]->getName().find("64Bit") != Name.npos) {
264 // FIXME: These instructions aren't marked as 64-bit in any way
265 Is64Bit |= Rec->getName() == "JMP64pcrel32" ||
266 Rec->getName() == "MASKMOVDQU64" ||
267 Rec->getName() == "POPFS64" ||
268 Rec->getName() == "POPGS64" ||
269 Rec->getName() == "PUSHFS64" ||
270 Rec->getName() == "PUSHGS64" ||
271 Rec->getName() == "REX64_PREFIX" ||
272 Rec->getName().find("MOV64") != Name.npos ||
273 Rec->getName().find("PUSH64") != Name.npos ||
274 Rec->getName().find("POP64") != Name.npos;
276 ShouldBeEmitted = true;
279 void RecognizableInstr::processInstr(DisassemblerTables &tables,
280 const CodeGenInstruction &insn,
283 // Ignore "asm parser only" instructions.
284 if (insn.TheDef->getValueAsBit("isAsmParserOnly"))
287 RecognizableInstr recogInstr(tables, insn, uid);
289 recogInstr.emitInstructionSpecifier(tables);
291 if (recogInstr.shouldBeEmitted())
292 recogInstr.emitDecodePath(tables);
295 InstructionContext RecognizableInstr::insnContext() const {
296 InstructionContext insnContext;
298 if (HasVEX_4VPrefix || HasVEX_4VOp3Prefix|| HasVEXPrefix) {
299 if (HasVEX_LPrefix && HasVEX_WPrefix) {
301 insnContext = IC_VEX_L_W_OPSIZE;
303 llvm_unreachable("Don't support VEX.L and VEX.W together");
304 } else if (HasOpSizePrefix && HasVEX_LPrefix)
305 insnContext = IC_VEX_L_OPSIZE;
306 else if (HasOpSizePrefix && HasVEX_WPrefix)
307 insnContext = IC_VEX_W_OPSIZE;
308 else if (HasOpSizePrefix)
309 insnContext = IC_VEX_OPSIZE;
310 else if (HasVEX_LPrefix &&
311 (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
312 insnContext = IC_VEX_L_XS;
313 else if (HasVEX_LPrefix && (Prefix == X86Local::XD ||
314 Prefix == X86Local::T8XD ||
315 Prefix == X86Local::TAXD))
316 insnContext = IC_VEX_L_XD;
317 else if (HasVEX_WPrefix &&
318 (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
319 insnContext = IC_VEX_W_XS;
320 else if (HasVEX_WPrefix && (Prefix == X86Local::XD ||
321 Prefix == X86Local::T8XD ||
322 Prefix == X86Local::TAXD))
323 insnContext = IC_VEX_W_XD;
324 else if (HasVEX_WPrefix)
325 insnContext = IC_VEX_W;
326 else if (HasVEX_LPrefix)
327 insnContext = IC_VEX_L;
328 else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
329 Prefix == X86Local::TAXD)
330 insnContext = IC_VEX_XD;
331 else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
332 insnContext = IC_VEX_XS;
334 insnContext = IC_VEX;
335 } else if (Is64Bit || HasREX_WPrefix) {
336 if (HasREX_WPrefix && HasOpSizePrefix)
337 insnContext = IC_64BIT_REXW_OPSIZE;
338 else if (HasOpSizePrefix && (Prefix == X86Local::XD ||
339 Prefix == X86Local::T8XD ||
340 Prefix == X86Local::TAXD))
341 insnContext = IC_64BIT_XD_OPSIZE;
342 else if (HasOpSizePrefix &&
343 (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
344 insnContext = IC_64BIT_XS_OPSIZE;
345 else if (HasOpSizePrefix)
346 insnContext = IC_64BIT_OPSIZE;
347 else if (HasAdSizePrefix)
348 insnContext = IC_64BIT_ADSIZE;
349 else if (HasREX_WPrefix &&
350 (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
351 insnContext = IC_64BIT_REXW_XS;
352 else if (HasREX_WPrefix && (Prefix == X86Local::XD ||
353 Prefix == X86Local::T8XD ||
354 Prefix == X86Local::TAXD))
355 insnContext = IC_64BIT_REXW_XD;
356 else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
357 Prefix == X86Local::TAXD)
358 insnContext = IC_64BIT_XD;
359 else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS)
360 insnContext = IC_64BIT_XS;
361 else if (HasREX_WPrefix)
362 insnContext = IC_64BIT_REXW;
364 insnContext = IC_64BIT;
366 if (HasOpSizePrefix && (Prefix == X86Local::XD ||
367 Prefix == X86Local::T8XD ||
368 Prefix == X86Local::TAXD))
369 insnContext = IC_XD_OPSIZE;
370 else if (HasOpSizePrefix &&
371 (Prefix == X86Local::XS || Prefix == X86Local::T8XS))
372 insnContext = IC_XS_OPSIZE;
373 else if (HasOpSizePrefix)
374 insnContext = IC_OPSIZE;
375 else if (HasAdSizePrefix)
376 insnContext = IC_ADSIZE;
377 else if (Prefix == X86Local::XD || Prefix == X86Local::T8XD ||
378 Prefix == X86Local::TAXD)
380 else if (Prefix == X86Local::XS || Prefix == X86Local::T8XS ||
381 Prefix == X86Local::REP)
390 RecognizableInstr::filter_ret RecognizableInstr::filter() const {
395 // Filter out intrinsics
397 assert(Rec->isSubClassOf("X86Inst") && "Can only filter X86 instructions");
399 if (Form == X86Local::Pseudo ||
400 (IsCodeGenOnly && Name.find("_REV") == Name.npos))
401 return FILTER_STRONG;
404 // Filter out artificial instructions but leave in the LOCK_PREFIX so it is
405 // printed as a separate "instruction".
407 if (Name.find("_Int") != Name.npos ||
408 Name.find("Int_") != Name.npos ||
409 Name.find("_NOREX") != Name.npos)
410 return FILTER_STRONG;
412 // Filter out instructions with segment override prefixes.
413 // They're too messy to handle now and we'll special case them if needed.
416 return FILTER_STRONG;
424 // Filter out instructions with a LOCK prefix;
425 // prefer forms that do not have the prefix
429 // Filter out alternate forms of AVX instructions
430 if (Name.find("_alt") != Name.npos ||
431 Name.find("XrYr") != Name.npos ||
432 (Name.find("r64r") != Name.npos && Name.find("r64r64") == Name.npos) ||
433 Name.find("_64mr") != Name.npos ||
434 Name.find("Xrr") != Name.npos ||
435 Name.find("rr64") != Name.npos)
440 if (Name.find("PCMPISTRI") != Name.npos && Name != "PCMPISTRI")
442 if (Name.find("PCMPESTRI") != Name.npos && Name != "PCMPESTRI")
445 if (Name.find("MOV") != Name.npos && Name.find("r0") != Name.npos)
447 if (Name.find("MOVZ") != Name.npos && Name.find("MOVZX") == Name.npos)
449 if (Name.find("Fs") != Name.npos)
451 if (Name == "PUSH64i16" ||
452 Name == "MOVPQI2QImr" ||
453 Name == "VMOVPQI2QImr" ||
454 Name == "MMX_MOVD64rrv164" ||
455 Name == "MOV64ri64i32" ||
456 Name == "VMASKMOVDQU64" ||
457 Name == "VEXTRACTPSrr64" ||
458 Name == "VMOVQd64rr" ||
459 Name == "VMOVQs64rr")
462 if (HasFROperands && Name.find("MOV") != Name.npos &&
463 ((Name.find("2") != Name.npos && Name.find("32") == Name.npos) ||
464 (Name.find("to") != Name.npos)))
465 return FILTER_STRONG;
467 return FILTER_NORMAL;
470 bool RecognizableInstr::hasFROperands() const {
471 const std::vector<CGIOperandList::OperandInfo> &OperandList = *Operands;
472 unsigned numOperands = OperandList.size();
474 for (unsigned operandIndex = 0; operandIndex < numOperands; ++operandIndex) {
475 const std::string &recName = OperandList[operandIndex].Rec->getName();
477 if (recName.find("FR") != recName.npos)
483 bool RecognizableInstr::has256BitOperands() const {
484 const std::vector<CGIOperandList::OperandInfo> &OperandList = *Operands;
485 unsigned numOperands = OperandList.size();
487 for (unsigned operandIndex = 0; operandIndex < numOperands; ++operandIndex) {
488 const std::string &recName = OperandList[operandIndex].Rec->getName();
490 if (!recName.compare("VR256")) {
497 void RecognizableInstr::handleOperand(bool optional, unsigned &operandIndex,
498 unsigned &physicalOperandIndex,
499 unsigned &numPhysicalOperands,
500 const unsigned *operandMapping,
501 OperandEncoding (*encodingFromString)
503 bool hasOpSizePrefix)) {
505 if (physicalOperandIndex >= numPhysicalOperands)
508 assert(physicalOperandIndex < numPhysicalOperands);
511 while (operandMapping[operandIndex] != operandIndex) {
512 Spec->operands[operandIndex].encoding = ENCODING_DUP;
513 Spec->operands[operandIndex].type =
514 (OperandType)(TYPE_DUP0 + operandMapping[operandIndex]);
518 const std::string &typeName = (*Operands)[operandIndex].Rec->getName();
520 Spec->operands[operandIndex].encoding = encodingFromString(typeName,
522 Spec->operands[operandIndex].type = typeFromString(typeName,
528 ++physicalOperandIndex;
531 void RecognizableInstr::emitInstructionSpecifier(DisassemblerTables &tables) {
534 if (!ShouldBeEmitted)
539 Spec->filtered = true;
542 ShouldBeEmitted = false;
548 Spec->insnContext = insnContext();
550 const std::vector<CGIOperandList::OperandInfo> &OperandList = *Operands;
552 unsigned numOperands = OperandList.size();
553 unsigned numPhysicalOperands = 0;
555 // operandMapping maps from operands in OperandList to their originals.
556 // If operandMapping[i] != i, then the entry is a duplicate.
557 unsigned operandMapping[X86_MAX_OPERANDS];
558 assert(numOperands <= X86_MAX_OPERANDS && "X86_MAX_OPERANDS is not large enough");
560 for (unsigned operandIndex = 0; operandIndex < numOperands; ++operandIndex) {
561 if (OperandList[operandIndex].Constraints.size()) {
562 const CGIOperandList::ConstraintInfo &Constraint =
563 OperandList[operandIndex].Constraints[0];
564 if (Constraint.isTied()) {
565 operandMapping[operandIndex] = operandIndex;
566 operandMapping[Constraint.getTiedOperand()] = operandIndex;
568 ++numPhysicalOperands;
569 operandMapping[operandIndex] = operandIndex;
572 ++numPhysicalOperands;
573 operandMapping[operandIndex] = operandIndex;
577 #define HANDLE_OPERAND(class) \
578 handleOperand(false, \
580 physicalOperandIndex, \
581 numPhysicalOperands, \
583 class##EncodingFromString);
585 #define HANDLE_OPTIONAL(class) \
586 handleOperand(true, \
588 physicalOperandIndex, \
589 numPhysicalOperands, \
591 class##EncodingFromString);
593 // operandIndex should always be < numOperands
594 unsigned operandIndex = 0;
595 // physicalOperandIndex should always be < numPhysicalOperands
596 unsigned physicalOperandIndex = 0;
599 case X86Local::RawFrm:
600 // Operand 1 (optional) is an address or immediate.
601 // Operand 2 (optional) is an immediate.
602 assert(numPhysicalOperands <= 2 &&
603 "Unexpected number of operands for RawFrm");
604 HANDLE_OPTIONAL(relocation)
605 HANDLE_OPTIONAL(immediate)
607 case X86Local::AddRegFrm:
608 // Operand 1 is added to the opcode.
609 // Operand 2 (optional) is an address.
610 assert(numPhysicalOperands >= 1 && numPhysicalOperands <= 2 &&
611 "Unexpected number of operands for AddRegFrm");
612 HANDLE_OPERAND(opcodeModifier)
613 HANDLE_OPTIONAL(relocation)
615 case X86Local::MRMDestReg:
616 // Operand 1 is a register operand in the R/M field.
617 // Operand 2 is a register operand in the Reg/Opcode field.
618 // - In AVX, there is a register operand in the VEX.vvvv field here -
619 // Operand 3 (optional) is an immediate.
621 assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 4 &&
622 "Unexpected number of operands for MRMDestRegFrm with VEX_4V");
624 assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
625 "Unexpected number of operands for MRMDestRegFrm");
627 HANDLE_OPERAND(rmRegister)
630 // FIXME: In AVX, the register below becomes the one encoded
631 // in ModRMVEX and the one above the one in the VEX.VVVV field
632 HANDLE_OPERAND(vvvvRegister)
634 HANDLE_OPERAND(roRegister)
635 HANDLE_OPTIONAL(immediate)
637 case X86Local::MRMDestMem:
638 // Operand 1 is a memory operand (possibly SIB-extended)
639 // Operand 2 is a register operand in the Reg/Opcode field.
640 // - In AVX, there is a register operand in the VEX.vvvv field here -
641 // Operand 3 (optional) is an immediate.
643 assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 4 &&
644 "Unexpected number of operands for MRMDestMemFrm with VEX_4V");
646 assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
647 "Unexpected number of operands for MRMDestMemFrm");
648 HANDLE_OPERAND(memory)
651 // FIXME: In AVX, the register below becomes the one encoded
652 // in ModRMVEX and the one above the one in the VEX.VVVV field
653 HANDLE_OPERAND(vvvvRegister)
655 HANDLE_OPERAND(roRegister)
656 HANDLE_OPTIONAL(immediate)
658 case X86Local::MRMSrcReg:
659 // Operand 1 is a register operand in the Reg/Opcode field.
660 // Operand 2 is a register operand in the R/M field.
661 // - In AVX, there is a register operand in the VEX.vvvv field here -
662 // Operand 3 (optional) is an immediate.
663 // Operand 4 (optional) is an immediate.
665 if (HasVEX_4VPrefix || HasVEX_4VOp3Prefix)
666 assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 5 &&
667 "Unexpected number of operands for MRMSrcRegFrm with VEX_4V");
669 assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 4 &&
670 "Unexpected number of operands for MRMSrcRegFrm");
672 HANDLE_OPERAND(roRegister)
675 // FIXME: In AVX, the register below becomes the one encoded
676 // in ModRMVEX and the one above the one in the VEX.VVVV field
677 HANDLE_OPERAND(vvvvRegister)
680 HANDLE_OPERAND(immediate)
682 HANDLE_OPERAND(rmRegister)
684 if (HasVEX_4VOp3Prefix)
685 HANDLE_OPERAND(vvvvRegister)
687 if (!HasMemOp4Prefix)
688 HANDLE_OPTIONAL(immediate)
689 HANDLE_OPTIONAL(immediate) // above might be a register in 7:4
690 HANDLE_OPTIONAL(immediate)
692 case X86Local::MRMSrcMem:
693 // Operand 1 is a register operand in the Reg/Opcode field.
694 // Operand 2 is a memory operand (possibly SIB-extended)
695 // - In AVX, there is a register operand in the VEX.vvvv field here -
696 // Operand 3 (optional) is an immediate.
698 if (HasVEX_4VPrefix || HasVEX_4VOp3Prefix)
699 assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 5 &&
700 "Unexpected number of operands for MRMSrcMemFrm with VEX_4V");
702 assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
703 "Unexpected number of operands for MRMSrcMemFrm");
705 HANDLE_OPERAND(roRegister)
708 // FIXME: In AVX, the register below becomes the one encoded
709 // in ModRMVEX and the one above the one in the VEX.VVVV field
710 HANDLE_OPERAND(vvvvRegister)
713 HANDLE_OPERAND(immediate)
715 HANDLE_OPERAND(memory)
717 if (HasVEX_4VOp3Prefix)
718 HANDLE_OPERAND(vvvvRegister)
720 if (!HasMemOp4Prefix)
721 HANDLE_OPTIONAL(immediate)
722 HANDLE_OPTIONAL(immediate) // above might be a register in 7:4
724 case X86Local::MRM0r:
725 case X86Local::MRM1r:
726 case X86Local::MRM2r:
727 case X86Local::MRM3r:
728 case X86Local::MRM4r:
729 case X86Local::MRM5r:
730 case X86Local::MRM6r:
731 case X86Local::MRM7r:
732 // Operand 1 is a register operand in the R/M field.
733 // Operand 2 (optional) is an immediate or relocation.
734 // Operand 3 (optional) is an immediate.
736 assert(numPhysicalOperands <= 3 &&
737 "Unexpected number of operands for MRMnRFrm with VEX_4V");
739 assert(numPhysicalOperands <= 3 &&
740 "Unexpected number of operands for MRMnRFrm");
742 HANDLE_OPERAND(vvvvRegister)
743 HANDLE_OPTIONAL(rmRegister)
744 HANDLE_OPTIONAL(relocation)
745 HANDLE_OPTIONAL(immediate)
747 case X86Local::MRM0m:
748 case X86Local::MRM1m:
749 case X86Local::MRM2m:
750 case X86Local::MRM3m:
751 case X86Local::MRM4m:
752 case X86Local::MRM5m:
753 case X86Local::MRM6m:
754 case X86Local::MRM7m:
755 // Operand 1 is a memory operand (possibly SIB-extended)
756 // Operand 2 (optional) is an immediate or relocation.
758 assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
759 "Unexpected number of operands for MRMnMFrm");
761 assert(numPhysicalOperands >= 1 && numPhysicalOperands <= 2 &&
762 "Unexpected number of operands for MRMnMFrm");
764 HANDLE_OPERAND(vvvvRegister)
765 HANDLE_OPERAND(memory)
766 HANDLE_OPTIONAL(relocation)
768 case X86Local::RawFrmImm8:
769 // operand 1 is a 16-bit immediate
770 // operand 2 is an 8-bit immediate
771 assert(numPhysicalOperands == 2 &&
772 "Unexpected number of operands for X86Local::RawFrmImm8");
773 HANDLE_OPERAND(immediate)
774 HANDLE_OPERAND(immediate)
776 case X86Local::RawFrmImm16:
777 // operand 1 is a 16-bit immediate
778 // operand 2 is a 16-bit immediate
779 HANDLE_OPERAND(immediate)
780 HANDLE_OPERAND(immediate)
782 case X86Local::MRMInitReg:
787 #undef HANDLE_OPERAND
788 #undef HANDLE_OPTIONAL
791 void RecognizableInstr::emitDecodePath(DisassemblerTables &tables) const {
792 // Special cases where the LLVM tables are not complete
794 #define MAP(from, to) \
795 case X86Local::MRM_##from: \
796 filter = new ExactFilter(0x##from); \
799 OpcodeType opcodeType = (OpcodeType)-1;
801 ModRMFilter* filter = NULL;
802 uint8_t opcodeToSet = 0;
805 // Extended two-byte opcodes can start with f2 0f, f3 0f, or 0f
809 opcodeType = TWOBYTE;
813 if (needsModRMForDecode(Form))
814 filter = new ModFilter(isRegFormat(Form));
816 filter = new DumbFilter();
818 #define EXTENSION_TABLE(n) case 0x##n:
819 TWO_BYTE_EXTENSION_TABLES
820 #undef EXTENSION_TABLE
823 llvm_unreachable("Unhandled two-byte extended opcode");
824 case X86Local::MRM0r:
825 case X86Local::MRM1r:
826 case X86Local::MRM2r:
827 case X86Local::MRM3r:
828 case X86Local::MRM4r:
829 case X86Local::MRM5r:
830 case X86Local::MRM6r:
831 case X86Local::MRM7r:
832 filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
834 case X86Local::MRM0m:
835 case X86Local::MRM1m:
836 case X86Local::MRM2m:
837 case X86Local::MRM3m:
838 case X86Local::MRM4m:
839 case X86Local::MRM5m:
840 case X86Local::MRM6m:
841 case X86Local::MRM7m:
842 filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
848 opcodeToSet = Opcode;
853 opcodeType = THREEBYTE_38;
856 if (needsModRMForDecode(Form))
857 filter = new ModFilter(isRegFormat(Form));
859 filter = new DumbFilter();
861 #define EXTENSION_TABLE(n) case 0x##n:
862 THREE_BYTE_38_EXTENSION_TABLES
863 #undef EXTENSION_TABLE
866 llvm_unreachable("Unhandled two-byte extended opcode");
867 case X86Local::MRM0r:
868 case X86Local::MRM1r:
869 case X86Local::MRM2r:
870 case X86Local::MRM3r:
871 case X86Local::MRM4r:
872 case X86Local::MRM5r:
873 case X86Local::MRM6r:
874 case X86Local::MRM7r:
875 filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
877 case X86Local::MRM0m:
878 case X86Local::MRM1m:
879 case X86Local::MRM2m:
880 case X86Local::MRM3m:
881 case X86Local::MRM4m:
882 case X86Local::MRM5m:
883 case X86Local::MRM6m:
884 case X86Local::MRM7m:
885 filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
891 opcodeToSet = Opcode;
895 opcodeType = THREEBYTE_3A;
896 if (needsModRMForDecode(Form))
897 filter = new ModFilter(isRegFormat(Form));
899 filter = new DumbFilter();
900 opcodeToSet = Opcode;
903 opcodeType = THREEBYTE_A6;
904 if (needsModRMForDecode(Form))
905 filter = new ModFilter(isRegFormat(Form));
907 filter = new DumbFilter();
908 opcodeToSet = Opcode;
911 opcodeType = THREEBYTE_A7;
912 if (needsModRMForDecode(Form))
913 filter = new ModFilter(isRegFormat(Form));
915 filter = new DumbFilter();
916 opcodeToSet = Opcode;
926 assert(Opcode >= 0xc0 && "Unexpected opcode for an escape opcode");
927 opcodeType = ONEBYTE;
928 if (Form == X86Local::AddRegFrm) {
929 Spec->modifierType = MODIFIER_MODRM;
930 Spec->modifierBase = Opcode;
931 filter = new AddRegEscapeFilter(Opcode);
933 filter = new EscapeFilter(true, Opcode);
935 opcodeToSet = 0xd8 + (Prefix - X86Local::D8);
939 opcodeType = ONEBYTE;
941 #define EXTENSION_TABLE(n) case 0x##n:
942 ONE_BYTE_EXTENSION_TABLES
943 #undef EXTENSION_TABLE
946 llvm_unreachable("Fell through the cracks of a single-byte "
948 case X86Local::MRM0r:
949 case X86Local::MRM1r:
950 case X86Local::MRM2r:
951 case X86Local::MRM3r:
952 case X86Local::MRM4r:
953 case X86Local::MRM5r:
954 case X86Local::MRM6r:
955 case X86Local::MRM7r:
956 filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
958 case X86Local::MRM0m:
959 case X86Local::MRM1m:
960 case X86Local::MRM2m:
961 case X86Local::MRM3m:
962 case X86Local::MRM4m:
963 case X86Local::MRM5m:
964 case X86Local::MRM6m:
965 case X86Local::MRM7m:
966 filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
979 filter = new EscapeFilter(false, Form - X86Local::MRM0m);
982 if (needsModRMForDecode(Form))
983 filter = new ModFilter(isRegFormat(Form));
985 filter = new DumbFilter();
988 opcodeToSet = Opcode;
991 assert(opcodeType != (OpcodeType)-1 &&
992 "Opcode type not set");
993 assert(filter && "Filter not set");
995 if (Form == X86Local::AddRegFrm) {
996 if(Spec->modifierType != MODIFIER_MODRM) {
997 assert(opcodeToSet < 0xf9 &&
998 "Not enough room for all ADDREG_FRM operands");
1000 uint8_t currentOpcode;
1002 for (currentOpcode = opcodeToSet;
1003 currentOpcode < opcodeToSet + 8;
1005 tables.setTableFields(opcodeType,
1009 UID, Is32Bit, IgnoresVEX_L);
1011 Spec->modifierType = MODIFIER_OPCODE;
1012 Spec->modifierBase = opcodeToSet;
1014 // modifierBase was set where MODIFIER_MODRM was set
1015 tables.setTableFields(opcodeType,
1019 UID, Is32Bit, IgnoresVEX_L);
1022 tables.setTableFields(opcodeType,
1026 UID, Is32Bit, IgnoresVEX_L);
1028 Spec->modifierType = MODIFIER_NONE;
1029 Spec->modifierBase = opcodeToSet;
1037 #define TYPE(str, type) if (s == str) return type;
1038 OperandType RecognizableInstr::typeFromString(const std::string &s,
1040 bool hasREX_WPrefix,
1041 bool hasOpSizePrefix) {
1043 // For SSE instructions, we ignore the OpSize prefix and force operand
1045 TYPE("GR16", TYPE_R16)
1046 TYPE("GR32", TYPE_R32)
1047 TYPE("GR64", TYPE_R64)
1049 if(hasREX_WPrefix) {
1050 // For instructions with a REX_W prefix, a declared 32-bit register encoding
1052 TYPE("GR32", TYPE_R32)
1054 if(!hasOpSizePrefix) {
1055 // For instructions without an OpSize prefix, a declared 16-bit register or
1056 // immediate encoding is special.
1057 TYPE("GR16", TYPE_R16)
1058 TYPE("i16imm", TYPE_IMM16)
1060 TYPE("i16mem", TYPE_Mv)
1061 TYPE("i16imm", TYPE_IMMv)
1062 TYPE("i16i8imm", TYPE_IMMv)
1063 TYPE("GR16", TYPE_Rv)
1064 TYPE("i32mem", TYPE_Mv)
1065 TYPE("i32imm", TYPE_IMMv)
1066 TYPE("i32i8imm", TYPE_IMM32)
1067 TYPE("u32u8imm", TYPE_IMM32)
1068 TYPE("GR32", TYPE_Rv)
1069 TYPE("i64mem", TYPE_Mv)
1070 TYPE("i64i32imm", TYPE_IMM64)
1071 TYPE("i64i8imm", TYPE_IMM64)
1072 TYPE("GR64", TYPE_R64)
1073 TYPE("i8mem", TYPE_M8)
1074 TYPE("i8imm", TYPE_IMM8)
1075 TYPE("GR8", TYPE_R8)
1076 TYPE("VR128", TYPE_XMM128)
1077 TYPE("f128mem", TYPE_M128)
1078 TYPE("f256mem", TYPE_M256)
1079 TYPE("FR64", TYPE_XMM64)
1080 TYPE("f64mem", TYPE_M64FP)
1081 TYPE("sdmem", TYPE_M64FP)
1082 TYPE("FR32", TYPE_XMM32)
1083 TYPE("f32mem", TYPE_M32FP)
1084 TYPE("ssmem", TYPE_M32FP)
1085 TYPE("RST", TYPE_ST)
1086 TYPE("i128mem", TYPE_M128)
1087 TYPE("i256mem", TYPE_M256)
1088 TYPE("i64i32imm_pcrel", TYPE_REL64)
1089 TYPE("i16imm_pcrel", TYPE_REL16)
1090 TYPE("i32imm_pcrel", TYPE_REL32)
1091 TYPE("SSECC", TYPE_IMM3)
1092 TYPE("AVXCC", TYPE_IMM5)
1093 TYPE("brtarget", TYPE_RELv)
1094 TYPE("uncondbrtarget", TYPE_RELv)
1095 TYPE("brtarget8", TYPE_REL8)
1096 TYPE("f80mem", TYPE_M80FP)
1097 TYPE("lea32mem", TYPE_LEA)
1098 TYPE("lea64_32mem", TYPE_LEA)
1099 TYPE("lea64mem", TYPE_LEA)
1100 TYPE("VR64", TYPE_MM64)
1101 TYPE("i64imm", TYPE_IMMv)
1102 TYPE("opaque32mem", TYPE_M1616)
1103 TYPE("opaque48mem", TYPE_M1632)
1104 TYPE("opaque80mem", TYPE_M1664)
1105 TYPE("opaque512mem", TYPE_M512)
1106 TYPE("SEGMENT_REG", TYPE_SEGMENTREG)
1107 TYPE("DEBUG_REG", TYPE_DEBUGREG)
1108 TYPE("CONTROL_REG", TYPE_CONTROLREG)
1109 TYPE("offset8", TYPE_MOFFS8)
1110 TYPE("offset16", TYPE_MOFFS16)
1111 TYPE("offset32", TYPE_MOFFS32)
1112 TYPE("offset64", TYPE_MOFFS64)
1113 TYPE("VR256", TYPE_XMM256)
1114 TYPE("GR16_NOAX", TYPE_Rv)
1115 TYPE("GR32_NOAX", TYPE_Rv)
1116 TYPE("GR64_NOAX", TYPE_R64)
1117 TYPE("vx32mem", TYPE_M32)
1118 TYPE("vy32mem", TYPE_M32)
1119 TYPE("vx64mem", TYPE_M64)
1120 TYPE("vy64mem", TYPE_M64)
1121 errs() << "Unhandled type string " << s << "\n";
1122 llvm_unreachable("Unhandled type string");
1126 #define ENCODING(str, encoding) if (s == str) return encoding;
1127 OperandEncoding RecognizableInstr::immediateEncodingFromString
1128 (const std::string &s,
1129 bool hasOpSizePrefix) {
1130 if(!hasOpSizePrefix) {
1131 // For instructions without an OpSize prefix, a declared 16-bit register or
1132 // immediate encoding is special.
1133 ENCODING("i16imm", ENCODING_IW)
1135 ENCODING("i32i8imm", ENCODING_IB)
1136 ENCODING("u32u8imm", ENCODING_IB)
1137 ENCODING("SSECC", ENCODING_IB)
1138 ENCODING("AVXCC", ENCODING_IB)
1139 ENCODING("i16imm", ENCODING_Iv)
1140 ENCODING("i16i8imm", ENCODING_IB)
1141 ENCODING("i32imm", ENCODING_Iv)
1142 ENCODING("i64i32imm", ENCODING_ID)
1143 ENCODING("i64i8imm", ENCODING_IB)
1144 ENCODING("i8imm", ENCODING_IB)
1145 // This is not a typo. Instructions like BLENDVPD put
1146 // register IDs in 8-bit immediates nowadays.
1147 ENCODING("VR256", ENCODING_IB)
1148 ENCODING("VR128", ENCODING_IB)
1149 errs() << "Unhandled immediate encoding " << s << "\n";
1150 llvm_unreachable("Unhandled immediate encoding");
1153 OperandEncoding RecognizableInstr::rmRegisterEncodingFromString
1154 (const std::string &s,
1155 bool hasOpSizePrefix) {
1156 ENCODING("GR16", ENCODING_RM)
1157 ENCODING("GR32", ENCODING_RM)
1158 ENCODING("GR64", ENCODING_RM)
1159 ENCODING("GR8", ENCODING_RM)
1160 ENCODING("VR128", ENCODING_RM)
1161 ENCODING("FR64", ENCODING_RM)
1162 ENCODING("FR32", ENCODING_RM)
1163 ENCODING("VR64", ENCODING_RM)
1164 ENCODING("VR256", ENCODING_RM)
1165 errs() << "Unhandled R/M register encoding " << s << "\n";
1166 llvm_unreachable("Unhandled R/M register encoding");
1169 OperandEncoding RecognizableInstr::roRegisterEncodingFromString
1170 (const std::string &s,
1171 bool hasOpSizePrefix) {
1172 ENCODING("GR16", ENCODING_REG)
1173 ENCODING("GR32", ENCODING_REG)
1174 ENCODING("GR64", ENCODING_REG)
1175 ENCODING("GR8", ENCODING_REG)
1176 ENCODING("VR128", ENCODING_REG)
1177 ENCODING("FR64", ENCODING_REG)
1178 ENCODING("FR32", ENCODING_REG)
1179 ENCODING("VR64", ENCODING_REG)
1180 ENCODING("SEGMENT_REG", ENCODING_REG)
1181 ENCODING("DEBUG_REG", ENCODING_REG)
1182 ENCODING("CONTROL_REG", ENCODING_REG)
1183 ENCODING("VR256", ENCODING_REG)
1184 errs() << "Unhandled reg/opcode register encoding " << s << "\n";
1185 llvm_unreachable("Unhandled reg/opcode register encoding");
1188 OperandEncoding RecognizableInstr::vvvvRegisterEncodingFromString
1189 (const std::string &s,
1190 bool hasOpSizePrefix) {
1191 ENCODING("GR32", ENCODING_VVVV)
1192 ENCODING("GR64", ENCODING_VVVV)
1193 ENCODING("FR32", ENCODING_VVVV)
1194 ENCODING("FR64", ENCODING_VVVV)
1195 ENCODING("VR128", ENCODING_VVVV)
1196 ENCODING("VR256", ENCODING_VVVV)
1197 errs() << "Unhandled VEX.vvvv register encoding " << s << "\n";
1198 llvm_unreachable("Unhandled VEX.vvvv register encoding");
1201 OperandEncoding RecognizableInstr::memoryEncodingFromString
1202 (const std::string &s,
1203 bool hasOpSizePrefix) {
1204 ENCODING("i16mem", ENCODING_RM)
1205 ENCODING("i32mem", ENCODING_RM)
1206 ENCODING("i64mem", ENCODING_RM)
1207 ENCODING("i8mem", ENCODING_RM)
1208 ENCODING("ssmem", ENCODING_RM)
1209 ENCODING("sdmem", ENCODING_RM)
1210 ENCODING("f128mem", ENCODING_RM)
1211 ENCODING("f256mem", ENCODING_RM)
1212 ENCODING("f64mem", ENCODING_RM)
1213 ENCODING("f32mem", ENCODING_RM)
1214 ENCODING("i128mem", ENCODING_RM)
1215 ENCODING("i256mem", ENCODING_RM)
1216 ENCODING("f80mem", ENCODING_RM)
1217 ENCODING("lea32mem", ENCODING_RM)
1218 ENCODING("lea64_32mem", ENCODING_RM)
1219 ENCODING("lea64mem", ENCODING_RM)
1220 ENCODING("opaque32mem", ENCODING_RM)
1221 ENCODING("opaque48mem", ENCODING_RM)
1222 ENCODING("opaque80mem", ENCODING_RM)
1223 ENCODING("opaque512mem", ENCODING_RM)
1224 ENCODING("vx32mem", ENCODING_RM)
1225 ENCODING("vy32mem", ENCODING_RM)
1226 ENCODING("vx64mem", ENCODING_RM)
1227 ENCODING("vy64mem", ENCODING_RM)
1228 errs() << "Unhandled memory encoding " << s << "\n";
1229 llvm_unreachable("Unhandled memory encoding");
1232 OperandEncoding RecognizableInstr::relocationEncodingFromString
1233 (const std::string &s,
1234 bool hasOpSizePrefix) {
1235 if(!hasOpSizePrefix) {
1236 // For instructions without an OpSize prefix, a declared 16-bit register or
1237 // immediate encoding is special.
1238 ENCODING("i16imm", ENCODING_IW)
1240 ENCODING("i16imm", ENCODING_Iv)
1241 ENCODING("i16i8imm", ENCODING_IB)
1242 ENCODING("i32imm", ENCODING_Iv)
1243 ENCODING("i32i8imm", ENCODING_IB)
1244 ENCODING("i64i32imm", ENCODING_ID)
1245 ENCODING("i64i8imm", ENCODING_IB)
1246 ENCODING("i8imm", ENCODING_IB)
1247 ENCODING("i64i32imm_pcrel", ENCODING_ID)
1248 ENCODING("i16imm_pcrel", ENCODING_IW)
1249 ENCODING("i32imm_pcrel", ENCODING_ID)
1250 ENCODING("brtarget", ENCODING_Iv)
1251 ENCODING("brtarget8", ENCODING_IB)
1252 ENCODING("i64imm", ENCODING_IO)
1253 ENCODING("offset8", ENCODING_Ia)
1254 ENCODING("offset16", ENCODING_Ia)
1255 ENCODING("offset32", ENCODING_Ia)
1256 ENCODING("offset64", ENCODING_Ia)
1257 errs() << "Unhandled relocation encoding " << s << "\n";
1258 llvm_unreachable("Unhandled relocation encoding");
1261 OperandEncoding RecognizableInstr::opcodeModifierEncodingFromString
1262 (const std::string &s,
1263 bool hasOpSizePrefix) {
1264 ENCODING("RST", ENCODING_I)
1265 ENCODING("GR32", ENCODING_Rv)
1266 ENCODING("GR64", ENCODING_RO)
1267 ENCODING("GR16", ENCODING_Rv)
1268 ENCODING("GR8", ENCODING_RB)
1269 ENCODING("GR16_NOAX", ENCODING_Rv)
1270 ENCODING("GR32_NOAX", ENCODING_Rv)
1271 ENCODING("GR64_NOAX", ENCODING_RO)
1272 errs() << "Unhandled opcode modifier encoding " << s << "\n";
1273 llvm_unreachable("Unhandled opcode modifier encoding");