lib/Target/Mips/AsmPrinter/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/DwarfWriter.h"
  27 #include "llvm/CodeGen/MachineFunctionPass.h"
  28 #include "llvm/CodeGen/MachineConstantPool.h"
  29 #include "llvm/CodeGen/MachineFrameInfo.h"
  30 #include "llvm/CodeGen/MachineInstr.h"
  31 #include "llvm/MC/MCStreamer.h"
  32 #include "llvm/MC/MCAsmInfo.h"
  33 #include "llvm/MC/MCSymbol.h"
  34 #include "llvm/Target/TargetData.h"
  35 #include "llvm/Target/TargetLoweringObjectFile.h"
  36 #include "llvm/Target/TargetMachine.h"
  37 #include "llvm/Target/TargetOptions.h"
  38 #include "llvm/Target/TargetRegistry.h"
  39 #include "llvm/Support/ErrorHandling.h"
  40 #include "llvm/ADT/Statistic.h"
  41 #include "llvm/ADT/StringExtras.h"
  42 #include "llvm/Support/Debug.h"
  43 #include "llvm/Support/CommandLine.h"
  44 #include "llvm/Support/FormattedStream.h"
  45 #include "llvm/Support/MathExtras.h"
  46 #include <cctype>
  47 using namespace llvm;
  48
  49 STATISTIC(EmittedInsts, "Number of machine instrs printed");
  50
  51 namespace {
  52   class MipsAsmPrinter : public AsmPrinter {
  53     const MipsSubtarget *Subtarget;
  54   public:
  55     explicit MipsAsmPrinter(formatted_raw_ostream &O, TargetMachine &TM,
  56                             const MCAsmInfo *T, bool V)
  57       : AsmPrinter(O, TM, T, V) {
  58       Subtarget = &TM.getSubtarget<MipsSubtarget>();
  59     }
  60
  61     virtual const char *getPassName() const {
  62       return "Mips Assembly Printer";
  63     }
  64
  65     bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
  66                          unsigned AsmVariant, const char *ExtraCode);
  67     void printOperand(const MachineInstr *MI, int opNum);
  68     void printUnsignedImm(const MachineInstr *MI, int opNum);
  69     void printMemOperand(const MachineInstr *MI, int opNum,
  70                          const char *Modifier = 0);
  71     void printFCCOperand(const MachineInstr *MI, int opNum,
  72                          const char *Modifier = 0);
  73     void printSavedRegsBitmask(MachineFunction &MF);
  74     void printHex32(unsigned int Value);
  75
  76     const char *emitCurrentABIString();
  77     void emitFunctionStart(MachineFunction &MF);
  78     void emitFunctionEnd(MachineFunction &MF);
  79     void emitFrameDirective(MachineFunction &MF);
  80
  81     void printInstruction(const MachineInstr *MI);  // autogenerated.
  82     static const char *getRegisterName(unsigned RegNo);
  83
  84     bool runOnMachineFunction(MachineFunction &F);
  85     void EmitStartOfAsmFile(Module &M);
  86   };
  87 } // end of anonymous namespace
  88
  89 #include "MipsGenAsmWriter.inc"
  90
  91 //===----------------------------------------------------------------------===//
  92 //
  93 //  Mips Asm Directives
  94 //
  95 //  -- Frame directive "frame Stackpointer, Stacksize, RARegister"
  96 //  Describe the stack frame.
  97 //
  98 //  -- Mask directives "(f)mask  bitmask, offset"
  99 //  Tells the assembler which registers are saved and where.
 100 //  bitmask - contain a little endian bitset indicating which registers are
 101 //            saved on function prologue (e.g. with a 0x80000000 mask, the
 102 //            assembler knows the register 31 (RA) is saved at prologue.
 103 //  offset  - the position before stack pointer subtraction indicating where
 104 //            the first saved register on prologue is located. (e.g. with a
 105 //
 106 //  Consider the following function prologue:
 107 //
 108 //    .frame  $fp,48,$ra
 109 //    .mask   0xc0000000,-8
 110 //       addiu $sp, $sp, -48
 111 //       sw $ra, 40($sp)
 112 //       sw $fp, 36($sp)
 113 //
 114 //    With a 0xc0000000 mask, the assembler knows the register 31 (RA) and
 115 //    30 (FP) are saved at prologue. As the save order on prologue is from
 116 //    left to right, RA is saved first. A -8 offset means that after the
 117 //    stack pointer subtration, the first register in the mask (RA) will be
 118 //    saved at address 48-8=40.
 119 //
 120 //===----------------------------------------------------------------------===//
 121
 122 //===----------------------------------------------------------------------===//
 123 // Mask directives
 124 //===----------------------------------------------------------------------===//
 125
 126 // Create a bitmask with all callee saved registers for CPU or Floating Point
 127 // registers. For CPU registers consider RA, GP and FP for saving if necessary.
 128 void MipsAsmPrinter::
 129 printSavedRegsBitmask(MachineFunction &MF)
 130 {
 131   const TargetRegisterInfo &RI = *TM.getRegisterInfo();
 132   MipsFunctionInfo *MipsFI = MF.getInfo<MipsFunctionInfo>();
 133
 134   // CPU and FPU Saved Registers Bitmasks
 135   unsigned int CPUBitmask = 0;
 136   unsigned int FPUBitmask = 0;
 137
 138   // Set the CPU and FPU Bitmasks
 139   MachineFrameInfo *MFI = MF.getFrameInfo();
 140   const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
 141   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
 142     unsigned RegNum = MipsRegisterInfo::getRegisterNumbering(CSI[i].getReg());
 143     if (CSI[i].getRegClass() == Mips::CPURegsRegisterClass)
 144       CPUBitmask |= (1 << RegNum);
 145     else
 146       FPUBitmask |= (1 << RegNum);
 147   }
 148
 149   // Return Address and Frame registers must also be set in CPUBitmask.
 150   if (RI.hasFP(MF))
 151     CPUBitmask |= (1 << MipsRegisterInfo::
 152                 getRegisterNumbering(RI.getFrameRegister(MF)));
 153
 154   if (MF.getFrameInfo()->hasCalls())
 155     CPUBitmask |= (1 << MipsRegisterInfo::
 156                 getRegisterNumbering(RI.getRARegister()));
 157
 158   // Print CPUBitmask
 159   O << "\t.mask \t"; printHex32(CPUBitmask); O << ','
 160     << MipsFI->getCPUTopSavedRegOff() << '\n';
 161
 162   // Print FPUBitmask
 163   O << "\t.fmask\t"; printHex32(FPUBitmask); O << ","
 164     << MipsFI->getFPUTopSavedRegOff() << '\n';
 165 }
 166
 167 // Print a 32 bit hex number with all numbers.
 168 void MipsAsmPrinter::
 169 printHex32(unsigned int Value)
 170 {
 171   O << "0x";
 172   for (int i = 7; i >= 0; i--)
 173     O << utohexstr( (Value & (0xF << (i*4))) >> (i*4) );
 174 }
 175
 176 //===----------------------------------------------------------------------===//
 177 // Frame and Set directives
 178 //===----------------------------------------------------------------------===//
 179
 180 /// Frame Directive
 181 void MipsAsmPrinter::emitFrameDirective(MachineFunction &MF) {
 182   const TargetRegisterInfo &RI = *TM.getRegisterInfo();
 183
 184   unsigned stackReg  = RI.getFrameRegister(MF);
 185   unsigned returnReg = RI.getRARegister();
 186   unsigned stackSize = MF.getFrameInfo()->getStackSize();
 187
 188
 189   O << "\t.frame\t" << '$' << LowercaseString(getRegisterName(stackReg))
 190                     << ',' << stackSize << ','
 191                     << '$' << LowercaseString(getRegisterName(returnReg))
 192                     << '\n';
 193 }
 194
 195 /// Emit Set directives.
 196 const char *MipsAsmPrinter::emitCurrentABIString() {
 197   switch(Subtarget->getTargetABI()) {
 198     case MipsSubtarget::O32:  return "abi32";
 199     case MipsSubtarget::O64:  return "abiO64";
 200     case MipsSubtarget::N32:  return "abiN32";
 201     case MipsSubtarget::N64:  return "abi64";
 202     case MipsSubtarget::EABI: return "eabi32"; // TODO: handle eabi64
 203     default: break;
 204   }
 205
 206   llvm_unreachable("Unknown Mips ABI");
 207   return NULL;
 208 }
 209
 210 /// Emit the directives used by GAS on the start of functions
 211 void MipsAsmPrinter::emitFunctionStart(MachineFunction &MF) {
 212   // Print out the label for the function.
 213   const Function *F = MF.getFunction();
 214   OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang, TM));
 215
 216   // 2 bits aligned
 217   EmitAlignment(MF.getAlignment(), F);
 218
 219   O << "\t.globl\t" << *CurrentFnSym << '\n';
 220   O << "\t.ent\t" << *CurrentFnSym << '\n';
 221
 222   printVisibility(CurrentFnSym, F->getVisibility());
 223
 224   if ((MAI->hasDotTypeDotSizeDirective()) && Subtarget->isLinux())
 225     O << "\t.type\t" << *CurrentFnSym << ", @function\n";
 226
 227   O << *CurrentFnSym << ":\n";
 228
 229   emitFrameDirective(MF);
 230   printSavedRegsBitmask(MF);
 231
 232   O << '\n';
 233 }
 234
 235 /// Emit the directives used by GAS on the end of functions
 236 void MipsAsmPrinter::emitFunctionEnd(MachineFunction &MF) {
 237   // There are instruction for this macros, but they must
 238   // always be at the function end, and we can't emit and
 239   // break with BB logic.
 240   O << "\t.set\tmacro\n";
 241   O << "\t.set\treorder\n";
 242
 243   O << "\t.end\t" << *CurrentFnSym << '\n';
 244   if (MAI->hasDotTypeDotSizeDirective() && !Subtarget->isLinux())
 245     O << "\t.size\t" << *CurrentFnSym << ", .-" << *CurrentFnSym << '\n';
 246 }
 247
 248 /// runOnMachineFunction - This uses the printMachineInstruction()
 249 /// method to print assembly for each instruction.
 250 bool MipsAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
 251   SetupMachineFunction(MF);
 252
 253   // Print out constants referenced by the function
 254   EmitConstantPool(MF.getConstantPool());
 255
 256   // Print out jump tables referenced by the function
 257   EmitJumpTableInfo(MF);
 258
 259   O << "\n\n";
 260
 261   // Emit the function start directives
 262   emitFunctionStart(MF);
 263
 264   // Print out code for the function.
 265   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 266        I != E; ++I) {
 267
 268     // Print a label for the basic block.
 269     if (I != MF.begin()) {
 270       EmitBasicBlockStart(I);
 271     }
 272
 273     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
 274          II != E; ++II) {
 275       processDebugLoc(II, true);
 276
 277       // Print the assembly for the instruction.
 278       printInstruction(II);
 279
 280       if (VerboseAsm)
 281         EmitComments(*II);
 282       O << '\n';
 283
 284       processDebugLoc(II, false);
 285       ++EmittedInsts;
 286     }
 287
 288     // Each Basic Block is separated by a newline
 289     O << '\n';
 290   }
 291
 292   // Emit function end directives
 293   emitFunctionEnd(MF);
 294
 295   // We didn't modify anything.
 296   return false;
 297 }
 298
 299 // Print out an operand for an inline asm expression.
 300 bool MipsAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 301                                      unsigned AsmVariant,const char *ExtraCode){
 302   // Does this asm operand have a single letter operand modifier?
 303   if (ExtraCode && ExtraCode[0])
 304     return true; // Unknown modifier.
 305
 306   printOperand(MI, OpNo);
 307   return false;
 308 }
 309
 310 void MipsAsmPrinter::printOperand(const MachineInstr *MI, int opNum) {
 311   const MachineOperand &MO = MI->getOperand(opNum);
 312   bool closeP = false;
 313
 314   if (MO.getTargetFlags())
 315     closeP = true;
 316
 317   switch(MO.getTargetFlags()) {
 318   case MipsII::MO_GPREL:    O << "%gp_rel("; break;
 319   case MipsII::MO_GOT_CALL: O << "%call16("; break;
 320   case MipsII::MO_GOT:
 321     if (MI->getOpcode() == Mips::LW)
 322       O << "%got(";
 323     else
 324       O << "%lo(";
 325     break;
 326   case MipsII::MO_ABS_HILO:
 327     if (MI->getOpcode() == Mips::LUi)
 328       O << "%hi(";
 329     else
 330       O << "%lo(";
 331     break;
 332   }
 333
 334   switch (MO.getType()) {
 335     case MachineOperand::MO_Register:
 336       O << '$' << LowercaseString(getRegisterName(MO.getReg()));
 337       break;
 338
 339     case MachineOperand::MO_Immediate:
 340       O << (short int)MO.getImm();
 341       break;
 342
 343     case MachineOperand::MO_MachineBasicBlock:
 344       O << *MO.getMBB()->getSymbol(OutContext);
 345       return;
 346
 347     case MachineOperand::MO_GlobalAddress:
 348       O << *GetGlobalValueSymbol(MO.getGlobal());
 349       break;
 350
 351     case MachineOperand::MO_ExternalSymbol:
 352       O << *GetExternalSymbolSymbol(MO.getSymbolName());
 353       break;
 354
 355     case MachineOperand::MO_JumpTableIndex:
 356       O << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
 357         << '_' << MO.getIndex();
 358       break;
 359
 360     case MachineOperand::MO_ConstantPoolIndex:
 361       O << MAI->getPrivateGlobalPrefix() << "CPI"
 362         << getFunctionNumber() << "_" << MO.getIndex();
 363       if (MO.getOffset())
 364         O << "+" << MO.getOffset();
 365       break;
 366
 367     default:
 368       llvm_unreachable("<unknown operand type>");
 369   }
 370
 371   if (closeP) O << ")";
 372 }
 373
 374 void MipsAsmPrinter::printUnsignedImm(const MachineInstr *MI, int opNum) {
 375   const MachineOperand &MO = MI->getOperand(opNum);
 376   if (MO.getType() == MachineOperand::MO_Immediate)
 377     O << (unsigned short int)MO.getImm();
 378   else
 379     printOperand(MI, opNum);
 380 }
 381
 382 void MipsAsmPrinter::
 383 printMemOperand(const MachineInstr *MI, int opNum, const char *Modifier) {
 384   // when using stack locations for not load/store instructions
 385   // print the same way as all normal 3 operand instructions.
 386   if (Modifier && !strcmp(Modifier, "stackloc")) {
 387     printOperand(MI, opNum+1);
 388     O << ", ";
 389     printOperand(MI, opNum);
 390     return;
 391   }
 392
 393   // Load/Store memory operands -- imm($reg)
 394   // If PIC target the target is loaded as the
 395   // pattern lw $25,%call16($28)
 396   printOperand(MI, opNum);
 397   O << "(";
 398   printOperand(MI, opNum+1);
 399   O << ")";
 400 }
 401
 402 void MipsAsmPrinter::
 403 printFCCOperand(const MachineInstr *MI, int opNum, const char *Modifier) {
 404   const MachineOperand& MO = MI->getOperand(opNum);
 405   O << Mips::MipsFCCToString((Mips::CondCode)MO.getImm());
 406 }
 407
 408 void MipsAsmPrinter::EmitStartOfAsmFile(Module &M) {
 409   // FIXME: Use SwitchSection.
 410
 411   // Tell the assembler which ABI we are using
 412   O << "\t.section .mdebug." << emitCurrentABIString() << '\n';
 413
 414   // TODO: handle O64 ABI
 415   if (Subtarget->isABI_EABI())
 416     O << "\t.section .gcc_compiled_long" <<
 417       (Subtarget->isGP32bit() ? "32" : "64") << '\n';
 418
 419   // return to previous section
 420   O << "\t.previous" << '\n';
 421 }
 422
 423 // Force static initialization.
 424 extern "C" void LLVMInitializeMipsAsmPrinter() {
 425   RegisterAsmPrinter<MipsAsmPrinter> X(TheMipsTarget);
 426   RegisterAsmPrinter<MipsAsmPrinter> Y(TheMipselTarget);
 427 }