lib/Target/Mips/MipsAsmPrinter.cpp

   1 //===-- MipsAsmPrinter.cpp - Mips LLVM Assembly Printer -------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains a printer that converts from our internal representation
  11 // of machine-dependent LLVM code to GAS-format MIPS assembly language.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "InstPrinter/MipsInstPrinter.h"
  16 #include "MCTargetDesc/MipsBaseInfo.h"
  17 #include "MCTargetDesc/MipsMCNaCl.h"
  18 #include "Mips.h"
  19 #include "MipsAsmPrinter.h"
  20 #include "MipsInstrInfo.h"
  21 #include "MipsMCInstLower.h"
  22 #include "MipsTargetMachine.h"
  23 #include "MipsTargetStreamer.h"
  24 #include "llvm/ADT/SmallString.h"
  25 #include "llvm/ADT/Twine.h"
  26 #include "llvm/CodeGen/MachineConstantPool.h"
  27 #include "llvm/CodeGen/MachineFrameInfo.h"
  28 #include "llvm/CodeGen/MachineFunctionPass.h"
  29 #include "llvm/CodeGen/MachineInstr.h"
  30 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  31 #include "llvm/CodeGen/MachineMemOperand.h"
  32 #include "llvm/IR/BasicBlock.h"
  33 #include "llvm/IR/DataLayout.h"
  34 #include "llvm/IR/InlineAsm.h"
  35 #include "llvm/IR/Instructions.h"
  36 #include "llvm/IR/Mangler.h"
  37 #include "llvm/MC/MCAsmInfo.h"
  38 #include "llvm/MC/MCContext.h"
  39 #include "llvm/MC/MCELFStreamer.h"
  40 #include "llvm/MC/MCExpr.h"
  41 #include "llvm/MC/MCInst.h"
  42 #include "llvm/MC/MCSection.h"
  43 #include "llvm/MC/MCSectionELF.h"
  44 #include "llvm/MC/MCSymbolELF.h"
  45 #include "llvm/Support/ELF.h"
  46 #include "llvm/Support/TargetRegistry.h"
  47 #include "llvm/Support/raw_ostream.h"
  48 #include "llvm/Target/TargetLoweringObjectFile.h"
  49 #include "llvm/Target/TargetOptions.h"
  50 #include <string>
  51
  52 using namespace llvm;
  53
  54 #define DEBUG_TYPE "mips-asm-printer"
  55
  56 MipsTargetStreamer &MipsAsmPrinter::getTargetStreamer() const {
  57   return static_cast<MipsTargetStreamer &>(*OutStreamer->getTargetStreamer());
  58 }
  59
  60 bool MipsAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
  61   Subtarget = &MF.getSubtarget<MipsSubtarget>();
  62
  63   // Initialize TargetLoweringObjectFile.
  64   const_cast<TargetLoweringObjectFile &>(getObjFileLowering())
  65       .Initialize(OutContext, TM);
  66
  67   MipsFI = MF.getInfo<MipsFunctionInfo>();
  68   if (Subtarget->inMips16Mode())
  69     for (std::map<
  70              const char *,
  71              const llvm::Mips16HardFloatInfo::FuncSignature *>::const_iterator
  72              it = MipsFI->StubsNeeded.begin();
  73          it != MipsFI->StubsNeeded.end(); ++it) {
  74       const char *Symbol = it->first;
  75       const llvm::Mips16HardFloatInfo::FuncSignature *Signature = it->second;
  76       if (StubsNeeded.find(Symbol) == StubsNeeded.end())
  77         StubsNeeded[Symbol] = Signature;
  78     }
  79   MCP = MF.getConstantPool();
  80
  81   // In NaCl, all indirect jump targets must be aligned to bundle size.
  82   if (Subtarget->isTargetNaCl())
  83     NaClAlignIndirectJumpTargets(MF);
  84
  85   AsmPrinter::runOnMachineFunction(MF);
  86   return true;
  87 }
  88
  89 bool MipsAsmPrinter::lowerOperand(const MachineOperand &MO, MCOperand &MCOp) {
  90   MCOp = MCInstLowering.LowerOperand(MO);
  91   return MCOp.isValid();
  92 }
  93
  94 #include "MipsGenMCPseudoLowering.inc"
  95
  96 // Lower PseudoReturn/PseudoIndirectBranch/PseudoIndirectBranch64 to JR, JR_MM,
  97 // JALR, or JALR64 as appropriate for the target
  98 void MipsAsmPrinter::emitPseudoIndirectBranch(MCStreamer &OutStreamer,
  99                                               const MachineInstr *MI) {
 100   bool HasLinkReg = false;
 101   MCInst TmpInst0;
 102
 103   if (Subtarget->hasMips64r6()) {
 104     // MIPS64r6 should use (JALR64 ZERO_64, $rs)
 105     TmpInst0.setOpcode(Mips::JALR64);
 106     HasLinkReg = true;
 107   } else if (Subtarget->hasMips32r6()) {
 108     // MIPS32r6 should use (JALR ZERO, $rs)
 109     TmpInst0.setOpcode(Mips::JALR);
 110     HasLinkReg = true;
 111   } else if (Subtarget->inMicroMipsMode())
 112     // microMIPS should use (JR_MM $rs)
 113     TmpInst0.setOpcode(Mips::JR_MM);
 114   else {
 115     // Everything else should use (JR $rs)
 116     TmpInst0.setOpcode(Mips::JR);
 117   }
 118
 119   MCOperand MCOp;
 120
 121   if (HasLinkReg) {
 122     unsigned ZeroReg = Subtarget->isGP64bit() ? Mips::ZERO_64 : Mips::ZERO;
 123     TmpInst0.addOperand(MCOperand::createReg(ZeroReg));
 124   }
 125
 126   lowerOperand(MI->getOperand(0), MCOp);
 127   TmpInst0.addOperand(MCOp);
 128
 129   EmitToStreamer(OutStreamer, TmpInst0);
 130 }
 131
 132 void MipsAsmPrinter::EmitInstruction(const MachineInstr *MI) {
 133   MipsTargetStreamer &TS = getTargetStreamer();
 134   TS.forbidModuleDirective();
 135
 136   if (MI->isDebugValue()) {
 137     SmallString<128> Str;
 138     raw_svector_ostream OS(Str);
 139
 140     PrintDebugValueComment(MI, OS);
 141     return;
 142   }
 143
 144   // If we just ended a constant pool, mark it as such.
 145   if (InConstantPool && MI->getOpcode() != Mips::CONSTPOOL_ENTRY) {
 146     OutStreamer->EmitDataRegion(MCDR_DataRegionEnd);
 147     InConstantPool = false;
 148   }
 149   if (MI->getOpcode() == Mips::CONSTPOOL_ENTRY) {
 150     // CONSTPOOL_ENTRY - This instruction represents a floating
 151     //constant pool in the function.  The first operand is the ID#
 152     // for this instruction, the second is the index into the
 153     // MachineConstantPool that this is, the third is the size in
 154     // bytes of this constant pool entry.
 155     // The required alignment is specified on the basic block holding this MI.
 156     //
 157     unsigned LabelId = (unsigned)MI->getOperand(0).getImm();
 158     unsigned CPIdx   = (unsigned)MI->getOperand(1).getIndex();
 159
 160     // If this is the first entry of the pool, mark it.
 161     if (!InConstantPool) {
 162       OutStreamer->EmitDataRegion(MCDR_DataRegion);
 163       InConstantPool = true;
 164     }
 165
 166     OutStreamer->EmitLabel(GetCPISymbol(LabelId));
 167
 168     const MachineConstantPoolEntry &MCPE = MCP->getConstants()[CPIdx];
 169     if (MCPE.isMachineConstantPoolEntry())
 170       EmitMachineConstantPoolValue(MCPE.Val.MachineCPVal);
 171     else
 172       EmitGlobalConstant(MCPE.Val.ConstVal);
 173     return;
 174   }
 175
 176
 177   MachineBasicBlock::const_instr_iterator I = MI;
 178   MachineBasicBlock::const_instr_iterator E = MI->getParent()->instr_end();
 179
 180   do {
 181     // Do any auto-generated pseudo lowerings.
 182     if (emitPseudoExpansionLowering(*OutStreamer, &*I))
 183       continue;
 184
 185     if (I->getOpcode() == Mips::PseudoReturn ||
 186         I->getOpcode() == Mips::PseudoReturn64 ||
 187         I->getOpcode() == Mips::PseudoIndirectBranch ||
 188         I->getOpcode() == Mips::PseudoIndirectBranch64) {
 189       emitPseudoIndirectBranch(*OutStreamer, &*I);
 190       continue;
 191     }
 192
 193     // The inMips16Mode() test is not permanent.
 194     // Some instructions are marked as pseudo right now which
 195     // would make the test fail for the wrong reason but
 196     // that will be fixed soon. We need this here because we are
 197     // removing another test for this situation downstream in the
 198     // callchain.
 199     //
 200     if (I->isPseudo() && !Subtarget->inMips16Mode()
 201         && !isLongBranchPseudo(I->getOpcode()))
 202       llvm_unreachable("Pseudo opcode found in EmitInstruction()");
 203
 204     MCInst TmpInst0;
 205     MCInstLowering.Lower(I, TmpInst0);
 206     EmitToStreamer(*OutStreamer, TmpInst0);
 207   } while ((++I != E) && I->isInsideBundle()); // Delay slot check
 208 }
 209
 210 //===----------------------------------------------------------------------===//
 211 //
 212 //  Mips Asm Directives
 213 //
 214 //  -- Frame directive "frame Stackpointer, Stacksize, RARegister"
 215 //  Describe the stack frame.
 216 //
 217 //  -- Mask directives "(f)mask  bitmask, offset"
 218 //  Tells the assembler which registers are saved and where.
 219 //  bitmask - contain a little endian bitset indicating which registers are
 220 //            saved on function prologue (e.g. with a 0x80000000 mask, the
 221 //            assembler knows the register 31 (RA) is saved at prologue.
 222 //  offset  - the position before stack pointer subtraction indicating where
 223 //            the first saved register on prologue is located. (e.g. with a
 224 //
 225 //  Consider the following function prologue:
 226 //
 227 //    .frame  $fp,48,$ra
 228 //    .mask   0xc0000000,-8
 229 //       addiu $sp, $sp, -48
 230 //       sw $ra, 40($sp)
 231 //       sw $fp, 36($sp)
 232 //
 233 //    With a 0xc0000000 mask, the assembler knows the register 31 (RA) and
 234 //    30 (FP) are saved at prologue. As the save order on prologue is from
 235 //    left to right, RA is saved first. A -8 offset means that after the
 236 //    stack pointer subtration, the first register in the mask (RA) will be
 237 //    saved at address 48-8=40.
 238 //
 239 //===----------------------------------------------------------------------===//
 240
 241 //===----------------------------------------------------------------------===//
 242 // Mask directives
 243 //===----------------------------------------------------------------------===//
 244
 245 // Create a bitmask with all callee saved registers for CPU or Floating Point
 246 // registers. For CPU registers consider RA, GP and FP for saving if necessary.
 247 void MipsAsmPrinter::printSavedRegsBitmask() {
 248   // CPU and FPU Saved Registers Bitmasks
 249   unsigned CPUBitmask = 0, FPUBitmask = 0;
 250   int CPUTopSavedRegOff, FPUTopSavedRegOff;
 251
 252   // Set the CPU and FPU Bitmasks
 253   const MachineFrameInfo *MFI = MF->getFrameInfo();
 254   const TargetRegisterInfo *TRI = MF->getSubtarget().getRegisterInfo();
 255   const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
 256   // size of stack area to which FP callee-saved regs are saved.
 257   unsigned CPURegSize = Mips::GPR32RegClass.getSize();
 258   unsigned FGR32RegSize = Mips::FGR32RegClass.getSize();
 259   unsigned AFGR64RegSize = Mips::AFGR64RegClass.getSize();
 260   bool HasAFGR64Reg = false;
 261   unsigned CSFPRegsSize = 0;
 262
 263   for (const auto &I : CSI) {
 264     unsigned Reg = I.getReg();
 265     unsigned RegNum = TRI->getEncodingValue(Reg);
 266
 267     // If it's a floating point register, set the FPU Bitmask.
 268     // If it's a general purpose register, set the CPU Bitmask.
 269     if (Mips::FGR32RegClass.contains(Reg)) {
 270       FPUBitmask |= (1 << RegNum);
 271       CSFPRegsSize += FGR32RegSize;
 272     } else if (Mips::AFGR64RegClass.contains(Reg)) {
 273       FPUBitmask |= (3 << RegNum);
 274       CSFPRegsSize += AFGR64RegSize;
 275       HasAFGR64Reg = true;
 276     } else if (Mips::GPR32RegClass.contains(Reg))
 277       CPUBitmask |= (1 << RegNum);
 278   }
 279
 280   // FP Regs are saved right below where the virtual frame pointer points to.
 281   FPUTopSavedRegOff = FPUBitmask ?
 282     (HasAFGR64Reg ? -AFGR64RegSize : -FGR32RegSize) : 0;
 283
 284   // CPU Regs are saved below FP Regs.
 285   CPUTopSavedRegOff = CPUBitmask ? -CSFPRegsSize - CPURegSize : 0;
 286
 287   MipsTargetStreamer &TS = getTargetStreamer();
 288   // Print CPUBitmask
 289   TS.emitMask(CPUBitmask, CPUTopSavedRegOff);
 290
 291   // Print FPUBitmask
 292   TS.emitFMask(FPUBitmask, FPUTopSavedRegOff);
 293 }
 294
 295 //===----------------------------------------------------------------------===//
 296 // Frame and Set directives
 297 //===----------------------------------------------------------------------===//
 298
 299 /// Frame Directive
 300 void MipsAsmPrinter::emitFrameDirective() {
 301   const TargetRegisterInfo &RI = *MF->getSubtarget().getRegisterInfo();
 302
 303   unsigned stackReg  = RI.getFrameRegister(*MF);
 304   unsigned returnReg = RI.getRARegister();
 305   unsigned stackSize = MF->getFrameInfo()->getStackSize();
 306
 307   getTargetStreamer().emitFrame(stackReg, stackSize, returnReg);
 308 }
 309
 310 /// Emit Set directives.
 311 const char *MipsAsmPrinter::getCurrentABIString() const {
 312   switch (static_cast<MipsTargetMachine &>(TM).getABI().GetEnumValue()) {
 313   case MipsABIInfo::ABI::O32:  return "abi32";
 314   case MipsABIInfo::ABI::N32:  return "abiN32";
 315   case MipsABIInfo::ABI::N64:  return "abi64";
 316   case MipsABIInfo::ABI::EABI: return "eabi32"; // TODO: handle eabi64
 317   default: llvm_unreachable("Unknown Mips ABI");
 318   }
 319 }
 320
 321 void MipsAsmPrinter::EmitFunctionEntryLabel() {
 322   MipsTargetStreamer &TS = getTargetStreamer();
 323
 324   // NaCl sandboxing requires that indirect call instructions are masked.
 325   // This means that function entry points should be bundle-aligned.
 326   if (Subtarget->isTargetNaCl())
 327     EmitAlignment(std::max(MF->getAlignment(), MIPS_NACL_BUNDLE_ALIGN));
 328
 329   if (Subtarget->inMicroMipsMode())
 330     TS.emitDirectiveSetMicroMips();
 331   else
 332     TS.emitDirectiveSetNoMicroMips();
 333
 334   if (Subtarget->inMips16Mode())
 335     TS.emitDirectiveSetMips16();
 336   else
 337     TS.emitDirectiveSetNoMips16();
 338
 339   TS.emitDirectiveEnt(*CurrentFnSym);
 340   OutStreamer->EmitLabel(CurrentFnSym);
 341 }
 342
 343 /// EmitFunctionBodyStart - Targets can override this to emit stuff before
 344 /// the first basic block in the function.
 345 void MipsAsmPrinter::EmitFunctionBodyStart() {
 346   MipsTargetStreamer &TS = getTargetStreamer();
 347
 348   MCInstLowering.Initialize(&MF->getContext());
 349
 350   bool IsNakedFunction = MF->getFunction()->hasFnAttribute(Attribute::Naked);
 351   if (!IsNakedFunction)
 352     emitFrameDirective();
 353
 354   if (!IsNakedFunction)
 355     printSavedRegsBitmask();
 356
 357   if (!Subtarget->inMips16Mode()) {
 358     TS.emitDirectiveSetNoReorder();
 359     TS.emitDirectiveSetNoMacro();
 360     TS.emitDirectiveSetNoAt();
 361   }
 362 }
 363
 364 /// EmitFunctionBodyEnd - Targets can override this to emit stuff after
 365 /// the last basic block in the function.
 366 void MipsAsmPrinter::EmitFunctionBodyEnd() {
 367   MipsTargetStreamer &TS = getTargetStreamer();
 368
 369   // There are instruction for this macros, but they must
 370   // always be at the function end, and we can't emit and
 371   // break with BB logic.
 372   if (!Subtarget->inMips16Mode()) {
 373     TS.emitDirectiveSetAt();
 374     TS.emitDirectiveSetMacro();
 375     TS.emitDirectiveSetReorder();
 376   }
 377   TS.emitDirectiveEnd(CurrentFnSym->getName());
 378   // Make sure to terminate any constant pools that were at the end
 379   // of the function.
 380   if (!InConstantPool)
 381     return;
 382   InConstantPool = false;
 383   OutStreamer->EmitDataRegion(MCDR_DataRegionEnd);
 384 }
 385
 386 void MipsAsmPrinter::EmitBasicBlockEnd(const MachineBasicBlock &MBB) {
 387   MipsTargetStreamer &TS = getTargetStreamer();
 388   if (MBB.size() == 0)
 389     TS.emitDirectiveInsn();
 390 }
 391
 392 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
 393 /// exactly one predecessor and the control transfer mechanism between
 394 /// the predecessor and this block is a fall-through.
 395 bool MipsAsmPrinter::isBlockOnlyReachableByFallthrough(const MachineBasicBlock*
 396                                                        MBB) const {
 397   // The predecessor has to be immediately before this block.
 398   const MachineBasicBlock *Pred = *MBB->pred_begin();
 399
 400   // If the predecessor is a switch statement, assume a jump table
 401   // implementation, so it is not a fall through.
 402   if (const BasicBlock *bb = Pred->getBasicBlock())
 403     if (isa<SwitchInst>(bb->getTerminator()))
 404       return false;
 405
 406   // If this is a landing pad, it isn't a fall through.  If it has no preds,
 407   // then nothing falls through to it.
 408   if (MBB->isLandingPad() || MBB->pred_empty())
 409     return false;
 410
 411   // If there isn't exactly one predecessor, it can't be a fall through.
 412   MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(), PI2 = PI;
 413   ++PI2;
 414
 415   if (PI2 != MBB->pred_end())
 416     return false;
 417
 418   // The predecessor has to be immediately before this block.
 419   if (!Pred->isLayoutSuccessor(MBB))
 420     return false;
 421
 422   // If the block is completely empty, then it definitely does fall through.
 423   if (Pred->empty())
 424     return true;
 425
 426   // Otherwise, check the last instruction.
 427   // Check if the last terminator is an unconditional branch.
 428   MachineBasicBlock::const_iterator I = Pred->end();
 429   while (I != Pred->begin() && !(--I)->isTerminator()) ;
 430
 431   return !I->isBarrier();
 432 }
 433
 434 // Print out an operand for an inline asm expression.
 435 bool MipsAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNum,
 436                                      unsigned AsmVariant, const char *ExtraCode,
 437                                      raw_ostream &O) {
 438   // Does this asm operand have a single letter operand modifier?
 439   if (ExtraCode && ExtraCode[0]) {
 440     if (ExtraCode[1] != 0) return true; // Unknown modifier.
 441
 442     const MachineOperand &MO = MI->getOperand(OpNum);
 443     switch (ExtraCode[0]) {
 444     default:
 445       // See if this is a generic print operand
 446       return AsmPrinter::PrintAsmOperand(MI,OpNum,AsmVariant,ExtraCode,O);
 447     case 'X': // hex const int
 448       if ((MO.getType()) != MachineOperand::MO_Immediate)
 449         return true;
 450       O << "0x" << Twine::utohexstr(MO.getImm());
 451       return false;
 452     case 'x': // hex const int (low 16 bits)
 453       if ((MO.getType()) != MachineOperand::MO_Immediate)
 454         return true;
 455       O << "0x" << Twine::utohexstr(MO.getImm() & 0xffff);
 456       return false;
 457     case 'd': // decimal const int
 458       if ((MO.getType()) != MachineOperand::MO_Immediate)
 459         return true;
 460       O << MO.getImm();
 461       return false;
 462     case 'm': // decimal const int minus 1
 463       if ((MO.getType()) != MachineOperand::MO_Immediate)
 464         return true;
 465       O << MO.getImm() - 1;
 466       return false;
 467     case 'z': {
 468       // $0 if zero, regular printing otherwise
 469       if (MO.getType() == MachineOperand::MO_Immediate && MO.getImm() == 0) {
 470         O << "$0";
 471         return false;
 472       }
 473       // If not, call printOperand as normal.
 474       break;
 475     }
 476     case 'D': // Second part of a double word register operand
 477     case 'L': // Low order register of a double word register operand
 478     case 'M': // High order register of a double word register operand
 479     {
 480       if (OpNum == 0)
 481         return true;
 482       const MachineOperand &FlagsOP = MI->getOperand(OpNum - 1);
 483       if (!FlagsOP.isImm())
 484         return true;
 485       unsigned Flags = FlagsOP.getImm();
 486       unsigned NumVals = InlineAsm::getNumOperandRegisters(Flags);
 487       // Number of registers represented by this operand. We are looking
 488       // for 2 for 32 bit mode and 1 for 64 bit mode.
 489       if (NumVals != 2) {
 490         if (Subtarget->isGP64bit() && NumVals == 1 && MO.isReg()) {
 491           unsigned Reg = MO.getReg();
 492           O << '$' << MipsInstPrinter::getRegisterName(Reg);
 493           return false;
 494         }
 495         return true;
 496       }
 497
 498       unsigned RegOp = OpNum;
 499       if (!Subtarget->isGP64bit()){
 500         // Endianess reverses which register holds the high or low value
 501         // between M and L.
 502         switch(ExtraCode[0]) {
 503         case 'M':
 504           RegOp = (Subtarget->isLittle()) ? OpNum + 1 : OpNum;
 505           break;
 506         case 'L':
 507           RegOp = (Subtarget->isLittle()) ? OpNum : OpNum + 1;
 508           break;
 509         case 'D': // Always the second part
 510           RegOp = OpNum + 1;
 511         }
 512         if (RegOp >= MI->getNumOperands())
 513           return true;
 514         const MachineOperand &MO = MI->getOperand(RegOp);
 515         if (!MO.isReg())
 516           return true;
 517         unsigned Reg = MO.getReg();
 518         O << '$' << MipsInstPrinter::getRegisterName(Reg);
 519         return false;
 520       }
 521     }
 522     case 'w':
 523       // Print MSA registers for the 'f' constraint
 524       // In LLVM, the 'w' modifier doesn't need to do anything.
 525       // We can just call printOperand as normal.
 526       break;
 527     }
 528   }
 529
 530   printOperand(MI, OpNum, O);
 531   return false;
 532 }
 533
 534 bool MipsAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
 535                                            unsigned OpNum, unsigned AsmVariant,
 536                                            const char *ExtraCode,
 537                                            raw_ostream &O) {
 538   assert(OpNum + 1 < MI->getNumOperands() && "Insufficient operands");
 539   const MachineOperand &BaseMO = MI->getOperand(OpNum);
 540   const MachineOperand &OffsetMO = MI->getOperand(OpNum + 1);
 541   assert(BaseMO.isReg() && "Unexpected base pointer for inline asm memory operand.");
 542   assert(OffsetMO.isImm() && "Unexpected offset for inline asm memory operand.");
 543   int Offset = OffsetMO.getImm();
 544
 545   // Currently we are expecting either no ExtraCode or 'D'
 546   if (ExtraCode) {
 547     if (ExtraCode[0] == 'D')
 548       Offset += 4;
 549     else
 550       return true; // Unknown modifier.
 551     // FIXME: M = high order bits
 552     // FIXME: L = low order bits
 553   }
 554
 555   O << Offset << "($" << MipsInstPrinter::getRegisterName(BaseMO.getReg()) << ")";
 556
 557   return false;
 558 }
 559
 560 void MipsAsmPrinter::printOperand(const MachineInstr *MI, int opNum,
 561                                   raw_ostream &O) {
 562   const DataLayout *DL = TM.getDataLayout();
 563   const MachineOperand &MO = MI->getOperand(opNum);
 564   bool closeP = false;
 565
 566   if (MO.getTargetFlags())
 567     closeP = true;
 568
 569   switch(MO.getTargetFlags()) {
 570   case MipsII::MO_GPREL:    O << "%gp_rel("; break;
 571   case MipsII::MO_GOT_CALL: O << "%call16("; break;
 572   case MipsII::MO_GOT:      O << "%got(";    break;
 573   case MipsII::MO_ABS_HI:   O << "%hi(";     break;
 574   case MipsII::MO_ABS_LO:   O << "%lo(";     break;
 575   case MipsII::MO_TLSGD:    O << "%tlsgd(";  break;
 576   case MipsII::MO_GOTTPREL: O << "%gottprel("; break;
 577   case MipsII::MO_TPREL_HI: O << "%tprel_hi("; break;
 578   case MipsII::MO_TPREL_LO: O << "%tprel_lo("; break;
 579   case MipsII::MO_GPOFF_HI: O << "%hi(%neg(%gp_rel("; break;
 580   case MipsII::MO_GPOFF_LO: O << "%lo(%neg(%gp_rel("; break;
 581   case MipsII::MO_GOT_DISP: O << "%got_disp("; break;
 582   case MipsII::MO_GOT_PAGE: O << "%got_page("; break;
 583   case MipsII::MO_GOT_OFST: O << "%got_ofst("; break;
 584   }
 585
 586   switch (MO.getType()) {
 587     case MachineOperand::MO_Register:
 588       O << '$'
 589         << StringRef(MipsInstPrinter::getRegisterName(MO.getReg())).lower();
 590       break;
 591
 592     case MachineOperand::MO_Immediate:
 593       O << MO.getImm();
 594       break;
 595
 596     case MachineOperand::MO_MachineBasicBlock:
 597       O << *MO.getMBB()->getSymbol();
 598       return;
 599
 600     case MachineOperand::MO_GlobalAddress:
 601       O << *getSymbol(MO.getGlobal());
 602       break;
 603
 604     case MachineOperand::MO_BlockAddress: {
 605       MCSymbol *BA = GetBlockAddressSymbol(MO.getBlockAddress());
 606       O << BA->getName();
 607       break;
 608     }
 609
 610     case MachineOperand::MO_ConstantPoolIndex:
 611       O << DL->getPrivateGlobalPrefix() << "CPI"
 612         << getFunctionNumber() << "_" << MO.getIndex();
 613       if (MO.getOffset())
 614         O << "+" << MO.getOffset();
 615       break;
 616
 617     default:
 618       llvm_unreachable("<unknown operand type>");
 619   }
 620
 621   if (closeP) O << ")";
 622 }
 623
 624 void MipsAsmPrinter::printUnsignedImm(const MachineInstr *MI, int opNum,
 625                                       raw_ostream &O) {
 626   const MachineOperand &MO = MI->getOperand(opNum);
 627   if (MO.isImm())
 628     O << (unsigned short int)MO.getImm();
 629   else
 630     printOperand(MI, opNum, O);
 631 }
 632
 633 void MipsAsmPrinter::printUnsignedImm8(const MachineInstr *MI, int opNum,
 634                                        raw_ostream &O) {
 635   const MachineOperand &MO = MI->getOperand(opNum);
 636   if (MO.isImm())
 637     O << (unsigned short int)(unsigned char)MO.getImm();
 638   else
 639     printOperand(MI, opNum, O);
 640 }
 641
 642 void MipsAsmPrinter::
 643 printMemOperand(const MachineInstr *MI, int opNum, raw_ostream &O) {
 644   // Load/Store memory operands -- imm($reg)
 645   // If PIC target the target is loaded as the
 646   // pattern lw $25,%call16($28)
 647
 648   // opNum can be invalid if instruction has reglist as operand.
 649   // MemOperand is always last operand of instruction (base + offset).
 650   switch (MI->getOpcode()) {
 651   default:
 652     break;
 653   case Mips::SWM32_MM:
 654   case Mips::LWM32_MM:
 655     opNum = MI->getNumOperands() - 2;
 656     break;
 657   }
 658
 659   printOperand(MI, opNum+1, O);
 660   O << "(";
 661   printOperand(MI, opNum, O);
 662   O << ")";
 663 }
 664
 665 void MipsAsmPrinter::
 666 printMemOperandEA(const MachineInstr *MI, int opNum, raw_ostream &O) {
 667   // when using stack locations for not load/store instructions
 668   // print the same way as all normal 3 operand instructions.
 669   printOperand(MI, opNum, O);
 670   O << ", ";
 671   printOperand(MI, opNum+1, O);
 672   return;
 673 }
 674
 675 void MipsAsmPrinter::
 676 printFCCOperand(const MachineInstr *MI, int opNum, raw_ostream &O,
 677                 const char *Modifier) {
 678   const MachineOperand &MO = MI->getOperand(opNum);
 679   O << Mips::MipsFCCToString((Mips::CondCode)MO.getImm());
 680 }
 681
 682 void MipsAsmPrinter::
 683 printRegisterList(const MachineInstr *MI, int opNum, raw_ostream &O) {
 684   for (int i = opNum, e = MI->getNumOperands(); i != e; ++i) {
 685     if (i != opNum) O << ", ";
 686     printOperand(MI, i, O);
 687   }
 688 }
 689
 690 void MipsAsmPrinter::EmitStartOfAsmFile(Module &M) {
 691
 692   // Compute MIPS architecture attributes based on the default subtarget
 693   // that we'd have constructed. Module level directives aren't LTO
 694   // clean anyhow.
 695   // FIXME: For ifunc related functions we could iterate over and look
 696   // for a feature string that doesn't match the default one.
 697   StringRef TT = TM.getTargetTriple();
 698   StringRef CPU =
 699       MIPS_MC::selectMipsCPU(TM.getTargetTriple(), TM.getTargetCPU());
 700   StringRef FS = TM.getTargetFeatureString();
 701   const MipsTargetMachine &MTM = static_cast<const MipsTargetMachine &>(TM);
 702   const MipsSubtarget STI(TT, CPU, FS, MTM.isLittleEndian(), MTM);
 703
 704   bool IsABICalls = STI.isABICalls();
 705   const MipsABIInfo &ABI = MTM.getABI();
 706   if (IsABICalls) {
 707     getTargetStreamer().emitDirectiveAbiCalls();
 708     Reloc::Model RM = TM.getRelocationModel();
 709     // FIXME: This condition should be a lot more complicated that it is here.
 710     //        Ideally it should test for properties of the ABI and not the ABI
 711     //        itself.
 712     //        For the moment, I'm only correcting enough to make MIPS-IV work.
 713     if (RM == Reloc::Static && !ABI.IsN64())
 714       getTargetStreamer().emitDirectiveOptionPic0();
 715   }
 716
 717   // Tell the assembler which ABI we are using
 718   std::string SectionName = std::string(".mdebug.") + getCurrentABIString();
 719   OutStreamer->SwitchSection(
 720       OutContext.getELFSection(SectionName, ELF::SHT_PROGBITS, 0));
 721
 722   // NaN: At the moment we only support:
 723   // 1. .nan legacy (default)
 724   // 2. .nan 2008
 725   STI.isNaN2008() ? getTargetStreamer().emitDirectiveNaN2008()
 726                   : getTargetStreamer().emitDirectiveNaNLegacy();
 727
 728   // TODO: handle O64 ABI
 729
 730   if (ABI.IsEABI()) {
 731     if (STI.isGP32bit())
 732       OutStreamer->SwitchSection(OutContext.getELFSection(".gcc_compiled_long32",
 733                                                           ELF::SHT_PROGBITS, 0));
 734     else
 735       OutStreamer->SwitchSection(OutContext.getELFSection(".gcc_compiled_long64",
 736                                                           ELF::SHT_PROGBITS, 0));
 737   }
 738
 739   getTargetStreamer().updateABIInfo(STI);
 740
 741   // We should always emit a '.module fp=...' but binutils 2.24 does not accept
 742   // it. We therefore emit it when it contradicts the ABI defaults (-mfpxx or
 743   // -mfp64) and omit it otherwise.
 744   if (ABI.IsO32() && (STI.isABI_FPXX() || STI.isFP64bit()))
 745     getTargetStreamer().emitDirectiveModuleFP();
 746
 747   // We should always emit a '.module [no]oddspreg' but binutils 2.24 does not
 748   // accept it. We therefore emit it when it contradicts the default or an
 749   // option has changed the default (i.e. FPXX) and omit it otherwise.
 750   if (ABI.IsO32() && (!STI.useOddSPReg() || STI.isABI_FPXX()))
 751     getTargetStreamer().emitDirectiveModuleOddSPReg(STI.useOddSPReg(),
 752                                                     ABI.IsO32());
 753 }
 754
 755 void MipsAsmPrinter::emitInlineAsmStart() const {
 756   MipsTargetStreamer &TS = getTargetStreamer();
 757
 758   // GCC's choice of assembler options for inline assembly code ('at', 'macro'
 759   // and 'reorder') is different from LLVM's choice for generated code ('noat',
 760   // 'nomacro' and 'noreorder').
 761   // In order to maintain compatibility with inline assembly code which depends
 762   // on GCC's assembler options being used, we have to switch to those options
 763   // for the duration of the inline assembly block and then switch back.
 764   TS.emitDirectiveSetPush();
 765   TS.emitDirectiveSetAt();
 766   TS.emitDirectiveSetMacro();
 767   TS.emitDirectiveSetReorder();
 768   OutStreamer->AddBlankLine();
 769 }
 770
 771 void MipsAsmPrinter::emitInlineAsmEnd(const MCSubtargetInfo &StartInfo,
 772                                       const MCSubtargetInfo *EndInfo) const {
 773   OutStreamer->AddBlankLine();
 774   getTargetStreamer().emitDirectiveSetPop();
 775 }
 776
 777 void MipsAsmPrinter::EmitJal(const MCSubtargetInfo &STI, MCSymbol *Symbol) {
 778   MCInst I;
 779   I.setOpcode(Mips::JAL);
 780   I.addOperand(
 781       MCOperand::createExpr(MCSymbolRefExpr::create(Symbol, OutContext)));
 782   OutStreamer->EmitInstruction(I, STI);
 783 }
 784
 785 void MipsAsmPrinter::EmitInstrReg(const MCSubtargetInfo &STI, unsigned Opcode,
 786                                   unsigned Reg) {
 787   MCInst I;
 788   I.setOpcode(Opcode);
 789   I.addOperand(MCOperand::createReg(Reg));
 790   OutStreamer->EmitInstruction(I, STI);
 791 }
 792
 793 void MipsAsmPrinter::EmitInstrRegReg(const MCSubtargetInfo &STI,
 794                                      unsigned Opcode, unsigned Reg1,
 795                                      unsigned Reg2) {
 796   MCInst I;
 797   //
 798   // Because of the current td files for Mips32, the operands for MTC1
 799   // appear backwards from their normal assembly order. It's not a trivial
 800   // change to fix this in the td file so we adjust for it here.
 801   //
 802   if (Opcode == Mips::MTC1) {
 803     unsigned Temp = Reg1;
 804     Reg1 = Reg2;
 805     Reg2 = Temp;
 806   }
 807   I.setOpcode(Opcode);
 808   I.addOperand(MCOperand::createReg(Reg1));
 809   I.addOperand(MCOperand::createReg(Reg2));
 810   OutStreamer->EmitInstruction(I, STI);
 811 }
 812
 813 void MipsAsmPrinter::EmitInstrRegRegReg(const MCSubtargetInfo &STI,
 814                                         unsigned Opcode, unsigned Reg1,
 815                                         unsigned Reg2, unsigned Reg3) {
 816   MCInst I;
 817   I.setOpcode(Opcode);
 818   I.addOperand(MCOperand::createReg(Reg1));
 819   I.addOperand(MCOperand::createReg(Reg2));
 820   I.addOperand(MCOperand::createReg(Reg3));
 821   OutStreamer->EmitInstruction(I, STI);
 822 }
 823
 824 void MipsAsmPrinter::EmitMovFPIntPair(const MCSubtargetInfo &STI,
 825                                       unsigned MovOpc, unsigned Reg1,
 826                                       unsigned Reg2, unsigned FPReg1,
 827                                       unsigned FPReg2, bool LE) {
 828   if (!LE) {
 829     unsigned temp = Reg1;
 830     Reg1 = Reg2;
 831     Reg2 = temp;
 832   }
 833   EmitInstrRegReg(STI, MovOpc, Reg1, FPReg1);
 834   EmitInstrRegReg(STI, MovOpc, Reg2, FPReg2);
 835 }
 836
 837 void MipsAsmPrinter::EmitSwapFPIntParams(const MCSubtargetInfo &STI,
 838                                          Mips16HardFloatInfo::FPParamVariant PV,
 839                                          bool LE, bool ToFP) {
 840   using namespace Mips16HardFloatInfo;
 841   unsigned MovOpc = ToFP ? Mips::MTC1 : Mips::MFC1;
 842   switch (PV) {
 843   case FSig:
 844     EmitInstrRegReg(STI, MovOpc, Mips::A0, Mips::F12);
 845     break;
 846   case FFSig:
 847     EmitMovFPIntPair(STI, MovOpc, Mips::A0, Mips::A1, Mips::F12, Mips::F14, LE);
 848     break;
 849   case FDSig:
 850     EmitInstrRegReg(STI, MovOpc, Mips::A0, Mips::F12);
 851     EmitMovFPIntPair(STI, MovOpc, Mips::A2, Mips::A3, Mips::F14, Mips::F15, LE);
 852     break;
 853   case DSig:
 854     EmitMovFPIntPair(STI, MovOpc, Mips::A0, Mips::A1, Mips::F12, Mips::F13, LE);
 855     break;
 856   case DDSig:
 857     EmitMovFPIntPair(STI, MovOpc, Mips::A0, Mips::A1, Mips::F12, Mips::F13, LE);
 858     EmitMovFPIntPair(STI, MovOpc, Mips::A2, Mips::A3, Mips::F14, Mips::F15, LE);
 859     break;
 860   case DFSig:
 861     EmitMovFPIntPair(STI, MovOpc, Mips::A0, Mips::A1, Mips::F12, Mips::F13, LE);
 862     EmitInstrRegReg(STI, MovOpc, Mips::A2, Mips::F14);
 863     break;
 864   case NoSig:
 865     return;
 866   }
 867 }
 868
 869 void MipsAsmPrinter::EmitSwapFPIntRetval(
 870     const MCSubtargetInfo &STI, Mips16HardFloatInfo::FPReturnVariant RV,
 871     bool LE) {
 872   using namespace Mips16HardFloatInfo;
 873   unsigned MovOpc = Mips::MFC1;
 874   switch (RV) {
 875   case FRet:
 876     EmitInstrRegReg(STI, MovOpc, Mips::V0, Mips::F0);
 877     break;
 878   case DRet:
 879     EmitMovFPIntPair(STI, MovOpc, Mips::V0, Mips::V1, Mips::F0, Mips::F1, LE);
 880     break;
 881   case CFRet:
 882     EmitMovFPIntPair(STI, MovOpc, Mips::V0, Mips::V1, Mips::F0, Mips::F1, LE);
 883     break;
 884   case CDRet:
 885     EmitMovFPIntPair(STI, MovOpc, Mips::V0, Mips::V1, Mips::F0, Mips::F1, LE);
 886     EmitMovFPIntPair(STI, MovOpc, Mips::A0, Mips::A1, Mips::F2, Mips::F3, LE);
 887     break;
 888   case NoFPRet:
 889     break;
 890   }
 891 }
 892
 893 void MipsAsmPrinter::EmitFPCallStub(
 894     const char *Symbol, const Mips16HardFloatInfo::FuncSignature *Signature) {
 895   MCSymbol *MSymbol = OutContext.getOrCreateSymbol(StringRef(Symbol));
 896   using namespace Mips16HardFloatInfo;
 897   bool LE = getDataLayout().isLittleEndian();
 898   // Construct a local MCSubtargetInfo here.
 899   // This is because the MachineFunction won't exist (but have not yet been
 900   // freed) and since we're at the global level we can use the default
 901   // constructed subtarget.
 902   std::unique_ptr<MCSubtargetInfo> STI(TM.getTarget().createMCSubtargetInfo(
 903       TM.getTargetTriple(), TM.getTargetCPU(), TM.getTargetFeatureString()));
 904
 905   //
 906   // .global xxxx
 907   //
 908   OutStreamer->EmitSymbolAttribute(MSymbol, MCSA_Global);
 909   const char *RetType;
 910   //
 911   // make the comment field identifying the return and parameter
 912   // types of the floating point stub
 913   // # Stub function to call rettype xxxx (params)
 914   //
 915   switch (Signature->RetSig) {
 916   case FRet:
 917     RetType = "float";
 918     break;
 919   case DRet:
 920     RetType = "double";
 921     break;
 922   case CFRet:
 923     RetType = "complex";
 924     break;
 925   case CDRet:
 926     RetType = "double complex";
 927     break;
 928   case NoFPRet:
 929     RetType = "";
 930     break;
 931   }
 932   const char *Parms;
 933   switch (Signature->ParamSig) {
 934   case FSig:
 935     Parms = "float";
 936     break;
 937   case FFSig:
 938     Parms = "float, float";
 939     break;
 940   case FDSig:
 941     Parms = "float, double";
 942     break;
 943   case DSig:
 944     Parms = "double";
 945     break;
 946   case DDSig:
 947     Parms = "double, double";
 948     break;
 949   case DFSig:
 950     Parms = "double, float";
 951     break;
 952   case NoSig:
 953     Parms = "";
 954     break;
 955   }
 956   OutStreamer->AddComment("\t# Stub function to call " + Twine(RetType) + " " +
 957                           Twine(Symbol) + " (" + Twine(Parms) + ")");
 958   //
 959   // probably not necessary but we save and restore the current section state
 960   //
 961   OutStreamer->PushSection();
 962   //
 963   // .section mips16.call.fpxxxx,"ax",@progbits
 964   //
 965   MCSectionELF *M = OutContext.getELFSection(
 966       ".mips16.call.fp." + std::string(Symbol), ELF::SHT_PROGBITS,
 967       ELF::SHF_ALLOC | ELF::SHF_EXECINSTR);
 968   OutStreamer->SwitchSection(M, nullptr);
 969   //
 970   // .align 2
 971   //
 972   OutStreamer->EmitValueToAlignment(4);
 973   MipsTargetStreamer &TS = getTargetStreamer();
 974   //
 975   // .set nomips16
 976   // .set nomicromips
 977   //
 978   TS.emitDirectiveSetNoMips16();
 979   TS.emitDirectiveSetNoMicroMips();
 980   //
 981   // .ent __call_stub_fp_xxxx
 982   // .type  __call_stub_fp_xxxx,@function
 983   //  __call_stub_fp_xxxx:
 984   //
 985   std::string x = "__call_stub_fp_" + std::string(Symbol);
 986   MCSymbolELF *Stub =
 987       cast<MCSymbolELF>(OutContext.getOrCreateSymbol(StringRef(x)));
 988   TS.emitDirectiveEnt(*Stub);
 989   MCSymbol *MType =
 990       OutContext.getOrCreateSymbol("__call_stub_fp_" + Twine(Symbol));
 991   OutStreamer->EmitSymbolAttribute(MType, MCSA_ELF_TypeFunction);
 992   OutStreamer->EmitLabel(Stub);
 993
 994   // Only handle non-pic for now.
 995   assert(TM.getRelocationModel() != Reloc::PIC_ &&
 996          "should not be here if we are compiling pic");
 997   TS.emitDirectiveSetReorder();
 998   //
 999   // We need to add a MipsMCExpr class to MCTargetDesc to fully implement
1000   // stubs without raw text but this current patch is for compiler generated
1001   // functions and they all return some value.
1002   // The calling sequence for non pic is different in that case and we need
1003   // to implement %lo and %hi in order to handle the case of no return value
1004   // See the corresponding method in Mips16HardFloat for details.
1005   //
1006   // mov the return address to S2.
1007   // we have no stack space to store it and we are about to make another call.
1008   // We need to make sure that the enclosing function knows to save S2
1009   // This should have already been handled.
1010   //
1011   // Mov $18, $31
1012
1013   EmitInstrRegRegReg(*STI, Mips::ADDu, Mips::S2, Mips::RA, Mips::ZERO);
1014
1015   EmitSwapFPIntParams(*STI, Signature->ParamSig, LE, true);
1016
1017   // Jal xxxx
1018   //
1019   EmitJal(*STI, MSymbol);
1020
1021   // fix return values
1022   EmitSwapFPIntRetval(*STI, Signature->RetSig, LE);
1023   //
1024   // do the return
1025   // if (Signature->RetSig == NoFPRet)
1026   //  llvm_unreachable("should not be any stubs here with no return value");
1027   // else
1028   EmitInstrReg(*STI, Mips::JR, Mips::S2);
1029
1030   MCSymbol *Tmp = OutContext.createTempSymbol();
1031   OutStreamer->EmitLabel(Tmp);
1032   const MCSymbolRefExpr *E = MCSymbolRefExpr::create(Stub, OutContext);
1033   const MCSymbolRefExpr *T = MCSymbolRefExpr::create(Tmp, OutContext);
1034   const MCExpr *T_min_E = MCBinaryExpr::createSub(T, E, OutContext);
1035   OutStreamer->emitELFSize(Stub, T_min_E);
1036   TS.emitDirectiveEnd(x);
1037   OutStreamer->PopSection();
1038 }
1039
1040 void MipsAsmPrinter::EmitEndOfAsmFile(Module &M) {
1041   // Emit needed stubs
1042   //
1043   for (std::map<
1044            const char *,
1045            const llvm::Mips16HardFloatInfo::FuncSignature *>::const_iterator
1046            it = StubsNeeded.begin();
1047        it != StubsNeeded.end(); ++it) {
1048     const char *Symbol = it->first;
1049     const llvm::Mips16HardFloatInfo::FuncSignature *Signature = it->second;
1050     EmitFPCallStub(Symbol, Signature);
1051   }
1052   // return to the text section
1053   OutStreamer->SwitchSection(OutContext.getObjectFileInfo()->getTextSection());
1054 }
1055
1056 void MipsAsmPrinter::PrintDebugValueComment(const MachineInstr *MI,
1057                                            raw_ostream &OS) {
1058   // TODO: implement
1059 }
1060
1061 // Align all targets of indirect branches on bundle size.  Used only if target
1062 // is NaCl.
1063 void MipsAsmPrinter::NaClAlignIndirectJumpTargets(MachineFunction &MF) {
1064   // Align all blocks that are jumped to through jump table.
1065   if (MachineJumpTableInfo *JtInfo = MF.getJumpTableInfo()) {
1066     const std::vector<MachineJumpTableEntry> &JT = JtInfo->getJumpTables();
1067     for (unsigned I = 0; I < JT.size(); ++I) {
1068       const std::vector<MachineBasicBlock*> &MBBs = JT[I].MBBs;
1069
1070       for (unsigned J = 0; J < MBBs.size(); ++J)
1071         MBBs[J]->setAlignment(MIPS_NACL_BUNDLE_ALIGN);
1072     }
1073   }
1074
1075   // If basic block address is taken, block can be target of indirect branch.
1076   for (MachineFunction::iterator MBB = MF.begin(), E = MF.end();
1077                                  MBB != E; ++MBB) {
1078     if (MBB->hasAddressTaken())
1079       MBB->setAlignment(MIPS_NACL_BUNDLE_ALIGN);
1080   }
1081 }
1082
1083 bool MipsAsmPrinter::isLongBranchPseudo(int Opcode) const {
1084   return (Opcode == Mips::LONG_BRANCH_LUi
1085           || Opcode == Mips::LONG_BRANCH_ADDiu
1086           || Opcode == Mips::LONG_BRANCH_DADDiu);
1087 }
1088
1089 // Force static initialization.
1090 extern "C" void LLVMInitializeMipsAsmPrinter() {
1091   RegisterAsmPrinter<MipsAsmPrinter> X(TheMipsTarget);
1092   RegisterAsmPrinter<MipsAsmPrinter> Y(TheMipselTarget);
1093   RegisterAsmPrinter<MipsAsmPrinter> A(TheMips64Target);
1094   RegisterAsmPrinter<MipsAsmPrinter> B(TheMips64elTarget);
1095 }