blob: 259606d0577505e2759695f28d7aa6f50ddbd1dd [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 Carlssonc2226202010-05-26 05:58:59 +000025class RecordLayoutBuilder {
Anders Carlsson35a36eb2010-05-26 05:41:04 +000026 // FIXME: Remove this and make the appropriate fields public.
27 friend class clang::ASTContext;
28
29 ASTContext &Context;
30
31 /// Size - The current size of the record layout.
32 uint64_t Size;
33
34 /// Alignment - The current alignment of the record layout.
35 unsigned Alignment;
36
37 llvm::SmallVector<uint64_t, 16> FieldOffsets;
38
39 /// Packed - Whether the record is packed or not.
40 bool Packed;
41
42 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
43 /// this contains the number of bits in the last byte that can be used for
44 /// an adjacent bitfield if necessary.
45 unsigned char UnfilledBitsInLastByte;
46
47 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
48 /// #pragma pack.
49 unsigned MaxFieldAlignment;
50
51 /// DataSize - The data size of the record being laid out.
52 uint64_t DataSize;
53
54 bool IsUnion;
55
56 uint64_t NonVirtualSize;
57 unsigned NonVirtualAlignment;
58
59 /// PrimaryBase - the primary base class (if one exists) of the class
60 /// we're laying out.
61 const CXXRecordDecl *PrimaryBase;
62
63 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
64 /// out is virtual.
65 bool PrimaryBaseIsVirtual;
66
67 typedef llvm::DenseMap<const CXXRecordDecl *, uint64_t> BaseOffsetsMapTy;
68
69 /// Bases - base classes and their offsets in the record.
70 BaseOffsetsMapTy Bases;
71
72 // VBases - virtual base classes and their offsets in the record.
73 BaseOffsetsMapTy VBases;
74
75 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
76 /// primary base classes for some other direct or indirect base class.
77 llvm::SmallSet<const CXXRecordDecl*, 32> IndirectPrimaryBases;
78
79 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
80 /// inheritance graph order. Used for determining the primary base class.
81 const CXXRecordDecl *FirstNearlyEmptyVBase;
82
83 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
84 /// avoid visiting virtual bases more than once.
85 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
86
87 /// SizeOfLargestEmptySubobject - When laying out C++ classes, this holds the
88 /// size of the largest empty subobject (either a base or a member).
89 /// Will be zero if the record being built doesn't contain any empty classes.
90 uint64_t SizeOfLargestEmptySubobject;
91
92 /// EmptyClassOffsets - A map from offsets to empty record decls.
93 typedef std::multimap<uint64_t, const CXXRecordDecl *> EmptyClassOffsetsTy;
94 EmptyClassOffsetsTy EmptyClassOffsets;
95
Anders Carlssonce7f7772010-05-26 15:20:08 +000096 RecordLayoutBuilder(ASTContext &Context)
97 : Context(Context), Size(0), Alignment(8), Packed(false),
98 UnfilledBitsInLastByte(0), MaxFieldAlignment(0), DataSize(0),
99 IsUnion(false), NonVirtualSize(0), NonVirtualAlignment(8), PrimaryBase(0),
100 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0),
101 SizeOfLargestEmptySubobject(0) { }
102
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000103 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000104 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000105 void Layout(const ObjCInterfaceDecl *D);
106
107 void LayoutFields(const RecordDecl *D);
108 void LayoutField(const FieldDecl *D);
109 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize);
110 void LayoutBitField(const FieldDecl *D);
111
112 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
113 /// member subobject that is empty.
114 void ComputeEmptySubobjectSizes(const CXXRecordDecl *RD);
115
116 /// DeterminePrimaryBase - Determine the primary base of the given class.
117 void DeterminePrimaryBase(const CXXRecordDecl *RD);
118
119 void SelectPrimaryVBase(const CXXRecordDecl *RD);
120
121 /// IdentifyPrimaryBases - Identify all virtual base classes, direct or
122 /// indirect, that are primary base classes for some other direct or indirect
123 /// base class.
124 void IdentifyPrimaryBases(const CXXRecordDecl *RD);
125
126 bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
127
128 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
129 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
130 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
131
132 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
133 void LayoutNonVirtualBase(const CXXRecordDecl *RD);
134
135 void AddPrimaryVirtualBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
136 const CXXRecordDecl *MostDerivedClass);
137
138 /// LayoutVirtualBases - Lays out all the virtual bases.
139 void LayoutVirtualBases(const CXXRecordDecl *RD,
140 const CXXRecordDecl *MostDerivedClass);
141
142 /// LayoutVirtualBase - Lays out a single virtual base.
143 void LayoutVirtualBase(const CXXRecordDecl *RD);
144
145 /// LayoutBase - Will lay out a base and return the offset where it was
146 /// placed, in bits.
147 uint64_t LayoutBase(const CXXRecordDecl *RD);
148
149 /// canPlaceRecordAtOffset - Return whether a record (either a base class
150 /// or a field) can be placed at the given offset.
151 /// Returns false if placing the record will result in two components
152 /// (direct or indirect) of the same type having the same offset.
153 bool canPlaceRecordAtOffset(const CXXRecordDecl *RD, uint64_t Offset,
154 bool CheckVBases) const;
155
156 /// canPlaceFieldAtOffset - Return whether a field can be placed at the given
157 /// offset.
158 bool canPlaceFieldAtOffset(const FieldDecl *FD, uint64_t Offset) const;
159
160 /// UpdateEmptyClassOffsets - Called after a record (either a base class
161 /// or a field) has been placed at the given offset. Will update the
162 /// EmptyClassOffsets map if the class is empty or has any empty bases or
163 /// fields.
164 void UpdateEmptyClassOffsets(const CXXRecordDecl *RD, uint64_t Offset,
165 bool UpdateVBases);
166
167 /// UpdateEmptyClassOffsets - Called after a field has been placed at the
168 /// given offset.
169 void UpdateEmptyClassOffsets(const FieldDecl *FD, uint64_t Offset);
170
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000171 /// InitializeLayout - Initialize record layout for the given record decl.
172 void InitializeLayout(const RecordDecl *D);
173
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000174 /// FinishLayout - Finalize record layout. Adjust record size based on the
175 /// alignment.
176 void FinishLayout();
177
178 void UpdateAlignment(unsigned NewAlignment);
179
Anders Carlssonc2226202010-05-26 05:58:59 +0000180 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
181 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000182public:
183 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
184};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000185} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000186
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000187/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
188/// no other data.
Anders Carlssonc2226202010-05-26 05:58:59 +0000189bool RecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000190 // FIXME: Audit the corners
191 if (!RD->isDynamicClass())
192 return false;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000193 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
194 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0))
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000195 return true;
196 return false;
197}
198
Anders Carlsson15837f82010-05-08 23:06:26 +0000199void
Anders Carlssonc2226202010-05-26 05:58:59 +0000200RecordLayoutBuilder::ComputeEmptySubobjectSizes(const CXXRecordDecl *RD) {
Anders Carlsson15837f82010-05-08 23:06:26 +0000201 // Check the bases.
202 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
203 E = RD->bases_end(); I != E; ++I) {
204 const CXXRecordDecl *BaseDecl =
205 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
206
207 uint64_t EmptySize = 0;
208 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
209 if (BaseDecl->isEmpty()) {
210 // If the class decl is empty, get its size.
211 EmptySize = Layout.getSize();
212 } else {
213 // Otherwise, we get the largest empty subobject for the decl.
214 EmptySize = Layout.getSizeOfLargestEmptySubobject();
215 }
216
217 SizeOfLargestEmptySubobject = std::max(SizeOfLargestEmptySubobject,
218 EmptySize);
219 }
220
221 // Check the fields.
222 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
223 I != E; ++I) {
224 const FieldDecl *FD = *I;
225
226 const RecordType *RT =
227 Context.getBaseElementType(FD->getType())->getAs<RecordType>();
228
229 // We only care about record types.
230 if (!RT)
231 continue;
232
233 uint64_t EmptySize = 0;
234 const CXXRecordDecl *MemberDecl = cast<CXXRecordDecl>(RT->getDecl());
235 const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
236 if (MemberDecl->isEmpty()) {
237 // If the class decl is empty, get its size.
238 EmptySize = Layout.getSize();
239 } else {
240 // Otherwise, we get the largest empty subobject for the decl.
241 EmptySize = Layout.getSizeOfLargestEmptySubobject();
242 }
243
244 SizeOfLargestEmptySubobject = std::max(SizeOfLargestEmptySubobject,
245 EmptySize);
246 }
247}
248
Anders Carlssonc2226202010-05-26 05:58:59 +0000249void RecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000250 const ASTRecordLayout::PrimaryBaseInfo &BaseInfo =
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000251 Context.getASTRecordLayout(RD).getPrimaryBaseInfo();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000252
Anders Carlsson81430692009-09-22 03:02:06 +0000253 // If the record has a primary base class that is virtual, add it to the set
254 // of primary bases.
Anders Carlssona30c0d32009-11-27 22:14:40 +0000255 if (BaseInfo.isVirtual())
256 IndirectPrimaryBases.insert(BaseInfo.getBase());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000257
Anders Carlsson81430692009-09-22 03:02:06 +0000258 // Now traverse all bases and find primary bases for them.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000259 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000260 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000261 assert(!i->getType()->isDependentType() &&
262 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000263 const CXXRecordDecl *Base =
Mike Stump78696a72009-08-11 04:03:59 +0000264 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000265
Mike Stump78696a72009-08-11 04:03:59 +0000266 // Only bases with virtual bases participate in computing the
267 // indirect primary virtual base classes.
Mike Stumpc2f591b2009-08-13 22:53:07 +0000268 if (Base->getNumVBases())
Anders Carlsson81430692009-09-22 03:02:06 +0000269 IdentifyPrimaryBases(Base);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000270 }
271}
272
Anders Carlsson81430692009-09-22 03:02:06 +0000273void
Anders Carlssonc2226202010-05-26 05:58:59 +0000274RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000275 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000276 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000277 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000278 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000279
Mike Stump11289f42009-09-09 15:08:12 +0000280 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000281 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000282
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000283 // Check if this is a nearly empty virtual base.
284 if (I->isVirtual() && IsNearlyEmpty(Base)) {
285 // If it's not an indirect primary base, then we've found our primary
286 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000287 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000288 PrimaryBase = Base;
289 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000290 return;
291 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000292
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000293 // Is this the first nearly empty virtual base?
294 if (!FirstNearlyEmptyVBase)
295 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000296 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000297
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000298 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000299 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000300 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000301 }
302}
303
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000304/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000305void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000306 // If the class isn't dynamic, it won't have a primary base.
307 if (!RD->isDynamicClass())
308 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000309
Anders Carlsson81430692009-09-22 03:02:06 +0000310 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000311 // indirect bases, and record all their primary virtual base classes.
Mike Stump590a7c72009-08-13 23:26:06 +0000312 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000313 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000314 assert(!i->getType()->isDependentType() &&
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000315 "Cannot lay out class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000316 const CXXRecordDecl *Base =
Mike Stump590a7c72009-08-13 23:26:06 +0000317 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +0000318 IdentifyPrimaryBases(Base);
Mike Stump590a7c72009-08-13 23:26:06 +0000319 }
320
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000321 // If the record has a dynamic base class, attempt to choose a primary base
322 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000323 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000324 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000325 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000326 // Ignore virtual bases.
327 if (i->isVirtual())
328 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000329
Anders Carlsson03ff3792009-11-27 22:05:05 +0000330 const CXXRecordDecl *Base =
331 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
332
333 if (Base->isDynamicClass()) {
334 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000335 PrimaryBase = Base;
336 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000337 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000338 }
339 }
340
341 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000342 // indirect primary virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000343 if (RD->getNumVBases() != 0) {
344 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000345 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000346 return;
347 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000348
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000349 // Otherwise, it is the first nearly empty virtual base that is not an
350 // indirect primary virtual base class, if one exists.
351 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000352 PrimaryBase = FirstNearlyEmptyVBase;
353 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000354 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000355 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000356
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000357 // Otherwise there is no primary base class.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000358 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000359
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000360 // Allocate the virtual table pointer at offset zero.
361 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000362
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000363 // Update the size.
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000364 Size += Context.Target.getPointerWidth(0);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000365 DataSize = Size;
366
367 // Update the alignment.
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000368 UpdateAlignment(Context.Target.getPointerAlign(0));
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000369}
370
Anders Carlsson09ffa322010-03-10 22:21:28 +0000371void
Anders Carlssonc2226202010-05-26 05:58:59 +0000372RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000373 // First, determine the primary base class.
374 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000375
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000376 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000377 if (PrimaryBase) {
378 if (PrimaryBaseIsVirtual) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000379 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000380 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +0000381
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000382 assert(!VisitedVirtualBases.count(PrimaryBase) &&
383 "vbase already visited!");
384 VisitedVirtualBases.insert(PrimaryBase);
Anders Carlsson291279e2010-04-10 18:42:27 +0000385
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000386 LayoutVirtualBase(PrimaryBase);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000387 } else
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000388 LayoutNonVirtualBase(PrimaryBase);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000389 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000390
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000391 // Now lay out the non-virtual bases.
392 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000393 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000394
395 // Ignore virtual bases.
396 if (I->isVirtual())
397 continue;
398
399 const CXXRecordDecl *Base =
400 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
401
402 // Skip the primary base.
Anders Carlssonb48414f2010-05-26 05:31:23 +0000403 if (Base == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000404 continue;
405
406 // Lay out the base.
407 LayoutNonVirtualBase(Base);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000408 }
409}
410
Anders Carlssonc2226202010-05-26 05:58:59 +0000411void RecordLayoutBuilder::LayoutNonVirtualBase(const CXXRecordDecl *RD) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000412 // Layout the base.
413 uint64_t Offset = LayoutBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000414
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000415 // Add its base class offset.
Anders Carlsson6a848892010-03-11 04:10:39 +0000416 if (!Bases.insert(std::make_pair(RD, Offset)).second)
417 assert(false && "Added same base offset more than once!");
Anders Carlsson09ffa322010-03-10 22:21:28 +0000418}
Mike Stump2b84dd32009-11-05 04:02:15 +0000419
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000420void
Anders Carlssonc2226202010-05-26 05:58:59 +0000421RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +0000422 uint64_t Offset,
423 const CXXRecordDecl *MostDerivedClass) {
424 // We already have the offset for the primary base of the most derived class.
425 if (RD != MostDerivedClass) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000426 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonea7b1822010-04-15 16:12:58 +0000427 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
428
429 // If this is a primary virtual base and we haven't seen it before, add it.
430 if (PrimaryBase && Layout.getPrimaryBaseWasVirtual() &&
431 !VBases.count(PrimaryBase))
432 VBases.insert(std::make_pair(PrimaryBase, Offset));
433 }
434
435 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
436 E = RD->bases_end(); I != E; ++I) {
437 assert(!I->getType()->isDependentType() &&
438 "Cannot layout class with dependent bases.");
439
440 const CXXRecordDecl *BaseDecl =
441 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
442
443 if (!BaseDecl->getNumVBases()) {
444 // This base isn't interesting since it doesn't have any virtual bases.
445 continue;
446 }
447
448 // Compute the offset of this base.
449 uint64_t BaseOffset;
450
451 if (I->isVirtual()) {
452 // If we don't know this vbase yet, don't visit it. It will be visited
453 // later.
454 if (!VBases.count(BaseDecl)) {
455 continue;
456 }
457
458 // Check if we've already visited this base.
459 if (!VisitedVirtualBases.insert(BaseDecl))
460 continue;
461
462 // We want the vbase offset from the class we're currently laying out.
463 BaseOffset = VBases[BaseDecl];
464 } else if (RD == MostDerivedClass) {
465 // We want the base offset from the class we're currently laying out.
466 assert(Bases.count(BaseDecl) && "Did not find base!");
467 BaseOffset = Bases[BaseDecl];
468 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000469 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonea7b1822010-04-15 16:12:58 +0000470 BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
471 }
472
473 AddPrimaryVirtualBaseOffsets(BaseDecl, BaseOffset, MostDerivedClass);
474 }
475}
476
477void
Anders Carlssonc2226202010-05-26 05:58:59 +0000478RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +0000479 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +0000480 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +0000481 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +0000482
Anders Carlsson291279e2010-04-10 18:42:27 +0000483 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000484 PrimaryBase = this->PrimaryBase;
485 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +0000486 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000487 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +0000488 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson291279e2010-04-10 18:42:27 +0000489 PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
490 }
491
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000492 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
493 E = RD->bases_end(); I != E; ++I) {
494 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000495 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000496
Mike Stump11289f42009-09-09 15:08:12 +0000497 const CXXRecordDecl *Base =
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000498 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
499
500 if (I->isVirtual()) {
Anders Carlsson291279e2010-04-10 18:42:27 +0000501 if (PrimaryBase != Base || !PrimaryBaseIsVirtual) {
502 bool IndirectPrimaryBase = IndirectPrimaryBases.count(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000503
Anders Carlsson291279e2010-04-10 18:42:27 +0000504 // Only lay out the virtual base if it's not an indirect primary base.
505 if (!IndirectPrimaryBase) {
506 // Only visit virtual bases once.
507 if (!VisitedVirtualBases.insert(Base))
508 continue;
509
Anders Carlssonfe900962010-03-11 05:42:17 +0000510 LayoutVirtualBase(Base);
Anders Carlsson6a848892010-03-11 04:10:39 +0000511 }
Mike Stump2b84dd32009-11-05 04:02:15 +0000512 }
Mike Stumpc2f591b2009-08-13 22:53:07 +0000513 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000514
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000515 if (!Base->getNumVBases()) {
516 // This base isn't interesting since it doesn't have any virtual bases.
517 continue;
Mike Stump996576f32009-08-16 19:04:13 +0000518 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +0000519
Anders Carlssonea7b1822010-04-15 16:12:58 +0000520 LayoutVirtualBases(Base, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +0000521 }
522}
523
Anders Carlssonc2226202010-05-26 05:58:59 +0000524void RecordLayoutBuilder::LayoutVirtualBase(const CXXRecordDecl *RD) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000525 // Layout the base.
526 uint64_t Offset = LayoutBase(RD);
527
528 // Add its base class offset.
Anders Carlsson6a848892010-03-11 04:10:39 +0000529 if (!VBases.insert(std::make_pair(RD, Offset)).second)
530 assert(false && "Added same vbase offset more than once!");
Anders Carlsson09ffa322010-03-10 22:21:28 +0000531}
532
Anders Carlssonc2226202010-05-26 05:58:59 +0000533uint64_t RecordLayoutBuilder::LayoutBase(const CXXRecordDecl *RD) {
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000534 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000535
536 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond626cb72010-05-10 15:26:14 +0000537 if (RD->isEmpty() && canPlaceRecordAtOffset(RD, 0, /*CheckVBases=*/false)) {
Anders Carlsson09ffa322010-03-10 22:21:28 +0000538 // We were able to place the class at offset 0.
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000539 UpdateEmptyClassOffsets(RD, 0, /*UpdateVBases=*/false);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000540
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000541 Size = std::max(Size, Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +0000542
543 return 0;
544 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000545
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000546 unsigned BaseAlign = Layout.getNonVirtualAlign();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000547
Anders Carlsson09ffa322010-03-10 22:21:28 +0000548 // Round up the current record size to the base's alignment boundary.
549 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000550
Anders Carlsson09ffa322010-03-10 22:21:28 +0000551 // Try to place the base.
552 while (true) {
Anders Carlssond626cb72010-05-10 15:26:14 +0000553 if (canPlaceRecordAtOffset(RD, Offset, /*CheckVBases=*/false))
Anders Carlsson09ffa322010-03-10 22:21:28 +0000554 break;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000555
Anders Carlsson09ffa322010-03-10 22:21:28 +0000556 Offset += BaseAlign;
557 }
558
559 if (!RD->isEmpty()) {
560 // Update the data size.
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000561 DataSize = Offset + Layout.getNonVirtualSize();
Anders Carlsson09ffa322010-03-10 22:21:28 +0000562
563 Size = std::max(Size, DataSize);
564 } else
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000565 Size = std::max(Size, Offset + Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +0000566
567 // Remember max struct/class alignment.
568 UpdateAlignment(BaseAlign);
569
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000570 UpdateEmptyClassOffsets(RD, Offset, /*UpdateVBases=*/false);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000571 return Offset;
572}
573
Anders Carlssond626cb72010-05-10 15:26:14 +0000574bool
Anders Carlssonc2226202010-05-26 05:58:59 +0000575RecordLayoutBuilder::canPlaceRecordAtOffset(const CXXRecordDecl *RD,
Anders Carlssond626cb72010-05-10 15:26:14 +0000576 uint64_t Offset,
577 bool CheckVBases) const {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000578 // Look for an empty class with the same type at the same offset.
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000579 for (EmptyClassOffsetsTy::const_iterator I =
580 EmptyClassOffsets.lower_bound(Offset),
581 E = EmptyClassOffsets.upper_bound(Offset); I != E; ++I) {
582
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000583 if (I->second == RD)
584 return false;
585 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000586
Anders Carlsson82828a32010-05-09 05:03:38 +0000587 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000588
589 // Check bases.
590 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000591 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000592 assert(!I->getType()->isDependentType() &&
593 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000594 if (I->isVirtual())
595 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000596
Anders Carlsson82828a32010-05-09 05:03:38 +0000597 const CXXRecordDecl *BaseDecl =
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000598 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
599
Anders Carlsson82828a32010-05-09 05:03:38 +0000600 uint64_t BaseOffset = Layout.getBaseClassOffset(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000601
Anders Carlssond626cb72010-05-10 15:26:14 +0000602 if (!canPlaceRecordAtOffset(BaseDecl, Offset + BaseOffset,
603 /*CheckVBases=*/false))
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000604 return false;
605 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000606
Anders Carlssond7d358a2009-09-25 15:39:00 +0000607 // Check fields.
608 unsigned FieldNo = 0;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000609 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
Anders Carlssond7d358a2009-09-25 15:39:00 +0000610 I != E; ++I, ++FieldNo) {
611 const FieldDecl *FD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000612
Anders Carlsson82828a32010-05-09 05:03:38 +0000613 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000614
Anders Carlssond7d358a2009-09-25 15:39:00 +0000615 if (!canPlaceFieldAtOffset(FD, Offset + FieldOffset))
616 return false;
617 }
618
Anders Carlssond626cb72010-05-10 15:26:14 +0000619 if (CheckVBases) {
620 // FIXME: virtual bases.
621 }
622
Anders Carlsson6522b052009-09-24 03:13:30 +0000623 return true;
624}
625
Anders Carlssonc2226202010-05-26 05:58:59 +0000626bool RecordLayoutBuilder::canPlaceFieldAtOffset(const FieldDecl *FD,
Anders Carlsson6f95c702009-09-25 00:02:51 +0000627 uint64_t Offset) const {
Anders Carlsson4bf82142009-09-25 01:23:32 +0000628 QualType T = FD->getType();
629 if (const RecordType *RT = T->getAs<RecordType>()) {
Anders Carlsson6f95c702009-09-25 00:02:51 +0000630 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
Anders Carlssond626cb72010-05-10 15:26:14 +0000631 return canPlaceRecordAtOffset(RD, Offset, /*CheckVBases=*/true);
Anders Carlsson6f95c702009-09-25 00:02:51 +0000632 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000633
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000634 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
635 QualType ElemTy = Context.getBaseElementType(AT);
Anders Carlsson4bf82142009-09-25 01:23:32 +0000636 const RecordType *RT = ElemTy->getAs<RecordType>();
637 if (!RT)
638 return true;
639 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
640 if (!RD)
641 return true;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000642
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000643 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson4bf82142009-09-25 01:23:32 +0000644
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000645 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Mike Stump2b84dd32009-11-05 04:02:15 +0000646 uint64_t ElementOffset = Offset;
Anders Carlsson4bf82142009-09-25 01:23:32 +0000647 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssond626cb72010-05-10 15:26:14 +0000648 if (!canPlaceRecordAtOffset(RD, ElementOffset, /*CheckVBases=*/true))
Anders Carlsson4bf82142009-09-25 01:23:32 +0000649 return false;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000650
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000651 ElementOffset += Layout.getSize();
Anders Carlsson4bf82142009-09-25 01:23:32 +0000652 }
653 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000654
Anders Carlsson6f95c702009-09-25 00:02:51 +0000655 return true;
656}
657
Anders Carlssonc2226202010-05-26 05:58:59 +0000658void RecordLayoutBuilder::UpdateEmptyClassOffsets(const CXXRecordDecl *RD,
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000659 uint64_t Offset,
660 bool UpdateVBases) {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000661 if (RD->isEmpty())
662 EmptyClassOffsets.insert(std::make_pair(Offset, RD));
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000663
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000664 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000665
666 // Update bases.
667 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000668 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000669 assert(!I->getType()->isDependentType() &&
670 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000671 if (I->isVirtual())
672 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000673
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000674 const CXXRecordDecl *Base =
675 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000676
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000677 uint64_t BaseClassOffset = Layout.getBaseClassOffset(Base);
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000678 UpdateEmptyClassOffsets(Base, Offset + BaseClassOffset,
679 /*UpdateVBases=*/false);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000680 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000681
Anders Carlssond7d358a2009-09-25 15:39:00 +0000682 // Update fields.
683 unsigned FieldNo = 0;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000684 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
Anders Carlssond7d358a2009-09-25 15:39:00 +0000685 I != E; ++I, ++FieldNo) {
686 const FieldDecl *FD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000687
Anders Carlsson2357bfd2010-05-08 22:35:05 +0000688 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
Anders Carlssond7d358a2009-09-25 15:39:00 +0000689 UpdateEmptyClassOffsets(FD, Offset + FieldOffset);
690 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000691
Anders Carlsson57732052010-05-23 18:14:24 +0000692 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
693
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000694 if (UpdateVBases) {
695 // FIXME: Update virtual bases.
Anders Carlsson57732052010-05-23 18:14:24 +0000696 } else if (PrimaryBase && Layout.getPrimaryBaseWasVirtual()) {
697 // We always want to update the offsets of a primary virtual base.
698 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
699 "primary base class offset must always be 0!");
700 UpdateEmptyClassOffsets(PrimaryBase, Offset, /*UpdateVBases=*/false);
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000701 }
Anders Carlsson6522b052009-09-24 03:13:30 +0000702}
703
Anders Carlssone1883102009-09-25 01:54:38 +0000704void
Anders Carlssonc2226202010-05-26 05:58:59 +0000705RecordLayoutBuilder::UpdateEmptyClassOffsets(const FieldDecl *FD,
Anders Carlssone1883102009-09-25 01:54:38 +0000706 uint64_t Offset) {
707 QualType T = FD->getType();
708
709 if (const RecordType *RT = T->getAs<RecordType>()) {
710 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000711 UpdateEmptyClassOffsets(RD, Offset, /*UpdateVBases=*/true);
Anders Carlssone1883102009-09-25 01:54:38 +0000712 return;
713 }
714 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000715
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000716 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
717 QualType ElemTy = Context.getBaseElementType(AT);
Anders Carlssone1883102009-09-25 01:54:38 +0000718 const RecordType *RT = ElemTy->getAs<RecordType>();
719 if (!RT)
720 return;
721 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
722 if (!RD)
723 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000724
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000725 const ASTRecordLayout &Info = Context.getASTRecordLayout(RD);
Anders Carlssone1883102009-09-25 01:54:38 +0000726
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000727 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Mike Stump2b84dd32009-11-05 04:02:15 +0000728 uint64_t ElementOffset = Offset;
Anders Carlssone1883102009-09-25 01:54:38 +0000729
730 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson5f1a1702010-05-10 15:28:59 +0000731 UpdateEmptyClassOffsets(RD, ElementOffset, /*UpdateVBases=*/true);
Anders Carlssone1883102009-09-25 01:54:38 +0000732 ElementOffset += Info.getSize();
733 }
734 }
735}
736
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000737void RecordLayoutBuilder::InitializeLayout(const RecordDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +0000738 IsUnion = D->isUnion();
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000739
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000740 Packed = D->hasAttr<PackedAttr>();
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000741
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000742 // The #pragma pack attribute specifies the maximum field alignment.
Anders Carlsson68e0b682009-08-08 18:23:56 +0000743 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000744 MaxFieldAlignment = PPA->getAlignment();
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000745
Anders Carlsson79474332009-07-18 20:20:21 +0000746 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Alexis Hunt96d5c762009-11-21 08:43:09 +0000747 UpdateAlignment(AA->getMaxAlignment());
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000748}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000749
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000750void RecordLayoutBuilder::Layout(const RecordDecl *D) {
751 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +0000752 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +0000753
Anders Carlsson79474332009-07-18 20:20:21 +0000754 // Finally, round the size of the total struct up to the alignment of the
755 // struct itself.
756 FinishLayout();
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000757}
758
759void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
760 InitializeLayout(RD);
761
762 ComputeEmptySubobjectSizes(RD);
763
764 // Lay out the vtable and the non-virtual bases.
765 LayoutNonVirtualBases(RD);
766
767 LayoutFields(RD);
768
769 NonVirtualSize = Size;
770 NonVirtualAlignment = Alignment;
771
772 // Lay out the virtual bases and add the primary virtual base offsets.
773 LayoutVirtualBases(RD, RD);
774
775 VisitedVirtualBases.clear();
776 AddPrimaryVirtualBaseOffsets(RD, 0, RD);
777
778 // Finally, round the size of the total struct up to the alignment of the
779 // struct itself.
780 FinishLayout();
781
Anders Carlsson5b441d72010-04-10 21:24:48 +0000782#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000783 // Check that we have base offsets for all bases.
784 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
785 E = RD->bases_end(); I != E; ++I) {
786 if (I->isVirtual())
787 continue;
Anders Carlsson5b441d72010-04-10 21:24:48 +0000788
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000789 const CXXRecordDecl *BaseDecl =
790 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
791
792 assert(Bases.count(BaseDecl) && "Did not find base offset!");
793 }
794
795 // And all virtual bases.
796 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
797 E = RD->vbases_end(); I != E; ++I) {
798 const CXXRecordDecl *BaseDecl =
799 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson5b441d72010-04-10 21:24:48 +0000800
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000801 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +0000802 }
803#endif
Anders Carlsson79474332009-07-18 20:20:21 +0000804}
805
Anders Carlssonc2226202010-05-26 05:58:59 +0000806void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +0000807 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000808 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +0000809
810 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +0000811
Anders Carlsson4f516282009-07-18 20:50:59 +0000812 // We start laying out ivars not at the end of the superclass
813 // structure, but at the next byte following the last field.
Anders Carlsson27b50132009-07-18 21:26:44 +0000814 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlsson47680d82009-09-26 01:34:51 +0000815 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +0000816 }
Mike Stump11289f42009-09-09 15:08:12 +0000817
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000818 Packed = D->hasAttr<PackedAttr>();
Mike Stump11289f42009-09-09 15:08:12 +0000819
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000820 // The #pragma pack attribute specifies the maximum field alignment.
821 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
822 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000823
Anders Carlsson4f516282009-07-18 20:50:59 +0000824 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Alexis Hunt96d5c762009-11-21 08:43:09 +0000825 UpdateAlignment(AA->getMaxAlignment());
Anders Carlsson4f516282009-07-18 20:50:59 +0000826 // Layout each ivar sequentially.
827 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000828 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson4f516282009-07-18 20:50:59 +0000829 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
830 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +0000831
Anders Carlsson4f516282009-07-18 20:50:59 +0000832 // Finally, round the size of the total struct up to the alignment of the
833 // struct itself.
834 FinishLayout();
835}
836
Anders Carlssonc2226202010-05-26 05:58:59 +0000837void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +0000838 // Layout each field, for now, just sequentially, respecting alignment. In
839 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +0000840 for (RecordDecl::field_iterator Field = D->field_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000841 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
Anders Carlsson118ce162009-07-18 21:48:39 +0000842 LayoutField(*Field);
843}
844
Anders Carlssonc2226202010-05-26 05:58:59 +0000845void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Anders Carlsson57235162010-04-16 15:57:11 +0000846 uint64_t TypeSize) {
847 assert(Context.getLangOptions().CPlusPlus &&
848 "Can only have wide bit-fields in C++!");
849
850 // Itanium C++ ABI 2.4:
851 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
852 // sizeof(T')*8 <= n.
853
854 QualType IntegralPODTypes[] = {
855 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
856 Context.UnsignedLongTy, Context.UnsignedLongLongTy
857 };
858
Anders Carlsson57235162010-04-16 15:57:11 +0000859 QualType Type;
860 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
861 I != E; ++I) {
862 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +0000863
864 if (Size > FieldSize)
865 break;
866
867 Type = IntegralPODTypes[I];
868 }
869 assert(!Type.isNull() && "Did not find a type!");
Anders Carlsson57235162010-04-16 15:57:11 +0000870
871 unsigned TypeAlign = Context.getTypeAlign(Type);
872
873 // We're not going to use any of the unfilled bits in the last byte.
874 UnfilledBitsInLastByte = 0;
875
Anders Carlssonaad5fa82010-04-17 20:21:41 +0000876 uint64_t FieldOffset;
877
Anders Carlsson57235162010-04-16 15:57:11 +0000878 if (IsUnion) {
879 DataSize = std::max(DataSize, FieldSize);
Anders Carlssonaad5fa82010-04-17 20:21:41 +0000880 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +0000881 } else {
Anders Carlssonaad5fa82010-04-17 20:21:41 +0000882 // The bitfield is allocated starting at the next offset aligned appropriately
883 // for T', with length n bits.
884 FieldOffset = llvm::RoundUpToAlignment(DataSize, TypeAlign);
885
Anders Carlsson57235162010-04-16 15:57:11 +0000886 uint64_t NewSizeInBits = FieldOffset + FieldSize;
887
888 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
889 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
890 }
891
892 // Place this field at the current location.
893 FieldOffsets.push_back(FieldOffset);
894
895 // Update the size.
896 Size = std::max(Size, DataSize);
897
898 // Remember max struct/class alignment.
899 UpdateAlignment(TypeAlign);
900}
901
Anders Carlssonc2226202010-05-26 05:58:59 +0000902void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +0000903 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlssonba958402009-11-22 19:13:51 +0000904 uint64_t FieldOffset = IsUnion ? 0 : (DataSize - UnfilledBitsInLastByte);
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000905 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000906
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000907 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +0000908 uint64_t TypeSize = FieldInfo.first;
909 unsigned FieldAlign = FieldInfo.second;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000910
Anders Carlsson57235162010-04-16 15:57:11 +0000911 if (FieldSize > TypeSize) {
912 LayoutWideBitField(FieldSize, TypeSize);
913 return;
914 }
915
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000916 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson07209442009-11-22 17:37:31 +0000917 FieldAlign = 1;
918 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
919 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
920
921 // The maximum field alignment overrides the aligned attribute.
922 if (MaxFieldAlignment)
923 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000924
Daniel Dunbar3d9289c2010-04-15 06:18:39 +0000925 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson07209442009-11-22 17:37:31 +0000926 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
927 FieldOffset = (FieldOffset + (FieldAlign-1)) & ~(FieldAlign-1);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000928
Daniel Dunbar3d9289c2010-04-15 06:18:39 +0000929 // Padding members don't affect overall alignment.
Anders Carlsson07209442009-11-22 17:37:31 +0000930 if (!D->getIdentifier())
931 FieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000932
Anders Carlsson07209442009-11-22 17:37:31 +0000933 // Place this field at the current location.
934 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000935
Anders Carlssonba958402009-11-22 19:13:51 +0000936 // Update DataSize to include the last byte containing (part of) the bitfield.
937 if (IsUnion) {
938 // FIXME: I think FieldSize should be TypeSize here.
939 DataSize = std::max(DataSize, FieldSize);
940 } else {
941 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000942
Anders Carlssonba958402009-11-22 19:13:51 +0000943 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
944 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
945 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000946
Anders Carlssonba958402009-11-22 19:13:51 +0000947 // Update the size.
948 Size = std::max(Size, DataSize);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000949
Anders Carlsson07209442009-11-22 17:37:31 +0000950 // Remember max struct/class alignment.
951 UpdateAlignment(FieldAlign);
952}
953
Anders Carlssonc2226202010-05-26 05:58:59 +0000954void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +0000955 if (D->isBitField()) {
956 LayoutBitField(D);
957 return;
958 }
959
Anders Carlssonba958402009-11-22 19:13:51 +0000960 // Reset the unfilled bits.
961 UnfilledBitsInLastByte = 0;
962
Anders Carlsson07209442009-11-22 17:37:31 +0000963 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlsson47680d82009-09-26 01:34:51 +0000964 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +0000965 uint64_t FieldSize;
966 unsigned FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000967
Anders Carlsson07209442009-11-22 17:37:31 +0000968 if (D->getType()->isIncompleteArrayType()) {
969 // This is a flexible array member; we can't directly
970 // query getTypeInfo about these, so we figure it out here.
971 // Flexible array members don't have any size, but they
972 // have to be aligned appropriately for their element type.
973 FieldSize = 0;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000974 const ArrayType* ATy = Context.getAsArrayType(D->getType());
975 FieldAlign = Context.getTypeAlign(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +0000976 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
977 unsigned AS = RT->getPointeeType().getAddressSpace();
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000978 FieldSize = Context.Target.getPointerWidth(AS);
979 FieldAlign = Context.Target.getPointerAlign(AS);
Anders Carlsson79474332009-07-18 20:20:21 +0000980 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000981 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +0000982 FieldSize = FieldInfo.first;
983 FieldAlign = FieldInfo.second;
Anders Carlsson79474332009-07-18 20:20:21 +0000984 }
Mike Stump11289f42009-09-09 15:08:12 +0000985
Anders Carlsson07209442009-11-22 17:37:31 +0000986 if (FieldPacked)
987 FieldAlign = 8;
988 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
989 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
990
991 // The maximum field alignment overrides the aligned attribute.
992 if (MaxFieldAlignment)
993 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
994
995 // Round up the current record size to the field's alignment boundary.
996 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000997
Anders Carlsson07209442009-11-22 17:37:31 +0000998 if (!IsUnion) {
999 while (true) {
1000 // Check if we can place the field at this offset.
1001 if (canPlaceFieldAtOffset(D, FieldOffset))
1002 break;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001003
Anders Carlsson07209442009-11-22 17:37:31 +00001004 // We couldn't place the field at the offset. Try again at a new offset.
1005 FieldOffset += FieldAlign;
1006 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001007
Anders Carlsson07209442009-11-22 17:37:31 +00001008 UpdateEmptyClassOffsets(D, FieldOffset);
1009 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001010
Anders Carlsson79474332009-07-18 20:20:21 +00001011 // Place this field at the current location.
1012 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +00001013
Anders Carlsson79474332009-07-18 20:20:21 +00001014 // Reserve space for this field.
1015 if (IsUnion)
1016 Size = std::max(Size, FieldSize);
1017 else
1018 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +00001019
Anders Carlsson47680d82009-09-26 01:34:51 +00001020 // Update the data size.
1021 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +00001022
Anders Carlsson79474332009-07-18 20:20:21 +00001023 // Remember max struct/class alignment.
1024 UpdateAlignment(FieldAlign);
1025}
1026
Anders Carlssonc2226202010-05-26 05:58:59 +00001027void RecordLayoutBuilder::FinishLayout() {
Anders Carlsson79474332009-07-18 20:20:21 +00001028 // In C++, records cannot be of size 0.
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001029 if (Context.getLangOptions().CPlusPlus && Size == 0)
Anders Carlsson79474332009-07-18 20:20:21 +00001030 Size = 8;
1031 // Finally, round the size of the record up to the alignment of the
1032 // record itself.
Anders Carlsson07209442009-11-22 17:37:31 +00001033 Size = llvm::RoundUpToAlignment(Size, Alignment);
Anders Carlsson79474332009-07-18 20:20:21 +00001034}
1035
Anders Carlssonc2226202010-05-26 05:58:59 +00001036void RecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment) {
Anders Carlsson79474332009-07-18 20:20:21 +00001037 if (NewAlignment <= Alignment)
1038 return;
Mike Stump11289f42009-09-09 15:08:12 +00001039
Anders Carlsson79474332009-07-18 20:20:21 +00001040 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
Mike Stump11289f42009-09-09 15:08:12 +00001041
Anders Carlsson79474332009-07-18 20:20:21 +00001042 Alignment = NewAlignment;
1043}
Mike Stump11289f42009-09-09 15:08:12 +00001044
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001045const CXXMethodDecl *
Anders Carlssonc2226202010-05-26 05:58:59 +00001046RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001047 assert(RD->isDynamicClass() && "Class does not have any virtual methods!");
1048
Daniel Dunbarccabe482010-04-19 20:44:53 +00001049 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001050 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001051 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001052
1053 // A class inside an anonymous namespace doesn't have a key function. (Or
1054 // at least, there's no point to assigning a key function to such a class;
1055 // this doesn't affect the ABI.)
1056 if (RD->isInAnonymousNamespace())
1057 return 0;
1058
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001059 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1060 E = RD->method_end(); I != E; ++I) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001061 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001062
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001063 if (!MD->isVirtual())
1064 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001065
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001066 if (MD->isPure())
1067 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001068
Anders Carlssonf98849e2009-12-02 17:15:43 +00001069 // Ignore implicit member functions, they are always marked as inline, but
1070 // they don't have a body until they're defined.
1071 if (MD->isImplicit())
1072 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001073
Douglas Gregora318efd2010-01-05 19:06:31 +00001074 if (MD->isInlineSpecified())
1075 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001076
1077 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001078 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001079
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001080 // We found it.
1081 return MD;
1082 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001083
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001084 return 0;
1085}
1086
Anders Carlssondf291d82010-05-26 04:56:53 +00001087/// getASTRecordLayout - Get or compute information about the layout of the
1088/// specified record (struct/union/class), which indicates its size and field
1089/// position information.
1090const ASTRecordLayout &ASTContext::getASTRecordLayout(const RecordDecl *D) {
1091 D = D->getDefinition();
1092 assert(D && "Cannot get layout of forward declarations!");
1093
1094 // Look up this layout, if already laid out, return what we have.
1095 // Note that we can't save a reference to the entry because this function
1096 // is recursive.
1097 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1098 if (Entry) return *Entry;
1099
Anders Carlssond2954862010-05-26 05:10:47 +00001100 const ASTRecordLayout *NewEntry;
1101
1102 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc2226202010-05-26 05:58:59 +00001103 RecordLayoutBuilder Builder(*this);
Anders Carlssond2954862010-05-26 05:10:47 +00001104 Builder.Layout(RD);
1105
1106 // FIXME: This is not always correct. See the part about bitfields at
1107 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1108 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1109 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1110
1111 // FIXME: This should be done in FinalizeLayout.
1112 uint64_t DataSize =
1113 IsPODForThePurposeOfLayout ? Builder.Size : Builder.DataSize;
1114 uint64_t NonVirtualSize =
1115 IsPODForThePurposeOfLayout ? DataSize : Builder.NonVirtualSize;
1116
1117 NewEntry =
1118 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1119 DataSize, Builder.FieldOffsets.data(),
1120 Builder.FieldOffsets.size(),
1121 NonVirtualSize,
1122 Builder.NonVirtualAlignment,
1123 Builder.SizeOfLargestEmptySubobject,
1124 Builder.PrimaryBase,
Anders Carlsson1d1e4cf2010-05-26 05:25:15 +00001125 Builder.PrimaryBaseIsVirtual,
Anders Carlssond2954862010-05-26 05:10:47 +00001126 Builder.Bases, Builder.VBases);
1127 } else {
Anders Carlssonc2226202010-05-26 05:58:59 +00001128 RecordLayoutBuilder Builder(*this);
Anders Carlssond2954862010-05-26 05:10:47 +00001129 Builder.Layout(D);
1130
1131 NewEntry =
1132 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1133 Builder.Size,
1134 Builder.FieldOffsets.data(),
1135 Builder.FieldOffsets.size());
1136 }
1137
Anders Carlssondf291d82010-05-26 04:56:53 +00001138 ASTRecordLayouts[D] = NewEntry;
1139
1140 if (getLangOptions().DumpRecordLayouts) {
1141 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1142 DumpRecordLayout(D, llvm::errs());
1143 }
1144
1145 return *NewEntry;
1146}
1147
1148const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1149 RD = cast<CXXRecordDecl>(RD->getDefinition());
1150 assert(RD && "Cannot get key function for forward declarations!");
1151
1152 const CXXMethodDecl *&Entry = KeyFunctions[RD];
1153 if (!Entry)
Anders Carlssonc2226202010-05-26 05:58:59 +00001154 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Anders Carlssondf291d82010-05-26 04:56:53 +00001155 else
Anders Carlssonc2226202010-05-26 05:58:59 +00001156 assert(Entry == RecordLayoutBuilder::ComputeKeyFunction(RD) &&
Anders Carlssondf291d82010-05-26 04:56:53 +00001157 "Key function changed!");
1158
1159 return Entry;
1160}
1161
1162/// getInterfaceLayoutImpl - Get or compute information about the
1163/// layout of the given interface.
1164///
1165/// \param Impl - If given, also include the layout of the interface's
1166/// implementation. This may differ by including synthesized ivars.
1167const ASTRecordLayout &
1168ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
1169 const ObjCImplementationDecl *Impl) {
1170 assert(!D->isForwardDecl() && "Invalid interface decl!");
1171
1172 // Look up this layout, if already laid out, return what we have.
1173 ObjCContainerDecl *Key =
1174 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1175 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1176 return *Entry;
1177
1178 // Add in synthesized ivar count if laying out an implementation.
1179 if (Impl) {
1180 unsigned SynthCount = CountNonClassIvars(D);
1181 // If there aren't any sythesized ivars then reuse the interface
1182 // entry. Note we can't cache this because we simply free all
1183 // entries later; however we shouldn't look up implementations
1184 // frequently.
1185 if (SynthCount == 0)
1186 return getObjCLayout(D, 0);
1187 }
1188
Anders Carlssonc2226202010-05-26 05:58:59 +00001189 RecordLayoutBuilder Builder(*this);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001190 Builder.Layout(D);
1191
Anders Carlssondf291d82010-05-26 04:56:53 +00001192 const ASTRecordLayout *NewEntry =
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001193 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1194 Builder.DataSize,
1195 Builder.FieldOffsets.data(),
1196 Builder.FieldOffsets.size());
1197
Anders Carlssondf291d82010-05-26 04:56:53 +00001198 ObjCLayouts[Key] = NewEntry;
1199
1200 return *NewEntry;
1201}
1202
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001203static void PrintOffset(llvm::raw_ostream &OS,
1204 uint64_t Offset, unsigned IndentLevel) {
1205 OS << llvm::format("%4d | ", Offset);
1206 OS.indent(IndentLevel * 2);
1207}
1208
1209static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
1210 const CXXRecordDecl *RD, ASTContext &C,
1211 uint64_t Offset,
1212 unsigned IndentLevel,
1213 const char* Description,
1214 bool IncludeVirtualBases) {
1215 const ASTRecordLayout &Info = C.getASTRecordLayout(RD);
1216
1217 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00001218 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001219 if (Description)
1220 OS << ' ' << Description;
1221 if (RD->isEmpty())
1222 OS << " (empty)";
1223 OS << '\n';
1224
1225 IndentLevel++;
1226
1227 const CXXRecordDecl *PrimaryBase = Info.getPrimaryBase();
1228
1229 // Vtable pointer.
1230 if (RD->isDynamicClass() && !PrimaryBase) {
1231 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001232 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001233 }
1234 // Dump (non-virtual) bases
1235 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1236 E = RD->bases_end(); I != E; ++I) {
1237 assert(!I->getType()->isDependentType() &&
1238 "Cannot layout class with dependent bases.");
1239 if (I->isVirtual())
1240 continue;
1241
1242 const CXXRecordDecl *Base =
1243 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1244
1245 uint64_t BaseOffset = Offset + Info.getBaseClassOffset(Base) / 8;
1246
1247 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1248 Base == PrimaryBase ? "(primary base)" : "(base)",
1249 /*IncludeVirtualBases=*/false);
1250 }
1251
1252 // Dump fields.
1253 uint64_t FieldNo = 0;
1254 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1255 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1256 const FieldDecl *Field = *I;
1257 uint64_t FieldOffset = Offset + Info.getFieldOffset(FieldNo) / 8;
1258
1259 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1260 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1261 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
1262 Field->getNameAsCString(),
1263 /*IncludeVirtualBases=*/true);
1264 continue;
1265 }
1266 }
1267
1268 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001269 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001270 }
1271
1272 if (!IncludeVirtualBases)
1273 return;
1274
1275 // Dump virtual bases.
1276 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1277 E = RD->vbases_end(); I != E; ++I) {
1278 assert(I->isVirtual() && "Found non-virtual class!");
1279 const CXXRecordDecl *VBase =
1280 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1281
1282 uint64_t VBaseOffset = Offset + Info.getVBaseClassOffset(VBase) / 8;
1283 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1284 VBase == PrimaryBase ?
1285 "(primary virtual base)" : "(virtual base)",
1286 /*IncludeVirtualBases=*/false);
1287 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001288
1289 OS << " sizeof=" << Info.getSize() / 8;
1290 OS << ", dsize=" << Info.getDataSize() / 8;
1291 OS << ", align=" << Info.getAlignment() / 8 << '\n';
1292 OS << " nvsize=" << Info.getNonVirtualSize() / 8;
1293 OS << ", nvalign=" << Info.getNonVirtualAlign() / 8 << '\n';
1294 OS << '\n';
1295}
Daniel Dunbarccabe482010-04-19 20:44:53 +00001296
1297void ASTContext::DumpRecordLayout(const RecordDecl *RD,
1298 llvm::raw_ostream &OS) {
1299 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1300
1301 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1302 return DumpCXXRecordLayout(OS, CXXRD, *this, 0, 0, 0,
1303 /*IncludeVirtualBases=*/true);
1304
1305 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1306 OS << "Record: ";
1307 RD->dump();
1308 OS << "\nLayout: ";
1309 OS << "<ASTRecordLayout\n";
1310 OS << " Size:" << Info.getSize() << "\n";
1311 OS << " DataSize:" << Info.getDataSize() << "\n";
1312 OS << " Alignment:" << Info.getAlignment() << "\n";
1313 OS << " FieldOffsets: [";
1314 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1315 if (i) OS << ", ";
1316 OS << Info.getFieldOffset(i);
1317 }
1318 OS << "]>\n";
1319}