Fix a latent bug in select constantexpr handling that was broke 253.perlbmk
[oota-llvm.git] / lib / VMCore / Constants.cpp
1 //===-- Constants.cpp - Implement Constant nodes --------------------------===//
2 // 
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 // 
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the Constant* classes...
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "llvm/Constants.h"
15 #include "ConstantFolding.h"
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/iMemory.h"
18 #include "llvm/SymbolTable.h"
19 #include "llvm/Module.h"
20 #include "Support/StringExtras.h"
21 #include <algorithm>
22 using namespace llvm;
23
24 ConstantBool *ConstantBool::True  = new ConstantBool(true);
25 ConstantBool *ConstantBool::False = new ConstantBool(false);
26
27
28 //===----------------------------------------------------------------------===//
29 //                              Constant Class
30 //===----------------------------------------------------------------------===//
31
32 // Specialize setName to take care of symbol table majik
33 void Constant::setName(const std::string &Name, SymbolTable *ST) {
34   assert(ST && "Type::setName - Must provide symbol table argument!");
35
36   if (Name.size()) ST->insert(Name, this);
37 }
38
39 void Constant::destroyConstantImpl() {
40   // When a Constant is destroyed, there may be lingering
41   // references to the constant by other constants in the constant pool.  These
42   // constants are implicitly dependent on the module that is being deleted,
43   // but they don't know that.  Because we only find out when the CPV is
44   // deleted, we must now notify all of our users (that should only be
45   // Constants) that they are, in fact, invalid now and should be deleted.
46   //
47   while (!use_empty()) {
48     Value *V = use_back();
49 #ifndef NDEBUG      // Only in -g mode...
50     if (!isa<Constant>(V))
51       std::cerr << "While deleting: " << *this
52                 << "\n\nUse still stuck around after Def is destroyed: "
53                 << *V << "\n\n";
54 #endif
55     assert(isa<Constant>(V) && "References remain to Constant being destroyed");
56     Constant *CPV = cast<Constant>(V);
57     CPV->destroyConstant();
58
59     // The constant should remove itself from our use list...
60     assert((use_empty() || use_back() != V) && "Constant not removed!");
61   }
62
63   // Value has no outstanding references it is safe to delete it now...
64   delete this;
65 }
66
67 // Static constructor to create a '0' constant of arbitrary type...
68 Constant *Constant::getNullValue(const Type *Ty) {
69   switch (Ty->getPrimitiveID()) {
70   case Type::BoolTyID: {
71     static Constant *NullBool = ConstantBool::get(false);
72     return NullBool;
73   }
74   case Type::SByteTyID: {
75     static Constant *NullSByte = ConstantSInt::get(Type::SByteTy, 0);
76     return NullSByte;
77   }
78   case Type::UByteTyID: {
79     static Constant *NullUByte = ConstantUInt::get(Type::UByteTy, 0);
80     return NullUByte;
81   }
82   case Type::ShortTyID: {
83     static Constant *NullShort = ConstantSInt::get(Type::ShortTy, 0);
84     return NullShort;
85   }
86   case Type::UShortTyID: {
87     static Constant *NullUShort = ConstantUInt::get(Type::UShortTy, 0);
88     return NullUShort;
89   }
90   case Type::IntTyID: {
91     static Constant *NullInt = ConstantSInt::get(Type::IntTy, 0);
92     return NullInt;
93   }
94   case Type::UIntTyID: {
95     static Constant *NullUInt = ConstantUInt::get(Type::UIntTy, 0);
96     return NullUInt;
97   }
98   case Type::LongTyID: {
99     static Constant *NullLong = ConstantSInt::get(Type::LongTy, 0);
100     return NullLong;
101   }
102   case Type::ULongTyID: {
103     static Constant *NullULong = ConstantUInt::get(Type::ULongTy, 0);
104     return NullULong;
105   }
106
107   case Type::FloatTyID: {
108     static Constant *NullFloat = ConstantFP::get(Type::FloatTy, 0);
109     return NullFloat;
110   }
111   case Type::DoubleTyID: {
112     static Constant *NullDouble = ConstantFP::get(Type::DoubleTy, 0);
113     return NullDouble;
114   }
115
116   case Type::PointerTyID: 
117     return ConstantPointerNull::get(cast<PointerType>(Ty));
118
119   case Type::StructTyID:
120   case Type::ArrayTyID:
121     return ConstantAggregateZero::get(Ty);
122   default:
123     // Function, Type, Label, or Opaque type?
124     assert(0 && "Cannot create a null constant of that type!");
125     return 0;
126   }
127 }
128
129 // Static constructor to create the maximum constant of an integral type...
130 ConstantIntegral *ConstantIntegral::getMaxValue(const Type *Ty) {
131   switch (Ty->getPrimitiveID()) {
132   case Type::BoolTyID:   return ConstantBool::True;
133   case Type::SByteTyID:
134   case Type::ShortTyID:
135   case Type::IntTyID:
136   case Type::LongTyID: {
137     // Calculate 011111111111111... 
138     unsigned TypeBits = Ty->getPrimitiveSize()*8;
139     int64_t Val = INT64_MAX;             // All ones
140     Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
141     return ConstantSInt::get(Ty, Val);
142   }
143
144   case Type::UByteTyID:
145   case Type::UShortTyID:
146   case Type::UIntTyID:
147   case Type::ULongTyID:  return getAllOnesValue(Ty);
148
149   default: return 0;
150   }
151 }
152
153 // Static constructor to create the minimum constant for an integral type...
154 ConstantIntegral *ConstantIntegral::getMinValue(const Type *Ty) {
155   switch (Ty->getPrimitiveID()) {
156   case Type::BoolTyID:   return ConstantBool::False;
157   case Type::SByteTyID:
158   case Type::ShortTyID:
159   case Type::IntTyID:
160   case Type::LongTyID: {
161      // Calculate 1111111111000000000000 
162      unsigned TypeBits = Ty->getPrimitiveSize()*8;
163      int64_t Val = -1;                    // All ones
164      Val <<= TypeBits-1;                  // Shift over to the right spot
165      return ConstantSInt::get(Ty, Val);
166   }
167
168   case Type::UByteTyID:
169   case Type::UShortTyID:
170   case Type::UIntTyID:
171   case Type::ULongTyID:  return ConstantUInt::get(Ty, 0);
172
173   default: return 0;
174   }
175 }
176
177 // Static constructor to create an integral constant with all bits set
178 ConstantIntegral *ConstantIntegral::getAllOnesValue(const Type *Ty) {
179   switch (Ty->getPrimitiveID()) {
180   case Type::BoolTyID:   return ConstantBool::True;
181   case Type::SByteTyID:
182   case Type::ShortTyID:
183   case Type::IntTyID:
184   case Type::LongTyID:   return ConstantSInt::get(Ty, -1);
185
186   case Type::UByteTyID:
187   case Type::UShortTyID:
188   case Type::UIntTyID:
189   case Type::ULongTyID: {
190     // Calculate ~0 of the right type...
191     unsigned TypeBits = Ty->getPrimitiveSize()*8;
192     uint64_t Val = ~0ULL;                // All ones
193     Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
194     return ConstantUInt::get(Ty, Val);
195   }
196   default: return 0;
197   }
198 }
199
200 bool ConstantUInt::isAllOnesValue() const {
201   unsigned TypeBits = getType()->getPrimitiveSize()*8;
202   uint64_t Val = ~0ULL;                // All ones
203   Val >>= 64-TypeBits;                 // Shift out inappropriate bits
204   return getValue() == Val;
205 }
206
207
208 //===----------------------------------------------------------------------===//
209 //                            ConstantXXX Classes
210 //===----------------------------------------------------------------------===//
211
212 //===----------------------------------------------------------------------===//
213 //                             Normal Constructors
214
215 ConstantBool::ConstantBool(bool V) : ConstantIntegral(Type::BoolTy) {
216   Val = V;
217 }
218
219 ConstantInt::ConstantInt(const Type *Ty, uint64_t V) : ConstantIntegral(Ty) {
220   Val.Unsigned = V;
221 }
222
223 ConstantSInt::ConstantSInt(const Type *Ty, int64_t V) : ConstantInt(Ty, V) {
224   assert(Ty->isInteger() && Ty->isSigned() &&
225          "Illegal type for unsigned integer constant!");
226   assert(isValueValidForType(Ty, V) && "Value too large for type!");
227 }
228
229 ConstantUInt::ConstantUInt(const Type *Ty, uint64_t V) : ConstantInt(Ty, V) {
230   assert(Ty->isInteger() && Ty->isUnsigned() &&
231          "Illegal type for unsigned integer constant!");
232   assert(isValueValidForType(Ty, V) && "Value too large for type!");
233 }
234
235 ConstantFP::ConstantFP(const Type *Ty, double V) : Constant(Ty) {
236   assert(isValueValidForType(Ty, V) && "Value too large for type!");
237   Val = V;
238 }
239
240 ConstantArray::ConstantArray(const ArrayType *T,
241                              const std::vector<Constant*> &V) : Constant(T) {
242   Operands.reserve(V.size());
243   for (unsigned i = 0, e = V.size(); i != e; ++i) {
244     assert(V[i]->getType() == T->getElementType() ||
245            (T->isAbstract() &&
246             V[i]->getType()->getPrimitiveID() ==
247             T->getElementType()->getPrimitiveID()));
248     Operands.push_back(Use(V[i], this));
249   }
250 }
251
252 ConstantStruct::ConstantStruct(const StructType *T,
253                                const std::vector<Constant*> &V) : Constant(T) {
254   assert(V.size() == T->getNumElements() &&
255          "Invalid initializer vector for constant structure");
256   Operands.reserve(V.size());
257   for (unsigned i = 0, e = V.size(); i != e; ++i) {
258     assert((V[i]->getType() == T->getElementType(i) ||
259             ((T->getElementType(i)->isAbstract() ||
260               V[i]->getType()->isAbstract()) &&
261              T->getElementType(i)->getPrimitiveID() == 
262                       V[i]->getType()->getPrimitiveID())) &&
263            "Initializer for struct element doesn't match struct element type!");
264     Operands.push_back(Use(V[i], this));
265   }
266 }
267
268 ConstantPointerRef::ConstantPointerRef(GlobalValue *GV)
269   : Constant(GV->getType()) {
270   Operands.reserve(1);
271   Operands.push_back(Use(GV, this));
272 }
273
274 ConstantExpr::ConstantExpr(unsigned Opcode, Constant *C, const Type *Ty)
275   : Constant(Ty), iType(Opcode) {
276   Operands.reserve(1);
277   Operands.push_back(Use(C, this));
278 }
279
280 // Select instruction creation ctor
281 ConstantExpr::ConstantExpr(Constant *C, Constant *V1, Constant *V2)
282   : Constant(V1->getType()), iType(Instruction::Select) {
283   Operands.reserve(3);
284   Operands.push_back(Use(C, this));
285   Operands.push_back(Use(V1, this));
286   Operands.push_back(Use(V2, this));
287 }
288
289
290 static bool isSetCC(unsigned Opcode) {
291   return Opcode == Instruction::SetEQ || Opcode == Instruction::SetNE ||
292          Opcode == Instruction::SetLT || Opcode == Instruction::SetGT ||
293          Opcode == Instruction::SetLE || Opcode == Instruction::SetGE;
294 }
295
296 ConstantExpr::ConstantExpr(unsigned Opcode, Constant *C1, Constant *C2)
297   : Constant(isSetCC(Opcode) ? Type::BoolTy : C1->getType()), iType(Opcode) {
298   Operands.reserve(2);
299   Operands.push_back(Use(C1, this));
300   Operands.push_back(Use(C2, this));
301 }
302
303 ConstantExpr::ConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
304                            const Type *DestTy)
305   : Constant(DestTy), iType(Instruction::GetElementPtr) {
306   Operands.reserve(1+IdxList.size());
307   Operands.push_back(Use(C, this));
308   for (unsigned i = 0, E = IdxList.size(); i != E; ++i)
309     Operands.push_back(Use(IdxList[i], this));
310 }
311
312 /// ConstantExpr::get* - Return some common constants without having to
313 /// specify the full Instruction::OPCODE identifier.
314 ///
315 Constant *ConstantExpr::getNeg(Constant *C) {
316   if (!C->getType()->isFloatingPoint())
317     return get(Instruction::Sub, getNullValue(C->getType()), C);
318   else
319     return get(Instruction::Sub, ConstantFP::get(C->getType(), -0.0), C);
320 }
321 Constant *ConstantExpr::getNot(Constant *C) {
322   assert(isa<ConstantIntegral>(C) && "Cannot NOT a nonintegral type!");
323   return get(Instruction::Xor, C,
324              ConstantIntegral::getAllOnesValue(C->getType()));
325 }
326 Constant *ConstantExpr::getAdd(Constant *C1, Constant *C2) {
327   return get(Instruction::Add, C1, C2);
328 }
329 Constant *ConstantExpr::getSub(Constant *C1, Constant *C2) {
330   return get(Instruction::Sub, C1, C2);
331 }
332 Constant *ConstantExpr::getMul(Constant *C1, Constant *C2) {
333   return get(Instruction::Mul, C1, C2);
334 }
335 Constant *ConstantExpr::getDiv(Constant *C1, Constant *C2) {
336   return get(Instruction::Div, C1, C2);
337 }
338 Constant *ConstantExpr::getRem(Constant *C1, Constant *C2) {
339   return get(Instruction::Rem, C1, C2);
340 }
341 Constant *ConstantExpr::getAnd(Constant *C1, Constant *C2) {
342   return get(Instruction::And, C1, C2);
343 }
344 Constant *ConstantExpr::getOr(Constant *C1, Constant *C2) {
345   return get(Instruction::Or, C1, C2);
346 }
347 Constant *ConstantExpr::getXor(Constant *C1, Constant *C2) {
348   return get(Instruction::Xor, C1, C2);
349 }
350 Constant *ConstantExpr::getSetEQ(Constant *C1, Constant *C2) {
351   return get(Instruction::SetEQ, C1, C2);
352 }
353 Constant *ConstantExpr::getSetNE(Constant *C1, Constant *C2) {
354   return get(Instruction::SetNE, C1, C2);
355 }
356 Constant *ConstantExpr::getSetLT(Constant *C1, Constant *C2) {
357   return get(Instruction::SetLT, C1, C2);
358 }
359 Constant *ConstantExpr::getSetGT(Constant *C1, Constant *C2) {
360   return get(Instruction::SetGT, C1, C2);
361 }
362 Constant *ConstantExpr::getSetLE(Constant *C1, Constant *C2) {
363   return get(Instruction::SetLE, C1, C2);
364 }
365 Constant *ConstantExpr::getSetGE(Constant *C1, Constant *C2) {
366   return get(Instruction::SetGE, C1, C2);
367 }
368 Constant *ConstantExpr::getShl(Constant *C1, Constant *C2) {
369   return get(Instruction::Shl, C1, C2);
370 }
371 Constant *ConstantExpr::getShr(Constant *C1, Constant *C2) {
372   return get(Instruction::Shr, C1, C2);
373 }
374
375
376
377
378 //===----------------------------------------------------------------------===//
379 //                           classof implementations
380
381 bool ConstantIntegral::classof(const Constant *CPV) {
382   return CPV->getType()->isIntegral() && !isa<ConstantExpr>(CPV);
383 }
384
385 bool ConstantInt::classof(const Constant *CPV) {
386   return CPV->getType()->isInteger() && !isa<ConstantExpr>(CPV);
387 }
388 bool ConstantSInt::classof(const Constant *CPV) {
389   return CPV->getType()->isSigned() && !isa<ConstantExpr>(CPV);
390 }
391 bool ConstantUInt::classof(const Constant *CPV) {
392   return CPV->getType()->isUnsigned() && !isa<ConstantExpr>(CPV);
393 }
394 bool ConstantFP::classof(const Constant *CPV) {
395   const Type *Ty = CPV->getType();
396   return ((Ty == Type::FloatTy || Ty == Type::DoubleTy) &&
397           !isa<ConstantExpr>(CPV));
398 }
399 bool ConstantAggregateZero::classof(const Constant *CPV) {
400   return (isa<ArrayType>(CPV->getType()) || isa<StructType>(CPV->getType())) &&
401          CPV->isNullValue();
402 }
403 bool ConstantArray::classof(const Constant *CPV) {
404   return isa<ArrayType>(CPV->getType()) && !CPV->isNullValue();
405 }
406 bool ConstantStruct::classof(const Constant *CPV) {
407   return isa<StructType>(CPV->getType()) && !CPV->isNullValue();
408 }
409
410 bool ConstantPointerNull::classof(const Constant *CPV) {
411   return isa<PointerType>(CPV->getType()) && !isa<ConstantExpr>(CPV) &&
412          CPV->getNumOperands() == 0;
413 }
414
415 bool ConstantPointerRef::classof(const Constant *CPV) {
416   return isa<PointerType>(CPV->getType()) && !isa<ConstantExpr>(CPV) &&
417          CPV->getNumOperands() == 1;
418 }
419
420
421
422 //===----------------------------------------------------------------------===//
423 //                      isValueValidForType implementations
424
425 bool ConstantSInt::isValueValidForType(const Type *Ty, int64_t Val) {
426   switch (Ty->getPrimitiveID()) {
427   default:
428     return false;         // These can't be represented as integers!!!
429
430     // Signed types...
431   case Type::SByteTyID:
432     return (Val <= INT8_MAX && Val >= INT8_MIN);
433   case Type::ShortTyID:
434     return (Val <= INT16_MAX && Val >= INT16_MIN);
435   case Type::IntTyID:
436     return (Val <= INT32_MAX && Val >= INT32_MIN);
437   case Type::LongTyID:
438     return true;          // This is the largest type...
439   }
440   assert(0 && "WTF?");
441   return false;
442 }
443
444 bool ConstantUInt::isValueValidForType(const Type *Ty, uint64_t Val) {
445   switch (Ty->getPrimitiveID()) {
446   default:
447     return false;         // These can't be represented as integers!!!
448
449     // Unsigned types...
450   case Type::UByteTyID:
451     return (Val <= UINT8_MAX);
452   case Type::UShortTyID:
453     return (Val <= UINT16_MAX);
454   case Type::UIntTyID:
455     return (Val <= UINT32_MAX);
456   case Type::ULongTyID:
457     return true;          // This is the largest type...
458   }
459   assert(0 && "WTF?");
460   return false;
461 }
462
463 bool ConstantFP::isValueValidForType(const Type *Ty, double Val) {
464   switch (Ty->getPrimitiveID()) {
465   default:
466     return false;         // These can't be represented as floating point!
467
468     // TODO: Figure out how to test if a double can be cast to a float!
469   case Type::FloatTyID:
470   case Type::DoubleTyID:
471     return true;          // This is the largest type...
472   }
473 };
474
475 //===----------------------------------------------------------------------===//
476 //                replaceUsesOfWithOnConstant implementations
477
478 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
479                                                 bool DisableChecking) {
480   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
481
482   std::vector<Constant*> Values;
483   Values.reserve(getValues().size());  // Build replacement array...
484   for (unsigned i = 0, e = getValues().size(); i != e; ++i) {
485     Constant *Val = cast<Constant>(getValues()[i]);
486     if (Val == From) Val = cast<Constant>(To);
487     Values.push_back(Val);
488   }
489   
490   Constant *Replacement = ConstantArray::get(getType(), Values);
491   assert(Replacement != this && "I didn't contain From!");
492
493   // Everyone using this now uses the replacement...
494   if (DisableChecking)
495     uncheckedReplaceAllUsesWith(Replacement);
496   else
497     replaceAllUsesWith(Replacement);
498   
499   // Delete the old constant!
500   destroyConstant();  
501 }
502
503 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
504                                                  bool DisableChecking) {
505   assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
506
507   std::vector<Constant*> Values;
508   Values.reserve(getValues().size());
509   for (unsigned i = 0, e = getValues().size(); i != e; ++i) {
510     Constant *Val = cast<Constant>(getValues()[i]);
511     if (Val == From) Val = cast<Constant>(To);
512     Values.push_back(Val);
513   }
514   
515   Constant *Replacement = ConstantStruct::get(getType(), Values);
516   assert(Replacement != this && "I didn't contain From!");
517
518   // Everyone using this now uses the replacement...
519   if (DisableChecking)
520     uncheckedReplaceAllUsesWith(Replacement);
521   else
522     replaceAllUsesWith(Replacement);
523   
524   // Delete the old constant!
525   destroyConstant();
526 }
527
528 void ConstantPointerRef::replaceUsesOfWithOnConstant(Value *From, Value *To,
529                                                      bool DisableChecking) {
530   if (isa<GlobalValue>(To)) {
531     assert(From == getOperand(0) && "Doesn't contain from!");
532     ConstantPointerRef *Replacement =
533       ConstantPointerRef::get(cast<GlobalValue>(To));
534     
535     // Everyone using this now uses the replacement...
536     if (DisableChecking)
537       uncheckedReplaceAllUsesWith(Replacement);
538     else
539       replaceAllUsesWith(Replacement);
540     
541   } else {
542     // Just replace ourselves with the To value specified.
543     if (DisableChecking)
544       uncheckedReplaceAllUsesWith(To);
545     else
546       replaceAllUsesWith(To);
547   }
548
549   // Delete the old constant!
550   destroyConstant();
551 }
552
553 void ConstantExpr::replaceUsesOfWithOnConstant(Value *From, Value *ToV,
554                                                bool DisableChecking) {
555   assert(isa<Constant>(ToV) && "Cannot make Constant refer to non-constant!");
556   Constant *To = cast<Constant>(ToV);
557
558   Constant *Replacement = 0;
559   if (getOpcode() == Instruction::GetElementPtr) {
560     std::vector<Constant*> Indices;
561     Constant *Pointer = getOperand(0);
562     Indices.reserve(getNumOperands()-1);
563     if (Pointer == From) Pointer = To;
564     
565     for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
566       Constant *Val = getOperand(i);
567       if (Val == From) Val = To;
568       Indices.push_back(Val);
569     }
570     Replacement = ConstantExpr::getGetElementPtr(Pointer, Indices);
571   } else if (getOpcode() == Instruction::Cast) {
572     assert(getOperand(0) == From && "Cast only has one use!");
573     Replacement = ConstantExpr::getCast(To, getType());
574   } else if (getNumOperands() == 2) {
575     Constant *C1 = getOperand(0);
576     Constant *C2 = getOperand(1);
577     if (C1 == From) C1 = To;
578     if (C2 == From) C2 = To;
579     Replacement = ConstantExpr::get(getOpcode(), C1, C2);
580   } else {
581     assert(0 && "Unknown ConstantExpr type!");
582     return;
583   }
584   
585   assert(Replacement != this && "I didn't contain From!");
586
587   // Everyone using this now uses the replacement...
588   if (DisableChecking)
589     uncheckedReplaceAllUsesWith(Replacement);
590   else
591     replaceAllUsesWith(Replacement);
592   
593   // Delete the old constant!
594   destroyConstant();
595 }
596
597 //===----------------------------------------------------------------------===//
598 //                      Factory Function Implementation
599
600 // ConstantCreator - A class that is used to create constants by
601 // ValueMap*.  This class should be partially specialized if there is
602 // something strange that needs to be done to interface to the ctor for the
603 // constant.
604 //
605 namespace llvm {
606   template<class ConstantClass, class TypeClass, class ValType>
607   struct ConstantCreator {
608     static ConstantClass *create(const TypeClass *Ty, const ValType &V) {
609       return new ConstantClass(Ty, V);
610     }
611   };
612   
613   template<class ConstantClass, class TypeClass>
614   struct ConvertConstantType {
615     static void convert(ConstantClass *OldC, const TypeClass *NewTy) {
616       assert(0 && "This type cannot be converted!\n");
617       abort();
618     }
619   };
620 }
621
622 namespace {
623   template<class ValType, class TypeClass, class ConstantClass>
624   class ValueMap : public AbstractTypeUser {
625     typedef std::pair<const TypeClass*, ValType> MapKey;
626     typedef std::map<MapKey, ConstantClass *> MapTy;
627     typedef typename MapTy::iterator MapIterator;
628     MapTy Map;
629
630     typedef std::map<const TypeClass*, MapIterator> AbstractTypeMapTy;
631     AbstractTypeMapTy AbstractTypeMap;
632   public:
633     // getOrCreate - Return the specified constant from the map, creating it if
634     // necessary.
635     ConstantClass *getOrCreate(const TypeClass *Ty, const ValType &V) {
636       MapKey Lookup(Ty, V);
637       MapIterator I = Map.lower_bound(Lookup);
638       if (I != Map.end() && I->first == Lookup)
639         return I->second;  // Is it in the map?
640
641       // If no preexisting value, create one now...
642       ConstantClass *Result =
643         ConstantCreator<ConstantClass,TypeClass,ValType>::create(Ty, V);
644
645
646       /// FIXME: why does this assert fail when loading 176.gcc?
647       //assert(Result->getType() == Ty && "Type specified is not correct!");
648       I = Map.insert(I, std::make_pair(MapKey(Ty, V), Result));
649
650       // If the type of the constant is abstract, make sure that an entry exists
651       // for it in the AbstractTypeMap.
652       if (Ty->isAbstract()) {
653         typename AbstractTypeMapTy::iterator TI =
654           AbstractTypeMap.lower_bound(Ty);
655
656         if (TI == AbstractTypeMap.end() || TI->first != Ty) {
657           // Add ourselves to the ATU list of the type.
658           cast<DerivedType>(Ty)->addAbstractTypeUser(this);
659
660           AbstractTypeMap.insert(TI, std::make_pair(Ty, I));
661         }
662       }
663       return Result;
664     }
665     
666     void remove(ConstantClass *CP) {
667       // FIXME: This should not use a linear scan.  If this gets to be a
668       // performance problem, someone should look at this.
669       MapIterator I = Map.begin();
670       for (MapIterator E = Map.end(); I != E && I->second != CP; ++I)
671         /* empty */;
672       
673       assert(I != Map.end() && "Constant not found in constant table!");
674
675       // Now that we found the entry, make sure this isn't the entry that
676       // the AbstractTypeMap points to.
677       const TypeClass *Ty = I->first.first;
678       if (Ty->isAbstract()) {
679         assert(AbstractTypeMap.count(Ty) &&
680                "Abstract type not in AbstractTypeMap?");
681         MapIterator &ATMEntryIt = AbstractTypeMap[Ty];
682         if (ATMEntryIt == I) {
683           // Yes, we are removing the representative entry for this type.
684           // See if there are any other entries of the same type.
685           MapIterator TmpIt = ATMEntryIt;
686           
687           // First check the entry before this one...
688           if (TmpIt != Map.begin()) {
689             --TmpIt;
690             if (TmpIt->first.first != Ty) // Not the same type, move back...
691               ++TmpIt;
692           }
693           
694           // If we didn't find the same type, try to move forward...
695           if (TmpIt == ATMEntryIt) {
696             ++TmpIt;
697             if (TmpIt == Map.end() || TmpIt->first.first != Ty)
698               --TmpIt;   // No entry afterwards with the same type
699           }
700
701           // If there is another entry in the map of the same abstract type,
702           // update the AbstractTypeMap entry now.
703           if (TmpIt != ATMEntryIt) {
704             ATMEntryIt = TmpIt;
705           } else {
706             // Otherwise, we are removing the last instance of this type
707             // from the table.  Remove from the ATM, and from user list.
708             cast<DerivedType>(Ty)->removeAbstractTypeUser(this);
709             AbstractTypeMap.erase(Ty);
710           }
711         }
712       }
713       
714       Map.erase(I);
715     }
716
717     void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
718       typename AbstractTypeMapTy::iterator I = 
719         AbstractTypeMap.find(cast<TypeClass>(OldTy));
720
721       assert(I != AbstractTypeMap.end() &&
722              "Abstract type not in AbstractTypeMap?");
723
724       // Convert a constant at a time until the last one is gone.  The last one
725       // leaving will remove() itself, causing the AbstractTypeMapEntry to be
726       // eliminated eventually.
727       do {
728         ConvertConstantType<ConstantClass,
729                             TypeClass>::convert(I->second->second,
730                                                 cast<TypeClass>(NewTy));
731
732         I = AbstractTypeMap.find(cast<TypeClass>(OldTy));
733       } while (I != AbstractTypeMap.end());
734     }
735
736     // If the type became concrete without being refined to any other existing
737     // type, we just remove ourselves from the ATU list.
738     void typeBecameConcrete(const DerivedType *AbsTy) {
739       AbsTy->removeAbstractTypeUser(this);
740     }
741
742     void dump() const {
743       std::cerr << "Constant.cpp: ValueMap\n";
744     }
745   };
746 }
747
748
749
750 //---- ConstantUInt::get() and ConstantSInt::get() implementations...
751 //
752 static ValueMap< int64_t, Type, ConstantSInt> SIntConstants;
753 static ValueMap<uint64_t, Type, ConstantUInt> UIntConstants;
754
755 ConstantSInt *ConstantSInt::get(const Type *Ty, int64_t V) {
756   return SIntConstants.getOrCreate(Ty, V);
757 }
758
759 ConstantUInt *ConstantUInt::get(const Type *Ty, uint64_t V) {
760   return UIntConstants.getOrCreate(Ty, V);
761 }
762
763 ConstantInt *ConstantInt::get(const Type *Ty, unsigned char V) {
764   assert(V <= 127 && "Can only be used with very small positive constants!");
765   if (Ty->isSigned()) return ConstantSInt::get(Ty, V);
766   return ConstantUInt::get(Ty, V);
767 }
768
769 //---- ConstantFP::get() implementation...
770 //
771 namespace llvm {
772   template<>
773   struct ConstantCreator<ConstantFP, Type, uint64_t> {
774     static ConstantFP *create(const Type *Ty, uint64_t V) {
775       assert(Ty == Type::DoubleTy);
776       union {
777         double F;
778         uint64_t I;
779       } T;
780       T.I = V;
781       return new ConstantFP(Ty, T.F);
782     }
783   };
784   template<>
785   struct ConstantCreator<ConstantFP, Type, uint32_t> {
786     static ConstantFP *create(const Type *Ty, uint32_t V) {
787       assert(Ty == Type::FloatTy);
788       union {
789         float F;
790         uint32_t I;
791       } T;
792       T.I = V;
793       return new ConstantFP(Ty, T.F);
794     }
795   };
796 }
797
798 static ValueMap<uint64_t, Type, ConstantFP> DoubleConstants;
799 static ValueMap<uint32_t, Type, ConstantFP> FloatConstants;
800
801 ConstantFP *ConstantFP::get(const Type *Ty, double V) {
802   if (Ty == Type::FloatTy) {
803     // Force the value through memory to normalize it.
804     union {
805       float F;
806       uint32_t I;
807     } T;
808     T.F = (float)V;
809     return FloatConstants.getOrCreate(Ty, T.I);
810   } else {
811     assert(Ty == Type::DoubleTy);
812     union {
813       double F;
814       uint64_t I;
815     } T;
816     T.F = V;
817     return DoubleConstants.getOrCreate(Ty, T.I);
818   }
819 }
820
821 //---- ConstantAggregateZero::get() implementation...
822 //
823 namespace llvm {
824   // ConstantAggregateZero does not take extra "value" argument...
825   template<class ValType>
826   struct ConstantCreator<ConstantAggregateZero, Type, ValType> {
827     static ConstantAggregateZero *create(const Type *Ty, const ValType &V){
828       return new ConstantAggregateZero(Ty);
829     }
830   };
831
832   template<>
833   struct ConvertConstantType<ConstantAggregateZero, Type> {
834     static void convert(ConstantAggregateZero *OldC, const Type *NewTy) {
835       // Make everyone now use a constant of the new type...
836       Constant *New = ConstantAggregateZero::get(NewTy);
837       assert(New != OldC && "Didn't replace constant??");
838       OldC->uncheckedReplaceAllUsesWith(New);
839       OldC->destroyConstant();     // This constant is now dead, destroy it.
840     }
841   };
842 }
843
844 static ValueMap<char, Type, ConstantAggregateZero> AggZeroConstants;
845
846 Constant *ConstantAggregateZero::get(const Type *Ty) {
847   return AggZeroConstants.getOrCreate(Ty, 0);
848 }
849
850 // destroyConstant - Remove the constant from the constant table...
851 //
852 void ConstantAggregateZero::destroyConstant() {
853   AggZeroConstants.remove(this);
854   destroyConstantImpl();
855 }
856
857 void ConstantAggregateZero::replaceUsesOfWithOnConstant(Value *From, Value *To,
858                                                         bool DisableChecking) {
859   assert(0 && "No uses!");
860   abort();
861 }
862
863
864
865 //---- ConstantArray::get() implementation...
866 //
867 namespace llvm {
868   template<>
869   struct ConvertConstantType<ConstantArray, ArrayType> {
870     static void convert(ConstantArray *OldC, const ArrayType *NewTy) {
871       // Make everyone now use a constant of the new type...
872       std::vector<Constant*> C;
873       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
874         C.push_back(cast<Constant>(OldC->getOperand(i)));
875       Constant *New = ConstantArray::get(NewTy, C);
876       assert(New != OldC && "Didn't replace constant??");
877       OldC->uncheckedReplaceAllUsesWith(New);
878       OldC->destroyConstant();    // This constant is now dead, destroy it.
879     }
880   };
881 }
882
883 static ValueMap<std::vector<Constant*>, ArrayType,
884                 ConstantArray> ArrayConstants;
885
886 Constant *ConstantArray::get(const ArrayType *Ty,
887                              const std::vector<Constant*> &V) {
888   // If this is an all-zero array, return a ConstantAggregateZero object
889   if (!V.empty()) {
890     Constant *C = V[0];
891     if (!C->isNullValue())
892       return ArrayConstants.getOrCreate(Ty, V);
893     for (unsigned i = 1, e = V.size(); i != e; ++i)
894       if (V[i] != C)
895         return ArrayConstants.getOrCreate(Ty, V);
896   }
897   return ConstantAggregateZero::get(Ty);
898 }
899
900 // destroyConstant - Remove the constant from the constant table...
901 //
902 void ConstantArray::destroyConstant() {
903   ArrayConstants.remove(this);
904   destroyConstantImpl();
905 }
906
907 // ConstantArray::get(const string&) - Return an array that is initialized to
908 // contain the specified string.  A null terminator is added to the specified
909 // string so that it may be used in a natural way...
910 //
911 Constant *ConstantArray::get(const std::string &Str) {
912   std::vector<Constant*> ElementVals;
913
914   for (unsigned i = 0; i < Str.length(); ++i)
915     ElementVals.push_back(ConstantSInt::get(Type::SByteTy, Str[i]));
916
917   // Add a null terminator to the string...
918   ElementVals.push_back(ConstantSInt::get(Type::SByteTy, 0));
919
920   ArrayType *ATy = ArrayType::get(Type::SByteTy, Str.length()+1);
921   return ConstantArray::get(ATy, ElementVals);
922 }
923
924 /// isString - This method returns true if the array is an array of sbyte or
925 /// ubyte, and if the elements of the array are all ConstantInt's.
926 bool ConstantArray::isString() const {
927   // Check the element type for sbyte or ubyte...
928   if (getType()->getElementType() != Type::UByteTy &&
929       getType()->getElementType() != Type::SByteTy)
930     return false;
931   // Check the elements to make sure they are all integers, not constant
932   // expressions.
933   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
934     if (!isa<ConstantInt>(getOperand(i)))
935       return false;
936   return true;
937 }
938
939 // getAsString - If the sub-element type of this array is either sbyte or ubyte,
940 // then this method converts the array to an std::string and returns it.
941 // Otherwise, it asserts out.
942 //
943 std::string ConstantArray::getAsString() const {
944   assert(isString() && "Not a string!");
945   std::string Result;
946   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
947     Result += (char)cast<ConstantInt>(getOperand(i))->getRawValue();
948   return Result;
949 }
950
951
952 //---- ConstantStruct::get() implementation...
953 //
954
955 namespace llvm {
956   template<>
957   struct ConvertConstantType<ConstantStruct, StructType> {
958     static void convert(ConstantStruct *OldC, const StructType *NewTy) {
959       // Make everyone now use a constant of the new type...
960       std::vector<Constant*> C;
961       for (unsigned i = 0, e = OldC->getNumOperands(); i != e; ++i)
962         C.push_back(cast<Constant>(OldC->getOperand(i)));
963       Constant *New = ConstantStruct::get(NewTy, C);
964       assert(New != OldC && "Didn't replace constant??");
965       
966       OldC->uncheckedReplaceAllUsesWith(New);
967       OldC->destroyConstant();    // This constant is now dead, destroy it.
968     }
969   };
970 }
971
972 static ValueMap<std::vector<Constant*>, StructType, 
973                 ConstantStruct> StructConstants;
974
975 Constant *ConstantStruct::get(const StructType *Ty,
976                               const std::vector<Constant*> &V) {
977   // Create a ConstantAggregateZero value if all elements are zeros...
978   for (unsigned i = 0, e = V.size(); i != e; ++i)
979     if (!V[i]->isNullValue())
980       return StructConstants.getOrCreate(Ty, V);
981
982   return ConstantAggregateZero::get(Ty);
983 }
984
985 // destroyConstant - Remove the constant from the constant table...
986 //
987 void ConstantStruct::destroyConstant() {
988   StructConstants.remove(this);
989   destroyConstantImpl();
990 }
991
992 //---- ConstantPointerNull::get() implementation...
993 //
994
995 namespace llvm {
996   // ConstantPointerNull does not take extra "value" argument...
997   template<class ValType>
998   struct ConstantCreator<ConstantPointerNull, PointerType, ValType> {
999     static ConstantPointerNull *create(const PointerType *Ty, const ValType &V){
1000       return new ConstantPointerNull(Ty);
1001     }
1002   };
1003
1004   template<>
1005   struct ConvertConstantType<ConstantPointerNull, PointerType> {
1006     static void convert(ConstantPointerNull *OldC, const PointerType *NewTy) {
1007       // Make everyone now use a constant of the new type...
1008       Constant *New = ConstantPointerNull::get(NewTy);
1009       assert(New != OldC && "Didn't replace constant??");
1010       OldC->uncheckedReplaceAllUsesWith(New);
1011       OldC->destroyConstant();     // This constant is now dead, destroy it.
1012     }
1013   };
1014 }
1015
1016 static ValueMap<char, PointerType, ConstantPointerNull> NullPtrConstants;
1017
1018 ConstantPointerNull *ConstantPointerNull::get(const PointerType *Ty) {
1019   return NullPtrConstants.getOrCreate(Ty, 0);
1020 }
1021
1022 // destroyConstant - Remove the constant from the constant table...
1023 //
1024 void ConstantPointerNull::destroyConstant() {
1025   NullPtrConstants.remove(this);
1026   destroyConstantImpl();
1027 }
1028
1029
1030 //---- ConstantPointerRef::get() implementation...
1031 //
1032 ConstantPointerRef *ConstantPointerRef::get(GlobalValue *GV) {
1033   assert(GV->getParent() && "Global Value must be attached to a module!");
1034   
1035   // The Module handles the pointer reference sharing...
1036   return GV->getParent()->getConstantPointerRef(GV);
1037 }
1038
1039 // destroyConstant - Remove the constant from the constant table...
1040 //
1041 void ConstantPointerRef::destroyConstant() {
1042   getValue()->getParent()->destroyConstantPointerRef(this);
1043   destroyConstantImpl();
1044 }
1045
1046
1047 //---- ConstantExpr::get() implementations...
1048 //
1049 typedef std::pair<unsigned, std::vector<Constant*> > ExprMapKeyType;
1050
1051 namespace llvm {
1052   template<>
1053   struct ConstantCreator<ConstantExpr, Type, ExprMapKeyType> {
1054     static ConstantExpr *create(const Type *Ty, const ExprMapKeyType &V) {
1055       if (V.first == Instruction::Cast)
1056         return new ConstantExpr(Instruction::Cast, V.second[0], Ty);
1057       if ((V.first >= Instruction::BinaryOpsBegin &&
1058            V.first < Instruction::BinaryOpsEnd) ||
1059           V.first == Instruction::Shl || V.first == Instruction::Shr)
1060         return new ConstantExpr(V.first, V.second[0], V.second[1]);
1061       if (V.first == Instruction::Select)
1062         return new ConstantExpr(V.second[0], V.second[1], V.second[2]);
1063       
1064       assert(V.first == Instruction::GetElementPtr && "Invalid ConstantExpr!");
1065       
1066       std::vector<Constant*> IdxList(V.second.begin()+1, V.second.end());
1067       return new ConstantExpr(V.second[0], IdxList, Ty);
1068     }
1069   };
1070
1071   template<>
1072   struct ConvertConstantType<ConstantExpr, Type> {
1073     static void convert(ConstantExpr *OldC, const Type *NewTy) {
1074       Constant *New;
1075       switch (OldC->getOpcode()) {
1076       case Instruction::Cast:
1077         New = ConstantExpr::getCast(OldC->getOperand(0), NewTy);
1078         break;
1079       case Instruction::Select:
1080         New = ConstantExpr::getSelectTy(NewTy, OldC->getOperand(0),
1081                                         OldC->getOperand(1),
1082                                         OldC->getOperand(2));
1083         break;
1084       case Instruction::Shl:
1085       case Instruction::Shr:
1086         New = ConstantExpr::getShiftTy(NewTy, OldC->getOpcode(),
1087                                      OldC->getOperand(0), OldC->getOperand(1));
1088         break;
1089       default:
1090         assert(OldC->getOpcode() >= Instruction::BinaryOpsBegin &&
1091                OldC->getOpcode() < Instruction::BinaryOpsEnd);
1092         New = ConstantExpr::getTy(NewTy, OldC->getOpcode(), OldC->getOperand(0),
1093                                   OldC->getOperand(1));
1094         break;
1095       case Instruction::GetElementPtr:
1096         // Make everyone now use a constant of the new type... 
1097         std::vector<Constant*> C;
1098         for (unsigned i = 1, e = OldC->getNumOperands(); i != e; ++i)
1099           C.push_back(cast<Constant>(OldC->getOperand(i)));
1100         New = ConstantExpr::getGetElementPtrTy(NewTy, OldC->getOperand(0), C);
1101         break;
1102       }
1103       
1104       assert(New != OldC && "Didn't replace constant??");
1105       OldC->uncheckedReplaceAllUsesWith(New);
1106       OldC->destroyConstant();    // This constant is now dead, destroy it.
1107     }
1108   };
1109 } // end namespace llvm
1110
1111
1112 static ValueMap<ExprMapKeyType, Type, ConstantExpr> ExprConstants;
1113
1114 Constant *ConstantExpr::getCast(Constant *C, const Type *Ty) {
1115   assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1116
1117   if (Constant *FC = ConstantFoldCastInstruction(C, Ty))
1118     return FC;          // Fold a few common cases...
1119
1120   // Look up the constant in the table first to ensure uniqueness
1121   std::vector<Constant*> argVec(1, C);
1122   ExprMapKeyType Key = std::make_pair(Instruction::Cast, argVec);
1123   return ExprConstants.getOrCreate(Ty, Key);
1124 }
1125
1126 Constant *ConstantExpr::getTy(const Type *ReqTy, unsigned Opcode,
1127                               Constant *C1, Constant *C2) {
1128   if (Opcode == Instruction::Shl || Opcode == Instruction::Shr)
1129     return getShiftTy(ReqTy, Opcode, C1, C2);
1130   // Check the operands for consistency first
1131   assert((Opcode >= Instruction::BinaryOpsBegin &&
1132           Opcode < Instruction::BinaryOpsEnd) &&
1133          "Invalid opcode in binary constant expression");
1134   assert(C1->getType() == C2->getType() &&
1135          "Operand types in binary constant expression should match");
1136
1137   if (ReqTy == C1->getType())
1138     if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1139       return FC;          // Fold a few common cases...
1140
1141   std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1142   ExprMapKeyType Key = std::make_pair(Opcode, argVec);
1143   return ExprConstants.getOrCreate(ReqTy, Key);
1144 }
1145
1146 Constant *ConstantExpr::getSelectTy(const Type *ReqTy, Constant *C,
1147                                     Constant *V1, Constant *V2) {
1148   assert(C->getType() == Type::BoolTy && "Select condition must be bool!");
1149   assert(V1->getType() == V2->getType() && "Select value types must match!");
1150   assert(V1->getType()->isFirstClassType() && "Cannot select aggregate type!");
1151
1152   if (ReqTy == V1->getType())
1153     if (Constant *SC = ConstantFoldSelectInstruction(C, V1, V2))
1154       return SC;        // Fold common cases
1155
1156   std::vector<Constant*> argVec(3, C);
1157   argVec[1] = V1;
1158   argVec[2] = V2;
1159   ExprMapKeyType Key = std::make_pair(Instruction::Select, argVec);
1160   return ExprConstants.getOrCreate(ReqTy, Key);
1161 }
1162
1163 /// getShiftTy - Return a shift left or shift right constant expr
1164 Constant *ConstantExpr::getShiftTy(const Type *ReqTy, unsigned Opcode,
1165                                    Constant *C1, Constant *C2) {
1166   // Check the operands for consistency first
1167   assert((Opcode == Instruction::Shl ||
1168           Opcode == Instruction::Shr) &&
1169          "Invalid opcode in binary constant expression");
1170   assert(C1->getType()->isIntegral() && C2->getType() == Type::UByteTy &&
1171          "Invalid operand types for Shift constant expr!");
1172
1173   if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1174     return FC;          // Fold a few common cases...
1175
1176   // Look up the constant in the table first to ensure uniqueness
1177   std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1178   ExprMapKeyType Key = std::make_pair(Opcode, argVec);
1179   return ExprConstants.getOrCreate(ReqTy, Key);
1180 }
1181
1182
1183 Constant *ConstantExpr::getGetElementPtrTy(const Type *ReqTy, Constant *C,
1184                                         const std::vector<Constant*> &IdxList) {
1185   assert(GetElementPtrInst::getIndexedType(C->getType(),
1186                    std::vector<Value*>(IdxList.begin(), IdxList.end()), true) &&
1187          "GEP indices invalid!");
1188
1189   if (Constant *FC = ConstantFoldGetElementPtr(C, IdxList))
1190     return FC;          // Fold a few common cases...
1191
1192   assert(isa<PointerType>(C->getType()) &&
1193          "Non-pointer type for constant GetElementPtr expression");
1194   // Look up the constant in the table first to ensure uniqueness
1195   std::vector<Constant*> argVec(1, C);
1196   argVec.insert(argVec.end(), IdxList.begin(), IdxList.end());
1197   const ExprMapKeyType &Key = std::make_pair(Instruction::GetElementPtr,argVec);
1198   return ExprConstants.getOrCreate(ReqTy, Key);
1199 }
1200
1201 Constant *ConstantExpr::getGetElementPtr(Constant *C,
1202                                          const std::vector<Constant*> &IdxList){
1203   // Get the result type of the getelementptr!
1204   std::vector<Value*> VIdxList(IdxList.begin(), IdxList.end());
1205
1206   const Type *Ty = GetElementPtrInst::getIndexedType(C->getType(), VIdxList,
1207                                                      true);
1208   assert(Ty && "GEP indices invalid!");
1209   return getGetElementPtrTy(PointerType::get(Ty), C, IdxList);
1210 }
1211
1212
1213 // destroyConstant - Remove the constant from the constant table...
1214 //
1215 void ConstantExpr::destroyConstant() {
1216   ExprConstants.remove(this);
1217   destroyConstantImpl();
1218 }
1219
1220 const char *ConstantExpr::getOpcodeName() const {
1221   return Instruction::getOpcodeName(getOpcode());
1222 }