1//===-- Instruction.cpp - Implement the Instruction class -----------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file implements the Instruction class for the IR library.
10//
11//===----------------------------------------------------------------------===//
12
13#include "llvm/IR/Instruction.h"
14#include "llvm/ADT/DenseSet.h"
15#include "llvm/ADT/STLExtras.h"
16#include "llvm/IR/AttributeMask.h"
17#include "llvm/IR/Attributes.h"
18#include "llvm/IR/Constants.h"
19#include "llvm/IR/InstrTypes.h"
20#include "llvm/IR/Instructions.h"
21#include "llvm/IR/IntrinsicInst.h"
22#include "llvm/IR/Intrinsics.h"
23#include "llvm/IR/LLVMContext.h"
24#include "llvm/IR/MemoryModelRelaxationAnnotations.h"
25#include "llvm/IR/Module.h"
26#include "llvm/IR/Operator.h"
27#include "llvm/IR/ProfDataUtils.h"
28#include "llvm/IR/Type.h"
29#include "llvm/Support/CommandLine.h"
30#include "llvm/Support/Compiler.h"
31using namespace llvm;
32
33namespace llvm {
34
35// FIXME: Flag used for an ablation performance test, Issue #147390. Placing it
36// here because referencing IR should be feasible from anywhere. Will be
37// removed after the ablation test.
38cl::opt<bool> ProfcheckDisableMetadataFixes(
39 "profcheck-disable-metadata-fixes", cl::Hidden, cl::init(Val: false),
40 cl::desc(
41 "Disable metadata propagation fixes discovered through Issue #147390"));
42
43} // end namespace llvm
44
45InsertPosition::InsertPosition(BasicBlock *InsertAtEnd)
46 : InsertAt(InsertAtEnd ? InsertAtEnd->end() : InstListType::iterator()) {}
47
48Instruction::Instruction(Type *ty, unsigned it, AllocInfo AllocInfo,
49 InsertPosition InsertBefore)
50 : User(ty, Value::InstructionVal + it, AllocInfo) {
51 // When called with an iterator, there must be a block to insert into.
52 if (InstListType::iterator InsertIt = InsertBefore; InsertIt.isValid()) {
53 BasicBlock *BB = InsertIt.getNodeParent();
54 assert(BB && "Instruction to insert before is not in a basic block!");
55 insertInto(ParentBB: BB, It: InsertBefore);
56 }
57}
58
59Instruction::~Instruction() {
60 assert(!getParent() && "Instruction still linked in the program!");
61
62 // Replace any extant metadata uses of this instruction with poison to
63 // preserve debug info accuracy. Some alternatives include:
64 // - Treat Instruction like any other Value, and point its extant metadata
65 // uses to an empty ValueAsMetadata node. This makes extant dbg.value uses
66 // trivially dead (i.e. fair game for deletion in many passes), leading to
67 // stale dbg.values being in effect for too long.
68 // - Call salvageDebugInfoOrMarkUndef. Not needed to make instruction removal
69 // correct. OTOH results in wasted work in some common cases (e.g. when all
70 // instructions in a BasicBlock are deleted).
71 if (isUsedByMetadata())
72 ValueAsMetadata::handleRAUW(From: this, To: PoisonValue::get(T: getType()));
73
74 // Remove associated metadata from context.
75 if (hasMetadata()) {
76 // Explicitly remove DIAssignID metadata to clear up ID -> Instruction(s)
77 // mapping in LLVMContext.
78 updateDIAssignIDMapping(ID: nullptr);
79 clearMetadata();
80 }
81}
82
83const Module *Instruction::getModule() const {
84 return getParent()->getModule();
85}
86
87const Function *Instruction::getFunction() const {
88 return getParent()->getParent();
89}
90
91const DataLayout &Instruction::getDataLayout() const {
92 return getModule()->getDataLayout();
93}
94
95void Instruction::removeFromParent() {
96 // Perform any debug-info maintenence required.
97 handleMarkerRemoval();
98
99 getParent()->getInstList().remove(IT: getIterator());
100}
101
102void Instruction::handleMarkerRemoval() {
103 if (!DebugMarker)
104 return;
105
106 DebugMarker->removeMarker();
107}
108
109BasicBlock::iterator Instruction::eraseFromParent() {
110 handleMarkerRemoval();
111 return getParent()->getInstList().erase(where: getIterator());
112}
113
114/// Insert an unlinked instruction into a basic block immediately before the
115/// specified instruction.
116void Instruction::insertBefore(BasicBlock::iterator InsertPos) {
117 insertBefore(BB&: *InsertPos->getParent(), InsertPos);
118}
119
120/// Insert an unlinked instruction into a basic block immediately after the
121/// specified instruction.
122void Instruction::insertAfter(Instruction *InsertPos) {
123 BasicBlock *DestParent = InsertPos->getParent();
124
125 DestParent->getInstList().insertAfter(where: InsertPos->getIterator(), New: this);
126}
127
128void Instruction::insertAfter(BasicBlock::iterator InsertPos) {
129 BasicBlock *DestParent = InsertPos->getParent();
130
131 DestParent->getInstList().insertAfter(where: InsertPos, New: this);
132}
133
134BasicBlock::iterator Instruction::insertInto(BasicBlock *ParentBB,
135 BasicBlock::iterator It) {
136 assert(getParent() == nullptr && "Expected detached instruction");
137 assert((It == ParentBB->end() || It->getParent() == ParentBB) &&
138 "It not in ParentBB");
139 insertBefore(BB&: *ParentBB, InsertPos: It);
140 return getIterator();
141}
142
143void Instruction::insertBefore(BasicBlock &BB,
144 InstListType::iterator InsertPos) {
145 assert(!DebugMarker);
146
147 BB.getInstList().insert(where: InsertPos, New: this);
148
149 // We've inserted "this": if InsertAtHead is set then it comes before any
150 // DbgVariableRecords attached to InsertPos. But if it's not set, then any
151 // DbgRecords should now come before "this".
152 bool InsertAtHead = InsertPos.getHeadBit();
153 if (!InsertAtHead) {
154 DbgMarker *SrcMarker = BB.getMarker(It: InsertPos);
155 if (SrcMarker && !SrcMarker->empty()) {
156 // If this assertion fires, the calling code is about to insert a PHI
157 // after debug-records, which would form a sequence like:
158 // %0 = PHI
159 // #dbg_value
160 // %1 = PHI
161 // Which is de-normalised and undesired -- hence the assertion. To avoid
162 // this, you must insert at that position using an iterator, and it must
163 // be aquired by calling getFirstNonPHIIt / begin or similar methods on
164 // the block. This will signal to this behind-the-scenes debug-info
165 // maintenence code that you intend the PHI to be ahead of everything,
166 // including any debug-info.
167 assert(!isa<PHINode>(this) && "Inserting PHI after debug-records!");
168 adoptDbgRecords(BB: &BB, It: InsertPos, InsertAtHead: false);
169 }
170 }
171
172 // If we're inserting a terminator, check if we need to flush out
173 // TrailingDbgRecords. Inserting instructions at the end of an incomplete
174 // block is handled by the code block above.
175 if (isTerminator())
176 getParent()->flushTerminatorDbgRecords();
177}
178
179/// Unlink this instruction from its current basic block and insert it into the
180/// basic block that MovePos lives in, right before MovePos.
181void Instruction::moveBefore(BasicBlock::iterator MovePos) {
182 moveBeforeImpl(BB&: *MovePos->getParent(), I: MovePos, Preserve: false);
183}
184
185void Instruction::moveBeforePreserving(BasicBlock::iterator MovePos) {
186 moveBeforeImpl(BB&: *MovePos->getParent(), I: MovePos, Preserve: true);
187}
188
189void Instruction::moveAfter(Instruction *MovePos) {
190 auto NextIt = std::next(x: MovePos->getIterator());
191 // We want this instruction to be moved to after NextIt in the instruction
192 // list, but before NextIt's debug value range.
193 NextIt.setHeadBit(true);
194 moveBeforeImpl(BB&: *MovePos->getParent(), I: NextIt, Preserve: false);
195}
196
197void Instruction::moveAfter(InstListType::iterator MovePos) {
198 // We want this instruction to be moved to after NextIt in the instruction
199 // list, but before NextIt's debug value range.
200 MovePos.setHeadBit(true);
201 moveBeforeImpl(BB&: *MovePos->getParent(), I: MovePos, Preserve: false);
202}
203
204void Instruction::moveAfterPreserving(Instruction *MovePos) {
205 auto NextIt = std::next(x: MovePos->getIterator());
206 // We want this instruction and its debug range to be moved to after NextIt
207 // in the instruction list, but before NextIt's debug value range.
208 NextIt.setHeadBit(true);
209 moveBeforeImpl(BB&: *MovePos->getParent(), I: NextIt, Preserve: true);
210}
211
212void Instruction::moveBefore(BasicBlock &BB, InstListType::iterator I) {
213 moveBeforeImpl(BB, I, Preserve: false);
214}
215
216void Instruction::moveBeforePreserving(BasicBlock &BB,
217 InstListType::iterator I) {
218 moveBeforeImpl(BB, I, Preserve: true);
219}
220
221void Instruction::moveBeforeImpl(BasicBlock &BB, InstListType::iterator I,
222 bool Preserve) {
223 assert(I == BB.end() || I->getParent() == &BB);
224 bool InsertAtHead = I.getHeadBit();
225
226 // If we've been given the "Preserve" flag, then just move the DbgRecords with
227 // the instruction, no more special handling needed.
228 if (DebugMarker && !Preserve) {
229 if (I != this->getIterator() || InsertAtHead) {
230 // "this" is definitely moving in the list, or it's moving ahead of its
231 // attached DbgVariableRecords. Detach any existing DbgRecords.
232 handleMarkerRemoval();
233 }
234 }
235
236 // Move this single instruction. Use the list splice method directly, not
237 // the block splicer, which will do more debug-info things.
238 BB.getInstList().splice(where: I, L2&: getParent()->getInstList(), first: getIterator());
239
240 if (!Preserve) {
241 DbgMarker *NextMarker = getParent()->getNextMarker(I: this);
242
243 // If we're inserting at point I, and not in front of the DbgRecords
244 // attached there, then we should absorb the DbgRecords attached to I.
245 if (!InsertAtHead && NextMarker && !NextMarker->empty()) {
246 adoptDbgRecords(BB: &BB, It: I, InsertAtHead: false);
247 }
248 }
249
250 if (isTerminator())
251 getParent()->flushTerminatorDbgRecords();
252}
253
254iterator_range<DbgRecord::self_iterator> Instruction::cloneDebugInfoFrom(
255 const Instruction *From, std::optional<DbgRecord::self_iterator> FromHere,
256 bool InsertAtHead) {
257 if (!From->DebugMarker)
258 return DbgMarker::getEmptyDbgRecordRange();
259
260 if (!DebugMarker)
261 getParent()->createMarker(I: this);
262
263 return DebugMarker->cloneDebugInfoFrom(From: From->DebugMarker, FromHere,
264 InsertAtHead);
265}
266
267std::optional<DbgRecord::self_iterator>
268Instruction::getDbgReinsertionPosition() {
269 // Is there a marker on the next instruction?
270 DbgMarker *NextMarker = getParent()->getNextMarker(I: this);
271 if (!NextMarker)
272 return std::nullopt;
273
274 // Are there any DbgRecords in the next marker?
275 if (NextMarker->StoredDbgRecords.empty())
276 return std::nullopt;
277
278 return NextMarker->StoredDbgRecords.begin();
279}
280
281bool Instruction::hasDbgRecords() const { return !getDbgRecordRange().empty(); }
282
283void Instruction::adoptDbgRecords(BasicBlock *BB, BasicBlock::iterator It,
284 bool InsertAtHead) {
285 DbgMarker *SrcMarker = BB->getMarker(It);
286 auto ReleaseTrailingDbgRecords = [BB, It, SrcMarker]() {
287 if (BB->end() == It) {
288 SrcMarker->eraseFromParent();
289 BB->deleteTrailingDbgRecords();
290 }
291 };
292
293 if (!SrcMarker || SrcMarker->StoredDbgRecords.empty()) {
294 ReleaseTrailingDbgRecords();
295 return;
296 }
297
298 // If we have DbgMarkers attached to this instruction, we have to honour the
299 // ordering of DbgRecords between this and the other marker. Fall back to just
300 // absorbing from the source.
301 if (DebugMarker || It == BB->end()) {
302 // Ensure we _do_ have a marker.
303 getParent()->createMarker(I: this);
304 DebugMarker->absorbDebugValues(Src&: *SrcMarker, InsertAtHead);
305
306 // Having transferred everything out of SrcMarker, we _could_ clean it up
307 // and free the marker now. However, that's a lot of heap-accounting for a
308 // small amount of memory with a good chance of re-use. Leave it for the
309 // moment. It will be released when the Instruction is freed in the worst
310 // case.
311 // However: if we transferred from a trailing marker off the end of the
312 // block, it's important to not leave the empty marker trailing. It will
313 // give a misleading impression that some debug records have been left
314 // trailing.
315 ReleaseTrailingDbgRecords();
316 } else {
317 // Optimisation: we're transferring all the DbgRecords from the source
318 // marker onto this empty location: just adopt the other instructions
319 // marker.
320 DebugMarker = SrcMarker;
321 DebugMarker->MarkedInstr = this;
322 It->DebugMarker = nullptr;
323 }
324}
325
326void Instruction::dropDbgRecords() {
327 if (DebugMarker)
328 DebugMarker->dropDbgRecords();
329}
330
331void Instruction::dropOneDbgRecord(DbgRecord *DVR) {
332 DebugMarker->dropOneDbgRecord(DR: DVR);
333}
334
335bool Instruction::comesBefore(const Instruction *Other) const {
336 assert(getParent() && Other->getParent() &&
337 "instructions without BB parents have no order");
338 assert(getParent() == Other->getParent() &&
339 "cross-BB instruction order comparison");
340 if (!getParent()->isInstrOrderValid())
341 const_cast<BasicBlock *>(getParent())->renumberInstructions();
342 return Order < Other->Order;
343}
344
345std::optional<BasicBlock::iterator> Instruction::getInsertionPointAfterDef() {
346 assert(!getType()->isVoidTy() && "Instruction must define result");
347 BasicBlock *InsertBB;
348 BasicBlock::iterator InsertPt;
349 if (auto *PN = dyn_cast<PHINode>(Val: this)) {
350 InsertBB = PN->getParent();
351 InsertPt = InsertBB->getFirstInsertionPt();
352 } else if (auto *II = dyn_cast<InvokeInst>(Val: this)) {
353 InsertBB = II->getNormalDest();
354 InsertPt = InsertBB->getFirstInsertionPt();
355 } else if (isa<CallBrInst>(Val: this)) {
356 // Def is available in multiple successors, there's no single dominating
357 // insertion point.
358 return std::nullopt;
359 } else {
360 assert(!isTerminator() && "Only invoke/callbr terminators return value");
361 InsertBB = getParent();
362 InsertPt = std::next(x: getIterator());
363 // Any instruction inserted immediately after "this" will come before any
364 // debug-info records take effect -- thus, set the head bit indicating that
365 // to debug-info-transfer code.
366 InsertPt.setHeadBit(true);
367 }
368
369 // catchswitch blocks don't have any legal insertion point (because they
370 // are both an exception pad and a terminator).
371 if (InsertPt == InsertBB->end())
372 return std::nullopt;
373 return InsertPt;
374}
375
376bool Instruction::isOnlyUserOfAnyOperand() {
377 return any_of(Range: operands(), P: [](const Value *V) { return V->hasOneUser(); });
378}
379
380void Instruction::setHasNoUnsignedWrap(bool b) {
381 if (auto *Inst = dyn_cast<OverflowingBinaryOperator>(Val: this))
382 Inst->setHasNoUnsignedWrap(b);
383 else
384 cast<TruncInst>(Val: this)->setHasNoUnsignedWrap(b);
385}
386
387void Instruction::setHasNoSignedWrap(bool b) {
388 if (auto *Inst = dyn_cast<OverflowingBinaryOperator>(Val: this))
389 Inst->setHasNoSignedWrap(b);
390 else
391 cast<TruncInst>(Val: this)->setHasNoSignedWrap(b);
392}
393
394void Instruction::setIsExact(bool b) {
395 cast<PossiblyExactOperator>(Val: this)->setIsExact(b);
396}
397
398void Instruction::setNonNeg(bool b) {
399 assert(isa<PossiblyNonNegInst>(this) && "Must be zext/uitofp");
400 SubclassOptionalData = (SubclassOptionalData & ~PossiblyNonNegInst::NonNeg) |
401 (b * PossiblyNonNegInst::NonNeg);
402}
403
404bool Instruction::hasNoUnsignedWrap() const {
405 if (auto *Inst = dyn_cast<OverflowingBinaryOperator>(Val: this))
406 return Inst->hasNoUnsignedWrap();
407
408 return cast<TruncInst>(Val: this)->hasNoUnsignedWrap();
409}
410
411bool Instruction::hasNoSignedWrap() const {
412 if (auto *Inst = dyn_cast<OverflowingBinaryOperator>(Val: this))
413 return Inst->hasNoSignedWrap();
414
415 return cast<TruncInst>(Val: this)->hasNoSignedWrap();
416}
417
418bool Instruction::hasNonNeg() const {
419 assert(isa<PossiblyNonNegInst>(this) && "Must be zext/uitofp");
420 return (SubclassOptionalData & PossiblyNonNegInst::NonNeg) != 0;
421}
422
423bool Instruction::hasPoisonGeneratingFlags() const {
424 return cast<Operator>(Val: this)->hasPoisonGeneratingFlags();
425}
426
427void Instruction::dropPoisonGeneratingFlags() {
428 switch (getOpcode()) {
429 case Instruction::Add:
430 case Instruction::Sub:
431 case Instruction::Mul:
432 case Instruction::Shl:
433 cast<OverflowingBinaryOperator>(Val: this)->setHasNoUnsignedWrap(false);
434 cast<OverflowingBinaryOperator>(Val: this)->setHasNoSignedWrap(false);
435 break;
436
437 case Instruction::UDiv:
438 case Instruction::SDiv:
439 case Instruction::AShr:
440 case Instruction::LShr:
441 cast<PossiblyExactOperator>(Val: this)->setIsExact(false);
442 break;
443
444 case Instruction::Or:
445 cast<PossiblyDisjointInst>(Val: this)->setIsDisjoint(false);
446 break;
447
448 case Instruction::GetElementPtr:
449 cast<GetElementPtrInst>(Val: this)->setNoWrapFlags(GEPNoWrapFlags::none());
450 break;
451
452 case Instruction::UIToFP:
453 case Instruction::ZExt:
454 setNonNeg(false);
455 break;
456
457 case Instruction::Trunc:
458 cast<TruncInst>(Val: this)->setHasNoUnsignedWrap(false);
459 cast<TruncInst>(Val: this)->setHasNoSignedWrap(false);
460 break;
461
462 case Instruction::ICmp:
463 cast<ICmpInst>(Val: this)->setSameSign(false);
464 break;
465
466 case Instruction::AddrSpaceCast:
467 cast<AddrSpaceCastInst>(Val: this)->setNonNull(false);
468 break;
469
470 case Instruction::Call: {
471 if (auto *II = dyn_cast<IntrinsicInst>(Val: this)) {
472 switch (II->getIntrinsicID()) {
473 case Intrinsic::ctlz:
474 case Intrinsic::cttz:
475 case Intrinsic::abs:
476 II->setOperand(i_nocapture: 1, Val_nocapture: ConstantInt::getFalse(Context&: getContext()));
477 break;
478 }
479 }
480 break;
481 }
482 }
483
484 if (isa<FPMathOperator>(Val: this)) {
485 setHasNoNaNs(false);
486 setHasNoInfs(false);
487 }
488
489 assert(!hasPoisonGeneratingFlags() && "must be kept in sync");
490}
491
492bool Instruction::hasPoisonGeneratingMetadata() const {
493 return any_of(Range: Metadata::PoisonGeneratingIDs,
494 P: [this](unsigned ID) { return hasMetadata(KindID: ID); });
495}
496
497bool Instruction::hasNonDebugLocLoopMetadata() const {
498 // If there is no loop metadata at all, we also don't have
499 // non-debug loop metadata, obviously.
500 if (!hasMetadata(KindID: LLVMContext::MD_loop))
501 return false;
502
503 // If we do have loop metadata, retrieve it.
504 MDNode *LoopMD = getMetadata(KindID: LLVMContext::MD_loop);
505
506 // Check if the existing operands are debug locations. This loop
507 // should terminate after at most three iterations. Skip
508 // the first item because it is a self-reference.
509 for (const MDOperand &Op : llvm::drop_begin(RangeOrContainer: LoopMD->operands())) {
510 // check for debug location type by attempting a cast.
511 if (!isa<DILocation>(Val: Op)) {
512 return true;
513 }
514 }
515
516 // If we get here, then all we have is debug locations in the loop metadata.
517 return false;
518}
519
520void Instruction::dropPoisonGeneratingMetadata() {
521 for (unsigned ID : Metadata::PoisonGeneratingIDs)
522 eraseMetadata(KindID: ID);
523}
524
525bool Instruction::hasPoisonGeneratingAttributes() const {
526 if (const auto *CB = dyn_cast<CallBase>(Val: this)) {
527 auto HasPoisonGeneratingAttributes = [](AttributeSet Attrs) {
528 return Attrs.hasAttribute(Kind: Attribute::Range) ||
529 Attrs.hasAttribute(Kind: Attribute::Alignment) ||
530 Attrs.hasAttribute(Kind: Attribute::NonNull) ||
531 Attrs.hasAttribute(Kind: Attribute::NoFPClass);
532 };
533 if (HasPoisonGeneratingAttributes(CB->getRetAttributes()))
534 return true;
535 for (unsigned ArgNo = 0; ArgNo < CB->arg_size(); ArgNo++)
536 if (HasPoisonGeneratingAttributes(CB->getParamAttributes(ArgNo)))
537 return true;
538 }
539 return false;
540}
541
542void Instruction::dropPoisonGeneratingAttributes() {
543 if (auto *CB = dyn_cast<CallBase>(Val: this)) {
544 AttributeMask AM;
545 AM.addAttribute(Val: Attribute::Range);
546 AM.addAttribute(Val: Attribute::Alignment);
547 AM.addAttribute(Val: Attribute::NonNull);
548 AM.addAttribute(Val: Attribute::NoFPClass);
549 CB->removeRetAttrs(AttrsToRemove: AM);
550 for (unsigned ArgNo = 0; ArgNo < CB->arg_size(); ArgNo++)
551 CB->removeParamAttrs(ArgNo, AttrsToRemove: AM);
552 }
553 assert(!hasPoisonGeneratingAttributes() && "must be kept in sync");
554}
555
556void Instruction::dropUBImplyingAttrsAndUnknownMetadata(
557 ArrayRef<unsigned> KnownIDs) {
558 dropUnknownNonDebugMetadata(KnownIDs);
559 auto *CB = dyn_cast<CallBase>(Val: this);
560 if (!CB)
561 return;
562 // For call instructions, we also need to drop parameter and return attributes
563 // that can cause UB if the call is moved to a location where the attribute is
564 // not valid.
565 AttributeList AL = CB->getAttributes();
566 if (AL.isEmpty())
567 return;
568 AttributeMask UBImplyingAttributes =
569 AttributeFuncs::getUBImplyingAttributes();
570 for (unsigned ArgNo = 0; ArgNo < CB->arg_size(); ArgNo++)
571 CB->removeParamAttrs(ArgNo, AttrsToRemove: UBImplyingAttributes);
572 CB->removeRetAttrs(AttrsToRemove: UBImplyingAttributes);
573}
574
575void Instruction::dropUBImplyingAttrsAndMetadata(ArrayRef<unsigned> Keep) {
576 // !annotation and !prof metadata does not impact semantics.
577 // !range, !nonnull, !align and !nofpclass produce poison, so they are safe to
578 // speculate.
579 // !fpmath specifies floating-point precision and does not imply UB.
580 // !mem.cache_hint is a performance hint and does not imply UB.
581 // !noundef and various AA metadata must be dropped, as it generally produces
582 // immediate undefined behavior.
583 static const unsigned KnownIDs[] = {
584 LLVMContext::MD_annotation, LLVMContext::MD_range,
585 LLVMContext::MD_nonnull, LLVMContext::MD_align,
586 LLVMContext::MD_fpmath, LLVMContext::MD_prof,
587 LLVMContext::MD_mem_cache_hint, LLVMContext::MD_nofpclass};
588 SmallVector<unsigned> KeepIDs;
589 KeepIDs.reserve(N: Keep.size() + std::size(KnownIDs));
590 append_range(C&: KeepIDs, R: KnownIDs);
591 append_range(C&: KeepIDs, R&: Keep);
592 dropUBImplyingAttrsAndUnknownMetadata(KnownIDs: KeepIDs);
593}
594
595bool Instruction::hasUBImplyingAttrs() const {
596 auto *CB = dyn_cast<CallBase>(Val: this);
597 if (!CB)
598 return false;
599 // For call instructions, we also need to check parameter and return
600 // attributes that can cause UB.
601 for (unsigned ArgNo = 0; ArgNo < CB->arg_size(); ArgNo++)
602 if (CB->isPassingUndefUB(ArgNo))
603 return true;
604 return CB->hasRetAttr(Kind: Attribute::NoUndef) ||
605 CB->hasRetAttr(Kind: Attribute::Dereferenceable) ||
606 CB->hasRetAttr(Kind: Attribute::DereferenceableOrNull);
607}
608
609bool Instruction::isExact() const {
610 return cast<PossiblyExactOperator>(Val: this)->isExact();
611}
612
613void Instruction::setFast(bool B) {
614 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
615 cast<FPMathOperator>(Val: this)->setFast(B);
616}
617
618void Instruction::setHasAllowReassoc(bool B) {
619 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
620 cast<FPMathOperator>(Val: this)->setHasAllowReassoc(B);
621}
622
623void Instruction::setHasNoNaNs(bool B) {
624 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
625 cast<FPMathOperator>(Val: this)->setHasNoNaNs(B);
626}
627
628void Instruction::setHasNoInfs(bool B) {
629 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
630 cast<FPMathOperator>(Val: this)->setHasNoInfs(B);
631}
632
633void Instruction::setHasNoSignedZeros(bool B) {
634 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
635 cast<FPMathOperator>(Val: this)->setHasNoSignedZeros(B);
636}
637
638void Instruction::setHasAllowReciprocal(bool B) {
639 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
640 cast<FPMathOperator>(Val: this)->setHasAllowReciprocal(B);
641}
642
643void Instruction::setHasAllowContract(bool B) {
644 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
645 cast<FPMathOperator>(Val: this)->setHasAllowContract(B);
646}
647
648void Instruction::setHasApproxFunc(bool B) {
649 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
650 cast<FPMathOperator>(Val: this)->setHasApproxFunc(B);
651}
652
653void Instruction::setFastMathFlags(FastMathFlags FMF) {
654 assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
655 cast<FPMathOperator>(Val: this)->setFastMathFlags(FMF);
656}
657
658void Instruction::copyFastMathFlags(FastMathFlags FMF) {
659 assert(isa<FPMathOperator>(this) && "copying fast-math flag on invalid op");
660 cast<FPMathOperator>(Val: this)->copyFastMathFlags(FMF);
661}
662
663bool Instruction::isFast() const {
664 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
665 return cast<FPMathOperator>(Val: this)->isFast();
666}
667
668bool Instruction::hasAllowReassoc() const {
669 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
670 return cast<FPMathOperator>(Val: this)->hasAllowReassoc();
671}
672
673bool Instruction::hasNoNaNs() const {
674 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
675 return cast<FPMathOperator>(Val: this)->hasNoNaNs();
676}
677
678bool Instruction::hasNoInfs() const {
679 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
680 return cast<FPMathOperator>(Val: this)->hasNoInfs();
681}
682
683bool Instruction::hasNoSignedZeros() const {
684 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
685 return cast<FPMathOperator>(Val: this)->hasNoSignedZeros();
686}
687
688bool Instruction::hasAllowReciprocal() const {
689 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
690 return cast<FPMathOperator>(Val: this)->hasAllowReciprocal();
691}
692
693bool Instruction::hasAllowContract() const {
694 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
695 return cast<FPMathOperator>(Val: this)->hasAllowContract();
696}
697
698bool Instruction::hasApproxFunc() const {
699 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
700 return cast<FPMathOperator>(Val: this)->hasApproxFunc();
701}
702
703FastMathFlags Instruction::getFastMathFlags() const {
704 assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
705 return cast<FPMathOperator>(Val: this)->getFastMathFlags();
706}
707
708FastMathFlags Instruction::getFastMathFlagsOrNone() const {
709 if (!isa<FPMathOperator>(Val: this))
710 return {};
711 return cast<FPMathOperator>(Val: this)->getFastMathFlags();
712}
713
714void Instruction::copyFastMathFlags(const Instruction *I) {
715 copyFastMathFlags(FMF: I->getFastMathFlags());
716}
717
718void Instruction::copyIRFlags(const Value *V, bool IncludeWrapFlags) {
719 // Copy the wrapping flags.
720 if (IncludeWrapFlags && isa<OverflowingBinaryOperator>(Val: this)) {
721 if (auto *OB = dyn_cast<OverflowingBinaryOperator>(Val: V)) {
722 setHasNoSignedWrap(OB->hasNoSignedWrap());
723 setHasNoUnsignedWrap(OB->hasNoUnsignedWrap());
724 }
725 }
726
727 if (auto *TI = dyn_cast<TruncInst>(Val: V)) {
728 if (isa<TruncInst>(Val: this)) {
729 setHasNoSignedWrap(TI->hasNoSignedWrap());
730 setHasNoUnsignedWrap(TI->hasNoUnsignedWrap());
731 }
732 }
733
734 // Copy the exact flag.
735 if (auto *PE = dyn_cast<PossiblyExactOperator>(Val: V))
736 if (isa<PossiblyExactOperator>(Val: this))
737 setIsExact(PE->isExact());
738
739 if (auto *SrcPD = dyn_cast<PossiblyDisjointInst>(Val: V))
740 if (auto *DestPD = dyn_cast<PossiblyDisjointInst>(Val: this))
741 DestPD->setIsDisjoint(SrcPD->isDisjoint());
742
743 // Copy the fast-math flags.
744 if (auto *FP = dyn_cast<FPMathOperator>(Val: V))
745 if (isa<FPMathOperator>(Val: this))
746 copyFastMathFlags(FMF: FP->getFastMathFlags());
747
748 if (auto *SrcGEP = dyn_cast<GetElementPtrInst>(Val: V))
749 if (auto *DestGEP = dyn_cast<GetElementPtrInst>(Val: this))
750 DestGEP->setNoWrapFlags(SrcGEP->getNoWrapFlags() |
751 DestGEP->getNoWrapFlags());
752
753 if (auto *NNI = dyn_cast<PossiblyNonNegInst>(Val: V))
754 if (isa<PossiblyNonNegInst>(Val: this))
755 setNonNeg(NNI->hasNonNeg());
756
757 if (auto *SrcICmp = dyn_cast<ICmpInst>(Val: V))
758 if (auto *DestICmp = dyn_cast<ICmpInst>(Val: this))
759 DestICmp->setSameSign(SrcICmp->hasSameSign());
760
761 if (auto *SrcASC = dyn_cast<AddrSpaceCastInst>(Val: V))
762 if (auto *DestASC = dyn_cast<AddrSpaceCastInst>(Val: this)) {
763 assert(DestASC->getSrcAddressSpace() == SrcASC->getSrcAddressSpace() &&
764 "nonull flag cannot be safely preserved with different source "
765 "address spaces");
766 DestASC->setNonNull(SrcASC->hasNonNull());
767 }
768}
769
770void Instruction::andIRFlags(const Value *V) {
771 if (auto *OB = dyn_cast<OverflowingBinaryOperator>(Val: V)) {
772 if (isa<OverflowingBinaryOperator>(Val: this)) {
773 setHasNoSignedWrap(hasNoSignedWrap() && OB->hasNoSignedWrap());
774 setHasNoUnsignedWrap(hasNoUnsignedWrap() && OB->hasNoUnsignedWrap());
775 }
776 }
777
778 if (auto *TI = dyn_cast<TruncInst>(Val: V)) {
779 if (isa<TruncInst>(Val: this)) {
780 setHasNoSignedWrap(hasNoSignedWrap() && TI->hasNoSignedWrap());
781 setHasNoUnsignedWrap(hasNoUnsignedWrap() && TI->hasNoUnsignedWrap());
782 }
783 }
784
785 if (auto *PE = dyn_cast<PossiblyExactOperator>(Val: V))
786 if (isa<PossiblyExactOperator>(Val: this))
787 setIsExact(isExact() && PE->isExact());
788
789 if (auto *SrcPD = dyn_cast<PossiblyDisjointInst>(Val: V))
790 if (auto *DestPD = dyn_cast<PossiblyDisjointInst>(Val: this))
791 DestPD->setIsDisjoint(DestPD->isDisjoint() && SrcPD->isDisjoint());
792
793 if (auto *FP = dyn_cast<FPMathOperator>(Val: V)) {
794 if (isa<FPMathOperator>(Val: this)) {
795 FastMathFlags FM = getFastMathFlags();
796 FM &= FP->getFastMathFlags();
797 copyFastMathFlags(FMF: FM);
798 }
799 }
800
801 if (auto *SrcGEP = dyn_cast<GetElementPtrInst>(Val: V))
802 if (auto *DestGEP = dyn_cast<GetElementPtrInst>(Val: this))
803 DestGEP->setNoWrapFlags(SrcGEP->getNoWrapFlags() &
804 DestGEP->getNoWrapFlags());
805
806 if (auto *NNI = dyn_cast<PossiblyNonNegInst>(Val: V))
807 if (isa<PossiblyNonNegInst>(Val: this))
808 setNonNeg(hasNonNeg() && NNI->hasNonNeg());
809
810 if (auto *SrcICmp = dyn_cast<ICmpInst>(Val: V))
811 if (auto *DestICmp = dyn_cast<ICmpInst>(Val: this))
812 DestICmp->setSameSign(DestICmp->hasSameSign() && SrcICmp->hasSameSign());
813
814 if (auto *SrcASC = dyn_cast<AddrSpaceCastInst>(Val: V))
815 if (auto *DestASC = dyn_cast<AddrSpaceCastInst>(Val: this)) {
816 assert(DestASC->getSrcAddressSpace() == SrcASC->getSrcAddressSpace() &&
817 "nonull flag cannot be safely preserved with different source "
818 "address spaces");
819 DestASC->setNonNull(DestASC->hasNonNull() && SrcASC->hasNonNull());
820 }
821}
822
823const char *Instruction::getOpcodeName(unsigned OpCode) {
824 // clang-format off
825 switch (OpCode) {
826 // Terminators
827 case Ret: return "ret";
828 case UncondBr: return "br";
829 case CondBr: return "br";
830 case Switch: return "switch";
831 case IndirectBr: return "indirectbr";
832 case Invoke: return "invoke";
833 case Resume: return "resume";
834 case Unreachable: return "unreachable";
835 case CleanupRet: return "cleanupret";
836 case CatchRet: return "catchret";
837 case CatchPad: return "catchpad";
838 case CatchSwitch: return "catchswitch";
839 case CallBr: return "callbr";
840
841 // Standard unary operators...
842 case FNeg: return "fneg";
843
844 // Standard binary operators...
845 case Add: return "add";
846 case FAdd: return "fadd";
847 case Sub: return "sub";
848 case FSub: return "fsub";
849 case Mul: return "mul";
850 case FMul: return "fmul";
851 case UDiv: return "udiv";
852 case SDiv: return "sdiv";
853 case FDiv: return "fdiv";
854 case URem: return "urem";
855 case SRem: return "srem";
856 case FRem: return "frem";
857
858 // Logical operators...
859 case And: return "and";
860 case Or : return "or";
861 case Xor: return "xor";
862
863 // Memory instructions...
864 case Alloca: return "alloca";
865 case Load: return "load";
866 case Store: return "store";
867 case AtomicCmpXchg: return "cmpxchg";
868 case AtomicRMW: return "atomicrmw";
869 case Fence: return "fence";
870 case GetElementPtr: return "getelementptr";
871
872 // Convert instructions...
873 case Trunc: return "trunc";
874 case ZExt: return "zext";
875 case SExt: return "sext";
876 case FPTrunc: return "fptrunc";
877 case FPExt: return "fpext";
878 case FPToUI: return "fptoui";
879 case FPToSI: return "fptosi";
880 case UIToFP: return "uitofp";
881 case SIToFP: return "sitofp";
882 case IntToPtr: return "inttoptr";
883 case PtrToAddr: return "ptrtoaddr";
884 case PtrToInt: return "ptrtoint";
885 case BitCast: return "bitcast";
886 case AddrSpaceCast: return "addrspacecast";
887
888 // Other instructions...
889 case ICmp: return "icmp";
890 case FCmp: return "fcmp";
891 case PHI: return "phi";
892 case Select: return "select";
893 case Call: return "call";
894 case Shl: return "shl";
895 case LShr: return "lshr";
896 case AShr: return "ashr";
897 case VAArg: return "va_arg";
898 case ExtractElement: return "extractelement";
899 case InsertElement: return "insertelement";
900 case ShuffleVector: return "shufflevector";
901 case ExtractValue: return "extractvalue";
902 case InsertValue: return "insertvalue";
903 case LandingPad: return "landingpad";
904 case CleanupPad: return "cleanuppad";
905 case Freeze: return "freeze";
906 case BitInsert: return "bitinsert";
907 case BitExtract: return "bitextract";
908
909 default: return "<Invalid operator> ";
910 }
911 // clang-format on
912}
913
914/// This must be kept in sync with FunctionComparator::cmpOperations in
915/// lib/Transforms/Utils/FunctionComparator.cpp.
916bool Instruction::hasSameSpecialState(const Instruction *I2,
917 bool IgnoreAlignment,
918 bool IntersectAttrs) const {
919 const auto *I1 = this;
920 assert(I1->getOpcode() == I2->getOpcode() &&
921 "Can not compare special state of different instructions");
922
923 auto CheckAttrsSame = [IntersectAttrs](const CallBase *CB0,
924 const CallBase *CB1) {
925 return IntersectAttrs
926 ? CB0->getAttributes()
927 .intersectWith(C&: CB0->getContext(), Other: CB1->getAttributes())
928 .has_value()
929 : CB0->getAttributes() == CB1->getAttributes();
930 };
931
932 if (const AllocaInst *AI = dyn_cast<AllocaInst>(Val: I1))
933 return AI->getAllocatedType() == cast<AllocaInst>(Val: I2)->getAllocatedType() &&
934 (AI->getAlign() == cast<AllocaInst>(Val: I2)->getAlign() ||
935 IgnoreAlignment);
936 if (const LoadInst *LI = dyn_cast<LoadInst>(Val: I1))
937 return LI->isVolatile() == cast<LoadInst>(Val: I2)->isVolatile() &&
938 LI->isElementwise() == cast<LoadInst>(Val: I2)->isElementwise() &&
939 (LI->getAlign() == cast<LoadInst>(Val: I2)->getAlign() ||
940 IgnoreAlignment) &&
941 LI->getOrdering() == cast<LoadInst>(Val: I2)->getOrdering() &&
942 LI->getSyncScopeID() == cast<LoadInst>(Val: I2)->getSyncScopeID();
943 if (const StoreInst *SI = dyn_cast<StoreInst>(Val: I1))
944 return SI->isVolatile() == cast<StoreInst>(Val: I2)->isVolatile() &&
945 SI->isElementwise() == cast<StoreInst>(Val: I2)->isElementwise() &&
946 (SI->getAlign() == cast<StoreInst>(Val: I2)->getAlign() ||
947 IgnoreAlignment) &&
948 SI->getOrdering() == cast<StoreInst>(Val: I2)->getOrdering() &&
949 SI->getSyncScopeID() == cast<StoreInst>(Val: I2)->getSyncScopeID();
950 if (const CmpInst *CI = dyn_cast<CmpInst>(Val: I1))
951 return CI->getPredicate() == cast<CmpInst>(Val: I2)->getPredicate();
952 if (const CallInst *CI = dyn_cast<CallInst>(Val: I1))
953 return CI->isTailCall() == cast<CallInst>(Val: I2)->isTailCall() &&
954 CI->getCallingConv() == cast<CallInst>(Val: I2)->getCallingConv() &&
955 CheckAttrsSame(CI, cast<CallInst>(Val: I2)) &&
956 CI->hasIdenticalOperandBundleSchema(Other: *cast<CallInst>(Val: I2));
957 if (const InvokeInst *CI = dyn_cast<InvokeInst>(Val: I1))
958 return CI->getCallingConv() == cast<InvokeInst>(Val: I2)->getCallingConv() &&
959 CheckAttrsSame(CI, cast<InvokeInst>(Val: I2)) &&
960 CI->hasIdenticalOperandBundleSchema(Other: *cast<InvokeInst>(Val: I2));
961 if (const CallBrInst *CI = dyn_cast<CallBrInst>(Val: I1))
962 return CI->getCallingConv() == cast<CallBrInst>(Val: I2)->getCallingConv() &&
963 CheckAttrsSame(CI, cast<CallBrInst>(Val: I2)) &&
964 CI->hasIdenticalOperandBundleSchema(Other: *cast<CallBrInst>(Val: I2));
965 if (const SwitchInst *SI = dyn_cast<SwitchInst>(Val: I1)) {
966 for (auto [Case1, Case2] : zip(t: SI->cases(), u: cast<SwitchInst>(Val: I2)->cases()))
967 if (Case1.getCaseValue() != Case2.getCaseValue())
968 return false;
969 return true;
970 }
971 if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(Val: I1))
972 return IVI->getIndices() == cast<InsertValueInst>(Val: I2)->getIndices();
973 if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(Val: I1))
974 return EVI->getIndices() == cast<ExtractValueInst>(Val: I2)->getIndices();
975 if (const FenceInst *FI = dyn_cast<FenceInst>(Val: I1))
976 return FI->getOrdering() == cast<FenceInst>(Val: I2)->getOrdering() &&
977 FI->getSyncScopeID() == cast<FenceInst>(Val: I2)->getSyncScopeID();
978 if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(Val: I1))
979 return CXI->isVolatile() == cast<AtomicCmpXchgInst>(Val: I2)->isVolatile() &&
980 (CXI->getAlign() == cast<AtomicCmpXchgInst>(Val: I2)->getAlign() ||
981 IgnoreAlignment) &&
982 CXI->isWeak() == cast<AtomicCmpXchgInst>(Val: I2)->isWeak() &&
983 CXI->getSuccessOrdering() ==
984 cast<AtomicCmpXchgInst>(Val: I2)->getSuccessOrdering() &&
985 CXI->getFailureOrdering() ==
986 cast<AtomicCmpXchgInst>(Val: I2)->getFailureOrdering() &&
987 CXI->getSyncScopeID() ==
988 cast<AtomicCmpXchgInst>(Val: I2)->getSyncScopeID();
989 if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(Val: I1))
990 return RMWI->getOperation() == cast<AtomicRMWInst>(Val: I2)->getOperation() &&
991 RMWI->isElementwise() == cast<AtomicRMWInst>(Val: I2)->isElementwise() &&
992 RMWI->isVolatile() == cast<AtomicRMWInst>(Val: I2)->isVolatile() &&
993 (RMWI->getAlign() == cast<AtomicRMWInst>(Val: I2)->getAlign() ||
994 IgnoreAlignment) &&
995 RMWI->getOrdering() == cast<AtomicRMWInst>(Val: I2)->getOrdering() &&
996 RMWI->getSyncScopeID() == cast<AtomicRMWInst>(Val: I2)->getSyncScopeID();
997 if (const ShuffleVectorInst *SVI = dyn_cast<ShuffleVectorInst>(Val: I1))
998 return SVI->getShuffleMask() ==
999 cast<ShuffleVectorInst>(Val: I2)->getShuffleMask();
1000 if (const GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Val: I1))
1001 return GEP->getSourceElementType() ==
1002 cast<GetElementPtrInst>(Val: I2)->getSourceElementType();
1003
1004 return true;
1005}
1006
1007bool Instruction::isIdenticalTo(const Instruction *I) const {
1008 return isIdenticalToWhenDefined(I) &&
1009 SubclassOptionalData == I->SubclassOptionalData;
1010}
1011
1012bool Instruction::isIdenticalToWhenDefined(const Instruction *I,
1013 bool IntersectAttrs) const {
1014 if (getOpcode() != I->getOpcode() ||
1015 getNumOperands() != I->getNumOperands() || getType() != I->getType())
1016 return false;
1017
1018 // If both instructions have no operands, they are identical.
1019 if (getNumOperands() == 0 && I->getNumOperands() == 0)
1020 return this->hasSameSpecialState(I2: I, /*IgnoreAlignment=*/false,
1021 IntersectAttrs);
1022
1023 // We have two instructions of identical opcode and #operands. Check to see
1024 // if all operands are the same.
1025 if (!equal(LRange: operands(), RRange: I->operands()))
1026 return false;
1027
1028 // WARNING: this logic must be kept in sync with EliminateDuplicatePHINodes()!
1029 if (const PHINode *Phi = dyn_cast<PHINode>(Val: this)) {
1030 const PHINode *OtherPhi = cast<PHINode>(Val: I);
1031 return equal(LRange: Phi->blocks(), RRange: OtherPhi->blocks());
1032 }
1033
1034 return this->hasSameSpecialState(I2: I, /*IgnoreAlignment=*/false,
1035 IntersectAttrs);
1036}
1037
1038// Keep this in sync with FunctionComparator::cmpOperations in
1039// lib/Transforms/IPO/MergeFunctions.cpp.
1040bool Instruction::isSameOperationAs(const Instruction *I,
1041 unsigned flags) const {
1042 bool IgnoreAlignment = flags & CompareIgnoringAlignment;
1043 bool UseScalarTypes = flags & CompareUsingScalarTypes;
1044 bool IntersectAttrs = flags & CompareUsingIntersectedAttrs;
1045 bool CheckCallTargets = flags & CompareCallTargets;
1046
1047 if (getOpcode() != I->getOpcode() ||
1048 getNumOperands() != I->getNumOperands() ||
1049 (UseScalarTypes ?
1050 getType()->getScalarType() != I->getType()->getScalarType() :
1051 getType() != I->getType()))
1052 return false;
1053
1054 // We have two instructions of identical opcode and #operands. Check to see
1055 // if all operands are the same type
1056 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1057 if (UseScalarTypes ?
1058 getOperand(i)->getType()->getScalarType() !=
1059 I->getOperand(i)->getType()->getScalarType() :
1060 getOperand(i)->getType() != I->getOperand(i)->getType())
1061 return false;
1062
1063 if (CheckCallTargets)
1064 if (const auto *CB = dyn_cast<CallBase>(Val: this))
1065 if (CB->getCalledOperand() != cast<CallBase>(Val: I)->getCalledOperand())
1066 return false;
1067
1068 return this->hasSameSpecialState(I2: I, IgnoreAlignment, IntersectAttrs);
1069}
1070
1071bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
1072 for (const Use &U : uses()) {
1073 // PHI nodes uses values in the corresponding predecessor block. For other
1074 // instructions, just check to see whether the parent of the use matches up.
1075 const Instruction *I = cast<Instruction>(Val: U.getUser());
1076 const PHINode *PN = dyn_cast<PHINode>(Val: I);
1077 if (!PN) {
1078 if (I->getParent() != BB)
1079 return true;
1080 continue;
1081 }
1082
1083 if (PN->getIncomingBlock(U) != BB)
1084 return true;
1085 }
1086 return false;
1087}
1088
1089MemoryEffects Instruction::getMemoryEffects() const {
1090 auto GetEffects = [](ModRefInfo BaseMR, AtomicOrdering Ordering,
1091 bool IsVolatile) {
1092 if (isStrongerThanMonotonic(AO: Ordering))
1093 return MemoryEffects::unknown();
1094
1095 if (IsVolatile)
1096 return MemoryEffects::inaccessibleOrArgMemOnly();
1097
1098 if (isStrongerThanUnordered(AO: Ordering))
1099 return MemoryEffects::argMemOnly();
1100
1101 return MemoryEffects::argMemOnly(MR: BaseMR);
1102 };
1103 switch (getOpcode()) {
1104 default:
1105 return MemoryEffects::none();
1106 case Instruction::VAArg:
1107 return MemoryEffects::argMemOnly();
1108 case Instruction::CatchPad:
1109 case Instruction::CatchRet:
1110 case Instruction::Fence:
1111 return MemoryEffects::unknown();
1112 case Instruction::Call:
1113 case Instruction::Invoke:
1114 case Instruction::CallBr:
1115 return cast<CallBase>(Val: this)->getMemoryEffects();
1116 case Instruction::Load: {
1117 auto *LI = cast<LoadInst>(Val: this);
1118 return GetEffects(ModRefInfo::Ref, LI->getOrdering(), LI->isVolatile());
1119 }
1120 case Instruction::Store: {
1121 auto *SI = cast<StoreInst>(Val: this);
1122 return GetEffects(ModRefInfo::Mod, SI->getOrdering(), SI->isVolatile());
1123 }
1124 case Instruction::AtomicRMW: {
1125 auto *RMW = cast<AtomicRMWInst>(Val: this);
1126 return GetEffects(ModRefInfo::ModRef, RMW->getOrdering(),
1127 RMW->isVolatile());
1128 }
1129 case Instruction::AtomicCmpXchg: {
1130 auto *CX = cast<AtomicCmpXchgInst>(Val: this);
1131 return GetEffects(ModRefInfo::ModRef, CX->getMergedOrdering(),
1132 CX->isVolatile());
1133 }
1134 }
1135}
1136
1137// This is duplicating the logic from getMemoryEffects() for performance
1138// reasons. Computing the full MemoryEffects just to perform a Mod/Ref check
1139// is expensive.
1140
1141bool Instruction::mayReadFromMemory() const {
1142 switch (getOpcode()) {
1143 default: return false;
1144 case Instruction::VAArg:
1145 case Instruction::Load:
1146 case Instruction::Fence: // FIXME: refine definition of mayReadFromMemory
1147 case Instruction::AtomicCmpXchg:
1148 case Instruction::AtomicRMW:
1149 case Instruction::CatchPad:
1150 case Instruction::CatchRet:
1151 return true;
1152 case Instruction::Call:
1153 case Instruction::Invoke:
1154 case Instruction::CallBr:
1155 return !cast<CallBase>(Val: this)->onlyWritesMemory();
1156 case Instruction::Store:
1157 return !cast<StoreInst>(Val: this)->isUnordered();
1158 }
1159}
1160
1161bool Instruction::mayWriteToMemory() const {
1162 switch (getOpcode()) {
1163 default: return false;
1164 case Instruction::Fence: // FIXME: refine definition of mayWriteToMemory
1165 case Instruction::Store:
1166 case Instruction::VAArg:
1167 case Instruction::AtomicCmpXchg:
1168 case Instruction::AtomicRMW:
1169 case Instruction::CatchPad:
1170 case Instruction::CatchRet:
1171 return true;
1172 case Instruction::Call:
1173 case Instruction::Invoke:
1174 case Instruction::CallBr:
1175 return !cast<CallBase>(Val: this)->onlyReadsMemory();
1176 case Instruction::Load:
1177 return !cast<LoadInst>(Val: this)->isUnordered();
1178 }
1179}
1180
1181bool Instruction::isAtomic() const {
1182 switch (getOpcode()) {
1183 default:
1184 return false;
1185 case Instruction::AtomicCmpXchg:
1186 case Instruction::AtomicRMW:
1187 case Instruction::Fence:
1188 return true;
1189 case Instruction::Load:
1190 return cast<LoadInst>(Val: this)->getOrdering() != AtomicOrdering::NotAtomic;
1191 case Instruction::Store:
1192 return cast<StoreInst>(Val: this)->getOrdering() != AtomicOrdering::NotAtomic;
1193 }
1194}
1195
1196bool Instruction::hasAtomicLoad() const {
1197 assert(isAtomic());
1198 switch (getOpcode()) {
1199 default:
1200 return false;
1201 case Instruction::AtomicCmpXchg:
1202 case Instruction::AtomicRMW:
1203 case Instruction::Load:
1204 return true;
1205 }
1206}
1207
1208bool Instruction::hasAtomicStore() const {
1209 assert(isAtomic());
1210 switch (getOpcode()) {
1211 default:
1212 return false;
1213 case Instruction::AtomicCmpXchg:
1214 case Instruction::AtomicRMW:
1215 case Instruction::Store:
1216 return true;
1217 }
1218}
1219
1220bool Instruction::isVolatile() const {
1221 switch (getOpcode()) {
1222 default:
1223 return false;
1224 case Instruction::AtomicRMW:
1225 return cast<AtomicRMWInst>(Val: this)->isVolatile();
1226 case Instruction::Store:
1227 return cast<StoreInst>(Val: this)->isVolatile();
1228 case Instruction::Load:
1229 return cast<LoadInst>(Val: this)->isVolatile();
1230 case Instruction::AtomicCmpXchg:
1231 return cast<AtomicCmpXchgInst>(Val: this)->isVolatile();
1232 case Instruction::Call:
1233 case Instruction::Invoke:
1234 // There are a very limited number of intrinsics with volatile flags.
1235 if (auto *II = dyn_cast<IntrinsicInst>(Val: this)) {
1236 if (auto *MI = dyn_cast<MemIntrinsic>(Val: II))
1237 return MI->isVolatile();
1238 switch (II->getIntrinsicID()) {
1239 default: break;
1240 case Intrinsic::matrix_column_major_load:
1241 return cast<ConstantInt>(Val: II->getArgOperand(i: 2))->isOne();
1242 case Intrinsic::matrix_column_major_store:
1243 return cast<ConstantInt>(Val: II->getArgOperand(i: 3))->isOne();
1244 }
1245 }
1246 return false;
1247 }
1248}
1249
1250bool Instruction::maySynchronize() const {
1251 switch (getOpcode()) {
1252 default:
1253 assert(!isAtomic() && "Unhandled atomic instruction");
1254 return false;
1255 case Instruction::Fence: {
1256 // All legal orderings for fence are stronger than monotonic.
1257 auto *FI = cast<FenceInst>(Val: this);
1258 return FI->getSyncScopeID() != SyncScope::SingleThread;
1259 }
1260 case Instruction::AtomicRMW:
1261 return isStrongerThanMonotonic(AO: cast<AtomicRMWInst>(Val: this)->getOrdering());
1262 case Instruction::AtomicCmpXchg: {
1263 auto *ACXI = cast<AtomicCmpXchgInst>(Val: this);
1264 return isStrongerThanMonotonic(AO: ACXI->getSuccessOrdering()) ||
1265 isStrongerThanMonotonic(AO: ACXI->getFailureOrdering());
1266 }
1267 case Instruction::Store:
1268 return isStrongerThanMonotonic(AO: cast<StoreInst>(Val: this)->getOrdering());
1269 case Instruction::Load:
1270 return isStrongerThanMonotonic(AO: cast<LoadInst>(Val: this)->getOrdering());
1271 case Instruction::Call:
1272 case Instruction::Invoke:
1273 case Instruction::CallBr:
1274 return !cast<CallBase>(Val: this)->hasFnAttr(Kind: Attribute::NoSync);
1275 }
1276}
1277
1278Type *Instruction::getAccessType() const {
1279 switch (getOpcode()) {
1280 case Instruction::Store:
1281 return cast<StoreInst>(Val: this)->getValueOperand()->getType();
1282 case Instruction::Load:
1283 case Instruction::AtomicRMW:
1284 return getType();
1285 case Instruction::AtomicCmpXchg:
1286 return cast<AtomicCmpXchgInst>(Val: this)->getNewValOperand()->getType();
1287 case Instruction::Call:
1288 case Instruction::Invoke:
1289 if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Val: this)) {
1290 switch (II->getIntrinsicID()) {
1291 case Intrinsic::masked_load:
1292 case Intrinsic::masked_gather:
1293 case Intrinsic::masked_expandload:
1294 case Intrinsic::vp_load:
1295 case Intrinsic::vp_gather:
1296 case Intrinsic::experimental_vp_strided_load:
1297 return II->getType();
1298 case Intrinsic::masked_store:
1299 case Intrinsic::masked_scatter:
1300 case Intrinsic::masked_compressstore:
1301 case Intrinsic::vp_store:
1302 case Intrinsic::vp_scatter:
1303 case Intrinsic::experimental_vp_strided_store:
1304 return II->getOperand(i_nocapture: 0)->getType();
1305 default:
1306 break;
1307 }
1308 }
1309 }
1310
1311 return nullptr;
1312}
1313
1314static bool canUnwindPastLandingPad(const LandingPadInst *LP,
1315 bool IncludePhaseOneUnwind) {
1316 // Because phase one unwinding skips cleanup landingpads, we effectively
1317 // unwind past this frame, and callers need to have valid unwind info.
1318 if (LP->isCleanup())
1319 return IncludePhaseOneUnwind;
1320
1321 for (unsigned I = 0; I < LP->getNumClauses(); ++I) {
1322 Constant *Clause = LP->getClause(Idx: I);
1323 // catch ptr null catches all exceptions.
1324 if (LP->isCatch(Idx: I) && isa<ConstantPointerNull>(Val: Clause))
1325 return false;
1326 // filter [0 x ptr] catches all exceptions.
1327 if (LP->isFilter(Idx: I) && Clause->getType()->getArrayNumElements() == 0)
1328 return false;
1329 }
1330
1331 // May catch only some subset of exceptions, in which case other exceptions
1332 // will continue unwinding.
1333 return true;
1334}
1335
1336bool Instruction::mayThrow(bool IncludePhaseOneUnwind) const {
1337 switch (getOpcode()) {
1338 case Instruction::Call:
1339 return !cast<CallInst>(Val: this)->doesNotThrow();
1340 case Instruction::CleanupRet:
1341 return cast<CleanupReturnInst>(Val: this)->unwindsToCaller();
1342 case Instruction::CatchSwitch:
1343 return cast<CatchSwitchInst>(Val: this)->unwindsToCaller();
1344 case Instruction::Resume:
1345 return true;
1346 case Instruction::Invoke: {
1347 // Landingpads themselves don't unwind -- however, an invoke of a skipped
1348 // landingpad may continue unwinding.
1349 BasicBlock *UnwindDest = cast<InvokeInst>(Val: this)->getUnwindDest();
1350 BasicBlock::iterator Pad = UnwindDest->getFirstNonPHIIt();
1351 if (auto *LP = dyn_cast<LandingPadInst>(Val&: Pad))
1352 return canUnwindPastLandingPad(LP, IncludePhaseOneUnwind);
1353 return false;
1354 }
1355 case Instruction::CleanupPad:
1356 // Treat the same as cleanup landingpad.
1357 return IncludePhaseOneUnwind;
1358 default:
1359 return false;
1360 }
1361}
1362
1363bool Instruction::mayHaveSideEffects() const {
1364 return mayWriteToMemory() || mayThrow() || !willReturn();
1365}
1366
1367bool Instruction::isSafeToRemove() const {
1368 return (!isa<CallInst>(Val: this) || !this->mayHaveSideEffects()) &&
1369 !this->isTerminator() && !this->isEHPad();
1370}
1371
1372bool Instruction::willReturn() const {
1373 // Volatile operations are not guaranteed to return.
1374 if (isVolatile())
1375 return false;
1376
1377 if (const auto *CB = dyn_cast<CallBase>(Val: this))
1378 return CB->hasFnAttr(Kind: Attribute::WillReturn);
1379 return true;
1380}
1381
1382bool Instruction::isLifetimeStartOrEnd() const {
1383 auto *II = dyn_cast<IntrinsicInst>(Val: this);
1384 if (!II)
1385 return false;
1386 Intrinsic::ID ID = II->getIntrinsicID();
1387 return ID == Intrinsic::lifetime_start || ID == Intrinsic::lifetime_end;
1388}
1389
1390bool Instruction::isDebugOrPseudoInst() const {
1391 return isa<DbgInfoIntrinsic>(Val: this) || isa<PseudoProbeInst>(Val: this);
1392}
1393
1394const DebugLoc &Instruction::getStableDebugLoc() const {
1395 return getDebugLoc();
1396}
1397
1398bool Instruction::isAssociative() const {
1399 if (auto *II = dyn_cast<IntrinsicInst>(Val: this))
1400 return II->isAssociative();
1401 unsigned Opcode = getOpcode();
1402 if (isAssociative(Opcode))
1403 return true;
1404
1405 switch (Opcode) {
1406 case FMul:
1407 return cast<FPMathOperator>(Val: this)->hasAllowReassoc();
1408 case FAdd:
1409 return cast<FPMathOperator>(Val: this)->hasAllowReassoc() &&
1410 cast<FPMathOperator>(Val: this)->hasNoSignedZeros();
1411 default:
1412 return false;
1413 }
1414}
1415
1416bool Instruction::isCommutative() const {
1417 if (auto *II = dyn_cast<IntrinsicInst>(Val: this))
1418 return II->isCommutative();
1419 // TODO: Should allow icmp/fcmp?
1420 return isCommutative(Opcode: getOpcode());
1421}
1422
1423bool Instruction::isCommutableOperand(unsigned Op) const {
1424 if (auto *II = dyn_cast<IntrinsicInst>(Val: this))
1425 return II->isCommutableOperand(Op);
1426 // TODO: Should allow icmp/fcmp?
1427 return isCommutative(Opcode: getOpcode());
1428}
1429
1430unsigned Instruction::getNumSuccessors() const {
1431 switch (getOpcode()) {
1432#define HANDLE_TERM_INST(N, OPC, CLASS) \
1433 case Instruction::OPC: \
1434 return static_cast<const CLASS *>(this)->getNumSuccessors();
1435#include "llvm/IR/Instruction.def"
1436 default:
1437 break;
1438 }
1439 llvm_unreachable("not a terminator");
1440}
1441
1442BasicBlock *Instruction::getSuccessor(unsigned idx) const {
1443 switch (getOpcode()) {
1444#define HANDLE_TERM_INST(N, OPC, CLASS) \
1445 case Instruction::OPC: \
1446 return static_cast<const CLASS *>(this)->getSuccessor(idx);
1447#include "llvm/IR/Instruction.def"
1448 default:
1449 break;
1450 }
1451 llvm_unreachable("not a terminator");
1452}
1453
1454void Instruction::setSuccessor(unsigned idx, BasicBlock *B) {
1455 switch (getOpcode()) {
1456#define HANDLE_TERM_INST(N, OPC, CLASS) \
1457 case Instruction::OPC: \
1458 return static_cast<CLASS *>(this)->setSuccessor(idx, B);
1459#include "llvm/IR/Instruction.def"
1460 default:
1461 break;
1462 }
1463 llvm_unreachable("not a terminator");
1464}
1465
1466iterator_range<Instruction::const_succ_iterator>
1467Instruction::successors() const {
1468 switch (getOpcode()) {
1469#define HANDLE_TERM_INST(N, OPC, CLASS) \
1470 case Instruction::OPC: \
1471 return static_cast<const CLASS *>(this)->successors();
1472#include "llvm/IR/Instruction.def"
1473 default:
1474 break;
1475 }
1476 llvm_unreachable("not a terminator");
1477}
1478
1479void Instruction::replaceSuccessorWith(BasicBlock *OldBB, BasicBlock *NewBB) {
1480 auto Succs = successors();
1481 for (auto I = Succs.begin(), E = Succs.end(); I != E; ++I)
1482 if (*I == OldBB)
1483 I.getUse()->set(NewBB);
1484}
1485
1486Instruction *Instruction::cloneImpl() const {
1487 llvm_unreachable("Subclass of Instruction failed to implement cloneImpl");
1488}
1489
1490void Instruction::swapProfMetadata() {
1491 MDNode *ProfileData = getBranchWeightMDNode(I: *this);
1492 if (!ProfileData)
1493 return;
1494 unsigned FirstIdx = getBranchWeightOffset(ProfileData);
1495 if (ProfileData->getNumOperands() != 2 + FirstIdx)
1496 return;
1497
1498 unsigned SecondIdx = FirstIdx + 1;
1499 SmallVector<Metadata *, 4> Ops;
1500 // If there are more weights past the second, we can't swap them
1501 if (ProfileData->getNumOperands() > SecondIdx + 1)
1502 return;
1503 for (unsigned Idx = 0; Idx < FirstIdx; ++Idx) {
1504 Ops.push_back(Elt: ProfileData->getOperand(I: Idx));
1505 }
1506 // Switch the order of the weights
1507 Ops.push_back(Elt: ProfileData->getOperand(I: SecondIdx));
1508 Ops.push_back(Elt: ProfileData->getOperand(I: FirstIdx));
1509 setMetadata(KindID: LLVMContext::MD_prof,
1510 Node: MDNode::get(Context&: ProfileData->getContext(), MDs: Ops));
1511}
1512
1513void Instruction::copyProfileAndDebugMetadata(const Instruction &SrcInst) {
1514 // TODO: Include additional metadata in the future if appropriate.
1515 static const unsigned SafeIDs[] = {
1516 LLVMContext::MD_dbg, LLVMContext::MD_prof, LLVMContext::MD_memprof,
1517 LLVMContext::MD_callsite};
1518 copyMetadata(SrcInst, WL: SafeIDs);
1519}
1520
1521void Instruction::copyMetadata(const Instruction &SrcInst,
1522 ArrayRef<unsigned> WL) {
1523 if (WL.empty() || is_contained(Range&: WL, Element: LLVMContext::MD_dbg))
1524 setDebugLoc(SrcInst.getDebugLoc().orElse(Other: getDebugLoc()));
1525
1526 if (!SrcInst.hasMetadata())
1527 return;
1528
1529 SmallDenseSet<unsigned, 4> WLS(WL.begin(), WL.end());
1530
1531 // Otherwise, enumerate and copy over metadata from the old instruction to the
1532 // new one.
1533 SmallVector<std::pair<unsigned, MDNode *>, 4> TheMDs;
1534 SrcInst.getAllMetadataOtherThanDebugLoc(MDs&: TheMDs);
1535 for (const auto &MD : TheMDs) {
1536 if (WL.empty() || WLS.count(V: MD.first))
1537 setMetadata(KindID: MD.first, Node: MD.second);
1538 }
1539}
1540
1541Instruction *Instruction::clone() const {
1542 Instruction *New = nullptr;
1543 switch (getOpcode()) {
1544 default:
1545 llvm_unreachable("Unhandled Opcode.");
1546#define HANDLE_INST(num, opc, clas) \
1547 case Instruction::opc: \
1548 New = cast<clas>(this)->cloneImpl(); \
1549 break;
1550#include "llvm/IR/Instruction.def"
1551#undef HANDLE_INST
1552 }
1553
1554 New->SubclassOptionalData = SubclassOptionalData;
1555 New->copyMetadata(SrcInst: *this);
1556 return New;
1557}
1558