include/llvm/IR/DataLayout.h

   1 //===--------- llvm/DataLayout.h - Data size & alignment info ---*- C++ -*-===//
   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 defines layout properties related to datatype size/offset/alignment
  11 // information.  It uses lazy annotations to cache information about how
  12 // structure types are laid out and used.
  13 //
  14 // This structure should be created once, filled in if the defaults are not
  15 // correct and then passed around by const&.  None of the members functions
  16 // require modification to the object.
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #ifndef LLVM_IR_DATALAYOUT_H
  21 #define LLVM_IR_DATALAYOUT_H
  22
  23 #include "llvm/ADT/DenseMap.h"
  24 #include "llvm/ADT/SmallVector.h"
  25 #include "llvm/IR/DerivedTypes.h"
  26 #include "llvm/IR/Type.h"
  27 #include "llvm/Pass.h"
  28 #include "llvm/Support/DataTypes.h"
  29
  30 namespace llvm {
  31
  32 class Value;
  33 class Type;
  34 class IntegerType;
  35 class StructType;
  36 class StructLayout;
  37 class Triple;
  38 class GlobalVariable;
  39 class LLVMContext;
  40 template<typename T>
  41 class ArrayRef;
  42
  43 /// Enum used to categorize the alignment types stored by LayoutAlignElem
  44 enum AlignTypeEnum {
  45   INVALID_ALIGN = 0,                 ///< An invalid alignment
  46   INTEGER_ALIGN = 'i',               ///< Integer type alignment
  47   VECTOR_ALIGN = 'v',                ///< Vector type alignment
  48   FLOAT_ALIGN = 'f',                 ///< Floating point type alignment
  49   AGGREGATE_ALIGN = 'a'              ///< Aggregate alignment
  50 };
  51
  52 /// Layout alignment element.
  53 ///
  54 /// Stores the alignment data associated with a given alignment type (integer,
  55 /// vector, float) and type bit width.
  56 ///
  57 /// @note The unusual order of elements in the structure attempts to reduce
  58 /// padding and make the structure slightly more cache friendly.
  59 struct LayoutAlignElem {
  60   unsigned AlignType    : 8;  ///< Alignment type (AlignTypeEnum)
  61   unsigned TypeBitWidth : 24; ///< Type bit width
  62   unsigned ABIAlign     : 16; ///< ABI alignment for this type/bitw
  63   unsigned PrefAlign    : 16; ///< Pref. alignment for this type/bitw
  64
  65   /// Initializer
  66   static LayoutAlignElem get(AlignTypeEnum align_type, unsigned abi_align,
  67                              unsigned pref_align, uint32_t bit_width);
  68   /// Equality predicate
  69   bool operator==(const LayoutAlignElem &rhs) const;
  70 };
  71
  72 /// Layout pointer alignment element.
  73 ///
  74 /// Stores the alignment data associated with a given pointer and address space.
  75 ///
  76 /// @note The unusual order of elements in the structure attempts to reduce
  77 /// padding and make the structure slightly more cache friendly.
  78 struct PointerAlignElem {
  79   unsigned            ABIAlign;       ///< ABI alignment for this type/bitw
  80   unsigned            PrefAlign;      ///< Pref. alignment for this type/bitw
  81   uint32_t            TypeByteWidth;  ///< Type byte width
  82   uint32_t            AddressSpace;   ///< Address space for the pointer type
  83
  84   /// Initializer
  85   static PointerAlignElem get(uint32_t AddressSpace, unsigned ABIAlign,
  86                              unsigned PrefAlign, uint32_t TypeByteWidth);
  87   /// Equality predicate
  88   bool operator==(const PointerAlignElem &rhs) const;
  89 };
  90
  91 /// This class holds a parsed version of the target data layout string in a
  92 /// module and provides methods for querying it. The target data layout string
  93 /// is specified *by the target* - a frontend generating LLVM IR is required to
  94 /// generate the right target data for the target being codegen'd to.
  95 class DataLayout {
  96 private:
  97   bool          LittleEndian;          ///< Defaults to false
  98   unsigned      StackNaturalAlign;     ///< Stack natural alignment
  99
 100   enum ManglingModeT {
 101     MM_None,
 102     MM_ELF,
 103     MM_MachO,
 104     MM_WINCOFF,
 105     MM_Mips
 106   };
 107   ManglingModeT ManglingMode;
 108
 109   SmallVector<unsigned char, 8> LegalIntWidths; ///< Legal Integers.
 110
 111   /// Alignments - Where the primitive type alignment data is stored.
 112   ///
 113   /// @sa reset().
 114   /// @note Could support multiple size pointer alignments, e.g., 32-bit
 115   /// pointers vs. 64-bit pointers by extending LayoutAlignment, but for now,
 116   /// we don't.
 117   SmallVector<LayoutAlignElem, 16> Alignments;
 118   typedef SmallVector<PointerAlignElem, 8> PointersTy;
 119   PointersTy Pointers;
 120
 121   PointersTy::const_iterator findPoiterLowerBound(uint32_t AddressSpace) const {
 122     return const_cast<DataLayout *>(this)->findPoiterLowerBound(AddressSpace);
 123   }
 124
 125   PointersTy::iterator findPoiterLowerBound(uint32_t AddressSpace);
 126
 127   /// InvalidAlignmentElem - This member is a signal that a requested alignment
 128   /// type and bit width were not found in the SmallVector.
 129   static const LayoutAlignElem InvalidAlignmentElem;
 130
 131   /// InvalidPointerElem - This member is a signal that a requested pointer
 132   /// type and bit width were not found in the DenseSet.
 133   static const PointerAlignElem InvalidPointerElem;
 134
 135   // The StructType -> StructLayout map.
 136   mutable void *LayoutMap;
 137
 138   //! Set/initialize target alignments
 139   void setAlignment(AlignTypeEnum align_type, unsigned abi_align,
 140                     unsigned pref_align, uint32_t bit_width);
 141   unsigned getAlignmentInfo(AlignTypeEnum align_type, uint32_t bit_width,
 142                             bool ABIAlign, Type *Ty) const;
 143
 144   //! Set/initialize pointer alignments
 145   void setPointerAlignment(uint32_t AddrSpace, unsigned ABIAlign,
 146                            unsigned PrefAlign, uint32_t TypeByteWidth);
 147
 148   //! Internal helper method that returns requested alignment for type.
 149   unsigned getAlignment(Type *Ty, bool abi_or_pref) const;
 150
 151   /// Valid alignment predicate.
 152   ///
 153   /// Predicate that tests a LayoutAlignElem reference returned by get() against
 154   /// InvalidAlignmentElem.
 155   bool validAlignment(const LayoutAlignElem &align) const {
 156     return &align != &InvalidAlignmentElem;
 157   }
 158
 159   /// Valid pointer predicate.
 160   ///
 161   /// Predicate that tests a PointerAlignElem reference returned by get() against
 162   /// InvalidPointerElem.
 163   bool validPointer(const PointerAlignElem &align) const {
 164     return &align != &InvalidPointerElem;
 165   }
 166
 167   /// Parses a target data specification string. Assert if the string is
 168   /// malformed.
 169   void parseSpecifier(StringRef LayoutDescription);
 170
 171   // Free all internal data structures.
 172   void clear();
 173
 174 public:
 175   /// Constructs a DataLayout from a specification string. See reset().
 176   explicit DataLayout(StringRef LayoutDescription) : LayoutMap(0) {
 177     reset(LayoutDescription);
 178   }
 179
 180   /// Initialize target data from properties stored in the module.
 181   explicit DataLayout(const Module *M);
 182
 183   DataLayout(const DataLayout &DL) : LayoutMap(0) { *this = DL; }
 184
 185   DataLayout &operator=(const DataLayout &DL) {
 186     clear();
 187     LittleEndian = DL.isLittleEndian();
 188     StackNaturalAlign = DL.StackNaturalAlign;
 189     ManglingMode = DL.ManglingMode;
 190     LegalIntWidths = DL.LegalIntWidths;
 191     Alignments = DL.Alignments;
 192     Pointers = DL.Pointers;
 193     return *this;
 194   }
 195
 196   bool operator==(const DataLayout &Other) const;
 197   bool operator!=(const DataLayout &Other) const { return !(*this == Other); }
 198
 199   ~DataLayout();  // Not virtual, do not subclass this class
 200
 201   /// Parse a data layout string (with fallback to default values).
 202   void reset(StringRef LayoutDescription);
 203
 204   /// Layout endianness...
 205   bool isLittleEndian() const { return LittleEndian; }
 206   bool isBigEndian() const { return !LittleEndian; }
 207
 208   /// getStringRepresentation - Return the string representation of the
 209   /// DataLayout.  This representation is in the same format accepted by the
 210   /// string constructor above.
 211   std::string getStringRepresentation() const;
 212
 213   /// isLegalInteger - This function returns true if the specified type is
 214   /// known to be a native integer type supported by the CPU.  For example,
 215   /// i64 is not native on most 32-bit CPUs and i37 is not native on any known
 216   /// one.  This returns false if the integer width is not legal.
 217   ///
 218   /// The width is specified in bits.
 219   ///
 220   bool isLegalInteger(unsigned Width) const {
 221     for (unsigned i = 0, e = (unsigned)LegalIntWidths.size(); i != e; ++i)
 222       if (LegalIntWidths[i] == Width)
 223         return true;
 224     return false;
 225   }
 226
 227   bool isIllegalInteger(unsigned Width) const {
 228     return !isLegalInteger(Width);
 229   }
 230
 231   /// Returns true if the given alignment exceeds the natural stack alignment.
 232   bool exceedsNaturalStackAlignment(unsigned Align) const {
 233     return (StackNaturalAlign != 0) && (Align > StackNaturalAlign);
 234   }
 235
 236   bool hasMicrosoftFastStdCallMangling() const {
 237     return ManglingMode == MM_WINCOFF;
 238   }
 239
 240   bool hasLinkerPrivateGlobalPrefix() const {
 241     return ManglingMode == MM_MachO;
 242   }
 243
 244   const char *getLinkerPrivateGlobalPrefix() const {
 245     if (ManglingMode == MM_MachO)
 246       return "l";
 247     return getPrivateGlobalPrefix();
 248   }
 249
 250   char getGlobalPrefix() const {
 251     switch (ManglingMode) {
 252     case MM_None:
 253     case MM_ELF:
 254     case MM_Mips:
 255       return '\0';
 256     case MM_MachO:
 257     case MM_WINCOFF:
 258       return '_';
 259     }
 260     llvm_unreachable("invalid mangling mode");
 261   }
 262
 263   const char *getPrivateGlobalPrefix() const {
 264     switch (ManglingMode) {
 265     case MM_None:
 266       return "";
 267     case MM_ELF:
 268       return ".L";
 269     case MM_Mips:
 270       return "$";
 271     case MM_MachO:
 272     case MM_WINCOFF:
 273       return "L";
 274     }
 275     llvm_unreachable("invalid mangling mode");
 276   }
 277
 278   static const char *getManglingComponent(const Triple &T);
 279
 280   /// fitsInLegalInteger - This function returns true if the specified type fits
 281   /// in a native integer type supported by the CPU.  For example, if the CPU
 282   /// only supports i32 as a native integer type, then i27 fits in a legal
 283   // integer type but i45 does not.
 284   bool fitsInLegalInteger(unsigned Width) const {
 285     for (unsigned i = 0, e = (unsigned)LegalIntWidths.size(); i != e; ++i)
 286       if (Width <= LegalIntWidths[i])
 287         return true;
 288     return false;
 289   }
 290
 291   /// Layout pointer alignment
 292   /// FIXME: The defaults need to be removed once all of
 293   /// the backends/clients are updated.
 294   unsigned getPointerABIAlignment(unsigned AS = 0) const;
 295
 296   /// Return target's alignment for stack-based pointers
 297   /// FIXME: The defaults need to be removed once all of
 298   /// the backends/clients are updated.
 299   unsigned getPointerPrefAlignment(unsigned AS = 0) const;
 300
 301   /// Layout pointer size
 302   /// FIXME: The defaults need to be removed once all of
 303   /// the backends/clients are updated.
 304   unsigned getPointerSize(unsigned AS = 0) const;
 305
 306   /// Layout pointer size, in bits
 307   /// FIXME: The defaults need to be removed once all of
 308   /// the backends/clients are updated.
 309   unsigned getPointerSizeInBits(unsigned AS = 0) const {
 310     return getPointerSize(AS) * 8;
 311   }
 312
 313   /// Layout pointer size, in bits, based on the type.  If this function is
 314   /// called with a pointer type, then the type size of the pointer is returned.
 315   /// If this function is called with a vector of pointers, then the type size
 316   /// of the pointer is returned.  This should only be called with a pointer or
 317   /// vector of pointers.
 318   unsigned getPointerTypeSizeInBits(Type *) const;
 319
 320   unsigned getPointerTypeSize(Type *Ty) const {
 321     return getPointerTypeSizeInBits(Ty) / 8;
 322   }
 323
 324   /// Size examples:
 325   ///
 326   /// Type        SizeInBits  StoreSizeInBits  AllocSizeInBits[*]
 327   /// ----        ----------  ---------------  ---------------
 328   ///  i1            1           8                8
 329   ///  i8            8           8                8
 330   ///  i19          19          24               32
 331   ///  i32          32          32               32
 332   ///  i100        100         104              128
 333   ///  i128        128         128              128
 334   ///  Float        32          32               32
 335   ///  Double       64          64               64
 336   ///  X86_FP80     80          80               96
 337   ///
 338   /// [*] The alloc size depends on the alignment, and thus on the target.
 339   ///     These values are for x86-32 linux.
 340
 341   /// getTypeSizeInBits - Return the number of bits necessary to hold the
 342   /// specified type.  For example, returns 36 for i36 and 80 for x86_fp80.
 343   /// The type passed must have a size (Type::isSized() must return true).
 344   uint64_t getTypeSizeInBits(Type *Ty) const;
 345
 346   /// getTypeStoreSize - Return the maximum number of bytes that may be
 347   /// overwritten by storing the specified type.  For example, returns 5
 348   /// for i36 and 10 for x86_fp80.
 349   uint64_t getTypeStoreSize(Type *Ty) const {
 350     return (getTypeSizeInBits(Ty)+7)/8;
 351   }
 352
 353   /// getTypeStoreSizeInBits - Return the maximum number of bits that may be
 354   /// overwritten by storing the specified type; always a multiple of 8.  For
 355   /// example, returns 40 for i36 and 80 for x86_fp80.
 356   uint64_t getTypeStoreSizeInBits(Type *Ty) const {
 357     return 8*getTypeStoreSize(Ty);
 358   }
 359
 360   /// getTypeAllocSize - Return the offset in bytes between successive objects
 361   /// of the specified type, including alignment padding.  This is the amount
 362   /// that alloca reserves for this type.  For example, returns 12 or 16 for
 363   /// x86_fp80, depending on alignment.
 364   uint64_t getTypeAllocSize(Type *Ty) const {
 365     // Round up to the next alignment boundary.
 366     return RoundUpAlignment(getTypeStoreSize(Ty), getABITypeAlignment(Ty));
 367   }
 368
 369   /// getTypeAllocSizeInBits - Return the offset in bits between successive
 370   /// objects of the specified type, including alignment padding; always a
 371   /// multiple of 8.  This is the amount that alloca reserves for this type.
 372   /// For example, returns 96 or 128 for x86_fp80, depending on alignment.
 373   uint64_t getTypeAllocSizeInBits(Type *Ty) const {
 374     return 8*getTypeAllocSize(Ty);
 375   }
 376
 377   /// getABITypeAlignment - Return the minimum ABI-required alignment for the
 378   /// specified type.
 379   unsigned getABITypeAlignment(Type *Ty) const;
 380
 381   /// getABIIntegerTypeAlignment - Return the minimum ABI-required alignment for
 382   /// an integer type of the specified bitwidth.
 383   unsigned getABIIntegerTypeAlignment(unsigned BitWidth) const;
 384
 385   /// getPrefTypeAlignment - Return the preferred stack/global alignment for
 386   /// the specified type.  This is always at least as good as the ABI alignment.
 387   unsigned getPrefTypeAlignment(Type *Ty) const;
 388
 389   /// getPreferredTypeAlignmentShift - Return the preferred alignment for the
 390   /// specified type, returned as log2 of the value (a shift amount).
 391   unsigned getPreferredTypeAlignmentShift(Type *Ty) const;
 392
 393   /// getIntPtrType - Return an integer type with size at least as big as that
 394   /// of a pointer in the given address space.
 395   IntegerType *getIntPtrType(LLVMContext &C, unsigned AddressSpace = 0) const;
 396
 397   /// getIntPtrType - Return an integer (vector of integer) type with size at
 398   /// least as big as that of a pointer of the given pointer (vector of pointer)
 399   /// type.
 400   Type *getIntPtrType(Type *) const;
 401
 402   /// getSmallestLegalIntType - Return the smallest integer type with size at
 403   /// least as big as Width bits.
 404   Type *getSmallestLegalIntType(LLVMContext &C, unsigned Width = 0) const;
 405
 406   /// getLargestLegalIntType - Return the largest legal integer type, or null if
 407   /// none are set.
 408   Type *getLargestLegalIntType(LLVMContext &C) const {
 409     unsigned LargestSize = getLargestLegalIntTypeSize();
 410     return (LargestSize == 0) ? 0 : Type::getIntNTy(C, LargestSize);
 411   }
 412
 413   /// getLargestLegalIntType - Return the size of largest legal integer type
 414   /// size, or 0 if none are set.
 415   unsigned getLargestLegalIntTypeSize() const;
 416
 417   /// getIndexedOffset - return the offset from the beginning of the type for
 418   /// the specified indices.  This is used to implement getelementptr.
 419   uint64_t getIndexedOffset(Type *Ty, ArrayRef<Value *> Indices) const;
 420
 421   /// getStructLayout - Return a StructLayout object, indicating the alignment
 422   /// of the struct, its size, and the offsets of its fields.  Note that this
 423   /// information is lazily cached.
 424   const StructLayout *getStructLayout(StructType *Ty) const;
 425
 426   /// getPreferredAlignment - Return the preferred alignment of the specified
 427   /// global.  This includes an explicitly requested alignment (if the global
 428   /// has one).
 429   unsigned getPreferredAlignment(const GlobalVariable *GV) const;
 430
 431   /// getPreferredAlignmentLog - Return the preferred alignment of the
 432   /// specified global, returned in log form.  This includes an explicitly
 433   /// requested alignment (if the global has one).
 434   unsigned getPreferredAlignmentLog(const GlobalVariable *GV) const;
 435
 436   /// RoundUpAlignment - Round the specified value up to the next alignment
 437   /// boundary specified by Alignment.  For example, 7 rounded up to an
 438   /// alignment boundary of 4 is 8.  8 rounded up to the alignment boundary of 4
 439   /// is 8 because it is already aligned.
 440   template <typename UIntTy>
 441   static UIntTy RoundUpAlignment(UIntTy Val, unsigned Alignment) {
 442     assert((Alignment & (Alignment-1)) == 0 && "Alignment must be power of 2!");
 443     return (Val + (Alignment-1)) & ~UIntTy(Alignment-1);
 444   }
 445 };
 446
 447 class DataLayoutPass : public ImmutablePass {
 448   DataLayout DL;
 449
 450 public:
 451   /// This has to exist, because this is a pass, but it should never be used.
 452   DataLayoutPass();
 453   ~DataLayoutPass();
 454
 455   const DataLayout &getDataLayout() const { return DL; }
 456
 457   // For use with the C API. C++ code should always use the constructor that
 458   // takes a module.
 459   explicit DataLayoutPass(const DataLayout &DL);
 460
 461   explicit DataLayoutPass(const Module *M);
 462
 463   static char ID; // Pass identification, replacement for typeid
 464 };
 465
 466 /// StructLayout - used to lazily calculate structure layout information for a
 467 /// target machine, based on the DataLayout structure.
 468 ///
 469 class StructLayout {
 470   uint64_t StructSize;
 471   unsigned StructAlignment;
 472   unsigned NumElements;
 473   uint64_t MemberOffsets[1];  // variable sized array!
 474 public:
 475
 476   uint64_t getSizeInBytes() const {
 477     return StructSize;
 478   }
 479
 480   uint64_t getSizeInBits() const {
 481     return 8*StructSize;
 482   }
 483
 484   unsigned getAlignment() const {
 485     return StructAlignment;
 486   }
 487
 488   /// getElementContainingOffset - Given a valid byte offset into the structure,
 489   /// return the structure index that contains it.
 490   ///
 491   unsigned getElementContainingOffset(uint64_t Offset) const;
 492
 493   uint64_t getElementOffset(unsigned Idx) const {
 494     assert(Idx < NumElements && "Invalid element idx!");
 495     return MemberOffsets[Idx];
 496   }
 497
 498   uint64_t getElementOffsetInBits(unsigned Idx) const {
 499     return getElementOffset(Idx)*8;
 500   }
 501
 502 private:
 503   friend class DataLayout;   // Only DataLayout can create this class
 504   StructLayout(StructType *ST, const DataLayout &DL);
 505 };
 506
 507
 508 // The implementation of this method is provided inline as it is particularly
 509 // well suited to constant folding when called on a specific Type subclass.
 510 inline uint64_t DataLayout::getTypeSizeInBits(Type *Ty) const {
 511   assert(Ty->isSized() && "Cannot getTypeInfo() on a type that is unsized!");
 512   switch (Ty->getTypeID()) {
 513   case Type::LabelTyID:
 514     return getPointerSizeInBits(0);
 515   case Type::PointerTyID:
 516     return getPointerSizeInBits(Ty->getPointerAddressSpace());
 517   case Type::ArrayTyID: {
 518     ArrayType *ATy = cast<ArrayType>(Ty);
 519     return ATy->getNumElements() *
 520            getTypeAllocSizeInBits(ATy->getElementType());
 521   }
 522   case Type::StructTyID:
 523     // Get the layout annotation... which is lazily created on demand.
 524     return getStructLayout(cast<StructType>(Ty))->getSizeInBits();
 525   case Type::IntegerTyID:
 526     return Ty->getIntegerBitWidth();
 527   case Type::HalfTyID:
 528     return 16;
 529   case Type::FloatTyID:
 530     return 32;
 531   case Type::DoubleTyID:
 532   case Type::X86_MMXTyID:
 533     return 64;
 534   case Type::PPC_FP128TyID:
 535   case Type::FP128TyID:
 536     return 128;
 537     // In memory objects this is always aligned to a higher boundary, but
 538   // only 80 bits contain information.
 539   case Type::X86_FP80TyID:
 540     return 80;
 541   case Type::VectorTyID: {
 542     VectorType *VTy = cast<VectorType>(Ty);
 543     return VTy->getNumElements() * getTypeSizeInBits(VTy->getElementType());
 544   }
 545   default:
 546     llvm_unreachable("DataLayout::getTypeSizeInBits(): Unsupported type");
 547   }
 548 }
 549
 550 } // End llvm namespace
 551
 552 #endif