blob: 577ad9badbefc93753cdda64711eb3fc4383cb0c [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"
Daniel Dunbaraa423af2010-04-08 02:59:49 +000017#include "llvm/Support/Format.h"
18#include "llvm/ADT/SmallSet.h"
19#include "llvm/Support/MathExtras.h"
Anders Carlsson35a36eb2010-05-26 05:41:04 +000020#include <map>
Anders Carlsson79474332009-07-18 20:20:21 +000021
22using namespace clang;
23
Anders Carlsson35a36eb2010-05-26 05:41:04 +000024class ASTRecordLayoutBuilder {
25 // FIXME: Remove this and make the appropriate fields public.
26 friend class clang::ASTContext;
27
28 ASTContext &Context;
29
30 /// Size - The current size of the record layout.
31 uint64_t Size;
32
33 /// Alignment - The current alignment of the record layout.
34 unsigned Alignment;
35
36 llvm::SmallVector<uint64_t, 16> FieldOffsets;
37
38 /// Packed - Whether the record is packed or not.
39 bool Packed;
40
41 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
42 /// this contains the number of bits in the last byte that can be used for
43 /// an adjacent bitfield if necessary.
44 unsigned char UnfilledBitsInLastByte;
45
46 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
47 /// #pragma pack.
48 unsigned MaxFieldAlignment;
49
50 /// DataSize - The data size of the record being laid out.
51 uint64_t DataSize;
52
53 bool IsUnion;
54
55 uint64_t NonVirtualSize;
56 unsigned NonVirtualAlignment;
57
58 /// PrimaryBase - the primary base class (if one exists) of the class
59 /// we're laying out.
60 const CXXRecordDecl *PrimaryBase;
61
62 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
63 /// out is virtual.
64 bool PrimaryBaseIsVirtual;
65
66 typedef llvm::DenseMap<const CXXRecordDecl *, uint64_t> BaseOffsetsMapTy;
67
68 /// Bases - base classes and their offsets in the record.
69 BaseOffsetsMapTy Bases;
70
71 // VBases - virtual base classes and their offsets in the record.
72 BaseOffsetsMapTy VBases;
73
74 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
75 /// primary base classes for some other direct or indirect base class.
76 llvm::SmallSet<const CXXRecordDecl*, 32> IndirectPrimaryBases;
77
78 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
79 /// inheritance graph order. Used for determining the primary base class.
80 const CXXRecordDecl *FirstNearlyEmptyVBase;
81
82 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
83 /// avoid visiting virtual bases more than once.
84 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
85
86 /// SizeOfLargestEmptySubobject - When laying out C++ classes, this holds the
87 /// size of the largest empty subobject (either a base or a member).
88 /// Will be zero if the record being built doesn't contain any empty classes.
89 uint64_t SizeOfLargestEmptySubobject;
90
91 /// EmptyClassOffsets - A map from offsets to empty record decls.
92 typedef std::multimap<uint64_t, const CXXRecordDecl *> EmptyClassOffsetsTy;
93 EmptyClassOffsetsTy EmptyClassOffsets;
94
95 ASTRecordLayoutBuilder(ASTContext &Ctx);
96
97 void Layout(const RecordDecl *D);
98 void Layout(const ObjCInterfaceDecl *D);
99
100 void LayoutFields(const RecordDecl *D);
101 void LayoutField(const FieldDecl *D);
102 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize);
103 void LayoutBitField(const FieldDecl *D);
104
105 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
106 /// member subobject that is empty.
107 void ComputeEmptySubobjectSizes(const CXXRecordDecl *RD);
108
109 /// DeterminePrimaryBase - Determine the primary base of the given class.
110 void DeterminePrimaryBase(const CXXRecordDecl *RD);
111
112 void SelectPrimaryVBase(const CXXRecordDecl *RD);
113
114 /// IdentifyPrimaryBases - Identify all virtual base classes, direct or
115 /// indirect, that are primary base classes for some other direct or indirect
116 /// base class.
117 void IdentifyPrimaryBases(const CXXRecordDecl *RD);
118
119 bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
120
121 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
122 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
123 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
124
125 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
126 void LayoutNonVirtualBase(const CXXRecordDecl *RD);
127
128 void AddPrimaryVirtualBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
129 const CXXRecordDecl *MostDerivedClass);
130
131 /// LayoutVirtualBases - Lays out all the virtual bases.
132 void LayoutVirtualBases(const CXXRecordDecl *RD,
133 const CXXRecordDecl *MostDerivedClass);
134
135 /// LayoutVirtualBase - Lays out a single virtual base.
136 void LayoutVirtualBase(const CXXRecordDecl *RD);
137
138 /// LayoutBase - Will lay out a base and return the offset where it was
139 /// placed, in bits.
140 uint64_t LayoutBase(const CXXRecordDecl *RD);
141
142 /// canPlaceRecordAtOffset - Return whether a record (either a base class
143 /// or a field) can be placed at the given offset.
144 /// Returns false if placing the record will result in two components
145 /// (direct or indirect) of the same type having the same offset.
146 bool canPlaceRecordAtOffset(const CXXRecordDecl *RD, uint64_t Offset,
147 bool CheckVBases) const;
148
149 /// canPlaceFieldAtOffset - Return whether a field can be placed at the given
150 /// offset.
151 bool canPlaceFieldAtOffset(const FieldDecl *FD, uint64_t Offset) const;
152
153 /// UpdateEmptyClassOffsets - Called after a record (either a base class
154 /// or a field) has been placed at the given offset. Will update the
155 /// EmptyClassOffsets map if the class is empty or has any empty bases or
156 /// fields.
157 void UpdateEmptyClassOffsets(const CXXRecordDecl *RD, uint64_t Offset,
158 bool UpdateVBases);
159
160 /// UpdateEmptyClassOffsets - Called after a field has been placed at the
161 /// given offset.
162 void UpdateEmptyClassOffsets(const FieldDecl *FD, uint64_t Offset);
163
164 /// FinishLayout - Finalize record layout. Adjust record size based on the
165 /// alignment.
166 void FinishLayout();
167
168 void UpdateAlignment(unsigned NewAlignment);
169
170 ASTRecordLayoutBuilder(const ASTRecordLayoutBuilder&); // DO NOT IMPLEMENT
171 void operator=(const ASTRecordLayoutBuilder&); // DO NOT IMPLEMENT
172public:
173 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
174};
175
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000176ASTRecordLayoutBuilder::ASTRecordLayoutBuilder(ASTContext &Context)
177 : Context(Context), Size(0), Alignment(8), Packed(false),
178 UnfilledBitsInLastByte(0), MaxFieldAlignment(0), DataSize(0), IsUnion(false),
Anders Carlsson1d1e4cf2010-05-26 05:25:15 +0000179 NonVirtualSize(0), NonVirtualAlignment(8), PrimaryBase(0),
180 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0),
Anders Carlsson15837f82010-05-08 23:06:26 +0000181 SizeOfLargestEmptySubobject(0) { }
Mike Stump3dc7eb92009-07-30 00:22:38 +0000182
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000183/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
184/// no other data.
Anders Carlsson81430692009-09-22 03:02:06 +0000185bool ASTRecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000186 // FIXME: Audit the corners
187 if (!RD->isDynamicClass())
188 return false;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000189 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
190 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0))
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000191 return true;
192 return false;
193}
194
Anders Carlsson15837f82010-05-08 23:06:26 +0000195void
196ASTRecordLayoutBuilder::ComputeEmptySubobjectSizes(const CXXRecordDecl *RD) {
197 // Check the bases.
198 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
199 E = RD->bases_end(); I != E; ++I) {
200 const CXXRecordDecl *BaseDecl =
201 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
202
203 uint64_t EmptySize = 0;
204 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
205 if (BaseDecl->isEmpty()) {
206 // If the class decl is empty, get its size.
207 EmptySize = Layout.getSize();
208 } else {
209 // Otherwise, we get the largest empty subobject for the decl.
210 EmptySize = Layout.getSizeOfLargestEmptySubobject();
211 }
212
213 SizeOfLargestEmptySubobject = std::max(SizeOfLargestEmptySubobject,
214 EmptySize);
215 }
216
217 // Check the fields.
218 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
219 I != E; ++I) {
220 const FieldDecl *FD = *I;
221
222 const RecordType *RT =
223 Context.getBaseElementType(FD->getType())->getAs<RecordType>();
224
225 // We only care about record types.
226 if (!RT)
227 continue;
228
229 uint64_t EmptySize = 0;
230 const CXXRecordDecl *MemberDecl = cast<CXXRecordDecl>(RT->getDecl());
231 const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
232 if (MemberDecl->isEmpty()) {
233 // If the class decl is empty, get its size.
234 EmptySize = Layout.getSize();
235 } else {
236 // Otherwise, we get the largest empty subobject for the decl.
237 EmptySize = Layout.getSizeOfLargestEmptySubobject();
238 }
239
240 SizeOfLargestEmptySubobject = std::max(SizeOfLargestEmptySubobject,
241 EmptySize);
242 }
243}
244
Anders Carlsson81430692009-09-22 03:02:06 +0000245void ASTRecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000246 const ASTRecordLayout::PrimaryBaseInfo &BaseInfo =
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000247 Context.getASTRecordLayout(RD).getPrimaryBaseInfo();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000248
Anders Carlsson81430692009-09-22 03:02:06 +0000249 // If the record has a primary base class that is virtual, add it to the set
250 // of primary bases.
Anders Carlssona30c0d32009-11-27 22:14:40 +0000251 if (BaseInfo.isVirtual())
252 IndirectPrimaryBases.insert(BaseInfo.getBase());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000253
Anders Carlsson81430692009-09-22 03:02:06 +0000254 // Now traverse all bases and find primary bases for them.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000255 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000256 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000257 assert(!i->getType()->isDependentType() &&
258 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000259 const CXXRecordDecl *Base =
Mike Stump78696a72009-08-11 04:03:59 +0000260 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000261
Mike Stump78696a72009-08-11 04:03:59 +0000262 // Only bases with virtual bases participate in computing the
263 // indirect primary virtual base classes.
Mike Stumpc2f591b2009-08-13 22:53:07 +0000264 if (Base->getNumVBases())
Anders Carlsson81430692009-09-22 03:02:06 +0000265 IdentifyPrimaryBases(Base);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000266 }
267}
268
Anders Carlsson81430692009-09-22 03:02:06 +0000269void
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000270ASTRecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000271 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000272 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000273 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000274 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000275
Mike Stump11289f42009-09-09 15:08:12 +0000276 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000277 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000278
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000279 // Check if this is a nearly empty virtual base.
280 if (I->isVirtual() && IsNearlyEmpty(Base)) {
281 // If it's not an indirect primary base, then we've found our primary
282 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000283 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000284 PrimaryBase = Base;
285 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000286 return;
287 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000288
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000289 // Is this the first nearly empty virtual base?
290 if (!FirstNearlyEmptyVBase)
291 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000292 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000293
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000294 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000295 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000296 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000297 }
298}
299
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000300/// DeterminePrimaryBase - Determine the primary base of the given class.
301void ASTRecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
302 // If the class isn't dynamic, it won't have a primary base.
303 if (!RD->isDynamicClass())
304 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000305
Anders Carlsson81430692009-09-22 03:02:06 +0000306 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000307 // indirect bases, and record all their primary virtual base classes.
Mike Stump590a7c72009-08-13 23:26:06 +0000308 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000309 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000310 assert(!i->getType()->isDependentType() &&
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000311 "Cannot lay out class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000312 const CXXRecordDecl *Base =
Mike Stump590a7c72009-08-13 23:26:06 +0000313 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +0000314 IdentifyPrimaryBases(Base);
Mike Stump590a7c72009-08-13 23:26:06 +0000315 }
316
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000317 // If the record has a dynamic base class, attempt to choose a primary base
318 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000319 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000320 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000321 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000322 // Ignore virtual bases.
323 if (i->isVirtual())
324 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000325
Anders Carlsson03ff3792009-11-27 22:05:05 +0000326 const CXXRecordDecl *Base =
327 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
328
329 if (Base->isDynamicClass()) {
330 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000331 PrimaryBase = Base;
332 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000333 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000334 }
335 }
336
337 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000338 // indirect primary virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000339 if (RD->getNumVBases() != 0) {
340 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000341 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000342 return;
343 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000344
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000345 // Otherwise, it is the first nearly empty virtual base that is not an
346 // indirect primary virtual base class, if one exists.
347 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000348 PrimaryBase = FirstNearlyEmptyVBase;
349 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000350 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000351 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000352
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000353 // Otherwise there is no primary base class.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000354 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000355
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000356 // Allocate the virtual table pointer at offset zero.
357 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000358
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000359 // Update the size.
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000360 Size += Context.Target.getPointerWidth(0);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000361 DataSize = Size;
362
363 // Update the alignment.
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000364 UpdateAlignment(Context.Target.getPointerAlign(0));
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000365}
366
Anders Carlsson09ffa322010-03-10 22:21:28 +0000367void
368ASTRecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000369 // First, determine the primary base class.
370 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000371
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000372 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000373 if (PrimaryBase) {
374 if (PrimaryBaseIsVirtual) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000375 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000376 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +0000377
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000378 assert(!VisitedVirtualBases.count(PrimaryBase) &&
379 "vbase already visited!");
380 VisitedVirtualBases.insert(PrimaryBase);
Anders Carlsson291279e2010-04-10 18:42:27 +0000381
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000382 LayoutVirtualBase(PrimaryBase);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000383 } else
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000384 LayoutNonVirtualBase(PrimaryBase);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000385 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000386
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000387 // Now lay out the non-virtual bases.
388 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000389 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000390
391 // Ignore virtual bases.
392 if (I->isVirtual())
393 continue;
394
395 const CXXRecordDecl *Base =
396 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
397
398 // Skip the primary base.
Anders Carlssonb48414f2010-05-26 05:31:23 +0000399 if (Base == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000400 continue;
401
402 // Lay out the base.
403 LayoutNonVirtualBase(Base);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000404 }
405}
406
407void ASTRecordLayoutBuilder::LayoutNonVirtualBase(const CXXRecordDecl *RD) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000408 // Layout the base.
409 uint64_t Offset = LayoutBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000410
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000411 // Add its base class offset.
Anders Carlsson6a848892010-03-11 04:10:39 +0000412 if (!Bases.insert(std::make_pair(RD, Offset)).second)
413 assert(false && "Added same base offset more than once!");
Anders Carlsson09ffa322010-03-10 22:21:28 +0000414}
Mike Stump2b84dd32009-11-05 04:02:15 +0000415
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000416void
Anders Carlssonea7b1822010-04-15 16:12:58 +0000417ASTRecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const CXXRecordDecl *RD,
418 uint64_t Offset,
419 const CXXRecordDecl *MostDerivedClass) {
420 // We already have the offset for the primary base of the most derived class.
421 if (RD != MostDerivedClass) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000422 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonea7b1822010-04-15 16:12:58 +0000423 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
424
425 // If this is a primary virtual base and we haven't seen it before, add it.
426 if (PrimaryBase && Layout.getPrimaryBaseWasVirtual() &&
427 !VBases.count(PrimaryBase))
428 VBases.insert(std::make_pair(PrimaryBase, Offset));
429 }
430
431 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
432 E = RD->bases_end(); I != E; ++I) {
433 assert(!I->getType()->isDependentType() &&
434 "Cannot layout class with dependent bases.");
435
436 const CXXRecordDecl *BaseDecl =
437 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
438
439 if (!BaseDecl->getNumVBases()) {
440 // This base isn't interesting since it doesn't have any virtual bases.
441 continue;
442 }
443
444 // Compute the offset of this base.
445 uint64_t BaseOffset;
446
447 if (I->isVirtual()) {
448 // If we don't know this vbase yet, don't visit it. It will be visited
449 // later.
450 if (!VBases.count(BaseDecl)) {
451 continue;
452 }
453
454 // Check if we've already visited this base.
455 if (!VisitedVirtualBases.insert(BaseDecl))
456 continue;
457
458 // We want the vbase offset from the class we're currently laying out.
459 BaseOffset = VBases[BaseDecl];
460 } else if (RD == MostDerivedClass) {
461 // We want the base offset from the class we're currently laying out.
462 assert(Bases.count(BaseDecl) && "Did not find base!");
463 BaseOffset = Bases[BaseDecl];
464 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000465 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonea7b1822010-04-15 16:12:58 +0000466 BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
467 }
468
469 AddPrimaryVirtualBaseOffsets(BaseDecl, BaseOffset, MostDerivedClass);
470 }
471}
472
473void
Anders Carlssonde710c92010-03-11 04:33:54 +0000474ASTRecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +0000475 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +0000476 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +0000477 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +0000478
Anders Carlsson291279e2010-04-10 18:42:27 +0000479 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000480 PrimaryBase = this->PrimaryBase;
481 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +0000482 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000483 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +0000484 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson291279e2010-04-10 18:42:27 +0000485 PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
486 }
487
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000488 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
489 E = RD->bases_end(); I != E; ++I) {
490 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000491 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000492
Mike Stump11289f42009-09-09 15:08:12 +0000493 const CXXRecordDecl *Base =
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000494 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
495
496 if (I->isVirtual()) {
Anders Carlsson291279e2010-04-10 18:42:27 +0000497 if (PrimaryBase != Base || !PrimaryBaseIsVirtual) {
498 bool IndirectPrimaryBase = IndirectPrimaryBases.count(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000499
Anders Carlsson291279e2010-04-10 18:42:27 +0000500 // Only lay out the virtual base if it's not an indirect primary base.
501 if (!IndirectPrimaryBase) {
502 // Only visit virtual bases once.
503 if (!VisitedVirtualBases.insert(Base))
504 continue;
505
Anders Carlssonfe900962010-03-11 05:42:17 +0000506 LayoutVirtualBase(Base);
Anders Carlsson6a848892010-03-11 04:10:39 +0000507 }
Mike Stump2b84dd32009-11-05 04:02:15 +0000508 }
Mike Stumpc2f591b2009-08-13 22:53:07 +0000509 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000510
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000511 if (!Base->getNumVBases()) {
512 // This base isn't interesting since it doesn't have any virtual bases.
513 continue;
Mike Stump996576f32009-08-16 19:04:13 +0000514 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000515
Anders Carlssonea7b1822010-04-15 16:12:58 +0000516 LayoutVirtualBases(Base, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +0000517 }
518}
519
Anders Carlsson09ffa322010-03-10 22:21:28 +0000520void ASTRecordLayoutBuilder::LayoutVirtualBase(const CXXRecordDecl *RD) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000521 // Layout the base.
522 uint64_t Offset = LayoutBase(RD);
523
524 // Add its base class offset.
Anders Carlsson6a848892010-03-11 04:10:39 +0000525 if (!VBases.insert(std::make_pair(RD, Offset)).second)
526 assert(false && "Added same vbase offset more than once!");
Anders Carlsson09ffa322010-03-10 22:21:28 +0000527}
528
529uint64_t ASTRecordLayoutBuilder::LayoutBase(const CXXRecordDecl *RD) {
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000530 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000531
532 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond626cb72010-05-10 15:26:14 +0000533 if (RD->isEmpty() && canPlaceRecordAtOffset(RD, 0, /*CheckVBases=*/false)) {
Anders Carlsson09ffa322010-03-10 22:21:28 +0000534 // We were able to place the class at offset 0.
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000535 UpdateEmptyClassOffsets(RD, 0, /*UpdateVBases=*/false);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000536
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000537 Size = std::max(Size, Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +0000538
539 return 0;
540 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000541
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000542 unsigned BaseAlign = Layout.getNonVirtualAlign();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000543
Anders Carlsson09ffa322010-03-10 22:21:28 +0000544 // Round up the current record size to the base's alignment boundary.
545 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000546
Anders Carlsson09ffa322010-03-10 22:21:28 +0000547 // Try to place the base.
548 while (true) {
Anders Carlssond626cb72010-05-10 15:26:14 +0000549 if (canPlaceRecordAtOffset(RD, Offset, /*CheckVBases=*/false))
Anders Carlsson09ffa322010-03-10 22:21:28 +0000550 break;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000551
Anders Carlsson09ffa322010-03-10 22:21:28 +0000552 Offset += BaseAlign;
553 }
554
555 if (!RD->isEmpty()) {
556 // Update the data size.
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000557 DataSize = Offset + Layout.getNonVirtualSize();
Anders Carlsson09ffa322010-03-10 22:21:28 +0000558
559 Size = std::max(Size, DataSize);
560 } else
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000561 Size = std::max(Size, Offset + Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +0000562
563 // Remember max struct/class alignment.
564 UpdateAlignment(BaseAlign);
565
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000566 UpdateEmptyClassOffsets(RD, Offset, /*UpdateVBases=*/false);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000567 return Offset;
568}
569
Anders Carlssond626cb72010-05-10 15:26:14 +0000570bool
571ASTRecordLayoutBuilder::canPlaceRecordAtOffset(const CXXRecordDecl *RD,
572 uint64_t Offset,
573 bool CheckVBases) const {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000574 // Look for an empty class with the same type at the same offset.
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000575 for (EmptyClassOffsetsTy::const_iterator I =
576 EmptyClassOffsets.lower_bound(Offset),
577 E = EmptyClassOffsets.upper_bound(Offset); I != E; ++I) {
578
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000579 if (I->second == RD)
580 return false;
581 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000582
Anders Carlsson82828a32010-05-09 05:03:38 +0000583 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000584
585 // Check bases.
586 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000587 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000588 assert(!I->getType()->isDependentType() &&
589 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000590 if (I->isVirtual())
591 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000592
Anders Carlsson82828a32010-05-09 05:03:38 +0000593 const CXXRecordDecl *BaseDecl =
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000594 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
595
Anders Carlsson82828a32010-05-09 05:03:38 +0000596 uint64_t BaseOffset = Layout.getBaseClassOffset(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000597
Anders Carlssond626cb72010-05-10 15:26:14 +0000598 if (!canPlaceRecordAtOffset(BaseDecl, Offset + BaseOffset,
599 /*CheckVBases=*/false))
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000600 return false;
601 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000602
Anders Carlssond7d358a2009-09-25 15:39:00 +0000603 // Check fields.
604 unsigned FieldNo = 0;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000605 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
Anders Carlssond7d358a2009-09-25 15:39:00 +0000606 I != E; ++I, ++FieldNo) {
607 const FieldDecl *FD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000608
Anders Carlsson82828a32010-05-09 05:03:38 +0000609 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000610
Anders Carlssond7d358a2009-09-25 15:39:00 +0000611 if (!canPlaceFieldAtOffset(FD, Offset + FieldOffset))
612 return false;
613 }
614
Anders Carlssond626cb72010-05-10 15:26:14 +0000615 if (CheckVBases) {
616 // FIXME: virtual bases.
617 }
618
Anders Carlsson6522b052009-09-24 03:13:30 +0000619 return true;
620}
621
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000622bool ASTRecordLayoutBuilder::canPlaceFieldAtOffset(const FieldDecl *FD,
Anders Carlsson6f95c702009-09-25 00:02:51 +0000623 uint64_t Offset) const {
Anders Carlsson4bf82142009-09-25 01:23:32 +0000624 QualType T = FD->getType();
625 if (const RecordType *RT = T->getAs<RecordType>()) {
Anders Carlsson6f95c702009-09-25 00:02:51 +0000626 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
Anders Carlssond626cb72010-05-10 15:26:14 +0000627 return canPlaceRecordAtOffset(RD, Offset, /*CheckVBases=*/true);
Anders Carlsson6f95c702009-09-25 00:02:51 +0000628 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000629
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000630 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
631 QualType ElemTy = Context.getBaseElementType(AT);
Anders Carlsson4bf82142009-09-25 01:23:32 +0000632 const RecordType *RT = ElemTy->getAs<RecordType>();
633 if (!RT)
634 return true;
635 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
636 if (!RD)
637 return true;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000638
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000639 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson4bf82142009-09-25 01:23:32 +0000640
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000641 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Mike Stump2b84dd32009-11-05 04:02:15 +0000642 uint64_t ElementOffset = Offset;
Anders Carlsson4bf82142009-09-25 01:23:32 +0000643 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssond626cb72010-05-10 15:26:14 +0000644 if (!canPlaceRecordAtOffset(RD, ElementOffset, /*CheckVBases=*/true))
Anders Carlsson4bf82142009-09-25 01:23:32 +0000645 return false;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000646
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000647 ElementOffset += Layout.getSize();
Anders Carlsson4bf82142009-09-25 01:23:32 +0000648 }
649 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000650
Anders Carlsson6f95c702009-09-25 00:02:51 +0000651 return true;
652}
653
Anders Carlsson6522b052009-09-24 03:13:30 +0000654void ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const CXXRecordDecl *RD,
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000655 uint64_t Offset,
656 bool UpdateVBases) {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000657 if (RD->isEmpty())
658 EmptyClassOffsets.insert(std::make_pair(Offset, RD));
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000659
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000660 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000661
662 // Update bases.
663 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000664 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000665 assert(!I->getType()->isDependentType() &&
666 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000667 if (I->isVirtual())
668 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000669
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000670 const CXXRecordDecl *Base =
671 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000672
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000673 uint64_t BaseClassOffset = Layout.getBaseClassOffset(Base);
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000674 UpdateEmptyClassOffsets(Base, Offset + BaseClassOffset,
675 /*UpdateVBases=*/false);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000676 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000677
Anders Carlssond7d358a2009-09-25 15:39:00 +0000678 // Update fields.
679 unsigned FieldNo = 0;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000680 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
Anders Carlssond7d358a2009-09-25 15:39:00 +0000681 I != E; ++I, ++FieldNo) {
682 const FieldDecl *FD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000683
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000684 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
Anders Carlssond7d358a2009-09-25 15:39:00 +0000685 UpdateEmptyClassOffsets(FD, Offset + FieldOffset);
686 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000687
Anders Carlsson57732052010-05-23 18:14:24 +0000688 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
689
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000690 if (UpdateVBases) {
691 // FIXME: Update virtual bases.
Anders Carlsson57732052010-05-23 18:14:24 +0000692 } else if (PrimaryBase && Layout.getPrimaryBaseWasVirtual()) {
693 // We always want to update the offsets of a primary virtual base.
694 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
695 "primary base class offset must always be 0!");
696 UpdateEmptyClassOffsets(PrimaryBase, Offset, /*UpdateVBases=*/false);
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000697 }
Anders Carlsson6522b052009-09-24 03:13:30 +0000698}
699
Anders Carlssone1883102009-09-25 01:54:38 +0000700void
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000701ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const FieldDecl *FD,
Anders Carlssone1883102009-09-25 01:54:38 +0000702 uint64_t Offset) {
703 QualType T = FD->getType();
704
705 if (const RecordType *RT = T->getAs<RecordType>()) {
706 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000707 UpdateEmptyClassOffsets(RD, Offset, /*UpdateVBases=*/true);
Anders Carlssone1883102009-09-25 01:54:38 +0000708 return;
709 }
710 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000711
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000712 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
713 QualType ElemTy = Context.getBaseElementType(AT);
Anders Carlssone1883102009-09-25 01:54:38 +0000714 const RecordType *RT = ElemTy->getAs<RecordType>();
715 if (!RT)
716 return;
717 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
718 if (!RD)
719 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000720
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000721 const ASTRecordLayout &Info = Context.getASTRecordLayout(RD);
Anders Carlssone1883102009-09-25 01:54:38 +0000722
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000723 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Mike Stump2b84dd32009-11-05 04:02:15 +0000724 uint64_t ElementOffset = Offset;
Anders Carlssone1883102009-09-25 01:54:38 +0000725
726 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000727 UpdateEmptyClassOffsets(RD, ElementOffset, /*UpdateVBases=*/true);
Anders Carlssone1883102009-09-25 01:54:38 +0000728 ElementOffset += Info.getSize();
729 }
730 }
731}
732
Anders Carlsson79474332009-07-18 20:20:21 +0000733void ASTRecordLayoutBuilder::Layout(const RecordDecl *D) {
734 IsUnion = D->isUnion();
Anders Carlsson68e0b682009-08-08 18:23:56 +0000735
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000736 Packed = D->hasAttr<PackedAttr>();
737
738 // The #pragma pack attribute specifies the maximum field alignment.
Anders Carlsson68e0b682009-08-08 18:23:56 +0000739 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000740 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000741
Anders Carlsson79474332009-07-18 20:20:21 +0000742 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Alexis Hunt96d5c762009-11-21 08:43:09 +0000743 UpdateAlignment(AA->getMaxAlignment());
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000744
Mike Stump22ea1f82009-08-16 01:46:26 +0000745 // If this is a C++ class, lay out the vtable and the non-virtual bases.
Mike Stump6b2556f2009-08-06 13:41:24 +0000746 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D);
Anders Carlsson15837f82010-05-08 23:06:26 +0000747 if (RD) {
748 ComputeEmptySubobjectSizes(RD);
Mike Stump3dc7eb92009-07-30 00:22:38 +0000749 LayoutNonVirtualBases(RD);
Anders Carlsson15837f82010-05-08 23:06:26 +0000750 }
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000751
Anders Carlsson118ce162009-07-18 21:48:39 +0000752 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +0000753
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000754 NonVirtualSize = Size;
755 NonVirtualAlignment = Alignment;
Mike Stump3dc7eb92009-07-30 00:22:38 +0000756
Anders Carlssonea7b1822010-04-15 16:12:58 +0000757 // If this is a C++ class, lay out its virtual bases and add its primary
758 // virtual base offsets.
759 if (RD) {
760 LayoutVirtualBases(RD, RD);
761
762 VisitedVirtualBases.clear();
763 AddPrimaryVirtualBaseOffsets(RD, 0, RD);
764 }
Mike Stump6b2556f2009-08-06 13:41:24 +0000765
Anders Carlsson79474332009-07-18 20:20:21 +0000766 // Finally, round the size of the total struct up to the alignment of the
767 // struct itself.
768 FinishLayout();
Anders Carlsson5b441d72010-04-10 21:24:48 +0000769
770#ifndef NDEBUG
771 if (RD) {
772 // Check that we have base offsets for all bases.
773 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
774 E = RD->bases_end(); I != E; ++I) {
775 if (I->isVirtual())
776 continue;
777
778 const CXXRecordDecl *BaseDecl =
779 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
780
781 assert(Bases.count(BaseDecl) && "Did not find base offset!");
782 }
783
784 // And all virtual bases.
785 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
786 E = RD->vbases_end(); I != E; ++I) {
787 const CXXRecordDecl *BaseDecl =
788 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
789
790 assert(VBases.count(BaseDecl) && "Did not find base offset!");
791 }
792 }
793#endif
Anders Carlsson79474332009-07-18 20:20:21 +0000794}
795
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +0000796void ASTRecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +0000797 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000798 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +0000799
800 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +0000801
Anders Carlsson4f516282009-07-18 20:50:59 +0000802 // We start laying out ivars not at the end of the superclass
803 // structure, but at the next byte following the last field.
Anders Carlsson27b50132009-07-18 21:26:44 +0000804 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlsson47680d82009-09-26 01:34:51 +0000805 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +0000806 }
Mike Stump11289f42009-09-09 15:08:12 +0000807
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000808 Packed = D->hasAttr<PackedAttr>();
Mike Stump11289f42009-09-09 15:08:12 +0000809
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000810 // The #pragma pack attribute specifies the maximum field alignment.
811 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
812 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000813
Anders Carlsson4f516282009-07-18 20:50:59 +0000814 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Alexis Hunt96d5c762009-11-21 08:43:09 +0000815 UpdateAlignment(AA->getMaxAlignment());
Anders Carlsson4f516282009-07-18 20:50:59 +0000816 // Layout each ivar sequentially.
817 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000818 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson4f516282009-07-18 20:50:59 +0000819 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
820 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +0000821
Anders Carlsson4f516282009-07-18 20:50:59 +0000822 // Finally, round the size of the total struct up to the alignment of the
823 // struct itself.
824 FinishLayout();
825}
826
Anders Carlsson118ce162009-07-18 21:48:39 +0000827void ASTRecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
828 // Layout each field, for now, just sequentially, respecting alignment. In
829 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +0000830 for (RecordDecl::field_iterator Field = D->field_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000831 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
Anders Carlsson118ce162009-07-18 21:48:39 +0000832 LayoutField(*Field);
833}
834
Anders Carlsson57235162010-04-16 15:57:11 +0000835void ASTRecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
836 uint64_t TypeSize) {
837 assert(Context.getLangOptions().CPlusPlus &&
838 "Can only have wide bit-fields in C++!");
839
840 // Itanium C++ ABI 2.4:
841 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
842 // sizeof(T')*8 <= n.
843
844 QualType IntegralPODTypes[] = {
845 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
846 Context.UnsignedLongTy, Context.UnsignedLongLongTy
847 };
848
Anders Carlsson57235162010-04-16 15:57:11 +0000849 QualType Type;
850 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
851 I != E; ++I) {
852 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +0000853
854 if (Size > FieldSize)
855 break;
856
857 Type = IntegralPODTypes[I];
858 }
859 assert(!Type.isNull() && "Did not find a type!");
Anders Carlsson57235162010-04-16 15:57:11 +0000860
861 unsigned TypeAlign = Context.getTypeAlign(Type);
862
863 // We're not going to use any of the unfilled bits in the last byte.
864 UnfilledBitsInLastByte = 0;
865
Anders Carlssonaad5fa82010-04-17 20:21:41 +0000866 uint64_t FieldOffset;
867
Anders Carlsson57235162010-04-16 15:57:11 +0000868 if (IsUnion) {
869 DataSize = std::max(DataSize, FieldSize);
Anders Carlssonaad5fa82010-04-17 20:21:41 +0000870 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +0000871 } else {
Anders Carlssonaad5fa82010-04-17 20:21:41 +0000872 // The bitfield is allocated starting at the next offset aligned appropriately
873 // for T', with length n bits.
874 FieldOffset = llvm::RoundUpToAlignment(DataSize, TypeAlign);
875
Anders Carlsson57235162010-04-16 15:57:11 +0000876 uint64_t NewSizeInBits = FieldOffset + FieldSize;
877
878 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
879 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
880 }
881
882 // Place this field at the current location.
883 FieldOffsets.push_back(FieldOffset);
884
885 // Update the size.
886 Size = std::max(Size, DataSize);
887
888 // Remember max struct/class alignment.
889 UpdateAlignment(TypeAlign);
890}
891
Anders Carlsson07209442009-11-22 17:37:31 +0000892void ASTRecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
893 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlssonba958402009-11-22 19:13:51 +0000894 uint64_t FieldOffset = IsUnion ? 0 : (DataSize - UnfilledBitsInLastByte);
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000895 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000896
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000897 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +0000898 uint64_t TypeSize = FieldInfo.first;
899 unsigned FieldAlign = FieldInfo.second;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000900
Anders Carlsson57235162010-04-16 15:57:11 +0000901 if (FieldSize > TypeSize) {
902 LayoutWideBitField(FieldSize, TypeSize);
903 return;
904 }
905
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000906 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson07209442009-11-22 17:37:31 +0000907 FieldAlign = 1;
908 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
909 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
910
911 // The maximum field alignment overrides the aligned attribute.
912 if (MaxFieldAlignment)
913 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000914
Daniel Dunbar3d9289c2010-04-15 06:18:39 +0000915 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson07209442009-11-22 17:37:31 +0000916 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
917 FieldOffset = (FieldOffset + (FieldAlign-1)) & ~(FieldAlign-1);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000918
Daniel Dunbar3d9289c2010-04-15 06:18:39 +0000919 // Padding members don't affect overall alignment.
Anders Carlsson07209442009-11-22 17:37:31 +0000920 if (!D->getIdentifier())
921 FieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000922
Anders Carlsson07209442009-11-22 17:37:31 +0000923 // Place this field at the current location.
924 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000925
Anders Carlssonba958402009-11-22 19:13:51 +0000926 // Update DataSize to include the last byte containing (part of) the bitfield.
927 if (IsUnion) {
928 // FIXME: I think FieldSize should be TypeSize here.
929 DataSize = std::max(DataSize, FieldSize);
930 } else {
931 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000932
Anders Carlssonba958402009-11-22 19:13:51 +0000933 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
934 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
935 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000936
Anders Carlssonba958402009-11-22 19:13:51 +0000937 // Update the size.
938 Size = std::max(Size, DataSize);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000939
Anders Carlsson07209442009-11-22 17:37:31 +0000940 // Remember max struct/class alignment.
941 UpdateAlignment(FieldAlign);
942}
943
Anders Carlsson79474332009-07-18 20:20:21 +0000944void ASTRecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +0000945 if (D->isBitField()) {
946 LayoutBitField(D);
947 return;
948 }
949
Anders Carlssonba958402009-11-22 19:13:51 +0000950 // Reset the unfilled bits.
951 UnfilledBitsInLastByte = 0;
952
Anders Carlsson07209442009-11-22 17:37:31 +0000953 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlsson47680d82009-09-26 01:34:51 +0000954 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +0000955 uint64_t FieldSize;
956 unsigned FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000957
Anders Carlsson07209442009-11-22 17:37:31 +0000958 if (D->getType()->isIncompleteArrayType()) {
959 // This is a flexible array member; we can't directly
960 // query getTypeInfo about these, so we figure it out here.
961 // Flexible array members don't have any size, but they
962 // have to be aligned appropriately for their element type.
963 FieldSize = 0;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000964 const ArrayType* ATy = Context.getAsArrayType(D->getType());
965 FieldAlign = Context.getTypeAlign(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +0000966 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
967 unsigned AS = RT->getPointeeType().getAddressSpace();
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000968 FieldSize = Context.Target.getPointerWidth(AS);
969 FieldAlign = Context.Target.getPointerAlign(AS);
Anders Carlsson79474332009-07-18 20:20:21 +0000970 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000971 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +0000972 FieldSize = FieldInfo.first;
973 FieldAlign = FieldInfo.second;
Anders Carlsson79474332009-07-18 20:20:21 +0000974 }
Mike Stump11289f42009-09-09 15:08:12 +0000975
Anders Carlsson07209442009-11-22 17:37:31 +0000976 if (FieldPacked)
977 FieldAlign = 8;
978 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
979 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
980
981 // The maximum field alignment overrides the aligned attribute.
982 if (MaxFieldAlignment)
983 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
984
985 // Round up the current record size to the field's alignment boundary.
986 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000987
Anders Carlsson07209442009-11-22 17:37:31 +0000988 if (!IsUnion) {
989 while (true) {
990 // Check if we can place the field at this offset.
991 if (canPlaceFieldAtOffset(D, FieldOffset))
992 break;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000993
Anders Carlsson07209442009-11-22 17:37:31 +0000994 // We couldn't place the field at the offset. Try again at a new offset.
995 FieldOffset += FieldAlign;
996 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000997
Anders Carlsson07209442009-11-22 17:37:31 +0000998 UpdateEmptyClassOffsets(D, FieldOffset);
999 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001000
Anders Carlsson79474332009-07-18 20:20:21 +00001001 // Place this field at the current location.
1002 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +00001003
Anders Carlsson79474332009-07-18 20:20:21 +00001004 // Reserve space for this field.
1005 if (IsUnion)
1006 Size = std::max(Size, FieldSize);
1007 else
1008 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +00001009
Anders Carlsson47680d82009-09-26 01:34:51 +00001010 // Update the data size.
1011 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +00001012
Anders Carlsson79474332009-07-18 20:20:21 +00001013 // Remember max struct/class alignment.
1014 UpdateAlignment(FieldAlign);
1015}
1016
1017void ASTRecordLayoutBuilder::FinishLayout() {
1018 // In C++, records cannot be of size 0.
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001019 if (Context.getLangOptions().CPlusPlus && Size == 0)
Anders Carlsson79474332009-07-18 20:20:21 +00001020 Size = 8;
1021 // Finally, round the size of the record up to the alignment of the
1022 // record itself.
Anders Carlsson07209442009-11-22 17:37:31 +00001023 Size = llvm::RoundUpToAlignment(Size, Alignment);
Anders Carlsson79474332009-07-18 20:20:21 +00001024}
1025
1026void ASTRecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment) {
1027 if (NewAlignment <= Alignment)
1028 return;
Mike Stump11289f42009-09-09 15:08:12 +00001029
Anders Carlsson79474332009-07-18 20:20:21 +00001030 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
Mike Stump11289f42009-09-09 15:08:12 +00001031
Anders Carlsson79474332009-07-18 20:20:21 +00001032 Alignment = NewAlignment;
1033}
Mike Stump11289f42009-09-09 15:08:12 +00001034
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001035const CXXMethodDecl *
1036ASTRecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
1037 assert(RD->isDynamicClass() && "Class does not have any virtual methods!");
1038
Daniel Dunbarccabe482010-04-19 20:44:53 +00001039 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001040 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001041 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001042
1043 // A class inside an anonymous namespace doesn't have a key function. (Or
1044 // at least, there's no point to assigning a key function to such a class;
1045 // this doesn't affect the ABI.)
1046 if (RD->isInAnonymousNamespace())
1047 return 0;
1048
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001049 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1050 E = RD->method_end(); I != E; ++I) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001051 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001052
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001053 if (!MD->isVirtual())
1054 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001055
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001056 if (MD->isPure())
1057 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001058
Anders Carlssonf98849e2009-12-02 17:15:43 +00001059 // Ignore implicit member functions, they are always marked as inline, but
1060 // they don't have a body until they're defined.
1061 if (MD->isImplicit())
1062 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001063
Douglas Gregora318efd2010-01-05 19:06:31 +00001064 if (MD->isInlineSpecified())
1065 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001066
1067 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001068 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001069
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001070 // We found it.
1071 return MD;
1072 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001073
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001074 return 0;
1075}
1076
Anders Carlssondf291d82010-05-26 04:56:53 +00001077/// getASTRecordLayout - Get or compute information about the layout of the
1078/// specified record (struct/union/class), which indicates its size and field
1079/// position information.
1080const ASTRecordLayout &ASTContext::getASTRecordLayout(const RecordDecl *D) {
1081 D = D->getDefinition();
1082 assert(D && "Cannot get layout of forward declarations!");
1083
1084 // Look up this layout, if already laid out, return what we have.
1085 // Note that we can't save a reference to the entry because this function
1086 // is recursive.
1087 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1088 if (Entry) return *Entry;
1089
Anders Carlssond2954862010-05-26 05:10:47 +00001090 const ASTRecordLayout *NewEntry;
1091
1092 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
1093 ASTRecordLayoutBuilder Builder(*this);
1094 Builder.Layout(RD);
1095
1096 // FIXME: This is not always correct. See the part about bitfields at
1097 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1098 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1099 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1100
1101 // FIXME: This should be done in FinalizeLayout.
1102 uint64_t DataSize =
1103 IsPODForThePurposeOfLayout ? Builder.Size : Builder.DataSize;
1104 uint64_t NonVirtualSize =
1105 IsPODForThePurposeOfLayout ? DataSize : Builder.NonVirtualSize;
1106
1107 NewEntry =
1108 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1109 DataSize, Builder.FieldOffsets.data(),
1110 Builder.FieldOffsets.size(),
1111 NonVirtualSize,
1112 Builder.NonVirtualAlignment,
1113 Builder.SizeOfLargestEmptySubobject,
1114 Builder.PrimaryBase,
Anders Carlsson1d1e4cf2010-05-26 05:25:15 +00001115 Builder.PrimaryBaseIsVirtual,
Anders Carlssond2954862010-05-26 05:10:47 +00001116 Builder.Bases, Builder.VBases);
1117 } else {
1118 ASTRecordLayoutBuilder Builder(*this);
1119 Builder.Layout(D);
1120
1121 NewEntry =
1122 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1123 Builder.Size,
1124 Builder.FieldOffsets.data(),
1125 Builder.FieldOffsets.size());
1126 }
1127
Anders Carlssondf291d82010-05-26 04:56:53 +00001128 ASTRecordLayouts[D] = NewEntry;
1129
1130 if (getLangOptions().DumpRecordLayouts) {
1131 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1132 DumpRecordLayout(D, llvm::errs());
1133 }
1134
1135 return *NewEntry;
1136}
1137
1138const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1139 RD = cast<CXXRecordDecl>(RD->getDefinition());
1140 assert(RD && "Cannot get key function for forward declarations!");
1141
1142 const CXXMethodDecl *&Entry = KeyFunctions[RD];
1143 if (!Entry)
1144 Entry = ASTRecordLayoutBuilder::ComputeKeyFunction(RD);
1145 else
1146 assert(Entry == ASTRecordLayoutBuilder::ComputeKeyFunction(RD) &&
1147 "Key function changed!");
1148
1149 return Entry;
1150}
1151
1152/// getInterfaceLayoutImpl - Get or compute information about the
1153/// layout of the given interface.
1154///
1155/// \param Impl - If given, also include the layout of the interface's
1156/// implementation. This may differ by including synthesized ivars.
1157const ASTRecordLayout &
1158ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
1159 const ObjCImplementationDecl *Impl) {
1160 assert(!D->isForwardDecl() && "Invalid interface decl!");
1161
1162 // Look up this layout, if already laid out, return what we have.
1163 ObjCContainerDecl *Key =
1164 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1165 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1166 return *Entry;
1167
1168 // Add in synthesized ivar count if laying out an implementation.
1169 if (Impl) {
1170 unsigned SynthCount = CountNonClassIvars(D);
1171 // If there aren't any sythesized ivars then reuse the interface
1172 // entry. Note we can't cache this because we simply free all
1173 // entries later; however we shouldn't look up implementations
1174 // frequently.
1175 if (SynthCount == 0)
1176 return getObjCLayout(D, 0);
1177 }
1178
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001179 ASTRecordLayoutBuilder Builder(*this);
1180 Builder.Layout(D);
1181
Anders Carlssondf291d82010-05-26 04:56:53 +00001182 const ASTRecordLayout *NewEntry =
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001183 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1184 Builder.DataSize,
1185 Builder.FieldOffsets.data(),
1186 Builder.FieldOffsets.size());
1187
Anders Carlssondf291d82010-05-26 04:56:53 +00001188 ObjCLayouts[Key] = NewEntry;
1189
1190 return *NewEntry;
1191}
1192
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001193static void PrintOffset(llvm::raw_ostream &OS,
1194 uint64_t Offset, unsigned IndentLevel) {
1195 OS << llvm::format("%4d | ", Offset);
1196 OS.indent(IndentLevel * 2);
1197}
1198
1199static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
1200 const CXXRecordDecl *RD, ASTContext &C,
1201 uint64_t Offset,
1202 unsigned IndentLevel,
1203 const char* Description,
1204 bool IncludeVirtualBases) {
1205 const ASTRecordLayout &Info = C.getASTRecordLayout(RD);
1206
1207 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00001208 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001209 if (Description)
1210 OS << ' ' << Description;
1211 if (RD->isEmpty())
1212 OS << " (empty)";
1213 OS << '\n';
1214
1215 IndentLevel++;
1216
1217 const CXXRecordDecl *PrimaryBase = Info.getPrimaryBase();
1218
1219 // Vtable pointer.
1220 if (RD->isDynamicClass() && !PrimaryBase) {
1221 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001222 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001223 }
1224 // Dump (non-virtual) bases
1225 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1226 E = RD->bases_end(); I != E; ++I) {
1227 assert(!I->getType()->isDependentType() &&
1228 "Cannot layout class with dependent bases.");
1229 if (I->isVirtual())
1230 continue;
1231
1232 const CXXRecordDecl *Base =
1233 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1234
1235 uint64_t BaseOffset = Offset + Info.getBaseClassOffset(Base) / 8;
1236
1237 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1238 Base == PrimaryBase ? "(primary base)" : "(base)",
1239 /*IncludeVirtualBases=*/false);
1240 }
1241
1242 // Dump fields.
1243 uint64_t FieldNo = 0;
1244 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1245 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1246 const FieldDecl *Field = *I;
1247 uint64_t FieldOffset = Offset + Info.getFieldOffset(FieldNo) / 8;
1248
1249 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1250 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1251 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
1252 Field->getNameAsCString(),
1253 /*IncludeVirtualBases=*/true);
1254 continue;
1255 }
1256 }
1257
1258 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001259 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001260 }
1261
1262 if (!IncludeVirtualBases)
1263 return;
1264
1265 // Dump virtual bases.
1266 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1267 E = RD->vbases_end(); I != E; ++I) {
1268 assert(I->isVirtual() && "Found non-virtual class!");
1269 const CXXRecordDecl *VBase =
1270 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1271
1272 uint64_t VBaseOffset = Offset + Info.getVBaseClassOffset(VBase) / 8;
1273 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1274 VBase == PrimaryBase ?
1275 "(primary virtual base)" : "(virtual base)",
1276 /*IncludeVirtualBases=*/false);
1277 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001278
1279 OS << " sizeof=" << Info.getSize() / 8;
1280 OS << ", dsize=" << Info.getDataSize() / 8;
1281 OS << ", align=" << Info.getAlignment() / 8 << '\n';
1282 OS << " nvsize=" << Info.getNonVirtualSize() / 8;
1283 OS << ", nvalign=" << Info.getNonVirtualAlign() / 8 << '\n';
1284 OS << '\n';
1285}
Daniel Dunbarccabe482010-04-19 20:44:53 +00001286
1287void ASTContext::DumpRecordLayout(const RecordDecl *RD,
1288 llvm::raw_ostream &OS) {
1289 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1290
1291 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1292 return DumpCXXRecordLayout(OS, CXXRD, *this, 0, 0, 0,
1293 /*IncludeVirtualBases=*/true);
1294
1295 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1296 OS << "Record: ";
1297 RD->dump();
1298 OS << "\nLayout: ";
1299 OS << "<ASTRecordLayout\n";
1300 OS << " Size:" << Info.getSize() << "\n";
1301 OS << " DataSize:" << Info.getDataSize() << "\n";
1302 OS << " Alignment:" << Info.getAlignment() << "\n";
1303 OS << " FieldOffsets: [";
1304 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1305 if (i) OS << ", ";
1306 OS << Info.getFieldOffset(i);
1307 }
1308 OS << "]>\n";
1309}