1 //===-- Instructions.cpp - Implement the LLVM instructions ----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements all of the non-inline methods for the LLVM instruction
13 //===----------------------------------------------------------------------===//
15 #include "llvm/IR/Instructions.h"
16 #include "LLVMContextImpl.h"
17 #include "llvm/IR/CallSite.h"
18 #include "llvm/IR/ConstantRange.h"
19 #include "llvm/IR/Constants.h"
20 #include "llvm/IR/DataLayout.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/Function.h"
23 #include "llvm/IR/Module.h"
24 #include "llvm/IR/Operator.h"
25 #include "llvm/Support/ErrorHandling.h"
26 #include "llvm/Support/MathExtras.h"
29 //===----------------------------------------------------------------------===//
31 //===----------------------------------------------------------------------===//
33 User::op_iterator CallSite::getCallee() const {
34 Instruction *II(getInstruction());
36 ? cast<CallInst>(II)->op_end() - 1 // Skip Callee
37 : cast<InvokeInst>(II)->op_end() - 3; // Skip BB, BB, Callee
40 //===----------------------------------------------------------------------===//
41 // TerminatorInst Class
42 //===----------------------------------------------------------------------===//
44 // Out of line virtual method, so the vtable, etc has a home.
45 TerminatorInst::~TerminatorInst() {
48 //===----------------------------------------------------------------------===//
49 // UnaryInstruction Class
50 //===----------------------------------------------------------------------===//
52 // Out of line virtual method, so the vtable, etc has a home.
53 UnaryInstruction::~UnaryInstruction() {
56 //===----------------------------------------------------------------------===//
58 //===----------------------------------------------------------------------===//
60 /// areInvalidOperands - Return a string if the specified operands are invalid
61 /// for a select operation, otherwise return null.
62 const char *SelectInst::areInvalidOperands(Value *Op0, Value *Op1, Value *Op2) {
63 if (Op1->getType() != Op2->getType())
64 return "both values to select must have same type";
66 if (VectorType *VT = dyn_cast<VectorType>(Op0->getType())) {
68 if (VT->getElementType() != Type::getInt1Ty(Op0->getContext()))
69 return "vector select condition element type must be i1";
70 VectorType *ET = dyn_cast<VectorType>(Op1->getType());
72 return "selected values for vector select must be vectors";
73 if (ET->getNumElements() != VT->getNumElements())
74 return "vector select requires selected vectors to have "
75 "the same vector length as select condition";
76 } else if (Op0->getType() != Type::getInt1Ty(Op0->getContext())) {
77 return "select condition must be i1 or <n x i1>";
83 //===----------------------------------------------------------------------===//
85 //===----------------------------------------------------------------------===//
87 PHINode::PHINode(const PHINode &PN)
88 : Instruction(PN.getType(), Instruction::PHI,
89 allocHungoffUses(PN.getNumOperands()), PN.getNumOperands()),
90 ReservedSpace(PN.getNumOperands()) {
91 std::copy(PN.op_begin(), PN.op_end(), op_begin());
92 std::copy(PN.block_begin(), PN.block_end(), block_begin());
93 SubclassOptionalData = PN.SubclassOptionalData;
100 Use *PHINode::allocHungoffUses(unsigned N) const {
101 // Allocate the array of Uses of the incoming values, followed by a pointer
102 // (with bottom bit set) to the User, followed by the array of pointers to
103 // the incoming basic blocks.
104 size_t size = N * sizeof(Use) + sizeof(Use::UserRef)
105 + N * sizeof(BasicBlock*);
106 Use *Begin = static_cast<Use*>(::operator new(size));
107 Use *End = Begin + N;
108 (void) new(End) Use::UserRef(const_cast<PHINode*>(this), 1);
109 return Use::initTags(Begin, End);
112 // removeIncomingValue - Remove an incoming value. This is useful if a
113 // predecessor basic block is deleted.
114 Value *PHINode::removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty) {
115 Value *Removed = getIncomingValue(Idx);
117 // Move everything after this operand down.
119 // FIXME: we could just swap with the end of the list, then erase. However,
120 // clients might not expect this to happen. The code as it is thrashes the
121 // use/def lists, which is kinda lame.
122 std::copy(op_begin() + Idx + 1, op_end(), op_begin() + Idx);
123 std::copy(block_begin() + Idx + 1, block_end(), block_begin() + Idx);
125 // Nuke the last value.
126 Op<-1>().set(nullptr);
129 // If the PHI node is dead, because it has zero entries, nuke it now.
130 if (getNumOperands() == 0 && DeletePHIIfEmpty) {
131 // If anyone is using this PHI, make them use a dummy value instead...
132 replaceAllUsesWith(UndefValue::get(getType()));
138 /// growOperands - grow operands - This grows the operand list in response
139 /// to a push_back style of operation. This grows the number of ops by 1.5
142 void PHINode::growOperands() {
143 unsigned e = getNumOperands();
144 unsigned NumOps = e + e / 2;
145 if (NumOps < 2) NumOps = 2; // 2 op PHI nodes are VERY common.
147 Use *OldOps = op_begin();
148 BasicBlock **OldBlocks = block_begin();
150 ReservedSpace = NumOps;
151 OperandList = allocHungoffUses(ReservedSpace);
153 std::copy(OldOps, OldOps + e, op_begin());
154 std::copy(OldBlocks, OldBlocks + e, block_begin());
156 Use::zap(OldOps, OldOps + e, true);
159 /// hasConstantValue - If the specified PHI node always merges together the same
160 /// value, return the value, otherwise return null.
161 Value *PHINode::hasConstantValue() const {
162 // Exploit the fact that phi nodes always have at least one entry.
163 Value *ConstantValue = getIncomingValue(0);
164 for (unsigned i = 1, e = getNumIncomingValues(); i != e; ++i)
165 if (getIncomingValue(i) != ConstantValue && getIncomingValue(i) != this) {
166 if (ConstantValue != this)
167 return nullptr; // Incoming values not all the same.
168 // The case where the first value is this PHI.
169 ConstantValue = getIncomingValue(i);
171 if (ConstantValue == this)
172 return UndefValue::get(getType());
173 return ConstantValue;
176 //===----------------------------------------------------------------------===//
177 // LandingPadInst Implementation
178 //===----------------------------------------------------------------------===//
180 LandingPadInst::LandingPadInst(Type *RetTy, Value *PersonalityFn,
181 unsigned NumReservedValues, const Twine &NameStr,
182 Instruction *InsertBefore)
183 : Instruction(RetTy, Instruction::LandingPad, nullptr, 0, InsertBefore) {
184 init(PersonalityFn, 1 + NumReservedValues, NameStr);
187 LandingPadInst::LandingPadInst(Type *RetTy, Value *PersonalityFn,
188 unsigned NumReservedValues, const Twine &NameStr,
189 BasicBlock *InsertAtEnd)
190 : Instruction(RetTy, Instruction::LandingPad, nullptr, 0, InsertAtEnd) {
191 init(PersonalityFn, 1 + NumReservedValues, NameStr);
194 LandingPadInst::LandingPadInst(const LandingPadInst &LP)
195 : Instruction(LP.getType(), Instruction::LandingPad,
196 allocHungoffUses(LP.getNumOperands()), LP.getNumOperands()),
197 ReservedSpace(LP.getNumOperands()) {
198 Use *OL = OperandList, *InOL = LP.OperandList;
199 for (unsigned I = 0, E = ReservedSpace; I != E; ++I)
202 setCleanup(LP.isCleanup());
205 LandingPadInst::~LandingPadInst() {
209 LandingPadInst *LandingPadInst::Create(Type *RetTy, Value *PersonalityFn,
210 unsigned NumReservedClauses,
211 const Twine &NameStr,
212 Instruction *InsertBefore) {
213 return new LandingPadInst(RetTy, PersonalityFn, NumReservedClauses, NameStr,
217 LandingPadInst *LandingPadInst::Create(Type *RetTy, Value *PersonalityFn,
218 unsigned NumReservedClauses,
219 const Twine &NameStr,
220 BasicBlock *InsertAtEnd) {
221 return new LandingPadInst(RetTy, PersonalityFn, NumReservedClauses, NameStr,
225 void LandingPadInst::init(Value *PersFn, unsigned NumReservedValues,
226 const Twine &NameStr) {
227 ReservedSpace = NumReservedValues;
229 OperandList = allocHungoffUses(ReservedSpace);
230 OperandList[0] = PersFn;
235 /// growOperands - grow operands - This grows the operand list in response to a
236 /// push_back style of operation. This grows the number of ops by 2 times.
237 void LandingPadInst::growOperands(unsigned Size) {
238 unsigned e = getNumOperands();
239 if (ReservedSpace >= e + Size) return;
240 ReservedSpace = (e + Size / 2) * 2;
242 Use *NewOps = allocHungoffUses(ReservedSpace);
243 Use *OldOps = OperandList;
244 for (unsigned i = 0; i != e; ++i)
245 NewOps[i] = OldOps[i];
247 OperandList = NewOps;
248 Use::zap(OldOps, OldOps + e, true);
251 void LandingPadInst::addClause(Value *Val) {
252 unsigned OpNo = getNumOperands();
254 assert(OpNo < ReservedSpace && "Growing didn't work!");
256 OperandList[OpNo] = Val;
259 //===----------------------------------------------------------------------===//
260 // CallInst Implementation
261 //===----------------------------------------------------------------------===//
263 CallInst::~CallInst() {
266 void CallInst::init(Value *Func, ArrayRef<Value *> Args, const Twine &NameStr) {
267 assert(NumOperands == Args.size() + 1 && "NumOperands not set up?");
272 cast<FunctionType>(cast<PointerType>(Func->getType())->getElementType());
274 assert((Args.size() == FTy->getNumParams() ||
275 (FTy->isVarArg() && Args.size() > FTy->getNumParams())) &&
276 "Calling a function with bad signature!");
278 for (unsigned i = 0; i != Args.size(); ++i)
279 assert((i >= FTy->getNumParams() ||
280 FTy->getParamType(i) == Args[i]->getType()) &&
281 "Calling a function with a bad signature!");
284 std::copy(Args.begin(), Args.end(), op_begin());
288 void CallInst::init(Value *Func, const Twine &NameStr) {
289 assert(NumOperands == 1 && "NumOperands not set up?");
294 cast<FunctionType>(cast<PointerType>(Func->getType())->getElementType());
296 assert(FTy->getNumParams() == 0 && "Calling a function with bad signature");
302 CallInst::CallInst(Value *Func, const Twine &Name,
303 Instruction *InsertBefore)
304 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
305 ->getElementType())->getReturnType(),
307 OperandTraits<CallInst>::op_end(this) - 1,
312 CallInst::CallInst(Value *Func, const Twine &Name,
313 BasicBlock *InsertAtEnd)
314 : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
315 ->getElementType())->getReturnType(),
317 OperandTraits<CallInst>::op_end(this) - 1,
322 CallInst::CallInst(const CallInst &CI)
323 : Instruction(CI.getType(), Instruction::Call,
324 OperandTraits<CallInst>::op_end(this) - CI.getNumOperands(),
325 CI.getNumOperands()) {
326 setAttributes(CI.getAttributes());
327 setTailCall(CI.isTailCall());
328 setCallingConv(CI.getCallingConv());
330 std::copy(CI.op_begin(), CI.op_end(), op_begin());
331 SubclassOptionalData = CI.SubclassOptionalData;
334 void CallInst::addAttribute(unsigned i, Attribute::AttrKind attr) {
335 AttributeSet PAL = getAttributes();
336 PAL = PAL.addAttribute(getContext(), i, attr);
340 void CallInst::removeAttribute(unsigned i, Attribute attr) {
341 AttributeSet PAL = getAttributes();
343 LLVMContext &Context = getContext();
344 PAL = PAL.removeAttributes(Context, i,
345 AttributeSet::get(Context, i, B));
349 bool CallInst::hasFnAttrImpl(Attribute::AttrKind A) const {
350 if (AttributeList.hasAttribute(AttributeSet::FunctionIndex, A))
352 if (const Function *F = getCalledFunction())
353 return F->getAttributes().hasAttribute(AttributeSet::FunctionIndex, A);
357 bool CallInst::paramHasAttr(unsigned i, Attribute::AttrKind A) const {
358 if (AttributeList.hasAttribute(i, A))
360 if (const Function *F = getCalledFunction())
361 return F->getAttributes().hasAttribute(i, A);
365 /// IsConstantOne - Return true only if val is constant int 1
366 static bool IsConstantOne(Value *val) {
367 assert(val && "IsConstantOne does not work with NULL val");
368 return isa<ConstantInt>(val) && cast<ConstantInt>(val)->isOne();
371 static Instruction *createMalloc(Instruction *InsertBefore,
372 BasicBlock *InsertAtEnd, Type *IntPtrTy,
373 Type *AllocTy, Value *AllocSize,
374 Value *ArraySize, Function *MallocF,
376 assert(((!InsertBefore && InsertAtEnd) || (InsertBefore && !InsertAtEnd)) &&
377 "createMalloc needs either InsertBefore or InsertAtEnd");
379 // malloc(type) becomes:
380 // bitcast (i8* malloc(typeSize)) to type*
381 // malloc(type, arraySize) becomes:
382 // bitcast (i8 *malloc(typeSize*arraySize)) to type*
384 ArraySize = ConstantInt::get(IntPtrTy, 1);
385 else if (ArraySize->getType() != IntPtrTy) {
387 ArraySize = CastInst::CreateIntegerCast(ArraySize, IntPtrTy, false,
390 ArraySize = CastInst::CreateIntegerCast(ArraySize, IntPtrTy, false,
394 if (!IsConstantOne(ArraySize)) {
395 if (IsConstantOne(AllocSize)) {
396 AllocSize = ArraySize; // Operand * 1 = Operand
397 } else if (Constant *CO = dyn_cast<Constant>(ArraySize)) {
398 Constant *Scale = ConstantExpr::getIntegerCast(CO, IntPtrTy,
400 // Malloc arg is constant product of type size and array size
401 AllocSize = ConstantExpr::getMul(Scale, cast<Constant>(AllocSize));
403 // Multiply type size by the array size...
405 AllocSize = BinaryOperator::CreateMul(ArraySize, AllocSize,
406 "mallocsize", InsertBefore);
408 AllocSize = BinaryOperator::CreateMul(ArraySize, AllocSize,
409 "mallocsize", InsertAtEnd);
413 assert(AllocSize->getType() == IntPtrTy && "malloc arg is wrong size");
414 // Create the call to Malloc.
415 BasicBlock* BB = InsertBefore ? InsertBefore->getParent() : InsertAtEnd;
416 Module* M = BB->getParent()->getParent();
417 Type *BPTy = Type::getInt8PtrTy(BB->getContext());
418 Value *MallocFunc = MallocF;
420 // prototype malloc as "void *malloc(size_t)"
421 MallocFunc = M->getOrInsertFunction("malloc", BPTy, IntPtrTy, NULL);
422 PointerType *AllocPtrType = PointerType::getUnqual(AllocTy);
423 CallInst *MCall = nullptr;
424 Instruction *Result = nullptr;
426 MCall = CallInst::Create(MallocFunc, AllocSize, "malloccall", InsertBefore);
428 if (Result->getType() != AllocPtrType)
429 // Create a cast instruction to convert to the right type...
430 Result = new BitCastInst(MCall, AllocPtrType, Name, InsertBefore);
432 MCall = CallInst::Create(MallocFunc, AllocSize, "malloccall");
434 if (Result->getType() != AllocPtrType) {
435 InsertAtEnd->getInstList().push_back(MCall);
436 // Create a cast instruction to convert to the right type...
437 Result = new BitCastInst(MCall, AllocPtrType, Name);
440 MCall->setTailCall();
441 if (Function *F = dyn_cast<Function>(MallocFunc)) {
442 MCall->setCallingConv(F->getCallingConv());
443 if (!F->doesNotAlias(0)) F->setDoesNotAlias(0);
445 assert(!MCall->getType()->isVoidTy() && "Malloc has void return type");
450 /// CreateMalloc - Generate the IR for a call to malloc:
451 /// 1. Compute the malloc call's argument as the specified type's size,
452 /// possibly multiplied by the array size if the array size is not
454 /// 2. Call malloc with that argument.
455 /// 3. Bitcast the result of the malloc call to the specified type.
456 Instruction *CallInst::CreateMalloc(Instruction *InsertBefore,
457 Type *IntPtrTy, Type *AllocTy,
458 Value *AllocSize, Value *ArraySize,
461 return createMalloc(InsertBefore, nullptr, IntPtrTy, AllocTy, AllocSize,
462 ArraySize, MallocF, Name);
465 /// CreateMalloc - Generate the IR for a call to malloc:
466 /// 1. Compute the malloc call's argument as the specified type's size,
467 /// possibly multiplied by the array size if the array size is not
469 /// 2. Call malloc with that argument.
470 /// 3. Bitcast the result of the malloc call to the specified type.
471 /// Note: This function does not add the bitcast to the basic block, that is the
472 /// responsibility of the caller.
473 Instruction *CallInst::CreateMalloc(BasicBlock *InsertAtEnd,
474 Type *IntPtrTy, Type *AllocTy,
475 Value *AllocSize, Value *ArraySize,
476 Function *MallocF, const Twine &Name) {
477 return createMalloc(nullptr, InsertAtEnd, IntPtrTy, AllocTy, AllocSize,
478 ArraySize, MallocF, Name);
481 static Instruction* createFree(Value* Source, Instruction *InsertBefore,
482 BasicBlock *InsertAtEnd) {
483 assert(((!InsertBefore && InsertAtEnd) || (InsertBefore && !InsertAtEnd)) &&
484 "createFree needs either InsertBefore or InsertAtEnd");
485 assert(Source->getType()->isPointerTy() &&
486 "Can not free something of nonpointer type!");
488 BasicBlock* BB = InsertBefore ? InsertBefore->getParent() : InsertAtEnd;
489 Module* M = BB->getParent()->getParent();
491 Type *VoidTy = Type::getVoidTy(M->getContext());
492 Type *IntPtrTy = Type::getInt8PtrTy(M->getContext());
493 // prototype free as "void free(void*)"
494 Value *FreeFunc = M->getOrInsertFunction("free", VoidTy, IntPtrTy, NULL);
495 CallInst* Result = nullptr;
496 Value *PtrCast = Source;
498 if (Source->getType() != IntPtrTy)
499 PtrCast = new BitCastInst(Source, IntPtrTy, "", InsertBefore);
500 Result = CallInst::Create(FreeFunc, PtrCast, "", InsertBefore);
502 if (Source->getType() != IntPtrTy)
503 PtrCast = new BitCastInst(Source, IntPtrTy, "", InsertAtEnd);
504 Result = CallInst::Create(FreeFunc, PtrCast, "");
506 Result->setTailCall();
507 if (Function *F = dyn_cast<Function>(FreeFunc))
508 Result->setCallingConv(F->getCallingConv());
513 /// CreateFree - Generate the IR for a call to the builtin free function.
514 Instruction * CallInst::CreateFree(Value* Source, Instruction *InsertBefore) {
515 return createFree(Source, InsertBefore, nullptr);
518 /// CreateFree - Generate the IR for a call to the builtin free function.
519 /// Note: This function does not add the call to the basic block, that is the
520 /// responsibility of the caller.
521 Instruction* CallInst::CreateFree(Value* Source, BasicBlock *InsertAtEnd) {
522 Instruction* FreeCall = createFree(Source, nullptr, InsertAtEnd);
523 assert(FreeCall && "CreateFree did not create a CallInst");
527 //===----------------------------------------------------------------------===//
528 // InvokeInst Implementation
529 //===----------------------------------------------------------------------===//
531 void InvokeInst::init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
532 ArrayRef<Value *> Args, const Twine &NameStr) {
533 assert(NumOperands == 3 + Args.size() && "NumOperands not set up?");
536 Op<-1>() = IfException;
540 cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType());
542 assert(((Args.size() == FTy->getNumParams()) ||
543 (FTy->isVarArg() && Args.size() > FTy->getNumParams())) &&
544 "Invoking a function with bad signature");
546 for (unsigned i = 0, e = Args.size(); i != e; i++)
547 assert((i >= FTy->getNumParams() ||
548 FTy->getParamType(i) == Args[i]->getType()) &&
549 "Invoking a function with a bad signature!");
552 std::copy(Args.begin(), Args.end(), op_begin());
556 InvokeInst::InvokeInst(const InvokeInst &II)
557 : TerminatorInst(II.getType(), Instruction::Invoke,
558 OperandTraits<InvokeInst>::op_end(this)
559 - II.getNumOperands(),
560 II.getNumOperands()) {
561 setAttributes(II.getAttributes());
562 setCallingConv(II.getCallingConv());
563 std::copy(II.op_begin(), II.op_end(), op_begin());
564 SubclassOptionalData = II.SubclassOptionalData;
567 BasicBlock *InvokeInst::getSuccessorV(unsigned idx) const {
568 return getSuccessor(idx);
570 unsigned InvokeInst::getNumSuccessorsV() const {
571 return getNumSuccessors();
573 void InvokeInst::setSuccessorV(unsigned idx, BasicBlock *B) {
574 return setSuccessor(idx, B);
577 bool InvokeInst::hasFnAttrImpl(Attribute::AttrKind A) const {
578 if (AttributeList.hasAttribute(AttributeSet::FunctionIndex, A))
580 if (const Function *F = getCalledFunction())
581 return F->getAttributes().hasAttribute(AttributeSet::FunctionIndex, A);
585 bool InvokeInst::paramHasAttr(unsigned i, Attribute::AttrKind A) const {
586 if (AttributeList.hasAttribute(i, A))
588 if (const Function *F = getCalledFunction())
589 return F->getAttributes().hasAttribute(i, A);
593 void InvokeInst::addAttribute(unsigned i, Attribute::AttrKind attr) {
594 AttributeSet PAL = getAttributes();
595 PAL = PAL.addAttribute(getContext(), i, attr);
599 void InvokeInst::removeAttribute(unsigned i, Attribute attr) {
600 AttributeSet PAL = getAttributes();
602 PAL = PAL.removeAttributes(getContext(), i,
603 AttributeSet::get(getContext(), i, B));
607 LandingPadInst *InvokeInst::getLandingPadInst() const {
608 return cast<LandingPadInst>(getUnwindDest()->getFirstNonPHI());
611 //===----------------------------------------------------------------------===//
612 // ReturnInst Implementation
613 //===----------------------------------------------------------------------===//
615 ReturnInst::ReturnInst(const ReturnInst &RI)
616 : TerminatorInst(Type::getVoidTy(RI.getContext()), Instruction::Ret,
617 OperandTraits<ReturnInst>::op_end(this) -
619 RI.getNumOperands()) {
620 if (RI.getNumOperands())
621 Op<0>() = RI.Op<0>();
622 SubclassOptionalData = RI.SubclassOptionalData;
625 ReturnInst::ReturnInst(LLVMContext &C, Value *retVal, Instruction *InsertBefore)
626 : TerminatorInst(Type::getVoidTy(C), Instruction::Ret,
627 OperandTraits<ReturnInst>::op_end(this) - !!retVal, !!retVal,
632 ReturnInst::ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd)
633 : TerminatorInst(Type::getVoidTy(C), Instruction::Ret,
634 OperandTraits<ReturnInst>::op_end(this) - !!retVal, !!retVal,
639 ReturnInst::ReturnInst(LLVMContext &Context, BasicBlock *InsertAtEnd)
640 : TerminatorInst(Type::getVoidTy(Context), Instruction::Ret,
641 OperandTraits<ReturnInst>::op_end(this), 0, InsertAtEnd) {
644 unsigned ReturnInst::getNumSuccessorsV() const {
645 return getNumSuccessors();
648 /// Out-of-line ReturnInst method, put here so the C++ compiler can choose to
649 /// emit the vtable for the class in this translation unit.
650 void ReturnInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
651 llvm_unreachable("ReturnInst has no successors!");
654 BasicBlock *ReturnInst::getSuccessorV(unsigned idx) const {
655 llvm_unreachable("ReturnInst has no successors!");
658 ReturnInst::~ReturnInst() {
661 //===----------------------------------------------------------------------===//
662 // ResumeInst Implementation
663 //===----------------------------------------------------------------------===//
665 ResumeInst::ResumeInst(const ResumeInst &RI)
666 : TerminatorInst(Type::getVoidTy(RI.getContext()), Instruction::Resume,
667 OperandTraits<ResumeInst>::op_begin(this), 1) {
668 Op<0>() = RI.Op<0>();
671 ResumeInst::ResumeInst(Value *Exn, Instruction *InsertBefore)
672 : TerminatorInst(Type::getVoidTy(Exn->getContext()), Instruction::Resume,
673 OperandTraits<ResumeInst>::op_begin(this), 1, InsertBefore) {
677 ResumeInst::ResumeInst(Value *Exn, BasicBlock *InsertAtEnd)
678 : TerminatorInst(Type::getVoidTy(Exn->getContext()), Instruction::Resume,
679 OperandTraits<ResumeInst>::op_begin(this), 1, InsertAtEnd) {
683 unsigned ResumeInst::getNumSuccessorsV() const {
684 return getNumSuccessors();
687 void ResumeInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
688 llvm_unreachable("ResumeInst has no successors!");
691 BasicBlock *ResumeInst::getSuccessorV(unsigned idx) const {
692 llvm_unreachable("ResumeInst has no successors!");
695 //===----------------------------------------------------------------------===//
696 // UnreachableInst Implementation
697 //===----------------------------------------------------------------------===//
699 UnreachableInst::UnreachableInst(LLVMContext &Context,
700 Instruction *InsertBefore)
701 : TerminatorInst(Type::getVoidTy(Context), Instruction::Unreachable,
702 nullptr, 0, InsertBefore) {
704 UnreachableInst::UnreachableInst(LLVMContext &Context, BasicBlock *InsertAtEnd)
705 : TerminatorInst(Type::getVoidTy(Context), Instruction::Unreachable,
706 nullptr, 0, InsertAtEnd) {
709 unsigned UnreachableInst::getNumSuccessorsV() const {
710 return getNumSuccessors();
713 void UnreachableInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
714 llvm_unreachable("UnreachableInst has no successors!");
717 BasicBlock *UnreachableInst::getSuccessorV(unsigned idx) const {
718 llvm_unreachable("UnreachableInst has no successors!");
721 //===----------------------------------------------------------------------===//
722 // BranchInst Implementation
723 //===----------------------------------------------------------------------===//
725 void BranchInst::AssertOK() {
727 assert(getCondition()->getType()->isIntegerTy(1) &&
728 "May only branch on boolean predicates!");
731 BranchInst::BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore)
732 : TerminatorInst(Type::getVoidTy(IfTrue->getContext()), Instruction::Br,
733 OperandTraits<BranchInst>::op_end(this) - 1,
735 assert(IfTrue != 0 && "Branch destination may not be null!");
738 BranchInst::BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
739 Instruction *InsertBefore)
740 : TerminatorInst(Type::getVoidTy(IfTrue->getContext()), Instruction::Br,
741 OperandTraits<BranchInst>::op_end(this) - 3,
751 BranchInst::BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd)
752 : TerminatorInst(Type::getVoidTy(IfTrue->getContext()), Instruction::Br,
753 OperandTraits<BranchInst>::op_end(this) - 1,
755 assert(IfTrue != 0 && "Branch destination may not be null!");
759 BranchInst::BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
760 BasicBlock *InsertAtEnd)
761 : TerminatorInst(Type::getVoidTy(IfTrue->getContext()), Instruction::Br,
762 OperandTraits<BranchInst>::op_end(this) - 3,
773 BranchInst::BranchInst(const BranchInst &BI) :
774 TerminatorInst(Type::getVoidTy(BI.getContext()), Instruction::Br,
775 OperandTraits<BranchInst>::op_end(this) - BI.getNumOperands(),
776 BI.getNumOperands()) {
777 Op<-1>() = BI.Op<-1>();
778 if (BI.getNumOperands() != 1) {
779 assert(BI.getNumOperands() == 3 && "BR can have 1 or 3 operands!");
780 Op<-3>() = BI.Op<-3>();
781 Op<-2>() = BI.Op<-2>();
783 SubclassOptionalData = BI.SubclassOptionalData;
786 void BranchInst::swapSuccessors() {
787 assert(isConditional() &&
788 "Cannot swap successors of an unconditional branch");
789 Op<-1>().swap(Op<-2>());
791 // Update profile metadata if present and it matches our structural
793 MDNode *ProfileData = getMetadata(LLVMContext::MD_prof);
794 if (!ProfileData || ProfileData->getNumOperands() != 3)
797 // The first operand is the name. Fetch them backwards and build a new one.
799 ProfileData->getOperand(0),
800 ProfileData->getOperand(2),
801 ProfileData->getOperand(1)
803 setMetadata(LLVMContext::MD_prof,
804 MDNode::get(ProfileData->getContext(), Ops));
807 BasicBlock *BranchInst::getSuccessorV(unsigned idx) const {
808 return getSuccessor(idx);
810 unsigned BranchInst::getNumSuccessorsV() const {
811 return getNumSuccessors();
813 void BranchInst::setSuccessorV(unsigned idx, BasicBlock *B) {
814 setSuccessor(idx, B);
818 //===----------------------------------------------------------------------===//
819 // AllocaInst Implementation
820 //===----------------------------------------------------------------------===//
822 static Value *getAISize(LLVMContext &Context, Value *Amt) {
824 Amt = ConstantInt::get(Type::getInt32Ty(Context), 1);
826 assert(!isa<BasicBlock>(Amt) &&
827 "Passed basic block into allocation size parameter! Use other ctor");
828 assert(Amt->getType()->isIntegerTy() &&
829 "Allocation array size is not an integer!");
834 AllocaInst::AllocaInst(Type *Ty, Value *ArraySize,
835 const Twine &Name, Instruction *InsertBefore)
836 : UnaryInstruction(PointerType::getUnqual(Ty), Alloca,
837 getAISize(Ty->getContext(), ArraySize), InsertBefore) {
839 assert(!Ty->isVoidTy() && "Cannot allocate void!");
843 AllocaInst::AllocaInst(Type *Ty, Value *ArraySize,
844 const Twine &Name, BasicBlock *InsertAtEnd)
845 : UnaryInstruction(PointerType::getUnqual(Ty), Alloca,
846 getAISize(Ty->getContext(), ArraySize), InsertAtEnd) {
848 assert(!Ty->isVoidTy() && "Cannot allocate void!");
852 AllocaInst::AllocaInst(Type *Ty, const Twine &Name,
853 Instruction *InsertBefore)
854 : UnaryInstruction(PointerType::getUnqual(Ty), Alloca,
855 getAISize(Ty->getContext(), nullptr), InsertBefore) {
857 assert(!Ty->isVoidTy() && "Cannot allocate void!");
861 AllocaInst::AllocaInst(Type *Ty, const Twine &Name,
862 BasicBlock *InsertAtEnd)
863 : UnaryInstruction(PointerType::getUnqual(Ty), Alloca,
864 getAISize(Ty->getContext(), nullptr), InsertAtEnd) {
866 assert(!Ty->isVoidTy() && "Cannot allocate void!");
870 AllocaInst::AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
871 const Twine &Name, Instruction *InsertBefore)
872 : UnaryInstruction(PointerType::getUnqual(Ty), Alloca,
873 getAISize(Ty->getContext(), ArraySize), InsertBefore) {
875 assert(!Ty->isVoidTy() && "Cannot allocate void!");
879 AllocaInst::AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
880 const Twine &Name, BasicBlock *InsertAtEnd)
881 : UnaryInstruction(PointerType::getUnqual(Ty), Alloca,
882 getAISize(Ty->getContext(), ArraySize), InsertAtEnd) {
884 assert(!Ty->isVoidTy() && "Cannot allocate void!");
888 // Out of line virtual method, so the vtable, etc has a home.
889 AllocaInst::~AllocaInst() {
892 void AllocaInst::setAlignment(unsigned Align) {
893 assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
894 assert(Align <= MaximumAlignment &&
895 "Alignment is greater than MaximumAlignment!");
896 setInstructionSubclassData((getSubclassDataFromInstruction() & ~31) |
897 (Log2_32(Align) + 1));
898 assert(getAlignment() == Align && "Alignment representation error!");
901 bool AllocaInst::isArrayAllocation() const {
902 if (ConstantInt *CI = dyn_cast<ConstantInt>(getOperand(0)))
907 Type *AllocaInst::getAllocatedType() const {
908 return getType()->getElementType();
911 /// isStaticAlloca - Return true if this alloca is in the entry block of the
912 /// function and is a constant size. If so, the code generator will fold it
913 /// into the prolog/epilog code, so it is basically free.
914 bool AllocaInst::isStaticAlloca() const {
915 // Must be constant size.
916 if (!isa<ConstantInt>(getArraySize())) return false;
918 // Must be in the entry block.
919 const BasicBlock *Parent = getParent();
920 return Parent == &Parent->getParent()->front() && !isUsedWithInAlloca();
923 //===----------------------------------------------------------------------===//
924 // LoadInst Implementation
925 //===----------------------------------------------------------------------===//
927 void LoadInst::AssertOK() {
928 assert(getOperand(0)->getType()->isPointerTy() &&
929 "Ptr must have pointer type.");
930 assert(!(isAtomic() && getAlignment() == 0) &&
931 "Alignment required for atomic load");
934 LoadInst::LoadInst(Value *Ptr, const Twine &Name, Instruction *InsertBef)
935 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
936 Load, Ptr, InsertBef) {
939 setAtomic(NotAtomic);
944 LoadInst::LoadInst(Value *Ptr, const Twine &Name, BasicBlock *InsertAE)
945 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
946 Load, Ptr, InsertAE) {
949 setAtomic(NotAtomic);
954 LoadInst::LoadInst(Value *Ptr, const Twine &Name, bool isVolatile,
955 Instruction *InsertBef)
956 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
957 Load, Ptr, InsertBef) {
958 setVolatile(isVolatile);
960 setAtomic(NotAtomic);
965 LoadInst::LoadInst(Value *Ptr, const Twine &Name, bool isVolatile,
966 BasicBlock *InsertAE)
967 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
968 Load, Ptr, InsertAE) {
969 setVolatile(isVolatile);
971 setAtomic(NotAtomic);
976 LoadInst::LoadInst(Value *Ptr, const Twine &Name, bool isVolatile,
977 unsigned Align, Instruction *InsertBef)
978 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
979 Load, Ptr, InsertBef) {
980 setVolatile(isVolatile);
982 setAtomic(NotAtomic);
987 LoadInst::LoadInst(Value *Ptr, const Twine &Name, bool isVolatile,
988 unsigned Align, BasicBlock *InsertAE)
989 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
990 Load, Ptr, InsertAE) {
991 setVolatile(isVolatile);
993 setAtomic(NotAtomic);
998 LoadInst::LoadInst(Value *Ptr, const Twine &Name, bool isVolatile,
999 unsigned Align, AtomicOrdering Order,
1000 SynchronizationScope SynchScope,
1001 Instruction *InsertBef)
1002 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
1003 Load, Ptr, InsertBef) {
1004 setVolatile(isVolatile);
1005 setAlignment(Align);
1006 setAtomic(Order, SynchScope);
1011 LoadInst::LoadInst(Value *Ptr, const Twine &Name, bool isVolatile,
1012 unsigned Align, AtomicOrdering Order,
1013 SynchronizationScope SynchScope,
1014 BasicBlock *InsertAE)
1015 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
1016 Load, Ptr, InsertAE) {
1017 setVolatile(isVolatile);
1018 setAlignment(Align);
1019 setAtomic(Order, SynchScope);
1024 LoadInst::LoadInst(Value *Ptr, const char *Name, Instruction *InsertBef)
1025 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
1026 Load, Ptr, InsertBef) {
1029 setAtomic(NotAtomic);
1031 if (Name && Name[0]) setName(Name);
1034 LoadInst::LoadInst(Value *Ptr, const char *Name, BasicBlock *InsertAE)
1035 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
1036 Load, Ptr, InsertAE) {
1039 setAtomic(NotAtomic);
1041 if (Name && Name[0]) setName(Name);
1044 LoadInst::LoadInst(Value *Ptr, const char *Name, bool isVolatile,
1045 Instruction *InsertBef)
1046 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
1047 Load, Ptr, InsertBef) {
1048 setVolatile(isVolatile);
1050 setAtomic(NotAtomic);
1052 if (Name && Name[0]) setName(Name);
1055 LoadInst::LoadInst(Value *Ptr, const char *Name, bool isVolatile,
1056 BasicBlock *InsertAE)
1057 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
1058 Load, Ptr, InsertAE) {
1059 setVolatile(isVolatile);
1061 setAtomic(NotAtomic);
1063 if (Name && Name[0]) setName(Name);
1066 void LoadInst::setAlignment(unsigned Align) {
1067 assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
1068 assert(Align <= MaximumAlignment &&
1069 "Alignment is greater than MaximumAlignment!");
1070 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(31 << 1)) |
1071 ((Log2_32(Align)+1)<<1));
1072 assert(getAlignment() == Align && "Alignment representation error!");
1075 //===----------------------------------------------------------------------===//
1076 // StoreInst Implementation
1077 //===----------------------------------------------------------------------===//
1079 void StoreInst::AssertOK() {
1080 assert(getOperand(0) && getOperand(1) && "Both operands must be non-null!");
1081 assert(getOperand(1)->getType()->isPointerTy() &&
1082 "Ptr must have pointer type!");
1083 assert(getOperand(0)->getType() ==
1084 cast<PointerType>(getOperand(1)->getType())->getElementType()
1085 && "Ptr must be a pointer to Val type!");
1086 assert(!(isAtomic() && getAlignment() == 0) &&
1087 "Alignment required for atomic store");
1091 StoreInst::StoreInst(Value *val, Value *addr, Instruction *InsertBefore)
1092 : Instruction(Type::getVoidTy(val->getContext()), Store,
1093 OperandTraits<StoreInst>::op_begin(this),
1094 OperandTraits<StoreInst>::operands(this),
1100 setAtomic(NotAtomic);
1104 StoreInst::StoreInst(Value *val, Value *addr, BasicBlock *InsertAtEnd)
1105 : Instruction(Type::getVoidTy(val->getContext()), Store,
1106 OperandTraits<StoreInst>::op_begin(this),
1107 OperandTraits<StoreInst>::operands(this),
1113 setAtomic(NotAtomic);
1117 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
1118 Instruction *InsertBefore)
1119 : Instruction(Type::getVoidTy(val->getContext()), Store,
1120 OperandTraits<StoreInst>::op_begin(this),
1121 OperandTraits<StoreInst>::operands(this),
1125 setVolatile(isVolatile);
1127 setAtomic(NotAtomic);
1131 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
1132 unsigned Align, Instruction *InsertBefore)
1133 : Instruction(Type::getVoidTy(val->getContext()), Store,
1134 OperandTraits<StoreInst>::op_begin(this),
1135 OperandTraits<StoreInst>::operands(this),
1139 setVolatile(isVolatile);
1140 setAlignment(Align);
1141 setAtomic(NotAtomic);
1145 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
1146 unsigned Align, AtomicOrdering Order,
1147 SynchronizationScope SynchScope,
1148 Instruction *InsertBefore)
1149 : Instruction(Type::getVoidTy(val->getContext()), Store,
1150 OperandTraits<StoreInst>::op_begin(this),
1151 OperandTraits<StoreInst>::operands(this),
1155 setVolatile(isVolatile);
1156 setAlignment(Align);
1157 setAtomic(Order, SynchScope);
1161 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
1162 BasicBlock *InsertAtEnd)
1163 : Instruction(Type::getVoidTy(val->getContext()), Store,
1164 OperandTraits<StoreInst>::op_begin(this),
1165 OperandTraits<StoreInst>::operands(this),
1169 setVolatile(isVolatile);
1171 setAtomic(NotAtomic);
1175 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
1176 unsigned Align, BasicBlock *InsertAtEnd)
1177 : Instruction(Type::getVoidTy(val->getContext()), Store,
1178 OperandTraits<StoreInst>::op_begin(this),
1179 OperandTraits<StoreInst>::operands(this),
1183 setVolatile(isVolatile);
1184 setAlignment(Align);
1185 setAtomic(NotAtomic);
1189 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
1190 unsigned Align, AtomicOrdering Order,
1191 SynchronizationScope SynchScope,
1192 BasicBlock *InsertAtEnd)
1193 : Instruction(Type::getVoidTy(val->getContext()), Store,
1194 OperandTraits<StoreInst>::op_begin(this),
1195 OperandTraits<StoreInst>::operands(this),
1199 setVolatile(isVolatile);
1200 setAlignment(Align);
1201 setAtomic(Order, SynchScope);
1205 void StoreInst::setAlignment(unsigned Align) {
1206 assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
1207 assert(Align <= MaximumAlignment &&
1208 "Alignment is greater than MaximumAlignment!");
1209 setInstructionSubclassData((getSubclassDataFromInstruction() & ~(31 << 1)) |
1210 ((Log2_32(Align)+1) << 1));
1211 assert(getAlignment() == Align && "Alignment representation error!");
1214 //===----------------------------------------------------------------------===//
1215 // AtomicCmpXchgInst Implementation
1216 //===----------------------------------------------------------------------===//
1218 void AtomicCmpXchgInst::Init(Value *Ptr, Value *Cmp, Value *NewVal,
1219 AtomicOrdering SuccessOrdering,
1220 AtomicOrdering FailureOrdering,
1221 SynchronizationScope SynchScope) {
1225 setSuccessOrdering(SuccessOrdering);
1226 setFailureOrdering(FailureOrdering);
1227 setSynchScope(SynchScope);
1229 assert(getOperand(0) && getOperand(1) && getOperand(2) &&
1230 "All operands must be non-null!");
1231 assert(getOperand(0)->getType()->isPointerTy() &&
1232 "Ptr must have pointer type!");
1233 assert(getOperand(1)->getType() ==
1234 cast<PointerType>(getOperand(0)->getType())->getElementType()
1235 && "Ptr must be a pointer to Cmp type!");
1236 assert(getOperand(2)->getType() ==
1237 cast<PointerType>(getOperand(0)->getType())->getElementType()
1238 && "Ptr must be a pointer to NewVal type!");
1239 assert(SuccessOrdering != NotAtomic &&
1240 "AtomicCmpXchg instructions must be atomic!");
1241 assert(FailureOrdering != NotAtomic &&
1242 "AtomicCmpXchg instructions must be atomic!");
1243 assert(SuccessOrdering >= FailureOrdering &&
1244 "AtomicCmpXchg success ordering must be at least as strong as fail");
1245 assert(FailureOrdering != Release && FailureOrdering != AcquireRelease &&
1246 "AtomicCmpXchg failure ordering cannot include release semantics");
1249 AtomicCmpXchgInst::AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
1250 AtomicOrdering SuccessOrdering,
1251 AtomicOrdering FailureOrdering,
1252 SynchronizationScope SynchScope,
1253 Instruction *InsertBefore)
1254 : Instruction(Cmp->getType(), AtomicCmpXchg,
1255 OperandTraits<AtomicCmpXchgInst>::op_begin(this),
1256 OperandTraits<AtomicCmpXchgInst>::operands(this),
1258 Init(Ptr, Cmp, NewVal, SuccessOrdering, FailureOrdering, SynchScope);
1261 AtomicCmpXchgInst::AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
1262 AtomicOrdering SuccessOrdering,
1263 AtomicOrdering FailureOrdering,
1264 SynchronizationScope SynchScope,
1265 BasicBlock *InsertAtEnd)
1266 : Instruction(Cmp->getType(), AtomicCmpXchg,
1267 OperandTraits<AtomicCmpXchgInst>::op_begin(this),
1268 OperandTraits<AtomicCmpXchgInst>::operands(this),
1270 Init(Ptr, Cmp, NewVal, SuccessOrdering, FailureOrdering, SynchScope);
1273 //===----------------------------------------------------------------------===//
1274 // AtomicRMWInst Implementation
1275 //===----------------------------------------------------------------------===//
1277 void AtomicRMWInst::Init(BinOp Operation, Value *Ptr, Value *Val,
1278 AtomicOrdering Ordering,
1279 SynchronizationScope SynchScope) {
1282 setOperation(Operation);
1283 setOrdering(Ordering);
1284 setSynchScope(SynchScope);
1286 assert(getOperand(0) && getOperand(1) &&
1287 "All operands must be non-null!");
1288 assert(getOperand(0)->getType()->isPointerTy() &&
1289 "Ptr must have pointer type!");
1290 assert(getOperand(1)->getType() ==
1291 cast<PointerType>(getOperand(0)->getType())->getElementType()
1292 && "Ptr must be a pointer to Val type!");
1293 assert(Ordering != NotAtomic &&
1294 "AtomicRMW instructions must be atomic!");
1297 AtomicRMWInst::AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
1298 AtomicOrdering Ordering,
1299 SynchronizationScope SynchScope,
1300 Instruction *InsertBefore)
1301 : Instruction(Val->getType(), AtomicRMW,
1302 OperandTraits<AtomicRMWInst>::op_begin(this),
1303 OperandTraits<AtomicRMWInst>::operands(this),
1305 Init(Operation, Ptr, Val, Ordering, SynchScope);
1308 AtomicRMWInst::AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
1309 AtomicOrdering Ordering,
1310 SynchronizationScope SynchScope,
1311 BasicBlock *InsertAtEnd)
1312 : Instruction(Val->getType(), AtomicRMW,
1313 OperandTraits<AtomicRMWInst>::op_begin(this),
1314 OperandTraits<AtomicRMWInst>::operands(this),
1316 Init(Operation, Ptr, Val, Ordering, SynchScope);
1319 //===----------------------------------------------------------------------===//
1320 // FenceInst Implementation
1321 //===----------------------------------------------------------------------===//
1323 FenceInst::FenceInst(LLVMContext &C, AtomicOrdering Ordering,
1324 SynchronizationScope SynchScope,
1325 Instruction *InsertBefore)
1326 : Instruction(Type::getVoidTy(C), Fence, nullptr, 0, InsertBefore) {
1327 setOrdering(Ordering);
1328 setSynchScope(SynchScope);
1331 FenceInst::FenceInst(LLVMContext &C, AtomicOrdering Ordering,
1332 SynchronizationScope SynchScope,
1333 BasicBlock *InsertAtEnd)
1334 : Instruction(Type::getVoidTy(C), Fence, nullptr, 0, InsertAtEnd) {
1335 setOrdering(Ordering);
1336 setSynchScope(SynchScope);
1339 //===----------------------------------------------------------------------===//
1340 // GetElementPtrInst Implementation
1341 //===----------------------------------------------------------------------===//
1343 void GetElementPtrInst::init(Value *Ptr, ArrayRef<Value *> IdxList,
1344 const Twine &Name) {
1345 assert(NumOperands == 1 + IdxList.size() && "NumOperands not initialized?");
1346 OperandList[0] = Ptr;
1347 std::copy(IdxList.begin(), IdxList.end(), op_begin() + 1);
1351 GetElementPtrInst::GetElementPtrInst(const GetElementPtrInst &GEPI)
1352 : Instruction(GEPI.getType(), GetElementPtr,
1353 OperandTraits<GetElementPtrInst>::op_end(this)
1354 - GEPI.getNumOperands(),
1355 GEPI.getNumOperands()) {
1356 std::copy(GEPI.op_begin(), GEPI.op_end(), op_begin());
1357 SubclassOptionalData = GEPI.SubclassOptionalData;
1360 /// getIndexedType - Returns the type of the element that would be accessed with
1361 /// a gep instruction with the specified parameters.
1363 /// The Idxs pointer should point to a continuous piece of memory containing the
1364 /// indices, either as Value* or uint64_t.
1366 /// A null type is returned if the indices are invalid for the specified
1369 template <typename IndexTy>
1370 static Type *getIndexedTypeInternal(Type *Ptr, ArrayRef<IndexTy> IdxList) {
1371 PointerType *PTy = dyn_cast<PointerType>(Ptr->getScalarType());
1372 if (!PTy) return nullptr; // Type isn't a pointer type!
1373 Type *Agg = PTy->getElementType();
1375 // Handle the special case of the empty set index set, which is always valid.
1376 if (IdxList.empty())
1379 // If there is at least one index, the top level type must be sized, otherwise
1380 // it cannot be 'stepped over'.
1381 if (!Agg->isSized())
1384 unsigned CurIdx = 1;
1385 for (; CurIdx != IdxList.size(); ++CurIdx) {
1386 CompositeType *CT = dyn_cast<CompositeType>(Agg);
1387 if (!CT || CT->isPointerTy()) return nullptr;
1388 IndexTy Index = IdxList[CurIdx];
1389 if (!CT->indexValid(Index)) return nullptr;
1390 Agg = CT->getTypeAtIndex(Index);
1392 return CurIdx == IdxList.size() ? Agg : nullptr;
1395 Type *GetElementPtrInst::getIndexedType(Type *Ptr, ArrayRef<Value *> IdxList) {
1396 return getIndexedTypeInternal(Ptr, IdxList);
1399 Type *GetElementPtrInst::getIndexedType(Type *Ptr,
1400 ArrayRef<Constant *> IdxList) {
1401 return getIndexedTypeInternal(Ptr, IdxList);
1404 Type *GetElementPtrInst::getIndexedType(Type *Ptr, ArrayRef<uint64_t> IdxList) {
1405 return getIndexedTypeInternal(Ptr, IdxList);
1408 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
1409 /// zeros. If so, the result pointer and the first operand have the same
1410 /// value, just potentially different types.
1411 bool GetElementPtrInst::hasAllZeroIndices() const {
1412 for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1413 if (ConstantInt *CI = dyn_cast<ConstantInt>(getOperand(i))) {
1414 if (!CI->isZero()) return false;
1422 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
1423 /// constant integers. If so, the result pointer and the first operand have
1424 /// a constant offset between them.
1425 bool GetElementPtrInst::hasAllConstantIndices() const {
1426 for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1427 if (!isa<ConstantInt>(getOperand(i)))
1433 void GetElementPtrInst::setIsInBounds(bool B) {
1434 cast<GEPOperator>(this)->setIsInBounds(B);
1437 bool GetElementPtrInst::isInBounds() const {
1438 return cast<GEPOperator>(this)->isInBounds();
1441 bool GetElementPtrInst::accumulateConstantOffset(const DataLayout &DL,
1442 APInt &Offset) const {
1443 // Delegate to the generic GEPOperator implementation.
1444 return cast<GEPOperator>(this)->accumulateConstantOffset(DL, Offset);
1447 //===----------------------------------------------------------------------===//
1448 // ExtractElementInst Implementation
1449 //===----------------------------------------------------------------------===//
1451 ExtractElementInst::ExtractElementInst(Value *Val, Value *Index,
1453 Instruction *InsertBef)
1454 : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1456 OperandTraits<ExtractElementInst>::op_begin(this),
1458 assert(isValidOperands(Val, Index) &&
1459 "Invalid extractelement instruction operands!");
1465 ExtractElementInst::ExtractElementInst(Value *Val, Value *Index,
1467 BasicBlock *InsertAE)
1468 : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1470 OperandTraits<ExtractElementInst>::op_begin(this),
1472 assert(isValidOperands(Val, Index) &&
1473 "Invalid extractelement instruction operands!");
1481 bool ExtractElementInst::isValidOperands(const Value *Val, const Value *Index) {
1482 if (!Val->getType()->isVectorTy() || !Index->getType()->isIntegerTy(32))
1488 //===----------------------------------------------------------------------===//
1489 // InsertElementInst Implementation
1490 //===----------------------------------------------------------------------===//
1492 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, Value *Index,
1494 Instruction *InsertBef)
1495 : Instruction(Vec->getType(), InsertElement,
1496 OperandTraits<InsertElementInst>::op_begin(this),
1498 assert(isValidOperands(Vec, Elt, Index) &&
1499 "Invalid insertelement instruction operands!");
1506 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, Value *Index,
1508 BasicBlock *InsertAE)
1509 : Instruction(Vec->getType(), InsertElement,
1510 OperandTraits<InsertElementInst>::op_begin(this),
1512 assert(isValidOperands(Vec, Elt, Index) &&
1513 "Invalid insertelement instruction operands!");
1521 bool InsertElementInst::isValidOperands(const Value *Vec, const Value *Elt,
1522 const Value *Index) {
1523 if (!Vec->getType()->isVectorTy())
1524 return false; // First operand of insertelement must be vector type.
1526 if (Elt->getType() != cast<VectorType>(Vec->getType())->getElementType())
1527 return false;// Second operand of insertelement must be vector element type.
1529 if (!Index->getType()->isIntegerTy(32))
1530 return false; // Third operand of insertelement must be i32.
1535 //===----------------------------------------------------------------------===//
1536 // ShuffleVectorInst Implementation
1537 //===----------------------------------------------------------------------===//
1539 ShuffleVectorInst::ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1541 Instruction *InsertBefore)
1542 : Instruction(VectorType::get(cast<VectorType>(V1->getType())->getElementType(),
1543 cast<VectorType>(Mask->getType())->getNumElements()),
1545 OperandTraits<ShuffleVectorInst>::op_begin(this),
1546 OperandTraits<ShuffleVectorInst>::operands(this),
1548 assert(isValidOperands(V1, V2, Mask) &&
1549 "Invalid shuffle vector instruction operands!");
1556 ShuffleVectorInst::ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1558 BasicBlock *InsertAtEnd)
1559 : Instruction(VectorType::get(cast<VectorType>(V1->getType())->getElementType(),
1560 cast<VectorType>(Mask->getType())->getNumElements()),
1562 OperandTraits<ShuffleVectorInst>::op_begin(this),
1563 OperandTraits<ShuffleVectorInst>::operands(this),
1565 assert(isValidOperands(V1, V2, Mask) &&
1566 "Invalid shuffle vector instruction operands!");
1574 bool ShuffleVectorInst::isValidOperands(const Value *V1, const Value *V2,
1575 const Value *Mask) {
1576 // V1 and V2 must be vectors of the same type.
1577 if (!V1->getType()->isVectorTy() || V1->getType() != V2->getType())
1580 // Mask must be vector of i32.
1581 VectorType *MaskTy = dyn_cast<VectorType>(Mask->getType());
1582 if (!MaskTy || !MaskTy->getElementType()->isIntegerTy(32))
1585 // Check to see if Mask is valid.
1586 if (isa<UndefValue>(Mask) || isa<ConstantAggregateZero>(Mask))
1589 if (const ConstantVector *MV = dyn_cast<ConstantVector>(Mask)) {
1590 unsigned V1Size = cast<VectorType>(V1->getType())->getNumElements();
1591 for (Value *Op : MV->operands()) {
1592 if (ConstantInt *CI = dyn_cast<ConstantInt>(Op)) {
1593 if (CI->uge(V1Size*2))
1595 } else if (!isa<UndefValue>(Op)) {
1602 if (const ConstantDataSequential *CDS =
1603 dyn_cast<ConstantDataSequential>(Mask)) {
1604 unsigned V1Size = cast<VectorType>(V1->getType())->getNumElements();
1605 for (unsigned i = 0, e = MaskTy->getNumElements(); i != e; ++i)
1606 if (CDS->getElementAsInteger(i) >= V1Size*2)
1611 // The bitcode reader can create a place holder for a forward reference
1612 // used as the shuffle mask. When this occurs, the shuffle mask will
1613 // fall into this case and fail. To avoid this error, do this bit of
1614 // ugliness to allow such a mask pass.
1615 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(Mask))
1616 if (CE->getOpcode() == Instruction::UserOp1)
1622 /// getMaskValue - Return the index from the shuffle mask for the specified
1623 /// output result. This is either -1 if the element is undef or a number less
1624 /// than 2*numelements.
1625 int ShuffleVectorInst::getMaskValue(Constant *Mask, unsigned i) {
1626 assert(i < Mask->getType()->getVectorNumElements() && "Index out of range");
1627 if (ConstantDataSequential *CDS =dyn_cast<ConstantDataSequential>(Mask))
1628 return CDS->getElementAsInteger(i);
1629 Constant *C = Mask->getAggregateElement(i);
1630 if (isa<UndefValue>(C))
1632 return cast<ConstantInt>(C)->getZExtValue();
1635 /// getShuffleMask - Return the full mask for this instruction, where each
1636 /// element is the element number and undef's are returned as -1.
1637 void ShuffleVectorInst::getShuffleMask(Constant *Mask,
1638 SmallVectorImpl<int> &Result) {
1639 unsigned NumElts = Mask->getType()->getVectorNumElements();
1641 if (ConstantDataSequential *CDS=dyn_cast<ConstantDataSequential>(Mask)) {
1642 for (unsigned i = 0; i != NumElts; ++i)
1643 Result.push_back(CDS->getElementAsInteger(i));
1646 for (unsigned i = 0; i != NumElts; ++i) {
1647 Constant *C = Mask->getAggregateElement(i);
1648 Result.push_back(isa<UndefValue>(C) ? -1 :
1649 cast<ConstantInt>(C)->getZExtValue());
1654 //===----------------------------------------------------------------------===//
1655 // InsertValueInst Class
1656 //===----------------------------------------------------------------------===//
1658 void InsertValueInst::init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
1659 const Twine &Name) {
1660 assert(NumOperands == 2 && "NumOperands not initialized?");
1662 // There's no fundamental reason why we require at least one index
1663 // (other than weirdness with &*IdxBegin being invalid; see
1664 // getelementptr's init routine for example). But there's no
1665 // present need to support it.
1666 assert(Idxs.size() > 0 && "InsertValueInst must have at least one index");
1668 assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs) ==
1669 Val->getType() && "Inserted value must match indexed type!");
1673 Indices.append(Idxs.begin(), Idxs.end());
1677 InsertValueInst::InsertValueInst(const InsertValueInst &IVI)
1678 : Instruction(IVI.getType(), InsertValue,
1679 OperandTraits<InsertValueInst>::op_begin(this), 2),
1680 Indices(IVI.Indices) {
1681 Op<0>() = IVI.getOperand(0);
1682 Op<1>() = IVI.getOperand(1);
1683 SubclassOptionalData = IVI.SubclassOptionalData;
1686 //===----------------------------------------------------------------------===//
1687 // ExtractValueInst Class
1688 //===----------------------------------------------------------------------===//
1690 void ExtractValueInst::init(ArrayRef<unsigned> Idxs, const Twine &Name) {
1691 assert(NumOperands == 1 && "NumOperands not initialized?");
1693 // There's no fundamental reason why we require at least one index.
1694 // But there's no present need to support it.
1695 assert(Idxs.size() > 0 && "ExtractValueInst must have at least one index");
1697 Indices.append(Idxs.begin(), Idxs.end());
1701 ExtractValueInst::ExtractValueInst(const ExtractValueInst &EVI)
1702 : UnaryInstruction(EVI.getType(), ExtractValue, EVI.getOperand(0)),
1703 Indices(EVI.Indices) {
1704 SubclassOptionalData = EVI.SubclassOptionalData;
1707 // getIndexedType - Returns the type of the element that would be extracted
1708 // with an extractvalue instruction with the specified parameters.
1710 // A null type is returned if the indices are invalid for the specified
1713 Type *ExtractValueInst::getIndexedType(Type *Agg,
1714 ArrayRef<unsigned> Idxs) {
1715 for (unsigned Index : Idxs) {
1716 // We can't use CompositeType::indexValid(Index) here.
1717 // indexValid() always returns true for arrays because getelementptr allows
1718 // out-of-bounds indices. Since we don't allow those for extractvalue and
1719 // insertvalue we need to check array indexing manually.
1720 // Since the only other types we can index into are struct types it's just
1721 // as easy to check those manually as well.
1722 if (ArrayType *AT = dyn_cast<ArrayType>(Agg)) {
1723 if (Index >= AT->getNumElements())
1725 } else if (StructType *ST = dyn_cast<StructType>(Agg)) {
1726 if (Index >= ST->getNumElements())
1729 // Not a valid type to index into.
1733 Agg = cast<CompositeType>(Agg)->getTypeAtIndex(Index);
1735 return const_cast<Type*>(Agg);
1738 //===----------------------------------------------------------------------===//
1739 // BinaryOperator Class
1740 //===----------------------------------------------------------------------===//
1742 BinaryOperator::BinaryOperator(BinaryOps iType, Value *S1, Value *S2,
1743 Type *Ty, const Twine &Name,
1744 Instruction *InsertBefore)
1745 : Instruction(Ty, iType,
1746 OperandTraits<BinaryOperator>::op_begin(this),
1747 OperandTraits<BinaryOperator>::operands(this),
1755 BinaryOperator::BinaryOperator(BinaryOps iType, Value *S1, Value *S2,
1756 Type *Ty, const Twine &Name,
1757 BasicBlock *InsertAtEnd)
1758 : Instruction(Ty, iType,
1759 OperandTraits<BinaryOperator>::op_begin(this),
1760 OperandTraits<BinaryOperator>::operands(this),
1769 void BinaryOperator::init(BinaryOps iType) {
1770 Value *LHS = getOperand(0), *RHS = getOperand(1);
1771 (void)LHS; (void)RHS; // Silence warnings.
1772 assert(LHS->getType() == RHS->getType() &&
1773 "Binary operator operand types must match!");
1778 assert(getType() == LHS->getType() &&
1779 "Arithmetic operation should return same type as operands!");
1780 assert(getType()->isIntOrIntVectorTy() &&
1781 "Tried to create an integer operation on a non-integer type!");
1783 case FAdd: case FSub:
1785 assert(getType() == LHS->getType() &&
1786 "Arithmetic operation should return same type as operands!");
1787 assert(getType()->isFPOrFPVectorTy() &&
1788 "Tried to create a floating-point operation on a "
1789 "non-floating-point type!");
1793 assert(getType() == LHS->getType() &&
1794 "Arithmetic operation should return same type as operands!");
1795 assert((getType()->isIntegerTy() || (getType()->isVectorTy() &&
1796 cast<VectorType>(getType())->getElementType()->isIntegerTy())) &&
1797 "Incorrect operand type (not integer) for S/UDIV");
1800 assert(getType() == LHS->getType() &&
1801 "Arithmetic operation should return same type as operands!");
1802 assert(getType()->isFPOrFPVectorTy() &&
1803 "Incorrect operand type (not floating point) for FDIV");
1807 assert(getType() == LHS->getType() &&
1808 "Arithmetic operation should return same type as operands!");
1809 assert((getType()->isIntegerTy() || (getType()->isVectorTy() &&
1810 cast<VectorType>(getType())->getElementType()->isIntegerTy())) &&
1811 "Incorrect operand type (not integer) for S/UREM");
1814 assert(getType() == LHS->getType() &&
1815 "Arithmetic operation should return same type as operands!");
1816 assert(getType()->isFPOrFPVectorTy() &&
1817 "Incorrect operand type (not floating point) for FREM");
1822 assert(getType() == LHS->getType() &&
1823 "Shift operation should return same type as operands!");
1824 assert((getType()->isIntegerTy() ||
1825 (getType()->isVectorTy() &&
1826 cast<VectorType>(getType())->getElementType()->isIntegerTy())) &&
1827 "Tried to create a shift operation on a non-integral type!");
1831 assert(getType() == LHS->getType() &&
1832 "Logical operation should return same type as operands!");
1833 assert((getType()->isIntegerTy() ||
1834 (getType()->isVectorTy() &&
1835 cast<VectorType>(getType())->getElementType()->isIntegerTy())) &&
1836 "Tried to create a logical operation on a non-integral type!");
1844 BinaryOperator *BinaryOperator::Create(BinaryOps Op, Value *S1, Value *S2,
1846 Instruction *InsertBefore) {
1847 assert(S1->getType() == S2->getType() &&
1848 "Cannot create binary operator with two operands of differing type!");
1849 return new BinaryOperator(Op, S1, S2, S1->getType(), Name, InsertBefore);
1852 BinaryOperator *BinaryOperator::Create(BinaryOps Op, Value *S1, Value *S2,
1854 BasicBlock *InsertAtEnd) {
1855 BinaryOperator *Res = Create(Op, S1, S2, Name);
1856 InsertAtEnd->getInstList().push_back(Res);
1860 BinaryOperator *BinaryOperator::CreateNeg(Value *Op, const Twine &Name,
1861 Instruction *InsertBefore) {
1862 Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1863 return new BinaryOperator(Instruction::Sub,
1865 Op->getType(), Name, InsertBefore);
1868 BinaryOperator *BinaryOperator::CreateNeg(Value *Op, const Twine &Name,
1869 BasicBlock *InsertAtEnd) {
1870 Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1871 return new BinaryOperator(Instruction::Sub,
1873 Op->getType(), Name, InsertAtEnd);
1876 BinaryOperator *BinaryOperator::CreateNSWNeg(Value *Op, const Twine &Name,
1877 Instruction *InsertBefore) {
1878 Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1879 return BinaryOperator::CreateNSWSub(zero, Op, Name, InsertBefore);
1882 BinaryOperator *BinaryOperator::CreateNSWNeg(Value *Op, const Twine &Name,
1883 BasicBlock *InsertAtEnd) {
1884 Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1885 return BinaryOperator::CreateNSWSub(zero, Op, Name, InsertAtEnd);
1888 BinaryOperator *BinaryOperator::CreateNUWNeg(Value *Op, const Twine &Name,
1889 Instruction *InsertBefore) {
1890 Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1891 return BinaryOperator::CreateNUWSub(zero, Op, Name, InsertBefore);
1894 BinaryOperator *BinaryOperator::CreateNUWNeg(Value *Op, const Twine &Name,
1895 BasicBlock *InsertAtEnd) {
1896 Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1897 return BinaryOperator::CreateNUWSub(zero, Op, Name, InsertAtEnd);
1900 BinaryOperator *BinaryOperator::CreateFNeg(Value *Op, const Twine &Name,
1901 Instruction *InsertBefore) {
1902 Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1903 return new BinaryOperator(Instruction::FSub, zero, Op,
1904 Op->getType(), Name, InsertBefore);
1907 BinaryOperator *BinaryOperator::CreateFNeg(Value *Op, const Twine &Name,
1908 BasicBlock *InsertAtEnd) {
1909 Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1910 return new BinaryOperator(Instruction::FSub, zero, Op,
1911 Op->getType(), Name, InsertAtEnd);
1914 BinaryOperator *BinaryOperator::CreateNot(Value *Op, const Twine &Name,
1915 Instruction *InsertBefore) {
1916 Constant *C = Constant::getAllOnesValue(Op->getType());
1917 return new BinaryOperator(Instruction::Xor, Op, C,
1918 Op->getType(), Name, InsertBefore);
1921 BinaryOperator *BinaryOperator::CreateNot(Value *Op, const Twine &Name,
1922 BasicBlock *InsertAtEnd) {
1923 Constant *AllOnes = Constant::getAllOnesValue(Op->getType());
1924 return new BinaryOperator(Instruction::Xor, Op, AllOnes,
1925 Op->getType(), Name, InsertAtEnd);
1929 // isConstantAllOnes - Helper function for several functions below
1930 static inline bool isConstantAllOnes(const Value *V) {
1931 if (const Constant *C = dyn_cast<Constant>(V))
1932 return C->isAllOnesValue();
1936 bool BinaryOperator::isNeg(const Value *V) {
1937 if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
1938 if (Bop->getOpcode() == Instruction::Sub)
1939 if (Constant* C = dyn_cast<Constant>(Bop->getOperand(0)))
1940 return C->isNegativeZeroValue();
1944 bool BinaryOperator::isFNeg(const Value *V, bool IgnoreZeroSign) {
1945 if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
1946 if (Bop->getOpcode() == Instruction::FSub)
1947 if (Constant* C = dyn_cast<Constant>(Bop->getOperand(0))) {
1948 if (!IgnoreZeroSign)
1949 IgnoreZeroSign = cast<Instruction>(V)->hasNoSignedZeros();
1950 return !IgnoreZeroSign ? C->isNegativeZeroValue() : C->isZeroValue();
1955 bool BinaryOperator::isNot(const Value *V) {
1956 if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
1957 return (Bop->getOpcode() == Instruction::Xor &&
1958 (isConstantAllOnes(Bop->getOperand(1)) ||
1959 isConstantAllOnes(Bop->getOperand(0))));
1963 Value *BinaryOperator::getNegArgument(Value *BinOp) {
1964 return cast<BinaryOperator>(BinOp)->getOperand(1);
1967 const Value *BinaryOperator::getNegArgument(const Value *BinOp) {
1968 return getNegArgument(const_cast<Value*>(BinOp));
1971 Value *BinaryOperator::getFNegArgument(Value *BinOp) {
1972 return cast<BinaryOperator>(BinOp)->getOperand(1);
1975 const Value *BinaryOperator::getFNegArgument(const Value *BinOp) {
1976 return getFNegArgument(const_cast<Value*>(BinOp));
1979 Value *BinaryOperator::getNotArgument(Value *BinOp) {
1980 assert(isNot(BinOp) && "getNotArgument on non-'not' instruction!");
1981 BinaryOperator *BO = cast<BinaryOperator>(BinOp);
1982 Value *Op0 = BO->getOperand(0);
1983 Value *Op1 = BO->getOperand(1);
1984 if (isConstantAllOnes(Op0)) return Op1;
1986 assert(isConstantAllOnes(Op1));
1990 const Value *BinaryOperator::getNotArgument(const Value *BinOp) {
1991 return getNotArgument(const_cast<Value*>(BinOp));
1995 // swapOperands - Exchange the two operands to this instruction. This
1996 // instruction is safe to use on any binary instruction and does not
1997 // modify the semantics of the instruction. If the instruction is
1998 // order dependent (SetLT f.e.) the opcode is changed.
2000 bool BinaryOperator::swapOperands() {
2001 if (!isCommutative())
2002 return true; // Can't commute operands
2003 Op<0>().swap(Op<1>());
2007 void BinaryOperator::setHasNoUnsignedWrap(bool b) {
2008 cast<OverflowingBinaryOperator>(this)->setHasNoUnsignedWrap(b);
2011 void BinaryOperator::setHasNoSignedWrap(bool b) {
2012 cast<OverflowingBinaryOperator>(this)->setHasNoSignedWrap(b);
2015 void BinaryOperator::setIsExact(bool b) {
2016 cast<PossiblyExactOperator>(this)->setIsExact(b);
2019 bool BinaryOperator::hasNoUnsignedWrap() const {
2020 return cast<OverflowingBinaryOperator>(this)->hasNoUnsignedWrap();
2023 bool BinaryOperator::hasNoSignedWrap() const {
2024 return cast<OverflowingBinaryOperator>(this)->hasNoSignedWrap();
2027 bool BinaryOperator::isExact() const {
2028 return cast<PossiblyExactOperator>(this)->isExact();
2031 //===----------------------------------------------------------------------===//
2032 // FPMathOperator Class
2033 //===----------------------------------------------------------------------===//
2035 /// getFPAccuracy - Get the maximum error permitted by this operation in ULPs.
2036 /// An accuracy of 0.0 means that the operation should be performed with the
2037 /// default precision.
2038 float FPMathOperator::getFPAccuracy() const {
2040 cast<Instruction>(this)->getMetadata(LLVMContext::MD_fpmath);
2043 ConstantFP *Accuracy = cast<ConstantFP>(MD->getOperand(0));
2044 return Accuracy->getValueAPF().convertToFloat();
2048 //===----------------------------------------------------------------------===//
2050 //===----------------------------------------------------------------------===//
2052 void CastInst::anchor() {}
2054 // Just determine if this cast only deals with integral->integral conversion.
2055 bool CastInst::isIntegerCast() const {
2056 switch (getOpcode()) {
2057 default: return false;
2058 case Instruction::ZExt:
2059 case Instruction::SExt:
2060 case Instruction::Trunc:
2062 case Instruction::BitCast:
2063 return getOperand(0)->getType()->isIntegerTy() &&
2064 getType()->isIntegerTy();
2068 bool CastInst::isLosslessCast() const {
2069 // Only BitCast can be lossless, exit fast if we're not BitCast
2070 if (getOpcode() != Instruction::BitCast)
2073 // Identity cast is always lossless
2074 Type* SrcTy = getOperand(0)->getType();
2075 Type* DstTy = getType();
2079 // Pointer to pointer is always lossless.
2080 if (SrcTy->isPointerTy())
2081 return DstTy->isPointerTy();
2082 return false; // Other types have no identity values
2085 /// This function determines if the CastInst does not require any bits to be
2086 /// changed in order to effect the cast. Essentially, it identifies cases where
2087 /// no code gen is necessary for the cast, hence the name no-op cast. For
2088 /// example, the following are all no-op casts:
2089 /// # bitcast i32* %x to i8*
2090 /// # bitcast <2 x i32> %x to <4 x i16>
2091 /// # ptrtoint i32* %x to i32 ; on 32-bit plaforms only
2092 /// @brief Determine if the described cast is a no-op.
2093 bool CastInst::isNoopCast(Instruction::CastOps Opcode,
2098 default: llvm_unreachable("Invalid CastOp");
2099 case Instruction::Trunc:
2100 case Instruction::ZExt:
2101 case Instruction::SExt:
2102 case Instruction::FPTrunc:
2103 case Instruction::FPExt:
2104 case Instruction::UIToFP:
2105 case Instruction::SIToFP:
2106 case Instruction::FPToUI:
2107 case Instruction::FPToSI:
2108 case Instruction::AddrSpaceCast:
2109 // TODO: Target informations may give a more accurate answer here.
2111 case Instruction::BitCast:
2112 return true; // BitCast never modifies bits.
2113 case Instruction::PtrToInt:
2114 return IntPtrTy->getScalarSizeInBits() ==
2115 DestTy->getScalarSizeInBits();
2116 case Instruction::IntToPtr:
2117 return IntPtrTy->getScalarSizeInBits() ==
2118 SrcTy->getScalarSizeInBits();
2122 /// @brief Determine if a cast is a no-op.
2123 bool CastInst::isNoopCast(Type *IntPtrTy) const {
2124 return isNoopCast(getOpcode(), getOperand(0)->getType(), getType(), IntPtrTy);
2127 bool CastInst::isNoopCast(const DataLayout *DL) const {
2129 // Assume maximum pointer size.
2130 return isNoopCast(Type::getInt64Ty(getContext()));
2133 Type *PtrOpTy = nullptr;
2134 if (getOpcode() == Instruction::PtrToInt)
2135 PtrOpTy = getOperand(0)->getType();
2136 else if (getOpcode() == Instruction::IntToPtr)
2137 PtrOpTy = getType();
2139 Type *IntPtrTy = PtrOpTy
2140 ? DL->getIntPtrType(PtrOpTy)
2141 : DL->getIntPtrType(getContext(), 0);
2143 return isNoopCast(getOpcode(), getOperand(0)->getType(), getType(), IntPtrTy);
2146 /// This function determines if a pair of casts can be eliminated and what
2147 /// opcode should be used in the elimination. This assumes that there are two
2148 /// instructions like this:
2149 /// * %F = firstOpcode SrcTy %x to MidTy
2150 /// * %S = secondOpcode MidTy %F to DstTy
2151 /// The function returns a resultOpcode so these two casts can be replaced with:
2152 /// * %Replacement = resultOpcode %SrcTy %x to DstTy
2153 /// If no such cast is permited, the function returns 0.
2154 unsigned CastInst::isEliminableCastPair(
2155 Instruction::CastOps firstOp, Instruction::CastOps secondOp,
2156 Type *SrcTy, Type *MidTy, Type *DstTy, Type *SrcIntPtrTy, Type *MidIntPtrTy,
2157 Type *DstIntPtrTy) {
2158 // Define the 144 possibilities for these two cast instructions. The values
2159 // in this matrix determine what to do in a given situation and select the
2160 // case in the switch below. The rows correspond to firstOp, the columns
2161 // correspond to secondOp. In looking at the table below, keep in mind
2162 // the following cast properties:
2164 // Size Compare Source Destination
2165 // Operator Src ? Size Type Sign Type Sign
2166 // -------- ------------ ------------------- ---------------------
2167 // TRUNC > Integer Any Integral Any
2168 // ZEXT < Integral Unsigned Integer Any
2169 // SEXT < Integral Signed Integer Any
2170 // FPTOUI n/a FloatPt n/a Integral Unsigned
2171 // FPTOSI n/a FloatPt n/a Integral Signed
2172 // UITOFP n/a Integral Unsigned FloatPt n/a
2173 // SITOFP n/a Integral Signed FloatPt n/a
2174 // FPTRUNC > FloatPt n/a FloatPt n/a
2175 // FPEXT < FloatPt n/a FloatPt n/a
2176 // PTRTOINT n/a Pointer n/a Integral Unsigned
2177 // INTTOPTR n/a Integral Unsigned Pointer n/a
2178 // BITCAST = FirstClass n/a FirstClass n/a
2179 // ADDRSPCST n/a Pointer n/a Pointer n/a
2181 // NOTE: some transforms are safe, but we consider them to be non-profitable.
2182 // For example, we could merge "fptoui double to i32" + "zext i32 to i64",
2183 // into "fptoui double to i64", but this loses information about the range
2184 // of the produced value (we no longer know the top-part is all zeros).
2185 // Further this conversion is often much more expensive for typical hardware,
2186 // and causes issues when building libgcc. We disallow fptosi+sext for the
2188 const unsigned numCastOps =
2189 Instruction::CastOpsEnd - Instruction::CastOpsBegin;
2190 static const uint8_t CastResults[numCastOps][numCastOps] = {
2191 // T F F U S F F P I B A -+
2192 // R Z S P P I I T P 2 N T S |
2193 // U E E 2 2 2 2 R E I T C C +- secondOp
2194 // N X X U S F F N X N 2 V V |
2195 // C T T I I P P C T T P T T -+
2196 { 1, 0, 0,99,99, 0, 0,99,99,99, 0, 3, 0}, // Trunc -+
2197 { 8, 1, 9,99,99, 2, 0,99,99,99, 2, 3, 0}, // ZExt |
2198 { 8, 0, 1,99,99, 0, 2,99,99,99, 0, 3, 0}, // SExt |
2199 { 0, 0, 0,99,99, 0, 0,99,99,99, 0, 3, 0}, // FPToUI |
2200 { 0, 0, 0,99,99, 0, 0,99,99,99, 0, 3, 0}, // FPToSI |
2201 { 99,99,99, 0, 0,99,99, 0, 0,99,99, 4, 0}, // UIToFP +- firstOp
2202 { 99,99,99, 0, 0,99,99, 0, 0,99,99, 4, 0}, // SIToFP |
2203 { 99,99,99, 0, 0,99,99, 1, 0,99,99, 4, 0}, // FPTrunc |
2204 { 99,99,99, 2, 2,99,99,10, 2,99,99, 4, 0}, // FPExt |
2205 { 1, 0, 0,99,99, 0, 0,99,99,99, 7, 3, 0}, // PtrToInt |
2206 { 99,99,99,99,99,99,99,99,99,11,99,15, 0}, // IntToPtr |
2207 { 5, 5, 5, 6, 6, 5, 5, 6, 6,16, 5, 1,14}, // BitCast |
2208 { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,13,12}, // AddrSpaceCast -+
2211 // If either of the casts are a bitcast from scalar to vector, disallow the
2212 // merging. However, bitcast of A->B->A are allowed.
2213 bool isFirstBitcast = (firstOp == Instruction::BitCast);
2214 bool isSecondBitcast = (secondOp == Instruction::BitCast);
2215 bool chainedBitcast = (SrcTy == DstTy && isFirstBitcast && isSecondBitcast);
2217 // Check if any of the bitcasts convert scalars<->vectors.
2218 if ((isFirstBitcast && isa<VectorType>(SrcTy) != isa<VectorType>(MidTy)) ||
2219 (isSecondBitcast && isa<VectorType>(MidTy) != isa<VectorType>(DstTy)))
2220 // Unless we are bitcasing to the original type, disallow optimizations.
2221 if (!chainedBitcast) return 0;
2223 int ElimCase = CastResults[firstOp-Instruction::CastOpsBegin]
2224 [secondOp-Instruction::CastOpsBegin];
2227 // Categorically disallowed.
2230 // Allowed, use first cast's opcode.
2233 // Allowed, use second cast's opcode.
2236 // No-op cast in second op implies firstOp as long as the DestTy
2237 // is integer and we are not converting between a vector and a
2239 if (!SrcTy->isVectorTy() && DstTy->isIntegerTy())
2243 // No-op cast in second op implies firstOp as long as the DestTy
2244 // is floating point.
2245 if (DstTy->isFloatingPointTy())
2249 // No-op cast in first op implies secondOp as long as the SrcTy
2251 if (SrcTy->isIntegerTy())
2255 // No-op cast in first op implies secondOp as long as the SrcTy
2256 // is a floating point.
2257 if (SrcTy->isFloatingPointTy())
2261 // Cannot simplify if address spaces are different!
2262 if (SrcTy->getPointerAddressSpace() != DstTy->getPointerAddressSpace())
2265 unsigned MidSize = MidTy->getScalarSizeInBits();
2266 // We can still fold this without knowing the actual sizes as long we
2267 // know that the intermediate pointer is the largest possible
2269 // FIXME: Is this always true?
2271 return Instruction::BitCast;
2273 // ptrtoint, inttoptr -> bitcast (ptr -> ptr) if int size is >= ptr size.
2274 if (!SrcIntPtrTy || DstIntPtrTy != SrcIntPtrTy)
2276 unsigned PtrSize = SrcIntPtrTy->getScalarSizeInBits();
2277 if (MidSize >= PtrSize)
2278 return Instruction::BitCast;
2282 // ext, trunc -> bitcast, if the SrcTy and DstTy are same size
2283 // ext, trunc -> ext, if sizeof(SrcTy) < sizeof(DstTy)
2284 // ext, trunc -> trunc, if sizeof(SrcTy) > sizeof(DstTy)
2285 unsigned SrcSize = SrcTy->getScalarSizeInBits();
2286 unsigned DstSize = DstTy->getScalarSizeInBits();
2287 if (SrcSize == DstSize)
2288 return Instruction::BitCast;
2289 else if (SrcSize < DstSize)
2294 // zext, sext -> zext, because sext can't sign extend after zext
2295 return Instruction::ZExt;
2297 // fpext followed by ftrunc is allowed if the bit size returned to is
2298 // the same as the original, in which case its just a bitcast
2300 return Instruction::BitCast;
2301 return 0; // If the types are not the same we can't eliminate it.
2303 // inttoptr, ptrtoint -> bitcast if SrcSize<=PtrSize and SrcSize==DstSize
2306 unsigned PtrSize = MidIntPtrTy->getScalarSizeInBits();
2307 unsigned SrcSize = SrcTy->getScalarSizeInBits();
2308 unsigned DstSize = DstTy->getScalarSizeInBits();
2309 if (SrcSize <= PtrSize && SrcSize == DstSize)
2310 return Instruction::BitCast;
2314 // addrspacecast, addrspacecast -> bitcast, if SrcAS == DstAS
2315 // addrspacecast, addrspacecast -> addrspacecast, if SrcAS != DstAS
2316 if (SrcTy->getPointerAddressSpace() != DstTy->getPointerAddressSpace())
2317 return Instruction::AddrSpaceCast;
2318 return Instruction::BitCast;
2321 // FIXME: this state can be merged with (1), but the following assert
2322 // is useful to check the correcteness of the sequence due to semantic
2323 // change of bitcast.
2325 SrcTy->isPtrOrPtrVectorTy() &&
2326 MidTy->isPtrOrPtrVectorTy() &&
2327 DstTy->isPtrOrPtrVectorTy() &&
2328 SrcTy->getPointerAddressSpace() != MidTy->getPointerAddressSpace() &&
2329 MidTy->getPointerAddressSpace() == DstTy->getPointerAddressSpace() &&
2330 "Illegal addrspacecast, bitcast sequence!");
2331 // Allowed, use first cast's opcode
2334 // FIXME: this state can be merged with (2), but the following assert
2335 // is useful to check the correcteness of the sequence due to semantic
2336 // change of bitcast.
2338 SrcTy->isPtrOrPtrVectorTy() &&
2339 MidTy->isPtrOrPtrVectorTy() &&
2340 DstTy->isPtrOrPtrVectorTy() &&
2341 SrcTy->getPointerAddressSpace() == MidTy->getPointerAddressSpace() &&
2342 MidTy->getPointerAddressSpace() != DstTy->getPointerAddressSpace() &&
2343 "Illegal bitcast, addrspacecast sequence!");
2344 // Allowed, use second cast's opcode
2347 // FIXME: this state can be merged with (1), but the following assert
2348 // is useful to check the correcteness of the sequence due to semantic
2349 // change of bitcast.
2351 SrcTy->isIntOrIntVectorTy() &&
2352 MidTy->isPtrOrPtrVectorTy() &&
2353 DstTy->isPtrOrPtrVectorTy() &&
2354 MidTy->getPointerAddressSpace() == DstTy->getPointerAddressSpace() &&
2355 "Illegal inttoptr, bitcast sequence!");
2356 // Allowed, use first cast's opcode
2359 // FIXME: this state can be merged with (2), but the following assert
2360 // is useful to check the correcteness of the sequence due to semantic
2361 // change of bitcast.
2363 SrcTy->isPtrOrPtrVectorTy() &&
2364 MidTy->isPtrOrPtrVectorTy() &&
2365 DstTy->isIntOrIntVectorTy() &&
2366 SrcTy->getPointerAddressSpace() == MidTy->getPointerAddressSpace() &&
2367 "Illegal bitcast, ptrtoint sequence!");
2368 // Allowed, use second cast's opcode
2371 // Cast combination can't happen (error in input). This is for all cases
2372 // where the MidTy is not the same for the two cast instructions.
2373 llvm_unreachable("Invalid Cast Combination");
2375 llvm_unreachable("Error in CastResults table!!!");
2379 CastInst *CastInst::Create(Instruction::CastOps op, Value *S, Type *Ty,
2380 const Twine &Name, Instruction *InsertBefore) {
2381 assert(castIsValid(op, S, Ty) && "Invalid cast!");
2382 // Construct and return the appropriate CastInst subclass
2384 case Trunc: return new TruncInst (S, Ty, Name, InsertBefore);
2385 case ZExt: return new ZExtInst (S, Ty, Name, InsertBefore);
2386 case SExt: return new SExtInst (S, Ty, Name, InsertBefore);
2387 case FPTrunc: return new FPTruncInst (S, Ty, Name, InsertBefore);
2388 case FPExt: return new FPExtInst (S, Ty, Name, InsertBefore);
2389 case UIToFP: return new UIToFPInst (S, Ty, Name, InsertBefore);
2390 case SIToFP: return new SIToFPInst (S, Ty, Name, InsertBefore);
2391 case FPToUI: return new FPToUIInst (S, Ty, Name, InsertBefore);
2392 case FPToSI: return new FPToSIInst (S, Ty, Name, InsertBefore);
2393 case PtrToInt: return new PtrToIntInst (S, Ty, Name, InsertBefore);
2394 case IntToPtr: return new IntToPtrInst (S, Ty, Name, InsertBefore);
2395 case BitCast: return new BitCastInst (S, Ty, Name, InsertBefore);
2396 case AddrSpaceCast: return new AddrSpaceCastInst (S, Ty, Name, InsertBefore);
2397 default: llvm_unreachable("Invalid opcode provided");
2401 CastInst *CastInst::Create(Instruction::CastOps op, Value *S, Type *Ty,
2402 const Twine &Name, BasicBlock *InsertAtEnd) {
2403 assert(castIsValid(op, S, Ty) && "Invalid cast!");
2404 // Construct and return the appropriate CastInst subclass
2406 case Trunc: return new TruncInst (S, Ty, Name, InsertAtEnd);
2407 case ZExt: return new ZExtInst (S, Ty, Name, InsertAtEnd);
2408 case SExt: return new SExtInst (S, Ty, Name, InsertAtEnd);
2409 case FPTrunc: return new FPTruncInst (S, Ty, Name, InsertAtEnd);
2410 case FPExt: return new FPExtInst (S, Ty, Name, InsertAtEnd);
2411 case UIToFP: return new UIToFPInst (S, Ty, Name, InsertAtEnd);
2412 case SIToFP: return new SIToFPInst (S, Ty, Name, InsertAtEnd);
2413 case FPToUI: return new FPToUIInst (S, Ty, Name, InsertAtEnd);
2414 case FPToSI: return new FPToSIInst (S, Ty, Name, InsertAtEnd);
2415 case PtrToInt: return new PtrToIntInst (S, Ty, Name, InsertAtEnd);
2416 case IntToPtr: return new IntToPtrInst (S, Ty, Name, InsertAtEnd);
2417 case BitCast: return new BitCastInst (S, Ty, Name, InsertAtEnd);
2418 case AddrSpaceCast: return new AddrSpaceCastInst (S, Ty, Name, InsertAtEnd);
2419 default: llvm_unreachable("Invalid opcode provided");
2423 CastInst *CastInst::CreateZExtOrBitCast(Value *S, Type *Ty,
2425 Instruction *InsertBefore) {
2426 if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2427 return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2428 return Create(Instruction::ZExt, S, Ty, Name, InsertBefore);
2431 CastInst *CastInst::CreateZExtOrBitCast(Value *S, Type *Ty,
2433 BasicBlock *InsertAtEnd) {
2434 if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2435 return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2436 return Create(Instruction::ZExt, S, Ty, Name, InsertAtEnd);
2439 CastInst *CastInst::CreateSExtOrBitCast(Value *S, Type *Ty,
2441 Instruction *InsertBefore) {
2442 if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2443 return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2444 return Create(Instruction::SExt, S, Ty, Name, InsertBefore);
2447 CastInst *CastInst::CreateSExtOrBitCast(Value *S, Type *Ty,
2449 BasicBlock *InsertAtEnd) {
2450 if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2451 return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2452 return Create(Instruction::SExt, S, Ty, Name, InsertAtEnd);
2455 CastInst *CastInst::CreateTruncOrBitCast(Value *S, Type *Ty,
2457 Instruction *InsertBefore) {
2458 if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2459 return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2460 return Create(Instruction::Trunc, S, Ty, Name, InsertBefore);
2463 CastInst *CastInst::CreateTruncOrBitCast(Value *S, Type *Ty,
2465 BasicBlock *InsertAtEnd) {
2466 if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2467 return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2468 return Create(Instruction::Trunc, S, Ty, Name, InsertAtEnd);
2471 CastInst *CastInst::CreatePointerCast(Value *S, Type *Ty,
2473 BasicBlock *InsertAtEnd) {
2474 assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
2475 assert((Ty->isIntOrIntVectorTy() || Ty->isPtrOrPtrVectorTy()) &&
2477 assert(Ty->isVectorTy() == S->getType()->isVectorTy() && "Invalid cast");
2478 assert((!Ty->isVectorTy() ||
2479 Ty->getVectorNumElements() == S->getType()->getVectorNumElements()) &&
2482 if (Ty->isIntOrIntVectorTy())
2483 return Create(Instruction::PtrToInt, S, Ty, Name, InsertAtEnd);
2485 Type *STy = S->getType();
2486 if (STy->getPointerAddressSpace() != Ty->getPointerAddressSpace())
2487 return Create(Instruction::AddrSpaceCast, S, Ty, Name, InsertAtEnd);
2489 return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2492 /// @brief Create a BitCast or a PtrToInt cast instruction
2493 CastInst *CastInst::CreatePointerCast(Value *S, Type *Ty,
2495 Instruction *InsertBefore) {
2496 assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
2497 assert((Ty->isIntOrIntVectorTy() || Ty->isPtrOrPtrVectorTy()) &&
2499 assert(Ty->isVectorTy() == S->getType()->isVectorTy() && "Invalid cast");
2500 assert((!Ty->isVectorTy() ||
2501 Ty->getVectorNumElements() == S->getType()->getVectorNumElements()) &&
2504 if (Ty->isIntOrIntVectorTy())
2505 return Create(Instruction::PtrToInt, S, Ty, Name, InsertBefore);
2507 Type *STy = S->getType();
2508 if (STy->getPointerAddressSpace() != Ty->getPointerAddressSpace())
2509 return Create(Instruction::AddrSpaceCast, S, Ty, Name, InsertBefore);
2511 return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2514 CastInst *CastInst::CreateIntegerCast(Value *C, Type *Ty,
2515 bool isSigned, const Twine &Name,
2516 Instruction *InsertBefore) {
2517 assert(C->getType()->isIntOrIntVectorTy() && Ty->isIntOrIntVectorTy() &&
2518 "Invalid integer cast");
2519 unsigned SrcBits = C->getType()->getScalarSizeInBits();
2520 unsigned DstBits = Ty->getScalarSizeInBits();
2521 Instruction::CastOps opcode =
2522 (SrcBits == DstBits ? Instruction::BitCast :
2523 (SrcBits > DstBits ? Instruction::Trunc :
2524 (isSigned ? Instruction::SExt : Instruction::ZExt)));
2525 return Create(opcode, C, Ty, Name, InsertBefore);
2528 CastInst *CastInst::CreateIntegerCast(Value *C, Type *Ty,
2529 bool isSigned, const Twine &Name,
2530 BasicBlock *InsertAtEnd) {
2531 assert(C->getType()->isIntOrIntVectorTy() && Ty->isIntOrIntVectorTy() &&
2533 unsigned SrcBits = C->getType()->getScalarSizeInBits();
2534 unsigned DstBits = Ty->getScalarSizeInBits();
2535 Instruction::CastOps opcode =
2536 (SrcBits == DstBits ? Instruction::BitCast :
2537 (SrcBits > DstBits ? Instruction::Trunc :
2538 (isSigned ? Instruction::SExt : Instruction::ZExt)));
2539 return Create(opcode, C, Ty, Name, InsertAtEnd);
2542 CastInst *CastInst::CreateFPCast(Value *C, Type *Ty,
2544 Instruction *InsertBefore) {
2545 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
2547 unsigned SrcBits = C->getType()->getScalarSizeInBits();
2548 unsigned DstBits = Ty->getScalarSizeInBits();
2549 Instruction::CastOps opcode =
2550 (SrcBits == DstBits ? Instruction::BitCast :
2551 (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt));
2552 return Create(opcode, C, Ty, Name, InsertBefore);
2555 CastInst *CastInst::CreateFPCast(Value *C, Type *Ty,
2557 BasicBlock *InsertAtEnd) {
2558 assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
2560 unsigned SrcBits = C->getType()->getScalarSizeInBits();
2561 unsigned DstBits = Ty->getScalarSizeInBits();
2562 Instruction::CastOps opcode =
2563 (SrcBits == DstBits ? Instruction::BitCast :
2564 (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt));
2565 return Create(opcode, C, Ty, Name, InsertAtEnd);
2568 // Check whether it is valid to call getCastOpcode for these types.
2569 // This routine must be kept in sync with getCastOpcode.
2570 bool CastInst::isCastable(Type *SrcTy, Type *DestTy) {
2571 if (!SrcTy->isFirstClassType() || !DestTy->isFirstClassType())
2574 if (SrcTy == DestTy)
2577 if (VectorType *SrcVecTy = dyn_cast<VectorType>(SrcTy))
2578 if (VectorType *DestVecTy = dyn_cast<VectorType>(DestTy))
2579 if (SrcVecTy->getNumElements() == DestVecTy->getNumElements()) {
2580 // An element by element cast. Valid if casting the elements is valid.
2581 SrcTy = SrcVecTy->getElementType();
2582 DestTy = DestVecTy->getElementType();
2585 // Get the bit sizes, we'll need these
2586 unsigned SrcBits = SrcTy->getPrimitiveSizeInBits(); // 0 for ptr
2587 unsigned DestBits = DestTy->getPrimitiveSizeInBits(); // 0 for ptr
2589 // Run through the possibilities ...
2590 if (DestTy->isIntegerTy()) { // Casting to integral
2591 if (SrcTy->isIntegerTy()) { // Casting from integral
2593 } else if (SrcTy->isFloatingPointTy()) { // Casting from floating pt
2595 } else if (SrcTy->isVectorTy()) { // Casting from vector
2596 return DestBits == SrcBits;
2597 } else { // Casting from something else
2598 return SrcTy->isPointerTy();
2600 } else if (DestTy->isFloatingPointTy()) { // Casting to floating pt
2601 if (SrcTy->isIntegerTy()) { // Casting from integral
2603 } else if (SrcTy->isFloatingPointTy()) { // Casting from floating pt
2605 } else if (SrcTy->isVectorTy()) { // Casting from vector
2606 return DestBits == SrcBits;
2607 } else { // Casting from something else
2610 } else if (DestTy->isVectorTy()) { // Casting to vector
2611 return DestBits == SrcBits;
2612 } else if (DestTy->isPointerTy()) { // Casting to pointer
2613 if (SrcTy->isPointerTy()) { // Casting from pointer
2615 } else if (SrcTy->isIntegerTy()) { // Casting from integral
2617 } else { // Casting from something else
2620 } else if (DestTy->isX86_MMXTy()) {
2621 if (SrcTy->isVectorTy()) {
2622 return DestBits == SrcBits; // 64-bit vector to MMX
2626 } else { // Casting to something else
2631 bool CastInst::isBitCastable(Type *SrcTy, Type *DestTy) {
2632 if (!SrcTy->isFirstClassType() || !DestTy->isFirstClassType())
2635 if (SrcTy == DestTy)
2638 if (VectorType *SrcVecTy = dyn_cast<VectorType>(SrcTy)) {
2639 if (VectorType *DestVecTy = dyn_cast<VectorType>(DestTy)) {
2640 if (SrcVecTy->getNumElements() == DestVecTy->getNumElements()) {
2641 // An element by element cast. Valid if casting the elements is valid.
2642 SrcTy = SrcVecTy->getElementType();
2643 DestTy = DestVecTy->getElementType();
2648 if (PointerType *DestPtrTy = dyn_cast<PointerType>(DestTy)) {
2649 if (PointerType *SrcPtrTy = dyn_cast<PointerType>(SrcTy)) {
2650 return SrcPtrTy->getAddressSpace() == DestPtrTy->getAddressSpace();
2654 unsigned SrcBits = SrcTy->getPrimitiveSizeInBits(); // 0 for ptr
2655 unsigned DestBits = DestTy->getPrimitiveSizeInBits(); // 0 for ptr
2657 // Could still have vectors of pointers if the number of elements doesn't
2659 if (SrcBits == 0 || DestBits == 0)
2662 if (SrcBits != DestBits)
2665 if (DestTy->isX86_MMXTy() || SrcTy->isX86_MMXTy())
2671 // Provide a way to get a "cast" where the cast opcode is inferred from the
2672 // types and size of the operand. This, basically, is a parallel of the
2673 // logic in the castIsValid function below. This axiom should hold:
2674 // castIsValid( getCastOpcode(Val, Ty), Val, Ty)
2675 // should not assert in castIsValid. In other words, this produces a "correct"
2676 // casting opcode for the arguments passed to it.
2677 // This routine must be kept in sync with isCastable.
2678 Instruction::CastOps
2679 CastInst::getCastOpcode(
2680 const Value *Src, bool SrcIsSigned, Type *DestTy, bool DestIsSigned) {
2681 Type *SrcTy = Src->getType();
2683 assert(SrcTy->isFirstClassType() && DestTy->isFirstClassType() &&
2684 "Only first class types are castable!");
2686 if (SrcTy == DestTy)
2689 // FIXME: Check address space sizes here
2690 if (VectorType *SrcVecTy = dyn_cast<VectorType>(SrcTy))
2691 if (VectorType *DestVecTy = dyn_cast<VectorType>(DestTy))
2692 if (SrcVecTy->getNumElements() == DestVecTy->getNumElements()) {
2693 // An element by element cast. Find the appropriate opcode based on the
2695 SrcTy = SrcVecTy->getElementType();
2696 DestTy = DestVecTy->getElementType();
2699 // Get the bit sizes, we'll need these
2700 unsigned SrcBits = SrcTy->getPrimitiveSizeInBits(); // 0 for ptr
2701 unsigned DestBits = DestTy->getPrimitiveSizeInBits(); // 0 for ptr
2703 // Run through the possibilities ...
2704 if (DestTy->isIntegerTy()) { // Casting to integral
2705 if (SrcTy->isIntegerTy()) { // Casting from integral
2706 if (DestBits < SrcBits)
2707 return Trunc; // int -> smaller int
2708 else if (DestBits > SrcBits) { // its an extension
2710 return SExt; // signed -> SEXT
2712 return ZExt; // unsigned -> ZEXT
2714 return BitCast; // Same size, No-op cast
2716 } else if (SrcTy->isFloatingPointTy()) { // Casting from floating pt
2718 return FPToSI; // FP -> sint
2720 return FPToUI; // FP -> uint
2721 } else if (SrcTy->isVectorTy()) {
2722 assert(DestBits == SrcBits &&
2723 "Casting vector to integer of different width");
2724 return BitCast; // Same size, no-op cast
2726 assert(SrcTy->isPointerTy() &&
2727 "Casting from a value that is not first-class type");
2728 return PtrToInt; // ptr -> int
2730 } else if (DestTy->isFloatingPointTy()) { // Casting to floating pt
2731 if (SrcTy->isIntegerTy()) { // Casting from integral
2733 return SIToFP; // sint -> FP
2735 return UIToFP; // uint -> FP
2736 } else if (SrcTy->isFloatingPointTy()) { // Casting from floating pt
2737 if (DestBits < SrcBits) {
2738 return FPTrunc; // FP -> smaller FP
2739 } else if (DestBits > SrcBits) {
2740 return FPExt; // FP -> larger FP
2742 return BitCast; // same size, no-op cast
2744 } else if (SrcTy->isVectorTy()) {
2745 assert(DestBits == SrcBits &&
2746 "Casting vector to floating point of different width");
2747 return BitCast; // same size, no-op cast
2749 llvm_unreachable("Casting pointer or non-first class to float");
2750 } else if (DestTy->isVectorTy()) {
2751 assert(DestBits == SrcBits &&
2752 "Illegal cast to vector (wrong type or size)");
2754 } else if (DestTy->isPointerTy()) {
2755 if (SrcTy->isPointerTy()) {
2756 if (DestTy->getPointerAddressSpace() != SrcTy->getPointerAddressSpace())
2757 return AddrSpaceCast;
2758 return BitCast; // ptr -> ptr
2759 } else if (SrcTy->isIntegerTy()) {
2760 return IntToPtr; // int -> ptr
2762 llvm_unreachable("Casting pointer to other than pointer or int");
2763 } else if (DestTy->isX86_MMXTy()) {
2764 if (SrcTy->isVectorTy()) {
2765 assert(DestBits == SrcBits && "Casting vector of wrong width to X86_MMX");
2766 return BitCast; // 64-bit vector to MMX
2768 llvm_unreachable("Illegal cast to X86_MMX");
2770 llvm_unreachable("Casting to type that is not first-class");
2773 //===----------------------------------------------------------------------===//
2774 // CastInst SubClass Constructors
2775 //===----------------------------------------------------------------------===//
2777 /// Check that the construction parameters for a CastInst are correct. This
2778 /// could be broken out into the separate constructors but it is useful to have
2779 /// it in one place and to eliminate the redundant code for getting the sizes
2780 /// of the types involved.
2782 CastInst::castIsValid(Instruction::CastOps op, Value *S, Type *DstTy) {
2784 // Check for type sanity on the arguments
2785 Type *SrcTy = S->getType();
2787 // If this is a cast to the same type then it's trivially true.
2791 if (!SrcTy->isFirstClassType() || !DstTy->isFirstClassType() ||
2792 SrcTy->isAggregateType() || DstTy->isAggregateType())
2795 // Get the size of the types in bits, we'll need this later
2796 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2797 unsigned DstBitSize = DstTy->getScalarSizeInBits();
2799 // If these are vector types, get the lengths of the vectors (using zero for
2800 // scalar types means that checking that vector lengths match also checks that
2801 // scalars are not being converted to vectors or vectors to scalars).
2802 unsigned SrcLength = SrcTy->isVectorTy() ?
2803 cast<VectorType>(SrcTy)->getNumElements() : 0;
2804 unsigned DstLength = DstTy->isVectorTy() ?
2805 cast<VectorType>(DstTy)->getNumElements() : 0;
2807 // Switch on the opcode provided
2809 default: return false; // This is an input error
2810 case Instruction::Trunc:
2811 return SrcTy->isIntOrIntVectorTy() && DstTy->isIntOrIntVectorTy() &&
2812 SrcLength == DstLength && SrcBitSize > DstBitSize;
2813 case Instruction::ZExt:
2814 return SrcTy->isIntOrIntVectorTy() && DstTy->isIntOrIntVectorTy() &&
2815 SrcLength == DstLength && SrcBitSize < DstBitSize;
2816 case Instruction::SExt:
2817 return SrcTy->isIntOrIntVectorTy() && DstTy->isIntOrIntVectorTy() &&
2818 SrcLength == DstLength && SrcBitSize < DstBitSize;
2819 case Instruction::FPTrunc:
2820 return SrcTy->isFPOrFPVectorTy() && DstTy->isFPOrFPVectorTy() &&
2821 SrcLength == DstLength && SrcBitSize > DstBitSize;
2822 case Instruction::FPExt:
2823 return SrcTy->isFPOrFPVectorTy() && DstTy->isFPOrFPVectorTy() &&
2824 SrcLength == DstLength && SrcBitSize < DstBitSize;
2825 case Instruction::UIToFP:
2826 case Instruction::SIToFP:
2827 return SrcTy->isIntOrIntVectorTy() && DstTy->isFPOrFPVectorTy() &&
2828 SrcLength == DstLength;
2829 case Instruction::FPToUI:
2830 case Instruction::FPToSI:
2831 return SrcTy->isFPOrFPVectorTy() && DstTy->isIntOrIntVectorTy() &&
2832 SrcLength == DstLength;
2833 case Instruction::PtrToInt:
2834 if (isa<VectorType>(SrcTy) != isa<VectorType>(DstTy))
2836 if (VectorType *VT = dyn_cast<VectorType>(SrcTy))
2837 if (VT->getNumElements() != cast<VectorType>(DstTy)->getNumElements())
2839 return SrcTy->getScalarType()->isPointerTy() &&
2840 DstTy->getScalarType()->isIntegerTy();
2841 case Instruction::IntToPtr:
2842 if (isa<VectorType>(SrcTy) != isa<VectorType>(DstTy))
2844 if (VectorType *VT = dyn_cast<VectorType>(SrcTy))
2845 if (VT->getNumElements() != cast<VectorType>(DstTy)->getNumElements())
2847 return SrcTy->getScalarType()->isIntegerTy() &&
2848 DstTy->getScalarType()->isPointerTy();
2849 case Instruction::BitCast: {
2850 PointerType *SrcPtrTy = dyn_cast<PointerType>(SrcTy->getScalarType());
2851 PointerType *DstPtrTy = dyn_cast<PointerType>(DstTy->getScalarType());
2853 // BitCast implies a no-op cast of type only. No bits change.
2854 // However, you can't cast pointers to anything but pointers.
2855 if (!SrcPtrTy != !DstPtrTy)
2858 // For non-pointer cases, the cast is okay if the source and destination bit
2859 // widths are identical.
2861 return SrcTy->getPrimitiveSizeInBits() == DstTy->getPrimitiveSizeInBits();
2863 // If both are pointers then the address spaces must match.
2864 if (SrcPtrTy->getAddressSpace() != DstPtrTy->getAddressSpace())
2867 // A vector of pointers must have the same number of elements.
2868 if (VectorType *SrcVecTy = dyn_cast<VectorType>(SrcTy)) {
2869 if (VectorType *DstVecTy = dyn_cast<VectorType>(DstTy))
2870 return (SrcVecTy->getNumElements() == DstVecTy->getNumElements());
2877 case Instruction::AddrSpaceCast: {
2878 PointerType *SrcPtrTy = dyn_cast<PointerType>(SrcTy->getScalarType());
2882 PointerType *DstPtrTy = dyn_cast<PointerType>(DstTy->getScalarType());
2886 if (SrcPtrTy->getAddressSpace() == DstPtrTy->getAddressSpace())
2889 if (VectorType *SrcVecTy = dyn_cast<VectorType>(SrcTy)) {
2890 if (VectorType *DstVecTy = dyn_cast<VectorType>(DstTy))
2891 return (SrcVecTy->getNumElements() == DstVecTy->getNumElements());
2901 TruncInst::TruncInst(
2902 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2903 ) : CastInst(Ty, Trunc, S, Name, InsertBefore) {
2904 assert(castIsValid(getOpcode(), S, Ty) && "Illegal Trunc");
2907 TruncInst::TruncInst(
2908 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2909 ) : CastInst(Ty, Trunc, S, Name, InsertAtEnd) {
2910 assert(castIsValid(getOpcode(), S, Ty) && "Illegal Trunc");
2914 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2915 ) : CastInst(Ty, ZExt, S, Name, InsertBefore) {
2916 assert(castIsValid(getOpcode(), S, Ty) && "Illegal ZExt");
2920 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2921 ) : CastInst(Ty, ZExt, S, Name, InsertAtEnd) {
2922 assert(castIsValid(getOpcode(), S, Ty) && "Illegal ZExt");
2925 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2926 ) : CastInst(Ty, SExt, S, Name, InsertBefore) {
2927 assert(castIsValid(getOpcode(), S, Ty) && "Illegal SExt");
2931 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2932 ) : CastInst(Ty, SExt, S, Name, InsertAtEnd) {
2933 assert(castIsValid(getOpcode(), S, Ty) && "Illegal SExt");
2936 FPTruncInst::FPTruncInst(
2937 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2938 ) : CastInst(Ty, FPTrunc, S, Name, InsertBefore) {
2939 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPTrunc");
2942 FPTruncInst::FPTruncInst(
2943 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2944 ) : CastInst(Ty, FPTrunc, S, Name, InsertAtEnd) {
2945 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPTrunc");
2948 FPExtInst::FPExtInst(
2949 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2950 ) : CastInst(Ty, FPExt, S, Name, InsertBefore) {
2951 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPExt");
2954 FPExtInst::FPExtInst(
2955 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2956 ) : CastInst(Ty, FPExt, S, Name, InsertAtEnd) {
2957 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPExt");
2960 UIToFPInst::UIToFPInst(
2961 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2962 ) : CastInst(Ty, UIToFP, S, Name, InsertBefore) {
2963 assert(castIsValid(getOpcode(), S, Ty) && "Illegal UIToFP");
2966 UIToFPInst::UIToFPInst(
2967 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2968 ) : CastInst(Ty, UIToFP, S, Name, InsertAtEnd) {
2969 assert(castIsValid(getOpcode(), S, Ty) && "Illegal UIToFP");
2972 SIToFPInst::SIToFPInst(
2973 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2974 ) : CastInst(Ty, SIToFP, S, Name, InsertBefore) {
2975 assert(castIsValid(getOpcode(), S, Ty) && "Illegal SIToFP");
2978 SIToFPInst::SIToFPInst(
2979 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2980 ) : CastInst(Ty, SIToFP, S, Name, InsertAtEnd) {
2981 assert(castIsValid(getOpcode(), S, Ty) && "Illegal SIToFP");
2984 FPToUIInst::FPToUIInst(
2985 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2986 ) : CastInst(Ty, FPToUI, S, Name, InsertBefore) {
2987 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToUI");
2990 FPToUIInst::FPToUIInst(
2991 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2992 ) : CastInst(Ty, FPToUI, S, Name, InsertAtEnd) {
2993 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToUI");
2996 FPToSIInst::FPToSIInst(
2997 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2998 ) : CastInst(Ty, FPToSI, S, Name, InsertBefore) {
2999 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToSI");
3002 FPToSIInst::FPToSIInst(
3003 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
3004 ) : CastInst(Ty, FPToSI, S, Name, InsertAtEnd) {
3005 assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToSI");
3008 PtrToIntInst::PtrToIntInst(
3009 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
3010 ) : CastInst(Ty, PtrToInt, S, Name, InsertBefore) {
3011 assert(castIsValid(getOpcode(), S, Ty) && "Illegal PtrToInt");
3014 PtrToIntInst::PtrToIntInst(
3015 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
3016 ) : CastInst(Ty, PtrToInt, S, Name, InsertAtEnd) {
3017 assert(castIsValid(getOpcode(), S, Ty) && "Illegal PtrToInt");
3020 IntToPtrInst::IntToPtrInst(
3021 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
3022 ) : CastInst(Ty, IntToPtr, S, Name, InsertBefore) {
3023 assert(castIsValid(getOpcode(), S, Ty) && "Illegal IntToPtr");
3026 IntToPtrInst::IntToPtrInst(
3027 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
3028 ) : CastInst(Ty, IntToPtr, S, Name, InsertAtEnd) {
3029 assert(castIsValid(getOpcode(), S, Ty) && "Illegal IntToPtr");
3032 BitCastInst::BitCastInst(
3033 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
3034 ) : CastInst(Ty, BitCast, S, Name, InsertBefore) {
3035 assert(castIsValid(getOpcode(), S, Ty) && "Illegal BitCast");
3038 BitCastInst::BitCastInst(
3039 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
3040 ) : CastInst(Ty, BitCast, S, Name, InsertAtEnd) {
3041 assert(castIsValid(getOpcode(), S, Ty) && "Illegal BitCast");
3044 AddrSpaceCastInst::AddrSpaceCastInst(
3045 Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
3046 ) : CastInst(Ty, AddrSpaceCast, S, Name, InsertBefore) {
3047 assert(castIsValid(getOpcode(), S, Ty) && "Illegal AddrSpaceCast");
3050 AddrSpaceCastInst::AddrSpaceCastInst(
3051 Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
3052 ) : CastInst(Ty, AddrSpaceCast, S, Name, InsertAtEnd) {
3053 assert(castIsValid(getOpcode(), S, Ty) && "Illegal AddrSpaceCast");
3056 //===----------------------------------------------------------------------===//
3058 //===----------------------------------------------------------------------===//
3060 void CmpInst::anchor() {}
3062 CmpInst::CmpInst(Type *ty, OtherOps op, unsigned short predicate,
3063 Value *LHS, Value *RHS, const Twine &Name,
3064 Instruction *InsertBefore)
3065 : Instruction(ty, op,
3066 OperandTraits<CmpInst>::op_begin(this),
3067 OperandTraits<CmpInst>::operands(this),
3071 setPredicate((Predicate)predicate);
3075 CmpInst::CmpInst(Type *ty, OtherOps op, unsigned short predicate,
3076 Value *LHS, Value *RHS, const Twine &Name,
3077 BasicBlock *InsertAtEnd)
3078 : Instruction(ty, op,
3079 OperandTraits<CmpInst>::op_begin(this),
3080 OperandTraits<CmpInst>::operands(this),
3084 setPredicate((Predicate)predicate);
3089 CmpInst::Create(OtherOps Op, unsigned short predicate,
3090 Value *S1, Value *S2,
3091 const Twine &Name, Instruction *InsertBefore) {
3092 if (Op == Instruction::ICmp) {
3094 return new ICmpInst(InsertBefore, CmpInst::Predicate(predicate),
3097 return new ICmpInst(CmpInst::Predicate(predicate),
3102 return new FCmpInst(InsertBefore, CmpInst::Predicate(predicate),
3105 return new FCmpInst(CmpInst::Predicate(predicate),
3110 CmpInst::Create(OtherOps Op, unsigned short predicate, Value *S1, Value *S2,
3111 const Twine &Name, BasicBlock *InsertAtEnd) {
3112 if (Op == Instruction::ICmp) {
3113 return new ICmpInst(*InsertAtEnd, CmpInst::Predicate(predicate),
3116 return new FCmpInst(*InsertAtEnd, CmpInst::Predicate(predicate),
3120 void CmpInst::swapOperands() {
3121 if (ICmpInst *IC = dyn_cast<ICmpInst>(this))
3124 cast<FCmpInst>(this)->swapOperands();
3127 bool CmpInst::isCommutative() const {
3128 if (const ICmpInst *IC = dyn_cast<ICmpInst>(this))
3129 return IC->isCommutative();
3130 return cast<FCmpInst>(this)->isCommutative();
3133 bool CmpInst::isEquality() const {
3134 if (const ICmpInst *IC = dyn_cast<ICmpInst>(this))
3135 return IC->isEquality();
3136 return cast<FCmpInst>(this)->isEquality();
3140 CmpInst::Predicate CmpInst::getInversePredicate(Predicate pred) {
3142 default: llvm_unreachable("Unknown cmp predicate!");
3143 case ICMP_EQ: return ICMP_NE;
3144 case ICMP_NE: return ICMP_EQ;
3145 case ICMP_UGT: return ICMP_ULE;
3146 case ICMP_ULT: return ICMP_UGE;
3147 case ICMP_UGE: return ICMP_ULT;
3148 case ICMP_ULE: return ICMP_UGT;
3149 case ICMP_SGT: return ICMP_SLE;
3150 case ICMP_SLT: return ICMP_SGE;
3151 case ICMP_SGE: return ICMP_SLT;
3152 case ICMP_SLE: return ICMP_SGT;
3154 case FCMP_OEQ: return FCMP_UNE;
3155 case FCMP_ONE: return FCMP_UEQ;
3156 case FCMP_OGT: return FCMP_ULE;
3157 case FCMP_OLT: return FCMP_UGE;
3158 case FCMP_OGE: return FCMP_ULT;
3159 case FCMP_OLE: return FCMP_UGT;
3160 case FCMP_UEQ: return FCMP_ONE;
3161 case FCMP_UNE: return FCMP_OEQ;
3162 case FCMP_UGT: return FCMP_OLE;
3163 case FCMP_ULT: return FCMP_OGE;
3164 case FCMP_UGE: return FCMP_OLT;
3165 case FCMP_ULE: return FCMP_OGT;
3166 case FCMP_ORD: return FCMP_UNO;
3167 case FCMP_UNO: return FCMP_ORD;
3168 case FCMP_TRUE: return FCMP_FALSE;
3169 case FCMP_FALSE: return FCMP_TRUE;
3173 ICmpInst::Predicate ICmpInst::getSignedPredicate(Predicate pred) {
3175 default: llvm_unreachable("Unknown icmp predicate!");
3176 case ICMP_EQ: case ICMP_NE:
3177 case ICMP_SGT: case ICMP_SLT: case ICMP_SGE: case ICMP_SLE:
3179 case ICMP_UGT: return ICMP_SGT;
3180 case ICMP_ULT: return ICMP_SLT;
3181 case ICMP_UGE: return ICMP_SGE;
3182 case ICMP_ULE: return ICMP_SLE;
3186 ICmpInst::Predicate ICmpInst::getUnsignedPredicate(Predicate pred) {
3188 default: llvm_unreachable("Unknown icmp predicate!");
3189 case ICMP_EQ: case ICMP_NE:
3190 case ICMP_UGT: case ICMP_ULT: case ICMP_UGE: case ICMP_ULE:
3192 case ICMP_SGT: return ICMP_UGT;
3193 case ICMP_SLT: return ICMP_ULT;
3194 case ICMP_SGE: return ICMP_UGE;
3195 case ICMP_SLE: return ICMP_ULE;
3199 /// Initialize a set of values that all satisfy the condition with C.
3202 ICmpInst::makeConstantRange(Predicate pred, const APInt &C) {
3205 uint32_t BitWidth = C.getBitWidth();
3207 default: llvm_unreachable("Invalid ICmp opcode to ConstantRange ctor!");
3208 case ICmpInst::ICMP_EQ: ++Upper; break;
3209 case ICmpInst::ICMP_NE: ++Lower; break;
3210 case ICmpInst::ICMP_ULT:
3211 Lower = APInt::getMinValue(BitWidth);
3212 // Check for an empty-set condition.
3214 return ConstantRange(BitWidth, /*isFullSet=*/false);
3216 case ICmpInst::ICMP_SLT:
3217 Lower = APInt::getSignedMinValue(BitWidth);
3218 // Check for an empty-set condition.
3220 return ConstantRange(BitWidth, /*isFullSet=*/false);
3222 case ICmpInst::ICMP_UGT:
3223 ++Lower; Upper = APInt::getMinValue(BitWidth); // Min = Next(Max)
3224 // Check for an empty-set condition.
3226 return ConstantRange(BitWidth, /*isFullSet=*/false);
3228 case ICmpInst::ICMP_SGT:
3229 ++Lower; Upper = APInt::getSignedMinValue(BitWidth); // Min = Next(Max)
3230 // Check for an empty-set condition.
3232 return ConstantRange(BitWidth, /*isFullSet=*/false);
3234 case ICmpInst::ICMP_ULE:
3235 Lower = APInt::getMinValue(BitWidth); ++Upper;
3236 // Check for a full-set condition.
3238 return ConstantRange(BitWidth, /*isFullSet=*/true);
3240 case ICmpInst::ICMP_SLE:
3241 Lower = APInt::getSignedMinValue(BitWidth); ++Upper;
3242 // Check for a full-set condition.
3244 return ConstantRange(BitWidth, /*isFullSet=*/true);
3246 case ICmpInst::ICMP_UGE:
3247 Upper = APInt::getMinValue(BitWidth); // Min = Next(Max)
3248 // Check for a full-set condition.
3250 return ConstantRange(BitWidth, /*isFullSet=*/true);
3252 case ICmpInst::ICMP_SGE:
3253 Upper = APInt::getSignedMinValue(BitWidth); // Min = Next(Max)
3254 // Check for a full-set condition.
3256 return ConstantRange(BitWidth, /*isFullSet=*/true);
3259 return ConstantRange(Lower, Upper);
3262 CmpInst::Predicate CmpInst::getSwappedPredicate(Predicate pred) {
3264 default: llvm_unreachable("Unknown cmp predicate!");
3265 case ICMP_EQ: case ICMP_NE:
3267 case ICMP_SGT: return ICMP_SLT;
3268 case ICMP_SLT: return ICMP_SGT;
3269 case ICMP_SGE: return ICMP_SLE;
3270 case ICMP_SLE: return ICMP_SGE;
3271 case ICMP_UGT: return ICMP_ULT;
3272 case ICMP_ULT: return ICMP_UGT;
3273 case ICMP_UGE: return ICMP_ULE;
3274 case ICMP_ULE: return ICMP_UGE;
3276 case FCMP_FALSE: case FCMP_TRUE:
3277 case FCMP_OEQ: case FCMP_ONE:
3278 case FCMP_UEQ: case FCMP_UNE:
3279 case FCMP_ORD: case FCMP_UNO:
3281 case FCMP_OGT: return FCMP_OLT;
3282 case FCMP_OLT: return FCMP_OGT;
3283 case FCMP_OGE: return FCMP_OLE;
3284 case FCMP_OLE: return FCMP_OGE;
3285 case FCMP_UGT: return FCMP_ULT;
3286 case FCMP_ULT: return FCMP_UGT;
3287 case FCMP_UGE: return FCMP_ULE;
3288 case FCMP_ULE: return FCMP_UGE;
3292 bool CmpInst::isUnsigned(unsigned short predicate) {
3293 switch (predicate) {
3294 default: return false;
3295 case ICmpInst::ICMP_ULT: case ICmpInst::ICMP_ULE: case ICmpInst::ICMP_UGT:
3296 case ICmpInst::ICMP_UGE: return true;
3300 bool CmpInst::isSigned(unsigned short predicate) {
3301 switch (predicate) {
3302 default: return false;
3303 case ICmpInst::ICMP_SLT: case ICmpInst::ICMP_SLE: case ICmpInst::ICMP_SGT:
3304 case ICmpInst::ICMP_SGE: return true;
3308 bool CmpInst::isOrdered(unsigned short predicate) {
3309 switch (predicate) {
3310 default: return false;
3311 case FCmpInst::FCMP_OEQ: case FCmpInst::FCMP_ONE: case FCmpInst::FCMP_OGT:
3312 case FCmpInst::FCMP_OLT: case FCmpInst::FCMP_OGE: case FCmpInst::FCMP_OLE:
3313 case FCmpInst::FCMP_ORD: return true;
3317 bool CmpInst::isUnordered(unsigned short predicate) {
3318 switch (predicate) {
3319 default: return false;
3320 case FCmpInst::FCMP_UEQ: case FCmpInst::FCMP_UNE: case FCmpInst::FCMP_UGT:
3321 case FCmpInst::FCMP_ULT: case FCmpInst::FCMP_UGE: case FCmpInst::FCMP_ULE:
3322 case FCmpInst::FCMP_UNO: return true;
3326 bool CmpInst::isTrueWhenEqual(unsigned short predicate) {
3328 default: return false;
3329 case ICMP_EQ: case ICMP_UGE: case ICMP_ULE: case ICMP_SGE: case ICMP_SLE:
3330 case FCMP_TRUE: case FCMP_UEQ: case FCMP_UGE: case FCMP_ULE: return true;
3334 bool CmpInst::isFalseWhenEqual(unsigned short predicate) {
3336 case ICMP_NE: case ICMP_UGT: case ICMP_ULT: case ICMP_SGT: case ICMP_SLT:
3337 case FCMP_FALSE: case FCMP_ONE: case FCMP_OGT: case FCMP_OLT: return true;
3338 default: return false;
3343 //===----------------------------------------------------------------------===//
3344 // SwitchInst Implementation
3345 //===----------------------------------------------------------------------===//
3347 void SwitchInst::init(Value *Value, BasicBlock *Default, unsigned NumReserved) {
3348 assert(Value && Default && NumReserved);
3349 ReservedSpace = NumReserved;
3351 OperandList = allocHungoffUses(ReservedSpace);
3353 OperandList[0] = Value;
3354 OperandList[1] = Default;
3357 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
3358 /// switch on and a default destination. The number of additional cases can
3359 /// be specified here to make memory allocation more efficient. This
3360 /// constructor can also autoinsert before another instruction.
3361 SwitchInst::SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
3362 Instruction *InsertBefore)
3363 : TerminatorInst(Type::getVoidTy(Value->getContext()), Instruction::Switch,
3364 nullptr, 0, InsertBefore) {
3365 init(Value, Default, 2+NumCases*2);
3368 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
3369 /// switch on and a default destination. The number of additional cases can
3370 /// be specified here to make memory allocation more efficient. This
3371 /// constructor also autoinserts at the end of the specified BasicBlock.
3372 SwitchInst::SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
3373 BasicBlock *InsertAtEnd)
3374 : TerminatorInst(Type::getVoidTy(Value->getContext()), Instruction::Switch,
3375 nullptr, 0, InsertAtEnd) {
3376 init(Value, Default, 2+NumCases*2);
3379 SwitchInst::SwitchInst(const SwitchInst &SI)
3380 : TerminatorInst(SI.getType(), Instruction::Switch, nullptr, 0) {
3381 init(SI.getCondition(), SI.getDefaultDest(), SI.getNumOperands());
3382 NumOperands = SI.getNumOperands();
3383 Use *OL = OperandList, *InOL = SI.OperandList;
3384 for (unsigned i = 2, E = SI.getNumOperands(); i != E; i += 2) {
3386 OL[i+1] = InOL[i+1];
3388 SubclassOptionalData = SI.SubclassOptionalData;
3391 SwitchInst::~SwitchInst() {
3396 /// addCase - Add an entry to the switch instruction...
3398 void SwitchInst::addCase(ConstantInt *OnVal, BasicBlock *Dest) {
3399 unsigned NewCaseIdx = getNumCases();
3400 unsigned OpNo = NumOperands;
3401 if (OpNo+2 > ReservedSpace)
3402 growOperands(); // Get more space!
3403 // Initialize some new operands.
3404 assert(OpNo+1 < ReservedSpace && "Growing didn't work!");
3405 NumOperands = OpNo+2;
3406 CaseIt Case(this, NewCaseIdx);
3407 Case.setValue(OnVal);
3408 Case.setSuccessor(Dest);
3411 /// removeCase - This method removes the specified case and its successor
3412 /// from the switch instruction.
3413 void SwitchInst::removeCase(CaseIt i) {
3414 unsigned idx = i.getCaseIndex();
3416 assert(2 + idx*2 < getNumOperands() && "Case index out of range!!!");
3418 unsigned NumOps = getNumOperands();
3419 Use *OL = OperandList;
3421 // Overwrite this case with the end of the list.
3422 if (2 + (idx + 1) * 2 != NumOps) {
3423 OL[2 + idx * 2] = OL[NumOps - 2];
3424 OL[2 + idx * 2 + 1] = OL[NumOps - 1];
3427 // Nuke the last value.
3428 OL[NumOps-2].set(nullptr);
3429 OL[NumOps-2+1].set(nullptr);
3430 NumOperands = NumOps-2;
3433 /// growOperands - grow operands - This grows the operand list in response
3434 /// to a push_back style of operation. This grows the number of ops by 3 times.
3436 void SwitchInst::growOperands() {
3437 unsigned e = getNumOperands();
3438 unsigned NumOps = e*3;
3440 ReservedSpace = NumOps;
3441 Use *NewOps = allocHungoffUses(NumOps);
3442 Use *OldOps = OperandList;
3443 for (unsigned i = 0; i != e; ++i) {
3444 NewOps[i] = OldOps[i];
3446 OperandList = NewOps;
3447 Use::zap(OldOps, OldOps + e, true);
3451 BasicBlock *SwitchInst::getSuccessorV(unsigned idx) const {
3452 return getSuccessor(idx);
3454 unsigned SwitchInst::getNumSuccessorsV() const {
3455 return getNumSuccessors();
3457 void SwitchInst::setSuccessorV(unsigned idx, BasicBlock *B) {
3458 setSuccessor(idx, B);
3461 //===----------------------------------------------------------------------===//
3462 // IndirectBrInst Implementation
3463 //===----------------------------------------------------------------------===//
3465 void IndirectBrInst::init(Value *Address, unsigned NumDests) {
3466 assert(Address && Address->getType()->isPointerTy() &&
3467 "Address of indirectbr must be a pointer");
3468 ReservedSpace = 1+NumDests;
3470 OperandList = allocHungoffUses(ReservedSpace);
3472 OperandList[0] = Address;
3476 /// growOperands - grow operands - This grows the operand list in response
3477 /// to a push_back style of operation. This grows the number of ops by 2 times.
3479 void IndirectBrInst::growOperands() {
3480 unsigned e = getNumOperands();
3481 unsigned NumOps = e*2;
3483 ReservedSpace = NumOps;
3484 Use *NewOps = allocHungoffUses(NumOps);
3485 Use *OldOps = OperandList;
3486 for (unsigned i = 0; i != e; ++i)
3487 NewOps[i] = OldOps[i];
3488 OperandList = NewOps;
3489 Use::zap(OldOps, OldOps + e, true);
3492 IndirectBrInst::IndirectBrInst(Value *Address, unsigned NumCases,
3493 Instruction *InsertBefore)
3494 : TerminatorInst(Type::getVoidTy(Address->getContext()),Instruction::IndirectBr,
3495 nullptr, 0, InsertBefore) {
3496 init(Address, NumCases);
3499 IndirectBrInst::IndirectBrInst(Value *Address, unsigned NumCases,
3500 BasicBlock *InsertAtEnd)
3501 : TerminatorInst(Type::getVoidTy(Address->getContext()),Instruction::IndirectBr,
3502 nullptr, 0, InsertAtEnd) {
3503 init(Address, NumCases);
3506 IndirectBrInst::IndirectBrInst(const IndirectBrInst &IBI)
3507 : TerminatorInst(Type::getVoidTy(IBI.getContext()), Instruction::IndirectBr,
3508 allocHungoffUses(IBI.getNumOperands()),
3509 IBI.getNumOperands()) {
3510 Use *OL = OperandList, *InOL = IBI.OperandList;
3511 for (unsigned i = 0, E = IBI.getNumOperands(); i != E; ++i)
3513 SubclassOptionalData = IBI.SubclassOptionalData;
3516 IndirectBrInst::~IndirectBrInst() {
3520 /// addDestination - Add a destination.
3522 void IndirectBrInst::addDestination(BasicBlock *DestBB) {
3523 unsigned OpNo = NumOperands;
3524 if (OpNo+1 > ReservedSpace)
3525 growOperands(); // Get more space!
3526 // Initialize some new operands.
3527 assert(OpNo < ReservedSpace && "Growing didn't work!");
3528 NumOperands = OpNo+1;
3529 OperandList[OpNo] = DestBB;
3532 /// removeDestination - This method removes the specified successor from the
3533 /// indirectbr instruction.
3534 void IndirectBrInst::removeDestination(unsigned idx) {
3535 assert(idx < getNumOperands()-1 && "Successor index out of range!");
3537 unsigned NumOps = getNumOperands();
3538 Use *OL = OperandList;
3540 // Replace this value with the last one.
3541 OL[idx+1] = OL[NumOps-1];
3543 // Nuke the last value.
3544 OL[NumOps-1].set(nullptr);
3545 NumOperands = NumOps-1;
3548 BasicBlock *IndirectBrInst::getSuccessorV(unsigned idx) const {
3549 return getSuccessor(idx);
3551 unsigned IndirectBrInst::getNumSuccessorsV() const {
3552 return getNumSuccessors();
3554 void IndirectBrInst::setSuccessorV(unsigned idx, BasicBlock *B) {
3555 setSuccessor(idx, B);
3558 //===----------------------------------------------------------------------===//
3559 // clone_impl() implementations
3560 //===----------------------------------------------------------------------===//
3562 // Define these methods here so vtables don't get emitted into every translation
3563 // unit that uses these classes.
3565 GetElementPtrInst *GetElementPtrInst::clone_impl() const {
3566 return new (getNumOperands()) GetElementPtrInst(*this);
3569 BinaryOperator *BinaryOperator::clone_impl() const {
3570 return Create(getOpcode(), Op<0>(), Op<1>());
3573 FCmpInst* FCmpInst::clone_impl() const {
3574 return new FCmpInst(getPredicate(), Op<0>(), Op<1>());
3577 ICmpInst* ICmpInst::clone_impl() const {
3578 return new ICmpInst(getPredicate(), Op<0>(), Op<1>());
3581 ExtractValueInst *ExtractValueInst::clone_impl() const {
3582 return new ExtractValueInst(*this);
3585 InsertValueInst *InsertValueInst::clone_impl() const {
3586 return new InsertValueInst(*this);
3589 AllocaInst *AllocaInst::clone_impl() const {
3590 return new AllocaInst(getAllocatedType(),
3591 (Value*)getOperand(0),
3595 LoadInst *LoadInst::clone_impl() const {
3596 return new LoadInst(getOperand(0), Twine(), isVolatile(),
3597 getAlignment(), getOrdering(), getSynchScope());
3600 StoreInst *StoreInst::clone_impl() const {
3601 return new StoreInst(getOperand(0), getOperand(1), isVolatile(),
3602 getAlignment(), getOrdering(), getSynchScope());
3606 AtomicCmpXchgInst *AtomicCmpXchgInst::clone_impl() const {
3607 AtomicCmpXchgInst *Result =
3608 new AtomicCmpXchgInst(getOperand(0), getOperand(1), getOperand(2),
3609 getSuccessOrdering(), getFailureOrdering(),
3611 Result->setVolatile(isVolatile());
3615 AtomicRMWInst *AtomicRMWInst::clone_impl() const {
3616 AtomicRMWInst *Result =
3617 new AtomicRMWInst(getOperation(),getOperand(0), getOperand(1),
3618 getOrdering(), getSynchScope());
3619 Result->setVolatile(isVolatile());
3623 FenceInst *FenceInst::clone_impl() const {
3624 return new FenceInst(getContext(), getOrdering(), getSynchScope());
3627 TruncInst *TruncInst::clone_impl() const {
3628 return new TruncInst(getOperand(0), getType());
3631 ZExtInst *ZExtInst::clone_impl() const {
3632 return new ZExtInst(getOperand(0), getType());
3635 SExtInst *SExtInst::clone_impl() const {
3636 return new SExtInst(getOperand(0), getType());
3639 FPTruncInst *FPTruncInst::clone_impl() const {
3640 return new FPTruncInst(getOperand(0), getType());
3643 FPExtInst *FPExtInst::clone_impl() const {
3644 return new FPExtInst(getOperand(0), getType());
3647 UIToFPInst *UIToFPInst::clone_impl() const {
3648 return new UIToFPInst(getOperand(0), getType());
3651 SIToFPInst *SIToFPInst::clone_impl() const {
3652 return new SIToFPInst(getOperand(0), getType());
3655 FPToUIInst *FPToUIInst::clone_impl() const {
3656 return new FPToUIInst(getOperand(0), getType());
3659 FPToSIInst *FPToSIInst::clone_impl() const {
3660 return new FPToSIInst(getOperand(0), getType());
3663 PtrToIntInst *PtrToIntInst::clone_impl() const {
3664 return new PtrToIntInst(getOperand(0), getType());
3667 IntToPtrInst *IntToPtrInst::clone_impl() const {
3668 return new IntToPtrInst(getOperand(0), getType());
3671 BitCastInst *BitCastInst::clone_impl() const {
3672 return new BitCastInst(getOperand(0), getType());
3675 AddrSpaceCastInst *AddrSpaceCastInst::clone_impl() const {
3676 return new AddrSpaceCastInst(getOperand(0), getType());
3679 CallInst *CallInst::clone_impl() const {
3680 return new(getNumOperands()) CallInst(*this);
3683 SelectInst *SelectInst::clone_impl() const {
3684 return SelectInst::Create(getOperand(0), getOperand(1), getOperand(2));
3687 VAArgInst *VAArgInst::clone_impl() const {
3688 return new VAArgInst(getOperand(0), getType());
3691 ExtractElementInst *ExtractElementInst::clone_impl() const {
3692 return ExtractElementInst::Create(getOperand(0), getOperand(1));
3695 InsertElementInst *InsertElementInst::clone_impl() const {
3696 return InsertElementInst::Create(getOperand(0), getOperand(1), getOperand(2));
3699 ShuffleVectorInst *ShuffleVectorInst::clone_impl() const {
3700 return new ShuffleVectorInst(getOperand(0), getOperand(1), getOperand(2));
3703 PHINode *PHINode::clone_impl() const {
3704 return new PHINode(*this);
3707 LandingPadInst *LandingPadInst::clone_impl() const {
3708 return new LandingPadInst(*this);
3711 ReturnInst *ReturnInst::clone_impl() const {
3712 return new(getNumOperands()) ReturnInst(*this);
3715 BranchInst *BranchInst::clone_impl() const {
3716 return new(getNumOperands()) BranchInst(*this);
3719 SwitchInst *SwitchInst::clone_impl() const {
3720 return new SwitchInst(*this);
3723 IndirectBrInst *IndirectBrInst::clone_impl() const {
3724 return new IndirectBrInst(*this);
3728 InvokeInst *InvokeInst::clone_impl() const {
3729 return new(getNumOperands()) InvokeInst(*this);
3732 ResumeInst *ResumeInst::clone_impl() const {
3733 return new(1) ResumeInst(*this);
3736 UnreachableInst *UnreachableInst::clone_impl() const {
3737 LLVMContext &Context = getContext();
3738 return new UnreachableInst(Context);