lib/CodeGen/AsmPrinter/AsmPrinter.cpp

   1 //===-- AsmPrinter.cpp - Common AsmPrinter code ---------------------------===//
   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 implements the AsmPrinter class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "asm-printer"
  15 #include "llvm/CodeGen/AsmPrinter.h"
  16 #include "llvm/Assembly/Writer.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/Constants.h"
  19 #include "llvm/Module.h"
  20 #include "llvm/CodeGen/DwarfWriter.h"
  21 #include "llvm/CodeGen/GCMetadataPrinter.h"
  22 #include "llvm/CodeGen/MachineConstantPool.h"
  23 #include "llvm/CodeGen/MachineFrameInfo.h"
  24 #include "llvm/CodeGen/MachineFunction.h"
  25 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  26 #include "llvm/CodeGen/MachineLoopInfo.h"
  27 #include "llvm/CodeGen/MachineModuleInfo.h"
  28 #include "llvm/Analysis/ConstantFolding.h"
  29 #include "llvm/Analysis/DebugInfo.h"
  30 #include "llvm/MC/MCContext.h"
  31 #include "llvm/MC/MCExpr.h"
  32 #include "llvm/MC/MCInst.h"
  33 #include "llvm/MC/MCSection.h"
  34 #include "llvm/MC/MCStreamer.h"
  35 #include "llvm/MC/MCSymbol.h"
  36 #include "llvm/MC/MCAsmInfo.h"
  37 #include "llvm/Target/Mangler.h"
  38 #include "llvm/Target/TargetData.h"
  39 #include "llvm/Target/TargetInstrInfo.h"
  40 #include "llvm/Target/TargetLowering.h"
  41 #include "llvm/Target/TargetLoweringObjectFile.h"
  42 #include "llvm/Target/TargetOptions.h"
  43 #include "llvm/Target/TargetRegisterInfo.h"
  44 #include "llvm/ADT/SmallPtrSet.h"
  45 #include "llvm/ADT/SmallString.h"
  46 #include "llvm/ADT/Statistic.h"
  47 #include "llvm/Support/CommandLine.h"
  48 #include "llvm/Support/Debug.h"
  49 #include "llvm/Support/ErrorHandling.h"
  50 #include "llvm/Support/Format.h"
  51 #include "llvm/Support/FormattedStream.h"
  52 #include <cerrno>
  53 using namespace llvm;
  54
  55 STATISTIC(EmittedInsts, "Number of machine instrs printed");
  56
  57 char AsmPrinter::ID = 0;
  58 AsmPrinter::AsmPrinter(formatted_raw_ostream &o, TargetMachine &tm,
  59                        MCContext &Ctx, MCStreamer &Streamer,
  60                        const MCAsmInfo *T)
  61   : MachineFunctionPass(&ID), O(o),
  62     TM(tm), MAI(T), TRI(tm.getRegisterInfo()),
  63     OutContext(Ctx), OutStreamer(Streamer),
  64     LastMI(0), LastFn(0), Counter(~0U), SetCounter(0), PrevDLT(NULL) {
  65   DW = 0; MMI = 0;
  66   VerboseAsm = Streamer.isVerboseAsm();
  67 }
  68
  69 AsmPrinter::~AsmPrinter() {
  70   for (gcp_iterator I = GCMetadataPrinters.begin(),
  71                     E = GCMetadataPrinters.end(); I != E; ++I)
  72     delete I->second;
  73
  74   delete &OutStreamer;
  75   delete &OutContext;
  76 }
  77
  78 /// getFunctionNumber - Return a unique ID for the current function.
  79 ///
  80 unsigned AsmPrinter::getFunctionNumber() const {
  81   return MF->getFunctionNumber();
  82 }
  83
  84 TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
  85   return TM.getTargetLowering()->getObjFileLowering();
  86 }
  87
  88 /// getCurrentSection() - Return the current section we are emitting to.
  89 const MCSection *AsmPrinter::getCurrentSection() const {
  90   return OutStreamer.getCurrentSection();
  91 }
  92
  93
  94 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
  95   AU.setPreservesAll();
  96   MachineFunctionPass::getAnalysisUsage(AU);
  97   AU.addRequired<GCModuleInfo>();
  98   if (VerboseAsm)
  99     AU.addRequired<MachineLoopInfo>();
 100 }
 101
 102 bool AsmPrinter::doInitialization(Module &M) {
 103   // Initialize TargetLoweringObjectFile.
 104   const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
 105     .Initialize(OutContext, TM);
 106
 107   Mang = new Mangler(OutContext);
 108
 109   // Allow the target to emit any magic that it wants at the start of the file.
 110   EmitStartOfAsmFile(M);
 111
 112   // Very minimal debug info. It is ignored if we emit actual debug info. If we
 113   // don't, this at least helps the user find where a global came from.
 114   if (MAI->hasSingleParameterDotFile()) {
 115     // .file "foo.c"
 116     OutStreamer.EmitFileDirective(M.getModuleIdentifier());
 117   }
 118
 119   GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
 120   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
 121   for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
 122     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
 123       MP->beginAssembly(O, *this, *MAI);
 124
 125   if (!M.getModuleInlineAsm().empty())
 126     O << MAI->getCommentString() << " Start of file scope inline assembly\n"
 127       << M.getModuleInlineAsm()
 128       << '\n' << MAI->getCommentString()
 129       << " End of file scope inline assembly\n";
 130
 131   MMI = getAnalysisIfAvailable<MachineModuleInfo>();
 132   if (MMI)
 133     MMI->AnalyzeModule(M);
 134   DW = getAnalysisIfAvailable<DwarfWriter>();
 135   if (DW)
 136     DW->BeginModule(&M, MMI, O, this, MAI);
 137
 138   return false;
 139 }
 140
 141 void AsmPrinter::EmitLinkage(unsigned Linkage, MCSymbol *GVSym) const {
 142   switch ((GlobalValue::LinkageTypes)Linkage) {
 143   case GlobalValue::CommonLinkage:
 144   case GlobalValue::LinkOnceAnyLinkage:
 145   case GlobalValue::LinkOnceODRLinkage:
 146   case GlobalValue::WeakAnyLinkage:
 147   case GlobalValue::WeakODRLinkage:
 148   case GlobalValue::LinkerPrivateLinkage:
 149     if (MAI->getWeakDefDirective() != 0) {
 150       // .globl _foo
 151       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
 152       // .weak_definition _foo
 153       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefinition);
 154     } else if (const char *LinkOnce = MAI->getLinkOnceDirective()) {
 155       // .globl _foo
 156       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
 157       // FIXME: linkonce should be a section attribute, handled by COFF Section
 158       // assignment.
 159       // http://sourceware.org/binutils/docs-2.20/as/Linkonce.html#Linkonce
 160       // .linkonce discard
 161       // FIXME: It would be nice to use .linkonce samesize for non-common
 162       // globals.
 163       O << LinkOnce;
 164     } else {
 165       // .weak _foo
 166       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Weak);
 167     }
 168     break;
 169   case GlobalValue::DLLExportLinkage:
 170   case GlobalValue::AppendingLinkage:
 171     // FIXME: appending linkage variables should go into a section of
 172     // their name or something.  For now, just emit them as external.
 173   case GlobalValue::ExternalLinkage:
 174     // If external or appending, declare as a global symbol.
 175     // .globl _foo
 176     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
 177     break;
 178   case GlobalValue::PrivateLinkage:
 179   case GlobalValue::InternalLinkage:
 180     break;
 181   default:
 182     llvm_unreachable("Unknown linkage type!");
 183   }
 184 }
 185
 186
 187 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
 188 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
 189   if (!GV->hasInitializer())   // External globals require no code.
 190     return;
 191
 192   // Check to see if this is a special global used by LLVM, if so, emit it.
 193   if (EmitSpecialLLVMGlobal(GV))
 194     return;
 195
 196   MCSymbol *GVSym = GetGlobalValueSymbol(GV);
 197   EmitVisibility(GVSym, GV->getVisibility());
 198
 199   if (MAI->hasDotTypeDotSizeDirective())
 200     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_ELF_TypeObject);
 201
 202   SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
 203
 204   const TargetData *TD = TM.getTargetData();
 205   unsigned Size = TD->getTypeAllocSize(GV->getType()->getElementType());
 206   unsigned AlignLog = TD->getPreferredAlignmentLog(GV);
 207
 208   // Handle common and BSS local symbols (.lcomm).
 209   if (GVKind.isCommon() || GVKind.isBSSLocal()) {
 210     if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
 211
 212     if (VerboseAsm) {
 213       WriteAsOperand(OutStreamer.GetCommentOS(), GV,
 214                      /*PrintType=*/false, GV->getParent());
 215       OutStreamer.GetCommentOS() << '\n';
 216     }
 217
 218     // Handle common symbols.
 219     if (GVKind.isCommon()) {
 220       // .comm _foo, 42, 4
 221       OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
 222       return;
 223     }
 224
 225     // Handle local BSS symbols.
 226     if (MAI->hasMachoZeroFillDirective()) {
 227       const MCSection *TheSection =
 228         getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
 229       // .zerofill __DATA, __bss, _foo, 400, 5
 230       OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
 231       return;
 232     }
 233
 234     if (MAI->hasLCOMMDirective()) {
 235       // .lcomm _foo, 42
 236       OutStreamer.EmitLocalCommonSymbol(GVSym, Size);
 237       return;
 238     }
 239
 240     // .local _foo
 241     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Local);
 242     // .comm _foo, 42, 4
 243     OutStreamer.EmitCommonSymbol(GVSym, Size, 1 << AlignLog);
 244     return;
 245   }
 246
 247   const MCSection *TheSection =
 248     getObjFileLowering().SectionForGlobal(GV, GVKind, Mang, TM);
 249
 250   // Handle the zerofill directive on darwin, which is a special form of BSS
 251   // emission.
 252   if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
 253     // .globl _foo
 254     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
 255     // .zerofill __DATA, __common, _foo, 400, 5
 256     OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
 257     return;
 258   }
 259
 260   OutStreamer.SwitchSection(TheSection);
 261
 262   EmitLinkage(GV->getLinkage(), GVSym);
 263   EmitAlignment(AlignLog, GV);
 264
 265   if (VerboseAsm) {
 266     WriteAsOperand(OutStreamer.GetCommentOS(), GV,
 267                    /*PrintType=*/false, GV->getParent());
 268     OutStreamer.GetCommentOS() << '\n';
 269   }
 270   OutStreamer.EmitLabel(GVSym);
 271
 272   EmitGlobalConstant(GV->getInitializer());
 273
 274   if (MAI->hasDotTypeDotSizeDirective())
 275     // .size foo, 42
 276     OutStreamer.EmitELFSize(GVSym, MCConstantExpr::Create(Size, OutContext));
 277
 278   OutStreamer.AddBlankLine();
 279 }
 280
 281 /// EmitFunctionHeader - This method emits the header for the current
 282 /// function.
 283 void AsmPrinter::EmitFunctionHeader() {
 284   // Print out constants referenced by the function
 285   EmitConstantPool();
 286
 287   // Print the 'header' of function.
 288   const Function *F = MF->getFunction();
 289
 290   OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F, Mang, TM));
 291   EmitVisibility(CurrentFnSym, F->getVisibility());
 292
 293   EmitLinkage(F->getLinkage(), CurrentFnSym);
 294   EmitAlignment(MF->getAlignment(), F);
 295
 296   if (MAI->hasDotTypeDotSizeDirective())
 297     OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCSA_ELF_TypeFunction);
 298
 299   if (VerboseAsm) {
 300     WriteAsOperand(OutStreamer.GetCommentOS(), F,
 301                    /*PrintType=*/false, F->getParent());
 302     OutStreamer.GetCommentOS() << '\n';
 303   }
 304
 305   // Emit the CurrentFnSym.  This is a virtual function to allow targets to
 306   // do their wild and crazy things as required.
 307   EmitFunctionEntryLabel();
 308
 309   // Add some workaround for linkonce linkage on Cygwin\MinGW.
 310   if (MAI->getLinkOnceDirective() != 0 &&
 311       (F->hasLinkOnceLinkage() || F->hasWeakLinkage()))
 312     // FIXME: What is this?
 313     O << "Lllvm$workaround$fake$stub$" << *CurrentFnSym << ":\n";
 314
 315   // Emit pre-function debug and/or EH information.
 316   if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
 317     DW->BeginFunction(MF);
 318 }
 319
 320 /// EmitFunctionEntryLabel - Emit the label that is the entrypoint for the
 321 /// function.  This can be overridden by targets as required to do custom stuff.
 322 void AsmPrinter::EmitFunctionEntryLabel() {
 323   OutStreamer.EmitLabel(CurrentFnSym);
 324 }
 325
 326
 327 /// EmitComments - Pretty-print comments for instructions.
 328 static void EmitComments(const MachineInstr &MI, raw_ostream &CommentOS) {
 329   const MachineFunction *MF = MI.getParent()->getParent();
 330   const TargetMachine &TM = MF->getTarget();
 331
 332   if (!MI.getDebugLoc().isUnknown()) {
 333     DILocation DLT = MF->getDILocation(MI.getDebugLoc());
 334
 335     // Print source line info.
 336     DIScope Scope = DLT.getScope();
 337     // Omit the directory, because it's likely to be long and uninteresting.
 338     if (Scope.Verify())
 339       CommentOS << Scope.getFilename();
 340     else
 341       CommentOS << "<unknown>";
 342     CommentOS << ':' << DLT.getLineNumber();
 343     if (DLT.getColumnNumber() != 0)
 344       CommentOS << ':' << DLT.getColumnNumber();
 345     CommentOS << '\n';
 346   }
 347
 348   // Check for spills and reloads
 349   int FI;
 350
 351   const MachineFrameInfo *FrameInfo = MF->getFrameInfo();
 352
 353   // We assume a single instruction only has a spill or reload, not
 354   // both.
 355   const MachineMemOperand *MMO;
 356   if (TM.getInstrInfo()->isLoadFromStackSlotPostFE(&MI, FI)) {
 357     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
 358       MMO = *MI.memoperands_begin();
 359       CommentOS << MMO->getSize() << "-byte Reload\n";
 360     }
 361   } else if (TM.getInstrInfo()->hasLoadFromStackSlot(&MI, MMO, FI)) {
 362     if (FrameInfo->isSpillSlotObjectIndex(FI))
 363       CommentOS << MMO->getSize() << "-byte Folded Reload\n";
 364   } else if (TM.getInstrInfo()->isStoreToStackSlotPostFE(&MI, FI)) {
 365     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
 366       MMO = *MI.memoperands_begin();
 367       CommentOS << MMO->getSize() << "-byte Spill\n";
 368     }
 369   } else if (TM.getInstrInfo()->hasStoreToStackSlot(&MI, MMO, FI)) {
 370     if (FrameInfo->isSpillSlotObjectIndex(FI))
 371       CommentOS << MMO->getSize() << "-byte Folded Spill\n";
 372   }
 373
 374   // Check for spill-induced copies
 375   unsigned SrcReg, DstReg, SrcSubIdx, DstSubIdx;
 376   if (TM.getInstrInfo()->isMoveInstr(MI, SrcReg, DstReg,
 377                                      SrcSubIdx, DstSubIdx)) {
 378     if (MI.getAsmPrinterFlag(MachineInstr::ReloadReuse))
 379       CommentOS << " Reload Reuse\n";
 380   }
 381 }
 382
 383
 384
 385 /// EmitFunctionBody - This method emits the body and trailer for a
 386 /// function.
 387 void AsmPrinter::EmitFunctionBody() {
 388   // Emit target-specific gunk before the function body.
 389   EmitFunctionBodyStart();
 390
 391   // Print out code for the function.
 392   bool HasAnyRealCode = false;
 393   for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
 394        I != E; ++I) {
 395     // Print a label for the basic block.
 396     EmitBasicBlockStart(I);
 397     for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
 398          II != IE; ++II) {
 399       // Print the assembly for the instruction.
 400       if (!II->isLabel())
 401         HasAnyRealCode = true;
 402
 403       ++EmittedInsts;
 404
 405       // FIXME: Clean up processDebugLoc.
 406       processDebugLoc(II, true);
 407
 408       if (VerboseAsm)
 409         EmitComments(*II, OutStreamer.GetCommentOS());
 410
 411       switch (II->getOpcode()) {
 412       case TargetOpcode::DBG_LABEL:
 413       case TargetOpcode::EH_LABEL:
 414       case TargetOpcode::GC_LABEL:
 415         printLabelInst(II);
 416         break;
 417       case TargetOpcode::INLINEASM:
 418         printInlineAsm(II);
 419         break;
 420       case TargetOpcode::IMPLICIT_DEF:
 421         printImplicitDef(II);
 422         break;
 423       case TargetOpcode::KILL:
 424         printKill(II);
 425         break;
 426       default:
 427         EmitInstruction(II);
 428         break;
 429       }
 430
 431       // FIXME: Clean up processDebugLoc.
 432       processDebugLoc(II, false);
 433     }
 434   }
 435
 436   // If the function is empty and the object file uses .subsections_via_symbols,
 437   // then we need to emit *something* to the function body to prevent the
 438   // labels from collapsing together.  Just emit a 0 byte.
 439   if (MAI->hasSubsectionsViaSymbols() && !HasAnyRealCode)
 440     OutStreamer.EmitIntValue(0, 1, 0/*addrspace*/);
 441
 442   // Emit target-specific gunk after the function body.
 443   EmitFunctionBodyEnd();
 444
 445   if (MAI->hasDotTypeDotSizeDirective())
 446     O << "\t.size\t" << *CurrentFnSym << ", .-" << *CurrentFnSym << '\n';
 447
 448   // Emit post-function debug information.
 449   if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
 450     DW->EndFunction(MF);
 451
 452   // Print out jump tables referenced by the function.
 453   EmitJumpTableInfo();
 454
 455   OutStreamer.AddBlankLine();
 456 }
 457
 458
 459 bool AsmPrinter::doFinalization(Module &M) {
 460   // Emit global variables.
 461   for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 462        I != E; ++I)
 463     EmitGlobalVariable(I);
 464
 465   // Emit final debug information.
 466   if (MAI->doesSupportDebugInformation() || MAI->doesSupportExceptionHandling())
 467     DW->EndModule();
 468
 469   // If the target wants to know about weak references, print them all.
 470   if (MAI->getWeakRefDirective()) {
 471     // FIXME: This is not lazy, it would be nice to only print weak references
 472     // to stuff that is actually used.  Note that doing so would require targets
 473     // to notice uses in operands (due to constant exprs etc).  This should
 474     // happen with the MC stuff eventually.
 475
 476     // Print out module-level global variables here.
 477     for (Module::const_global_iterator I = M.global_begin(), E = M.global_end();
 478          I != E; ++I) {
 479       if (!I->hasExternalWeakLinkage()) continue;
 480       OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
 481                                       MCSA_WeakReference);
 482     }
 483
 484     for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
 485       if (!I->hasExternalWeakLinkage()) continue;
 486       OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(I),
 487                                       MCSA_WeakReference);
 488     }
 489   }
 490
 491   if (MAI->hasSetDirective()) {
 492     OutStreamer.AddBlankLine();
 493     for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
 494          I != E; ++I) {
 495       MCSymbol *Name = GetGlobalValueSymbol(I);
 496
 497       const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
 498       MCSymbol *Target = GetGlobalValueSymbol(GV);
 499
 500       if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
 501         OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
 502       else if (I->hasWeakLinkage())
 503         OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
 504       else
 505         assert(I->hasLocalLinkage() && "Invalid alias linkage");
 506
 507       EmitVisibility(Name, I->getVisibility());
 508
 509       // Emit the directives as assignments aka .set:
 510       OutStreamer.EmitAssignment(Name,
 511                                  MCSymbolRefExpr::Create(Target, OutContext));
 512     }
 513   }
 514
 515   GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
 516   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
 517   for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
 518     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
 519       MP->finishAssembly(O, *this, *MAI);
 520
 521   // If we don't have any trampolines, then we don't require stack memory
 522   // to be executable. Some targets have a directive to declare this.
 523   Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
 524   if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
 525     if (MCSection *S = MAI->getNonexecutableStackSection(OutContext))
 526       OutStreamer.SwitchSection(S);
 527
 528   // Allow the target to emit any magic that it wants at the end of the file,
 529   // after everything else has gone out.
 530   EmitEndOfAsmFile(M);
 531
 532   delete Mang; Mang = 0;
 533   DW = 0; MMI = 0;
 534
 535   OutStreamer.Finish();
 536   return false;
 537 }
 538
 539 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
 540   this->MF = &MF;
 541   // Get the function symbol.
 542   CurrentFnSym = GetGlobalValueSymbol(MF.getFunction());
 543
 544   if (VerboseAsm)
 545     LI = &getAnalysis<MachineLoopInfo>();
 546 }
 547
 548 namespace {
 549   // SectionCPs - Keep track the alignment, constpool entries per Section.
 550   struct SectionCPs {
 551     const MCSection *S;
 552     unsigned Alignment;
 553     SmallVector<unsigned, 4> CPEs;
 554     SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
 555   };
 556 }
 557
 558 /// EmitConstantPool - Print to the current output stream assembly
 559 /// representations of the constants in the constant pool MCP. This is
 560 /// used to print out constants which have been "spilled to memory" by
 561 /// the code generator.
 562 ///
 563 void AsmPrinter::EmitConstantPool() {
 564   const MachineConstantPool *MCP = MF->getConstantPool();
 565   const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
 566   if (CP.empty()) return;
 567
 568   // Calculate sections for constant pool entries. We collect entries to go into
 569   // the same section together to reduce amount of section switch statements.
 570   SmallVector<SectionCPs, 4> CPSections;
 571   for (unsigned i = 0, e = CP.size(); i != e; ++i) {
 572     const MachineConstantPoolEntry &CPE = CP[i];
 573     unsigned Align = CPE.getAlignment();
 574
 575     SectionKind Kind;
 576     switch (CPE.getRelocationInfo()) {
 577     default: llvm_unreachable("Unknown section kind");
 578     case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
 579     case 1:
 580       Kind = SectionKind::getReadOnlyWithRelLocal();
 581       break;
 582     case 0:
 583     switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
 584     case 4:  Kind = SectionKind::getMergeableConst4(); break;
 585     case 8:  Kind = SectionKind::getMergeableConst8(); break;
 586     case 16: Kind = SectionKind::getMergeableConst16();break;
 587     default: Kind = SectionKind::getMergeableConst(); break;
 588     }
 589     }
 590
 591     const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
 592
 593     // The number of sections are small, just do a linear search from the
 594     // last section to the first.
 595     bool Found = false;
 596     unsigned SecIdx = CPSections.size();
 597     while (SecIdx != 0) {
 598       if (CPSections[--SecIdx].S == S) {
 599         Found = true;
 600         break;
 601       }
 602     }
 603     if (!Found) {
 604       SecIdx = CPSections.size();
 605       CPSections.push_back(SectionCPs(S, Align));
 606     }
 607
 608     if (Align > CPSections[SecIdx].Alignment)
 609       CPSections[SecIdx].Alignment = Align;
 610     CPSections[SecIdx].CPEs.push_back(i);
 611   }
 612
 613   // Now print stuff into the calculated sections.
 614   for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
 615     OutStreamer.SwitchSection(CPSections[i].S);
 616     EmitAlignment(Log2_32(CPSections[i].Alignment));
 617
 618     unsigned Offset = 0;
 619     for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
 620       unsigned CPI = CPSections[i].CPEs[j];
 621       MachineConstantPoolEntry CPE = CP[CPI];
 622
 623       // Emit inter-object padding for alignment.
 624       unsigned AlignMask = CPE.getAlignment() - 1;
 625       unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
 626       OutStreamer.EmitFill(NewOffset - Offset, 0/*fillval*/, 0/*addrspace*/);
 627
 628       const Type *Ty = CPE.getType();
 629       Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
 630
 631       // Emit the label with a comment on it.
 632       if (VerboseAsm) {
 633         OutStreamer.GetCommentOS() << "constant pool ";
 634         WriteTypeSymbolic(OutStreamer.GetCommentOS(), CPE.getType(),
 635                           MF->getFunction()->getParent());
 636         OutStreamer.GetCommentOS() << '\n';
 637       }
 638       OutStreamer.EmitLabel(GetCPISymbol(CPI));
 639
 640       if (CPE.isMachineConstantPoolEntry())
 641         EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
 642       else
 643         EmitGlobalConstant(CPE.Val.ConstVal);
 644     }
 645   }
 646 }
 647
 648 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
 649 /// by the current function to the current output stream.
 650 ///
 651 void AsmPrinter::EmitJumpTableInfo() {
 652   const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
 653   if (MJTI == 0) return;
 654   if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return;
 655   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
 656   if (JT.empty()) return;
 657
 658   // Pick the directive to use to print the jump table entries, and switch to
 659   // the appropriate section.
 660   const Function *F = MF->getFunction();
 661   bool JTInDiffSection = false;
 662   if (// In PIC mode, we need to emit the jump table to the same section as the
 663       // function body itself, otherwise the label differences won't make sense.
 664       // FIXME: Need a better predicate for this: what about custom entries?
 665       MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 ||
 666       // We should also do if the section name is NULL or function is declared
 667       // in discardable section
 668       // FIXME: this isn't the right predicate, should be based on the MCSection
 669       // for the function.
 670       F->isWeakForLinker()) {
 671     OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F,Mang,TM));
 672   } else {
 673     // Otherwise, drop it in the readonly section.
 674     const MCSection *ReadOnlySection =
 675       getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
 676     OutStreamer.SwitchSection(ReadOnlySection);
 677     JTInDiffSection = true;
 678   }
 679
 680   EmitAlignment(Log2_32(MJTI->getEntryAlignment(*TM.getTargetData())));
 681
 682   for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
 683     const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
 684
 685     // If this jump table was deleted, ignore it.
 686     if (JTBBs.empty()) continue;
 687
 688     // For the EK_LabelDifference32 entry, if the target supports .set, emit a
 689     // .set directive for each unique entry.  This reduces the number of
 690     // relocations the assembler will generate for the jump table.
 691     if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
 692         MAI->hasSetDirective()) {
 693       SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
 694       const TargetLowering *TLI = TM.getTargetLowering();
 695       const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext);
 696       for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
 697         const MachineBasicBlock *MBB = JTBBs[ii];
 698         if (!EmittedSets.insert(MBB)) continue;
 699
 700         // .set LJTSet, LBB32-base
 701         const MCExpr *LHS =
 702           MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
 703         OutStreamer.EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
 704                                 MCBinaryExpr::CreateSub(LHS, Base, OutContext));
 705       }
 706     }
 707
 708     // On some targets (e.g. Darwin) we want to emit two consequtive labels
 709     // before each jump table.  The first label is never referenced, but tells
 710     // the assembler and linker the extents of the jump table object.  The
 711     // second label is actually referenced by the code.
 712     if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0])
 713       // FIXME: This doesn't have to have any specific name, just any randomly
 714       // named and numbered 'l' label would work.  Simplify GetJTISymbol.
 715       OutStreamer.EmitLabel(GetJTISymbol(JTI, true));
 716
 717     OutStreamer.EmitLabel(GetJTISymbol(JTI));
 718
 719     for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
 720       EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
 721   }
 722 }
 723
 724 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
 725 /// current stream.
 726 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
 727                                     const MachineBasicBlock *MBB,
 728                                     unsigned UID) const {
 729   const MCExpr *Value = 0;
 730   switch (MJTI->getEntryKind()) {
 731   case MachineJumpTableInfo::EK_Inline:
 732     llvm_unreachable("Cannot emit EK_Inline jump table entry"); break;
 733   case MachineJumpTableInfo::EK_Custom32:
 734     Value = TM.getTargetLowering()->LowerCustomJumpTableEntry(MJTI, MBB, UID,
 735                                                               OutContext);
 736     break;
 737   case MachineJumpTableInfo::EK_BlockAddress:
 738     // EK_BlockAddress - Each entry is a plain address of block, e.g.:
 739     //     .word LBB123
 740     Value = MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
 741     break;
 742   case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
 743     // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
 744     // with a relocation as gp-relative, e.g.:
 745     //     .gprel32 LBB123
 746     MCSymbol *MBBSym = MBB->getSymbol(OutContext);
 747     OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
 748     return;
 749   }
 750
 751   case MachineJumpTableInfo::EK_LabelDifference32: {
 752     // EK_LabelDifference32 - Each entry is the address of the block minus
 753     // the address of the jump table.  This is used for PIC jump tables where
 754     // gprel32 is not supported.  e.g.:
 755     //      .word LBB123 - LJTI1_2
 756     // If the .set directive is supported, this is emitted as:
 757     //      .set L4_5_set_123, LBB123 - LJTI1_2
 758     //      .word L4_5_set_123
 759
 760     // If we have emitted set directives for the jump table entries, print
 761     // them rather than the entries themselves.  If we're emitting PIC, then
 762     // emit the table entries as differences between two text section labels.
 763     if (MAI->hasSetDirective()) {
 764       // If we used .set, reference the .set's symbol.
 765       Value = MCSymbolRefExpr::Create(GetJTSetSymbol(UID, MBB->getNumber()),
 766                                       OutContext);
 767       break;
 768     }
 769     // Otherwise, use the difference as the jump table entry.
 770     Value = MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
 771     const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(UID), OutContext);
 772     Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
 773     break;
 774   }
 775   }
 776
 777   assert(Value && "Unknown entry kind!");
 778
 779   unsigned EntrySize = MJTI->getEntrySize(*TM.getTargetData());
 780   OutStreamer.EmitValue(Value, EntrySize, /*addrspace*/0);
 781 }
 782
 783
 784 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
 785 /// special global used by LLVM.  If so, emit it and return true, otherwise
 786 /// do nothing and return false.
 787 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
 788   if (GV->getName() == "llvm.used") {
 789     if (MAI->hasNoDeadStrip())    // No need to emit this at all.
 790       EmitLLVMUsedList(GV->getInitializer());
 791     return true;
 792   }
 793
 794   // Ignore debug and non-emitted data.  This handles llvm.compiler.used.
 795   if (GV->getSection() == "llvm.metadata" ||
 796       GV->hasAvailableExternallyLinkage())
 797     return true;
 798
 799   if (!GV->hasAppendingLinkage()) return false;
 800
 801   assert(GV->hasInitializer() && "Not a special LLVM global!");
 802
 803   const TargetData *TD = TM.getTargetData();
 804   unsigned Align = Log2_32(TD->getPointerPrefAlignment());
 805   if (GV->getName() == "llvm.global_ctors") {
 806     OutStreamer.SwitchSection(getObjFileLowering().getStaticCtorSection());
 807     EmitAlignment(Align, 0);
 808     EmitXXStructorList(GV->getInitializer());
 809
 810     if (TM.getRelocationModel() == Reloc::Static &&
 811         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
 812       StringRef Sym(".constructors_used");
 813       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
 814                                       MCSA_Reference);
 815     }
 816     return true;
 817   }
 818
 819   if (GV->getName() == "llvm.global_dtors") {
 820     OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
 821     EmitAlignment(Align, 0);
 822     EmitXXStructorList(GV->getInitializer());
 823
 824     if (TM.getRelocationModel() == Reloc::Static &&
 825         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
 826       StringRef Sym(".destructors_used");
 827       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
 828                                       MCSA_Reference);
 829     }
 830     return true;
 831   }
 832
 833   return false;
 834 }
 835
 836 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
 837 /// global in the specified llvm.used list for which emitUsedDirectiveFor
 838 /// is true, as being used with this directive.
 839 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
 840   // Should be an array of 'i8*'.
 841   ConstantArray *InitList = dyn_cast<ConstantArray>(List);
 842   if (InitList == 0) return;
 843
 844   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
 845     const GlobalValue *GV =
 846       dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
 847     if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang))
 848       OutStreamer.EmitSymbolAttribute(GetGlobalValueSymbol(GV),
 849                                       MCSA_NoDeadStrip);
 850   }
 851 }
 852
 853 /// EmitXXStructorList - Emit the ctor or dtor list.  This just prints out the
 854 /// function pointers, ignoring the init priority.
 855 void AsmPrinter::EmitXXStructorList(Constant *List) {
 856   // Should be an array of '{ int, void ()* }' structs.  The first value is the
 857   // init priority, which we ignore.
 858   if (!isa<ConstantArray>(List)) return;
 859   ConstantArray *InitList = cast<ConstantArray>(List);
 860   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
 861     if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
 862       if (CS->getNumOperands() != 2) return;  // Not array of 2-element structs.
 863
 864       if (CS->getOperand(1)->isNullValue())
 865         return;  // Found a null terminator, exit printing.
 866       // Emit the function pointer.
 867       EmitGlobalConstant(CS->getOperand(1));
 868     }
 869 }
 870
 871 //===--------------------------------------------------------------------===//
 872 // Emission and print routines
 873 //
 874
 875 /// EmitInt8 - Emit a byte directive and value.
 876 ///
 877 void AsmPrinter::EmitInt8(int Value) const {
 878   OutStreamer.EmitIntValue(Value, 1, 0/*addrspace*/);
 879 }
 880
 881 /// EmitInt16 - Emit a short directive and value.
 882 ///
 883 void AsmPrinter::EmitInt16(int Value) const {
 884   OutStreamer.EmitIntValue(Value, 2, 0/*addrspace*/);
 885 }
 886
 887 /// EmitInt32 - Emit a long directive and value.
 888 ///
 889 void AsmPrinter::EmitInt32(int Value) const {
 890   OutStreamer.EmitIntValue(Value, 4, 0/*addrspace*/);
 891 }
 892
 893 /// EmitInt64 - Emit a long long directive and value.
 894 ///
 895 void AsmPrinter::EmitInt64(uint64_t Value) const {
 896   OutStreamer.EmitIntValue(Value, 8, 0/*addrspace*/);
 897 }
 898
 899 /// EmitLabelDifference - Emit something like ".long Hi-Lo" where the size
 900 /// in bytes of the directive is specified by Size and Hi/Lo specify the
 901 /// labels.  This implicitly uses .set if it is available.
 902 void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
 903                                      unsigned Size) const {
 904   // Get the Hi-Lo expression.
 905   const MCExpr *Diff =
 906     MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(Hi, OutContext),
 907                             MCSymbolRefExpr::Create(Lo, OutContext),
 908                             OutContext);
 909
 910   if (!MAI->hasSetDirective()) {
 911     OutStreamer.EmitValue(Diff, Size, 0/*AddrSpace*/);
 912     return;
 913   }
 914
 915   // Otherwise, emit with .set (aka assignment).
 916   MCSymbol *SetLabel =
 917     OutContext.GetOrCreateTemporarySymbol(Twine(MAI->getPrivateGlobalPrefix()) +
 918                                           "set" + Twine(SetCounter++));
 919   OutStreamer.EmitAssignment(SetLabel, Diff);
 920   OutStreamer.EmitSymbolValue(SetLabel, Size, 0/*AddrSpace*/);
 921 }
 922
 923
 924 //===----------------------------------------------------------------------===//
 925
 926 // EmitAlignment - Emit an alignment directive to the specified power of
 927 // two boundary.  For example, if you pass in 3 here, you will get an 8
 928 // byte alignment.  If a global value is specified, and if that global has
 929 // an explicit alignment requested, it will unconditionally override the
 930 // alignment request.  However, if ForcedAlignBits is specified, this value
 931 // has final say: the ultimate alignment will be the max of ForcedAlignBits
 932 // and the alignment computed with NumBits and the global.
 933 //
 934 // The algorithm is:
 935 //     Align = NumBits;
 936 //     if (GV && GV->hasalignment) Align = GV->getalignment();
 937 //     Align = std::max(Align, ForcedAlignBits);
 938 //
 939 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
 940                                unsigned ForcedAlignBits,
 941                                bool UseFillExpr) const {
 942   if (GV && GV->getAlignment())
 943     NumBits = Log2_32(GV->getAlignment());
 944   NumBits = std::max(NumBits, ForcedAlignBits);
 945
 946   if (NumBits == 0) return;   // No need to emit alignment.
 947
 948   if (getCurrentSection()->getKind().isText())
 949     OutStreamer.EmitCodeAlignment(1 << NumBits);
 950   else
 951     OutStreamer.EmitValueToAlignment(1 << NumBits, 0, 1, 0);
 952 }
 953
 954 /// LowerConstant - Lower the specified LLVM Constant to an MCExpr.
 955 ///
 956 static const MCExpr *LowerConstant(const Constant *CV, AsmPrinter &AP) {
 957   MCContext &Ctx = AP.OutContext;
 958
 959   if (CV->isNullValue() || isa<UndefValue>(CV))
 960     return MCConstantExpr::Create(0, Ctx);
 961
 962   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
 963     return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
 964
 965   if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
 966     return MCSymbolRefExpr::Create(AP.GetGlobalValueSymbol(GV), Ctx);
 967   if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
 968     return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
 969
 970   const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
 971   if (CE == 0) {
 972     llvm_unreachable("Unknown constant value to lower!");
 973     return MCConstantExpr::Create(0, Ctx);
 974   }
 975
 976   switch (CE->getOpcode()) {
 977   default:
 978     // If the code isn't optimized, there may be outstanding folding
 979     // opportunities. Attempt to fold the expression using TargetData as a
 980     // last resort before giving up.
 981     if (Constant *C =
 982           ConstantFoldConstantExpression(CE, AP.TM.getTargetData()))
 983       if (C != CE)
 984         return LowerConstant(C, AP);
 985 #ifndef NDEBUG
 986     CE->dump();
 987 #endif
 988     llvm_unreachable("FIXME: Don't support this constant expr");
 989   case Instruction::GetElementPtr: {
 990     const TargetData &TD = *AP.TM.getTargetData();
 991     // Generate a symbolic expression for the byte address
 992     const Constant *PtrVal = CE->getOperand(0);
 993     SmallVector<Value*, 8> IdxVec(CE->op_begin()+1, CE->op_end());
 994     int64_t Offset = TD.getIndexedOffset(PtrVal->getType(), &IdxVec[0],
 995                                          IdxVec.size());
 996
 997     const MCExpr *Base = LowerConstant(CE->getOperand(0), AP);
 998     if (Offset == 0)
 999       return Base;
1000
1001     // Truncate/sext the offset to the pointer size.
1002     if (TD.getPointerSizeInBits() != 64) {
1003       int SExtAmount = 64-TD.getPointerSizeInBits();
1004       Offset = (Offset << SExtAmount) >> SExtAmount;
1005     }
1006
1007     return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
1008                                    Ctx);
1009   }
1010
1011   case Instruction::Trunc:
1012     // We emit the value and depend on the assembler to truncate the generated
1013     // expression properly.  This is important for differences between
1014     // blockaddress labels.  Since the two labels are in the same function, it
1015     // is reasonable to treat their delta as a 32-bit value.
1016     // FALL THROUGH.
1017   case Instruction::BitCast:
1018     return LowerConstant(CE->getOperand(0), AP);
1019
1020   case Instruction::IntToPtr: {
1021     const TargetData &TD = *AP.TM.getTargetData();
1022     // Handle casts to pointers by changing them into casts to the appropriate
1023     // integer type.  This promotes constant folding and simplifies this code.
1024     Constant *Op = CE->getOperand(0);
1025     Op = ConstantExpr::getIntegerCast(Op, TD.getIntPtrType(CV->getContext()),
1026                                       false/*ZExt*/);
1027     return LowerConstant(Op, AP);
1028   }
1029
1030   case Instruction::PtrToInt: {
1031     const TargetData &TD = *AP.TM.getTargetData();
1032     // Support only foldable casts to/from pointers that can be eliminated by
1033     // changing the pointer to the appropriately sized integer type.
1034     Constant *Op = CE->getOperand(0);
1035     const Type *Ty = CE->getType();
1036
1037     const MCExpr *OpExpr = LowerConstant(Op, AP);
1038
1039     // We can emit the pointer value into this slot if the slot is an
1040     // integer slot equal to the size of the pointer.
1041     if (TD.getTypeAllocSize(Ty) == TD.getTypeAllocSize(Op->getType()))
1042       return OpExpr;
1043
1044     // Otherwise the pointer is smaller than the resultant integer, mask off
1045     // the high bits so we are sure to get a proper truncation if the input is
1046     // a constant expr.
1047     unsigned InBits = TD.getTypeAllocSizeInBits(Op->getType());
1048     const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
1049     return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
1050   }
1051
1052   // The MC library also has a right-shift operator, but it isn't consistently
1053   // signed or unsigned between different targets.
1054   case Instruction::Add:
1055   case Instruction::Sub:
1056   case Instruction::Mul:
1057   case Instruction::SDiv:
1058   case Instruction::SRem:
1059   case Instruction::Shl:
1060   case Instruction::And:
1061   case Instruction::Or:
1062   case Instruction::Xor: {
1063     const MCExpr *LHS = LowerConstant(CE->getOperand(0), AP);
1064     const MCExpr *RHS = LowerConstant(CE->getOperand(1), AP);
1065     switch (CE->getOpcode()) {
1066     default: llvm_unreachable("Unknown binary operator constant cast expr");
1067     case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
1068     case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
1069     case Instruction::Mul: return MCBinaryExpr::CreateMul(LHS, RHS, Ctx);
1070     case Instruction::SDiv: return MCBinaryExpr::CreateDiv(LHS, RHS, Ctx);
1071     case Instruction::SRem: return MCBinaryExpr::CreateMod(LHS, RHS, Ctx);
1072     case Instruction::Shl: return MCBinaryExpr::CreateShl(LHS, RHS, Ctx);
1073     case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
1074     case Instruction::Or:  return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
1075     case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
1076     }
1077   }
1078   }
1079 }
1080
1081 static void EmitGlobalConstantArray(const ConstantArray *CA, unsigned AddrSpace,
1082                                     AsmPrinter &AP) {
1083   if (AddrSpace != 0 || !CA->isString()) {
1084     // Not a string.  Print the values in successive locations
1085     for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1086       AP.EmitGlobalConstant(CA->getOperand(i), AddrSpace);
1087     return;
1088   }
1089
1090   // Otherwise, it can be emitted as .ascii.
1091   SmallVector<char, 128> TmpVec;
1092   TmpVec.reserve(CA->getNumOperands());
1093   for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1094     TmpVec.push_back(cast<ConstantInt>(CA->getOperand(i))->getZExtValue());
1095
1096   AP.OutStreamer.EmitBytes(StringRef(TmpVec.data(), TmpVec.size()), AddrSpace);
1097 }
1098
1099 static void EmitGlobalConstantVector(const ConstantVector *CV,
1100                                      unsigned AddrSpace, AsmPrinter &AP) {
1101   for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
1102     AP.EmitGlobalConstant(CV->getOperand(i), AddrSpace);
1103 }
1104
1105 static void EmitGlobalConstantStruct(const ConstantStruct *CS,
1106                                      unsigned AddrSpace, AsmPrinter &AP) {
1107   // Print the fields in successive locations. Pad to align if needed!
1108   const TargetData *TD = AP.TM.getTargetData();
1109   unsigned Size = TD->getTypeAllocSize(CS->getType());
1110   const StructLayout *Layout = TD->getStructLayout(CS->getType());
1111   uint64_t SizeSoFar = 0;
1112   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
1113     const Constant *Field = CS->getOperand(i);
1114
1115     // Check if padding is needed and insert one or more 0s.
1116     uint64_t FieldSize = TD->getTypeAllocSize(Field->getType());
1117     uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
1118                         - Layout->getElementOffset(i)) - FieldSize;
1119     SizeSoFar += FieldSize + PadSize;
1120
1121     // Now print the actual field value.
1122     AP.EmitGlobalConstant(Field, AddrSpace);
1123
1124     // Insert padding - this may include padding to increase the size of the
1125     // current field up to the ABI size (if the struct is not packed) as well
1126     // as padding to ensure that the next field starts at the right offset.
1127     AP.OutStreamer.EmitZeros(PadSize, AddrSpace);
1128   }
1129   assert(SizeSoFar == Layout->getSizeInBytes() &&
1130          "Layout of constant struct may be incorrect!");
1131 }
1132
1133 static void EmitGlobalConstantFP(const ConstantFP *CFP, unsigned AddrSpace,
1134                                  AsmPrinter &AP) {
1135   // FP Constants are printed as integer constants to avoid losing
1136   // precision.
1137   if (CFP->getType()->isDoubleTy()) {
1138     if (AP.VerboseAsm) {
1139       double Val = CFP->getValueAPF().convertToDouble();
1140       AP.OutStreamer.GetCommentOS() << "double " << Val << '\n';
1141     }
1142
1143     uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1144     AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1145     return;
1146   }
1147
1148   if (CFP->getType()->isFloatTy()) {
1149     if (AP.VerboseAsm) {
1150       float Val = CFP->getValueAPF().convertToFloat();
1151       AP.OutStreamer.GetCommentOS() << "float " << Val << '\n';
1152     }
1153     uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1154     AP.OutStreamer.EmitIntValue(Val, 4, AddrSpace);
1155     return;
1156   }
1157
1158   if (CFP->getType()->isX86_FP80Ty()) {
1159     // all long double variants are printed as hex
1160     // api needed to prevent premature destruction
1161     APInt API = CFP->getValueAPF().bitcastToAPInt();
1162     const uint64_t *p = API.getRawData();
1163     if (AP.VerboseAsm) {
1164       // Convert to double so we can print the approximate val as a comment.
1165       APFloat DoubleVal = CFP->getValueAPF();
1166       bool ignored;
1167       DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1168                         &ignored);
1169       AP.OutStreamer.GetCommentOS() << "x86_fp80 ~= "
1170         << DoubleVal.convertToDouble() << '\n';
1171     }
1172
1173     if (AP.TM.getTargetData()->isBigEndian()) {
1174       AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1175       AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1176     } else {
1177       AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1178       AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1179     }
1180
1181     // Emit the tail padding for the long double.
1182     const TargetData &TD = *AP.TM.getTargetData();
1183     AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
1184                              TD.getTypeStoreSize(CFP->getType()), AddrSpace);
1185     return;
1186   }
1187
1188   assert(CFP->getType()->isPPC_FP128Ty() &&
1189          "Floating point constant type not handled");
1190   // All long double variants are printed as hex api needed to prevent
1191   // premature destruction.
1192   APInt API = CFP->getValueAPF().bitcastToAPInt();
1193   const uint64_t *p = API.getRawData();
1194   if (AP.TM.getTargetData()->isBigEndian()) {
1195     AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1196     AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1197   } else {
1198     AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1199     AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1200   }
1201 }
1202
1203 static void EmitGlobalConstantLargeInt(const ConstantInt *CI,
1204                                        unsigned AddrSpace, AsmPrinter &AP) {
1205   const TargetData *TD = AP.TM.getTargetData();
1206   unsigned BitWidth = CI->getBitWidth();
1207   assert((BitWidth & 63) == 0 && "only support multiples of 64-bits");
1208
1209   // We don't expect assemblers to support integer data directives
1210   // for more than 64 bits, so we emit the data in at most 64-bit
1211   // quantities at a time.
1212   const uint64_t *RawData = CI->getValue().getRawData();
1213   for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1214     uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1215     AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1216   }
1217 }
1218
1219 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1220 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
1221   if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
1222     uint64_t Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1223     if (Size == 0) Size = 1; // An empty "_foo:" followed by a section is undef.
1224     return OutStreamer.EmitZeros(Size, AddrSpace);
1225   }
1226
1227   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1228     unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1229     switch (Size) {
1230     case 1:
1231     case 2:
1232     case 4:
1233     case 8:
1234       if (VerboseAsm)
1235         OutStreamer.GetCommentOS() << format("0x%llx\n", CI->getZExtValue());
1236       OutStreamer.EmitIntValue(CI->getZExtValue(), Size, AddrSpace);
1237       return;
1238     default:
1239       EmitGlobalConstantLargeInt(CI, AddrSpace, *this);
1240       return;
1241     }
1242   }
1243
1244   if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1245     return EmitGlobalConstantArray(CVA, AddrSpace, *this);
1246
1247   if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1248     return EmitGlobalConstantStruct(CVS, AddrSpace, *this);
1249
1250   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1251     return EmitGlobalConstantFP(CFP, AddrSpace, *this);
1252
1253   if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1254     return EmitGlobalConstantVector(V, AddrSpace, *this);
1255
1256   if (isa<ConstantPointerNull>(CV)) {
1257     unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1258     OutStreamer.EmitIntValue(0, Size, AddrSpace);
1259     return;
1260   }
1261
1262   // Otherwise, it must be a ConstantExpr.  Lower it to an MCExpr, then emit it
1263   // thread the streamer with EmitValue.
1264   OutStreamer.EmitValue(LowerConstant(CV, *this),
1265                         TM.getTargetData()->getTypeAllocSize(CV->getType()),
1266                         AddrSpace);
1267 }
1268
1269 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1270   // Target doesn't support this yet!
1271   llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1272 }
1273
1274 /// PrintSpecial - Print information related to the specified machine instr
1275 /// that is independent of the operand, and may be independent of the instr
1276 /// itself.  This can be useful for portably encoding the comment character
1277 /// or other bits of target-specific knowledge into the asmstrings.  The
1278 /// syntax used is ${:comment}.  Targets can override this to add support
1279 /// for their own strange codes.
1280 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1281   if (!strcmp(Code, "private")) {
1282     O << MAI->getPrivateGlobalPrefix();
1283   } else if (!strcmp(Code, "comment")) {
1284     if (VerboseAsm)
1285       O << MAI->getCommentString();
1286   } else if (!strcmp(Code, "uid")) {
1287     // Comparing the address of MI isn't sufficient, because machineinstrs may
1288     // be allocated to the same address across functions.
1289     const Function *ThisF = MI->getParent()->getParent()->getFunction();
1290
1291     // If this is a new LastFn instruction, bump the counter.
1292     if (LastMI != MI || LastFn != ThisF) {
1293       ++Counter;
1294       LastMI = MI;
1295       LastFn = ThisF;
1296     }
1297     O << Counter;
1298   } else {
1299     std::string msg;
1300     raw_string_ostream Msg(msg);
1301     Msg << "Unknown special formatter '" << Code
1302          << "' for machine instr: " << *MI;
1303     llvm_report_error(Msg.str());
1304   }
1305 }
1306
1307 /// processDebugLoc - Processes the debug information of each machine
1308 /// instruction's DebugLoc.
1309 void AsmPrinter::processDebugLoc(const MachineInstr *MI,
1310                                  bool BeforePrintingInsn) {
1311   if (!MAI || !DW || !MAI->doesSupportDebugInformation()
1312       || !DW->ShouldEmitDwarfDebug())
1313     return;
1314   DebugLoc DL = MI->getDebugLoc();
1315   if (DL.isUnknown())
1316     return;
1317   DILocation CurDLT = MF->getDILocation(DL);
1318   if (!CurDLT.getScope().Verify())
1319     return;
1320
1321   if (!BeforePrintingInsn) {
1322     // After printing instruction
1323     DW->EndScope(MI);
1324   } else if (CurDLT.getNode() != PrevDLT) {
1325     MCSymbol *L = DW->RecordSourceLine(CurDLT.getLineNumber(),
1326                                        CurDLT.getColumnNumber(),
1327                                        CurDLT.getScope().getNode());
1328     DW->BeginScope(MI, L);
1329     PrevDLT = CurDLT.getNode();
1330   }
1331 }
1332
1333
1334 /// printInlineAsm - This method formats and prints the specified machine
1335 /// instruction that is an inline asm.
1336 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1337   unsigned NumOperands = MI->getNumOperands();
1338
1339   // Count the number of register definitions.
1340   unsigned NumDefs = 0;
1341   for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1342        ++NumDefs)
1343     assert(NumDefs != NumOperands-1 && "No asm string?");
1344
1345   assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1346
1347   // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1348   const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1349
1350   O << '\t';
1351
1352   // If this asmstr is empty, just print the #APP/#NOAPP markers.
1353   // These are useful to see where empty asm's wound up.
1354   if (AsmStr[0] == 0) {
1355     O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1356     O << MAI->getCommentString() << MAI->getInlineAsmEnd() << '\n';
1357     return;
1358   }
1359
1360   O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1361
1362   // The variant of the current asmprinter.
1363   int AsmPrinterVariant = MAI->getAssemblerDialect();
1364
1365   int CurVariant = -1;            // The number of the {.|.|.} region we are in.
1366   const char *LastEmitted = AsmStr; // One past the last character emitted.
1367
1368   while (*LastEmitted) {
1369     switch (*LastEmitted) {
1370     default: {
1371       // Not a special case, emit the string section literally.
1372       const char *LiteralEnd = LastEmitted+1;
1373       while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1374              *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1375         ++LiteralEnd;
1376       if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1377         O.write(LastEmitted, LiteralEnd-LastEmitted);
1378       LastEmitted = LiteralEnd;
1379       break;
1380     }
1381     case '\n':
1382       ++LastEmitted;   // Consume newline character.
1383       O << '\n';       // Indent code with newline.
1384       break;
1385     case '$': {
1386       ++LastEmitted;   // Consume '$' character.
1387       bool Done = true;
1388
1389       // Handle escapes.
1390       switch (*LastEmitted) {
1391       default: Done = false; break;
1392       case '$':     // $$ -> $
1393         if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1394           O << '$';
1395         ++LastEmitted;  // Consume second '$' character.
1396         break;
1397       case '(':             // $( -> same as GCC's { character.
1398         ++LastEmitted;      // Consume '(' character.
1399         if (CurVariant != -1) {
1400           llvm_report_error("Nested variants found in inline asm string: '"
1401                             + std::string(AsmStr) + "'");
1402         }
1403         CurVariant = 0;     // We're in the first variant now.
1404         break;
1405       case '|':
1406         ++LastEmitted;  // consume '|' character.
1407         if (CurVariant == -1)
1408           O << '|';       // this is gcc's behavior for | outside a variant
1409         else
1410           ++CurVariant;   // We're in the next variant.
1411         break;
1412       case ')':         // $) -> same as GCC's } char.
1413         ++LastEmitted;  // consume ')' character.
1414         if (CurVariant == -1)
1415           O << '}';     // this is gcc's behavior for } outside a variant
1416         else
1417           CurVariant = -1;
1418         break;
1419       }
1420       if (Done) break;
1421
1422       bool HasCurlyBraces = false;
1423       if (*LastEmitted == '{') {     // ${variable}
1424         ++LastEmitted;               // Consume '{' character.
1425         HasCurlyBraces = true;
1426       }
1427
1428       // If we have ${:foo}, then this is not a real operand reference, it is a
1429       // "magic" string reference, just like in .td files.  Arrange to call
1430       // PrintSpecial.
1431       if (HasCurlyBraces && *LastEmitted == ':') {
1432         ++LastEmitted;
1433         const char *StrStart = LastEmitted;
1434         const char *StrEnd = strchr(StrStart, '}');
1435         if (StrEnd == 0) {
1436           llvm_report_error("Unterminated ${:foo} operand in inline asm string: '"
1437                             + std::string(AsmStr) + "'");
1438         }
1439
1440         std::string Val(StrStart, StrEnd);
1441         PrintSpecial(MI, Val.c_str());
1442         LastEmitted = StrEnd+1;
1443         break;
1444       }
1445
1446       const char *IDStart = LastEmitted;
1447       char *IDEnd;
1448       errno = 0;
1449       long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1450       if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1451         llvm_report_error("Bad $ operand number in inline asm string: '"
1452                           + std::string(AsmStr) + "'");
1453       }
1454       LastEmitted = IDEnd;
1455
1456       char Modifier[2] = { 0, 0 };
1457
1458       if (HasCurlyBraces) {
1459         // If we have curly braces, check for a modifier character.  This
1460         // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1461         if (*LastEmitted == ':') {
1462           ++LastEmitted;    // Consume ':' character.
1463           if (*LastEmitted == 0) {
1464             llvm_report_error("Bad ${:} expression in inline asm string: '"
1465                               + std::string(AsmStr) + "'");
1466           }
1467
1468           Modifier[0] = *LastEmitted;
1469           ++LastEmitted;    // Consume modifier character.
1470         }
1471
1472         if (*LastEmitted != '}') {
1473           llvm_report_error("Bad ${} expression in inline asm string: '"
1474                             + std::string(AsmStr) + "'");
1475         }
1476         ++LastEmitted;    // Consume '}' character.
1477       }
1478
1479       if ((unsigned)Val >= NumOperands-1) {
1480         llvm_report_error("Invalid $ operand number in inline asm string: '"
1481                           + std::string(AsmStr) + "'");
1482       }
1483
1484       // Okay, we finally have a value number.  Ask the target to print this
1485       // operand!
1486       if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1487         unsigned OpNo = 1;
1488
1489         bool Error = false;
1490
1491         // Scan to find the machine operand number for the operand.
1492         for (; Val; --Val) {
1493           if (OpNo >= MI->getNumOperands()) break;
1494           unsigned OpFlags = MI->getOperand(OpNo).getImm();
1495           OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1496         }
1497
1498         if (OpNo >= MI->getNumOperands()) {
1499           Error = true;
1500         } else {
1501           unsigned OpFlags = MI->getOperand(OpNo).getImm();
1502           ++OpNo;  // Skip over the ID number.
1503
1504           if (Modifier[0] == 'l')  // labels are target independent
1505             O << *MI->getOperand(OpNo).getMBB()->getSymbol(OutContext);
1506           else {
1507             AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1508             if ((OpFlags & 7) == 4) {
1509               Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1510                                                 Modifier[0] ? Modifier : 0);
1511             } else {
1512               Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1513                                           Modifier[0] ? Modifier : 0);
1514             }
1515           }
1516         }
1517         if (Error) {
1518           std::string msg;
1519           raw_string_ostream Msg(msg);
1520           Msg << "Invalid operand found in inline asm: '" << AsmStr << "'\n";
1521           MI->print(Msg);
1522           llvm_report_error(Msg.str());
1523         }
1524       }
1525       break;
1526     }
1527     }
1528   }
1529   O << "\n\t" << MAI->getCommentString() << MAI->getInlineAsmEnd();
1530   OutStreamer.AddBlankLine();
1531 }
1532
1533 /// printImplicitDef - This method prints the specified machine instruction
1534 /// that is an implicit def.
1535 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1536   if (!VerboseAsm) return;
1537   O.PadToColumn(MAI->getCommentColumn());
1538   O << MAI->getCommentString() << " implicit-def: "
1539     << TRI->getName(MI->getOperand(0).getReg());
1540   OutStreamer.AddBlankLine();
1541 }
1542
1543 void AsmPrinter::printKill(const MachineInstr *MI) const {
1544   if (!VerboseAsm) return;
1545   O.PadToColumn(MAI->getCommentColumn());
1546   O << MAI->getCommentString() << " kill:";
1547   for (unsigned n = 0, e = MI->getNumOperands(); n != e; ++n) {
1548     const MachineOperand &op = MI->getOperand(n);
1549     assert(op.isReg() && "KILL instruction must have only register operands");
1550     O << ' ' << TRI->getName(op.getReg()) << (op.isDef() ? "<def>" : "<kill>");
1551   }
1552   OutStreamer.AddBlankLine();
1553 }
1554
1555 /// printLabel - This method prints a local label used by debug and
1556 /// exception handling tables.
1557 void AsmPrinter::printLabelInst(const MachineInstr *MI) const {
1558   MCSymbol *Sym =
1559     OutContext.GetOrCreateTemporarySymbol(Twine(MAI->getPrivateGlobalPrefix()) +
1560                                  "label" + Twine(MI->getOperand(0).getImm()));
1561   OutStreamer.EmitLabel(Sym);
1562 }
1563
1564 void AsmPrinter::printLabel(unsigned Id) const {
1565   MCSymbol *Sym =
1566     OutContext.GetOrCreateTemporarySymbol(Twine(MAI->getPrivateGlobalPrefix()) +
1567                                           "label" + Twine(Id));
1568   OutStreamer.EmitLabel(Sym);
1569 }
1570
1571 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1572 /// instruction, using the specified assembler variant.  Targets should
1573 /// override this to format as appropriate.
1574 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1575                                  unsigned AsmVariant, const char *ExtraCode) {
1576   // Target doesn't support this yet!
1577   return true;
1578 }
1579
1580 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1581                                        unsigned AsmVariant,
1582                                        const char *ExtraCode) {
1583   // Target doesn't support this yet!
1584   return true;
1585 }
1586
1587 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
1588   return GetBlockAddressSymbol(BA->getFunction(), BA->getBasicBlock());
1589 }
1590
1591 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const Function *F,
1592                                             const BasicBlock *BB) const {
1593   assert(BB->hasName() &&
1594          "Address of anonymous basic block not supported yet!");
1595
1596   // This code must use the function name itself, and not the function number,
1597   // since it must be possible to generate the label name from within other
1598   // functions.
1599   SmallString<60> FnName;
1600   Mang->getNameWithPrefix(FnName, F, false);
1601
1602   // FIXME: THIS IS BROKEN IF THE LLVM BASIC BLOCK DOESN'T HAVE A NAME!
1603   SmallString<60> NameResult;
1604   Mang->getNameWithPrefix(NameResult,
1605                           StringRef("BA") + Twine((unsigned)FnName.size()) +
1606                           "_" + FnName.str() + "_" + BB->getName(),
1607                           Mangler::Private);
1608
1609   return OutContext.GetOrCreateTemporarySymbol(NameResult.str());
1610 }
1611
1612 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
1613 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
1614   return OutContext.GetOrCreateTemporarySymbol
1615     (Twine(MAI->getPrivateGlobalPrefix()) + "CPI" + Twine(getFunctionNumber())
1616      + "_" + Twine(CPID));
1617 }
1618
1619 /// GetJTISymbol - Return the symbol for the specified jump table entry.
1620 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
1621   return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
1622 }
1623
1624 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
1625 /// FIXME: privatize to AsmPrinter.
1626 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
1627   return OutContext.GetOrCreateTemporarySymbol
1628   (Twine(MAI->getPrivateGlobalPrefix()) + Twine(getFunctionNumber()) + "_" +
1629    Twine(UID) + "_set_" + Twine(MBBID));
1630 }
1631
1632 /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
1633 /// value.
1634 MCSymbol *AsmPrinter::GetGlobalValueSymbol(const GlobalValue *GV) const {
1635   SmallString<60> NameStr;
1636   Mang->getNameWithPrefix(NameStr, GV, false);
1637
1638   if (!GV->hasPrivateLinkage())
1639     return OutContext.GetOrCreateSymbol(NameStr.str());
1640   return OutContext.GetOrCreateTemporarySymbol(NameStr.str());
1641 }
1642
1643 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1644 /// global value name as its base, with the specified suffix, and where the
1645 /// symbol is forced to have private linkage if ForcePrivate is true.
1646 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1647                                                    StringRef Suffix,
1648                                                    bool ForcePrivate) const {
1649   SmallString<60> NameStr;
1650   Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
1651   NameStr.append(Suffix.begin(), Suffix.end());
1652   if (!GV->hasPrivateLinkage() && !ForcePrivate)
1653     return OutContext.GetOrCreateSymbol(NameStr.str());
1654   return OutContext.GetOrCreateTemporarySymbol(NameStr.str());
1655 }
1656
1657 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
1658 /// ExternalSymbol.
1659 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
1660   SmallString<60> NameStr;
1661   Mang->getNameWithPrefix(NameStr, Sym);
1662   return OutContext.GetOrCreateSymbol(NameStr.str());
1663 }
1664
1665
1666
1667 /// PrintParentLoopComment - Print comments about parent loops of this one.
1668 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1669                                    unsigned FunctionNumber) {
1670   if (Loop == 0) return;
1671   PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
1672   OS.indent(Loop->getLoopDepth()*2)
1673     << "Parent Loop BB" << FunctionNumber << "_"
1674     << Loop->getHeader()->getNumber()
1675     << " Depth=" << Loop->getLoopDepth() << '\n';
1676 }
1677
1678
1679 /// PrintChildLoopComment - Print comments about child loops within
1680 /// the loop for this basic block, with nesting.
1681 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1682                                   unsigned FunctionNumber) {
1683   // Add child loop information
1684   for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
1685     OS.indent((*CL)->getLoopDepth()*2)
1686       << "Child Loop BB" << FunctionNumber << "_"
1687       << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
1688       << '\n';
1689     PrintChildLoopComment(OS, *CL, FunctionNumber);
1690   }
1691 }
1692
1693 /// PrintBasicBlockLoopComments - Pretty-print comments for basic blocks.
1694 static void PrintBasicBlockLoopComments(const MachineBasicBlock &MBB,
1695                                         const MachineLoopInfo *LI,
1696                                         const AsmPrinter &AP) {
1697   // Add loop depth information
1698   const MachineLoop *Loop = LI->getLoopFor(&MBB);
1699   if (Loop == 0) return;
1700
1701   MachineBasicBlock *Header = Loop->getHeader();
1702   assert(Header && "No header for loop");
1703
1704   // If this block is not a loop header, just print out what is the loop header
1705   // and return.
1706   if (Header != &MBB) {
1707     AP.OutStreamer.AddComment("  in Loop: Header=BB" +
1708                               Twine(AP.getFunctionNumber())+"_" +
1709                               Twine(Loop->getHeader()->getNumber())+
1710                               " Depth="+Twine(Loop->getLoopDepth()));
1711     return;
1712   }
1713
1714   // Otherwise, it is a loop header.  Print out information about child and
1715   // parent loops.
1716   raw_ostream &OS = AP.OutStreamer.GetCommentOS();
1717
1718   PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
1719
1720   OS << "=>";
1721   OS.indent(Loop->getLoopDepth()*2-2);
1722
1723   OS << "This ";
1724   if (Loop->empty())
1725     OS << "Inner ";
1726   OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
1727
1728   PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
1729 }
1730
1731
1732 /// EmitBasicBlockStart - This method prints the label for the specified
1733 /// MachineBasicBlock, an alignment (if present) and a comment describing
1734 /// it if appropriate.
1735 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1736   // Emit an alignment directive for this block, if needed.
1737   if (unsigned Align = MBB->getAlignment())
1738     EmitAlignment(Log2_32(Align));
1739
1740   // If the block has its address taken, emit a special label to satisfy
1741   // references to the block. This is done so that we don't need to
1742   // remember the number of this label, and so that we can make
1743   // forward references to labels without knowing what their numbers
1744   // will be.
1745   if (MBB->hasAddressTaken()) {
1746     const BasicBlock *BB = MBB->getBasicBlock();
1747     if (VerboseAsm)
1748       OutStreamer.AddComment("Address Taken");
1749     OutStreamer.EmitLabel(GetBlockAddressSymbol(BB->getParent(), BB));
1750   }
1751
1752   // Print the main label for the block.
1753   if (MBB->pred_empty() || isBlockOnlyReachableByFallthrough(MBB)) {
1754     if (VerboseAsm) {
1755       // NOTE: Want this comment at start of line.
1756       O << MAI->getCommentString() << " BB#" << MBB->getNumber() << ':';
1757       if (const BasicBlock *BB = MBB->getBasicBlock())
1758         if (BB->hasName())
1759           OutStreamer.AddComment("%" + BB->getName());
1760
1761       PrintBasicBlockLoopComments(*MBB, LI, *this);
1762       OutStreamer.AddBlankLine();
1763     }
1764   } else {
1765     if (VerboseAsm) {
1766       if (const BasicBlock *BB = MBB->getBasicBlock())
1767         if (BB->hasName())
1768           OutStreamer.AddComment("%" + BB->getName());
1769       PrintBasicBlockLoopComments(*MBB, LI, *this);
1770     }
1771
1772     OutStreamer.EmitLabel(MBB->getSymbol(OutContext));
1773   }
1774 }
1775
1776 void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility) const {
1777   MCSymbolAttr Attr = MCSA_Invalid;
1778
1779   switch (Visibility) {
1780   default: break;
1781   case GlobalValue::HiddenVisibility:
1782     Attr = MAI->getHiddenVisibilityAttr();
1783     break;
1784   case GlobalValue::ProtectedVisibility:
1785     Attr = MAI->getProtectedVisibilityAttr();
1786     break;
1787   }
1788
1789   if (Attr != MCSA_Invalid)
1790     OutStreamer.EmitSymbolAttribute(Sym, Attr);
1791 }
1792
1793 void AsmPrinter::printOffset(int64_t Offset) const {
1794   if (Offset > 0)
1795     O << '+' << Offset;
1796   else if (Offset < 0)
1797     O << Offset;
1798 }
1799
1800 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
1801 /// exactly one predecessor and the control transfer mechanism between
1802 /// the predecessor and this block is a fall-through.
1803 bool AsmPrinter::isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB)
1804     const {
1805   // If this is a landing pad, it isn't a fall through.  If it has no preds,
1806   // then nothing falls through to it.
1807   if (MBB->isLandingPad() || MBB->pred_empty())
1808     return false;
1809
1810   // If there isn't exactly one predecessor, it can't be a fall through.
1811   MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(), PI2 = PI;
1812   ++PI2;
1813   if (PI2 != MBB->pred_end())
1814     return false;
1815
1816   // The predecessor has to be immediately before this block.
1817   const MachineBasicBlock *Pred = *PI;
1818
1819   if (!Pred->isLayoutSuccessor(MBB))
1820     return false;
1821
1822   // If the block is completely empty, then it definitely does fall through.
1823   if (Pred->empty())
1824     return true;
1825
1826   // Otherwise, check the last instruction.
1827   const MachineInstr &LastInst = Pred->back();
1828   return !LastInst.getDesc().isBarrier();
1829 }
1830
1831
1832
1833 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1834   if (!S->usesMetadata())
1835     return 0;
1836
1837   gcp_iterator GCPI = GCMetadataPrinters.find(S);
1838   if (GCPI != GCMetadataPrinters.end())
1839     return GCPI->second;
1840
1841   const char *Name = S->getName().c_str();
1842
1843   for (GCMetadataPrinterRegistry::iterator
1844          I = GCMetadataPrinterRegistry::begin(),
1845          E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1846     if (strcmp(Name, I->getName()) == 0) {
1847       GCMetadataPrinter *GMP = I->instantiate();
1848       GMP->S = S;
1849       GCMetadataPrinters.insert(std::make_pair(S, GMP));
1850       return GMP;
1851     }
1852
1853   llvm_report_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
1854   return 0;
1855 }
1856