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