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