8206d088b99dc99e58e6572bc5ad54ccd050e31f
[oota-llvm.git] / 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 #include "llvm/CodeGen/AsmPrinter.h"
15 #include "DwarfDebug.h"
16 #include "DwarfException.h"
17 #include "Win64Exception.h"
18 #include "WinCodeViewLineTables.h"
19 #include "llvm/ADT/SmallString.h"
20 #include "llvm/ADT/Statistic.h"
21 #include "llvm/Analysis/ConstantFolding.h"
22 #include "llvm/Analysis/JumpInstrTableInfo.h"
23 #include "llvm/CodeGen/Analysis.h"
24 #include "llvm/CodeGen/GCMetadataPrinter.h"
25 #include "llvm/CodeGen/MachineConstantPool.h"
26 #include "llvm/CodeGen/MachineFrameInfo.h"
27 #include "llvm/CodeGen/MachineFunction.h"
28 #include "llvm/CodeGen/MachineInstrBundle.h"
29 #include "llvm/CodeGen/MachineJumpTableInfo.h"
30 #include "llvm/CodeGen/MachineLoopInfo.h"
31 #include "llvm/CodeGen/MachineModuleInfo.h"
32 #include "llvm/IR/DataLayout.h"
33 #include "llvm/IR/DebugInfo.h"
34 #include "llvm/IR/Mangler.h"
35 #include "llvm/IR/Module.h"
36 #include "llvm/IR/Operator.h"
37 #include "llvm/MC/MCAsmInfo.h"
38 #include "llvm/MC/MCContext.h"
39 #include "llvm/MC/MCExpr.h"
40 #include "llvm/MC/MCInst.h"
41 #include "llvm/MC/MCSection.h"
42 #include "llvm/MC/MCStreamer.h"
43 #include "llvm/MC/MCSymbol.h"
44 #include "llvm/Support/ErrorHandling.h"
45 #include "llvm/Support/Format.h"
46 #include "llvm/Support/MathExtras.h"
47 #include "llvm/Support/Timer.h"
48 #include "llvm/Target/TargetFrameLowering.h"
49 #include "llvm/Target/TargetInstrInfo.h"
50 #include "llvm/Target/TargetLowering.h"
51 #include "llvm/Target/TargetLoweringObjectFile.h"
52 #include "llvm/Target/TargetRegisterInfo.h"
53 #include "llvm/Target/TargetSubtargetInfo.h"
54 using namespace llvm;
55
56 #define DEBUG_TYPE "asm-printer"
57
58 static const char *const DWARFGroupName = "DWARF Emission";
59 static const char *const DbgTimerName = "Debug Info Emission";
60 static const char *const EHTimerName = "DWARF Exception Writer";
61 static const char *const CodeViewLineTablesGroupName = "CodeView Line Tables";
62
63 STATISTIC(EmittedInsts, "Number of machine instrs printed");
64
65 char AsmPrinter::ID = 0;
66
67 typedef DenseMap<GCStrategy*, std::unique_ptr<GCMetadataPrinter>> gcp_map_type;
68 static gcp_map_type &getGCMap(void *&P) {
69   if (!P)
70     P = new gcp_map_type();
71   return *(gcp_map_type*)P;
72 }
73
74
75 /// getGVAlignmentLog2 - Return the alignment to use for the specified global
76 /// value in log2 form.  This rounds up to the preferred alignment if possible
77 /// and legal.
78 static unsigned getGVAlignmentLog2(const GlobalValue *GV, const DataLayout &TD,
79                                    unsigned InBits = 0) {
80   unsigned NumBits = 0;
81   if (const GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV))
82     NumBits = TD.getPreferredAlignmentLog(GVar);
83
84   // If InBits is specified, round it to it.
85   if (InBits > NumBits)
86     NumBits = InBits;
87
88   // If the GV has a specified alignment, take it into account.
89   if (GV->getAlignment() == 0)
90     return NumBits;
91
92   unsigned GVAlign = Log2_32(GV->getAlignment());
93
94   // If the GVAlign is larger than NumBits, or if we are required to obey
95   // NumBits because the GV has an assigned section, obey it.
96   if (GVAlign > NumBits || GV->hasSection())
97     NumBits = GVAlign;
98   return NumBits;
99 }
100
101 AsmPrinter::AsmPrinter(TargetMachine &tm, std::unique_ptr<MCStreamer> Streamer)
102     : MachineFunctionPass(ID), TM(tm), MAI(tm.getMCAsmInfo()),
103       MII(tm.getSubtargetImpl()->getInstrInfo()),
104       OutContext(Streamer->getContext()), OutStreamer(*Streamer.release()),
105       LastMI(nullptr), LastFn(0), Counter(~0U), SetCounter(0) {
106   DD = nullptr; MMI = nullptr; LI = nullptr; MF = nullptr;
107   CurrentFnSym = CurrentFnSymForSize = nullptr;
108   GCMetadataPrinters = nullptr;
109   VerboseAsm = OutStreamer.isVerboseAsm();
110 }
111
112 AsmPrinter::~AsmPrinter() {
113   assert(!DD && Handlers.empty() && "Debug/EH info didn't get finalized");
114
115   if (GCMetadataPrinters) {
116     gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
117
118     delete &GCMap;
119     GCMetadataPrinters = nullptr;
120   }
121
122   delete &OutStreamer;
123 }
124
125 /// getFunctionNumber - Return a unique ID for the current function.
126 ///
127 unsigned AsmPrinter::getFunctionNumber() const {
128   return MF->getFunctionNumber();
129 }
130
131 const TargetLoweringObjectFile &AsmPrinter::getObjFileLowering() const {
132   return TM.getSubtargetImpl()->getTargetLowering()->getObjFileLowering();
133 }
134
135 /// getDataLayout - Return information about data layout.
136 const DataLayout &AsmPrinter::getDataLayout() const {
137   return *TM.getSubtargetImpl()->getDataLayout();
138 }
139
140 const MCSubtargetInfo &AsmPrinter::getSubtargetInfo() const {
141   return TM.getSubtarget<MCSubtargetInfo>();
142 }
143
144 void AsmPrinter::EmitToStreamer(MCStreamer &S, const MCInst &Inst) {
145   S.EmitInstruction(Inst, getSubtargetInfo());
146 }
147
148 StringRef AsmPrinter::getTargetTriple() const {
149   return TM.getTargetTriple();
150 }
151
152 /// getCurrentSection() - Return the current section we are emitting to.
153 const MCSection *AsmPrinter::getCurrentSection() const {
154   return OutStreamer.getCurrentSection().first;
155 }
156
157
158
159 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
160   AU.setPreservesAll();
161   MachineFunctionPass::getAnalysisUsage(AU);
162   AU.addRequired<MachineModuleInfo>();
163   AU.addRequired<GCModuleInfo>();
164   if (isVerbose())
165     AU.addRequired<MachineLoopInfo>();
166 }
167
168 bool AsmPrinter::doInitialization(Module &M) {
169   MMI = getAnalysisIfAvailable<MachineModuleInfo>();
170   MMI->AnalyzeModule(M);
171
172   // Initialize TargetLoweringObjectFile.
173   const_cast<TargetLoweringObjectFile&>(getObjFileLowering())
174     .Initialize(OutContext, TM);
175
176   OutStreamer.InitSections(false);
177
178   Mang = new Mangler(TM.getSubtargetImpl()->getDataLayout());
179
180   // Emit the version-min deplyment target directive if needed.
181   //
182   // FIXME: If we end up with a collection of these sorts of Darwin-specific
183   // or ELF-specific things, it may make sense to have a platform helper class
184   // that will work with the target helper class. For now keep it here, as the
185   // alternative is duplicated code in each of the target asm printers that
186   // use the directive, where it would need the same conditionalization
187   // anyway.
188   Triple TT(getTargetTriple());
189   if (TT.isOSDarwin()) {
190     unsigned Major, Minor, Update;
191     TT.getOSVersion(Major, Minor, Update);
192     // If there is a version specified, Major will be non-zero.
193     if (Major)
194       OutStreamer.EmitVersionMin((TT.isMacOSX() ?
195                                   MCVM_OSXVersionMin : MCVM_IOSVersionMin),
196                                  Major, Minor, Update);
197   }
198
199   // Allow the target to emit any magic that it wants at the start of the file.
200   EmitStartOfAsmFile(M);
201
202   // Very minimal debug info. It is ignored if we emit actual debug info. If we
203   // don't, this at least helps the user find where a global came from.
204   if (MAI->hasSingleParameterDotFile()) {
205     // .file "foo.c"
206     OutStreamer.EmitFileDirective(M.getModuleIdentifier());
207   }
208
209   GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
210   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
211   for (auto &I : *MI)
212     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
213       MP->beginAssembly(M, *MI, *this);
214
215   // Emit module-level inline asm if it exists.
216   if (!M.getModuleInlineAsm().empty()) {
217     OutStreamer.AddComment("Start of file scope inline assembly");
218     OutStreamer.AddBlankLine();
219     EmitInlineAsm(M.getModuleInlineAsm()+"\n");
220     OutStreamer.AddComment("End of file scope inline assembly");
221     OutStreamer.AddBlankLine();
222   }
223
224   if (MAI->doesSupportDebugInformation()) {
225     bool skip_dwarf = false;
226     if (Triple(TM.getTargetTriple()).isKnownWindowsMSVCEnvironment()) {
227       Handlers.push_back(HandlerInfo(new WinCodeViewLineTables(this),
228                                      DbgTimerName,
229                                      CodeViewLineTablesGroupName));
230       // FIXME: Don't emit DWARF debug info if there's at least one function
231       // with AddressSanitizer instrumentation.
232       // This is a band-aid fix for PR22032.
233       for (auto &F : M.functions()) {
234         if (F.hasFnAttribute(Attribute::SanitizeAddress)) {
235           skip_dwarf = true;
236           break;
237         }
238       }
239     }
240     if (!skip_dwarf) {
241       DD = new DwarfDebug(this, &M);
242       Handlers.push_back(HandlerInfo(DD, DbgTimerName, DWARFGroupName));
243     }
244   }
245
246   EHStreamer *ES = nullptr;
247   switch (MAI->getExceptionHandlingType()) {
248   case ExceptionHandling::None:
249     break;
250   case ExceptionHandling::SjLj:
251   case ExceptionHandling::DwarfCFI:
252     ES = new DwarfCFIException(this);
253     break;
254   case ExceptionHandling::ARM:
255     ES = new ARMException(this);
256     break;
257   case ExceptionHandling::WinEH:
258     switch (MAI->getWinEHEncodingType()) {
259     default: llvm_unreachable("unsupported unwinding information encoding");
260     case WinEH::EncodingType::Itanium:
261       ES = new Win64Exception(this);
262       break;
263     }
264     break;
265   }
266   if (ES)
267     Handlers.push_back(HandlerInfo(ES, EHTimerName, DWARFGroupName));
268   return false;
269 }
270
271 static bool canBeHidden(const GlobalValue *GV, const MCAsmInfo &MAI) {
272   if (!MAI.hasWeakDefCanBeHiddenDirective())
273     return false;
274
275   return canBeOmittedFromSymbolTable(GV);
276 }
277
278 void AsmPrinter::EmitLinkage(const GlobalValue *GV, MCSymbol *GVSym) const {
279   GlobalValue::LinkageTypes Linkage = GV->getLinkage();
280   switch (Linkage) {
281   case GlobalValue::CommonLinkage:
282   case GlobalValue::LinkOnceAnyLinkage:
283   case GlobalValue::LinkOnceODRLinkage:
284   case GlobalValue::WeakAnyLinkage:
285   case GlobalValue::WeakODRLinkage:
286     if (MAI->hasWeakDefDirective()) {
287       // .globl _foo
288       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
289
290       if (!canBeHidden(GV, *MAI))
291         // .weak_definition _foo
292         OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefinition);
293       else
294         OutStreamer.EmitSymbolAttribute(GVSym, MCSA_WeakDefAutoPrivate);
295     } else if (MAI->hasLinkOnceDirective()) {
296       // .globl _foo
297       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
298       //NOTE: linkonce is handled by the section the symbol was assigned to.
299     } else {
300       // .weak _foo
301       OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Weak);
302     }
303     return;
304   case GlobalValue::AppendingLinkage:
305     // FIXME: appending linkage variables should go into a section of
306     // their name or something.  For now, just emit them as external.
307   case GlobalValue::ExternalLinkage:
308     // If external or appending, declare as a global symbol.
309     // .globl _foo
310     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
311     return;
312   case GlobalValue::PrivateLinkage:
313   case GlobalValue::InternalLinkage:
314     return;
315   case GlobalValue::AvailableExternallyLinkage:
316     llvm_unreachable("Should never emit this");
317   case GlobalValue::ExternalWeakLinkage:
318     llvm_unreachable("Don't know how to emit these");
319   }
320   llvm_unreachable("Unknown linkage type!");
321 }
322
323 void AsmPrinter::getNameWithPrefix(SmallVectorImpl<char> &Name,
324                                    const GlobalValue *GV) const {
325   TM.getNameWithPrefix(Name, GV, *Mang);
326 }
327
328 MCSymbol *AsmPrinter::getSymbol(const GlobalValue *GV) const {
329   return TM.getSymbol(GV, *Mang);
330 }
331
332 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
333 void AsmPrinter::EmitGlobalVariable(const GlobalVariable *GV) {
334   if (GV->hasInitializer()) {
335     // Check to see if this is a special global used by LLVM, if so, emit it.
336     if (EmitSpecialLLVMGlobal(GV))
337       return;
338
339     if (isVerbose()) {
340       GV->printAsOperand(OutStreamer.GetCommentOS(),
341                      /*PrintType=*/false, GV->getParent());
342       OutStreamer.GetCommentOS() << '\n';
343     }
344   }
345
346   MCSymbol *GVSym = getSymbol(GV);
347   EmitVisibility(GVSym, GV->getVisibility(), !GV->isDeclaration());
348
349   if (!GV->hasInitializer())   // External globals require no extra code.
350     return;
351
352   GVSym->redefineIfPossible();
353   if (GVSym->isDefined() || GVSym->isVariable())
354     report_fatal_error("symbol '" + Twine(GVSym->getName()) +
355                        "' is already defined");
356
357   if (MAI->hasDotTypeDotSizeDirective())
358     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_ELF_TypeObject);
359
360   SectionKind GVKind = TargetLoweringObjectFile::getKindForGlobal(GV, TM);
361
362   const DataLayout *DL = TM.getSubtargetImpl()->getDataLayout();
363   uint64_t Size = DL->getTypeAllocSize(GV->getType()->getElementType());
364
365   // If the alignment is specified, we *must* obey it.  Overaligning a global
366   // with a specified alignment is a prompt way to break globals emitted to
367   // sections and expected to be contiguous (e.g. ObjC metadata).
368   unsigned AlignLog = getGVAlignmentLog2(GV, *DL);
369
370   for (const HandlerInfo &HI : Handlers) {
371     NamedRegionTimer T(HI.TimerName, HI.TimerGroupName, TimePassesIsEnabled);
372     HI.Handler->setSymbolSize(GVSym, Size);
373   }
374
375   // Handle common and BSS local symbols (.lcomm).
376   if (GVKind.isCommon() || GVKind.isBSSLocal()) {
377     if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
378     unsigned Align = 1 << AlignLog;
379
380     // Handle common symbols.
381     if (GVKind.isCommon()) {
382       if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
383         Align = 0;
384
385       // .comm _foo, 42, 4
386       OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
387       return;
388     }
389
390     // Handle local BSS symbols.
391     if (MAI->hasMachoZeroFillDirective()) {
392       const MCSection *TheSection =
393         getObjFileLowering().SectionForGlobal(GV, GVKind, *Mang, TM);
394       // .zerofill __DATA, __bss, _foo, 400, 5
395       OutStreamer.EmitZerofill(TheSection, GVSym, Size, Align);
396       return;
397     }
398
399     // Use .lcomm only if it supports user-specified alignment.
400     // Otherwise, while it would still be correct to use .lcomm in some
401     // cases (e.g. when Align == 1), the external assembler might enfore
402     // some -unknown- default alignment behavior, which could cause
403     // spurious differences between external and integrated assembler.
404     // Prefer to simply fall back to .local / .comm in this case.
405     if (MAI->getLCOMMDirectiveAlignmentType() != LCOMM::NoAlignment) {
406       // .lcomm _foo, 42
407       OutStreamer.EmitLocalCommonSymbol(GVSym, Size, Align);
408       return;
409     }
410
411     if (!getObjFileLowering().getCommDirectiveSupportsAlignment())
412       Align = 0;
413
414     // .local _foo
415     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Local);
416     // .comm _foo, 42, 4
417     OutStreamer.EmitCommonSymbol(GVSym, Size, Align);
418     return;
419   }
420
421   const MCSection *TheSection =
422     getObjFileLowering().SectionForGlobal(GV, GVKind, *Mang, TM);
423
424   // Handle the zerofill directive on darwin, which is a special form of BSS
425   // emission.
426   if (GVKind.isBSSExtern() && MAI->hasMachoZeroFillDirective()) {
427     if (Size == 0) Size = 1;  // zerofill of 0 bytes is undefined.
428
429     // .globl _foo
430     OutStreamer.EmitSymbolAttribute(GVSym, MCSA_Global);
431     // .zerofill __DATA, __common, _foo, 400, 5
432     OutStreamer.EmitZerofill(TheSection, GVSym, Size, 1 << AlignLog);
433     return;
434   }
435
436   // Handle thread local data for mach-o which requires us to output an
437   // additional structure of data and mangle the original symbol so that we
438   // can reference it later.
439   //
440   // TODO: This should become an "emit thread local global" method on TLOF.
441   // All of this macho specific stuff should be sunk down into TLOFMachO and
442   // stuff like "TLSExtraDataSection" should no longer be part of the parent
443   // TLOF class.  This will also make it more obvious that stuff like
444   // MCStreamer::EmitTBSSSymbol is macho specific and only called from macho
445   // specific code.
446   if (GVKind.isThreadLocal() && MAI->hasMachoTBSSDirective()) {
447     // Emit the .tbss symbol
448     MCSymbol *MangSym =
449       OutContext.GetOrCreateSymbol(GVSym->getName() + Twine("$tlv$init"));
450
451     if (GVKind.isThreadBSS()) {
452       TheSection = getObjFileLowering().getTLSBSSSection();
453       OutStreamer.EmitTBSSSymbol(TheSection, MangSym, Size, 1 << AlignLog);
454     } else if (GVKind.isThreadData()) {
455       OutStreamer.SwitchSection(TheSection);
456
457       EmitAlignment(AlignLog, GV);
458       OutStreamer.EmitLabel(MangSym);
459
460       EmitGlobalConstant(GV->getInitializer());
461     }
462
463     OutStreamer.AddBlankLine();
464
465     // Emit the variable struct for the runtime.
466     const MCSection *TLVSect
467       = getObjFileLowering().getTLSExtraDataSection();
468
469     OutStreamer.SwitchSection(TLVSect);
470     // Emit the linkage here.
471     EmitLinkage(GV, GVSym);
472     OutStreamer.EmitLabel(GVSym);
473
474     // Three pointers in size:
475     //   - __tlv_bootstrap - used to make sure support exists
476     //   - spare pointer, used when mapped by the runtime
477     //   - pointer to mangled symbol above with initializer
478     unsigned PtrSize = DL->getPointerTypeSize(GV->getType());
479     OutStreamer.EmitSymbolValue(GetExternalSymbolSymbol("_tlv_bootstrap"),
480                                 PtrSize);
481     OutStreamer.EmitIntValue(0, PtrSize);
482     OutStreamer.EmitSymbolValue(MangSym, PtrSize);
483
484     OutStreamer.AddBlankLine();
485     return;
486   }
487
488   OutStreamer.SwitchSection(TheSection);
489
490   EmitLinkage(GV, GVSym);
491   EmitAlignment(AlignLog, GV);
492
493   OutStreamer.EmitLabel(GVSym);
494
495   EmitGlobalConstant(GV->getInitializer());
496
497   if (MAI->hasDotTypeDotSizeDirective())
498     // .size foo, 42
499     OutStreamer.EmitELFSize(GVSym, MCConstantExpr::Create(Size, OutContext));
500
501   OutStreamer.AddBlankLine();
502 }
503
504 /// EmitFunctionHeader - This method emits the header for the current
505 /// function.
506 void AsmPrinter::EmitFunctionHeader() {
507   // Print out constants referenced by the function
508   EmitConstantPool();
509
510   // Print the 'header' of function.
511   const Function *F = MF->getFunction();
512
513   OutStreamer.SwitchSection(
514       getObjFileLowering().SectionForGlobal(F, *Mang, TM));
515   EmitVisibility(CurrentFnSym, F->getVisibility());
516
517   EmitLinkage(F, CurrentFnSym);
518   EmitAlignment(MF->getAlignment(), F);
519
520   if (MAI->hasDotTypeDotSizeDirective())
521     OutStreamer.EmitSymbolAttribute(CurrentFnSym, MCSA_ELF_TypeFunction);
522
523   if (isVerbose()) {
524     F->printAsOperand(OutStreamer.GetCommentOS(),
525                    /*PrintType=*/false, F->getParent());
526     OutStreamer.GetCommentOS() << '\n';
527   }
528
529   // Emit the prefix data.
530   if (F->hasPrefixData())
531     EmitGlobalConstant(F->getPrefixData());
532
533   // Emit the CurrentFnSym.  This is a virtual function to allow targets to
534   // do their wild and crazy things as required.
535   EmitFunctionEntryLabel();
536
537   // If the function had address-taken blocks that got deleted, then we have
538   // references to the dangling symbols.  Emit them at the start of the function
539   // so that we don't get references to undefined symbols.
540   std::vector<MCSymbol*> DeadBlockSyms;
541   MMI->takeDeletedSymbolsForFunction(F, DeadBlockSyms);
542   for (unsigned i = 0, e = DeadBlockSyms.size(); i != e; ++i) {
543     OutStreamer.AddComment("Address taken block that was later removed");
544     OutStreamer.EmitLabel(DeadBlockSyms[i]);
545   }
546
547   // Emit pre-function debug and/or EH information.
548   for (const HandlerInfo &HI : Handlers) {
549     NamedRegionTimer T(HI.TimerName, HI.TimerGroupName, TimePassesIsEnabled);
550     HI.Handler->beginFunction(MF);
551   }
552
553   // Emit the prologue data.
554   if (F->hasPrologueData())
555     EmitGlobalConstant(F->getPrologueData());
556 }
557
558 /// EmitFunctionEntryLabel - Emit the label that is the entrypoint for the
559 /// function.  This can be overridden by targets as required to do custom stuff.
560 void AsmPrinter::EmitFunctionEntryLabel() {
561   CurrentFnSym->redefineIfPossible();
562
563   // The function label could have already been emitted if two symbols end up
564   // conflicting due to asm renaming.  Detect this and emit an error.
565   if (CurrentFnSym->isVariable())
566     report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
567                        "' is a protected alias");
568   if (CurrentFnSym->isDefined())
569     report_fatal_error("'" + Twine(CurrentFnSym->getName()) +
570                        "' label emitted multiple times to assembly file");
571
572   return OutStreamer.EmitLabel(CurrentFnSym);
573 }
574
575 /// emitComments - Pretty-print comments for instructions.
576 static void emitComments(const MachineInstr &MI, raw_ostream &CommentOS) {
577   const MachineFunction *MF = MI.getParent()->getParent();
578   const TargetMachine &TM = MF->getTarget();
579
580   // Check for spills and reloads
581   int FI;
582
583   const MachineFrameInfo *FrameInfo = MF->getFrameInfo();
584
585   // We assume a single instruction only has a spill or reload, not
586   // both.
587   const MachineMemOperand *MMO;
588   if (TM.getSubtargetImpl()->getInstrInfo()->isLoadFromStackSlotPostFE(&MI,
589                                                                        FI)) {
590     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
591       MMO = *MI.memoperands_begin();
592       CommentOS << MMO->getSize() << "-byte Reload\n";
593     }
594   } else if (TM.getSubtargetImpl()->getInstrInfo()->hasLoadFromStackSlot(
595                  &MI, MMO, FI)) {
596     if (FrameInfo->isSpillSlotObjectIndex(FI))
597       CommentOS << MMO->getSize() << "-byte Folded Reload\n";
598   } else if (TM.getSubtargetImpl()->getInstrInfo()->isStoreToStackSlotPostFE(
599                  &MI, FI)) {
600     if (FrameInfo->isSpillSlotObjectIndex(FI)) {
601       MMO = *MI.memoperands_begin();
602       CommentOS << MMO->getSize() << "-byte Spill\n";
603     }
604   } else if (TM.getSubtargetImpl()->getInstrInfo()->hasStoreToStackSlot(
605                  &MI, MMO, FI)) {
606     if (FrameInfo->isSpillSlotObjectIndex(FI))
607       CommentOS << MMO->getSize() << "-byte Folded Spill\n";
608   }
609
610   // Check for spill-induced copies
611   if (MI.getAsmPrinterFlag(MachineInstr::ReloadReuse))
612     CommentOS << " Reload Reuse\n";
613 }
614
615 /// emitImplicitDef - This method emits the specified machine instruction
616 /// that is an implicit def.
617 void AsmPrinter::emitImplicitDef(const MachineInstr *MI) const {
618   unsigned RegNo = MI->getOperand(0).getReg();
619   OutStreamer.AddComment(
620       Twine("implicit-def: ") +
621       TM.getSubtargetImpl()->getRegisterInfo()->getName(RegNo));
622   OutStreamer.AddBlankLine();
623 }
624
625 static void emitKill(const MachineInstr *MI, AsmPrinter &AP) {
626   std::string Str = "kill:";
627   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
628     const MachineOperand &Op = MI->getOperand(i);
629     assert(Op.isReg() && "KILL instruction must have only register operands");
630     Str += ' ';
631     Str += AP.TM.getSubtargetImpl()->getRegisterInfo()->getName(Op.getReg());
632     Str += (Op.isDef() ? "<def>" : "<kill>");
633   }
634   AP.OutStreamer.AddComment(Str);
635   AP.OutStreamer.AddBlankLine();
636 }
637
638 /// emitDebugValueComment - This method handles the target-independent form
639 /// of DBG_VALUE, returning true if it was able to do so.  A false return
640 /// means the target will need to handle MI in EmitInstruction.
641 static bool emitDebugValueComment(const MachineInstr *MI, AsmPrinter &AP) {
642   // This code handles only the 4-operand target-independent form.
643   if (MI->getNumOperands() != 4)
644     return false;
645
646   SmallString<128> Str;
647   raw_svector_ostream OS(Str);
648   OS << "DEBUG_VALUE: ";
649
650   DIVariable V = MI->getDebugVariable();
651   if (V.getContext().isSubprogram()) {
652     StringRef Name = DISubprogram(V.getContext()).getDisplayName();
653     if (!Name.empty())
654       OS << Name << ":";
655   }
656   OS << V.getName();
657
658   DIExpression Expr = MI->getDebugExpression();
659   if (Expr.isVariablePiece())
660     OS << " [piece offset=" << Expr.getPieceOffset()
661        << " size=" << Expr.getPieceSize() << "]";
662   OS << " <- ";
663
664   // The second operand is only an offset if it's an immediate.
665   bool Deref = MI->getOperand(0).isReg() && MI->getOperand(1).isImm();
666   int64_t Offset = Deref ? MI->getOperand(1).getImm() : 0;
667
668   // Register or immediate value. Register 0 means undef.
669   if (MI->getOperand(0).isFPImm()) {
670     APFloat APF = APFloat(MI->getOperand(0).getFPImm()->getValueAPF());
671     if (MI->getOperand(0).getFPImm()->getType()->isFloatTy()) {
672       OS << (double)APF.convertToFloat();
673     } else if (MI->getOperand(0).getFPImm()->getType()->isDoubleTy()) {
674       OS << APF.convertToDouble();
675     } else {
676       // There is no good way to print long double.  Convert a copy to
677       // double.  Ah well, it's only a comment.
678       bool ignored;
679       APF.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven,
680                   &ignored);
681       OS << "(long double) " << APF.convertToDouble();
682     }
683   } else if (MI->getOperand(0).isImm()) {
684     OS << MI->getOperand(0).getImm();
685   } else if (MI->getOperand(0).isCImm()) {
686     MI->getOperand(0).getCImm()->getValue().print(OS, false /*isSigned*/);
687   } else {
688     unsigned Reg;
689     if (MI->getOperand(0).isReg()) {
690       Reg = MI->getOperand(0).getReg();
691     } else {
692       assert(MI->getOperand(0).isFI() && "Unknown operand type");
693       const TargetFrameLowering *TFI =
694           AP.TM.getSubtargetImpl()->getFrameLowering();
695       Offset += TFI->getFrameIndexReference(*AP.MF,
696                                             MI->getOperand(0).getIndex(), Reg);
697       Deref = true;
698     }
699     if (Reg == 0) {
700       // Suppress offset, it is not meaningful here.
701       OS << "undef";
702       // NOTE: Want this comment at start of line, don't emit with AddComment.
703       AP.OutStreamer.emitRawComment(OS.str());
704       return true;
705     }
706     if (Deref)
707       OS << '[';
708     OS << AP.TM.getSubtargetImpl()->getRegisterInfo()->getName(Reg);
709   }
710
711   if (Deref)
712     OS << '+' << Offset << ']';
713
714   // NOTE: Want this comment at start of line, don't emit with AddComment.
715   AP.OutStreamer.emitRawComment(OS.str());
716   return true;
717 }
718
719 AsmPrinter::CFIMoveType AsmPrinter::needsCFIMoves() {
720   if (MAI->getExceptionHandlingType() == ExceptionHandling::DwarfCFI &&
721       MF->getFunction()->needsUnwindTableEntry())
722     return CFI_M_EH;
723
724   if (MMI->hasDebugInfo())
725     return CFI_M_Debug;
726
727   return CFI_M_None;
728 }
729
730 bool AsmPrinter::needsSEHMoves() {
731   return MAI->usesWindowsCFI() && MF->getFunction()->needsUnwindTableEntry();
732 }
733
734 void AsmPrinter::emitCFIInstruction(const MachineInstr &MI) {
735   ExceptionHandling ExceptionHandlingType = MAI->getExceptionHandlingType();
736   if (ExceptionHandlingType != ExceptionHandling::DwarfCFI &&
737       ExceptionHandlingType != ExceptionHandling::ARM)
738     return;
739
740   if (needsCFIMoves() == CFI_M_None)
741     return;
742
743   const MachineModuleInfo &MMI = MF->getMMI();
744   const std::vector<MCCFIInstruction> &Instrs = MMI.getFrameInstructions();
745   unsigned CFIIndex = MI.getOperand(0).getCFIIndex();
746   const MCCFIInstruction &CFI = Instrs[CFIIndex];
747   emitCFIInstruction(CFI);
748 }
749
750 void AsmPrinter::emitFrameAlloc(const MachineInstr &MI) {
751   // The operands are the MCSymbol and the frame offset of the allocation.
752   MCSymbol *FrameAllocSym = MI.getOperand(0).getMCSymbol();
753   int FrameOffset = MI.getOperand(1).getImm();
754
755   // Emit a symbol assignment.
756   OutStreamer.EmitAssignment(FrameAllocSym,
757                              MCConstantExpr::Create(FrameOffset, OutContext));
758 }
759
760 /// EmitFunctionBody - This method emits the body and trailer for a
761 /// function.
762 void AsmPrinter::EmitFunctionBody() {
763   // Emit target-specific gunk before the function body.
764   EmitFunctionBodyStart();
765
766   bool ShouldPrintDebugScopes = MMI->hasDebugInfo();
767
768   // Print out code for the function.
769   bool HasAnyRealCode = false;
770   for (auto &MBB : *MF) {
771     // Print a label for the basic block.
772     EmitBasicBlockStart(MBB);
773     for (auto &MI : MBB) {
774
775       // Print the assembly for the instruction.
776       if (!MI.isPosition() && !MI.isImplicitDef() && !MI.isKill() &&
777           !MI.isDebugValue()) {
778         HasAnyRealCode = true;
779         ++EmittedInsts;
780       }
781
782       if (ShouldPrintDebugScopes) {
783         for (const HandlerInfo &HI : Handlers) {
784           NamedRegionTimer T(HI.TimerName, HI.TimerGroupName,
785                              TimePassesIsEnabled);
786           HI.Handler->beginInstruction(&MI);
787         }
788       }
789
790       if (isVerbose())
791         emitComments(MI, OutStreamer.GetCommentOS());
792
793       switch (MI.getOpcode()) {
794       case TargetOpcode::CFI_INSTRUCTION:
795         emitCFIInstruction(MI);
796         break;
797
798       case TargetOpcode::FRAME_ALLOC:
799         emitFrameAlloc(MI);
800         break;
801
802       case TargetOpcode::EH_LABEL:
803       case TargetOpcode::GC_LABEL:
804         OutStreamer.EmitLabel(MI.getOperand(0).getMCSymbol());
805         break;
806       case TargetOpcode::INLINEASM:
807         EmitInlineAsm(&MI);
808         break;
809       case TargetOpcode::DBG_VALUE:
810         if (isVerbose()) {
811           if (!emitDebugValueComment(&MI, *this))
812             EmitInstruction(&MI);
813         }
814         break;
815       case TargetOpcode::IMPLICIT_DEF:
816         if (isVerbose()) emitImplicitDef(&MI);
817         break;
818       case TargetOpcode::KILL:
819         if (isVerbose()) emitKill(&MI, *this);
820         break;
821       default:
822         EmitInstruction(&MI);
823         break;
824       }
825
826       if (ShouldPrintDebugScopes) {
827         for (const HandlerInfo &HI : Handlers) {
828           NamedRegionTimer T(HI.TimerName, HI.TimerGroupName,
829                              TimePassesIsEnabled);
830           HI.Handler->endInstruction();
831         }
832       }
833     }
834
835     EmitBasicBlockEnd(MBB);
836   }
837
838   // If the function is empty and the object file uses .subsections_via_symbols,
839   // then we need to emit *something* to the function body to prevent the
840   // labels from collapsing together.  Just emit a noop.
841   if ((MAI->hasSubsectionsViaSymbols() && !HasAnyRealCode)) {
842     MCInst Noop;
843     TM.getSubtargetImpl()->getInstrInfo()->getNoopForMachoTarget(Noop);
844     OutStreamer.AddComment("avoids zero-length function");
845
846     // Targets can opt-out of emitting the noop here by leaving the opcode
847     // unspecified.
848     if (Noop.getOpcode())
849       OutStreamer.EmitInstruction(Noop, getSubtargetInfo());
850   }
851
852   const Function *F = MF->getFunction();
853   for (const auto &BB : *F) {
854     if (!BB.hasAddressTaken())
855       continue;
856     MCSymbol *Sym = GetBlockAddressSymbol(&BB);
857     if (Sym->isDefined())
858       continue;
859     OutStreamer.AddComment("Address of block that was removed by CodeGen");
860     OutStreamer.EmitLabel(Sym);
861   }
862
863   // Emit target-specific gunk after the function body.
864   EmitFunctionBodyEnd();
865
866   // If the target wants a .size directive for the size of the function, emit
867   // it.
868   if (MAI->hasDotTypeDotSizeDirective()) {
869     // Create a symbol for the end of function, so we can get the size as
870     // difference between the function label and the temp label.
871     MCSymbol *FnEndLabel = OutContext.CreateTempSymbol();
872     OutStreamer.EmitLabel(FnEndLabel);
873
874     const MCExpr *SizeExp =
875       MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(FnEndLabel, OutContext),
876                               MCSymbolRefExpr::Create(CurrentFnSymForSize,
877                                                       OutContext),
878                               OutContext);
879     OutStreamer.EmitELFSize(CurrentFnSym, SizeExp);
880   }
881
882   // Emit post-function debug and/or EH information.
883   for (const HandlerInfo &HI : Handlers) {
884     NamedRegionTimer T(HI.TimerName, HI.TimerGroupName, TimePassesIsEnabled);
885     HI.Handler->endFunction(MF);
886   }
887   MMI->EndFunction();
888
889   // Print out jump tables referenced by the function.
890   EmitJumpTableInfo();
891
892   OutStreamer.AddBlankLine();
893 }
894
895 bool AsmPrinter::doFinalization(Module &M) {
896   // Emit global variables.
897   for (const auto &G : M.globals())
898     EmitGlobalVariable(&G);
899
900   // Emit visibility info for declarations
901   for (const Function &F : M) {
902     if (!F.isDeclaration())
903       continue;
904     GlobalValue::VisibilityTypes V = F.getVisibility();
905     if (V == GlobalValue::DefaultVisibility)
906       continue;
907
908     MCSymbol *Name = getSymbol(&F);
909     EmitVisibility(Name, V, false);
910   }
911
912   // Get information about jump-instruction tables to print.
913   JumpInstrTableInfo *JITI = getAnalysisIfAvailable<JumpInstrTableInfo>();
914
915   if (JITI && !JITI->getTables().empty()) {
916     unsigned Arch = Triple(getTargetTriple()).getArch();
917     bool IsThumb = (Arch == Triple::thumb || Arch == Triple::thumbeb);
918     MCInst TrapInst;
919     TM.getSubtargetImpl()->getInstrInfo()->getTrap(TrapInst);
920     unsigned LogAlignment = llvm::Log2_64(JITI->entryByteAlignment());
921
922     // Emit the right section for these functions.
923     OutStreamer.SwitchSection(OutContext.getObjectFileInfo()->getTextSection());
924     for (const auto &KV : JITI->getTables()) {
925       uint64_t Count = 0;
926       for (const auto &FunPair : KV.second) {
927         // Emit the function labels to make this be a function entry point.
928         MCSymbol *FunSym =
929           OutContext.GetOrCreateSymbol(FunPair.second->getName());
930         EmitAlignment(LogAlignment);
931         if (IsThumb)
932           OutStreamer.EmitThumbFunc(FunSym);
933         if (MAI->hasDotTypeDotSizeDirective())
934           OutStreamer.EmitSymbolAttribute(FunSym, MCSA_ELF_TypeFunction);
935         OutStreamer.EmitLabel(FunSym);
936
937         // Emit the jump instruction to transfer control to the original
938         // function.
939         MCInst JumpToFun;
940         MCSymbol *TargetSymbol =
941           OutContext.GetOrCreateSymbol(FunPair.first->getName());
942         const MCSymbolRefExpr *TargetSymRef =
943           MCSymbolRefExpr::Create(TargetSymbol, MCSymbolRefExpr::VK_PLT,
944                                   OutContext);
945         TM.getSubtargetImpl()->getInstrInfo()->getUnconditionalBranch(
946             JumpToFun, TargetSymRef);
947         OutStreamer.EmitInstruction(JumpToFun, getSubtargetInfo());
948         ++Count;
949       }
950
951       // Emit enough padding instructions to fill up to the next power of two.
952       uint64_t Remaining = NextPowerOf2(Count) - Count;
953       for (uint64_t C = 0; C < Remaining; ++C) {
954         EmitAlignment(LogAlignment);
955         OutStreamer.EmitInstruction(TrapInst, getSubtargetInfo());
956       }
957
958     }
959   }
960
961   // Emit module flags.
962   SmallVector<Module::ModuleFlagEntry, 8> ModuleFlags;
963   M.getModuleFlagsMetadata(ModuleFlags);
964   if (!ModuleFlags.empty())
965     getObjFileLowering().emitModuleFlags(OutStreamer, ModuleFlags, *Mang, TM);
966
967   // Make sure we wrote out everything we need.
968   OutStreamer.Flush();
969
970   // Finalize debug and EH information.
971   for (const HandlerInfo &HI : Handlers) {
972     NamedRegionTimer T(HI.TimerName, HI.TimerGroupName,
973                        TimePassesIsEnabled);
974     HI.Handler->endModule();
975     delete HI.Handler;
976   }
977   Handlers.clear();
978   DD = nullptr;
979
980   // If the target wants to know about weak references, print them all.
981   if (MAI->getWeakRefDirective()) {
982     // FIXME: This is not lazy, it would be nice to only print weak references
983     // to stuff that is actually used.  Note that doing so would require targets
984     // to notice uses in operands (due to constant exprs etc).  This should
985     // happen with the MC stuff eventually.
986
987     // Print out module-level global variables here.
988     for (const auto &G : M.globals()) {
989       if (!G.hasExternalWeakLinkage())
990         continue;
991       OutStreamer.EmitSymbolAttribute(getSymbol(&G), MCSA_WeakReference);
992     }
993
994     for (const auto &F : M) {
995       if (!F.hasExternalWeakLinkage())
996         continue;
997       OutStreamer.EmitSymbolAttribute(getSymbol(&F), MCSA_WeakReference);
998     }
999   }
1000
1001   OutStreamer.AddBlankLine();
1002   for (const auto &Alias : M.aliases()) {
1003     MCSymbol *Name = getSymbol(&Alias);
1004
1005     if (Alias.hasExternalLinkage() || !MAI->getWeakRefDirective())
1006       OutStreamer.EmitSymbolAttribute(Name, MCSA_Global);
1007     else if (Alias.hasWeakLinkage() || Alias.hasLinkOnceLinkage())
1008       OutStreamer.EmitSymbolAttribute(Name, MCSA_WeakReference);
1009     else
1010       assert(Alias.hasLocalLinkage() && "Invalid alias linkage");
1011
1012     EmitVisibility(Name, Alias.getVisibility());
1013
1014     // Emit the directives as assignments aka .set:
1015     OutStreamer.EmitAssignment(Name, lowerConstant(Alias.getAliasee()));
1016   }
1017
1018   GCModuleInfo *MI = getAnalysisIfAvailable<GCModuleInfo>();
1019   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
1020   for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
1021     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(**--I))
1022       MP->finishAssembly(M, *MI, *this);
1023
1024   // Emit llvm.ident metadata in an '.ident' directive.
1025   EmitModuleIdents(M);
1026
1027   // Emit __morestack address if needed for indirect calls.
1028   if (MMI->usesMorestackAddr()) {
1029     const MCSection *ReadOnlySection =
1030         getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly(),
1031                                                    /*C=*/nullptr);
1032     OutStreamer.SwitchSection(ReadOnlySection);
1033
1034     MCSymbol *AddrSymbol =
1035         OutContext.GetOrCreateSymbol(StringRef("__morestack_addr"));
1036     OutStreamer.EmitLabel(AddrSymbol);
1037
1038     const DataLayout &DL = *TM.getSubtargetImpl()->getDataLayout();
1039     unsigned PtrSize = DL.getPointerSize(0);
1040     OutStreamer.EmitSymbolValue(GetExternalSymbolSymbol("__morestack"),
1041                                 PtrSize);
1042   }
1043
1044   // If we don't have any trampolines, then we don't require stack memory
1045   // to be executable. Some targets have a directive to declare this.
1046   Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
1047   if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
1048     if (const MCSection *S = MAI->getNonexecutableStackSection(OutContext))
1049       OutStreamer.SwitchSection(S);
1050
1051   // Allow the target to emit any magic that it wants at the end of the file,
1052   // after everything else has gone out.
1053   EmitEndOfAsmFile(M);
1054
1055   delete Mang; Mang = nullptr;
1056   MMI = nullptr;
1057
1058   OutStreamer.Finish();
1059   OutStreamer.reset();
1060
1061   return false;
1062 }
1063
1064 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
1065   this->MF = &MF;
1066   // Get the function symbol.
1067   CurrentFnSym = getSymbol(MF.getFunction());
1068   CurrentFnSymForSize = CurrentFnSym;
1069
1070   if (isVerbose())
1071     LI = &getAnalysis<MachineLoopInfo>();
1072 }
1073
1074 namespace {
1075   // SectionCPs - Keep track the alignment, constpool entries per Section.
1076   struct SectionCPs {
1077     const MCSection *S;
1078     unsigned Alignment;
1079     SmallVector<unsigned, 4> CPEs;
1080     SectionCPs(const MCSection *s, unsigned a) : S(s), Alignment(a) {}
1081   };
1082 }
1083
1084 /// EmitConstantPool - Print to the current output stream assembly
1085 /// representations of the constants in the constant pool MCP. This is
1086 /// used to print out constants which have been "spilled to memory" by
1087 /// the code generator.
1088 ///
1089 void AsmPrinter::EmitConstantPool() {
1090   const MachineConstantPool *MCP = MF->getConstantPool();
1091   const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
1092   if (CP.empty()) return;
1093
1094   // Calculate sections for constant pool entries. We collect entries to go into
1095   // the same section together to reduce amount of section switch statements.
1096   SmallVector<SectionCPs, 4> CPSections;
1097   for (unsigned i = 0, e = CP.size(); i != e; ++i) {
1098     const MachineConstantPoolEntry &CPE = CP[i];
1099     unsigned Align = CPE.getAlignment();
1100
1101     SectionKind Kind =
1102         CPE.getSectionKind(TM.getSubtargetImpl()->getDataLayout());
1103
1104     const Constant *C = nullptr;
1105     if (!CPE.isMachineConstantPoolEntry())
1106       C = CPE.Val.ConstVal;
1107
1108     const MCSection *S = getObjFileLowering().getSectionForConstant(Kind, C);
1109
1110     // The number of sections are small, just do a linear search from the
1111     // last section to the first.
1112     bool Found = false;
1113     unsigned SecIdx = CPSections.size();
1114     while (SecIdx != 0) {
1115       if (CPSections[--SecIdx].S == S) {
1116         Found = true;
1117         break;
1118       }
1119     }
1120     if (!Found) {
1121       SecIdx = CPSections.size();
1122       CPSections.push_back(SectionCPs(S, Align));
1123     }
1124
1125     if (Align > CPSections[SecIdx].Alignment)
1126       CPSections[SecIdx].Alignment = Align;
1127     CPSections[SecIdx].CPEs.push_back(i);
1128   }
1129
1130   // Now print stuff into the calculated sections.
1131   const MCSection *CurSection = nullptr;
1132   unsigned Offset = 0;
1133   for (unsigned i = 0, e = CPSections.size(); i != e; ++i) {
1134     for (unsigned j = 0, ee = CPSections[i].CPEs.size(); j != ee; ++j) {
1135       unsigned CPI = CPSections[i].CPEs[j];
1136       MCSymbol *Sym = GetCPISymbol(CPI);
1137       if (!Sym->isUndefined())
1138         continue;
1139
1140       if (CurSection != CPSections[i].S) {
1141         OutStreamer.SwitchSection(CPSections[i].S);
1142         EmitAlignment(Log2_32(CPSections[i].Alignment));
1143         CurSection = CPSections[i].S;
1144         Offset = 0;
1145       }
1146
1147       MachineConstantPoolEntry CPE = CP[CPI];
1148
1149       // Emit inter-object padding for alignment.
1150       unsigned AlignMask = CPE.getAlignment() - 1;
1151       unsigned NewOffset = (Offset + AlignMask) & ~AlignMask;
1152       OutStreamer.EmitZeros(NewOffset - Offset);
1153
1154       Type *Ty = CPE.getType();
1155       Offset = NewOffset +
1156                TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(Ty);
1157
1158       OutStreamer.EmitLabel(Sym);
1159       if (CPE.isMachineConstantPoolEntry())
1160         EmitMachineConstantPoolValue(CPE.Val.MachineCPVal);
1161       else
1162         EmitGlobalConstant(CPE.Val.ConstVal);
1163     }
1164   }
1165 }
1166
1167 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
1168 /// by the current function to the current output stream.
1169 ///
1170 void AsmPrinter::EmitJumpTableInfo() {
1171   const DataLayout *DL = MF->getSubtarget().getDataLayout();
1172   const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
1173   if (!MJTI) return;
1174   if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_Inline) return;
1175   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
1176   if (JT.empty()) return;
1177
1178   // Pick the directive to use to print the jump table entries, and switch to
1179   // the appropriate section.
1180   const Function *F = MF->getFunction();
1181   bool JTInDiffSection = false;
1182   if (// In PIC mode, we need to emit the jump table to the same section as the
1183       // function body itself, otherwise the label differences won't make sense.
1184       // FIXME: Need a better predicate for this: what about custom entries?
1185       MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 ||
1186       // We should also do if the section name is NULL or function is declared
1187       // in discardable section
1188       // FIXME: this isn't the right predicate, should be based on the MCSection
1189       // for the function.
1190       F->isWeakForLinker()) {
1191     OutStreamer.SwitchSection(
1192         getObjFileLowering().SectionForGlobal(F, *Mang, TM));
1193   } else {
1194     // Otherwise, drop it in the readonly section.
1195     const MCSection *ReadOnlySection =
1196         getObjFileLowering().getSectionForConstant(SectionKind::getReadOnly(),
1197                                                    /*C=*/nullptr);
1198     OutStreamer.SwitchSection(ReadOnlySection);
1199     JTInDiffSection = true;
1200   }
1201
1202   EmitAlignment(Log2_32(
1203       MJTI->getEntryAlignment(*TM.getSubtargetImpl()->getDataLayout())));
1204
1205   // Jump tables in code sections are marked with a data_region directive
1206   // where that's supported.
1207   if (!JTInDiffSection)
1208     OutStreamer.EmitDataRegion(MCDR_DataRegionJT32);
1209
1210   for (unsigned JTI = 0, e = JT.size(); JTI != e; ++JTI) {
1211     const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
1212
1213     // If this jump table was deleted, ignore it.
1214     if (JTBBs.empty()) continue;
1215
1216     // For the EK_LabelDifference32 entry, if using .set avoids a relocation,
1217     /// emit a .set directive for each unique entry.
1218     if (MJTI->getEntryKind() == MachineJumpTableInfo::EK_LabelDifference32 &&
1219         MAI->doesSetDirectiveSuppressesReloc()) {
1220       SmallPtrSet<const MachineBasicBlock*, 16> EmittedSets;
1221       const TargetLowering *TLI = TM.getSubtargetImpl()->getTargetLowering();
1222       const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF,JTI,OutContext);
1223       for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
1224         const MachineBasicBlock *MBB = JTBBs[ii];
1225         if (!EmittedSets.insert(MBB).second)
1226           continue;
1227
1228         // .set LJTSet, LBB32-base
1229         const MCExpr *LHS =
1230           MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1231         OutStreamer.EmitAssignment(GetJTSetSymbol(JTI, MBB->getNumber()),
1232                                 MCBinaryExpr::CreateSub(LHS, Base, OutContext));
1233       }
1234     }
1235
1236     // On some targets (e.g. Darwin) we want to emit two consecutive labels
1237     // before each jump table.  The first label is never referenced, but tells
1238     // the assembler and linker the extents of the jump table object.  The
1239     // second label is actually referenced by the code.
1240     if (JTInDiffSection && DL->hasLinkerPrivateGlobalPrefix())
1241       // FIXME: This doesn't have to have any specific name, just any randomly
1242       // named and numbered 'l' label would work.  Simplify GetJTISymbol.
1243       OutStreamer.EmitLabel(GetJTISymbol(JTI, true));
1244
1245     OutStreamer.EmitLabel(GetJTISymbol(JTI));
1246
1247     for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
1248       EmitJumpTableEntry(MJTI, JTBBs[ii], JTI);
1249   }
1250   if (!JTInDiffSection)
1251     OutStreamer.EmitDataRegion(MCDR_DataRegionEnd);
1252 }
1253
1254 /// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
1255 /// current stream.
1256 void AsmPrinter::EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
1257                                     const MachineBasicBlock *MBB,
1258                                     unsigned UID) const {
1259   assert(MBB && MBB->getNumber() >= 0 && "Invalid basic block");
1260   const MCExpr *Value = nullptr;
1261   switch (MJTI->getEntryKind()) {
1262   case MachineJumpTableInfo::EK_Inline:
1263     llvm_unreachable("Cannot emit EK_Inline jump table entry");
1264   case MachineJumpTableInfo::EK_Custom32:
1265     Value =
1266         TM.getSubtargetImpl()->getTargetLowering()->LowerCustomJumpTableEntry(
1267             MJTI, MBB, UID, OutContext);
1268     break;
1269   case MachineJumpTableInfo::EK_BlockAddress:
1270     // EK_BlockAddress - Each entry is a plain address of block, e.g.:
1271     //     .word LBB123
1272     Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1273     break;
1274   case MachineJumpTableInfo::EK_GPRel32BlockAddress: {
1275     // EK_GPRel32BlockAddress - Each entry is an address of block, encoded
1276     // with a relocation as gp-relative, e.g.:
1277     //     .gprel32 LBB123
1278     MCSymbol *MBBSym = MBB->getSymbol();
1279     OutStreamer.EmitGPRel32Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1280     return;
1281   }
1282
1283   case MachineJumpTableInfo::EK_GPRel64BlockAddress: {
1284     // EK_GPRel64BlockAddress - Each entry is an address of block, encoded
1285     // with a relocation as gp-relative, e.g.:
1286     //     .gpdword LBB123
1287     MCSymbol *MBBSym = MBB->getSymbol();
1288     OutStreamer.EmitGPRel64Value(MCSymbolRefExpr::Create(MBBSym, OutContext));
1289     return;
1290   }
1291
1292   case MachineJumpTableInfo::EK_LabelDifference32: {
1293     // Each entry is the address of the block minus the address of the jump
1294     // table. This is used for PIC jump tables where gprel32 is not supported.
1295     // e.g.:
1296     //      .word LBB123 - LJTI1_2
1297     // If the .set directive avoids relocations, this is emitted as:
1298     //      .set L4_5_set_123, LBB123 - LJTI1_2
1299     //      .word L4_5_set_123
1300     if (MAI->doesSetDirectiveSuppressesReloc()) {
1301       Value = MCSymbolRefExpr::Create(GetJTSetSymbol(UID, MBB->getNumber()),
1302                                       OutContext);
1303       break;
1304     }
1305     Value = MCSymbolRefExpr::Create(MBB->getSymbol(), OutContext);
1306     const TargetLowering *TLI = TM.getSubtargetImpl()->getTargetLowering();
1307     const MCExpr *Base = TLI->getPICJumpTableRelocBaseExpr(MF, UID, OutContext);
1308     Value = MCBinaryExpr::CreateSub(Value, Base, OutContext);
1309     break;
1310   }
1311   }
1312
1313   assert(Value && "Unknown entry kind!");
1314
1315   unsigned EntrySize =
1316       MJTI->getEntrySize(*TM.getSubtargetImpl()->getDataLayout());
1317   OutStreamer.EmitValue(Value, EntrySize);
1318 }
1319
1320
1321 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
1322 /// special global used by LLVM.  If so, emit it and return true, otherwise
1323 /// do nothing and return false.
1324 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
1325   if (GV->getName() == "llvm.used") {
1326     if (MAI->hasNoDeadStrip())    // No need to emit this at all.
1327       EmitLLVMUsedList(cast<ConstantArray>(GV->getInitializer()));
1328     return true;
1329   }
1330
1331   // Ignore debug and non-emitted data.  This handles llvm.compiler.used.
1332   if (StringRef(GV->getSection()) == "llvm.metadata" ||
1333       GV->hasAvailableExternallyLinkage())
1334     return true;
1335
1336   if (!GV->hasAppendingLinkage()) return false;
1337
1338   assert(GV->hasInitializer() && "Not a special LLVM global!");
1339
1340   if (GV->getName() == "llvm.global_ctors") {
1341     EmitXXStructorList(GV->getInitializer(), /* isCtor */ true);
1342
1343     if (TM.getRelocationModel() == Reloc::Static &&
1344         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1345       StringRef Sym(".constructors_used");
1346       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1347                                       MCSA_Reference);
1348     }
1349     return true;
1350   }
1351
1352   if (GV->getName() == "llvm.global_dtors") {
1353     EmitXXStructorList(GV->getInitializer(), /* isCtor */ false);
1354
1355     if (TM.getRelocationModel() == Reloc::Static &&
1356         MAI->hasStaticCtorDtorReferenceInStaticMode()) {
1357       StringRef Sym(".destructors_used");
1358       OutStreamer.EmitSymbolAttribute(OutContext.GetOrCreateSymbol(Sym),
1359                                       MCSA_Reference);
1360     }
1361     return true;
1362   }
1363
1364   return false;
1365 }
1366
1367 /// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
1368 /// global in the specified llvm.used list for which emitUsedDirectiveFor
1369 /// is true, as being used with this directive.
1370 void AsmPrinter::EmitLLVMUsedList(const ConstantArray *InitList) {
1371   // Should be an array of 'i8*'.
1372   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
1373     const GlobalValue *GV =
1374       dyn_cast<GlobalValue>(InitList->getOperand(i)->stripPointerCasts());
1375     if (GV)
1376       OutStreamer.EmitSymbolAttribute(getSymbol(GV), MCSA_NoDeadStrip);
1377   }
1378 }
1379
1380 namespace {
1381 struct Structor {
1382   Structor() : Priority(0), Func(nullptr), ComdatKey(nullptr) {}
1383   int Priority;
1384   llvm::Constant *Func;
1385   llvm::GlobalValue *ComdatKey;
1386 };
1387 } // end namespace
1388
1389 /// EmitXXStructorList - Emit the ctor or dtor list taking into account the init
1390 /// priority.
1391 void AsmPrinter::EmitXXStructorList(const Constant *List, bool isCtor) {
1392   // Should be an array of '{ int, void ()* }' structs.  The first value is the
1393   // init priority.
1394   if (!isa<ConstantArray>(List)) return;
1395
1396   // Sanity check the structors list.
1397   const ConstantArray *InitList = dyn_cast<ConstantArray>(List);
1398   if (!InitList) return; // Not an array!
1399   StructType *ETy = dyn_cast<StructType>(InitList->getType()->getElementType());
1400   // FIXME: Only allow the 3-field form in LLVM 4.0.
1401   if (!ETy || ETy->getNumElements() < 2 || ETy->getNumElements() > 3)
1402     return; // Not an array of two or three elements!
1403   if (!isa<IntegerType>(ETy->getTypeAtIndex(0U)) ||
1404       !isa<PointerType>(ETy->getTypeAtIndex(1U))) return; // Not (int, ptr).
1405   if (ETy->getNumElements() == 3 && !isa<PointerType>(ETy->getTypeAtIndex(2U)))
1406     return; // Not (int, ptr, ptr).
1407
1408   // Gather the structors in a form that's convenient for sorting by priority.
1409   SmallVector<Structor, 8> Structors;
1410   for (Value *O : InitList->operands()) {
1411     ConstantStruct *CS = dyn_cast<ConstantStruct>(O);
1412     if (!CS) continue; // Malformed.
1413     if (CS->getOperand(1)->isNullValue())
1414       break;  // Found a null terminator, skip the rest.
1415     ConstantInt *Priority = dyn_cast<ConstantInt>(CS->getOperand(0));
1416     if (!Priority) continue; // Malformed.
1417     Structors.push_back(Structor());
1418     Structor &S = Structors.back();
1419     S.Priority = Priority->getLimitedValue(65535);
1420     S.Func = CS->getOperand(1);
1421     if (ETy->getNumElements() == 3 && !CS->getOperand(2)->isNullValue())
1422       S.ComdatKey = dyn_cast<GlobalValue>(CS->getOperand(2)->stripPointerCasts());
1423   }
1424
1425   // Emit the function pointers in the target-specific order
1426   const DataLayout *DL = TM.getSubtargetImpl()->getDataLayout();
1427   unsigned Align = Log2_32(DL->getPointerPrefAlignment());
1428   std::stable_sort(Structors.begin(), Structors.end(),
1429                    [](const Structor &L,
1430                       const Structor &R) { return L.Priority < R.Priority; });
1431   for (Structor &S : Structors) {
1432     const TargetLoweringObjectFile &Obj = getObjFileLowering();
1433     const MCSymbol *KeySym = nullptr;
1434     if (GlobalValue *GV = S.ComdatKey) {
1435       if (GV->hasAvailableExternallyLinkage())
1436         // If the associated variable is available_externally, some other TU
1437         // will provide its dynamic initializer.
1438         continue;
1439
1440       KeySym = getSymbol(GV);
1441     }
1442     const MCSection *OutputSection =
1443         (isCtor ? Obj.getStaticCtorSection(S.Priority, KeySym)
1444                 : Obj.getStaticDtorSection(S.Priority, KeySym));
1445     OutStreamer.SwitchSection(OutputSection);
1446     if (OutStreamer.getCurrentSection() != OutStreamer.getPreviousSection())
1447       EmitAlignment(Align);
1448     EmitXXStructor(S.Func);
1449   }
1450 }
1451
1452 void AsmPrinter::EmitModuleIdents(Module &M) {
1453   if (!MAI->hasIdentDirective())
1454     return;
1455
1456   if (const NamedMDNode *NMD = M.getNamedMetadata("llvm.ident")) {
1457     for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
1458       const MDNode *N = NMD->getOperand(i);
1459       assert(N->getNumOperands() == 1 &&
1460              "llvm.ident metadata entry can have only one operand");
1461       const MDString *S = cast<MDString>(N->getOperand(0));
1462       OutStreamer.EmitIdent(S->getString());
1463     }
1464   }
1465 }
1466
1467 //===--------------------------------------------------------------------===//
1468 // Emission and print routines
1469 //
1470
1471 /// EmitInt8 - Emit a byte directive and value.
1472 ///
1473 void AsmPrinter::EmitInt8(int Value) const {
1474   OutStreamer.EmitIntValue(Value, 1);
1475 }
1476
1477 /// EmitInt16 - Emit a short directive and value.
1478 ///
1479 void AsmPrinter::EmitInt16(int Value) const {
1480   OutStreamer.EmitIntValue(Value, 2);
1481 }
1482
1483 /// EmitInt32 - Emit a long directive and value.
1484 ///
1485 void AsmPrinter::EmitInt32(int Value) const {
1486   OutStreamer.EmitIntValue(Value, 4);
1487 }
1488
1489 /// Emit something like ".long Hi-Lo" where the size in bytes of the directive
1490 /// is specified by Size and Hi/Lo specify the labels. This implicitly uses
1491 /// .set if it avoids relocations.
1492 void AsmPrinter::EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
1493                                      unsigned Size) const {
1494   // Get the Hi-Lo expression.
1495   const MCExpr *Diff =
1496     MCBinaryExpr::CreateSub(MCSymbolRefExpr::Create(Hi, OutContext),
1497                             MCSymbolRefExpr::Create(Lo, OutContext),
1498                             OutContext);
1499
1500   if (!MAI->doesSetDirectiveSuppressesReloc()) {
1501     OutStreamer.EmitValue(Diff, Size);
1502     return;
1503   }
1504
1505   // Otherwise, emit with .set (aka assignment).
1506   MCSymbol *SetLabel = GetTempSymbol("set", SetCounter++);
1507   OutStreamer.EmitAssignment(SetLabel, Diff);
1508   OutStreamer.EmitSymbolValue(SetLabel, Size);
1509 }
1510
1511 /// EmitLabelPlusOffset - Emit something like ".long Label+Offset"
1512 /// where the size in bytes of the directive is specified by Size and Label
1513 /// specifies the label.  This implicitly uses .set if it is available.
1514 void AsmPrinter::EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
1515                                      unsigned Size,
1516                                      bool IsSectionRelative) const {
1517   if (MAI->needsDwarfSectionOffsetDirective() && IsSectionRelative) {
1518     OutStreamer.EmitCOFFSecRel32(Label);
1519     return;
1520   }
1521
1522   // Emit Label+Offset (or just Label if Offset is zero)
1523   const MCExpr *Expr = MCSymbolRefExpr::Create(Label, OutContext);
1524   if (Offset)
1525     Expr = MCBinaryExpr::CreateAdd(
1526         Expr, MCConstantExpr::Create(Offset, OutContext), OutContext);
1527
1528   OutStreamer.EmitValue(Expr, Size);
1529 }
1530
1531 //===----------------------------------------------------------------------===//
1532
1533 // EmitAlignment - Emit an alignment directive to the specified power of
1534 // two boundary.  For example, if you pass in 3 here, you will get an 8
1535 // byte alignment.  If a global value is specified, and if that global has
1536 // an explicit alignment requested, it will override the alignment request
1537 // if required for correctness.
1538 //
1539 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalObject *GV) const {
1540   if (GV)
1541     NumBits = getGVAlignmentLog2(GV, *TM.getSubtargetImpl()->getDataLayout(),
1542                                  NumBits);
1543
1544   if (NumBits == 0) return;   // 1-byte aligned: no need to emit alignment.
1545
1546   assert(NumBits <
1547              static_cast<unsigned>(std::numeric_limits<unsigned>::digits) &&
1548          "undefined behavior");
1549   if (getCurrentSection()->getKind().isText())
1550     OutStreamer.EmitCodeAlignment(1u << NumBits);
1551   else
1552     OutStreamer.EmitValueToAlignment(1u << NumBits);
1553 }
1554
1555 //===----------------------------------------------------------------------===//
1556 // Constant emission.
1557 //===----------------------------------------------------------------------===//
1558
1559 const MCExpr *AsmPrinter::lowerConstant(const Constant *CV) {
1560   MCContext &Ctx = OutContext;
1561
1562   if (CV->isNullValue() || isa<UndefValue>(CV))
1563     return MCConstantExpr::Create(0, Ctx);
1564
1565   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
1566     return MCConstantExpr::Create(CI->getZExtValue(), Ctx);
1567
1568   if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
1569     return MCSymbolRefExpr::Create(getSymbol(GV), Ctx);
1570
1571   if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
1572     return MCSymbolRefExpr::Create(GetBlockAddressSymbol(BA), Ctx);
1573
1574   const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
1575   if (!CE) {
1576     llvm_unreachable("Unknown constant value to lower!");
1577   }
1578
1579   if (const MCExpr *RelocExpr
1580       = getObjFileLowering().getExecutableRelativeSymbol(CE, *Mang, TM))
1581     return RelocExpr;
1582
1583   switch (CE->getOpcode()) {
1584   default:
1585     // If the code isn't optimized, there may be outstanding folding
1586     // opportunities. Attempt to fold the expression using DataLayout as a
1587     // last resort before giving up.
1588     if (Constant *C = ConstantFoldConstantExpression(
1589             CE, TM.getSubtargetImpl()->getDataLayout()))
1590       if (C != CE)
1591         return lowerConstant(C);
1592
1593     // Otherwise report the problem to the user.
1594     {
1595       std::string S;
1596       raw_string_ostream OS(S);
1597       OS << "Unsupported expression in static initializer: ";
1598       CE->printAsOperand(OS, /*PrintType=*/false,
1599                      !MF ? nullptr : MF->getFunction()->getParent());
1600       report_fatal_error(OS.str());
1601     }
1602   case Instruction::GetElementPtr: {
1603     const DataLayout &DL = *TM.getSubtargetImpl()->getDataLayout();
1604     // Generate a symbolic expression for the byte address
1605     APInt OffsetAI(DL.getPointerTypeSizeInBits(CE->getType()), 0);
1606     cast<GEPOperator>(CE)->accumulateConstantOffset(DL, OffsetAI);
1607
1608     const MCExpr *Base = lowerConstant(CE->getOperand(0));
1609     if (!OffsetAI)
1610       return Base;
1611
1612     int64_t Offset = OffsetAI.getSExtValue();
1613     return MCBinaryExpr::CreateAdd(Base, MCConstantExpr::Create(Offset, Ctx),
1614                                    Ctx);
1615   }
1616
1617   case Instruction::Trunc:
1618     // We emit the value and depend on the assembler to truncate the generated
1619     // expression properly.  This is important for differences between
1620     // blockaddress labels.  Since the two labels are in the same function, it
1621     // is reasonable to treat their delta as a 32-bit value.
1622     // FALL THROUGH.
1623   case Instruction::BitCast:
1624     return lowerConstant(CE->getOperand(0));
1625
1626   case Instruction::IntToPtr: {
1627     const DataLayout &DL = *TM.getSubtargetImpl()->getDataLayout();
1628     // Handle casts to pointers by changing them into casts to the appropriate
1629     // integer type.  This promotes constant folding and simplifies this code.
1630     Constant *Op = CE->getOperand(0);
1631     Op = ConstantExpr::getIntegerCast(Op, DL.getIntPtrType(CV->getType()),
1632                                       false/*ZExt*/);
1633     return lowerConstant(Op);
1634   }
1635
1636   case Instruction::PtrToInt: {
1637     const DataLayout &DL = *TM.getSubtargetImpl()->getDataLayout();
1638     // Support only foldable casts to/from pointers that can be eliminated by
1639     // changing the pointer to the appropriately sized integer type.
1640     Constant *Op = CE->getOperand(0);
1641     Type *Ty = CE->getType();
1642
1643     const MCExpr *OpExpr = lowerConstant(Op);
1644
1645     // We can emit the pointer value into this slot if the slot is an
1646     // integer slot equal to the size of the pointer.
1647     if (DL.getTypeAllocSize(Ty) == DL.getTypeAllocSize(Op->getType()))
1648       return OpExpr;
1649
1650     // Otherwise the pointer is smaller than the resultant integer, mask off
1651     // the high bits so we are sure to get a proper truncation if the input is
1652     // a constant expr.
1653     unsigned InBits = DL.getTypeAllocSizeInBits(Op->getType());
1654     const MCExpr *MaskExpr = MCConstantExpr::Create(~0ULL >> (64-InBits), Ctx);
1655     return MCBinaryExpr::CreateAnd(OpExpr, MaskExpr, Ctx);
1656   }
1657
1658   // The MC library also has a right-shift operator, but it isn't consistently
1659   // signed or unsigned between different targets.
1660   case Instruction::Add:
1661   case Instruction::Sub:
1662   case Instruction::Mul:
1663   case Instruction::SDiv:
1664   case Instruction::SRem:
1665   case Instruction::Shl:
1666   case Instruction::And:
1667   case Instruction::Or:
1668   case Instruction::Xor: {
1669     const MCExpr *LHS = lowerConstant(CE->getOperand(0));
1670     const MCExpr *RHS = lowerConstant(CE->getOperand(1));
1671     switch (CE->getOpcode()) {
1672     default: llvm_unreachable("Unknown binary operator constant cast expr");
1673     case Instruction::Add: return MCBinaryExpr::CreateAdd(LHS, RHS, Ctx);
1674     case Instruction::Sub: return MCBinaryExpr::CreateSub(LHS, RHS, Ctx);
1675     case Instruction::Mul: return MCBinaryExpr::CreateMul(LHS, RHS, Ctx);
1676     case Instruction::SDiv: return MCBinaryExpr::CreateDiv(LHS, RHS, Ctx);
1677     case Instruction::SRem: return MCBinaryExpr::CreateMod(LHS, RHS, Ctx);
1678     case Instruction::Shl: return MCBinaryExpr::CreateShl(LHS, RHS, Ctx);
1679     case Instruction::And: return MCBinaryExpr::CreateAnd(LHS, RHS, Ctx);
1680     case Instruction::Or:  return MCBinaryExpr::CreateOr (LHS, RHS, Ctx);
1681     case Instruction::Xor: return MCBinaryExpr::CreateXor(LHS, RHS, Ctx);
1682     }
1683   }
1684   }
1685 }
1686
1687 static void emitGlobalConstantImpl(const Constant *C, AsmPrinter &AP);
1688
1689 /// isRepeatedByteSequence - Determine whether the given value is
1690 /// composed of a repeated sequence of identical bytes and return the
1691 /// byte value.  If it is not a repeated sequence, return -1.
1692 static int isRepeatedByteSequence(const ConstantDataSequential *V) {
1693   StringRef Data = V->getRawDataValues();
1694   assert(!Data.empty() && "Empty aggregates should be CAZ node");
1695   char C = Data[0];
1696   for (unsigned i = 1, e = Data.size(); i != e; ++i)
1697     if (Data[i] != C) return -1;
1698   return static_cast<uint8_t>(C); // Ensure 255 is not returned as -1.
1699 }
1700
1701
1702 /// isRepeatedByteSequence - Determine whether the given value is
1703 /// composed of a repeated sequence of identical bytes and return the
1704 /// byte value.  If it is not a repeated sequence, return -1.
1705 static int isRepeatedByteSequence(const Value *V, TargetMachine &TM) {
1706
1707   if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
1708     if (CI->getBitWidth() > 64) return -1;
1709
1710     uint64_t Size =
1711         TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(V->getType());
1712     uint64_t Value = CI->getZExtValue();
1713
1714     // Make sure the constant is at least 8 bits long and has a power
1715     // of 2 bit width.  This guarantees the constant bit width is
1716     // always a multiple of 8 bits, avoiding issues with padding out
1717     // to Size and other such corner cases.
1718     if (CI->getBitWidth() < 8 || !isPowerOf2_64(CI->getBitWidth())) return -1;
1719
1720     uint8_t Byte = static_cast<uint8_t>(Value);
1721
1722     for (unsigned i = 1; i < Size; ++i) {
1723       Value >>= 8;
1724       if (static_cast<uint8_t>(Value) != Byte) return -1;
1725     }
1726     return Byte;
1727   }
1728   if (const ConstantArray *CA = dyn_cast<ConstantArray>(V)) {
1729     // Make sure all array elements are sequences of the same repeated
1730     // byte.
1731     assert(CA->getNumOperands() != 0 && "Should be a CAZ");
1732     int Byte = isRepeatedByteSequence(CA->getOperand(0), TM);
1733     if (Byte == -1) return -1;
1734
1735     for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i) {
1736       int ThisByte = isRepeatedByteSequence(CA->getOperand(i), TM);
1737       if (ThisByte == -1) return -1;
1738       if (Byte != ThisByte) return -1;
1739     }
1740     return Byte;
1741   }
1742
1743   if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(V))
1744     return isRepeatedByteSequence(CDS);
1745
1746   return -1;
1747 }
1748
1749 static void emitGlobalConstantDataSequential(const ConstantDataSequential *CDS,
1750                                              AsmPrinter &AP){
1751
1752   // See if we can aggregate this into a .fill, if so, emit it as such.
1753   int Value = isRepeatedByteSequence(CDS, AP.TM);
1754   if (Value != -1) {
1755     uint64_t Bytes =
1756         AP.TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(
1757             CDS->getType());
1758     // Don't emit a 1-byte object as a .fill.
1759     if (Bytes > 1)
1760       return AP.OutStreamer.EmitFill(Bytes, Value);
1761   }
1762
1763   // If this can be emitted with .ascii/.asciz, emit it as such.
1764   if (CDS->isString())
1765     return AP.OutStreamer.EmitBytes(CDS->getAsString());
1766
1767   // Otherwise, emit the values in successive locations.
1768   unsigned ElementByteSize = CDS->getElementByteSize();
1769   if (isa<IntegerType>(CDS->getElementType())) {
1770     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1771       if (AP.isVerbose())
1772         AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1773                                                 CDS->getElementAsInteger(i));
1774       AP.OutStreamer.EmitIntValue(CDS->getElementAsInteger(i),
1775                                   ElementByteSize);
1776     }
1777   } else if (ElementByteSize == 4) {
1778     // FP Constants are printed as integer constants to avoid losing
1779     // precision.
1780     assert(CDS->getElementType()->isFloatTy());
1781     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1782       union {
1783         float F;
1784         uint32_t I;
1785       };
1786
1787       F = CDS->getElementAsFloat(i);
1788       if (AP.isVerbose())
1789         AP.OutStreamer.GetCommentOS() << "float " << F << '\n';
1790       AP.OutStreamer.EmitIntValue(I, 4);
1791     }
1792   } else {
1793     assert(CDS->getElementType()->isDoubleTy());
1794     for (unsigned i = 0, e = CDS->getNumElements(); i != e; ++i) {
1795       union {
1796         double F;
1797         uint64_t I;
1798       };
1799
1800       F = CDS->getElementAsDouble(i);
1801       if (AP.isVerbose())
1802         AP.OutStreamer.GetCommentOS() << "double " << F << '\n';
1803       AP.OutStreamer.EmitIntValue(I, 8);
1804     }
1805   }
1806
1807   const DataLayout &DL = *AP.TM.getSubtargetImpl()->getDataLayout();
1808   unsigned Size = DL.getTypeAllocSize(CDS->getType());
1809   unsigned EmittedSize = DL.getTypeAllocSize(CDS->getType()->getElementType()) *
1810                         CDS->getNumElements();
1811   if (unsigned Padding = Size - EmittedSize)
1812     AP.OutStreamer.EmitZeros(Padding);
1813
1814 }
1815
1816 static void emitGlobalConstantArray(const ConstantArray *CA, AsmPrinter &AP) {
1817   // See if we can aggregate some values.  Make sure it can be
1818   // represented as a series of bytes of the constant value.
1819   int Value = isRepeatedByteSequence(CA, AP.TM);
1820
1821   if (Value != -1) {
1822     uint64_t Bytes =
1823         AP.TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(
1824             CA->getType());
1825     AP.OutStreamer.EmitFill(Bytes, Value);
1826   }
1827   else {
1828     for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1829       emitGlobalConstantImpl(CA->getOperand(i), AP);
1830   }
1831 }
1832
1833 static void emitGlobalConstantVector(const ConstantVector *CV, AsmPrinter &AP) {
1834   for (unsigned i = 0, e = CV->getType()->getNumElements(); i != e; ++i)
1835     emitGlobalConstantImpl(CV->getOperand(i), AP);
1836
1837   const DataLayout &DL = *AP.TM.getSubtargetImpl()->getDataLayout();
1838   unsigned Size = DL.getTypeAllocSize(CV->getType());
1839   unsigned EmittedSize = DL.getTypeAllocSize(CV->getType()->getElementType()) *
1840                          CV->getType()->getNumElements();
1841   if (unsigned Padding = Size - EmittedSize)
1842     AP.OutStreamer.EmitZeros(Padding);
1843 }
1844
1845 static void emitGlobalConstantStruct(const ConstantStruct *CS, AsmPrinter &AP) {
1846   // Print the fields in successive locations. Pad to align if needed!
1847   const DataLayout *DL = AP.TM.getSubtargetImpl()->getDataLayout();
1848   unsigned Size = DL->getTypeAllocSize(CS->getType());
1849   const StructLayout *Layout = DL->getStructLayout(CS->getType());
1850   uint64_t SizeSoFar = 0;
1851   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i) {
1852     const Constant *Field = CS->getOperand(i);
1853
1854     // Check if padding is needed and insert one or more 0s.
1855     uint64_t FieldSize = DL->getTypeAllocSize(Field->getType());
1856     uint64_t PadSize = ((i == e-1 ? Size : Layout->getElementOffset(i+1))
1857                         - Layout->getElementOffset(i)) - FieldSize;
1858     SizeSoFar += FieldSize + PadSize;
1859
1860     // Now print the actual field value.
1861     emitGlobalConstantImpl(Field, AP);
1862
1863     // Insert padding - this may include padding to increase the size of the
1864     // current field up to the ABI size (if the struct is not packed) as well
1865     // as padding to ensure that the next field starts at the right offset.
1866     AP.OutStreamer.EmitZeros(PadSize);
1867   }
1868   assert(SizeSoFar == Layout->getSizeInBytes() &&
1869          "Layout of constant struct may be incorrect!");
1870 }
1871
1872 static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP) {
1873   APInt API = CFP->getValueAPF().bitcastToAPInt();
1874
1875   // First print a comment with what we think the original floating-point value
1876   // should have been.
1877   if (AP.isVerbose()) {
1878     SmallString<8> StrVal;
1879     CFP->getValueAPF().toString(StrVal);
1880
1881     if (CFP->getType())
1882       CFP->getType()->print(AP.OutStreamer.GetCommentOS());
1883     else
1884       AP.OutStreamer.GetCommentOS() << "Printing <null> Type";
1885     AP.OutStreamer.GetCommentOS() << ' ' << StrVal << '\n';
1886   }
1887
1888   // Now iterate through the APInt chunks, emitting them in endian-correct
1889   // order, possibly with a smaller chunk at beginning/end (e.g. for x87 80-bit
1890   // floats).
1891   unsigned NumBytes = API.getBitWidth() / 8;
1892   unsigned TrailingBytes = NumBytes % sizeof(uint64_t);
1893   const uint64_t *p = API.getRawData();
1894
1895   // PPC's long double has odd notions of endianness compared to how LLVM
1896   // handles it: p[0] goes first for *big* endian on PPC.
1897   if (AP.TM.getSubtargetImpl()->getDataLayout()->isBigEndian() &&
1898       !CFP->getType()->isPPC_FP128Ty()) {
1899     int Chunk = API.getNumWords() - 1;
1900
1901     if (TrailingBytes)
1902       AP.OutStreamer.EmitIntValue(p[Chunk--], TrailingBytes);
1903
1904     for (; Chunk >= 0; --Chunk)
1905       AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1906   } else {
1907     unsigned Chunk;
1908     for (Chunk = 0; Chunk < NumBytes / sizeof(uint64_t); ++Chunk)
1909       AP.OutStreamer.EmitIntValue(p[Chunk], sizeof(uint64_t));
1910
1911     if (TrailingBytes)
1912       AP.OutStreamer.EmitIntValue(p[Chunk], TrailingBytes);
1913   }
1914
1915   // Emit the tail padding for the long double.
1916   const DataLayout &DL = *AP.TM.getSubtargetImpl()->getDataLayout();
1917   AP.OutStreamer.EmitZeros(DL.getTypeAllocSize(CFP->getType()) -
1918                            DL.getTypeStoreSize(CFP->getType()));
1919 }
1920
1921 static void emitGlobalConstantLargeInt(const ConstantInt *CI, AsmPrinter &AP) {
1922   const DataLayout *DL = AP.TM.getSubtargetImpl()->getDataLayout();
1923   unsigned BitWidth = CI->getBitWidth();
1924
1925   // Copy the value as we may massage the layout for constants whose bit width
1926   // is not a multiple of 64-bits.
1927   APInt Realigned(CI->getValue());
1928   uint64_t ExtraBits = 0;
1929   unsigned ExtraBitsSize = BitWidth & 63;
1930
1931   if (ExtraBitsSize) {
1932     // The bit width of the data is not a multiple of 64-bits.
1933     // The extra bits are expected to be at the end of the chunk of the memory.
1934     // Little endian:
1935     // * Nothing to be done, just record the extra bits to emit.
1936     // Big endian:
1937     // * Record the extra bits to emit.
1938     // * Realign the raw data to emit the chunks of 64-bits.
1939     if (DL->isBigEndian()) {
1940       // Basically the structure of the raw data is a chunk of 64-bits cells:
1941       //    0        1         BitWidth / 64
1942       // [chunk1][chunk2] ... [chunkN].
1943       // The most significant chunk is chunkN and it should be emitted first.
1944       // However, due to the alignment issue chunkN contains useless bits.
1945       // Realign the chunks so that they contain only useless information:
1946       // ExtraBits     0       1       (BitWidth / 64) - 1
1947       //       chu[nk1 chu][nk2 chu] ... [nkN-1 chunkN]
1948       ExtraBits = Realigned.getRawData()[0] &
1949         (((uint64_t)-1) >> (64 - ExtraBitsSize));
1950       Realigned = Realigned.lshr(ExtraBitsSize);
1951     } else
1952       ExtraBits = Realigned.getRawData()[BitWidth / 64];
1953   }
1954
1955   // We don't expect assemblers to support integer data directives
1956   // for more than 64 bits, so we emit the data in at most 64-bit
1957   // quantities at a time.
1958   const uint64_t *RawData = Realigned.getRawData();
1959   for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1960     uint64_t Val = DL->isBigEndian() ? RawData[e - i - 1] : RawData[i];
1961     AP.OutStreamer.EmitIntValue(Val, 8);
1962   }
1963
1964   if (ExtraBitsSize) {
1965     // Emit the extra bits after the 64-bits chunks.
1966
1967     // Emit a directive that fills the expected size.
1968     uint64_t Size = AP.TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(
1969         CI->getType());
1970     Size -= (BitWidth / 64) * 8;
1971     assert(Size && Size * 8 >= ExtraBitsSize &&
1972            (ExtraBits & (((uint64_t)-1) >> (64 - ExtraBitsSize)))
1973            == ExtraBits && "Directive too small for extra bits.");
1974     AP.OutStreamer.EmitIntValue(ExtraBits, Size);
1975   }
1976 }
1977
1978 static void emitGlobalConstantImpl(const Constant *CV, AsmPrinter &AP) {
1979   const DataLayout *DL = AP.TM.getSubtargetImpl()->getDataLayout();
1980   uint64_t Size = DL->getTypeAllocSize(CV->getType());
1981   if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV))
1982     return AP.OutStreamer.EmitZeros(Size);
1983
1984   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1985     switch (Size) {
1986     case 1:
1987     case 2:
1988     case 4:
1989     case 8:
1990       if (AP.isVerbose())
1991         AP.OutStreamer.GetCommentOS() << format("0x%" PRIx64 "\n",
1992                                                 CI->getZExtValue());
1993       AP.OutStreamer.EmitIntValue(CI->getZExtValue(), Size);
1994       return;
1995     default:
1996       emitGlobalConstantLargeInt(CI, AP);
1997       return;
1998     }
1999   }
2000
2001   if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
2002     return emitGlobalConstantFP(CFP, AP);
2003
2004   if (isa<ConstantPointerNull>(CV)) {
2005     AP.OutStreamer.EmitIntValue(0, Size);
2006     return;
2007   }
2008
2009   if (const ConstantDataSequential *CDS = dyn_cast<ConstantDataSequential>(CV))
2010     return emitGlobalConstantDataSequential(CDS, AP);
2011
2012   if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
2013     return emitGlobalConstantArray(CVA, AP);
2014
2015   if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
2016     return emitGlobalConstantStruct(CVS, AP);
2017
2018   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
2019     // Look through bitcasts, which might not be able to be MCExpr'ized (e.g. of
2020     // vectors).
2021     if (CE->getOpcode() == Instruction::BitCast)
2022       return emitGlobalConstantImpl(CE->getOperand(0), AP);
2023
2024     if (Size > 8) {
2025       // If the constant expression's size is greater than 64-bits, then we have
2026       // to emit the value in chunks. Try to constant fold the value and emit it
2027       // that way.
2028       Constant *New = ConstantFoldConstantExpression(CE, DL);
2029       if (New && New != CE)
2030         return emitGlobalConstantImpl(New, AP);
2031     }
2032   }
2033
2034   if (const ConstantVector *V = dyn_cast<ConstantVector>(CV))
2035     return emitGlobalConstantVector(V, AP);
2036
2037   // Otherwise, it must be a ConstantExpr.  Lower it to an MCExpr, then emit it
2038   // thread the streamer with EmitValue.
2039   AP.OutStreamer.EmitValue(AP.lowerConstant(CV), Size);
2040 }
2041
2042 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
2043 void AsmPrinter::EmitGlobalConstant(const Constant *CV) {
2044   uint64_t Size =
2045       TM.getSubtargetImpl()->getDataLayout()->getTypeAllocSize(CV->getType());
2046   if (Size)
2047     emitGlobalConstantImpl(CV, *this);
2048   else if (MAI->hasSubsectionsViaSymbols()) {
2049     // If the global has zero size, emit a single byte so that two labels don't
2050     // look like they are at the same location.
2051     OutStreamer.EmitIntValue(0, 1);
2052   }
2053 }
2054
2055 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
2056   // Target doesn't support this yet!
2057   llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
2058 }
2059
2060 void AsmPrinter::printOffset(int64_t Offset, raw_ostream &OS) const {
2061   if (Offset > 0)
2062     OS << '+' << Offset;
2063   else if (Offset < 0)
2064     OS << Offset;
2065 }
2066
2067 //===----------------------------------------------------------------------===//
2068 // Symbol Lowering Routines.
2069 //===----------------------------------------------------------------------===//
2070
2071 /// GetTempSymbol - Return the MCSymbol corresponding to the assembler
2072 /// temporary label with the specified stem and unique ID.
2073 MCSymbol *AsmPrinter::GetTempSymbol(Twine Name, unsigned ID) const {
2074   const DataLayout *DL = TM.getSubtargetImpl()->getDataLayout();
2075   return OutContext.GetOrCreateSymbol(Twine(DL->getPrivateGlobalPrefix()) +
2076                                       Name + Twine(ID));
2077 }
2078
2079 /// GetTempSymbol - Return an assembler temporary label with the specified
2080 /// stem.
2081 MCSymbol *AsmPrinter::GetTempSymbol(Twine Name) const {
2082   const DataLayout *DL = TM.getSubtargetImpl()->getDataLayout();
2083   return OutContext.GetOrCreateSymbol(Twine(DL->getPrivateGlobalPrefix())+
2084                                       Name);
2085 }
2086
2087
2088 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BlockAddress *BA) const {
2089   return MMI->getAddrLabelSymbol(BA->getBasicBlock());
2090 }
2091
2092 MCSymbol *AsmPrinter::GetBlockAddressSymbol(const BasicBlock *BB) const {
2093   return MMI->getAddrLabelSymbol(BB);
2094 }
2095
2096 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
2097 MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
2098   const DataLayout *DL = TM.getSubtargetImpl()->getDataLayout();
2099   return OutContext.GetOrCreateSymbol
2100     (Twine(DL->getPrivateGlobalPrefix()) + "CPI" + Twine(getFunctionNumber())
2101      + "_" + Twine(CPID));
2102 }
2103
2104 /// GetJTISymbol - Return the symbol for the specified jump table entry.
2105 MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
2106   return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
2107 }
2108
2109 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
2110 /// FIXME: privatize to AsmPrinter.
2111 MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
2112   const DataLayout *DL = TM.getSubtargetImpl()->getDataLayout();
2113   return OutContext.GetOrCreateSymbol
2114   (Twine(DL->getPrivateGlobalPrefix()) + Twine(getFunctionNumber()) + "_" +
2115    Twine(UID) + "_set_" + Twine(MBBID));
2116 }
2117
2118 MCSymbol *AsmPrinter::getSymbolWithGlobalValueBase(const GlobalValue *GV,
2119                                                    StringRef Suffix) const {
2120   return getObjFileLowering().getSymbolWithGlobalValueBase(GV, Suffix, *Mang,
2121                                                            TM);
2122 }
2123
2124 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
2125 /// ExternalSymbol.
2126 MCSymbol *AsmPrinter::GetExternalSymbolSymbol(StringRef Sym) const {
2127   SmallString<60> NameStr;
2128   Mang->getNameWithPrefix(NameStr, Sym);
2129   return OutContext.GetOrCreateSymbol(NameStr.str());
2130 }
2131
2132
2133
2134 /// PrintParentLoopComment - Print comments about parent loops of this one.
2135 static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2136                                    unsigned FunctionNumber) {
2137   if (!Loop) return;
2138   PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
2139   OS.indent(Loop->getLoopDepth()*2)
2140     << "Parent Loop BB" << FunctionNumber << "_"
2141     << Loop->getHeader()->getNumber()
2142     << " Depth=" << Loop->getLoopDepth() << '\n';
2143 }
2144
2145
2146 /// PrintChildLoopComment - Print comments about child loops within
2147 /// the loop for this basic block, with nesting.
2148 static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop,
2149                                   unsigned FunctionNumber) {
2150   // Add child loop information
2151   for (const MachineLoop *CL : *Loop) {
2152     OS.indent(CL->getLoopDepth()*2)
2153       << "Child Loop BB" << FunctionNumber << "_"
2154       << CL->getHeader()->getNumber() << " Depth " << CL->getLoopDepth()
2155       << '\n';
2156     PrintChildLoopComment(OS, CL, FunctionNumber);
2157   }
2158 }
2159
2160 /// emitBasicBlockLoopComments - Pretty-print comments for basic blocks.
2161 static void emitBasicBlockLoopComments(const MachineBasicBlock &MBB,
2162                                        const MachineLoopInfo *LI,
2163                                        const AsmPrinter &AP) {
2164   // Add loop depth information
2165   const MachineLoop *Loop = LI->getLoopFor(&MBB);
2166   if (!Loop) return;
2167
2168   MachineBasicBlock *Header = Loop->getHeader();
2169   assert(Header && "No header for loop");
2170
2171   // If this block is not a loop header, just print out what is the loop header
2172   // and return.
2173   if (Header != &MBB) {
2174     AP.OutStreamer.AddComment("  in Loop: Header=BB" +
2175                               Twine(AP.getFunctionNumber())+"_" +
2176                               Twine(Loop->getHeader()->getNumber())+
2177                               " Depth="+Twine(Loop->getLoopDepth()));
2178     return;
2179   }
2180
2181   // Otherwise, it is a loop header.  Print out information about child and
2182   // parent loops.
2183   raw_ostream &OS = AP.OutStreamer.GetCommentOS();
2184
2185   PrintParentLoopComment(OS, Loop->getParentLoop(), AP.getFunctionNumber());
2186
2187   OS << "=>";
2188   OS.indent(Loop->getLoopDepth()*2-2);
2189
2190   OS << "This ";
2191   if (Loop->empty())
2192     OS << "Inner ";
2193   OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
2194
2195   PrintChildLoopComment(OS, Loop, AP.getFunctionNumber());
2196 }
2197
2198
2199 /// EmitBasicBlockStart - This method prints the label for the specified
2200 /// MachineBasicBlock, an alignment (if present) and a comment describing
2201 /// it if appropriate.
2202 void AsmPrinter::EmitBasicBlockStart(const MachineBasicBlock &MBB) const {
2203   // Emit an alignment directive for this block, if needed.
2204   if (unsigned Align = MBB.getAlignment())
2205     EmitAlignment(Align);
2206
2207   // If the block has its address taken, emit any labels that were used to
2208   // reference the block.  It is possible that there is more than one label
2209   // here, because multiple LLVM BB's may have been RAUW'd to this block after
2210   // the references were generated.
2211   if (MBB.hasAddressTaken()) {
2212     const BasicBlock *BB = MBB.getBasicBlock();
2213     if (isVerbose())
2214       OutStreamer.AddComment("Block address taken");
2215
2216     std::vector<MCSymbol*> Symbols = MMI->getAddrLabelSymbolToEmit(BB);
2217     for (auto *Sym : Symbols)
2218       OutStreamer.EmitLabel(Sym);
2219   }
2220
2221   // Print some verbose block comments.
2222   if (isVerbose()) {
2223     if (const BasicBlock *BB = MBB.getBasicBlock())
2224       if (BB->hasName())
2225         OutStreamer.AddComment("%" + BB->getName());
2226     emitBasicBlockLoopComments(MBB, LI, *this);
2227   }
2228
2229   // Print the main label for the block.
2230   if (MBB.pred_empty() || isBlockOnlyReachableByFallthrough(&MBB)) {
2231     if (isVerbose()) {
2232       // NOTE: Want this comment at start of line, don't emit with AddComment.
2233       OutStreamer.emitRawComment(" BB#" + Twine(MBB.getNumber()) + ":", false);
2234     }
2235   } else {
2236     OutStreamer.EmitLabel(MBB.getSymbol());
2237   }
2238 }
2239
2240 void AsmPrinter::EmitVisibility(MCSymbol *Sym, unsigned Visibility,
2241                                 bool IsDefinition) const {
2242   MCSymbolAttr Attr = MCSA_Invalid;
2243
2244   switch (Visibility) {
2245   default: break;
2246   case GlobalValue::HiddenVisibility:
2247     if (IsDefinition)
2248       Attr = MAI->getHiddenVisibilityAttr();
2249     else
2250       Attr = MAI->getHiddenDeclarationVisibilityAttr();
2251     break;
2252   case GlobalValue::ProtectedVisibility:
2253     Attr = MAI->getProtectedVisibilityAttr();
2254     break;
2255   }
2256
2257   if (Attr != MCSA_Invalid)
2258     OutStreamer.EmitSymbolAttribute(Sym, Attr);
2259 }
2260
2261 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
2262 /// exactly one predecessor and the control transfer mechanism between
2263 /// the predecessor and this block is a fall-through.
2264 bool AsmPrinter::
2265 isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const {
2266   // If this is a landing pad, it isn't a fall through.  If it has no preds,
2267   // then nothing falls through to it.
2268   if (MBB->isLandingPad() || MBB->pred_empty())
2269     return false;
2270
2271   // If there isn't exactly one predecessor, it can't be a fall through.
2272   if (MBB->pred_size() > 1)
2273     return false;
2274
2275   // The predecessor has to be immediately before this block.
2276   MachineBasicBlock *Pred = *MBB->pred_begin();
2277   if (!Pred->isLayoutSuccessor(MBB))
2278     return false;
2279
2280   // If the block is completely empty, then it definitely does fall through.
2281   if (Pred->empty())
2282     return true;
2283
2284   // Check the terminators in the previous blocks
2285   for (const auto &MI : Pred->terminators()) {
2286     // If it is not a simple branch, we are in a table somewhere.
2287     if (!MI.isBranch() || MI.isIndirectBranch())
2288       return false;
2289
2290     // If we are the operands of one of the branches, this is not a fall
2291     // through. Note that targets with delay slots will usually bundle
2292     // terminators with the delay slot instruction.
2293     for (ConstMIBundleOperands OP(&MI); OP.isValid(); ++OP) {
2294       if (OP->isJTI())
2295         return false;
2296       if (OP->isMBB() && OP->getMBB() == MBB)
2297         return false;
2298     }
2299   }
2300
2301   return true;
2302 }
2303
2304
2305
2306 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy &S) {
2307   if (!S.usesMetadata())
2308     return nullptr;
2309
2310   assert(!S.useStatepoints() && "statepoints do not currently support custom"
2311          " stackmap formats, please see the documentation for a description of"
2312          " the default format.  If you really need a custom serialized format,"
2313          " please file a bug");
2314
2315   gcp_map_type &GCMap = getGCMap(GCMetadataPrinters);
2316   gcp_map_type::iterator GCPI = GCMap.find(&S);
2317   if (GCPI != GCMap.end())
2318     return GCPI->second.get();
2319
2320   const char *Name = S.getName().c_str();
2321
2322   for (GCMetadataPrinterRegistry::iterator
2323          I = GCMetadataPrinterRegistry::begin(),
2324          E = GCMetadataPrinterRegistry::end(); I != E; ++I)
2325     if (strcmp(Name, I->getName()) == 0) {
2326       std::unique_ptr<GCMetadataPrinter> GMP = I->instantiate();
2327       GMP->S = &S;
2328       auto IterBool = GCMap.insert(std::make_pair(&S, std::move(GMP)));
2329       return IterBool.first->second.get();
2330     }
2331
2332   report_fatal_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
2333 }
2334
2335 /// Pin vtable to this file.
2336 AsmPrinterHandler::~AsmPrinterHandler() {}