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"
41 // A clone of X86 since we can't depend on something that is generated.
51 MRM0r = 16, MRM1r = 17, MRM2r = 18, MRM3r = 19,
52 MRM4r = 20, MRM5r = 21, MRM6r = 22, MRM7r = 23,
53 MRM0m = 24, MRM1m = 25, MRM2m = 26, MRM3m = 27,
54 MRM4m = 28, MRM5m = 29, MRM6m = 30, MRM7m = 31,
56 #define MAP(from, to) MRM_##from = to,
67 D8 = 3, D9 = 4, DA = 5, DB = 6,
68 DC = 7, DD = 8, DE = 9, DF = 10,
71 A6 = 15, A7 = 16, TF = 17
75 // If rows are added to the opcode extension tables, then corresponding entries
76 // must be added here.
78 // If the row corresponds to a single byte (i.e., 8f), then add an entry for
79 // that byte to ONE_BYTE_EXTENSION_TABLES.
81 // If the row corresponds to two bytes where the first is 0f, add an entry for
82 // the second byte to TWO_BYTE_EXTENSION_TABLES.
84 // If the row corresponds to some other set of bytes, you will need to modify
85 // the code in RecognizableInstr::emitDecodePath() as well, and add new prefixes
86 // to the X86 TD files, except in two cases: if the first two bytes of such a
87 // new combination are 0f 38 or 0f 3a, you just have to add maps called
88 // THREE_BYTE_38_EXTENSION_TABLES and THREE_BYTE_3A_EXTENSION_TABLES and add a
89 // switch(Opcode) just below the case X86Local::T8: or case X86Local::TA: line
90 // in RecognizableInstr::emitDecodePath().
92 #define ONE_BYTE_EXTENSION_TABLES \
100 EXTENSION_TABLE(c6) \
101 EXTENSION_TABLE(c7) \
102 EXTENSION_TABLE(d0) \
103 EXTENSION_TABLE(d1) \
104 EXTENSION_TABLE(d2) \
105 EXTENSION_TABLE(d3) \
106 EXTENSION_TABLE(f6) \
107 EXTENSION_TABLE(f7) \
108 EXTENSION_TABLE(fe) \
111 #define TWO_BYTE_EXTENSION_TABLES \
112 EXTENSION_TABLE(00) \
113 EXTENSION_TABLE(01) \
114 EXTENSION_TABLE(18) \
115 EXTENSION_TABLE(71) \
116 EXTENSION_TABLE(72) \
117 EXTENSION_TABLE(73) \
118 EXTENSION_TABLE(ae) \
119 EXTENSION_TABLE(ba) \
122 using namespace X86Disassembler;
124 /// needsModRMForDecode - Indicates whether a particular instruction requires a
125 /// ModR/M byte for the instruction to be properly decoded. For example, a
126 /// MRMDestReg instruction needs the Mod field in the ModR/M byte to be set to
129 /// @param form - The form of the instruction.
130 /// @return - true if the form implies that a ModR/M byte is required, false
132 static bool needsModRMForDecode(uint8_t form) {
133 if (form == X86Local::MRMDestReg ||
134 form == X86Local::MRMDestMem ||
135 form == X86Local::MRMSrcReg ||
136 form == X86Local::MRMSrcMem ||
137 (form >= X86Local::MRM0r && form <= X86Local::MRM7r) ||
138 (form >= X86Local::MRM0m && form <= X86Local::MRM7m))
144 /// isRegFormat - Indicates whether a particular form requires the Mod field of
145 /// the ModR/M byte to be 0b11.
147 /// @param form - The form of the instruction.
148 /// @return - true if the form implies that Mod must be 0b11, false
150 static bool isRegFormat(uint8_t form) {
151 if (form == X86Local::MRMDestReg ||
152 form == X86Local::MRMSrcReg ||
153 (form >= X86Local::MRM0r && form <= X86Local::MRM7r))
159 /// byteFromBitsInit - Extracts a value at most 8 bits in width from a BitsInit.
160 /// Useful for switch statements and the like.
162 /// @param init - A reference to the BitsInit to be decoded.
163 /// @return - The field, with the first bit in the BitsInit as the lowest
165 static uint8_t byteFromBitsInit(BitsInit &init) {
166 int width = init.getNumBits();
168 assert(width <= 8 && "Field is too large for uint8_t!");
175 for (index = 0; index < width; index++) {
176 if (static_cast<BitInit*>(init.getBit(index))->getValue())
185 /// byteFromRec - Extract a value at most 8 bits in with from a Record given the
186 /// name of the field.
188 /// @param rec - The record from which to extract the value.
189 /// @param name - The name of the field in the record.
190 /// @return - The field, as translated by byteFromBitsInit().
191 static uint8_t byteFromRec(const Record* rec, const std::string &name) {
192 BitsInit* bits = rec->getValueAsBitsInit(name);
193 return byteFromBitsInit(*bits);
196 RecognizableInstr::RecognizableInstr(DisassemblerTables &tables,
197 const CodeGenInstruction &insn,
202 Name = Rec->getName();
203 Spec = &tables.specForUID(UID);
205 if (!Rec->isSubClassOf("X86Inst")) {
206 ShouldBeEmitted = false;
210 Prefix = byteFromRec(Rec, "Prefix");
211 Opcode = byteFromRec(Rec, "Opcode");
212 Form = byteFromRec(Rec, "FormBits");
213 SegOvr = byteFromRec(Rec, "SegOvrBits");
215 HasOpSizePrefix = Rec->getValueAsBit("hasOpSizePrefix");
216 HasREX_WPrefix = Rec->getValueAsBit("hasREX_WPrefix");
217 HasVEXPrefix = Rec->getValueAsBit("hasVEXPrefix");
218 HasVEX_4VPrefix = Rec->getValueAsBit("hasVEX_4VPrefix");
219 HasVEX_WPrefix = Rec->getValueAsBit("hasVEX_WPrefix");
220 HasLockPrefix = Rec->getValueAsBit("hasLockPrefix");
221 IsCodeGenOnly = Rec->getValueAsBit("isCodeGenOnly");
223 Name = Rec->getName();
224 AsmString = Rec->getValueAsString("AsmString");
226 Operands = &insn.Operands.OperandList;
228 IsSSE = (HasOpSizePrefix && (Name.find("16") == Name.npos)) ||
229 (Name.find("CRC32") != Name.npos);
230 HasFROperands = hasFROperands();
231 HasVEX_LPrefix = has256BitOperands() || Rec->getValueAsBit("hasVEX_L");
233 // Check for 64-bit inst which does not require REX
236 // FIXME: Is there some better way to check for In64BitMode?
237 std::vector<Record*> Predicates = Rec->getValueAsListOfDefs("Predicates");
238 for (unsigned i = 0, e = Predicates.size(); i != e; ++i) {
239 if (Predicates[i]->getName().find("32Bit") != Name.npos) {
243 if (Predicates[i]->getName().find("64Bit") != Name.npos) {
248 // FIXME: These instructions aren't marked as 64-bit in any way
249 Is64Bit |= Rec->getName() == "JMP64pcrel32" ||
250 Rec->getName() == "MASKMOVDQU64" ||
251 Rec->getName() == "POPFS64" ||
252 Rec->getName() == "POPGS64" ||
253 Rec->getName() == "PUSHFS64" ||
254 Rec->getName() == "PUSHGS64" ||
255 Rec->getName() == "REX64_PREFIX" ||
256 Rec->getName().find("VMREAD64") != Name.npos ||
257 Rec->getName().find("VMWRITE64") != Name.npos ||
258 Rec->getName().find("MOV64") != Name.npos ||
259 Rec->getName().find("PUSH64") != Name.npos ||
260 Rec->getName().find("POP64") != Name.npos;
262 ShouldBeEmitted = true;
265 void RecognizableInstr::processInstr(DisassemblerTables &tables,
266 const CodeGenInstruction &insn,
269 // Ignore "asm parser only" instructions.
270 if (insn.TheDef->getValueAsBit("isAsmParserOnly"))
273 RecognizableInstr recogInstr(tables, insn, uid);
275 recogInstr.emitInstructionSpecifier(tables);
277 if (recogInstr.shouldBeEmitted())
278 recogInstr.emitDecodePath(tables);
281 InstructionContext RecognizableInstr::insnContext() const {
282 InstructionContext insnContext;
284 if (HasVEX_4VPrefix || HasVEXPrefix) {
285 if (HasOpSizePrefix && HasVEX_LPrefix)
286 insnContext = IC_VEX_L_OPSIZE;
287 else if (HasOpSizePrefix && HasVEX_WPrefix)
288 insnContext = IC_VEX_W_OPSIZE;
289 else if (HasOpSizePrefix)
290 insnContext = IC_VEX_OPSIZE;
291 else if (HasVEX_LPrefix && Prefix == X86Local::XS)
292 insnContext = IC_VEX_L_XS;
293 else if (HasVEX_LPrefix && Prefix == X86Local::XD)
294 insnContext = IC_VEX_L_XD;
295 else if (HasVEX_WPrefix && Prefix == X86Local::XS)
296 insnContext = IC_VEX_W_XS;
297 else if (HasVEX_WPrefix && Prefix == X86Local::XD)
298 insnContext = IC_VEX_W_XD;
299 else if (HasVEX_WPrefix)
300 insnContext = IC_VEX_W;
301 else if (HasVEX_LPrefix)
302 insnContext = IC_VEX_L;
303 else if (Prefix == X86Local::XD)
304 insnContext = IC_VEX_XD;
305 else if (Prefix == X86Local::XS)
306 insnContext = IC_VEX_XS;
308 insnContext = IC_VEX;
309 } else if (Is64Bit || HasREX_WPrefix) {
310 if (HasREX_WPrefix && HasOpSizePrefix)
311 insnContext = IC_64BIT_REXW_OPSIZE;
312 else if (HasOpSizePrefix && (Prefix == X86Local::XD || Prefix == X86Local::TF))
313 insnContext = IC_64BIT_XD_OPSIZE;
314 else if (HasOpSizePrefix)
315 insnContext = IC_64BIT_OPSIZE;
316 else if (HasREX_WPrefix && Prefix == X86Local::XS)
317 insnContext = IC_64BIT_REXW_XS;
318 else if (HasREX_WPrefix && (Prefix == X86Local::XD || Prefix == X86Local::TF))
319 insnContext = IC_64BIT_REXW_XD;
320 else if (Prefix == X86Local::XD || Prefix == X86Local::TF)
321 insnContext = IC_64BIT_XD;
322 else if (Prefix == X86Local::XS)
323 insnContext = IC_64BIT_XS;
324 else if (HasREX_WPrefix)
325 insnContext = IC_64BIT_REXW;
327 insnContext = IC_64BIT;
329 if (HasOpSizePrefix &&
330 (Prefix == X86Local::XD || Prefix == X86Local::TF))
331 insnContext = IC_XD_OPSIZE;
332 else if (HasOpSizePrefix)
333 insnContext = IC_OPSIZE;
334 else if (Prefix == X86Local::XD || Prefix == X86Local::TF)
336 else if (Prefix == X86Local::XS || Prefix == X86Local::REP)
345 RecognizableInstr::filter_ret RecognizableInstr::filter() const {
350 // Filter out intrinsics
352 if (!Rec->isSubClassOf("X86Inst"))
353 return FILTER_STRONG;
355 if (Form == X86Local::Pseudo ||
356 (IsCodeGenOnly && Name.find("_REV") == Name.npos))
357 return FILTER_STRONG;
359 if (Form == X86Local::MRMInitReg)
360 return FILTER_STRONG;
363 // Filter out artificial instructions
365 if (Name.find("TAILJMP") != Name.npos ||
366 Name.find("_Int") != Name.npos ||
367 Name.find("_int") != Name.npos ||
368 Name.find("Int_") != Name.npos ||
369 Name.find("_NOREX") != Name.npos ||
370 Name.find("_TC") != Name.npos ||
371 Name.find("EH_RETURN") != Name.npos ||
372 Name.find("V_SET") != Name.npos ||
373 Name.find("LOCK_") != Name.npos ||
374 Name.find("WIN") != Name.npos ||
375 Name.find("_AVX") != Name.npos ||
376 Name.find("2SDL") != Name.npos)
377 return FILTER_STRONG;
379 // Filter out instructions with segment override prefixes.
380 // They're too messy to handle now and we'll special case them if needed.
383 return FILTER_STRONG;
385 // Filter out instructions that can't be printed.
387 if (AsmString.size() == 0)
388 return FILTER_STRONG;
390 // Filter out instructions with subreg operands.
392 if (AsmString.find("subreg") != AsmString.npos)
393 return FILTER_STRONG;
400 // Filter out instructions with a LOCK prefix;
401 // prefer forms that do not have the prefix
405 // Filter out alternate forms of AVX instructions
406 if (Name.find("_alt") != Name.npos ||
407 Name.find("XrYr") != Name.npos ||
408 (Name.find("r64r") != Name.npos && Name.find("r64r64") == Name.npos) ||
409 Name.find("_64mr") != Name.npos ||
410 Name.find("Xrr") != Name.npos ||
411 Name.find("rr64") != Name.npos)
414 if (Name == "VMASKMOVDQU64" ||
415 Name == "VEXTRACTPSrr64" ||
416 Name == "VMOVQd64rr" ||
417 Name == "VMOVQs64rr")
422 if (Name.find("PCMPISTRI") != Name.npos && Name != "PCMPISTRI")
424 if (Name.find("PCMPESTRI") != Name.npos && Name != "PCMPESTRI")
427 if (Name.find("MOV") != Name.npos && Name.find("r0") != Name.npos)
429 if (Name.find("MOVZ") != Name.npos && Name.find("MOVZX") == Name.npos)
431 if (Name.find("Fs") != Name.npos)
433 if (Name == "MOVLPDrr" ||
434 Name == "MOVLPSrr" ||
440 Name == "MOVSX16rm8" ||
441 Name == "MOVSX16rr8" ||
442 Name == "MOVZX16rm8" ||
443 Name == "MOVZX16rr8" ||
444 Name == "PUSH32i16" ||
445 Name == "PUSH64i16" ||
446 Name == "MOVPQI2QImr" ||
447 Name == "VMOVPQI2QImr" ||
452 Name == "MMX_MOVD64rrv164" ||
453 Name == "CRC32m16" ||
454 Name == "MOV64ri64i32" ||
458 if (HasFROperands && Name.find("MOV") != Name.npos &&
459 ((Name.find("2") != Name.npos && Name.find("32") == Name.npos) ||
460 (Name.find("to") != Name.npos)))
463 return FILTER_NORMAL;
466 bool RecognizableInstr::hasFROperands() const {
467 const std::vector<CGIOperandList::OperandInfo> &OperandList = *Operands;
468 unsigned numOperands = OperandList.size();
470 for (unsigned operandIndex = 0; operandIndex < numOperands; ++operandIndex) {
471 const std::string &recName = OperandList[operandIndex].Rec->getName();
473 if (recName.find("FR") != recName.npos)
479 bool RecognizableInstr::has256BitOperands() const {
480 const std::vector<CGIOperandList::OperandInfo> &OperandList = *Operands;
481 unsigned numOperands = OperandList.size();
483 for (unsigned operandIndex = 0; operandIndex < numOperands; ++operandIndex) {
484 const std::string &recName = OperandList[operandIndex].Rec->getName();
486 if (!recName.compare("VR256") || !recName.compare("f256mem")) {
493 void RecognizableInstr::handleOperand(
495 unsigned &operandIndex,
496 unsigned &physicalOperandIndex,
497 unsigned &numPhysicalOperands,
498 unsigned *operandMapping,
499 OperandEncoding (*encodingFromString)(const std::string&, bool hasOpSizePrefix)) {
501 if (physicalOperandIndex >= numPhysicalOperands)
504 assert(physicalOperandIndex < numPhysicalOperands);
507 while (operandMapping[operandIndex] != operandIndex) {
508 Spec->operands[operandIndex].encoding = ENCODING_DUP;
509 Spec->operands[operandIndex].type =
510 (OperandType)(TYPE_DUP0 + operandMapping[operandIndex]);
514 const std::string &typeName = (*Operands)[operandIndex].Rec->getName();
516 Spec->operands[operandIndex].encoding = encodingFromString(typeName,
518 Spec->operands[operandIndex].type = typeFromString(typeName,
524 ++physicalOperandIndex;
527 void RecognizableInstr::emitInstructionSpecifier(DisassemblerTables &tables) {
530 if (!Rec->isSubClassOf("X86Inst"))
535 Spec->filtered = true;
538 ShouldBeEmitted = false;
544 Spec->insnContext = insnContext();
546 const std::vector<CGIOperandList::OperandInfo> &OperandList = *Operands;
548 unsigned operandIndex;
549 unsigned numOperands = OperandList.size();
550 unsigned numPhysicalOperands = 0;
552 // operandMapping maps from operands in OperandList to their originals.
553 // If operandMapping[i] != i, then the entry is a duplicate.
554 unsigned operandMapping[X86_MAX_OPERANDS];
556 bool hasFROperands = false;
558 assert(numOperands < X86_MAX_OPERANDS && "X86_MAX_OPERANDS is not large enough");
560 for (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] = Constraint.getTiedOperand();
567 ++numPhysicalOperands;
568 operandMapping[operandIndex] = operandIndex;
571 ++numPhysicalOperands;
572 operandMapping[operandIndex] = operandIndex;
575 const std::string &recName = OperandList[operandIndex].Rec->getName();
577 if (recName.find("FR") != recName.npos)
578 hasFROperands = true;
581 if (hasFROperands && Name.find("MOV") != Name.npos &&
582 ((Name.find("2") != Name.npos && Name.find("32") == Name.npos) ||
583 (Name.find("to") != Name.npos)))
584 ShouldBeEmitted = false;
586 if (!ShouldBeEmitted)
589 #define HANDLE_OPERAND(class) \
590 handleOperand(false, \
592 physicalOperandIndex, \
593 numPhysicalOperands, \
595 class##EncodingFromString);
597 #define HANDLE_OPTIONAL(class) \
598 handleOperand(true, \
600 physicalOperandIndex, \
601 numPhysicalOperands, \
603 class##EncodingFromString);
605 // operandIndex should always be < numOperands
607 // physicalOperandIndex should always be < numPhysicalOperands
608 unsigned physicalOperandIndex = 0;
611 case X86Local::RawFrm:
612 // Operand 1 (optional) is an address or immediate.
613 // Operand 2 (optional) is an immediate.
614 assert(numPhysicalOperands <= 2 &&
615 "Unexpected number of operands for RawFrm");
616 HANDLE_OPTIONAL(relocation)
617 HANDLE_OPTIONAL(immediate)
619 case X86Local::AddRegFrm:
620 // Operand 1 is added to the opcode.
621 // Operand 2 (optional) is an address.
622 assert(numPhysicalOperands >= 1 && numPhysicalOperands <= 2 &&
623 "Unexpected number of operands for AddRegFrm");
624 HANDLE_OPERAND(opcodeModifier)
625 HANDLE_OPTIONAL(relocation)
627 case X86Local::MRMDestReg:
628 // Operand 1 is a register operand in the R/M field.
629 // Operand 2 is a register operand in the Reg/Opcode field.
630 // - In AVX, there is a register operand in the VEX.vvvv field here -
631 // Operand 3 (optional) is an immediate.
633 assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 4 &&
634 "Unexpected number of operands for MRMDestRegFrm with VEX_4V");
636 assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
637 "Unexpected number of operands for MRMDestRegFrm");
639 HANDLE_OPERAND(rmRegister)
642 // FIXME: In AVX, the register below becomes the one encoded
643 // in ModRMVEX and the one above the one in the VEX.VVVV field
644 HANDLE_OPERAND(vvvvRegister)
646 HANDLE_OPERAND(roRegister)
647 HANDLE_OPTIONAL(immediate)
649 case X86Local::MRMDestMem:
650 // Operand 1 is a memory operand (possibly SIB-extended)
651 // Operand 2 is a register operand in the Reg/Opcode field.
652 // - In AVX, there is a register operand in the VEX.vvvv field here -
653 // Operand 3 (optional) is an immediate.
655 assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 4 &&
656 "Unexpected number of operands for MRMDestMemFrm with VEX_4V");
658 assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
659 "Unexpected number of operands for MRMDestMemFrm");
660 HANDLE_OPERAND(memory)
663 // FIXME: In AVX, the register below becomes the one encoded
664 // in ModRMVEX and the one above the one in the VEX.VVVV field
665 HANDLE_OPERAND(vvvvRegister)
667 HANDLE_OPERAND(roRegister)
668 HANDLE_OPTIONAL(immediate)
670 case X86Local::MRMSrcReg:
671 // Operand 1 is a register operand in the Reg/Opcode field.
672 // Operand 2 is a register operand in the R/M field.
673 // - In AVX, there is a register operand in the VEX.vvvv field here -
674 // Operand 3 (optional) is an immediate.
677 assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 4 &&
678 "Unexpected number of operands for MRMSrcRegFrm with VEX_4V");
680 assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
681 "Unexpected number of operands for MRMSrcRegFrm");
683 HANDLE_OPERAND(roRegister)
686 // FIXME: In AVX, the register below becomes the one encoded
687 // in ModRMVEX and the one above the one in the VEX.VVVV field
688 HANDLE_OPERAND(vvvvRegister)
690 HANDLE_OPERAND(rmRegister)
691 HANDLE_OPTIONAL(immediate)
693 case X86Local::MRMSrcMem:
694 // Operand 1 is a register operand in the Reg/Opcode field.
695 // Operand 2 is a memory operand (possibly SIB-extended)
696 // - In AVX, there is a register operand in the VEX.vvvv field here -
697 // Operand 3 (optional) is an immediate.
700 assert(numPhysicalOperands >= 3 && numPhysicalOperands <= 4 &&
701 "Unexpected number of operands for MRMSrcMemFrm with VEX_4V");
703 assert(numPhysicalOperands >= 2 && numPhysicalOperands <= 3 &&
704 "Unexpected number of operands for MRMSrcMemFrm");
706 HANDLE_OPERAND(roRegister)
709 // FIXME: In AVX, the register below becomes the one encoded
710 // in ModRMVEX and the one above the one in the VEX.VVVV field
711 HANDLE_OPERAND(vvvvRegister)
713 HANDLE_OPERAND(memory)
714 HANDLE_OPTIONAL(immediate)
716 case X86Local::MRM0r:
717 case X86Local::MRM1r:
718 case X86Local::MRM2r:
719 case X86Local::MRM3r:
720 case X86Local::MRM4r:
721 case X86Local::MRM5r:
722 case X86Local::MRM6r:
723 case X86Local::MRM7r:
724 // Operand 1 is a register operand in the R/M field.
725 // Operand 2 (optional) is an immediate or relocation.
727 assert(numPhysicalOperands <= 3 &&
728 "Unexpected number of operands for MRMSrcMemFrm with VEX_4V");
730 assert(numPhysicalOperands <= 2 &&
731 "Unexpected number of operands for MRMnRFrm");
733 HANDLE_OPERAND(vvvvRegister);
734 HANDLE_OPTIONAL(rmRegister)
735 HANDLE_OPTIONAL(relocation)
737 case X86Local::MRM0m:
738 case X86Local::MRM1m:
739 case X86Local::MRM2m:
740 case X86Local::MRM3m:
741 case X86Local::MRM4m:
742 case X86Local::MRM5m:
743 case X86Local::MRM6m:
744 case X86Local::MRM7m:
745 // Operand 1 is a memory operand (possibly SIB-extended)
746 // Operand 2 (optional) is an immediate or relocation.
747 assert(numPhysicalOperands >= 1 && numPhysicalOperands <= 2 &&
748 "Unexpected number of operands for MRMnMFrm");
749 HANDLE_OPERAND(memory)
750 HANDLE_OPTIONAL(relocation)
752 case X86Local::RawFrmImm8:
753 // operand 1 is a 16-bit immediate
754 // operand 2 is an 8-bit immediate
755 assert(numPhysicalOperands == 2 &&
756 "Unexpected number of operands for X86Local::RawFrmImm8");
757 HANDLE_OPERAND(immediate)
758 HANDLE_OPERAND(immediate)
760 case X86Local::RawFrmImm16:
761 // operand 1 is a 16-bit immediate
762 // operand 2 is a 16-bit immediate
763 HANDLE_OPERAND(immediate)
764 HANDLE_OPERAND(immediate)
766 case X86Local::MRMInitReg:
771 #undef HANDLE_OPERAND
772 #undef HANDLE_OPTIONAL
775 void RecognizableInstr::emitDecodePath(DisassemblerTables &tables) const {
776 // Special cases where the LLVM tables are not complete
778 #define MAP(from, to) \
779 case X86Local::MRM_##from: \
780 filter = new ExactFilter(0x##from); \
783 OpcodeType opcodeType = (OpcodeType)-1;
785 ModRMFilter* filter = NULL;
786 uint8_t opcodeToSet = 0;
789 // Extended two-byte opcodes can start with f2 0f, f3 0f, or 0f
793 opcodeType = TWOBYTE;
797 if (needsModRMForDecode(Form))
798 filter = new ModFilter(isRegFormat(Form));
800 filter = new DumbFilter();
802 #define EXTENSION_TABLE(n) case 0x##n:
803 TWO_BYTE_EXTENSION_TABLES
804 #undef EXTENSION_TABLE
807 llvm_unreachable("Unhandled two-byte extended opcode");
808 case X86Local::MRM0r:
809 case X86Local::MRM1r:
810 case X86Local::MRM2r:
811 case X86Local::MRM3r:
812 case X86Local::MRM4r:
813 case X86Local::MRM5r:
814 case X86Local::MRM6r:
815 case X86Local::MRM7r:
816 filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
818 case X86Local::MRM0m:
819 case X86Local::MRM1m:
820 case X86Local::MRM2m:
821 case X86Local::MRM3m:
822 case X86Local::MRM4m:
823 case X86Local::MRM5m:
824 case X86Local::MRM6m:
825 case X86Local::MRM7m:
826 filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
832 opcodeToSet = Opcode;
836 opcodeType = THREEBYTE_38;
837 if (needsModRMForDecode(Form))
838 filter = new ModFilter(isRegFormat(Form));
840 filter = new DumbFilter();
841 opcodeToSet = Opcode;
844 opcodeType = THREEBYTE_3A;
845 if (needsModRMForDecode(Form))
846 filter = new ModFilter(isRegFormat(Form));
848 filter = new DumbFilter();
849 opcodeToSet = Opcode;
852 opcodeType = THREEBYTE_A6;
853 if (needsModRMForDecode(Form))
854 filter = new ModFilter(isRegFormat(Form));
856 filter = new DumbFilter();
857 opcodeToSet = Opcode;
860 opcodeType = THREEBYTE_A7;
861 if (needsModRMForDecode(Form))
862 filter = new ModFilter(isRegFormat(Form));
864 filter = new DumbFilter();
865 opcodeToSet = Opcode;
875 assert(Opcode >= 0xc0 && "Unexpected opcode for an escape opcode");
876 opcodeType = ONEBYTE;
877 if (Form == X86Local::AddRegFrm) {
878 Spec->modifierType = MODIFIER_MODRM;
879 Spec->modifierBase = Opcode;
880 filter = new AddRegEscapeFilter(Opcode);
882 filter = new EscapeFilter(true, Opcode);
884 opcodeToSet = 0xd8 + (Prefix - X86Local::D8);
888 opcodeType = ONEBYTE;
890 #define EXTENSION_TABLE(n) case 0x##n:
891 ONE_BYTE_EXTENSION_TABLES
892 #undef EXTENSION_TABLE
895 llvm_unreachable("Fell through the cracks of a single-byte "
897 case X86Local::MRM0r:
898 case X86Local::MRM1r:
899 case X86Local::MRM2r:
900 case X86Local::MRM3r:
901 case X86Local::MRM4r:
902 case X86Local::MRM5r:
903 case X86Local::MRM6r:
904 case X86Local::MRM7r:
905 filter = new ExtendedFilter(true, Form - X86Local::MRM0r);
907 case X86Local::MRM0m:
908 case X86Local::MRM1m:
909 case X86Local::MRM2m:
910 case X86Local::MRM3m:
911 case X86Local::MRM4m:
912 case X86Local::MRM5m:
913 case X86Local::MRM6m:
914 case X86Local::MRM7m:
915 filter = new ExtendedFilter(false, Form - X86Local::MRM0m);
928 filter = new EscapeFilter(false, Form - X86Local::MRM0m);
931 if (needsModRMForDecode(Form))
932 filter = new ModFilter(isRegFormat(Form));
934 filter = new DumbFilter();
937 opcodeToSet = Opcode;
940 assert(opcodeType != (OpcodeType)-1 &&
941 "Opcode type not set");
942 assert(filter && "Filter not set");
944 if (Form == X86Local::AddRegFrm) {
945 if(Spec->modifierType != MODIFIER_MODRM) {
946 assert(opcodeToSet < 0xf9 &&
947 "Not enough room for all ADDREG_FRM operands");
949 uint8_t currentOpcode;
951 for (currentOpcode = opcodeToSet;
952 currentOpcode < opcodeToSet + 8;
954 tables.setTableFields(opcodeType,
960 Spec->modifierType = MODIFIER_OPCODE;
961 Spec->modifierBase = opcodeToSet;
963 // modifierBase was set where MODIFIER_MODRM was set
964 tables.setTableFields(opcodeType,
971 tables.setTableFields(opcodeType,
977 Spec->modifierType = MODIFIER_NONE;
978 Spec->modifierBase = opcodeToSet;
986 #define TYPE(str, type) if (s == str) return type;
987 OperandType RecognizableInstr::typeFromString(const std::string &s,
990 bool hasOpSizePrefix) {
992 // For SSE instructions, we ignore the OpSize prefix and force operand
994 TYPE("GR16", TYPE_R16)
995 TYPE("GR32", TYPE_R32)
996 TYPE("GR64", TYPE_R64)
999 // For instructions with a REX_W prefix, a declared 32-bit register encoding
1001 TYPE("GR32", TYPE_R32)
1003 if(!hasOpSizePrefix) {
1004 // For instructions without an OpSize prefix, a declared 16-bit register or
1005 // immediate encoding is special.
1006 TYPE("GR16", TYPE_R16)
1007 TYPE("i16imm", TYPE_IMM16)
1009 TYPE("i16mem", TYPE_Mv)
1010 TYPE("i16imm", TYPE_IMMv)
1011 TYPE("i16i8imm", TYPE_IMMv)
1012 TYPE("GR16", TYPE_Rv)
1013 TYPE("i32mem", TYPE_Mv)
1014 TYPE("i32imm", TYPE_IMMv)
1015 TYPE("i32i8imm", TYPE_IMM32)
1016 TYPE("u32u8imm", TYPE_IMM32)
1017 TYPE("GR32", TYPE_Rv)
1018 TYPE("i64mem", TYPE_Mv)
1019 TYPE("i64i32imm", TYPE_IMM64)
1020 TYPE("i64i8imm", TYPE_IMM64)
1021 TYPE("GR64", TYPE_R64)
1022 TYPE("i8mem", TYPE_M8)
1023 TYPE("i8imm", TYPE_IMM8)
1024 TYPE("GR8", TYPE_R8)
1025 TYPE("VR128", TYPE_XMM128)
1026 TYPE("f128mem", TYPE_M128)
1027 TYPE("f256mem", TYPE_M256)
1028 TYPE("FR64", TYPE_XMM64)
1029 TYPE("f64mem", TYPE_M64FP)
1030 TYPE("sdmem", TYPE_M64FP)
1031 TYPE("FR32", TYPE_XMM32)
1032 TYPE("f32mem", TYPE_M32FP)
1033 TYPE("ssmem", TYPE_M32FP)
1034 TYPE("RST", TYPE_ST)
1035 TYPE("i128mem", TYPE_M128)
1036 TYPE("i256mem", TYPE_M256)
1037 TYPE("i64i32imm_pcrel", TYPE_REL64)
1038 TYPE("i16imm_pcrel", TYPE_REL16)
1039 TYPE("i32imm_pcrel", TYPE_REL32)
1040 TYPE("SSECC", TYPE_IMM3)
1041 TYPE("brtarget", TYPE_RELv)
1042 TYPE("uncondbrtarget", TYPE_RELv)
1043 TYPE("brtarget8", TYPE_REL8)
1044 TYPE("f80mem", TYPE_M80FP)
1045 TYPE("lea32mem", TYPE_LEA)
1046 TYPE("lea64_32mem", TYPE_LEA)
1047 TYPE("lea64mem", TYPE_LEA)
1048 TYPE("VR64", TYPE_MM64)
1049 TYPE("i64imm", TYPE_IMMv)
1050 TYPE("opaque32mem", TYPE_M1616)
1051 TYPE("opaque48mem", TYPE_M1632)
1052 TYPE("opaque80mem", TYPE_M1664)
1053 TYPE("opaque512mem", TYPE_M512)
1054 TYPE("SEGMENT_REG", TYPE_SEGMENTREG)
1055 TYPE("DEBUG_REG", TYPE_DEBUGREG)
1056 TYPE("CONTROL_REG", TYPE_CONTROLREG)
1057 TYPE("offset8", TYPE_MOFFS8)
1058 TYPE("offset16", TYPE_MOFFS16)
1059 TYPE("offset32", TYPE_MOFFS32)
1060 TYPE("offset64", TYPE_MOFFS64)
1061 TYPE("VR256", TYPE_XMM256)
1062 errs() << "Unhandled type string " << s << "\n";
1063 llvm_unreachable("Unhandled type string");
1067 #define ENCODING(str, encoding) if (s == str) return encoding;
1068 OperandEncoding RecognizableInstr::immediateEncodingFromString
1069 (const std::string &s,
1070 bool hasOpSizePrefix) {
1071 if(!hasOpSizePrefix) {
1072 // For instructions without an OpSize prefix, a declared 16-bit register or
1073 // immediate encoding is special.
1074 ENCODING("i16imm", ENCODING_IW)
1076 ENCODING("i32i8imm", ENCODING_IB)
1077 ENCODING("u32u8imm", ENCODING_IB)
1078 ENCODING("SSECC", ENCODING_IB)
1079 ENCODING("i16imm", ENCODING_Iv)
1080 ENCODING("i16i8imm", ENCODING_IB)
1081 ENCODING("i32imm", ENCODING_Iv)
1082 ENCODING("i64i32imm", ENCODING_ID)
1083 ENCODING("i64i8imm", ENCODING_IB)
1084 ENCODING("i8imm", ENCODING_IB)
1085 // This is not a typo. Instructions like BLENDVPD put
1086 // register IDs in 8-bit immediates nowadays.
1087 ENCODING("VR256", ENCODING_IB)
1088 ENCODING("VR128", ENCODING_IB)
1089 errs() << "Unhandled immediate encoding " << s << "\n";
1090 llvm_unreachable("Unhandled immediate encoding");
1093 OperandEncoding RecognizableInstr::rmRegisterEncodingFromString
1094 (const std::string &s,
1095 bool hasOpSizePrefix) {
1096 ENCODING("GR16", ENCODING_RM)
1097 ENCODING("GR32", ENCODING_RM)
1098 ENCODING("GR64", ENCODING_RM)
1099 ENCODING("GR8", ENCODING_RM)
1100 ENCODING("VR128", ENCODING_RM)
1101 ENCODING("FR64", ENCODING_RM)
1102 ENCODING("FR32", ENCODING_RM)
1103 ENCODING("VR64", ENCODING_RM)
1104 ENCODING("VR256", ENCODING_RM)
1105 errs() << "Unhandled R/M register encoding " << s << "\n";
1106 llvm_unreachable("Unhandled R/M register encoding");
1109 OperandEncoding RecognizableInstr::roRegisterEncodingFromString
1110 (const std::string &s,
1111 bool hasOpSizePrefix) {
1112 ENCODING("GR16", ENCODING_REG)
1113 ENCODING("GR32", ENCODING_REG)
1114 ENCODING("GR64", ENCODING_REG)
1115 ENCODING("GR8", ENCODING_REG)
1116 ENCODING("VR128", ENCODING_REG)
1117 ENCODING("FR64", ENCODING_REG)
1118 ENCODING("FR32", ENCODING_REG)
1119 ENCODING("VR64", ENCODING_REG)
1120 ENCODING("SEGMENT_REG", ENCODING_REG)
1121 ENCODING("DEBUG_REG", ENCODING_REG)
1122 ENCODING("CONTROL_REG", ENCODING_REG)
1123 ENCODING("VR256", ENCODING_REG)
1124 errs() << "Unhandled reg/opcode register encoding " << s << "\n";
1125 llvm_unreachable("Unhandled reg/opcode register encoding");
1128 OperandEncoding RecognizableInstr::vvvvRegisterEncodingFromString
1129 (const std::string &s,
1130 bool hasOpSizePrefix) {
1131 ENCODING("FR32", ENCODING_VVVV)
1132 ENCODING("FR64", ENCODING_VVVV)
1133 ENCODING("VR128", ENCODING_VVVV)
1134 ENCODING("VR256", ENCODING_VVVV)
1135 errs() << "Unhandled VEX.vvvv register encoding " << s << "\n";
1136 llvm_unreachable("Unhandled VEX.vvvv register encoding");
1139 OperandEncoding RecognizableInstr::memoryEncodingFromString
1140 (const std::string &s,
1141 bool hasOpSizePrefix) {
1142 ENCODING("i16mem", ENCODING_RM)
1143 ENCODING("i32mem", ENCODING_RM)
1144 ENCODING("i64mem", ENCODING_RM)
1145 ENCODING("i8mem", ENCODING_RM)
1146 ENCODING("ssmem", ENCODING_RM)
1147 ENCODING("sdmem", ENCODING_RM)
1148 ENCODING("f128mem", ENCODING_RM)
1149 ENCODING("f256mem", ENCODING_RM)
1150 ENCODING("f64mem", ENCODING_RM)
1151 ENCODING("f32mem", ENCODING_RM)
1152 ENCODING("i128mem", ENCODING_RM)
1153 ENCODING("i256mem", ENCODING_RM)
1154 ENCODING("f80mem", ENCODING_RM)
1155 ENCODING("lea32mem", ENCODING_RM)
1156 ENCODING("lea64_32mem", ENCODING_RM)
1157 ENCODING("lea64mem", ENCODING_RM)
1158 ENCODING("opaque32mem", ENCODING_RM)
1159 ENCODING("opaque48mem", ENCODING_RM)
1160 ENCODING("opaque80mem", ENCODING_RM)
1161 ENCODING("opaque512mem", ENCODING_RM)
1162 errs() << "Unhandled memory encoding " << s << "\n";
1163 llvm_unreachable("Unhandled memory encoding");
1166 OperandEncoding RecognizableInstr::relocationEncodingFromString
1167 (const std::string &s,
1168 bool hasOpSizePrefix) {
1169 if(!hasOpSizePrefix) {
1170 // For instructions without an OpSize prefix, a declared 16-bit register or
1171 // immediate encoding is special.
1172 ENCODING("i16imm", ENCODING_IW)
1174 ENCODING("i16imm", ENCODING_Iv)
1175 ENCODING("i16i8imm", ENCODING_IB)
1176 ENCODING("i32imm", ENCODING_Iv)
1177 ENCODING("i32i8imm", ENCODING_IB)
1178 ENCODING("i64i32imm", ENCODING_ID)
1179 ENCODING("i64i8imm", ENCODING_IB)
1180 ENCODING("i8imm", ENCODING_IB)
1181 ENCODING("i64i32imm_pcrel", ENCODING_ID)
1182 ENCODING("i16imm_pcrel", ENCODING_IW)
1183 ENCODING("i32imm_pcrel", ENCODING_ID)
1184 ENCODING("brtarget", ENCODING_Iv)
1185 ENCODING("brtarget8", ENCODING_IB)
1186 ENCODING("i64imm", ENCODING_IO)
1187 ENCODING("offset8", ENCODING_Ia)
1188 ENCODING("offset16", ENCODING_Ia)
1189 ENCODING("offset32", ENCODING_Ia)
1190 ENCODING("offset64", ENCODING_Ia)
1191 errs() << "Unhandled relocation encoding " << s << "\n";
1192 llvm_unreachable("Unhandled relocation encoding");
1195 OperandEncoding RecognizableInstr::opcodeModifierEncodingFromString
1196 (const std::string &s,
1197 bool hasOpSizePrefix) {
1198 ENCODING("RST", ENCODING_I)
1199 ENCODING("GR32", ENCODING_Rv)
1200 ENCODING("GR64", ENCODING_RO)
1201 ENCODING("GR16", ENCODING_Rv)
1202 ENCODING("GR8", ENCODING_RB)
1203 errs() << "Unhandled opcode modifier encoding " << s << "\n";
1204 llvm_unreachable("Unhandled opcode modifier encoding");