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