lib/Target/Sparc/SparcAsmPrinter.cpp

   1 //===-- SparcAsmPrinter.cpp - Sparc 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 SPARC assembly language.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "asm-printer"
  16 #include "Sparc.h"
  17 #include "InstPrinter/SparcInstPrinter.h"
  18 #include "MCTargetDesc/SparcBaseInfo.h"
  19 #include "MCTargetDesc/SparcMCExpr.h"
  20 #include "SparcInstrInfo.h"
  21 #include "SparcTargetMachine.h"
  22 #include "SparcTargetStreamer.h"
  23 #include "llvm/ADT/SmallString.h"
  24 #include "llvm/CodeGen/AsmPrinter.h"
  25 #include "llvm/CodeGen/MachineInstr.h"
  26 #include "llvm/CodeGen/MachineRegisterInfo.h"
  27 #include "llvm/IR/Mangler.h"
  28 #include "llvm/MC/MCAsmInfo.h"
  29 #include "llvm/MC/MCContext.h"
  30 #include "llvm/MC/MCInst.h"
  31 #include "llvm/MC/MCStreamer.h"
  32 #include "llvm/MC/MCSymbol.h"
  33 #include "llvm/Support/TargetRegistry.h"
  34 #include "llvm/Support/raw_ostream.h"
  35 using namespace llvm;
  36
  37 namespace {
  38   class SparcAsmPrinter : public AsmPrinter {
  39     SparcTargetStreamer &getTargetStreamer() {
  40       return static_cast<SparcTargetStreamer&>(OutStreamer.getTargetStreamer());
  41     }
  42   public:
  43     explicit SparcAsmPrinter(TargetMachine &TM, MCStreamer &Streamer)
  44       : AsmPrinter(TM, Streamer) {}
  45
  46     virtual const char *getPassName() const {
  47       return "Sparc Assembly Printer";
  48     }
  49
  50     void printOperand(const MachineInstr *MI, int opNum, raw_ostream &OS);
  51     void printMemOperand(const MachineInstr *MI, int opNum, raw_ostream &OS,
  52                          const char *Modifier = 0);
  53     void printCCOperand(const MachineInstr *MI, int opNum, raw_ostream &OS);
  54
  55     virtual void EmitFunctionBodyStart();
  56     virtual void EmitInstruction(const MachineInstr *MI);
  57
  58     static const char *getRegisterName(unsigned RegNo) {
  59       return SparcInstPrinter::getRegisterName(RegNo);
  60     }
  61
  62     bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
  63                          unsigned AsmVariant, const char *ExtraCode,
  64                          raw_ostream &O);
  65     bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
  66                                unsigned AsmVariant, const char *ExtraCode,
  67                                raw_ostream &O);
  68
  69     virtual bool isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB)
  70                        const;
  71
  72   };
  73 } // end of anonymous namespace
  74
  75 static MCOperand createPCXCallOP(MCSymbol *Label,
  76                                  MCContext &OutContext)
  77 {
  78   const MCSymbolRefExpr *MCSym = MCSymbolRefExpr::Create(Label,
  79                                                          OutContext);
  80   const SparcMCExpr *expr = SparcMCExpr::Create(SparcMCExpr::VK_Sparc_None,
  81                                                 MCSym, OutContext);
  82   return MCOperand::CreateExpr(expr);
  83 }
  84
  85 static MCOperand createPCXRelExprOp(SparcMCExpr::VariantKind Kind,
  86                                     MCSymbol *GOTLabel, MCSymbol *StartLabel,
  87                                     MCSymbol *CurLabel,
  88                                     MCContext &OutContext)
  89 {
  90   const MCSymbolRefExpr *GOT = MCSymbolRefExpr::Create(GOTLabel, OutContext);
  91   const MCSymbolRefExpr *Start = MCSymbolRefExpr::Create(StartLabel,
  92                                                          OutContext);
  93   const MCSymbolRefExpr *Cur = MCSymbolRefExpr::Create(CurLabel,
  94                                                        OutContext);
  95
  96   const MCBinaryExpr *Sub = MCBinaryExpr::CreateSub(Cur, Start, OutContext);
  97   const MCBinaryExpr *Add = MCBinaryExpr::CreateAdd(GOT, Sub, OutContext);
  98   const SparcMCExpr *expr = SparcMCExpr::Create(Kind,
  99                                                 Add, OutContext);
 100   return MCOperand::CreateExpr(expr);
 101 }
 102
 103 static void EmitCall(MCStreamer &OutStreamer,
 104                      MCOperand &Callee)
 105 {
 106   MCInst CallInst;
 107   CallInst.setOpcode(SP::CALL);
 108   CallInst.addOperand(Callee);
 109   OutStreamer.EmitInstruction(CallInst);
 110 }
 111
 112 static void EmitSETHI(MCStreamer &OutStreamer,
 113                       MCOperand &Imm, MCOperand &RD)
 114 {
 115   MCInst SETHIInst;
 116   SETHIInst.setOpcode(SP::SETHIi);
 117   SETHIInst.addOperand(RD);
 118   SETHIInst.addOperand(Imm);
 119   OutStreamer.EmitInstruction(SETHIInst);
 120 }
 121
 122 static void EmitOR(MCStreamer &OutStreamer, MCOperand &RS1,
 123                    MCOperand &Imm, MCOperand &RD)
 124 {
 125   MCInst ORInst;
 126   ORInst.setOpcode(SP::ORri);
 127   ORInst.addOperand(RD);
 128   ORInst.addOperand(RS1);
 129   ORInst.addOperand(Imm);
 130   OutStreamer.EmitInstruction(ORInst);
 131 }
 132
 133 static void EmitADD(MCStreamer &OutStreamer,
 134                     MCOperand &RS1, MCOperand &RS2, MCOperand &RD)
 135 {
 136   MCInst ADDInst;
 137   ADDInst.setOpcode(SP::ADDrr);
 138   ADDInst.addOperand(RD);
 139   ADDInst.addOperand(RS1);
 140   ADDInst.addOperand(RS2);
 141   OutStreamer.EmitInstruction(ADDInst);
 142 }
 143
 144 static void LowerGETPCXAndEmitMCInsts(const MachineInstr *MI,
 145                                       MCStreamer &OutStreamer,
 146                                       MCContext &OutContext)
 147 {
 148   const MachineOperand &MO = MI->getOperand(0);
 149   MCSymbol *StartLabel = OutContext.CreateTempSymbol();
 150   MCSymbol *EndLabel   = OutContext.CreateTempSymbol();
 151   MCSymbol *SethiLabel = OutContext.CreateTempSymbol();
 152   MCSymbol *GOTLabel   =
 153     OutContext.GetOrCreateSymbol(Twine("_GLOBAL_OFFSET_TABLE_"));
 154
 155   assert(MO.getReg() != SP::O7 &&
 156          "%o7 is assigned as destination for getpcx!");
 157
 158   MCOperand MCRegOP = MCOperand::CreateReg(MO.getReg());
 159   MCOperand RegO7   = MCOperand::CreateReg(SP::O7);
 160
 161   // <StartLabel>:
 162   //   call <EndLabel>
 163   // <SethiLabel>:
 164   //     sethi %hi(_GLOBAL_OFFSET_TABLE_+(<SethiLabel>-<StartLabel>)), <MO>
 165   // <EndLabel>:
 166   //   or  <MO>, %lo(_GLOBAL_OFFSET_TABLE_+(<EndLabel>-<StartLabel>))), <MO>
 167   //   add <MO>, %o7, <MO>
 168
 169   OutStreamer.EmitLabel(StartLabel);
 170   MCOperand Callee =  createPCXCallOP(EndLabel, OutContext);
 171   EmitCall(OutStreamer, Callee);
 172   OutStreamer.EmitLabel(SethiLabel);
 173   MCOperand hiImm = createPCXRelExprOp(SparcMCExpr::VK_Sparc_HI,
 174                                        GOTLabel, StartLabel, SethiLabel,
 175                                        OutContext);
 176   EmitSETHI(OutStreamer, hiImm, MCRegOP);
 177   OutStreamer.EmitLabel(EndLabel);
 178   MCOperand loImm = createPCXRelExprOp(SparcMCExpr::VK_Sparc_LO,
 179                                        GOTLabel, StartLabel, EndLabel,
 180                                        OutContext);
 181   EmitOR(OutStreamer, MCRegOP, loImm, MCRegOP);
 182   EmitADD(OutStreamer, MCRegOP, RegO7, MCRegOP);
 183 }
 184
 185 void SparcAsmPrinter::EmitInstruction(const MachineInstr *MI)
 186 {
 187
 188   switch (MI->getOpcode()) {
 189   default: break;
 190   case TargetOpcode::DBG_VALUE:
 191     // FIXME: Debug Value.
 192     return;
 193   case SP::GETPCX:
 194     LowerGETPCXAndEmitMCInsts(MI, OutStreamer, OutContext);
 195     return;
 196   }
 197   MachineBasicBlock::const_instr_iterator I = MI;
 198   MachineBasicBlock::const_instr_iterator E = MI->getParent()->instr_end();
 199   do {
 200     MCInst TmpInst;
 201     LowerSparcMachineInstrToMCInst(I, TmpInst, *this);
 202     OutStreamer.EmitInstruction(TmpInst);
 203   } while ((++I != E) && I->isInsideBundle()); // Delay slot check.
 204 }
 205
 206 void SparcAsmPrinter::EmitFunctionBodyStart() {
 207   if (!TM.getSubtarget<SparcSubtarget>().is64Bit())
 208     return;
 209
 210   const MachineRegisterInfo &MRI = MF->getRegInfo();
 211   const unsigned globalRegs[] = { SP::G2, SP::G3, SP::G6, SP::G7, 0 };
 212   for (unsigned i = 0; globalRegs[i] != 0; ++i) {
 213     unsigned reg = globalRegs[i];
 214     if (MRI.use_empty(reg))
 215       continue;
 216
 217     if  (reg == SP::G6 || reg == SP::G7)
 218       getTargetStreamer().emitSparcRegisterIgnore(reg);
 219     else
 220       getTargetStreamer().emitSparcRegisterScratch(reg);
 221   }
 222 }
 223
 224 void SparcAsmPrinter::printOperand(const MachineInstr *MI, int opNum,
 225                                    raw_ostream &O) {
 226   const DataLayout *DL = TM.getDataLayout();
 227   const MachineOperand &MO = MI->getOperand (opNum);
 228   unsigned TF = MO.getTargetFlags();
 229 #ifndef NDEBUG
 230   // Verify the target flags.
 231   if (MO.isGlobal() || MO.isSymbol() || MO.isCPI()) {
 232     if (MI->getOpcode() == SP::CALL)
 233       assert(TF == SPII::MO_NO_FLAG &&
 234              "Cannot handle target flags on call address");
 235     else if (MI->getOpcode() == SP::SETHIi || MI->getOpcode() == SP::SETHIXi)
 236       assert((TF == SPII::MO_HI || TF == SPII::MO_H44 || TF == SPII::MO_HH
 237               || TF == SPII::MO_TLS_GD_HI22
 238               || TF == SPII::MO_TLS_LDM_HI22
 239               || TF == SPII::MO_TLS_LDO_HIX22
 240               || TF == SPII::MO_TLS_IE_HI22
 241               || TF == SPII::MO_TLS_LE_HIX22) &&
 242              "Invalid target flags for address operand on sethi");
 243     else if (MI->getOpcode() == SP::TLS_CALL)
 244       assert((TF == SPII::MO_NO_FLAG
 245               || TF == SPII::MO_TLS_GD_CALL
 246               || TF == SPII::MO_TLS_LDM_CALL) &&
 247              "Cannot handle target flags on tls call address");
 248     else if (MI->getOpcode() == SP::TLS_ADDrr)
 249       assert((TF == SPII::MO_TLS_GD_ADD || TF == SPII::MO_TLS_LDM_ADD
 250               || TF == SPII::MO_TLS_LDO_ADD || TF == SPII::MO_TLS_IE_ADD) &&
 251              "Cannot handle target flags on add for TLS");
 252     else if (MI->getOpcode() == SP::TLS_LDrr)
 253       assert(TF == SPII::MO_TLS_IE_LD &&
 254              "Cannot handle target flags on ld for TLS");
 255     else if (MI->getOpcode() == SP::TLS_LDXrr)
 256       assert(TF == SPII::MO_TLS_IE_LDX &&
 257              "Cannot handle target flags on ldx for TLS");
 258     else if (MI->getOpcode() == SP::XORri || MI->getOpcode() == SP::XORXri)
 259       assert((TF == SPII::MO_TLS_LDO_LOX10 || TF == SPII::MO_TLS_LE_LOX10) &&
 260              "Cannot handle target flags on xor for TLS");
 261     else
 262       assert((TF == SPII::MO_LO || TF == SPII::MO_M44 || TF == SPII::MO_L44
 263               || TF == SPII::MO_HM
 264               || TF == SPII::MO_TLS_GD_LO10
 265               || TF == SPII::MO_TLS_LDM_LO10
 266               || TF == SPII::MO_TLS_IE_LO10 ) &&
 267              "Invalid target flags for small address operand");
 268   }
 269 #endif
 270
 271   bool CloseParen = true;
 272   switch (TF) {
 273   default:
 274       llvm_unreachable("Unknown target flags on operand");
 275   case SPII::MO_NO_FLAG:
 276     CloseParen = false;
 277     break;
 278   case SPII::MO_LO:  O << "%lo(";  break;
 279   case SPII::MO_HI:  O << "%hi(";  break;
 280   case SPII::MO_H44: O << "%h44("; break;
 281   case SPII::MO_M44: O << "%m44("; break;
 282   case SPII::MO_L44: O << "%l44("; break;
 283   case SPII::MO_HH:  O << "%hh(";  break;
 284   case SPII::MO_HM:  O << "%hm(";  break;
 285   case SPII::MO_TLS_GD_HI22:   O << "%tgd_hi22(";   break;
 286   case SPII::MO_TLS_GD_LO10:   O << "%tgd_lo10(";   break;
 287   case SPII::MO_TLS_GD_ADD:    O << "%tgd_add(";    break;
 288   case SPII::MO_TLS_GD_CALL:   O << "%tgd_call(";   break;
 289   case SPII::MO_TLS_LDM_HI22:  O << "%tldm_hi22(";  break;
 290   case SPII::MO_TLS_LDM_LO10:  O << "%tldm_lo10(";  break;
 291   case SPII::MO_TLS_LDM_ADD:   O << "%tldm_add(";   break;
 292   case SPII::MO_TLS_LDM_CALL:  O << "%tldm_call(";  break;
 293   case SPII::MO_TLS_LDO_HIX22: O << "%tldo_hix22("; break;
 294   case SPII::MO_TLS_LDO_LOX10: O << "%tldo_lox10("; break;
 295   case SPII::MO_TLS_LDO_ADD:   O << "%tldo_add(";   break;
 296   case SPII::MO_TLS_IE_HI22:   O << "%tie_hi22(";   break;
 297   case SPII::MO_TLS_IE_LO10:   O << "%tie_lo10(";   break;
 298   case SPII::MO_TLS_IE_LD:     O << "%tie_ld(";     break;
 299   case SPII::MO_TLS_IE_LDX:    O << "%tie_ldx(";    break;
 300   case SPII::MO_TLS_IE_ADD:    O << "%tie_add(";    break;
 301   case SPII::MO_TLS_LE_HIX22:  O << "%tle_hix22(";  break;
 302   case SPII::MO_TLS_LE_LOX10:  O << "%tle_lox10(";   break;
 303   }
 304
 305   switch (MO.getType()) {
 306   case MachineOperand::MO_Register:
 307     O << "%" << StringRef(getRegisterName(MO.getReg())).lower();
 308     break;
 309
 310   case MachineOperand::MO_Immediate:
 311     O << (int)MO.getImm();
 312     break;
 313   case MachineOperand::MO_MachineBasicBlock:
 314     O << *MO.getMBB()->getSymbol();
 315     return;
 316   case MachineOperand::MO_GlobalAddress:
 317     O << *getSymbol(MO.getGlobal());
 318     break;
 319   case MachineOperand::MO_BlockAddress:
 320     O <<  GetBlockAddressSymbol(MO.getBlockAddress())->getName();
 321     break;
 322   case MachineOperand::MO_ExternalSymbol:
 323     O << MO.getSymbolName();
 324     break;
 325   case MachineOperand::MO_ConstantPoolIndex:
 326     O << DL->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << "_"
 327       << MO.getIndex();
 328     break;
 329   default:
 330     llvm_unreachable("<unknown operand type>");
 331   }
 332   if (CloseParen) O << ")";
 333 }
 334
 335 void SparcAsmPrinter::printMemOperand(const MachineInstr *MI, int opNum,
 336                                       raw_ostream &O, const char *Modifier) {
 337   printOperand(MI, opNum, O);
 338
 339   // If this is an ADD operand, emit it like normal operands.
 340   if (Modifier && !strcmp(Modifier, "arith")) {
 341     O << ", ";
 342     printOperand(MI, opNum+1, O);
 343     return;
 344   }
 345
 346   if (MI->getOperand(opNum+1).isReg() &&
 347       MI->getOperand(opNum+1).getReg() == SP::G0)
 348     return;   // don't print "+%g0"
 349   if (MI->getOperand(opNum+1).isImm() &&
 350       MI->getOperand(opNum+1).getImm() == 0)
 351     return;   // don't print "+0"
 352
 353   O << "+";
 354   printOperand(MI, opNum+1, O);
 355 }
 356
 357 /// PrintAsmOperand - Print out an operand for an inline asm expression.
 358 ///
 359 bool SparcAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 360                                       unsigned AsmVariant,
 361                                       const char *ExtraCode,
 362                                       raw_ostream &O) {
 363   if (ExtraCode && ExtraCode[0]) {
 364     if (ExtraCode[1] != 0) return true; // Unknown modifier.
 365
 366     switch (ExtraCode[0]) {
 367     default:
 368       // See if this is a generic print operand
 369       return AsmPrinter::PrintAsmOperand(MI, OpNo, AsmVariant, ExtraCode, O);
 370     case 'r':
 371      break;
 372     }
 373   }
 374
 375   printOperand(MI, OpNo, O);
 376
 377   return false;
 378 }
 379
 380 bool SparcAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
 381                                             unsigned OpNo, unsigned AsmVariant,
 382                                             const char *ExtraCode,
 383                                             raw_ostream &O) {
 384   if (ExtraCode && ExtraCode[0])
 385     return true;  // Unknown modifier
 386
 387   O << '[';
 388   printMemOperand(MI, OpNo, O);
 389   O << ']';
 390
 391   return false;
 392 }
 393
 394 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
 395 /// exactly one predecessor and the control transfer mechanism between
 396 /// the predecessor and this block is a fall-through.
 397 ///
 398 /// This overrides AsmPrinter's implementation to handle delay slots.
 399 bool SparcAsmPrinter::
 400 isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const {
 401   // If this is a landing pad, it isn't a fall through.  If it has no preds,
 402   // then nothing falls through to it.
 403   if (MBB->isLandingPad() || MBB->pred_empty())
 404     return false;
 405
 406   // If there isn't exactly one predecessor, it can't be a fall through.
 407   MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(), PI2 = PI;
 408   ++PI2;
 409   if (PI2 != MBB->pred_end())
 410     return false;
 411
 412   // The predecessor has to be immediately before this block.
 413   const MachineBasicBlock *Pred = *PI;
 414
 415   if (!Pred->isLayoutSuccessor(MBB))
 416     return false;
 417
 418   // Check if the last terminator is an unconditional branch.
 419   MachineBasicBlock::const_iterator I = Pred->end();
 420   while (I != Pred->begin() && !(--I)->isTerminator())
 421     ; // Noop
 422   return I == Pred->end() || !I->isBarrier();
 423 }
 424
 425 // Force static initialization.
 426 extern "C" void LLVMInitializeSparcAsmPrinter() {
 427   RegisterAsmPrinter<SparcAsmPrinter> X(TheSparcTarget);
 428   RegisterAsmPrinter<SparcAsmPrinter> Y(TheSparcV9Target);
 429 }