8ce40a95b1e94d5028c6abf2f8e0923943cf8a31
[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(Value *Amt) {
704   if (!Amt)
705     Amt = ConstantInt::get(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(const Type *Ty, Value *ArraySize, unsigned iTy,
716                                unsigned Align, const std::string &Name,
717                                Instruction *InsertBefore)
718   : UnaryInstruction(PointerType::getUnqual(Ty), iTy, getAISize(ArraySize),
719                      InsertBefore) {
720   setAlignment(Align);
721   assert(Ty != Type::VoidTy && "Cannot allocate void!");
722   setName(Name);
723 }
724
725 AllocationInst::AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy,
726                                unsigned Align, const std::string &Name,
727                                BasicBlock *InsertAtEnd)
728   : UnaryInstruction(PointerType::getUnqual(Ty), iTy, getAISize(ArraySize),
729                      InsertAtEnd) {
730   setAlignment(Align);
731   assert(Ty != Type::VoidTy && "Cannot allocate void!");
732   setName(Name);
733 }
734
735 // Out of line virtual method, so the vtable, etc has a home.
736 AllocationInst::~AllocationInst() {
737 }
738
739 void AllocationInst::setAlignment(unsigned Align) {
740   assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
741   SubclassData = Log2_32(Align) + 1;
742   assert(getAlignment() == Align && "Alignment representation error!");
743 }
744
745 bool AllocationInst::isArrayAllocation() const {
746   if (ConstantInt *CI = dyn_cast<ConstantInt>(getOperand(0)))
747     return CI->getZExtValue() != 1;
748   return true;
749 }
750
751 const Type *AllocationInst::getAllocatedType() const {
752   return getType()->getElementType();
753 }
754
755 AllocaInst::AllocaInst(const AllocaInst &AI)
756   : AllocationInst(AI.getType()->getElementType(), (Value*)AI.getOperand(0),
757                    Instruction::Alloca, AI.getAlignment()) {
758 }
759
760 /// isStaticAlloca - Return true if this alloca is in the entry block of the
761 /// function and is a constant size.  If so, the code generator will fold it
762 /// into the prolog/epilog code, so it is basically free.
763 bool AllocaInst::isStaticAlloca() const {
764   // Must be constant size.
765   if (!isa<ConstantInt>(getArraySize())) return false;
766   
767   // Must be in the entry block.
768   const BasicBlock *Parent = getParent();
769   return Parent == &Parent->getParent()->front();
770 }
771
772 MallocInst::MallocInst(const MallocInst &MI)
773   : AllocationInst(MI.getType()->getElementType(), (Value*)MI.getOperand(0),
774                    Instruction::Malloc, MI.getAlignment()) {
775 }
776
777 //===----------------------------------------------------------------------===//
778 //                             FreeInst Implementation
779 //===----------------------------------------------------------------------===//
780
781 void FreeInst::AssertOK() {
782   assert(isa<PointerType>(getOperand(0)->getType()) &&
783          "Can not free something of nonpointer type!");
784 }
785
786 FreeInst::FreeInst(Value *Ptr, Instruction *InsertBefore)
787   : UnaryInstruction(Type::VoidTy, Free, Ptr, InsertBefore) {
788   AssertOK();
789 }
790
791 FreeInst::FreeInst(Value *Ptr, BasicBlock *InsertAtEnd)
792   : UnaryInstruction(Type::VoidTy, Free, Ptr, InsertAtEnd) {
793   AssertOK();
794 }
795
796
797 //===----------------------------------------------------------------------===//
798 //                           LoadInst Implementation
799 //===----------------------------------------------------------------------===//
800
801 void LoadInst::AssertOK() {
802   assert(isa<PointerType>(getOperand(0)->getType()) &&
803          "Ptr must have pointer type.");
804 }
805
806 LoadInst::LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBef)
807   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
808                      Load, Ptr, InsertBef) {
809   setVolatile(false);
810   setAlignment(0);
811   AssertOK();
812   setName(Name);
813 }
814
815 LoadInst::LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAE)
816   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
817                      Load, Ptr, InsertAE) {
818   setVolatile(false);
819   setAlignment(0);
820   AssertOK();
821   setName(Name);
822 }
823
824 LoadInst::LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
825                    Instruction *InsertBef)
826   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
827                      Load, Ptr, InsertBef) {
828   setVolatile(isVolatile);
829   setAlignment(0);
830   AssertOK();
831   setName(Name);
832 }
833
834 LoadInst::LoadInst(Value *Ptr, const std::string &Name, bool isVolatile, 
835                    unsigned Align, Instruction *InsertBef)
836   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
837                      Load, Ptr, InsertBef) {
838   setVolatile(isVolatile);
839   setAlignment(Align);
840   AssertOK();
841   setName(Name);
842 }
843
844 LoadInst::LoadInst(Value *Ptr, const std::string &Name, bool isVolatile, 
845                    unsigned Align, BasicBlock *InsertAE)
846   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
847                      Load, Ptr, InsertAE) {
848   setVolatile(isVolatile);
849   setAlignment(Align);
850   AssertOK();
851   setName(Name);
852 }
853
854 LoadInst::LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
855                    BasicBlock *InsertAE)
856   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
857                      Load, Ptr, InsertAE) {
858   setVolatile(isVolatile);
859   setAlignment(0);
860   AssertOK();
861   setName(Name);
862 }
863
864
865
866 LoadInst::LoadInst(Value *Ptr, const char *Name, Instruction *InsertBef)
867   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
868                      Load, Ptr, InsertBef) {
869   setVolatile(false);
870   setAlignment(0);
871   AssertOK();
872   if (Name && Name[0]) setName(Name);
873 }
874
875 LoadInst::LoadInst(Value *Ptr, const char *Name, BasicBlock *InsertAE)
876   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
877                      Load, Ptr, InsertAE) {
878   setVolatile(false);
879   setAlignment(0);
880   AssertOK();
881   if (Name && Name[0]) setName(Name);
882 }
883
884 LoadInst::LoadInst(Value *Ptr, const char *Name, bool isVolatile,
885                    Instruction *InsertBef)
886 : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
887                    Load, Ptr, InsertBef) {
888   setVolatile(isVolatile);
889   setAlignment(0);
890   AssertOK();
891   if (Name && Name[0]) setName(Name);
892 }
893
894 LoadInst::LoadInst(Value *Ptr, const char *Name, bool isVolatile,
895                    BasicBlock *InsertAE)
896   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
897                      Load, Ptr, InsertAE) {
898   setVolatile(isVolatile);
899   setAlignment(0);
900   AssertOK();
901   if (Name && Name[0]) setName(Name);
902 }
903
904 void LoadInst::setAlignment(unsigned Align) {
905   assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
906   SubclassData = (SubclassData & 1) | ((Log2_32(Align)+1)<<1);
907 }
908
909 //===----------------------------------------------------------------------===//
910 //                           StoreInst Implementation
911 //===----------------------------------------------------------------------===//
912
913 void StoreInst::AssertOK() {
914   assert(getOperand(0) && getOperand(1) && "Both operands must be non-null!");
915   assert(isa<PointerType>(getOperand(1)->getType()) &&
916          "Ptr must have pointer type!");
917   assert(getOperand(0)->getType() ==
918                  cast<PointerType>(getOperand(1)->getType())->getElementType()
919          && "Ptr must be a pointer to Val type!");
920 }
921
922
923 StoreInst::StoreInst(Value *val, Value *addr, Instruction *InsertBefore)
924   : Instruction(Type::VoidTy, Store,
925                 OperandTraits<StoreInst>::op_begin(this),
926                 OperandTraits<StoreInst>::operands(this),
927                 InsertBefore) {
928   Op<0>() = val;
929   Op<1>() = addr;
930   setVolatile(false);
931   setAlignment(0);
932   AssertOK();
933 }
934
935 StoreInst::StoreInst(Value *val, Value *addr, BasicBlock *InsertAtEnd)
936   : Instruction(Type::VoidTy, Store,
937                 OperandTraits<StoreInst>::op_begin(this),
938                 OperandTraits<StoreInst>::operands(this),
939                 InsertAtEnd) {
940   Op<0>() = val;
941   Op<1>() = addr;
942   setVolatile(false);
943   setAlignment(0);
944   AssertOK();
945 }
946
947 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
948                      Instruction *InsertBefore)
949   : Instruction(Type::VoidTy, Store,
950                 OperandTraits<StoreInst>::op_begin(this),
951                 OperandTraits<StoreInst>::operands(this),
952                 InsertBefore) {
953   Op<0>() = val;
954   Op<1>() = addr;
955   setVolatile(isVolatile);
956   setAlignment(0);
957   AssertOK();
958 }
959
960 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
961                      unsigned Align, Instruction *InsertBefore)
962   : Instruction(Type::VoidTy, Store,
963                 OperandTraits<StoreInst>::op_begin(this),
964                 OperandTraits<StoreInst>::operands(this),
965                 InsertBefore) {
966   Op<0>() = val;
967   Op<1>() = addr;
968   setVolatile(isVolatile);
969   setAlignment(Align);
970   AssertOK();
971 }
972
973 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
974                      unsigned Align, BasicBlock *InsertAtEnd)
975   : Instruction(Type::VoidTy, Store,
976                 OperandTraits<StoreInst>::op_begin(this),
977                 OperandTraits<StoreInst>::operands(this),
978                 InsertAtEnd) {
979   Op<0>() = val;
980   Op<1>() = addr;
981   setVolatile(isVolatile);
982   setAlignment(Align);
983   AssertOK();
984 }
985
986 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
987                      BasicBlock *InsertAtEnd)
988   : Instruction(Type::VoidTy, Store,
989                 OperandTraits<StoreInst>::op_begin(this),
990                 OperandTraits<StoreInst>::operands(this),
991                 InsertAtEnd) {
992   Op<0>() = val;
993   Op<1>() = addr;
994   setVolatile(isVolatile);
995   setAlignment(0);
996   AssertOK();
997 }
998
999 void StoreInst::setAlignment(unsigned Align) {
1000   assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
1001   SubclassData = (SubclassData & 1) | ((Log2_32(Align)+1)<<1);
1002 }
1003
1004 //===----------------------------------------------------------------------===//
1005 //                       GetElementPtrInst Implementation
1006 //===----------------------------------------------------------------------===//
1007
1008 static unsigned retrieveAddrSpace(const Value *Val) {
1009   return cast<PointerType>(Val->getType())->getAddressSpace();
1010 }
1011
1012 void GetElementPtrInst::init(Value *Ptr, Value* const *Idx, unsigned NumIdx,
1013                              const std::string &Name) {
1014   assert(NumOperands == 1+NumIdx && "NumOperands not initialized?");
1015   Use *OL = OperandList;
1016   OL[0] = Ptr;
1017
1018   for (unsigned i = 0; i != NumIdx; ++i)
1019     OL[i+1] = Idx[i];
1020
1021   setName(Name);
1022 }
1023
1024 void GetElementPtrInst::init(Value *Ptr, Value *Idx, const std::string &Name) {
1025   assert(NumOperands == 2 && "NumOperands not initialized?");
1026   Use *OL = OperandList;
1027   OL[0] = Ptr;
1028   OL[1] = Idx;
1029
1030   setName(Name);
1031 }
1032
1033 GetElementPtrInst::GetElementPtrInst(const GetElementPtrInst &GEPI)
1034   : Instruction(GEPI.getType(), GetElementPtr,
1035                 OperandTraits<GetElementPtrInst>::op_end(this)
1036                 - GEPI.getNumOperands(),
1037                 GEPI.getNumOperands()) {
1038   Use *OL = OperandList;
1039   Use *GEPIOL = GEPI.OperandList;
1040   for (unsigned i = 0, E = NumOperands; i != E; ++i)
1041     OL[i] = GEPIOL[i];
1042 }
1043
1044 GetElementPtrInst::GetElementPtrInst(Value *Ptr, Value *Idx,
1045                                      const std::string &Name, Instruction *InBe)
1046   : Instruction(PointerType::get(checkType(getIndexedType(Ptr->getType(),Idx)),
1047                                  retrieveAddrSpace(Ptr)),
1048                 GetElementPtr,
1049                 OperandTraits<GetElementPtrInst>::op_end(this) - 2,
1050                 2, InBe) {
1051   init(Ptr, Idx, Name);
1052 }
1053
1054 GetElementPtrInst::GetElementPtrInst(Value *Ptr, Value *Idx,
1055                                      const std::string &Name, BasicBlock *IAE)
1056   : Instruction(PointerType::get(checkType(getIndexedType(Ptr->getType(),Idx)),
1057                                  retrieveAddrSpace(Ptr)),
1058                 GetElementPtr,
1059                 OperandTraits<GetElementPtrInst>::op_end(this) - 2,
1060                 2, IAE) {
1061   init(Ptr, Idx, Name);
1062 }
1063
1064 /// getIndexedType - Returns the type of the element that would be accessed with
1065 /// a gep instruction with the specified parameters.
1066 ///
1067 /// The Idxs pointer should point to a continuous piece of memory containing the
1068 /// indices, either as Value* or uint64_t.
1069 ///
1070 /// A null type is returned if the indices are invalid for the specified
1071 /// pointer type.
1072 ///
1073 template <typename IndexTy>
1074 static const Type* getIndexedTypeInternal(const Type *Ptr, IndexTy const *Idxs,
1075                                           unsigned NumIdx) {
1076   const PointerType *PTy = dyn_cast<PointerType>(Ptr);
1077   if (!PTy) return 0;   // Type isn't a pointer type!
1078   const Type *Agg = PTy->getElementType();
1079
1080   // Handle the special case of the empty set index set, which is always valid.
1081   if (NumIdx == 0)
1082     return Agg;
1083   
1084   // If there is at least one index, the top level type must be sized, otherwise
1085   // it cannot be 'stepped over'.  We explicitly allow abstract types (those
1086   // that contain opaque types) under the assumption that it will be resolved to
1087   // a sane type later.
1088   if (!Agg->isSized() && !Agg->isAbstract())
1089     return 0;
1090
1091   unsigned CurIdx = 1;
1092   for (; CurIdx != NumIdx; ++CurIdx) {
1093     const CompositeType *CT = dyn_cast<CompositeType>(Agg);
1094     if (!CT || isa<PointerType>(CT)) return 0;
1095     IndexTy Index = Idxs[CurIdx];
1096     if (!CT->indexValid(Index)) return 0;
1097     Agg = CT->getTypeAtIndex(Index);
1098
1099     // If the new type forwards to another type, then it is in the middle
1100     // of being refined to another type (and hence, may have dropped all
1101     // references to what it was using before).  So, use the new forwarded
1102     // type.
1103     if (const Type *Ty = Agg->getForwardedType())
1104       Agg = Ty;
1105   }
1106   return CurIdx == NumIdx ? Agg : 0;
1107 }
1108
1109 const Type* GetElementPtrInst::getIndexedType(const Type *Ptr,
1110                                               Value* const *Idxs,
1111                                               unsigned NumIdx) {
1112   return getIndexedTypeInternal(Ptr, Idxs, NumIdx);
1113 }
1114
1115 const Type* GetElementPtrInst::getIndexedType(const Type *Ptr,
1116                                               uint64_t const *Idxs,
1117                                               unsigned NumIdx) {
1118   return getIndexedTypeInternal(Ptr, Idxs, NumIdx);
1119 }
1120
1121 const Type* GetElementPtrInst::getIndexedType(const Type *Ptr, Value *Idx) {
1122   const PointerType *PTy = dyn_cast<PointerType>(Ptr);
1123   if (!PTy) return 0;   // Type isn't a pointer type!
1124
1125   // Check the pointer index.
1126   if (!PTy->indexValid(Idx)) return 0;
1127
1128   return PTy->getElementType();
1129 }
1130
1131
1132 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
1133 /// zeros.  If so, the result pointer and the first operand have the same
1134 /// value, just potentially different types.
1135 bool GetElementPtrInst::hasAllZeroIndices() const {
1136   for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1137     if (ConstantInt *CI = dyn_cast<ConstantInt>(getOperand(i))) {
1138       if (!CI->isZero()) return false;
1139     } else {
1140       return false;
1141     }
1142   }
1143   return true;
1144 }
1145
1146 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
1147 /// constant integers.  If so, the result pointer and the first operand have
1148 /// a constant offset between them.
1149 bool GetElementPtrInst::hasAllConstantIndices() const {
1150   for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1151     if (!isa<ConstantInt>(getOperand(i)))
1152       return false;
1153   }
1154   return true;
1155 }
1156
1157
1158 //===----------------------------------------------------------------------===//
1159 //                           ExtractElementInst Implementation
1160 //===----------------------------------------------------------------------===//
1161
1162 ExtractElementInst::ExtractElementInst(Value *Val, Value *Index,
1163                                        const std::string &Name,
1164                                        Instruction *InsertBef)
1165   : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1166                 ExtractElement,
1167                 OperandTraits<ExtractElementInst>::op_begin(this),
1168                 2, InsertBef) {
1169   assert(isValidOperands(Val, Index) &&
1170          "Invalid extractelement instruction operands!");
1171   Op<0>() = Val;
1172   Op<1>() = Index;
1173   setName(Name);
1174 }
1175
1176 ExtractElementInst::ExtractElementInst(Value *Val, unsigned IndexV,
1177                                        const std::string &Name,
1178                                        Instruction *InsertBef)
1179   : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1180                 ExtractElement,
1181                 OperandTraits<ExtractElementInst>::op_begin(this),
1182                 2, InsertBef) {
1183   Constant *Index = ConstantInt::get(Type::Int32Ty, IndexV);
1184   assert(isValidOperands(Val, Index) &&
1185          "Invalid extractelement instruction operands!");
1186   Op<0>() = Val;
1187   Op<1>() = Index;
1188   setName(Name);
1189 }
1190
1191
1192 ExtractElementInst::ExtractElementInst(Value *Val, Value *Index,
1193                                        const std::string &Name,
1194                                        BasicBlock *InsertAE)
1195   : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1196                 ExtractElement,
1197                 OperandTraits<ExtractElementInst>::op_begin(this),
1198                 2, InsertAE) {
1199   assert(isValidOperands(Val, Index) &&
1200          "Invalid extractelement instruction operands!");
1201
1202   Op<0>() = Val;
1203   Op<1>() = Index;
1204   setName(Name);
1205 }
1206
1207 ExtractElementInst::ExtractElementInst(Value *Val, unsigned IndexV,
1208                                        const std::string &Name,
1209                                        BasicBlock *InsertAE)
1210   : Instruction(cast<VectorType>(Val->getType())->getElementType(),
1211                 ExtractElement,
1212                 OperandTraits<ExtractElementInst>::op_begin(this),
1213                 2, InsertAE) {
1214   Constant *Index = ConstantInt::get(Type::Int32Ty, IndexV);
1215   assert(isValidOperands(Val, Index) &&
1216          "Invalid extractelement instruction operands!");
1217   
1218   Op<0>() = Val;
1219   Op<1>() = Index;
1220   setName(Name);
1221 }
1222
1223
1224 bool ExtractElementInst::isValidOperands(const Value *Val, const Value *Index) {
1225   if (!isa<VectorType>(Val->getType()) || Index->getType() != Type::Int32Ty)
1226     return false;
1227   return true;
1228 }
1229
1230
1231 //===----------------------------------------------------------------------===//
1232 //                           InsertElementInst Implementation
1233 //===----------------------------------------------------------------------===//
1234
1235 InsertElementInst::InsertElementInst(const InsertElementInst &IE)
1236     : Instruction(IE.getType(), InsertElement,
1237                   OperandTraits<InsertElementInst>::op_begin(this), 3) {
1238   Op<0>() = IE.Op<0>();
1239   Op<1>() = IE.Op<1>();
1240   Op<2>() = IE.Op<2>();
1241 }
1242 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, Value *Index,
1243                                      const std::string &Name,
1244                                      Instruction *InsertBef)
1245   : Instruction(Vec->getType(), InsertElement,
1246                 OperandTraits<InsertElementInst>::op_begin(this),
1247                 3, InsertBef) {
1248   assert(isValidOperands(Vec, Elt, Index) &&
1249          "Invalid insertelement instruction operands!");
1250   Op<0>() = Vec;
1251   Op<1>() = Elt;
1252   Op<2>() = Index;
1253   setName(Name);
1254 }
1255
1256 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, unsigned IndexV,
1257                                      const std::string &Name,
1258                                      Instruction *InsertBef)
1259   : Instruction(Vec->getType(), InsertElement,
1260                 OperandTraits<InsertElementInst>::op_begin(this),
1261                 3, InsertBef) {
1262   Constant *Index = ConstantInt::get(Type::Int32Ty, IndexV);
1263   assert(isValidOperands(Vec, Elt, Index) &&
1264          "Invalid insertelement instruction operands!");
1265   Op<0>() = Vec;
1266   Op<1>() = Elt;
1267   Op<2>() = Index;
1268   setName(Name);
1269 }
1270
1271
1272 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, Value *Index,
1273                                      const std::string &Name,
1274                                      BasicBlock *InsertAE)
1275   : Instruction(Vec->getType(), InsertElement,
1276                 OperandTraits<InsertElementInst>::op_begin(this),
1277                 3, InsertAE) {
1278   assert(isValidOperands(Vec, Elt, Index) &&
1279          "Invalid insertelement instruction operands!");
1280
1281   Op<0>() = Vec;
1282   Op<1>() = Elt;
1283   Op<2>() = Index;
1284   setName(Name);
1285 }
1286
1287 InsertElementInst::InsertElementInst(Value *Vec, Value *Elt, unsigned IndexV,
1288                                      const std::string &Name,
1289                                      BasicBlock *InsertAE)
1290 : Instruction(Vec->getType(), InsertElement,
1291               OperandTraits<InsertElementInst>::op_begin(this),
1292               3, InsertAE) {
1293   Constant *Index = ConstantInt::get(Type::Int32Ty, IndexV);
1294   assert(isValidOperands(Vec, Elt, Index) &&
1295          "Invalid insertelement instruction operands!");
1296   
1297   Op<0>() = Vec;
1298   Op<1>() = Elt;
1299   Op<2>() = Index;
1300   setName(Name);
1301 }
1302
1303 bool InsertElementInst::isValidOperands(const Value *Vec, const Value *Elt, 
1304                                         const Value *Index) {
1305   if (!isa<VectorType>(Vec->getType()))
1306     return false;   // First operand of insertelement must be vector type.
1307   
1308   if (Elt->getType() != cast<VectorType>(Vec->getType())->getElementType())
1309     return false;// Second operand of insertelement must be vector element type.
1310     
1311   if (Index->getType() != Type::Int32Ty)
1312     return false;  // Third operand of insertelement must be i32.
1313   return true;
1314 }
1315
1316
1317 //===----------------------------------------------------------------------===//
1318 //                      ShuffleVectorInst Implementation
1319 //===----------------------------------------------------------------------===//
1320
1321 ShuffleVectorInst::ShuffleVectorInst(const ShuffleVectorInst &SV) 
1322   : Instruction(SV.getType(), ShuffleVector,
1323                 OperandTraits<ShuffleVectorInst>::op_begin(this),
1324                 OperandTraits<ShuffleVectorInst>::operands(this)) {
1325   Op<0>() = SV.Op<0>();
1326   Op<1>() = SV.Op<1>();
1327   Op<2>() = SV.Op<2>();
1328 }
1329
1330 ShuffleVectorInst::ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1331                                      const std::string &Name,
1332                                      Instruction *InsertBefore)
1333 : Instruction(VectorType::get(cast<VectorType>(V1->getType())->getElementType(),
1334                 cast<VectorType>(Mask->getType())->getNumElements()),
1335               ShuffleVector,
1336               OperandTraits<ShuffleVectorInst>::op_begin(this),
1337               OperandTraits<ShuffleVectorInst>::operands(this),
1338               InsertBefore) {
1339   assert(isValidOperands(V1, V2, Mask) &&
1340          "Invalid shuffle vector instruction operands!");
1341   Op<0>() = V1;
1342   Op<1>() = V2;
1343   Op<2>() = Mask;
1344   setName(Name);
1345 }
1346
1347 ShuffleVectorInst::ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
1348                                      const std::string &Name,
1349                                      BasicBlock *InsertAtEnd)
1350   : Instruction(V1->getType(), ShuffleVector,
1351                 OperandTraits<ShuffleVectorInst>::op_begin(this),
1352                 OperandTraits<ShuffleVectorInst>::operands(this),
1353                 InsertAtEnd) {
1354   assert(isValidOperands(V1, V2, Mask) &&
1355          "Invalid shuffle vector instruction operands!");
1356
1357   Op<0>() = V1;
1358   Op<1>() = V2;
1359   Op<2>() = Mask;
1360   setName(Name);
1361 }
1362
1363 bool ShuffleVectorInst::isValidOperands(const Value *V1, const Value *V2,
1364                                         const Value *Mask) {
1365   if (!isa<VectorType>(V1->getType()) || V1->getType() != V2->getType())
1366     return false;
1367   
1368   const VectorType *MaskTy = dyn_cast<VectorType>(Mask->getType());
1369   if (!isa<Constant>(Mask) || MaskTy == 0 ||
1370       MaskTy->getElementType() != Type::Int32Ty)
1371     return false;
1372   return true;
1373 }
1374
1375 /// getMaskValue - Return the index from the shuffle mask for the specified
1376 /// output result.  This is either -1 if the element is undef or a number less
1377 /// than 2*numelements.
1378 int ShuffleVectorInst::getMaskValue(unsigned i) const {
1379   const Constant *Mask = cast<Constant>(getOperand(2));
1380   if (isa<UndefValue>(Mask)) return -1;
1381   if (isa<ConstantAggregateZero>(Mask)) return 0;
1382   const ConstantVector *MaskCV = cast<ConstantVector>(Mask);
1383   assert(i < MaskCV->getNumOperands() && "Index out of range");
1384
1385   if (isa<UndefValue>(MaskCV->getOperand(i)))
1386     return -1;
1387   return cast<ConstantInt>(MaskCV->getOperand(i))->getZExtValue();
1388 }
1389
1390 //===----------------------------------------------------------------------===//
1391 //                             InsertValueInst Class
1392 //===----------------------------------------------------------------------===//
1393
1394 void InsertValueInst::init(Value *Agg, Value *Val, const unsigned *Idx, 
1395                            unsigned NumIdx, const std::string &Name) {
1396   assert(NumOperands == 2 && "NumOperands not initialized?");
1397   Op<0>() = Agg;
1398   Op<1>() = Val;
1399
1400   Indices.insert(Indices.end(), Idx, Idx + NumIdx);
1401   setName(Name);
1402 }
1403
1404 void InsertValueInst::init(Value *Agg, Value *Val, unsigned Idx, 
1405                            const std::string &Name) {
1406   assert(NumOperands == 2 && "NumOperands not initialized?");
1407   Op<0>() = Agg;
1408   Op<1>() = Val;
1409
1410   Indices.push_back(Idx);
1411   setName(Name);
1412 }
1413
1414 InsertValueInst::InsertValueInst(const InsertValueInst &IVI)
1415   : Instruction(IVI.getType(), InsertValue,
1416                 OperandTraits<InsertValueInst>::op_begin(this), 2),
1417     Indices(IVI.Indices) {
1418   Op<0>() = IVI.getOperand(0);
1419   Op<1>() = IVI.getOperand(1);
1420 }
1421
1422 InsertValueInst::InsertValueInst(Value *Agg,
1423                                  Value *Val,
1424                                  unsigned Idx, 
1425                                  const std::string &Name,
1426                                  Instruction *InsertBefore)
1427   : Instruction(Agg->getType(), InsertValue,
1428                 OperandTraits<InsertValueInst>::op_begin(this),
1429                 2, InsertBefore) {
1430   init(Agg, Val, Idx, Name);
1431 }
1432
1433 InsertValueInst::InsertValueInst(Value *Agg,
1434                                  Value *Val,
1435                                  unsigned Idx, 
1436                                  const std::string &Name,
1437                                  BasicBlock *InsertAtEnd)
1438   : Instruction(Agg->getType(), InsertValue,
1439                 OperandTraits<InsertValueInst>::op_begin(this),
1440                 2, InsertAtEnd) {
1441   init(Agg, Val, Idx, Name);
1442 }
1443
1444 //===----------------------------------------------------------------------===//
1445 //                             ExtractValueInst Class
1446 //===----------------------------------------------------------------------===//
1447
1448 void ExtractValueInst::init(const unsigned *Idx, unsigned NumIdx,
1449                             const std::string &Name) {
1450   assert(NumOperands == 1 && "NumOperands not initialized?");
1451
1452   Indices.insert(Indices.end(), Idx, Idx + NumIdx);
1453   setName(Name);
1454 }
1455
1456 void ExtractValueInst::init(unsigned Idx, const std::string &Name) {
1457   assert(NumOperands == 1 && "NumOperands not initialized?");
1458
1459   Indices.push_back(Idx);
1460   setName(Name);
1461 }
1462
1463 ExtractValueInst::ExtractValueInst(const ExtractValueInst &EVI)
1464   : UnaryInstruction(EVI.getType(), ExtractValue, EVI.getOperand(0)),
1465     Indices(EVI.Indices) {
1466 }
1467
1468 // getIndexedType - Returns the type of the element that would be extracted
1469 // with an extractvalue instruction with the specified parameters.
1470 //
1471 // A null type is returned if the indices are invalid for the specified
1472 // pointer type.
1473 //
1474 const Type* ExtractValueInst::getIndexedType(const Type *Agg,
1475                                              const unsigned *Idxs,
1476                                              unsigned NumIdx) {
1477   unsigned CurIdx = 0;
1478   for (; CurIdx != NumIdx; ++CurIdx) {
1479     const CompositeType *CT = dyn_cast<CompositeType>(Agg);
1480     if (!CT || isa<PointerType>(CT) || isa<VectorType>(CT)) return 0;
1481     unsigned Index = Idxs[CurIdx];
1482     if (!CT->indexValid(Index)) return 0;
1483     Agg = CT->getTypeAtIndex(Index);
1484
1485     // If the new type forwards to another type, then it is in the middle
1486     // of being refined to another type (and hence, may have dropped all
1487     // references to what it was using before).  So, use the new forwarded
1488     // type.
1489     if (const Type *Ty = Agg->getForwardedType())
1490       Agg = Ty;
1491   }
1492   return CurIdx == NumIdx ? Agg : 0;
1493 }
1494
1495 const Type* ExtractValueInst::getIndexedType(const Type *Agg,
1496                                              unsigned Idx) {
1497   return getIndexedType(Agg, &Idx, 1);
1498 }
1499
1500 //===----------------------------------------------------------------------===//
1501 //                             BinaryOperator Class
1502 //===----------------------------------------------------------------------===//
1503
1504 /// AdjustIType - Map Add, Sub, and Mul to FAdd, FSub, and FMul when the
1505 /// type is floating-point, to help provide compatibility with an older API.
1506 ///
1507 static BinaryOperator::BinaryOps AdjustIType(BinaryOperator::BinaryOps iType,
1508                                              const Type *Ty) {
1509   // API compatibility: Adjust integer opcodes to floating-point opcodes.
1510   if (Ty->isFPOrFPVector()) {
1511     if (iType == BinaryOperator::Add) iType = BinaryOperator::FAdd;
1512     else if (iType == BinaryOperator::Sub) iType = BinaryOperator::FSub;
1513     else if (iType == BinaryOperator::Mul) iType = BinaryOperator::FMul;
1514   }
1515   return iType;
1516 }
1517
1518 BinaryOperator::BinaryOperator(BinaryOps iType, Value *S1, Value *S2,
1519                                const Type *Ty, const std::string &Name,
1520                                Instruction *InsertBefore)
1521   : Instruction(Ty, AdjustIType(iType, Ty),
1522                 OperandTraits<BinaryOperator>::op_begin(this),
1523                 OperandTraits<BinaryOperator>::operands(this),
1524                 InsertBefore) {
1525   Op<0>() = S1;
1526   Op<1>() = S2;
1527   init(AdjustIType(iType, Ty));
1528   setName(Name);
1529 }
1530
1531 BinaryOperator::BinaryOperator(BinaryOps iType, Value *S1, Value *S2, 
1532                                const Type *Ty, const std::string &Name,
1533                                BasicBlock *InsertAtEnd)
1534   : Instruction(Ty, AdjustIType(iType, Ty),
1535                 OperandTraits<BinaryOperator>::op_begin(this),
1536                 OperandTraits<BinaryOperator>::operands(this),
1537                 InsertAtEnd) {
1538   Op<0>() = S1;
1539   Op<1>() = S2;
1540   init(AdjustIType(iType, Ty));
1541   setName(Name);
1542 }
1543
1544
1545 void BinaryOperator::init(BinaryOps iType) {
1546   Value *LHS = getOperand(0), *RHS = getOperand(1);
1547   LHS = LHS; RHS = RHS; // Silence warnings.
1548   assert(LHS->getType() == RHS->getType() &&
1549          "Binary operator operand types must match!");
1550 #ifndef NDEBUG
1551   switch (iType) {
1552   case Add: case Sub:
1553   case Mul:
1554     assert(getType() == LHS->getType() &&
1555            "Arithmetic operation should return same type as operands!");
1556     assert(getType()->isIntOrIntVector() &&
1557            "Tried to create an integer operation on a non-integer type!");
1558     break;
1559   case FAdd: case FSub:
1560   case FMul:
1561     assert(getType() == LHS->getType() &&
1562            "Arithmetic operation should return same type as operands!");
1563     assert(getType()->isFPOrFPVector() &&
1564            "Tried to create a floating-point operation on a "
1565            "non-floating-point type!");
1566     break;
1567   case UDiv: 
1568   case SDiv: 
1569     assert(getType() == LHS->getType() &&
1570            "Arithmetic operation should return same type as operands!");
1571     assert((getType()->isInteger() || (isa<VectorType>(getType()) && 
1572             cast<VectorType>(getType())->getElementType()->isInteger())) &&
1573            "Incorrect operand type (not integer) for S/UDIV");
1574     break;
1575   case FDiv:
1576     assert(getType() == LHS->getType() &&
1577            "Arithmetic operation should return same type as operands!");
1578     assert(getType()->isFPOrFPVector() &&
1579            "Incorrect operand type (not floating point) for FDIV");
1580     break;
1581   case URem: 
1582   case SRem: 
1583     assert(getType() == LHS->getType() &&
1584            "Arithmetic operation should return same type as operands!");
1585     assert((getType()->isInteger() || (isa<VectorType>(getType()) && 
1586             cast<VectorType>(getType())->getElementType()->isInteger())) &&
1587            "Incorrect operand type (not integer) for S/UREM");
1588     break;
1589   case FRem:
1590     assert(getType() == LHS->getType() &&
1591            "Arithmetic operation should return same type as operands!");
1592     assert(getType()->isFPOrFPVector() &&
1593            "Incorrect operand type (not floating point) for FREM");
1594     break;
1595   case Shl:
1596   case LShr:
1597   case AShr:
1598     assert(getType() == LHS->getType() &&
1599            "Shift operation should return same type as operands!");
1600     assert((getType()->isInteger() ||
1601             (isa<VectorType>(getType()) && 
1602              cast<VectorType>(getType())->getElementType()->isInteger())) &&
1603            "Tried to create a shift operation on a non-integral type!");
1604     break;
1605   case And: case Or:
1606   case Xor:
1607     assert(getType() == LHS->getType() &&
1608            "Logical operation should return same type as operands!");
1609     assert((getType()->isInteger() ||
1610             (isa<VectorType>(getType()) && 
1611              cast<VectorType>(getType())->getElementType()->isInteger())) &&
1612            "Tried to create a logical operation on a non-integral type!");
1613     break;
1614   default:
1615     break;
1616   }
1617 #endif
1618 }
1619
1620 BinaryOperator *BinaryOperator::Create(BinaryOps Op, Value *S1, Value *S2,
1621                                        const std::string &Name,
1622                                        Instruction *InsertBefore) {
1623   assert(S1->getType() == S2->getType() &&
1624          "Cannot create binary operator with two operands of differing type!");
1625   return new BinaryOperator(Op, S1, S2, S1->getType(), Name, InsertBefore);
1626 }
1627
1628 BinaryOperator *BinaryOperator::Create(BinaryOps Op, Value *S1, Value *S2,
1629                                        const std::string &Name,
1630                                        BasicBlock *InsertAtEnd) {
1631   BinaryOperator *Res = Create(Op, S1, S2, Name);
1632   InsertAtEnd->getInstList().push_back(Res);
1633   return Res;
1634 }
1635
1636 BinaryOperator *BinaryOperator::CreateNeg(LLVMContext &Context,
1637                                           Value *Op, const std::string &Name,
1638                                           Instruction *InsertBefore) {
1639   Value *zero = Context.getZeroValueForNegation(Op->getType());
1640   return new BinaryOperator(Instruction::Sub,
1641                             zero, Op,
1642                             Op->getType(), Name, InsertBefore);
1643 }
1644
1645 BinaryOperator *BinaryOperator::CreateNeg(LLVMContext &Context, 
1646                                           Value *Op, const std::string &Name,
1647                                           BasicBlock *InsertAtEnd) {
1648   Value *zero = Context.getZeroValueForNegation(Op->getType());
1649   return new BinaryOperator(Instruction::Sub,
1650                             zero, Op,
1651                             Op->getType(), Name, InsertAtEnd);
1652 }
1653
1654 BinaryOperator *BinaryOperator::CreateFNeg(LLVMContext &Context,
1655                                            Value *Op, const std::string &Name,
1656                                            Instruction *InsertBefore) {
1657   Value *zero = Context.getZeroValueForNegation(Op->getType());
1658   return new BinaryOperator(Instruction::FSub,
1659                             zero, Op,
1660                             Op->getType(), Name, InsertBefore);
1661 }
1662
1663 BinaryOperator *BinaryOperator::CreateFNeg(LLVMContext &Context,
1664                                            Value *Op, const std::string &Name,
1665                                            BasicBlock *InsertAtEnd) {
1666   Value *zero = Context.getZeroValueForNegation(Op->getType());
1667   return new BinaryOperator(Instruction::FSub,
1668                             zero, Op,
1669                             Op->getType(), Name, InsertAtEnd);
1670 }
1671
1672 BinaryOperator *BinaryOperator::CreateNot(LLVMContext &Context,
1673                                           Value *Op, const std::string &Name,
1674                                           Instruction *InsertBefore) {
1675   Constant *C;
1676   if (const VectorType *PTy = dyn_cast<VectorType>(Op->getType())) {
1677     C = Context.getAllOnesValue(PTy->getElementType());
1678     C = ConstantVector::get(std::vector<Constant*>(PTy->getNumElements(), C));
1679   } else {
1680     C = Context.getAllOnesValue(Op->getType());
1681   }
1682   
1683   return new BinaryOperator(Instruction::Xor, Op, C,
1684                             Op->getType(), Name, InsertBefore);
1685 }
1686
1687 BinaryOperator *BinaryOperator::CreateNot(LLVMContext &Context,
1688                                           Value *Op, const std::string &Name,
1689                                           BasicBlock *InsertAtEnd) {
1690   Constant *AllOnes;
1691   if (const VectorType *PTy = dyn_cast<VectorType>(Op->getType())) {
1692     // Create a vector of all ones values.
1693     Constant *Elt = Context.getAllOnesValue(PTy->getElementType());
1694     AllOnes = 
1695       ConstantVector::get(std::vector<Constant*>(PTy->getNumElements(), Elt));
1696   } else {
1697     AllOnes = Context.getAllOnesValue(Op->getType());
1698   }
1699   
1700   return new BinaryOperator(Instruction::Xor, Op, AllOnes,
1701                             Op->getType(), Name, InsertAtEnd);
1702 }
1703
1704
1705 // isConstantAllOnes - Helper function for several functions below
1706 static inline bool isConstantAllOnes(const Value *V) {
1707   if (const ConstantInt *CI = dyn_cast<ConstantInt>(V))
1708     return CI->isAllOnesValue();
1709   if (const ConstantVector *CV = dyn_cast<ConstantVector>(V))
1710     return CV->isAllOnesValue();
1711   return false;
1712 }
1713
1714 bool BinaryOperator::isNeg(const Value *V) {
1715   if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
1716     if (Bop->getOpcode() == Instruction::Sub)
1717       if (Constant* C = dyn_cast<Constant>(Bop->getOperand(0)))
1718         return C->isNegativeZeroValue();
1719   return false;
1720 }
1721
1722 bool BinaryOperator::isFNeg(const Value *V) {
1723   if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
1724     if (Bop->getOpcode() == Instruction::FSub)
1725       if (Constant* C = dyn_cast<Constant>(Bop->getOperand(0)))
1726       return C->isNegativeZeroValue();
1727   return false;
1728 }
1729
1730 bool BinaryOperator::isNot(const Value *V) {
1731   if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
1732     return (Bop->getOpcode() == Instruction::Xor &&
1733             (isConstantAllOnes(Bop->getOperand(1)) ||
1734              isConstantAllOnes(Bop->getOperand(0))));
1735   return false;
1736 }
1737
1738 Value *BinaryOperator::getNegArgument(Value *BinOp) {
1739   return cast<BinaryOperator>(BinOp)->getOperand(1);
1740 }
1741
1742 const Value *BinaryOperator::getNegArgument(const Value *BinOp) {
1743   return getNegArgument(const_cast<Value*>(BinOp));
1744 }
1745
1746 Value *BinaryOperator::getFNegArgument(Value *BinOp) {
1747   return cast<BinaryOperator>(BinOp)->getOperand(1);
1748 }
1749
1750 const Value *BinaryOperator::getFNegArgument(const Value *BinOp) {
1751   return getFNegArgument(const_cast<Value*>(BinOp));
1752 }
1753
1754 Value *BinaryOperator::getNotArgument(Value *BinOp) {
1755   assert(isNot(BinOp) && "getNotArgument on non-'not' instruction!");
1756   BinaryOperator *BO = cast<BinaryOperator>(BinOp);
1757   Value *Op0 = BO->getOperand(0);
1758   Value *Op1 = BO->getOperand(1);
1759   if (isConstantAllOnes(Op0)) return Op1;
1760
1761   assert(isConstantAllOnes(Op1));
1762   return Op0;
1763 }
1764
1765 const Value *BinaryOperator::getNotArgument(const Value *BinOp) {
1766   return getNotArgument(const_cast<Value*>(BinOp));
1767 }
1768
1769
1770 // swapOperands - Exchange the two operands to this instruction.  This
1771 // instruction is safe to use on any binary instruction and does not
1772 // modify the semantics of the instruction.  If the instruction is
1773 // order dependent (SetLT f.e.) the opcode is changed.
1774 //
1775 bool BinaryOperator::swapOperands() {
1776   if (!isCommutative())
1777     return true; // Can't commute operands
1778   Op<0>().swap(Op<1>());
1779   return false;
1780 }
1781
1782 //===----------------------------------------------------------------------===//
1783 //                                CastInst Class
1784 //===----------------------------------------------------------------------===//
1785
1786 // Just determine if this cast only deals with integral->integral conversion.
1787 bool CastInst::isIntegerCast() const {
1788   switch (getOpcode()) {
1789     default: return false;
1790     case Instruction::ZExt:
1791     case Instruction::SExt:
1792     case Instruction::Trunc:
1793       return true;
1794     case Instruction::BitCast:
1795       return getOperand(0)->getType()->isInteger() && getType()->isInteger();
1796   }
1797 }
1798
1799 bool CastInst::isLosslessCast() const {
1800   // Only BitCast can be lossless, exit fast if we're not BitCast
1801   if (getOpcode() != Instruction::BitCast)
1802     return false;
1803
1804   // Identity cast is always lossless
1805   const Type* SrcTy = getOperand(0)->getType();
1806   const Type* DstTy = getType();
1807   if (SrcTy == DstTy)
1808     return true;
1809   
1810   // Pointer to pointer is always lossless.
1811   if (isa<PointerType>(SrcTy))
1812     return isa<PointerType>(DstTy);
1813   return false;  // Other types have no identity values
1814 }
1815
1816 /// This function determines if the CastInst does not require any bits to be
1817 /// changed in order to effect the cast. Essentially, it identifies cases where
1818 /// no code gen is necessary for the cast, hence the name no-op cast.  For 
1819 /// example, the following are all no-op casts:
1820 /// # bitcast i32* %x to i8*
1821 /// # bitcast <2 x i32> %x to <4 x i16> 
1822 /// # ptrtoint i32* %x to i32     ; on 32-bit plaforms only
1823 /// @brief Determine if a cast is a no-op.
1824 bool CastInst::isNoopCast(const Type *IntPtrTy) const {
1825   switch (getOpcode()) {
1826     default:
1827       assert(!"Invalid CastOp");
1828     case Instruction::Trunc:
1829     case Instruction::ZExt:
1830     case Instruction::SExt: 
1831     case Instruction::FPTrunc:
1832     case Instruction::FPExt:
1833     case Instruction::UIToFP:
1834     case Instruction::SIToFP:
1835     case Instruction::FPToUI:
1836     case Instruction::FPToSI:
1837       return false; // These always modify bits
1838     case Instruction::BitCast:
1839       return true;  // BitCast never modifies bits.
1840     case Instruction::PtrToInt:
1841       return IntPtrTy->getScalarSizeInBits() ==
1842              getType()->getScalarSizeInBits();
1843     case Instruction::IntToPtr:
1844       return IntPtrTy->getScalarSizeInBits() ==
1845              getOperand(0)->getType()->getScalarSizeInBits();
1846   }
1847 }
1848
1849 /// This function determines if a pair of casts can be eliminated and what 
1850 /// opcode should be used in the elimination. This assumes that there are two 
1851 /// instructions like this:
1852 /// *  %F = firstOpcode SrcTy %x to MidTy
1853 /// *  %S = secondOpcode MidTy %F to DstTy
1854 /// The function returns a resultOpcode so these two casts can be replaced with:
1855 /// *  %Replacement = resultOpcode %SrcTy %x to DstTy
1856 /// If no such cast is permited, the function returns 0.
1857 unsigned CastInst::isEliminableCastPair(
1858   Instruction::CastOps firstOp, Instruction::CastOps secondOp,
1859   const Type *SrcTy, const Type *MidTy, const Type *DstTy, const Type *IntPtrTy)
1860 {
1861   // Define the 144 possibilities for these two cast instructions. The values
1862   // in this matrix determine what to do in a given situation and select the
1863   // case in the switch below.  The rows correspond to firstOp, the columns 
1864   // correspond to secondOp.  In looking at the table below, keep in  mind
1865   // the following cast properties:
1866   //
1867   //          Size Compare       Source               Destination
1868   // Operator  Src ? Size   Type       Sign         Type       Sign
1869   // -------- ------------ -------------------   ---------------------
1870   // TRUNC         >       Integer      Any        Integral     Any
1871   // ZEXT          <       Integral   Unsigned     Integer      Any
1872   // SEXT          <       Integral    Signed      Integer      Any
1873   // FPTOUI       n/a      FloatPt      n/a        Integral   Unsigned
1874   // FPTOSI       n/a      FloatPt      n/a        Integral    Signed 
1875   // UITOFP       n/a      Integral   Unsigned     FloatPt      n/a   
1876   // SITOFP       n/a      Integral    Signed      FloatPt      n/a   
1877   // FPTRUNC       >       FloatPt      n/a        FloatPt      n/a   
1878   // FPEXT         <       FloatPt      n/a        FloatPt      n/a   
1879   // PTRTOINT     n/a      Pointer      n/a        Integral   Unsigned
1880   // INTTOPTR     n/a      Integral   Unsigned     Pointer      n/a
1881   // BITCONVERT    =       FirstClass   n/a       FirstClass    n/a   
1882   //
1883   // NOTE: some transforms are safe, but we consider them to be non-profitable.
1884   // For example, we could merge "fptoui double to i32" + "zext i32 to i64",
1885   // into "fptoui double to i64", but this loses information about the range
1886   // of the produced value (we no longer know the top-part is all zeros). 
1887   // Further this conversion is often much more expensive for typical hardware,
1888   // and causes issues when building libgcc.  We disallow fptosi+sext for the 
1889   // same reason.
1890   const unsigned numCastOps = 
1891     Instruction::CastOpsEnd - Instruction::CastOpsBegin;
1892   static const uint8_t CastResults[numCastOps][numCastOps] = {
1893     // T        F  F  U  S  F  F  P  I  B   -+
1894     // R  Z  S  P  P  I  I  T  P  2  N  T    |
1895     // U  E  E  2  2  2  2  R  E  I  T  C    +- secondOp
1896     // N  X  X  U  S  F  F  N  X  N  2  V    |
1897     // C  T  T  I  I  P  P  C  T  T  P  T   -+
1898     {  1, 0, 0,99,99, 0, 0,99,99,99, 0, 3 }, // Trunc      -+
1899     {  8, 1, 9,99,99, 2, 0,99,99,99, 2, 3 }, // ZExt        |
1900     {  8, 0, 1,99,99, 0, 2,99,99,99, 0, 3 }, // SExt        |
1901     {  0, 0, 0,99,99, 0, 0,99,99,99, 0, 3 }, // FPToUI      |
1902     {  0, 0, 0,99,99, 0, 0,99,99,99, 0, 3 }, // FPToSI      |
1903     { 99,99,99, 0, 0,99,99, 0, 0,99,99, 4 }, // UIToFP      +- firstOp
1904     { 99,99,99, 0, 0,99,99, 0, 0,99,99, 4 }, // SIToFP      |
1905     { 99,99,99, 0, 0,99,99, 1, 0,99,99, 4 }, // FPTrunc     |
1906     { 99,99,99, 2, 2,99,99,10, 2,99,99, 4 }, // FPExt       |
1907     {  1, 0, 0,99,99, 0, 0,99,99,99, 7, 3 }, // PtrToInt    |
1908     { 99,99,99,99,99,99,99,99,99,13,99,12 }, // IntToPtr    |
1909     {  5, 5, 5, 6, 6, 5, 5, 6, 6,11, 5, 1 }, // BitCast    -+
1910   };
1911
1912   int ElimCase = CastResults[firstOp-Instruction::CastOpsBegin]
1913                             [secondOp-Instruction::CastOpsBegin];
1914   switch (ElimCase) {
1915     case 0: 
1916       // categorically disallowed
1917       return 0;
1918     case 1: 
1919       // allowed, use first cast's opcode
1920       return firstOp;
1921     case 2: 
1922       // allowed, use second cast's opcode
1923       return secondOp;
1924     case 3: 
1925       // no-op cast in second op implies firstOp as long as the DestTy 
1926       // is integer
1927       if (DstTy->isInteger())
1928         return firstOp;
1929       return 0;
1930     case 4:
1931       // no-op cast in second op implies firstOp as long as the DestTy
1932       // is floating point
1933       if (DstTy->isFloatingPoint())
1934         return firstOp;
1935       return 0;
1936     case 5: 
1937       // no-op cast in first op implies secondOp as long as the SrcTy
1938       // is an integer
1939       if (SrcTy->isInteger())
1940         return secondOp;
1941       return 0;
1942     case 6:
1943       // no-op cast in first op implies secondOp as long as the SrcTy
1944       // is a floating point
1945       if (SrcTy->isFloatingPoint())
1946         return secondOp;
1947       return 0;
1948     case 7: { 
1949       // ptrtoint, inttoptr -> bitcast (ptr -> ptr) if int size is >= ptr size
1950       unsigned PtrSize = IntPtrTy->getScalarSizeInBits();
1951       unsigned MidSize = MidTy->getScalarSizeInBits();
1952       if (MidSize >= PtrSize)
1953         return Instruction::BitCast;
1954       return 0;
1955     }
1956     case 8: {
1957       // ext, trunc -> bitcast,    if the SrcTy and DstTy are same size
1958       // ext, trunc -> ext,        if sizeof(SrcTy) < sizeof(DstTy)
1959       // ext, trunc -> trunc,      if sizeof(SrcTy) > sizeof(DstTy)
1960       unsigned SrcSize = SrcTy->getScalarSizeInBits();
1961       unsigned DstSize = DstTy->getScalarSizeInBits();
1962       if (SrcSize == DstSize)
1963         return Instruction::BitCast;
1964       else if (SrcSize < DstSize)
1965         return firstOp;
1966       return secondOp;
1967     }
1968     case 9: // zext, sext -> zext, because sext can't sign extend after zext
1969       return Instruction::ZExt;
1970     case 10:
1971       // fpext followed by ftrunc is allowed if the bit size returned to is
1972       // the same as the original, in which case its just a bitcast
1973       if (SrcTy == DstTy)
1974         return Instruction::BitCast;
1975       return 0; // If the types are not the same we can't eliminate it.
1976     case 11:
1977       // bitcast followed by ptrtoint is allowed as long as the bitcast
1978       // is a pointer to pointer cast.
1979       if (isa<PointerType>(SrcTy) && isa<PointerType>(MidTy))
1980         return secondOp;
1981       return 0;
1982     case 12:
1983       // inttoptr, bitcast -> intptr  if bitcast is a ptr to ptr cast
1984       if (isa<PointerType>(MidTy) && isa<PointerType>(DstTy))
1985         return firstOp;
1986       return 0;
1987     case 13: {
1988       // inttoptr, ptrtoint -> bitcast if SrcSize<=PtrSize and SrcSize==DstSize
1989       unsigned PtrSize = IntPtrTy->getScalarSizeInBits();
1990       unsigned SrcSize = SrcTy->getScalarSizeInBits();
1991       unsigned DstSize = DstTy->getScalarSizeInBits();
1992       if (SrcSize <= PtrSize && SrcSize == DstSize)
1993         return Instruction::BitCast;
1994       return 0;
1995     }
1996     case 99: 
1997       // cast combination can't happen (error in input). This is for all cases
1998       // where the MidTy is not the same for the two cast instructions.
1999       assert(!"Invalid Cast Combination");
2000       return 0;
2001     default:
2002       assert(!"Error in CastResults table!!!");
2003       return 0;
2004   }
2005   return 0;
2006 }
2007
2008 CastInst *CastInst::Create(Instruction::CastOps op, Value *S, const Type *Ty, 
2009   const std::string &Name, Instruction *InsertBefore) {
2010   // Construct and return the appropriate CastInst subclass
2011   switch (op) {
2012     case Trunc:    return new TruncInst    (S, Ty, Name, InsertBefore);
2013     case ZExt:     return new ZExtInst     (S, Ty, Name, InsertBefore);
2014     case SExt:     return new SExtInst     (S, Ty, Name, InsertBefore);
2015     case FPTrunc:  return new FPTruncInst  (S, Ty, Name, InsertBefore);
2016     case FPExt:    return new FPExtInst    (S, Ty, Name, InsertBefore);
2017     case UIToFP:   return new UIToFPInst   (S, Ty, Name, InsertBefore);
2018     case SIToFP:   return new SIToFPInst   (S, Ty, Name, InsertBefore);
2019     case FPToUI:   return new FPToUIInst   (S, Ty, Name, InsertBefore);
2020     case FPToSI:   return new FPToSIInst   (S, Ty, Name, InsertBefore);
2021     case PtrToInt: return new PtrToIntInst (S, Ty, Name, InsertBefore);
2022     case IntToPtr: return new IntToPtrInst (S, Ty, Name, InsertBefore);
2023     case BitCast:  return new BitCastInst  (S, Ty, Name, InsertBefore);
2024     default:
2025       assert(!"Invalid opcode provided");
2026   }
2027   return 0;
2028 }
2029
2030 CastInst *CastInst::Create(Instruction::CastOps op, Value *S, const Type *Ty,
2031   const std::string &Name, BasicBlock *InsertAtEnd) {
2032   // Construct and return the appropriate CastInst subclass
2033   switch (op) {
2034     case Trunc:    return new TruncInst    (S, Ty, Name, InsertAtEnd);
2035     case ZExt:     return new ZExtInst     (S, Ty, Name, InsertAtEnd);
2036     case SExt:     return new SExtInst     (S, Ty, Name, InsertAtEnd);
2037     case FPTrunc:  return new FPTruncInst  (S, Ty, Name, InsertAtEnd);
2038     case FPExt:    return new FPExtInst    (S, Ty, Name, InsertAtEnd);
2039     case UIToFP:   return new UIToFPInst   (S, Ty, Name, InsertAtEnd);
2040     case SIToFP:   return new SIToFPInst   (S, Ty, Name, InsertAtEnd);
2041     case FPToUI:   return new FPToUIInst   (S, Ty, Name, InsertAtEnd);
2042     case FPToSI:   return new FPToSIInst   (S, Ty, Name, InsertAtEnd);
2043     case PtrToInt: return new PtrToIntInst (S, Ty, Name, InsertAtEnd);
2044     case IntToPtr: return new IntToPtrInst (S, Ty, Name, InsertAtEnd);
2045     case BitCast:  return new BitCastInst  (S, Ty, Name, InsertAtEnd);
2046     default:
2047       assert(!"Invalid opcode provided");
2048   }
2049   return 0;
2050 }
2051
2052 CastInst *CastInst::CreateZExtOrBitCast(Value *S, const Type *Ty, 
2053                                         const std::string &Name,
2054                                         Instruction *InsertBefore) {
2055   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2056     return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2057   return Create(Instruction::ZExt, S, Ty, Name, InsertBefore);
2058 }
2059
2060 CastInst *CastInst::CreateZExtOrBitCast(Value *S, const Type *Ty, 
2061                                         const std::string &Name,
2062                                         BasicBlock *InsertAtEnd) {
2063   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2064     return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2065   return Create(Instruction::ZExt, S, Ty, Name, InsertAtEnd);
2066 }
2067
2068 CastInst *CastInst::CreateSExtOrBitCast(Value *S, const Type *Ty, 
2069                                         const std::string &Name,
2070                                         Instruction *InsertBefore) {
2071   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2072     return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2073   return Create(Instruction::SExt, S, Ty, Name, InsertBefore);
2074 }
2075
2076 CastInst *CastInst::CreateSExtOrBitCast(Value *S, const Type *Ty, 
2077                                         const std::string &Name,
2078                                         BasicBlock *InsertAtEnd) {
2079   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2080     return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2081   return Create(Instruction::SExt, S, Ty, Name, InsertAtEnd);
2082 }
2083
2084 CastInst *CastInst::CreateTruncOrBitCast(Value *S, const Type *Ty,
2085                                          const std::string &Name,
2086                                          Instruction *InsertBefore) {
2087   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2088     return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2089   return Create(Instruction::Trunc, S, Ty, Name, InsertBefore);
2090 }
2091
2092 CastInst *CastInst::CreateTruncOrBitCast(Value *S, const Type *Ty,
2093                                          const std::string &Name, 
2094                                          BasicBlock *InsertAtEnd) {
2095   if (S->getType()->getScalarSizeInBits() == Ty->getScalarSizeInBits())
2096     return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2097   return Create(Instruction::Trunc, S, Ty, Name, InsertAtEnd);
2098 }
2099
2100 CastInst *CastInst::CreatePointerCast(Value *S, const Type *Ty,
2101                                       const std::string &Name,
2102                                       BasicBlock *InsertAtEnd) {
2103   assert(isa<PointerType>(S->getType()) && "Invalid cast");
2104   assert((Ty->isInteger() || isa<PointerType>(Ty)) &&
2105          "Invalid cast");
2106
2107   if (Ty->isInteger())
2108     return Create(Instruction::PtrToInt, S, Ty, Name, InsertAtEnd);
2109   return Create(Instruction::BitCast, S, Ty, Name, InsertAtEnd);
2110 }
2111
2112 /// @brief Create a BitCast or a PtrToInt cast instruction
2113 CastInst *CastInst::CreatePointerCast(Value *S, const Type *Ty, 
2114                                       const std::string &Name, 
2115                                       Instruction *InsertBefore) {
2116   assert(isa<PointerType>(S->getType()) && "Invalid cast");
2117   assert((Ty->isInteger() || isa<PointerType>(Ty)) &&
2118          "Invalid cast");
2119
2120   if (Ty->isInteger())
2121     return Create(Instruction::PtrToInt, S, Ty, Name, InsertBefore);
2122   return Create(Instruction::BitCast, S, Ty, Name, InsertBefore);
2123 }
2124
2125 CastInst *CastInst::CreateIntegerCast(Value *C, const Type *Ty, 
2126                                       bool isSigned, const std::string &Name,
2127                                       Instruction *InsertBefore) {
2128   assert(C->getType()->isInteger() && Ty->isInteger() && "Invalid cast");
2129   unsigned SrcBits = C->getType()->getScalarSizeInBits();
2130   unsigned DstBits = Ty->getScalarSizeInBits();
2131   Instruction::CastOps opcode =
2132     (SrcBits == DstBits ? Instruction::BitCast :
2133      (SrcBits > DstBits ? Instruction::Trunc :
2134       (isSigned ? Instruction::SExt : Instruction::ZExt)));
2135   return Create(opcode, C, Ty, Name, InsertBefore);
2136 }
2137
2138 CastInst *CastInst::CreateIntegerCast(Value *C, const Type *Ty, 
2139                                       bool isSigned, const std::string &Name,
2140                                       BasicBlock *InsertAtEnd) {
2141   assert(C->getType()->isIntOrIntVector() && Ty->isIntOrIntVector() &&
2142          "Invalid cast");
2143   unsigned SrcBits = C->getType()->getScalarSizeInBits();
2144   unsigned DstBits = Ty->getScalarSizeInBits();
2145   Instruction::CastOps opcode =
2146     (SrcBits == DstBits ? Instruction::BitCast :
2147      (SrcBits > DstBits ? Instruction::Trunc :
2148       (isSigned ? Instruction::SExt : Instruction::ZExt)));
2149   return Create(opcode, C, Ty, Name, InsertAtEnd);
2150 }
2151
2152 CastInst *CastInst::CreateFPCast(Value *C, const Type *Ty, 
2153                                  const std::string &Name, 
2154                                  Instruction *InsertBefore) {
2155   assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
2156          "Invalid cast");
2157   unsigned SrcBits = C->getType()->getScalarSizeInBits();
2158   unsigned DstBits = Ty->getScalarSizeInBits();
2159   Instruction::CastOps opcode =
2160     (SrcBits == DstBits ? Instruction::BitCast :
2161      (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt));
2162   return Create(opcode, C, Ty, Name, InsertBefore);
2163 }
2164
2165 CastInst *CastInst::CreateFPCast(Value *C, const Type *Ty, 
2166                                  const std::string &Name, 
2167                                  BasicBlock *InsertAtEnd) {
2168   assert(C->getType()->isFPOrFPVector() && Ty->isFPOrFPVector() &&
2169          "Invalid cast");
2170   unsigned SrcBits = C->getType()->getScalarSizeInBits();
2171   unsigned DstBits = Ty->getScalarSizeInBits();
2172   Instruction::CastOps opcode =
2173     (SrcBits == DstBits ? Instruction::BitCast :
2174      (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt));
2175   return Create(opcode, C, Ty, Name, InsertAtEnd);
2176 }
2177
2178 // Check whether it is valid to call getCastOpcode for these types.
2179 // This routine must be kept in sync with getCastOpcode.
2180 bool CastInst::isCastable(const Type *SrcTy, const Type *DestTy) {
2181   if (!SrcTy->isFirstClassType() || !DestTy->isFirstClassType())
2182     return false;
2183
2184   if (SrcTy == DestTy)
2185     return true;
2186
2187   // Get the bit sizes, we'll need these
2188   unsigned SrcBits = SrcTy->getScalarSizeInBits();   // 0 for ptr
2189   unsigned DestBits = DestTy->getScalarSizeInBits(); // 0 for ptr
2190
2191   // Run through the possibilities ...
2192   if (DestTy->isInteger()) {                   // Casting to integral
2193     if (SrcTy->isInteger()) {                  // Casting from integral
2194         return true;
2195     } else if (SrcTy->isFloatingPoint()) {     // Casting from floating pt
2196       return true;
2197     } else if (const VectorType *PTy = dyn_cast<VectorType>(SrcTy)) {
2198                                                // Casting from vector
2199       return DestBits == PTy->getBitWidth();
2200     } else {                                   // Casting from something else
2201       return isa<PointerType>(SrcTy);
2202     }
2203   } else if (DestTy->isFloatingPoint()) {      // Casting to floating pt
2204     if (SrcTy->isInteger()) {                  // Casting from integral
2205       return true;
2206     } else if (SrcTy->isFloatingPoint()) {     // Casting from floating pt
2207       return true;
2208     } else if (const VectorType *PTy = dyn_cast<VectorType>(SrcTy)) {
2209                                                // Casting from vector
2210       return DestBits == PTy->getBitWidth();
2211     } else {                                   // Casting from something else
2212       return false;
2213     }
2214   } else if (const VectorType *DestPTy = dyn_cast<VectorType>(DestTy)) {
2215                                                 // Casting to vector
2216     if (const VectorType *SrcPTy = dyn_cast<VectorType>(SrcTy)) {
2217                                                 // Casting from vector
2218       return DestPTy->getBitWidth() == SrcPTy->getBitWidth();
2219     } else {                                    // Casting from something else
2220       return DestPTy->getBitWidth() == SrcBits;
2221     }
2222   } else if (isa<PointerType>(DestTy)) {        // Casting to pointer
2223     if (isa<PointerType>(SrcTy)) {              // Casting from pointer
2224       return true;
2225     } else if (SrcTy->isInteger()) {            // Casting from integral
2226       return true;
2227     } else {                                    // Casting from something else
2228       return false;
2229     }
2230   } else {                                      // Casting to something else
2231     return false;
2232   }
2233 }
2234
2235 // Provide a way to get a "cast" where the cast opcode is inferred from the 
2236 // types and size of the operand. This, basically, is a parallel of the 
2237 // logic in the castIsValid function below.  This axiom should hold:
2238 //   castIsValid( getCastOpcode(Val, Ty), Val, Ty)
2239 // should not assert in castIsValid. In other words, this produces a "correct"
2240 // casting opcode for the arguments passed to it.
2241 // This routine must be kept in sync with isCastable.
2242 Instruction::CastOps
2243 CastInst::getCastOpcode(
2244   const Value *Src, bool SrcIsSigned, const Type *DestTy, bool DestIsSigned) {
2245   // Get the bit sizes, we'll need these
2246   const Type *SrcTy = Src->getType();
2247   unsigned SrcBits = SrcTy->getScalarSizeInBits();   // 0 for ptr
2248   unsigned DestBits = DestTy->getScalarSizeInBits(); // 0 for ptr
2249
2250   assert(SrcTy->isFirstClassType() && DestTy->isFirstClassType() &&
2251          "Only first class types are castable!");
2252
2253   // Run through the possibilities ...
2254   if (DestTy->isInteger()) {                       // Casting to integral
2255     if (SrcTy->isInteger()) {                      // Casting from integral
2256       if (DestBits < SrcBits)
2257         return Trunc;                               // int -> smaller int
2258       else if (DestBits > SrcBits) {                // its an extension
2259         if (SrcIsSigned)
2260           return SExt;                              // signed -> SEXT
2261         else
2262           return ZExt;                              // unsigned -> ZEXT
2263       } else {
2264         return BitCast;                             // Same size, No-op cast
2265       }
2266     } else if (SrcTy->isFloatingPoint()) {          // Casting from floating pt
2267       if (DestIsSigned) 
2268         return FPToSI;                              // FP -> sint
2269       else
2270         return FPToUI;                              // FP -> uint 
2271     } else if (const VectorType *PTy = dyn_cast<VectorType>(SrcTy)) {
2272       assert(DestBits == PTy->getBitWidth() &&
2273                "Casting vector to integer of different width");
2274       PTy = NULL;
2275       return BitCast;                             // Same size, no-op cast
2276     } else {
2277       assert(isa<PointerType>(SrcTy) &&
2278              "Casting from a value that is not first-class type");
2279       return PtrToInt;                              // ptr -> int
2280     }
2281   } else if (DestTy->isFloatingPoint()) {           // Casting to floating pt
2282     if (SrcTy->isInteger()) {                      // Casting from integral
2283       if (SrcIsSigned)
2284         return SIToFP;                              // sint -> FP
2285       else
2286         return UIToFP;                              // uint -> FP
2287     } else if (SrcTy->isFloatingPoint()) {          // Casting from floating pt
2288       if (DestBits < SrcBits) {
2289         return FPTrunc;                             // FP -> smaller FP
2290       } else if (DestBits > SrcBits) {
2291         return FPExt;                               // FP -> larger FP
2292       } else  {
2293         return BitCast;                             // same size, no-op cast
2294       }
2295     } else if (const VectorType *PTy = dyn_cast<VectorType>(SrcTy)) {
2296       assert(DestBits == PTy->getBitWidth() &&
2297              "Casting vector to floating point of different width");
2298       PTy = NULL;
2299       return BitCast;                             // same size, no-op cast
2300     } else {
2301       llvm_unreachable("Casting pointer or non-first class to float");
2302     }
2303   } else if (const VectorType *DestPTy = dyn_cast<VectorType>(DestTy)) {
2304     if (const VectorType *SrcPTy = dyn_cast<VectorType>(SrcTy)) {
2305       assert(DestPTy->getBitWidth() == SrcPTy->getBitWidth() &&
2306              "Casting vector to vector of different widths");
2307       SrcPTy = NULL;
2308       return BitCast;                             // vector -> vector
2309     } else if (DestPTy->getBitWidth() == SrcBits) {
2310       return BitCast;                               // float/int -> vector
2311     } else {
2312       assert(!"Illegal cast to vector (wrong type or size)");
2313     }
2314   } else if (isa<PointerType>(DestTy)) {
2315     if (isa<PointerType>(SrcTy)) {
2316       return BitCast;                               // ptr -> ptr
2317     } else if (SrcTy->isInteger()) {
2318       return IntToPtr;                              // int -> ptr
2319     } else {
2320       assert(!"Casting pointer to other than pointer or int");
2321     }
2322   } else {
2323     assert(!"Casting to type that is not first-class");
2324   }
2325
2326   // If we fall through to here we probably hit an assertion cast above
2327   // and assertions are not turned on. Anything we return is an error, so
2328   // BitCast is as good a choice as any.
2329   return BitCast;
2330 }
2331
2332 //===----------------------------------------------------------------------===//
2333 //                    CastInst SubClass Constructors
2334 //===----------------------------------------------------------------------===//
2335
2336 /// Check that the construction parameters for a CastInst are correct. This
2337 /// could be broken out into the separate constructors but it is useful to have
2338 /// it in one place and to eliminate the redundant code for getting the sizes
2339 /// of the types involved.
2340 bool 
2341 CastInst::castIsValid(Instruction::CastOps op, Value *S, const Type *DstTy) {
2342
2343   // Check for type sanity on the arguments
2344   const Type *SrcTy = S->getType();
2345   if (!SrcTy->isFirstClassType() || !DstTy->isFirstClassType())
2346     return false;
2347
2348   // Get the size of the types in bits, we'll need this later
2349   unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2350   unsigned DstBitSize = DstTy->getScalarSizeInBits();
2351
2352   // Switch on the opcode provided
2353   switch (op) {
2354   default: return false; // This is an input error
2355   case Instruction::Trunc:
2356     return SrcTy->isIntOrIntVector() &&
2357            DstTy->isIntOrIntVector()&& SrcBitSize > DstBitSize;
2358   case Instruction::ZExt:
2359     return SrcTy->isIntOrIntVector() &&
2360            DstTy->isIntOrIntVector()&& SrcBitSize < DstBitSize;
2361   case Instruction::SExt: 
2362     return SrcTy->isIntOrIntVector() &&
2363            DstTy->isIntOrIntVector()&& SrcBitSize < DstBitSize;
2364   case Instruction::FPTrunc:
2365     return SrcTy->isFPOrFPVector() &&
2366            DstTy->isFPOrFPVector() && 
2367            SrcBitSize > DstBitSize;
2368   case Instruction::FPExt:
2369     return SrcTy->isFPOrFPVector() &&
2370            DstTy->isFPOrFPVector() && 
2371            SrcBitSize < DstBitSize;
2372   case Instruction::UIToFP:
2373   case Instruction::SIToFP:
2374     if (const VectorType *SVTy = dyn_cast<VectorType>(SrcTy)) {
2375       if (const VectorType *DVTy = dyn_cast<VectorType>(DstTy)) {
2376         return SVTy->getElementType()->isIntOrIntVector() &&
2377                DVTy->getElementType()->isFPOrFPVector() &&
2378                SVTy->getNumElements() == DVTy->getNumElements();
2379       }
2380     }
2381     return SrcTy->isIntOrIntVector() && DstTy->isFPOrFPVector();
2382   case Instruction::FPToUI:
2383   case Instruction::FPToSI:
2384     if (const VectorType *SVTy = dyn_cast<VectorType>(SrcTy)) {
2385       if (const VectorType *DVTy = dyn_cast<VectorType>(DstTy)) {
2386         return SVTy->getElementType()->isFPOrFPVector() &&
2387                DVTy->getElementType()->isIntOrIntVector() &&
2388                SVTy->getNumElements() == DVTy->getNumElements();
2389       }
2390     }
2391     return SrcTy->isFPOrFPVector() && DstTy->isIntOrIntVector();
2392   case Instruction::PtrToInt:
2393     return isa<PointerType>(SrcTy) && DstTy->isInteger();
2394   case Instruction::IntToPtr:
2395     return SrcTy->isInteger() && isa<PointerType>(DstTy);
2396   case Instruction::BitCast:
2397     // BitCast implies a no-op cast of type only. No bits change.
2398     // However, you can't cast pointers to anything but pointers.
2399     if (isa<PointerType>(SrcTy) != isa<PointerType>(DstTy))
2400       return false;
2401
2402     // Now we know we're not dealing with a pointer/non-pointer mismatch. In all
2403     // these cases, the cast is okay if the source and destination bit widths
2404     // are identical.
2405     return SrcTy->getPrimitiveSizeInBits() == DstTy->getPrimitiveSizeInBits();
2406   }
2407 }
2408
2409 TruncInst::TruncInst(
2410   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2411 ) : CastInst(Ty, Trunc, S, Name, InsertBefore) {
2412   assert(castIsValid(getOpcode(), S, Ty) && "Illegal Trunc");
2413 }
2414
2415 TruncInst::TruncInst(
2416   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2417 ) : CastInst(Ty, Trunc, S, Name, InsertAtEnd) { 
2418   assert(castIsValid(getOpcode(), S, Ty) && "Illegal Trunc");
2419 }
2420
2421 ZExtInst::ZExtInst(
2422   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2423 )  : CastInst(Ty, ZExt, S, Name, InsertBefore) { 
2424   assert(castIsValid(getOpcode(), S, Ty) && "Illegal ZExt");
2425 }
2426
2427 ZExtInst::ZExtInst(
2428   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2429 )  : CastInst(Ty, ZExt, S, Name, InsertAtEnd) { 
2430   assert(castIsValid(getOpcode(), S, Ty) && "Illegal ZExt");
2431 }
2432 SExtInst::SExtInst(
2433   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2434 ) : CastInst(Ty, SExt, S, Name, InsertBefore) { 
2435   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SExt");
2436 }
2437
2438 SExtInst::SExtInst(
2439   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2440 )  : CastInst(Ty, SExt, S, Name, InsertAtEnd) { 
2441   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SExt");
2442 }
2443
2444 FPTruncInst::FPTruncInst(
2445   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2446 ) : CastInst(Ty, FPTrunc, S, Name, InsertBefore) { 
2447   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPTrunc");
2448 }
2449
2450 FPTruncInst::FPTruncInst(
2451   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2452 ) : CastInst(Ty, FPTrunc, S, Name, InsertAtEnd) { 
2453   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPTrunc");
2454 }
2455
2456 FPExtInst::FPExtInst(
2457   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2458 ) : CastInst(Ty, FPExt, S, Name, InsertBefore) { 
2459   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPExt");
2460 }
2461
2462 FPExtInst::FPExtInst(
2463   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2464 ) : CastInst(Ty, FPExt, S, Name, InsertAtEnd) { 
2465   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPExt");
2466 }
2467
2468 UIToFPInst::UIToFPInst(
2469   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2470 ) : CastInst(Ty, UIToFP, S, Name, InsertBefore) { 
2471   assert(castIsValid(getOpcode(), S, Ty) && "Illegal UIToFP");
2472 }
2473
2474 UIToFPInst::UIToFPInst(
2475   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2476 ) : CastInst(Ty, UIToFP, S, Name, InsertAtEnd) { 
2477   assert(castIsValid(getOpcode(), S, Ty) && "Illegal UIToFP");
2478 }
2479
2480 SIToFPInst::SIToFPInst(
2481   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2482 ) : CastInst(Ty, SIToFP, S, Name, InsertBefore) { 
2483   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SIToFP");
2484 }
2485
2486 SIToFPInst::SIToFPInst(
2487   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2488 ) : CastInst(Ty, SIToFP, S, Name, InsertAtEnd) { 
2489   assert(castIsValid(getOpcode(), S, Ty) && "Illegal SIToFP");
2490 }
2491
2492 FPToUIInst::FPToUIInst(
2493   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2494 ) : CastInst(Ty, FPToUI, S, Name, InsertBefore) { 
2495   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToUI");
2496 }
2497
2498 FPToUIInst::FPToUIInst(
2499   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2500 ) : CastInst(Ty, FPToUI, S, Name, InsertAtEnd) { 
2501   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToUI");
2502 }
2503
2504 FPToSIInst::FPToSIInst(
2505   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2506 ) : CastInst(Ty, FPToSI, S, Name, InsertBefore) { 
2507   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToSI");
2508 }
2509
2510 FPToSIInst::FPToSIInst(
2511   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2512 ) : CastInst(Ty, FPToSI, S, Name, InsertAtEnd) { 
2513   assert(castIsValid(getOpcode(), S, Ty) && "Illegal FPToSI");
2514 }
2515
2516 PtrToIntInst::PtrToIntInst(
2517   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2518 ) : CastInst(Ty, PtrToInt, S, Name, InsertBefore) { 
2519   assert(castIsValid(getOpcode(), S, Ty) && "Illegal PtrToInt");
2520 }
2521
2522 PtrToIntInst::PtrToIntInst(
2523   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2524 ) : CastInst(Ty, PtrToInt, S, Name, InsertAtEnd) { 
2525   assert(castIsValid(getOpcode(), S, Ty) && "Illegal PtrToInt");
2526 }
2527
2528 IntToPtrInst::IntToPtrInst(
2529   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2530 ) : CastInst(Ty, IntToPtr, S, Name, InsertBefore) { 
2531   assert(castIsValid(getOpcode(), S, Ty) && "Illegal IntToPtr");
2532 }
2533
2534 IntToPtrInst::IntToPtrInst(
2535   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2536 ) : CastInst(Ty, IntToPtr, S, Name, InsertAtEnd) { 
2537   assert(castIsValid(getOpcode(), S, Ty) && "Illegal IntToPtr");
2538 }
2539
2540 BitCastInst::BitCastInst(
2541   Value *S, const Type *Ty, const std::string &Name, Instruction *InsertBefore
2542 ) : CastInst(Ty, BitCast, S, Name, InsertBefore) { 
2543   assert(castIsValid(getOpcode(), S, Ty) && "Illegal BitCast");
2544 }
2545
2546 BitCastInst::BitCastInst(
2547   Value *S, const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd
2548 ) : CastInst(Ty, BitCast, S, Name, InsertAtEnd) { 
2549   assert(castIsValid(getOpcode(), S, Ty) && "Illegal BitCast");
2550 }
2551
2552 //===----------------------------------------------------------------------===//
2553 //                               CmpInst Classes
2554 //===----------------------------------------------------------------------===//
2555
2556 CmpInst::CmpInst(const Type *ty, OtherOps op, unsigned short predicate,
2557                  Value *LHS, Value *RHS, const std::string &Name,
2558                  Instruction *InsertBefore)
2559   : Instruction(ty, op,
2560                 OperandTraits<CmpInst>::op_begin(this),
2561                 OperandTraits<CmpInst>::operands(this),
2562                 InsertBefore) {
2563     Op<0>() = LHS;
2564     Op<1>() = RHS;
2565   SubclassData = predicate;
2566   setName(Name);
2567 }
2568
2569 CmpInst::CmpInst(const Type *ty, OtherOps op, unsigned short predicate,
2570                  Value *LHS, Value *RHS, const std::string &Name,
2571                  BasicBlock *InsertAtEnd)
2572   : Instruction(ty, op,
2573                 OperandTraits<CmpInst>::op_begin(this),
2574                 OperandTraits<CmpInst>::operands(this),
2575                 InsertAtEnd) {
2576   Op<0>() = LHS;
2577   Op<1>() = RHS;
2578   SubclassData = predicate;
2579   setName(Name);
2580 }
2581
2582 CmpInst *
2583 CmpInst::Create(LLVMContext &Context, OtherOps Op, unsigned short predicate,
2584                 Value *S1, Value *S2, 
2585                 const std::string &Name, Instruction *InsertBefore) {
2586   if (Op == Instruction::ICmp) {
2587     if (InsertBefore)
2588       return new ICmpInst(InsertBefore, CmpInst::Predicate(predicate),
2589                           S1, S2, Name);
2590     else
2591       return new ICmpInst(Context, CmpInst::Predicate(predicate),
2592                           S1, S2, Name);
2593   }
2594   
2595   if (InsertBefore)
2596     return new FCmpInst(InsertBefore, CmpInst::Predicate(predicate),
2597                         S1, S2, Name);
2598   else
2599     return new FCmpInst(Context, CmpInst::Predicate(predicate),
2600                         S1, S2, Name);
2601 }
2602
2603 CmpInst *
2604 CmpInst::Create(OtherOps Op, unsigned short predicate, Value *S1, Value *S2, 
2605                 const std::string &Name, BasicBlock *InsertAtEnd) {
2606   if (Op == Instruction::ICmp) {
2607     return new ICmpInst(*InsertAtEnd, CmpInst::Predicate(predicate),
2608                         S1, S2, Name);
2609   }
2610   return new FCmpInst(*InsertAtEnd, CmpInst::Predicate(predicate),
2611                       S1, S2, Name);
2612 }
2613
2614 void CmpInst::swapOperands() {
2615   if (ICmpInst *IC = dyn_cast<ICmpInst>(this))
2616     IC->swapOperands();
2617   else
2618     cast<FCmpInst>(this)->swapOperands();
2619 }
2620
2621 bool CmpInst::isCommutative() {
2622   if (ICmpInst *IC = dyn_cast<ICmpInst>(this))
2623     return IC->isCommutative();
2624   return cast<FCmpInst>(this)->isCommutative();
2625 }
2626
2627 bool CmpInst::isEquality() {
2628   if (ICmpInst *IC = dyn_cast<ICmpInst>(this))
2629     return IC->isEquality();
2630   return cast<FCmpInst>(this)->isEquality();
2631 }
2632
2633
2634 CmpInst::Predicate CmpInst::getInversePredicate(Predicate pred) {
2635   switch (pred) {
2636     default: assert(!"Unknown cmp predicate!");
2637     case ICMP_EQ: return ICMP_NE;
2638     case ICMP_NE: return ICMP_EQ;
2639     case ICMP_UGT: return ICMP_ULE;
2640     case ICMP_ULT: return ICMP_UGE;
2641     case ICMP_UGE: return ICMP_ULT;
2642     case ICMP_ULE: return ICMP_UGT;
2643     case ICMP_SGT: return ICMP_SLE;
2644     case ICMP_SLT: return ICMP_SGE;
2645     case ICMP_SGE: return ICMP_SLT;
2646     case ICMP_SLE: return ICMP_SGT;
2647
2648     case FCMP_OEQ: return FCMP_UNE;
2649     case FCMP_ONE: return FCMP_UEQ;
2650     case FCMP_OGT: return FCMP_ULE;
2651     case FCMP_OLT: return FCMP_UGE;
2652     case FCMP_OGE: return FCMP_ULT;
2653     case FCMP_OLE: return FCMP_UGT;
2654     case FCMP_UEQ: return FCMP_ONE;
2655     case FCMP_UNE: return FCMP_OEQ;
2656     case FCMP_UGT: return FCMP_OLE;
2657     case FCMP_ULT: return FCMP_OGE;
2658     case FCMP_UGE: return FCMP_OLT;
2659     case FCMP_ULE: return FCMP_OGT;
2660     case FCMP_ORD: return FCMP_UNO;
2661     case FCMP_UNO: return FCMP_ORD;
2662     case FCMP_TRUE: return FCMP_FALSE;
2663     case FCMP_FALSE: return FCMP_TRUE;
2664   }
2665 }
2666
2667 ICmpInst::Predicate ICmpInst::getSignedPredicate(Predicate pred) {
2668   switch (pred) {
2669     default: assert(! "Unknown icmp predicate!");
2670     case ICMP_EQ: case ICMP_NE: 
2671     case ICMP_SGT: case ICMP_SLT: case ICMP_SGE: case ICMP_SLE: 
2672        return pred;
2673     case ICMP_UGT: return ICMP_SGT;
2674     case ICMP_ULT: return ICMP_SLT;
2675     case ICMP_UGE: return ICMP_SGE;
2676     case ICMP_ULE: return ICMP_SLE;
2677   }
2678 }
2679
2680 ICmpInst::Predicate ICmpInst::getUnsignedPredicate(Predicate pred) {
2681   switch (pred) {
2682     default: assert(! "Unknown icmp predicate!");
2683     case ICMP_EQ: case ICMP_NE: 
2684     case ICMP_UGT: case ICMP_ULT: case ICMP_UGE: case ICMP_ULE: 
2685        return pred;
2686     case ICMP_SGT: return ICMP_UGT;
2687     case ICMP_SLT: return ICMP_ULT;
2688     case ICMP_SGE: return ICMP_UGE;
2689     case ICMP_SLE: return ICMP_ULE;
2690   }
2691 }
2692
2693 bool ICmpInst::isSignedPredicate(Predicate pred) {
2694   switch (pred) {
2695     default: assert(! "Unknown icmp predicate!");
2696     case ICMP_SGT: case ICMP_SLT: case ICMP_SGE: case ICMP_SLE: 
2697       return true;
2698     case ICMP_EQ:  case ICMP_NE: case ICMP_UGT: case ICMP_ULT: 
2699     case ICMP_UGE: case ICMP_ULE:
2700       return false;
2701   }
2702 }
2703
2704 /// Initialize a set of values that all satisfy the condition with C.
2705 ///
2706 ConstantRange 
2707 ICmpInst::makeConstantRange(Predicate pred, const APInt &C) {
2708   APInt Lower(C);
2709   APInt Upper(C);
2710   uint32_t BitWidth = C.getBitWidth();
2711   switch (pred) {
2712   default: llvm_unreachable("Invalid ICmp opcode to ConstantRange ctor!");
2713   case ICmpInst::ICMP_EQ: Upper++; break;
2714   case ICmpInst::ICMP_NE: Lower++; break;
2715   case ICmpInst::ICMP_ULT: Lower = APInt::getMinValue(BitWidth); break;
2716   case ICmpInst::ICMP_SLT: Lower = APInt::getSignedMinValue(BitWidth); break;
2717   case ICmpInst::ICMP_UGT: 
2718     Lower++; Upper = APInt::getMinValue(BitWidth);        // Min = Next(Max)
2719     break;
2720   case ICmpInst::ICMP_SGT:
2721     Lower++; Upper = APInt::getSignedMinValue(BitWidth);  // Min = Next(Max)
2722     break;
2723   case ICmpInst::ICMP_ULE: 
2724     Lower = APInt::getMinValue(BitWidth); Upper++; 
2725     break;
2726   case ICmpInst::ICMP_SLE: 
2727     Lower = APInt::getSignedMinValue(BitWidth); Upper++; 
2728     break;
2729   case ICmpInst::ICMP_UGE:
2730     Upper = APInt::getMinValue(BitWidth);        // Min = Next(Max)
2731     break;
2732   case ICmpInst::ICMP_SGE:
2733     Upper = APInt::getSignedMinValue(BitWidth);  // Min = Next(Max)
2734     break;
2735   }
2736   return ConstantRange(Lower, Upper);
2737 }
2738
2739 CmpInst::Predicate CmpInst::getSwappedPredicate(Predicate pred) {
2740   switch (pred) {
2741     default: assert(!"Unknown cmp predicate!");
2742     case ICMP_EQ: case ICMP_NE:
2743       return pred;
2744     case ICMP_SGT: return ICMP_SLT;
2745     case ICMP_SLT: return ICMP_SGT;
2746     case ICMP_SGE: return ICMP_SLE;
2747     case ICMP_SLE: return ICMP_SGE;
2748     case ICMP_UGT: return ICMP_ULT;
2749     case ICMP_ULT: return ICMP_UGT;
2750     case ICMP_UGE: return ICMP_ULE;
2751     case ICMP_ULE: return ICMP_UGE;
2752   
2753     case FCMP_FALSE: case FCMP_TRUE:
2754     case FCMP_OEQ: case FCMP_ONE:
2755     case FCMP_UEQ: case FCMP_UNE:
2756     case FCMP_ORD: case FCMP_UNO:
2757       return pred;
2758     case FCMP_OGT: return FCMP_OLT;
2759     case FCMP_OLT: return FCMP_OGT;
2760     case FCMP_OGE: return FCMP_OLE;
2761     case FCMP_OLE: return FCMP_OGE;
2762     case FCMP_UGT: return FCMP_ULT;
2763     case FCMP_ULT: return FCMP_UGT;
2764     case FCMP_UGE: return FCMP_ULE;
2765     case FCMP_ULE: return FCMP_UGE;
2766   }
2767 }
2768
2769 bool CmpInst::isUnsigned(unsigned short predicate) {
2770   switch (predicate) {
2771     default: return false;
2772     case ICmpInst::ICMP_ULT: case ICmpInst::ICMP_ULE: case ICmpInst::ICMP_UGT: 
2773     case ICmpInst::ICMP_UGE: return true;
2774   }
2775 }
2776
2777 bool CmpInst::isSigned(unsigned short predicate){
2778   switch (predicate) {
2779     default: return false;
2780     case ICmpInst::ICMP_SLT: case ICmpInst::ICMP_SLE: case ICmpInst::ICMP_SGT: 
2781     case ICmpInst::ICMP_SGE: return true;
2782   }
2783 }
2784
2785 bool CmpInst::isOrdered(unsigned short predicate) {
2786   switch (predicate) {
2787     default: return false;
2788     case FCmpInst::FCMP_OEQ: case FCmpInst::FCMP_ONE: case FCmpInst::FCMP_OGT: 
2789     case FCmpInst::FCMP_OLT: case FCmpInst::FCMP_OGE: case FCmpInst::FCMP_OLE: 
2790     case FCmpInst::FCMP_ORD: return true;
2791   }
2792 }
2793       
2794 bool CmpInst::isUnordered(unsigned short predicate) {
2795   switch (predicate) {
2796     default: return false;
2797     case FCmpInst::FCMP_UEQ: case FCmpInst::FCMP_UNE: case FCmpInst::FCMP_UGT: 
2798     case FCmpInst::FCMP_ULT: case FCmpInst::FCMP_UGE: case FCmpInst::FCMP_ULE: 
2799     case FCmpInst::FCMP_UNO: return true;
2800   }
2801 }
2802
2803 //===----------------------------------------------------------------------===//
2804 //                        SwitchInst Implementation
2805 //===----------------------------------------------------------------------===//
2806
2807 void SwitchInst::init(Value *Value, BasicBlock *Default, unsigned NumCases) {
2808   assert(Value && Default);
2809   ReservedSpace = 2+NumCases*2;
2810   NumOperands = 2;
2811   OperandList = allocHungoffUses(ReservedSpace);
2812
2813   OperandList[0] = Value;
2814   OperandList[1] = Default;
2815 }
2816
2817 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2818 /// switch on and a default destination.  The number of additional cases can
2819 /// be specified here to make memory allocation more efficient.  This
2820 /// constructor can also autoinsert before another instruction.
2821 SwitchInst::SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2822                        Instruction *InsertBefore)
2823   : TerminatorInst(Type::VoidTy, Instruction::Switch, 0, 0, InsertBefore) {
2824   init(Value, Default, NumCases);
2825 }
2826
2827 /// SwitchInst ctor - Create a new switch instruction, specifying a value to
2828 /// switch on and a default destination.  The number of additional cases can
2829 /// be specified here to make memory allocation more efficient.  This
2830 /// constructor also autoinserts at the end of the specified BasicBlock.
2831 SwitchInst::SwitchInst(Value *Value, BasicBlock *Default, unsigned NumCases,
2832                        BasicBlock *InsertAtEnd)
2833   : TerminatorInst(Type::VoidTy, Instruction::Switch, 0, 0, InsertAtEnd) {
2834   init(Value, Default, NumCases);
2835 }
2836
2837 SwitchInst::SwitchInst(const SwitchInst &SI)
2838   : TerminatorInst(Type::VoidTy, Instruction::Switch,
2839                    allocHungoffUses(SI.getNumOperands()), SI.getNumOperands()) {
2840   Use *OL = OperandList, *InOL = SI.OperandList;
2841   for (unsigned i = 0, E = SI.getNumOperands(); i != E; i+=2) {
2842     OL[i] = InOL[i];
2843     OL[i+1] = InOL[i+1];
2844   }
2845 }
2846
2847 SwitchInst::~SwitchInst() {
2848   dropHungoffUses(OperandList);
2849 }
2850
2851
2852 /// addCase - Add an entry to the switch instruction...
2853 ///
2854 void SwitchInst::addCase(ConstantInt *OnVal, BasicBlock *Dest) {
2855   unsigned OpNo = NumOperands;
2856   if (OpNo+2 > ReservedSpace)
2857     resizeOperands(0);  // Get more space!
2858   // Initialize some new operands.
2859   assert(OpNo+1 < ReservedSpace && "Growing didn't work!");
2860   NumOperands = OpNo+2;
2861   OperandList[OpNo] = OnVal;
2862   OperandList[OpNo+1] = Dest;
2863 }
2864
2865 /// removeCase - This method removes the specified successor from the switch
2866 /// instruction.  Note that this cannot be used to remove the default
2867 /// destination (successor #0).
2868 ///
2869 void SwitchInst::removeCase(unsigned idx) {
2870   assert(idx != 0 && "Cannot remove the default case!");
2871   assert(idx*2 < getNumOperands() && "Successor index out of range!!!");
2872
2873   unsigned NumOps = getNumOperands();
2874   Use *OL = OperandList;
2875
2876   // Move everything after this operand down.
2877   //
2878   // FIXME: we could just swap with the end of the list, then erase.  However,
2879   // client might not expect this to happen.  The code as it is thrashes the
2880   // use/def lists, which is kinda lame.
2881   for (unsigned i = (idx+1)*2; i != NumOps; i += 2) {
2882     OL[i-2] = OL[i];
2883     OL[i-2+1] = OL[i+1];
2884   }
2885
2886   // Nuke the last value.
2887   OL[NumOps-2].set(0);
2888   OL[NumOps-2+1].set(0);
2889   NumOperands = NumOps-2;
2890 }
2891
2892 /// resizeOperands - resize operands - This adjusts the length of the operands
2893 /// list according to the following behavior:
2894 ///   1. If NumOps == 0, grow the operand list in response to a push_back style
2895 ///      of operation.  This grows the number of ops by 3 times.
2896 ///   2. If NumOps > NumOperands, reserve space for NumOps operands.
2897 ///   3. If NumOps == NumOperands, trim the reserved space.
2898 ///
2899 void SwitchInst::resizeOperands(unsigned NumOps) {
2900   unsigned e = getNumOperands();
2901   if (NumOps == 0) {
2902     NumOps = e*3;
2903   } else if (NumOps*2 > NumOperands) {
2904     // No resize needed.
2905     if (ReservedSpace >= NumOps) return;
2906   } else if (NumOps == NumOperands) {
2907     if (ReservedSpace == NumOps) return;
2908   } else {
2909     return;
2910   }
2911
2912   ReservedSpace = NumOps;
2913   Use *NewOps = allocHungoffUses(NumOps);
2914   Use *OldOps = OperandList;
2915   for (unsigned i = 0; i != e; ++i) {
2916       NewOps[i] = OldOps[i];
2917   }
2918   OperandList = NewOps;
2919   if (OldOps) Use::zap(OldOps, OldOps + e, true);
2920 }
2921
2922
2923 BasicBlock *SwitchInst::getSuccessorV(unsigned idx) const {
2924   return getSuccessor(idx);
2925 }
2926 unsigned SwitchInst::getNumSuccessorsV() const {
2927   return getNumSuccessors();
2928 }
2929 void SwitchInst::setSuccessorV(unsigned idx, BasicBlock *B) {
2930   setSuccessor(idx, B);
2931 }
2932
2933 // Define these methods here so vtables don't get emitted into every translation
2934 // unit that uses these classes.
2935
2936 GetElementPtrInst *GetElementPtrInst::clone(LLVMContext&) const {
2937   return new(getNumOperands()) GetElementPtrInst(*this);
2938 }
2939
2940 BinaryOperator *BinaryOperator::clone(LLVMContext&) const {
2941   return Create(getOpcode(), Op<0>(), Op<1>());
2942 }
2943
2944 FCmpInst* FCmpInst::clone(LLVMContext &Context) const {
2945   return new FCmpInst(Context, getPredicate(), Op<0>(), Op<1>());
2946 }
2947 ICmpInst* ICmpInst::clone(LLVMContext &Context) const {
2948   return new ICmpInst(Context, getPredicate(), Op<0>(), Op<1>());
2949 }
2950
2951 ExtractValueInst *ExtractValueInst::clone(LLVMContext&) const {
2952   return new ExtractValueInst(*this);
2953 }
2954 InsertValueInst *InsertValueInst::clone(LLVMContext&) const {
2955   return new InsertValueInst(*this);
2956 }
2957
2958 MallocInst *MallocInst::clone(LLVMContext&) const {
2959   return new MallocInst(*this);
2960 }
2961
2962 AllocaInst *AllocaInst::clone(LLVMContext&) const {
2963   return new AllocaInst(*this);
2964 }
2965
2966 FreeInst *FreeInst::clone(LLVMContext&) const {
2967   return new FreeInst(getOperand(0));
2968 }
2969
2970 LoadInst *LoadInst::clone(LLVMContext&) const {
2971   return new LoadInst(*this);
2972 }
2973
2974 StoreInst *StoreInst::clone(LLVMContext&) const {
2975   return new StoreInst(*this);
2976 }
2977
2978 CastInst *TruncInst::clone(LLVMContext&) const {
2979   return new TruncInst(*this);
2980 }
2981
2982 CastInst *ZExtInst::clone(LLVMContext&) const {
2983   return new ZExtInst(*this);
2984 }
2985
2986 CastInst *SExtInst::clone(LLVMContext&) const {
2987   return new SExtInst(*this);
2988 }
2989
2990 CastInst *FPTruncInst::clone(LLVMContext&) const {
2991   return new FPTruncInst(*this);
2992 }
2993
2994 CastInst *FPExtInst::clone(LLVMContext&) const {
2995   return new FPExtInst(*this);
2996 }
2997
2998 CastInst *UIToFPInst::clone(LLVMContext&) const {
2999   return new UIToFPInst(*this);
3000 }
3001
3002 CastInst *SIToFPInst::clone(LLVMContext&) const {
3003   return new SIToFPInst(*this);
3004 }
3005
3006 CastInst *FPToUIInst::clone(LLVMContext&) const {
3007   return new FPToUIInst(*this);
3008 }
3009
3010 CastInst *FPToSIInst::clone(LLVMContext&) const {
3011   return new FPToSIInst(*this);
3012 }
3013
3014 CastInst *PtrToIntInst::clone(LLVMContext&) const {
3015   return new PtrToIntInst(*this);
3016 }
3017
3018 CastInst *IntToPtrInst::clone(LLVMContext&) const {
3019   return new IntToPtrInst(*this);
3020 }
3021
3022 CastInst *BitCastInst::clone(LLVMContext&) const {
3023   return new BitCastInst(*this);
3024 }
3025
3026 CallInst *CallInst::clone(LLVMContext&) const {
3027   return new(getNumOperands()) CallInst(*this);
3028 }
3029
3030 SelectInst *SelectInst::clone(LLVMContext&)   const {
3031   return new(getNumOperands()) SelectInst(*this);
3032 }
3033
3034 VAArgInst *VAArgInst::clone(LLVMContext&) const {
3035   return new VAArgInst(*this);
3036 }
3037
3038 ExtractElementInst *ExtractElementInst::clone(LLVMContext&) const {
3039   return new ExtractElementInst(*this);
3040 }
3041
3042 InsertElementInst *InsertElementInst::clone(LLVMContext&) const {
3043   return InsertElementInst::Create(*this);
3044 }
3045
3046 ShuffleVectorInst *ShuffleVectorInst::clone(LLVMContext&) const {
3047   return new ShuffleVectorInst(*this);
3048 }
3049
3050 PHINode *PHINode::clone(LLVMContext&) const {
3051   return new PHINode(*this);
3052 }
3053
3054 ReturnInst *ReturnInst::clone(LLVMContext&) const {
3055   return new(getNumOperands()) ReturnInst(*this);
3056 }
3057
3058 BranchInst *BranchInst::clone(LLVMContext&) const {
3059   unsigned Ops(getNumOperands());
3060   return new(Ops, Ops == 1) BranchInst(*this);
3061 }
3062
3063 SwitchInst *SwitchInst::clone(LLVMContext&) const {
3064   return new SwitchInst(*this);
3065 }
3066
3067 InvokeInst *InvokeInst::clone(LLVMContext&) const {
3068   return new(getNumOperands()) InvokeInst(*this);
3069 }
3070
3071 UnwindInst *UnwindInst::clone(LLVMContext&) const {
3072   return new UnwindInst();
3073 }
3074
3075 UnreachableInst *UnreachableInst::clone(LLVMContext&) const {
3076   return new UnreachableInst();
3077 }