lib/Target/Mips/MipsAsmPrinter.cpp

   1 //===-- MipsAsmPrinter.cpp - Mips LLVM assembly writer --------------------===//
   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 #define DEBUG_TYPE "mips-asm-printer"
  16
  17 #include "Mips.h"
  18 #include "MipsSubtarget.h"
  19 #include "MipsInstrInfo.h"
  20 #include "MipsTargetMachine.h"
  21 #include "MipsMachineFunction.h"
  22 #include "llvm/Constants.h"
  23 #include "llvm/DerivedTypes.h"
  24 #include "llvm/Module.h"
  25 #include "llvm/CodeGen/AsmPrinter.h"
  26 #include "llvm/CodeGen/MachineFunctionPass.h"
  27 #include "llvm/CodeGen/MachineConstantPool.h"
  28 #include "llvm/CodeGen/MachineFrameInfo.h"
  29 #include "llvm/CodeGen/MachineInstr.h"
  30 #include "llvm/Target/TargetAsmInfo.h"
  31 #include "llvm/Target/TargetData.h"
  32 #include "llvm/Target/TargetMachine.h"
  33 #include "llvm/Target/TargetOptions.h"
  34 #include "llvm/Support/Mangler.h"
  35 #include "llvm/ADT/Statistic.h"
  36 #include "llvm/ADT/StringExtras.h"
  37 #include "llvm/Support/Debug.h"
  38 #include "llvm/Support/CommandLine.h"
  39 #include "llvm/Support/MathExtras.h"
  40 #include <cctype>
  41
  42 using namespace llvm;
  43
  44 STATISTIC(EmittedInsts, "Number of machine instrs printed");
  45
  46 namespace {
  47   struct VISIBILITY_HIDDEN MipsAsmPrinter : public AsmPrinter {
  48
  49     const MipsSubtarget *Subtarget;
  50
  51     MipsAsmPrinter(std::ostream &O, MipsTargetMachine &TM,
  52                    const TargetAsmInfo *T):
  53                    AsmPrinter(O, TM, T) {
  54       Subtarget = &TM.getSubtarget<MipsSubtarget>();
  55     }
  56
  57     virtual const char *getPassName() const {
  58       return "Mips Assembly Printer";
  59     }
  60
  61     virtual std::string getSectionForFunction(const Function &F) const;
  62     bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
  63                          unsigned AsmVariant, const char *ExtraCode);
  64     void printOperand(const MachineInstr *MI, int opNum);
  65     void printUnsignedImm(const MachineInstr *MI, int opNum);
  66     void printMemOperand(const MachineInstr *MI, int opNum,
  67                          const char *Modifier = 0);
  68     void printFCCOperand(const MachineInstr *MI, int opNum,
  69                          const char *Modifier = 0);
  70     void printModuleLevelGV(const GlobalVariable* GVar);
  71     void printSavedRegsBitmask(MachineFunction &MF);
  72     void printHex32(unsigned int Value);
  73
  74     const char *emitCurrentABIString(void);
  75     void emitFunctionStart(MachineFunction &MF);
  76     void emitFunctionEnd(MachineFunction &MF);
  77     void emitFrameDirective(MachineFunction &MF);
  78
  79     bool printInstruction(const MachineInstr *MI);  // autogenerated.
  80     bool runOnMachineFunction(MachineFunction &F);
  81     bool doInitialization(Module &M);
  82     bool doFinalization(Module &M);
  83   };
  84 } // end of anonymous namespace
  85
  86 #include "MipsGenAsmWriter.inc"
  87
  88 /// createMipsCodePrinterPass - Returns a pass that prints the MIPS
  89 /// assembly code for a MachineFunction to the given output stream,
  90 /// using the given target machine description.  This should work
  91 /// regardless of whether the function is in SSA form.
  92 FunctionPass *llvm::createMipsCodePrinterPass(std::ostream &o,
  93                                               MipsTargetMachine &tm)
  94 {
  95   return new MipsAsmPrinter(o, tm, tm.getTargetAsmInfo());
  96 }
  97
  98 //===----------------------------------------------------------------------===//
  99 //
 100 //  Mips Asm Directives
 101 //
 102 //  -- Frame directive "frame Stackpointer, Stacksize, RARegister"
 103 //  Describe the stack frame.
 104 //
 105 //  -- Mask directives "(f)mask  bitmask, offset"
 106 //  Tells the assembler which registers are saved and where.
 107 //  bitmask - contain a little endian bitset indicating which registers are
 108 //            saved on function prologue (e.g. with a 0x80000000 mask, the
 109 //            assembler knows the register 31 (RA) is saved at prologue.
 110 //  offset  - the position before stack pointer subtraction indicating where
 111 //            the first saved register on prologue is located. (e.g. with a
 112 //
 113 //  Consider the following function prologue:
 114 //
 115 //    .frame  $fp,48,$ra
 116 //    .mask   0xc0000000,-8
 117 //       addiu $sp, $sp, -48
 118 //       sw $ra, 40($sp)
 119 //       sw $fp, 36($sp)
 120 //
 121 //    With a 0xc0000000 mask, the assembler knows the register 31 (RA) and
 122 //    30 (FP) are saved at prologue. As the save order on prologue is from
 123 //    left to right, RA is saved first. A -8 offset means that after the
 124 //    stack pointer subtration, the first register in the mask (RA) will be
 125 //    saved at address 48-8=40.
 126 //
 127 //===----------------------------------------------------------------------===//
 128
 129 //===----------------------------------------------------------------------===//
 130 // Mask directives
 131 //===----------------------------------------------------------------------===//
 132
 133 // Create a bitmask with all callee saved registers for CPU or Floating Point
 134 // registers. For CPU registers consider RA, GP and FP for saving if necessary.
 135 void MipsAsmPrinter::
 136 printSavedRegsBitmask(MachineFunction &MF)
 137 {
 138   const TargetRegisterInfo &RI = *TM.getRegisterInfo();
 139   MipsFunctionInfo *MipsFI = MF.getInfo<MipsFunctionInfo>();
 140
 141   // CPU and FPU Saved Registers Bitmasks
 142   unsigned int CPUBitmask = 0;
 143   unsigned int FPUBitmask = 0;
 144
 145   // Set the CPU and FPU Bitmasks
 146   MachineFrameInfo *MFI = MF.getFrameInfo();
 147   const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
 148   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
 149     unsigned RegNum = MipsRegisterInfo::getRegisterNumbering(CSI[i].getReg());
 150     if (CSI[i].getRegClass() == Mips::CPURegsRegisterClass)
 151       CPUBitmask |= (1 << RegNum);
 152     else
 153       FPUBitmask |= (1 << RegNum);
 154   }
 155
 156   // Return Address and Frame registers must also be set in CPUBitmask.
 157   if (RI.hasFP(MF))
 158     CPUBitmask |= (1 << MipsRegisterInfo::
 159                 getRegisterNumbering(RI.getFrameRegister(MF)));
 160
 161   if (MF.getFrameInfo()->hasCalls())
 162     CPUBitmask |= (1 << MipsRegisterInfo::
 163                 getRegisterNumbering(RI.getRARegister()));
 164
 165   // Print CPUBitmask
 166   O << "\t.mask \t"; printHex32(CPUBitmask); O << ','
 167     << MipsFI->getCPUTopSavedRegOff() << '\n';
 168
 169   // Print FPUBitmask
 170   O << "\t.fmask\t"; printHex32(FPUBitmask); O << ","
 171     << MipsFI->getFPUTopSavedRegOff() << '\n';
 172 }
 173
 174 // Print a 32 bit hex number with all numbers.
 175 void MipsAsmPrinter::
 176 printHex32(unsigned int Value)
 177 {
 178   O << "0x" << std::hex;
 179   for (int i = 7; i >= 0; i--)
 180     O << std::hex << ( (Value & (0xF << (i*4))) >> (i*4) );
 181   O << std::dec;
 182 }
 183
 184 //===----------------------------------------------------------------------===//
 185 // Frame and Set directives
 186 //===----------------------------------------------------------------------===//
 187
 188 /// Frame Directive
 189 void MipsAsmPrinter::
 190 emitFrameDirective(MachineFunction &MF)
 191 {
 192   const TargetRegisterInfo &RI = *TM.getRegisterInfo();
 193
 194   unsigned stackReg  = RI.getFrameRegister(MF);
 195   unsigned returnReg = RI.getRARegister();
 196   unsigned stackSize = MF.getFrameInfo()->getStackSize();
 197
 198
 199   O << "\t.frame\t" << '$' << LowercaseString(RI.get(stackReg).AsmName)
 200                     << ',' << stackSize << ','
 201                     << '$' << LowercaseString(RI.get(returnReg).AsmName)
 202                     << '\n';
 203 }
 204
 205 /// Emit Set directives.
 206 const char * MipsAsmPrinter::
 207 emitCurrentABIString(void)
 208 {
 209   switch(Subtarget->getTargetABI()) {
 210     case MipsSubtarget::O32:  return "abi32";
 211     case MipsSubtarget::O64:  return "abiO64";
 212     case MipsSubtarget::N32:  return "abiN32";
 213     case MipsSubtarget::N64:  return "abi64";
 214     case MipsSubtarget::EABI: return "eabi32"; // TODO: handle eabi64
 215     default: break;
 216   }
 217
 218   assert(0 && "Unknown Mips ABI");
 219   return NULL;
 220 }
 221
 222 // Substitute old hook with new one temporary
 223 std::string MipsAsmPrinter::getSectionForFunction(const Function &F) const {
 224   return TAI->SectionForGlobal(&F);
 225 }
 226
 227 /// Emit the directives used by GAS on the start of functions
 228 void MipsAsmPrinter::
 229 emitFunctionStart(MachineFunction &MF)
 230 {
 231   // Print out the label for the function.
 232   const Function *F = MF.getFunction();
 233   SwitchToTextSection(TAI->SectionForGlobal(F).c_str());
 234
 235   // 2 bits aligned
 236   EmitAlignment(2, F);
 237
 238   O << "\t.globl\t"  << CurrentFnName << '\n';
 239   O << "\t.ent\t"    << CurrentFnName << '\n';
 240
 241   printVisibility(CurrentFnName, F->getVisibility());
 242
 243   if ((TAI->hasDotTypeDotSizeDirective()) && Subtarget->isLinux())
 244     O << "\t.type\t"   << CurrentFnName << ", @function\n";
 245
 246   O << CurrentFnName << ":\n";
 247
 248   emitFrameDirective(MF);
 249   printSavedRegsBitmask(MF);
 250
 251   O << '\n';
 252 }
 253
 254 /// Emit the directives used by GAS on the end of functions
 255 void MipsAsmPrinter::
 256 emitFunctionEnd(MachineFunction &MF)
 257 {
 258   // There are instruction for this macros, but they must
 259   // always be at the function end, and we can't emit and
 260   // break with BB logic.
 261   O << "\t.set\tmacro\n";
 262   O << "\t.set\treorder\n";
 263
 264   O << "\t.end\t" << CurrentFnName << '\n';
 265   if (TAI->hasDotTypeDotSizeDirective() && !Subtarget->isLinux())
 266     O << "\t.size\t" << CurrentFnName << ", .-" << CurrentFnName << '\n';
 267 }
 268
 269 /// runOnMachineFunction - This uses the printMachineInstruction()
 270 /// method to print assembly for each instruction.
 271 bool MipsAsmPrinter::
 272 runOnMachineFunction(MachineFunction &MF)
 273 {
 274   SetupMachineFunction(MF);
 275
 276   // Print out constants referenced by the function
 277   EmitConstantPool(MF.getConstantPool());
 278
 279   // Print out jump tables referenced by the function
 280   EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
 281
 282   O << "\n\n";
 283
 284   // What's my mangled name?
 285   CurrentFnName = Mang->getValueName(MF.getFunction());
 286
 287   // Emit the function start directives
 288   emitFunctionStart(MF);
 289
 290   // Print out code for the function.
 291   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 292        I != E; ++I) {
 293
 294     // Print a label for the basic block.
 295     if (I != MF.begin()) {
 296       printBasicBlockLabel(I, true, true);
 297       O << '\n';
 298     }
 299
 300     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
 301          II != E; ++II) {
 302       // Print the assembly for the instruction.
 303       printInstruction(II);
 304       ++EmittedInsts;
 305     }
 306
 307     // Each Basic Block is separated by a newline
 308     O << '\n';
 309   }
 310
 311   // Emit function end directives
 312   emitFunctionEnd(MF);
 313
 314   // We didn't modify anything.
 315   return false;
 316 }
 317
 318 // Print out an operand for an inline asm expression.
 319 bool MipsAsmPrinter::
 320 PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 321                 unsigned AsmVariant, const char *ExtraCode)
 322 {
 323   // Does this asm operand have a single letter operand modifier?
 324   if (ExtraCode && ExtraCode[0])
 325     return true; // Unknown modifier.
 326
 327   printOperand(MI, OpNo);
 328   return false;
 329 }
 330
 331 void MipsAsmPrinter::
 332 printOperand(const MachineInstr *MI, int opNum)
 333 {
 334   const MachineOperand &MO = MI->getOperand(opNum);
 335   const TargetRegisterInfo  &RI = *TM.getRegisterInfo();
 336   bool closeP = false;
 337   bool isPIC = (TM.getRelocationModel() == Reloc::PIC_);
 338   bool isCodeLarge = (TM.getCodeModel() == CodeModel::Large);
 339
 340   // %hi and %lo used on mips gas to load global addresses on
 341   // static code. %got is used to load global addresses when
 342   // using PIC_. %call16 is used to load direct call targets
 343   // on PIC_ and small code size. %call_lo and %call_hi load
 344   // direct call targets on PIC_ and large code size.
 345   if (MI->getOpcode() == Mips::LUi && !MO.isRegister()
 346       && !MO.isImmediate()) {
 347     if ((isPIC) && (isCodeLarge))
 348       O << "%call_hi(";
 349     else
 350       O << "%hi(";
 351     closeP = true;
 352   } else if ((MI->getOpcode() == Mips::ADDiu) && !MO.isRegister()
 353              && !MO.isImmediate()) {
 354     const MachineOperand &firstMO = MI->getOperand(opNum-1);
 355     if (firstMO.getReg() == Mips::GP)
 356       O << "%gp_rel(";
 357     else
 358       O << "%lo(";
 359     closeP = true;
 360   } else if ((isPIC) && (MI->getOpcode() == Mips::LW)
 361              && (!MO.isRegister()) && (!MO.isImmediate())) {
 362     const MachineOperand &firstMO = MI->getOperand(opNum-1);
 363     const MachineOperand &lastMO  = MI->getOperand(opNum+1);
 364     if ((firstMO.isRegister()) && (lastMO.isRegister())) {
 365       if ((firstMO.getReg() == Mips::T9) && (lastMO.getReg() == Mips::GP)
 366           && (!isCodeLarge))
 367         O << "%call16(";
 368       else if ((firstMO.getReg() != Mips::T9) && (lastMO.getReg() == Mips::GP))
 369         O << "%got(";
 370       else if ((firstMO.getReg() == Mips::T9) && (lastMO.getReg() != Mips::GP)
 371                && (isCodeLarge))
 372         O << "%call_lo(";
 373       closeP = true;
 374     }
 375   }
 376
 377   switch (MO.getType())
 378   {
 379     case MachineOperand::MO_Register:
 380       if (TargetRegisterInfo::isPhysicalRegister(MO.getReg()))
 381         O << '$' << LowercaseString (RI.get(MO.getReg()).AsmName);
 382       else
 383         O << '$' << MO.getReg();
 384       break;
 385
 386     case MachineOperand::MO_Immediate:
 387       O << (short int)MO.getImm();
 388       break;
 389
 390     case MachineOperand::MO_MachineBasicBlock:
 391       printBasicBlockLabel(MO.getMBB());
 392       return;
 393
 394     case MachineOperand::MO_GlobalAddress:
 395       O << Mang->getValueName(MO.getGlobal());
 396       break;
 397
 398     case MachineOperand::MO_ExternalSymbol:
 399       O << MO.getSymbolName();
 400       break;
 401
 402     case MachineOperand::MO_JumpTableIndex:
 403       O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
 404       << '_' << MO.getIndex();
 405       break;
 406
 407     case MachineOperand::MO_ConstantPoolIndex:
 408       O << TAI->getPrivateGlobalPrefix() << "CPI"
 409         << getFunctionNumber() << "_" << MO.getIndex();
 410       break;
 411
 412     default:
 413       O << "<unknown operand type>"; abort (); break;
 414   }
 415
 416   if (closeP) O << ")";
 417 }
 418
 419 void MipsAsmPrinter::
 420 printUnsignedImm(const MachineInstr *MI, int opNum)
 421 {
 422   const MachineOperand &MO = MI->getOperand(opNum);
 423   if (MO.getType() == MachineOperand::MO_Immediate)
 424     O << (unsigned short int)MO.getImm();
 425   else
 426     printOperand(MI, opNum);
 427 }
 428
 429 void MipsAsmPrinter::
 430 printMemOperand(const MachineInstr *MI, int opNum, const char *Modifier)
 431 {
 432   // when using stack locations for not load/store instructions
 433   // print the same way as all normal 3 operand instructions.
 434   if (Modifier && !strcmp(Modifier, "stackloc")) {
 435     printOperand(MI, opNum+1);
 436     O << ", ";
 437     printOperand(MI, opNum);
 438     return;
 439   }
 440
 441   // Load/Store memory operands -- imm($reg)
 442   // If PIC target the target is loaded as the
 443   // pattern lw $25,%call16($28)
 444   printOperand(MI, opNum);
 445   O << "(";
 446   printOperand(MI, opNum+1);
 447   O << ")";
 448 }
 449
 450 void MipsAsmPrinter::
 451 printFCCOperand(const MachineInstr *MI, int opNum, const char *Modifier)
 452 {
 453   const MachineOperand& MO = MI->getOperand(opNum);
 454   O << Mips::MipsFCCToString((Mips::CondCode)MO.getImm());
 455 }
 456
 457 bool MipsAsmPrinter::
 458 doInitialization(Module &M)
 459 {
 460   Mang = new Mangler(M);
 461
 462   // Tell the assembler which ABI we are using
 463   O << "\t.section .mdebug." << emitCurrentABIString() << '\n';
 464
 465   // TODO: handle O64 ABI
 466   if (Subtarget->isABI_EABI())
 467     O << "\t.section .gcc_compiled_long" <<
 468       (Subtarget->isGP32bit() ? "32" : "64") << '\n';
 469
 470   // return to previous section
 471   O << "\t.previous" << '\n';
 472
 473   return false; // success
 474 }
 475
 476 void MipsAsmPrinter::
 477 printModuleLevelGV(const GlobalVariable* GVar) {
 478   const TargetData *TD = TM.getTargetData();
 479
 480   if (!GVar->hasInitializer())
 481     return;   // External global require no code
 482
 483   // Check to see if this is a special global used by LLVM, if so, emit it.
 484   if (EmitSpecialLLVMGlobal(GVar))
 485     return;
 486
 487   O << "\n\n";
 488   std::string SectionName = TAI->SectionForGlobal(GVar);
 489   std::string name = Mang->getValueName(GVar);
 490   Constant *C = GVar->getInitializer();
 491   const Type *CTy = C->getType();
 492   unsigned Size = TD->getABITypeSize(CTy);
 493   const ConstantArray *CVA = dyn_cast<ConstantArray>(C);
 494   bool printSizeAndType = true;
 495
 496   // A data structure or array is aligned in memory to the largest
 497   // alignment boundary required by any data type inside it (this matches
 498   // the Preferred Type Alignment). For integral types, the alignment is
 499   // the type size.
 500   unsigned Align;
 501   if (CTy->getTypeID() == Type::IntegerTyID ||
 502       CTy->getTypeID() == Type::VoidTyID) {
 503     assert(!(Size & (Size-1)) && "Alignment is not a power of two!");
 504     Align = Log2_32(Size);
 505   } else
 506     Align = TD->getPreferredTypeAlignmentShift(CTy);
 507
 508   printVisibility(name, GVar->getVisibility());
 509
 510   SwitchToDataSection(SectionName.c_str());
 511
 512   if (C->isNullValue() && !GVar->hasSection()) {
 513     if (!GVar->isThreadLocal() &&
 514         (GVar->hasInternalLinkage() || GVar->isWeakForLinker())) {
 515       if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
 516
 517       if (GVar->hasInternalLinkage())
 518         O << "\t.local\t" << name << '\n';
 519
 520       O << TAI->getCOMMDirective() << name << ',' << Size;
 521       if (TAI->getCOMMDirectiveTakesAlignment())
 522         O << ',' << (1 << Align);
 523
 524       O << '\n';
 525       return;
 526     }
 527   }
 528   switch (GVar->getLinkage()) {
 529    case GlobalValue::LinkOnceLinkage:
 530    case GlobalValue::CommonLinkage:
 531    case GlobalValue::WeakLinkage:
 532     // FIXME: Verify correct for weak.
 533     // Nonnull linkonce -> weak
 534     O << "\t.weak " << name << '\n';
 535     break;
 536    case GlobalValue::AppendingLinkage:
 537     // FIXME: appending linkage variables should go into a section of their name
 538     // or something.  For now, just emit them as external.
 539    case GlobalValue::ExternalLinkage:
 540     // If external or appending, declare as a global symbol
 541     O << TAI->getGlobalDirective() << name << '\n';
 542     // Fall Through
 543    case GlobalValue::InternalLinkage:
 544     if (CVA && CVA->isCString())
 545       printSizeAndType = false;
 546     break;
 547    case GlobalValue::GhostLinkage:
 548     cerr << "Should not have any unmaterialized functions!\n";
 549     abort();
 550    case GlobalValue::DLLImportLinkage:
 551     cerr << "DLLImport linkage is not supported by this target!\n";
 552     abort();
 553    case GlobalValue::DLLExportLinkage:
 554     cerr << "DLLExport linkage is not supported by this target!\n";
 555     abort();
 556    default:
 557     assert(0 && "Unknown linkage type!");
 558   }
 559
 560   EmitAlignment(Align, GVar);
 561
 562   if (TAI->hasDotTypeDotSizeDirective() && printSizeAndType) {
 563     O << "\t.type " << name << ",@object\n";
 564     O << "\t.size " << name << ',' << Size << '\n';
 565   }
 566
 567   O << name << ":\n";
 568   EmitGlobalConstant(C);
 569 }
 570
 571 bool MipsAsmPrinter::
 572 doFinalization(Module &M)
 573 {
 574   // Print out module-level global variables here.
 575   for (Module::const_global_iterator I = M.global_begin(),
 576          E = M.global_end(); I != E; ++I)
 577     printModuleLevelGV(I);
 578
 579   O << '\n';
 580
 581   return AsmPrinter::doFinalization(M);
 582 }