1 //===- MipsDisassembler.cpp - Disassembler for Mips -------------*- 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 Mips Disassembler.
12 //===----------------------------------------------------------------------===//
15 #include "MipsRegisterInfo.h"
16 #include "MipsSubtarget.h"
17 #include "llvm/MC/MCDisassembler.h"
18 #include "llvm/MC/MCFixedLenDisassembler.h"
19 #include "llvm/MC/MCInst.h"
20 #include "llvm/MC/MCSubtargetInfo.h"
21 #include "llvm/Support/MathExtras.h"
22 #include "llvm/Support/MemoryObject.h"
23 #include "llvm/Support/TargetRegistry.h"
27 typedef MCDisassembler::DecodeStatus DecodeStatus;
31 /// MipsDisassemblerBase - a disasembler class for Mips.
32 class MipsDisassemblerBase : public MCDisassembler {
34 /// Constructor - Initializes the disassembler.
36 MipsDisassemblerBase(const MCSubtargetInfo &STI, const MCRegisterInfo *Info,
38 MCDisassembler(STI), RegInfo(Info),
39 IsN64(STI.getFeatureBits() & Mips::FeatureN64), isBigEndian(bigEndian) {}
41 virtual ~MipsDisassemblerBase() {}
43 const MCRegisterInfo *getRegInfo() const { return RegInfo.get(); }
45 bool isN64() const { return IsN64; }
48 OwningPtr<const MCRegisterInfo> RegInfo;
54 /// MipsDisassembler - a disasembler class for Mips32.
55 class MipsDisassembler : public MipsDisassemblerBase {
58 /// Constructor - Initializes the disassembler.
60 MipsDisassembler(const MCSubtargetInfo &STI, const MCRegisterInfo *Info,
62 MipsDisassemblerBase(STI, Info, bigEndian) {
63 IsMicroMips = STI.getFeatureBits() & Mips::FeatureMicroMips;
66 /// getInstruction - See MCDisassembler.
67 virtual DecodeStatus getInstruction(MCInst &instr,
69 const MemoryObject ®ion,
72 raw_ostream &cStream) const;
76 /// Mips64Disassembler - a disasembler class for Mips64.
77 class Mips64Disassembler : public MipsDisassemblerBase {
79 /// Constructor - Initializes the disassembler.
81 Mips64Disassembler(const MCSubtargetInfo &STI, const MCRegisterInfo *Info,
83 MipsDisassemblerBase(STI, Info, bigEndian) {}
85 /// getInstruction - See MCDisassembler.
86 virtual DecodeStatus getInstruction(MCInst &instr,
88 const MemoryObject ®ion,
91 raw_ostream &cStream) const;
94 } // end anonymous namespace
96 // Forward declare these because the autogenerated code will reference them.
97 // Definitions are further down.
98 static DecodeStatus DecodeGPR64RegisterClass(MCInst &Inst,
101 const void *Decoder);
103 static DecodeStatus DecodeCPU16RegsRegisterClass(MCInst &Inst,
106 const void *Decoder);
108 static DecodeStatus DecodeGPR32RegisterClass(MCInst &Inst,
111 const void *Decoder);
113 static DecodeStatus DecodePtrRegisterClass(MCInst &Inst,
116 const void *Decoder);
118 static DecodeStatus DecodeDSPRRegisterClass(MCInst &Inst,
121 const void *Decoder);
123 static DecodeStatus DecodeFGR64RegisterClass(MCInst &Inst,
126 const void *Decoder);
128 static DecodeStatus DecodeFGR32RegisterClass(MCInst &Inst,
131 const void *Decoder);
133 static DecodeStatus DecodeFGRH32RegisterClass(MCInst &Inst,
136 const void *Decoder);
138 static DecodeStatus DecodeCCRRegisterClass(MCInst &Inst,
141 const void *Decoder);
143 static DecodeStatus DecodeFCCRegisterClass(MCInst &Inst,
146 const void *Decoder);
148 static DecodeStatus DecodeHWRegsRegisterClass(MCInst &Inst,
151 const void *Decoder);
153 static DecodeStatus DecodeAFGR64RegisterClass(MCInst &Inst,
156 const void *Decoder);
158 static DecodeStatus DecodeACC64DSPRegisterClass(MCInst &Inst,
161 const void *Decoder);
163 static DecodeStatus DecodeHI32DSPRegisterClass(MCInst &Inst,
166 const void *Decoder);
168 static DecodeStatus DecodeLO32DSPRegisterClass(MCInst &Inst,
171 const void *Decoder);
173 static DecodeStatus DecodeMSA128BRegisterClass(MCInst &Inst,
176 const void *Decoder);
178 static DecodeStatus DecodeMSA128HRegisterClass(MCInst &Inst,
181 const void *Decoder);
183 static DecodeStatus DecodeMSA128WRegisterClass(MCInst &Inst,
186 const void *Decoder);
188 static DecodeStatus DecodeMSA128DRegisterClass(MCInst &Inst,
191 const void *Decoder);
193 static DecodeStatus DecodeMSACtrlRegisterClass(MCInst &Inst,
196 const void *Decoder);
198 static DecodeStatus DecodeBranchTarget(MCInst &Inst,
201 const void *Decoder);
203 static DecodeStatus DecodeJumpTarget(MCInst &Inst,
206 const void *Decoder);
208 // DecodeBranchTargetMM - Decode microMIPS branch offset, which is
209 // shifted left by 1 bit.
210 static DecodeStatus DecodeBranchTargetMM(MCInst &Inst,
213 const void *Decoder);
215 // DecodeJumpTargetMM - Decode microMIPS jump target, which is
216 // shifted left by 1 bit.
217 static DecodeStatus DecodeJumpTargetMM(MCInst &Inst,
220 const void *Decoder);
222 static DecodeStatus DecodeMem(MCInst &Inst,
225 const void *Decoder);
227 static DecodeStatus DecodeMSA128Mem(MCInst &Inst, unsigned Insn,
228 uint64_t Address, const void *Decoder);
230 static DecodeStatus DecodeMemMMImm12(MCInst &Inst,
233 const void *Decoder);
235 static DecodeStatus DecodeMemMMImm16(MCInst &Inst,
238 const void *Decoder);
240 static DecodeStatus DecodeFMem(MCInst &Inst, unsigned Insn,
242 const void *Decoder);
244 static DecodeStatus DecodeSimm16(MCInst &Inst,
247 const void *Decoder);
249 static DecodeStatus DecodeInsSize(MCInst &Inst,
252 const void *Decoder);
254 static DecodeStatus DecodeExtSize(MCInst &Inst,
257 const void *Decoder);
260 extern Target TheMipselTarget, TheMipsTarget, TheMips64Target,
264 static MCDisassembler *createMipsDisassembler(
266 const MCSubtargetInfo &STI) {
267 return new MipsDisassembler(STI, T.createMCRegInfo(""), true);
270 static MCDisassembler *createMipselDisassembler(
272 const MCSubtargetInfo &STI) {
273 return new MipsDisassembler(STI, T.createMCRegInfo(""), false);
276 static MCDisassembler *createMips64Disassembler(
278 const MCSubtargetInfo &STI) {
279 return new Mips64Disassembler(STI, T.createMCRegInfo(""), true);
282 static MCDisassembler *createMips64elDisassembler(
284 const MCSubtargetInfo &STI) {
285 return new Mips64Disassembler(STI, T.createMCRegInfo(""), false);
288 extern "C" void LLVMInitializeMipsDisassembler() {
289 // Register the disassembler.
290 TargetRegistry::RegisterMCDisassembler(TheMipsTarget,
291 createMipsDisassembler);
292 TargetRegistry::RegisterMCDisassembler(TheMipselTarget,
293 createMipselDisassembler);
294 TargetRegistry::RegisterMCDisassembler(TheMips64Target,
295 createMips64Disassembler);
296 TargetRegistry::RegisterMCDisassembler(TheMips64elTarget,
297 createMips64elDisassembler);
301 #include "MipsGenDisassemblerTables.inc"
303 /// readInstruction - read four bytes from the MemoryObject
304 /// and return 32 bit word sorted according to the given endianess
305 static DecodeStatus readInstruction32(const MemoryObject ®ion,
313 // We want to read exactly 4 Bytes of data.
314 if (region.readBytes(address, 4, Bytes) == -1) {
316 return MCDisassembler::Fail;
320 // Encoded as a big-endian 32-bit word in the stream.
321 insn = (Bytes[3] << 0) |
327 // Encoded as a small-endian 32-bit word in the stream.
328 // Little-endian byte ordering:
329 // mips32r2: 4 | 3 | 2 | 1
330 // microMIPS: 2 | 1 | 4 | 3
332 insn = (Bytes[2] << 0) |
337 insn = (Bytes[0] << 0) |
344 return MCDisassembler::Success;
348 MipsDisassembler::getInstruction(MCInst &instr,
350 const MemoryObject &Region,
352 raw_ostream &vStream,
353 raw_ostream &cStream) const {
356 DecodeStatus Result = readInstruction32(Region, Address, Size,
357 Insn, isBigEndian, IsMicroMips);
358 if (Result == MCDisassembler::Fail)
359 return MCDisassembler::Fail;
362 // Calling the auto-generated decoder function.
363 Result = decodeInstruction(DecoderTableMicroMips32, instr, Insn, Address,
365 if (Result != MCDisassembler::Fail) {
369 return MCDisassembler::Fail;
372 // Calling the auto-generated decoder function.
373 Result = decodeInstruction(DecoderTableMips32, instr, Insn, Address,
375 if (Result != MCDisassembler::Fail) {
380 return MCDisassembler::Fail;
384 Mips64Disassembler::getInstruction(MCInst &instr,
386 const MemoryObject &Region,
388 raw_ostream &vStream,
389 raw_ostream &cStream) const {
392 DecodeStatus Result = readInstruction32(Region, Address, Size,
393 Insn, isBigEndian, false);
394 if (Result == MCDisassembler::Fail)
395 return MCDisassembler::Fail;
397 // Calling the auto-generated decoder function.
398 Result = decodeInstruction(DecoderTableMips6432, instr, Insn, Address,
400 if (Result != MCDisassembler::Fail) {
404 // If we fail to decode in Mips64 decoder space we can try in Mips32
405 Result = decodeInstruction(DecoderTableMips32, instr, Insn, Address,
407 if (Result != MCDisassembler::Fail) {
412 return MCDisassembler::Fail;
415 static unsigned getReg(const void *D, unsigned RC, unsigned RegNo) {
416 const MipsDisassemblerBase *Dis = static_cast<const MipsDisassemblerBase*>(D);
417 return *(Dis->getRegInfo()->getRegClass(RC).begin() + RegNo);
420 static DecodeStatus DecodeCPU16RegsRegisterClass(MCInst &Inst,
423 const void *Decoder) {
425 return MCDisassembler::Fail;
429 static DecodeStatus DecodeGPR64RegisterClass(MCInst &Inst,
432 const void *Decoder) {
435 return MCDisassembler::Fail;
437 unsigned Reg = getReg(Decoder, Mips::GPR64RegClassID, RegNo);
438 Inst.addOperand(MCOperand::CreateReg(Reg));
439 return MCDisassembler::Success;
442 static DecodeStatus DecodeGPR32RegisterClass(MCInst &Inst,
445 const void *Decoder) {
447 return MCDisassembler::Fail;
448 unsigned Reg = getReg(Decoder, Mips::GPR32RegClassID, RegNo);
449 Inst.addOperand(MCOperand::CreateReg(Reg));
450 return MCDisassembler::Success;
453 static DecodeStatus DecodePtrRegisterClass(MCInst &Inst,
456 const void *Decoder) {
457 if (static_cast<const MipsDisassembler *>(Decoder)->isN64())
458 return DecodeGPR64RegisterClass(Inst, RegNo, Address, Decoder);
460 return DecodeGPR32RegisterClass(Inst, RegNo, Address, Decoder);
463 static DecodeStatus DecodeDSPRRegisterClass(MCInst &Inst,
466 const void *Decoder) {
467 return DecodeGPR32RegisterClass(Inst, RegNo, Address, Decoder);
470 static DecodeStatus DecodeFGR64RegisterClass(MCInst &Inst,
473 const void *Decoder) {
475 return MCDisassembler::Fail;
477 unsigned Reg = getReg(Decoder, Mips::FGR64RegClassID, RegNo);
478 Inst.addOperand(MCOperand::CreateReg(Reg));
479 return MCDisassembler::Success;
482 static DecodeStatus DecodeFGR32RegisterClass(MCInst &Inst,
485 const void *Decoder) {
487 return MCDisassembler::Fail;
489 unsigned Reg = getReg(Decoder, Mips::FGR32RegClassID, RegNo);
490 Inst.addOperand(MCOperand::CreateReg(Reg));
491 return MCDisassembler::Success;
494 static DecodeStatus DecodeFGRH32RegisterClass(MCInst &Inst,
497 const void *Decoder) {
499 return MCDisassembler::Fail;
501 unsigned Reg = getReg(Decoder, Mips::FGRH32RegClassID, RegNo);
502 Inst.addOperand(MCOperand::CreateReg(Reg));
503 return MCDisassembler::Success;
506 static DecodeStatus DecodeCCRRegisterClass(MCInst &Inst,
509 const void *Decoder) {
511 return MCDisassembler::Fail;
512 unsigned Reg = getReg(Decoder, Mips::CCRRegClassID, RegNo);
513 Inst.addOperand(MCOperand::CreateReg(Reg));
514 return MCDisassembler::Success;
517 static DecodeStatus DecodeFCCRegisterClass(MCInst &Inst,
520 const void *Decoder) {
522 return MCDisassembler::Fail;
523 unsigned Reg = getReg(Decoder, Mips::FCCRegClassID, RegNo);
524 Inst.addOperand(MCOperand::CreateReg(Reg));
525 return MCDisassembler::Success;
528 static DecodeStatus DecodeMem(MCInst &Inst,
531 const void *Decoder) {
532 int Offset = SignExtend32<16>(Insn & 0xffff);
533 unsigned Reg = fieldFromInstruction(Insn, 16, 5);
534 unsigned Base = fieldFromInstruction(Insn, 21, 5);
536 Reg = getReg(Decoder, Mips::GPR32RegClassID, Reg);
537 Base = getReg(Decoder, Mips::GPR32RegClassID, Base);
539 if(Inst.getOpcode() == Mips::SC){
540 Inst.addOperand(MCOperand::CreateReg(Reg));
543 Inst.addOperand(MCOperand::CreateReg(Reg));
544 Inst.addOperand(MCOperand::CreateReg(Base));
545 Inst.addOperand(MCOperand::CreateImm(Offset));
547 return MCDisassembler::Success;
550 static DecodeStatus DecodeMSA128Mem(MCInst &Inst, unsigned Insn,
551 uint64_t Address, const void *Decoder) {
552 int Offset = SignExtend32<10>(fieldFromInstruction(Insn, 16, 10));
553 unsigned Reg = fieldFromInstruction(Insn, 6, 5);
554 unsigned Base = fieldFromInstruction(Insn, 11, 5);
556 Reg = getReg(Decoder, Mips::MSA128BRegClassID, Reg);
557 Base = getReg(Decoder, Mips::GPR32RegClassID, Base);
559 Inst.addOperand(MCOperand::CreateReg(Reg));
560 Inst.addOperand(MCOperand::CreateReg(Base));
561 Inst.addOperand(MCOperand::CreateImm(Offset));
563 return MCDisassembler::Success;
566 static DecodeStatus DecodeMemMMImm12(MCInst &Inst,
569 const void *Decoder) {
570 int Offset = SignExtend32<12>(Insn & 0x0fff);
571 unsigned Reg = fieldFromInstruction(Insn, 21, 5);
572 unsigned Base = fieldFromInstruction(Insn, 16, 5);
574 Reg = getReg(Decoder, Mips::GPR32RegClassID, Reg);
575 Base = getReg(Decoder, Mips::GPR32RegClassID, Base);
577 Inst.addOperand(MCOperand::CreateReg(Reg));
578 Inst.addOperand(MCOperand::CreateReg(Base));
579 Inst.addOperand(MCOperand::CreateImm(Offset));
581 return MCDisassembler::Success;
584 static DecodeStatus DecodeMemMMImm16(MCInst &Inst,
587 const void *Decoder) {
588 int Offset = SignExtend32<16>(Insn & 0xffff);
589 unsigned Reg = fieldFromInstruction(Insn, 21, 5);
590 unsigned Base = fieldFromInstruction(Insn, 16, 5);
592 Reg = getReg(Decoder, Mips::GPR32RegClassID, Reg);
593 Base = getReg(Decoder, Mips::GPR32RegClassID, Base);
595 Inst.addOperand(MCOperand::CreateReg(Reg));
596 Inst.addOperand(MCOperand::CreateReg(Base));
597 Inst.addOperand(MCOperand::CreateImm(Offset));
599 return MCDisassembler::Success;
602 static DecodeStatus DecodeFMem(MCInst &Inst,
605 const void *Decoder) {
606 int Offset = SignExtend32<16>(Insn & 0xffff);
607 unsigned Reg = fieldFromInstruction(Insn, 16, 5);
608 unsigned Base = fieldFromInstruction(Insn, 21, 5);
610 Reg = getReg(Decoder, Mips::FGR64RegClassID, Reg);
611 Base = getReg(Decoder, Mips::GPR32RegClassID, Base);
613 Inst.addOperand(MCOperand::CreateReg(Reg));
614 Inst.addOperand(MCOperand::CreateReg(Base));
615 Inst.addOperand(MCOperand::CreateImm(Offset));
617 return MCDisassembler::Success;
621 static DecodeStatus DecodeHWRegsRegisterClass(MCInst &Inst,
624 const void *Decoder) {
625 // Currently only hardware register 29 is supported.
627 return MCDisassembler::Fail;
628 Inst.addOperand(MCOperand::CreateReg(Mips::HWR29));
629 return MCDisassembler::Success;
632 static DecodeStatus DecodeAFGR64RegisterClass(MCInst &Inst,
635 const void *Decoder) {
636 if (RegNo > 30 || RegNo %2)
637 return MCDisassembler::Fail;
640 unsigned Reg = getReg(Decoder, Mips::AFGR64RegClassID, RegNo /2);
641 Inst.addOperand(MCOperand::CreateReg(Reg));
642 return MCDisassembler::Success;
645 static DecodeStatus DecodeACC64DSPRegisterClass(MCInst &Inst,
648 const void *Decoder) {
650 return MCDisassembler::Fail;
652 unsigned Reg = getReg(Decoder, Mips::ACC64DSPRegClassID, RegNo);
653 Inst.addOperand(MCOperand::CreateReg(Reg));
654 return MCDisassembler::Success;
657 static DecodeStatus DecodeHI32DSPRegisterClass(MCInst &Inst,
660 const void *Decoder) {
662 return MCDisassembler::Fail;
664 unsigned Reg = getReg(Decoder, Mips::HI32DSPRegClassID, RegNo);
665 Inst.addOperand(MCOperand::CreateReg(Reg));
666 return MCDisassembler::Success;
669 static DecodeStatus DecodeLO32DSPRegisterClass(MCInst &Inst,
672 const void *Decoder) {
674 return MCDisassembler::Fail;
676 unsigned Reg = getReg(Decoder, Mips::LO32DSPRegClassID, RegNo);
677 Inst.addOperand(MCOperand::CreateReg(Reg));
678 return MCDisassembler::Success;
681 static DecodeStatus DecodeMSA128BRegisterClass(MCInst &Inst,
684 const void *Decoder) {
686 return MCDisassembler::Fail;
688 unsigned Reg = getReg(Decoder, Mips::MSA128BRegClassID, RegNo);
689 Inst.addOperand(MCOperand::CreateReg(Reg));
690 return MCDisassembler::Success;
693 static DecodeStatus DecodeMSA128HRegisterClass(MCInst &Inst,
696 const void *Decoder) {
698 return MCDisassembler::Fail;
700 unsigned Reg = getReg(Decoder, Mips::MSA128HRegClassID, RegNo);
701 Inst.addOperand(MCOperand::CreateReg(Reg));
702 return MCDisassembler::Success;
705 static DecodeStatus DecodeMSA128WRegisterClass(MCInst &Inst,
708 const void *Decoder) {
710 return MCDisassembler::Fail;
712 unsigned Reg = getReg(Decoder, Mips::MSA128WRegClassID, RegNo);
713 Inst.addOperand(MCOperand::CreateReg(Reg));
714 return MCDisassembler::Success;
717 static DecodeStatus DecodeMSA128DRegisterClass(MCInst &Inst,
720 const void *Decoder) {
722 return MCDisassembler::Fail;
724 unsigned Reg = getReg(Decoder, Mips::MSA128DRegClassID, RegNo);
725 Inst.addOperand(MCOperand::CreateReg(Reg));
726 return MCDisassembler::Success;
729 static DecodeStatus DecodeMSACtrlRegisterClass(MCInst &Inst,
732 const void *Decoder) {
734 return MCDisassembler::Fail;
736 unsigned Reg = getReg(Decoder, Mips::MSACtrlRegClassID, RegNo);
737 Inst.addOperand(MCOperand::CreateReg(Reg));
738 return MCDisassembler::Success;
741 static DecodeStatus DecodeBranchTarget(MCInst &Inst,
744 const void *Decoder) {
745 unsigned BranchOffset = Offset & 0xffff;
746 BranchOffset = SignExtend32<18>(BranchOffset << 2) + 4;
747 Inst.addOperand(MCOperand::CreateImm(BranchOffset));
748 return MCDisassembler::Success;
751 static DecodeStatus DecodeJumpTarget(MCInst &Inst,
754 const void *Decoder) {
756 unsigned JumpOffset = fieldFromInstruction(Insn, 0, 26) << 2;
757 Inst.addOperand(MCOperand::CreateImm(JumpOffset));
758 return MCDisassembler::Success;
761 static DecodeStatus DecodeBranchTargetMM(MCInst &Inst,
764 const void *Decoder) {
765 unsigned BranchOffset = Offset & 0xffff;
766 BranchOffset = SignExtend32<18>(BranchOffset << 1);
767 Inst.addOperand(MCOperand::CreateImm(BranchOffset));
768 return MCDisassembler::Success;
771 static DecodeStatus DecodeJumpTargetMM(MCInst &Inst,
774 const void *Decoder) {
775 unsigned JumpOffset = fieldFromInstruction(Insn, 0, 26) << 1;
776 Inst.addOperand(MCOperand::CreateImm(JumpOffset));
777 return MCDisassembler::Success;
780 static DecodeStatus DecodeSimm16(MCInst &Inst,
783 const void *Decoder) {
784 Inst.addOperand(MCOperand::CreateImm(SignExtend32<16>(Insn)));
785 return MCDisassembler::Success;
788 static DecodeStatus DecodeInsSize(MCInst &Inst,
791 const void *Decoder) {
792 // First we need to grab the pos(lsb) from MCInst.
793 int Pos = Inst.getOperand(2).getImm();
794 int Size = (int) Insn - Pos + 1;
795 Inst.addOperand(MCOperand::CreateImm(SignExtend32<16>(Size)));
796 return MCDisassembler::Success;
799 static DecodeStatus DecodeExtSize(MCInst &Inst,
802 const void *Decoder) {
803 int Size = (int) Insn + 1;
804 Inst.addOperand(MCOperand::CreateImm(SignExtend32<16>(Size)));
805 return MCDisassembler::Success;