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