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