[opaque pointer type] Avoid using PointerType::getElementType for a few cases of...
[oota-llvm.git] / lib / IR / Instructions.cpp
1 //===-- Instructions.cpp - Implement the LLVM instructions ----------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements all of the non-inline methods for the LLVM instruction
11 // classes.
12 //
13 //===----------------------------------------------------------------------===//
14
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"
27 using namespace llvm;
28
29 //===----------------------------------------------------------------------===//
30 //                            CallSite Class
31 //===----------------------------------------------------------------------===//
32
33 User::op_iterator CallSite::getCallee() const {
34   Instruction *II(getInstruction());
35   return isCall()
36     ? cast<CallInst>(II)->op_end() - 1 // Skip Callee
37     : cast<InvokeInst>(II)->op_end() - 3; // Skip BB, BB, Callee
38 }
39
40 //===----------------------------------------------------------------------===//
41 //                            TerminatorInst Class
42 //===----------------------------------------------------------------------===//
43
44 // Out of line virtual method, so the vtable, etc has a home.
45 TerminatorInst::~TerminatorInst() {
46 }
47
48 //===----------------------------------------------------------------------===//
49 //                           UnaryInstruction Class
50 //===----------------------------------------------------------------------===//
51
52 // Out of line virtual method, so the vtable, etc has a home.
53 UnaryInstruction::~UnaryInstruction() {
54 }
55
56 //===----------------------------------------------------------------------===//
57 //                              SelectInst Class
58 //===----------------------------------------------------------------------===//
59
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";
65   
66   if (VectorType *VT = dyn_cast<VectorType>(Op0->getType())) {
67     // Vector select.
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());
71     if (!ET)
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>";
78   }
79   return nullptr;
80 }
81
82
83 //===----------------------------------------------------------------------===//
84 //                               PHINode Class
85 //===----------------------------------------------------------------------===//
86
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;
94 }
95
96 PHINode::~PHINode() {
97   dropHungoffUses();
98 }
99
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);
110 }
111
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);
116
117   // Move everything after this operand down.
118   //
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);
124
125   // Nuke the last value.
126   Op<-1>().set(nullptr);
127   --NumOperands;
128
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()));
133     eraseFromParent();
134   }
135   return Removed;
136 }
137
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
140 /// times.
141 ///
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.
146
147   Use *OldOps = op_begin();
148   BasicBlock **OldBlocks = block_begin();
149
150   ReservedSpace = NumOps;
151   OperandList = allocHungoffUses(ReservedSpace);
152
153   std::copy(OldOps, OldOps + e, op_begin());
154   std::copy(OldBlocks, OldBlocks + e, block_begin());
155
156   Use::zap(OldOps, OldOps + e, true);
157 }
158
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);
170     }
171   if (ConstantValue == this)
172     return UndefValue::get(getType());
173   return ConstantValue;
174 }
175
176 //===----------------------------------------------------------------------===//
177 //                       LandingPadInst Implementation
178 //===----------------------------------------------------------------------===//
179
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);
185 }
186
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);
192 }
193
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)
200     OL[I] = InOL[I];
201
202   setCleanup(LP.isCleanup());
203 }
204
205 LandingPadInst::~LandingPadInst() {
206   dropHungoffUses();
207 }
208
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,
214                             InsertBefore);
215 }
216
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,
222                             InsertAtEnd);
223 }
224
225 void LandingPadInst::init(Value *PersFn, unsigned NumReservedValues,
226                           const Twine &NameStr) {
227   ReservedSpace = NumReservedValues;
228   NumOperands = 1;
229   OperandList = allocHungoffUses(ReservedSpace);
230   OperandList[0] = PersFn;
231   setName(NameStr);
232   setCleanup(false);
233 }
234
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;
241
242   Use *NewOps = allocHungoffUses(ReservedSpace);
243   Use *OldOps = OperandList;
244   for (unsigned i = 0; i != e; ++i)
245       NewOps[i] = OldOps[i];
246
247   OperandList = NewOps;
248   Use::zap(OldOps, OldOps + e, true);
249 }
250
251 void LandingPadInst::addClause(Constant *Val) {
252   unsigned OpNo = getNumOperands();
253   growOperands(1);
254   assert(OpNo < ReservedSpace && "Growing didn't work!");
255   ++NumOperands;
256   OperandList[OpNo] = Val;
257 }
258
259 //===----------------------------------------------------------------------===//
260 //                        CallInst Implementation
261 //===----------------------------------------------------------------------===//
262
263 CallInst::~CallInst() {
264 }
265
266 void CallInst::init(FunctionType *FTy, Value *Func, ArrayRef<Value *> Args,
267                     const Twine &NameStr) {
268   this->FTy = FTy;
269   assert(NumOperands == Args.size() + 1 && "NumOperands not set up?");
270   Op<-1>() = Func;
271
272 #ifndef NDEBUG
273   assert((Args.size() == FTy->getNumParams() ||
274           (FTy->isVarArg() && Args.size() > FTy->getNumParams())) &&
275          "Calling a function with bad signature!");
276
277   for (unsigned i = 0; i != Args.size(); ++i)
278     assert((i >= FTy->getNumParams() || 
279             FTy->getParamType(i) == Args[i]->getType()) &&
280            "Calling a function with a bad signature!");
281 #endif
282
283   std::copy(Args.begin(), Args.end(), op_begin());
284   setName(NameStr);
285 }
286
287 void CallInst::init(Value *Func, const Twine &NameStr) {
288   FTy =
289       cast<FunctionType>(cast<PointerType>(Func->getType())->getElementType());
290   assert(NumOperands == 1 && "NumOperands not set up?");
291   Op<-1>() = Func;
292
293   assert(FTy->getNumParams() == 0 && "Calling a function with bad signature");
294
295   setName(NameStr);
296 }
297
298 CallInst::CallInst(Value *Func, const Twine &Name,
299                    Instruction *InsertBefore)
300   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
301                                    ->getElementType())->getReturnType(),
302                 Instruction::Call,
303                 OperandTraits<CallInst>::op_end(this) - 1,
304                 1, InsertBefore) {
305   init(Func, Name);
306 }
307
308 CallInst::CallInst(Value *Func, const Twine &Name,
309                    BasicBlock *InsertAtEnd)
310   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
311                                    ->getElementType())->getReturnType(),
312                 Instruction::Call,
313                 OperandTraits<CallInst>::op_end(this) - 1,
314                 1, InsertAtEnd) {
315   init(Func, Name);
316 }
317
318 CallInst::CallInst(const CallInst &CI)
319     : Instruction(CI.getType(), Instruction::Call,
320                   OperandTraits<CallInst>::op_end(this) - CI.getNumOperands(),
321                   CI.getNumOperands()),
322       AttributeList(CI.AttributeList), FTy(CI.FTy) {
323   setTailCallKind(CI.getTailCallKind());
324   setCallingConv(CI.getCallingConv());
325     
326   std::copy(CI.op_begin(), CI.op_end(), op_begin());
327   SubclassOptionalData = CI.SubclassOptionalData;
328 }
329
330 void CallInst::addAttribute(unsigned i, Attribute::AttrKind attr) {
331   AttributeSet PAL = getAttributes();
332   PAL = PAL.addAttribute(getContext(), i, attr);
333   setAttributes(PAL);
334 }
335
336 void CallInst::removeAttribute(unsigned i, Attribute attr) {
337   AttributeSet PAL = getAttributes();
338   AttrBuilder B(attr);
339   LLVMContext &Context = getContext();
340   PAL = PAL.removeAttributes(Context, i,
341                              AttributeSet::get(Context, i, B));
342   setAttributes(PAL);
343 }
344
345 void CallInst::addDereferenceableAttr(unsigned i, uint64_t Bytes) {
346   AttributeSet PAL = getAttributes();
347   PAL = PAL.addDereferenceableAttr(getContext(), i, Bytes);
348   setAttributes(PAL);
349 }
350
351 void CallInst::addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes) {
352   AttributeSet PAL = getAttributes();
353   PAL = PAL.addDereferenceableOrNullAttr(getContext(), i, Bytes);
354   setAttributes(PAL);
355 }
356
357 bool CallInst::hasFnAttrImpl(Attribute::AttrKind A) const {
358   if (AttributeList.hasAttribute(AttributeSet::FunctionIndex, A))
359     return true;
360   if (const Function *F = getCalledFunction())
361     return F->getAttributes().hasAttribute(AttributeSet::FunctionIndex, A);
362   return false;
363 }
364
365 bool CallInst::paramHasAttr(unsigned i, Attribute::AttrKind A) const {
366   if (AttributeList.hasAttribute(i, A))
367     return true;
368   if (const Function *F = getCalledFunction())
369     return F->getAttributes().hasAttribute(i, A);
370   return false;
371 }
372
373 /// IsConstantOne - Return true only if val is constant int 1
374 static bool IsConstantOne(Value *val) {
375   assert(val && "IsConstantOne does not work with nullptr val");
376   const ConstantInt *CVal = dyn_cast<ConstantInt>(val);
377   return CVal && CVal->isOne();
378 }
379
380 static Instruction *createMalloc(Instruction *InsertBefore,
381                                  BasicBlock *InsertAtEnd, Type *IntPtrTy,
382                                  Type *AllocTy, Value *AllocSize, 
383                                  Value *ArraySize, Function *MallocF,
384                                  const Twine &Name) {
385   assert(((!InsertBefore && InsertAtEnd) || (InsertBefore && !InsertAtEnd)) &&
386          "createMalloc needs either InsertBefore or InsertAtEnd");
387
388   // malloc(type) becomes: 
389   //       bitcast (i8* malloc(typeSize)) to type*
390   // malloc(type, arraySize) becomes:
391   //       bitcast (i8 *malloc(typeSize*arraySize)) to type*
392   if (!ArraySize)
393     ArraySize = ConstantInt::get(IntPtrTy, 1);
394   else if (ArraySize->getType() != IntPtrTy) {
395     if (InsertBefore)
396       ArraySize = CastInst::CreateIntegerCast(ArraySize, IntPtrTy, false,
397                                               "", InsertBefore);
398     else
399       ArraySize = CastInst::CreateIntegerCast(ArraySize, IntPtrTy, false,
400                                               "", InsertAtEnd);
401   }
402
403   if (!IsConstantOne(ArraySize)) {
404     if (IsConstantOne(AllocSize)) {
405       AllocSize = ArraySize;         // Operand * 1 = Operand
406     } else if (Constant *CO = dyn_cast<Constant>(ArraySize)) {
407       Constant *Scale = ConstantExpr::getIntegerCast(CO, IntPtrTy,
408                                                      false /*ZExt*/);
409       // Malloc arg is constant product of type size and array size
410       AllocSize = ConstantExpr::getMul(Scale, cast<Constant>(AllocSize));
411     } else {
412       // Multiply type size by the array size...
413       if (InsertBefore)
414         AllocSize = BinaryOperator::CreateMul(ArraySize, AllocSize,
415                                               "mallocsize", InsertBefore);
416       else
417         AllocSize = BinaryOperator::CreateMul(ArraySize, AllocSize,
418                                               "mallocsize", InsertAtEnd);
419     }
420   }
421
422   assert(AllocSize->getType() == IntPtrTy && "malloc arg is wrong size");
423   // Create the call to Malloc.
424   BasicBlock* BB = InsertBefore ? InsertBefore->getParent() : InsertAtEnd;
425   Module* M = BB->getParent()->getParent();
426   Type *BPTy = Type::getInt8PtrTy(BB->getContext());
427   Value *MallocFunc = MallocF;
428   if (!MallocFunc)
429     // prototype malloc as "void *malloc(size_t)"
430     MallocFunc = M->getOrInsertFunction("malloc", BPTy, IntPtrTy, nullptr);
431   PointerType *AllocPtrType = PointerType::getUnqual(AllocTy);
432   CallInst *MCall = nullptr;
433   Instruction *Result = nullptr;
434   if (InsertBefore) {
435     MCall = CallInst::Create(MallocFunc, AllocSize, "malloccall", InsertBefore);
436     Result = MCall;
437     if (Result->getType() != AllocPtrType)
438       // Create a cast instruction to convert to the right type...
439       Result = new BitCastInst(MCall, AllocPtrType, Name, InsertBefore);
440   } else {
441     MCall = CallInst::Create(MallocFunc, AllocSize, "malloccall");
442     Result = MCall;
443     if (Result->getType() != AllocPtrType) {
444       InsertAtEnd->getInstList().push_back(MCall);
445       // Create a cast instruction to convert to the right type...
446       Result = new BitCastInst(MCall, AllocPtrType, Name);
447     }
448   }
449   MCall->setTailCall();
450   if (Function *F = dyn_cast<Function>(MallocFunc)) {
451     MCall->setCallingConv(F->getCallingConv());
452     if (!F->doesNotAlias(0)) F->setDoesNotAlias(0);
453   }
454   assert(!MCall->getType()->isVoidTy() && "Malloc has void return type");
455
456   return Result;
457 }
458
459 /// CreateMalloc - Generate the IR for a call to malloc:
460 /// 1. Compute the malloc call's argument as the specified type's size,
461 ///    possibly multiplied by the array size if the array size is not
462 ///    constant 1.
463 /// 2. Call malloc with that argument.
464 /// 3. Bitcast the result of the malloc call to the specified type.
465 Instruction *CallInst::CreateMalloc(Instruction *InsertBefore,
466                                     Type *IntPtrTy, Type *AllocTy,
467                                     Value *AllocSize, Value *ArraySize,
468                                     Function * MallocF,
469                                     const Twine &Name) {
470   return createMalloc(InsertBefore, nullptr, IntPtrTy, AllocTy, AllocSize,
471                       ArraySize, MallocF, Name);
472 }
473
474 /// CreateMalloc - Generate the IR for a call to malloc:
475 /// 1. Compute the malloc call's argument as the specified type's size,
476 ///    possibly multiplied by the array size if the array size is not
477 ///    constant 1.
478 /// 2. Call malloc with that argument.
479 /// 3. Bitcast the result of the malloc call to the specified type.
480 /// Note: This function does not add the bitcast to the basic block, that is the
481 /// responsibility of the caller.
482 Instruction *CallInst::CreateMalloc(BasicBlock *InsertAtEnd,
483                                     Type *IntPtrTy, Type *AllocTy,
484                                     Value *AllocSize, Value *ArraySize, 
485                                     Function *MallocF, const Twine &Name) {
486   return createMalloc(nullptr, InsertAtEnd, IntPtrTy, AllocTy, AllocSize,
487                       ArraySize, MallocF, Name);
488 }
489
490 static Instruction* createFree(Value* Source, Instruction *InsertBefore,
491                                BasicBlock *InsertAtEnd) {
492   assert(((!InsertBefore && InsertAtEnd) || (InsertBefore && !InsertAtEnd)) &&
493          "createFree needs either InsertBefore or InsertAtEnd");
494   assert(Source->getType()->isPointerTy() &&
495          "Can not free something of nonpointer type!");
496
497   BasicBlock* BB = InsertBefore ? InsertBefore->getParent() : InsertAtEnd;
498   Module* M = BB->getParent()->getParent();
499
500   Type *VoidTy = Type::getVoidTy(M->getContext());
501   Type *IntPtrTy = Type::getInt8PtrTy(M->getContext());
502   // prototype free as "void free(void*)"
503   Value *FreeFunc = M->getOrInsertFunction("free", VoidTy, IntPtrTy, nullptr);
504   CallInst* Result = nullptr;
505   Value *PtrCast = Source;
506   if (InsertBefore) {
507     if (Source->getType() != IntPtrTy)
508       PtrCast = new BitCastInst(Source, IntPtrTy, "", InsertBefore);
509     Result = CallInst::Create(FreeFunc, PtrCast, "", InsertBefore);
510   } else {
511     if (Source->getType() != IntPtrTy)
512       PtrCast = new BitCastInst(Source, IntPtrTy, "", InsertAtEnd);
513     Result = CallInst::Create(FreeFunc, PtrCast, "");
514   }
515   Result->setTailCall();
516   if (Function *F = dyn_cast<Function>(FreeFunc))
517     Result->setCallingConv(F->getCallingConv());
518
519   return Result;
520 }
521
522 /// CreateFree - Generate the IR for a call to the builtin free function.
523 Instruction * CallInst::CreateFree(Value* Source, Instruction *InsertBefore) {
524   return createFree(Source, InsertBefore, nullptr);
525 }
526
527 /// CreateFree - Generate the IR for a call to the builtin free function.
528 /// Note: This function does not add the call to the basic block, that is the
529 /// responsibility of the caller.
530 Instruction* CallInst::CreateFree(Value* Source, BasicBlock *InsertAtEnd) {
531   Instruction* FreeCall = createFree(Source, nullptr, InsertAtEnd);
532   assert(FreeCall && "CreateFree did not create a CallInst");
533   return FreeCall;
534 }
535
536 //===----------------------------------------------------------------------===//
537 //                        InvokeInst Implementation
538 //===----------------------------------------------------------------------===//
539
540 void InvokeInst::init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
541                       ArrayRef<Value *> Args, const Twine &NameStr) {
542   FTy = cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType());
543
544   assert(NumOperands == 3 + Args.size() && "NumOperands not set up?");
545   Op<-3>() = Fn;
546   Op<-2>() = IfNormal;
547   Op<-1>() = IfException;
548
549 #ifndef NDEBUG
550   assert(((Args.size() == FTy->getNumParams()) ||
551           (FTy->isVarArg() && Args.size() > FTy->getNumParams())) &&
552          "Invoking a function with bad signature");
553
554   for (unsigned i = 0, e = Args.size(); i != e; i++)
555     assert((i >= FTy->getNumParams() || 
556             FTy->getParamType(i) == Args[i]->getType()) &&
557            "Invoking a function with a bad signature!");
558 #endif
559
560   std::copy(Args.begin(), Args.end(), op_begin());
561   setName(NameStr);
562 }
563
564 InvokeInst::InvokeInst(const InvokeInst &II)
565     : TerminatorInst(II.getType(), Instruction::Invoke,
566                      OperandTraits<InvokeInst>::op_end(this) -
567                          II.getNumOperands(),
568                      II.getNumOperands()),
569       AttributeList(II.AttributeList), FTy(II.FTy) {
570   setCallingConv(II.getCallingConv());
571   std::copy(II.op_begin(), II.op_end(), op_begin());
572   SubclassOptionalData = II.SubclassOptionalData;
573 }
574
575 BasicBlock *InvokeInst::getSuccessorV(unsigned idx) const {
576   return getSuccessor(idx);
577 }
578 unsigned InvokeInst::getNumSuccessorsV() const {
579   return getNumSuccessors();
580 }
581 void InvokeInst::setSuccessorV(unsigned idx, BasicBlock *B) {
582   return setSuccessor(idx, B);
583 }
584
585 bool InvokeInst::hasFnAttrImpl(Attribute::AttrKind A) const {
586   if (AttributeList.hasAttribute(AttributeSet::FunctionIndex, A))
587     return true;
588   if (const Function *F = getCalledFunction())
589     return F->getAttributes().hasAttribute(AttributeSet::FunctionIndex, A);
590   return false;
591 }
592
593 bool InvokeInst::paramHasAttr(unsigned i, Attribute::AttrKind A) const {
594   if (AttributeList.hasAttribute(i, A))
595     return true;
596   if (const Function *F = getCalledFunction())
597     return F->getAttributes().hasAttribute(i, A);
598   return false;
599 }
600
601 void InvokeInst::addAttribute(unsigned i, Attribute::AttrKind attr) {
602   AttributeSet PAL = getAttributes();
603   PAL = PAL.addAttribute(getContext(), i, attr);
604   setAttributes(PAL);
605 }
606
607 void InvokeInst::removeAttribute(unsigned i, Attribute attr) {
608   AttributeSet PAL = getAttributes();
609   AttrBuilder B(attr);
610   PAL = PAL.removeAttributes(getContext(), i,
611                              AttributeSet::get(getContext(), i, B));
612   setAttributes(PAL);
613 }
614
615 void InvokeInst::addDereferenceableAttr(unsigned i, uint64_t Bytes) {
616   AttributeSet PAL = getAttributes();
617   PAL = PAL.addDereferenceableAttr(getContext(), i, Bytes);
618   setAttributes(PAL);
619 }
620
621 void InvokeInst::addDereferenceableOrNullAttr(unsigned i, uint64_t Bytes) {
622   AttributeSet PAL = getAttributes();
623   PAL = PAL.addDereferenceableOrNullAttr(getContext(), i, Bytes);
624   setAttributes(PAL);
625 }
626
627 LandingPadInst *InvokeInst::getLandingPadInst() const {
628   return cast<LandingPadInst>(getUnwindDest()->getFirstNonPHI());
629 }
630
631 //===----------------------------------------------------------------------===//
632 //                        ReturnInst Implementation
633 //===----------------------------------------------------------------------===//
634
635 ReturnInst::ReturnInst(const ReturnInst &RI)
636   : TerminatorInst(Type::getVoidTy(RI.getContext()), Instruction::Ret,
637                    OperandTraits<ReturnInst>::op_end(this) -
638                      RI.getNumOperands(),
639                    RI.getNumOperands()) {
640   if (RI.getNumOperands())
641     Op<0>() = RI.Op<0>();
642   SubclassOptionalData = RI.SubclassOptionalData;
643 }
644
645 ReturnInst::ReturnInst(LLVMContext &C, Value *retVal, Instruction *InsertBefore)
646   : TerminatorInst(Type::getVoidTy(C), Instruction::Ret,
647                    OperandTraits<ReturnInst>::op_end(this) - !!retVal, !!retVal,
648                    InsertBefore) {
649   if (retVal)
650     Op<0>() = retVal;
651 }
652 ReturnInst::ReturnInst(LLVMContext &C, Value *retVal, BasicBlock *InsertAtEnd)
653   : TerminatorInst(Type::getVoidTy(C), Instruction::Ret,
654                    OperandTraits<ReturnInst>::op_end(this) - !!retVal, !!retVal,
655                    InsertAtEnd) {
656   if (retVal)
657     Op<0>() = retVal;
658 }
659 ReturnInst::ReturnInst(LLVMContext &Context, BasicBlock *InsertAtEnd)
660   : TerminatorInst(Type::getVoidTy(Context), Instruction::Ret,
661                    OperandTraits<ReturnInst>::op_end(this), 0, InsertAtEnd) {
662 }
663
664 unsigned ReturnInst::getNumSuccessorsV() const {
665   return getNumSuccessors();
666 }
667
668 /// Out-of-line ReturnInst method, put here so the C++ compiler can choose to
669 /// emit the vtable for the class in this translation unit.
670 void ReturnInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
671   llvm_unreachable("ReturnInst has no successors!");
672 }
673
674 BasicBlock *ReturnInst::getSuccessorV(unsigned idx) const {
675   llvm_unreachable("ReturnInst has no successors!");
676 }
677
678 ReturnInst::~ReturnInst() {
679 }
680
681 //===----------------------------------------------------------------------===//
682 //                        ResumeInst Implementation
683 //===----------------------------------------------------------------------===//
684
685 ResumeInst::ResumeInst(const ResumeInst &RI)
686   : TerminatorInst(Type::getVoidTy(RI.getContext()), Instruction::Resume,
687                    OperandTraits<ResumeInst>::op_begin(this), 1) {
688   Op<0>() = RI.Op<0>();
689 }
690
691 ResumeInst::ResumeInst(Value *Exn, Instruction *InsertBefore)
692   : TerminatorInst(Type::getVoidTy(Exn->getContext()), Instruction::Resume,
693                    OperandTraits<ResumeInst>::op_begin(this), 1, InsertBefore) {
694   Op<0>() = Exn;
695 }
696
697 ResumeInst::ResumeInst(Value *Exn, BasicBlock *InsertAtEnd)
698   : TerminatorInst(Type::getVoidTy(Exn->getContext()), Instruction::Resume,
699                    OperandTraits<ResumeInst>::op_begin(this), 1, InsertAtEnd) {
700   Op<0>() = Exn;
701 }
702
703 unsigned ResumeInst::getNumSuccessorsV() const {
704   return getNumSuccessors();
705 }
706
707 void ResumeInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
708   llvm_unreachable("ResumeInst has no successors!");
709 }
710
711 BasicBlock *ResumeInst::getSuccessorV(unsigned idx) const {
712   llvm_unreachable("ResumeInst has no successors!");
713 }
714
715 //===----------------------------------------------------------------------===//
716 //                      UnreachableInst Implementation
717 //===----------------------------------------------------------------------===//
718
719 UnreachableInst::UnreachableInst(LLVMContext &Context, 
720                                  Instruction *InsertBefore)
721   : TerminatorInst(Type::getVoidTy(Context), Instruction::Unreachable,
722                    nullptr, 0, InsertBefore) {
723 }
724 UnreachableInst::UnreachableInst(LLVMContext &Context, BasicBlock *InsertAtEnd)
725   : TerminatorInst(Type::getVoidTy(Context), Instruction::Unreachable,
726                    nullptr, 0, InsertAtEnd) {
727 }
728
729 unsigned UnreachableInst::getNumSuccessorsV() const {
730   return getNumSuccessors();
731 }
732
733 void UnreachableInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
734   llvm_unreachable("UnreachableInst has no successors!");
735 }
736
737 BasicBlock *UnreachableInst::getSuccessorV(unsigned idx) const {
738   llvm_unreachable("UnreachableInst has no successors!");
739 }
740
741 //===----------------------------------------------------------------------===//
742 //                        BranchInst Implementation
743 //===----------------------------------------------------------------------===//
744
745 void BranchInst::AssertOK() {
746   if (isConditional())
747     assert(getCondition()->getType()->isIntegerTy(1) &&
748            "May only branch on boolean predicates!");
749 }
750
751 BranchInst::BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore)
752   : TerminatorInst(Type::getVoidTy(IfTrue->getContext()), Instruction::Br,
753                    OperandTraits<BranchInst>::op_end(this) - 1,
754                    1, InsertBefore) {
755   assert(IfTrue && "Branch destination may not be null!");
756   Op<-1>() = IfTrue;
757 }
758 BranchInst::BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
759                        Instruction *InsertBefore)
760   : TerminatorInst(Type::getVoidTy(IfTrue->getContext()), Instruction::Br,
761                    OperandTraits<BranchInst>::op_end(this) - 3,
762                    3, InsertBefore) {
763   Op<-1>() = IfTrue;
764   Op<-2>() = IfFalse;
765   Op<-3>() = Cond;
766 #ifndef NDEBUG
767   AssertOK();
768 #endif
769 }
770
771 BranchInst::BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd)
772   : TerminatorInst(Type::getVoidTy(IfTrue->getContext()), Instruction::Br,
773                    OperandTraits<BranchInst>::op_end(this) - 1,
774                    1, InsertAtEnd) {
775   assert(IfTrue && "Branch destination may not be null!");
776   Op<-1>() = IfTrue;
777 }
778
779 BranchInst::BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
780            BasicBlock *InsertAtEnd)
781   : TerminatorInst(Type::getVoidTy(IfTrue->getContext()), Instruction::Br,
782                    OperandTraits<BranchInst>::op_end(this) - 3,
783                    3, InsertAtEnd) {
784   Op<-1>() = IfTrue;
785   Op<-2>() = IfFalse;
786   Op<-3>() = Cond;
787 #ifndef NDEBUG
788   AssertOK();
789 #endif
790 }
791
792
793 BranchInst::BranchInst(const BranchInst &BI) :
794   TerminatorInst(Type::getVoidTy(BI.getContext()), Instruction::Br,
795                  OperandTraits<BranchInst>::op_end(this) - BI.getNumOperands(),
796                  BI.getNumOperands()) {
797   Op<-1>() = BI.Op<-1>();
798   if (BI.getNumOperands() != 1) {
799     assert(BI.getNumOperands() == 3 && "BR can have 1 or 3 operands!");
800     Op<-3>() = BI.Op<-3>();
801     Op<-2>() = BI.Op<-2>();
802   }
803   SubclassOptionalData = BI.SubclassOptionalData;
804 }
805
806 void BranchInst::swapSuccessors() {
807   assert(isConditional() &&
808          "Cannot swap successors of an unconditional branch");
809   Op<-1>().swap(Op<-2>());
810
811   // Update profile metadata if present and it matches our structural
812   // expectations.
813   MDNode *ProfileData = getMetadata(LLVMContext::MD_prof);
814   if (!ProfileData || ProfileData->getNumOperands() != 3)
815     return;
816
817   // The first operand is the name. Fetch them backwards and build a new one.
818   Metadata *Ops[] = {ProfileData->getOperand(0), ProfileData->getOperand(2),
819                      ProfileData->getOperand(1)};
820   setMetadata(LLVMContext::MD_prof,
821               MDNode::get(ProfileData->getContext(), Ops));
822 }
823
824 BasicBlock *BranchInst::getSuccessorV(unsigned idx) const {
825   return getSuccessor(idx);
826 }
827 unsigned BranchInst::getNumSuccessorsV() const {
828   return getNumSuccessors();
829 }
830 void BranchInst::setSuccessorV(unsigned idx, BasicBlock *B) {
831   setSuccessor(idx, B);
832 }
833
834
835 //===----------------------------------------------------------------------===//
836 //                        AllocaInst Implementation
837 //===----------------------------------------------------------------------===//
838
839 static Value *getAISize(LLVMContext &Context, Value *Amt) {
840   if (!Amt)
841     Amt = ConstantInt::get(Type::getInt32Ty(Context), 1);
842   else {
843     assert(!isa<BasicBlock>(Amt) &&
844            "Passed basic block into allocation size parameter! Use other ctor");
845     assert(Amt->getType()->isIntegerTy() &&
846            "Allocation array size is not an integer!");
847   }
848   return Amt;
849 }
850
851 AllocaInst::AllocaInst(Type *Ty, const Twine &Name, Instruction *InsertBefore)
852     : AllocaInst(Ty, /*ArraySize=*/nullptr, Name, InsertBefore) {}
853
854 AllocaInst::AllocaInst(Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd)
855     : AllocaInst(Ty, /*ArraySize=*/nullptr, Name, InsertAtEnd) {}
856
857 AllocaInst::AllocaInst(Type *Ty, Value *ArraySize, const Twine &Name,
858                        Instruction *InsertBefore)
859     : AllocaInst(Ty, ArraySize, /*Align=*/0, Name, InsertBefore) {}
860
861 AllocaInst::AllocaInst(Type *Ty, Value *ArraySize, const Twine &Name,
862                        BasicBlock *InsertAtEnd)
863     : AllocaInst(Ty, ArraySize, /*Align=*/0, Name, InsertAtEnd) {}
864
865 AllocaInst::AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
866                        const Twine &Name, Instruction *InsertBefore)
867   : UnaryInstruction(PointerType::getUnqual(Ty), Alloca,
868                      getAISize(Ty->getContext(), ArraySize), InsertBefore) {
869   setAlignment(Align);
870   assert(!Ty->isVoidTy() && "Cannot allocate void!");
871   setName(Name);
872 }
873
874 AllocaInst::AllocaInst(Type *Ty, Value *ArraySize, unsigned Align,
875                        const Twine &Name, BasicBlock *InsertAtEnd)
876   : UnaryInstruction(PointerType::getUnqual(Ty), Alloca,
877                      getAISize(Ty->getContext(), ArraySize), InsertAtEnd) {
878   setAlignment(Align);
879   assert(!Ty->isVoidTy() && "Cannot allocate void!");
880   setName(Name);
881 }
882
883 // Out of line virtual method, so the vtable, etc has a home.
884 AllocaInst::~AllocaInst() {
885 }
886
887 void AllocaInst::setAlignment(unsigned Align) {
888   assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
889   assert(Align <= MaximumAlignment &&
890          "Alignment is greater than MaximumAlignment!");
891   setInstructionSubclassData((getSubclassDataFromInstruction() & ~31) |
892                              (Log2_32(Align) + 1));
893   assert(getAlignment() == Align && "Alignment representation error!");
894 }
895
896 bool AllocaInst::isArrayAllocation() const {
897   if (ConstantInt *CI = dyn_cast<ConstantInt>(getOperand(0)))
898     return !CI->isOne();
899   return true;
900 }
901
902 Type *AllocaInst::getAllocatedType() const {
903   return getType()->getElementType();
904 }
905
906 /// isStaticAlloca - Return true if this alloca is in the entry block of the
907 /// function and is a constant size.  If so, the code generator will fold it
908 /// into the prolog/epilog code, so it is basically free.
909 bool AllocaInst::isStaticAlloca() const {
910   // Must be constant size.
911   if (!isa<ConstantInt>(getArraySize())) return false;
912   
913   // Must be in the entry block.
914   const BasicBlock *Parent = getParent();
915   return Parent == &Parent->getParent()->front() && !isUsedWithInAlloca();
916 }
917
918 //===----------------------------------------------------------------------===//
919 //                           LoadInst Implementation
920 //===----------------------------------------------------------------------===//
921
922 void LoadInst::AssertOK() {
923   assert(getOperand(0)->getType()->isPointerTy() &&
924          "Ptr must have pointer type.");
925   assert(!(isAtomic() && getAlignment() == 0) &&
926          "Alignment required for atomic load");
927 }
928
929 LoadInst::LoadInst(Value *Ptr, const Twine &Name, Instruction *InsertBef)
930     : LoadInst(Ptr, Name, /*isVolatile=*/false, InsertBef) {}
931
932 LoadInst::LoadInst(Value *Ptr, const Twine &Name, BasicBlock *InsertAE)
933     : LoadInst(Ptr, Name, /*isVolatile=*/false, InsertAE) {}
934
935 LoadInst::LoadInst(Value *Ptr, const Twine &Name, bool isVolatile,
936                    Instruction *InsertBef)
937     : LoadInst(Ptr, Name, isVolatile, /*Align=*/0, InsertBef) {}
938
939 LoadInst::LoadInst(Value *Ptr, const Twine &Name, bool isVolatile,
940                    BasicBlock *InsertAE)
941     : LoadInst(Ptr, Name, isVolatile, /*Align=*/0, InsertAE) {}
942
943 LoadInst::LoadInst(Type *Ty, Value *Ptr, const Twine &Name, bool isVolatile,
944                    unsigned Align, Instruction *InsertBef)
945     : LoadInst(Ty, Ptr, Name, isVolatile, Align, NotAtomic, CrossThread,
946                InsertBef) {}
947
948 LoadInst::LoadInst(Value *Ptr, const Twine &Name, bool isVolatile,
949                    unsigned Align, BasicBlock *InsertAE)
950     : LoadInst(Ptr, Name, isVolatile, Align, NotAtomic, CrossThread, InsertAE) {
951 }
952
953 LoadInst::LoadInst(Type *Ty, Value *Ptr, const Twine &Name, bool isVolatile,
954                    unsigned Align, AtomicOrdering Order,
955                    SynchronizationScope SynchScope, Instruction *InsertBef)
956     : UnaryInstruction(Ty, Load, Ptr, InsertBef) {
957   setVolatile(isVolatile);
958   setAlignment(Align);
959   setAtomic(Order, SynchScope);
960   AssertOK();
961   setName(Name);
962 }
963
964 LoadInst::LoadInst(Value *Ptr, const Twine &Name, bool isVolatile, 
965                    unsigned Align, AtomicOrdering Order,
966                    SynchronizationScope SynchScope,
967                    BasicBlock *InsertAE)
968   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
969                      Load, Ptr, InsertAE) {
970   setVolatile(isVolatile);
971   setAlignment(Align);
972   setAtomic(Order, SynchScope);
973   AssertOK();
974   setName(Name);
975 }
976
977 LoadInst::LoadInst(Value *Ptr, const char *Name, Instruction *InsertBef)
978   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
979                      Load, Ptr, InsertBef) {
980   setVolatile(false);
981   setAlignment(0);
982   setAtomic(NotAtomic);
983   AssertOK();
984   if (Name && Name[0]) setName(Name);
985 }
986
987 LoadInst::LoadInst(Value *Ptr, const char *Name, BasicBlock *InsertAE)
988   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
989                      Load, Ptr, InsertAE) {
990   setVolatile(false);
991   setAlignment(0);
992   setAtomic(NotAtomic);
993   AssertOK();
994   if (Name && Name[0]) setName(Name);
995 }
996
997 LoadInst::LoadInst(Value *Ptr, const char *Name, bool isVolatile,
998                    Instruction *InsertBef)
999 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
1000                    Load, Ptr, InsertBef) {
1001   setVolatile(isVolatile);
1002   setAlignment(0);
1003   setAtomic(NotAtomic);
1004   AssertOK();
1005   if (Name && Name[0]) setName(Name);
1006 }
1007
1008 LoadInst::LoadInst(Value *Ptr, const char *Name, bool isVolatile,
1009                    BasicBlock *InsertAE)
1010   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
1011                      Load, Ptr, InsertAE) {
1012   setVolatile(isVolatile);
1013   setAlignment(0);
1014   setAtomic(NotAtomic);
1015   AssertOK();
1016   if (Name && Name[0]) setName(Name);
1017 }
1018
1019 void LoadInst::setAlignment(unsigned Align) {
1020   assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
1021   assert(Align <= MaximumAlignment &&
1022          "Alignment is greater than MaximumAlignment!");
1023   setInstructionSubclassData((getSubclassDataFromInstruction() & ~(31 << 1)) |
1024                              ((Log2_32(Align)+1)<<1));
1025   assert(getAlignment() == Align && "Alignment representation error!");
1026 }
1027
1028 //===----------------------------------------------------------------------===//
1029 //                           StoreInst Implementation
1030 //===----------------------------------------------------------------------===//
1031
1032 void StoreInst::AssertOK() {
1033   assert(getOperand(0) && getOperand(1) && "Both operands must be non-null!");
1034   assert(getOperand(1)->getType()->isPointerTy() &&
1035          "Ptr must have pointer type!");
1036   assert(getOperand(0)->getType() ==
1037                  cast<PointerType>(getOperand(1)->getType())->getElementType()
1038          && "Ptr must be a pointer to Val type!");
1039   assert(!(isAtomic() && getAlignment() == 0) &&
1040          "Alignment required for atomic store");
1041 }
1042
1043 StoreInst::StoreInst(Value *val, Value *addr, Instruction *InsertBefore)
1044     : StoreInst(val, addr, /*isVolatile=*/false, InsertBefore) {}
1045
1046 StoreInst::StoreInst(Value *val, Value *addr, BasicBlock *InsertAtEnd)
1047     : StoreInst(val, addr, /*isVolatile=*/false, InsertAtEnd) {}
1048
1049 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
1050                      Instruction *InsertBefore)
1051     : StoreInst(val, addr, isVolatile, /*Align=*/0, InsertBefore) {}
1052
1053 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
1054                      BasicBlock *InsertAtEnd)
1055     : StoreInst(val, addr, isVolatile, /*Align=*/0, InsertAtEnd) {}
1056
1057 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile, unsigned Align,
1058                      Instruction *InsertBefore)
1059     : StoreInst(val, addr, isVolatile, Align, NotAtomic, CrossThread,
1060                 InsertBefore) {}
1061
1062 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile, unsigned Align,
1063                      BasicBlock *InsertAtEnd)
1064     : StoreInst(val, addr, isVolatile, Align, NotAtomic, CrossThread,
1065                 InsertAtEnd) {}
1066
1067 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
1068                      unsigned Align, AtomicOrdering Order,
1069                      SynchronizationScope SynchScope,
1070                      Instruction *InsertBefore)
1071   : Instruction(Type::getVoidTy(val->getContext()), Store,
1072                 OperandTraits<StoreInst>::op_begin(this),
1073                 OperandTraits<StoreInst>::operands(this),
1074                 InsertBefore) {
1075   Op<0>() = val;
1076   Op<1>() = addr;
1077   setVolatile(isVolatile);
1078   setAlignment(Align);
1079   setAtomic(Order, SynchScope);
1080   AssertOK();
1081 }
1082
1083 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
1084                      unsigned Align, AtomicOrdering Order,
1085                      SynchronizationScope SynchScope,
1086                      BasicBlock *InsertAtEnd)
1087   : Instruction(Type::getVoidTy(val->getContext()), Store,
1088                 OperandTraits<StoreInst>::op_begin(this),
1089                 OperandTraits<StoreInst>::operands(this),
1090                 InsertAtEnd) {
1091   Op<0>() = val;
1092   Op<1>() = addr;
1093   setVolatile(isVolatile);
1094   setAlignment(Align);
1095   setAtomic(Order, SynchScope);
1096   AssertOK();
1097 }
1098
1099 void StoreInst::setAlignment(unsigned Align) {
1100   assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
1101   assert(Align <= MaximumAlignment &&
1102          "Alignment is greater than MaximumAlignment!");
1103   setInstructionSubclassData((getSubclassDataFromInstruction() & ~(31 << 1)) |
1104                              ((Log2_32(Align)+1) << 1));
1105   assert(getAlignment() == Align && "Alignment representation error!");
1106 }
1107
1108 //===----------------------------------------------------------------------===//
1109 //                       AtomicCmpXchgInst Implementation
1110 //===----------------------------------------------------------------------===//
1111
1112 void AtomicCmpXchgInst::Init(Value *Ptr, Value *Cmp, Value *NewVal,
1113                              AtomicOrdering SuccessOrdering,
1114                              AtomicOrdering FailureOrdering,
1115                              SynchronizationScope SynchScope) {
1116   Op<0>() = Ptr;
1117   Op<1>() = Cmp;
1118   Op<2>() = NewVal;
1119   setSuccessOrdering(SuccessOrdering);
1120   setFailureOrdering(FailureOrdering);
1121   setSynchScope(SynchScope);
1122
1123   assert(getOperand(0) && getOperand(1) && getOperand(2) &&
1124          "All operands must be non-null!");
1125   assert(getOperand(0)->getType()->isPointerTy() &&
1126          "Ptr must have pointer type!");
1127   assert(getOperand(1)->getType() ==
1128                  cast<PointerType>(getOperand(0)->getType())->getElementType()
1129          && "Ptr must be a pointer to Cmp type!");
1130   assert(getOperand(2)->getType() ==
1131                  cast<PointerType>(getOperand(0)->getType())->getElementType()
1132          && "Ptr must be a pointer to NewVal type!");
1133   assert(SuccessOrdering != NotAtomic &&
1134          "AtomicCmpXchg instructions must be atomic!");
1135   assert(FailureOrdering != NotAtomic &&
1136          "AtomicCmpXchg instructions must be atomic!");
1137   assert(SuccessOrdering >= FailureOrdering &&
1138          "AtomicCmpXchg success ordering must be at least as strong as fail");
1139   assert(FailureOrdering != Release && FailureOrdering != AcquireRelease &&
1140          "AtomicCmpXchg failure ordering cannot include release semantics");
1141 }
1142
1143 AtomicCmpXchgInst::AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
1144                                      AtomicOrdering SuccessOrdering,
1145                                      AtomicOrdering FailureOrdering,
1146                                      SynchronizationScope SynchScope,
1147                                      Instruction *InsertBefore)
1148     : Instruction(
1149           StructType::get(Cmp->getType(), Type::getInt1Ty(Cmp->getContext()),
1150                           nullptr),
1151           AtomicCmpXchg, OperandTraits<AtomicCmpXchgInst>::op_begin(this),
1152           OperandTraits<AtomicCmpXchgInst>::operands(this), InsertBefore) {
1153   Init(Ptr, Cmp, NewVal, SuccessOrdering, FailureOrdering, SynchScope);
1154 }
1155
1156 AtomicCmpXchgInst::AtomicCmpXchgInst(Value *Ptr, Value *Cmp, Value *NewVal,
1157                                      AtomicOrdering SuccessOrdering,
1158                                      AtomicOrdering FailureOrdering,
1159                                      SynchronizationScope SynchScope,
1160                                      BasicBlock *InsertAtEnd)
1161     : Instruction(
1162           StructType::get(Cmp->getType(), Type::getInt1Ty(Cmp->getContext()),
1163                           nullptr),
1164           AtomicCmpXchg, OperandTraits<AtomicCmpXchgInst>::op_begin(this),
1165           OperandTraits<AtomicCmpXchgInst>::operands(this), InsertAtEnd) {
1166   Init(Ptr, Cmp, NewVal, SuccessOrdering, FailureOrdering, SynchScope);
1167 }
1168
1169 //===----------------------------------------------------------------------===//
1170 //                       AtomicRMWInst Implementation
1171 //===----------------------------------------------------------------------===//
1172
1173 void AtomicRMWInst::Init(BinOp Operation, Value *Ptr, Value *Val,
1174                          AtomicOrdering Ordering,
1175                          SynchronizationScope SynchScope) {
1176   Op<0>() = Ptr;
1177   Op<1>() = Val;
1178   setOperation(Operation);
1179   setOrdering(Ordering);
1180   setSynchScope(SynchScope);
1181
1182   assert(getOperand(0) && getOperand(1) &&
1183          "All operands must be non-null!");
1184   assert(getOperand(0)->getType()->isPointerTy() &&
1185          "Ptr must have pointer type!");
1186   assert(getOperand(1)->getType() ==
1187          cast<PointerType>(getOperand(0)->getType())->getElementType()
1188          && "Ptr must be a pointer to Val type!");
1189   assert(Ordering != NotAtomic &&
1190          "AtomicRMW instructions must be atomic!");
1191 }
1192
1193 AtomicRMWInst::AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
1194                              AtomicOrdering Ordering,
1195                              SynchronizationScope SynchScope,
1196                              Instruction *InsertBefore)
1197   : Instruction(Val->getType(), AtomicRMW,
1198                 OperandTraits<AtomicRMWInst>::op_begin(this),
1199                 OperandTraits<AtomicRMWInst>::operands(this),
1200                 InsertBefore) {
1201   Init(Operation, Ptr, Val, Ordering, SynchScope);
1202 }
1203
1204 AtomicRMWInst::AtomicRMWInst(BinOp Operation, Value *Ptr, Value *Val,
1205                              AtomicOrdering Ordering,
1206                              SynchronizationScope SynchScope,
1207                              BasicBlock *InsertAtEnd)
1208   : Instruction(Val->getType(), AtomicRMW,
1209                 OperandTraits<AtomicRMWInst>::op_begin(this),
1210                 OperandTraits<AtomicRMWInst>::operands(this),
1211                 InsertAtEnd) {
1212   Init(Operation, Ptr, Val, Ordering, SynchScope);
1213 }
1214
1215 //===----------------------------------------------------------------------===//
1216 //                       FenceInst Implementation
1217 //===----------------------------------------------------------------------===//
1218
1219 FenceInst::FenceInst(LLVMContext &C, AtomicOrdering Ordering, 
1220                      SynchronizationScope SynchScope,
1221                      Instruction *InsertBefore)
1222   : Instruction(Type::getVoidTy(C), Fence, nullptr, 0, InsertBefore) {
1223   setOrdering(Ordering);
1224   setSynchScope(SynchScope);
1225 }
1226
1227 FenceInst::FenceInst(LLVMContext &C, AtomicOrdering Ordering, 
1228                      SynchronizationScope SynchScope,
1229                      BasicBlock *InsertAtEnd)
1230   : Instruction(Type::getVoidTy(C), Fence, nullptr, 0, InsertAtEnd) {
1231   setOrdering(Ordering);
1232   setSynchScope(SynchScope);
1233 }
1234
1235 //===----------------------------------------------------------------------===//
1236 //                       GetElementPtrInst Implementation
1237 //===----------------------------------------------------------------------===//
1238
1239 void GetElementPtrInst::init(Value *Ptr, ArrayRef<Value *> IdxList,
1240                              const Twine &Name) {
1241   assert(NumOperands == 1 + IdxList.size() && "NumOperands not initialized?");
1242   OperandList[0] = Ptr;
1243   std::copy(IdxList.begin(), IdxList.end(), op_begin() + 1);
1244   setName(Name);
1245 }
1246
1247 GetElementPtrInst::GetElementPtrInst(const GetElementPtrInst &GEPI)
1248   : Instruction(GEPI.getType(), GetElementPtr,
1249                 OperandTraits<GetElementPtrInst>::op_end(this)
1250                 - GEPI.getNumOperands(),
1251                 GEPI.getNumOperands()) {
1252   std::copy(GEPI.op_begin(), GEPI.op_end(), op_begin());
1253   SubclassOptionalData = GEPI.SubclassOptionalData;
1254 }
1255
1256 /// getIndexedType - Returns the type of the element that would be accessed with
1257 /// a gep instruction with the specified parameters.
1258 ///
1259 /// The Idxs pointer should point to a continuous piece of memory containing the
1260 /// indices, either as Value* or uint64_t.
1261 ///
1262 /// A null type is returned if the indices are invalid for the specified
1263 /// pointer type.
1264 ///
1265 template <typename IndexTy>
1266 static Type *getIndexedTypeInternal(Type *Agg, ArrayRef<IndexTy> IdxList) {
1267   // Handle the special case of the empty set index set, which is always valid.
1268   if (IdxList.empty())
1269     return Agg;
1270
1271   // If there is at least one index, the top level type must be sized, otherwise
1272   // it cannot be 'stepped over'.
1273   if (!Agg->isSized())
1274     return nullptr;
1275
1276   unsigned CurIdx = 1;
1277   for (; CurIdx != IdxList.size(); ++CurIdx) {
1278     CompositeType *CT = dyn_cast<CompositeType>(Agg);
1279     if (!CT || CT->isPointerTy()) return nullptr;
1280     IndexTy Index = IdxList[CurIdx];
1281     if (!CT->indexValid(Index)) return nullptr;
1282     Agg = CT->getTypeAtIndex(Index);
1283   }
1284   return CurIdx == IdxList.size() ? Agg : nullptr;
1285 }
1286
1287 Type *GetElementPtrInst::getIndexedType(Type *Ty, ArrayRef<Value *> IdxList) {
1288   return getIndexedTypeInternal(Ty, IdxList);
1289 }
1290
1291 Type *GetElementPtrInst::getIndexedType(Type *Ty,
1292                                         ArrayRef<Constant *> IdxList) {
1293   return getIndexedTypeInternal(Ty, IdxList);
1294 }
1295
1296 Type *GetElementPtrInst::getIndexedType(Type *Ty, ArrayRef<uint64_t> IdxList) {
1297   return getIndexedTypeInternal(Ty, IdxList);
1298 }
1299
1300 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
1301 /// zeros.  If so, the result pointer and the first operand have the same
1302 /// value, just potentially different types.
1303 bool GetElementPtrInst::hasAllZeroIndices() const {
1304   for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1305     if (ConstantInt *CI = dyn_cast<ConstantInt>(getOperand(i))) {
1306       if (!CI->isZero()) return false;
1307     } else {
1308       return false;
1309     }
1310   }
1311   return true;
1312 }
1313
1314 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
1315 /// constant integers.  If so, the result pointer and the first operand have
1316 /// a constant offset between them.
1317 bool GetElementPtrInst::hasAllConstantIndices() const {
1318   for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1319     if (!isa<ConstantInt>(getOperand(i)))
1320       return false;
1321   }
1322   return true;
1323 }
1324
1325 void GetElementPtrInst::setIsInBounds(bool B) {
1326   cast<GEPOperator>(this)->setIsInBounds(B);
1327 }
1328
1329 bool GetElementPtrInst::isInBounds() const {
1330   return cast<GEPOperator>(this)->isInBounds();
1331 }
1332
1333 bool GetElementPtrInst::accumulateConstantOffset(const DataLayout &DL,
1334                                                  APInt &Offset) const {
1335   // Delegate to the generic GEPOperator implementation.
1336   return cast<GEPOperator>(this)->accumulateConstantOffset(DL, Offset);
1337 }
1338
1339 //===----------------------------------------------------------------------===//
1340 //                           ExtractElementInst Implementation
1341 //===----------------------------------------------------------------------===//
1342
1343 ExtractElementInst::ExtractElementInst(Value *Val, Value *Index,
1344                                        const Twine &Name,
1345                                        Instruction *InsertBef)
1346   : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1347                 ExtractElement,
1348                 OperandTraits<ExtractElementInst>::op_begin(this),
1349                 2, InsertBef) {
1350   assert(isValidOperands(Val, Index) &&
1351          "Invalid extractelement instruction operands!");
1352   Op<0>() = Val;
1353   Op<1>() = Index;
1354   setName(Name);
1355 }
1356
1357 ExtractElementInst::ExtractElementInst(Value *Val, Value *Index,
1358                                        const Twine &Name,
1359                                        BasicBlock *InsertAE)
1360   : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1361                 ExtractElement,
1362                 OperandTraits<ExtractElementInst>::op_begin(this),
1363                 2, InsertAE) {
1364   assert(isValidOperands(Val, Index) &&
1365          "Invalid extractelement instruction operands!");
1366
1367   Op<0>() = Val;
1368   Op<1>() = Index;
1369   setName(Name);
1370 }
1371
1372
1373 bool ExtractElementInst::isValidOperands(const Value *Val, const Value *Index) {
1374   if (!Val->getType()->isVectorTy() || !Index->getType()->isIntegerTy())
1375     return false;
1376   return true;
1377 }
1378
1379
1380 //===----------------------------------------------------------------------===//
1381 //                           InsertElementInst Implementation
1382 //===----------------------------------------------------------------------===//
1383
1384 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, Value *Index,
1385                                      const Twine &Name,
1386                                      Instruction *InsertBef)
1387   : Instruction(Vec->getType(), InsertElement,
1388                 OperandTraits<InsertElementInst>::op_begin(this),
1389                 3, InsertBef) {
1390   assert(isValidOperands(Vec, Elt, Index) &&
1391          "Invalid insertelement instruction operands!");
1392   Op<0>() = Vec;
1393   Op<1>() = Elt;
1394   Op<2>() = Index;
1395   setName(Name);
1396 }
1397
1398 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, Value *Index,
1399                                      const Twine &Name,
1400                                      BasicBlock *InsertAE)
1401   : Instruction(Vec->getType(), InsertElement,
1402                 OperandTraits<InsertElementInst>::op_begin(this),
1403                 3, InsertAE) {
1404   assert(isValidOperands(Vec, Elt, Index) &&
1405          "Invalid insertelement instruction operands!");
1406
1407   Op<0>() = Vec;
1408   Op<1>() = Elt;
1409   Op<2>() = Index;
1410   setName(Name);
1411 }
1412
1413 bool InsertElementInst::isValidOperands(const Value *Vec, const Value *Elt, 
1414                                         const Value *Index) {
1415   if (!Vec->getType()->isVectorTy())
1416     return false;   // First operand of insertelement must be vector type.
1417   
1418   if (Elt->getType() != cast<VectorType>(Vec->getType())->getElementType())
1419     return false;// Second operand of insertelement must be vector element type.
1420     
1421   if (!Index->getType()->isIntegerTy())
1422     return false;  // Third operand of insertelement must be i32.
1423   return true;
1424 }
1425
1426
1427 //===----------------------------------------------------------------------===//
1428 //                      ShuffleVectorInst Implementation
1429 //===----------------------------------------------------------------------===//
1430
1431 ShuffleVectorInst::ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1432                                      const Twine &Name,
1433                                      Instruction *InsertBefore)
1434 : Instruction(VectorType::get(cast<VectorType>(V1->getType())->getElementType(),
1435                 cast<VectorType>(Mask->getType())->getNumElements()),
1436               ShuffleVector,
1437               OperandTraits<ShuffleVectorInst>::op_begin(this),
1438               OperandTraits<ShuffleVectorInst>::operands(this),
1439               InsertBefore) {
1440   assert(isValidOperands(V1, V2, Mask) &&
1441          "Invalid shuffle vector instruction operands!");
1442   Op<0>() = V1;
1443   Op<1>() = V2;
1444   Op<2>() = Mask;
1445   setName(Name);
1446 }
1447
1448 ShuffleVectorInst::ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1449                                      const Twine &Name,
1450                                      BasicBlock *InsertAtEnd)
1451 : Instruction(VectorType::get(cast<VectorType>(V1->getType())->getElementType(),
1452                 cast<VectorType>(Mask->getType())->getNumElements()),
1453               ShuffleVector,
1454               OperandTraits<ShuffleVectorInst>::op_begin(this),
1455               OperandTraits<ShuffleVectorInst>::operands(this),
1456               InsertAtEnd) {
1457   assert(isValidOperands(V1, V2, Mask) &&
1458          "Invalid shuffle vector instruction operands!");
1459
1460   Op<0>() = V1;
1461   Op<1>() = V2;
1462   Op<2>() = Mask;
1463   setName(Name);
1464 }
1465
1466 bool ShuffleVectorInst::isValidOperands(const Value *V1, const Value *V2,
1467                                         const Value *Mask) {
1468   // V1 and V2 must be vectors of the same type.
1469   if (!V1->getType()->isVectorTy() || V1->getType() != V2->getType())
1470     return false;
1471   
1472   // Mask must be vector of i32.
1473   VectorType *MaskTy = dyn_cast<VectorType>(Mask->getType());
1474   if (!MaskTy || !MaskTy->getElementType()->isIntegerTy(32))
1475     return false;
1476
1477   // Check to see if Mask is valid.
1478   if (isa<UndefValue>(Mask) || isa<ConstantAggregateZero>(Mask))
1479     return true;
1480
1481   if (const ConstantVector *MV = dyn_cast<ConstantVector>(Mask)) {
1482     unsigned V1Size = cast<VectorType>(V1->getType())->getNumElements();
1483     for (Value *Op : MV->operands()) {
1484       if (ConstantInt *CI = dyn_cast<ConstantInt>(Op)) {
1485         if (CI->uge(V1Size*2))
1486           return false;
1487       } else if (!isa<UndefValue>(Op)) {
1488         return false;
1489       }
1490     }
1491     return true;
1492   }
1493   
1494   if (const ConstantDataSequential *CDS =
1495         dyn_cast<ConstantDataSequential>(Mask)) {
1496     unsigned V1Size = cast<VectorType>(V1->getType())->getNumElements();
1497     for (unsigned i = 0, e = MaskTy->getNumElements(); i != e; ++i)
1498       if (CDS->getElementAsInteger(i) >= V1Size*2)
1499         return false;
1500     return true;
1501   }
1502   
1503   // The bitcode reader can create a place holder for a forward reference
1504   // used as the shuffle mask. When this occurs, the shuffle mask will
1505   // fall into this case and fail. To avoid this error, do this bit of
1506   // ugliness to allow such a mask pass.
1507   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(Mask))
1508     if (CE->getOpcode() == Instruction::UserOp1)
1509       return true;
1510
1511   return false;
1512 }
1513
1514 /// getMaskValue - Return the index from the shuffle mask for the specified
1515 /// output result.  This is either -1 if the element is undef or a number less
1516 /// than 2*numelements.
1517 int ShuffleVectorInst::getMaskValue(Constant *Mask, unsigned i) {
1518   assert(i < Mask->getType()->getVectorNumElements() && "Index out of range");
1519   if (ConstantDataSequential *CDS =dyn_cast<ConstantDataSequential>(Mask))
1520     return CDS->getElementAsInteger(i);
1521   Constant *C = Mask->getAggregateElement(i);
1522   if (isa<UndefValue>(C))
1523     return -1;
1524   return cast<ConstantInt>(C)->getZExtValue();
1525 }
1526
1527 /// getShuffleMask - Return the full mask for this instruction, where each
1528 /// element is the element number and undef's are returned as -1.
1529 void ShuffleVectorInst::getShuffleMask(Constant *Mask,
1530                                        SmallVectorImpl<int> &Result) {
1531   unsigned NumElts = Mask->getType()->getVectorNumElements();
1532   
1533   if (ConstantDataSequential *CDS=dyn_cast<ConstantDataSequential>(Mask)) {
1534     for (unsigned i = 0; i != NumElts; ++i)
1535       Result.push_back(CDS->getElementAsInteger(i));
1536     return;
1537   }    
1538   for (unsigned i = 0; i != NumElts; ++i) {
1539     Constant *C = Mask->getAggregateElement(i);
1540     Result.push_back(isa<UndefValue>(C) ? -1 :
1541                      cast<ConstantInt>(C)->getZExtValue());
1542   }
1543 }
1544
1545
1546 //===----------------------------------------------------------------------===//
1547 //                             InsertValueInst Class
1548 //===----------------------------------------------------------------------===//
1549
1550 void InsertValueInst::init(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs, 
1551                            const Twine &Name) {
1552   assert(NumOperands == 2 && "NumOperands not initialized?");
1553
1554   // There's no fundamental reason why we require at least one index
1555   // (other than weirdness with &*IdxBegin being invalid; see
1556   // getelementptr's init routine for example). But there's no
1557   // present need to support it.
1558   assert(Idxs.size() > 0 && "InsertValueInst must have at least one index");
1559
1560   assert(ExtractValueInst::getIndexedType(Agg->getType(), Idxs) ==
1561          Val->getType() && "Inserted value must match indexed type!");
1562   Op<0>() = Agg;
1563   Op<1>() = Val;
1564
1565   Indices.append(Idxs.begin(), Idxs.end());
1566   setName(Name);
1567 }
1568
1569 InsertValueInst::InsertValueInst(const InsertValueInst &IVI)
1570   : Instruction(IVI.getType(), InsertValue,
1571                 OperandTraits<InsertValueInst>::op_begin(this), 2),
1572     Indices(IVI.Indices) {
1573   Op<0>() = IVI.getOperand(0);
1574   Op<1>() = IVI.getOperand(1);
1575   SubclassOptionalData = IVI.SubclassOptionalData;
1576 }
1577
1578 //===----------------------------------------------------------------------===//
1579 //                             ExtractValueInst Class
1580 //===----------------------------------------------------------------------===//
1581
1582 void ExtractValueInst::init(ArrayRef<unsigned> Idxs, const Twine &Name) {
1583   assert(NumOperands == 1 && "NumOperands not initialized?");
1584
1585   // There's no fundamental reason why we require at least one index.
1586   // But there's no present need to support it.
1587   assert(Idxs.size() > 0 && "ExtractValueInst must have at least one index");
1588
1589   Indices.append(Idxs.begin(), Idxs.end());
1590   setName(Name);
1591 }
1592
1593 ExtractValueInst::ExtractValueInst(const ExtractValueInst &EVI)
1594   : UnaryInstruction(EVI.getType(), ExtractValue, EVI.getOperand(0)),
1595     Indices(EVI.Indices) {
1596   SubclassOptionalData = EVI.SubclassOptionalData;
1597 }
1598
1599 // getIndexedType - Returns the type of the element that would be extracted
1600 // with an extractvalue instruction with the specified parameters.
1601 //
1602 // A null type is returned if the indices are invalid for the specified
1603 // pointer type.
1604 //
1605 Type *ExtractValueInst::getIndexedType(Type *Agg,
1606                                        ArrayRef<unsigned> Idxs) {
1607   for (unsigned Index : Idxs) {
1608     // We can't use CompositeType::indexValid(Index) here.
1609     // indexValid() always returns true for arrays because getelementptr allows
1610     // out-of-bounds indices. Since we don't allow those for extractvalue and
1611     // insertvalue we need to check array indexing manually.
1612     // Since the only other types we can index into are struct types it's just
1613     // as easy to check those manually as well.
1614     if (ArrayType *AT = dyn_cast<ArrayType>(Agg)) {
1615       if (Index >= AT->getNumElements())
1616         return nullptr;
1617     } else if (StructType *ST = dyn_cast<StructType>(Agg)) {
1618       if (Index >= ST->getNumElements())
1619         return nullptr;
1620     } else {
1621       // Not a valid type to index into.
1622       return nullptr;
1623     }
1624
1625     Agg = cast<CompositeType>(Agg)->getTypeAtIndex(Index);
1626   }
1627   return const_cast<Type*>(Agg);
1628 }
1629
1630 //===----------------------------------------------------------------------===//
1631 //                             BinaryOperator Class
1632 //===----------------------------------------------------------------------===//
1633
1634 BinaryOperator::BinaryOperator(BinaryOps iType, Value *S1, Value *S2,
1635                                Type *Ty, const Twine &Name,
1636                                Instruction *InsertBefore)
1637   : Instruction(Ty, iType,
1638                 OperandTraits<BinaryOperator>::op_begin(this),
1639                 OperandTraits<BinaryOperator>::operands(this),
1640                 InsertBefore) {
1641   Op<0>() = S1;
1642   Op<1>() = S2;
1643   init(iType);
1644   setName(Name);
1645 }
1646
1647 BinaryOperator::BinaryOperator(BinaryOps iType, Value *S1, Value *S2, 
1648                                Type *Ty, const Twine &Name,
1649                                BasicBlock *InsertAtEnd)
1650   : Instruction(Ty, iType,
1651                 OperandTraits<BinaryOperator>::op_begin(this),
1652                 OperandTraits<BinaryOperator>::operands(this),
1653                 InsertAtEnd) {
1654   Op<0>() = S1;
1655   Op<1>() = S2;
1656   init(iType);
1657   setName(Name);
1658 }
1659
1660
1661 void BinaryOperator::init(BinaryOps iType) {
1662   Value *LHS = getOperand(0), *RHS = getOperand(1);
1663   (void)LHS; (void)RHS; // Silence warnings.
1664   assert(LHS->getType() == RHS->getType() &&
1665          "Binary operator operand types must match!");
1666 #ifndef NDEBUG
1667   switch (iType) {
1668   case Add: case Sub:
1669   case Mul:
1670     assert(getType() == LHS->getType() &&
1671            "Arithmetic operation should return same type as operands!");
1672     assert(getType()->isIntOrIntVectorTy() &&
1673            "Tried to create an integer operation on a non-integer type!");
1674     break;
1675   case FAdd: case FSub:
1676   case FMul:
1677     assert(getType() == LHS->getType() &&
1678            "Arithmetic operation should return same type as operands!");
1679     assert(getType()->isFPOrFPVectorTy() &&
1680            "Tried to create a floating-point operation on a "
1681            "non-floating-point type!");
1682     break;
1683   case UDiv: 
1684   case SDiv: 
1685     assert(getType() == LHS->getType() &&
1686            "Arithmetic operation should return same type as operands!");
1687     assert((getType()->isIntegerTy() || (getType()->isVectorTy() && 
1688             cast<VectorType>(getType())->getElementType()->isIntegerTy())) &&
1689            "Incorrect operand type (not integer) for S/UDIV");
1690     break;
1691   case FDiv:
1692     assert(getType() == LHS->getType() &&
1693            "Arithmetic operation should return same type as operands!");
1694     assert(getType()->isFPOrFPVectorTy() &&
1695            "Incorrect operand type (not floating point) for FDIV");
1696     break;
1697   case URem: 
1698   case SRem: 
1699     assert(getType() == LHS->getType() &&
1700            "Arithmetic operation should return same type as operands!");
1701     assert((getType()->isIntegerTy() || (getType()->isVectorTy() && 
1702             cast<VectorType>(getType())->getElementType()->isIntegerTy())) &&
1703            "Incorrect operand type (not integer) for S/UREM");
1704     break;
1705   case FRem:
1706     assert(getType() == LHS->getType() &&
1707            "Arithmetic operation should return same type as operands!");
1708     assert(getType()->isFPOrFPVectorTy() &&
1709            "Incorrect operand type (not floating point) for FREM");
1710     break;
1711   case Shl:
1712   case LShr:
1713   case AShr:
1714     assert(getType() == LHS->getType() &&
1715            "Shift operation should return same type as operands!");
1716     assert((getType()->isIntegerTy() ||
1717             (getType()->isVectorTy() && 
1718              cast<VectorType>(getType())->getElementType()->isIntegerTy())) &&
1719            "Tried to create a shift operation on a non-integral type!");
1720     break;
1721   case And: case Or:
1722   case Xor:
1723     assert(getType() == LHS->getType() &&
1724            "Logical operation should return same type as operands!");
1725     assert((getType()->isIntegerTy() ||
1726             (getType()->isVectorTy() && 
1727              cast<VectorType>(getType())->getElementType()->isIntegerTy())) &&
1728            "Tried to create a logical operation on a non-integral type!");
1729     break;
1730   default:
1731     break;
1732   }
1733 #endif
1734 }
1735
1736 BinaryOperator *BinaryOperator::Create(BinaryOps Op, Value *S1, Value *S2,
1737                                        const Twine &Name,
1738                                        Instruction *InsertBefore) {
1739   assert(S1->getType() == S2->getType() &&
1740          "Cannot create binary operator with two operands of differing type!");
1741   return new BinaryOperator(Op, S1, S2, S1->getType(), Name, InsertBefore);
1742 }
1743
1744 BinaryOperator *BinaryOperator::Create(BinaryOps Op, Value *S1, Value *S2,
1745                                        const Twine &Name,
1746                                        BasicBlock *InsertAtEnd) {
1747   BinaryOperator *Res = Create(Op, S1, S2, Name);
1748   InsertAtEnd->getInstList().push_back(Res);
1749   return Res;
1750 }
1751
1752 BinaryOperator *BinaryOperator::CreateNeg(Value *Op, const Twine &Name,
1753                                           Instruction *InsertBefore) {
1754   Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1755   return new BinaryOperator(Instruction::Sub,
1756                             zero, Op,
1757                             Op->getType(), Name, InsertBefore);
1758 }
1759
1760 BinaryOperator *BinaryOperator::CreateNeg(Value *Op, const Twine &Name,
1761                                           BasicBlock *InsertAtEnd) {
1762   Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1763   return new BinaryOperator(Instruction::Sub,
1764                             zero, Op,
1765                             Op->getType(), Name, InsertAtEnd);
1766 }
1767
1768 BinaryOperator *BinaryOperator::CreateNSWNeg(Value *Op, const Twine &Name,
1769                                              Instruction *InsertBefore) {
1770   Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1771   return BinaryOperator::CreateNSWSub(zero, Op, Name, InsertBefore);
1772 }
1773
1774 BinaryOperator *BinaryOperator::CreateNSWNeg(Value *Op, const Twine &Name,
1775                                              BasicBlock *InsertAtEnd) {
1776   Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1777   return BinaryOperator::CreateNSWSub(zero, Op, Name, InsertAtEnd);
1778 }
1779
1780 BinaryOperator *BinaryOperator::CreateNUWNeg(Value *Op, const Twine &Name,
1781                                              Instruction *InsertBefore) {
1782   Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1783   return BinaryOperator::CreateNUWSub(zero, Op, Name, InsertBefore);
1784 }
1785
1786 BinaryOperator *BinaryOperator::CreateNUWNeg(Value *Op, const Twine &Name,
1787                                              BasicBlock *InsertAtEnd) {
1788   Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1789   return BinaryOperator::CreateNUWSub(zero, Op, Name, InsertAtEnd);
1790 }
1791
1792 BinaryOperator *BinaryOperator::CreateFNeg(Value *Op, const Twine &Name,
1793                                            Instruction *InsertBefore) {
1794   Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1795   return new BinaryOperator(Instruction::FSub, zero, Op,
1796                             Op->getType(), Name, InsertBefore);
1797 }
1798
1799 BinaryOperator *BinaryOperator::CreateFNeg(Value *Op, const Twine &Name,
1800                                            BasicBlock *InsertAtEnd) {
1801   Value *zero = ConstantFP::getZeroValueForNegation(Op->getType());
1802   return new BinaryOperator(Instruction::FSub, zero, Op,
1803                             Op->getType(), Name, InsertAtEnd);
1804 }
1805
1806 BinaryOperator *BinaryOperator::CreateNot(Value *Op, const Twine &Name,
1807                                           Instruction *InsertBefore) {
1808   Constant *C = Constant::getAllOnesValue(Op->getType());
1809   return new BinaryOperator(Instruction::Xor, Op, C,
1810                             Op->getType(), Name, InsertBefore);
1811 }
1812
1813 BinaryOperator *BinaryOperator::CreateNot(Value *Op, const Twine &Name,
1814                                           BasicBlock *InsertAtEnd) {
1815   Constant *AllOnes = Constant::getAllOnesValue(Op->getType());
1816   return new BinaryOperator(Instruction::Xor, Op, AllOnes,
1817                             Op->getType(), Name, InsertAtEnd);
1818 }
1819
1820
1821 // isConstantAllOnes - Helper function for several functions below
1822 static inline bool isConstantAllOnes(const Value *V) {
1823   if (const Constant *C = dyn_cast<Constant>(V))
1824     return C->isAllOnesValue();
1825   return false;
1826 }
1827
1828 bool BinaryOperator::isNeg(const Value *V) {
1829   if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
1830     if (Bop->getOpcode() == Instruction::Sub)
1831       if (Constant* C = dyn_cast<Constant>(Bop->getOperand(0)))
1832         return C->isNegativeZeroValue();
1833   return false;
1834 }
1835
1836 bool BinaryOperator::isFNeg(const Value *V, bool IgnoreZeroSign) {
1837   if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
1838     if (Bop->getOpcode() == Instruction::FSub)
1839       if (Constant* C = dyn_cast<Constant>(Bop->getOperand(0))) {
1840         if (!IgnoreZeroSign)
1841           IgnoreZeroSign = cast<Instruction>(V)->hasNoSignedZeros();
1842         return !IgnoreZeroSign ? C->isNegativeZeroValue() : C->isZeroValue();
1843       }
1844   return false;
1845 }
1846
1847 bool BinaryOperator::isNot(const Value *V) {
1848   if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
1849     return (Bop->getOpcode() == Instruction::Xor &&
1850             (isConstantAllOnes(Bop->getOperand(1)) ||
1851              isConstantAllOnes(Bop->getOperand(0))));
1852   return false;
1853 }
1854
1855 Value *BinaryOperator::getNegArgument(Value *BinOp) {
1856   return cast<BinaryOperator>(BinOp)->getOperand(1);
1857 }
1858
1859 const Value *BinaryOperator::getNegArgument(const Value *BinOp) {
1860   return getNegArgument(const_cast<Value*>(BinOp));
1861 }
1862
1863 Value *BinaryOperator::getFNegArgument(Value *BinOp) {
1864   return cast<BinaryOperator>(BinOp)->getOperand(1);
1865 }
1866
1867 const Value *BinaryOperator::getFNegArgument(const Value *BinOp) {
1868   return getFNegArgument(const_cast<Value*>(BinOp));
1869 }
1870
1871 Value *BinaryOperator::getNotArgument(Value *BinOp) {
1872   assert(isNot(BinOp) && "getNotArgument on non-'not' instruction!");
1873   BinaryOperator *BO = cast<BinaryOperator>(BinOp);
1874   Value *Op0 = BO->getOperand(0);
1875   Value *Op1 = BO->getOperand(1);
1876   if (isConstantAllOnes(Op0)) return Op1;
1877
1878   assert(isConstantAllOnes(Op1));
1879   return Op0;
1880 }
1881
1882 const Value *BinaryOperator::getNotArgument(const Value *BinOp) {
1883   return getNotArgument(const_cast<Value*>(BinOp));
1884 }
1885
1886
1887 // swapOperands - Exchange the two operands to this instruction.  This
1888 // instruction is safe to use on any binary instruction and does not
1889 // modify the semantics of the instruction.  If the instruction is
1890 // order dependent (SetLT f.e.) the opcode is changed.
1891 //
1892 bool BinaryOperator::swapOperands() {
1893   if (!isCommutative())
1894     return true; // Can't commute operands
1895   Op<0>().swap(Op<1>());
1896   return false;
1897 }
1898
1899 void BinaryOperator::setHasNoUnsignedWrap(bool b) {
1900   cast<OverflowingBinaryOperator>(this)->setHasNoUnsignedWrap(b);
1901 }
1902
1903 void BinaryOperator::setHasNoSignedWrap(bool b) {
1904   cast<OverflowingBinaryOperator>(this)->setHasNoSignedWrap(b);
1905 }
1906
1907 void BinaryOperator::setIsExact(bool b) {
1908   cast<PossiblyExactOperator>(this)->setIsExact(b);
1909 }
1910
1911 bool BinaryOperator::hasNoUnsignedWrap() const {
1912   return cast<OverflowingBinaryOperator>(this)->hasNoUnsignedWrap();
1913 }
1914
1915 bool BinaryOperator::hasNoSignedWrap() const {
1916   return cast<OverflowingBinaryOperator>(this)->hasNoSignedWrap();
1917 }
1918
1919 bool BinaryOperator::isExact() const {
1920   return cast<PossiblyExactOperator>(this)->isExact();
1921 }
1922
1923 void BinaryOperator::copyIRFlags(const Value *V) {
1924   // Copy the wrapping flags.
1925   if (auto *OB = dyn_cast<OverflowingBinaryOperator>(V)) {
1926     setHasNoSignedWrap(OB->hasNoSignedWrap());
1927     setHasNoUnsignedWrap(OB->hasNoUnsignedWrap());
1928   }
1929
1930   // Copy the exact flag.
1931   if (auto *PE = dyn_cast<PossiblyExactOperator>(V))
1932     setIsExact(PE->isExact());
1933   
1934   // Copy the fast-math flags.
1935   if (auto *FP = dyn_cast<FPMathOperator>(V))
1936     copyFastMathFlags(FP->getFastMathFlags());
1937 }
1938
1939 void BinaryOperator::andIRFlags(const Value *V) {
1940   if (auto *OB = dyn_cast<OverflowingBinaryOperator>(V)) {
1941     setHasNoSignedWrap(hasNoSignedWrap() & OB->hasNoSignedWrap());
1942     setHasNoUnsignedWrap(hasNoUnsignedWrap() & OB->hasNoUnsignedWrap());
1943   }
1944   
1945   if (auto *PE = dyn_cast<PossiblyExactOperator>(V))
1946     setIsExact(isExact() & PE->isExact());
1947   
1948   if (auto *FP = dyn_cast<FPMathOperator>(V)) {
1949     FastMathFlags FM = getFastMathFlags();
1950     FM &= FP->getFastMathFlags();
1951     copyFastMathFlags(FM);
1952   }
1953 }
1954
1955
1956 //===----------------------------------------------------------------------===//
1957 //                             FPMathOperator Class
1958 //===----------------------------------------------------------------------===//
1959
1960 /// getFPAccuracy - Get the maximum error permitted by this operation in ULPs.
1961 /// An accuracy of 0.0 means that the operation should be performed with the
1962 /// default precision.
1963 float FPMathOperator::getFPAccuracy() const {
1964   const MDNode *MD =
1965       cast<Instruction>(this)->getMetadata(LLVMContext::MD_fpmath);
1966   if (!MD)
1967     return 0.0;
1968   ConstantFP *Accuracy = mdconst::extract<ConstantFP>(MD->getOperand(0));
1969   return Accuracy->getValueAPF().convertToFloat();
1970 }
1971
1972
1973 //===----------------------------------------------------------------------===//
1974 //                                CastInst Class
1975 //===----------------------------------------------------------------------===//
1976
1977 void CastInst::anchor() {}
1978
1979 // Just determine if this cast only deals with integral->integral conversion.
1980 bool CastInst::isIntegerCast() const {
1981   switch (getOpcode()) {
1982     default: return false;
1983     case Instruction::ZExt:
1984     case Instruction::SExt:
1985     case Instruction::Trunc:
1986       return true;
1987     case Instruction::BitCast:
1988       return getOperand(0)->getType()->isIntegerTy() &&
1989         getType()->isIntegerTy();
1990   }
1991 }
1992
1993 bool CastInst::isLosslessCast() const {
1994   // Only BitCast can be lossless, exit fast if we're not BitCast
1995   if (getOpcode() != Instruction::BitCast)
1996     return false;
1997
1998   // Identity cast is always lossless
1999   Type* SrcTy = getOperand(0)->getType();
2000   Type* DstTy = getType();
2001   if (SrcTy == DstTy)
2002     return true;
2003   
2004   // Pointer to pointer is always lossless.
2005   if (SrcTy->isPointerTy())
2006     return DstTy->isPointerTy();
2007   return false;  // Other types have no identity values
2008 }
2009
2010 /// This function determines if the CastInst does not require any bits to be
2011 /// changed in order to effect the cast. Essentially, it identifies cases where
2012 /// no code gen is necessary for the cast, hence the name no-op cast.  For 
2013 /// example, the following are all no-op casts:
2014 /// # bitcast i32* %x to i8*
2015 /// # bitcast <2 x i32> %x to <4 x i16> 
2016 /// # ptrtoint i32* %x to i32     ; on 32-bit plaforms only
2017 /// @brief Determine if the described cast is a no-op.
2018 bool CastInst::isNoopCast(Instruction::CastOps Opcode,
2019                           Type *SrcTy,
2020                           Type *DestTy,
2021                           Type *IntPtrTy) {
2022   switch (Opcode) {
2023     default: llvm_unreachable("Invalid CastOp");
2024     case Instruction::Trunc:
2025     case Instruction::ZExt:
2026     case Instruction::SExt: 
2027     case Instruction::FPTrunc:
2028     case Instruction::FPExt:
2029     case Instruction::UIToFP:
2030     case Instruction::SIToFP:
2031     case Instruction::FPToUI:
2032     case Instruction::FPToSI:
2033     case Instruction::AddrSpaceCast:
2034       // TODO: Target informations may give a more accurate answer here.
2035       return false;
2036     case Instruction::BitCast:
2037       return true;  // BitCast never modifies bits.
2038     case Instruction::PtrToInt:
2039       return IntPtrTy->getScalarSizeInBits() ==
2040              DestTy->getScalarSizeInBits();
2041     case Instruction::IntToPtr:
2042       return IntPtrTy->getScalarSizeInBits() ==
2043              SrcTy->getScalarSizeInBits();
2044   }
2045 }
2046
2047 /// @brief Determine if a cast is a no-op.
2048 bool CastInst::isNoopCast(Type *IntPtrTy) const {
2049   return isNoopCast(getOpcode(), getOperand(0)->getType(), getType(), IntPtrTy);
2050 }
2051
2052 bool CastInst::isNoopCast(const DataLayout &DL) const {
2053   Type *PtrOpTy = nullptr;
2054   if (getOpcode() == Instruction::PtrToInt)
2055     PtrOpTy = getOperand(0)->getType();
2056   else if (getOpcode() == Instruction::IntToPtr)
2057     PtrOpTy = getType();
2058
2059   Type *IntPtrTy =
2060       PtrOpTy ? DL.getIntPtrType(PtrOpTy) : DL.getIntPtrType(getContext(), 0);
2061
2062   return isNoopCast(getOpcode(), getOperand(0)->getType(), getType(), IntPtrTy);
2063 }
2064
2065 /// This function determines if a pair of casts can be eliminated and what
2066 /// opcode should be used in the elimination. This assumes that there are two
2067 /// instructions like this:
2068 /// *  %F = firstOpcode SrcTy %x to MidTy
2069 /// *  %S = secondOpcode MidTy %F to DstTy
2070 /// The function returns a resultOpcode so these two casts can be replaced with:
2071 /// *  %Replacement = resultOpcode %SrcTy %x to DstTy
2072 /// If no such cast is permited, the function returns 0.
2073 unsigned CastInst::isEliminableCastPair(
2074   Instruction::CastOps firstOp, Instruction::CastOps secondOp,
2075   Type *SrcTy, Type *MidTy, Type *DstTy, Type *SrcIntPtrTy, Type *MidIntPtrTy,
2076   Type *DstIntPtrTy) {
2077   // Define the 144 possibilities for these two cast instructions. The values
2078   // in this matrix determine what to do in a given situation and select the
2079   // case in the switch below.  The rows correspond to firstOp, the columns 
2080   // correspond to secondOp.  In looking at the table below, keep in  mind
2081   // the following cast properties:
2082   //
2083   //          Size Compare       Source               Destination
2084   // Operator  Src ? Size   Type       Sign         Type       Sign
2085   // -------- ------------ -------------------   ---------------------
2086   // TRUNC         >       Integer      Any        Integral     Any
2087   // ZEXT          <       Integral   Unsigned     Integer      Any
2088   // SEXT          <       Integral    Signed      Integer      Any
2089   // FPTOUI       n/a      FloatPt      n/a        Integral   Unsigned
2090   // FPTOSI       n/a      FloatPt      n/a        Integral    Signed
2091   // UITOFP       n/a      Integral   Unsigned     FloatPt      n/a
2092   // SITOFP       n/a      Integral    Signed      FloatPt      n/a
2093   // FPTRUNC       >       FloatPt      n/a        FloatPt      n/a
2094   // FPEXT         <       FloatPt      n/a        FloatPt      n/a
2095   // PTRTOINT     n/a      Pointer      n/a        Integral   Unsigned
2096   // INTTOPTR     n/a      Integral   Unsigned     Pointer      n/a
2097   // BITCAST       =       FirstClass   n/a       FirstClass    n/a
2098   // ADDRSPCST    n/a      Pointer      n/a        Pointer      n/a
2099   //
2100   // NOTE: some transforms are safe, but we consider them to be non-profitable.
2101   // For example, we could merge "fptoui double to i32" + "zext i32 to i64",
2102   // into "fptoui double to i64", but this loses information about the range
2103   // of the produced value (we no longer know the top-part is all zeros).
2104   // Further this conversion is often much more expensive for typical hardware,
2105   // and causes issues when building libgcc.  We disallow fptosi+sext for the
2106   // same reason.
2107   const unsigned numCastOps =
2108     Instruction::CastOpsEnd - Instruction::CastOpsBegin;
2109   static const uint8_t CastResults[numCastOps][numCastOps] = {
2110     // T        F  F  U  S  F  F  P  I  B  A  -+
2111     // R  Z  S  P  P  I  I  T  P  2  N  T  S   |
2112     // U  E  E  2  2  2  2  R  E  I  T  C  C   +- secondOp
2113     // N  X  X  U  S  F  F  N  X  N  2  V  V   |
2114     // C  T  T  I  I  P  P  C  T  T  P  T  T  -+
2115     {  1, 0, 0,99,99, 0, 0,99,99,99, 0, 3, 0}, // Trunc         -+
2116     {  8, 1, 9,99,99, 2,17,99,99,99, 2, 3, 0}, // ZExt           |
2117     {  8, 0, 1,99,99, 0, 2,99,99,99, 0, 3, 0}, // SExt           |
2118     {  0, 0, 0,99,99, 0, 0,99,99,99, 0, 3, 0}, // FPToUI         |
2119     {  0, 0, 0,99,99, 0, 0,99,99,99, 0, 3, 0}, // FPToSI         |
2120     { 99,99,99, 0, 0,99,99, 0, 0,99,99, 4, 0}, // UIToFP         +- firstOp
2121     { 99,99,99, 0, 0,99,99, 0, 0,99,99, 4, 0}, // SIToFP         |
2122     { 99,99,99, 0, 0,99,99, 1, 0,99,99, 4, 0}, // FPTrunc        |
2123     { 99,99,99, 2, 2,99,99,10, 2,99,99, 4, 0}, // FPExt          |
2124     {  1, 0, 0,99,99, 0, 0,99,99,99, 7, 3, 0}, // PtrToInt       |
2125     { 99,99,99,99,99,99,99,99,99,11,99,15, 0}, // IntToPtr       |
2126     {  5, 5, 5, 6, 6, 5, 5, 6, 6,16, 5, 1,14}, // BitCast        |
2127     {  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,13,12}, // AddrSpaceCast -+
2128   };
2129
2130   // If either of the casts are a bitcast from scalar to vector, disallow the
2131   // merging. However, bitcast of A->B->A are allowed.
2132   bool isFirstBitcast  = (firstOp == Instruction::BitCast);
2133   bool isSecondBitcast = (secondOp == Instruction::BitCast);
2134   bool chainedBitcast  = (SrcTy == DstTy && isFirstBitcast && isSecondBitcast);
2135
2136   // Check if any of the bitcasts convert scalars<->vectors.
2137   if ((isFirstBitcast  && isa<VectorType>(SrcTy) != isa<VectorType>(MidTy)) ||
2138       (isSecondBitcast && isa<VectorType>(MidTy) != isa<VectorType>(DstTy)))
2139     // Unless we are bitcasing to the original type, disallow optimizations.
2140     if (!chainedBitcast) return 0;
2141
2142   int ElimCase = CastResults[firstOp-Instruction::CastOpsBegin]
2143                             [secondOp-Instruction::CastOpsBegin];
2144   switch (ElimCase) {
2145     case 0: 
2146       // Categorically disallowed.
2147       return 0;
2148     case 1: 
2149       // Allowed, use first cast's opcode.
2150       return firstOp;
2151     case 2: 
2152       // Allowed, use second cast's opcode.
2153       return secondOp;
2154     case 3: 
2155       // No-op cast in second op implies firstOp as long as the DestTy
2156       // is integer and we are not converting between a vector and a
2157       // non-vector type.
2158       if (!SrcTy->isVectorTy() && DstTy->isIntegerTy())
2159         return firstOp;
2160       return 0;
2161     case 4:
2162       // No-op cast in second op implies firstOp as long as the DestTy
2163       // is floating point.
2164       if (DstTy->isFloatingPointTy())
2165         return firstOp;
2166       return 0;
2167     case 5: 
2168       // No-op cast in first op implies secondOp as long as the SrcTy
2169       // is an integer.
2170       if (SrcTy->isIntegerTy())
2171         return secondOp;
2172       return 0;
2173     case 6:
2174       // No-op cast in first op implies secondOp as long as the SrcTy
2175       // is a floating point.
2176       if (SrcTy->isFloatingPointTy())
2177         return secondOp;
2178       return 0;
2179     case 7: {
2180       // Cannot simplify if address spaces are different!
2181       if (SrcTy->getPointerAddressSpace() != DstTy->getPointerAddressSpace())
2182         return 0;
2183
2184       unsigned MidSize = MidTy->getScalarSizeInBits();
2185       // We can still fold this without knowing the actual sizes as long we
2186       // know that the intermediate pointer is the largest possible
2187       // pointer size.
2188       // FIXME: Is this always true?
2189       if (MidSize == 64)
2190         return Instruction::BitCast;
2191
2192       // ptrtoint, inttoptr -> bitcast (ptr -> ptr) if int size is >= ptr size.
2193       if (!SrcIntPtrTy || DstIntPtrTy != SrcIntPtrTy)
2194         return 0;
2195       unsigned PtrSize = SrcIntPtrTy->getScalarSizeInBits();
2196       if (MidSize >= PtrSize)
2197         return Instruction::BitCast;
2198       return 0;
2199     }
2200     case 8: {
2201       // ext, trunc -> bitcast,    if the SrcTy and DstTy are same size
2202       // ext, trunc -> ext,        if sizeof(SrcTy) < sizeof(DstTy)
2203       // ext, trunc -> trunc,      if sizeof(SrcTy) > sizeof(DstTy)
2204       unsigned SrcSize = SrcTy->getScalarSizeInBits();
2205       unsigned DstSize = DstTy->getScalarSizeInBits();
2206       if (SrcSize == DstSize)
2207         return Instruction::BitCast;
2208       else if (SrcSize < DstSize)
2209         return firstOp;
2210       return secondOp;
2211     }
2212     case 9:
2213       // zext, sext -> zext, because sext can't sign extend after zext
2214       return Instruction::ZExt;
2215     case 10:
2216       // fpext followed by ftrunc is allowed if the bit size returned to is
2217       // the same as the original, in which case its just a bitcast
2218       if (SrcTy == DstTy)
2219         return Instruction::BitCast;
2220       return 0; // If the types are not the same we can't eliminate it.
2221     case 11: {
2222       // inttoptr, ptrtoint -> bitcast if SrcSize<=PtrSize and SrcSize==DstSize
2223       if (!MidIntPtrTy)
2224         return 0;
2225       unsigned PtrSize = MidIntPtrTy->getScalarSizeInBits();
2226       unsigned SrcSize = SrcTy->getScalarSizeInBits();
2227       unsigned DstSize = DstTy->getScalarSizeInBits();
2228       if (SrcSize <= PtrSize && SrcSize == DstSize)
2229         return Instruction::BitCast;
2230       return 0;
2231     }
2232     case 12: {
2233       // addrspacecast, addrspacecast -> bitcast,       if SrcAS == DstAS
2234       // addrspacecast, addrspacecast -> addrspacecast, if SrcAS != DstAS
2235       if (SrcTy->getPointerAddressSpace() != DstTy->getPointerAddressSpace())
2236         return Instruction::AddrSpaceCast;
2237       return Instruction::BitCast;
2238     }
2239     case 13:
2240       // FIXME: this state can be merged with (1), but the following assert
2241       // is useful to check the correcteness of the sequence due to semantic
2242       // change of bitcast.
2243       assert(
2244         SrcTy->isPtrOrPtrVectorTy() &&
2245         MidTy->isPtrOrPtrVectorTy() &&
2246         DstTy->isPtrOrPtrVectorTy() &&
2247         SrcTy->getPointerAddressSpace() != MidTy->getPointerAddressSpace() &&
2248         MidTy->getPointerAddressSpace() == DstTy->getPointerAddressSpace() &&
2249         "Illegal addrspacecast, bitcast sequence!");
2250       // Allowed, use first cast's opcode
2251       return firstOp;
2252     case 14:
2253       // bitcast, addrspacecast -> addrspacecast if the element type of
2254       // bitcast's source is the same as that of addrspacecast's destination.
2255       if (SrcTy->getPointerElementType() == DstTy->getPointerElementType())
2256         return Instruction::AddrSpaceCast;
2257       return 0;
2258
2259     case 15:
2260       // FIXME: this state can be merged with (1), but the following assert
2261       // is useful to check the correcteness of the sequence due to semantic
2262       // change of bitcast.
2263       assert(
2264         SrcTy->isIntOrIntVectorTy() &&
2265         MidTy->isPtrOrPtrVectorTy() &&
2266         DstTy->isPtrOrPtrVectorTy() &&
2267         MidTy->getPointerAddressSpace() == DstTy->getPointerAddressSpace() &&
2268         "Illegal inttoptr, bitcast sequence!");
2269       // Allowed, use first cast's opcode
2270       return firstOp;
2271     case 16:
2272       // FIXME: this state can be merged with (2), but the following assert
2273       // is useful to check the correcteness of the sequence due to semantic
2274       // change of bitcast.
2275       assert(
2276         SrcTy->isPtrOrPtrVectorTy() &&
2277         MidTy->isPtrOrPtrVectorTy() &&
2278         DstTy->isIntOrIntVectorTy() &&
2279         SrcTy->getPointerAddressSpace() == MidTy->getPointerAddressSpace() &&
2280         "Illegal bitcast, ptrtoint sequence!");
2281       // Allowed, use second cast's opcode
2282       return secondOp;
2283     case 17:
2284       // (sitofp (zext x)) -> (uitofp x)
2285       return Instruction::UIToFP;
2286     case 99: 
2287       // Cast combination can't happen (error in input). This is for all cases
2288       // where the MidTy is not the same for the two cast instructions.
2289       llvm_unreachable("Invalid Cast Combination");
2290     default:
2291       llvm_unreachable("Error in CastResults table!!!");
2292   }
2293 }
2294
2295 CastInst *CastInst::Create(Instruction::CastOps op, Value *S, Type *Ty, 
2296   const Twine &Name, Instruction *InsertBefore) {
2297   assert(castIsValid(op, S, Ty) && "Invalid cast!");
2298   // Construct and return the appropriate CastInst subclass
2299   switch (op) {
2300   case Trunc:         return new TruncInst         (S, Ty, Name, InsertBefore);
2301   case ZExt:          return new ZExtInst          (S, Ty, Name, InsertBefore);
2302   case SExt:          return new SExtInst          (S, Ty, Name, InsertBefore);
2303   case FPTrunc:       return new FPTruncInst       (S, Ty, Name, InsertBefore);
2304   case FPExt:         return new FPExtInst         (S, Ty, Name, InsertBefore);
2305   case UIToFP:        return new UIToFPInst        (S, Ty, Name, InsertBefore);
2306   case SIToFP:        return new SIToFPInst        (S, Ty, Name, InsertBefore);
2307   case FPToUI:        return new FPToUIInst        (S, Ty, Name, InsertBefore);
2308   case FPToSI:        return new FPToSIInst        (S, Ty, Name, InsertBefore);
2309   case PtrToInt:      return new PtrToIntInst      (S, Ty, Name, InsertBefore);
2310   case IntToPtr:      return new IntToPtrInst      (S, Ty, Name, InsertBefore);
2311   case BitCast:       return new BitCastInst       (S, Ty, Name, InsertBefore);
2312   case AddrSpaceCast: return new AddrSpaceCastInst (S, Ty, Name, InsertBefore);
2313   default: llvm_unreachable("Invalid opcode provided");
2314   }
2315 }
2316
2317 CastInst *CastInst::Create(Instruction::CastOps op, Value *S, Type *Ty,
2318   const Twine &Name, BasicBlock *InsertAtEnd) {
2319   assert(castIsValid(op, S, Ty) && "Invalid cast!");
2320   // Construct and return the appropriate CastInst subclass
2321   switch (op) {
2322   case Trunc:         return new TruncInst         (S, Ty, Name, InsertAtEnd);
2323   case ZExt:          return new ZExtInst          (S, Ty, Name, InsertAtEnd);
2324   case SExt:          return new SExtInst          (S, Ty, Name, InsertAtEnd);
2325   case FPTrunc:       return new FPTruncInst       (S, Ty, Name, InsertAtEnd);
2326   case FPExt:         return new FPExtInst         (S, Ty, Name, InsertAtEnd);
2327   case UIToFP:        return new UIToFPInst        (S, Ty, Name, InsertAtEnd);
2328   case SIToFP:        return new SIToFPInst        (S, Ty, Name, InsertAtEnd);
2329   case FPToUI:        return new FPToUIInst        (S, Ty, Name, InsertAtEnd);
2330   case FPToSI:        return new FPToSIInst        (S, Ty, Name, InsertAtEnd);
2331   case PtrToInt:      return new PtrToIntInst      (S, Ty, Name, InsertAtEnd);
2332   case IntToPtr:      return new IntToPtrInst      (S, Ty, Name, InsertAtEnd);
2333   case BitCast:       return new BitCastInst       (S, Ty, Name, InsertAtEnd);
2334   case AddrSpaceCast: return new AddrSpaceCastInst (S, Ty, Name, InsertAtEnd);
2335   default: llvm_unreachable("Invalid opcode provided");
2336   }
2337 }
2338
2339 CastInst *CastInst::CreateZExtOrBitCast(Value *S, Type *Ty, 
2340                                         const Twine &Name,
2341                                         Instruction *InsertBefore) {
2342   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2343     return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2344   return Create(Instruction::ZExt, S, Ty, Name, InsertBefore);
2345 }
2346
2347 CastInst *CastInst::CreateZExtOrBitCast(Value *S, Type *Ty, 
2348                                         const Twine &Name,
2349                                         BasicBlock *InsertAtEnd) {
2350   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2351     return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2352   return Create(Instruction::ZExt, S, Ty, Name, InsertAtEnd);
2353 }
2354
2355 CastInst *CastInst::CreateSExtOrBitCast(Value *S, Type *Ty, 
2356                                         const Twine &Name,
2357                                         Instruction *InsertBefore) {
2358   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2359     return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2360   return Create(Instruction::SExt, S, Ty, Name, InsertBefore);
2361 }
2362
2363 CastInst *CastInst::CreateSExtOrBitCast(Value *S, Type *Ty, 
2364                                         const Twine &Name,
2365                                         BasicBlock *InsertAtEnd) {
2366   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2367     return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2368   return Create(Instruction::SExt, S, Ty, Name, InsertAtEnd);
2369 }
2370
2371 CastInst *CastInst::CreateTruncOrBitCast(Value *S, Type *Ty,
2372                                          const Twine &Name,
2373                                          Instruction *InsertBefore) {
2374   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2375     return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2376   return Create(Instruction::Trunc, S, Ty, Name, InsertBefore);
2377 }
2378
2379 CastInst *CastInst::CreateTruncOrBitCast(Value *S, Type *Ty,
2380                                          const Twine &Name, 
2381                                          BasicBlock *InsertAtEnd) {
2382   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2383     return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2384   return Create(Instruction::Trunc, S, Ty, Name, InsertAtEnd);
2385 }
2386
2387 CastInst *CastInst::CreatePointerCast(Value *S, Type *Ty,
2388                                       const Twine &Name,
2389                                       BasicBlock *InsertAtEnd) {
2390   assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
2391   assert((Ty->isIntOrIntVectorTy() || Ty->isPtrOrPtrVectorTy()) &&
2392          "Invalid cast");
2393   assert(Ty->isVectorTy() == S->getType()->isVectorTy() && "Invalid cast");
2394   assert((!Ty->isVectorTy() ||
2395           Ty->getVectorNumElements() == S->getType()->getVectorNumElements()) &&
2396          "Invalid cast");
2397
2398   if (Ty->isIntOrIntVectorTy())
2399     return Create(Instruction::PtrToInt, S, Ty, Name, InsertAtEnd);
2400
2401   return CreatePointerBitCastOrAddrSpaceCast(S, Ty, Name, InsertAtEnd);
2402 }
2403
2404 /// @brief Create a BitCast or a PtrToInt cast instruction
2405 CastInst *CastInst::CreatePointerCast(Value *S, Type *Ty,
2406                                       const Twine &Name,
2407                                       Instruction *InsertBefore) {
2408   assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
2409   assert((Ty->isIntOrIntVectorTy() || Ty->isPtrOrPtrVectorTy()) &&
2410          "Invalid cast");
2411   assert(Ty->isVectorTy() == S->getType()->isVectorTy() && "Invalid cast");
2412   assert((!Ty->isVectorTy() ||
2413           Ty->getVectorNumElements() == S->getType()->getVectorNumElements()) &&
2414          "Invalid cast");
2415
2416   if (Ty->isIntOrIntVectorTy())
2417     return Create(Instruction::PtrToInt, S, Ty, Name, InsertBefore);
2418
2419   return CreatePointerBitCastOrAddrSpaceCast(S, Ty, Name, InsertBefore);
2420 }
2421
2422 CastInst *CastInst::CreatePointerBitCastOrAddrSpaceCast(
2423   Value *S, Type *Ty,
2424   const Twine &Name,
2425   BasicBlock *InsertAtEnd) {
2426   assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
2427   assert(Ty->isPtrOrPtrVectorTy() && "Invalid cast");
2428
2429   if (S->getType()->getPointerAddressSpace() != Ty->getPointerAddressSpace())
2430     return Create(Instruction::AddrSpaceCast, S, Ty, Name, InsertAtEnd);
2431
2432   return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2433 }
2434
2435 CastInst *CastInst::CreatePointerBitCastOrAddrSpaceCast(
2436   Value *S, Type *Ty,
2437   const Twine &Name,
2438   Instruction *InsertBefore) {
2439   assert(S->getType()->isPtrOrPtrVectorTy() && "Invalid cast");
2440   assert(Ty->isPtrOrPtrVectorTy() && "Invalid cast");
2441
2442   if (S->getType()->getPointerAddressSpace() != Ty->getPointerAddressSpace())
2443     return Create(Instruction::AddrSpaceCast, S, Ty, Name, InsertBefore);
2444
2445   return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2446 }
2447
2448 CastInst *CastInst::CreateBitOrPointerCast(Value *S, Type *Ty,
2449                                            const Twine &Name,
2450                                            Instruction *InsertBefore) {
2451   if (S->getType()->isPointerTy() && Ty->isIntegerTy())
2452     return Create(Instruction::PtrToInt, S, Ty, Name, InsertBefore);
2453   if (S->getType()->isIntegerTy() && Ty->isPointerTy())
2454     return Create(Instruction::IntToPtr, S, Ty, Name, InsertBefore);
2455
2456   return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2457 }
2458
2459 CastInst *CastInst::CreateIntegerCast(Value *C, Type *Ty,
2460                                       bool isSigned, const Twine &Name,
2461                                       Instruction *InsertBefore) {
2462   assert(C->getType()->isIntOrIntVectorTy() && Ty->isIntOrIntVectorTy() &&
2463          "Invalid integer cast");
2464   unsigned SrcBits = C->getType()->getScalarSizeInBits();
2465   unsigned DstBits = Ty->getScalarSizeInBits();
2466   Instruction::CastOps opcode =
2467     (SrcBits == DstBits ? Instruction::BitCast :
2468      (SrcBits > DstBits ? Instruction::Trunc :
2469       (isSigned ? Instruction::SExt : Instruction::ZExt)));
2470   return Create(opcode, C, Ty, Name, InsertBefore);
2471 }
2472
2473 CastInst *CastInst::CreateIntegerCast(Value *C, Type *Ty, 
2474                                       bool isSigned, const Twine &Name,
2475                                       BasicBlock *InsertAtEnd) {
2476   assert(C->getType()->isIntOrIntVectorTy() && Ty->isIntOrIntVectorTy() &&
2477          "Invalid cast");
2478   unsigned SrcBits = C->getType()->getScalarSizeInBits();
2479   unsigned DstBits = Ty->getScalarSizeInBits();
2480   Instruction::CastOps opcode =
2481     (SrcBits == DstBits ? Instruction::BitCast :
2482      (SrcBits > DstBits ? Instruction::Trunc :
2483       (isSigned ? Instruction::SExt : Instruction::ZExt)));
2484   return Create(opcode, C, Ty, Name, InsertAtEnd);
2485 }
2486
2487 CastInst *CastInst::CreateFPCast(Value *C, Type *Ty, 
2488                                  const Twine &Name, 
2489                                  Instruction *InsertBefore) {
2490   assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
2491          "Invalid cast");
2492   unsigned SrcBits = C->getType()->getScalarSizeInBits();
2493   unsigned DstBits = Ty->getScalarSizeInBits();
2494   Instruction::CastOps opcode =
2495     (SrcBits == DstBits ? Instruction::BitCast :
2496      (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt));
2497   return Create(opcode, C, Ty, Name, InsertBefore);
2498 }
2499
2500 CastInst *CastInst::CreateFPCast(Value *C, Type *Ty, 
2501                                  const Twine &Name, 
2502                                  BasicBlock *InsertAtEnd) {
2503   assert(C->getType()->isFPOrFPVectorTy() && Ty->isFPOrFPVectorTy() &&
2504          "Invalid cast");
2505   unsigned SrcBits = C->getType()->getScalarSizeInBits();
2506   unsigned DstBits = Ty->getScalarSizeInBits();
2507   Instruction::CastOps opcode =
2508     (SrcBits == DstBits ? Instruction::BitCast :
2509      (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt));
2510   return Create(opcode, C, Ty, Name, InsertAtEnd);
2511 }
2512
2513 // Check whether it is valid to call getCastOpcode for these types.
2514 // This routine must be kept in sync with getCastOpcode.
2515 bool CastInst::isCastable(Type *SrcTy, Type *DestTy) {
2516   if (!SrcTy->isFirstClassType() || !DestTy->isFirstClassType())
2517     return false;
2518
2519   if (SrcTy == DestTy)
2520     return true;
2521
2522   if (VectorType *SrcVecTy = dyn_cast<VectorType>(SrcTy))
2523     if (VectorType *DestVecTy = dyn_cast<VectorType>(DestTy))
2524       if (SrcVecTy->getNumElements() == DestVecTy->getNumElements()) {
2525         // An element by element cast.  Valid if casting the elements is valid.
2526         SrcTy = SrcVecTy->getElementType();
2527         DestTy = DestVecTy->getElementType();
2528       }
2529
2530   // Get the bit sizes, we'll need these
2531   unsigned SrcBits = SrcTy->getPrimitiveSizeInBits();   // 0 for ptr
2532   unsigned DestBits = DestTy->getPrimitiveSizeInBits(); // 0 for ptr
2533
2534   // Run through the possibilities ...
2535   if (DestTy->isIntegerTy()) {               // Casting to integral
2536     if (SrcTy->isIntegerTy())                // Casting from integral
2537         return true;
2538     if (SrcTy->isFloatingPointTy())   // Casting from floating pt
2539       return true;
2540     if (SrcTy->isVectorTy())          // Casting from vector
2541       return DestBits == SrcBits;
2542                                       // Casting from something else
2543     return SrcTy->isPointerTy();
2544   } 
2545   if (DestTy->isFloatingPointTy()) {  // Casting to floating pt
2546     if (SrcTy->isIntegerTy())                // Casting from integral
2547       return true;
2548     if (SrcTy->isFloatingPointTy())   // Casting from floating pt
2549       return true;
2550     if (SrcTy->isVectorTy())          // Casting from vector
2551       return DestBits == SrcBits;
2552                                     // Casting from something else
2553     return false;
2554   }
2555   if (DestTy->isVectorTy())         // Casting to vector
2556     return DestBits == SrcBits;
2557   if (DestTy->isPointerTy()) {        // Casting to pointer
2558     if (SrcTy->isPointerTy())                // Casting from pointer
2559       return true;
2560     return SrcTy->isIntegerTy();             // Casting from integral
2561   } 
2562   if (DestTy->isX86_MMXTy()) {
2563     if (SrcTy->isVectorTy())
2564       return DestBits == SrcBits;       // 64-bit vector to MMX
2565     return false;
2566   }                                    // Casting to something else
2567   return false;
2568 }
2569
2570 bool CastInst::isBitCastable(Type *SrcTy, Type *DestTy) {
2571   if (!SrcTy->isFirstClassType() || !DestTy->isFirstClassType())
2572     return false;
2573
2574   if (SrcTy == DestTy)
2575     return true;
2576
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();
2583       }
2584     }
2585   }
2586
2587   if (PointerType *DestPtrTy = dyn_cast<PointerType>(DestTy)) {
2588     if (PointerType *SrcPtrTy = dyn_cast<PointerType>(SrcTy)) {
2589       return SrcPtrTy->getAddressSpace() == DestPtrTy->getAddressSpace();
2590     }
2591   }
2592
2593   unsigned SrcBits = SrcTy->getPrimitiveSizeInBits();   // 0 for ptr
2594   unsigned DestBits = DestTy->getPrimitiveSizeInBits(); // 0 for ptr
2595
2596   // Could still have vectors of pointers if the number of elements doesn't
2597   // match
2598   if (SrcBits == 0 || DestBits == 0)
2599     return false;
2600
2601   if (SrcBits != DestBits)
2602     return false;
2603
2604   if (DestTy->isX86_MMXTy() || SrcTy->isX86_MMXTy())
2605     return false;
2606
2607   return true;
2608 }
2609
2610 bool CastInst::isBitOrNoopPointerCastable(Type *SrcTy, Type *DestTy,
2611                                           const DataLayout &DL) {
2612   if (auto *PtrTy = dyn_cast<PointerType>(SrcTy))
2613     if (auto *IntTy = dyn_cast<IntegerType>(DestTy))
2614       return IntTy->getBitWidth() == DL.getPointerTypeSizeInBits(PtrTy);
2615   if (auto *PtrTy = dyn_cast<PointerType>(DestTy))
2616     if (auto *IntTy = dyn_cast<IntegerType>(SrcTy))
2617       return IntTy->getBitWidth() == DL.getPointerTypeSizeInBits(PtrTy);
2618
2619   return isBitCastable(SrcTy, DestTy);
2620 }
2621
2622 // Provide a way to get a "cast" where the cast opcode is inferred from the
2623 // types and size of the operand. This, basically, is a parallel of the
2624 // logic in the castIsValid function below.  This axiom should hold:
2625 //   castIsValid( getCastOpcode(Val, Ty), Val, Ty)
2626 // should not assert in castIsValid. In other words, this produces a "correct"
2627 // casting opcode for the arguments passed to it.
2628 // This routine must be kept in sync with isCastable.
2629 Instruction::CastOps
2630 CastInst::getCastOpcode(
2631   const Value *Src, bool SrcIsSigned, Type *DestTy, bool DestIsSigned) {
2632   Type *SrcTy = Src->getType();
2633
2634   assert(SrcTy->isFirstClassType() && DestTy->isFirstClassType() &&
2635          "Only first class types are castable!");
2636
2637   if (SrcTy == DestTy)
2638     return BitCast;
2639
2640   // FIXME: Check address space sizes here
2641   if (VectorType *SrcVecTy = dyn_cast<VectorType>(SrcTy))
2642     if (VectorType *DestVecTy = dyn_cast<VectorType>(DestTy))
2643       if (SrcVecTy->getNumElements() == DestVecTy->getNumElements()) {
2644         // An element by element cast.  Find the appropriate opcode based on the
2645         // element types.
2646         SrcTy = SrcVecTy->getElementType();
2647         DestTy = DestVecTy->getElementType();
2648       }
2649
2650   // Get the bit sizes, we'll need these
2651   unsigned SrcBits = SrcTy->getPrimitiveSizeInBits();   // 0 for ptr
2652   unsigned DestBits = DestTy->getPrimitiveSizeInBits(); // 0 for ptr
2653
2654   // Run through the possibilities ...
2655   if (DestTy->isIntegerTy()) {                      // Casting to integral
2656     if (SrcTy->isIntegerTy()) {                     // Casting from integral
2657       if (DestBits < SrcBits)
2658         return Trunc;                               // int -> smaller int
2659       else if (DestBits > SrcBits) {                // its an extension
2660         if (SrcIsSigned)
2661           return SExt;                              // signed -> SEXT
2662         else
2663           return ZExt;                              // unsigned -> ZEXT
2664       } else {
2665         return BitCast;                             // Same size, No-op cast
2666       }
2667     } else if (SrcTy->isFloatingPointTy()) {        // Casting from floating pt
2668       if (DestIsSigned) 
2669         return FPToSI;                              // FP -> sint
2670       else
2671         return FPToUI;                              // FP -> uint 
2672     } else if (SrcTy->isVectorTy()) {
2673       assert(DestBits == SrcBits &&
2674              "Casting vector to integer of different width");
2675       return BitCast;                             // Same size, no-op cast
2676     } else {
2677       assert(SrcTy->isPointerTy() &&
2678              "Casting from a value that is not first-class type");
2679       return PtrToInt;                              // ptr -> int
2680     }
2681   } else if (DestTy->isFloatingPointTy()) {         // Casting to floating pt
2682     if (SrcTy->isIntegerTy()) {                     // Casting from integral
2683       if (SrcIsSigned)
2684         return SIToFP;                              // sint -> FP
2685       else
2686         return UIToFP;                              // uint -> FP
2687     } else if (SrcTy->isFloatingPointTy()) {        // Casting from floating pt
2688       if (DestBits < SrcBits) {
2689         return FPTrunc;                             // FP -> smaller FP
2690       } else if (DestBits > SrcBits) {
2691         return FPExt;                               // FP -> larger FP
2692       } else  {
2693         return BitCast;                             // same size, no-op cast
2694       }
2695     } else if (SrcTy->isVectorTy()) {
2696       assert(DestBits == SrcBits &&
2697              "Casting vector to floating point of different width");
2698       return BitCast;                             // same size, no-op cast
2699     }
2700     llvm_unreachable("Casting pointer or non-first class to float");
2701   } else if (DestTy->isVectorTy()) {
2702     assert(DestBits == SrcBits &&
2703            "Illegal cast to vector (wrong type or size)");
2704     return BitCast;
2705   } else if (DestTy->isPointerTy()) {
2706     if (SrcTy->isPointerTy()) {
2707       if (DestTy->getPointerAddressSpace() != SrcTy->getPointerAddressSpace())
2708         return AddrSpaceCast;
2709       return BitCast;                               // ptr -> ptr
2710     } else if (SrcTy->isIntegerTy()) {
2711       return IntToPtr;                              // int -> ptr
2712     }
2713     llvm_unreachable("Casting pointer to other than pointer or int");
2714   } else if (DestTy->isX86_MMXTy()) {
2715     if (SrcTy->isVectorTy()) {
2716       assert(DestBits == SrcBits && "Casting vector of wrong width to X86_MMX");
2717       return BitCast;                               // 64-bit vector to MMX
2718     }
2719     llvm_unreachable("Illegal cast to X86_MMX");
2720   }
2721   llvm_unreachable("Casting to type that is not first-class");
2722 }
2723
2724 //===----------------------------------------------------------------------===//
2725 //                    CastInst SubClass Constructors
2726 //===----------------------------------------------------------------------===//
2727
2728 /// Check that the construction parameters for a CastInst are correct. This
2729 /// could be broken out into the separate constructors but it is useful to have
2730 /// it in one place and to eliminate the redundant code for getting the sizes
2731 /// of the types involved.
2732 bool 
2733 CastInst::castIsValid(Instruction::CastOps op, Value *S, Type *DstTy) {
2734
2735   // Check for type sanity on the arguments
2736   Type *SrcTy = S->getType();
2737
2738   if (!SrcTy->isFirstClassType() || !DstTy->isFirstClassType() ||
2739       SrcTy->isAggregateType() || DstTy->isAggregateType())
2740     return false;
2741
2742   // Get the size of the types in bits, we'll need this later
2743   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2744   unsigned DstBitSize = DstTy->getScalarSizeInBits();
2745
2746   // If these are vector types, get the lengths of the vectors (using zero for
2747   // scalar types means that checking that vector lengths match also checks that
2748   // scalars are not being converted to vectors or vectors to scalars).
2749   unsigned SrcLength = SrcTy->isVectorTy() ?
2750     cast<VectorType>(SrcTy)->getNumElements() : 0;
2751   unsigned DstLength = DstTy->isVectorTy() ?
2752     cast<VectorType>(DstTy)->getNumElements() : 0;
2753
2754   // Switch on the opcode provided
2755   switch (op) {
2756   default: return false; // This is an input error
2757   case Instruction::Trunc:
2758     return SrcTy->isIntOrIntVectorTy() && DstTy->isIntOrIntVectorTy() &&
2759       SrcLength == DstLength && SrcBitSize > DstBitSize;
2760   case Instruction::ZExt:
2761     return SrcTy->isIntOrIntVectorTy() && DstTy->isIntOrIntVectorTy() &&
2762       SrcLength == DstLength && SrcBitSize < DstBitSize;
2763   case Instruction::SExt: 
2764     return SrcTy->isIntOrIntVectorTy() && DstTy->isIntOrIntVectorTy() &&
2765       SrcLength == DstLength && SrcBitSize < DstBitSize;
2766   case Instruction::FPTrunc:
2767     return SrcTy->isFPOrFPVectorTy() && DstTy->isFPOrFPVectorTy() &&
2768       SrcLength == DstLength && SrcBitSize > DstBitSize;
2769   case Instruction::FPExt:
2770     return SrcTy->isFPOrFPVectorTy() && DstTy->isFPOrFPVectorTy() &&
2771       SrcLength == DstLength && SrcBitSize < DstBitSize;
2772   case Instruction::UIToFP:
2773   case Instruction::SIToFP:
2774     return SrcTy->isIntOrIntVectorTy() && DstTy->isFPOrFPVectorTy() &&
2775       SrcLength == DstLength;
2776   case Instruction::FPToUI:
2777   case Instruction::FPToSI:
2778     return SrcTy->isFPOrFPVectorTy() && DstTy->isIntOrIntVectorTy() &&
2779       SrcLength == DstLength;
2780   case Instruction::PtrToInt:
2781     if (isa<VectorType>(SrcTy) != isa<VectorType>(DstTy))
2782       return false;
2783     if (VectorType *VT = dyn_cast<VectorType>(SrcTy))
2784       if (VT->getNumElements() != cast<VectorType>(DstTy)->getNumElements())
2785         return false;
2786     return SrcTy->getScalarType()->isPointerTy() &&
2787            DstTy->getScalarType()->isIntegerTy();
2788   case Instruction::IntToPtr:
2789     if (isa<VectorType>(SrcTy) != isa<VectorType>(DstTy))
2790       return false;
2791     if (VectorType *VT = dyn_cast<VectorType>(SrcTy))
2792       if (VT->getNumElements() != cast<VectorType>(DstTy)->getNumElements())
2793         return false;
2794     return SrcTy->getScalarType()->isIntegerTy() &&
2795            DstTy->getScalarType()->isPointerTy();
2796   case Instruction::BitCast: {
2797     PointerType *SrcPtrTy = dyn_cast<PointerType>(SrcTy->getScalarType());
2798     PointerType *DstPtrTy = dyn_cast<PointerType>(DstTy->getScalarType());
2799
2800     // BitCast implies a no-op cast of type only. No bits change.
2801     // However, you can't cast pointers to anything but pointers.
2802     if (!SrcPtrTy != !DstPtrTy)
2803       return false;
2804
2805     // For non-pointer cases, the cast is okay if the source and destination bit
2806     // widths are identical.
2807     if (!SrcPtrTy)
2808       return SrcTy->getPrimitiveSizeInBits() == DstTy->getPrimitiveSizeInBits();
2809
2810     // If both are pointers then the address spaces must match.
2811     if (SrcPtrTy->getAddressSpace() != DstPtrTy->getAddressSpace())
2812       return false;
2813
2814     // A vector of pointers must have the same number of elements.
2815     if (VectorType *SrcVecTy = dyn_cast<VectorType>(SrcTy)) {
2816       if (VectorType *DstVecTy = dyn_cast<VectorType>(DstTy))
2817         return (SrcVecTy->getNumElements() == DstVecTy->getNumElements());
2818
2819       return false;
2820     }
2821
2822     return true;
2823   }
2824   case Instruction::AddrSpaceCast: {
2825     PointerType *SrcPtrTy = dyn_cast<PointerType>(SrcTy->getScalarType());
2826     if (!SrcPtrTy)
2827       return false;
2828
2829     PointerType *DstPtrTy = dyn_cast<PointerType>(DstTy->getScalarType());
2830     if (!DstPtrTy)
2831       return false;
2832
2833     if (SrcPtrTy->getAddressSpace() == DstPtrTy->getAddressSpace())
2834       return false;
2835
2836     if (VectorType *SrcVecTy = dyn_cast<VectorType>(SrcTy)) {
2837       if (VectorType *DstVecTy = dyn_cast<VectorType>(DstTy))
2838         return (SrcVecTy->getNumElements() == DstVecTy->getNumElements());
2839
2840       return false;
2841     }
2842
2843     return true;
2844   }
2845   }
2846 }
2847
2848 TruncInst::TruncInst(
2849   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2850 ) : CastInst(Ty, Trunc, S, Name, InsertBefore) {
2851   assert(castIsValid(getOpcode(), S, Ty) && "Illegal Trunc");
2852 }
2853
2854 TruncInst::TruncInst(
2855   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2856 ) : CastInst(Ty, Trunc, S, Name, InsertAtEnd) { 
2857   assert(castIsValid(getOpcode(), S, Ty) && "Illegal Trunc");
2858 }
2859
2860 ZExtInst::ZExtInst(
2861   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2862 )  : CastInst(Ty, ZExt, S, Name, InsertBefore) { 
2863   assert(castIsValid(getOpcode(), S, Ty) && "Illegal ZExt");
2864 }
2865
2866 ZExtInst::ZExtInst(
2867   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2868 )  : CastInst(Ty, ZExt, S, Name, InsertAtEnd) { 
2869   assert(castIsValid(getOpcode(), S, Ty) && "Illegal ZExt");
2870 }
2871 SExtInst::SExtInst(
2872   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2873 ) : CastInst(Ty, SExt, S, Name, InsertBefore) { 
2874   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SExt");
2875 }
2876
2877 SExtInst::SExtInst(
2878   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2879 )  : CastInst(Ty, SExt, S, Name, InsertAtEnd) { 
2880   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SExt");
2881 }
2882
2883 FPTruncInst::FPTruncInst(
2884   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2885 ) : CastInst(Ty, FPTrunc, S, Name, InsertBefore) { 
2886   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPTrunc");
2887 }
2888
2889 FPTruncInst::FPTruncInst(
2890   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2891 ) : CastInst(Ty, FPTrunc, S, Name, InsertAtEnd) { 
2892   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPTrunc");
2893 }
2894
2895 FPExtInst::FPExtInst(
2896   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2897 ) : CastInst(Ty, FPExt, S, Name, InsertBefore) { 
2898   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPExt");
2899 }
2900
2901 FPExtInst::FPExtInst(
2902   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2903 ) : CastInst(Ty, FPExt, S, Name, InsertAtEnd) { 
2904   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPExt");
2905 }
2906
2907 UIToFPInst::UIToFPInst(
2908   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2909 ) : CastInst(Ty, UIToFP, S, Name, InsertBefore) { 
2910   assert(castIsValid(getOpcode(), S, Ty) && "Illegal UIToFP");
2911 }
2912
2913 UIToFPInst::UIToFPInst(
2914   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2915 ) : CastInst(Ty, UIToFP, S, Name, InsertAtEnd) { 
2916   assert(castIsValid(getOpcode(), S, Ty) && "Illegal UIToFP");
2917 }
2918
2919 SIToFPInst::SIToFPInst(
2920   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2921 ) : CastInst(Ty, SIToFP, S, Name, InsertBefore) { 
2922   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SIToFP");
2923 }
2924
2925 SIToFPInst::SIToFPInst(
2926   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2927 ) : CastInst(Ty, SIToFP, S, Name, InsertAtEnd) { 
2928   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SIToFP");
2929 }
2930
2931 FPToUIInst::FPToUIInst(
2932   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2933 ) : CastInst(Ty, FPToUI, S, Name, InsertBefore) { 
2934   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToUI");
2935 }
2936
2937 FPToUIInst::FPToUIInst(
2938   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2939 ) : CastInst(Ty, FPToUI, S, Name, InsertAtEnd) { 
2940   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToUI");
2941 }
2942
2943 FPToSIInst::FPToSIInst(
2944   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2945 ) : CastInst(Ty, FPToSI, S, Name, InsertBefore) { 
2946   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToSI");
2947 }
2948
2949 FPToSIInst::FPToSIInst(
2950   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2951 ) : CastInst(Ty, FPToSI, S, Name, InsertAtEnd) { 
2952   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToSI");
2953 }
2954
2955 PtrToIntInst::PtrToIntInst(
2956   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2957 ) : CastInst(Ty, PtrToInt, S, Name, InsertBefore) { 
2958   assert(castIsValid(getOpcode(), S, Ty) && "Illegal PtrToInt");
2959 }
2960
2961 PtrToIntInst::PtrToIntInst(
2962   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2963 ) : CastInst(Ty, PtrToInt, S, Name, InsertAtEnd) { 
2964   assert(castIsValid(getOpcode(), S, Ty) && "Illegal PtrToInt");
2965 }
2966
2967 IntToPtrInst::IntToPtrInst(
2968   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2969 ) : CastInst(Ty, IntToPtr, S, Name, InsertBefore) { 
2970   assert(castIsValid(getOpcode(), S, Ty) && "Illegal IntToPtr");
2971 }
2972
2973 IntToPtrInst::IntToPtrInst(
2974   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2975 ) : CastInst(Ty, IntToPtr, S, Name, InsertAtEnd) { 
2976   assert(castIsValid(getOpcode(), S, Ty) && "Illegal IntToPtr");
2977 }
2978
2979 BitCastInst::BitCastInst(
2980   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2981 ) : CastInst(Ty, BitCast, S, Name, InsertBefore) { 
2982   assert(castIsValid(getOpcode(), S, Ty) && "Illegal BitCast");
2983 }
2984
2985 BitCastInst::BitCastInst(
2986   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2987 ) : CastInst(Ty, BitCast, S, Name, InsertAtEnd) { 
2988   assert(castIsValid(getOpcode(), S, Ty) && "Illegal BitCast");
2989 }
2990
2991 AddrSpaceCastInst::AddrSpaceCastInst(
2992   Value *S, Type *Ty, const Twine &Name, Instruction *InsertBefore
2993 ) : CastInst(Ty, AddrSpaceCast, S, Name, InsertBefore) {
2994   assert(castIsValid(getOpcode(), S, Ty) && "Illegal AddrSpaceCast");
2995 }
2996
2997 AddrSpaceCastInst::AddrSpaceCastInst(
2998   Value *S, Type *Ty, const Twine &Name, BasicBlock *InsertAtEnd
2999 ) : CastInst(Ty, AddrSpaceCast, S, Name, InsertAtEnd) {
3000   assert(castIsValid(getOpcode(), S, Ty) && "Illegal AddrSpaceCast");
3001 }
3002
3003 //===----------------------------------------------------------------------===//
3004 //                               CmpInst Classes
3005 //===----------------------------------------------------------------------===//
3006
3007 void CmpInst::anchor() {}
3008
3009 CmpInst::CmpInst(Type *ty, OtherOps op, unsigned short predicate,
3010                  Value *LHS, Value *RHS, const Twine &Name,
3011                  Instruction *InsertBefore)
3012   : Instruction(ty, op,
3013                 OperandTraits<CmpInst>::op_begin(this),
3014                 OperandTraits<CmpInst>::operands(this),
3015                 InsertBefore) {
3016     Op<0>() = LHS;
3017     Op<1>() = RHS;
3018   setPredicate((Predicate)predicate);
3019   setName(Name);
3020 }
3021
3022 CmpInst::CmpInst(Type *ty, OtherOps op, unsigned short predicate,
3023                  Value *LHS, Value *RHS, const Twine &Name,
3024                  BasicBlock *InsertAtEnd)
3025   : Instruction(ty, op,
3026                 OperandTraits<CmpInst>::op_begin(this),
3027                 OperandTraits<CmpInst>::operands(this),
3028                 InsertAtEnd) {
3029   Op<0>() = LHS;
3030   Op<1>() = RHS;
3031   setPredicate((Predicate)predicate);
3032   setName(Name);
3033 }
3034
3035 CmpInst *
3036 CmpInst::Create(OtherOps Op, unsigned short predicate,
3037                 Value *S1, Value *S2, 
3038                 const Twine &Name, Instruction *InsertBefore) {
3039   if (Op == Instruction::ICmp) {
3040     if (InsertBefore)
3041       return new ICmpInst(InsertBefore, CmpInst::Predicate(predicate),
3042                           S1, S2, Name);
3043     else
3044       return new ICmpInst(CmpInst::Predicate(predicate),
3045                           S1, S2, Name);
3046   }
3047   
3048   if (InsertBefore)
3049     return new FCmpInst(InsertBefore, CmpInst::Predicate(predicate),
3050                         S1, S2, Name);
3051   else
3052     return new FCmpInst(CmpInst::Predicate(predicate),
3053                         S1, S2, Name);
3054 }
3055
3056 CmpInst *
3057 CmpInst::Create(OtherOps Op, unsigned short predicate, Value *S1, Value *S2, 
3058                 const Twine &Name, BasicBlock *InsertAtEnd) {
3059   if (Op == Instruction::ICmp) {
3060     return new ICmpInst(*InsertAtEnd, CmpInst::Predicate(predicate),
3061                         S1, S2, Name);
3062   }
3063   return new FCmpInst(*InsertAtEnd, CmpInst::Predicate(predicate),
3064                       S1, S2, Name);
3065 }
3066
3067 void CmpInst::swapOperands() {
3068   if (ICmpInst *IC = dyn_cast<ICmpInst>(this))
3069     IC->swapOperands();
3070   else
3071     cast<FCmpInst>(this)->swapOperands();
3072 }
3073
3074 bool CmpInst::isCommutative() const {
3075   if (const ICmpInst *IC = dyn_cast<ICmpInst>(this))
3076     return IC->isCommutative();
3077   return cast<FCmpInst>(this)->isCommutative();
3078 }
3079
3080 bool CmpInst::isEquality() const {
3081   if (const ICmpInst *IC = dyn_cast<ICmpInst>(this))
3082     return IC->isEquality();
3083   return cast<FCmpInst>(this)->isEquality();
3084 }
3085
3086
3087 CmpInst::Predicate CmpInst::getInversePredicate(Predicate pred) {
3088   switch (pred) {
3089     default: llvm_unreachable("Unknown cmp predicate!");
3090     case ICMP_EQ: return ICMP_NE;
3091     case ICMP_NE: return ICMP_EQ;
3092     case ICMP_UGT: return ICMP_ULE;
3093     case ICMP_ULT: return ICMP_UGE;
3094     case ICMP_UGE: return ICMP_ULT;
3095     case ICMP_ULE: return ICMP_UGT;
3096     case ICMP_SGT: return ICMP_SLE;
3097     case ICMP_SLT: return ICMP_SGE;
3098     case ICMP_SGE: return ICMP_SLT;
3099     case ICMP_SLE: return ICMP_SGT;
3100
3101     case FCMP_OEQ: return FCMP_UNE;
3102     case FCMP_ONE: return FCMP_UEQ;
3103     case FCMP_OGT: return FCMP_ULE;
3104     case FCMP_OLT: return FCMP_UGE;
3105     case FCMP_OGE: return FCMP_ULT;
3106     case FCMP_OLE: return FCMP_UGT;
3107     case FCMP_UEQ: return FCMP_ONE;
3108     case FCMP_UNE: return FCMP_OEQ;
3109     case FCMP_UGT: return FCMP_OLE;
3110     case FCMP_ULT: return FCMP_OGE;
3111     case FCMP_UGE: return FCMP_OLT;
3112     case FCMP_ULE: return FCMP_OGT;
3113     case FCMP_ORD: return FCMP_UNO;
3114     case FCMP_UNO: return FCMP_ORD;
3115     case FCMP_TRUE: return FCMP_FALSE;
3116     case FCMP_FALSE: return FCMP_TRUE;
3117   }
3118 }
3119
3120 ICmpInst::Predicate ICmpInst::getSignedPredicate(Predicate pred) {
3121   switch (pred) {
3122     default: llvm_unreachable("Unknown icmp predicate!");
3123     case ICMP_EQ: case ICMP_NE: 
3124     case ICMP_SGT: case ICMP_SLT: case ICMP_SGE: case ICMP_SLE: 
3125        return pred;
3126     case ICMP_UGT: return ICMP_SGT;
3127     case ICMP_ULT: return ICMP_SLT;
3128     case ICMP_UGE: return ICMP_SGE;
3129     case ICMP_ULE: return ICMP_SLE;
3130   }
3131 }
3132
3133 ICmpInst::Predicate ICmpInst::getUnsignedPredicate(Predicate pred) {
3134   switch (pred) {
3135     default: llvm_unreachable("Unknown icmp predicate!");
3136     case ICMP_EQ: case ICMP_NE: 
3137     case ICMP_UGT: case ICMP_ULT: case ICMP_UGE: case ICMP_ULE: 
3138        return pred;
3139     case ICMP_SGT: return ICMP_UGT;
3140     case ICMP_SLT: return ICMP_ULT;
3141     case ICMP_SGE: return ICMP_UGE;
3142     case ICMP_SLE: return ICMP_ULE;
3143   }
3144 }
3145
3146 /// Initialize a set of values that all satisfy the condition with C.
3147 ///
3148 ConstantRange 
3149 ICmpInst::makeConstantRange(Predicate pred, const APInt &C) {
3150   APInt Lower(C);
3151   APInt Upper(C);
3152   uint32_t BitWidth = C.getBitWidth();
3153   switch (pred) {
3154   default: llvm_unreachable("Invalid ICmp opcode to ConstantRange ctor!");
3155   case ICmpInst::ICMP_EQ: ++Upper; break;
3156   case ICmpInst::ICMP_NE: ++Lower; break;
3157   case ICmpInst::ICMP_ULT:
3158     Lower = APInt::getMinValue(BitWidth);
3159     // Check for an empty-set condition.
3160     if (Lower == Upper)
3161       return ConstantRange(BitWidth, /*isFullSet=*/false);
3162     break;
3163   case ICmpInst::ICMP_SLT:
3164     Lower = APInt::getSignedMinValue(BitWidth);
3165     // Check for an empty-set condition.
3166     if (Lower == Upper)
3167       return ConstantRange(BitWidth, /*isFullSet=*/false);
3168     break;
3169   case ICmpInst::ICMP_UGT: 
3170     ++Lower; Upper = APInt::getMinValue(BitWidth);        // Min = Next(Max)
3171     // Check for an empty-set condition.
3172     if (Lower == Upper)
3173       return ConstantRange(BitWidth, /*isFullSet=*/false);
3174     break;
3175   case ICmpInst::ICMP_SGT:
3176     ++Lower; Upper = APInt::getSignedMinValue(BitWidth);  // Min = Next(Max)
3177     // Check for an empty-set condition.
3178     if (Lower == Upper)
3179       return ConstantRange(BitWidth, /*isFullSet=*/false);
3180     break;
3181   case ICmpInst::ICMP_ULE: 
3182     Lower = APInt::getMinValue(BitWidth); ++Upper; 
3183     // Check for a full-set condition.
3184     if (Lower == Upper)
3185       return ConstantRange(BitWidth, /*isFullSet=*/true);
3186     break;
3187   case ICmpInst::ICMP_SLE: 
3188     Lower = APInt::getSignedMinValue(BitWidth); ++Upper; 
3189     // Check for a full-set condition.
3190     if (Lower == Upper)
3191       return ConstantRange(BitWidth, /*isFullSet=*/true);
3192     break;
3193   case ICmpInst::ICMP_UGE:
3194     Upper = APInt::getMinValue(BitWidth);        // Min = Next(Max)
3195     // Check for a full-set condition.
3196     if (Lower == Upper)
3197       return ConstantRange(BitWidth, /*isFullSet=*/true);
3198     break;
3199   case ICmpInst::ICMP_SGE:
3200     Upper = APInt::getSignedMinValue(BitWidth);  // Min = Next(Max)
3201     // Check for a full-set condition.
3202     if (Lower == Upper)
3203       return ConstantRange(BitWidth, /*isFullSet=*/true);
3204     break;
3205   }
3206   return ConstantRange(Lower, Upper);
3207 }
3208
3209 CmpInst::Predicate CmpInst::getSwappedPredicate(Predicate pred) {
3210   switch (pred) {
3211     default: llvm_unreachable("Unknown cmp predicate!");
3212     case ICMP_EQ: case ICMP_NE:
3213       return pred;
3214     case ICMP_SGT: return ICMP_SLT;
3215     case ICMP_SLT: return ICMP_SGT;
3216     case ICMP_SGE: return ICMP_SLE;
3217     case ICMP_SLE: return ICMP_SGE;
3218     case ICMP_UGT: return ICMP_ULT;
3219     case ICMP_ULT: return ICMP_UGT;
3220     case ICMP_UGE: return ICMP_ULE;
3221     case ICMP_ULE: return ICMP_UGE;
3222   
3223     case FCMP_FALSE: case FCMP_TRUE:
3224     case FCMP_OEQ: case FCMP_ONE:
3225     case FCMP_UEQ: case FCMP_UNE:
3226     case FCMP_ORD: case FCMP_UNO:
3227       return pred;
3228     case FCMP_OGT: return FCMP_OLT;
3229     case FCMP_OLT: return FCMP_OGT;
3230     case FCMP_OGE: return FCMP_OLE;
3231     case FCMP_OLE: return FCMP_OGE;
3232     case FCMP_UGT: return FCMP_ULT;
3233     case FCMP_ULT: return FCMP_UGT;
3234     case FCMP_UGE: return FCMP_ULE;
3235     case FCMP_ULE: return FCMP_UGE;
3236   }
3237 }
3238
3239 bool CmpInst::isUnsigned(unsigned short predicate) {
3240   switch (predicate) {
3241     default: return false;
3242     case ICmpInst::ICMP_ULT: case ICmpInst::ICMP_ULE: case ICmpInst::ICMP_UGT: 
3243     case ICmpInst::ICMP_UGE: return true;
3244   }
3245 }
3246
3247 bool CmpInst::isSigned(unsigned short predicate) {
3248   switch (predicate) {
3249     default: return false;
3250     case ICmpInst::ICMP_SLT: case ICmpInst::ICMP_SLE: case ICmpInst::ICMP_SGT: 
3251     case ICmpInst::ICMP_SGE: return true;
3252   }
3253 }
3254
3255 bool CmpInst::isOrdered(unsigned short predicate) {
3256   switch (predicate) {
3257     default: return false;
3258     case FCmpInst::FCMP_OEQ: case FCmpInst::FCMP_ONE: case FCmpInst::FCMP_OGT: 
3259     case FCmpInst::FCMP_OLT: case FCmpInst::FCMP_OGE: case FCmpInst::FCMP_OLE: 
3260     case FCmpInst::FCMP_ORD: return true;
3261   }
3262 }
3263       
3264 bool CmpInst::isUnordered(unsigned short predicate) {
3265   switch (predicate) {
3266     default: return false;
3267     case FCmpInst::FCMP_UEQ: case FCmpInst::FCMP_UNE: case FCmpInst::FCMP_UGT: 
3268     case FCmpInst::FCMP_ULT: case FCmpInst::FCMP_UGE: case FCmpInst::FCMP_ULE: 
3269     case FCmpInst::FCMP_UNO: return true;
3270   }
3271 }
3272
3273 bool CmpInst::isTrueWhenEqual(unsigned short predicate) {
3274   switch(predicate) {
3275     default: return false;
3276     case ICMP_EQ:   case ICMP_UGE: case ICMP_ULE: case ICMP_SGE: case ICMP_SLE:
3277     case FCMP_TRUE: case FCMP_UEQ: case FCMP_UGE: case FCMP_ULE: return true;
3278   }
3279 }
3280
3281 bool CmpInst::isFalseWhenEqual(unsigned short predicate) {
3282   switch(predicate) {
3283   case ICMP_NE:    case ICMP_UGT: case ICMP_ULT: case ICMP_SGT: case ICMP_SLT:
3284   case FCMP_FALSE: case FCMP_ONE: case FCMP_OGT: case FCMP_OLT: return true;
3285   default: return false;
3286   }
3287 }
3288
3289
3290 //===----------------------------------------------------------------------===//
3291 //                        SwitchInst Implementation
3292 //===----------------------------------------------------------------------===//
3293
3294 void SwitchInst::init(Value *Value, BasicBlock *Default, unsigned NumReserved) {
3295   assert(Value && Default && NumReserved);
3296   ReservedSpace = NumReserved;
3297   NumOperands = 2;
3298   OperandList = allocHungoffUses(ReservedSpace);
3299
3300   OperandList[0] = Value;
3301   OperandList[1] = Default;
3302 }
3303
3304 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
3305 /// switch on and a default destination.  The number of additional cases can
3306 /// be specified here to make memory allocation more efficient.  This
3307 /// constructor can also autoinsert before another instruction.
3308 SwitchInst::SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
3309                        Instruction *InsertBefore)
3310   : TerminatorInst(Type::getVoidTy(Value->getContext()), Instruction::Switch,
3311                    nullptr, 0, InsertBefore) {
3312   init(Value, Default, 2+NumCases*2);
3313 }
3314
3315 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
3316 /// switch on and a default destination.  The number of additional cases can
3317 /// be specified here to make memory allocation more efficient.  This
3318 /// constructor also autoinserts at the end of the specified BasicBlock.
3319 SwitchInst::SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
3320                        BasicBlock *InsertAtEnd)
3321   : TerminatorInst(Type::getVoidTy(Value->getContext()), Instruction::Switch,
3322                    nullptr, 0, InsertAtEnd) {
3323   init(Value, Default, 2+NumCases*2);
3324 }
3325
3326 SwitchInst::SwitchInst(const SwitchInst &SI)
3327   : TerminatorInst(SI.getType(), Instruction::Switch, nullptr, 0) {
3328   init(SI.getCondition(), SI.getDefaultDest(), SI.getNumOperands());
3329   NumOperands = SI.getNumOperands();
3330   Use *OL = OperandList, *InOL = SI.OperandList;
3331   for (unsigned i = 2, E = SI.getNumOperands(); i != E; i += 2) {
3332     OL[i] = InOL[i];
3333     OL[i+1] = InOL[i+1];
3334   }
3335   SubclassOptionalData = SI.SubclassOptionalData;
3336 }
3337
3338 SwitchInst::~SwitchInst() {
3339   dropHungoffUses();
3340 }
3341
3342
3343 /// addCase - Add an entry to the switch instruction...
3344 ///
3345 void SwitchInst::addCase(ConstantInt *OnVal, BasicBlock *Dest) {
3346   unsigned NewCaseIdx = getNumCases(); 
3347   unsigned OpNo = NumOperands;
3348   if (OpNo+2 > ReservedSpace)
3349     growOperands();  // Get more space!
3350   // Initialize some new operands.
3351   assert(OpNo+1 < ReservedSpace && "Growing didn't work!");
3352   NumOperands = OpNo+2;
3353   CaseIt Case(this, NewCaseIdx);
3354   Case.setValue(OnVal);
3355   Case.setSuccessor(Dest);
3356 }
3357
3358 /// removeCase - This method removes the specified case and its successor
3359 /// from the switch instruction.
3360 void SwitchInst::removeCase(CaseIt i) {
3361   unsigned idx = i.getCaseIndex();
3362   
3363   assert(2 + idx*2 < getNumOperands() && "Case index out of range!!!");
3364
3365   unsigned NumOps = getNumOperands();
3366   Use *OL = OperandList;
3367
3368   // Overwrite this case with the end of the list.
3369   if (2 + (idx + 1) * 2 != NumOps) {
3370     OL[2 + idx * 2] = OL[NumOps - 2];
3371     OL[2 + idx * 2 + 1] = OL[NumOps - 1];
3372   }
3373
3374   // Nuke the last value.
3375   OL[NumOps-2].set(nullptr);
3376   OL[NumOps-2+1].set(nullptr);
3377   NumOperands = NumOps-2;
3378 }
3379
3380 /// growOperands - grow operands - This grows the operand list in response
3381 /// to a push_back style of operation.  This grows the number of ops by 3 times.
3382 ///
3383 void SwitchInst::growOperands() {
3384   unsigned e = getNumOperands();
3385   unsigned NumOps = e*3;
3386
3387   ReservedSpace = NumOps;
3388   Use *NewOps = allocHungoffUses(NumOps);
3389   Use *OldOps = OperandList;
3390   for (unsigned i = 0; i != e; ++i) {
3391       NewOps[i] = OldOps[i];
3392   }
3393   OperandList = NewOps;
3394   Use::zap(OldOps, OldOps + e, true);
3395 }
3396
3397
3398 BasicBlock *SwitchInst::getSuccessorV(unsigned idx) const {
3399   return getSuccessor(idx);
3400 }
3401 unsigned SwitchInst::getNumSuccessorsV() const {
3402   return getNumSuccessors();
3403 }
3404 void SwitchInst::setSuccessorV(unsigned idx, BasicBlock *B) {
3405   setSuccessor(idx, B);
3406 }
3407
3408 //===----------------------------------------------------------------------===//
3409 //                        IndirectBrInst Implementation
3410 //===----------------------------------------------------------------------===//
3411
3412 void IndirectBrInst::init(Value *Address, unsigned NumDests) {
3413   assert(Address && Address->getType()->isPointerTy() &&
3414          "Address of indirectbr must be a pointer");
3415   ReservedSpace = 1+NumDests;
3416   NumOperands = 1;
3417   OperandList = allocHungoffUses(ReservedSpace);
3418   
3419   OperandList[0] = Address;
3420 }
3421
3422
3423 /// growOperands - grow operands - This grows the operand list in response
3424 /// to a push_back style of operation.  This grows the number of ops by 2 times.
3425 ///
3426 void IndirectBrInst::growOperands() {
3427   unsigned e = getNumOperands();
3428   unsigned NumOps = e*2;
3429   
3430   ReservedSpace = NumOps;
3431   Use *NewOps = allocHungoffUses(NumOps);
3432   Use *OldOps = OperandList;
3433   for (unsigned i = 0; i != e; ++i)
3434     NewOps[i] = OldOps[i];
3435   OperandList = NewOps;
3436   Use::zap(OldOps, OldOps + e, true);
3437 }
3438
3439 IndirectBrInst::IndirectBrInst(Value *Address, unsigned NumCases,
3440                                Instruction *InsertBefore)
3441 : TerminatorInst(Type::getVoidTy(Address->getContext()),Instruction::IndirectBr,
3442                  nullptr, 0, InsertBefore) {
3443   init(Address, NumCases);
3444 }
3445
3446 IndirectBrInst::IndirectBrInst(Value *Address, unsigned NumCases,
3447                                BasicBlock *InsertAtEnd)
3448 : TerminatorInst(Type::getVoidTy(Address->getContext()),Instruction::IndirectBr,
3449                  nullptr, 0, InsertAtEnd) {
3450   init(Address, NumCases);
3451 }
3452
3453 IndirectBrInst::IndirectBrInst(const IndirectBrInst &IBI)
3454   : TerminatorInst(Type::getVoidTy(IBI.getContext()), Instruction::IndirectBr,
3455                    allocHungoffUses(IBI.getNumOperands()),
3456                    IBI.getNumOperands()) {
3457   Use *OL = OperandList, *InOL = IBI.OperandList;
3458   for (unsigned i = 0, E = IBI.getNumOperands(); i != E; ++i)
3459     OL[i] = InOL[i];
3460   SubclassOptionalData = IBI.SubclassOptionalData;
3461 }
3462
3463 IndirectBrInst::~IndirectBrInst() {
3464   dropHungoffUses();
3465 }
3466
3467 /// addDestination - Add a destination.
3468 ///
3469 void IndirectBrInst::addDestination(BasicBlock *DestBB) {
3470   unsigned OpNo = NumOperands;
3471   if (OpNo+1 > ReservedSpace)
3472     growOperands();  // Get more space!
3473   // Initialize some new operands.
3474   assert(OpNo < ReservedSpace && "Growing didn't work!");
3475   NumOperands = OpNo+1;
3476   OperandList[OpNo] = DestBB;
3477 }
3478
3479 /// removeDestination - This method removes the specified successor from the
3480 /// indirectbr instruction.
3481 void IndirectBrInst::removeDestination(unsigned idx) {
3482   assert(idx < getNumOperands()-1 && "Successor index out of range!");
3483   
3484   unsigned NumOps = getNumOperands();
3485   Use *OL = OperandList;
3486
3487   // Replace this value with the last one.
3488   OL[idx+1] = OL[NumOps-1];
3489   
3490   // Nuke the last value.
3491   OL[NumOps-1].set(nullptr);
3492   NumOperands = NumOps-1;
3493 }
3494
3495 BasicBlock *IndirectBrInst::getSuccessorV(unsigned idx) const {
3496   return getSuccessor(idx);
3497 }
3498 unsigned IndirectBrInst::getNumSuccessorsV() const {
3499   return getNumSuccessors();
3500 }
3501 void IndirectBrInst::setSuccessorV(unsigned idx, BasicBlock *B) {
3502   setSuccessor(idx, B);
3503 }
3504
3505 //===----------------------------------------------------------------------===//
3506 //                           clone_impl() implementations
3507 //===----------------------------------------------------------------------===//
3508
3509 // Define these methods here so vtables don't get emitted into every translation
3510 // unit that uses these classes.
3511
3512 GetElementPtrInst *GetElementPtrInst::clone_impl() const {
3513   return new (getNumOperands()) GetElementPtrInst(*this);
3514 }
3515
3516 BinaryOperator *BinaryOperator::clone_impl() const {
3517   return Create(getOpcode(), Op<0>(), Op<1>());
3518 }
3519
3520 FCmpInst* FCmpInst::clone_impl() const {
3521   return new FCmpInst(getPredicate(), Op<0>(), Op<1>());
3522 }
3523
3524 ICmpInst* ICmpInst::clone_impl() const {
3525   return new ICmpInst(getPredicate(), Op<0>(), Op<1>());
3526 }
3527
3528 ExtractValueInst *ExtractValueInst::clone_impl() const {
3529   return new ExtractValueInst(*this);
3530 }
3531
3532 InsertValueInst *InsertValueInst::clone_impl() const {
3533   return new InsertValueInst(*this);
3534 }
3535
3536 AllocaInst *AllocaInst::clone_impl() const {
3537   AllocaInst *Result = new AllocaInst(getAllocatedType(),
3538                                       (Value *)getOperand(0), getAlignment());
3539   Result->setUsedWithInAlloca(isUsedWithInAlloca());
3540   return Result;
3541 }
3542
3543 LoadInst *LoadInst::clone_impl() const {
3544   return new LoadInst(getOperand(0), Twine(), isVolatile(),
3545                       getAlignment(), getOrdering(), getSynchScope());
3546 }
3547
3548 StoreInst *StoreInst::clone_impl() const {
3549   return new StoreInst(getOperand(0), getOperand(1), isVolatile(),
3550                        getAlignment(), getOrdering(), getSynchScope());
3551   
3552 }
3553
3554 AtomicCmpXchgInst *AtomicCmpXchgInst::clone_impl() const {
3555   AtomicCmpXchgInst *Result =
3556     new AtomicCmpXchgInst(getOperand(0), getOperand(1), getOperand(2),
3557                           getSuccessOrdering(), getFailureOrdering(),
3558                           getSynchScope());
3559   Result->setVolatile(isVolatile());
3560   Result->setWeak(isWeak());
3561   return Result;
3562 }
3563
3564 AtomicRMWInst *AtomicRMWInst::clone_impl() const {
3565   AtomicRMWInst *Result =
3566     new AtomicRMWInst(getOperation(),getOperand(0), getOperand(1),
3567                       getOrdering(), getSynchScope());
3568   Result->setVolatile(isVolatile());
3569   return Result;
3570 }
3571
3572 FenceInst *FenceInst::clone_impl() const {
3573   return new FenceInst(getContext(), getOrdering(), getSynchScope());
3574 }
3575
3576 TruncInst *TruncInst::clone_impl() const {
3577   return new TruncInst(getOperand(0), getType());
3578 }
3579
3580 ZExtInst *ZExtInst::clone_impl() const {
3581   return new ZExtInst(getOperand(0), getType());
3582 }
3583
3584 SExtInst *SExtInst::clone_impl() const {
3585   return new SExtInst(getOperand(0), getType());
3586 }
3587
3588 FPTruncInst *FPTruncInst::clone_impl() const {
3589   return new FPTruncInst(getOperand(0), getType());
3590 }
3591
3592 FPExtInst *FPExtInst::clone_impl() const {
3593   return new FPExtInst(getOperand(0), getType());
3594 }
3595
3596 UIToFPInst *UIToFPInst::clone_impl() const {
3597   return new UIToFPInst(getOperand(0), getType());
3598 }
3599
3600 SIToFPInst *SIToFPInst::clone_impl() const {
3601   return new SIToFPInst(getOperand(0), getType());
3602 }
3603
3604 FPToUIInst *FPToUIInst::clone_impl() const {
3605   return new FPToUIInst(getOperand(0), getType());
3606 }
3607
3608 FPToSIInst *FPToSIInst::clone_impl() const {
3609   return new FPToSIInst(getOperand(0), getType());
3610 }
3611
3612 PtrToIntInst *PtrToIntInst::clone_impl() const {
3613   return new PtrToIntInst(getOperand(0), getType());
3614 }
3615
3616 IntToPtrInst *IntToPtrInst::clone_impl() const {
3617   return new IntToPtrInst(getOperand(0), getType());
3618 }
3619
3620 BitCastInst *BitCastInst::clone_impl() const {
3621   return new BitCastInst(getOperand(0), getType());
3622 }
3623
3624 AddrSpaceCastInst *AddrSpaceCastInst::clone_impl() const {
3625   return new AddrSpaceCastInst(getOperand(0), getType());
3626 }
3627
3628 CallInst *CallInst::clone_impl() const {
3629   return  new(getNumOperands()) CallInst(*this);
3630 }
3631
3632 SelectInst *SelectInst::clone_impl() const {
3633   return SelectInst::Create(getOperand(0), getOperand(1), getOperand(2));
3634 }
3635
3636 VAArgInst *VAArgInst::clone_impl() const {
3637   return new VAArgInst(getOperand(0), getType());
3638 }
3639
3640 ExtractElementInst *ExtractElementInst::clone_impl() const {
3641   return ExtractElementInst::Create(getOperand(0), getOperand(1));
3642 }
3643
3644 InsertElementInst *InsertElementInst::clone_impl() const {
3645   return InsertElementInst::Create(getOperand(0), getOperand(1), getOperand(2));
3646 }
3647
3648 ShuffleVectorInst *ShuffleVectorInst::clone_impl() const {
3649   return new ShuffleVectorInst(getOperand(0), getOperand(1), getOperand(2));
3650 }
3651
3652 PHINode *PHINode::clone_impl() const {
3653   return new PHINode(*this);
3654 }
3655
3656 LandingPadInst *LandingPadInst::clone_impl() const {
3657   return new LandingPadInst(*this);
3658 }
3659
3660 ReturnInst *ReturnInst::clone_impl() const {
3661   return new(getNumOperands()) ReturnInst(*this);
3662 }
3663
3664 BranchInst *BranchInst::clone_impl() const {
3665   return new(getNumOperands()) BranchInst(*this);
3666 }
3667
3668 SwitchInst *SwitchInst::clone_impl() const {
3669   return new SwitchInst(*this);
3670 }
3671
3672 IndirectBrInst *IndirectBrInst::clone_impl() const {
3673   return new IndirectBrInst(*this);
3674 }
3675
3676
3677 InvokeInst *InvokeInst::clone_impl() const {
3678   return new(getNumOperands()) InvokeInst(*this);
3679 }
3680
3681 ResumeInst *ResumeInst::clone_impl() const {
3682   return new(1) ResumeInst(*this);
3683 }
3684
3685 UnreachableInst *UnreachableInst::clone_impl() const {
3686   LLVMContext &Context = getContext();
3687   return new UnreachableInst(Context);
3688 }