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