1 //===-- ARMInstPrinter.cpp - Convert ARM MCInst to assembly syntax --------===//
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 class prints an ARM MCInst to a .s file.
12 //===----------------------------------------------------------------------===//
14 #define DEBUG_TYPE "asm-printer"
15 #include "ARMBaseInfo.h"
16 #include "ARMInstPrinter.h"
17 #include "ARMAddressingModes.h"
18 #include "llvm/MC/MCInst.h"
19 #include "llvm/MC/MCAsmInfo.h"
20 #include "llvm/MC/MCExpr.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/Support/raw_ostream.h"
25 #define GET_INSTRUCTION_NAME
26 #include "ARMGenAsmWriter.inc"
28 StringRef ARMInstPrinter::getOpcodeName(unsigned Opcode) const {
29 return getInstructionName(Opcode);
33 void ARMInstPrinter::printInst(const MCInst *MI, raw_ostream &O) {
34 // Check for MOVs and print canonical forms, instead.
35 if (MI->getOpcode() == ARM::MOVs) {
36 // FIXME: Thumb variants?
37 const MCOperand &Dst = MI->getOperand(0);
38 const MCOperand &MO1 = MI->getOperand(1);
39 const MCOperand &MO2 = MI->getOperand(2);
40 const MCOperand &MO3 = MI->getOperand(3);
42 O << '\t' << ARM_AM::getShiftOpcStr(ARM_AM::getSORegShOp(MO3.getImm()));
43 printSBitModifierOperand(MI, 6, O);
44 printPredicateOperand(MI, 4, O);
46 O << '\t' << getRegisterName(Dst.getReg())
47 << ", " << getRegisterName(MO1.getReg());
49 if (ARM_AM::getSORegShOp(MO3.getImm()) == ARM_AM::rrx)
55 O << getRegisterName(MO2.getReg());
56 assert(ARM_AM::getSORegOffset(MO3.getImm()) == 0);
58 O << "#" << ARM_AM::getSORegOffset(MO3.getImm());
64 if ((MI->getOpcode() == ARM::STM_UPD || MI->getOpcode() == ARM::t2STM_UPD) &&
65 MI->getOperand(0).getReg() == ARM::SP) {
66 const MCOperand &MO1 = MI->getOperand(2);
67 if (ARM_AM::getAM4SubMode(MO1.getImm()) == ARM_AM::db) {
69 printPredicateOperand(MI, 3, O);
71 printRegisterList(MI, 5, O);
77 if ((MI->getOpcode() == ARM::LDM_UPD || MI->getOpcode() == ARM::t2LDM_UPD) &&
78 MI->getOperand(0).getReg() == ARM::SP) {
79 const MCOperand &MO1 = MI->getOperand(2);
80 if (ARM_AM::getAM4SubMode(MO1.getImm()) == ARM_AM::ia) {
82 printPredicateOperand(MI, 3, O);
84 printRegisterList(MI, 5, O);
90 if ((MI->getOpcode() == ARM::VSTMS_UPD || MI->getOpcode() ==ARM::VSTMD_UPD) &&
91 MI->getOperand(0).getReg() == ARM::SP) {
92 const MCOperand &MO1 = MI->getOperand(2);
93 if (ARM_AM::getAM4SubMode(MO1.getImm()) == ARM_AM::db) {
95 printPredicateOperand(MI, 3, O);
97 printRegisterList(MI, 5, O);
103 if ((MI->getOpcode() == ARM::VLDMS_UPD || MI->getOpcode() ==ARM::VLDMD_UPD) &&
104 MI->getOperand(0).getReg() == ARM::SP) {
105 const MCOperand &MO1 = MI->getOperand(2);
106 if (ARM_AM::getAM4SubMode(MO1.getImm()) == ARM_AM::ia) {
108 printPredicateOperand(MI, 3, O);
110 printRegisterList(MI, 5, O);
115 printInstruction(MI, O);
118 void ARMInstPrinter::printOperand(const MCInst *MI, unsigned OpNo,
119 raw_ostream &O, const char *Modifier) {
120 const MCOperand &Op = MI->getOperand(OpNo);
122 unsigned Reg = Op.getReg();
123 O << getRegisterName(Reg);
124 } else if (Op.isImm()) {
125 assert((Modifier == 0 || Modifier[0] == 0) && "No modifiers supported");
126 O << '#' << Op.getImm();
128 assert((Modifier == 0 || Modifier[0] == 0) && "No modifiers supported");
129 assert(Op.isExpr() && "unknown operand kind in printOperand");
134 static void printSOImm(raw_ostream &O, int64_t V, raw_ostream *CommentStream,
135 const MCAsmInfo *MAI) {
136 // Break it up into two parts that make up a shifter immediate.
137 V = ARM_AM::getSOImmVal(V);
138 assert(V != -1 && "Not a valid so_imm value!");
140 unsigned Imm = ARM_AM::getSOImmValImm(V);
141 unsigned Rot = ARM_AM::getSOImmValRot(V);
143 // Print low-level immediate formation info, per
144 // A5.1.3: "Data-processing operands - Immediate".
146 O << "#" << Imm << ", " << Rot;
147 // Pretty printed version.
149 *CommentStream << (int)ARM_AM::rotr32(Imm, Rot) << "\n";
156 /// printSOImmOperand - SOImm is 4-bit rotate amount in bits 8-11 with 8-bit
157 /// immediate in bits 0-7.
158 void ARMInstPrinter::printSOImmOperand(const MCInst *MI, unsigned OpNum,
160 const MCOperand &MO = MI->getOperand(OpNum);
161 assert(MO.isImm() && "Not a valid so_imm value!");
162 printSOImm(O, MO.getImm(), CommentStream, &MAI);
165 /// printSOImm2PartOperand - SOImm is broken into two pieces using a 'mov'
166 /// followed by an 'orr' to materialize.
167 void ARMInstPrinter::printSOImm2PartOperand(const MCInst *MI, unsigned OpNum,
169 // FIXME: REMOVE this method.
173 // so_reg is a 4-operand unit corresponding to register forms of the A5.1
174 // "Addressing Mode 1 - Data-processing operands" forms. This includes:
176 // REG REG 0,SH_OPC - e.g. R5, ROR R3
177 // REG 0 IMM,SH_OPC - e.g. R5, LSL #3
178 void ARMInstPrinter::printSORegOperand(const MCInst *MI, unsigned OpNum,
180 const MCOperand &MO1 = MI->getOperand(OpNum);
181 const MCOperand &MO2 = MI->getOperand(OpNum+1);
182 const MCOperand &MO3 = MI->getOperand(OpNum+2);
184 O << getRegisterName(MO1.getReg());
186 // Print the shift opc.
187 ARM_AM::ShiftOpc ShOpc = ARM_AM::getSORegShOp(MO3.getImm());
188 O << ", " << ARM_AM::getShiftOpcStr(ShOpc);
190 O << ' ' << getRegisterName(MO2.getReg());
191 assert(ARM_AM::getSORegOffset(MO3.getImm()) == 0);
192 } else if (ShOpc != ARM_AM::rrx) {
193 O << " #" << ARM_AM::getSORegOffset(MO3.getImm());
198 void ARMInstPrinter::printAddrMode2Operand(const MCInst *MI, unsigned Op,
200 const MCOperand &MO1 = MI->getOperand(Op);
201 const MCOperand &MO2 = MI->getOperand(Op+1);
202 const MCOperand &MO3 = MI->getOperand(Op+2);
204 if (!MO1.isReg()) { // FIXME: This is for CP entries, but isn't right.
205 printOperand(MI, Op, O);
209 O << "[" << getRegisterName(MO1.getReg());
212 if (ARM_AM::getAM2Offset(MO3.getImm())) // Don't print +0.
214 << ARM_AM::getAddrOpcStr(ARM_AM::getAM2Op(MO3.getImm()))
215 << ARM_AM::getAM2Offset(MO3.getImm());
221 << ARM_AM::getAddrOpcStr(ARM_AM::getAM2Op(MO3.getImm()))
222 << getRegisterName(MO2.getReg());
224 if (unsigned ShImm = ARM_AM::getAM2Offset(MO3.getImm()))
226 << ARM_AM::getShiftOpcStr(ARM_AM::getAM2ShiftOpc(MO3.getImm()))
231 void ARMInstPrinter::printAddrMode2OffsetOperand(const MCInst *MI,
234 const MCOperand &MO1 = MI->getOperand(OpNum);
235 const MCOperand &MO2 = MI->getOperand(OpNum+1);
238 unsigned ImmOffs = ARM_AM::getAM2Offset(MO2.getImm());
240 << ARM_AM::getAddrOpcStr(ARM_AM::getAM2Op(MO2.getImm()))
245 O << ARM_AM::getAddrOpcStr(ARM_AM::getAM2Op(MO2.getImm()))
246 << getRegisterName(MO1.getReg());
248 if (unsigned ShImm = ARM_AM::getAM2Offset(MO2.getImm()))
250 << ARM_AM::getShiftOpcStr(ARM_AM::getAM2ShiftOpc(MO2.getImm()))
254 void ARMInstPrinter::printAddrMode3Operand(const MCInst *MI, unsigned OpNum,
256 const MCOperand &MO1 = MI->getOperand(OpNum);
257 const MCOperand &MO2 = MI->getOperand(OpNum+1);
258 const MCOperand &MO3 = MI->getOperand(OpNum+2);
260 O << '[' << getRegisterName(MO1.getReg());
263 O << ", " << (char)ARM_AM::getAM3Op(MO3.getImm())
264 << getRegisterName(MO2.getReg()) << ']';
268 if (unsigned ImmOffs = ARM_AM::getAM3Offset(MO3.getImm()))
270 << ARM_AM::getAddrOpcStr(ARM_AM::getAM3Op(MO3.getImm()))
275 void ARMInstPrinter::printAddrMode3OffsetOperand(const MCInst *MI,
278 const MCOperand &MO1 = MI->getOperand(OpNum);
279 const MCOperand &MO2 = MI->getOperand(OpNum+1);
282 O << (char)ARM_AM::getAM3Op(MO2.getImm())
283 << getRegisterName(MO1.getReg());
287 unsigned ImmOffs = ARM_AM::getAM3Offset(MO2.getImm());
289 << ARM_AM::getAddrOpcStr(ARM_AM::getAM3Op(MO2.getImm()))
293 void ARMInstPrinter::printLdStmModeOperand(const MCInst *MI, unsigned OpNum,
295 const char *Modifier) {
296 ARM_AM::AMSubMode Mode = ARM_AM::getAM4SubMode(MI->getOperand(OpNum)
298 O << ARM_AM::getAMSubModeStr(Mode);
301 void ARMInstPrinter::printAddrMode5Operand(const MCInst *MI, unsigned OpNum,
303 const char *Modifier) {
304 const MCOperand &MO1 = MI->getOperand(OpNum);
305 const MCOperand &MO2 = MI->getOperand(OpNum+1);
307 if (!MO1.isReg()) { // FIXME: This is for CP entries, but isn't right.
308 printOperand(MI, OpNum, O);
312 O << "[" << getRegisterName(MO1.getReg());
314 if (unsigned ImmOffs = ARM_AM::getAM5Offset(MO2.getImm())) {
316 << ARM_AM::getAddrOpcStr(ARM_AM::getAM5Op(MO2.getImm()))
322 void ARMInstPrinter::printAddrMode6Operand(const MCInst *MI, unsigned OpNum,
324 const MCOperand &MO1 = MI->getOperand(OpNum);
325 const MCOperand &MO2 = MI->getOperand(OpNum+1);
327 O << "[" << getRegisterName(MO1.getReg());
329 // FIXME: Both darwin as and GNU as violate ARM docs here.
330 O << ", :" << (MO2.getImm() << 3);
335 void ARMInstPrinter::printAddrMode6OffsetOperand(const MCInst *MI,
338 const MCOperand &MO = MI->getOperand(OpNum);
339 if (MO.getReg() == 0)
342 O << ", " << getRegisterName(MO.getReg());
345 void ARMInstPrinter::printAddrModePCOperand(const MCInst *MI, unsigned OpNum,
347 const char *Modifier) {
348 // All instructions using addrmodepc are pseudos and should have been
349 // handled explicitly in printInstructionThroughMCStreamer(). If one got
350 // here, it wasn't, so something's wrong.
351 llvm_unreachable("Unhandled PC-relative pseudo-instruction!");
354 void ARMInstPrinter::printBitfieldInvMaskImmOperand(const MCInst *MI,
357 const MCOperand &MO = MI->getOperand(OpNum);
358 uint32_t v = ~MO.getImm();
359 int32_t lsb = CountTrailingZeros_32(v);
360 int32_t width = (32 - CountLeadingZeros_32 (v)) - lsb;
361 assert(MO.isImm() && "Not a valid bf_inv_mask_imm value!");
362 O << '#' << lsb << ", #" << width;
365 void ARMInstPrinter::printMemBOption(const MCInst *MI, unsigned OpNum,
367 unsigned val = MI->getOperand(OpNum).getImm();
368 O << ARM_MB::MemBOptToString(val);
371 void ARMInstPrinter::printShiftImmOperand(const MCInst *MI, unsigned OpNum,
373 unsigned ShiftOp = MI->getOperand(OpNum).getImm();
374 ARM_AM::ShiftOpc Opc = ARM_AM::getSORegShOp(ShiftOp);
376 case ARM_AM::no_shift:
385 assert(0 && "unexpected shift opcode for shift immediate operand");
387 O << ARM_AM::getSORegOffset(ShiftOp);
390 void ARMInstPrinter::printRegisterList(const MCInst *MI, unsigned OpNum,
393 for (unsigned i = OpNum, e = MI->getNumOperands(); i != e; ++i) {
394 if (i != OpNum) O << ", ";
395 O << getRegisterName(MI->getOperand(i).getReg());
400 void ARMInstPrinter::printSetendOperand(const MCInst *MI, unsigned OpNum,
402 const MCOperand &Op = MI->getOperand(OpNum);
409 void ARMInstPrinter::printCPSOptionOperand(const MCInst *MI, unsigned OpNum,
411 const MCOperand &Op = MI->getOperand(OpNum);
412 unsigned option = Op.getImm();
413 unsigned mode = option & 31;
414 bool changemode = option >> 5 & 1;
415 unsigned AIF = option >> 6 & 7;
416 unsigned imod = option >> 9 & 3;
423 if (AIF & 4) O << 'a';
424 if (AIF & 2) O << 'i';
425 if (AIF & 1) O << 'f';
426 if (AIF > 0 && changemode) O << ", ";
432 void ARMInstPrinter::printMSRMaskOperand(const MCInst *MI, unsigned OpNum,
434 const MCOperand &Op = MI->getOperand(OpNum);
435 unsigned Mask = Op.getImm();
438 if (Mask & 8) O << 'f';
439 if (Mask & 4) O << 's';
440 if (Mask & 2) O << 'x';
441 if (Mask & 1) O << 'c';
445 void ARMInstPrinter::printNegZeroOperand(const MCInst *MI, unsigned OpNum,
447 const MCOperand &Op = MI->getOperand(OpNum);
450 O << '-' << (-Op.getImm() - 1);
455 void ARMInstPrinter::printPredicateOperand(const MCInst *MI, unsigned OpNum,
457 ARMCC::CondCodes CC = (ARMCC::CondCodes)MI->getOperand(OpNum).getImm();
459 O << ARMCondCodeToString(CC);
462 void ARMInstPrinter::printMandatoryPredicateOperand(const MCInst *MI,
465 ARMCC::CondCodes CC = (ARMCC::CondCodes)MI->getOperand(OpNum).getImm();
466 O << ARMCondCodeToString(CC);
469 void ARMInstPrinter::printSBitModifierOperand(const MCInst *MI, unsigned OpNum,
471 if (MI->getOperand(OpNum).getReg()) {
472 assert(MI->getOperand(OpNum).getReg() == ARM::CPSR &&
473 "Expect ARM CPSR register!");
478 void ARMInstPrinter::printNoHashImmediate(const MCInst *MI, unsigned OpNum,
480 O << MI->getOperand(OpNum).getImm();
483 void ARMInstPrinter::printPCLabel(const MCInst *MI, unsigned OpNum,
485 llvm_unreachable("Unhandled PC-relative pseudo-instruction!");
488 void ARMInstPrinter::printThumbS4ImmOperand(const MCInst *MI, unsigned OpNum,
490 O << "#" << MI->getOperand(OpNum).getImm() * 4;
493 void ARMInstPrinter::printThumbITMask(const MCInst *MI, unsigned OpNum,
495 // (3 - the number of trailing zeros) is the number of then / else.
496 unsigned Mask = MI->getOperand(OpNum).getImm();
497 unsigned CondBit0 = Mask >> 4 & 1;
498 unsigned NumTZ = CountTrailingZeros_32(Mask);
499 assert(NumTZ <= 3 && "Invalid IT mask!");
500 for (unsigned Pos = 3, e = NumTZ; Pos > e; --Pos) {
501 bool T = ((Mask >> Pos) & 1) == CondBit0;
509 void ARMInstPrinter::printThumbAddrModeRROperand(const MCInst *MI, unsigned Op,
511 const MCOperand &MO1 = MI->getOperand(Op);
512 const MCOperand &MO2 = MI->getOperand(Op+1);
513 O << "[" << getRegisterName(MO1.getReg());
514 O << ", " << getRegisterName(MO2.getReg()) << "]";
517 void ARMInstPrinter::printThumbAddrModeRI5Operand(const MCInst *MI, unsigned Op,
520 const MCOperand &MO1 = MI->getOperand(Op);
521 const MCOperand &MO2 = MI->getOperand(Op+1);
522 const MCOperand &MO3 = MI->getOperand(Op+2);
524 if (!MO1.isReg()) { // FIXME: This is for CP entries, but isn't right.
525 printOperand(MI, Op, O);
529 O << "[" << getRegisterName(MO1.getReg());
531 O << ", " << getRegisterName(MO3.getReg());
532 else if (unsigned ImmOffs = MO2.getImm())
533 O << ", #" << ImmOffs * Scale;
537 void ARMInstPrinter::printThumbAddrModeS1Operand(const MCInst *MI, unsigned Op,
539 printThumbAddrModeRI5Operand(MI, Op, O, 1);
542 void ARMInstPrinter::printThumbAddrModeS2Operand(const MCInst *MI, unsigned Op,
544 printThumbAddrModeRI5Operand(MI, Op, O, 2);
547 void ARMInstPrinter::printThumbAddrModeS4Operand(const MCInst *MI, unsigned Op,
549 printThumbAddrModeRI5Operand(MI, Op, O, 4);
552 void ARMInstPrinter::printThumbAddrModeSPOperand(const MCInst *MI, unsigned Op,
554 const MCOperand &MO1 = MI->getOperand(Op);
555 const MCOperand &MO2 = MI->getOperand(Op+1);
556 O << "[" << getRegisterName(MO1.getReg());
557 if (unsigned ImmOffs = MO2.getImm())
558 O << ", #" << ImmOffs*4;
562 void ARMInstPrinter::printTBAddrMode(const MCInst *MI, unsigned OpNum,
564 O << "[pc, " << getRegisterName(MI->getOperand(OpNum).getReg());
565 if (MI->getOpcode() == ARM::t2TBH)
570 // Constant shifts t2_so_reg is a 2-operand unit corresponding to the Thumb2
571 // register with shift forms.
573 // REG IMM, SH_OPC - e.g. R5, LSL #3
574 void ARMInstPrinter::printT2SOOperand(const MCInst *MI, unsigned OpNum,
576 const MCOperand &MO1 = MI->getOperand(OpNum);
577 const MCOperand &MO2 = MI->getOperand(OpNum+1);
579 unsigned Reg = MO1.getReg();
580 O << getRegisterName(Reg);
582 // Print the shift opc.
583 assert(MO2.isImm() && "Not a valid t2_so_reg value!");
584 ARM_AM::ShiftOpc ShOpc = ARM_AM::getSORegShOp(MO2.getImm());
585 O << ", " << ARM_AM::getShiftOpcStr(ShOpc);
586 if (ShOpc != ARM_AM::rrx)
587 O << " #" << ARM_AM::getSORegOffset(MO2.getImm());
590 void ARMInstPrinter::printAddrModeImm12Operand(const MCInst *MI, unsigned OpNum,
592 const MCOperand &MO1 = MI->getOperand(OpNum);
593 const MCOperand &MO2 = MI->getOperand(OpNum+1);
595 if (!MO1.isReg()) { // FIXME: This is for CP entries, but isn't right.
596 printOperand(MI, OpNum, O);
600 O << "[" << getRegisterName(MO1.getReg());
602 int32_t OffImm = (int32_t)MO2.getImm();
603 bool isSub = OffImm < 0;
604 // Special value for #-0. All others are normal.
605 if (OffImm == INT32_MIN)
608 O << ", #-" << -OffImm;
610 O << ", #" << OffImm;
614 void ARMInstPrinter::printT2AddrModeImm8Operand(const MCInst *MI,
617 const MCOperand &MO1 = MI->getOperand(OpNum);
618 const MCOperand &MO2 = MI->getOperand(OpNum+1);
620 O << "[" << getRegisterName(MO1.getReg());
622 int32_t OffImm = (int32_t)MO2.getImm();
625 O << ", #-" << -OffImm;
627 O << ", #" << OffImm;
631 void ARMInstPrinter::printT2AddrModeImm8s4Operand(const MCInst *MI,
634 const MCOperand &MO1 = MI->getOperand(OpNum);
635 const MCOperand &MO2 = MI->getOperand(OpNum+1);
637 O << "[" << getRegisterName(MO1.getReg());
639 int32_t OffImm = (int32_t)MO2.getImm() / 4;
642 O << ", #-" << -OffImm * 4;
644 O << ", #" << OffImm * 4;
648 void ARMInstPrinter::printT2AddrModeImm8OffsetOperand(const MCInst *MI,
651 const MCOperand &MO1 = MI->getOperand(OpNum);
652 int32_t OffImm = (int32_t)MO1.getImm();
655 O << "#-" << -OffImm;
660 void ARMInstPrinter::printT2AddrModeImm8s4OffsetOperand(const MCInst *MI,
663 const MCOperand &MO1 = MI->getOperand(OpNum);
664 int32_t OffImm = (int32_t)MO1.getImm() / 4;
667 O << "#-" << -OffImm * 4;
669 O << "#" << OffImm * 4;
672 void ARMInstPrinter::printT2AddrModeSoRegOperand(const MCInst *MI,
675 const MCOperand &MO1 = MI->getOperand(OpNum);
676 const MCOperand &MO2 = MI->getOperand(OpNum+1);
677 const MCOperand &MO3 = MI->getOperand(OpNum+2);
679 O << "[" << getRegisterName(MO1.getReg());
681 assert(MO2.getReg() && "Invalid so_reg load / store address!");
682 O << ", " << getRegisterName(MO2.getReg());
684 unsigned ShAmt = MO3.getImm();
686 assert(ShAmt <= 3 && "Not a valid Thumb2 addressing mode!");
687 O << ", lsl #" << ShAmt;
692 void ARMInstPrinter::printVFPf32ImmOperand(const MCInst *MI, unsigned OpNum,
694 O << '#' << (float)MI->getOperand(OpNum).getFPImm();
697 void ARMInstPrinter::printVFPf64ImmOperand(const MCInst *MI, unsigned OpNum,
699 O << '#' << MI->getOperand(OpNum).getFPImm();
702 void ARMInstPrinter::printNEONModImmOperand(const MCInst *MI, unsigned OpNum,
704 unsigned EncodedImm = MI->getOperand(OpNum).getImm();
706 uint64_t Val = ARM_AM::decodeNEONModImm(EncodedImm, EltBits);
707 O << "#0x" << utohexstr(Val);