Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 1 | //===--- CGRecordLayoutBuilder.h - Record builder helper --------*- 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 is a helper class used to build CGRecordLayout objects and LLVM types. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
| 14 | #ifndef CLANG_CODEGEN_CGRECORDLAYOUTBUILDER_H |
| 15 | #define CLANG_CODEGEN_CGRECORDLAYOUTBUILDER_H |
| 16 | |
| 17 | #include "llvm/ADT/SmallVector.h" |
Chandler Carruth | 9f8eb20 | 2009-10-26 01:37:10 +0000 | [diff] [blame] | 18 | #include "llvm/System/DataTypes.h" |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 19 | #include <vector> |
| 20 | |
| 21 | namespace llvm { |
| 22 | class Type; |
| 23 | } |
| 24 | |
| 25 | namespace clang { |
Anders Carlsson | 4b3e5be | 2009-12-16 17:27:20 +0000 | [diff] [blame] | 26 | class ASTRecordLayout; |
| 27 | class CXXRecordDecl; |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 28 | class FieldDecl; |
| 29 | class RecordDecl; |
Anders Carlsson | 2c12d03 | 2010-02-02 05:17:25 +0000 | [diff] [blame] | 30 | class QualType; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 31 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 32 | namespace CodeGen { |
| 33 | class CGRecordLayout; |
| 34 | class CodeGenTypes; |
| 35 | |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 36 | class CGRecordLayoutBuilder { |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 37 | CodeGenTypes &Types; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 38 | |
Anders Carlsson | 4b5584b | 2009-07-23 17:24:40 +0000 | [diff] [blame] | 39 | /// Packed - Whether the resulting LLVM struct will be packed or not. |
| 40 | bool Packed; |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 41 | |
Anders Carlsson | 2c12d03 | 2010-02-02 05:17:25 +0000 | [diff] [blame] | 42 | /// ContainsPointerToDataMember - Whether one of the fields in this record |
| 43 | /// layout is a pointer to data member, or a struct that contains pointer to |
| 44 | /// data member. |
| 45 | bool ContainsPointerToDataMember; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 46 | |
Anders Carlsson | a5dd722 | 2009-08-08 19:38:24 +0000 | [diff] [blame] | 47 | /// Alignment - Contains the alignment of the RecordDecl. |
| 48 | unsigned Alignment; |
| 49 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 50 | /// AlignmentAsLLVMStruct - Will contain the maximum alignment of all the |
| 51 | /// LLVM types. |
| 52 | unsigned AlignmentAsLLVMStruct; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 53 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 54 | /// BitsAvailableInLastField - If a bit field spans only part of a LLVM field, |
| 55 | /// this will have the number of bits still available in the field. |
| 56 | char BitsAvailableInLastField; |
Anders Carlsson | c2cc1d5 | 2009-07-28 17:56:36 +0000 | [diff] [blame] | 57 | |
| 58 | /// NextFieldOffsetInBytes - Holds the next field offset in bytes. |
| 59 | uint64_t NextFieldOffsetInBytes; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 60 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 61 | /// FieldTypes - Holds the LLVM types that the struct is created from. |
| 62 | std::vector<const llvm::Type *> FieldTypes; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 63 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 64 | /// LLVMFieldInfo - Holds a field and its corresponding LLVM field number. |
| 65 | typedef std::pair<const FieldDecl *, unsigned> LLVMFieldInfo; |
| 66 | llvm::SmallVector<LLVMFieldInfo, 16> LLVMFields; |
| 67 | |
| 68 | /// LLVMBitFieldInfo - Holds location and size information about a bit field. |
| 69 | struct LLVMBitFieldInfo { |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 70 | LLVMBitFieldInfo(const FieldDecl *FD, unsigned FieldNo, unsigned Start, |
Anders Carlsson | 8330cee | 2009-07-23 17:01:21 +0000 | [diff] [blame] | 71 | unsigned Size) |
| 72 | : FD(FD), FieldNo(FieldNo), Start(Start), Size(Size) { } |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 73 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 74 | const FieldDecl *FD; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 75 | |
Anders Carlsson | 8330cee | 2009-07-23 17:01:21 +0000 | [diff] [blame] | 76 | unsigned FieldNo; |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 77 | unsigned Start; |
| 78 | unsigned Size; |
| 79 | }; |
| 80 | llvm::SmallVector<LLVMBitFieldInfo, 16> LLVMBitFields; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 81 | |
| 82 | CGRecordLayoutBuilder(CodeGenTypes &Types) |
Anders Carlsson | 2c12d03 | 2010-02-02 05:17:25 +0000 | [diff] [blame] | 83 | : Types(Types), Packed(false), ContainsPointerToDataMember(false) |
Anders Carlsson | fc3eaa4 | 2009-08-23 01:25:01 +0000 | [diff] [blame] | 84 | , Alignment(0), AlignmentAsLLVMStruct(1) |
Anders Carlsson | c2cc1d5 | 2009-07-28 17:56:36 +0000 | [diff] [blame] | 85 | , BitsAvailableInLastField(0), NextFieldOffsetInBytes(0) { } |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 86 | |
| 87 | /// Layout - Will layout a RecordDecl. |
| 88 | void Layout(const RecordDecl *D); |
| 89 | |
Anders Carlsson | 5a6e398 | 2009-07-23 03:43:54 +0000 | [diff] [blame] | 90 | /// LayoutUnion - Will layout a union RecordDecl. |
| 91 | void LayoutUnion(const RecordDecl *D); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 92 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 93 | /// LayoutField - try to layout all fields in the record decl. |
| 94 | /// Returns false if the operation failed because the struct is not packed. |
| 95 | bool LayoutFields(const RecordDecl *D); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 96 | |
Anders Carlsson | 4b3e5be | 2009-12-16 17:27:20 +0000 | [diff] [blame] | 97 | /// LayoutBases - layout the bases and vtable pointer of a record decl. |
| 98 | void LayoutBases(const CXXRecordDecl *RD, const ASTRecordLayout &Layout); |
| 99 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 100 | /// LayoutField - layout a single field. Returns false if the operation failed |
| 101 | /// because the current struct is not packed. |
| 102 | bool LayoutField(const FieldDecl *D, uint64_t FieldOffset); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 103 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 104 | /// LayoutBitField - layout a single bit field. |
| 105 | void LayoutBitField(const FieldDecl *D, uint64_t FieldOffset); |
| 106 | |
Anders Carlsson | 728d7cd | 2009-07-24 02:45:50 +0000 | [diff] [blame] | 107 | /// AppendField - Appends a field with the given offset and type. |
| 108 | void AppendField(uint64_t FieldOffsetInBytes, const llvm::Type *FieldTy); |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 109 | |
| 110 | /// AppendPadding - Appends enough padding bytes so that the total struct |
| 111 | /// size matches the alignment of the passed in type. |
| 112 | void AppendPadding(uint64_t FieldOffsetInBytes, const llvm::Type *FieldTy); |
| 113 | |
| 114 | /// AppendPadding - Appends enough padding bytes so that the total |
| 115 | /// struct size is a multiple of the field alignment. |
| 116 | void AppendPadding(uint64_t FieldOffsetInBytes, unsigned FieldAlignment); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 117 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 118 | /// AppendBytes - Append a given number of bytes to the record. |
| 119 | void AppendBytes(uint64_t NumBytes); |
| 120 | |
Anders Carlsson | c1efe36 | 2009-07-27 14:55:54 +0000 | [diff] [blame] | 121 | /// AppendTailPadding - Append enough tail padding so that the type will have |
| 122 | /// the passed size. |
| 123 | void AppendTailPadding(uint64_t RecordSize); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 124 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 125 | unsigned getTypeAlignment(const llvm::Type *Ty) const; |
| 126 | uint64_t getTypeSizeInBytes(const llvm::Type *Ty) const; |
| 127 | |
Anders Carlsson | 2c12d03 | 2010-02-02 05:17:25 +0000 | [diff] [blame] | 128 | /// CheckForPointerToDataMember - Check if the given type contains a pointer |
| 129 | /// to data member. |
| 130 | void CheckForPointerToDataMember(QualType T); |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 131 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 132 | public: |
| 133 | /// ComputeLayout - Return the right record layout for a given record decl. |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 134 | static CGRecordLayout *ComputeLayout(CodeGenTypes &Types, |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 135 | const RecordDecl *D); |
| 136 | }; |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 137 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 138 | } // end namespace CodeGen |
| 139 | } // end namespace clang |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 140 | |
Mike Stump | 1eb4433 | 2009-09-09 15:08:12 +0000 | [diff] [blame] | 141 | |
| 142 | #endif |