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 "llvm/Constants.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/Function.h"
  18 #include "llvm/Instructions.h"
  19 #include "llvm/Support/CallSite.h"
  20 #include "llvm/Support/ConstantRange.h"
  21 #include "llvm/Support/MathExtras.h"
  22 using namespace llvm;
  23
  24 //===----------------------------------------------------------------------===//
  25 //                            CallSite Class
  26 //===----------------------------------------------------------------------===//
  27
  28 CallSite::CallSite(Instruction *C) {
  29   assert((isa<CallInst>(C) || isa<InvokeInst>(C)) && "Not a call!");
  30   I = C;
  31 }
  32 unsigned CallSite::getCallingConv() const {
  33   if (CallInst *CI = dyn_cast<CallInst>(I))
  34     return CI->getCallingConv();
  35   else
  36     return cast<InvokeInst>(I)->getCallingConv();
  37 }
  38 void CallSite::setCallingConv(unsigned CC) {
  39   if (CallInst *CI = dyn_cast<CallInst>(I))
  40     CI->setCallingConv(CC);
  41   else
  42     cast<InvokeInst>(I)->setCallingConv(CC);
  43 }
  44 const PAListPtr &CallSite::getParamAttrs() const {
  45   if (CallInst *CI = dyn_cast<CallInst>(I))
  46     return CI->getParamAttrs();
  47   else
  48     return cast<InvokeInst>(I)->getParamAttrs();
  49 }
  50 void CallSite::setParamAttrs(const PAListPtr &PAL) {
  51   if (CallInst *CI = dyn_cast<CallInst>(I))
  52     CI->setParamAttrs(PAL);
  53   else
  54     cast<InvokeInst>(I)->setParamAttrs(PAL);
  55 }
  56 bool CallSite::paramHasAttr(uint16_t i, ParameterAttributes attr) const {
  57   if (CallInst *CI = dyn_cast<CallInst>(I))
  58     return CI->paramHasAttr(i, attr);
  59   else
  60     return cast<InvokeInst>(I)->paramHasAttr(i, attr);
  61 }
  62 uint16_t CallSite::getParamAlignment(uint16_t i) const {
  63   if (CallInst *CI = dyn_cast<CallInst>(I))
  64     return CI->getParamAlignment(i);
  65   else
  66     return cast<InvokeInst>(I)->getParamAlignment(i);
  67 }
  68
  69 bool CallSite::doesNotAccessMemory() const {
  70   if (CallInst *CI = dyn_cast<CallInst>(I))
  71     return CI->doesNotAccessMemory();
  72   else
  73     return cast<InvokeInst>(I)->doesNotAccessMemory();
  74 }
  75 bool CallSite::onlyReadsMemory() const {
  76   if (CallInst *CI = dyn_cast<CallInst>(I))
  77     return CI->onlyReadsMemory();
  78   else
  79     return cast<InvokeInst>(I)->onlyReadsMemory();
  80 }
  81 bool CallSite::doesNotThrow() const {
  82   if (CallInst *CI = dyn_cast<CallInst>(I))
  83     return CI->doesNotThrow();
  84   else
  85     return cast<InvokeInst>(I)->doesNotThrow();
  86 }
  87 void CallSite::setDoesNotThrow(bool doesNotThrow) {
  88   if (CallInst *CI = dyn_cast<CallInst>(I))
  89     CI->setDoesNotThrow(doesNotThrow);
  90   else
  91     cast<InvokeInst>(I)->setDoesNotThrow(doesNotThrow);
  92 }
  93
  94 //===----------------------------------------------------------------------===//
  95 //                            TerminatorInst Class
  96 //===----------------------------------------------------------------------===//
  97
  98 // Out of line virtual method, so the vtable, etc has a home.
  99 TerminatorInst::~TerminatorInst() {
 100 }
 101
 102 //===----------------------------------------------------------------------===//
 103 //                           UnaryInstruction Class
 104 //===----------------------------------------------------------------------===//
 105
 106 // Out of line virtual method, so the vtable, etc has a home.
 107 UnaryInstruction::~UnaryInstruction() {
 108 }
 109
 110 //===----------------------------------------------------------------------===//
 111 //                               PHINode Class
 112 //===----------------------------------------------------------------------===//
 113
 114 PHINode::PHINode(const PHINode &PN)
 115   : Instruction(PN.getType(), Instruction::PHI,
 116                 allocHungoffUses(PN.getNumOperands()), PN.getNumOperands()),
 117     ReservedSpace(PN.getNumOperands()) {
 118   Use *OL = OperandList;
 119   for (unsigned i = 0, e = PN.getNumOperands(); i != e; i+=2) {
 120     OL[i] = PN.getOperand(i);
 121     OL[i+1] = PN.getOperand(i+1);
 122   }
 123 }
 124
 125 PHINode::~PHINode() {
 126   dropHungoffUses(OperandList);
 127 }
 128
 129 // removeIncomingValue - Remove an incoming value.  This is useful if a
 130 // predecessor basic block is deleted.
 131 Value *PHINode::removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty) {
 132   unsigned NumOps = getNumOperands();
 133   Use *OL = OperandList;
 134   assert(Idx*2 < NumOps && "BB not in PHI node!");
 135   Value *Removed = OL[Idx*2];
 136
 137   // Move everything after this operand down.
 138   //
 139   // FIXME: we could just swap with the end of the list, then erase.  However,
 140   // client might not expect this to happen.  The code as it is thrashes the
 141   // use/def lists, which is kinda lame.
 142   for (unsigned i = (Idx+1)*2; i != NumOps; i += 2) {
 143     OL[i-2] = OL[i];
 144     OL[i-2+1] = OL[i+1];
 145   }
 146
 147   // Nuke the last value.
 148   OL[NumOps-2].set(0);
 149   OL[NumOps-2+1].set(0);
 150   NumOperands = NumOps-2;
 151
 152   // If the PHI node is dead, because it has zero entries, nuke it now.
 153   if (NumOps == 2 && DeletePHIIfEmpty) {
 154     // If anyone is using this PHI, make them use a dummy value instead...
 155     replaceAllUsesWith(UndefValue::get(getType()));
 156     eraseFromParent();
 157   }
 158   return Removed;
 159 }
 160
 161 /// resizeOperands - resize operands - This adjusts the length of the operands
 162 /// list according to the following behavior:
 163 ///   1. If NumOps == 0, grow the operand list in response to a push_back style
 164 ///      of operation.  This grows the number of ops by 1.5 times.
 165 ///   2. If NumOps > NumOperands, reserve space for NumOps operands.
 166 ///   3. If NumOps == NumOperands, trim the reserved space.
 167 ///
 168 void PHINode::resizeOperands(unsigned NumOps) {
 169   unsigned e = getNumOperands();
 170   if (NumOps == 0) {
 171     NumOps = e*3/2;
 172     if (NumOps < 4) NumOps = 4;      // 4 op PHI nodes are VERY common.
 173   } else if (NumOps*2 > NumOperands) {
 174     // No resize needed.
 175     if (ReservedSpace >= NumOps) return;
 176   } else if (NumOps == NumOperands) {
 177     if (ReservedSpace == NumOps) return;
 178   } else {
 179     return;
 180   }
 181
 182   ReservedSpace = NumOps;
 183   Use *OldOps = OperandList;
 184   Use *NewOps = allocHungoffUses(NumOps);
 185   for (unsigned i = 0; i != e; ++i) {
 186       NewOps[i] = OldOps[i];
 187   }
 188   OperandList = NewOps;
 189   if (OldOps) Use::zap(OldOps, OldOps + e, true);
 190 }
 191
 192 /// hasConstantValue - If the specified PHI node always merges together the same
 193 /// value, return the value, otherwise return null.
 194 ///
 195 Value *PHINode::hasConstantValue(bool AllowNonDominatingInstruction) const {
 196   // If the PHI node only has one incoming value, eliminate the PHI node...
 197   if (getNumIncomingValues() == 1) {
 198     if (getIncomingValue(0) != this)   // not  X = phi X
 199       return getIncomingValue(0);
 200     else
 201       return UndefValue::get(getType());  // Self cycle is dead.
 202   }
 203
 204   // Otherwise if all of the incoming values are the same for the PHI, replace
 205   // the PHI node with the incoming value.
 206   //
 207   Value *InVal = 0;
 208   bool HasUndefInput = false;
 209   for (unsigned i = 0, e = getNumIncomingValues(); i != e; ++i)
 210     if (isa<UndefValue>(getIncomingValue(i))) {
 211       HasUndefInput = true;
 212     } else if (getIncomingValue(i) != this) { // Not the PHI node itself...
 213       if (InVal && getIncomingValue(i) != InVal)
 214         return 0;  // Not the same, bail out.
 215       else
 216         InVal = getIncomingValue(i);
 217     }
 218
 219   // The only case that could cause InVal to be null is if we have a PHI node
 220   // that only has entries for itself.  In this case, there is no entry into the
 221   // loop, so kill the PHI.
 222   //
 223   if (InVal == 0) InVal = UndefValue::get(getType());
 224
 225   // If we have a PHI node like phi(X, undef, X), where X is defined by some
 226   // instruction, we cannot always return X as the result of the PHI node.  Only
 227   // do this if X is not an instruction (thus it must dominate the PHI block),
 228   // or if the client is prepared to deal with this possibility.
 229   if (HasUndefInput && !AllowNonDominatingInstruction)
 230     if (Instruction *IV = dyn_cast<Instruction>(InVal))
 231       // If it's in the entry block, it dominates everything.
 232       if (IV->getParent() != &IV->getParent()->getParent()->getEntryBlock() ||
 233           isa<InvokeInst>(IV))
 234         return 0;   // Cannot guarantee that InVal dominates this PHINode.
 235
 236   // All of the incoming values are the same, return the value now.
 237   return InVal;
 238 }
 239
 240
 241 //===----------------------------------------------------------------------===//
 242 //                        CallInst Implementation
 243 //===----------------------------------------------------------------------===//
 244
 245 CallInst::~CallInst() {
 246 }
 247
 248 void CallInst::init(Value *Func, Value* const *Params, unsigned NumParams) {
 249   assert(NumOperands == NumParams+1 && "NumOperands not set up?");
 250   Use *OL = OperandList;
 251   OL[0] = Func;
 252
 253   const FunctionType *FTy =
 254     cast<FunctionType>(cast<PointerType>(Func->getType())->getElementType());
 255   FTy = FTy;  // silence warning.
 256
 257   assert((NumParams == FTy->getNumParams() ||
 258           (FTy->isVarArg() && NumParams > FTy->getNumParams())) &&
 259          "Calling a function with bad signature!");
 260   for (unsigned i = 0; i != NumParams; ++i) {
 261     assert((i >= FTy->getNumParams() ||
 262             FTy->getParamType(i) == Params[i]->getType()) &&
 263            "Calling a function with a bad signature!");
 264     OL[i+1] = Params[i];
 265   }
 266 }
 267
 268 void CallInst::init(Value *Func, Value *Actual1, Value *Actual2) {
 269   assert(NumOperands == 3 && "NumOperands not set up?");
 270   Use *OL = OperandList;
 271   OL[0] = Func;
 272   OL[1] = Actual1;
 273   OL[2] = Actual2;
 274
 275   const FunctionType *FTy =
 276     cast<FunctionType>(cast<PointerType>(Func->getType())->getElementType());
 277   FTy = FTy;  // silence warning.
 278
 279   assert((FTy->getNumParams() == 2 ||
 280           (FTy->isVarArg() && FTy->getNumParams() < 2)) &&
 281          "Calling a function with bad signature");
 282   assert((0 >= FTy->getNumParams() ||
 283           FTy->getParamType(0) == Actual1->getType()) &&
 284          "Calling a function with a bad signature!");
 285   assert((1 >= FTy->getNumParams() ||
 286           FTy->getParamType(1) == Actual2->getType()) &&
 287          "Calling a function with a bad signature!");
 288 }
 289
 290 void CallInst::init(Value *Func, Value *Actual) {
 291   assert(NumOperands == 2 && "NumOperands not set up?");
 292   Use *OL = OperandList;
 293   OL[0] = Func;
 294   OL[1] = Actual;
 295
 296   const FunctionType *FTy =
 297     cast<FunctionType>(cast<PointerType>(Func->getType())->getElementType());
 298   FTy = FTy;  // silence warning.
 299
 300   assert((FTy->getNumParams() == 1 ||
 301           (FTy->isVarArg() && FTy->getNumParams() == 0)) &&
 302          "Calling a function with bad signature");
 303   assert((0 == FTy->getNumParams() ||
 304           FTy->getParamType(0) == Actual->getType()) &&
 305          "Calling a function with a bad signature!");
 306 }
 307
 308 void CallInst::init(Value *Func) {
 309   assert(NumOperands == 1 && "NumOperands not set up?");
 310   Use *OL = OperandList;
 311   OL[0] = Func;
 312
 313   const FunctionType *FTy =
 314     cast<FunctionType>(cast<PointerType>(Func->getType())->getElementType());
 315   FTy = FTy;  // silence warning.
 316
 317   assert(FTy->getNumParams() == 0 && "Calling a function with bad signature");
 318 }
 319
 320 CallInst::CallInst(Value *Func, Value* Actual, const std::string &Name,
 321                    Instruction *InsertBefore)
 322   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
 323                                    ->getElementType())->getReturnType(),
 324                 Instruction::Call,
 325                 OperandTraits<CallInst>::op_end(this) - 2,
 326                 2, InsertBefore) {
 327   init(Func, Actual);
 328   setName(Name);
 329 }
 330
 331 CallInst::CallInst(Value *Func, Value* Actual, const std::string &Name,
 332                    BasicBlock  *InsertAtEnd)
 333   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
 334                                    ->getElementType())->getReturnType(),
 335                 Instruction::Call,
 336                 OperandTraits<CallInst>::op_end(this) - 2,
 337                 2, InsertAtEnd) {
 338   init(Func, Actual);
 339   setName(Name);
 340 }
 341 CallInst::CallInst(Value *Func, const std::string &Name,
 342                    Instruction *InsertBefore)
 343   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
 344                                    ->getElementType())->getReturnType(),
 345                 Instruction::Call,
 346                 OperandTraits<CallInst>::op_end(this) - 1,
 347                 1, InsertBefore) {
 348   init(Func);
 349   setName(Name);
 350 }
 351
 352 CallInst::CallInst(Value *Func, const std::string &Name,
 353                    BasicBlock *InsertAtEnd)
 354   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
 355                                    ->getElementType())->getReturnType(),
 356                 Instruction::Call,
 357                 OperandTraits<CallInst>::op_end(this) - 1,
 358                 1, InsertAtEnd) {
 359   init(Func);
 360   setName(Name);
 361 }
 362
 363 CallInst::CallInst(const CallInst &CI)
 364   : Instruction(CI.getType(), Instruction::Call,
 365                 OperandTraits<CallInst>::op_end(this) - CI.getNumOperands(),
 366                 CI.getNumOperands()) {
 367   setParamAttrs(CI.getParamAttrs());
 368   SubclassData = CI.SubclassData;
 369   Use *OL = OperandList;
 370   Use *InOL = CI.OperandList;
 371   for (unsigned i = 0, e = CI.getNumOperands(); i != e; ++i)
 372     OL[i] = InOL[i];
 373 }
 374
 375 void CallInst::addParamAttr(unsigned i, ParameterAttributes attr) {
 376   PAListPtr PAL = getParamAttrs();
 377   PAL = PAL.addAttr(i, attr);
 378   setParamAttrs(PAL);
 379 }
 380
 381 bool CallInst::paramHasAttr(unsigned i, ParameterAttributes attr) const {
 382   if (ParamAttrs.paramHasAttr(i, attr))
 383     return true;
 384   if (const Function *F = getCalledFunction())
 385     return F->paramHasAttr(i, attr);
 386   return false;
 387 }
 388
 389 void CallInst::setDoesNotThrow(bool doesNotThrow) {
 390   PAListPtr PAL = getParamAttrs();
 391   if (doesNotThrow)
 392     PAL = PAL.addAttr(0, ParamAttr::NoUnwind);
 393   else
 394     PAL = PAL.removeAttr(0, ParamAttr::NoUnwind);
 395   setParamAttrs(PAL);
 396 }
 397
 398
 399 //===----------------------------------------------------------------------===//
 400 //                        InvokeInst Implementation
 401 //===----------------------------------------------------------------------===//
 402
 403 void InvokeInst::init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
 404                       Value* const *Args, unsigned NumArgs) {
 405   assert(NumOperands == 3+NumArgs && "NumOperands not set up?");
 406   Use *OL = OperandList;
 407   OL[0] = Fn;
 408   OL[1] = IfNormal;
 409   OL[2] = IfException;
 410   const FunctionType *FTy =
 411     cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType());
 412   FTy = FTy;  // silence warning.
 413
 414   assert(((NumArgs == FTy->getNumParams()) ||
 415           (FTy->isVarArg() && NumArgs > FTy->getNumParams())) &&
 416          "Calling a function with bad signature");
 417
 418   for (unsigned i = 0, e = NumArgs; i != e; i++) {
 419     assert((i >= FTy->getNumParams() ||
 420             FTy->getParamType(i) == Args[i]->getType()) &&
 421            "Invoking a function with a bad signature!");
 422
 423     OL[i+3] = Args[i];
 424   }
 425 }
 426
 427 InvokeInst::InvokeInst(const InvokeInst &II)
 428   : TerminatorInst(II.getType(), Instruction::Invoke,
 429                    OperandTraits<InvokeInst>::op_end(this)
 430                    - II.getNumOperands(),
 431                    II.getNumOperands()) {
 432   setParamAttrs(II.getParamAttrs());
 433   SubclassData = II.SubclassData;
 434   Use *OL = OperandList, *InOL = II.OperandList;
 435   for (unsigned i = 0, e = II.getNumOperands(); i != e; ++i)
 436     OL[i] = InOL[i];
 437 }
 438
 439 BasicBlock *InvokeInst::getSuccessorV(unsigned idx) const {
 440   return getSuccessor(idx);
 441 }
 442 unsigned InvokeInst::getNumSuccessorsV() const {
 443   return getNumSuccessors();
 444 }
 445 void InvokeInst::setSuccessorV(unsigned idx, BasicBlock *B) {
 446   return setSuccessor(idx, B);
 447 }
 448
 449 bool InvokeInst::paramHasAttr(unsigned i, ParameterAttributes attr) const {
 450   if (ParamAttrs.paramHasAttr(i, attr))
 451     return true;
 452   if (const Function *F = getCalledFunction())
 453     return F->paramHasAttr(i, attr);
 454   return false;
 455 }
 456
 457 void InvokeInst::addParamAttr(unsigned i, ParameterAttributes attr) {
 458   PAListPtr PAL = getParamAttrs();
 459   PAL = PAL.addAttr(i, attr);
 460   setParamAttrs(PAL);
 461 }
 462
 463 void InvokeInst::setDoesNotThrow(bool doesNotThrow) {
 464   PAListPtr PAL = getParamAttrs();
 465   if (doesNotThrow)
 466     PAL = PAL.addAttr(0, ParamAttr::NoUnwind);
 467   else
 468     PAL = PAL.removeAttr(0, ParamAttr::NoUnwind);
 469   setParamAttrs(PAL);
 470 }
 471
 472
 473 //===----------------------------------------------------------------------===//
 474 //                        ReturnInst Implementation
 475 //===----------------------------------------------------------------------===//
 476
 477 ReturnInst::ReturnInst(const ReturnInst &RI)
 478   : TerminatorInst(Type::VoidTy, Instruction::Ret,
 479                    OperandTraits<ReturnInst>::op_end(this)
 480                    - RI.getNumOperands(),
 481                    RI.getNumOperands()) {
 482   unsigned N = RI.getNumOperands();
 483   if (N == 1)
 484     Op<0>() = RI.Op<0>();
 485   else if (N) {
 486     Use *OL = OperandList;
 487     for (unsigned i = 0; i < N; ++i)
 488       OL[i] = RI.getOperand(i);
 489   }
 490 }
 491
 492 ReturnInst::ReturnInst(Value *retVal, Instruction *InsertBefore)
 493   : TerminatorInst(Type::VoidTy, Instruction::Ret,
 494                    OperandTraits<ReturnInst>::op_end(this) - (retVal != 0),
 495                    retVal != 0, InsertBefore) {
 496   if (retVal)
 497     init(&retVal, 1);
 498 }
 499 ReturnInst::ReturnInst(Value *retVal, BasicBlock *InsertAtEnd)
 500   : TerminatorInst(Type::VoidTy, Instruction::Ret,
 501                    OperandTraits<ReturnInst>::op_end(this) - (retVal != 0),
 502                    retVal != 0, InsertAtEnd) {
 503   if (retVal)
 504     init(&retVal, 1);
 505 }
 506 ReturnInst::ReturnInst(BasicBlock *InsertAtEnd)
 507   : TerminatorInst(Type::VoidTy, Instruction::Ret,
 508                    OperandTraits<ReturnInst>::op_end(this),
 509                    0, InsertAtEnd) {
 510 }
 511
 512 ReturnInst::ReturnInst(Value * const* retVals, unsigned N,
 513                        Instruction *InsertBefore)
 514   : TerminatorInst(Type::VoidTy, Instruction::Ret,
 515                    OperandTraits<ReturnInst>::op_end(this) - N,
 516                    N, InsertBefore) {
 517   if (N != 0)
 518     init(retVals, N);
 519 }
 520 ReturnInst::ReturnInst(Value * const* retVals, unsigned N,
 521                        BasicBlock *InsertAtEnd)
 522   : TerminatorInst(Type::VoidTy, Instruction::Ret,
 523                    OperandTraits<ReturnInst>::op_end(this) - N,
 524                    N, InsertAtEnd) {
 525   if (N != 0)
 526     init(retVals, N);
 527 }
 528
 529 void ReturnInst::init(Value * const* retVals, unsigned N) {
 530   assert (N > 0 && "Invalid operands numbers in ReturnInst init");
 531
 532   NumOperands = N;
 533   if (NumOperands == 1) {
 534     Value *V = *retVals;
 535     if (V->getType() == Type::VoidTy)
 536       return;
 537     Op<0>() = V;
 538     return;
 539   }
 540
 541   Use *OL = OperandList;
 542   for (unsigned i = 0; i < NumOperands; ++i) {
 543     Value *V = *retVals++;
 544     assert(!isa<BasicBlock>(V) &&
 545            "Cannot return basic block.  Probably using the incorrect ctor");
 546     OL[i] = V;
 547   }
 548 }
 549
 550 unsigned ReturnInst::getNumSuccessorsV() const {
 551   return getNumSuccessors();
 552 }
 553
 554 /// Out-of-line ReturnInst method, put here so the C++ compiler can choose to
 555 /// emit the vtable for the class in this translation unit.
 556 void ReturnInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
 557   assert(0 && "ReturnInst has no successors!");
 558 }
 559
 560 BasicBlock *ReturnInst::getSuccessorV(unsigned idx) const {
 561   assert(0 && "ReturnInst has no successors!");
 562   abort();
 563   return 0;
 564 }
 565
 566 ReturnInst::~ReturnInst() {
 567 }
 568
 569 //===----------------------------------------------------------------------===//
 570 //                        UnwindInst Implementation
 571 //===----------------------------------------------------------------------===//
 572
 573 UnwindInst::UnwindInst(Instruction *InsertBefore)
 574   : TerminatorInst(Type::VoidTy, Instruction::Unwind, 0, 0, InsertBefore) {
 575 }
 576 UnwindInst::UnwindInst(BasicBlock *InsertAtEnd)
 577   : TerminatorInst(Type::VoidTy, Instruction::Unwind, 0, 0, InsertAtEnd) {
 578 }
 579
 580
 581 unsigned UnwindInst::getNumSuccessorsV() const {
 582   return getNumSuccessors();
 583 }
 584
 585 void UnwindInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
 586   assert(0 && "UnwindInst has no successors!");
 587 }
 588
 589 BasicBlock *UnwindInst::getSuccessorV(unsigned idx) const {
 590   assert(0 && "UnwindInst has no successors!");
 591   abort();
 592   return 0;
 593 }
 594
 595 //===----------------------------------------------------------------------===//
 596 //                      UnreachableInst Implementation
 597 //===----------------------------------------------------------------------===//
 598
 599 UnreachableInst::UnreachableInst(Instruction *InsertBefore)
 600   : TerminatorInst(Type::VoidTy, Instruction::Unreachable, 0, 0, InsertBefore) {
 601 }
 602 UnreachableInst::UnreachableInst(BasicBlock *InsertAtEnd)
 603   : TerminatorInst(Type::VoidTy, Instruction::Unreachable, 0, 0, InsertAtEnd) {
 604 }
 605
 606 unsigned UnreachableInst::getNumSuccessorsV() const {
 607   return getNumSuccessors();
 608 }
 609
 610 void UnreachableInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
 611   assert(0 && "UnwindInst has no successors!");
 612 }
 613
 614 BasicBlock *UnreachableInst::getSuccessorV(unsigned idx) const {
 615   assert(0 && "UnwindInst has no successors!");
 616   abort();
 617   return 0;
 618 }
 619
 620 //===----------------------------------------------------------------------===//
 621 //                        BranchInst Implementation
 622 //===----------------------------------------------------------------------===//
 623
 624 void BranchInst::AssertOK() {
 625   if (isConditional())
 626     assert(getCondition()->getType() == Type::Int1Ty &&
 627            "May only branch on boolean predicates!");
 628 }
 629
 630 BranchInst::BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore)
 631   : TerminatorInst(Type::VoidTy, Instruction::Br,
 632                    OperandTraits<BranchInst>::op_end(this) - 1,
 633                    1, InsertBefore) {
 634   assert(IfTrue != 0 && "Branch destination may not be null!");
 635   Op<0>() = IfTrue;
 636 }
 637 BranchInst::BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
 638                        Instruction *InsertBefore)
 639   : TerminatorInst(Type::VoidTy, Instruction::Br,
 640                    OperandTraits<BranchInst>::op_end(this) - 3,
 641                    3, InsertBefore) {
 642   Op<0>() = IfTrue;
 643   Op<1>() = IfFalse;
 644   Op<2>() = Cond;
 645 #ifndef NDEBUG
 646   AssertOK();
 647 #endif
 648 }
 649
 650 BranchInst::BranchInst(BasicBlock *IfTrue, BasicBlock *InsertAtEnd)
 651   : TerminatorInst(Type::VoidTy, Instruction::Br,
 652                    OperandTraits<BranchInst>::op_end(this) - 1,
 653                    1, InsertAtEnd) {
 654   assert(IfTrue != 0 && "Branch destination may not be null!");
 655   Op<0>() = IfTrue;
 656 }
 657
 658 BranchInst::BranchInst(BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond,
 659            BasicBlock *InsertAtEnd)
 660   : TerminatorInst(Type::VoidTy, Instruction::Br,
 661                    OperandTraits<BranchInst>::op_end(this) - 3,
 662                    3, InsertAtEnd) {
 663   Op<0>() = IfTrue;
 664   Op<1>() = IfFalse;
 665   Op<2>() = Cond;
 666 #ifndef NDEBUG
 667   AssertOK();
 668 #endif
 669 }
 670
 671
 672 BranchInst::BranchInst(const BranchInst &BI) :
 673   TerminatorInst(Type::VoidTy, Instruction::Br,
 674                  OperandTraits<BranchInst>::op_end(this) - BI.getNumOperands(),
 675                  BI.getNumOperands()) {
 676   OperandList[0] = BI.getOperand(0);
 677   if (BI.getNumOperands() != 1) {
 678     assert(BI.getNumOperands() == 3 && "BR can have 1 or 3 operands!");
 679     OperandList[1] = BI.getOperand(1);
 680     OperandList[2] = BI.getOperand(2);
 681   }
 682 }
 683
 684 BasicBlock *BranchInst::getSuccessorV(unsigned idx) const {
 685   return getSuccessor(idx);
 686 }
 687 unsigned BranchInst::getNumSuccessorsV() const {
 688   return getNumSuccessors();
 689 }
 690 void BranchInst::setSuccessorV(unsigned idx, BasicBlock *B) {
 691   setSuccessor(idx, B);
 692 }
 693
 694
 695 //===----------------------------------------------------------------------===//
 696 //                        AllocationInst Implementation
 697 //===----------------------------------------------------------------------===//
 698
 699 static Value *getAISize(Value *Amt) {
 700   if (!Amt)
 701     Amt = ConstantInt::get(Type::Int32Ty, 1);
 702   else {
 703     assert(!isa<BasicBlock>(Amt) &&
 704            "Passed basic block into allocation size parameter! Use other ctor");
 705     assert(Amt->getType() == Type::Int32Ty &&
 706            "Malloc/Allocation array size is not a 32-bit integer!");
 707   }
 708   return Amt;
 709 }
 710
 711 AllocationInst::AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy,
 712                                unsigned Align, const std::string &Name,
 713                                Instruction *InsertBefore)
 714   : UnaryInstruction(PointerType::getUnqual(Ty), iTy, getAISize(ArraySize),
 715                      InsertBefore) {
 716   setAlignment(Align);
 717   assert(Ty != Type::VoidTy && "Cannot allocate void!");
 718   setName(Name);
 719 }
 720
 721 AllocationInst::AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy,
 722                                unsigned Align, const std::string &Name,
 723                                BasicBlock *InsertAtEnd)
 724   : UnaryInstruction(PointerType::getUnqual(Ty), iTy, getAISize(ArraySize),
 725                      InsertAtEnd) {
 726   setAlignment(Align);
 727   assert(Ty != Type::VoidTy && "Cannot allocate void!");
 728   setName(Name);
 729 }
 730
 731 // Out of line virtual method, so the vtable, etc has a home.
 732 AllocationInst::~AllocationInst() {
 733 }
 734
 735 void AllocationInst::setAlignment(unsigned Align) {
 736   assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
 737   SubclassData = Log2_32(Align) + 1;
 738   assert(getAlignment() == Align && "Alignment representation error!");
 739 }
 740
 741 bool AllocationInst::isArrayAllocation() const {
 742   if (ConstantInt *CI = dyn_cast<ConstantInt>(getOperand(0)))
 743     return CI->getZExtValue() != 1;
 744   return true;
 745 }
 746
 747 const Type *AllocationInst::getAllocatedType() const {
 748   return getType()->getElementType();
 749 }
 750
 751 AllocaInst::AllocaInst(const AllocaInst &AI)
 752   : AllocationInst(AI.getType()->getElementType(), (Value*)AI.getOperand(0),
 753                    Instruction::Alloca, AI.getAlignment()) {
 754 }
 755
 756 MallocInst::MallocInst(const MallocInst &MI)
 757   : AllocationInst(MI.getType()->getElementType(), (Value*)MI.getOperand(0),
 758                    Instruction::Malloc, MI.getAlignment()) {
 759 }
 760
 761 //===----------------------------------------------------------------------===//
 762 //                             FreeInst Implementation
 763 //===----------------------------------------------------------------------===//
 764
 765 void FreeInst::AssertOK() {
 766   assert(isa<PointerType>(getOperand(0)->getType()) &&
 767          "Can not free something of nonpointer type!");
 768 }
 769
 770 FreeInst::FreeInst(Value *Ptr, Instruction *InsertBefore)
 771   : UnaryInstruction(Type::VoidTy, Free, Ptr, InsertBefore) {
 772   AssertOK();
 773 }
 774
 775 FreeInst::FreeInst(Value *Ptr, BasicBlock *InsertAtEnd)
 776   : UnaryInstruction(Type::VoidTy, Free, Ptr, InsertAtEnd) {
 777   AssertOK();
 778 }
 779
 780
 781 //===----------------------------------------------------------------------===//
 782 //                           LoadInst Implementation
 783 //===----------------------------------------------------------------------===//
 784
 785 void LoadInst::AssertOK() {
 786   assert(isa<PointerType>(getOperand(0)->getType()) &&
 787          "Ptr must have pointer type.");
 788 }
 789
 790 LoadInst::LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBef)
 791   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
 792                      Load, Ptr, InsertBef) {
 793   setVolatile(false);
 794   setAlignment(0);
 795   AssertOK();
 796   setName(Name);
 797 }
 798
 799 LoadInst::LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAE)
 800   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
 801                      Load, Ptr, InsertAE) {
 802   setVolatile(false);
 803   setAlignment(0);
 804   AssertOK();
 805   setName(Name);
 806 }
 807
 808 LoadInst::LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
 809                    Instruction *InsertBef)
 810   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
 811                      Load, Ptr, InsertBef) {
 812   setVolatile(isVolatile);
 813   setAlignment(0);
 814   AssertOK();
 815   setName(Name);
 816 }
 817
 818 LoadInst::LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
 819                    unsigned Align, Instruction *InsertBef)
 820   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
 821                      Load, Ptr, InsertBef) {
 822   setVolatile(isVolatile);
 823   setAlignment(Align);
 824   AssertOK();
 825   setName(Name);
 826 }
 827
 828 LoadInst::LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
 829                    unsigned Align, BasicBlock *InsertAE)
 830   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
 831                      Load, Ptr, InsertAE) {
 832   setVolatile(isVolatile);
 833   setAlignment(Align);
 834   AssertOK();
 835   setName(Name);
 836 }
 837
 838 LoadInst::LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
 839                    BasicBlock *InsertAE)
 840   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
 841                      Load, Ptr, InsertAE) {
 842   setVolatile(isVolatile);
 843   setAlignment(0);
 844   AssertOK();
 845   setName(Name);
 846 }
 847
 848
 849
 850 LoadInst::LoadInst(Value *Ptr, const char *Name, Instruction *InsertBef)
 851   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
 852                      Load, Ptr, InsertBef) {
 853   setVolatile(false);
 854   setAlignment(0);
 855   AssertOK();
 856   if (Name && Name[0]) setName(Name);
 857 }
 858
 859 LoadInst::LoadInst(Value *Ptr, const char *Name, BasicBlock *InsertAE)
 860   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
 861                      Load, Ptr, InsertAE) {
 862   setVolatile(false);
 863   setAlignment(0);
 864   AssertOK();
 865   if (Name && Name[0]) setName(Name);
 866 }
 867
 868 LoadInst::LoadInst(Value *Ptr, const char *Name, bool isVolatile,
 869                    Instruction *InsertBef)
 870 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
 871                    Load, Ptr, InsertBef) {
 872   setVolatile(isVolatile);
 873   setAlignment(0);
 874   AssertOK();
 875   if (Name && Name[0]) setName(Name);
 876 }
 877
 878 LoadInst::LoadInst(Value *Ptr, const char *Name, bool isVolatile,
 879                    BasicBlock *InsertAE)
 880   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
 881                      Load, Ptr, InsertAE) {
 882   setVolatile(isVolatile);
 883   setAlignment(0);
 884   AssertOK();
 885   if (Name && Name[0]) setName(Name);
 886 }
 887
 888 void LoadInst::setAlignment(unsigned Align) {
 889   assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
 890   SubclassData = (SubclassData & 1) | ((Log2_32(Align)+1)<<1);
 891 }
 892
 893 //===----------------------------------------------------------------------===//
 894 //                           StoreInst Implementation
 895 //===----------------------------------------------------------------------===//
 896
 897 void StoreInst::AssertOK() {
 898   assert(isa<PointerType>(getOperand(1)->getType()) &&
 899          "Ptr must have pointer type!");
 900   assert(getOperand(0)->getType() ==
 901                  cast<PointerType>(getOperand(1)->getType())->getElementType()
 902          && "Ptr must be a pointer to Val type!");
 903 }
 904
 905
 906 StoreInst::StoreInst(Value *val, Value *addr, Instruction *InsertBefore)
 907   : Instruction(Type::VoidTy, Store,
 908                 OperandTraits<StoreInst>::op_begin(this),
 909                 OperandTraits<StoreInst>::operands(this),
 910                 InsertBefore) {
 911   Op<0>() = val;
 912   Op<1>() = addr;
 913   setVolatile(false);
 914   setAlignment(0);
 915   AssertOK();
 916 }
 917
 918 StoreInst::StoreInst(Value *val, Value *addr, BasicBlock *InsertAtEnd)
 919   : Instruction(Type::VoidTy, Store,
 920                 OperandTraits<StoreInst>::op_begin(this),
 921                 OperandTraits<StoreInst>::operands(this),
 922                 InsertAtEnd) {
 923   Op<0>() = val;
 924   Op<1>() = addr;
 925   setVolatile(false);
 926   setAlignment(0);
 927   AssertOK();
 928 }
 929
 930 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
 931                      Instruction *InsertBefore)
 932   : Instruction(Type::VoidTy, Store,
 933                 OperandTraits<StoreInst>::op_begin(this),
 934                 OperandTraits<StoreInst>::operands(this),
 935                 InsertBefore) {
 936   Op<0>() = val;
 937   Op<1>() = addr;
 938   setVolatile(isVolatile);
 939   setAlignment(0);
 940   AssertOK();
 941 }
 942
 943 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
 944                      unsigned Align, Instruction *InsertBefore)
 945   : Instruction(Type::VoidTy, Store,
 946                 OperandTraits<StoreInst>::op_begin(this),
 947                 OperandTraits<StoreInst>::operands(this),
 948                 InsertBefore) {
 949   Op<0>() = val;
 950   Op<1>() = addr;
 951   setVolatile(isVolatile);
 952   setAlignment(Align);
 953   AssertOK();
 954 }
 955
 956 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
 957                      unsigned Align, BasicBlock *InsertAtEnd)
 958   : Instruction(Type::VoidTy, Store,
 959                 OperandTraits<StoreInst>::op_begin(this),
 960                 OperandTraits<StoreInst>::operands(this),
 961                 InsertAtEnd) {
 962   Op<0>() = val;
 963   Op<1>() = addr;
 964   setVolatile(isVolatile);
 965   setAlignment(Align);
 966   AssertOK();
 967 }
 968
 969 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
 970                      BasicBlock *InsertAtEnd)
 971   : Instruction(Type::VoidTy, Store,
 972                 OperandTraits<StoreInst>::op_begin(this),
 973                 OperandTraits<StoreInst>::operands(this),
 974                 InsertAtEnd) {
 975   Op<0>() = val;
 976   Op<1>() = addr;
 977   setVolatile(isVolatile);
 978   setAlignment(0);
 979   AssertOK();
 980 }
 981
 982 void StoreInst::setAlignment(unsigned Align) {
 983   assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
 984   SubclassData = (SubclassData & 1) | ((Log2_32(Align)+1)<<1);
 985 }
 986
 987 //===----------------------------------------------------------------------===//
 988 //                       GetElementPtrInst Implementation
 989 //===----------------------------------------------------------------------===//
 990
 991 static unsigned retrieveAddrSpace(const Value *Val) {
 992   return cast<PointerType>(Val->getType())->getAddressSpace();
 993 }
 994
 995 void GetElementPtrInst::init(Value *Ptr, Value* const *Idx, unsigned NumIdx) {
 996   assert(NumOperands == 1+NumIdx && "NumOperands not initialized?");
 997   Use *OL = OperandList;
 998   OL[0] = Ptr;
 999
1000   for (unsigned i = 0; i != NumIdx; ++i)
1001     OL[i+1] = Idx[i];
1002 }
1003
1004 void GetElementPtrInst::init(Value *Ptr, Value *Idx) {
1005   assert(NumOperands == 2 && "NumOperands not initialized?");
1006   Use *OL = OperandList;
1007   OL[0] = Ptr;
1008   OL[1] = Idx;
1009 }
1010
1011 GetElementPtrInst::GetElementPtrInst(const GetElementPtrInst &GEPI)
1012   : Instruction(GEPI.getType(), GetElementPtr,
1013                 OperandTraits<GetElementPtrInst>::op_end(this)
1014                 - GEPI.getNumOperands(),
1015                 GEPI.getNumOperands()) {
1016   Use *OL = OperandList;
1017   Use *GEPIOL = GEPI.OperandList;
1018   for (unsigned i = 0, E = NumOperands; i != E; ++i)
1019     OL[i] = GEPIOL[i];
1020 }
1021
1022 GetElementPtrInst::GetElementPtrInst(Value *Ptr, Value *Idx,
1023                                      const std::string &Name, Instruction *InBe)
1024   : Instruction(PointerType::get(checkType(getIndexedType(Ptr->getType(),Idx)),
1025                                  retrieveAddrSpace(Ptr)),
1026                 GetElementPtr,
1027                 OperandTraits<GetElementPtrInst>::op_end(this) - 2,
1028                 2, InBe) {
1029   init(Ptr, Idx);
1030   setName(Name);
1031 }
1032
1033 GetElementPtrInst::GetElementPtrInst(Value *Ptr, Value *Idx,
1034                                      const std::string &Name, BasicBlock *IAE)
1035   : Instruction(PointerType::get(checkType(getIndexedType(Ptr->getType(),Idx)),
1036                                  retrieveAddrSpace(Ptr)),
1037                 GetElementPtr,
1038                 OperandTraits<GetElementPtrInst>::op_end(this) - 2,
1039                 2, IAE) {
1040   init(Ptr, Idx);
1041   setName(Name);
1042 }
1043
1044 // getIndexedType - Returns the type of the element that would be loaded with
1045 // a load instruction with the specified parameters.
1046 //
1047 // A null type is returned if the indices are invalid for the specified
1048 // pointer type.
1049 //
1050 const Type* GetElementPtrInst::getIndexedType(const Type *Ptr,
1051                                               Value* const *Idxs,
1052                                               unsigned NumIdx) {
1053   const PointerType *PTy = dyn_cast<PointerType>(Ptr);
1054   if (!PTy) return 0;   // Type isn't a pointer type!
1055   const Type *Agg = PTy->getElementType();
1056
1057   // Handle the special case of the empty set index set...
1058   if (NumIdx == 0)
1059     return Agg;
1060
1061   unsigned CurIdx = 1;
1062   for (; CurIdx != NumIdx; ++CurIdx) {
1063     const CompositeType *CT = dyn_cast<CompositeType>(Agg);
1064     if (!CT || isa<PointerType>(CT)) return 0;
1065     Value *Index = Idxs[CurIdx];
1066     if (!CT->indexValid(Index)) return 0;
1067     Agg = CT->getTypeAtIndex(Index);
1068
1069     // If the new type forwards to another type, then it is in the middle
1070     // of being refined to another type (and hence, may have dropped all
1071     // references to what it was using before).  So, use the new forwarded
1072     // type.
1073     if (const Type *Ty = Agg->getForwardedType())
1074       Agg = Ty;
1075   }
1076   return CurIdx == NumIdx ? Agg : 0;
1077 }
1078
1079 const Type* GetElementPtrInst::getIndexedType(const Type *Ptr, Value *Idx) {
1080   const PointerType *PTy = dyn_cast<PointerType>(Ptr);
1081   if (!PTy) return 0;   // Type isn't a pointer type!
1082
1083   // Check the pointer index.
1084   if (!PTy->indexValid(Idx)) return 0;
1085
1086   return PTy->getElementType();
1087 }
1088
1089
1090 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
1091 /// zeros.  If so, the result pointer and the first operand have the same
1092 /// value, just potentially different types.
1093 bool GetElementPtrInst::hasAllZeroIndices() const {
1094   for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1095     if (ConstantInt *CI = dyn_cast<ConstantInt>(getOperand(i))) {
1096       if (!CI->isZero()) return false;
1097     } else {
1098       return false;
1099     }
1100   }
1101   return true;
1102 }
1103
1104 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
1105 /// constant integers.  If so, the result pointer and the first operand have
1106 /// a constant offset between them.
1107 bool GetElementPtrInst::hasAllConstantIndices() const {
1108   for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1109     if (!isa<ConstantInt>(getOperand(i)))
1110       return false;
1111   }
1112   return true;
1113 }
1114
1115
1116 //===----------------------------------------------------------------------===//
1117 //                           ExtractElementInst Implementation
1118 //===----------------------------------------------------------------------===//
1119
1120 ExtractElementInst::ExtractElementInst(Value *Val, Value *Index,
1121                                        const std::string &Name,
1122                                        Instruction *InsertBef)
1123   : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1124                 ExtractElement,
1125                 OperandTraits<ExtractElementInst>::op_begin(this),
1126                 2, InsertBef) {
1127   assert(isValidOperands(Val, Index) &&
1128          "Invalid extractelement instruction operands!");
1129   Op<0>() = Val;
1130   Op<1>() = Index;
1131   setName(Name);
1132 }
1133
1134 ExtractElementInst::ExtractElementInst(Value *Val, unsigned IndexV,
1135                                        const std::string &Name,
1136                                        Instruction *InsertBef)
1137   : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1138                 ExtractElement,
1139                 OperandTraits<ExtractElementInst>::op_begin(this),
1140                 2, InsertBef) {
1141   Constant *Index = ConstantInt::get(Type::Int32Ty, IndexV);
1142   assert(isValidOperands(Val, Index) &&
1143          "Invalid extractelement instruction operands!");
1144   Op<0>() = Val;
1145   Op<1>() = Index;
1146   setName(Name);
1147 }
1148
1149
1150 ExtractElementInst::ExtractElementInst(Value *Val, Value *Index,
1151                                        const std::string &Name,
1152                                        BasicBlock *InsertAE)
1153   : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1154                 ExtractElement,
1155                 OperandTraits<ExtractElementInst>::op_begin(this),
1156                 2, InsertAE) {
1157   assert(isValidOperands(Val, Index) &&
1158          "Invalid extractelement instruction operands!");
1159
1160   Op<0>() = Val;
1161   Op<1>() = Index;
1162   setName(Name);
1163 }
1164
1165 ExtractElementInst::ExtractElementInst(Value *Val, unsigned IndexV,
1166                                        const std::string &Name,
1167                                        BasicBlock *InsertAE)
1168   : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1169                 ExtractElement,
1170                 OperandTraits<ExtractElementInst>::op_begin(this),
1171                 2, InsertAE) {
1172   Constant *Index = ConstantInt::get(Type::Int32Ty, IndexV);
1173   assert(isValidOperands(Val, Index) &&
1174          "Invalid extractelement instruction operands!");
1175
1176   Op<0>() = Val;
1177   Op<1>() = Index;
1178   setName(Name);
1179 }
1180
1181
1182 bool ExtractElementInst::isValidOperands(const Value *Val, const Value *Index) {
1183   if (!isa<VectorType>(Val->getType()) || Index->getType() != Type::Int32Ty)
1184     return false;
1185   return true;
1186 }
1187
1188
1189 //===----------------------------------------------------------------------===//
1190 //                           InsertElementInst Implementation
1191 //===----------------------------------------------------------------------===//
1192
1193 InsertElementInst::InsertElementInst(const InsertElementInst &IE)
1194     : Instruction(IE.getType(), InsertElement,
1195                   OperandTraits<InsertElementInst>::op_begin(this), 3) {
1196   Op<0>() = IE.Op<0>();
1197   Op<1>() = IE.Op<1>();
1198   Op<2>() = IE.Op<2>();
1199 }
1200 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, Value *Index,
1201                                      const std::string &Name,
1202                                      Instruction *InsertBef)
1203   : Instruction(Vec->getType(), InsertElement,
1204                 OperandTraits<InsertElementInst>::op_begin(this),
1205                 3, InsertBef) {
1206   assert(isValidOperands(Vec, Elt, Index) &&
1207          "Invalid insertelement instruction operands!");
1208   Op<0>() = Vec;
1209   Op<1>() = Elt;
1210   Op<2>() = Index;
1211   setName(Name);
1212 }
1213
1214 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, unsigned IndexV,
1215                                      const std::string &Name,
1216                                      Instruction *InsertBef)
1217   : Instruction(Vec->getType(), InsertElement,
1218                 OperandTraits<InsertElementInst>::op_begin(this),
1219                 3, InsertBef) {
1220   Constant *Index = ConstantInt::get(Type::Int32Ty, IndexV);
1221   assert(isValidOperands(Vec, Elt, Index) &&
1222          "Invalid insertelement instruction operands!");
1223   Op<0>() = Vec;
1224   Op<1>() = Elt;
1225   Op<2>() = Index;
1226   setName(Name);
1227 }
1228
1229
1230 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, Value *Index,
1231                                      const std::string &Name,
1232                                      BasicBlock *InsertAE)
1233   : Instruction(Vec->getType(), InsertElement,
1234                 OperandTraits<InsertElementInst>::op_begin(this),
1235                 3, InsertAE) {
1236   assert(isValidOperands(Vec, Elt, Index) &&
1237          "Invalid insertelement instruction operands!");
1238
1239   Op<0>() = Vec;
1240   Op<1>() = Elt;
1241   Op<2>() = Index;
1242   setName(Name);
1243 }
1244
1245 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, unsigned IndexV,
1246                                      const std::string &Name,
1247                                      BasicBlock *InsertAE)
1248 : Instruction(Vec->getType(), InsertElement,
1249               OperandTraits<InsertElementInst>::op_begin(this),
1250               3, InsertAE) {
1251   Constant *Index = ConstantInt::get(Type::Int32Ty, IndexV);
1252   assert(isValidOperands(Vec, Elt, Index) &&
1253          "Invalid insertelement instruction operands!");
1254
1255   Op<0>() = Vec;
1256   Op<1>() = Elt;
1257   Op<2>() = Index;
1258   setName(Name);
1259 }
1260
1261 bool InsertElementInst::isValidOperands(const Value *Vec, const Value *Elt,
1262                                         const Value *Index) {
1263   if (!isa<VectorType>(Vec->getType()))
1264     return false;   // First operand of insertelement must be vector type.
1265
1266   if (Elt->getType() != cast<VectorType>(Vec->getType())->getElementType())
1267     return false;// Second operand of insertelement must be vector element type.
1268
1269   if (Index->getType() != Type::Int32Ty)
1270     return false;  // Third operand of insertelement must be uint.
1271   return true;
1272 }
1273
1274
1275 //===----------------------------------------------------------------------===//
1276 //                      ShuffleVectorInst Implementation
1277 //===----------------------------------------------------------------------===//
1278
1279 ShuffleVectorInst::ShuffleVectorInst(const ShuffleVectorInst &SV)
1280   : Instruction(SV.getType(), ShuffleVector,
1281                 OperandTraits<ShuffleVectorInst>::op_begin(this),
1282                 OperandTraits<ShuffleVectorInst>::operands(this)) {
1283   Op<0>() = SV.Op<0>();
1284   Op<1>() = SV.Op<1>();
1285   Op<2>() = SV.Op<2>();
1286 }
1287
1288 ShuffleVectorInst::ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1289                                      const std::string &Name,
1290                                      Instruction *InsertBefore)
1291   : Instruction(V1->getType(), ShuffleVector,
1292                 OperandTraits<ShuffleVectorInst>::op_begin(this),
1293                 OperandTraits<ShuffleVectorInst>::operands(this),
1294                 InsertBefore) {
1295   assert(isValidOperands(V1, V2, Mask) &&
1296          "Invalid shuffle vector instruction operands!");
1297   Op<0>() = V1;
1298   Op<1>() = V2;
1299   Op<2>() = Mask;
1300   setName(Name);
1301 }
1302
1303 ShuffleVectorInst::ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1304                                      const std::string &Name,
1305                                      BasicBlock *InsertAtEnd)
1306   : Instruction(V1->getType(), ShuffleVector,
1307                 OperandTraits<ShuffleVectorInst>::op_begin(this),
1308                 OperandTraits<ShuffleVectorInst>::operands(this),
1309                 InsertAtEnd) {
1310   assert(isValidOperands(V1, V2, Mask) &&
1311          "Invalid shuffle vector instruction operands!");
1312
1313   Op<0>() = V1;
1314   Op<1>() = V2;
1315   Op<2>() = Mask;
1316   setName(Name);
1317 }
1318
1319 bool ShuffleVectorInst::isValidOperands(const Value *V1, const Value *V2,
1320                                         const Value *Mask) {
1321   if (!isa<VectorType>(V1->getType()) ||
1322       V1->getType() != V2->getType())
1323     return false;
1324
1325   const VectorType *MaskTy = dyn_cast<VectorType>(Mask->getType());
1326   if (!isa<Constant>(Mask) || MaskTy == 0 ||
1327       MaskTy->getElementType() != Type::Int32Ty ||
1328       MaskTy->getNumElements() !=
1329       cast<VectorType>(V1->getType())->getNumElements())
1330     return false;
1331   return true;
1332 }
1333
1334 /// getMaskValue - Return the index from the shuffle mask for the specified
1335 /// output result.  This is either -1 if the element is undef or a number less
1336 /// than 2*numelements.
1337 int ShuffleVectorInst::getMaskValue(unsigned i) const {
1338   const Constant *Mask = cast<Constant>(getOperand(2));
1339   if (isa<UndefValue>(Mask)) return -1;
1340   if (isa<ConstantAggregateZero>(Mask)) return 0;
1341   const ConstantVector *MaskCV = cast<ConstantVector>(Mask);
1342   assert(i < MaskCV->getNumOperands() && "Index out of range");
1343
1344   if (isa<UndefValue>(MaskCV->getOperand(i)))
1345     return -1;
1346   return cast<ConstantInt>(MaskCV->getOperand(i))->getZExtValue();
1347 }
1348
1349 //===----------------------------------------------------------------------===//
1350 //                             InsertValueInst Class
1351 //===----------------------------------------------------------------------===//
1352
1353 void InsertValueInst::init(Value *Agg, Value *Val,
1354                            const unsigned *Idx, unsigned NumIdx) {
1355   assert(NumOperands == 2 && "NumOperands not initialized?");
1356   Op<0>() = Agg;
1357   Op<1>() = Val;
1358
1359   Indices.insert(Indices.end(), Idx, Idx + NumIdx);
1360 }
1361
1362 void InsertValueInst::init(Value *Agg, Value *Val, unsigned Idx) {
1363   assert(NumOperands == 2 && "NumOperands not initialized?");
1364   Op<0>() = Agg;
1365   Op<1>() = Val;
1366
1367   Indices.push_back(Idx);
1368 }
1369
1370 InsertValueInst::InsertValueInst(const InsertValueInst &IVI)
1371   : Instruction(IVI.getType(), InsertValue,
1372                 OperandTraits<InsertValueInst>::op_begin(this), 2),
1373     Indices(IVI.Indices) {
1374 }
1375
1376 //===----------------------------------------------------------------------===//
1377 //                             ExtractValueInst Class
1378 //===----------------------------------------------------------------------===//
1379
1380 void ExtractValueInst::init(Value *Agg, const unsigned *Idx, unsigned NumIdx) {
1381   assert(NumOperands == 1 && "NumOperands not initialized?");
1382   Op<0>() = Agg;
1383
1384   Indices.insert(Indices.end(), Idx, Idx + NumIdx);
1385 }
1386
1387 void ExtractValueInst::init(Value *Agg, unsigned Idx) {
1388   assert(NumOperands == 1 && "NumOperands not initialized?");
1389   Op<0>() = Agg;
1390
1391   Indices.push_back(Idx);
1392 }
1393
1394 ExtractValueInst::ExtractValueInst(const ExtractValueInst &EVI)
1395   : Instruction(reinterpret_cast<const Type*>(EVI.getType()), ExtractValue,
1396                 OperandTraits<ExtractValueInst>::op_begin(this), 1),
1397     Indices(EVI.Indices) {
1398 }
1399
1400 // getIndexedType - Returns the type of the element that would be extracted
1401 // with an extractvalue instruction with the specified parameters.
1402 //
1403 // A null type is returned if the indices are invalid for the specified
1404 // pointer type.
1405 //
1406 const Type* ExtractValueInst::getIndexedType(const Type *Agg,
1407                                              const unsigned *Idxs,
1408                                              unsigned NumIdx) {
1409   unsigned CurIdx = 0;
1410   for (; CurIdx != NumIdx; ++CurIdx) {
1411     const CompositeType *CT = dyn_cast<CompositeType>(Agg);
1412     if (!CT || isa<PointerType>(CT) || isa<VectorType>(CT)) return 0;
1413     unsigned Index = Idxs[CurIdx];
1414     if (!CT->indexValid(Index)) return 0;
1415     Agg = CT->getTypeAtIndex(Index);
1416
1417     // If the new type forwards to another type, then it is in the middle
1418     // of being refined to another type (and hence, may have dropped all
1419     // references to what it was using before).  So, use the new forwarded
1420     // type.
1421     if (const Type *Ty = Agg->getForwardedType())
1422       Agg = Ty;
1423   }
1424   return CurIdx == NumIdx ? Agg : 0;
1425 }
1426
1427 //===----------------------------------------------------------------------===//
1428 //                             BinaryOperator Class
1429 //===----------------------------------------------------------------------===//
1430
1431 BinaryOperator::BinaryOperator(BinaryOps iType, Value *S1, Value *S2,
1432                                const Type *Ty, const std::string &Name,
1433                                Instruction *InsertBefore)
1434   : Instruction(Ty, iType,
1435                 OperandTraits<BinaryOperator>::op_begin(this),
1436                 OperandTraits<BinaryOperator>::operands(this),
1437                 InsertBefore) {
1438   Op<0>() = S1;
1439   Op<1>() = S2;
1440   init(iType);
1441   setName(Name);
1442 }
1443
1444 BinaryOperator::BinaryOperator(BinaryOps iType, Value *S1, Value *S2,
1445                                const Type *Ty, const std::string &Name,
1446                                BasicBlock *InsertAtEnd)
1447   : Instruction(Ty, iType,
1448                 OperandTraits<BinaryOperator>::op_begin(this),
1449                 OperandTraits<BinaryOperator>::operands(this),
1450                 InsertAtEnd) {
1451   Op<0>() = S1;
1452   Op<1>() = S2;
1453   init(iType);
1454   setName(Name);
1455 }
1456
1457
1458 void BinaryOperator::init(BinaryOps iType) {
1459   Value *LHS = getOperand(0), *RHS = getOperand(1);
1460   LHS = LHS; RHS = RHS; // Silence warnings.
1461   assert(LHS->getType() == RHS->getType() &&
1462          "Binary operator operand types must match!");
1463 #ifndef NDEBUG
1464   switch (iType) {
1465   case Add: case Sub:
1466   case Mul:
1467     assert(getType() == LHS->getType() &&
1468            "Arithmetic operation should return same type as operands!");
1469     assert((getType()->isInteger() || getType()->isFloatingPoint() ||
1470             isa<VectorType>(getType())) &&
1471           "Tried to create an arithmetic operation on a non-arithmetic type!");
1472     break;
1473   case UDiv:
1474   case SDiv:
1475     assert(getType() == LHS->getType() &&
1476            "Arithmetic operation should return same type as operands!");
1477     assert((getType()->isInteger() || (isa<VectorType>(getType()) &&
1478             cast<VectorType>(getType())->getElementType()->isInteger())) &&
1479            "Incorrect operand type (not integer) for S/UDIV");
1480     break;
1481   case FDiv:
1482     assert(getType() == LHS->getType() &&
1483            "Arithmetic operation should return same type as operands!");
1484     assert((getType()->isFloatingPoint() || (isa<VectorType>(getType()) &&
1485             cast<VectorType>(getType())->getElementType()->isFloatingPoint()))
1486             && "Incorrect operand type (not floating point) for FDIV");
1487     break;
1488   case URem:
1489   case SRem:
1490     assert(getType() == LHS->getType() &&
1491            "Arithmetic operation should return same type as operands!");
1492     assert((getType()->isInteger() || (isa<VectorType>(getType()) &&
1493             cast<VectorType>(getType())->getElementType()->isInteger())) &&
1494            "Incorrect operand type (not integer) for S/UREM");
1495     break;
1496   case FRem:
1497     assert(getType() == LHS->getType() &&
1498            "Arithmetic operation should return same type as operands!");
1499     assert((getType()->isFloatingPoint() || (isa<VectorType>(getType()) &&
1500             cast<VectorType>(getType())->getElementType()->isFloatingPoint()))
1501             && "Incorrect operand type (not floating point) for FREM");
1502     break;
1503   case Shl:
1504   case LShr:
1505   case AShr:
1506     assert(getType() == LHS->getType() &&
1507            "Shift operation should return same type as operands!");
1508     assert(getType()->isInteger() &&
1509            "Shift operation requires integer operands");
1510     break;
1511   case And: case Or:
1512   case Xor:
1513     assert(getType() == LHS->getType() &&
1514            "Logical operation should return same type as operands!");
1515     assert((getType()->isInteger() ||
1516             (isa<VectorType>(getType()) &&
1517              cast<VectorType>(getType())->getElementType()->isInteger())) &&
1518            "Tried to create a logical operation on a non-integral type!");
1519     break;
1520   default:
1521     break;
1522   }
1523 #endif
1524 }
1525
1526 BinaryOperator *BinaryOperator::Create(BinaryOps Op, Value *S1, Value *S2,
1527                                        const std::string &Name,
1528                                        Instruction *InsertBefore) {
1529   assert(S1->getType() == S2->getType() &&
1530          "Cannot create binary operator with two operands of differing type!");
1531   return new BinaryOperator(Op, S1, S2, S1->getType(), Name, InsertBefore);
1532 }
1533
1534 BinaryOperator *BinaryOperator::Create(BinaryOps Op, Value *S1, Value *S2,
1535                                        const std::string &Name,
1536                                        BasicBlock *InsertAtEnd) {
1537   BinaryOperator *Res = Create(Op, S1, S2, Name);
1538   InsertAtEnd->getInstList().push_back(Res);
1539   return Res;
1540 }
1541
1542 BinaryOperator *BinaryOperator::CreateNeg(Value *Op, const std::string &Name,
1543                                           Instruction *InsertBefore) {
1544   Value *zero = ConstantExpr::getZeroValueForNegationExpr(Op->getType());
1545   return new BinaryOperator(Instruction::Sub,
1546                             zero, Op,
1547                             Op->getType(), Name, InsertBefore);
1548 }
1549
1550 BinaryOperator *BinaryOperator::CreateNeg(Value *Op, const std::string &Name,
1551                                           BasicBlock *InsertAtEnd) {
1552   Value *zero = ConstantExpr::getZeroValueForNegationExpr(Op->getType());
1553   return new BinaryOperator(Instruction::Sub,
1554                             zero, Op,
1555                             Op->getType(), Name, InsertAtEnd);
1556 }
1557
1558 BinaryOperator *BinaryOperator::CreateNot(Value *Op, const std::string &Name,
1559                                           Instruction *InsertBefore) {
1560   Constant *C;
1561   if (const VectorType *PTy = dyn_cast<VectorType>(Op->getType())) {
1562     C = ConstantInt::getAllOnesValue(PTy->getElementType());
1563     C = ConstantVector::get(std::vector<Constant*>(PTy->getNumElements(), C));
1564   } else {
1565     C = ConstantInt::getAllOnesValue(Op->getType());
1566   }
1567
1568   return new BinaryOperator(Instruction::Xor, Op, C,
1569                             Op->getType(), Name, InsertBefore);
1570 }
1571
1572 BinaryOperator *BinaryOperator::CreateNot(Value *Op, const std::string &Name,
1573                                           BasicBlock *InsertAtEnd) {
1574   Constant *AllOnes;
1575   if (const VectorType *PTy = dyn_cast<VectorType>(Op->getType())) {
1576     // Create a vector of all ones values.
1577     Constant *Elt = ConstantInt::getAllOnesValue(PTy->getElementType());
1578     AllOnes =
1579       ConstantVector::get(std::vector<Constant*>(PTy->getNumElements(), Elt));
1580   } else {
1581     AllOnes = ConstantInt::getAllOnesValue(Op->getType());
1582   }
1583
1584   return new BinaryOperator(Instruction::Xor, Op, AllOnes,
1585                             Op->getType(), Name, InsertAtEnd);
1586 }
1587
1588
1589 // isConstantAllOnes - Helper function for several functions below
1590 static inline bool isConstantAllOnes(const Value *V) {
1591   if (const ConstantInt *CI = dyn_cast<ConstantInt>(V))
1592     return CI->isAllOnesValue();
1593   if (const ConstantVector *CV = dyn_cast<ConstantVector>(V))
1594     return CV->isAllOnesValue();
1595   return false;
1596 }
1597
1598 bool BinaryOperator::isNeg(const Value *V) {
1599   if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
1600     if (Bop->getOpcode() == Instruction::Sub)
1601       return Bop->getOperand(0) ==
1602              ConstantExpr::getZeroValueForNegationExpr(Bop->getType());
1603   return false;
1604 }
1605
1606 bool BinaryOperator::isNot(const Value *V) {
1607   if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
1608     return (Bop->getOpcode() == Instruction::Xor &&
1609             (isConstantAllOnes(Bop->getOperand(1)) ||
1610              isConstantAllOnes(Bop->getOperand(0))));
1611   return false;
1612 }
1613
1614 Value *BinaryOperator::getNegArgument(Value *BinOp) {
1615   assert(isNeg(BinOp) && "getNegArgument from non-'neg' instruction!");
1616   return cast<BinaryOperator>(BinOp)->getOperand(1);
1617 }
1618
1619 const Value *BinaryOperator::getNegArgument(const Value *BinOp) {
1620   return getNegArgument(const_cast<Value*>(BinOp));
1621 }
1622
1623 Value *BinaryOperator::getNotArgument(Value *BinOp) {
1624   assert(isNot(BinOp) && "getNotArgument on non-'not' instruction!");
1625   BinaryOperator *BO = cast<BinaryOperator>(BinOp);
1626   Value *Op0 = BO->getOperand(0);
1627   Value *Op1 = BO->getOperand(1);
1628   if (isConstantAllOnes(Op0)) return Op1;
1629
1630   assert(isConstantAllOnes(Op1));
1631   return Op0;
1632 }
1633
1634 const Value *BinaryOperator::getNotArgument(const Value *BinOp) {
1635   return getNotArgument(const_cast<Value*>(BinOp));
1636 }
1637
1638
1639 // swapOperands - Exchange the two operands to this instruction.  This
1640 // instruction is safe to use on any binary instruction and does not
1641 // modify the semantics of the instruction.  If the instruction is
1642 // order dependent (SetLT f.e.) the opcode is changed.
1643 //
1644 bool BinaryOperator::swapOperands() {
1645   if (!isCommutative())
1646     return true; // Can't commute operands
1647   Op<0>().swap(Op<1>());
1648   return false;
1649 }
1650
1651 //===----------------------------------------------------------------------===//
1652 //                                CastInst Class
1653 //===----------------------------------------------------------------------===//
1654
1655 // Just determine if this cast only deals with integral->integral conversion.
1656 bool CastInst::isIntegerCast() const {
1657   switch (getOpcode()) {
1658     default: return false;
1659     case Instruction::ZExt:
1660     case Instruction::SExt:
1661     case Instruction::Trunc:
1662       return true;
1663     case Instruction::BitCast:
1664       return getOperand(0)->getType()->isInteger() && getType()->isInteger();
1665   }
1666 }
1667
1668 bool CastInst::isLosslessCast() const {
1669   // Only BitCast can be lossless, exit fast if we're not BitCast
1670   if (getOpcode() != Instruction::BitCast)
1671     return false;
1672
1673   // Identity cast is always lossless
1674   const Type* SrcTy = getOperand(0)->getType();
1675   const Type* DstTy = getType();
1676   if (SrcTy == DstTy)
1677     return true;
1678
1679   // Pointer to pointer is always lossless.
1680   if (isa<PointerType>(SrcTy))
1681     return isa<PointerType>(DstTy);
1682   return false;  // Other types have no identity values
1683 }
1684
1685 /// This function determines if the CastInst does not require any bits to be
1686 /// changed in order to effect the cast. Essentially, it identifies cases where
1687 /// no code gen is necessary for the cast, hence the name no-op cast.  For
1688 /// example, the following are all no-op casts:
1689 /// # bitcast i32* %x to i8*
1690 /// # bitcast <2 x i32> %x to <4 x i16>
1691 /// # ptrtoint i32* %x to i32     ; on 32-bit plaforms only
1692 /// @brief Determine if a cast is a no-op.
1693 bool CastInst::isNoopCast(const Type *IntPtrTy) const {
1694   switch (getOpcode()) {
1695     default:
1696       assert(!"Invalid CastOp");
1697     case Instruction::Trunc:
1698     case Instruction::ZExt:
1699     case Instruction::SExt:
1700     case Instruction::FPTrunc:
1701     case Instruction::FPExt:
1702     case Instruction::UIToFP:
1703     case Instruction::SIToFP:
1704     case Instruction::FPToUI:
1705     case Instruction::FPToSI:
1706       return false; // These always modify bits
1707     case Instruction::BitCast:
1708       return true;  // BitCast never modifies bits.
1709     case Instruction::PtrToInt:
1710       return IntPtrTy->getPrimitiveSizeInBits() ==
1711             getType()->getPrimitiveSizeInBits();
1712     case Instruction::IntToPtr:
1713       return IntPtrTy->getPrimitiveSizeInBits() ==
1714              getOperand(0)->getType()->getPrimitiveSizeInBits();
1715   }
1716 }
1717
1718 /// This function determines if a pair of casts can be eliminated and what
1719 /// opcode should be used in the elimination. This assumes that there are two
1720 /// instructions like this:
1721 /// *  %F = firstOpcode SrcTy %x to MidTy
1722 /// *  %S = secondOpcode MidTy %F to DstTy
1723 /// The function returns a resultOpcode so these two casts can be replaced with:
1724 /// *  %Replacement = resultOpcode %SrcTy %x to DstTy
1725 /// If no such cast is permited, the function returns 0.
1726 unsigned CastInst::isEliminableCastPair(
1727   Instruction::CastOps firstOp, Instruction::CastOps secondOp,
1728   const Type *SrcTy, const Type *MidTy, const Type *DstTy, const Type *IntPtrTy)
1729 {
1730   // Define the 144 possibilities for these two cast instructions. The values
1731   // in this matrix determine what to do in a given situation and select the
1732   // case in the switch below.  The rows correspond to firstOp, the columns
1733   // correspond to secondOp.  In looking at the table below, keep in  mind
1734   // the following cast properties:
1735   //
1736   //          Size Compare       Source               Destination
1737   // Operator  Src ? Size   Type       Sign         Type       Sign
1738   // -------- ------------ -------------------   ---------------------
1739   // TRUNC         >       Integer      Any        Integral     Any
1740   // ZEXT          <       Integral   Unsigned     Integer      Any
1741   // SEXT          <       Integral    Signed      Integer      Any
1742   // FPTOUI       n/a      FloatPt      n/a        Integral   Unsigned
1743   // FPTOSI       n/a      FloatPt      n/a        Integral    Signed
1744   // UITOFP       n/a      Integral   Unsigned     FloatPt      n/a
1745   // SITOFP       n/a      Integral    Signed      FloatPt      n/a
1746   // FPTRUNC       >       FloatPt      n/a        FloatPt      n/a
1747   // FPEXT         <       FloatPt      n/a        FloatPt      n/a
1748   // PTRTOINT     n/a      Pointer      n/a        Integral   Unsigned
1749   // INTTOPTR     n/a      Integral   Unsigned     Pointer      n/a
1750   // BITCONVERT    =       FirstClass   n/a       FirstClass    n/a
1751   //
1752   // NOTE: some transforms are safe, but we consider them to be non-profitable.
1753   // For example, we could merge "fptoui double to uint" + "zext uint to ulong",
1754   // into "fptoui double to ulong", but this loses information about the range
1755   // of the produced value (we no longer know the top-part is all zeros).
1756   // Further this conversion is often much more expensive for typical hardware,
1757   // and causes issues when building libgcc.  We disallow fptosi+sext for the
1758   // same reason.
1759   const unsigned numCastOps =
1760     Instruction::CastOpsEnd - Instruction::CastOpsBegin;
1761   static const uint8_t CastResults[numCastOps][numCastOps] = {
1762     // T        F  F  U  S  F  F  P  I  B   -+
1763     // R  Z  S  P  P  I  I  T  P  2  N  T    |
1764     // U  E  E  2  2  2  2  R  E  I  T  C    +- secondOp
1765     // N  X  X  U  S  F  F  N  X  N  2  V    |
1766     // C  T  T  I  I  P  P  C  T  T  P  T   -+
1767     {  1, 0, 0,99,99, 0, 0,99,99,99, 0, 3 }, // Trunc      -+
1768     {  8, 1, 9,99,99, 2, 0,99,99,99, 2, 3 }, // ZExt        |
1769     {  8, 0, 1,99,99, 0, 2,99,99,99, 0, 3 }, // SExt        |
1770     {  0, 0, 0,99,99, 0, 0,99,99,99, 0, 3 }, // FPToUI      |
1771     {  0, 0, 0,99,99, 0, 0,99,99,99, 0, 3 }, // FPToSI      |
1772     { 99,99,99, 0, 0,99,99, 0, 0,99,99, 4 }, // UIToFP      +- firstOp
1773     { 99,99,99, 0, 0,99,99, 0, 0,99,99, 4 }, // SIToFP      |
1774     { 99,99,99, 0, 0,99,99, 1, 0,99,99, 4 }, // FPTrunc     |
1775     { 99,99,99, 2, 2,99,99,10, 2,99,99, 4 }, // FPExt       |
1776     {  1, 0, 0,99,99, 0, 0,99,99,99, 7, 3 }, // PtrToInt    |
1777     { 99,99,99,99,99,99,99,99,99,13,99,12 }, // IntToPtr    |
1778     {  5, 5, 5, 6, 6, 5, 5, 6, 6,11, 5, 1 }, // BitCast    -+
1779   };
1780
1781   int ElimCase = CastResults[firstOp-Instruction::CastOpsBegin]
1782                             [secondOp-Instruction::CastOpsBegin];
1783   switch (ElimCase) {
1784     case 0:
1785       // categorically disallowed
1786       return 0;
1787     case 1:
1788       // allowed, use first cast's opcode
1789       return firstOp;
1790     case 2:
1791       // allowed, use second cast's opcode
1792       return secondOp;
1793     case 3:
1794       // no-op cast in second op implies firstOp as long as the DestTy
1795       // is integer
1796       if (DstTy->isInteger())
1797         return firstOp;
1798       return 0;
1799     case 4:
1800       // no-op cast in second op implies firstOp as long as the DestTy
1801       // is floating point
1802       if (DstTy->isFloatingPoint())
1803         return firstOp;
1804       return 0;
1805     case 5:
1806       // no-op cast in first op implies secondOp as long as the SrcTy
1807       // is an integer
1808       if (SrcTy->isInteger())
1809         return secondOp;
1810       return 0;
1811     case 6:
1812       // no-op cast in first op implies secondOp as long as the SrcTy
1813       // is a floating point
1814       if (SrcTy->isFloatingPoint())
1815         return secondOp;
1816       return 0;
1817     case 7: {
1818       // ptrtoint, inttoptr -> bitcast (ptr -> ptr) if int size is >= ptr size
1819       unsigned PtrSize = IntPtrTy->getPrimitiveSizeInBits();
1820       unsigned MidSize = MidTy->getPrimitiveSizeInBits();
1821       if (MidSize >= PtrSize)
1822         return Instruction::BitCast;
1823       return 0;
1824     }
1825     case 8: {
1826       // ext, trunc -> bitcast,    if the SrcTy and DstTy are same size
1827       // ext, trunc -> ext,        if sizeof(SrcTy) < sizeof(DstTy)
1828       // ext, trunc -> trunc,      if sizeof(SrcTy) > sizeof(DstTy)
1829       unsigned SrcSize = SrcTy->getPrimitiveSizeInBits();
1830       unsigned DstSize = DstTy->getPrimitiveSizeInBits();
1831       if (SrcSize == DstSize)
1832         return Instruction::BitCast;
1833       else if (SrcSize < DstSize)
1834         return firstOp;
1835       return secondOp;
1836     }
1837     case 9: // zext, sext -> zext, because sext can't sign extend after zext
1838       return Instruction::ZExt;
1839     case 10:
1840       // fpext followed by ftrunc is allowed if the bit size returned to is
1841       // the same as the original, in which case its just a bitcast
1842       if (SrcTy == DstTy)
1843         return Instruction::BitCast;
1844       return 0; // If the types are not the same we can't eliminate it.
1845     case 11:
1846       // bitcast followed by ptrtoint is allowed as long as the bitcast
1847       // is a pointer to pointer cast.
1848       if (isa<PointerType>(SrcTy) && isa<PointerType>(MidTy))
1849         return secondOp;
1850       return 0;
1851     case 12:
1852       // inttoptr, bitcast -> intptr  if bitcast is a ptr to ptr cast
1853       if (isa<PointerType>(MidTy) && isa<PointerType>(DstTy))
1854         return firstOp;
1855       return 0;
1856     case 13: {
1857       // inttoptr, ptrtoint -> bitcast if SrcSize<=PtrSize and SrcSize==DstSize
1858       unsigned PtrSize = IntPtrTy->getPrimitiveSizeInBits();
1859       unsigned SrcSize = SrcTy->getPrimitiveSizeInBits();
1860       unsigned DstSize = DstTy->getPrimitiveSizeInBits();
1861       if (SrcSize <= PtrSize && SrcSize == DstSize)
1862         return Instruction::BitCast;
1863       return 0;
1864     }
1865     case 99:
1866       // cast combination can't happen (error in input). This is for all cases
1867       // where the MidTy is not the same for the two cast instructions.
1868       assert(!"Invalid Cast Combination");
1869       return 0;
1870     default:
1871       assert(!"Error in CastResults table!!!");
1872       return 0;
1873   }
1874   return 0;
1875 }
1876
1877 CastInst *CastInst::Create(Instruction::CastOps op, Value *S, const Type *Ty,
1878   const std::string &Name, Instruction *InsertBefore) {
1879   // Construct and return the appropriate CastInst subclass
1880   switch (op) {
1881     case Trunc:    return new TruncInst    (S, Ty, Name, InsertBefore);
1882     case ZExt:     return new ZExtInst     (S, Ty, Name, InsertBefore);
1883     case SExt:     return new SExtInst     (S, Ty, Name, InsertBefore);
1884     case FPTrunc:  return new FPTruncInst  (S, Ty, Name, InsertBefore);
1885     case FPExt:    return new FPExtInst    (S, Ty, Name, InsertBefore);
1886     case UIToFP:   return new UIToFPInst   (S, Ty, Name, InsertBefore);
1887     case SIToFP:   return new SIToFPInst   (S, Ty, Name, InsertBefore);
1888     case FPToUI:   return new FPToUIInst   (S, Ty, Name, InsertBefore);
1889     case FPToSI:   return new FPToSIInst   (S, Ty, Name, InsertBefore);
1890     case PtrToInt: return new PtrToIntInst (S, Ty, Name, InsertBefore);
1891     case IntToPtr: return new IntToPtrInst (S, Ty, Name, InsertBefore);
1892     case BitCast:  return new BitCastInst  (S, Ty, Name, InsertBefore);
1893     default:
1894       assert(!"Invalid opcode provided");
1895   }
1896   return 0;
1897 }
1898
1899 CastInst *CastInst::Create(Instruction::CastOps op, Value *S, const Type *Ty,
1900   const std::string &Name, BasicBlock *InsertAtEnd) {
1901   // Construct and return the appropriate CastInst subclass
1902   switch (op) {
1903     case Trunc:    return new TruncInst    (S, Ty, Name, InsertAtEnd);
1904     case ZExt:     return new ZExtInst     (S, Ty, Name, InsertAtEnd);
1905     case SExt:     return new SExtInst     (S, Ty, Name, InsertAtEnd);
1906     case FPTrunc:  return new FPTruncInst  (S, Ty, Name, InsertAtEnd);
1907     case FPExt:    return new FPExtInst    (S, Ty, Name, InsertAtEnd);
1908     case UIToFP:   return new UIToFPInst   (S, Ty, Name, InsertAtEnd);
1909     case SIToFP:   return new SIToFPInst   (S, Ty, Name, InsertAtEnd);
1910     case FPToUI:   return new FPToUIInst   (S, Ty, Name, InsertAtEnd);
1911     case FPToSI:   return new FPToSIInst   (S, Ty, Name, InsertAtEnd);
1912     case PtrToInt: return new PtrToIntInst (S, Ty, Name, InsertAtEnd);
1913     case IntToPtr: return new IntToPtrInst (S, Ty, Name, InsertAtEnd);
1914     case BitCast:  return new BitCastInst  (S, Ty, Name, InsertAtEnd);
1915     default:
1916       assert(!"Invalid opcode provided");
1917   }
1918   return 0;
1919 }
1920
1921 CastInst *CastInst::CreateZExtOrBitCast(Value *S, const Type *Ty,
1922                                         const std::string &Name,
1923                                         Instruction *InsertBefore) {
1924   if (S->getType()->getPrimitiveSizeInBits() == Ty->getPrimitiveSizeInBits())
1925     return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
1926   return Create(Instruction::ZExt, S, Ty, Name, InsertBefore);
1927 }
1928
1929 CastInst *CastInst::CreateZExtOrBitCast(Value *S, const Type *Ty,
1930                                         const std::string &Name,
1931                                         BasicBlock *InsertAtEnd) {
1932   if (S->getType()->getPrimitiveSizeInBits() == Ty->getPrimitiveSizeInBits())
1933     return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
1934   return Create(Instruction::ZExt, S, Ty, Name, InsertAtEnd);
1935 }
1936
1937 CastInst *CastInst::CreateSExtOrBitCast(Value *S, const Type *Ty,
1938                                         const std::string &Name,
1939                                         Instruction *InsertBefore) {
1940   if (S->getType()->getPrimitiveSizeInBits() == Ty->getPrimitiveSizeInBits())
1941     return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
1942   return Create(Instruction::SExt, S, Ty, Name, InsertBefore);
1943 }
1944
1945 CastInst *CastInst::CreateSExtOrBitCast(Value *S, const Type *Ty,
1946                                         const std::string &Name,
1947                                         BasicBlock *InsertAtEnd) {
1948   if (S->getType()->getPrimitiveSizeInBits() == Ty->getPrimitiveSizeInBits())
1949     return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
1950   return Create(Instruction::SExt, S, Ty, Name, InsertAtEnd);
1951 }
1952
1953 CastInst *CastInst::CreateTruncOrBitCast(Value *S, const Type *Ty,
1954                                          const std::string &Name,
1955                                          Instruction *InsertBefore) {
1956   if (S->getType()->getPrimitiveSizeInBits() == Ty->getPrimitiveSizeInBits())
1957     return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
1958   return Create(Instruction::Trunc, S, Ty, Name, InsertBefore);
1959 }
1960
1961 CastInst *CastInst::CreateTruncOrBitCast(Value *S, const Type *Ty,
1962                                          const std::string &Name,
1963                                          BasicBlock *InsertAtEnd) {
1964   if (S->getType()->getPrimitiveSizeInBits() == Ty->getPrimitiveSizeInBits())
1965     return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
1966   return Create(Instruction::Trunc, S, Ty, Name, InsertAtEnd);
1967 }
1968
1969 CastInst *CastInst::CreatePointerCast(Value *S, const Type *Ty,
1970                                       const std::string &Name,
1971                                       BasicBlock *InsertAtEnd) {
1972   assert(isa<PointerType>(S->getType()) && "Invalid cast");
1973   assert((Ty->isInteger() || isa<PointerType>(Ty)) &&
1974          "Invalid cast");
1975
1976   if (Ty->isInteger())
1977     return Create(Instruction::PtrToInt, S, Ty, Name, InsertAtEnd);
1978   return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
1979 }
1980
1981 /// @brief Create a BitCast or a PtrToInt cast instruction
1982 CastInst *CastInst::CreatePointerCast(Value *S, const Type *Ty,
1983                                       const std::string &Name,
1984                                       Instruction *InsertBefore) {
1985   assert(isa<PointerType>(S->getType()) && "Invalid cast");
1986   assert((Ty->isInteger() || isa<PointerType>(Ty)) &&
1987          "Invalid cast");
1988
1989   if (Ty->isInteger())
1990     return Create(Instruction::PtrToInt, S, Ty, Name, InsertBefore);
1991   return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
1992 }
1993
1994 CastInst *CastInst::CreateIntegerCast(Value *C, const Type *Ty,
1995                                       bool isSigned, const std::string &Name,
1996                                       Instruction *InsertBefore) {
1997   assert(C->getType()->isInteger() && Ty->isInteger() && "Invalid cast");
1998   unsigned SrcBits = C->getType()->getPrimitiveSizeInBits();
1999   unsigned DstBits = Ty->getPrimitiveSizeInBits();
2000   Instruction::CastOps opcode =
2001     (SrcBits == DstBits ? Instruction::BitCast :
2002      (SrcBits > DstBits ? Instruction::Trunc :
2003       (isSigned ? Instruction::SExt : Instruction::ZExt)));
2004   return Create(opcode, C, Ty, Name, InsertBefore);
2005 }
2006
2007 CastInst *CastInst::CreateIntegerCast(Value *C, const Type *Ty,
2008                                       bool isSigned, const std::string &Name,
2009                                       BasicBlock *InsertAtEnd) {
2010   assert(C->getType()->isInteger() && Ty->isInteger() && "Invalid cast");
2011   unsigned SrcBits = C->getType()->getPrimitiveSizeInBits();
2012   unsigned DstBits = Ty->getPrimitiveSizeInBits();
2013   Instruction::CastOps opcode =
2014     (SrcBits == DstBits ? Instruction::BitCast :
2015      (SrcBits > DstBits ? Instruction::Trunc :
2016       (isSigned ? Instruction::SExt : Instruction::ZExt)));
2017   return Create(opcode, C, Ty, Name, InsertAtEnd);
2018 }
2019
2020 CastInst *CastInst::CreateFPCast(Value *C, const Type *Ty,
2021                                  const std::string &Name,
2022                                  Instruction *InsertBefore) {
2023   assert(C->getType()->isFloatingPoint() && Ty->isFloatingPoint() &&
2024          "Invalid cast");
2025   unsigned SrcBits = C->getType()->getPrimitiveSizeInBits();
2026   unsigned DstBits = Ty->getPrimitiveSizeInBits();
2027   Instruction::CastOps opcode =
2028     (SrcBits == DstBits ? Instruction::BitCast :
2029      (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt));
2030   return Create(opcode, C, Ty, Name, InsertBefore);
2031 }
2032
2033 CastInst *CastInst::CreateFPCast(Value *C, const Type *Ty,
2034                                  const std::string &Name,
2035                                  BasicBlock *InsertAtEnd) {
2036   assert(C->getType()->isFloatingPoint() && Ty->isFloatingPoint() &&
2037          "Invalid cast");
2038   unsigned SrcBits = C->getType()->getPrimitiveSizeInBits();
2039   unsigned DstBits = Ty->getPrimitiveSizeInBits();
2040   Instruction::CastOps opcode =
2041     (SrcBits == DstBits ? Instruction::BitCast :
2042      (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt));
2043   return Create(opcode, C, Ty, Name, InsertAtEnd);
2044 }
2045
2046 // Check whether it is valid to call getCastOpcode for these types.
2047 // This routine must be kept in sync with getCastOpcode.
2048 bool CastInst::isCastable(const Type *SrcTy, const Type *DestTy) {
2049   if (!SrcTy->isFirstClassType() || !DestTy->isFirstClassType())
2050     return false;
2051
2052   if (SrcTy == DestTy)
2053     return true;
2054
2055   // Get the bit sizes, we'll need these
2056   unsigned SrcBits = SrcTy->getPrimitiveSizeInBits();   // 0 for ptr/vector
2057   unsigned DestBits = DestTy->getPrimitiveSizeInBits(); // 0 for ptr/vector
2058
2059   // Run through the possibilities ...
2060   if (DestTy->isInteger()) {                   // Casting to integral
2061     if (SrcTy->isInteger()) {                  // Casting from integral
2062         return true;
2063     } else if (SrcTy->isFloatingPoint()) {     // Casting from floating pt
2064       return true;
2065     } else if (const VectorType *PTy = dyn_cast<VectorType>(SrcTy)) {
2066                                                // Casting from vector
2067       return DestBits == PTy->getBitWidth();
2068     } else {                                   // Casting from something else
2069       return isa<PointerType>(SrcTy);
2070     }
2071   } else if (DestTy->isFloatingPoint()) {      // Casting to floating pt
2072     if (SrcTy->isInteger()) {                  // Casting from integral
2073       return true;
2074     } else if (SrcTy->isFloatingPoint()) {     // Casting from floating pt
2075       return true;
2076     } else if (const VectorType *PTy = dyn_cast<VectorType>(SrcTy)) {
2077                                                // Casting from vector
2078       return DestBits == PTy->getBitWidth();
2079     } else {                                   // Casting from something else
2080       return false;
2081     }
2082   } else if (const VectorType *DestPTy = dyn_cast<VectorType>(DestTy)) {
2083                                                 // Casting to vector
2084     if (const VectorType *SrcPTy = dyn_cast<VectorType>(SrcTy)) {
2085                                                 // Casting from vector
2086       return DestPTy->getBitWidth() == SrcPTy->getBitWidth();
2087     } else {                                    // Casting from something else
2088       return DestPTy->getBitWidth() == SrcBits;
2089     }
2090   } else if (isa<PointerType>(DestTy)) {        // Casting to pointer
2091     if (isa<PointerType>(SrcTy)) {              // Casting from pointer
2092       return true;
2093     } else if (SrcTy->isInteger()) {            // Casting from integral
2094       return true;
2095     } else {                                    // Casting from something else
2096       return false;
2097     }
2098   } else {                                      // Casting to something else
2099     return false;
2100   }
2101 }
2102
2103 // Provide a way to get a "cast" where the cast opcode is inferred from the
2104 // types and size of the operand. This, basically, is a parallel of the
2105 // logic in the castIsValid function below.  This axiom should hold:
2106 //   castIsValid( getCastOpcode(Val, Ty), Val, Ty)
2107 // should not assert in castIsValid. In other words, this produces a "correct"
2108 // casting opcode for the arguments passed to it.
2109 // This routine must be kept in sync with isCastable.
2110 Instruction::CastOps
2111 CastInst::getCastOpcode(
2112   const Value *Src, bool SrcIsSigned, const Type *DestTy, bool DestIsSigned) {
2113   // Get the bit sizes, we'll need these
2114   const Type *SrcTy = Src->getType();
2115   unsigned SrcBits = SrcTy->getPrimitiveSizeInBits();   // 0 for ptr/vector
2116   unsigned DestBits = DestTy->getPrimitiveSizeInBits(); // 0 for ptr/vector
2117
2118   assert(SrcTy->isFirstClassType() && DestTy->isFirstClassType() &&
2119          "Only first class types are castable!");
2120
2121   // Run through the possibilities ...
2122   if (DestTy->isInteger()) {                       // Casting to integral
2123     if (SrcTy->isInteger()) {                      // Casting from integral
2124       if (DestBits < SrcBits)
2125         return Trunc;                               // int -> smaller int
2126       else if (DestBits > SrcBits) {                // its an extension
2127         if (SrcIsSigned)
2128           return SExt;                              // signed -> SEXT
2129         else
2130           return ZExt;                              // unsigned -> ZEXT
2131       } else {
2132         return BitCast;                             // Same size, No-op cast
2133       }
2134     } else if (SrcTy->isFloatingPoint()) {          // Casting from floating pt
2135       if (DestIsSigned)
2136         return FPToSI;                              // FP -> sint
2137       else
2138         return FPToUI;                              // FP -> uint
2139     } else if (const VectorType *PTy = dyn_cast<VectorType>(SrcTy)) {
2140       assert(DestBits == PTy->getBitWidth() &&
2141                "Casting vector to integer of different width");
2142       return BitCast;                             // Same size, no-op cast
2143     } else {
2144       assert(isa<PointerType>(SrcTy) &&
2145              "Casting from a value that is not first-class type");
2146       return PtrToInt;                              // ptr -> int
2147     }
2148   } else if (DestTy->isFloatingPoint()) {           // Casting to floating pt
2149     if (SrcTy->isInteger()) {                      // Casting from integral
2150       if (SrcIsSigned)
2151         return SIToFP;                              // sint -> FP
2152       else
2153         return UIToFP;                              // uint -> FP
2154     } else if (SrcTy->isFloatingPoint()) {          // Casting from floating pt
2155       if (DestBits < SrcBits) {
2156         return FPTrunc;                             // FP -> smaller FP
2157       } else if (DestBits > SrcBits) {
2158         return FPExt;                               // FP -> larger FP
2159       } else  {
2160         return BitCast;                             // same size, no-op cast
2161       }
2162     } else if (const VectorType *PTy = dyn_cast<VectorType>(SrcTy)) {
2163       assert(DestBits == PTy->getBitWidth() &&
2164              "Casting vector to floating point of different width");
2165         return BitCast;                             // same size, no-op cast
2166     } else {
2167       assert(0 && "Casting pointer or non-first class to float");
2168     }
2169   } else if (const VectorType *DestPTy = dyn_cast<VectorType>(DestTy)) {
2170     if (const VectorType *SrcPTy = dyn_cast<VectorType>(SrcTy)) {
2171       assert(DestPTy->getBitWidth() == SrcPTy->getBitWidth() &&
2172              "Casting vector to vector of different widths");
2173       return BitCast;                             // vector -> vector
2174     } else if (DestPTy->getBitWidth() == SrcBits) {
2175       return BitCast;                               // float/int -> vector
2176     } else {
2177       assert(!"Illegal cast to vector (wrong type or size)");
2178     }
2179   } else if (isa<PointerType>(DestTy)) {
2180     if (isa<PointerType>(SrcTy)) {
2181       return BitCast;                               // ptr -> ptr
2182     } else if (SrcTy->isInteger()) {
2183       return IntToPtr;                              // int -> ptr
2184     } else {
2185       assert(!"Casting pointer to other than pointer or int");
2186     }
2187   } else {
2188     assert(!"Casting to type that is not first-class");
2189   }
2190
2191   // If we fall through to here we probably hit an assertion cast above
2192   // and assertions are not turned on. Anything we return is an error, so
2193   // BitCast is as good a choice as any.
2194   return BitCast;
2195 }
2196
2197 //===----------------------------------------------------------------------===//
2198 //                    CastInst SubClass Constructors
2199 //===----------------------------------------------------------------------===//
2200
2201 /// Check that the construction parameters for a CastInst are correct. This
2202 /// could be broken out into the separate constructors but it is useful to have
2203 /// it in one place and to eliminate the redundant code for getting the sizes
2204 /// of the types involved.
2205 bool
2206 CastInst::castIsValid(Instruction::CastOps op, Value *S, const Type *DstTy) {
2207
2208   // Check for type sanity on the arguments
2209   const Type *SrcTy = S->getType();
2210   if (!SrcTy->isFirstClassType() || !DstTy->isFirstClassType())
2211     return false;
2212
2213   // Get the size of the types in bits, we'll need this later
2214   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
2215   unsigned DstBitSize = DstTy->getPrimitiveSizeInBits();
2216
2217   // Switch on the opcode provided
2218   switch (op) {
2219   default: return false; // This is an input error
2220   case Instruction::Trunc:
2221     return SrcTy->isInteger() && DstTy->isInteger()&& SrcBitSize > DstBitSize;
2222   case Instruction::ZExt:
2223     return SrcTy->isInteger() && DstTy->isInteger()&& SrcBitSize < DstBitSize;
2224   case Instruction::SExt:
2225     return SrcTy->isInteger() && DstTy->isInteger()&& SrcBitSize < DstBitSize;
2226   case Instruction::FPTrunc:
2227     return SrcTy->isFloatingPoint() && DstTy->isFloatingPoint() &&
2228       SrcBitSize > DstBitSize;
2229   case Instruction::FPExt:
2230     return SrcTy->isFloatingPoint() && DstTy->isFloatingPoint() &&
2231       SrcBitSize < DstBitSize;
2232   case Instruction::UIToFP:
2233   case Instruction::SIToFP:
2234     if (const VectorType *SVTy = dyn_cast<VectorType>(SrcTy)) {
2235       if (const VectorType *DVTy = dyn_cast<VectorType>(DstTy)) {
2236         return SVTy->getElementType()->isInteger() &&
2237                DVTy->getElementType()->isFloatingPoint() &&
2238                SVTy->getNumElements() == DVTy->getNumElements();
2239       }
2240     }
2241     return SrcTy->isInteger() && DstTy->isFloatingPoint();
2242   case Instruction::FPToUI:
2243   case Instruction::FPToSI:
2244     if (const VectorType *SVTy = dyn_cast<VectorType>(SrcTy)) {
2245       if (const VectorType *DVTy = dyn_cast<VectorType>(DstTy)) {
2246         return SVTy->getElementType()->isFloatingPoint() &&
2247                DVTy->getElementType()->isInteger() &&
2248                SVTy->getNumElements() == DVTy->getNumElements();
2249       }
2250     }
2251     return SrcTy->isFloatingPoint() && DstTy->isInteger();
2252   case Instruction::PtrToInt:
2253     return isa<PointerType>(SrcTy) && DstTy->isInteger();
2254   case Instruction::IntToPtr:
2255     return SrcTy->isInteger() && isa<PointerType>(DstTy);
2256   case Instruction::BitCast:
2257     // BitCast implies a no-op cast of type only. No bits change.
2258     // However, you can't cast pointers to anything but pointers.
2259     if (isa<PointerType>(SrcTy) != isa<PointerType>(DstTy))
2260       return false;
2261
2262     // Now we know we're not dealing with a pointer/non-pointer mismatch. In all
2263     // these cases, the cast is okay if the source and destination bit widths
2264     // are identical.
2265     return SrcBitSize == DstBitSize;
2266   }
2267 }
2268
2269 TruncInst::TruncInst(
2270   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2271 ) : CastInst(Ty, Trunc, S, Name, InsertBefore) {
2272   assert(castIsValid(getOpcode(), S, Ty) && "Illegal Trunc");
2273 }
2274
2275 TruncInst::TruncInst(
2276   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2277 ) : CastInst(Ty, Trunc, S, Name, InsertAtEnd) {
2278   assert(castIsValid(getOpcode(), S, Ty) && "Illegal Trunc");
2279 }
2280
2281 ZExtInst::ZExtInst(
2282   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2283 )  : CastInst(Ty, ZExt, S, Name, InsertBefore) {
2284   assert(castIsValid(getOpcode(), S, Ty) && "Illegal ZExt");
2285 }
2286
2287 ZExtInst::ZExtInst(
2288   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2289 )  : CastInst(Ty, ZExt, S, Name, InsertAtEnd) {
2290   assert(castIsValid(getOpcode(), S, Ty) && "Illegal ZExt");
2291 }
2292 SExtInst::SExtInst(
2293   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2294 ) : CastInst(Ty, SExt, S, Name, InsertBefore) {
2295   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SExt");
2296 }
2297
2298 SExtInst::SExtInst(
2299   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2300 )  : CastInst(Ty, SExt, S, Name, InsertAtEnd) {
2301   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SExt");
2302 }
2303
2304 FPTruncInst::FPTruncInst(
2305   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2306 ) : CastInst(Ty, FPTrunc, S, Name, InsertBefore) {
2307   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPTrunc");
2308 }
2309
2310 FPTruncInst::FPTruncInst(
2311   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2312 ) : CastInst(Ty, FPTrunc, S, Name, InsertAtEnd) {
2313   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPTrunc");
2314 }
2315
2316 FPExtInst::FPExtInst(
2317   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2318 ) : CastInst(Ty, FPExt, S, Name, InsertBefore) {
2319   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPExt");
2320 }
2321
2322 FPExtInst::FPExtInst(
2323   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2324 ) : CastInst(Ty, FPExt, S, Name, InsertAtEnd) {
2325   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPExt");
2326 }
2327
2328 UIToFPInst::UIToFPInst(
2329   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2330 ) : CastInst(Ty, UIToFP, S, Name, InsertBefore) {
2331   assert(castIsValid(getOpcode(), S, Ty) && "Illegal UIToFP");
2332 }
2333
2334 UIToFPInst::UIToFPInst(
2335   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2336 ) : CastInst(Ty, UIToFP, S, Name, InsertAtEnd) {
2337   assert(castIsValid(getOpcode(), S, Ty) && "Illegal UIToFP");
2338 }
2339
2340 SIToFPInst::SIToFPInst(
2341   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2342 ) : CastInst(Ty, SIToFP, S, Name, InsertBefore) {
2343   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SIToFP");
2344 }
2345
2346 SIToFPInst::SIToFPInst(
2347   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2348 ) : CastInst(Ty, SIToFP, S, Name, InsertAtEnd) {
2349   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SIToFP");
2350 }
2351
2352 FPToUIInst::FPToUIInst(
2353   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2354 ) : CastInst(Ty, FPToUI, S, Name, InsertBefore) {
2355   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToUI");
2356 }
2357
2358 FPToUIInst::FPToUIInst(
2359   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2360 ) : CastInst(Ty, FPToUI, S, Name, InsertAtEnd) {
2361   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToUI");
2362 }
2363
2364 FPToSIInst::FPToSIInst(
2365   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2366 ) : CastInst(Ty, FPToSI, S, Name, InsertBefore) {
2367   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToSI");
2368 }
2369
2370 FPToSIInst::FPToSIInst(
2371   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2372 ) : CastInst(Ty, FPToSI, S, Name, InsertAtEnd) {
2373   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToSI");
2374 }
2375
2376 PtrToIntInst::PtrToIntInst(
2377   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2378 ) : CastInst(Ty, PtrToInt, S, Name, InsertBefore) {
2379   assert(castIsValid(getOpcode(), S, Ty) && "Illegal PtrToInt");
2380 }
2381
2382 PtrToIntInst::PtrToIntInst(
2383   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2384 ) : CastInst(Ty, PtrToInt, S, Name, InsertAtEnd) {
2385   assert(castIsValid(getOpcode(), S, Ty) && "Illegal PtrToInt");
2386 }
2387
2388 IntToPtrInst::IntToPtrInst(
2389   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2390 ) : CastInst(Ty, IntToPtr, S, Name, InsertBefore) {
2391   assert(castIsValid(getOpcode(), S, Ty) && "Illegal IntToPtr");
2392 }
2393
2394 IntToPtrInst::IntToPtrInst(
2395   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2396 ) : CastInst(Ty, IntToPtr, S, Name, InsertAtEnd) {
2397   assert(castIsValid(getOpcode(), S, Ty) && "Illegal IntToPtr");
2398 }
2399
2400 BitCastInst::BitCastInst(
2401   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2402 ) : CastInst(Ty, BitCast, S, Name, InsertBefore) {
2403   assert(castIsValid(getOpcode(), S, Ty) && "Illegal BitCast");
2404 }
2405
2406 BitCastInst::BitCastInst(
2407   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2408 ) : CastInst(Ty, BitCast, S, Name, InsertAtEnd) {
2409   assert(castIsValid(getOpcode(), S, Ty) && "Illegal BitCast");
2410 }
2411
2412 //===----------------------------------------------------------------------===//
2413 //                               CmpInst Classes
2414 //===----------------------------------------------------------------------===//
2415
2416 CmpInst::CmpInst(const Type *ty, OtherOps op, unsigned short predicate,
2417                  Value *LHS, Value *RHS, const std::string &Name,
2418                  Instruction *InsertBefore)
2419   : Instruction(ty, op,
2420                 OperandTraits<CmpInst>::op_begin(this),
2421                 OperandTraits<CmpInst>::operands(this),
2422                 InsertBefore) {
2423     Op<0>() = LHS;
2424     Op<1>() = RHS;
2425   SubclassData = predicate;
2426   setName(Name);
2427 }
2428
2429 CmpInst::CmpInst(const Type *ty, OtherOps op, unsigned short predicate,
2430                  Value *LHS, Value *RHS, const std::string &Name,
2431                  BasicBlock *InsertAtEnd)
2432   : Instruction(ty, op,
2433                 OperandTraits<CmpInst>::op_begin(this),
2434                 OperandTraits<CmpInst>::operands(this),
2435                 InsertAtEnd) {
2436   Op<0>() = LHS;
2437   Op<1>() = RHS;
2438   SubclassData = predicate;
2439   setName(Name);
2440 }
2441
2442 CmpInst *
2443 CmpInst::Create(OtherOps Op, unsigned short predicate, Value *S1, Value *S2,
2444                 const std::string &Name, Instruction *InsertBefore) {
2445   if (Op == Instruction::ICmp) {
2446     return new ICmpInst(CmpInst::Predicate(predicate), S1, S2, Name,
2447                         InsertBefore);
2448   }
2449   if (Op == Instruction::FCmp) {
2450     return new FCmpInst(CmpInst::Predicate(predicate), S1, S2, Name,
2451                         InsertBefore);
2452   }
2453   if (Op == Instruction::VICmp) {
2454     return new VICmpInst(CmpInst::Predicate(predicate), S1, S2, Name,
2455                          InsertBefore);
2456   }
2457   return new VFCmpInst(CmpInst::Predicate(predicate), S1, S2, Name,
2458                        InsertBefore);
2459 }
2460
2461 CmpInst *
2462 CmpInst::Create(OtherOps Op, unsigned short predicate, Value *S1, Value *S2,
2463                 const std::string &Name, BasicBlock *InsertAtEnd) {
2464   if (Op == Instruction::ICmp) {
2465     return new ICmpInst(CmpInst::Predicate(predicate), S1, S2, Name,
2466                         InsertAtEnd);
2467   }
2468   if (Op == Instruction::FCmp) {
2469     return new FCmpInst(CmpInst::Predicate(predicate), S1, S2, Name,
2470                         InsertAtEnd);
2471   }
2472   if (Op == Instruction::VICmp) {
2473     return new VICmpInst(CmpInst::Predicate(predicate), S1, S2, Name,
2474                          InsertAtEnd);
2475   }
2476   return new VFCmpInst(CmpInst::Predicate(predicate), S1, S2, Name,
2477                        InsertAtEnd);
2478 }
2479
2480 void CmpInst::swapOperands() {
2481   if (ICmpInst *IC = dyn_cast<ICmpInst>(this))
2482     IC->swapOperands();
2483   else
2484     cast<FCmpInst>(this)->swapOperands();
2485 }
2486
2487 bool CmpInst::isCommutative() {
2488   if (ICmpInst *IC = dyn_cast<ICmpInst>(this))
2489     return IC->isCommutative();
2490   return cast<FCmpInst>(this)->isCommutative();
2491 }
2492
2493 bool CmpInst::isEquality() {
2494   if (ICmpInst *IC = dyn_cast<ICmpInst>(this))
2495     return IC->isEquality();
2496   return cast<FCmpInst>(this)->isEquality();
2497 }
2498
2499
2500 CmpInst::Predicate CmpInst::getInversePredicate(Predicate pred) {
2501   switch (pred) {
2502     default: assert(!"Unknown cmp predicate!");
2503     case ICMP_EQ: return ICMP_NE;
2504     case ICMP_NE: return ICMP_EQ;
2505     case ICMP_UGT: return ICMP_ULE;
2506     case ICMP_ULT: return ICMP_UGE;
2507     case ICMP_UGE: return ICMP_ULT;
2508     case ICMP_ULE: return ICMP_UGT;
2509     case ICMP_SGT: return ICMP_SLE;
2510     case ICMP_SLT: return ICMP_SGE;
2511     case ICMP_SGE: return ICMP_SLT;
2512     case ICMP_SLE: return ICMP_SGT;
2513
2514     case FCMP_OEQ: return FCMP_UNE;
2515     case FCMP_ONE: return FCMP_UEQ;
2516     case FCMP_OGT: return FCMP_ULE;
2517     case FCMP_OLT: return FCMP_UGE;
2518     case FCMP_OGE: return FCMP_ULT;
2519     case FCMP_OLE: return FCMP_UGT;
2520     case FCMP_UEQ: return FCMP_ONE;
2521     case FCMP_UNE: return FCMP_OEQ;
2522     case FCMP_UGT: return FCMP_OLE;
2523     case FCMP_ULT: return FCMP_OGE;
2524     case FCMP_UGE: return FCMP_OLT;
2525     case FCMP_ULE: return FCMP_OGT;
2526     case FCMP_ORD: return FCMP_UNO;
2527     case FCMP_UNO: return FCMP_ORD;
2528     case FCMP_TRUE: return FCMP_FALSE;
2529     case FCMP_FALSE: return FCMP_TRUE;
2530   }
2531 }
2532
2533 ICmpInst::Predicate ICmpInst::getSignedPredicate(Predicate pred) {
2534   switch (pred) {
2535     default: assert(! "Unknown icmp predicate!");
2536     case ICMP_EQ: case ICMP_NE:
2537     case ICMP_SGT: case ICMP_SLT: case ICMP_SGE: case ICMP_SLE:
2538        return pred;
2539     case ICMP_UGT: return ICMP_SGT;
2540     case ICMP_ULT: return ICMP_SLT;
2541     case ICMP_UGE: return ICMP_SGE;
2542     case ICMP_ULE: return ICMP_SLE;
2543   }
2544 }
2545
2546 ICmpInst::Predicate ICmpInst::getUnsignedPredicate(Predicate pred) {
2547   switch (pred) {
2548     default: assert(! "Unknown icmp predicate!");
2549     case ICMP_EQ: case ICMP_NE:
2550     case ICMP_UGT: case ICMP_ULT: case ICMP_UGE: case ICMP_ULE:
2551        return pred;
2552     case ICMP_SGT: return ICMP_UGT;
2553     case ICMP_SLT: return ICMP_ULT;
2554     case ICMP_SGE: return ICMP_UGE;
2555     case ICMP_SLE: return ICMP_ULE;
2556   }
2557 }
2558
2559 bool ICmpInst::isSignedPredicate(Predicate pred) {
2560   switch (pred) {
2561     default: assert(! "Unknown icmp predicate!");
2562     case ICMP_SGT: case ICMP_SLT: case ICMP_SGE: case ICMP_SLE:
2563       return true;
2564     case ICMP_EQ:  case ICMP_NE: case ICMP_UGT: case ICMP_ULT:
2565     case ICMP_UGE: case ICMP_ULE:
2566       return false;
2567   }
2568 }
2569
2570 /// Initialize a set of values that all satisfy the condition with C.
2571 ///
2572 ConstantRange
2573 ICmpInst::makeConstantRange(Predicate pred, const APInt &C) {
2574   APInt Lower(C);
2575   APInt Upper(C);
2576   uint32_t BitWidth = C.getBitWidth();
2577   switch (pred) {
2578   default: assert(0 && "Invalid ICmp opcode to ConstantRange ctor!");
2579   case ICmpInst::ICMP_EQ: Upper++; break;
2580   case ICmpInst::ICMP_NE: Lower++; break;
2581   case ICmpInst::ICMP_ULT: Lower = APInt::getMinValue(BitWidth); break;
2582   case ICmpInst::ICMP_SLT: Lower = APInt::getSignedMinValue(BitWidth); break;
2583   case ICmpInst::ICMP_UGT:
2584     Lower++; Upper = APInt::getMinValue(BitWidth);        // Min = Next(Max)
2585     break;
2586   case ICmpInst::ICMP_SGT:
2587     Lower++; Upper = APInt::getSignedMinValue(BitWidth);  // Min = Next(Max)
2588     break;
2589   case ICmpInst::ICMP_ULE:
2590     Lower = APInt::getMinValue(BitWidth); Upper++;
2591     break;
2592   case ICmpInst::ICMP_SLE:
2593     Lower = APInt::getSignedMinValue(BitWidth); Upper++;
2594     break;
2595   case ICmpInst::ICMP_UGE:
2596     Upper = APInt::getMinValue(BitWidth);        // Min = Next(Max)
2597     break;
2598   case ICmpInst::ICMP_SGE:
2599     Upper = APInt::getSignedMinValue(BitWidth);  // Min = Next(Max)
2600     break;
2601   }
2602   return ConstantRange(Lower, Upper);
2603 }
2604
2605 CmpInst::Predicate CmpInst::getSwappedPredicate(Predicate pred) {
2606   switch (pred) {
2607     default: assert(!"Unknown cmp predicate!");
2608     case ICMP_EQ: case ICMP_NE:
2609       return pred;
2610     case ICMP_SGT: return ICMP_SLT;
2611     case ICMP_SLT: return ICMP_SGT;
2612     case ICMP_SGE: return ICMP_SLE;
2613     case ICMP_SLE: return ICMP_SGE;
2614     case ICMP_UGT: return ICMP_ULT;
2615     case ICMP_ULT: return ICMP_UGT;
2616     case ICMP_UGE: return ICMP_ULE;
2617     case ICMP_ULE: return ICMP_UGE;
2618
2619     case FCMP_FALSE: case FCMP_TRUE:
2620     case FCMP_OEQ: case FCMP_ONE:
2621     case FCMP_UEQ: case FCMP_UNE:
2622     case FCMP_ORD: case FCMP_UNO:
2623       return pred;
2624     case FCMP_OGT: return FCMP_OLT;
2625     case FCMP_OLT: return FCMP_OGT;
2626     case FCMP_OGE: return FCMP_OLE;
2627     case FCMP_OLE: return FCMP_OGE;
2628     case FCMP_UGT: return FCMP_ULT;
2629     case FCMP_ULT: return FCMP_UGT;
2630     case FCMP_UGE: return FCMP_ULE;
2631     case FCMP_ULE: return FCMP_UGE;
2632   }
2633 }
2634
2635 bool CmpInst::isUnsigned(unsigned short predicate) {
2636   switch (predicate) {
2637     default: return false;
2638     case ICmpInst::ICMP_ULT: case ICmpInst::ICMP_ULE: case ICmpInst::ICMP_UGT:
2639     case ICmpInst::ICMP_UGE: return true;
2640   }
2641 }
2642
2643 bool CmpInst::isSigned(unsigned short predicate){
2644   switch (predicate) {
2645     default: return false;
2646     case ICmpInst::ICMP_SLT: case ICmpInst::ICMP_SLE: case ICmpInst::ICMP_SGT:
2647     case ICmpInst::ICMP_SGE: return true;
2648   }
2649 }
2650
2651 bool CmpInst::isOrdered(unsigned short predicate) {
2652   switch (predicate) {
2653     default: return false;
2654     case FCmpInst::FCMP_OEQ: case FCmpInst::FCMP_ONE: case FCmpInst::FCMP_OGT:
2655     case FCmpInst::FCMP_OLT: case FCmpInst::FCMP_OGE: case FCmpInst::FCMP_OLE:
2656     case FCmpInst::FCMP_ORD: return true;
2657   }
2658 }
2659
2660 bool CmpInst::isUnordered(unsigned short predicate) {
2661   switch (predicate) {
2662     default: return false;
2663     case FCmpInst::FCMP_UEQ: case FCmpInst::FCMP_UNE: case FCmpInst::FCMP_UGT:
2664     case FCmpInst::FCMP_ULT: case FCmpInst::FCMP_UGE: case FCmpInst::FCMP_ULE:
2665     case FCmpInst::FCMP_UNO: return true;
2666   }
2667 }
2668
2669 //===----------------------------------------------------------------------===//
2670 //                        SwitchInst Implementation
2671 //===----------------------------------------------------------------------===//
2672
2673 void SwitchInst::init(Value *Value, BasicBlock *Default, unsigned NumCases) {
2674   assert(Value && Default);
2675   ReservedSpace = 2+NumCases*2;
2676   NumOperands = 2;
2677   OperandList = allocHungoffUses(ReservedSpace);
2678
2679   OperandList[0] = Value;
2680   OperandList[1] = Default;
2681 }
2682
2683 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2684 /// switch on and a default destination.  The number of additional cases can
2685 /// be specified here to make memory allocation more efficient.  This
2686 /// constructor can also autoinsert before another instruction.
2687 SwitchInst::SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2688                        Instruction *InsertBefore)
2689   : TerminatorInst(Type::VoidTy, Instruction::Switch, 0, 0, InsertBefore) {
2690   init(Value, Default, NumCases);
2691 }
2692
2693 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2694 /// switch on and a default destination.  The number of additional cases can
2695 /// be specified here to make memory allocation more efficient.  This
2696 /// constructor also autoinserts at the end of the specified BasicBlock.
2697 SwitchInst::SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2698                        BasicBlock *InsertAtEnd)
2699   : TerminatorInst(Type::VoidTy, Instruction::Switch, 0, 0, InsertAtEnd) {
2700   init(Value, Default, NumCases);
2701 }
2702
2703 SwitchInst::SwitchInst(const SwitchInst &SI)
2704   : TerminatorInst(Type::VoidTy, Instruction::Switch,
2705                    allocHungoffUses(SI.getNumOperands()), SI.getNumOperands()) {
2706   Use *OL = OperandList, *InOL = SI.OperandList;
2707   for (unsigned i = 0, E = SI.getNumOperands(); i != E; i+=2) {
2708     OL[i] = InOL[i];
2709     OL[i+1] = InOL[i+1];
2710   }
2711 }
2712
2713 SwitchInst::~SwitchInst() {
2714   dropHungoffUses(OperandList);
2715 }
2716
2717
2718 /// addCase - Add an entry to the switch instruction...
2719 ///
2720 void SwitchInst::addCase(ConstantInt *OnVal, BasicBlock *Dest) {
2721   unsigned OpNo = NumOperands;
2722   if (OpNo+2 > ReservedSpace)
2723     resizeOperands(0);  // Get more space!
2724   // Initialize some new operands.
2725   assert(OpNo+1 < ReservedSpace && "Growing didn't work!");
2726   NumOperands = OpNo+2;
2727   OperandList[OpNo] = OnVal;
2728   OperandList[OpNo+1] = Dest;
2729 }
2730
2731 /// removeCase - This method removes the specified successor from the switch
2732 /// instruction.  Note that this cannot be used to remove the default
2733 /// destination (successor #0).
2734 ///
2735 void SwitchInst::removeCase(unsigned idx) {
2736   assert(idx != 0 && "Cannot remove the default case!");
2737   assert(idx*2 < getNumOperands() && "Successor index out of range!!!");
2738
2739   unsigned NumOps = getNumOperands();
2740   Use *OL = OperandList;
2741
2742   // Move everything after this operand down.
2743   //
2744   // FIXME: we could just swap with the end of the list, then erase.  However,
2745   // client might not expect this to happen.  The code as it is thrashes the
2746   // use/def lists, which is kinda lame.
2747   for (unsigned i = (idx+1)*2; i != NumOps; i += 2) {
2748     OL[i-2] = OL[i];
2749     OL[i-2+1] = OL[i+1];
2750   }
2751
2752   // Nuke the last value.
2753   OL[NumOps-2].set(0);
2754   OL[NumOps-2+1].set(0);
2755   NumOperands = NumOps-2;
2756 }
2757
2758 /// resizeOperands - resize operands - This adjusts the length of the operands
2759 /// list according to the following behavior:
2760 ///   1. If NumOps == 0, grow the operand list in response to a push_back style
2761 ///      of operation.  This grows the number of ops by 3 times.
2762 ///   2. If NumOps > NumOperands, reserve space for NumOps operands.
2763 ///   3. If NumOps == NumOperands, trim the reserved space.
2764 ///
2765 void SwitchInst::resizeOperands(unsigned NumOps) {
2766   unsigned e = getNumOperands();
2767   if (NumOps == 0) {
2768     NumOps = e*3;
2769   } else if (NumOps*2 > NumOperands) {
2770     // No resize needed.
2771     if (ReservedSpace >= NumOps) return;
2772   } else if (NumOps == NumOperands) {
2773     if (ReservedSpace == NumOps) return;
2774   } else {
2775     return;
2776   }
2777
2778   ReservedSpace = NumOps;
2779   Use *NewOps = allocHungoffUses(NumOps);
2780   Use *OldOps = OperandList;
2781   for (unsigned i = 0; i != e; ++i) {
2782       NewOps[i] = OldOps[i];
2783   }
2784   OperandList = NewOps;
2785   if (OldOps) Use::zap(OldOps, OldOps + e, true);
2786 }
2787
2788
2789 BasicBlock *SwitchInst::getSuccessorV(unsigned idx) const {
2790   return getSuccessor(idx);
2791 }
2792 unsigned SwitchInst::getNumSuccessorsV() const {
2793   return getNumSuccessors();
2794 }
2795 void SwitchInst::setSuccessorV(unsigned idx, BasicBlock *B) {
2796   setSuccessor(idx, B);
2797 }
2798
2799 //===----------------------------------------------------------------------===//
2800 //                           GetResultInst Implementation
2801 //===----------------------------------------------------------------------===//
2802
2803 GetResultInst::GetResultInst(Value *Aggregate, unsigned Index,
2804                              const std::string &Name,
2805                              Instruction *InsertBef)
2806   : UnaryInstruction(cast<StructType>(Aggregate->getType())
2807                        ->getElementType(Index),
2808                      GetResult, Aggregate, InsertBef),
2809     Idx(Index) {
2810   assert(isValidOperands(Aggregate, Index)
2811          && "Invalid GetResultInst operands!");
2812   setName(Name);
2813 }
2814
2815 bool GetResultInst::isValidOperands(const Value *Aggregate, unsigned Index) {
2816   if (!Aggregate)
2817     return false;
2818
2819   if (const StructType *STy = dyn_cast<StructType>(Aggregate->getType())) {
2820     unsigned NumElements = STy->getNumElements();
2821     if (Index >= NumElements || NumElements == 0)
2822       return false;
2823
2824     // getresult aggregate value's element types are restricted to
2825     // avoid nested aggregates.
2826     for (unsigned i = 0; i < NumElements; ++i)
2827       if (!STy->getElementType(i)->isFirstClassType())
2828         return false;
2829
2830     // Otherwise, Aggregate is valid.
2831     return true;
2832   }
2833   return false;
2834 }
2835
2836 // Define these methods here so vtables don't get emitted into every translation
2837 // unit that uses these classes.
2838
2839 GetElementPtrInst *GetElementPtrInst::clone() const {
2840   return new(getNumOperands()) GetElementPtrInst(*this);
2841 }
2842
2843 BinaryOperator *BinaryOperator::clone() const {
2844   return Create(getOpcode(), Op<0>(), Op<1>());
2845 }
2846
2847 FCmpInst* FCmpInst::clone() const {
2848   return new FCmpInst(getPredicate(), Op<0>(), Op<1>());
2849 }
2850 ICmpInst* ICmpInst::clone() const {
2851   return new ICmpInst(getPredicate(), Op<0>(), Op<1>());
2852 }
2853
2854 VFCmpInst* VFCmpInst::clone() const {
2855   return new VFCmpInst(getPredicate(), Op<0>(), Op<1>());
2856 }
2857 VICmpInst* VICmpInst::clone() const {
2858   return new VICmpInst(getPredicate(), Op<0>(), Op<1>());
2859 }
2860
2861 ExtractValueInst *ExtractValueInst::clone() const {
2862   return new ExtractValueInst(*this);
2863 }
2864 InsertValueInst *InsertValueInst::clone() const {
2865   return new InsertValueInst(*this);
2866 }
2867
2868
2869 MallocInst *MallocInst::clone()   const { return new MallocInst(*this); }
2870 AllocaInst *AllocaInst::clone()   const { return new AllocaInst(*this); }
2871 FreeInst   *FreeInst::clone()     const { return new FreeInst(getOperand(0)); }
2872 LoadInst   *LoadInst::clone()     const { return new LoadInst(*this); }
2873 StoreInst  *StoreInst::clone()    const { return new StoreInst(*this); }
2874 CastInst   *TruncInst::clone()    const { return new TruncInst(*this); }
2875 CastInst   *ZExtInst::clone()     const { return new ZExtInst(*this); }
2876 CastInst   *SExtInst::clone()     const { return new SExtInst(*this); }
2877 CastInst   *FPTruncInst::clone()  const { return new FPTruncInst(*this); }
2878 CastInst   *FPExtInst::clone()    const { return new FPExtInst(*this); }
2879 CastInst   *UIToFPInst::clone()   const { return new UIToFPInst(*this); }
2880 CastInst   *SIToFPInst::clone()   const { return new SIToFPInst(*this); }
2881 CastInst   *FPToUIInst::clone()   const { return new FPToUIInst(*this); }
2882 CastInst   *FPToSIInst::clone()   const { return new FPToSIInst(*this); }
2883 CastInst   *PtrToIntInst::clone() const { return new PtrToIntInst(*this); }
2884 CastInst   *IntToPtrInst::clone() const { return new IntToPtrInst(*this); }
2885 CastInst   *BitCastInst::clone()  const { return new BitCastInst(*this); }
2886 CallInst   *CallInst::clone()     const {
2887   return new(getNumOperands()) CallInst(*this);
2888 }
2889 SelectInst *SelectInst::clone()   const {
2890   return new(getNumOperands()) SelectInst(*this);
2891 }
2892 VAArgInst  *VAArgInst::clone()    const { return new VAArgInst(*this); }
2893
2894 ExtractElementInst *ExtractElementInst::clone() const {
2895   return new ExtractElementInst(*this);
2896 }
2897 InsertElementInst *InsertElementInst::clone() const {
2898   return InsertElementInst::Create(*this);
2899 }
2900 ShuffleVectorInst *ShuffleVectorInst::clone() const {
2901   return new ShuffleVectorInst(*this);
2902 }
2903 PHINode    *PHINode::clone()    const { return new PHINode(*this); }
2904 ReturnInst *ReturnInst::clone() const {
2905   return new(getNumOperands()) ReturnInst(*this);
2906 }
2907 BranchInst *BranchInst::clone() const {
2908   return new(getNumOperands()) BranchInst(*this);
2909 }
2910 SwitchInst *SwitchInst::clone() const { return new SwitchInst(*this); }
2911 InvokeInst *InvokeInst::clone() const {
2912   return new(getNumOperands()) InvokeInst(*this);
2913 }
2914 UnwindInst *UnwindInst::clone() const { return new UnwindInst(); }
2915 UnreachableInst *UnreachableInst::clone() const { return new UnreachableInst();}
2916 GetResultInst *GetResultInst::clone() const { return new GetResultInst(*this); }