1 //===-- Type.cpp - Implement the Type class -------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the Type class for the VMCore library.
12 //===----------------------------------------------------------------------===//
14 #include "LLVMContextImpl.h"
15 #include "llvm/DerivedTypes.h"
16 #include "llvm/Constants.h"
17 #include "llvm/Assembly/Writer.h"
18 #include "llvm/LLVMContext.h"
19 #include "llvm/Metadata.h"
20 #include "llvm/ADT/DepthFirstIterator.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/ADT/SCCIterator.h"
23 #include "llvm/ADT/STLExtras.h"
24 #include "llvm/Support/Compiler.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Support/ManagedStatic.h"
28 #include "llvm/Support/MathExtras.h"
29 #include "llvm/Support/raw_ostream.h"
30 #include "llvm/System/Threading.h"
35 // DEBUG_MERGE_TYPES - Enable this #define to see how and when derived types are
36 // created and later destroyed, all in an effort to make sure that there is only
37 // a single canonical version of a type.
39 // #define DEBUG_MERGE_TYPES 1
41 AbstractTypeUser::~AbstractTypeUser() {}
43 void AbstractTypeUser::setType(Value *V, const Type *NewTy) {
47 //===----------------------------------------------------------------------===//
48 // Type Class Implementation
49 //===----------------------------------------------------------------------===//
51 /// Because of the way Type subclasses are allocated, this function is necessary
52 /// to use the correct kind of "delete" operator to deallocate the Type object.
53 /// Some type objects (FunctionTy, StructTy) allocate additional space after
54 /// the space for their derived type to hold the contained types array of
55 /// PATypeHandles. Using this allocation scheme means all the PATypeHandles are
56 /// allocated with the type object, decreasing allocations and eliminating the
57 /// need for a std::vector to be used in the Type class itself.
58 /// @brief Type destruction function
59 void Type::destroy() const {
61 // Structures and Functions allocate their contained types past the end of
62 // the type object itself. These need to be destroyed differently than the
64 if (isa<FunctionType>(this) || isa<StructType>(this)) {
65 // First, make sure we destruct any PATypeHandles allocated by these
66 // subclasses. They must be manually destructed.
67 for (unsigned i = 0; i < NumContainedTys; ++i)
68 ContainedTys[i].PATypeHandle::~PATypeHandle();
70 // Now call the destructor for the subclass directly because we're going
71 // to delete this as an array of char.
72 if (isa<FunctionType>(this))
73 static_cast<const FunctionType*>(this)->FunctionType::~FunctionType();
75 static_cast<const StructType*>(this)->StructType::~StructType();
77 // Finally, remove the memory as an array deallocation of the chars it was
79 operator delete(const_cast<Type *>(this));
82 } else if (const OpaqueType *opaque_this = dyn_cast<OpaqueType>(this)) {
83 LLVMContextImpl *pImpl = this->getContext().pImpl;
84 pImpl->OpaqueTypes.erase(opaque_this);
87 // For all the other type subclasses, there is either no contained types or
88 // just one (all Sequentials). For Sequentials, the PATypeHandle is not
89 // allocated past the type object, its included directly in the SequentialType
90 // class. This means we can safely just do "normal" delete of this object and
91 // all the destructors that need to run will be run.
95 const Type *Type::getPrimitiveType(LLVMContext &C, TypeID IDNumber) {
97 case VoidTyID : return getVoidTy(C);
98 case FloatTyID : return getFloatTy(C);
99 case DoubleTyID : return getDoubleTy(C);
100 case X86_FP80TyID : return getX86_FP80Ty(C);
101 case FP128TyID : return getFP128Ty(C);
102 case PPC_FP128TyID : return getPPC_FP128Ty(C);
103 case LabelTyID : return getLabelTy(C);
104 case MetadataTyID : return getMetadataTy(C);
110 const Type *Type::getVAArgsPromotedType(LLVMContext &C) const {
111 if (ID == IntegerTyID && getSubclassData() < 32)
112 return Type::getInt32Ty(C);
113 else if (ID == FloatTyID)
114 return Type::getDoubleTy(C);
119 /// getScalarType - If this is a vector type, return the element type,
120 /// otherwise return this.
121 const Type *Type::getScalarType() const {
122 if (const VectorType *VTy = dyn_cast<VectorType>(this))
123 return VTy->getElementType();
127 /// isInteger - Return true if this is an IntegerType of the specified width.
128 bool Type::isInteger(unsigned Bitwidth) const {
129 return isInteger() && cast<IntegerType>(this)->getBitWidth() == Bitwidth;
132 /// isIntOrIntVector - Return true if this is an integer type or a vector of
135 bool Type::isIntOrIntVector() const {
138 if (ID != Type::VectorTyID) return false;
140 return cast<VectorType>(this)->getElementType()->isInteger();
143 /// isFPOrFPVector - Return true if this is a FP type or a vector of FP types.
145 bool Type::isFPOrFPVector() const {
146 if (ID == Type::FloatTyID || ID == Type::DoubleTyID ||
147 ID == Type::FP128TyID || ID == Type::X86_FP80TyID ||
148 ID == Type::PPC_FP128TyID)
150 if (ID != Type::VectorTyID) return false;
152 return cast<VectorType>(this)->getElementType()->isFloatingPoint();
155 // canLosslesslyBitCastTo - Return true if this type can be converted to
156 // 'Ty' without any reinterpretation of bits. For example, i8* to i32*.
158 bool Type::canLosslesslyBitCastTo(const Type *Ty) const {
159 // Identity cast means no change so return true
163 // They are not convertible unless they are at least first class types
164 if (!this->isFirstClassType() || !Ty->isFirstClassType())
167 // Vector -> Vector conversions are always lossless if the two vector types
168 // have the same size, otherwise not.
169 if (const VectorType *thisPTy = dyn_cast<VectorType>(this))
170 if (const VectorType *thatPTy = dyn_cast<VectorType>(Ty))
171 return thisPTy->getBitWidth() == thatPTy->getBitWidth();
173 // At this point we have only various mismatches of the first class types
174 // remaining and ptr->ptr. Just select the lossless conversions. Everything
175 // else is not lossless.
176 if (isa<PointerType>(this))
177 return isa<PointerType>(Ty);
178 return false; // Other types have no identity values
181 unsigned Type::getPrimitiveSizeInBits() const {
182 switch (getTypeID()) {
183 case Type::FloatTyID: return 32;
184 case Type::DoubleTyID: return 64;
185 case Type::X86_FP80TyID: return 80;
186 case Type::FP128TyID: return 128;
187 case Type::PPC_FP128TyID: return 128;
188 case Type::IntegerTyID: return cast<IntegerType>(this)->getBitWidth();
189 case Type::VectorTyID: return cast<VectorType>(this)->getBitWidth();
194 /// getScalarSizeInBits - If this is a vector type, return the
195 /// getPrimitiveSizeInBits value for the element type. Otherwise return the
196 /// getPrimitiveSizeInBits value for this type.
197 unsigned Type::getScalarSizeInBits() const {
198 return getScalarType()->getPrimitiveSizeInBits();
201 /// getFPMantissaWidth - Return the width of the mantissa of this type. This
202 /// is only valid on floating point types. If the FP type does not
203 /// have a stable mantissa (e.g. ppc long double), this method returns -1.
204 int Type::getFPMantissaWidth() const {
205 if (const VectorType *VTy = dyn_cast<VectorType>(this))
206 return VTy->getElementType()->getFPMantissaWidth();
207 assert(isFloatingPoint() && "Not a floating point type!");
208 if (ID == FloatTyID) return 24;
209 if (ID == DoubleTyID) return 53;
210 if (ID == X86_FP80TyID) return 64;
211 if (ID == FP128TyID) return 113;
212 assert(ID == PPC_FP128TyID && "unknown fp type");
216 /// isSizedDerivedType - Derived types like structures and arrays are sized
217 /// iff all of the members of the type are sized as well. Since asking for
218 /// their size is relatively uncommon, move this operation out of line.
219 bool Type::isSizedDerivedType() const {
220 if (isa<IntegerType>(this))
223 if (const ArrayType *ATy = dyn_cast<ArrayType>(this))
224 return ATy->getElementType()->isSized();
226 if (const VectorType *PTy = dyn_cast<VectorType>(this))
227 return PTy->getElementType()->isSized();
229 if (!isa<StructType>(this))
232 // Okay, our struct is sized if all of the elements are...
233 for (subtype_iterator I = subtype_begin(), E = subtype_end(); I != E; ++I)
234 if (!(*I)->isSized())
240 /// getForwardedTypeInternal - This method is used to implement the union-find
241 /// algorithm for when a type is being forwarded to another type.
242 const Type *Type::getForwardedTypeInternal() const {
243 assert(ForwardType && "This type is not being forwarded to another type!");
245 // Check to see if the forwarded type has been forwarded on. If so, collapse
246 // the forwarding links.
247 const Type *RealForwardedType = ForwardType->getForwardedType();
248 if (!RealForwardedType)
249 return ForwardType; // No it's not forwarded again
251 // Yes, it is forwarded again. First thing, add the reference to the new
253 if (RealForwardedType->isAbstract())
254 cast<DerivedType>(RealForwardedType)->addRef();
256 // Now drop the old reference. This could cause ForwardType to get deleted.
257 cast<DerivedType>(ForwardType)->dropRef();
259 // Return the updated type.
260 ForwardType = RealForwardedType;
264 void Type::refineAbstractType(const DerivedType *OldTy, const Type *NewTy) {
265 llvm_unreachable("Attempting to refine a derived type!");
267 void Type::typeBecameConcrete(const DerivedType *AbsTy) {
268 llvm_unreachable("DerivedType is already a concrete type!");
272 std::string Type::getDescription() const {
273 LLVMContextImpl *pImpl = getContext().pImpl;
276 pImpl->AbstractTypeDescriptions :
277 pImpl->ConcreteTypeDescriptions;
280 raw_string_ostream DescOS(DescStr);
281 Map.print(this, DescOS);
286 bool StructType::indexValid(const Value *V) const {
287 // Structure indexes require 32-bit integer constants.
288 if (V->getType()->isInteger(32))
289 if (const ConstantInt *CU = dyn_cast<ConstantInt>(V))
290 return indexValid(CU->getZExtValue());
294 bool StructType::indexValid(unsigned V) const {
295 return V < NumContainedTys;
298 // getTypeAtIndex - Given an index value into the type, return the type of the
299 // element. For a structure type, this must be a constant value...
301 const Type *StructType::getTypeAtIndex(const Value *V) const {
302 unsigned Idx = (unsigned)cast<ConstantInt>(V)->getZExtValue();
303 return getTypeAtIndex(Idx);
306 const Type *StructType::getTypeAtIndex(unsigned Idx) const {
307 assert(indexValid(Idx) && "Invalid structure index!");
308 return ContainedTys[Idx];
311 //===----------------------------------------------------------------------===//
312 // Primitive 'Type' data
313 //===----------------------------------------------------------------------===//
315 const Type *Type::getVoidTy(LLVMContext &C) {
316 return &C.pImpl->VoidTy;
319 const Type *Type::getLabelTy(LLVMContext &C) {
320 return &C.pImpl->LabelTy;
323 const Type *Type::getFloatTy(LLVMContext &C) {
324 return &C.pImpl->FloatTy;
327 const Type *Type::getDoubleTy(LLVMContext &C) {
328 return &C.pImpl->DoubleTy;
331 const Type *Type::getMetadataTy(LLVMContext &C) {
332 return &C.pImpl->MetadataTy;
335 const Type *Type::getX86_FP80Ty(LLVMContext &C) {
336 return &C.pImpl->X86_FP80Ty;
339 const Type *Type::getFP128Ty(LLVMContext &C) {
340 return &C.pImpl->FP128Ty;
343 const Type *Type::getPPC_FP128Ty(LLVMContext &C) {
344 return &C.pImpl->PPC_FP128Ty;
347 const IntegerType *Type::getInt1Ty(LLVMContext &C) {
348 return &C.pImpl->Int1Ty;
351 const IntegerType *Type::getInt8Ty(LLVMContext &C) {
352 return &C.pImpl->Int8Ty;
355 const IntegerType *Type::getInt16Ty(LLVMContext &C) {
356 return &C.pImpl->Int16Ty;
359 const IntegerType *Type::getInt32Ty(LLVMContext &C) {
360 return &C.pImpl->Int32Ty;
363 const IntegerType *Type::getInt64Ty(LLVMContext &C) {
364 return &C.pImpl->Int64Ty;
367 const PointerType *Type::getFloatPtrTy(LLVMContext &C, unsigned AS) {
368 return getFloatTy(C)->getPointerTo(AS);
371 const PointerType *Type::getDoublePtrTy(LLVMContext &C, unsigned AS) {
372 return getDoubleTy(C)->getPointerTo(AS);
375 const PointerType *Type::getX86_FP80PtrTy(LLVMContext &C, unsigned AS) {
376 return getX86_FP80Ty(C)->getPointerTo(AS);
379 const PointerType *Type::getFP128PtrTy(LLVMContext &C, unsigned AS) {
380 return getFP128Ty(C)->getPointerTo(AS);
383 const PointerType *Type::getPPC_FP128PtrTy(LLVMContext &C, unsigned AS) {
384 return getPPC_FP128Ty(C)->getPointerTo(AS);
387 const PointerType *Type::getInt1PtrTy(LLVMContext &C, unsigned AS) {
388 return getInt1Ty(C)->getPointerTo(AS);
391 const PointerType *Type::getInt8PtrTy(LLVMContext &C, unsigned AS) {
392 return getInt8Ty(C)->getPointerTo(AS);
395 const PointerType *Type::getInt16PtrTy(LLVMContext &C, unsigned AS) {
396 return getInt16Ty(C)->getPointerTo(AS);
399 const PointerType *Type::getInt32PtrTy(LLVMContext &C, unsigned AS) {
400 return getInt32Ty(C)->getPointerTo(AS);
403 const PointerType *Type::getInt64PtrTy(LLVMContext &C, unsigned AS) {
404 return getInt64Ty(C)->getPointerTo(AS);
407 //===----------------------------------------------------------------------===//
408 // Derived Type Constructors
409 //===----------------------------------------------------------------------===//
411 /// isValidReturnType - Return true if the specified type is valid as a return
413 bool FunctionType::isValidReturnType(const Type *RetTy) {
414 return RetTy->getTypeID() != LabelTyID &&
415 RetTy->getTypeID() != MetadataTyID;
418 /// isValidArgumentType - Return true if the specified type is valid as an
420 bool FunctionType::isValidArgumentType(const Type *ArgTy) {
421 return ArgTy->isFirstClassType() || isa<OpaqueType>(ArgTy);
424 FunctionType::FunctionType(const Type *Result,
425 const std::vector<const Type*> &Params,
427 : DerivedType(Result->getContext(), FunctionTyID), isVarArgs(IsVarArgs) {
428 ContainedTys = reinterpret_cast<PATypeHandle*>(this+1);
429 NumContainedTys = Params.size() + 1; // + 1 for result type
430 assert(isValidReturnType(Result) && "invalid return type for function");
433 bool isAbstract = Result->isAbstract();
434 new (&ContainedTys[0]) PATypeHandle(Result, this);
436 for (unsigned i = 0; i != Params.size(); ++i) {
437 assert(isValidArgumentType(Params[i]) &&
438 "Not a valid type for function argument!");
439 new (&ContainedTys[i+1]) PATypeHandle(Params[i], this);
440 isAbstract |= Params[i]->isAbstract();
443 // Calculate whether or not this type is abstract
444 setAbstract(isAbstract);
447 StructType::StructType(LLVMContext &C,
448 const std::vector<const Type*> &Types, bool isPacked)
449 : CompositeType(C, StructTyID) {
450 ContainedTys = reinterpret_cast<PATypeHandle*>(this + 1);
451 NumContainedTys = Types.size();
452 setSubclassData(isPacked);
453 bool isAbstract = false;
454 for (unsigned i = 0; i < Types.size(); ++i) {
455 assert(Types[i] && "<null> type for structure field!");
456 assert(isValidElementType(Types[i]) &&
457 "Invalid type for structure element!");
458 new (&ContainedTys[i]) PATypeHandle(Types[i], this);
459 isAbstract |= Types[i]->isAbstract();
462 // Calculate whether or not this type is abstract
463 setAbstract(isAbstract);
466 ArrayType::ArrayType(const Type *ElType, uint64_t NumEl)
467 : SequentialType(ArrayTyID, ElType) {
470 // Calculate whether or not this type is abstract
471 setAbstract(ElType->isAbstract());
474 VectorType::VectorType(const Type *ElType, unsigned NumEl)
475 : SequentialType(VectorTyID, ElType) {
477 setAbstract(ElType->isAbstract());
478 assert(NumEl > 0 && "NumEl of a VectorType must be greater than 0");
479 assert(isValidElementType(ElType) &&
480 "Elements of a VectorType must be a primitive type");
485 PointerType::PointerType(const Type *E, unsigned AddrSpace)
486 : SequentialType(PointerTyID, E) {
487 AddressSpace = AddrSpace;
488 // Calculate whether or not this type is abstract
489 setAbstract(E->isAbstract());
492 OpaqueType::OpaqueType(LLVMContext &C) : DerivedType(C, OpaqueTyID) {
494 #ifdef DEBUG_MERGE_TYPES
495 DEBUG(dbgs() << "Derived new type: " << *this << "\n");
499 void PATypeHolder::destroy() {
503 // dropAllTypeUses - When this (abstract) type is resolved to be equal to
504 // another (more concrete) type, we must eliminate all references to other
505 // types, to avoid some circular reference problems.
506 void DerivedType::dropAllTypeUses() {
507 if (NumContainedTys != 0) {
508 // The type must stay abstract. To do this, we insert a pointer to a type
509 // that will never get resolved, thus will always be abstract.
510 ContainedTys[0] = getContext().pImpl->AlwaysOpaqueTy;
512 // Change the rest of the types to be Int32Ty's. It doesn't matter what we
513 // pick so long as it doesn't point back to this type. We choose something
514 // concrete to avoid overhead for adding to AbstractTypeUser lists and
516 const Type *ConcreteTy = Type::getInt32Ty(getContext());
517 for (unsigned i = 1, e = NumContainedTys; i != e; ++i)
518 ContainedTys[i] = ConcreteTy;
525 /// TypePromotionGraph and graph traits - this is designed to allow us to do
526 /// efficient SCC processing of type graphs. This is the exact same as
527 /// GraphTraits<Type*>, except that we pretend that concrete types have no
528 /// children to avoid processing them.
529 struct TypePromotionGraph {
531 TypePromotionGraph(Type *T) : Ty(T) {}
537 template <> struct GraphTraits<TypePromotionGraph> {
538 typedef Type NodeType;
539 typedef Type::subtype_iterator ChildIteratorType;
541 static inline NodeType *getEntryNode(TypePromotionGraph G) { return G.Ty; }
542 static inline ChildIteratorType child_begin(NodeType *N) {
544 return N->subtype_begin();
545 else // No need to process children of concrete types.
546 return N->subtype_end();
548 static inline ChildIteratorType child_end(NodeType *N) {
549 return N->subtype_end();
555 // PromoteAbstractToConcrete - This is a recursive function that walks a type
556 // graph calculating whether or not a type is abstract.
558 void Type::PromoteAbstractToConcrete() {
559 if (!isAbstract()) return;
561 scc_iterator<TypePromotionGraph> SI = scc_begin(TypePromotionGraph(this));
562 scc_iterator<TypePromotionGraph> SE = scc_end (TypePromotionGraph(this));
564 for (; SI != SE; ++SI) {
565 std::vector<Type*> &SCC = *SI;
567 // Concrete types are leaves in the tree. Since an SCC will either be all
568 // abstract or all concrete, we only need to check one type.
569 if (SCC[0]->isAbstract()) {
570 if (isa<OpaqueType>(SCC[0]))
571 return; // Not going to be concrete, sorry.
573 // If all of the children of all of the types in this SCC are concrete,
574 // then this SCC is now concrete as well. If not, neither this SCC, nor
575 // any parent SCCs will be concrete, so we might as well just exit.
576 for (unsigned i = 0, e = SCC.size(); i != e; ++i)
577 for (Type::subtype_iterator CI = SCC[i]->subtype_begin(),
578 E = SCC[i]->subtype_end(); CI != E; ++CI)
579 if ((*CI)->isAbstract())
580 // If the child type is in our SCC, it doesn't make the entire SCC
581 // abstract unless there is a non-SCC abstract type.
582 if (std::find(SCC.begin(), SCC.end(), *CI) == SCC.end())
583 return; // Not going to be concrete, sorry.
585 // Okay, we just discovered this whole SCC is now concrete, mark it as
587 for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
588 assert(SCC[i]->isAbstract() && "Why are we processing concrete types?");
590 SCC[i]->setAbstract(false);
593 for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
594 assert(!SCC[i]->isAbstract() && "Concrete type became abstract?");
595 // The type just became concrete, notify all users!
596 cast<DerivedType>(SCC[i])->notifyUsesThatTypeBecameConcrete();
603 //===----------------------------------------------------------------------===//
604 // Type Structural Equality Testing
605 //===----------------------------------------------------------------------===//
607 // TypesEqual - Two types are considered structurally equal if they have the
608 // same "shape": Every level and element of the types have identical primitive
609 // ID's, and the graphs have the same edges/nodes in them. Nodes do not have to
610 // be pointer equals to be equivalent though. This uses an optimistic algorithm
611 // that assumes that two graphs are the same until proven otherwise.
613 static bool TypesEqual(const Type *Ty, const Type *Ty2,
614 std::map<const Type *, const Type *> &EqTypes) {
615 if (Ty == Ty2) return true;
616 if (Ty->getTypeID() != Ty2->getTypeID()) return false;
617 if (isa<OpaqueType>(Ty))
618 return false; // Two unequal opaque types are never equal
620 std::map<const Type*, const Type*>::iterator It = EqTypes.find(Ty);
621 if (It != EqTypes.end())
622 return It->second == Ty2; // Looping back on a type, check for equality
624 // Otherwise, add the mapping to the table to make sure we don't get
625 // recursion on the types...
626 EqTypes.insert(It, std::make_pair(Ty, Ty2));
628 // Two really annoying special cases that breaks an otherwise nice simple
629 // algorithm is the fact that arraytypes have sizes that differentiates types,
630 // and that function types can be varargs or not. Consider this now.
632 if (const IntegerType *ITy = dyn_cast<IntegerType>(Ty)) {
633 const IntegerType *ITy2 = cast<IntegerType>(Ty2);
634 return ITy->getBitWidth() == ITy2->getBitWidth();
635 } else if (const PointerType *PTy = dyn_cast<PointerType>(Ty)) {
636 const PointerType *PTy2 = cast<PointerType>(Ty2);
637 return PTy->getAddressSpace() == PTy2->getAddressSpace() &&
638 TypesEqual(PTy->getElementType(), PTy2->getElementType(), EqTypes);
639 } else if (const StructType *STy = dyn_cast<StructType>(Ty)) {
640 const StructType *STy2 = cast<StructType>(Ty2);
641 if (STy->getNumElements() != STy2->getNumElements()) return false;
642 if (STy->isPacked() != STy2->isPacked()) return false;
643 for (unsigned i = 0, e = STy2->getNumElements(); i != e; ++i)
644 if (!TypesEqual(STy->getElementType(i), STy2->getElementType(i), EqTypes))
647 } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
648 const ArrayType *ATy2 = cast<ArrayType>(Ty2);
649 return ATy->getNumElements() == ATy2->getNumElements() &&
650 TypesEqual(ATy->getElementType(), ATy2->getElementType(), EqTypes);
651 } else if (const VectorType *PTy = dyn_cast<VectorType>(Ty)) {
652 const VectorType *PTy2 = cast<VectorType>(Ty2);
653 return PTy->getNumElements() == PTy2->getNumElements() &&
654 TypesEqual(PTy->getElementType(), PTy2->getElementType(), EqTypes);
655 } else if (const FunctionType *FTy = dyn_cast<FunctionType>(Ty)) {
656 const FunctionType *FTy2 = cast<FunctionType>(Ty2);
657 if (FTy->isVarArg() != FTy2->isVarArg() ||
658 FTy->getNumParams() != FTy2->getNumParams() ||
659 !TypesEqual(FTy->getReturnType(), FTy2->getReturnType(), EqTypes))
661 for (unsigned i = 0, e = FTy2->getNumParams(); i != e; ++i) {
662 if (!TypesEqual(FTy->getParamType(i), FTy2->getParamType(i), EqTypes))
667 llvm_unreachable("Unknown derived type!");
672 namespace llvm { // in namespace llvm so findable by ADL
673 static bool TypesEqual(const Type *Ty, const Type *Ty2) {
674 std::map<const Type *, const Type *> EqTypes;
675 return ::TypesEqual(Ty, Ty2, EqTypes);
679 // AbstractTypeHasCycleThrough - Return true there is a path from CurTy to
680 // TargetTy in the type graph. We know that Ty is an abstract type, so if we
681 // ever reach a non-abstract type, we know that we don't need to search the
683 static bool AbstractTypeHasCycleThrough(const Type *TargetTy, const Type *CurTy,
684 SmallPtrSet<const Type*, 128> &VisitedTypes) {
685 if (TargetTy == CurTy) return true;
686 if (!CurTy->isAbstract()) return false;
688 if (!VisitedTypes.insert(CurTy))
689 return false; // Already been here.
691 for (Type::subtype_iterator I = CurTy->subtype_begin(),
692 E = CurTy->subtype_end(); I != E; ++I)
693 if (AbstractTypeHasCycleThrough(TargetTy, *I, VisitedTypes))
698 static bool ConcreteTypeHasCycleThrough(const Type *TargetTy, const Type *CurTy,
699 SmallPtrSet<const Type*, 128> &VisitedTypes) {
700 if (TargetTy == CurTy) return true;
702 if (!VisitedTypes.insert(CurTy))
703 return false; // Already been here.
705 for (Type::subtype_iterator I = CurTy->subtype_begin(),
706 E = CurTy->subtype_end(); I != E; ++I)
707 if (ConcreteTypeHasCycleThrough(TargetTy, *I, VisitedTypes))
712 /// TypeHasCycleThroughItself - Return true if the specified type has
713 /// a cycle back to itself.
715 namespace llvm { // in namespace llvm so it's findable by ADL
716 static bool TypeHasCycleThroughItself(const Type *Ty) {
717 SmallPtrSet<const Type*, 128> VisitedTypes;
719 if (Ty->isAbstract()) { // Optimized case for abstract types.
720 for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
722 if (AbstractTypeHasCycleThrough(Ty, *I, VisitedTypes))
725 for (Type::subtype_iterator I = Ty->subtype_begin(), E = Ty->subtype_end();
727 if (ConcreteTypeHasCycleThrough(Ty, *I, VisitedTypes))
734 //===----------------------------------------------------------------------===//
735 // Function Type Factory and Value Class...
737 const IntegerType *IntegerType::get(LLVMContext &C, unsigned NumBits) {
738 assert(NumBits >= MIN_INT_BITS && "bitwidth too small");
739 assert(NumBits <= MAX_INT_BITS && "bitwidth too large");
741 // Check for the built-in integer types
743 case 1: return cast<IntegerType>(Type::getInt1Ty(C));
744 case 8: return cast<IntegerType>(Type::getInt8Ty(C));
745 case 16: return cast<IntegerType>(Type::getInt16Ty(C));
746 case 32: return cast<IntegerType>(Type::getInt32Ty(C));
747 case 64: return cast<IntegerType>(Type::getInt64Ty(C));
752 LLVMContextImpl *pImpl = C.pImpl;
754 IntegerValType IVT(NumBits);
755 IntegerType *ITy = 0;
757 // First, see if the type is already in the table, for which
758 // a reader lock suffices.
759 ITy = pImpl->IntegerTypes.get(IVT);
762 // Value not found. Derive a new type!
763 ITy = new IntegerType(C, NumBits);
764 pImpl->IntegerTypes.add(IVT, ITy);
766 #ifdef DEBUG_MERGE_TYPES
767 DEBUG(dbgs() << "Derived new type: " << *ITy << "\n");
772 bool IntegerType::isPowerOf2ByteWidth() const {
773 unsigned BitWidth = getBitWidth();
774 return (BitWidth > 7) && isPowerOf2_32(BitWidth);
777 APInt IntegerType::getMask() const {
778 return APInt::getAllOnesValue(getBitWidth());
781 FunctionValType FunctionValType::get(const FunctionType *FT) {
782 // Build up a FunctionValType
783 std::vector<const Type *> ParamTypes;
784 ParamTypes.reserve(FT->getNumParams());
785 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i)
786 ParamTypes.push_back(FT->getParamType(i));
787 return FunctionValType(FT->getReturnType(), ParamTypes, FT->isVarArg());
791 // FunctionType::get - The factory function for the FunctionType class...
792 FunctionType *FunctionType::get(const Type *ReturnType,
793 const std::vector<const Type*> &Params,
795 FunctionValType VT(ReturnType, Params, isVarArg);
796 FunctionType *FT = 0;
798 LLVMContextImpl *pImpl = ReturnType->getContext().pImpl;
800 FT = pImpl->FunctionTypes.get(VT);
803 FT = (FunctionType*) operator new(sizeof(FunctionType) +
804 sizeof(PATypeHandle)*(Params.size()+1));
805 new (FT) FunctionType(ReturnType, Params, isVarArg);
806 pImpl->FunctionTypes.add(VT, FT);
809 #ifdef DEBUG_MERGE_TYPES
810 DEBUG(dbgs() << "Derived new type: " << FT << "\n");
815 ArrayType *ArrayType::get(const Type *ElementType, uint64_t NumElements) {
816 assert(ElementType && "Can't get array of <null> types!");
817 assert(isValidElementType(ElementType) && "Invalid type for array element!");
819 ArrayValType AVT(ElementType, NumElements);
822 LLVMContextImpl *pImpl = ElementType->getContext().pImpl;
824 AT = pImpl->ArrayTypes.get(AVT);
827 // Value not found. Derive a new type!
828 pImpl->ArrayTypes.add(AVT, AT = new ArrayType(ElementType, NumElements));
830 #ifdef DEBUG_MERGE_TYPES
831 DEBUG(dbgs() << "Derived new type: " << *AT << "\n");
836 bool ArrayType::isValidElementType(const Type *ElemTy) {
837 return ElemTy->getTypeID() != VoidTyID && ElemTy->getTypeID() != LabelTyID &&
838 ElemTy->getTypeID() != MetadataTyID && !isa<FunctionType>(ElemTy);
841 VectorType *VectorType::get(const Type *ElementType, unsigned NumElements) {
842 assert(ElementType && "Can't get vector of <null> types!");
844 VectorValType PVT(ElementType, NumElements);
847 LLVMContextImpl *pImpl = ElementType->getContext().pImpl;
849 PT = pImpl->VectorTypes.get(PVT);
852 pImpl->VectorTypes.add(PVT, PT = new VectorType(ElementType, NumElements));
854 #ifdef DEBUG_MERGE_TYPES
855 DEBUG(dbgs() << "Derived new type: " << *PT << "\n");
860 bool VectorType::isValidElementType(const Type *ElemTy) {
861 return ElemTy->isInteger() || ElemTy->isFloatingPoint() ||
862 isa<OpaqueType>(ElemTy);
865 //===----------------------------------------------------------------------===//
866 // Struct Type Factory...
869 StructType *StructType::get(LLVMContext &Context,
870 const std::vector<const Type*> &ETypes,
872 StructValType STV(ETypes, isPacked);
875 LLVMContextImpl *pImpl = Context.pImpl;
877 ST = pImpl->StructTypes.get(STV);
880 // Value not found. Derive a new type!
881 ST = (StructType*) operator new(sizeof(StructType) +
882 sizeof(PATypeHandle) * ETypes.size());
883 new (ST) StructType(Context, ETypes, isPacked);
884 pImpl->StructTypes.add(STV, ST);
886 #ifdef DEBUG_MERGE_TYPES
887 DEBUG(dbgs() << "Derived new type: " << *ST << "\n");
892 StructType *StructType::get(LLVMContext &Context, const Type *type, ...) {
894 std::vector<const llvm::Type*> StructFields;
897 StructFields.push_back(type);
898 type = va_arg(ap, llvm::Type*);
900 return llvm::StructType::get(Context, StructFields);
903 bool StructType::isValidElementType(const Type *ElemTy) {
904 return ElemTy->getTypeID() != VoidTyID && ElemTy->getTypeID() != LabelTyID &&
905 ElemTy->getTypeID() != MetadataTyID && !isa<FunctionType>(ElemTy);
909 //===----------------------------------------------------------------------===//
910 // Pointer Type Factory...
913 PointerType *PointerType::get(const Type *ValueType, unsigned AddressSpace) {
914 assert(ValueType && "Can't get a pointer to <null> type!");
915 assert(ValueType->getTypeID() != VoidTyID &&
916 "Pointer to void is not valid, use i8* instead!");
917 assert(isValidElementType(ValueType) && "Invalid type for pointer element!");
918 PointerValType PVT(ValueType, AddressSpace);
922 LLVMContextImpl *pImpl = ValueType->getContext().pImpl;
924 PT = pImpl->PointerTypes.get(PVT);
927 // Value not found. Derive a new type!
928 pImpl->PointerTypes.add(PVT, PT = new PointerType(ValueType, AddressSpace));
930 #ifdef DEBUG_MERGE_TYPES
931 DEBUG(dbgs() << "Derived new type: " << *PT << "\n");
936 const PointerType *Type::getPointerTo(unsigned addrs) const {
937 return PointerType::get(this, addrs);
940 bool PointerType::isValidElementType(const Type *ElemTy) {
941 return ElemTy->getTypeID() != VoidTyID &&
942 ElemTy->getTypeID() != LabelTyID &&
943 ElemTy->getTypeID() != MetadataTyID;
947 //===----------------------------------------------------------------------===//
948 // Opaque Type Factory...
951 OpaqueType *OpaqueType::get(LLVMContext &C) {
952 OpaqueType *OT = new OpaqueType(C); // All opaque types are distinct
954 LLVMContextImpl *pImpl = C.pImpl;
955 pImpl->OpaqueTypes.insert(OT);
961 //===----------------------------------------------------------------------===//
962 // Derived Type Refinement Functions
963 //===----------------------------------------------------------------------===//
965 // addAbstractTypeUser - Notify an abstract type that there is a new user of
966 // it. This function is called primarily by the PATypeHandle class.
967 void Type::addAbstractTypeUser(AbstractTypeUser *U) const {
968 assert(isAbstract() && "addAbstractTypeUser: Current type not abstract!");
969 AbstractTypeUsers.push_back(U);
973 // removeAbstractTypeUser - Notify an abstract type that a user of the class
974 // no longer has a handle to the type. This function is called primarily by
975 // the PATypeHandle class. When there are no users of the abstract type, it
976 // is annihilated, because there is no way to get a reference to it ever again.
978 void Type::removeAbstractTypeUser(AbstractTypeUser *U) const {
980 // Search from back to front because we will notify users from back to
981 // front. Also, it is likely that there will be a stack like behavior to
982 // users that register and unregister users.
985 for (i = AbstractTypeUsers.size(); AbstractTypeUsers[i-1] != U; --i)
986 assert(i != 0 && "AbstractTypeUser not in user list!");
988 --i; // Convert to be in range 0 <= i < size()
989 assert(i < AbstractTypeUsers.size() && "Index out of range!"); // Wraparound?
991 AbstractTypeUsers.erase(AbstractTypeUsers.begin()+i);
993 #ifdef DEBUG_MERGE_TYPES
994 DEBUG(dbgs() << " remAbstractTypeUser[" << (void*)this << ", "
995 << *this << "][" << i << "] User = " << U << "\n");
998 if (AbstractTypeUsers.empty() && getRefCount() == 0 && isAbstract()) {
999 #ifdef DEBUG_MERGE_TYPES
1000 DEBUG(dbgs() << "DELETEing unused abstract type: <" << *this
1001 << ">[" << (void*)this << "]" << "\n");
1009 // unlockedRefineAbstractTypeTo - This function is used when it is discovered
1010 // that the 'this' abstract type is actually equivalent to the NewType
1011 // specified. This causes all users of 'this' to switch to reference the more
1012 // concrete type NewType and for 'this' to be deleted. Only used for internal
1015 void DerivedType::unlockedRefineAbstractTypeTo(const Type *NewType) {
1016 assert(isAbstract() && "refineAbstractTypeTo: Current type is not abstract!");
1017 assert(this != NewType && "Can't refine to myself!");
1018 assert(ForwardType == 0 && "This type has already been refined!");
1020 LLVMContextImpl *pImpl = getContext().pImpl;
1022 // The descriptions may be out of date. Conservatively clear them all!
1023 pImpl->AbstractTypeDescriptions.clear();
1025 #ifdef DEBUG_MERGE_TYPES
1026 DEBUG(dbgs() << "REFINING abstract type [" << (void*)this << " "
1027 << *this << "] to [" << (void*)NewType << " "
1028 << *NewType << "]!\n");
1031 // Make sure to put the type to be refined to into a holder so that if IT gets
1032 // refined, that we will not continue using a dead reference...
1034 PATypeHolder NewTy(NewType);
1035 // Any PATypeHolders referring to this type will now automatically forward to
1036 // the type we are resolved to.
1037 ForwardType = NewType;
1038 if (NewType->isAbstract())
1039 cast<DerivedType>(NewType)->addRef();
1041 // Add a self use of the current type so that we don't delete ourself until
1042 // after the function exits.
1044 PATypeHolder CurrentTy(this);
1046 // To make the situation simpler, we ask the subclass to remove this type from
1047 // the type map, and to replace any type uses with uses of non-abstract types.
1048 // This dramatically limits the amount of recursive type trouble we can find
1052 // Iterate over all of the uses of this type, invoking callback. Each user
1053 // should remove itself from our use list automatically. We have to check to
1054 // make sure that NewTy doesn't _become_ 'this'. If it does, resolving types
1055 // will not cause users to drop off of the use list. If we resolve to ourself
1058 while (!AbstractTypeUsers.empty() && NewTy != this) {
1059 AbstractTypeUser *User = AbstractTypeUsers.back();
1061 unsigned OldSize = AbstractTypeUsers.size(); OldSize=OldSize;
1062 #ifdef DEBUG_MERGE_TYPES
1063 DEBUG(dbgs() << " REFINING user " << OldSize-1 << "[" << (void*)User
1064 << "] of abstract type [" << (void*)this << " "
1065 << *this << "] to [" << (void*)NewTy.get() << " "
1066 << *NewTy << "]!\n");
1068 User->refineAbstractType(this, NewTy);
1070 assert(AbstractTypeUsers.size() != OldSize &&
1071 "AbsTyUser did not remove self from user list!");
1074 // If we were successful removing all users from the type, 'this' will be
1075 // deleted when the last PATypeHolder is destroyed or updated from this type.
1076 // This may occur on exit of this function, as the CurrentTy object is
1080 // refineAbstractTypeTo - This function is used by external callers to notify
1081 // us that this abstract type is equivalent to another type.
1083 void DerivedType::refineAbstractTypeTo(const Type *NewType) {
1084 // All recursive calls will go through unlockedRefineAbstractTypeTo,
1085 // to avoid deadlock problems.
1086 unlockedRefineAbstractTypeTo(NewType);
1089 // notifyUsesThatTypeBecameConcrete - Notify AbstractTypeUsers of this type that
1090 // the current type has transitioned from being abstract to being concrete.
1092 void DerivedType::notifyUsesThatTypeBecameConcrete() {
1093 #ifdef DEBUG_MERGE_TYPES
1094 DEBUG(dbgs() << "typeIsREFINED type: " << (void*)this << " " << *this <<"\n");
1097 unsigned OldSize = AbstractTypeUsers.size(); OldSize=OldSize;
1098 while (!AbstractTypeUsers.empty()) {
1099 AbstractTypeUser *ATU = AbstractTypeUsers.back();
1100 ATU->typeBecameConcrete(this);
1102 assert(AbstractTypeUsers.size() < OldSize-- &&
1103 "AbstractTypeUser did not remove itself from the use list!");
1107 // refineAbstractType - Called when a contained type is found to be more
1108 // concrete - this could potentially change us from an abstract type to a
1111 void FunctionType::refineAbstractType(const DerivedType *OldType,
1112 const Type *NewType) {
1113 LLVMContextImpl *pImpl = OldType->getContext().pImpl;
1114 pImpl->FunctionTypes.RefineAbstractType(this, OldType, NewType);
1117 void FunctionType::typeBecameConcrete(const DerivedType *AbsTy) {
1118 LLVMContextImpl *pImpl = AbsTy->getContext().pImpl;
1119 pImpl->FunctionTypes.TypeBecameConcrete(this, AbsTy);
1123 // refineAbstractType - Called when a contained type is found to be more
1124 // concrete - this could potentially change us from an abstract type to a
1127 void ArrayType::refineAbstractType(const DerivedType *OldType,
1128 const Type *NewType) {
1129 LLVMContextImpl *pImpl = OldType->getContext().pImpl;
1130 pImpl->ArrayTypes.RefineAbstractType(this, OldType, NewType);
1133 void ArrayType::typeBecameConcrete(const DerivedType *AbsTy) {
1134 LLVMContextImpl *pImpl = AbsTy->getContext().pImpl;
1135 pImpl->ArrayTypes.TypeBecameConcrete(this, AbsTy);
1138 // refineAbstractType - Called when a contained type is found to be more
1139 // concrete - this could potentially change us from an abstract type to a
1142 void VectorType::refineAbstractType(const DerivedType *OldType,
1143 const Type *NewType) {
1144 LLVMContextImpl *pImpl = OldType->getContext().pImpl;
1145 pImpl->VectorTypes.RefineAbstractType(this, OldType, NewType);
1148 void VectorType::typeBecameConcrete(const DerivedType *AbsTy) {
1149 LLVMContextImpl *pImpl = AbsTy->getContext().pImpl;
1150 pImpl->VectorTypes.TypeBecameConcrete(this, AbsTy);
1153 // refineAbstractType - Called when a contained type is found to be more
1154 // concrete - this could potentially change us from an abstract type to a
1157 void StructType::refineAbstractType(const DerivedType *OldType,
1158 const Type *NewType) {
1159 LLVMContextImpl *pImpl = OldType->getContext().pImpl;
1160 pImpl->StructTypes.RefineAbstractType(this, OldType, NewType);
1163 void StructType::typeBecameConcrete(const DerivedType *AbsTy) {
1164 LLVMContextImpl *pImpl = AbsTy->getContext().pImpl;
1165 pImpl->StructTypes.TypeBecameConcrete(this, AbsTy);
1168 // refineAbstractType - Called when a contained type is found to be more
1169 // concrete - this could potentially change us from an abstract type to a
1172 void PointerType::refineAbstractType(const DerivedType *OldType,
1173 const Type *NewType) {
1174 LLVMContextImpl *pImpl = OldType->getContext().pImpl;
1175 pImpl->PointerTypes.RefineAbstractType(this, OldType, NewType);
1178 void PointerType::typeBecameConcrete(const DerivedType *AbsTy) {
1179 LLVMContextImpl *pImpl = AbsTy->getContext().pImpl;
1180 pImpl->PointerTypes.TypeBecameConcrete(this, AbsTy);
1183 bool SequentialType::indexValid(const Value *V) const {
1184 if (isa<IntegerType>(V->getType()))
1190 raw_ostream &operator<<(raw_ostream &OS, const Type &T) {