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