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