1 //===-- Constants.cpp - Implement Constant nodes --------------------------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Constant* classes...
12 //===----------------------------------------------------------------------===//
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"
24 ConstantBool *ConstantBool::True = new ConstantBool(true);
25 ConstantBool *ConstantBool::False = new ConstantBool(false);
28 //===----------------------------------------------------------------------===//
30 //===----------------------------------------------------------------------===//
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!");
36 if (Name.size()) ST->insert(Name, this);
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.
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: "
55 assert(isa<Constant>(V) && "References remain to Constant being destroyed");
56 Constant *CPV = cast<Constant>(V);
57 CPV->destroyConstant();
59 // The constant should remove itself from our use list...
60 assert((use_empty() || use_back() != V) && "Constant not removed!");
63 // Value has no outstanding references it is safe to delete it now...
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);
74 case Type::SByteTyID: {
75 static Constant *NullSByte = ConstantSInt::get(Type::SByteTy, 0);
78 case Type::UByteTyID: {
79 static Constant *NullUByte = ConstantUInt::get(Type::UByteTy, 0);
82 case Type::ShortTyID: {
83 static Constant *NullShort = ConstantSInt::get(Type::ShortTy, 0);
86 case Type::UShortTyID: {
87 static Constant *NullUShort = ConstantUInt::get(Type::UShortTy, 0);
91 static Constant *NullInt = ConstantSInt::get(Type::IntTy, 0);
94 case Type::UIntTyID: {
95 static Constant *NullUInt = ConstantUInt::get(Type::UIntTy, 0);
98 case Type::LongTyID: {
99 static Constant *NullLong = ConstantSInt::get(Type::LongTy, 0);
102 case Type::ULongTyID: {
103 static Constant *NullULong = ConstantUInt::get(Type::ULongTy, 0);
107 case Type::FloatTyID: {
108 static Constant *NullFloat = ConstantFP::get(Type::FloatTy, 0);
111 case Type::DoubleTyID: {
112 static Constant *NullDouble = ConstantFP::get(Type::DoubleTy, 0);
116 case Type::PointerTyID:
117 return ConstantPointerNull::get(cast<PointerType>(Ty));
119 case Type::StructTyID:
120 case Type::ArrayTyID:
121 return ConstantAggregateZero::get(Ty);
123 // Function, Type, Label, or Opaque type?
124 assert(0 && "Cannot create a null constant of that type!");
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:
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);
144 case Type::UByteTyID:
145 case Type::UShortTyID:
147 case Type::ULongTyID: return getAllOnesValue(Ty);
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:
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);
168 case Type::UByteTyID:
169 case Type::UShortTyID:
171 case Type::ULongTyID: return ConstantUInt::get(Ty, 0);
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:
184 case Type::LongTyID: return ConstantSInt::get(Ty, -1);
186 case Type::UByteTyID:
187 case Type::UShortTyID:
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);
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;
208 //===----------------------------------------------------------------------===//
209 // ConstantXXX Classes
210 //===----------------------------------------------------------------------===//
212 //===----------------------------------------------------------------------===//
213 // Normal Constructors
215 ConstantBool::ConstantBool(bool V) : ConstantIntegral(Type::BoolTy) {
219 ConstantInt::ConstantInt(const Type *Ty, uint64_t V) : ConstantIntegral(Ty) {
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!");
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!");
235 ConstantFP::ConstantFP(const Type *Ty, double V) : Constant(Ty) {
236 assert(isValueValidForType(Ty, V) && "Value too large for type!");
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() ||
246 V[i]->getType()->getPrimitiveID() ==
247 T->getElementType()->getPrimitiveID()));
248 Operands.push_back(Use(V[i], this));
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));
268 ConstantPointerRef::ConstantPointerRef(GlobalValue *GV)
269 : Constant(GV->getType()) {
271 Operands.push_back(Use(GV, this));
274 ConstantExpr::ConstantExpr(unsigned Opcode, Constant *C, const Type *Ty)
275 : Constant(Ty), iType(Opcode) {
277 Operands.push_back(Use(C, this));
280 // Select instruction creation ctor
281 ConstantExpr::ConstantExpr(Constant *C, Constant *V1, Constant *V2)
282 : Constant(V1->getType()), iType(Instruction::Select) {
284 Operands.push_back(Use(C, this));
285 Operands.push_back(Use(V1, this));
286 Operands.push_back(Use(V2, this));
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;
296 ConstantExpr::ConstantExpr(unsigned Opcode, Constant *C1, Constant *C2)
297 : Constant(isSetCC(Opcode) ? Type::BoolTy : C1->getType()), iType(Opcode) {
299 Operands.push_back(Use(C1, this));
300 Operands.push_back(Use(C2, this));
303 ConstantExpr::ConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
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));
312 /// ConstantExpr::get* - Return some common constants without having to
313 /// specify the full Instruction::OPCODE identifier.
315 Constant *ConstantExpr::getNeg(Constant *C) {
316 if (!C->getType()->isFloatingPoint())
317 return get(Instruction::Sub, getNullValue(C->getType()), C);
319 return get(Instruction::Sub, ConstantFP::get(C->getType(), -0.0), C);
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()));
326 Constant *ConstantExpr::getAdd(Constant *C1, Constant *C2) {
327 return get(Instruction::Add, C1, C2);
329 Constant *ConstantExpr::getSub(Constant *C1, Constant *C2) {
330 return get(Instruction::Sub, C1, C2);
332 Constant *ConstantExpr::getMul(Constant *C1, Constant *C2) {
333 return get(Instruction::Mul, C1, C2);
335 Constant *ConstantExpr::getDiv(Constant *C1, Constant *C2) {
336 return get(Instruction::Div, C1, C2);
338 Constant *ConstantExpr::getRem(Constant *C1, Constant *C2) {
339 return get(Instruction::Rem, C1, C2);
341 Constant *ConstantExpr::getAnd(Constant *C1, Constant *C2) {
342 return get(Instruction::And, C1, C2);
344 Constant *ConstantExpr::getOr(Constant *C1, Constant *C2) {
345 return get(Instruction::Or, C1, C2);
347 Constant *ConstantExpr::getXor(Constant *C1, Constant *C2) {
348 return get(Instruction::Xor, C1, C2);
350 Constant *ConstantExpr::getSetEQ(Constant *C1, Constant *C2) {
351 return get(Instruction::SetEQ, C1, C2);
353 Constant *ConstantExpr::getSetNE(Constant *C1, Constant *C2) {
354 return get(Instruction::SetNE, C1, C2);
356 Constant *ConstantExpr::getSetLT(Constant *C1, Constant *C2) {
357 return get(Instruction::SetLT, C1, C2);
359 Constant *ConstantExpr::getSetGT(Constant *C1, Constant *C2) {
360 return get(Instruction::SetGT, C1, C2);
362 Constant *ConstantExpr::getSetLE(Constant *C1, Constant *C2) {
363 return get(Instruction::SetLE, C1, C2);
365 Constant *ConstantExpr::getSetGE(Constant *C1, Constant *C2) {
366 return get(Instruction::SetGE, C1, C2);
368 Constant *ConstantExpr::getShl(Constant *C1, Constant *C2) {
369 return get(Instruction::Shl, C1, C2);
371 Constant *ConstantExpr::getShr(Constant *C1, Constant *C2) {
372 return get(Instruction::Shr, C1, C2);
378 //===----------------------------------------------------------------------===//
379 // classof implementations
381 bool ConstantIntegral::classof(const Constant *CPV) {
382 return CPV->getType()->isIntegral() && !isa<ConstantExpr>(CPV);
385 bool ConstantInt::classof(const Constant *CPV) {
386 return CPV->getType()->isInteger() && !isa<ConstantExpr>(CPV);
388 bool ConstantSInt::classof(const Constant *CPV) {
389 return CPV->getType()->isSigned() && !isa<ConstantExpr>(CPV);
391 bool ConstantUInt::classof(const Constant *CPV) {
392 return CPV->getType()->isUnsigned() && !isa<ConstantExpr>(CPV);
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));
399 bool ConstantAggregateZero::classof(const Constant *CPV) {
400 return (isa<ArrayType>(CPV->getType()) || isa<StructType>(CPV->getType())) &&
403 bool ConstantArray::classof(const Constant *CPV) {
404 return isa<ArrayType>(CPV->getType()) && !CPV->isNullValue();
406 bool ConstantStruct::classof(const Constant *CPV) {
407 return isa<StructType>(CPV->getType()) && !CPV->isNullValue();
410 bool ConstantPointerNull::classof(const Constant *CPV) {
411 return isa<PointerType>(CPV->getType()) && !isa<ConstantExpr>(CPV) &&
412 CPV->getNumOperands() == 0;
415 bool ConstantPointerRef::classof(const Constant *CPV) {
416 return isa<PointerType>(CPV->getType()) && !isa<ConstantExpr>(CPV) &&
417 CPV->getNumOperands() == 1;
422 //===----------------------------------------------------------------------===//
423 // isValueValidForType implementations
425 bool ConstantSInt::isValueValidForType(const Type *Ty, int64_t Val) {
426 switch (Ty->getPrimitiveID()) {
428 return false; // These can't be represented as integers!!!
431 case Type::SByteTyID:
432 return (Val <= INT8_MAX && Val >= INT8_MIN);
433 case Type::ShortTyID:
434 return (Val <= INT16_MAX && Val >= INT16_MIN);
436 return (Val <= INT32_MAX && Val >= INT32_MIN);
438 return true; // This is the largest type...
444 bool ConstantUInt::isValueValidForType(const Type *Ty, uint64_t Val) {
445 switch (Ty->getPrimitiveID()) {
447 return false; // These can't be represented as integers!!!
450 case Type::UByteTyID:
451 return (Val <= UINT8_MAX);
452 case Type::UShortTyID:
453 return (Val <= UINT16_MAX);
455 return (Val <= UINT32_MAX);
456 case Type::ULongTyID:
457 return true; // This is the largest type...
463 bool ConstantFP::isValueValidForType(const Type *Ty, double Val) {
464 switch (Ty->getPrimitiveID()) {
466 return false; // These can't be represented as floating point!
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...
475 //===----------------------------------------------------------------------===//
476 // replaceUsesOfWithOnConstant implementations
478 void ConstantArray::replaceUsesOfWithOnConstant(Value *From, Value *To,
479 bool DisableChecking) {
480 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
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);
490 Constant *Replacement = ConstantArray::get(getType(), Values);
491 assert(Replacement != this && "I didn't contain From!");
493 // Everyone using this now uses the replacement...
495 uncheckedReplaceAllUsesWith(Replacement);
497 replaceAllUsesWith(Replacement);
499 // Delete the old constant!
503 void ConstantStruct::replaceUsesOfWithOnConstant(Value *From, Value *To,
504 bool DisableChecking) {
505 assert(isa<Constant>(To) && "Cannot make Constant refer to non-constant!");
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);
515 Constant *Replacement = ConstantStruct::get(getType(), Values);
516 assert(Replacement != this && "I didn't contain From!");
518 // Everyone using this now uses the replacement...
520 uncheckedReplaceAllUsesWith(Replacement);
522 replaceAllUsesWith(Replacement);
524 // Delete the old constant!
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));
535 // Everyone using this now uses the replacement...
537 uncheckedReplaceAllUsesWith(Replacement);
539 replaceAllUsesWith(Replacement);
542 // Just replace ourselves with the To value specified.
544 uncheckedReplaceAllUsesWith(To);
546 replaceAllUsesWith(To);
549 // Delete the old constant!
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);
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;
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);
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);
581 assert(0 && "Unknown ConstantExpr type!");
585 assert(Replacement != this && "I didn't contain From!");
587 // Everyone using this now uses the replacement...
589 uncheckedReplaceAllUsesWith(Replacement);
591 replaceAllUsesWith(Replacement);
593 // Delete the old constant!
597 //===----------------------------------------------------------------------===//
598 // Factory Function Implementation
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
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);
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");
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;
630 typedef std::map<const TypeClass*, MapIterator> AbstractTypeMapTy;
631 AbstractTypeMapTy AbstractTypeMap;
633 // getOrCreate - Return the specified constant from the map, creating it if
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?
641 // If no preexisting value, create one now...
642 ConstantClass *Result =
643 ConstantCreator<ConstantClass,TypeClass,ValType>::create(Ty, V);
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));
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);
656 if (TI == AbstractTypeMap.end() || TI->first != Ty) {
657 // Add ourselves to the ATU list of the type.
658 cast<DerivedType>(Ty)->addAbstractTypeUser(this);
660 AbstractTypeMap.insert(TI, std::make_pair(Ty, I));
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)
673 assert(I != Map.end() && "Constant not found in constant table!");
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;
687 // First check the entry before this one...
688 if (TmpIt != Map.begin()) {
690 if (TmpIt->first.first != Ty) // Not the same type, move back...
694 // If we didn't find the same type, try to move forward...
695 if (TmpIt == ATMEntryIt) {
697 if (TmpIt == Map.end() || TmpIt->first.first != Ty)
698 --TmpIt; // No entry afterwards with the same type
701 // If there is another entry in the map of the same abstract type,
702 // update the AbstractTypeMap entry now.
703 if (TmpIt != ATMEntryIt) {
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);
717 void refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
718 typename AbstractTypeMapTy::iterator I =
719 AbstractTypeMap.find(cast<TypeClass>(OldTy));
721 assert(I != AbstractTypeMap.end() &&
722 "Abstract type not in AbstractTypeMap?");
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.
728 ConvertConstantType<ConstantClass,
729 TypeClass>::convert(I->second->second,
730 cast<TypeClass>(NewTy));
732 I = AbstractTypeMap.find(cast<TypeClass>(OldTy));
733 } while (I != AbstractTypeMap.end());
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);
743 std::cerr << "Constant.cpp: ValueMap\n";
750 //---- ConstantUInt::get() and ConstantSInt::get() implementations...
752 static ValueMap< int64_t, Type, ConstantSInt> SIntConstants;
753 static ValueMap<uint64_t, Type, ConstantUInt> UIntConstants;
755 ConstantSInt *ConstantSInt::get(const Type *Ty, int64_t V) {
756 return SIntConstants.getOrCreate(Ty, V);
759 ConstantUInt *ConstantUInt::get(const Type *Ty, uint64_t V) {
760 return UIntConstants.getOrCreate(Ty, V);
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);
769 //---- ConstantFP::get() implementation...
773 struct ConstantCreator<ConstantFP, Type, uint64_t> {
774 static ConstantFP *create(const Type *Ty, uint64_t V) {
775 assert(Ty == Type::DoubleTy);
781 return new ConstantFP(Ty, T.F);
785 struct ConstantCreator<ConstantFP, Type, uint32_t> {
786 static ConstantFP *create(const Type *Ty, uint32_t V) {
787 assert(Ty == Type::FloatTy);
793 return new ConstantFP(Ty, T.F);
798 static ValueMap<uint64_t, Type, ConstantFP> DoubleConstants;
799 static ValueMap<uint32_t, Type, ConstantFP> FloatConstants;
801 ConstantFP *ConstantFP::get(const Type *Ty, double V) {
802 if (Ty == Type::FloatTy) {
803 // Force the value through memory to normalize it.
809 return FloatConstants.getOrCreate(Ty, T.I);
811 assert(Ty == Type::DoubleTy);
817 return DoubleConstants.getOrCreate(Ty, T.I);
821 //---- ConstantAggregateZero::get() implementation...
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);
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.
844 static ValueMap<char, Type, ConstantAggregateZero> AggZeroConstants;
846 Constant *ConstantAggregateZero::get(const Type *Ty) {
847 return AggZeroConstants.getOrCreate(Ty, 0);
850 // destroyConstant - Remove the constant from the constant table...
852 void ConstantAggregateZero::destroyConstant() {
853 AggZeroConstants.remove(this);
854 destroyConstantImpl();
857 void ConstantAggregateZero::replaceUsesOfWithOnConstant(Value *From, Value *To,
858 bool DisableChecking) {
859 assert(0 && "No uses!");
865 //---- ConstantArray::get() implementation...
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.
883 static ValueMap<std::vector<Constant*>, ArrayType,
884 ConstantArray> ArrayConstants;
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
891 if (!C->isNullValue())
892 return ArrayConstants.getOrCreate(Ty, V);
893 for (unsigned i = 1, e = V.size(); i != e; ++i)
895 return ArrayConstants.getOrCreate(Ty, V);
897 return ConstantAggregateZero::get(Ty);
900 // destroyConstant - Remove the constant from the constant table...
902 void ConstantArray::destroyConstant() {
903 ArrayConstants.remove(this);
904 destroyConstantImpl();
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...
911 Constant *ConstantArray::get(const std::string &Str) {
912 std::vector<Constant*> ElementVals;
914 for (unsigned i = 0; i < Str.length(); ++i)
915 ElementVals.push_back(ConstantSInt::get(Type::SByteTy, Str[i]));
917 // Add a null terminator to the string...
918 ElementVals.push_back(ConstantSInt::get(Type::SByteTy, 0));
920 ArrayType *ATy = ArrayType::get(Type::SByteTy, Str.length()+1);
921 return ConstantArray::get(ATy, ElementVals);
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)
931 // Check the elements to make sure they are all integers, not constant
933 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
934 if (!isa<ConstantInt>(getOperand(i)))
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.
943 std::string ConstantArray::getAsString() const {
944 assert(isString() && "Not a string!");
946 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
947 Result += (char)cast<ConstantInt>(getOperand(i))->getRawValue();
952 //---- ConstantStruct::get() implementation...
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??");
966 OldC->uncheckedReplaceAllUsesWith(New);
967 OldC->destroyConstant(); // This constant is now dead, destroy it.
972 static ValueMap<std::vector<Constant*>, StructType,
973 ConstantStruct> StructConstants;
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);
982 return ConstantAggregateZero::get(Ty);
985 // destroyConstant - Remove the constant from the constant table...
987 void ConstantStruct::destroyConstant() {
988 StructConstants.remove(this);
989 destroyConstantImpl();
992 //---- ConstantPointerNull::get() implementation...
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);
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.
1016 static ValueMap<char, PointerType, ConstantPointerNull> NullPtrConstants;
1018 ConstantPointerNull *ConstantPointerNull::get(const PointerType *Ty) {
1019 return NullPtrConstants.getOrCreate(Ty, 0);
1022 // destroyConstant - Remove the constant from the constant table...
1024 void ConstantPointerNull::destroyConstant() {
1025 NullPtrConstants.remove(this);
1026 destroyConstantImpl();
1030 //---- ConstantPointerRef::get() implementation...
1032 ConstantPointerRef *ConstantPointerRef::get(GlobalValue *GV) {
1033 assert(GV->getParent() && "Global Value must be attached to a module!");
1035 // The Module handles the pointer reference sharing...
1036 return GV->getParent()->getConstantPointerRef(GV);
1039 // destroyConstant - Remove the constant from the constant table...
1041 void ConstantPointerRef::destroyConstant() {
1042 getValue()->getParent()->destroyConstantPointerRef(this);
1043 destroyConstantImpl();
1047 //---- ConstantExpr::get() implementations...
1049 typedef std::pair<unsigned, std::vector<Constant*> > ExprMapKeyType;
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]);
1062 assert(V.first == Instruction::GetElementPtr && "Invalid ConstantExpr!");
1064 std::vector<Constant*> IdxList(V.second.begin()+1, V.second.end());
1065 return new ConstantExpr(V.second[0], IdxList, Ty);
1070 struct ConvertConstantType<ConstantExpr, Type> {
1071 static void convert(ConstantExpr *OldC, const Type *NewTy) {
1073 switch (OldC->getOpcode()) {
1074 case Instruction::Cast:
1075 New = ConstantExpr::getCast(OldC->getOperand(0), NewTy);
1077 case Instruction::Select:
1078 New = ConstantExpr::getSelectTy(NewTy, OldC->getOperand(0),
1079 OldC->getOperand(1),
1080 OldC->getOperand(2));
1082 case Instruction::Shl:
1083 case Instruction::Shr:
1084 New = ConstantExpr::getShiftTy(NewTy, OldC->getOpcode(),
1085 OldC->getOperand(0), OldC->getOperand(1));
1088 assert(OldC->getOpcode() >= Instruction::BinaryOpsBegin &&
1089 OldC->getOpcode() < Instruction::BinaryOpsEnd);
1090 New = ConstantExpr::getTy(NewTy, OldC->getOpcode(), OldC->getOperand(0),
1091 OldC->getOperand(1));
1093 case Instruction::GetElementPtr:
1094 // Make everyone now use a constant of the new type...
1095 std::vector<Constant*> C;
1096 for (unsigned i = 1, e = OldC->getNumOperands(); i != e; ++i)
1097 C.push_back(cast<Constant>(OldC->getOperand(i)));
1098 New = ConstantExpr::getGetElementPtrTy(NewTy, OldC->getOperand(0), C);
1102 assert(New != OldC && "Didn't replace constant??");
1103 OldC->uncheckedReplaceAllUsesWith(New);
1104 OldC->destroyConstant(); // This constant is now dead, destroy it.
1107 } // end namespace llvm
1110 static ValueMap<ExprMapKeyType, Type, ConstantExpr> ExprConstants;
1112 Constant *ConstantExpr::getCast(Constant *C, const Type *Ty) {
1113 assert(Ty->isFirstClassType() && "Cannot cast to an aggregate type!");
1115 if (Constant *FC = ConstantFoldCastInstruction(C, Ty))
1116 return FC; // Fold a few common cases...
1118 // Look up the constant in the table first to ensure uniqueness
1119 std::vector<Constant*> argVec(1, C);
1120 ExprMapKeyType Key = std::make_pair(Instruction::Cast, argVec);
1121 return ExprConstants.getOrCreate(Ty, Key);
1124 Constant *ConstantExpr::getTy(const Type *ReqTy, unsigned Opcode,
1125 Constant *C1, Constant *C2) {
1126 if (Opcode == Instruction::Shl || Opcode == Instruction::Shr)
1127 return getShiftTy(ReqTy, Opcode, C1, C2);
1128 // Check the operands for consistency first
1129 assert((Opcode >= Instruction::BinaryOpsBegin &&
1130 Opcode < Instruction::BinaryOpsEnd) &&
1131 "Invalid opcode in binary constant expression");
1132 assert(C1->getType() == C2->getType() &&
1133 "Operand types in binary constant expression should match");
1135 if (ReqTy == C1->getType())
1136 if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1137 return FC; // Fold a few common cases...
1139 std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1140 ExprMapKeyType Key = std::make_pair(Opcode, argVec);
1141 return ExprConstants.getOrCreate(ReqTy, Key);
1144 Constant *ConstantExpr::getSelectTy(const Type *ReqTy, Constant *C,
1145 Constant *V1, Constant *V2) {
1146 assert(C->getType() == Type::BoolTy && "Select condition must be bool!");
1147 assert(V1->getType() == V2->getType() && "Select value types must match!");
1148 assert(V1->getType()->isFirstClassType() && "Cannot select aggregate type!");
1150 if (ReqTy == V1->getType())
1151 if (Constant *SC = ConstantFoldSelectInstruction(C, V1, V2))
1152 return SC; // Fold common cases
1154 std::vector<Constant*> argVec(3, C);
1157 ExprMapKeyType Key = std::make_pair(Instruction::Select, argVec);
1158 return ExprConstants.getOrCreate(ReqTy, Key);
1161 /// getShiftTy - Return a shift left or shift right constant expr
1162 Constant *ConstantExpr::getShiftTy(const Type *ReqTy, unsigned Opcode,
1163 Constant *C1, Constant *C2) {
1164 // Check the operands for consistency first
1165 assert((Opcode == Instruction::Shl ||
1166 Opcode == Instruction::Shr) &&
1167 "Invalid opcode in binary constant expression");
1168 assert(C1->getType()->isIntegral() && C2->getType() == Type::UByteTy &&
1169 "Invalid operand types for Shift constant expr!");
1171 if (Constant *FC = ConstantFoldBinaryInstruction(Opcode, C1, C2))
1172 return FC; // Fold a few common cases...
1174 // Look up the constant in the table first to ensure uniqueness
1175 std::vector<Constant*> argVec(1, C1); argVec.push_back(C2);
1176 ExprMapKeyType Key = std::make_pair(Opcode, argVec);
1177 return ExprConstants.getOrCreate(ReqTy, Key);
1181 Constant *ConstantExpr::getGetElementPtrTy(const Type *ReqTy, Constant *C,
1182 const std::vector<Constant*> &IdxList) {
1183 assert(GetElementPtrInst::getIndexedType(C->getType(),
1184 std::vector<Value*>(IdxList.begin(), IdxList.end()), true) &&
1185 "GEP indices invalid!");
1187 if (Constant *FC = ConstantFoldGetElementPtr(C, IdxList))
1188 return FC; // Fold a few common cases...
1190 assert(isa<PointerType>(C->getType()) &&
1191 "Non-pointer type for constant GetElementPtr expression");
1192 // Look up the constant in the table first to ensure uniqueness
1193 std::vector<Constant*> argVec(1, C);
1194 argVec.insert(argVec.end(), IdxList.begin(), IdxList.end());
1195 const ExprMapKeyType &Key = std::make_pair(Instruction::GetElementPtr,argVec);
1196 return ExprConstants.getOrCreate(ReqTy, Key);
1199 Constant *ConstantExpr::getGetElementPtr(Constant *C,
1200 const std::vector<Constant*> &IdxList){
1201 // Get the result type of the getelementptr!
1202 std::vector<Value*> VIdxList(IdxList.begin(), IdxList.end());
1204 const Type *Ty = GetElementPtrInst::getIndexedType(C->getType(), VIdxList,
1206 assert(Ty && "GEP indices invalid!");
1207 return getGetElementPtrTy(PointerType::get(Ty), C, IdxList);
1211 // destroyConstant - Remove the constant from the constant table...
1213 void ConstantExpr::destroyConstant() {
1214 ExprConstants.remove(this);
1215 destroyConstantImpl();
1218 const char *ConstantExpr::getOpcodeName() const {
1219 return Instruction::getOpcodeName(getOpcode());