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