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