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