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