1//===- MachineFunction.cpp ------------------------------------------------===//
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// Collect native machine code information for a function. This allows
10// target-specific information about the generated code to be stored with each
11// function.
12//
13//===----------------------------------------------------------------------===//
14
15#include "llvm/CodeGen/MachineFunction.h"
16#include "llvm/ADT/BitVector.h"
17#include "llvm/ADT/DenseMap.h"
18#include "llvm/ADT/DenseSet.h"
19#include "llvm/ADT/STLExtras.h"
20#include "llvm/ADT/SmallString.h"
21#include "llvm/ADT/SmallVector.h"
22#include "llvm/ADT/StringRef.h"
23#include "llvm/ADT/StringSwitch.h"
24#include "llvm/ADT/Twine.h"
25#include "llvm/Analysis/ConstantFolding.h"
26#include "llvm/Analysis/ProfileSummaryInfo.h"
27#include "llvm/CodeGen/MachineBasicBlock.h"
28#include "llvm/CodeGen/MachineConstantPool.h"
29#include "llvm/CodeGen/MachineFrameInfo.h"
30#include "llvm/CodeGen/MachineInstr.h"
31#include "llvm/CodeGen/MachineJumpTableInfo.h"
32#include "llvm/CodeGen/MachineMemOperand.h"
33#include "llvm/CodeGen/MachineModuleInfo.h"
34#include "llvm/CodeGen/MachineRegisterInfo.h"
35#include "llvm/CodeGen/PseudoSourceValue.h"
36#include "llvm/CodeGen/PseudoSourceValueManager.h"
37#include "llvm/CodeGen/TargetFrameLowering.h"
38#include "llvm/CodeGen/TargetInstrInfo.h"
39#include "llvm/CodeGen/TargetLowering.h"
40#include "llvm/CodeGen/TargetRegisterInfo.h"
41#include "llvm/CodeGen/TargetSubtargetInfo.h"
42#include "llvm/CodeGen/WinEHFuncInfo.h"
43#include "llvm/Config/llvm-config.h"
44#include "llvm/IR/Attributes.h"
45#include "llvm/IR/BasicBlock.h"
46#include "llvm/IR/Constant.h"
47#include "llvm/IR/DataLayout.h"
48#include "llvm/IR/DerivedTypes.h"
49#include "llvm/IR/EHPersonalities.h"
50#include "llvm/IR/Function.h"
51#include "llvm/IR/GlobalValue.h"
52#include "llvm/IR/Instruction.h"
53#include "llvm/IR/Instructions.h"
54#include "llvm/IR/Metadata.h"
55#include "llvm/IR/Module.h"
56#include "llvm/IR/ModuleSlotTracker.h"
57#include "llvm/IR/Value.h"
58#include "llvm/MC/MCAsmInfo.h"
59#include "llvm/MC/MCContext.h"
60#include "llvm/MC/MCSymbol.h"
61#include "llvm/MC/SectionKind.h"
62#include "llvm/Support/Casting.h"
63#include "llvm/Support/CommandLine.h"
64#include "llvm/Support/Compiler.h"
65#include "llvm/Support/DOTGraphTraits.h"
66#include "llvm/Support/ErrorHandling.h"
67#include "llvm/Support/FormatVariadic.h"
68#include "llvm/Support/GraphWriter.h"
69#include "llvm/Support/raw_ostream.h"
70#include "llvm/Target/TargetMachine.h"
71#include <algorithm>
72#include <cassert>
73#include <cstddef>
74#include <cstdint>
75#include <iterator>
76#include <string>
77#include <utility>
78#include <vector>
79
80#include "LiveDebugValues/LiveDebugValues.h"
81
82using namespace llvm;
83
84#define DEBUG_TYPE "codegen"
85
86static cl::opt<unsigned> AlignAllFunctions(
87 "align-all-functions",
88 cl::desc("Force the alignment of all functions in log2 format (e.g. 4 "
89 "means align on 16B boundaries)."),
90 cl::init(Val: 0), cl::Hidden);
91
92static const char *getPropertyName(MachineFunctionProperties::Property Prop) {
93 using P = MachineFunctionProperties::Property;
94
95 // clang-format off
96 switch(Prop) {
97 case P::FailedISel: return "FailedISel";
98 case P::IsSSA: return "IsSSA";
99 case P::Legalized: return "Legalized";
100 case P::NoPHIs: return "NoPHIs";
101 case P::NoVRegs: return "NoVRegs";
102 case P::RegBankSelected: return "RegBankSelected";
103 case P::Selected: return "Selected";
104 case P::TracksLiveness: return "TracksLiveness";
105 case P::TiedOpsRewritten: return "TiedOpsRewritten";
106 case P::FailsVerification: return "FailsVerification";
107 case P::FailedRegAlloc: return "FailedRegAlloc";
108 case P::TracksDebugUserValues: return "TracksDebugUserValues";
109 }
110 // clang-format on
111 llvm_unreachable("Invalid machine function property");
112}
113
114void setUnsafeStackSize(const Function &F, MachineFrameInfo &FrameInfo) {
115 if (!F.hasFnAttribute(Kind: Attribute::SafeStack))
116 return;
117
118 FrameInfo.setUnsafeStackSize(
119 F.getFnAttributeAsParsedInteger(Kind: "unsafe-stack-size"));
120}
121
122// Pin the vtable to this file.
123void MachineFunction::Delegate::anchor() {}
124
125void MachineFunctionProperties::print(raw_ostream &OS) const {
126 const char *Separator = "";
127 for (BitVector::size_type I = 0; I < Properties.size(); ++I) {
128 if (!Properties[I])
129 continue;
130 OS << Separator << getPropertyName(Prop: static_cast<Property>(I));
131 Separator = ", ";
132 }
133}
134
135//===----------------------------------------------------------------------===//
136// MachineFunction implementation
137//===----------------------------------------------------------------------===//
138
139// Out-of-line virtual method.
140MachineFunctionInfo::~MachineFunctionInfo() = default;
141
142void ilist_alloc_traits<MachineBasicBlock>::deleteNode(MachineBasicBlock *MBB) {
143 MBB->getParent()->deleteMachineBasicBlock(MBB);
144}
145
146static inline Align getFnStackAlignment(const TargetSubtargetInfo &STI,
147 const Function &F) {
148 if (auto MA = F.getFnStackAlign())
149 return *MA;
150 return STI.getFrameLowering()->getStackAlign();
151}
152
153static FramePointerKind getFramePointerPolicy(const Function &F) {
154 Attribute FPAttr = F.getFnAttribute(Kind: "frame-pointer");
155 if (!FPAttr.isValid())
156 return FramePointerKind::None;
157
158 StringRef FP = FPAttr.getValueAsString();
159 return StringSwitch<FramePointerKind>(FP)
160 .Case(S: "all", Value: FramePointerKind::All)
161 .Case(S: "non-leaf", Value: FramePointerKind::NonLeaf)
162 .Case(S: "non-leaf-no-reserve", Value: FramePointerKind::NonLeafNoReserve)
163 .Case(S: "reserved", Value: FramePointerKind::Reserved)
164 .Case(S: "none", Value: FramePointerKind::None)
165 .Default(Value: FramePointerKind::None);
166}
167
168MachineFunction::MachineFunction(Function &F, const TargetMachine &Target,
169 const TargetSubtargetInfo &STI, MCContext &Ctx,
170 unsigned FunctionNum)
171 : F(F), Target(Target), STI(STI), Ctx(Ctx) {
172 FunctionNumber = FunctionNum;
173 init();
174}
175
176void MachineFunction::handleInsertion(MachineInstr &MI) {
177 if (TheDelegate)
178 TheDelegate->MF_HandleInsertion(MI);
179}
180
181void MachineFunction::handleRemoval(MachineInstr &MI) {
182 if (TheDelegate)
183 TheDelegate->MF_HandleRemoval(MI);
184}
185
186void MachineFunction::handleChangeDesc(MachineInstr &MI,
187 const MCInstrDesc &TID) {
188 if (TheDelegate)
189 TheDelegate->MF_HandleChangeDesc(MI, TID);
190}
191
192void MachineFunction::init() {
193 // Assume the function starts in SSA form with correct liveness.
194 Properties.setIsSSA();
195 Properties.setTracksLiveness();
196 RegInfo = new (Allocator) MachineRegisterInfo(this);
197
198 MFInfo = nullptr;
199
200 // We can realign the stack if the target supports it and the user hasn't
201 // explicitly asked us not to.
202 bool CanRealignSP = STI.getFrameLowering()->isStackRealignable() &&
203 !F.hasFnAttribute(Kind: "no-realign-stack");
204 bool ForceRealignSP = F.hasFnAttribute(Kind: Attribute::StackAlignment) ||
205 F.hasFnAttribute(Kind: "stackrealign");
206 FrameInfo = new (Allocator) MachineFrameInfo(
207 getFnStackAlignment(STI, F), /*StackRealignable=*/CanRealignSP,
208 /*ForcedRealign=*/ForceRealignSP && CanRealignSP);
209 FrameInfo->setFramePointerPolicy(getFramePointerPolicy(F));
210
211 setUnsafeStackSize(F, FrameInfo&: *FrameInfo);
212
213 if (F.hasFnAttribute(Kind: Attribute::StackAlignment))
214 FrameInfo->ensureMaxAlignment(Alignment: *F.getFnStackAlign());
215
216 ConstantPool = new (Allocator) MachineConstantPool(getDataLayout());
217 Alignment = STI.getTargetLowering()->getMinFunctionAlignment();
218
219 // -fsanitize=function and -fsanitize=kcfi instrument indirect function calls
220 // to load a type hash before the function label. Ensure functions are aligned
221 // by a least 4 to avoid unaligned access, which is especially important for
222 // -mno-unaligned-access.
223 if (F.hasMetadata(KindID: LLVMContext::MD_func_sanitize) ||
224 F.getMetadata(KindID: LLVMContext::MD_kcfi_type))
225 Alignment = std::max(a: Alignment, b: Align(4));
226
227 if (AlignAllFunctions)
228 Alignment = Align::fromLog2(Log2Value: AlignAllFunctions);
229
230 JumpTableInfo = nullptr;
231
232 if (isFuncletEHPersonality(Pers: classifyEHPersonality(
233 Pers: F.hasPersonalityFn() ? F.getPersonalityFn() : nullptr))) {
234 WinEHInfo = new (Allocator) WinEHFuncInfo();
235 }
236
237 if (!Target.isCompatibleDataLayout(Candidate: getDataLayout())) {
238 report_fatal_error(
239 reason: formatv(Fmt: "Can't create a MachineFunction using a Module with a "
240 "Target-incompatible DataLayout attached\n Target "
241 "DataLayout: {0}\n Module DataLayout: {1}\n",
242 Vals: Target.createDataLayout().getStringRepresentation(),
243 Vals: getDataLayout().getStringRepresentation()));
244 }
245
246 PSVManager = std::make_unique<PseudoSourceValueManager>(args: getTarget());
247}
248
249void MachineFunction::initTargetMachineFunctionInfo(
250 const TargetSubtargetInfo &STI) {
251 assert(!MFInfo && "MachineFunctionInfo already set");
252 MFInfo = Target.createMachineFunctionInfo(Allocator, F, STI: &STI);
253}
254
255MachineFunctionInfo *MachineFunction::cloneInfoFrom(
256 const MachineFunction &OrigMF,
257 const DenseMap<MachineBasicBlock *, MachineBasicBlock *> &Src2DstMBB) {
258 assert(!MFInfo && "new function already has MachineFunctionInfo");
259 if (!OrigMF.MFInfo)
260 return nullptr;
261
262 MachineFunctionInfo *ClonedInfo =
263 OrigMF.MFInfo->clone(Allocator, DestMF&: *this, Src2DstMBB);
264 if (!ClonedInfo)
265 return nullptr;
266
267 RegInfo->copyPendingVirtRegMapEntriesFrom(Other: OrigMF.getRegInfo());
268 return ClonedInfo;
269}
270
271MachineFunction::~MachineFunction() {
272 clear();
273}
274
275void MachineFunction::clear() {
276 Properties.reset();
277
278 // Clear JumpTableInfo first. Otherwise, every MBB we delete would do a
279 // linear search over the jump table entries to find and erase itself.
280 if (JumpTableInfo) {
281 JumpTableInfo->~MachineJumpTableInfo();
282 Allocator.Deallocate(Ptr: JumpTableInfo);
283 JumpTableInfo = nullptr;
284 }
285
286 // Don't call destructors on MachineInstr and MachineOperand. All of their
287 // memory comes from the BumpPtrAllocator which is about to be purged.
288 //
289 // Do call MachineBasicBlock destructors, it contains std::vectors.
290 for (iterator I = begin(), E = end(); I != E; I = BasicBlocks.erase(where: I))
291 I->Insts.clearAndLeakNodesUnsafely();
292 MBBNumbering.clear();
293
294 InstructionRecycler.clear(Allocator);
295 OperandRecycler.clear(Allocator);
296 BasicBlockRecycler.clear(Allocator);
297 CodeViewAnnotations.clear();
298 VariableDbgInfos.clear();
299 CallSitesInfo.clear();
300 CalledGlobalsInfo.clear();
301 if (RegInfo) {
302 RegInfo->~MachineRegisterInfo();
303 Allocator.Deallocate(Ptr: RegInfo);
304 }
305 if (MFInfo) {
306 MFInfo->~MachineFunctionInfo();
307 Allocator.Deallocate(Ptr: MFInfo);
308 }
309
310 FrameInfo->~MachineFrameInfo();
311 Allocator.Deallocate(Ptr: FrameInfo);
312
313 ConstantPool->~MachineConstantPool();
314 Allocator.Deallocate(Ptr: ConstantPool);
315
316 if (WinEHInfo) {
317 WinEHInfo->~WinEHFuncInfo();
318 Allocator.Deallocate(Ptr: WinEHInfo);
319 }
320}
321
322const DataLayout &MachineFunction::getDataLayout() const {
323 return F.getDataLayout();
324}
325
326/// Get the JumpTableInfo for this function.
327/// If it does not already exist, allocate one.
328MachineJumpTableInfo *MachineFunction::
329getOrCreateJumpTableInfo(unsigned EntryKind) {
330 if (JumpTableInfo) return JumpTableInfo;
331
332 JumpTableInfo = new (Allocator)
333 MachineJumpTableInfo((MachineJumpTableInfo::JTEntryKind)EntryKind);
334 return JumpTableInfo;
335}
336
337DenormalMode MachineFunction::getDenormalMode(const fltSemantics &FPType) const {
338 return F.getDenormalMode(FPType);
339}
340
341/// Should we be emitting segmented stack stuff for the function
342bool MachineFunction::shouldSplitStack() const {
343 return getFunction().hasFnAttribute(Kind: "split-stack");
344}
345
346Align MachineFunction::getPreferredAlignment() const {
347 Align PrefAlignment;
348
349 if (MaybeAlign A = F.getPreferredAlignment())
350 PrefAlignment = *A;
351 else if (!F.hasOptSize())
352 PrefAlignment = STI.getTargetLowering()->getPrefFunctionAlignment();
353 else
354 PrefAlignment = Align(1);
355
356 return std::max(a: PrefAlignment, b: getAlignment());
357}
358
359[[nodiscard]] unsigned
360MachineFunction::addFrameInst(const MCCFIInstruction &Inst) {
361 FrameInstructions.push_back(x: Inst);
362 return FrameInstructions.size() - 1;
363}
364
365void MachineFunction::replaceFrameInstRegister(MCRegister FromReg,
366 MCRegister ToReg) {
367 const MCRegisterInfo *MCRI = Ctx.getRegisterInfo();
368 unsigned DwarfFromReg = MCRI->getDwarfRegNum(Reg: FromReg, isEH: false);
369 unsigned DwarfToReg = MCRI->getDwarfRegNum(Reg: ToReg, isEH: false);
370
371 for (MCCFIInstruction &Inst : FrameInstructions)
372 Inst.replaceRegister(FromReg: DwarfFromReg, ToReg: DwarfToReg);
373}
374
375/// This discards all of the MachineBasicBlock numbers and recomputes them.
376/// This guarantees that the MBB numbers are sequential, dense, and match the
377/// ordering of the blocks within the function. If a specific MachineBasicBlock
378/// is specified, only that block and those after it are renumbered.
379void MachineFunction::RenumberBlocks(MachineBasicBlock *MBB) {
380 if (empty()) { MBBNumbering.clear(); return; }
381 MachineFunction::iterator MBBI, E = end();
382 if (MBB == nullptr)
383 MBBI = begin();
384 else
385 MBBI = MBB->getIterator();
386
387 // Figure out the block number this should have.
388 unsigned BlockNo = 0;
389 if (MBBI != begin())
390 BlockNo = std::prev(x: MBBI)->getNumber() + 1;
391
392 for (; MBBI != E; ++MBBI, ++BlockNo) {
393 if (MBBI->getNumber() != (int)BlockNo) {
394 // Remove use of the old number.
395 if (MBBI->getNumber() != -1) {
396 assert(MBBNumbering[MBBI->getNumber()] == &*MBBI &&
397 "MBB number mismatch!");
398 MBBNumbering[MBBI->getNumber()] = nullptr;
399 }
400
401 // If BlockNo is already taken, set that block's number to -1.
402 if (MBBNumbering[BlockNo])
403 MBBNumbering[BlockNo]->setNumber(-1);
404
405 MBBNumbering[BlockNo] = &*MBBI;
406 MBBI->setNumber(BlockNo);
407 }
408 }
409
410 // Okay, all the blocks are renumbered. If we have compactified the block
411 // numbering, shrink MBBNumbering now.
412 assert(BlockNo <= MBBNumbering.size() && "Mismatch!");
413 MBBNumbering.resize(new_size: BlockNo);
414}
415
416int64_t MachineFunction::estimateFunctionSizeInBytes() {
417 const TargetInstrInfo &TII = *getSubtarget().getInstrInfo();
418 const Align FunctionAlignment = getAlignment();
419 MachineFunction::iterator MBBI = begin(), E = end();
420 /// Offset - Distance from the beginning of the function to the end
421 /// of the basic block.
422 int64_t Offset = 0;
423
424 for (; MBBI != E; ++MBBI) {
425 const Align Alignment = MBBI->getAlignment();
426 int64_t BlockSize = 0;
427
428 for (auto &MI : *MBBI) {
429 BlockSize += TII.getInstSizeInBytes(MI);
430 }
431
432 int64_t OffsetBB;
433 if (Alignment <= FunctionAlignment) {
434 OffsetBB = alignTo(Size: Offset, A: Alignment);
435 } else {
436 // The alignment of this MBB is larger than the function's alignment, so
437 // we can't tell whether or not it will insert nops. Assume that it will.
438 OffsetBB = alignTo(Size: Offset, A: Alignment) + Alignment.value() -
439 FunctionAlignment.value();
440 }
441 Offset = OffsetBB + BlockSize;
442 }
443
444 return Offset;
445}
446
447/// This method iterates over the basic blocks and assigns their IsBeginSection
448/// and IsEndSection fields. This must be called after MBB layout is finalized
449/// and the SectionID's are assigned to MBBs.
450void MachineFunction::assignBeginEndSections() {
451 front().setIsBeginSection();
452 auto CurrentSectionID = front().getSectionID();
453 for (auto MBBI = std::next(x: begin()), E = end(); MBBI != E; ++MBBI) {
454 if (MBBI->getSectionID() == CurrentSectionID)
455 continue;
456 MBBI->setIsBeginSection();
457 std::prev(x: MBBI)->setIsEndSection();
458 CurrentSectionID = MBBI->getSectionID();
459 }
460 back().setIsEndSection();
461}
462
463/// Allocate a new MachineInstr. Use this instead of `new MachineInstr'.
464MachineInstr *MachineFunction::CreateMachineInstr(const MCInstrDesc &MCID,
465 DebugLoc DL,
466 bool NoImplicit) {
467 return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
468 MachineInstr(*this, MCID, std::move(DL), NoImplicit);
469}
470
471/// Create a new MachineInstr which is a copy of the 'Orig' instruction,
472/// identical in all ways except the instruction has no parent, prev, or next.
473MachineInstr *
474MachineFunction::CloneMachineInstr(const MachineInstr *Orig) {
475 return new (InstructionRecycler.Allocate<MachineInstr>(Allocator))
476 MachineInstr(*this, *Orig);
477}
478
479MachineInstr &MachineFunction::cloneMachineInstrBundle(
480 MachineBasicBlock &MBB, MachineBasicBlock::iterator InsertBefore,
481 const MachineInstr &Orig) {
482 MachineInstr *FirstClone = nullptr;
483 MachineBasicBlock::const_instr_iterator I = Orig.getIterator();
484 while (true) {
485 MachineInstr *Cloned = CloneMachineInstr(Orig: &*I);
486 MBB.insert(I: InsertBefore, MI: Cloned);
487 if (FirstClone == nullptr) {
488 FirstClone = Cloned;
489 } else {
490 Cloned->bundleWithPred();
491 }
492
493 if (!I->isBundledWithSucc())
494 break;
495 ++I;
496 }
497 // Copy over call info to the cloned instruction if needed. If Orig is in
498 // a bundle, copyAdditionalCallInfo takes care of finding the call instruction
499 // in the bundle.
500 if (Orig.shouldUpdateAdditionalCallInfo())
501 copyAdditionalCallInfo(Old: &Orig, New: FirstClone);
502 return *FirstClone;
503}
504
505/// Delete the given MachineInstr.
506///
507/// This function also serves as the MachineInstr destructor - the real
508/// ~MachineInstr() destructor must be empty.
509void MachineFunction::deleteMachineInstr(MachineInstr *MI) {
510 // Verify that a call site info is at valid state. This assertion should
511 // be triggered during the implementation of support for the
512 // call site info of a new architecture. If the assertion is triggered,
513 // back trace will tell where to insert a call to updateCallSiteInfo().
514 assert((!MI->isCandidateForAdditionalCallInfo() ||
515 !CallSitesInfo.contains(MI)) &&
516 "Call site info was not updated!");
517 // Verify that the "called globals" info is in a valid state.
518 assert((!MI->isCandidateForAdditionalCallInfo() ||
519 !CalledGlobalsInfo.contains(MI)) &&
520 "Called globals info was not updated!");
521 // Strip it for parts. The operand array and the MI object itself are
522 // independently recyclable.
523 if (MI->Operands)
524 deallocateOperandArray(Cap: MI->CapOperands, Array: MI->Operands);
525 // Don't call ~MachineInstr() which must be trivial anyway because
526 // ~MachineFunction drops whole lists of MachineInstrs wihout calling their
527 // destructors.
528 InstructionRecycler.Deallocate(Allocator, Element: MI);
529}
530
531/// Allocate a new MachineBasicBlock. Use this instead of
532/// `new MachineBasicBlock'.
533MachineBasicBlock *
534MachineFunction::CreateMachineBasicBlock(const BasicBlock *BB,
535 std::optional<UniqueBBID> BBID) {
536 MachineBasicBlock *MBB =
537 new (BasicBlockRecycler.Allocate<MachineBasicBlock>(Allocator))
538 MachineBasicBlock(*this, BB);
539 // Set BBID for `-basic-block-sections=list` and `-basic-block-address-map` to
540 // allow robust mapping of profiles to basic blocks.
541 if (Target.Options.BBAddrMap ||
542 Target.getBBSectionsType() == BasicBlockSection::List)
543 MBB->setBBID(BBID.has_value() ? *BBID : UniqueBBID{.BaseID: NextBBID++, .CloneID: 0});
544 return MBB;
545}
546
547/// Delete the given MachineBasicBlock.
548void MachineFunction::deleteMachineBasicBlock(MachineBasicBlock *MBB) {
549 assert(MBB->getParent() == this && "MBB parent mismatch!");
550 // Clean up any references to MBB in jump tables before deleting it.
551 if (JumpTableInfo)
552 JumpTableInfo->RemoveMBBFromJumpTables(MBB);
553 MBB->~MachineBasicBlock();
554 BasicBlockRecycler.Deallocate(Allocator, Element: MBB);
555}
556
557MachineMemOperand *MachineFunction::getMachineMemOperand(
558 MachinePointerInfo PtrInfo, MachineMemOperand::Flags F, LocationSize Size,
559 Align BaseAlignment, const MMOMetadata &Metadata, SyncScope::ID SSID,
560 AtomicOrdering Ordering, AtomicOrdering FailureOrdering) {
561 assert((!Size.hasValue() ||
562 Size.getValue().getKnownMinValue() != ~UINT64_C(0)) &&
563 "Unexpected an unknown size to be represented using "
564 "LocationSize::beforeOrAfter()");
565 return new (Allocator)
566 MachineMemOperand(PtrInfo, F, Size, BaseAlignment, Metadata, SSID,
567 Ordering, FailureOrdering);
568}
569
570MachineMemOperand *MachineFunction::getMachineMemOperand(
571 MachinePointerInfo PtrInfo, MachineMemOperand::Flags F, LLT MemTy,
572 Align BaseAlignment, const MMOMetadata &Metadata, SyncScope::ID SSID,
573 AtomicOrdering Ordering, AtomicOrdering FailureOrdering) {
574 return new (Allocator)
575 MachineMemOperand(PtrInfo, F, MemTy, BaseAlignment, Metadata, SSID,
576 Ordering, FailureOrdering);
577}
578
579MachineMemOperand *
580MachineFunction::getMachineMemOperand(const MachineMemOperand *MMO,
581 const MachinePointerInfo &PtrInfo,
582 LocationSize Size) {
583 assert((!Size.hasValue() ||
584 Size.getValue().getKnownMinValue() != ~UINT64_C(0)) &&
585 "Unexpected an unknown size to be represented using "
586 "LocationSize::beforeOrAfter()");
587 return new (Allocator) MachineMemOperand(
588 PtrInfo, MMO->getFlags(), Size, MMO->getBaseAlign(),
589 MMOMetadata(AAMDNodes(), /*Ranges=*/nullptr, MMO->getMemCacheHint()),
590 MMO->getSyncScopeID(), MMO->getSuccessOrdering(),
591 MMO->getFailureOrdering());
592}
593
594MachineMemOperand *MachineFunction::getMachineMemOperand(
595 const MachineMemOperand *MMO, const MachinePointerInfo &PtrInfo, LLT Ty) {
596 return new (Allocator) MachineMemOperand(
597 PtrInfo, MMO->getFlags(), Ty, MMO->getBaseAlign(),
598 MMOMetadata(AAMDNodes(), /*Ranges=*/nullptr, MMO->getMemCacheHint()),
599 MMO->getSyncScopeID(), MMO->getSuccessOrdering(),
600 MMO->getFailureOrdering());
601}
602
603MachineMemOperand *
604MachineFunction::getMachineMemOperand(const MachineMemOperand *MMO,
605 int64_t Offset, LLT Ty) {
606 const MachinePointerInfo &PtrInfo = MMO->getPointerInfo();
607
608 // If there is no pointer value, the offset isn't tracked so we need to adjust
609 // the base alignment.
610 Align Alignment = PtrInfo.V.isNull()
611 ? commonAlignment(A: MMO->getBaseAlign(), Offset)
612 : MMO->getBaseAlign();
613
614 // Do not preserve ranges, since we don't necessarily know what the high bits
615 // are anymore.
616 return new (Allocator) MachineMemOperand(
617 PtrInfo.getWithOffset(O: Offset), MMO->getFlags(), Ty, Alignment,
618 MMOMetadata(MMO->getAAInfo(), /*Ranges=*/nullptr, MMO->getMemCacheHint()),
619 MMO->getSyncScopeID(), MMO->getSuccessOrdering(),
620 MMO->getFailureOrdering());
621}
622
623MachineMemOperand *
624MachineFunction::getMachineMemOperand(const MachineMemOperand *MMO,
625 const AAMDNodes &AAInfo) {
626 MachinePointerInfo MPI = MMO->getValue() ?
627 MachinePointerInfo(MMO->getValue(), MMO->getOffset()) :
628 MachinePointerInfo(MMO->getPseudoValue(), MMO->getOffset());
629
630 return new (Allocator) MachineMemOperand(
631 MPI, MMO->getFlags(), MMO->getSize(), MMO->getBaseAlign(),
632 MMOMetadata(AAInfo, MMO->getRanges(), MMO->getMemCacheHint()),
633 MMO->getSyncScopeID(), MMO->getSuccessOrdering(),
634 MMO->getFailureOrdering());
635}
636
637MachineMemOperand *
638MachineFunction::getMachineMemOperand(const MachineMemOperand *MMO,
639 MachineMemOperand::Flags Flags) {
640 return new (Allocator) MachineMemOperand(
641 MMO->getPointerInfo(), Flags, MMO->getSize(), MMO->getBaseAlign(),
642 MMOMetadata(MMO->getAAInfo(), MMO->getRanges(), MMO->getMemCacheHint()),
643 MMO->getSyncScopeID(), MMO->getSuccessOrdering(),
644 MMO->getFailureOrdering());
645}
646
647MachineInstr::ExtraInfo *MachineFunction::createMIExtraInfo(
648 ArrayRef<MachineMemOperand *> MMOs, MCSymbol *PreInstrSymbol,
649 MCSymbol *PostInstrSymbol, MDNode *HeapAllocMarker, MDNode *PCSections,
650 uint32_t CFIType, MDNode *MMRAs, Value *DS) {
651 return MachineInstr::ExtraInfo::create(Allocator, MMOs, PreInstrSymbol,
652 PostInstrSymbol, HeapAllocMarker,
653 PCSections, CFIType, MMRAs, DS);
654}
655
656const char *MachineFunction::createExternalSymbolName(StringRef Name) {
657 char *Dest = Allocator.Allocate<char>(Num: Name.size() + 1);
658 llvm::copy(Range&: Name, Out: Dest);
659 Dest[Name.size()] = 0;
660 return Dest;
661}
662
663uint32_t *MachineFunction::allocateRegMask() {
664 unsigned NumRegs = getSubtarget().getRegisterInfo()->getNumRegs();
665 unsigned Size = MachineOperand::getRegMaskSize(NumRegs);
666 uint32_t *Mask = Allocator.Allocate<uint32_t>(Num: Size);
667 memset(s: Mask, c: 0, n: Size * sizeof(Mask[0]));
668 return Mask;
669}
670
671ArrayRef<int> MachineFunction::allocateShuffleMask(ArrayRef<int> Mask) {
672 int* AllocMask = Allocator.Allocate<int>(Num: Mask.size());
673 copy(Range&: Mask, Out: AllocMask);
674 return {AllocMask, Mask.size()};
675}
676
677#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
678LLVM_DUMP_METHOD void MachineFunction::dump() const {
679 print(dbgs());
680}
681#endif
682
683StringRef MachineFunction::getName() const {
684 return getFunction().getName();
685}
686
687void MachineFunction::print(raw_ostream &OS, const SlotIndexes *Indexes) const {
688 OS << "# Machine code for function " << getName() << ": ";
689 getProperties().print(OS);
690 OS << '\n';
691
692 // Print Frame Information
693 FrameInfo->print(MF: *this, OS);
694
695 // Print JumpTable Information
696 if (JumpTableInfo)
697 JumpTableInfo->print(OS);
698
699 // Print Constant Pool
700 ConstantPool->print(OS);
701
702 const TargetRegisterInfo *TRI = getSubtarget().getRegisterInfo();
703
704 if (RegInfo && !RegInfo->livein_empty()) {
705 OS << "Function Live Ins: ";
706 for (MachineRegisterInfo::livein_iterator
707 I = RegInfo->livein_begin(), E = RegInfo->livein_end(); I != E; ++I) {
708 OS << printReg(Reg: I->first, TRI);
709 if (I->second)
710 OS << " in " << printReg(Reg: I->second, TRI);
711 if (std::next(x: I) != E)
712 OS << ", ";
713 }
714 OS << '\n';
715 }
716
717 ModuleSlotTracker MST(getFunction().getParent());
718 MST.incorporateFunction(F: getFunction());
719 for (const auto &BB : *this) {
720 OS << '\n';
721 // If we print the whole function, print it at its most verbose level.
722 BB.print(OS, MST, Indexes, /*IsStandalone=*/true);
723 }
724
725 OS << "\n# End machine code for function " << getName() << ".\n\n";
726}
727
728/// True if this function needs frame moves for debug or exceptions.
729bool MachineFunction::needsFrameMoves() const {
730 // TODO: Ideally, what we'd like is to have a switch that allows emitting
731 // synchronous (precise at call-sites only) CFA into .eh_frame. However, even
732 // under this switch, we'd like .debug_frame to be precise when using -g. At
733 // this moment, there's no way to specify that some CFI directives go into
734 // .eh_frame only, while others go into .debug_frame only.
735 return getTarget().Options.ForceDwarfFrameSection ||
736 F.needsUnwindTableEntry() ||
737 !F.getParent()->debug_compile_units().empty();
738}
739
740bool MachineFunction::usesWindowsUnwindInfo() const {
741 return getTarget().getMCAsmInfo().usesWindowsCFI() &&
742 F.getParent()->getExceptionModel() == ExceptionHandling::WinEH;
743}
744
745bool MachineFunction::needsWinCFI() const {
746 return getFunction().needsUnwindTableEntry() && usesWindowsUnwindInfo();
747}
748
749bool MachineFunction::disableFramePointerElim() const {
750 FramePointerKind FP = getFrameInfo().getFramePointerPolicy();
751 switch (FP) {
752 case FramePointerKind::All:
753 return true;
754 case FramePointerKind::NonLeaf:
755 case FramePointerKind::NonLeafNoReserve:
756 return getFrameInfo().hasCalls();
757 case FramePointerKind::None:
758 case FramePointerKind::Reserved:
759 return false;
760 }
761 llvm_unreachable("unknown frame pointer flag");
762}
763
764bool MachineFunction::framePointerIsReserved() const {
765 FramePointerKind FP = getFrameInfo().getFramePointerPolicy();
766 switch (FP) {
767 case FramePointerKind::All:
768 case FramePointerKind::NonLeaf:
769 case FramePointerKind::Reserved:
770 return true;
771 case FramePointerKind::NonLeafNoReserve:
772 return getFrameInfo().hasCalls();
773 case FramePointerKind::None:
774 return false;
775 }
776 llvm_unreachable("unknown frame pointer flag");
777}
778
779MachineFunction::CallSiteInfo::CallSiteInfo(const CallBase &CB) {
780 if (MDNode *Node = CB.getMetadata(KindID: llvm::LLVMContext::MD_call_target))
781 CallTarget = Node;
782
783 // Numeric callee_type ids are only for indirect calls.
784 if (!CB.isIndirectCall())
785 return;
786
787 MDNode *CalleeTypeList = CB.getMetadata(KindID: LLVMContext::MD_callee_type);
788 if (!CalleeTypeList)
789 return;
790
791 for (const MDOperand &Op : CalleeTypeList->operands()) {
792 MDNode *TypeMD = cast<MDNode>(Val: Op);
793 MDString *TypeIdStr = cast<MDString>(Val: TypeMD->getOperand(I: 0));
794 // Compute numeric type id from type id string
795 uint64_t TypeIdVal = MD5Hash(Str: TypeIdStr->getString());
796 IntegerType *Int64Ty = Type::getInt64Ty(C&: CB.getContext());
797 CalleeTypeIds.push_back(
798 Elt: ConstantInt::get(Ty: Int64Ty, V: TypeIdVal, /*IsSigned=*/false));
799 }
800}
801
802template <>
803struct llvm::DOTGraphTraits<const MachineFunction *>
804 : public DefaultDOTGraphTraits {
805 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
806
807 static std::string getGraphName(const MachineFunction *F) {
808 return ("CFG for '" + F->getName() + "' function").str();
809 }
810
811 std::string getNodeLabel(const MachineBasicBlock *Node,
812 const MachineFunction *Graph) {
813 std::string OutStr;
814 {
815 raw_string_ostream OSS(OutStr);
816
817 if (isSimple()) {
818 OSS << printMBBReference(MBB: *Node);
819 if (const BasicBlock *BB = Node->getBasicBlock())
820 OSS << ": " << BB->getName();
821 } else
822 Node->print(OS&: OSS);
823 }
824
825 if (OutStr[0] == '\n')
826 OutStr.erase(position: OutStr.begin());
827
828 // Process string output to make it nicer...
829 for (unsigned i = 0; i != OutStr.length(); ++i)
830 if (OutStr[i] == '\n') { // Left justify
831 OutStr[i] = '\\';
832 OutStr.insert(p: OutStr.begin() + i + 1, c: 'l');
833 }
834 return OutStr;
835 }
836};
837
838void MachineFunction::viewCFG() const
839{
840#ifndef NDEBUG
841 ViewGraph(this, "mf" + getName());
842#else
843 errs() << "MachineFunction::viewCFG is only available in debug builds on "
844 << "systems with Graphviz or gv!\n";
845#endif // NDEBUG
846}
847
848void MachineFunction::viewCFGOnly() const
849{
850#ifndef NDEBUG
851 ViewGraph(this, "mf" + getName(), true);
852#else
853 errs() << "MachineFunction::viewCFGOnly is only available in debug builds on "
854 << "systems with Graphviz or gv!\n";
855#endif // NDEBUG
856}
857
858/// Add the specified physical register as a live-in value and
859/// create a corresponding virtual register for it.
860Register MachineFunction::addLiveIn(MCRegister PReg,
861 const TargetRegisterClass *RC) {
862 MachineRegisterInfo &MRI = getRegInfo();
863 Register VReg = MRI.getLiveInVirtReg(PReg);
864 if (VReg) {
865 const TargetRegisterClass *VRegRC = MRI.getRegClass(Reg: VReg);
866 (void)VRegRC;
867 // A physical register can be added several times.
868 // Between two calls, the register class of the related virtual register
869 // may have been constrained to match some operation constraints.
870 // In that case, check that the current register class includes the
871 // physical register and is a sub class of the specified RC.
872 assert((VRegRC == RC || (VRegRC->contains(PReg) &&
873 RC->hasSubClassEq(VRegRC))) &&
874 "Register class mismatch!");
875 return VReg;
876 }
877 VReg = MRI.createVirtualRegister(RegClass: RC);
878 MRI.addLiveIn(Reg: PReg, vreg: VReg);
879 return VReg;
880}
881
882/// Return the MCSymbol for the specified non-empty jump table.
883/// If isLinkerPrivate is specified, an 'l' label is returned, otherwise a
884/// normal 'L' label is returned.
885MCSymbol *MachineFunction::getJTISymbol(unsigned JTI, MCContext &Ctx,
886 bool isLinkerPrivate) const {
887 const DataLayout &DL = getDataLayout();
888 assert(JumpTableInfo && "No jump tables");
889 assert(JTI < JumpTableInfo->getJumpTables().size() && "Invalid JTI!");
890
891 StringRef Prefix = isLinkerPrivate ? DL.getLinkerPrivateGlobalPrefix()
892 : DL.getInternalSymbolPrefix();
893 SmallString<60> Name;
894 raw_svector_ostream(Name)
895 << Prefix << "JTI" << getFunctionNumber() << '_' << JTI;
896 return Ctx.getOrCreateSymbol(Name);
897}
898
899/// Return a function-local symbol to represent the PIC base.
900MCSymbol *MachineFunction::getPICBaseSymbol() const {
901 const DataLayout &DL = getDataLayout();
902 return Ctx.getOrCreateSymbol(Name: Twine(DL.getInternalSymbolPrefix()) +
903 Twine(getFunctionNumber()) + "$pb");
904}
905
906/// \name Exception Handling
907/// \{
908
909LandingPadInfo &
910MachineFunction::getOrCreateLandingPadInfo(MachineBasicBlock *LandingPad) {
911 unsigned N = LandingPads.size();
912 for (unsigned i = 0; i < N; ++i) {
913 LandingPadInfo &LP = LandingPads[i];
914 if (LP.LandingPadBlock == LandingPad)
915 return LP;
916 }
917
918 LandingPads.push_back(x: LandingPadInfo(LandingPad));
919 return LandingPads[N];
920}
921
922void MachineFunction::addInvoke(MachineBasicBlock *LandingPad,
923 MCSymbol *BeginLabel, MCSymbol *EndLabel) {
924 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
925 LP.BeginLabels.push_back(Elt: BeginLabel);
926 LP.EndLabels.push_back(Elt: EndLabel);
927}
928
929MCSymbol *MachineFunction::addLandingPad(MachineBasicBlock *LandingPad) {
930 MCSymbol *LandingPadLabel = Ctx.createTempSymbol();
931 LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
932 LP.LandingPadLabel = LandingPadLabel;
933
934 BasicBlock::const_iterator FirstI =
935 LandingPad->getBasicBlock()->getFirstNonPHIIt();
936 if (const auto *LPI = dyn_cast<LandingPadInst>(Val&: FirstI)) {
937 // If there's no typeid list specified, then "cleanup" is implicit.
938 // Otherwise, id 0 is reserved for the cleanup action.
939 if (LPI->isCleanup() && LPI->getNumClauses() != 0)
940 LP.TypeIds.push_back(x: 0);
941
942 // FIXME: New EH - Add the clauses in reverse order. This isn't 100%
943 // correct, but we need to do it this way because of how the DWARF EH
944 // emitter processes the clauses.
945 for (unsigned I = LPI->getNumClauses(); I != 0; --I) {
946 Value *Val = LPI->getClause(Idx: I - 1);
947 if (LPI->isCatch(Idx: I - 1)) {
948 LP.TypeIds.push_back(
949 x: getTypeIDFor(TI: dyn_cast<GlobalValue>(Val: Val->stripPointerCasts())));
950 } else {
951 // Add filters in a list.
952 auto *CVal = cast<Constant>(Val);
953 SmallVector<unsigned, 4> FilterList;
954 for (const Use &U : CVal->operands())
955 FilterList.push_back(
956 Elt: getTypeIDFor(TI: cast<GlobalValue>(Val: U->stripPointerCasts())));
957
958 LP.TypeIds.push_back(x: getFilterIDFor(TyIds: FilterList));
959 }
960 }
961
962 } else if (const auto *CPI = dyn_cast<CatchPadInst>(Val&: FirstI)) {
963 for (unsigned I = CPI->arg_size(); I != 0; --I) {
964 auto *TypeInfo =
965 dyn_cast<GlobalValue>(Val: CPI->getArgOperand(i: I - 1)->stripPointerCasts());
966 LP.TypeIds.push_back(x: getTypeIDFor(TI: TypeInfo));
967 }
968
969 } else {
970 assert(isa<CleanupPadInst>(FirstI) && "Invalid landingpad!");
971 }
972
973 return LandingPadLabel;
974}
975
976void MachineFunction::setCallSiteLandingPad(MCSymbol *Sym,
977 ArrayRef<unsigned> Sites) {
978 LPadToCallSiteMap[Sym].append(in_start: Sites.begin(), in_end: Sites.end());
979}
980
981unsigned MachineFunction::getTypeIDFor(const GlobalValue *TI) {
982 for (unsigned i = 0, N = TypeInfos.size(); i != N; ++i)
983 if (TypeInfos[i] == TI) return i + 1;
984
985 TypeInfos.push_back(x: TI);
986 return TypeInfos.size();
987}
988
989int MachineFunction::getFilterIDFor(ArrayRef<unsigned> TyIds) {
990 // If the new filter coincides with the tail of an existing filter, then
991 // re-use the existing filter. Folding filters more than this requires
992 // re-ordering filters and/or their elements - probably not worth it.
993 for (unsigned i : FilterEnds) {
994 unsigned j = TyIds.size();
995
996 while (i && j)
997 if (FilterIds[--i] != TyIds[--j])
998 goto try_next;
999
1000 if (!j)
1001 // The new filter coincides with range [i, end) of the existing filter.
1002 return -(1 + i);
1003
1004try_next:;
1005 }
1006
1007 // Add the new filter.
1008 int FilterID = -(1 + FilterIds.size());
1009 FilterIds.reserve(n: FilterIds.size() + TyIds.size() + 1);
1010 llvm::append_range(C&: FilterIds, R&: TyIds);
1011 FilterEnds.push_back(x: FilterIds.size());
1012 FilterIds.push_back(x: 0); // terminator
1013 return FilterID;
1014}
1015
1016MachineFunction::CallSiteInfoMap::iterator
1017MachineFunction::getCallSiteInfo(const MachineInstr *MI) {
1018 assert(MI->isCandidateForAdditionalCallInfo() &&
1019 "Call site info refers only to call (MI) candidates");
1020
1021 if (!Target.Options.EmitCallSiteInfo && !Target.Options.EmitCallGraphSection)
1022 return CallSitesInfo.end();
1023 return CallSitesInfo.find(Val: MI);
1024}
1025
1026/// Return the call machine instruction or find a call within bundle.
1027static const MachineInstr *getCallInstr(const MachineInstr *MI) {
1028 if (!MI->isBundle())
1029 return MI;
1030
1031 for (const auto &BMI : make_range(x: getBundleStart(I: MI->getIterator()),
1032 y: getBundleEnd(I: MI->getIterator())))
1033 if (BMI.isCandidateForAdditionalCallInfo())
1034 return &BMI;
1035
1036 llvm_unreachable("Unexpected bundle without a call site candidate");
1037}
1038
1039void MachineFunction::eraseAdditionalCallInfo(const MachineInstr *MI) {
1040 assert(MI->shouldUpdateAdditionalCallInfo() &&
1041 "Call info refers only to call (MI) candidates or "
1042 "candidates inside bundles");
1043
1044 const MachineInstr *CallMI = getCallInstr(MI);
1045
1046 CallSiteInfoMap::iterator CSIt = getCallSiteInfo(MI: CallMI);
1047 if (CSIt != CallSitesInfo.end())
1048 CallSitesInfo.erase(I: CSIt);
1049
1050 CalledGlobalsInfo.erase(Val: CallMI);
1051}
1052
1053void MachineFunction::copyAdditionalCallInfo(const MachineInstr *Old,
1054 const MachineInstr *New) {
1055 assert(Old->shouldUpdateAdditionalCallInfo() &&
1056 "Call info refers only to call (MI) candidates or "
1057 "candidates inside bundles");
1058
1059 if (!New->isCandidateForAdditionalCallInfo())
1060 return eraseAdditionalCallInfo(MI: Old);
1061
1062 const MachineInstr *OldCallMI = getCallInstr(MI: Old);
1063 CallSiteInfoMap::iterator CSIt = getCallSiteInfo(MI: OldCallMI);
1064 if (CSIt != CallSitesInfo.end()) {
1065 CallSiteInfo CSInfo = CSIt->second;
1066 CallSitesInfo[New] = std::move(CSInfo);
1067 }
1068
1069 CalledGlobalsMap::iterator CGIt = CalledGlobalsInfo.find(Val: OldCallMI);
1070 if (CGIt != CalledGlobalsInfo.end()) {
1071 CalledGlobalInfo CGInfo = CGIt->second;
1072 CalledGlobalsInfo[New] = std::move(CGInfo);
1073 }
1074}
1075
1076void MachineFunction::moveAdditionalCallInfo(const MachineInstr *Old,
1077 const MachineInstr *New) {
1078 assert(Old->shouldUpdateAdditionalCallInfo() &&
1079 "Call info refers only to call (MI) candidates or "
1080 "candidates inside bundles");
1081
1082 if (!New->isCandidateForAdditionalCallInfo())
1083 return eraseAdditionalCallInfo(MI: Old);
1084
1085 const MachineInstr *OldCallMI = getCallInstr(MI: Old);
1086 CallSiteInfoMap::iterator CSIt = getCallSiteInfo(MI: OldCallMI);
1087 if (CSIt != CallSitesInfo.end()) {
1088 CallSiteInfo CSInfo = std::move(CSIt->second);
1089 CallSitesInfo.erase(I: CSIt);
1090 CallSitesInfo[New] = std::move(CSInfo);
1091 }
1092
1093 CalledGlobalsMap::iterator CGIt = CalledGlobalsInfo.find(Val: OldCallMI);
1094 if (CGIt != CalledGlobalsInfo.end()) {
1095 CalledGlobalInfo CGInfo = std::move(CGIt->second);
1096 CalledGlobalsInfo.erase(I: CGIt);
1097 CalledGlobalsInfo[New] = std::move(CGInfo);
1098 }
1099}
1100
1101void MachineFunction::setDebugInstrNumberingCount(unsigned Num) {
1102 DebugInstrNumberingCount = Num;
1103}
1104
1105void MachineFunction::makeDebugValueSubstitution(DebugInstrOperandPair A,
1106 DebugInstrOperandPair B,
1107 unsigned Subreg) {
1108 // Catch any accidental self-loops.
1109 assert(A.first != B.first);
1110 // Don't allow any substitutions _from_ the memory operand number.
1111 assert(A.second != DebugOperandMemNumber);
1112
1113 DebugValueSubstitutions.push_back(Elt: {A, B, Subreg});
1114}
1115
1116void MachineFunction::substituteDebugValuesForInst(const MachineInstr &Old,
1117 MachineInstr &New,
1118 unsigned MaxOperand) {
1119 // If the Old instruction wasn't tracked at all, there is no work to do.
1120 unsigned OldInstrNum = Old.peekDebugInstrNum();
1121 if (!OldInstrNum)
1122 return;
1123
1124 // Iterate over all operands looking for defs to create substitutions for.
1125 // Avoid creating new instr numbers unless we create a new substitution.
1126 // While this has no functional effect, it risks confusing someone reading
1127 // MIR output.
1128 // Examine all the operands, or the first N specified by the caller.
1129 MaxOperand = std::min(a: MaxOperand, b: Old.getNumOperands());
1130 for (unsigned int I = 0; I < MaxOperand; ++I) {
1131 const auto &OldMO = Old.getOperand(i: I);
1132 auto &NewMO = New.getOperand(i: I);
1133 (void)NewMO;
1134
1135 if (!OldMO.isReg() || !OldMO.isDef())
1136 continue;
1137 assert(NewMO.isDef());
1138
1139 unsigned NewInstrNum = New.getDebugInstrNum();
1140 makeDebugValueSubstitution(A: std::make_pair(x&: OldInstrNum, y&: I),
1141 B: std::make_pair(x&: NewInstrNum, y&: I));
1142 }
1143}
1144
1145auto MachineFunction::salvageCopySSA(
1146 MachineInstr &MI, DenseMap<Register, DebugInstrOperandPair> &DbgPHICache)
1147 -> DebugInstrOperandPair {
1148 const TargetInstrInfo &TII = *getSubtarget().getInstrInfo();
1149
1150 // Check whether this copy-like instruction has already been salvaged into
1151 // an operand pair.
1152 Register Dest;
1153 if (auto CopyDstSrc = TII.isCopyLikeInstr(MI)) {
1154 Dest = CopyDstSrc->Destination->getReg();
1155 } else {
1156 assert(MI.isSubregToReg());
1157 Dest = MI.getOperand(i: 0).getReg();
1158 }
1159
1160 auto CacheIt = DbgPHICache.find(Val: Dest);
1161 if (CacheIt != DbgPHICache.end())
1162 return CacheIt->second;
1163
1164 // Calculate the instruction number to use, or install a DBG_PHI.
1165 auto OperandPair = salvageCopySSAImpl(MI);
1166 DbgPHICache.insert(KV: {Dest, OperandPair});
1167 return OperandPair;
1168}
1169
1170auto MachineFunction::salvageCopySSAImpl(MachineInstr &MI)
1171 -> DebugInstrOperandPair {
1172 MachineRegisterInfo &MRI = getRegInfo();
1173 const TargetRegisterInfo &TRI = *MRI.getTargetRegisterInfo();
1174 const TargetInstrInfo &TII = *getSubtarget().getInstrInfo();
1175
1176 // Chase the value read by a copy-like instruction back to the instruction
1177 // that ultimately _defines_ that value. This may pass:
1178 // * Through multiple intermediate copies, including subregister moves /
1179 // copies,
1180 // * Copies from physical registers that must then be traced back to the
1181 // defining instruction,
1182 // * Or, physical registers may be live-in to (only) the entry block, which
1183 // requires a DBG_PHI to be created.
1184 // We can pursue this problem in that order: trace back through copies,
1185 // optionally through a physical register, to a defining instruction. We
1186 // should never move from physreg to vreg. As we're still in SSA form, no need
1187 // to worry about partial definitions of registers.
1188
1189 // Helper lambda to interpret a copy-like instruction. Takes instruction,
1190 // returns the register read and any subregister identifying which part is
1191 // read.
1192 auto GetRegAndSubreg =
1193 [&](const MachineInstr &Cpy) -> std::pair<Register, unsigned> {
1194 Register NewReg, OldReg;
1195 unsigned SubReg;
1196 if (Cpy.isCopy()) {
1197 OldReg = Cpy.getOperand(i: 0).getReg();
1198 NewReg = Cpy.getOperand(i: 1).getReg();
1199 SubReg = Cpy.getOperand(i: 1).getSubReg();
1200 } else if (Cpy.isSubregToReg()) {
1201 OldReg = Cpy.getOperand(i: 0).getReg();
1202 NewReg = Cpy.getOperand(i: 1).getReg();
1203 SubReg = Cpy.getOperand(i: 2).getImm();
1204 } else {
1205 auto CopyDetails = *TII.isCopyInstr(MI: Cpy);
1206 const MachineOperand &Src = *CopyDetails.Source;
1207 const MachineOperand &Dest = *CopyDetails.Destination;
1208 OldReg = Dest.getReg();
1209 NewReg = Src.getReg();
1210 SubReg = Src.getSubReg();
1211 }
1212
1213 return {NewReg, SubReg};
1214 };
1215
1216 // First seek either the defining instruction, or a copy from a physreg.
1217 // During search, the current state is the current copy instruction, and which
1218 // register we've read. Accumulate qualifying subregisters into SubregsSeen;
1219 // deal with those later.
1220 auto State = GetRegAndSubreg(MI);
1221 auto CurInst = MI.getIterator();
1222 SmallVector<unsigned, 4> SubregsSeen;
1223 while (true) {
1224 // If we've found a copy from a physreg, first portion of search is over.
1225 if (!State.first.isVirtual())
1226 break;
1227
1228 // Record any subregister qualifier.
1229 if (State.second)
1230 SubregsSeen.push_back(Elt: State.second);
1231
1232 MachineInstr *Inst = MRI.getVRegDef(Reg: State.first);
1233 assert(Inst && "Virtual register has no def");
1234 CurInst = Inst->getIterator();
1235
1236 // Any non-copy instruction is the defining instruction we're seeking.
1237 if (!Inst->isCopyLike() && !TII.isCopyLikeInstr(MI: *Inst))
1238 break;
1239 State = GetRegAndSubreg(*Inst);
1240 };
1241
1242 // Helper lambda to apply additional subregister substitutions to a known
1243 // instruction/operand pair. Adds new (fake) substitutions so that we can
1244 // record the subregister. FIXME: this isn't very space efficient if multiple
1245 // values are tracked back through the same copies; cache something later.
1246 auto ApplySubregisters =
1247 [&](DebugInstrOperandPair P) -> DebugInstrOperandPair {
1248 for (unsigned Subreg : reverse(C&: SubregsSeen)) {
1249 // Fetch a new instruction number, not attached to an actual instruction.
1250 unsigned NewInstrNumber = getNewDebugInstrNum();
1251 // Add a substitution from the "new" number to the known one, with a
1252 // qualifying subreg.
1253 makeDebugValueSubstitution(A: {NewInstrNumber, 0}, B: P, Subreg);
1254 // Return the new number; to find the underlying value, consumers need to
1255 // deal with the qualifying subreg.
1256 P = {NewInstrNumber, 0};
1257 }
1258 return P;
1259 };
1260
1261 // If we managed to find the defining instruction after COPYs, return an
1262 // instruction / operand pair after adding subregister qualifiers.
1263 if (State.first.isVirtual()) {
1264 // Virtual register def -- we can just look up where this happens.
1265 MachineInstr *Inst = MRI.getVRegDef(Reg: State.first);
1266 for (auto &MO : Inst->all_defs()) {
1267 if (MO.getReg() != State.first)
1268 continue;
1269 return ApplySubregisters({Inst->getDebugInstrNum(), MO.getOperandNo()});
1270 }
1271
1272 llvm_unreachable("Vreg def with no corresponding operand?");
1273 }
1274
1275 // Our search ended in a copy from a physreg: walk back up the function
1276 // looking for whatever defines the physreg.
1277 assert(CurInst->isCopyLike() || TII.isCopyInstr(*CurInst));
1278 State = GetRegAndSubreg(*CurInst);
1279 Register RegToSeek = State.first;
1280
1281 auto RMII = CurInst->getReverseIterator();
1282 auto PrevInstrs = make_range(x: RMII, y: CurInst->getParent()->instr_rend());
1283 for (auto &ToExamine : PrevInstrs) {
1284 for (auto &MO : ToExamine.all_defs()) {
1285 // Test for operand that defines something aliasing RegToSeek.
1286 if (!TRI.regsOverlap(RegA: RegToSeek, RegB: MO.getReg()))
1287 continue;
1288
1289 return ApplySubregisters(
1290 {ToExamine.getDebugInstrNum(), MO.getOperandNo()});
1291 }
1292 }
1293
1294 MachineBasicBlock &InsertBB = *CurInst->getParent();
1295
1296 // We reached the start of the block before finding a defining instruction.
1297 // There are numerous scenarios where this can happen:
1298 // * Constant physical registers,
1299 // * Several intrinsics that allow LLVM-IR to read arbitary registers,
1300 // * Arguments in the entry block,
1301 // * Exception handling landing pads.
1302 // Validating all of them is too difficult, so just insert a DBG_PHI reading
1303 // the variable value at this position, rather than checking it makes sense.
1304
1305 // Create DBG_PHI for specified physreg.
1306 auto Builder = BuildMI(BB&: InsertBB, I: InsertBB.getFirstNonPHI(), MIMD: DebugLoc(),
1307 MCID: TII.get(Opcode: TargetOpcode::DBG_PHI));
1308 Builder.addReg(RegNo: State.first);
1309 unsigned NewNum = getNewDebugInstrNum();
1310 Builder.addImm(Val: NewNum);
1311 return ApplySubregisters({NewNum, 0u});
1312}
1313
1314void MachineFunction::finalizeDebugInstrRefs() {
1315 auto *TII = getSubtarget().getInstrInfo();
1316
1317 auto MakeUndefDbgValue = [&](MachineInstr &MI) {
1318 const MCInstrDesc &RefII = TII->get(Opcode: TargetOpcode::DBG_VALUE_LIST);
1319 MI.setDesc(RefII);
1320 MI.setDebugValueUndef();
1321 };
1322
1323 DenseMap<Register, DebugInstrOperandPair> ArgDbgPHIs;
1324 for (auto &MBB : *this) {
1325 for (auto &MI : MBB) {
1326 if (!MI.isDebugRef())
1327 continue;
1328
1329 bool IsValidRef = true;
1330
1331 for (MachineOperand &MO : MI.debug_operands()) {
1332 if (!MO.isReg())
1333 continue;
1334
1335 Register Reg = MO.getReg();
1336
1337 // Some vregs can be deleted as redundant in the meantime. Mark those
1338 // as DBG_VALUE $noreg. Additionally, some normal instructions are
1339 // quickly deleted, leaving dangling references to vregs with no def.
1340 if (Reg == 0 || !RegInfo->hasOneDef(RegNo: Reg)) {
1341 IsValidRef = false;
1342 break;
1343 }
1344
1345 assert(Reg.isVirtual());
1346 MachineInstr &DefMI = *RegInfo->def_instr_begin(RegNo: Reg);
1347
1348 // If we've found a copy-like instruction, follow it back to the
1349 // instruction that defines the source value, see salvageCopySSA docs
1350 // for why this is important.
1351 if (DefMI.isCopyLike() || TII->isCopyInstr(MI: DefMI)) {
1352 auto Result = salvageCopySSA(MI&: DefMI, DbgPHICache&: ArgDbgPHIs);
1353 MO.ChangeToDbgInstrRef(InstrIdx: Result.first, OpIdx: Result.second);
1354 } else {
1355 // Otherwise, identify the operand number that the VReg refers to.
1356 unsigned OperandIdx = 0;
1357 for (const auto &DefMO : DefMI.operands()) {
1358 if (DefMO.isReg() && DefMO.isDef() && DefMO.getReg() == Reg)
1359 break;
1360 ++OperandIdx;
1361 }
1362 assert(OperandIdx < DefMI.getNumOperands());
1363
1364 // Morph this instr ref to point at the given instruction and operand.
1365 unsigned ID = DefMI.getDebugInstrNum();
1366 MO.ChangeToDbgInstrRef(InstrIdx: ID, OpIdx: OperandIdx);
1367 }
1368 }
1369
1370 if (!IsValidRef)
1371 MakeUndefDbgValue(MI);
1372 }
1373 }
1374}
1375
1376bool MachineFunction::shouldUseDebugInstrRef() const {
1377 // Disable instr-ref at -O0: it's very slow (in compile time). We can still
1378 // have optimized code inlined into this unoptimized code, however with
1379 // fewer and less aggressive optimizations happening, coverage and accuracy
1380 // should not suffer.
1381 if (getTarget().getOptLevel() == CodeGenOptLevel::None)
1382 return false;
1383
1384 // Don't use instr-ref if this function is marked optnone.
1385 if (F.hasFnAttribute(Kind: Attribute::OptimizeNone))
1386 return false;
1387
1388 if (llvm::debuginfoShouldUseDebugInstrRef(T: getTarget().getTargetTriple()))
1389 return true;
1390
1391 return false;
1392}
1393
1394bool MachineFunction::useDebugInstrRef() const {
1395 return UseDebugInstrRef;
1396}
1397
1398void MachineFunction::setUseDebugInstrRef(bool Use) {
1399 UseDebugInstrRef = Use;
1400}
1401
1402// Use one million as a high / reserved number.
1403const unsigned MachineFunction::DebugOperandMemNumber = 1000000;
1404
1405/// \}
1406
1407//===----------------------------------------------------------------------===//
1408// MachineJumpTableInfo implementation
1409//===----------------------------------------------------------------------===//
1410
1411MachineJumpTableEntry::MachineJumpTableEntry(
1412 const std::vector<MachineBasicBlock *> &MBBs)
1413 : MBBs(MBBs), Hotness(MachineFunctionDataHotness::Unknown) {}
1414
1415/// Return the size of each entry in the jump table.
1416unsigned MachineJumpTableInfo::getEntrySize(const DataLayout &TD) const {
1417 // The size of a jump table entry is 4 bytes unless the entry is just the
1418 // address of a block, in which case it is the pointer size.
1419 switch (getEntryKind()) {
1420 case MachineJumpTableInfo::EK_BlockAddress:
1421 return TD.getPointerSize();
1422 case MachineJumpTableInfo::EK_GPRel64BlockAddress:
1423 case MachineJumpTableInfo::EK_LabelDifference64:
1424 return 8;
1425 case MachineJumpTableInfo::EK_GPRel32BlockAddress:
1426 case MachineJumpTableInfo::EK_LabelDifference32:
1427 case MachineJumpTableInfo::EK_Custom32:
1428 return 4;
1429 case MachineJumpTableInfo::EK_Inline:
1430 return 0;
1431 }
1432 llvm_unreachable("Unknown jump table encoding!");
1433}
1434
1435/// Return the alignment of each entry in the jump table.
1436unsigned MachineJumpTableInfo::getEntryAlignment(const DataLayout &TD) const {
1437 // The alignment of a jump table entry is the alignment of int32 unless the
1438 // entry is just the address of a block, in which case it is the pointer
1439 // alignment.
1440 switch (getEntryKind()) {
1441 case MachineJumpTableInfo::EK_BlockAddress:
1442 return TD.getPointerABIAlignment(AS: 0).value();
1443 case MachineJumpTableInfo::EK_GPRel64BlockAddress:
1444 case MachineJumpTableInfo::EK_LabelDifference64:
1445 return TD.getABIIntegerTypeAlignment(BitWidth: 64).value();
1446 case MachineJumpTableInfo::EK_GPRel32BlockAddress:
1447 case MachineJumpTableInfo::EK_LabelDifference32:
1448 case MachineJumpTableInfo::EK_Custom32:
1449 return TD.getABIIntegerTypeAlignment(BitWidth: 32).value();
1450 case MachineJumpTableInfo::EK_Inline:
1451 return 1;
1452 }
1453 llvm_unreachable("Unknown jump table encoding!");
1454}
1455
1456/// Create a new jump table entry in the jump table info.
1457unsigned MachineJumpTableInfo::createJumpTableIndex(
1458 const std::vector<MachineBasicBlock*> &DestBBs) {
1459 assert(!DestBBs.empty() && "Cannot create an empty jump table!");
1460 JumpTables.push_back(x: MachineJumpTableEntry(DestBBs));
1461 return JumpTables.size()-1;
1462}
1463
1464bool MachineJumpTableInfo::updateJumpTableEntryHotness(
1465 size_t JTI, MachineFunctionDataHotness Hotness) {
1466 assert(JTI < JumpTables.size() && "Invalid JTI!");
1467 // Record the largest hotness value.
1468 if (Hotness <= JumpTables[JTI].Hotness)
1469 return false;
1470
1471 JumpTables[JTI].Hotness = Hotness;
1472 return true;
1473}
1474
1475/// If Old is the target of any jump tables, update the jump tables to branch
1476/// to New instead.
1477bool MachineJumpTableInfo::ReplaceMBBInJumpTables(MachineBasicBlock *Old,
1478 MachineBasicBlock *New) {
1479 assert(Old != New && "Not making a change?");
1480 bool MadeChange = false;
1481 for (size_t i = 0, e = JumpTables.size(); i != e; ++i)
1482 ReplaceMBBInJumpTable(Idx: i, Old, New);
1483 return MadeChange;
1484}
1485
1486/// If MBB is present in any jump tables, remove it.
1487bool MachineJumpTableInfo::RemoveMBBFromJumpTables(MachineBasicBlock *MBB) {
1488 bool MadeChange = false;
1489 for (MachineJumpTableEntry &JTE : JumpTables) {
1490 auto removeBeginItr = std::remove(first: JTE.MBBs.begin(), last: JTE.MBBs.end(), value: MBB);
1491 MadeChange |= (removeBeginItr != JTE.MBBs.end());
1492 JTE.MBBs.erase(first: removeBeginItr, last: JTE.MBBs.end());
1493 }
1494 return MadeChange;
1495}
1496
1497/// If Old is a target of the jump tables, update the jump table to branch to
1498/// New instead.
1499bool MachineJumpTableInfo::ReplaceMBBInJumpTable(unsigned Idx,
1500 MachineBasicBlock *Old,
1501 MachineBasicBlock *New) {
1502 assert(Old != New && "Not making a change?");
1503 bool MadeChange = false;
1504 MachineJumpTableEntry &JTE = JumpTables[Idx];
1505 for (MachineBasicBlock *&MBB : JTE.MBBs)
1506 if (MBB == Old) {
1507 MBB = New;
1508 MadeChange = true;
1509 }
1510 return MadeChange;
1511}
1512
1513void MachineJumpTableInfo::print(raw_ostream &OS) const {
1514 if (JumpTables.empty()) return;
1515
1516 OS << "Jump Tables:\n";
1517
1518 for (unsigned i = 0, e = JumpTables.size(); i != e; ++i) {
1519 OS << printJumpTableEntryReference(Idx: i) << ':';
1520 for (const MachineBasicBlock *MBB : JumpTables[i].MBBs)
1521 OS << ' ' << printMBBReference(MBB: *MBB);
1522 OS << '\n';
1523 }
1524
1525 OS << '\n';
1526}
1527
1528#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
1529LLVM_DUMP_METHOD void MachineJumpTableInfo::dump() const { print(dbgs()); }
1530#endif
1531
1532Printable llvm::printJumpTableEntryReference(unsigned Idx) {
1533 return Printable([Idx](raw_ostream &OS) { OS << "%jump-table." << Idx; });
1534}
1535
1536//===----------------------------------------------------------------------===//
1537// MachineConstantPool implementation
1538//===----------------------------------------------------------------------===//
1539
1540void MachineConstantPoolValue::anchor() {}
1541
1542unsigned MachineConstantPoolValue::getSizeInBytes(const DataLayout &DL) const {
1543 return DL.getTypeAllocSize(Ty);
1544}
1545
1546unsigned MachineConstantPoolEntry::getSizeInBytes(const DataLayout &DL) const {
1547 if (isMachineConstantPoolEntry())
1548 return Val.MachineCPVal->getSizeInBytes(DL);
1549 return DL.getTypeAllocSize(Ty: Val.ConstVal->getType());
1550}
1551
1552bool MachineConstantPoolEntry::needsRelocation() const {
1553 if (isMachineConstantPoolEntry())
1554 return true;
1555 return Val.ConstVal->needsDynamicRelocation();
1556}
1557
1558SectionKind
1559MachineConstantPoolEntry::getSectionKind(const DataLayout *DL) const {
1560 if (needsRelocation())
1561 return SectionKind::getReadOnlyWithRel();
1562 switch (getSizeInBytes(DL: *DL)) {
1563 case 4:
1564 return SectionKind::getMergeableConst4();
1565 case 8:
1566 return SectionKind::getMergeableConst8();
1567 case 16:
1568 return SectionKind::getMergeableConst16();
1569 case 32:
1570 return SectionKind::getMergeableConst32();
1571 default:
1572 return SectionKind::getReadOnly();
1573 }
1574}
1575
1576MachineConstantPool::~MachineConstantPool() {
1577 // A constant may be a member of both Constants and MachineCPVsSharingEntries,
1578 // so keep track of which we've deleted to avoid double deletions.
1579 DenseSet<MachineConstantPoolValue*> Deleted;
1580 for (const MachineConstantPoolEntry &C : Constants)
1581 if (C.isMachineConstantPoolEntry()) {
1582 Deleted.insert(V: C.Val.MachineCPVal);
1583 delete C.Val.MachineCPVal;
1584 }
1585 for (MachineConstantPoolValue *CPV : MachineCPVsSharingEntries) {
1586 if (Deleted.count(V: CPV) == 0)
1587 delete CPV;
1588 }
1589}
1590
1591/// Test whether the given two constants can be allocated the same constant pool
1592/// entry referenced by \param A.
1593static bool CanShareConstantPoolEntry(const Constant *A, const Constant *B,
1594 const DataLayout &DL) {
1595 // Handle the trivial case quickly.
1596 if (A == B) return true;
1597
1598 // If they have the same type but weren't the same constant, quickly
1599 // reject them.
1600 if (A->getType() == B->getType()) return false;
1601
1602 // We can't handle structs or arrays.
1603 if (isa<StructType>(Val: A->getType()) || isa<ArrayType>(Val: A->getType()) ||
1604 isa<StructType>(Val: B->getType()) || isa<ArrayType>(Val: B->getType()))
1605 return false;
1606
1607 // For now, only support constants with the same size.
1608 uint64_t StoreSize = DL.getTypeStoreSize(Ty: A->getType());
1609 if (StoreSize != DL.getTypeStoreSize(Ty: B->getType()) || StoreSize > 128)
1610 return false;
1611
1612 bool ContainsUndefOrPoisonA = A->containsUndefOrPoisonElement();
1613
1614 Type *IntTy = IntegerType::get(C&: A->getContext(), NumBits: StoreSize*8);
1615
1616 // Try constant folding a bitcast of both instructions to an integer. If we
1617 // get two identical ConstantInt's, then we are good to share them. We use
1618 // the constant folding APIs to do this so that we get the benefit of
1619 // DataLayout.
1620 if (isa<PointerType>(Val: A->getType()))
1621 A = ConstantFoldCastOperand(Opcode: Instruction::PtrToInt,
1622 C: const_cast<Constant *>(A), DestTy: IntTy, DL);
1623 else if (A->getType() != IntTy)
1624 A = ConstantFoldCastOperand(Opcode: Instruction::BitCast, C: const_cast<Constant *>(A),
1625 DestTy: IntTy, DL);
1626 if (isa<PointerType>(Val: B->getType()))
1627 B = ConstantFoldCastOperand(Opcode: Instruction::PtrToInt,
1628 C: const_cast<Constant *>(B), DestTy: IntTy, DL);
1629 else if (B->getType() != IntTy)
1630 B = ConstantFoldCastOperand(Opcode: Instruction::BitCast, C: const_cast<Constant *>(B),
1631 DestTy: IntTy, DL);
1632
1633 if (A != B)
1634 return false;
1635
1636 // Constants only safely match if A doesn't contain undef/poison.
1637 // As we'll be reusing A, it doesn't matter if B contain undef/poison.
1638 // TODO: Handle cases where A and B have the same undef/poison elements.
1639 // TODO: Merge A and B with mismatching undef/poison elements.
1640 return !ContainsUndefOrPoisonA;
1641}
1642
1643/// Create a new entry in the constant pool or return an existing one.
1644/// User must specify the log2 of the minimum required alignment for the object.
1645unsigned MachineConstantPool::getConstantPoolIndex(const Constant *C,
1646 Align Alignment) {
1647 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
1648
1649 // Check to see if we already have this constant.
1650 //
1651 // FIXME, this could be made much more efficient for large constant pools.
1652 for (unsigned i = 0, e = Constants.size(); i != e; ++i)
1653 if (!Constants[i].isMachineConstantPoolEntry() &&
1654 CanShareConstantPoolEntry(A: Constants[i].Val.ConstVal, B: C, DL)) {
1655 if (Constants[i].getAlign() < Alignment)
1656 Constants[i].Alignment = Alignment;
1657 return i;
1658 }
1659
1660 Constants.push_back(x: MachineConstantPoolEntry(C, Alignment));
1661 return Constants.size()-1;
1662}
1663
1664unsigned MachineConstantPool::getConstantPoolIndex(MachineConstantPoolValue *V,
1665 Align Alignment) {
1666 if (Alignment > PoolAlignment) PoolAlignment = Alignment;
1667
1668 // Check to see if we already have this constant.
1669 //
1670 // FIXME, this could be made much more efficient for large constant pools.
1671 int Idx = V->getExistingMachineCPValue(CP: this, Alignment);
1672 if (Idx != -1) {
1673 MachineCPVsSharingEntries.insert(V);
1674 return (unsigned)Idx;
1675 }
1676
1677 Constants.push_back(x: MachineConstantPoolEntry(V, Alignment));
1678 return Constants.size()-1;
1679}
1680
1681void MachineConstantPool::print(raw_ostream &OS) const {
1682 if (Constants.empty()) return;
1683
1684 OS << "Constant Pool:\n";
1685 for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
1686 OS << " cp#" << i << ": ";
1687 if (Constants[i].isMachineConstantPoolEntry())
1688 Constants[i].Val.MachineCPVal->print(O&: OS);
1689 else
1690 Constants[i].Val.ConstVal->printAsOperand(O&: OS);
1691 OS << ", align=" << Constants[i].getAlign().value();
1692 OS << "\n";
1693 }
1694}
1695
1696//===----------------------------------------------------------------------===//
1697// Template specializations for MachineFunction implementations of
1698// ProfileSummaryInfo::getEntryCount() and ProfileSummaryInfo::hasHotAttr().
1699//===----------------------------------------------------------------------===//
1700template <>
1701std::optional<uint64_t>
1702ProfileSummaryInfo::getEntryCount<llvm::MachineFunction>(
1703 const llvm::MachineFunction *F) const {
1704 return F->getFunction().getEntryCount();
1705}
1706
1707template <>
1708bool ProfileSummaryInfo::hasHotAttr<llvm::MachineFunction>(
1709 const llvm::MachineFunction *F) const {
1710 return F->getFunction().hasFnAttribute(Kind: Attribute::Hot);
1711}
1712
1713#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
1714LLVM_DUMP_METHOD void MachineConstantPool::dump() const { print(dbgs()); }
1715#endif
1716