Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 1 | //===--- CGRecordLayoutBuilder.cpp - 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 | #include "CGRecordLayoutBuilder.h" |
| 15 | |
| 16 | #include "clang/AST/ASTContext.h" |
| 17 | #include "clang/AST/Attr.h" |
| 18 | #include "clang/AST/DeclCXX.h" |
| 19 | #include "clang/AST/Expr.h" |
| 20 | #include "clang/AST/RecordLayout.h" |
| 21 | #include "CodeGenTypes.h" |
| 22 | #include "llvm/DerivedTypes.h" |
| 23 | #include "llvm/Target/TargetData.h" |
| 24 | |
| 25 | |
| 26 | using namespace clang; |
| 27 | using namespace CodeGen; |
| 28 | |
| 29 | void CGRecordLayoutBuilder::Layout(const RecordDecl *D) { |
Anders Carlsson | 5a6e398 | 2009-07-23 03:43:54 +0000 | [diff] [blame] | 30 | if (D->isUnion()) { |
| 31 | LayoutUnion(D); |
| 32 | return; |
| 33 | } |
| 34 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 35 | if (const PackedAttr* PA = D->getAttr<PackedAttr>()) |
Anders Carlsson | 4b5584b | 2009-07-23 17:24:40 +0000 | [diff] [blame] | 36 | Packed = PA->getAlignment(); |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 37 | |
| 38 | if (LayoutFields(D)) |
| 39 | return; |
| 40 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 41 | // We weren't able to layout the struct. Try again with a packed struct |
Anders Carlsson | 4b5584b | 2009-07-23 17:24:40 +0000 | [diff] [blame] | 42 | Packed = true; |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 43 | AlignmentAsLLVMStruct = 1; |
| 44 | FieldTypes.clear(); |
| 45 | FieldInfos.clear(); |
| 46 | LLVMFields.clear(); |
| 47 | LLVMBitFields.clear(); |
| 48 | |
| 49 | LayoutFields(D); |
| 50 | } |
| 51 | |
| 52 | void CGRecordLayoutBuilder::LayoutBitField(const FieldDecl *D, |
| 53 | uint64_t FieldOffset) { |
| 54 | uint64_t FieldSize = |
| 55 | D->getBitWidth()->EvaluateAsInt(Types.getContext()).getZExtValue(); |
| 56 | |
| 57 | if (FieldSize == 0) |
| 58 | return; |
| 59 | |
| 60 | uint64_t NextFieldOffset = getNextFieldOffsetInBytes() * 8; |
| 61 | unsigned NumBytesToAppend; |
| 62 | |
| 63 | if (FieldOffset < NextFieldOffset) { |
| 64 | assert(BitsAvailableInLastField && "Bitfield size mismatch!"); |
| 65 | assert(!FieldInfos.empty() && "Field infos can't be empty!"); |
| 66 | |
| 67 | // The bitfield begins in the previous bit-field. |
| 68 | NumBytesToAppend = |
| 69 | llvm::RoundUpToAlignment(FieldSize - BitsAvailableInLastField, 8) / 8; |
| 70 | } else { |
| 71 | assert(FieldOffset % 8 == 0 && "Field offset not aligned correctly"); |
| 72 | |
| 73 | // Append padding if necessary. |
| 74 | AppendBytes((FieldOffset - NextFieldOffset) / 8); |
| 75 | |
| 76 | NumBytesToAppend = |
| 77 | llvm::RoundUpToAlignment(FieldSize, 8) / 8; |
| 78 | |
| 79 | assert(NumBytesToAppend && "No bytes to append!"); |
| 80 | } |
| 81 | |
| 82 | const llvm::Type *Ty = Types.ConvertTypeForMemRecursive(D->getType()); |
| 83 | uint64_t TypeSizeInBits = getTypeSizeInBytes(Ty) * 8; |
| 84 | |
Anders Carlsson | 8330cee | 2009-07-23 17:01:21 +0000 | [diff] [blame] | 85 | LLVMBitFields.push_back(LLVMBitFieldInfo(D, FieldOffset / TypeSizeInBits, |
| 86 | FieldOffset % TypeSizeInBits, |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 87 | FieldSize)); |
| 88 | |
| 89 | AppendBytes(NumBytesToAppend); |
| 90 | |
Anders Carlsson | c1efe36 | 2009-07-27 14:55:54 +0000 | [diff] [blame] | 91 | AlignmentAsLLVMStruct = std::max(AlignmentAsLLVMStruct, getTypeAlignment(Ty)); |
| 92 | |
Anders Carlsson | faaec22 | 2009-07-23 21:16:33 +0000 | [diff] [blame] | 93 | BitsAvailableInLastField = |
| 94 | getNextFieldOffsetInBytes() * 8 - (FieldOffset + FieldSize); |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 95 | } |
| 96 | |
| 97 | bool CGRecordLayoutBuilder::LayoutField(const FieldDecl *D, |
| 98 | uint64_t FieldOffset) { |
Anders Carlsson | 4b5584b | 2009-07-23 17:24:40 +0000 | [diff] [blame] | 99 | bool FieldPacked = Packed; |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 100 | |
| 101 | // FIXME: Should this override struct packing? Probably we want to |
| 102 | // take the minimum? |
| 103 | if (const PackedAttr *PA = D->getAttr<PackedAttr>()) |
Anders Carlsson | 4b5584b | 2009-07-23 17:24:40 +0000 | [diff] [blame] | 104 | FieldPacked = PA->getAlignment(); |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 105 | |
| 106 | // If the field is packed, then we need a packed struct. |
Anders Carlsson | 4b5584b | 2009-07-23 17:24:40 +0000 | [diff] [blame] | 107 | if (!Packed && FieldPacked) |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 108 | return false; |
| 109 | |
| 110 | if (D->isBitField()) { |
| 111 | // We must use packed structs for unnamed bit fields since they |
| 112 | // don't affect the struct alignment. |
Anders Carlsson | 4b5584b | 2009-07-23 17:24:40 +0000 | [diff] [blame] | 113 | if (!Packed && !D->getDeclName()) |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 114 | return false; |
| 115 | |
| 116 | LayoutBitField(D, FieldOffset); |
| 117 | return true; |
| 118 | } |
| 119 | |
| 120 | const llvm::Type *Ty = Types.ConvertTypeForMemRecursive(D->getType()); |
| 121 | |
| 122 | // Check if the field is aligned. |
| 123 | if (const AlignedAttr *PA = D->getAttr<AlignedAttr>()) { |
| 124 | unsigned FieldAlign = PA->getAlignment(); |
| 125 | |
Anders Carlsson | 4b5584b | 2009-07-23 17:24:40 +0000 | [diff] [blame] | 126 | if (!Packed && getTypeAlignment(Ty) > FieldAlign) |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 127 | return false; |
| 128 | } |
| 129 | |
| 130 | assert(FieldOffset % 8 == 0 && "FieldOffset is not on a byte boundary!"); |
| 131 | |
| 132 | uint64_t FieldOffsetInBytes = FieldOffset / 8; |
| 133 | |
| 134 | // Append padding if necessary. |
| 135 | AppendPadding(FieldOffsetInBytes, Ty); |
| 136 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 137 | // Now append the field. |
| 138 | LLVMFields.push_back(LLVMFieldInfo(D, FieldTypes.size())); |
Anders Carlsson | 728d7cd | 2009-07-24 02:45:50 +0000 | [diff] [blame] | 139 | AppendField(FieldOffsetInBytes, Ty); |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 140 | |
| 141 | return true; |
| 142 | } |
| 143 | |
Anders Carlsson | 5a6e398 | 2009-07-23 03:43:54 +0000 | [diff] [blame] | 144 | void CGRecordLayoutBuilder::LayoutUnion(const RecordDecl *D) { |
| 145 | assert(D->isUnion() && "Can't call LayoutUnion on a non-union record!"); |
| 146 | |
| 147 | const ASTRecordLayout &Layout = Types.getContext().getASTRecordLayout(D); |
| 148 | |
| 149 | const llvm::Type *Ty = 0; |
| 150 | uint64_t Size = 0; |
| 151 | unsigned Align = 0; |
| 152 | |
| 153 | unsigned FieldNo = 0; |
| 154 | for (RecordDecl::field_iterator Field = D->field_begin(), |
| 155 | FieldEnd = D->field_end(); Field != FieldEnd; ++Field, ++FieldNo) { |
| 156 | assert(Layout.getFieldOffset(FieldNo) == 0 && |
| 157 | "Union field offset did not start at the beginning of record!"); |
Anders Carlsson | 2cc8f17 | 2009-07-23 04:00:39 +0000 | [diff] [blame] | 158 | |
| 159 | if (Field->isBitField()) { |
| 160 | uint64_t FieldSize = |
| 161 | Field->getBitWidth()->EvaluateAsInt(Types.getContext()).getZExtValue(); |
| 162 | |
| 163 | // Ignore zero sized bit fields. |
| 164 | if (FieldSize == 0) |
| 165 | continue; |
Anders Carlsson | 94ae95f | 2009-07-23 22:52:34 +0000 | [diff] [blame] | 166 | |
| 167 | // Add the bit field info. |
| 168 | Types.addBitFieldInfo(*Field, 0, 0, FieldSize); |
| 169 | } else |
| 170 | Types.addFieldInfo(*Field, 0); |
Anders Carlsson | 5a6e398 | 2009-07-23 03:43:54 +0000 | [diff] [blame] | 171 | |
| 172 | const llvm::Type *FieldTy = |
| 173 | Types.ConvertTypeForMemRecursive(Field->getType()); |
Anders Carlsson | 177d4d8 | 2009-07-23 21:52:03 +0000 | [diff] [blame] | 174 | unsigned FieldAlign = Types.getTargetData().getABITypeAlignment(FieldTy); |
| 175 | uint64_t FieldSize = Types.getTargetData().getTypeAllocSize(FieldTy); |
Anders Carlsson | 5a6e398 | 2009-07-23 03:43:54 +0000 | [diff] [blame] | 176 | |
| 177 | if (FieldAlign < Align) |
| 178 | continue; |
| 179 | |
| 180 | if (FieldAlign > Align || FieldSize > Size) { |
| 181 | Ty = FieldTy; |
| 182 | Align = FieldAlign; |
| 183 | Size = FieldSize; |
| 184 | } |
| 185 | } |
| 186 | |
| 187 | // Now add our field. |
Anders Carlsson | 94ae95f | 2009-07-23 22:52:34 +0000 | [diff] [blame] | 188 | if (Ty) |
Anders Carlsson | 728d7cd | 2009-07-24 02:45:50 +0000 | [diff] [blame] | 189 | AppendField(0, Ty); |
Anders Carlsson | 5a6e398 | 2009-07-23 03:43:54 +0000 | [diff] [blame] | 190 | |
| 191 | // Append tail padding. |
| 192 | if (Layout.getSize() / 8 > Size) |
| 193 | AppendPadding(Layout.getSize() / 8, Align); |
| 194 | } |
| 195 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 196 | bool CGRecordLayoutBuilder::LayoutFields(const RecordDecl *D) { |
| 197 | assert(!D->isUnion() && "Can't call LayoutFields on a union!"); |
| 198 | |
Anders Carlsson | 5a6e398 | 2009-07-23 03:43:54 +0000 | [diff] [blame] | 199 | const ASTRecordLayout &Layout = Types.getContext().getASTRecordLayout(D); |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 200 | |
| 201 | unsigned FieldNo = 0; |
Fariborz Jahanian | cad8665 | 2009-07-27 20:57:45 +0000 | [diff] [blame^] | 202 | // FIXME. This will probably change when virtual bases are supported. |
| 203 | if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(D)) |
| 204 | FieldNo += CXXRD->getNumBases(); |
| 205 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 206 | for (RecordDecl::field_iterator Field = D->field_begin(), |
| 207 | FieldEnd = D->field_end(); Field != FieldEnd; ++Field, ++FieldNo) { |
| 208 | if (!LayoutField(*Field, Layout.getFieldOffset(FieldNo))) { |
Anders Carlsson | 4b5584b | 2009-07-23 17:24:40 +0000 | [diff] [blame] | 209 | assert(!Packed && |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 210 | "Could not layout fields even with a packed LLVM struct!"); |
| 211 | return false; |
| 212 | } |
| 213 | } |
| 214 | |
| 215 | // Append tail padding if necessary. |
Anders Carlsson | c1efe36 | 2009-07-27 14:55:54 +0000 | [diff] [blame] | 216 | AppendTailPadding(Layout.getSize()); |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 217 | |
| 218 | return true; |
| 219 | } |
| 220 | |
Anders Carlsson | c1efe36 | 2009-07-27 14:55:54 +0000 | [diff] [blame] | 221 | void CGRecordLayoutBuilder::AppendTailPadding(uint64_t RecordSize) { |
| 222 | assert(RecordSize % 8 == 0 && "Invalid record size!"); |
| 223 | |
| 224 | uint64_t RecordSizeInBytes = RecordSize / 8; |
| 225 | assert(getNextFieldOffsetInBytes() <= RecordSizeInBytes && "Size mismatch!"); |
| 226 | |
| 227 | unsigned NumPadBytes = RecordSizeInBytes - getNextFieldOffsetInBytes(); |
| 228 | AppendBytes(NumPadBytes); |
| 229 | } |
| 230 | |
| 231 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 232 | void CGRecordLayoutBuilder::AppendField(uint64_t FieldOffsetInBytes, |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 233 | const llvm::Type *FieldTy) { |
| 234 | AlignmentAsLLVMStruct = std::max(AlignmentAsLLVMStruct, |
| 235 | getTypeAlignment(FieldTy)); |
Anders Carlsson | 728d7cd | 2009-07-24 02:45:50 +0000 | [diff] [blame] | 236 | |
| 237 | uint64_t FieldSizeInBytes = getTypeSizeInBytes(FieldTy); |
| 238 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 239 | FieldTypes.push_back(FieldTy); |
| 240 | FieldInfos.push_back(FieldInfo(FieldOffsetInBytes, FieldSizeInBytes)); |
| 241 | |
| 242 | BitsAvailableInLastField = 0; |
| 243 | } |
| 244 | |
| 245 | void |
| 246 | CGRecordLayoutBuilder::AppendPadding(uint64_t FieldOffsetInBytes, |
| 247 | const llvm::Type *FieldTy) { |
| 248 | AppendPadding(FieldOffsetInBytes, getTypeAlignment(FieldTy)); |
| 249 | } |
| 250 | |
| 251 | void CGRecordLayoutBuilder::AppendPadding(uint64_t FieldOffsetInBytes, |
| 252 | unsigned FieldAlignment) { |
| 253 | uint64_t NextFieldOffsetInBytes = getNextFieldOffsetInBytes(); |
| 254 | assert(NextFieldOffsetInBytes <= FieldOffsetInBytes && |
| 255 | "Incorrect field layout!"); |
| 256 | |
| 257 | // Round up the field offset to the alignment of the field type. |
| 258 | uint64_t AlignedNextFieldOffsetInBytes = |
| 259 | llvm::RoundUpToAlignment(NextFieldOffsetInBytes, FieldAlignment); |
| 260 | |
| 261 | if (AlignedNextFieldOffsetInBytes < FieldOffsetInBytes) { |
| 262 | // Even with alignment, the field offset is not at the right place, |
| 263 | // insert padding. |
| 264 | uint64_t PaddingInBytes = FieldOffsetInBytes - NextFieldOffsetInBytes; |
| 265 | |
| 266 | AppendBytes(PaddingInBytes); |
| 267 | } |
| 268 | } |
| 269 | |
| 270 | void CGRecordLayoutBuilder::AppendBytes(uint64_t NumBytes) { |
| 271 | if (NumBytes == 0) |
| 272 | return; |
| 273 | |
| 274 | const llvm::Type *Ty = llvm::Type::Int8Ty; |
Anders Carlsson | c1efe36 | 2009-07-27 14:55:54 +0000 | [diff] [blame] | 275 | if (NumBytes > 1) |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 276 | Ty = llvm::ArrayType::get(Ty, NumBytes); |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 277 | |
| 278 | // Append the padding field |
Anders Carlsson | 728d7cd | 2009-07-24 02:45:50 +0000 | [diff] [blame] | 279 | AppendField(getNextFieldOffsetInBytes(), Ty); |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 280 | } |
| 281 | |
| 282 | uint64_t CGRecordLayoutBuilder::getNextFieldOffsetInBytes() const { |
| 283 | if (FieldInfos.empty()) |
| 284 | return 0; |
| 285 | |
| 286 | const FieldInfo &LastInfo = FieldInfos.back(); |
| 287 | return LastInfo.OffsetInBytes + LastInfo.SizeInBytes; |
| 288 | } |
| 289 | |
| 290 | unsigned CGRecordLayoutBuilder::getTypeAlignment(const llvm::Type *Ty) const { |
Anders Carlsson | 4b5584b | 2009-07-23 17:24:40 +0000 | [diff] [blame] | 291 | if (Packed) |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 292 | return 1; |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 293 | |
| 294 | return Types.getTargetData().getABITypeAlignment(Ty); |
| 295 | } |
| 296 | |
| 297 | uint64_t CGRecordLayoutBuilder::getTypeSizeInBytes(const llvm::Type *Ty) const { |
| 298 | return Types.getTargetData().getTypeAllocSize(Ty); |
| 299 | } |
| 300 | |
| 301 | CGRecordLayout * |
| 302 | CGRecordLayoutBuilder::ComputeLayout(CodeGenTypes &Types, |
| 303 | const RecordDecl *D) { |
| 304 | CGRecordLayoutBuilder Builder(Types); |
| 305 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 306 | Builder.Layout(D); |
Anders Carlsson | 4c98efd | 2009-07-24 15:20:52 +0000 | [diff] [blame] | 307 | |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 308 | const llvm::Type *Ty = llvm::StructType::get(Builder.FieldTypes, |
Anders Carlsson | 4b5584b | 2009-07-23 17:24:40 +0000 | [diff] [blame] | 309 | Builder.Packed); |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 310 | |
| 311 | // Add all the field numbers. |
| 312 | for (unsigned i = 0, e = Builder.LLVMFields.size(); i != e; ++i) { |
| 313 | const FieldDecl *FD = Builder.LLVMFields[i].first; |
| 314 | unsigned FieldNo = Builder.LLVMFields[i].second; |
| 315 | |
| 316 | Types.addFieldInfo(FD, FieldNo); |
| 317 | } |
| 318 | |
| 319 | // Add bitfield info. |
| 320 | for (unsigned i = 0, e = Builder.LLVMBitFields.size(); i != e; ++i) { |
| 321 | const LLVMBitFieldInfo &Info = Builder.LLVMBitFields[i]; |
| 322 | |
Anders Carlsson | 8330cee | 2009-07-23 17:01:21 +0000 | [diff] [blame] | 323 | Types.addBitFieldInfo(Info.FD, Info.FieldNo, Info.Start, Info.Size); |
Anders Carlsson | 45372a6 | 2009-07-23 03:17:50 +0000 | [diff] [blame] | 324 | } |
| 325 | |
| 326 | return new CGRecordLayout(Ty, llvm::SmallSet<unsigned, 8>()); |
| 327 | } |