blob: d0a48fd891ab57651d22a2a6b352fd62578f8887 [file] [log] [blame]
Anders Carlsson35a36eb2010-05-26 05:41:04 +00001//=== RecordLayoutBuilder.cpp - Helper class for building record layouts ---==//
Anders Carlsson79474332009-07-18 20:20:21 +00002//
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
Anders Carlsson79474332009-07-18 20:20:21 +000010#include "clang/AST/Attr.h"
11#include "clang/AST/Decl.h"
Anders Carlsson6d9f6f32009-07-19 00:18:47 +000012#include "clang/AST/DeclCXX.h"
Anders Carlsson4f516282009-07-18 20:50:59 +000013#include "clang/AST/DeclObjC.h"
Anders Carlsson79474332009-07-18 20:20:21 +000014#include "clang/AST/Expr.h"
Anders Carlsson35a36eb2010-05-26 05:41:04 +000015#include "clang/AST/RecordLayout.h"
Anders Carlsson79474332009-07-18 20:20:21 +000016#include "clang/Basic/TargetInfo.h"
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +000017#include "clang/Sema/SemaDiagnostic.h"
Daniel Dunbaraa423af2010-04-08 02:59:49 +000018#include "llvm/Support/Format.h"
19#include "llvm/ADT/SmallSet.h"
20#include "llvm/Support/MathExtras.h"
Anders Carlsson35a36eb2010-05-26 05:41:04 +000021#include <map>
Anders Carlsson79474332009-07-18 20:20:21 +000022
23using namespace clang;
24
Benjamin Kramerc7656cd2010-05-26 09:58:31 +000025namespace {
Anders Carlssonf58de112010-05-26 15:32:58 +000026
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000027/// BaseSubobjectInfo - Represents a single base subobject in a complete class.
28/// For a class hierarchy like
29///
30/// class A { };
31/// class B : A { };
32/// class C : A, B { };
33///
34/// The BaseSubobjectInfo graph for C will have three BaseSubobjectInfo
35/// instances, one for B and two for A.
36///
37/// If a base is virtual, it will only have one BaseSubobjectInfo allocated.
38struct BaseSubobjectInfo {
39 /// Class - The class for this base info.
Anders Carlsson056818f2010-05-28 21:13:31 +000040 const CXXRecordDecl *Class;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000041
42 /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
Anders Carlsson056818f2010-05-28 21:13:31 +000043 bool IsVirtual;
44
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000045 /// Bases - Information about the base subobjects.
46 llvm::SmallVector<BaseSubobjectInfo*, 4> Bases;
47
Anders Carlssone3c24c72010-05-29 17:35:14 +000048 /// PrimaryVirtualBaseInfo - Holds the base info for the primary virtual base
49 /// of this base info (if one exists).
50 BaseSubobjectInfo *PrimaryVirtualBaseInfo;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000051
52 // FIXME: Document.
53 const BaseSubobjectInfo *Derived;
Anders Carlsson056818f2010-05-28 21:13:31 +000054};
55
Anders Carlssonf58de112010-05-26 15:32:58 +000056/// EmptySubobjectMap - Keeps track of which empty subobjects exist at different
57/// offsets while laying out a C++ class.
58class EmptySubobjectMap {
59 ASTContext &Context;
Anders Carlsson233e2722010-10-31 21:54:55 +000060 uint64_t CharWidth;
61
Anders Carlssonf58de112010-05-26 15:32:58 +000062 /// Class - The class whose empty entries we're keeping track of.
63 const CXXRecordDecl *Class;
Daniel Dunbar592a85c2010-05-27 02:25:46 +000064
Anders Carlsson439edd12010-05-27 05:41:06 +000065 /// EmptyClassOffsets - A map from offsets to empty record decls.
66 typedef llvm::SmallVector<const CXXRecordDecl *, 1> ClassVectorTy;
Anders Carlssonf8f756d2010-10-31 21:22:43 +000067 typedef llvm::DenseMap<CharUnits, ClassVectorTy> EmptyClassOffsetsMapTy;
Anders Carlsson439edd12010-05-27 05:41:06 +000068 EmptyClassOffsetsMapTy EmptyClassOffsets;
69
Anders Carlssoncc5de092010-06-08 15:56:03 +000070 /// MaxEmptyClassOffset - The highest offset known to contain an empty
71 /// base subobject.
Anders Carlsson725190f2010-10-31 21:39:24 +000072 CharUnits MaxEmptyClassOffset;
Anders Carlssoncc5de092010-06-08 15:56:03 +000073
Daniel Dunbar592a85c2010-05-27 02:25:46 +000074 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000075 /// member subobject that is empty.
76 void ComputeEmptySubobjectSizes();
Anders Carlsson439edd12010-05-27 05:41:06 +000077
Anders Carlsson725190f2010-10-31 21:39:24 +000078 void AddSubobjectAtOffset(const CXXRecordDecl *RD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000079
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000080 void UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlssoncc59cc52010-06-13 18:00:18 +000081 uint64_t Offset, bool PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +000082
Anders Carlssondb319762010-05-27 18:20:57 +000083 void UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
84 const CXXRecordDecl *Class,
85 uint64_t Offset);
86 void UpdateEmptyFieldSubobjects(const FieldDecl *FD, uint64_t Offset);
87
Anders Carlssoncc5de092010-06-08 15:56:03 +000088 /// AnyEmptySubobjectsBeyondOffset - Returns whether there are any empty
89 /// subobjects beyond the given offset.
Anders Carlsson725190f2010-10-31 21:39:24 +000090 bool AnyEmptySubobjectsBeyondOffset(CharUnits Offset) const {
Anders Carlssoncc5de092010-06-08 15:56:03 +000091 return Offset <= MaxEmptyClassOffset;
92 }
93
Anders Carlsson233e2722010-10-31 21:54:55 +000094 CharUnits
95 getFieldOffset(const ASTRecordLayout &Layout, unsigned FieldNo) const {
96 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
97 assert(FieldOffset % CharWidth == 0 &&
98 "Field offset not at char boundary!");
99
100 return CharUnits::fromQuantity(FieldOffset / CharWidth);
101 }
102
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000103 // FIXME: Remove these.
104 CharUnits toCharUnits(uint64_t Offset) const {
Anders Carlsson233e2722010-10-31 21:54:55 +0000105 return CharUnits::fromQuantity(Offset / CharWidth);
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000106 }
107 uint64_t toOffset(CharUnits Offset) const {
Anders Carlsson233e2722010-10-31 21:54:55 +0000108 return Offset.getQuantity() * CharWidth;
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000109 }
110
Charles Davisc2c576a2010-08-19 00:55:19 +0000111protected:
Anders Carlsson725190f2010-10-31 21:39:24 +0000112 bool CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
113 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000114
115 bool CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
116 uint64_t Offset);
117
118 bool CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
119 const CXXRecordDecl *Class,
120 uint64_t Offset) const;
121 bool CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
Anders Carlsson233e2722010-10-31 21:54:55 +0000122 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000123
Anders Carlssonf58de112010-05-26 15:32:58 +0000124public:
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000125 /// This holds the size of the largest empty subobject (either a base
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000126 /// or a member). Will be zero if the record being built doesn't contain
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000127 /// any empty classes.
128 uint64_t SizeOfLargestEmptySubobject;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000129
Anders Carlssonf58de112010-05-26 15:32:58 +0000130 EmptySubobjectMap(ASTContext &Context, const CXXRecordDecl *Class)
Anders Carlsson233e2722010-10-31 21:54:55 +0000131 : Context(Context), CharWidth(Context.getCharWidth()), Class(Class),
132 SizeOfLargestEmptySubobject(0) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000133 ComputeEmptySubobjectSizes();
134 }
135
136 /// CanPlaceBaseAtOffset - Return whether the given base class can be placed
137 /// at the given offset.
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000138 /// Returns false if placing the record will result in two components
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000139 /// (direct or indirect) of the same type having the same offset.
Anders Carlssoncc5de092010-06-08 15:56:03 +0000140 bool CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
141 uint64_t Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000142
143 /// CanPlaceFieldAtOffset - Return whether a field can be placed at the given
144 /// offset.
145 bool CanPlaceFieldAtOffset(const FieldDecl *FD, uint64_t Offset);
Anders Carlssonf58de112010-05-26 15:32:58 +0000146};
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000147
148void EmptySubobjectMap::ComputeEmptySubobjectSizes() {
149 // Check the bases.
150 for (CXXRecordDecl::base_class_const_iterator I = Class->bases_begin(),
151 E = Class->bases_end(); I != E; ++I) {
152 const CXXRecordDecl *BaseDecl =
153 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
154
155 uint64_t EmptySize = 0;
156 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
157 if (BaseDecl->isEmpty()) {
158 // If the class decl is empty, get its size.
159 EmptySize = Layout.getSize();
160 } else {
161 // Otherwise, we get the largest empty subobject for the decl.
162 EmptySize = Layout.getSizeOfLargestEmptySubobject();
163 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000164
165 SizeOfLargestEmptySubobject = std::max(SizeOfLargestEmptySubobject,
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000166 EmptySize);
167 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000168
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000169 // Check the fields.
170 for (CXXRecordDecl::field_iterator I = Class->field_begin(),
171 E = Class->field_end(); I != E; ++I) {
172 const FieldDecl *FD = *I;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000173
174 const RecordType *RT =
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000175 Context.getBaseElementType(FD->getType())->getAs<RecordType>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000176
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000177 // We only care about record types.
178 if (!RT)
179 continue;
180
181 uint64_t EmptySize = 0;
182 const CXXRecordDecl *MemberDecl = cast<CXXRecordDecl>(RT->getDecl());
183 const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
184 if (MemberDecl->isEmpty()) {
185 // If the class decl is empty, get its size.
186 EmptySize = Layout.getSize();
187 } else {
188 // Otherwise, we get the largest empty subobject for the decl.
189 EmptySize = Layout.getSizeOfLargestEmptySubobject();
190 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000191
192 SizeOfLargestEmptySubobject = std::max(SizeOfLargestEmptySubobject,
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000193 EmptySize);
194 }
195}
196
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000197bool
Anders Carlssondb319762010-05-27 18:20:57 +0000198EmptySubobjectMap::CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000199 CharUnits Offset) const {
Anders Carlssondb319762010-05-27 18:20:57 +0000200 // We only need to check empty bases.
201 if (!RD->isEmpty())
202 return true;
203
Anders Carlsson725190f2010-10-31 21:39:24 +0000204 EmptyClassOffsetsMapTy::const_iterator I = EmptyClassOffsets.find(Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000205 if (I == EmptyClassOffsets.end())
206 return true;
207
208 const ClassVectorTy& Classes = I->second;
209 if (std::find(Classes.begin(), Classes.end(), RD) == Classes.end())
210 return true;
211
212 // There is already an empty class of the same type at this offset.
213 return false;
214}
215
216void EmptySubobjectMap::AddSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000217 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000218 // We only care about empty bases.
219 if (!RD->isEmpty())
220 return;
221
Anders Carlsson725190f2010-10-31 21:39:24 +0000222 ClassVectorTy& Classes = EmptyClassOffsets[Offset];
Anders Carlssondb319762010-05-27 18:20:57 +0000223 assert(std::find(Classes.begin(), Classes.end(), RD) == Classes.end() &&
224 "Duplicate empty class detected!");
Anders Carlsson44687202010-06-08 19:09:24 +0000225
Anders Carlssondb319762010-05-27 18:20:57 +0000226 Classes.push_back(RD);
Anders Carlssoncc5de092010-06-08 15:56:03 +0000227
228 // Update the empty class offset.
Anders Carlsson725190f2010-10-31 21:39:24 +0000229 if (Offset > MaxEmptyClassOffset)
230 MaxEmptyClassOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000231}
232
233bool
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000234EmptySubobjectMap::CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson439edd12010-05-27 05:41:06 +0000235 uint64_t Offset) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000236 // We don't have to keep looking past the maximum offset that's known to
237 // contain an empty class.
Anders Carlsson725190f2010-10-31 21:39:24 +0000238 if (!AnyEmptySubobjectsBeyondOffset(toCharUnits(Offset)))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000239 return true;
240
Anders Carlsson725190f2010-10-31 21:39:24 +0000241 if (!CanPlaceSubobjectAtOffset(Info->Class, toCharUnits(Offset)))
Anders Carlssondb319762010-05-27 18:20:57 +0000242 return false;
243
Anders Carlsson439edd12010-05-27 05:41:06 +0000244 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000245 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000246 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000247 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000248 if (Base->IsVirtual)
249 continue;
250
Anders Carlsson439edd12010-05-27 05:41:06 +0000251 uint64_t BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
252
253 if (!CanPlaceBaseSubobjectAtOffset(Base, BaseOffset))
254 return false;
255 }
256
Anders Carlssone3c24c72010-05-29 17:35:14 +0000257 if (Info->PrimaryVirtualBaseInfo) {
258 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000259
260 if (Info == PrimaryVirtualBaseInfo->Derived) {
261 if (!CanPlaceBaseSubobjectAtOffset(PrimaryVirtualBaseInfo, Offset))
262 return false;
263 }
264 }
265
Anders Carlssondb319762010-05-27 18:20:57 +0000266 // Traverse all member variables.
267 unsigned FieldNo = 0;
268 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
269 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
270 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000271 if (FD->isBitField())
272 continue;
273
274 CharUnits FieldOffset =
275 toCharUnits(Offset) + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000276 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
277 return false;
278 }
279
Anders Carlsson439edd12010-05-27 05:41:06 +0000280 return true;
281}
282
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000283void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000284 uint64_t Offset,
285 bool PlacingEmptyBase) {
286 if (!PlacingEmptyBase && Offset >= SizeOfLargestEmptySubobject) {
287 // We know that the only empty subobjects that can conflict with empty
288 // subobject of non-empty bases, are empty bases that can be placed at
289 // offset zero. Because of this, we only need to keep track of empty base
290 // subobjects with offsets less than the size of the largest empty
291 // subobject for our class.
292 return;
293 }
294
Anders Carlsson725190f2010-10-31 21:39:24 +0000295 AddSubobjectAtOffset(Info->Class, toCharUnits(Offset));
Anders Carlssona7774a62010-05-29 21:10:24 +0000296
Anders Carlsson439edd12010-05-27 05:41:06 +0000297 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000298 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000299 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000300 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000301 if (Base->IsVirtual)
302 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000303
Anders Carlsson439edd12010-05-27 05:41:06 +0000304 uint64_t BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000305 UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000306 }
307
Anders Carlssone3c24c72010-05-29 17:35:14 +0000308 if (Info->PrimaryVirtualBaseInfo) {
309 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000310
311 if (Info == PrimaryVirtualBaseInfo->Derived)
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000312 UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
313 PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000314 }
Anders Carlssondb319762010-05-27 18:20:57 +0000315
Anders Carlssondb319762010-05-27 18:20:57 +0000316 // Traverse all member variables.
317 unsigned FieldNo = 0;
318 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
319 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
320 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000321 if (FD->isBitField())
322 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000323
Anders Carlsson233e2722010-10-31 21:54:55 +0000324 CharUnits FieldOffset =
325 toCharUnits(Offset) + getFieldOffset(Layout, FieldNo);
326 UpdateEmptyFieldSubobjects(FD, toOffset(FieldOffset));
Anders Carlssondb319762010-05-27 18:20:57 +0000327 }
Anders Carlsson439edd12010-05-27 05:41:06 +0000328}
329
Anders Carlssona60b86a2010-05-29 20:49:49 +0000330bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson439edd12010-05-27 05:41:06 +0000331 uint64_t Offset) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000332 // If we know this class doesn't have any empty subobjects we don't need to
333 // bother checking.
334 if (!SizeOfLargestEmptySubobject)
335 return true;
336
Anders Carlsson439edd12010-05-27 05:41:06 +0000337 if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
338 return false;
Anders Carlssondb319762010-05-27 18:20:57 +0000339
340 // We are able to place the base at this offset. Make sure to update the
341 // empty base subobject map.
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000342 UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000343 return true;
344}
345
Anders Carlssondb319762010-05-27 18:20:57 +0000346bool
347EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
348 const CXXRecordDecl *Class,
Anders Carlssoncc5de092010-06-08 15:56:03 +0000349 uint64_t Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000350 // We don't have to keep looking past the maximum offset that's known to
351 // contain an empty class.
Anders Carlsson725190f2010-10-31 21:39:24 +0000352 if (!AnyEmptySubobjectsBeyondOffset(toCharUnits(Offset)))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000353 return true;
354
Anders Carlsson725190f2010-10-31 21:39:24 +0000355 if (!CanPlaceSubobjectAtOffset(RD, toCharUnits(Offset)))
Anders Carlssondb319762010-05-27 18:20:57 +0000356 return false;
357
358 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
359
360 // Traverse all non-virtual bases.
361 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
362 E = RD->bases_end(); I != E; ++I) {
363 if (I->isVirtual())
364 continue;
365
366 const CXXRecordDecl *BaseDecl =
367 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
368
369 uint64_t BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
370 if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
371 return false;
372 }
373
Anders Carlsson44687202010-06-08 19:09:24 +0000374 if (RD == Class) {
375 // This is the most derived class, traverse virtual bases as well.
376 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
377 E = RD->vbases_end(); I != E; ++I) {
378 const CXXRecordDecl *VBaseDecl =
379 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
380
381 uint64_t VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
382 if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
383 return false;
384 }
385 }
386
Anders Carlssondb319762010-05-27 18:20:57 +0000387 // Traverse all member variables.
388 unsigned FieldNo = 0;
389 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
390 I != E; ++I, ++FieldNo) {
391 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000392 if (FD->isBitField())
393 continue;
394
395 CharUnits FieldOffset =
396 toCharUnits(Offset) + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000397
398 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
399 return false;
400 }
401
402 return true;
403}
404
Anders Carlsson233e2722010-10-31 21:54:55 +0000405bool
406EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
407 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000408 // We don't have to keep looking past the maximum offset that's known to
409 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000410 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000411 return true;
412
Anders Carlssondb319762010-05-27 18:20:57 +0000413 QualType T = FD->getType();
414 if (const RecordType *RT = T->getAs<RecordType>()) {
415 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Anders Carlsson233e2722010-10-31 21:54:55 +0000416 return CanPlaceFieldSubobjectAtOffset(RD, RD, toOffset(Offset));
Anders Carlssondb319762010-05-27 18:20:57 +0000417 }
418
419 // If we have an array type we need to look at every element.
420 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
421 QualType ElemTy = Context.getBaseElementType(AT);
422 const RecordType *RT = ElemTy->getAs<RecordType>();
423 if (!RT)
424 return true;
425
426 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
427 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
428
429 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson233e2722010-10-31 21:54:55 +0000430 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000431 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000432 // We don't have to keep looking past the maximum offset that's known to
433 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000434 if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000435 return true;
436
Anders Carlsson233e2722010-10-31 21:54:55 +0000437 if (!CanPlaceFieldSubobjectAtOffset(RD, RD, toOffset(ElementOffset)))
Anders Carlssondb319762010-05-27 18:20:57 +0000438 return false;
439
Anders Carlsson233e2722010-10-31 21:54:55 +0000440 ElementOffset += toCharUnits(Layout.getSize());
Anders Carlssondb319762010-05-27 18:20:57 +0000441 }
442 }
443
444 return true;
445}
446
447bool
448EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD, uint64_t Offset) {
Anders Carlsson233e2722010-10-31 21:54:55 +0000449 if (!CanPlaceFieldSubobjectAtOffset(FD, toCharUnits(Offset)))
Anders Carlssondb319762010-05-27 18:20:57 +0000450 return false;
451
452 // We are able to place the member variable at this offset.
453 // Make sure to update the empty base subobject map.
454 UpdateEmptyFieldSubobjects(FD, Offset);
455 return true;
456}
457
458void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
459 const CXXRecordDecl *Class,
460 uint64_t Offset) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000461 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000462 // field subobjects are subobjects of empty bases that can be placed at offset
Anders Carlssonae111dc2010-06-13 17:49:16 +0000463 // zero. Because of this, we only need to keep track of empty field
464 // subobjects with offsets less than the size of the largest empty
465 // subobject for our class.
466 if (Offset >= SizeOfLargestEmptySubobject)
467 return;
468
Anders Carlsson725190f2010-10-31 21:39:24 +0000469 AddSubobjectAtOffset(RD, toCharUnits(Offset));
Anders Carlssondb319762010-05-27 18:20:57 +0000470
471 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
472
473 // Traverse all non-virtual bases.
474 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
475 E = RD->bases_end(); I != E; ++I) {
476 if (I->isVirtual())
477 continue;
478
479 const CXXRecordDecl *BaseDecl =
480 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
481
482 uint64_t BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
483 UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
484 }
485
Anders Carlsson44687202010-06-08 19:09:24 +0000486 if (RD == Class) {
487 // This is the most derived class, traverse virtual bases as well.
488 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
489 E = RD->vbases_end(); I != E; ++I) {
490 const CXXRecordDecl *VBaseDecl =
491 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
492
493 uint64_t VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
494 UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
495 }
496 }
497
Anders Carlssondb319762010-05-27 18:20:57 +0000498 // Traverse all member variables.
499 unsigned FieldNo = 0;
500 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
501 I != E; ++I, ++FieldNo) {
502 const FieldDecl *FD = *I;
503
Anders Carlsson233e2722010-10-31 21:54:55 +0000504 CharUnits FieldOffset =
505 toCharUnits(Offset) + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000506
Anders Carlsson233e2722010-10-31 21:54:55 +0000507 UpdateEmptyFieldSubobjects(FD, toOffset(FieldOffset));
Anders Carlssondb319762010-05-27 18:20:57 +0000508 }
509}
510
511void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
512 uint64_t Offset) {
513 QualType T = FD->getType();
514 if (const RecordType *RT = T->getAs<RecordType>()) {
515 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
516 UpdateEmptyFieldSubobjects(RD, RD, Offset);
517 return;
518 }
519
520 // If we have an array type we need to update every element.
521 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
522 QualType ElemTy = Context.getBaseElementType(AT);
523 const RecordType *RT = ElemTy->getAs<RecordType>();
524 if (!RT)
525 return;
526
527 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
528 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
529
530 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
531 uint64_t ElementOffset = Offset;
532
533 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000534 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000535 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlssonae111dc2010-06-13 17:49:16 +0000536 // offset zero. Because of this, we only need to keep track of empty field
537 // subobjects with offsets less than the size of the largest empty
538 // subobject for our class.
539 if (ElementOffset >= SizeOfLargestEmptySubobject)
540 return;
541
Anders Carlssondb319762010-05-27 18:20:57 +0000542 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
543 ElementOffset += Layout.getSize();
544 }
545 }
546}
547
Anders Carlssonc2226202010-05-26 05:58:59 +0000548class RecordLayoutBuilder {
Charles Davisc2c576a2010-08-19 00:55:19 +0000549protected:
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000550 // FIXME: Remove this and make the appropriate fields public.
551 friend class clang::ASTContext;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000552
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000553 ASTContext &Context;
554
Anders Carlssonf58de112010-05-26 15:32:58 +0000555 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000556
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000557 /// Size - The current size of the record layout.
558 uint64_t Size;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000559
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000560 /// Alignment - The current alignment of the record layout.
561 unsigned Alignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000562
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000563 /// \brief The alignment if attribute packed is not used.
564 unsigned UnpackedAlignment;
565
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000566 llvm::SmallVector<uint64_t, 16> FieldOffsets;
567
568 /// Packed - Whether the record is packed or not.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000569 unsigned Packed : 1;
570
571 unsigned IsUnion : 1;
572
573 unsigned IsMac68kAlign : 1;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000574
575 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
576 /// this contains the number of bits in the last byte that can be used for
577 /// an adjacent bitfield if necessary.
578 unsigned char UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000579
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000580 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000581 /// #pragma pack.
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000582 unsigned MaxFieldAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000583
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000584 /// DataSize - The data size of the record being laid out.
585 uint64_t DataSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000586
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000587 uint64_t NonVirtualSize;
588 unsigned NonVirtualAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000589
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000590 /// PrimaryBase - the primary base class (if one exists) of the class
591 /// we're laying out.
592 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000593
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000594 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
595 /// out is virtual.
596 bool PrimaryBaseIsVirtual;
597
Anders Carlsson22f57202010-10-31 21:01:46 +0000598 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000599
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000600 /// Bases - base classes and their offsets in the record.
601 BaseOffsetsMapTy Bases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000602
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000603 // VBases - virtual base classes and their offsets in the record.
604 BaseOffsetsMapTy VBases;
605
606 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
607 /// primary base classes for some other direct or indirect base class.
608 llvm::SmallSet<const CXXRecordDecl*, 32> IndirectPrimaryBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000609
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000610 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
611 /// inheritance graph order. Used for determining the primary base class.
612 const CXXRecordDecl *FirstNearlyEmptyVBase;
613
614 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
615 /// avoid visiting virtual bases more than once.
616 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000617
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000618 RecordLayoutBuilder(ASTContext &Context, EmptySubobjectMap *EmptySubobjects)
619 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0), Alignment(8),
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000620 UnpackedAlignment(Alignment), Packed(false), IsUnion(false),
621 IsMac68kAlign(false), UnfilledBitsInLastByte(0), MaxFieldAlignment(0),
622 DataSize(0), NonVirtualSize(0), NonVirtualAlignment(8), PrimaryBase(0),
Daniel Dunbar6da10982010-05-27 05:45:51 +0000623 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0) { }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000624
Anders Carlsson725190f2010-10-31 21:39:24 +0000625 // FIXME: Remove these.
626 CharUnits toCharUnits(uint64_t Offset) const {
627 return CharUnits::fromQuantity(Offset / Context.getCharWidth());
628 }
629 uint64_t toOffset(CharUnits Offset) const {
630 return Offset.getQuantity() * Context.getCharWidth();
631 }
632
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000633 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000634 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000635 void Layout(const ObjCInterfaceDecl *D);
636
637 void LayoutFields(const RecordDecl *D);
638 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000639 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
640 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000641 void LayoutBitField(const FieldDecl *D);
642
Anders Carlssone3c24c72010-05-29 17:35:14 +0000643 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
644 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
645
646 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
647 BaseSubobjectInfoMapTy;
648
649 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
650 /// of the class we're laying out to their base subobject info.
651 BaseSubobjectInfoMapTy VirtualBaseInfo;
652
653 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
654 /// class we're laying out to their base subobject info.
655 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
656
657 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
658 /// bases of the given class.
659 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
660
661 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
662 /// single class and all of its base classes.
663 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
664 bool IsVirtual,
665 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000666
667 /// DeterminePrimaryBase - Determine the primary base of the given class.
668 void DeterminePrimaryBase(const CXXRecordDecl *RD);
669
670 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000671
Charles Davisc2c576a2010-08-19 00:55:19 +0000672 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
673
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000674 /// IdentifyPrimaryBases - Identify all virtual base classes, direct or
675 /// indirect, that are primary base classes for some other direct or indirect
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000676 /// base class.
677 void IdentifyPrimaryBases(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000678
Charles Davisc2c576a2010-08-19 00:55:19 +0000679 virtual bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000680
681 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000682 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
683 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
684
685 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000686 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000687
Anders Carlsson6b0d9142010-05-29 19:44:50 +0000688 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Charles Davisc2c576a2010-08-19 00:55:19 +0000689 uint64_t Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000690
691 /// LayoutVirtualBases - Lays out all the virtual bases.
692 void LayoutVirtualBases(const CXXRecordDecl *RD,
693 const CXXRecordDecl *MostDerivedClass);
694
695 /// LayoutVirtualBase - Lays out a single virtual base.
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000696 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000697
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000698 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000699 /// placed, in bits.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +0000700 uint64_t LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000701
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000702 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000703 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000704
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000705 /// FinishLayout - Finalize record layout. Adjust record size based on the
706 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000707 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000708
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000709 void UpdateAlignment(unsigned NewAlignment, unsigned UnpackedNewAlignment);
710 void UpdateAlignment(unsigned NewAlignment) {
711 UpdateAlignment(NewAlignment, NewAlignment);
712 }
713
714 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
715 uint64_t UnpackedOffset, unsigned UnpackedAlign,
716 bool isPacked, const FieldDecl *D);
717
718 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000719
Argyrios Kyrtzidis499e6e42010-08-15 10:17:39 +0000720 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
721 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000722public:
723 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +0000724
725 virtual ~RecordLayoutBuilder() { }
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000726};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000727} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000728
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000729/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
730/// no other data.
Anders Carlssonc2226202010-05-26 05:58:59 +0000731bool RecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000732 // FIXME: Audit the corners
733 if (!RD->isDynamicClass())
734 return false;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000735 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
736 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0))
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000737 return true;
738 return false;
739}
740
Anders Carlssonc2226202010-05-26 05:58:59 +0000741void RecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000742 const ASTRecordLayout::PrimaryBaseInfo &BaseInfo =
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000743 Context.getASTRecordLayout(RD).getPrimaryBaseInfo();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000744
Anders Carlsson81430692009-09-22 03:02:06 +0000745 // If the record has a primary base class that is virtual, add it to the set
746 // of primary bases.
Anders Carlssona30c0d32009-11-27 22:14:40 +0000747 if (BaseInfo.isVirtual())
748 IndirectPrimaryBases.insert(BaseInfo.getBase());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000749
Anders Carlsson81430692009-09-22 03:02:06 +0000750 // Now traverse all bases and find primary bases for them.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000751 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000752 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000753 assert(!i->getType()->isDependentType() &&
754 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000755 const CXXRecordDecl *Base =
Mike Stump78696a72009-08-11 04:03:59 +0000756 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000757
Mike Stump78696a72009-08-11 04:03:59 +0000758 // Only bases with virtual bases participate in computing the
759 // indirect primary virtual base classes.
Mike Stumpc2f591b2009-08-13 22:53:07 +0000760 if (Base->getNumVBases())
Anders Carlsson81430692009-09-22 03:02:06 +0000761 IdentifyPrimaryBases(Base);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000762 }
763}
764
Anders Carlsson81430692009-09-22 03:02:06 +0000765void
Anders Carlssonc2226202010-05-26 05:58:59 +0000766RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000767 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000768 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000769 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000770 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000771
Mike Stump11289f42009-09-09 15:08:12 +0000772 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000773 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000774
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000775 // Check if this is a nearly empty virtual base.
776 if (I->isVirtual() && IsNearlyEmpty(Base)) {
777 // If it's not an indirect primary base, then we've found our primary
778 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000779 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000780 PrimaryBase = Base;
781 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000782 return;
783 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000784
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000785 // Is this the first nearly empty virtual base?
786 if (!FirstNearlyEmptyVBase)
787 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000788 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000789
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000790 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000791 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000792 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000793 }
794}
795
Charles Davisc2c576a2010-08-19 00:55:19 +0000796uint64_t
797RecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
798 return Context.Target.getPointerWidth(0);
799}
800
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000801/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000802void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000803 // If the class isn't dynamic, it won't have a primary base.
804 if (!RD->isDynamicClass())
805 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000806
Anders Carlsson81430692009-09-22 03:02:06 +0000807 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000808 // indirect bases, and record all their primary virtual base classes.
Mike Stump590a7c72009-08-13 23:26:06 +0000809 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000810 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000811 assert(!i->getType()->isDependentType() &&
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000812 "Cannot lay out class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000813 const CXXRecordDecl *Base =
Mike Stump590a7c72009-08-13 23:26:06 +0000814 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +0000815 IdentifyPrimaryBases(Base);
Mike Stump590a7c72009-08-13 23:26:06 +0000816 }
817
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000818 // If the record has a dynamic base class, attempt to choose a primary base
819 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000820 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000821 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000822 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000823 // Ignore virtual bases.
824 if (i->isVirtual())
825 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000826
Anders Carlsson03ff3792009-11-27 22:05:05 +0000827 const CXXRecordDecl *Base =
828 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
829
830 if (Base->isDynamicClass()) {
831 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000832 PrimaryBase = Base;
833 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000834 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000835 }
836 }
837
838 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000839 // indirect primary virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000840 if (RD->getNumVBases() != 0) {
841 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000842 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000843 return;
844 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000845
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000846 // Otherwise, it is the first nearly empty virtual base that is not an
847 // indirect primary virtual base class, if one exists.
848 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000849 PrimaryBase = FirstNearlyEmptyVBase;
850 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000851 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000852 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000853
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000854 // Otherwise there is no primary base class.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000855 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000856
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000857 // Allocate the virtual table pointer at offset zero.
858 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000859
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000860 // Update the size.
Charles Davisc2c576a2010-08-19 00:55:19 +0000861 Size += GetVirtualPointersSize(RD);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000862 DataSize = Size;
863
864 // Update the alignment.
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000865 UpdateAlignment(Context.Target.getPointerAlign(0));
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000866}
867
Anders Carlssone3c24c72010-05-29 17:35:14 +0000868BaseSubobjectInfo *
869RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
870 bool IsVirtual,
871 BaseSubobjectInfo *Derived) {
872 BaseSubobjectInfo *Info;
873
874 if (IsVirtual) {
875 // Check if we already have info about this virtual base.
876 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
877 if (InfoSlot) {
878 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
879 return InfoSlot;
880 }
881
882 // We don't, create it.
883 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
884 Info = InfoSlot;
885 } else {
886 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
887 }
888
889 Info->Class = RD;
890 Info->IsVirtual = IsVirtual;
891 Info->Derived = 0;
892 Info->PrimaryVirtualBaseInfo = 0;
893
894 const CXXRecordDecl *PrimaryVirtualBase = 0;
895 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
896
897 // Check if this base has a primary virtual base.
898 if (RD->getNumVBases()) {
899 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
900 if (Layout.getPrimaryBaseWasVirtual()) {
901 // This base does have a primary virtual base.
902 PrimaryVirtualBase = Layout.getPrimaryBase();
903 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
904
905 // Now check if we have base subobject info about this primary base.
906 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
907
908 if (PrimaryVirtualBaseInfo) {
909 if (PrimaryVirtualBaseInfo->Derived) {
910 // We did have info about this primary base, and it turns out that it
911 // has already been claimed as a primary virtual base for another
912 // base.
913 PrimaryVirtualBase = 0;
914 } else {
915 // We can claim this base as our primary base.
916 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
917 PrimaryVirtualBaseInfo->Derived = Info;
918 }
919 }
920 }
921 }
922
923 // Now go through all direct bases.
924 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
925 E = RD->bases_end(); I != E; ++I) {
926 bool IsVirtual = I->isVirtual();
927
928 const CXXRecordDecl *BaseDecl =
929 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
930
931 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
932 }
933
934 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
935 // Traversing the bases must have created the base info for our primary
936 // virtual base.
937 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
938 assert(PrimaryVirtualBaseInfo &&
939 "Did not create a primary virtual base!");
940
941 // Claim the primary virtual base as our primary virtual base.
942 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
943 PrimaryVirtualBaseInfo->Derived = Info;
944 }
945
946 return Info;
947}
948
949void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
950 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
951 E = RD->bases_end(); I != E; ++I) {
952 bool IsVirtual = I->isVirtual();
953
954 const CXXRecordDecl *BaseDecl =
955 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
956
957 // Compute the base subobject info for this base.
958 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
959
960 if (IsVirtual) {
961 // ComputeBaseInfo has already added this base for us.
962 assert(VirtualBaseInfo.count(BaseDecl) &&
963 "Did not add virtual base!");
964 } else {
965 // Add the base info to the map of non-virtual bases.
966 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
967 "Non-virtual base already exists!");
968 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
969 }
970 }
971}
972
Anders Carlsson09ffa322010-03-10 22:21:28 +0000973void
Anders Carlssonc2226202010-05-26 05:58:59 +0000974RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000975 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000976 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000977
Anders Carlssone3c24c72010-05-29 17:35:14 +0000978 // Compute base subobject info.
979 ComputeBaseSubobjectInfo(RD);
980
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000981 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000982 if (PrimaryBase) {
983 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000984 // If the primary virtual base was a primary virtual base of some other
985 // base class we'll have to steal it.
986 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
987 PrimaryBaseInfo->Derived = 0;
988
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000989 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000990 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +0000991
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000992 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000993 "vbase already visited!");
994 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000995
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000996 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000997 } else {
998 BaseSubobjectInfo *PrimaryBaseInfo =
999 NonVirtualBaseInfo.lookup(PrimaryBase);
1000 assert(PrimaryBaseInfo &&
1001 "Did not find base info for non-virtual primary base!");
1002
1003 LayoutNonVirtualBase(PrimaryBaseInfo);
1004 }
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001005 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001006
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001007 // Now lay out the non-virtual bases.
1008 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001009 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001010
1011 // Ignore virtual bases.
1012 if (I->isVirtual())
1013 continue;
1014
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001015 const CXXRecordDecl *BaseDecl =
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001016 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1017
1018 // Skip the primary base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001019 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001020 continue;
1021
1022 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001023 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
1024 assert(BaseInfo && "Did not find base info for non-virtual base!");
1025
1026 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001027 }
1028}
1029
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001030void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001031 // Layout the base.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001032 uint64_t Offset = LayoutBase(Base);
Anders Carlsson22f57202010-10-31 21:01:46 +00001033 CharUnits OffsetInChars =
1034 CharUnits::fromQuantity(Offset / Context.getCharWidth());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001035
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001036 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001037 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlsson22f57202010-10-31 21:01:46 +00001038 Bases.insert(std::make_pair(Base->Class, OffsetInChars));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001039
1040 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001041}
Mike Stump2b84dd32009-11-05 04:02:15 +00001042
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001043void
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001044RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
1045 uint64_t Offset) {
1046 // This base isn't interesting, it has no virtual bases.
1047 if (!Info->Class->getNumVBases())
1048 return;
1049
1050 // First, check if we have a virtual primary base to add offsets for.
1051 if (Info->PrimaryVirtualBaseInfo) {
1052 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1053 "Primary virtual base is not virtual!");
1054 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1055 // Add the offset.
1056 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1057 "primary vbase offset already exists!");
Anders Carlsson22f57202010-10-31 21:01:46 +00001058 CharUnits OffsetInChars =
1059 CharUnits::fromQuantity(Offset / Context.getCharWidth());
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001060 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
Anders Carlsson22f57202010-10-31 21:01:46 +00001061 OffsetInChars));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001062
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001063 // Traverse the primary virtual base.
1064 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1065 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001066 }
1067
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001068 // Now go through all direct non-virtual bases.
1069 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1070 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1071 const BaseSubobjectInfo *Base = Info->Bases[I];
1072 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001073 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001074
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001075 uint64_t BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
1076 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001077 }
1078}
1079
1080void
Anders Carlssonc2226202010-05-26 05:58:59 +00001081RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +00001082 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001083 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001084 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001085
Anders Carlsson291279e2010-04-10 18:42:27 +00001086 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001087 PrimaryBase = this->PrimaryBase;
1088 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001089 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001090 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001091 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson291279e2010-04-10 18:42:27 +00001092 PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
1093 }
1094
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001095 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1096 E = RD->bases_end(); I != E; ++I) {
1097 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001098 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001099
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001100 const CXXRecordDecl *BaseDecl =
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001101 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1102
1103 if (I->isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001104 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1105 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001106
Anders Carlsson291279e2010-04-10 18:42:27 +00001107 // Only lay out the virtual base if it's not an indirect primary base.
1108 if (!IndirectPrimaryBase) {
1109 // Only visit virtual bases once.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001110 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlsson291279e2010-04-10 18:42:27 +00001111 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001112
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001113 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1114 assert(BaseInfo && "Did not find virtual base info!");
1115 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001116 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001117 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001118 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001119
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001120 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001121 // This base isn't interesting since it doesn't have any virtual bases.
1122 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001123 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001124
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001125 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001126 }
1127}
1128
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001129void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001130 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1131
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001132 // Layout the base.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001133 uint64_t Offset = LayoutBase(Base);
Anders Carlsson22f57202010-10-31 21:01:46 +00001134 CharUnits OffsetInChars =
1135 CharUnits::fromQuantity(Offset / Context.getCharWidth());
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001136
1137 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001138 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
Anders Carlsson22f57202010-10-31 21:01:46 +00001139 VBases.insert(std::make_pair(Base->Class, OffsetInChars));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001140
1141 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001142}
1143
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001144uint64_t RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
1145 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001146
1147 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001148 if (Base->Class->isEmpty() &&
Anders Carlssonb1fcdd02010-05-30 06:52:33 +00001149 EmptySubobjects->CanPlaceBaseAtOffset(Base, 0)) {
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001150 Size = std::max(Size, Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001151
1152 return 0;
1153 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001154
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001155 unsigned BaseAlign = Layout.getNonVirtualAlign();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001156
Anders Carlsson09ffa322010-03-10 22:21:28 +00001157 // Round up the current record size to the base's alignment boundary.
1158 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001159
Anders Carlsson09ffa322010-03-10 22:21:28 +00001160 // Try to place the base.
Anders Carlssonb1fcdd02010-05-30 06:52:33 +00001161 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset))
Anders Carlsson09ffa322010-03-10 22:21:28 +00001162 Offset += BaseAlign;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001163
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001164 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001165 // Update the data size.
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001166 DataSize = Offset + Layout.getNonVirtualSize();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001167
1168 Size = std::max(Size, DataSize);
1169 } else
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001170 Size = std::max(Size, Offset + Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001171
1172 // Remember max struct/class alignment.
1173 UpdateAlignment(BaseAlign);
1174
Anders Carlsson09ffa322010-03-10 22:21:28 +00001175 return Offset;
1176}
1177
Daniel Dunbar6da10982010-05-27 05:45:51 +00001178void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
1179 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1180 IsUnion = RD->isUnion();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001181
Anders Carlsson28a5fa22009-08-08 19:38:24 +00001182 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001183
Daniel Dunbar6da10982010-05-27 05:45:51 +00001184 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1185 // and forces all structures to have 2-byte alignment. The IBM docs on it
1186 // allude to additional (more complicated) semantics, especially with regard
1187 // to bit-fields, but gcc appears not to follow that.
1188 if (D->hasAttr<AlignMac68kAttr>()) {
1189 IsMac68kAlign = true;
1190 MaxFieldAlignment = 2 * 8;
1191 Alignment = 2 * 8;
1192 } else {
1193 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
1194 MaxFieldAlignment = MFAA->getAlignment();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001195
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001196 if (unsigned MaxAlign = D->getMaxAlignment())
1197 UpdateAlignment(MaxAlign);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001198 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001199}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001200
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001201void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1202 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001203 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001204
Anders Carlsson79474332009-07-18 20:20:21 +00001205 // Finally, round the size of the total struct up to the alignment of the
1206 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001207 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001208}
1209
1210void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1211 InitializeLayout(RD);
1212
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001213 // Lay out the vtable and the non-virtual bases.
1214 LayoutNonVirtualBases(RD);
1215
1216 LayoutFields(RD);
1217
1218 NonVirtualSize = Size;
1219 NonVirtualAlignment = Alignment;
1220
1221 // Lay out the virtual bases and add the primary virtual base offsets.
1222 LayoutVirtualBases(RD, RD);
1223
1224 VisitedVirtualBases.clear();
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001225
1226 // Finally, round the size of the total struct up to the alignment of the
1227 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001228 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001229
Anders Carlsson5b441d72010-04-10 21:24:48 +00001230#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001231 // Check that we have base offsets for all bases.
1232 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1233 E = RD->bases_end(); I != E; ++I) {
1234 if (I->isVirtual())
1235 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001236
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001237 const CXXRecordDecl *BaseDecl =
1238 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1239
1240 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1241 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001242
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001243 // And all virtual bases.
1244 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1245 E = RD->vbases_end(); I != E; ++I) {
1246 const CXXRecordDecl *BaseDecl =
1247 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001248
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001249 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001250 }
1251#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001252}
1253
Anders Carlssonc2226202010-05-26 05:58:59 +00001254void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001255 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001256 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001257
1258 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +00001259
Anders Carlsson4f516282009-07-18 20:50:59 +00001260 // We start laying out ivars not at the end of the superclass
1261 // structure, but at the next byte following the last field.
Anders Carlsson27b50132009-07-18 21:26:44 +00001262 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlsson47680d82009-09-26 01:34:51 +00001263 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +00001264 }
Mike Stump11289f42009-09-09 15:08:12 +00001265
Daniel Dunbar6da10982010-05-27 05:45:51 +00001266 InitializeLayout(D);
Daniel Dunbar40130442010-05-27 01:12:46 +00001267
Anders Carlsson4f516282009-07-18 20:50:59 +00001268 // Layout each ivar sequentially.
1269 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001270 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson4f516282009-07-18 20:50:59 +00001271 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
1272 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +00001273
Anders Carlsson4f516282009-07-18 20:50:59 +00001274 // Finally, round the size of the total struct up to the alignment of the
1275 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001276 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001277}
1278
Anders Carlssonc2226202010-05-26 05:58:59 +00001279void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001280 // Layout each field, for now, just sequentially, respecting alignment. In
1281 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +00001282 for (RecordDecl::field_iterator Field = D->field_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001283 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
Anders Carlsson118ce162009-07-18 21:48:39 +00001284 LayoutField(*Field);
1285}
1286
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001287void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001288 uint64_t TypeSize,
1289 bool FieldPacked,
1290 const FieldDecl *D) {
Anders Carlsson57235162010-04-16 15:57:11 +00001291 assert(Context.getLangOptions().CPlusPlus &&
1292 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001293
Anders Carlsson57235162010-04-16 15:57:11 +00001294 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001295 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001296 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001297
Anders Carlsson57235162010-04-16 15:57:11 +00001298 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001299 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001300 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1301 };
1302
Anders Carlsson57235162010-04-16 15:57:11 +00001303 QualType Type;
1304 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1305 I != E; ++I) {
1306 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +00001307
1308 if (Size > FieldSize)
1309 break;
1310
1311 Type = IntegralPODTypes[I];
1312 }
1313 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001314
Anders Carlsson57235162010-04-16 15:57:11 +00001315 unsigned TypeAlign = Context.getTypeAlign(Type);
1316
1317 // We're not going to use any of the unfilled bits in the last byte.
1318 UnfilledBitsInLastByte = 0;
1319
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001320 uint64_t FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001321 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001322
Anders Carlsson57235162010-04-16 15:57:11 +00001323 if (IsUnion) {
1324 DataSize = std::max(DataSize, FieldSize);
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001325 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001326 } else {
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001327 // The bitfield is allocated starting at the next offset aligned appropriately
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001328 // for T', with length n bits.
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001329 FieldOffset = llvm::RoundUpToAlignment(DataSize, TypeAlign);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001330
Anders Carlsson57235162010-04-16 15:57:11 +00001331 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001332
Anders Carlsson57235162010-04-16 15:57:11 +00001333 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1334 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1335 }
1336
1337 // Place this field at the current location.
1338 FieldOffsets.push_back(FieldOffset);
1339
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001340 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
1341 TypeAlign, FieldPacked, D);
1342
Anders Carlsson57235162010-04-16 15:57:11 +00001343 // Update the size.
1344 Size = std::max(Size, DataSize);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001345
Anders Carlsson57235162010-04-16 15:57:11 +00001346 // Remember max struct/class alignment.
1347 UpdateAlignment(TypeAlign);
1348}
1349
Anders Carlssonc2226202010-05-26 05:58:59 +00001350void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001351 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001352 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1353 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001354 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001355
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001356 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001357 uint64_t TypeSize = FieldInfo.first;
1358 unsigned FieldAlign = FieldInfo.second;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001359
Anders Carlsson57235162010-04-16 15:57:11 +00001360 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001361 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001362 return;
1363 }
1364
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001365 // The align if the field is not packed. This is to check if the attribute
1366 // was unnecessary (-Wpacked).
1367 unsigned UnpackedFieldAlign = FieldAlign;
1368 uint64_t UnpackedFieldOffset = FieldOffset;
1369 if (!Context.Target.useBitFieldTypeAlignment())
1370 UnpackedFieldAlign = 1;
1371
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001372 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson07209442009-11-22 17:37:31 +00001373 FieldAlign = 1;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001374 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001375 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001376
1377 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001378 if (MaxFieldAlignment) {
Anders Carlsson07209442009-11-22 17:37:31 +00001379 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001380 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1381 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001382
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001383 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001384 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
Daniel Dunbarf35e7652010-06-29 18:34:35 +00001385 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001386
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001387 if (FieldSize == 0 ||
1388 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize)
1389 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1390 UnpackedFieldAlign);
1391
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001392 // Padding members don't affect overall alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001393 if (!D->getIdentifier())
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001394 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001395
Anders Carlsson07209442009-11-22 17:37:31 +00001396 // Place this field at the current location.
1397 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001398
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001399 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1400 UnpackedFieldAlign, FieldPacked, D);
1401
Anders Carlssonba958402009-11-22 19:13:51 +00001402 // Update DataSize to include the last byte containing (part of) the bitfield.
1403 if (IsUnion) {
1404 // FIXME: I think FieldSize should be TypeSize here.
1405 DataSize = std::max(DataSize, FieldSize);
1406 } else {
1407 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001408
Anders Carlssonba958402009-11-22 19:13:51 +00001409 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1410 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1411 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001412
Anders Carlssonba958402009-11-22 19:13:51 +00001413 // Update the size.
1414 Size = std::max(Size, DataSize);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001415
Anders Carlsson07209442009-11-22 17:37:31 +00001416 // Remember max struct/class alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001417 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson07209442009-11-22 17:37:31 +00001418}
1419
Anders Carlssonc2226202010-05-26 05:58:59 +00001420void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001421 if (D->isBitField()) {
1422 LayoutBitField(D);
1423 return;
1424 }
1425
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001426 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1427
Anders Carlssonba958402009-11-22 19:13:51 +00001428 // Reset the unfilled bits.
1429 UnfilledBitsInLastByte = 0;
1430
Anders Carlsson07209442009-11-22 17:37:31 +00001431 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlsson47680d82009-09-26 01:34:51 +00001432 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +00001433 uint64_t FieldSize;
1434 unsigned FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001435
Anders Carlsson07209442009-11-22 17:37:31 +00001436 if (D->getType()->isIncompleteArrayType()) {
1437 // This is a flexible array member; we can't directly
1438 // query getTypeInfo about these, so we figure it out here.
1439 // Flexible array members don't have any size, but they
1440 // have to be aligned appropriately for their element type.
1441 FieldSize = 0;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001442 const ArrayType* ATy = Context.getAsArrayType(D->getType());
1443 FieldAlign = Context.getTypeAlign(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001444 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1445 unsigned AS = RT->getPointeeType().getAddressSpace();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001446 FieldSize = Context.Target.getPointerWidth(AS);
1447 FieldAlign = Context.Target.getPointerAlign(AS);
Anders Carlsson79474332009-07-18 20:20:21 +00001448 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001449 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001450 FieldSize = FieldInfo.first;
1451 FieldAlign = FieldInfo.second;
Anders Carlsson79474332009-07-18 20:20:21 +00001452 }
Mike Stump11289f42009-09-09 15:08:12 +00001453
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001454 // The align if the field is not packed. This is to check if the attribute
1455 // was unnecessary (-Wpacked).
1456 unsigned UnpackedFieldAlign = FieldAlign;
1457 uint64_t UnpackedFieldOffset = FieldOffset;
1458
Anders Carlsson07209442009-11-22 17:37:31 +00001459 if (FieldPacked)
1460 FieldAlign = 8;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001461 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001462 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001463
1464 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001465 if (MaxFieldAlignment) {
Anders Carlsson07209442009-11-22 17:37:31 +00001466 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001467 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1468 }
Anders Carlsson07209442009-11-22 17:37:31 +00001469
1470 // Round up the current record size to the field's alignment boundary.
1471 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001472 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1473 UnpackedFieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001474
Anders Carlssonb1fcdd02010-05-30 06:52:33 +00001475 if (!IsUnion && EmptySubobjects) {
1476 // Check if we can place the field at this offset.
1477 while (!EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset)) {
Anders Carlsson07209442009-11-22 17:37:31 +00001478 // We couldn't place the field at the offset. Try again at a new offset.
1479 FieldOffset += FieldAlign;
1480 }
Anders Carlsson07209442009-11-22 17:37:31 +00001481 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001482
Anders Carlsson79474332009-07-18 20:20:21 +00001483 // Place this field at the current location.
1484 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +00001485
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001486 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1487 UnpackedFieldAlign, FieldPacked, D);
1488
Anders Carlsson79474332009-07-18 20:20:21 +00001489 // Reserve space for this field.
1490 if (IsUnion)
1491 Size = std::max(Size, FieldSize);
1492 else
1493 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +00001494
Anders Carlsson47680d82009-09-26 01:34:51 +00001495 // Update the data size.
1496 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +00001497
Anders Carlsson79474332009-07-18 20:20:21 +00001498 // Remember max struct/class alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001499 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001500}
1501
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001502void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +00001503 // In C++, records cannot be of size 0.
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001504 if (Context.getLangOptions().CPlusPlus && Size == 0)
Anders Carlsson79474332009-07-18 20:20:21 +00001505 Size = 8;
1506 // Finally, round the size of the record up to the alignment of the
1507 // record itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001508 uint64_t UnpaddedSize = Size - UnfilledBitsInLastByte;
1509 uint64_t UnpackedSize = llvm::RoundUpToAlignment(Size, UnpackedAlignment);
Anders Carlsson07209442009-11-22 17:37:31 +00001510 Size = llvm::RoundUpToAlignment(Size, Alignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001511
1512 unsigned CharBitNum = Context.Target.getCharWidth();
1513 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1514 // Warn if padding was introduced to the struct/class/union.
1515 if (Size > UnpaddedSize) {
1516 unsigned PadSize = Size - UnpaddedSize;
1517 bool InBits = true;
1518 if (PadSize % CharBitNum == 0) {
1519 PadSize = PadSize / CharBitNum;
1520 InBits = false;
1521 }
1522 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1523 << Context.getTypeDeclType(RD)
1524 << PadSize
1525 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1526 }
1527
1528 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1529 // bother since there won't be alignment issues.
1530 if (Packed && UnpackedAlignment > CharBitNum && Size == UnpackedSize)
1531 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1532 << Context.getTypeDeclType(RD);
1533 }
Anders Carlsson79474332009-07-18 20:20:21 +00001534}
1535
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001536void RecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment,
1537 unsigned UnpackedNewAlignment) {
Daniel Dunbar6da10982010-05-27 05:45:51 +00001538 // The alignment is not modified when using 'mac68k' alignment.
1539 if (IsMac68kAlign)
1540 return;
1541
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001542 if (NewAlignment > Alignment) {
1543 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
1544 Alignment = NewAlignment;
1545 }
1546
1547 if (UnpackedNewAlignment > UnpackedAlignment) {
1548 assert(llvm::isPowerOf2_32(UnpackedNewAlignment &&
1549 "Alignment not a power of 2"));
1550 UnpackedAlignment = UnpackedNewAlignment;
1551 }
1552}
1553
1554void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1555 uint64_t UnpaddedOffset,
1556 uint64_t UnpackedOffset,
1557 unsigned UnpackedAlign,
1558 bool isPacked,
1559 const FieldDecl *D) {
1560 // We let objc ivars without warning, objc interfaces generally are not used
1561 // for padding tricks.
1562 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00001563 return;
Mike Stump11289f42009-09-09 15:08:12 +00001564
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001565 unsigned CharBitNum = Context.Target.getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00001566
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001567 // Warn if padding was introduced to the struct/class.
1568 if (!IsUnion && Offset > UnpaddedOffset) {
1569 unsigned PadSize = Offset - UnpaddedOffset;
1570 bool InBits = true;
1571 if (PadSize % CharBitNum == 0) {
1572 PadSize = PadSize / CharBitNum;
1573 InBits = false;
1574 }
1575 if (D->getIdentifier())
1576 Diag(D->getLocation(), diag::warn_padded_struct_field)
1577 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1578 << Context.getTypeDeclType(D->getParent())
1579 << PadSize
1580 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1581 << D->getIdentifier();
1582 else
1583 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1584 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1585 << Context.getTypeDeclType(D->getParent())
1586 << PadSize
1587 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1588 }
1589
1590 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1591 // bother since there won't be alignment issues.
1592 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1593 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1594 << D->getIdentifier();
Anders Carlsson79474332009-07-18 20:20:21 +00001595}
Mike Stump11289f42009-09-09 15:08:12 +00001596
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001597const CXXMethodDecl *
Anders Carlssonc2226202010-05-26 05:58:59 +00001598RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001599 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001600 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001601 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001602
1603 // A class inside an anonymous namespace doesn't have a key function. (Or
1604 // at least, there's no point to assigning a key function to such a class;
1605 // this doesn't affect the ABI.)
1606 if (RD->isInAnonymousNamespace())
1607 return 0;
1608
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001609 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1610 // Same behavior as GCC.
1611 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1612 if (TSK == TSK_ImplicitInstantiation ||
1613 TSK == TSK_ExplicitInstantiationDefinition)
1614 return 0;
1615
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001616 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1617 E = RD->method_end(); I != E; ++I) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001618 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001619
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001620 if (!MD->isVirtual())
1621 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001622
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001623 if (MD->isPure())
1624 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001625
Anders Carlssonf98849e2009-12-02 17:15:43 +00001626 // Ignore implicit member functions, they are always marked as inline, but
1627 // they don't have a body until they're defined.
1628 if (MD->isImplicit())
1629 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001630
Douglas Gregora318efd2010-01-05 19:06:31 +00001631 if (MD->isInlineSpecified())
1632 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001633
1634 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001635 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001636
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001637 // We found it.
1638 return MD;
1639 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001640
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001641 return 0;
1642}
1643
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001644DiagnosticBuilder
1645RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
1646 return Context.getDiagnostics().Report(
1647 FullSourceLoc(Loc, Context.getSourceManager()), DiagID);
1648}
1649
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001650namespace {
1651 // This class implements layout specific to the Microsoft ABI.
1652 class MSRecordLayoutBuilder : public RecordLayoutBuilder {
1653 public:
1654 MSRecordLayoutBuilder(ASTContext& Ctx, EmptySubobjectMap *EmptySubobjects) :
1655 RecordLayoutBuilder(Ctx, EmptySubobjects) {}
Charles Davisc2c576a2010-08-19 00:55:19 +00001656
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001657 virtual bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
1658 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
1659 };
1660}
Charles Davisc2c576a2010-08-19 00:55:19 +00001661
1662bool MSRecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
1663 // FIXME: Audit the corners
1664 if (!RD->isDynamicClass())
1665 return false;
1666 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
1667 // In the Microsoft ABI, classes can have one or two vtable pointers.
1668 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0) ||
1669 BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0) * 2)
1670 return true;
1671 return false;
1672}
1673
1674uint64_t
1675MSRecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
1676 // We should reserve space for two pointers if the class has both
1677 // virtual functions and virtual bases.
1678 if (RD->isPolymorphic() && RD->getNumVBases() > 0)
1679 return 2 * Context.Target.getPointerWidth(0);
1680 return Context.Target.getPointerWidth(0);
1681}
1682
Anders Carlssondf291d82010-05-26 04:56:53 +00001683/// getASTRecordLayout - Get or compute information about the layout of the
1684/// specified record (struct/union/class), which indicates its size and field
1685/// position information.
1686const ASTRecordLayout &ASTContext::getASTRecordLayout(const RecordDecl *D) {
1687 D = D->getDefinition();
1688 assert(D && "Cannot get layout of forward declarations!");
1689
1690 // Look up this layout, if already laid out, return what we have.
1691 // Note that we can't save a reference to the entry because this function
1692 // is recursive.
1693 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1694 if (Entry) return *Entry;
1695
Anders Carlssond2954862010-05-26 05:10:47 +00001696 const ASTRecordLayout *NewEntry;
1697
1698 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001699 EmptySubobjectMap EmptySubobjects(*this, RD);
Anders Carlsson439edd12010-05-27 05:41:06 +00001700
Charles Davisc2c576a2010-08-19 00:55:19 +00001701 // When compiling for Microsoft, use the special MS builder.
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001702 llvm::OwningPtr<RecordLayoutBuilder> Builder;
Charles Davis6bcb07a2010-08-19 02:18:14 +00001703 switch (Target.getCXXABI()) {
1704 default:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001705 Builder.reset(new RecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001706 break;
1707 case CXXABI_Microsoft:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001708 Builder.reset(new MSRecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001709 }
Charles Davisc2c576a2010-08-19 00:55:19 +00001710 Builder->Layout(RD);
Anders Carlssond2954862010-05-26 05:10:47 +00001711
1712 // FIXME: This is not always correct. See the part about bitfields at
1713 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1714 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1715 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1716
1717 // FIXME: This should be done in FinalizeLayout.
1718 uint64_t DataSize =
Charles Davisc2c576a2010-08-19 00:55:19 +00001719 IsPODForThePurposeOfLayout ? Builder->Size : Builder->DataSize;
Anders Carlssond2954862010-05-26 05:10:47 +00001720 uint64_t NonVirtualSize =
Charles Davisc2c576a2010-08-19 00:55:19 +00001721 IsPODForThePurposeOfLayout ? DataSize : Builder->NonVirtualSize;
Anders Carlssond2954862010-05-26 05:10:47 +00001722
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001723 NewEntry =
Charles Davisc2c576a2010-08-19 00:55:19 +00001724 new (*this) ASTRecordLayout(*this, Builder->Size, Builder->Alignment,
1725 DataSize, Builder->FieldOffsets.data(),
1726 Builder->FieldOffsets.size(),
Anders Carlssond2954862010-05-26 05:10:47 +00001727 NonVirtualSize,
Charles Davisc2c576a2010-08-19 00:55:19 +00001728 Builder->NonVirtualAlignment,
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001729 EmptySubobjects.SizeOfLargestEmptySubobject,
Charles Davisc2c576a2010-08-19 00:55:19 +00001730 Builder->PrimaryBase,
1731 Builder->PrimaryBaseIsVirtual,
1732 Builder->Bases, Builder->VBases);
Anders Carlssond2954862010-05-26 05:10:47 +00001733 } else {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001734 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlssond2954862010-05-26 05:10:47 +00001735 Builder.Layout(D);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001736
Anders Carlssond2954862010-05-26 05:10:47 +00001737 NewEntry =
1738 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1739 Builder.Size,
1740 Builder.FieldOffsets.data(),
1741 Builder.FieldOffsets.size());
1742 }
1743
Anders Carlssondf291d82010-05-26 04:56:53 +00001744 ASTRecordLayouts[D] = NewEntry;
1745
1746 if (getLangOptions().DumpRecordLayouts) {
1747 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1748 DumpRecordLayout(D, llvm::errs());
1749 }
1750
1751 return *NewEntry;
1752}
1753
1754const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1755 RD = cast<CXXRecordDecl>(RD->getDefinition());
1756 assert(RD && "Cannot get key function for forward declarations!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001757
Anders Carlssondf291d82010-05-26 04:56:53 +00001758 const CXXMethodDecl *&Entry = KeyFunctions[RD];
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001759 if (!Entry)
Anders Carlssonc2226202010-05-26 05:58:59 +00001760 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001761
Anders Carlssondf291d82010-05-26 04:56:53 +00001762 return Entry;
1763}
1764
1765/// getInterfaceLayoutImpl - Get or compute information about the
1766/// layout of the given interface.
1767///
1768/// \param Impl - If given, also include the layout of the interface's
1769/// implementation. This may differ by including synthesized ivars.
1770const ASTRecordLayout &
1771ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
1772 const ObjCImplementationDecl *Impl) {
1773 assert(!D->isForwardDecl() && "Invalid interface decl!");
1774
1775 // Look up this layout, if already laid out, return what we have.
1776 ObjCContainerDecl *Key =
1777 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1778 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1779 return *Entry;
1780
1781 // Add in synthesized ivar count if laying out an implementation.
1782 if (Impl) {
1783 unsigned SynthCount = CountNonClassIvars(D);
1784 // If there aren't any sythesized ivars then reuse the interface
1785 // entry. Note we can't cache this because we simply free all
1786 // entries later; however we shouldn't look up implementations
1787 // frequently.
1788 if (SynthCount == 0)
1789 return getObjCLayout(D, 0);
1790 }
1791
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001792 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001793 Builder.Layout(D);
1794
Anders Carlssondf291d82010-05-26 04:56:53 +00001795 const ASTRecordLayout *NewEntry =
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001796 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1797 Builder.DataSize,
1798 Builder.FieldOffsets.data(),
1799 Builder.FieldOffsets.size());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001800
Anders Carlssondf291d82010-05-26 04:56:53 +00001801 ObjCLayouts[Key] = NewEntry;
1802
1803 return *NewEntry;
1804}
1805
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001806static void PrintOffset(llvm::raw_ostream &OS,
1807 uint64_t Offset, unsigned IndentLevel) {
1808 OS << llvm::format("%4d | ", Offset);
1809 OS.indent(IndentLevel * 2);
1810}
1811
1812static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
1813 const CXXRecordDecl *RD, ASTContext &C,
1814 uint64_t Offset,
1815 unsigned IndentLevel,
1816 const char* Description,
1817 bool IncludeVirtualBases) {
1818 const ASTRecordLayout &Info = C.getASTRecordLayout(RD);
1819
1820 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00001821 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001822 if (Description)
1823 OS << ' ' << Description;
1824 if (RD->isEmpty())
1825 OS << " (empty)";
1826 OS << '\n';
1827
1828 IndentLevel++;
1829
1830 const CXXRecordDecl *PrimaryBase = Info.getPrimaryBase();
1831
1832 // Vtable pointer.
1833 if (RD->isDynamicClass() && !PrimaryBase) {
1834 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001835 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001836 }
1837 // Dump (non-virtual) bases
1838 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1839 E = RD->bases_end(); I != E; ++I) {
1840 assert(!I->getType()->isDependentType() &&
1841 "Cannot layout class with dependent bases.");
1842 if (I->isVirtual())
1843 continue;
1844
1845 const CXXRecordDecl *Base =
1846 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1847
1848 uint64_t BaseOffset = Offset + Info.getBaseClassOffset(Base) / 8;
1849
1850 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1851 Base == PrimaryBase ? "(primary base)" : "(base)",
1852 /*IncludeVirtualBases=*/false);
1853 }
1854
1855 // Dump fields.
1856 uint64_t FieldNo = 0;
1857 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1858 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1859 const FieldDecl *Field = *I;
1860 uint64_t FieldOffset = Offset + Info.getFieldOffset(FieldNo) / 8;
1861
1862 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1863 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1864 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
Daniel Dunbar56df9772010-08-17 22:39:59 +00001865 Field->getName().data(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001866 /*IncludeVirtualBases=*/true);
1867 continue;
1868 }
1869 }
1870
1871 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001872 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001873 }
1874
1875 if (!IncludeVirtualBases)
1876 return;
1877
1878 // Dump virtual bases.
1879 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1880 E = RD->vbases_end(); I != E; ++I) {
1881 assert(I->isVirtual() && "Found non-virtual class!");
1882 const CXXRecordDecl *VBase =
1883 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1884
1885 uint64_t VBaseOffset = Offset + Info.getVBaseClassOffset(VBase) / 8;
1886 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1887 VBase == PrimaryBase ?
1888 "(primary virtual base)" : "(virtual base)",
1889 /*IncludeVirtualBases=*/false);
1890 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001891
1892 OS << " sizeof=" << Info.getSize() / 8;
1893 OS << ", dsize=" << Info.getDataSize() / 8;
1894 OS << ", align=" << Info.getAlignment() / 8 << '\n';
1895 OS << " nvsize=" << Info.getNonVirtualSize() / 8;
1896 OS << ", nvalign=" << Info.getNonVirtualAlign() / 8 << '\n';
1897 OS << '\n';
1898}
Daniel Dunbarccabe482010-04-19 20:44:53 +00001899
1900void ASTContext::DumpRecordLayout(const RecordDecl *RD,
1901 llvm::raw_ostream &OS) {
1902 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1903
1904 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1905 return DumpCXXRecordLayout(OS, CXXRD, *this, 0, 0, 0,
1906 /*IncludeVirtualBases=*/true);
1907
1908 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1909 OS << "Record: ";
1910 RD->dump();
1911 OS << "\nLayout: ";
1912 OS << "<ASTRecordLayout\n";
1913 OS << " Size:" << Info.getSize() << "\n";
1914 OS << " DataSize:" << Info.getDataSize() << "\n";
1915 OS << " Alignment:" << Info.getAlignment() << "\n";
1916 OS << " FieldOffsets: [";
1917 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1918 if (i) OS << ", ";
1919 OS << Info.getFieldOffset(i);
1920 }
1921 OS << "]>\n";
1922}