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