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 #include "Sparc.h"
  16 #include "InstPrinter/SparcInstPrinter.h"
  17 #include "MCTargetDesc/SparcMCExpr.h"
  18 #include "SparcInstrInfo.h"
  19 #include "SparcTargetMachine.h"
  20 #include "SparcTargetStreamer.h"
  21 #include "llvm/ADT/SmallString.h"
  22 #include "llvm/CodeGen/AsmPrinter.h"
  23 #include "llvm/CodeGen/MachineInstr.h"
  24 #include "llvm/CodeGen/MachineModuleInfoImpls.h"
  25 #include "llvm/CodeGen/MachineRegisterInfo.h"
  26 #include "llvm/CodeGen/TargetLoweringObjectFileImpl.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 #define DEBUG_TYPE "asm-printer"
  38
  39 namespace {
  40   class SparcAsmPrinter : public AsmPrinter {
  41     SparcTargetStreamer &getTargetStreamer() {
  42       return static_cast<SparcTargetStreamer &>(
  43           *OutStreamer.getTargetStreamer());
  44     }
  45   public:
  46     explicit SparcAsmPrinter(TargetMachine &TM,
  47                              std::unique_ptr<MCStreamer> Streamer)
  48         : AsmPrinter(TM, std::move(Streamer)) {}
  49
  50     const char *getPassName() const override {
  51       return "Sparc Assembly Printer";
  52     }
  53
  54     void printOperand(const MachineInstr *MI, int opNum, raw_ostream &OS);
  55     void printMemOperand(const MachineInstr *MI, int opNum, raw_ostream &OS,
  56                          const char *Modifier = nullptr);
  57     void printCCOperand(const MachineInstr *MI, int opNum, raw_ostream &OS);
  58
  59     void EmitFunctionBodyStart() override;
  60     void EmitInstruction(const MachineInstr *MI) override;
  61     void EmitEndOfAsmFile(Module &M) override;
  62
  63     static const char *getRegisterName(unsigned RegNo) {
  64       return SparcInstPrinter::getRegisterName(RegNo);
  65     }
  66
  67     bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
  68                          unsigned AsmVariant, const char *ExtraCode,
  69                          raw_ostream &O) override;
  70     bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
  71                                unsigned AsmVariant, const char *ExtraCode,
  72                                raw_ostream &O) override;
  73
  74     void LowerGETPCXAndEmitMCInsts(const MachineInstr *MI,
  75                                    const MCSubtargetInfo &STI);
  76
  77   };
  78 } // end of anonymous namespace
  79
  80 static MCOperand createSparcMCOperand(SparcMCExpr::VariantKind Kind,
  81                                       MCSymbol *Sym, MCContext &OutContext) {
  82   const MCSymbolRefExpr *MCSym = MCSymbolRefExpr::Create(Sym,
  83                                                          OutContext);
  84   const SparcMCExpr *expr = SparcMCExpr::Create(Kind, MCSym, OutContext);
  85   return MCOperand::CreateExpr(expr);
  86
  87 }
  88 static MCOperand createPCXCallOP(MCSymbol *Label,
  89                                  MCContext &OutContext) {
  90   return createSparcMCOperand(SparcMCExpr::VK_Sparc_None, Label, OutContext);
  91 }
  92
  93 static MCOperand createPCXRelExprOp(SparcMCExpr::VariantKind Kind,
  94                                     MCSymbol *GOTLabel, MCSymbol *StartLabel,
  95                                     MCSymbol *CurLabel,
  96                                     MCContext &OutContext)
  97 {
  98   const MCSymbolRefExpr *GOT = MCSymbolRefExpr::Create(GOTLabel, OutContext);
  99   const MCSymbolRefExpr *Start = MCSymbolRefExpr::Create(StartLabel,
 100                                                          OutContext);
 101   const MCSymbolRefExpr *Cur = MCSymbolRefExpr::Create(CurLabel,
 102                                                        OutContext);
 103
 104   const MCBinaryExpr *Sub = MCBinaryExpr::CreateSub(Cur, Start, OutContext);
 105   const MCBinaryExpr *Add = MCBinaryExpr::CreateAdd(GOT, Sub, OutContext);
 106   const SparcMCExpr *expr = SparcMCExpr::Create(Kind,
 107                                                 Add, OutContext);
 108   return MCOperand::CreateExpr(expr);
 109 }
 110
 111 static void EmitCall(MCStreamer &OutStreamer,
 112                      MCOperand &Callee,
 113                      const MCSubtargetInfo &STI)
 114 {
 115   MCInst CallInst;
 116   CallInst.setOpcode(SP::CALL);
 117   CallInst.addOperand(Callee);
 118   OutStreamer.EmitInstruction(CallInst, STI);
 119 }
 120
 121 static void EmitSETHI(MCStreamer &OutStreamer,
 122                       MCOperand &Imm, MCOperand &RD,
 123                       const MCSubtargetInfo &STI)
 124 {
 125   MCInst SETHIInst;
 126   SETHIInst.setOpcode(SP::SETHIi);
 127   SETHIInst.addOperand(RD);
 128   SETHIInst.addOperand(Imm);
 129   OutStreamer.EmitInstruction(SETHIInst, STI);
 130 }
 131
 132 static void EmitBinary(MCStreamer &OutStreamer, unsigned Opcode,
 133                        MCOperand &RS1, MCOperand &Src2, MCOperand &RD,
 134                        const MCSubtargetInfo &STI)
 135 {
 136   MCInst Inst;
 137   Inst.setOpcode(Opcode);
 138   Inst.addOperand(RD);
 139   Inst.addOperand(RS1);
 140   Inst.addOperand(Src2);
 141   OutStreamer.EmitInstruction(Inst, STI);
 142 }
 143
 144 static void EmitOR(MCStreamer &OutStreamer,
 145                    MCOperand &RS1, MCOperand &Imm, MCOperand &RD,
 146                    const MCSubtargetInfo &STI) {
 147   EmitBinary(OutStreamer, SP::ORri, RS1, Imm, RD, STI);
 148 }
 149
 150 static void EmitADD(MCStreamer &OutStreamer,
 151                     MCOperand &RS1, MCOperand &RS2, MCOperand &RD,
 152                     const MCSubtargetInfo &STI) {
 153   EmitBinary(OutStreamer, SP::ADDrr, RS1, RS2, RD, STI);
 154 }
 155
 156 static void EmitSHL(MCStreamer &OutStreamer,
 157                     MCOperand &RS1, MCOperand &Imm, MCOperand &RD,
 158                     const MCSubtargetInfo &STI) {
 159   EmitBinary(OutStreamer, SP::SLLri, RS1, Imm, RD, STI);
 160 }
 161
 162
 163 static void EmitHiLo(MCStreamer &OutStreamer,  MCSymbol *GOTSym,
 164                      SparcMCExpr::VariantKind HiKind,
 165                      SparcMCExpr::VariantKind LoKind,
 166                      MCOperand &RD,
 167                      MCContext &OutContext,
 168                      const MCSubtargetInfo &STI) {
 169
 170   MCOperand hi = createSparcMCOperand(HiKind, GOTSym, OutContext);
 171   MCOperand lo = createSparcMCOperand(LoKind, GOTSym, OutContext);
 172   EmitSETHI(OutStreamer, hi, RD, STI);
 173   EmitOR(OutStreamer, RD, lo, RD, STI);
 174 }
 175
 176 void SparcAsmPrinter::LowerGETPCXAndEmitMCInsts(const MachineInstr *MI,
 177                                                 const MCSubtargetInfo &STI)
 178 {
 179   MCSymbol *GOTLabel   =
 180     OutContext.GetOrCreateSymbol(Twine("_GLOBAL_OFFSET_TABLE_"));
 181
 182   const MachineOperand &MO = MI->getOperand(0);
 183   assert(MO.getReg() != SP::O7 &&
 184          "%o7 is assigned as destination for getpcx!");
 185
 186   MCOperand MCRegOP = MCOperand::CreateReg(MO.getReg());
 187
 188
 189   if (TM.getRelocationModel() != Reloc::PIC_) {
 190     // Just load the address of GOT to MCRegOP.
 191     switch(TM.getCodeModel()) {
 192     default:
 193       llvm_unreachable("Unsupported absolute code model");
 194     case CodeModel::Small:
 195       EmitHiLo(OutStreamer, GOTLabel,
 196                SparcMCExpr::VK_Sparc_HI, SparcMCExpr::VK_Sparc_LO,
 197                MCRegOP, OutContext, STI);
 198       break;
 199     case CodeModel::Medium: {
 200       EmitHiLo(OutStreamer, GOTLabel,
 201                SparcMCExpr::VK_Sparc_H44, SparcMCExpr::VK_Sparc_M44,
 202                MCRegOP, OutContext, STI);
 203       MCOperand imm = MCOperand::CreateExpr(MCConstantExpr::Create(12,
 204                                                                    OutContext));
 205       EmitSHL(OutStreamer, MCRegOP, imm, MCRegOP, STI);
 206       MCOperand lo = createSparcMCOperand(SparcMCExpr::VK_Sparc_L44,
 207                                           GOTLabel, OutContext);
 208       EmitOR(OutStreamer, MCRegOP, lo, MCRegOP, STI);
 209       break;
 210     }
 211     case CodeModel::Large: {
 212       EmitHiLo(OutStreamer, GOTLabel,
 213                SparcMCExpr::VK_Sparc_HH, SparcMCExpr::VK_Sparc_HM,
 214                MCRegOP, OutContext, STI);
 215       MCOperand imm = MCOperand::CreateExpr(MCConstantExpr::Create(32,
 216                                                                    OutContext));
 217       EmitSHL(OutStreamer, MCRegOP, imm, MCRegOP, STI);
 218       // Use register %o7 to load the lower 32 bits.
 219       MCOperand RegO7 = MCOperand::CreateReg(SP::O7);
 220       EmitHiLo(OutStreamer, GOTLabel,
 221                SparcMCExpr::VK_Sparc_HI, SparcMCExpr::VK_Sparc_LO,
 222                RegO7, OutContext, STI);
 223       EmitADD(OutStreamer, MCRegOP, RegO7, MCRegOP, STI);
 224     }
 225     }
 226     return;
 227   }
 228
 229   MCSymbol *StartLabel = OutContext.CreateTempSymbol();
 230   MCSymbol *EndLabel   = OutContext.CreateTempSymbol();
 231   MCSymbol *SethiLabel = OutContext.CreateTempSymbol();
 232
 233   MCOperand RegO7   = MCOperand::CreateReg(SP::O7);
 234
 235   // <StartLabel>:
 236   //   call <EndLabel>
 237   // <SethiLabel>:
 238   //     sethi %hi(_GLOBAL_OFFSET_TABLE_+(<SethiLabel>-<StartLabel>)), <MO>
 239   // <EndLabel>:
 240   //   or  <MO>, %lo(_GLOBAL_OFFSET_TABLE_+(<EndLabel>-<StartLabel>))), <MO>
 241   //   add <MO>, %o7, <MO>
 242
 243   OutStreamer.EmitLabel(StartLabel);
 244   MCOperand Callee =  createPCXCallOP(EndLabel, OutContext);
 245   EmitCall(OutStreamer, Callee, STI);
 246   OutStreamer.EmitLabel(SethiLabel);
 247   MCOperand hiImm = createPCXRelExprOp(SparcMCExpr::VK_Sparc_PC22,
 248                                        GOTLabel, StartLabel, SethiLabel,
 249                                        OutContext);
 250   EmitSETHI(OutStreamer, hiImm, MCRegOP, STI);
 251   OutStreamer.EmitLabel(EndLabel);
 252   MCOperand loImm = createPCXRelExprOp(SparcMCExpr::VK_Sparc_PC10,
 253                                        GOTLabel, StartLabel, EndLabel,
 254                                        OutContext);
 255   EmitOR(OutStreamer, MCRegOP, loImm, MCRegOP, STI);
 256   EmitADD(OutStreamer, MCRegOP, RegO7, MCRegOP, STI);
 257 }
 258
 259 void SparcAsmPrinter::EmitInstruction(const MachineInstr *MI)
 260 {
 261
 262   switch (MI->getOpcode()) {
 263   default: break;
 264   case TargetOpcode::DBG_VALUE:
 265     // FIXME: Debug Value.
 266     return;
 267   case SP::GETPCX:
 268     LowerGETPCXAndEmitMCInsts(MI, getSubtargetInfo());
 269     return;
 270   }
 271   MachineBasicBlock::const_instr_iterator I = MI;
 272   MachineBasicBlock::const_instr_iterator E = MI->getParent()->instr_end();
 273   do {
 274     MCInst TmpInst;
 275     LowerSparcMachineInstrToMCInst(I, TmpInst, *this);
 276     EmitToStreamer(OutStreamer, TmpInst);
 277   } while ((++I != E) && I->isInsideBundle()); // Delay slot check.
 278 }
 279
 280 void SparcAsmPrinter::EmitFunctionBodyStart() {
 281   if (!TM.getSubtarget<SparcSubtarget>().is64Bit())
 282     return;
 283
 284   const MachineRegisterInfo &MRI = MF->getRegInfo();
 285   const unsigned globalRegs[] = { SP::G2, SP::G3, SP::G6, SP::G7, 0 };
 286   for (unsigned i = 0; globalRegs[i] != 0; ++i) {
 287     unsigned reg = globalRegs[i];
 288     if (MRI.use_empty(reg))
 289       continue;
 290
 291     if  (reg == SP::G6 || reg == SP::G7)
 292       getTargetStreamer().emitSparcRegisterIgnore(reg);
 293     else
 294       getTargetStreamer().emitSparcRegisterScratch(reg);
 295   }
 296 }
 297
 298 void SparcAsmPrinter::printOperand(const MachineInstr *MI, int opNum,
 299                                    raw_ostream &O) {
 300   const DataLayout *DL = TM.getDataLayout();
 301   const MachineOperand &MO = MI->getOperand (opNum);
 302   SparcMCExpr::VariantKind TF = (SparcMCExpr::VariantKind) MO.getTargetFlags();
 303
 304 #ifndef NDEBUG
 305   // Verify the target flags.
 306   if (MO.isGlobal() || MO.isSymbol() || MO.isCPI()) {
 307     if (MI->getOpcode() == SP::CALL)
 308       assert(TF == SparcMCExpr::VK_Sparc_None &&
 309              "Cannot handle target flags on call address");
 310     else if (MI->getOpcode() == SP::SETHIi || MI->getOpcode() == SP::SETHIXi)
 311       assert((TF == SparcMCExpr::VK_Sparc_HI
 312               || TF == SparcMCExpr::VK_Sparc_H44
 313               || TF == SparcMCExpr::VK_Sparc_HH
 314               || TF == SparcMCExpr::VK_Sparc_TLS_GD_HI22
 315               || TF == SparcMCExpr::VK_Sparc_TLS_LDM_HI22
 316               || TF == SparcMCExpr::VK_Sparc_TLS_LDO_HIX22
 317               || TF == SparcMCExpr::VK_Sparc_TLS_IE_HI22
 318               || TF == SparcMCExpr::VK_Sparc_TLS_LE_HIX22) &&
 319              "Invalid target flags for address operand on sethi");
 320     else if (MI->getOpcode() == SP::TLS_CALL)
 321       assert((TF == SparcMCExpr::VK_Sparc_None
 322               || TF == SparcMCExpr::VK_Sparc_TLS_GD_CALL
 323               || TF == SparcMCExpr::VK_Sparc_TLS_LDM_CALL) &&
 324              "Cannot handle target flags on tls call address");
 325     else if (MI->getOpcode() == SP::TLS_ADDrr)
 326       assert((TF == SparcMCExpr::VK_Sparc_TLS_GD_ADD
 327               || TF == SparcMCExpr::VK_Sparc_TLS_LDM_ADD
 328               || TF == SparcMCExpr::VK_Sparc_TLS_LDO_ADD
 329               || TF == SparcMCExpr::VK_Sparc_TLS_IE_ADD) &&
 330              "Cannot handle target flags on add for TLS");
 331     else if (MI->getOpcode() == SP::TLS_LDrr)
 332       assert(TF == SparcMCExpr::VK_Sparc_TLS_IE_LD &&
 333              "Cannot handle target flags on ld for TLS");
 334     else if (MI->getOpcode() == SP::TLS_LDXrr)
 335       assert(TF == SparcMCExpr::VK_Sparc_TLS_IE_LDX &&
 336              "Cannot handle target flags on ldx for TLS");
 337     else if (MI->getOpcode() == SP::XORri || MI->getOpcode() == SP::XORXri)
 338       assert((TF == SparcMCExpr::VK_Sparc_TLS_LDO_LOX10
 339               || TF == SparcMCExpr::VK_Sparc_TLS_LE_LOX10) &&
 340              "Cannot handle target flags on xor for TLS");
 341     else
 342       assert((TF == SparcMCExpr::VK_Sparc_LO
 343               || TF == SparcMCExpr::VK_Sparc_M44
 344               || TF == SparcMCExpr::VK_Sparc_L44
 345               || TF == SparcMCExpr::VK_Sparc_HM
 346               || TF == SparcMCExpr::VK_Sparc_TLS_GD_LO10
 347               || TF == SparcMCExpr::VK_Sparc_TLS_LDM_LO10
 348               || TF == SparcMCExpr::VK_Sparc_TLS_IE_LO10 ) &&
 349              "Invalid target flags for small address operand");
 350   }
 351 #endif
 352
 353
 354   bool CloseParen = SparcMCExpr::printVariantKind(O, TF);
 355
 356   switch (MO.getType()) {
 357   case MachineOperand::MO_Register:
 358     O << "%" << StringRef(getRegisterName(MO.getReg())).lower();
 359     break;
 360
 361   case MachineOperand::MO_Immediate:
 362     O << (int)MO.getImm();
 363     break;
 364   case MachineOperand::MO_MachineBasicBlock:
 365     O << *MO.getMBB()->getSymbol();
 366     return;
 367   case MachineOperand::MO_GlobalAddress:
 368     O << *getSymbol(MO.getGlobal());
 369     break;
 370   case MachineOperand::MO_BlockAddress:
 371     O <<  GetBlockAddressSymbol(MO.getBlockAddress())->getName();
 372     break;
 373   case MachineOperand::MO_ExternalSymbol:
 374     O << MO.getSymbolName();
 375     break;
 376   case MachineOperand::MO_ConstantPoolIndex:
 377     O << DL->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << "_"
 378       << MO.getIndex();
 379     break;
 380   default:
 381     llvm_unreachable("<unknown operand type>");
 382   }
 383   if (CloseParen) O << ")";
 384 }
 385
 386 void SparcAsmPrinter::printMemOperand(const MachineInstr *MI, int opNum,
 387                                       raw_ostream &O, const char *Modifier) {
 388   printOperand(MI, opNum, O);
 389
 390   // If this is an ADD operand, emit it like normal operands.
 391   if (Modifier && !strcmp(Modifier, "arith")) {
 392     O << ", ";
 393     printOperand(MI, opNum+1, O);
 394     return;
 395   }
 396
 397   if (MI->getOperand(opNum+1).isReg() &&
 398       MI->getOperand(opNum+1).getReg() == SP::G0)
 399     return;   // don't print "+%g0"
 400   if (MI->getOperand(opNum+1).isImm() &&
 401       MI->getOperand(opNum+1).getImm() == 0)
 402     return;   // don't print "+0"
 403
 404   O << "+";
 405   printOperand(MI, opNum+1, O);
 406 }
 407
 408 /// PrintAsmOperand - Print out an operand for an inline asm expression.
 409 ///
 410 bool SparcAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 411                                       unsigned AsmVariant,
 412                                       const char *ExtraCode,
 413                                       raw_ostream &O) {
 414   if (ExtraCode && ExtraCode[0]) {
 415     if (ExtraCode[1] != 0) return true; // Unknown modifier.
 416
 417     switch (ExtraCode[0]) {
 418     default:
 419       // See if this is a generic print operand
 420       return AsmPrinter::PrintAsmOperand(MI, OpNo, AsmVariant, ExtraCode, O);
 421     case 'r':
 422      break;
 423     }
 424   }
 425
 426   printOperand(MI, OpNo, O);
 427
 428   return false;
 429 }
 430
 431 bool SparcAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
 432                                             unsigned OpNo, unsigned AsmVariant,
 433                                             const char *ExtraCode,
 434                                             raw_ostream &O) {
 435   if (ExtraCode && ExtraCode[0])
 436     return true;  // Unknown modifier
 437
 438   O << '[';
 439   printMemOperand(MI, OpNo, O);
 440   O << ']';
 441
 442   return false;
 443 }
 444
 445 void SparcAsmPrinter::EmitEndOfAsmFile(Module &M) {
 446   const TargetLoweringObjectFileELF &TLOFELF =
 447     static_cast<const TargetLoweringObjectFileELF &>(getObjFileLowering());
 448   MachineModuleInfoELF &MMIELF = MMI->getObjFileInfo<MachineModuleInfoELF>();
 449
 450   // Generate stubs for global variables.
 451   MachineModuleInfoELF::SymbolListTy Stubs = MMIELF.GetGVStubList();
 452   if (!Stubs.empty()) {
 453     OutStreamer.SwitchSection(TLOFELF.getDataSection());
 454     unsigned PtrSize = TM.getDataLayout()->getPointerSize(0);
 455     for (unsigned i = 0, e = Stubs.size(); i != e; ++i) {
 456       OutStreamer.EmitLabel(Stubs[i].first);
 457       OutStreamer.EmitSymbolValue(Stubs[i].second.getPointer(), PtrSize);
 458     }
 459   }
 460 }
 461
 462 // Force static initialization.
 463 extern "C" void LLVMInitializeSparcAsmPrinter() {
 464   RegisterAsmPrinter<SparcAsmPrinter> X(TheSparcTarget);
 465   RegisterAsmPrinter<SparcAsmPrinter> Y(TheSparcV9Target);
 466 }