lib/Target/XCore/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 "XCoreTargetMachine.h"
  20 #include "llvm/Constants.h"
  21 #include "llvm/DerivedTypes.h"
  22 #include "llvm/Module.h"
  23 #include "llvm/CodeGen/AsmPrinter.h"
  24 #include "llvm/CodeGen/DwarfWriter.h"
  25 #include "llvm/CodeGen/MachineModuleInfo.h"
  26 #include "llvm/CodeGen/MachineFunctionPass.h"
  27 #include "llvm/CodeGen/MachineConstantPool.h"
  28 #include "llvm/CodeGen/MachineInstr.h"
  29 #include "llvm/Target/TargetAsmInfo.h"
  30 #include "llvm/Target/TargetData.h"
  31 #include "llvm/Support/Mangler.h"
  32 #include "llvm/ADT/Statistic.h"
  33 #include "llvm/ADT/StringExtras.h"
  34 #include "llvm/Support/CommandLine.h"
  35 #include "llvm/Support/ErrorHandling.h"
  36 #include "llvm/Support/FormattedStream.h"
  37 #include "llvm/Support/MathExtras.h"
  38 #include <algorithm>
  39 #include <cctype>
  40 using namespace llvm;
  41
  42 STATISTIC(EmittedInsts, "Number of machine instrs printed");
  43
  44 static cl::opt<std::string> FileDirective("xcore-file-directive", cl::Optional,
  45   cl::desc("Output a file directive into the assembly file"),
  46   cl::Hidden,
  47   cl::value_desc("filename"),
  48   cl::init(""));
  49
  50 static cl::opt<unsigned> MaxThreads("xcore-max-threads", cl::Optional,
  51   cl::desc("Maximum number of threads (for emulation thread-local storage)"),
  52   cl::Hidden,
  53   cl::value_desc("number"),
  54   cl::init(8));
  55
  56 namespace {
  57   class VISIBILITY_HIDDEN XCoreAsmPrinter : public AsmPrinter {
  58     DwarfWriter *DW;
  59     const XCoreSubtarget &Subtarget;
  60   public:
  61     explicit XCoreAsmPrinter(formatted_raw_ostream &O, XCoreTargetMachine &TM,
  62                              const TargetAsmInfo *T, bool V)
  63       : AsmPrinter(O, TM, T, V), DW(0),
  64         Subtarget(*TM.getSubtargetImpl()) {}
  65
  66     virtual const char *getPassName() const {
  67       return "XCore Assembly Printer";
  68     }
  69
  70     void printMemOperand(const MachineInstr *MI, int opNum);
  71     void printOperand(const MachineInstr *MI, int opNum);
  72     bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
  73                         unsigned AsmVariant, const char *ExtraCode);
  74
  75     void emitFileDirective(const std::string &filename);
  76     void emitGlobalDirective(const std::string &name);
  77     void emitExternDirective(const std::string &name);
  78
  79     void emitArrayBound(const std::string &name, const GlobalVariable *GV);
  80     void emitGlobal(const GlobalVariable *GV);
  81
  82     void emitFunctionStart(MachineFunction &MF);
  83     void emitFunctionEnd(MachineFunction &MF);
  84
  85     bool printInstruction(const MachineInstr *MI);  // autogenerated.
  86     void printMachineInstruction(const MachineInstr *MI);
  87     bool runOnMachineFunction(MachineFunction &F);
  88     bool doInitialization(Module &M);
  89     bool doFinalization(Module &M);
  90
  91     void getAnalysisUsage(AnalysisUsage &AU) const {
  92       AsmPrinter::getAnalysisUsage(AU);
  93       AU.setPreservesAll();
  94       AU.addRequired<MachineModuleInfo>();
  95       AU.addRequired<DwarfWriter>();
  96     }
  97   };
  98 } // end of anonymous namespace
  99
 100 #include "XCoreGenAsmWriter.inc"
 101
 102 /// createXCoreCodePrinterPass - Returns a pass that prints the XCore
 103 /// assembly code for a MachineFunction to the given output stream,
 104 /// using the given target machine description.  This should work
 105 /// regardless of whether the function is in SSA form.
 106 ///
 107 FunctionPass *llvm::createXCoreCodePrinterPass(formatted_raw_ostream &o,
 108                                                XCoreTargetMachine &tm,
 109                                                bool verbose) {
 110   return new XCoreAsmPrinter(o, tm, tm.getTargetAsmInfo(), verbose);
 111 }
 112
 113 // PrintEscapedString - Print each character of the specified string, escaping
 114 // it if it is not printable or if it is an escape char.
 115 static void PrintEscapedString(const std::string &Str,
 116                                formatted_raw_ostream &Out) {
 117   for (unsigned i = 0, e = Str.size(); i != e; ++i) {
 118     unsigned char C = Str[i];
 119     if (isprint(C) && C != '"' && C != '\\') {
 120       Out << C;
 121     } else {
 122       Out << '\\'
 123           << (char) ((C/16  < 10) ? ( C/16 +'0') : ( C/16 -10+'A'))
 124           << (char)(((C&15) < 10) ? ((C&15)+'0') : ((C&15)-10+'A'));
 125     }
 126   }
 127 }
 128
 129 void XCoreAsmPrinter::
 130 emitFileDirective(const std::string &name)
 131 {
 132   O << "\t.file\t\"";
 133   PrintEscapedString(name, O);
 134   O << "\"\n";
 135 }
 136
 137 void XCoreAsmPrinter::
 138 emitGlobalDirective(const std::string &name)
 139 {
 140   O << TAI->getGlobalDirective() << name;
 141   O << "\n";
 142 }
 143
 144 void XCoreAsmPrinter::
 145 emitExternDirective(const std::string &name)
 146 {
 147   O << "\t.extern\t" << name;
 148   O << '\n';
 149 }
 150
 151 void XCoreAsmPrinter::
 152 emitArrayBound(const std::string &name, const GlobalVariable *GV)
 153 {
 154   assert(((GV->hasExternalLinkage() ||
 155     GV->hasWeakLinkage()) ||
 156     GV->hasLinkOnceLinkage()) && "Unexpected linkage");
 157   if (const ArrayType *ATy = dyn_cast<ArrayType>(
 158     cast<PointerType>(GV->getType())->getElementType()))
 159   {
 160     O << TAI->getGlobalDirective() << name << ".globound" << "\n";
 161     O << TAI->getSetDirective() << name << ".globound" << ","
 162       << ATy->getNumElements() << "\n";
 163     if (GV->hasWeakLinkage() || GV->hasLinkOnceLinkage()) {
 164       // TODO Use COMDAT groups for LinkOnceLinkage
 165       O << TAI->getWeakDefDirective() << name << ".globound" << "\n";
 166     }
 167   }
 168 }
 169
 170 void XCoreAsmPrinter::
 171 emitGlobal(const GlobalVariable *GV)
 172 {
 173   const TargetData *TD = TM.getTargetData();
 174
 175   if (GV->hasInitializer()) {
 176     // Check to see if this is a special global used by LLVM, if so, emit it.
 177     if (EmitSpecialLLVMGlobal(GV))
 178       return;
 179
 180     SwitchToSection(TAI->SectionForGlobal(GV));
 181
 182     std::string name = Mang->getMangledName(GV);
 183     Constant *C = GV->getInitializer();
 184     unsigned Align = (unsigned)TD->getPreferredTypeAlignmentShift(C->getType());
 185
 186     // Mark the start of the global
 187     O << "\t.cc_top " << name << ".data," << name << "\n";
 188
 189     switch (GV->getLinkage()) {
 190     case GlobalValue::AppendingLinkage:
 191       llvm_report_error("AppendingLinkage is not supported by this target!");
 192     case GlobalValue::LinkOnceAnyLinkage:
 193     case GlobalValue::LinkOnceODRLinkage:
 194     case GlobalValue::WeakAnyLinkage:
 195     case GlobalValue::WeakODRLinkage:
 196     case GlobalValue::ExternalLinkage:
 197       emitArrayBound(name, GV);
 198       emitGlobalDirective(name);
 199       // TODO Use COMDAT groups for LinkOnceLinkage
 200       if (GV->hasWeakLinkage() || GV->hasLinkOnceLinkage()) {
 201         O << TAI->getWeakDefDirective() << name << "\n";
 202       }
 203       // FALL THROUGH
 204     case GlobalValue::InternalLinkage:
 205     case GlobalValue::PrivateLinkage:
 206       break;
 207     case GlobalValue::GhostLinkage:
 208       llvm_unreachable("Should not have any unmaterialized functions!");
 209     case GlobalValue::DLLImportLinkage:
 210       llvm_unreachable("DLLImport linkage is not supported by this target!");
 211     case GlobalValue::DLLExportLinkage:
 212       llvm_unreachable("DLLExport linkage is not supported by this target!");
 213     default:
 214       llvm_unreachable("Unknown linkage type!");
 215     }
 216
 217     EmitAlignment(Align, GV, 2);
 218
 219     unsigned Size = TD->getTypeAllocSize(C->getType());
 220     if (GV->isThreadLocal()) {
 221       Size *= MaxThreads;
 222     }
 223     if (TAI->hasDotTypeDotSizeDirective()) {
 224       O << "\t.type " << name << ",@object\n";
 225       O << "\t.size " << name << "," << Size << "\n";
 226     }
 227     O << name << ":\n";
 228
 229     EmitGlobalConstant(C);
 230     if (GV->isThreadLocal()) {
 231       for (unsigned i = 1; i < MaxThreads; ++i) {
 232         EmitGlobalConstant(C);
 233       }
 234     }
 235     if (Size < 4) {
 236       // The ABI requires that unsigned scalar types smaller than 32 bits
 237       // are are padded to 32 bits.
 238       EmitZeros(4 - Size);
 239     }
 240
 241     // Mark the end of the global
 242     O << "\t.cc_bottom " << name << ".data\n";
 243   }
 244 }
 245
 246 /// Emit the directives on the start of functions
 247 void XCoreAsmPrinter::
 248 emitFunctionStart(MachineFunction &MF)
 249 {
 250   // Print out the label for the function.
 251   const Function *F = MF.getFunction();
 252
 253   SwitchToSection(TAI->SectionForGlobal(F));
 254
 255   // Mark the start of the function
 256   O << "\t.cc_top " << CurrentFnName << ".function," << CurrentFnName << "\n";
 257
 258   switch (F->getLinkage()) {
 259   default: llvm_unreachable("Unknown linkage type!");
 260   case Function::InternalLinkage:  // Symbols default to internal.
 261   case Function::PrivateLinkage:
 262     break;
 263   case Function::ExternalLinkage:
 264     emitGlobalDirective(CurrentFnName);
 265     break;
 266   case Function::LinkOnceAnyLinkage:
 267   case Function::LinkOnceODRLinkage:
 268   case Function::WeakAnyLinkage:
 269   case Function::WeakODRLinkage:
 270     // TODO Use COMDAT groups for LinkOnceLinkage
 271     O << TAI->getGlobalDirective() << CurrentFnName << "\n";
 272     O << TAI->getWeakDefDirective() << CurrentFnName << "\n";
 273     break;
 274   }
 275   // (1 << 1) byte aligned
 276   EmitAlignment(MF.getAlignment(), F, 1);
 277   if (TAI->hasDotTypeDotSizeDirective()) {
 278     O << "\t.type " << CurrentFnName << ",@function\n";
 279   }
 280   O << CurrentFnName << ":\n";
 281 }
 282
 283 /// Emit the directives on the end of functions
 284 void XCoreAsmPrinter::
 285 emitFunctionEnd(MachineFunction &MF)
 286 {
 287   // Mark the end of the function
 288   O << "\t.cc_bottom " << CurrentFnName << ".function\n";
 289 }
 290
 291 /// runOnMachineFunction - This uses the printMachineInstruction()
 292 /// method to print assembly for each instruction.
 293 ///
 294 bool XCoreAsmPrinter::runOnMachineFunction(MachineFunction &MF)
 295 {
 296   this->MF = &MF;
 297
 298   SetupMachineFunction(MF);
 299
 300   // Print out constants referenced by the function
 301   EmitConstantPool(MF.getConstantPool());
 302
 303   // Print out jump tables referenced by the function
 304   EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
 305
 306   // Emit the function start directives
 307   emitFunctionStart(MF);
 308
 309   // Emit pre-function debug information.
 310   DW->BeginFunction(&MF);
 311
 312   // Print out code for the function.
 313   for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
 314        I != E; ++I) {
 315
 316     // Print a label for the basic block.
 317     if (I != MF.begin()) {
 318       printBasicBlockLabel(I, true , true);
 319       O << '\n';
 320     }
 321
 322     for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
 323          II != E; ++II) {
 324       // Print the assembly for the instruction.
 325       O << "\t";
 326       printMachineInstruction(II);
 327     }
 328
 329     // Each Basic Block is separated by a newline
 330     O << '\n';
 331   }
 332
 333   // Emit function end directives
 334   emitFunctionEnd(MF);
 335
 336   // Emit post-function debug information.
 337   DW->EndFunction(&MF);
 338
 339   // We didn't modify anything.
 340   return false;
 341 }
 342
 343 void XCoreAsmPrinter::printMemOperand(const MachineInstr *MI, int opNum)
 344 {
 345   printOperand(MI, opNum);
 346
 347   if (MI->getOperand(opNum+1).isImm()
 348     && MI->getOperand(opNum+1).getImm() == 0)
 349     return;
 350
 351   O << "+";
 352   printOperand(MI, opNum+1);
 353 }
 354
 355 void XCoreAsmPrinter::printOperand(const MachineInstr *MI, int opNum) {
 356   const MachineOperand &MO = MI->getOperand(opNum);
 357   switch (MO.getType()) {
 358   case MachineOperand::MO_Register:
 359     if (TargetRegisterInfo::isPhysicalRegister(MO.getReg()))
 360       O << TM.getRegisterInfo()->get(MO.getReg()).AsmName;
 361     else
 362       llvm_unreachable("not implemented");
 363     break;
 364   case MachineOperand::MO_Immediate:
 365     O << MO.getImm();
 366     break;
 367   case MachineOperand::MO_MachineBasicBlock:
 368     printBasicBlockLabel(MO.getMBB());
 369     break;
 370   case MachineOperand::MO_GlobalAddress:
 371     O << Mang->getMangledName(MO.getGlobal());
 372     break;
 373   case MachineOperand::MO_ExternalSymbol:
 374     O << MO.getSymbolName();
 375     break;
 376   case MachineOperand::MO_ConstantPoolIndex:
 377     O << TAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber()
 378       << '_' << MO.getIndex();
 379     break;
 380   case MachineOperand::MO_JumpTableIndex:
 381     O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
 382       << '_' << MO.getIndex();
 383     break;
 384   default:
 385     llvm_unreachable("not implemented");
 386   }
 387 }
 388
 389 /// PrintAsmOperand - Print out an operand for an inline asm expression.
 390 ///
 391 bool XCoreAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 392                                       unsigned AsmVariant,
 393                                       const char *ExtraCode) {
 394   printOperand(MI, OpNo);
 395   return false;
 396 }
 397
 398 void XCoreAsmPrinter::printMachineInstruction(const MachineInstr *MI) {
 399   ++EmittedInsts;
 400
 401   // Check for mov mnemonic
 402   unsigned src, dst, srcSR, dstSR;
 403   if (TM.getInstrInfo()->isMoveInstr(*MI, src, dst, srcSR, dstSR)) {
 404     O << "\tmov ";
 405     O << TM.getRegisterInfo()->get(dst).AsmName;
 406     O << ", ";
 407     O << TM.getRegisterInfo()->get(src).AsmName;
 408     O << "\n";
 409     return;
 410   }
 411   if (printInstruction(MI)) {
 412     return;
 413   }
 414   llvm_unreachable("Unhandled instruction in asm writer!");
 415 }
 416
 417 bool XCoreAsmPrinter::doInitialization(Module &M) {
 418   bool Result = AsmPrinter::doInitialization(M);
 419   DW = getAnalysisIfAvailable<DwarfWriter>();
 420
 421   if (!FileDirective.empty())
 422     emitFileDirective(FileDirective);
 423
 424   return Result;
 425 }
 426
 427 bool XCoreAsmPrinter::doFinalization(Module &M) {
 428
 429   // Print out module-level global variables.
 430   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 431        I != E; ++I) {
 432     emitGlobal(I);
 433   }
 434
 435   return AsmPrinter::doFinalization(M);
 436 }