include/llvm/Target/TargetData.h

   1 //===-- llvm/Target/TargetData.h - Data size & alignment info ---*- C++ -*-===//
   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.  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_TARGET_TARGETDATA_H
  21 #define LLVM_TARGET_TARGETDATA_H
  22
  23 #include "llvm/Pass.h"
  24 #include "Support/Annotation.h"
  25 #include "Support/DataTypes.h"
  26 #include <vector>
  27 class Value;
  28 class Type;
  29 class StructType;
  30 class StructLayout;
  31
  32 class TargetData : public ImmutablePass {
  33   bool          LittleEndian;          // Defaults to false
  34   unsigned char ByteAlignment;         // Defaults to 1 bytes
  35   unsigned char ShortAlignment;        // Defaults to 2 bytes
  36   unsigned char IntAlignment;          // Defaults to 4 bytes
  37   unsigned char LongAlignment;         // Defaults to 8 bytes
  38   unsigned char FloatAlignment;        // Defaults to 4 bytes
  39   unsigned char DoubleAlignment;       // Defaults to 8 bytes
  40   unsigned char PointerSize;           // Defaults to 8 bytes
  41   unsigned char PointerAlignment;      // Defaults to 8 bytes
  42   AnnotationID  AID;                   // AID for structure layout annotation
  43
  44   static Annotation *TypeAnFactory(AnnotationID, const Annotable *, void *);
  45 public:
  46   TargetData(const std::string &TargetName = "",
  47              bool LittleEndian = false,
  48              unsigned char PtrSize = 8,
  49              unsigned char PtrAl = 8, unsigned char DoubleAl = 8,
  50              unsigned char FloatAl = 4, unsigned char LongAl = 8,
  51              unsigned char IntAl = 4, unsigned char ShortAl = 2,
  52              unsigned char ByteAl = 1);
  53   TargetData(const std::string &ToolName, const Module *M);
  54   ~TargetData();  // Not virtual, do not subclass this class
  55
  56   /// Target endianness...
  57   bool          isLittleEndian()      const { return     LittleEndian; }
  58   bool          isBigEndian()         const { return    !LittleEndian; }
  59
  60   /// Target alignment constraints
  61   unsigned char getByteAlignment()    const { return    ByteAlignment; }
  62   unsigned char getShortAlignment()   const { return   ShortAlignment; }
  63   unsigned char getIntAlignment()     const { return     IntAlignment; }
  64   unsigned char getLongAlignment()    const { return    LongAlignment; }
  65   unsigned char getFloatAlignment()   const { return   FloatAlignment; }
  66   unsigned char getDoubleAlignment()  const { return  DoubleAlignment; }
  67   unsigned char getPointerAlignment() const { return PointerAlignment; }
  68   unsigned char getPointerSize()      const { return      PointerSize; }
  69   AnnotationID  getStructLayoutAID()  const { return AID; }
  70
  71   // getTypeSize - Return the number of bytes necessary to hold the specified
  72   // type
  73   uint64_t      getTypeSize     (const Type *Ty) const;
  74
  75   // getTypeAlignment - Return the minimum required alignment for the specified
  76   // type
  77   unsigned char getTypeAlignment(const Type *Ty) const;
  78
  79   // getIndexOffset - return the offset from the beginning of the type for the
  80   // specified indices.  This is used to implement getelementptr.
  81   //
  82   uint64_t      getIndexedOffset(const Type *Ty,
  83                                  const std::vector<Value*> &Indices) const;
  84
  85   inline const StructLayout *getStructLayout(const StructType *Ty) const {
  86     return (const StructLayout*)
  87          ((const Annotable*)Ty)->getOrCreateAnnotation(AID);
  88   }
  89 };
  90
  91 // This annotation (attached ONLY to StructType classes) is used to lazily
  92 // calculate structure layout information for a target machine, based on the
  93 // TargetData structure.
  94 //
  95 struct StructLayout : public Annotation {
  96   std::vector<uint64_t> MemberOffsets;
  97   uint64_t StructSize;
  98   unsigned StructAlignment;
  99 private:
 100   friend class TargetData;   // Only TargetData can create this class
 101   inline StructLayout(const StructType *ST, const TargetData &TD);
 102 };
 103
 104 #endif