LLVM 23.0.0git
AsmPrinter.cpp
Go to the documentation of this file.
1//===- AsmPrinter.cpp - Common AsmPrinter code ----------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file implements the AsmPrinter class.
10//
11//===----------------------------------------------------------------------===//
12
14#include "CodeViewDebug.h"
15#include "DwarfDebug.h"
16#include "DwarfException.h"
17#include "PseudoProbePrinter.h"
18#include "WasmException.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"
28#include "llvm/ADT/Statistic.h"
30#include "llvm/ADT/StringRef.h"
32#include "llvm/ADT/Twine.h"
68#include "llvm/Config/config.h"
69#include "llvm/IR/BasicBlock.h"
70#include "llvm/IR/Comdat.h"
71#include "llvm/IR/Constant.h"
72#include "llvm/IR/Constants.h"
73#include "llvm/IR/DataLayout.h"
77#include "llvm/IR/Function.h"
78#include "llvm/IR/GCStrategy.h"
79#include "llvm/IR/GlobalAlias.h"
80#include "llvm/IR/GlobalIFunc.h"
82#include "llvm/IR/GlobalValue.h"
84#include "llvm/IR/Instruction.h"
87#include "llvm/IR/Mangler.h"
88#include "llvm/IR/Metadata.h"
89#include "llvm/IR/Module.h"
90#include "llvm/IR/Operator.h"
91#include "llvm/IR/PseudoProbe.h"
92#include "llvm/IR/Type.h"
93#include "llvm/IR/Value.h"
94#include "llvm/IR/ValueHandle.h"
95#include "llvm/MC/MCAsmInfo.h"
96#include "llvm/MC/MCContext.h"
98#include "llvm/MC/MCExpr.h"
99#include "llvm/MC/MCInst.h"
100#include "llvm/MC/MCSchedule.h"
101#include "llvm/MC/MCSection.h"
103#include "llvm/MC/MCSectionELF.h"
106#include "llvm/MC/MCStreamer.h"
108#include "llvm/MC/MCSymbol.h"
109#include "llvm/MC/MCSymbolELF.h"
111#include "llvm/MC/MCValue.h"
112#include "llvm/MC/SectionKind.h"
114#include "llvm/Object/ELFTypes.h"
115#include "llvm/Pass.h"
117#include "llvm/Support/Casting.h"
122#include "llvm/Support/Format.h"
124#include "llvm/Support/Path.h"
125#include "llvm/Support/VCSRevision.h"
131#include <algorithm>
132#include <cassert>
133#include <cinttypes>
134#include <cstdint>
135#include <iterator>
136#include <memory>
137#include <optional>
138#include <string>
139#include <utility>
140#include <vector>
141
142using namespace llvm;
143
144#define DEBUG_TYPE "asm-printer"
145
146// This is a replication of fields of object::PGOAnalysisMap::Features. It
147// should match the order of the fields so that
148// `object::PGOAnalysisMap::Features::decode(PgoAnalysisMapFeatures.getBits())`
149// succeeds.
159 "pgo-analysis-map", cl::Hidden, cl::CommaSeparated,
161 clEnumValN(PGOMapFeaturesEnum::None, "none", "Disable all options"),
163 "Function Entry Count"),
165 "Basic Block Frequency"),
166 clEnumValN(PGOMapFeaturesEnum::BrProb, "br-prob", "Branch Probability"),
167 clEnumValN(PGOMapFeaturesEnum::All, "all", "Enable all options")),
168 cl::desc(
169 "Enable extended information within the SHT_LLVM_BB_ADDR_MAP that is "
170 "extracted from PGO related analysis."));
171
173 "pgo-analysis-map-emit-bb-sections-cfg",
174 cl::desc("Enable the post-link cfg information from the basic block "
175 "sections profile in the PGO analysis map"),
176 cl::Hidden, cl::init(false));
177
179 "basic-block-address-map-skip-bb-entries",
180 cl::desc("Skip emitting basic block entries in the SHT_LLVM_BB_ADDR_MAP "
181 "section. It's used to save binary size when BB entries are "
182 "unnecessary for some PGOAnalysisMap features."),
183 cl::Hidden, cl::init(false));
184
186 "emit-jump-table-sizes-section",
187 cl::desc("Emit a section containing jump table addresses and sizes"),
188 cl::Hidden, cl::init(false));
189
190// This isn't turned on by default, since several of the scheduling models are
191// not completely accurate, and we don't want to be misleading.
193 "asm-print-latency",
194 cl::desc("Print instruction latencies as verbose asm comments"), cl::Hidden,
195 cl::init(false));
196
198 StackUsageFile("stack-usage-file",
199 cl::desc("Output filename for stack usage information"),
200 cl::value_desc("filename"), cl::Hidden);
201
203
204STATISTIC(EmittedInsts, "Number of machine instrs printed");
205
206char AsmPrinter::ID = 0;
207
208namespace {
209class AddrLabelMapCallbackPtr final : CallbackVH {
210 AddrLabelMap *Map = nullptr;
211
212public:
213 AddrLabelMapCallbackPtr() = default;
214 AddrLabelMapCallbackPtr(Value *V) : CallbackVH(V) {}
215
216 void setPtr(BasicBlock *BB) {
218 }
219
220 void setMap(AddrLabelMap *map) { Map = map; }
221
222 void deleted() override;
223 void allUsesReplacedWith(Value *V2) override;
224};
225} // namespace
226
228 MCContext &Context;
229 struct AddrLabelSymEntry {
230 /// The symbols for the label.
232
233 Function *Fn; // The containing function of the BasicBlock.
234 unsigned Index; // The index in BBCallbacks for the BasicBlock.
235 };
236
237 DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry> AddrLabelSymbols;
238
239 /// Callbacks for the BasicBlock's that we have entries for. We use this so
240 /// we get notified if a block is deleted or RAUWd.
241 std::vector<AddrLabelMapCallbackPtr> BBCallbacks;
242
243 /// This is a per-function list of symbols whose corresponding BasicBlock got
244 /// deleted. These symbols need to be emitted at some point in the file, so
245 /// AsmPrinter emits them after the function body.
246 DenseMap<AssertingVH<Function>, std::vector<MCSymbol *>>
247 DeletedAddrLabelsNeedingEmission;
248
249public:
250 AddrLabelMap(MCContext &context) : Context(context) {}
251
253 assert(DeletedAddrLabelsNeedingEmission.empty() &&
254 "Some labels for deleted blocks never got emitted");
255 }
256
258
260 std::vector<MCSymbol *> &Result);
261
264};
265
267 assert(BB->hasAddressTaken() &&
268 "Shouldn't get label for block without address taken");
269 AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
270
271 // If we already had an entry for this block, just return it.
272 if (!Entry.Symbols.empty()) {
273 assert(BB->getParent() == Entry.Fn && "Parent changed");
274 return Entry.Symbols;
275 }
276
277 // Otherwise, this is a new entry, create a new symbol for it and add an
278 // entry to BBCallbacks so we can be notified if the BB is deleted or RAUWd.
279 BBCallbacks.emplace_back(BB);
280 BBCallbacks.back().setMap(this);
281 Entry.Index = BBCallbacks.size() - 1;
282 Entry.Fn = BB->getParent();
283 MCSymbol *Sym = BB->hasAddressTaken() ? Context.createNamedTempSymbol()
284 : Context.createTempSymbol();
285 Entry.Symbols.push_back(Sym);
286 return Entry.Symbols;
287}
288
289/// If we have any deleted symbols for F, return them.
291 Function *F, std::vector<MCSymbol *> &Result) {
292 DenseMap<AssertingVH<Function>, std::vector<MCSymbol *>>::iterator I =
293 DeletedAddrLabelsNeedingEmission.find(F);
294
295 // If there are no entries for the function, just return.
296 if (I == DeletedAddrLabelsNeedingEmission.end())
297 return;
298
299 // Otherwise, take the list.
300 std::swap(Result, I->second);
301 DeletedAddrLabelsNeedingEmission.erase(I);
302}
303
304//===- Address of Block Management ----------------------------------------===//
305
308 // Lazily create AddrLabelSymbols.
309 if (!AddrLabelSymbols)
310 AddrLabelSymbols = std::make_unique<AddrLabelMap>(OutContext);
311 return AddrLabelSymbols->getAddrLabelSymbolToEmit(
312 const_cast<BasicBlock *>(BB));
313}
314
316 const Function *F, std::vector<MCSymbol *> &Result) {
317 // If no blocks have had their addresses taken, we're done.
318 if (!AddrLabelSymbols)
319 return;
320 return AddrLabelSymbols->takeDeletedSymbolsForFunction(
321 const_cast<Function *>(F), Result);
322}
323
325 // If the block got deleted, there is no need for the symbol. If the symbol
326 // was already emitted, we can just forget about it, otherwise we need to
327 // queue it up for later emission when the function is output.
328 AddrLabelSymEntry Entry = std::move(AddrLabelSymbols[BB]);
329 AddrLabelSymbols.erase(BB);
330 assert(!Entry.Symbols.empty() && "Didn't have a symbol, why a callback?");
331 BBCallbacks[Entry.Index] = nullptr; // Clear the callback.
332
333#if !LLVM_MEMORY_SANITIZER_BUILD
334 // BasicBlock is destroyed already, so this access is UB detectable by msan.
335 assert((BB->getParent() == nullptr || BB->getParent() == Entry.Fn) &&
336 "Block/parent mismatch");
337#endif
338
339 for (MCSymbol *Sym : Entry.Symbols) {
340 if (Sym->isDefined())
341 return;
342
343 // If the block is not yet defined, we need to emit it at the end of the
344 // function. Add the symbol to the DeletedAddrLabelsNeedingEmission list
345 // for the containing Function. Since the block is being deleted, its
346 // parent may already be removed, we have to get the function from 'Entry'.
347 DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
348 }
349}
350
352 // Get the entry for the RAUW'd block and remove it from our map.
353 AddrLabelSymEntry OldEntry = std::move(AddrLabelSymbols[Old]);
354 AddrLabelSymbols.erase(Old);
355 assert(!OldEntry.Symbols.empty() && "Didn't have a symbol, why a callback?");
356
357 AddrLabelSymEntry &NewEntry = AddrLabelSymbols[New];
358
359 // If New is not address taken, just move our symbol over to it.
360 if (NewEntry.Symbols.empty()) {
361 BBCallbacks[OldEntry.Index].setPtr(New); // Update the callback.
362 NewEntry = std::move(OldEntry); // Set New's entry.
363 return;
364 }
365
366 BBCallbacks[OldEntry.Index] = nullptr; // Update the callback.
367
368 // Otherwise, we need to add the old symbols to the new block's set.
369 llvm::append_range(NewEntry.Symbols, OldEntry.Symbols);
370}
371
372void AddrLabelMapCallbackPtr::deleted() {
373 Map->UpdateForDeletedBlock(cast<BasicBlock>(getValPtr()));
374}
375
376void AddrLabelMapCallbackPtr::allUsesReplacedWith(Value *V2) {
377 Map->UpdateForRAUWBlock(cast<BasicBlock>(getValPtr()), cast<BasicBlock>(V2));
378}
379
380/// getGVAlignment - Return the alignment to use for the specified global
381/// value. This rounds up to the preferred alignment if possible and legal.
383 Align InAlign) {
384 Align Alignment;
385 if (const GlobalVariable *GVar = dyn_cast<GlobalVariable>(GV))
386 Alignment = DL.getPreferredAlign(GVar);
387
388 // If InAlign is specified, round it to it.
389 if (InAlign > Alignment)
390 Alignment = InAlign;
391
392 // If the GV has a specified alignment, take it into account.
393 MaybeAlign GVAlign;
394 if (auto *GVar = dyn_cast<GlobalVariable>(GV))
395 GVAlign = GVar->getAlign();
396 else if (auto *F = dyn_cast<Function>(GV))
397 GVAlign = F->getAlign();
398 if (!GVAlign)
399 return Alignment;
400
401 assert(GVAlign && "GVAlign must be set");
402
403 // If the GVAlign is larger than NumBits, or if we are required to obey
404 // NumBits because the GV has an assigned section, obey it.
405 if (*GVAlign > Alignment || GV->hasSection())
406 Alignment = *GVAlign;
407 return Alignment;
408}
409
410AsmPrinter::AsmPrinter(TargetMachine &tm, std::unique_ptr<MCStreamer> Streamer,
411 char &ID)
412 : MachineFunctionPass(ID), TM(tm), MAI(tm.getMCAsmInfo()),
413 OutContext(Streamer->getContext()), OutStreamer(std::move(Streamer)),
414 SM(*this) {
415 VerboseAsm = OutStreamer->isVerboseAsm();
416 DwarfUsesRelocationsAcrossSections =
417 MAI.doesDwarfUseRelocationsAcrossSections();
418 GetMMI = [this]() {
420 return MMIWP ? &MMIWP->getMMI() : nullptr;
421 };
422 GetORE = [this](MachineFunction &MF) {
424 };
425 GetMDT = [this](MachineFunction &MF) {
426 auto *MDTWrapper =
428 return MDTWrapper ? &MDTWrapper->getDomTree() : nullptr;
429 };
430 GetMLI = [this](MachineFunction &MF) {
432 return MLIWrapper ? &MLIWrapper->getLI() : nullptr;
433 };
434 BeginGCAssembly = [this](Module &M) {
436 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
437 for (const auto &I : *MI)
438 if (GCMetadataPrinter *MP = getOrCreateGCPrinter(*I))
439 MP->beginAssembly(M, *MI, *this);
440 };
441 FinishGCAssembly = [this](Module &M) {
443 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
444 for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E;)
445 if (GCMetadataPrinter *MP = getOrCreateGCPrinter(**--I))
446 MP->finishAssembly(M, *MI, *this);
447 };
448 EmitStackMaps = [this](Module &M) {
450 assert(MI && "AsmPrinter didn't require GCModuleInfo?");
451 bool NeedsDefault = false;
452 if (MI->begin() == MI->end())
453 // No GC strategy, use the default format.
454 NeedsDefault = true;
455 else
456 for (const auto &I : *MI) {
457 if (GCMetadataPrinter *MP = getOrCreateGCPrinter(*I))
458 if (MP->emitStackMaps(SM, *this))
459 continue;
460 // The strategy doesn't have printer or doesn't emit custom stack maps.
461 // Use the default format.
462 NeedsDefault = true;
463 }
464
465 if (NeedsDefault)
466 SM.serializeToStackMapSection();
467 };
468 AssertDebugEHFinalized = [&]() {
469 assert(!DD && Handlers.size() == NumUserHandlers &&
470 "Debug/EH info didn't get finalized");
471 };
472}
473
475
477 return TM.isPositionIndependent();
478}
479
480/// getFunctionNumber - Return a unique ID for the current function.
482 return MF->getFunctionNumber();
483}
484
486 return *TM.getObjFileLowering();
487}
488
490 assert(MMI && "MMI could not be nullptr!");
491 return MMI->getModule()->getDataLayout();
492}
493
494// Do not use the cached DataLayout because some client use it without a Module
495// (dsymutil, llvm-dwarfdump).
497 return TM.getPointerSize(0); // FIXME: Default address space
498}
499
501 assert(MF && "getSubtargetInfo requires a valid MachineFunction!");
502 return MF->getSubtarget<MCSubtargetInfo>();
503}
504
508
509/// getCurrentSection() - Return the current section we are emitting to.
511 return OutStreamer->getCurrentSectionOnly();
512}
513
514/// createDwarfDebug() - Create the DwarfDebug handler.
516
528
530 MMI = GetMMI();
531 HasSplitStack = false;
532 HasNoSplitStack = false;
533 DbgInfoAvailable = !M.debug_compile_units().empty();
534 const Triple &Target = TM.getTargetTriple();
535
536 AddrLabelSymbols = nullptr;
537
538 // Initialize TargetLoweringObjectFile.
539 TM.getObjFileLowering()->Initialize(OutContext, TM);
540
541 TM.getObjFileLowering()->getModuleMetadata(M);
542
543 // On AIX, we delay emitting any section information until
544 // after emitting the .file pseudo-op. This allows additional
545 // information (such as the embedded command line) to be associated
546 // with all sections in the object file rather than a single section.
547 if (!Target.isOSBinFormatXCOFF())
548 OutStreamer->initSections(TM.getMCSubtargetInfo());
549
550 // Emit the version-min deployment target directive if needed.
551 //
552 // FIXME: If we end up with a collection of these sorts of Darwin-specific
553 // or ELF-specific things, it may make sense to have a platform helper class
554 // that will work with the target helper class. For now keep it here, as the
555 // alternative is duplicated code in each of the target asm printers that
556 // use the directive, where it would need the same conditionalization
557 // anyway.
558 if (Target.isOSBinFormatMachO() && Target.isOSDarwin()) {
559 Triple TVT(M.getDarwinTargetVariantTriple());
560 OutStreamer->emitVersionForTarget(
561 Target, M.getSDKVersion(),
562 M.getDarwinTargetVariantTriple().empty() ? nullptr : &TVT,
563 M.getDarwinTargetVariantSDKVersion());
564 }
565
566 // Allow the target to emit any magic that it wants at the start of the file.
568
569 // Very minimal debug info. It is ignored if we emit actual debug info. If we
570 // don't, this at least helps the user find where a global came from.
571 if (MAI.hasSingleParameterDotFile()) {
572 // .file "foo.c"
573 if (MAI.isAIX()) {
574 const char VerStr[] =
575#ifdef PACKAGE_VENDOR
576 PACKAGE_VENDOR " "
577#endif
578 PACKAGE_NAME " version " PACKAGE_VERSION
579#ifdef LLVM_REVISION
580 " (" LLVM_REVISION ")"
581#endif
582 ;
583 // TODO: Add timestamp and description.
584 OutStreamer->emitFileDirective(M.getSourceFileName(), VerStr, "", "");
585 } else {
586 OutStreamer->emitFileDirective(
587 llvm::sys::path::filename(M.getSourceFileName()));
588 }
589 }
590
591 // On AIX, emit bytes for llvm.commandline metadata after .file so that the
592 // C_INFO symbol is preserved if any csect is kept by the linker.
593 if (Target.isOSBinFormatXCOFF()) {
594 emitModuleCommandLines(M);
595 // Now we can generate section information.
596 OutStreamer->switchSection(
597 OutContext.getObjectFileInfo()->getTextSection());
598
599 // To work around an AIX assembler and/or linker bug, generate
600 // a rename for the default text-section symbol name. This call has
601 // no effect when generating object code directly.
602 MCSection *TextSection =
603 OutStreamer->getContext().getObjectFileInfo()->getTextSection();
604 MCSymbolXCOFF *XSym =
605 static_cast<MCSectionXCOFF *>(TextSection)->getQualNameSymbol();
606 if (XSym->hasRename())
607 OutStreamer->emitXCOFFRenameDirective(XSym, XSym->getSymbolTableName());
608 }
609
611
612 // Emit module-level inline asm if it exists.
613 if (M.hasModuleInlineAsm()) {
614 OutStreamer->AddComment("Start of file scope inline assembly");
615 OutStreamer->addBlankLine();
616 for (const Module::GlobalAsmFragment &Frag : M.getModuleInlineAsm()) {
617 const MCSubtargetInfo &AsmSTI = TM.getMCSubtargetInfo(
618 Frag.Props.TargetCPU, Frag.Props.TargetFeatures);
619 bool DidPush = emitTargetFeaturePush(AsmSTI);
620 emitInlineAsm(
621 Frag.Asm, AsmSTI, TM.Options.MCOptions, nullptr,
622 InlineAsm::AsmDialect(TM.getMCAsmInfo().getAssemblerDialect()));
623 emitTargetFeaturePop(AsmSTI, DidPush);
624 }
625 OutStreamer->AddComment("End of file scope inline assembly");
626 OutStreamer->addBlankLine();
627 }
628
629 if (MAI.doesSupportDebugInformation()) {
630 bool EmitCodeView = M.getCodeViewFlag();
631 // On Windows targets, emit minimal CodeView compiler info even when debug
632 // info is disabled.
633 if ((Target.isOSWindows() || (Target.isUEFI() && EmitCodeView)) &&
634 M.getNamedMetadata("llvm.dbg.cu"))
635 Handlers.push_back(std::make_unique<CodeViewDebug>(this));
636 if (!EmitCodeView || M.getDwarfVersion()) {
637 if (hasDebugInfo()) {
638 DD = createDwarfDebug();
639 Handlers.push_back(std::unique_ptr<DwarfDebug>(DD));
640 }
641 }
642 }
643
644 if (M.getNamedMetadata(PseudoProbeDescMetadataName))
645 PP = std::make_unique<PseudoProbeHandler>(this);
646
647 switch (MAI.getExceptionHandlingType()) {
649 // We may want to emit CFI for debug.
650 [[fallthrough]];
654 for (auto &F : M.getFunctionList()) {
656 ModuleCFISection = getFunctionCFISectionType(F);
657 // If any function needsUnwindTableEntry(), it needs .eh_frame and hence
658 // the module needs .eh_frame. If we have found that case, we are done.
659 if (ModuleCFISection == CFISection::EH)
660 break;
661 }
662 assert(MAI.getExceptionHandlingType() == ExceptionHandling::DwarfCFI ||
663 usesCFIWithoutEH() || ModuleCFISection != CFISection::EH);
664 break;
665 default:
666 break;
667 }
668
669 EHStreamer *ES = nullptr;
670 switch (MAI.getExceptionHandlingType()) {
672 if (!usesCFIWithoutEH())
673 break;
674 [[fallthrough]];
678 ES = new DwarfCFIException(this);
679 break;
681 ES = new ARMException(this);
682 break;
684 switch (MAI.getWinEHEncodingType()) {
685 default: llvm_unreachable("unsupported unwinding information encoding");
687 break;
690 ES = new WinException(this);
691 break;
692 }
693 break;
695 ES = new WasmException(this);
696 break;
698 ES = new AIXException(this);
699 break;
700 }
701 if (ES)
702 EHHandlers.push_back(std::unique_ptr<EHStreamer>(ES));
703
704 // All CFG modes required the tables emitted.
705 if (M.getControlFlowGuardMode() != ControlFlowGuardMode::Disabled)
706 Handlers.push_back(std::make_unique<WinCFGuard>(this));
707
708 for (auto &Handler : Handlers)
709 Handler->beginModule(&M);
710 for (auto &Handler : EHHandlers)
711 Handler->beginModule(&M);
712
713 return false;
714}
715
716static bool canBeHidden(const GlobalValue *GV, const MCAsmInfo &MAI) {
718 return false;
719
720 return GV->canBeOmittedFromSymbolTable();
721}
722
723void AsmPrinter::emitLinkage(const GlobalValue *GV, MCSymbol *GVSym) const {
725 switch (Linkage) {
731 if (MAI.isMachO()) {
732 // .globl _foo
733 OutStreamer->emitSymbolAttribute(GVSym, MCSA_Global);
734
735 if (!canBeHidden(GV, MAI))
736 // .weak_definition _foo
737 OutStreamer->emitSymbolAttribute(GVSym, MCSA_WeakDefinition);
738 else
739 OutStreamer->emitSymbolAttribute(GVSym, MCSA_WeakDefAutoPrivate);
740 } else if (MAI.avoidWeakIfComdat() && GV->hasComdat()) {
741 // .globl _foo
742 OutStreamer->emitSymbolAttribute(GVSym, MCSA_Global);
743 //NOTE: linkonce is handled by the section the symbol was assigned to.
744 } else {
745 // .weak _foo
746 OutStreamer->emitSymbolAttribute(GVSym, MCSA_Weak);
747 }
748 return;
750 OutStreamer->emitSymbolAttribute(GVSym, MCSA_Global);
751 return;
754 return;
758 llvm_unreachable("Should never emit this");
759 }
760 llvm_unreachable("Unknown linkage type!");
761}
762
764 const GlobalValue *GV) const {
765 TM.getNameWithPrefix(Name, GV, getObjFileLowering().getMangler());
766}
767
769 return TM.getSymbol(GV);
770}
771
773 // On ELF, use .Lfoo$local if GV is a non-interposable GlobalObject with an
774 // exact definion (intersection of GlobalValue::hasExactDefinition() and
775 // !isInterposable()). These linkages include: external, appending, internal,
776 // private. It may be profitable to use a local alias for external. The
777 // assembler would otherwise be conservative and assume a global default
778 // visibility symbol can be interposable, even if the code generator already
779 // assumed it.
780 if (TM.getTargetTriple().isOSBinFormatELF() && GV.canBenefitFromLocalAlias()) {
781 const Module &M = *GV.getParent();
782 if (TM.getRelocationModel() != Reloc::Static &&
783 M.getPIELevel() == PIELevel::Default && GV.isDSOLocal())
784 return getSymbolWithGlobalValueBase(&GV, "$local");
785 }
786 return TM.getSymbol(&GV);
787}
788
789/// EmitGlobalVariable - Emit the specified global variable to the .s file.
791 bool IsEmuTLSVar = TM.useEmulatedTLS() && GV->isThreadLocal();
792 assert(!(IsEmuTLSVar && GV->hasCommonLinkage()) &&
793 "No emulated TLS variables in the common section");
794
795 // Never emit TLS variable xyz in emulated TLS model.
796 // The initialization value is in __emutls_t.xyz instead of xyz.
797 if (IsEmuTLSVar)
798 return;
799
800 if (GV->hasInitializer()) {
801 // Check to see if this is a special global used by LLVM, if so, emit it.
802 if (emitSpecialLLVMGlobal(GV))
803 return;
804
805 // Skip the emission of global equivalents. The symbol can be emitted later
806 // on by emitGlobalGOTEquivs in case it turns out to be needed.
807 if (GlobalGOTEquivs.count(getSymbol(GV)))
808 return;
809
810 if (isVerbose()) {
811 // When printing the control variable __emutls_v.*,
812 // we don't need to print the original TLS variable name.
813 GV->printAsOperand(OutStreamer->getCommentOS(),
814 /*PrintType=*/false, GV->getParent());
815 OutStreamer->getCommentOS() << '\n';
816 }
817 }
818
819 MCSymbol *GVSym = getSymbol(GV);
820 MCSymbol *EmittedSym = GVSym;
821
822 // getOrCreateEmuTLSControlSym only creates the symbol with name and default
823 // attributes.
824 // GV's or GVSym's attributes will be used for the EmittedSym.
825 emitVisibility(EmittedSym, GV->getVisibility(), !GV->isDeclaration());
826
827 if (GV->isTagged()) {
828 Triple T = TM.getTargetTriple();
829
830 if (T.getArch() != Triple::aarch64)
831 OutContext.reportError(SMLoc(),
832 "tagged symbols (-fsanitize=memtag-globals) are "
833 "only supported on AArch64");
834 OutStreamer->emitSymbolAttribute(EmittedSym, MCSA_Memtag);
835 }
836
837 if (!GV->hasInitializer()) // External globals require no extra code.
838 return;
839
840 GVSym->redefineIfPossible();
841 if (GVSym->isDefined() || GVSym->isVariable())
842 OutContext.reportError(SMLoc(), "symbol '" + Twine(GVSym->getName()) +
843 "' is already defined");
844
845 if (MAI.hasDotTypeDotSizeDirective())
846 OutStreamer->emitSymbolAttribute(EmittedSym, MCSA_ELF_TypeObject);
847
849
850 const DataLayout &DL = GV->getDataLayout();
852
853 // If the alignment is specified, we *must* obey it. Overaligning a global
854 // with a specified alignment is a prompt way to break globals emitted to
855 // sections and expected to be contiguous (e.g. ObjC metadata).
856 const Align Alignment = getGVAlignment(GV, DL);
857
858 for (auto &Handler : Handlers)
859 Handler->setSymbolSize(GVSym, Size);
860
861 // Handle common symbols
862 if (GVKind.isCommon()) {
863 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
864 // .comm _foo, 42, 4
865 OutStreamer->emitCommonSymbol(GVSym, Size, Alignment);
866 return;
867 }
868
869 // Determine to which section this global should be emitted.
870 MCSection *TheSection = getObjFileLowering().SectionForGlobal(GV, GVKind, TM);
871
872 // If we have a bss global going to a section that supports the
873 // zerofill directive, do so here.
874 if (GVKind.isBSS() && MAI.isMachO() && TheSection->isBssSection()) {
875 if (Size == 0)
876 Size = 1; // zerofill of 0 bytes is undefined.
877 emitLinkage(GV, GVSym);
878 // .zerofill __DATA, __bss, _foo, 400, 5
879 OutStreamer->emitZerofill(TheSection, GVSym, Size, Alignment);
880 return;
881 }
882
883 // If this is a BSS local symbol and we are emitting in the BSS
884 // section use .lcomm/.comm directive.
885 if (GVKind.isBSSLocal() &&
886 getObjFileLowering().getBSSSection() == TheSection) {
887 if (Size == 0)
888 Size = 1; // .comm Foo, 0 is undefined, avoid it.
889
890 // Use .lcomm only if it supports user-specified alignment.
891 // Otherwise, while it would still be correct to use .lcomm in some
892 // cases (e.g. when Align == 1), the external assembler might enfore
893 // some -unknown- default alignment behavior, which could cause
894 // spurious differences between external and integrated assembler.
895 // Prefer to simply fall back to .local / .comm in this case.
896 if (MAI.getLCOMMDirectiveAlignmentType() != LCOMM::NoAlignment) {
897 // .lcomm _foo, 42
898 OutStreamer->emitLocalCommonSymbol(GVSym, Size, Alignment);
899 return;
900 }
901
902 // .local _foo
903 OutStreamer->emitSymbolAttribute(GVSym, MCSA_Local);
904 // .comm _foo, 42, 4
905 OutStreamer->emitCommonSymbol(GVSym, Size, Alignment);
906 return;
907 }
908
909 // Handle thread local data for mach-o which requires us to output an
910 // additional structure of data and mangle the original symbol so that we
911 // can reference it later.
912 //
913 // TODO: This should become an "emit thread local global" method on TLOF.
914 // All of this macho specific stuff should be sunk down into TLOFMachO and
915 // stuff like "TLSExtraDataSection" should no longer be part of the parent
916 // TLOF class. This will also make it more obvious that stuff like
917 // MCStreamer::EmitTBSSSymbol is macho specific and only called from macho
918 // specific code.
919 if (GVKind.isThreadLocal() && MAI.isMachO()) {
920 // Emit the .tbss symbol
921 MCSymbol *MangSym =
922 OutContext.getOrCreateSymbol(GVSym->getName() + Twine("$tlv$init"));
923
924 if (GVKind.isThreadBSS()) {
925 TheSection = getObjFileLowering().getTLSBSSSection();
926 OutStreamer->emitTBSSSymbol(TheSection, MangSym, Size, Alignment);
927 } else if (GVKind.isThreadData()) {
928 OutStreamer->switchSection(TheSection);
929
930 emitAlignment(Alignment, GV);
931 OutStreamer->emitLabel(MangSym);
932
934 GV->getInitializer());
935 }
936
937 OutStreamer->addBlankLine();
938
939 // Emit the variable struct for the runtime.
941
942 OutStreamer->switchSection(TLVSect);
943 // Emit the linkage here.
944 emitLinkage(GV, GVSym);
945 OutStreamer->emitLabel(GVSym);
946
947 // Three pointers in size:
948 // - __tlv_bootstrap - used to make sure support exists
949 // - spare pointer, used when mapped by the runtime
950 // - pointer to mangled symbol above with initializer
951 unsigned PtrSize = DL.getPointerTypeSize(GV->getType());
952 OutStreamer->emitSymbolValue(GetExternalSymbolSymbol("_tlv_bootstrap"),
953 PtrSize);
954 OutStreamer->emitIntValue(0, PtrSize);
955 OutStreamer->emitSymbolValue(MangSym, PtrSize);
956
957 OutStreamer->addBlankLine();
958 return;
959 }
960
961 MCSymbol *EmittedInitSym = GVSym;
962
963 OutStreamer->switchSection(TheSection);
964
965 emitLinkage(GV, EmittedInitSym);
966 emitAlignment(Alignment, GV);
967
968 OutStreamer->emitLabel(EmittedInitSym);
969 MCSymbol *LocalAlias = getSymbolPreferLocal(*GV);
970 if (LocalAlias != EmittedInitSym)
971 OutStreamer->emitLabel(LocalAlias);
972
974
975 if (MAI.hasDotTypeDotSizeDirective())
976 // .size foo, 42
977 OutStreamer->emitELFSize(EmittedInitSym,
979
980 OutStreamer->addBlankLine();
981}
982
983/// Emit the directive and value for debug thread local expression
984///
985/// \p Value - The value to emit.
986/// \p Size - The size of the integer (in bytes) to emit.
987void AsmPrinter::emitDebugValue(const MCExpr *Value, unsigned Size) const {
988 OutStreamer->emitValue(Value, Size);
989}
990
991void AsmPrinter::emitFunctionHeaderComment() {}
992
993void AsmPrinter::emitFunctionPrefix(ArrayRef<const Constant *> Prefix) {
994 const Function &F = MF->getFunction();
996 for (auto &C : Prefix)
997 emitGlobalConstant(F.getDataLayout(), C);
998 return;
999 }
1000 // Preserving prefix-like data on platforms which use subsections-via-symbols
1001 // is a bit tricky. Here we introduce a symbol for the prefix-like data
1002 // and use the .alt_entry attribute to mark the function's real entry point
1003 // as an alternative entry point to the symbol that precedes the function..
1004 OutStreamer->emitLabel(OutContext.createLinkerPrivateTempSymbol());
1005
1006 for (auto &C : Prefix) {
1007 emitGlobalConstant(F.getDataLayout(), C);
1008 }
1009
1010 // Emit an .alt_entry directive for the actual function symbol.
1011 OutStreamer->emitSymbolAttribute(CurrentFnSym, MCSA_AltEntry);
1012}
1013
1014/// EmitFunctionHeader - This method emits the header for the current
1015/// function.
1016void AsmPrinter::emitFunctionHeader() {
1017 const Function &F = MF->getFunction();
1018
1019 if (isVerbose())
1020 OutStreamer->getCommentOS()
1021 << "-- Begin function "
1022 << GlobalValue::dropLLVMManglingEscape(F.getName()) << '\n';
1023
1024 // Print out constants referenced by the function
1026
1027 // Print the 'header' of function.
1028 // If basic block sections are desired, explicitly request a unique section
1029 // for this function's entry block.
1030 if (MF->front().isBeginSection())
1031 MF->setSection(getObjFileLowering().getUniqueSectionForFunction(F, TM));
1032 else
1033 MF->setSection(getObjFileLowering().SectionForGlobal(&F, TM));
1034 OutStreamer->switchSection(MF->getSection());
1035
1036 if (MAI.isAIX())
1038 else
1039 emitVisibility(CurrentFnSym, F.getVisibility());
1040
1042 if (MAI.hasFunctionAlignment()) {
1043 Align PrefAlign = MF->getPreferredAlignment();
1044 if (MAI.useIntegratedAssembler() && MAI.hasPreferredAlignment()) {
1045 // Emit .p2align for the effective minimum alignment (which accounts for
1046 // F's own align attribute via getGVAlignment), then emit .prefalign only
1047 // when the preferred alignment is greater. The end symbol must be
1048 // created here, before the function body, so that .prefalign can
1049 // reference it; emitFunctionBody will emit the label at the function
1050 // end.
1051 Align MinAlign = emitAlignment(MF->getAlignment(), &F);
1052 if (MinAlign < PrefAlign) {
1053 CurrentFnEnd = createTempSymbol("func_end");
1054 OutStreamer->emitPrefAlign(PrefAlign, *CurrentFnEnd,
1055 /*EmitNops=*/true, /*Fill=*/0,
1057 }
1058 } else {
1059 emitAlignment(PrefAlign, &F);
1060 }
1061 }
1062
1063 if (MAI.hasDotTypeDotSizeDirective())
1064 OutStreamer->emitSymbolAttribute(CurrentFnSym, MCSA_ELF_TypeFunction);
1065
1066 if (F.hasFnAttribute(Attribute::Cold))
1067 OutStreamer->emitSymbolAttribute(CurrentFnSym, MCSA_Cold);
1068
1069 // Emit the prefix data.
1070 if (F.hasPrefixData())
1071 emitFunctionPrefix({F.getPrefixData()});
1072
1073 // Emit KCFI type information before patchable-function-prefix nops.
1075
1076 // Emit M NOPs for -fpatchable-function-entry=N,M where M>0. We arbitrarily
1077 // place prefix data before NOPs.
1078 unsigned PatchableFunctionPrefix =
1079 F.getFnAttributeAsParsedInteger("patchable-function-prefix");
1080 unsigned PatchableFunctionEntry =
1081 F.getFnAttributeAsParsedInteger("patchable-function-entry");
1082 if (PatchableFunctionPrefix) {
1084 OutContext.createLinkerPrivateTempSymbol();
1086 emitNops(PatchableFunctionPrefix);
1087 } else if (PatchableFunctionEntry) {
1088 // May be reassigned when emitting the body, to reference the label after
1089 // the initial BTI (AArch64) or endbr32/endbr64 (x86).
1091 }
1092
1093 // Emit the function prologue data for the indirect call sanitizer.
1094 if (const MDNode *MD = F.getMetadata(LLVMContext::MD_func_sanitize)) {
1095 assert(MD->getNumOperands() == 2);
1096
1097 auto *PrologueSig = mdconst::extract<Constant>(MD->getOperand(0));
1098 auto *TypeHash = mdconst::extract<Constant>(MD->getOperand(1));
1099 emitFunctionPrefix({PrologueSig, TypeHash});
1100 }
1101
1102 if (isVerbose()) {
1103 F.printAsOperand(OutStreamer->getCommentOS(),
1104 /*PrintType=*/false, F.getParent());
1105 emitFunctionHeaderComment();
1106 OutStreamer->getCommentOS() << '\n';
1107 }
1108
1109 // Emit the function descriptor. This is a virtual function to allow targets
1110 // to emit their specific function descriptor. Right now it is only used by
1111 // the AIX target. The PowerPC 64-bit V1 ELF target also uses function
1112 // descriptors and should be converted to use this hook as well.
1113 if (MAI.isAIX())
1115
1116 // Emit the CurrentFnSym. This is a virtual function to allow targets to do
1117 // their wild and crazy things as required.
1119
1120 // If the function had address-taken blocks that got deleted, then we have
1121 // references to the dangling symbols. Emit them at the start of the function
1122 // so that we don't get references to undefined symbols.
1123 std::vector<MCSymbol*> DeadBlockSyms;
1124 takeDeletedSymbolsForFunction(&F, DeadBlockSyms);
1125 for (MCSymbol *DeadBlockSym : DeadBlockSyms) {
1126 OutStreamer->AddComment("Address taken block that was later removed");
1127 OutStreamer->emitLabel(DeadBlockSym);
1128 }
1129
1130 if (CurrentFnBegin) {
1131 if (MAI.useAssignmentForEHBegin()) {
1132 MCSymbol *CurPos = OutContext.createTempSymbol();
1133 OutStreamer->emitLabel(CurPos);
1134 OutStreamer->emitAssignment(CurrentFnBegin,
1136 } else {
1137 OutStreamer->emitLabel(CurrentFnBegin);
1138 }
1139 }
1140
1141 // Emit pre-function debug and/or EH information.
1142 for (auto &Handler : Handlers) {
1143 Handler->beginFunction(MF);
1144 Handler->beginBasicBlockSection(MF->front());
1145 }
1146 for (auto &Handler : EHHandlers) {
1147 Handler->beginFunction(MF);
1148 Handler->beginBasicBlockSection(MF->front());
1149 }
1150
1151 // Emit the prologue data.
1152 if (F.hasPrologueData())
1153 emitGlobalConstant(F.getDataLayout(), F.getPrologueData());
1154}
1155
1156/// EmitFunctionEntryLabel - Emit the label that is the entrypoint for the
1157/// function. This can be overridden by targets as required to do custom stuff.
1159 CurrentFnSym->redefineIfPossible();
1160 OutStreamer->emitLabel(CurrentFnSym);
1161
1162 if (TM.getTargetTriple().isOSBinFormatELF()) {
1163 MCSymbol *Sym = getSymbolPreferLocal(MF->getFunction());
1164 if (Sym != CurrentFnSym) {
1165 CurrentFnBeginLocal = Sym;
1166 OutStreamer->emitLabel(Sym);
1167 OutStreamer->emitSymbolAttribute(Sym, MCSA_ELF_TypeFunction);
1168 }
1169 }
1170}
1171
1172/// emitComments - Pretty-print comments for instructions.
1173static void emitComments(const MachineInstr &MI, const MCSubtargetInfo *STI,
1174 raw_ostream &CommentOS) {
1175 const MachineFunction *MF = MI.getMF();
1177
1178 // Check for spills and reloads
1179
1180 // We assume a single instruction only has a spill or reload, not
1181 // both.
1182 std::optional<LocationSize> Size;
1183 if ((Size = MI.getRestoreSize(TII))) {
1184 CommentOS << Size->getValue() << "-byte Reload\n";
1185 } else if ((Size = MI.getFoldedRestoreSize(TII))) {
1186 if (!Size->hasValue())
1187 CommentOS << "Unknown-size Folded Reload\n";
1188 else if (Size->getValue())
1189 CommentOS << Size->getValue() << "-byte Folded Reload\n";
1190 } else if ((Size = MI.getSpillSize(TII))) {
1191 CommentOS << Size->getValue() << "-byte Spill\n";
1192 } else if ((Size = MI.getFoldedSpillSize(TII))) {
1193 if (!Size->hasValue())
1194 CommentOS << "Unknown-size Folded Spill\n";
1195 else if (Size->getValue())
1196 CommentOS << Size->getValue() << "-byte Folded Spill\n";
1197 }
1198
1199 // Check for spill-induced copies
1200 if (MI.getAsmPrinterFlag(MachineInstr::ReloadReuse))
1201 CommentOS << " Reload Reuse\n";
1202
1203 if (PrintLatency) {
1205 const MCSchedModel &SCModel = STI->getSchedModel();
1208 *STI, *TII, MI);
1209 // Report only interesting latencies.
1210 if (1 < Latency)
1211 CommentOS << " Latency: " << Latency << "\n";
1212 }
1213}
1214
1215/// emitImplicitDef - This method emits the specified machine instruction
1216/// that is an implicit def.
1218 Register RegNo = MI->getOperand(0).getReg();
1219
1220 SmallString<128> Str;
1221 raw_svector_ostream OS(Str);
1222 OS << "implicit-def: "
1223 << printReg(RegNo, MF->getSubtarget().getRegisterInfo());
1224
1225 OutStreamer->AddComment(OS.str());
1226 OutStreamer->addBlankLine();
1227}
1228
1229static void emitKill(const MachineInstr *MI, AsmPrinter &AP) {
1230 std::string Str;
1231 raw_string_ostream OS(Str);
1232 OS << "kill:";
1233 for (const MachineOperand &Op : MI->operands()) {
1234 assert(Op.isReg() && "KILL instruction must have only register operands");
1235 OS << ' ' << (Op.isDef() ? "def " : "killed ")
1236 << printReg(Op.getReg(), AP.MF->getSubtarget().getRegisterInfo());
1237 }
1238 AP.OutStreamer->AddComment(Str);
1239 AP.OutStreamer->addBlankLine();
1240}
1241
1242static void emitFakeUse(const MachineInstr *MI, AsmPrinter &AP) {
1243 std::string Str;
1244 raw_string_ostream OS(Str);
1245 OS << "fake_use:";
1246 for (const MachineOperand &Op : MI->operands()) {
1247 // In some circumstances we can end up with fake uses of constants; skip
1248 // these.
1249 if (!Op.isReg())
1250 continue;
1251 OS << ' ' << printReg(Op.getReg(), AP.MF->getSubtarget().getRegisterInfo());
1252 }
1253 AP.OutStreamer->AddComment(OS.str());
1254 AP.OutStreamer->addBlankLine();
1255}
1256
1257/// emitDebugValueComment - This method handles the target-independent form
1258/// of DBG_VALUE, returning true if it was able to do so. A false return
1259/// means the target will need to handle MI in EmitInstruction.
1261 // This code handles only the 4-operand target-independent form.
1262 if (MI->isNonListDebugValue() && MI->getNumOperands() != 4)
1263 return false;
1264
1265 SmallString<128> Str;
1266 raw_svector_ostream OS(Str);
1267 OS << "DEBUG_VALUE: ";
1268
1269 const DILocalVariable *V = MI->getDebugVariable();
1270 if (auto *SP = dyn_cast<DISubprogram>(V->getScope())) {
1271 StringRef Name = SP->getName();
1272 if (!Name.empty())
1273 OS << Name << ":";
1274 }
1275 OS << V->getName();
1276 OS << " <- ";
1277
1278 const DIExpression *Expr = MI->getDebugExpression();
1279 // First convert this to a non-variadic expression if possible, to simplify
1280 // the output.
1281 if (auto NonVariadicExpr = DIExpression::convertToNonVariadicExpression(Expr))
1282 Expr = *NonVariadicExpr;
1283 // Then, output the possibly-simplified expression.
1284 if (Expr->getNumElements()) {
1285 OS << '[';
1286 ListSeparator LS;
1287 for (auto &Op : Expr->expr_ops()) {
1288 OS << LS << dwarf::OperationEncodingString(Op.getOp());
1289 for (unsigned I = 0; I < Op.getNumArgs(); ++I)
1290 OS << ' ' << Op.getArg(I);
1291 }
1292 OS << "] ";
1293 }
1294
1295 // Register or immediate value. Register 0 means undef.
1296 for (const MachineOperand &Op : MI->debug_operands()) {
1297 if (&Op != MI->debug_operands().begin())
1298 OS << ", ";
1299 switch (Op.getType()) {
1301 APFloat APF = APFloat(Op.getFPImm()->getValueAPF());
1302 Type *ImmTy = Op.getFPImm()->getType();
1303 if (ImmTy->isBFloatTy() || ImmTy->isHalfTy() || ImmTy->isFloatTy() ||
1304 ImmTy->isDoubleTy()) {
1305 OS << APF.convertToDouble();
1306 } else {
1307 // There is no good way to print long double. Convert a copy to
1308 // double. Ah well, it's only a comment.
1309 bool ignored;
1311 &ignored);
1312 OS << "(long double) " << APF.convertToDouble();
1313 }
1314 break;
1315 }
1317 OS << Op.getImm();
1318 break;
1319 }
1321 Op.getCImm()->getValue().print(OS, false /*isSigned*/);
1322 break;
1323 }
1325 OS << "!target-index(" << Op.getIndex() << "," << Op.getOffset() << ")";
1326 break;
1327 }
1330 Register Reg;
1331 std::optional<StackOffset> Offset;
1332 if (Op.isReg()) {
1333 Reg = Op.getReg();
1334 } else {
1335 const TargetFrameLowering *TFI =
1337 Offset = TFI->getFrameIndexReference(*AP.MF, Op.getIndex(), Reg);
1338 }
1339 if (!Reg) {
1340 // Suppress offset, it is not meaningful here.
1341 OS << "undef";
1342 break;
1343 }
1344 // The second operand is only an offset if it's an immediate.
1345 if (MI->isIndirectDebugValue())
1346 Offset = StackOffset::getFixed(MI->getDebugOffset().getImm());
1347 if (Offset)
1348 OS << '[';
1349 OS << printReg(Reg, AP.MF->getSubtarget().getRegisterInfo());
1350 if (Offset)
1351 OS << '+' << Offset->getFixed() << ']';
1352 break;
1353 }
1354 default:
1355 llvm_unreachable("Unknown operand type");
1356 }
1357 }
1358
1359 // NOTE: Want this comment at start of line, don't emit with AddComment.
1360 AP.OutStreamer->emitRawComment(Str);
1361 return true;
1362}
1363
1364/// This method handles the target-independent form of DBG_LABEL, returning
1365/// true if it was able to do so. A false return means the target will need
1366/// to handle MI in EmitInstruction.
1368 if (MI->getNumOperands() != 1)
1369 return false;
1370
1371 SmallString<128> Str;
1372 raw_svector_ostream OS(Str);
1373 OS << "DEBUG_LABEL: ";
1374
1375 const DILabel *V = MI->getDebugLabel();
1376 if (auto *SP = dyn_cast<DISubprogram>(
1377 V->getScope()->getNonLexicalBlockFileScope())) {
1378 StringRef Name = SP->getName();
1379 if (!Name.empty())
1380 OS << Name << ":";
1381 }
1382 OS << V->getName();
1383
1384 // NOTE: Want this comment at start of line, don't emit with AddComment.
1385 AP.OutStreamer->emitRawComment(OS.str());
1386 return true;
1387}
1388
1391 // Ignore functions that won't get emitted.
1392 if (F.isDeclarationForLinker())
1393 return CFISection::None;
1394
1395 if (MAI.getExceptionHandlingType() == ExceptionHandling::DwarfCFI &&
1396 F.needsUnwindTableEntry())
1397 return CFISection::EH;
1398
1399 if (MAI.usesCFIWithoutEH() && F.hasUWTable())
1400 return CFISection::EH;
1401
1402 if (hasDebugInfo() || TM.Options.ForceDwarfFrameSection)
1403 return CFISection::Debug;
1404
1405 return CFISection::None;
1406}
1407
1412
1414 return MAI.usesWindowsCFI() && MF->getFunction().needsUnwindTableEntry();
1415}
1416
1418 return MAI.usesCFIWithoutEH() && ModuleCFISection != CFISection::None;
1419}
1420
1422 ExceptionHandling ExceptionHandlingType = MAI.getExceptionHandlingType();
1423 if (!usesCFIWithoutEH() &&
1424 ExceptionHandlingType != ExceptionHandling::DwarfCFI &&
1425 ExceptionHandlingType != ExceptionHandling::ARM)
1426 return;
1427
1429 return;
1430
1431 // If there is no "real" instruction following this CFI instruction, skip
1432 // emitting it; it would be beyond the end of the function's FDE range.
1433 auto *MBB = MI.getParent();
1434 auto I = std::next(MI.getIterator());
1435 while (I != MBB->end() && I->isTransient())
1436 ++I;
1437 if (I == MBB->instr_end() &&
1438 MBB->getReverseIterator() == MBB->getParent()->rbegin())
1439 return;
1440
1441 const std::vector<MCCFIInstruction> &Instrs = MF->getFrameInstructions();
1442 unsigned CFIIndex = MI.getOperand(0).getCFIIndex();
1443 const MCCFIInstruction &CFI = Instrs[CFIIndex];
1444 emitCFIInstruction(CFI);
1445}
1446
1448 // The operands are the MCSymbol and the frame offset of the allocation.
1449 MCSymbol *FrameAllocSym = MI.getOperand(0).getMCSymbol();
1450 int FrameOffset = MI.getOperand(1).getImm();
1451
1452 // Emit a symbol assignment.
1453 OutStreamer->emitAssignment(FrameAllocSym,
1454 MCConstantExpr::create(FrameOffset, OutContext));
1455}
1456
1457/// Returns the BB metadata to be emitted in the SHT_LLVM_BB_ADDR_MAP section
1458/// for a given basic block. This can be used to capture more precise profile
1459/// information.
1461 const TargetInstrInfo *TII = MBB.getParent()->getSubtarget().getInstrInfo();
1463 MBB.isReturnBlock(), !MBB.empty() && TII->isTailCall(MBB.back()),
1464 MBB.isEHPad(), const_cast<MachineBasicBlock &>(MBB).canFallThrough(),
1465 !MBB.empty() && MBB.rbegin()->isIndirectBranch()}
1466 .encode();
1467}
1468
1470getBBAddrMapFeature(const MachineFunction &MF, int NumMBBSectionRanges,
1471 bool HasCalls, const CFGProfile *FuncCFGProfile) {
1472 // Ensure that the user has not passed in additional options while also
1473 // specifying all or none.
1476 popcount(PgoAnalysisMapFeatures.getBits()) != 1) {
1478 "-pgo-analysis-map can accept only all or none with no additional "
1479 "values.");
1480 }
1481
1482 bool NoFeatures = PgoAnalysisMapFeatures.isSet(PGOMapFeaturesEnum::None);
1484 bool FuncEntryCountEnabled =
1485 AllFeatures || (!NoFeatures && PgoAnalysisMapFeatures.isSet(
1487 bool BBFreqEnabled =
1488 AllFeatures ||
1489 (!NoFeatures && PgoAnalysisMapFeatures.isSet(PGOMapFeaturesEnum::BBFreq));
1490 bool BrProbEnabled =
1491 AllFeatures ||
1492 (!NoFeatures && PgoAnalysisMapFeatures.isSet(PGOMapFeaturesEnum::BrProb));
1493 bool PostLinkCfgEnabled = FuncCFGProfile && PgoAnalysisMapEmitBBSectionsCfg;
1494
1495 if ((BBFreqEnabled || BrProbEnabled) && BBAddrMapSkipEmitBBEntries) {
1497 "BB entries info is required for BBFreq and BrProb features");
1498 }
1499 return {FuncEntryCountEnabled, BBFreqEnabled, BrProbEnabled,
1500 MF.hasBBSections() && NumMBBSectionRanges > 1,
1501 // Use static_cast to avoid breakage of tests on windows.
1502 static_cast<bool>(BBAddrMapSkipEmitBBEntries), HasCalls,
1503 static_cast<bool>(EmitBBHash), PostLinkCfgEnabled};
1504}
1505
1507 MCSection *BBAddrMapSection =
1508 getObjFileLowering().getBBAddrMapSection(*MF.getSection());
1509 assert(BBAddrMapSection && ".llvm_bb_addr_map section is not initialized.");
1510 bool HasCalls = !CurrentFnCallsiteEndSymbols.empty();
1511
1512 const BasicBlockSectionsProfileReader *BBSPR = nullptr;
1513 if (auto *BBSPRPass =
1515 BBSPR = &BBSPRPass->getBBSPR();
1516 const CFGProfile *FuncCFGProfile = nullptr;
1517 if (BBSPR)
1518 FuncCFGProfile = BBSPR->getFunctionCFGProfile(MF.getFunction().getName());
1519
1520 const MCSymbol *FunctionSymbol = getFunctionBegin();
1521
1522 OutStreamer->pushSection();
1523 OutStreamer->switchSection(BBAddrMapSection);
1524 OutStreamer->AddComment("version");
1525 uint8_t BBAddrMapVersion = OutStreamer->getContext().getBBAddrMapVersion();
1526 OutStreamer->emitInt8(BBAddrMapVersion);
1527 OutStreamer->AddComment("feature");
1528 auto Features = getBBAddrMapFeature(MF, MBBSectionRanges.size(), HasCalls,
1529 FuncCFGProfile);
1530 OutStreamer->emitInt16(Features.encode());
1531 // Emit BB Information for each basic block in the function.
1532 if (Features.MultiBBRange) {
1533 OutStreamer->AddComment("number of basic block ranges");
1534 OutStreamer->emitULEB128IntValue(MBBSectionRanges.size());
1535 }
1536 // Number of blocks in each MBB section.
1537 MapVector<MBBSectionID, unsigned> MBBSectionNumBlocks;
1538 const MCSymbol *PrevMBBEndSymbol = nullptr;
1539 if (!Features.MultiBBRange) {
1540 OutStreamer->AddComment("function address");
1541 OutStreamer->emitSymbolValue(FunctionSymbol, getPointerSize());
1542 OutStreamer->AddComment("number of basic blocks");
1543 OutStreamer->emitULEB128IntValue(MF.size());
1544 PrevMBBEndSymbol = FunctionSymbol;
1545 } else {
1546 unsigned BBCount = 0;
1547 for (const MachineBasicBlock &MBB : MF) {
1548 BBCount++;
1549 if (MBB.isEndSection()) {
1550 // Store each section's basic block count when it ends.
1551 MBBSectionNumBlocks[MBB.getSectionID()] = BBCount;
1552 // Reset the count for the next section.
1553 BBCount = 0;
1554 }
1555 }
1556 }
1557 // Emit the BB entry for each basic block in the function.
1558 for (const MachineBasicBlock &MBB : MF) {
1559 const MCSymbol *MBBSymbol =
1560 MBB.isEntryBlock() ? FunctionSymbol : MBB.getSymbol();
1561 bool IsBeginSection =
1562 Features.MultiBBRange && (MBB.isBeginSection() || MBB.isEntryBlock());
1563 if (IsBeginSection) {
1564 OutStreamer->AddComment("base address");
1565 OutStreamer->emitSymbolValue(MBBSymbol, getPointerSize());
1566 OutStreamer->AddComment("number of basic blocks");
1567 OutStreamer->emitULEB128IntValue(MBBSectionNumBlocks[MBB.getSectionID()]);
1568 PrevMBBEndSymbol = MBBSymbol;
1569 }
1570
1571 auto MBHI =
1572 Features.BBHash ? &getAnalysis<MachineBlockHashInfo>() : nullptr;
1573
1574 if (!Features.OmitBBEntries) {
1575 OutStreamer->AddComment("BB id");
1576 // Emit the BB ID for this basic block.
1577 // We only emit BaseID since CloneID is unset for
1578 // -basic-block-adress-map.
1579 // TODO: Emit the full BBID when labels and sections can be mixed
1580 // together.
1581 OutStreamer->emitULEB128IntValue(MBB.getBBID()->BaseID);
1582 // Emit the basic block offset relative to the end of the previous block.
1583 // This is zero unless the block is padded due to alignment.
1584 emitLabelDifferenceAsULEB128(MBBSymbol, PrevMBBEndSymbol);
1585 const MCSymbol *CurrentLabel = MBBSymbol;
1586 if (HasCalls) {
1587 auto CallsiteEndSymbols = CurrentFnCallsiteEndSymbols.lookup(&MBB);
1588 OutStreamer->AddComment("number of callsites");
1589 OutStreamer->emitULEB128IntValue(CallsiteEndSymbols.size());
1590 for (const MCSymbol *CallsiteEndSymbol : CallsiteEndSymbols) {
1591 // Emit the callsite offset.
1592 emitLabelDifferenceAsULEB128(CallsiteEndSymbol, CurrentLabel);
1593 CurrentLabel = CallsiteEndSymbol;
1594 }
1595 }
1596 // Emit the offset to the end of the block, which can be used to compute
1597 // the total block size.
1598 emitLabelDifferenceAsULEB128(MBB.getEndSymbol(), CurrentLabel);
1599 // Emit the Metadata.
1600 OutStreamer->emitULEB128IntValue(getBBAddrMapMetadata(MBB));
1601 // Emit the Hash.
1602 if (MBHI) {
1603 OutStreamer->emitInt64(MBHI->getMBBHash(MBB));
1604 }
1605 }
1606 PrevMBBEndSymbol = MBB.getEndSymbol();
1607 }
1608
1609 if (Features.hasPGOAnalysis()) {
1610 assert(BBAddrMapVersion >= 2 &&
1611 "PGOAnalysisMap only supports version 2 or later");
1612
1613 if (Features.FuncEntryCount) {
1614 OutStreamer->AddComment("function entry count");
1615 auto MaybeEntryCount = MF.getFunction().getEntryCount();
1616 OutStreamer->emitULEB128IntValue(MaybeEntryCount ? *MaybeEntryCount : 0);
1617 }
1618 const MachineBlockFrequencyInfo *MBFI =
1619 Features.BBFreq
1621 : nullptr;
1622 const MachineBranchProbabilityInfo *MBPI =
1623 Features.BrProb
1625 : nullptr;
1626
1627 if (Features.BBFreq || Features.BrProb) {
1628 for (const MachineBasicBlock &MBB : MF) {
1629 if (Features.BBFreq) {
1630 OutStreamer->AddComment("basic block frequency");
1631 OutStreamer->emitULEB128IntValue(
1632 MBFI->getBlockFreq(&MBB).getFrequency());
1633 if (Features.PostLinkCfg) {
1634 OutStreamer->AddComment("basic block frequency (propeller)");
1635 OutStreamer->emitULEB128IntValue(
1636 FuncCFGProfile->getBlockCount(*MBB.getBBID()));
1637 }
1638 }
1639 if (Features.BrProb) {
1640 unsigned SuccCount = MBB.succ_size();
1641 OutStreamer->AddComment("basic block successor count");
1642 OutStreamer->emitULEB128IntValue(SuccCount);
1643 for (const MachineBasicBlock *SuccMBB : MBB.successors()) {
1644 OutStreamer->AddComment("successor BB ID");
1645 OutStreamer->emitULEB128IntValue(SuccMBB->getBBID()->BaseID);
1646 OutStreamer->AddComment("successor branch probability");
1647 OutStreamer->emitULEB128IntValue(
1648 MBPI->getEdgeProbability(&MBB, SuccMBB).getNumerator());
1649 if (Features.PostLinkCfg) {
1650 OutStreamer->AddComment("successor branch frequency (propeller)");
1651 OutStreamer->emitULEB128IntValue(FuncCFGProfile->getEdgeCount(
1652 *MBB.getBBID(), *SuccMBB->getBBID()));
1653 }
1654 }
1655 }
1656 }
1657 }
1658 }
1659
1660 OutStreamer->popSection();
1661}
1662
1664 const MCSymbol *Symbol) {
1665 MCSection *Section =
1666 getObjFileLowering().getKCFITrapSection(*MF.getSection());
1667 if (!Section)
1668 return;
1669
1670 OutStreamer->pushSection();
1671 OutStreamer->switchSection(Section);
1672
1673 MCSymbol *Loc = OutContext.createLinkerPrivateTempSymbol();
1674 OutStreamer->emitLabel(Loc);
1675 OutStreamer->emitAbsoluteSymbolDiff(Symbol, Loc, 4);
1676
1677 OutStreamer->popSection();
1678}
1679
1681 const Function &F = MF.getFunction();
1682 if (const MDNode *MD = F.getMetadata(LLVMContext::MD_kcfi_type))
1683 emitGlobalConstant(F.getDataLayout(),
1684 mdconst::extract<ConstantInt>(MD->getOperand(0)));
1685}
1686
1688 if (PP) {
1689 auto GUID = MI.getOperand(0).getImm();
1690 auto Index = MI.getOperand(1).getImm();
1691 auto Type = MI.getOperand(2).getImm();
1692 auto Attr = MI.getOperand(3).getImm();
1693 DILocation *DebugLoc = MI.getDebugLoc();
1694 PP->emitPseudoProbe(GUID, Index, Type, Attr, DebugLoc);
1695 }
1696}
1697
1699 if (!MF.getTarget().Options.EmitStackSizeSection)
1700 return;
1701
1702 MCSection *StackSizeSection =
1704 if (!StackSizeSection)
1705 return;
1706
1707 const MachineFrameInfo &FrameInfo = MF.getFrameInfo();
1708 // Don't emit functions with dynamic stack allocations.
1709 if (FrameInfo.hasVarSizedObjects())
1710 return;
1711
1712 OutStreamer->pushSection();
1713 OutStreamer->switchSection(StackSizeSection);
1714
1715 const MCSymbol *FunctionSymbol = getFunctionBegin();
1716 uint64_t StackSize =
1717 FrameInfo.getStackSize() + FrameInfo.getUnsafeStackSize();
1718 OutStreamer->emitSymbolValue(FunctionSymbol, TM.getProgramPointerSize());
1719 OutStreamer->emitULEB128IntValue(StackSize);
1720
1721 OutStreamer->popSection();
1722}
1723
1725 const std::string OutputFilename =
1727 : MF.getTarget().Options.StackUsageFile;
1728
1729 // OutputFilename empty implies -fstack-usage is not passed.
1730 if (OutputFilename.empty())
1731 return;
1732
1733 const MachineFrameInfo &FrameInfo = MF.getFrameInfo();
1734 uint64_t StackSize =
1735 FrameInfo.getStackSize() + FrameInfo.getUnsafeStackSize();
1736
1737 if (StackUsageStream == nullptr) {
1738 std::error_code EC;
1739 StackUsageStream =
1740 std::make_unique<raw_fd_ostream>(OutputFilename, EC, sys::fs::OF_Text);
1741 if (EC) {
1742 errs() << "Could not open file: " << EC.message();
1743 return;
1744 }
1745 }
1746
1747 if (const DISubprogram *DSP = MF.getFunction().getSubprogram())
1748 *StackUsageStream << DSP->getFilename() << ':' << DSP->getLine();
1749 else
1750 *StackUsageStream << MF.getFunction().getParent()->getName();
1751
1752 *StackUsageStream << ':' << MF.getName() << '\t' << StackSize << '\t';
1753 if (FrameInfo.hasVarSizedObjects())
1754 *StackUsageStream << "dynamic\n";
1755 else
1756 *StackUsageStream << "static\n";
1757}
1758
1759/// Extracts a generalized numeric type identifier of a Function's type from
1760/// callgraph metadata. Returns null if metadata cannot be found.
1763 F.getMetadata(LLVMContext::MD_callgraph, Types);
1764 for (const auto &Type : Types) {
1765 if (Type->getNumOperands() == 1 && isa<MDString>(Type->getOperand(0))) {
1766 MDString *MDGeneralizedTypeId = cast<MDString>(Type->getOperand(0));
1767 if (MDGeneralizedTypeId->getString().ends_with(".generalized")) {
1768 uint64_t TypeIdVal = llvm::MD5Hash(MDGeneralizedTypeId->getString());
1769 IntegerType *Int64Ty = Type::getInt64Ty(F.getContext());
1770 return ConstantInt::get(Int64Ty, TypeIdVal);
1771 }
1772 }
1773 }
1774 return nullptr;
1775}
1776
1777/// Emits .llvm.callgraph section.
1779 FunctionCallGraphInfo &FuncCGInfo) {
1780 if (!MF.getTarget().Options.EmitCallGraphSection)
1781 return;
1782
1783 // Switch to the call graph section for the function
1784 MCSection *FuncCGSection =
1786 assert(FuncCGSection && "null callgraph section");
1787 OutStreamer->pushSection();
1788 OutStreamer->switchSection(FuncCGSection);
1789
1790 const Function &F = MF.getFunction();
1791 // If this function has external linkage or has its address taken and
1792 // it is not a callback, then anything could call it.
1793 bool IsIndirectTarget =
1794 !F.hasLocalLinkage() || F.hasAddressTaken(nullptr,
1795 /*IgnoreCallbackUses=*/true,
1796 /*IgnoreAssumeLikeCalls=*/true,
1797 /*IgnoreLLVMUsed=*/false);
1798
1799 const auto &DirectCallees = FuncCGInfo.DirectCallees;
1800 const auto &IndirectCalleeTypeIDs = FuncCGInfo.IndirectCalleeTypeIDs;
1801
1802 using namespace callgraph;
1803 Flags CGFlags = Flags::None;
1804 if (IsIndirectTarget)
1805 CGFlags |= Flags::IsIndirectTarget;
1806 if (DirectCallees.size() > 0)
1807 CGFlags |= Flags::HasDirectCallees;
1808 if (IndirectCalleeTypeIDs.size() > 0)
1809 CGFlags |= Flags::HasIndirectCallees;
1810
1811 // Emit function's call graph information.
1812 // 1) CallGraphSectionFormatVersion
1813 // 2) Flags
1814 // a. LSB bit 0 is set to 1 if the function is a potential indirect
1815 // target.
1816 // b. LSB bit 1 is set to 1 if there are direct callees.
1817 // c. LSB bit 2 is set to 1 if there are indirect callees.
1818 // d. Rest of the 5 bits in Flags are reserved for any future use.
1819 // 3) Function entry PC.
1820 // 4) FunctionTypeID if the function is indirect target and its type id
1821 // is known, otherwise it is set to 0.
1822 // 5) Number of unique direct callees, if at least one exists.
1823 // 6) For each unique direct callee, the callee's PC.
1824 // 7) Number of unique indirect target type IDs, if at least one exists.
1825 // 8) Each unique indirect target type id.
1826 OutStreamer->emitInt8(CallGraphSectionFormatVersion::V_0);
1827 OutStreamer->emitInt8(static_cast<uint8_t>(CGFlags));
1828 OutStreamer->emitSymbolValue(getSymbol(&F), TM.getProgramPointerSize());
1829 const auto *TypeId = extractNumericCGTypeId(F);
1830 if (IsIndirectTarget && TypeId)
1831 OutStreamer->emitInt64(TypeId->getZExtValue());
1832 else
1833 OutStreamer->emitInt64(0);
1834
1835 if (DirectCallees.size() > 0) {
1836 OutStreamer->emitULEB128IntValue(DirectCallees.size());
1837 for (const auto &CalleeSymbol : DirectCallees)
1838 OutStreamer->emitSymbolValue(CalleeSymbol, TM.getProgramPointerSize());
1839 FuncCGInfo.DirectCallees.clear();
1840 }
1841 if (IndirectCalleeTypeIDs.size() > 0) {
1842 OutStreamer->emitULEB128IntValue(IndirectCalleeTypeIDs.size());
1843 for (const auto &CalleeTypeId : IndirectCalleeTypeIDs)
1844 OutStreamer->emitInt64(CalleeTypeId);
1845 FuncCGInfo.IndirectCalleeTypeIDs.clear();
1846 }
1847 // End of emitting call graph section contents.
1848 OutStreamer->popSection();
1849}
1850
1852 const MDNode &MD) {
1853 MCSymbol *S = MF.getContext().createTempSymbol("pcsection");
1854 OutStreamer->emitLabel(S);
1855 PCSectionsSymbols[&MD].emplace_back(S);
1856}
1857
1859 const Function &F = MF.getFunction();
1860 if (PCSectionsSymbols.empty() && !F.hasMetadata(LLVMContext::MD_pcsections))
1861 return;
1862
1863 const CodeModel::Model CM = MF.getTarget().getCodeModel();
1864 const unsigned RelativeRelocSize =
1866 : 4;
1867
1868 // Switch to PCSection, short-circuiting the common case where the current
1869 // section is still valid (assume most MD_pcsections contain just 1 section).
1870 auto SwitchSection = [&, Prev = StringRef()](const StringRef &Sec) mutable {
1871 if (Sec == Prev)
1872 return;
1873 MCSection *S = getObjFileLowering().getPCSection(Sec, MF.getSection());
1874 assert(S && "PC section is not initialized");
1875 OutStreamer->switchSection(S);
1876 Prev = Sec;
1877 };
1878 // Emit symbols into sections and data as specified in the pcsections MDNode.
1879 auto EmitForMD = [&](const MDNode &MD, ArrayRef<const MCSymbol *> Syms,
1880 bool Deltas) {
1881 // Expect the first operand to be a section name. After that, a tuple of
1882 // constants may appear, which will simply be emitted into the current
1883 // section (the user of MD_pcsections decides the format of encoded data).
1884 assert(isa<MDString>(MD.getOperand(0)) && "first operand not a string");
1885 bool ConstULEB128 = false;
1886 for (const MDOperand &MDO : MD.operands()) {
1887 if (auto *S = dyn_cast<MDString>(MDO)) {
1888 // Found string, start of new section!
1889 // Find options for this section "<section>!<opts>" - supported options:
1890 // C = Compress constant integers of size 2-8 bytes as ULEB128.
1891 const StringRef SecWithOpt = S->getString();
1892 const size_t OptStart = SecWithOpt.find('!'); // likely npos
1893 const StringRef Sec = SecWithOpt.substr(0, OptStart);
1894 const StringRef Opts = SecWithOpt.substr(OptStart); // likely empty
1895 ConstULEB128 = Opts.contains('C');
1896#ifndef NDEBUG
1897 for (char O : Opts)
1898 assert((O == '!' || O == 'C') && "Invalid !pcsections options");
1899#endif
1900 SwitchSection(Sec);
1901 const MCSymbol *Prev = Syms.front();
1902 for (const MCSymbol *Sym : Syms) {
1903 if (Sym == Prev || !Deltas) {
1904 // Use the entry itself as the base of the relative offset.
1905 MCSymbol *Base = MF.getContext().createTempSymbol("pcsection_base");
1906 OutStreamer->emitLabel(Base);
1907 // Emit relative relocation `addr - base`, which avoids a dynamic
1908 // relocation in the final binary. User will get the address with
1909 // `base + addr`.
1910 emitLabelDifference(Sym, Base, RelativeRelocSize);
1911 } else {
1912 // Emit delta between symbol and previous symbol.
1913 if (ConstULEB128)
1915 else
1916 emitLabelDifference(Sym, Prev, 4);
1917 }
1918 Prev = Sym;
1919 }
1920 } else {
1921 // Emit auxiliary data after PC.
1922 assert(isa<MDNode>(MDO) && "expecting either string or tuple");
1923 const auto *AuxMDs = cast<MDNode>(MDO);
1924 for (const MDOperand &AuxMDO : AuxMDs->operands()) {
1925 assert(isa<ConstantAsMetadata>(AuxMDO) && "expecting a constant");
1926 const Constant *C = cast<ConstantAsMetadata>(AuxMDO)->getValue();
1927 const DataLayout &DL = F.getDataLayout();
1928 const uint64_t Size = DL.getTypeStoreSize(C->getType());
1929
1930 if (auto *CI = dyn_cast<ConstantInt>(C);
1931 CI && ConstULEB128 && Size > 1 && Size <= 8) {
1932 emitULEB128(CI->getZExtValue());
1933 } else {
1935 }
1936 }
1937 }
1938 }
1939 };
1940
1941 OutStreamer->pushSection();
1942 // Emit PCs for function start and function size.
1943 if (const MDNode *MD = F.getMetadata(LLVMContext::MD_pcsections))
1944 EmitForMD(*MD, {getFunctionBegin(), getFunctionEnd()}, true);
1945 // Emit PCs for instructions collected.
1946 for (const auto &MS : PCSectionsSymbols)
1947 EmitForMD(*MS.first, MS.second, false);
1948 OutStreamer->popSection();
1949 PCSectionsSymbols.clear();
1950}
1951
1952/// Returns true if function begin and end labels should be emitted.
1953static bool needFuncLabels(const MachineFunction &MF, const AsmPrinter &Asm) {
1954 if (Asm.hasDebugInfo() || !MF.getLandingPads().empty() ||
1955 MF.hasEHFunclets() ||
1956 MF.getFunction().hasMetadata(LLVMContext::MD_pcsections))
1957 return true;
1958
1959 // We might emit an EH table that uses function begin and end labels even if
1960 // we don't have any landingpads.
1961 if (!MF.getFunction().hasPersonalityFn())
1962 return false;
1963 return !isNoOpWithoutInvoke(
1965}
1966
1967// Return the mnemonic of a MachineInstr if available, or the MachineInstr
1968// opcode name otherwise.
1970 const TargetInstrInfo *TII =
1971 MI.getParent()->getParent()->getSubtarget().getInstrInfo();
1972 MCInst MCI;
1973 MCI.setOpcode(MI.getOpcode());
1974 if (StringRef Name = Streamer.getMnemonic(MCI); !Name.empty())
1975 return Name;
1976 StringRef Name = TII->getName(MI.getOpcode());
1977 assert(!Name.empty() && "Missing mnemonic and name for opcode");
1978 return Name;
1979}
1980
1982 FunctionCallGraphInfo &FuncCGInfo,
1983 const MachineFunction::CallSiteInfoMap &CallSitesInfoMap,
1984 const MachineInstr &MI) {
1985 assert(MI.isCall() && "This method is meant for call instructions only.");
1986 const MachineOperand &CalleeOperand = MI.getOperand(0);
1987 if (CalleeOperand.isGlobal() || CalleeOperand.isSymbol()) {
1988 // Handle direct calls.
1989 MCSymbol *CalleeSymbol = nullptr;
1990 switch (CalleeOperand.getType()) {
1992 CalleeSymbol = getSymbol(CalleeOperand.getGlobal());
1993 break;
1995 CalleeSymbol = GetExternalSymbolSymbol(CalleeOperand.getSymbolName());
1996 break;
1997 default:
1999 "Expected to only handle direct call instructions here.");
2000 }
2001 FuncCGInfo.DirectCallees.insert(CalleeSymbol);
2002 return; // Early exit after handling the direct call instruction.
2003 }
2004 const auto &CallSiteInfo = CallSitesInfoMap.find(&MI);
2005 if (CallSiteInfo == CallSitesInfoMap.end())
2006 return;
2007 // Handle indirect callsite info.
2008 // Only indirect calls have type identifiers set.
2009 for (ConstantInt *CalleeTypeId : CallSiteInfo->second.CalleeTypeIds) {
2010 uint64_t CalleeTypeIdVal = CalleeTypeId->getZExtValue();
2011 FuncCGInfo.IndirectCalleeTypeIDs.insert(CalleeTypeIdVal);
2012 }
2013}
2014
2015/// Helper to emit a symbol for the prefetch target associated with the given
2016/// BBID and callsite index.
2018 unsigned CallsiteIndex) {
2019 SmallString<128> FunctionName;
2020 getNameWithPrefix(FunctionName, &MF->getFunction());
2021 MCSymbol *PrefetchTargetSymbol = OutContext.getOrCreateSymbol(
2022 getPrefetchTargetSymbolName(FunctionName, BBID, CallsiteIndex));
2023 // If the function is weak-linkage it may be replaced by a strong
2024 // version, in which case the prefetch targets should also be replaced.
2025 OutStreamer->emitSymbolAttribute(
2026 PrefetchTargetSymbol,
2027 MF->getFunction().isWeakForLinker() ? MCSA_Weak : MCSA_Global);
2028 OutStreamer->emitLabel(PrefetchTargetSymbol);
2029}
2030
2031/// Emit dangling prefetch targets that were not mapped to any basic block.
2033 const DenseMap<UniqueBBID, SmallVector<unsigned>> &MFPrefetchTargets =
2034 MF->getPrefetchTargets();
2035 if (MFPrefetchTargets.empty())
2036 return;
2037 DenseSet<UniqueBBID> MFBBIDs;
2038 for (const MachineBasicBlock &MBB : *MF)
2039 if (std::optional<UniqueBBID> BBID = MBB.getBBID())
2040 MFBBIDs.insert(*BBID);
2041
2042 for (const auto &[BBID, CallsiteIndexes] : MFPrefetchTargets) {
2043 if (MFBBIDs.contains(BBID))
2044 continue;
2045 for (unsigned CallsiteIndex : CallsiteIndexes)
2047 }
2048}
2049
2050/// EmitFunctionBody - This method emits the body and trailer for a
2051/// function.
2053 emitFunctionHeader();
2054
2055 // Emit target-specific gunk before the function body.
2057
2058 if (isVerbose()) {
2059 // Get MachineDominatorTree or compute it on the fly if it's unavailable
2060 MDT = GetMDT(*MF);
2061 if (!MDT) {
2062 OwnedMDT = std::make_unique<MachineDominatorTree>();
2063 OwnedMDT->recalculate(*MF);
2064 MDT = OwnedMDT.get();
2065 }
2066
2067 // Get MachineLoopInfo or compute it on the fly if it's unavailable
2068 MLI = GetMLI(*MF);
2069 if (!MLI) {
2070 OwnedMLI = std::make_unique<MachineLoopInfo>();
2071 OwnedMLI->analyze(*MDT);
2072 MLI = OwnedMLI.get();
2073 }
2074 }
2075
2076 // Print out code for the function.
2077 bool HasAnyRealCode = false;
2078 int NumInstsInFunction = 0;
2079 bool IsEHa = MMI->getModule()->getModuleFlag("eh-asynch");
2080
2081 const MCSubtargetInfo *STI = nullptr;
2082 if (this->MF)
2083 STI = &getSubtargetInfo();
2084 else
2085 STI = &TM.getMCSubtargetInfo();
2086
2087 bool CanDoExtraAnalysis = ORE->allowExtraAnalysis(DEBUG_TYPE);
2088 // Create a slot for the entry basic block section so that the section
2089 // order is preserved when iterating over MBBSectionRanges.
2090 if (!MF->empty())
2091 MBBSectionRanges[MF->front().getSectionID()] =
2093
2094 FunctionCallGraphInfo FuncCGInfo;
2095 const auto &CallSitesInfoMap = MF->getCallSitesInfo();
2096
2097 // Dangling targets are not mapped to any blocks and must be emitted at the
2098 // beginning of the function.
2100
2101 const auto &MFPrefetchTargets = MF->getPrefetchTargets();
2102 for (auto &MBB : *MF) {
2103 // Print a label for the basic block.
2105 DenseMap<StringRef, unsigned> MnemonicCounts;
2106
2107 const SmallVector<unsigned> *PrefetchTargets = nullptr;
2108 if (auto BBID = MBB.getBBID()) {
2109 auto R = MFPrefetchTargets.find(*BBID);
2110 if (R != MFPrefetchTargets.end())
2111 PrefetchTargets = &R->second;
2112 }
2113 auto PrefetchTargetIt =
2114 PrefetchTargets ? PrefetchTargets->begin() : nullptr;
2115 auto PrefetchTargetEnd = PrefetchTargets ? PrefetchTargets->end() : nullptr;
2116 unsigned LastCallsiteIndex = 0;
2117
2118 for (auto &MI : MBB) {
2119 if (PrefetchTargetIt != PrefetchTargetEnd &&
2120 *PrefetchTargetIt == LastCallsiteIndex) {
2121 emitPrefetchTargetSymbol(*MBB.getBBID(), *PrefetchTargetIt);
2122 ++PrefetchTargetIt;
2123 }
2124
2125 // Print the assembly for the instruction.
2126 if (!MI.isPosition() && !MI.isImplicitDef() && !MI.isKill() &&
2127 !MI.isDebugInstr()) {
2128 HasAnyRealCode = true;
2129 }
2130
2131 // If there is a pre-instruction symbol, emit a label for it here.
2132 if (MCSymbol *S = MI.getPreInstrSymbol())
2133 OutStreamer->emitLabel(S);
2134
2135 if (MDNode *MD = MI.getPCSections())
2136 emitPCSectionsLabel(*MF, *MD);
2137
2138 for (auto &Handler : Handlers)
2139 Handler->beginInstruction(&MI);
2140
2141 if (isVerbose())
2142 emitComments(MI, STI, OutStreamer->getCommentOS());
2143
2144#ifndef NDEBUG
2145 MCFragment *OldFragment = OutStreamer->getCurrentFragment();
2146 size_t OldFragSize = OldFragment->getFixedSize();
2147#endif
2148
2149 switch (MI.getOpcode()) {
2150 case TargetOpcode::CFI_INSTRUCTION:
2152 break;
2153 case TargetOpcode::LOCAL_ESCAPE:
2155 break;
2156 case TargetOpcode::ANNOTATION_LABEL:
2157 case TargetOpcode::GC_LABEL:
2158 OutStreamer->emitLabel(MI.getOperand(0).getMCSymbol());
2159 break;
2160 case TargetOpcode::EH_LABEL:
2161 OutStreamer->AddComment("EH_LABEL");
2162 OutStreamer->emitLabel(MI.getOperand(0).getMCSymbol());
2163 // For AsynchEH, insert a Nop if followed by a trap inst
2164 // Or the exception won't be caught.
2165 // (see MCConstantExpr::create(1,..) in WinException.cpp)
2166 // Ignore SDiv/UDiv because a DIV with Const-0 divisor
2167 // must have being turned into an UndefValue.
2168 // Div with variable opnds won't be the first instruction in
2169 // an EH region as it must be led by at least a Load
2170 {
2171 auto MI2 = std::next(MI.getIterator());
2172 if (IsEHa && MI2 != MBB.end() &&
2173 (MI2->mayLoadOrStore() || MI2->mayRaiseFPException()))
2174 emitNops(1);
2175 }
2176 break;
2177 case TargetOpcode::INLINEASM:
2178 case TargetOpcode::INLINEASM_BR:
2179 emitInlineAsm(&MI);
2180 break;
2181 case TargetOpcode::DBG_VALUE:
2182 case TargetOpcode::DBG_VALUE_LIST:
2183 if (isVerbose()) {
2184 if (!emitDebugValueComment(&MI, *this))
2186 }
2187 break;
2188 case TargetOpcode::DBG_INSTR_REF:
2189 // This instruction reference will have been resolved to a machine
2190 // location, and a nearby DBG_VALUE created. We can safely ignore
2191 // the instruction reference.
2192 break;
2193 case TargetOpcode::DBG_PHI:
2194 // This instruction is only used to label a program point, it's purely
2195 // meta information.
2196 break;
2197 case TargetOpcode::DBG_LABEL:
2198 if (isVerbose()) {
2199 if (!emitDebugLabelComment(&MI, *this))
2201 }
2202 break;
2203 case TargetOpcode::IMPLICIT_DEF:
2204 if (isVerbose()) emitImplicitDef(&MI);
2205 break;
2206 case TargetOpcode::KILL:
2207 if (isVerbose()) emitKill(&MI, *this);
2208 break;
2209 case TargetOpcode::FAKE_USE:
2210 if (isVerbose())
2211 emitFakeUse(&MI, *this);
2212 break;
2213 case TargetOpcode::PSEUDO_PROBE:
2215 break;
2216 case TargetOpcode::ARITH_FENCE:
2217 if (isVerbose())
2218 OutStreamer->emitRawComment("ARITH_FENCE");
2219 break;
2220 case TargetOpcode::MEMBARRIER:
2221 OutStreamer->emitRawComment("MEMBARRIER");
2222 break;
2223 case TargetOpcode::JUMP_TABLE_DEBUG_INFO:
2224 // This instruction is only used to note jump table debug info, it's
2225 // purely meta information.
2226 break;
2227 case TargetOpcode::INIT_UNDEF:
2228 // This is only used to influence register allocation behavior, no
2229 // actual initialization is needed.
2230 break;
2231 case TargetOpcode::RELOC_NONE: {
2232 // Generate a temporary label for the current PC.
2233 MCSymbol *Sym = OutContext.createTempSymbol("reloc_none");
2234 OutStreamer->emitLabel(Sym);
2235 const MCExpr *Dot = MCSymbolRefExpr::create(Sym, OutContext);
2237 OutContext.getOrCreateSymbol(MI.getOperand(0).getSymbolName()),
2238 OutContext);
2239 OutStreamer->emitRelocDirective(*Dot, "BFD_RELOC_NONE", Value, SMLoc());
2240 break;
2241 }
2242 default:
2244
2245 auto CountInstruction = [&](const MachineInstr &MI) {
2246 // Skip Meta instructions inside bundles.
2247 if (MI.isMetaInstruction())
2248 return;
2249 ++NumInstsInFunction;
2250 if (CanDoExtraAnalysis) {
2252 ++MnemonicCounts[Name];
2253 }
2254 };
2255 if (!MI.isBundle()) {
2256 CountInstruction(MI);
2257 break;
2258 }
2259 // Separately count all the instructions in a bundle.
2260 for (auto It = std::next(MI.getIterator());
2261 It != MBB.end() && It->isInsideBundle(); ++It) {
2262 CountInstruction(*It);
2263 }
2264 break;
2265 }
2266
2267#ifndef NDEBUG
2268 // Verify that the instruction size reported by InstrInfo matches the
2269 // actually emitted size. Many backends performing branch relaxation
2270 // on the MIR level rely on this for correctness.
2271 // TODO: We currently can't distinguish whether a parse error occurred
2272 // when handling INLINEASM.
2273 if (OutStreamer->isObj() && !OutContext.hadError() &&
2274 (MI.getOpcode() != TargetOpcode::INLINEASM &&
2275 MI.getOpcode() != TargetOpcode::INLINEASM_BR)) {
2276 const TargetInstrInfo *TII = MF->getSubtarget().getInstrInfo();
2278 TII->getInstSizeVerifyMode(MI);
2280 unsigned ExpectedSize = TII->getInstSizeInBytes(MI);
2281 MCFragment *NewFragment = OutStreamer->getCurrentFragment();
2282 unsigned ActualSize;
2283 if (OldFragment == NewFragment) {
2284 ActualSize = NewFragment->getFixedSize() - OldFragSize;
2285 } else {
2286 ActualSize = OldFragment->getFixedSize() - OldFragSize;
2287 const MCFragment *F = OldFragment->getNext();
2288 for (; F != NewFragment; F = F->getNext())
2289 ActualSize += F->getFixedSize();
2290 ActualSize += NewFragment->getFixedSize();
2291 }
2292 bool AllowOverEstimate =
2294 bool Valid = AllowOverEstimate ? ActualSize <= ExpectedSize
2295 : ActualSize == ExpectedSize;
2296 if (!Valid) {
2297 dbgs() << "In function: " << MF->getName() << "\n";
2298 dbgs() << "Size mismatch for: " << MI;
2299 if (MI.isBundled()) {
2300 dbgs() << "{\n";
2301 auto It = MI.getIterator(), End = MBB.instr_end();
2302 for (++It; It != End && It->isInsideBundle(); ++It)
2303 dbgs().indent(2) << *It;
2304 dbgs() << "}\n";
2305 }
2306 dbgs() << "Expected " << (AllowOverEstimate ? "maximum" : "exact")
2307 << " size: " << ExpectedSize << "\n";
2308 dbgs() << "Actual size: " << ActualSize << "\n";
2309 abort();
2310 }
2311 }
2312 }
2313#endif
2314
2315 if (MI.isCall()) {
2316 if (MF->getTarget().Options.BBAddrMap)
2318 LastCallsiteIndex++;
2319 }
2320
2321 if (TM.Options.EmitCallGraphSection && MI.isCall())
2322 handleCallsiteForCallgraph(FuncCGInfo, CallSitesInfoMap, MI);
2323
2324 // If there is a post-instruction symbol, emit a label for it here.
2325 if (MCSymbol *S = MI.getPostInstrSymbol()) {
2326 // Emit the weak symbol attribute used for the prefetch target fallback.
2327 if (TM.getTargetTriple().isOSBinFormatELF()) {
2328 MCSymbolELF *ESym = static_cast<MCSymbolELF *>(S);
2329 if (ESym->getBinding() == ELF::STB_WEAK)
2330 OutStreamer->emitSymbolAttribute(S, MCSA_Weak);
2331 }
2332 OutStreamer->emitLabel(S);
2333 }
2334
2335 for (auto &Handler : Handlers)
2336 Handler->endInstruction();
2337 }
2338 // Emit the remaining prefetch targets for this block. This includes
2339 // nonexisting callsite indexes.
2340 while (PrefetchTargetIt != PrefetchTargetEnd) {
2341 emitPrefetchTargetSymbol(*MBB.getBBID(), *PrefetchTargetIt);
2342 ++PrefetchTargetIt;
2343 }
2344
2345 // We must emit temporary symbol for the end of this basic block, if either
2346 // we have BBLabels enabled or if this basic blocks marks the end of a
2347 // section.
2348 if (MF->getTarget().Options.BBAddrMap ||
2349 (MAI.hasDotTypeDotSizeDirective() && MBB.isEndSection()))
2350 OutStreamer->emitLabel(MBB.getEndSymbol());
2351
2352 if (MBB.isEndSection()) {
2353 // The size directive for the section containing the entry block is
2354 // handled separately by the function section.
2355 if (!MBB.sameSection(&MF->front())) {
2356 if (MAI.hasDotTypeDotSizeDirective()) {
2357 // Emit the size directive for the basic block section.
2358 const MCExpr *SizeExp = MCBinaryExpr::createSub(
2359 MCSymbolRefExpr::create(MBB.getEndSymbol(), OutContext),
2360 MCSymbolRefExpr::create(CurrentSectionBeginSym, OutContext),
2361 OutContext);
2362 OutStreamer->emitELFSize(CurrentSectionBeginSym, SizeExp);
2363 }
2364 assert(!MBBSectionRanges.contains(MBB.getSectionID()) &&
2365 "Overwrite section range");
2366 MBBSectionRanges[MBB.getSectionID()] =
2367 MBBSectionRange{CurrentSectionBeginSym, MBB.getEndSymbol()};
2368 }
2369 }
2371
2372 if (CanDoExtraAnalysis) {
2373 // Skip empty blocks.
2374 if (MBB.empty())
2375 continue;
2376
2378 MBB.begin()->getDebugLoc(), &MBB);
2379
2380 // Generate instruction mix remark. First, sort counts in descending order
2381 // by count and name.
2383 for (auto &KV : MnemonicCounts)
2384 MnemonicVec.emplace_back(KV.first, KV.second);
2385
2386 sort(MnemonicVec, [](const std::pair<StringRef, unsigned> &A,
2387 const std::pair<StringRef, unsigned> &B) {
2388 if (A.second > B.second)
2389 return true;
2390 if (A.second == B.second)
2391 return StringRef(A.first) < StringRef(B.first);
2392 return false;
2393 });
2394 R << "BasicBlock: " << ore::NV("BasicBlock", MBB.getName()) << "\n";
2395 for (auto &KV : MnemonicVec) {
2396 auto Name = (Twine("INST_") + getToken(KV.first.trim()).first).str();
2397 R << KV.first << ": " << ore::NV(Name, KV.second) << "\n";
2398 }
2399 ORE->emit(R);
2400 }
2401 }
2402
2403 EmittedInsts += NumInstsInFunction;
2404 MachineOptimizationRemarkAnalysis R(DEBUG_TYPE, "InstructionCount",
2405 MF->getFunction().getSubprogram(),
2406 &MF->front());
2407 R << ore::NV("NumInstructions", NumInstsInFunction)
2408 << " instructions in function";
2409 ORE->emit(R);
2410
2411 // If the function is empty and the object file uses .subsections_via_symbols,
2412 // then we need to emit *something* to the function body to prevent the
2413 // labels from collapsing together. Just emit a noop.
2414 // Similarly, don't emit empty functions on Windows either. It can lead to
2415 // duplicate entries (two functions with the same RVA) in the Guard CF Table
2416 // after linking, causing the kernel not to load the binary:
2417 // https://developercommunity.visualstudio.com/content/problem/45366/vc-linker-creates-invalid-dll-with-clang-cl.html
2418 // FIXME: Hide this behind some API in e.g. MCAsmInfo or MCTargetStreamer.
2419 const Triple &TT = TM.getTargetTriple();
2420 if (!HasAnyRealCode && (MAI.hasSubsectionsViaSymbols() ||
2421 (TT.isOSWindows() && TT.isOSBinFormatCOFF()))) {
2422 MCInst Noop = MF->getSubtarget().getInstrInfo()->getNop();
2423
2424 // Targets can opt-out of emitting the noop here by leaving the opcode
2425 // unspecified.
2426 if (Noop.getOpcode()) {
2427 OutStreamer->AddComment("avoids zero-length function");
2428 emitNops(1);
2429 }
2430 }
2431
2432 // Switch to the original section in case basic block sections was used.
2433 OutStreamer->switchSection(MF->getSection());
2434
2435 const Function &F = MF->getFunction();
2436 for (const auto &BB : F) {
2437 if (!BB.hasAddressTaken())
2438 continue;
2439 MCSymbol *Sym = GetBlockAddressSymbol(&BB);
2440 if (Sym->isDefined())
2441 continue;
2442 OutStreamer->AddComment("Address of block that was removed by CodeGen");
2443 OutStreamer->emitLabel(Sym);
2444 }
2445
2446 // Emit target-specific gunk after the function body.
2448
2449 // Even though wasm supports .type and .size in general, function symbols
2450 // are automatically sized.
2451 bool EmitFunctionSize = MAI.hasDotTypeDotSizeDirective() && !TT.isWasm();
2452
2453 // SPIR-V supports label instructions only inside a block, not after the
2454 // function body.
2455 if (TT.getObjectFormat() != Triple::SPIRV &&
2456 (EmitFunctionSize || needFuncLabels(*MF, *this) || CurrentFnEnd)) {
2457 // Create a symbol for the end of function, if not already pre-created
2458 // (e.g. for .prefalign directive).
2459 if (!CurrentFnEnd)
2460 CurrentFnEnd = createTempSymbol("func_end");
2461 OutStreamer->emitLabel(CurrentFnEnd);
2462 }
2463
2464 // If the target wants a .size directive for the size of the function, emit
2465 // it.
2466 if (EmitFunctionSize) {
2467 // We can get the size as difference between the function label and the
2468 // temp label.
2469 const MCExpr *SizeExp = MCBinaryExpr::createSub(
2470 MCSymbolRefExpr::create(CurrentFnEnd, OutContext),
2472 OutStreamer->emitELFSize(CurrentFnSym, SizeExp);
2474 OutStreamer->emitELFSize(CurrentFnBeginLocal, SizeExp);
2475 }
2476
2477 // Call endBasicBlockSection on the last block now, if it wasn't already
2478 // called.
2479 if (!MF->back().isEndSection()) {
2480 for (auto &Handler : Handlers)
2481 Handler->endBasicBlockSection(MF->back());
2482 for (auto &Handler : EHHandlers)
2483 Handler->endBasicBlockSection(MF->back());
2484 }
2485 for (auto &Handler : Handlers)
2486 Handler->markFunctionEnd();
2487 for (auto &Handler : EHHandlers)
2488 Handler->markFunctionEnd();
2489 // Update the end label of the entry block's section.
2490 MBBSectionRanges[MF->front().getSectionID()].EndLabel = CurrentFnEnd;
2491
2492 // Print out jump tables referenced by the function.
2494
2495 // Emit post-function debug and/or EH information.
2496 for (auto &Handler : Handlers)
2497 Handler->endFunction(MF);
2498 for (auto &Handler : EHHandlers)
2499 Handler->endFunction(MF);
2500
2501 // Emit section containing BB address offsets and their metadata, when
2502 // BB labels are requested for this function. Skip empty functions.
2503 if (HasAnyRealCode) {
2504 if (MF->getTarget().Options.BBAddrMap)
2506 else if (PgoAnalysisMapFeatures.getBits() != 0)
2507 MF->getContext().reportWarning(
2508 SMLoc(), "pgo-analysis-map is enabled for function " + MF->getName() +
2509 " but it does not have labels");
2510 }
2511
2512 // Emit sections containing instruction and function PCs.
2514
2515 // Emit section containing stack size metadata.
2517
2518 // Emit section containing call graph metadata.
2519 emitCallGraphSection(*MF, FuncCGInfo);
2520
2521 // Emit .su file containing function stack size information.
2523
2525
2526 if (isVerbose())
2527 OutStreamer->getCommentOS() << "-- End function\n";
2528
2529 OutStreamer->addBlankLine();
2530}
2531
2532/// Compute the number of Global Variables that uses a Constant.
2533static unsigned getNumGlobalVariableUses(const Constant *C,
2534 bool &HasNonGlobalUsers) {
2535 if (!C) {
2536 HasNonGlobalUsers = true;
2537 return 0;
2538 }
2539
2541 return 1;
2542
2543 unsigned NumUses = 0;
2544 for (const auto *CU : C->users())
2545 NumUses +=
2546 getNumGlobalVariableUses(dyn_cast<Constant>(CU), HasNonGlobalUsers);
2547
2548 return NumUses;
2549}
2550
2551/// Only consider global GOT equivalents if at least one user is a
2552/// cstexpr inside an initializer of another global variables. Also, don't
2553/// handle cstexpr inside instructions. During global variable emission,
2554/// candidates are skipped and are emitted later in case at least one cstexpr
2555/// isn't replaced by a PC relative GOT entry access.
2557 unsigned &NumGOTEquivUsers,
2558 bool &HasNonGlobalUsers) {
2559 // Global GOT equivalents are unnamed private globals with a constant
2560 // pointer initializer to another global symbol. They must point to a
2561 // GlobalVariable or Function, i.e., as GlobalValue.
2562 if (!GV->hasGlobalUnnamedAddr() || !GV->hasInitializer() ||
2563 !GV->isConstant() || !GV->isDiscardableIfUnused() ||
2565 return false;
2566
2567 // To be a got equivalent, at least one of its users need to be a constant
2568 // expression used by another global variable.
2569 for (const auto *U : GV->users())
2570 NumGOTEquivUsers +=
2571 getNumGlobalVariableUses(dyn_cast<Constant>(U), HasNonGlobalUsers);
2572
2573 return NumGOTEquivUsers > 0;
2574}
2575
2576/// Unnamed constant global variables solely contaning a pointer to
2577/// another globals variable is equivalent to a GOT table entry; it contains the
2578/// the address of another symbol. Optimize it and replace accesses to these
2579/// "GOT equivalents" by using the GOT entry for the final global instead.
2580/// Compute GOT equivalent candidates among all global variables to avoid
2581/// emitting them if possible later on, after it use is replaced by a GOT entry
2582/// access.
2584 if (!getObjFileLowering().supportIndirectSymViaGOTPCRel())
2585 return;
2586
2587 for (const auto &G : M.globals()) {
2588 unsigned NumGOTEquivUsers = 0;
2589 bool HasNonGlobalUsers = false;
2590 if (!isGOTEquivalentCandidate(&G, NumGOTEquivUsers, HasNonGlobalUsers))
2591 continue;
2592 // If non-global variables use it, we still need to emit it.
2593 // Add 1 here, then emit it in `emitGlobalGOTEquivs`.
2594 if (HasNonGlobalUsers)
2595 NumGOTEquivUsers += 1;
2596 const MCSymbol *GOTEquivSym = getSymbol(&G);
2597 GlobalGOTEquivs[GOTEquivSym] = std::make_pair(&G, NumGOTEquivUsers);
2598 }
2599}
2600
2601/// Constant expressions using GOT equivalent globals may not be eligible
2602/// for PC relative GOT entry conversion, in such cases we need to emit such
2603/// globals we previously omitted in EmitGlobalVariable.
2605 if (!getObjFileLowering().supportIndirectSymViaGOTPCRel())
2606 return;
2607
2609 for (auto &I : GlobalGOTEquivs) {
2610 const GlobalVariable *GV = I.second.first;
2611 unsigned Cnt = I.second.second;
2612 if (Cnt)
2613 FailedCandidates.push_back(GV);
2614 }
2615 GlobalGOTEquivs.clear();
2616
2617 for (const auto *GV : FailedCandidates)
2619}
2620
2622 MCSymbol *Name = getSymbol(&GA);
2623 const GlobalObject *BaseObject = GA.getAliaseeObject();
2624
2625 bool IsFunction = GA.getValueType()->isFunctionTy();
2626 // Treat bitcasts of functions as functions also. This is important at least
2627 // on WebAssembly where object and function addresses can't alias each other.
2628 if (!IsFunction)
2629 IsFunction = isa_and_nonnull<Function>(BaseObject);
2630
2631 // AIX's assembly directive `.set` is not usable for aliasing purpose,
2632 // so AIX has to use the extra-label-at-definition strategy. At this
2633 // point, all the extra label is emitted, we just have to emit linkage for
2634 // those labels.
2635 if (TM.getTargetTriple().isOSBinFormatXCOFF()) {
2636 // Linkage for alias of global variable has been emitted.
2637 if (isa_and_nonnull<GlobalVariable>(BaseObject))
2638 return;
2639
2640 emitLinkage(&GA, Name);
2641 // If it's a function, also emit linkage for aliases of function entry
2642 // point.
2643 if (IsFunction)
2644 emitLinkage(&GA,
2645 getObjFileLowering().getFunctionEntryPointSymbol(&GA, TM));
2646 return;
2647 }
2648
2649 if (GA.hasExternalLinkage() || !MAI.getWeakRefDirective())
2650 OutStreamer->emitSymbolAttribute(Name, MCSA_Global);
2651 else if (GA.hasWeakLinkage() || GA.hasLinkOnceLinkage())
2652 OutStreamer->emitSymbolAttribute(Name, MCSA_WeakReference);
2653 else
2654 assert(GA.hasLocalLinkage() && "Invalid alias linkage");
2655
2656 // Set the symbol type to function if the alias has a function type.
2657 // This affects codegen when the aliasee is not a function.
2658 if (IsFunction) {
2659 OutStreamer->emitSymbolAttribute(Name, MCSA_ELF_TypeFunction);
2660 if (TM.getTargetTriple().isOSBinFormatCOFF()) {
2661 OutStreamer->beginCOFFSymbolDef(Name);
2662 OutStreamer->emitCOFFSymbolStorageClass(
2667 OutStreamer->endCOFFSymbolDef();
2668 }
2669 }
2670
2671 emitVisibility(Name, GA.getVisibility());
2672
2673 const MCExpr *Expr = lowerConstant(GA.getAliasee());
2674
2675 if (MAI.isMachO() && isa<MCBinaryExpr>(Expr))
2676 OutStreamer->emitSymbolAttribute(Name, MCSA_AltEntry);
2677
2678 // Emit the directives as assignments aka .set:
2679 OutStreamer->emitAssignment(Name, Expr);
2680 MCSymbol *LocalAlias = getSymbolPreferLocal(GA);
2681 if (LocalAlias != Name)
2682 OutStreamer->emitAssignment(LocalAlias, Expr);
2683
2684 // If the aliasee does not correspond to a symbol in the output, i.e. the
2685 // alias is not of an object or the aliased object is private, then set the
2686 // size of the alias symbol from the type of the alias. We don't do this in
2687 // other situations as the alias and aliasee having differing types but same
2688 // size may be intentional.
2689 if (MAI.hasDotTypeDotSizeDirective() && GA.getValueType()->isSized() &&
2690 (!BaseObject || BaseObject->hasPrivateLinkage())) {
2691 const DataLayout &DL = M.getDataLayout();
2692 uint64_t Size = DL.getTypeAllocSize(GA.getValueType());
2693 OutStreamer->emitELFSize(Name, MCConstantExpr::create(Size, OutContext));
2694 }
2695}
2696
2697void AsmPrinter::emitGlobalIFunc(Module &M, const GlobalIFunc &GI) {
2698 auto EmitLinkage = [&](MCSymbol *Sym) {
2700 OutStreamer->emitSymbolAttribute(Sym, MCSA_Global);
2701 else if (GI.hasWeakLinkage() || GI.hasLinkOnceLinkage())
2702 OutStreamer->emitSymbolAttribute(Sym, MCSA_WeakReference);
2703 else
2704 assert(GI.hasLocalLinkage() && "Invalid ifunc linkage");
2705 };
2706
2708 MCSymbol *Name = getSymbol(&GI);
2709 EmitLinkage(Name);
2710 OutStreamer->emitSymbolAttribute(Name, MCSA_ELF_TypeIndFunction);
2711 emitVisibility(Name, GI.getVisibility());
2712
2713 // Emit the directives as assignments aka .set:
2714 const MCExpr *Expr = lowerConstant(GI.getResolver());
2715 OutStreamer->emitAssignment(Name, Expr);
2716 MCSymbol *LocalAlias = getSymbolPreferLocal(GI);
2717 if (LocalAlias != Name)
2718 OutStreamer->emitAssignment(LocalAlias, Expr);
2719
2720 return;
2721 }
2722
2723 if (!TM.getTargetTriple().isOSBinFormatMachO() || !getIFuncMCSubtargetInfo())
2724 reportFatalUsageError("IFuncs are not supported on this platform");
2725
2726 // On Darwin platforms, emit a manually-constructed .symbol_resolver that
2727 // implements the symbol resolution duties of the IFunc.
2728 //
2729 // Normally, this would be handled by linker magic, but unfortunately there
2730 // are a few limitations in ld64 and ld-prime's implementation of
2731 // .symbol_resolver that mean we can't always use them:
2732 //
2733 // * resolvers cannot be the target of an alias
2734 // * resolvers cannot have private linkage
2735 // * resolvers cannot have linkonce linkage
2736 // * resolvers cannot appear in executables
2737 // * resolvers cannot appear in bundles
2738 //
2739 // This works around that by emitting a close approximation of what the
2740 // linker would have done.
2741
2742 MCSymbol *LazyPointer =
2743 GetExternalSymbolSymbol(GI.getName() + ".lazy_pointer");
2744 MCSymbol *StubHelper = GetExternalSymbolSymbol(GI.getName() + ".stub_helper");
2745
2746 OutStreamer->switchSection(OutContext.getObjectFileInfo()->getDataSection());
2747
2748 const DataLayout &DL = M.getDataLayout();
2749 emitAlignment(Align(DL.getPointerSize()));
2750 OutStreamer->emitLabel(LazyPointer);
2751 emitVisibility(LazyPointer, GI.getVisibility());
2752 OutStreamer->emitValue(MCSymbolRefExpr::create(StubHelper, OutContext), 8);
2753
2754 OutStreamer->switchSection(OutContext.getObjectFileInfo()->getTextSection());
2755
2756 const TargetSubtargetInfo *STI =
2757 TM.getSubtargetImpl(*GI.getResolverFunction());
2758 const TargetLowering *TLI = STI->getTargetLowering();
2759 Align TextAlign(TLI->getMinFunctionAlignment());
2760
2761 MCSymbol *Stub = getSymbol(&GI);
2762 EmitLinkage(Stub);
2763 OutStreamer->emitCodeAlignment(TextAlign, *getIFuncMCSubtargetInfo());
2764 OutStreamer->emitLabel(Stub);
2765 emitVisibility(Stub, GI.getVisibility());
2766 emitMachOIFuncStubBody(M, GI, LazyPointer);
2767
2768 OutStreamer->emitCodeAlignment(TextAlign, *getIFuncMCSubtargetInfo());
2769 OutStreamer->emitLabel(StubHelper);
2770 emitVisibility(StubHelper, GI.getVisibility());
2771 emitMachOIFuncStubHelperBody(M, GI, LazyPointer);
2772}
2773
2775 if (!RS.wantsSection())
2776 return;
2777 if (!RS.getFilename())
2778 return;
2779
2780 MCSection *RemarksSection =
2781 OutContext.getObjectFileInfo()->getRemarksSection();
2782 if (!RemarksSection && RS.needsSection()) {
2783 OutContext.reportWarning(SMLoc(), "Current object file format does not "
2784 "support remarks sections.");
2785 }
2786 if (!RemarksSection)
2787 return;
2788
2789 SmallString<128> Filename = *RS.getFilename();
2791 assert(!Filename.empty() && "The filename can't be empty.");
2792
2793 std::string Buf;
2794 raw_string_ostream OS(Buf);
2795
2796 remarks::RemarkSerializer &RemarkSerializer = RS.getSerializer();
2797 std::unique_ptr<remarks::MetaSerializer> MetaSerializer =
2798 RemarkSerializer.metaSerializer(OS, Filename);
2799 MetaSerializer->emit();
2800
2801 // Switch to the remarks section.
2802 OutStreamer->switchSection(RemarksSection);
2803 OutStreamer->emitBinaryData(Buf);
2804}
2805
2807 const Constant *Initializer = G.getInitializer();
2808 return G.getParent()->getDataLayout().getTypeAllocSize(
2809 Initializer->getType());
2810}
2811
2813 // We used to do this in clang, but there are optimization passes that turn
2814 // non-constant globals into constants. So now, clang only tells us whether
2815 // it would *like* a global to be tagged, but we still make the decision here.
2816 //
2817 // For now, don't instrument constant data, as it'll be in .rodata anyway. It
2818 // may be worth instrumenting these in future to stop them from being used as
2819 // gadgets.
2820 if (G.getName().starts_with("llvm.") || G.isThreadLocal() || G.isConstant())
2821 return false;
2822
2823 // Globals can be placed implicitly or explicitly in sections. There's two
2824 // different types of globals that meet this criteria that cause problems:
2825 // 1. Function pointers that are going into various init arrays (either
2826 // explicitly through `__attribute__((section(<foo>)))` or implicitly
2827 // through `__attribute__((constructor)))`, such as ".(pre)init(_array)",
2828 // ".fini(_array)", ".ctors", and ".dtors". These function pointers end up
2829 // overaligned and overpadded, making iterating over them problematic, and
2830 // each function pointer is individually tagged (so the iteration over
2831 // them causes SIGSEGV/MTE[AS]ERR).
2832 // 2. Global variables put into an explicit section, where the section's name
2833 // is a valid C-style identifier. The linker emits a `__start_<name>` and
2834 // `__stop_<name>` symbol for the section, so that you can iterate over
2835 // globals within this section. Unfortunately, again, these globals would
2836 // be tagged and so iteration causes SIGSEGV/MTE[AS]ERR.
2837 //
2838 // To mitigate both these cases, and because specifying a section is rare
2839 // outside of these two cases, disable MTE protection for globals in any
2840 // section.
2841 if (G.hasSection())
2842 return false;
2843
2844 return globalSize(G) > 0;
2845}
2846
2848 uint64_t SizeInBytes = globalSize(*G);
2849
2850 uint64_t NewSize = alignTo(SizeInBytes, 16);
2851 if (SizeInBytes != NewSize) {
2852 // Pad the initializer out to the next multiple of 16 bytes.
2853 llvm::SmallVector<uint8_t> Init(NewSize - SizeInBytes, 0);
2854 Constant *Padding = ConstantDataArray::get(M.getContext(), Init);
2855 Constant *Initializer = G->getInitializer();
2856 Initializer = ConstantStruct::getAnon({Initializer, Padding});
2857 auto *NewGV = new GlobalVariable(
2858 M, Initializer->getType(), G->isConstant(), G->getLinkage(),
2859 Initializer, "", G, G->getThreadLocalMode(), G->getAddressSpace());
2860 NewGV->copyAttributesFrom(G);
2861 NewGV->setComdat(G->getComdat());
2862 NewGV->copyMetadata(G, 0);
2863
2864 NewGV->takeName(G);
2865 G->replaceAllUsesWith(NewGV);
2866 G->eraseFromParent();
2867 G = NewGV;
2868 }
2869
2870 if (G->getAlign().valueOrOne() < 16)
2871 G->setAlignment(Align(16));
2872
2873 // Ensure that tagged globals don't get merged by ICF - as they should have
2874 // different tags at runtime.
2875 G->setUnnamedAddr(GlobalValue::UnnamedAddr::None);
2876}
2877
2879 auto Meta = G.getSanitizerMetadata();
2880 Meta.Memtag = false;
2881 G.setSanitizerMetadata(Meta);
2882}
2883
2885 // Set the MachineFunction to nullptr so that we can catch attempted
2886 // accesses to MF specific features at the module level and so that
2887 // we can conditionalize accesses based on whether or not it is nullptr.
2888 MF = nullptr;
2889 const Triple &Target = TM.getTargetTriple();
2890
2891 std::vector<GlobalVariable *> GlobalsToTag;
2892 for (GlobalVariable &G : M.globals()) {
2893 if (G.isDeclaration() || !G.isTagged())
2894 continue;
2895 if (!shouldTagGlobal(G)) {
2896 assert(G.hasSanitizerMetadata()); // because isTagged.
2898 assert(!G.isTagged());
2899 continue;
2900 }
2901 GlobalsToTag.push_back(&G);
2902 }
2903 for (GlobalVariable *G : GlobalsToTag)
2905
2906 // Gather all GOT equivalent globals in the module. We really need two
2907 // passes over the globals: one to compute and another to avoid its emission
2908 // in EmitGlobalVariable, otherwise we would not be able to handle cases
2909 // where the got equivalent shows up before its use.
2911
2912 // Emit global variables.
2913 for (const auto &G : M.globals())
2915
2916 // Emit remaining GOT equivalent globals.
2918
2920
2921 // Emit linkage(XCOFF) and visibility info for declarations
2922 for (const Function &F : M) {
2923 if (!F.isDeclarationForLinker())
2924 continue;
2925
2926 MCSymbol *Name = getSymbol(&F);
2927 // Function getSymbol gives us the function descriptor symbol for XCOFF.
2928
2929 if (!Target.isOSBinFormatXCOFF()) {
2930 GlobalValue::VisibilityTypes V = F.getVisibility();
2932 continue;
2933
2934 emitVisibility(Name, V, false);
2935 continue;
2936 }
2937
2938 if (F.isIntrinsic())
2939 continue;
2940
2941 // Handle the XCOFF case.
2942 // Variable `Name` is the function descriptor symbol (see above). Get the
2943 // function entry point symbol.
2944 MCSymbol *FnEntryPointSym = TLOF.getFunctionEntryPointSymbol(&F, TM);
2945 // Emit linkage for the function entry point.
2946 emitLinkage(&F, FnEntryPointSym);
2947
2948 // If a function's address is taken, which means it may be called via a
2949 // function pointer, we need the function descriptor for it.
2950 if (F.hasAddressTaken())
2951 emitLinkage(&F, Name);
2952 }
2953
2954 // Emit the remarks section contents.
2955 // FIXME: Figure out when is the safest time to emit this section. It should
2956 // not come after debug info.
2957 if (remarks::RemarkStreamer *RS = M.getContext().getMainRemarkStreamer())
2958 emitRemarksSection(*RS);
2959
2961
2962 if (Target.isOSBinFormatELF()) {
2963 MachineModuleInfoELF &MMIELF = MMI->getObjFileInfo<MachineModuleInfoELF>();
2964
2965 // Output stubs for external and common global variables.
2967 if (!Stubs.empty()) {
2968 OutStreamer->switchSection(TLOF.getDataSection());
2969 const DataLayout &DL = M.getDataLayout();
2970
2971 emitAlignment(Align(DL.getPointerSize()));
2972 for (const auto &Stub : Stubs) {
2973 OutStreamer->emitLabel(Stub.first);
2974 OutStreamer->emitSymbolValue(Stub.second.getPointer(),
2975 DL.getPointerSize());
2976 }
2977 }
2978 }
2979
2980 if (Target.isOSBinFormatCOFF()) {
2981 MachineModuleInfoCOFF &MMICOFF =
2982 MMI->getObjFileInfo<MachineModuleInfoCOFF>();
2983
2984 // Output stubs for external and common global variables.
2986 if (!Stubs.empty()) {
2987 const DataLayout &DL = M.getDataLayout();
2988
2989 for (const auto &Stub : Stubs) {
2991 SectionName += Stub.first->getName();
2992 OutStreamer->switchSection(OutContext.getCOFFSection(
2996 Stub.first->getName(), COFF::IMAGE_COMDAT_SELECT_ANY));
2997 emitAlignment(Align(DL.getPointerSize()));
2998 OutStreamer->emitSymbolAttribute(Stub.first, MCSA_Global);
2999 OutStreamer->emitLabel(Stub.first);
3000 OutStreamer->emitSymbolValue(Stub.second.getPointer(),
3001 DL.getPointerSize());
3002 }
3003 }
3004 }
3005
3006 // This needs to happen before emitting debug information since that can end
3007 // arbitrary sections.
3008 if (auto *TS = OutStreamer->getTargetStreamer())
3009 TS->emitConstantPools();
3010
3011 // Emit Stack maps before any debug info. Mach-O requires that no data or
3012 // text sections come after debug info has been emitted. This matters for
3013 // stack maps as they are arbitrary data, and may even have a custom format
3014 // through user plugins.
3015 EmitStackMaps(M);
3016
3017 // Print aliases in topological order, that is, for each alias a = b,
3018 // b must be printed before a.
3019 // This is because on some targets (e.g. PowerPC) linker expects aliases in
3020 // such an order to generate correct TOC information.
3023 for (const auto &Alias : M.aliases()) {
3024 if (Alias.hasAvailableExternallyLinkage())
3025 continue;
3026 for (const GlobalAlias *Cur = &Alias; Cur;
3027 Cur = dyn_cast<GlobalAlias>(Cur->getAliasee())) {
3028 if (!AliasVisited.insert(Cur).second)
3029 break;
3030 AliasStack.push_back(Cur);
3031 }
3032 for (const GlobalAlias *AncestorAlias : llvm::reverse(AliasStack))
3033 emitGlobalAlias(M, *AncestorAlias);
3034 AliasStack.clear();
3035 }
3036
3037 // IFuncs must come before deubginfo in case the backend decides to emit them
3038 // as actual functions, since on Mach-O targets, we cannot create regular
3039 // sections after DWARF.
3040 for (const auto &IFunc : M.ifuncs())
3041 emitGlobalIFunc(M, IFunc);
3042 if (TM.getTargetTriple().isOSBinFormatXCOFF() && hasDebugInfo()) {
3043 // Emit section end. This is used to tell the debug line section where the
3044 // end is for a text section if we don't use .loc to represent the debug
3045 // line.
3046 auto *Sec = OutContext.getObjectFileInfo()->getTextSection();
3047 OutStreamer->switchSectionNoPrint(Sec);
3048 MCSymbol *Sym = Sec->getEndSymbol(OutContext);
3049 OutStreamer->emitLabel(Sym);
3050 }
3051
3052 // Finalize debug and EH information.
3053 for (auto &Handler : Handlers)
3054 Handler->endModule();
3055 for (auto &Handler : EHHandlers)
3056 Handler->endModule();
3057
3058 // This deletes all the ephemeral handlers that AsmPrinter added, while
3059 // keeping all the user-added handlers alive until the AsmPrinter is
3060 // destroyed.
3061 EHHandlers.clear();
3062 Handlers.erase(Handlers.begin() + NumUserHandlers, Handlers.end());
3063 DD = nullptr;
3064
3065 // If the target wants to know about weak references, print them all.
3066 if (MAI.getWeakRefDirective()) {
3067 // FIXME: This is not lazy, it would be nice to only print weak references
3068 // to stuff that is actually used. Note that doing so would require targets
3069 // to notice uses in operands (due to constant exprs etc). This should
3070 // happen with the MC stuff eventually.
3071
3072 // Print out module-level global objects here.
3073 for (const auto &GO : M.global_objects()) {
3074 if (!GO.hasExternalWeakLinkage())
3075 continue;
3076 OutStreamer->emitSymbolAttribute(getSymbol(&GO), MCSA_WeakReference);
3077 }
3079 auto SymbolName = "swift_async_extendedFramePointerFlags";
3080 auto Global = M.getGlobalVariable(SymbolName);
3081 if (!Global) {
3082 auto PtrTy = PointerType::getUnqual(M.getContext());
3083 Global = new GlobalVariable(M, PtrTy, false,
3085 SymbolName);
3086 OutStreamer->emitSymbolAttribute(getSymbol(Global), MCSA_WeakReference);
3087 }
3088 }
3089 }
3090
3092
3093 // Emit llvm.ident metadata in an '.ident' directive.
3094 emitModuleIdents(M);
3095
3096 // Emit bytes for llvm.commandline metadata.
3097 // The command line metadata is emitted earlier on XCOFF.
3098 if (!Target.isOSBinFormatXCOFF())
3099 emitModuleCommandLines(M);
3100
3101 // Emit .note.GNU-split-stack and .note.GNU-no-split-stack sections if
3102 // split-stack is used.
3103 if (TM.getTargetTriple().isOSBinFormatELF() && HasSplitStack) {
3104 OutStreamer->switchSection(OutContext.getELFSection(".note.GNU-split-stack",
3105 ELF::SHT_PROGBITS, 0));
3106 if (HasNoSplitStack)
3107 OutStreamer->switchSection(OutContext.getELFSection(
3108 ".note.GNU-no-split-stack", ELF::SHT_PROGBITS, 0));
3109 }
3110
3111 // If we don't have any trampolines, then we don't require stack memory
3112 // to be executable. Some targets have a directive to declare this.
3113 Function *InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
3114 bool HasTrampolineUses =
3115 InitTrampolineIntrinsic && !InitTrampolineIntrinsic->use_empty();
3116 MCSection *S = MAI.getStackSection(OutContext, /*Exec=*/HasTrampolineUses);
3117 if (S)
3118 OutStreamer->switchSection(S);
3119
3120 if (TM.Options.EmitAddrsig) {
3121 // Emit address-significance attributes for all globals.
3122 OutStreamer->emitAddrsig();
3123 for (const GlobalValue &GV : M.global_values()) {
3124 if (!GV.use_empty() && !GV.isThreadLocal() &&
3125 !GV.hasDLLImportStorageClass() &&
3126 !GV.getName().starts_with("llvm.") &&
3127 !GV.hasAtLeastLocalUnnamedAddr())
3128 OutStreamer->emitAddrsigSym(getSymbol(&GV));
3129 }
3130 }
3131
3132 // Emit symbol partition specifications (ELF only).
3133 if (Target.isOSBinFormatELF()) {
3134 unsigned UniqueID = 0;
3135 for (const GlobalValue &GV : M.global_values()) {
3136 if (!GV.hasPartition() || GV.isDeclarationForLinker() ||
3137 GV.getVisibility() != GlobalValue::DefaultVisibility)
3138 continue;
3139
3140 OutStreamer->switchSection(
3141 OutContext.getELFSection(".llvm_sympart", ELF::SHT_LLVM_SYMPART, 0, 0,
3142 "", false, ++UniqueID, nullptr));
3143 OutStreamer->emitBytes(GV.getPartition());
3144 OutStreamer->emitZeros(1);
3145 OutStreamer->emitValue(
3147 MAI.getCodePointerSize());
3148 }
3149 }
3150
3151 // Allow the target to emit any magic that it wants at the end of the file,
3152 // after everything else has gone out.
3154
3155 MMI = nullptr;
3156 AddrLabelSymbols = nullptr;
3157
3158 OutStreamer->finish();
3159 OutStreamer->reset();
3160 OwnedMLI.reset();
3161 OwnedMDT.reset();
3162
3163 return false;
3164}
3165
3167 auto Res = MBBSectionExceptionSyms.try_emplace(MBB.getSectionID());
3168 if (Res.second)
3169 Res.first->second = createTempSymbol("exception");
3170 return Res.first->second;
3171}
3172
3174 MCContext &Ctx = MF->getContext();
3175 MCSymbol *Sym = Ctx.createTempSymbol("BB" + Twine(MF->getFunctionNumber()) +
3176 "_" + Twine(MBB.getNumber()) + "_CS");
3177 CurrentFnCallsiteEndSymbols[&MBB].push_back(Sym);
3178 return Sym;
3179}
3180
3182 this->MF = &MF;
3183 const Function &F = MF.getFunction();
3184
3185 // Record that there are split-stack functions, so we will emit a special
3186 // section to tell the linker.
3187 if (MF.shouldSplitStack()) {
3188 HasSplitStack = true;
3189
3190 if (!MF.getFrameInfo().needsSplitStackProlog())
3191 HasNoSplitStack = true;
3192 } else
3193 HasNoSplitStack = true;
3194
3195 // Get the function symbol.
3196 if (!MAI.isAIX()) {
3197 CurrentFnSym = getSymbol(&MF.getFunction());
3198 } else {
3199 assert(TM.getTargetTriple().isOSAIX() &&
3200 "Only AIX uses the function descriptor hooks.");
3201 // AIX is unique here in that the name of the symbol emitted for the
3202 // function body does not have the same name as the source function's
3203 // C-linkage name.
3204 assert(CurrentFnDescSym && "The function descriptor symbol needs to be"
3205 " initalized first.");
3206
3207 // Get the function entry point symbol.
3209 }
3210
3212 CurrentFnBegin = nullptr;
3213 CurrentFnBeginLocal = nullptr;
3214 CurrentFnEnd = nullptr;
3215 CurrentSectionBeginSym = nullptr;
3217 MBBSectionRanges.clear();
3218 MBBSectionExceptionSyms.clear();
3219 bool NeedsLocalForSize = MAI.needsLocalForSize();
3220 if (F.hasFnAttribute("patchable-function-entry") ||
3221 F.hasFnAttribute("function-instrument") ||
3222 F.hasFnAttribute("xray-instruction-threshold") ||
3223 needFuncLabels(MF, *this) || NeedsLocalForSize ||
3224 MF.getTarget().Options.EmitStackSizeSection ||
3225 MF.getTarget().Options.EmitCallGraphSection ||
3226 MF.getTarget().Options.BBAddrMap) {
3227 CurrentFnBegin = createTempSymbol("func_begin");
3228 if (NeedsLocalForSize)
3230 }
3231
3232 ORE = GetORE(MF);
3233}
3234
3235namespace {
3236
3237// Keep track the alignment, constpool entries per Section.
3238 struct SectionCPs {
3239 MCSection *S;
3240 Align Alignment;
3242
3243 SectionCPs(MCSection *s, Align a) : S(s), Alignment(a) {}
3244 };
3245
3246} // end anonymous namespace
3247
3249 if (TM.Options.EnableStaticDataPartitioning && C && SDPI && PSI)
3250 return SDPI->getConstantSectionPrefix(C, PSI);
3251
3252 return "";
3253}
3254
3255/// EmitConstantPool - Print to the current output stream assembly
3256/// representations of the constants in the constant pool MCP. This is
3257/// used to print out constants which have been "spilled to memory" by
3258/// the code generator.
3260 const MachineConstantPool *MCP = MF->getConstantPool();
3261 const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
3262 if (CP.empty()) return;
3263
3264 // Calculate sections for constant pool entries. We collect entries to go into
3265 // the same section together to reduce amount of section switch statements.
3266 SmallVector<SectionCPs, 4> CPSections;
3267 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
3268 const MachineConstantPoolEntry &CPE = CP[i];
3269 Align Alignment = CPE.getAlign();
3270
3272
3273 const Constant *C = nullptr;
3274 if (!CPE.isMachineConstantPoolEntry())
3275 C = CPE.Val.ConstVal;
3276
3278 getDataLayout(), Kind, C, Alignment, &MF->getFunction(),
3280
3281 // The number of sections are small, just do a linear search from the
3282 // last section to the first.
3283 bool Found = false;
3284 unsigned SecIdx = CPSections.size();
3285 while (SecIdx != 0) {
3286 if (CPSections[--SecIdx].S == S) {
3287 Found = true;
3288 break;
3289 }
3290 }
3291 if (!Found) {
3292 SecIdx = CPSections.size();
3293 CPSections.push_back(SectionCPs(S, Alignment));
3294 }
3295
3296 if (Alignment > CPSections[SecIdx].Alignment)
3297 CPSections[SecIdx].Alignment = Alignment;
3298 CPSections[SecIdx].CPEs.push_back(i);
3299 }
3300
3301 // Now print stuff into the calculated sections.
3302 const MCSection *CurSection = nullptr;
3303 unsigned Offset = 0;
3304 for (const SectionCPs &CPSection : CPSections) {
3305 for (unsigned CPI : CPSection.CPEs) {
3306 MCSymbol *Sym = GetCPISymbol(CPI);
3307 if (!Sym->isUndefined())
3308 continue;
3309
3310 if (CurSection != CPSection.S) {
3311 OutStreamer->switchSection(CPSection.S);
3312 emitAlignment(Align(CPSection.Alignment));
3313 CurSection = CPSection.S;
3314 Offset = 0;
3315 }
3316
3317 MachineConstantPoolEntry CPE = CP[CPI];
3318
3319 // Emit inter-object padding for alignment.
3320 unsigned NewOffset = alignTo(Offset, CPE.getAlign());
3321 OutStreamer->emitZeros(NewOffset - Offset);
3322
3323 Offset = NewOffset + CPE.getSizeInBytes(getDataLayout());
3324
3325 OutStreamer->emitLabel(Sym);
3328 else
3330 }
3331 }
3332}
3333
3334// Print assembly representations of the jump tables used by the current
3335// function.
3337 const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
3338 if (!MJTI) return;
3339
3340 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
3341 if (JT.empty()) return;
3342
3343 if (!TM.Options.EnableStaticDataPartitioning) {
3344 emitJumpTableImpl(*MJTI, llvm::to_vector(llvm::seq<unsigned>(JT.size())));
3345 return;
3346 }
3347
3348 SmallVector<unsigned> HotJumpTableIndices, ColdJumpTableIndices;
3349 // When static data partitioning is enabled, collect jump table entries that
3350 // go into the same section together to reduce the amount of section switch
3351 // statements.
3352 for (unsigned JTI = 0, JTSize = JT.size(); JTI < JTSize; ++JTI) {
3353 if (JT[JTI].Hotness == MachineFunctionDataHotness::Cold) {
3354 ColdJumpTableIndices.push_back(JTI);
3355 } else {
3356 HotJumpTableIndices.push_back(JTI);
3357 }
3358 }
3359
3360 emitJumpTableImpl(*MJTI, HotJumpTableIndices);
3361 emitJumpTableImpl(*MJTI, ColdJumpTableIndices);
3362}
3363
3364void AsmPrinter::emitJumpTableImpl(const MachineJumpTableInfo &MJTI,
3365 ArrayRef<unsigned> JumpTableIndices) {
3367 JumpTableIndices.empty())
3368 return;
3369
3371 const Function &F = MF->getFunction();
3372 const std::vector<MachineJumpTableEntry> &JT = MJTI.getJumpTables();
3373 MCSection *JumpTableSection = nullptr;
3374
3375 const bool UseLabelDifference =
3378 // Pick the directive to use to print the jump table entries, and switch to
3379 // the appropriate section.
3380 const bool JTInDiffSection =
3381 !TLOF.shouldPutJumpTableInFunctionSection(UseLabelDifference, F);
3382 if (JTInDiffSection) {
3384 JumpTableSection =
3385 TLOF.getSectionForJumpTable(F, TM, &JT[JumpTableIndices.front()]);
3386 } else {
3387 JumpTableSection = TLOF.getSectionForJumpTable(F, TM);
3388 }
3389 OutStreamer->switchSection(JumpTableSection);
3390 }
3391
3392 const DataLayout &DL = MF->getDataLayout();
3394
3395 // Jump tables in code sections are marked with a data_region directive
3396 // where that's supported.
3397 if (!JTInDiffSection)
3398 OutStreamer->emitDataRegion(MCDR_DataRegionJT32);
3399
3400 for (const unsigned JumpTableIndex : JumpTableIndices) {
3401 ArrayRef<MachineBasicBlock *> JTBBs = JT[JumpTableIndex].MBBs;
3402
3403 // If this jump table was deleted, ignore it.
3404 if (JTBBs.empty())
3405 continue;
3406
3407 // For the EK_LabelDifference32 entry, if using .set avoids a relocation,
3408 /// emit a .set directive for each unique entry.
3410 MAI.doesSetDirectiveSuppressReloc()) {
3411 SmallPtrSet<const MachineBasicBlock *, 16> EmittedSets;
3412 const TargetLowering *TLI = MF->getSubtarget().getTargetLowering();
3413 const MCExpr *Base =
3414 TLI->getPICJumpTableRelocBaseExpr(MF, JumpTableIndex, OutContext);
3415 for (const MachineBasicBlock *MBB : JTBBs) {
3416 if (!EmittedSets.insert(MBB).second)
3417 continue;
3418
3419 // .set LJTSet, LBB32-base
3420 const MCExpr *LHS =
3422 OutStreamer->emitAssignment(
3423 GetJTSetSymbol(JumpTableIndex, MBB->getNumber()),
3425 }
3426 }
3427
3428 // On some targets (e.g. Darwin) we want to emit two consecutive labels
3429 // before each jump table. The first label is never referenced, but tells
3430 // the assembler and linker the extents of the jump table object. The
3431 // second label is actually referenced by the code.
3432 if (JTInDiffSection && DL.hasLinkerPrivateGlobalPrefix())
3433 // FIXME: This doesn't have to have any specific name, just any randomly
3434 // named and numbered local label started with 'l' would work. Simplify
3435 // GetJTISymbol.
3436 OutStreamer->emitLabel(GetJTISymbol(JumpTableIndex, true));
3437
3438 MCSymbol *JTISymbol = GetJTISymbol(JumpTableIndex);
3439 OutStreamer->emitLabel(JTISymbol);
3440
3441 // Defer MCAssembler based constant folding due to a performance issue. The
3442 // label differences will be evaluated at write time.
3443 for (const MachineBasicBlock *MBB : JTBBs)
3444 emitJumpTableEntry(MJTI, MBB, JumpTableIndex);
3445 }
3446
3448 emitJumpTableSizesSection(MJTI, MF->getFunction());
3449
3450 if (!JTInDiffSection)
3451 OutStreamer->emitDataRegion(MCDR_DataRegionEnd);
3452}
3453
3454void AsmPrinter::emitJumpTableSizesSection(const MachineJumpTableInfo &MJTI,
3455 const Function &F) const {
3456 const std::vector<MachineJumpTableEntry> &JT = MJTI.getJumpTables();
3457
3458 if (JT.empty())
3459 return;
3460
3461 StringRef GroupName = F.hasComdat() ? F.getComdat()->getName() : "";
3462 MCSection *JumpTableSizesSection = nullptr;
3463 StringRef sectionName = ".llvm_jump_table_sizes";
3464
3465 bool isElf = TM.getTargetTriple().isOSBinFormatELF();
3466 bool isCoff = TM.getTargetTriple().isOSBinFormatCOFF();
3467
3468 if (!isCoff && !isElf)
3469 return;
3470
3471 if (isElf) {
3472 auto *LinkedToSym = static_cast<MCSymbolELF *>(CurrentFnSym);
3473 int Flags = F.hasComdat() ? static_cast<int>(ELF::SHF_GROUP) : 0;
3474
3475 JumpTableSizesSection = OutContext.getELFSection(
3476 sectionName, ELF::SHT_LLVM_JT_SIZES, Flags, 0, GroupName, F.hasComdat(),
3477 MCSection::NonUniqueID, LinkedToSym);
3478 } else if (isCoff) {
3479 if (F.hasComdat()) {
3480 JumpTableSizesSection = OutContext.getCOFFSection(
3481 sectionName,
3484 F.getComdat()->getName(), COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE);
3485 } else {
3486 JumpTableSizesSection = OutContext.getCOFFSection(
3490 }
3491 }
3492
3493 OutStreamer->switchSection(JumpTableSizesSection);
3494
3495 for (unsigned JTI = 0, E = JT.size(); JTI != E; ++JTI) {
3496 const std::vector<MachineBasicBlock *> &JTBBs = JT[JTI].MBBs;
3497 OutStreamer->emitSymbolValue(GetJTISymbol(JTI), TM.getProgramPointerSize());
3498 OutStreamer->emitIntValue(JTBBs.size(), TM.getProgramPointerSize());
3499 }
3500}
3501
3502/// EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the
3503/// current stream.
3505 const MachineBasicBlock *MBB,
3506 unsigned UID) const {
3507 assert(MBB && MBB->getNumber() >= 0 && "Invalid basic block");
3508 const MCExpr *Value = nullptr;
3509 switch (MJTI.getEntryKind()) {
3511 llvm_unreachable("Cannot emit EK_Inline jump table entry");
3514 llvm_unreachable("MIPS specific");
3516 Value = MF->getSubtarget().getTargetLowering()->LowerCustomJumpTableEntry(
3517 &MJTI, MBB, UID, OutContext);
3518 break;
3520 // EK_BlockAddress - Each entry is a plain address of block, e.g.:
3521 // .word LBB123
3523 break;
3524
3527 // Each entry is the address of the block minus the address of the jump
3528 // table. This is used for PIC jump tables where gprel32 is not supported.
3529 // e.g.:
3530 // .word LBB123 - LJTI1_2
3531 // If the .set directive avoids relocations, this is emitted as:
3532 // .set L4_5_set_123, LBB123 - LJTI1_2
3533 // .word L4_5_set_123
3535 MAI.doesSetDirectiveSuppressReloc()) {
3536 Value = MCSymbolRefExpr::create(GetJTSetSymbol(UID, MBB->getNumber()),
3537 OutContext);
3538 break;
3539 }
3541 const TargetLowering *TLI = MF->getSubtarget().getTargetLowering();
3544 break;
3545 }
3546 }
3547
3548 assert(Value && "Unknown entry kind!");
3549
3550 unsigned EntrySize = MJTI.getEntrySize(getDataLayout());
3551 OutStreamer->emitValue(Value, EntrySize);
3552}
3553
3554/// EmitSpecialLLVMGlobal - Check to see if the specified global is a
3555/// special global used by LLVM. If so, emit it and return true, otherwise
3556/// do nothing and return false.
3558 if (GV->getName() == "llvm.used") {
3559 if (MAI.hasNoDeadStrip()) // No need to emit this at all.
3560 emitLLVMUsedList(cast<ConstantArray>(GV->getInitializer()));
3561 return true;
3562 }
3563
3564 // Ignore debug and non-emitted data. This handles llvm.compiler.used.
3565 if (GV->getSection() == "llvm.metadata" ||
3567 return true;
3568
3569 if (GV->getName() == "llvm.arm64ec.symbolmap") {
3570 // For ARM64EC, print the table that maps between symbols and the
3571 // corresponding thunks to translate between x64 and AArch64 code.
3572 // This table is generated by AArch64Arm64ECCallLowering.
3573 OutStreamer->switchSection(
3574 OutContext.getCOFFSection(".hybmp$x", COFF::IMAGE_SCN_LNK_INFO));
3575 auto *Arr = cast<ConstantArray>(GV->getInitializer());
3576 for (auto &U : Arr->operands()) {
3577 auto *C = cast<Constant>(U);
3578 auto *Src = cast<GlobalValue>(C->getOperand(0)->stripPointerCasts());
3579 auto *Dst = cast<GlobalValue>(C->getOperand(1)->stripPointerCasts());
3580 int Kind = cast<ConstantInt>(C->getOperand(2))->getZExtValue();
3581
3582 if (Src->hasDLLImportStorageClass()) {
3583 // For now, we assume dllimport functions aren't directly called.
3584 // (We might change this later to match MSVC.)
3585 OutStreamer->emitCOFFSymbolIndex(
3586 OutContext.getOrCreateSymbol("__imp_" + Src->getName()));
3587 OutStreamer->emitCOFFSymbolIndex(getSymbol(Dst));
3588 OutStreamer->emitInt32(Kind);
3589 } else {
3590 // FIXME: For non-dllimport functions, MSVC emits the same entry
3591 // twice, for reasons I don't understand. I have to assume the linker
3592 // ignores the redundant entry; there aren't any reasonable semantics
3593 // to attach to it.
3594 OutStreamer->emitCOFFSymbolIndex(getSymbol(Src));
3595 OutStreamer->emitCOFFSymbolIndex(getSymbol(Dst));
3596 OutStreamer->emitInt32(Kind);
3597 }
3598 }
3599 return true;
3600 }
3601
3602 if (!GV->hasAppendingLinkage()) return false;
3603
3604 assert(GV->hasInitializer() && "Not a special LLVM global!");
3605
3606 if (GV->getName() == "llvm.global_ctors") {
3608 /* isCtor */ true);
3609
3610 return true;
3611 }
3612
3613 if (GV->getName() == "llvm.global_dtors") {
3615 /* isCtor */ false);
3616
3617 return true;
3618 }
3619
3620 GV->getContext().emitError(
3621 "unknown special variable with appending linkage: " +
3622 GV->getNameOrAsOperand());
3623 return true;
3624}
3625
3626/// EmitLLVMUsedList - For targets that define a MAI::UsedDirective, mark each
3627/// global in the specified llvm.used list.
3628void AsmPrinter::emitLLVMUsedList(const ConstantArray *InitList) {
3629 // Should be an array of 'i8*'.
3630 for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
3631 const GlobalValue *GV =
3633 if (GV)
3634 OutStreamer->emitSymbolAttribute(getSymbol(GV), MCSA_NoDeadStrip);
3635 }
3636}
3637
3639 const Constant *List,
3640 SmallVector<Structor, 8> &Structors) {
3641 // Should be an array of '{ i32, void ()*, i8* }' structs. The first value is
3642 // the init priority.
3644 return;
3645
3646 // Gather the structors in a form that's convenient for sorting by priority.
3647 for (Value *O : cast<ConstantArray>(List)->operands()) {
3648 auto *CS = cast<ConstantStruct>(O);
3649 if (CS->getOperand(1)->isNullValue())
3650 break; // Found a null terminator, skip the rest.
3651 ConstantInt *Priority = dyn_cast<ConstantInt>(CS->getOperand(0));
3652 if (!Priority)
3653 continue; // Malformed.
3654 Structors.push_back(Structor());
3655 Structor &S = Structors.back();
3656 S.Priority = Priority->getLimitedValue(65535);
3657 S.Func = CS->getOperand(1);
3658 if (!CS->getOperand(2)->isNullValue()) {
3659 if (TM.getTargetTriple().isOSAIX()) {
3660 CS->getContext().emitError(
3661 "associated data of XXStructor list is not yet supported on AIX");
3662 }
3663
3664 S.ComdatKey =
3665 dyn_cast<GlobalValue>(CS->getOperand(2)->stripPointerCasts());
3666 }
3667 }
3668
3669 // Emit the function pointers in the target-specific order
3670 llvm::stable_sort(Structors, [](const Structor &L, const Structor &R) {
3671 return L.Priority < R.Priority;
3672 });
3673}
3674
3675/// EmitXXStructorList - Emit the ctor or dtor list taking into account the init
3676/// priority.
3678 bool IsCtor) {
3679 SmallVector<Structor, 8> Structors;
3680 preprocessXXStructorList(DL, List, Structors);
3681 if (Structors.empty())
3682 return;
3683
3684 // Emit the structors in reverse order if we are using the .ctor/.dtor
3685 // initialization scheme.
3686 if (!TM.Options.UseInitArray)
3687 std::reverse(Structors.begin(), Structors.end());
3688
3689 const Align Align = DL.getPointerPrefAlignment(DL.getProgramAddressSpace());
3690 for (Structor &S : Structors) {
3692 const MCSymbol *KeySym = nullptr;
3693 if (GlobalValue *GV = S.ComdatKey) {
3694 if (GV->isDeclarationForLinker())
3695 // If the associated variable is not defined in this module
3696 // (it might be available_externally, or have been an
3697 // available_externally definition that was dropped by the
3698 // EliminateAvailableExternally pass), some other TU
3699 // will provide its dynamic initializer.
3700 continue;
3701
3702 KeySym = getSymbol(GV);
3703 }
3704
3705 MCSection *OutputSection =
3706 (IsCtor ? Obj.getStaticCtorSection(S.Priority, KeySym)
3707 : Obj.getStaticDtorSection(S.Priority, KeySym));
3708 OutStreamer->switchSection(OutputSection);
3709 if (OutStreamer->getCurrentSection() != OutStreamer->getPreviousSection())
3711 emitXXStructor(DL, S.Func);
3712 }
3713}
3714
3715void AsmPrinter::emitModuleIdents(Module &M) {
3716 if (!MAI.hasIdentDirective())
3717 return;
3718
3719 if (const NamedMDNode *NMD = M.getNamedMetadata("llvm.ident")) {
3720 for (const MDNode *N : NMD->operands()) {
3721 assert(N->getNumOperands() == 1 &&
3722 "llvm.ident metadata entry can have only one operand");
3723 const MDString *S = cast<MDString>(N->getOperand(0));
3724 OutStreamer->emitIdent(S->getString());
3725 }
3726 }
3727}
3728
3729void AsmPrinter::emitModuleCommandLines(Module &M) {
3730 MCSection *CommandLine = getObjFileLowering().getSectionForCommandLines();
3731 if (!CommandLine)
3732 return;
3733
3734 const NamedMDNode *NMD = M.getNamedMetadata("llvm.commandline");
3735 if (!NMD || !NMD->getNumOperands())
3736 return;
3737
3738 OutStreamer->pushSection();
3739 OutStreamer->switchSection(CommandLine);
3740 OutStreamer->emitZeros(1);
3741 for (const MDNode *N : NMD->operands()) {
3742 assert(N->getNumOperands() == 1 &&
3743 "llvm.commandline metadata entry can have only one operand");
3744 const MDString *S = cast<MDString>(N->getOperand(0));
3745 OutStreamer->emitBytes(S->getString());
3746 OutStreamer->emitZeros(1);
3747 }
3748 OutStreamer->popSection();
3749}
3750
3751//===--------------------------------------------------------------------===//
3752// Emission and print routines
3753//
3754
3755/// Emit a byte directive and value.
3756///
3757void AsmPrinter::emitInt8(int Value) const { OutStreamer->emitInt8(Value); }
3758
3759/// Emit a short directive and value.
3760void AsmPrinter::emitInt16(int Value) const { OutStreamer->emitInt16(Value); }
3761
3762/// Emit a long directive and value.
3763void AsmPrinter::emitInt32(int Value) const { OutStreamer->emitInt32(Value); }
3764
3765/// EmitSLEB128 - emit the specified signed leb128 value.
3766void AsmPrinter::emitSLEB128(int64_t Value, const char *Desc) const {
3767 if (isVerbose() && Desc)
3768 OutStreamer->AddComment(Desc);
3769
3770 OutStreamer->emitSLEB128IntValue(Value);
3771}
3772
3774 unsigned PadTo) const {
3775 if (isVerbose() && Desc)
3776 OutStreamer->AddComment(Desc);
3777
3778 OutStreamer->emitULEB128IntValue(Value, PadTo);
3779}
3780
3781/// Emit a long long directive and value.
3783 OutStreamer->emitInt64(Value);
3784}
3785
3786/// Emit something like ".long Hi-Lo" where the size in bytes of the directive
3787/// is specified by Size and Hi/Lo specify the labels. This implicitly uses
3788/// .set if it avoids relocations.
3790 unsigned Size) const {
3791 OutStreamer->emitAbsoluteSymbolDiff(Hi, Lo, Size);
3792}
3793
3794/// Emit something like ".uleb128 Hi-Lo".
3796 const MCSymbol *Lo) const {
3797 OutStreamer->emitAbsoluteSymbolDiffAsULEB128(Hi, Lo);
3798}
3799
3800/// EmitLabelPlusOffset - Emit something like ".long Label+Offset"
3801/// where the size in bytes of the directive is specified by Size and Label
3802/// specifies the label. This implicitly uses .set if it is available.
3804 unsigned Size,
3805 bool IsSectionRelative) const {
3806 if (MAI.needsDwarfSectionOffsetDirective() && IsSectionRelative) {
3807 OutStreamer->emitCOFFSecRel32(Label, Offset);
3808 if (Size > 4)
3809 OutStreamer->emitZeros(Size - 4);
3810 return;
3811 }
3812
3813 // Emit Label+Offset (or just Label if Offset is zero)
3814 const MCExpr *Expr = MCSymbolRefExpr::create(Label, OutContext);
3815 if (Offset)
3818
3819 OutStreamer->emitValue(Expr, Size);
3820}
3821
3822//===----------------------------------------------------------------------===//
3823
3824// EmitAlignment - Emit an alignment directive to the specified power of
3825// two boundary. If a global value is specified, and if that global has
3826// an explicit alignment requested, it will override the alignment request
3827// if required for correctness.
3829 unsigned MaxBytesToEmit) const {
3830 if (GV)
3831 Alignment = getGVAlignment(GV, GV->getDataLayout(), Alignment);
3832
3833 if (Alignment == Align(1))
3834 return Alignment; // 1-byte aligned: no need to emit alignment.
3835
3836 if (getCurrentSection()->isText()) {
3837 const MCSubtargetInfo *STI = nullptr;
3838 if (this->MF)
3839 STI = &getSubtargetInfo();
3840 else
3841 STI = &TM.getMCSubtargetInfo();
3842 OutStreamer->emitCodeAlignment(Alignment, *STI, MaxBytesToEmit);
3843 } else
3844 OutStreamer->emitValueToAlignment(Alignment, 0, 1, MaxBytesToEmit);
3845 return Alignment;
3846}
3847
3848//===----------------------------------------------------------------------===//
3849// Constant emission.
3850//===----------------------------------------------------------------------===//
3851
3853 const Constant *BaseCV,
3854 uint64_t Offset) {
3855 MCContext &Ctx = OutContext;
3856
3857 if (CV->isNullValue() || isa<UndefValue>(CV))
3858 return MCConstantExpr::create(0, Ctx);
3859
3860 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV))
3861 return MCConstantExpr::create(CI->getZExtValue(), Ctx);
3862
3863 if (const ConstantByte *CB = dyn_cast<ConstantByte>(CV))
3864 return MCConstantExpr::create(CB->getZExtValue(), Ctx);
3865
3866 if (const ConstantPtrAuth *CPA = dyn_cast<ConstantPtrAuth>(CV))
3867 return lowerConstantPtrAuth(*CPA);
3868
3869 if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
3870 return MCSymbolRefExpr::create(getSymbol(GV), Ctx);
3871
3872 if (const BlockAddress *BA = dyn_cast<BlockAddress>(CV))
3873 return lowerBlockAddressConstant(*BA);
3874
3875 if (const auto *Equiv = dyn_cast<DSOLocalEquivalent>(CV))
3877 getSymbol(Equiv->getGlobalValue()), nullptr, 0, std::nullopt, TM);
3878
3879 if (const NoCFIValue *NC = dyn_cast<NoCFIValue>(CV))
3880 return MCSymbolRefExpr::create(getSymbol(NC->getGlobalValue()), Ctx);
3881
3882 const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV);
3883 if (!CE) {
3884 llvm_unreachable("Unknown constant value to lower!");
3885 }
3886
3887 // The constant expression opcodes are limited to those that are necessary
3888 // to represent relocations on supported targets. Expressions involving only
3889 // constant addresses are constant folded instead.
3890 switch (CE->getOpcode()) {
3891 default:
3892 break; // Error
3893 case Instruction::AddrSpaceCast: {
3894 const Constant *Op = CE->getOperand(0);
3895 unsigned DstAS = CE->getType()->getPointerAddressSpace();
3896 unsigned SrcAS = Op->getType()->getPointerAddressSpace();
3897 if (TM.isNoopAddrSpaceCast(SrcAS, DstAS))
3898 return lowerConstant(Op);
3899
3900 break; // Error
3901 }
3902 case Instruction::GetElementPtr: {
3903 // Generate a symbolic expression for the byte address
3904 APInt OffsetAI(getDataLayout().getPointerTypeSizeInBits(CE->getType()), 0);
3905 cast<GEPOperator>(CE)->accumulateConstantOffset(getDataLayout(), OffsetAI);
3906
3907 const MCExpr *Base = lowerConstant(CE->getOperand(0));
3908 if (!OffsetAI)
3909 return Base;
3910
3911 int64_t Offset = OffsetAI.getSExtValue();
3913 Ctx);
3914 }
3915
3916 case Instruction::Trunc:
3917 // We emit the value and depend on the assembler to truncate the generated
3918 // expression properly. This is important for differences between
3919 // blockaddress labels. Since the two labels are in the same function, it
3920 // is reasonable to treat their delta as a 32-bit value.
3921 [[fallthrough]];
3922 case Instruction::BitCast:
3923 return lowerConstant(CE->getOperand(0), BaseCV, Offset);
3924
3925 case Instruction::IntToPtr: {
3926 const DataLayout &DL = getDataLayout();
3927
3928 // Handle casts to pointers by changing them into casts to the appropriate
3929 // integer type. This promotes constant folding and simplifies this code.
3930 Constant *Op = CE->getOperand(0);
3931 Op = ConstantFoldIntegerCast(Op, DL.getIntPtrType(CV->getType()),
3932 /*IsSigned*/ false, DL);
3933 if (Op)
3934 return lowerConstant(Op);
3935
3936 break; // Error
3937 }
3938
3939 case Instruction::PtrToAddr:
3940 case Instruction::PtrToInt: {
3941 const DataLayout &DL = getDataLayout();
3942
3943 // Support only foldable casts to/from pointers that can be eliminated by
3944 // changing the pointer to the appropriately sized integer type.
3945 Constant *Op = CE->getOperand(0);
3946 Type *Ty = CE->getType();
3947
3948 const MCExpr *OpExpr = lowerConstant(Op);
3949
3950 // We can emit the pointer value into this slot if the slot is an
3951 // integer slot equal to the size of the pointer.
3952 //
3953 // If the pointer is larger than the resultant integer, then
3954 // as with Trunc just depend on the assembler to truncate it.
3955 if (DL.getTypeAllocSize(Ty).getFixedValue() <=
3956 DL.getTypeAllocSize(Op->getType()).getFixedValue())
3957 return OpExpr;
3958
3959 break; // Error
3960 }
3961
3962 case Instruction::Sub: {
3963 GlobalValue *LHSGV, *RHSGV;
3964 APInt LHSOffset, RHSOffset;
3965 DSOLocalEquivalent *DSOEquiv;
3966 if (IsConstantOffsetFromGlobal(CE->getOperand(0), LHSGV, LHSOffset,
3967 getDataLayout(), &DSOEquiv) &&
3968 IsConstantOffsetFromGlobal(CE->getOperand(1), RHSGV, RHSOffset,
3969 getDataLayout())) {
3970 auto *LHSSym = getSymbol(LHSGV);
3971 auto *RHSSym = getSymbol(RHSGV);
3972 int64_t Addend = (LHSOffset - RHSOffset).getSExtValue();
3973 std::optional<int64_t> PCRelativeOffset;
3974 if (getObjFileLowering().hasPLTPCRelative() && RHSGV == BaseCV)
3975 PCRelativeOffset = Offset;
3976
3977 // Try the generic symbol difference first.
3979 LHSGV, RHSGV, Addend, PCRelativeOffset, TM);
3980
3981 // (ELF-specific) If the generic symbol difference does not apply, and
3982 // LHS is a dso_local_equivalent of a function, reference the PLT entry
3983 // instead. Note: A default visibility symbol is by default preemptible
3984 // during linking, and should not be referenced with PC-relative
3985 // relocations. Therefore, use a PLT relocation even if the function is
3986 // dso_local.
3987 if (DSOEquiv && TM.getTargetTriple().isOSBinFormatELF())
3989 LHSSym, RHSSym, Addend, PCRelativeOffset, TM);
3990
3991 // Otherwise, return LHS-RHS+Addend.
3992 if (!Res) {
3993 Res =
3995 MCSymbolRefExpr::create(RHSSym, Ctx), Ctx);
3996 if (Addend != 0)
3998 Res, MCConstantExpr::create(Addend, Ctx), Ctx);
3999 }
4000 return Res;
4001 }
4002
4003 const MCExpr *LHS = lowerConstant(CE->getOperand(0));
4004 const MCExpr *RHS = lowerConstant(CE->getOperand(1));
4005 return MCBinaryExpr::createSub(LHS, RHS, Ctx);
4006 break;
4007 }
4008
4009 case Instruction::Add: {
4010 const MCExpr *LHS = lowerConstant(CE->getOperand(0));
4011 const MCExpr *RHS = lowerConstant(CE->getOperand(1));
4012 return MCBinaryExpr::createAdd(LHS, RHS, Ctx);
4013 }
4014 }
4015
4016 // If the code isn't optimized, there may be outstanding folding
4017 // opportunities. Attempt to fold the expression using DataLayout as a
4018 // last resort before giving up.
4020 if (C != CE)
4021 return lowerConstant(C);
4022
4023 // Otherwise report the problem to the user.
4024 std::string S;
4025 raw_string_ostream OS(S);
4026 OS << "unsupported expression in static initializer: ";
4027 CE->printAsOperand(OS, /*PrintType=*/false,
4028 !MF ? nullptr : MF->getFunction().getParent());
4029 CE->getContext().emitError(S);
4030 return MCConstantExpr::create(0, Ctx);
4031}
4032
4033static void emitGlobalConstantImpl(const DataLayout &DL, const Constant *C,
4034 AsmPrinter &AP,
4035 const Constant *BaseCV = nullptr,
4036 uint64_t Offset = 0,
4037 AsmPrinter::AliasMapTy *AliasList = nullptr);
4038
4039static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP);
4040static void emitGlobalConstantFP(APFloat APF, Type *ET, AsmPrinter &AP);
4041
4042/// isRepeatedByteSequence - Determine whether the given value is
4043/// composed of a repeated sequence of identical bytes and return the
4044/// byte value. If it is not a repeated sequence, return -1.
4046 StringRef Data = V->getRawDataValues();
4047 assert(!Data.empty() && "Empty aggregates should be CAZ node");
4048 char C = Data[0];
4049 for (unsigned i = 1, e = Data.size(); i != e; ++i)
4050 if (Data[i] != C) return -1;
4051 return static_cast<uint8_t>(C); // Ensure 255 is not returned as -1.
4052}
4053
4054/// isRepeatedByteSequence - Determine whether the given value is
4055/// composed of a repeated sequence of identical bytes and return the
4056/// byte value. If it is not a repeated sequence, return -1.
4057static int isRepeatedByteSequence(const Value *V, const DataLayout &DL) {
4058 if (const ConstantInt *CI = dyn_cast<ConstantInt>(V)) {
4059 uint64_t Size = DL.getTypeAllocSizeInBits(V->getType());
4060 assert(Size % 8 == 0);
4061
4062 // Extend the element to take zero padding into account.
4063 APInt Value = CI->getValue().zext(Size);
4064 if (!Value.isSplat(8))
4065 return -1;
4066
4067 return Value.zextOrTrunc(8).getZExtValue();
4068 }
4069 if (const ConstantArray *CA = dyn_cast<ConstantArray>(V)) {
4070 // Make sure all array elements are sequences of the same repeated
4071 // byte.
4072 assert(CA->getNumOperands() != 0 && "Should be a CAZ");
4073 Constant *Op0 = CA->getOperand(0);
4074 int Byte = isRepeatedByteSequence(Op0, DL);
4075 if (Byte == -1)
4076 return -1;
4077
4078 // All array elements must be equal.
4079 for (unsigned i = 1, e = CA->getNumOperands(); i != e; ++i)
4080 if (CA->getOperand(i) != Op0)
4081 return -1;
4082 return Byte;
4083 }
4084
4086 return isRepeatedByteSequence(CDS);
4087
4088 return -1;
4089}
4090
4092 AsmPrinter::AliasMapTy *AliasList) {
4093 if (AliasList) {
4094 auto AliasIt = AliasList->find(Offset);
4095 if (AliasIt != AliasList->end()) {
4096 for (const GlobalAlias *GA : AliasIt->second)
4097 AP.OutStreamer->emitLabel(AP.getSymbol(GA));
4098 AliasList->erase(Offset);
4099 }
4100 }
4101}
4102
4104 const DataLayout &DL, const ConstantDataSequential *CDS, AsmPrinter &AP,
4105 AsmPrinter::AliasMapTy *AliasList) {
4106 // See if we can aggregate this into a .fill, if so, emit it as such.
4107 int Value = isRepeatedByteSequence(CDS, DL);
4108 if (Value != -1) {
4109 uint64_t Bytes = DL.getTypeAllocSize(CDS->getType());
4110 // Don't emit a 1-byte object as a .fill.
4111 if (Bytes > 1)
4112 return AP.OutStreamer->emitFill(Bytes, Value);
4113 }
4114
4115 // If this can be emitted with .ascii/.asciz, emit it as such.
4116 if (CDS->isString())
4117 return AP.OutStreamer->emitBytes(CDS->getAsString());
4118
4119 // Otherwise, emit the values in successive locations.
4120 uint64_t ElementByteSize = CDS->getElementByteSize();
4121 if (isa<IntegerType>(CDS->getElementType()) ||
4122 isa<ByteType>(CDS->getElementType())) {
4123 for (uint64_t I = 0, E = CDS->getNumElements(); I != E; ++I) {
4124 emitGlobalAliasInline(AP, ElementByteSize * I, AliasList);
4125 if (AP.isVerbose())
4126 AP.OutStreamer->getCommentOS()
4127 << format("0x%" PRIx64 "\n", CDS->getElementAsInteger(I));
4128 AP.OutStreamer->emitIntValue(CDS->getElementAsInteger(I),
4129 ElementByteSize);
4130 }
4131 } else {
4132 Type *ET = CDS->getElementType();
4133 for (uint64_t I = 0, E = CDS->getNumElements(); I != E; ++I) {
4134 emitGlobalAliasInline(AP, ElementByteSize * I, AliasList);
4136 }
4137 }
4138
4139 unsigned Size = DL.getTypeAllocSize(CDS->getType());
4140 unsigned EmittedSize =
4141 DL.getTypeAllocSize(CDS->getElementType()) * CDS->getNumElements();
4142 assert(EmittedSize <= Size && "Size cannot be less than EmittedSize!");
4143 if (unsigned Padding = Size - EmittedSize)
4144 AP.OutStreamer->emitZeros(Padding);
4145}
4146
4148 const ConstantArray *CA, AsmPrinter &AP,
4149 const Constant *BaseCV, uint64_t Offset,
4150 AsmPrinter::AliasMapTy *AliasList) {
4151 // See if we can aggregate some values. Make sure it can be
4152 // represented as a series of bytes of the constant value.
4153 int Value = isRepeatedByteSequence(CA, DL);
4154
4155 if (Value != -1) {
4156 uint64_t Bytes = DL.getTypeAllocSize(CA->getType());
4157 AP.OutStreamer->emitFill(Bytes, Value);
4158 } else {
4159 for (unsigned I = 0, E = CA->getNumOperands(); I != E; ++I) {
4160 emitGlobalConstantImpl(DL, CA->getOperand(I), AP, BaseCV, Offset,
4161 AliasList);
4162 Offset += DL.getTypeAllocSize(CA->getOperand(I)->getType());
4163 }
4164 }
4165}
4166
4167static void emitGlobalConstantLargeInt(const ConstantInt *CI, AsmPrinter &AP);
4168
4169static void emitGlobalConstantVector(const DataLayout &DL, const Constant *CV,
4170 AsmPrinter &AP,
4171 AsmPrinter::AliasMapTy *AliasList) {
4172 uint64_t AllocSize = DL.getTypeAllocSize(CV->getType());
4173
4174 if (CV->isNullValue())
4175 return AP.OutStreamer->emitZeros(AllocSize);
4176
4177 auto *VTy = cast<FixedVectorType>(CV->getType());
4178 Type *ElementType = VTy->getElementType();
4179 uint64_t ElementSizeInBits = DL.getTypeSizeInBits(ElementType);
4180 uint64_t ElementAllocSizeInBits = DL.getTypeAllocSizeInBits(ElementType);
4181 uint64_t EmittedSize;
4182 if (ElementSizeInBits != ElementAllocSizeInBits) {
4183 // If the allocation size of an element is different from the size in bits,
4184 // printing each element separately will insert incorrect padding.
4185 //
4186 // The general algorithm here is complicated; instead of writing it out
4187 // here, just use the existing code in ConstantFolding.
4188 Type *IntT =
4189 IntegerType::get(CV->getContext(), DL.getTypeSizeInBits(CV->getType()));
4191 ConstantExpr::getBitCast(const_cast<Constant *>(CV), IntT), DL));
4192 if (!CI) {
4194 "Cannot lower vector global with unusual element type");
4195 }
4196 emitGlobalAliasInline(AP, 0, AliasList);
4198 EmittedSize = DL.getTypeStoreSize(CV->getType());
4199 } else {
4200 for (unsigned I = 0, E = VTy->getNumElements(); I != E; ++I) {
4201 emitGlobalAliasInline(AP, AllocSize * I, AliasList);
4203 }
4204 EmittedSize = DL.getTypeAllocSize(ElementType) * VTy->getNumElements();
4205 }
4206
4207 if (unsigned Padding = AllocSize - EmittedSize)
4208 AP.OutStreamer->emitZeros(Padding);
4209}
4210
4212 const ConstantStruct *CS, AsmPrinter &AP,
4213 const Constant *BaseCV, uint64_t Offset,
4214 AsmPrinter::AliasMapTy *AliasList) {
4215 // Print the fields in successive locations. Pad to align if needed!
4216 uint64_t Size = DL.getTypeAllocSize(CS->getType());
4217 const StructLayout *Layout = DL.getStructLayout(CS->getType());
4218 uint64_t SizeSoFar = 0;
4219 for (unsigned I = 0, E = CS->getNumOperands(); I != E; ++I) {
4220 const Constant *Field = CS->getOperand(I);
4221
4222 // Print the actual field value.
4223 emitGlobalConstantImpl(DL, Field, AP, BaseCV, Offset + SizeSoFar,
4224 AliasList);
4225
4226 // Check if padding is needed and insert one or more 0s.
4227 uint64_t FieldSize = DL.getTypeAllocSize(Field->getType());
4228 uint64_t PadSize = ((I == E - 1 ? Size : Layout->getElementOffset(I + 1)) -
4229 Layout->getElementOffset(I)) -
4230 FieldSize;
4231 SizeSoFar += FieldSize + PadSize;
4232
4233 // Insert padding - this may include padding to increase the size of the
4234 // current field up to the ABI size (if the struct is not packed) as well
4235 // as padding to ensure that the next field starts at the right offset.
4236 AP.OutStreamer->emitZeros(PadSize);
4237 }
4238 assert(SizeSoFar == Layout->getSizeInBytes() &&
4239 "Layout of constant struct may be incorrect!");
4240}
4241
4242static void emitGlobalConstantFP(APFloat APF, Type *ET, AsmPrinter &AP) {
4243 assert(ET && "Unknown float type");
4244 APInt API = APF.bitcastToAPInt();
4245
4246 // First print a comment with what we think the original floating-point value
4247 // should have been.
4248 if (AP.isVerbose()) {
4249 SmallString<8> StrVal;
4250 APF.toString(StrVal);
4251 ET->print(AP.OutStreamer->getCommentOS());
4252 AP.OutStreamer->getCommentOS() << ' ' << StrVal << '\n';
4253 }
4254
4255 // Now iterate through the APInt chunks, emitting them in endian-correct
4256 // order, possibly with a smaller chunk at beginning/end (e.g. for x87 80-bit
4257 // floats).
4258 unsigned NumBytes = API.getBitWidth() / 8;
4259 unsigned TrailingBytes = NumBytes % sizeof(uint64_t);
4260 const uint64_t *p = API.getRawData();
4261
4262 // PPC's long double has odd notions of endianness compared to how LLVM
4263 // handles it: p[0] goes first for *big* endian on PPC.
4264 if (AP.getDataLayout().isBigEndian() && !ET->isPPC_FP128Ty()) {
4265 int Chunk = API.getNumWords() - 1;
4266
4267 if (TrailingBytes)
4268 AP.OutStreamer->emitIntValueInHexWithPadding(p[Chunk--], TrailingBytes);
4269
4270 for (; Chunk >= 0; --Chunk)
4271 AP.OutStreamer->emitIntValueInHexWithPadding(p[Chunk], sizeof(uint64_t));
4272 } else {
4273 unsigned Chunk;
4274 for (Chunk = 0; Chunk < NumBytes / sizeof(uint64_t); ++Chunk)
4275 AP.OutStreamer->emitIntValueInHexWithPadding(p[Chunk], sizeof(uint64_t));
4276
4277 if (TrailingBytes)
4278 AP.OutStreamer->emitIntValueInHexWithPadding(p[Chunk], TrailingBytes);
4279 }
4280
4281 // Emit the tail padding for the long double.
4282 const DataLayout &DL = AP.getDataLayout();
4283 AP.OutStreamer->emitZeros(DL.getTypeAllocSize(ET) - DL.getTypeStoreSize(ET));
4284}
4285
4286static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP) {
4287 emitGlobalConstantFP(CFP->getValueAPF(), CFP->getType(), AP);
4288}
4289
4291 uint64_t TypeStoreSize,
4292 AsmPrinter &AP) {
4293 const DataLayout &DL = AP.getDataLayout();
4294 unsigned BitWidth = Val.getBitWidth();
4295
4296 // Copy the value as we may massage the layout for constants whose bit width
4297 // is not a multiple of 64-bits.
4298 APInt Realigned(Val);
4299 uint64_t ExtraBits = 0;
4300 unsigned ExtraBitsSize = BitWidth & 63;
4301
4302 if (ExtraBitsSize) {
4303 // The bit width of the data is not a multiple of 64-bits.
4304 // The extra bits are expected to be at the end of the chunk of the memory.
4305 // Little endian:
4306 // * Nothing to be done, just record the extra bits to emit.
4307 // Big endian:
4308 // * Record the extra bits to emit.
4309 // * Realign the raw data to emit the chunks of 64-bits.
4310 if (DL.isBigEndian()) {
4311 // Basically the structure of the raw data is a chunk of 64-bits cells:
4312 // 0 1 BitWidth / 64
4313 // [chunk1][chunk2] ... [chunkN].
4314 // The most significant chunk is chunkN and it should be emitted first.
4315 // However, due to the alignment issue chunkN contains useless bits.
4316 // Realign the chunks so that they contain only useful information:
4317 // ExtraBits 0 1 (BitWidth / 64) - 1
4318 // chu[nk1 chu][nk2 chu] ... [nkN-1 chunkN]
4319 ExtraBitsSize = alignTo(ExtraBitsSize, 8);
4320 ExtraBits =
4321 Realigned.getRawData()[0] & (((uint64_t)-1) >> (64 - ExtraBitsSize));
4322 if (BitWidth >= 64)
4323 Realigned.lshrInPlace(ExtraBitsSize);
4324 } else
4325 ExtraBits = Realigned.getRawData()[BitWidth / 64];
4326 }
4327
4328 // We don't expect assemblers to support data directives
4329 // for more than 64 bits, so we emit the data in at most 64-bit
4330 // quantities at a time.
4331 const uint64_t *RawData = Realigned.getRawData();
4332 for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
4333 uint64_t ChunkVal = DL.isBigEndian() ? RawData[e - i - 1] : RawData[i];
4334 AP.OutStreamer->emitIntValue(ChunkVal, 8);
4335 }
4336
4337 if (ExtraBitsSize) {
4338 // Emit the extra bits after the 64-bits chunks.
4339
4340 // Emit a directive that fills the expected size.
4341 uint64_t Size = TypeStoreSize - (BitWidth / 64) * 8;
4342 assert(Size && Size * 8 >= ExtraBitsSize &&
4343 (ExtraBits & (((uint64_t)-1) >> (64 - ExtraBitsSize))) ==
4344 ExtraBits &&
4345 "Directive too small for extra bits.");
4346 AP.OutStreamer->emitIntValue(ExtraBits, Size);
4347 }
4348}
4349
4351 AsmPrinter &AP) {
4353 CB->getValue(), AP.getDataLayout().getTypeStoreSize(CB->getType()), AP);
4354}
4355
4360
4361/// Transform a not absolute MCExpr containing a reference to a GOT
4362/// equivalent global, by a target specific GOT pc relative access to the
4363/// final symbol.
4365 const Constant *BaseCst,
4366 uint64_t Offset) {
4367 // The global @foo below illustrates a global that uses a got equivalent.
4368 //
4369 // @bar = global i32 42
4370 // @gotequiv = private unnamed_addr constant i32* @bar
4371 // @foo = i32 trunc (i64 sub (i64 ptrtoint (i32** @gotequiv to i64),
4372 // i64 ptrtoint (i32* @foo to i64))
4373 // to i32)
4374 //
4375 // The cstexpr in @foo is converted into the MCExpr `ME`, where we actually
4376 // check whether @foo is suitable to use a GOTPCREL. `ME` is usually in the
4377 // form:
4378 //
4379 // foo = cstexpr, where
4380 // cstexpr := <gotequiv> - "." + <cst>
4381 // cstexpr := <gotequiv> - (<foo> - <offset from @foo base>) + <cst>
4382 //
4383 // After canonicalization by evaluateAsRelocatable `ME` turns into:
4384 //
4385 // cstexpr := <gotequiv> - <foo> + gotpcrelcst, where
4386 // gotpcrelcst := <offset from @foo base> + <cst>
4387 MCValue MV;
4388 if (!(*ME)->evaluateAsRelocatable(MV, nullptr) || MV.isAbsolute())
4389 return;
4390 const MCSymbol *GOTEquivSym = MV.getAddSym();
4391 if (!GOTEquivSym)
4392 return;
4393
4394 // Check that GOT equivalent symbol is cached.
4395 if (!AP.GlobalGOTEquivs.count(GOTEquivSym))
4396 return;
4397
4398 const GlobalValue *BaseGV = dyn_cast_or_null<GlobalValue>(BaseCst);
4399 if (!BaseGV)
4400 return;
4401
4402 // Check for a valid base symbol
4403 const MCSymbol *BaseSym = AP.getSymbol(BaseGV);
4404 const MCSymbol *SymB = MV.getSubSym();
4405
4406 if (!SymB || BaseSym != SymB)
4407 return;
4408
4409 // Make sure to match:
4410 //
4411 // gotpcrelcst := <offset from @foo base> + <cst>
4412 //
4413 int64_t GOTPCRelCst = Offset + MV.getConstant();
4414 if (!AP.getObjFileLowering().supportGOTPCRelWithOffset() && GOTPCRelCst != 0)
4415 return;
4416
4417 // Emit the GOT PC relative to replace the got equivalent global, i.e.:
4418 //
4419 // bar:
4420 // .long 42
4421 // gotequiv:
4422 // .quad bar
4423 // foo:
4424 // .long gotequiv - "." + <cst>
4425 //
4426 // is replaced by the target specific equivalent to:
4427 //
4428 // bar:
4429 // .long 42
4430 // foo:
4431 // .long bar@GOTPCREL+<gotpcrelcst>
4432 AsmPrinter::GOTEquivUsePair Result = AP.GlobalGOTEquivs[GOTEquivSym];
4433 const GlobalVariable *GV = Result.first;
4434 int NumUses = (int)Result.second;
4435 const GlobalValue *FinalGV = dyn_cast<GlobalValue>(GV->getOperand(0));
4436 const MCSymbol *FinalSym = AP.getSymbol(FinalGV);
4438 FinalGV, FinalSym, MV, Offset, AP.MMI, *AP.OutStreamer);
4439
4440 // Update GOT equivalent usage information
4441 --NumUses;
4442 if (NumUses >= 0)
4443 AP.GlobalGOTEquivs[GOTEquivSym] = std::make_pair(GV, NumUses);
4444}
4445
4446static void emitGlobalConstantImpl(const DataLayout &DL, const Constant *CV,
4447 AsmPrinter &AP, const Constant *BaseCV,
4449 AsmPrinter::AliasMapTy *AliasList) {
4450 assert((!AliasList || AP.TM.getTargetTriple().isOSBinFormatXCOFF()) &&
4451 "AliasList only expected for XCOFF");
4452 emitGlobalAliasInline(AP, Offset, AliasList);
4453 uint64_t Size = DL.getTypeAllocSize(CV->getType());
4454
4455 // Globals with sub-elements such as combinations of arrays and structs
4456 // are handled recursively by emitGlobalConstantImpl. Keep track of the
4457 // constant symbol base and the current position with BaseCV and Offset.
4458 if (!BaseCV && CV->hasOneUse())
4459 BaseCV = dyn_cast<Constant>(CV->user_back());
4460
4462 StructType *structType;
4463 if (AliasList && (structType = llvm::dyn_cast<StructType>(CV->getType()))) {
4464 unsigned numElements = {structType->getNumElements()};
4465 if (numElements != 0) {
4466 // Handle cases of aliases to direct struct elements
4467 const StructLayout *Layout = DL.getStructLayout(structType);
4468 uint64_t SizeSoFar = 0;
4469 for (unsigned int i = 0; i < numElements - 1; ++i) {
4470 uint64_t GapToNext = Layout->getElementOffset(i + 1) - SizeSoFar;
4471 AP.OutStreamer->emitZeros(GapToNext);
4472 SizeSoFar += GapToNext;
4473 emitGlobalAliasInline(AP, Offset + SizeSoFar, AliasList);
4474 }
4475 AP.OutStreamer->emitZeros(Size - SizeSoFar);
4476 return;
4477 }
4478 }
4479 return AP.OutStreamer->emitZeros(Size);
4480 }
4481
4482 if (isa<UndefValue>(CV))
4483 return AP.OutStreamer->emitZeros(Size);
4484
4485 if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
4486 if (isa<VectorType>(CV->getType()))
4487 return emitGlobalConstantVector(DL, CV, AP, AliasList);
4488
4489 const uint64_t StoreSize = DL.getTypeStoreSize(CV->getType());
4490 if (StoreSize <= 8) {
4491 if (AP.isVerbose())
4492 AP.OutStreamer->getCommentOS()
4493 << format("0x%" PRIx64 "\n", CI->getZExtValue());
4494 AP.OutStreamer->emitIntValue(CI->getZExtValue(), StoreSize);
4495 } else {
4497 }
4498
4499 // Emit tail padding if needed
4500 if (Size != StoreSize)
4501 AP.OutStreamer->emitZeros(Size - StoreSize);
4502
4503 return;
4504 }
4505
4506 if (const ConstantByte *CB = dyn_cast<ConstantByte>(CV)) {
4507 if (isa<VectorType>(CV->getType()))
4508 return emitGlobalConstantVector(DL, CV, AP, AliasList);
4509
4510 const uint64_t StoreSize = DL.getTypeStoreSize(CV->getType());
4511 if (StoreSize <= 8) {
4512 if (AP.isVerbose())
4513 AP.OutStreamer->getCommentOS()
4514 << format("0x%" PRIx64 "\n", CB->getZExtValue());
4515 AP.OutStreamer->emitIntValue(CB->getZExtValue(), StoreSize);
4516 } else {
4518 }
4519
4520 // Emit tail padding if needed
4521 if (Size != StoreSize)
4522 AP.OutStreamer->emitZeros(Size - StoreSize);
4523
4524 return;
4525 }
4526
4527 if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
4528 if (isa<VectorType>(CV->getType()))
4529 return emitGlobalConstantVector(DL, CV, AP, AliasList);
4530 else
4531 return emitGlobalConstantFP(CFP, AP);
4532 }
4533
4534 if (isa<ConstantPointerNull>(CV)) {
4535 AP.OutStreamer->emitIntValue(0, Size);
4536 return;
4537 }
4538
4540 return emitGlobalConstantDataSequential(DL, CDS, AP, AliasList);
4541
4542 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
4543 return emitGlobalConstantArray(DL, CVA, AP, BaseCV, Offset, AliasList);
4544
4545 if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
4546 return emitGlobalConstantStruct(DL, CVS, AP, BaseCV, Offset, AliasList);
4547
4548 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
4549 // Look through bitcasts, which might not be able to be MCExpr'ized (e.g. of
4550 // vectors).
4551 if (CE->getOpcode() == Instruction::BitCast)
4552 return emitGlobalConstantImpl(DL, CE->getOperand(0), AP);
4553
4554 if (Size > 8) {
4555 // If the constant expression's size is greater than 64-bits, then we have
4556 // to emit the value in chunks. Try to constant fold the value and emit it
4557 // that way.
4558 Constant *New = ConstantFoldConstant(CE, DL);
4559 if (New != CE)
4560 return emitGlobalConstantImpl(DL, New, AP);
4561 }
4562 }
4563
4564 if (isa<ConstantVector>(CV))
4565 return emitGlobalConstantVector(DL, CV, AP, AliasList);
4566
4567 // Otherwise, it must be a ConstantExpr. Lower it to an MCExpr, then emit it
4568 // thread the streamer with EmitValue.
4569 const MCExpr *ME = AP.lowerConstant(CV, BaseCV, Offset);
4570
4571 // Since lowerConstant already folded and got rid of all IR pointer and
4572 // integer casts, detect GOT equivalent accesses by looking into the MCExpr
4573 // directly.
4575 handleIndirectSymViaGOTPCRel(AP, &ME, BaseCV, Offset);
4576
4577 AP.OutStreamer->emitValue(ME, Size);
4578}
4579
4580/// EmitGlobalConstant - Print a general LLVM constant to the .s file.
4582 AliasMapTy *AliasList) {
4583 uint64_t Size = DL.getTypeAllocSize(CV->getType());
4584 if (Size)
4585 emitGlobalConstantImpl(DL, CV, *this, nullptr, 0, AliasList);
4586 else if (MAI.hasSubsectionsViaSymbols()) {
4587 // If the global has zero size, emit a single byte so that two labels don't
4588 // look like they are at the same location.
4589 OutStreamer->emitIntValue(0, 1);
4590 }
4591 if (!AliasList)
4592 return;
4593 // TODO: These remaining aliases are not emitted in the correct location. Need
4594 // to handle the case where the alias offset doesn't refer to any sub-element.
4595 for (auto &AliasPair : *AliasList) {
4596 for (const GlobalAlias *GA : AliasPair.second)
4597 OutStreamer->emitLabel(getSymbol(GA));
4598 }
4599}
4600
4602 // Target doesn't support this yet!
4603 llvm_unreachable("Target does not support EmitMachineConstantPoolValue");
4604}
4605
4607 if (Offset > 0)
4608 OS << '+' << Offset;
4609 else if (Offset < 0)
4610 OS << Offset;
4611}
4612
4613void AsmPrinter::emitNops(unsigned N) {
4614 MCInst Nop = MF->getSubtarget().getInstrInfo()->getNop();
4615 for (; N; --N)
4617}
4618
4619//===----------------------------------------------------------------------===//
4620// Symbol Lowering Routines.
4621//===----------------------------------------------------------------------===//
4622
4624 return OutContext.createTempSymbol(Name, true);
4625}
4626
4628 return const_cast<AsmPrinter *>(this)->getAddrLabelSymbol(
4629 BA->getBasicBlock());
4630}
4631
4633 return const_cast<AsmPrinter *>(this)->getAddrLabelSymbol(BB);
4634}
4635
4639
4640/// GetCPISymbol - Return the symbol for the specified constant pool entry.
4641MCSymbol *AsmPrinter::GetCPISymbol(unsigned CPID) const {
4642 if (getSubtargetInfo().getTargetTriple().isWindowsMSVCEnvironment() ||
4643 getSubtargetInfo().getTargetTriple().isUEFI()) {
4644 const MachineConstantPoolEntry &CPE =
4645 MF->getConstantPool()->getConstants()[CPID];
4646 if (!CPE.isMachineConstantPoolEntry()) {
4647 const DataLayout &DL = MF->getDataLayout();
4648 SectionKind Kind = CPE.getSectionKind(&DL);
4649 const Constant *C = CPE.Val.ConstVal;
4650 Align Alignment = CPE.Alignment;
4652 DL, Kind, C, Alignment, &MF->getFunction());
4653 if (S && TM.getTargetTriple().isOSBinFormatCOFF()) {
4654 if (MCSymbol *Sym =
4655 static_cast<const MCSectionCOFF *>(S)->getCOMDATSymbol()) {
4656 if (Sym->isUndefined())
4657 OutStreamer->emitSymbolAttribute(Sym, MCSA_Global);
4658 return Sym;
4659 }
4660 }
4661 }
4662 }
4663
4664 const DataLayout &DL = getDataLayout();
4665 return OutContext.getOrCreateSymbol(Twine(DL.getInternalSymbolPrefix()) +
4666 "CPI" + Twine(getFunctionNumber()) + "_" +
4667 Twine(CPID));
4668}
4669
4670/// GetJTISymbol - Return the symbol for the specified jump table entry.
4671MCSymbol *AsmPrinter::GetJTISymbol(unsigned JTID, bool isLinkerPrivate) const {
4672 return MF->getJTISymbol(JTID, OutContext, isLinkerPrivate);
4673}
4674
4675/// GetJTSetSymbol - Return the symbol for the specified jump table .set
4676/// FIXME: privatize to AsmPrinter.
4677MCSymbol *AsmPrinter::GetJTSetSymbol(unsigned UID, unsigned MBBID) const {
4678 const DataLayout &DL = getDataLayout();
4679 return OutContext.getOrCreateSymbol(Twine(DL.getInternalSymbolPrefix()) +
4680 Twine(getFunctionNumber()) + "_" +
4681 Twine(UID) + "_set_" + Twine(MBBID));
4682}
4683
4688
4689/// Return the MCSymbol for the specified ExternalSymbol.
4691 SmallString<60> NameStr;
4693 return OutContext.getOrCreateSymbol(NameStr);
4694}
4695
4696/// PrintParentLoopComment - Print comments about parent loops of this one.
4698 unsigned FunctionNumber) {
4699 if (!Loop) return;
4700 PrintParentLoopComment(OS, Loop->getParentLoop(), FunctionNumber);
4701 OS.indent(Loop->getLoopDepth()*2)
4702 << "Parent Loop BB" << FunctionNumber << "_"
4703 << Loop->getHeader()->getNumber()
4704 << " Depth=" << Loop->getLoopDepth() << '\n';
4705}
4706
4707/// PrintChildLoopComment - Print comments about child loops within
4708/// the loop for this basic block, with nesting.
4710 unsigned FunctionNumber) {
4711 // Add child loop information
4712 for (const MachineLoop *CL : *Loop) {
4713 OS.indent(CL->getLoopDepth()*2)
4714 << "Child Loop BB" << FunctionNumber << "_"
4715 << CL->getHeader()->getNumber() << " Depth " << CL->getLoopDepth()
4716 << '\n';
4717 PrintChildLoopComment(OS, CL, FunctionNumber);
4718 }
4719}
4720
4721/// emitBasicBlockLoopComments - Pretty-print comments for basic blocks.
4723 const MachineLoopInfo *LI,
4724 const AsmPrinter &AP) {
4725 // Add loop depth information
4726 const MachineLoop *Loop = LI->getLoopFor(&MBB);
4727 if (!Loop) return;
4728
4729 MachineBasicBlock *Header = Loop->getHeader();
4730 assert(Header && "No header for loop");
4731
4732 // If this block is not a loop header, just print out what is the loop header
4733 // and return.
4734 if (Header != &MBB) {
4735 AP.OutStreamer->AddComment(" in Loop: Header=BB" +
4736 Twine(AP.getFunctionNumber())+"_" +
4738 " Depth="+Twine(Loop->getLoopDepth()));
4739 return;
4740 }
4741
4742 // Otherwise, it is a loop header. Print out information about child and
4743 // parent loops.
4744 raw_ostream &OS = AP.OutStreamer->getCommentOS();
4745
4747
4748 OS << "=>";
4749 OS.indent(Loop->getLoopDepth()*2-2);
4750
4751 OS << "This ";
4752 if (Loop->isInnermost())
4753 OS << "Inner ";
4754 OS << "Loop Header: Depth=" + Twine(Loop->getLoopDepth()) << '\n';
4755
4757}
4758
4759/// emitBasicBlockStart - This method prints the label for the specified
4760/// MachineBasicBlock, an alignment (if present) and a comment describing
4761/// it if appropriate.
4763 // End the previous funclet and start a new one.
4764 if (MBB.isEHFuncletEntry()) {
4765 for (auto &Handler : Handlers) {
4766 Handler->endFunclet();
4767 Handler->beginFunclet(MBB);
4768 }
4769 for (auto &Handler : EHHandlers) {
4770 Handler->endFunclet();
4771 Handler->beginFunclet(MBB);
4772 }
4773 }
4774
4775 // Switch to a new section if this basic block must begin a section. The
4776 // entry block is always placed in the function section and is handled
4777 // separately.
4778 if (MBB.isBeginSection() && !MBB.isEntryBlock()) {
4779 OutStreamer->switchSection(
4780 getObjFileLowering().getSectionForMachineBasicBlock(MF->getFunction(),
4781 MBB, TM));
4782 CurrentSectionBeginSym = MBB.getSymbol();
4783 }
4784
4785 for (auto &Handler : Handlers)
4786 Handler->beginCodeAlignment(MBB);
4787
4788 // Emit an alignment directive for this block, if needed.
4789 const Align Alignment = MBB.getAlignment();
4790 if (Alignment != Align(1))
4791 emitAlignment(Alignment, nullptr, MBB.getMaxBytesForAlignment());
4792
4793 // If the block has its address taken, emit any labels that were used to
4794 // reference the block. It is possible that there is more than one label
4795 // here, because multiple LLVM BB's may have been RAUW'd to this block after
4796 // the references were generated.
4797 if (MBB.isIRBlockAddressTaken()) {
4798 if (isVerbose())
4799 OutStreamer->AddComment("Block address taken");
4800
4801 BasicBlock *BB = MBB.getAddressTakenIRBlock();
4802 assert(BB && BB->hasAddressTaken() && "Missing BB");
4803 for (MCSymbol *Sym : getAddrLabelSymbolToEmit(BB))
4804 OutStreamer->emitLabel(Sym);
4805 } else if (isVerbose() && MBB.isMachineBlockAddressTaken()) {
4806 OutStreamer->AddComment("Block address taken");
4807 } else if (isVerbose() && MBB.isInlineAsmBrIndirectTarget()) {
4808 OutStreamer->AddComment("Inline asm indirect target");
4809 }
4810
4811 // Print some verbose block comments.
4812 if (isVerbose()) {
4813 if (const BasicBlock *BB = MBB.getBasicBlock()) {
4814 if (BB->hasName()) {
4815 BB->printAsOperand(OutStreamer->getCommentOS(),
4816 /*PrintType=*/false, BB->getModule());
4817 OutStreamer->getCommentOS() << '\n';
4818 }
4819 }
4820
4821 assert(MLI != nullptr && "MachineLoopInfo should has been computed");
4823 }
4824
4825 // Print the main label for the block.
4826 if (shouldEmitLabelForBasicBlock(MBB)) {
4827 if (isVerbose() && MBB.hasLabelMustBeEmitted())
4828 OutStreamer->AddComment("Label of block must be emitted");
4829 OutStreamer->emitLabel(MBB.getSymbol());
4830 } else {
4831 if (isVerbose()) {
4832 // NOTE: Want this comment at start of line, don't emit with AddComment.
4833 OutStreamer->emitRawComment(" %bb." + Twine(MBB.getNumber()) + ":",
4834 false);
4835 }
4836 }
4837
4838 if (MBB.isEHContTarget() &&
4839 MAI.getExceptionHandlingType() == ExceptionHandling::WinEH) {
4840 OutStreamer->emitLabel(MBB.getEHContSymbol());
4841 }
4842
4843 // With BB sections, each basic block must handle CFI information on its own
4844 // if it begins a section (Entry block call is handled separately, next to
4845 // beginFunction).
4846 if (MBB.isBeginSection() && !MBB.isEntryBlock()) {
4847 for (auto &Handler : Handlers)
4848 Handler->beginBasicBlockSection(MBB);
4849 for (auto &Handler : EHHandlers)
4850 Handler->beginBasicBlockSection(MBB);
4851 }
4852}
4853
4855 // Check if CFI information needs to be updated for this MBB with basic block
4856 // sections.
4857 if (MBB.isEndSection()) {
4858 for (auto &Handler : Handlers)
4859 Handler->endBasicBlockSection(MBB);
4860 for (auto &Handler : EHHandlers)
4861 Handler->endBasicBlockSection(MBB);
4862 }
4863}
4864
4865void AsmPrinter::emitVisibility(MCSymbol *Sym, unsigned Visibility,
4866 bool IsDefinition) const {
4868
4869 switch (Visibility) {
4870 default: break;
4872 if (IsDefinition)
4873 Attr = MAI.getHiddenVisibilityAttr();
4874 else
4875 Attr = MAI.getHiddenDeclarationVisibilityAttr();
4876 break;
4878 Attr = MAI.getProtectedVisibilityAttr();
4879 break;
4880 }
4881
4882 if (Attr != MCSA_Invalid)
4883 OutStreamer->emitSymbolAttribute(Sym, Attr);
4884}
4885
4886bool AsmPrinter::shouldEmitLabelForBasicBlock(
4887 const MachineBasicBlock &MBB) const {
4888 // With `-fbasic-block-sections=`, a label is needed for every non-entry block
4889 // in the labels mode (option `=labels`) and every section beginning in the
4890 // sections mode (`=all` and `=list=`).
4891 if ((MF->getTarget().Options.BBAddrMap || MBB.isBeginSection()) &&
4892 !MBB.isEntryBlock())
4893 return true;
4894 // A label is needed for any block with at least one predecessor (when that
4895 // predecessor is not the fallthrough predecessor, or if it is an EH funclet
4896 // entry, or if a label is forced).
4897 return !MBB.pred_empty() &&
4898 (!isBlockOnlyReachableByFallthrough(&MBB) || MBB.isEHFuncletEntry() ||
4899 MBB.hasLabelMustBeEmitted());
4900}
4901
4902/// isBlockOnlyReachableByFallthough - Return true if the basic block has
4903/// exactly one predecessor and the control transfer mechanism between
4904/// the predecessor and this block is a fall-through.
4907 // If this is a landing pad, it isn't a fall through. If it has no preds,
4908 // then nothing falls through to it.
4909 if (MBB->isEHPad() || MBB->pred_empty())
4910 return false;
4911
4912 // If there isn't exactly one predecessor, it can't be a fall through.
4913 if (MBB->pred_size() > 1)
4914 return false;
4915
4916 // The predecessor has to be immediately before this block.
4917 MachineBasicBlock *Pred = *MBB->pred_begin();
4918 if (!Pred->isLayoutSuccessor(MBB))
4919 return false;
4920
4921 // If the block is completely empty, then it definitely does fall through.
4922 if (Pred->empty())
4923 return true;
4924
4925 // Check the terminators in the previous blocks
4926 for (const auto &MI : Pred->terminators()) {
4927 // If it is not a simple branch, we are in a table somewhere.
4928 if (!MI.isBranch() || MI.isIndirectBranch())
4929 return false;
4930
4931 // If we are the operands of one of the branches, this is not a fall
4932 // through. Note that targets with delay slots will usually bundle
4933 // terminators with the delay slot instruction.
4934 for (ConstMIBundleOperands OP(MI); OP.isValid(); ++OP) {
4935 if (OP->isJTI())
4936 return false;
4937 if (OP->isMBB() && OP->getMBB() == MBB)
4938 return false;
4939 }
4940 }
4941
4942 return true;
4943}
4944
4945GCMetadataPrinter *AsmPrinter::getOrCreateGCPrinter(GCStrategy &S) {
4946 if (!S.usesMetadata())
4947 return nullptr;
4948
4949 auto [GCPI, Inserted] = GCMetadataPrinters.try_emplace(&S);
4950 if (!Inserted)
4951 return GCPI->second.get();
4952
4953 auto Name = S.getName();
4954
4955 for (const GCMetadataPrinterRegistry::entry &GCMetaPrinter :
4957 if (Name == GCMetaPrinter.getName()) {
4958 std::unique_ptr<GCMetadataPrinter> GMP = GCMetaPrinter.instantiate();
4959 GMP->S = &S;
4960 GCPI->second = std::move(GMP);
4961 return GCPI->second.get();
4962 }
4963
4964 report_fatal_error("no GCMetadataPrinter registered for GC: " + Twine(Name));
4965}
4966
4968 std::unique_ptr<AsmPrinterHandler> Handler) {
4969 Handlers.insert(Handlers.begin(), std::move(Handler));
4971}
4972
4973/// Pin vtables to this file.
4975
4977
4978// In the binary's "xray_instr_map" section, an array of these function entries
4979// describes each instrumentation point. When XRay patches your code, the index
4980// into this table will be given to your handler as a patch point identifier.
4982 auto Kind8 = static_cast<uint8_t>(Kind);
4983 Out->emitBinaryData(StringRef(reinterpret_cast<const char *>(&Kind8), 1));
4984 Out->emitBinaryData(
4985 StringRef(reinterpret_cast<const char *>(&AlwaysInstrument), 1));
4986 Out->emitBinaryData(StringRef(reinterpret_cast<const char *>(&Version), 1));
4987 auto Padding = (4 * Bytes) - ((2 * Bytes) + 3);
4988 assert(Padding >= 0 && "Instrumentation map entry > 4 * Word Size");
4989 Out->emitZeros(Padding);
4990}
4991
4993 if (Sleds.empty())
4994 return;
4995
4996 auto PrevSection = OutStreamer->getCurrentSectionOnly();
4997 const Function &F = MF->getFunction();
4998 MCSection *InstMap = nullptr;
4999 MCSection *FnSledIndex = nullptr;
5000 const Triple &TT = TM.getTargetTriple();
5001 // Use PC-relative addresses on all targets.
5002 if (TT.isOSBinFormatELF()) {
5003 auto LinkedToSym = static_cast<const MCSymbolELF *>(CurrentFnSym);
5004 auto Flags = ELF::SHF_ALLOC | ELF::SHF_LINK_ORDER;
5005 StringRef GroupName;
5006 if (F.hasComdat()) {
5007 Flags |= ELF::SHF_GROUP;
5008 GroupName = F.getComdat()->getName();
5009 }
5010 InstMap = OutContext.getELFSection("xray_instr_map", ELF::SHT_PROGBITS,
5011 Flags, 0, GroupName, F.hasComdat(),
5012 MCSection::NonUniqueID, LinkedToSym);
5013
5014 if (TM.Options.XRayFunctionIndex)
5015 FnSledIndex = OutContext.getELFSection(
5016 "xray_fn_idx", ELF::SHT_PROGBITS, Flags, 0, GroupName, F.hasComdat(),
5017 MCSection::NonUniqueID, LinkedToSym);
5018 } else if (MF->getSubtarget().getTargetTriple().isOSBinFormatMachO()) {
5019 InstMap = OutContext.getMachOSection("__DATA", "xray_instr_map",
5022 if (TM.Options.XRayFunctionIndex)
5023 FnSledIndex = OutContext.getMachOSection("__DATA", "xray_fn_idx",
5026 } else {
5027 llvm_unreachable("Unsupported target");
5028 }
5029
5030 auto WordSizeBytes = MAI.getCodePointerSize();
5031
5032 // Now we switch to the instrumentation map section. Because this is done
5033 // per-function, we are able to create an index entry that will represent the
5034 // range of sleds associated with a function.
5035 auto &Ctx = OutContext;
5036 MCSymbol *SledsStart =
5037 OutContext.createLinkerPrivateSymbol("xray_sleds_start");
5038 OutStreamer->switchSection(InstMap);
5039 OutStreamer->emitLabel(SledsStart);
5040 for (const auto &Sled : Sleds) {
5041 MCSymbol *Dot = Ctx.createTempSymbol();
5042 OutStreamer->emitLabel(Dot);
5043 OutStreamer->emitValueImpl(
5045 MCSymbolRefExpr::create(Dot, Ctx), Ctx),
5046 WordSizeBytes);
5047 OutStreamer->emitValueImpl(
5051 MCConstantExpr::create(WordSizeBytes, Ctx),
5052 Ctx),
5053 Ctx),
5054 WordSizeBytes);
5055 Sled.emit(WordSizeBytes, OutStreamer.get());
5056 }
5057 MCSymbol *SledsEnd = OutContext.createTempSymbol("xray_sleds_end", true);
5058 OutStreamer->emitLabel(SledsEnd);
5059
5060 // We then emit a single entry in the index per function. We use the symbols
5061 // that bound the instrumentation map as the range for a specific function.
5062 // Each entry contains 2 words and needs to be word-aligned.
5063 if (FnSledIndex) {
5064 OutStreamer->switchSection(FnSledIndex);
5065 OutStreamer->emitValueToAlignment(Align(WordSizeBytes));
5066 // For Mach-O, use an "l" symbol as the atom of this subsection. The label
5067 // difference uses a SUBTRACTOR external relocation which references the
5068 // symbol.
5069 MCSymbol *Dot = Ctx.createLinkerPrivateSymbol("xray_fn_idx");
5070 OutStreamer->emitLabel(Dot);
5071 OutStreamer->emitValueImpl(
5073 MCSymbolRefExpr::create(Dot, Ctx), Ctx),
5074 WordSizeBytes);
5075 OutStreamer->emitValueImpl(MCConstantExpr::create(Sleds.size(), Ctx),
5076 WordSizeBytes);
5077 OutStreamer->switchSection(PrevSection);
5078 }
5079 Sleds.clear();
5080}
5081
5083 SledKind Kind, uint8_t Version) {
5084 const Function &F = MI.getMF()->getFunction();
5085 auto Attr = F.getFnAttribute("function-instrument");
5086 bool LogArgs = F.hasFnAttribute("xray-log-args");
5087 bool AlwaysInstrument =
5088 Attr.isStringAttribute() && Attr.getValueAsString() == "xray-always";
5089 if (Kind == SledKind::FUNCTION_ENTER && LogArgs)
5091 Sleds.emplace_back(XRayFunctionEntry{Sled, CurrentFnSym, Kind,
5092 AlwaysInstrument, &F, Version});
5093}
5094
5096 const Function &F = MF->getFunction();
5097 unsigned PatchableFunctionPrefix =
5098 F.getFnAttributeAsParsedInteger("patchable-function-prefix");
5099 unsigned PatchableFunctionEntry =
5100 F.getFnAttributeAsParsedInteger("patchable-function-entry");
5101 if (!PatchableFunctionPrefix && !PatchableFunctionEntry)
5102 return;
5103 const unsigned PointerSize = getPointerSize();
5104 if (TM.getTargetTriple().isOSBinFormatELF()) {
5105 auto Flags = ELF::SHF_WRITE | ELF::SHF_ALLOC;
5106 const MCSymbolELF *LinkedToSym = nullptr;
5107 StringRef GroupName, SectionName;
5108
5109 if (F.hasFnAttribute("patchable-function-entry-section"))
5110 SectionName = F.getFnAttribute("patchable-function-entry-section")
5111 .getValueAsString();
5112 if (SectionName.empty())
5113 SectionName = "__patchable_function_entries";
5114
5115 // GNU as < 2.35 did not support section flag 'o'. GNU ld < 2.36 did not
5116 // support mixed SHF_LINK_ORDER and non-SHF_LINK_ORDER sections.
5117 if (MAI.useIntegratedAssembler() || MAI.binutilsIsAtLeast(2, 36)) {
5118 Flags |= ELF::SHF_LINK_ORDER;
5119 if (F.hasComdat()) {
5120 Flags |= ELF::SHF_GROUP;
5121 GroupName = F.getComdat()->getName();
5122 }
5123 LinkedToSym = static_cast<const MCSymbolELF *>(CurrentFnSym);
5124 }
5125 OutStreamer->switchSection(OutContext.getELFSection(
5126 SectionName, ELF::SHT_PROGBITS, Flags, 0, GroupName, F.hasComdat(),
5127 MCSection::NonUniqueID, LinkedToSym));
5128 emitAlignment(Align(PointerSize));
5129 OutStreamer->emitSymbolValue(CurrentPatchableFunctionEntrySym, PointerSize);
5130 }
5131}
5132
5134 return OutStreamer->getContext().getDwarfVersion();
5135}
5136
5138 OutStreamer->getContext().setDwarfVersion(Version);
5139}
5140
5142 return OutStreamer->getContext().getDwarfFormat() == dwarf::DWARF64;
5143}
5144
5147 OutStreamer->getContext().getDwarfFormat());
5148}
5149
5151 return {getDwarfVersion(), uint8_t(MAI.getCodePointerSize()),
5152 OutStreamer->getContext().getDwarfFormat(),
5154}
5155
5158 OutStreamer->getContext().getDwarfFormat());
5159}
5160
5161std::tuple<const MCSymbol *, uint64_t, const MCSymbol *,
5164 const MCSymbol *BranchLabel) const {
5165 const auto TLI = MF->getSubtarget().getTargetLowering();
5166 const auto BaseExpr =
5167 TLI->getPICJumpTableRelocBaseExpr(MF, JTI, MMI->getContext());
5168 const auto Base = &cast<MCSymbolRefExpr>(BaseExpr)->getSymbol();
5169
5170 // By default, for the architectures that support CodeView,
5171 // EK_LabelDifference32 is implemented as an Int32 from the base address.
5172 return std::make_tuple(Base, 0, BranchLabel,
5174}
5175
5177 const Triple &TT = TM.getTargetTriple();
5178 assert(TT.isOSBinFormatCOFF());
5179
5180 bool IsTargetArm64EC = TT.isWindowsArm64EC();
5182 SmallVector<MCSymbol *> FuncOverrideDefaultSymbols;
5183 bool SwitchedToDirectiveSection = false;
5184 for (const Function &F : M.functions()) {
5185 if (F.hasFnAttribute("loader-replaceable")) {
5186 if (!SwitchedToDirectiveSection) {
5187 OutStreamer->switchSection(
5188 OutContext.getObjectFileInfo()->getDrectveSection());
5189 SwitchedToDirectiveSection = true;
5190 }
5191
5192 StringRef Name = F.getName();
5193
5194 // For hybrid-patchable targets, strip the prefix so that we can mark
5195 // the real function as replaceable.
5196 if (IsTargetArm64EC && Name.ends_with(HybridPatchableTargetSuffix)) {
5197 Name = Name.drop_back(HybridPatchableTargetSuffix.size());
5198 }
5199
5200 MCSymbol *FuncOverrideSymbol =
5201 MMI->getContext().getOrCreateSymbol(Name + "_$fo$");
5202 OutStreamer->beginCOFFSymbolDef(FuncOverrideSymbol);
5203 OutStreamer->emitCOFFSymbolStorageClass(COFF::IMAGE_SYM_CLASS_EXTERNAL);
5204 OutStreamer->emitCOFFSymbolType(COFF::IMAGE_SYM_DTYPE_NULL);
5205 OutStreamer->endCOFFSymbolDef();
5206
5207 MCSymbol *FuncOverrideDefaultSymbol =
5208 MMI->getContext().getOrCreateSymbol(Name + "_$fo_default$");
5209 OutStreamer->beginCOFFSymbolDef(FuncOverrideDefaultSymbol);
5210 OutStreamer->emitCOFFSymbolStorageClass(COFF::IMAGE_SYM_CLASS_EXTERNAL);
5211 OutStreamer->emitCOFFSymbolType(COFF::IMAGE_SYM_DTYPE_NULL);
5212 OutStreamer->endCOFFSymbolDef();
5213 FuncOverrideDefaultSymbols.push_back(FuncOverrideDefaultSymbol);
5214
5215 OutStreamer->emitBytes((Twine(" /ALTERNATENAME:") +
5216 FuncOverrideSymbol->getName() + "=" +
5217 FuncOverrideDefaultSymbol->getName())
5218 .toStringRef(Buf));
5219 Buf.clear();
5220 }
5221 }
5222
5223 if (SwitchedToDirectiveSection)
5224 OutStreamer->popSection();
5225
5226 if (FuncOverrideDefaultSymbols.empty())
5227 return;
5228
5229 // MSVC emits the symbols for the default variables pointing at the start of
5230 // the .data section, but doesn't actually allocate any space for them. LLVM
5231 // can't do this, so have all of the variables pointing at a single byte
5232 // instead.
5233 OutStreamer->switchSection(OutContext.getObjectFileInfo()->getDataSection());
5234 for (MCSymbol *Symbol : FuncOverrideDefaultSymbols) {
5235 OutStreamer->emitLabel(Symbol);
5236 }
5237 OutStreamer->emitZeros(1);
5238 OutStreamer->popSection();
5239}
5240
5242 const Triple &TT = TM.getTargetTriple();
5243 assert(TT.isOSBinFormatCOFF());
5244
5245 // Emit an absolute @feat.00 symbol.
5246 MCSymbol *S = MMI->getContext().getOrCreateSymbol(StringRef("@feat.00"));
5247 OutStreamer->beginCOFFSymbolDef(S);
5248 OutStreamer->emitCOFFSymbolStorageClass(COFF::IMAGE_SYM_CLASS_STATIC);
5249 OutStreamer->emitCOFFSymbolType(COFF::IMAGE_SYM_DTYPE_NULL);
5250 OutStreamer->endCOFFSymbolDef();
5251 int64_t Feat00Value = 0;
5252
5253 if (TT.getArch() == Triple::x86) {
5254 // According to the PE-COFF spec, the LSB of this value marks the object
5255 // for "registered SEH". This means that all SEH handler entry points
5256 // must be registered in .sxdata. Use of any unregistered handlers will
5257 // cause the process to terminate immediately. LLVM does not know how to
5258 // register any SEH handlers, so its object files should be safe.
5259 Feat00Value |= COFF::Feat00Flags::SafeSEH;
5260 }
5261
5262 if (M.getControlFlowGuardMode() == ControlFlowGuardMode::Enabled) {
5263 // Object is CFG-aware. Only set if we actually inserted the checks.
5264 Feat00Value |= COFF::Feat00Flags::GuardCF;
5265 }
5266
5267 if (M.getModuleFlag("ehcontguard")) {
5268 // Object also has EHCont.
5269 Feat00Value |= COFF::Feat00Flags::GuardEHCont;
5270 }
5271
5272 if (M.getModuleFlag("ms-kernel")) {
5273 // Object is compiled with /kernel.
5274 Feat00Value |= COFF::Feat00Flags::Kernel;
5275 }
5276
5277 OutStreamer->emitSymbolAttribute(S, MCSA_Global);
5278 OutStreamer->emitAssignment(
5279 S, MCConstantExpr::create(Feat00Value, MMI->getContext()));
5280}
5281
5282namespace llvm {
5283namespace {
5285 MachineFunction &MF) {
5287 MAM.getResult<FunctionAnalysisManagerModuleProxy>(M).getManager();
5290 MF.getFunction())
5291 .getManager();
5292 return MFAM;
5293}
5294} // anonymous namespace
5295
5298 MachineModuleInfo &MMI = MAM.getResult<MachineModuleAnalysis>(M).getMMI();
5299 AsmPrinter.GetMMI = [&MMI]() { return &MMI; };
5300 AsmPrinter.MMI = &MMI;
5301 AsmPrinter.GetORE = [&MAM, &M](MachineFunction &MF) {
5302 return &getMFAM(M, MAM, MF)
5304 };
5305 AsmPrinter.GetMDT = [&MAM, &M](MachineFunction &MF) {
5306 return &getMFAM(M, MAM, MF).getResult<MachineDominatorTreeAnalysis>(MF);
5307 };
5308 AsmPrinter.GetMLI = [&MAM, &M](MachineFunction &MF) {
5309 return &getMFAM(M, MAM, MF).getResult<MachineLoopAnalysis>(MF);
5310 };
5311 // TODO(boomanaiden154): Get GC working with the new pass manager.
5312 AsmPrinter.BeginGCAssembly = [](Module &M) {};
5314 AsmPrinter.EmitStackMaps = [](Module &M) {};
5316}
5317
5319 MachineFunction &MF,
5321 const ModuleAnalysisManagerMachineFunctionProxy::Result &MAMProxy =
5323 MachineModuleInfo &MMI =
5324 MAMProxy
5325 .getCachedResult<MachineModuleAnalysis>(*MF.getFunction().getParent())
5326 ->getMMI();
5327 AsmPrinter.GetMMI = [&MMI]() { return &MMI; };
5328 AsmPrinter.MMI = &MMI;
5329 AsmPrinter.GetORE = [&MFAM](MachineFunction &MF) {
5331 };
5332 AsmPrinter.GetMDT = [&MFAM](MachineFunction &MF) {
5333 return &MFAM.getResult<MachineDominatorTreeAnalysis>(MF);
5334 };
5335 AsmPrinter.GetMLI = [&MFAM](MachineFunction &MF) {
5336 return &MFAM.getResult<MachineLoopAnalysis>(MF);
5337 };
5338 // TODO(boomanaiden154): Get GC working with the new pass manager.
5339 AsmPrinter.BeginGCAssembly = [](Module &M) {};
5341 AsmPrinter.EmitStackMaps = [](Module &M) {};
5343}
5344
5346
5347} // namespace llvm
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
This file declares a class to represent arbitrary precision floating point values and provide a varie...
This file implements a class to represent arbitrary precision integral constant values and operations...
MachineBasicBlock & MBB
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
static cl::opt< bool > PgoAnalysisMapEmitBBSectionsCfg("pgo-analysis-map-emit-bb-sections-cfg", cl::desc("Enable the post-link cfg information from the basic block " "sections profile in the PGO analysis map"), cl::Hidden, cl::init(false))
static bool emitDebugValueComment(const MachineInstr *MI, AsmPrinter &AP)
emitDebugValueComment - This method handles the target-independent form of DBG_VALUE,...
static cl::opt< std::string > StackUsageFile("stack-usage-file", cl::desc("Output filename for stack usage information"), cl::value_desc("filename"), cl::Hidden)
static uint32_t getBBAddrMapMetadata(const MachineBasicBlock &MBB)
Returns the BB metadata to be emitted in the SHT_LLVM_BB_ADDR_MAP section for a given basic block.
cl::opt< bool > EmitBBHash
static cl::opt< bool > BBAddrMapSkipEmitBBEntries("basic-block-address-map-skip-bb-entries", cl::desc("Skip emitting basic block entries in the SHT_LLVM_BB_ADDR_MAP " "section. It's used to save binary size when BB entries are " "unnecessary for some PGOAnalysisMap features."), cl::Hidden, cl::init(false))
static void emitGlobalConstantFP(const ConstantFP *CFP, AsmPrinter &AP)
static void emitFakeUse(const MachineInstr *MI, AsmPrinter &AP)
static bool isGOTEquivalentCandidate(const GlobalVariable *GV, unsigned &NumGOTEquivUsers, bool &HasNonGlobalUsers)
Only consider global GOT equivalents if at least one user is a cstexpr inside an initializer of anoth...
static void emitGlobalConstantLargeByte(const ConstantByte *CB, AsmPrinter &AP)
static void tagGlobalDefinition(Module &M, GlobalVariable *G)
static void emitBasicBlockLoopComments(const MachineBasicBlock &MBB, const MachineLoopInfo *LI, const AsmPrinter &AP)
emitBasicBlockLoopComments - Pretty-print comments for basic blocks.
static void emitGlobalConstantLargeAPInt(const APInt &Val, uint64_t TypeStoreSize, AsmPrinter &AP)
static void handleIndirectSymViaGOTPCRel(AsmPrinter &AP, const MCExpr **ME, const Constant *BaseCst, uint64_t Offset)
Transform a not absolute MCExpr containing a reference to a GOT equivalent global,...
static llvm::object::BBAddrMap::Features getBBAddrMapFeature(const MachineFunction &MF, int NumMBBSectionRanges, bool HasCalls, const CFGProfile *FuncCFGProfile)
static int isRepeatedByteSequence(const ConstantDataSequential *V)
isRepeatedByteSequence - Determine whether the given value is composed of a repeated sequence of iden...
static void emitGlobalAliasInline(AsmPrinter &AP, uint64_t Offset, AsmPrinter::AliasMapTy *AliasList)
static bool needFuncLabels(const MachineFunction &MF, const AsmPrinter &Asm)
Returns true if function begin and end labels should be emitted.
static unsigned getNumGlobalVariableUses(const Constant *C, bool &HasNonGlobalUsers)
Compute the number of Global Variables that uses a Constant.
static cl::bits< PGOMapFeaturesEnum > PgoAnalysisMapFeatures("pgo-analysis-map", cl::Hidden, cl::CommaSeparated, cl::values(clEnumValN(PGOMapFeaturesEnum::None, "none", "Disable all options"), clEnumValN(PGOMapFeaturesEnum::FuncEntryCount, "func-entry-count", "Function Entry Count"), clEnumValN(PGOMapFeaturesEnum::BBFreq, "bb-freq", "Basic Block Frequency"), clEnumValN(PGOMapFeaturesEnum::BrProb, "br-prob", "Branch Probability"), clEnumValN(PGOMapFeaturesEnum::All, "all", "Enable all options")), cl::desc("Enable extended information within the SHT_LLVM_BB_ADDR_MAP that is " "extracted from PGO related analysis."))
static void removeMemtagFromGlobal(GlobalVariable &G)
static uint64_t globalSize(const llvm::GlobalVariable &G)
static void PrintChildLoopComment(raw_ostream &OS, const MachineLoop *Loop, unsigned FunctionNumber)
PrintChildLoopComment - Print comments about child loops within the loop for this basic block,...
static StringRef getMIMnemonic(const MachineInstr &MI, MCStreamer &Streamer)
PGOMapFeaturesEnum
static void emitComments(const MachineInstr &MI, const MCSubtargetInfo *STI, raw_ostream &CommentOS)
emitComments - Pretty-print comments for instructions.
static void PrintParentLoopComment(raw_ostream &OS, const MachineLoop *Loop, unsigned FunctionNumber)
PrintParentLoopComment - Print comments about parent loops of this one.
static void emitGlobalConstantStruct(const DataLayout &DL, const ConstantStruct *CS, AsmPrinter &AP, const Constant *BaseCV, uint64_t Offset, AsmPrinter::AliasMapTy *AliasList)
static void emitGlobalConstantDataSequential(const DataLayout &DL, const ConstantDataSequential *CDS, AsmPrinter &AP, AsmPrinter::AliasMapTy *AliasList)
static void emitKill(const MachineInstr *MI, AsmPrinter &AP)
static bool shouldTagGlobal(const llvm::GlobalVariable &G)
static void emitGlobalConstantImpl(const DataLayout &DL, const Constant *C, AsmPrinter &AP, const Constant *BaseCV=nullptr, uint64_t Offset=0, AsmPrinter::AliasMapTy *AliasList=nullptr)
static ConstantInt * extractNumericCGTypeId(const Function &F)
Extracts a generalized numeric type identifier of a Function's type from callgraph metadata.
static cl::opt< bool > PrintLatency("asm-print-latency", cl::desc("Print instruction latencies as verbose asm comments"), cl::Hidden, cl::init(false))
static bool emitDebugLabelComment(const MachineInstr *MI, AsmPrinter &AP)
This method handles the target-independent form of DBG_LABEL, returning true if it was able to do so.
static bool canBeHidden(const GlobalValue *GV, const MCAsmInfo &MAI)
static void emitGlobalConstantVector(const DataLayout &DL, const Constant *CV, AsmPrinter &AP, AsmPrinter::AliasMapTy *AliasList)
static cl::opt< bool > EmitJumpTableSizesSection("emit-jump-table-sizes-section", cl::desc("Emit a section containing jump table addresses and sizes"), cl::Hidden, cl::init(false))
static void emitGlobalConstantArray(const DataLayout &DL, const ConstantArray *CA, AsmPrinter &AP, const Constant *BaseCV, uint64_t Offset, AsmPrinter::AliasMapTy *AliasList)
static void emitGlobalConstantLargeInt(const ConstantInt *CI, AsmPrinter &AP)
static const Function * getParent(const Value *V)
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
#define clEnumValN(ENUMVAL, FLAGNAME, DESC)
This file contains the declarations for the subclasses of Constant, which represent the different fla...
This file defines the DenseMap class.
This file contains constants used for implementing Dwarf debug support.
#define DEBUG_TYPE
This file contains the declaration of the GlobalIFunc class, which represents a single indirect funct...
const HexagonInstrInfo * TII
IRTranslator LLVM IR MI
Module.h This file contains the declarations for the Module class.
This file contains common utilities for code prefetch insertion.
===- LazyMachineBlockFrequencyInfo.h - Lazy Block Frequency -*- C++ -*–===//
const FeatureInfo AllFeatures[]
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
#define G(x, y, z)
Definition MD5.cpp:55
This file declares the MachineConstantPool class which is an abstract constant pool to keep track of ...
===- MachineOptimizationRemarkEmitter.h - Opt Diagnostics -*- C++ -*-—===//
Register Reg
static cl::opt< std::string > OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"), cl::init("-"))
This file provides utility analysis objects describing memory locations.
This file contains the declarations for metadata subclasses.
#define T
static constexpr StringLiteral Filename
OptimizedStructLayoutField Field
FunctionAnalysisManager FAM
ModuleAnalysisManager MAM
Func getContext().diagnose(DiagnosticInfoUnsupported(Func
This file contains some templates that are useful if you are working with the STL at all.
#define OP(OPC)
Definition Instruction.h:46
This file defines the SmallPtrSet class.
This file defines the SmallString class.
This file defines the SmallVector class.
This file defines the 'Statistic' class, which is designed to be an easy way to expose various metric...
#define STATISTIC(VARNAME, DESC)
Definition Statistic.h:171
This file contains some functions that are useful when dealing with strings.
This file describes how to lower LLVM code to machine code.
Defines the virtual file system interface vfs::FileSystem.
Value * LHS
static const fltSemantics & IEEEdouble()
Definition APFloat.h:298
static constexpr roundingMode rmNearestTiesToEven
Definition APFloat.h:345
LLVM_ABI opStatus convert(const fltSemantics &ToSemantics, roundingMode RM, bool *losesInfo)
Definition APFloat.cpp:5920
LLVM_ABI double convertToDouble() const
Converts this APFloat to host double value.
Definition APFloat.cpp:5979
void toString(SmallVectorImpl< char > &Str, unsigned FormatPrecision=0, unsigned FormatMaxPadding=3, bool TruncateZero=true) const
Definition APFloat.h:1602
APInt bitcastToAPInt() const
Definition APFloat.h:1457
Class for arbitrary precision integers.
Definition APInt.h:78
unsigned getBitWidth() const
Return the number of bits in the APInt.
Definition APInt.h:1513
unsigned getNumWords() const
Get the number of words.
Definition APInt.h:1520
const uint64_t * getRawData() const
This function returns a pointer to the internal storage of the APInt.
Definition APInt.h:576
int64_t getSExtValue() const
Get sign extended value.
Definition APInt.h:1587
void lshrInPlace(unsigned ShiftAmt)
Logical right-shift this APInt by ShiftAmt in place.
Definition APInt.h:865
AddrLabelMap(MCContext &context)
void UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New)
void takeDeletedSymbolsForFunction(Function *F, std::vector< MCSymbol * > &Result)
If we have any deleted symbols for F, return them.
void UpdateForDeletedBlock(BasicBlock *BB)
ArrayRef< MCSymbol * > getAddrLabelSymbolToEmit(BasicBlock *BB)
PassT::Result & getResult(IRUnitT &IR, ExtraArgTs... ExtraArgs)
Get the result of an analysis pass for a given IR unit.
Represent the analysis usage information of a pass.
AnalysisUsage & addUsedIfAvailable()
Add the specified Pass class to the set of analyses used by this pass.
AnalysisUsage & addRequired()
void setPreservesAll()
Set by analyses that do not transform their input at all.
Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
const T & front() const
Get the first element.
Definition ArrayRef.h:144
bool empty() const
Check if the array is empty.
Definition ArrayRef.h:136
static LLVM_ABI AnalysisKey Key
virtual ~AsmPrinterHandler()
Pin vtables to this file.
virtual void markFunctionEnd()
This class is intended to be used as a driving class for all asm writers.
Definition AsmPrinter.h:91
virtual void emitInstruction(const MachineInstr *)
Targets should implement this to emit instructions.
Definition AsmPrinter.h:638
void emitDanglingPrefetchTargets()
Emit prefetch targets that were not mapped to any basic block.
const TargetLoweringObjectFile & getObjFileLowering() const
Return information about object file lowering.
MCSymbol * getSymbolWithGlobalValueBase(const GlobalValue *GV, StringRef Suffix) const
Return the MCSymbol for a private symbol with global value name as its base, with the specified suffi...
MCSymbol * getSymbol(const GlobalValue *GV) const
void emitULEB128(uint64_t Value, const char *Desc=nullptr, unsigned PadTo=0) const
Emit the specified unsigned leb128 value.
SmallVector< XRayFunctionEntry, 4 > Sleds
Definition AsmPrinter.h:426
MapVector< MBBSectionID, MBBSectionRange > MBBSectionRanges
Definition AsmPrinter.h:158
bool isDwarf64() const
void emitNops(unsigned N)
Emit N NOP instructions.
MCSymbol * CurrentFnBegin
Definition AsmPrinter.h:233
MachineLoopInfo * MLI
This is a pointer to the current MachineLoopInfo.
Definition AsmPrinter.h:118
virtual void emitDebugValue(const MCExpr *Value, unsigned Size) const
Emit the directive and value for debug thread local expression.
void EmitToStreamer(MCStreamer &S, const MCInst &Inst)
virtual void emitConstantPool()
Print to the current output stream assembly representations of the constants in the constant pool MCP...
virtual void emitGlobalVariable(const GlobalVariable *GV)
Emit the specified global variable to the .s file.
std::function< MachineOptimizationRemarkEmitter *(MachineFunction &)> GetORE
Definition AsmPrinter.h:177
virtual const MCExpr * lowerConstantPtrAuth(const ConstantPtrAuth &CPA)
Definition AsmPrinter.h:659
unsigned int getUnitLengthFieldByteSize() const
Returns 4 for DWARF32 and 12 for DWARF64.
void emitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset, unsigned Size, bool IsSectionRelative=false) const
Emit something like ".long Label+Offset" where the size in bytes of the directive is specified by Siz...
virtual bool emitTargetFeaturePush(const MCSubtargetInfo &STI)
Emit necessary directives to allow use of instructions that are permitted by target features enabled ...
Definition AsmPrinter.h:937
~AsmPrinter() override
TargetMachine & TM
Target machine description.
Definition AsmPrinter.h:94
void emitXRayTable()
Emit a table with all XRay instrumentation points.
virtual void emitGlobalAlias(const Module &M, const GlobalAlias &GA)
DenseMap< const MachineBasicBlock *, SmallVector< MCSymbol *, 1 > > CurrentFnCallsiteEndSymbols
Vector of symbols marking the end of the callsites in the current function, keyed by their containing...
Definition AsmPrinter.h:144
virtual void emitBasicBlockEnd(const MachineBasicBlock &MBB)
Targets can override this to emit stuff at the end of a basic block.
Align emitAlignment(Align Alignment, const GlobalObject *GV=nullptr, unsigned MaxBytesToEmit=0) const
Emit an alignment directive to the specified power of two boundary.
virtual void emitJumpTableEntry(const MachineJumpTableInfo &MJTI, const MachineBasicBlock *MBB, unsigned uid) const
EmitJumpTableEntry - Emit a jump table entry for the specified MBB to the current stream.
MCSymbol * CurrentFnDescSym
The symbol for the current function descriptor on AIX.
Definition AsmPrinter.h:132
MCSymbol * CurrentFnBeginLocal
For dso_local functions, the current $local alias for the function.
Definition AsmPrinter.h:236
MapVector< const MCSymbol *, GOTEquivUsePair > GlobalGOTEquivs
Definition AsmPrinter.h:163
virtual MCSymbol * GetCPISymbol(unsigned CPID) const
Return the symbol for the specified constant pool entry.
void emitGlobalGOTEquivs()
Constant expressions using GOT equivalent globals may not be eligible for PC relative GOT entry conve...
MCSymbol * getFunctionBegin() const
Definition AsmPrinter.h:319
void emitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo, unsigned Size) const
Emit something like ".long Hi-Lo" where the size in bytes of the directive is specified by Size and H...
void emitKCFITrapEntry(const MachineFunction &MF, const MCSymbol *Symbol)
SmallVector< std::unique_ptr< EHStreamer >, 1 > EHHandlers
A handle to the EH info emitter (if present).
Definition AsmPrinter.h:239
virtual void emitMachOIFuncStubHelperBody(Module &M, const GlobalIFunc &GI, MCSymbol *LazyPointer)
Definition AsmPrinter.h:690
MCSymbol * getMBBExceptionSym(const MachineBasicBlock &MBB)
std::function< void(Module &)> EmitStackMaps
Definition AsmPrinter.h:182
MCSymbol * getAddrLabelSymbol(const BasicBlock *BB)
Return the symbol to be used for the specified basic block when its address is taken.
Definition AsmPrinter.h:329
virtual DwarfDebug * createDwarfDebug()
Create the DwarfDebug handler.
SmallVector< std::unique_ptr< AsmPrinterHandler >, 2 > Handlers
Definition AsmPrinter.h:244
bool emitSpecialLLVMGlobal(const GlobalVariable *GV)
Check to see if the specified global is a special global used by LLVM.
MachineFunction * MF
The current machine function.
Definition AsmPrinter.h:109
virtual void emitJumpTableInfo()
Print assembly representations of the jump tables used by the current function to the current output ...
void computeGlobalGOTEquivs(Module &M)
Unnamed constant global variables solely contaning a pointer to another globals variable act like a g...
static Align getGVAlignment(const GlobalObject *GV, const DataLayout &DL, Align InAlign=Align(1))
Return the alignment for the specified GV.
MCSymbol * createCallsiteEndSymbol(const MachineBasicBlock &MBB)
Creates a new symbol to be used for the end of a callsite at the specified basic block.
virtual const MCExpr * lowerConstant(const Constant *CV, const Constant *BaseCV=nullptr, uint64_t Offset=0)
Lower the specified LLVM Constant to an MCExpr.
void emitCallGraphSection(const MachineFunction &MF, FunctionCallGraphInfo &FuncCGInfo)
Emits .llvm.callgraph section.
void emitInt8(int Value) const
Emit a byte directive and value.
CFISection getFunctionCFISectionType(const Function &F) const
Get the CFISection type for a function.
virtual void SetupMachineFunction(MachineFunction &MF)
This should be called when a new MachineFunction is being processed from runOnMachineFunction.
void emitFunctionBody()
This method emits the body and trailer for a function.
virtual bool isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const
Return true if the basic block has exactly one predecessor and the control transfer mechanism between...
void emitBBAddrMapSection(const MachineFunction &MF)
void emitPCSections(const MachineFunction &MF)
Emits the PC sections collected from instructions.
MachineDominatorTree * MDT
This is a pointer to the current MachineDominatorTree.
Definition AsmPrinter.h:115
virtual void emitStartOfAsmFile(Module &)
This virtual method can be overridden by targets that want to emit something at the start of their fi...
Definition AsmPrinter.h:614
MCSymbol * GetJTISymbol(unsigned JTID, bool isLinkerPrivate=false) const
Return the symbol for the specified jump table entry.
std::function< void(Module &)> FinishGCAssembly
Definition AsmPrinter.h:181
virtual void emitMachineConstantPoolValue(MachineConstantPoolValue *MCPV)
bool hasDebugInfo() const
Returns true if valid debug info is present.
Definition AsmPrinter.h:515
virtual void emitFunctionBodyStart()
Targets can override this to emit stuff before the first basic block in the function.
Definition AsmPrinter.h:622
std::function< MachineDominatorTree *(MachineFunction &)> GetMDT
Definition AsmPrinter.h:178
std::pair< const GlobalVariable *, unsigned > GOTEquivUsePair
Map global GOT equivalent MCSymbols to GlobalVariables and keep track of its number of uses by other ...
Definition AsmPrinter.h:162
void emitPatchableFunctionEntries()
void recordSled(MCSymbol *Sled, const MachineInstr &MI, SledKind Kind, uint8_t Version=0)
virtual void emitEndOfAsmFile(Module &)
This virtual method can be overridden by targets that want to emit something at the end of their file...
Definition AsmPrinter.h:618
bool doInitialization(Module &M) override
Set up the AsmPrinter when we are working on a new module.
MCSymbol * GetJTSetSymbol(unsigned UID, unsigned MBBID) const
Return the symbol for the specified jump table .set FIXME: privatize to AsmPrinter.
virtual void emitMachOIFuncStubBody(Module &M, const GlobalIFunc &GI, MCSymbol *LazyPointer)
Definition AsmPrinter.h:684
virtual void emitImplicitDef(const MachineInstr *MI) const
Targets can override this to customize the output of IMPLICIT_DEF instructions in verbose mode.
virtual void emitLinkage(const GlobalValue *GV, MCSymbol *GVSym) const
This emits linkage information about GVSym based on GV, if this is supported by the target.
void getAnalysisUsage(AnalysisUsage &AU) const override
Record analysis usage.
unsigned getFunctionNumber() const
Return a unique ID for the current function.
MachineOptimizationRemarkEmitter * ORE
Optimization remark emitter.
Definition AsmPrinter.h:121
DenseMap< uint64_t, SmallVector< const GlobalAlias *, 1 > > AliasMapTy
Print a general LLVM constant to the .s file.
Definition AsmPrinter.h:584
virtual bool shouldEmitWeakSwiftAsyncExtendedFramePointerFlags() const
AsmPrinter(TargetMachine &TM, std::unique_ptr< MCStreamer > Streamer, char &ID=AsmPrinter::ID)
void printOffset(int64_t Offset, raw_ostream &OS) const
This is just convenient handler for printing offsets.
void emitGlobalConstant(const DataLayout &DL, const Constant *CV, AliasMapTy *AliasList=nullptr)
EmitGlobalConstant - Print a general LLVM constant to the .s file.
void emitFrameAlloc(const MachineInstr &MI)
void emitStackSizeSection(const MachineFunction &MF)
MCSymbol * getSymbolPreferLocal(const GlobalValue &GV) const
Similar to getSymbol() but preferred for references.
std::function< void(Module &)> BeginGCAssembly
Definition AsmPrinter.h:180
MCSymbol * CurrentFnSym
The symbol for the current function.
Definition AsmPrinter.h:128
MachineModuleInfo * MMI
This is a pointer to the current MachineModuleInfo.
Definition AsmPrinter.h:112
void emitSLEB128(int64_t Value, const char *Desc=nullptr) const
Emit the specified signed leb128 value.
MCContext & OutContext
This is the context for the output file that we are streaming.
Definition AsmPrinter.h:101
const StaticDataProfileInfo * SDPI
Provides the profile information for constants.
Definition AsmPrinter.h:147
void emitCFIInstruction(const MachineInstr &MI)
MCSymbol * createTempSymbol(const Twine &Name) const
bool doFinalization(Module &M) override
Shut down the asmprinter.
virtual const MCSubtargetInfo * getIFuncMCSubtargetInfo() const
getSubtargetInfo() cannot be used where this is needed because we don't have a MachineFunction when w...
Definition AsmPrinter.h:680
void emitStackUsage(const MachineFunction &MF)
virtual void emitKCFITypeId(const MachineFunction &MF)
bool isPositionIndependent() const
virtual void emitTargetFeaturePop(const MCSubtargetInfo &STI, bool DidPush)
Emit necessary directives to restore target feature state.
Definition AsmPrinter.h:944
virtual void emitXXStructorList(const DataLayout &DL, const Constant *List, bool IsCtor)
This method emits llvm.global_ctors or llvm.global_dtors list.
void emitPCSectionsLabel(const MachineFunction &MF, const MDNode &MD)
Emits a label as reference for PC sections.
MCSymbol * CurrentPatchableFunctionEntrySym
The symbol for the entry in __patchable_function_entires.
Definition AsmPrinter.h:124
virtual void emitBasicBlockStart(const MachineBasicBlock &MBB)
Targets can override this to emit stuff at the start of a basic block.
void takeDeletedSymbolsForFunction(const Function *F, std::vector< MCSymbol * > &Result)
If the specified function has had any references to address-taken blocks generated,...
void emitVisibility(MCSymbol *Sym, unsigned Visibility, bool IsDefinition=true) const
This emits visibility information about symbol, if this is supported by the target.
void emitInt32(int Value) const
Emit a long directive and value.
std::unique_ptr< MCStreamer > OutStreamer
This is the MCStreamer object for the file we are generating.
Definition AsmPrinter.h:106
const ProfileSummaryInfo * PSI
The profile summary information.
Definition AsmPrinter.h:150
const MCAsmInfo & MAI
Target Asm Printer information.
Definition AsmPrinter.h:97
std::function< void()> AssertDebugEHFinalized
Definition AsmPrinter.h:183
virtual void emitFunctionDescriptor()
Definition AsmPrinter.h:647
const MCSection * getCurrentSection() const
Return the current section we are emitting to.
unsigned int getDwarfOffsetByteSize() const
Returns 4 for DWARF32 and 8 for DWARF64.
size_t NumUserHandlers
Definition AsmPrinter.h:245
MCSymbol * CurrentFnSymForSize
The symbol used to represent the start of the current function for the purpose of calculating its siz...
Definition AsmPrinter.h:137
std::function< MachineLoopInfo *(MachineFunction &)> GetMLI
Definition AsmPrinter.h:179
std::function< MachineModuleInfo *()> GetMMI
Definition AsmPrinter.h:176
bool isVerbose() const
Return true if assembly output should contain comments.
Definition AsmPrinter.h:310
MCSymbol * getFunctionEnd() const
Definition AsmPrinter.h:320
virtual void emitXXStructor(const DataLayout &DL, const Constant *CV)
Targets can override this to change how global constants that are part of a C++ static/global constru...
Definition AsmPrinter.h:655
void preprocessXXStructorList(const DataLayout &DL, const Constant *List, SmallVector< Structor, 8 > &Structors)
This method gathers an array of Structors and then sorts them out by Priority.
void emitInt16(int Value) const
Emit a short directive and value.
void setDwarfVersion(uint16_t Version)
void getNameWithPrefix(SmallVectorImpl< char > &Name, const GlobalValue *GV) const
StringRef getConstantSectionSuffix(const Constant *C) const
Returns a section suffix (hot or unlikely) for the constant if profiles are available.
void emitPseudoProbe(const MachineInstr &MI)
unsigned getPointerSize() const
Return the pointer size from the TargetMachine.
void emitRemarksSection(remarks::RemarkStreamer &RS)
MCSymbol * GetBlockAddressSymbol(const BlockAddress *BA) const
Return the MCSymbol used to satisfy BlockAddress uses of the specified basic block.
ArrayRef< MCSymbol * > getAddrLabelSymbolToEmit(const BasicBlock *BB)
Return the symbol to be used for the specified basic block when its address is taken.
virtual void emitFunctionBodyEnd()
Targets can override this to emit stuff after the last basic block in the function.
Definition AsmPrinter.h:626
const DataLayout & getDataLayout() const
Return information about data layout.
void emitCOFFFeatureSymbol(Module &M)
Emits the @feat.00 symbol indicating the features enabled in this module.
virtual void emitFunctionEntryLabel()
EmitFunctionEntryLabel - Emit the label that is the entrypoint for the function.
MCSymbol * GetExternalSymbolSymbol(const Twine &Sym) const
Return the MCSymbol for the specified ExternalSymbol.
void handleCallsiteForCallgraph(FunctionCallGraphInfo &FuncCGInfo, const MachineFunction::CallSiteInfoMap &CallSitesInfoMap, const MachineInstr &MI)
If MI is an indirect call, add expected type IDs to indirect type ids list.
void emitPrefetchTargetSymbol(const UniqueBBID &BBID, unsigned CallsiteIndex)
Helper to emit a symbol for the prefetch target associated with the given BBID and callsite index.
void emitInt64(uint64_t Value) const
Emit a long long directive and value.
uint16_t getDwarfVersion() const
dwarf::FormParams getDwarfFormParams() const
Returns information about the byte size of DW_FORM values.
const MCSubtargetInfo & getSubtargetInfo() const
Return information about subtarget.
void emitCOFFReplaceableFunctionData(Module &M)
Emits symbols and data to allow functions marked with the loader-replaceable attribute to be replacea...
bool usesCFIWithoutEH() const
Since emitting CFI unwind information is entangled with supporting the exceptions,...
bool doesDwarfUseRelocationsAcrossSections() const
Definition AsmPrinter.h:376
@ None
Do not emit either .eh_frame or .debug_frame.
Definition AsmPrinter.h:167
@ Debug
Emit .debug_frame.
Definition AsmPrinter.h:169
void addAsmPrinterHandler(std::unique_ptr< AsmPrinterHandler > Handler)
virtual std::tuple< const MCSymbol *, uint64_t, const MCSymbol *, codeview::JumpTableEntrySize > getCodeViewJumpTableInfo(int JTI, const MachineInstr *BranchInstr, const MCSymbol *BranchLabel) const
Gets information required to create a CodeView debug symbol for a jump table.
void emitLabelDifferenceAsULEB128(const MCSymbol *Hi, const MCSymbol *Lo) const
Emit something like ".uleb128 Hi-Lo".
virtual const MCExpr * lowerBlockAddressConstant(const BlockAddress &BA)
Lower the specified BlockAddress to an MCExpr.
const CFGProfile * getFunctionCFGProfile(StringRef FuncName) const
LLVM Basic Block Representation.
Definition BasicBlock.h:62
unsigned getNumber() const
Definition BasicBlock.h:95
const Function * getParent() const
Return the enclosing method, or null if none.
Definition BasicBlock.h:213
bool hasAddressTaken() const
Returns true if there are any uses of this basic block other than direct branches,...
Definition BasicBlock.h:687
The address of a basic block.
Definition Constants.h:1088
BasicBlock * getBasicBlock() const
Definition Constants.h:1125
uint64_t getFrequency() const
Returns the frequency as a fixpoint number scaled by the entry frequency.
uint32_t getNumerator() const
Value handle with callbacks on RAUW and destruction.
ConstMIBundleOperands - Iterate over all operands in a const bundle of machine instructions.
ConstantArray - Constant Array Declarations.
Definition Constants.h:590
ArrayType * getType() const
Specialize the getType() method to always return an ArrayType, which reduces the amount of casting ne...
Definition Constants.h:609
Class for constant bytes.
Definition Constants.h:281
const APInt & getValue() const
Return the constant as an APInt value reference.
Definition Constants.h:345
static Constant * get(LLVMContext &Context, ArrayRef< ElementTy > Elts)
get() constructor - Return a constant with array type with an element count and element type matching...
Definition Constants.h:878
ConstantDataSequential - A vector or array constant whose element type is a simple 1/2/4/8-byte integ...
Definition Constants.h:755
LLVM_ABI APFloat getElementAsAPFloat(uint64_t i) const
If this is a sequential container of floating point type, return the specified element as an APFloat.
LLVM_ABI uint64_t getElementAsInteger(uint64_t i) const
If this is a sequential container of integers (of any size), return the specified element in the low ...
StringRef getAsString() const
If this array is isString(), then this method returns the array as a StringRef.
Definition Constants.h:831
LLVM_ABI uint64_t getElementByteSize() const
Return the size (in bytes) of each element in the array/vector.
LLVM_ABI bool isString(unsigned CharSize=8) const
This method returns true if this is an array of CharSize integers or bytes.
LLVM_ABI uint64_t getNumElements() const
Return the number of elements in the array or vector.
LLVM_ABI Type * getElementType() const
Return the element type of the array/vector.
A constant value that is initialized with an expression using other constant values.
Definition Constants.h:1316
static LLVM_ABI Constant * getBitCast(Constant *C, Type *Ty, bool OnlyIfReduced=false)
ConstantFP - Floating Point Values [float, double].
Definition Constants.h:420
const APFloat & getValueAPF() const
Definition Constants.h:463
This is the shared class of boolean and integer constants.
Definition Constants.h:87
uint64_t getLimitedValue(uint64_t Limit=~0ULL) const
getLimitedValue - If the value is smaller than the specified limit, return it, otherwise return the l...
Definition Constants.h:269
uint64_t getZExtValue() const
Return the constant as a 64-bit unsigned integer value after it has been zero extended as appropriate...
Definition Constants.h:168
const APInt & getValue() const
Return the constant as an APInt value reference.
Definition Constants.h:159
A signed pointer, in the ptrauth sense.
Definition Constants.h:1223
StructType * getType() const
Specialization - reduce amount of casting.
Definition Constants.h:661
static Constant * getAnon(ArrayRef< Constant * > V, bool Packed=false)
Return an anonymous struct that has the specified elements.
Definition Constants.h:643
This is an important base class in LLVM.
Definition Constant.h:43
bool isNullValue() const
Return true if this is the value that would be returned by getNullValue.
Definition Constant.h:64
LLVM_ABI Constant * getAggregateElement(unsigned Elt) const
For aggregates (struct/array/vector) return the constant that corresponds to the specified element if...
DWARF expression.
iterator_range< expr_op_iterator > expr_ops() const
unsigned getNumElements() const
static LLVM_ABI std::optional< const DIExpression * > convertToNonVariadicExpression(const DIExpression *Expr)
If Expr is a valid single-location expression, i.e.
Subprogram description. Uses SubclassData1.
Wrapper for a function that represents a value that functionally represents the original function.
Definition Constants.h:1143
A parsed version of the target data layout string in and methods for querying it.
Definition DataLayout.h:64
bool isBigEndian() const
Definition DataLayout.h:218
TypeSize getTypeStoreSize(Type *Ty) const
Returns the maximum number of bytes that may be overwritten by storing the specified type.
Definition DataLayout.h:579
A debug info location.
Definition DebugLoc.h:126
iterator find(const_arg_type_t< KeyT > Val)
Definition DenseMap.h:223
bool empty() const
Definition DenseMap.h:171
iterator end()
Definition DenseMap.h:141
Implements a dense probed hash-table based set.
Definition DenseSet.h:281
Collects and handles dwarf debug information.
Definition DwarfDebug.h:352
Emits exception handling directives.
Definition EHStreamer.h:30
bool hasPersonalityFn() const
Check whether this function has a personality function.
Definition Function.h:879
Constant * getPersonalityFn() const
Get the personality function associated with this function.
const Function & getFunction() const
Definition Function.h:166
LLVMContext & getContext() const
getContext - Return a reference to the LLVMContext associated with this function.
Definition Function.cpp:353
GCMetadataPrinter - Emits GC metadata as assembly code.
An analysis pass which caches information about the entire Module.
Definition GCMetadata.h:237
SmallVector< std::unique_ptr< GCStrategy >, 1 >::const_iterator iterator
Definition GCMetadata.h:266
GCStrategy describes a garbage collector algorithm's code generation requirements,...
Definition GCStrategy.h:64
bool usesMetadata() const
If set, appropriate metadata tables must be emitted by the back-end (assembler, JIT,...
Definition GCStrategy.h:120
const std::string & getName() const
Return the name of the GC strategy.
Definition GCStrategy.h:90
LLVM_ABI const GlobalObject * getAliaseeObject() const
Definition Globals.cpp:730
const Constant * getAliasee() const
Definition GlobalAlias.h:87
LLVM_ABI const Function * getResolverFunction() const
Definition Globals.cpp:759
const Constant * getResolver() const
Definition GlobalIFunc.h:73
StringRef getSection() const
Get the custom section of this global if it has one.
bool hasMetadata() const
Return true if this GlobalObject has any metadata attached to it.
bool hasSection() const
Check if this global has a custom object file section.
bool hasLinkOnceLinkage() const
bool hasExternalLinkage() const
bool isDSOLocal() const
bool isThreadLocal() const
If the value is "Thread Local", its value isn't shared by the threads.
VisibilityTypes getVisibility() const
LLVM_ABI bool isDeclaration() const
Return true if the primary definition of this global value is outside of the current translation unit...
Definition Globals.cpp:408
LinkageTypes getLinkage() const
bool hasLocalLinkage() const
static StringRef dropLLVMManglingEscape(StringRef Name)
If the given string begins with the GlobalValue name mangling escape character '\1',...
bool hasPrivateLinkage() const
bool isTagged() const
bool isDeclarationForLinker() const
Module * getParent()
Get the module that this global value is contained inside of...
PointerType * getType() const
Global values are always pointers.
VisibilityTypes
An enumeration for the kinds of visibility of global values.
Definition GlobalValue.h:67
@ DefaultVisibility
The GV is visible.
Definition GlobalValue.h:68
@ HiddenVisibility
The GV is hidden.
Definition GlobalValue.h:69
@ ProtectedVisibility
The GV is protected.
Definition GlobalValue.h:70
LLVM_ABI const DataLayout & getDataLayout() const
Get the data layout of the module this global belongs to.
Definition Globals.cpp:205
LLVM_ABI bool canBenefitFromLocalAlias() const
Definition Globals.cpp:187
bool hasComdat() const
bool hasWeakLinkage() const
bool hasCommonLinkage() const
bool hasGlobalUnnamedAddr() const
bool hasAppendingLinkage() const
static bool isDiscardableIfUnused(LinkageTypes Linkage)
Whether the definition of this global may be discarded if it is not used in its compilation unit.
LLVM_ABI bool canBeOmittedFromSymbolTable() const
True if GV can be left out of the object symbol table.
Definition Globals.cpp:546
bool hasAvailableExternallyLinkage() const
LinkageTypes
An enumeration for the kinds of linkage for global values.
Definition GlobalValue.h:52
@ PrivateLinkage
Like Internal, but omit from symbol table.
Definition GlobalValue.h:61
@ CommonLinkage
Tentative definitions.
Definition GlobalValue.h:63
@ InternalLinkage
Rename collisions when linking (static functions).
Definition GlobalValue.h:60
@ LinkOnceAnyLinkage
Keep one copy of function when linking (inline)
Definition GlobalValue.h:55
@ WeakODRLinkage
Same, but only replaced by something equivalent.
Definition GlobalValue.h:58
@ ExternalLinkage
Externally visible function.
Definition GlobalValue.h:53
@ WeakAnyLinkage
Keep one copy of named function when linking (weak)
Definition GlobalValue.h:57
@ AppendingLinkage
Special purpose, only applies to global arrays.
Definition GlobalValue.h:59
@ AvailableExternallyLinkage
Available for inspection, not emission.
Definition GlobalValue.h:54
@ ExternalWeakLinkage
ExternalWeak linkage description.
Definition GlobalValue.h:62
@ LinkOnceODRLinkage
Same, but only replaced by something equivalent.
Definition GlobalValue.h:56
Type * getValueType() const
const Constant * getInitializer() const
getInitializer - Return the initializer for this global variable.
bool hasInitializer() const
Definitions have initializers, declarations don't.
LLVM_ABI uint64_t getGlobalSize(const DataLayout &DL) const
Get the size of this global variable in bytes.
Definition Globals.cpp:640
bool isConstant() const
If the value is a global constant, its value is immutable throughout the runtime execution of the pro...
Itinerary data supplied by a subtarget to be used by a target.
Class to represent integer types.
static LLVM_ABI IntegerType * get(LLVMContext &C, unsigned NumBits)
This static method is the primary way of constructing an IntegerType.
Definition Type.cpp:348
LLVM_ABI void emitError(const Instruction *I, const Twine &ErrorStr)
emitError - Emit an error message to the currently installed error handler with optional location inf...
This is an alternative analysis pass to MachineBlockFrequencyInfo.
A helper class to return the specified delimiter string after the first invocation of operator String...
bool isInnermost() const
Return true if the loop does not contain any (natural) loops.
BlockT * getHeader() const
unsigned getLoopDepth() const
Return the nesting level of this loop.
LoopT * getParentLoop() const
Return the parent loop if it exists or nullptr for top level loops.
LoopT * getLoopFor(const BlockT *BB) const
Return the inner most loop that BB lives in.
Represents a single loop in the control flow graph.
Definition LoopInfo.h:40
This class is intended to be used as a base class for asm properties and features specific to the tar...
Definition MCAsmInfo.h:66
bool hasWeakDefCanBeHiddenDirective() const
Definition MCAsmInfo.h:635
bool hasSubsectionsViaSymbols() const
Definition MCAsmInfo.h:466
const char * getWeakRefDirective() const
Definition MCAsmInfo.h:633
bool hasIdentDirective() const
Definition MCAsmInfo.h:630
static const MCBinaryExpr * createAdd(const MCExpr *LHS, const MCExpr *RHS, MCContext &Ctx, SMLoc Loc=SMLoc())
Definition MCExpr.h:342
static const MCBinaryExpr * createSub(const MCExpr *LHS, const MCExpr *RHS, MCContext &Ctx)
Definition MCExpr.h:427
static LLVM_ABI const MCConstantExpr * create(int64_t Value, MCContext &Ctx, bool PrintInHex=false, unsigned SizeInBytes=0)
Definition MCExpr.cpp:212
Context object for machine code objects.
Definition MCContext.h:83
Base class for the full range of assembler expressions which are needed for parsing.
Definition MCExpr.h:34
MCFragment * getNext() const
Definition MCSection.h:177
size_t getFixedSize() const
Definition MCSection.h:223
Instances of this class represent a single low-level machine instruction.
Definition MCInst.h:188
unsigned getOpcode() const
Definition MCInst.h:202
void setOpcode(unsigned Op)
Definition MCInst.h:201
Interface to description of machine instruction set.
Definition MCInstrInfo.h:27
MCSection * getTLSBSSSection() const
MCSection * getStackSizesSection(const MCSection &TextSec) const
MCSection * getBBAddrMapSection(const MCSection &TextSec) const
MCSection * getTLSExtraDataSection() const
MCSection * getKCFITrapSection(const MCSection &TextSec) const
MCSection * getPCSection(StringRef Name, const MCSection *TextSec) const
MCSection * getCallGraphSection(const MCSection &TextSec) const
MCSection * getDataSection() const
This represents a section on Windows.
Instances of this class represent a uniqued identifier for a section in the current translation unit.
Definition MCSection.h:573
bool isBssSection() const
Check whether this section is "virtual", that is has no actual object file contents.
Definition MCSection.h:690
static constexpr unsigned NonUniqueID
Definition MCSection.h:578
Streaming machine code generation interface.
Definition MCStreamer.h:222
virtual void emitBinaryData(StringRef Data)
Functionally identical to EmitBytes.
virtual void emitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI)
Emit the given Instruction into the current section.
virtual StringRef getMnemonic(const MCInst &MI) const
Returns the mnemonic for MI, if the streamer has access to a instruction printer and returns an empty...
Definition MCStreamer.h:488
void emitZeros(uint64_t NumBytes)
Emit NumBytes worth of zeros.
Generic base class for all target subtargets.
const MCSchedModel & getSchedModel() const
Get the machine model for this subtarget's CPU.
LLVM_ABI unsigned getBinding() const
static const MCSymbolRefExpr * create(const MCSymbol *Symbol, MCContext &Ctx, SMLoc Loc=SMLoc())
Definition MCExpr.h:213
StringRef getSymbolTableName() const
bool hasRename() const
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition MCSymbol.h:42
bool isDefined() const
isDefined - Check if this symbol is defined (i.e., it has an address).
Definition MCSymbol.h:233
bool isUndefined() const
isUndefined - Check if this symbol undefined (i.e., implicitly defined).
Definition MCSymbol.h:243
StringRef getName() const
getName - Get the symbol name.
Definition MCSymbol.h:188
bool isVariable() const
isVariable - Check if this is a variable symbol.
Definition MCSymbol.h:267
void redefineIfPossible()
Prepare this symbol to be redefined.
Definition MCSymbol.h:212
const MCSymbol * getAddSym() const
Definition MCValue.h:49
int64_t getConstant() const
Definition MCValue.h:44
const MCSymbol * getSubSym() const
Definition MCValue.h:51
bool isAbsolute() const
Is this an absolute (as opposed to relocatable) value.
Definition MCValue.h:54
Metadata node.
Definition Metadata.h:1069
const MDOperand & getOperand(unsigned I) const
Definition Metadata.h:1426
ArrayRef< MDOperand > operands() const
Definition Metadata.h:1424
Tracking metadata reference owned by Metadata.
Definition Metadata.h:891
A single uniqued string.
Definition Metadata.h:722
LLVM_ABI StringRef getString() const
Definition Metadata.cpp:632
LLVM_ABI MCSymbol * getSymbol() const
Return the MCSymbol for this basic block.
int getNumber() const
MachineBasicBlocks are uniquely numbered at the function level, unless they're not in a MachineFuncti...
MachineBlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to estimate machine basic b...
LLVM_ABI BlockFrequency getBlockFreq(const MachineBasicBlock *MBB) const
getblockFreq - Return block frequency.
Legacy MachineFunctionPass for MachineBlockHashInfo.
LLVM_ABI BranchProbability getEdgeProbability(const MachineBasicBlock *Src, const MachineBasicBlock *Dst) const
This class is a data container for one entry in a MachineConstantPool.
union llvm::MachineConstantPoolEntry::@004270020304201266316354007027341142157160323045 Val
The constant itself.
bool isMachineConstantPoolEntry() const
isMachineConstantPoolEntry - Return true if the MachineConstantPoolEntry is indeed a target specific ...
MachineConstantPoolValue * MachineCPVal
Align Alignment
The required alignment for this entry.
LLVM_ABI unsigned getSizeInBytes(const DataLayout &DL) const
LLVM_ABI SectionKind getSectionKind(const DataLayout *DL) const
Abstract base class for all machine specific constantpool value subclasses.
The MachineConstantPool class keeps track of constants referenced by a function which must be spilled...
const std::vector< MachineConstantPoolEntry > & getConstants() const
Analysis pass which computes a MachineDominatorTree.
The MachineFrameInfo class represents an abstract stack frame until prolog/epilog code is inserted.
void getAnalysisUsage(AnalysisUsage &AU) const override
getAnalysisUsage - Subclasses that override getAnalysisUsage must call this.
const TargetSubtargetInfo & getSubtarget() const
getSubtarget - Return the subtarget for which this machine code is being compiled.
DenseMap< const MachineInstr *, CallSiteInfo > CallSiteInfoMap
bool hasBBSections() const
Returns true if this function has basic block sections enabled.
Function & getFunction()
Return the LLVM function that this machine code represents.
const std::vector< LandingPadInfo > & getLandingPads() const
Return a reference to the landing pad info for the current function.
const TargetMachine & getTarget() const
getTarget - Return the target machine this machine code is compiled with
Representation of each machine instruction.
LLVM_ABI unsigned getEntrySize(const DataLayout &TD) const
getEntrySize - Return the size of each entry in the jump table.
@ EK_GPRel32BlockAddress
EK_GPRel32BlockAddress - Each entry is an address of block, encoded with a relocation as gp-relative,...
@ EK_Inline
EK_Inline - Jump table entries are emitted inline at their point of use.
@ EK_LabelDifference32
EK_LabelDifference32 - Each entry is the address of the block minus the address of the jump table.
@ EK_Custom32
EK_Custom32 - Each entry is a 32-bit value that is custom lowered by the TargetLowering::LowerCustomJ...
@ EK_LabelDifference64
EK_LabelDifference64 - Each entry is the address of the block minus the address of the jump table.
@ EK_BlockAddress
EK_BlockAddress - Each entry is a plain address of block, e.g.: .word LBB123.
@ EK_GPRel64BlockAddress
EK_GPRel64BlockAddress - Each entry is an address of block, encoded with a relocation as gp-relative,...
LLVM_ABI unsigned getEntryAlignment(const DataLayout &TD) const
getEntryAlignment - Return the alignment of each entry in the jump table.
const std::vector< MachineJumpTableEntry > & getJumpTables() const
Analysis pass that exposes the MachineLoopInfo for a machine function.
An analysis that produces MachineModuleInfo for a module.
MachineModuleInfoCOFF - This is a MachineModuleInfoImpl implementation for COFF targets.
SymbolListTy GetGVStubList()
Accessor methods to return the set of stubs in sorted order.
MachineModuleInfoELF - This is a MachineModuleInfoImpl implementation for ELF targets.
SymbolListTy GetGVStubList()
Accessor methods to return the set of stubs in sorted order.
std::vector< std::pair< MCSymbol *, StubValueTy > > SymbolListTy
This class contains meta information specific to a module.
MachineOperand class - Representation of each machine instruction operand.
const GlobalValue * getGlobal() const
bool isSymbol() const
isSymbol - Tests if this is a MO_ExternalSymbol operand.
bool isGlobal() const
isGlobal - Tests if this is a MO_GlobalAddress operand.
MachineOperandType getType() const
getType - Returns the MachineOperandType for this operand.
const char * getSymbolName() const
@ MO_Immediate
Immediate operand.
@ MO_GlobalAddress
Address of a global value.
@ MO_CImmediate
Immediate >64bit operand.
@ MO_FrameIndex
Abstract Stack Frame Index.
@ MO_Register
Register operand.
@ MO_ExternalSymbol
Name of external global symbol.
@ MO_TargetIndex
Target-dependent index+offset operand.
@ MO_FPImmediate
Floating-point immediate operand.
Diagnostic information for optimization analysis remarks.
LLVM_ABI void getNameWithPrefix(raw_ostream &OS, const GlobalValue *GV, bool CannotUsePrivateLabel) const
Print the appropriate prefix and the specified global variable's name.
Definition Mangler.cpp:121
This class implements a map that also provides access to all stored values in a deterministic order.
Definition MapVector.h:38
A Module instance is used to store all the information related to an LLVM module.
Definition Module.h:67
A tuple of MDNodes.
Definition Metadata.h:1753
LLVM_ABI unsigned getNumOperands() const
iterator_range< op_iterator > operands()
Definition Metadata.h:1849
Wrapper for a value that won't be replaced with a CFI jump table pointer in LowerTypeTestsModule.
Definition Constants.h:1182
AnalysisType & getAnalysis() const
getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information ...
AnalysisType * getAnalysisIfAvailable() const
getAnalysisIfAvailable<AnalysisType>() - Subclasses use this function to get analysis information tha...
static PointerType * getUnqual(Type *ElementType)
This constructs a pointer to an object of the specified type in the default address space (address sp...
Wrapper class representing virtual and physical registers.
Definition Register.h:20
SimpleRegistryEntry< GCMetadataPrinter, CtorParamTypes... > entry
Definition Registry.h:123
static iterator_range< iterator > entries()
Definition Registry.h:183
Represents a location in source code.
Definition SMLoc.h:22
SectionKind - This is a simple POD value that classifies the properties of a section.
Definition SectionKind.h:22
bool isCommon() const
bool isBSS() const
static SectionKind getReadOnlyWithRel()
bool isBSSLocal() const
bool isThreadBSS() const
bool isThreadLocal() const
bool isThreadData() const
static SectionKind getReadOnly()
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition SmallString.h:26
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
reference emplace_back(ArgTypes &&... Args)
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
int64_t getFixed() const
Returns the fixed component of the stack.
Definition TypeSize.h:46
Represent a constant reference to a string, i.e.
Definition StringRef.h:56
constexpr StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition StringRef.h:597
bool contains(StringRef Other) const
Return true if the given string is a substring of *this, and false otherwise.
Definition StringRef.h:446
size_t find(char C, size_t From=0) const
Search for the first character C in the string.
Definition StringRef.h:290
bool ends_with(StringRef Suffix) const
Check if this string ends with the given Suffix.
Definition StringRef.h:270
Used to lazily calculate structure layout information for a target machine, based on the DataLayout s...
Definition DataLayout.h:743
TypeSize getSizeInBytes() const
Definition DataLayout.h:752
TypeSize getElementOffset(unsigned Idx) const
Definition DataLayout.h:774
Class to represent struct types.
unsigned getNumElements() const
Random access to the elements.
Information about stack frame layout on the target.
virtual StackOffset getFrameIndexReference(const MachineFunction &MF, int FI, Register &FrameReg) const
getFrameIndexReference - This method should return the base register and offset used to reference a f...
TargetInstrInfo - Interface to description of machine instruction set.
@ AllowOverEstimate
Allow the reported instruction size to be larger than the actual size.
@ NoVerify
Do not verify instruction size.
Align getMinFunctionAlignment() const
Return the minimum function alignment.
virtual const MCExpr * lowerDSOLocalEquivalent(const MCSymbol *LHS, const MCSymbol *RHS, int64_t Addend, std::optional< int64_t > PCRelativeOffset, const TargetMachine &TM) const
virtual MCSection * getSectionForCommandLines() const
If supported, return the section to use for the llvm.commandline metadata.
static SectionKind getKindForGlobal(const GlobalObject *GO, const TargetMachine &TM)
Classify the specified global variable into a set of target independent categories embodied in Sectio...
virtual MCSection * getSectionForJumpTable(const Function &F, const TargetMachine &TM) const
virtual bool shouldPutJumpTableInFunctionSection(bool UsesLabelDifference, const Function &F) const
virtual const MCExpr * getIndirectSymViaGOTPCRel(const GlobalValue *GV, const MCSymbol *Sym, const MCValue &MV, int64_t Offset, MachineModuleInfo *MMI, MCStreamer &Streamer) const
Get the target specific PC relative GOT entry relocation.
virtual void emitModuleMetadata(MCStreamer &Streamer, Module &M) const
Emit the module-level metadata that the platform cares about.
virtual MCSection * getSectionForConstant(const DataLayout &DL, SectionKind Kind, const Constant *C, Align &Alignment, const Function *F) const
Given a constant with the SectionKind, return a section that it should be placed in.
virtual const MCExpr * lowerRelativeReference(const GlobalValue *LHS, const GlobalValue *RHS, int64_t Addend, std::optional< int64_t > PCRelativeOffset, const TargetMachine &TM) const
MCSymbol * getSymbolWithGlobalValueBase(const GlobalValue *GV, StringRef Suffix, const TargetMachine &TM) const
Return the MCSymbol for a private symbol with global value name as its base, with the specified suffi...
bool supportGOTPCRelWithOffset() const
Target GOT "PC"-relative relocation supports encoding an additional binary expression with an offset?
bool supportIndirectSymViaGOTPCRel() const
Target supports replacing a data "PC"-relative access to a symbol through another symbol,...
virtual MCSymbol * getFunctionEntryPointSymbol(const GlobalValue *Func, const TargetMachine &TM) const
If supported, return the function entry point symbol.
MCSection * SectionForGlobal(const GlobalObject *GO, SectionKind Kind, const TargetMachine &TM) const
This method computes the appropriate section to emit the specified global variable or function defini...
This class defines information used to lower LLVM code to legal SelectionDAG operators that the targe...
virtual const MCExpr * getPICJumpTableRelocBaseExpr(const MachineFunction *MF, unsigned JTI, MCContext &Ctx) const
This returns the relocation base for the given PIC jumptable, the same as getPICJumpTableRelocBase,...
Primary interface to the complete machine description for the target machine.
const Triple & getTargetTriple() const
TargetOptions Options
unsigned EnableStaticDataPartitioning
Enables the StaticDataSplitter pass.
virtual const TargetFrameLowering * getFrameLowering() const
virtual const TargetInstrInfo * getInstrInfo() const
virtual const TargetRegisterInfo * getRegisterInfo() const =0
Return the target's register information.
virtual const TargetLowering * getTargetLowering() const
Target - Wrapper for Target specific information.
TinyPtrVector - This class is specialized for cases where there are normally 0 or 1 element in a vect...
Triple - Helper class for working with autoconf configuration names.
Definition Triple.h:47
bool isOSBinFormatXCOFF() const
Tests whether the OS uses the XCOFF binary format.
Definition Triple.h:878
bool isOSBinFormatELF() const
Tests whether the OS uses the ELF binary format.
Definition Triple.h:863
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
static LLVM_ABI IntegerType * getInt64Ty(LLVMContext &C)
Definition Type.cpp:310
bool isFloatTy() const
Return true if this is 'float', a 32-bit IEEE fp type.
Definition Type.h:155
bool isBFloatTy() const
Return true if this is 'bfloat', a 16-bit bfloat type.
Definition Type.h:147
bool isPPC_FP128Ty() const
Return true if this is powerpc long double.
Definition Type.h:167
bool isSized(SmallPtrSetImpl< Type * > *Visited=nullptr) const
Return true if it makes sense to take the size of this type.
Definition Type.h:326
bool isHalfTy() const
Return true if this is 'half', a 16-bit IEEE fp type.
Definition Type.h:144
LLVM_ABI void print(raw_ostream &O, bool IsForDebug=false, bool NoDetails=false) const
Print the current type.
bool isDoubleTy() const
Return true if this is 'double', a 64-bit IEEE fp type.
Definition Type.h:158
bool isFunctionTy() const
True if this is an instance of FunctionType.
Definition Type.h:273
Value * getOperand(unsigned i) const
Definition User.h:207
unsigned getNumOperands() const
Definition User.h:229
Value * operator=(Value *RHS)
Definition ValueHandle.h:80
LLVM Value Representation.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:255
LLVM_ABI std::string getNameOrAsOperand() const
Definition Value.cpp:461
bool hasOneUse() const
Return true if there is exactly one use of this value.
Definition Value.h:439
LLVMContext & getContext() const
All values hold a context through their type.
Definition Value.h:258
iterator_range< user_iterator > users()
Definition Value.h:426
User * user_back()
Definition Value.h:412
LLVM_ABI void printAsOperand(raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
Print the name of this Value out to the specified raw_ostream.
LLVM_ABI const Value * stripPointerCasts() const
Strip off pointer casts, all-zero GEPs and address space casts.
Definition Value.cpp:713
bool use_empty() const
Definition Value.h:346
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:319
std::pair< iterator, bool > insert(const ValueT &V)
Definition DenseSet.h:209
bool contains(const_arg_type_t< ValueT > V) const
Check if the set contains the given element.
Definition DenseSet.h:182
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
raw_ostream & indent(unsigned NumSpaces)
indent - Insert 'NumSpaces' spaces.
A raw_ostream that writes to an std::string.
std::string & str()
Returns the string's reference.
A raw_ostream that writes to an SmallVector or SmallString.
StringRef str() const
Return a StringRef for the vector contents.
LLVM_ABI StringRef OperationEncodingString(unsigned Encoding)
Definition Dwarf.cpp:138
This file contains the declaration of the Comdat class, which represents a single COMDAT in LLVM.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
constexpr char Align[]
Key for Kernel::Arg::Metadata::mAlign.
@ IMAGE_SCN_MEM_READ
Definition COFF.h:336
@ IMAGE_SCN_MEM_DISCARDABLE
Definition COFF.h:331
@ IMAGE_SCN_LNK_INFO
Definition COFF.h:307
@ IMAGE_SCN_CNT_INITIALIZED_DATA
Definition COFF.h:304
@ IMAGE_SCN_LNK_COMDAT
Definition COFF.h:309
@ IMAGE_SYM_CLASS_EXTERNAL
External symbol.
Definition COFF.h:224
@ IMAGE_SYM_CLASS_STATIC
Static.
Definition COFF.h:225
@ IMAGE_COMDAT_SELECT_ASSOCIATIVE
Definition COFF.h:459
@ IMAGE_COMDAT_SELECT_ANY
Definition COFF.h:456
@ SafeSEH
Definition COFF.h:847
@ GuardEHCont
Definition COFF.h:855
@ GuardCF
Definition COFF.h:853
@ Kernel
Definition COFF.h:857
@ IMAGE_SYM_DTYPE_NULL
No complex type; simple scalar variable.
Definition COFF.h:274
@ IMAGE_SYM_DTYPE_FUNCTION
A function that returns a base type.
Definition COFF.h:276
@ SCT_COMPLEX_TYPE_SHIFT
Type is formed as (base + (derived << SCT_COMPLEX_TYPE_SHIFT))
Definition COFF.h:280
@ C
The default llvm calling convention, compatible with C.
Definition CallingConv.h:34
@ SHF_ALLOC
Definition ELF.h:1256
@ SHF_LINK_ORDER
Definition ELF.h:1271
@ SHF_GROUP
Definition ELF.h:1278
@ SHF_WRITE
Definition ELF.h:1253
@ SHT_LLVM_JT_SIZES
Definition ELF.h:1196
@ SHT_PROGBITS
Definition ELF.h:1155
@ SHT_LLVM_SYMPART
Definition ELF.h:1188
@ STB_WEAK
Definition ELF.h:1414
@ S_ATTR_LIVE_SUPPORT
S_ATTR_LIVE_SUPPORT - Blocks are live if they reference live blocks.
Definition MachO.h:202
@ Itanium
Windows CE ARM, PowerPC, SH3, SH4.
Definition MCAsmInfo.h:51
@ X86
Windows x64, Windows Itanium (IA-64)
Definition MCAsmInfo.h:52
ValuesClass values(OptsTy... Options)
Helper to build a ValuesClass by forwarding a variable number of arguments as an initializer list to ...
initializer< Ty > init(const Ty &Val)
uint8_t getUnitLengthFieldByteSize(DwarfFormat Format)
Get the byte size of the unit length field depending on the DWARF format.
Definition Dwarf.h:1151
@ DWARF64
Definition Dwarf.h:93
uint8_t getDwarfOffsetByteSize(DwarfFormat Format)
The size of a reference determined by the DWARF 32/64-bit format.
Definition Dwarf.h:1109
std::enable_if_t< detail::IsValidPointer< X, Y >::value, X * > extract(Y &&MD)
Extract a Value from Metadata.
Definition Metadata.h:668
DiagnosticInfoOptimizationBase::Argument NV
uint64_t MD5Hash(const FunctionId &Obj)
Definition FunctionId.h:167
@ OF_Text
The file should be opened in text mode on platforms like z/OS that make this distinction.
Definition FileSystem.h:795
LLVM_ABI std::error_code make_absolute(SmallVectorImpl< char > &path)
Make path an absolute path.
Definition Path.cpp:979
LLVM_ABI StringRef filename(StringRef path LLVM_LIFETIME_BOUND, Style style=Style::native)
Get filename.
Definition Path.cpp:594
This is an optimization pass for GlobalISel generic memory operations.
@ Offset
Definition DWP.cpp:573
void stable_sort(R &&Range)
Definition STLExtras.h:2116
OuterAnalysisManagerProxy< ModuleAnalysisManager, MachineFunction > ModuleAnalysisManagerMachineFunctionProxy
Provide the ModuleAnalysisManager to Function proxy.
LLVM_ABI std::pair< StringRef, StringRef > getToken(StringRef Source, StringRef Delimiters=" \t\n\v\f\r")
getToken - This function extracts one token from source, ignoring any leading characters that appear ...
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
ExceptionHandling
Definition CodeGen.h:53
@ SjLj
setjmp/longjmp based exceptions
Definition CodeGen.h:56
@ ZOS
z/OS MVS Exception Handling.
Definition CodeGen.h:61
@ None
No exception support.
Definition CodeGen.h:54
@ AIX
AIX Exception Handling.
Definition CodeGen.h:60
@ DwarfCFI
DWARF-like instruction based exceptions.
Definition CodeGen.h:55
@ WinEH
Windows Exception Handling.
Definition CodeGen.h:58
@ Wasm
WebAssembly Exception Handling.
Definition CodeGen.h:59
LLVM_ABI bool IsConstantOffsetFromGlobal(Constant *C, GlobalValue *&GV, APInt &Offset, const DataLayout &DL, DSOLocalEquivalent **DSOEquiv=nullptr)
If this constant is a constant offset from a global, return the global and the constant.
void append_range(Container &C, Range &&R)
Wrapper function to append range R to container C.
Definition STLExtras.h:2208
InnerAnalysisManagerProxy< FunctionAnalysisManager, Module > FunctionAnalysisManagerModuleProxy
Provide the FunctionAnalysisManager to Module proxy.
AnalysisManager< MachineFunction > MachineFunctionAnalysisManager
bool isa_and_nonnull(const Y &Val)
Definition Casting.h:676
Op::Description Desc
constexpr int popcount(T Value) noexcept
Count the number of set bits in a value.
Definition bit.h:156
@ MCDR_DataRegionEnd
.end_data_region
@ MCDR_DataRegionJT32
.data_region jt32
bool isNoOpWithoutInvoke(EHPersonality Pers)
Return true if this personality may be safely removed if there are no invoke instructions remaining i...
RelativeUniformCounterPtr ValuesPtrExpr VTableAddr Value
Definition InstrProf.h:143
constexpr T MinAlign(U A, V B)
A and B are either alignments or offsets.
Definition MathExtras.h:357
LLVM_ABI Constant * ConstantFoldConstant(const Constant *C, const DataLayout &DL, const TargetLibraryInfo *TLI=nullptr)
ConstantFoldConstant - Fold the constant using the specified DataLayout.
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:753
auto reverse(ContainerTy &&C)
Definition STLExtras.h:407
void sort(IteratorTy Start, IteratorTy End)
Definition STLExtras.h:1636
LLVM_ABI void setupModuleAsmPrinter(Module &M, ModuleAnalysisManager &MAM, AsmPrinter &AsmPrinter)
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition Debug.cpp:209
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
Definition Error.cpp:163
constexpr uint64_t alignTo(uint64_t Size, Align A)
Returns a multiple of A needed to store Size bytes.
Definition Alignment.h:144
LLVM_ABI SmallString< 128 > getPrefetchTargetSymbolName(StringRef FunctionName, const UniqueBBID &BBID, unsigned CallsiteIndex)
SmallVector< ValueTypeFromRangeType< R >, Size > to_vector(R &&Range)
Given a range of type R, iterate the entire range and return a SmallVector with elements of the vecto...
LLVM_ABI EHPersonality classifyEHPersonality(const Value *Pers)
See if the given exception handling personality function is one that we understand.
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
InnerAnalysisManagerProxy< MachineFunctionAnalysisManager, Function > MachineFunctionAnalysisManagerFunctionProxy
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
Definition Format.h:94
constexpr std::string_view HybridPatchableTargetSuffix
Definition Mangler.h:37
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
@ Global
Append to llvm.global_dtors.
DWARFExpression::Operation Op
ArrayRef(const T &OneElt) -> ArrayRef< T >
constexpr unsigned BitWidth
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1917
LLVM_ABI void setupMachineFunctionAsmPrinter(MachineFunctionAnalysisManager &MFAM, MachineFunction &MF, AsmPrinter &AsmPrinter)
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
auto seq(T Begin, T End)
Iterate over an integral type from Begin up to - but not including - End.
Definition Sequence.h:305
AnalysisManager< Function > FunctionAnalysisManager
Convenience typedef for the Function analysis manager.
@ TypeHash
Token ID based on allocated type hash.
Definition AllocToken.h:32
LLVM_ABI Constant * ConstantFoldIntegerCast(Constant *C, Type *DestTy, bool IsSigned, const DataLayout &DL)
Constant fold a zext, sext or trunc, depending on IsSigned and whether the DestTy is wider or narrowe...
LLVM_ABI Printable printReg(Register Reg, const TargetRegisterInfo *TRI=nullptr, unsigned SubIdx=0, const MachineRegisterInfo *MRI=nullptr)
Prints virtual and physical registers with or without a TRI instance.
@ MCSA_Local
.local (ELF)
@ MCSA_WeakDefAutoPrivate
.weak_def_can_be_hidden (MachO)
@ MCSA_Memtag
.memtag (ELF)
@ MCSA_WeakReference
.weak_reference (MachO)
@ MCSA_AltEntry
.alt_entry (MachO)
@ MCSA_ELF_TypeIndFunction
.type _foo, STT_GNU_IFUNC
@ MCSA_Weak
.weak
@ MCSA_WeakDefinition
.weak_definition (MachO)
@ MCSA_Global
.type _foo, @gnu_unique_object
@ MCSA_Cold
.cold (MachO)
@ MCSA_ELF_TypeObject
.type _foo, STT_OBJECT # aka @object
@ MCSA_ELF_TypeFunction
.type _foo, STT_FUNC # aka @function
@ MCSA_Invalid
Not a valid directive.
@ MCSA_NoDeadStrip
.no_dead_strip (MachO)
AnalysisManager< Module > ModuleAnalysisManager
Convenience typedef for the Module analysis manager.
Definition MIRParser.h:39
constexpr const char * PseudoProbeDescMetadataName
Definition PseudoProbe.h:26
LLVM_ABI void reportFatalUsageError(Error Err)
Report a fatal error that does not indicate a bug in LLVM.
Definition Error.cpp:177
Implement std::hash so that hash_code can be used in STL containers.
Definition BitVector.h:860
void swap(llvm::BitVector &LHS, llvm::BitVector &RHS)
Implement std::swap in terms of BitVector swap.
Definition BitVector.h:862
#define N
#define NC
Definition regutils.h:42
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition Alignment.h:39
A special type used by analysis passes to provide an address that identifies that particular analysis...
Definition Analysis.h:29
Map a basic block section ID to the begin and end symbols of that section which determine the section...
Definition AsmPrinter.h:154
llvm.global_ctors and llvm.global_dtors are arrays of Structor structs.
Definition AsmPrinter.h:547
LLVM_ABI void emit(int, MCStreamer *) const
uint64_t getEdgeCount(const UniqueBBID &SrcBBID, const UniqueBBID &SinkBBID) const
uint64_t getBlockCount(const UniqueBBID &BBID) const
Machine model for scheduling, bundling, and heuristics.
Definition MCSchedule.h:264
static LLVM_ABI int computeInstrLatency(const MCSubtargetInfo &STI, const MCSchedClassDesc &SCDesc)
Returns the latency value for the scheduling class.
This struct is a compact representation of a valid (power of two) or undefined (0) alignment.
Definition Alignment.h:106
A helper struct providing information about the byte size of DW_FORM values that vary in size dependi...
Definition Dwarf.h:1122
This is the base class for a remark serializer.
virtual std::unique_ptr< MetaSerializer > metaSerializer(raw_ostream &OS, StringRef ExternalFilename)=0
Return the corresponding metadata serializer.