include/llvm/Support/TypeBuilder.h

   1 //===---- llvm/Support/TypeBuilder.h - Builder for LLVM types ---*- 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 the TypeBuilder class, which is used as a convenient way to
  11 // create LLVM types with a consistent and simplified interface.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_SUPPORT_TYPEBUILDER_H
  16 #define LLVM_SUPPORT_TYPEBUILDER_H
  17
  18 #include "llvm/DerivedTypes.h"
  19 #include "llvm/LLVMContext.h"
  20 #include <limits.h>
  21
  22 namespace llvm {
  23
  24 /// TypeBuilder - This provides a uniform API for looking up types
  25 /// known at compile time.  To support cross-compilation, we define a
  26 /// series of tag types in the llvm::types namespace, like i<N>,
  27 /// ieee_float, ppc_fp128, etc.  TypeBuilder<T, false> allows T to be
  28 /// any of these, a native C type (whose size may depend on the host
  29 /// compiler), or a pointer, function, or struct type built out of
  30 /// these.  TypeBuilder<T, true> removes native C types from this set
  31 /// to guarantee that its result is suitable for cross-compilation.
  32 /// We define the primitive types, pointer types, and functions up to
  33 /// 5 arguments here, but to use this class with your own types,
  34 /// you'll need to specialize it.  For example, say you want to call a
  35 /// function defined externally as:
  36 ///
  37 ///   struct MyType {
  38 ///     int32 a;
  39 ///     int32 *b;
  40 ///     void *array[1];  // Intended as a flexible array.
  41 ///   };
  42 ///   int8 AFunction(struct MyType *value);
  43 ///
  44 /// You'll want to use
  45 ///   Function::Create(TypeBuilder<types::i<8>(MyType*), true>::get(), ...)
  46 /// to declare the function, but when you first try this, your compiler will
  47 /// complain that TypeBuilder<MyType, true>::get() doesn't exist. To fix this,
  48 /// write:
  49 ///
  50 ///   namespace llvm {
  51 ///   template<bool xcompile> class TypeBuilder<MyType, xcompile> {
  52 ///   public:
  53 ///     static const StructType *get(LLVMContext &Context) {
  54 ///       // If you cache this result, be sure to cache it separately
  55 ///       // for each LLVMContext.
  56 ///       return StructType::get(
  57 ///         TypeBuilder<types::i<32>, xcompile>::get(Context),
  58 ///         TypeBuilder<types::i<32>*, xcompile>::get(Context),
  59 ///         TypeBuilder<types::i<8>*[], xcompile>::get(Context),
  60 ///         NULL);
  61 ///     }
  62 ///
  63 ///     // You may find this a convenient place to put some constants
  64 ///     // to help with getelementptr.  They don't have any effect on
  65 ///     // the operation of TypeBuilder.
  66 ///     enum Fields {
  67 ///       FIELD_A,
  68 ///       FIELD_B,
  69 ///       FIELD_ARRAY
  70 ///     };
  71 ///   }
  72 ///   }  // namespace llvm
  73 ///
  74 /// TypeBuilder cannot handle recursive types or types you only know at runtime.
  75 /// If you try to give it a recursive type, it will deadlock, infinitely
  76 /// recurse, or throw a recursive_init exception.
  77 template<typename T, bool cross_compilable> class TypeBuilder {};
  78
  79 // Types for use with cross-compilable TypeBuilders.  These correspond
  80 // exactly with an LLVM-native type.
  81 namespace types {
  82 /// i<N> corresponds to the LLVM IntegerType with N bits.
  83 template<uint32_t num_bits> class i {};
  84
  85 // The following classes represent the LLVM floating types.
  86 class ieee_float {};
  87 class ieee_double {};
  88 class x86_fp80 {};
  89 class fp128 {};
  90 class ppc_fp128 {};
  91 }  // namespace types
  92
  93 // LLVM doesn't have const or volatile types.
  94 template<typename T, bool cross> class TypeBuilder<const T, cross>
  95   : public TypeBuilder<T, cross> {};
  96 template<typename T, bool cross> class TypeBuilder<volatile T, cross>
  97   : public TypeBuilder<T, cross> {};
  98 template<typename T, bool cross> class TypeBuilder<const volatile T, cross>
  99   : public TypeBuilder<T, cross> {};
 100
 101 // Pointers
 102 template<typename T, bool cross> class TypeBuilder<T*, cross> {
 103 public:
 104   static const PointerType *get(LLVMContext &Context) {
 105     return PointerType::getUnqual(TypeBuilder<T,cross>::get(Context));
 106   }
 107 };
 108
 109 /// There is no support for references
 110 template<typename T, bool cross> class TypeBuilder<T&, cross> {};
 111
 112 // Arrays
 113 template<typename T, size_t N, bool cross> class TypeBuilder<T[N], cross> {
 114 public:
 115   static const ArrayType *get(LLVMContext &Context) {
 116     return ArrayType::get(TypeBuilder<T, cross>::get(Context), N);
 117   }
 118 };
 119 /// LLVM uses an array of length 0 to represent an unknown-length array.
 120 template<typename T, bool cross> class TypeBuilder<T[], cross> {
 121 public:
 122   static const ArrayType *get(LLVMContext &Context) {
 123     return ArrayType::get(TypeBuilder<T, cross>::get(Context), 0);
 124   }
 125 };
 126
 127 // Define the C integral types only for TypeBuilder<T, false>.
 128 //
 129 // C integral types do not have a defined size. It would be nice to use the
 130 // stdint.h-defined typedefs that do have defined sizes, but we'd run into the
 131 // following problem:
 132 //
 133 // On an ILP32 machine, stdint.h might define:
 134 //
 135 //   typedef int int32_t;
 136 //   typedef long long int64_t;
 137 //   typedef long size_t;
 138 //
 139 // If we defined TypeBuilder<int32_t> and TypeBuilder<int64_t>, then any use of
 140 // TypeBuilder<size_t> would fail.  We couldn't define TypeBuilder<size_t> in
 141 // addition to the defined-size types because we'd get duplicate definitions on
 142 // platforms where stdint.h instead defines:
 143 //
 144 //   typedef int int32_t;
 145 //   typedef long long int64_t;
 146 //   typedef int size_t;
 147 //
 148 // So we define all the primitive C types and nothing else.
 149 #define DEFINE_INTEGRAL_TYPEBUILDER(T) \
 150 template<> class TypeBuilder<T, false> { \
 151 public: \
 152   static const IntegerType *get(LLVMContext &Context) { \
 153     return IntegerType::get(Context, sizeof(T) * CHAR_BIT); \
 154   } \
 155 }; \
 156 template<> class TypeBuilder<T, true> { \
 157   /* We provide a definition here so users don't accidentally */ \
 158   /* define these types to work. */ \
 159 }
 160 DEFINE_INTEGRAL_TYPEBUILDER(char);
 161 DEFINE_INTEGRAL_TYPEBUILDER(signed char);
 162 DEFINE_INTEGRAL_TYPEBUILDER(unsigned char);
 163 DEFINE_INTEGRAL_TYPEBUILDER(short);
 164 DEFINE_INTEGRAL_TYPEBUILDER(unsigned short);
 165 DEFINE_INTEGRAL_TYPEBUILDER(int);
 166 DEFINE_INTEGRAL_TYPEBUILDER(unsigned int);
 167 DEFINE_INTEGRAL_TYPEBUILDER(long);
 168 DEFINE_INTEGRAL_TYPEBUILDER(unsigned long);
 169 #ifdef _MSC_VER
 170 DEFINE_INTEGRAL_TYPEBUILDER(__int64);
 171 DEFINE_INTEGRAL_TYPEBUILDER(unsigned __int64);
 172 #else /* _MSC_VER */
 173 DEFINE_INTEGRAL_TYPEBUILDER(long long);
 174 DEFINE_INTEGRAL_TYPEBUILDER(unsigned long long);
 175 #endif /* _MSC_VER */
 176 #undef DEFINE_INTEGRAL_TYPEBUILDER
 177
 178 template<uint32_t num_bits, bool cross>
 179 class TypeBuilder<types::i<num_bits>, cross> {
 180 public:
 181   static const IntegerType *get(LLVMContext &C) {
 182     return IntegerType::get(C, num_bits);
 183   }
 184 };
 185
 186 template<> class TypeBuilder<float, false> {
 187 public:
 188   static const Type *get(LLVMContext& C) {
 189     return Type::getFloatTy(C);
 190   }
 191 };
 192 template<> class TypeBuilder<float, true> {};
 193
 194 template<> class TypeBuilder<double, false> {
 195 public:
 196   static const Type *get(LLVMContext& C) {
 197     return Type::getDoubleTy(C);
 198   }
 199 };
 200 template<> class TypeBuilder<double, true> {};
 201
 202 template<bool cross> class TypeBuilder<types::ieee_float, cross> {
 203 public:
 204   static const Type *get(LLVMContext& C) { return Type::getFloatTy(C); }
 205 };
 206 template<bool cross> class TypeBuilder<types::ieee_double, cross> {
 207 public:
 208   static const Type *get(LLVMContext& C) { return Type::getDoubleTy(C); }
 209 };
 210 template<bool cross> class TypeBuilder<types::x86_fp80, cross> {
 211 public:
 212   static const Type *get(LLVMContext& C) { return Type::getX86_FP80Ty(C); }
 213 };
 214 template<bool cross> class TypeBuilder<types::fp128, cross> {
 215 public:
 216   static const Type *get(LLVMContext& C) { return Type::getFP128Ty(C); }
 217 };
 218 template<bool cross> class TypeBuilder<types::ppc_fp128, cross> {
 219 public:
 220   static const Type *get(LLVMContext& C) { return Type::getPPC_FP128Ty(C); }
 221 };
 222
 223 template<bool cross> class TypeBuilder<void, cross> {
 224 public:
 225   static const Type *get(LLVMContext &C) {
 226     return Type::getVoidTy(C);
 227   }
 228 };
 229
 230 /// void* is disallowed in LLVM types, but it occurs often enough in C code that
 231 /// we special case it.
 232 template<> class TypeBuilder<void*, false>
 233   : public TypeBuilder<types::i<8>*, false> {};
 234
 235 template<typename R, bool cross> class TypeBuilder<R(), cross> {
 236 public:
 237   static const FunctionType *get(LLVMContext &Context) {
 238     return FunctionType::get(TypeBuilder<R, cross>::get(Context), false);
 239   }
 240 };
 241 template<typename R, typename A1, bool cross> class TypeBuilder<R(A1), cross> {
 242 public:
 243   static const FunctionType *get(LLVMContext &Context) {
 244     std::vector<const Type*> params;
 245     params.reserve(1);
 246     params.push_back(TypeBuilder<A1, cross>::get(Context));
 247     return FunctionType::get(TypeBuilder<R, cross>::get(Context),
 248                              params, false);
 249   }
 250 };
 251 template<typename R, typename A1, typename A2, bool cross>
 252 class TypeBuilder<R(A1, A2), cross> {
 253 public:
 254   static const FunctionType *get(LLVMContext &Context) {
 255     std::vector<const Type*> params;
 256     params.reserve(2);
 257     params.push_back(TypeBuilder<A1, cross>::get(Context));
 258     params.push_back(TypeBuilder<A2, cross>::get(Context));
 259     return FunctionType::get(TypeBuilder<R, cross>::get(Context),
 260                              params, false);
 261   }
 262 };
 263 template<typename R, typename A1, typename A2, typename A3, bool cross>
 264 class TypeBuilder<R(A1, A2, A3), cross> {
 265 public:
 266   static const FunctionType *get(LLVMContext &Context) {
 267     std::vector<const Type*> params;
 268     params.reserve(3);
 269     params.push_back(TypeBuilder<A1, cross>::get(Context));
 270     params.push_back(TypeBuilder<A2, cross>::get(Context));
 271     params.push_back(TypeBuilder<A3, cross>::get(Context));
 272     return FunctionType::get(TypeBuilder<R, cross>::get(Context),
 273                              params, false);
 274   }
 275 };
 276
 277 template<typename R, typename A1, typename A2, typename A3, typename A4,
 278          bool cross>
 279 class TypeBuilder<R(A1, A2, A3, A4), cross> {
 280 public:
 281   static const FunctionType *get(LLVMContext &Context) {
 282     std::vector<const Type*> params;
 283     params.reserve(4);
 284     params.push_back(TypeBuilder<A1, cross>::get(Context));
 285     params.push_back(TypeBuilder<A2, cross>::get(Context));
 286     params.push_back(TypeBuilder<A3, cross>::get(Context));
 287     params.push_back(TypeBuilder<A4, cross>::get(Context));
 288     return FunctionType::get(TypeBuilder<R, cross>::get(Context),
 289                              params, false);
 290   }
 291 };
 292
 293 template<typename R, typename A1, typename A2, typename A3, typename A4,
 294          typename A5, bool cross>
 295 class TypeBuilder<R(A1, A2, A3, A4, A5), cross> {
 296 public:
 297   static const FunctionType *get(LLVMContext &Context) {
 298     std::vector<const Type*> params;
 299     params.reserve(5);
 300     params.push_back(TypeBuilder<A1, cross>::get(Context));
 301     params.push_back(TypeBuilder<A2, cross>::get(Context));
 302     params.push_back(TypeBuilder<A3, cross>::get(Context));
 303     params.push_back(TypeBuilder<A4, cross>::get(Context));
 304     params.push_back(TypeBuilder<A5, cross>::get(Context));
 305     return FunctionType::get(TypeBuilder<R, cross>::get(Context),
 306                              params, false);
 307   }
 308 };
 309
 310 template<typename R, bool cross> class TypeBuilder<R(...), cross> {
 311 public:
 312   static const FunctionType *get(LLVMContext &Context) {
 313     return FunctionType::get(TypeBuilder<R, cross>::get(Context), true);
 314   }
 315 };
 316 template<typename R, typename A1, bool cross>
 317 class TypeBuilder<R(A1, ...), cross> {
 318 public:
 319   static const FunctionType *get(LLVMContext &Context) {
 320     std::vector<const Type*> params;
 321     params.reserve(1);
 322     params.push_back(TypeBuilder<A1, cross>::get(Context));
 323     return FunctionType::get(TypeBuilder<R, cross>::get(Context), params, true);
 324   }
 325 };
 326 template<typename R, typename A1, typename A2, bool cross>
 327 class TypeBuilder<R(A1, A2, ...), cross> {
 328 public:
 329   static const FunctionType *get(LLVMContext &Context) {
 330     std::vector<const Type*> params;
 331     params.reserve(2);
 332     params.push_back(TypeBuilder<A1, cross>::get(Context));
 333     params.push_back(TypeBuilder<A2, cross>::get(Context));
 334     return FunctionType::get(TypeBuilder<R, cross>::get(Context),
 335                                    params, true);
 336   }
 337 };
 338 template<typename R, typename A1, typename A2, typename A3, bool cross>
 339 class TypeBuilder<R(A1, A2, A3, ...), cross> {
 340 public:
 341   static const FunctionType *get(LLVMContext &Context) {
 342     std::vector<const Type*> params;
 343     params.reserve(3);
 344     params.push_back(TypeBuilder<A1, cross>::get(Context));
 345     params.push_back(TypeBuilder<A2, cross>::get(Context));
 346     params.push_back(TypeBuilder<A3, cross>::get(Context));
 347     return FunctionType::get(TypeBuilder<R, cross>::get(Context),
 348                                    params, true);
 349   }
 350 };
 351
 352 template<typename R, typename A1, typename A2, typename A3, typename A4,
 353          bool cross>
 354 class TypeBuilder<R(A1, A2, A3, A4, ...), cross> {
 355 public:
 356   static const FunctionType *get(LLVMContext &Context) {
 357     std::vector<const Type*> params;
 358     params.reserve(4);
 359     params.push_back(TypeBuilder<A1, cross>::get(Context));
 360     params.push_back(TypeBuilder<A2, cross>::get(Context));
 361     params.push_back(TypeBuilder<A3, cross>::get(Context));
 362     params.push_back(TypeBuilder<A4, cross>::get(Context));
 363     return FunctionType::get(TypeBuilder<R, cross>::get(Context),
 364                              params, true);
 365   }
 366 };
 367
 368 template<typename R, typename A1, typename A2, typename A3, typename A4,
 369          typename A5, bool cross>
 370 class TypeBuilder<R(A1, A2, A3, A4, A5, ...), cross> {
 371 public:
 372   static const FunctionType *get(LLVMContext &Context) {
 373     std::vector<const Type*> params;
 374     params.reserve(5);
 375     params.push_back(TypeBuilder<A1, cross>::get(Context));
 376     params.push_back(TypeBuilder<A2, cross>::get(Context));
 377     params.push_back(TypeBuilder<A3, cross>::get(Context));
 378     params.push_back(TypeBuilder<A4, cross>::get(Context));
 379     params.push_back(TypeBuilder<A5, cross>::get(Context));
 380     return FunctionType::get(TypeBuilder<R, cross>::get(Context),
 381                                    params, true);
 382   }
 383 };
 384
 385 }  // namespace llvm
 386
 387 #endif