lib/IR/Instructions.cpp

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