lib/IR/Type.cpp

   1 //===-- Type.cpp - Implement the Type class -------------------------------===//
   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 Type class for the IR library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/IR/Type.h"
  15 #include "LLVMContextImpl.h"
  16 #include "llvm/ADT/SmallString.h"
  17 #include "llvm/IR/Module.h"
  18 #include <algorithm>
  19 #include <cstdarg>
  20 using namespace llvm;
  21
  22 //===----------------------------------------------------------------------===//
  23 //                         Type Class Implementation
  24 //===----------------------------------------------------------------------===//
  25
  26 Type *Type::getPrimitiveType(LLVMContext &C, TypeID IDNumber) {
  27   switch (IDNumber) {
  28   case VoidTyID      : return getVoidTy(C);
  29   case HalfTyID      : return getHalfTy(C);
  30   case FloatTyID     : return getFloatTy(C);
  31   case DoubleTyID    : return getDoubleTy(C);
  32   case X86_FP80TyID  : return getX86_FP80Ty(C);
  33   case FP128TyID     : return getFP128Ty(C);
  34   case PPC_FP128TyID : return getPPC_FP128Ty(C);
  35   case LabelTyID     : return getLabelTy(C);
  36   case MetadataTyID  : return getMetadataTy(C);
  37   case X86_MMXTyID   : return getX86_MMXTy(C);
  38   default:
  39     return nullptr;
  40   }
  41 }
  42
  43 /// getScalarType - If this is a vector type, return the element type,
  44 /// otherwise return this.
  45 Type *Type::getScalarType() {
  46   if (VectorType *VTy = dyn_cast<VectorType>(this))
  47     return VTy->getElementType();
  48   return this;
  49 }
  50
  51 const Type *Type::getScalarType() const {
  52   if (const VectorType *VTy = dyn_cast<VectorType>(this))
  53     return VTy->getElementType();
  54   return this;
  55 }
  56
  57 /// isIntegerTy - Return true if this is an IntegerType of the specified width.
  58 bool Type::isIntegerTy(unsigned Bitwidth) const {
  59   return isIntegerTy() && cast<IntegerType>(this)->getBitWidth() == Bitwidth;
  60 }
  61
  62 // canLosslesslyBitCastTo - Return true if this type can be converted to
  63 // 'Ty' without any reinterpretation of bits.  For example, i8* to i32*.
  64 //
  65 bool Type::canLosslesslyBitCastTo(Type *Ty) const {
  66   // Identity cast means no change so return true
  67   if (this == Ty)
  68     return true;
  69
  70   // They are not convertible unless they are at least first class types
  71   if (!this->isFirstClassType() || !Ty->isFirstClassType())
  72     return false;
  73
  74   // Vector -> Vector conversions are always lossless if the two vector types
  75   // have the same size, otherwise not.  Also, 64-bit vector types can be
  76   // converted to x86mmx.
  77   if (const VectorType *thisPTy = dyn_cast<VectorType>(this)) {
  78     if (const VectorType *thatPTy = dyn_cast<VectorType>(Ty))
  79       return thisPTy->getBitWidth() == thatPTy->getBitWidth();
  80     if (Ty->getTypeID() == Type::X86_MMXTyID &&
  81         thisPTy->getBitWidth() == 64)
  82       return true;
  83   }
  84
  85   if (this->getTypeID() == Type::X86_MMXTyID)
  86     if (const VectorType *thatPTy = dyn_cast<VectorType>(Ty))
  87       if (thatPTy->getBitWidth() == 64)
  88         return true;
  89
  90   // At this point we have only various mismatches of the first class types
  91   // remaining and ptr->ptr. Just select the lossless conversions. Everything
  92   // else is not lossless. Conservatively assume we can't losslessly convert
  93   // between pointers with different address spaces.
  94   if (const PointerType *PTy = dyn_cast<PointerType>(this)) {
  95     if (const PointerType *OtherPTy = dyn_cast<PointerType>(Ty))
  96       return PTy->getAddressSpace() == OtherPTy->getAddressSpace();
  97     return false;
  98   }
  99   return false;  // Other types have no identity values
 100 }
 101
 102 bool Type::isEmptyTy() const {
 103   const ArrayType *ATy = dyn_cast<ArrayType>(this);
 104   if (ATy) {
 105     unsigned NumElements = ATy->getNumElements();
 106     return NumElements == 0 || ATy->getElementType()->isEmptyTy();
 107   }
 108
 109   const StructType *STy = dyn_cast<StructType>(this);
 110   if (STy) {
 111     unsigned NumElements = STy->getNumElements();
 112     for (unsigned i = 0; i < NumElements; ++i)
 113       if (!STy->getElementType(i)->isEmptyTy())
 114         return false;
 115     return true;
 116   }
 117
 118   return false;
 119 }
 120
 121 unsigned Type::getPrimitiveSizeInBits() const {
 122   switch (getTypeID()) {
 123   case Type::HalfTyID: return 16;
 124   case Type::FloatTyID: return 32;
 125   case Type::DoubleTyID: return 64;
 126   case Type::X86_FP80TyID: return 80;
 127   case Type::FP128TyID: return 128;
 128   case Type::PPC_FP128TyID: return 128;
 129   case Type::X86_MMXTyID: return 64;
 130   case Type::IntegerTyID: return cast<IntegerType>(this)->getBitWidth();
 131   case Type::VectorTyID:  return cast<VectorType>(this)->getBitWidth();
 132   default: return 0;
 133   }
 134 }
 135
 136 /// getScalarSizeInBits - If this is a vector type, return the
 137 /// getPrimitiveSizeInBits value for the element type. Otherwise return the
 138 /// getPrimitiveSizeInBits value for this type.
 139 unsigned Type::getScalarSizeInBits() const {
 140   return getScalarType()->getPrimitiveSizeInBits();
 141 }
 142
 143 /// getFPMantissaWidth - Return the width of the mantissa of this type.  This
 144 /// is only valid on floating point types.  If the FP type does not
 145 /// have a stable mantissa (e.g. ppc long double), this method returns -1.
 146 int Type::getFPMantissaWidth() const {
 147   if (const VectorType *VTy = dyn_cast<VectorType>(this))
 148     return VTy->getElementType()->getFPMantissaWidth();
 149   assert(isFloatingPointTy() && "Not a floating point type!");
 150   if (getTypeID() == HalfTyID) return 11;
 151   if (getTypeID() == FloatTyID) return 24;
 152   if (getTypeID() == DoubleTyID) return 53;
 153   if (getTypeID() == X86_FP80TyID) return 64;
 154   if (getTypeID() == FP128TyID) return 113;
 155   assert(getTypeID() == PPC_FP128TyID && "unknown fp type");
 156   return -1;
 157 }
 158
 159 /// isSizedDerivedType - Derived types like structures and arrays are sized
 160 /// iff all of the members of the type are sized as well.  Since asking for
 161 /// their size is relatively uncommon, move this operation out of line.
 162 bool Type::isSizedDerivedType(SmallPtrSetImpl<const Type*> *Visited) const {
 163   if (const ArrayType *ATy = dyn_cast<ArrayType>(this))
 164     return ATy->getElementType()->isSized(Visited);
 165
 166   if (const VectorType *VTy = dyn_cast<VectorType>(this))
 167     return VTy->getElementType()->isSized(Visited);
 168
 169   return cast<StructType>(this)->isSized(Visited);
 170 }
 171
 172 //===----------------------------------------------------------------------===//
 173 //                         Subclass Helper Methods
 174 //===----------------------------------------------------------------------===//
 175
 176 unsigned Type::getIntegerBitWidth() const {
 177   return cast<IntegerType>(this)->getBitWidth();
 178 }
 179
 180 bool Type::isFunctionVarArg() const {
 181   return cast<FunctionType>(this)->isVarArg();
 182 }
 183
 184 Type *Type::getFunctionParamType(unsigned i) const {
 185   return cast<FunctionType>(this)->getParamType(i);
 186 }
 187
 188 unsigned Type::getFunctionNumParams() const {
 189   return cast<FunctionType>(this)->getNumParams();
 190 }
 191
 192 StringRef Type::getStructName() const {
 193   return cast<StructType>(this)->getName();
 194 }
 195
 196 unsigned Type::getStructNumElements() const {
 197   return cast<StructType>(this)->getNumElements();
 198 }
 199
 200 Type *Type::getStructElementType(unsigned N) const {
 201   return cast<StructType>(this)->getElementType(N);
 202 }
 203
 204 Type *Type::getSequentialElementType() const {
 205   return cast<SequentialType>(this)->getElementType();
 206 }
 207
 208 uint64_t Type::getArrayNumElements() const {
 209   return cast<ArrayType>(this)->getNumElements();
 210 }
 211
 212 unsigned Type::getVectorNumElements() const {
 213   return cast<VectorType>(this)->getNumElements();
 214 }
 215
 216 unsigned Type::getPointerAddressSpace() const {
 217   return cast<PointerType>(getScalarType())->getAddressSpace();
 218 }
 219
 220
 221 //===----------------------------------------------------------------------===//
 222 //                          Primitive 'Type' data
 223 //===----------------------------------------------------------------------===//
 224
 225 Type *Type::getVoidTy(LLVMContext &C) { return &C.pImpl->VoidTy; }
 226 Type *Type::getLabelTy(LLVMContext &C) { return &C.pImpl->LabelTy; }
 227 Type *Type::getHalfTy(LLVMContext &C) { return &C.pImpl->HalfTy; }
 228 Type *Type::getFloatTy(LLVMContext &C) { return &C.pImpl->FloatTy; }
 229 Type *Type::getDoubleTy(LLVMContext &C) { return &C.pImpl->DoubleTy; }
 230 Type *Type::getMetadataTy(LLVMContext &C) { return &C.pImpl->MetadataTy; }
 231 Type *Type::getX86_FP80Ty(LLVMContext &C) { return &C.pImpl->X86_FP80Ty; }
 232 Type *Type::getFP128Ty(LLVMContext &C) { return &C.pImpl->FP128Ty; }
 233 Type *Type::getPPC_FP128Ty(LLVMContext &C) { return &C.pImpl->PPC_FP128Ty; }
 234 Type *Type::getX86_MMXTy(LLVMContext &C) { return &C.pImpl->X86_MMXTy; }
 235
 236 IntegerType *Type::getInt1Ty(LLVMContext &C) { return &C.pImpl->Int1Ty; }
 237 IntegerType *Type::getInt8Ty(LLVMContext &C) { return &C.pImpl->Int8Ty; }
 238 IntegerType *Type::getInt16Ty(LLVMContext &C) { return &C.pImpl->Int16Ty; }
 239 IntegerType *Type::getInt32Ty(LLVMContext &C) { return &C.pImpl->Int32Ty; }
 240 IntegerType *Type::getInt64Ty(LLVMContext &C) { return &C.pImpl->Int64Ty; }
 241 IntegerType *Type::getInt128Ty(LLVMContext &C) { return &C.pImpl->Int128Ty; }
 242
 243 IntegerType *Type::getIntNTy(LLVMContext &C, unsigned N) {
 244   return IntegerType::get(C, N);
 245 }
 246
 247 PointerType *Type::getHalfPtrTy(LLVMContext &C, unsigned AS) {
 248   return getHalfTy(C)->getPointerTo(AS);
 249 }
 250
 251 PointerType *Type::getFloatPtrTy(LLVMContext &C, unsigned AS) {
 252   return getFloatTy(C)->getPointerTo(AS);
 253 }
 254
 255 PointerType *Type::getDoublePtrTy(LLVMContext &C, unsigned AS) {
 256   return getDoubleTy(C)->getPointerTo(AS);
 257 }
 258
 259 PointerType *Type::getX86_FP80PtrTy(LLVMContext &C, unsigned AS) {
 260   return getX86_FP80Ty(C)->getPointerTo(AS);
 261 }
 262
 263 PointerType *Type::getFP128PtrTy(LLVMContext &C, unsigned AS) {
 264   return getFP128Ty(C)->getPointerTo(AS);
 265 }
 266
 267 PointerType *Type::getPPC_FP128PtrTy(LLVMContext &C, unsigned AS) {
 268   return getPPC_FP128Ty(C)->getPointerTo(AS);
 269 }
 270
 271 PointerType *Type::getX86_MMXPtrTy(LLVMContext &C, unsigned AS) {
 272   return getX86_MMXTy(C)->getPointerTo(AS);
 273 }
 274
 275 PointerType *Type::getIntNPtrTy(LLVMContext &C, unsigned N, unsigned AS) {
 276   return getIntNTy(C, N)->getPointerTo(AS);
 277 }
 278
 279 PointerType *Type::getInt1PtrTy(LLVMContext &C, unsigned AS) {
 280   return getInt1Ty(C)->getPointerTo(AS);
 281 }
 282
 283 PointerType *Type::getInt8PtrTy(LLVMContext &C, unsigned AS) {
 284   return getInt8Ty(C)->getPointerTo(AS);
 285 }
 286
 287 PointerType *Type::getInt16PtrTy(LLVMContext &C, unsigned AS) {
 288   return getInt16Ty(C)->getPointerTo(AS);
 289 }
 290
 291 PointerType *Type::getInt32PtrTy(LLVMContext &C, unsigned AS) {
 292   return getInt32Ty(C)->getPointerTo(AS);
 293 }
 294
 295 PointerType *Type::getInt64PtrTy(LLVMContext &C, unsigned AS) {
 296   return getInt64Ty(C)->getPointerTo(AS);
 297 }
 298
 299
 300 //===----------------------------------------------------------------------===//
 301 //                       IntegerType Implementation
 302 //===----------------------------------------------------------------------===//
 303
 304 IntegerType *IntegerType::get(LLVMContext &C, unsigned NumBits) {
 305   assert(NumBits >= MIN_INT_BITS && "bitwidth too small");
 306   assert(NumBits <= MAX_INT_BITS && "bitwidth too large");
 307
 308   // Check for the built-in integer types
 309   switch (NumBits) {
 310   case  1: return cast<IntegerType>(Type::getInt1Ty(C));
 311   case  8: return cast<IntegerType>(Type::getInt8Ty(C));
 312   case 16: return cast<IntegerType>(Type::getInt16Ty(C));
 313   case 32: return cast<IntegerType>(Type::getInt32Ty(C));
 314   case 64: return cast<IntegerType>(Type::getInt64Ty(C));
 315   default:
 316     break;
 317   }
 318
 319   IntegerType *&Entry = C.pImpl->IntegerTypes[NumBits];
 320
 321   if (!Entry)
 322     Entry = new (C.pImpl->TypeAllocator) IntegerType(C, NumBits);
 323
 324   return Entry;
 325 }
 326
 327 bool IntegerType::isPowerOf2ByteWidth() const {
 328   unsigned BitWidth = getBitWidth();
 329   return (BitWidth > 7) && isPowerOf2_32(BitWidth);
 330 }
 331
 332 APInt IntegerType::getMask() const {
 333   return APInt::getAllOnesValue(getBitWidth());
 334 }
 335
 336 //===----------------------------------------------------------------------===//
 337 //                       FunctionType Implementation
 338 //===----------------------------------------------------------------------===//
 339
 340 FunctionType::FunctionType(Type *Result, ArrayRef<Type*> Params,
 341                            bool IsVarArgs)
 342   : Type(Result->getContext(), FunctionTyID) {
 343   Type **SubTys = reinterpret_cast<Type**>(this+1);
 344   assert(isValidReturnType(Result) && "invalid return type for function");
 345   setSubclassData(IsVarArgs);
 346
 347   SubTys[0] = const_cast<Type*>(Result);
 348
 349   for (unsigned i = 0, e = Params.size(); i != e; ++i) {
 350     assert(isValidArgumentType(Params[i]) &&
 351            "Not a valid type for function argument!");
 352     SubTys[i+1] = Params[i];
 353   }
 354
 355   ContainedTys = SubTys;
 356   NumContainedTys = Params.size() + 1; // + 1 for result type
 357 }
 358
 359 // FunctionType::get - The factory function for the FunctionType class.
 360 FunctionType *FunctionType::get(Type *ReturnType,
 361                                 ArrayRef<Type*> Params, bool isVarArg) {
 362   LLVMContextImpl *pImpl = ReturnType->getContext().pImpl;
 363   FunctionTypeKeyInfo::KeyTy Key(ReturnType, Params, isVarArg);
 364   auto I = pImpl->FunctionTypes.find_as(Key);
 365   FunctionType *FT;
 366
 367   if (I == pImpl->FunctionTypes.end()) {
 368     FT = (FunctionType*) pImpl->TypeAllocator.
 369       Allocate(sizeof(FunctionType) + sizeof(Type*) * (Params.size() + 1),
 370                AlignOf<FunctionType>::Alignment);
 371     new (FT) FunctionType(ReturnType, Params, isVarArg);
 372     pImpl->FunctionTypes.insert(FT);
 373   } else {
 374     FT = *I;
 375   }
 376
 377   return FT;
 378 }
 379
 380 FunctionType *FunctionType::get(Type *Result, bool isVarArg) {
 381   return get(Result, None, isVarArg);
 382 }
 383
 384 /// isValidReturnType - Return true if the specified type is valid as a return
 385 /// type.
 386 bool FunctionType::isValidReturnType(Type *RetTy) {
 387   return !RetTy->isFunctionTy() && !RetTy->isLabelTy() &&
 388   !RetTy->isMetadataTy();
 389 }
 390
 391 /// isValidArgumentType - Return true if the specified type is valid as an
 392 /// argument type.
 393 bool FunctionType::isValidArgumentType(Type *ArgTy) {
 394   return ArgTy->isFirstClassType();
 395 }
 396
 397 //===----------------------------------------------------------------------===//
 398 //                       StructType Implementation
 399 //===----------------------------------------------------------------------===//
 400
 401 // Primitive Constructors.
 402
 403 StructType *StructType::get(LLVMContext &Context, ArrayRef<Type*> ETypes,
 404                             bool isPacked) {
 405   LLVMContextImpl *pImpl = Context.pImpl;
 406   AnonStructTypeKeyInfo::KeyTy Key(ETypes, isPacked);
 407   auto I = pImpl->AnonStructTypes.find_as(Key);
 408   StructType *ST;
 409
 410   if (I == pImpl->AnonStructTypes.end()) {
 411     // Value not found.  Create a new type!
 412     ST = new (Context.pImpl->TypeAllocator) StructType(Context);
 413     ST->setSubclassData(SCDB_IsLiteral);  // Literal struct.
 414     ST->setBody(ETypes, isPacked);
 415     Context.pImpl->AnonStructTypes.insert(ST);
 416   } else {
 417     ST = *I;
 418   }
 419
 420   return ST;
 421 }
 422
 423 void StructType::setBody(ArrayRef<Type*> Elements, bool isPacked) {
 424   assert(isOpaque() && "Struct body already set!");
 425
 426   setSubclassData(getSubclassData() | SCDB_HasBody);
 427   if (isPacked)
 428     setSubclassData(getSubclassData() | SCDB_Packed);
 429
 430   unsigned NumElements = Elements.size();
 431   Type **Elts = getContext().pImpl->TypeAllocator.Allocate<Type*>(NumElements);
 432   memcpy(Elts, Elements.data(), sizeof(Elements[0]) * NumElements);
 433
 434   ContainedTys = Elts;
 435   NumContainedTys = NumElements;
 436 }
 437
 438 void StructType::setName(StringRef Name) {
 439   if (Name == getName()) return;
 440
 441   StringMap<StructType *> &SymbolTable = getContext().pImpl->NamedStructTypes;
 442   typedef StringMap<StructType *>::MapEntryTy EntryTy;
 443
 444   // If this struct already had a name, remove its symbol table entry. Don't
 445   // delete the data yet because it may be part of the new name.
 446   if (SymbolTableEntry)
 447     SymbolTable.remove((EntryTy *)SymbolTableEntry);
 448
 449   // If this is just removing the name, we're done.
 450   if (Name.empty()) {
 451     if (SymbolTableEntry) {
 452       // Delete the old string data.
 453       ((EntryTy *)SymbolTableEntry)->Destroy(SymbolTable.getAllocator());
 454       SymbolTableEntry = nullptr;
 455     }
 456     return;
 457   }
 458
 459   // Look up the entry for the name.
 460   auto IterBool =
 461       getContext().pImpl->NamedStructTypes.insert(std::make_pair(Name, this));
 462
 463   // While we have a name collision, try a random rename.
 464   if (!IterBool.second) {
 465     SmallString<64> TempStr(Name);
 466     TempStr.push_back('.');
 467     raw_svector_ostream TmpStream(TempStr);
 468     unsigned NameSize = Name.size();
 469
 470     do {
 471       TempStr.resize(NameSize + 1);
 472       TmpStream.resync();
 473       TmpStream << getContext().pImpl->NamedStructTypesUniqueID++;
 474
 475       IterBool = getContext().pImpl->NamedStructTypes.insert(
 476           std::make_pair(TmpStream.str(), this));
 477     } while (!IterBool.second);
 478   }
 479
 480   // Delete the old string data.
 481   if (SymbolTableEntry)
 482     ((EntryTy *)SymbolTableEntry)->Destroy(SymbolTable.getAllocator());
 483   SymbolTableEntry = &*IterBool.first;
 484 }
 485
 486 //===----------------------------------------------------------------------===//
 487 // StructType Helper functions.
 488
 489 StructType *StructType::create(LLVMContext &Context, StringRef Name) {
 490   StructType *ST = new (Context.pImpl->TypeAllocator) StructType(Context);
 491   if (!Name.empty())
 492     ST->setName(Name);
 493   return ST;
 494 }
 495
 496 StructType *StructType::get(LLVMContext &Context, bool isPacked) {
 497   return get(Context, None, isPacked);
 498 }
 499
 500 StructType *StructType::get(Type *type, ...) {
 501   assert(type && "Cannot create a struct type with no elements with this");
 502   LLVMContext &Ctx = type->getContext();
 503   va_list ap;
 504   SmallVector<llvm::Type*, 8> StructFields;
 505   va_start(ap, type);
 506   while (type) {
 507     StructFields.push_back(type);
 508     type = va_arg(ap, llvm::Type*);
 509   }
 510   auto *Ret = llvm::StructType::get(Ctx, StructFields);
 511   va_end(ap);
 512   return Ret;
 513 }
 514
 515 StructType *StructType::create(LLVMContext &Context, ArrayRef<Type*> Elements,
 516                                StringRef Name, bool isPacked) {
 517   StructType *ST = create(Context, Name);
 518   ST->setBody(Elements, isPacked);
 519   return ST;
 520 }
 521
 522 StructType *StructType::create(LLVMContext &Context, ArrayRef<Type*> Elements) {
 523   return create(Context, Elements, StringRef());
 524 }
 525
 526 StructType *StructType::create(LLVMContext &Context) {
 527   return create(Context, StringRef());
 528 }
 529
 530 StructType *StructType::create(ArrayRef<Type*> Elements, StringRef Name,
 531                                bool isPacked) {
 532   assert(!Elements.empty() &&
 533          "This method may not be invoked with an empty list");
 534   return create(Elements[0]->getContext(), Elements, Name, isPacked);
 535 }
 536
 537 StructType *StructType::create(ArrayRef<Type*> Elements) {
 538   assert(!Elements.empty() &&
 539          "This method may not be invoked with an empty list");
 540   return create(Elements[0]->getContext(), Elements, StringRef());
 541 }
 542
 543 StructType *StructType::create(StringRef Name, Type *type, ...) {
 544   assert(type && "Cannot create a struct type with no elements with this");
 545   LLVMContext &Ctx = type->getContext();
 546   va_list ap;
 547   SmallVector<llvm::Type*, 8> StructFields;
 548   va_start(ap, type);
 549   while (type) {
 550     StructFields.push_back(type);
 551     type = va_arg(ap, llvm::Type*);
 552   }
 553   auto *Ret = llvm::StructType::create(Ctx, StructFields, Name);
 554   va_end(ap);
 555   return Ret;
 556 }
 557
 558 bool StructType::isSized(SmallPtrSetImpl<const Type*> *Visited) const {
 559   if ((getSubclassData() & SCDB_IsSized) != 0)
 560     return true;
 561   if (isOpaque())
 562     return false;
 563
 564   if (Visited && !Visited->insert(this).second)
 565     return false;
 566
 567   // Okay, our struct is sized if all of the elements are, but if one of the
 568   // elements is opaque, the struct isn't sized *yet*, but may become sized in
 569   // the future, so just bail out without caching.
 570   for (element_iterator I = element_begin(), E = element_end(); I != E; ++I)
 571     if (!(*I)->isSized(Visited))
 572       return false;
 573
 574   // Here we cheat a bit and cast away const-ness. The goal is to memoize when
 575   // we find a sized type, as types can only move from opaque to sized, not the
 576   // other way.
 577   const_cast<StructType*>(this)->setSubclassData(
 578     getSubclassData() | SCDB_IsSized);
 579   return true;
 580 }
 581
 582 StringRef StructType::getName() const {
 583   assert(!isLiteral() && "Literal structs never have names");
 584   if (!SymbolTableEntry) return StringRef();
 585
 586   return ((StringMapEntry<StructType*> *)SymbolTableEntry)->getKey();
 587 }
 588
 589 void StructType::setBody(Type *type, ...) {
 590   assert(type && "Cannot create a struct type with no elements with this");
 591   va_list ap;
 592   SmallVector<llvm::Type*, 8> StructFields;
 593   va_start(ap, type);
 594   while (type) {
 595     StructFields.push_back(type);
 596     type = va_arg(ap, llvm::Type*);
 597   }
 598   setBody(StructFields);
 599   va_end(ap);
 600 }
 601
 602 bool StructType::isValidElementType(Type *ElemTy) {
 603   return !ElemTy->isVoidTy() && !ElemTy->isLabelTy() &&
 604          !ElemTy->isMetadataTy() && !ElemTy->isFunctionTy();
 605 }
 606
 607 /// isLayoutIdentical - Return true if this is layout identical to the
 608 /// specified struct.
 609 bool StructType::isLayoutIdentical(StructType *Other) const {
 610   if (this == Other) return true;
 611
 612   if (isPacked() != Other->isPacked() ||
 613       getNumElements() != Other->getNumElements())
 614     return false;
 615
 616   return std::equal(element_begin(), element_end(), Other->element_begin());
 617 }
 618
 619 /// getTypeByName - Return the type with the specified name, or null if there
 620 /// is none by that name.
 621 StructType *Module::getTypeByName(StringRef Name) const {
 622   return getContext().pImpl->NamedStructTypes.lookup(Name);
 623 }
 624
 625
 626 //===----------------------------------------------------------------------===//
 627 //                       CompositeType Implementation
 628 //===----------------------------------------------------------------------===//
 629
 630 Type *CompositeType::getTypeAtIndex(const Value *V) {
 631   if (StructType *STy = dyn_cast<StructType>(this)) {
 632     unsigned Idx =
 633       (unsigned)cast<Constant>(V)->getUniqueInteger().getZExtValue();
 634     assert(indexValid(Idx) && "Invalid structure index!");
 635     return STy->getElementType(Idx);
 636   }
 637
 638   return cast<SequentialType>(this)->getElementType();
 639 }
 640 Type *CompositeType::getTypeAtIndex(unsigned Idx) {
 641   if (StructType *STy = dyn_cast<StructType>(this)) {
 642     assert(indexValid(Idx) && "Invalid structure index!");
 643     return STy->getElementType(Idx);
 644   }
 645
 646   return cast<SequentialType>(this)->getElementType();
 647 }
 648 bool CompositeType::indexValid(const Value *V) const {
 649   if (const StructType *STy = dyn_cast<StructType>(this)) {
 650     // Structure indexes require (vectors of) 32-bit integer constants.  In the
 651     // vector case all of the indices must be equal.
 652     if (!V->getType()->getScalarType()->isIntegerTy(32))
 653       return false;
 654     const Constant *C = dyn_cast<Constant>(V);
 655     if (C && V->getType()->isVectorTy())
 656       C = C->getSplatValue();
 657     const ConstantInt *CU = dyn_cast_or_null<ConstantInt>(C);
 658     return CU && CU->getZExtValue() < STy->getNumElements();
 659   }
 660
 661   // Sequential types can be indexed by any integer.
 662   return V->getType()->isIntOrIntVectorTy();
 663 }
 664
 665 bool CompositeType::indexValid(unsigned Idx) const {
 666   if (const StructType *STy = dyn_cast<StructType>(this))
 667     return Idx < STy->getNumElements();
 668   // Sequential types can be indexed by any integer.
 669   return true;
 670 }
 671
 672
 673 //===----------------------------------------------------------------------===//
 674 //                           ArrayType Implementation
 675 //===----------------------------------------------------------------------===//
 676
 677 ArrayType::ArrayType(Type *ElType, uint64_t NumEl)
 678   : SequentialType(ArrayTyID, ElType) {
 679   NumElements = NumEl;
 680 }
 681
 682 ArrayType *ArrayType::get(Type *elementType, uint64_t NumElements) {
 683   Type *ElementType = const_cast<Type*>(elementType);
 684   assert(isValidElementType(ElementType) && "Invalid type for array element!");
 685
 686   LLVMContextImpl *pImpl = ElementType->getContext().pImpl;
 687   ArrayType *&Entry =
 688     pImpl->ArrayTypes[std::make_pair(ElementType, NumElements)];
 689
 690   if (!Entry)
 691     Entry = new (pImpl->TypeAllocator) ArrayType(ElementType, NumElements);
 692   return Entry;
 693 }
 694
 695 bool ArrayType::isValidElementType(Type *ElemTy) {
 696   return !ElemTy->isVoidTy() && !ElemTy->isLabelTy() &&
 697          !ElemTy->isMetadataTy() && !ElemTy->isFunctionTy();
 698 }
 699
 700 //===----------------------------------------------------------------------===//
 701 //                          VectorType Implementation
 702 //===----------------------------------------------------------------------===//
 703
 704 VectorType::VectorType(Type *ElType, unsigned NumEl)
 705   : SequentialType(VectorTyID, ElType) {
 706   NumElements = NumEl;
 707 }
 708
 709 VectorType *VectorType::get(Type *elementType, unsigned NumElements) {
 710   Type *ElementType = const_cast<Type*>(elementType);
 711   assert(NumElements > 0 && "#Elements of a VectorType must be greater than 0");
 712   assert(isValidElementType(ElementType) && "Element type of a VectorType must "
 713                                             "be an integer, floating point, or "
 714                                             "pointer type.");
 715
 716   LLVMContextImpl *pImpl = ElementType->getContext().pImpl;
 717   VectorType *&Entry = ElementType->getContext().pImpl
 718     ->VectorTypes[std::make_pair(ElementType, NumElements)];
 719
 720   if (!Entry)
 721     Entry = new (pImpl->TypeAllocator) VectorType(ElementType, NumElements);
 722   return Entry;
 723 }
 724
 725 bool VectorType::isValidElementType(Type *ElemTy) {
 726   return ElemTy->isIntegerTy() || ElemTy->isFloatingPointTy() ||
 727     ElemTy->isPointerTy();
 728 }
 729
 730 //===----------------------------------------------------------------------===//
 731 //                         PointerType Implementation
 732 //===----------------------------------------------------------------------===//
 733
 734 PointerType *PointerType::get(Type *EltTy, unsigned AddressSpace) {
 735   assert(EltTy && "Can't get a pointer to <null> type!");
 736   assert(isValidElementType(EltTy) && "Invalid type for pointer element!");
 737
 738   LLVMContextImpl *CImpl = EltTy->getContext().pImpl;
 739
 740   // Since AddressSpace #0 is the common case, we special case it.
 741   PointerType *&Entry = AddressSpace == 0 ? CImpl->PointerTypes[EltTy]
 742      : CImpl->ASPointerTypes[std::make_pair(EltTy, AddressSpace)];
 743
 744   if (!Entry)
 745     Entry = new (CImpl->TypeAllocator) PointerType(EltTy, AddressSpace);
 746   return Entry;
 747 }
 748
 749
 750 PointerType::PointerType(Type *E, unsigned AddrSpace)
 751   : SequentialType(PointerTyID, E) {
 752 #ifndef NDEBUG
 753   const unsigned oldNCT = NumContainedTys;
 754 #endif
 755   setSubclassData(AddrSpace);
 756   // Check for miscompile. PR11652.
 757   assert(oldNCT == NumContainedTys && "bitfield written out of bounds?");
 758 }
 759
 760 PointerType *Type::getPointerTo(unsigned addrs) {
 761   return PointerType::get(this, addrs);
 762 }
 763
 764 bool PointerType::isValidElementType(Type *ElemTy) {
 765   return !ElemTy->isVoidTy() && !ElemTy->isLabelTy() &&
 766          !ElemTy->isMetadataTy();
 767 }