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, *TM.getTargetData());
 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 = Mang->getSymbol(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(Mang->getSymbol(I), MCSA_WeakReference);
 481     }
 482
 483     for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I) {
 484       if (!I->hasExternalWeakLinkage()) continue;
 485       OutStreamer.EmitSymbolAttribute(Mang->getSymbol(I), MCSA_WeakReference);
 486     }
 487   }
 488
 489   if (MAI->hasSetDirective()) {
 490     OutStreamer.AddBlankLine();
 491     for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
 492          I != E; ++I) {
 493       MCSymbol *Name = Mang->getSymbol(I);
 494
 495       const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
 496       MCSymbol *Target = Mang->getSymbol(GV);
 497
 498       if (I->hasExternalLinkage() || !MAI->getWeakRefDirective())
 499         OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
 500       else if (I->hasWeakLinkage())
 501         OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
 502       else
 503         assert(I->hasLocalLinkage() && "Invalid alias linkage");
 504
 505       EmitVisibility(Name, I->getVisibility());
 506
 507       // Emit the directives as assignments aka .set:
 508       OutStreamer.EmitAssignment(Name,
 509                                  MCSymbolRefExpr::Create(Target, OutContext));
 510     }
 511   }
 512
 513   GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
 514   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
 515   for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
 516     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
 517       MP->finishAssembly(O, *this, *MAI);
 518
 519   // If we don't have any trampolines, then we don't require stack memory
 520   // to be executable. Some targets have a directive to declare this.
 521   Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
 522   if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
 523     if (MCSection *S = MAI->getNonexecutableStackSection(OutContext))
 524       OutStreamer.SwitchSection(S);
 525
 526   // Allow the target to emit any magic that it wants at the end of the file,
 527   // after everything else has gone out.
 528   EmitEndOfAsmFile(M);
 529
 530   delete Mang; Mang = 0;
 531   DW = 0; MMI = 0;
 532
 533   OutStreamer.Finish();
 534   return false;
 535 }
 536
 537 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
 538   this->MF = &MF;
 539   // Get the function symbol.
 540   CurrentFnSym = Mang->getSymbol(MF.getFunction());
 541
 542   if (VerboseAsm)
 543     LI = &getAnalysis<MachineLoopInfo>();
 544 }
 545
 546 namespace {
 547   // SectionCPs - Keep track the alignment, constpool entries per Section.
 548   struct SectionCPs {
 549     const MCSection *S;
 550     unsigned Alignment;
 551     SmallVector<unsigned, 4> CPEs;
 552     SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
 553   };
 554 }
 555
 556 /// EmitConstantPool - Print to the current output stream assembly
 557 /// representations of the constants in the constant pool MCP. This is
 558 /// used to print out constants which have been "spilled to memory" by
 559 /// the code generator.
 560 ///
 561 void AsmPrinter::EmitConstantPool() {
 562   const MachineConstantPool *MCP = MF->getConstantPool();
 563   const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
 564   if (CP.empty()) return;
 565
 566   // Calculate sections for constant pool entries. We collect entries to go into
 567   // the same section together to reduce amount of section switch statements.
 568   SmallVector<SectionCPs, 4> CPSections;
 569   for (unsigned i = 0, e = CP.size(); i != e; ++i) {
 570     const MachineConstantPoolEntry &CPE = CP[i];
 571     unsigned Align = CPE.getAlignment();
 572
 573     SectionKind Kind;
 574     switch (CPE.getRelocationInfo()) {
 575     default: llvm_unreachable("Unknown section kind");
 576     case 2: Kind = SectionKind::getReadOnlyWithRel(); break;
 577     case 1:
 578       Kind = SectionKind::getReadOnlyWithRelLocal();
 579       break;
 580     case 0:
 581     switch (TM.getTargetData()->getTypeAllocSize(CPE.getType())) {
 582     case 4:  Kind = SectionKind::getMergeableConst4(); break;
 583     case 8:  Kind = SectionKind::getMergeableConst8(); break;
 584     case 16: Kind = SectionKind::getMergeableConst16();break;
 585     default: Kind = SectionKind::getMergeableConst(); break;
 586     }
 587     }
 588
 589     const MCSection *S = getObjFileLowering().getSectionForConstant(Kind);
 590
 591     // The number of sections are small, just do a linear search from the
 592     // last section to the first.
 593     bool Found = false;
 594     unsigned SecIdx = CPSections.size();
 595     while (SecIdx != 0) {
 596       if (CPSections[--SecIdx].S == S) {
 597         Found = true;
 598         break;
 599       }
 600     }
 601     if (!Found) {
 602       SecIdx = CPSections.size();
 603       CPSections.push_back(SectionCPs(S, Align));
 604     }
 605
 606     if (Align > CPSections[SecIdx].Alignment)
 607       CPSections[SecIdx].Alignment = Align;
 608     CPSections[SecIdx].CPEs.push_back(i);
 609   }
 610
 611   // Now print stuff into the calculated sections.
 612   for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
 613     OutStreamer.SwitchSection(CPSections[i].S);
 614     EmitAlignment(Log2_32(CPSections[i].Alignment));
 615
 616     unsigned Offset = 0;
 617     for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
 618       unsigned CPI = CPSections[i].CPEs[j];
 619       MachineConstantPoolEntry CPE = CP[CPI];
 620
 621       // Emit inter-object padding for alignment.
 622       unsigned AlignMask = CPE.getAlignment() - 1;
 623       unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
 624       OutStreamer.EmitFill(NewOffset - Offset, 0/*fillval*/, 0/*addrspace*/);
 625
 626       const Type *Ty = CPE.getType();
 627       Offset = NewOffset + TM.getTargetData()->getTypeAllocSize(Ty);
 628
 629       // Emit the label with a comment on it.
 630       if (VerboseAsm) {
 631         OutStreamer.GetCommentOS() << "constant pool ";
 632         WriteTypeSymbolic(OutStreamer.GetCommentOS(), CPE.getType(),
 633                           MF->getFunction()->getParent());
 634         OutStreamer.GetCommentOS() << '\n';
 635       }
 636       OutStreamer.EmitLabel(GetCPISymbol(CPI));
 637
 638       if (CPE.isMachineConstantPoolEntry())
 639         EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
 640       else
 641         EmitGlobalConstant(CPE.Val.ConstVal);
 642     }
 643   }
 644 }
 645
 646 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
 647 /// by the current function to the current output stream.
 648 ///
 649 void AsmPrinter::EmitJumpTableInfo() {
 650   const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
 651   if (MJTI == 0) return;
 652   if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return;
 653   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
 654   if (JT.empty()) return;
 655
 656   // Pick the directive to use to print the jump table entries, and switch to
 657   // the appropriate section.
 658   const Function *F = MF->getFunction();
 659   bool JTInDiffSection = false;
 660   if (// In PIC mode, we need to emit the jump table to the same section as the
 661       // function body itself, otherwise the label differences won't make sense.
 662       // FIXME: Need a better predicate for this: what about custom entries?
 663       MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 ||
 664       // We should also do if the section name is NULL or function is declared
 665       // in discardable section
 666       // FIXME: this isn't the right predicate, should be based on the MCSection
 667       // for the function.
 668       F->isWeakForLinker()) {
 669     OutStreamer.SwitchSection(getObjFileLowering().SectionForGlobal(F,Mang,TM));
 670   } else {
 671     // Otherwise, drop it in the readonly section.
 672     const MCSection *ReadOnlySection =
 673       getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly());
 674     OutStreamer.SwitchSection(ReadOnlySection);
 675     JTInDiffSection = true;
 676   }
 677
 678   EmitAlignment(Log2_32(MJTI->getEntryAlignment(*TM.getTargetData())));
 679
 680   for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
 681     const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
 682
 683     // If this jump table was deleted, ignore it.
 684     if (JTBBs.empty()) continue;
 685
 686     // For the EK_LabelDifference32 entry, if the target supports .set, emit a
 687     // .set directive for each unique entry.  This reduces the number of
 688     // relocations the assembler will generate for the jump table.
 689     if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
 690         MAI->hasSetDirective()) {
 691       SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
 692       const TargetLowering *TLI = TM.getTargetLowering();
 693       const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext);
 694       for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
 695         const MachineBasicBlock *MBB = JTBBs[ii];
 696         if (!EmittedSets.insert(MBB)) continue;
 697
 698         // .set LJTSet, LBB32-base
 699         const MCExpr *LHS =
 700           MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
 701         OutStreamer.EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
 702                                 MCBinaryExpr::CreateSub(LHS, Base, OutContext));
 703       }
 704     }
 705
 706     // On some targets (e.g. Darwin) we want to emit two consequtive labels
 707     // before each jump table.  The first label is never referenced, but tells
 708     // the assembler and linker the extents of the jump table object.  The
 709     // second label is actually referenced by the code.
 710     if (JTInDiffSection && MAI->getLinkerPrivateGlobalPrefix()[0])
 711       // FIXME: This doesn't have to have any specific name, just any randomly
 712       // named and numbered 'l' label would work.  Simplify GetJTISymbol.
 713       OutStreamer.EmitLabel(GetJTISymbol(JTI, true));
 714
 715     OutStreamer.EmitLabel(GetJTISymbol(JTI));
 716
 717     for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
 718       EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
 719   }
 720 }
 721
 722 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
 723 /// current stream.
 724 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
 725                                     const MachineBasicBlock *MBB,
 726                                     unsigned UID) const {
 727   const MCExpr *Value = 0;
 728   switch (MJTI->getEntryKind()) {
 729   case MachineJumpTableInfo::EK_Inline:
 730     llvm_unreachable("Cannot emit EK_Inline jump table entry"); break;
 731   case MachineJumpTableInfo::EK_Custom32:
 732     Value = TM.getTargetLowering()->LowerCustomJumpTableEntry(MJTI, MBB, UID,
 733                                                               OutContext);
 734     break;
 735   case MachineJumpTableInfo::EK_BlockAddress:
 736     // EK_BlockAddress - Each entry is a plain address of block, e.g.:
 737     //     .word LBB123
 738     Value = MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
 739     break;
 740   case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
 741     // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
 742     // with a relocation as gp-relative, e.g.:
 743     //     .gprel32 LBB123
 744     MCSymbol *MBBSym = MBB->getSymbol(OutContext);
 745     OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
 746     return;
 747   }
 748
 749   case MachineJumpTableInfo::EK_LabelDifference32: {
 750     // EK_LabelDifference32 - Each entry is the address of the block minus
 751     // the address of the jump table.  This is used for PIC jump tables where
 752     // gprel32 is not supported.  e.g.:
 753     //      .word LBB123 - LJTI1_2
 754     // If the .set directive is supported, this is emitted as:
 755     //      .set L4_5_set_123, LBB123 - LJTI1_2
 756     //      .word L4_5_set_123
 757
 758     // If we have emitted set directives for the jump table entries, print
 759     // them rather than the entries themselves.  If we're emitting PIC, then
 760     // emit the table entries as differences between two text section labels.
 761     if (MAI->hasSetDirective()) {
 762       // If we used .set, reference the .set's symbol.
 763       Value = MCSymbolRefExpr::Create(GetJTSetSymbol(UID, MBB->getNumber()),
 764                                       OutContext);
 765       break;
 766     }
 767     // Otherwise, use the difference as the jump table entry.
 768     Value = MCSymbolRefExpr::Create(MBB->getSymbol(OutContext), OutContext);
 769     const MCExpr *JTI = MCSymbolRefExpr::Create(GetJTISymbol(UID), OutContext);
 770     Value = MCBinaryExpr::CreateSub(Value, JTI, OutContext);
 771     break;
 772   }
 773   }
 774
 775   assert(Value && "Unknown entry kind!");
 776
 777   unsigned EntrySize = MJTI->getEntrySize(*TM.getTargetData());
 778   OutStreamer.EmitValue(Value, EntrySize, /*addrspace*/0);
 779 }
 780
 781
 782 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
 783 /// special global used by LLVM.  If so, emit it and return true, otherwise
 784 /// do nothing and return false.
 785 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
 786   if (GV->getName() == "llvm.used") {
 787     if (MAI->hasNoDeadStrip())    // No need to emit this at all.
 788       EmitLLVMUsedList(GV->getInitializer());
 789     return true;
 790   }
 791
 792   // Ignore debug and non-emitted data.  This handles llvm.compiler.used.
 793   if (GV->getSection() == "llvm.metadata" ||
 794       GV->hasAvailableExternallyLinkage())
 795     return true;
 796
 797   if (!GV->hasAppendingLinkage()) return false;
 798
 799   assert(GV->hasInitializer() && "Not a special LLVM global!");
 800
 801   const TargetData *TD = TM.getTargetData();
 802   unsigned Align = Log2_32(TD->getPointerPrefAlignment());
 803   if (GV->getName() == "llvm.global_ctors") {
 804     OutStreamer.SwitchSection(getObjFileLowering().getStaticCtorSection());
 805     EmitAlignment(Align, 0);
 806     EmitXXStructorList(GV->getInitializer());
 807
 808     if (TM.getRelocationModel() == Reloc::Static &&
 809         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
 810       StringRef Sym(".constructors_used");
 811       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
 812                                       MCSA_Reference);
 813     }
 814     return true;
 815   }
 816
 817   if (GV->getName() == "llvm.global_dtors") {
 818     OutStreamer.SwitchSection(getObjFileLowering().getStaticDtorSection());
 819     EmitAlignment(Align, 0);
 820     EmitXXStructorList(GV->getInitializer());
 821
 822     if (TM.getRelocationModel() == Reloc::Static &&
 823         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
 824       StringRef Sym(".destructors_used");
 825       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
 826                                       MCSA_Reference);
 827     }
 828     return true;
 829   }
 830
 831   return false;
 832 }
 833
 834 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
 835 /// global in the specified llvm.used list for which emitUsedDirectiveFor
 836 /// is true, as being used with this directive.
 837 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
 838   // Should be an array of 'i8*'.
 839   ConstantArray *InitList = dyn_cast<ConstantArray>(List);
 840   if (InitList == 0) return;
 841
 842   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
 843     const GlobalValue *GV =
 844       dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
 845     if (GV && getObjFileLowering().shouldEmitUsedDirectiveFor(GV, Mang))
 846       OutStreamer.EmitSymbolAttribute(Mang->getSymbol(GV), MCSA_NoDeadStrip);
 847   }
 848 }
 849
 850 /// EmitXXStructorList - Emit the ctor or dtor list.  This just prints out the
 851 /// function pointers, ignoring the init priority.
 852 void AsmPrinter::EmitXXStructorList(Constant *List) {
 853   // Should be an array of '{ int, void ()* }' structs.  The first value is the
 854   // init priority, which we ignore.
 855   if (!isa<ConstantArray>(List)) return;
 856   ConstantArray *InitList = cast<ConstantArray>(List);
 857   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
 858     if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
 859       if (CS->getNumOperands() != 2) return;  // Not array of 2-element structs.
 860
 861       if (CS->getOperand(1)->isNullValue())
 862         return;  // Found a null terminator, exit printing.
 863       // Emit the function pointer.
 864       EmitGlobalConstant(CS->getOperand(1));
 865     }
 866 }
 867
 868 //===--------------------------------------------------------------------===//
 869 // Emission and print routines
 870 //
 871
 872 /// EmitInt8 - Emit a byte directive and value.
 873 ///
 874 void AsmPrinter::EmitInt8(int Value) const {
 875   OutStreamer.EmitIntValue(Value, 1, 0/*addrspace*/);
 876 }
 877
 878 /// EmitInt16 - Emit a short directive and value.
 879 ///
 880 void AsmPrinter::EmitInt16(int Value) const {
 881   OutStreamer.EmitIntValue(Value, 2, 0/*addrspace*/);
 882 }
 883
 884 /// EmitInt32 - Emit a long directive and value.
 885 ///
 886 void AsmPrinter::EmitInt32(int Value) const {
 887   OutStreamer.EmitIntValue(Value, 4, 0/*addrspace*/);
 888 }
 889
 890 /// EmitInt64 - Emit a long long directive and value.
 891 ///
 892 void AsmPrinter::EmitInt64(uint64_t Value) const {
 893   OutStreamer.EmitIntValue(Value, 8, 0/*addrspace*/);
 894 }
 895
 896 /// EmitLabelDifference - Emit something like ".long Hi-Lo" where the size
 897 /// in bytes of the directive is specified by Size and Hi/Lo specify the
 898 /// labels.  This implicitly uses .set if it is available.
 899 void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
 900                                      unsigned Size) const {
 901   // Get the Hi-Lo expression.
 902   const MCExpr *Diff =
 903     MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(Hi, OutContext),
 904                             MCSymbolRefExpr::Create(Lo, OutContext),
 905                             OutContext);
 906
 907   if (!MAI->hasSetDirective()) {
 908     OutStreamer.EmitValue(Diff, Size, 0/*AddrSpace*/);
 909     return;
 910   }
 911
 912   // Otherwise, emit with .set (aka assignment).
 913   MCSymbol *SetLabel =
 914     OutContext.GetOrCreateTemporarySymbol(Twine(MAI->getPrivateGlobalPrefix()) +
 915                                           "set" + Twine(SetCounter++));
 916   OutStreamer.EmitAssignment(SetLabel, Diff);
 917   OutStreamer.EmitSymbolValue(SetLabel, Size, 0/*AddrSpace*/);
 918 }
 919
 920
 921 //===----------------------------------------------------------------------===//
 922
 923 // EmitAlignment - Emit an alignment directive to the specified power of
 924 // two boundary.  For example, if you pass in 3 here, you will get an 8
 925 // byte alignment.  If a global value is specified, and if that global has
 926 // an explicit alignment requested, it will unconditionally override the
 927 // alignment request.  However, if ForcedAlignBits is specified, this value
 928 // has final say: the ultimate alignment will be the max of ForcedAlignBits
 929 // and the alignment computed with NumBits and the global.
 930 //
 931 // The algorithm is:
 932 //     Align = NumBits;
 933 //     if (GV && GV->hasalignment) Align = GV->getalignment();
 934 //     Align = std::max(Align, ForcedAlignBits);
 935 //
 936 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
 937                                unsigned ForcedAlignBits,
 938                                bool UseFillExpr) const {
 939   if (GV && GV->getAlignment())
 940     NumBits = Log2_32(GV->getAlignment());
 941   NumBits = std::max(NumBits, ForcedAlignBits);
 942
 943   if (NumBits == 0) return;   // No need to emit alignment.
 944
 945   if (getCurrentSection()->getKind().isText())
 946     OutStreamer.EmitCodeAlignment(1 << NumBits);
 947   else
 948     OutStreamer.EmitValueToAlignment(1 << NumBits, 0, 1, 0);
 949 }
 950
 951 /// LowerConstant - Lower the specified LLVM Constant to an MCExpr.
 952 ///
 953 static const MCExpr *LowerConstant(const Constant *CV, AsmPrinter &AP) {
 954   MCContext &Ctx = AP.OutContext;
 955
 956   if (CV->isNullValue() || isa<UndefValue>(CV))
 957     return MCConstantExpr::Create(0, Ctx);
 958
 959   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
 960     return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
 961
 962   if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
 963     return MCSymbolRefExpr::Create(AP.Mang->getSymbol(GV), Ctx);
 964   if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
 965     return MCSymbolRefExpr::Create(AP.GetBlockAddressSymbol(BA), Ctx);
 966
 967   const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
 968   if (CE == 0) {
 969     llvm_unreachable("Unknown constant value to lower!");
 970     return MCConstantExpr::Create(0, Ctx);
 971   }
 972
 973   switch (CE->getOpcode()) {
 974   default:
 975     // If the code isn't optimized, there may be outstanding folding
 976     // opportunities. Attempt to fold the expression using TargetData as a
 977     // last resort before giving up.
 978     if (Constant *C =
 979           ConstantFoldConstantExpression(CE, AP.TM.getTargetData()))
 980       if (C != CE)
 981         return LowerConstant(C, AP);
 982 #ifndef NDEBUG
 983     CE->dump();
 984 #endif
 985     llvm_unreachable("FIXME: Don't support this constant expr");
 986   case Instruction::GetElementPtr: {
 987     const TargetData &TD = *AP.TM.getTargetData();
 988     // Generate a symbolic expression for the byte address
 989     const Constant *PtrVal = CE->getOperand(0);
 990     SmallVector<Value*, 8> IdxVec(CE->op_begin()+1, CE->op_end());
 991     int64_t Offset = TD.getIndexedOffset(PtrVal->getType(), &IdxVec[0],
 992                                          IdxVec.size());
 993
 994     const MCExpr *Base = LowerConstant(CE->getOperand(0), AP);
 995     if (Offset == 0)
 996       return Base;
 997
 998     // Truncate/sext the offset to the pointer size.
 999     if (TD.getPointerSizeInBits() != 64) {
1000       int SExtAmount = 64-TD.getPointerSizeInBits();
1001       Offset = (Offset << SExtAmount) >> SExtAmount;
1002     }
1003
1004     return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
1005                                    Ctx);
1006   }
1007
1008   case Instruction::Trunc:
1009     // We emit the value and depend on the assembler to truncate the generated
1010     // expression properly.  This is important for differences between
1011     // blockaddress labels.  Since the two labels are in the same function, it
1012     // is reasonable to treat their delta as a 32-bit value.
1013     // FALL THROUGH.
1014   case Instruction::BitCast:
1015     return LowerConstant(CE->getOperand(0), AP);
1016
1017   case Instruction::IntToPtr: {
1018     const TargetData &TD = *AP.TM.getTargetData();
1019     // Handle casts to pointers by changing them into casts to the appropriate
1020     // integer type.  This promotes constant folding and simplifies this code.
1021     Constant *Op = CE->getOperand(0);
1022     Op = ConstantExpr::getIntegerCast(Op, TD.getIntPtrType(CV->getContext()),
1023                                       false/*ZExt*/);
1024     return LowerConstant(Op, AP);
1025   }
1026
1027   case Instruction::PtrToInt: {
1028     const TargetData &TD = *AP.TM.getTargetData();
1029     // Support only foldable casts to/from pointers that can be eliminated by
1030     // changing the pointer to the appropriately sized integer type.
1031     Constant *Op = CE->getOperand(0);
1032     const Type *Ty = CE->getType();
1033
1034     const MCExpr *OpExpr = LowerConstant(Op, AP);
1035
1036     // We can emit the pointer value into this slot if the slot is an
1037     // integer slot equal to the size of the pointer.
1038     if (TD.getTypeAllocSize(Ty) == TD.getTypeAllocSize(Op->getType()))
1039       return OpExpr;
1040
1041     // Otherwise the pointer is smaller than the resultant integer, mask off
1042     // the high bits so we are sure to get a proper truncation if the input is
1043     // a constant expr.
1044     unsigned InBits = TD.getTypeAllocSizeInBits(Op->getType());
1045     const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
1046     return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
1047   }
1048
1049   // The MC library also has a right-shift operator, but it isn't consistently
1050   // signed or unsigned between different targets.
1051   case Instruction::Add:
1052   case Instruction::Sub:
1053   case Instruction::Mul:
1054   case Instruction::SDiv:
1055   case Instruction::SRem:
1056   case Instruction::Shl:
1057   case Instruction::And:
1058   case Instruction::Or:
1059   case Instruction::Xor: {
1060     const MCExpr *LHS = LowerConstant(CE->getOperand(0), AP);
1061     const MCExpr *RHS = LowerConstant(CE->getOperand(1), AP);
1062     switch (CE->getOpcode()) {
1063     default: llvm_unreachable("Unknown binary operator constant cast expr");
1064     case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
1065     case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
1066     case Instruction::Mul: return MCBinaryExpr::CreateMul(LHS, RHS, Ctx);
1067     case Instruction::SDiv: return MCBinaryExpr::CreateDiv(LHS, RHS, Ctx);
1068     case Instruction::SRem: return MCBinaryExpr::CreateMod(LHS, RHS, Ctx);
1069     case Instruction::Shl: return MCBinaryExpr::CreateShl(LHS, RHS, Ctx);
1070     case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
1071     case Instruction::Or:  return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
1072     case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
1073     }
1074   }
1075   }
1076 }
1077
1078 static void EmitGlobalConstantArray(const ConstantArray *CA, unsigned AddrSpace,
1079                                     AsmPrinter &AP) {
1080   if (AddrSpace != 0 || !CA->isString()) {
1081     // Not a string.  Print the values in successive locations
1082     for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1083       AP.EmitGlobalConstant(CA->getOperand(i), AddrSpace);
1084     return;
1085   }
1086
1087   // Otherwise, it can be emitted as .ascii.
1088   SmallVector<char, 128> TmpVec;
1089   TmpVec.reserve(CA->getNumOperands());
1090   for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1091     TmpVec.push_back(cast<ConstantInt>(CA->getOperand(i))->getZExtValue());
1092
1093   AP.OutStreamer.EmitBytes(StringRef(TmpVec.data(), TmpVec.size()), AddrSpace);
1094 }
1095
1096 static void EmitGlobalConstantVector(const ConstantVector *CV,
1097                                      unsigned AddrSpace, AsmPrinter &AP) {
1098   for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
1099     AP.EmitGlobalConstant(CV->getOperand(i), AddrSpace);
1100 }
1101
1102 static void EmitGlobalConstantStruct(const ConstantStruct *CS,
1103                                      unsigned AddrSpace, AsmPrinter &AP) {
1104   // Print the fields in successive locations. Pad to align if needed!
1105   const TargetData *TD = AP.TM.getTargetData();
1106   unsigned Size = TD->getTypeAllocSize(CS->getType());
1107   const StructLayout *Layout = TD->getStructLayout(CS->getType());
1108   uint64_t SizeSoFar = 0;
1109   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
1110     const Constant *Field = CS->getOperand(i);
1111
1112     // Check if padding is needed and insert one or more 0s.
1113     uint64_t FieldSize = TD->getTypeAllocSize(Field->getType());
1114     uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
1115                         - Layout->getElementOffset(i)) - FieldSize;
1116     SizeSoFar += FieldSize + PadSize;
1117
1118     // Now print the actual field value.
1119     AP.EmitGlobalConstant(Field, AddrSpace);
1120
1121     // Insert padding - this may include padding to increase the size of the
1122     // current field up to the ABI size (if the struct is not packed) as well
1123     // as padding to ensure that the next field starts at the right offset.
1124     AP.OutStreamer.EmitZeros(PadSize, AddrSpace);
1125   }
1126   assert(SizeSoFar == Layout->getSizeInBytes() &&
1127          "Layout of constant struct may be incorrect!");
1128 }
1129
1130 static void EmitGlobalConstantFP(const ConstantFP *CFP, unsigned AddrSpace,
1131                                  AsmPrinter &AP) {
1132   // FP Constants are printed as integer constants to avoid losing
1133   // precision.
1134   if (CFP->getType()->isDoubleTy()) {
1135     if (AP.VerboseAsm) {
1136       double Val = CFP->getValueAPF().convertToDouble();
1137       AP.OutStreamer.GetCommentOS() << "double " << Val << '\n';
1138     }
1139
1140     uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1141     AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1142     return;
1143   }
1144
1145   if (CFP->getType()->isFloatTy()) {
1146     if (AP.VerboseAsm) {
1147       float Val = CFP->getValueAPF().convertToFloat();
1148       AP.OutStreamer.GetCommentOS() << "float " << Val << '\n';
1149     }
1150     uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
1151     AP.OutStreamer.EmitIntValue(Val, 4, AddrSpace);
1152     return;
1153   }
1154
1155   if (CFP->getType()->isX86_FP80Ty()) {
1156     // all long double variants are printed as hex
1157     // api needed to prevent premature destruction
1158     APInt API = CFP->getValueAPF().bitcastToAPInt();
1159     const uint64_t *p = API.getRawData();
1160     if (AP.VerboseAsm) {
1161       // Convert to double so we can print the approximate val as a comment.
1162       APFloat DoubleVal = CFP->getValueAPF();
1163       bool ignored;
1164       DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
1165                         &ignored);
1166       AP.OutStreamer.GetCommentOS() << "x86_fp80 ~= "
1167         << DoubleVal.convertToDouble() << '\n';
1168     }
1169
1170     if (AP.TM.getTargetData()->isBigEndian()) {
1171       AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1172       AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1173     } else {
1174       AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1175       AP.OutStreamer.EmitIntValue(p[1], 2, AddrSpace);
1176     }
1177
1178     // Emit the tail padding for the long double.
1179     const TargetData &TD = *AP.TM.getTargetData();
1180     AP.OutStreamer.EmitZeros(TD.getTypeAllocSize(CFP->getType()) -
1181                              TD.getTypeStoreSize(CFP->getType()), AddrSpace);
1182     return;
1183   }
1184
1185   assert(CFP->getType()->isPPC_FP128Ty() &&
1186          "Floating point constant type not handled");
1187   // All long double variants are printed as hex api needed to prevent
1188   // premature destruction.
1189   APInt API = CFP->getValueAPF().bitcastToAPInt();
1190   const uint64_t *p = API.getRawData();
1191   if (AP.TM.getTargetData()->isBigEndian()) {
1192     AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1193     AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1194   } else {
1195     AP.OutStreamer.EmitIntValue(p[1], 8, AddrSpace);
1196     AP.OutStreamer.EmitIntValue(p[0], 8, AddrSpace);
1197   }
1198 }
1199
1200 static void EmitGlobalConstantLargeInt(const ConstantInt *CI,
1201                                        unsigned AddrSpace, AsmPrinter &AP) {
1202   const TargetData *TD = AP.TM.getTargetData();
1203   unsigned BitWidth = CI->getBitWidth();
1204   assert((BitWidth & 63) == 0 && "only support multiples of 64-bits");
1205
1206   // We don't expect assemblers to support integer data directives
1207   // for more than 64 bits, so we emit the data in at most 64-bit
1208   // quantities at a time.
1209   const uint64_t *RawData = CI->getValue().getRawData();
1210   for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1211     uint64_t Val = TD->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1212     AP.OutStreamer.EmitIntValue(Val, 8, AddrSpace);
1213   }
1214 }
1215
1216 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
1217 void AsmPrinter::EmitGlobalConstant(const Constant *CV, unsigned AddrSpace) {
1218   if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
1219     uint64_t Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1220     if (Size == 0) Size = 1; // An empty "_foo:" followed by a section is undef.
1221     return OutStreamer.EmitZeros(Size, AddrSpace);
1222   }
1223
1224   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1225     unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1226     switch (Size) {
1227     case 1:
1228     case 2:
1229     case 4:
1230     case 8:
1231       if (VerboseAsm)
1232         OutStreamer.GetCommentOS() << format("0x%llx\n", CI->getZExtValue());
1233       OutStreamer.EmitIntValue(CI->getZExtValue(), Size, AddrSpace);
1234       return;
1235     default:
1236       EmitGlobalConstantLargeInt(CI, AddrSpace, *this);
1237       return;
1238     }
1239   }
1240
1241   if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
1242     return EmitGlobalConstantArray(CVA, AddrSpace, *this);
1243
1244   if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
1245     return EmitGlobalConstantStruct(CVS, AddrSpace, *this);
1246
1247   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
1248     return EmitGlobalConstantFP(CFP, AddrSpace, *this);
1249
1250   if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
1251     return EmitGlobalConstantVector(V, AddrSpace, *this);
1252
1253   if (isa<ConstantPointerNull>(CV)) {
1254     unsigned Size = TM.getTargetData()->getTypeAllocSize(CV->getType());
1255     OutStreamer.EmitIntValue(0, Size, AddrSpace);
1256     return;
1257   }
1258
1259   // Otherwise, it must be a ConstantExpr.  Lower it to an MCExpr, then emit it
1260   // thread the streamer with EmitValue.
1261   OutStreamer.EmitValue(LowerConstant(CV, *this),
1262                         TM.getTargetData()->getTypeAllocSize(CV->getType()),
1263                         AddrSpace);
1264 }
1265
1266 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1267   // Target doesn't support this yet!
1268   llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
1269 }
1270
1271 /// PrintSpecial - Print information related to the specified machine instr
1272 /// that is independent of the operand, and may be independent of the instr
1273 /// itself.  This can be useful for portably encoding the comment character
1274 /// or other bits of target-specific knowledge into the asmstrings.  The
1275 /// syntax used is ${:comment}.  Targets can override this to add support
1276 /// for their own strange codes.
1277 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) const {
1278   if (!strcmp(Code, "private")) {
1279     O << MAI->getPrivateGlobalPrefix();
1280   } else if (!strcmp(Code, "comment")) {
1281     if (VerboseAsm)
1282       O << MAI->getCommentString();
1283   } else if (!strcmp(Code, "uid")) {
1284     // Comparing the address of MI isn't sufficient, because machineinstrs may
1285     // be allocated to the same address across functions.
1286     const Function *ThisF = MI->getParent()->getParent()->getFunction();
1287
1288     // If this is a new LastFn instruction, bump the counter.
1289     if (LastMI != MI || LastFn != ThisF) {
1290       ++Counter;
1291       LastMI = MI;
1292       LastFn = ThisF;
1293     }
1294     O << Counter;
1295   } else {
1296     std::string msg;
1297     raw_string_ostream Msg(msg);
1298     Msg << "Unknown special formatter '" << Code
1299          << "' for machine instr: " << *MI;
1300     llvm_report_error(Msg.str());
1301   }
1302 }
1303
1304 /// processDebugLoc - Processes the debug information of each machine
1305 /// instruction's DebugLoc.
1306 void AsmPrinter::processDebugLoc(const MachineInstr *MI,
1307                                  bool BeforePrintingInsn) {
1308   if (!MAI || !DW || !MAI->doesSupportDebugInformation()
1309       || !DW->ShouldEmitDwarfDebug())
1310     return;
1311   DebugLoc DL = MI->getDebugLoc();
1312   if (DL.isUnknown())
1313     return;
1314   DILocation CurDLT = MF->getDILocation(DL);
1315   if (!CurDLT.getScope().Verify())
1316     return;
1317
1318   if (!BeforePrintingInsn) {
1319     // After printing instruction
1320     DW->EndScope(MI);
1321   } else if (CurDLT.getNode() != PrevDLT) {
1322     MCSymbol *L = DW->RecordSourceLine(CurDLT.getLineNumber(),
1323                                        CurDLT.getColumnNumber(),
1324                                        CurDLT.getScope().getNode());
1325     DW->BeginScope(MI, L);
1326     PrevDLT = CurDLT.getNode();
1327   }
1328 }
1329
1330
1331 /// printInlineAsm - This method formats and prints the specified machine
1332 /// instruction that is an inline asm.
1333 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1334   unsigned NumOperands = MI->getNumOperands();
1335
1336   // Count the number of register definitions.
1337   unsigned NumDefs = 0;
1338   for (; MI->getOperand(NumDefs).isReg() && MI->getOperand(NumDefs).isDef();
1339        ++NumDefs)
1340     assert(NumDefs != NumOperands-1 && "No asm string?");
1341
1342   assert(MI->getOperand(NumDefs).isSymbol() && "No asm string?");
1343
1344   // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1345   const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1346
1347   O << '\t';
1348
1349   // If this asmstr is empty, just print the #APP/#NOAPP markers.
1350   // These are useful to see where empty asm's wound up.
1351   if (AsmStr[0] == 0) {
1352     O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1353     O << MAI->getCommentString() << MAI->getInlineAsmEnd() << '\n';
1354     return;
1355   }
1356
1357   O << MAI->getCommentString() << MAI->getInlineAsmStart() << "\n\t";
1358
1359   // The variant of the current asmprinter.
1360   int AsmPrinterVariant = MAI->getAssemblerDialect();
1361
1362   int CurVariant = -1;            // The number of the {.|.|.} region we are in.
1363   const char *LastEmitted = AsmStr; // One past the last character emitted.
1364
1365   while (*LastEmitted) {
1366     switch (*LastEmitted) {
1367     default: {
1368       // Not a special case, emit the string section literally.
1369       const char *LiteralEnd = LastEmitted+1;
1370       while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1371              *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1372         ++LiteralEnd;
1373       if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1374         O.write(LastEmitted, LiteralEnd-LastEmitted);
1375       LastEmitted = LiteralEnd;
1376       break;
1377     }
1378     case '\n':
1379       ++LastEmitted;   // Consume newline character.
1380       O << '\n';       // Indent code with newline.
1381       break;
1382     case '$': {
1383       ++LastEmitted;   // Consume '$' character.
1384       bool Done = true;
1385
1386       // Handle escapes.
1387       switch (*LastEmitted) {
1388       default: Done = false; break;
1389       case '$':     // $$ -> $
1390         if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1391           O << '$';
1392         ++LastEmitted;  // Consume second '$' character.
1393         break;
1394       case '(':             // $( -> same as GCC's { character.
1395         ++LastEmitted;      // Consume '(' character.
1396         if (CurVariant != -1) {
1397           llvm_report_error("Nested variants found in inline asm string: '"
1398                             + std::string(AsmStr) + "'");
1399         }
1400         CurVariant = 0;     // We're in the first variant now.
1401         break;
1402       case '|':
1403         ++LastEmitted;  // consume '|' character.
1404         if (CurVariant == -1)
1405           O << '|';       // this is gcc's behavior for | outside a variant
1406         else
1407           ++CurVariant;   // We're in the next variant.
1408         break;
1409       case ')':         // $) -> same as GCC's } char.
1410         ++LastEmitted;  // consume ')' character.
1411         if (CurVariant == -1)
1412           O << '}';     // this is gcc's behavior for } outside a variant
1413         else
1414           CurVariant = -1;
1415         break;
1416       }
1417       if (Done) break;
1418
1419       bool HasCurlyBraces = false;
1420       if (*LastEmitted == '{') {     // ${variable}
1421         ++LastEmitted;               // Consume '{' character.
1422         HasCurlyBraces = true;
1423       }
1424
1425       // If we have ${:foo}, then this is not a real operand reference, it is a
1426       // "magic" string reference, just like in .td files.  Arrange to call
1427       // PrintSpecial.
1428       if (HasCurlyBraces && *LastEmitted == ':') {
1429         ++LastEmitted;
1430         const char *StrStart = LastEmitted;
1431         const char *StrEnd = strchr(StrStart, '}');
1432         if (StrEnd == 0) {
1433           llvm_report_error("Unterminated ${:foo} operand in inline asm string: '"
1434                             + std::string(AsmStr) + "'");
1435         }
1436
1437         std::string Val(StrStart, StrEnd);
1438         PrintSpecial(MI, Val.c_str());
1439         LastEmitted = StrEnd+1;
1440         break;
1441       }
1442
1443       const char *IDStart = LastEmitted;
1444       char *IDEnd;
1445       errno = 0;
1446       long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1447       if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1448         llvm_report_error("Bad $ operand number in inline asm string: '"
1449                           + std::string(AsmStr) + "'");
1450       }
1451       LastEmitted = IDEnd;
1452
1453       char Modifier[2] = { 0, 0 };
1454
1455       if (HasCurlyBraces) {
1456         // If we have curly braces, check for a modifier character.  This
1457         // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1458         if (*LastEmitted == ':') {
1459           ++LastEmitted;    // Consume ':' character.
1460           if (*LastEmitted == 0) {
1461             llvm_report_error("Bad ${:} expression in inline asm string: '"
1462                               + std::string(AsmStr) + "'");
1463           }
1464
1465           Modifier[0] = *LastEmitted;
1466           ++LastEmitted;    // Consume modifier character.
1467         }
1468
1469         if (*LastEmitted != '}') {
1470           llvm_report_error("Bad ${} expression in inline asm string: '"
1471                             + std::string(AsmStr) + "'");
1472         }
1473         ++LastEmitted;    // Consume '}' character.
1474       }
1475
1476       if ((unsigned)Val >= NumOperands-1) {
1477         llvm_report_error("Invalid $ operand number in inline asm string: '"
1478                           + std::string(AsmStr) + "'");
1479       }
1480
1481       // Okay, we finally have a value number.  Ask the target to print this
1482       // operand!
1483       if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1484         unsigned OpNo = 1;
1485
1486         bool Error = false;
1487
1488         // Scan to find the machine operand number for the operand.
1489         for (; Val; --Val) {
1490           if (OpNo >= MI->getNumOperands()) break;
1491           unsigned OpFlags = MI->getOperand(OpNo).getImm();
1492           OpNo += InlineAsm::getNumOperandRegisters(OpFlags) + 1;
1493         }
1494
1495         if (OpNo >= MI->getNumOperands()) {
1496           Error = true;
1497         } else {
1498           unsigned OpFlags = MI->getOperand(OpNo).getImm();
1499           ++OpNo;  // Skip over the ID number.
1500
1501           if (Modifier[0] == 'l')  // labels are target independent
1502             O << *MI->getOperand(OpNo).getMBB()->getSymbol(OutContext);
1503           else {
1504             AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1505             if ((OpFlags & 7) == 4) {
1506               Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1507                                                 Modifier[0] ? Modifier : 0);
1508             } else {
1509               Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1510                                           Modifier[0] ? Modifier : 0);
1511             }
1512           }
1513         }
1514         if (Error) {
1515           std::string msg;
1516           raw_string_ostream Msg(msg);
1517           Msg << "Invalid operand found in inline asm: '" << AsmStr << "'\n";
1518           MI->print(Msg);
1519           llvm_report_error(Msg.str());
1520         }
1521       }
1522       break;
1523     }
1524     }
1525   }
1526   O << "\n\t" << MAI->getCommentString() << MAI->getInlineAsmEnd();
1527   OutStreamer.AddBlankLine();
1528 }
1529
1530 /// printImplicitDef - This method prints the specified machine instruction
1531 /// that is an implicit def.
1532 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1533   if (!VerboseAsm) return;
1534   O.PadToColumn(MAI->getCommentColumn());
1535   O << MAI->getCommentString() << " implicit-def: "
1536     << TRI->getName(MI->getOperand(0).getReg());
1537   OutStreamer.AddBlankLine();
1538 }
1539
1540 void AsmPrinter::printKill(const MachineInstr *MI) const {
1541   if (!VerboseAsm) return;
1542   O.PadToColumn(MAI->getCommentColumn());
1543   O << MAI->getCommentString() << " kill:";
1544   for (unsigned n = 0, e = MI->getNumOperands(); n != e; ++n) {
1545     const MachineOperand &op = MI->getOperand(n);
1546     assert(op.isReg() && "KILL instruction must have only register operands");
1547     O << ' ' << TRI->getName(op.getReg()) << (op.isDef() ? "<def>" : "<kill>");
1548   }
1549   OutStreamer.AddBlankLine();
1550 }
1551
1552 /// printLabel - This method prints a local label used by debug and
1553 /// exception handling tables.
1554 void AsmPrinter::printLabelInst(const MachineInstr *MI) const {
1555   MCSymbol *Sym =
1556     OutContext.GetOrCreateTemporarySymbol(Twine(MAI->getPrivateGlobalPrefix()) +
1557                                  "label" + Twine(MI->getOperand(0).getImm()));
1558   OutStreamer.EmitLabel(Sym);
1559 }
1560
1561 void AsmPrinter::printLabel(unsigned Id) const {
1562   MCSymbol *Sym =
1563     OutContext.GetOrCreateTemporarySymbol(Twine(MAI->getPrivateGlobalPrefix()) +
1564                                           "label" + Twine(Id));
1565   OutStreamer.EmitLabel(Sym);
1566 }
1567
1568 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1569 /// instruction, using the specified assembler variant.  Targets should
1570 /// override this to format as appropriate.
1571 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1572                                  unsigned AsmVariant, const char *ExtraCode) {
1573   // Target doesn't support this yet!
1574   return true;
1575 }
1576
1577 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1578                                        unsigned AsmVariant,
1579                                        const char *ExtraCode) {
1580   // Target doesn't support this yet!
1581   return true;
1582 }
1583
1584 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
1585   return GetBlockAddressSymbol(BA->getFunction(), BA->getBasicBlock());
1586 }
1587
1588 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const Function *F,
1589                                             const BasicBlock *BB) const {
1590   assert(BB->hasName() &&
1591          "Address of anonymous basic block not supported yet!");
1592
1593   // This code must use the function name itself, and not the function number,
1594   // since it must be possible to generate the label name from within other
1595   // functions.
1596   SmallString<60> FnName;
1597   Mang->getNameWithPrefix(FnName, F, false);
1598
1599   // FIXME: THIS IS BROKEN IF THE LLVM BASIC BLOCK DOESN'T HAVE A NAME!
1600   SmallString<60> NameResult;
1601   Mang->getNameWithPrefix(NameResult,
1602                           StringRef("BA") + Twine((unsigned)FnName.size()) +
1603                           "_" + FnName.str() + "_" + BB->getName(),
1604                           Mangler::Private);
1605
1606   return OutContext.GetOrCreateTemporarySymbol(NameResult.str());
1607 }
1608
1609 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
1610 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
1611   return OutContext.GetOrCreateTemporarySymbol
1612     (Twine(MAI->getPrivateGlobalPrefix()) + "CPI" + Twine(getFunctionNumber())
1613      + "_" + Twine(CPID));
1614 }
1615
1616 /// GetJTISymbol - Return the symbol for the specified jump table entry.
1617 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
1618   return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
1619 }
1620
1621 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
1622 /// FIXME: privatize to AsmPrinter.
1623 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
1624   return OutContext.GetOrCreateTemporarySymbol
1625   (Twine(MAI->getPrivateGlobalPrefix()) + Twine(getFunctionNumber()) + "_" +
1626    Twine(UID) + "_set_" + Twine(MBBID));
1627 }
1628
1629 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
1630 /// global value name as its base, with the specified suffix, and where the
1631 /// symbol is forced to have private linkage if ForcePrivate is true.
1632 MCSymbol *AsmPrinter::GetSymbolWithGlobalValueBase(const GlobalValue *GV,
1633                                                    StringRef Suffix,
1634                                                    bool ForcePrivate) const {
1635   SmallString<60> NameStr;
1636   Mang->getNameWithPrefix(NameStr, GV, ForcePrivate);
1637   NameStr.append(Suffix.begin(), Suffix.end());
1638   if (!GV->hasPrivateLinkage() && !ForcePrivate)
1639     return OutContext.GetOrCreateSymbol(NameStr.str());
1640   return OutContext.GetOrCreateTemporarySymbol(NameStr.str());
1641 }
1642
1643 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
1644 /// ExternalSymbol.
1645 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
1646   SmallString<60> NameStr;
1647   Mang->getNameWithPrefix(NameStr, Sym);
1648   return OutContext.GetOrCreateSymbol(NameStr.str());
1649 }
1650
1651
1652
1653 /// PrintParentLoopComment - Print comments about parent loops of this one.
1654 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1655                                    unsigned FunctionNumber) {
1656   if (Loop == 0) return;
1657   PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
1658   OS.indent(Loop->getLoopDepth()*2)
1659     << "Parent Loop BB" << FunctionNumber << "_"
1660     << Loop->getHeader()->getNumber()
1661     << " Depth=" << Loop->getLoopDepth() << '\n';
1662 }
1663
1664
1665 /// PrintChildLoopComment - Print comments about child loops within
1666 /// the loop for this basic block, with nesting.
1667 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
1668                                   unsigned FunctionNumber) {
1669   // Add child loop information
1670   for (MachineLoop::iterator CL = Loop->begin(), E = Loop->end();CL != E; ++CL){
1671     OS.indent((*CL)->getLoopDepth()*2)
1672       << "Child Loop BB" << FunctionNumber << "_"
1673       << (*CL)->getHeader()->getNumber() << " Depth " << (*CL)->getLoopDepth()
1674       << '\n';
1675     PrintChildLoopComment(OS, *CL, FunctionNumber);
1676   }
1677 }
1678
1679 /// PrintBasicBlockLoopComments - Pretty-print comments for basic blocks.
1680 static void PrintBasicBlockLoopComments(const MachineBasicBlock &MBB,
1681                                         const MachineLoopInfo *LI,
1682                                         const AsmPrinter &AP) {
1683   // Add loop depth information
1684   const MachineLoop *Loop = LI->getLoopFor(&MBB);
1685   if (Loop == 0) return;
1686
1687   MachineBasicBlock *Header = Loop->getHeader();
1688   assert(Header && "No header for loop");
1689
1690   // If this block is not a loop header, just print out what is the loop header
1691   // and return.
1692   if (Header != &MBB) {
1693     AP.OutStreamer.AddComment("  in Loop: Header=BB" +
1694                               Twine(AP.getFunctionNumber())+"_" +
1695                               Twine(Loop->getHeader()->getNumber())+
1696                               " Depth="+Twine(Loop->getLoopDepth()));
1697     return;
1698   }
1699
1700   // Otherwise, it is a loop header.  Print out information about child and
1701   // parent loops.
1702   raw_ostream &OS = AP.OutStreamer.GetCommentOS();
1703
1704   PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
1705
1706   OS << "=>";
1707   OS.indent(Loop->getLoopDepth()*2-2);
1708
1709   OS << "This ";
1710   if (Loop->empty())
1711     OS << "Inner ";
1712   OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
1713
1714   PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
1715 }
1716
1717
1718 /// EmitBasicBlockStart - This method prints the label for the specified
1719 /// MachineBasicBlock, an alignment (if present) and a comment describing
1720 /// it if appropriate.
1721 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock *MBB) const {
1722   // Emit an alignment directive for this block, if needed.
1723   if (unsigned Align = MBB->getAlignment())
1724     EmitAlignment(Log2_32(Align));
1725
1726   // If the block has its address taken, emit a special label to satisfy
1727   // references to the block. This is done so that we don't need to
1728   // remember the number of this label, and so that we can make
1729   // forward references to labels without knowing what their numbers
1730   // will be.
1731   if (MBB->hasAddressTaken()) {
1732     const BasicBlock *BB = MBB->getBasicBlock();
1733     if (VerboseAsm)
1734       OutStreamer.AddComment("Address Taken");
1735     OutStreamer.EmitLabel(GetBlockAddressSymbol(BB->getParent(), BB));
1736   }
1737
1738   // Print the main label for the block.
1739   if (MBB->pred_empty() || isBlockOnlyReachableByFallthrough(MBB)) {
1740     if (VerboseAsm) {
1741       // NOTE: Want this comment at start of line.
1742       O << MAI->getCommentString() << " BB#" << MBB->getNumber() << ':';
1743       if (const BasicBlock *BB = MBB->getBasicBlock())
1744         if (BB->hasName())
1745           OutStreamer.AddComment("%" + BB->getName());
1746
1747       PrintBasicBlockLoopComments(*MBB, LI, *this);
1748       OutStreamer.AddBlankLine();
1749     }
1750   } else {
1751     if (VerboseAsm) {
1752       if (const BasicBlock *BB = MBB->getBasicBlock())
1753         if (BB->hasName())
1754           OutStreamer.AddComment("%" + BB->getName());
1755       PrintBasicBlockLoopComments(*MBB, LI, *this);
1756     }
1757
1758     OutStreamer.EmitLabel(MBB->getSymbol(OutContext));
1759   }
1760 }
1761
1762 void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility) const {
1763   MCSymbolAttr Attr = MCSA_Invalid;
1764
1765   switch (Visibility) {
1766   default: break;
1767   case GlobalValue::HiddenVisibility:
1768     Attr = MAI->getHiddenVisibilityAttr();
1769     break;
1770   case GlobalValue::ProtectedVisibility:
1771     Attr = MAI->getProtectedVisibilityAttr();
1772     break;
1773   }
1774
1775   if (Attr != MCSA_Invalid)
1776     OutStreamer.EmitSymbolAttribute(Sym, Attr);
1777 }
1778
1779 void AsmPrinter::printOffset(int64_t Offset) const {
1780   if (Offset > 0)
1781     O << '+' << Offset;
1782   else if (Offset < 0)
1783     O << Offset;
1784 }
1785
1786 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
1787 /// exactly one predecessor and the control transfer mechanism between
1788 /// the predecessor and this block is a fall-through.
1789 bool AsmPrinter::isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB)
1790     const {
1791   // If this is a landing pad, it isn't a fall through.  If it has no preds,
1792   // then nothing falls through to it.
1793   if (MBB->isLandingPad() || MBB->pred_empty())
1794     return false;
1795
1796   // If there isn't exactly one predecessor, it can't be a fall through.
1797   MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(), PI2 = PI;
1798   ++PI2;
1799   if (PI2 != MBB->pred_end())
1800     return false;
1801
1802   // The predecessor has to be immediately before this block.
1803   const MachineBasicBlock *Pred = *PI;
1804
1805   if (!Pred->isLayoutSuccessor(MBB))
1806     return false;
1807
1808   // If the block is completely empty, then it definitely does fall through.
1809   if (Pred->empty())
1810     return true;
1811
1812   // Otherwise, check the last instruction.
1813   const MachineInstr &LastInst = Pred->back();
1814   return !LastInst.getDesc().isBarrier();
1815 }
1816
1817
1818
1819 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1820   if (!S->usesMetadata())
1821     return 0;
1822
1823   gcp_iterator GCPI = GCMetadataPrinters.find(S);
1824   if (GCPI != GCMetadataPrinters.end())
1825     return GCPI->second;
1826
1827   const char *Name = S->getName().c_str();
1828
1829   for (GCMetadataPrinterRegistry::iterator
1830          I = GCMetadataPrinterRegistry::begin(),
1831          E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1832     if (strcmp(Name, I->getName()) == 0) {
1833       GCMetadataPrinter *GMP = I->instantiate();
1834       GMP->S = S;
1835       GCMetadataPrinters.insert(std::make_pair(S, GMP));
1836       return GMP;
1837     }
1838
1839   llvm_report_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
1840   return 0;
1841 }
1842