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