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