lib/IR/Instructions.cpp

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