lib/Target/Mips/MipsAsmPrinter.cpp

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