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 "SparcInstrInfo.h"
  18 #include "llvm/Constants.h"
  19 #include "llvm/DerivedTypes.h"
  20 #include "llvm/Module.h"
  21 #include "llvm/CodeGen/AsmPrinter.h"
  22 #include "llvm/CodeGen/MachineFunctionPass.h"
  23 #include "llvm/CodeGen/MachineConstantPool.h"
  24 #include "llvm/CodeGen/MachineInstr.h"
  25 #include "llvm/Target/TargetAsmInfo.h"
  26 #include "llvm/Target/TargetData.h"
  27 #include "llvm/Target/TargetMachine.h"
  28 #include "llvm/Support/Mangler.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include "llvm/ADT/Statistic.h"
  31 #include "llvm/ADT/StringExtras.h"
  32 #include "llvm/Support/CommandLine.h"
  33 #include "llvm/Support/MathExtras.h"
  34 #include <cctype>
  35 #include <cstring>
  36 #include <map>
  37 using namespace llvm;
  38
  39 STATISTIC(EmittedInsts, "Number of machine instrs printed");
  40
  41 namespace {
  42   struct VISIBILITY_HIDDEN SparcAsmPrinter : public AsmPrinter {
  43     SparcAsmPrinter(raw_ostream &O, TargetMachine &TM, const TargetAsmInfo *T)
  44       : AsmPrinter(O, TM, T) {
  45     }
  46
  47     /// We name each basic block in a Function with a unique number, so
  48     /// that we can consistently refer to them later. This is cleared
  49     /// at the beginning of each call to runOnMachineFunction().
  50     ///
  51     typedef std::map<const Value *, unsigned> ValueMapTy;
  52     ValueMapTy NumberForBB;
  53
  54     virtual const char *getPassName() const {
  55       return "Sparc Assembly Printer";
  56     }
  57
  58     void printModuleLevelGV(const GlobalVariable* GVar);
  59     void printOperand(const MachineInstr *MI, int opNum);
  60     void printMemOperand(const MachineInstr *MI, int opNum,
  61                          const char *Modifier = 0);
  62     void printCCOperand(const MachineInstr *MI, int opNum);
  63
  64     bool printInstruction(const MachineInstr *MI);  // autogenerated.
  65     bool runOnMachineFunction(MachineFunction &F);
  66     bool doInitialization(Module &M);
  67     bool doFinalization(Module &M);
  68     bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
  69                        unsigned AsmVariant, const char *ExtraCode);
  70     bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
  71                              unsigned AsmVariant, const char *ExtraCode);
  72   };
  73 } // end of anonymous namespace
  74
  75 #include "SparcGenAsmWriter.inc"
  76
  77 /// createSparcCodePrinterPass - Returns a pass that prints the SPARC
  78 /// assembly code for a MachineFunction to the given output stream,
  79 /// using the given target machine description.  This should work
  80 /// regardless of whether the function is in SSA form.
  81 ///
  82 FunctionPass *llvm::createSparcCodePrinterPass(raw_ostream &o,
  83                                                TargetMachine &tm) {
  84   return new SparcAsmPrinter(o, tm, tm.getTargetAsmInfo());
  85 }
  86
  87 /// runOnMachineFunction - This uses the printInstruction()
  88 /// method to print assembly for each instruction.
  89 ///
  90 bool SparcAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
  91   SetupMachineFunction(MF);
  92
  93   // Print out constants referenced by the function
  94   EmitConstantPool(MF.getConstantPool());
  95
  96   // BBNumber is used here so that a given Printer will never give two
  97   // BBs the same name. (If you have a better way, please let me know!)
  98   static unsigned BBNumber = 0;
  99
 100   O << "\n\n";
 101   // What's my mangled name?
 102   CurrentFnName = Mang->getValueName(MF.getFunction());
 103
 104   // Print out the label for the function.
 105   const Function *F = MF.getFunction();
 106   SwitchToSection(TAI->SectionForGlobal(F));
 107   EmitAlignment(4, F);
 108   O << "\t.globl\t" << CurrentFnName << '\n';
 109
 110   printVisibility(CurrentFnName, F->getVisibility());
 111
 112   O << "\t.type\t" << CurrentFnName << ", #function\n";
 113   O << CurrentFnName << ":\n";
 114
 115   // Number each basic block so that we can consistently refer to them
 116   // in PC-relative references.
 117   // FIXME: Why not use the MBB numbers?
 118   NumberForBB.clear();
 119   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 120        I != E; ++I) {
 121     NumberForBB[I->getBasicBlock()] = BBNumber++;
 122   }
 123
 124   // Print out code for the function.
 125   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 126        I != E; ++I) {
 127     // Print a label for the basic block.
 128     if (I != MF.begin()) {
 129       printBasicBlockLabel(I, true, true);
 130       O << '\n';
 131     }
 132     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
 133          II != E; ++II) {
 134       // Print the assembly for the instruction.
 135       printInstruction(II);
 136       ++EmittedInsts;
 137     }
 138   }
 139
 140   // We didn't modify anything.
 141   return false;
 142 }
 143
 144 void SparcAsmPrinter::printOperand(const MachineInstr *MI, int opNum) {
 145   const MachineOperand &MO = MI->getOperand (opNum);
 146   const TargetRegisterInfo &RI = *TM.getRegisterInfo();
 147   bool CloseParen = false;
 148   if (MI->getOpcode() == SP::SETHIi && !MO.isReg() && !MO.isImm()) {
 149     O << "%hi(";
 150     CloseParen = true;
 151   } else if ((MI->getOpcode() == SP::ORri || MI->getOpcode() == SP::ADDri) &&
 152              !MO.isReg() && !MO.isImm()) {
 153     O << "%lo(";
 154     CloseParen = true;
 155   }
 156   switch (MO.getType()) {
 157   case MachineOperand::MO_Register:
 158     if (TargetRegisterInfo::isPhysicalRegister(MO.getReg()))
 159       O << "%" << LowercaseString (RI.get(MO.getReg()).AsmName);
 160     else
 161       O << "%reg" << MO.getReg();
 162     break;
 163
 164   case MachineOperand::MO_Immediate:
 165     O << (int)MO.getImm();
 166     break;
 167   case MachineOperand::MO_MachineBasicBlock:
 168     printBasicBlockLabel(MO.getMBB());
 169     return;
 170   case MachineOperand::MO_GlobalAddress:
 171     O << Mang->getValueName(MO.getGlobal());
 172     break;
 173   case MachineOperand::MO_ExternalSymbol:
 174     O << MO.getSymbolName();
 175     break;
 176   case MachineOperand::MO_ConstantPoolIndex:
 177     O << TAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << "_"
 178       << MO.getIndex();
 179     break;
 180   default:
 181     O << "<unknown operand type>"; abort (); break;
 182   }
 183   if (CloseParen) O << ")";
 184 }
 185
 186 void SparcAsmPrinter::printMemOperand(const MachineInstr *MI, int opNum,
 187                                       const char *Modifier) {
 188   printOperand(MI, opNum);
 189
 190   // If this is an ADD operand, emit it like normal operands.
 191   if (Modifier && !strcmp(Modifier, "arith")) {
 192     O << ", ";
 193     printOperand(MI, opNum+1);
 194     return;
 195   }
 196
 197   if (MI->getOperand(opNum+1).isReg() &&
 198       MI->getOperand(opNum+1).getReg() == SP::G0)
 199     return;   // don't print "+%g0"
 200   if (MI->getOperand(opNum+1).isImm() &&
 201       MI->getOperand(opNum+1).getImm() == 0)
 202     return;   // don't print "+0"
 203
 204   O << "+";
 205   if (MI->getOperand(opNum+1).isGlobal() ||
 206       MI->getOperand(opNum+1).isCPI()) {
 207     O << "%lo(";
 208     printOperand(MI, opNum+1);
 209     O << ")";
 210   } else {
 211     printOperand(MI, opNum+1);
 212   }
 213 }
 214
 215 void SparcAsmPrinter::printCCOperand(const MachineInstr *MI, int opNum) {
 216   int CC = (int)MI->getOperand(opNum).getImm();
 217   O << SPARCCondCodeToString((SPCC::CondCodes)CC);
 218 }
 219
 220 bool SparcAsmPrinter::doInitialization(Module &M) {
 221   Mang = new Mangler(M);
 222   return false; // success
 223 }
 224
 225 bool SparcAsmPrinter::doFinalization(Module &M) {
 226   // Print out module-level global variables here.
 227   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 228        I != E; ++I)
 229     printModuleLevelGV(I);
 230
 231   O << '\n';
 232
 233   return AsmPrinter::doFinalization(M);
 234 }
 235
 236 void SparcAsmPrinter::printModuleLevelGV(const GlobalVariable* GVar) {
 237   const TargetData *TD = TM.getTargetData();
 238
 239   if (!GVar->hasInitializer())
 240     return;  // External global require no code
 241
 242   // Check to see if this is a special global used by LLVM, if so, emit it.
 243   if (EmitSpecialLLVMGlobal(GVar))
 244     return;
 245
 246   O << "\n\n";
 247   std::string name = Mang->getValueName(GVar);
 248   Constant *C = GVar->getInitializer();
 249   unsigned Size = TD->getABITypeSize(C->getType());
 250   unsigned Align = TD->getPreferredAlignment(GVar);
 251
 252   printVisibility(name, GVar->getVisibility());
 253
 254   SwitchToSection(TAI->SectionForGlobal(GVar));
 255
 256   if (C->isNullValue() && !GVar->hasSection()) {
 257     if (!GVar->isThreadLocal() &&
 258         (GVar->hasInternalLinkage() || GVar->mayBeOverridden())) {
 259       if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
 260
 261       if (GVar->hasInternalLinkage())
 262         O << "\t.local " << name << '\n';
 263
 264       O << TAI->getCOMMDirective() << name << ',' << Size;
 265       if (TAI->getCOMMDirectiveTakesAlignment())
 266         O << ',' << (1 << Align);
 267
 268       O << '\n';
 269       return;
 270     }
 271   }
 272
 273   switch (GVar->getLinkage()) {
 274    case GlobalValue::CommonLinkage:
 275    case GlobalValue::LinkOnceLinkage:
 276    case GlobalValue::WeakLinkage:   // FIXME: Verify correct for weak.
 277     // Nonnull linkonce -> weak
 278     O << "\t.weak " << name << '\n';
 279     break;
 280    case GlobalValue::AppendingLinkage:
 281     // FIXME: appending linkage variables should go into a section of
 282     // their name or something.  For now, just emit them as external.
 283    case GlobalValue::ExternalLinkage:
 284     // If external or appending, declare as a global symbol
 285     O << TAI->getGlobalDirective() << name << '\n';
 286     // FALL THROUGH
 287    case GlobalValue::InternalLinkage:
 288     break;
 289    case GlobalValue::GhostLinkage:
 290     cerr << "Should not have any unmaterialized functions!\n";
 291     abort();
 292    case GlobalValue::DLLImportLinkage:
 293     cerr << "DLLImport linkage is not supported by this target!\n";
 294     abort();
 295    case GlobalValue::DLLExportLinkage:
 296     cerr << "DLLExport linkage is not supported by this target!\n";
 297     abort();
 298    default:
 299     assert(0 && "Unknown linkage type!");
 300   }
 301
 302   EmitAlignment(Align, GVar);
 303
 304   if (TAI->hasDotTypeDotSizeDirective()) {
 305     O << "\t.type " << name << ",#object\n";
 306     O << "\t.size " << name << ',' << Size << '\n';
 307   }
 308
 309   O << name << ":\n";
 310   EmitGlobalConstant(C);
 311 }
 312
 313 /// PrintAsmOperand - Print out an operand for an inline asm expression.
 314 ///
 315 bool SparcAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 316                                       unsigned AsmVariant,
 317                                       const char *ExtraCode) {
 318   if (ExtraCode && ExtraCode[0])
 319     return true;  // Unknown modifier
 320
 321   printOperand(MI, OpNo);
 322
 323   return false;
 324 }
 325
 326 bool SparcAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
 327                                             unsigned OpNo,
 328                                             unsigned AsmVariant,
 329                                             const char *ExtraCode) {
 330   if (ExtraCode && ExtraCode[0])
 331     return true;  // Unknown modifier
 332
 333   O << '[';
 334   printMemOperand(MI, OpNo);
 335   O << ']';
 336
 337   return false;
 338 }