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