From 096fd7b5a7b19912bfedeaef870a0c655f16e325 Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Sat, 25 Apr 2009 22:14:04 +0000 Subject: [PATCH] Add a new TypeBuilder helper class, which eases making LLVM IR types. Patch by Jeffrey Yasskin! git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@70084 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/Support/TypeBuilder.h | 463 ++++++++++++++++++++++++++ unittests/Support/TypeBuilderTest.cpp | 233 +++++++++++++ 2 files changed, 696 insertions(+) create mode 100644 include/llvm/Support/TypeBuilder.h create mode 100644 unittests/Support/TypeBuilderTest.cpp diff --git a/include/llvm/Support/TypeBuilder.h b/include/llvm/Support/TypeBuilder.h new file mode 100644 index 00000000000..df8bc5ea4ba --- /dev/null +++ b/include/llvm/Support/TypeBuilder.h @@ -0,0 +1,463 @@ +//===---- llvm/Support/TypeBuilder.h - Builder for LLVM types ---*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// +// This file defines the TypeBuilder class, which is used as a convenient way to +// create LLVM types with a consistent and simplified interface. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_SUPPORT_TYPEBUILDER_H +#define LLVM_SUPPORT_TYPEBUILDER_H + +#include "llvm/DerivedTypes.h" + +namespace llvm { + +/// TypeBuilder - This provides a uniform API for looking up types +/// known at compile time. To support cross-compilation, we define a +/// series of tag types in the llvm::types namespace, like i, +/// ieee_float, ppc_fp128, etc. TypeBuilder allows T to be +/// any of these, a native C type (whose size may depend on the host +/// compiler), or a pointer, function, or struct type built out of +/// these. TypeBuilder removes native C types from this set +/// to guarantee that its result is suitable for cross-compilation. +/// We define the primitive types, pointer types, and functions up to +/// 5 arguments here, but to use this class with your own types, +/// you'll need to specialize it. For example, say you want to call a +/// function defined externally as: +/// +/// struct MyType { +/// int32 a; +/// int32 *b; +/// void *array[1]; // Intended as a flexible array. +/// }; +/// int8 AFunction(struct MyType *value); +/// +/// You'll want to use +/// Function::Create(TypeBuilder(MyType*)>::get(), ...) +/// to declare the function, but when you first try this, your compiler will +/// complain that TypeBuilder::get() doesn't exist. To fix this, write: +/// +/// namespace llvm { +/// using types::i; +/// template class TypeBuilder { +/// public: +/// static const StructType *get() { +/// // Using the static result variable ensures that the type is +/// // only looked up once. +/// static const StructType *const result = StructType::get( +/// TypeBuilder, xcompile>::get(), +/// TypeBuilder*, xcompile>::get(), +/// TypeBuilder*[], xcompile>::get(), +/// NULL); +/// return result; +/// } +/// +/// // You may find this a convenient place to put some constants +/// // to help with getelementptr. They don't have any effect on +/// // the operation of TypeBuilder. +/// enum Fields { +/// FIELD_A, +/// FIELD_B, +/// FIELD_ARRAY +/// }; +/// } +/// } // namespace llvm +/// +/// Using the static result variable ensures that the type is only looked up +/// once. +/// +/// TypeBuilder cannot handle recursive types or types you only know at runtime. +/// If you try to give it a recursive type, it will deadlock, infinitely +/// recurse, or throw a recursive_init exception. +template class TypeBuilder {}; + +// Types for use with cross-compilable TypeBuilders. These correspond +// exactly with an LLVM-native type. +namespace types { +/// i corresponds to the LLVM IntegerType with N bits. +template class i {}; + +// The following classes represent the LLVM floating types. +class ieee_float {}; +class ieee_double {}; +class x86_fp80 {}; +class fp128 {}; +class ppc_fp128 {}; +} // namespace types + +// LLVM doesn't have const or volatile types. +template class TypeBuilder + : public TypeBuilder {}; +template class TypeBuilder + : public TypeBuilder {}; +template class TypeBuilder + : public TypeBuilder {}; + +// Pointers +template class TypeBuilder { +public: + static const PointerType *get() { + static const PointerType *const result = + PointerType::getUnqual(TypeBuilder::get()); + return result; + } +}; + +/// There is no support for references +template class TypeBuilder {}; + +// Arrays +template class TypeBuilder { +public: + static const ArrayType *get() { + static const ArrayType *const result = + ArrayType::get(TypeBuilder::get(), N); + return result; + } +}; +/// LLVM uses an array of length 0 to represent an unknown-length array. +template class TypeBuilder { +public: + static const ArrayType *get() { + static const ArrayType *const result = + ArrayType::get(TypeBuilder::get(), 0); + return result; + } +}; + +// Define the C integral types only for TypeBuilder. +// +// C integral types do not have a defined size. It would be nice to use the +// stdint.h-defined typedefs that do have defined sizes, but we'd run into the +// following problem: +// +// On an ILP32 machine, stdint.h might define: +// +// typedef int int32_t; +// typedef long long int64_t; +// typedef long size_t; +// +// If we defined TypeBuilder and TypeBuilder, then any use of +// TypeBuilder would fail. We couldn't define TypeBuilder in +// addition to the defined-size types because we'd get duplicate definitions on +// platforms where stdint.h instead defines: +// +// typedef int int32_t; +// typedef long long int64_t; +// typedef int size_t; +// +// So we define all the primitive C types and nothing else. +#define DEFINE_INTEGRAL_TYPEBUILDER(T) \ +template<> class TypeBuilder { \ +public: \ + static const IntegerType *get() { \ + static const IntegerType *const result = \ + IntegerType::get(sizeof(T) * CHAR_BIT); \ + return result; \ + } \ +}; \ +template<> class TypeBuilder { \ + /* We provide a definition here so users don't accidentally */ \ + /* define these types to work. */ \ +} +DEFINE_INTEGRAL_TYPEBUILDER(char); +DEFINE_INTEGRAL_TYPEBUILDER(signed char); +DEFINE_INTEGRAL_TYPEBUILDER(unsigned char); +DEFINE_INTEGRAL_TYPEBUILDER(short); +DEFINE_INTEGRAL_TYPEBUILDER(unsigned short); +DEFINE_INTEGRAL_TYPEBUILDER(int); +DEFINE_INTEGRAL_TYPEBUILDER(unsigned int); +DEFINE_INTEGRAL_TYPEBUILDER(long); +DEFINE_INTEGRAL_TYPEBUILDER(unsigned long); +#ifdef _MSC_VER +DEFINE_INTEGRAL_TYPEBUILDER(__int64); +DEFINE_INTEGRAL_TYPEBUILDER(unsigned __int64); +#else /* _MSC_VER */ +DEFINE_INTEGRAL_TYPEBUILDER(long long); +DEFINE_INTEGRAL_TYPEBUILDER(unsigned long long); +#endif /* _MSC_VER */ +#undef DEFINE_INTEGRAL_TYPEBUILDER + +template +class TypeBuilder, cross> { +public: + static const IntegerType *get() { + static const IntegerType *const result = IntegerType::get(num_bits); + return result; + } +}; + +template<> class TypeBuilder { +public: + static const Type *get() { + return Type::FloatTy; + } +}; +template<> class TypeBuilder {}; + +template<> class TypeBuilder { +public: + static const Type *get() { + return Type::DoubleTy; + } +}; +template<> class TypeBuilder {}; + +template class TypeBuilder { +public: + static const Type *get() { return Type::FloatTy; } +}; +template class TypeBuilder { +public: + static const Type *get() { return Type::DoubleTy; } +}; +template class TypeBuilder { +public: + static const Type *get() { return Type::X86_FP80Ty; } +}; +template class TypeBuilder { +public: + static const Type *get() { return Type::FP128Ty; } +}; +template class TypeBuilder { +public: + static const Type *get() { return Type::PPC_FP128Ty; } +}; + +template class TypeBuilder { +public: + static const Type *get() { + return Type::VoidTy; + } +}; + +/// void* is disallowed in LLVM types, but it occurs often enough in C code that +/// we special case it. +template<> class TypeBuilder + : public TypeBuilder*, false> {}; + +template class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + return FunctionType::get(TypeBuilder::get(), params, false); + } +}; +template class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + params.reserve(1); + params.push_back(TypeBuilder::get()); + return FunctionType::get(TypeBuilder::get(), params, false); + } +}; +template +class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + params.reserve(2); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + return FunctionType::get(TypeBuilder::get(), params, false); + } +}; +template +class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + params.reserve(3); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + return FunctionType::get(TypeBuilder::get(), params, false); + } +}; + +template +class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + params.reserve(4); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + return FunctionType::get(TypeBuilder::get(), params, false); + } +}; + +template +class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + params.reserve(5); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + return FunctionType::get(TypeBuilder::get(), params, false); + } +}; + +template class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + return FunctionType::get(TypeBuilder::get(), params, true); + } +}; +template +class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + params.reserve(1); + params.push_back(TypeBuilder::get()); + return FunctionType::get(TypeBuilder::get(), params, true); + } +}; +template +class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + params.reserve(2); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + return FunctionType::get(TypeBuilder::get(), params, true); + } +}; +template +class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + params.reserve(3); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + return FunctionType::get(TypeBuilder::get(), params, true); + } +}; + +template +class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + params.reserve(4); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + return FunctionType::get(TypeBuilder::get(), params, true); + } +}; + +template +class TypeBuilder { +public: + static const FunctionType *get() { + static const FunctionType *const result = create(); + return result; + } + +private: + static const FunctionType *create() { + std::vector params; + params.reserve(5); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + params.push_back(TypeBuilder::get()); + return FunctionType::get(TypeBuilder::get(), params, true); + } +}; + +} // namespace llvm + +#endif diff --git a/unittests/Support/TypeBuilderTest.cpp b/unittests/Support/TypeBuilderTest.cpp new file mode 100644 index 00000000000..425ee6bf54e --- /dev/null +++ b/unittests/Support/TypeBuilderTest.cpp @@ -0,0 +1,233 @@ +//===- llvm/unittest/Support/TypeBuilderTest.cpp - TypeBuilder tests -----===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#include "llvm/Support/TypeBuilder.h" + +#include "gtest/gtest.h" + +using namespace llvm; + +namespace { + +TEST(TypeBuilderTest, Void) { + EXPECT_EQ(Type::VoidTy, (TypeBuilder::get())); + EXPECT_EQ(Type::VoidTy, (TypeBuilder::get())); + // Special case for C compatibility: + EXPECT_EQ(PointerType::getUnqual(Type::Int8Ty), + (TypeBuilder::get())); +} + +TEST(TypeBuilderTest, HostIntegers) { + EXPECT_EQ(Type::Int8Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::Int8Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::Int16Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::Int16Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::Int32Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::Int32Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::Int64Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::Int64Ty, (TypeBuilder::get())); + + EXPECT_EQ(IntegerType::get(sizeof(size_t) * CHAR_BIT), + (TypeBuilder::get())); + EXPECT_EQ(IntegerType::get(sizeof(ptrdiff_t) * CHAR_BIT), + (TypeBuilder::get())); +} + +TEST(TypeBuilderTest, CrossCompilableIntegers) { + EXPECT_EQ(IntegerType::get(1), (TypeBuilder, true>::get())); + EXPECT_EQ(IntegerType::get(1), (TypeBuilder, false>::get())); + EXPECT_EQ(IntegerType::get(72), (TypeBuilder, true>::get())); + EXPECT_EQ(IntegerType::get(72), (TypeBuilder, false>::get())); +} + +TEST(TypeBuilderTest, Float) { + EXPECT_EQ(Type::FloatTy, (TypeBuilder::get())); + EXPECT_EQ(Type::DoubleTy, (TypeBuilder::get())); + // long double isn't supported yet. + EXPECT_EQ(Type::FloatTy, (TypeBuilder::get())); + EXPECT_EQ(Type::FloatTy, (TypeBuilder::get())); + EXPECT_EQ(Type::DoubleTy, (TypeBuilder::get())); + EXPECT_EQ(Type::DoubleTy, (TypeBuilder::get())); + EXPECT_EQ(Type::X86_FP80Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::X86_FP80Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::FP128Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::FP128Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::PPC_FP128Ty, (TypeBuilder::get())); + EXPECT_EQ(Type::PPC_FP128Ty, (TypeBuilder::get())); +} + +TEST(TypeBuilderTest, Derived) { + EXPECT_EQ(PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty)), + (TypeBuilder::get())); + EXPECT_EQ(ArrayType::get(Type::Int8Ty, 7), + (TypeBuilder::get())); + EXPECT_EQ(ArrayType::get(Type::Int8Ty, 0), + (TypeBuilder::get())); + + EXPECT_EQ(PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty)), + (TypeBuilder**, false>::get())); + EXPECT_EQ(ArrayType::get(Type::Int8Ty, 7), + (TypeBuilder[7], false>::get())); + EXPECT_EQ(ArrayType::get(Type::Int8Ty, 0), + (TypeBuilder[], false>::get())); + + EXPECT_EQ(PointerType::getUnqual(PointerType::getUnqual(Type::Int8Ty)), + (TypeBuilder**, true>::get())); + EXPECT_EQ(ArrayType::get(Type::Int8Ty, 7), + (TypeBuilder[7], true>::get())); + EXPECT_EQ(ArrayType::get(Type::Int8Ty, 0), + (TypeBuilder[], true>::get())); + + + EXPECT_EQ(Type::Int8Ty, + (TypeBuilder::get())); + EXPECT_EQ(Type::Int8Ty, + (TypeBuilder::get())); + EXPECT_EQ(Type::Int8Ty, + (TypeBuilder::get())); + + EXPECT_EQ(Type::Int8Ty, + (TypeBuilder, false>::get())); + EXPECT_EQ(Type::Int8Ty, + (TypeBuilder, false>::get())); + EXPECT_EQ(Type::Int8Ty, + (TypeBuilder, false>::get())); + + EXPECT_EQ(Type::Int8Ty, + (TypeBuilder, true>::get())); + EXPECT_EQ(Type::Int8Ty, + (TypeBuilder, true>::get())); + EXPECT_EQ(Type::Int8Ty, + (TypeBuilder, true>::get())); + + EXPECT_EQ(PointerType::getUnqual(Type::Int8Ty), + (TypeBuilder::get())); +} + +TEST(TypeBuilderTest, Functions) { + std::vector params; + EXPECT_EQ(FunctionType::get(Type::VoidTy, params, false), + (TypeBuilder::get())); + EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true), + (TypeBuilder::get())); + params.push_back(TypeBuilder::get()); + EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, false), + (TypeBuilder::get())); + EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true), + (TypeBuilder::get())); + params.push_back(TypeBuilder::get()); + EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, false), + (TypeBuilder::get())); + EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true), + (TypeBuilder::get())); + params.push_back(TypeBuilder::get()); + EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, false), + (TypeBuilder::get())); + EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true), + (TypeBuilder::get())); + params.push_back(TypeBuilder::get()); + EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, false), + (TypeBuilder::get())); + EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true), + (TypeBuilder::get())); + params.push_back(TypeBuilder::get()); + EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, false), + (TypeBuilder::get())); + EXPECT_EQ(FunctionType::get(Type::Int8Ty, params, true), + (TypeBuilder::get())); +} + +class MyType { + int a; + int *b; + void *array[1]; +}; + +class MyPortableType { + int32_t a; + int32_t *b; + void *array[1]; +}; + +} // anonymous namespace + +namespace llvm { +template class TypeBuilder { +public: + static const StructType *get() { + // Using the static result variable ensures that the type is + // only looked up once. + static const StructType *const result = StructType::get( + TypeBuilder::get(), + TypeBuilder::get(), + TypeBuilder::get(), + NULL); + return result; + } + + // You may find this a convenient place to put some constants + // to help with getelementptr. They don't have any effect on + // the operation of TypeBuilder. + enum Fields { + FIELD_A, + FIELD_B, + FIELD_ARRAY + }; +}; + +template class TypeBuilder { +public: + static const StructType *get() { + // Using the static result variable ensures that the type is + // only looked up once. + static const StructType *const result = StructType::get( + TypeBuilder, cross>::get(), + TypeBuilder*, cross>::get(), + TypeBuilder*[], cross>::get(), + NULL); + return result; + } + + // You may find this a convenient place to put some constants + // to help with getelementptr. They don't have any effect on + // the operation of TypeBuilder. + enum Fields { + FIELD_A, + FIELD_B, + FIELD_ARRAY + }; +}; +} // namespace llvm +namespace { + +TEST(TypeBuilderTest, Extensions) { + EXPECT_EQ(PointerType::getUnqual(StructType::get( + TypeBuilder::get(), + TypeBuilder::get(), + TypeBuilder::get(), + NULL)), + (TypeBuilder::get())); + EXPECT_EQ(PointerType::getUnqual(StructType::get( + TypeBuilder, false>::get(), + TypeBuilder*, false>::get(), + TypeBuilder*[], false>::get(), + NULL)), + (TypeBuilder::get())); + EXPECT_EQ(PointerType::getUnqual(StructType::get( + TypeBuilder, false>::get(), + TypeBuilder*, false>::get(), + TypeBuilder*[], false>::get(), + NULL)), + (TypeBuilder::get())); +} + +} // anonymous namespace -- 2.34.1