1 //===---- llvm/Support/TypeBuilder.h - Builder for LLVM types ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_SUPPORT_TYPEBUILDER_H
16 #define LLVM_SUPPORT_TYPEBUILDER_H
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/LLVMContext.h"
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:
40 /// void *array[1]; // Intended as a flexible array.
42 /// int8 AFunction(struct MyType *value);
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,
51 /// template<bool xcompile> class TypeBuilder<MyType, xcompile> {
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),
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.
72 /// } // namespace llvm
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 {};
79 // Types for use with cross-compilable TypeBuilders. These correspond
80 // exactly with an LLVM-native type.
82 /// i<N> corresponds to the LLVM IntegerType with N bits.
83 template<uint32_t num_bits> class i {};
85 // The following classes represent the LLVM floating types.
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> {};
102 template<typename T, bool cross> class TypeBuilder<T*, cross> {
104 static const PointerType *get(LLVMContext &Context) {
105 return PointerType::getUnqual(TypeBuilder<T,cross>::get(Context));
109 /// There is no support for references
110 template<typename T, bool cross> class TypeBuilder<T&, cross> {};
113 template<typename T, size_t N, bool cross> class TypeBuilder<T[N], cross> {
115 static const ArrayType *get(LLVMContext &Context) {
116 return ArrayType::get(TypeBuilder<T, cross>::get(Context), N);
119 /// LLVM uses an array of length 0 to represent an unknown-length array.
120 template<typename T, bool cross> class TypeBuilder<T[], cross> {
122 static const ArrayType *get(LLVMContext &Context) {
123 return ArrayType::get(TypeBuilder<T, cross>::get(Context), 0);
127 // Define the C integral types only for TypeBuilder<T, false>.
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:
133 // On an ILP32 machine, stdint.h might define:
135 // typedef int int32_t;
136 // typedef long long int64_t;
137 // typedef long size_t;
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:
144 // typedef int int32_t;
145 // typedef long long int64_t;
146 // typedef int size_t;
148 // So we define all the primitive C types and nothing else.
149 #define DEFINE_INTEGRAL_TYPEBUILDER(T) \
150 template<> class TypeBuilder<T, false> { \
152 static const IntegerType *get(LLVMContext &Context) { \
153 return IntegerType::get(Context, sizeof(T) * CHAR_BIT); \
156 template<> class TypeBuilder<T, true> { \
157 /* We provide a definition here so users don't accidentally */ \
158 /* define these types to work. */ \
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);
170 DEFINE_INTEGRAL_TYPEBUILDER(__int64);
171 DEFINE_INTEGRAL_TYPEBUILDER(unsigned __int64);
173 DEFINE_INTEGRAL_TYPEBUILDER(long long);
174 DEFINE_INTEGRAL_TYPEBUILDER(unsigned long long);
175 #endif /* _MSC_VER */
176 #undef DEFINE_INTEGRAL_TYPEBUILDER
178 template<uint32_t num_bits, bool cross>
179 class TypeBuilder<types::i<num_bits>, cross> {
181 static const IntegerType *get(LLVMContext &C) {
182 return IntegerType::get(C, num_bits);
186 template<> class TypeBuilder<float, false> {
188 static const Type *get(LLVMContext& C) {
189 return Type::getFloatTy(C);
192 template<> class TypeBuilder<float, true> {};
194 template<> class TypeBuilder<double, false> {
196 static const Type *get(LLVMContext& C) {
197 return Type::getDoubleTy(C);
200 template<> class TypeBuilder<double, true> {};
202 template<bool cross> class TypeBuilder<types::ieee_float, cross> {
204 static const Type *get(LLVMContext& C) { return Type::getFloatTy(C); }
206 template<bool cross> class TypeBuilder<types::ieee_double, cross> {
208 static const Type *get(LLVMContext& C) { return Type::getDoubleTy(C); }
210 template<bool cross> class TypeBuilder<types::x86_fp80, cross> {
212 static const Type *get(LLVMContext& C) { return Type::getX86_FP80Ty(C); }
214 template<bool cross> class TypeBuilder<types::fp128, cross> {
216 static const Type *get(LLVMContext& C) { return Type::getFP128Ty(C); }
218 template<bool cross> class TypeBuilder<types::ppc_fp128, cross> {
220 static const Type *get(LLVMContext& C) { return Type::getPPC_FP128Ty(C); }
223 template<bool cross> class TypeBuilder<void, cross> {
225 static const Type *get(LLVMContext &C) {
226 return Type::getVoidTy(C);
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 template<> class TypeBuilder<const void*, false>
235 : public TypeBuilder<types::i<8>*, false> {};
236 template<> class TypeBuilder<volatile void*, false>
237 : public TypeBuilder<types::i<8>*, false> {};
238 template<> class TypeBuilder<const volatile void*, false>
239 : public TypeBuilder<types::i<8>*, false> {};
241 template<typename R, bool cross> class TypeBuilder<R(), cross> {
243 static const FunctionType *get(LLVMContext &Context) {
244 return FunctionType::get(TypeBuilder<R, cross>::get(Context), false);
247 template<typename R, typename A1, bool cross> class TypeBuilder<R(A1), cross> {
249 static const FunctionType *get(LLVMContext &Context) {
250 std::vector<const Type*> params;
252 params.push_back(TypeBuilder<A1, cross>::get(Context));
253 return FunctionType::get(TypeBuilder<R, cross>::get(Context),
257 template<typename R, typename A1, typename A2, bool cross>
258 class TypeBuilder<R(A1, A2), cross> {
260 static const FunctionType *get(LLVMContext &Context) {
261 std::vector<const Type*> params;
263 params.push_back(TypeBuilder<A1, cross>::get(Context));
264 params.push_back(TypeBuilder<A2, cross>::get(Context));
265 return FunctionType::get(TypeBuilder<R, cross>::get(Context),
269 template<typename R, typename A1, typename A2, typename A3, bool cross>
270 class TypeBuilder<R(A1, A2, A3), cross> {
272 static const FunctionType *get(LLVMContext &Context) {
273 std::vector<const Type*> params;
275 params.push_back(TypeBuilder<A1, cross>::get(Context));
276 params.push_back(TypeBuilder<A2, cross>::get(Context));
277 params.push_back(TypeBuilder<A3, cross>::get(Context));
278 return FunctionType::get(TypeBuilder<R, cross>::get(Context),
283 template<typename R, typename A1, typename A2, typename A3, typename A4,
285 class TypeBuilder<R(A1, A2, A3, A4), cross> {
287 static const FunctionType *get(LLVMContext &Context) {
288 std::vector<const Type*> params;
290 params.push_back(TypeBuilder<A1, cross>::get(Context));
291 params.push_back(TypeBuilder<A2, cross>::get(Context));
292 params.push_back(TypeBuilder<A3, cross>::get(Context));
293 params.push_back(TypeBuilder<A4, cross>::get(Context));
294 return FunctionType::get(TypeBuilder<R, cross>::get(Context),
299 template<typename R, typename A1, typename A2, typename A3, typename A4,
300 typename A5, bool cross>
301 class TypeBuilder<R(A1, A2, A3, A4, A5), cross> {
303 static const FunctionType *get(LLVMContext &Context) {
304 std::vector<const Type*> params;
306 params.push_back(TypeBuilder<A1, cross>::get(Context));
307 params.push_back(TypeBuilder<A2, cross>::get(Context));
308 params.push_back(TypeBuilder<A3, cross>::get(Context));
309 params.push_back(TypeBuilder<A4, cross>::get(Context));
310 params.push_back(TypeBuilder<A5, cross>::get(Context));
311 return FunctionType::get(TypeBuilder<R, cross>::get(Context),
316 template<typename R, bool cross> class TypeBuilder<R(...), cross> {
318 static const FunctionType *get(LLVMContext &Context) {
319 return FunctionType::get(TypeBuilder<R, cross>::get(Context), true);
322 template<typename R, typename A1, bool cross>
323 class TypeBuilder<R(A1, ...), cross> {
325 static const FunctionType *get(LLVMContext &Context) {
326 std::vector<const Type*> params;
328 params.push_back(TypeBuilder<A1, cross>::get(Context));
329 return FunctionType::get(TypeBuilder<R, cross>::get(Context), params, true);
332 template<typename R, typename A1, typename A2, bool cross>
333 class TypeBuilder<R(A1, A2, ...), cross> {
335 static const FunctionType *get(LLVMContext &Context) {
336 std::vector<const Type*> params;
338 params.push_back(TypeBuilder<A1, cross>::get(Context));
339 params.push_back(TypeBuilder<A2, cross>::get(Context));
340 return FunctionType::get(TypeBuilder<R, cross>::get(Context),
344 template<typename R, typename A1, typename A2, typename A3, bool cross>
345 class TypeBuilder<R(A1, A2, A3, ...), cross> {
347 static const FunctionType *get(LLVMContext &Context) {
348 std::vector<const Type*> params;
350 params.push_back(TypeBuilder<A1, cross>::get(Context));
351 params.push_back(TypeBuilder<A2, cross>::get(Context));
352 params.push_back(TypeBuilder<A3, cross>::get(Context));
353 return FunctionType::get(TypeBuilder<R, cross>::get(Context),
358 template<typename R, typename A1, typename A2, typename A3, typename A4,
360 class TypeBuilder<R(A1, A2, A3, A4, ...), cross> {
362 static const FunctionType *get(LLVMContext &Context) {
363 std::vector<const Type*> params;
365 params.push_back(TypeBuilder<A1, cross>::get(Context));
366 params.push_back(TypeBuilder<A2, cross>::get(Context));
367 params.push_back(TypeBuilder<A3, cross>::get(Context));
368 params.push_back(TypeBuilder<A4, cross>::get(Context));
369 return FunctionType::get(TypeBuilder<R, cross>::get(Context),
374 template<typename R, typename A1, typename A2, typename A3, typename A4,
375 typename A5, bool cross>
376 class TypeBuilder<R(A1, A2, A3, A4, A5, ...), cross> {
378 static const FunctionType *get(LLVMContext &Context) {
379 std::vector<const Type*> params;
381 params.push_back(TypeBuilder<A1, cross>::get(Context));
382 params.push_back(TypeBuilder<A2, cross>::get(Context));
383 params.push_back(TypeBuilder<A3, cross>::get(Context));
384 params.push_back(TypeBuilder<A4, cross>::get(Context));
385 params.push_back(TypeBuilder<A5, cross>::get(Context));
386 return FunctionType::get(TypeBuilder<R, cross>::get(Context),