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