API changes for class Use size reduction, wave 1.
[oota-llvm.git] / lib / VMCore / Constants.cpp
1 //===-- Constants.cpp - Implement Constant nodes --------------------------===//
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 the Constant* classes...
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "llvm/Constants.h"
15 #include "ConstantFold.h"
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/GlobalValue.h"
18 #include "llvm/Instructions.h"
19 #include "llvm/Module.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/Support/Compiler.h"
22 #include "llvm/Support/Debug.h"
23 #include "llvm/Support/ManagedStatic.h"
24 #include "llvm/Support/MathExtras.h"
25 #include "llvm/ADT/DenseMap.h"
26 #include "llvm/ADT/SmallVector.h"
27 #include <algorithm>
28 #include <map>
29 using namespace llvm;
30
31 //===----------------------------------------------------------------------===//
32 //                              Constant Class
33 //===----------------------------------------------------------------------===//
34
35 void Constant::destroyConstantImpl() {
36   // When a Constant is destroyed, there may be lingering
37   // references to the constant by other constants in the constant pool.  These
38   // constants are implicitly dependent on the module that is being deleted,
39   // but they don't know that.  Because we only find out when the CPV is
40   // deleted, we must now notify all of our users (that should only be
41   // Constants) that they are, in fact, invalid now and should be deleted.
42   //
43   while (!use_empty()) {
44     Value *V = use_back();
45 #ifndef NDEBUG      // Only in -g mode...
46     if (!isa<Constant>(V))
47       DOUT << "While deleting: " << *this
48            << "\n\nUse still stuck around after Def is destroyed: "
49            << *V << "\n\n";
50 #endif
51     assert(isa<Constant>(V) && "References remain to Constant being destroyed");
52     Constant *CV = cast<Constant>(V);
53     CV->destroyConstant();
54
55     // The constant should remove itself from our use list...
56     assert((use_empty() || use_back() != V) && "Constant not removed!");
57   }
58
59   // Value has no outstanding references it is safe to delete it now...
60   delete this;
61 }
62
63 /// canTrap - Return true if evaluation of this constant could trap.  This is
64 /// true for things like constant expressions that could divide by zero.
65 bool Constant::canTrap() const {
66   assert(getType()->isFirstClassType() && "Cannot evaluate aggregate vals!");
67   // The only thing that could possibly trap are constant exprs.
68   const ConstantExpr *CE = dyn_cast<ConstantExpr>(this);
69   if (!CE) return false;
70   
71   // ConstantExpr traps if any operands can trap. 
72   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
73     if (getOperand(i)->canTrap()) 
74       return true;
75
76   // Otherwise, only specific operations can trap.
77   switch (CE->getOpcode()) {
78   default:
79     return false;
80   case Instruction::UDiv:
81   case Instruction::SDiv:
82   case Instruction::FDiv:
83   case Instruction::URem:
84   case Instruction::SRem:
85   case Instruction::FRem:
86     // Div and rem can trap if the RHS is not known to be non-zero.
87     if (!isa<ConstantInt>(getOperand(1)) || getOperand(1)->isNullValue())
88       return true;
89     return false;
90   }
91 }
92
93 /// ContaintsRelocations - Return true if the constant value contains
94 /// relocations which cannot be resolved at compile time.
95 bool Constant::ContainsRelocations() const {
96   if (isa<GlobalValue>(this))
97     return true;
98   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
99     if (getOperand(i)->ContainsRelocations())
100       return true;
101   return false;
102 }
103
104 // Static constructor to create a '0' constant of arbitrary type...
105 Constant *Constant::getNullValue(const Type *Ty) {
106   static uint64_t zero[2] = {0, 0};
107   switch (Ty->getTypeID()) {
108   case Type::IntegerTyID:
109     return ConstantInt::get(Ty, 0);
110   case Type::FloatTyID:
111     return ConstantFP::get(Ty, APFloat(APInt(32, 0)));
112   case Type::DoubleTyID:
113     return ConstantFP::get(Ty, APFloat(APInt(64, 0)));
114   case Type::X86_FP80TyID:
115     return ConstantFP::get(Ty, APFloat(APInt(80, 2, zero)));
116   case Type::FP128TyID:
117     return ConstantFP::get(Ty, APFloat(APInt(128, 2, zero), true));
118   case Type::PPC_FP128TyID:
119     return ConstantFP::get(Ty, APFloat(APInt(128, 2, zero)));
120   case Type::PointerTyID:
121     return ConstantPointerNull::get(cast<PointerType>(Ty));
122   case Type::StructTyID:
123   case Type::ArrayTyID:
124   case Type::VectorTyID:
125     return ConstantAggregateZero::get(Ty);
126   default:
127     // Function, Label, or Opaque type?
128     assert(!"Cannot create a null constant of that type!");
129     return 0;
130   }
131 }
132
133 Constant *Constant::getAllOnesValue(const Type *Ty) {
134   if (const IntegerType* ITy = dyn_cast<IntegerType>(Ty))
135     return ConstantInt::get(APInt::getAllOnesValue(ITy->getBitWidth()));
136   return ConstantVector::getAllOnesValue(cast<VectorType>(Ty));
137 }
138
139 // Static constructor to create an integral constant with all bits set
140 ConstantInt *ConstantInt::getAllOnesValue(const Type *Ty) {
141   if (const IntegerType* ITy = dyn_cast<IntegerType>(Ty))
142     return ConstantInt::get(APInt::getAllOnesValue(ITy->getBitWidth()));
143   return 0;
144 }
145
146 /// @returns the value for a vector integer constant of the given type that
147 /// has all its bits set to true.
148 /// @brief Get the all ones value
149 ConstantVector *ConstantVector::getAllOnesValue(const VectorType *Ty) {
150   std::vector<Constant*> Elts;
151   Elts.resize(Ty->getNumElements(),
152               ConstantInt::getAllOnesValue(Ty->getElementType()));
153   assert(Elts[0] && "Not a vector integer type!");
154   return cast<ConstantVector>(ConstantVector::get(Elts));
155 }
156
157
158 //===----------------------------------------------------------------------===//
159 //                                ConstantInt
160 //===----------------------------------------------------------------------===//
161
162 ConstantInt::ConstantInt(const IntegerType *Ty, const APInt& V)
163   : Constant(Ty, ConstantIntVal, 0, 0), Val(V) {
164   assert(V.getBitWidth() == Ty->getBitWidth() && "Invalid constant for type");
165 }
166
167 ConstantInt *ConstantInt::TheTrueVal = 0;
168 ConstantInt *ConstantInt::TheFalseVal = 0;
169
170 namespace llvm {
171   void CleanupTrueFalse(void *) {
172     ConstantInt::ResetTrueFalse();
173   }
174 }
175
176 static ManagedCleanup<llvm::CleanupTrueFalse> TrueFalseCleanup;
177
178 ConstantInt *ConstantInt::CreateTrueFalseVals(bool WhichOne) {
179   assert(TheTrueVal == 0 && TheFalseVal == 0);
180   TheTrueVal  = get(Type::Int1Ty, 1);
181   TheFalseVal = get(Type::Int1Ty, 0);
182   
183   // Ensure that llvm_shutdown nulls out TheTrueVal/TheFalseVal.
184   TrueFalseCleanup.Register();
185   
186   return WhichOne ? TheTrueVal : TheFalseVal;
187 }
188
189
190 namespace {
191   struct DenseMapAPIntKeyInfo {
192     struct KeyTy {
193       APInt val;
194       const Type* type;
195       KeyTy(const APInt& V, const Type* Ty) : val(V), type(Ty) {}
196       KeyTy(const KeyTy& that) : val(that.val), type(that.type) {}
197       bool operator==(const KeyTy& that) const {
198         return type == that.type && this->val == that.val;
199       }
200       bool operator!=(const KeyTy& that) const {
201         return !this->operator==(that);
202       }
203     };
204     static inline KeyTy getEmptyKey() { return KeyTy(APInt(1,0), 0); }
205     static inline KeyTy getTombstoneKey() { return KeyTy(APInt(1,1), 0); }
206     static unsigned getHashValue(const KeyTy &Key) {
207       return DenseMapInfo<void*>::getHashValue(Key.type) ^ 
208         Key.val.getHashValue();
209     }
210     static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
211       return LHS == RHS;
212     }
213     static bool isPod() { return false; }
214   };
215 }
216
217
218 typedef DenseMap<DenseMapAPIntKeyInfo::KeyTy, ConstantInt*, 
219                  DenseMapAPIntKeyInfo> IntMapTy;
220 static ManagedStatic<IntMapTy> IntConstants;
221
222 ConstantInt *ConstantInt::get(const Type *Ty, uint64_t V, bool isSigned) {
223   const IntegerType *ITy = cast<IntegerType>(Ty);
224   return get(APInt(ITy->getBitWidth(), V, isSigned));
225 }
226
227 // Get a ConstantInt from an APInt. Note that the value stored in the DenseMap 
228 // as the key, is a DenseMapAPIntKeyInfo::KeyTy which has provided the
229 // operator== and operator!= to ensure that the DenseMap doesn't attempt to
230 // compare APInt's of different widths, which would violate an APInt class
231 // invariant which generates an assertion.
232 ConstantInt *ConstantInt::get(const APInt& V) {
233   // Get the corresponding integer type for the bit width of the value.
234   const IntegerType *ITy = IntegerType::get(V.getBitWidth());
235   // get an existing value or the insertion position
236   DenseMapAPIntKeyInfo::KeyTy Key(V, ITy);
237   ConstantInt *&Slot = (*IntConstants)[Key]; 
238   // if it exists, return it.
239   if (Slot)
240     return Slot;
241   // otherwise create a new one, insert it, and return it.
242   return Slot = new ConstantInt(ITy, V);
243 }
244
245 //===----------------------------------------------------------------------===//
246 //                                ConstantFP
247 //===----------------------------------------------------------------------===//
248
249 ConstantFP::ConstantFP(const Type *Ty, const APFloat& V)
250   : Constant(Ty, ConstantFPVal, 0, 0), Val(V) {
251   // temporary
252   if (Ty==Type::FloatTy)
253     assert(&V.getSemantics()==&APFloat::IEEEsingle);
254   else if (Ty==Type::DoubleTy)
255     assert(&V.getSemantics()==&APFloat::IEEEdouble);
256   else if (Ty==Type::X86_FP80Ty)
257     assert(&V.getSemantics()==&APFloat::x87DoubleExtended);
258   else if (Ty==Type::FP128Ty)
259     assert(&V.getSemantics()==&APFloat::IEEEquad);
260   else if (Ty==Type::PPC_FP128Ty)
261     assert(&V.getSemantics()==&APFloat::PPCDoubleDouble);
262   else
263     assert(0);
264 }
265
266 bool ConstantFP::isNullValue() const {
267   return Val.isZero() && !Val.isNegative();
268 }
269
270 ConstantFP *ConstantFP::getNegativeZero(const Type *Ty) {
271   APFloat apf = cast <ConstantFP>(Constant::getNullValue(Ty))->getValueAPF();
272   apf.changeSign();
273   return ConstantFP::get(Ty, apf);
274 }
275
276 bool ConstantFP::isExactlyValue(const APFloat& V) const {
277   return Val.bitwiseIsEqual(V);
278 }
279
280 namespace {
281   struct DenseMapAPFloatKeyInfo {
282     struct KeyTy {
283       APFloat val;
284       KeyTy(const APFloat& V) : val(V){}
285       KeyTy(const KeyTy& that) : val(that.val) {}
286       bool operator==(const KeyTy& that) const {
287         return this->val.bitwiseIsEqual(that.val);
288       }
289       bool operator!=(const KeyTy& that) const {
290         return !this->operator==(that);
291       }
292     };
293     static inline KeyTy getEmptyKey() { 
294       return KeyTy(APFloat(APFloat::Bogus,1));
295     }
296     static inline KeyTy getTombstoneKey() { 
297       return KeyTy(APFloat(APFloat::Bogus,2)); 
298     }
299     static unsigned getHashValue(const KeyTy &Key) {
300       return Key.val.getHashValue();
301     }
302     static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {
303       return LHS == RHS;
304     }
305     static bool isPod() { return false; }
306   };
307 }
308
309 //---- ConstantFP::get() implementation...
310 //
311 typedef DenseMap<DenseMapAPFloatKeyInfo::KeyTy, ConstantFP*, 
312                  DenseMapAPFloatKeyInfo> FPMapTy;
313
314 static ManagedStatic<FPMapTy> FPConstants;
315
316 ConstantFP *ConstantFP::get(const Type *Ty, const APFloat& V) {
317   // temporary
318   if (Ty==Type::FloatTy)
319     assert(&V.getSemantics()==&APFloat::IEEEsingle);
320   else if (Ty==Type::DoubleTy)
321     assert(&V.getSemantics()==&APFloat::IEEEdouble);
322   else if (Ty==Type::X86_FP80Ty)
323     assert(&V.getSemantics()==&APFloat::x87DoubleExtended);
324   else if (Ty==Type::FP128Ty)
325     assert(&V.getSemantics()==&APFloat::IEEEquad);
326   else if (Ty==Type::PPC_FP128Ty)
327     assert(&V.getSemantics()==&APFloat::PPCDoubleDouble);
328   else
329     assert(0);
330   
331   DenseMapAPFloatKeyInfo::KeyTy Key(V);
332   ConstantFP *&Slot = (*FPConstants)[Key];
333   if (Slot) return Slot;
334   return Slot = new ConstantFP(Ty, V);
335 }
336
337 //===----------------------------------------------------------------------===//
338 //                            ConstantXXX Classes
339 //===----------------------------------------------------------------------===//
340
341
342 ConstantArray::ConstantArray(const ArrayType *T,
343                              const std::vector<Constant*> &V)
344   : Constant(T, ConstantArrayVal, new Use[V.size()], V.size()) {
345   assert(V.size() == T->getNumElements() &&
346          "Invalid initializer vector for constant array");
347   Use *OL = OperandList;
348   for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
349        I != E; ++I, ++OL) {
350     Constant *C = *I;
351     assert((C->getType() == T->getElementType() ||
352             (T->isAbstract() &&
353              C->getType()->getTypeID() == T->getElementType()->getTypeID())) &&
354            "Initializer for array element doesn't match array element type!");
355     OL->init(C, this);
356   }
357 }
358
359 ConstantArray::~ConstantArray() {
360   delete [] OperandList;
361 }
362
363 ConstantStruct::ConstantStruct(const StructType *T,
364                                const std::vector<Constant*> &V)
365   : Constant(T, ConstantStructVal, new Use[V.size()], V.size()) {
366   assert(V.size() == T->getNumElements() &&
367          "Invalid initializer vector for constant structure");
368   Use *OL = OperandList;
369   for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
370        I != E; ++I, ++OL) {
371     Constant *C = *I;
372     assert((C->getType() == T->getElementType(I-V.begin()) ||
373             ((T->getElementType(I-V.begin())->isAbstract() ||
374               C->getType()->isAbstract()) &&
375              T->getElementType(I-V.begin())->getTypeID() == 
376                    C->getType()->getTypeID())) &&
377            "Initializer for struct element doesn't match struct element type!");
378     OL->init(C, this);
379   }
380 }
381
382 ConstantStruct::~ConstantStruct() {
383   delete [] OperandList;
384 }
385
386
387 ConstantVector::ConstantVector(const VectorType *T,
388                                const std::vector<Constant*> &V)
389   : Constant(T, ConstantVectorVal, new Use[V.size()], V.size()) {
390   Use *OL = OperandList;
391     for (std::vector<Constant*>::const_iterator I = V.begin(), E = V.end();
392          I != E; ++I, ++OL) {
393       Constant *C = *I;
394       assert((C->getType() == T->getElementType() ||
395             (T->isAbstract() &&
396              C->getType()->getTypeID() == T->getElementType()->getTypeID())) &&
397            "Initializer for vector element doesn't match vector element type!");
398     OL->init(C, this);
399   }
400 }
401
402 ConstantVector::~ConstantVector() {
403   delete [] OperandList;
404 }
405
406 // We declare several classes private to this file, so use an anonymous
407 // namespace
408 namespace {
409
410 /// UnaryConstantExpr - This class is private to Constants.cpp, and is used
411 /// behind the scenes to implement unary constant exprs.
412 class VISIBILITY_HIDDEN UnaryConstantExpr : public ConstantExpr {
413   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
414   Use Op;
415 public:
416   // allocate space for exactly one operand
417   void *operator new(size_t s) {
418     return User::operator new(s, 1);
419   }
420   UnaryConstantExpr(unsigned Opcode, Constant *C, const Type *Ty)
421     : ConstantExpr(Ty, Opcode, &Op, 1), Op(C, this) {}
422 };
423
424 /// BinaryConstantExpr - This class is private to Constants.cpp, and is used
425 /// behind the scenes to implement binary constant exprs.
426 class VISIBILITY_HIDDEN BinaryConstantExpr : public ConstantExpr {
427   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
428   Use Ops[2];
429 public:
430   // allocate space for exactly two operands
431   void *operator new(size_t s) {
432     return User::operator new(s, 2);
433   }
434   BinaryConstantExpr(unsigned Opcode, Constant *C1, Constant *C2)
435     : ConstantExpr(C1->getType(), Opcode, Ops, 2) {
436     Ops[0].init(C1, this);
437     Ops[1].init(C2, this);
438   }
439 };
440
441 /// SelectConstantExpr - This class is private to Constants.cpp, and is used
442 /// behind the scenes to implement select constant exprs.
443 class VISIBILITY_HIDDEN SelectConstantExpr : public ConstantExpr {
444   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
445   Use Ops[3];
446 public:
447   // allocate space for exactly three operands
448   void *operator new(size_t s) {
449     return User::operator new(s, 3);
450   }
451   SelectConstantExpr(Constant *C1, Constant *C2, Constant *C3)
452     : ConstantExpr(C2->getType(), Instruction::Select, Ops, 3) {
453     Ops[0].init(C1, this);
454     Ops[1].init(C2, this);
455     Ops[2].init(C3, this);
456   }
457 };
458
459 /// ExtractElementConstantExpr - This class is private to
460 /// Constants.cpp, and is used behind the scenes to implement
461 /// extractelement constant exprs.
462 class VISIBILITY_HIDDEN ExtractElementConstantExpr : public ConstantExpr {
463   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
464   Use Ops[2];
465 public:
466   // allocate space for exactly two operands
467   void *operator new(size_t s) {
468     return User::operator new(s, 2);
469   }
470   ExtractElementConstantExpr(Constant *C1, Constant *C2)
471     : ConstantExpr(cast<VectorType>(C1->getType())->getElementType(), 
472                    Instruction::ExtractElement, Ops, 2) {
473     Ops[0].init(C1, this);
474     Ops[1].init(C2, this);
475   }
476 };
477
478 /// InsertElementConstantExpr - This class is private to
479 /// Constants.cpp, and is used behind the scenes to implement
480 /// insertelement constant exprs.
481 class VISIBILITY_HIDDEN InsertElementConstantExpr : public ConstantExpr {
482   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
483   Use Ops[3];
484 public:
485   // allocate space for exactly three operands
486   void *operator new(size_t s) {
487     return User::operator new(s, 3);
488   }
489   InsertElementConstantExpr(Constant *C1, Constant *C2, Constant *C3)
490     : ConstantExpr(C1->getType(), Instruction::InsertElement, 
491                    Ops, 3) {
492     Ops[0].init(C1, this);
493     Ops[1].init(C2, this);
494     Ops[2].init(C3, this);
495   }
496 };
497
498 /// ShuffleVectorConstantExpr - This class is private to
499 /// Constants.cpp, and is used behind the scenes to implement
500 /// shufflevector constant exprs.
501 class VISIBILITY_HIDDEN ShuffleVectorConstantExpr : public ConstantExpr {
502   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
503   Use Ops[3];
504 public:
505   // allocate space for exactly three operands
506   void *operator new(size_t s) {
507     return User::operator new(s, 3);
508   }
509   ShuffleVectorConstantExpr(Constant *C1, Constant *C2, Constant *C3)
510   : ConstantExpr(C1->getType(), Instruction::ShuffleVector, 
511                  Ops, 3) {
512     Ops[0].init(C1, this);
513     Ops[1].init(C2, this);
514     Ops[2].init(C3, this);
515   }
516 };
517
518 /// GetElementPtrConstantExpr - This class is private to Constants.cpp, and is
519 /// used behind the scenes to implement getelementpr constant exprs.
520 class VISIBILITY_HIDDEN GetElementPtrConstantExpr : public ConstantExpr {
521   GetElementPtrConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
522                             const Type *DestTy)
523     : ConstantExpr(DestTy, Instruction::GetElementPtr,
524                    new Use[IdxList.size()+1], IdxList.size()+1) {
525     OperandList[0].init(C, this);
526     for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
527       OperandList[i+1].init(IdxList[i], this);
528   }
529 public:
530   static GetElementPtrConstantExpr *Create(Constant *C, const std::vector<Constant*> &IdxList,
531                                     const Type *DestTy) {
532     return new(IdxList.size() + 1/*FIXME*/) GetElementPtrConstantExpr(C, IdxList, DestTy);
533   }
534   ~GetElementPtrConstantExpr() {
535     delete [] OperandList;
536   }
537 };
538
539 // CompareConstantExpr - This class is private to Constants.cpp, and is used
540 // behind the scenes to implement ICmp and FCmp constant expressions. This is
541 // needed in order to store the predicate value for these instructions.
542 struct VISIBILITY_HIDDEN CompareConstantExpr : public ConstantExpr {
543   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
544   // allocate space for exactly two operands
545   void *operator new(size_t s) {
546     return User::operator new(s, 2);
547   }
548   unsigned short predicate;
549   Use Ops[2];
550   CompareConstantExpr(Instruction::OtherOps opc, unsigned short pred, 
551                       Constant* LHS, Constant* RHS)
552     : ConstantExpr(Type::Int1Ty, opc, Ops, 2), predicate(pred) {
553     OperandList[0].init(LHS, this);
554     OperandList[1].init(RHS, this);
555   }
556 };
557
558 } // end anonymous namespace
559
560
561 // Utility function for determining if a ConstantExpr is a CastOp or not. This
562 // can't be inline because we don't want to #include Instruction.h into
563 // Constant.h
564 bool ConstantExpr::isCast() const {
565   return Instruction::isCast(getOpcode());
566 }
567
568 bool ConstantExpr::isCompare() const {
569   return getOpcode() == Instruction::ICmp || getOpcode() == Instruction::FCmp;
570 }
571
572 /// ConstantExpr::get* - Return some common constants without having to
573 /// specify the full Instruction::OPCODE identifier.
574 ///
575 Constant *ConstantExpr::getNeg(Constant *C) {
576   return get(Instruction::Sub,
577              ConstantExpr::getZeroValueForNegationExpr(C->getType()),
578              C);
579 }
580 Constant *ConstantExpr::getNot(Constant *C) {
581   assert(isa<IntegerType>(C->getType()) && "Cannot NOT a nonintegral value!");
582   return get(Instruction::Xor, C,
583              ConstantInt::getAllOnesValue(C->getType()));
584 }
585 Constant *ConstantExpr::getAdd(Constant *C1, Constant *C2) {
586   return get(Instruction::Add, C1, C2);
587 }
588 Constant *ConstantExpr::getSub(Constant *C1, Constant *C2) {
589   return get(Instruction::Sub, C1, C2);
590 }
591 Constant *ConstantExpr::getMul(Constant *C1, Constant *C2) {
592   return get(Instruction::Mul, C1, C2);
593 }
594 Constant *ConstantExpr::getUDiv(Constant *C1, Constant *C2) {
595   return get(Instruction::UDiv, C1, C2);
596 }
597 Constant *ConstantExpr::getSDiv(Constant *C1, Constant *C2) {
598   return get(Instruction::SDiv, C1, C2);
599 }
600 Constant *ConstantExpr::getFDiv(Constant *C1, Constant *C2) {
601   return get(Instruction::FDiv, C1, C2);
602 }
603 Constant *ConstantExpr::getURem(Constant *C1, Constant *C2) {
604   return get(Instruction::URem, C1, C2);
605 }
606 Constant *ConstantExpr::getSRem(Constant *C1, Constant *C2) {
607   return get(Instruction::SRem, C1, C2);
608 }
609 Constant *ConstantExpr::getFRem(Constant *C1, Constant *C2) {
610   return get(Instruction::FRem, C1, C2);
611 }
612 Constant *ConstantExpr::getAnd(Constant *C1, Constant *C2) {
613   return get(Instruction::And, C1, C2);
614 }
615 Constant *ConstantExpr::getOr(Constant *C1, Constant *C2) {
616   return get(Instruction::Or, C1, C2);
617 }
618 Constant *ConstantExpr::getXor(Constant *C1, Constant *C2) {
619   return get(Instruction::Xor, C1, C2);
620 }
621 unsigned ConstantExpr::getPredicate() const {
622   assert(getOpcode() == Instruction::FCmp || getOpcode() == Instruction::ICmp);
623   return ((const CompareConstantExpr*)this)->predicate;
624 }
625 Constant *ConstantExpr::getShl(Constant *C1, Constant *C2) {
626   return get(Instruction::Shl, C1, C2);
627 }
628 Constant *ConstantExpr::getLShr(Constant *C1, Constant *C2) {
629   return get(Instruction::LShr, C1, C2);
630 }
631 Constant *ConstantExpr::getAShr(Constant *C1, Constant *C2) {
632   return get(Instruction::AShr, C1, C2);
633 }
634
635 /// getWithOperandReplaced - Return a constant expression identical to this
636 /// one, but with the specified operand set to the specified value.
637 Constant *
638 ConstantExpr::getWithOperandReplaced(unsigned OpNo, Constant *Op) const {
639   assert(OpNo < getNumOperands() && "Operand num is out of range!");
640   assert(Op->getType() == getOperand(OpNo)->getType() &&
641          "Replacing operand with value of different type!");
642   if (getOperand(OpNo) == Op)
643     return const_cast<ConstantExpr*>(this);
644   
645   Constant *Op0, *Op1, *Op2;
646   switch (getOpcode()) {
647   case Instruction::Trunc:
648   case Instruction::ZExt:
649   case Instruction::SExt:
650   case Instruction::FPTrunc:
651   case Instruction::FPExt:
652   case Instruction::UIToFP:
653   case Instruction::SIToFP:
654   case Instruction::FPToUI:
655   case Instruction::FPToSI:
656   case Instruction::PtrToInt:
657   case Instruction::IntToPtr:
658   case Instruction::BitCast:
659     return ConstantExpr::getCast(getOpcode(), Op, getType());
660   case Instruction::Select:
661     Op0 = (OpNo == 0) ? Op : getOperand(0);
662     Op1 = (OpNo == 1) ? Op : getOperand(1);
663     Op2 = (OpNo == 2) ? Op : getOperand(2);
664     return ConstantExpr::getSelect(Op0, Op1, Op2);
665   case Instruction::InsertElement:
666     Op0 = (OpNo == 0) ? Op : getOperand(0);
667     Op1 = (OpNo == 1) ? Op : getOperand(1);
668     Op2 = (OpNo == 2) ? Op : getOperand(2);
669     return ConstantExpr::getInsertElement(Op0, Op1, Op2);
670   case Instruction::ExtractElement:
671     Op0 = (OpNo == 0) ? Op : getOperand(0);
672     Op1 = (OpNo == 1) ? Op : getOperand(1);
673     return ConstantExpr::getExtractElement(Op0, Op1);
674   case Instruction::ShuffleVector:
675     Op0 = (OpNo == 0) ? Op : getOperand(0);
676     Op1 = (OpNo == 1) ? Op : getOperand(1);
677     Op2 = (OpNo == 2) ? Op : getOperand(2);
678     return ConstantExpr::getShuffleVector(Op0, Op1, Op2);
679   case Instruction::GetElementPtr: {
680     SmallVector<Constant*, 8> Ops;
681     Ops.resize(getNumOperands());
682     for (unsigned i = 1, e = getNumOperands(); i != e; ++i)
683       Ops[i] = getOperand(i);
684     if (OpNo == 0)
685       return ConstantExpr::getGetElementPtr(Op, &Ops[0], Ops.size());
686     Ops[OpNo-1] = Op;
687     return ConstantExpr::getGetElementPtr(getOperand(0), &Ops[0], Ops.size());
688   }
689   default:
690     assert(getNumOperands() == 2 && "Must be binary operator?");
691     Op0 = (OpNo == 0) ? Op : getOperand(0);
692     Op1 = (OpNo == 1) ? Op : getOperand(1);
693     return ConstantExpr::get(getOpcode(), Op0, Op1);
694   }
695 }
696
697 /// getWithOperands - This returns the current constant expression with the
698 /// operands replaced with the specified values.  The specified operands must
699 /// match count and type with the existing ones.
700 Constant *ConstantExpr::
701 getWithOperands(const std::vector<Constant*> &Ops) const {
702   assert(Ops.size() == getNumOperands() && "Operand count mismatch!");
703   bool AnyChange = false;
704   for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
705     assert(Ops[i]->getType() == getOperand(i)->getType() &&
706            "Operand type mismatch!");
707     AnyChange |= Ops[i] != getOperand(i);
708   }
709   if (!AnyChange)  // No operands changed, return self.
710     return const_cast<ConstantExpr*>(this);
711
712   switch (getOpcode()) {
713   case Instruction::Trunc:
714   case Instruction::ZExt:
715   case Instruction::SExt:
716   case Instruction::FPTrunc:
717   case Instruction::FPExt:
718   case Instruction::UIToFP:
719   case Instruction::SIToFP:
720   case Instruction::FPToUI:
721   case Instruction::FPToSI:
722   case Instruction::PtrToInt:
723   case Instruction::IntToPtr:
724   case Instruction::BitCast:
725     return ConstantExpr::getCast(getOpcode(), Ops[0], getType());
726   case Instruction::Select:
727     return ConstantExpr::getSelect(Ops[0], Ops[1], Ops[2]);
728   case Instruction::InsertElement:
729     return ConstantExpr::getInsertElement(Ops[0], Ops[1], Ops[2]);
730   case Instruction::ExtractElement:
731     return ConstantExpr::getExtractElement(Ops[0], Ops[1]);
732   case Instruction::ShuffleVector:
733     return ConstantExpr::getShuffleVector(Ops[0], Ops[1], Ops[2]);
734   case Instruction::GetElementPtr:
735     return ConstantExpr::getGetElementPtr(Ops[0], &Ops[1], Ops.size()-1);
736   case Instruction::ICmp:
737   case Instruction::FCmp:
738     return ConstantExpr::getCompare(getPredicate(), Ops[0], Ops[1]);
739   default:
740     assert(getNumOperands() == 2 && "Must be binary operator?");
741     return ConstantExpr::get(getOpcode(), Ops[0], Ops[1]);
742   }
743 }
744
745
746 //===----------------------------------------------------------------------===//
747 //                      isValueValidForType implementations
748
749 bool ConstantInt::isValueValidForType(const Type *Ty, uint64_t Val) {
750   unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
751   if (Ty == Type::Int1Ty)
752     return Val == 0 || Val == 1;
753   if (NumBits >= 64)
754     return true; // always true, has to fit in largest type
755   uint64_t Max = (1ll << NumBits) - 1;
756   return Val <= Max;
757 }
758
759 bool ConstantInt::isValueValidForType(const Type *Ty, int64_t Val) {
760   unsigned NumBits = cast<IntegerType>(Ty)->getBitWidth(); // assert okay
761   if (Ty == Type::Int1Ty)
762     return Val == 0 || Val == 1 || Val == -1;
763   if (NumBits >= 64)
764     return true; // always true, has to fit in largest type
765   int64_t Min = -(1ll << (NumBits-1));
766   int64_t Max = (1ll << (NumBits-1)) - 1;
767   return (Val >= Min && Val <= Max);
768 }
769
770 bool ConstantFP::isValueValidForType(const Type *Ty, const APFloat& Val) {
771   // convert modifies in place, so make a copy.
772   APFloat Val2 = APFloat(Val);
773   switch (Ty->getTypeID()) {
774   default:
775     return false;         // These can't be represented as floating point!
776
777   // FIXME rounding mode needs to be more flexible
778   case Type::FloatTyID:
779     return &Val2.getSemantics() == &APFloat::IEEEsingle ||
780            Val2.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven) == 
781               APFloat::opOK;
782   case Type::DoubleTyID:
783     return &Val2.getSemantics() == &APFloat::IEEEsingle || 
784            &Val2.getSemantics() == &APFloat::IEEEdouble ||
785            Val2.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven) == 
786              APFloat::opOK;
787   case Type::X86_FP80TyID:
788     return &Val2.getSemantics() == &APFloat::IEEEsingle || 
789            &Val2.getSemantics() == &APFloat::IEEEdouble ||
790            &Val2.getSemantics() == &APFloat::x87DoubleExtended;
791   case Type::FP128TyID:
792     return &Val2.getSemantics() == &APFloat::IEEEsingle || 
793            &Val2.getSemantics() == &APFloat::IEEEdouble ||
794            &Val2.getSemantics() == &APFloat::IEEEquad;
795   case Type::PPC_FP128TyID:
796     return &Val2.getSemantics() == &APFloat::IEEEsingle || 
797            &Val2.getSemantics() == &APFloat::IEEEdouble ||
798            &Val2.getSemantics() == &APFloat::PPCDoubleDouble;
799   }
800 }
801
802 //===----------------------------------------------------------------------===//
803 //                      Factory Function Implementation
804
805 // ConstantCreator - A class that is used to create constants by
806 // ValueMap*.  This class should be partially specialized if there is
807 // something strange that needs to be done to interface to the ctor for the
808 // constant.
809 //
810 namespace llvm {
811   template<class ConstantClass, class TypeClass, class ValType>
812   struct VISIBILITY_HIDDEN ConstantCreator {
813     static ConstantClass *create(const TypeClass *Ty, const ValType &V) {
814       unsigned FIXME; // = traits<ValType>::uses(V)
815       return new(FIXME) ConstantClass(Ty, V);
816     }
817   };
818
819   template<class ConstantClass, class TypeClass>
820   struct VISIBILITY_HIDDEN ConvertConstantType {
821     static void convert(ConstantClass *OldC, const TypeClass *NewTy) {
822       assert(0 && "This type cannot be converted!\n");
823       abort();
824     }
825   };
826
827   template<class ValType, class TypeClass, class ConstantClass,
828            bool HasLargeKey = false  /*true for arrays and structs*/ >
829   class VISIBILITY_HIDDEN ValueMap : public AbstractTypeUser {
830   public:
831     typedef std::pair<const Type*, ValType> MapKey;
832     typedef std::map<MapKey, Constant *> MapTy;
833     typedef std::map<Constant*, typename MapTy::iterator> InverseMapTy;
834     typedef std::map<const Type*, typename MapTy::iterator> AbstractTypeMapTy;
835   private:
836     /// Map - This is the main map from the element descriptor to the Constants.
837     /// This is the primary way we avoid creating two of the same shape
838     /// constant.
839     MapTy Map;
840     
841     /// InverseMap - If "HasLargeKey" is true, this contains an inverse mapping
842     /// from the constants to their element in Map.  This is important for
843     /// removal of constants from the array, which would otherwise have to scan
844     /// through the map with very large keys.
845     InverseMapTy InverseMap;
846
847     /// AbstractTypeMap - Map for abstract type constants.
848     ///
849     AbstractTypeMapTy AbstractTypeMap;
850
851   public:
852     typename MapTy::iterator map_end() { return Map.end(); }
853     
854     /// InsertOrGetItem - Return an iterator for the specified element.
855     /// If the element exists in the map, the returned iterator points to the
856     /// entry and Exists=true.  If not, the iterator points to the newly
857     /// inserted entry and returns Exists=false.  Newly inserted entries have
858     /// I->second == 0, and should be filled in.
859     typename MapTy::iterator InsertOrGetItem(std::pair<MapKey, Constant *>
860                                    &InsertVal,
861                                    bool &Exists) {
862       std::pair<typename MapTy::iterator, bool> IP = Map.insert(InsertVal);
863       Exists = !IP.second;
864       return IP.first;
865     }
866     
867 private:
868     typename MapTy::iterator FindExistingElement(ConstantClass *CP) {
869       if (HasLargeKey) {
870         typename InverseMapTy::iterator IMI = InverseMap.find(CP);
871         assert(IMI != InverseMap.end() && IMI->second != Map.end() &&
872                IMI->second->second == CP &&
873                "InverseMap corrupt!");
874         return IMI->second;
875       }
876       
877       typename MapTy::iterator I =
878         Map.find(MapKey((TypeClass*)CP->getRawType(), getValType(CP)));
879       if (I == Map.end() || I->second != CP) {
880         // FIXME: This should not use a linear scan.  If this gets to be a
881         // performance problem, someone should look at this.
882         for (I = Map.begin(); I != Map.end() && I->second != CP; ++I)
883           /* empty */;
884       }
885       return I;
886     }
887 public:
888     
889     /// getOrCreate - Return the specified constant from the map, creating it if
890     /// necessary.
891     ConstantClass *getOrCreate(const TypeClass *Ty, const ValType &V) {
892       MapKey Lookup(Ty, V);
893       typename MapTy::iterator I = Map.lower_bound(Lookup);
894       // Is it in the map?      
895       if (I != Map.end() && I->first == Lookup)
896         return static_cast<ConstantClass *>(I->second);  
897
898       // If no preexisting value, create one now...
899       ConstantClass *Result =
900         ConstantCreator<ConstantClass,TypeClass,ValType>::create(Ty, V);
901
902       /// FIXME: why does this assert fail when loading 176.gcc?
903       //assert(Result->getType() == Ty && "Type specified is not correct!");
904       I = Map.insert(I, std::make_pair(MapKey(Ty, V), Result));
905
906       if (HasLargeKey)  // Remember the reverse mapping if needed.
907         InverseMap.insert(std::make_pair(Result, I));
908       
909       // If the type of the constant is abstract, make sure that an entry exists
910       // for it in the AbstractTypeMap.
911       if (Ty->isAbstract()) {
912         typename AbstractTypeMapTy::iterator TI =
913           AbstractTypeMap.lower_bound(Ty);
914
915         if (TI == AbstractTypeMap.end() || TI->first != Ty) {
916           // Add ourselves to the ATU list of the type.
917           cast<DerivedType>(Ty)->addAbstractTypeUser(this);
918
919           AbstractTypeMap.insert(TI, std::make_pair(Ty, I));
920         }
921       }
922       return Result;
923     }
924
925     void remove(ConstantClass *CP) {
926       typename MapTy::iterator I = FindExistingElement(CP);
927       assert(I != Map.end() && "Constant not found in constant table!");
928       assert(I->second == CP && "Didn't find correct element?");
929
930       if (HasLargeKey)  // Remember the reverse mapping if needed.
931         InverseMap.erase(CP);
932       
933       // Now that we found the entry, make sure this isn't the entry that
934       // the AbstractTypeMap points to.
935       const TypeClass *Ty = static_cast<const TypeClass *>(I->first.first);
936       if (Ty->isAbstract()) {
937         assert(AbstractTypeMap.count(Ty) &&
938                "Abstract type not in AbstractTypeMap?");
939         typename MapTy::iterator &ATMEntryIt = AbstractTypeMap[Ty];
940         if (ATMEntryIt == I) {
941           // Yes, we are removing the representative entry for this type.
942           // See if there are any other entries of the same type.
943           typename MapTy::iterator TmpIt = ATMEntryIt;
944
945           // First check the entry before this one...
946           if (TmpIt != Map.begin()) {
947             --TmpIt;
948             if (TmpIt->first.first != Ty) // Not the same type, move back...
949               ++TmpIt;
950           }
951
952           // If we didn't find the same type, try to move forward...
953           if (TmpIt == ATMEntryIt) {
954             ++TmpIt;
955             if (TmpIt == Map.end() || TmpIt->first.first != Ty)
956               --TmpIt;   // No entry afterwards with the same type
957           }
958
959           // If there is another entry in the map of the same abstract type,
960           // update the AbstractTypeMap entry now.
961           if (TmpIt != ATMEntryIt) {
962             ATMEntryIt = TmpIt;
963           } else {
964             // Otherwise, we are removing the last instance of this type
965             // from the table.  Remove from the ATM, and from user list.
966             cast<DerivedType>(Ty)->removeAbstractTypeUser(this);
967             AbstractTypeMap.erase(Ty);
968           }
969         }
970       }
971
972       Map.erase(I);
973     }
974
975     
976     /// MoveConstantToNewSlot - If we are about to change C to be the element
977     /// specified by I, update our internal data structures to reflect this
978     /// fact.
979     void MoveConstantToNewSlot(ConstantClass *C, typename MapTy::iterator I) {
980       // First, remove the old location of the specified constant in the map.
981       typename MapTy::iterator OldI = FindExistingElement(C);
982       assert(OldI != Map.end() && "Constant not found in constant table!");
983       assert(OldI->second == C && "Didn't find correct element?");
984       
985       // If this constant is the representative element for its abstract type,
986       // update the AbstractTypeMap so that the representative element is I.
987       if (C->getType()->isAbstract()) {
988         typename AbstractTypeMapTy::iterator ATI =
989             AbstractTypeMap.find(C->getType());
990         assert(ATI != AbstractTypeMap.end() &&
991                "Abstract type not in AbstractTypeMap?");
992         if (ATI->second == OldI)
993           ATI->second = I;
994       }
995       
996       // Remove the old entry from the map.
997       Map.erase(OldI);
998       
999       // Update the inverse map so that we know that this constant is now
1000       // located at descriptor I.
1001       if (HasLargeKey) {
1002         assert(I->second == C && "Bad inversemap entry!");
1003         InverseMap[C] = I;
1004       }
1005     }
1006     
1007     void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
1008       typename AbstractTypeMapTy::iterator I =
1009         AbstractTypeMap.find(cast<Type>(OldTy));
1010
1011       assert(I != AbstractTypeMap.end() &&
1012              "Abstract type not in AbstractTypeMap?");
1013
1014       // Convert a constant at a time until the last one is gone.  The last one
1015       // leaving will remove() itself, causing the AbstractTypeMapEntry to be
1016       // eliminated eventually.
1017       do {
1018         ConvertConstantType<ConstantClass,
1019                             TypeClass>::convert(
1020                                 static_cast<ConstantClass *>(I->second->second),
1021                                                 cast<TypeClass>(NewTy));
1022
1023         I = AbstractTypeMap.find(cast<Type>(OldTy));
1024       } while (I != AbstractTypeMap.end());
1025     }
1026
1027     // If the type became concrete without being refined to any other existing
1028     // type, we just remove ourselves from the ATU list.
1029     void typeBecameConcrete(const DerivedType *AbsTy) {
1030       AbsTy->removeAbstractTypeUser(this);
1031     }
1032
1033     void dump() const {
1034       DOUT << "Constant.cpp: ValueMap\n";
1035     }
1036   };
1037 }
1038
1039
1040
1041 //---- ConstantAggregateZero::get() implementation...
1042 //
1043 namespace llvm {
1044   // ConstantAggregateZero does not take extra "value" argument...
1045   template<class ValType>
1046   struct ConstantCreator<ConstantAggregateZero, Type, ValType> {
1047     static ConstantAggregateZero *create(const Type *Ty, const ValType &V){
1048       return new ConstantAggregateZero(Ty);
1049     }
1050   };
1051
1052   template<>
1053   struct ConvertConstantType<ConstantAggregateZero, Type> {
1054     static void convert(ConstantAggregateZero *OldC, const Type *NewTy) {
1055       // Make everyone now use a constant of the new type...
1056       Constant *New = ConstantAggregateZero::get(NewTy);
1057       assert(New != OldC && "Didn't replace constant??");
1058       OldC->uncheckedReplaceAllUsesWith(New);
1059       OldC->destroyConstant();     // This constant is now dead, destroy it.
1060     }
1061   };
1062 }
1063
1064 static ManagedStatic<ValueMap<char, Type, 
1065                               ConstantAggregateZero> > AggZeroConstants;
1066
1067 static char getValType(ConstantAggregateZero *CPZ) { return 0; }
1068
1069 Constant *ConstantAggregateZero::get(const Type *Ty) {
1070   assert((isa<StructType>(Ty) || isa<ArrayType>(Ty) || isa<VectorType>(Ty)) &&
1071          "Cannot create an aggregate zero of non-aggregate type!");
1072   return AggZeroConstants->getOrCreate(Ty, 0);
1073 }
1074
1075 // destroyConstant - Remove the constant from the constant table...
1076 //
1077 void ConstantAggregateZero::destroyConstant() {
1078   AggZeroConstants->remove(this);
1079   destroyConstantImpl();
1080 }
1081
1082 //---- ConstantArray::get() implementation...
1083 //
1084 namespace llvm {
1085   template<>
1086   struct ConvertConstantType<ConstantArray, ArrayType> {
1087     static void convert(ConstantArray *OldC, const ArrayType *NewTy) {
1088       // Make everyone now use a constant of the new type...
1089       std::vector<Constant*> C;
1090       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
1091         C.push_back(cast<Constant>(OldC->getOperand(i)));
1092       Constant *New = ConstantArray::get(NewTy, C);
1093       assert(New != OldC && "Didn't replace constant??");
1094       OldC->uncheckedReplaceAllUsesWith(New);
1095       OldC->destroyConstant();    // This constant is now dead, destroy it.
1096     }
1097   };
1098 }
1099
1100 static std::vector<Constant*> getValType(ConstantArray *CA) {
1101   std::vector<Constant*> Elements;
1102   Elements.reserve(CA->getNumOperands());
1103   for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1104     Elements.push_back(cast<Constant>(CA->getOperand(i)));
1105   return Elements;
1106 }
1107
1108 typedef ValueMap<std::vector<Constant*>, ArrayType, 
1109                  ConstantArray, true /*largekey*/> ArrayConstantsTy;
1110 static ManagedStatic<ArrayConstantsTy> ArrayConstants;
1111
1112 Constant *ConstantArray::get(const ArrayType *Ty,
1113                              const std::vector<Constant*> &V) {
1114   // If this is an all-zero array, return a ConstantAggregateZero object
1115   if (!V.empty()) {
1116     Constant *C = V[0];
1117     if (!C->isNullValue())
1118       return ArrayConstants->getOrCreate(Ty, V);
1119     for (unsigned i = 1, e = V.size(); i != e; ++i)
1120       if (V[i] != C)
1121         return ArrayConstants->getOrCreate(Ty, V);
1122   }
1123   return ConstantAggregateZero::get(Ty);
1124 }
1125
1126 // destroyConstant - Remove the constant from the constant table...
1127 //
1128 void ConstantArray::destroyConstant() {
1129   ArrayConstants->remove(this);
1130   destroyConstantImpl();
1131 }
1132
1133 /// ConstantArray::get(const string&) - Return an array that is initialized to
1134 /// contain the specified string.  If length is zero then a null terminator is 
1135 /// added to the specified string so that it may be used in a natural way. 
1136 /// Otherwise, the length parameter specifies how much of the string to use 
1137 /// and it won't be null terminated.
1138 ///
1139 Constant *ConstantArray::get(const std::string &Str, bool AddNull) {
1140   std::vector<Constant*> ElementVals;
1141   for (unsigned i = 0; i < Str.length(); ++i)
1142     ElementVals.push_back(ConstantInt::get(Type::Int8Ty, Str[i]));
1143
1144   // Add a null terminator to the string...
1145   if (AddNull) {
1146     ElementVals.push_back(ConstantInt::get(Type::Int8Ty, 0));
1147   }
1148
1149   ArrayType *ATy = ArrayType::get(Type::Int8Ty, ElementVals.size());
1150   return ConstantArray::get(ATy, ElementVals);
1151 }
1152
1153 /// isString - This method returns true if the array is an array of i8, and 
1154 /// if the elements of the array are all ConstantInt's.
1155 bool ConstantArray::isString() const {
1156   // Check the element type for i8...
1157   if (getType()->getElementType() != Type::Int8Ty)
1158     return false;
1159   // Check the elements to make sure they are all integers, not constant
1160   // expressions.
1161   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1162     if (!isa<ConstantInt>(getOperand(i)))
1163       return false;
1164   return true;
1165 }
1166
1167 /// isCString - This method returns true if the array is a string (see
1168 /// isString) and it ends in a null byte \0 and does not contains any other
1169 /// null bytes except its terminator.
1170 bool ConstantArray::isCString() const {
1171   // Check the element type for i8...
1172   if (getType()->getElementType() != Type::Int8Ty)
1173     return false;
1174   Constant *Zero = Constant::getNullValue(getOperand(0)->getType());
1175   // Last element must be a null.
1176   if (getOperand(getNumOperands()-1) != Zero)
1177     return false;
1178   // Other elements must be non-null integers.
1179   for (unsigned i = 0, e = getNumOperands()-1; i != e; ++i) {
1180     if (!isa<ConstantInt>(getOperand(i)))
1181       return false;
1182     if (getOperand(i) == Zero)
1183       return false;
1184   }
1185   return true;
1186 }
1187
1188
1189 // getAsString - If the sub-element type of this array is i8
1190 // then this method converts the array to an std::string and returns it.
1191 // Otherwise, it asserts out.
1192 //
1193 std::string ConstantArray::getAsString() const {
1194   assert(isString() && "Not a string!");
1195   std::string Result;
1196   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
1197     Result += (char)cast<ConstantInt>(getOperand(i))->getZExtValue();
1198   return Result;
1199 }
1200
1201
1202 //---- ConstantStruct::get() implementation...
1203 //
1204
1205 namespace llvm {
1206   template<>
1207   struct ConvertConstantType<ConstantStruct, StructType> {
1208     static void convert(ConstantStruct *OldC, const StructType *NewTy) {
1209       // Make everyone now use a constant of the new type...
1210       std::vector<Constant*> C;
1211       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
1212         C.push_back(cast<Constant>(OldC->getOperand(i)));
1213       Constant *New = ConstantStruct::get(NewTy, C);
1214       assert(New != OldC && "Didn't replace constant??");
1215
1216       OldC->uncheckedReplaceAllUsesWith(New);
1217       OldC->destroyConstant();    // This constant is now dead, destroy it.
1218     }
1219   };
1220 }
1221
1222 typedef ValueMap<std::vector<Constant*>, StructType,
1223                  ConstantStruct, true /*largekey*/> StructConstantsTy;
1224 static ManagedStatic<StructConstantsTy> StructConstants;
1225
1226 static std::vector<Constant*> getValType(ConstantStruct *CS) {
1227   std::vector<Constant*> Elements;
1228   Elements.reserve(CS->getNumOperands());
1229   for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i)
1230     Elements.push_back(cast<Constant>(CS->getOperand(i)));
1231   return Elements;
1232 }
1233
1234 Constant *ConstantStruct::get(const StructType *Ty,
1235                               const std::vector<Constant*> &V) {
1236   // Create a ConstantAggregateZero value if all elements are zeros...
1237   for (unsigned i = 0, e = V.size(); i != e; ++i)
1238     if (!V[i]->isNullValue())
1239       return StructConstants->getOrCreate(Ty, V);
1240
1241   return ConstantAggregateZero::get(Ty);
1242 }
1243
1244 Constant *ConstantStruct::get(const std::vector<Constant*> &V, bool packed) {
1245   std::vector<const Type*> StructEls;
1246   StructEls.reserve(V.size());
1247   for (unsigned i = 0, e = V.size(); i != e; ++i)
1248     StructEls.push_back(V[i]->getType());
1249   return get(StructType::get(StructEls, packed), V);
1250 }
1251
1252 // destroyConstant - Remove the constant from the constant table...
1253 //
1254 void ConstantStruct::destroyConstant() {
1255   StructConstants->remove(this);
1256   destroyConstantImpl();
1257 }
1258
1259 //---- ConstantVector::get() implementation...
1260 //
1261 namespace llvm {
1262   template<>
1263   struct ConvertConstantType<ConstantVector, VectorType> {
1264     static void convert(ConstantVector *OldC, const VectorType *NewTy) {
1265       // Make everyone now use a constant of the new type...
1266       std::vector<Constant*> C;
1267       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
1268         C.push_back(cast<Constant>(OldC->getOperand(i)));
1269       Constant *New = ConstantVector::get(NewTy, C);
1270       assert(New != OldC && "Didn't replace constant??");
1271       OldC->uncheckedReplaceAllUsesWith(New);
1272       OldC->destroyConstant();    // This constant is now dead, destroy it.
1273     }
1274   };
1275 }
1276
1277 static std::vector<Constant*> getValType(ConstantVector *CP) {
1278   std::vector<Constant*> Elements;
1279   Elements.reserve(CP->getNumOperands());
1280   for (unsigned i = 0, e = CP->getNumOperands(); i != e; ++i)
1281     Elements.push_back(CP->getOperand(i));
1282   return Elements;
1283 }
1284
1285 static ManagedStatic<ValueMap<std::vector<Constant*>, VectorType,
1286                               ConstantVector> > VectorConstants;
1287
1288 Constant *ConstantVector::get(const VectorType *Ty,
1289                               const std::vector<Constant*> &V) {
1290   // If this is an all-zero vector, return a ConstantAggregateZero object
1291   if (!V.empty()) {
1292     Constant *C = V[0];
1293     if (!C->isNullValue())
1294       return VectorConstants->getOrCreate(Ty, V);
1295     for (unsigned i = 1, e = V.size(); i != e; ++i)
1296       if (V[i] != C)
1297         return VectorConstants->getOrCreate(Ty, V);
1298   }
1299   return ConstantAggregateZero::get(Ty);
1300 }
1301
1302 Constant *ConstantVector::get(const std::vector<Constant*> &V) {
1303   assert(!V.empty() && "Cannot infer type if V is empty");
1304   return get(VectorType::get(V.front()->getType(),V.size()), V);
1305 }
1306
1307 // destroyConstant - Remove the constant from the constant table...
1308 //
1309 void ConstantVector::destroyConstant() {
1310   VectorConstants->remove(this);
1311   destroyConstantImpl();
1312 }
1313
1314 /// This function will return true iff every element in this vector constant
1315 /// is set to all ones.
1316 /// @returns true iff this constant's emements are all set to all ones.
1317 /// @brief Determine if the value is all ones.
1318 bool ConstantVector::isAllOnesValue() const {
1319   // Check out first element.
1320   const Constant *Elt = getOperand(0);
1321   const ConstantInt *CI = dyn_cast<ConstantInt>(Elt);
1322   if (!CI || !CI->isAllOnesValue()) return false;
1323   // Then make sure all remaining elements point to the same value.
1324   for (unsigned I = 1, E = getNumOperands(); I < E; ++I) {
1325     if (getOperand(I) != Elt) return false;
1326   }
1327   return true;
1328 }
1329
1330 /// getSplatValue - If this is a splat constant, where all of the
1331 /// elements have the same value, return that value. Otherwise return null.
1332 Constant *ConstantVector::getSplatValue() {
1333   // Check out first element.
1334   Constant *Elt = getOperand(0);
1335   // Then make sure all remaining elements point to the same value.
1336   for (unsigned I = 1, E = getNumOperands(); I < E; ++I)
1337     if (getOperand(I) != Elt) return 0;
1338   return Elt;
1339 }
1340
1341 //---- ConstantPointerNull::get() implementation...
1342 //
1343
1344 namespace llvm {
1345   // ConstantPointerNull does not take extra "value" argument...
1346   template<class ValType>
1347   struct ConstantCreator<ConstantPointerNull, PointerType, ValType> {
1348     static ConstantPointerNull *create(const PointerType *Ty, const ValType &V){
1349       return new ConstantPointerNull(Ty);
1350     }
1351   };
1352
1353   template<>
1354   struct ConvertConstantType<ConstantPointerNull, PointerType> {
1355     static void convert(ConstantPointerNull *OldC, const PointerType *NewTy) {
1356       // Make everyone now use a constant of the new type...
1357       Constant *New = ConstantPointerNull::get(NewTy);
1358       assert(New != OldC && "Didn't replace constant??");
1359       OldC->uncheckedReplaceAllUsesWith(New);
1360       OldC->destroyConstant();     // This constant is now dead, destroy it.
1361     }
1362   };
1363 }
1364
1365 static ManagedStatic<ValueMap<char, PointerType, 
1366                               ConstantPointerNull> > NullPtrConstants;
1367
1368 static char getValType(ConstantPointerNull *) {
1369   return 0;
1370 }
1371
1372
1373 ConstantPointerNull *ConstantPointerNull::get(const PointerType *Ty) {
1374   return NullPtrConstants->getOrCreate(Ty, 0);
1375 }
1376
1377 // destroyConstant - Remove the constant from the constant table...
1378 //
1379 void ConstantPointerNull::destroyConstant() {
1380   NullPtrConstants->remove(this);
1381   destroyConstantImpl();
1382 }
1383
1384
1385 //---- UndefValue::get() implementation...
1386 //
1387
1388 namespace llvm {
1389   // UndefValue does not take extra "value" argument...
1390   template<class ValType>
1391   struct ConstantCreator<UndefValue, Type, ValType> {
1392     static UndefValue *create(const Type *Ty, const ValType &V) {
1393       return new UndefValue(Ty);
1394     }
1395   };
1396
1397   template<>
1398   struct ConvertConstantType<UndefValue, Type> {
1399     static void convert(UndefValue *OldC, const Type *NewTy) {
1400       // Make everyone now use a constant of the new type.
1401       Constant *New = UndefValue::get(NewTy);
1402       assert(New != OldC && "Didn't replace constant??");
1403       OldC->uncheckedReplaceAllUsesWith(New);
1404       OldC->destroyConstant();     // This constant is now dead, destroy it.
1405     }
1406   };
1407 }
1408
1409 static ManagedStatic<ValueMap<char, Type, UndefValue> > UndefValueConstants;
1410
1411 static char getValType(UndefValue *) {
1412   return 0;
1413 }
1414
1415
1416 UndefValue *UndefValue::get(const Type *Ty) {
1417   return UndefValueConstants->getOrCreate(Ty, 0);
1418 }
1419
1420 // destroyConstant - Remove the constant from the constant table.
1421 //
1422 void UndefValue::destroyConstant() {
1423   UndefValueConstants->remove(this);
1424   destroyConstantImpl();
1425 }
1426
1427
1428 //---- ConstantExpr::get() implementations...
1429 //
1430
1431 struct ExprMapKeyType {
1432   explicit ExprMapKeyType(unsigned opc, std::vector<Constant*> ops,
1433       unsigned short pred = 0) : opcode(opc), predicate(pred), operands(ops) { }
1434   uint16_t opcode;
1435   uint16_t predicate;
1436   std::vector<Constant*> operands;
1437   bool operator==(const ExprMapKeyType& that) const {
1438     return this->opcode == that.opcode &&
1439            this->predicate == that.predicate &&
1440            this->operands == that.operands;
1441   }
1442   bool operator<(const ExprMapKeyType & that) const {
1443     return this->opcode < that.opcode ||
1444       (this->opcode == that.opcode && this->predicate < that.predicate) ||
1445       (this->opcode == that.opcode && this->predicate == that.predicate &&
1446        this->operands < that.operands);
1447   }
1448
1449   bool operator!=(const ExprMapKeyType& that) const {
1450     return !(*this == that);
1451   }
1452 };
1453
1454 namespace llvm {
1455   template<>
1456   struct ConstantCreator<ConstantExpr, Type, ExprMapKeyType> {
1457     static ConstantExpr *create(const Type *Ty, const ExprMapKeyType &V,
1458         unsigned short pred = 0) {
1459       if (Instruction::isCast(V.opcode))
1460         return new UnaryConstantExpr(V.opcode, V.operands[0], Ty);
1461       if ((V.opcode >= Instruction::BinaryOpsBegin &&
1462            V.opcode < Instruction::BinaryOpsEnd))
1463         return new BinaryConstantExpr(V.opcode, V.operands[0], V.operands[1]);
1464       if (V.opcode == Instruction::Select)
1465         return new SelectConstantExpr(V.operands[0], V.operands[1], 
1466                                       V.operands[2]);
1467       if (V.opcode == Instruction::ExtractElement)
1468         return new ExtractElementConstantExpr(V.operands[0], V.operands[1]);
1469       if (V.opcode == Instruction::InsertElement)
1470         return new InsertElementConstantExpr(V.operands[0], V.operands[1],
1471                                              V.operands[2]);
1472       if (V.opcode == Instruction::ShuffleVector)
1473         return new ShuffleVectorConstantExpr(V.operands[0], V.operands[1],
1474                                              V.operands[2]);
1475       if (V.opcode == Instruction::GetElementPtr) {
1476         std::vector<Constant*> IdxList(V.operands.begin()+1, V.operands.end());
1477         return GetElementPtrConstantExpr::Create(V.operands[0], IdxList, Ty);
1478       }
1479
1480       // The compare instructions are weird. We have to encode the predicate
1481       // value and it is combined with the instruction opcode by multiplying
1482       // the opcode by one hundred. We must decode this to get the predicate.
1483       if (V.opcode == Instruction::ICmp)
1484         return new CompareConstantExpr(Instruction::ICmp, V.predicate, 
1485                                        V.operands[0], V.operands[1]);
1486       if (V.opcode == Instruction::FCmp) 
1487         return new CompareConstantExpr(Instruction::FCmp, V.predicate, 
1488                                        V.operands[0], V.operands[1]);
1489       assert(0 && "Invalid ConstantExpr!");
1490       return 0;
1491     }
1492   };
1493
1494   template<>
1495   struct ConvertConstantType<ConstantExpr, Type> {
1496     static void convert(ConstantExpr *OldC, const Type *NewTy) {
1497       Constant *New;
1498       switch (OldC->getOpcode()) {
1499       case Instruction::Trunc:
1500       case Instruction::ZExt:
1501       case Instruction::SExt:
1502       case Instruction::FPTrunc:
1503       case Instruction::FPExt:
1504       case Instruction::UIToFP:
1505       case Instruction::SIToFP:
1506       case Instruction::FPToUI:
1507       case Instruction::FPToSI:
1508       case Instruction::PtrToInt:
1509       case Instruction::IntToPtr:
1510       case Instruction::BitCast:
1511         New = ConstantExpr::getCast(OldC->getOpcode(), OldC->getOperand(0), 
1512                                     NewTy);
1513         break;
1514       case Instruction::Select:
1515         New = ConstantExpr::getSelectTy(NewTy, OldC->getOperand(0),
1516                                         OldC->getOperand(1),
1517                                         OldC->getOperand(2));
1518         break;
1519       default:
1520         assert(OldC->getOpcode() >= Instruction::BinaryOpsBegin &&
1521                OldC->getOpcode() <  Instruction::BinaryOpsEnd);
1522         New = ConstantExpr::getTy(NewTy, OldC->getOpcode(), OldC->getOperand(0),
1523                                   OldC->getOperand(1));
1524         break;
1525       case Instruction::GetElementPtr:
1526         // Make everyone now use a constant of the new type...
1527         std::vector<Value*> Idx(OldC->op_begin()+1, OldC->op_end());
1528         New = ConstantExpr::getGetElementPtrTy(NewTy, OldC->getOperand(0),
1529                                                &Idx[0], Idx.size());
1530         break;
1531       }
1532
1533       assert(New != OldC && "Didn't replace constant??");
1534       OldC->uncheckedReplaceAllUsesWith(New);
1535       OldC->destroyConstant();    // This constant is now dead, destroy it.
1536     }
1537   };
1538 } // end namespace llvm
1539
1540
1541 static ExprMapKeyType getValType(ConstantExpr *CE) {
1542   std::vector<Constant*> Operands;
1543   Operands.reserve(CE->getNumOperands());
1544   for (unsigned i = 0, e = CE->getNumOperands(); i != e; ++i)
1545     Operands.push_back(cast<Constant>(CE->getOperand(i)));
1546   return ExprMapKeyType(CE->getOpcode(), Operands, 
1547       CE->isCompare() ? CE->getPredicate() : 0);
1548 }
1549
1550 static ManagedStatic<ValueMap<ExprMapKeyType, Type,
1551                               ConstantExpr> > ExprConstants;
1552
1553 /// This is a utility function to handle folding of casts and lookup of the
1554 /// cast in the ExprConstants map. It is used by the various get* methods below.
1555 static inline Constant *getFoldedCast(
1556   Instruction::CastOps opc, Constant *C, const Type *Ty) {
1557   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1558   // Fold a few common cases
1559   if (Constant *FC = ConstantFoldCastInstruction(opc, C, Ty))
1560     return FC;
1561
1562   // Look up the constant in the table first to ensure uniqueness
1563   std::vector<Constant*> argVec(1, C);
1564   ExprMapKeyType Key(opc, argVec);
1565   return ExprConstants->getOrCreate(Ty, Key);
1566 }
1567  
1568 Constant *ConstantExpr::getCast(unsigned oc, Constant *C, const Type *Ty) {
1569   Instruction::CastOps opc = Instruction::CastOps(oc);
1570   assert(Instruction::isCast(opc) && "opcode out of range");
1571   assert(C && Ty && "Null arguments to getCast");
1572   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1573
1574   switch (opc) {
1575     default:
1576       assert(0 && "Invalid cast opcode");
1577       break;
1578     case Instruction::Trunc:    return getTrunc(C, Ty);
1579     case Instruction::ZExt:     return getZExt(C, Ty);
1580     case Instruction::SExt:     return getSExt(C, Ty);
1581     case Instruction::FPTrunc:  return getFPTrunc(C, Ty);
1582     case Instruction::FPExt:    return getFPExtend(C, Ty);
1583     case Instruction::UIToFP:   return getUIToFP(C, Ty);
1584     case Instruction::SIToFP:   return getSIToFP(C, Ty);
1585     case Instruction::FPToUI:   return getFPToUI(C, Ty);
1586     case Instruction::FPToSI:   return getFPToSI(C, Ty);
1587     case Instruction::PtrToInt: return getPtrToInt(C, Ty);
1588     case Instruction::IntToPtr: return getIntToPtr(C, Ty);
1589     case Instruction::BitCast:  return getBitCast(C, Ty);
1590   }
1591   return 0;
1592
1593
1594 Constant *ConstantExpr::getZExtOrBitCast(Constant *C, const Type *Ty) {
1595   if (C->getType()->getPrimitiveSizeInBits() == Ty->getPrimitiveSizeInBits())
1596     return getCast(Instruction::BitCast, C, Ty);
1597   return getCast(Instruction::ZExt, C, Ty);
1598 }
1599
1600 Constant *ConstantExpr::getSExtOrBitCast(Constant *C, const Type *Ty) {
1601   if (C->getType()->getPrimitiveSizeInBits() == Ty->getPrimitiveSizeInBits())
1602     return getCast(Instruction::BitCast, C, Ty);
1603   return getCast(Instruction::SExt, C, Ty);
1604 }
1605
1606 Constant *ConstantExpr::getTruncOrBitCast(Constant *C, const Type *Ty) {
1607   if (C->getType()->getPrimitiveSizeInBits() == Ty->getPrimitiveSizeInBits())
1608     return getCast(Instruction::BitCast, C, Ty);
1609   return getCast(Instruction::Trunc, C, Ty);
1610 }
1611
1612 Constant *ConstantExpr::getPointerCast(Constant *S, const Type *Ty) {
1613   assert(isa<PointerType>(S->getType()) && "Invalid cast");
1614   assert((Ty->isInteger() || isa<PointerType>(Ty)) && "Invalid cast");
1615
1616   if (Ty->isInteger())
1617     return getCast(Instruction::PtrToInt, S, Ty);
1618   return getCast(Instruction::BitCast, S, Ty);
1619 }
1620
1621 Constant *ConstantExpr::getIntegerCast(Constant *C, const Type *Ty, 
1622                                        bool isSigned) {
1623   assert(C->getType()->isInteger() && Ty->isInteger() && "Invalid cast");
1624   unsigned SrcBits = C->getType()->getPrimitiveSizeInBits();
1625   unsigned DstBits = Ty->getPrimitiveSizeInBits();
1626   Instruction::CastOps opcode =
1627     (SrcBits == DstBits ? Instruction::BitCast :
1628      (SrcBits > DstBits ? Instruction::Trunc :
1629       (isSigned ? Instruction::SExt : Instruction::ZExt)));
1630   return getCast(opcode, C, Ty);
1631 }
1632
1633 Constant *ConstantExpr::getFPCast(Constant *C, const Type *Ty) {
1634   assert(C->getType()->isFloatingPoint() && Ty->isFloatingPoint() && 
1635          "Invalid cast");
1636   unsigned SrcBits = C->getType()->getPrimitiveSizeInBits();
1637   unsigned DstBits = Ty->getPrimitiveSizeInBits();
1638   if (SrcBits == DstBits)
1639     return C; // Avoid a useless cast
1640   Instruction::CastOps opcode =
1641      (SrcBits > DstBits ? Instruction::FPTrunc : Instruction::FPExt);
1642   return getCast(opcode, C, Ty);
1643 }
1644
1645 Constant *ConstantExpr::getTrunc(Constant *C, const Type *Ty) {
1646   assert(C->getType()->isInteger() && "Trunc operand must be integer");
1647   assert(Ty->isInteger() && "Trunc produces only integral");
1648   assert(C->getType()->getPrimitiveSizeInBits() > Ty->getPrimitiveSizeInBits()&&
1649          "SrcTy must be larger than DestTy for Trunc!");
1650
1651   return getFoldedCast(Instruction::Trunc, C, Ty);
1652 }
1653
1654 Constant *ConstantExpr::getSExt(Constant *C, const Type *Ty) {
1655   assert(C->getType()->isInteger() && "SEXt operand must be integral");
1656   assert(Ty->isInteger() && "SExt produces only integer");
1657   assert(C->getType()->getPrimitiveSizeInBits() < Ty->getPrimitiveSizeInBits()&&
1658          "SrcTy must be smaller than DestTy for SExt!");
1659
1660   return getFoldedCast(Instruction::SExt, C, Ty);
1661 }
1662
1663 Constant *ConstantExpr::getZExt(Constant *C, const Type *Ty) {
1664   assert(C->getType()->isInteger() && "ZEXt operand must be integral");
1665   assert(Ty->isInteger() && "ZExt produces only integer");
1666   assert(C->getType()->getPrimitiveSizeInBits() < Ty->getPrimitiveSizeInBits()&&
1667          "SrcTy must be smaller than DestTy for ZExt!");
1668
1669   return getFoldedCast(Instruction::ZExt, C, Ty);
1670 }
1671
1672 Constant *ConstantExpr::getFPTrunc(Constant *C, const Type *Ty) {
1673   assert(C->getType()->isFloatingPoint() && Ty->isFloatingPoint() &&
1674          C->getType()->getPrimitiveSizeInBits() > Ty->getPrimitiveSizeInBits()&&
1675          "This is an illegal floating point truncation!");
1676   return getFoldedCast(Instruction::FPTrunc, C, Ty);
1677 }
1678
1679 Constant *ConstantExpr::getFPExtend(Constant *C, const Type *Ty) {
1680   assert(C->getType()->isFloatingPoint() && Ty->isFloatingPoint() &&
1681          C->getType()->getPrimitiveSizeInBits() < Ty->getPrimitiveSizeInBits()&&
1682          "This is an illegal floating point extension!");
1683   return getFoldedCast(Instruction::FPExt, C, Ty);
1684 }
1685
1686 Constant *ConstantExpr::getUIToFP(Constant *C, const Type *Ty) {
1687   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1688   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1689   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1690   assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
1691          "This is an illegal uint to floating point cast!");
1692   return getFoldedCast(Instruction::UIToFP, C, Ty);
1693 }
1694
1695 Constant *ConstantExpr::getSIToFP(Constant *C, const Type *Ty) {
1696   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1697   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1698   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1699   assert(C->getType()->isIntOrIntVector() && Ty->isFPOrFPVector() &&
1700          "This is an illegal sint to floating point cast!");
1701   return getFoldedCast(Instruction::SIToFP, C, Ty);
1702 }
1703
1704 Constant *ConstantExpr::getFPToUI(Constant *C, const Type *Ty) {
1705   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1706   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1707   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1708   assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
1709          "This is an illegal floating point to uint cast!");
1710   return getFoldedCast(Instruction::FPToUI, C, Ty);
1711 }
1712
1713 Constant *ConstantExpr::getFPToSI(Constant *C, const Type *Ty) {
1714   bool fromVec = C->getType()->getTypeID() == Type::VectorTyID;
1715   bool toVec = Ty->getTypeID() == Type::VectorTyID;
1716   assert((fromVec == toVec) && "Cannot convert from scalar to/from vector");
1717   assert(C->getType()->isFPOrFPVector() && Ty->isIntOrIntVector() &&
1718          "This is an illegal floating point to sint cast!");
1719   return getFoldedCast(Instruction::FPToSI, C, Ty);
1720 }
1721
1722 Constant *ConstantExpr::getPtrToInt(Constant *C, const Type *DstTy) {
1723   assert(isa<PointerType>(C->getType()) && "PtrToInt source must be pointer");
1724   assert(DstTy->isInteger() && "PtrToInt destination must be integral");
1725   return getFoldedCast(Instruction::PtrToInt, C, DstTy);
1726 }
1727
1728 Constant *ConstantExpr::getIntToPtr(Constant *C, const Type *DstTy) {
1729   assert(C->getType()->isInteger() && "IntToPtr source must be integral");
1730   assert(isa<PointerType>(DstTy) && "IntToPtr destination must be a pointer");
1731   return getFoldedCast(Instruction::IntToPtr, C, DstTy);
1732 }
1733
1734 Constant *ConstantExpr::getBitCast(Constant *C, const Type *DstTy) {
1735   // BitCast implies a no-op cast of type only. No bits change.  However, you 
1736   // can't cast pointers to anything but pointers.
1737   const Type *SrcTy = C->getType();
1738   assert((isa<PointerType>(SrcTy) == isa<PointerType>(DstTy)) &&
1739          "BitCast cannot cast pointer to non-pointer and vice versa");
1740
1741   // Now we know we're not dealing with mismatched pointer casts (ptr->nonptr
1742   // or nonptr->ptr). For all the other types, the cast is okay if source and 
1743   // destination bit widths are identical.
1744   unsigned SrcBitSize = SrcTy->getPrimitiveSizeInBits();
1745   unsigned DstBitSize = DstTy->getPrimitiveSizeInBits();
1746   assert(SrcBitSize == DstBitSize && "BitCast requies types of same width");
1747   return getFoldedCast(Instruction::BitCast, C, DstTy);
1748 }
1749
1750 Constant *ConstantExpr::getSizeOf(const Type *Ty) {
1751   // sizeof is implemented as: (i64) gep (Ty*)null, 1
1752   Constant *GEPIdx = ConstantInt::get(Type::Int32Ty, 1);
1753   Constant *GEP =
1754     getGetElementPtr(getNullValue(PointerType::getUnqual(Ty)), &GEPIdx, 1);
1755   return getCast(Instruction::PtrToInt, GEP, Type::Int64Ty);
1756 }
1757
1758 Constant *ConstantExpr::getTy(const Type *ReqTy, unsigned Opcode,
1759                               Constant *C1, Constant *C2) {
1760   // Check the operands for consistency first
1761   assert(Opcode >= Instruction::BinaryOpsBegin &&
1762          Opcode <  Instruction::BinaryOpsEnd   &&
1763          "Invalid opcode in binary constant expression");
1764   assert(C1->getType() == C2->getType() &&
1765          "Operand types in binary constant expression should match");
1766
1767   if (ReqTy == C1->getType() || ReqTy == Type::Int1Ty)
1768     if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1769       return FC;          // Fold a few common cases...
1770
1771   std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1772   ExprMapKeyType Key(Opcode, argVec);
1773   return ExprConstants->getOrCreate(ReqTy, Key);
1774 }
1775
1776 Constant *ConstantExpr::getCompareTy(unsigned short predicate,
1777                                      Constant *C1, Constant *C2) {
1778   switch (predicate) {
1779     default: assert(0 && "Invalid CmpInst predicate");
1780     case FCmpInst::FCMP_FALSE: case FCmpInst::FCMP_OEQ: case FCmpInst::FCMP_OGT:
1781     case FCmpInst::FCMP_OGE: case FCmpInst::FCMP_OLT: case FCmpInst::FCMP_OLE:
1782     case FCmpInst::FCMP_ONE: case FCmpInst::FCMP_ORD: case FCmpInst::FCMP_UNO:
1783     case FCmpInst::FCMP_UEQ: case FCmpInst::FCMP_UGT: case FCmpInst::FCMP_UGE:
1784     case FCmpInst::FCMP_ULT: case FCmpInst::FCMP_ULE: case FCmpInst::FCMP_UNE:
1785     case FCmpInst::FCMP_TRUE:
1786       return getFCmp(predicate, C1, C2);
1787     case ICmpInst::ICMP_EQ: case ICmpInst::ICMP_NE: case ICmpInst::ICMP_UGT:
1788     case ICmpInst::ICMP_UGE: case ICmpInst::ICMP_ULT: case ICmpInst::ICMP_ULE:
1789     case ICmpInst::ICMP_SGT: case ICmpInst::ICMP_SGE: case ICmpInst::ICMP_SLT:
1790     case ICmpInst::ICMP_SLE:
1791       return getICmp(predicate, C1, C2);
1792   }
1793 }
1794
1795 Constant *ConstantExpr::get(unsigned Opcode, Constant *C1, Constant *C2) {
1796 #ifndef NDEBUG
1797   switch (Opcode) {
1798   case Instruction::Add: 
1799   case Instruction::Sub:
1800   case Instruction::Mul: 
1801     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1802     assert((C1->getType()->isInteger() || C1->getType()->isFloatingPoint() ||
1803             isa<VectorType>(C1->getType())) &&
1804            "Tried to create an arithmetic operation on a non-arithmetic type!");
1805     break;
1806   case Instruction::UDiv: 
1807   case Instruction::SDiv: 
1808     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1809     assert((C1->getType()->isInteger() || (isa<VectorType>(C1->getType()) &&
1810       cast<VectorType>(C1->getType())->getElementType()->isInteger())) &&
1811            "Tried to create an arithmetic operation on a non-arithmetic type!");
1812     break;
1813   case Instruction::FDiv:
1814     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1815     assert((C1->getType()->isFloatingPoint() || (isa<VectorType>(C1->getType())
1816       && cast<VectorType>(C1->getType())->getElementType()->isFloatingPoint())) 
1817       && "Tried to create an arithmetic operation on a non-arithmetic type!");
1818     break;
1819   case Instruction::URem: 
1820   case Instruction::SRem: 
1821     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1822     assert((C1->getType()->isInteger() || (isa<VectorType>(C1->getType()) &&
1823       cast<VectorType>(C1->getType())->getElementType()->isInteger())) &&
1824            "Tried to create an arithmetic operation on a non-arithmetic type!");
1825     break;
1826   case Instruction::FRem:
1827     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1828     assert((C1->getType()->isFloatingPoint() || (isa<VectorType>(C1->getType())
1829       && cast<VectorType>(C1->getType())->getElementType()->isFloatingPoint())) 
1830       && "Tried to create an arithmetic operation on a non-arithmetic type!");
1831     break;
1832   case Instruction::And:
1833   case Instruction::Or:
1834   case Instruction::Xor:
1835     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1836     assert((C1->getType()->isInteger() || isa<VectorType>(C1->getType())) &&
1837            "Tried to create a logical operation on a non-integral type!");
1838     break;
1839   case Instruction::Shl:
1840   case Instruction::LShr:
1841   case Instruction::AShr:
1842     assert(C1->getType() == C2->getType() && "Op types should be identical!");
1843     assert(C1->getType()->isInteger() &&
1844            "Tried to create a shift operation on a non-integer type!");
1845     break;
1846   default:
1847     break;
1848   }
1849 #endif
1850
1851   return getTy(C1->getType(), Opcode, C1, C2);
1852 }
1853
1854 Constant *ConstantExpr::getCompare(unsigned short pred, 
1855                             Constant *C1, Constant *C2) {
1856   assert(C1->getType() == C2->getType() && "Op types should be identical!");
1857   return getCompareTy(pred, C1, C2);
1858 }
1859
1860 Constant *ConstantExpr::getSelectTy(const Type *ReqTy, Constant *C,
1861                                     Constant *V1, Constant *V2) {
1862   assert(C->getType() == Type::Int1Ty && "Select condition must be i1!");
1863   assert(V1->getType() == V2->getType() && "Select value types must match!");
1864   assert(V1->getType()->isFirstClassType() && "Cannot select aggregate type!");
1865
1866   if (ReqTy == V1->getType())
1867     if (Constant *SC = ConstantFoldSelectInstruction(C, V1, V2))
1868       return SC;        // Fold common cases
1869
1870   std::vector<Constant*> argVec(3, C);
1871   argVec[1] = V1;
1872   argVec[2] = V2;
1873   ExprMapKeyType Key(Instruction::Select, argVec);
1874   return ExprConstants->getOrCreate(ReqTy, Key);
1875 }
1876
1877 Constant *ConstantExpr::getGetElementPtrTy(const Type *ReqTy, Constant *C,
1878                                            Value* const *Idxs,
1879                                            unsigned NumIdx) {
1880   assert(GetElementPtrInst::getIndexedType(C->getType(), Idxs, Idxs+NumIdx, true) &&
1881          "GEP indices invalid!");
1882
1883   if (Constant *FC = ConstantFoldGetElementPtr(C, (Constant**)Idxs, NumIdx))
1884     return FC;          // Fold a few common cases...
1885
1886   assert(isa<PointerType>(C->getType()) &&
1887          "Non-pointer type for constant GetElementPtr expression");
1888   // Look up the constant in the table first to ensure uniqueness
1889   std::vector<Constant*> ArgVec;
1890   ArgVec.reserve(NumIdx+1);
1891   ArgVec.push_back(C);
1892   for (unsigned i = 0; i != NumIdx; ++i)
1893     ArgVec.push_back(cast<Constant>(Idxs[i]));
1894   const ExprMapKeyType Key(Instruction::GetElementPtr, ArgVec);
1895   return ExprConstants->getOrCreate(ReqTy, Key);
1896 }
1897
1898 Constant *ConstantExpr::getGetElementPtr(Constant *C, Value* const *Idxs,
1899                                          unsigned NumIdx) {
1900   // Get the result type of the getelementptr!
1901   const Type *Ty = 
1902     GetElementPtrInst::getIndexedType(C->getType(), Idxs, Idxs+NumIdx, true);
1903   assert(Ty && "GEP indices invalid!");
1904   unsigned As = cast<PointerType>(C->getType())->getAddressSpace();
1905   return getGetElementPtrTy(PointerType::get(Ty, As), C, Idxs, NumIdx);
1906 }
1907
1908 Constant *ConstantExpr::getGetElementPtr(Constant *C, Constant* const *Idxs,
1909                                          unsigned NumIdx) {
1910   return getGetElementPtr(C, (Value* const *)Idxs, NumIdx);
1911 }
1912
1913
1914 Constant *
1915 ConstantExpr::getICmp(unsigned short pred, Constant* LHS, Constant* RHS) {
1916   assert(LHS->getType() == RHS->getType());
1917   assert(pred >= ICmpInst::FIRST_ICMP_PREDICATE && 
1918          pred <= ICmpInst::LAST_ICMP_PREDICATE && "Invalid ICmp Predicate");
1919
1920   if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
1921     return FC;          // Fold a few common cases...
1922
1923   // Look up the constant in the table first to ensure uniqueness
1924   std::vector<Constant*> ArgVec;
1925   ArgVec.push_back(LHS);
1926   ArgVec.push_back(RHS);
1927   // Get the key type with both the opcode and predicate
1928   const ExprMapKeyType Key(Instruction::ICmp, ArgVec, pred);
1929   return ExprConstants->getOrCreate(Type::Int1Ty, Key);
1930 }
1931
1932 Constant *
1933 ConstantExpr::getFCmp(unsigned short pred, Constant* LHS, Constant* RHS) {
1934   assert(LHS->getType() == RHS->getType());
1935   assert(pred <= FCmpInst::LAST_FCMP_PREDICATE && "Invalid FCmp Predicate");
1936
1937   if (Constant *FC = ConstantFoldCompareInstruction(pred, LHS, RHS))
1938     return FC;          // Fold a few common cases...
1939
1940   // Look up the constant in the table first to ensure uniqueness
1941   std::vector<Constant*> ArgVec;
1942   ArgVec.push_back(LHS);
1943   ArgVec.push_back(RHS);
1944   // Get the key type with both the opcode and predicate
1945   const ExprMapKeyType Key(Instruction::FCmp, ArgVec, pred);
1946   return ExprConstants->getOrCreate(Type::Int1Ty, Key);
1947 }
1948
1949 Constant *ConstantExpr::getExtractElementTy(const Type *ReqTy, Constant *Val,
1950                                             Constant *Idx) {
1951   if (Constant *FC = ConstantFoldExtractElementInstruction(Val, Idx))
1952     return FC;          // Fold a few common cases...
1953   // Look up the constant in the table first to ensure uniqueness
1954   std::vector<Constant*> ArgVec(1, Val);
1955   ArgVec.push_back(Idx);
1956   const ExprMapKeyType Key(Instruction::ExtractElement,ArgVec);
1957   return ExprConstants->getOrCreate(ReqTy, Key);
1958 }
1959
1960 Constant *ConstantExpr::getExtractElement(Constant *Val, Constant *Idx) {
1961   assert(isa<VectorType>(Val->getType()) &&
1962          "Tried to create extractelement operation on non-vector type!");
1963   assert(Idx->getType() == Type::Int32Ty &&
1964          "Extractelement index must be i32 type!");
1965   return getExtractElementTy(cast<VectorType>(Val->getType())->getElementType(),
1966                              Val, Idx);
1967 }
1968
1969 Constant *ConstantExpr::getInsertElementTy(const Type *ReqTy, Constant *Val,
1970                                            Constant *Elt, Constant *Idx) {
1971   if (Constant *FC = ConstantFoldInsertElementInstruction(Val, Elt, Idx))
1972     return FC;          // Fold a few common cases...
1973   // Look up the constant in the table first to ensure uniqueness
1974   std::vector<Constant*> ArgVec(1, Val);
1975   ArgVec.push_back(Elt);
1976   ArgVec.push_back(Idx);
1977   const ExprMapKeyType Key(Instruction::InsertElement,ArgVec);
1978   return ExprConstants->getOrCreate(ReqTy, Key);
1979 }
1980
1981 Constant *ConstantExpr::getInsertElement(Constant *Val, Constant *Elt, 
1982                                          Constant *Idx) {
1983   assert(isa<VectorType>(Val->getType()) &&
1984          "Tried to create insertelement operation on non-vector type!");
1985   assert(Elt->getType() == cast<VectorType>(Val->getType())->getElementType()
1986          && "Insertelement types must match!");
1987   assert(Idx->getType() == Type::Int32Ty &&
1988          "Insertelement index must be i32 type!");
1989   return getInsertElementTy(cast<VectorType>(Val->getType())->getElementType(),
1990                             Val, Elt, Idx);
1991 }
1992
1993 Constant *ConstantExpr::getShuffleVectorTy(const Type *ReqTy, Constant *V1,
1994                                            Constant *V2, Constant *Mask) {
1995   if (Constant *FC = ConstantFoldShuffleVectorInstruction(V1, V2, Mask))
1996     return FC;          // Fold a few common cases...
1997   // Look up the constant in the table first to ensure uniqueness
1998   std::vector<Constant*> ArgVec(1, V1);
1999   ArgVec.push_back(V2);
2000   ArgVec.push_back(Mask);
2001   const ExprMapKeyType Key(Instruction::ShuffleVector,ArgVec);
2002   return ExprConstants->getOrCreate(ReqTy, Key);
2003 }
2004
2005 Constant *ConstantExpr::getShuffleVector(Constant *V1, Constant *V2, 
2006                                          Constant *Mask) {
2007   assert(ShuffleVectorInst::isValidOperands(V1, V2, Mask) &&
2008          "Invalid shuffle vector constant expr operands!");
2009   return getShuffleVectorTy(V1->getType(), V1, V2, Mask);
2010 }
2011
2012 Constant *ConstantExpr::getZeroValueForNegationExpr(const Type *Ty) {
2013   if (const VectorType *PTy = dyn_cast<VectorType>(Ty))
2014     if (PTy->getElementType()->isFloatingPoint()) {
2015       std::vector<Constant*> zeros(PTy->getNumElements(),
2016                            ConstantFP::getNegativeZero(PTy->getElementType()));
2017       return ConstantVector::get(PTy, zeros);
2018     }
2019
2020   if (Ty->isFloatingPoint()) 
2021     return ConstantFP::getNegativeZero(Ty);
2022
2023   return Constant::getNullValue(Ty);
2024 }
2025
2026 // destroyConstant - Remove the constant from the constant table...
2027 //
2028 void ConstantExpr::destroyConstant() {
2029   ExprConstants->remove(this);
2030   destroyConstantImpl();
2031 }
2032
2033 const char *ConstantExpr::getOpcodeName() const {
2034   return Instruction::getOpcodeName(getOpcode());
2035 }
2036
2037 //===----------------------------------------------------------------------===//
2038 //                replaceUsesOfWithOnConstant implementations
2039
2040 /// replaceUsesOfWithOnConstant - Update this constant array to change uses of
2041 /// 'From' to be uses of 'To'.  This must update the uniquing data structures
2042 /// etc.
2043 ///
2044 /// Note that we intentionally replace all uses of From with To here.  Consider
2045 /// a large array that uses 'From' 1000 times.  By handling this case all here,
2046 /// ConstantArray::replaceUsesOfWithOnConstant is only invoked once, and that
2047 /// single invocation handles all 1000 uses.  Handling them one at a time would
2048 /// work, but would be really slow because it would have to unique each updated
2049 /// array instance.
2050 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
2051                                                 Use *U) {
2052   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2053   Constant *ToC = cast<Constant>(To);
2054
2055   std::pair<ArrayConstantsTy::MapKey, Constant*> Lookup;
2056   Lookup.first.first = getType();
2057   Lookup.second = this;
2058
2059   std::vector<Constant*> &Values = Lookup.first.second;
2060   Values.reserve(getNumOperands());  // Build replacement array.
2061
2062   // Fill values with the modified operands of the constant array.  Also, 
2063   // compute whether this turns into an all-zeros array.
2064   bool isAllZeros = false;
2065   unsigned NumUpdated = 0;
2066   if (!ToC->isNullValue()) {
2067     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2068       Constant *Val = cast<Constant>(O->get());
2069       if (Val == From) {
2070         Val = ToC;
2071         ++NumUpdated;
2072       }
2073       Values.push_back(Val);
2074     }
2075   } else {
2076     isAllZeros = true;
2077     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2078       Constant *Val = cast<Constant>(O->get());
2079       if (Val == From) {
2080         Val = ToC;
2081         ++NumUpdated;
2082       }
2083       Values.push_back(Val);
2084       if (isAllZeros) isAllZeros = Val->isNullValue();
2085     }
2086   }
2087   
2088   Constant *Replacement = 0;
2089   if (isAllZeros) {
2090     Replacement = ConstantAggregateZero::get(getType());
2091   } else {
2092     // Check to see if we have this array type already.
2093     bool Exists;
2094     ArrayConstantsTy::MapTy::iterator I =
2095       ArrayConstants->InsertOrGetItem(Lookup, Exists);
2096     
2097     if (Exists) {
2098       Replacement = I->second;
2099     } else {
2100       // Okay, the new shape doesn't exist in the system yet.  Instead of
2101       // creating a new constant array, inserting it, replaceallusesof'ing the
2102       // old with the new, then deleting the old... just update the current one
2103       // in place!
2104       ArrayConstants->MoveConstantToNewSlot(this, I);
2105       
2106       // Update to the new value.  Optimize for the case when we have a single
2107       // operand that we're changing, but handle bulk updates efficiently.
2108       if (NumUpdated == 1) {
2109         unsigned OperandToUpdate = U-OperandList;
2110         assert(getOperand(OperandToUpdate) == From &&
2111                "ReplaceAllUsesWith broken!");
2112         setOperand(OperandToUpdate, ToC);
2113       } else {
2114         for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
2115           if (getOperand(i) == From)
2116             setOperand(i, ToC);
2117       }
2118       return;
2119     }
2120   }
2121  
2122   // Otherwise, I do need to replace this with an existing value.
2123   assert(Replacement != this && "I didn't contain From!");
2124   
2125   // Everyone using this now uses the replacement.
2126   uncheckedReplaceAllUsesWith(Replacement);
2127   
2128   // Delete the old constant!
2129   destroyConstant();
2130 }
2131
2132 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
2133                                                  Use *U) {
2134   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2135   Constant *ToC = cast<Constant>(To);
2136
2137   unsigned OperandToUpdate = U-OperandList;
2138   assert(getOperand(OperandToUpdate) == From && "ReplaceAllUsesWith broken!");
2139
2140   std::pair<StructConstantsTy::MapKey, Constant*> Lookup;
2141   Lookup.first.first = getType();
2142   Lookup.second = this;
2143   std::vector<Constant*> &Values = Lookup.first.second;
2144   Values.reserve(getNumOperands());  // Build replacement struct.
2145   
2146   
2147   // Fill values with the modified operands of the constant struct.  Also, 
2148   // compute whether this turns into an all-zeros struct.
2149   bool isAllZeros = false;
2150   if (!ToC->isNullValue()) {
2151     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O)
2152       Values.push_back(cast<Constant>(O->get()));
2153   } else {
2154     isAllZeros = true;
2155     for (Use *O = OperandList, *E = OperandList+getNumOperands(); O != E; ++O) {
2156       Constant *Val = cast<Constant>(O->get());
2157       Values.push_back(Val);
2158       if (isAllZeros) isAllZeros = Val->isNullValue();
2159     }
2160   }
2161   Values[OperandToUpdate] = ToC;
2162   
2163   Constant *Replacement = 0;
2164   if (isAllZeros) {
2165     Replacement = ConstantAggregateZero::get(getType());
2166   } else {
2167     // Check to see if we have this array type already.
2168     bool Exists;
2169     StructConstantsTy::MapTy::iterator I =
2170       StructConstants->InsertOrGetItem(Lookup, Exists);
2171     
2172     if (Exists) {
2173       Replacement = I->second;
2174     } else {
2175       // Okay, the new shape doesn't exist in the system yet.  Instead of
2176       // creating a new constant struct, inserting it, replaceallusesof'ing the
2177       // old with the new, then deleting the old... just update the current one
2178       // in place!
2179       StructConstants->MoveConstantToNewSlot(this, I);
2180       
2181       // Update to the new value.
2182       setOperand(OperandToUpdate, ToC);
2183       return;
2184     }
2185   }
2186   
2187   assert(Replacement != this && "I didn't contain From!");
2188   
2189   // Everyone using this now uses the replacement.
2190   uncheckedReplaceAllUsesWith(Replacement);
2191   
2192   // Delete the old constant!
2193   destroyConstant();
2194 }
2195
2196 void ConstantVector::replaceUsesOfWithOnConstant(Value *From, Value *To,
2197                                                  Use *U) {
2198   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
2199   
2200   std::vector<Constant*> Values;
2201   Values.reserve(getNumOperands());  // Build replacement array...
2202   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
2203     Constant *Val = getOperand(i);
2204     if (Val == From) Val = cast<Constant>(To);
2205     Values.push_back(Val);
2206   }
2207   
2208   Constant *Replacement = ConstantVector::get(getType(), Values);
2209   assert(Replacement != this && "I didn't contain From!");
2210   
2211   // Everyone using this now uses the replacement.
2212   uncheckedReplaceAllUsesWith(Replacement);
2213   
2214   // Delete the old constant!
2215   destroyConstant();
2216 }
2217
2218 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
2219                                                Use *U) {
2220   assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
2221   Constant *To = cast<Constant>(ToV);
2222   
2223   Constant *Replacement = 0;
2224   if (getOpcode() == Instruction::GetElementPtr) {
2225     SmallVector<Constant*, 8> Indices;
2226     Constant *Pointer = getOperand(0);
2227     Indices.reserve(getNumOperands()-1);
2228     if (Pointer == From) Pointer = To;
2229     
2230     for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
2231       Constant *Val = getOperand(i);
2232       if (Val == From) Val = To;
2233       Indices.push_back(Val);
2234     }
2235     Replacement = ConstantExpr::getGetElementPtr(Pointer,
2236                                                  &Indices[0], Indices.size());
2237   } else if (isCast()) {
2238     assert(getOperand(0) == From && "Cast only has one use!");
2239     Replacement = ConstantExpr::getCast(getOpcode(), To, getType());
2240   } else if (getOpcode() == Instruction::Select) {
2241     Constant *C1 = getOperand(0);
2242     Constant *C2 = getOperand(1);
2243     Constant *C3 = getOperand(2);
2244     if (C1 == From) C1 = To;
2245     if (C2 == From) C2 = To;
2246     if (C3 == From) C3 = To;
2247     Replacement = ConstantExpr::getSelect(C1, C2, C3);
2248   } else if (getOpcode() == Instruction::ExtractElement) {
2249     Constant *C1 = getOperand(0);
2250     Constant *C2 = getOperand(1);
2251     if (C1 == From) C1 = To;
2252     if (C2 == From) C2 = To;
2253     Replacement = ConstantExpr::getExtractElement(C1, C2);
2254   } else if (getOpcode() == Instruction::InsertElement) {
2255     Constant *C1 = getOperand(0);
2256     Constant *C2 = getOperand(1);
2257     Constant *C3 = getOperand(1);
2258     if (C1 == From) C1 = To;
2259     if (C2 == From) C2 = To;
2260     if (C3 == From) C3 = To;
2261     Replacement = ConstantExpr::getInsertElement(C1, C2, C3);
2262   } else if (getOpcode() == Instruction::ShuffleVector) {
2263     Constant *C1 = getOperand(0);
2264     Constant *C2 = getOperand(1);
2265     Constant *C3 = getOperand(2);
2266     if (C1 == From) C1 = To;
2267     if (C2 == From) C2 = To;
2268     if (C3 == From) C3 = To;
2269     Replacement = ConstantExpr::getShuffleVector(C1, C2, C3);
2270   } else if (isCompare()) {
2271     Constant *C1 = getOperand(0);
2272     Constant *C2 = getOperand(1);
2273     if (C1 == From) C1 = To;
2274     if (C2 == From) C2 = To;
2275     if (getOpcode() == Instruction::ICmp)
2276       Replacement = ConstantExpr::getICmp(getPredicate(), C1, C2);
2277     else
2278       Replacement = ConstantExpr::getFCmp(getPredicate(), C1, C2);
2279   } else if (getNumOperands() == 2) {
2280     Constant *C1 = getOperand(0);
2281     Constant *C2 = getOperand(1);
2282     if (C1 == From) C1 = To;
2283     if (C2 == From) C2 = To;
2284     Replacement = ConstantExpr::get(getOpcode(), C1, C2);
2285   } else {
2286     assert(0 && "Unknown ConstantExpr type!");
2287     return;
2288   }
2289   
2290   assert(Replacement != this && "I didn't contain From!");
2291   
2292   // Everyone using this now uses the replacement.
2293   uncheckedReplaceAllUsesWith(Replacement);
2294   
2295   // Delete the old constant!
2296   destroyConstant();
2297 }
2298
2299
2300 /// getStringValue - Turn an LLVM constant pointer that eventually points to a
2301 /// global into a string value.  Return an empty string if we can't do it.
2302 /// Parameter Chop determines if the result is chopped at the first null
2303 /// terminator.
2304 ///
2305 std::string Constant::getStringValue(bool Chop, unsigned Offset) {
2306   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(this)) {
2307     if (GV->hasInitializer() && isa<ConstantArray>(GV->getInitializer())) {
2308       ConstantArray *Init = cast<ConstantArray>(GV->getInitializer());
2309       if (Init->isString()) {
2310         std::string Result = Init->getAsString();
2311         if (Offset < Result.size()) {
2312           // If we are pointing INTO The string, erase the beginning...
2313           Result.erase(Result.begin(), Result.begin()+Offset);
2314
2315           // Take off the null terminator, and any string fragments after it.
2316           if (Chop) {
2317             std::string::size_type NullPos = Result.find_first_of((char)0);
2318             if (NullPos != std::string::npos)
2319               Result.erase(Result.begin()+NullPos, Result.end());
2320           }
2321           return Result;
2322         }
2323       }
2324     }
2325   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(this)) {
2326     if (CE->getOpcode() == Instruction::GetElementPtr) {
2327       // Turn a gep into the specified offset.
2328       if (CE->getNumOperands() == 3 &&
2329           cast<Constant>(CE->getOperand(1))->isNullValue() &&
2330           isa<ConstantInt>(CE->getOperand(2))) {
2331         Offset += cast<ConstantInt>(CE->getOperand(2))->getZExtValue();
2332         return CE->getOperand(0)->getStringValue(Chop, Offset);
2333       }
2334     }
2335   }
2336   return "";
2337 }