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