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