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