Get logical operations to like packed types, allow BinOp::getNot to create
[oota-llvm.git] / lib / VMCore / Instructions.cpp
1 //===-- Instructions.cpp - Implement the LLVM instructions ----------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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/BasicBlock.h"
16 #include "llvm/Constants.h"
17 #include "llvm/DerivedTypes.h"
18 #include "llvm/Function.h"
19 #include "llvm/Instructions.h"
20 #include "llvm/Support/CallSite.h"
21 using namespace llvm;
22
23 unsigned CallSite::getCallingConv() const {
24   if (CallInst *CI = dyn_cast<CallInst>(I))
25     return CI->getCallingConv();
26   else
27     return cast<InvokeInst>(I)->getCallingConv();
28 }
29 void CallSite::setCallingConv(unsigned CC) {
30   if (CallInst *CI = dyn_cast<CallInst>(I))
31     CI->setCallingConv(CC);
32   else
33     cast<InvokeInst>(I)->setCallingConv(CC);
34 }
35
36
37 //===----------------------------------------------------------------------===//
38 //                            TerminatorInst Class
39 //===----------------------------------------------------------------------===//
40
41 TerminatorInst::TerminatorInst(Instruction::TermOps iType,
42                                Use *Ops, unsigned NumOps, Instruction *IB)
43   : Instruction(Type::VoidTy, iType, Ops, NumOps, "", IB) {
44 }
45
46 TerminatorInst::TerminatorInst(Instruction::TermOps iType,
47                                Use *Ops, unsigned NumOps, BasicBlock *IAE)
48   : Instruction(Type::VoidTy, iType, Ops, NumOps, "", IAE) {
49 }
50
51
52
53 //===----------------------------------------------------------------------===//
54 //                               PHINode Class
55 //===----------------------------------------------------------------------===//
56
57 PHINode::PHINode(const PHINode &PN)
58   : Instruction(PN.getType(), Instruction::PHI,
59                 new Use[PN.getNumOperands()], PN.getNumOperands()),
60     ReservedSpace(PN.getNumOperands()) {
61   Use *OL = OperandList;
62   for (unsigned i = 0, e = PN.getNumOperands(); i != e; i+=2) {
63     OL[i].init(PN.getOperand(i), this);
64     OL[i+1].init(PN.getOperand(i+1), this);
65   }
66 }
67
68 PHINode::~PHINode() {
69   delete [] OperandList;
70 }
71
72 // removeIncomingValue - Remove an incoming value.  This is useful if a
73 // predecessor basic block is deleted.
74 Value *PHINode::removeIncomingValue(unsigned Idx, bool DeletePHIIfEmpty) {
75   unsigned NumOps = getNumOperands();
76   Use *OL = OperandList;
77   assert(Idx*2 < NumOps && "BB not in PHI node!");
78   Value *Removed = OL[Idx*2];
79
80   // Move everything after this operand down.
81   //
82   // FIXME: we could just swap with the end of the list, then erase.  However,
83   // client might not expect this to happen.  The code as it is thrashes the
84   // use/def lists, which is kinda lame.
85   for (unsigned i = (Idx+1)*2; i != NumOps; i += 2) {
86     OL[i-2] = OL[i];
87     OL[i-2+1] = OL[i+1];
88   }
89
90   // Nuke the last value.
91   OL[NumOps-2].set(0);
92   OL[NumOps-2+1].set(0);
93   NumOperands = NumOps-2;
94
95   // If the PHI node is dead, because it has zero entries, nuke it now.
96   if (NumOps == 2 && DeletePHIIfEmpty) {
97     // If anyone is using this PHI, make them use a dummy value instead...
98     replaceAllUsesWith(UndefValue::get(getType()));
99     eraseFromParent();
100   }
101   return Removed;
102 }
103
104 /// resizeOperands - resize operands - This adjusts the length of the operands
105 /// list according to the following behavior:
106 ///   1. If NumOps == 0, grow the operand list in response to a push_back style
107 ///      of operation.  This grows the number of ops by 1.5 times.
108 ///   2. If NumOps > NumOperands, reserve space for NumOps operands.
109 ///   3. If NumOps == NumOperands, trim the reserved space.
110 ///
111 void PHINode::resizeOperands(unsigned NumOps) {
112   if (NumOps == 0) {
113     NumOps = (getNumOperands())*3/2;
114     if (NumOps < 4) NumOps = 4;      // 4 op PHI nodes are VERY common.
115   } else if (NumOps*2 > NumOperands) {
116     // No resize needed.
117     if (ReservedSpace >= NumOps) return;
118   } else if (NumOps == NumOperands) {
119     if (ReservedSpace == NumOps) return;
120   } else {
121     return;
122   }
123
124   ReservedSpace = NumOps;
125   Use *NewOps = new Use[NumOps];
126   Use *OldOps = OperandList;
127   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
128       NewOps[i].init(OldOps[i], this);
129       OldOps[i].set(0);
130   }
131   delete [] OldOps;
132   OperandList = NewOps;
133 }
134
135 /// hasConstantValue - If the specified PHI node always merges together the same
136 /// value, return the value, otherwise return null.
137 ///
138 Value *PHINode::hasConstantValue(bool AllowNonDominatingInstruction) const {
139   // If the PHI node only has one incoming value, eliminate the PHI node...
140   if (getNumIncomingValues() == 1)
141     if (getIncomingValue(0) != this)   // not  X = phi X
142       return getIncomingValue(0);
143     else
144       return UndefValue::get(getType());  // Self cycle is dead.
145       
146   // Otherwise if all of the incoming values are the same for the PHI, replace
147   // the PHI node with the incoming value.
148   //
149   Value *InVal = 0;
150   bool HasUndefInput = false;
151   for (unsigned i = 0, e = getNumIncomingValues(); i != e; ++i)
152     if (isa<UndefValue>(getIncomingValue(i)))
153       HasUndefInput = true;
154     else if (getIncomingValue(i) != this)  // Not the PHI node itself...
155       if (InVal && getIncomingValue(i) != InVal)
156         return 0;  // Not the same, bail out.
157       else
158         InVal = getIncomingValue(i);
159   
160   // The only case that could cause InVal to be null is if we have a PHI node
161   // that only has entries for itself.  In this case, there is no entry into the
162   // loop, so kill the PHI.
163   //
164   if (InVal == 0) InVal = UndefValue::get(getType());
165   
166   // If we have a PHI node like phi(X, undef, X), where X is defined by some
167   // instruction, we cannot always return X as the result of the PHI node.  Only
168   // do this if X is not an instruction (thus it must dominate the PHI block),
169   // or if the client is prepared to deal with this possibility.
170   if (HasUndefInput && !AllowNonDominatingInstruction)
171     if (Instruction *IV = dyn_cast<Instruction>(InVal))
172       // If it's in the entry block, it dominates everything.
173       if (IV->getParent() != &IV->getParent()->getParent()->front() ||
174           isa<InvokeInst>(IV))
175         return 0;   // Cannot guarantee that InVal dominates this PHINode.
176
177   // All of the incoming values are the same, return the value now.
178   return InVal;
179 }
180
181
182 //===----------------------------------------------------------------------===//
183 //                        CallInst Implementation
184 //===----------------------------------------------------------------------===//
185
186 CallInst::~CallInst() {
187   delete [] OperandList;
188 }
189
190 void CallInst::init(Value *Func, const std::vector<Value*> &Params) {
191   NumOperands = Params.size()+1;
192   Use *OL = OperandList = new Use[Params.size()+1];
193   OL[0].init(Func, this);
194
195   const FunctionType *FTy =
196     cast<FunctionType>(cast<PointerType>(Func->getType())->getElementType());
197
198   assert((Params.size() == FTy->getNumParams() ||
199           (FTy->isVarArg() && Params.size() > FTy->getNumParams())) &&
200          "Calling a function with bad signature");
201   for (unsigned i = 0, e = Params.size(); i != e; ++i)
202     OL[i+1].init(Params[i], this);
203 }
204
205 void CallInst::init(Value *Func, Value *Actual1, Value *Actual2) {
206   NumOperands = 3;
207   Use *OL = OperandList = new Use[3];
208   OL[0].init(Func, this);
209   OL[1].init(Actual1, this);
210   OL[2].init(Actual2, this);
211
212   const FunctionType *FTy =
213     cast<FunctionType>(cast<PointerType>(Func->getType())->getElementType());
214
215   assert((FTy->getNumParams() == 2 ||
216           (FTy->isVarArg() && FTy->getNumParams() == 0)) &&
217          "Calling a function with bad signature");
218 }
219
220 void CallInst::init(Value *Func, Value *Actual) {
221   NumOperands = 2;
222   Use *OL = OperandList = new Use[2];
223   OL[0].init(Func, this);
224   OL[1].init(Actual, this);
225
226   const FunctionType *FTy =
227     cast<FunctionType>(cast<PointerType>(Func->getType())->getElementType());
228
229   assert((FTy->getNumParams() == 1 ||
230           (FTy->isVarArg() && FTy->getNumParams() == 0)) &&
231          "Calling a function with bad signature");
232 }
233
234 void CallInst::init(Value *Func) {
235   NumOperands = 1;
236   Use *OL = OperandList = new Use[1];
237   OL[0].init(Func, this);
238
239   const FunctionType *MTy =
240     cast<FunctionType>(cast<PointerType>(Func->getType())->getElementType());
241
242   assert(MTy->getNumParams() == 0 && "Calling a function with bad signature");
243 }
244
245 CallInst::CallInst(Value *Func, const std::vector<Value*> &Params,
246                    const std::string &Name, Instruction *InsertBefore)
247   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
248                                  ->getElementType())->getReturnType(),
249                 Instruction::Call, 0, 0, Name, InsertBefore) {
250   init(Func, Params);
251 }
252
253 CallInst::CallInst(Value *Func, const std::vector<Value*> &Params,
254                    const std::string &Name, BasicBlock *InsertAtEnd)
255   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
256                                  ->getElementType())->getReturnType(),
257                 Instruction::Call, 0, 0, Name, InsertAtEnd) {
258   init(Func, Params);
259 }
260
261 CallInst::CallInst(Value *Func, Value *Actual1, Value *Actual2,
262                    const std::string &Name, Instruction  *InsertBefore)
263   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
264                                    ->getElementType())->getReturnType(),
265                 Instruction::Call, 0, 0, Name, InsertBefore) {
266   init(Func, Actual1, Actual2);
267 }
268
269 CallInst::CallInst(Value *Func, Value *Actual1, Value *Actual2,
270                    const std::string &Name, BasicBlock  *InsertAtEnd)
271   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
272                                    ->getElementType())->getReturnType(),
273                 Instruction::Call, 0, 0, Name, InsertAtEnd) {
274   init(Func, Actual1, Actual2);
275 }
276
277 CallInst::CallInst(Value *Func, Value* Actual, const std::string &Name,
278                    Instruction  *InsertBefore)
279   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
280                                    ->getElementType())->getReturnType(),
281                 Instruction::Call, 0, 0, Name, InsertBefore) {
282   init(Func, Actual);
283 }
284
285 CallInst::CallInst(Value *Func, Value* Actual, const std::string &Name,
286                    BasicBlock  *InsertAtEnd)
287   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
288                                    ->getElementType())->getReturnType(),
289                 Instruction::Call, 0, 0, Name, InsertAtEnd) {
290   init(Func, Actual);
291 }
292
293 CallInst::CallInst(Value *Func, const std::string &Name,
294                    Instruction *InsertBefore)
295   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
296                                    ->getElementType())->getReturnType(),
297                 Instruction::Call, 0, 0, Name, InsertBefore) {
298   init(Func);
299 }
300
301 CallInst::CallInst(Value *Func, const std::string &Name,
302                    BasicBlock *InsertAtEnd)
303   : Instruction(cast<FunctionType>(cast<PointerType>(Func->getType())
304                                    ->getElementType())->getReturnType(),
305                 Instruction::Call, 0, 0, Name, InsertAtEnd) {
306   init(Func);
307 }
308
309 CallInst::CallInst(const CallInst &CI)
310   : Instruction(CI.getType(), Instruction::Call, new Use[CI.getNumOperands()],
311                 CI.getNumOperands()) {
312   SubclassData = CI.SubclassData;
313   Use *OL = OperandList;
314   Use *InOL = CI.OperandList;
315   for (unsigned i = 0, e = CI.getNumOperands(); i != e; ++i)
316     OL[i].init(InOL[i], this);
317 }
318
319
320 //===----------------------------------------------------------------------===//
321 //                        InvokeInst Implementation
322 //===----------------------------------------------------------------------===//
323
324 InvokeInst::~InvokeInst() {
325   delete [] OperandList;
326 }
327
328 void InvokeInst::init(Value *Fn, BasicBlock *IfNormal, BasicBlock *IfException,
329                       const std::vector<Value*> &Params) {
330   NumOperands = 3+Params.size();
331   Use *OL = OperandList = new Use[3+Params.size()];
332   OL[0].init(Fn, this);
333   OL[1].init(IfNormal, this);
334   OL[2].init(IfException, this);
335   const FunctionType *FTy =
336     cast<FunctionType>(cast<PointerType>(Fn->getType())->getElementType());
337
338   assert((Params.size() == FTy->getNumParams()) ||
339          (FTy->isVarArg() && Params.size() > FTy->getNumParams()) &&
340          "Calling a function with bad signature");
341
342   for (unsigned i = 0, e = Params.size(); i != e; i++)
343     OL[i+3].init(Params[i], this);
344 }
345
346 InvokeInst::InvokeInst(Value *Fn, BasicBlock *IfNormal,
347                        BasicBlock *IfException,
348                        const std::vector<Value*> &Params,
349                        const std::string &Name, Instruction *InsertBefore)
350   : TerminatorInst(cast<FunctionType>(cast<PointerType>(Fn->getType())
351                                     ->getElementType())->getReturnType(),
352                    Instruction::Invoke, 0, 0, Name, InsertBefore) {
353   init(Fn, IfNormal, IfException, Params);
354 }
355
356 InvokeInst::InvokeInst(Value *Fn, BasicBlock *IfNormal,
357                        BasicBlock *IfException,
358                        const std::vector<Value*> &Params,
359                        const std::string &Name, BasicBlock *InsertAtEnd)
360   : TerminatorInst(cast<FunctionType>(cast<PointerType>(Fn->getType())
361                                     ->getElementType())->getReturnType(),
362                    Instruction::Invoke, 0, 0, Name, InsertAtEnd) {
363   init(Fn, IfNormal, IfException, Params);
364 }
365
366 InvokeInst::InvokeInst(const InvokeInst &II)
367   : TerminatorInst(II.getType(), Instruction::Invoke,
368                    new Use[II.getNumOperands()], II.getNumOperands()) {
369   SubclassData = II.SubclassData;
370   Use *OL = OperandList, *InOL = II.OperandList;
371   for (unsigned i = 0, e = II.getNumOperands(); i != e; ++i)
372     OL[i].init(InOL[i], this);
373 }
374
375 BasicBlock *InvokeInst::getSuccessorV(unsigned idx) const {
376   return getSuccessor(idx);
377 }
378 unsigned InvokeInst::getNumSuccessorsV() const {
379   return getNumSuccessors();
380 }
381 void InvokeInst::setSuccessorV(unsigned idx, BasicBlock *B) {
382   return setSuccessor(idx, B);
383 }
384
385
386 //===----------------------------------------------------------------------===//
387 //                        ReturnInst Implementation
388 //===----------------------------------------------------------------------===//
389
390 void ReturnInst::init(Value *retVal) {
391   if (retVal && retVal->getType() != Type::VoidTy) {
392     assert(!isa<BasicBlock>(retVal) &&
393            "Cannot return basic block.  Probably using the incorrect ctor");
394     NumOperands = 1;
395     RetVal.init(retVal, this);
396   }
397 }
398
399 unsigned ReturnInst::getNumSuccessorsV() const {
400   return getNumSuccessors();
401 }
402
403 // Out-of-line ReturnInst method, put here so the C++ compiler can choose to
404 // emit the vtable for the class in this translation unit.
405 void ReturnInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
406   assert(0 && "ReturnInst has no successors!");
407 }
408
409 BasicBlock *ReturnInst::getSuccessorV(unsigned idx) const {
410   assert(0 && "ReturnInst has no successors!");
411   abort();
412   return 0;
413 }
414
415
416 //===----------------------------------------------------------------------===//
417 //                        UnwindInst Implementation
418 //===----------------------------------------------------------------------===//
419
420 unsigned UnwindInst::getNumSuccessorsV() const {
421   return getNumSuccessors();
422 }
423
424 void UnwindInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
425   assert(0 && "UnwindInst has no successors!");
426 }
427
428 BasicBlock *UnwindInst::getSuccessorV(unsigned idx) const {
429   assert(0 && "UnwindInst has no successors!");
430   abort();
431   return 0;
432 }
433
434 //===----------------------------------------------------------------------===//
435 //                      UnreachableInst Implementation
436 //===----------------------------------------------------------------------===//
437
438 unsigned UnreachableInst::getNumSuccessorsV() const {
439   return getNumSuccessors();
440 }
441
442 void UnreachableInst::setSuccessorV(unsigned idx, BasicBlock *NewSucc) {
443   assert(0 && "UnwindInst has no successors!");
444 }
445
446 BasicBlock *UnreachableInst::getSuccessorV(unsigned idx) const {
447   assert(0 && "UnwindInst has no successors!");
448   abort();
449   return 0;
450 }
451
452 //===----------------------------------------------------------------------===//
453 //                        BranchInst Implementation
454 //===----------------------------------------------------------------------===//
455
456 void BranchInst::AssertOK() {
457   if (isConditional())
458     assert(getCondition()->getType() == Type::BoolTy &&
459            "May only branch on boolean predicates!");
460 }
461
462 BranchInst::BranchInst(const BranchInst &BI) :
463   TerminatorInst(Instruction::Br, Ops, BI.getNumOperands()) {
464   OperandList[0].init(BI.getOperand(0), this);
465   if (BI.getNumOperands() != 1) {
466     assert(BI.getNumOperands() == 3 && "BR can have 1 or 3 operands!");
467     OperandList[1].init(BI.getOperand(1), this);
468     OperandList[2].init(BI.getOperand(2), this);
469   }
470 }
471
472 BasicBlock *BranchInst::getSuccessorV(unsigned idx) const {
473   return getSuccessor(idx);
474 }
475 unsigned BranchInst::getNumSuccessorsV() const {
476   return getNumSuccessors();
477 }
478 void BranchInst::setSuccessorV(unsigned idx, BasicBlock *B) {
479   setSuccessor(idx, B);
480 }
481
482
483 //===----------------------------------------------------------------------===//
484 //                        AllocationInst Implementation
485 //===----------------------------------------------------------------------===//
486
487 static Value *getAISize(Value *Amt) {
488   if (!Amt)
489     Amt = ConstantUInt::get(Type::UIntTy, 1);
490   else
491     assert(Amt->getType() == Type::UIntTy &&
492            "Malloc/Allocation array size != UIntTy!");
493   return Amt;
494 }
495
496 AllocationInst::AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy,
497                                unsigned Align, const std::string &Name,
498                                Instruction *InsertBefore)
499   : UnaryInstruction(PointerType::get(Ty), iTy, getAISize(ArraySize),
500                      Name, InsertBefore), Alignment(Align) {
501   assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
502   assert(Ty != Type::VoidTy && "Cannot allocate void!");
503 }
504
505 AllocationInst::AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy,
506                                unsigned Align, const std::string &Name,
507                                BasicBlock *InsertAtEnd)
508   : UnaryInstruction(PointerType::get(Ty), iTy, getAISize(ArraySize),
509                      Name, InsertAtEnd), Alignment(Align) {
510   assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
511   assert(Ty != Type::VoidTy && "Cannot allocate void!");
512 }
513
514 bool AllocationInst::isArrayAllocation() const {
515   if (ConstantUInt *CUI = dyn_cast<ConstantUInt>(getOperand(0)))
516     return CUI->getValue() != 1;
517   return true;
518 }
519
520 const Type *AllocationInst::getAllocatedType() const {
521   return getType()->getElementType();
522 }
523
524 AllocaInst::AllocaInst(const AllocaInst &AI)
525   : AllocationInst(AI.getType()->getElementType(), (Value*)AI.getOperand(0),
526                    Instruction::Alloca, AI.getAlignment()) {
527 }
528
529 MallocInst::MallocInst(const MallocInst &MI)
530   : AllocationInst(MI.getType()->getElementType(), (Value*)MI.getOperand(0),
531                    Instruction::Malloc, MI.getAlignment()) {
532 }
533
534 //===----------------------------------------------------------------------===//
535 //                             FreeInst Implementation
536 //===----------------------------------------------------------------------===//
537
538 void FreeInst::AssertOK() {
539   assert(isa<PointerType>(getOperand(0)->getType()) &&
540          "Can not free something of nonpointer type!");
541 }
542
543 FreeInst::FreeInst(Value *Ptr, Instruction *InsertBefore)
544   : UnaryInstruction(Type::VoidTy, Free, Ptr, "", InsertBefore) {
545   AssertOK();
546 }
547
548 FreeInst::FreeInst(Value *Ptr, BasicBlock *InsertAtEnd)
549   : UnaryInstruction(Type::VoidTy, Free, Ptr, "", InsertAtEnd) {
550   AssertOK();
551 }
552
553
554 //===----------------------------------------------------------------------===//
555 //                           LoadInst Implementation
556 //===----------------------------------------------------------------------===//
557
558 void LoadInst::AssertOK() {
559   assert(isa<PointerType>(getOperand(0)->getType()) &&
560          "Ptr must have pointer type.");
561 }
562
563 LoadInst::LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBef)
564   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
565                      Load, Ptr, Name, InsertBef) {
566   setVolatile(false);
567   AssertOK();
568 }
569
570 LoadInst::LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAE)
571   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
572                      Load, Ptr, Name, InsertAE) {
573   setVolatile(false);
574   AssertOK();
575 }
576
577 LoadInst::LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
578                    Instruction *InsertBef)
579   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
580                      Load, Ptr, Name, InsertBef) {
581   setVolatile(isVolatile);
582   AssertOK();
583 }
584
585 LoadInst::LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
586                    BasicBlock *InsertAE)
587   : UnaryInstruction(cast<PointerType>(Ptr->getType())->getElementType(),
588                      Load, Ptr, Name, InsertAE) {
589   setVolatile(isVolatile);
590   AssertOK();
591 }
592
593
594 //===----------------------------------------------------------------------===//
595 //                           StoreInst Implementation
596 //===----------------------------------------------------------------------===//
597
598 void StoreInst::AssertOK() {
599   assert(isa<PointerType>(getOperand(1)->getType()) &&
600          "Ptr must have pointer type!");
601   assert(getOperand(0)->getType() ==
602                  cast<PointerType>(getOperand(1)->getType())->getElementType()
603          && "Ptr must be a pointer to Val type!");
604 }
605
606
607 StoreInst::StoreInst(Value *val, Value *addr, Instruction *InsertBefore)
608   : Instruction(Type::VoidTy, Store, Ops, 2, "", InsertBefore) {
609   Ops[0].init(val, this);
610   Ops[1].init(addr, this);
611   setVolatile(false);
612   AssertOK();
613 }
614
615 StoreInst::StoreInst(Value *val, Value *addr, BasicBlock *InsertAtEnd)
616   : Instruction(Type::VoidTy, Store, Ops, 2, "", InsertAtEnd) {
617   Ops[0].init(val, this);
618   Ops[1].init(addr, this);
619   setVolatile(false);
620   AssertOK();
621 }
622
623 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
624                      Instruction *InsertBefore)
625   : Instruction(Type::VoidTy, Store, Ops, 2, "", InsertBefore) {
626   Ops[0].init(val, this);
627   Ops[1].init(addr, this);
628   setVolatile(isVolatile);
629   AssertOK();
630 }
631
632 StoreInst::StoreInst(Value *val, Value *addr, bool isVolatile,
633                      BasicBlock *InsertAtEnd)
634   : Instruction(Type::VoidTy, Store, Ops, 2, "", InsertAtEnd) {
635   Ops[0].init(val, this);
636   Ops[1].init(addr, this);
637   setVolatile(isVolatile);
638   AssertOK();
639 }
640
641 //===----------------------------------------------------------------------===//
642 //                       GetElementPtrInst Implementation
643 //===----------------------------------------------------------------------===//
644
645 // checkType - Simple wrapper function to give a better assertion failure
646 // message on bad indexes for a gep instruction.
647 //
648 static inline const Type *checkType(const Type *Ty) {
649   assert(Ty && "Invalid indices for type!");
650   return Ty;
651 }
652
653 void GetElementPtrInst::init(Value *Ptr, const std::vector<Value*> &Idx) {
654   NumOperands = 1+Idx.size();
655   Use *OL = OperandList = new Use[NumOperands];
656   OL[0].init(Ptr, this);
657
658   for (unsigned i = 0, e = Idx.size(); i != e; ++i)
659     OL[i+1].init(Idx[i], this);
660 }
661
662 void GetElementPtrInst::init(Value *Ptr, Value *Idx0, Value *Idx1) {
663   NumOperands = 3;
664   Use *OL = OperandList = new Use[3];
665   OL[0].init(Ptr, this);
666   OL[1].init(Idx0, this);
667   OL[2].init(Idx1, this);
668 }
669
670 void GetElementPtrInst::init(Value *Ptr, Value *Idx) {
671   NumOperands = 2;
672   Use *OL = OperandList = new Use[2];
673   OL[0].init(Ptr, this);
674   OL[1].init(Idx, this);
675 }
676
677 GetElementPtrInst::GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
678                                      const std::string &Name, Instruction *InBe)
679   : Instruction(PointerType::get(checkType(getIndexedType(Ptr->getType(),
680                                                           Idx, true))),
681                 GetElementPtr, 0, 0, Name, InBe) {
682   init(Ptr, Idx);
683 }
684
685 GetElementPtrInst::GetElementPtrInst(Value *Ptr, const std::vector<Value*> &Idx,
686                                      const std::string &Name, BasicBlock *IAE)
687   : Instruction(PointerType::get(checkType(getIndexedType(Ptr->getType(),
688                                                           Idx, true))),
689                 GetElementPtr, 0, 0, Name, IAE) {
690   init(Ptr, Idx);
691 }
692
693 GetElementPtrInst::GetElementPtrInst(Value *Ptr, Value *Idx,
694                                      const std::string &Name, Instruction *InBe)
695   : Instruction(PointerType::get(checkType(getIndexedType(Ptr->getType(),Idx))),
696                 GetElementPtr, 0, 0, Name, InBe) {
697   init(Ptr, Idx);
698 }
699
700 GetElementPtrInst::GetElementPtrInst(Value *Ptr, Value *Idx,
701                                      const std::string &Name, BasicBlock *IAE)
702   : Instruction(PointerType::get(checkType(getIndexedType(Ptr->getType(),Idx))),
703                 GetElementPtr, 0, 0, Name, IAE) {
704   init(Ptr, Idx);
705 }
706
707 GetElementPtrInst::GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
708                                      const std::string &Name, Instruction *InBe)
709   : Instruction(PointerType::get(checkType(getIndexedType(Ptr->getType(),
710                                                           Idx0, Idx1, true))),
711                 GetElementPtr, 0, 0, Name, InBe) {
712   init(Ptr, Idx0, Idx1);
713 }
714
715 GetElementPtrInst::GetElementPtrInst(Value *Ptr, Value *Idx0, Value *Idx1,
716                                      const std::string &Name, BasicBlock *IAE)
717   : Instruction(PointerType::get(checkType(getIndexedType(Ptr->getType(),
718                                                           Idx0, Idx1, true))),
719                 GetElementPtr, 0, 0, Name, IAE) {
720   init(Ptr, Idx0, Idx1);
721 }
722
723 GetElementPtrInst::~GetElementPtrInst() {
724   delete[] OperandList;
725 }
726
727 // getIndexedType - Returns the type of the element that would be loaded with
728 // a load instruction with the specified parameters.
729 //
730 // A null type is returned if the indices are invalid for the specified
731 // pointer type.
732 //
733 const Type* GetElementPtrInst::getIndexedType(const Type *Ptr,
734                                               const std::vector<Value*> &Idx,
735                                               bool AllowCompositeLeaf) {
736   if (!isa<PointerType>(Ptr)) return 0;   // Type isn't a pointer type!
737
738   // Handle the special case of the empty set index set...
739   if (Idx.empty())
740     if (AllowCompositeLeaf ||
741         cast<PointerType>(Ptr)->getElementType()->isFirstClassType())
742       return cast<PointerType>(Ptr)->getElementType();
743     else
744       return 0;
745
746   unsigned CurIdx = 0;
747   while (const CompositeType *CT = dyn_cast<CompositeType>(Ptr)) {
748     if (Idx.size() == CurIdx) {
749       if (AllowCompositeLeaf || CT->isFirstClassType()) return Ptr;
750       return 0;   // Can't load a whole structure or array!?!?
751     }
752
753     Value *Index = Idx[CurIdx++];
754     if (isa<PointerType>(CT) && CurIdx != 1)
755       return 0;  // Can only index into pointer types at the first index!
756     if (!CT->indexValid(Index)) return 0;
757     Ptr = CT->getTypeAtIndex(Index);
758
759     // If the new type forwards to another type, then it is in the middle
760     // of being refined to another type (and hence, may have dropped all
761     // references to what it was using before).  So, use the new forwarded
762     // type.
763     if (const Type * Ty = Ptr->getForwardedType()) {
764       Ptr = Ty;
765     }
766   }
767   return CurIdx == Idx.size() ? Ptr : 0;
768 }
769
770 const Type* GetElementPtrInst::getIndexedType(const Type *Ptr,
771                                               Value *Idx0, Value *Idx1,
772                                               bool AllowCompositeLeaf) {
773   const PointerType *PTy = dyn_cast<PointerType>(Ptr);
774   if (!PTy) return 0;   // Type isn't a pointer type!
775
776   // Check the pointer index.
777   if (!PTy->indexValid(Idx0)) return 0;
778
779   const CompositeType *CT = dyn_cast<CompositeType>(PTy->getElementType());
780   if (!CT || !CT->indexValid(Idx1)) return 0;
781
782   const Type *ElTy = CT->getTypeAtIndex(Idx1);
783   if (AllowCompositeLeaf || ElTy->isFirstClassType())
784     return ElTy;
785   return 0;
786 }
787
788 const Type* GetElementPtrInst::getIndexedType(const Type *Ptr, Value *Idx) {
789   const PointerType *PTy = dyn_cast<PointerType>(Ptr);
790   if (!PTy) return 0;   // Type isn't a pointer type!
791
792   // Check the pointer index.
793   if (!PTy->indexValid(Idx)) return 0;
794
795   return PTy->getElementType();
796 }
797
798 //===----------------------------------------------------------------------===//
799 //                             BinaryOperator Class
800 //===----------------------------------------------------------------------===//
801
802 void BinaryOperator::init(BinaryOps iType)
803 {
804   Value *LHS = getOperand(0), *RHS = getOperand(1);
805   assert(LHS->getType() == RHS->getType() &&
806          "Binary operator operand types must match!");
807 #ifndef NDEBUG
808   switch (iType) {
809   case Add: case Sub:
810   case Mul: case Div:
811   case Rem:
812     assert(getType() == LHS->getType() &&
813            "Arithmetic operation should return same type as operands!");
814     assert((getType()->isInteger() || getType()->isFloatingPoint() ||
815             isa<PackedType>(getType())) &&
816           "Tried to create an arithmetic operation on a non-arithmetic type!");
817     break;
818   case And: case Or:
819   case Xor:
820     assert(getType() == LHS->getType() &&
821            "Logical operation should return same type as operands!");
822     assert((getType()->isIntegral() ||
823             (isa<PackedType>(getType()) && 
824              cast<PackedType>(getType())->getElementType()->isIntegral())) &&
825            "Tried to create a logical operation on a non-integral type!");
826     break;
827   case SetLT: case SetGT: case SetLE:
828   case SetGE: case SetEQ: case SetNE:
829     assert(getType() == Type::BoolTy && "Setcc must return bool!");
830   default:
831     break;
832   }
833 #endif
834 }
835
836 BinaryOperator *BinaryOperator::create(BinaryOps Op, Value *S1, Value *S2,
837                                        const std::string &Name,
838                                        Instruction *InsertBefore) {
839   assert(S1->getType() == S2->getType() &&
840          "Cannot create binary operator with two operands of differing type!");
841   switch (Op) {
842   // Binary comparison operators...
843   case SetLT: case SetGT: case SetLE:
844   case SetGE: case SetEQ: case SetNE:
845     return new SetCondInst(Op, S1, S2, Name, InsertBefore);
846
847   default:
848     return new BinaryOperator(Op, S1, S2, S1->getType(), Name, InsertBefore);
849   }
850 }
851
852 BinaryOperator *BinaryOperator::create(BinaryOps Op, Value *S1, Value *S2,
853                                        const std::string &Name,
854                                        BasicBlock *InsertAtEnd) {
855   BinaryOperator *Res = create(Op, S1, S2, Name);
856   InsertAtEnd->getInstList().push_back(Res);
857   return Res;
858 }
859
860 BinaryOperator *BinaryOperator::createNeg(Value *Op, const std::string &Name,
861                                           Instruction *InsertBefore) {
862   if (!Op->getType()->isFloatingPoint())
863     return new BinaryOperator(Instruction::Sub,
864                               Constant::getNullValue(Op->getType()), Op,
865                               Op->getType(), Name, InsertBefore);
866   else
867     return new BinaryOperator(Instruction::Sub,
868                               ConstantFP::get(Op->getType(), -0.0), Op,
869                               Op->getType(), Name, InsertBefore);
870 }
871
872 BinaryOperator *BinaryOperator::createNeg(Value *Op, const std::string &Name,
873                                           BasicBlock *InsertAtEnd) {
874   if (!Op->getType()->isFloatingPoint())
875     return new BinaryOperator(Instruction::Sub,
876                               Constant::getNullValue(Op->getType()), Op,
877                               Op->getType(), Name, InsertAtEnd);
878   else
879     return new BinaryOperator(Instruction::Sub,
880                               ConstantFP::get(Op->getType(), -0.0), Op,
881                               Op->getType(), Name, InsertAtEnd);
882 }
883
884 BinaryOperator *BinaryOperator::createNot(Value *Op, const std::string &Name,
885                                           Instruction *InsertBefore) {
886   return new BinaryOperator(Instruction::Xor, Op,
887                             ConstantIntegral::getAllOnesValue(Op->getType()),
888                             Op->getType(), Name, InsertBefore);
889 }
890
891 BinaryOperator *BinaryOperator::createNot(Value *Op, const std::string &Name,
892                                           BasicBlock *InsertAtEnd) {
893   Constant *AllOnes;
894   if (const PackedType *PTy = dyn_cast<PackedType>(Op->getType())) {
895     // Create a vector of all ones values.
896     Constant *Elt = ConstantIntegral::getAllOnesValue(PTy->getElementType());
897     AllOnes = 
898       ConstantPacked::get(std::vector<Constant*>(PTy->getNumElements(), Elt));
899   } else {
900     AllOnes = ConstantIntegral::getAllOnesValue(Op->getType());
901   }
902   
903   return new BinaryOperator(Instruction::Xor, Op, AllOnes,
904                             Op->getType(), Name, InsertAtEnd);
905 }
906
907
908 // isConstantAllOnes - Helper function for several functions below
909 static inline bool isConstantAllOnes(const Value *V) {
910   return isa<ConstantIntegral>(V) &&cast<ConstantIntegral>(V)->isAllOnesValue();
911 }
912
913 bool BinaryOperator::isNeg(const Value *V) {
914   if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
915     if (Bop->getOpcode() == Instruction::Sub)
916       if (!V->getType()->isFloatingPoint())
917         return Bop->getOperand(0) == Constant::getNullValue(Bop->getType());
918       else
919         return Bop->getOperand(0) == ConstantFP::get(Bop->getType(), -0.0);
920   return false;
921 }
922
923 bool BinaryOperator::isNot(const Value *V) {
924   if (const BinaryOperator *Bop = dyn_cast<BinaryOperator>(V))
925     return (Bop->getOpcode() == Instruction::Xor &&
926             (isConstantAllOnes(Bop->getOperand(1)) ||
927              isConstantAllOnes(Bop->getOperand(0))));
928   return false;
929 }
930
931 Value *BinaryOperator::getNegArgument(Value *BinOp) {
932   assert(isNeg(BinOp) && "getNegArgument from non-'neg' instruction!");
933   return cast<BinaryOperator>(BinOp)->getOperand(1);
934 }
935
936 const Value *BinaryOperator::getNegArgument(const Value *BinOp) {
937   return getNegArgument(const_cast<Value*>(BinOp));
938 }
939
940 Value *BinaryOperator::getNotArgument(Value *BinOp) {
941   assert(isNot(BinOp) && "getNotArgument on non-'not' instruction!");
942   BinaryOperator *BO = cast<BinaryOperator>(BinOp);
943   Value *Op0 = BO->getOperand(0);
944   Value *Op1 = BO->getOperand(1);
945   if (isConstantAllOnes(Op0)) return Op1;
946
947   assert(isConstantAllOnes(Op1));
948   return Op0;
949 }
950
951 const Value *BinaryOperator::getNotArgument(const Value *BinOp) {
952   return getNotArgument(const_cast<Value*>(BinOp));
953 }
954
955
956 // swapOperands - Exchange the two operands to this instruction.  This
957 // instruction is safe to use on any binary instruction and does not
958 // modify the semantics of the instruction.  If the instruction is
959 // order dependent (SetLT f.e.) the opcode is changed.
960 //
961 bool BinaryOperator::swapOperands() {
962   if (isCommutative())
963     ;  // If the instruction is commutative, it is safe to swap the operands
964   else if (SetCondInst *SCI = dyn_cast<SetCondInst>(this))
965     /// FIXME: SetCC instructions shouldn't all have different opcodes.
966     setOpcode(SCI->getSwappedCondition());
967   else
968     return true;   // Can't commute operands
969
970   std::swap(Ops[0], Ops[1]);
971   return false;
972 }
973
974
975 //===----------------------------------------------------------------------===//
976 //                             SetCondInst Class
977 //===----------------------------------------------------------------------===//
978
979 SetCondInst::SetCondInst(BinaryOps Opcode, Value *S1, Value *S2,
980                          const std::string &Name, Instruction *InsertBefore)
981   : BinaryOperator(Opcode, S1, S2, Type::BoolTy, Name, InsertBefore) {
982
983   // Make sure it's a valid type... getInverseCondition will assert out if not.
984   assert(getInverseCondition(Opcode));
985 }
986
987 SetCondInst::SetCondInst(BinaryOps Opcode, Value *S1, Value *S2,
988                          const std::string &Name, BasicBlock *InsertAtEnd)
989   : BinaryOperator(Opcode, S1, S2, Type::BoolTy, Name, InsertAtEnd) {
990
991   // Make sure it's a valid type... getInverseCondition will assert out if not.
992   assert(getInverseCondition(Opcode));
993 }
994
995 // getInverseCondition - Return the inverse of the current condition opcode.
996 // For example seteq -> setne, setgt -> setle, setlt -> setge, etc...
997 //
998 Instruction::BinaryOps SetCondInst::getInverseCondition(BinaryOps Opcode) {
999   switch (Opcode) {
1000   default:
1001     assert(0 && "Unknown setcc opcode!");
1002   case SetEQ: return SetNE;
1003   case SetNE: return SetEQ;
1004   case SetGT: return SetLE;
1005   case SetLT: return SetGE;
1006   case SetGE: return SetLT;
1007   case SetLE: return SetGT;
1008   }
1009 }
1010
1011 // getSwappedCondition - Return the condition opcode that would be the result
1012 // of exchanging the two operands of the setcc instruction without changing
1013 // the result produced.  Thus, seteq->seteq, setle->setge, setlt->setgt, etc.
1014 //
1015 Instruction::BinaryOps SetCondInst::getSwappedCondition(BinaryOps Opcode) {
1016   switch (Opcode) {
1017   default: assert(0 && "Unknown setcc instruction!");
1018   case SetEQ: case SetNE: return Opcode;
1019   case SetGT: return SetLT;
1020   case SetLT: return SetGT;
1021   case SetGE: return SetLE;
1022   case SetLE: return SetGE;
1023   }
1024 }
1025
1026 //===----------------------------------------------------------------------===//
1027 //                        SwitchInst Implementation
1028 //===----------------------------------------------------------------------===//
1029
1030 void SwitchInst::init(Value *Value, BasicBlock *Default, unsigned NumCases) {
1031   assert(Value && Default);
1032   ReservedSpace = 2+NumCases*2;
1033   NumOperands = 2;
1034   OperandList = new Use[ReservedSpace];
1035
1036   OperandList[0].init(Value, this);
1037   OperandList[1].init(Default, this);
1038 }
1039
1040 SwitchInst::SwitchInst(const SwitchInst &SI)
1041   : TerminatorInst(Instruction::Switch, new Use[SI.getNumOperands()],
1042                    SI.getNumOperands()) {
1043   Use *OL = OperandList, *InOL = SI.OperandList;
1044   for (unsigned i = 0, E = SI.getNumOperands(); i != E; i+=2) {
1045     OL[i].init(InOL[i], this);
1046     OL[i+1].init(InOL[i+1], this);
1047   }
1048 }
1049
1050 SwitchInst::~SwitchInst() {
1051   delete [] OperandList;
1052 }
1053
1054
1055 /// addCase - Add an entry to the switch instruction...
1056 ///
1057 void SwitchInst::addCase(ConstantInt *OnVal, BasicBlock *Dest) {
1058   unsigned OpNo = NumOperands;
1059   if (OpNo+2 > ReservedSpace)
1060     resizeOperands(0);  // Get more space!
1061   // Initialize some new operands.
1062   assert(OpNo+1 < ReservedSpace && "Growing didn't work!");
1063   NumOperands = OpNo+2;
1064   OperandList[OpNo].init(OnVal, this);
1065   OperandList[OpNo+1].init(Dest, this);
1066 }
1067
1068 /// removeCase - This method removes the specified successor from the switch
1069 /// instruction.  Note that this cannot be used to remove the default
1070 /// destination (successor #0).
1071 ///
1072 void SwitchInst::removeCase(unsigned idx) {
1073   assert(idx != 0 && "Cannot remove the default case!");
1074   assert(idx*2 < getNumOperands() && "Successor index out of range!!!");
1075
1076   unsigned NumOps = getNumOperands();
1077   Use *OL = OperandList;
1078
1079   // Move everything after this operand down.
1080   //
1081   // FIXME: we could just swap with the end of the list, then erase.  However,
1082   // client might not expect this to happen.  The code as it is thrashes the
1083   // use/def lists, which is kinda lame.
1084   for (unsigned i = (idx+1)*2; i != NumOps; i += 2) {
1085     OL[i-2] = OL[i];
1086     OL[i-2+1] = OL[i+1];
1087   }
1088
1089   // Nuke the last value.
1090   OL[NumOps-2].set(0);
1091   OL[NumOps-2+1].set(0);
1092   NumOperands = NumOps-2;
1093 }
1094
1095 /// resizeOperands - resize operands - This adjusts the length of the operands
1096 /// list according to the following behavior:
1097 ///   1. If NumOps == 0, grow the operand list in response to a push_back style
1098 ///      of operation.  This grows the number of ops by 1.5 times.
1099 ///   2. If NumOps > NumOperands, reserve space for NumOps operands.
1100 ///   3. If NumOps == NumOperands, trim the reserved space.
1101 ///
1102 void SwitchInst::resizeOperands(unsigned NumOps) {
1103   if (NumOps == 0) {
1104     NumOps = getNumOperands()/2*6;
1105   } else if (NumOps*2 > NumOperands) {
1106     // No resize needed.
1107     if (ReservedSpace >= NumOps) return;
1108   } else if (NumOps == NumOperands) {
1109     if (ReservedSpace == NumOps) return;
1110   } else {
1111     return;
1112   }
1113
1114   ReservedSpace = NumOps;
1115   Use *NewOps = new Use[NumOps];
1116   Use *OldOps = OperandList;
1117   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
1118       NewOps[i].init(OldOps[i], this);
1119       OldOps[i].set(0);
1120   }
1121   delete [] OldOps;
1122   OperandList = NewOps;
1123 }
1124
1125
1126 BasicBlock *SwitchInst::getSuccessorV(unsigned idx) const {
1127   return getSuccessor(idx);
1128 }
1129 unsigned SwitchInst::getNumSuccessorsV() const {
1130   return getNumSuccessors();
1131 }
1132 void SwitchInst::setSuccessorV(unsigned idx, BasicBlock *B) {
1133   setSuccessor(idx, B);
1134 }
1135
1136
1137 // Define these methods here so vtables don't get emitted into every translation
1138 // unit that uses these classes.
1139
1140 GetElementPtrInst *GetElementPtrInst::clone() const {
1141   return new GetElementPtrInst(*this);
1142 }
1143
1144 BinaryOperator *BinaryOperator::clone() const {
1145   return create(getOpcode(), Ops[0], Ops[1]);
1146 }
1147
1148 MallocInst *MallocInst::clone() const { return new MallocInst(*this); }
1149 AllocaInst *AllocaInst::clone() const { return new AllocaInst(*this); }
1150 FreeInst   *FreeInst::clone()   const { return new FreeInst(getOperand(0)); }
1151 LoadInst   *LoadInst::clone()   const { return new LoadInst(*this); }
1152 StoreInst  *StoreInst::clone()  const { return new StoreInst(*this); }
1153 CastInst   *CastInst::clone()   const { return new CastInst(*this); }
1154 CallInst   *CallInst::clone()   const { return new CallInst(*this); }
1155 ShiftInst  *ShiftInst::clone()  const { return new ShiftInst(*this); }
1156 SelectInst *SelectInst::clone() const { return new SelectInst(*this); }
1157 VAArgInst  *VAArgInst::clone()  const { return new VAArgInst(*this); }
1158 PHINode    *PHINode::clone()    const { return new PHINode(*this); }
1159 ReturnInst *ReturnInst::clone() const { return new ReturnInst(*this); }
1160 BranchInst *BranchInst::clone() const { return new BranchInst(*this); }
1161 SwitchInst *SwitchInst::clone() const { return new SwitchInst(*this); }
1162 InvokeInst *InvokeInst::clone() const { return new InvokeInst(*this); }
1163 UnwindInst *UnwindInst::clone() const { return new UnwindInst(); }
1164 UnreachableInst *UnreachableInst::clone() const { return new UnreachableInst();}