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