blob: e845bdad6ccfc05ed0244db398306ab077ec0234 [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
Benjamin Kramerc7656cd2010-05-26 09:58:31 +000024namespace {
Anders Carlssonf58de112010-05-26 15:32:58 +000025
26/// EmptySubobjectMap - Keeps track of which empty subobjects exist at different
27/// offsets while laying out a C++ class.
28class EmptySubobjectMap {
29 ASTContext &Context;
30
31 /// Class - The class whose empty entries we're keeping track of.
32 const CXXRecordDecl *Class;
33
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000034 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
35 /// member subobject that is empty.
36 void ComputeEmptySubobjectSizes();
37
Anders Carlssonf58de112010-05-26 15:32:58 +000038public:
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000039 /// This holds the size of the largest empty subobject (either a base
40 /// or a member). Will be zero if the record being built doesn't contain
41 /// any empty classes.
42 uint64_t SizeOfLargestEmptySubobject;
43
Anders Carlssonf58de112010-05-26 15:32:58 +000044 EmptySubobjectMap(ASTContext &Context, const CXXRecordDecl *Class)
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000045 : Context(Context), Class(Class), SizeOfLargestEmptySubobject(0) { }
Anders Carlssonf58de112010-05-26 15:32:58 +000046
47};
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000048
49void EmptySubobjectMap::ComputeEmptySubobjectSizes() {
50 // Check the bases.
51 for (CXXRecordDecl::base_class_const_iterator I = Class->bases_begin(),
52 E = Class->bases_end(); I != E; ++I) {
53 const CXXRecordDecl *BaseDecl =
54 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
55
56 uint64_t EmptySize = 0;
57 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
58 if (BaseDecl->isEmpty()) {
59 // If the class decl is empty, get its size.
60 EmptySize = Layout.getSize();
61 } else {
62 // Otherwise, we get the largest empty subobject for the decl.
63 EmptySize = Layout.getSizeOfLargestEmptySubobject();
64 }
65
66 SizeOfLargestEmptySubobject = std::max(SizeOfLargestEmptySubobject,
67 EmptySize);
68 }
Anders Carlssonf58de112010-05-26 15:32:58 +000069
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000070 // Check the fields.
71 for (CXXRecordDecl::field_iterator I = Class->field_begin(),
72 E = Class->field_end(); I != E; ++I) {
73 const FieldDecl *FD = *I;
74
75 const RecordType *RT =
76 Context.getBaseElementType(FD->getType())->getAs<RecordType>();
77
78 // We only care about record types.
79 if (!RT)
80 continue;
81
82 uint64_t EmptySize = 0;
83 const CXXRecordDecl *MemberDecl = cast<CXXRecordDecl>(RT->getDecl());
84 const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
85 if (MemberDecl->isEmpty()) {
86 // If the class decl is empty, get its size.
87 EmptySize = Layout.getSize();
88 } else {
89 // Otherwise, we get the largest empty subobject for the decl.
90 EmptySize = Layout.getSizeOfLargestEmptySubobject();
91 }
92
93 SizeOfLargestEmptySubobject = std::max(SizeOfLargestEmptySubobject,
94 EmptySize);
95 }
96}
97
Anders Carlssonc2226202010-05-26 05:58:59 +000098class RecordLayoutBuilder {
Anders Carlsson35a36eb2010-05-26 05:41:04 +000099 // FIXME: Remove this and make the appropriate fields public.
100 friend class clang::ASTContext;
101
102 ASTContext &Context;
103
Anders Carlssonf58de112010-05-26 15:32:58 +0000104 EmptySubobjectMap *EmptySubobjects;
105
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000106 /// Size - The current size of the record layout.
107 uint64_t Size;
108
109 /// Alignment - The current alignment of the record layout.
110 unsigned Alignment;
111
112 llvm::SmallVector<uint64_t, 16> FieldOffsets;
113
114 /// Packed - Whether the record is packed or not.
115 bool Packed;
116
117 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
118 /// this contains the number of bits in the last byte that can be used for
119 /// an adjacent bitfield if necessary.
120 unsigned char UnfilledBitsInLastByte;
121
122 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
123 /// #pragma pack.
124 unsigned MaxFieldAlignment;
125
126 /// DataSize - The data size of the record being laid out.
127 uint64_t DataSize;
128
129 bool IsUnion;
130
131 uint64_t NonVirtualSize;
132 unsigned NonVirtualAlignment;
133
134 /// PrimaryBase - the primary base class (if one exists) of the class
135 /// we're laying out.
136 const CXXRecordDecl *PrimaryBase;
137
138 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
139 /// out is virtual.
140 bool PrimaryBaseIsVirtual;
141
142 typedef llvm::DenseMap<const CXXRecordDecl *, uint64_t> BaseOffsetsMapTy;
143
144 /// Bases - base classes and their offsets in the record.
145 BaseOffsetsMapTy Bases;
146
147 // VBases - virtual base classes and their offsets in the record.
148 BaseOffsetsMapTy VBases;
149
150 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
151 /// primary base classes for some other direct or indirect base class.
152 llvm::SmallSet<const CXXRecordDecl*, 32> IndirectPrimaryBases;
153
154 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
155 /// inheritance graph order. Used for determining the primary base class.
156 const CXXRecordDecl *FirstNearlyEmptyVBase;
157
158 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
159 /// avoid visiting virtual bases more than once.
160 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000161
162 /// EmptyClassOffsets - A map from offsets to empty record decls.
163 typedef std::multimap<uint64_t, const CXXRecordDecl *> EmptyClassOffsetsTy;
164 EmptyClassOffsetsTy EmptyClassOffsets;
165
Anders Carlssonce7f7772010-05-26 15:20:08 +0000166 RecordLayoutBuilder(ASTContext &Context)
Anders Carlssonf58de112010-05-26 15:32:58 +0000167 : Context(Context), EmptySubobjects(0), Size(0), Alignment(8),
168 Packed(false), UnfilledBitsInLastByte(0), MaxFieldAlignment(0), DataSize(0),
Anders Carlssonce7f7772010-05-26 15:20:08 +0000169 IsUnion(false), NonVirtualSize(0), NonVirtualAlignment(8), PrimaryBase(0),
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000170 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0) { }
Anders Carlssonce7f7772010-05-26 15:20:08 +0000171
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000172 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000173 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000174 void Layout(const ObjCInterfaceDecl *D);
175
176 void LayoutFields(const RecordDecl *D);
177 void LayoutField(const FieldDecl *D);
178 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize);
179 void LayoutBitField(const FieldDecl *D);
180
181 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
182 /// member subobject that is empty.
183 void ComputeEmptySubobjectSizes(const CXXRecordDecl *RD);
184
185 /// DeterminePrimaryBase - Determine the primary base of the given class.
186 void DeterminePrimaryBase(const CXXRecordDecl *RD);
187
188 void SelectPrimaryVBase(const CXXRecordDecl *RD);
189
190 /// IdentifyPrimaryBases - Identify all virtual base classes, direct or
191 /// indirect, that are primary base classes for some other direct or indirect
192 /// base class.
193 void IdentifyPrimaryBases(const CXXRecordDecl *RD);
194
195 bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
196
197 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
198 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
199 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
200
201 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
202 void LayoutNonVirtualBase(const CXXRecordDecl *RD);
203
204 void AddPrimaryVirtualBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
205 const CXXRecordDecl *MostDerivedClass);
206
207 /// LayoutVirtualBases - Lays out all the virtual bases.
208 void LayoutVirtualBases(const CXXRecordDecl *RD,
209 const CXXRecordDecl *MostDerivedClass);
210
211 /// LayoutVirtualBase - Lays out a single virtual base.
212 void LayoutVirtualBase(const CXXRecordDecl *RD);
213
214 /// LayoutBase - Will lay out a base and return the offset where it was
215 /// placed, in bits.
216 uint64_t LayoutBase(const CXXRecordDecl *RD);
217
218 /// canPlaceRecordAtOffset - Return whether a record (either a base class
219 /// or a field) can be placed at the given offset.
220 /// Returns false if placing the record will result in two components
221 /// (direct or indirect) of the same type having the same offset.
222 bool canPlaceRecordAtOffset(const CXXRecordDecl *RD, uint64_t Offset,
223 bool CheckVBases) const;
224
225 /// canPlaceFieldAtOffset - Return whether a field can be placed at the given
226 /// offset.
227 bool canPlaceFieldAtOffset(const FieldDecl *FD, uint64_t Offset) const;
228
229 /// UpdateEmptyClassOffsets - Called after a record (either a base class
230 /// or a field) has been placed at the given offset. Will update the
231 /// EmptyClassOffsets map if the class is empty or has any empty bases or
232 /// fields.
233 void UpdateEmptyClassOffsets(const CXXRecordDecl *RD, uint64_t Offset,
234 bool UpdateVBases);
235
236 /// UpdateEmptyClassOffsets - Called after a field has been placed at the
237 /// given offset.
238 void UpdateEmptyClassOffsets(const FieldDecl *FD, uint64_t Offset);
239
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000240 /// InitializeLayout - Initialize record layout for the given record decl.
241 void InitializeLayout(const RecordDecl *D);
242
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000243 /// FinishLayout - Finalize record layout. Adjust record size based on the
244 /// alignment.
245 void FinishLayout();
246
247 void UpdateAlignment(unsigned NewAlignment);
248
Anders Carlssonc2226202010-05-26 05:58:59 +0000249 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
250 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000251public:
252 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000253
254 uint64_t getSizeOfLargestEmptySubobject() {
255 return EmptySubobjects->SizeOfLargestEmptySubobject;
256 }
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000257};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000258} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000259
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000260/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
261/// no other data.
Anders Carlssonc2226202010-05-26 05:58:59 +0000262bool RecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000263 // FIXME: Audit the corners
264 if (!RD->isDynamicClass())
265 return false;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000266 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
267 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0))
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000268 return true;
269 return false;
270}
271
Anders Carlssonc2226202010-05-26 05:58:59 +0000272void RecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000273 const ASTRecordLayout::PrimaryBaseInfo &BaseInfo =
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000274 Context.getASTRecordLayout(RD).getPrimaryBaseInfo();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000275
Anders Carlsson81430692009-09-22 03:02:06 +0000276 // If the record has a primary base class that is virtual, add it to the set
277 // of primary bases.
Anders Carlssona30c0d32009-11-27 22:14:40 +0000278 if (BaseInfo.isVirtual())
279 IndirectPrimaryBases.insert(BaseInfo.getBase());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000280
Anders Carlsson81430692009-09-22 03:02:06 +0000281 // Now traverse all bases and find primary bases for them.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000282 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000283 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000284 assert(!i->getType()->isDependentType() &&
285 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000286 const CXXRecordDecl *Base =
Mike Stump78696a72009-08-11 04:03:59 +0000287 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000288
Mike Stump78696a72009-08-11 04:03:59 +0000289 // Only bases with virtual bases participate in computing the
290 // indirect primary virtual base classes.
Mike Stumpc2f591b2009-08-13 22:53:07 +0000291 if (Base->getNumVBases())
Anders Carlsson81430692009-09-22 03:02:06 +0000292 IdentifyPrimaryBases(Base);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000293 }
294}
295
Anders Carlsson81430692009-09-22 03:02:06 +0000296void
Anders Carlssonc2226202010-05-26 05:58:59 +0000297RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000298 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000299 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000300 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000301 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000302
Mike Stump11289f42009-09-09 15:08:12 +0000303 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000304 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000305
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000306 // Check if this is a nearly empty virtual base.
307 if (I->isVirtual() && IsNearlyEmpty(Base)) {
308 // If it's not an indirect primary base, then we've found our primary
309 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000310 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000311 PrimaryBase = Base;
312 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000313 return;
314 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000315
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000316 // Is this the first nearly empty virtual base?
317 if (!FirstNearlyEmptyVBase)
318 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000319 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000320
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000321 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000322 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000323 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000324 }
325}
326
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000327/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000328void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000329 // If the class isn't dynamic, it won't have a primary base.
330 if (!RD->isDynamicClass())
331 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000332
Anders Carlsson81430692009-09-22 03:02:06 +0000333 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000334 // indirect bases, and record all their primary virtual base classes.
Mike Stump590a7c72009-08-13 23:26:06 +0000335 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000336 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000337 assert(!i->getType()->isDependentType() &&
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000338 "Cannot lay out class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000339 const CXXRecordDecl *Base =
Mike Stump590a7c72009-08-13 23:26:06 +0000340 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +0000341 IdentifyPrimaryBases(Base);
Mike Stump590a7c72009-08-13 23:26:06 +0000342 }
343
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000344 // If the record has a dynamic base class, attempt to choose a primary base
345 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000346 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000347 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000348 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000349 // Ignore virtual bases.
350 if (i->isVirtual())
351 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000352
Anders Carlsson03ff3792009-11-27 22:05:05 +0000353 const CXXRecordDecl *Base =
354 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
355
356 if (Base->isDynamicClass()) {
357 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000358 PrimaryBase = Base;
359 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000360 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000361 }
362 }
363
364 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000365 // indirect primary virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000366 if (RD->getNumVBases() != 0) {
367 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000368 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000369 return;
370 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000371
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000372 // Otherwise, it is the first nearly empty virtual base that is not an
373 // indirect primary virtual base class, if one exists.
374 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000375 PrimaryBase = FirstNearlyEmptyVBase;
376 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000377 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000378 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000379
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000380 // Otherwise there is no primary base class.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000381 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000382
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000383 // Allocate the virtual table pointer at offset zero.
384 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000385
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000386 // Update the size.
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000387 Size += Context.Target.getPointerWidth(0);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000388 DataSize = Size;
389
390 // Update the alignment.
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000391 UpdateAlignment(Context.Target.getPointerAlign(0));
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000392}
393
Anders Carlsson09ffa322010-03-10 22:21:28 +0000394void
Anders Carlssonc2226202010-05-26 05:58:59 +0000395RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000396 // First, determine the primary base class.
397 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000398
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000399 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000400 if (PrimaryBase) {
401 if (PrimaryBaseIsVirtual) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000402 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000403 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +0000404
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000405 assert(!VisitedVirtualBases.count(PrimaryBase) &&
406 "vbase already visited!");
407 VisitedVirtualBases.insert(PrimaryBase);
Anders Carlsson291279e2010-04-10 18:42:27 +0000408
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000409 LayoutVirtualBase(PrimaryBase);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000410 } else
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000411 LayoutNonVirtualBase(PrimaryBase);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000412 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000413
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000414 // Now lay out the non-virtual bases.
415 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000416 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000417
418 // Ignore virtual bases.
419 if (I->isVirtual())
420 continue;
421
422 const CXXRecordDecl *Base =
423 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
424
425 // Skip the primary base.
Anders Carlssonb48414f2010-05-26 05:31:23 +0000426 if (Base == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000427 continue;
428
429 // Lay out the base.
430 LayoutNonVirtualBase(Base);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000431 }
432}
433
Anders Carlssonc2226202010-05-26 05:58:59 +0000434void RecordLayoutBuilder::LayoutNonVirtualBase(const CXXRecordDecl *RD) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000435 // Layout the base.
436 uint64_t Offset = LayoutBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000437
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000438 // Add its base class offset.
Anders Carlsson6a848892010-03-11 04:10:39 +0000439 if (!Bases.insert(std::make_pair(RD, Offset)).second)
440 assert(false && "Added same base offset more than once!");
Anders Carlsson09ffa322010-03-10 22:21:28 +0000441}
Mike Stump2b84dd32009-11-05 04:02:15 +0000442
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000443void
Anders Carlssonc2226202010-05-26 05:58:59 +0000444RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +0000445 uint64_t Offset,
446 const CXXRecordDecl *MostDerivedClass) {
447 // We already have the offset for the primary base of the most derived class.
448 if (RD != MostDerivedClass) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000449 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonea7b1822010-04-15 16:12:58 +0000450 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
451
452 // If this is a primary virtual base and we haven't seen it before, add it.
453 if (PrimaryBase && Layout.getPrimaryBaseWasVirtual() &&
454 !VBases.count(PrimaryBase))
455 VBases.insert(std::make_pair(PrimaryBase, Offset));
456 }
457
458 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
459 E = RD->bases_end(); I != E; ++I) {
460 assert(!I->getType()->isDependentType() &&
461 "Cannot layout class with dependent bases.");
462
463 const CXXRecordDecl *BaseDecl =
464 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
465
466 if (!BaseDecl->getNumVBases()) {
467 // This base isn't interesting since it doesn't have any virtual bases.
468 continue;
469 }
470
471 // Compute the offset of this base.
472 uint64_t BaseOffset;
473
474 if (I->isVirtual()) {
475 // If we don't know this vbase yet, don't visit it. It will be visited
476 // later.
477 if (!VBases.count(BaseDecl)) {
478 continue;
479 }
480
481 // Check if we've already visited this base.
482 if (!VisitedVirtualBases.insert(BaseDecl))
483 continue;
484
485 // We want the vbase offset from the class we're currently laying out.
486 BaseOffset = VBases[BaseDecl];
487 } else if (RD == MostDerivedClass) {
488 // We want the base offset from the class we're currently laying out.
489 assert(Bases.count(BaseDecl) && "Did not find base!");
490 BaseOffset = Bases[BaseDecl];
491 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000492 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonea7b1822010-04-15 16:12:58 +0000493 BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
494 }
495
496 AddPrimaryVirtualBaseOffsets(BaseDecl, BaseOffset, MostDerivedClass);
497 }
498}
499
500void
Anders Carlssonc2226202010-05-26 05:58:59 +0000501RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +0000502 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +0000503 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +0000504 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +0000505
Anders Carlsson291279e2010-04-10 18:42:27 +0000506 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000507 PrimaryBase = this->PrimaryBase;
508 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +0000509 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000510 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +0000511 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson291279e2010-04-10 18:42:27 +0000512 PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
513 }
514
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000515 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
516 E = RD->bases_end(); I != E; ++I) {
517 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000518 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000519
Mike Stump11289f42009-09-09 15:08:12 +0000520 const CXXRecordDecl *Base =
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000521 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
522
523 if (I->isVirtual()) {
Anders Carlsson291279e2010-04-10 18:42:27 +0000524 if (PrimaryBase != Base || !PrimaryBaseIsVirtual) {
525 bool IndirectPrimaryBase = IndirectPrimaryBases.count(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000526
Anders Carlsson291279e2010-04-10 18:42:27 +0000527 // Only lay out the virtual base if it's not an indirect primary base.
528 if (!IndirectPrimaryBase) {
529 // Only visit virtual bases once.
530 if (!VisitedVirtualBases.insert(Base))
531 continue;
532
Anders Carlssonfe900962010-03-11 05:42:17 +0000533 LayoutVirtualBase(Base);
Anders Carlsson6a848892010-03-11 04:10:39 +0000534 }
Mike Stump2b84dd32009-11-05 04:02:15 +0000535 }
Mike Stumpc2f591b2009-08-13 22:53:07 +0000536 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000537
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000538 if (!Base->getNumVBases()) {
539 // This base isn't interesting since it doesn't have any virtual bases.
540 continue;
Mike Stump996576f32009-08-16 19:04:13 +0000541 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000542
Anders Carlssonea7b1822010-04-15 16:12:58 +0000543 LayoutVirtualBases(Base, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +0000544 }
545}
546
Anders Carlssonc2226202010-05-26 05:58:59 +0000547void RecordLayoutBuilder::LayoutVirtualBase(const CXXRecordDecl *RD) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000548 // Layout the base.
549 uint64_t Offset = LayoutBase(RD);
550
551 // Add its base class offset.
Anders Carlsson6a848892010-03-11 04:10:39 +0000552 if (!VBases.insert(std::make_pair(RD, Offset)).second)
553 assert(false && "Added same vbase offset more than once!");
Anders Carlsson09ffa322010-03-10 22:21:28 +0000554}
555
Anders Carlssonc2226202010-05-26 05:58:59 +0000556uint64_t RecordLayoutBuilder::LayoutBase(const CXXRecordDecl *RD) {
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000557 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000558
559 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond626cb72010-05-10 15:26:14 +0000560 if (RD->isEmpty() && canPlaceRecordAtOffset(RD, 0, /*CheckVBases=*/false)) {
Anders Carlsson09ffa322010-03-10 22:21:28 +0000561 // We were able to place the class at offset 0.
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000562 UpdateEmptyClassOffsets(RD, 0, /*UpdateVBases=*/false);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000563
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000564 Size = std::max(Size, Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +0000565
566 return 0;
567 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000568
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000569 unsigned BaseAlign = Layout.getNonVirtualAlign();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000570
Anders Carlsson09ffa322010-03-10 22:21:28 +0000571 // Round up the current record size to the base's alignment boundary.
572 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000573
Anders Carlsson09ffa322010-03-10 22:21:28 +0000574 // Try to place the base.
575 while (true) {
Anders Carlssond626cb72010-05-10 15:26:14 +0000576 if (canPlaceRecordAtOffset(RD, Offset, /*CheckVBases=*/false))
Anders Carlsson09ffa322010-03-10 22:21:28 +0000577 break;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000578
Anders Carlsson09ffa322010-03-10 22:21:28 +0000579 Offset += BaseAlign;
580 }
581
582 if (!RD->isEmpty()) {
583 // Update the data size.
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000584 DataSize = Offset + Layout.getNonVirtualSize();
Anders Carlsson09ffa322010-03-10 22:21:28 +0000585
586 Size = std::max(Size, DataSize);
587 } else
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000588 Size = std::max(Size, Offset + Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +0000589
590 // Remember max struct/class alignment.
591 UpdateAlignment(BaseAlign);
592
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000593 UpdateEmptyClassOffsets(RD, Offset, /*UpdateVBases=*/false);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000594 return Offset;
595}
596
Anders Carlssond626cb72010-05-10 15:26:14 +0000597bool
Anders Carlssonc2226202010-05-26 05:58:59 +0000598RecordLayoutBuilder::canPlaceRecordAtOffset(const CXXRecordDecl *RD,
Anders Carlssond626cb72010-05-10 15:26:14 +0000599 uint64_t Offset,
600 bool CheckVBases) const {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000601 // Look for an empty class with the same type at the same offset.
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000602 for (EmptyClassOffsetsTy::const_iterator I =
603 EmptyClassOffsets.lower_bound(Offset),
604 E = EmptyClassOffsets.upper_bound(Offset); I != E; ++I) {
605
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000606 if (I->second == RD)
607 return false;
608 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000609
Anders Carlsson82828a32010-05-09 05:03:38 +0000610 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000611
612 // Check bases.
613 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000614 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000615 assert(!I->getType()->isDependentType() &&
616 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000617 if (I->isVirtual())
618 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000619
Anders Carlsson82828a32010-05-09 05:03:38 +0000620 const CXXRecordDecl *BaseDecl =
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000621 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
622
Anders Carlsson82828a32010-05-09 05:03:38 +0000623 uint64_t BaseOffset = Layout.getBaseClassOffset(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000624
Anders Carlssond626cb72010-05-10 15:26:14 +0000625 if (!canPlaceRecordAtOffset(BaseDecl, Offset + BaseOffset,
626 /*CheckVBases=*/false))
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000627 return false;
628 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000629
Anders Carlssond7d358a2009-09-25 15:39:00 +0000630 // Check fields.
631 unsigned FieldNo = 0;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000632 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
Anders Carlssond7d358a2009-09-25 15:39:00 +0000633 I != E; ++I, ++FieldNo) {
634 const FieldDecl *FD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000635
Anders Carlsson82828a32010-05-09 05:03:38 +0000636 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000637
Anders Carlssond7d358a2009-09-25 15:39:00 +0000638 if (!canPlaceFieldAtOffset(FD, Offset + FieldOffset))
639 return false;
640 }
641
Anders Carlssond626cb72010-05-10 15:26:14 +0000642 if (CheckVBases) {
643 // FIXME: virtual bases.
644 }
645
Anders Carlsson6522b052009-09-24 03:13:30 +0000646 return true;
647}
648
Anders Carlssonc2226202010-05-26 05:58:59 +0000649bool RecordLayoutBuilder::canPlaceFieldAtOffset(const FieldDecl *FD,
Anders Carlsson6f95c702009-09-25 00:02:51 +0000650 uint64_t Offset) const {
Anders Carlsson4bf82142009-09-25 01:23:32 +0000651 QualType T = FD->getType();
652 if (const RecordType *RT = T->getAs<RecordType>()) {
Anders Carlsson6f95c702009-09-25 00:02:51 +0000653 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
Anders Carlssond626cb72010-05-10 15:26:14 +0000654 return canPlaceRecordAtOffset(RD, Offset, /*CheckVBases=*/true);
Anders Carlsson6f95c702009-09-25 00:02:51 +0000655 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000656
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000657 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
658 QualType ElemTy = Context.getBaseElementType(AT);
Anders Carlsson4bf82142009-09-25 01:23:32 +0000659 const RecordType *RT = ElemTy->getAs<RecordType>();
660 if (!RT)
661 return true;
662 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
663 if (!RD)
664 return true;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000665
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000666 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson4bf82142009-09-25 01:23:32 +0000667
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000668 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Mike Stump2b84dd32009-11-05 04:02:15 +0000669 uint64_t ElementOffset = Offset;
Anders Carlsson4bf82142009-09-25 01:23:32 +0000670 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssond626cb72010-05-10 15:26:14 +0000671 if (!canPlaceRecordAtOffset(RD, ElementOffset, /*CheckVBases=*/true))
Anders Carlsson4bf82142009-09-25 01:23:32 +0000672 return false;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000673
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000674 ElementOffset += Layout.getSize();
Anders Carlsson4bf82142009-09-25 01:23:32 +0000675 }
676 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000677
Anders Carlsson6f95c702009-09-25 00:02:51 +0000678 return true;
679}
680
Anders Carlssonc2226202010-05-26 05:58:59 +0000681void RecordLayoutBuilder::UpdateEmptyClassOffsets(const CXXRecordDecl *RD,
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000682 uint64_t Offset,
683 bool UpdateVBases) {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000684 if (RD->isEmpty())
685 EmptyClassOffsets.insert(std::make_pair(Offset, RD));
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000686
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000687 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000688
689 // Update bases.
690 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000691 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000692 assert(!I->getType()->isDependentType() &&
693 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000694 if (I->isVirtual())
695 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000696
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000697 const CXXRecordDecl *Base =
698 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000699
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000700 uint64_t BaseClassOffset = Layout.getBaseClassOffset(Base);
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000701 UpdateEmptyClassOffsets(Base, Offset + BaseClassOffset,
702 /*UpdateVBases=*/false);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000703 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000704
Anders Carlssond7d358a2009-09-25 15:39:00 +0000705 // Update fields.
706 unsigned FieldNo = 0;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000707 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
Anders Carlssond7d358a2009-09-25 15:39:00 +0000708 I != E; ++I, ++FieldNo) {
709 const FieldDecl *FD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000710
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000711 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
Anders Carlssond7d358a2009-09-25 15:39:00 +0000712 UpdateEmptyClassOffsets(FD, Offset + FieldOffset);
713 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000714
Anders Carlsson57732052010-05-23 18:14:24 +0000715 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
716
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000717 if (UpdateVBases) {
718 // FIXME: Update virtual bases.
Anders Carlsson57732052010-05-23 18:14:24 +0000719 } else if (PrimaryBase && Layout.getPrimaryBaseWasVirtual()) {
720 // We always want to update the offsets of a primary virtual base.
721 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
722 "primary base class offset must always be 0!");
723 UpdateEmptyClassOffsets(PrimaryBase, Offset, /*UpdateVBases=*/false);
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000724 }
Anders Carlsson6522b052009-09-24 03:13:30 +0000725}
726
Anders Carlssone1883102009-09-25 01:54:38 +0000727void
Anders Carlssonc2226202010-05-26 05:58:59 +0000728RecordLayoutBuilder::UpdateEmptyClassOffsets(const FieldDecl *FD,
Anders Carlssone1883102009-09-25 01:54:38 +0000729 uint64_t Offset) {
730 QualType T = FD->getType();
731
732 if (const RecordType *RT = T->getAs<RecordType>()) {
733 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000734 UpdateEmptyClassOffsets(RD, Offset, /*UpdateVBases=*/true);
Anders Carlssone1883102009-09-25 01:54:38 +0000735 return;
736 }
737 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000738
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000739 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
740 QualType ElemTy = Context.getBaseElementType(AT);
Anders Carlssone1883102009-09-25 01:54:38 +0000741 const RecordType *RT = ElemTy->getAs<RecordType>();
742 if (!RT)
743 return;
744 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
745 if (!RD)
746 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000747
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000748 const ASTRecordLayout &Info = Context.getASTRecordLayout(RD);
Anders Carlssone1883102009-09-25 01:54:38 +0000749
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000750 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Mike Stump2b84dd32009-11-05 04:02:15 +0000751 uint64_t ElementOffset = Offset;
Anders Carlssone1883102009-09-25 01:54:38 +0000752
753 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000754 UpdateEmptyClassOffsets(RD, ElementOffset, /*UpdateVBases=*/true);
Anders Carlssone1883102009-09-25 01:54:38 +0000755 ElementOffset += Info.getSize();
756 }
757 }
758}
759
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000760void RecordLayoutBuilder::InitializeLayout(const RecordDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +0000761 IsUnion = D->isUnion();
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000762
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000763 Packed = D->hasAttr<PackedAttr>();
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000764
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000765 // The #pragma pack attribute specifies the maximum field alignment.
Anders Carlsson68e0b682009-08-08 18:23:56 +0000766 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000767 MaxFieldAlignment = PPA->getAlignment();
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000768
Anders Carlsson79474332009-07-18 20:20:21 +0000769 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Alexis Hunt96d5c762009-11-21 08:43:09 +0000770 UpdateAlignment(AA->getMaxAlignment());
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000771}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000772
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000773void RecordLayoutBuilder::Layout(const RecordDecl *D) {
774 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +0000775 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +0000776
Anders Carlsson79474332009-07-18 20:20:21 +0000777 // Finally, round the size of the total struct up to the alignment of the
778 // struct itself.
779 FinishLayout();
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000780}
781
782void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
Anders Carlssonf58de112010-05-26 15:32:58 +0000783 // Create our empty subobject offset map.
784 EmptySubobjectMap EmptySubobjectMap(Context, RD);
785 EmptySubobjects = &EmptySubobjectMap;
786
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000787 InitializeLayout(RD);
788
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000789 // Lay out the vtable and the non-virtual bases.
790 LayoutNonVirtualBases(RD);
791
792 LayoutFields(RD);
793
794 NonVirtualSize = Size;
795 NonVirtualAlignment = Alignment;
796
797 // Lay out the virtual bases and add the primary virtual base offsets.
798 LayoutVirtualBases(RD, RD);
799
800 VisitedVirtualBases.clear();
801 AddPrimaryVirtualBaseOffsets(RD, 0, RD);
802
803 // Finally, round the size of the total struct up to the alignment of the
804 // struct itself.
805 FinishLayout();
806
Anders Carlsson5b441d72010-04-10 21:24:48 +0000807#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000808 // Check that we have base offsets for all bases.
809 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
810 E = RD->bases_end(); I != E; ++I) {
811 if (I->isVirtual())
812 continue;
Anders Carlsson5b441d72010-04-10 21:24:48 +0000813
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000814 const CXXRecordDecl *BaseDecl =
815 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
816
817 assert(Bases.count(BaseDecl) && "Did not find base offset!");
818 }
819
820 // And all virtual bases.
821 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
822 E = RD->vbases_end(); I != E; ++I) {
823 const CXXRecordDecl *BaseDecl =
824 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson5b441d72010-04-10 21:24:48 +0000825
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000826 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +0000827 }
828#endif
Anders Carlsson79474332009-07-18 20:20:21 +0000829}
830
Anders Carlssonc2226202010-05-26 05:58:59 +0000831void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +0000832 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000833 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +0000834
835 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +0000836
Anders Carlsson4f516282009-07-18 20:50:59 +0000837 // We start laying out ivars not at the end of the superclass
838 // structure, but at the next byte following the last field.
Anders Carlsson27b50132009-07-18 21:26:44 +0000839 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlsson47680d82009-09-26 01:34:51 +0000840 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +0000841 }
Mike Stump11289f42009-09-09 15:08:12 +0000842
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000843 Packed = D->hasAttr<PackedAttr>();
Mike Stump11289f42009-09-09 15:08:12 +0000844
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000845 // The #pragma pack attribute specifies the maximum field alignment.
846 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
847 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000848
Anders Carlsson4f516282009-07-18 20:50:59 +0000849 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Alexis Hunt96d5c762009-11-21 08:43:09 +0000850 UpdateAlignment(AA->getMaxAlignment());
Anders Carlsson4f516282009-07-18 20:50:59 +0000851 // Layout each ivar sequentially.
852 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000853 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson4f516282009-07-18 20:50:59 +0000854 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
855 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +0000856
Anders Carlsson4f516282009-07-18 20:50:59 +0000857 // Finally, round the size of the total struct up to the alignment of the
858 // struct itself.
859 FinishLayout();
860}
861
Anders Carlssonc2226202010-05-26 05:58:59 +0000862void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +0000863 // Layout each field, for now, just sequentially, respecting alignment. In
864 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +0000865 for (RecordDecl::field_iterator Field = D->field_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000866 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
Anders Carlsson118ce162009-07-18 21:48:39 +0000867 LayoutField(*Field);
868}
869
Anders Carlssonc2226202010-05-26 05:58:59 +0000870void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Anders Carlsson57235162010-04-16 15:57:11 +0000871 uint64_t TypeSize) {
872 assert(Context.getLangOptions().CPlusPlus &&
873 "Can only have wide bit-fields in C++!");
874
875 // Itanium C++ ABI 2.4:
876 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
877 // sizeof(T')*8 <= n.
878
879 QualType IntegralPODTypes[] = {
880 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
881 Context.UnsignedLongTy, Context.UnsignedLongLongTy
882 };
883
Anders Carlsson57235162010-04-16 15:57:11 +0000884 QualType Type;
885 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
886 I != E; ++I) {
887 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +0000888
889 if (Size > FieldSize)
890 break;
891
892 Type = IntegralPODTypes[I];
893 }
894 assert(!Type.isNull() && "Did not find a type!");
Anders Carlsson57235162010-04-16 15:57:11 +0000895
896 unsigned TypeAlign = Context.getTypeAlign(Type);
897
898 // We're not going to use any of the unfilled bits in the last byte.
899 UnfilledBitsInLastByte = 0;
900
Anders Carlssonaad5fa82010-04-17 20:21:41 +0000901 uint64_t FieldOffset;
902
Anders Carlsson57235162010-04-16 15:57:11 +0000903 if (IsUnion) {
904 DataSize = std::max(DataSize, FieldSize);
Anders Carlssonaad5fa82010-04-17 20:21:41 +0000905 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +0000906 } else {
Anders Carlssonaad5fa82010-04-17 20:21:41 +0000907 // The bitfield is allocated starting at the next offset aligned appropriately
908 // for T', with length n bits.
909 FieldOffset = llvm::RoundUpToAlignment(DataSize, TypeAlign);
910
Anders Carlsson57235162010-04-16 15:57:11 +0000911 uint64_t NewSizeInBits = FieldOffset + FieldSize;
912
913 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
914 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
915 }
916
917 // Place this field at the current location.
918 FieldOffsets.push_back(FieldOffset);
919
920 // Update the size.
921 Size = std::max(Size, DataSize);
922
923 // Remember max struct/class alignment.
924 UpdateAlignment(TypeAlign);
925}
926
Anders Carlssonc2226202010-05-26 05:58:59 +0000927void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +0000928 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlssonba958402009-11-22 19:13:51 +0000929 uint64_t FieldOffset = IsUnion ? 0 : (DataSize - UnfilledBitsInLastByte);
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000930 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000931
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000932 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +0000933 uint64_t TypeSize = FieldInfo.first;
934 unsigned FieldAlign = FieldInfo.second;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000935
Anders Carlsson57235162010-04-16 15:57:11 +0000936 if (FieldSize > TypeSize) {
937 LayoutWideBitField(FieldSize, TypeSize);
938 return;
939 }
940
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000941 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson07209442009-11-22 17:37:31 +0000942 FieldAlign = 1;
943 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
944 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
945
946 // The maximum field alignment overrides the aligned attribute.
947 if (MaxFieldAlignment)
948 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000949
Daniel Dunbar3d9289c2010-04-15 06:18:39 +0000950 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson07209442009-11-22 17:37:31 +0000951 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
952 FieldOffset = (FieldOffset + (FieldAlign-1)) & ~(FieldAlign-1);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000953
Daniel Dunbar3d9289c2010-04-15 06:18:39 +0000954 // Padding members don't affect overall alignment.
Anders Carlsson07209442009-11-22 17:37:31 +0000955 if (!D->getIdentifier())
956 FieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000957
Anders Carlsson07209442009-11-22 17:37:31 +0000958 // Place this field at the current location.
959 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000960
Anders Carlssonba958402009-11-22 19:13:51 +0000961 // Update DataSize to include the last byte containing (part of) the bitfield.
962 if (IsUnion) {
963 // FIXME: I think FieldSize should be TypeSize here.
964 DataSize = std::max(DataSize, FieldSize);
965 } else {
966 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000967
Anders Carlssonba958402009-11-22 19:13:51 +0000968 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
969 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
970 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000971
Anders Carlssonba958402009-11-22 19:13:51 +0000972 // Update the size.
973 Size = std::max(Size, DataSize);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000974
Anders Carlsson07209442009-11-22 17:37:31 +0000975 // Remember max struct/class alignment.
976 UpdateAlignment(FieldAlign);
977}
978
Anders Carlssonc2226202010-05-26 05:58:59 +0000979void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +0000980 if (D->isBitField()) {
981 LayoutBitField(D);
982 return;
983 }
984
Anders Carlssonba958402009-11-22 19:13:51 +0000985 // Reset the unfilled bits.
986 UnfilledBitsInLastByte = 0;
987
Anders Carlsson07209442009-11-22 17:37:31 +0000988 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlsson47680d82009-09-26 01:34:51 +0000989 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +0000990 uint64_t FieldSize;
991 unsigned FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000992
Anders Carlsson07209442009-11-22 17:37:31 +0000993 if (D->getType()->isIncompleteArrayType()) {
994 // This is a flexible array member; we can't directly
995 // query getTypeInfo about these, so we figure it out here.
996 // Flexible array members don't have any size, but they
997 // have to be aligned appropriately for their element type.
998 FieldSize = 0;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000999 const ArrayType* ATy = Context.getAsArrayType(D->getType());
1000 FieldAlign = Context.getTypeAlign(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001001 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1002 unsigned AS = RT->getPointeeType().getAddressSpace();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001003 FieldSize = Context.Target.getPointerWidth(AS);
1004 FieldAlign = Context.Target.getPointerAlign(AS);
Anders Carlsson79474332009-07-18 20:20:21 +00001005 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001006 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001007 FieldSize = FieldInfo.first;
1008 FieldAlign = FieldInfo.second;
Anders Carlsson79474332009-07-18 20:20:21 +00001009 }
Mike Stump11289f42009-09-09 15:08:12 +00001010
Anders Carlsson07209442009-11-22 17:37:31 +00001011 if (FieldPacked)
1012 FieldAlign = 8;
1013 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
1014 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
1015
1016 // The maximum field alignment overrides the aligned attribute.
1017 if (MaxFieldAlignment)
1018 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
1019
1020 // Round up the current record size to the field's alignment boundary.
1021 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001022
Anders Carlsson07209442009-11-22 17:37:31 +00001023 if (!IsUnion) {
1024 while (true) {
1025 // Check if we can place the field at this offset.
1026 if (canPlaceFieldAtOffset(D, FieldOffset))
1027 break;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001028
Anders Carlsson07209442009-11-22 17:37:31 +00001029 // We couldn't place the field at the offset. Try again at a new offset.
1030 FieldOffset += FieldAlign;
1031 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001032
Anders Carlsson07209442009-11-22 17:37:31 +00001033 UpdateEmptyClassOffsets(D, FieldOffset);
1034 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001035
Anders Carlsson79474332009-07-18 20:20:21 +00001036 // Place this field at the current location.
1037 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +00001038
Anders Carlsson79474332009-07-18 20:20:21 +00001039 // Reserve space for this field.
1040 if (IsUnion)
1041 Size = std::max(Size, FieldSize);
1042 else
1043 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +00001044
Anders Carlsson47680d82009-09-26 01:34:51 +00001045 // Update the data size.
1046 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +00001047
Anders Carlsson79474332009-07-18 20:20:21 +00001048 // Remember max struct/class alignment.
1049 UpdateAlignment(FieldAlign);
1050}
1051
Anders Carlssonc2226202010-05-26 05:58:59 +00001052void RecordLayoutBuilder::FinishLayout() {
Anders Carlsson79474332009-07-18 20:20:21 +00001053 // In C++, records cannot be of size 0.
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001054 if (Context.getLangOptions().CPlusPlus && Size == 0)
Anders Carlsson79474332009-07-18 20:20:21 +00001055 Size = 8;
1056 // Finally, round the size of the record up to the alignment of the
1057 // record itself.
Anders Carlsson07209442009-11-22 17:37:31 +00001058 Size = llvm::RoundUpToAlignment(Size, Alignment);
Anders Carlsson79474332009-07-18 20:20:21 +00001059}
1060
Anders Carlssonc2226202010-05-26 05:58:59 +00001061void RecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment) {
Anders Carlsson79474332009-07-18 20:20:21 +00001062 if (NewAlignment <= Alignment)
1063 return;
Mike Stump11289f42009-09-09 15:08:12 +00001064
Anders Carlsson79474332009-07-18 20:20:21 +00001065 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
Mike Stump11289f42009-09-09 15:08:12 +00001066
Anders Carlsson79474332009-07-18 20:20:21 +00001067 Alignment = NewAlignment;
1068}
Mike Stump11289f42009-09-09 15:08:12 +00001069
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001070const CXXMethodDecl *
Anders Carlssonc2226202010-05-26 05:58:59 +00001071RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001072 assert(RD->isDynamicClass() && "Class does not have any virtual methods!");
1073
Daniel Dunbarccabe482010-04-19 20:44:53 +00001074 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001075 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001076 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001077
1078 // A class inside an anonymous namespace doesn't have a key function. (Or
1079 // at least, there's no point to assigning a key function to such a class;
1080 // this doesn't affect the ABI.)
1081 if (RD->isInAnonymousNamespace())
1082 return 0;
1083
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001084 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1085 E = RD->method_end(); I != E; ++I) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001086 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001087
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001088 if (!MD->isVirtual())
1089 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001090
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001091 if (MD->isPure())
1092 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001093
Anders Carlssonf98849e2009-12-02 17:15:43 +00001094 // Ignore implicit member functions, they are always marked as inline, but
1095 // they don't have a body until they're defined.
1096 if (MD->isImplicit())
1097 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001098
Douglas Gregora318efd2010-01-05 19:06:31 +00001099 if (MD->isInlineSpecified())
1100 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001101
1102 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001103 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001104
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001105 // We found it.
1106 return MD;
1107 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001108
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001109 return 0;
1110}
1111
Anders Carlssondf291d82010-05-26 04:56:53 +00001112/// getASTRecordLayout - Get or compute information about the layout of the
1113/// specified record (struct/union/class), which indicates its size and field
1114/// position information.
1115const ASTRecordLayout &ASTContext::getASTRecordLayout(const RecordDecl *D) {
1116 D = D->getDefinition();
1117 assert(D && "Cannot get layout of forward declarations!");
1118
1119 // Look up this layout, if already laid out, return what we have.
1120 // Note that we can't save a reference to the entry because this function
1121 // is recursive.
1122 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1123 if (Entry) return *Entry;
1124
Anders Carlssond2954862010-05-26 05:10:47 +00001125 const ASTRecordLayout *NewEntry;
1126
1127 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc2226202010-05-26 05:58:59 +00001128 RecordLayoutBuilder Builder(*this);
Anders Carlssond2954862010-05-26 05:10:47 +00001129 Builder.Layout(RD);
1130
1131 // FIXME: This is not always correct. See the part about bitfields at
1132 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1133 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1134 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1135
1136 // FIXME: This should be done in FinalizeLayout.
1137 uint64_t DataSize =
1138 IsPODForThePurposeOfLayout ? Builder.Size : Builder.DataSize;
1139 uint64_t NonVirtualSize =
1140 IsPODForThePurposeOfLayout ? DataSize : Builder.NonVirtualSize;
1141
1142 NewEntry =
1143 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1144 DataSize, Builder.FieldOffsets.data(),
1145 Builder.FieldOffsets.size(),
1146 NonVirtualSize,
1147 Builder.NonVirtualAlignment,
Anders Carlssonc5ca1f72010-05-26 15:54:25 +00001148 Builder.getSizeOfLargestEmptySubobject(),
Anders Carlssond2954862010-05-26 05:10:47 +00001149 Builder.PrimaryBase,
Anders Carlsson1d1e4cf2010-05-26 05:25:15 +00001150 Builder.PrimaryBaseIsVirtual,
Anders Carlssond2954862010-05-26 05:10:47 +00001151 Builder.Bases, Builder.VBases);
1152 } else {
Anders Carlssonc2226202010-05-26 05:58:59 +00001153 RecordLayoutBuilder Builder(*this);
Anders Carlssond2954862010-05-26 05:10:47 +00001154 Builder.Layout(D);
1155
1156 NewEntry =
1157 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1158 Builder.Size,
1159 Builder.FieldOffsets.data(),
1160 Builder.FieldOffsets.size());
1161 }
1162
Anders Carlssondf291d82010-05-26 04:56:53 +00001163 ASTRecordLayouts[D] = NewEntry;
1164
1165 if (getLangOptions().DumpRecordLayouts) {
1166 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1167 DumpRecordLayout(D, llvm::errs());
1168 }
1169
1170 return *NewEntry;
1171}
1172
1173const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1174 RD = cast<CXXRecordDecl>(RD->getDefinition());
1175 assert(RD && "Cannot get key function for forward declarations!");
1176
1177 const CXXMethodDecl *&Entry = KeyFunctions[RD];
1178 if (!Entry)
Anders Carlssonc2226202010-05-26 05:58:59 +00001179 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Anders Carlssondf291d82010-05-26 04:56:53 +00001180 else
Anders Carlssonc2226202010-05-26 05:58:59 +00001181 assert(Entry == RecordLayoutBuilder::ComputeKeyFunction(RD) &&
Anders Carlssondf291d82010-05-26 04:56:53 +00001182 "Key function changed!");
1183
1184 return Entry;
1185}
1186
1187/// getInterfaceLayoutImpl - Get or compute information about the
1188/// layout of the given interface.
1189///
1190/// \param Impl - If given, also include the layout of the interface's
1191/// implementation. This may differ by including synthesized ivars.
1192const ASTRecordLayout &
1193ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
1194 const ObjCImplementationDecl *Impl) {
1195 assert(!D->isForwardDecl() && "Invalid interface decl!");
1196
1197 // Look up this layout, if already laid out, return what we have.
1198 ObjCContainerDecl *Key =
1199 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1200 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1201 return *Entry;
1202
1203 // Add in synthesized ivar count if laying out an implementation.
1204 if (Impl) {
1205 unsigned SynthCount = CountNonClassIvars(D);
1206 // If there aren't any sythesized ivars then reuse the interface
1207 // entry. Note we can't cache this because we simply free all
1208 // entries later; however we shouldn't look up implementations
1209 // frequently.
1210 if (SynthCount == 0)
1211 return getObjCLayout(D, 0);
1212 }
1213
Anders Carlssonc2226202010-05-26 05:58:59 +00001214 RecordLayoutBuilder Builder(*this);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001215 Builder.Layout(D);
1216
Anders Carlssondf291d82010-05-26 04:56:53 +00001217 const ASTRecordLayout *NewEntry =
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001218 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1219 Builder.DataSize,
1220 Builder.FieldOffsets.data(),
1221 Builder.FieldOffsets.size());
1222
Anders Carlssondf291d82010-05-26 04:56:53 +00001223 ObjCLayouts[Key] = NewEntry;
1224
1225 return *NewEntry;
1226}
1227
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001228static void PrintOffset(llvm::raw_ostream &OS,
1229 uint64_t Offset, unsigned IndentLevel) {
1230 OS << llvm::format("%4d | ", Offset);
1231 OS.indent(IndentLevel * 2);
1232}
1233
1234static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
1235 const CXXRecordDecl *RD, ASTContext &C,
1236 uint64_t Offset,
1237 unsigned IndentLevel,
1238 const char* Description,
1239 bool IncludeVirtualBases) {
1240 const ASTRecordLayout &Info = C.getASTRecordLayout(RD);
1241
1242 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00001243 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001244 if (Description)
1245 OS << ' ' << Description;
1246 if (RD->isEmpty())
1247 OS << " (empty)";
1248 OS << '\n';
1249
1250 IndentLevel++;
1251
1252 const CXXRecordDecl *PrimaryBase = Info.getPrimaryBase();
1253
1254 // Vtable pointer.
1255 if (RD->isDynamicClass() && !PrimaryBase) {
1256 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001257 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001258 }
1259 // Dump (non-virtual) bases
1260 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1261 E = RD->bases_end(); I != E; ++I) {
1262 assert(!I->getType()->isDependentType() &&
1263 "Cannot layout class with dependent bases.");
1264 if (I->isVirtual())
1265 continue;
1266
1267 const CXXRecordDecl *Base =
1268 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1269
1270 uint64_t BaseOffset = Offset + Info.getBaseClassOffset(Base) / 8;
1271
1272 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1273 Base == PrimaryBase ? "(primary base)" : "(base)",
1274 /*IncludeVirtualBases=*/false);
1275 }
1276
1277 // Dump fields.
1278 uint64_t FieldNo = 0;
1279 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1280 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1281 const FieldDecl *Field = *I;
1282 uint64_t FieldOffset = Offset + Info.getFieldOffset(FieldNo) / 8;
1283
1284 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1285 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1286 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
1287 Field->getNameAsCString(),
1288 /*IncludeVirtualBases=*/true);
1289 continue;
1290 }
1291 }
1292
1293 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001294 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001295 }
1296
1297 if (!IncludeVirtualBases)
1298 return;
1299
1300 // Dump virtual bases.
1301 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1302 E = RD->vbases_end(); I != E; ++I) {
1303 assert(I->isVirtual() && "Found non-virtual class!");
1304 const CXXRecordDecl *VBase =
1305 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1306
1307 uint64_t VBaseOffset = Offset + Info.getVBaseClassOffset(VBase) / 8;
1308 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1309 VBase == PrimaryBase ?
1310 "(primary virtual base)" : "(virtual base)",
1311 /*IncludeVirtualBases=*/false);
1312 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001313
1314 OS << " sizeof=" << Info.getSize() / 8;
1315 OS << ", dsize=" << Info.getDataSize() / 8;
1316 OS << ", align=" << Info.getAlignment() / 8 << '\n';
1317 OS << " nvsize=" << Info.getNonVirtualSize() / 8;
1318 OS << ", nvalign=" << Info.getNonVirtualAlign() / 8 << '\n';
1319 OS << '\n';
1320}
Daniel Dunbarccabe482010-04-19 20:44:53 +00001321
1322void ASTContext::DumpRecordLayout(const RecordDecl *RD,
1323 llvm::raw_ostream &OS) {
1324 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1325
1326 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1327 return DumpCXXRecordLayout(OS, CXXRD, *this, 0, 0, 0,
1328 /*IncludeVirtualBases=*/true);
1329
1330 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1331 OS << "Record: ";
1332 RD->dump();
1333 OS << "\nLayout: ";
1334 OS << "<ASTRecordLayout\n";
1335 OS << " Size:" << Info.getSize() << "\n";
1336 OS << " DataSize:" << Info.getDataSize() << "\n";
1337 OS << " Alignment:" << Info.getAlignment() << "\n";
1338 OS << " FieldOffsets: [";
1339 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1340 if (i) OS << ", ";
1341 OS << Info.getFieldOffset(i);
1342 }
1343 OS << "]>\n";
1344}