lib/Target/TargetData.cpp

   1 //===-- TargetData.cpp - Data size & alignment routines --------------------==//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines target properties related to datatype size/offset/alignment
  11 // information.
  12 //
  13 // This structure should be created once, filled in if the defaults are not
  14 // correct and then passed around by const&.  None of the members functions
  15 // require modification to the object.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "llvm/Target/TargetData.h"
  20 #include "llvm/Module.h"
  21 #include "llvm/DerivedTypes.h"
  22 #include "llvm/Constants.h"
  23 #include "llvm/Support/GetElementPtrTypeIterator.h"
  24 #include "llvm/Support/MathExtras.h"
  25 #include "llvm/ADT/StringExtras.h"
  26 #include <algorithm>
  27 #include <cstdlib>
  28 #include <sstream>
  29 using namespace llvm;
  30
  31 // Handle the Pass registration stuff necessary to use TargetData's.
  32 namespace {
  33   // Register the default SparcV9 implementation...
  34   RegisterPass<TargetData> X("targetdata", "Target Data Layout");
  35 }
  36
  37 static inline void getTypeInfoABI(const Type *Ty, const TargetData *TD,
  38                                   uint64_t &Size, unsigned char &Alignment);
  39
  40 static inline void getTypeInfoPref(const Type *Ty, const TargetData *TD,
  41                                    uint64_t &Size, unsigned char &Alignment);
  42
  43 //===----------------------------------------------------------------------===//
  44 // Support for StructLayout
  45 //===----------------------------------------------------------------------===//
  46
  47 StructLayout::StructLayout(const StructType *ST, const TargetData &TD) {
  48   StructAlignment = 0;
  49   StructSize = 0;
  50
  51   // Loop over each of the elements, placing them in memory...
  52   for (StructType::element_iterator TI = ST->element_begin(),
  53          TE = ST->element_end(); TI != TE; ++TI) {
  54     const Type *Ty = *TI;
  55     unsigned char A;
  56     unsigned TyAlign;
  57     uint64_t TySize;
  58     getTypeInfoABI(Ty, &TD, TySize, A);
  59     TyAlign = ST->isPacked() ? 1 : A;
  60
  61     // Add padding if necessary to make the data element aligned properly...
  62     if (StructSize % TyAlign != 0)
  63       StructSize = (StructSize/TyAlign + 1) * TyAlign;   // Add padding...
  64
  65     // Keep track of maximum alignment constraint
  66     StructAlignment = std::max(TyAlign, StructAlignment);
  67
  68     MemberOffsets.push_back(StructSize);
  69     StructSize += TySize;                 // Consume space for this data item
  70   }
  71
  72   // Empty structures have alignment of 1 byte.
  73   if (StructAlignment == 0) StructAlignment = 1;
  74
  75   // Add padding to the end of the struct so that it could be put in an array
  76   // and all array elements would be aligned correctly.
  77   if (StructSize % StructAlignment != 0)
  78     StructSize = (StructSize/StructAlignment + 1) * StructAlignment;
  79 }
  80
  81
  82 /// getElementContainingOffset - Given a valid offset into the structure,
  83 /// return the structure index that contains it.
  84 unsigned StructLayout::getElementContainingOffset(uint64_t Offset) const {
  85   std::vector<uint64_t>::const_iterator SI =
  86     std::upper_bound(MemberOffsets.begin(), MemberOffsets.end(), Offset);
  87   assert(SI != MemberOffsets.begin() && "Offset not in structure type!");
  88   --SI;
  89   assert(*SI <= Offset && "upper_bound didn't work");
  90   assert((SI == MemberOffsets.begin() || *(SI-1) < Offset) &&
  91          (SI+1 == MemberOffsets.end() || *(SI+1) > Offset) &&
  92          "Upper bound didn't work!");
  93   return SI-MemberOffsets.begin();
  94 }
  95
  96 //===----------------------------------------------------------------------===//
  97 //                       TargetData Class Implementation
  98 //===----------------------------------------------------------------------===//
  99
 100 void TargetData::init(const std::string &TargetDescription) {
 101   std::string temp = TargetDescription;
 102
 103   LittleEndian = false;
 104   PointerMemSize = 8;
 105   PointerABIAlignment   = 8;
 106   DoubleABIAlignment = 0;
 107   FloatABIAlignment = 4;
 108   LongABIAlignment   = 0;
 109   IntABIAlignment   = 4;
 110   ShortABIAlignment  = 2;
 111   ByteABIAlignment  = 1;
 112   BoolABIAlignment   = 1;
 113   BoolPrefAlignment = BoolABIAlignment;
 114   BytePrefAlignment = ByteABIAlignment;
 115   ShortPrefAlignment = ShortABIAlignment;
 116   IntPrefAlignment = IntABIAlignment;
 117   LongPrefAlignment = 8;
 118   FloatPrefAlignment = FloatABIAlignment;
 119   DoublePrefAlignment = 8;
 120   PointerPrefAlignment = PointerABIAlignment;
 121   AggMinPrefAlignment = 0;
 122
 123   while (!temp.empty()) {
 124     std::string token = getToken(temp, "-");
 125
 126     char signal = getToken(token, ":")[0];
 127
 128     switch(signal) {
 129     case 'E':
 130       LittleEndian = false;
 131       break;
 132     case 'e':
 133       LittleEndian = true;
 134       break;
 135     case 'p':
 136       PointerMemSize = atoi(getToken(token,":").c_str()) / 8;
 137       PointerABIAlignment = atoi(getToken(token,":").c_str()) / 8;
 138       PointerPrefAlignment = atoi(getToken(token,":").c_str()) / 8;
 139       if (PointerPrefAlignment == 0)
 140         PointerPrefAlignment = PointerABIAlignment;
 141       break;
 142     case 'd':
 143       DoubleABIAlignment = atoi(getToken(token,":").c_str()) / 8;
 144       DoublePrefAlignment = atoi(getToken(token,":").c_str()) / 8;
 145       if (DoublePrefAlignment == 0)
 146         DoublePrefAlignment = DoubleABIAlignment;
 147       break;
 148     case 'f':
 149       FloatABIAlignment = atoi(getToken(token, ":").c_str()) / 8;
 150       FloatPrefAlignment = atoi(getToken(token,":").c_str()) / 8;
 151       if (FloatPrefAlignment == 0)
 152         FloatPrefAlignment = FloatABIAlignment;
 153       break;
 154     case 'l':
 155       LongABIAlignment = atoi(getToken(token, ":").c_str()) / 8;
 156       LongPrefAlignment = atoi(getToken(token,":").c_str()) / 8;
 157       if (LongPrefAlignment == 0)
 158         LongPrefAlignment = LongABIAlignment;
 159       break;
 160     case 'i':
 161       IntABIAlignment = atoi(getToken(token, ":").c_str()) / 8;
 162       IntPrefAlignment = atoi(getToken(token,":").c_str()) / 8;
 163       if (IntPrefAlignment == 0)
 164         IntPrefAlignment = IntABIAlignment;
 165       break;
 166     case 's':
 167       ShortABIAlignment = atoi(getToken(token, ":").c_str()) / 8;
 168       ShortPrefAlignment = atoi(getToken(token,":").c_str()) / 8;
 169       if (ShortPrefAlignment == 0)
 170         ShortPrefAlignment = ShortABIAlignment;
 171       break;
 172     case 'b':
 173       ByteABIAlignment = atoi(getToken(token, ":").c_str()) / 8;
 174       BytePrefAlignment = atoi(getToken(token,":").c_str()) / 8;
 175       if (BytePrefAlignment == 0)
 176         BytePrefAlignment = ByteABIAlignment;
 177       break;
 178     case 'B':
 179       BoolABIAlignment = atoi(getToken(token, ":").c_str()) / 8;
 180       BoolPrefAlignment = atoi(getToken(token,":").c_str()) / 8;
 181       if (BoolPrefAlignment == 0)
 182         BoolPrefAlignment = BoolABIAlignment;
 183       break;
 184     case 'A':
 185       AggMinPrefAlignment = atoi(getToken(token,":").c_str()) / 8;
 186       break;
 187     default:
 188       break;
 189     }
 190   }
 191
 192   // Unless explicitly specified, the alignments for longs and doubles is
 193   // capped by pointer size.
 194   if (LongABIAlignment == 0)
 195           LongABIAlignment = LongPrefAlignment = PointerMemSize;
 196   if (DoubleABIAlignment == 0)
 197     DoubleABIAlignment = DoublePrefAlignment = PointerMemSize;
 198 }
 199
 200 TargetData::TargetData(const Module *M) {
 201   init(M->getDataLayout());
 202 }
 203
 204 /// Layouts - The lazy cache of structure layout information maintained by
 205 /// TargetData.
 206 ///
 207 static std::map<std::pair<const TargetData*,const StructType*>,
 208                 StructLayout> *Layouts = 0;
 209
 210
 211 TargetData::~TargetData() {
 212   if (Layouts) {
 213     // Remove any layouts for this TD.
 214     std::map<std::pair<const TargetData*,
 215       const StructType*>, StructLayout>::iterator
 216       I = Layouts->lower_bound(std::make_pair(this, (const StructType*)0));
 217     while (I != Layouts->end() && I->first.first == this)
 218       Layouts->erase(I++);
 219     if (Layouts->empty()) {
 220       delete Layouts;
 221       Layouts = 0;
 222     }
 223   }
 224 }
 225
 226 std::string TargetData::getStringRepresentation() const {
 227   std::stringstream repr;
 228
 229   if (LittleEndian)
 230     repr << "e";
 231   else
 232     repr << "E";
 233
 234   repr << "-p:" << (PointerMemSize * 8) << ":" << (PointerABIAlignment * 8);
 235   repr << "-d:" << (DoubleABIAlignment * 8) << ":"
 236        << (DoublePrefAlignment * 8);
 237   repr << "-f:" << (FloatABIAlignment * 8) << ":"
 238        << (FloatPrefAlignment * 8);
 239   repr << "-l:" << (LongABIAlignment * 8) << ":"
 240        << (LongPrefAlignment * 8);
 241   repr << "-i:" << (IntABIAlignment * 8) << ":"
 242        << (IntPrefAlignment * 8);
 243   repr << "-s:" << (ShortABIAlignment * 8) << ":"
 244        << (ShortPrefAlignment * 8);
 245   repr << "-b:" << (ByteABIAlignment * 8) << ":"
 246        << (BytePrefAlignment * 8);
 247   repr << "-B:" << (BoolABIAlignment * 8) << ":"
 248        << (BoolPrefAlignment * 8);
 249   repr << "-A:" << (AggMinPrefAlignment * 8);
 250
 251   return repr.str();
 252 }
 253
 254 const StructLayout *TargetData::getStructLayout(const StructType *Ty) const {
 255   if (Layouts == 0)
 256     Layouts = new std::map<std::pair<const TargetData*,const StructType*>,
 257                            StructLayout>();
 258   std::map<std::pair<const TargetData*,const StructType*>,
 259                      StructLayout>::iterator
 260     I = Layouts->lower_bound(std::make_pair(this, Ty));
 261   if (I != Layouts->end() && I->first.first == this && I->first.second == Ty)
 262     return &I->second;
 263   else {
 264     return &Layouts->insert(I, std::make_pair(std::make_pair(this, Ty),
 265                                               StructLayout(Ty, *this)))->second;
 266   }
 267 }
 268
 269 /// InvalidateStructLayoutInfo - TargetData speculatively caches StructLayout
 270 /// objects.  If a TargetData object is alive when types are being refined and
 271 /// removed, this method must be called whenever a StructType is removed to
 272 /// avoid a dangling pointer in this cache.
 273 void TargetData::InvalidateStructLayoutInfo(const StructType *Ty) const {
 274   if (!Layouts) return;  // No cache.
 275
 276   std::map<std::pair<const TargetData*,const StructType*>,
 277            StructLayout>::iterator I = Layouts->find(std::make_pair(this, Ty));
 278   if (I != Layouts->end())
 279     Layouts->erase(I);
 280 }
 281
 282
 283
 284 static inline void getTypeInfoABI(const Type *Ty, const TargetData *TD,
 285                                   uint64_t &Size, unsigned char &Alignment) {
 286   assert(Ty->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
 287   switch (Ty->getTypeID()) {
 288   case Type::IntegerTyID: {
 289     unsigned BitWidth = cast<IntegerType>(Ty)->getBitWidth();
 290     if (BitWidth <= 8) {
 291       Size = 1; Alignment = TD->getByteABIAlignment();
 292     } else if (BitWidth <= 16) {
 293       Size = 2; Alignment = TD->getShortABIAlignment();
 294     } else if (BitWidth <= 32) {
 295       Size = 4; Alignment = TD->getIntABIAlignment();
 296     } else if (BitWidth <= 64) {
 297       Size = 8; Alignment = TD->getLongABIAlignment();
 298     } else
 299       assert(0 && "Integer types > 64 bits not supported.");
 300     return;
 301   }
 302   case Type::VoidTyID:   Size = 1; Alignment = TD->getByteABIAlignment(); return;
 303   case Type::FloatTyID:  Size = 4; Alignment = TD->getFloatABIAlignment(); return;
 304   case Type::DoubleTyID: Size = 8; Alignment = TD->getDoubleABIAlignment(); return;
 305   case Type::LabelTyID:
 306   case Type::PointerTyID:
 307     Size = TD->getPointerSize(); Alignment = TD->getPointerABIAlignment();
 308     return;
 309   case Type::ArrayTyID: {
 310     const ArrayType *ATy = cast<ArrayType>(Ty);
 311     getTypeInfoABI(ATy->getElementType(), TD, Size, Alignment);
 312     unsigned AlignedSize = (Size + Alignment - 1)/Alignment*Alignment;
 313     Size = AlignedSize*ATy->getNumElements();
 314     return;
 315   }
 316   case Type::PackedTyID: {
 317     const PackedType *PTy = cast<PackedType>(Ty);
 318     getTypeInfoABI(PTy->getElementType(), TD, Size, Alignment);
 319     unsigned AlignedSize = (Size + Alignment - 1)/Alignment*Alignment;
 320     Size = AlignedSize*PTy->getNumElements();
 321     // FIXME: The alignments of specific packed types are target dependent.
 322     // For now, just set it to be equal to Size.
 323     Alignment = Size;
 324     return;
 325   }
 326   case Type::StructTyID: {
 327     // Get the layout annotation... which is lazily created on demand.
 328     const StructLayout *Layout = TD->getStructLayout(cast<StructType>(Ty));
 329     Size = Layout->StructSize; Alignment = Layout->StructAlignment;
 330     return;
 331   }
 332
 333   default:
 334     assert(0 && "Bad type for getTypeInfo!!!");
 335     return;
 336   }
 337 }
 338
 339 static inline void getTypeInfoPref(const Type *Ty, const TargetData *TD,
 340                                    uint64_t &Size, unsigned char &Alignment) {
 341   assert(Ty->isSized() && "Cannot getTypeInfoPref() on a type that is unsized!");
 342   switch (Ty->getTypeID()) {
 343   case Type::IntegerTyID: {
 344     unsigned BitWidth = cast<IntegerType>(Ty)->getBitWidth();
 345     if (BitWidth <= 8) {
 346       Size = 1; Alignment = TD->getBytePrefAlignment();
 347     } else if (BitWidth <= 16) {
 348       Size = 2; Alignment = TD->getShortPrefAlignment();
 349     } else if (BitWidth <= 32) {
 350       Size = 4; Alignment = TD->getIntPrefAlignment();
 351     } else if (BitWidth <= 64) {
 352       Size = 8; Alignment = TD->getLongPrefAlignment();
 353     } else
 354       assert(0 && "Integer types > 64 bits not supported.");
 355     return;
 356   }
 357   case Type::VoidTyID:
 358     Size = 1; Alignment = TD->getBytePrefAlignment();
 359     return;
 360   case Type::FloatTyID:
 361     Size = 4; Alignment = TD->getFloatPrefAlignment();
 362     return;
 363   case Type::DoubleTyID:
 364     Size = 8; Alignment = TD->getDoublePrefAlignment();
 365     return;
 366   case Type::LabelTyID:
 367   case Type::PointerTyID:
 368     Size = TD->getPointerSize(); Alignment = TD->getPointerPrefAlignment();
 369     return;
 370   case Type::ArrayTyID: {
 371     const ArrayType *ATy = cast<ArrayType>(Ty);
 372     getTypeInfoPref(ATy->getElementType(), TD, Size, Alignment);
 373     unsigned AlignedSize = (Size + Alignment - 1)/Alignment*Alignment;
 374     Size = AlignedSize*ATy->getNumElements();
 375     return;
 376   }
 377   case Type::PackedTyID: {
 378     const PackedType *PTy = cast<PackedType>(Ty);
 379     getTypeInfoPref(PTy->getElementType(), TD, Size, Alignment);
 380     unsigned AlignedSize = (Size + Alignment - 1)/Alignment*Alignment;
 381     Size = AlignedSize*PTy->getNumElements();
 382     // FIXME: The alignments of specific packed types are target dependent.
 383     // For now, just set it to be equal to Size.
 384     Alignment = Size;
 385     return;
 386   }
 387   case Type::StructTyID: {
 388     // Get the layout annotation... which is lazily created on demand;
 389     // enforce minimum aggregate alignment.
 390     const StructLayout *Layout = TD->getStructLayout(cast<StructType>(Ty));
 391     Size = Layout->StructSize;
 392     Alignment = std::max(Layout->StructAlignment,
 393                          (const unsigned int) TD->getAggMinPrefAlignment());
 394     return;
 395   }
 396
 397   default:
 398     assert(0 && "Bad type for getTypeInfoPref!!!");
 399     return;
 400   }
 401 }
 402
 403
 404 uint64_t TargetData::getTypeSize(const Type *Ty) const {
 405   uint64_t Size;
 406   unsigned char Align;
 407   getTypeInfoABI(Ty, this, Size, Align);
 408   return Size;
 409 }
 410
 411 uint64_t TargetData::getTypeSizeInBits(const Type *Ty) const {
 412   if (Ty->isInteger())
 413     return cast<IntegerType>(Ty)->getBitWidth();
 414
 415   uint64_t Size;
 416   unsigned char Align;
 417   getTypeInfoABI(Ty, this, Size, Align);
 418   return Size * 8;
 419 }
 420
 421 unsigned char TargetData::getTypeAlignmentABI(const Type *Ty) const {
 422   uint64_t Size;
 423   unsigned char Align;
 424   getTypeInfoABI(Ty, this, Size, Align);
 425   return Align;
 426 }
 427
 428 unsigned char TargetData::getTypeAlignmentPref(const Type *Ty) const {
 429   uint64_t Size;
 430   unsigned char Align;
 431   getTypeInfoPref(Ty, this, Size, Align);
 432   return Align;
 433 }
 434
 435 unsigned char TargetData::getPreferredTypeAlignmentShift(const Type *Ty) const {
 436   unsigned Align = getTypeAlignmentPref(Ty);
 437   assert(!(Align & (Align-1)) && "Alignment is not a power of two!");
 438   return Log2_32(Align);
 439 }
 440
 441 /// getIntPtrType - Return an unsigned integer type that is the same size or
 442 /// greater to the host pointer size.
 443 const Type *TargetData::getIntPtrType() const {
 444   switch (getPointerSize()) {
 445   default: assert(0 && "Unknown pointer size!");
 446   case 2: return Type::Int16Ty;
 447   case 4: return Type::Int32Ty;
 448   case 8: return Type::Int64Ty;
 449   }
 450 }
 451
 452
 453 uint64_t TargetData::getIndexedOffset(const Type *ptrTy,
 454                                       const std::vector<Value*> &Idx) const {
 455   const Type *Ty = ptrTy;
 456   assert(isa<PointerType>(Ty) && "Illegal argument for getIndexedOffset()");
 457   uint64_t Result = 0;
 458
 459   generic_gep_type_iterator<std::vector<Value*>::const_iterator>
 460     TI = gep_type_begin(ptrTy, Idx.begin(), Idx.end());
 461   for (unsigned CurIDX = 0; CurIDX != Idx.size(); ++CurIDX, ++TI) {
 462     if (const StructType *STy = dyn_cast<StructType>(*TI)) {
 463       assert(Idx[CurIDX]->getType() == Type::Int32Ty && "Illegal struct idx");
 464       unsigned FieldNo = cast<ConstantInt>(Idx[CurIDX])->getZExtValue();
 465
 466       // Get structure layout information...
 467       const StructLayout *Layout = getStructLayout(STy);
 468
 469       // Add in the offset, as calculated by the structure layout info...
 470       assert(FieldNo < Layout->MemberOffsets.size() &&"FieldNo out of range!");
 471       Result += Layout->MemberOffsets[FieldNo];
 472
 473       // Update Ty to refer to current element
 474       Ty = STy->getElementType(FieldNo);
 475     } else {
 476       // Update Ty to refer to current element
 477       Ty = cast<SequentialType>(Ty)->getElementType();
 478
 479       // Get the array index and the size of each array element.
 480       int64_t arrayIdx = cast<ConstantInt>(Idx[CurIDX])->getSExtValue();
 481       Result += arrayIdx * (int64_t)getTypeSize(Ty);
 482     }
 483   }
 484
 485   return Result;
 486 }
 487
 488 /// getPreferredAlignmentLog - Return the preferred alignment of the
 489 /// specified global, returned in log form.  This includes an explicitly
 490 /// requested alignment (if the global has one).
 491 unsigned TargetData::getPreferredAlignmentLog(const GlobalVariable *GV) const {
 492   const Type *ElemType = GV->getType()->getElementType();
 493   unsigned Alignment = getPreferredTypeAlignmentShift(ElemType);
 494   if (GV->getAlignment() > (1U << Alignment))
 495     Alignment = Log2_32(GV->getAlignment());
 496
 497   if (GV->hasInitializer()) {
 498     // Always round up alignment of global doubles to 8 bytes.
 499     if (Alignment < 4) {
 500       // If the global is not external, see if it is large.  If so, give it a
 501       // larger alignment.
 502       if (getTypeSize(ElemType) > 128)
 503         Alignment = 4;    // 16-byte alignment.
 504     }
 505   }
 506   return Alignment;
 507 }
 508