lib/Target/XCore/AsmPrinter/XCoreAsmPrinter.cpp

   1 //===-- XCoreAsmPrinter.cpp - XCore 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 the XAS-format XCore assembly language.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "asm-printer"
  16 #include "XCore.h"
  17 #include "XCoreInstrInfo.h"
  18 #include "XCoreSubtarget.h"
  19 #include "XCoreMCAsmInfo.h"
  20 #include "XCoreTargetMachine.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/DwarfWriter.h"
  26 #include "llvm/CodeGen/MachineModuleInfo.h"
  27 #include "llvm/CodeGen/MachineFunctionPass.h"
  28 #include "llvm/CodeGen/MachineConstantPool.h"
  29 #include "llvm/CodeGen/MachineInstr.h"
  30 #include "llvm/MC/MCStreamer.h"
  31 #include "llvm/MC/MCSymbol.h"
  32 #include "llvm/Target/TargetData.h"
  33 #include "llvm/Target/TargetLoweringObjectFile.h"
  34 #include "llvm/Target/TargetRegistry.h"
  35 #include "llvm/ADT/Statistic.h"
  36 #include "llvm/ADT/StringExtras.h"
  37 #include "llvm/Support/CommandLine.h"
  38 #include "llvm/Support/ErrorHandling.h"
  39 #include "llvm/Support/FormattedStream.h"
  40 #include "llvm/Support/MathExtras.h"
  41 #include <algorithm>
  42 #include <cctype>
  43 using namespace llvm;
  44
  45 STATISTIC(EmittedInsts, "Number of machine instrs printed");
  46
  47 static cl::opt<unsigned> MaxThreads("xcore-max-threads", cl::Optional,
  48   cl::desc("Maximum number of threads (for emulation thread-local storage)"),
  49   cl::Hidden,
  50   cl::value_desc("number"),
  51   cl::init(8));
  52
  53 namespace {
  54   class XCoreAsmPrinter : public AsmPrinter {
  55     const XCoreSubtarget &Subtarget;
  56   public:
  57     explicit XCoreAsmPrinter(formatted_raw_ostream &O, TargetMachine &TM,
  58                              const MCAsmInfo *T, bool V)
  59       : AsmPrinter(O, TM, T, V),
  60       Subtarget(TM.getSubtarget<XCoreSubtarget>()) {}
  61
  62     virtual const char *getPassName() const {
  63       return "XCore Assembly Printer";
  64     }
  65
  66     void printMemOperand(const MachineInstr *MI, int opNum);
  67     void printOperand(const MachineInstr *MI, int opNum);
  68     bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
  69                         unsigned AsmVariant, const char *ExtraCode);
  70
  71     void emitGlobalDirective(const MCSymbol *Sym);
  72
  73     void emitArrayBound(const MCSymbol *Sym, const GlobalVariable *GV);
  74     virtual void EmitGlobalVariable(const GlobalVariable *GV);
  75
  76     void emitFunctionStart(MachineFunction &MF);
  77     void emitFunctionEnd(MachineFunction &MF);
  78
  79     void printInstruction(const MachineInstr *MI);  // autogenerated.
  80     static const char *getRegisterName(unsigned RegNo);
  81
  82     void printMachineInstruction(const MachineInstr *MI);
  83     bool runOnMachineFunction(MachineFunction &F);
  84
  85     void getAnalysisUsage(AnalysisUsage &AU) const {
  86       AsmPrinter::getAnalysisUsage(AU);
  87       AU.setPreservesAll();
  88       AU.addRequired<MachineModuleInfo>();
  89       AU.addRequired<DwarfWriter>();
  90     }
  91   };
  92 } // end of anonymous namespace
  93
  94 #include "XCoreGenAsmWriter.inc"
  95
  96 void XCoreAsmPrinter::emitGlobalDirective(const MCSymbol *Sym) {
  97   O << MAI->getGlobalDirective() << *Sym << "\n";
  98 }
  99
 100 void XCoreAsmPrinter::emitArrayBound(const MCSymbol *Sym,
 101                                      const GlobalVariable *GV) {
 102   assert(((GV->hasExternalLinkage() ||
 103     GV->hasWeakLinkage()) ||
 104     GV->hasLinkOnceLinkage()) && "Unexpected linkage");
 105   if (const ArrayType *ATy = dyn_cast<ArrayType>(
 106     cast<PointerType>(GV->getType())->getElementType())) {
 107     O << MAI->getGlobalDirective() << *Sym;
 108     O << ".globound" << "\n";
 109     O << "\t.set\t" << *Sym;
 110     O << ".globound" << "," << ATy->getNumElements() << "\n";
 111     if (GV->hasWeakLinkage() || GV->hasLinkOnceLinkage()) {
 112       // TODO Use COMDAT groups for LinkOnceLinkage
 113       O << MAI->getWeakDefDirective() << *Sym << ".globound" << "\n";
 114     }
 115   }
 116 }
 117
 118 void XCoreAsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
 119   // Check to see if this is a special global used by LLVM, if so, emit it.
 120   if (!GV->hasInitializer() ||
 121       EmitSpecialLLVMGlobal(GV))
 122     return;
 123
 124   const TargetData *TD = TM.getTargetData();
 125   OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(GV, Mang,TM));
 126
 127
 128   MCSymbol *GVSym = GetGlobalValueSymbol(GV);
 129   Constant *C = GV->getInitializer();
 130   unsigned Align = (unsigned)TD->getPreferredTypeAlignmentShift(C->getType());
 131
 132   // Mark the start of the global
 133   O << "\t.cc_top " << *GVSym << ".data," << *GVSym << "\n";
 134
 135   switch (GV->getLinkage()) {
 136   case GlobalValue::AppendingLinkage:
 137     llvm_report_error("AppendingLinkage is not supported by this target!");
 138   case GlobalValue::LinkOnceAnyLinkage:
 139   case GlobalValue::LinkOnceODRLinkage:
 140   case GlobalValue::WeakAnyLinkage:
 141   case GlobalValue::WeakODRLinkage:
 142   case GlobalValue::ExternalLinkage:
 143     emitArrayBound(GVSym, GV);
 144     emitGlobalDirective(GVSym);
 145     // TODO Use COMDAT groups for LinkOnceLinkage
 146     if (GV->hasWeakLinkage() || GV->hasLinkOnceLinkage())
 147       O << MAI->getWeakDefDirective() << *GVSym << "\n";
 148     // FALL THROUGH
 149   case GlobalValue::InternalLinkage:
 150   case GlobalValue::PrivateLinkage:
 151   case GlobalValue::LinkerPrivateLinkage:
 152     break;
 153   case GlobalValue::GhostLinkage:
 154     llvm_unreachable("Should not have any unmaterialized functions!");
 155   case GlobalValue::DLLImportLinkage:
 156     llvm_unreachable("DLLImport linkage is not supported by this target!");
 157   case GlobalValue::DLLExportLinkage:
 158     llvm_unreachable("DLLExport linkage is not supported by this target!");
 159   default:
 160     llvm_unreachable("Unknown linkage type!");
 161   }
 162
 163   EmitAlignment(Align, GV, 2);
 164
 165   unsigned Size = TD->getTypeAllocSize(C->getType());
 166   if (GV->isThreadLocal()) {
 167     Size *= MaxThreads;
 168   }
 169   if (MAI->hasDotTypeDotSizeDirective()) {
 170     O << "\t.type " << *GVSym << ",@object\n";
 171     O << "\t.size " << *GVSym << "," << Size << "\n";
 172   }
 173   O << *GVSym << ":\n";
 174
 175   EmitGlobalConstant(C);
 176   if (GV->isThreadLocal()) {
 177     for (unsigned i = 1; i < MaxThreads; ++i)
 178       EmitGlobalConstant(C);
 179   }
 180   // The ABI requires that unsigned scalar types smaller than 32 bits
 181   // are padded to 32 bits.
 182   if (Size < 4)
 183     OutStreamer.EmitZeros(4 - Size, 0);
 184
 185   // Mark the end of the global
 186   O << "\t.cc_bottom " << *GVSym << ".data\n";
 187 }
 188
 189 /// Emit the directives on the start of functions
 190 void XCoreAsmPrinter::emitFunctionStart(MachineFunction &MF) {
 191   // Print out the label for the function.
 192   const Function *F = MF.getFunction();
 193
 194   OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang, TM));
 195
 196   // Mark the start of the function
 197   O << "\t.cc_top " << *CurrentFnSym << ".function," << *CurrentFnSym << "\n";
 198
 199   switch (F->getLinkage()) {
 200   default: llvm_unreachable("Unknown linkage type!");
 201   case Function::InternalLinkage:  // Symbols default to internal.
 202   case Function::PrivateLinkage:
 203   case Function::LinkerPrivateLinkage:
 204     break;
 205   case Function::ExternalLinkage:
 206     emitGlobalDirective(CurrentFnSym);
 207     break;
 208   case Function::LinkOnceAnyLinkage:
 209   case Function::LinkOnceODRLinkage:
 210   case Function::WeakAnyLinkage:
 211   case Function::WeakODRLinkage:
 212     // TODO Use COMDAT groups for LinkOnceLinkage
 213     O << MAI->getGlobalDirective() << *CurrentFnSym << "\n";
 214     O << MAI->getWeakDefDirective() << *CurrentFnSym << "\n";
 215     break;
 216   }
 217   // (1 << 1) byte aligned
 218   EmitAlignment(MF.getAlignment(), F, 1);
 219   if (MAI->hasDotTypeDotSizeDirective())
 220     O << "\t.type " << *CurrentFnSym << ",@function\n";
 221
 222   O << *CurrentFnSym << ":\n";
 223 }
 224
 225 /// Emit the directives on the end of functions
 226 void XCoreAsmPrinter::emitFunctionEnd(MachineFunction &MF) {
 227   // Mark the end of the function
 228   O << "\t.cc_bottom " << *CurrentFnSym << ".function\n";
 229 }
 230
 231 /// runOnMachineFunction - This uses the printMachineInstruction()
 232 /// method to print assembly for each instruction.
 233 ///
 234 bool XCoreAsmPrinter::runOnMachineFunction(MachineFunction &MF) {
 235   SetupMachineFunction(MF);
 236
 237   // Print out constants referenced by the function
 238   EmitConstantPool(MF.getConstantPool());
 239
 240   // Emit the function start directives
 241   emitFunctionStart(MF);
 242
 243   // Emit pre-function debug information.
 244   DW->BeginFunction(&MF);
 245
 246   // Print out code for the function.
 247   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 248        I != E; ++I) {
 249
 250     // Print a label for the basic block.
 251     if (I != MF.begin()) {
 252       EmitBasicBlockStart(I);
 253     }
 254
 255     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
 256          II != E; ++II) {
 257       // Print the assembly for the instruction.
 258       printMachineInstruction(II);
 259     }
 260
 261     // Each Basic Block is separated by a newline
 262     O << '\n';
 263   }
 264
 265   // Emit function end directives
 266   emitFunctionEnd(MF);
 267
 268   // Print out jump tables referenced by the function
 269   EmitJumpTableInfo(MF);
 270
 271   // Emit post-function debug information.
 272   DW->EndFunction(&MF);
 273
 274   // We didn't modify anything.
 275   return false;
 276 }
 277
 278 void XCoreAsmPrinter::printMemOperand(const MachineInstr *MI, int opNum)
 279 {
 280   printOperand(MI, opNum);
 281
 282   if (MI->getOperand(opNum+1).isImm()
 283     && MI->getOperand(opNum+1).getImm() == 0)
 284     return;
 285
 286   O << "+";
 287   printOperand(MI, opNum+1);
 288 }
 289
 290 void XCoreAsmPrinter::printOperand(const MachineInstr *MI, int opNum) {
 291   const MachineOperand &MO = MI->getOperand(opNum);
 292   switch (MO.getType()) {
 293   case MachineOperand::MO_Register:
 294     O << getRegisterName(MO.getReg());
 295     break;
 296   case MachineOperand::MO_Immediate:
 297     O << MO.getImm();
 298     break;
 299   case MachineOperand::MO_MachineBasicBlock:
 300     O << *MO.getMBB()->getSymbol(OutContext);
 301     break;
 302   case MachineOperand::MO_GlobalAddress:
 303     O << *GetGlobalValueSymbol(MO.getGlobal());
 304     break;
 305   case MachineOperand::MO_ExternalSymbol:
 306     O << MO.getSymbolName();
 307     break;
 308   case MachineOperand::MO_ConstantPoolIndex:
 309     O << MAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber()
 310       << '_' << MO.getIndex();
 311     break;
 312   case MachineOperand::MO_JumpTableIndex:
 313     O << MAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
 314       << '_' << MO.getIndex();
 315     break;
 316   case MachineOperand::MO_BlockAddress:
 317     O << *GetBlockAddressSymbol(MO.getBlockAddress());
 318     break;
 319   default:
 320     llvm_unreachable("not implemented");
 321   }
 322 }
 323
 324 /// PrintAsmOperand - Print out an operand for an inline asm expression.
 325 ///
 326 bool XCoreAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 327                                       unsigned AsmVariant,
 328                                       const char *ExtraCode) {
 329   printOperand(MI, OpNo);
 330   return false;
 331 }
 332
 333 void XCoreAsmPrinter::printMachineInstruction(const MachineInstr *MI) {
 334   ++EmittedInsts;
 335
 336   processDebugLoc(MI, true);
 337
 338   // Check for mov mnemonic
 339   unsigned src, dst, srcSR, dstSR;
 340   if (TM.getInstrInfo()->isMoveInstr(*MI, src, dst, srcSR, dstSR)) {
 341     O << "\tmov " << getRegisterName(dst) << ", ";
 342     O << getRegisterName(src) << '\n';
 343     return;
 344   }
 345   printInstruction(MI);
 346   if (VerboseAsm)
 347     EmitComments(*MI);
 348   O << '\n';
 349
 350   processDebugLoc(MI, false);
 351 }
 352
 353 // Force static initialization.
 354 extern "C" void LLVMInitializeXCoreAsmPrinter() {
 355   RegisterAsmPrinter<XCoreAsmPrinter> X(TheXCoreTarget);
 356 }