1//===- Instructions.cpp - Implement the LLVM instructions -----------------===//
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 all of the non-inline methods for the LLVM instruction
10// classes.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/IR/Instructions.h"
15#include "LLVMContextImpl.h"
16#include "llvm/ADT/SmallBitVector.h"
17#include "llvm/ADT/SmallVector.h"
18#include "llvm/ADT/Twine.h"
19#include "llvm/IR/Attributes.h"
20#include "llvm/IR/BasicBlock.h"
21#include "llvm/IR/Constant.h"
22#include "llvm/IR/ConstantRange.h"
23#include "llvm/IR/Constants.h"
24#include "llvm/IR/DataLayout.h"
25#include "llvm/IR/DerivedTypes.h"
26#include "llvm/IR/Function.h"
27#include "llvm/IR/InstrTypes.h"
28#include "llvm/IR/Instruction.h"
29#include "llvm/IR/Intrinsics.h"
30#include "llvm/IR/LLVMContext.h"
31#include "llvm/IR/MDBuilder.h"
32#include "llvm/IR/Metadata.h"
33#include "llvm/IR/Module.h"
34#include "llvm/IR/Operator.h"
35#include "llvm/IR/PatternMatch.h"
36#include "llvm/IR/ProfDataUtils.h"
37#include "llvm/IR/Type.h"
38#include "llvm/IR/Value.h"
39#include "llvm/Support/AtomicOrdering.h"
40#include "llvm/Support/Casting.h"
41#include "llvm/Support/CheckedArithmetic.h"
42#include "llvm/Support/Compiler.h"
43#include "llvm/Support/ErrorHandling.h"
44#include "llvm/Support/KnownBits.h"
45#include "llvm/Support/MathExtras.h"
46#include "llvm/Support/ModRef.h"
47#include "llvm/Support/TypeSize.h"
48#include <algorithm>
49#include <cassert>
50#include <cstdint>
51#include <optional>
52#include <vector>
53
54using namespace llvm;
55
56static cl::opt<bool> DisableI2pP2iOpt(
57 "disable-i2p-p2i-opt", cl::init(Val: false),
58 cl::desc("Disables inttoptr/ptrtoint roundtrip optimization"));
59
60//===----------------------------------------------------------------------===//
61// AllocaInst Class
62//===----------------------------------------------------------------------===//
63
64std::optional<TypeSize>
65AllocaInst::getAllocationSize(const DataLayout &DL) const {
66 TypeSize Size = DL.getTypeAllocSize(Ty: getAllocatedType());
67 // Zero-sized types can return early since 0 * N = 0 for any array size N.
68 if (Size.isZero())
69 return Size;
70 if (isArrayAllocation()) {
71 auto *C = dyn_cast<ConstantInt>(Val: getArraySize());
72 if (!C)
73 return std::nullopt;
74 std::optional<uint64_t> NumElements = C->getValue().tryZExtValue();
75 if (!NumElements)
76 return std::nullopt;
77 assert(!Size.isScalable() && "Array elements cannot have a scalable size");
78 auto CheckedProd =
79 checkedMulUnsigned(LHS: Size.getKnownMinValue(), RHS: *NumElements);
80 if (!CheckedProd)
81 return std::nullopt;
82 return TypeSize::getFixed(ExactSize: *CheckedProd);
83 }
84 return Size;
85}
86
87std::optional<TypeSize>
88AllocaInst::getAllocationSizeInBits(const DataLayout &DL) const {
89 std::optional<TypeSize> Size = getAllocationSize(DL);
90 if (!Size)
91 return std::nullopt;
92 auto CheckedProd = checkedMulUnsigned(LHS: Size->getKnownMinValue(),
93 RHS: static_cast<TypeSize::ScalarTy>(8));
94 if (!CheckedProd)
95 return std::nullopt;
96 return TypeSize::get(Quantity: *CheckedProd, Scalable: Size->isScalable());
97}
98
99//===----------------------------------------------------------------------===//
100// SelectInst Class
101//===----------------------------------------------------------------------===//
102
103/// areInvalidOperands - Return a string if the specified operands are invalid
104/// for a select operation, otherwise return null.
105const char *SelectInst::areInvalidOperands(Value *Op0, Value *Op1, Value *Op2) {
106 if (Op1->getType() != Op2->getType())
107 return "both values to select must have same type";
108
109 if (Op1->getType()->isTokenTy())
110 return "select values cannot have token type";
111
112 if (VectorType *VT = dyn_cast<VectorType>(Val: Op0->getType())) {
113 // Vector select.
114 if (VT->getElementType() != Type::getInt1Ty(C&: Op0->getContext()))
115 return "vector select condition element type must be i1";
116 VectorType *ET = dyn_cast<VectorType>(Val: Op1->getType());
117 if (!ET)
118 return "selected values for vector select must be vectors";
119 if (ET->getElementCount() != VT->getElementCount())
120 return "vector select requires selected vectors to have "
121 "the same vector length as select condition";
122 } else if (Op0->getType() != Type::getInt1Ty(C&: Op0->getContext())) {
123 return "select condition must be i1 or <n x i1>";
124 }
125 return nullptr;
126}
127
128//===----------------------------------------------------------------------===//
129// PHINode Class
130//===----------------------------------------------------------------------===//
131
132PHINode::PHINode(const PHINode &PN)
133 : Instruction(PN.getType(), Instruction::PHI, AllocMarker),
134 ReservedSpace(PN.getNumOperands()) {
135 NumUserOperands = PN.getNumOperands();
136 allocHungoffUses(N: PN.getNumOperands());
137 std::copy(first: PN.op_begin(), last: PN.op_end(), result: op_begin());
138 copyIncomingBlocks(BBRange: make_range(x: PN.block_begin(), y: PN.block_end()));
139 FMF = PN.FMF;
140}
141
142// removeIncomingValue - Remove an incoming value. This is useful if a
143// predecessor basic block is deleted.
144Value *PHINode::removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty) {
145 Value *Removed = getIncomingValue(i: Idx);
146 // Swap with the end of the list.
147 unsigned Last = getNumOperands() - 1;
148 if (Idx != Last) {
149 setIncomingValue(i: Idx, V: getIncomingValue(i: Last));
150 setIncomingBlock(i: Idx, BB: getIncomingBlock(i: Last));
151 }
152
153 // Nuke the last value.
154 Op<-1>().set(nullptr);
155 setNumHungOffUseOperands(getNumOperands() - 1);
156
157 // If the PHI node is dead, because it has zero entries, nuke it now.
158 if (getNumOperands() == 0 && DeletePHIIfEmpty) {
159 // If anyone is using this PHI, make them use a dummy value instead...
160 replaceAllUsesWith(V: PoisonValue::get(T: getType()));
161 eraseFromParent();
162 }
163 return Removed;
164}
165
166void PHINode::removeIncomingValueIf(function_ref<bool(unsigned)> Predicate,
167 bool DeletePHIIfEmpty) {
168 unsigned NumOps = getNumIncomingValues();
169
170 // Loop backwards in case the predicate is purely index based.
171 for (unsigned Idx = NumOps; Idx-- > 0;) {
172 if (Predicate(Idx)) {
173 unsigned LastIdx = NumOps - 1;
174 if (Idx != LastIdx) {
175 setIncomingValue(i: Idx, V: getIncomingValue(i: LastIdx));
176 setIncomingBlock(i: Idx, BB: getIncomingBlock(i: LastIdx));
177 }
178 getOperandUse(i: LastIdx).set(nullptr);
179 NumOps--;
180 }
181 }
182
183 setNumHungOffUseOperands(NumOps);
184
185 // If the PHI node is dead, because it has zero entries, nuke it now.
186 if (getNumOperands() == 0 && DeletePHIIfEmpty) {
187 // If anyone is using this PHI, make them use a dummy value instead...
188 replaceAllUsesWith(V: PoisonValue::get(T: getType()));
189 eraseFromParent();
190 }
191}
192
193/// growOperands - grow operands - This grows the operand list in response
194/// to a push_back style of operation. This grows the number of ops by 1.5
195/// times.
196///
197void PHINode::growOperands() {
198 unsigned e = getNumOperands();
199 unsigned NumOps = e + e / 2;
200 if (NumOps < 2) NumOps = 2; // 2 op PHI nodes are VERY common.
201
202 ReservedSpace = NumOps;
203 growHungoffUses(N: ReservedSpace, /*WithExtraValues=*/true);
204}
205
206/// hasConstantValue - If the specified PHI node always merges together the same
207/// value, return the value, otherwise return null.
208Value *PHINode::hasConstantValue() const {
209 // Exploit the fact that phi nodes always have at least one entry.
210 Value *ConstantValue = getIncomingValue(i: 0);
211 for (unsigned i = 1, e = getNumIncomingValues(); i != e; ++i)
212 if (getIncomingValue(i) != ConstantValue && getIncomingValue(i) != this) {
213 if (ConstantValue != this)
214 return nullptr; // Incoming values not all the same.
215 // The case where the first value is this PHI.
216 ConstantValue = getIncomingValue(i);
217 }
218 if (ConstantValue == this)
219 return PoisonValue::get(T: getType());
220 return ConstantValue;
221}
222
223/// hasConstantOrUndefValue - Whether the specified PHI node always merges
224/// together the same value, assuming that undefs result in the same value as
225/// non-undefs.
226/// Unlike \ref hasConstantValue, this does not return a value because the
227/// unique non-undef incoming value need not dominate the PHI node.
228bool PHINode::hasConstantOrUndefValue() const {
229 Value *ConstantValue = nullptr;
230 for (unsigned i = 0, e = getNumIncomingValues(); i != e; ++i) {
231 Value *Incoming = getIncomingValue(i);
232 if (Incoming != this && !isa<UndefValue>(Val: Incoming)) {
233 if (ConstantValue && ConstantValue != Incoming)
234 return false;
235 ConstantValue = Incoming;
236 }
237 }
238 return true;
239}
240
241//===----------------------------------------------------------------------===//
242// LandingPadInst Implementation
243//===----------------------------------------------------------------------===//
244
245LandingPadInst::LandingPadInst(Type *RetTy, unsigned NumReservedValues,
246 const Twine &NameStr,
247 InsertPosition InsertBefore)
248 : Instruction(RetTy, Instruction::LandingPad, AllocMarker, InsertBefore) {
249 init(NumReservedValues, NameStr);
250}
251
252LandingPadInst::LandingPadInst(const LandingPadInst &LP)
253 : Instruction(LP.getType(), Instruction::LandingPad, AllocMarker),
254 ReservedSpace(LP.getNumOperands()) {
255 NumUserOperands = LP.getNumOperands();
256 allocHungoffUses(N: LP.getNumOperands());
257 Use *OL = getOperandList();
258 const Use *InOL = LP.getOperandList();
259 for (unsigned I = 0, E = ReservedSpace; I != E; ++I)
260 OL[I] = InOL[I];
261
262 setCleanup(LP.isCleanup());
263}
264
265LandingPadInst *LandingPadInst::Create(Type *RetTy, unsigned NumReservedClauses,
266 const Twine &NameStr,
267 InsertPosition InsertBefore) {
268 return new LandingPadInst(RetTy, NumReservedClauses, NameStr, InsertBefore);
269}
270
271void LandingPadInst::init(unsigned NumReservedValues, const Twine &NameStr) {
272 ReservedSpace = NumReservedValues;
273 setNumHungOffUseOperands(0);
274 allocHungoffUses(N: ReservedSpace);
275 setName(NameStr);
276 setCleanup(false);
277}
278
279/// growOperands - grow operands - This grows the operand list in response to a
280/// push_back style of operation. This grows the number of ops by 2 times.
281void LandingPadInst::growOperands(unsigned Size) {
282 unsigned e = getNumOperands();
283 if (ReservedSpace >= e + Size) return;
284 ReservedSpace = (std::max(a: e, b: 1U) + Size / 2) * 2;
285 growHungoffUses(N: ReservedSpace);
286}
287
288void LandingPadInst::addClause(Constant *Val) {
289 unsigned OpNo = getNumOperands();
290 growOperands(Size: 1);
291 assert(OpNo < ReservedSpace && "Growing didn't work!");
292 setNumHungOffUseOperands(getNumOperands() + 1);
293 getOperandList()[OpNo] = Val;
294}
295
296//===----------------------------------------------------------------------===//
297// CallBase Implementation
298//===----------------------------------------------------------------------===//
299
300CallBase *CallBase::Create(CallBase *CB, ArrayRef<OperandBundleDef> Bundles,
301 InsertPosition InsertPt) {
302 switch (CB->getOpcode()) {
303 case Instruction::Call:
304 return CallInst::Create(CI: cast<CallInst>(Val: CB), Bundles, InsertPt);
305 case Instruction::Invoke:
306 return InvokeInst::Create(II: cast<InvokeInst>(Val: CB), Bundles, InsertPt);
307 case Instruction::CallBr:
308 return CallBrInst::Create(CBI: cast<CallBrInst>(Val: CB), Bundles, InsertBefore: InsertPt);
309 default:
310 llvm_unreachable("Unknown CallBase sub-class!");
311 }
312}
313
314CallBase *CallBase::Create(CallBase *CI, OperandBundleDef OpB,
315 InsertPosition InsertPt) {
316 SmallVector<OperandBundleDef, 2> OpDefs;
317 for (unsigned i = 0, e = CI->getNumOperandBundles(); i < e; ++i) {
318 auto ChildOB = CI->getOperandBundleAt(Index: i);
319 if (ChildOB.getTagName() != OpB.getTag())
320 OpDefs.emplace_back(Args&: ChildOB);
321 }
322 OpDefs.emplace_back(Args&: OpB);
323 return CallBase::Create(CB: CI, Bundles: OpDefs, InsertPt);
324}
325
326Function *CallBase::getCaller() { return getParent()->getParent(); }
327
328unsigned CallBase::getNumSubclassExtraOperandsDynamic() const {
329 assert(getOpcode() == Instruction::CallBr && "Unexpected opcode!");
330 return cast<CallBrInst>(Val: this)->getNumIndirectDests() + 1;
331}
332
333bool CallBase::isIndirectCall() const {
334 const Value *V = getCalledOperand();
335 if (isa<Function>(Val: V) || isa<Constant>(Val: V))
336 return false;
337 return !isInlineAsm();
338}
339
340/// Tests if this call site must be tail call optimized. Only a CallInst can
341/// be tail call optimized.
342bool CallBase::isMustTailCall() const {
343 if (auto *CI = dyn_cast<CallInst>(Val: this))
344 return CI->isMustTailCall();
345 return false;
346}
347
348/// Tests if this call site is marked as a tail call.
349bool CallBase::isTailCall() const {
350 if (auto *CI = dyn_cast<CallInst>(Val: this))
351 return CI->isTailCall();
352 return false;
353}
354
355Intrinsic::ID CallBase::getIntrinsicID() const {
356 if (auto *F = dyn_cast_or_null<Function>(Val: getCalledOperand()))
357 return F->getIntrinsicID();
358 return Intrinsic::not_intrinsic;
359}
360
361FPClassTest CallBase::getRetNoFPClass() const {
362 FPClassTest Mask = Attrs.getRetNoFPClass();
363
364 if (const Function *F = getCalledFunction())
365 Mask |= F->getAttributes().getRetNoFPClass();
366 return Mask;
367}
368
369FPClassTest CallBase::getParamNoFPClass(unsigned i) const {
370 FPClassTest Mask = Attrs.getParamNoFPClass(ArgNo: i);
371
372 if (const Function *F = getCalledFunction())
373 Mask |= F->getAttributes().getParamNoFPClass(ArgNo: i);
374 return Mask;
375}
376
377std::optional<ConstantRange> CallBase::getRange() const {
378 Attribute CallAttr = Attrs.getRetAttr(Kind: Attribute::Range);
379 Attribute FnAttr;
380 if (const Function *F = getCalledFunction())
381 FnAttr = F->getRetAttribute(Kind: Attribute::Range);
382
383 if (CallAttr.isValid() && FnAttr.isValid())
384 return CallAttr.getRange().intersectWith(CR: FnAttr.getRange());
385 if (CallAttr.isValid())
386 return CallAttr.getRange();
387 if (FnAttr.isValid())
388 return FnAttr.getRange();
389 return std::nullopt;
390}
391
392bool CallBase::isReturnNonNull() const {
393 if (hasRetAttr(Kind: Attribute::NonNull))
394 return true;
395
396 if (getRetDereferenceableBytes() > 0 &&
397 !NullPointerIsDefined(F: getCaller(), AS: getType()->getPointerAddressSpace()))
398 return true;
399
400 return false;
401}
402
403Value *CallBase::getArgOperandWithAttribute(Attribute::AttrKind Kind) const {
404 unsigned Index;
405
406 if (Attrs.hasAttrSomewhere(Kind, Index: &Index))
407 return getArgOperand(i: Index - AttributeList::FirstArgIndex);
408 if (const Function *F = getCalledFunction())
409 if (F->getAttributes().hasAttrSomewhere(Kind, Index: &Index))
410 return getArgOperand(i: Index - AttributeList::FirstArgIndex);
411
412 return nullptr;
413}
414
415/// Determine whether the argument or parameter has the given attribute.
416bool CallBase::paramHasAttr(unsigned ArgNo, Attribute::AttrKind Kind) const {
417 assert(ArgNo < arg_size() && "Param index out of bounds!");
418
419 if (Attrs.hasParamAttr(ArgNo, Kind))
420 return true;
421
422 const Function *F = getCalledFunction();
423 if (!F)
424 return false;
425
426 if (!F->getAttributes().hasParamAttr(ArgNo, Kind))
427 return false;
428
429 // Take into account mod/ref by operand bundles.
430 switch (Kind) {
431 case Attribute::ReadNone:
432 return !hasReadingOperandBundles() && !hasClobberingOperandBundles();
433 case Attribute::ReadOnly:
434 return !hasClobberingOperandBundles();
435 case Attribute::WriteOnly:
436 return !hasReadingOperandBundles();
437 default:
438 return true;
439 }
440}
441
442bool CallBase::paramHasNonNullAttr(unsigned ArgNo,
443 bool AllowUndefOrPoison) const {
444 assert(getArgOperand(ArgNo)->getType()->isPointerTy() &&
445 "Argument must be a pointer");
446 if (paramHasAttr(ArgNo, Kind: Attribute::NonNull) &&
447 (AllowUndefOrPoison || paramHasAttr(ArgNo, Kind: Attribute::NoUndef)))
448 return true;
449
450 if (paramHasAttr(ArgNo, Kind: Attribute::Dereferenceable) &&
451 !NullPointerIsDefined(
452 F: getCaller(),
453 AS: getArgOperand(i: ArgNo)->getType()->getPointerAddressSpace()))
454 return true;
455
456 return false;
457}
458
459bool CallBase::hasFnAttrOnCalledFunction(Attribute::AttrKind Kind) const {
460 if (auto *F = dyn_cast<Function>(Val: getCalledOperand()))
461 return F->getAttributes().hasFnAttr(Kind);
462
463 return false;
464}
465
466bool CallBase::hasFnAttrOnCalledFunction(StringRef Kind) const {
467 if (auto *F = dyn_cast<Function>(Val: getCalledOperand()))
468 return F->getAttributes().hasFnAttr(Kind);
469
470 return false;
471}
472
473template <typename AK>
474Attribute CallBase::getFnAttrOnCalledFunction(AK Kind) const {
475 if constexpr (std::is_same_v<AK, Attribute::AttrKind>) {
476 // getMemoryEffects() correctly combines memory effects from the call-site,
477 // operand bundles and function.
478 assert(Kind != Attribute::Memory && "Use getMemoryEffects() instead");
479 }
480
481 if (auto *F = dyn_cast<Function>(Val: getCalledOperand()))
482 return F->getAttributes().getFnAttr(Kind);
483
484 return Attribute();
485}
486
487template LLVM_ABI Attribute
488CallBase::getFnAttrOnCalledFunction(Attribute::AttrKind Kind) const;
489template LLVM_ABI Attribute
490CallBase::getFnAttrOnCalledFunction(StringRef Kind) const;
491
492template <typename AK>
493Attribute CallBase::getParamAttrOnCalledFunction(unsigned ArgNo,
494 AK Kind) const {
495 Value *V = getCalledOperand();
496
497 if (auto *F = dyn_cast<Function>(Val: V))
498 return F->getAttributes().getParamAttr(ArgNo, Kind);
499
500 return Attribute();
501}
502template LLVM_ABI Attribute CallBase::getParamAttrOnCalledFunction(
503 unsigned ArgNo, Attribute::AttrKind Kind) const;
504template LLVM_ABI Attribute
505CallBase::getParamAttrOnCalledFunction(unsigned ArgNo, StringRef Kind) const;
506
507void CallBase::getOperandBundlesAsDefs(
508 SmallVectorImpl<OperandBundleDef> &Defs) const {
509 for (unsigned i = 0, e = getNumOperandBundles(); i != e; ++i)
510 Defs.emplace_back(Args: getOperandBundleAt(Index: i));
511}
512
513CallBase::op_iterator
514CallBase::populateBundleOperandInfos(ArrayRef<OperandBundleDef> Bundles,
515 const unsigned BeginIndex) {
516 auto It = op_begin() + BeginIndex;
517 for (auto &B : Bundles)
518 It = std::copy(first: B.input_begin(), last: B.input_end(), result: It);
519
520 auto *ContextImpl = getContext().pImpl;
521 auto BI = Bundles.begin();
522 unsigned CurrentIndex = BeginIndex;
523
524 for (auto &BOI : bundle_op_infos()) {
525 assert(BI != Bundles.end() && "Incorrect allocation?");
526
527 BOI.Tag = ContextImpl->getOrInsertBundleTag(Tag: BI->getTag());
528 BOI.Begin = CurrentIndex;
529 BOI.End = CurrentIndex + BI->input_size();
530 CurrentIndex = BOI.End;
531 BI++;
532 }
533
534 assert(BI == Bundles.end() && "Incorrect allocation?");
535
536 return It;
537}
538
539CallBase::BundleOpInfo &CallBase::getBundleOpInfoForOperand(unsigned OpIdx) {
540 /// When there isn't many bundles, we do a simple linear search.
541 /// Else fallback to a binary-search that use the fact that bundles usually
542 /// have similar number of argument to get faster convergence.
543 if (bundle_op_info_end() - bundle_op_info_begin() < 8) {
544 for (auto &BOI : bundle_op_infos())
545 if (BOI.Begin <= OpIdx && OpIdx < BOI.End)
546 return BOI;
547
548 llvm_unreachable("Did not find operand bundle for operand!");
549 }
550
551 assert(OpIdx >= arg_size() && "the Idx is not in the operand bundles");
552 assert(bundle_op_info_end() - bundle_op_info_begin() > 0 &&
553 OpIdx < std::prev(bundle_op_info_end())->End &&
554 "The Idx isn't in the operand bundle");
555
556 /// We need a decimal number below and to prevent using floating point numbers
557 /// we use an intergal value multiplied by this constant.
558 constexpr unsigned NumberScaling = 1024;
559
560 bundle_op_iterator Begin = bundle_op_info_begin();
561 bundle_op_iterator End = bundle_op_info_end();
562 bundle_op_iterator Current = Begin;
563
564 while (Begin != End) {
565 unsigned ScaledOperandPerBundle =
566 NumberScaling * (std::prev(x: End)->End - Begin->Begin) / (End - Begin);
567 Current = Begin + (((OpIdx - Begin->Begin) * NumberScaling) /
568 ScaledOperandPerBundle);
569 if (Current >= End)
570 Current = std::prev(x: End);
571 assert(Current < End && Current >= Begin &&
572 "the operand bundle doesn't cover every value in the range");
573 if (OpIdx >= Current->Begin && OpIdx < Current->End)
574 break;
575 if (OpIdx >= Current->End)
576 Begin = Current + 1;
577 else
578 End = Current;
579 }
580
581 assert(OpIdx >= Current->Begin && OpIdx < Current->End &&
582 "the operand bundle doesn't cover every value in the range");
583 return *Current;
584}
585
586CallBase *CallBase::addOperandBundle(CallBase *CB, uint32_t ID,
587 OperandBundleDef OB,
588 InsertPosition InsertPt) {
589 if (CB->getOperandBundle(ID))
590 return CB;
591
592 SmallVector<OperandBundleDef, 1> Bundles;
593 CB->getOperandBundlesAsDefs(Defs&: Bundles);
594 Bundles.push_back(Elt: OB);
595 return Create(CB, Bundles, InsertPt);
596}
597
598CallBase *CallBase::removeOperandBundle(CallBase *CB, uint32_t ID,
599 InsertPosition InsertPt) {
600 SmallVector<OperandBundleDef, 1> Bundles;
601 bool CreateNew = false;
602
603 for (unsigned I = 0, E = CB->getNumOperandBundles(); I != E; ++I) {
604 auto Bundle = CB->getOperandBundleAt(Index: I);
605 if (Bundle.getTagID() == ID) {
606 CreateNew = true;
607 continue;
608 }
609 Bundles.emplace_back(Args&: Bundle);
610 }
611
612 return CreateNew ? Create(CB, Bundles, InsertPt) : CB;
613}
614
615CallBase *CallBase::removeOperandBundleAt(CallBase *CB, size_t Offset,
616 InsertPosition InsertPt) {
617 auto OpBundleCount = CB->getNumOperandBundles();
618 assert(Offset < OpBundleCount &&
619 "Trying to remove non-existant operand bundle");
620 SmallVector<OperandBundleDef> Bundles;
621 Bundles.reserve(N: OpBundleCount - 1);
622 size_t I = 0;
623 for (; I != Offset; ++I)
624 Bundles.emplace_back(Args: CB->getOperandBundleAt(Index: I));
625 ++I;
626 for (; I != OpBundleCount; ++I)
627 Bundles.emplace_back(Args: CB->getOperandBundleAt(Index: I));
628 return Create(CB, Bundles, InsertPt);
629}
630
631bool CallBase::hasReadingOperandBundles() const {
632 // Implementation note: this is a conservative implementation of operand
633 // bundle semantics, where *any* non-assume operand bundle (other than
634 // ptrauth) forces a callsite to be at least readonly.
635 return hasOperandBundlesOtherThan(IDs: {LLVMContext::OB_ptrauth,
636 LLVMContext::OB_kcfi,
637 LLVMContext::OB_convergencectrl,
638 LLVMContext::OB_deactivation_symbol}) &&
639 getIntrinsicID() != Intrinsic::assume;
640}
641
642bool CallBase::hasClobberingOperandBundles() const {
643 return hasOperandBundlesOtherThan(
644 IDs: {LLVMContext::OB_deopt, LLVMContext::OB_funclet,
645 LLVMContext::OB_ptrauth, LLVMContext::OB_kcfi,
646 LLVMContext::OB_convergencectrl,
647 LLVMContext::OB_deactivation_symbol}) &&
648 getIntrinsicID() != Intrinsic::assume;
649}
650
651MemoryEffects CallBase::getMemoryEffects() const {
652 MemoryEffects ME = getAttributes().getMemoryEffects();
653 if (auto *Fn = dyn_cast<Function>(Val: getCalledOperand())) {
654 MemoryEffects FnME = Fn->getMemoryEffects();
655 if (hasOperandBundles()) {
656 // TODO: Add a method to get memory effects for operand bundles instead.
657 if (hasReadingOperandBundles())
658 FnME |= MemoryEffects::readOnly();
659 if (hasClobberingOperandBundles())
660 FnME |= MemoryEffects::writeOnly();
661 }
662 if (isVolatile()) {
663 // Volatile operations also access inaccessible memory.
664 FnME |= MemoryEffects::inaccessibleMemOnly();
665 }
666 ME &= FnME;
667 }
668 return ME;
669}
670void CallBase::setMemoryEffects(MemoryEffects ME) {
671 addFnAttr(Attr: Attribute::getWithMemoryEffects(Context&: getContext(), ME));
672}
673
674/// Determine if the function does not access memory.
675bool CallBase::doesNotAccessMemory() const {
676 return getMemoryEffects().doesNotAccessMemory();
677}
678void CallBase::setDoesNotAccessMemory() {
679 setMemoryEffects(MemoryEffects::none());
680}
681
682/// Determine if the function does not access or only reads memory.
683bool CallBase::onlyReadsMemory() const {
684 return getMemoryEffects().onlyReadsMemory();
685}
686void CallBase::setOnlyReadsMemory() {
687 setMemoryEffects(getMemoryEffects() & MemoryEffects::readOnly());
688}
689
690/// Determine if the function does not access or only writes memory.
691bool CallBase::onlyWritesMemory() const {
692 return getMemoryEffects().onlyWritesMemory();
693}
694void CallBase::setOnlyWritesMemory() {
695 setMemoryEffects(getMemoryEffects() & MemoryEffects::writeOnly());
696}
697
698/// Determine if the call can access memmory only using pointers based
699/// on its arguments.
700bool CallBase::onlyAccessesArgMemory() const {
701 return getMemoryEffects().onlyAccessesArgPointees();
702}
703void CallBase::setOnlyAccessesArgMemory() {
704 setMemoryEffects(getMemoryEffects() & MemoryEffects::argMemOnly());
705}
706
707/// Determine if the function may only access memory that is
708/// inaccessible from the IR.
709bool CallBase::onlyAccessesInaccessibleMemory() const {
710 return getMemoryEffects().onlyAccessesInaccessibleMem();
711}
712void CallBase::setOnlyAccessesInaccessibleMemory() {
713 setMemoryEffects(getMemoryEffects() & MemoryEffects::inaccessibleMemOnly());
714}
715
716/// Determine if the function may only access memory that is
717/// either inaccessible from the IR or pointed to by its arguments.
718bool CallBase::onlyAccessesInaccessibleMemOrArgMem() const {
719 return getMemoryEffects().onlyAccessesInaccessibleOrArgMem();
720}
721void CallBase::setOnlyAccessesInaccessibleMemOrArgMem() {
722 setMemoryEffects(getMemoryEffects() &
723 MemoryEffects::inaccessibleOrArgMemOnly());
724}
725
726CaptureInfo CallBase::getCaptureInfo(unsigned OpNo) const {
727 if (OpNo < arg_size()) {
728 // If the argument is passed byval, the callee does not have access to the
729 // original pointer and thus cannot capture it.
730 if (isByValArgument(ArgNo: OpNo))
731 return CaptureInfo::none();
732
733 CaptureInfo CI = getParamAttributes(ArgNo: OpNo).getCaptureInfo();
734 if (auto *Fn = dyn_cast<Function>(Val: getCalledOperand()))
735 CI &= Fn->getAttributes().getParamAttrs(ArgNo: OpNo).getCaptureInfo();
736 return CI;
737 }
738
739 // Bundles on assumes are captures(none).
740 if (getIntrinsicID() == Intrinsic::assume)
741 return CaptureInfo::none();
742
743 // deopt operand bundles are captures(none)
744 auto &BOI = getBundleOpInfoForOperand(OpIdx: OpNo);
745 auto OBU = operandBundleFromBundleOpInfo(BOI);
746 return OBU.isDeoptOperandBundle() ? CaptureInfo::none() : CaptureInfo::all();
747}
748
749bool CallBase::hasArgumentWithAdditionalReturnCaptureComponents() const {
750 for (unsigned I = 0, E = arg_size(); I < E; ++I) {
751 if (!getArgOperand(i: I)->getType()->isPointerTy())
752 continue;
753
754 CaptureInfo CI = getParamAttributes(ArgNo: I).getCaptureInfo();
755 if (auto *Fn = dyn_cast<Function>(Val: getCalledOperand()))
756 CI &= Fn->getAttributes().getParamAttrs(ArgNo: I).getCaptureInfo();
757 if (capturesAnything(CC: CI.getRetComponents() & ~CI.getOtherComponents()))
758 return true;
759 }
760 return false;
761}
762
763//===----------------------------------------------------------------------===//
764// CallInst Implementation
765//===----------------------------------------------------------------------===//
766
767void CallInst::init(FunctionType *FTy, Value *Func, ArrayRef<Value *> Args,
768 ArrayRef<OperandBundleDef> Bundles, const Twine &NameStr) {
769 this->FTy = FTy;
770 assert(getNumOperands() == Args.size() + CountBundleInputs(Bundles) + 1 &&
771 "NumOperands not set up?");
772
773#ifndef NDEBUG
774 assert((Args.size() == FTy->getNumParams() ||
775 (FTy->isVarArg() && Args.size() > FTy->getNumParams())) &&
776 "Calling a function with bad signature!");
777
778 for (unsigned i = 0; i != Args.size(); ++i)
779 assert((i >= FTy->getNumParams() ||
780 FTy->getParamType(i) == Args[i]->getType()) &&
781 "Calling a function with a bad signature!");
782#endif
783
784 // Set operands in order of their index to match use-list-order
785 // prediction.
786 llvm::copy(Range&: Args, Out: op_begin());
787 setCalledOperand(Func);
788
789 auto It = populateBundleOperandInfos(Bundles, BeginIndex: Args.size());
790 (void)It;
791 assert(It + 1 == op_end() && "Should add up!");
792
793 setName(NameStr);
794}
795
796void CallInst::init(FunctionType *FTy, Value *Func, const Twine &NameStr) {
797 this->FTy = FTy;
798 assert(getNumOperands() == 1 && "NumOperands not set up?");
799 setCalledOperand(Func);
800
801 assert(FTy->getNumParams() == 0 && "Calling a function with bad signature");
802
803 setName(NameStr);
804}
805
806CallInst::CallInst(FunctionType *Ty, Value *Func, const Twine &Name,
807 AllocInfo AllocInfo, InsertPosition InsertBefore)
808 : CallBase(Ty->getReturnType(), Instruction::Call, AllocInfo,
809 InsertBefore) {
810 init(FTy: Ty, Func, NameStr: Name);
811}
812
813CallInst::CallInst(const CallInst &CI, AllocInfo AllocInfo)
814 : CallBase(CI.Attrs, CI.FTy, CI.getType(), Instruction::Call, AllocInfo) {
815 assert(getNumOperands() == CI.getNumOperands() &&
816 "Wrong number of operands allocated");
817 setTailCallKind(CI.getTailCallKind());
818 setCallingConv(CI.getCallingConv());
819
820 std::copy(first: CI.op_begin(), last: CI.op_end(), result: op_begin());
821 std::copy(first: CI.bundle_op_info_begin(), last: CI.bundle_op_info_end(),
822 result: bundle_op_info_begin());
823 FMF = CI.FMF;
824}
825
826CallInst *CallInst::Create(CallInst *CI, ArrayRef<OperandBundleDef> OpB,
827 InsertPosition InsertPt) {
828 std::vector<Value *> Args(CI->arg_begin(), CI->arg_end());
829
830 auto *NewCI = CallInst::Create(Ty: CI->getFunctionType(), Func: CI->getCalledOperand(),
831 Args, Bundles: OpB, NameStr: CI->getName(), InsertBefore: InsertPt);
832 NewCI->setTailCallKind(CI->getTailCallKind());
833 NewCI->setCallingConv(CI->getCallingConv());
834 NewCI->FMF = CI->FMF;
835 NewCI->setAttributes(CI->getAttributes());
836 NewCI->setDebugLoc(CI->getDebugLoc());
837 return NewCI;
838}
839
840// Update profile weight for call instruction by scaling it using the ratio
841// of S/T. The meaning of "branch_weights" meta data for call instruction is
842// transfered to represent call count.
843void CallInst::updateProfWeight(uint64_t S, uint64_t T) {
844 if (T == 0) {
845 LLVM_DEBUG(dbgs() << "Attempting to update profile weights will result in "
846 "div by 0. Ignoring. Likely the function "
847 << getParent()->getParent()->getName()
848 << " has 0 entry count, and contains call instructions "
849 "with non-zero prof info.");
850 return;
851 }
852 scaleProfData(I&: *this, S, T);
853}
854
855//===----------------------------------------------------------------------===//
856// InvokeInst Implementation
857//===----------------------------------------------------------------------===//
858
859void InvokeInst::init(FunctionType *FTy, Value *Fn, BasicBlock *IfNormal,
860 BasicBlock *IfException, ArrayRef<Value *> Args,
861 ArrayRef<OperandBundleDef> Bundles,
862 const Twine &NameStr) {
863 this->FTy = FTy;
864
865 assert(getNumOperands() ==
866 ComputeNumOperands(Args.size(), CountBundleInputs(Bundles)) &&
867 "NumOperands not set up?");
868
869#ifndef NDEBUG
870 assert(((Args.size() == FTy->getNumParams()) ||
871 (FTy->isVarArg() && Args.size() > FTy->getNumParams())) &&
872 "Invoking a function with bad signature");
873
874 for (unsigned i = 0, e = Args.size(); i != e; i++)
875 assert((i >= FTy->getNumParams() ||
876 FTy->getParamType(i) == Args[i]->getType()) &&
877 "Invoking a function with a bad signature!");
878#endif
879
880 // Set operands in order of their index to match use-list-order
881 // prediction.
882 llvm::copy(Range&: Args, Out: op_begin());
883 setNormalDest(IfNormal);
884 setUnwindDest(IfException);
885 setCalledOperand(Fn);
886
887 auto It = populateBundleOperandInfos(Bundles, BeginIndex: Args.size());
888 (void)It;
889 assert(It + 3 == op_end() && "Should add up!");
890
891 setName(NameStr);
892}
893
894InvokeInst::InvokeInst(const InvokeInst &II, AllocInfo AllocInfo)
895 : CallBase(II.Attrs, II.FTy, II.getType(), Instruction::Invoke, AllocInfo) {
896 assert(getNumOperands() == II.getNumOperands() &&
897 "Wrong number of operands allocated");
898 setCallingConv(II.getCallingConv());
899 std::copy(first: II.op_begin(), last: II.op_end(), result: op_begin());
900 std::copy(first: II.bundle_op_info_begin(), last: II.bundle_op_info_end(),
901 result: bundle_op_info_begin());
902 SubclassOptionalData = II.SubclassOptionalData;
903}
904
905InvokeInst *InvokeInst::Create(InvokeInst *II, ArrayRef<OperandBundleDef> OpB,
906 InsertPosition InsertPt) {
907 std::vector<Value *> Args(II->arg_begin(), II->arg_end());
908
909 auto *NewII = InvokeInst::Create(
910 Ty: II->getFunctionType(), Func: II->getCalledOperand(), IfNormal: II->getNormalDest(),
911 IfException: II->getUnwindDest(), Args, Bundles: OpB, NameStr: II->getName(), InsertBefore: InsertPt);
912 NewII->setCallingConv(II->getCallingConv());
913 NewII->SubclassOptionalData = II->SubclassOptionalData;
914 NewII->setAttributes(II->getAttributes());
915 NewII->setDebugLoc(II->getDebugLoc());
916 return NewII;
917}
918
919LandingPadInst *InvokeInst::getLandingPadInst() const {
920 return cast<LandingPadInst>(Val: getUnwindDest()->getFirstNonPHIIt());
921}
922
923void InvokeInst::updateProfWeight(uint64_t S, uint64_t T) {
924 if (T == 0) {
925 LLVM_DEBUG(dbgs() << "Attempting to update profile weights will result in "
926 "div by 0. Ignoring. Likely the function "
927 << getParent()->getParent()->getName()
928 << " has 0 entry count, and contains call instructions "
929 "with non-zero prof info.");
930 return;
931 }
932 scaleProfData(I&: *this, S, T);
933}
934
935//===----------------------------------------------------------------------===//
936// CallBrInst Implementation
937//===----------------------------------------------------------------------===//
938
939void CallBrInst::init(FunctionType *FTy, Value *Fn, BasicBlock *Fallthrough,
940 ArrayRef<BasicBlock *> IndirectDests,
941 ArrayRef<Value *> Args,
942 ArrayRef<OperandBundleDef> Bundles,
943 const Twine &NameStr) {
944 this->FTy = FTy;
945
946 assert(getNumOperands() == ComputeNumOperands(Args.size(),
947 IndirectDests.size(),
948 CountBundleInputs(Bundles)) &&
949 "NumOperands not set up?");
950
951#ifndef NDEBUG
952 assert(((Args.size() == FTy->getNumParams()) ||
953 (FTy->isVarArg() && Args.size() > FTy->getNumParams())) &&
954 "Calling a function with bad signature");
955
956 for (unsigned i = 0, e = Args.size(); i != e; i++)
957 assert((i >= FTy->getNumParams() ||
958 FTy->getParamType(i) == Args[i]->getType()) &&
959 "Calling a function with a bad signature!");
960#endif
961
962 // Set operands in order of their index to match use-list-order
963 // prediction.
964 llvm::copy(Range&: Args, Out: op_begin());
965 NumIndirectDests = IndirectDests.size();
966 setDefaultDest(Fallthrough);
967 for (unsigned i = 0; i != NumIndirectDests; ++i)
968 setIndirectDest(i, B: IndirectDests[i]);
969 setCalledOperand(Fn);
970
971 auto It = populateBundleOperandInfos(Bundles, BeginIndex: Args.size());
972 (void)It;
973 assert(It + 2 + IndirectDests.size() == op_end() && "Should add up!");
974
975 setName(NameStr);
976}
977
978CallBrInst::CallBrInst(const CallBrInst &CBI, AllocInfo AllocInfo)
979 : CallBase(CBI.Attrs, CBI.FTy, CBI.getType(), Instruction::CallBr,
980 AllocInfo) {
981 assert(getNumOperands() == CBI.getNumOperands() &&
982 "Wrong number of operands allocated");
983 setCallingConv(CBI.getCallingConv());
984 std::copy(first: CBI.op_begin(), last: CBI.op_end(), result: op_begin());
985 std::copy(first: CBI.bundle_op_info_begin(), last: CBI.bundle_op_info_end(),
986 result: bundle_op_info_begin());
987 SubclassOptionalData = CBI.SubclassOptionalData;
988 NumIndirectDests = CBI.NumIndirectDests;
989}
990
991CallBrInst *CallBrInst::Create(CallBrInst *CBI, ArrayRef<OperandBundleDef> OpB,
992 InsertPosition InsertPt) {
993 std::vector<Value *> Args(CBI->arg_begin(), CBI->arg_end());
994
995 auto *NewCBI = CallBrInst::Create(
996 Ty: CBI->getFunctionType(), Func: CBI->getCalledOperand(), DefaultDest: CBI->getDefaultDest(),
997 IndirectDests: CBI->getIndirectDests(), Args, Bundles: OpB, NameStr: CBI->getName(), InsertBefore: InsertPt);
998 NewCBI->setCallingConv(CBI->getCallingConv());
999 NewCBI->SubclassOptionalData = CBI->SubclassOptionalData;
1000 NewCBI->setAttributes(CBI->getAttributes());
1001 NewCBI->setDebugLoc(CBI->getDebugLoc());
1002 NewCBI->NumIndirectDests = CBI->NumIndirectDests;
1003 return NewCBI;
1004}
1005
1006//===----------------------------------------------------------------------===//
1007// ReturnInst Implementation
1008//===----------------------------------------------------------------------===//
1009
1010ReturnInst::ReturnInst(const ReturnInst &RI, AllocInfo AllocInfo)
1011 : Instruction(Type::getVoidTy(C&: RI.getContext()), Instruction::Ret,
1012 AllocInfo) {
1013 assert(getNumOperands() == RI.getNumOperands() &&
1014 "Wrong number of operands allocated");
1015 if (RI.getNumOperands())
1016 Op<0>() = RI.Op<0>();
1017 SubclassOptionalData = RI.SubclassOptionalData;
1018}
1019
1020ReturnInst::ReturnInst(LLVMContext &C, Value *retVal, AllocInfo AllocInfo,
1021 InsertPosition InsertBefore)
1022 : Instruction(Type::getVoidTy(C), Instruction::Ret, AllocInfo,
1023 InsertBefore) {
1024 if (retVal)
1025 Op<0>() = retVal;
1026}
1027
1028//===----------------------------------------------------------------------===//
1029// ResumeInst Implementation
1030//===----------------------------------------------------------------------===//
1031
1032ResumeInst::ResumeInst(const ResumeInst &RI)
1033 : Instruction(Type::getVoidTy(C&: RI.getContext()), Instruction::Resume,
1034 AllocMarker) {
1035 Op<0>() = RI.Op<0>();
1036}
1037
1038ResumeInst::ResumeInst(Value *Exn, InsertPosition InsertBefore)
1039 : Instruction(Type::getVoidTy(C&: Exn->getContext()), Instruction::Resume,
1040 AllocMarker, InsertBefore) {
1041 Op<0>() = Exn;
1042}
1043
1044//===----------------------------------------------------------------------===//
1045// CleanupReturnInst Implementation
1046//===----------------------------------------------------------------------===//
1047
1048CleanupReturnInst::CleanupReturnInst(const CleanupReturnInst &CRI,
1049 AllocInfo AllocInfo)
1050 : Instruction(CRI.getType(), Instruction::CleanupRet, AllocInfo) {
1051 assert(getNumOperands() == CRI.getNumOperands() &&
1052 "Wrong number of operands allocated");
1053 setSubclassData<Instruction::OpaqueField>(
1054 CRI.getSubclassData<Instruction::OpaqueField>());
1055 Op<0>() = CRI.Op<0>();
1056 if (CRI.hasUnwindDest())
1057 Op<1>() = CRI.Op<1>();
1058}
1059
1060void CleanupReturnInst::init(Value *CleanupPad, BasicBlock *UnwindBB) {
1061 if (UnwindBB)
1062 setSubclassData<UnwindDestField>(true);
1063
1064 Op<0>() = CleanupPad;
1065 if (UnwindBB)
1066 Op<1>() = UnwindBB;
1067}
1068
1069CleanupReturnInst::CleanupReturnInst(Value *CleanupPad, BasicBlock *UnwindBB,
1070 AllocInfo AllocInfo,
1071 InsertPosition InsertBefore)
1072 : Instruction(Type::getVoidTy(C&: CleanupPad->getContext()),
1073 Instruction::CleanupRet, AllocInfo, InsertBefore) {
1074 init(CleanupPad, UnwindBB);
1075}
1076
1077//===----------------------------------------------------------------------===//
1078// CatchReturnInst Implementation
1079//===----------------------------------------------------------------------===//
1080void CatchReturnInst::init(Value *CatchPad, BasicBlock *BB) {
1081 Op<0>() = CatchPad;
1082 Op<1>() = BB;
1083}
1084
1085CatchReturnInst::CatchReturnInst(const CatchReturnInst &CRI)
1086 : Instruction(Type::getVoidTy(C&: CRI.getContext()), Instruction::CatchRet,
1087 AllocMarker) {
1088 Op<0>() = CRI.Op<0>();
1089 Op<1>() = CRI.Op<1>();
1090}
1091
1092CatchReturnInst::CatchReturnInst(Value *CatchPad, BasicBlock *BB,
1093 InsertPosition InsertBefore)
1094 : Instruction(Type::getVoidTy(C&: BB->getContext()), Instruction::CatchRet,
1095 AllocMarker, InsertBefore) {
1096 init(CatchPad, BB);
1097}
1098
1099//===----------------------------------------------------------------------===//
1100// CatchSwitchInst Implementation
1101//===----------------------------------------------------------------------===//
1102
1103CatchSwitchInst::CatchSwitchInst(Value *ParentPad, BasicBlock *UnwindDest,
1104 unsigned NumReservedValues,
1105 const Twine &NameStr,
1106 InsertPosition InsertBefore)
1107 : Instruction(ParentPad->getType(), Instruction::CatchSwitch, AllocMarker,
1108 InsertBefore) {
1109 if (UnwindDest)
1110 ++NumReservedValues;
1111 init(ParentPad, UnwindDest, NumReserved: NumReservedValues + 1);
1112 setName(NameStr);
1113}
1114
1115CatchSwitchInst::CatchSwitchInst(const CatchSwitchInst &CSI)
1116 : Instruction(CSI.getType(), Instruction::CatchSwitch, AllocMarker) {
1117 NumUserOperands = CSI.NumUserOperands;
1118 init(ParentPad: CSI.getParentPad(), UnwindDest: CSI.getUnwindDest(), NumReserved: CSI.getNumOperands());
1119 setNumHungOffUseOperands(ReservedSpace);
1120 Use *OL = getOperandList();
1121 const Use *InOL = CSI.getOperandList();
1122 for (unsigned I = 1, E = ReservedSpace; I != E; ++I)
1123 OL[I] = InOL[I];
1124}
1125
1126void CatchSwitchInst::init(Value *ParentPad, BasicBlock *UnwindDest,
1127 unsigned NumReservedValues) {
1128 assert(ParentPad && NumReservedValues);
1129
1130 ReservedSpace = NumReservedValues;
1131 setNumHungOffUseOperands(UnwindDest ? 2 : 1);
1132 allocHungoffUses(N: ReservedSpace);
1133
1134 Op<0>() = ParentPad;
1135 if (UnwindDest) {
1136 setSubclassData<UnwindDestField>(true);
1137 setUnwindDest(UnwindDest);
1138 }
1139}
1140
1141/// growOperands - grow operands - This grows the operand list in response to a
1142/// push_back style of operation. This grows the number of ops by 2 times.
1143void CatchSwitchInst::growOperands(unsigned Size) {
1144 unsigned NumOperands = getNumOperands();
1145 assert(NumOperands >= 1);
1146 if (ReservedSpace >= NumOperands + Size)
1147 return;
1148 ReservedSpace = (NumOperands + Size / 2) * 2;
1149 growHungoffUses(N: ReservedSpace);
1150}
1151
1152void CatchSwitchInst::addHandler(BasicBlock *Handler) {
1153 unsigned OpNo = getNumOperands();
1154 growOperands(Size: 1);
1155 assert(OpNo < ReservedSpace && "Growing didn't work!");
1156 setNumHungOffUseOperands(getNumOperands() + 1);
1157 getOperandList()[OpNo] = Handler;
1158}
1159
1160void CatchSwitchInst::removeHandler(handler_iterator HI) {
1161 // Move all subsequent handlers up one.
1162 Use *EndDst = op_end() - 1;
1163 for (Use *CurDst = HI.getCurrent(); CurDst != EndDst; ++CurDst)
1164 *CurDst = *(CurDst + 1);
1165 // Null out the last handler use.
1166 *EndDst = nullptr;
1167
1168 setNumHungOffUseOperands(getNumOperands() - 1);
1169}
1170
1171//===----------------------------------------------------------------------===//
1172// FuncletPadInst Implementation
1173//===----------------------------------------------------------------------===//
1174void FuncletPadInst::init(Value *ParentPad, ArrayRef<Value *> Args,
1175 const Twine &NameStr) {
1176 assert(getNumOperands() == 1 + Args.size() && "NumOperands not set up?");
1177 llvm::copy(Range&: Args, Out: op_begin());
1178 setParentPad(ParentPad);
1179 setName(NameStr);
1180}
1181
1182FuncletPadInst::FuncletPadInst(const FuncletPadInst &FPI, AllocInfo AllocInfo)
1183 : Instruction(FPI.getType(), FPI.getOpcode(), AllocInfo) {
1184 assert(getNumOperands() == FPI.getNumOperands() &&
1185 "Wrong number of operands allocated");
1186 std::copy(first: FPI.op_begin(), last: FPI.op_end(), result: op_begin());
1187 setParentPad(FPI.getParentPad());
1188}
1189
1190FuncletPadInst::FuncletPadInst(Instruction::FuncletPadOps Op, Value *ParentPad,
1191 ArrayRef<Value *> Args, AllocInfo AllocInfo,
1192 const Twine &NameStr,
1193 InsertPosition InsertBefore)
1194 : Instruction(ParentPad->getType(), Op, AllocInfo, InsertBefore) {
1195 init(ParentPad, Args, NameStr);
1196}
1197
1198//===----------------------------------------------------------------------===//
1199// UnreachableInst Implementation
1200//===----------------------------------------------------------------------===//
1201
1202UnreachableInst::UnreachableInst(LLVMContext &Context,
1203 InsertPosition InsertBefore)
1204 : Instruction(Type::getVoidTy(C&: Context), Instruction::Unreachable,
1205 AllocMarker, InsertBefore) {}
1206
1207//===----------------------------------------------------------------------===//
1208// UncondBrInst Implementation
1209//===----------------------------------------------------------------------===//
1210
1211// Suppress deprecation warnings from BranchInst.
1212LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_PUSH
1213
1214UncondBrInst::UncondBrInst(BasicBlock *Target, InsertPosition InsertBefore)
1215 : BranchInst(Type::getVoidTy(C&: Target->getContext()), Instruction::UncondBr,
1216 AllocMarker, InsertBefore) {
1217 Op<-1>() = Target;
1218}
1219
1220UncondBrInst::UncondBrInst(const UncondBrInst &BI)
1221 : BranchInst(Type::getVoidTy(C&: BI.getContext()), Instruction::UncondBr,
1222 AllocMarker) {
1223 Op<-1>() = BI.Op<-1>();
1224 SubclassOptionalData = BI.SubclassOptionalData;
1225}
1226
1227//===----------------------------------------------------------------------===//
1228// CondBrInst Implementation
1229//===----------------------------------------------------------------------===//
1230
1231void CondBrInst::AssertOK() {
1232 assert(getCondition()->getType()->isIntegerTy(1) &&
1233 "May only branch on boolean predicates!");
1234}
1235
1236CondBrInst::CondBrInst(Value *Cond, BasicBlock *IfTrue, BasicBlock *IfFalse,
1237 InsertPosition InsertBefore)
1238 : BranchInst(Type::getVoidTy(C&: IfTrue->getContext()), Instruction::CondBr,
1239 AllocMarker, InsertBefore) {
1240 // Assign in order of operand index to make use-list order predictable.
1241 Op<-3>() = Cond;
1242 Op<-2>() = IfTrue;
1243 Op<-1>() = IfFalse;
1244#ifndef NDEBUG
1245 AssertOK();
1246#endif
1247}
1248
1249CondBrInst::CondBrInst(const CondBrInst &BI)
1250 : BranchInst(Type::getVoidTy(C&: BI.getContext()), Instruction::CondBr,
1251 AllocMarker) {
1252 // Assign in order of operand index to make use-list order predictable.
1253 Op<-3>() = BI.Op<-3>();
1254 Op<-2>() = BI.Op<-2>();
1255 Op<-1>() = BI.Op<-1>();
1256 SubclassOptionalData = BI.SubclassOptionalData;
1257}
1258
1259void CondBrInst::swapSuccessors() {
1260 Op<-1>().swap(RHS&: Op<-2>());
1261
1262 // Update profile metadata if present and it matches our structural
1263 // expectations.
1264 swapProfMetadata();
1265}
1266
1267// Suppress deprecation warnings from BranchInst.
1268LLVM_SUPPRESS_DEPRECATED_DECLARATIONS_POP
1269
1270//===----------------------------------------------------------------------===//
1271// AllocaInst Implementation
1272//===----------------------------------------------------------------------===//
1273
1274static Value *getAISize(LLVMContext &Context, Value *Amt) {
1275 if (!Amt)
1276 Amt = ConstantInt::get(Ty: Type::getInt32Ty(C&: Context), V: 1);
1277 else {
1278 assert(!isa<BasicBlock>(Amt) &&
1279 "Passed basic block into allocation size parameter! Use other ctor");
1280 assert(Amt->getType()->isIntegerTy() &&
1281 "Allocation array size is not an integer!");
1282 }
1283 return Amt;
1284}
1285
1286static Align computeAllocaDefaultAlign(Type *Ty, InsertPosition Pos) {
1287 assert(Pos.isValid() &&
1288 "Insertion position cannot be null when alignment not provided!");
1289 BasicBlock *BB = Pos.getBasicBlock();
1290 assert(BB->getParent() &&
1291 "BB must be in a Function when alignment not provided!");
1292 const DataLayout &DL = BB->getDataLayout();
1293 return DL.getPrefTypeAlign(Ty);
1294}
1295
1296AllocaInst::AllocaInst(Type *Ty, unsigned AddrSpace, const Twine &Name,
1297 InsertPosition InsertBefore)
1298 : AllocaInst(Ty, AddrSpace, /*ArraySize=*/nullptr, Name, InsertBefore) {}
1299
1300AllocaInst::AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize,
1301 const Twine &Name, InsertPosition InsertBefore)
1302 : AllocaInst(Ty, AddrSpace, ArraySize,
1303 computeAllocaDefaultAlign(Ty, Pos: InsertBefore), Name,
1304 InsertBefore) {}
1305
1306AllocaInst::AllocaInst(Type *Ty, unsigned AddrSpace, Value *ArraySize,
1307 Align Align, const Twine &Name,
1308 InsertPosition InsertBefore)
1309 : UnaryInstruction(PointerType::get(C&: Ty->getContext(), AddressSpace: AddrSpace), Alloca,
1310 getAISize(Context&: Ty->getContext(), Amt: ArraySize), InsertBefore),
1311 AllocatedType(Ty) {
1312 setAlignment(Align);
1313 assert(!Ty->isVoidTy() && "Cannot allocate void!");
1314 setName(Name);
1315}
1316
1317bool AllocaInst::isArrayAllocation() const {
1318 if (ConstantInt *CI = dyn_cast<ConstantInt>(Val: getOperand(i_nocapture: 0)))
1319 return !CI->isOne();
1320 return true;
1321}
1322
1323/// isStaticAlloca - Return true if this alloca is in the entry block of the
1324/// function and is a constant size. If so, the code generator will fold it
1325/// into the prolog/epilog code, so it is basically free.
1326bool AllocaInst::isStaticAlloca() const {
1327 // Must be constant size.
1328 if (!isa<ConstantInt>(Val: getArraySize())) return false;
1329
1330 // Must be in the entry block.
1331 const BasicBlock *Parent = getParent();
1332 return Parent->isEntryBlock() && !isUsedWithInAlloca();
1333}
1334
1335//===----------------------------------------------------------------------===//
1336// LoadInst Implementation
1337//===----------------------------------------------------------------------===//
1338
1339void LoadInst::AssertOK() {
1340 assert(getOperand(0)->getType()->isPointerTy() &&
1341 "Ptr must have pointer type.");
1342}
1343
1344static Align computeLoadStoreDefaultAlign(Type *Ty, InsertPosition Pos) {
1345 assert(Pos.isValid() &&
1346 "Insertion position cannot be null when alignment not provided!");
1347 BasicBlock *BB = Pos.getBasicBlock();
1348 assert(BB->getParent() &&
1349 "BB must be in a Function when alignment not provided!");
1350 const DataLayout &DL = BB->getDataLayout();
1351 return DL.getABITypeAlign(Ty);
1352}
1353
1354LoadInst::LoadInst(Type *Ty, Value *Ptr, const Twine &Name,
1355 InsertPosition InsertBef)
1356 : LoadInst(Ty, Ptr, Name, /*isVolatile=*/false, InsertBef) {}
1357
1358LoadInst::LoadInst(Type *Ty, Value *Ptr, const Twine &Name, bool isVolatile,
1359 InsertPosition InsertBef)
1360 : LoadInst(Ty, Ptr, Name, isVolatile,
1361 computeLoadStoreDefaultAlign(Ty, Pos: InsertBef), InsertBef) {}
1362
1363LoadInst::LoadInst(Type *Ty, Value *Ptr, const Twine &Name, bool isVolatile,
1364 Align Align, InsertPosition InsertBef)
1365 : LoadInst(Ty, Ptr, Name, isVolatile, Align, AtomicOrdering::NotAtomic,
1366 SyncScope::System, InsertBef) {}
1367
1368LoadInst::LoadInst(Type *Ty, Value *Ptr, const Twine &Name, bool isVolatile,
1369 Align Align, AtomicOrdering Order, SyncScope::ID SSID,
1370 InsertPosition InsertBef)
1371 : UnaryInstruction(Ty, Load, Ptr, InsertBef) {
1372 setVolatile(isVolatile);
1373 setAlignment(Align);
1374 setAtomic(Ordering: Order, SSID);
1375 AssertOK();
1376 setName(Name);
1377}
1378
1379//===----------------------------------------------------------------------===//
1380// StoreInst Implementation
1381//===----------------------------------------------------------------------===//
1382
1383void StoreInst::AssertOK() {
1384 assert(getOperand(0) && getOperand(1) && "Both operands must be non-null!");
1385 assert(getOperand(1)->getType()->isPointerTy() &&
1386 "Ptr must have pointer type!");
1387}
1388
1389StoreInst::StoreInst(Value *val, Value *addr, InsertPosition InsertBefore)
1390 : StoreInst(val, addr, /*isVolatile=*/false, InsertBefore) {}
1391
1392StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
1393 InsertPosition InsertBefore)
1394 : StoreInst(val, addr, isVolatile,
1395 computeLoadStoreDefaultAlign(Ty: val->getType(), Pos: InsertBefore),
1396 InsertBefore) {}
1397
1398StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile, Align Align,
1399 InsertPosition InsertBefore)
1400 : StoreInst(val, addr, isVolatile, Align, AtomicOrdering::NotAtomic,
1401 SyncScope::System, InsertBefore) {}
1402
1403StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile, Align Align,
1404 AtomicOrdering Order, SyncScope::ID SSID,
1405 InsertPosition InsertBefore)
1406 : Instruction(Type::getVoidTy(C&: val->getContext()), Store, AllocMarker,
1407 InsertBefore) {
1408 Op<0>() = val;
1409 Op<1>() = addr;
1410 setVolatile(isVolatile);
1411 setAlignment(Align);
1412 setAtomic(Ordering: Order, SSID);
1413 AssertOK();
1414}
1415
1416//===----------------------------------------------------------------------===//
1417// AtomicCmpXchgInst Implementation
1418//===----------------------------------------------------------------------===//
1419
1420void AtomicCmpXchgInst::Init(Value *Ptr, Value *Cmp, Value *NewVal,
1421 Align Alignment, AtomicOrdering SuccessOrdering,
1422 AtomicOrdering FailureOrdering,
1423 SyncScope::ID SSID) {
1424 Op<0>() = Ptr;
1425 Op<1>() = Cmp;
1426 Op<2>() = NewVal;
1427 setSuccessOrdering(SuccessOrdering);
1428 setFailureOrdering(FailureOrdering);
1429 setSyncScopeID(SSID);
1430 setAlignment(Alignment);
1431
1432 assert(getOperand(0) && getOperand(1) && getOperand(2) &&
1433 "All operands must be non-null!");
1434 assert(getOperand(0)->getType()->isPointerTy() &&
1435 "Ptr must have pointer type!");
1436 assert(getOperand(1)->getType() == getOperand(2)->getType() &&
1437 "Cmp type and NewVal type must be same!");
1438}
1439
1440AtomicCmpXchgInst::AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
1441 Align Alignment,
1442 AtomicOrdering SuccessOrdering,
1443 AtomicOrdering FailureOrdering,
1444 SyncScope::ID SSID,
1445 InsertPosition InsertBefore)
1446 : Instruction(
1447 StructType::get(elt1: Cmp->getType(), elts: Type::getInt1Ty(C&: Cmp->getContext())),
1448 AtomicCmpXchg, AllocMarker, InsertBefore) {
1449 Init(Ptr, Cmp, NewVal, Alignment, SuccessOrdering, FailureOrdering, SSID);
1450}
1451
1452//===----------------------------------------------------------------------===//
1453// AtomicRMWInst Implementation
1454//===----------------------------------------------------------------------===//
1455
1456void AtomicRMWInst::Init(BinOp Operation, Value *Ptr, Value *Val,
1457 Align Alignment, AtomicOrdering Ordering,
1458 SyncScope::ID SSID, bool Elementwise) {
1459 assert(Ordering != AtomicOrdering::NotAtomic &&
1460 "atomicrmw instructions can only be atomic.");
1461 assert(Ordering != AtomicOrdering::Unordered &&
1462 "atomicrmw instructions cannot be unordered.");
1463 Op<0>() = Ptr;
1464 Op<1>() = Val;
1465 setOperation(Operation);
1466 setOrdering(Ordering);
1467 setSyncScopeID(SSID);
1468 setElementwise(Elementwise);
1469 setAlignment(Alignment);
1470
1471 assert(getOperand(0) && getOperand(1) && "All operands must be non-null!");
1472 assert(getOperand(0)->getType()->isPointerTy() &&
1473 "Ptr must have pointer type!");
1474 assert(Ordering != AtomicOrdering::NotAtomic &&
1475 "AtomicRMW instructions must be atomic!");
1476}
1477
1478AtomicRMWInst::AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
1479 Align Alignment, AtomicOrdering Ordering,
1480 SyncScope::ID SSID, bool Elementwise,
1481 InsertPosition InsertBefore)
1482 : Instruction(Val->getType(), AtomicRMW, AllocMarker, InsertBefore) {
1483 Init(Operation, Ptr, Val, Alignment, Ordering, SSID, Elementwise);
1484}
1485
1486StringRef AtomicRMWInst::getOperationName(BinOp Op) {
1487 switch (Op) {
1488 case AtomicRMWInst::Xchg:
1489 return "xchg";
1490 case AtomicRMWInst::Add:
1491 return "add";
1492 case AtomicRMWInst::Sub:
1493 return "sub";
1494 case AtomicRMWInst::And:
1495 return "and";
1496 case AtomicRMWInst::Nand:
1497 return "nand";
1498 case AtomicRMWInst::Or:
1499 return "or";
1500 case AtomicRMWInst::Xor:
1501 return "xor";
1502 case AtomicRMWInst::Max:
1503 return "max";
1504 case AtomicRMWInst::Min:
1505 return "min";
1506 case AtomicRMWInst::UMax:
1507 return "umax";
1508 case AtomicRMWInst::UMin:
1509 return "umin";
1510 case AtomicRMWInst::FAdd:
1511 return "fadd";
1512 case AtomicRMWInst::FSub:
1513 return "fsub";
1514 case AtomicRMWInst::FMax:
1515 return "fmax";
1516 case AtomicRMWInst::FMin:
1517 return "fmin";
1518 case AtomicRMWInst::FMaximum:
1519 return "fmaximum";
1520 case AtomicRMWInst::FMinimum:
1521 return "fminimum";
1522 case AtomicRMWInst::FMaximumNum:
1523 return "fmaximumnum";
1524 case AtomicRMWInst::FMinimumNum:
1525 return "fminimumnum";
1526 case AtomicRMWInst::UIncWrap:
1527 return "uinc_wrap";
1528 case AtomicRMWInst::UDecWrap:
1529 return "udec_wrap";
1530 case AtomicRMWInst::USubCond:
1531 return "usub_cond";
1532 case AtomicRMWInst::USubSat:
1533 return "usub_sat";
1534 case AtomicRMWInst::BAD_BINOP:
1535 return "<invalid operation>";
1536 }
1537
1538 llvm_unreachable("invalid atomicrmw operation");
1539}
1540
1541//===----------------------------------------------------------------------===//
1542// FenceInst Implementation
1543//===----------------------------------------------------------------------===//
1544
1545FenceInst::FenceInst(LLVMContext &C, AtomicOrdering Ordering,
1546 SyncScope::ID SSID, InsertPosition InsertBefore)
1547 : Instruction(Type::getVoidTy(C), Fence, AllocMarker, InsertBefore) {
1548 setOrdering(Ordering);
1549 setSyncScopeID(SSID);
1550}
1551
1552//===----------------------------------------------------------------------===//
1553// GetElementPtrInst Implementation
1554//===----------------------------------------------------------------------===//
1555
1556void GetElementPtrInst::init(Value *Ptr, ArrayRef<Value *> IdxList,
1557 const Twine &Name) {
1558 assert(getNumOperands() == 1 + IdxList.size() &&
1559 "NumOperands not initialized?");
1560 Op<0>() = Ptr;
1561 llvm::copy(Range&: IdxList, Out: op_begin() + 1);
1562 setName(Name);
1563}
1564
1565GetElementPtrInst::GetElementPtrInst(const GetElementPtrInst &GEPI,
1566 AllocInfo AllocInfo)
1567 : Instruction(GEPI.getType(), GetElementPtr, AllocInfo),
1568 SourceElementType(GEPI.SourceElementType),
1569 ResultElementType(GEPI.ResultElementType) {
1570 assert(getNumOperands() == GEPI.getNumOperands() &&
1571 "Wrong number of operands allocated");
1572 std::copy(first: GEPI.op_begin(), last: GEPI.op_end(), result: op_begin());
1573 SubclassOptionalData = GEPI.SubclassOptionalData;
1574}
1575
1576Type *GetElementPtrInst::getTypeAtIndex(Type *Ty, Value *Idx) {
1577 if (auto *Struct = dyn_cast<StructType>(Val: Ty)) {
1578 if (!Struct->indexValid(V: Idx))
1579 return nullptr;
1580 return Struct->getTypeAtIndex(V: Idx);
1581 }
1582 if (!Idx->getType()->isIntOrIntVectorTy())
1583 return nullptr;
1584 if (auto *Array = dyn_cast<ArrayType>(Val: Ty))
1585 return Array->getElementType();
1586 if (auto *Vector = dyn_cast<VectorType>(Val: Ty))
1587 return Vector->getElementType();
1588 return nullptr;
1589}
1590
1591Type *GetElementPtrInst::getTypeAtIndex(Type *Ty, uint64_t Idx) {
1592 if (auto *Struct = dyn_cast<StructType>(Val: Ty)) {
1593 if (Idx >= Struct->getNumElements())
1594 return nullptr;
1595 return Struct->getElementType(N: Idx);
1596 }
1597 if (auto *Array = dyn_cast<ArrayType>(Val: Ty))
1598 return Array->getElementType();
1599 if (auto *Vector = dyn_cast<VectorType>(Val: Ty))
1600 return Vector->getElementType();
1601 return nullptr;
1602}
1603
1604template <typename IndexTy>
1605static Type *getIndexedTypeInternal(Type *Ty, ArrayRef<IndexTy> IdxList) {
1606 if (IdxList.empty())
1607 return Ty;
1608 for (IndexTy V : IdxList.slice(1)) {
1609 Ty = GetElementPtrInst::getTypeAtIndex(Ty, V);
1610 if (!Ty)
1611 return Ty;
1612 }
1613 return Ty;
1614}
1615
1616Type *GetElementPtrInst::getIndexedType(Type *Ty, ArrayRef<Value *> IdxList) {
1617 return getIndexedTypeInternal(Ty, IdxList);
1618}
1619
1620Type *GetElementPtrInst::getIndexedType(Type *Ty,
1621 ArrayRef<Constant *> IdxList) {
1622 return getIndexedTypeInternal(Ty, IdxList);
1623}
1624
1625Type *GetElementPtrInst::getIndexedType(Type *Ty, ArrayRef<uint64_t> IdxList) {
1626 return getIndexedTypeInternal(Ty, IdxList);
1627}
1628
1629/// hasAllZeroIndices - Return true if all of the indices of this GEP are
1630/// zeros. If so, the result pointer and the first operand have the same
1631/// value, just potentially different types.
1632bool GetElementPtrInst::hasAllZeroIndices() const {
1633 for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1634 if (ConstantInt *CI = dyn_cast<ConstantInt>(Val: getOperand(i_nocapture: i))) {
1635 if (!CI->isZero()) return false;
1636 } else {
1637 return false;
1638 }
1639 }
1640 return true;
1641}
1642
1643/// hasAllConstantIndices - Return true if all of the indices of this GEP are
1644/// constant integers. If so, the result pointer and the first operand have
1645/// a constant offset between them.
1646bool GetElementPtrInst::hasAllConstantIndices() const {
1647 for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1648 if (!isa<ConstantInt>(Val: getOperand(i_nocapture: i)))
1649 return false;
1650 }
1651 return true;
1652}
1653
1654void GetElementPtrInst::setNoWrapFlags(GEPNoWrapFlags NW) {
1655 SubclassOptionalData = NW.getRaw();
1656}
1657
1658void GetElementPtrInst::setIsInBounds(bool B) {
1659 GEPNoWrapFlags NW = cast<GEPOperator>(Val: this)->getNoWrapFlags();
1660 if (B)
1661 NW |= GEPNoWrapFlags::inBounds();
1662 else
1663 NW = NW.withoutInBounds();
1664 setNoWrapFlags(NW);
1665}
1666
1667GEPNoWrapFlags GetElementPtrInst::getNoWrapFlags() const {
1668 return cast<GEPOperator>(Val: this)->getNoWrapFlags();
1669}
1670
1671bool GetElementPtrInst::isInBounds() const {
1672 return cast<GEPOperator>(Val: this)->isInBounds();
1673}
1674
1675bool GetElementPtrInst::hasNoUnsignedSignedWrap() const {
1676 return cast<GEPOperator>(Val: this)->hasNoUnsignedSignedWrap();
1677}
1678
1679bool GetElementPtrInst::hasNoUnsignedWrap() const {
1680 return cast<GEPOperator>(Val: this)->hasNoUnsignedWrap();
1681}
1682
1683bool GetElementPtrInst::accumulateConstantOffset(const DataLayout &DL,
1684 APInt &Offset) const {
1685 // Delegate to the generic GEPOperator implementation.
1686 return cast<GEPOperator>(Val: this)->accumulateConstantOffset(DL, Offset);
1687}
1688
1689bool GetElementPtrInst::collectOffset(
1690 const DataLayout &DL, unsigned BitWidth,
1691 SmallMapVector<Value *, APInt, 4> &VariableOffsets,
1692 APInt &ConstantOffset) const {
1693 // Delegate to the generic GEPOperator implementation.
1694 return cast<GEPOperator>(Val: this)->collectOffset(DL, BitWidth, VariableOffsets,
1695 ConstantOffset);
1696}
1697
1698//===----------------------------------------------------------------------===//
1699// ExtractElementInst Implementation
1700//===----------------------------------------------------------------------===//
1701
1702ExtractElementInst::ExtractElementInst(Value *Val, Value *Index,
1703 const Twine &Name,
1704 InsertPosition InsertBef)
1705 : Instruction(cast<VectorType>(Val: Val->getType())->getElementType(),
1706 ExtractElement, AllocMarker, InsertBef) {
1707 assert(isValidOperands(Val, Index) &&
1708 "Invalid extractelement instruction operands!");
1709 Op<0>() = Val;
1710 Op<1>() = Index;
1711 setName(Name);
1712}
1713
1714bool ExtractElementInst::isValidOperands(const Value *Val, const Value *Index) {
1715 if (!Val->getType()->isVectorTy() || !Index->getType()->isIntegerTy())
1716 return false;
1717 return true;
1718}
1719
1720//===----------------------------------------------------------------------===//
1721// InsertElementInst Implementation
1722//===----------------------------------------------------------------------===//
1723
1724InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, Value *Index,
1725 const Twine &Name,
1726 InsertPosition InsertBef)
1727 : Instruction(Vec->getType(), InsertElement, AllocMarker, InsertBef) {
1728 assert(isValidOperands(Vec, Elt, Index) &&
1729 "Invalid insertelement instruction operands!");
1730 Op<0>() = Vec;
1731 Op<1>() = Elt;
1732 Op<2>() = Index;
1733 setName(Name);
1734}
1735
1736bool InsertElementInst::isValidOperands(const Value *Vec, const Value *Elt,
1737 const Value *Index) {
1738 if (!Vec->getType()->isVectorTy())
1739 return false; // First operand of insertelement must be vector type.
1740
1741 if (Elt->getType() != cast<VectorType>(Val: Vec->getType())->getElementType())
1742 return false;// Second operand of insertelement must be vector element type.
1743
1744 if (!Index->getType()->isIntegerTy())
1745 return false; // Third operand of insertelement must be i32.
1746 return true;
1747}
1748
1749//===----------------------------------------------------------------------===//
1750// ShuffleVectorInst Implementation
1751//===----------------------------------------------------------------------===//
1752
1753static Value *createPlaceholderForShuffleVector(Value *V) {
1754 assert(V && "Cannot create placeholder of nullptr V");
1755 return PoisonValue::get(T: V->getType());
1756}
1757
1758ShuffleVectorInst::ShuffleVectorInst(Value *V1, Value *Mask, const Twine &Name,
1759 InsertPosition InsertBefore)
1760 : ShuffleVectorInst(V1, createPlaceholderForShuffleVector(V: V1), Mask, Name,
1761 InsertBefore) {}
1762
1763ShuffleVectorInst::ShuffleVectorInst(Value *V1, ArrayRef<int> Mask,
1764 const Twine &Name,
1765 InsertPosition InsertBefore)
1766 : ShuffleVectorInst(V1, createPlaceholderForShuffleVector(V: V1), Mask, Name,
1767 InsertBefore) {}
1768
1769ShuffleVectorInst::ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1770 const Twine &Name,
1771 InsertPosition InsertBefore)
1772 : Instruction(
1773 VectorType::get(ElementType: cast<VectorType>(Val: V1->getType())->getElementType(),
1774 EC: cast<VectorType>(Val: Mask->getType())->getElementCount()),
1775 ShuffleVector, AllocMarker, InsertBefore) {
1776 assert(isValidOperands(V1, V2, Mask) &&
1777 "Invalid shuffle vector instruction operands!");
1778
1779 Op<0>() = V1;
1780 Op<1>() = V2;
1781 SmallVector<int, 16> MaskArr;
1782 getShuffleMask(Mask: cast<Constant>(Val: Mask), Result&: MaskArr);
1783 setShuffleMask(MaskArr);
1784 setName(Name);
1785}
1786
1787ShuffleVectorInst::ShuffleVectorInst(Value *V1, Value *V2, ArrayRef<int> Mask,
1788 const Twine &Name,
1789 InsertPosition InsertBefore)
1790 : Instruction(
1791 VectorType::get(ElementType: cast<VectorType>(Val: V1->getType())->getElementType(),
1792 NumElements: Mask.size(), Scalable: isa<ScalableVectorType>(Val: V1->getType())),
1793 ShuffleVector, AllocMarker, InsertBefore) {
1794 assert(isValidOperands(V1, V2, Mask) &&
1795 "Invalid shuffle vector instruction operands!");
1796 Op<0>() = V1;
1797 Op<1>() = V2;
1798 setShuffleMask(Mask);
1799 setName(Name);
1800}
1801
1802void ShuffleVectorInst::commute() {
1803 int NumOpElts = cast<FixedVectorType>(Val: Op<0>()->getType())->getNumElements();
1804 int NumMaskElts = ShuffleMask.size();
1805 SmallVector<int, 16> NewMask(NumMaskElts);
1806 for (int i = 0; i != NumMaskElts; ++i) {
1807 int MaskElt = getMaskValue(Elt: i);
1808 if (MaskElt == PoisonMaskElem) {
1809 NewMask[i] = PoisonMaskElem;
1810 continue;
1811 }
1812 assert(MaskElt >= 0 && MaskElt < 2 * NumOpElts && "Out-of-range mask");
1813 MaskElt = (MaskElt < NumOpElts) ? MaskElt + NumOpElts : MaskElt - NumOpElts;
1814 NewMask[i] = MaskElt;
1815 }
1816 setShuffleMask(NewMask);
1817 Op<0>().swap(RHS&: Op<1>());
1818}
1819
1820bool ShuffleVectorInst::isValidOperands(const Value *V1, const Value *V2,
1821 ArrayRef<int> Mask) {
1822 // V1 and V2 must be vectors of the same type.
1823 if (!isa<VectorType>(Val: V1->getType()) || V1->getType() != V2->getType())
1824 return false;
1825
1826 // Make sure the mask elements make sense.
1827 int V1Size =
1828 cast<VectorType>(Val: V1->getType())->getElementCount().getKnownMinValue();
1829 for (int Elem : Mask)
1830 if (Elem != PoisonMaskElem && Elem >= V1Size * 2)
1831 return false;
1832
1833 if (isa<ScalableVectorType>(Val: V1->getType()))
1834 if ((Mask[0] != 0 && Mask[0] != PoisonMaskElem) || !all_equal(Range&: Mask))
1835 return false;
1836
1837 return true;
1838}
1839
1840bool ShuffleVectorInst::isValidOperands(const Value *V1, const Value *V2,
1841 const Value *Mask) {
1842 // V1 and V2 must be vectors of the same type.
1843 if (!V1->getType()->isVectorTy() || V1->getType() != V2->getType())
1844 return false;
1845
1846 // Mask must be vector of i32, and must be the same kind of vector as the
1847 // input vectors
1848 auto *MaskTy = dyn_cast<VectorType>(Val: Mask->getType());
1849 if (!MaskTy || !MaskTy->getElementType()->isIntegerTy(BitWidth: 32) ||
1850 isa<ScalableVectorType>(Val: MaskTy) != isa<ScalableVectorType>(Val: V1->getType()))
1851 return false;
1852
1853 // Check to see if Mask is valid.
1854 if (isa<UndefValue>(Val: Mask) || isa<ConstantAggregateZero>(Val: Mask))
1855 return true;
1856
1857 // NOTE: Through vector ConstantInt we have the potential to support more
1858 // than just zero splat masks but that requires a LangRef change.
1859 if (isa<ScalableVectorType>(Val: MaskTy))
1860 return false;
1861
1862 unsigned V1Size = cast<FixedVectorType>(Val: V1->getType())->getNumElements();
1863
1864 if (const auto *CI = dyn_cast<ConstantInt>(Val: Mask))
1865 return !CI->uge(Num: V1Size * 2);
1866
1867 if (const auto *MV = dyn_cast<ConstantVector>(Val: Mask)) {
1868 for (Value *Op : MV->operands()) {
1869 if (auto *CI = dyn_cast<ConstantInt>(Val: Op)) {
1870 if (CI->uge(Num: V1Size*2))
1871 return false;
1872 } else if (!isa<UndefValue>(Val: Op)) {
1873 return false;
1874 }
1875 }
1876 return true;
1877 }
1878
1879 if (const auto *CDS = dyn_cast<ConstantDataSequential>(Val: Mask)) {
1880 for (unsigned i = 0, e = cast<FixedVectorType>(Val: MaskTy)->getNumElements();
1881 i != e; ++i)
1882 if (CDS->getElementAsInteger(i) >= V1Size*2)
1883 return false;
1884 return true;
1885 }
1886
1887 return false;
1888}
1889
1890void ShuffleVectorInst::getShuffleMask(const Constant *Mask,
1891 SmallVectorImpl<int> &Result) {
1892 ElementCount EC = cast<VectorType>(Val: Mask->getType())->getElementCount();
1893
1894 if (isa<ConstantAggregateZero>(Val: Mask) || isa<UndefValue>(Val: Mask)) {
1895 int MaskVal = isa<UndefValue>(Val: Mask) ? -1 : 0;
1896 Result.append(NumInputs: EC.getKnownMinValue(), Elt: MaskVal);
1897 return;
1898 }
1899
1900 assert(!EC.isScalable() &&
1901 "Scalable vector shuffle mask must be undef or zeroinitializer");
1902
1903 unsigned NumElts = EC.getFixedValue();
1904
1905 Result.reserve(N: NumElts);
1906
1907 if (auto *CDS = dyn_cast<ConstantDataSequential>(Val: Mask)) {
1908 for (unsigned i = 0; i != NumElts; ++i)
1909 Result.push_back(Elt: CDS->getElementAsInteger(i));
1910 return;
1911 }
1912 for (unsigned i = 0; i != NumElts; ++i) {
1913 Constant *C = Mask->getAggregateElement(Elt: i);
1914 Result.push_back(Elt: isa<UndefValue>(Val: C) ? -1 :
1915 cast<ConstantInt>(Val: C)->getZExtValue());
1916 }
1917}
1918
1919void ShuffleVectorInst::setShuffleMask(ArrayRef<int> Mask) {
1920 ShuffleMask.assign(in_start: Mask.begin(), in_end: Mask.end());
1921 ShuffleMaskForBitcode = convertShuffleMaskForBitcode(Mask, ResultTy: getType());
1922}
1923
1924Constant *ShuffleVectorInst::convertShuffleMaskForBitcode(ArrayRef<int> Mask,
1925 Type *ResultTy) {
1926 Type *Int32Ty = Type::getInt32Ty(C&: ResultTy->getContext());
1927 if (isa<ScalableVectorType>(Val: ResultTy)) {
1928 assert(all_equal(Mask) && "Unexpected shuffle");
1929 Type *VecTy = VectorType::get(ElementType: Int32Ty, NumElements: Mask.size(), Scalable: true);
1930 if (Mask[0] == 0)
1931 return Constant::getNullValue(Ty: VecTy);
1932 return PoisonValue::get(T: VecTy);
1933 }
1934 SmallVector<Constant *, 16> MaskConst;
1935 for (int Elem : Mask) {
1936 if (Elem == PoisonMaskElem)
1937 MaskConst.push_back(Elt: PoisonValue::get(T: Int32Ty));
1938 else
1939 MaskConst.push_back(Elt: ConstantInt::get(Ty: Int32Ty, V: Elem));
1940 }
1941 return ConstantVector::get(V: MaskConst);
1942}
1943
1944static bool isSingleSourceMaskImpl(ArrayRef<int> Mask, int NumOpElts) {
1945 assert(!Mask.empty() && "Shuffle mask must contain elements");
1946 bool UsesLHS = false;
1947 bool UsesRHS = false;
1948 for (int I : Mask) {
1949 if (I == -1)
1950 continue;
1951 assert(I >= 0 && I < (NumOpElts * 2) &&
1952 "Out-of-bounds shuffle mask element");
1953 UsesLHS |= (I < NumOpElts);
1954 UsesRHS |= (I >= NumOpElts);
1955 if (UsesLHS && UsesRHS)
1956 return false;
1957 }
1958 // Allow for degenerate case: completely undef mask means neither source is used.
1959 return UsesLHS || UsesRHS;
1960}
1961
1962bool ShuffleVectorInst::isSingleSourceMask(ArrayRef<int> Mask, int NumSrcElts) {
1963 // We don't have vector operand size information, so assume operands are the
1964 // same size as the mask.
1965 return isSingleSourceMaskImpl(Mask, NumOpElts: NumSrcElts);
1966}
1967
1968static bool isIdentityMaskImpl(ArrayRef<int> Mask, int NumOpElts) {
1969 if (!isSingleSourceMaskImpl(Mask, NumOpElts))
1970 return false;
1971 for (int i = 0, NumMaskElts = Mask.size(); i < NumMaskElts; ++i) {
1972 if (Mask[i] == -1)
1973 continue;
1974 if (Mask[i] != i && Mask[i] != (NumOpElts + i))
1975 return false;
1976 }
1977 return true;
1978}
1979
1980bool ShuffleVectorInst::isIdentityMask(ArrayRef<int> Mask, int NumSrcElts) {
1981 if (Mask.size() != static_cast<unsigned>(NumSrcElts))
1982 return false;
1983 // We don't have vector operand size information, so assume operands are the
1984 // same size as the mask.
1985 return isIdentityMaskImpl(Mask, NumOpElts: NumSrcElts);
1986}
1987
1988bool ShuffleVectorInst::isReverseMask(ArrayRef<int> Mask, int NumSrcElts) {
1989 if (Mask.size() != static_cast<unsigned>(NumSrcElts))
1990 return false;
1991 if (!isSingleSourceMask(Mask, NumSrcElts))
1992 return false;
1993
1994 // The number of elements in the mask must be at least 2.
1995 if (NumSrcElts < 2)
1996 return false;
1997
1998 for (int I = 0, E = Mask.size(); I < E; ++I) {
1999 if (Mask[I] == -1)
2000 continue;
2001 if (Mask[I] != (NumSrcElts - 1 - I) &&
2002 Mask[I] != (NumSrcElts + NumSrcElts - 1 - I))
2003 return false;
2004 }
2005 return true;
2006}
2007
2008bool ShuffleVectorInst::isZeroEltSplatMask(ArrayRef<int> Mask, int NumSrcElts) {
2009 if (Mask.size() != static_cast<unsigned>(NumSrcElts))
2010 return false;
2011 if (!isSingleSourceMask(Mask, NumSrcElts))
2012 return false;
2013 for (int I = 0, E = Mask.size(); I < E; ++I) {
2014 if (Mask[I] == -1)
2015 continue;
2016 if (Mask[I] != 0 && Mask[I] != NumSrcElts)
2017 return false;
2018 }
2019 return true;
2020}
2021
2022bool ShuffleVectorInst::isSelectMask(ArrayRef<int> Mask, int NumSrcElts) {
2023 if (Mask.size() != static_cast<unsigned>(NumSrcElts))
2024 return false;
2025 // Select is differentiated from identity. It requires using both sources.
2026 if (isSingleSourceMask(Mask, NumSrcElts))
2027 return false;
2028 for (int I = 0, E = Mask.size(); I < E; ++I) {
2029 if (Mask[I] == -1)
2030 continue;
2031 if (Mask[I] != I && Mask[I] != (NumSrcElts + I))
2032 return false;
2033 }
2034 return true;
2035}
2036
2037bool ShuffleVectorInst::isTransposeMask(ArrayRef<int> Mask, int NumSrcElts) {
2038 // Example masks that will return true:
2039 // v1 = <a, b, c, d>
2040 // v2 = <e, f, g, h>
2041 // trn1 = shufflevector v1, v2 <0, 4, 2, 6> = <a, e, c, g>
2042 // trn2 = shufflevector v1, v2 <1, 5, 3, 7> = <b, f, d, h>
2043
2044 if (Mask.size() != static_cast<unsigned>(NumSrcElts))
2045 return false;
2046 // 1. The number of elements in the mask must be a power-of-2 and at least 2.
2047 int Sz = Mask.size();
2048 if (Sz < 2 || !isPowerOf2_32(Value: Sz))
2049 return false;
2050
2051 // 2. The first element of the mask must be either a 0 or a 1.
2052 if (Mask[0] != 0 && Mask[0] != 1)
2053 return false;
2054
2055 // 3. The difference between the first 2 elements must be equal to the
2056 // number of elements in the mask.
2057 if ((Mask[1] - Mask[0]) != NumSrcElts)
2058 return false;
2059
2060 // 4. The difference between consecutive even-numbered and odd-numbered
2061 // elements must be equal to 2.
2062 for (int I = 2; I < Sz; ++I) {
2063 int MaskEltVal = Mask[I];
2064 if (MaskEltVal == -1)
2065 return false;
2066 int MaskEltPrevVal = Mask[I - 2];
2067 if (MaskEltVal - MaskEltPrevVal != 2)
2068 return false;
2069 }
2070 return true;
2071}
2072
2073bool ShuffleVectorInst::isSpliceMask(ArrayRef<int> Mask, int NumSrcElts,
2074 int &Index) {
2075 if (Mask.size() != static_cast<unsigned>(NumSrcElts))
2076 return false;
2077 // Example: shufflevector <4 x n> A, <4 x n> B, <1,2,3,4>
2078 int StartIndex = -1;
2079 for (int I = 0, E = Mask.size(); I != E; ++I) {
2080 int MaskEltVal = Mask[I];
2081 if (MaskEltVal == -1)
2082 continue;
2083
2084 if (StartIndex == -1) {
2085 // Don't support a StartIndex that begins in the second input, or if the
2086 // first non-undef index would access below the StartIndex.
2087 if (MaskEltVal < I || NumSrcElts <= (MaskEltVal - I))
2088 return false;
2089
2090 StartIndex = MaskEltVal - I;
2091 continue;
2092 }
2093
2094 // Splice is sequential starting from StartIndex.
2095 if (MaskEltVal != (StartIndex + I))
2096 return false;
2097 }
2098
2099 if (StartIndex == -1)
2100 return false;
2101
2102 // NOTE: This accepts StartIndex == 0 (COPY).
2103 Index = StartIndex;
2104 return true;
2105}
2106
2107bool ShuffleVectorInst::isExtractSubvectorMask(ArrayRef<int> Mask,
2108 int NumSrcElts, int &Index) {
2109 // Must extract from a single source.
2110 if (!isSingleSourceMaskImpl(Mask, NumOpElts: NumSrcElts))
2111 return false;
2112
2113 // Must be smaller (else this is an Identity shuffle).
2114 if (NumSrcElts <= (int)Mask.size())
2115 return false;
2116
2117 // Find start of extraction, accounting that we may start with an UNDEF.
2118 int SubIndex = -1;
2119 for (int i = 0, e = Mask.size(); i != e; ++i) {
2120 int M = Mask[i];
2121 if (M < 0)
2122 continue;
2123 int Offset = (M % NumSrcElts) - i;
2124 if (0 <= SubIndex && SubIndex != Offset)
2125 return false;
2126 SubIndex = Offset;
2127 }
2128
2129 if (0 <= SubIndex && SubIndex + (int)Mask.size() <= NumSrcElts) {
2130 Index = SubIndex;
2131 return true;
2132 }
2133 return false;
2134}
2135
2136bool ShuffleVectorInst::isInsertSubvectorMask(ArrayRef<int> Mask,
2137 int NumSrcElts, int &NumSubElts,
2138 int &Index) {
2139 int NumMaskElts = Mask.size();
2140
2141 // Don't try to match if we're shuffling to a smaller size.
2142 if (NumMaskElts < NumSrcElts)
2143 return false;
2144
2145 // TODO: We don't recognize self-insertion/widening.
2146 if (isSingleSourceMaskImpl(Mask, NumOpElts: NumSrcElts))
2147 return false;
2148
2149 // Determine which mask elements are attributed to which source.
2150 APInt UndefElts = APInt::getZero(numBits: NumMaskElts);
2151 APInt Src0Elts = APInt::getZero(numBits: NumMaskElts);
2152 APInt Src1Elts = APInt::getZero(numBits: NumMaskElts);
2153 bool Src0Identity = true;
2154 bool Src1Identity = true;
2155
2156 for (int i = 0; i != NumMaskElts; ++i) {
2157 int M = Mask[i];
2158 if (M < 0) {
2159 UndefElts.setBit(i);
2160 continue;
2161 }
2162 if (M < NumSrcElts) {
2163 Src0Elts.setBit(i);
2164 Src0Identity &= (M == i);
2165 continue;
2166 }
2167 Src1Elts.setBit(i);
2168 Src1Identity &= (M == (i + NumSrcElts));
2169 }
2170 assert((Src0Elts | Src1Elts | UndefElts).isAllOnes() &&
2171 "unknown shuffle elements");
2172 assert(!Src0Elts.isZero() && !Src1Elts.isZero() &&
2173 "2-source shuffle not found");
2174
2175 // Determine lo/hi span ranges.
2176 // TODO: How should we handle undefs at the start of subvector insertions?
2177 int Src0Lo = Src0Elts.countr_zero();
2178 int Src1Lo = Src1Elts.countr_zero();
2179 int Src0Hi = NumMaskElts - Src0Elts.countl_zero();
2180 int Src1Hi = NumMaskElts - Src1Elts.countl_zero();
2181
2182 // If src0 is in place, see if the src1 elements is inplace within its own
2183 // span.
2184 if (Src0Identity) {
2185 int NumSub1Elts = Src1Hi - Src1Lo;
2186 ArrayRef<int> Sub1Mask = Mask.slice(N: Src1Lo, M: NumSub1Elts);
2187 if (isIdentityMaskImpl(Mask: Sub1Mask, NumOpElts: NumSrcElts)) {
2188 NumSubElts = NumSub1Elts;
2189 Index = Src1Lo;
2190 return true;
2191 }
2192 }
2193
2194 // If src1 is in place, see if the src0 elements is inplace within its own
2195 // span.
2196 if (Src1Identity) {
2197 int NumSub0Elts = Src0Hi - Src0Lo;
2198 ArrayRef<int> Sub0Mask = Mask.slice(N: Src0Lo, M: NumSub0Elts);
2199 if (isIdentityMaskImpl(Mask: Sub0Mask, NumOpElts: NumSrcElts)) {
2200 NumSubElts = NumSub0Elts;
2201 Index = Src0Lo;
2202 return true;
2203 }
2204 }
2205
2206 return false;
2207}
2208
2209bool ShuffleVectorInst::isIdentityWithPadding() const {
2210 // FIXME: Not currently possible to express a shuffle mask for a scalable
2211 // vector for this case.
2212 if (isa<ScalableVectorType>(Val: getType()))
2213 return false;
2214
2215 int NumOpElts = cast<FixedVectorType>(Val: Op<0>()->getType())->getNumElements();
2216 int NumMaskElts = cast<FixedVectorType>(Val: getType())->getNumElements();
2217 if (NumMaskElts <= NumOpElts)
2218 return false;
2219
2220 // The first part of the mask must choose elements from exactly 1 source op.
2221 ArrayRef<int> Mask = getShuffleMask();
2222 if (!isIdentityMaskImpl(Mask, NumOpElts))
2223 return false;
2224
2225 // All extending must be with undef elements.
2226 for (int i = NumOpElts; i < NumMaskElts; ++i)
2227 if (Mask[i] != -1)
2228 return false;
2229
2230 return true;
2231}
2232
2233bool ShuffleVectorInst::isIdentityWithExtract() const {
2234 // FIXME: Not currently possible to express a shuffle mask for a scalable
2235 // vector for this case.
2236 if (isa<ScalableVectorType>(Val: getType()))
2237 return false;
2238
2239 int NumOpElts = cast<FixedVectorType>(Val: Op<0>()->getType())->getNumElements();
2240 int NumMaskElts = cast<FixedVectorType>(Val: getType())->getNumElements();
2241 if (NumMaskElts >= NumOpElts)
2242 return false;
2243
2244 return isIdentityMaskImpl(Mask: getShuffleMask(), NumOpElts);
2245}
2246
2247bool ShuffleVectorInst::isConcat() const {
2248 // Vector concatenation is differentiated from identity with padding.
2249 if (isa<UndefValue>(Val: Op<0>()) || isa<UndefValue>(Val: Op<1>()))
2250 return false;
2251
2252 // FIXME: Not currently possible to express a shuffle mask for a scalable
2253 // vector for this case.
2254 if (isa<ScalableVectorType>(Val: getType()))
2255 return false;
2256
2257 int NumOpElts = cast<FixedVectorType>(Val: Op<0>()->getType())->getNumElements();
2258 int NumMaskElts = cast<FixedVectorType>(Val: getType())->getNumElements();
2259 if (NumMaskElts != NumOpElts * 2)
2260 return false;
2261
2262 // Use the mask length rather than the operands' vector lengths here. We
2263 // already know that the shuffle returns a vector twice as long as the inputs,
2264 // and neither of the inputs are undef vectors. If the mask picks consecutive
2265 // elements from both inputs, then this is a concatenation of the inputs.
2266 return isIdentityMaskImpl(Mask: getShuffleMask(), NumOpElts: NumMaskElts);
2267}
2268
2269static bool isReplicationMaskWithParams(ArrayRef<int> Mask,
2270 int ReplicationFactor, int VF) {
2271 assert(Mask.size() == (unsigned)ReplicationFactor * VF &&
2272 "Unexpected mask size.");
2273
2274 for (int CurrElt : seq(Size: VF)) {
2275 ArrayRef<int> CurrSubMask = Mask.take_front(N: ReplicationFactor);
2276 assert(CurrSubMask.size() == (unsigned)ReplicationFactor &&
2277 "Run out of mask?");
2278 Mask = Mask.drop_front(N: ReplicationFactor);
2279 if (!all_of(Range&: CurrSubMask, P: [CurrElt](int MaskElt) {
2280 return MaskElt == PoisonMaskElem || MaskElt == CurrElt;
2281 }))
2282 return false;
2283 }
2284 assert(Mask.empty() && "Did not consume the whole mask?");
2285
2286 return true;
2287}
2288
2289bool ShuffleVectorInst::isReplicationMask(ArrayRef<int> Mask,
2290 int &ReplicationFactor, int &VF) {
2291 // undef-less case is trivial.
2292 if (!llvm::is_contained(Range&: Mask, Element: PoisonMaskElem)) {
2293 ReplicationFactor =
2294 Mask.take_while(Pred: [](int MaskElt) { return MaskElt == 0; }).size();
2295 if (ReplicationFactor == 0 || Mask.size() % ReplicationFactor != 0)
2296 return false;
2297 VF = Mask.size() / ReplicationFactor;
2298 return isReplicationMaskWithParams(Mask, ReplicationFactor, VF);
2299 }
2300
2301 // However, if the mask contains undef's, we have to enumerate possible tuples
2302 // and pick one. There are bounds on replication factor: [1, mask size]
2303 // (where RF=1 is an identity shuffle, RF=mask size is a broadcast shuffle)
2304 // Additionally, mask size is a replication factor multiplied by vector size,
2305 // which further significantly reduces the search space.
2306
2307 // Before doing that, let's perform basic correctness checking first.
2308 int Largest = -1;
2309 for (int MaskElt : Mask) {
2310 if (MaskElt == PoisonMaskElem)
2311 continue;
2312 // Elements must be in non-decreasing order.
2313 if (MaskElt < Largest)
2314 return false;
2315 Largest = std::max(a: Largest, b: MaskElt);
2316 }
2317
2318 // Prefer larger replication factor if all else equal.
2319 for (int PossibleReplicationFactor :
2320 reverse(C: seq_inclusive<unsigned>(Begin: 1, End: Mask.size()))) {
2321 if (Mask.size() % PossibleReplicationFactor != 0)
2322 continue;
2323 int PossibleVF = Mask.size() / PossibleReplicationFactor;
2324 if (!isReplicationMaskWithParams(Mask, ReplicationFactor: PossibleReplicationFactor,
2325 VF: PossibleVF))
2326 continue;
2327 ReplicationFactor = PossibleReplicationFactor;
2328 VF = PossibleVF;
2329 return true;
2330 }
2331
2332 return false;
2333}
2334
2335bool ShuffleVectorInst::isReplicationMask(int &ReplicationFactor,
2336 int &VF) const {
2337 // Not possible to express a shuffle mask for a scalable vector for this
2338 // case.
2339 if (isa<ScalableVectorType>(Val: getType()))
2340 return false;
2341
2342 VF = cast<FixedVectorType>(Val: Op<0>()->getType())->getNumElements();
2343 if (ShuffleMask.size() % VF != 0)
2344 return false;
2345 ReplicationFactor = ShuffleMask.size() / VF;
2346
2347 return isReplicationMaskWithParams(Mask: ShuffleMask, ReplicationFactor, VF);
2348}
2349
2350bool ShuffleVectorInst::isOneUseSingleSourceMask(ArrayRef<int> Mask, int VF) {
2351 if (VF <= 0 || Mask.size() < static_cast<unsigned>(VF) ||
2352 Mask.size() % VF != 0)
2353 return false;
2354 for (unsigned K = 0, Sz = Mask.size(); K < Sz; K += VF) {
2355 ArrayRef<int> SubMask = Mask.slice(N: K, M: VF);
2356 if (all_of(Range&: SubMask, P: equal_to(Arg: PoisonMaskElem)))
2357 continue;
2358 SmallBitVector Used(VF, false);
2359 for (int Idx : SubMask) {
2360 if (Idx != PoisonMaskElem && Idx < VF)
2361 Used.set(Idx);
2362 }
2363 if (!Used.all())
2364 return false;
2365 }
2366 return true;
2367}
2368
2369/// Return true if this shuffle mask is a replication mask.
2370bool ShuffleVectorInst::isOneUseSingleSourceMask(int VF) const {
2371 // Not possible to express a shuffle mask for a scalable vector for this
2372 // case.
2373 if (isa<ScalableVectorType>(Val: getType()))
2374 return false;
2375 if (!isSingleSourceMask(Mask: ShuffleMask, NumSrcElts: VF))
2376 return false;
2377
2378 return isOneUseSingleSourceMask(Mask: ShuffleMask, VF);
2379}
2380
2381bool ShuffleVectorInst::isInterleave(unsigned Factor) {
2382 FixedVectorType *OpTy = dyn_cast<FixedVectorType>(Val: getOperand(i_nocapture: 0)->getType());
2383 // shuffle_vector can only interleave fixed length vectors - for scalable
2384 // vectors, see the @llvm.vector.interleave2 intrinsic
2385 if (!OpTy)
2386 return false;
2387 unsigned OpNumElts = OpTy->getNumElements();
2388
2389 return isInterleaveMask(Mask: ShuffleMask, Factor, NumInputElts: OpNumElts * 2);
2390}
2391
2392bool ShuffleVectorInst::isInterleaveMask(
2393 ArrayRef<int> Mask, unsigned Factor, unsigned NumInputElts,
2394 SmallVectorImpl<unsigned> &StartIndexes) {
2395 unsigned NumElts = Mask.size();
2396 if (NumElts % Factor)
2397 return false;
2398
2399 unsigned LaneLen = NumElts / Factor;
2400 if (!isPowerOf2_32(Value: LaneLen))
2401 return false;
2402
2403 StartIndexes.resize(N: Factor);
2404
2405 // Check whether each element matches the general interleaved rule.
2406 // Ignore undef elements, as long as the defined elements match the rule.
2407 // Outer loop processes all factors (x, y, z in the above example)
2408 unsigned I = 0, J;
2409 for (; I < Factor; I++) {
2410 unsigned SavedLaneValue;
2411 unsigned SavedNoUndefs = 0;
2412
2413 // Inner loop processes consecutive accesses (x, x+1... in the example)
2414 for (J = 0; J < LaneLen - 1; J++) {
2415 // Lane computes x's position in the Mask
2416 unsigned Lane = J * Factor + I;
2417 unsigned NextLane = Lane + Factor;
2418 int LaneValue = Mask[Lane];
2419 int NextLaneValue = Mask[NextLane];
2420
2421 // If both are defined, values must be sequential
2422 if (LaneValue >= 0 && NextLaneValue >= 0 &&
2423 LaneValue + 1 != NextLaneValue)
2424 break;
2425
2426 // If the next value is undef, save the current one as reference
2427 if (LaneValue >= 0 && NextLaneValue < 0) {
2428 SavedLaneValue = LaneValue;
2429 SavedNoUndefs = 1;
2430 }
2431
2432 // Undefs are allowed, but defined elements must still be consecutive:
2433 // i.e.: x,..., undef,..., x + 2,..., undef,..., undef,..., x + 5, ....
2434 // Verify this by storing the last non-undef followed by an undef
2435 // Check that following non-undef masks are incremented with the
2436 // corresponding distance.
2437 if (SavedNoUndefs > 0 && LaneValue < 0) {
2438 SavedNoUndefs++;
2439 if (NextLaneValue >= 0 &&
2440 SavedLaneValue + SavedNoUndefs != (unsigned)NextLaneValue)
2441 break;
2442 }
2443 }
2444
2445 if (J < LaneLen - 1)
2446 return false;
2447
2448 int StartMask = 0;
2449 if (Mask[I] >= 0) {
2450 // Check that the start of the I range (J=0) is greater than 0
2451 StartMask = Mask[I];
2452 } else if (Mask[(LaneLen - 1) * Factor + I] >= 0) {
2453 // StartMask defined by the last value in lane
2454 StartMask = Mask[(LaneLen - 1) * Factor + I] - J;
2455 } else if (SavedNoUndefs > 0) {
2456 // StartMask defined by some non-zero value in the j loop
2457 StartMask = SavedLaneValue - (LaneLen - 1 - SavedNoUndefs);
2458 }
2459 // else StartMask remains set to 0, i.e. all elements are undefs
2460
2461 if (StartMask < 0)
2462 return false;
2463 // We must stay within the vectors; This case can happen with undefs.
2464 if (StartMask + LaneLen > NumInputElts)
2465 return false;
2466
2467 StartIndexes[I] = StartMask;
2468 }
2469
2470 return true;
2471}
2472
2473/// Check if the mask is a DE-interleave mask of the given factor
2474/// \p Factor like:
2475/// <Index, Index+Factor, ..., Index+(NumElts-1)*Factor>
2476bool ShuffleVectorInst::isDeInterleaveMaskOfFactor(ArrayRef<int> Mask,
2477 unsigned Factor,
2478 unsigned &Index) {
2479 // Check all potential start indices from 0 to (Factor - 1).
2480 for (unsigned Idx = 0; Idx < Factor; Idx++) {
2481 unsigned I = 0;
2482
2483 // Check that elements are in ascending order by Factor. Ignore undef
2484 // elements.
2485 for (; I < Mask.size(); I++)
2486 if (Mask[I] >= 0 && static_cast<unsigned>(Mask[I]) != Idx + I * Factor)
2487 break;
2488
2489 if (I == Mask.size()) {
2490 Index = Idx;
2491 return true;
2492 }
2493 }
2494
2495 return false;
2496}
2497
2498/// Try to lower a vector shuffle as a bit rotation.
2499///
2500/// Look for a repeated rotation pattern in each sub group.
2501/// Returns an element-wise left bit rotation amount or -1 if failed.
2502static int matchShuffleAsBitRotate(ArrayRef<int> Mask, int NumSubElts) {
2503 int NumElts = Mask.size();
2504 assert((NumElts % NumSubElts) == 0 && "Illegal shuffle mask");
2505
2506 int RotateAmt = -1;
2507 for (int i = 0; i != NumElts; i += NumSubElts) {
2508 for (int j = 0; j != NumSubElts; ++j) {
2509 int M = Mask[i + j];
2510 if (M < 0)
2511 continue;
2512 if (M < i || M >= i + NumSubElts)
2513 return -1;
2514 int Offset = (NumSubElts - (M - (i + j))) % NumSubElts;
2515 if (0 <= RotateAmt && Offset != RotateAmt)
2516 return -1;
2517 RotateAmt = Offset;
2518 }
2519 }
2520 return RotateAmt;
2521}
2522
2523bool ShuffleVectorInst::isBitRotateMask(
2524 ArrayRef<int> Mask, unsigned EltSizeInBits, unsigned MinSubElts,
2525 unsigned MaxSubElts, unsigned &NumSubElts, unsigned &RotateAmt) {
2526 for (NumSubElts = MinSubElts; NumSubElts <= MaxSubElts; NumSubElts *= 2) {
2527 int EltRotateAmt = matchShuffleAsBitRotate(Mask, NumSubElts);
2528 if (EltRotateAmt < 0)
2529 continue;
2530 RotateAmt = EltRotateAmt * EltSizeInBits;
2531 return true;
2532 }
2533
2534 return false;
2535}
2536
2537//===----------------------------------------------------------------------===//
2538// InsertValueInst Class
2539//===----------------------------------------------------------------------===//
2540
2541void InsertValueInst::init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
2542 const Twine &Name) {
2543 assert(getNumOperands() == 2 && "NumOperands not initialized?");
2544
2545 // There's no fundamental reason why we require at least one index
2546 // (other than weirdness with &*IdxBegin being invalid; see
2547 // getelementptr's init routine for example). But there's no
2548 // present need to support it.
2549 assert(!Idxs.empty() && "InsertValueInst must have at least one index");
2550
2551 assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs) ==
2552 Val->getType() && "Inserted value must match indexed type!");
2553 Op<0>() = Agg;
2554 Op<1>() = Val;
2555
2556 Indices.append(in_start: Idxs.begin(), in_end: Idxs.end());
2557 setName(Name);
2558}
2559
2560InsertValueInst::InsertValueInst(const InsertValueInst &IVI)
2561 : Instruction(IVI.getType(), InsertValue, AllocMarker),
2562 Indices(IVI.Indices) {
2563 Op<0>() = IVI.getOperand(i_nocapture: 0);
2564 Op<1>() = IVI.getOperand(i_nocapture: 1);
2565 SubclassOptionalData = IVI.SubclassOptionalData;
2566}
2567
2568//===----------------------------------------------------------------------===//
2569// ExtractValueInst Class
2570//===----------------------------------------------------------------------===//
2571
2572void ExtractValueInst::init(ArrayRef<unsigned> Idxs, const Twine &Name) {
2573 assert(getNumOperands() == 1 && "NumOperands not initialized?");
2574
2575 // There's no fundamental reason why we require at least one index.
2576 // But there's no present need to support it.
2577 assert(!Idxs.empty() && "ExtractValueInst must have at least one index");
2578
2579 Indices.append(in_start: Idxs.begin(), in_end: Idxs.end());
2580 setName(Name);
2581}
2582
2583ExtractValueInst::ExtractValueInst(const ExtractValueInst &EVI)
2584 : UnaryInstruction(EVI.getType(), ExtractValue, EVI.getOperand(i_nocapture: 0),
2585 (BasicBlock *)nullptr),
2586 Indices(EVI.Indices) {
2587 SubclassOptionalData = EVI.SubclassOptionalData;
2588}
2589
2590// getIndexedType - Returns the type of the element that would be extracted
2591// with an extractvalue instruction with the specified parameters.
2592//
2593// A null type is returned if the indices are invalid for the specified
2594// pointer type.
2595//
2596Type *ExtractValueInst::getIndexedType(Type *Agg,
2597 ArrayRef<unsigned> Idxs) {
2598 for (unsigned Index : Idxs) {
2599 // We can't use CompositeType::indexValid(Index) here.
2600 // indexValid() always returns true for arrays because getelementptr allows
2601 // out-of-bounds indices. Since we don't allow those for extractvalue and
2602 // insertvalue we need to check array indexing manually.
2603 // Since the only other types we can index into are struct types it's just
2604 // as easy to check those manually as well.
2605 if (ArrayType *AT = dyn_cast<ArrayType>(Val: Agg)) {
2606 if (Index >= AT->getNumElements())
2607 return nullptr;
2608 Agg = AT->getElementType();
2609 } else if (StructType *ST = dyn_cast<StructType>(Val: Agg)) {
2610 if (Index >= ST->getNumElements())
2611 return nullptr;
2612 Agg = ST->getElementType(N: Index);
2613 } else {
2614 // Not a valid type to index into.
2615 return nullptr;
2616 }
2617 }
2618 return Agg;
2619}
2620
2621//===----------------------------------------------------------------------===//
2622// UnaryOperator Class
2623//===----------------------------------------------------------------------===//
2624
2625UnaryOperator::UnaryOperator(UnaryOps iType, Value *S, Type *Ty,
2626 const Twine &Name, InsertPosition InsertBefore)
2627 : UnaryInstruction(Ty, iType, S, InsertBefore) {
2628 Op<0>() = S;
2629 setName(Name);
2630 AssertOK();
2631}
2632
2633UnaryOperator *UnaryOperator::Create(UnaryOps Op, Value *S, const Twine &Name,
2634 InsertPosition InsertBefore) {
2635 switch (Op) {
2636 case UnaryOps::FNeg:
2637 return new FPUnaryOperator(Op, S, S->getType(), Name, InsertBefore);
2638 default:
2639 return new UnaryOperator(Op, S, S->getType(), Name, InsertBefore);
2640 }
2641}
2642
2643void UnaryOperator::AssertOK() {
2644 Value *LHS = getOperand(i_nocapture: 0);
2645 (void)LHS; // Silence warnings.
2646#ifndef NDEBUG
2647 switch (getOpcode()) {
2648 case FNeg:
2649 assert(getType() == LHS->getType() &&
2650 "Unary operation should return same type as operand!");
2651 assert(getType()->isFPOrFPVectorTy() &&
2652 "Tried to create a floating-point operation on a "
2653 "non-floating-point type!");
2654 break;
2655 default: llvm_unreachable("Invalid opcode provided");
2656 }
2657#endif
2658}
2659
2660//===----------------------------------------------------------------------===//
2661// BinaryOperator Class
2662//===----------------------------------------------------------------------===//
2663
2664BinaryOperator::BinaryOperator(BinaryOps iType, Value *S1, Value *S2, Type *Ty,
2665 const Twine &Name, InsertPosition InsertBefore)
2666 : Instruction(Ty, iType, AllocMarker, InsertBefore) {
2667 Op<0>() = S1;
2668 Op<1>() = S2;
2669 setName(Name);
2670 AssertOK();
2671}
2672
2673void BinaryOperator::AssertOK() {
2674 Value *LHS = getOperand(i_nocapture: 0), *RHS = getOperand(i_nocapture: 1);
2675 (void)LHS; (void)RHS; // Silence warnings.
2676 assert(LHS->getType() == RHS->getType() &&
2677 "Binary operator operand types must match!");
2678#ifndef NDEBUG
2679 switch (getOpcode()) {
2680 case Add: case Sub:
2681 case Mul:
2682 assert(getType() == LHS->getType() &&
2683 "Arithmetic operation should return same type as operands!");
2684 assert(getType()->isIntOrIntVectorTy() &&
2685 "Tried to create an integer operation on a non-integer type!");
2686 break;
2687 case FAdd: case FSub:
2688 case FMul:
2689 assert(getType() == LHS->getType() &&
2690 "Arithmetic operation should return same type as operands!");
2691 assert(getType()->isFPOrFPVectorTy() &&
2692 "Tried to create a floating-point operation on a "
2693 "non-floating-point type!");
2694 break;
2695 case UDiv:
2696 case SDiv:
2697 assert(getType() == LHS->getType() &&
2698 "Arithmetic operation should return same type as operands!");
2699 assert(getType()->isIntOrIntVectorTy() &&
2700 "Incorrect operand type (not integer) for S/UDIV");
2701 break;
2702 case FDiv:
2703 assert(getType() == LHS->getType() &&
2704 "Arithmetic operation should return same type as operands!");
2705 assert(getType()->isFPOrFPVectorTy() &&
2706 "Incorrect operand type (not floating point) for FDIV");
2707 break;
2708 case URem:
2709 case SRem:
2710 assert(getType() == LHS->getType() &&
2711 "Arithmetic operation should return same type as operands!");
2712 assert(getType()->isIntOrIntVectorTy() &&
2713 "Incorrect operand type (not integer) for S/UREM");
2714 break;
2715 case FRem:
2716 assert(getType() == LHS->getType() &&
2717 "Arithmetic operation should return same type as operands!");
2718 assert(getType()->isFPOrFPVectorTy() &&
2719 "Incorrect operand type (not floating point) for FREM");
2720 break;
2721 case Shl:
2722 case LShr:
2723 case AShr:
2724 assert(getType() == LHS->getType() &&
2725 "Shift operation should return same type as operands!");
2726 assert(getType()->isIntOrIntVectorTy() &&
2727 "Tried to create a shift operation on a non-integral type!");
2728 break;
2729 case And: case Or:
2730 case Xor:
2731 assert(getType() == LHS->getType() &&
2732 "Logical operation should return same type as operands!");
2733 assert(getType()->isIntOrIntVectorTy() &&
2734 "Tried to create a logical operation on a non-integral type!");
2735 break;
2736 default: llvm_unreachable("Invalid opcode provided");
2737 }
2738#endif
2739}
2740
2741BinaryOperator *BinaryOperator::Create(BinaryOps Op, Value *S1, Value *S2,
2742 const Twine &Name,
2743 InsertPosition InsertBefore) {
2744 assert(S1->getType() == S2->getType() &&
2745 "Cannot create binary operator with two operands of differing type!");
2746 switch (Op) {
2747 case BinaryOps::FAdd:
2748 case BinaryOps::FSub:
2749 case BinaryOps::FMul:
2750 case BinaryOps::FDiv:
2751 case BinaryOps::FRem:
2752 return new FPBinaryOperator(Op, S1, S2, S1->getType(), Name, InsertBefore);
2753 default:
2754 return new BinaryOperator(Op, S1, S2, S1->getType(), Name, InsertBefore);
2755 }
2756}
2757
2758BinaryOperator *BinaryOperator::CreateNeg(Value *Op, const Twine &Name,
2759 InsertPosition InsertBefore) {
2760 Value *Zero = ConstantInt::get(Ty: Op->getType(), V: 0);
2761 return new BinaryOperator(Instruction::Sub, Zero, Op, Op->getType(), Name,
2762 InsertBefore);
2763}
2764
2765BinaryOperator *BinaryOperator::CreateNSWNeg(Value *Op, const Twine &Name,
2766 InsertPosition InsertBefore) {
2767 Value *Zero = ConstantInt::get(Ty: Op->getType(), V: 0);
2768 return BinaryOperator::CreateNSWSub(V1: Zero, V2: Op, Name, InsertBefore);
2769}
2770
2771BinaryOperator *BinaryOperator::CreateNot(Value *Op, const Twine &Name,
2772 InsertPosition InsertBefore) {
2773 Constant *C = Constant::getAllOnesValue(Ty: Op->getType());
2774 return new BinaryOperator(Instruction::Xor, Op, C,
2775 Op->getType(), Name, InsertBefore);
2776}
2777
2778// Exchange the two operands to this instruction. This instruction is safe to
2779// use on any binary instruction and does not modify the semantics of the
2780// instruction.
2781bool BinaryOperator::swapOperands() {
2782 if (!isCommutative())
2783 return true; // Can't commute operands
2784 Op<0>().swap(RHS&: Op<1>());
2785 return false;
2786}
2787
2788//===----------------------------------------------------------------------===//
2789// FPMathOperator Class
2790//===----------------------------------------------------------------------===//
2791
2792float FPMathOperator::getFPAccuracy() const {
2793 const MDNode *MD =
2794 cast<Instruction>(Val: this)->getMetadata(KindID: LLVMContext::MD_fpmath);
2795 if (!MD)
2796 return 0.0;
2797 ConstantFP *Accuracy = mdconst::extract<ConstantFP>(MD: MD->getOperand(I: 0));
2798 return Accuracy->getValueAPF().convertToFloat();
2799}
2800
2801//===----------------------------------------------------------------------===//
2802// CastInst Class
2803//===----------------------------------------------------------------------===//
2804
2805// Just determine if this cast only deals with integral->integral conversion.
2806bool CastInst::isIntegerCast() const {
2807 switch (getOpcode()) {
2808 default: return false;
2809 case Instruction::ZExt:
2810 case Instruction::SExt:
2811 case Instruction::Trunc:
2812 return true;
2813 case Instruction::BitCast:
2814 return getOperand(i_nocapture: 0)->getType()->isIntegerTy() &&
2815 getType()->isIntegerTy();
2816 }
2817}
2818
2819/// This function determines if the CastInst does not require any bits to be
2820/// changed in order to effect the cast. Essentially, it identifies cases where
2821/// no code gen is necessary for the cast, hence the name no-op cast. For
2822/// example, the following are all no-op casts:
2823/// # bitcast i32* %x to i8*
2824/// # bitcast <2 x i32> %x to <4 x i16>
2825/// # ptrtoint i32* %x to i32 ; on 32-bit plaforms only
2826/// Determine if the described cast is a no-op.
2827bool CastInst::isNoopCast(Instruction::CastOps Opcode,
2828 Type *SrcTy,
2829 Type *DestTy,
2830 const DataLayout &DL) {
2831 assert(castIsValid(Opcode, SrcTy, DestTy) && "method precondition");
2832 switch (Opcode) {
2833 default: llvm_unreachable("Invalid CastOp");
2834 case Instruction::Trunc:
2835 case Instruction::ZExt:
2836 case Instruction::SExt:
2837 case Instruction::FPTrunc:
2838 case Instruction::FPExt:
2839 case Instruction::UIToFP:
2840 case Instruction::SIToFP:
2841 case Instruction::FPToUI:
2842 case Instruction::FPToSI:
2843 case Instruction::AddrSpaceCast:
2844 // TODO: Target informations may give a more accurate answer here.
2845 return false;
2846 case Instruction::BitCast:
2847 return true; // BitCast never modifies bits.
2848 case Instruction::PtrToAddr:
2849 case Instruction::PtrToInt:
2850 return DL.getIntPtrType(SrcTy)->getScalarSizeInBits() ==
2851 DestTy->getScalarSizeInBits();
2852 case Instruction::IntToPtr:
2853 return DL.getIntPtrType(DestTy)->getScalarSizeInBits() ==
2854 SrcTy->getScalarSizeInBits();
2855 }
2856}
2857
2858bool CastInst::isNoopCast(const DataLayout &DL) const {
2859 return isNoopCast(Opcode: getOpcode(), SrcTy: getOperand(i_nocapture: 0)->getType(), DestTy: getType(), DL);
2860}
2861
2862/// This function determines if a pair of casts can be eliminated and what
2863/// opcode should be used in the elimination. This assumes that there are two
2864/// instructions like this:
2865/// * %F = firstOpcode SrcTy %x to MidTy
2866/// * %S = secondOpcode MidTy %F to DstTy
2867/// The function returns a resultOpcode so these two casts can be replaced with:
2868/// * %Replacement = resultOpcode %SrcTy %x to DstTy
2869/// If no such cast is permitted, the function returns 0.
2870unsigned CastInst::isEliminableCastPair(Instruction::CastOps firstOp,
2871 Instruction::CastOps secondOp,
2872 Type *SrcTy, Type *MidTy, Type *DstTy,
2873 const DataLayout *DL) {
2874 // Define the 144 possibilities for these two cast instructions. The values
2875 // in this matrix determine what to do in a given situation and select the
2876 // case in the switch below. The rows correspond to firstOp, the columns
2877 // correspond to secondOp. In looking at the table below, keep in mind
2878 // the following cast properties:
2879 //
2880 // Size Compare Source Destination
2881 // Operator Src ? Size Type Sign Type Sign
2882 // -------- ------------ ------------------- ---------------------
2883 // TRUNC > Integer Any Integral Any
2884 // ZEXT < Integral Unsigned Integer Any
2885 // SEXT < Integral Signed Integer Any
2886 // FPTOUI n/a FloatPt n/a Integral Unsigned
2887 // FPTOSI n/a FloatPt n/a Integral Signed
2888 // UITOFP n/a Integral Unsigned FloatPt n/a
2889 // SITOFP n/a Integral Signed FloatPt n/a
2890 // FPTRUNC > FloatPt n/a FloatPt n/a
2891 // FPEXT < FloatPt n/a FloatPt n/a
2892 // PTRTOINT n/a Pointer n/a Integral Unsigned
2893 // PTRTOADDR n/a Pointer n/a Integral Unsigned
2894 // INTTOPTR n/a Integral Unsigned Pointer n/a
2895 // BITCAST = FirstClass n/a FirstClass n/a
2896 // ADDRSPCST n/a Pointer n/a Pointer n/a
2897 //
2898 // NOTE: some transforms are safe, but we consider them to be non-profitable.
2899 // For example, we could merge "fptoui double to i32" + "zext i32 to i64",
2900 // into "fptoui double to i64", but this loses information about the range
2901 // of the produced value (we no longer know the top-part is all zeros).
2902 // Further this conversion is often much more expensive for typical hardware,
2903 // and causes issues when building libgcc. We disallow fptosi+sext for the
2904 // same reason.
2905 const unsigned numCastOps =
2906 Instruction::CastOpsEnd - Instruction::CastOpsBegin;
2907 // clang-format off
2908 static const uint8_t CastResults[numCastOps][numCastOps] = {
2909 // T F F U S F F P P I B A -+
2910 // R Z S P P I I T P 2 2 N T S |
2911 // U E E 2 2 2 2 R E I A T C C +- secondOp
2912 // N X X U S F F N X N D 2 V V |
2913 // C T T I I P P C T T R P T T -+
2914 { 1, 0, 0,99,99, 0, 0,99,99,99,99, 0, 3, 0}, // Trunc -+
2915 { 8, 1, 9,99,99, 2,17,99,99,99,99, 2, 3, 0}, // ZExt |
2916 { 8, 0, 1,99,99, 0, 2,99,99,99,99, 0, 3, 0}, // SExt |
2917 { 0, 0, 0,99,99, 0, 0,99,99,99,99, 0, 3, 0}, // FPToUI |
2918 { 0, 0, 0,99,99, 0, 0,99,99,99,99, 0, 3, 0}, // FPToSI |
2919 { 99,99,99, 0, 0,99,99, 0, 0,99,99,99, 4, 0}, // UIToFP +- firstOp
2920 { 99,99,99, 0, 0,99,99, 0, 0,99,99,99, 4, 0}, // SIToFP |
2921 { 99,99,99, 0, 0,99,99, 0, 0,99,99,99, 4, 0}, // FPTrunc |
2922 { 99,99,99, 2, 2,99,99, 8, 2,99,99,99, 4, 0}, // FPExt |
2923 { 1, 0, 0,99,99, 0, 0,99,99,99,99, 7, 3, 0}, // PtrToInt |
2924 { 0, 0, 0,99,99, 0, 0,99,99,99,99, 0, 3, 0}, // PtrToAddr |
2925 { 99,99,99,99,99,99,99,99,99,11,11,99,15, 0}, // IntToPtr |
2926 { 5, 5, 5, 0, 0, 5, 5, 0, 0,16,16, 5, 1,14}, // BitCast |
2927 { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,13,12}, // AddrSpaceCast -+
2928 };
2929 // clang-format on
2930
2931 // TODO: This logic could be encoded into the table above and handled in the
2932 // switch below.
2933 // If either of the casts are a bitcast from scalar to vector, disallow the
2934 // merging. However, any pair of bitcasts are allowed.
2935 bool IsFirstBitcast = (firstOp == Instruction::BitCast);
2936 bool IsSecondBitcast = (secondOp == Instruction::BitCast);
2937 bool AreBothBitcasts = IsFirstBitcast && IsSecondBitcast;
2938
2939 // Check if any of the casts convert scalars <-> vectors.
2940 if ((IsFirstBitcast && isa<VectorType>(Val: SrcTy) != isa<VectorType>(Val: MidTy)) ||
2941 (IsSecondBitcast && isa<VectorType>(Val: MidTy) != isa<VectorType>(Val: DstTy)))
2942 if (!AreBothBitcasts)
2943 return 0;
2944
2945 int ElimCase = CastResults[firstOp-Instruction::CastOpsBegin]
2946 [secondOp-Instruction::CastOpsBegin];
2947 switch (ElimCase) {
2948 case 0:
2949 // Categorically disallowed.
2950 return 0;
2951 case 1:
2952 // Allowed, use first cast's opcode.
2953 return firstOp;
2954 case 2:
2955 // Allowed, use second cast's opcode.
2956 return secondOp;
2957 case 3:
2958 // No-op cast in second op implies firstOp as long as the DestTy
2959 // is integer and we are not converting between a vector and a
2960 // non-vector type.
2961 if (!SrcTy->isVectorTy() && DstTy->isIntegerTy())
2962 return firstOp;
2963 return 0;
2964 case 4:
2965 // No-op cast in second op implies firstOp as long as the DestTy
2966 // matches MidTy.
2967 if (DstTy == MidTy)
2968 return firstOp;
2969 return 0;
2970 case 5:
2971 // No-op cast in first op implies secondOp as long as the SrcTy
2972 // is an integer.
2973 if (SrcTy->isIntegerTy())
2974 return secondOp;
2975 return 0;
2976 case 7: {
2977 // Disable inttoptr/ptrtoint optimization if enabled.
2978 if (DisableI2pP2iOpt)
2979 return 0;
2980
2981 // Cannot simplify if address spaces are different!
2982 if (SrcTy != DstTy)
2983 return 0;
2984
2985 // Cannot simplify if the intermediate integer size is smaller than the
2986 // pointer size.
2987 unsigned MidSize = MidTy->getScalarSizeInBits();
2988 if (!DL || MidSize < DL->getPointerTypeSizeInBits(SrcTy))
2989 return 0;
2990
2991 return Instruction::BitCast;
2992 }
2993 case 8: {
2994 // ext, trunc -> bitcast, if the SrcTy and DstTy are the same
2995 // ext, trunc -> ext, if sizeof(SrcTy) < sizeof(DstTy)
2996 // ext, trunc -> trunc, if sizeof(SrcTy) > sizeof(DstTy)
2997 unsigned SrcSize = SrcTy->getScalarSizeInBits();
2998 unsigned DstSize = DstTy->getScalarSizeInBits();
2999 if (SrcTy == DstTy)
3000 return Instruction::BitCast;
3001 if (SrcSize < DstSize)
3002 return firstOp;
3003 if (SrcSize > DstSize)
3004 return secondOp;
3005 return 0;
3006 }
3007 case 9:
3008 // zext, sext -> zext, because sext can't sign extend after zext
3009 return Instruction::ZExt;
3010 case 11: {
3011 // inttoptr, ptrtoint/ptrtoaddr -> integer cast
3012 if (!DL)
3013 return 0;
3014 unsigned MidSize = secondOp == Instruction::PtrToAddr
3015 ? DL->getAddressSizeInBits(Ty: MidTy)
3016 : DL->getPointerTypeSizeInBits(MidTy);
3017 unsigned SrcSize = SrcTy->getScalarSizeInBits();
3018 unsigned DstSize = DstTy->getScalarSizeInBits();
3019 // If the middle size is smaller than both source and destination,
3020 // an additional masking operation would be required.
3021 if (MidSize < SrcSize && MidSize < DstSize)
3022 return 0;
3023 if (DstSize < SrcSize)
3024 return Instruction::Trunc;
3025 if (DstSize > SrcSize)
3026 return Instruction::ZExt;
3027 return Instruction::BitCast;
3028 }
3029 case 12:
3030 // addrspacecast, addrspacecast -> bitcast, if SrcAS == DstAS
3031 // addrspacecast, addrspacecast -> addrspacecast, if SrcAS != DstAS
3032 if (SrcTy->getPointerAddressSpace() != DstTy->getPointerAddressSpace())
3033 return Instruction::AddrSpaceCast;
3034 return Instruction::BitCast;
3035 case 13:
3036 // FIXME: this state can be merged with (1), but the following assert
3037 // is useful to check the correcteness of the sequence due to semantic
3038 // change of bitcast.
3039 // addrspacecast can only fold through a bitcast if the result remains a
3040 // pointer. A pointer-to-byte bitcast must stay as a separate bitcast.
3041 if (!DstTy->isPtrOrPtrVectorTy())
3042 return 0;
3043 assert(
3044 SrcTy->isPtrOrPtrVectorTy() &&
3045 MidTy->isPtrOrPtrVectorTy() &&
3046 DstTy->isPtrOrPtrVectorTy() &&
3047 SrcTy->getPointerAddressSpace() != MidTy->getPointerAddressSpace() &&
3048 MidTy->getPointerAddressSpace() == DstTy->getPointerAddressSpace() &&
3049 "Illegal addrspacecast, bitcast sequence!");
3050 // Allowed, use first cast's opcode
3051 return firstOp;
3052 case 14:
3053 // bitcast, addrspacecast -> addrspacecast
3054 // addrspacecast can only fold through a bitcast if the source was already
3055 // a pointer. A byte-to-pointer bitcast must stay as a separate bitcast.
3056 if (!SrcTy->isPtrOrPtrVectorTy())
3057 return 0;
3058 return Instruction::AddrSpaceCast;
3059 case 15:
3060 // FIXME: this state can be merged with (1), but the following assert
3061 // is useful to check the correcteness of the sequence due to semantic
3062 // change of bitcast.
3063 assert(
3064 SrcTy->isIntOrIntVectorTy() &&
3065 MidTy->isPtrOrPtrVectorTy() &&
3066 DstTy->isPtrOrPtrVectorTy() &&
3067 MidTy->getPointerAddressSpace() == DstTy->getPointerAddressSpace() &&
3068 "Illegal inttoptr, bitcast sequence!");
3069 // Allowed, use first cast's opcode
3070 return firstOp;
3071 case 16:
3072 // FIXME: this state can be merged with (2), but the following assert
3073 // is useful to check the correcteness of the sequence due to semantic
3074 // change of bitcast.
3075 assert(
3076 SrcTy->isPtrOrPtrVectorTy() &&
3077 MidTy->isPtrOrPtrVectorTy() &&
3078 DstTy->isIntOrIntVectorTy() &&
3079 SrcTy->getPointerAddressSpace() == MidTy->getPointerAddressSpace() &&
3080 "Illegal bitcast, ptrtoint sequence!");
3081 // Allowed, use second cast's opcode
3082 return secondOp;
3083 case 17:
3084 // (sitofp (zext x)) -> (uitofp x)
3085 return Instruction::UIToFP;
3086 case 99:
3087 // Cast combination can't happen (error in input). This is for all cases
3088 // where the MidTy is not the same for the two cast instructions.
3089 llvm_unreachable("Invalid Cast Combination");
3090 default:
3091 llvm_unreachable("Error in CastResults table!!!");
3092 }
3093}
3094
3095CastInst *CastInst::Create(Instruction::CastOps op, Value *S, Type *Ty,
3096 const Twine &Name, InsertPosition InsertBefore) {
3097 assert(castIsValid(op, S, Ty) && "Invalid cast!");
3098 // Construct and return the appropriate CastInst subclass
3099 switch (op) {
3100 case Trunc: return new TruncInst (S, Ty, Name, InsertBefore);
3101 case ZExt: return new ZExtInst (S, Ty, Name, InsertBefore);
3102 case SExt: return new SExtInst (S, Ty, Name, InsertBefore);
3103 case FPTrunc: return new FPTruncInst (S, Ty, Name, InsertBefore);
3104 case FPExt: return new FPExtInst (S, Ty, Name, InsertBefore);
3105 case UIToFP: return new UIToFPInst (S, Ty, Name, InsertBefore);
3106 case SIToFP: return new SIToFPInst (S, Ty, Name, InsertBefore);
3107 case FPToUI: return new FPToUIInst (S, Ty, Name, InsertBefore);
3108 case FPToSI: return new FPToSIInst (S, Ty, Name, InsertBefore);
3109 case PtrToAddr: return new PtrToAddrInst (S, Ty, Name, InsertBefore);
3110 case PtrToInt: return new PtrToIntInst (S, Ty, Name, InsertBefore);
3111 case IntToPtr: return new IntToPtrInst (S, Ty, Name, InsertBefore);
3112 case BitCast:
3113 return new BitCastInst(S, Ty, Name, InsertBefore);
3114 case AddrSpaceCast:
3115 return new AddrSpaceCastInst(S, Ty, Name, InsertBefore);
3116 default:
3117 llvm_unreachable("Invalid opcode provided");
3118 }
3119}
3120
3121CastInst *CastInst::CreateZExtOrBitCast(Value *S, Type *Ty, const Twine &Name,
3122 InsertPosition InsertBefore) {
3123 if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
3124 return Create(op: Instruction::BitCast, S, Ty, Name, InsertBefore);
3125 return Create(op: Instruction::ZExt, S, Ty, Name, InsertBefore);
3126}
3127
3128CastInst *CastInst::CreateSExtOrBitCast(Value *S, Type *Ty, const Twine &Name,
3129 InsertPosition InsertBefore) {
3130 if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
3131 return Create(op: Instruction::BitCast, S, Ty, Name, InsertBefore);
3132 return Create(op: Instruction::SExt, S, Ty, Name, InsertBefore);
3133}
3134
3135CastInst *CastInst::CreateTruncOrBitCast(Value *S, Type *Ty, const Twine &Name,
3136 InsertPosition InsertBefore) {
3137 if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
3138 return Create(op: Instruction::BitCast, S, Ty, Name, InsertBefore);
3139 return Create(op: Instruction::Trunc, S, Ty, Name, InsertBefore);
3140}
3141
3142/// Create a BitCast or a PtrToInt cast instruction
3143CastInst *CastInst::CreatePointerCast(Value *S, Type *Ty, const Twine &Name,
3144 InsertPosition InsertBefore) {
3145 assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
3146 assert((Ty->isIntOrIntVectorTy() || Ty->isPtrOrPtrVectorTy()) &&
3147 "Invalid cast");
3148 assert(Ty->isVectorTy() == S->getType()->isVectorTy() && "Invalid cast");
3149 assert((!Ty->isVectorTy() ||
3150 cast<VectorType>(Ty)->getElementCount() ==
3151 cast<VectorType>(S->getType())->getElementCount()) &&
3152 "Invalid cast");
3153
3154 if (Ty->isIntOrIntVectorTy())
3155 return Create(op: Instruction::PtrToInt, S, Ty, Name, InsertBefore);
3156
3157 return CreatePointerBitCastOrAddrSpaceCast(S, Ty, Name, InsertBefore);
3158}
3159
3160CastInst *CastInst::CreatePointerBitCastOrAddrSpaceCast(
3161 Value *S, Type *Ty, const Twine &Name, InsertPosition InsertBefore) {
3162 assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
3163 assert(Ty->isPtrOrPtrVectorTy() && "Invalid cast");
3164
3165 if (S->getType()->getPointerAddressSpace() != Ty->getPointerAddressSpace())
3166 return Create(op: Instruction::AddrSpaceCast, S, Ty, Name, InsertBefore);
3167
3168 return Create(op: Instruction::BitCast, S, Ty, Name, InsertBefore);
3169}
3170
3171CastInst *CastInst::CreateBitOrPointerCast(Value *S, Type *Ty,
3172 const Twine &Name,
3173 InsertPosition InsertBefore) {
3174 if (S->getType()->isPointerTy() && Ty->isIntegerTy())
3175 return Create(op: Instruction::PtrToInt, S, Ty, Name, InsertBefore);
3176 if (S->getType()->isIntegerTy() && Ty->isPointerTy())
3177 return Create(op: Instruction::IntToPtr, S, Ty, Name, InsertBefore);
3178
3179 return Create(op: Instruction::BitCast, S, Ty, Name, InsertBefore);
3180}
3181
3182CastInst *CastInst::CreateIntegerCast(Value *C, Type *Ty, bool isSigned,
3183 const Twine &Name,
3184 InsertPosition InsertBefore) {
3185 assert(C->getType()->isIntOrIntVectorTy() && Ty->isIntOrIntVectorTy() &&
3186 "Invalid integer cast");
3187 unsigned SrcBits = C->getType()->getScalarSizeInBits();
3188 unsigned DstBits = Ty->getScalarSizeInBits();
3189 Instruction::CastOps opcode =
3190 (SrcBits == DstBits ? Instruction::BitCast :
3191 (SrcBits > DstBits ? Instruction::Trunc :
3192 (isSigned ? Instruction::SExt : Instruction::ZExt)));
3193 return Create(op: opcode, S: C, Ty, Name, InsertBefore);
3194}
3195
3196CastInst *CastInst::CreateFPCast(Value *C, Type *Ty, const Twine &Name,
3197 InsertPosition InsertBefore) {
3198 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
3199 "Invalid cast");
3200 unsigned SrcBits = C->getType()->getScalarSizeInBits();
3201 unsigned DstBits = Ty->getScalarSizeInBits();
3202 assert((C->getType() == Ty || SrcBits != DstBits) && "Invalid cast");
3203 Instruction::CastOps opcode =
3204 (SrcBits == DstBits ? Instruction::BitCast :
3205 (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt));
3206 return Create(op: opcode, S: C, Ty, Name, InsertBefore);
3207}
3208
3209bool CastInst::isBitCastable(Type *SrcTy, Type *DestTy) {
3210 if (!SrcTy->isFirstClassType() || !DestTy->isFirstClassType())
3211 return false;
3212
3213 if (SrcTy == DestTy)
3214 return true;
3215
3216 if (VectorType *SrcVecTy = dyn_cast<VectorType>(Val: SrcTy)) {
3217 if (VectorType *DestVecTy = dyn_cast<VectorType>(Val: DestTy)) {
3218 if (SrcVecTy->getElementCount() == DestVecTy->getElementCount()) {
3219 // An element by element cast. Valid if casting the elements is valid.
3220 SrcTy = SrcVecTy->getElementType();
3221 DestTy = DestVecTy->getElementType();
3222 }
3223 }
3224 }
3225
3226 if (PointerType *DestPtrTy = dyn_cast<PointerType>(Val: DestTy)) {
3227 if (PointerType *SrcPtrTy = dyn_cast<PointerType>(Val: SrcTy)) {
3228 return SrcPtrTy->getAddressSpace() == DestPtrTy->getAddressSpace();
3229 }
3230 }
3231
3232 TypeSize SrcBits = SrcTy->getPrimitiveSizeInBits(); // 0 for ptr
3233 TypeSize DestBits = DestTy->getPrimitiveSizeInBits(); // 0 for ptr
3234
3235 // Could still have vectors of pointers if the number of elements doesn't
3236 // match
3237 if (SrcBits.getKnownMinValue() == 0 || DestBits.getKnownMinValue() == 0)
3238 return false;
3239
3240 if (SrcBits != DestBits)
3241 return false;
3242
3243 return true;
3244}
3245
3246bool CastInst::isBitOrNoopPointerCastable(Type *SrcTy, Type *DestTy,
3247 const DataLayout &DL) {
3248 // ptrtoint and inttoptr are not allowed on non-integral pointers
3249 if (auto *PtrTy = dyn_cast<PointerType>(Val: SrcTy))
3250 if (auto *IntTy = dyn_cast<IntegerType>(Val: DestTy))
3251 return (IntTy->getBitWidth() == DL.getPointerTypeSizeInBits(PtrTy) &&
3252 !DL.isNonIntegralPointerType(PT: PtrTy));
3253 if (auto *PtrTy = dyn_cast<PointerType>(Val: DestTy))
3254 if (auto *IntTy = dyn_cast<IntegerType>(Val: SrcTy))
3255 return (IntTy->getBitWidth() == DL.getPointerTypeSizeInBits(PtrTy) &&
3256 !DL.isNonIntegralPointerType(PT: PtrTy));
3257
3258 return isBitCastable(SrcTy, DestTy);
3259}
3260
3261// Provide a way to get a "cast" where the cast opcode is inferred from the
3262// types and size of the operand. This, basically, is a parallel of the
3263// logic in the castIsValid function below. This axiom should hold:
3264// castIsValid( getCastOpcode(Val, Ty), Val, Ty)
3265// should not assert in castIsValid. In other words, this produces a "correct"
3266// casting opcode for the arguments passed to it.
3267Instruction::CastOps
3268CastInst::getCastOpcode(
3269 const Value *Src, bool SrcIsSigned, Type *DestTy, bool DestIsSigned) {
3270 Type *SrcTy = Src->getType();
3271
3272 assert(SrcTy->isFirstClassType() && DestTy->isFirstClassType() &&
3273 "Only first class types are castable!");
3274
3275 if (SrcTy == DestTy)
3276 return BitCast;
3277
3278 // FIXME: Check address space sizes here
3279 if (VectorType *SrcVecTy = dyn_cast<VectorType>(Val: SrcTy))
3280 if (VectorType *DestVecTy = dyn_cast<VectorType>(Val: DestTy))
3281 if (SrcVecTy->getElementCount() == DestVecTy->getElementCount()) {
3282 // An element by element cast. Find the appropriate opcode based on the
3283 // element types.
3284 SrcTy = SrcVecTy->getElementType();
3285 DestTy = DestVecTy->getElementType();
3286 }
3287
3288 // Get the bit sizes, we'll need these
3289 // FIXME: This doesn't work for scalable vector types with different element
3290 // counts that don't call getElementType above.
3291 unsigned SrcBits =
3292 SrcTy->getPrimitiveSizeInBits().getFixedValue(); // 0 for ptr
3293 unsigned DestBits =
3294 DestTy->getPrimitiveSizeInBits().getFixedValue(); // 0 for ptr
3295
3296 // Run through the possibilities ...
3297 if (DestTy->isByteTy()) { // Casting to byte
3298 if (SrcTy->isIntegerTy()) { // Casting from integral
3299 assert(DestBits == SrcBits && "Illegal cast from integer to byte type");
3300 return BitCast;
3301 } else if (SrcTy->isPointerTy()) { // Casting from pointer
3302 assert(DestBits == SrcBits && "Illegal cast from pointer to byte type");
3303 return BitCast;
3304 }
3305 llvm_unreachable("Illegal cast to byte type");
3306 } else if (DestTy->isIntegerTy()) { // Casting to integral
3307 if (SrcTy->isIntegerTy()) { // Casting from integral
3308 if (DestBits < SrcBits)
3309 return Trunc; // int -> smaller int
3310 else if (DestBits > SrcBits) { // its an extension
3311 if (SrcIsSigned)
3312 return SExt; // signed -> SEXT
3313 else
3314 return ZExt; // unsigned -> ZEXT
3315 } else {
3316 return BitCast; // Same size, No-op cast
3317 }
3318 } else if (SrcTy->isFloatingPointTy()) { // Casting from floating pt
3319 if (DestIsSigned)
3320 return FPToSI; // FP -> sint
3321 else
3322 return FPToUI; // FP -> uint
3323 } else if (SrcTy->isVectorTy()) {
3324 assert(DestBits == SrcBits &&
3325 "Casting vector to integer of different width");
3326 return BitCast; // Same size, no-op cast
3327 } else {
3328 assert(SrcTy->isPointerTy() &&
3329 "Casting from a value that is not first-class type");
3330 return PtrToInt; // ptr -> int
3331 }
3332 } else if (DestTy->isFloatingPointTy()) { // Casting to floating pt
3333 if (SrcTy->isIntegerTy()) { // Casting from integral
3334 if (SrcIsSigned)
3335 return SIToFP; // sint -> FP
3336 else
3337 return UIToFP; // uint -> FP
3338 } else if (SrcTy->isFloatingPointTy()) { // Casting from floating pt
3339 if (DestBits < SrcBits) {
3340 return FPTrunc; // FP -> smaller FP
3341 } else if (DestBits > SrcBits) {
3342 return FPExt; // FP -> larger FP
3343 } else {
3344 return BitCast; // same size, no-op cast
3345 }
3346 } else if (SrcTy->isVectorTy()) {
3347 assert(DestBits == SrcBits &&
3348 "Casting vector to floating point of different width");
3349 return BitCast; // same size, no-op cast
3350 }
3351 llvm_unreachable("Casting pointer or non-first class to float");
3352 } else if (DestTy->isVectorTy()) {
3353 assert(DestBits == SrcBits &&
3354 "Illegal cast to vector (wrong type or size)");
3355 return BitCast;
3356 } else if (DestTy->isPointerTy()) {
3357 if (SrcTy->isPointerTy()) {
3358 if (DestTy->getPointerAddressSpace() != SrcTy->getPointerAddressSpace())
3359 return AddrSpaceCast;
3360 return BitCast; // ptr -> ptr
3361 } else if (SrcTy->isIntegerTy()) {
3362 return IntToPtr; // int -> ptr
3363 }
3364 llvm_unreachable("Casting pointer to other than pointer or int");
3365 }
3366 llvm_unreachable("Casting to type that is not first-class");
3367}
3368
3369//===----------------------------------------------------------------------===//
3370// CastInst SubClass Constructors
3371//===----------------------------------------------------------------------===//
3372
3373/// Check that the construction parameters for a CastInst are correct. This
3374/// could be broken out into the separate constructors but it is useful to have
3375/// it in one place and to eliminate the redundant code for getting the sizes
3376/// of the types involved.
3377bool
3378CastInst::castIsValid(Instruction::CastOps op, Type *SrcTy, Type *DstTy) {
3379 if (!SrcTy->isFirstClassType() || !DstTy->isFirstClassType() ||
3380 SrcTy->isAggregateType() || DstTy->isAggregateType())
3381 return false;
3382
3383 // Get the size of the types in bits, and whether we are dealing
3384 // with vector types, we'll need this later.
3385 bool SrcIsVec = isa<VectorType>(Val: SrcTy);
3386 bool DstIsVec = isa<VectorType>(Val: DstTy);
3387 unsigned SrcScalarBitSize = SrcTy->getScalarSizeInBits();
3388 unsigned DstScalarBitSize = DstTy->getScalarSizeInBits();
3389
3390 // If these are vector types, get the lengths of the vectors (using zero for
3391 // scalar types means that checking that vector lengths match also checks that
3392 // scalars are not being converted to vectors or vectors to scalars).
3393 ElementCount SrcEC = SrcIsVec ? cast<VectorType>(Val: SrcTy)->getElementCount()
3394 : ElementCount::getFixed(MinVal: 0);
3395 ElementCount DstEC = DstIsVec ? cast<VectorType>(Val: DstTy)->getElementCount()
3396 : ElementCount::getFixed(MinVal: 0);
3397
3398 // Switch on the opcode provided
3399 switch (op) {
3400 default: return false; // This is an input error
3401 case Instruction::Trunc:
3402 return SrcTy->isIntOrIntVectorTy() && DstTy->isIntOrIntVectorTy() &&
3403 SrcEC == DstEC && SrcScalarBitSize > DstScalarBitSize;
3404 case Instruction::ZExt:
3405 return SrcTy->isIntOrIntVectorTy() && DstTy->isIntOrIntVectorTy() &&
3406 SrcEC == DstEC && SrcScalarBitSize < DstScalarBitSize;
3407 case Instruction::SExt:
3408 return SrcTy->isIntOrIntVectorTy() && DstTy->isIntOrIntVectorTy() &&
3409 SrcEC == DstEC && SrcScalarBitSize < DstScalarBitSize;
3410 case Instruction::FPTrunc:
3411 return SrcTy->isFPOrFPVectorTy() && DstTy->isFPOrFPVectorTy() &&
3412 SrcEC == DstEC && SrcScalarBitSize > DstScalarBitSize;
3413 case Instruction::FPExt:
3414 return SrcTy->isFPOrFPVectorTy() && DstTy->isFPOrFPVectorTy() &&
3415 SrcEC == DstEC && SrcScalarBitSize < DstScalarBitSize;
3416 case Instruction::UIToFP:
3417 case Instruction::SIToFP:
3418 return SrcTy->isIntOrIntVectorTy() && DstTy->isFPOrFPVectorTy() &&
3419 SrcEC == DstEC;
3420 case Instruction::FPToUI:
3421 case Instruction::FPToSI:
3422 return SrcTy->isFPOrFPVectorTy() && DstTy->isIntOrIntVectorTy() &&
3423 SrcEC == DstEC;
3424 case Instruction::PtrToAddr:
3425 case Instruction::PtrToInt:
3426 if (SrcEC != DstEC)
3427 return false;
3428 return SrcTy->isPtrOrPtrVectorTy() && DstTy->isIntOrIntVectorTy();
3429 case Instruction::IntToPtr:
3430 if (SrcEC != DstEC)
3431 return false;
3432 return SrcTy->isIntOrIntVectorTy() && DstTy->isPtrOrPtrVectorTy();
3433 case Instruction::BitCast: {
3434 PointerType *SrcPtrTy = dyn_cast<PointerType>(Val: SrcTy->getScalarType());
3435 PointerType *DstPtrTy = dyn_cast<PointerType>(Val: DstTy->getScalarType());
3436
3437 // BitCast implies a no-op cast of type only. No bits change.
3438 // However, you can't cast pointers to anything but pointers/bytes.
3439 if ((SrcPtrTy && DstTy->isByteOrByteVectorTy()) ||
3440 (SrcTy->isByteOrByteVectorTy() && DstPtrTy))
3441 return true;
3442 if (!SrcPtrTy != !DstPtrTy)
3443 return false;
3444
3445 // For non-pointer cases, the cast is okay if the source and destination bit
3446 // widths are identical.
3447 if (!SrcPtrTy)
3448 return SrcTy->getPrimitiveSizeInBits() == DstTy->getPrimitiveSizeInBits();
3449
3450 // If both are pointers then the address spaces must match.
3451 if (SrcPtrTy->getAddressSpace() != DstPtrTy->getAddressSpace())
3452 return false;
3453
3454 // A vector of pointers must have the same number of elements.
3455 if (SrcIsVec && DstIsVec)
3456 return SrcEC == DstEC;
3457 if (SrcIsVec)
3458 return SrcEC == ElementCount::getFixed(MinVal: 1);
3459 if (DstIsVec)
3460 return DstEC == ElementCount::getFixed(MinVal: 1);
3461
3462 return true;
3463 }
3464 case Instruction::AddrSpaceCast: {
3465 PointerType *SrcPtrTy = dyn_cast<PointerType>(Val: SrcTy->getScalarType());
3466 if (!SrcPtrTy)
3467 return false;
3468
3469 PointerType *DstPtrTy = dyn_cast<PointerType>(Val: DstTy->getScalarType());
3470 if (!DstPtrTy)
3471 return false;
3472
3473 if (SrcPtrTy->getAddressSpace() == DstPtrTy->getAddressSpace())
3474 return false;
3475
3476 return SrcEC == DstEC;
3477 }
3478 }
3479}
3480
3481TruncInst::TruncInst(Value *S, Type *Ty, const Twine &Name,
3482 InsertPosition InsertBefore)
3483 : CastInst(Ty, Trunc, S, Name, InsertBefore) {
3484 assert(castIsValid(getOpcode(), S, Ty) && "Illegal Trunc");
3485}
3486
3487ZExtInst::ZExtInst(Value *S, Type *Ty, const Twine &Name,
3488 InsertPosition InsertBefore)
3489 : CastInst(Ty, ZExt, S, Name, InsertBefore) {
3490 assert(castIsValid(getOpcode(), S, Ty) && "Illegal ZExt");
3491}
3492
3493SExtInst::SExtInst(Value *S, Type *Ty, const Twine &Name,
3494 InsertPosition InsertBefore)
3495 : CastInst(Ty, SExt, S, Name, InsertBefore) {
3496 assert(castIsValid(getOpcode(), S, Ty) && "Illegal SExt");
3497}
3498
3499FPTruncInst::FPTruncInst(Value *S, Type *Ty, const Twine &Name,
3500 InsertPosition InsertBefore)
3501 : CastInst(Ty, FPTrunc, S, Name, InsertBefore) {
3502 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPTrunc");
3503}
3504
3505FPExtInst::FPExtInst(Value *S, Type *Ty, const Twine &Name,
3506 InsertPosition InsertBefore)
3507 : CastInst(Ty, FPExt, S, Name, InsertBefore) {
3508 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPExt");
3509}
3510
3511UIToFPInst::UIToFPInst(Value *S, Type *Ty, const Twine &Name,
3512 InsertPosition InsertBefore)
3513 : CastInst(Ty, UIToFP, S, Name, InsertBefore) {
3514 assert(castIsValid(getOpcode(), S, Ty) && "Illegal UIToFP");
3515}
3516
3517SIToFPInst::SIToFPInst(Value *S, Type *Ty, const Twine &Name,
3518 InsertPosition InsertBefore)
3519 : CastInst(Ty, SIToFP, S, Name, InsertBefore) {
3520 assert(castIsValid(getOpcode(), S, Ty) && "Illegal SIToFP");
3521}
3522
3523FPToUIInst::FPToUIInst(Value *S, Type *Ty, const Twine &Name,
3524 InsertPosition InsertBefore)
3525 : CastInst(Ty, FPToUI, S, Name, InsertBefore) {
3526 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToUI");
3527}
3528
3529FPToSIInst::FPToSIInst(Value *S, Type *Ty, const Twine &Name,
3530 InsertPosition InsertBefore)
3531 : CastInst(Ty, FPToSI, S, Name, InsertBefore) {
3532 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToSI");
3533}
3534
3535PtrToIntInst::PtrToIntInst(Value *S, Type *Ty, const Twine &Name,
3536 InsertPosition InsertBefore)
3537 : CastInst(Ty, PtrToInt, S, Name, InsertBefore) {
3538 assert(castIsValid(getOpcode(), S, Ty) && "Illegal PtrToInt");
3539}
3540
3541PtrToAddrInst::PtrToAddrInst(Value *S, Type *Ty, const Twine &Name,
3542 InsertPosition InsertBefore)
3543 : CastInst(Ty, PtrToAddr, S, Name, InsertBefore) {
3544 assert(castIsValid(getOpcode(), S, Ty) && "Illegal PtrToAddr");
3545}
3546
3547IntToPtrInst::IntToPtrInst(Value *S, Type *Ty, const Twine &Name,
3548 InsertPosition InsertBefore)
3549 : CastInst(Ty, IntToPtr, S, Name, InsertBefore) {
3550 assert(castIsValid(getOpcode(), S, Ty) && "Illegal IntToPtr");
3551}
3552
3553BitCastInst::BitCastInst(Value *S, Type *Ty, const Twine &Name,
3554 InsertPosition InsertBefore)
3555 : CastInst(Ty, BitCast, S, Name, InsertBefore) {
3556 assert(castIsValid(getOpcode(), S, Ty) && "Illegal BitCast");
3557}
3558
3559AddrSpaceCastInst::AddrSpaceCastInst(Value *S, Type *Ty, const Twine &Name,
3560 InsertPosition InsertBefore)
3561 : CastInst(Ty, AddrSpaceCast, S, Name, InsertBefore) {
3562 assert(castIsValid(getOpcode(), S, Ty) && "Illegal AddrSpaceCast");
3563}
3564
3565//===----------------------------------------------------------------------===//
3566// CmpInst Classes
3567//===----------------------------------------------------------------------===//
3568
3569CmpInst::CmpInst(Type *ty, OtherOps op, Predicate predicate, Value *LHS,
3570 Value *RHS, const Twine &Name, InsertPosition InsertBefore)
3571 : Instruction(ty, op, AllocMarker, InsertBefore) {
3572 Op<0>() = LHS;
3573 Op<1>() = RHS;
3574 setPredicate(predicate);
3575 setName(Name);
3576}
3577
3578CmpInst *CmpInst::Create(OtherOps Op, Predicate predicate, Value *S1, Value *S2,
3579 const Twine &Name, InsertPosition InsertBefore) {
3580 if (Op == Instruction::ICmp) {
3581 if (InsertBefore.isValid())
3582 return new ICmpInst(InsertBefore, CmpInst::Predicate(predicate),
3583 S1, S2, Name);
3584 else
3585 return new ICmpInst(CmpInst::Predicate(predicate),
3586 S1, S2, Name);
3587 }
3588
3589 if (InsertBefore.isValid())
3590 return new FCmpInst(InsertBefore, CmpInst::Predicate(predicate),
3591 S1, S2, Name);
3592 else
3593 return new FCmpInst(CmpInst::Predicate(predicate),
3594 S1, S2, Name);
3595}
3596
3597CmpInst *CmpInst::CreateWithCopiedFlags(OtherOps Op, Predicate Pred, Value *S1,
3598 Value *S2,
3599 const Instruction *FlagsSource,
3600 const Twine &Name,
3601 InsertPosition InsertBefore) {
3602 CmpInst *Inst = Create(Op, predicate: Pred, S1, S2, Name, InsertBefore);
3603 Inst->copyIRFlags(V: FlagsSource);
3604 return Inst;
3605}
3606
3607void CmpInst::swapOperands() {
3608 if (ICmpInst *IC = dyn_cast<ICmpInst>(Val: this))
3609 IC->swapOperands();
3610 else
3611 cast<FCmpInst>(Val: this)->swapOperands();
3612}
3613
3614bool CmpInst::isCommutative() const {
3615 if (const ICmpInst *IC = dyn_cast<ICmpInst>(Val: this))
3616 return IC->isCommutative();
3617 return cast<FCmpInst>(Val: this)->isCommutative();
3618}
3619
3620bool CmpInst::isEquality(Predicate P) {
3621 if (ICmpInst::isIntPredicate(P))
3622 return ICmpInst::isEquality(P);
3623 if (FCmpInst::isFPPredicate(P))
3624 return FCmpInst::isEquality(Pred: P);
3625 llvm_unreachable("Unsupported predicate kind");
3626}
3627
3628// Returns true if either operand of CmpInst is a provably non-zero
3629// floating-point constant.
3630static bool hasNonZeroFPOperands(const CmpInst *Cmp) {
3631 auto *LHS = dyn_cast<Constant>(Val: Cmp->getOperand(i_nocapture: 0));
3632 auto *RHS = dyn_cast<Constant>(Val: Cmp->getOperand(i_nocapture: 1));
3633 if (auto *Const = LHS ? LHS : RHS) {
3634 using namespace llvm::PatternMatch;
3635 return match(V: Const, P: m_NonZeroNotDenormalFP());
3636 }
3637 return false;
3638}
3639
3640// Floating-point equality is not an equivalence when comparing +0.0 with
3641// -0.0, when comparing NaN with another value, or when flushing
3642// denormals-to-zero.
3643bool CmpInst::isEquivalence(bool Invert) const {
3644 switch (Invert ? getInversePredicate() : getPredicate()) {
3645 case CmpInst::Predicate::ICMP_EQ:
3646 return true;
3647 case CmpInst::Predicate::FCMP_UEQ:
3648 if (!hasNoNaNs())
3649 return false;
3650 [[fallthrough]];
3651 case CmpInst::Predicate::FCMP_OEQ:
3652 return hasNonZeroFPOperands(Cmp: this);
3653 default:
3654 return false;
3655 }
3656}
3657
3658CmpInst::Predicate CmpInst::getInversePredicate(Predicate pred) {
3659 switch (pred) {
3660 default: llvm_unreachable("Unknown cmp predicate!");
3661 case ICMP_EQ: return ICMP_NE;
3662 case ICMP_NE: return ICMP_EQ;
3663 case ICMP_UGT: return ICMP_ULE;
3664 case ICMP_ULT: return ICMP_UGE;
3665 case ICMP_UGE: return ICMP_ULT;
3666 case ICMP_ULE: return ICMP_UGT;
3667 case ICMP_SGT: return ICMP_SLE;
3668 case ICMP_SLT: return ICMP_SGE;
3669 case ICMP_SGE: return ICMP_SLT;
3670 case ICMP_SLE: return ICMP_SGT;
3671
3672 case FCMP_OEQ: return FCMP_UNE;
3673 case FCMP_ONE: return FCMP_UEQ;
3674 case FCMP_OGT: return FCMP_ULE;
3675 case FCMP_OLT: return FCMP_UGE;
3676 case FCMP_OGE: return FCMP_ULT;
3677 case FCMP_OLE: return FCMP_UGT;
3678 case FCMP_UEQ: return FCMP_ONE;
3679 case FCMP_UNE: return FCMP_OEQ;
3680 case FCMP_UGT: return FCMP_OLE;
3681 case FCMP_ULT: return FCMP_OGE;
3682 case FCMP_UGE: return FCMP_OLT;
3683 case FCMP_ULE: return FCMP_OGT;
3684 case FCMP_ORD: return FCMP_UNO;
3685 case FCMP_UNO: return FCMP_ORD;
3686 case FCMP_TRUE: return FCMP_FALSE;
3687 case FCMP_FALSE: return FCMP_TRUE;
3688 }
3689}
3690
3691StringRef CmpInst::getPredicateName(Predicate Pred) {
3692 switch (Pred) {
3693 default: return "unknown";
3694 case FCmpInst::FCMP_FALSE: return "false";
3695 case FCmpInst::FCMP_OEQ: return "oeq";
3696 case FCmpInst::FCMP_OGT: return "ogt";
3697 case FCmpInst::FCMP_OGE: return "oge";
3698 case FCmpInst::FCMP_OLT: return "olt";
3699 case FCmpInst::FCMP_OLE: return "ole";
3700 case FCmpInst::FCMP_ONE: return "one";
3701 case FCmpInst::FCMP_ORD: return "ord";
3702 case FCmpInst::FCMP_UNO: return "uno";
3703 case FCmpInst::FCMP_UEQ: return "ueq";
3704 case FCmpInst::FCMP_UGT: return "ugt";
3705 case FCmpInst::FCMP_UGE: return "uge";
3706 case FCmpInst::FCMP_ULT: return "ult";
3707 case FCmpInst::FCMP_ULE: return "ule";
3708 case FCmpInst::FCMP_UNE: return "une";
3709 case FCmpInst::FCMP_TRUE: return "true";
3710 case ICmpInst::ICMP_EQ: return "eq";
3711 case ICmpInst::ICMP_NE: return "ne";
3712 case ICmpInst::ICMP_SGT: return "sgt";
3713 case ICmpInst::ICMP_SGE: return "sge";
3714 case ICmpInst::ICMP_SLT: return "slt";
3715 case ICmpInst::ICMP_SLE: return "sle";
3716 case ICmpInst::ICMP_UGT: return "ugt";
3717 case ICmpInst::ICMP_UGE: return "uge";
3718 case ICmpInst::ICMP_ULT: return "ult";
3719 case ICmpInst::ICMP_ULE: return "ule";
3720 }
3721}
3722
3723raw_ostream &llvm::operator<<(raw_ostream &OS, CmpInst::Predicate Pred) {
3724 OS << CmpInst::getPredicateName(Pred);
3725 return OS;
3726}
3727
3728ICmpInst::Predicate ICmpInst::getSignedPredicate(Predicate pred) {
3729 switch (pred) {
3730 default: llvm_unreachable("Unknown icmp predicate!");
3731 case ICMP_EQ: case ICMP_NE:
3732 case ICMP_SGT: case ICMP_SLT: case ICMP_SGE: case ICMP_SLE:
3733 return pred;
3734 case ICMP_UGT: return ICMP_SGT;
3735 case ICMP_ULT: return ICMP_SLT;
3736 case ICMP_UGE: return ICMP_SGE;
3737 case ICMP_ULE: return ICMP_SLE;
3738 }
3739}
3740
3741ICmpInst::Predicate ICmpInst::getUnsignedPredicate(Predicate pred) {
3742 switch (pred) {
3743 default: llvm_unreachable("Unknown icmp predicate!");
3744 case ICMP_EQ: case ICMP_NE:
3745 case ICMP_UGT: case ICMP_ULT: case ICMP_UGE: case ICMP_ULE:
3746 return pred;
3747 case ICMP_SGT: return ICMP_UGT;
3748 case ICMP_SLT: return ICMP_ULT;
3749 case ICMP_SGE: return ICMP_UGE;
3750 case ICMP_SLE: return ICMP_ULE;
3751 }
3752}
3753
3754CmpInst::Predicate CmpInst::getSwappedPredicate(Predicate pred) {
3755 switch (pred) {
3756 default: llvm_unreachable("Unknown cmp predicate!");
3757 case ICMP_EQ: case ICMP_NE:
3758 return pred;
3759 case ICMP_SGT: return ICMP_SLT;
3760 case ICMP_SLT: return ICMP_SGT;
3761 case ICMP_SGE: return ICMP_SLE;
3762 case ICMP_SLE: return ICMP_SGE;
3763 case ICMP_UGT: return ICMP_ULT;
3764 case ICMP_ULT: return ICMP_UGT;
3765 case ICMP_UGE: return ICMP_ULE;
3766 case ICMP_ULE: return ICMP_UGE;
3767
3768 case FCMP_FALSE: case FCMP_TRUE:
3769 case FCMP_OEQ: case FCMP_ONE:
3770 case FCMP_UEQ: case FCMP_UNE:
3771 case FCMP_ORD: case FCMP_UNO:
3772 return pred;
3773 case FCMP_OGT: return FCMP_OLT;
3774 case FCMP_OLT: return FCMP_OGT;
3775 case FCMP_OGE: return FCMP_OLE;
3776 case FCMP_OLE: return FCMP_OGE;
3777 case FCMP_UGT: return FCMP_ULT;
3778 case FCMP_ULT: return FCMP_UGT;
3779 case FCMP_UGE: return FCMP_ULE;
3780 case FCMP_ULE: return FCMP_UGE;
3781 }
3782}
3783
3784bool CmpInst::isNonStrictPredicate(Predicate pred) {
3785 switch (pred) {
3786 case ICMP_SGE:
3787 case ICMP_SLE:
3788 case ICMP_UGE:
3789 case ICMP_ULE:
3790 case FCMP_OGE:
3791 case FCMP_OLE:
3792 case FCMP_UGE:
3793 case FCMP_ULE:
3794 return true;
3795 default:
3796 return false;
3797 }
3798}
3799
3800bool CmpInst::isStrictPredicate(Predicate pred) {
3801 switch (pred) {
3802 case ICMP_SGT:
3803 case ICMP_SLT:
3804 case ICMP_UGT:
3805 case ICMP_ULT:
3806 case FCMP_OGT:
3807 case FCMP_OLT:
3808 case FCMP_UGT:
3809 case FCMP_ULT:
3810 return true;
3811 default:
3812 return false;
3813 }
3814}
3815
3816CmpInst::Predicate CmpInst::getStrictPredicate(Predicate pred) {
3817 switch (pred) {
3818 case ICMP_SGE:
3819 return ICMP_SGT;
3820 case ICMP_SLE:
3821 return ICMP_SLT;
3822 case ICMP_UGE:
3823 return ICMP_UGT;
3824 case ICMP_ULE:
3825 return ICMP_ULT;
3826 case FCMP_OGE:
3827 return FCMP_OGT;
3828 case FCMP_OLE:
3829 return FCMP_OLT;
3830 case FCMP_UGE:
3831 return FCMP_UGT;
3832 case FCMP_ULE:
3833 return FCMP_ULT;
3834 default:
3835 return pred;
3836 }
3837}
3838
3839CmpInst::Predicate CmpInst::getNonStrictPredicate(Predicate pred) {
3840 switch (pred) {
3841 case ICMP_SGT:
3842 return ICMP_SGE;
3843 case ICMP_SLT:
3844 return ICMP_SLE;
3845 case ICMP_UGT:
3846 return ICMP_UGE;
3847 case ICMP_ULT:
3848 return ICMP_ULE;
3849 case FCMP_OGT:
3850 return FCMP_OGE;
3851 case FCMP_OLT:
3852 return FCMP_OLE;
3853 case FCMP_UGT:
3854 return FCMP_UGE;
3855 case FCMP_ULT:
3856 return FCMP_ULE;
3857 default:
3858 return pred;
3859 }
3860}
3861
3862CmpInst::Predicate CmpInst::getFlippedStrictnessPredicate(Predicate pred) {
3863 assert(CmpInst::isRelational(pred) && "Call only with relational predicate!");
3864
3865 if (isStrictPredicate(pred))
3866 return getNonStrictPredicate(pred);
3867 if (isNonStrictPredicate(pred))
3868 return getStrictPredicate(pred);
3869
3870 llvm_unreachable("Unknown predicate!");
3871}
3872
3873bool ICmpInst::compare(const APInt &LHS, const APInt &RHS,
3874 ICmpInst::Predicate Pred) {
3875 assert(ICmpInst::isIntPredicate(Pred) && "Only for integer predicates!");
3876 switch (Pred) {
3877 case ICmpInst::Predicate::ICMP_EQ:
3878 return LHS.eq(RHS);
3879 case ICmpInst::Predicate::ICMP_NE:
3880 return LHS.ne(RHS);
3881 case ICmpInst::Predicate::ICMP_UGT:
3882 return LHS.ugt(RHS);
3883 case ICmpInst::Predicate::ICMP_UGE:
3884 return LHS.uge(RHS);
3885 case ICmpInst::Predicate::ICMP_ULT:
3886 return LHS.ult(RHS);
3887 case ICmpInst::Predicate::ICMP_ULE:
3888 return LHS.ule(RHS);
3889 case ICmpInst::Predicate::ICMP_SGT:
3890 return LHS.sgt(RHS);
3891 case ICmpInst::Predicate::ICMP_SGE:
3892 return LHS.sge(RHS);
3893 case ICmpInst::Predicate::ICMP_SLT:
3894 return LHS.slt(RHS);
3895 case ICmpInst::Predicate::ICMP_SLE:
3896 return LHS.sle(RHS);
3897 default:
3898 llvm_unreachable("Unexpected non-integer predicate.");
3899 };
3900}
3901
3902bool FCmpInst::compare(const APFloat &LHS, const APFloat &RHS,
3903 FCmpInst::Predicate Pred) {
3904 APFloat::cmpResult R = LHS.compare(RHS);
3905 switch (Pred) {
3906 default:
3907 llvm_unreachable("Invalid FCmp Predicate");
3908 case FCmpInst::FCMP_FALSE:
3909 return false;
3910 case FCmpInst::FCMP_TRUE:
3911 return true;
3912 case FCmpInst::FCMP_UNO:
3913 return R == APFloat::cmpUnordered;
3914 case FCmpInst::FCMP_ORD:
3915 return R != APFloat::cmpUnordered;
3916 case FCmpInst::FCMP_UEQ:
3917 return R == APFloat::cmpUnordered || R == APFloat::cmpEqual;
3918 case FCmpInst::FCMP_OEQ:
3919 return R == APFloat::cmpEqual;
3920 case FCmpInst::FCMP_UNE:
3921 return R != APFloat::cmpEqual;
3922 case FCmpInst::FCMP_ONE:
3923 return R == APFloat::cmpLessThan || R == APFloat::cmpGreaterThan;
3924 case FCmpInst::FCMP_ULT:
3925 return R == APFloat::cmpUnordered || R == APFloat::cmpLessThan;
3926 case FCmpInst::FCMP_OLT:
3927 return R == APFloat::cmpLessThan;
3928 case FCmpInst::FCMP_UGT:
3929 return R == APFloat::cmpUnordered || R == APFloat::cmpGreaterThan;
3930 case FCmpInst::FCMP_OGT:
3931 return R == APFloat::cmpGreaterThan;
3932 case FCmpInst::FCMP_ULE:
3933 return R != APFloat::cmpGreaterThan;
3934 case FCmpInst::FCMP_OLE:
3935 return R == APFloat::cmpLessThan || R == APFloat::cmpEqual;
3936 case FCmpInst::FCMP_UGE:
3937 return R != APFloat::cmpLessThan;
3938 case FCmpInst::FCMP_OGE:
3939 return R == APFloat::cmpGreaterThan || R == APFloat::cmpEqual;
3940 }
3941}
3942
3943std::optional<bool> ICmpInst::compare(const KnownBits &LHS,
3944 const KnownBits &RHS,
3945 ICmpInst::Predicate Pred) {
3946 switch (Pred) {
3947 case ICmpInst::ICMP_EQ:
3948 return KnownBits::eq(LHS, RHS);
3949 case ICmpInst::ICMP_NE:
3950 return KnownBits::ne(LHS, RHS);
3951 case ICmpInst::ICMP_UGE:
3952 return KnownBits::uge(LHS, RHS);
3953 case ICmpInst::ICMP_UGT:
3954 return KnownBits::ugt(LHS, RHS);
3955 case ICmpInst::ICMP_ULE:
3956 return KnownBits::ule(LHS, RHS);
3957 case ICmpInst::ICMP_ULT:
3958 return KnownBits::ult(LHS, RHS);
3959 case ICmpInst::ICMP_SGE:
3960 return KnownBits::sge(LHS, RHS);
3961 case ICmpInst::ICMP_SGT:
3962 return KnownBits::sgt(LHS, RHS);
3963 case ICmpInst::ICMP_SLE:
3964 return KnownBits::sle(LHS, RHS);
3965 case ICmpInst::ICMP_SLT:
3966 return KnownBits::slt(LHS, RHS);
3967 default:
3968 llvm_unreachable("Unexpected non-integer predicate.");
3969 }
3970}
3971
3972CmpInst::Predicate ICmpInst::getFlippedSignednessPredicate(Predicate pred) {
3973 if (CmpInst::isEquality(P: pred))
3974 return pred;
3975 if (isSigned(Pred: pred))
3976 return getUnsignedPredicate(pred);
3977 if (isUnsigned(Pred: pred))
3978 return getSignedPredicate(pred);
3979
3980 llvm_unreachable("Unknown predicate!");
3981}
3982
3983bool CmpInst::isOrdered(Predicate predicate) {
3984 switch (predicate) {
3985 default: return false;
3986 case FCmpInst::FCMP_OEQ: case FCmpInst::FCMP_ONE: case FCmpInst::FCMP_OGT:
3987 case FCmpInst::FCMP_OLT: case FCmpInst::FCMP_OGE: case FCmpInst::FCMP_OLE:
3988 case FCmpInst::FCMP_ORD: return true;
3989 }
3990}
3991
3992bool CmpInst::isUnordered(Predicate predicate) {
3993 switch (predicate) {
3994 default: return false;
3995 case FCmpInst::FCMP_UEQ: case FCmpInst::FCMP_UNE: case FCmpInst::FCMP_UGT:
3996 case FCmpInst::FCMP_ULT: case FCmpInst::FCMP_UGE: case FCmpInst::FCMP_ULE:
3997 case FCmpInst::FCMP_UNO: return true;
3998 }
3999}
4000
4001bool CmpInst::isTrueWhenEqual(Predicate predicate) {
4002 switch(predicate) {
4003 default: return false;
4004 case ICMP_EQ: case ICMP_UGE: case ICMP_ULE: case ICMP_SGE: case ICMP_SLE:
4005 case FCMP_TRUE: case FCMP_UEQ: case FCMP_UGE: case FCMP_ULE: return true;
4006 }
4007}
4008
4009bool CmpInst::isFalseWhenEqual(Predicate predicate) {
4010 switch(predicate) {
4011 case ICMP_NE: case ICMP_UGT: case ICMP_ULT: case ICMP_SGT: case ICMP_SLT:
4012 case FCMP_FALSE: case FCMP_ONE: case FCMP_OGT: case FCMP_OLT: return true;
4013 default: return false;
4014 }
4015}
4016
4017static bool isImpliedTrueByMatchingCmp(CmpPredicate Pred1, CmpPredicate Pred2) {
4018 // If the predicates match, then we know the first condition implies the
4019 // second is true.
4020 if (CmpPredicate::getMatching(A: Pred1, B: Pred2))
4021 return true;
4022
4023 if (Pred1.hasSameSign() && CmpInst::isSigned(Pred: Pred2))
4024 Pred1 = ICmpInst::getFlippedSignednessPredicate(pred: Pred1);
4025 else if (Pred2.hasSameSign() && CmpInst::isSigned(Pred: Pred1))
4026 Pred2 = ICmpInst::getFlippedSignednessPredicate(pred: Pred2);
4027
4028 switch (Pred1) {
4029 default:
4030 break;
4031 case CmpInst::ICMP_EQ:
4032 // A == B implies A >=u B, A <=u B, A >=s B, and A <=s B are true.
4033 return Pred2 == CmpInst::ICMP_UGE || Pred2 == CmpInst::ICMP_ULE ||
4034 Pred2 == CmpInst::ICMP_SGE || Pred2 == CmpInst::ICMP_SLE;
4035 case CmpInst::ICMP_UGT: // A >u B implies A != B and A >=u B are true.
4036 return Pred2 == CmpInst::ICMP_NE || Pred2 == CmpInst::ICMP_UGE;
4037 case CmpInst::ICMP_ULT: // A <u B implies A != B and A <=u B are true.
4038 return Pred2 == CmpInst::ICMP_NE || Pred2 == CmpInst::ICMP_ULE;
4039 case CmpInst::ICMP_SGT: // A >s B implies A != B and A >=s B are true.
4040 return Pred2 == CmpInst::ICMP_NE || Pred2 == CmpInst::ICMP_SGE;
4041 case CmpInst::ICMP_SLT: // A <s B implies A != B and A <=s B are true.
4042 return Pred2 == CmpInst::ICMP_NE || Pred2 == CmpInst::ICMP_SLE;
4043 }
4044 return false;
4045}
4046
4047static bool isImpliedFalseByMatchingCmp(CmpPredicate Pred1,
4048 CmpPredicate Pred2) {
4049 return isImpliedTrueByMatchingCmp(Pred1,
4050 Pred2: ICmpInst::getInverseCmpPredicate(Pred: Pred2));
4051}
4052
4053std::optional<bool> ICmpInst::isImpliedByMatchingCmp(CmpPredicate Pred1,
4054 CmpPredicate Pred2) {
4055 if (isImpliedTrueByMatchingCmp(Pred1, Pred2))
4056 return true;
4057 if (isImpliedFalseByMatchingCmp(Pred1, Pred2))
4058 return false;
4059 return std::nullopt;
4060}
4061
4062//===----------------------------------------------------------------------===//
4063// CmpPredicate Implementation
4064//===----------------------------------------------------------------------===//
4065
4066std::optional<CmpPredicate> CmpPredicate::getMatching(CmpPredicate A,
4067 CmpPredicate B) {
4068 if (A.Pred == B.Pred)
4069 return A.HasSameSign == B.HasSameSign ? A : CmpPredicate(A.Pred);
4070 if (CmpInst::isFPPredicate(P: A) || CmpInst::isFPPredicate(P: B))
4071 return {};
4072 if (A.HasSameSign &&
4073 A.Pred == ICmpInst::getFlippedSignednessPredicate(pred: B.Pred))
4074 return B.Pred;
4075 if (B.HasSameSign &&
4076 B.Pred == ICmpInst::getFlippedSignednessPredicate(pred: A.Pred))
4077 return A.Pred;
4078 return {};
4079}
4080
4081CmpInst::Predicate CmpPredicate::getPreferredSignedPredicate() const {
4082 return HasSameSign ? ICmpInst::getSignedPredicate(pred: Pred) : Pred;
4083}
4084
4085CmpPredicate CmpPredicate::get(const CmpInst *Cmp) {
4086 if (auto *ICI = dyn_cast<ICmpInst>(Val: Cmp))
4087 return ICI->getCmpPredicate();
4088 return Cmp->getPredicate();
4089}
4090
4091CmpPredicate CmpPredicate::getInverse(CmpPredicate P) {
4092 return {CmpInst::getInversePredicate(pred: P), P.hasSameSign()};
4093}
4094
4095CmpPredicate CmpPredicate::getSwapped(CmpPredicate P) {
4096 return {CmpInst::getSwappedPredicate(pred: P), P.hasSameSign()};
4097}
4098
4099CmpPredicate CmpPredicate::getSwapped(const CmpInst *Cmp) {
4100 return getSwapped(P: get(Cmp));
4101}
4102
4103//===----------------------------------------------------------------------===//
4104// SwitchInst Implementation
4105//===----------------------------------------------------------------------===//
4106
4107void SwitchInst::init(Value *Value, BasicBlock *Default, unsigned NumReserved) {
4108 assert(Value && Default && NumReserved);
4109 ReservedSpace = NumReserved;
4110 setNumHungOffUseOperands(2);
4111 allocHungoffUses(N: ReservedSpace);
4112
4113 Op<0>() = Value;
4114 Op<1>() = Default;
4115}
4116
4117/// SwitchInst ctor - Create a new switch instruction, specifying a value to
4118/// switch on and a default destination. The number of additional cases can
4119/// be specified here to make memory allocation more efficient. This
4120/// constructor can also autoinsert before another instruction.
4121SwitchInst::SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
4122 InsertPosition InsertBefore)
4123 : Instruction(Type::getVoidTy(C&: Value->getContext()), Instruction::Switch,
4124 AllocMarker, InsertBefore) {
4125 init(Value, Default, NumReserved: 2 + NumCases);
4126}
4127
4128SwitchInst::SwitchInst(const SwitchInst &SI)
4129 : Instruction(SI.getType(), Instruction::Switch, AllocMarker) {
4130 init(Value: SI.getCondition(), Default: SI.getDefaultDest(), NumReserved: SI.getNumOperands());
4131 setNumHungOffUseOperands(SI.getNumOperands());
4132 Use *OL = getOperandList();
4133 ConstantInt **VL = case_values();
4134 const Use *InOL = SI.getOperandList();
4135 ConstantInt *const *InVL = SI.case_values();
4136 for (unsigned i = 2, E = SI.getNumOperands(); i != E; ++i) {
4137 OL[i] = InOL[i];
4138 VL[i - 2] = InVL[i - 2];
4139 }
4140 SubclassOptionalData = SI.SubclassOptionalData;
4141}
4142
4143/// addCase - Add an entry to the switch instruction...
4144///
4145void SwitchInst::addCase(ConstantInt *OnVal, BasicBlock *Dest) {
4146 unsigned NewCaseIdx = getNumCases();
4147 unsigned OpNo = getNumOperands();
4148 if (OpNo + 1 > ReservedSpace)
4149 growOperands(); // Get more space!
4150 // Initialize some new operands.
4151 assert(OpNo < ReservedSpace && "Growing didn't work!");
4152 setNumHungOffUseOperands(OpNo + 1);
4153 CaseHandle Case(this, NewCaseIdx);
4154 Case.setValue(OnVal);
4155 Case.setSuccessor(Dest);
4156}
4157
4158/// removeCase - This method removes the specified case and its successor
4159/// from the switch instruction.
4160SwitchInst::CaseIt SwitchInst::removeCase(CaseIt I) {
4161 unsigned idx = I->getCaseIndex();
4162
4163 assert(2 + idx < getNumOperands() && "Case index out of range!!!");
4164
4165 unsigned NumOps = getNumOperands();
4166 Use *OL = getOperandList();
4167 ConstantInt **VL = case_values();
4168
4169 // Overwrite this case with the end of the list.
4170 if (2 + idx + 1 != NumOps) {
4171 OL[2 + idx] = OL[NumOps - 1];
4172 VL[idx] = VL[NumOps - 2 - 1];
4173 }
4174
4175 // Nuke the last value.
4176 OL[NumOps - 1].set(nullptr);
4177 VL[NumOps - 2 - 1] = nullptr;
4178 setNumHungOffUseOperands(NumOps - 1);
4179
4180 return CaseIt(this, idx);
4181}
4182
4183/// growOperands - grow operands - This grows the operand list in response
4184/// to a push_back style of operation. This grows the number of ops by 3 times.
4185///
4186void SwitchInst::growOperands() {
4187 unsigned e = getNumOperands();
4188 unsigned NumOps = e*3;
4189
4190 ReservedSpace = NumOps;
4191 growHungoffUses(N: ReservedSpace, /*WithExtraValues=*/true);
4192}
4193
4194void SwitchInstProfUpdateWrapper::init() {
4195 MDNode *ProfileData = getBranchWeightMDNode(I: SI);
4196 if (!ProfileData)
4197 return;
4198
4199 if (getNumBranchWeights(ProfileData: *ProfileData) != SI.getNumSuccessors()) {
4200 llvm_unreachable("number of prof branch_weights metadata operands does "
4201 "not correspond to number of succesors");
4202 }
4203
4204 SmallVector<uint32_t, 8> Weights;
4205 if (!extractBranchWeights(ProfileData, Weights))
4206 return;
4207 this->Weights = std::move(Weights);
4208}
4209
4210SwitchInst::CaseIt
4211SwitchInstProfUpdateWrapper::removeCase(SwitchInst::CaseIt I) {
4212 if (Weights) {
4213 assert(SI.getNumSuccessors() == Weights->size() &&
4214 "num of prof branch_weights must accord with num of successors");
4215 Changed = true;
4216 // Copy the last case to the place of the removed one and shrink.
4217 // This is tightly coupled with the way SwitchInst::removeCase() removes
4218 // the cases in SwitchInst::removeCase(CaseIt).
4219 (*Weights)[I->getCaseIndex() + 1] = Weights->back();
4220 Weights->pop_back();
4221 }
4222 return SI.removeCase(I);
4223}
4224
4225void SwitchInstProfUpdateWrapper::replaceDefaultDest(SwitchInst::CaseIt I) {
4226 auto *DestBlock = I->getCaseSuccessor();
4227 if (Weights) {
4228 auto Weight = getSuccessorWeight(idx: I->getCaseIndex() + 1);
4229 (*Weights)[0] = Weight.value();
4230 }
4231
4232 SI.setDefaultDest(DestBlock);
4233}
4234
4235void SwitchInstProfUpdateWrapper::addCase(
4236 ConstantInt *OnVal, BasicBlock *Dest,
4237 SwitchInstProfUpdateWrapper::CaseWeightOpt W) {
4238 SI.addCase(OnVal, Dest);
4239
4240 if (!Weights && W && *W) {
4241 Changed = true;
4242 Weights = SmallVector<uint32_t, 8>(SI.getNumSuccessors(), 0);
4243 (*Weights)[SI.getNumSuccessors() - 1] = *W;
4244 } else if (Weights) {
4245 Changed = true;
4246 Weights->push_back(Elt: W.value_or(u: 0));
4247 }
4248 if (Weights)
4249 assert(SI.getNumSuccessors() == Weights->size() &&
4250 "num of prof branch_weights must accord with num of successors");
4251}
4252
4253Instruction::InstListType::iterator
4254SwitchInstProfUpdateWrapper::eraseFromParent() {
4255 // Instruction is erased. Mark as unchanged to not touch it in the destructor.
4256 Changed = false;
4257 if (Weights)
4258 Weights->resize(N: 0);
4259 return SI.eraseFromParent();
4260}
4261
4262SwitchInstProfUpdateWrapper::CaseWeightOpt
4263SwitchInstProfUpdateWrapper::getSuccessorWeight(unsigned idx) {
4264 if (!Weights)
4265 return std::nullopt;
4266 return (*Weights)[idx];
4267}
4268
4269void SwitchInstProfUpdateWrapper::setSuccessorWeight(
4270 unsigned idx, SwitchInstProfUpdateWrapper::CaseWeightOpt W) {
4271 if (!W)
4272 return;
4273
4274 if (!Weights && *W)
4275 Weights = SmallVector<uint32_t, 8>(SI.getNumSuccessors(), 0);
4276
4277 if (Weights) {
4278 auto &OldW = (*Weights)[idx];
4279 if (*W != OldW) {
4280 Changed = true;
4281 OldW = *W;
4282 }
4283 }
4284}
4285
4286SwitchInstProfUpdateWrapper::CaseWeightOpt
4287SwitchInstProfUpdateWrapper::getSuccessorWeight(const SwitchInst &SI,
4288 unsigned idx) {
4289 if (MDNode *ProfileData = getValidBranchWeightMDNode(I: SI)) {
4290 SmallVector<uint32_t> Weights;
4291 extractFromBranchWeightMD32(ProfileData, Weights);
4292 return Weights[idx];
4293 }
4294
4295 return std::nullopt;
4296}
4297
4298//===----------------------------------------------------------------------===//
4299// IndirectBrInst Implementation
4300//===----------------------------------------------------------------------===//
4301
4302void IndirectBrInst::init(Value *Address, unsigned NumDests) {
4303 assert(Address && Address->getType()->isPointerTy() &&
4304 "Address of indirectbr must be a pointer");
4305 ReservedSpace = 1+NumDests;
4306 setNumHungOffUseOperands(1);
4307 allocHungoffUses(N: ReservedSpace);
4308
4309 Op<0>() = Address;
4310}
4311
4312
4313/// growOperands - grow operands - This grows the operand list in response
4314/// to a push_back style of operation. This grows the number of ops by 2 times.
4315///
4316void IndirectBrInst::growOperands() {
4317 unsigned e = getNumOperands();
4318 unsigned NumOps = e*2;
4319
4320 ReservedSpace = NumOps;
4321 growHungoffUses(N: ReservedSpace);
4322}
4323
4324IndirectBrInst::IndirectBrInst(Value *Address, unsigned NumCases,
4325 InsertPosition InsertBefore)
4326 : Instruction(Type::getVoidTy(C&: Address->getContext()),
4327 Instruction::IndirectBr, AllocMarker, InsertBefore) {
4328 init(Address, NumDests: NumCases);
4329}
4330
4331IndirectBrInst::IndirectBrInst(const IndirectBrInst &IBI)
4332 : Instruction(Type::getVoidTy(C&: IBI.getContext()), Instruction::IndirectBr,
4333 AllocMarker) {
4334 NumUserOperands = IBI.NumUserOperands;
4335 allocHungoffUses(N: IBI.getNumOperands());
4336 Use *OL = getOperandList();
4337 const Use *InOL = IBI.getOperandList();
4338 for (unsigned i = 0, E = IBI.getNumOperands(); i != E; ++i)
4339 OL[i] = InOL[i];
4340 SubclassOptionalData = IBI.SubclassOptionalData;
4341}
4342
4343/// addDestination - Add a destination.
4344///
4345void IndirectBrInst::addDestination(BasicBlock *DestBB) {
4346 unsigned OpNo = getNumOperands();
4347 if (OpNo+1 > ReservedSpace)
4348 growOperands(); // Get more space!
4349 // Initialize some new operands.
4350 assert(OpNo < ReservedSpace && "Growing didn't work!");
4351 setNumHungOffUseOperands(OpNo+1);
4352 getOperandList()[OpNo] = DestBB;
4353}
4354
4355/// removeDestination - This method removes the specified successor from the
4356/// indirectbr instruction.
4357void IndirectBrInst::removeDestination(unsigned idx) {
4358 assert(idx < getNumOperands()-1 && "Successor index out of range!");
4359
4360 unsigned NumOps = getNumOperands();
4361 Use *OL = getOperandList();
4362
4363 // Replace this value with the last one.
4364 OL[idx+1] = OL[NumOps-1];
4365
4366 // Nuke the last value.
4367 OL[NumOps-1].set(nullptr);
4368 setNumHungOffUseOperands(NumOps-1);
4369}
4370
4371//===----------------------------------------------------------------------===//
4372// FreezeInst Implementation
4373//===----------------------------------------------------------------------===//
4374
4375FreezeInst::FreezeInst(Value *S, const Twine &Name, InsertPosition InsertBefore)
4376 : UnaryInstruction(S->getType(), Freeze, S, InsertBefore) {
4377 setName(Name);
4378}
4379
4380//===----------------------------------------------------------------------===//
4381// cloneImpl() implementations
4382//===----------------------------------------------------------------------===//
4383
4384// Define these methods here so vtables don't get emitted into every translation
4385// unit that uses these classes.
4386
4387GetElementPtrInst *GetElementPtrInst::cloneImpl() const {
4388 IntrusiveOperandsAllocMarker AllocMarker{.NumOps: getNumOperands()};
4389 return new (AllocMarker) GetElementPtrInst(*this, AllocMarker);
4390}
4391
4392UnaryOperator *UnaryOperator::cloneImpl() const {
4393 return Create(Op: getOpcode(), S: Op<0>());
4394}
4395
4396FPUnaryOperator *FPUnaryOperator::cloneImpl() const {
4397 auto *I = static_cast<FPUnaryOperator *>(Create(Op: getOpcode(), S: Op<0>()));
4398 I->FMF = FMF;
4399 return I;
4400}
4401
4402BinaryOperator *BinaryOperator::cloneImpl() const {
4403 assert(!isa<FPBinaryOperator>(this) &&
4404 "Should call FPBinaryOperator::cloneImpl!");
4405 return Create(Op: getOpcode(), S1: Op<0>(), S2: Op<1>());
4406}
4407
4408FPBinaryOperator *FPBinaryOperator::cloneImpl() const {
4409 auto *I =
4410 static_cast<FPBinaryOperator *>(Create(Op: getOpcode(), S1: Op<0>(), S2: Op<1>()));
4411 I->FMF = FMF;
4412 return I;
4413}
4414
4415FCmpInst *FCmpInst::cloneImpl() const {
4416 auto *I = new FCmpInst(getPredicate(), Op<0>(), Op<1>());
4417 I->FMF = FMF;
4418 return I;
4419}
4420
4421ICmpInst *ICmpInst::cloneImpl() const {
4422 auto *Result = new ICmpInst(getPredicate(), Op<0>(), Op<1>());
4423 Result->setSameSign(hasSameSign());
4424 return Result;
4425}
4426
4427ExtractValueInst *ExtractValueInst::cloneImpl() const {
4428 return new ExtractValueInst(*this);
4429}
4430
4431InsertValueInst *InsertValueInst::cloneImpl() const {
4432 return new InsertValueInst(*this);
4433}
4434
4435AllocaInst *AllocaInst::cloneImpl() const {
4436 AllocaInst *Result = new AllocaInst(getAllocatedType(), getAddressSpace(),
4437 getOperand(i_nocapture: 0), getAlign());
4438 Result->setUsedWithInAlloca(isUsedWithInAlloca());
4439 Result->setSwiftError(isSwiftError());
4440 return Result;
4441}
4442
4443LoadInst *LoadInst::cloneImpl() const {
4444 return new LoadInst(getType(), getOperand(i_nocapture: 0), Twine(), isVolatile(),
4445 getAlign(), getOrdering(), getSyncScopeID());
4446}
4447
4448StoreInst *StoreInst::cloneImpl() const {
4449 return new StoreInst(getOperand(i_nocapture: 0), getOperand(i_nocapture: 1), isVolatile(), getAlign(),
4450 getOrdering(), getSyncScopeID());
4451}
4452
4453AtomicCmpXchgInst *AtomicCmpXchgInst::cloneImpl() const {
4454 AtomicCmpXchgInst *Result = new AtomicCmpXchgInst(
4455 getOperand(i_nocapture: 0), getOperand(i_nocapture: 1), getOperand(i_nocapture: 2), getAlign(),
4456 getSuccessOrdering(), getFailureOrdering(), getSyncScopeID());
4457 Result->setVolatile(isVolatile());
4458 Result->setWeak(isWeak());
4459 return Result;
4460}
4461
4462AtomicRMWInst *AtomicRMWInst::cloneImpl() const {
4463 AtomicRMWInst *Result = new AtomicRMWInst(
4464 getOperation(), getOperand(i_nocapture: 0), getOperand(i_nocapture: 1), getAlign(), getOrdering(),
4465 getSyncScopeID(), isElementwise());
4466 Result->setVolatile(isVolatile());
4467 return Result;
4468}
4469
4470FenceInst *FenceInst::cloneImpl() const {
4471 return new FenceInst(getContext(), getOrdering(), getSyncScopeID());
4472}
4473
4474TruncInst *TruncInst::cloneImpl() const {
4475 return new TruncInst(getOperand(i_nocapture: 0), getType());
4476}
4477
4478ZExtInst *ZExtInst::cloneImpl() const {
4479 return new ZExtInst(getOperand(i_nocapture: 0), getType());
4480}
4481
4482SExtInst *SExtInst::cloneImpl() const {
4483 return new SExtInst(getOperand(i_nocapture: 0), getType());
4484}
4485
4486FPTruncInst *FPTruncInst::cloneImpl() const {
4487 auto *I = new FPTruncInst(getOperand(i_nocapture: 0), getType());
4488 I->FMF = FMF;
4489 return I;
4490}
4491
4492FPExtInst *FPExtInst::cloneImpl() const {
4493 auto *I = new FPExtInst(getOperand(i_nocapture: 0), getType());
4494 I->FMF = FMF;
4495 return I;
4496}
4497
4498UIToFPInst *UIToFPInst::cloneImpl() const {
4499 auto *Result = new UIToFPInst(getOperand(i_nocapture: 0), getType());
4500 Result->FMF = FMF;
4501 return Result;
4502}
4503
4504SIToFPInst *SIToFPInst::cloneImpl() const {
4505 auto *Result = new SIToFPInst(getOperand(i_nocapture: 0), getType());
4506 Result->FMF = FMF;
4507 return Result;
4508}
4509
4510FPToUIInst *FPToUIInst::cloneImpl() const {
4511 return new FPToUIInst(getOperand(i_nocapture: 0), getType());
4512}
4513
4514FPToSIInst *FPToSIInst::cloneImpl() const {
4515 return new FPToSIInst(getOperand(i_nocapture: 0), getType());
4516}
4517
4518PtrToIntInst *PtrToIntInst::cloneImpl() const {
4519 return new PtrToIntInst(getOperand(i_nocapture: 0), getType());
4520}
4521
4522PtrToAddrInst *PtrToAddrInst::cloneImpl() const {
4523 return new PtrToAddrInst(getOperand(i_nocapture: 0), getType());
4524}
4525
4526IntToPtrInst *IntToPtrInst::cloneImpl() const {
4527 return new IntToPtrInst(getOperand(i_nocapture: 0), getType());
4528}
4529
4530BitCastInst *BitCastInst::cloneImpl() const {
4531 return new BitCastInst(getOperand(i_nocapture: 0), getType());
4532}
4533
4534AddrSpaceCastInst *AddrSpaceCastInst::cloneImpl() const {
4535 return new AddrSpaceCastInst(getOperand(i_nocapture: 0), getType());
4536}
4537
4538CallInst *CallInst::cloneImpl() const {
4539 if (hasOperandBundles()) {
4540 IntrusiveOperandsAndDescriptorAllocMarker AllocMarker{
4541 .NumOps: getNumOperands(),
4542 .DescBytes: getNumOperandBundles() * unsigned(sizeof(BundleOpInfo))};
4543 return new (AllocMarker) CallInst(*this, AllocMarker);
4544 }
4545 IntrusiveOperandsAllocMarker AllocMarker{.NumOps: getNumOperands()};
4546 return new (AllocMarker) CallInst(*this, AllocMarker);
4547}
4548
4549SelectInst *SelectInst::cloneImpl() const {
4550 auto *I = SelectInst::Create(C: getOperand(i_nocapture: 0), S1: getOperand(i_nocapture: 1), S2: getOperand(i_nocapture: 2));
4551 I->FMF = FMF;
4552 return I;
4553}
4554
4555VAArgInst *VAArgInst::cloneImpl() const {
4556 return new VAArgInst(getOperand(i_nocapture: 0), getType());
4557}
4558
4559ExtractElementInst *ExtractElementInst::cloneImpl() const {
4560 return ExtractElementInst::Create(Vec: getOperand(i_nocapture: 0), Idx: getOperand(i_nocapture: 1));
4561}
4562
4563InsertElementInst *InsertElementInst::cloneImpl() const {
4564 return InsertElementInst::Create(Vec: getOperand(i_nocapture: 0), NewElt: getOperand(i_nocapture: 1), Idx: getOperand(i_nocapture: 2));
4565}
4566
4567ShuffleVectorInst *ShuffleVectorInst::cloneImpl() const {
4568 return new ShuffleVectorInst(getOperand(i_nocapture: 0), getOperand(i_nocapture: 1), getShuffleMask());
4569}
4570
4571PHINode *PHINode::cloneImpl() const { return new (AllocMarker) PHINode(*this); }
4572
4573LandingPadInst *LandingPadInst::cloneImpl() const {
4574 return new LandingPadInst(*this);
4575}
4576
4577ReturnInst *ReturnInst::cloneImpl() const {
4578 IntrusiveOperandsAllocMarker AllocMarker{.NumOps: getNumOperands()};
4579 return new (AllocMarker) ReturnInst(*this, AllocMarker);
4580}
4581
4582UncondBrInst *UncondBrInst::cloneImpl() const {
4583 return new (AllocMarker) UncondBrInst(*this);
4584}
4585
4586CondBrInst *CondBrInst::cloneImpl() const {
4587 return new (AllocMarker) CondBrInst(*this);
4588}
4589
4590SwitchInst *SwitchInst::cloneImpl() const { return new SwitchInst(*this); }
4591
4592IndirectBrInst *IndirectBrInst::cloneImpl() const {
4593 return new IndirectBrInst(*this);
4594}
4595
4596InvokeInst *InvokeInst::cloneImpl() const {
4597 if (hasOperandBundles()) {
4598 IntrusiveOperandsAndDescriptorAllocMarker AllocMarker{
4599 .NumOps: getNumOperands(),
4600 .DescBytes: getNumOperandBundles() * unsigned(sizeof(BundleOpInfo))};
4601 return new (AllocMarker) InvokeInst(*this, AllocMarker);
4602 }
4603 IntrusiveOperandsAllocMarker AllocMarker{.NumOps: getNumOperands()};
4604 return new (AllocMarker) InvokeInst(*this, AllocMarker);
4605}
4606
4607CallBrInst *CallBrInst::cloneImpl() const {
4608 if (hasOperandBundles()) {
4609 IntrusiveOperandsAndDescriptorAllocMarker AllocMarker{
4610 .NumOps: getNumOperands(),
4611 .DescBytes: getNumOperandBundles() * unsigned(sizeof(BundleOpInfo))};
4612 return new (AllocMarker) CallBrInst(*this, AllocMarker);
4613 }
4614 IntrusiveOperandsAllocMarker AllocMarker{.NumOps: getNumOperands()};
4615 return new (AllocMarker) CallBrInst(*this, AllocMarker);
4616}
4617
4618ResumeInst *ResumeInst::cloneImpl() const {
4619 return new (AllocMarker) ResumeInst(*this);
4620}
4621
4622CleanupReturnInst *CleanupReturnInst::cloneImpl() const {
4623 IntrusiveOperandsAllocMarker AllocMarker{.NumOps: getNumOperands()};
4624 return new (AllocMarker) CleanupReturnInst(*this, AllocMarker);
4625}
4626
4627CatchReturnInst *CatchReturnInst::cloneImpl() const {
4628 return new (AllocMarker) CatchReturnInst(*this);
4629}
4630
4631CatchSwitchInst *CatchSwitchInst::cloneImpl() const {
4632 return new CatchSwitchInst(*this);
4633}
4634
4635FuncletPadInst *FuncletPadInst::cloneImpl() const {
4636 IntrusiveOperandsAllocMarker AllocMarker{.NumOps: getNumOperands()};
4637 return new (AllocMarker) FuncletPadInst(*this, AllocMarker);
4638}
4639
4640UnreachableInst *UnreachableInst::cloneImpl() const {
4641 LLVMContext &Context = getContext();
4642 return new UnreachableInst(Context);
4643}
4644
4645bool UnreachableInst::shouldLowerToTrap(bool TrapUnreachable,
4646 bool NoTrapAfterNoreturn) const {
4647 if (!TrapUnreachable)
4648 return false;
4649
4650 // We may be able to ignore unreachable behind a noreturn call.
4651 if (const CallInst *Call = dyn_cast_or_null<CallInst>(Val: getPrevNode());
4652 Call && Call->doesNotReturn()) {
4653 if (NoTrapAfterNoreturn)
4654 return false;
4655 // Do not emit an additional trap instruction.
4656 if (Call->isNonContinuableTrap())
4657 return false;
4658 }
4659
4660 if (getFunction()->hasFnAttribute(Kind: Attribute::Naked))
4661 return false;
4662
4663 return true;
4664}
4665
4666FreezeInst *FreezeInst::cloneImpl() const {
4667 return new FreezeInst(getOperand(i_nocapture: 0));
4668}
4669