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